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

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.      * {@inheritdoc}
  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.      * @param string $sessionId
  46.      *
  47.      * @return string
  48.      */
  49.     abstract protected function doRead($sessionId);
  51.     /**
  52.      * @param string $sessionId
  53.      * @param string $data
  54.      *
  55.      * @return bool
  56.      */
  57.     abstract protected function doWrite($sessionId, $data);
  59.     /**
  60.      * @param string $sessionId
  61.      *
  62.      * @return bool
  63.      */
  64.     abstract protected function doDestroy($sessionId);
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function validateId($sessionId)
  70.     {
  71.         $this->prefetchData = $this->read($sessionId);
  72.         $this->prefetchId = $sessionId;
  74.         return '' !== $this->prefetchData;
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function read($sessionId)
  81.     {
  82.         if (null !== $this->prefetchId) {
  83.             $prefetchId = $this->prefetchId;
  84.             $prefetchData = $this->prefetchData;
  85.             $this->prefetchId = $this->prefetchData = null;
  87.             if ($prefetchId === $sessionId || '' === $prefetchData) {
  88.                 $this->newSessionId = '' === $prefetchData ? $sessionId : null;
  90.                 return $prefetchData;
  91.             }
  92.         }
  94.         $data = $this->doRead($sessionId);
  95.         $this->newSessionId = '' === $data ? $sessionId : null;
  97.         return $data;
  98.     }
  100.     /**
  101.      * {@inheritdoc}
  102.      */
  103.     public function write($sessionId, $data)
  104.     {
  105.         if (null === $this->igbinaryEmptyData) {
  106.             // see https://github.com/igbinary/igbinary/issues/146
  107.             $this->igbinaryEmptyData = \function_exists('igbinary_serialize') ? igbinary_serialize([]) : '';
  108.         }
  109.         if ('' === $data || $this->igbinaryEmptyData === $data) {
  110.             return $this->destroy($sessionId);
  111.         }
  112.         $this->newSessionId = null;
  114.         return $this->doWrite($sessionId, $data);
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public function destroy($sessionId)
  121.     {
  122.         if (!headers_sent() && filter_var(ini_get('session.use_cookies'), FILTER_VALIDATE_BOOLEAN)) {
  123.             if (!$this->sessionName) {
  124.                 throw new \LogicException(sprintf('Session name cannot be empty, did you forget to call "parent::open()" in "%s"?.', \get_class($this)));
  125.             }
  126.             $cookie = SessionUtils::popSessionCookie($this->sessionName, $sessionId);
  127.             if (null === $cookie) {
  128.                 if (\PHP_VERSION_ID < 70300) {
  129.                     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));
  130.                 } else {
  131.                     $params = session_get_cookie_params();
  132.                     unset($params['lifetime']);
  133.                     setcookie($this->sessionName, '', $params);
  134.                 }
  135.             }
  136.         }
  138.         return $this->newSessionId === $sessionId || $this->doDestroy($sessionId);
  139.     }
  140. }