Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1007)

Unified Diff: chrome/browser/jumplist_win.cc

Issue 2098713003: Moved a bunch of win-specific files to the new win folder in chrome/browser (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Rebase Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/browser/jumplist_win.h ('k') | chrome/browser/private_working_set_snapshot.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/browser/jumplist_win.cc
diff --git a/chrome/browser/jumplist_win.cc b/chrome/browser/jumplist_win.cc
deleted file mode 100644
index 57dccaf49b5f304ffc0df24789d11c1a18013728..0000000000000000000000000000000000000000
--- a/chrome/browser/jumplist_win.cc
+++ /dev/null
@@ -1,590 +0,0 @@
-// Copyright 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.
-
-#include "chrome/browser/jumplist_win.h"
-
-#include "base/bind.h"
-#include "base/bind_helpers.h"
-#include "base/command_line.h"
-#include "base/files/file_util.h"
-#include "base/macros.h"
-#include "base/path_service.h"
-#include "base/strings/string_util.h"
-#include "base/strings/utf_string_conversions.h"
-#include "base/threading/thread.h"
-#include "base/trace_event/trace_event.h"
-#include "chrome/browser/chrome_notification_types.h"
-#include "chrome/browser/favicon/favicon_service_factory.h"
-#include "chrome/browser/history/top_sites_factory.h"
-#include "chrome/browser/metrics/jumplist_metrics_win.h"
-#include "chrome/browser/profiles/profile.h"
-#include "chrome/browser/sessions/tab_restore_service_factory.h"
-#include "chrome/browser/shell_integration_win.h"
-#include "chrome/common/chrome_constants.h"
-#include "chrome/common/chrome_switches.h"
-#include "chrome/common/pref_names.h"
-#include "chrome/common/url_constants.h"
-#include "chrome/grit/generated_resources.h"
-#include "components/favicon/core/favicon_service.h"
-#include "components/favicon_base/favicon_types.h"
-#include "components/history/core/browser/history_service.h"
-#include "components/history/core/browser/page_usage_data.h"
-#include "components/history/core/browser/top_sites.h"
-#include "components/prefs/pref_change_registrar.h"
-#include "components/sessions/core/session_types.h"
-#include "components/sessions/core/tab_restore_service.h"
-#include "components/strings/grit/components_strings.h"
-#include "content/public/browser/browser_thread.h"
-#include "content/public/browser/notification_registrar.h"
-#include "content/public/browser/notification_source.h"
-#include "ui/base/l10n/l10n_util.h"
-#include "ui/gfx/codec/png_codec.h"
-#include "ui/gfx/favicon_size.h"
-#include "ui/gfx/icon_util.h"
-#include "ui/gfx/image/image_family.h"
-#include "url/gurl.h"
-
-using content::BrowserThread;
-using JumpListData = JumpList::JumpListData;
-
-namespace {
-
-// Delay jumplist updates to allow collapsing of redundant update requests.
-const int kDelayForJumplistUpdateInMS = 3500;
-
-// Append the common switches to each shell link.
-void AppendCommonSwitches(ShellLinkItem* shell_link) {
- const char* kSwitchNames[] = { switches::kUserDataDir };
- const base::CommandLine& command_line =
- *base::CommandLine::ForCurrentProcess();
- shell_link->GetCommandLine()->CopySwitchesFrom(command_line,
- kSwitchNames,
- arraysize(kSwitchNames));
-}
-
-// Create a ShellLinkItem preloaded with common switches.
-scoped_refptr<ShellLinkItem> CreateShellLink() {
- scoped_refptr<ShellLinkItem> link(new ShellLinkItem);
- AppendCommonSwitches(link.get());
- return link;
-}
-
-// Creates a temporary icon file to be shown in JumpList.
-bool CreateIconFile(const SkBitmap& bitmap,
- const base::FilePath& icon_dir,
- base::FilePath* icon_path) {
- // Retrieve the path to a temporary file.
- // We don't have to care about the extension of this temporary file because
- // JumpList does not care about it.
- base::FilePath path;
- if (!base::CreateTemporaryFileInDir(icon_dir, &path))
- return false;
-
- // Create an icon file from the favicon attached to the given |page|, and
- // save it as the temporary file.
- gfx::ImageFamily image_family;
- image_family.Add(gfx::Image::CreateFrom1xBitmap(bitmap));
- if (!IconUtil::CreateIconFileFromImageFamily(image_family, path,
- IconUtil::NORMAL_WRITE))
- return false;
-
- // Add this icon file to the list and return its absolute path.
- // The IShellLink::SetIcon() function needs the absolute path to an icon.
- *icon_path = path;
- return true;
-}
-
-// Helper method for RunUpdate to create icon files for the asynchrounously
-// loaded icons.
-void CreateIconFiles(const base::FilePath& icon_dir,
- const ShellLinkItemList& item_list) {
- for (ShellLinkItemList::const_iterator item = item_list.begin();
- item != item_list.end(); ++item) {
- base::FilePath icon_path;
- if (CreateIconFile((*item)->icon_data(), icon_dir, &icon_path))
- (*item)->set_icon(icon_path.value(), 0);
- }
-}
-
-// Updates the "Tasks" category of the JumpList.
-bool UpdateTaskCategory(
- JumpListUpdater* jumplist_updater,
- IncognitoModePrefs::Availability incognito_availability) {
- base::FilePath chrome_path;
- if (!PathService::Get(base::FILE_EXE, &chrome_path))
- return false;
-
- ShellLinkItemList items;
-
- // Create an IShellLink object which launches Chrome, and add it to the
- // collection. We use our application icon as the icon for this item.
- // We remove '&' characters from this string so we can share it with our
- // system menu.
- if (incognito_availability != IncognitoModePrefs::FORCED) {
- scoped_refptr<ShellLinkItem> chrome = CreateShellLink();
- base::string16 chrome_title = l10n_util::GetStringUTF16(IDS_NEW_WINDOW);
- base::ReplaceSubstringsAfterOffset(
- &chrome_title, 0, L"&", base::StringPiece16());
- chrome->set_title(chrome_title);
- chrome->set_icon(chrome_path.value(), 0);
- items.push_back(chrome);
- }
-
- // Create an IShellLink object which launches Chrome in incognito mode, and
- // add it to the collection. We use our application icon as the icon for
- // this item.
- if (incognito_availability != IncognitoModePrefs::DISABLED) {
- scoped_refptr<ShellLinkItem> incognito = CreateShellLink();
- incognito->GetCommandLine()->AppendSwitch(switches::kIncognito);
- base::string16 incognito_title =
- l10n_util::GetStringUTF16(IDS_NEW_INCOGNITO_WINDOW);
- base::ReplaceSubstringsAfterOffset(
- &incognito_title, 0, L"&", base::StringPiece16());
- incognito->set_title(incognito_title);
- incognito->set_icon(chrome_path.value(), 0);
- items.push_back(incognito);
- }
-
- return jumplist_updater->AddTasks(items);
-}
-
-// Updates the application JumpList.
-bool UpdateJumpList(const wchar_t* app_id,
- const ShellLinkItemList& most_visited_pages,
- const ShellLinkItemList& recently_closed_pages,
- IncognitoModePrefs::Availability incognito_availability) {
- // JumpList is implemented only on Windows 7 or later.
- // So, we should return now when this function is called on earlier versions
- // of Windows.
- if (!JumpListUpdater::IsEnabled())
- return true;
-
- JumpListUpdater jumplist_updater(app_id);
- if (!jumplist_updater.BeginUpdate())
- return false;
-
- // We allocate 60% of the given JumpList slots to "most-visited" items
- // and 40% to "recently-closed" items, respectively.
- // Nevertheless, if there are not so many items in |recently_closed_pages|,
- // we give the remaining slots to "most-visited" items.
- const int kMostVisited = 60;
- const int kRecentlyClosed = 40;
- const int kTotal = kMostVisited + kRecentlyClosed;
- size_t most_visited_items =
- MulDiv(jumplist_updater.user_max_items(), kMostVisited, kTotal);
- size_t recently_closed_items =
- jumplist_updater.user_max_items() - most_visited_items;
- if (recently_closed_pages.size() < recently_closed_items) {
- most_visited_items += recently_closed_items - recently_closed_pages.size();
- recently_closed_items = recently_closed_pages.size();
- }
-
- // Update the "Most Visited" category of the JumpList if it exists.
- // This update request is applied into the JumpList when we commit this
- // transaction.
- if (!jumplist_updater.AddCustomCategory(
- l10n_util::GetStringUTF16(IDS_NEW_TAB_MOST_VISITED),
- most_visited_pages, most_visited_items)) {
- return false;
- }
-
- // Update the "Recently Closed" category of the JumpList.
- if (!jumplist_updater.AddCustomCategory(
- l10n_util::GetStringUTF16(IDS_RECENTLY_CLOSED),
- recently_closed_pages, recently_closed_items)) {
- return false;
- }
-
- // Update the "Tasks" category of the JumpList.
- if (!UpdateTaskCategory(&jumplist_updater, incognito_availability))
- return false;
-
- // Commit this transaction and send the updated JumpList to Windows.
- if (!jumplist_updater.CommitUpdate())
- return false;
-
- return true;
-}
-
-// Updates the jumplist, once all the data has been fetched.
-void RunUpdateOnFileThread(
- IncognitoModePrefs::Availability incognito_availability,
- const std::wstring& app_id,
- const base::FilePath& icon_dir,
- base::RefCountedData<JumpListData>* ref_counted_data) {
- JumpListData* data = &ref_counted_data->data;
- ShellLinkItemList local_most_visited_pages;
- ShellLinkItemList local_recently_closed_pages;
-
- {
- base::AutoLock auto_lock(data->list_lock_);
- // Make sure we are not out of date: if icon_urls_ is not empty, then
- // another notification has been received since we processed this one
- if (!data->icon_urls_.empty())
- return;
-
- // Make local copies of lists so we can release the lock.
- local_most_visited_pages = data->most_visited_pages_;
- local_recently_closed_pages = data->recently_closed_pages_;
- }
-
- // Delete the directory which contains old icon files, rename the current
- // icon directory, and create a new directory which contains new JumpList
- // icon files.
- base::FilePath icon_dir_old(icon_dir.value() + L"Old");
- if (base::PathExists(icon_dir_old))
- base::DeleteFile(icon_dir_old, true);
- base::Move(icon_dir, icon_dir_old);
- base::CreateDirectory(icon_dir);
-
- // Create temporary icon files for shortcuts in the "Most Visited" category.
- CreateIconFiles(icon_dir, local_most_visited_pages);
-
- // Create temporary icon files for shortcuts in the "Recently Closed"
- // category.
- CreateIconFiles(icon_dir, local_recently_closed_pages);
-
- // We finished collecting all resources needed for updating an application
- // JumpList. So, create a new JumpList and replace the current JumpList
- // with it.
- UpdateJumpList(app_id.c_str(),
- local_most_visited_pages,
- local_recently_closed_pages,
- incognito_availability);
-}
-
-} // namespace
-
-JumpList::JumpListData::JumpListData() {}
-
-JumpList::JumpListData::~JumpListData() {}
-
-JumpList::JumpList(Profile* profile)
- : profile_(profile),
- jumplist_data_(new base::RefCountedData<JumpListData>),
- task_id_(base::CancelableTaskTracker::kBadTaskId),
- weak_ptr_factory_(this) {
- DCHECK(Enabled());
- // To update JumpList when a tab is added or removed, we add this object to
- // the observer list of the TabRestoreService class.
- // When we add this object to the observer list, we save the pointer to this
- // TabRestoreService object. This pointer is used when we remove this object
- // from the observer list.
- sessions::TabRestoreService* tab_restore_service =
- TabRestoreServiceFactory::GetForProfile(profile_);
- if (!tab_restore_service)
- return;
-
- app_id_ =
- shell_integration::win::GetChromiumModelIdForProfile(profile_->GetPath());
- icon_dir_ = profile_->GetPath().Append(chrome::kJumpListIconDirname);
-
- scoped_refptr<history::TopSites> top_sites =
- TopSitesFactory::GetForProfile(profile_);
- if (top_sites) {
- // TopSites updates itself after a delay. This is especially noticable when
- // your profile is empty. Ask TopSites to update itself when jumplist is
- // initialized.
- top_sites->SyncWithHistory();
- registrar_.reset(new content::NotificationRegistrar);
- // Register as TopSitesObserver so that we can update ourselves when the
- // TopSites changes.
- top_sites->AddObserver(this);
- // Register for notification when profile is destroyed to ensure that all
- // observers are detatched at that time.
- registrar_->Add(this, chrome::NOTIFICATION_PROFILE_DESTROYED,
- content::Source<Profile>(profile_));
- }
- tab_restore_service->AddObserver(this);
- pref_change_registrar_.reset(new PrefChangeRegistrar);
- pref_change_registrar_->Init(profile_->GetPrefs());
- pref_change_registrar_->Add(
- prefs::kIncognitoModeAvailability,
- base::Bind(&JumpList::OnIncognitoAvailabilityChanged, this));
-}
-
-JumpList::~JumpList() {
- DCHECK(CalledOnValidThread());
- Terminate();
-}
-
-// static
-bool JumpList::Enabled() {
- return JumpListUpdater::IsEnabled();
-}
-
-void JumpList::Observe(int type,
- const content::NotificationSource& source,
- const content::NotificationDetails& details) {
- DCHECK(CalledOnValidThread());
- DCHECK_EQ(chrome::NOTIFICATION_PROFILE_DESTROYED, type);
- // Profile was destroyed, do clean-up.
- Terminate();
-}
-
-void JumpList::CancelPendingUpdate() {
- DCHECK(CalledOnValidThread());
- if (task_id_ != base::CancelableTaskTracker::kBadTaskId) {
- cancelable_task_tracker_.TryCancel(task_id_);
- task_id_ = base::CancelableTaskTracker::kBadTaskId;
- }
-}
-
-void JumpList::Terminate() {
- DCHECK(CalledOnValidThread());
- CancelPendingUpdate();
- if (profile_) {
- sessions::TabRestoreService* tab_restore_service =
- TabRestoreServiceFactory::GetForProfile(profile_);
- if (tab_restore_service)
- tab_restore_service->RemoveObserver(this);
- scoped_refptr<history::TopSites> top_sites =
- TopSitesFactory::GetForProfile(profile_);
- if (top_sites)
- top_sites->RemoveObserver(this);
- registrar_.reset();
- pref_change_registrar_.reset();
- }
- profile_ = NULL;
-}
-
-void JumpList::OnMostVisitedURLsAvailable(
- const history::MostVisitedURLList& urls) {
- DCHECK(CalledOnValidThread());
- // If we have a pending favicon request, cancel it here (it is out of date).
- CancelPendingUpdate();
-
- {
- JumpListData* data = &jumplist_data_->data;
- base::AutoLock auto_lock(data->list_lock_);
- data->most_visited_pages_.clear();
- for (size_t i = 0; i < urls.size(); i++) {
- const history::MostVisitedURL& url = urls[i];
- scoped_refptr<ShellLinkItem> link = CreateShellLink();
- std::string url_string = url.url.spec();
- std::wstring url_string_wide = base::UTF8ToWide(url_string);
- link->GetCommandLine()->AppendArgNative(url_string_wide);
- link->GetCommandLine()->AppendSwitchASCII(
- switches::kWinJumplistAction, jumplist::kMostVisitedCategory);
- link->set_title(!url.title.empty() ? url.title : url_string_wide);
- data->most_visited_pages_.push_back(link);
- data->icon_urls_.push_back(make_pair(url_string, link));
- }
- }
-
- // Send a query that retrieves the first favicon.
- StartLoadingFavicon();
-}
-
-void JumpList::TabRestoreServiceChanged(sessions::TabRestoreService* service) {
- DCHECK(CalledOnValidThread());
- // if we have a pending handle request, cancel it here (it is out of date).
- CancelPendingUpdate();
-
- // local list to pass to methods
- ShellLinkItemList temp_list;
-
- // Create a list of ShellLinkItems from the "Recently Closed" pages.
- // As noted above, we create a ShellLinkItem objects with the following
- // parameters.
- // * arguments
- // The last URL of the tab object.
- // * title
- // The title of the last URL.
- // * icon
- // An empty string. This value is to be updated in OnFaviconDataAvailable().
- // This code is copied from
- // RecentlyClosedTabsHandler::TabRestoreServiceChanged() to emulate it.
- const int kRecentlyClosedCount = 4;
- sessions::TabRestoreService* tab_restore_service =
- TabRestoreServiceFactory::GetForProfile(profile_);
- const sessions::TabRestoreService::Entries& entries =
- tab_restore_service->entries();
- for (sessions::TabRestoreService::Entries::const_iterator it =
- entries.begin();
- it != entries.end(); ++it) {
- const sessions::TabRestoreService::Entry* entry = *it;
- if (entry->type == sessions::TabRestoreService::TAB) {
- AddTab(static_cast<const sessions::TabRestoreService::Tab*>(entry),
- &temp_list, kRecentlyClosedCount);
- } else if (entry->type == sessions::TabRestoreService::WINDOW) {
- AddWindow(static_cast<const sessions::TabRestoreService::Window*>(entry),
- &temp_list, kRecentlyClosedCount);
- }
- }
- // Lock recently_closed_pages and copy temp_list into it.
- {
- JumpListData* data = &jumplist_data_->data;
- base::AutoLock auto_lock(data->list_lock_);
- data->recently_closed_pages_ = temp_list;
- }
-
- // Send a query that retrieves the first favicon.
- StartLoadingFavicon();
-}
-
-void JumpList::TabRestoreServiceDestroyed(
- sessions::TabRestoreService* service) {}
-
-bool JumpList::AddTab(const sessions::TabRestoreService::Tab* tab,
- ShellLinkItemList* list,
- size_t max_items) {
- DCHECK(CalledOnValidThread());
-
- // This code adds the URL and the title strings of the given tab to the
- // specified list.
- if (list->size() >= max_items)
- return false;
-
- scoped_refptr<ShellLinkItem> link = CreateShellLink();
- const sessions::SerializedNavigationEntry& current_navigation =
- tab->navigations.at(tab->current_navigation_index);
- std::string url = current_navigation.virtual_url().spec();
- link->GetCommandLine()->AppendArgNative(base::UTF8ToWide(url));
- link->GetCommandLine()->AppendSwitchASCII(
- switches::kWinJumplistAction, jumplist::kRecentlyClosedCategory);
- link->set_title(current_navigation.title());
- list->push_back(link);
- {
- JumpListData* data = &jumplist_data_->data;
- base::AutoLock auto_lock(data->list_lock_);
- data->icon_urls_.push_back(std::make_pair(std::move(url), std::move(link)));
- }
- return true;
-}
-
-void JumpList::AddWindow(const sessions::TabRestoreService::Window* window,
- ShellLinkItemList* list,
- size_t max_items) {
- DCHECK(CalledOnValidThread());
-
- // This code enumerates al the tabs in the given window object and add their
- // URLs and titles to the list.
- DCHECK(!window->tabs.empty());
-
- for (size_t i = 0; i < window->tabs.size(); ++i) {
- if (!AddTab(&window->tabs[i], list, max_items))
- return;
- }
-}
-
-void JumpList::StartLoadingFavicon() {
- DCHECK(CalledOnValidThread());
-
- GURL url;
- bool waiting_for_icons = true;
- {
- JumpListData* data = &jumplist_data_->data;
- base::AutoLock auto_lock(data->list_lock_);
- waiting_for_icons = !data->icon_urls_.empty();
- if (waiting_for_icons) {
- // Ask FaviconService if it has a favicon of a URL.
- // When FaviconService has one, it will call OnFaviconDataAvailable().
- url = GURL(data->icon_urls_.front().first);
- }
- }
-
- if (!waiting_for_icons) {
- // No more favicons are needed by the application JumpList. Schedule a
- // RunUpdateOnFileThread call.
- PostRunUpdate();
- return;
- }
-
- favicon::FaviconService* favicon_service =
- FaviconServiceFactory::GetForProfile(profile_,
- ServiceAccessType::EXPLICIT_ACCESS);
- task_id_ = favicon_service->GetFaviconImageForPageURL(
- url,
- base::Bind(&JumpList::OnFaviconDataAvailable, base::Unretained(this)),
- &cancelable_task_tracker_);
-}
-
-void JumpList::OnFaviconDataAvailable(
- const favicon_base::FaviconImageResult& image_result) {
- DCHECK(CalledOnValidThread());
-
- // If there is currently a favicon request in progress, it is now outdated,
- // as we have received another, so nullify the handle from the old request.
- task_id_ = base::CancelableTaskTracker::kBadTaskId;
- // Lock the list to set icon data and pop the url.
- {
- JumpListData* data = &jumplist_data_->data;
- base::AutoLock auto_lock(data->list_lock_);
- // Attach the received data to the ShellLinkItem object.
- // This data will be decoded by the RunUpdateOnFileThread method.
- if (!image_result.image.IsEmpty()) {
- if (!data->icon_urls_.empty() && data->icon_urls_.front().second.get())
- data->icon_urls_.front().second->set_icon_data(
- image_result.image.AsBitmap());
- }
-
- if (!data->icon_urls_.empty())
- data->icon_urls_.pop_front();
- }
- // Check whether we need to load more favicons.
- StartLoadingFavicon();
-}
-
-void JumpList::OnIncognitoAvailabilityChanged() {
- DCHECK(CalledOnValidThread());
-
- bool waiting_for_icons = true;
- {
- JumpListData* data = &jumplist_data_->data;
- base::AutoLock auto_lock(data->list_lock_);
- waiting_for_icons = !data->icon_urls_.empty();
- }
- if (!waiting_for_icons)
- PostRunUpdate();
- // If |icon_urls_| isn't empty then OnFaviconDataAvailable will eventually
- // call PostRunUpdate().
-}
-
-void JumpList::PostRunUpdate() {
- DCHECK(CalledOnValidThread());
-
- TRACE_EVENT0("browser", "JumpList::PostRunUpdate");
- // Initialize the one-shot timer to update the jumplists in a while.
- // If there is already a request queued then cancel it and post the new
- // request. This ensures that JumpListUpdates won't happen until there has
- // been a brief quiet period, thus avoiding update storms.
- if (timer_.IsRunning()) {
- timer_.Reset();
- } else {
- timer_.Start(FROM_HERE,
- base::TimeDelta::FromMilliseconds(kDelayForJumplistUpdateInMS),
- this,
- &JumpList::DeferredRunUpdate);
- }
-}
-
-void JumpList::DeferredRunUpdate() {
- DCHECK(CalledOnValidThread());
-
- TRACE_EVENT0("browser", "JumpList::DeferredRunUpdate");
- // Check if incognito windows (or normal windows) are disabled by policy.
- IncognitoModePrefs::Availability incognito_availability =
- profile_ ? IncognitoModePrefs::GetAvailability(profile_->GetPrefs())
- : IncognitoModePrefs::ENABLED;
-
- BrowserThread::PostTask(
- BrowserThread::FILE, FROM_HERE,
- base::Bind(&RunUpdateOnFileThread,
- incognito_availability,
- app_id_,
- icon_dir_,
- base::RetainedRef(jumplist_data_)));
-}
-
-void JumpList::TopSitesLoaded(history::TopSites* top_sites) {
-}
-
-void JumpList::TopSitesChanged(history::TopSites* top_sites,
- ChangeReason change_reason) {
- top_sites->GetMostVisitedURLs(
- base::Bind(&JumpList::OnMostVisitedURLsAvailable,
- weak_ptr_factory_.GetWeakPtr()),
- false);
-}
« no previous file with comments | « chrome/browser/jumplist_win.h ('k') | chrome/browser/private_working_set_snapshot.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698