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.                 /*
  68.                  * For supporting sessions in php runtime with runners like roadrunner or swoole the session
  69.                  * cookie need read from the cookie bag and set on the session storage.
  70.                  */
  71.                 if ($sess && !$sess->isStarted()) {
  72.                     $sessionId $request->cookies->get($sess->getName(), '');
  73.                     $sess->setId($sessionId);
  74.                 }
  75.                 return $sess;
  76.             });
  77.         }
  78.         $session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : null;
  79.         $this->sessionUsageStack[] = $session instanceof Session $session->getUsageIndex() : 0;
  80.     }
  81.     public function onKernelResponse(ResponseEvent $event)
  82.     {
  83.         if (!$event->isMainRequest() || (!$this->container->has('initialized_session') && !$event->getRequest()->hasSession())) {
  84.             return;
  85.         }
  86.         $response $event->getResponse();
  87.         $autoCacheControl = !$response->headers->has(self::NO_AUTO_CACHE_CONTROL_HEADER);
  88.         // Always remove the internal header if present
  89.         $response->headers->remove(self::NO_AUTO_CACHE_CONTROL_HEADER);
  90.         if (!$session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $event->getRequest()->getSession()) {
  91.             return;
  92.         }
  93.         if ($session->isStarted()) {
  94.             /*
  95.              * Saves the session, in case it is still open, before sending the response/headers.
  96.              *
  97.              * This ensures several things in case the developer did not save the session explicitly:
  98.              *
  99.              *  * If a session save handler without locking is used, it ensures the data is available
  100.              *    on the next request, e.g. after a redirect. PHPs auto-save at script end via
  101.              *    session_register_shutdown is executed after fastcgi_finish_request. So in this case
  102.              *    the data could be missing the next request because it might not be saved the moment
  103.              *    the new request is processed.
  104.              *  * A locking save handler (e.g. the native 'files') circumvents concurrency problems like
  105.              *    the one above. But by saving the session before long-running things in the terminate event,
  106.              *    we ensure the session is not blocked longer than needed.
  107.              *  * When regenerating the session ID no locking is involved in PHPs session design. See
  108.              *    https://bugs.php.net/61470 for a discussion. So in this case, the session must
  109.              *    be saved anyway before sending the headers with the new session ID. Otherwise session
  110.              *    data could get lost again for concurrent requests with the new ID. One result could be
  111.              *    that you get logged out after just logging in.
  112.              *
  113.              * This listener should be executed as one of the last listeners, so that previous listeners
  114.              * can still operate on the open session. This prevents the overhead of restarting it.
  115.              * Listeners after closing the session can still work with the session as usual because
  116.              * Symfonys session implementation starts the session on demand. So writing to it after
  117.              * it is saved will just restart it.
  118.              */
  119.             $session->save();
  120.             /*
  121.              * For supporting sessions in php runtime with runners like roadrunner or swoole the session
  122.              * cookie need to be written on the response object and should not be written by PHP itself.
  123.              */
  124.             $sessionName $session->getName();
  125.             $sessionId $session->getId();
  126.             $sessionOptions $this->getSessionOptions($this->sessionOptions);
  127.             $sessionCookiePath $sessionOptions['cookie_path'] ?? '/';
  128.             $sessionCookieDomain $sessionOptions['cookie_domain'] ?? null;
  129.             $sessionCookieSecure $sessionOptions['cookie_secure'] ?? false;
  130.             $sessionCookieHttpOnly $sessionOptions['cookie_httponly'] ?? true;
  131.             $sessionCookieSameSite $sessionOptions['cookie_samesite'] ?? Cookie::SAMESITE_LAX;
  132.             SessionUtils::popSessionCookie($sessionName$sessionId);
  133.             $request $event->getRequest();
  134.             $requestSessionCookieId $request->cookies->get($sessionName);
  135.             if ($requestSessionCookieId && $session->isEmpty()) {
  136.                 $response->headers->clearCookie(
  137.                     $sessionName,
  138.                     $sessionCookiePath,
  139.                     $sessionCookieDomain,
  140.                     $sessionCookieSecure,
  141.                     $sessionCookieHttpOnly,
  142.                     $sessionCookieSameSite
  143.                 );
  144.             } elseif ($sessionId !== $requestSessionCookieId) {
  145.                 $expire 0;
  146.                 $lifetime $sessionOptions['cookie_lifetime'] ?? null;
  147.                 if ($lifetime) {
  148.                     $expire time() + $lifetime;
  149.                 }
  150.                 $response->headers->setCookie(
  151.                     Cookie::create(
  152.                         $sessionName,
  153.                         $sessionId,
  154.                         $expire,
  155.                         $sessionCookiePath,
  156.                         $sessionCookieDomain,
  157.                         $sessionCookieSecure,
  158.                         $sessionCookieHttpOnly,
  159.                         false,
  160.                         $sessionCookieSameSite
  161.                     )
  162.                 );
  163.             }
  164.         }
  165.         if ($session instanceof Session $session->getUsageIndex() === end($this->sessionUsageStack) : !$session->isStarted()) {
  166.             return;
  167.         }
  168.         if ($autoCacheControl) {
  169.             $response
  170.                 ->setExpires(new \DateTime())
  171.                 ->setPrivate()
  172.                 ->setMaxAge(0)
  173.                 ->headers->addCacheControlDirective('must-revalidate');
  174.         }
  175.         if (!$event->getRequest()->attributes->get('_stateless'false)) {
  176.             return;
  177.         }
  178.         if ($this->debug) {
  179.             throw new UnexpectedSessionUsageException('Session was used while the request was declared stateless.');
  180.         }
  181.         if ($this->container->has('logger')) {
  182.             $this->container->get('logger')->warning('Session was used while the request was declared stateless.');
  183.         }
  184.     }
  185.     public function onFinishRequest(FinishRequestEvent $event)
  186.     {
  187.         if ($event->isMainRequest()) {
  188.             array_pop($this->sessionUsageStack);
  189.         }
  190.     }
  191.     public function onSessionUsage(): void
  192.     {
  193.         if (!$this->debug) {
  194.             return;
  195.         }
  196.         if ($this->container && $this->container->has('session_collector')) {
  197.             $this->container->get('session_collector')();
  198.         }
  199.         if (!$requestStack $this->container && $this->container->has('request_stack') ? $this->container->get('request_stack') : null) {
  200.             return;
  201.         }
  202.         $stateless false;
  203.         $clonedRequestStack = clone $requestStack;
  204.         while (null !== ($request $clonedRequestStack->pop()) && !$stateless) {
  205.             $stateless $request->attributes->get('_stateless');
  206.         }
  207.         if (!$stateless) {
  208.             return;
  209.         }
  210.         if (!$session $this->container && $this->container->has('initialized_session') ? $this->container->get('initialized_session') : $requestStack->getCurrentRequest()->getSession()) {
  211.             return;
  212.         }
  213.         if ($session->isStarted()) {
  214.             $session->save();
  215.         }
  216.         throw new UnexpectedSessionUsageException('Session was used while the request was declared stateless.');
  217.     }
  218.     public static function getSubscribedEvents(): array
  219.     {
  220.         return [
  221.             KernelEvents::REQUEST => ['onKernelRequest'128],
  222.             // low priority to come after regular response listeners, but higher than StreamedResponseListener
  223.             KernelEvents::RESPONSE => ['onKernelResponse', -1000],
  224.             KernelEvents::FINISH_REQUEST => ['onFinishRequest'],
  225.         ];
  226.     }
  227.     public function reset(): void
  228.     {
  229.         if (\PHP_SESSION_ACTIVE === session_status()) {
  230.             session_abort();
  231.         }
  232.         session_unset();
  233.         $_SESSION = [];
  234.         if (!headers_sent()) { // session id can only be reset when no headers were so we check for headers_sent first
  235.             session_id('');
  236.         }
  237.     }
  238.     /**
  239.      * Gets the session object.
  240.      *
  241.      * @return SessionInterface|null
  242.      */
  243.     abstract protected function getSession();
  244.     private function getSessionOptions(array $sessionOptions): array
  245.     {
  246.         $mergedSessionOptions = [];
  247.         foreach (session_get_cookie_params() as $key => $value) {
  248.             $mergedSessionOptions['cookie_'.$key] = $value;
  249.         }
  250.         foreach ($sessionOptions as $key => $value) {
  251.             // do the same logic as in the NativeSessionStorage
  252.             if ('cookie_secure' === $key && 'auto' === $value) {
  253.                 continue;
  254.             }
  255.             $mergedSessionOptions[$key] = $value;
  256.         }
  257.         return $mergedSessionOptions;
  258.     }
  259. }