Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\HttpFoundation\Session\Storage;
Chris@0: 
Chris@0: use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
Chris@0: use Symfony\Component\HttpFoundation\Session\Storage\Handler\NativeSessionHandler;
Chris@0: use Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy;
Chris@0: use Symfony\Component\HttpFoundation\Session\Storage\Proxy\SessionHandlerProxy;
Chris@0: 
Chris@0: /**
Chris@0:  * This provides a base class for session attribute storage.
Chris@0:  *
Chris@0:  * @author Drak <drak@zikula.org>
Chris@0:  */
Chris@0: class NativeSessionStorage implements SessionStorageInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Array of SessionBagInterface.
Chris@0:      *
Chris@0:      * @var SessionBagInterface[]
Chris@0:      */
Chris@0:     protected $bags;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var bool
Chris@0:      */
Chris@0:     protected $started = false;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var bool
Chris@0:      */
Chris@0:     protected $closed = false;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var AbstractProxy
Chris@0:      */
Chris@0:     protected $saveHandler;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var MetadataBag
Chris@0:      */
Chris@0:     protected $metadataBag;
Chris@0: 
Chris@0:     /**
Chris@0:      * Constructor.
Chris@0:      *
Chris@0:      * Depending on how you want the storage driver to behave you probably
Chris@0:      * want to override this constructor entirely.
Chris@0:      *
Chris@0:      * List of options for $options array with their defaults.
Chris@0:      *
Chris@0:      * @see http://php.net/session.configuration for options
Chris@0:      * but we omit 'session.' from the beginning of the keys for convenience.
Chris@0:      *
Chris@0:      * ("auto_start", is not supported as it tells PHP to start a session before
Chris@0:      * PHP starts to execute user-land code. Setting during runtime has no effect).
Chris@0:      *
Chris@0:      * cache_limiter, "" (use "0" to prevent headers from being sent entirely).
Chris@0:      * cookie_domain, ""
Chris@0:      * cookie_httponly, ""
Chris@0:      * cookie_lifetime, "0"
Chris@0:      * cookie_path, "/"
Chris@0:      * cookie_secure, ""
Chris@0:      * entropy_file, ""
Chris@0:      * entropy_length, "0"
Chris@0:      * gc_divisor, "100"
Chris@0:      * gc_maxlifetime, "1440"
Chris@0:      * gc_probability, "1"
Chris@0:      * hash_bits_per_character, "4"
Chris@0:      * hash_function, "0"
Chris@0:      * name, "PHPSESSID"
Chris@0:      * referer_check, ""
Chris@0:      * serialize_handler, "php"
Chris@0:      * use_strict_mode, "0"
Chris@0:      * use_cookies, "1"
Chris@0:      * use_only_cookies, "1"
Chris@0:      * use_trans_sid, "0"
Chris@0:      * upload_progress.enabled, "1"
Chris@0:      * upload_progress.cleanup, "1"
Chris@0:      * upload_progress.prefix, "upload_progress_"
Chris@0:      * upload_progress.name, "PHP_SESSION_UPLOAD_PROGRESS"
Chris@0:      * upload_progress.freq, "1%"
Chris@0:      * upload_progress.min-freq, "1"
Chris@0:      * url_rewriter.tags, "a=href,area=href,frame=src,form=,fieldset="
Chris@0:      *
Chris@0:      * @param array                                                            $options Session configuration options
Chris@0:      * @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler
Chris@0:      * @param MetadataBag                                                      $metaBag MetadataBag
Chris@0:      */
Chris@0:     public function __construct(array $options = array(), $handler = null, MetadataBag $metaBag = null)
Chris@0:     {
Chris@0:         session_cache_limiter(''); // disable by default because it's managed by HeaderBag (if used)
Chris@0:         ini_set('session.use_cookies', 1);
Chris@0: 
Chris@0:         session_register_shutdown();
Chris@0: 
Chris@0:         $this->setMetadataBag($metaBag);
Chris@0:         $this->setOptions($options);
Chris@0:         $this->setSaveHandler($handler);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the save handler instance.
Chris@0:      *
Chris@0:      * @return AbstractProxy
Chris@0:      */
Chris@0:     public function getSaveHandler()
Chris@0:     {
Chris@0:         return $this->saveHandler;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function start()
Chris@0:     {
Chris@0:         if ($this->started) {
Chris@0:             return true;
Chris@0:         }
Chris@0: 
Chris@0:         if (\PHP_SESSION_ACTIVE === session_status()) {
Chris@0:             throw new \RuntimeException('Failed to start the session: already started by PHP.');
Chris@0:         }
Chris@0: 
Chris@0:         if (ini_get('session.use_cookies') && headers_sent($file, $line)) {
Chris@0:             throw new \RuntimeException(sprintf('Failed to start the session because headers have already been sent by "%s" at line %d.', $file, $line));
Chris@0:         }
Chris@0: 
Chris@0:         // ok to try and start the session
Chris@0:         if (!session_start()) {
Chris@0:             throw new \RuntimeException('Failed to start the session');
Chris@0:         }
Chris@0: 
Chris@0:         $this->loadSession();
Chris@0: 
Chris@0:         return true;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getId()
Chris@0:     {
Chris@0:         return $this->saveHandler->getId();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setId($id)
Chris@0:     {
Chris@0:         $this->saveHandler->setId($id);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getName()
Chris@0:     {
Chris@0:         return $this->saveHandler->getName();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setName($name)
Chris@0:     {
Chris@0:         $this->saveHandler->setName($name);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function regenerate($destroy = false, $lifetime = null)
Chris@0:     {
Chris@0:         // Cannot regenerate the session ID for non-active sessions.
Chris@0:         if (\PHP_SESSION_ACTIVE !== session_status()) {
Chris@0:             return false;
Chris@0:         }
Chris@0: 
Chris@0:         if (null !== $lifetime) {
Chris@0:             ini_set('session.cookie_lifetime', $lifetime);
Chris@0:         }
Chris@0: 
Chris@0:         if ($destroy) {
Chris@0:             $this->metadataBag->stampNew();
Chris@0:         }
Chris@0: 
Chris@0:         $isRegenerated = session_regenerate_id($destroy);
Chris@0: 
Chris@0:         // The reference to $_SESSION in session bags is lost in PHP7 and we need to re-create it.
Chris@0:         // @see https://bugs.php.net/bug.php?id=70013
Chris@0:         $this->loadSession();
Chris@0: 
Chris@0:         return $isRegenerated;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function save()
Chris@0:     {
Chris@0:         session_write_close();
Chris@0: 
Chris@0:         $this->closed = true;
Chris@0:         $this->started = false;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function clear()
Chris@0:     {
Chris@0:         // clear out the bags
Chris@0:         foreach ($this->bags as $bag) {
Chris@0:             $bag->clear();
Chris@0:         }
Chris@0: 
Chris@0:         // clear out the session
Chris@0:         $_SESSION = array();
Chris@0: 
Chris@0:         // reconnect the bags to the session
Chris@0:         $this->loadSession();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function registerBag(SessionBagInterface $bag)
Chris@0:     {
Chris@0:         if ($this->started) {
Chris@0:             throw new \LogicException('Cannot register a bag when the session is already started.');
Chris@0:         }
Chris@0: 
Chris@0:         $this->bags[$bag->getName()] = $bag;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getBag($name)
Chris@0:     {
Chris@0:         if (!isset($this->bags[$name])) {
Chris@0:             throw new \InvalidArgumentException(sprintf('The SessionBagInterface %s is not registered.', $name));
Chris@0:         }
Chris@0: 
Chris@0:         if ($this->saveHandler->isActive() && !$this->started) {
Chris@0:             $this->loadSession();
Chris@0:         } elseif (!$this->started) {
Chris@0:             $this->start();
Chris@0:         }
Chris@0: 
Chris@0:         return $this->bags[$name];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets the MetadataBag.
Chris@0:      *
Chris@0:      * @param MetadataBag $metaBag
Chris@0:      */
Chris@0:     public function setMetadataBag(MetadataBag $metaBag = null)
Chris@0:     {
Chris@0:         if (null === $metaBag) {
Chris@0:             $metaBag = new MetadataBag();
Chris@0:         }
Chris@0: 
Chris@0:         $this->metadataBag = $metaBag;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the MetadataBag.
Chris@0:      *
Chris@0:      * @return MetadataBag
Chris@0:      */
Chris@0:     public function getMetadataBag()
Chris@0:     {
Chris@0:         return $this->metadataBag;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function isStarted()
Chris@0:     {
Chris@0:         return $this->started;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Sets session.* ini variables.
Chris@0:      *
Chris@0:      * For convenience we omit 'session.' from the beginning of the keys.
Chris@0:      * Explicitly ignores other ini keys.
Chris@0:      *
Chris@0:      * @param array $options Session ini directives array(key => value)
Chris@0:      *
Chris@0:      * @see http://php.net/session.configuration
Chris@0:      */
Chris@0:     public function setOptions(array $options)
Chris@0:     {
Chris@0:         $validOptions = array_flip(array(
Chris@0:             'cache_limiter', 'cookie_domain', 'cookie_httponly',
Chris@0:             'cookie_lifetime', 'cookie_path', 'cookie_secure',
Chris@0:             'entropy_file', 'entropy_length', 'gc_divisor',
Chris@0:             'gc_maxlifetime', 'gc_probability', 'hash_bits_per_character',
Chris@0:             'hash_function', 'name', 'referer_check',
Chris@0:             'serialize_handler', 'use_strict_mode', 'use_cookies',
Chris@0:             'use_only_cookies', 'use_trans_sid', 'upload_progress.enabled',
Chris@0:             'upload_progress.cleanup', 'upload_progress.prefix', 'upload_progress.name',
Chris@0:             'upload_progress.freq', 'upload_progress.min-freq', 'url_rewriter.tags',
Chris@0:         ));
Chris@0: 
Chris@0:         foreach ($options as $key => $value) {
Chris@0:             if (isset($validOptions[$key])) {
Chris@0:                 ini_set('session.'.$key, $value);
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Registers session save handler as a PHP session handler.
Chris@0:      *
Chris@0:      * To use internal PHP session save handlers, override this method using ini_set with
Chris@0:      * session.save_handler and session.save_path e.g.
Chris@0:      *
Chris@0:      *     ini_set('session.save_handler', 'files');
Chris@0:      *     ini_set('session.save_path', '/tmp');
Chris@0:      *
Chris@0:      * or pass in a NativeSessionHandler instance which configures session.save_handler in the
Chris@0:      * constructor, for a template see NativeFileSessionHandler or use handlers in
Chris@0:      * composer package drak/native-session
Chris@0:      *
Chris@0:      * @see http://php.net/session-set-save-handler
Chris@0:      * @see http://php.net/sessionhandlerinterface
Chris@0:      * @see http://php.net/sessionhandler
Chris@0:      * @see http://github.com/drak/NativeSession
Chris@0:      *
Chris@0:      * @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $saveHandler
Chris@0:      *
Chris@0:      * @throws \InvalidArgumentException
Chris@0:      */
Chris@0:     public function setSaveHandler($saveHandler = null)
Chris@0:     {
Chris@0:         if (!$saveHandler instanceof AbstractProxy &&
Chris@0:             !$saveHandler instanceof NativeSessionHandler &&
Chris@0:             !$saveHandler instanceof \SessionHandlerInterface &&
Chris@0:             null !== $saveHandler) {
Chris@0:             throw new \InvalidArgumentException('Must be instance of AbstractProxy or NativeSessionHandler; implement \SessionHandlerInterface; or be null.');
Chris@0:         }
Chris@0: 
Chris@0:         // Wrap $saveHandler in proxy and prevent double wrapping of proxy
Chris@0:         if (!$saveHandler instanceof AbstractProxy && $saveHandler instanceof \SessionHandlerInterface) {
Chris@0:             $saveHandler = new SessionHandlerProxy($saveHandler);
Chris@0:         } elseif (!$saveHandler instanceof AbstractProxy) {
Chris@0:             $saveHandler = new SessionHandlerProxy(new \SessionHandler());
Chris@0:         }
Chris@0:         $this->saveHandler = $saveHandler;
Chris@0: 
Chris@0:         if ($this->saveHandler instanceof \SessionHandlerInterface) {
Chris@0:             session_set_save_handler($this->saveHandler, false);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Load the session with attributes.
Chris@0:      *
Chris@0:      * After starting the session, PHP retrieves the session from whatever handlers
Chris@0:      * are set to (either PHP's internal, or a custom save handler set with session_set_save_handler()).
Chris@0:      * PHP takes the return value from the read() handler, unserializes it
Chris@0:      * and populates $_SESSION with the result automatically.
Chris@0:      *
Chris@0:      * @param array|null $session
Chris@0:      */
Chris@0:     protected function loadSession(array &$session = null)
Chris@0:     {
Chris@0:         if (null === $session) {
Chris@0:             $session = &$_SESSION;
Chris@0:         }
Chris@0: 
Chris@0:         $bags = array_merge($this->bags, array($this->metadataBag));
Chris@0: 
Chris@0:         foreach ($bags as $bag) {
Chris@0:             $key = $bag->getStorageKey();
Chris@0:             $session[$key] = isset($session[$key]) ? $session[$key] : array();
Chris@0:             $bag->initialize($session[$key]);
Chris@0:         }
Chris@0: 
Chris@0:         $this->started = true;
Chris@0:         $this->closed = false;
Chris@0:     }
Chris@0: }