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 chromeos {
  30
  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.
  42 class ProfileHelper
  43     : public BrowsingDataRemover::Observer,
  44       public OAuth2LoginManager::Observer,
  45       public user_manager::UserManager::UserSessionStateObserver {
  46  public:
  47   ProfileHelper();
  48   ~ProfileHelper() override;
  49
  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();
  54
  55   // Returns Profile instance that corresponds to |user_id_hash|.
  56   static Profile* GetProfileByUserIdHash(const std::string& user_id_hash);
  57
  58   // Returns profile path that corresponds to a given |user_id_hash|.
  59   static base::FilePath GetProfilePathByUserIdHash(
  60       const std::string& user_id_hash);
  61
  62   // Returns the path that corresponds to the sign-in profile.
  63   static base::FilePath GetSigninProfileDir();
  64
  65   // Returns OffTheRecord profile for use during signing phase.
  66   static Profile* GetSigninProfile();
  67
  68   // Returns user_id hash for |profile| instance or empty string if hash
  69   // could not be extracted from |profile|.
  70   static std::string GetUserIdHashFromProfile(const Profile* profile);
  71
  72   // Returns user profile dir in a format [u-user_id_hash].
  73   static base::FilePath GetUserProfileDir(const std::string& user_id_hash);
  74
  75   // Returns true if |profile| is the signin Profile. This can be used during
  76   // construction of the signin Profile to determine if that Profile is the
  77   // signin Profile.
  78   static bool IsSigninProfile(const Profile* profile);
  79
  80   // Returns true when |profile| corresponds to owner's profile.
  81   static bool IsOwnerProfile(Profile* profile);
  82
  83   // Returns true when |profile| corresponds to the primary user profile
  84   // of the current session.
  85   static bool IsPrimaryProfile(const Profile* profile);
  86
  87   // Initialize a bunch of services that are tied to a browser profile.
  88   // TODO(dzhioev): Investigate whether or not this method is needed.
  89   void ProfileStartup(Profile* profile, bool process_startup);
  90
  91   // Returns active user profile dir in a format [u-$hash].
  92   base::FilePath GetActiveUserProfileDir();
  93
  94   // Should called once after UserManager instance has been created.
  95   void Initialize();
  96
  97   // Returns hash for active user ID which is used to identify that user profile
  98   // on Chrome OS.
  99   std::string active_user_id_hash() { return active_user_id_hash_; }
 100
 101   // Clears site data (cookies, history, etc) for signin profile.
 102   // Callback can be empty. Not thread-safe.
 103   void ClearSigninProfile(const base::Closure& on_clear_callback);
 104
 105   // Returns profile of the |user| if it is created and fully initialized.
 106   // Otherwise, returns NULL.
 107   Profile* GetProfileByUser(const user_manager::User* user);
 108
 109   // DEPRECATED
 110   // Returns profile of the |user| if user's profile is created and fully
 111   // initialized. Otherwise, if some user is active, returns his profile.
 112   // Otherwise, returns signin profile.
 113   // Behaviour of this function does not correspond to its name and can be
 114   // very surprising, that's why it should not be used anymore.
 115   // Use |GetProfileByUser| instead.
 116   // TODO(dzhioev): remove this method. http://crbug.com/361528
 117   Profile* GetProfileByUserUnsafe(const user_manager::User* user);
 118
 119   // Returns NULL if User is not created.
 120   const user_manager::User* GetUserByProfile(const Profile* profile) const;
 121   user_manager::User* GetUserByProfile(Profile* profile) const;
 122
 123   static std::string GetUserIdHashByUserIdForTesting(
 124       const std::string& user_id);
 125
 126  private:
 127   // TODO(nkostylev): Create a test API class that will be the only one allowed
 128   // to access private test methods.
 129   friend class CryptohomeAuthenticatorTest;
 130   friend class DeviceSettingsTestBase;
 131   friend class ExistingUserControllerTest;
 132   friend class extensions::ExtensionGarbageCollectorChromeOSUnitTest;
 133   friend class FakeChromeUserManager;
 134   friend class KioskTest;
 135   friend class MockUserManager;
 136   friend class MultiProfileUserControllerTest;
 137   friend class ProfileHelperTest;
 138   friend class ProfileListChromeOSTest;
 139   friend class SessionStateDelegateChromeOSTest;
 140   friend class SystemTrayDelegateChromeOSTest;
 141
 142   // Called when signin profile is cleared.
 143   void OnSigninProfileCleared();
 144
 145   // BrowsingDataRemover::Observer implementation:
 146   void OnBrowsingDataRemoverDone() override;
 147
 148   // OAuth2LoginManager::Observer overrides.
 149   void OnSessionRestoreStateChanged(
 150       Profile* user_profile,
 151       OAuth2LoginManager::SessionRestoreState state) override;
 152
 153   // user_manager::UserManager::UserSessionStateObserver implementation:
 154   void ActiveUserHashChanged(const std::string& hash) override;
 155
 156   // Associates |user| with profile with the same user_id,
 157   // for GetUserByProfile() testing.
 158   void SetProfileToUserMappingForTesting(user_manager::User* user);
 159
 160   // Enables/disables testing code path in GetUserByProfile() like
 161   // always return primary user (when always_return_primary_user_for_testing is
 162   // set).
 163   static void SetProfileToUserForTestingEnabled(bool enabled);
 164
 165   // Enables/disables testing GetUserByProfile() by always returning
 166   // primary user.
 167   static void SetAlwaysReturnPrimaryUserForTesting(bool value);
 168
 169   // Associates |profile| with |user|, for GetProfileByUser() testing.
 170   void SetUserToProfileMappingForTesting(const user_manager::User* user,
 171                                          Profile* profile);
 172
 173   // Identifies path to active user profile on Chrome OS.
 174   std::string active_user_id_hash_;
 175
 176   // List of callbacks called after signin profile clearance.
 177   std::vector<base::Closure> on_clear_callbacks_;
 178
 179   // Called when a single stage of profile clearing is finished.
 180   base::Closure on_clear_profile_stage_finished_;
 181
 182   // A currently running browsing data remover.
 183   BrowsingDataRemover* browsing_data_remover_;
 184
 185   // Used for testing by unit tests and FakeUserManager/MockUserManager.
 186   std::map<const user_manager::User*, Profile*> user_to_profile_for_testing_;
 187
 188   // When this list is not empty GetUserByProfile() will find user that has
 189   // the same user_id as |profile|->GetProfileName().
 190   user_manager::UserList user_list_for_testing_;
 191
 192   // If true testing code path is used in GetUserByProfile() even if
 193   // user_list_for_testing_ list is empty. In that case primary user will always
 194   // be returned.
 195   static bool enable_profile_to_user_testing;
 196
 197   // If true and enable_profile_to_user_testing is true then primary user will
 198   // always be returned by GetUserByProfile().
 199   static bool always_return_primary_user_for_testing;
 200
 201   base::WeakPtrFactory<ProfileHelper> weak_factory_;
 202
 203   DISALLOW_COPY_AND_ASSIGN(ProfileHelper);
 204 };
 205
 206 } // namespace chromeos
 207
 208 #endif  // CHROME_BROWSER_CHROMEOS_PROFILES_PROFILE_HELPER_H_