Merge pull request #6503 from nextcloud/allow-apps-to-control-trash-bin

allow apps to control the trash bin
This commit is contained in:
Björn Schießle 2017-09-15 11:46:43 +02:00 committed by GitHub
commit 8500e11457
3 changed files with 158 additions and 13 deletions

View File

@ -0,0 +1,73 @@
<?php
/**
* @copyright Copyright (c) 2017 Bjoern Schiessle <bjoern@schiessle.org>
*
* @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\Events;
use OCP\Files\Node;
use Symfony\Component\EventDispatcher\Event;
/**
* Class MoveToTrashEvent
*
* Event to allow other apps to disable the trash bin for specific files
*
* @package OCA\Files_Trashbin\Events
*/
class MoveToTrashEvent extends Event {
/** @var bool */
private $moveToTrashBin;
/** @var Node */
private $node;
public function __construct(Node $node) {
$this->moveToTrashBin = true;
$this->node = $node;
}
/**
* get Node which will be deleted
*
* @return Node
*/
public function getNode() {
return $this->node;
}
/**
* disable trash bin for this operation
*/
public function disableTrashBin() {
$this->moveToTrashBin = false;
}
/**
* should the file be moved to the trash bin?
*
* @return bool
*/
public function shouldMoveToTrashBin() {
return $this->moveToTrashBin;
}
}

View File

