Merge pull request #24610 from nextcloud/enh/adding-missing-event-on-deleted-shares

adding a ShareDeletedEvent
This commit is contained in:
Roeland Jago Douma 2020-12-23 12:45:34 +01:00 committed by GitHub
commit 6846a83d56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 69 additions and 0 deletions

View File

@ -477,6 +477,7 @@ return array(
'OCP\\Settings\\ISubAdminSettings' => $baseDir . '/lib/public/Settings/ISubAdminSettings.php', 'OCP\\Settings\\ISubAdminSettings' => $baseDir . '/lib/public/Settings/ISubAdminSettings.php',
'OCP\\Share' => $baseDir . '/lib/public/Share.php', 'OCP\\Share' => $baseDir . '/lib/public/Share.php',
'OCP\\Share\\Events\\ShareCreatedEvent' => $baseDir . '/lib/public/Share/Events/ShareCreatedEvent.php', 'OCP\\Share\\Events\\ShareCreatedEvent' => $baseDir . '/lib/public/Share/Events/ShareCreatedEvent.php',
'OCP\\Share\\Events\\ShareDeletedEvent' => $baseDir . '/lib/public/Share/Events/ShareDeletedEvent.php',
'OCP\\Share\\Events\\VerifyMountPointEvent' => $baseDir . '/lib/public/Share/Events/VerifyMountPointEvent.php', 'OCP\\Share\\Events\\VerifyMountPointEvent' => $baseDir . '/lib/public/Share/Events/VerifyMountPointEvent.php',
'OCP\\Share\\Exceptions\\GenericShareException' => $baseDir . '/lib/public/Share/Exceptions/GenericShareException.php', 'OCP\\Share\\Exceptions\\GenericShareException' => $baseDir . '/lib/public/Share/Exceptions/GenericShareException.php',
'OCP\\Share\\Exceptions\\IllegalIDChangeException' => $baseDir . '/lib/public/Share/Exceptions/IllegalIDChangeException.php', 'OCP\\Share\\Exceptions\\IllegalIDChangeException' => $baseDir . '/lib/public/Share/Exceptions/IllegalIDChangeException.php',

View File

@ -506,6 +506,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OCP\\Settings\\ISubAdminSettings' => __DIR__ . '/../../..' . '/lib/public/Settings/ISubAdminSettings.php', 'OCP\\Settings\\ISubAdminSettings' => __DIR__ . '/../../..' . '/lib/public/Settings/ISubAdminSettings.php',
'OCP\\Share' => __DIR__ . '/../../..' . '/lib/public/Share.php', 'OCP\\Share' => __DIR__ . '/../../..' . '/lib/public/Share.php',
'OCP\\Share\\Events\\ShareCreatedEvent' => __DIR__ . '/../../..' . '/lib/public/Share/Events/ShareCreatedEvent.php', 'OCP\\Share\\Events\\ShareCreatedEvent' => __DIR__ . '/../../..' . '/lib/public/Share/Events/ShareCreatedEvent.php',
'OCP\\Share\\Events\\ShareDeletedEvent' => __DIR__ . '/../../..' . '/lib/public/Share/Events/ShareDeletedEvent.php',
'OCP\\Share\\Events\\VerifyMountPointEvent' => __DIR__ . '/../../..' . '/lib/public/Share/Events/VerifyMountPointEvent.php', 'OCP\\Share\\Events\\VerifyMountPointEvent' => __DIR__ . '/../../..' . '/lib/public/Share/Events/VerifyMountPointEvent.php',
'OCP\\Share\\Exceptions\\GenericShareException' => __DIR__ . '/../../..' . '/lib/public/Share/Exceptions/GenericShareException.php', 'OCP\\Share\\Exceptions\\GenericShareException' => __DIR__ . '/../../..' . '/lib/public/Share/Exceptions/GenericShareException.php',
'OCP\\Share\\Exceptions\\IllegalIDChangeException' => __DIR__ . '/../../..' . '/lib/public/Share/Exceptions/IllegalIDChangeException.php', 'OCP\\Share\\Exceptions\\IllegalIDChangeException' => __DIR__ . '/../../..' . '/lib/public/Share/Exceptions/IllegalIDChangeException.php',

View File

@ -1138,6 +1138,7 @@ class Manager implements IManager {
$deletedShares = array_merge($deletedShares, $deletedChildren); $deletedShares = array_merge($deletedShares, $deletedChildren);
$provider->delete($child); $provider->delete($child);
$this->dispatcher->dispatchTyped(new Share\Events\ShareDeletedEvent($child));
$deletedShares[] = $child; $deletedShares[] = $child;
} }
@ -1168,6 +1169,8 @@ class Manager implements IManager {
$provider = $this->factory->getProviderForType($share->getShareType()); $provider = $this->factory->getProviderForType($share->getShareType());
$provider->delete($share); $provider->delete($share);
$this->dispatcher->dispatchTyped(new Share\Events\ShareDeletedEvent($share));
// All the deleted shares caused by this delete // All the deleted shares caused by this delete
$deletedShares[] = $share; $deletedShares[] = $share;

View File

@ -0,0 +1,60 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020, Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @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 OCP\Share\Events;
use OCP\EventDispatcher\Event;
use OCP\Share\IShare;
/**
* @since 21.0.0
*/
class ShareDeletedEvent extends Event {
/** @var IShare */
private $share;
/**
*
* @param IShare $share
* @param IShare[] $children
*
* @since 21.0.0
*/
public function __construct(IShare $share) {
parent::__construct();
$this->share = $share;
}
/**
* @return IShare
* @since 21.0.0
*/
public function getShare(): IShare {
return $this->share;
}
}

View File

@ -209,6 +209,8 @@ class ManagerTest extends \Test\TestCase {
->setMethods(['getShareById', 'deleteChildren']) ->setMethods(['getShareById', 'deleteChildren'])
->getMock(); ->getMock();
$manager->method('deleteChildren')->willReturn([]);
$path = $this->createMock(File::class); $path = $this->createMock(File::class);
$path->method('getId')->willReturn(1); $path->method('getId')->willReturn(1);
@ -254,6 +256,8 @@ class ManagerTest extends \Test\TestCase {
->setMethods(['getShareById', 'deleteChildren']) ->setMethods(['getShareById', 'deleteChildren'])
->getMock(); ->getMock();
$manager->method('deleteChildren')->willReturn([]);
$share = $this->manager->newShare(); $share = $this->manager->newShare();
$share->setId(42) $share->setId(42)
->setProviderId('prov') ->setProviderId('prov')