Improve the ProfileInfoCache API.

chrome/browser/profiles/profile_info_cache.h

 // 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 <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
+#include "base/containers/scoped_ptr_hash_map.h"
 #include "base/files/file_path.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/strings/string16.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;
 class ProfileAvatarDownloader;
 
 // 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;
   base::string16 GetShortcutNameOfProfileAtIndex(size_t index) const override;
   base::FilePath GetPathOfProfileAtIndex(size_t index) const override;
   base::Time GetProfileActiveTimeAtIndex(size_t index) const override;
   base::string16 GetUserNameOfProfileAtIndex(size_t index) const override;
   const gfx::Image& GetAvatarIconOfProfileAtIndex(size_t index) override;
   std::string GetLocalAuthCredentialsOfProfileAtIndex(
       size_t index) const override;
@@ skipping 85 matching lines @@
                              const base::FilePath& profile_path);
 
   void AddObserver(ProfileInfoCacheObserver* obs);
   void RemoveObserver(ProfileInfoCacheObserver* obs);
 
   void set_disable_avatar_download_for_testing(
       bool disable_avatar_download_for_testing) {
     disable_avatar_download_for_testing_ = disable_avatar_download_for_testing;
   }
 
+  // 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 RemoveProfile(const base::FilePath& profile_path) override;
+  // Returns a vector containing one attributes entry per known profile. They
+  // are not sorted in any particular order.
+  std::vector<ProfileAttributesEntry*> GetAllProfilesAttributes() override;
+  bool GetProfileAttributesWithPath(
+      const base::FilePath& path,
+      ProfileAttributesEntry** entry) override;
+
  private:
   FRIEND_TEST_ALL_PREFIXES(ProfileInfoCacheTest, DownloadHighResAvatarTest);
   FRIEND_TEST_ALL_PREFIXES(ProfileInfoCacheTest,
                            NothingToDownloadHighResAvatarTest);
 
   const base::DictionaryValue* GetInfoForProfileAtIndex(size_t index) const;
   // Saves the profile info to a cache and takes ownership of |info|.
   void SetInfoForProfileAtIndex(size_t index, base::DictionaryValue* info);
   std::string CacheKeyFromProfilePath(const base::FilePath& profile_path) const;
   std::vector<std::string>::iterator FindPositionForProfile(
@@ skipping 39 matching lines @@
   void OnAvatarPictureSaved(const std::string& file_name,
                             const base::FilePath& profile_path);
 
   // 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();
 
   PrefService* prefs_;
   std::vector<std::string> sorted_keys_;
+  base::ScopedPtrHashMap<base::FilePath, scoped_ptr<ProfileAttributesEntry> >
+      profile_attributes_entries_;
   base::FilePath user_data_dir_;
 
   mutable base::ObserverList<ProfileInfoCacheObserver> observer_list_;
 
   // A cache of gaia/high res avatar profile pictures. This cache is updated
   // lazily so it needs to be mutable.
   mutable std::map<std::string, gfx::Image*> cached_avatar_images_;
   // Marks a profile picture as loading from disk. This prevents a picture from
   // loading multiple times.
   mutable std::map<std::string, bool> cached_avatar_images_loading_;
 
   // Map of profile pictures currently being downloaded from the remote
   // location and the ProfileAvatarDownloader instances downloading them.
   // This prevents a picture from being downloaded multiple times. The
   // ProfileAvatarDownloader instances are deleted when the download completes
   // or when the ProfileInfoCache is destroyed.
   std::map<std::string, ProfileAvatarDownloader*>
       avatar_images_downloads_in_progress_;
 
   // Determines of the ProfileAvatarDownloader should be created and executed
   // or not. Only set to true for tests.
   bool disable_avatar_download_for_testing_;
 
   DISALLOW_COPY_AND_ASSIGN(ProfileInfoCache);
 };
 
 #endif  // CHROME_BROWSER_PROFILES_PROFILE_INFO_CACHE_H_