Remove more fields from the User class

These fields are used by advanced features of the security system, which
are not ready out of the box in the bundle anyway. The provided fields
was the cause of complaints from 2 sides:
- people complaining about useless fields in the DB when they don't use
  the feature
- people complaining about the implementation not fitting their business
  needs.
The bundle does not provide the storage for these properties anymore.
Projects needing to use these features should add the fields and the
implementation they need in their child User class instead.

Author: stof

Model/User.php

@@ -95,34 +95,18 @@ abstract class User implements UserInterface, GroupableInterface
      */
     protected $groups;
 
-    /**
-     * @var bool
-     */
-    protected $locked;
-
-    /**
-     * @var \DateTime
-     */
-    protected $expiresAt;
-
     /**
      * @var array
      */
     protected $roles;
 
-    /**
-     * @var \DateTime
-     */
-    protected $credentialsExpireAt;
-
     /**
      * User constructor.
      */
     public function __construct()
     {
         $this->salt = base_convert(sha1(uniqid(mt_rand(), true)), 16, 36);
         $this->enabled = false;
-        $this->locked = false;
         $this->roles = array();
     }
 
@@ -153,11 +137,8 @@ public function serialize()
             $this->salt,
             $this->usernameCanonical,
             $this->username,
-            $this->locked,
             $this->enabled,
             $this->id,
-            $this->expiresAt,
-            $this->credentialsExpireAt,
             $this->email,
             $this->emailCanonical,
         ));
