chrome/browser/chromeos/profiles/profile_helper.h

   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.
   4
   5 #ifndef CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_
   6 #define CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/callback_forward.h"
  13 #include "base/files/file_path.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "chrome/browser/browsing_data/browsing_data_remover.h"
  16 #include "chrome/browser/chromeos/login/signin/oauth2_login_manager.h"
  17 #include "components/user_manager/user_manager.h"
  18
  19 class Profile;
  20
  21 namespace base {
  22 class FilePath;
  23 }
  24
  25 namespace extensions {
  26 class ExtensionGarbageCollectorChromeOSUnitTest;
  27 }
  28
  29 namespace ash {
  30 namespace test {
  31 class MultiUserWindowManagerChromeOSTest;
  32 }  // namespace test
  33 }  // namespace ash
  34
  35 namespace chromeos {
  36
  37 // This helper class is used on Chrome OS to keep track of currently
  38 // active user profile.
  39 // Whenever active user is changed (either add another user into session or
  40 // switch between users), ActiveUserHashChanged() will be called thus
  41 // internal state |active_user_id_hash_| will be updated.
  42 // Typical use cases for using this class:
  43 // 1. Get "signin profile" which is a special type of profile that is only used
  44 //    during signin flow: GetSigninProfile()
  45 // 2. Get profile dir of an active user, used by ProfileManager:
  46 //    GetActiveUserProfileDir()
  47 // 3. Get mapping from user_id_hash to Profile instance/profile path etc.
  48 class ProfileHelper
  49     : public BrowsingDataRemover::Observer,
  50       public OAuth2LoginManager::Observer,
  51       public user_manager::UserManager::UserSessionStateObserver {
  52  public:
  53   ProfileHelper();
  54   ~ProfileHelper() override;
  55
  56   // Returns ProfileHelper instance. This class is not singleton and is owned
  57   // by BrowserProcess/BrowserProcessPlatformPart. This method keeps that
  58   // knowledge in one place.
  59   static ProfileHelper* Get();
  60
  61   // Returns Profile instance that corresponds to |user_id_hash|.
  62   static Profile* GetProfileByUserIdHash(const std::string& user_id_hash);
  63
  64   // Returns profile path that corresponds to a given |user_id_hash|.
  65   static base::FilePath GetProfilePathByUserIdHash(
  66       const std::string& user_id_hash);
  67
  68   // Returns the path that corresponds to the sign-in profile.
  69   static base::FilePath GetSigninProfileDir();
  70
  71   // Returns OffTheRecord profile for use during signing phase.
  72   static Profile* GetSigninProfile();
  73
  74   // Returns user_id hash for |profile| instance or empty string if hash
  75   // could not be extracted from |profile|.
  76   static std::string GetUserIdHashFromProfile(const Profile* profile);
  77
  78   // Returns user profile dir in a format [u-user_id_hash].
  79   static base::FilePath GetUserProfileDir(const std::string& user_id_hash);
  80
  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
  83   // signin Profile.
  84   static bool IsSigninProfile(const Profile* profile);
  85
  86   // Returns true when |profile| corresponds to owner's profile.
  87   static bool IsOwnerProfile(Profile* profile);
  88
  89   // Returns true when |profile| corresponds to the primary user profile
  90   // of the current session.
  91   static bool IsPrimaryProfile(const Profile* profile);
  92
  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);
  96
  97   // Returns active user profile dir in a format [u-$hash].
  98   base::FilePath GetActiveUserProfileDir();
  99
 100   // Should called once after UserManager instance has been created.
 101   void Initialize();
 102
 103   // Returns hash for active user ID which is used to identify that user profile
 104   // on Chrome OS.
 105   std::string active_user_id_hash() { return active_user_id_hash_; }
 106
 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);
 110
 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);
 114
 115   // DEPRECATED
 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);
 124
 125   // Returns NULL if User is not created.
 126   const user_manager::User* GetUserByProfile(const Profile* profile) const;
 127   user_manager::User* GetUserByProfile(Profile* profile) const;
 128
 129   static std::string GetUserIdHashByUserIdForTesting(
 130       const std::string& user_id);
 131
 132  private:
 133   // TODO(nkostylev): Create a test API class that will be the only one allowed
 134   // to access private test methods.
 135   friend class CryptohomeAuthenticatorTest;
 136   friend class DeviceSettingsTestBase;
 137   friend class ExistingUserControllerTest;
 138   friend class extensions::ExtensionGarbageCollectorChromeOSUnitTest;
 139   friend class FakeChromeUserManager;
 140   friend class KioskTest;
 141   friend class MockUserManager;
 142   friend class MultiProfileUserControllerTest;
 143   friend class PrinterDetectorAppSearchEnabledTest;
 144   friend class ProfileHelperTest;
 145   friend class ProfileListChromeOSTest;
 146   friend class SessionStateDelegateChromeOSTest;
 147   friend class SystemTrayDelegateChromeOSTest;
 148   friend class ash::test::MultiUserWindowManagerChromeOSTest;
 149
 150   // Called when signin profile is cleared.
 151   void OnSigninProfileCleared();
 152
 153   // BrowsingDataRemover::Observer implementation:
 154   void OnBrowsingDataRemoverDone() override;
 155
 156   // OAuth2LoginManager::Observer overrides.
 157   void OnSessionRestoreStateChanged(
 158       Profile* user_profile,
 159       OAuth2LoginManager::SessionRestoreState state) override;
 160
 161   // user_manager::UserManager::UserSessionStateObserver implementation:
 162   void ActiveUserHashChanged(const std::string& hash) override;
 163
 164   // Associates |user| with profile with the same user_id,
 165   // for GetUserByProfile() testing.
 166   void SetProfileToUserMappingForTesting(user_manager::User* user);
 167
 168   // Enables/disables testing code path in GetUserByProfile() like
 169   // always return primary user (when always_return_primary_user_for_testing is
 170   // set).
 171   static void SetProfileToUserForTestingEnabled(bool enabled);
 172
 173   // Enables/disables testing GetUserByProfile() by always returning
 174   // primary user.
 175   static void SetAlwaysReturnPrimaryUserForTesting(bool value);
 176
 177   // Associates |profile| with |user|, for GetProfileByUser() testing.
 178   void SetUserToProfileMappingForTesting(const user_manager::User* user,
 179                                          Profile* profile);
 180
 181   // Identifies path to active user profile on Chrome OS.
 182   std::string active_user_id_hash_;
 183
 184   // List of callbacks called after signin profile clearance.
 185   std::vector<base::Closure> on_clear_callbacks_;
 186
 187   // Called when a single stage of profile clearing is finished.
 188   base::Closure on_clear_profile_stage_finished_;
 189
 190   // A currently running browsing data remover.
 191   BrowsingDataRemover* browsing_data_remover_;
 192
 193   // Used for testing by unit tests and FakeUserManager/MockUserManager.
 194   std::map<const user_manager::User*, Profile*> user_to_profile_for_testing_;
 195
 196   // When this list is not empty GetUserByProfile() will find user that has
 197   // the same user_id as |profile|->GetProfileName().
 198   user_manager::UserList user_list_for_testing_;
 199
 200   // If true testing code path is used in GetUserByProfile() even if
 201   // user_list_for_testing_ list is empty. In that case primary user will always
 202   // be returned.
 203   static bool enable_profile_to_user_testing;
 204
 205   // If true and enable_profile_to_user_testing is true then primary user will
 206   // always be returned by GetUserByProfile().
 207   static bool always_return_primary_user_for_testing;
 208
 209   base::WeakPtrFactory<ProfileHelper> weak_factory_;
 210
 211   DISALLOW_COPY_AND_ASSIGN(ProfileHelper);
 212 };
 213
 214 } // namespace chromeos
 215
 216 #endif  // CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_