commit vendor

vendor/sabre/dav/lib/DAV/Locks/Backend/AbstractBackend.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabre\DAV\Locks\Backend;
+
+/**
+ * This is an Abstract clas for lock backends.
+ *
+ * Currently this backend has no function, but it exists for consistency, and
+ * to ensure that if default code is required in the backend, there will be a
+ * non-bc-breaking way to do so.
+ *
+ * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
+ * @author Evert Pot (http://evertpot.com/)
+ * @license http://sabre.io/license/ Modified BSD License
+ */
+abstract class AbstractBackend implements BackendInterface
+{
+}

vendor/sabre/dav/lib/DAV/Locks/Backend/BackendInterface.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabre\DAV\Locks\Backend;
+
+use Sabre\DAV\Locks;
+
+/**
+ * If you are defining your own Locks backend, you must implement this
+ * interface.
+ *
+ * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
+ * @author Evert Pot (http://evertpot.com/)
+ * @license http://sabre.io/license/ Modified BSD License
+ */
+interface BackendInterface
+{
+    /**
+     * Returns a list of Sabre\DAV\Locks\LockInfo objects.
+     *
+     * This method should return all the locks for a particular uri, including
+     * locks that might be set on a parent uri.
+     *
+     * If returnChildLocks is set to true, this method should also look for
+     * any locks in the subtree of the uri for locks.
+     *
+     * @param string $uri
+     * @param bool   $returnChildLocks
+     *
+     * @return array
+     */
+    public function getLocks($uri, $returnChildLocks);
+
+    /**
+     * Locks a uri.
+     *
+     * @param string $uri
+     *
+     * @return bool
+     */
+    public function lock($uri, Locks\LockInfo $lockInfo);
+
+    /**
+     * Removes a lock from a uri.
+     *
+     * @param string $uri
+     *
+     * @return bool
+     */
+    public function unlock($uri, Locks\LockInfo $lockInfo);
+}

vendor/sabre/dav/lib/DAV/Locks/Backend/File.php

