blob: 19a8246b43e5c8bbceced0907004cf44dfd80e34 [file] [log] [blame]
// Copyright (c) 2012 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 CHROME_BROWSER_PROFILES_PROFILE_INFO_CACHE_H_
#define CHROME_BROWSER_PROFILES_PROFILE_INFO_CACHE_H_
#include <stddef.h>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include "base/compiler_specific.h"
#include "base/files/file_path.h"
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/string16.h"
#include "base/values.h"
#include "chrome/browser/profiles/profile_attributes_entry.h"
#include "chrome/browser/profiles/profile_attributes_storage.h"
#include "chrome/browser/profiles/profile_info_cache_observer.h"
#include "chrome/browser/profiles/profile_info_interface.h"
namespace gfx {
class Image;
}
namespace base {
class DictionaryValue;
}
class PrefService;
class PrefRegistrySimple;
// This class saves various information about profiles to local preferences.
// This cache can be used to display a list of profiles without having to
// actually load the profiles from disk.
// The ProfileInfoInterface is being deprecated. Prefer using the
// ProfileAttributesStorage and avoid using the Get*AtIndex family of functions.
class ProfileInfoCache : public ProfileInfoInterface,
public ProfileAttributesStorage,
public base::SupportsWeakPtr<ProfileInfoCache> {
public:
ProfileInfoCache(PrefService* prefs, const base::FilePath& user_data_dir);
~ProfileInfoCache() override;
// If the |supervised_user_id| is non-empty, the profile will be marked to be
// omitted from the avatar-menu list on desktop versions. This is used while a
// supervised user is in the process of being registered with the server. Use
// SetIsOmittedProfileAtIndex() to clear the flag when the profile is ready to
// be shown in the menu.
// Deprecated. Use AddProfile instead.
void AddProfileToCache(const base::FilePath& profile_path,
const base::string16& name,
const std::string& gaia_id,
const base::string16& user_name,
size_t icon_index,
const std::string& supervised_user_id);
// Deprecated. Use RemoveProfile instead.
void DeleteProfileFromCache(const base::FilePath& profile_path);
// ProfileInfoInterface:
size_t GetNumberOfProfiles() const override;
// Don't cache this value and reuse, because resorting the menu could cause
// the item being referred to to change out from under you.
// Deprecated. Prefer using the ProfileAttributesStorage interface instead of
// directly referring to this implementation.
size_t GetIndexOfProfileWithPath(
const base::FilePath& profile_path) const override;
base::string16 GetNameOfProfileAtIndex(size_t index) const override;
// Will be removed SOON with ProfileInfoCache tests. Do not use!
base::FilePath GetPathOfProfileAtIndex(size_t index) const override;
// Will be removed SOON with ProfileInfoCache tests. Do not use!
base::string16 GetUserNameOfProfileAtIndex(size_t index) const override;
// Will be removed SOON with ProfileInfoCache tests. Do not use!
const gfx::Image& GetAvatarIconOfProfileAtIndex(size_t index) const override;
// Note that a return value of false could mean an error in collection or
// that there are currently no background apps running. However, the action
// which results is the same in both cases (thus far).
// Will be removed SOON with ProfileInfoCache tests. Do not use!
bool GetBackgroundStatusOfProfileAtIndex(size_t index) const override;
base::string16 GetGAIANameOfProfileAtIndex(size_t index) const override;
base::string16 GetGAIAGivenNameOfProfileAtIndex(size_t index) const override;
std::string GetGAIAIdOfProfileAtIndex(size_t index) const override;
// Returns the GAIA picture for the given profile. This may return NULL
// if the profile does not have a GAIA picture or if the picture must be
// loaded from disk.
const gfx::Image* GetGAIAPictureOfProfileAtIndex(size_t index) const override;
bool IsUsingGAIAPictureOfProfileAtIndex(size_t index) const override;
bool ProfileIsSupervisedAtIndex(size_t index) const override;
bool ProfileIsChildAtIndex(size_t index) const override;
bool ProfileIsLegacySupervisedAtIndex(size_t index) const override;
bool IsOmittedProfileAtIndex(size_t index) const override;
bool ProfileIsSigninRequiredAtIndex(size_t index) const override;
std::string GetSupervisedUserIdOfProfileAtIndex(size_t index) const override;
bool ProfileIsUsingDefaultNameAtIndex(size_t index) const override;
bool ProfileIsUsingDefaultAvatarAtIndex(size_t index) const override;
// Returns true if a GAIA picture has been loaded or has failed to load for
// profile at |index|.
bool IsGAIAPictureOfProfileAtIndexLoaded(size_t index) const;
// Will be removed SOON with ProfileInfoCache tests. Do not use!
size_t GetAvatarIconIndexOfProfileAtIndex(size_t index) const;
// Warning: This will re-sort profiles and thus may change indices!
void SetNameOfProfileAtIndex(size_t index, const base::string16& name);
void SetAuthInfoOfProfileAtIndex(size_t index,
const std::string& gaia_id,
const base::string16& user_name);
// Will be removed SOON with ProfileInfoCache tests. Do not use!
void SetAvatarIconOfProfileAtIndex(size_t index, size_t icon_index);
void SetIsOmittedProfileAtIndex(size_t index, bool is_omitted);
void SetSupervisedUserIdOfProfileAtIndex(size_t index, const std::string& id);
// Will be removed SOON with ProfileInfoCache tests. Do not use!
void SetBackgroundStatusOfProfileAtIndex(size_t index,
bool running_background_apps);
// Warning: This will re-sort profiles and thus may change indices!
void SetGAIANameOfProfileAtIndex(size_t index, const base::string16& name);
// Warning: This will re-sort profiles and thus may change indices!
void SetGAIAGivenNameOfProfileAtIndex(size_t index,
const base::string16& name);
void SetGAIAPictureOfProfileAtIndex(size_t index, const gfx::Image* image);
void SetIsUsingGAIAPictureOfProfileAtIndex(size_t index, bool value);
void SetProfileSigninRequiredAtIndex(size_t index, bool value);
void SetProfileIsUsingDefaultNameAtIndex(size_t index, bool value);
void SetProfileIsUsingDefaultAvatarAtIndex(size_t index, bool value);
// Notify IsSignedInRequired to all observer
void NotifyIsSigninRequiredChanged(const base::FilePath& profile_path);
const base::FilePath& GetUserDataDir() const;
// Register cache related preferences in Local State.
static void RegisterPrefs(PrefRegistrySimple* registry);
// ProfileAttributesStorage:
void AddProfile(const base::FilePath& profile_path,
const base::string16& name,
const std::string& gaia_id,
const base::string16& user_name,
size_t icon_index,
const std::string& supervised_user_id) override;
void RemoveProfileByAccountId(const AccountId& account_id) override;
void RemoveProfile(const base::FilePath& profile_path) override;
bool GetProfileAttributesWithPath(const base::FilePath& path,
ProfileAttributesEntry** entry) override;
private:
FRIEND_TEST_ALL_PREFIXES(ProfileAttributesStorageTest,
DownloadHighResAvatarTest);
const base::DictionaryValue* GetInfoForProfileAtIndex(size_t index) const;
// Saves the profile info to a cache.
void SetInfoForProfileAtIndex(size_t index,
std::unique_ptr<base::DictionaryValue> info);
std::string CacheKeyFromProfilePath(const base::FilePath& profile_path) const;
std::vector<std::string>::iterator FindPositionForProfile(
const std::string& search_key,
const base::string16& search_name);
// Updates the position of the profile at the given index so that the list
// of profiles is still sorted.
void UpdateSortForProfileIndex(size_t index);
// Will be removed SOON with ProfileInfoCache tests. Do not use!
// Loads or uses an already loaded high resolution image of the
// generic profile avatar.
const gfx::Image* GetHighResAvatarOfProfileAtIndex(size_t index) const;
// Migrate any legacy profile names ("First user", "Default Profile") to
// new style default names ("Person 1"), and download and high-res avatars
// used by the profiles.
void MigrateLegacyProfileNamesAndDownloadAvatars();
// Remove statistics values that have previously been stored and are not used
// anymore.
void RemoveDeprecatedStatistics();
std::vector<std::string> sorted_keys_;
DISALLOW_COPY_AND_ASSIGN(ProfileInfoCache);
};
#endif // CHROME_BROWSER_PROFILES_PROFILE_INFO_CACHE_H_