vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/WebDebugToolbarListener.php line 61

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\CoreBundle\EventListener;
  18. use Pimcore\Http\RequestHelper;
  19. use Pimcore\Http\RequestMatcherFactory;
  20. use Symfony\Bundle\WebProfilerBundle\EventListener\WebDebugToolbarListener as SymfonyWebDebugToolbarListener;
  21. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  22. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  23. use Symfony\Component\HttpFoundation\RequestMatcherInterface;
  24. use Symfony\Component\HttpKernel\Event\RequestEvent;
  25. use Symfony\Component\HttpKernel\KernelEvents;
  27. /**
  28.  * Disables the web debug toolbar for frontend requests by admins (iframes inside admin interface)
  29.  *
  30.  * @internal
  31.  */
  32. class WebDebugToolbarListener implements EventSubscriberInterface
  33. {
  34.     /**
  35.      * @var RequestMatcherInterface[]
  36.      */
  37.     protected $excludeMatchers;
  39.     public function __construct(
  40.         protected RequestHelper $requestHelper,
  41.         protected RequestMatcherFactory $requestMatcherFactory,
  42.         protected ?SymfonyWebDebugToolbarListener $debugToolbarListener,
  43.         protected EventDispatcherInterface $eventDispatcher,
  44.         protected array $excludeRoutes
  45.     ) {
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public static function getSubscribedEvents(): array
  52.     {
  53.         return [
  54.             KernelEvents::REQUEST => ['onKernelResponse', -118],
  55.         ];
  56.     }
  58.     /**
  59.      * @param RequestEvent $event
  60.      */
  61.     public function onKernelResponse(RequestEvent $event)
  62.     {
  63.         if (!$event->isMainRequest()) {
  64.             return;
  65.         }
  67.         $request = $event->getRequest();
  69.         // do not show toolbar on frontend-admin requests
  70.         if ($this->requestHelper->isFrontendRequestByAdmin($request)) {
  71.             $this->disableWebDebugToolbar();
  72.         }
  74.         // do not show toolbar on excluded routes (pimcore.web_profiler.toolbar.excluded_routes config entry)
  75.         foreach ($this->getExcludeMatchers() as $excludeMatcher) {
  76.             if ($excludeMatcher->matches($request)) {
  77.                 $this->disableWebDebugToolbar();
  78.             }
  79.         }
  80.     }
  82.     /**
  83.      * @return RequestMatcherInterface[]
  84.      */
  85.     protected function getExcludeMatchers()
  86.     {
  87.         if (null === $this->excludeMatchers) {
  88.             $this->excludeMatchers = $this->requestMatcherFactory->buildRequestMatchers($this->excludeRoutes);
  89.         }
  91.         return $this->excludeMatchers;
  92.     }
  94.     protected function disableWebDebugToolbar(): void
  95.     {
  96.         if ($this->debugToolbarListener) {
  97.             $this->eventDispatcher->removeSubscriber($this->debugToolbarListener);
  98.         }
  99.     }
  100. }