vendor/symfony/symfony/src/Symfony/Component/Security/Http/Firewall.php line 51

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\Security\Http;
  14. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  17. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  18. use Symfony\Component\HttpKernel\Event\RequestEvent;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  20. use Symfony\Component\Security\Http\Firewall\AccessListener;
  21. use Symfony\Component\Security\Http\Firewall\LogoutListener;
  23. /**
  24.  * Firewall uses a FirewallMap to register security listeners for the given
  25.  * request.
  26.  *
  27.  * It allows for different security strategies within the same application
  28.  * (a Basic authentication for the /api, and a web based authentication for
  29.  * everything else for instance).
  30.  *
  31.  * @author Fabien Potencier <fabien@symfony.com>
  32.  */
  33. class Firewall implements EventSubscriberInterface
  34. {
  35.     private $map;
  36.     private $dispatcher;
  37.     private $exceptionListeners;
  39.     public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher)
  40.     {
  41.         // the type-hint will be updated to the "EventDispatcherInterface" from symfony/contracts in 5.0
  43.         $this->map = $map;
  44.         $this->dispatcher = $dispatcher;
  45.         $this->exceptionListeners = new \SplObjectStorage();
  46.     }
  48.     /**
  49.      * @internal since Symfony 4.3
  50.      */
  51.     public function onKernelRequest(GetResponseEvent $event)
  52.     {
  53.         if (!$event->isMasterRequest()) {
  54.             return;
  55.         }
  57.         // register listeners for this firewall
  58.         $listeners = $this->map->getListeners($event->getRequest());
  60.         if (3 !== \count($listeners)) {
  61.             @trigger_error(sprintf('Not returning an array of 3 elements from %s::getListeners() is deprecated since Symfony 4.2, the 3rd element must be an instance of %s or null.', FirewallMapInterface::class, LogoutListener::class), E_USER_DEPRECATED);
  62.             $listeners[2] = null;
  63.         }
  65.         $authenticationListeners = $listeners[0];
  66.         $exceptionListener = $listeners[1];
  67.         $logoutListener = $listeners[2];
  69.         if (null !== $exceptionListener) {
  70.             $this->exceptionListeners[$event->getRequest()] = $exceptionListener;
  71.             $exceptionListener->register($this->dispatcher);
  72.         }
  74.         $authenticationListeners = function () use ($authenticationListeners, $logoutListener) {
  75.             $accessListener = null;
  77.             foreach ($authenticationListeners as $listener) {
  78.                 if ($listener instanceof AccessListener) {
  79.                     $accessListener = $listener;
  81.                     continue;
  82.                 }
  84.                 yield $listener;
  85.             }
  87.             if (null !== $logoutListener) {
  88.                 yield $logoutListener;
  89.             }
  91.             if (null !== $accessListener) {
  92.                 yield $accessListener;
  93.             }
  94.         };
  96.         if ($event instanceof RequestEvent) {
  97.             $this->callListeners($event, $authenticationListeners());
  98.         } else {
  99.             $this->handleRequest($event, $authenticationListeners());
  100.         }
  101.     }
  103.     /**
  104.      * @internal since Symfony 4.3
  105.      */
  106.     public function onKernelFinishRequest(FinishRequestEvent $event)
  107.     {
  108.         $request = $event->getRequest();
  110.         if (isset($this->exceptionListeners[$request])) {
  111.             $this->exceptionListeners[$request]->unregister($this->dispatcher);
  112.             unset($this->exceptionListeners[$request]);
  113.         }
  114.     }
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public static function getSubscribedEvents()
  120.     {
  121.         return [
  122.             KernelEvents::REQUEST => ['onKernelRequest', 8],
  123.             KernelEvents::FINISH_REQUEST => 'onKernelFinishRequest',
  124.         ];
  125.     }
  127.     protected function callListeners(RequestEvent $event, iterable $listeners)
  128.     {
  129.         $this->handleRequest($event, $listeners);
  130.     }
  132.     /**
  133.      * @deprecated since Symfony 4.3, use callListeners instead
  134.      */
  135.     protected function handleRequest(GetResponseEvent $event, $listeners)
  136.     {
  137.         foreach ($listeners as $listener) {
  138.             if (\is_callable($listener)) {
  139.                 $listener($event);
  140.             } else {
  141.                 @trigger_error(sprintf('Calling the "%s::handle()" method from the firewall is deprecated since Symfony 4.3, extend "%s" instead.', \get_class($listener), AbstractListener::class), E_USER_DEPRECATED);
  142.                 $listener->handle($event);
  143.             }
  145.             if ($event->hasResponse()) {
  146.                 break;
  147.             }
  148.         }
  149.     }
  150. }