UserManager stack refactoring.

components/user_manager/user_manager_base.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef COMPONENTS_USER_MANAGER_USER_MANAGER_BASE_H_
 #define COMPONENTS_USER_MANAGER_USER_MANAGER_BASE_H_
 
 #include <set>
 #include <string>
 #include <vector>
@@ skipping 20 matching lines @@
 
 class RemoveUserDelegate;
 
 // Base implementation of the UserManager interface.
 class USER_MANAGER_EXPORT UserManagerBase : public UserManager {
  public:
   // Creates UserManagerBase with |task_runner| for UI thread and
   // |blocking_task_runner| for SequencedWorkerPool.
   UserManagerBase(scoped_refptr<base::TaskRunner> task_runner,
                   scoped_refptr<base::TaskRunner> blocking_task_runner);
-  virtual ~UserManagerBase();
+  ~UserManagerBase() override;
 
   // Registers UserManagerBase preferences.
   static void RegisterPrefs(PrefRegistrySimple* registry);
 
   // UserManager implementation:
-  virtual void Shutdown() override;
-  virtual const UserList& GetUsers() const override;
-  virtual const UserList& GetLoggedInUsers() const override;
-  virtual const UserList& GetLRULoggedInUsers() const override;
-  virtual const std::string& GetOwnerEmail() const override;
-  virtual void UserLoggedIn(const std::string& user_id,
-                            const std::string& user_id_hash,
-                            bool browser_restart) override;
-  virtual void SwitchActiveUser(const std::string& user_id) override;
-  virtual void SwitchToLastActiveUser() override;
-  virtual void SessionStarted() override;
-  virtual void RemoveUser(const std::string& user_id,
-                          RemoveUserDelegate* delegate) override;
-  virtual void RemoveUserFromList(const std::string& user_id) override;
-  virtual bool IsKnownUser(const std::string& user_id) const override;
-  virtual const User* FindUser(const std::string& user_id) const override;
-  virtual User* FindUserAndModify(const std::string& user_id) override;
-  virtual const User* GetLoggedInUser() const override;
-  virtual User* GetLoggedInUser() override;
-  virtual const User* GetActiveUser() const override;
-  virtual User* GetActiveUser() override;
-  virtual const User* GetPrimaryUser() const override;
-  virtual void SaveUserOAuthStatus(
-      const std::string& user_id,
-      User::OAuthTokenStatus oauth_token_status) override;
-  virtual void SaveForceOnlineSignin(const std::string& user_id,
-                                     bool force_online_signin) override;
-  virtual void SaveUserDisplayName(const std::string& user_id,
-                                   const base::string16& display_name) override;
-  virtual base::string16 GetUserDisplayName(
+  void Shutdown() override;
+  const UserList& GetUsers() const override;
+  const UserList& GetLoggedInUsers() const override;
+  const UserList& GetLRULoggedInUsers() const override;
+  const std::string& GetOwnerEmail() const override;
+  void UserLoggedIn(const std::string& user_id,
+                    const std::string& user_id_hash,
+                    bool browser_restart) override;
+  void SwitchActiveUser(const std::string& user_id) override;
+  void SwitchToLastActiveUser() override;
+  void SessionStarted() override;
+  void RemoveUser(const std::string& user_id,
+                  RemoveUserDelegate* delegate) override;
+  void RemoveUserFromList(const std::string& user_id) override;
+  bool IsKnownUser(const std::string& user_id) const override;
+  const User* FindUser(const std::string& user_id) const override;
+  User* FindUserAndModify(const std::string& user_id) override;
+  const User* GetLoggedInUser() const override;
+  User* GetLoggedInUser() override;
+  const User* GetActiveUser() const override;
+  User* GetActiveUser() override;
+  const User* GetPrimaryUser() const override;
+  void SaveUserOAuthStatus(const std::string& user_id,
+                           User::OAuthTokenStatus oauth_token_status) override;
+  void SaveForceOnlineSignin(const std::string& user_id,
+                             bool force_online_signin) override;
+  void SaveUserDisplayName(const std::string& user_id,
+                           const base::string16& display_name) override;
+  base::string16 GetUserDisplayName(const std::string& user_id) const override;
+  void SaveUserDisplayEmail(const std::string& user_id,
+                            const std::string& display_email) override;
+  std::string GetUserDisplayEmail(const std::string& user_id) const override;
+  void SaveUserType(const std::string& user_id,
+                    const UserType& user_type) override;
+  void UpdateUserAccountData(const std::string& user_id,
+                             const UserAccountData& account_data) override;
+  bool IsCurrentUserOwner() const override;
+  bool IsCurrentUserNew() const override;
+  bool IsCurrentUserNonCryptohomeDataEphemeral() const override;
+  bool CanCurrentUserLock() const override;
+  bool IsUserLoggedIn() const override;
+  bool IsLoggedInAsUserWithGaiaAccount() const override;
+  bool IsLoggedInAsChildUser() const override;
+  bool IsLoggedInAsPublicAccount() const override;
+  bool IsLoggedInAsGuest() const override;
+  bool IsLoggedInAsSupervisedUser() const override;
+  bool IsLoggedInAsKioskApp() const override;
+  bool IsLoggedInAsStub() const override;
+  bool IsSessionStarted() const override;
+  bool IsUserNonCryptohomeDataEphemeral(
       const std::string& user_id) const override;
-  virtual void SaveUserDisplayEmail(const std::string& user_id,
-                                    const std::string& display_email) override;
-  virtual std::string GetUserDisplayEmail(
-      const std::string& user_id) const override;
-  virtual void SaveUserType(const std::string& user_id,
-                            const UserType& user_type) override;
-  virtual void UpdateUserAccountData(
-      const std::string& user_id,
-      const UserAccountData& account_data) override;
-  virtual bool IsCurrentUserOwner() const override;
-  virtual bool IsCurrentUserNew() const override;
-  virtual bool IsCurrentUserNonCryptohomeDataEphemeral() const override;
-  virtual bool CanCurrentUserLock() const override;
-  virtual bool IsUserLoggedIn() const override;
-  virtual bool IsLoggedInAsUserWithGaiaAccount() const override;
-  virtual bool IsLoggedInAsChildUser() const override;
-  virtual bool IsLoggedInAsPublicAccount() const override;
-  virtual bool IsLoggedInAsGuest() const override;
-  virtual bool IsLoggedInAsSupervisedUser() const override;
-  virtual bool IsLoggedInAsKioskApp() const override;
-  virtual bool IsLoggedInAsStub() const override;
-  virtual bool IsSessionStarted() const override;
-  virtual bool IsUserNonCryptohomeDataEphemeral(
-      const std::string& user_id) const override;
-  virtual void AddObserver(UserManager::Observer* obs) override;
-  virtual void RemoveObserver(UserManager::Observer* obs) override;
-  virtual void AddSessionStateObserver(
+  void AddObserver(UserManager::Observer* obs) override;
+  void RemoveObserver(UserManager::Observer* obs) override;
+  void AddSessionStateObserver(
       UserManager::UserSessionStateObserver* obs) override;
-  virtual void RemoveSessionStateObserver(
+  void RemoveSessionStateObserver(
       UserManager::UserSessionStateObserver* obs) override;
-  virtual void NotifyLocalStateChanged() override;
-  virtual void ChangeUserChildStatus(User* user, bool is_child) override;
+  void NotifyLocalStateChanged() override;
+  void ChangeUserChildStatus(User* user, bool is_child) override;
 
   // Helper function that copies users from |users_list| to |users_vector| and
   // |users_set|. Duplicates and users already present in |existing_users| are
   // skipped.
   static void ParseUserList(const base::ListValue& users_list,
                             const std::set<std::string>& existing_users,
                             std::vector<std::string>* users_vector,
                             std::set<std::string>* users_set);
 
  protected:
@@ skipping 13 matching lines @@
   virtual void DeleteUser(User* user);
 
   // Returns the locale used by the application.
   virtual const std::string& GetApplicationLocale() const = 0;
 
   // Returns "Local State" PrefService instance.
   virtual PrefService* GetLocalState() const = 0;
 
   // Loads |users_| from Local State if the list has not been loaded yet.
   // Subsequent calls have no effect. Must be called on the UI thread.
-  void EnsureUsersLoaded();
+  virtual void EnsureUsersLoaded();
 
   // Handle OAuth token |status| change for |user_id|.
   virtual void HandleUserOAuthTokenStatusChange(
       const std::string& user_id,
       User::OAuthTokenStatus status) const = 0;
 
   // Returns true if device is enterprise managed.
   virtual bool IsEnterpriseManaged() const = 0;
 
   // Helper function that copies users from |users_list| to |users_vector| and
@@ skipping 103 matching lines @@
 
   // The primary user of the current session. It is recorded for the first
   // signed-in user and does not change thereafter.
   User* primary_user_;
 
   // List of all known users. User instances are owned by |this|. Regular users
   // are removed by |RemoveUserFromList|, public accounts by
   // |UpdateAndCleanUpPublicAccounts|.
   UserList users_;
 
+  // List of all users that are logged in current session. These point to User
+  // instances in |users_|. Only one of them could be marked as active.
+  UserList logged_in_users_;
+
+  // A list of all users that are logged in the current session. In contrast to
+  // |logged_in_users|, the order of this list is least recently used so that
+  // the active user should always be the first one in the list.
+  UserList lru_logged_in_users_;
+
  private:
   // Stages of loading user list from preferences. Some methods can have
   // different behavior depending on stage.
   enum UserLoadStage { STAGE_NOT_LOADED = 0, STAGE_LOADING, STAGE_LOADED };
 
   // Returns a list of users who have logged into this device previously.
   // Same as GetUsers but used if you need to modify User from that list.
   UserList& GetUsersAndModify();
 
   // Returns the user with the given email address if found in the persistent
@@ skipping 36 matching lines @@
   virtual void UpdateUserAccountLocale(const std::string& user_id,
                                        const std::string& locale);
 
   // Updates user account after locale was resolved.
   void DoUpdateAccountLocale(const std::string& user_id,
                              scoped_ptr<std::string> resolved_locale);
 
   // Indicates stage of loading user from prefs.
   UserLoadStage user_loading_stage_;
 
-  // List of all users that are logged in current session. These point to User
-  // instances in |users_|. Only one of them could be marked as active.
-  UserList logged_in_users_;
-
-  // A list of all users that are logged in the current session. In contrast to
-  // |logged_in_users|, the order of this list is least recently used so that
-  // the active user should always be the first one in the list.
-  UserList lru_logged_in_users_;
-
   // True if SessionStarted() has been called.
   bool session_started_;
 
   // Cached flag of whether currently logged-in user is owner or not.
   // May be accessed on different threads, requires locking.
   bool is_current_user_owner_;
   mutable base::Lock is_current_user_owner_lock_;
 
   // Cached flag of whether the currently logged-in user existed before this
   // login.
@@ skipping 41 matching lines @@
   scoped_refptr<base::TaskRunner> blocking_task_runner_;
 
   base::WeakPtrFactory<UserManagerBase> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(UserManagerBase);
 };
 
 }  // namespace user_manager
 
 #endif  // COMPONENTS_USER_MANAGER_USER_MANAGER_BASE_H_