[HttpFoundation][FrameworkBundle] Separate out mock session storage a…

…nd stop polluting global namespace. This makes mock sessions truly mock and not to interfere with global namespace. Add getters and setters for session name and ID.
symfony · fabpot · Mar 15, 2012 · Mar 3, 2012 · Mar 3, 2012 · Mar 3, 2012
commit b12ece0ff715a423e0f293f2648f3aa4bc55e445
diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/SessionListener.php
@@ -28,7 +28,14 @@
  */
 class SessionListener implements EventSubscriberInterface
 {
+    /**
+     * @var ContainerInterface
+     */
     private $container;
+
+    /**
+     * @var boolean
+     */
     private $autoStart;
 
     public function __construct(ContainerInterface $container, $autoStart = false)

diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/TestSessionListener.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/TestSessionListener.php
@@ -43,15 +43,16 @@ public function onKernelRequest(GetResponseEvent $event)
         }
 
         // bootstrap the session
-        if ($this->container->has('session')) {
-            $this->container->get('session');
+        if (!$this->container->has('session')) {
+            return;
         }
 
+        $session = $this->container->get('session');
         $cookies = $event->getRequest()->cookies;
-        if ($cookies->has(session_name())) {
-            session_id($cookies->get(session_name()));
+        if ($cookies->has($session->getName())) {
+            $session->setId($cookies->get($session->getName()));
         } else {
-            session_id('');
+            $session->setId('');
         }
     }
 
@@ -72,7 +73,7 @@ public function onKernelResponse(FilterResponseEvent $event)
 
             $params = session_get_cookie_params();
 
-            $event->getResponse()->headers->setCookie(new Cookie(session_name(), $session->getId(), 0 === $params['lifetime'] ? 0 : time() + $params['lifetime'], $params['path'], $params['domain'], $params['secure'], $params['httponly']));
+            $event->getResponse()->headers->setCookie(new Cookie($session->getName(), $session->getId(), 0 === $params['lifetime'] ? 0 : time() + $params['lifetime'], $params['path'], $params['domain'], $params['secure'], $params['httponly']));
         }
     }
 

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/EventListener/TestSessionListenerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/EventListener/TestSessionListenerTest.php
@@ -94,8 +94,13 @@ private function sessionMustBeSaved()
 
     private function getSession()
     {
-        return $this->getMockBuilder('Symfony\Component\HttpFoundation\Session\Session')
+        $mock = $this->getMockBuilder('Symfony\Component\HttpFoundation\Session\Session')
             ->disableOriginalConstructor()
             ->getMock();
+
+        // set return value for getName()
+        $mock->expects($this->any())->method('getName')->will($this->returnValue('MOCKSESSID'));
+
+        return $mock;
     }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -496,7 +496,8 @@ public function getSession()
     public function hasPreviousSession()
     {
         // the check for $this->session avoids malicious users trying to fake a session cookie with proper name
-        return $this->cookies->has(session_name()) && null !== $this->session;
+        $sessionName = $this->hasSession() ? $this->session->getName() : null;
+        return $this->cookies->has($sessionName) && $this->hasSession();
     }
 
     /**

diff --git a/src/Symfony/Component/HttpFoundation/Session/Session.php b/src/Symfony/Component/HttpFoundation/Session/Session.php
@@ -17,6 +17,7 @@
 use Symfony\Component\HttpFoundation\Session\Flash\FlashBag;
 use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
 use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
+use Symfony\Component\HttpFoundation\Session\Storage\SessionStorage;

 /**
  * Session.
@@ -140,19 +141,39 @@ public function save()
     }
 
     /**
-     * Returns the session ID
-     *
-     * @return mixed The session ID
-     *
-     * @api
+     * {@inheritdoc}
      */
     public function getId()
     {
         return $this->storage->getId();
     }
 
     /**
-     * Registers a SessionBagInterface with the sessio.
+     * {@inheritdoc}
+     */
+    public function setId($id)
+    {
+        $this->storage->setId($id);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return $this->storage->getName();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setName($name)
+    {
+        $this->storage->setName($name);
+    }
+
+    /**
+     * Registers a SessionBagInterface with the session.
      *
      * @param SessionBagInterface $bag
      */

diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php b/src/Symfony/Component/HttpFoundation/Session/SessionInterface.php
@@ -29,6 +29,42 @@ interface SessionInterface
      */
     function start();
 
+    /**
+     * Returns the session ID.
+     *
+     * @return string The session ID.
+     *
+     * @api
+     */
+    function getId();
+
+    /**
+     * Sets the session ID
+     *
+     * @param string $id
+     *
+     * @api
+     */
+    function setId($id);
+
+    /**
+     * Returns the session name.
+     *
+     * @return mixed The session name.
+     *
+     * @api
+     */
+    function getName();
+
+    /**
+     * Sets the session name.
+     *
+     * @param string $name
+     *
+     * @api
+     */
+    function setName($name);
+
     /**
      * Invalidates the current session.
      *

diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NativeFileSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/NativeFileSessionHandler.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;
 
 /**
- * NativeFileSessionStorage.
+ * NativeFileSessionHandler.
  *
  * Native session handler using PHP's built in file storage.
  *

diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/MockArraySessionStorage.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\HttpFoundation\Session\Storage;
 
-use Symfony\Component\HttpFoundation\Session\Storage\Handler\NullSessionHandler;
+use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
 
 /**
  * MockArraySessionStorage mocks the session for unit tests.
@@ -25,21 +25,41 @@
  * @author Bulat Shakirzyanov <mallluhuct@gmail.com>
  * @author Drak <drak@zikula.org>
  */
-class MockArraySessionStorage extends SessionStorage
+class MockArraySessionStorage implements SessionStorageInterface
 {
     /**
      * @var string
      */
-    protected $sessionId;
+    protected $id = '';
+
+    /**
+     * @var string
+     */
+    protected $name;
+
+    /**
+     * @var boolean
+     */
+    protected $started = false;
+
+    /**
+     * @var boolean
+     */
+    protected $closed = false;
 
     /**
      * @var array
      */
-    protected $sessionData = array();
+    protected $data = array();
 
-    public function __construct(array $options = array())
+    /**
+     * Constructor.
+     *
+     * @param string $name Session name
+     */
+    public function __construct($name = 'MOCKSESSID')
     {
-        parent::__construct($options, new NullSessionHandler());
+        $this->name = $name;
     }
 
     /**
@@ -49,7 +69,7 @@ public function __construct(array $options = array())
      */
     public function setSessionData(array $array)
     {
-        $this->sessionData = $array;
+        $this->data = $array;
     }
 
     /**
@@ -61,11 +81,11 @@ public function start()
             return true;
         }
 
-        $this->started = true;
-        $this->loadSession($this->sessionData);
+        if (empty($this->id)) {
+            $this->id = $this->generateId();
+        }
 
-        $this->sessionId = $this->generateSessionId();
-        session_id($this->sessionId);
+        $this->loadSession();
 
         return true;
     }
@@ -80,8 +100,7 @@ public function regenerate($destroy = false)
             $this->start();
         }
 
-        $this->sessionId = $this->generateSessionId();
-        session_id($this->sessionId);
+        $this->id = $this->generateId();
 
         return true;
     }
@@ -91,11 +110,35 @@ public function regenerate($destroy = false)
      */
     public function getId()
     {
-        if (!$this->started) {
-            return '';
+        return $this->id;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setId($id)
+    {
+        if ($this->started) {
+            throw new \LogicException('Cannot set session ID after the session has started.');
         }
 
-        return $this->sessionId;
+        $this->id = $id;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setName($name)
+    {
+        $this->name = $name;
     }
 
     /**
@@ -118,10 +161,18 @@ public function clear()
         }
 
         // clear out the session
-        $this->sessionData = array();
+        $this->data = array();
 
         // reconnect the bags to the session
-        $this->loadSession($this->sessionData);
+        $this->loadSession();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function registerBag(SessionBagInterface $bag)
+    {
+        $this->bags[$bag->getName()] = $bag;
     }
 
     /**
@@ -143,10 +194,25 @@ public function getBag($name)
     /**
      * Generates a session ID.
      *
+     * This doesn't need to be particularly cryptographically secure since this is just
+     * a mock.
+     *
      * @return string
      */
-    protected function generateSessionId()
+    protected function generateId()
+    {
+        return sha1(uniqid(mt_rand()));
+    }
+
+    protected function loadSession()
     {
-        return sha1(uniqid(mt_rand(), true));
+        foreach ($this->bags as $bag) {
+            $key = $bag->getStorageKey();
+            $this->data[$key] = isset($this->data[$key]) ? $this->data[$key] : array();
+            $bag->initialize($this->data[$key]);
+        }
+
+        $this->started = true;
+        $this->closed = false;
     }
 }