OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_JUMPLIST_WIN_H_ | 5 #ifndef CHROME_BROWSER_JUMPLIST_WIN_H_ |
6 #define CHROME_BROWSER_JUMPLIST_WIN_H_ | 6 #define CHROME_BROWSER_JUMPLIST_WIN_H_ |
7 | 7 |
8 #include <list> | 8 #include <list> |
9 #include <string> | 9 #include <string> |
10 #include <utility> | 10 #include <utility> |
11 #include <vector> | 11 #include <vector> |
12 | 12 |
13 #include "base/files/file_path.h" | 13 #include "base/files/file_path.h" |
14 #include "base/memory/weak_ptr.h" | 14 #include "base/memory/weak_ptr.h" |
15 #include "base/synchronization/lock.h" | 15 #include "base/synchronization/lock.h" |
16 #include "base/task/cancelable_task_tracker.h" | 16 #include "base/task/cancelable_task_tracker.h" |
17 #include "chrome/browser/history/history_service.h" | 17 #include "chrome/browser/history/history_service.h" |
18 #include "chrome/browser/history/history_types.h" | 18 #include "chrome/browser/history/history_types.h" |
19 #include "chrome/browser/jumplist_updater_win.h" | 19 #include "chrome/browser/jumplist_updater_win.h" |
| 20 #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.h" |
21 #include "chrome/browser/sessions/tab_restore_service_observer.h" | 22 #include "chrome/browser/sessions/tab_restore_service_observer.h" |
22 #include "content/public/browser/browser_thread.h" | 23 #include "content/public/browser/browser_thread.h" |
23 | 24 |
24 namespace chrome { | 25 namespace chrome { |
25 struct FaviconImageResult; | 26 struct FaviconImageResult; |
26 } | 27 } |
27 | 28 |
28 namespace content { | 29 namespace content { |
29 class NotificationRegistrar; | 30 class NotificationRegistrar; |
30 } | 31 } |
31 | 32 |
| 33 class PageUsageData; |
| 34 class PrefChangeRegistrar; |
32 class Profile; | 35 class Profile; |
33 class PageUsageData; | |
34 | 36 |
35 // A class which implements an application JumpList. | 37 // A class which implements an application JumpList. |
36 // This class encapsulates operations required for updating an application | 38 // This class encapsulates operations required for updating an application |
37 // JumpList: | 39 // JumpList: |
38 // * Retrieving "Most Visited" pages from HistoryService; | 40 // * Retrieving "Most Visited" pages from HistoryService; |
39 // * Retrieving strings from the application resource; | 41 // * Retrieving strings from the application resource; |
40 // * Creatng COM objects used by JumpList from PageUsageData objects; | 42 // * Creating COM objects used by JumpList from PageUsageData objects; |
41 // * Adding COM objects to JumpList, etc. | 43 // * Adding COM objects to JumpList, etc. |
42 // | 44 // |
43 // This class also implements TabRestoreServiceObserver. So, once we call | 45 // This class observes the tabs and policies of the given Profile and updates |
44 // AddObserver() and register this class as an observer, it automatically | 46 // the JumpList whenever a change is detected. |
45 // updates a JumpList when a tab is added or removed. | |
46 // | 47 // |
47 // Updating a JumpList requires some file operations and it is not good to | 48 // Updating a JumpList requires some file operations and it is not good to |
48 // update it in a UI thread. To solve this problem, this class posts to a | 49 // update it in a UI thread. To solve this problem, this class posts to a |
49 // runnable method when it actually updates a JumpList. | 50 // runnable method when it actually updates a JumpList. |
50 // | 51 // |
51 // Note. base::CancelableTaskTracker is not thread safe, so we | 52 // Note. base::CancelableTaskTracker is not thread safe, so we |
52 // always delete JumpList on UI thread (the same thread it got constructed on). | 53 // always delete JumpList on UI thread (the same thread it got constructed on). |
53 class JumpList : public TabRestoreServiceObserver, | 54 class JumpList : public TabRestoreServiceObserver, |
54 public content::NotificationObserver, | 55 public content::NotificationObserver, |
55 public base::RefCountedThreadSafe< | 56 public base::RefCountedThreadSafe< |
56 JumpList, content::BrowserThread::DeleteOnUIThread> { | 57 JumpList, content::BrowserThread::DeleteOnUIThread> { |
57 public: | 58 public: |
58 JumpList(); | 59 explicit JumpList(Profile* profile); |
59 | 60 |
60 // NotificationObserver implementation. | 61 // NotificationObserver implementation. |
61 virtual void Observe(int type, | 62 virtual void Observe(int type, |
62 const content::NotificationSource& source, | 63 const content::NotificationSource& source, |
63 const content::NotificationDetails& details); | 64 const content::NotificationDetails& details); |
64 | 65 |
65 // Registers (or unregisters) this object as an observer. | |
66 // When the TabRestoreService object notifies the tab status is changed, this | |
67 // class automatically updates an application JumpList. | |
68 bool AddObserver(Profile* profile); | |
69 void RemoveObserver(); | |
70 | |
71 // Observer callback for TabRestoreService::Observer to notify when a tab is | 66 // Observer callback for TabRestoreService::Observer to notify when a tab is |
72 // added or removed. | 67 // added or removed. |
73 virtual void TabRestoreServiceChanged(TabRestoreService* service); | 68 virtual void TabRestoreServiceChanged(TabRestoreService* service); |
74 | 69 |
75 // Observer callback to notice when our associated TabRestoreService | 70 // Observer callback to notice when our associated TabRestoreService |
76 // is destroyed. | 71 // is destroyed. |
77 virtual void TabRestoreServiceDestroyed(TabRestoreService* service); | 72 virtual void TabRestoreServiceDestroyed(TabRestoreService* service); |
78 | 73 |
79 // Cancel a pending jumplist update. | 74 // Cancel a pending jumplist update. |
80 void CancelPendingUpdate(); | 75 void CancelPendingUpdate(); |
81 | 76 |
82 // Terminate the jumplist: cancel any pending updates and remove observer | 77 // Terminate the jumplist: cancel any pending updates and stop observing |
83 // from TabRestoreService. This must be called before the profile provided | 78 // the Profile and its services. This must be called before the |profile_| |
84 // in the AddObserver method is destroyed. | 79 // is destroyed. |
85 void Terminate(); | 80 void Terminate(); |
86 | 81 |
87 // Returns true if the custom JumpList is enabled. | 82 // Returns true if the custom JumpList is enabled. |
88 // The custom jumplist works only on Windows 7 and above. | 83 // The custom jumplist works only on Windows 7 and above. |
89 static bool Enabled(); | 84 static bool Enabled(); |
90 | 85 |
91 protected: | 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 | 92 // Creates a ShellLinkItem object from a tab (or a window) and add it to the |
93 // given list. | 93 // given list. |
94 // These functions are copied from the RecentlyClosedTabsHandler class for | 94 // These functions are copied from the RecentlyClosedTabsHandler class for |
95 // compatibility with the new-tab page. | 95 // compatibility with the new-tab page. |
96 bool AddTab(const TabRestoreService::Tab* tab, | 96 bool AddTab(const TabRestoreService::Tab* tab, |
97 ShellLinkItemList* list, | 97 ShellLinkItemList* list, |
98 size_t max_items); | 98 size_t max_items); |
99 void AddWindow(const TabRestoreService::Window* window, | 99 void AddWindow(const TabRestoreService::Window* window, |
100 ShellLinkItemList* list, | 100 ShellLinkItemList* list, |
101 size_t max_items); | 101 size_t max_items); |
(...skipping 11 matching lines...) Expand all Loading... |
113 void OnFaviconDataAvailable( | 113 void OnFaviconDataAvailable( |
114 const favicon_base::FaviconImageResult& image_result); | 114 const favicon_base::FaviconImageResult& image_result); |
115 | 115 |
116 // Callback for TopSites that notifies when the "Most | 116 // Callback for TopSites that notifies when the "Most |
117 // Visited" list is available. This function updates the ShellLinkItemList | 117 // Visited" list is available. This function updates the ShellLinkItemList |
118 // objects and send another query that retrieves a favicon for each URL in | 118 // objects and send another query that retrieves a favicon for each URL in |
119 // the list. | 119 // the list. |
120 void OnMostVisitedURLsAvailable( | 120 void OnMostVisitedURLsAvailable( |
121 const history::MostVisitedURLList& data); | 121 const history::MostVisitedURLList& data); |
122 | 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 |
123 // Runnable method that updates the jumplist, once all the data | 129 // Runnable method that updates the jumplist, once all the data |
124 // has been fetched. | 130 // has been fetched. |
125 void RunUpdate(); | 131 void RunUpdate(IncognitoModePrefs::Availability incognito_availability); |
126 | 132 |
127 // Helper method for RunUpdate to create icon files for the asynchrounously | 133 // Helper method for RunUpdate to create icon files for the asynchrounously |
128 // loaded icons. | 134 // loaded icons. |
129 void CreateIconFiles(const ShellLinkItemList& item_list); | 135 void CreateIconFiles(const ShellLinkItemList& item_list); |
130 | 136 |
131 private: | |
132 friend struct content::BrowserThread::DeleteOnThread< | |
133 content::BrowserThread::UI>; | |
134 friend class base::DeleteHelper<JumpList>; | |
135 ~JumpList(); | |
136 | |
137 // For callbacks may be run after destruction. | 137 // For callbacks may be run after destruction. |
138 base::WeakPtrFactory<JumpList> weak_ptr_factory_; | 138 base::WeakPtrFactory<JumpList> weak_ptr_factory_; |
139 | 139 |
140 // Tracks FaviconService tasks. | 140 // Tracks FaviconService tasks. |
141 base::CancelableTaskTracker cancelable_task_tracker_; | 141 base::CancelableTaskTracker cancelable_task_tracker_; |
142 | 142 |
143 // The Profile object is used to listen for events | 143 // The Profile object is used to listen for events |
144 Profile* profile_; | 144 Profile* profile_; |
145 | 145 |
146 // Lives on the UI thread. | 146 // Lives on the UI thread. |
147 scoped_ptr<content::NotificationRegistrar> registrar_; | 147 scoped_ptr<content::NotificationRegistrar> registrar_; |
| 148 scoped_ptr<PrefChangeRegistrar> pref_change_registrar_; |
148 | 149 |
149 // App id to associate with the jump list. | 150 // App id to associate with the jump list. |
150 std::wstring app_id_; | 151 std::wstring app_id_; |
151 | 152 |
152 // The directory which contains JumpList icons. | 153 // The directory which contains JumpList icons. |
153 base::FilePath icon_dir_; | 154 base::FilePath icon_dir_; |
154 | 155 |
155 // Items in the "Most Visited" category of the application JumpList, | 156 // Items in the "Most Visited" category of the application JumpList, |
156 // protected by the list_lock_. | 157 // protected by the list_lock_. |
157 ShellLinkItemList most_visited_pages_; | 158 ShellLinkItemList most_visited_pages_; |
(...skipping 12 matching lines...) Expand all Loading... |
170 base::CancelableTaskTracker::TaskId task_id_; | 171 base::CancelableTaskTracker::TaskId task_id_; |
171 | 172 |
172 // Lock for most_visited_pages_, recently_closed_pages_, icon_urls_ | 173 // Lock for most_visited_pages_, recently_closed_pages_, icon_urls_ |
173 // as they may be used by up to 3 threads. | 174 // as they may be used by up to 3 threads. |
174 base::Lock list_lock_; | 175 base::Lock list_lock_; |
175 | 176 |
176 DISALLOW_COPY_AND_ASSIGN(JumpList); | 177 DISALLOW_COPY_AND_ASSIGN(JumpList); |
177 }; | 178 }; |
178 | 179 |
179 #endif // CHROME_BROWSER_JUMPLIST_WIN_H_ | 180 #endif // CHROME_BROWSER_JUMPLIST_WIN_H_ |
OLD | NEW |