Maintain a per-user temp directory for locks and temp files. Run a cleanup routine to remove old temp files every now and then

3 files changed, 103 insertions, 4 deletions

diff --git a/lib/Kolab/DAV/Locks/File.php b/lib/Kolab/DAV/Locks/File.php
index 0d8d17b..dddd936 100644
--- a/lib/Kolab/DAV/Locks/File.php
+++ b/lib/Kolab/DAV/Locks/File.php
@@ -33,13 +33,20 @@ use Sabre\DAV\Locks\Backend\AbstractBackend;
 class File extends AbstractBackend
 {
     /**
-     * The storage file prefix
+     * The storage directory prefix
      *
      * @var string
      */
     private $basePath;
 
     /**
+     * The directory to storage the file in
+     *
+     * @var string
+     */
+    private $dataDir;
+
+    /**
      * Constructor
      *
      * @param string $basePath base path to store lock files
@@ -174,7 +181,14 @@ class File extends AbstractBackend
      */
     protected function getLocksFile()
     {
-        return $this->basePath . '_' . str_replace('@', '_', HTTPBasic::$current_user);
+        if (!$this->dataDir) {
+            $this->dataDir = $this->basePath . '/' . str_replace('@', '_', HTTPBasic::$current_user);
+
+            if (!is_dir($this->dataDir))
+                mkdir($this->dataDir);
+        }
+
+        return $this->dataDir . '/locks';
     }
 
     /**
diff --git a/lib/Kolab/DAV/TempFilesPlugin.php b/lib/Kolab/DAV/TempFilesPlugin.php
new file mode 100644
index 0000000..5a19cd6
--- /dev/null
+++ b/lib/Kolab/DAV/TempFilesPlugin.php
@@ -0,0 +1,85 @@
+<?php
+
+/**
+ * Temporary File Filter Plugin for the Kolab WebDAV service.
+ *
+ * @author Thomas Bruederli <bruederli@kolabsys.com>
+ *
+ * Copyright (C) 2013, Kolab Systems AG <contact@kolabsys.com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Kolab\DAV;
+
+use Sabre\DAV;
+use Kolab\DAV\Auth\HTTPBasic;
+
+/**
+ * Temporary File Filter Plugin
+ *
+ * The purpose of this filter is to intercept some of the garbage files
+ * operation systems and applications tend to generate when mounting
+ * a WebDAV share as a disk.
+ */
+class TempFilesPlugin extends DAV\TemporaryFileFilterPlugin
+{
+    protected $baseDir;
+
+    /**
+     * Creates the plugin.
+     *
+     * @param string $baseDir Temp directoy base path
+     */
+    public function __construct($baseDir)
+    {
+        $this->baseDir = $baseDir;
+    }
+
+    /**
+     * This method returns the directory where the temporary files should be stored.
+     *
+     * @return string
+     */
+    protected function getDataDir()
+    {
+        if (!$this->dataDir) {
+            $this->dataDir = $this->baseDir . '/' . str_replace('@', '_', HTTPBasic::$current_user);
+
+            if (!is_dir($this->dataDir)) {
+                mkdir($this->dataDir);
+            }
+
+            // run a cleanup routine on every 100th request
+            if (rand(0,100) == 100) {
+                $this->cleanup();
+            }
+        }
+
+        return $this->dataDir;
+    }
+
+    /**
+     * Tempfile cleanup routine to remove files not touched for 24 hours
+     */
+    protected function cleanup()
+    {
+        $expires = time() - 86400;
+        foreach (glob($this->dataDir . '/*.tempfile') as $file) {
+            if (filemtime($file) < $expires) {
+                unlink($file);
+            }
+        }
+    }
+}
diff --git a/public_html/index.php b/public_html/index.php
index 83c8822..66b3d0c 100644
--- a/public_html/index.php
+++ b/public_html/index.php
@@ -155,11 +155,11 @@ if ($services['CARDDAV']) {
 if ($services['WEBDAV']) {
     // the lock manager is reponsible for making sure users don't overwrite each others changes.
     // TODO: replace this with a class that manages locks in the Kolab backend
-    $locks_backend = new Kolab\DAV\Locks\File(KOLAB_DAV_ROOT . '/temp/locks');
+    $locks_backend = new \Kolab\DAV\Locks\File(KOLAB_DAV_ROOT . '/temp');
     $server->addPlugin(new \Sabre\DAV\Locks\Plugin($locks_backend));
 
     // intercept some of the garbage files operation systems tend to generate when mounting a WebDAV share
-    $server->addPlugin(new \Sabre\DAV\TemporaryFileFilterPlugin(KOLAB_DAV_ROOT . '/temp'));
+    $server->addPlugin(new \Kolab\DAV\TempFilesPlugin(KOLAB_DAV_ROOT . '/temp'));
 }
 
 // HTML UI for browser-based access (recommended only for development)