vendor/symfony/security-http/Firewall.php line 50

  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\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  17. use Symfony\Component\HttpKernel\Event\RequestEvent;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. use Symfony\Component\Security\Http\Firewall\ExceptionListener;
  20. use Symfony\Component\Security\Http\Firewall\FirewallListenerInterface;
  21. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  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 FirewallMapInterface $map;
  36.     private EventDispatcherInterface $dispatcher;
  38.     /**
  39.      * @var \SplObjectStorage<Request, ExceptionListener>
  40.      */
  41.     private \SplObjectStorage $exceptionListeners;
  43.     public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher)
  44.     {
  45.         $this->map = $map;
  46.         $this->dispatcher = $dispatcher;
  47.         $this->exceptionListeners = new \SplObjectStorage();
  48.     }
  50.     /**
  51.      * @return void
  52.      */
  53.     public function onKernelRequest(RequestEvent $event)
  54.     {
  55.         if (!$event->isMainRequest()) {
  56.             return;
  57.         }
  59.         // register listeners for this firewall
  60.         $listeners = $this->map->getListeners($event->getRequest());
  62.         $authenticationListeners = $listeners[0];
  63.         $exceptionListener = $listeners[1];
  64.         $logoutListener = $listeners[2];
  66.         if (null !== $exceptionListener) {
  67.             $this->exceptionListeners[$event->getRequest()] = $exceptionListener;
  68.             $exceptionListener->register($this->dispatcher);
  69.         }
  71.         // Authentication listeners are pre-sorted by SortFirewallListenersPass
  72.         $authenticationListeners = function () use ($authenticationListeners, $logoutListener) {
  73.             if (null !== $logoutListener) {
  74.                 $logoutListenerPriority = $this->getListenerPriority($logoutListener);
  75.             }
  77.             foreach ($authenticationListeners as $listener) {
  78.                 $listenerPriority = $this->getListenerPriority($listener);
  80.                 // Yielding the LogoutListener at the correct position
  81.                 if (null !== $logoutListener && $listenerPriority < $logoutListenerPriority) {
  82.                     yield $logoutListener;
  83.                     $logoutListener = null;
  84.                 }
  86.                 yield $listener;
  87.             }
  89.             // When LogoutListener has the lowest priority of all listeners
  90.             if (null !== $logoutListener) {
  91.                 yield $logoutListener;
  92.             }
  93.         };
  95.         $this->callListeners($event, $authenticationListeners());
  96.     }
  98.     /**
  99.      * @return void
  100.      */
  101.     public function onKernelFinishRequest(FinishRequestEvent $event)
  102.     {
  103.         $request = $event->getRequest();
  105.         if (isset($this->exceptionListeners[$request])) {
  106.             $this->exceptionListeners[$request]->unregister($this->dispatcher);
  107.             unset($this->exceptionListeners[$request]);
  108.         }
  109.     }
  111.     /**
  112.      * @return array
  113.      */
  114.     public static function getSubscribedEvents()
  115.     {
  116.         return [
  117.             KernelEvents::REQUEST => ['onKernelRequest', 8],
  118.             KernelEvents::FINISH_REQUEST => 'onKernelFinishRequest',
  119.         ];
  120.     }
  122.     /**
  123.      * @return void
  124.      */
  125.     protected function callListeners(RequestEvent $event, iterable $listeners)
  126.     {
  127.         foreach ($listeners as $listener) {
  128.             $listener($event);
  130.             if ($event->hasResponse()) {
  131.                 break;
  132.             }
  133.         }
  134.     }
  136.     private function getListenerPriority(object $logoutListener): int
  137.     {
  138.         return $logoutListener instanceof FirewallListenerInterface ? $logoutListener->getPriority() : 0;
  139.     }
  140. }