@@ -0,0 +1,182 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabre\DAV\Locks\Backend;
+
+use Sabre\DAV\Locks\LockInfo;
+
+/**
+ * This Locks backend stores all locking information in a single file.
+ *
+ * Note that this is not nearly as robust as a database. If you are considering
+ * using this backend, keep in mind that the PDO backend can work with SqLite,
+ * which is designed to be a good file-based database.
+ *
+ * It literally solves the problem this class solves as well, but much better.
+ *
+ * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
+ * @author Evert Pot (http://evertpot.com/)
+ * @license http://sabre.io/license/ Modified BSD License
+ */
+class File extends AbstractBackend
+{
+    /**
+     * The storage file.
+     *
+     * @var string
+     */
+    private $locksFile;
+
+    /**
+     * Constructor.
+     *
+     * @param string $locksFile path to file
+     */
+    public function __construct($locksFile)
+    {
+        $this->locksFile = $locksFile;
+    }
+
+    /**
+     * Returns a list of Sabre\DAV\Locks\LockInfo objects.
+     *
+     * This method should return all the locks for a particular uri, including
+     * locks that might be set on a parent uri.
+     *
+     * If returnChildLocks is set to true, this method should also look for
+     * any locks in the subtree of the uri for locks.
+     *
+     * @param string $uri
+     * @param bool   $returnChildLocks
+     *
+     * @return array
+     */
+    public function getLocks($uri, $returnChildLocks)
+    {
+        $newLocks = [];
+
+        $locks = $this->getData();
+
+        foreach ($locks as $lock) {
+            if ($lock->uri === $uri ||
+                //deep locks on parents
+                (0 != $lock->depth && 0 === strpos($uri, $lock->uri.'/')) ||
+
+                // locks on children
+                ($returnChildLocks && (0 === strpos($lock->uri, $uri.'/')))) {
+                $newLocks[] = $lock;
+            }
+        }
+
+        // Checking if we can remove any of these locks
+        foreach ($newLocks as $k => $lock) {
+            if (time() > $lock->timeout + $lock->created) {
+                unset($newLocks[$k]);
+            }
+        }
+
+        return $newLocks;
+    }
+
+    /**
+     * Locks a uri.
+     *
+     * @param string $uri
+     *
+     * @return bool
+     */
+    public function lock($uri, LockInfo $lockInfo)
+    {
+        // We're making the lock timeout 30 minutes
+        $lockInfo->timeout = 1800;
+        $lockInfo->created = time();
+        $lockInfo->uri = $uri;
+
+        $locks = $this->getData();
+
+        foreach ($locks as $k => $lock) {
+            if (
+                ($lock->token == $lockInfo->token) ||
+                (time() > $lock->timeout + $lock->created)
+            ) {
+                unset($locks[$k]);
+            }
+        }
+        $locks[] = $lockInfo;
+        $this->putData($locks);
+
+        return true;
+    }
+
+    /**
+     * Removes a lock from a uri.
+     *
+     * @param string $uri
+     *
+     * @return bool
+     */
+    public function unlock($uri, LockInfo $lockInfo)
+    {
+        $locks = $this->getData();
+        foreach ($locks as $k => $lock) {
+            if ($lock->token == $lockInfo->token) {
+                unset($locks[$k]);
+                $this->putData($locks);
+
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Loads the lockdata from the filesystem.
+     *
+     * @return array
+     */
+    protected function getData()
+    {
+        if (!file_exists($this->locksFile)) {
+            return [];
+        }
+
+        // opening up the file, and creating a shared lock
+        $handle = fopen($this->locksFile, 'r');
+        flock($handle, LOCK_SH);
+
+        // Reading data until the eof
+        $data = stream_get_contents($handle);
+
+        // We're all good
+        flock($handle, LOCK_UN);
+        fclose($handle);
+
+        // Unserializing and checking if the resource file contains data for this file
+        $data = unserialize($data);
+        if (!$data) {
+            return [];
+        }
+
+        return $data;
+    }
+
+    /**
+     * Saves the lockdata.
+     */
+    protected function putData(array $newData)
+    {
+        // opening up the file, and creating an exclusive lock
+        $handle = fopen($this->locksFile, 'a+');
+        flock($handle, LOCK_EX);
+
+        // We can only truncate and rewind once the lock is acquired.
+        ftruncate($handle, 0);
+        rewind($handle);
+
+        fwrite($handle, serialize($newData));
+        flock($handle, LOCK_UN);
+        fclose($handle);
+    }
+}

vendor/sabre/dav/lib/DAV/Locks/Backend/PDO.php

@@ -0,0 +1,172 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sabre\DAV\Locks\Backend;
+
+use Sabre\DAV\Locks\LockInfo;
+
+/**
+ * The Lock manager allows you to handle all file-locks centrally.
+ *
+ * This Lock Manager stores all its data in a database. You must pass a PDO
+ * connection object in the constructor.
+ *
+ * @copyright Copyright (C) fruux GmbH (https://fruux.com/)
+ * @author Evert Pot (http://evertpot.com/)
+ * @license http://sabre.io/license/ Modified BSD License
+ */
+class PDO extends AbstractBackend
+{
+    /**
+     * The PDO tablename this backend uses.
+     *
+     * @var string
+     */
+    public $tableName = 'locks';
+
+    /**
+     * The PDO connection object.
+     *
+     * @var pdo
+     */
+    protected $pdo;
+
+    /**
+     * Constructor.
+     */
+    public function __construct(\PDO $pdo)
+    {
+        $this->pdo = $pdo;
+    }
+
+    /**
+     * Returns a list of Sabre\DAV\Locks\LockInfo objects.
+     *
+     * This method should return all the locks for a particular uri, including
+     * locks that might be set on a parent uri.
+     *
+     * If returnChildLocks is set to true, this method should also look for
+     * any locks in the subtree of the uri for locks.
+     *
+     * @param string $uri
+     * @param bool   $returnChildLocks
+     *
+     * @return array
+     */
+    public function getLocks($uri, $returnChildLocks)
+    {
+        // NOTE: the following 10 lines or so could be easily replaced by
+        // pure sql. MySQL's non-standard string concatenation prevents us
+        // from doing this though.
+        $query = 'SELECT owner, token, timeout, created, scope, depth, uri FROM '.$this->tableName.' WHERE (created > (? - timeout)) AND ((uri = ?)';
+        $params = [time(), $uri];
+
+        // We need to check locks for every part in the uri.
+        $uriParts = explode('/', $uri);
+
+        // We already covered the last part of the uri
+        array_pop($uriParts);
+
+        $currentPath = '';
+
+        foreach ($uriParts as $part) {
+            if ($currentPath) {
+                $currentPath .= '/';
+            }
+            $currentPath .= $part;
+
+            $query .= ' OR (depth!=0 AND uri = ?)';
+            $params[] = $currentPath;
+        }
+
+        if ($returnChildLocks) {
+            $query .= ' OR (uri LIKE ?)';
+            $params[] = $uri.'/%';
+        }
+        $query .= ')';
+
+        $stmt = $this->pdo->prepare($query);
+        $stmt->execute($params);
+        $result = $stmt->fetchAll();
+
+        $lockList = [];
+        foreach ($result as $row) {
+            $lockInfo = new LockInfo();
+            $lockInfo->owner = $row['owner'];
+            $lockInfo->token = $row['token'];
+            $lockInfo->timeout = $row['timeout'];
+            $lockInfo->created = $row['created'];
+            $lockInfo->scope = $row['scope'];
+            $lockInfo->depth = $row['depth'];
+            $lockInfo->uri = $row['uri'];
+            $lockList[] = $lockInfo;
+        }
+
+        return $lockList;
+    }
+
+    /**
+     * Locks a uri.
+     *
+     * @param string $uri
+     *
+     * @return bool
+     */
+    public function lock($uri, LockInfo $lockInfo)
+    {
+        // We're making the lock timeout 30 minutes
+        $lockInfo->timeout = 30 * 60;
+        $lockInfo->created = time();
+        $lockInfo->uri = $uri;
+
+        $locks = $this->getLocks($uri, false);
+        $exists = false;
+        foreach ($locks as $lock) {
+            if ($lock->token == $lockInfo->token) {
+                $exists = true;
+            }
+        }
+
+        if ($exists) {
+            $stmt = $this->pdo->prepare('UPDATE '.$this->tableName.' SET owner = ?, timeout = ?, scope = ?, depth = ?, uri = ?, created = ? WHERE token = ?');
+            $stmt->execute([
+                $lockInfo->owner,
+                $lockInfo->timeout,
+                $lockInfo->scope,
+                $lockInfo->depth,
+                $uri,
+                $lockInfo->created,
+                $lockInfo->token,
+            ]);
+        } else {
+            $stmt = $this->pdo->prepare('INSERT INTO '.$this->tableName.' (owner,timeout,scope,depth,uri,created,token) VALUES (?,?,?,?,?,?,?)');
+            $stmt->execute([
+                $lockInfo->owner,
+                $lockInfo->timeout,
+                $lockInfo->scope,
+                $lockInfo->depth,
+                $uri,
+                $lockInfo->created,
+                $lockInfo->token,
+            ]);
+        }
+
+        return true;
+    }
+
+    /**
+     * Removes a lock from a uri.
+     *
+     * @param string $uri
+     *
+     * @return bool
+     */
+    public function unlock($uri, LockInfo $lockInfo)
+    {
+        $stmt = $this->pdo->prepare('DELETE FROM '.$this->tableName.' WHERE uri = ? AND token = ?');
+        $stmt->execute([$uri, $lockInfo->token]);
+
+        return 1 === $stmt->rowCount();
+    }
+}