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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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\EventDispatcherInterface;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\HttpFoundation\RequestStack;
  20. use Symfony\Component\Stopwatch\Stopwatch;
  21. use Symfony\Contracts\Service\ResetInterface;
  23. /**
  24.  * Collects some data about event listeners.
  25.  *
  26.  * This event dispatcher delegates the dispatching to another one.
  27.  *
  28.  * @author Fabien Potencier <[email protected]>
  29.  */
  30. class TraceableEventDispatcher implements EventDispatcherInterface, ResetInterface
  31. {
  32.     protected $logger;
  33.     protected $stopwatch;
  35.     /**
  36.      * @var \SplObjectStorage<WrappedListener, array{string, string}>|null
  37.      */
  38.     private ?\SplObjectStorage $callStack = null;
  39.     private $dispatcher;
  40.     private array $wrappedListeners = [];
  41.     private array $orphanedEvents = [];
  42.     private $requestStack;
  43.     private string $currentRequestHash = '';
  45.     public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null, RequestStack $requestStack = null)
  46.     {
  47.         $this->dispatcher = $dispatcher;
  48.         $this->stopwatch = $stopwatch;
  49.         $this->logger = $logger;
  50.         $this->requestStack = $requestStack;
  51.     }
  53.     /**
  54.      * {@inheritdoc}
  55.      */
  56.     public function addListener(string $eventName, callable|array $listener, int $priority = 0)
  57.     {
  58.         $this->dispatcher->addListener($eventName, $listener, $priority);
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function addSubscriber(EventSubscriberInterface $subscriber)
  65.     {
  66.         $this->dispatcher->addSubscriber($subscriber);
  67.     }
  69.     /**
  70.      * {@inheritdoc}
  71.      */
  72.     public function removeListener(string $eventName, callable|array $listener)
  73.     {
  74.         if (isset($this->wrappedListeners[$eventName])) {
  75.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  76.                 if ($wrappedListener->getWrappedListener() === $listener || ($listener instanceof \Closure && $wrappedListener->getWrappedListener() == $listener)) {
  77.                     $listener = $wrappedListener;
  78.                     unset($this->wrappedListeners[$eventName][$index]);
  79.                     break;
  80.                 }
  81.             }
  82.         }
  84.         return $this->dispatcher->removeListener($eventName, $listener);
  85.     }
  87.     /**
  88.      * {@inheritdoc}
  89.      */
  90.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  91.     {
  92.         return $this->dispatcher->removeSubscriber($subscriber);
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function getListeners(string $eventName = null): array
  99.     {
  100.         return $this->dispatcher->getListeners($eventName);
  101.     }
  103.     /**
  104.      * {@inheritdoc}
  105.      */
  106.     public function getListenerPriority(string $eventName, callable|array $listener): ?int
  107.     {
  108.         // we might have wrapped listeners for the event (if called while dispatching)
  109.         // in that case get the priority by wrapper
  110.         if (isset($this->wrappedListeners[$eventName])) {
  111.             foreach ($this->wrappedListeners[$eventName] as $wrappedListener) {
  112.                 if ($wrappedListener->getWrappedListener() === $listener || ($listener instanceof \Closure && $wrappedListener->getWrappedListener() == $listener)) {
  113.                     return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  114.                 }
  115.             }
  116.         }
  118.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  119.     }
  121.     /**
  122.      * {@inheritdoc}
  123.      */
  124.     public function hasListeners(string $eventName = null): bool
  125.     {
  126.         return $this->dispatcher->hasListeners($eventName);
  127.     }
  129.     /**
  130.      * {@inheritdoc}
  131.      */
  132.     public function dispatch(object $event, string $eventName = null): object
  133.     {
  134.         $eventName = $eventName ?? \get_class($event);
  136.         if (null === $this->callStack) {
  137.             $this->callStack = new \SplObjectStorage();
  138.         }
  140.         $currentRequestHash = $this->currentRequestHash = $this->requestStack && ($request = $this->requestStack->getCurrentRequest()) ? spl_object_hash($request) : '';
  142.         if (null !== $this->logger && $event instanceof StoppableEventInterface && $event->isPropagationStopped()) {
  143.             $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  144.         }
  146.         $this->preProcess($eventName);
  147.         try {
  148.             $this->beforeDispatch($eventName, $event);
  149.             try {
  150.                 $e = $this->stopwatch->start($eventName, 'section');
  151.                 try {
  152.                     $this->dispatcher->dispatch($event, $eventName);
  153.                 } finally {
  154.                     if ($e->isStarted()) {
  155.                         $e->stop();
  156.                     }
  157.                 }
  158.             } finally {
  159.                 $this->afterDispatch($eventName, $event);
  160.             }
  161.         } finally {
  162.             $this->currentRequestHash = $currentRequestHash;
  163.             $this->postProcess($eventName);
  164.         }
  166.         return $event;
  167.     }
  169.     public function getCalledListeners(Request $request = null): array
  170.     {
  171.         if (null === $this->callStack) {
  172.             return [];
  173.         }
  175.         $hash = $request ? spl_object_hash($request) : null;
  176.         $called = [];
  177.         foreach ($this->callStack as $listener) {
  178.             [$eventName, $requestHash] = $this->callStack->getInfo();
  179.             if (null === $hash || $hash === $requestHash) {
  180.                 $called[] = $listener->getInfo($eventName);
  181.             }
  182.         }
  184.         return $called;
  185.     }
  187.     public function getNotCalledListeners(Request $request = null): array
  188.     {
  189.         try {
  190.             $allListeners = $this->getListeners();
  191.         } catch (\Exception $e) {
  192.             if (null !== $this->logger) {
  193.                 $this->logger->info('An exception was thrown while getting the uncalled listeners.', ['exception' => $e]);
  194.             }
  196.             // unable to retrieve the uncalled listeners
  197.             return [];
  198.         }
  200.         $hash = $request ? spl_object_hash($request) : null;
  201.         $calledListeners = [];
  203.         if (null !== $this->callStack) {
  204.             foreach ($this->callStack as $calledListener) {
  205.                 [, $requestHash] = $this->callStack->getInfo();
  207.                 if (null === $hash || $hash === $requestHash) {
  208.                     $calledListeners[] = $calledListener->getWrappedListener();
  209.                 }
  210.             }
  211.         }
  213.         $notCalled = [];
  214.         foreach ($allListeners as $eventName => $listeners) {
  215.             foreach ($listeners as $listener) {
  216.                 if (!\in_array($listener, $calledListeners, true)) {
  217.                     if (!$listener instanceof WrappedListener) {
  218.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this);
  219.                     }
  220.                     $notCalled[] = $listener->getInfo($eventName);
  221.                 }
  222.             }
  223.         }
  225.         uasort($notCalled, [$this, 'sortNotCalledListeners']);
  227.         return $notCalled;
  228.     }
  230.     public function getOrphanedEvents(Request $request = null): array
  231.     {
  232.         if ($request) {
  233.             return $this->orphanedEvents[spl_object_hash($request)] ?? [];
  234.         }
  236.         if (!$this->orphanedEvents) {
  237.             return [];
  238.         }
  240.         return array_merge(...array_values($this->orphanedEvents));
  241.     }
  243.     public function reset()
  244.     {
  245.         $this->callStack = null;
  246.         $this->orphanedEvents = [];
  247.         $this->currentRequestHash = '';
  248.     }
  250.     /**
  251.      * Proxies all method calls to the original event dispatcher.
  252.      *
  253.      * @param string $method    The method name
  254.      * @param array  $arguments The method arguments
  255.      */
  256.     public function __call(string $method, array $arguments): mixed
  257.     {
  258.         return $this->dispatcher->{$method}(...$arguments);
  259.     }
  261.     /**
  262.      * Called before dispatching the event.
  263.      */
  264.     protected function beforeDispatch(string $eventName, object $event)
  265.     {
  266.     }
  268.     /**
  269.      * Called after dispatching the event.
  270.      */
  271.     protected function afterDispatch(string $eventName, object $event)
  272.     {
  273.     }
  275.     private function preProcess(string $eventName): void
  276.     {
  277.         if (!$this->dispatcher->hasListeners($eventName)) {
  278.             $this->orphanedEvents[$this->currentRequestHash][] = $eventName;
  280.             return;
  281.         }
  283.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  284.             $priority = $this->getListenerPriority($eventName, $listener);
  285.             $wrappedListener = new WrappedListener($listener instanceof WrappedListener ? $listener->getWrappedListener() : $listener, null, $this->stopwatch, $this);
  286.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  287.             $this->dispatcher->removeListener($eventName, $listener);
  288.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  289.             $this->callStack->attach($wrappedListener, [$eventName, $this->currentRequestHash]);
  290.         }
  291.     }
  293.     private function postProcess(string $eventName): void
  294.     {
  295.         unset($this->wrappedListeners[$eventName]);
  296.         $skipped = false;
  297.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  298.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  299.                 continue;
  300.             }
  301.             // Unwrap listener
  302.             $priority = $this->getListenerPriority($eventName, $listener);
  303.             $this->dispatcher->removeListener($eventName, $listener);
  304.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  306.             if (null !== $this->logger) {
  307.                 $context = ['event' => $eventName, 'listener' => $listener->getPretty()];
  308.             }
  310.             if ($listener->wasCalled()) {
  311.                 if (null !== $this->logger) {
  312.                     $this->logger->debug('Notified event "{event}" to listener "{listener}".', $context);
  313.                 }
  314.             } else {
  315.                 $this->callStack->detach($listener);
  316.             }
  318.             if (null !== $this->logger && $skipped) {
  319.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  320.             }
  322.             if ($listener->stoppedPropagation()) {
  323.                 if (null !== $this->logger) {
  324.                     $this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  325.                 }
  327.                 $skipped = true;
  328.             }
  329.         }
  330.     }
  332.     private function sortNotCalledListeners(array $a, array $b)
  333.     {
  334.         if (0 !== $cmp = strcmp($a['event'], $b['event'])) {
  335.             return $cmp;
  336.         }
  338.         if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  339.             return 1;
  340.         }
  342.         if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  343.             return -1;
  344.         }
  346.         if ($a['priority'] === $b['priority']) {
  347.             return 0;
  348.         }
  350.         if ($a['priority'] > $b['priority']) {
  351.             return -1;
  352.         }
  354.         return 1;
  355.     }
  356. }