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