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

  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. /**
  34. * @var \SplObjectStorage<WrappedListener, array{string, string}>|null
  35. */
  36. private ?\SplObjectStorage $callStack = null;
  37. private array $wrappedListeners = [];
  38. private array $orphanedEvents = [];
  39. private string $currentRequestHash = '';
  41. public function __construct(
  42. private EventDispatcherInterface $dispatcher,
  43. protected Stopwatch $stopwatch,
  44. protected ?LoggerInterface $logger = null,
  45. private ?RequestStack $requestStack = null,
  46. ) {
  47. }
  49. public function addListener(string $eventName, callable|array $listener, int $priority = 0): void
  50. {
  51. $this->dispatcher->addListener($eventName, $listener, $priority);
  52. }
  54. public function addSubscriber(EventSubscriberInterface $subscriber): void
  55. {
  56. $this->dispatcher->addSubscriber($subscriber);
  57. }
  59. public function removeListener(string $eventName, callable|array $listener): void
  60. {
  61. if (isset($this->wrappedListeners[$eventName])) {
  62. foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
  63. if ($wrappedListener->getWrappedListener() === $listener || ($listener instanceof \Closure && $wrappedListener->getWrappedListener() == $listener)) {
  64. $listener = $wrappedListener;
  65. unset($this->wrappedListeners[$eventName][$index]);
  66. break;
  67. }
  68. }
  69. }
  71. $this->dispatcher->removeListener($eventName, $listener);
  72. }
  74. public function removeSubscriber(EventSubscriberInterface $subscriber): void
  75. {
  76. $this->dispatcher->removeSubscriber($subscriber);
  77. }
  79. public function getListeners(?string $eventName = null): array
  80. {
  81. return $this->dispatcher->getListeners($eventName);
  82. }
  84. public function getListenerPriority(string $eventName, callable|array $listener): ?int
  85. {
  86. // we might have wrapped listeners for the event (if called while dispatching)
  87. // in that case get the priority by wrapper
  88. if (isset($this->wrappedListeners[$eventName])) {
  89. foreach ($this->wrappedListeners[$eventName] as $wrappedListener) {
  90. if ($wrappedListener->getWrappedListener() === $listener || ($listener instanceof \Closure && $wrappedListener->getWrappedListener() == $listener)) {
  91. return $this->dispatcher->getListenerPriority($eventName, $wrappedListener);
  92. }
  93. }
  94. }
  96. return $this->dispatcher->getListenerPriority($eventName, $listener);
  97. }
  99. public function hasListeners(?string $eventName = null): bool
  100. {
  101. return $this->dispatcher->hasListeners($eventName);
  102. }
  104. public function dispatch(object $event, ?string $eventName = null): object
  105. {
  106. $eventName ??= $event::class;
  108. $this->callStack ??= new \SplObjectStorage();
  110. $currentRequestHash = $this->currentRequestHash = $this->requestStack && ($request = $this->requestStack->getCurrentRequest()) ? spl_object_hash($request) : '';
  112. if (null !== $this->logger && $event instanceof StoppableEventInterface && $event->isPropagationStopped()) {
  113. $this->logger->debug(sprintf('The "%s" event is already stopped. No listeners have been called.', $eventName));
  114. }
  116. $this->preProcess($eventName);
  117. try {
  118. $this->beforeDispatch($eventName, $event);
  119. try {
  120. $e = $this->stopwatch->start($eventName, 'section');
  121. try {
  122. $this->dispatcher->dispatch($event, $eventName);
  123. } finally {
  124. if ($e->isStarted()) {
  125. $e->stop();
  126. }
  127. }
  128. } finally {
  129. $this->afterDispatch($eventName, $event);
  130. }
  131. } finally {
  132. $this->currentRequestHash = $currentRequestHash;
  133. $this->postProcess($eventName);
  134. }
  136. return $event;
  137. }
  139. public function getCalledListeners(?Request $request = null): array
  140. {
  141. if (null === $this->callStack) {
  142. return [];
  143. }
  145. $hash = $request ? spl_object_hash($request) : null;
  146. $called = [];
  147. foreach ($this->callStack as $listener) {
  148. [$eventName, $requestHash] = $this->callStack->getInfo();
  149. if (null === $hash || $hash === $requestHash) {
  150. $called[] = $listener->getInfo($eventName);
  151. }
  152. }
  154. return $called;
  155. }
  157. public function getNotCalledListeners(?Request $request = null): array
  158. {
  159. try {
  160. $allListeners = $this->dispatcher instanceof EventDispatcher ? $this->getListenersWithPriority() : $this->getListenersWithoutPriority();
  161. } catch (\Exception $e) {
  162. $this->logger?->info('An exception was thrown while getting the uncalled listeners.', ['exception' => $e]);
  164. // unable to retrieve the uncalled listeners
  165. return [];
  166. }
  168. $hash = $request ? spl_object_hash($request) : null;
  169. $calledListeners = [];
  171. if (null !== $this->callStack) {
  172. foreach ($this->callStack as $calledListener) {
  173. [, $requestHash] = $this->callStack->getInfo();
  175. if (null === $hash || $hash === $requestHash) {
  176. $calledListeners[] = $calledListener->getWrappedListener();
  177. }
  178. }
  179. }
  181. $notCalled = [];
  183. foreach ($allListeners as $eventName => $listeners) {
  184. foreach ($listeners as [$listener, $priority]) {
  185. if (!\in_array($listener, $calledListeners, true)) {
  186. if (!$listener instanceof WrappedListener) {
  187. $listener = new WrappedListener($listener, null, $this->stopwatch, $this, $priority);
  188. }
  189. $notCalled[] = $listener->getInfo($eventName);
  190. }
  191. }
  192. }
  194. uasort($notCalled, $this->sortNotCalledListeners(...));
  196. return $notCalled;
  197. }
  199. public function getOrphanedEvents(?Request $request = null): array
  200. {
  201. if ($request) {
  202. return $this->orphanedEvents[spl_object_hash($request)] ?? [];
  203. }
  205. if (!$this->orphanedEvents) {
  206. return [];
  207. }
  209. return array_merge(...array_values($this->orphanedEvents));
  210. }
  212. public function reset(): void
  213. {
  214. $this->callStack = null;
  215. $this->orphanedEvents = [];
  216. $this->currentRequestHash = '';
  217. }
  219. /**
  220. * Proxies all method calls to the original event dispatcher.
  221. *
  222. * @param string $method The method name
  223. * @param array $arguments The method arguments
  224. */
  225. public function __call(string $method, array $arguments): mixed
  226. {
  227. return $this->dispatcher->{$method}(...$arguments);
  228. }
  230. /**
  231. * Called before dispatching the event.
  232. */
  233. protected function beforeDispatch(string $eventName, object $event): void
  234. {
  235. }
  237. /**
  238. * Called after dispatching the event.
  239. */
  240. protected function afterDispatch(string $eventName, object $event): void
  241. {
  242. }
  244. private function preProcess(string $eventName): void
  245. {
  246. if (!$this->dispatcher->hasListeners($eventName)) {
  247. $this->orphanedEvents[$this->currentRequestHash][] = $eventName;
  249. return;
  250. }
  252. foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  253. $priority = $this->getListenerPriority($eventName, $listener);
  254. $wrappedListener = new WrappedListener($listener instanceof WrappedListener ? $listener->getWrappedListener() : $listener, null, $this->stopwatch, $this);
  255. $this->wrappedListeners[$eventName][] = $wrappedListener;
  256. $this->dispatcher->removeListener($eventName, $listener);
  257. $this->dispatcher->addListener($eventName, $wrappedListener, $priority);
  258. $this->callStack->attach($wrappedListener, [$eventName, $this->currentRequestHash]);
  259. }
  260. }
  262. private function postProcess(string $eventName): void
  263. {
  264. unset($this->wrappedListeners[$eventName]);
  265. $skipped = false;
  266. foreach ($this->dispatcher->getListeners($eventName) as $listener) {
  267. if (!$listener instanceof WrappedListener) { // #12845: a new listener was added during dispatch.
  268. continue;
  269. }
  270. // Unwrap listener
  271. $priority = $this->getListenerPriority($eventName, $listener);
  272. $this->dispatcher->removeListener($eventName, $listener);
  273. $this->dispatcher->addListener($eventName, $listener->getWrappedListener(), $priority);
  275. if (null !== $this->logger) {
  276. $context = ['event' => $eventName, 'listener' => $listener->getPretty()];
  277. }
  279. if ($listener->wasCalled()) {
  280. $this->logger?->debug('Notified event "{event}" to listener "{listener}".', $context);
  281. } else {
  282. $this->callStack->detach($listener);
  283. }
  285. if (null !== $this->logger && $skipped) {
  286. $this->logger->debug('Listener "{listener}" was not called for event "{event}".', $context);
  287. }
  289. if ($listener->stoppedPropagation()) {
  290. $this->logger?->debug('Listener "{listener}" stopped propagation of the event "{event}".', $context);
  292. $skipped = true;
  293. }
  294. }
  295. }
  297. private function sortNotCalledListeners(array $a, array $b): int
  298. {
  299. if (0 !== $cmp = strcmp($a['event'], $b['event'])) {
  300. return $cmp;
  301. }
  303. if (\is_int($a['priority']) && !\is_int($b['priority'])) {
  304. return 1;
  305. }
  307. if (!\is_int($a['priority']) && \is_int($b['priority'])) {
  308. return -1;
  309. }
  311. if ($a['priority'] === $b['priority']) {
  312. return 0;
  313. }
  315. if ($a['priority'] > $b['priority']) {
  316. return -1;
  317. }
  319. return 1;
  320. }
  322. private function getListenersWithPriority(): array
  323. {
  324. $result = [];
  326. $allListeners = new \ReflectionProperty(EventDispatcher::class, 'listeners');
  328. foreach ($allListeners->getValue($this->dispatcher) as $eventName => $listenersByPriority) {
  329. foreach ($listenersByPriority as $priority => $listeners) {
  330. foreach ($listeners as $listener) {
  331. $result[$eventName][] = [$listener, $priority];
  332. }
  333. }
  334. }
  336. return $result;
  337. }
  339. private function getListenersWithoutPriority(): array
  340. {
  341. $result = [];
  343. foreach ($this->getListeners() as $eventName => $listeners) {
  344. foreach ($listeners as $listener) {
  345. $result[$eventName][] = [$listener, null];
  346. }
  347. }
  349. return $result;
  350. }
  351. }