vendor/symfony/http-foundation/Session/Storage/NativeSessionStorage.php line 287

  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\HttpFoundation\Session\Storage;
  11. use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
  12. use Symfony\Component\HttpFoundation\Session\Storage\Handler\StrictSessionHandler;
  13. use Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy;
  14. use Symfony\Component\HttpFoundation\Session\Storage\Proxy\SessionHandlerProxy;
  15. // Help opcache.preload discover always-needed symbols
  16. class_exists(MetadataBag::class);
  17. class_exists(StrictSessionHandler::class);
  18. class_exists(SessionHandlerProxy::class);
  19. /**
  20.  * This provides a base class for session attribute storage.
  21.  *
  22.  * @author Drak <drak@zikula.org>
  23.  */
  24. class NativeSessionStorage implements SessionStorageInterface
  25. {
  26.     /**
  27.      * @var SessionBagInterface[]
  28.      */
  29.     protected $bags = [];
  30.     /**
  31.      * @var bool
  32.      */
  33.     protected $started false;
  34.     /**
  35.      * @var bool
  36.      */
  37.     protected $closed false;
  38.     /**
  39.      * @var AbstractProxy|\SessionHandlerInterface
  40.      */
  41.     protected $saveHandler;
  42.     /**
  43.      * @var MetadataBag
  44.      */
  45.     protected $metadataBag;
  46.     /**
  47.      * Depending on how you want the storage driver to behave you probably
  48.      * want to override this constructor entirely.
  49.      *
  50.      * List of options for $options array with their defaults.
  51.      *
  52.      * @see https://php.net/session.configuration for options
  53.      * but we omit 'session.' from the beginning of the keys for convenience.
  54.      *
  55.      * ("auto_start", is not supported as it tells PHP to start a session before
  56.      * PHP starts to execute user-land code. Setting during runtime has no effect).
  57.      *
  58.      * cache_limiter, "" (use "0" to prevent headers from being sent entirely).
  59.      * cache_expire, "0"
  60.      * cookie_domain, ""
  61.      * cookie_httponly, ""
  62.      * cookie_lifetime, "0"
  63.      * cookie_path, "/"
  64.      * cookie_secure, ""
  65.      * cookie_samesite, null
  66.      * gc_divisor, "100"
  67.      * gc_maxlifetime, "1440"
  68.      * gc_probability, "1"
  69.      * lazy_write, "1"
  70.      * name, "PHPSESSID"
  71.      * referer_check, ""
  72.      * serialize_handler, "php"
  73.      * use_strict_mode, "1"
  74.      * use_cookies, "1"
  75.      * use_only_cookies, "1"
  76.      * use_trans_sid, "0"
  77.      * sid_length, "32"
  78.      * sid_bits_per_character, "5"
  79.      * trans_sid_hosts, $_SERVER['HTTP_HOST']
  80.      * trans_sid_tags, "a=href,area=href,frame=src,form="
  81.      */
  82.     public function __construct(array $options = [], AbstractProxy|\SessionHandlerInterface $handler nullMetadataBag $metaBag null)
  83.     {
  84.         if (!\extension_loaded('session')) {
  85.             throw new \LogicException('PHP extension "session" is required.');
  86.         }
  87.         $options += [
  88.             'cache_limiter' => '',
  89.             'cache_expire' => 0,
  90.             'use_cookies' => 1,
  91.             'lazy_write' => 1,
  92.             'use_strict_mode' => 1,
  93.         ];
  94.         session_register_shutdown();
  95.         $this->setMetadataBag($metaBag);
  96.         $this->setOptions($options);
  97.         $this->setSaveHandler($handler);
  98.     }
  99.     /**
  100.      * Gets the save handler instance.
  101.      */
  102.     public function getSaveHandler(): AbstractProxy|\SessionHandlerInterface
  103.     {
  104.         return $this->saveHandler;
  105.     }
  106.     public function start(): bool
  107.     {
  108.         if ($this->started) {
  109.             return true;
  110.         }
  111.         if (\PHP_SESSION_ACTIVE === session_status()) {
  112.             throw new \RuntimeException('Failed to start the session: already started by PHP.');
  113.         }
  114.         if (filter_var(\ini_get('session.use_cookies'), \FILTER_VALIDATE_BOOL) && headers_sent($file$line)) {
  115.             throw new \RuntimeException(sprintf('Failed to start the session because headers have already been sent by "%s" at line %d.'$file$line));
  116.         }
  117.         $sessionId $_COOKIE[session_name()] ?? null;
  118.         /*
  119.          * Explanation of the session ID regular expression: `/^[a-zA-Z0-9,-]{22,250}$/`.
  120.          *
  121.          * ---------- Part 1
  122.          *
  123.          * The part `[a-zA-Z0-9,-]` is related to the PHP ini directive `session.sid_bits_per_character` defined as 6.
  124.          * See https://www.php.net/manual/en/session.configuration.php#ini.session.sid-bits-per-character.
  125.          * Allowed values are integers such as:
  126.          * - 4 for range `a-f0-9`
  127.          * - 5 for range `a-v0-9`
  128.          * - 6 for range `a-zA-Z0-9,-`
  129.          *
  130.          * ---------- Part 2
  131.          *
  132.          * The part `{22,250}` is related to the PHP ini directive `session.sid_length`.
  133.          * See https://www.php.net/manual/en/session.configuration.php#ini.session.sid-length.
  134.          * Allowed values are integers between 22 and 256, but we use 250 for the max.
  135.          *
  136.          * Where does the 250 come from?
  137.          * - The length of Windows and Linux filenames is limited to 255 bytes. Then the max must not exceed 255.
  138.          * - The session filename prefix is `sess_`, a 5 bytes string. Then the max must not exceed 255 - 5 = 250.
  139.          *
  140.          * ---------- Conclusion
  141.          *
  142.          * The parts 1 and 2 prevent the warning below:
  143.          * `PHP Warning: SessionHandler::read(): Session ID is too long or contains illegal characters. Only the A-Z, a-z, 0-9, "-", and "," characters are allowed.`
  144.          *
  145.          * The part 2 prevents the warning below:
  146.          * `PHP Warning: SessionHandler::read(): open(filepath, O_RDWR) failed: No such file or directory (2).`
  147.          */
  148.         if ($sessionId && $this->saveHandler instanceof AbstractProxy && 'files' === $this->saveHandler->getSaveHandlerName() && !preg_match('/^[a-zA-Z0-9,-]{22,250}$/'$sessionId)) {
  149.             // the session ID in the header is invalid, create a new one
  150.             session_id(session_create_id());
  151.         }
  152.         // ok to try and start the session
  153.         if (!session_start()) {
  154.             throw new \RuntimeException('Failed to start the session.');
  155.         }
  156.         $this->loadSession();
  157.         return true;
  158.     }
  159.     public function getId(): string
  160.     {
  161.         return $this->saveHandler->getId();
  162.     }
  163.     public function setId(string $id)
  164.     {
  165.         $this->saveHandler->setId($id);
  166.     }
  167.     public function getName(): string
  168.     {
  169.         return $this->saveHandler->getName();
  170.     }
  171.     public function setName(string $name)
  172.     {
  173.         $this->saveHandler->setName($name);
  174.     }
  175.     public function regenerate(bool $destroy falseint $lifetime null): bool
  176.     {
  177.         // Cannot regenerate the session ID for non-active sessions.
  178.         if (\PHP_SESSION_ACTIVE !== session_status()) {
  179.             return false;
  180.         }
  181.         if (headers_sent()) {
  182.             return false;
  183.         }
  184.         if (null !== $lifetime && $lifetime != \ini_get('session.cookie_lifetime')) {
  185.             $this->save();
  186.             ini_set('session.cookie_lifetime'$lifetime);
  187.             $this->start();
  188.         }
  189.         if ($destroy) {
  190.             $this->metadataBag->stampNew();
  191.         }
  192.         return session_regenerate_id($destroy);
  193.     }
  194.     public function save()
  195.     {
  196.         // Store a copy so we can restore the bags in case the session was not left empty
  197.         $session $_SESSION;
  198.         foreach ($this->bags as $bag) {
  199.             if (empty($_SESSION[$key $bag->getStorageKey()])) {
  200.                 unset($_SESSION[$key]);
  201.             }
  202.         }
  203.         if ($_SESSION && [$key $this->metadataBag->getStorageKey()] === array_keys($_SESSION)) {
  204.             unset($_SESSION[$key]);
  205.         }
  206.         // Register error handler to add information about the current save handler
  207.         $previousHandler set_error_handler(function ($type$msg$file$line) use (&$previousHandler) {
  208.             if (\E_WARNING === $type && str_starts_with($msg'session_write_close():')) {
  209.                 $handler $this->saveHandler instanceof SessionHandlerProxy $this->saveHandler->getHandler() : $this->saveHandler;
  210.                 $msg sprintf('session_write_close(): Failed to write session data with "%s" handler'$handler::class);
  211.             }
  212.             return $previousHandler $previousHandler($type$msg$file$line) : false;
  213.         });
  214.         try {
  215.             session_write_close();
  216.         } finally {
  217.             restore_error_handler();
  218.             // Restore only if not empty
  219.             if ($_SESSION) {
  220.                 $_SESSION $session;
  221.             }
  222.         }
  223.         $this->closed true;
  224.         $this->started false;
  225.     }
  226.     public function clear()
  227.     {
  228.         // clear out the bags
  229.         foreach ($this->bags as $bag) {
  230.             $bag->clear();
  231.         }
  232.         // clear out the session
  233.         $_SESSION = [];
  234.         // reconnect the bags to the session
  235.         $this->loadSession();
  236.     }
  237.     public function registerBag(SessionBagInterface $bag)
  238.     {
  239.         if ($this->started) {
  240.             throw new \LogicException('Cannot register a bag when the session is already started.');
  241.         }
  242.         $this->bags[$bag->getName()] = $bag;
  243.     }
  244.     public function getBag(string $name): SessionBagInterface
  245.     {
  246.         if (!isset($this->bags[$name])) {
  247.             throw new \InvalidArgumentException(sprintf('The SessionBagInterface "%s" is not registered.'$name));
  248.         }
  249.         if (!$this->started && $this->saveHandler->isActive()) {
  250.             $this->loadSession();
  251.         } elseif (!$this->started) {
  252.             $this->start();
  253.         }
  254.         return $this->bags[$name];
  255.     }
  256.     public function setMetadataBag(MetadataBag $metaBag null)
  257.     {
  258.         if (\func_num_args()) {
  259.             trigger_deprecation('symfony/http-foundation''6.2''Calling "%s()" without any arguments is deprecated, pass null explicitly instead.'__METHOD__);
  260.         }
  261.         $this->metadataBag $metaBag ?? new MetadataBag();
  262.     }
  263.     /**
  264.      * Gets the MetadataBag.
  265.      */
  266.     public function getMetadataBag(): MetadataBag
  267.     {
  268.         return $this->metadataBag;
  269.     }
  270.     public function isStarted(): bool
  271.     {
  272.         return $this->started;
  273.     }
  274.     /**
  275.      * Sets session.* ini variables.
  276.      *
  277.      * For convenience we omit 'session.' from the beginning of the keys.
  278.      * Explicitly ignores other ini keys.
  279.      *
  280.      * @param array $options Session ini directives [key => value]
  281.      *
  282.      * @see https://php.net/session.configuration
  283.      */
  284.     public function setOptions(array $options)
  285.     {
  286.         if (headers_sent() || \PHP_SESSION_ACTIVE === session_status()) {
  287.             return;
  288.         }
  289.         $validOptions array_flip([
  290.             'cache_expire''cache_limiter''cookie_domain''cookie_httponly',
  291.             'cookie_lifetime''cookie_path''cookie_secure''cookie_samesite',
  292.             'gc_divisor''gc_maxlifetime''gc_probability',
  293.             'lazy_write''name''referer_check',
  294.             'serialize_handler''use_strict_mode''use_cookies',
  295.             'use_only_cookies''use_trans_sid',
  296.             'sid_length''sid_bits_per_character''trans_sid_hosts''trans_sid_tags',
  297.         ]);
  298.         foreach ($options as $key => $value) {
  299.             if (isset($validOptions[$key])) {
  300.                 if ('cookie_secure' === $key && 'auto' === $value) {
  301.                     continue;
  302.                 }
  303.                 ini_set('session.'.$key$value);
  304.             }
  305.         }
  306.     }
  307.     /**
  308.      * Registers session save handler as a PHP session handler.
  309.      *
  310.      * To use internal PHP session save handlers, override this method using ini_set with
  311.      * session.save_handler and session.save_path e.g.
  312.      *
  313.      *     ini_set('session.save_handler', 'files');
  314.      *     ini_set('session.save_path', '/tmp');
  315.      *
  316.      * or pass in a \SessionHandler instance which configures session.save_handler in the
  317.      * constructor, for a template see NativeFileSessionHandler.
  318.      *
  319.      * @see https://php.net/session-set-save-handler
  320.      * @see https://php.net/sessionhandlerinterface
  321.      * @see https://php.net/sessionhandler
  322.      *
  323.      * @throws \InvalidArgumentException
  324.      */
  325.     public function setSaveHandler(AbstractProxy|\SessionHandlerInterface $saveHandler null)
  326.     {
  327.         if (\func_num_args()) {
  328.             trigger_deprecation('symfony/http-foundation''6.2''Calling "%s()" without any arguments is deprecated, pass null explicitly instead.'__METHOD__);
  329.         }
  330.         // Wrap $saveHandler in proxy and prevent double wrapping of proxy
  331.         if (!$saveHandler instanceof AbstractProxy && $saveHandler instanceof \SessionHandlerInterface) {
  332.             $saveHandler = new SessionHandlerProxy($saveHandler);
  333.         } elseif (!$saveHandler instanceof AbstractProxy) {
  334.             $saveHandler = new SessionHandlerProxy(new StrictSessionHandler(new \SessionHandler()));
  335.         }
  336.         $this->saveHandler $saveHandler;
  337.         if (headers_sent() || \PHP_SESSION_ACTIVE === session_status()) {
  338.             return;
  339.         }
  340.         if ($this->saveHandler instanceof SessionHandlerProxy) {
  341.             session_set_save_handler($this->saveHandlerfalse);
  342.         }
  343.     }
  344.     /**
  345.      * Load the session with attributes.
  346.      *
  347.      * After starting the session, PHP retrieves the session from whatever handlers
  348.      * are set to (either PHP's internal, or a custom save handler set with session_set_save_handler()).
  349.      * PHP takes the return value from the read() handler, unserializes it
  350.      * and populates $_SESSION with the result automatically.
  351.      */
  352.     protected function loadSession(array &$session null)
  353.     {
  354.         if (null === $session) {
  355.             $session = &$_SESSION;
  356.         }
  357.         $bags array_merge($this->bags, [$this->metadataBag]);
  358.         foreach ($bags as $bag) {
  359.             $key $bag->getStorageKey();
  360.             $session[$key] = isset($session[$key]) && \is_array($session[$key]) ? $session[$key] : [];
  361.             $bag->initialize($session[$key]);
  362.         }
  363.         $this->started true;
  364.         $this->closed false;
  365.     }
  366. }