@@ -170,24 +151,23 @@ public function unserialize($serialized)
     {
         $data = unserialize($serialized);
 
-        if (9 === count($data)) {
-            unset($data[4], $data[6]);
-
-            // add a few extra elements in the array to ensure that we have enough keys when unserializing
-            // older data which does not include all properties.
-            $data = array_merge($data, array_fill(0, 4, null));
+        if (13 === count($data)) {
+            // Unserializing a User object from 1.3.x
+            unset($data[4], $data[5], $data[6], $data[9], $data[10]);
+            $data = array_values($data);
+        } elseif (11 === count($data)) {
+            // Unserializing a User from a dev version somewhere between 2.0-alpha3 and 2.0-alpha4
+            unset($data[4], $data[7], $data[8]);
+            $data = array_values($data);
         }
 
         list(
             $this->password,
             $this->salt,
             $this->usernameCanonical,
             $this->username,
-            $this->locked,
             $this->enabled,
             $this->id,
-            $this->expiresAt,
-            $this->credentialsExpireAt,
             $this->email,
             $this->emailCanonical
         ) = $data;
@@ -313,10 +293,6 @@ public function hasRole($role)
      */
     public function isAccountNonExpired()
     {
-        if (null !== $this->expiresAt && $this->expiresAt->getTimestamp() < time()) {
-            return false;
-        }
-
         return true;
     }
 
@@ -325,18 +301,14 @@ public function isAccountNonExpired()
      */
     public function isAccountNonLocked()
     {
-        return !$this->locked;
+        return true;
     }
 
     /**
      * {@inheritdoc}
      */
     public function isCredentialsNonExpired()
     {
-        if (null !== $this->credentialsExpireAt && $this->credentialsExpireAt->getTimestamp() < time()) {
-            return false;
-        }
-
         return true;
     }
 
@@ -345,11 +317,6 @@ public function isEnabled()
         return $this->enabled;
     }
 
-    public function isLocked()
-    {
-        return !$this->isAccountNonLocked();
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -391,18 +358,6 @@ public function setUsernameCanonical($usernameCanonical)
         return $this;
     }
 
-    /**
-     * @param \DateTime $date
-     *
-     * @return User
-     */
-    public function setCredentialsExpireAt(\DateTime $date = null)
-    {
-        $this->credentialsExpireAt = $date;
-
-        return $this;
-    }
-
     public function setEmail($email)
     {
         $this->email = $email;
@@ -430,18 +385,6 @@ public function setEnabled($boolean)
         return $this;
     }
 
-    /**
-     * @param \DateTime $date
-     *
-     * @return User
-     */
-    public function setExpiresAt(\DateTime $date = null)
-    {
-        $this->expiresAt = $date;
-
-        return $this;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -486,16 +429,6 @@ public function setLastLogin(\DateTime $time = null)
         return $this;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setLocked($boolean)
-    {
-        $this->locked = $boolean;
-
-        return $this;
-    }
-
     /**
      * {@inheritdoc}
      */

Model/UserInterface.php

@@ -126,15 +126,6 @@ public function isSuperAdmin();
      */
     public function setEnabled($boolean);
 
-    /**
-     * Sets the locking status of the user.
-     *
-     * @param bool $boolean
-     *
-     * @return self
-     */
-    public function setLocked($boolean);
-
     /**
      * Sets the super admin status.
      *

Resources/config/doctrine-mapping/User.couchdb.xml

@@ -11,8 +11,6 @@
         <field name="salt" fieldName="salt" type="string" />
         <field name="password" fieldName="password" type="string" />
         <field name="lastLogin" fieldName="lastLogin" type="datetime" />
-        <field name="locked" fieldName="locked" type="mixed" />
-        <field name="expiresAt" fieldName="expiresAt" type="datetime" />
         <field name="confirmationToken" fieldName="confirmationToken" type="string" />
         <field name="passwordRequestedAt" fieldName="passwordRequestedAt" type="datetime" />
         <field name="roles" fieldName="roles" type="mixed" />

Resources/config/doctrine-mapping/User.mongodb.xml

@@ -22,17 +22,12 @@
 
         <field name="lastLogin" fieldName="lastLogin" type="date" />
 
-        <field name="locked" fieldName="locked" type="boolean" />
-
-        <field name="expiresAt" fieldName="expiresAt" type="date" />
-
         <field name="confirmationToken" fieldName="confirmationToken" type="string" />
 
         <field name="passwordRequestedAt" fieldName="passwordRequestedAt" type="date" />
 
         <field name="roles" fieldName="roles" type="collection" />
 
-        <field name="credentialsExpireAt" fieldName="credentialsExpireAt" type="date" />
         <indexes>
             <index>
                 <key name="usernameCanonical" order="asc" />

Resources/config/doctrine-mapping/User.orm.xml

@@ -22,18 +22,12 @@
 
         <field name="lastLogin" column="last_login" type="datetime" nullable="true" />
 
-        <field name="locked" column="locked" type="boolean" />
-
-        <field name="expiresAt" column="expires_at" type="datetime" nullable="true" />
-
         <field name="confirmationToken" column="confirmation_token" type="string" length="180" unique="true" nullable="true" />
 
         <field name="passwordRequestedAt" column="password_requested_at" type="datetime" nullable="true" />
 
         <field name="roles" column="roles" type="array" />
 
-        <field name="credentialsExpireAt" column="credentials_expire_at" type="datetime" nullable="true" />
-
     </mapped-superclass>
 
 </doctrine-mapping>

Upgrade.md

@@ -8,13 +8,24 @@ break. For the full list of changes, please look at the Changelog file.
 
 Methods and properties removed from `FOS\UserBundle\Model\User`
 
-- `$expired`
-- `$credentialsExpired`
-- `setExpired()` (use `setExpiresAt(\DateTime::now()` instead)
-- `setCredentialsExpired()` (use `setCredentialsExpireAt(\DateTime::now()` instead)
-
-You need to drop the fields `expired` and `credentials_expired` from your database
-schema, because they aren't mapped anymore.
+- `$locked`
+- `$expired` and `$expiredAt`
+- `$credentialsExpired` and `$credentialsExpired`
+- `setLocked()` and `isLocked()`
+- `setExpired()` and `setExpiresAt()`
+- `setCredentialsExpired()` and `setCredentialsExpireAt()`
+
+These properties were used to implement advanced features of the AdvancedUserInterface
+from the Symfony component, but neither Symfony nor this bundle are providing
+ways to use these features fully (expired credentials would just prevent
+logging in for instance).
+Projects needing to use these advanced feature should add the fields they
+need in their User class and override the corresponding method to provide
+an implementation fitting their requirement. Projects wanting to keep the
+previous behavior of the bundle can copy the condition used in 1.3.7.
+
+You need to drop the removed fields from your database schema, because they
+aren't mapped anymore.
 
 ### LoginManager