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