diff options
Diffstat (limited to 'lib/private/EventDispatcher')
-rw-r--r-- | lib/private/EventDispatcher/EventDispatcher.php | 72 | ||||
-rw-r--r-- | lib/private/EventDispatcher/GenericEventWrapper.php | 124 | ||||
-rw-r--r-- | lib/private/EventDispatcher/ServiceEventListener.php | 49 | ||||
-rw-r--r-- | lib/private/EventDispatcher/SymfonyAdapter.php | 209 |
4 files changed, 36 insertions, 418 deletions
diff --git a/lib/private/EventDispatcher/EventDispatcher.php b/lib/private/EventDispatcher/EventDispatcher.php index 2a306344923..474c902013b 100644 --- a/lib/private/EventDispatcher/EventDispatcher.php +++ b/lib/private/EventDispatcher/EventDispatcher.php @@ -3,73 +3,49 @@ declare(strict_types=1); /** - * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @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/>. - * + * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ namespace OC\EventDispatcher; -use Psr\Log\LoggerInterface; -use function get_class; use OC\Broadcast\Events\BroadcastEvent; +use OC\Log; use OCP\Broadcast\Events\IBroadcastEvent; use OCP\EventDispatcher\ABroadcastedEvent; use OCP\EventDispatcher\Event; use OCP\EventDispatcher\IEventDispatcher; -use OCP\IContainer; -use OCP\IServerContainer; +use Psr\Container\ContainerInterface; +use Psr\Log\LoggerInterface; use Symfony\Component\EventDispatcher\EventDispatcher as SymfonyDispatcher; +use function get_class; class EventDispatcher implements IEventDispatcher { - /** @var SymfonyDispatcher */ - private $dispatcher; - - /** @var IContainer */ - private $container; - - /** @var LoggerInterface */ - private $logger; - - public function __construct(SymfonyDispatcher $dispatcher, - IServerContainer $container, - LoggerInterface $logger) { - $this->dispatcher = $dispatcher; - $this->container = $container; - $this->logger = $logger; + public function __construct( + private SymfonyDispatcher $dispatcher, + private ContainerInterface $container, + private LoggerInterface $logger, + ) { + // inject the event dispatcher into the logger + // this is done here because there is a cyclic dependency between the event dispatcher and logger + if ($this->logger instanceof Log || $this->logger instanceof Log\PsrLoggerAdapter) { + $this->logger->setEventDispatcher($this); + } } public function addListener(string $eventName, - callable $listener, - int $priority = 0): void { + callable $listener, + int $priority = 0): void { $this->dispatcher->addListener($eventName, $listener, $priority); } public function removeListener(string $eventName, - callable $listener): void { + callable $listener): void { $this->dispatcher->removeListener($eventName, $listener); } public function addServiceListener(string $eventName, - string $className, - int $priority = 0): void { + string $className, + int $priority = 0): void { $listener = new ServiceEventListener( $this->container, $className, @@ -79,11 +55,15 @@ class EventDispatcher implements IEventDispatcher { $this->addListener($eventName, $listener, $priority); } + public function hasListeners(string $eventName): bool { + return $this->dispatcher->hasListeners($eventName); + } + /** * @deprecated */ public function dispatch(string $eventName, - Event $event): void { + Event $event): void { $this->dispatcher->dispatch($event, $eventName); if ($event instanceof ABroadcastedEvent && !$event->isPropagationStopped()) { diff --git a/lib/private/EventDispatcher/GenericEventWrapper.php b/lib/private/EventDispatcher/GenericEventWrapper.php deleted file mode 100644 index b4d851d700f..00000000000 --- a/lib/private/EventDispatcher/GenericEventWrapper.php +++ /dev/null @@ -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->info( - '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(); - } -} diff --git a/lib/private/EventDispatcher/ServiceEventListener.php b/lib/private/EventDispatcher/ServiceEventListener.php index 21cdf7f8cc2..f9cc85b4126 100644 --- a/lib/private/EventDispatcher/ServiceEventListener.php +++ b/lib/private/EventDispatcher/ServiceEventListener.php @@ -3,26 +3,8 @@ declare(strict_types=1); /** - * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @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/>. - * + * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ namespace OC\EventDispatcher; @@ -30,7 +12,7 @@ namespace OC\EventDispatcher; use OCP\AppFramework\QueryException; use OCP\EventDispatcher\Event; use OCP\EventDispatcher\IEventListener; -use OCP\IServerContainer; +use Psr\Container\ContainerInterface; use Psr\Log\LoggerInterface; use function sprintf; @@ -41,24 +23,13 @@ use function sprintf; * created by the service container */ final class ServiceEventListener { - /** @var IServerContainer */ - private $container; - - /** @var string */ - private $class; - - /** @var LoggerInterface */ - private $logger; - - /** @var null|IEventListener */ - private $service; + private ?IEventListener $service = null; - public function __construct(IServerContainer $container, - string $class, - LoggerInterface $logger) { - $this->container = $container; - $this->class = $class; - $this->logger = $logger; + public function __construct( + private ContainerInterface $container, + private string $class, + private LoggerInterface $logger, + ) { } public function __invoke(Event $event) { @@ -67,7 +38,7 @@ final class ServiceEventListener { // TODO: fetch from the app containers, otherwise any custom services, // parameters and aliases won't be resolved. // See https://github.com/nextcloud/server/issues/27793 for details. - $this->service = $this->container->query($this->class); + $this->service = $this->container->get($this->class); } catch (QueryException $e) { $this->logger->error( sprintf( diff --git a/lib/private/EventDispatcher/SymfonyAdapter.php b/lib/private/EventDispatcher/SymfonyAdapter.php deleted file mode 100644 index aa6fcbc1ad3..00000000000 --- a/lib/private/EventDispatcher/SymfonyAdapter.php +++ /dev/null @@ -1,209 +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->info( - '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) { - $this->eventDispatcher->getSymfonyDispatcher()->dispatch($eventName); - return 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); - } -} |