symfony · ghost · Dec 4, 2011 · Nov 2, 2011 · Nov 4, 2011 · Nov 22, 2011
diff --git a/CHANGELOG-2.1.md b/CHANGELOG-2.1.md
@@ -33,6 +33,11 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
  * [BC BREAK] assets_base_urls and base_urls merging strategy has changed
  * changed the default profiler storage to use the filesystem instead of SQLite
  * added support for placeholders in route defaults and requirements (replaced by the value set in the service container)
+ * [BC BREAK] changed `session.xml` service name `session.storage.native` to `session.storage.native_file`
+ * added new session storage drivers to session.xml: `session.storage.native_memcache`, `session.storage.native_memcached`,
+   `session.storage.native_sqlite`, `session.storage.null`, `session.storage.memcache`,
+   and `session.storage.memcached`.  Added `session.storage.functional_test.file` service for functional session testing.
+ * removed `session.storage.filesystem` service.
 
 ### SecurityBundle
 
@@ -143,6 +148,33 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
  * removed the ContentTypeMimeTypeGuesser class as it is deprecated and never used on PHP 5.3
  * added ResponseHeaderBag::makeDisposition() (implements RFC 6266)
  * made mimetype to extension conversion configurable
+ * [BC BREAK] Moved flash messages out of the `Session` class and into `FlashBagInterface`.
+   Flashes are now stored as a bucket of messages per `$type` so there can be multiple messages per type.
+   There are four interface constants for type, `FlashBagInterface::INFO`, `FlashBagInterface::NOTICE`,
+   `FlashBagInterface::WARNING` and `FlashBagInterface::ERROR`.
+ * Flash messages are expired when retrieved (with $clear = true) set.  This makes the implementation
+   more flexible and removed some dependencies in the Session management cycle.
+ * [BC BREAK] Removed the following methods from the Session class: `setFlashes()`
+   `setFlash()`, `hasFlash()`, `removeFlash()`, and `clearFlashes()`.
+ * [BC BREAK] Changed `getFlash($clear=false)` now returns flash messages for display, and added
+   `addFlash($message, $type)`  to add flash messages.
+   `getFlashes()` now returns the `FlashBagInterface` for which there which can be used for deeper
+   manipulation of the flash message collection.
+ * `Session` object takes two additional object in the constructor: `AttributeBagInterface` and
+   `FlashBagInterface` after the `SessionStorageInterface`.
+ * Added `AbstractSessionStorage` base class for session storage drivers.
+ * Added `SessionSaveHandler` interface which storage drivers should implement after inheriting from
+   `AbstractSessionStorage` when writing custom session save handlers.
+ * [BC BREAK] `SessionStorageInterface` methods removed: `write()`, `read()` and `remove()`.  Added
+   `getAttributes()`, `getFlashes()`.
+ * Moved attribute storage to `AttributeBagInterface`.
+ * Added `AttributeBag` to replicate attributes storage behaviour from 2.0.x
+ * Added `NamespacedAttributeBag` for namespace session attributes.
+ * Session now implements `SessionInterface` making implementation customizable and portable.
+ * [BC BREAK] Removed `NativeSessionStorage` and replaced with `NativeFileSessionStorage`
+ * Added session storage drivers for PHP native Memcache, Memcached and SQLite session save handlers.
+ * Added session storage drivers for custom Memcache, Memcached and Null session save handlers.
+ * Removed `FilesystemSessionStorage`, use `FunctionalTestFileSessionStorage` for functional testing instead.
 
 ### HttpKernel
 
@@ -169,7 +201,7 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
 
 ### Serializer
 
