123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\EventDispatcher\Debug;
- use Symfony\Component\EventDispatcher\EventDispatcherInterface;
- use Symfony\Component\EventDispatcher\EventSubscriberInterface;
- use Symfony\Component\EventDispatcher\Event;
- use Symfony\Component\Stopwatch\Stopwatch;
- use Psr\Log\LoggerInterface;
- /**
- * Collects some data about event listeners.
- *
- * This event dispatcher delegates the dispatching to another one.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class TraceableEventDispatcher implements TraceableEventDispatcherInterface
- {
- protected $logger;
- protected $stopwatch;
- private $called;
- private $dispatcher;
- private $wrappedListeners;
- /**
- * Constructor.
- *
- * @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
- * @param Stopwatch $stopwatch A Stopwatch instance
- * @param LoggerInterface $logger A LoggerInterface instance
- */
- public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $stopwatch, LoggerInterface $logger = null)
- {
- $this->dispatcher = $dispatcher;
- $this->stopwatch = $stopwatch;
- $this->logger = $logger;
- $this->called = array();
- $this->wrappedListeners = array();
- }
- /**
- * {@inheritdoc}
- */
- public function addListener($eventName, $listener, $priority = 0)
- {
- $this->dispatcher->addListener($eventName, $listener, $priority);
- }
- /**
- * {@inheritdoc}
- */
- public function addSubscriber(EventSubscriberInterface $subscriber)
- {
- $this->dispatcher->addSubscriber($subscriber);
- }
- /**
- * {@inheritdoc}
- */
- public function removeListener($eventName, $listener)
- {
- if (isset($this->wrappedListeners[$eventName])) {
- foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
- if ($wrappedListener->getWrappedListener() === $listener) {
- $listener = $wrappedListener;
- unset($this->wrappedListeners[$eventName][$index]);
- break;
- }
- }
- }
- return $this->dispatcher->removeListener($eventName, $listener);
- }
- /**
- * {@inheritdoc}
- */
- public function removeSubscriber(EventSubscriberInterface $subscriber)
- {
- return $this->dispatcher->removeSubscriber($subscriber);
- }
- /**
- * {@inheritdoc}
- */
- public function getListeners($eventName = null)
- {
- return $this->dispatcher->getListeners($eventName);
- }
- /**
- * {@inheritdoc}
- */
- public function getListenerPriority($eventName, $listener)
- {
- if (!method_exists($this->dispatcher, 'getListenerPriority')) {
- return 0;
- }
- return $this->dispatcher->getListenerPriority($eventName, $listener);
- }
- /**
- * {@inheritdoc}
- */
- public function hasListeners($eventName = null)
- {
- return $this->dispatcher->hasListeners($eventName);
- }
- /**
- * {@inheritdoc}
- */
- public function dispatch($eventName, Event $event = null)
- {
- if (null === $event) {
- $event = new Event();
- }
- if (null !== $this->logger && $event->isPropagationStopped()) {
- $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
- }
- $this->preProcess($eventName);
- $this->preDispatch($eventName, $event);
- $e = $this->stopwatch->start($eventName, 'section');
- $this->dispatcher->dispatch($eventName, $event);
- if ($e->isStarted()) {
- $e->stop();
- }
- $this->postDispatch($eventName, $event);
- $this->postProcess($eventName);
- return $event;
- }
- /**
- * {@inheritdoc}
- */
- public function getCalledListeners()
- {
- $called = array();
- foreach ($this->called as $eventName => $listeners) {
- foreach ($listeners as $listener) {
- $info = $this->getListenerInfo($listener->getWrappedListener(), $eventName);
- $called[$eventName.'.'.$info['pretty']] = $info;
- }
- }
- return $called;
- }
- /**
- * {@inheritdoc}
- */
- public function getNotCalledListeners()
- {
- try {
- $allListeners = $this->getListeners();
- } catch (\Exception $e) {
- if (null !== $this->logger) {
- $this->logger->info('An exception was thrown while getting the uncalled listeners.', array('exception' => $e));
- }
- // unable to retrieve the uncalled listeners
- return array();
- }
- $notCalled = array();
- foreach ($allListeners as $eventName => $listeners) {
- foreach ($listeners as $listener) {
- $called = false;
- if (isset($this->called[$eventName])) {
- foreach ($this->called[$eventName] as $l) {
- if ($l->getWrappedListener() === $listener) {
- $called = true;
- break;
- }
- }
- }
- if (!$called) {
- $info = $this->getListenerInfo($listener, $eventName);
- $notCalled[$eventName.'.'.$info['pretty']] = $info;
- }
- }
- }
- uasort($notCalled, array($this, 'sortListenersByPriority'));
- return $notCalled;
- }
- /**
- * Proxies all method calls to the original event dispatcher.
- *
- * @param string $method The method name
- * @param array $arguments The method arguments
- *
- * @return mixed
- */
- public function __call($method, $arguments)
- {
- return call_user_func_array(array($this->dispatcher, $method), $arguments);
- }
- /**
- * Called before dispatching the event.
- *
- * @param string $eventName The event name
- * @param Event $event The event
- */
- protected function preDispatch($eventName, Event $event)
- {
- }
- /**
- * Called after dispatching the event.
- *
- * @param string $eventName The event name
- * @param Event $event The event
- */
- protected function postDispatch($eventName, Event $event)
- {
- }
- private function preProcess($eventName)
- {
- foreach ($this->dispatcher->getListeners($eventName) as $listener) {
- $info = $this->getListenerInfo($listener, $eventName);
- $name = isset($info['class']) ? $info['class'] : $info['type'];
- $wrappedListener = new WrappedListener($listener, $name, $this->stopwatch, $this);
- $this->wrappedListeners[$eventName][] = $wrappedListener;
- $this->dispatcher->removeListener($eventName, $listener);
- $this->dispatcher->addListener($eventName, $wrappedListener, $info['priority']);
- }
- }
- private function postProcess($eventName)
- {
- unset($this->wrappedListeners[$eventName]);
- $skipped = false;
- foreach ($this->dispatcher->getListeners($eventName) as $listener) {
- if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
- continue;
- }
- // Unwrap listener
- $priority = $this->getListenerPriority($eventName, $listener);
- $this->dispatcher->removeListener($eventName, $listener);
- $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
- $info = $this->getListenerInfo($listener->getWrappedListener(), $eventName);
- if ($listener->wasCalled()) {
- if (null !== $this->logger) {
- $this->logger->debug(sprintf('Notified event "%s" to listener "%s".', $eventName, $info['pretty']));
- }
- if (!isset($this->called[$eventName])) {
- $this->called[$eventName] = new \SplObjectStorage();
- }
- $this->called[$eventName]->attach($listener);
- }
- if (null !== $this->logger && $skipped) {
- $this->logger->debug(sprintf('Listener "%s" was not called for event "%s".', $info['pretty'], $eventName));
- }
- if ($listener->stoppedPropagation()) {
- if (null !== $this->logger) {
- $this->logger->debug(sprintf('Listener "%s" stopped propagation of the event "%s".', $info['pretty'], $eventName));
- }
- $skipped = true;
- }
- }
- }
- /**
- * Returns information about the listener.
- *
- * @param object $listener The listener
- * @param string $eventName The event name
- *
- * @return array Information about the listener
- */
- private function getListenerInfo($listener, $eventName)
- {
- $info = array(
- 'event' => $eventName,
- 'priority' => $this->getListenerPriority($eventName, $listener),
- );
- if ($listener instanceof \Closure) {
- $info += array(
- 'type' => 'Closure',
- 'pretty' => 'closure',
- );
- } elseif (is_string($listener)) {
- try {
- $r = new \ReflectionFunction($listener);
- $file = $r->getFileName();
- $line = $r->getStartLine();
- } catch (\ReflectionException $e) {
- $file = null;
- $line = null;
- }
- $info += array(
- 'type' => 'Function',
- 'function' => $listener,
- 'file' => $file,
- 'line' => $line,
- 'pretty' => $listener,
- );
- } elseif (is_array($listener) || (is_object($listener) && is_callable($listener))) {
- if (!is_array($listener)) {
- $listener = array($listener, '__invoke');
- }
- $class = is_object($listener[0]) ? get_class($listener[0]) : $listener[0];
- try {
- $r = new \ReflectionMethod($class, $listener[1]);
- $file = $r->getFileName();
- $line = $r->getStartLine();
- } catch (\ReflectionException $e) {
- $file = null;
- $line = null;
- }
- $info += array(
- 'type' => 'Method',
- 'class' => $class,
- 'method' => $listener[1],
- 'file' => $file,
- 'line' => $line,
- 'pretty' => $class.'::'.$listener[1],
- );
- }
- return $info;
- }
- private function sortListenersByPriority($a, $b)
- {
- if (is_int($a['priority']) && !is_int($b['priority'])) {
- return 1;
- }
- if (!is_int($a['priority']) && is_int($b['priority'])) {
- return -1;
- }
- if ($a['priority'] === $b['priority']) {
- return 0;
- }
- if ($a['priority'] > $b['priority']) {
- return -1;
- }
- return 1;
- }
- }
|