List trashbin in DAV

First steps for #1332

* Add a new DAV collection
* List all files in the trashbin for this user
* Deleting files from trashbin
* Get files from trashbin (just read)

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>

apps/files_trashbin/appinfo/info.xml

@@ -9,13 +9,14 @@ This application enables users to restore files that were deleted from the syste
 To prevent a user from running out of disk space, the Deleted files app will not utilize more than 50% of the currently available free quota for deleted files. If the deleted files exceed this limit, the app deletes the oldest files until it gets below this limit. More information is available in the Deleted Files documentation.
 
 	</description>
-	<version>1.4.0</version>
+	<version>1.4.1</version>
 	<licence>agpl</licence>
 	<author>Bjoern Schiessle</author>
 	<namespace>Files_Trashbin</namespace>
 	<default_enable/>
 	<types>
 		<filesystem/>
+		<dav/>
 	</types>
 	<documentation>
 		<user>user-trashbin</user>
@@ -34,4 +35,10 @@ To prevent a user from running out of disk space, the Deleted files app will not
 		<command>OCA\Files_Trashbin\Command\CleanUp</command>
 		<command>OCA\Files_Trashbin\Command\ExpireTrash</command>
 	</commands>
+
+	<sabre>
+		<collections>
+			<collection>OCA\Files_Trashbin\Sabre\RootCollection</collection>
+		</collections>
+	</sabre>
 </info>

apps/files_trashbin/composer/composer/autoload_classmap.php

@@ -18,6 +18,12 @@ return array(
     'OCA\\Files_Trashbin\\Expiration' => $baseDir . '/../lib/Expiration.php',
     'OCA\\Files_Trashbin\\Helper' => $baseDir . '/../lib/Helper.php',
     'OCA\\Files_Trashbin\\Hooks' => $baseDir . '/../lib/Hooks.php',
+    'OCA\\Files_Trashbin\\Sabre\\RootCollection' => $baseDir . '/../lib/Sabre/RootCollection.php',
+    'OCA\\Files_Trashbin\\Sabre\\TrashFile' => $baseDir . '/../lib/Sabre/TrashFile.php',
+    'OCA\\Files_Trashbin\\Sabre\\TrashFolder' => $baseDir . '/../lib/Sabre/TrashFolder.php',
+    'OCA\\Files_Trashbin\\Sabre\\TrashFolderFile' => $baseDir . '/../lib/Sabre/TrashFolderFile.php',
+    'OCA\\Files_Trashbin\\Sabre\\TrashFolderFolder' => $baseDir . '/../lib/Sabre/TrashFolderFolder.php',
+    'OCA\\Files_Trashbin\\Sabre\\TrashHome' => $baseDir . '/../lib/Sabre/TrashHome.php',
     'OCA\\Files_Trashbin\\Storage' => $baseDir . '/../lib/Storage.php',
     'OCA\\Files_Trashbin\\Trashbin' => $baseDir . '/../lib/Trashbin.php',
 );

apps/files_trashbin/composer/composer/autoload_static.php

@@ -33,6 +33,12 @@ class ComposerStaticInitFiles_Trashbin
         'OCA\\Files_Trashbin\\Expiration' => __DIR__ . '/..' . '/../lib/Expiration.php',
         'OCA\\Files_Trashbin\\Helper' => __DIR__ . '/..' . '/../lib/Helper.php',
         'OCA\\Files_Trashbin\\Hooks' => __DIR__ . '/..' . '/../lib/Hooks.php',
+        'OCA\\Files_Trashbin\\Sabre\\RootCollection' => __DIR__ . '/..' . '/../lib/Sabre/RootCollection.php',
+        'OCA\\Files_Trashbin\\Sabre\\TrashFile' => __DIR__ . '/..' . '/../lib/Sabre/TrashFile.php',
+        'OCA\\Files_Trashbin\\Sabre\\TrashFolder' => __DIR__ . '/..' . '/../lib/Sabre/TrashFolder.php',
+        'OCA\\Files_Trashbin\\Sabre\\TrashFolderFile' => __DIR__ . '/..' . '/../lib/Sabre/TrashFolderFile.php',
+        'OCA\\Files_Trashbin\\Sabre\\TrashFolderFolder' => __DIR__ . '/..' . '/../lib/Sabre/TrashFolderFolder.php',
+        'OCA\\Files_Trashbin\\Sabre\\TrashHome' => __DIR__ . '/..' . '/../lib/Sabre/TrashHome.php',
         'OCA\\Files_Trashbin\\Storage' => __DIR__ . '/..' . '/../lib/Storage.php',
         'OCA\\Files_Trashbin\\Trashbin' => __DIR__ . '/..' . '/../lib/Trashbin.php',
     );