- * [BC BREAK] convert the `item` XML tag to an array 
+ * [BC BREAK] convert the `item` XML tag to an array
 
    ``` xml
    <?xml version="1.0"?>

diff --git a/UPGRADE-2.1.md b/UPGRADE-2.1.md
@@ -11,7 +11,7 @@ UPGRADE FROM 2.0 to 2.1
   and/or share a common base configuration (i.e. ``config.yml``), merging
   could yield a set of base URL's for multiple environments.
 
-* moved management of the locale from the Session class to the Request class
+* [HttpFoundation] - moved management of the locale from the Session class to the Request class
 
   Configuring the default locale:
 
@@ -40,3 +40,63 @@ UPGRADE FROM 2.0 to 2.1
 
   Before: $session->getLocale()
   After: $request->getLocale()
+
+* [HttpFoundation] Flash Messages.  Moved to own bucket and returns and array based on type.
+
+  Before (PHP):
+
+  <?php if ($view['session']->hasFlash('notice')): ?>
+      <div class="flash-notice">
+          <?php echo $view['session']->getFlash('notice') ?>
+      </div>
+  <?php endif; ?>
+
+  After (PHP):
+
+      <?php foreach ($view['session']->flashGet(Symfony\Component\HttpFoundation\FlashBag::NOTICE) as $notice): ?>
+          <div class="flash-notice">
+          <?php echo $notice; ?>
+      </div>
+  <?php endforeach; ?>
+
+.. note::
+
+    You can of course declare `<?php use Symfony\Component\HttpFoundation\FlashBag; ?>` at the beginning
+    of the PHP template so you can use the shortcut `FlashBag::NOTICE`.
+
+  Before (Twig):
+
+  {% if app.session.hasFlash('notice') %}
+      <div class="flash-notice">
+          {{ app.session.flash('notice') }}
+      </div>
+  {% endif %}
+
+  After (Twig):
+
+  {% for flashMessage in app.session.flashGet(constant(Symfony\Component\HttpFoundation\FlashBag::NOTICE)) %}
+      <div class="flash-notice">
+          {{ flashMessage }}
+      </div>
+  {% endforeach %}
+
+* [HttpFoundation] Session object now requires two additional constructor arguments but will default to
+                   sensible defaults for convenience.  The methods, `setFlashes()`, `setFlash()`, `hasFlash()`,
+                   `removeFlash()`, and `clearFlashes()` have all been removed from the `Session` object.
+                   You may use `addFlash()` to add flashes.  `getFlash()` now returns an array for display.
+                   `getFlashes()` returns the FlashBagInterface if you need to deeply manipulate the flash message
+                   container.
+
+* [HttpFoundation] Session storage drivers should inherit from
+                   `Symfony\Component\HttpFoundation\SessionStorage\AbstractSessionStorage`
+                   and no longer should implement `read()`, `write()`, `remove()` which were removed from the
+                   `SessionStorageInterface`.
+
+* [HttpFoundation] Any session storage drive that wants to use custom save handlers should
+                   implement `Symfony\Component\HttpFoundation\SessionStorage\SessionSaveHandlerInterface`
+
+* [FrameworkBundle] The service session.storage.native is now called `session.storage.native_file`
+
+* [FrameworkBundle] The service `session.storage.filesystem` is deprecated and should be replaced
+                    `session.storage.native_file`
+
diff --git a/src/Symfony/Bridge/Doctrine/HttpFoundation/DbalSessionStorage.php b/src/Symfony/Bridge/Doctrine/HttpFoundation/DbalSessionStorage.php
@@ -3,7 +3,10 @@
 namespace Symfony\Bridge\Doctrine\HttpFoundation;
 
 use Doctrine\DBAL\Platforms\MySqlPlatform;
-use Symfony\Component\HttpFoundation\SessionStorage\NativeSessionStorage;
+use Symfony\Component\HttpFoundation\AttributeBagInterface;
+use Symfony\Component\HttpFoundation\FlashBagInterface;
+use Symfony\Component\HttpFoundation\SessionStorage\AbstractSessionStorage;
+use Symfony\Component\HttpFoundation\SessionStorage\SessionSaveHandlerInterface;
 use Doctrine\DBAL\Driver\Connection;
 
 /**
@@ -12,39 +15,32 @@
  * @author Fabien Potencier <[email protected]>
  * @author Johannes M. Schmitt <[email protected]>
  */
-class DbalSessionStorage extends NativeSessionStorage
+class DbalSessionStorage extends AbstractSessionStorage implements SessionSaveHandlerInterface
 {
+    /**
+     * @var Connection
+     */
     private $con;
+
+    /**
+     * @var string
+     */
     private $tableName;
 
-    public function __construct(Connection $con, $tableName = 'sessions', array $options = array())
+    /**
+     *
+     * @param Connection            $con        An instance of Connection.
+     * @param string                $tableName  Table name.
+     * @param array                 $options    Session configuration options
+     * @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
+     * @param FlashBagInterface     $flashes    A FlashBagInterface instance (defaults null for default FlashBag)
+     */
+    public function __construct(Connection $con, $tableName = 'sessions', array $options = array(), AttributeBagInterface $attributes = null, FlashBagInterface $flashes = null)
     {
-        parent::__construct($options);
-
         $this->con = $con;
         $this->tableName = $tableName;
-    }
-
-    /**
-    * Starts the session.
-    */
-    public function start()
-    {
-        if (self::$sessionStarted) {
-            return;
-        }
 
-        // use this object as the session handler
-        session_set_save_handler(
-            array($this, 'sessionOpen'),
-            array($this, 'sessionClose'),
-            array($this, 'sessionRead'),
-            array($this, 'sessionWrite'),
-            array($this, 'sessionDestroy'),
-            array($this, 'sessionGC')
-        );
-
-        parent::start();
+        parent::__construct($attributes, $flashes, $options);
     }
 
     /**
@@ -102,7 +98,7 @@ public function sessionDestroy($id)
      *
      * @throws \RuntimeException If any old sessions cannot be cleaned
      */
-    public function sessionGC($lifetime)
+    public function sessionGc($lifetime)
     {
         try {
             $this->con->executeQuery("DELETE FROM {$this->tableName} WHERE sess_time < :time", array(

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -162,7 +162,7 @@ private function addSessionSection(ArrayNodeDefinition $rootNode)
                     ->canBeUnset()
                     ->children()
                         ->booleanNode('auto_start')->defaultFalse()->end()
-                        ->scalarNode('storage_id')->defaultValue('session.storage.native')->end()
+                        ->scalarNode('storage_id')->defaultValue('session.storage.native_file')->end()
                         ->scalarNode('name')->end()
                         ->scalarNode('lifetime')->end()
                         ->scalarNode('path')->end()

diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/TestSessionListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/TestSessionListener.php
@@ -69,10 +69,7 @@ public function onKernelResponse(FilterResponseEvent $event)
 
         if ($session = $event->getRequest()->getSession()) {
             $session->save();
-            $session->close();
-
             $params = session_get_cookie_params();
-
             $event->getResponse()->headers->setCookie(new Cookie(session_name(), session_id(), 0 === $params['lifetime'] ? 0 : time() + $params['lifetime'], $params['path'], $params['domain'], $params['secure'], $params['httponly']));
         }
     }

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml
@@ -6,8 +6,19 @@
 
     <parameters>
         <parameter key="session.class">Symfony\Component\HttpFoundation\Session</parameter>
-        <parameter key="session.storage.native.class">Symfony\Component\HttpFoundation\SessionStorage\NativeSessionStorage</parameter>
-        <parameter key="session.storage.filesystem.class">Symfony\Component\HttpFoundation\SessionStorage\FilesystemSessionStorage</parameter>
+        <parameter key="session.flashbag.class">Symfony\Component\HttpFoundation\FlashBag</parameter>
+        <parameter key="session.attribute_bag.class">Symfony\Component\HttpFoundation\AttributeBag</parameter>
+        <parameter key="session.storage.native_file.class">Symfony\Component\HttpFoundation\SessionStorage\NativeFileSessionStorage</parameter>
+        <parameter key="session.storage.null.class">Symfony\Component\HttpFoundation\SessionStorage\NullSessionStorage</parameter>
+        <parameter key="session.storage.native_memcache.class">Symfony\Component\HttpFoundation\SessionStorage\NativeMemcacheSessionStorage</parameter>
+        <parameter key="session.storage.native_memcached.class">Symfony\Component\HttpFoundation\SessionStorage\NativeMemcachedSessionStorage</parameter>
+        <parameter key="session.storage.native_sqlite.class">Symfony\Component\HttpFoundation\SessionStorage\NativeSqliteSessionStorage</parameter>
+        <parameter key="session.storage.memcache.class">Symfony\Component\HttpFoundation\SessionStorage\MemcacheSessionStorage</parameter>
+        <parameter key="session.storage.memcached.class">Symfony\Component\HttpFoundation\SessionStorage\MemcachedSessionStorage</parameter>
+        <parameter key="session.storage.functional_test.file.class">Symfony\Component\HttpFoundation\SessionStorage\FunctionalTestFileSessionStorage</parameter>
+        <parameter key="session.memcache.class">Memcache</parameter>
+        <parameter key="session.memcached.class">Memcached</parameter>
+
         <parameter key="session_listener.class">Symfony\Bundle\FrameworkBundle\EventListener\SessionListener</parameter>
     </parameters>
 
@@ -16,13 +27,65 @@
             <argument type="service" id="session.storage" />
         </service>
 
-        <service id="session.storage.native" class="%session.storage.native.class%" public="false">
-            <argument>%session.storage.options%</argument>
+        <service id="session.flash_bag" class="%session.flashbag.class%" public="false" />
+        <service id="session.attribute_bag" class="%session.attribute_bag.class%" public="false" />
+        <service id="session.memcache" class="%session.memcache.class%" public="false" />
+        <service id="session.memcached" class="%session.memcached.class%" public="false" />
+
+        <service id="session.storage.functional_test.file" class="%session.storage.functional_test.file.class%" public="false">
+            <argument>%kernel.cache_dir%/sessions</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
         </service>
 
-        <service id="session.storage.filesystem" class="%session.storage.filesystem.class%" public="false">
+        <service id="session.storage.native_file" class="%session.storage.native_file.class%" public="false">
             <argument>%kernel.cache_dir%/sessions</argument>
             <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
+        </service>
+
+        <service id="session.storage.native_memcache" class="%session.storage.native_memcache.class%" public="false">
+            <argument>tcp://127.0.0.1:11211?persistent=0</argument>
+            <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
+        </service>
+
+        <service id="session.storage.native_memcached" class="%session.storage.native_memcached.class%" public="false">
+            <argument>127.0.0.1:11211</argument>
+            <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
+        </service>
+
+        <service id="session.storage.memcache" class="%session.storage.memcache.class%" public="false">
+            <argument type="service" id="session.memcache" />
+            <argument>tcp://127.0.0.1:11211?persistent=0</argument>
+            <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
+        </service>
+
+        <service id="session.storage.memcached" class="%session.storage.memcached.class%" public="false">
+            <argument type="service" id="session.memcached" />
+            <argument>tcp://127.0.0.1:11211?persistent=0</argument>
+            <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
+        </service>
+
+        <service id="session.storage.native_sqlite" class="%session.storage.native_sqlite.class%" public="false">
+            <argument>%kernel.cache_dir%/sf2_sqlite_sess.db</argument>
+            <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
+        </service>
+
+        <service id="session.storage.null" class="%session.storage.null.class%" public="false">
+            <argument>%session.storage.options%</argument>
+            <argument type="service" id="session.attribute_bag" />
+            <argument type="service" id="session.flash_bag" />
         </service>
 
         <service id="session_listener" class="%session_listener.class%">

diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/SessionHelper.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/SessionHelper.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Templating\Helper\Helper;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\FlashBagInterface;
 
 /**
  * SessionHelper provides read-only access to the session attributes.
@@ -46,19 +47,19 @@ public function get($name, $default = null)
         return $this->session->get($name, $default);
     }
 
-    public function getFlash($name, $default = null)
+    public function getFlashes($type)
     {
-        return $this->session->getFlash($name, $default);
+        return $this->session->getFlashes()->get($type);
     }
 
-    public function getFlashes()
+    public function getAllFlashes()
     {
-        return $this->session->getFlashes();
+        return $this->session->getFlashes()->all();
     }
 
-    public function hasFlash($name)
+    public function hasFlashes($type)
     {
-        return $this->session->hasFlash($name);
+        return $this->session->getFlashes()->has($type);
     }
 
     /**

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php
@@ -20,7 +20,7 @@
     ),
     'session' => array(
         'auto_start'     => true,
-        'storage_id'     => 'session.storage.native',
+        'storage_id'     => 'session.storage.native_file',
         'name'           => '_SYMFONY',
         'lifetime'       => 86400,
         '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
@@ -12,7 +12,7 @@
         <framework:esi enabled="true" />
         <framework:profiler only-exceptions="true" />
         <framework:router resource="%kernel.root_dir%/config/routing.xml" type="xml" />
-        <framework:session auto-start="true" storage-id="session.storage.native" name="_SYMFONY" lifetime="86400" path="/" domain="example.com" secure="true" httponly="true" />
+        <framework:session auto-start="true" storage-id="session.storage.native_file" name="_SYMFONY" lifetime="86400" path="/" domain="example.com" secure="true" httponly="true" />
         <framework:templating assets-version="SomeVersionScheme" cache="/path/to/cache" >
             <framework:loader>loader.foo</framework:loader>
             <framework:loader>loader.bar</framework:loader>

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -14,7 +14,7 @@ framework:
         type:         xml
     session:
         auto_start:     true
-        storage_id:     session.storage.native
+        storage_id:     session.storage.native_file
         name:           _SYMFONY
         lifetime:       86400
         path:           /

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -78,7 +78,7 @@ public function testSession()
         $this->assertTrue($container->hasDefinition('session'), '->registerSessionConfiguration() loads session.xml');
         $this->assertEquals('fr', $container->getParameter('kernel.default_locale'));
         $this->assertTrue($container->getDefinition('session_listener')->getArgument(1));
-        $this->assertEquals('session.storage.native', (string) $container->getAlias('session.storage'));
+        $this->assertEquals('session.storage.native_file', (string) $container->getAlias('session.storage'));
 
         $options = $container->getParameter('session.storage.options');
         $this->assertEquals('_SYMFONY', $options['name']);