From eaf3f75b31e6665285fa70da530168a09362d881 Mon Sep 17 00:00:00 2001 From: Drak Date: Sat, 20 Apr 2013 19:24:45 +0100 Subject: [PATCH 1/3] Revert "Revert "merged branch drak/start_on_demand (PR #7576)"" This reverts commit 5a3428dc7818195bf907639e26a4cf45340830b8. --- .../Bundle/FrameworkBundle/CHANGELOG.md | 2 ++ .../DependencyInjection/Configuration.php | 10 ++++++ .../FrameworkExtension.php | 9 ++++++ .../EventListener/SessionListener.php | 10 ++++-- .../Resources/config/schema/symfony-1.0.xsd | 3 ++ .../Resources/config/session.xml | 8 +++++ .../DependencyInjection/Fixtures/php/full.php | 2 ++ .../DependencyInjection/Fixtures/xml/full.xml | 2 +- .../DependencyInjection/Fixtures/yml/full.yml | 2 ++ .../FrameworkExtensionTest.php | 3 ++ .../Component/HttpFoundation/CHANGELOG.md | 1 + .../HttpFoundation/Session/Session.php | 2 +- .../Session/SessionBagInterface.php | 2 +- .../Session/SessionInterface.php | 16 +++++----- .../Handler/MemcacheSessionHandler.php | 2 +- .../Handler/MemcachedSessionHandler.php | 2 +- .../Storage/Handler/MongoDbSessionHandler.php | 4 +-- .../Handler/NativeFileSessionHandler.php | 6 ++-- .../Storage/Handler/PdoSessionHandler.php | 14 ++++---- .../Session/Storage/MetadataBag.php | 4 +-- .../Storage/MockArraySessionStorage.php | 17 +++++++--- .../Storage/MockFileSessionStorage.php | 18 ++++------- .../Session/Storage/NativeSessionStorage.php | 31 ++++++++++++------ .../Session/Storage/Proxy/AbstractProxy.php | 10 +++--- .../Session/Storage/Proxy/NativeProxy.php | 2 +- .../Storage/SessionStorageInterface.php | 32 ++++++++++++++----- .../Storage/MockArraySessionStorageTest.php | 30 ++++++++++++++++- .../Storage/MockFileSessionStorageTest.php | 32 +++++++++++++++++-- .../Storage/NativeSessionStorageTest.php | 29 +++++++++++++++++ 29 files changed, 235 insertions(+), 70 deletions(-) diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md index 48dd3ee5e8ead..a72c724bcd5af 100644 --- a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md +++ b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md @@ -13,6 +13,8 @@ CHANGELOG * added support for default templates per render tag * added FormHelper::form(), FormHelper::start() and FormHelper::end() * deprecated FormHelper::enctype() in favor of FormHelper::start() + * Reintroduce `auto_start` session config flag to instruct the `SessionListener` to manually start session + * Added session config option `on_demand_mode` to control session start on demand. 2.2.0 ----- diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php index d75107355a213..cd54ffddfda35 100644 --- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php +++ b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php @@ -198,6 +198,16 @@ private function addSessionSection(ArrayNodeDefinition $rootNode) ->info('session configuration') ->canBeUnset() ->children() + ->booleanNode('auto_start') + ->defaultFalse() + ->info('Flag for SessionListener to start session') + ->end() + ->enumNode('on_demand_mode') + ->values(array('off', 'on', 'off_lax')) + ->defaultValue('on') + ->info('Start session on demand: off, on, or off_lax') + ->end() + ->scalarNode('mock_name')->defaultValue('MOCKSESSID')->end() ->scalarNode('storage_id')->defaultValue('session.storage.native')->end() ->scalarNode('handler_id')->defaultValue('session.handler.native_file')->end() ->scalarNode('name')->end() diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php index 2848714cd952e..f65d5d87ba998 100644 --- a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php +++ b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php @@ -18,6 +18,7 @@ use Symfony\Component\Config\Resource\FileResource; use Symfony\Component\Config\Resource\DirectoryResource; use Symfony\Component\Finder\Finder; +use Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface; use Symfony\Component\HttpKernel\DependencyInjection\Extension; use Symfony\Component\Config\FileLocator; @@ -314,6 +315,14 @@ private function registerSessionConfiguration(array $config, ContainerBuilder $c $container->setParameter('session.storage.options', $options); + // this controls the SessionListener to start session + $container->setParameter('session.auto_start', $config['auto_start']); + + // this controls the session start on demand feature + $container->setParameter('session.storage.on_demand_mode', $config['on_demand_mode']); + + $container->setParameter('session.storage.mock_name', $config['mock_name']); + // session handler (the internal callback registered with PHP session management) if (null == $config['handler_id']) { // Set the handler class to be null diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php index 7b5ce51db997d..f594a85ddd70f 100644 --- a/src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php +++ b/src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php @@ -29,10 +29,12 @@ class SessionListener implements EventSubscriberInterface * @var ContainerInterface */ private $container; + private $autoStart; - public function __construct(ContainerInterface $container) + public function __construct(ContainerInterface $container, $autoStart = false) { $this->container = $container; + $this->autoStart = $autoStart; } public function onKernelRequest(GetResponseEvent $event) @@ -46,7 +48,11 @@ public function onKernelRequest(GetResponseEvent $event) return; } - $request->setSession($this->container->get('session')); + $request->setSession($session = $this->container->get('session')); + + if ($this->autoStart || $request->hasPreviousSession()) { + $session->start(); + } } public static function getSubscribedEvents() diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd index 675a24b2c620f..982991c17baf7 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd +++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd @@ -77,6 +77,9 @@ + + + diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml index de45365751be9..6e4d4876b8112 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml +++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml @@ -8,6 +8,7 @@ Symfony\Component\HttpFoundation\Session\Session Symfony\Component\HttpFoundation\Session\Flash\FlashBag Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag + Symfony\Component\HttpFoundation\Session\Storage\MetadataBag Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage Symfony\Component\HttpFoundation\Session\Storage\PhpBridgeSessionStorage Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage @@ -25,6 +26,8 @@ %session.storage.options% + + %session.storage.on_demand_mode% @@ -32,11 +35,15 @@ + %kernel.cache_dir%/sessions + %session.storage.mock_name% + + %session.storage.on_demand_mode% @@ -46,6 +53,7 @@ + %session.auto_start% diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php index c4eff9349228e..105e89dc997cc 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php @@ -24,6 +24,8 @@ 'session' => array( 'storage_id' => 'session.storage.native', 'handler_id' => 'session.handler.native_file', + 'auto_start' => true, + 'on_demand_mode' => 'on', 'name' => '_SYMFONY', 'cookie_lifetime' => 86400, 'cookie_path' => '/', diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml index 8fd3e9b6528a0..17eb5462a59a9 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml @@ -12,7 +12,7 @@ - + loader.foo loader.bar diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml index d013063916c38..7235b47167cb0 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml @@ -18,6 +18,8 @@ framework: session: storage_id: session.storage.native handler_id: session.handler.native_file + auto_start: true + on_demand_mode: on name: _SYMFONY cookie_lifetime: 86400 cookie_path: / diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php index 205d323d58199..7f331d43e4ca7 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php @@ -97,6 +97,9 @@ public function testSession() $this->assertEquals('session.storage.native', (string) $container->getAlias('session.storage')); $this->assertEquals('session.handler.native_file', (string) $container->getAlias('session.handler')); + $this->assertTrue($container->getParameter('session.auto_start')); + $this->assertEquals($container->getParameter('session.storage.on_demand_mode'), 'on'); + $options = $container->getParameter('session.storage.options'); $this->assertEquals('_SYMFONY', $options['name']); $this->assertEquals(86400, $options['cookie_lifetime']); diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md index 24a55da766969..fc4686c9f64f7 100644 --- a/src/Symfony/Component/HttpFoundation/CHANGELOG.md +++ b/src/Symfony/Component/HttpFoundation/CHANGELOG.md @@ -6,6 +6,7 @@ CHANGELOG * added support for ranges of IPs in trusted proxies * `UploadedFile::isValid` now returns false if the file was not uploaded via HTTP (in a non-test mode) + * added control for session start on demand. 2.2.0 ----- diff --git a/src/Symfony/Component/HttpFoundation/Session/Session.php b/src/Symfony/Component/HttpFoundation/Session/Session.php index 15df09770994e..f644e02330f2c 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Session.php +++ b/src/Symfony/Component/HttpFoundation/Session/Session.php @@ -49,7 +49,7 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable /** * Constructor. * - * @param SessionStorageInterface $storage A SessionStorageInterface instance. + * @param SessionStorageInterface $storage A SessionStorageInterface instance * @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag) * @param FlashBagInterface $flashes A FlashBagInterface instance (defaults null for default FlashBag) */ diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionBagInterface.php b/src/Symfony/Component/HttpFoundation/Session/SessionBagInterface.php index f8d3d32712294..7937e1e80c322 100644 --- a/src/Symfony/Component/HttpFoundation/Session/SessionBagInterface.php +++ b/src/Symfony/Component/HttpFoundation/Session/SessionBagInterface.php @@ -42,7 +42,7 @@ public function getStorageKey(); /** * Clears out data from bag. * - * @return mixed Whatever data was contained. + * @return mixed Whatever data was contained */ public function clear(); } diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php b/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php index a94fad00d6f0f..b0990272de6c5 100644 --- a/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php +++ b/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php @@ -23,9 +23,9 @@ interface SessionInterface /** * Starts the session storage. * - * @return Boolean True if session started. + * @return Boolean True if session started * - * @throws \RuntimeException If session fails to start. + * @throws \RuntimeException If session fails to start * * @api */ @@ -34,7 +34,7 @@ public function start(); /** * Returns the session ID. * - * @return string The session ID. + * @return string The session ID * * @api */ @@ -52,7 +52,7 @@ public function setId($id); /** * Returns the session name. * - * @return mixed The session name. + * @return mixed The session name * * @api */ @@ -76,9 +76,9 @@ public function setName($name); * @param integer $lifetime Sets the cookie lifetime for the session cookie. A null value * will leave the system settings unchanged, 0 sets the cookie * to expire with browser session. Time is in seconds, and is - * not a Unix timestamp. + * not a Unix timestamp * - * @return Boolean True if session invalidated, false if error. + * @return Boolean True if session invalidated, false if error * * @api */ @@ -92,9 +92,9 @@ public function invalidate($lifetime = null); * @param integer $lifetime Sets the cookie lifetime for the session cookie. A null value * will leave the system settings unchanged, 0 sets the cookie * to expire with browser session. Time is in seconds, and is - * not a Unix timestamp. + * not a Unix timestamp * - * @return Boolean True if session migrated, false if error. + * @return Boolean True if session migrated, false if error * * @api */ diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcacheSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcacheSessionHandler.php index 4a5e63989a463..57cadf8f831e3 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcacheSessionHandler.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcacheSessionHandler.php @@ -29,7 +29,7 @@ class MemcacheSessionHandler implements \SessionHandlerInterface private $ttl; /** - * @var string Key prefix for shared environments. + * @var string Key prefix for shared environments */ private $prefix; diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php index b3ca0bd3cdcf9..316f7fcd8ff41 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MemcachedSessionHandler.php @@ -34,7 +34,7 @@ class MemcachedSessionHandler implements \SessionHandlerInterface private $ttl; /** - * @var string Key prefix for shared environments. + * @var string Key prefix for shared environments */ private $prefix; diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php index 69ebae9542cc3..50f92bcb644f1 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php @@ -52,11 +52,11 @@ class MongoDbSessionHandler implements \SessionHandlerInterface public function __construct($mongo, array $options) { if (!($mongo instanceof \MongoClient || $mongo instanceof \Mongo)) { - throw new \InvalidArgumentException('MongoClient or Mongo instance required'); + throw new \InvalidArgumentException('MongoClient or Mongo instance required.'); } if (!isset($options['database']) || !isset($options['collection'])) { - throw new \InvalidArgumentException('You must provide the "database" and "collection" option for MongoDBSessionHandler'); + throw new \InvalidArgumentException('You must provide the "database" and "collection" option for MongoDBSessionHandler.'); } $this->mongo = $mongo; diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NativeFileSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NativeFileSessionHandler.php index f39235cbfb6a5..30993680fe430 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NativeFileSessionHandler.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NativeFileSessionHandler.php @@ -24,10 +24,10 @@ class NativeFileSessionHandler extends NativeSessionHandler * Constructor. * * @param string $savePath Path of directory to save session files. - * Default null will leave setting as defined by PHP. + * Default null will leave setting as defined by PHP * '/path', 'N;/path', or 'N;octal-mode;/path * - * @see http://php.net/session.configuration.php#ini.session.save-path for further details. + * @see http://php.net/session.configuration.php#ini.session.save-path for further details * * @throws \InvalidArgumentException On invalid $savePath */ @@ -41,7 +41,7 @@ public function __construct($savePath = null) if ($count = substr_count($savePath, ';')) { if ($count > 2) { - throw new \InvalidArgumentException(sprintf('Invalid argument $savePath \'%s\'', $savePath)); + throw new \InvalidArgumentException(sprintf('Invalid argument $savePath \'%s\'.', $savePath)); } // characters after last ';' are the path diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php index 487dbc41e50e6..d88e41b5c8e90 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/PdoSessionHandler.php @@ -20,12 +20,12 @@ class PdoSessionHandler implements \SessionHandlerInterface { /** - * @var \PDO PDO instance. + * @var \PDO PDO instance */ private $pdo; /** - * @var array Database options. + * @var array Database options */ private $dbOptions; @@ -90,7 +90,7 @@ public function destroy($id) $stmt->bindParam(':id', $id, \PDO::PARAM_STR); $stmt->execute(); } catch (\PDOException $e) { - throw new \RuntimeException(sprintf('PDOException was thrown when trying to manipulate session data: %s', $e->getMessage()), 0, $e); + throw new \RuntimeException(sprintf('PDOException was thrown when trying to manipulate session data: %s.', $e->getMessage()), 0, $e); } return true; @@ -113,7 +113,7 @@ public function gc($lifetime) $stmt->bindValue(':time', time() - $lifetime, \PDO::PARAM_INT); $stmt->execute(); } catch (\PDOException $e) { - throw new \RuntimeException(sprintf('PDOException was thrown when trying to manipulate session data: %s', $e->getMessage()), 0, $e); + throw new \RuntimeException(sprintf('PDOException was thrown when trying to manipulate session data: %s.', $e->getMessage()), 0, $e); } return true; @@ -149,7 +149,7 @@ public function read($id) return ''; } catch (\PDOException $e) { - throw new \RuntimeException(sprintf('PDOException was thrown when trying to read the session data: %s', $e->getMessage()), 0, $e); + throw new \RuntimeException(sprintf('PDOException was thrown when trying to read the session data: %s.', $e->getMessage()), 0, $e); } } @@ -204,7 +204,7 @@ public function write($id, $data) } } } catch (\PDOException $e) { - throw new \RuntimeException(sprintf('PDOException was thrown when trying to write the session data: %s', $e->getMessage()), 0, $e); + throw new \RuntimeException(sprintf('PDOException was thrown when trying to write the session data: %s.', $e->getMessage()), 0, $e); } return true; @@ -216,7 +216,7 @@ public function write($id, $data) * @param string $id * @param string $data * - * @return boolean True. + * @return boolean True */ private function createNewSession($id, $data = '') { diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.php b/src/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.php index 892d004b5d611..7465d03dad571 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.php @@ -51,7 +51,7 @@ class MetadataBag implements SessionBagInterface /** * Constructor. * - * @param string $storageKey The key used to store bag in the session. + * @param string $storageKey The key used to store bag in the session */ public function __construct($storageKey = '_sf2_meta') { @@ -90,7 +90,7 @@ public function getLifetime() * @param integer $lifetime Sets the cookie lifetime for the session cookie. A null value * will leave the system settings unchanged, 0 sets the cookie * to expire with browser session. Time is in seconds, and is - * not a Unix timestamp. + * not a Unix timestamp */ public function stampNew($lifetime = null) { diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php index a1fcf539f8fda..02644758ca3c9 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php @@ -63,16 +63,23 @@ class MockArraySessionStorage implements SessionStorageInterface */ protected $bags; + /** + * @var Boolean + */ + protected $mode; + /** * Constructor. * * @param string $name Session name - * @param MetadataBag $metaBag MetadataBag instance. + * @param MetadataBag $metaBag MetadataBag instance + * @param integer $mode Session on demand mode */ - public function __construct($name = 'MOCKSESSID', MetadataBag $metaBag = null) + public function __construct($name = 'MOCKSESSID', MetadataBag $metaBag = null, $mode = self::START_ON_DEMAND) { $this->name = $name; $this->setMetadataBag($metaBag); + $this->mode = $mode; } /** @@ -160,7 +167,7 @@ public function setName($name) public function save() { if (!$this->started || $this->closed) { - throw new \RuntimeException("Trying to save a session that was not started yet or was already closed"); + throw new \RuntimeException("Trying to save a session that was not started yet or was already closed."); } // nothing to do since we don't persist the session data $this->closed = false; @@ -200,8 +207,10 @@ public function getBag($name) throw new \InvalidArgumentException(sprintf('The SessionBagInterface %s is not registered.', $name)); } - if (!$this->started) { + if (!$this->started && self::START_ON_DEMAND === $this->mode) { $this->start(); + } elseif (!$this->started && self::NO_START_ON_DEMAND_STRICT === $this->mode) { + throw new \RuntimeException('Cannot access session bags because the session has not been started.'); } return $this->bags[$name]; diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/MockFileSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/MockFileSessionStorage.php index 280630914a6ce..df08e54dd94d8 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/MockFileSessionStorage.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/MockFileSessionStorage.php @@ -29,19 +29,15 @@ class MockFileSessionStorage extends MockArraySessionStorage */ private $savePath; - /** - * @var array - */ - private $sessionData; - /** * Constructor. * - * @param string $savePath Path of directory to save session files. - * @param string $name Session name. - * @param MetadataBag $metaBag MetadataBag instance. + * @param string $savePath Path of directory to save session files + * @param string $name Session name + * @param MetadataBag $metaBag MetadataBag instance + * @param integer $mode Start on demand mode */ - public function __construct($savePath = null, $name = 'MOCKSESSID', MetadataBag $metaBag = null) + public function __construct($savePath = null, $name = 'MOCKSESSID', MetadataBag $metaBag = null, $mode = self::START_ON_DEMAND) { if (null === $savePath) { $savePath = sys_get_temp_dir(); @@ -53,7 +49,7 @@ public function __construct($savePath = null, $name = 'MOCKSESSID', MetadataBag $this->savePath = $savePath; - parent::__construct($name, $metaBag); + parent::__construct($name, $metaBag, $mode); } /** @@ -98,7 +94,7 @@ public function regenerate($destroy = false, $lifetime = null) public function save() { if (!$this->started) { - throw new \RuntimeException("Trying to save a session that was not started yet or was already closed"); + throw new \RuntimeException("Trying to save a session that was not started yet or was already closed."); } file_put_contents($this->getFilePath(), serialize($this->data)); diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php index 41c9412d0e27e..4de340ae831fb 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php @@ -52,6 +52,16 @@ class NativeSessionStorage implements SessionStorageInterface */ protected $metadataBag; + /** + * @var Boolean + */ + protected $mode; + + /** + * @var Boolean + */ + protected $emulatePhp; + /** * Constructor. * @@ -59,8 +69,9 @@ class NativeSessionStorage implements SessionStorageInterface * want to override this constructor entirely. * * List of options for $options array with their defaults. + * * @see http://php.net/session.configuration for options - * but we omit 'session.' from the beginning of the keys for convenience. + * but we omit 'session.' from the beginning of the keys for convenience. * * ("auto_start", is not supported as it tells PHP to start a session before * PHP starts to execute user-land code. Setting during runtime has no effect). @@ -92,11 +103,12 @@ class NativeSessionStorage implements SessionStorageInterface * upload_progress.min-freq, "1" * url_rewriter.tags, "a=href,area=href,frame=src,form=,fieldset=" * - * @param array $options Session configuration options. + * @param array $options Session configuration options * @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler - * @param MetadataBag $metaBag MetadataBag. + * @param MetadataBag $metaBag MetadataBag + * @param integer $mode Start on demand mode */ - public function __construct(array $options = array(), $handler = null, MetadataBag $metaBag = null) + public function __construct(array $options = array(), $handler = null, MetadataBag $metaBag = null, $mode = self::START_ON_DEMAND) { ini_set('session.cache_limiter', ''); // disable by default because it's managed by HeaderBag (if used) ini_set('session.use_cookies', 1); @@ -110,6 +122,7 @@ public function __construct(array $options = array(), $handler = null, MetadataB $this->setMetadataBag($metaBag); $this->setOptions($options); $this->setSaveHandler($handler); + $this->mode = $mode; } /** @@ -146,7 +159,7 @@ public function start() // ok to try and start the session if (!session_start()) { - throw new \RuntimeException('Failed to start the session'); + throw new \RuntimeException('Failed to start the session.'); } $this->loadSession(); @@ -259,10 +272,10 @@ public function getBag($name) throw new \InvalidArgumentException(sprintf('The SessionBagInterface %s is not registered.', $name)); } - if ($this->saveHandler->isActive() && !$this->started) { - $this->loadSession(); - } elseif (!$this->started) { + if (!$this->started && self::START_ON_DEMAND === $this->mode) { $this->start(); + } elseif (!$this->started && self::NO_START_ON_DEMAND_STRICT === $this->mode) { + throw new \RuntimeException('Cannot access session bags because the session has not been started.'); } return $this->bags[$name]; @@ -306,7 +319,7 @@ public function isStarted() * For convenience we omit 'session.' from the beginning of the keys. * Explicitly ignores other ini keys. * - * @param array $options Session ini directives array(key => value). + * @param array $options Session ini directives array(key => value) * * @see http://php.net/session.configuration */ diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/AbstractProxy.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/AbstractProxy.php index ee6eb897287c9..17f1085476f75 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/AbstractProxy.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/AbstractProxy.php @@ -36,7 +36,7 @@ abstract class AbstractProxy protected $saveHandlerName; /** - * Gets the session.save_handler name. + * Gets the session.save_handler name * * @return string */ @@ -46,7 +46,7 @@ public function getSaveHandlerName() } /** - * Is this proxy handler and instance of \SessionHandlerInterface. + * Is this proxy handler and instance of \SessionHandlerInterface * * @return boolean */ @@ -56,7 +56,7 @@ public function isSessionHandlerInterface() } /** - * Returns true if this handler wraps an internal PHP session save handler using \SessionHandler. + * Returns true if this handler wraps an internal PHP session save handler using \SessionHandler * * @return Boolean */ @@ -120,7 +120,7 @@ public function getId() public function setId($id) { if ($this->isActive()) { - throw new \LogicException('Cannot change the ID of an active session'); + throw new \LogicException('Cannot change the ID of an active session.'); } session_id($id); @@ -146,7 +146,7 @@ public function getName() public function setName($name) { if ($this->isActive()) { - throw new \LogicException('Cannot change the name of an active session'); + throw new \LogicException('Cannot change the name of an active session.'); } session_name($name); diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/NativeProxy.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/NativeProxy.php index 23eebb3281ae8..5cdbd420c8e96 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/NativeProxy.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/NativeProxy.php @@ -32,7 +32,7 @@ public function __construct() /** * Returns true if this handler wraps an internal PHP session save handler using \SessionHandler. * - * @return Boolean False. + * @return Boolean False */ public function isWrapper() { diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.php b/src/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.php index 711eaa29a3125..691c27933a803 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/SessionStorageInterface.php @@ -24,12 +24,28 @@ */ interface SessionStorageInterface { + /** + * Do not start session on demand and throw exception if attempt + * is make to read or write bag data. + */ + const NO_START_ON_DEMAND_STRICT = 'off'; + + /** + * Start the session on demand when accessing bag data. + */ + const START_ON_DEMAND = 'on'; + + /** + * Do not start session on demand but allow access to session bags. + */ + const NO_START_ON_DEMAND_LAX = 'off_lax'; + /** * Starts the session. * - * @throws \RuntimeException If something goes wrong starting the session. + * @throws \RuntimeException If something goes wrong starting the session * - * @return boolean True if started. + * @return boolean True if started * * @api */ @@ -38,14 +54,14 @@ public function start(); /** * Checks if the session is started. * - * @return boolean True if started, false otherwise. + * @return boolean True if started, false otherwise */ public function isStarted(); /** * Returns the session ID * - * @return string The session ID or empty. + * @return string The session ID or empty * * @api */ @@ -63,7 +79,7 @@ public function setId($id); /** * Returns the session name * - * @return mixed The session name. + * @return mixed The session name * * @api */ @@ -89,11 +105,11 @@ public function setName($name); * Note regenerate+destroy should not clear the session data in memory * only delete the session data from persistent storage. * - * @param Boolean $destroy Destroy session when regenerating? + * @param Boolean $destroy Flag true to destroy session when regenerating * @param integer $lifetime Sets the cookie lifetime for the session cookie. A null value * will leave the system settings unchanged, 0 sets the cookie * to expire with browser session. Time is in seconds, and is - * not a Unix timestamp. + * not a Unix timestamp * * @return Boolean True if session regenerated, false if error * @@ -112,7 +128,7 @@ public function regenerate($destroy = false, $lifetime = null); * it should actually persist the session data if required. * * @throws \RuntimeException If the session is saved without being started, or if the session - * is already closed. + * is already closed */ public function save(); diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockArraySessionStorageTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockArraySessionStorageTest.php index 2a6f6bb7e8fe5..ebe18aecb5b2f 100644 --- a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockArraySessionStorageTest.php +++ b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockArraySessionStorageTest.php @@ -97,10 +97,38 @@ public function testGetId() } /** - * @expectedException RuntimeException + * @expectedException \RuntimeException */ public function testUnstartedSave() { $this->storage->save(); } + + /** + * @expectedException \RuntimeException + */ + public function testStartOnDemandException() + { + $storage = new MockArraySessionStorage('MOCKSESSID', null, MockArraySessionStorage::NO_START_ON_DEMAND_STRICT); + $storage->registerBag(new AttributeBag); + $this->assertFalse($storage->isStarted()); + $storage->getBag('attributes'); + } + + public function testStartOnDemandDefaults() + { + $storage = new MockArraySessionStorage('MOCKSESSID'); + $storage->registerBag(new AttributeBag); + $storage->getBag('attributes'); + $this->assertTrue($storage->isStarted()); + } + + public function testNoStartOnDemandLax() + { + $storage = new MockArraySessionStorage('MOCKSESSID', null, MockArraySessionStorage::NO_START_ON_DEMAND_LAX); + $storage->registerBag($bag = new AttributeBag); + $bag->set('foo', 'bar'); + $storage->getBag('attributes'); + $this->assertEquals(array('foo' => 'bar'), $storage->getBag('attributes')->all()); + } } diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockFileSessionStorageTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockFileSessionStorageTest.php index d42c62a25ca07..501d12ce23a11 100644 --- a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockFileSessionStorageTest.php +++ b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/MockFileSessionStorageTest.php @@ -28,7 +28,7 @@ class MockFileSessionStorageTest extends \PHPUnit_Framework_TestCase private $sessionDir; /** - * @var FileMockSessionStorage + * @var MockFileSessionStorage */ protected $storage; @@ -107,7 +107,7 @@ public function testMultipleInstances() } /** - * @expectedException RuntimeException + * @expectedException \RuntimeException */ public function testSaveWithoutStart() { @@ -123,4 +123,32 @@ private function getStorage() return $storage; } + + /** + * @expectedException \RuntimeException + */ + public function testStartOnDemandException() + { + $storage = new MockFileSessionStorage($this->sessionDir, 'MOCKSESSID', null, MockFileSessionStorage::NO_START_ON_DEMAND_STRICT); + $storage->registerBag(new AttributeBag); + $this->assertFalse($storage->isStarted()); + $storage->getBag('attributes'); + } + + public function testStartOnDemandDefaults() + { + $storage = new MockFileSessionStorage($this->sessionDir, 'MOCKSESSID'); + $storage->registerBag(new AttributeBag); + $storage->getBag('attributes'); + $this->assertTrue($storage->isStarted()); + } + + public function testNoStartOnDemandLax() + { + $storage = new MockFileSessionStorage($this->sessionDir, 'MOCKSESSID', null, MockFileSessionStorage::NO_START_ON_DEMAND_LAX); + $storage->registerBag($bag = new AttributeBag); + $bag->set('foo', 'bar'); + $storage->getBag('attributes'); + $this->assertEquals(array('foo' => 'bar'), $storage->getBag('attributes')->all()); + } } diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/NativeSessionStorageTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/NativeSessionStorageTest.php index bf515c79a6265..742f31f978a57 100644 --- a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/NativeSessionStorageTest.php +++ b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/NativeSessionStorageTest.php @@ -20,6 +20,7 @@ use Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy; use Symfony\Component\HttpFoundation\Session\Storage\Proxy\NativeProxy; use Symfony\Component\HttpFoundation\Session\Storage\Proxy\SessionHandlerProxy; +use Symfony\Component\HttpFoundation\Tests\Session\Storage\Handler\NativeSessionHandlerTest; /** * Test class for NativeSessionStorage. @@ -279,4 +280,32 @@ public function destroy($id) public function gc($maxlifetime) { } + + /** + * @expectedException \RuntimeException + */ + public function testStartOnDemandException() + { + $storage = new NativeSessionStorage(array(), null, null, NativeSessionStorage::NO_START_ON_DEMAND_STRICT); + $storage->registerBag(new AttributeBag); + $this->assertFalse($storage->isStarted()); + $storage->getBag('attributes'); + } + + public function testStartOnDemandDefaults() + { + $storage = new NativeSessionStorage(); + $storage->registerBag(new AttributeBag); + $storage->getBag('attributes'); + $this->assertTrue($storage->isStarted()); + } + + public function testNoStartOnDemandLax() + { + $storage = new NativeSessionStorage(array(), null, null, NativeSessionStorage::NO_START_ON_DEMAND_LAX); + $storage->registerBag($bag = new AttributeBag); + $bag->set('foo', 'bar'); + $storage->getBag('attributes'); + $this->assertEquals(array('foo' => 'bar'), $storage->getBag('attributes')->all()); + } } From 11cbffc874d02b34733ba4d78a4ef18e8f3d02a8 Mon Sep 17 00:00:00 2001 From: Drak Date: Fri, 26 Apr 2013 19:15:42 +0100 Subject: [PATCH 2/3] Remove unused property. --- .../HttpFoundation/Session/Storage/NativeSessionStorage.php | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php index 4de340ae831fb..d65c9f290e519 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php @@ -57,11 +57,6 @@ class NativeSessionStorage implements SessionStorageInterface */ protected $mode; - /** - * @var Boolean - */ - protected $emulatePhp; - /** * Constructor. * From 5cbdc873086646176eb63f5bf8bee302882645d5 Mon Sep 17 00:00:00 2001 From: Drak Date: Fri, 26 Apr 2013 19:27:30 +0100 Subject: [PATCH 3/3] Update PhpBridgeSessionStorage --- .../Session/Storage/PhpBridgeSessionStorage.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/PhpBridgeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/PhpBridgeSessionStorage.php index 0f0020397ad55..421600d62ebf5 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Storage/PhpBridgeSessionStorage.php +++ b/src/Symfony/Component/HttpFoundation/Session/Storage/PhpBridgeSessionStorage.php @@ -27,11 +27,13 @@ class PhpBridgeSessionStorage extends NativeSessionStorage * * @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler * @param MetadataBag $metaBag MetadataBag + * @param string $mode */ - public function __construct($handler = null, MetadataBag $metaBag = null) + public function __construct($handler = null, MetadataBag $metaBag = null, $mode = self::START_ON_DEMAND) { $this->setMetadataBag($metaBag); $this->setSaveHandler($handler); + $this->mode = $mode; } /**