chrome/browser/jumplist_win.h

   1 // Copyright (c) 2012 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_JUMPLIST_WIN_H_
   6 #define CHROME_BROWSER_JUMPLIST_WIN_H_
   7
   8 #include <list>
   9 #include <string>
  10 #include <utility>
  11 #include <vector>
  12
  13 #include "base/files/file_path.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/synchronization/lock.h"
  16 #include "base/task/cancelable_task_tracker.h"
  17 #include "chrome/browser/history/history_service.h"
  18 #include "chrome/browser/jumplist_updater_win.h"
  19 #include "chrome/browser/prefs/incognito_mode_prefs.h"
  20 #include "chrome/browser/profiles/avatar_menu.h"
  21 #include "chrome/browser/profiles/avatar_menu_observer.h"
  22 #include "chrome/browser/sessions/tab_restore_service.h"
  23 #include "chrome/browser/sessions/tab_restore_service_observer.h"
  24 #include "components/history/core/browser/history_types.h"
  25 #include "content/public/browser/browser_thread.h"
  26
  27 namespace chrome {
  28 struct FaviconImageResult;
  29 }
  30
  31 namespace content {
  32 class NotificationRegistrar;
  33 }
  34
  35 class PageUsageData;
  36 class PrefChangeRegistrar;
  37 class Profile;
  38
  39 // A class which implements an application JumpList.
  40 // This class encapsulates operations required for updating an application
  41 // JumpList:
  42 // * Retrieving "Most Visited" pages from HistoryService;
  43 // * Retrieving strings from the application resource;
  44 // * Creating COM objects used by JumpList from PageUsageData objects;
  45 // * Adding COM objects to JumpList, etc.
  46 //
  47 // This class observes the tabs and policies of the given Profile and updates
  48 // the JumpList whenever a change is detected.
  49 //
  50 // Updating a JumpList requires some file operations and it is not good to
  51 // update it in a UI thread. To solve this problem, this class posts to a
  52 // runnable method when it actually updates a JumpList.
  53 //
  54 // Note. base::CancelableTaskTracker is not thread safe, so we
  55 // always delete JumpList on UI thread (the same thread it got constructed on).
  56 class JumpList : public TabRestoreServiceObserver,
  57                  public content::NotificationObserver,
  58                  public AvatarMenuObserver,
  59                  public base::RefCountedThreadSafe<
  60                      JumpList, content::BrowserThread::DeleteOnUIThread> {
  61  public:
  62   explicit JumpList(Profile* profile);
  63
  64   // NotificationObserver implementation.
  65   void Observe(int type,
  66                const content::NotificationSource& source,
  67                const content::NotificationDetails& details) override;
  68
  69   // Observer callback for TabRestoreService::Observer to notify when a tab is
  70   // added or removed.
  71   void TabRestoreServiceChanged(TabRestoreService* service) override;
  72
  73   // Observer callback to notice when our associated TabRestoreService
  74   // is destroyed.
  75   void TabRestoreServiceDestroyed(TabRestoreService* service) override;
  76
  77   // Overridden from AvatarMenuObserver:
  78   void OnAvatarMenuChanged(AvatarMenu* avatar_menu) override;
  79
  80   // Cancel a pending jumplist update.
  81   void CancelPendingUpdate();
  82
  83   // Terminate the jumplist: cancel any pending updates and stop observing
  84   // the Profile and its services. This must be called before the |profile_|
  85   // is destroyed.
  86   void Terminate();
  87
  88   // Returns true if the custom JumpList is enabled.
  89   // The custom jumplist works only on Windows 7 and above.
  90   static bool Enabled();
  91
  92  private:
  93   friend struct content::BrowserThread::DeleteOnThread<
  94       content::BrowserThread::UI>;
  95   friend class base::DeleteHelper<JumpList>;
  96   virtual ~JumpList();
  97
  98   // Creates a ShellLinkItem object from a tab (or a window) and add it to the
  99   // given list.
 100   // These functions are copied from the RecentlyClosedTabsHandler class for
 101   // compatibility with the new-tab page.
 102   bool AddTab(const TabRestoreService::Tab* tab,
 103               ShellLinkItemList* list,
 104               size_t max_items);
 105   void AddWindow(const TabRestoreService::Window* window,
 106                  ShellLinkItemList* list,
 107                  size_t max_items);
 108
 109   // Starts loading a favicon for each URL in |icon_urls_|.
 110   // This function sends a query to HistoryService.
 111   // When finishing loading all favicons, this function posts a task that
 112   // decompresses collected favicons and updates a JumpList.
 113   void StartLoadingFavicon();
 114
 115   // A callback function for HistoryService that notify when a requested favicon
 116   // is available.
 117   // To avoid file operations, this function just attaches the given data to
 118   // a ShellLinkItem object.
 119   void OnFaviconDataAvailable(
 120       const favicon_base::FaviconImageResult& image_result);
 121
 122   // Callback for TopSites that notifies when the "Most
 123   // Visited" list is available. This function updates the ShellLinkItemList
 124   // objects and send another query that retrieves a favicon for each URL in
 125   // the list.
 126   void OnMostVisitedURLsAvailable(
 127       const history::MostVisitedURLList& data);
 128
 129   // Callback for changes to the incognito mode availability pref.
 130   void OnIncognitoAvailabilityChanged();
 131
 132   // Helper for RunUpdate() that determines its parameters.
 133   void PostRunUpdate();
 134
 135   // Runnable method that updates the jumplist, once all the data
 136   // has been fetched.
 137   void RunUpdateOnFileThread(
 138       IncognitoModePrefs::Availability incognito_availability);
 139
 140   // Helper method for RunUpdate to create icon files for the asynchrounously
 141   // loaded icons.
 142   void CreateIconFiles(const ShellLinkItemList& item_list);
 143
 144   // Called when the list of Profiles has changed. This function updates the
 145   // |profile_switcher_| ShellLinkItemList.
 146   void UpdateProfileSwitcher();
 147
 148   // Tracks FaviconService tasks.
 149   base::CancelableTaskTracker cancelable_task_tracker_;
 150
 151   // The Profile object is used to listen for events
 152   Profile* profile_;
 153
 154   // Lives on the UI thread.
 155   scoped_ptr<content::NotificationRegistrar> registrar_;
 156   scoped_ptr<PrefChangeRegistrar> pref_change_registrar_;
 157
 158   // App id to associate with the jump list.
 159   std::wstring app_id_;
 160
 161   // The directory which contains JumpList icons.
 162   base::FilePath icon_dir_;
 163
 164   // Items in the "Most Visited" category of the application JumpList,
 165   // protected by the list_lock_.
 166   ShellLinkItemList most_visited_pages_;
 167
 168   // Items in the "Recently Closed" category of the application JumpList,
 169   // protected by the list_lock_.
 170   ShellLinkItemList recently_closed_pages_;
 171
 172   // Items in the "People" category of the application JumpList, protected
 173   // by the list_lock_.
 174   ShellLinkItemList profile_switcher_;
 175
 176   // A list of URLs we need to retrieve their favicons,
 177   // protected by the list_lock_.
 178   typedef std::pair<std::string, scoped_refptr<ShellLinkItem> > URLPair;
 179   std::list<URLPair> icon_urls_;
 180
 181   // Id of last favicon task. It's used to cancel current task if a new one
 182   // comes in before it finishes.
 183   base::CancelableTaskTracker::TaskId task_id_;
 184
 185   // Lock for most_visited_pages_, recently_closed_pages_, icon_urls_
 186   // as they may be used by up to 3 threads.
 187   base::Lock list_lock_;
 188
 189   // For callbacks may be run after destruction.
 190   base::WeakPtrFactory<JumpList> weak_ptr_factory_;
 191
 192   // Contains data about existing Profiles.
 193   scoped_ptr<AvatarMenu> avatar_menu_;
 194
 195   // Whether the experiment that is replacing "Most Visited" category with a
 196   // "People" category is enabled.
 197   bool use_profiles_category_;
 198
 199   DISALLOW_COPY_AND_ASSIGN(JumpList);
 200 };
 201
 202 #endif  // CHROME_BROWSER_JUMPLIST_WIN_H_