@ -28,9 +28,13 @@ namespace OCA\Files_Trashbin;
use OC\Files\Filesystem; use OC\Files\Filesystem;
use OC\Files\Storage\Wrapper\Wrapper; use OC\Files\Storage\Wrapper\Wrapper;
use OC\Files\View; use OC\Files\View;
use OCA\Files_Trashbin\Events\MoveToTrashEvent;
use OCP\Encryption\Exceptions\GenericEncryptionException; use OCP\Encryption\Exceptions\GenericEncryptionException;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\ILogger; use OCP\ILogger;
use OCP\IUserManager; use OCP\IUserManager;
use Symfony\Component\EventDispatcher\EventDispatcher;
class Storage extends Wrapper { class Storage extends Wrapper {
@ -60,18 +64,31 @@ class Storage extends Wrapper {
/** @var ILogger */ /** @var ILogger */
private $logger; private $logger;
/** @var EventDispatcher */
private $eventDispatcher;
/** @var IRootFolder */
private $rootFolder;
/** /**
* Storage constructor. * Storage constructor.
* *
* @param array $parameters * @param array $parameters
* @param IUserManager|null $userManager * @param IUserManager|null $userManager
* @param ILogger|null $logger
* @param EventDispatcher|null $eventDispatcher
* @param IRootFolder|null $rootFolder
*/ */
public function __construct($parameters, public function __construct($parameters,
IUserManager $userManager = null, IUserManager $userManager = null,
ILogger $logger = null) { ILogger $logger = null,
EventDispatcher $eventDispatcher = null,
IRootFolder $rootFolder = null) {
$this->mountPoint = $parameters['mountPoint']; $this->mountPoint = $parameters['mountPoint'];
$this->userManager = $userManager; $this->userManager = $userManager;
$this->logger = $logger; $this->logger = $logger;
$this->eventDispatcher = $eventDispatcher;
$this->rootFolder = $rootFolder;
parent::__construct($parameters); parent::__construct($parameters);
} }
@ -200,6 +217,18 @@ class Storage extends Wrapper {
* @return bool * @return bool
*/ */
protected function shouldMoveToTrash($path){ protected function shouldMoveToTrash($path){
// check if there is a app which want to disable the trash bin for this file
$fileId = $this->storage->getCache()->getId($path);
$nodes = $this->rootFolder->getById($fileId);
foreach ($nodes as $node) {
$event = $this->createMoveToTrashEvent($node);
$this->eventDispatcher->dispatch('OCA\Files_Trashbin::moveToTrash', $event);
if ($event->shouldMoveToTrashBin() === false) {
return false;
}
}
$normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path); $normalized = Filesystem::normalizePath($this->mountPoint . '/' . $path);
$parts = explode('/', $normalized); $parts = explode('/', $normalized);
if (count($parts) < 4) { if (count($parts) < 4) {
@ -213,6 +242,17 @@ class Storage extends Wrapper {
return false; return false;
} }
/**
* get move to trash event
*
* @param Node $node
* @return MoveToTrashEvent
*/
protected function createMoveToTrashEvent(Node $node) {
$event = new MoveToTrashEvent($node);
return $event;
}
/** /**
* Run the delete operation with the given method * Run the delete operation with the given method
* *
@ -269,7 +309,9 @@ class Storage extends Wrapper {
return new \OCA\Files_Trashbin\Storage( return new \OCA\Files_Trashbin\Storage(
array('storage' => $storage, 'mountPoint' => $mountPoint), array('storage' => $storage, 'mountPoint' => $mountPoint),
\OC::$server->getUserManager(), \OC::$server->getUserManager(),
\OC::$server->getLogger() \OC::$server->getLogger(),
\OC::$server->getEventDispatcher(),
\OC::$server->getLazyRootFolder()
); );
}, 1); }, 1);
} }

View File

@ -31,7 +31,13 @@ namespace OCA\Files_Trashbin\Tests;
use OC\Files\Storage\Temporary; use OC\Files\Storage\Temporary;
use OC\Files\Filesystem; use OC\Files\Filesystem;
use OCA\Files_Trashbin\Events\MoveToTrashEvent;
use OCA\Files_Trashbin\Storage;
use OCP\Files\Cache\ICache;
use OCP\Files\IRootFolder;
use OCP\Files\Node;
use OCP\ILogger; use OCP\ILogger;
use Symfony\Component\EventDispatcher\EventDispatcher;
/** /**
* Class Storage * Class Storage
@ -522,19 +528,40 @@ class StorageTest extends \Test\TestCase {
/** /**
* @dataProvider dataTestShouldMoveToTrash * @dataProvider dataTestShouldMoveToTrash
*/ */
public function testShouldMoveToTrash($mountPoint, $path, $userExists, $expected) { public function testShouldMoveToTrash($mountPoint, $path, $userExists, $appDisablesTrash, $expected) {
$fileID = 1;
$cache = $this->getMock(ICache::class);
$cache->expects($this->any())->method('getId')->willReturn($fileID);
$tmpStorage = $this->getMockBuilder('\OC\Files\Storage\Temporary') $tmpStorage = $this->getMockBuilder('\OC\Files\Storage\Temporary')
->disableOriginalConstructor()->getMock(); ->disableOriginalConstructor()->getMock($cache);
$tmpStorage->expects($this->any())->method('getCache')->willReturn($cache);
$userManager = $this->getMockBuilder('OCP\IUserManager') $userManager = $this->getMockBuilder('OCP\IUserManager')
->disableOriginalConstructor()->getMock(); ->disableOriginalConstructor()->getMock();
$userManager->expects($this->any()) $userManager->expects($this->any())
->method('userExists')->willReturn($userExists); ->method('userExists')->willReturn($userExists);
$logger = $this->getMockBuilder(ILogger::class)->getMock(); $logger = $this->getMockBuilder(ILogger::class)->getMock();
$storage = new \OCA\Files_Trashbin\Storage( $eventDispatcher = $this->getMockBuilder(EventDispatcher::class)
['mountPoint' => $mountPoint, 'storage' => $tmpStorage], ->disableOriginalConstructor()->getMock();
$userManager, $rootFolder = $this->getMock(IRootFolder::class);
$logger $node = $this->getMockBuilder(Node::class)->disableOriginalConstructor()->getMock();
); $event = $this->getMockBuilder(MoveToTrashEvent::class)->disableOriginalConstructor()->getMock();
$event->expects($this->any())->method('shouldMoveToTrashBin')->willReturn(!$appDisablesTrash);
$rootFolder->expects($this->any())->method('getById')->with($fileID)->willReturn([$node]);
$storage = $this->getMockBuilder(Storage::class)
->setConstructorArgs(
[
['mountPoint' => $mountPoint, 'storage' => $tmpStorage],
$userManager,
$logger,
$eventDispatcher,
$rootFolder
]
)->setMethods(['createMoveToTrashEvent'])->getMock();
$storage->expects($this->any())->method('createMoveToTrashEvent')->with($node)
->willReturn($event);
$this->assertSame($expected, $this->assertSame($expected,
$this->invokePrivate($storage, 'shouldMoveToTrash', [$path]) $this->invokePrivate($storage, 'shouldMoveToTrash', [$path])
@ -544,10 +571,13 @@ class StorageTest extends \Test\TestCase {
public function dataTestShouldMoveToTrash() { public function dataTestShouldMoveToTrash() {
return [ return [
['/schiesbn/', '/files/test.txt', true, true], ['/schiesbn/', '/files/test.txt', true, false, true],
['/schiesbn/', '/files/test.txt', false, false], ['/schiesbn/', '/files/test.txt', false, false, false],
['/schiesbn/', '/test.txt', true, false], ['/schiesbn/', '/test.txt', true, false, false],
['/schiesbn/', '/test.txt', false, false], ['/schiesbn/', '/test.txt', false, false, false],
// other apps disables the trashbin
['/schiesbn/', '/files/test.txt', true, true, false],
['/schiesbn/', '/files/test.txt', false, true, false],
]; ];
} }