Merge pull request #39605 from nextcloud/bugfix/noid/final-events-cleanup
fix!: Final round of moving to IEventDispatcherpull/39715/head
Joas Schilling
3 years ago
committed by
GitHub
commit
44b4c16a09
@ -1,57 +0,0 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.com> |
||||
* @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\Listener; |
||||
|
||||
use OC\EventDispatcher\SymfonyAdapter; |
||||
use OCA\Files\Event\LoadAdditionalScriptsEvent; |
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\EventDispatcher\IEventListener; |
||||
use Symfony\Component\EventDispatcher\GenericEvent; |
||||
|
||||
class LegacyLoadAdditionalScriptsAdapter implements IEventListener { |
||||
|
||||
/** @var SymfonyAdapter */ |
||||
private $dispatcher; |
||||
|
||||
public function __construct(SymfonyAdapter $dispatcher) { |
||||
$this->dispatcher = $dispatcher; |
||||
} |
||||
|
||||
public function handle(Event $event): void { |
||||
if (!($event instanceof LoadAdditionalScriptsEvent)) { |
||||
return; |
||||
} |
||||
|
||||
$legacyEvent = new GenericEvent(null, ['hiddenFields' => []]); |
||||
$this->dispatcher->dispatch('OCA\Files::loadAdditionalScripts', $legacyEvent); |
||||
|
||||
$hiddenFields = $legacyEvent->getArgument('hiddenFields'); |
||||
foreach ($hiddenFields as $name => $value) { |
||||
$event->addHiddenField($name, $value); |
||||
} |
||||
} |
||||
} |
||||
@ -1,57 +0,0 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl> |
||||
* |
||||
* @author Julius Härtl <jus@bitgrid.net> |
||||
* |
||||
* @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_Sharing\Listener; |
||||
|
||||
use OC\EventDispatcher\SymfonyAdapter; |
||||
use OCA\Files_Sharing\Event\BeforeTemplateRenderedEvent; |
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\EventDispatcher\IEventListener; |
||||
use Symfony\Component\EventDispatcher\GenericEvent; |
||||
|
||||
class LegacyBeforeTemplateRenderedListener implements IEventListener { |
||||
|
||||
/** @var SymfonyAdapter */ |
||||
private $dispatcher; |
||||
|
||||
public function __construct(SymfonyAdapter $dispatcher) { |
||||
$this->dispatcher = $dispatcher; |
||||
} |
||||
|
||||
public function handle(Event $event): void { |
||||
if (!($event instanceof BeforeTemplateRenderedEvent)) { |
||||
return; |
||||
} |
||||
|
||||
$eventName = 'OCA\Files_Sharing::loadAdditionalScripts'; |
||||
|
||||
if ($event->getScope() !== null) { |
||||
$eventName .= '::' . $event->getScope(); |
||||
} |
||||
|
||||
$legacyEvent = new GenericEvent(null, ['share' => $event->getShare()]); |
||||
$this->dispatcher->dispatch($eventName, $legacyEvent); |
||||
} |
||||
} |
||||
@ -1,124 +0,0 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2020, Roeland Jago Douma <roeland@famdouma.nl> |
||||
* |
||||
* @author Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* @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 OC\EventDispatcher; |
||||
|
||||
use Psr\Log\LoggerInterface; |
||||
use Symfony\Component\EventDispatcher\GenericEvent; |
||||
|
||||
class GenericEventWrapper extends GenericEvent { |
||||
private LoggerInterface $logger; |
||||
|
||||
/** @var GenericEvent */ |
||||
private $event; |
||||
|
||||
/** @var string */ |
||||
private $eventName; |
||||
|
||||
/** @var bool */ |
||||
private $deprecationNoticeLogged = false; |
||||
|
||||
public function __construct(LoggerInterface $logger, string $eventName, ?GenericEvent $event) { |
||||
parent::__construct($eventName); |
||||
$this->logger = $logger; |
||||
$this->event = $event; |
||||
$this->eventName = $eventName; |
||||
} |
||||
|
||||
private function log() { |
||||
if ($this->deprecationNoticeLogged) { |
||||
return; |
||||
} |
||||
|
||||
$class = ($this->event !== null && is_object($this->event)) ? get_class($this->event) : 'null'; |
||||
$this->logger->debug( |
||||
'Deprecated event type for {name}: {class} is used', |
||||
[ 'name' => $this->eventName, 'class' => $class] |
||||
); |
||||
$this->deprecationNoticeLogged = true; |
||||
} |
||||
|
||||
public function isPropagationStopped(): bool { |
||||
$this->log(); |
||||
return $this->event->isPropagationStopped(); |
||||
} |
||||
|
||||
public function stopPropagation(): void { |
||||
$this->log(); |
||||
$this->event->stopPropagation(); |
||||
} |
||||
|
||||
public function getSubject() { |
||||
$this->log(); |
||||
return $this->event->getSubject(); |
||||
} |
||||
|
||||
public function getArgument($key) { |
||||
$this->log(); |
||||
return $this->event->getArgument($key); |
||||
} |
||||
|
||||
public function setArgument($key, $value) { |
||||
$this->log(); |
||||
return $this->event->setArgument($key, $value); |
||||
} |
||||
|
||||
public function getArguments() { |
||||
return $this->event->getArguments(); |
||||
} |
||||
|
||||
public function setArguments(array $args = []) { |
||||
return $this->event->setArguments($args); |
||||
} |
||||
|
||||
public function hasArgument($key) { |
||||
return $this->event->hasArgument($key); |
||||
} |
||||
|
||||
/** |
||||
* @return mixed |
||||
*/ |
||||
#[\ReturnTypeWillChange] |
||||
public function offsetGet($key) { |
||||
return $this->event->offsetGet($key); |
||||
} |
||||
|
||||
public function offsetSet($key, $value): void { |
||||
$this->event->offsetSet($key, $value); |
||||
} |
||||
|
||||
public function offsetUnset($key): void { |
||||
$this->event->offsetUnset($key); |
||||
} |
||||
|
||||
public function offsetExists($key): bool { |
||||
return $this->event->offsetExists($key); |
||||
} |
||||
|
||||
public function getIterator() { |
||||
return$this->event->getIterator(); |
||||
} |
||||
} |
||||
@ -1,208 +0,0 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* |
||||
* @author Arthur Schiwon <blizzz@arthur-schiwon.de> |
||||
* @author Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* @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 OC\EventDispatcher; |
||||
|
||||
use OCP\EventDispatcher\Event; |
||||
use Psr\Log\LoggerInterface; |
||||
use Symfony\Component\EventDispatcher\EventDispatcherInterface; |
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface; |
||||
use Symfony\Component\EventDispatcher\GenericEvent; |
||||
use function is_callable; |
||||
use function is_object; |
||||
use function is_string; |
||||
|
||||
/** |
||||
* @deprecated 20.0.0 use \OCP\EventDispatcher\IEventDispatcher |
||||
*/ |
||||
class SymfonyAdapter implements EventDispatcherInterface { |
||||
/** @var EventDispatcher */ |
||||
private $eventDispatcher; |
||||
private LoggerInterface $logger; |
||||
|
||||
/** |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function __construct(EventDispatcher $eventDispatcher, LoggerInterface $logger) { |
||||
$this->eventDispatcher = $eventDispatcher; |
||||
$this->logger = $logger; |
||||
} |
||||
|
||||
private static function detectEventAndName($a, $b) { |
||||
if (is_object($a) && (is_string($b) || $b === null)) { |
||||
// a is the event, the other one is the optional name |
||||
return [$a, $b]; |
||||
} |
||||
if (is_object($b) && (is_string($a) || $a === null)) { |
||||
// b is the event, the other one is the optional name |
||||
return [$b, $a]; |
||||
} |
||||
if (is_string($a) && $b === null) { |
||||
// a is a payload-less event |
||||
return [null, $a]; |
||||
} |
||||
if (is_string($b) && $a === null) { |
||||
// b is a payload-less event |
||||
return [null, $b]; |
||||
} |
||||
|
||||
// Anything else we can't detect |
||||
return [$a, $b]; |
||||
} |
||||
|
||||
/** |
||||
* Dispatches an event to all registered listeners. |
||||
* |
||||
* @param string $eventName The name of the event to dispatch. The name of |
||||
* the event is the name of the method that is |
||||
* invoked on listeners. |
||||
* @param Event|null $event The event to pass to the event handlers/listeners |
||||
* If not supplied, an empty Event instance is created |
||||
* |
||||
* @return object the emitted event |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function dispatch($eventName, $event = null): object { |
||||
[$event, $eventName] = self::detectEventAndName($event, $eventName); |
||||
|
||||
// type hinting is not possible, due to usage of GenericEvent |
||||
if ($event instanceof Event && $eventName === null) { |
||||
$this->eventDispatcher->dispatchTyped($event); |
||||
return $event; |
||||
} |
||||
if ($event instanceof Event) { |
||||
$this->eventDispatcher->dispatch($eventName, $event); |
||||
return $event; |
||||
} |
||||
|
||||
if ($event instanceof GenericEvent && get_class($event) === GenericEvent::class) { |
||||
$newEvent = new GenericEventWrapper($this->logger, $eventName, $event); |
||||
} else { |
||||
$newEvent = $event; |
||||
|
||||
// Legacy event |
||||
$this->logger->debug( |
||||
'Deprecated event type for {name}: {class}', |
||||
['name' => $eventName, 'class' => is_object($event) ? get_class($event) : 'null'] |
||||
); |
||||
} |
||||
|
||||
// Event with no payload (object) need special handling |
||||
if ($newEvent === null) { |
||||
$newEvent = new Event(); |
||||
} |
||||
|
||||
// Flip the argument order for Symfony to prevent a trigger_error |
||||
return $this->eventDispatcher->getSymfonyDispatcher()->dispatch($newEvent, $eventName); |
||||
} |
||||
|
||||
/** |
||||
* Adds an event listener that listens on the specified events. |
||||
* |
||||
* @param string $eventName The event to listen on |
||||
* @param callable $listener The listener |
||||
* @param int $priority The higher this value, the earlier an event |
||||
* listener will be triggered in the chain (defaults to 0) |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function addListener($eventName, $listener, $priority = 0) { |
||||
if (is_callable($listener)) { |
||||
$this->eventDispatcher->addListener($eventName, $listener, $priority); |
||||
} else { |
||||
// Legacy listener |
||||
$this->eventDispatcher->getSymfonyDispatcher()->addListener($eventName, $listener, $priority); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Adds an event subscriber. |
||||
* |
||||
* The subscriber is asked for all the events it is |
||||
* interested in and added as a listener for these events. |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function addSubscriber(EventSubscriberInterface $subscriber) { |
||||
$this->eventDispatcher->getSymfonyDispatcher()->addSubscriber($subscriber); |
||||
} |
||||
|
||||
/** |
||||
* Removes an event listener from the specified events. |
||||
* |
||||
* @param string $eventName The event to remove a listener from |
||||
* @param callable $listener The listener to remove |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function removeListener($eventName, $listener) { |
||||
$this->eventDispatcher->getSymfonyDispatcher()->removeListener($eventName, $listener); |
||||
} |
||||
|
||||
/** |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function removeSubscriber(EventSubscriberInterface $subscriber) { |
||||
$this->eventDispatcher->getSymfonyDispatcher()->removeSubscriber($subscriber); |
||||
} |
||||
|
||||
/** |
||||
* Gets the listeners of a specific event or all listeners sorted by descending priority. |
||||
* |
||||
* @param string|null $eventName The name of the event |
||||
* |
||||
* @return array The event listeners for the specified event, or all event listeners by event name |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function getListeners($eventName = null) { |
||||
return $this->eventDispatcher->getSymfonyDispatcher()->getListeners($eventName); |
||||
} |
||||
|
||||
/** |
||||
* Gets the listener priority for a specific event. |
||||
* |
||||
* Returns null if the event or the listener does not exist. |
||||
* |
||||
* @param string $eventName The name of the event |
||||
* @param callable $listener The listener |
||||
* |
||||
* @return int|null The event listener priority |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function getListenerPriority($eventName, $listener) { |
||||
return $this->eventDispatcher->getSymfonyDispatcher()->getListenerPriority($eventName, $listener); |
||||
} |
||||
|
||||
/** |
||||
* Checks whether an event has any registered listeners. |
||||
* |
||||
* @param string|null $eventName The name of the event |
||||
* |
||||
* @return bool true if the specified event has any listeners, false otherwise |
||||
* @deprecated 20.0.0 |
||||
*/ |
||||
public function hasListeners($eventName = null) { |
||||
return $this->eventDispatcher->getSymfonyDispatcher()->hasListeners($eventName); |
||||
} |
||||
} |
||||
@ -0,0 +1,58 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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\Accounts; |
||||
|
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\IUser; |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
class UserUpdatedEvent extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
protected IUser $user, |
||||
protected array $data, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getUser(): IUser { |
||||
return $this->user; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getData(): array { |
||||
return $this->data; |
||||
} |
||||
} |
||||
@ -0,0 +1,66 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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\Files\Events; |
||||
|
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\IUser; |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
class NodeAddedToFavorite extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
protected IUser $user, |
||||
protected int $fileId, |
||||
protected string $path, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getUser(): IUser { |
||||
return $this->user; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getFileId(): int { |
||||
return $this->fileId; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getPath(): string { |
||||
return $this->path; |
||||
} |
||||
} |
||||
@ -0,0 +1,66 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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\Files\Events; |
||||
|
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\IUser; |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
class NodeRemovedFromFavorite extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
protected IUser $user, |
||||
protected int $fileId, |
||||
protected string $path, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getUser(): IUser { |
||||
return $this->user; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getFileId(): int { |
||||
return $this->fileId; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getPath(): string { |
||||
return $this->path; |
||||
} |
||||
} |
||||
@ -0,0 +1,66 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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 28.0.0 |
||||
*/ |
||||
class BeforeShareCreatedEvent extends Event { |
||||
private ?string $error = null; |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
private IShare $share, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getShare(): IShare { |
||||
return $this->share; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function setError(string $error): void { |
||||
$this->error = $error; |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getError(): ?string { |
||||
return $this->error; |
||||
} |
||||
} |
||||
@ -0,0 +1,50 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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 28.0.0 |
||||
*/ |
||||
class BeforeShareDeletedEvent extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
private IShare $share, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getShare(): IShare { |
||||
return $this->share; |
||||
} |
||||
} |
||||
@ -0,0 +1,50 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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 28.0.0 |
||||
*/ |
||||
class ShareAcceptedEvent extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
private IShare $share, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getShare(): IShare { |
||||
return $this->share; |
||||
} |
||||
} |
||||
@ -0,0 +1,50 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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 28.0.0 |
||||
*/ |
||||
class ShareDeletedFromSelfEvent extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
private IShare $share, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getShare(): IShare { |
||||
return $this->share; |
||||
} |
||||
} |
||||
@ -0,0 +1,50 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/** |
||||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> |
||||
* |
||||
* @author Joas Schilling <coding@schilljs.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\User\Events; |
||||
|
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\IUser; |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
class UserFirstTimeLoggedInEvent extends Event { |
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function __construct( |
||||
private IUser $user, |
||||
) { |
||||
parent::__construct(); |
||||
} |
||||
|
||||
/** |
||||
* @since 28.0.0 |
||||
*/ |
||||
public function getUser(): IUser { |
||||
return $this->user; |
||||
} |
||||
} |
||||
@ -1,191 +0,0 @@ |
||||
<?php |
||||
|
||||
declare(strict_types=1); |
||||
|
||||
/* |
||||
* @copyright 2021 Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* |
||||
* @author 2021 Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* |
||||
* @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 lib\EventDispatcher; |
||||
|
||||
use OC\EventDispatcher\EventDispatcher; |
||||
use OC\EventDispatcher\GenericEventWrapper; |
||||
use OC\EventDispatcher\SymfonyAdapter; |
||||
use OCP\EventDispatcher\Event; |
||||
use OCP\EventDispatcher\GenericEvent; |
||||
use PHPUnit\Framework\MockObject\MockObject; |
||||
use Psr\Log\LoggerInterface; |
||||
use Symfony\Component\EventDispatcher\Event as SymfonyEvent; |
||||
use Symfony\Component\EventDispatcher\EventDispatcher as SymfonyDispatcher; |
||||
use Symfony\Component\EventDispatcher\EventDispatcherInterface; |
||||
use Symfony\Component\EventDispatcher\GenericEvent as SymfonyGenericEvent; |
||||
use Test\TestCase; |
||||
|
||||
class SymfonyAdapterTest extends TestCase { |
||||
/** @var EventDispatcher|MockObject */ |
||||
private $eventDispatcher; |
||||
|
||||
/** @var LoggerInterface|MockObject */ |
||||
private $logger; |
||||
|
||||
/** @var EventDispatcherInterface */ |
||||
private $adapter; |
||||
|
||||
protected function setUp(): void { |
||||
parent::setUp(); |
||||
|
||||
$this->eventDispatcher = $this->createMock(EventDispatcher::class); |
||||
$this->logger = $this->createMock(LoggerInterface::class); |
||||
|
||||
$this->adapter = new SymfonyAdapter( |
||||
$this->eventDispatcher, |
||||
$this->logger |
||||
); |
||||
} |
||||
|
||||
public function testDispatchTypedEvent(): void { |
||||
$event = new Event(); |
||||
$eventName = 'symfony'; |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
$eventName, |
||||
$event |
||||
) |
||||
->willReturnArgument(0); |
||||
|
||||
$this->adapter->dispatch($eventName, $event); |
||||
} |
||||
|
||||
public function testDispatchSymfonyGenericEvent(): void { |
||||
$eventName = 'symfony'; |
||||
$event = new SymfonyGenericEvent(); |
||||
$wrapped = new GenericEventWrapper( |
||||
$this->logger, |
||||
$eventName, |
||||
$event |
||||
); |
||||
$symfonyDispatcher = $this->createMock(SymfonyDispatcher::class); |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('getSymfonyDispatcher') |
||||
->willReturn($symfonyDispatcher); |
||||
$symfonyDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
self::equalTo($wrapped), |
||||
$eventName |
||||
) |
||||
->willReturnArgument(0); |
||||
|
||||
$result = $this->adapter->dispatch($eventName, $event); |
||||
|
||||
self::assertEquals($result, $wrapped); |
||||
} |
||||
|
||||
public function testDispatchOldSymfonyEventWithFlippedArgumentOrder(): void { |
||||
$event = new SymfonyEvent(); |
||||
$eventName = 'symfony'; |
||||
$symfonyDispatcher = $this->createMock(SymfonyDispatcher::class); |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('getSymfonyDispatcher') |
||||
->willReturn($symfonyDispatcher); |
||||
$symfonyDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
$event, |
||||
$eventName |
||||
) |
||||
->willReturnArgument(0); |
||||
|
||||
$result = $this->adapter->dispatch($event, $eventName); |
||||
|
||||
self::assertSame($result, $event); |
||||
} |
||||
|
||||
public function testDispatchOldSymfonyEvent(): void { |
||||
$event = new SymfonyEvent(); |
||||
$eventName = 'symfony'; |
||||
$symfonyDispatcher = $this->createMock(SymfonyDispatcher::class); |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('getSymfonyDispatcher') |
||||
->willReturn($symfonyDispatcher); |
||||
$symfonyDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
$event, |
||||
$eventName |
||||
) |
||||
->willReturnArgument(0); |
||||
|
||||
$result = $this->adapter->dispatch($eventName, $event); |
||||
|
||||
self::assertSame($result, $event); |
||||
} |
||||
|
||||
public function testDispatchCustomGenericEventWithFlippedArgumentOrder(): void { |
||||
$event = new GenericEvent(); |
||||
$eventName = 'symfony'; |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
$eventName, |
||||
$event |
||||
) |
||||
->willReturnArgument(0); |
||||
|
||||
$result = $this->adapter->dispatch($event, $eventName); |
||||
|
||||
self::assertSame($result, $event); |
||||
} |
||||
|
||||
public function testDispatchCustomGenericEvent(): void { |
||||
$event = new GenericEvent(); |
||||
$eventName = 'symfony'; |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
$eventName, |
||||
$event |
||||
); |
||||
|
||||
$result = $this->adapter->dispatch($eventName, $event); |
||||
|
||||
self::assertSame($result, $event); |
||||
} |
||||
|
||||
public function testDispatchEventWithoutPayload(): void { |
||||
$eventName = 'symfony'; |
||||
$symfonyDispatcher = $this->createMock(SymfonyDispatcher::class); |
||||
$this->eventDispatcher->expects(self::once()) |
||||
->method('getSymfonyDispatcher') |
||||
->willReturn($symfonyDispatcher); |
||||
$symfonyDispatcher->expects(self::once()) |
||||
->method('dispatch') |
||||
->with( |
||||
$this->anything(), |
||||
$eventName |
||||
) |
||||
->willReturnArgument(0); |
||||
|
||||
$result = $this->adapter->dispatch($eventName); |
||||
|
||||
self::assertNotNull($result); |
||||
} |
||||
} |
||||
Loading…
Reference in new issue