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

Open in your IDE?
  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\Log\LoggerInterface;
  15. use Symfony\Component\EventDispatcher\Event;
  16. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\Stopwatch\Stopwatch;
  20. /**
  21.  * Collects some data about event listeners.
  22.  *
  23.  * This event dispatcher delegates the dispatching to another one.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. class TraceableEventDispatcher implements TraceableEventDispatcherInterface
  28. {
  29.     protected $logger;
  30.     protected $stopwatch;
  32.     private $callStack;
  33.     private $dispatcher;
  34.     private $wrappedListeners;
  35.     private $orphanedEvents;
  37.     public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
  38.     {
  39.         $this->dispatcher = $dispatcher;
  40.         $this->stopwatch = $stopwatch;
  41.         $this->logger = $logger;
  42.         $this->wrappedListeners = [];
  43.         $this->orphanedEvents = [];
  44.     }
  46.     /**
  47.      * {@inheritdoc}
  48.      */
  49.     public function addListener($eventName, $listener, $priority = 0)
  50.     {
  51.         $this->dispatcher->addListener($eventName, $listener, $priority);
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     public function addSubscriber(EventSubscriberInterface $subscriber)
  58.     {
  59.         $this->dispatcher->addSubscriber($subscriber);
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function removeListener($eventName, $listener)
  66.     {
  67.         if (isset($this->wrappedListeners[$eventName])) {
  68.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  69.                 if ($wrappedListener->getWrappedListener() === $listener) {
  70.                     $listener = $wrappedListener;
  71.                     unset($this->wrappedListeners[$eventName][$index]);
  72.                     break;
  73.                 }
  74.             }
  75.         }
  77.         return $this->dispatcher->removeListener($eventName, $listener);
  78.     }
  80.     /**
  81.      * {@inheritdoc}
  82.      */
  83.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  84.     {
  85.         return $this->dispatcher->removeSubscriber($subscriber);
  86.     }
  88.     /**
  89.      * {@inheritdoc}
  90.      */
  91.     public function getListeners($eventName = null)
  92.     {
  93.         return $this->dispatcher->getListeners($eventName);
  94.     }
  96.     /**
  97.      * {@inheritdoc}
  98.      */
  99.     public function getListenerPriority($eventName, $listener)
  100.     {
  101.         // we might have wrapped listeners for the event (if called while dispatching)
  102.         // in that case get the priority by wrapper
  103.         if (isset($this->wrappedListeners[$eventName])) {
  104.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  105.                 if ($wrappedListener->getWrappedListener() === $listener) {
  106.                     return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  107.                 }
  108.             }
  109.         }
  111.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  112.     }
  114.     /**
  115.      * {@inheritdoc}
  116.      */
  117.     public function hasListeners($eventName = null)
  118.     {
  119.         return $this->dispatcher->hasListeners($eventName);
  120.     }
  122.     /**
  123.      * {@inheritdoc}
  124.      */
  125.     public function dispatch($eventName, Event $event = null)
  126.     {
  127.         if (null === $this->callStack) {
  128.             $this->callStack = new \SplObjectStorage();
  129.         }
  131.         if (null === $event) {
  132.             $event = new Event();
  133.         }
  135.         if (null !== $this->logger && $event->isPropagationStopped()) {
  136.             $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  137.         }
  139.         $this->preProcess($eventName);
  140.         try {
  141.             $this->preDispatch($eventName, $event);
  142.             try {
  143.                 $e = $this->stopwatch->start($eventName, 'section');
  144.                 try {
  145.                     $this->dispatcher->dispatch($eventName, $event);
  146.                 } finally {
  147.                     if ($e->isStarted()) {
  148.                         $e->stop();
  149.                     }
  150.                 }
  151.             } finally {
  152.                 $this->postDispatch($eventName, $event);
  153.             }
  154.         } finally {
  155.             $this->postProcess($eventName);
  156.         }
  158.         return $event;
  159.     }
  161.     /**
  162.      * {@inheritdoc}
  163.      */
  164.     public function getCalledListeners()
  165.     {
  166.         if (null === $this->callStack) {
  167.             return [];
  168.         }
  170.         $called = [];
  171.         foreach ($this->callStack as $listener) {
  172.             list($eventName) = $this->callStack->getInfo();
  174.             $called[] = $listener->getInfo($eventName);
  175.         }
  177.         return $called;
  178.     }
  180.     /**
  181.      * {@inheritdoc}
  182.      */
  183.     public function getNotCalledListeners()
  184.     {
  185.         try {
  186.             $allListeners = $this->getListeners();
  187.         } catch (\Exception $e) {
  188.             if (null !== $this->logger) {
  189.                 $this->logger->info('An exception was thrown while getting the uncalled listeners.', ['exception' => $e]);
  190.             }
  192.             // unable to retrieve the uncalled listeners
  193.             return [];
  194.         }
  196.         $calledListeners = [];
  198.         if (null !== $this->callStack) {
  199.             foreach ($this->callStack as $calledListener) {
  200.                 $calledListeners[] = $calledListener->getWrappedListener();
  201.             }
  202.         }
  204.         $notCalled = [];
  205.         foreach ($allListeners as $eventName => $listeners) {
  206.             foreach ($listeners as $listener) {
  207.                 if (!\in_array($listener, $calledListeners, true)) {
  208.                     if (!$listener instanceof WrappedListener) {
  209.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this);
  210.                     }
  211.                     $notCalled[] = $listener->getInfo($eventName);
  212.                 }
  213.             }
  214.         }
  216.         uasort($notCalled, [$this, 'sortNotCalledListeners']);
  218.         return $notCalled;
  219.     }
  221.     public function getOrphanedEvents(): array
  222.     {
  223.         return $this->orphanedEvents;
  224.     }
  226.     public function reset()
  227.     {
  228.         $this->callStack = null;
  229.         $this->orphanedEvents = [];
  230.     }
  232.     /**
  233.      * Proxies all method calls to the original event dispatcher.
  234.      *
  235.      * @param string $method    The method name
  236.      * @param array  $arguments The method arguments
  237.      *
  238.      * @return mixed
  239.      */
  240.     public function __call($method, $arguments)
  241.     {
  242.         return $this->dispatcher->{$method}(...$arguments);
  243.     }
  245.     /**
  246.      * Called before dispatching the event.
  247.      *
  248.      * @param string $eventName The event name
  249.      * @param Event  $event     The event
  250.      */
  251.     protected function preDispatch($eventName, Event $event)
  252.     {
  253.     }
  255.     /**
  256.      * Called after dispatching the event.
  257.      *
  258.      * @param string $eventName The event name
  259.      * @param Event  $event     The event
  260.      */
  261.     protected function postDispatch($eventName, Event $event)
  262.     {
  263.     }
  265.     private function preProcess($eventName)
  266.     {
  267.         if (!$this->dispatcher->hasListeners($eventName)) {
  268.             $this->orphanedEvents[] = $eventName;
  270.             return;
  271.         }
  273.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  274.             $priority = $this->getListenerPriority($eventName, $listener);
  275.             $wrappedListener = new WrappedListener($listener instanceof WrappedListener ? $listener->getWrappedListener() : $listener, null, $this->stopwatch, $this);
  276.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  277.             $this->dispatcher->removeListener($eventName, $listener);
  278.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  279.             $this->callStack->attach($wrappedListener, [$eventName]);
  280.         }
  281.     }
  283.     private function postProcess($eventName)
  284.     {
  285.         unset($this->wrappedListeners[$eventName]);
  286.         $skipped = false;
  287.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  288.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  289.                 continue;
  290.             }
  291.             // Unwrap listener
  292.             $priority = $this->getListenerPriority($eventName, $listener);
  293.             $this->dispatcher->removeListener($eventName, $listener);
  294.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  296.             if (null !== $this->logger) {
  297.                 $context = ['event' => $eventName, 'listener' => $listener->getPretty()];
  298.             }
  300.             if ($listener->wasCalled()) {
  301.                 if (null !== $this->logger) {
  302.                     $this->logger->debug('Notified event "{event}" to listener "{listener}".', $context);
  303.                 }
  304.             } else {
  305.                 $this->callStack->detach($listener);
  306.             }
  308.             if (null !== $this->logger && $skipped) {
  309.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  310.             }
  312.             if ($listener->stoppedPropagation()) {
  313.                 if (null !== $this->logger) {
  314.                     $this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  315.                 }
  317.                 $skipped = true;
  318.             }
  319.         }
  320.     }
  322.     private function sortNotCalledListeners(array $a, array $b)
  323.     {
  324.         if (0 !== $cmp = strcmp($a['event'], $b['event'])) {
  325.             return $cmp;
  326.         }
  328.         if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  329.             return 1;
  330.         }
  332.         if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  333.             return -1;
  334.         }
  336.         if ($a['priority'] === $b['priority']) {
  337.             return 0;
  338.         }
  340.         if ($a['priority'] > $b['priority']) {
  341.             return -1;
  342.         }
  344.         return 1;
  345.     }
  346. }