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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\HttpKernel\EventListener;
  11. use Psr\Container\ContainerInterface;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Symfony\Component\HttpFoundation\Session\Session;
  14. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  15. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  16. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  17. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. /**
  20.  * Sets the session onto the request on the "kernel.request" event and saves
  21.  * it on the "kernel.response" event.
  22.  *
  23.  * In addition, if the session has been started it overrides the Cache-Control
  24.  * header in such a way that all caching is disabled in that case.
  25.  * If you have a scenario where caching responses with session information in
  26.  * them makes sense, you can disable this behaviour by setting the header
  27.  * AbstractSessionListener::NO_AUTO_CACHE_CONTROL_HEADER on the response.
  28.  *
  29.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  30.  * @author Tobias Schultze <http://tobion.de>
  31.  *
  32.  * @internal since Symfony 4.3
  33.  */
  34. abstract class AbstractSessionListener implements EventSubscriberInterface
  35. {
  36.     public const NO_AUTO_CACHE_CONTROL_HEADER 'Symfony-Session-NoAutoCacheControl';
  37.     protected $container;
  38.     private $sessionUsageStack = [];
  39.     public function __construct(ContainerInterface $container null)
  40.     {
  41.         $this->container $container;
  42.     }
  43.     public function onKernelRequest(GetResponseEvent $event)
  44.     {
  45.         if (!$event->isMasterRequest()) {
  46.             return;
  47.         }
  48.         $request $event->getRequest();
  49.         if (!$request->hasSession()) {
  50.             $sess null;
  51.             $request->setSessionFactory(function () use (&$sess) { return $sess ?? $sess $this->getSession(); });
  52.         }
  53.         $session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : null;
  54.         $this->sessionUsageStack[] = $session instanceof Session $session->getUsageIndex() : 0;
  55.     }
  56.     public function onKernelResponse(FilterResponseEvent $event)
  57.     {
  58.         if (!$event->isMasterRequest()) {
  59.             return;
  60.         }
  61.         $response $event->getResponse();
  62.         $autoCacheControl = !$response->headers->has(self::NO_AUTO_CACHE_CONTROL_HEADER);
  63.         // Always remove the internal header if present
  64.         $response->headers->remove(self::NO_AUTO_CACHE_CONTROL_HEADER);
  65.         if (!$session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $event->getRequest()->getSession()) {
  66.             return;
  67.         }
  68.         if ($session instanceof Session $session->getUsageIndex() !== end($this->sessionUsageStack) : $session->isStarted()) {
  69.             if ($autoCacheControl) {
  70.                 $response
  71.                     ->setExpires(new \DateTime())
  72.                     ->setPrivate()
  73.                     ->setMaxAge(0)
  74.                     ->headers->addCacheControlDirective('must-revalidate');
  75.             }
  76.         }
  77.         if ($session->isStarted()) {
  78.             /*
  79.              * Saves the session, in case it is still open, before sending the response/headers.
  80.              *
  81.              * This ensures several things in case the developer did not save the session explicitly:
  82.              *
  83.              *  * If a session save handler without locking is used, it ensures the data is available
  84.              *    on the next request, e.g. after a redirect. PHPs auto-save at script end via
  85.              *    session_register_shutdown is executed after fastcgi_finish_request. So in this case
  86.              *    the data could be missing the next request because it might not be saved the moment
  87.              *    the new request is processed.
  88.              *  * A locking save handler (e.g. the native 'files') circumvents concurrency problems like
  89.              *    the one above. But by saving the session before long-running things in the terminate event,
  90.              *    we ensure the session is not blocked longer than needed.
  91.              *  * When regenerating the session ID no locking is involved in PHPs session design. See
  92.              *    https://bugs.php.net/61470 for a discussion. So in this case, the session must
  93.              *    be saved anyway before sending the headers with the new session ID. Otherwise session
  94.              *    data could get lost again for concurrent requests with the new ID. One result could be
  95.              *    that you get logged out after just logging in.
  96.              *
  97.              * This listener should be executed as one of the last listeners, so that previous listeners
  98.              * can still operate on the open session. This prevents the overhead of restarting it.
  99.              * Listeners after closing the session can still work with the session as usual because
  100.              * Symfonys session implementation starts the session on demand. So writing to it after
  101.              * it is saved will just restart it.
  102.              */
  103.             $session->save();
  104.         }
  105.     }
  106.     /**
  107.      * @internal
  108.      */
  109.     public function onFinishRequest(FinishRequestEvent $event)
  110.     {
  111.         if ($event->isMasterRequest()) {
  112.             array_pop($this->sessionUsageStack);
  113.         }
  114.     }
  115.     public static function getSubscribedEvents()
  116.     {
  117.         return [
  118.             KernelEvents::REQUEST => ['onKernelRequest'128],
  119.             // low priority to come after regular response listeners, but higher than StreamedResponseListener
  120.             KernelEvents::RESPONSE => ['onKernelResponse', -1000],
  121.             KernelEvents::FINISH_REQUEST => ['onFinishRequest'],
  122.         ];
  123.     }
  124.     /**
  125.      * Gets the session object.
  126.      *
  127.      * @return SessionInterface|null A SessionInterface instance or null if no session is available
  128.      */
  129.     abstract protected function getSession();
  130. }