vendor/symfony/http-kernel/EventListener/AbstractSessionListener.php line 70

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\HttpKernel\EventListener;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\HttpFoundation\Session\Session;
  17. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  18. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  19. use Symfony\Component\HttpKernel\Event\RequestEvent;
  20. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  21. use Symfony\Component\HttpKernel\Exception\UnexpectedSessionUsageException;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  24. /**
  25.  * Sets the session onto the request on the "kernel.request" event and saves
  26.  * it on the "kernel.response" event.
  27.  *
  28.  * In addition, if the session has been started it overrides the Cache-Control
  29.  * header in such a way that all caching is disabled in that case.
  30.  * If you have a scenario where caching responses with session information in
  31.  * them makes sense, you can disable this behaviour by setting the header
  32.  * AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER on the response.
  33.  *
  34.  * @author Johannes M. Schmitt <[email protected]>
  35.  * @author Tobias Schultze <http://tobion.de>
  36.  *
  37.  * @internal
  38.  */
  39. abstract class AbstractSessionListener implements EventSubscriberInterface
  40. {
  41.     public const NO_AUTO_CACHE_CONTROL_HEADER = 'Symfony-Session-NoAutoCacheControl';
  43.     protected $container;
  44.     private $sessionUsageStack = [];
  45.     private $debug;
  47.     public function __construct(ContainerInterface $container = null, bool $debug = false)
  48.     {
  49.         $this->container = $container;
  50.         $this->debug = $debug;
  51.     }
  53.     public function onKernelRequest(RequestEvent $event)
  54.     {
  55.         if (!$event->isMasterRequest()) {
  56.             return;
  57.         }
  59.         $session = null;
  60.         $request = $event->getRequest();
  61.         if (!$request->hasSession()) {
  62.             $sess = null;
  63.             $request->setSessionFactory(function () use (&$sess) { return $sess ?? $sess = $this->getSession(); });
  64.         }
  66.         $session = $session ?? ($this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : null);
  67.         $this->sessionUsageStack[] = $session instanceof Session ? $session->getUsageIndex() : 0;
  68.     }
  70.     public function onKernelResponse(ResponseEvent $event)
  71.     {
  72.         if (!$event->isMasterRequest()) {
  73.             return;
  74.         }
  76.         $response = $event->getResponse();
  77.         $autoCacheControl = !$response->headers->has(self::NO_AUTO_CACHE_CONTROL_HEADER);
  78.         // Always remove the internal header if present
  79.         $response->headers->remove(self::NO_AUTO_CACHE_CONTROL_HEADER);
  81.         if (!$session = $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $event->getRequest()->getSession()) {
  82.             return;
  83.         }
  85.         if ($session->isStarted()) {
  86.             /*
  87.              * Saves the session, in case it is still open, before sending the response/headers.
  88.              *
  89.              * This ensures several things in case the developer did not save the session explicitly:
  90.              *
  91.              *  * If a session save handler without locking is used, it ensures the data is available
  92.              *    on the next request, e.g. after a redirect. PHPs auto-save at script end via
  93.              *    session_register_shutdown is executed after fastcgi_finish_request. So in this case
  94.              *    the data could be missing the next request because it might not be saved the moment
  95.              *    the new request is processed.
  96.              *  * A locking save handler (e.g. the native 'files') circumvents concurrency problems like
  97.              *    the one above. But by saving the session before long-running things in the terminate event,
  98.              *    we ensure the session is not blocked longer than needed.
  99.              *  * When regenerating the session ID no locking is involved in PHPs session design. See
  100.              *    https://bugs.php.net/61470 for a discussion. So in this case, the session must
  101.              *    be saved anyway before sending the headers with the new session ID. Otherwise session
  102.              *    data could get lost again for concurrent requests with the new ID. One result could be
  103.              *    that you get logged out after just logging in.
  104.              *
  105.              * This listener should be executed as one of the last listeners, so that previous listeners
  106.              * can still operate on the open session. This prevents the overhead of restarting it.
  107.              * Listeners after closing the session can still work with the session as usual because
  108.              * Symfonys session implementation starts the session on demand. So writing to it after
  109.              * it is saved will just restart it.
  110.              */
  111.             $session->save();
  112.         }
  114.         if ($session instanceof Session ? $session->getUsageIndex() === end($this->sessionUsageStack) : !$session->isStarted()) {
  115.             return;
  116.         }
  118.         if ($autoCacheControl) {
  119.             $response
  120.                 ->setExpires(new \DateTime())
  121.                 ->setPrivate()
  122.                 ->setMaxAge(0)
  123.                 ->headers->addCacheControlDirective('must-revalidate');
  124.         }
  126.         if (!$event->getRequest()->attributes->get('_stateless', false)) {
  127.             return;
  128.         }
  130.         if ($this->debug) {
  131.             throw new UnexpectedSessionUsageException('Session was used while the request was declared stateless.');
  132.         }
  134.         if ($this->container->has('logger')) {
  135.             $this->container->get('logger')->warning('Session was used while the request was declared stateless.');
  136.         }
  137.     }
  139.     public function onFinishRequest(FinishRequestEvent $event)
  140.     {
  141.         if ($event->isMasterRequest()) {
  142.             array_pop($this->sessionUsageStack);
  143.         }
  144.     }
  146.     public function onSessionUsage(): void
  147.     {
  148.         if (!$this->debug) {
  149.             return;
  150.         }
  152.         if (!$requestStack = $this->container && $this->container->has('request_stack') ? $this->container->get('request_stack') : null) {
  153.             return;
  154.         }
  156.         $stateless = false;
  157.         $clonedRequestStack = clone $requestStack;
  158.         while (null !== ($request = $clonedRequestStack->pop()) && !$stateless) {
  159.             $stateless = $request->attributes->get('_stateless');
  160.         }
  162.         if (!$stateless) {
  163.             return;
  164.         }
  166.         if (!$session = $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $requestStack->getCurrentRequest()->getSession()) {
  167.             return;
  168.         }
  170.         if ($session->isStarted()) {
  171.             $session->save();
  172.         }
  174.         throw new UnexpectedSessionUsageException('Session was used while the request was declared stateless.');
  175.     }
  177.     public static function getSubscribedEvents(): array
  178.     {
  179.         return [
  180.             KernelEvents::REQUEST => ['onKernelRequest', 128],
  181.             // low priority to come after regular response listeners, but higher than StreamedResponseListener
  182.             KernelEvents::RESPONSE => ['onKernelResponse', -1000],
  183.             KernelEvents::FINISH_REQUEST => ['onFinishRequest'],
  184.         ];
  185.     }
  187.     /**
  188.      * Gets the session object.
  189.      *
  190.      * @return SessionInterface|null A SessionInterface instance or null if no session is available
  191.      */
  192.     abstract protected function getSession();
  193. }