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

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\AbstractListener;
  21. use Symfony\Component\Security\Http\Firewall\AccessListener;
  22. use Symfony\Component\Security\Http\Firewall\LogoutListener;
  24. /**
  25.  * Firewall uses a FirewallMap to register security listeners for the given
  26.  * request.
  27.  *
  28.  * It allows for different security strategies within the same application
  29.  * (a Basic authentication for the /api, and a web based authentication for
  30.  * everything else for instance).
  31.  *
  32.  * @author Fabien Potencier <fabien@symfony.com>
  33.  */
  34. class Firewall implements EventSubscriberInterface
  35. {
  36.     private $map;
  37.     private $dispatcher;
  38.     private $exceptionListeners;
  40.     public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher)
  41.     {
  42.         // the type-hint will be updated to the "EventDispatcherInterface" from symfony/contracts in 5.0
  44.         $this->map = $map;
  45.         $this->dispatcher = $dispatcher;
  46.         $this->exceptionListeners = new \SplObjectStorage();
  47.     }
  49.     /**
  50.      * @internal since Symfony 4.3
  51.      */
  52.     public function onKernelRequest(GetResponseEvent $event)
  53.     {
  54.         if (!$event->isMasterRequest()) {
  55.             return;
  56.         }
  58.         // register listeners for this firewall
  59.         $listeners = $this->map->getListeners($event->getRequest());
  61.         if (3 !== \count($listeners)) {
  62.             @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);
  63.             $listeners[2] = null;
  64.         }
  66.         $authenticationListeners = $listeners[0];
  67.         $exceptionListener = $listeners[1];
  68.         $logoutListener = $listeners[2];
  70.         if (null !== $exceptionListener) {
  71.             $this->exceptionListeners[$event->getRequest()] = $exceptionListener;
  72.             $exceptionListener->register($this->dispatcher);
  73.         }
  75.         $authenticationListeners = function () use ($authenticationListeners, $logoutListener) {
  76.             $accessListener = null;
  78.             foreach ($authenticationListeners as $listener) {
  79.                 if ($listener instanceof AccessListener) {
  80.                     $accessListener = $listener;
  82.                     continue;
  83.                 }
  85.                 yield $listener;
  86.             }
  88.             if (null !== $logoutListener) {
  89.                 yield $logoutListener;
  90.             }
  92.             if (null !== $accessListener) {
  93.                 yield $accessListener;
  94.             }
  95.         };
  97.         if ($event instanceof RequestEvent) {
  98.             $this->callListeners($event, $authenticationListeners());
  99.         } else {
  100.             $this->handleRequest($event, $authenticationListeners());
  101.         }
  102.     }
  104.     /**
  105.      * @internal since Symfony 4.3
  106.      */
  107.     public function onKernelFinishRequest(FinishRequestEvent $event)
  108.     {
  109.         $request = $event->getRequest();
  111.         if (isset($this->exceptionListeners[$request])) {
  112.             $this->exceptionListeners[$request]->unregister($this->dispatcher);
  113.             unset($this->exceptionListeners[$request]);
  114.         }
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public static function getSubscribedEvents()
  121.     {
  122.         return [
  123.             KernelEvents::REQUEST => ['onKernelRequest', 8],
  124.             KernelEvents::FINISH_REQUEST => 'onKernelFinishRequest',
  125.         ];
  126.     }
  128.     protected function callListeners(RequestEvent $event, iterable $listeners)
  129.     {
  130.         $this->handleRequest($event, $listeners);
  131.     }
  133.     /**
  134.      * @deprecated since Symfony 4.3, use callListeners instead
  135.      */
  136.     protected function handleRequest(GetResponseEvent $event, $listeners)
  137.     {
  138.         foreach ($listeners as $listener) {
  139.             if (\is_callable($listener)) {
  140.                 $listener($event);
  141.             } else {
  142.                 @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);
  143.                 $listener->handle($event);
  144.             }
  146.             if ($event->hasResponse()) {
  147.                 break;
  148.             }
  149.         }
  150.     }
  151. }