apps/files_trashbin/lib/AppInfo/Application.php

@@ -23,6 +23,7 @@
 
 namespace OCA\Files_Trashbin\AppInfo;
 
+use OCA\DAV\Connector\Sabre\Principal;
 use OCP\AppFramework\App;
 use OCA\Files_Trashbin\Expiration;
 use OCP\AppFramework\Utility\ITimeFactory;
@@ -47,5 +48,17 @@ class Application extends App {
 				$c->query(ITimeFactory::class)
 			);
 		});
+
+		/*
+		 * Register $principalBackend for the DAV collection
+		 */
+		$container->registerService('principalBackend', function () {
+			return new Principal(
+				\OC::$server->getUserManager(),
+				\OC::$server->getGroupManager(),
+				\OC::$server->getShareManager(),
+				\OC::$server->getUserSession()
+			);
+		});
 	}
 }

apps/files_trashbin/lib/Sabre/RootCollection.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 OCA\Files_Trashbin\Sabre;
+
+use Sabre\DAV\INode;
+use Sabre\DAVACL\AbstractPrincipalCollection;
+use Sabre\DAVACL\PrincipalBackend;
+
+class RootCollection extends AbstractPrincipalCollection {
+
+	public function __construct(PrincipalBackend\BackendInterface $principalBackend) {
+		parent::__construct($principalBackend, 'principals/users');
+	}
+
+	/**
+	 * This method returns a node for a principal.
+	 *
+	 * The passed array contains principal information, and is guaranteed to
+	 * at least contain a uri item. Other properties may or may not be
+	 * supplied by the authentication backend.
+	 *
+	 * @param array $principalInfo
+	 * @return INode
+	 */
+	public function getChildForPrincipal(array $principalInfo) {
+		list(,$name) = \Sabre\Uri\split($principalInfo['uri']);
+		$user = \OC::$server->getUserSession()->getUser();
+		if (is_null($user) || $name !== $user->getUID()) {
+			throw new \Sabre\DAV\Exception\Forbidden();
+		}
+		return new TrashHome($principalInfo);
+	}
+
+	public function getName() {
+		return 'trashbin';
+	}
+
+}

apps/files_trashbin/lib/Sabre/TrashFile.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 OCA\Files_Trashbin\Sabre;
+
+use OCP\Files\FileInfo;
+use Sabre\DAV\Exception\Forbidden;
+use Sabre\DAV\IFile;
+
+class TrashFile implements IFile {
+	/** @var string */
+	private $userId;
+
+	/** @var FileInfo */
+	private $data;
+
+	public function __construct(string $userId, FileInfo $data) {
+		$this->userId = $userId;
+		$this->data = $data;
+	}
+
+	public function put($data) {
+		throw new Forbidden();
+	}
+
+	public function get() {
+		return $this->data->getStorage()->fopen($this->data->getInternalPath().'.d'.$this->getLastModified(), 'rb');
+	}
+
+	public function getContentType() {
+		return $this->data->getMimetype();
+	}
+
+	public function getETag() {
+		return $this->data->getEtag();
+	}
+
+	public function getSize() {
+		return $this->data->getSize();
+	}
+
+	public function delete() {
+		\OCA\Files_Trashbin\Trashbin::delete($this->data->getName(), $this->userId, $this->getLastModified());
+	}
+
+	public function getName() {
+		return $this->data->getName() . '.d' . $this->getLastModified();
+	}
+
+	public function setName($name) {
+		throw new Forbidden();
+	}
+
+	public function getLastModified() {
+		return $this->data->getMtime();
+	}
+
+}

apps/files_trashbin/lib/Sabre/TrashFolder.php

