1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef COMPONENTS_USER_MANAGER_USER_MANAGER_BASE_H_
6 #define COMPONENTS_USER_MANAGER_USER_MANAGER_BASE_H_
12 #include "base/basictypes.h"
13 #include "base/memory/weak_ptr.h"
14 #include "base/observer_list.h"
15 #include "base/synchronization/lock.h"
16 #include "base/time/time.h"
17 #include "components/user_manager/user.h"
18 #include "components/user_manager/user_manager.h"
19 #include "components/user_manager/user_manager_export.h"
20 #include "components/user_manager/user_type.h"
23 class PrefRegistrySimple
;
30 namespace user_manager
{
32 class RemoveUserDelegate
;
34 // Base implementation of the UserManager interface.
35 class USER_MANAGER_EXPORT UserManagerBase
: public UserManager
{
37 // Creates UserManagerBase with |task_runner| for UI thread and
38 // |blocking_task_runner| for SequencedWorkerPool.
39 UserManagerBase(scoped_refptr
<base::TaskRunner
> task_runner
,
40 scoped_refptr
<base::TaskRunner
> blocking_task_runner
);
41 virtual ~UserManagerBase();
43 // Registers UserManagerBase preferences.
44 static void RegisterPrefs(PrefRegistrySimple
* registry
);
46 // UserManager implementation:
47 virtual void Shutdown() override
;
48 virtual const UserList
& GetUsers() const override
;
49 virtual const UserList
& GetLoggedInUsers() const override
;
50 virtual const UserList
& GetLRULoggedInUsers() const override
;
51 virtual const std::string
& GetOwnerEmail() const override
;
52 virtual void UserLoggedIn(const std::string
& user_id
,
53 const std::string
& user_id_hash
,
54 bool browser_restart
) override
;
55 virtual void SwitchActiveUser(const std::string
& user_id
) override
;
56 virtual void SwitchToLastActiveUser() override
;
57 virtual void SessionStarted() override
;
58 virtual void RemoveUser(const std::string
& user_id
,
59 RemoveUserDelegate
* delegate
) override
;
60 virtual void RemoveUserFromList(const std::string
& user_id
) override
;
61 virtual bool IsKnownUser(const std::string
& user_id
) const override
;
62 virtual const User
* FindUser(const std::string
& user_id
) const override
;
63 virtual User
* FindUserAndModify(const std::string
& user_id
) override
;
64 virtual const User
* GetLoggedInUser() const override
;
65 virtual User
* GetLoggedInUser() override
;
66 virtual const User
* GetActiveUser() const override
;
67 virtual User
* GetActiveUser() override
;
68 virtual const User
* GetPrimaryUser() const override
;
69 virtual void SaveUserOAuthStatus(
70 const std::string
& user_id
,
71 User::OAuthTokenStatus oauth_token_status
) override
;
72 virtual void SaveForceOnlineSignin(const std::string
& user_id
,
73 bool force_online_signin
) override
;
74 virtual void SaveUserDisplayName(const std::string
& user_id
,
75 const base::string16
& display_name
) override
;
76 virtual base::string16
GetUserDisplayName(
77 const std::string
& user_id
) const override
;
78 virtual void SaveUserDisplayEmail(const std::string
& user_id
,
79 const std::string
& display_email
) override
;
80 virtual std::string
GetUserDisplayEmail(
81 const std::string
& user_id
) const override
;
82 virtual void SaveUserType(const std::string
& user_id
,
83 const UserType
& user_type
) override
;
84 virtual void UpdateUserAccountData(
85 const std::string
& user_id
,
86 const UserAccountData
& account_data
) override
;
87 virtual bool IsCurrentUserOwner() const override
;
88 virtual bool IsCurrentUserNew() const override
;
89 virtual bool IsCurrentUserNonCryptohomeDataEphemeral() const override
;
90 virtual bool CanCurrentUserLock() const override
;
91 virtual bool IsUserLoggedIn() const override
;
92 virtual bool IsLoggedInAsUserWithGaiaAccount() const override
;
93 virtual bool IsLoggedInAsChildUser() const override
;
94 virtual bool IsLoggedInAsDemoUser() const override
;
95 virtual bool IsLoggedInAsPublicAccount() const override
;
96 virtual bool IsLoggedInAsGuest() const override
;
97 virtual bool IsLoggedInAsSupervisedUser() const override
;
98 virtual bool IsLoggedInAsKioskApp() const override
;
99 virtual bool IsLoggedInAsStub() const override
;
100 virtual bool IsSessionStarted() const override
;
101 virtual bool IsUserNonCryptohomeDataEphemeral(
102 const std::string
& user_id
) const override
;
103 virtual void AddObserver(UserManager::Observer
* obs
) override
;
104 virtual void RemoveObserver(UserManager::Observer
* obs
) override
;
105 virtual void AddSessionStateObserver(
106 UserManager::UserSessionStateObserver
* obs
) override
;
107 virtual void RemoveSessionStateObserver(
108 UserManager::UserSessionStateObserver
* obs
) override
;
109 virtual void NotifyLocalStateChanged() override
;
110 virtual void ChangeUserChildStatus(User
* user
, bool is_child
) override
;
112 // Helper function that copies users from |users_list| to |users_vector| and
113 // |users_set|. Duplicates and users already present in |existing_users| are
115 static void ParseUserList(const base::ListValue
& users_list
,
116 const std::set
<std::string
>& existing_users
,
117 std::vector
<std::string
>* users_vector
,
118 std::set
<std::string
>* users_set
);
121 // Adds |user| to users list, and adds it to front of LRU list. It is assumed
122 // that there is no user with same id.
123 virtual void AddUserRecord(User
* user
);
125 // Returns true if trusted device policies have successfully been retrieved
126 // and ephemeral users are enabled.
127 virtual bool AreEphemeralUsersEnabled() const = 0;
129 // Returns true if user may be removed.
130 virtual bool CanUserBeRemoved(const User
* user
) const;
132 // A wrapper around C++ delete operator. Deletes |user|, and when |user|
133 // equals to active_user_, active_user_ is reset to NULL.
134 virtual void DeleteUser(User
* user
);
136 // Returns the locale used by the application.
137 virtual const std::string
& GetApplicationLocale() const = 0;
139 // Returns "Local State" PrefService instance.
140 virtual PrefService
* GetLocalState() const = 0;
142 // Loads |users_| from Local State if the list has not been loaded yet.
143 // Subsequent calls have no effect. Must be called on the UI thread.
144 void EnsureUsersLoaded();
146 // Handle OAuth token |status| change for |user_id|.
147 virtual void HandleUserOAuthTokenStatusChange(
148 const std::string
& user_id
,
149 User::OAuthTokenStatus status
) const = 0;
151 // Returns true if device is enterprise managed.
152 virtual bool IsEnterpriseManaged() const = 0;
154 // Helper function that copies users from |users_list| to |users_vector| and
155 // |users_set|. Duplicates and users already present in |existing_users| are
157 // Loads public accounts from the Local state and fills in
158 // |public_sessions_set|.
159 virtual void LoadPublicAccounts(
160 std::set
<std::string
>* public_sessions_set
) = 0;
162 // Notifies that user has logged in.
163 virtual void NotifyOnLogin();
165 // Notifies observers that another user was added to the session.
166 // If |user_switch_pending| is true this means that user has not been fully
167 // initialized yet like waiting for profile to be loaded.
168 virtual void NotifyUserAddedToSession(const User
* added_user
,
169 bool user_switch_pending
);
171 // Performs any additional actions before user list is loaded.
172 virtual void PerformPreUserListLoadingActions() = 0;
174 // Performs any additional actions after user list is loaded.
175 virtual void PerformPostUserListLoadingActions() = 0;
177 // Performs any additional actions after UserLoggedIn() execution has been
179 // |browser_restart| is true when reloading Chrome after crash to distinguish
180 // from normal sign in flow.
181 virtual void PerformPostUserLoggedInActions(bool browser_restart
) = 0;
183 // Implementation for RemoveUser method. It is synchronous. It is called from
184 // RemoveUserInternal after owner check.
185 virtual void RemoveNonOwnerUserInternal(const std::string
& user_email
,
186 RemoveUserDelegate
* delegate
);
188 // Removes a regular or supervised user from the user list.
189 // Returns the user if found or NULL otherwise.
190 // Also removes the user from the persistent user list.
191 User
* RemoveRegularOrSupervisedUserFromList(const std::string
& user_id
);
193 // Implementation for RemoveUser method. This is an asynchronous part of the
194 // method, that verifies that owner will not get deleted, and calls
195 // |RemoveNonOwnerUserInternal|.
196 virtual void RemoveUserInternal(const std::string
& user_email
,
197 RemoveUserDelegate
* delegate
);
199 // Removes data stored or cached outside the user's cryptohome (wallpaper,
200 // avatar, OAuth token status, display name, display email).
201 virtual void RemoveNonCryptohomeData(const std::string
& user_id
);
203 // Check for a particular user type.
205 // Returns true if |user_id| represents demo app.
206 virtual bool IsDemoApp(const std::string
& user_id
) const = 0;
208 // Returns true if |user_id| represents kiosk app.
209 virtual bool IsKioskApp(const std::string
& user_id
) const = 0;
211 // Returns true if |user_id| represents public account that has been marked
213 virtual bool IsPublicAccountMarkedForRemoval(
214 const std::string
& user_id
) const = 0;
216 // These methods are called when corresponding user type has signed in.
218 // Indicates that the demo account has just logged in.
219 virtual void DemoAccountLoggedIn() = 0;
221 // Indicates that a user just logged in as guest.
222 virtual void GuestUserLoggedIn();
224 // Indicates that a kiosk app robot just logged in.
225 virtual void KioskAppLoggedIn(const std::string
& app_id
) = 0;
227 // Indicates that a user just logged into a public session.
228 virtual void PublicAccountUserLoggedIn(User
* user
) = 0;
230 // Indicates that a regular user just logged in.
231 virtual void RegularUserLoggedIn(const std::string
& user_id
);
233 // Indicates that a regular user just logged in as ephemeral.
234 virtual void RegularUserLoggedInAsEphemeral(const std::string
& user_id
);
236 // Indicates that a user just logged into a retail mode session.
237 virtual void RetailModeUserLoggedIn() = 0;
239 // Indicates that a supervised user just logged in.
240 virtual void SupervisedUserLoggedIn(const std::string
& user_id
) = 0;
242 // Getters/setters for private members.
244 virtual void SetCurrentUserIsOwner(bool is_current_user_owner
);
246 virtual bool GetEphemeralUsersEnabled() const;
247 virtual void SetEphemeralUsersEnabled(bool enabled
);
249 virtual void SetIsCurrentUserNew(bool is_new
);
251 virtual void SetOwnerEmail(std::string owner_user_id
);
253 virtual const std::string
& GetPendingUserSwitchID() const;
254 virtual void SetPendingUserSwitchID(std::string user_id
);
256 // The logged-in user that is currently active in current session.
257 // NULL until a user has logged in, then points to one
258 // of the User instances in |users_|, the |guest_user_| instance or an
259 // ephemeral user instance.
262 // The primary user of the current session. It is recorded for the first
263 // signed-in user and does not change thereafter.
266 // List of all known users. User instances are owned by |this|. Regular users
267 // are removed by |RemoveUserFromList|, public accounts by
268 // |UpdateAndCleanUpPublicAccounts|.
272 // Stages of loading user list from preferences. Some methods can have
273 // different behavior depending on stage.
274 enum UserLoadStage
{ STAGE_NOT_LOADED
= 0, STAGE_LOADING
, STAGE_LOADED
};
276 // Returns a list of users who have logged into this device previously.
277 // Same as GetUsers but used if you need to modify User from that list.
278 UserList
& GetUsersAndModify();
280 // Returns the user with the given email address if found in the persistent
281 // list. Returns |NULL| otherwise.
282 const User
* FindUserInList(const std::string
& user_id
) const;
284 // Returns |true| if user with the given id is found in the persistent list.
285 // Returns |false| otherwise. Does not trigger user loading.
286 bool UserExistsInList(const std::string
& user_id
) const;
288 // Same as FindUserInList but returns non-const pointer to User object.
289 User
* FindUserInListAndModify(const std::string
& user_id
);
291 // Reads user's oauth token status from local state preferences.
292 User::OAuthTokenStatus
LoadUserOAuthStatus(const std::string
& user_id
) const;
294 // Read a flag indicating whether online authentication against GAIA should
295 // be enforced during the user's next sign-in from local state preferences.
296 bool LoadForceOnlineSignin(const std::string
& user_id
) const;
298 // Notifies observers that merge session state had changed.
299 void NotifyMergeSessionStateChanged();
301 // Notifies observers that active user has changed.
302 void NotifyActiveUserChanged(const User
* active_user
);
304 // Notifies observers that active user_id hash has changed.
305 void NotifyActiveUserHashChanged(const std::string
& hash
);
307 // Update the global LoginState.
308 void UpdateLoginState();
310 // Insert |user| at the front of the LRU user list.
311 void SetLRUUser(User
* user
);
313 // Sends metrics in response to a user with gaia account (regular) logging in.
314 void SendGaiaUserLoginMetrics(const std::string
& user_id
);
316 // Sets account locale for user with id |user_id|.
317 virtual void UpdateUserAccountLocale(const std::string
& user_id
,
318 const std::string
& locale
);
320 // Updates user account after locale was resolved.
321 void DoUpdateAccountLocale(const std::string
& user_id
,
322 scoped_ptr
<std::string
> resolved_locale
);
324 // Indicates stage of loading user from prefs.
325 UserLoadStage user_loading_stage_
;
327 // List of all users that are logged in current session. These point to User
328 // instances in |users_|. Only one of them could be marked as active.
329 UserList logged_in_users_
;
331 // A list of all users that are logged in the current session. In contrast to
332 // |logged_in_users|, the order of this list is least recently used so that
333 // the active user should always be the first one in the list.
334 UserList lru_logged_in_users_
;
336 // True if SessionStarted() has been called.
337 bool session_started_
;
339 // Cached flag of whether currently logged-in user is owner or not.
340 // May be accessed on different threads, requires locking.
341 bool is_current_user_owner_
;
342 mutable base::Lock is_current_user_owner_lock_
;
344 // Cached flag of whether the currently logged-in user existed before this
346 bool is_current_user_new_
;
348 // Cached flag of whether the currently logged-in user is a regular user who
349 // logged in as ephemeral. Storage of persistent information is avoided for
350 // such users by not adding them to the persistent user list, not downloading
351 // their custom avatars and mounting their cryptohomes using tmpfs. Defaults
353 bool is_current_user_ephemeral_regular_user_
;
355 // Cached flag indicating whether the ephemeral user policy is enabled.
356 // Defaults to |false| if the value has not been read from trusted device
358 bool ephemeral_users_enabled_
;
360 // Cached name of device owner. Defaults to empty string if the value has not
361 // been read from trusted device policy yet.
362 std::string owner_email_
;
364 ObserverList
<UserManager::Observer
> observer_list_
;
366 // TODO(nkostylev): Merge with session state refactoring CL.
367 ObserverList
<UserManager::UserSessionStateObserver
>
368 session_state_observer_list_
;
370 // Time at which this object was created.
371 base::TimeTicks manager_creation_time_
;
373 // ID of the user just added to the session that needs to be activated
374 // as soon as user's profile is loaded.
375 std::string pending_user_switch_
;
377 // ID of the user that was active in the previous session.
378 // Preference value is stored here before first user signs in
379 // because pref will be overidden once session restore starts.
380 std::string last_session_active_user_
;
381 bool last_session_active_user_initialized_
;
383 // TaskRunner for UI thread.
384 scoped_refptr
<base::TaskRunner
> task_runner_
;
386 // TaskRunner for SequencedWorkerPool.
387 scoped_refptr
<base::TaskRunner
> blocking_task_runner_
;
389 base::WeakPtrFactory
<UserManagerBase
> weak_factory_
;
391 DISALLOW_COPY_AND_ASSIGN(UserManagerBase
);
394 } // namespace user_manager
396 #endif // COMPONENTS_USER_MANAGER_USER_MANAGER_BASE_H_