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