vendor/symfony/http-kernel/EventListener/ProfilerListener.php line 108

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\HttpKernel\EventListener;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestMatcherInterface;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\HttpFoundation\Session\Session;
  19. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  20. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  21. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  23. use Symfony\Component\HttpKernel\Profiler\Profile;
  24. use Symfony\Component\HttpKernel\Profiler\Profiler;
  26. /**
  27. * ProfilerListener collects data for the current request by listening to the kernel events.
  28. *
  29. * @author Fabien Potencier <fabien@symfony.com>
  30. *
  31. * @final
  32. */
  33. class ProfilerListener implements EventSubscriberInterface
  34. {
  35. protected $profiler;
  36. protected $matcher;
  37. protected $onlyException;
  38. protected $onlyMainRequests;
  39. protected $exception;
  40. /** @var \SplObjectStorage<Request, Profile> */
  41. protected $profiles;
  42. protected $requestStack;
  43. protected $collectParameter;
  44. /** @var \SplObjectStorage<Request, Request|null> */
  45. protected $parents;
  47. /**
  48. * @param bool $onlyException True if the profiler only collects data when an exception occurs, false otherwise
  49. * @param bool $onlyMainRequests True if the profiler only collects data when the request is the main request, false otherwise
  50. */
  51. public function __construct(Profiler $profiler, RequestStack $requestStack, ?RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMainRequests = false, ?string $collectParameter = null)
  52. {
  53. $this->profiler = $profiler;
  54. $this->matcher = $matcher;
  55. $this->onlyException = $onlyException;
  56. $this->onlyMainRequests = $onlyMainRequests;
  57. $this->profiles = new \SplObjectStorage();
  58. $this->parents = new \SplObjectStorage();
  59. $this->requestStack = $requestStack;
  60. $this->collectParameter = $collectParameter;
  61. }
  63. /**
  64. * Handles the onKernelException event.
  65. */
  66. public function onKernelException(ExceptionEvent $event)
  67. {
  68. if ($this->onlyMainRequests && !$event->isMainRequest()) {
  69. return;
  70. }
  72. $this->exception = $event->getThrowable();
  73. }
  75. /**
  76. * Handles the onKernelResponse event.
  77. */
  78. public function onKernelResponse(ResponseEvent $event)
  79. {
  80. if ($this->onlyMainRequests && !$event->isMainRequest()) {
  81. return;
  82. }
  84. if ($this->onlyException && null === $this->exception) {
  85. return;
  86. }
  88. $request = $event->getRequest();
  89. if (null !== $this->collectParameter && null !== $collectParameterValue = $request->get($this->collectParameter)) {
  90. true === $collectParameterValue || filter_var($collectParameterValue, \FILTER_VALIDATE_BOOLEAN) ? $this->profiler->enable() : $this->profiler->disable();
  91. }
  93. $exception = $this->exception;
  94. $this->exception = null;
  96. if (null !== $this->matcher && !$this->matcher->matches($request)) {
  97. return;
  98. }
  100. $session = !$request->attributes->getBoolean('_stateless') && $request->hasPreviousSession() && $request->hasSession() ? $request->getSession() : null;
  102. if ($session instanceof Session) {
  103. $usageIndexValue = $usageIndexReference = &$session->getUsageIndex();
  104. $usageIndexReference = \PHP_INT_MIN;
  105. }
  107. try {
  108. if (!$profile = $this->profiler->collect($request, $event->getResponse(), $exception)) {
  109. return;
  110. }
  111. } finally {
  112. if ($session instanceof Session) {
  113. $usageIndexReference = $usageIndexValue;
  114. }
  115. }
  117. $this->profiles[$request] = $profile;
  119. $this->parents[$request] = $this->requestStack->getParentRequest();
  120. }
  122. public function onKernelTerminate(TerminateEvent $event)
  123. {
  124. // attach children to parents
  125. foreach ($this->profiles as $request) {
  126. if (null !== $parentRequest = $this->parents[$request]) {
  127. if (isset($this->profiles[$parentRequest])) {
  128. $this->profiles[$parentRequest]->addChild($this->profiles[$request]);
  129. }
  130. }
  131. }
  133. // save profiles
  134. foreach ($this->profiles as $request) {
  135. $this->profiler->saveProfile($this->profiles[$request]);
  136. }
  138. $this->profiles = new \SplObjectStorage();
  139. $this->parents = new \SplObjectStorage();
  140. }
  142. public static function getSubscribedEvents(): array
  143. {
  144. return [
  145. KernelEvents::RESPONSE => ['onKernelResponse', -100],
  146. KernelEvents::EXCEPTION => ['onKernelException', 0],
  147. KernelEvents::TERMINATE => ['onKernelTerminate', -1024],
  148. ];
  149. }
  150. }