merged branch drak/start_on_demand (PR #7576)

This PR was merged into the master branch.

Discussion
----------

[2.3][Session] Give greater control over how and when session starts

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | na
| License       | MIT
| Doc PR        | symfony/symfony-docs#2475

Refs #6036

Gives control over how start on demand works: allowing to turn it on or off and to allow bag access when session is off.

Commits
-------

f431cb0 Fix tests
1f521d8 Coding standards
2583c26 [HttpFoundation][FrameworkBundle] Keep save auto_start behaviour as in 2.2 and make component values consistent with FrameworkBundle's configuration options.
ceaf69b [FrameworkBundle] Use more sophisticated validation and configuration.
af0a140 [FrameworkBundle] Add configuration to allow control over session start on demand.
8fc2397 [HttpFoundation] Give control over how session start on demand.

Author: fabpot

CHANGELOG.md

@@ -10,6 +10,8 @@ CHANGELOG
  * added `TimedPhpEngine`
  * added `--clean` option the the `translation:update` command
  * added `http_method_override` option
+ * 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
 -----

DependencyInjection/Configuration.php

@@ -184,6 +184,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()

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

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()

Resources/config/schema/symfony-1.0.xsd

@@ -77,6 +77,9 @@
     </xsd:complexType>
 
     <xsd:complexType name="session">
+        <xsd:attribute name="auto-start" type="xsd:boolean" />
+        <xsd:attribute name="on-demand-mode" type="xsd:string" />
+        <xsd:attribute name="mock-name" type="xsd:string" />
         <xsd:attribute name="storage-id" type="xsd:string" />
         <xsd:attribute name="handler-id" type="xsd:string" />
         <xsd:attribute name="name" type="xsd:string" />

Resources/config/session.xml

@@ -8,6 +8,7 @@
         <parameter key="session.class">Symfony\Component\HttpFoundation\Session\Session</parameter>
         <parameter key="session.flashbag.class">Symfony\Component\HttpFoundation\Session\Flash\FlashBag</parameter>
         <parameter key="session.attribute_bag.class">Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag</parameter>
+        <parameter key="session.metadata_bag.class">Symfony\Component\HttpFoundation\Session\Storage\MetadataBag</parameter>
         <parameter key="session.storage.native.class">Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage</parameter>
         <parameter key="session.storage.php_bridge.class">Symfony\Component\HttpFoundation\Session\Storage\PhpBridgeSessionStorage</parameter>
         <parameter key="session.storage.mock_file.class">Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage</parameter>
@@ -25,18 +26,24 @@
         <service id="session.storage.native" class="%session.storage.native.class%">
             <argument>%session.storage.options%</argument>
             <argument type="service" id="session.handler" />
+            <argument type="service" id="session.metadata_bag" />
+            <argument>%session.storage.on_demand_mode%</argument>
         </service>
 
         <service id="session.storage.php_bridge" class="%session.storage.php_bridge.class%">
             <argument type="service" id="session.handler" />
         </service>
 
         <service id="session.flash_bag" class="%session.flashbag.class%" public="false" />
+        <service id="session.metadata_bag" class="%session.metadata_bag.class%" public="false" />
 
         <service id="session.attribute_bag" class="%session.attribute_bag.class%" public="false" />
 
         <service id="session.storage.mock_file" class="%session.storage.mock_file.class%" public="false">
             <argument>%kernel.cache_dir%/sessions</argument>
+            <argument>%session.storage.mock_name%</argument>
+            <argument type="service" id="session.metadata_bag" />
+            <argument>%session.storage.on_demand_mode%</argument>
         </service>
 
         <service id="session.handler.native_file" class="%session.handler.native_file.class%" public="false">
@@ -46,6 +53,7 @@
         <service id="session_listener" class="%session_listener.class%">
             <tag name="kernel.event_subscriber" />
             <argument type="service" id="service_container" />
+            <argument>%session.auto_start%</argument>
         </service>
 
         <!-- for BC -->

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'     => '/',

Tests/DependencyInjection/Fixtures/xml/full.xml

@@ -12,7 +12,7 @@
         <framework:esi enabled="true" />
         <framework:profiler only-exceptions="true" enabled="false" />
         <framework:router resource="%kernel.root_dir%/config/routing.xml" type="xml" />
-        <framework:session gc-maxlifetime="90000" gc-probability="1" gc-divisor="108" storage-id="session.storage.native" handler-id="session.handler.native_file" name="_SYMFONY" cookie-lifetime="86400" cookie-path="/" cookie-domain="example.com" cookie-secure="true" cookie-httponly="true" save-path="/path/to/sessions" />
+        <framework:session gc-maxlifetime="90000" gc-probability="1" gc-divisor="108" storage-id="session.storage.native" handler-id="session.handler.native_file" name="_SYMFONY" cookie-lifetime="86400" cookie-path="/" cookie-domain="example.com" cookie-secure="true" cookie-httponly="true" save-path="/path/to/sessions" auto-start="true" on-demand-mode="on" />
         <framework:templating assets-version="SomeVersionScheme" cache="/path/to/cache" >
             <framework:loader>loader.foo</framework:loader>
             <framework:loader>loader.bar</framework:loader>

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:      /

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']);