vendor/symfony/http-kernel/EventListener/AbstractTestSessionListener.php line 40

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 Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\Cookie;
  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\GetResponseEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  22. /**
  23.  * TestSessionListener.
  24.  *
  25.  * Saves session in test environment.
  26.  *
  27.  * @author Bulat Shakirzyanov <[email protected]>
  28.  * @author Fabien Potencier <[email protected]>
  29.  */
  30. abstract class AbstractTestSessionListener implements EventSubscriberInterface
  31. {
  32.     private $sessionId;
  33.     private $sessionOptions;
  35.     public function __construct(array $sessionOptions = [])
  36.     {
  37.         $this->sessionOptions = $sessionOptions;
  38.     }
  40.     public function onKernelRequest(GetResponseEvent $event)
  41.     {
  42.         if (!$event->isMasterRequest()) {
  43.             return;
  44.         }
  46.         // bootstrap the session
  47.         $session = $this->getSession();
  48.         if (!$session) {
  49.             return;
  50.         }
  52.         $cookies = $event->getRequest()->cookies;
  54.         if ($cookies->has($session->getName())) {
  55.             $this->sessionId = $cookies->get($session->getName());
  56.             $session->setId($this->sessionId);
  57.         }
  58.     }
  60.     /**
  61.      * Checks if session was initialized and saves if current request is master
  62.      * Runs on 'kernel.response' in test environment.
  63.      */
  64.     public function onKernelResponse(FilterResponseEvent $event)
  65.     {
  66.         if (!$event->isMasterRequest()) {
  67.             return;
  68.         }
  70.         $request = $event->getRequest();
  71.         if (!$request->hasSession()) {
  72.             return;
  73.         }
  75.         $session = $request->getSession();
  76.         if ($wasStarted = $session->isStarted()) {
  77.             $session->save();
  78.         }
  80.         if ($session instanceof Session ? !$session->isEmpty() || (null !== $this->sessionId && $session->getId() !== $this->sessionId) : $wasStarted) {
  81.             $params = session_get_cookie_params() + ['samesite' => null];
  82.             foreach ($this->sessionOptions as $k => $v) {
  83.                 if (0 === strpos($k, 'cookie_')) {
  84.                     $params[substr($k, 7)] = $v;
  85.                 }
  86.             }
  88.             foreach ($event->getResponse()->headers->getCookies() as $cookie) {
  89.                 if ($session->getName() === $cookie->getName() && $params['path'] === $cookie->getPath() && $params['domain'] == $cookie->getDomain()) {
  90.                     return;
  91.                 }
  92.             }
  94.             $event->getResponse()->headers->setCookie(new Cookie($session->getName(), $session->getId(), 0 === $params['lifetime'] ? 0 : time() + $params['lifetime'], $params['path'], $params['domain'], $params['secure'], $params['httponly'], false, $params['samesite'] ?: null));
  95.             $this->sessionId = $session->getId();
  96.         }
  97.     }
  99.     public static function getSubscribedEvents()
  100.     {
  101.         return [
  102.             KernelEvents::REQUEST => ['onKernelRequest', 192],
  103.             KernelEvents::RESPONSE => ['onKernelResponse', -128],
  104.         ];
  105.     }
  107.     /**
  108.      * Gets the session object.
  109.      *
  110.      * @return SessionInterface|null A SessionInterface instance or null if no session is available
  111.      */
  112.     abstract protected function getSession();
  113. }