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

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