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

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;
  36.     public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
  37.     {
  38.         $this->dispatcher = $dispatcher;
  39.         $this->stopwatch = $stopwatch;
  40.         $this->logger = $logger;
  41.         $this->wrappedListeners = [];
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function addListener($eventName, $listener, $priority = 0)
  48.     {
  49.         $this->dispatcher->addListener($eventName, $listener, $priority);
  50.     }
  52.     /**
  53.      * {@inheritdoc}
  54.      */
  55.     public function addSubscriber(EventSubscriberInterface $subscriber)
  56.     {
  57.         $this->dispatcher->addSubscriber($subscriber);
  58.     }
  60.     /**
  61.      * {@inheritdoc}
  62.      */
  63.     public function removeListener($eventName, $listener)
  64.     {
  65.         if (isset($this->wrappedListeners[$eventName])) {
  66.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  67.                 if ($wrappedListener->getWrappedListener() === $listener) {
  68.                     $listener = $wrappedListener;
  69.                     unset($this->wrappedListeners[$eventName][$index]);
  70.                     break;
  71.                 }
  72.             }
  73.         }
  75.         return $this->dispatcher->removeListener($eventName, $listener);
  76.     }
  78.     /**
  79.      * {@inheritdoc}
  80.      */
  81.     public function removeSubscriber(EventSubscriberInterface $subscriber)
  82.     {
  83.         return $this->dispatcher->removeSubscriber($subscriber);
  84.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      */
  89.     public function getListeners($eventName = null)
  90.     {
  91.         return $this->dispatcher->getListeners($eventName);
  92.     }
  94.     /**
  95.      * {@inheritdoc}
  96.      */
  97.     public function getListenerPriority($eventName, $listener)
  98.     {
  99.         // we might have wrapped listeners for the event (if called while dispatching)
  100.         // in that case get the priority by wrapper
  101.         if (isset($this->wrappedListeners[$eventName])) {
  102.             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  103.                 if ($wrappedListener->getWrappedListener() === $listener) {
  104.                     return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  105.                 }
  106.             }
  107.         }
  109.         return $this->dispatcher->getListenerPriority($eventName, $listener);
  110.     }
  112.     /**
  113.      * {@inheritdoc}
  114.      */
  115.     public function hasListeners($eventName = null)
  116.     {
  117.         return $this->dispatcher->hasListeners($eventName);
  118.     }
  120.     /**
  121.      * {@inheritdoc}
  122.      */
  123.     public function dispatch($eventName, Event $event = null)
  124.     {
  125.         if (null === $this->callStack) {
  126.             $this->callStack = new \SplObjectStorage();
  127.         }
  129.         if (null === $event) {
  130.             $event = new Event();
  131.         }
  133.         if (null !== $this->logger && $event->isPropagationStopped()) {
  134.             $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  135.         }
  137.         $this->preProcess($eventName);
  138.         try {
  139.             $this->preDispatch($eventName, $event);
  140.             try {
  141.                 $e = $this->stopwatch->start($eventName, 'section');
  142.                 try {
  143.                     $this->dispatcher->dispatch($eventName, $event);
  144.                 } finally {
  145.                     if ($e->isStarted()) {
  146.                         $e->stop();
  147.                     }
  148.                 }
  149.             } finally {
  150.                 $this->postDispatch($eventName, $event);
  151.             }
  152.         } finally {
  153.             $this->postProcess($eventName);
  154.         }
  156.         return $event;
  157.     }
  159.     /**
  160.      * {@inheritdoc}
  161.      */
  162.     public function getCalledListeners()
  163.     {
  164.         if (null === $this->callStack) {
  165.             return [];
  166.         }
  168.         $called = [];
  169.         foreach ($this->callStack as $listener) {
  170.             list($eventName) = $this->callStack->getInfo();
  172.             $called[] = $listener->getInfo($eventName);
  173.         }
  175.         return $called;
  176.     }
  178.     /**
  179.      * {@inheritdoc}
  180.      */
  181.     public function getNotCalledListeners()
  182.     {
  183.         try {
  184.             $allListeners = $this->getListeners();
  185.         } catch (\Exception $e) {
  186.             if (null !== $this->logger) {
  187.                 $this->logger->info('An exception was thrown while getting the uncalled listeners.', ['exception' => $e]);
  188.             }
  190.             // unable to retrieve the uncalled listeners
  191.             return [];
  192.         }
  194.         $notCalled = [];
  195.         foreach ($allListeners as $eventName => $listeners) {
  196.             foreach ($listeners as $listener) {
  197.                 $called = false;
  198.                 if (null !== $this->callStack) {
  199.                     foreach ($this->callStack as $calledListener) {
  200.                         if ($calledListener->getWrappedListener() === $listener) {
  201.                             $called = true;
  203.                             break;
  204.                         }
  205.                     }
  206.                 }
  208.                 if (!$called) {
  209.                     if (!$listener instanceof WrappedListener) {
  210.                         $listener = new WrappedListener($listener, null, $this->stopwatch, $this);
  211.                     }
  212.                     $notCalled[] = $listener->getInfo($eventName);
  213.                 }
  214.             }
  215.         }
  217.         uasort($notCalled, [$this, 'sortNotCalledListeners']);
  219.         return $notCalled;
  220.     }
  222.     public function reset()
  223.     {
  224.         $this->callStack = null;
  225.     }
  227.     /**
  228.      * Proxies all method calls to the original event dispatcher.
  229.      *
  230.      * @param string $method    The method name
  231.      * @param array  $arguments The method arguments
  232.      *
  233.      * @return mixed
  234.      */
  235.     public function __call($method, $arguments)
  236.     {
  237.         return \call_user_func_array([$this->dispatcher, $method], $arguments);
  238.     }
  240.     /**
  241.      * Called before dispatching the event.
  242.      *
  243.      * @param string $eventName The event name
  244.      * @param Event  $event     The event
  245.      */
  246.     protected function preDispatch($eventName, Event $event)
  247.     {
  248.     }
  250.     /**
  251.      * Called after dispatching the event.
  252.      *
  253.      * @param string $eventName The event name
  254.      * @param Event  $event     The event
  255.      */
  256.     protected function postDispatch($eventName, Event $event)
  257.     {
  258.     }
  260.     private function preProcess($eventName)
  261.     {
  262.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  263.             $priority = $this->getListenerPriority($eventName, $listener);
  264.             $wrappedListener = new WrappedListener($listener instanceof WrappedListener ? $listener->getWrappedListener() : $listener, null, $this->stopwatch, $this);
  265.             $this->wrappedListeners[$eventName][] = $wrappedListener;
  266.             $this->dispatcher->removeListener($eventName, $listener);
  267.             $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  268.             $this->callStack->attach($wrappedListener, [$eventName]);
  269.         }
  270.     }
  272.     private function postProcess($eventName)
  273.     {
  274.         unset($this->wrappedListeners[$eventName]);
  275.         $skipped = false;
  276.         foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  277.             if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  278.                 continue;
  279.             }
  280.             // Unwrap listener
  281.             $priority = $this->getListenerPriority($eventName, $listener);
  282.             $this->dispatcher->removeListener($eventName, $listener);
  283.             $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  285.             if (null !== $this->logger) {
  286.                 $context = ['event' => $eventName, 'listener' => $listener->getPretty()];
  287.             }
  289.             if ($listener->wasCalled()) {
  290.                 if (null !== $this->logger) {
  291.                     $this->logger->debug('Notified event "{event}" to listener "{listener}".', $context);
  292.                 }
  293.             } else {
  294.                 $this->callStack->detach($listener);
  295.             }
  297.             if (null !== $this->logger && $skipped) {
  298.                 $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  299.             }
  301.             if ($listener->stoppedPropagation()) {
  302.                 if (null !== $this->logger) {
  303.                     $this->logger->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  304.                 }
  306.                 $skipped = true;
  307.             }
  308.         }
  309.     }
  311.     private function sortNotCalledListeners(array $a, array $b)
  312.     {
  313.         if (0 !== $cmp = strcmp($a['event'], $b['event'])) {
  314.             return $cmp;
  315.         }
  317.         if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  318.             return 1;
  319.         }
  321.         if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  322.             return -1;
  323.         }
  325.         if ($a['priority'] === $b['priority']) {
  326.             return 0;
  327.         }
  329.         if ($a['priority'] > $b['priority']) {
  330.             return -1;
  331.         }
  333.         return 1;
  334.     }
  335. }