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

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  32. */
  33. class Firewall implements EventSubscriberInterface
  34. {
  35. private $map;
  36. private $dispatcher;
  38. /**
  39. * @var \SplObjectStorage<Request, ExceptionListener>
  40. */
  41. private $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. public function onKernelRequest(RequestEvent $event)
  51. {
  52. if (!$event->isMainRequest()) {
  53. return;
  54. }
  56. // register listeners for this firewall
  57. $listeners = $this->map->getListeners($event->getRequest());
  59. $authenticationListeners = $listeners[0];
  60. $exceptionListener = $listeners[1];
  61. $logoutListener = $listeners[2];
  63. if (null !== $exceptionListener) {
  64. $this->exceptionListeners[$event->getRequest()] = $exceptionListener;
  65. $exceptionListener->register($this->dispatcher);
  66. }
  68. // Authentication listeners are pre-sorted by SortFirewallListenersPass
  69. $authenticationListeners = function () use ($authenticationListeners, $logoutListener) {
  70. if (null !== $logoutListener) {
  71. $logoutListenerPriority = $this->getListenerPriority($logoutListener);
  72. }
  74. foreach ($authenticationListeners as $listener) {
  75. $listenerPriority = $this->getListenerPriority($listener);
  77. // Yielding the LogoutListener at the correct position
  78. if (null !== $logoutListener && $listenerPriority < $logoutListenerPriority) {
  79. yield $logoutListener;
  80. $logoutListener = null;
  81. }
  83. yield $listener;
  84. }
  86. // When LogoutListener has the lowest priority of all listeners
  87. if (null !== $logoutListener) {
  88. yield $logoutListener;
  89. }
  90. };
  92. $this->callListeners($event, $authenticationListeners());
  93. }
  95. public function onKernelFinishRequest(FinishRequestEvent $event)
  96. {
  97. $request = $event->getRequest();
  99. if (isset($this->exceptionListeners[$request])) {
  100. $this->exceptionListeners[$request]->unregister($this->dispatcher);
  101. unset($this->exceptionListeners[$request]);
  102. }
  103. }
  105. /**
  106. * {@inheritdoc}
  107. */
  108. public static function getSubscribedEvents()
  109. {
  110. return [
  111. KernelEvents::REQUEST => ['onKernelRequest', 8],
  112. KernelEvents::FINISH_REQUEST => 'onKernelFinishRequest',
  113. ];
  114. }
  116. protected function callListeners(RequestEvent $event, iterable $listeners)
  117. {
  118. foreach ($listeners as $listener) {
  119. $listener($event);
  121. if ($event->hasResponse()) {
  122. break;
  123. }
  124. }
  125. }
  127. private function getListenerPriority(object $logoutListener): int
  128. {
  129. return $logoutListener instanceof FirewallListenerInterface ? $logoutListener->getPriority() : 0;
  130. }
  131. }