From 09940bcde697df90423cb0b4ecb4e62ba31bfaf7 Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Mon, 16 Apr 2018 14:14:31 +0200 Subject: [PATCH] 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 --- apps/files_trashbin/appinfo/info.xml | 9 +- .../composer/composer/autoload_classmap.php | 6 + .../composer/composer/autoload_static.php | 6 + .../lib/AppInfo/Application.php | 13 ++ .../lib/Sabre/RootCollection.php | 58 +++++++++ apps/files_trashbin/lib/Sabre/TrashFile.php | 77 ++++++++++++ apps/files_trashbin/lib/Sabre/TrashFolder.php | 102 +++++++++++++++ .../lib/Sabre/TrashFolderFile.php | 81 ++++++++++++ .../lib/Sabre/TrashFolderFolder.php | 110 +++++++++++++++++ apps/files_trashbin/lib/Sabre/TrashHome.php | 116 ++++++++++++++++++ 10 files changed, 577 insertions(+), 1 deletion(-) create mode 100644 apps/files_trashbin/lib/Sabre/RootCollection.php create mode 100644 apps/files_trashbin/lib/Sabre/TrashFile.php create mode 100644 apps/files_trashbin/lib/Sabre/TrashFolder.php create mode 100644 apps/files_trashbin/lib/Sabre/TrashFolderFile.php create mode 100644 apps/files_trashbin/lib/Sabre/TrashFolderFolder.php create mode 100644 apps/files_trashbin/lib/Sabre/TrashHome.php diff --git a/apps/files_trashbin/appinfo/info.xml b/apps/files_trashbin/appinfo/info.xml index 585e61fe1e..a71443e694 100644 --- a/apps/files_trashbin/appinfo/info.xml +++ b/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. - 1.4.0 + 1.4.1 agpl Bjoern Schiessle Files_Trashbin + user-trashbin @@ -34,4 +35,10 @@ To prevent a user from running out of disk space, the Deleted files app will not OCA\Files_Trashbin\Command\CleanUp OCA\Files_Trashbin\Command\ExpireTrash + + + + OCA\Files_Trashbin\Sabre\RootCollection + + diff --git a/apps/files_trashbin/composer/composer/autoload_classmap.php b/apps/files_trashbin/composer/composer/autoload_classmap.php index 2e58c7b1c6..ad1d3db37e 100644 --- a/apps/files_trashbin/composer/composer/autoload_classmap.php +++ b/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', ); diff --git a/apps/files_trashbin/composer/composer/autoload_static.php b/apps/files_trashbin/composer/composer/autoload_static.php index 01520e2d14..badea42dec 100644 --- a/apps/files_trashbin/composer/composer/autoload_static.php +++ b/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', ); diff --git a/apps/files_trashbin/lib/AppInfo/Application.php b/apps/files_trashbin/lib/AppInfo/Application.php index e9d4e6ecc1..ea27c8c16e 100644 --- a/apps/files_trashbin/lib/AppInfo/Application.php +++ b/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() + ); + }); } } diff --git a/apps/files_trashbin/lib/Sabre/RootCollection.php b/apps/files_trashbin/lib/Sabre/RootCollection.php new file mode 100644 index 0000000000..226fc33e58 --- /dev/null +++ b/apps/files_trashbin/lib/Sabre/RootCollection.php @@ -0,0 +1,58 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ +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'; + } + +} diff --git a/apps/files_trashbin/lib/Sabre/TrashFile.php b/apps/files_trashbin/lib/Sabre/TrashFile.php new file mode 100644 index 0000000000..39b788a2e2 --- /dev/null +++ b/apps/files_trashbin/lib/Sabre/TrashFile.php @@ -0,0 +1,77 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ +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(); + } + +} diff --git a/apps/files_trashbin/lib/Sabre/TrashFolder.php b/apps/files_trashbin/lib/Sabre/TrashFolder.php new file mode 100644 index 0000000000..2f97a73ebf --- /dev/null +++ b/apps/files_trashbin/lib/Sabre/TrashFolder.php @@ -0,0 +1,102 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ +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(); + } +} diff --git a/apps/files_trashbin/lib/Sabre/TrashFolderFile.php b/apps/files_trashbin/lib/Sabre/TrashFolderFile.php new file mode 100644 index 0000000000..5a9133f3ad --- /dev/null +++ b/apps/files_trashbin/lib/Sabre/TrashFolderFile.php @@ -0,0 +1,81 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ +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(); + } + +} diff --git a/apps/files_trashbin/lib/Sabre/TrashFolderFolder.php b/apps/files_trashbin/lib/Sabre/TrashFolderFolder.php new file mode 100644 index 0000000000..21c121c7d4 --- /dev/null +++ b/apps/files_trashbin/lib/Sabre/TrashFolderFolder.php @@ -0,0 +1,110 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ +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(); + } + +} diff --git a/apps/files_trashbin/lib/Sabre/TrashHome.php b/apps/files_trashbin/lib/Sabre/TrashHome.php new file mode 100644 index 0000000000..45a95ccea8 --- /dev/null +++ b/apps/files_trashbin/lib/Sabre/TrashHome.php @@ -0,0 +1,116 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ +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; + } +}