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

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\Cookie;
  14. use Symfony\Component\HttpFoundation\Session\Session;
  15. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  16. use Symfony\Component\HttpFoundation\Session\SessionUtils;
  17. use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
  18. use Symfony\Component\HttpKernel\Event\RequestEvent;
  19. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  20. use Symfony\Component\HttpKernel\Exception\UnexpectedSessionUsageException;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  22. use Symfony\Contracts\Service\ResetInterface;
  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 <schmittjoh@gmail.com>
  34.  * @author Tobias Schultze <http://tobion.de>
  35.  *
  36.  * @internal
  37.  */
  38. abstract class AbstractSessionListener implements EventSubscriberInterfaceResetInterface
  39. {
  40.     public const NO_AUTO_CACHE_CONTROL_HEADER 'Symfony-Session-NoAutoCacheControl';
  41.     protected $container;
  42.     private $sessionUsageStack = [];
  43.     private $debug;
  44.     /**
  45.      * @var array<string, mixed>
  46.      */
  47.     private $sessionOptions;
  48.     public function __construct(ContainerInterface $container nullbool $debug false, array $sessionOptions = [])
  49.     {
  50.         $this->container $container;
  51.         $this->debug $debug;
  52.         $this->sessionOptions $sessionOptions;
  53.     }
  54.     public function onKernelRequest(RequestEvent $event)
  55.     {
  56.         if (!$event->isMainRequest()) {
  57.             return;
  58.         }
  59.         $request $event->getRequest();
  60.         if (!$request->hasSession()) {
  61.             // This variable prevents calling `$this->getSession()` twice in case the Request (and the below factory) is cloned
  62.             $sess null;
  63.             $request->setSessionFactory(function () use (&$sess$request) {
  64.                 if (!$sess) {
  65.                     $sess $this->getSession();
  66.                     /*
  67.                      * For supporting sessions in php runtime with runners like roadrunner or swoole, the session
  68.                      * cookie needs to be read from the cookie bag and set on the session storage.
  69.                      *
  70.                      * Do not set it when a native php session is active.
  71.                      */
  72.                     if ($sess && !$sess->isStarted() && \PHP_SESSION_ACTIVE !== session_status()) {
  73.                         $sessionId $sess->getId() ?: $request->cookies->get($sess->getName(), '');
  74.                         $sess->setId($sessionId);
  75.                     }
  76.                 }
  77.                 return $sess;
  78.             });
  79.         }
  80.         $session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : null;
  81.         $this->sessionUsageStack[] = $session instanceof Session $session->getUsageIndex() : 0;
  82.     }
  83.     public function onKernelResponse(ResponseEvent $event)
  84.     {
  85.         if (!$event->isMainRequest() || (!$this->container->has('initialized_session') && !$event->getRequest()->hasSession())) {
  86.             return;
  87.         }
  88.         $response $event->getResponse();
  89.         $autoCacheControl = !$response->headers->has(self::NO_AUTO_CACHE_CONTROL_HEADER);
  90.         // Always remove the internal header if present
  91.         $response->headers->remove(self::NO_AUTO_CACHE_CONTROL_HEADER);
  92.         if (!$session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : ($event->getRequest()->hasSession() ? $event->getRequest()->getSession() : null)) {
  93.             return;
  94.         }
  95.         if ($session->isStarted()) {
  96.             /*
  97.              * Saves the session, in case it is still open, before sending the response/headers.
  98.              *
  99.              * This ensures several things in case the developer did not save the session explicitly:
  100.              *
  101.              *  * If a session save handler without locking is used, it ensures the data is available
  102.              *    on the next request, e.g. after a redirect. PHPs auto-save at script end via
  103.              *    session_register_shutdown is executed after fastcgi_finish_request. So in this case
  104.              *    the data could be missing the next request because it might not be saved the moment
  105.              *    the new request is processed.
  106.              *  * A locking save handler (e.g. the native 'files') circumvents concurrency problems like
  107.              *    the one above. But by saving the session before long-running things in the terminate event,
  108.              *    we ensure the session is not blocked longer than needed.
  109.              *  * When regenerating the session ID no locking is involved in PHPs session design. See
  110.              *    https://bugs.php.net/61470 for a discussion. So in this case, the session must
  111.              *    be saved anyway before sending the headers with the new session ID. Otherwise session
  112.              *    data could get lost again for concurrent requests with the new ID. One result could be
  113.              *    that you get logged out after just logging in.
  114.              *
  115.              * This listener should be executed as one of the last listeners, so that previous listeners
  116.              * can still operate on the open session. This prevents the overhead of restarting it.
  117.              * Listeners after closing the session can still work with the session as usual because
  118.              * Symfonys session implementation starts the session on demand. So writing to it after
  119.              * it is saved will just restart it.
  120.              */
  121.             $session->save();
  122.             /*
  123.              * For supporting sessions in php runtime with runners like roadrunner or swoole the session
  124.              * cookie need to be written on the response object and should not be written by PHP itself.
  125.              */
  126.             $sessionName $session->getName();
  127.             $sessionId $session->getId();
  128.             $sessionOptions $this->getSessionOptions($this->sessionOptions);
  129.             $sessionCookiePath $sessionOptions['cookie_path'] ?? '/';
  130.             $sessionCookieDomain $sessionOptions['cookie_domain'] ?? null;
  131.             $sessionCookieSecure $sessionOptions['cookie_secure'] ?? false;
  132.             $sessionCookieHttpOnly $sessionOptions['cookie_httponly'] ?? true;
  133.             $sessionCookieSameSite $sessionOptions['cookie_samesite'] ?? Cookie::SAMESITE_LAX;
  134.             $sessionUseCookies $sessionOptions['use_cookies'] ?? true;
  135.             SessionUtils::popSessionCookie($sessionName$sessionId);
  136.             if ($sessionUseCookies) {
  137.                 $request $event->getRequest();
  138.                 $requestSessionCookieId $request->cookies->get($sessionName);
  139.                 $isSessionEmpty $session->isEmpty() && empty($_SESSION); // checking $_SESSION to keep compatibility with native sessions
  140.                 if ($requestSessionCookieId && $isSessionEmpty) {
  141.                     // PHP internally sets the session cookie value to "deleted" when setcookie() is called with empty string $value argument
  142.                     // which happens in \Symfony\Component\HttpFoundation\Session\Storage\Handler\AbstractSessionHandler::destroy
  143.                     // when the session gets invalidated (for example on logout) so we must handle this case here too
  144.                     // otherwise we would send two Set-Cookie headers back with the response
  145.                     SessionUtils::popSessionCookie($sessionName'deleted');
  146.                     $response->headers->clearCookie(
  147.                         $sessionName,
  148.                         $sessionCookiePath,
  149.                         $sessionCookieDomain,
  150.                         $sessionCookieSecure,
  151.                         $sessionCookieHttpOnly,
  152.                         $sessionCookieSameSite
  153.                     );
  154.                 } elseif ($sessionId !== $requestSessionCookieId && !$isSessionEmpty) {
  155.                     $expire 0;
  156.                     $lifetime $sessionOptions['cookie_lifetime'] ?? null;
  157.                     if ($lifetime) {
  158.                         $expire time() + $lifetime;
  159.                     }
  160.                     $response->headers->setCookie(
  161.                         Cookie::create(
  162.                             $sessionName,
  163.                             $sessionId,
  164.                             $expire,
  165.                             $sessionCookiePath,
  166.                             $sessionCookieDomain,
  167.                             $sessionCookieSecure,
  168.                             $sessionCookieHttpOnly,
  169.                             false,
  170.                             $sessionCookieSameSite
  171.                         )
  172.                     );
  173.                 }
  174.             }
  175.         }
  176.         if ($session instanceof Session $session->getUsageIndex() === end($this->sessionUsageStack) : !$session->isStarted()) {
  177.             return;
  178.         }
  179.         if ($autoCacheControl) {
  180.             $response
  181.                 ->setExpires(new \DateTime())
  182.                 ->setPrivate()
  183.                 ->setMaxAge(0)
  184.                 ->headers->addCacheControlDirective('must-revalidate');
  185.         }
  186.         if (!$event->getRequest()->attributes->get('_stateless'false)) {
  187.             return;
  188.         }
  189.         if ($this->debug) {
  190.             throw new UnexpectedSessionUsageException('Session was used while the request was declared stateless.');
  191.         }
  192.         if ($this->container->has('logger')) {
  193.             $this->container->get('logger')->warning('Session was used while the request was declared stateless.');
  194.         }
  195.     }
  196.     public function onFinishRequest(FinishRequestEvent $event)
  197.     {
  198.         if ($event->isMainRequest()) {
  199.             array_pop($this->sessionUsageStack);
  200.         }
  201.     }
  202.     public function onSessionUsage(): void
  203.     {
  204.         if (!$this->debug) {
  205.             return;
  206.         }
  207.         if ($this->container && $this->container->has('session_collector')) {
  208.             $this->container->get('session_collector')();
  209.         }
  210.         if (!$requestStack $this->container && $this->container->has('request_stack') ? $this->container->get('request_stack') : null) {
  211.             return;
  212.         }
  213.         $stateless false;
  214.         $clonedRequestStack = clone $requestStack;
  215.         while (null !== ($request $clonedRequestStack->pop()) && !$stateless) {
  216.             $stateless $request->attributes->get('_stateless');
  217.         }
  218.         if (!$stateless) {
  219.             return;
  220.         }
  221.         if (!$session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $requestStack->getCurrentRequest()->getSession()) {
  222.             return;
  223.         }
  224.         if ($session->isStarted()) {
  225.             $session->save();
  226.         }
  227.         throw new UnexpectedSessionUsageException('Session was used while the request was declared stateless.');
  228.     }
  229.     public static function getSubscribedEvents(): array
  230.     {
  231.         return [
  232.             KernelEvents::REQUEST => ['onKernelRequest'128],
  233.             // low priority to come after regular response listeners, but higher than StreamedResponseListener
  234.             KernelEvents::RESPONSE => ['onKernelResponse', -1000],
  235.             KernelEvents::FINISH_REQUEST => ['onFinishRequest'],
  236.         ];
  237.     }
  238.     public function reset(): void
  239.     {
  240.         if (\PHP_SESSION_ACTIVE === session_status()) {
  241.             session_abort();
  242.         }
  243.         session_unset();
  244.         $_SESSION = [];
  245.         if (!headers_sent()) { // session id can only be reset when no headers were so we check for headers_sent first
  246.             session_id('');
  247.         }
  248.     }
  249.     /**
  250.      * Gets the session object.
  251.      *
  252.      * @return SessionInterface|null
  253.      */
  254.     abstract protected function getSession();
  255.     private function getSessionOptions(array $sessionOptions): array
  256.     {
  257.         $mergedSessionOptions = [];
  258.         foreach (session_get_cookie_params() as $key => $value) {
  259.             $mergedSessionOptions['cookie_'.$key] = $value;
  260.         }
  261.         foreach ($sessionOptions as $key => $value) {
  262.             // do the same logic as in the NativeSessionStorage
  263.             if ('cookie_secure' === $key && 'auto' === $value) {
  264.                 continue;
  265.             }
  266.             $mergedSessionOptions[$key] = $value;
  267.         }
  268.         return $mergedSessionOptions;
  269.     }
  270. }