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

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\EventSubscriberInterface;
  15. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  16. use Symfony\Component\HttpKernel\Event\RequestEvent;
  17. use Symfony\Component\HttpKernel\KernelEvents;
  18. use Symfony\Component\Security\Http\Firewall\FirewallListenerInterface;
  19. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  21. /**
  22.  * Firewall uses a FirewallMap to register security listeners for the given
  23.  * request.
  24.  *
  25.  * It allows for different security strategies within the same application
  26.  * (a Basic authentication for the /api, and a web based authentication for
  27.  * everything else for instance).
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  */
  31. class Firewall implements EventSubscriberInterface
  32. {
  33.     private $map;
  34.     private $dispatcher;
  35.     private $exceptionListeners;
  37.     public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher)
  38.     {
  39.         $this->map = $map;
  40.         $this->dispatcher = $dispatcher;
  41.         $this->exceptionListeners = new \SplObjectStorage();
  42.     }
  44.     public function onKernelRequest(RequestEvent $event)
  45.     {
  46.         if (!$event->isMainRequest()) {
  47.             return;
  48.         }
  50.         // register listeners for this firewall
  51.         $listeners = $this->map->getListeners($event->getRequest());
  53.         $authenticationListeners = $listeners[0];
  54.         $exceptionListener = $listeners[1];
  55.         $logoutListener = $listeners[2];
  57.         if (null !== $exceptionListener) {
  58.             $this->exceptionListeners[$event->getRequest()] = $exceptionListener;
  59.             $exceptionListener->register($this->dispatcher);
  60.         }
  62.         // Authentication listeners are pre-sorted by SortFirewallListenersPass
  63.         $authenticationListeners = function () use ($authenticationListeners, $logoutListener) {
  64.             if (null !== $logoutListener) {
  65.                 $logoutListenerPriority = $this->getListenerPriority($logoutListener);
  66.             }
  68.             foreach ($authenticationListeners as $listener) {
  69.                 $listenerPriority = $this->getListenerPriority($listener);
  71.                 // Yielding the LogoutListener at the correct position
  72.                 if (null !== $logoutListener && $listenerPriority < $logoutListenerPriority) {
  73.                     yield $logoutListener;
  74.                     $logoutListener = null;
  75.                 }
  77.                 yield $listener;
  78.             }
  80.             // When LogoutListener has the lowest priority of all listeners
  81.             if (null !== $logoutListener) {
  82.                 yield $logoutListener;
  83.             }
  84.         };
  86.         $this->callListeners($event, $authenticationListeners());
  87.     }
  89.     public function onKernelFinishRequest(FinishRequestEvent $event)
  90.     {
  91.         $request = $event->getRequest();
  93.         if (isset($this->exceptionListeners[$request])) {
  94.             $this->exceptionListeners[$request]->unregister($this->dispatcher);
  95.             unset($this->exceptionListeners[$request]);
  96.         }
  97.     }
  99.     /**
  100.      * {@inheritdoc}
  101.      */
  102.     public static function getSubscribedEvents()
  103.     {
  104.         return [
  105.             KernelEvents::REQUEST => ['onKernelRequest', 8],
  106.             KernelEvents::FINISH_REQUEST => 'onKernelFinishRequest',
  107.         ];
  108.     }
  110.     protected function callListeners(RequestEvent $event, iterable $listeners)
  111.     {
  112.         foreach ($listeners as $listener) {
  113.             $listener($event);
  115.             if ($event->hasResponse()) {
  116.                 break;
  117.             }
  118.         }
  119.     }
  121.     private function getListenerPriority(object $logoutListener): int
  122.     {
  123.         return $logoutListener instanceof FirewallListenerInterface ? $logoutListener->getPriority() : 0;
  124.     }
  125. }