fixed user refreshing after unserialization

3 files changed, 105 insertions, 21 deletions

diff --git a/Authentication/Token/Token.php b/Authentication/Token/Token.php
index 808f151..37b7ded 100644
--- a/Authentication/Token/Token.php
+++ b/Authentication/Token/Token.php
@@ -19,12 +19,14 @@ use Symfony\Component\Security\User\AccountInterface;
  * Base class for Token instances.
  *
  * @author Fabien Potencier <fabien.potencier@symfony-project.com>
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 abstract class Token implements TokenInterface
 {
     protected $roles;
     protected $authenticated;
     protected $user;
+    protected $userProviderName;
     protected $credentials;
     protected $immutable;
 
@@ -35,13 +37,7 @@ abstract class Token implements TokenInterface
      */
     public function __construct(array $roles = array())
     {
-        $this->roles = array();
-        foreach ($roles as $role) {
-            if (is_string($role)) {
-                $role = new Role((string) $role);
-            }
-            $this->addRole($role);
-        }
+        $this->setRoles($roles);
         $this->authenticated = false;
         $this->immutable = false;
     }
@@ -53,6 +49,10 @@ abstract class Token implements TokenInterface
      */
     public function addRole(RoleInterface $role)
     {
+        if ($this->immutable) {
+            throw new \LogicException('This token is considered immutable.');
+        }
+
         $this->roles[] = $role;
     }
 
@@ -65,6 +65,22 @@ abstract class Token implements TokenInterface
     }
 
     /**
+     * {@inheritDoc}
+     */
+    public function setRoles(array $roles)
+    {
+        $this->roles = array();
+
+        foreach ($roles as $role) {
+            if (is_string($role)) {
+                $role = new Role($role);
+            }
+
+            $this->addRole($role);
+        }
+    }
+
+    /**
      * {@inheritdoc}
      */
     public function __toString()
@@ -91,6 +107,10 @@ abstract class Token implements TokenInterface
      */
     public function setAuthenticated($authenticated)
     {
+        if ($this->immutable) {
+            throw new \LogicException('This token is considered immutable.');
+        }
+
         $this->authenticated = (Boolean) $authenticated;
     }
 
@@ -111,10 +131,32 @@ abstract class Token implements TokenInterface
     }
 
     /**
+     * {@inheritDoc}
+     */
+    public function setUser($user)
+    {
+        if ($this->immutable) {
+            throw new \LogicException('This token is considered immutable.');
+        }
+
+        if (!is_string($user) && !is_object($user)) {
+            throw new \InvalidArgumentException('$user must be an object, or a primitive string.');
+        } else if (is_object($user) && !method_exists($user, '__toString')) {
+            throw new \InvalidArgumentException('If $user is an object, it must implement __toString().');
+        }
+
+        $this->user = $user;
+    }
+
+    /**
      * {@inheritdoc}
      */
     public function eraseCredentials()
     {
+        if ($this->immutable) {
+            throw new \LogicException('This token is considered immutable.');
+        }
+
         if ($this->getCredentials() instanceof AccountInterface) {
             $this->getCredentials()->eraseCredentials();
         }
@@ -125,6 +167,14 @@ abstract class Token implements TokenInterface
     }
 
     /**
+     * {@inheritDoc}
+     */
+    public function getUserProviderName()
+    {
+        return $this->userProviderName;
+    }
+
+    /**
      * {@inheritdoc}
      */
     public function isImmutable()
@@ -135,9 +185,9 @@ abstract class Token implements TokenInterface
     /**
      * {@inheritdoc}
      */
-    public function setImmutable($value)
+    public function setImmutable()
     {
-        $this->immutable = (Boolean) $value;
+        $this->immutable = true;
     }
 
     /**
@@ -145,9 +195,7 @@ abstract class Token implements TokenInterface
      */
     public function serialize()
     {
-        // FIXME: don't serialize the user object, just the username (see ContextListener)
-        //return serialize(array((string) $this, $this->credentials, $this->authenticated, $this->roles, $this->immutable));
-        return serialize(array($this->user, $this->credentials, $this->authenticated, $this->roles, $this->immutable));
+        return serialize(array($this->user, $this->userProviderName, $this->credentials, $this->authenticated, $this->roles, $this->immutable));
     }
 
     /**
@@ -155,6 +203,6 @@ abstract class Token implements TokenInterface
      */
     public function unserialize($serialized)
     {
-        list($this->user, $this->credentials, $this->authenticated, $this->roles, $this->immutable) = unserialize($serialized);
+        list($this->user, $this->userProviderName, $this->credentials, $this->authenticated, $this->roles, $this->immutable) = unserialize($serialized);
     }
 }
diff --git a/Authentication/Token/TokenInterface.php b/Authentication/Token/TokenInterface.php
index 01753cf..4f37522 100644
--- a/Authentication/Token/TokenInterface.php
+++ b/Authentication/Token/TokenInterface.php
@@ -2,6 +2,8 @@
 
 namespace Symfony\Component\Security\Authentication\Token;
 
+use Symfony\Component\Security\User\AccountInterface;
+
 /*
  * This file is part of the Symfony package.
  *
@@ -33,6 +35,14 @@ interface TokenInterface extends \Serializable
     function getRoles();
 
     /**
+     * Sets the user's roles
+     *
+     * @param array $roles
+     * @return void
+     */
+    function setRoles(array $roles);
+
+    /**
      * Returns the user credentials.
      *
      * @return mixed The user credentials
@@ -40,18 +50,27 @@ interface TokenInterface extends \Serializable
     function getCredentials();
 
     /**
-     * Checks whether the token is immutable or not.
+     * Returns a user representation.
      *
-     * @return Boolean true if the token is immutable, false otherwise
+     * @return mixed either returns an object which implements __toString(), or
+     *                  a primitive string is returned.
      */
-    function isImmutable();
+    function getUser();
 
     /**
-     * Returns a user instance.
+     * Sets the user.
      *
-     * @return object The User instance
+     * @param mixed $user can either be an object which implements __toString(), or
+     *                       only a primitive string
      */
-    function getUser();
+    function setUser($user);
+
+    /**
+     * Returns a unique id for the user provider that was used to retrieve the user
+     *
+     * @return string
+     */
+    function getUserProviderName();
 
     /**
      * Checks if the user is authenticated or not.
@@ -68,6 +87,22 @@ interface TokenInterface extends \Serializable
     function setAuthenticated($isAuthenticated);
 
     /**
+     * Whether this token is considered immutable
+     *
+     * @return Boolean
+     */
+    function isImmutable();
+
+    /**
+     * Marks this token as immutable. This change cannot be reversed.
+     *
+     * You'll need to create a new token if you want a mutable token again.
+     *
+     * @return void
+     */
+    function setImmutable();
+
+    /**
      * Removes sensitive information from the token.
      */
     function eraseCredentials();
diff --git a/Authentication/Token/UsernamePasswordToken.php b/Authentication/Token/UsernamePasswordToken.php
index ae248e8..ce11cb3 100644
--- a/Authentication/Token/UsernamePasswordToken.php
+++ b/Authentication/Token/UsernamePasswordToken.php
@@ -21,12 +21,13 @@ class UsernamePasswordToken extends Token
     /**
      * Constructor.
      */
-    public function __construct($user, $credentials, array $roles = array())
+    public function __construct($user, $credentials, $userProviderName = null, array $roles = array())
     {
         parent::__construct($roles);
 
-        $this->user = $user;
+        $this->setUser($user);
         $this->credentials = $credentials;
+        $this->userProviderName = $userProviderName;
 
         parent::setAuthenticated((Boolean) count($roles));
     }