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

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.         $session = null;
  57.         $request = $event->getRequest();
  58.         if (!$request->hasSession()) {
  59.             $sess = null;
  60.             $request->setSessionFactory(function () use (&$sess) { return $sess ?? $sess = $this->getSession(); });
  61.         }
  63.         $session = $session ?? ($this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : null);
  64.         $this->sessionUsageStack[] = $session instanceof Session ? $session->getUsageIndex() : 0;
  65.     }
  67.     public function onKernelResponse(FilterResponseEvent $event)
  68.     {
  69.         if (!$event->isMasterRequest()) {
  70.             return;
  71.         }
  73.         $response = $event->getResponse();
  74.         $autoCacheControl = !$response->headers->has(self::NO_AUTO_CACHE_CONTROL_HEADER);
  75.         // Always remove the internal header if present
  76.         $response->headers->remove(self::NO_AUTO_CACHE_CONTROL_HEADER);
  78.         if (!$session = $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $event->getRequest()->getSession()) {
  79.             return;
  80.         }
  82.         if ($session instanceof Session ? $session->getUsageIndex() !== end($this->sessionUsageStack) : $session->isStarted()) {
  83.             if ($autoCacheControl) {
  84.                 $response
  85.                     ->setExpires(new \DateTime())
  86.                     ->setPrivate()
  87.                     ->setMaxAge(0)
  88.                     ->headers->addCacheControlDirective('must-revalidate');
  89.             }
  90.         }
  92.         if ($session->isStarted()) {
  93.             /*
  94.              * Saves the session, in case it is still open, before sending the response/headers.
  95.              *
  96.              * This ensures several things in case the developer did not save the session explicitly:
  97.              *
  98.              *  * If a session save handler without locking is used, it ensures the data is available
  99.              *    on the next request, e.g. after a redirect. PHPs auto-save at script end via
  100.              *    session_register_shutdown is executed after fastcgi_finish_request. So in this case
  101.              *    the data could be missing the next request because it might not be saved the moment
  102.              *    the new request is processed.
  103.              *  * A locking save handler (e.g. the native 'files') circumvents concurrency problems like
  104.              *    the one above. But by saving the session before long-running things in the terminate event,
  105.              *    we ensure the session is not blocked longer than needed.
  106.              *  * When regenerating the session ID no locking is involved in PHPs session design. See
  107.              *    https://bugs.php.net/61470 for a discussion. So in this case, the session must
  108.              *    be saved anyway before sending the headers with the new session ID. Otherwise session
  109.              *    data could get lost again for concurrent requests with the new ID. One result could be
  110.              *    that you get logged out after just logging in.
  111.              *
  112.              * This listener should be executed as one of the last listeners, so that previous listeners
  113.              * can still operate on the open session. This prevents the overhead of restarting it.
  114.              * Listeners after closing the session can still work with the session as usual because
  115.              * Symfonys session implementation starts the session on demand. So writing to it after
  116.              * it is saved will just restart it.
  117.              */
  118.             $session->save();
  119.         }
  120.     }
  122.     /**
  123.      * @internal
  124.      */
  125.     public function onFinishRequest(FinishRequestEvent $event)
  126.     {
  127.         if ($event->isMasterRequest()) {
  128.             array_pop($this->sessionUsageStack);
  129.         }
  130.     }
  132.     public static function getSubscribedEvents()
  133.     {
  134.         return [
  135.             KernelEvents::REQUEST => ['onKernelRequest', 128],
  136.             // low priority to come after regular response listeners, but higher than StreamedResponseListener
  137.             KernelEvents::RESPONSE => ['onKernelResponse', -1000],
  138.             KernelEvents::FINISH_REQUEST => ['onFinishRequest'],
  139.         ];
  140.     }
  142.     /**
  143.      * Gets the session object.
  144.      *
  145.      * @return SessionInterface|null A SessionInterface instance or null if no session is available
  146.      */
  147.     abstract protected function getSession();
  148. }