| // 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_JUMPLIST_WIN_H_ |
| #define CHROME_BROWSER_JUMPLIST_WIN_H_ |
| |
| #include <list> |
| #include <string> |
| #include <utility> |
| #include <vector> |
| |
| #include "base/files/file_path.h" |
| #include "base/memory/weak_ptr.h" |
| #include "base/synchronization/lock.h" |
| #include "base/task/cancelable_task_tracker.h" |
| #include "chrome/browser/history/history_service.h" |
| #include "chrome/browser/jumplist_updater_win.h" |
| #include "chrome/browser/prefs/incognito_mode_prefs.h" |
| #include "chrome/browser/sessions/tab_restore_service.h" |
| #include "chrome/browser/sessions/tab_restore_service_observer.h" |
| #include "components/history/core/browser/history_types.h" |
| #include "content/public/browser/browser_thread.h" |
| |
| namespace chrome { |
| struct FaviconImageResult; |
| } |
| |
| namespace content { |
| class NotificationRegistrar; |
| } |
| |
| class PageUsageData; |
| class PrefChangeRegistrar; |
| class Profile; |
| |
| // A class which implements an application JumpList. |
| // This class encapsulates operations required for updating an application |
| // JumpList: |
| // * Retrieving "Most Visited" pages from HistoryService; |
| // * Retrieving strings from the application resource; |
| // * Creating COM objects used by JumpList from PageUsageData objects; |
| // * Adding COM objects to JumpList, etc. |
| // |
| // This class observes the tabs and policies of the given Profile and updates |
| // the JumpList whenever a change is detected. |
| // |
| // Updating a JumpList requires some file operations and it is not good to |
| // update it in a UI thread. To solve this problem, this class posts to a |
| // runnable method when it actually updates a JumpList. |
| // |
| // Note. base::CancelableTaskTracker is not thread safe, so we |
| // always delete JumpList on UI thread (the same thread it got constructed on). |
| class JumpList : public TabRestoreServiceObserver, |
| public content::NotificationObserver, |
| public base::RefCountedThreadSafe< |
| JumpList, content::BrowserThread::DeleteOnUIThread> { |
| public: |
| explicit JumpList(Profile* profile); |
| |
| // NotificationObserver implementation. |
| virtual void Observe(int type, |
| const content::NotificationSource& source, |
| const content::NotificationDetails& details); |
| |
| // Observer callback for TabRestoreService::Observer to notify when a tab is |
| // added or removed. |
| virtual void TabRestoreServiceChanged(TabRestoreService* service); |
| |
| // Observer callback to notice when our associated TabRestoreService |
| // is destroyed. |
| virtual void TabRestoreServiceDestroyed(TabRestoreService* service); |
| |
| // Cancel a pending jumplist update. |
| void CancelPendingUpdate(); |
| |
| // Terminate the jumplist: cancel any pending updates and stop observing |
| // the Profile and its services. This must be called before the |profile_| |
| // is destroyed. |
| void Terminate(); |
| |
| // Returns true if the custom JumpList is enabled. |
| // The custom jumplist works only on Windows 7 and above. |
| static bool Enabled(); |
| |
| private: |
| friend struct content::BrowserThread::DeleteOnThread< |
| content::BrowserThread::UI>; |
| friend class base::DeleteHelper<JumpList>; |
| virtual ~JumpList(); |
| |
| // Creates a ShellLinkItem object from a tab (or a window) and add it to the |
| // given list. |
| // These functions are copied from the RecentlyClosedTabsHandler class for |
| // compatibility with the new-tab page. |
| bool AddTab(const TabRestoreService::Tab* tab, |
| ShellLinkItemList* list, |
| size_t max_items); |
| void AddWindow(const TabRestoreService::Window* window, |
| ShellLinkItemList* list, |
| size_t max_items); |
| |
| // Starts loading a favicon for each URL in |icon_urls_|. |
| // This function sends a query to HistoryService. |
| // When finishing loading all favicons, this function posts a task that |
| // decompresses collected favicons and updates a JumpList. |
| void StartLoadingFavicon(); |
| |
| // A callback function for HistoryService that notify when a requested favicon |
| // is available. |
| // To avoid file operations, this function just attaches the given data to |
| // a ShellLinkItem object. |
| void OnFaviconDataAvailable( |
| const favicon_base::FaviconImageResult& image_result); |
| |
| // Callback for TopSites that notifies when the "Most |
| // Visited" list is available. This function updates the ShellLinkItemList |
| // objects and send another query that retrieves a favicon for each URL in |
| // the list. |
| void OnMostVisitedURLsAvailable( |
| const history::MostVisitedURLList& data); |
| |
| // Callback for changes to the incognito mode availability pref. |
| void OnIncognitoAvailabilityChanged(); |
| |
| // Helper for RunUpdate() that determines its parameters. |
| void PostRunUpdate(); |
| |
| // Runnable method that updates the jumplist, once all the data |
| // has been fetched. |
| void RunUpdate(IncognitoModePrefs::Availability incognito_availability); |
| |
| // Helper method for RunUpdate to create icon files for the asynchrounously |
| // loaded icons. |
| void CreateIconFiles(const ShellLinkItemList& item_list); |
| |
| // Tracks FaviconService tasks. |
| base::CancelableTaskTracker cancelable_task_tracker_; |
| |
| // The Profile object is used to listen for events |
| Profile* profile_; |
| |
| // Lives on the UI thread. |
| scoped_ptr<content::NotificationRegistrar> registrar_; |
| scoped_ptr<PrefChangeRegistrar> pref_change_registrar_; |
| |
| // App id to associate with the jump list. |
| std::wstring app_id_; |
| |
| // The directory which contains JumpList icons. |
| base::FilePath icon_dir_; |
| |
| // Items in the "Most Visited" category of the application JumpList, |
| // protected by the list_lock_. |
| ShellLinkItemList most_visited_pages_; |
| |
| // Items in the "Recently Closed" category of the application JumpList, |
| // protected by the list_lock_. |
| ShellLinkItemList recently_closed_pages_; |
| |
| // A list of URLs we need to retrieve their favicons, |
| // protected by the list_lock_. |
| typedef std::pair<std::string, scoped_refptr<ShellLinkItem> > URLPair; |
| std::list<URLPair> icon_urls_; |
| |
| // Id of last favicon task. It's used to cancel current task if a new one |
| // comes in before it finishes. |
| base::CancelableTaskTracker::TaskId task_id_; |
| |
| // Lock for most_visited_pages_, recently_closed_pages_, icon_urls_ |
| // as they may be used by up to 3 threads. |
| base::Lock list_lock_; |
| |
| // For callbacks may be run after destruction. |
| base::WeakPtrFactory<JumpList> weak_ptr_factory_; |
| |
| DISALLOW_COPY_AND_ASSIGN(JumpList); |
| }; |
| |
| #endif // CHROME_BROWSER_JUMPLIST_WIN_H_ |