1 // Copyright (c) 2013 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 CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_
6 #define CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_
11 #include "base/basictypes.h"
12 #include "base/callback_forward.h"
13 #include "base/files/file_path.h"
14 #include "chrome/browser/browsing_data/browsing_data_remover.h"
15 #include "chrome/browser/chromeos/login/signin/oauth2_login_manager.h"
16 #include "components/user_manager/user_manager.h"
25 namespace extensions {
26 class ExtensionGarbageCollectorChromeOSUnitTest;
31 // This helper class is used on Chrome OS to keep track of currently
32 // active user profile.
33 // Whenever active user is changed (either add another user into session or
34 // switch between users), ActiveUserHashChanged() will be called thus
35 // internal state |active_user_id_hash_| will be updated.
36 // Typical use cases for using this class:
37 // 1. Get "signin profile" which is a special type of profile that is only used
38 // during signin flow: GetSigninProfile()
39 // 2. Get profile dir of an active user, used by ProfileManager:
40 // GetActiveUserProfileDir()
41 // 3. Get mapping from user_id_hash to Profile instance/profile path etc.
43 : public BrowsingDataRemover::Observer,
44 public OAuth2LoginManager::Observer,
45 public user_manager::UserManager::UserSessionStateObserver {
48 virtual ~ProfileHelper();
50 // Returns ProfileHelper instance. This class is not singleton and is owned
51 // by BrowserProcess/BrowserProcessPlatformPart. This method keeps that
52 // knowledge in one place.
53 static ProfileHelper* Get();
55 // Returns Profile instance that corresponds to |user_id_hash|.
56 static Profile* GetProfileByUserIdHash(const std::string& user_id_hash);
58 // Returns profile dir that corresponds to a --login-profile cmd line switch.
59 static base::FilePath GetProfileDirByLegacyLoginProfileSwitch();
61 // Returns profile path that corresponds to a given |user_id_hash|.
62 static base::FilePath GetProfilePathByUserIdHash(
63 const std::string& user_id_hash);
65 // Returns the path that corresponds to the sign-in profile.
66 static base::FilePath GetSigninProfileDir();
68 // Returns OffTheRecord profile for use during signing phase.
69 static Profile* GetSigninProfile();
71 // Returns user_id hash for |profile| instance or empty string if hash
72 // could not be extracted from |profile|.
73 static std::string GetUserIdHashFromProfile(Profile* profile);
75 // Returns profile dir for the user identified by |user_id|.
76 static base::FilePath GetUserProfileDirByUserId(const std::string& user_id);
78 // Returns user profile dir in a format [u-user_id_hash].
79 static base::FilePath GetUserProfileDir(const std::string& user_id_hash);
81 // Returns true if |profile| is the signin Profile. This can be used during
82 // construction of the signin Profile to determine if that Profile is the
84 static bool IsSigninProfile(Profile* profile);
86 // Returns true when |profile| corresponds to owner's profile.
87 static bool IsOwnerProfile(Profile* profile);
89 // Returns true when |profile| corresponds to the primary user profile
90 // of the current session.
91 static bool IsPrimaryProfile(Profile* profile);
93 // Initialize a bunch of services that are tied to a browser profile.
94 // TODO(dzhioev): Investigate whether or not this method is needed.
95 void ProfileStartup(Profile* profile, bool process_startup);
97 // Returns active user profile dir in a format [u-$hash].
98 base::FilePath GetActiveUserProfileDir();
100 // Should called once after UserManager instance has been created.
103 // Returns hash for active user ID which is used to identify that user profile
105 std::string active_user_id_hash() { return active_user_id_hash_; }
107 // Clears site data (cookies, history, etc) for signin profile.
108 // Callback can be empty. Not thread-safe.
109 void ClearSigninProfile(const base::Closure& on_clear_callback);
111 // Returns profile of the |user| if it is created and fully initialized.
112 // Otherwise, returns NULL.
113 Profile* GetProfileByUser(const user_manager::User* user);
116 // Returns profile of the |user| if user's profile is created and fully
117 // initialized. Otherwise, if some user is active, returns his profile.
118 // Otherwise, returns signin profile.
119 // Behaviour of this function does not correspond to its name and can be
120 // very surprising, that's why it should not be used anymore.
121 // Use |GetProfileByUser| instead.
122 // TODO(dzhioev): remove this method. http://crbug.com/361528
123 Profile* GetProfileByUserUnsafe(const user_manager::User* user);
125 // Returns NULL if User is not created.
126 user_manager::User* GetUserByProfile(Profile* profile);
129 friend class DeviceSettingsTestBase;
130 friend class extensions::ExtensionGarbageCollectorChromeOSUnitTest;
131 friend class FakeUserManager;
132 friend class KioskTest;
133 friend class MockUserManager;
134 friend class MultiProfileUserControllerTest;
135 friend class ParallelAuthenticatorTest;
136 friend class ProfileHelperTest;
137 friend class ProfileListChromeOSTest;
138 friend class SessionStateDelegateChromeOSTest;
140 // BrowsingDataRemover::Observer implementation:
141 virtual void OnBrowsingDataRemoverDone() OVERRIDE;
143 // OAuth2LoginManager::Observer overrides.
144 virtual void OnSessionRestoreStateChanged(
145 Profile* user_profile,
146 OAuth2LoginManager::SessionRestoreState state) OVERRIDE;
148 // user_manager::UserManager::UserSessionStateObserver implementation:
149 virtual void ActiveUserHashChanged(const std::string& hash) OVERRIDE;
151 // Associates |user| with profile with the same user_id,
152 // for GetUserByProfile() testing.
153 void SetProfileToUserMappingForTesting(user_manager::User* user);
155 // Enables/disables testing code path in GetUserByProfile() like
156 // always return primary user (when always_return_primary_user_for_testing is
158 static void SetProfileToUserForTestingEnabled(bool enabled);
160 // Enables/disables testing GetUserByProfile() by always returning
162 static void SetAlwaysReturnPrimaryUserForTesting(bool value);
164 // Associates |profile| with |user|, for GetProfileByUser() testing.
165 void SetUserToProfileMappingForTesting(const user_manager::User* user,
168 // Identifies path to active user profile on Chrome OS.
169 std::string active_user_id_hash_;
171 // True if signin profile clearing now.
172 bool signin_profile_clear_requested_;
174 // List of callbacks called after signin profile clearance.
175 std::vector<base::Closure> on_clear_callbacks_;
177 // Used for testing by unit tests and FakeUserManager/MockUserManager.
178 std::map<const user_manager::User*, Profile*> user_to_profile_for_testing_;
180 // When this list is not empty GetUserByProfile() will find user that has
181 // the same user_id as |profile|->GetProfileName().
182 user_manager::UserList user_list_for_testing_;
184 // If true testing code path is used in GetUserByProfile() even if
185 // user_list_for_testing_ list is empty. In that case primary user will always
187 static bool enable_profile_to_user_testing;
189 // If true and enable_profile_to_user_testing is true then primary user will
190 // always be returned by GetUserByProfile().
191 static bool always_return_primary_user_for_testing;
193 DISALLOW_COPY_AND_ASSIGN(ProfileHelper);
196 } // namespace chromeos
198 #endif // CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_