vendor/symfony/http-foundation/Session/Storage/Handler/AbstractSessionHandler.php line 34

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  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\HttpFoundation\Session\Storage\Handler;
  14. use Symfony\Component\HttpFoundation\Session\SessionUtils;
  16. /**
  17.  * This abstract session handler provides a generic implementation
  18.  * of the PHP 7.0 SessionUpdateTimestampHandlerInterface,
  19.  * enabling strict and lazy session handling.
  20.  *
  21.  * @author Nicolas Grekas <p@tchwork.com>
  22.  */
  23. abstract class AbstractSessionHandler implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
  24. {
  25.     private $sessionName;
  26.     private $prefetchId;
  27.     private $prefetchData;
  28.     private $newSessionId;
  29.     private $igbinaryEmptyData;
  31.     /**
  32.      * @return bool
  33.      */
  34.     public function open($savePath, $sessionName)
  35.     {
  36.         $this->sessionName = $sessionName;
  37.         if (!headers_sent() && !ini_get('session.cache_limiter') && '0' !== ini_get('session.cache_limiter')) {
  38.             header(sprintf('Cache-Control: max-age=%d, private, must-revalidate', 60 * (int) ini_get('session.cache_expire')));
  39.         }
  41.         return true;
  42.     }
  44.     /**
  45.      * @return string
  46.      */
  47.     abstract protected function doRead(string $sessionId);
  49.     /**
  50.      * @return bool
  51.      */
  52.     abstract protected function doWrite(string $sessionId, string $data);
  54.     /**
  55.      * @return bool
  56.      */
  57.     abstract protected function doDestroy(string $sessionId);
  59.     /**
  60.      * @return bool
  61.      */
  62.     public function validateId($sessionId)
  63.     {
  64.         $this->prefetchData = $this->read($sessionId);
  65.         $this->prefetchId = $sessionId;
  67.         return '' !== $this->prefetchData;
  68.     }
  70.     /**
  71.      * @return string
  72.      */
  73.     public function read($sessionId)
  74.     {
  75.         if (null !== $this->prefetchId) {
  76.             $prefetchId = $this->prefetchId;
  77.             $prefetchData = $this->prefetchData;
  78.             $this->prefetchId = $this->prefetchData = null;
  80.             if ($prefetchId === $sessionId || '' === $prefetchData) {
  81.                 $this->newSessionId = '' === $prefetchData ? $sessionId : null;
  83.                 return $prefetchData;
  84.             }
  85.         }
  87.         $data = $this->doRead($sessionId);
  88.         $this->newSessionId = '' === $data ? $sessionId : null;
  90.         return $data;
  91.     }
  93.     /**
  94.      * @return bool
  95.      */
  96.     public function write($sessionId, $data)
  97.     {
  98.         if (null === $this->igbinaryEmptyData) {
  99.             // see https://github.com/igbinary/igbinary/issues/146
  100.             $this->igbinaryEmptyData = \function_exists('igbinary_serialize') ? igbinary_serialize([]) : '';
  101.         }
  102.         if ('' === $data || $this->igbinaryEmptyData === $data) {
  103.             return $this->destroy($sessionId);
  104.         }
  105.         $this->newSessionId = null;
  107.         return $this->doWrite($sessionId, $data);
  108.     }
  110.     /**
  111.      * @return bool
  112.      */
  113.     public function destroy($sessionId)
  114.     {
  115.         if (!headers_sent() && filter_var(ini_get('session.use_cookies'), FILTER_VALIDATE_BOOLEAN)) {
  116.             if (!$this->sessionName) {
  117.                 throw new \LogicException(sprintf('Session name cannot be empty, did you forget to call "parent::open()" in "%s"?.', static::class));
  118.             }
  119.             $cookie = SessionUtils::popSessionCookie($this->sessionName, $sessionId);
  121.             /*
  122.              * We send an invalidation Set-Cookie header (zero lifetime)
  123.              * when either the session was started or a cookie with
  124.              * the session name was sent by the client (in which case
  125.              * we know it's invalid as a valid session cookie would've
  126.              * started the session).
  127.              */
  128.             if (null === $cookie || isset($_COOKIE[$this->sessionName])) {
  129.                 if (\PHP_VERSION_ID < 70300) {
  130.                     setcookie($this->sessionName, '', 0, ini_get('session.cookie_path'), ini_get('session.cookie_domain'), filter_var(ini_get('session.cookie_secure'), FILTER_VALIDATE_BOOLEAN), filter_var(ini_get('session.cookie_httponly'), FILTER_VALIDATE_BOOLEAN));
  131.                 } else {
  132.                     $params = session_get_cookie_params();
  133.                     unset($params['lifetime']);
  134.                     setcookie($this->sessionName, '', $params);
  135.                 }
  136.             }
  137.         }
  139.         return $this->newSessionId === $sessionId || $this->doDestroy($sessionId);
  140.     }
  141. }