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

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