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

   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 #include "chrome/browser/ui/webui/ntp/most_visited_handler.h"
   6
   7 #include <set>
   8
   9 #include "base/bind.h"
  10 #include "base/bind_helpers.h"
  11 #include "base/command_line.h"
  12 #include "base/md5.h"
  13 #include "base/memory/scoped_vector.h"
  14 #include "base/memory/singleton.h"
  15 #include "base/metrics/histogram.h"
  16 #include "base/prefs/pref_service.h"
  17 #include "base/prefs/scoped_user_pref_update.h"
  18 #include "base/strings/string16.h"
  19 #include "base/strings/string_number_conversions.h"
  20 #include "base/strings/utf_string_conversions.h"
  21 #include "base/threading/thread.h"
  22 #include "base/values.h"
  23 #include "chrome/browser/chrome_notification_types.h"
  24 #include "chrome/browser/history/most_visited_tiles_experiment.h"
  25 #include "chrome/browser/history/page_usage_data.h"
  26 #include "chrome/browser/history/top_sites.h"
  27 #include "chrome/browser/profiles/profile.h"
  28 #include "chrome/browser/ui/browser.h"
  29 #include "chrome/browser/ui/browser_finder.h"
  30 #include "chrome/browser/ui/tabs/tab_strip_model.h"
  31 #include "chrome/browser/ui/tabs/tab_strip_model_utils.h"
  32 #include "chrome/browser/ui/webui/favicon_source.h"
  33 #include "chrome/browser/ui/webui/ntp/new_tab_ui.h"
  34 #include "chrome/browser/ui/webui/ntp/ntp_stats.h"
  35 #include "chrome/browser/ui/webui/ntp/thumbnail_list_source.h"
  36 #include "chrome/browser/ui/webui/ntp/thumbnail_source.h"
  37 #include "chrome/common/pref_names.h"
  38 #include "chrome/common/url_constants.h"
  39 #include "components/user_prefs/pref_registry_syncable.h"
  40 #include "content/public/browser/navigation_controller.h"
  41 #include "content/public/browser/navigation_entry.h"
  42 #include "content/public/browser/notification_source.h"
  43 #include "content/public/browser/url_data_source.h"
  44 #include "content/public/browser/user_metrics.h"
  45 #include "content/public/browser/web_contents.h"
  46 #include "content/public/browser/web_ui.h"
  47 #include "grit/chromium_strings.h"
  48 #include "grit/generated_resources.h"
  49 #include "grit/locale_settings.h"
  50 #include "ui/base/l10n/l10n_util.h"
  51 #include "url/gurl.h"
  52
  53 using base::UserMetricsAction;
  54
  55 MostVisitedHandler::MostVisitedHandler()
  56     : got_first_most_visited_request_(false),
  57       most_visited_viewed_(false),
  58       user_action_logged_(false),
  59       weak_ptr_factory_(this) {
  60 }
  61
  62 MostVisitedHandler::~MostVisitedHandler() {
  63   if (!user_action_logged_ && most_visited_viewed_) {
  64     const GURL ntp_url = GURL(chrome::kChromeUINewTabURL);
  65     int action_id = NTP_FOLLOW_ACTION_OTHER;
  66     content::NavigationEntry* entry =
  67         web_ui()->GetWebContents()->GetController().GetLastCommittedEntry();
  68     if (entry && (entry->GetURL() != ntp_url)) {
  69       action_id =
  70           content::PageTransitionStripQualifier(entry->GetTransitionType());
  71     }
  72
  73     UMA_HISTOGRAM_ENUMERATION("NewTabPage.MostVisitedAction", action_id,
  74                               NUM_NTP_FOLLOW_ACTIONS);
  75   }
  76 }
  77
  78 void MostVisitedHandler::RegisterMessages() {
  79   Profile* profile = Profile::FromWebUI(web_ui());
  80   // Set up our sources for thumbnail and favicon data.
  81   content::URLDataSource::Add(profile, new ThumbnailSource(profile, false));
  82   content::URLDataSource::Add(profile, new ThumbnailSource(profile, true));
  83
  84   // Set up our sources for top-sites data.
  85   content::URLDataSource::Add(profile, new ThumbnailListSource(profile));
  86
  87 #if defined(OS_ANDROID)
  88   // Register chrome://touch-icon as a data source for touch icons or favicons.
  89   content::URLDataSource::Add(profile,
  90                               new FaviconSource(profile, FaviconSource::ANY));
  91 #endif
  92   // Register chrome://favicon as a data source for favicons.
  93   content::URLDataSource::Add(
  94       profile, new FaviconSource(profile, FaviconSource::FAVICON));
  95
  96   history::TopSites* ts = profile->GetTopSites();
  97   if (ts) {
  98     // TopSites updates itself after a delay. This is especially noticable when
  99     // your profile is empty. Ask TopSites to update itself when we're about to
 100     // show the new tab page.
 101     ts->SyncWithHistory();
 102
 103     // Register for notification when TopSites changes so that we can update
 104     // ourself.
 105     registrar_.Add(this, chrome::NOTIFICATION_TOP_SITES_CHANGED,
 106                    content::Source<history::TopSites>(ts));
 107   }
 108
 109   // We pre-emptively make a fetch for the most visited pages so we have the
 110   // results sooner.
 111   StartQueryForMostVisited();
 112
 113   web_ui()->RegisterMessageCallback("getMostVisited",
 114       base::Bind(&MostVisitedHandler::HandleGetMostVisited,
 115                  base::Unretained(this)));
 116
 117   // Register ourselves for any most-visited item blacklisting.
 118   web_ui()->RegisterMessageCallback("blacklistURLFromMostVisited",
 119       base::Bind(&MostVisitedHandler::HandleBlacklistUrl,
 120                  base::Unretained(this)));
 121   web_ui()->RegisterMessageCallback("removeURLsFromMostVisitedBlacklist",
 122       base::Bind(&MostVisitedHandler::HandleRemoveUrlsFromBlacklist,
 123                  base::Unretained(this)));
 124   web_ui()->RegisterMessageCallback("clearMostVisitedURLsBlacklist",
 125       base::Bind(&MostVisitedHandler::HandleClearBlacklist,
 126                  base::Unretained(this)));
 127   web_ui()->RegisterMessageCallback("mostVisitedAction",
 128       base::Bind(&MostVisitedHandler::HandleMostVisitedAction,
 129                  base::Unretained(this)));
 130   web_ui()->RegisterMessageCallback("mostVisitedSelected",
 131       base::Bind(&MostVisitedHandler::HandleMostVisitedSelected,
 132                  base::Unretained(this)));
 133 }
 134
 135 void MostVisitedHandler::HandleGetMostVisited(const base::ListValue* args) {
 136   if (!got_first_most_visited_request_) {
 137     // If our initial data is already here, return it.
 138     SendPagesValue();
 139     got_first_most_visited_request_ = true;
 140   } else {
 141     StartQueryForMostVisited();
 142   }
 143 }
 144
 145 void MostVisitedHandler::SendPagesValue() {
 146   if (pages_value_) {
 147     Profile* profile = Profile::FromWebUI(web_ui());
 148     const base::DictionaryValue* url_blacklist =
 149         profile->GetPrefs()->GetDictionary(prefs::kNtpMostVisitedURLsBlacklist);
 150     bool has_blacklisted_urls = !url_blacklist->empty();
 151     history::TopSites* ts = profile->GetTopSites();
 152     if (ts) {
 153       has_blacklisted_urls = ts->HasBlacklistedItems();
 154
 155       MaybeRemovePageValues();
 156     }
 157
 158     base::FundamentalValue has_blacklisted_urls_value(has_blacklisted_urls);
 159     web_ui()->CallJavascriptFunction("ntp.setMostVisitedPages",
 160                                      *pages_value_,
 161                                      has_blacklisted_urls_value);
 162     pages_value_.reset();
 163   }
 164 }
 165
 166 void MostVisitedHandler::StartQueryForMostVisited() {
 167   history::TopSites* ts = Profile::FromWebUI(web_ui())->GetTopSites();
 168   if (ts) {
 169     ts->GetMostVisitedURLs(
 170         base::Bind(&MostVisitedHandler::OnMostVisitedUrlsAvailable,
 171                    weak_ptr_factory_.GetWeakPtr()), false);
 172   }
 173 }
 174
 175 void MostVisitedHandler::HandleBlacklistUrl(const base::ListValue* args) {
 176   std::string url = base::UTF16ToUTF8(ExtractStringValue(args));
 177   BlacklistUrl(GURL(url));
 178 }
 179
 180 void MostVisitedHandler::HandleRemoveUrlsFromBlacklist(
 181     const base::ListValue* args) {
 182   DCHECK(args->GetSize() != 0);
 183
 184   for (base::ListValue::const_iterator iter = args->begin();
 185        iter != args->end(); ++iter) {
 186     std::string url;
 187     bool r = (*iter)->GetAsString(&url);
 188     if (!r) {
 189       NOTREACHED();
 190       return;
 191     }
 192     content::RecordAction(UserMetricsAction("MostVisited_UrlRemoved"));
 193     history::TopSites* ts = Profile::FromWebUI(web_ui())->GetTopSites();
 194     if (ts)
 195       ts->RemoveBlacklistedURL(GURL(url));
 196   }
 197 }
 198
 199 void MostVisitedHandler::HandleClearBlacklist(const base::ListValue* args) {
 200   content::RecordAction(UserMetricsAction("MostVisited_BlacklistCleared"));
 201
 202   history::TopSites* ts = Profile::FromWebUI(web_ui())->GetTopSites();
 203   if (ts)
 204     ts->ClearBlacklistedURLs();
 205 }
 206
 207 void MostVisitedHandler::HandleMostVisitedAction(const base::ListValue* args) {
 208   DCHECK(args);
 209
 210   double action_id;
 211   if (!args->GetDouble(0, &action_id))
 212     NOTREACHED();
 213
 214   UMA_HISTOGRAM_ENUMERATION("NewTabPage.MostVisitedAction",
 215                             static_cast<int>(action_id),
 216                             NUM_NTP_FOLLOW_ACTIONS);
 217   most_visited_viewed_ = true;
 218   user_action_logged_ = true;
 219 }
 220
 221 void MostVisitedHandler::HandleMostVisitedSelected(
 222     const base::ListValue* args) {
 223   most_visited_viewed_ = true;
 224 }
 225
 226 void MostVisitedHandler::SetPagesValueFromTopSites(
 227     const history::MostVisitedURLList& data) {
 228   pages_value_.reset(new base::ListValue);
 229
 230   history::MostVisitedURLList top_sites(data);
 231   history::MostVisitedTilesExperiment::MaybeShuffle(&top_sites);
 232
 233   for (size_t i = 0; i < top_sites.size(); i++) {
 234     const history::MostVisitedURL& url = top_sites[i];
 235     base::DictionaryValue* page_value = new base::DictionaryValue();
 236     if (url.url.is_empty()) {
 237       page_value->SetBoolean("filler", true);
 238       pages_value_->Append(page_value);
 239       continue;
 240     }
 241
 242     NewTabUI::SetUrlTitleAndDirection(page_value,
 243                                       url.title,
 244                                       url.url);
 245     pages_value_->Append(page_value);
 246   }
 247 }
 248
 249 void MostVisitedHandler::OnMostVisitedUrlsAvailable(
 250     const history::MostVisitedURLList& data) {
 251   SetPagesValueFromTopSites(data);
 252   if (got_first_most_visited_request_) {
 253     SendPagesValue();
 254   }
 255 }
 256
 257 void MostVisitedHandler::Observe(int type,
 258                                  const content::NotificationSource& source,
 259                                  const content::NotificationDetails& details) {
 260   DCHECK_EQ(type, chrome::NOTIFICATION_TOP_SITES_CHANGED);
 261
 262   // Most visited urls changed, query again.
 263   StartQueryForMostVisited();
 264 }
 265
 266 void MostVisitedHandler::BlacklistUrl(const GURL& url) {
 267   history::TopSites* ts = Profile::FromWebUI(web_ui())->GetTopSites();
 268   if (ts)
 269     ts->AddBlacklistedURL(url);
 270   content::RecordAction(UserMetricsAction("MostVisited_UrlBlacklisted"));
 271 }
 272
 273 std::string MostVisitedHandler::GetDictionaryKeyForUrl(const std::string& url) {
 274   return base::MD5String(url);
 275 }
 276
 277 void MostVisitedHandler::MaybeRemovePageValues() {
 278 // The code below uses APIs not available on Android and the experiment should
 279 // not run there.
 280 #if !defined(OS_ANDROID)
 281   if (!history::MostVisitedTilesExperiment::IsDontShowOpenURLsEnabled())
 282     return;
 283
 284   TabStripModel* tab_strip_model = chrome::FindBrowserWithWebContents(
 285       web_ui()->GetWebContents())->tab_strip_model();
 286   history::TopSites* top_sites = Profile::FromWebUI(web_ui())->GetTopSites();
 287   if (!tab_strip_model || !top_sites) {
 288     NOTREACHED();
 289     return;
 290   }
 291
 292   std::set<std::string> open_urls;
 293   chrome::GetOpenUrls(*tab_strip_model, *top_sites, &open_urls);
 294   history::MostVisitedTilesExperiment::RemovePageValuesMatchingOpenTabs(
 295       open_urls,
 296       pages_value_.get());
 297 #endif
 298 }
 299
 300 // static
 301 void MostVisitedHandler::RegisterProfilePrefs(
 302     user_prefs::PrefRegistrySyncable* registry) {
 303   registry->RegisterDictionaryPref(
 304       prefs::kNtpMostVisitedURLsBlacklist,
 305       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 306 }