Code refactor(rename email to user_id in wallpaper_manager.h/cc)

chrome/browser/chromeos/login/wallpaper_manager.h

 // Copyright (c) 2013 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_CHROMEOS_LOGIN_WALLPAPER_MANAGER_H_
 #define CHROME_BROWSER_CHROMEOS_LOGIN_WALLPAPER_MANAGER_H_
 
 #include <deque>
 #include <string>
 #include <vector>
@@ skipping 79 matching lines @@
 
    private:
     WallpaperManager* wallpaper_manager_;  // not owned
 
     DISALLOW_COPY_AND_ASSIGN(TestApi);
   };
 
   class Observer {
    public:
     virtual ~Observer() {}
-    virtual void OnWallpaperAnimationFinished(const std::string& email) = 0;
+    virtual void OnWallpaperAnimationFinished(const std::string& user_id) = 0;
   };
 
   // This is "wallpaper either scheduled to load, or loading right now".
   //
   // While enqueued, it defines moment in the future, when it will be loaded.
   // Enqueued but not started request might be updated by subsequent load
   // request. Therefore it's created empty, and updated being enqueued.
   //
   // PendingWallpaper is owned by WallpaperManager, but reference to this object
   // is passed to other threads by PoskTask() calls, therefore it is
@@ skipping 96 matching lines @@
   // Initializes wallpaper. If logged in, loads user's wallpaper. If not logged
   // in, uses a solid color wallpaper. If logged in as a stub user, uses an
   // empty wallpaper.
   void InitializeWallpaper();
 
   // NotificationObserver overrides:
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
-  // Removes all |email| related wallpaper info and saved wallpapers.
-  void RemoveUserWallpaperInfo(const std::string& email);
+  // Removes all |user_id| related wallpaper info and saved wallpapers.
+  void RemoveUserWallpaperInfo(const std::string& user_id);
 
   // Resizes |wallpaper| to a resolution which is nearest to |preferred_width|
   // and |preferred_height| while maintaining aspect ratio.
   bool ResizeWallpaper(const UserImage& wallpaper,
                        ash::WallpaperLayout layout,
                        int preferred_width,
                        int preferred_height,
                        scoped_refptr<base::RefCountedBytes>* output);
 
   // Resizes |wallpaper| to a resolution which is nearest to |preferred_width|
@@ skipping 27 matching lines @@
 
   // Sets selected wallpaper information for |user_id| and saves it to Local
   // State if |is_persistent| is true.
   void SetUserWallpaperInfo(const std::string& user_id,
                             const WallpaperInfo& info,
                             bool is_persistent);
 
   // Sets last selected user on user pod row.
   void SetLastSelectedUser(const std::string& last_selected_user);
 
-  // Sets |email|'s wallpaper (asynchronously with zero delay).
-  void SetUserWallpaperNow(const std::string& email);
+  // Sets |user_id|'s wallpaper (asynchronously with zero delay).
+  void SetUserWallpaperNow(const std::string& user_id);
 
-  // Sets |email|'s wallpaper (asynchronously with default delay).
-  void SetUserWallpaperDelayed(const std::string& email);
+  // Sets |user_id|'s wallpaper (asynchronously with default delay).
+  void SetUserWallpaperDelayed(const std::string& user_id);
 
   // Sets wallpaper to |wallpaper| (asynchronously with zero delay).
