Revert of NTP Zombie Code Slayer Part IV: Most Visited

chrome/browser/ui/webui/ntp/most_visited_handler.cc

+// 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.
+
+#include "chrome/browser/ui/webui/ntp/most_visited_handler.h"
+
+#include <set>
+
+#include "base/bind.h"
+#include "base/bind_helpers.h"
+#include "base/command_line.h"
+#include "base/md5.h"
+#include "base/memory/scoped_vector.h"
+#include "base/memory/singleton.h"
+#include "base/metrics/histogram.h"
+#include "base/prefs/pref_service.h"
+#include "base/prefs/scoped_user_pref_update.h"
+#include "base/strings/string16.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/strings/utf_string_conversions.h"
+#include "base/threading/thread.h"
+#include "base/values.h"
+#include "chrome/browser/favicon/fallback_icon_service_factory.h"
+#include "chrome/browser/favicon/large_icon_service_factory.h"
+#include "chrome/browser/history/top_sites_factory.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/browser/thumbnails/thumbnail_list_source.h"
+#include "chrome/browser/ui/browser.h"
+#include "chrome/browser/ui/browser_finder.h"
+#include "chrome/browser/ui/tabs/tab_strip_model.h"
+#include "chrome/browser/ui/tabs/tab_strip_model_utils.h"
+#include "chrome/browser/ui/webui/fallback_icon_source.h"
+#include "chrome/browser/ui/webui/favicon_source.h"
+#include "chrome/browser/ui/webui/large_icon_source.h"
+#include "chrome/browser/ui/webui/ntp/new_tab_ui.h"
+#include "chrome/browser/ui/webui/ntp/ntp_stats.h"
+#include "chrome/browser/ui/webui/ntp/thumbnail_source.h"
+#include "chrome/common/pref_names.h"
+#include "chrome/common/url_constants.h"
+#include "components/favicon/core/fallback_icon_service.h"
+#include "components/favicon/core/large_icon_service.h"
+#include "components/history/core/browser/page_usage_data.h"
+#include "components/history/core/browser/top_sites.h"
+#include "components/keyed_service/core/service_access_type.h"
+#include "components/pref_registry/pref_registry_syncable.h"
+#include "content/public/browser/navigation_controller.h"
+#include "content/public/browser/navigation_entry.h"
+#include "content/public/browser/url_data_source.h"
+#include "content/public/browser/user_metrics.h"
+#include "content/public/browser/web_contents.h"
+#include "content/public/browser/web_ui.h"
+#include "url/gurl.h"
+
+using base::UserMetricsAction;
+
+MostVisitedHandler::MostVisitedHandler()
+    : scoped_observer_(this),
+      got_first_most_visited_request_(false),
+      most_visited_viewed_(false),
+      user_action_logged_(false),
+      weak_ptr_factory_(this) {
+}
+
+MostVisitedHandler::~MostVisitedHandler() {
+  if (!user_action_logged_ && most_visited_viewed_) {
+    const GURL ntp_url = GURL(chrome::kChromeUINewTabURL);
+    int action_id = NTP_FOLLOW_ACTION_OTHER;
+    content::NavigationEntry* entry =
+        web_ui()->GetWebContents()->GetController().GetLastCommittedEntry();
+    if (entry && (entry->GetURL() != ntp_url)) {
+      action_id =
+          ui::PageTransitionStripQualifier(entry->GetTransitionType());
+    }
+
+    UMA_HISTOGRAM_ENUMERATION("NewTabPage.MostVisitedAction", action_id,
+                              NUM_NTP_FOLLOW_ACTIONS);
+  }
+}
+
+void MostVisitedHandler::RegisterMessages() {
+  Profile* profile = Profile::FromWebUI(web_ui());
+  // Set up our sources for thumbnail and favicon data.
+  content::URLDataSource::Add(profile, new ThumbnailSource(profile, false));
+  content::URLDataSource::Add(profile, new ThumbnailSource(profile, true));
+
+  // Set up our sources for top-sites data.
+  content::URLDataSource::Add(profile, new ThumbnailListSource(profile));
+
+  favicon::FallbackIconService* fallback_icon_service =
+      FallbackIconServiceFactory::GetForBrowserContext(profile);
+  favicon::LargeIconService* large_icon_service =
+      LargeIconServiceFactory::GetForBrowserContext(profile);
+
+  // Register chrome://fallback-icon as a data source for fallback icons.
+  content::URLDataSource::Add(profile,
+                              new FallbackIconSource(fallback_icon_service));
+
+  // Register chrome://favicon as a data source for favicons.
+  content::URLDataSource::Add(
+      profile, new FaviconSource(profile, FaviconSource::FAVICON));
+
+  // Register chrome://large-icon as a data source for large icons.
+  content::URLDataSource::Add(
+      profile, new LargeIconSource(fallback_icon_service, large_icon_service));
+
+  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 we're about to
+    // show the new tab page.
+    top_sites->SyncWithHistory();
+
+    // Register as TopSitesObserver so that we can update ourselves when the
+    // TopSites changes.
+    scoped_observer_.Add(top_sites.get());
+  }
+
+  // We pre-emptively make a fetch for the most visited pages so we have the
+  // results sooner.
+  StartQueryForMostVisited();
+
+  web_ui()->RegisterMessageCallback("getMostVisited",
+      base::Bind(&MostVisitedHandler::HandleGetMostVisited,
+                 base::Unretained(this)));
+
+  // Register ourselves for any most-visited item blacklisting.
+  web_ui()->RegisterMessageCallback("blacklistURLFromMostVisited",
+      base::Bind(&MostVisitedHandler::HandleBlacklistUrl,
+                 base::Unretained(this)));
+  web_ui()->RegisterMessageCallback("removeURLsFromMostVisitedBlacklist",
+      base::Bind(&MostVisitedHandler::HandleRemoveUrlsFromBlacklist,
+                 base::Unretained(this)));
+  web_ui()->RegisterMessageCallback("clearMostVisitedURLsBlacklist",
+      base::Bind(&MostVisitedHandler::HandleClearBlacklist,
+                 base::Unretained(this)));
+  web_ui()->RegisterMessageCallback("mostVisitedAction",
+      base::Bind(&MostVisitedHandler::HandleMostVisitedAction,
+                 base::Unretained(this)));
+  web_ui()->RegisterMessageCallback("mostVisitedSelected",
+      base::Bind(&MostVisitedHandler::HandleMostVisitedSelected,
+                 base::Unretained(this)));
+}
+
+void MostVisitedHandler::HandleGetMostVisited(const base::ListValue* args) {
+  if (!got_first_most_visited_request_) {
+    // If our initial data is already here, return it.
+    SendPagesValue();
+    got_first_most_visited_request_ = true;
+  } else {
+    StartQueryForMostVisited();
+  }
+}
+
+void MostVisitedHandler::SendPagesValue() {
+  if (pages_value_) {
+    Profile* profile = Profile::FromWebUI(web_ui());
+    const base::DictionaryValue* url_blacklist =
+        profile->GetPrefs()->GetDictionary(prefs::kNtpMostVisitedURLsBlacklist);
+    bool has_blacklisted_urls = !url_blacklist->empty();
+    scoped_refptr<history::TopSites> ts =
+        TopSitesFactory::GetForProfile(profile);
+    if (ts)
+      has_blacklisted_urls = ts->HasBlacklistedItems();
+
+    base::FundamentalValue has_blacklisted_urls_value(has_blacklisted_urls);
+    web_ui()->CallJavascriptFunction("ntp.setMostVisitedPages",
+                                     *pages_value_,
+                                     has_blacklisted_urls_value);
+    pages_value_.reset();
+  }
+}
+
+void MostVisitedHandler::StartQueryForMostVisited() {
+  scoped_refptr<history::TopSites> ts =
+      TopSitesFactory::GetForProfile(Profile::FromWebUI(web_ui()));
+  if (ts) {
+    ts->GetMostVisitedURLs(
+        base::Bind(&MostVisitedHandler::OnMostVisitedUrlsAvailable,
+                   weak_ptr_factory_.GetWeakPtr()), false);
+  }
+}
+
+void MostVisitedHandler::HandleBlacklistUrl(const base::ListValue* args) {
+  std::string url = base::UTF16ToUTF8(ExtractStringValue(args));
+  BlacklistUrl(GURL(url));
+}
+
+void MostVisitedHandler::HandleRemoveUrlsFromBlacklist(
+    const base::ListValue* args) {
+  DCHECK(args->GetSize() != 0);
+
+  for (base::ListValue::const_iterator iter = args->begin();
+       iter != args->end(); ++iter) {
+    std::string url;
+    bool r = (*iter)->GetAsString(&url);
+    if (!r) {
+      NOTREACHED();
+      return;
+    }
+    content::RecordAction(UserMetricsAction("MostVisited_UrlRemoved"));
+    scoped_refptr<history::TopSites> ts =
+        TopSitesFactory::GetForProfile(Profile::FromWebUI(web_ui()));
+    if (ts)
+      ts->RemoveBlacklistedURL(GURL(url));
+  }
+}
+
+void MostVisitedHandler::HandleClearBlacklist(const base::ListValue* args) {
+  content::RecordAction(UserMetricsAction("MostVisited_BlacklistCleared"));
+
+  scoped_refptr<history::TopSites> ts =
+      TopSitesFactory::GetForProfile(Profile::FromWebUI(web_ui()));
+  if (ts)
+    ts->ClearBlacklistedURLs();
+}
+
+void MostVisitedHandler::HandleMostVisitedAction(const base::ListValue* args) {
+  DCHECK(args);
+
+  double action_id;
+  if (!args->GetDouble(0, &action_id))
+    NOTREACHED();
+
+  UMA_HISTOGRAM_ENUMERATION("NewTabPage.MostVisitedAction",
+                            static_cast<int>(action_id),
+                            NUM_NTP_FOLLOW_ACTIONS);
+  most_visited_viewed_ = true;
+  user_action_logged_ = true;
+}
+
+void MostVisitedHandler::HandleMostVisitedSelected(
+    const base::ListValue* args) {
+  most_visited_viewed_ = true;
+}
+
+void MostVisitedHandler::SetPagesValueFromTopSites(
+    const history::MostVisitedURLList& data) {
+  pages_value_.reset(new base::ListValue);
+
+  history::MostVisitedURLList top_sites(data);
+  for (size_t i = 0; i < top_sites.size(); i++) {
+    const history::MostVisitedURL& url = top_sites[i];
+
+    // The items which are to be written into |page_value| are also described in
+    // chrome/browser/resources/ntp4/new_tab.js in @typedef for PageData. Please
+    // update it whenever you add or remove any keys here.
+    base::DictionaryValue* page_value = new base::DictionaryValue();
+    if (url.url.is_empty()) {
+      page_value->SetBoolean("filler", true);
+      pages_value_->Append(page_value);
+      continue;
+    }
+
+    NewTabUI::SetUrlTitleAndDirection(page_value,
+                                      url.title,
+                                      url.url);
+    pages_value_->Append(page_value);
+  }
+}
+
+void MostVisitedHandler::OnMostVisitedUrlsAvailable(
+    const history::MostVisitedURLList& data) {
+  SetPagesValueFromTopSites(data);
+  if (got_first_most_visited_request_) {
+    SendPagesValue();
+  }
+}
+
+void MostVisitedHandler::TopSitesLoaded(history::TopSites* top_sites) {
+}
+
+void MostVisitedHandler::TopSitesChanged(history::TopSites* top_sites) {
+  // Most visited urls changed, query again.
+  StartQueryForMostVisited();
+}
+
+void MostVisitedHandler::BlacklistUrl(const GURL& url) {
+  scoped_refptr<history::TopSites> ts =
+      TopSitesFactory::GetForProfile(Profile::FromWebUI(web_ui()));
+  if (ts)
+    ts->AddBlacklistedURL(url);
+  content::RecordAction(UserMetricsAction("MostVisited_UrlBlacklisted"));
+}
+
+std::string MostVisitedHandler::GetDictionaryKeyForUrl(const std::string& url) {
+  return base::MD5String(url);
+}
+
+// static
+void MostVisitedHandler::RegisterProfilePrefs(
+    user_prefs::PrefRegistrySyncable* registry) {
+  registry->RegisterDictionaryPref(prefs::kNtpMostVisitedURLsBlacklist);
+}