vendor/symfony/event-dispatcher/Debug/TraceableEventDispatcher.php line 133

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\EventDispatcher\Debug;
  14. use Psr\EventDispatcher\StoppableEventInterface;
  15. use Psr\Log\LoggerInterface;
  16. use Symfony\Component\EventDispatcher\EventDispatcher;
  17. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpFoundation\RequestStack;
  21. use Symfony\Component\Stopwatch\Stopwatch;
  22. use Symfony\Contracts\Service\ResetInterface;
  24. /**
  25.  * Collects some data about event listeners.
  26.  *
  27.  * This event dispatcher delegates the dispatching to another one.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  */
  31. class TraceableEventDispatcher implements EventDispatcherInterface, ResetInterface
  32. {
  33.     protected $logger;
  34.     protected $stopwatch;
  36.     /**
  37.      * @var \SplObjectStorage<WrappedListener, array{string, string}>|null
  38.      */
  39.     private ?\SplObjectStorage $callStack = null;
  40.     private EventDispatcherInterface $dispatcher;
  41.     private array $wrappedListeners = [];
  42.     private array $orphanedEvents = [];
  43.     private ?RequestStack $requestStack;
  44.     private string $currentRequestHash = '';
  46.     public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, ?LoggerInterface $logger = null, ?RequestStack $requestStack = null)
  47.     {
  48.         $this->dispatcher = $dispatcher;
  49.         $this->stopwatch = $stopwatch;
  50.         $this->logger = $logger;
  51.         $this->requestStack = $requestStack;
  52.     }
  54.     /**
  55.      * @return void
  56.      */
  57.     public function addListener(string $eventName, callable|array $listener, int $priority = 0)
  58.     {
  59.         $this->dispatcher->addListener($eventName, $listener, $priority);
  60.     }
  62.     /**
  63.      * @return void
  64.      */
  65.     public function addSubscriber(EventSubscriberInterface $subscriber)
  66.     {
  67.         $this->dispatcher->addSubscriber($subscriber);
  68.     }
  70.     /**
  71.      * @return void
  72.      */
  73.     public function removeListener(string $eventName, callable|array $listener)
  74.     {
  75.         if (isset($this->wrappedListeners[$eventName])) {
  76.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  77.                 if ($wrappedListener->getWrappedListener() === $listener || ($listener instanceof \Closure && $wrappedListener->getWrappedListener() == $listener)) {
  78.                     $listener = $wrappedListener;
  79.                     unset($this->wrappedListeners[$eventName][$index]);
  80.                     break;
  81.                 }
  82.             }
  83.         }
  85.         $this->dispatcher->removeListener($eventName, $listener);
  86.     }
  88.     /**
  89.      * @return void
  90.      */
  91.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  92.     {
  93.         $this->dispatcher->removeSubscriber($subscriber);
  94.     }
  96.     public function getListeners(?string $eventName = null): array
  97.     {
  98.         return $this->dispatcher->getListeners($eventName);
  99.     }
  101.     public function getListenerPriority(string $eventName, callable|array $listener): ?int
  102.     {
  103.         // we might have wrapped listeners for the event (if called while dispatching)
  104.         // in that case get the priority by wrapper
  105.         if (isset($this->wrappedListeners[$eventName])) {
  106.             foreach ($this->wrappedListeners[$eventName] as $wrappedListener) {
  107.                 if ($wrappedListener->getWrappedListener() === $listener || ($listener instanceof \Closure && $wrappedListener->getWrappedListener() == $listener)) {
  108.                     return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  109.                 }
  110.             }
  111.         }
  113.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  114.     }
  116.     public function hasListeners(?string $eventName = null): bool
  117.     {
  118.         return $this->dispatcher->hasListeners($eventName);
  119.     }
  121.     public function dispatch(object $event, ?string $eventName = null): object
  122.     {
  123.         $eventName ??= $event::class;
  125.         $this->callStack ??= new \SplObjectStorage();
  127.         $currentRequestHash = $this->currentRequestHash = $this->requestStack && ($request = $this->requestStack->getCurrentRequest()) ? spl_object_hash($request) : '';
  129.         if (null !== $this->logger && $event instanceof StoppableEventInterface && $event->isPropagationStopped()) {
  130.             $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  131.         }
  133.         $this->preProcess($eventName);
  134.         try {
  135.             $this->beforeDispatch($eventName, $event);
  136.             try {
  137.                 $e = $this->stopwatch->start($eventName, 'section');
  138.                 try {
  139.                     $this->dispatcher->dispatch($event, $eventName);
  140.                 } finally {
  141.                     if ($e->isStarted()) {
  142.                         $e->stop();
  143.                     }
  144.                 }
  145.             } finally {
  146.                 $this->afterDispatch($eventName, $event);
  147.             }
  148.         } finally {
  149.             $this->currentRequestHash = $currentRequestHash;
  150.             $this->postProcess($eventName);
  151.         }
  153.         return $event;
  154.     }
  156.     public function getCalledListeners(?Request $request = null): array
  157.     {
  158.         if (null === $this->callStack) {
  159.             return [];
  160.         }
  162.         $hash = $request ? spl_object_hash($request) : null;
  163.         $called = [];
  164.         foreach ($this->callStack as $listener) {
  165.             [$eventName, $requestHash] = $this->callStack->getInfo();
  166.             if (null === $hash || $hash === $requestHash) {
  167.                 $called[] = $listener->getInfo($eventName);
  168.             }
  169.         }
  171.         return $called;
  172.     }
  174.     public function getNotCalledListeners(?Request $request = null): array
  175.     {
  176.         try {
  177.             $allListeners = $this->dispatcher instanceof EventDispatcher ? $this->getListenersWithPriority() : $this->getListenersWithoutPriority();
  178.         } catch (\Exception $e) {
  179.             $this->logger?->info('An exception was thrown while getting the uncalled listeners.', ['exception' => $e]);
  181.             // unable to retrieve the uncalled listeners
  182.             return [];
  183.         }
  185.         $hash = $request ? spl_object_hash($request) : null;
  186.         $calledListeners = [];
  188.         if (null !== $this->callStack) {
  189.             foreach ($this->callStack as $calledListener) {
  190.                 [, $requestHash] = $this->callStack->getInfo();
  192.                 if (null === $hash || $hash === $requestHash) {
  193.                     $calledListeners[] = $calledListener->getWrappedListener();
  194.                 }
  195.             }
  196.         }
  198.         $notCalled = [];
  200.         foreach ($allListeners as $eventName => $listeners) {
  201.             foreach ($listeners as [$listener, $priority]) {
  202.                 if (!\in_array($listener, $calledListeners, true)) {
  203.                     if (!$listener instanceof WrappedListener) {
  204.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this, $priority);
  205.                     }
  206.                     $notCalled[] = $listener->getInfo($eventName);
  207.                 }
  208.             }
  209.         }
  211.         uasort($notCalled, $this->sortNotCalledListeners(...));
  213.         return $notCalled;
  214.     }
  216.     public function getOrphanedEvents(?Request $request = null): array
  217.     {
  218.         if ($request) {
  219.             return $this->orphanedEvents[spl_object_hash($request)] ?? [];
  220.         }
  222.         if (!$this->orphanedEvents) {
  223.             return [];
  224.         }
  226.         return array_merge(...array_values($this->orphanedEvents));
  227.     }
  229.     /**
  230.      * @return void
  231.      */
  232.     public function reset()
  233.     {
  234.         $this->callStack = null;
  235.         $this->orphanedEvents = [];
  236.         $this->currentRequestHash = '';
  237.     }
  239.     /**
  240.      * Proxies all method calls to the original event dispatcher.
  241.      *
  242.      * @param string $method    The method name
  243.      * @param array  $arguments The method arguments
  244.      */
  245.     public function __call(string $method, array $arguments): mixed
  246.     {
  247.         return $this->dispatcher->{$method}(...$arguments);
  248.     }
  250.     /**
  251.      * Called before dispatching the event.
  252.      *
  253.      * @return void
  254.      */
  255.     protected function beforeDispatch(string $eventName, object $event)
  256.     {
  257.     }
  259.     /**
  260.      * Called after dispatching the event.
  261.      *
  262.      * @return void
  263.      */
  264.     protected function afterDispatch(string $eventName, object $event)
  265.     {
  266.     }
  268.     private function preProcess(string $eventName): void
  269.     {
  270.         if (!$this->dispatcher->hasListeners($eventName)) {
  271.             $this->orphanedEvents[$this->currentRequestHash][] = $eventName;
  273.             return;
  274.         }
  276.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  277.             $priority = $this->getListenerPriority($eventName, $listener);
  278.             $wrappedListener = new WrappedListener($listener instanceof WrappedListener ? $listener->getWrappedListener() : $listener, null, $this->stopwatch, $this);
  279.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  280.             $this->dispatcher->removeListener($eventName, $listener);
  281.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  282.             $this->callStack->attach($wrappedListener, [$eventName, $this->currentRequestHash]);
  283.         }
  284.     }
  286.     private function postProcess(string $eventName): void
  287.     {
  288.         unset($this->wrappedListeners[$eventName]);
  289.         $skipped = false;
  290.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  291.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  292.                 continue;
  293.             }
  294.             // Unwrap listener
  295.             $priority = $this->getListenerPriority($eventName, $listener);
  296.             $this->dispatcher->removeListener($eventName, $listener);
  297.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  299.             if (null !== $this->logger) {
  300.                 $context = ['event' => $eventName, 'listener' => $listener->getPretty()];
  301.             }
  303.             if ($listener->wasCalled()) {
  304.                 $this->logger?->debug('Notified event "{event}" to listener "{listener}".', $context);
  305.             } else {
  306.                 $this->callStack->detach($listener);
  307.             }
  309.             if (null !== $this->logger && $skipped) {
  310.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  311.             }
  313.             if ($listener->stoppedPropagation()) {
  314.                 $this->logger?->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  316.                 $skipped = true;
  317.             }
  318.         }
  319.     }
  321.     private function sortNotCalledListeners(array $a, array $b): int
  322.     {
  323.         if (0 !== $cmp = strcmp($a['event'], $b['event'])) {
  324.             return $cmp;
  325.         }
  327.         if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  328.             return 1;
  329.         }
  331.         if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  332.             return -1;
  333.         }
  335.         if ($a['priority'] === $b['priority']) {
  336.             return 0;
  337.         }
  339.         if ($a['priority'] > $b['priority']) {
  340.             return -1;
  341.         }
  343.         return 1;
  344.     }
  346.     private function getListenersWithPriority(): array
  347.     {
  348.         $result = [];
  350.         $allListeners = new \ReflectionProperty(EventDispatcher::class, 'listeners');
  352.         foreach ($allListeners->getValue($this->dispatcher) as $eventName => $listenersByPriority) {
  353.             foreach ($listenersByPriority as $priority => $listeners) {
  354.                 foreach ($listeners as $listener) {
  355.                     $result[$eventName][] = [$listener, $priority];
  356.                 }
  357.             }
  358.         }
  360.         return $result;
  361.     }
  363.     private function getListenersWithoutPriority(): array
  364.     {
  365.         $result = [];
  367.         foreach ($this->getListeners() as $eventName => $listeners) {
  368.             foreach ($listeners as $listener) {
  369.                 $result[$eventName][] = [$listener, null];
  370.             }
  371.         }
  373.         return $result;
  374.     }
  375. }