@@ -0,0 +1,102 @@
+<?php
+/**
+ * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 OCA\Files_Trashbin\Sabre;
+
+use OCP\Files\FileInfo;
+use Sabre\DAV\Exception\Forbidden;
+use Sabre\DAV\ICollection;
+
+class TrashFolder implements ICollection {
+	/** @var string */
+	private $userId;
+
+	/** @var FileInfo */
+	private $data;
+
+	public function __construct(string $root, string $userId, FileInfo $data) {
+		$this->userId = $userId;
+		$this->data = $data;
+	}
+
+	public function createFile($name, $data = null) {
+		throw new Forbidden();
+	}
+
+	public function createDirectory($name) {
+		throw new Forbidden();
+	}
+
+	public function getChild($name) {
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles($this->getName(), $this->userId);
+
+		foreach ($entries as $entry) {
+			if ($entry->getName() === $name) {
+				if ($entry->getMimetype() === 'httpd/unix-directory') {
+					return new TrashFolderFolder($this->getName(), $this->userId, $entry);
+				}
+				return new TrashFolderFile($this->getName(), $this->userId, $entry);
+			}
+		}
+	}
+
+	public function getChildren() {
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles($this->getName(), $this->userId);
+
+		$children = array_map(function (FileInfo $entry) {
+			if ($entry->getMimetype() === 'httpd/unix-directory') {
+				return new TrashFolderFolder($this->getName(), $this->userId, $entry);
+			}
+			return new TrashFolderFile($this->getName(), $this->userId, $entry);
+		}, $entries);
+
+		return $children;
+	}
+
+	public function childExists($name) {
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles($this->getName(), $this->userId);
+
+		foreach ($entries as $entry) {
+			if ($entry->getName() === $name) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	public function delete() {
+		\OCA\Files_Trashbin\Trashbin::delete($this->data->getName(), $this->userId, $this->getLastModified());
+	}
+
+	public function getName() {
+		return $this->data->getName() . '.d' . $this->getLastModified();
+	}
+
+	public function setName($name) {
+		throw new Forbidden();
+	}
+
+	public function getLastModified() {
+		return $this->data->getMtime();
+	}
+}

apps/files_trashbin/lib/Sabre/TrashFolderFile.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 OCA\Files_Trashbin\Sabre;
+
+use OCP\Files\FileInfo;
+use Sabre\DAV\Exception\Forbidden;
+use Sabre\DAV\IFile;
+
+class TrashFolderFile implements IFile {
+	/** @var string */
+	private $root;
+
+	/** @var string */
+	private $userId;
+
+	/** @var FileInfo */
+	private $data;
+
+	public function __construct(string $root, string $userId, FileInfo $data) {
+		$this->root = $root;
+		$this->userId = $userId;
+		$this->data = $data;
+	}
+
+	public function put($data) {
+		throw new Forbidden();
+	}
+
+	public function get() {
+		return $this->data->getStorage()->fopen($this->data->getInternalPath(), 'rb');
+	}
+
+	public function getContentType() {
+		return $this->data->getMimetype();
+	}
+
+	public function getETag() {
+		return $this->data->getEtag();
+	}
+
+	public function getSize() {
+		return $this->data->getSize();
+	}
+
+	public function delete() {
+		\OCA\Files_Trashbin\Trashbin::delete($this->root . '/' . $this->getName(), $this->userId, null);
+	}
+
+	public function getName() {
+		return $this->data->getName();
+	}
+
+	public function setName($name) {
+		throw new Forbidden();
+	}
+
+	public function getLastModified() {
+		return $this->data->getMtime();
+	}
+
+}

apps/files_trashbin/lib/Sabre/TrashFolderFolder.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 OCA\Files_Trashbin\Sabre;
+
+use OCP\Files\FileInfo;
+use Sabre\DAV\Exception\Forbidden;
+use Sabre\DAV\ICollection;
+
+class TrashFolderFolder implements ICollection {
+
+	/** @var string */
+	private $root;
+
+
+	/** @var string */
+	private $userId;
+
+	/** @var FileInfo */
+	private $data;
+
+	public function __construct(string $root, string $userId, FileInfo $data) {
+		$this->root = $root;
+		$this->userId = $userId;
+		$this->data = $data;
+	}
+
+	public function createFile($name, $data = null) {
+		throw new Forbidden();
+	}
+
+	public function createDirectory($name) {
+		throw new Forbidden();
+	}
+
+	public function getChild($name) {
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles($this->root . '/' . $this->getName(), $this->userId);
+
+		foreach ($entries as $entry) {
+			if ($entry->getName() === $name) {
+				if ($entry->getMimetype() === 'httpd/unix-directory') {
+					return new TrashFolderFolder($this->root . '/' . $this->getName(), $this->userId, $entry);
+				}
+				return new TrashFolderFile($this->root . '/' . $this->getName(), $this->userId, $entry);
+			}
+		}
+	}
+
+	public function getChildren() {
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles($this->root . '/' . $this->getName(), $this->userId);
+
+		$children = array_map(function (FileInfo $entry) {
+			if ($entry->getMimetype() === 'httpd/unix-directory') {
+				return new TrashFolderFolder($this->root.'/'.$this->getName(), $this->userId, $entry);
+			}
+			return new TrashFolderFile($this->root.'/'.$this->getName(), $this->userId, $entry);
+		}, $entries);
+
+		return $children;
+	}
+
+	public function childExists($name) {
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles($this->root . '/' . $this->getName(), $this->userId);
+
+		foreach ($entries as $entry) {
+			if ($entry->getName() === $name) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	public function delete() {
+		\OCA\Files_Trashbin\Trashbin::delete($this->root . '/' . $this->getName(), $this->userId, null);
+	}
+
+	public function getName() {
+		return $this->data->getName();
+
+	}
+
+	public function setName($name) {
+		throw new Forbidden();
+	}
+
+	function getLastModified() {
+		return $this->data->getMtime();
+	}
+
+}

apps/files_trashbin/lib/Sabre/TrashHome.php

@@ -0,0 +1,116 @@
+<?php
+/**
+ * @copyright 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * 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 OCA\Files_Trashbin\Sabre;
+
+use OCP\Files\FileInfo;
+use Sabre\DAV\Exception\Forbidden;
+use Sabre\DAV\Exception\NotFound;
+use Sabre\DAV\ICollection;
+
+class TrashHome implements ICollection {
+
+	/**
+	 * @var array
+	 */
+	private $principalInfo;
+
+	/**
+	 * FilesHome constructor.
+	 *
+	 * @param array $principalInfo
+	 */
+	public function __construct($principalInfo) {
+		$this->principalInfo = $principalInfo;
+	}
+
+	public function delete() {
+		throw new Forbidden('Permission denied to delete your trashbin');
+	}
+
+	public function getName(): string {
+		list(,$name) = \Sabre\Uri\split($this->principalInfo['uri']);
+		return $name;
+	}
+
+	public function setName($name) {
+		throw new Forbidden('Permission denied to rename this trashbin');
+	}
+
+	public function createFile($name, $data = null) {
+		throw new Forbidden('Not allowed to create files in the trashbin');
+	}
+
+	public function createDirectory($name) {
+		throw new Forbidden('Not allowed to create folders in the trashbin');
+	}
+
+	public function getChild($name) {
+		list(,$userId) = \Sabre\Uri\split($this->principalInfo['uri']);
+
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles('/', $userId);
+
+		foreach ($entries as $entry) {
+			if ($entry->getName() . '.d'.$entry->getMtime() === $name) {
+				if ($entry->getMimetype() === 'httpd/unix-directory') {
+					return new TrashFolder('/', $userId, $entry);
+				}
+				return new TrashFile($userId, $entry);
+			}
+		}
+
+		throw new NotFound();
+	}
+
+	public function getChildren() {
+		list(,$userId) = \Sabre\Uri\split($this->principalInfo['uri']);
+
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles('/', $userId);
+
+		$children = array_map(function (FileInfo $entry) use ($userId) {
+			if ($entry->getMimetype() === 'httpd/unix-directory') {
+				return new TrashFolder('/', $userId, $entry);
+			}
+			return new TrashFile($userId, $entry);
+		}, $entries);
+
+		return $children;
+	}
+
+	public function childExists($name) {
+		list(,$userId) = \Sabre\Uri\split($this->principalInfo['uri']);
+
+		$entries = \OCA\Files_Trashbin\Helper::getTrashFiles('/', $userId);
+
+		foreach ($entries as $entry) {
+			if ($entry->getName() . '.d'.$entry->getMtime() === $name) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	public function getLastModified() {
+		return 0;
+	}
+}