-  void SetWallpaperFromImageSkia(const std::string& email,
+  void SetWallpaperFromImageSkia(const std::string& user_id,
                                  const gfx::ImageSkia& wallpaper,
                                  ash::WallpaperLayout layout);
 
   // Updates current wallpaper. It may switch the size of wallpaper based on the
   // current display's resolution. (asynchronously with zero delay)
   void UpdateWallpaper();
 
   // Adds given observer to the list.
   void AddObserver(Observer* observer);
 
   // Removes given observer from the list.
   void RemoveObserver(Observer* observer);
 
  private:
   friend class TestApi;
   friend class WallpaperManagerBrowserTest;
   typedef std::map<std::string, gfx::ImageSkia> CustomWallpaperMap;
 
   // Gets encoded wallpaper from cache. Returns true if success.
-  bool GetWallpaperFromCache(const std::string& email,
+  bool GetWallpaperFromCache(const std::string& user_id,
                              gfx::ImageSkia* wallpaper);
 
   // The number of wallpapers have loaded. For test only.
   int loaded_wallpapers() const { return loaded_wallpapers_; }
 
   // Cache some (or all) logged in users' wallpapers to memory at login
   // screen. It should not compete with first wallpaper loading when boot
   // up/initialize login WebUI page.
   // There are two ways the first wallpaper might be loaded:
   // 1. Loaded on boot. Login WebUI waits for it.
   // 2. When flag --disable-boot-animation is passed. Login WebUI is loaded
   // right away and in 500ms after. Wallpaper started to load.
   // For case 2, should_cache_wallpaper_ is used to indicate if we need to
   // cache wallpapers on wallpaper animation finished. The cache operation
   // should be only executed once.
   void CacheUsersWallpapers();
 
-  // Caches |email|'s wallpaper to memory.
-  void CacheUserWallpaper(const std::string& email);
+  // Caches |user_id|'s wallpaper to memory.
+  void CacheUserWallpaper(const std::string& user_id);
 
   // Clears all obsolete wallpaper prefs from old version wallpaper pickers.
   void ClearObsoleteWallpaperPrefs();
 
   // Deletes everything else except |path| in the same directory.
   void DeleteAllExcept(const base::FilePath& path);
 
   // Deletes a list of wallpaper files in |file_list|.
   void DeleteWallpaperInList(const std::vector<base::FilePath>& file_list);
 
-  // Deletes all |email| related custom wallpapers and directories.
-  void DeleteUserWallpapers(const std::string& email,
+  // Deletes all |user_id| related custom wallpapers and directories.
+  void DeleteUserWallpapers(const std::string& user_id,
                             const std::string& path_to_file);
 
   // Creates all new custom wallpaper directories for |user_id_hash| if not
   // exist.
   void EnsureCustomWallpaperDirectories(const std::string& user_id_hash);
 
   // Gets the CommandLine representing the current process's command line.
   CommandLine* GetComandLine();
 
   // Initialize wallpaper of registered device after device policy is trusted.
   // Note that before device is enrolled, it proceeds with untrusted setting.
   void InitializeRegisteredDeviceWallpaper();
 
-  // Loads |email|'s wallpaper. When |update_wallpaper| is true, sets wallpaper
-  // to the loaded wallpaper.
-  void LoadWallpaper(const std::string& email,
+  // Loads |user_id|'s wallpaper. When |update_wallpaper| is true, sets
+  // wallpaper to the loaded wallpaper.
+  void LoadWallpaper(const std::string& user_id,
                      const WallpaperInfo& info,
                      bool update_wallpaper,
                      MovableOnDestroyCallbackHolder on_finish);
 
-  // Moves custom wallpapers from |email| directory to |user_id_hash|
+  // Moves custom wallpapers from |user_id| directory to |user_id_hash|
   // directory.
-  void MoveCustomWallpapersOnWorker(const std::string& email,
+  void MoveCustomWallpapersOnWorker(const std::string& user_id,
                                     const std::string& user_id_hash);
 
   // Called when the original custom wallpaper is moved to the new place.
   // Updates the corresponding user wallpaper info.
-  void MoveCustomWallpapersSuccess(const std::string& email,
+  void MoveCustomWallpapersSuccess(const std::string& user_id,
                                    const std::string& user_id_hash);
 
   // Moves custom wallpaper to a new place. Email address was used as directory
   // name in the old system, this is not safe. New directory system uses
-  // user_id_hash instead of email. This must be called after user_id_hash is
+  // user_id_hash instead of user_id. This must be called after user_id_hash is
   // ready.
   void MoveLoggedInUserCustomWallpaper();
 
-  // Gets |email|'s custom wallpaper at |wallpaper_path|. Falls back on original
-  // custom wallpaper. When |update_wallpaper| is true, sets wallpaper to the
-  // loaded wallpaper. Must run on wallpaper sequenced worker thread.
-  void GetCustomWallpaperInternal(const std::string& email,
+  // Gets |user_id|'s custom wallpaper at |wallpaper_path|. Falls back on
+  // original custom wallpaper. When |update_wallpaper| is true, sets wallpaper
+  // to the loaded wallpaper. Must run on wallpaper sequenced worker thread.
+  void GetCustomWallpaperInternal(const std::string& user_id,
                                   const WallpaperInfo& info,
                                   const base::FilePath& wallpaper_path,
                                   bool update_wallpaper,
                                   MovableOnDestroyCallbackHolder on_finish);
 
-  // Gets wallpaper information of |email| from Local State or memory. Returns
+  // Gets wallpaper information of |user_id| from Local State or memory. Returns
   // false if wallpaper information is not found.
-  bool GetUserWallpaperInfo(const std::string& email, WallpaperInfo* info);
+  bool GetUserWallpaperInfo(const std::string& user_id, WallpaperInfo* info);
 
   // Sets wallpaper to the decoded wallpaper if |update_wallpaper| is true.
   // Otherwise, cache wallpaper to memory if not logged in.
-  void OnWallpaperDecoded(const std::string& email,
+  void OnWallpaperDecoded(const std::string& user_id,
                           ash::WallpaperLayout layout,
                           bool update_wallpaper,
                           MovableOnDestroyCallbackHolder on_finish,
                           const UserImage& wallpaper);
 
   // Generates thumbnail of custom wallpaper on wallpaper sequenced worker
   // thread. If |persistent| is true, saves original custom image and resized
   // images to disk.
   void ProcessCustomWallpaper(const std::string& user_id_hash,
                               bool persistent,
                               const WallpaperInfo& info,
                               scoped_ptr<gfx::ImageSkia> image,
                               const UserImage::RawImage& raw_image);
 
   // Record data for User Metrics Analysis.
   void RecordUma(User::WallpaperType type, int index);
 
   // Saves original custom wallpaper to |path| (absolute path) on filesystem
   // and starts resizing operation of the custom wallpaper if necessary.
   void SaveCustomWallpaper(const std::string& user_id_hash,
                            const base::FilePath& path,
                            ash::WallpaperLayout layout,
                            const UserImage& wallpaper);
 
   // Saves wallpaper image raw |data| to |path| (absolute path) in file system.
   void SaveWallpaperInternal(const base::FilePath& path, const char* data,
                              int size);
 
   // Creates new PendingWallpaper request (or updates currently pending).
-  void ScheduleSetUserWallpaper(const std::string& email, bool delayed);
+  void ScheduleSetUserWallpaper(const std::string& user_id, bool delayed);
 
   // Sets wallpaper to default.
   void DoSetDefaultWallpaper(
       const std::string& user_id,
       MovableOnDestroyCallbackHolder on_finish);
 
   // Starts to load wallpaper at |wallpaper_path|. If |wallpaper_path| is the
   // same as |current_wallpaper_path_|, do nothing. Must be called on UI thread.
-  void StartLoad(const std::string& email,
+  void StartLoad(const std::string& user_id,
                  const WallpaperInfo& info,
                  bool update_wallpaper,
                  const base::FilePath& wallpaper_path,
                  MovableOnDestroyCallbackHolder on_finish);
 
   // After completed load operation, update average load time.
   void SaveLastLoadTime(const base::TimeDelta elapsed);
 
   // Notify all registed observers.
   void NotifyAnimationFinished();
@@ skipping 65 matching lines @@
   // All pending will be finally deleted on destroy.
   typedef std::vector<scoped_refptr<PendingWallpaper> > PendingList;
   PendingList loading_;
 
   DISALLOW_COPY_AND_ASSIGN(WallpaperManager);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROME_BROWSER_CHROMEOS_LOGIN_WALLPAPER_MANAGER_H_