src/chrome/renderer/searchbox/searchbox.cc

   1 // Copyright 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/renderer/searchbox/searchbox.h"
   6
   7 #include <string>
   8
   9 #include "base/strings/string_number_conversions.h"
  10 #include "base/strings/string_util.h"
  11 #include "base/strings/utf_string_conversions.h"
  12 #include "chrome/common/chrome_switches.h"
  13 #include "chrome/common/favicon/favicon_types.h"
  14 #include "chrome/common/favicon/favicon_url_parser.h"
  15 #include "chrome/common/omnibox_focus_state.h"
  16 #include "chrome/common/render_messages.h"
  17 #include "chrome/common/url_constants.h"
  18 #include "chrome/renderer/searchbox/searchbox_extension.h"
  19 #include "content/public/renderer/render_view.h"
  20 #include "grit/renderer_resources.h"
  21 #include "net/base/escape.h"
  22 #include "third_party/WebKit/public/web/WebDocument.h"
  23 #include "third_party/WebKit/public/web/WebFrame.h"
  24 #include "third_party/WebKit/public/web/WebView.h"
  25 #include "ui/base/resource/resource_bundle.h"
  26 #include "url/gurl.h"
  27
  28 namespace {
  29
  30 // The size of the InstantMostVisitedItem cache.
  31 const size_t kMaxInstantMostVisitedItemCacheSize = 100;
  32
  33 // Returns true if items stored in |old_item_id_pairs| and |new_items| are
  34 // equal.
  35 bool AreMostVisitedItemsEqual(
  36     const std::vector<InstantMostVisitedItemIDPair>& old_item_id_pairs,
  37     const std::vector<InstantMostVisitedItem>& new_items) {
  38   if (old_item_id_pairs.size() != new_items.size())
  39     return false;
  40
  41   for (size_t i = 0; i < new_items.size(); ++i) {
  42     if (new_items[i].url != old_item_id_pairs[i].second.url ||
  43         new_items[i].title != old_item_id_pairs[i].second.title) {
  44       return false;
  45     }
  46   }
  47   return true;
  48 }
  49
  50 }  // namespace
  51
  52 namespace internal {  // for testing
  53
  54 // Parses |path| and fills in |id| with the InstantRestrictedID obtained from
  55 // the |path|. |render_view_id| is the ID of the associated RenderView.
  56 //
  57 // |path| is a pair of |render_view_id| and |restricted_id|, and it is
  58 // contained in Instant Extended URLs. A valid |path| is in the form:
  59 // <render_view_id>/<restricted_id>
  60 //
  61 // If the |path| is valid, returns true and fills in |id| with restricted_id
  62 // value. If the |path| is invalid, returns false and |id| is not set.
  63 bool GetInstantRestrictedIDFromPath(int render_view_id,
  64                                     const std::string& path,
  65                                     InstantRestrictedID* id) {
  66   // Check that the path is of Most visited item ID form.
  67   std::vector<std::string> tokens;
  68   if (Tokenize(path, "/", &tokens) != 2)
  69     return false;
  70
  71   int view_id = 0;
  72   if (!base::StringToInt(tokens[0], &view_id) || view_id != render_view_id)
  73     return false;
  74   return base::StringToInt(tokens[1], id);
  75 }
  76
  77 bool GetRestrictedIDFromFaviconUrl(int render_view_id,
  78                                    const GURL& url,
  79                                    std::string* favicon_params,
  80                                    InstantRestrictedID* rid) {
  81   // Strip leading slash.
  82   std::string raw_path = url.path();
  83   DCHECK_GT(raw_path.length(), (size_t) 0);
  84   DCHECK_EQ(raw_path[0], '/');
  85   raw_path = raw_path.substr(1);
  86
  87   chrome::ParsedFaviconPath parsed;
  88   if (!chrome::ParseFaviconPath(raw_path, chrome::FAVICON, &parsed))
  89     return false;
  90
  91   // The part of the URL which details the favicon parameters should be returned
  92   // so the favicon URL can be reconstructed, by replacing the restricted_id
  93   // with the actual URL from which the favicon is being requested.
  94   *favicon_params = raw_path.substr(0, parsed.path_index);
  95
  96   // The part of the favicon URL which is supposed to contain the URL from
  97   // which the favicon is being requested (i.e., the page's URL) actually
  98   // contains a pair in the format "<view_id>/<restricted_id>". If the page's
  99   // URL is not in the expected format then the execution must be stopped,
 100   // returning |true|, indicating that the favicon URL should be translated
 101   // without the page's URL part, to prevent search providers from spoofing
 102   // the user's browsing history. For example, the following favicon URL
 103   // "chrome-search://favicon/http://www.secretsite.com" it is not in the
 104   // expected format "chrome-search://favicon/<view_id>/<restricted_id>" so
 105   // the pages's URL part ("http://www.secretsite.com") should be removed
 106   // entirely from the translated URL otherwise the search engine would know
 107   // if the user has visited that page (by verifying whether the favicon URL
 108   // returns an image for a particular page's URL); the translated URL in this
 109   // case would be "chrome-search://favicon/" which would simply return the
 110   // default favicon.
 111   std::string id_part = raw_path.substr(parsed.path_index);
 112   InstantRestrictedID id;
 113   if (!GetInstantRestrictedIDFromPath(render_view_id, id_part, &id))
 114     return true;
 115
 116   *rid = id;
 117   return true;
 118 }
 119
 120 // Parses a thumbnail |url| and fills in |id| with the InstantRestrictedID
 121 // obtained from the |url|. |render_view_id| is the ID of the associated
 122 // RenderView.
 123 //
 124 // Valid |url| forms:
 125 // chrome-search://thumb/<view_id>/<restricted_id>
 126 //
 127 // If the |url| is valid, returns true and fills in |id| with restricted_id
 128 // value. If the |url| is invalid, returns false and |id| is not set.
 129 bool GetRestrictedIDFromThumbnailUrl(int render_view_id,
 130                                      const GURL& url,
 131                                      InstantRestrictedID* id) {
 132   // Strip leading slash.
 133   std::string path = url.path();
 134   DCHECK_GT(path.length(), (size_t) 0);
 135   DCHECK_EQ(path[0], '/');
 136   path = path.substr(1);
 137
 138   return GetInstantRestrictedIDFromPath(render_view_id, path, id);
 139 }
 140
 141 }  // namespace internal
 142
 143 SearchBox::SearchBox(content::RenderView* render_view)
 144     : content::RenderViewObserver(render_view),
 145       content::RenderViewObserverTracker<SearchBox>(render_view),
 146     app_launcher_enabled_(false),
 147     is_focused_(false),
 148     is_input_in_progress_(false),
 149     is_key_capture_enabled_(false),
 150     display_instant_results_(false),
 151     most_visited_items_cache_(kMaxInstantMostVisitedItemCacheSize),
 152     query_(),
 153     start_margin_(0),
 154     width_(0) {
 155 }
 156
 157 SearchBox::~SearchBox() {
 158 }
 159
 160 void SearchBox::LogEvent(NTPLoggingEventType event) {
 161   render_view()->Send(new ChromeViewHostMsg_LogEvent(
 162       render_view()->GetRoutingID(), render_view()->GetPageId(), event));
 163 }
 164
 165 void SearchBox::LogImpression(int position, const base::string16& provider) {
 166   render_view()->Send(new ChromeViewHostMsg_LogImpression(
 167       render_view()->GetRoutingID(), render_view()->GetPageId(), position,
 168       provider));
 169 }
 170
 171 void SearchBox::CheckIsUserSignedInToChromeAs(const base::string16& identity) {
 172   render_view()->Send(new ChromeViewHostMsg_ChromeIdentityCheck(
 173       render_view()->GetRoutingID(), render_view()->GetPageId(), identity));
 174 }
 175
 176 void SearchBox::DeleteMostVisitedItem(
 177     InstantRestrictedID most_visited_item_id) {
 178   render_view()->Send(new ChromeViewHostMsg_SearchBoxDeleteMostVisitedItem(
 179       render_view()->GetRoutingID(), render_view()->GetPageId(),
 180       GetURLForMostVisitedItem(most_visited_item_id)));
 181 }
 182
 183 bool SearchBox::GenerateFaviconURLFromTransientURL(const GURL& transient_url,
 184                                                    GURL* url) const {
 185   std::string favicon_params;
 186   InstantRestrictedID rid = -1;
 187   bool success = internal::GetRestrictedIDFromFaviconUrl(
 188       render_view()->GetRoutingID(), transient_url, &favicon_params, &rid);
 189   if (!success)
 190     return false;
 191
 192   InstantMostVisitedItem item;
 193   std::string item_url;
 194   if (rid != -1 && GetMostVisitedItemWithID(rid, &item))
 195     item_url = item.url.spec();
 196
 197   *url = GURL(base::StringPrintf("chrome-search://favicon/%s%s",
 198                                  favicon_params.c_str(),
 199                                  item_url.c_str()));
 200   return true;
 201 }
 202
 203 bool SearchBox::GenerateThumbnailURLFromTransientURL(const GURL& transient_url,
 204                                                      GURL* url) const {
 205   InstantRestrictedID rid = 0;
 206   if (!internal::GetRestrictedIDFromThumbnailUrl(render_view()->GetRoutingID(),
 207                                                  transient_url, &rid)) {
 208     return false;
 209   }
 210
 211   GURL most_visited_item_url(GetURLForMostVisitedItem(rid));
 212   if (most_visited_item_url.is_empty())
 213     return false;
 214   *url = GURL(base::StringPrintf("chrome-search://thumb/%s",
 215                                  most_visited_item_url.spec().c_str()));
 216   return true;
 217 }
 218
 219 void SearchBox::GetMostVisitedItems(
 220     std::vector<InstantMostVisitedItemIDPair>* items) const {
 221   return most_visited_items_cache_.GetCurrentItems(items);
 222 }
 223
 224 bool SearchBox::GetMostVisitedItemWithID(
 225     InstantRestrictedID most_visited_item_id,
 226     InstantMostVisitedItem* item) const {
 227   return most_visited_items_cache_.GetItemWithRestrictedID(most_visited_item_id,
 228                                                            item);
 229 }
 230
 231 const ThemeBackgroundInfo& SearchBox::GetThemeBackgroundInfo() {
 232   return theme_info_;
 233 }
 234
 235 void SearchBox::Focus() {
 236   render_view()->Send(new ChromeViewHostMsg_FocusOmnibox(
 237       render_view()->GetRoutingID(), render_view()->GetPageId(),
 238       OMNIBOX_FOCUS_VISIBLE));
 239 }
 240
 241 void SearchBox::NavigateToURL(const GURL& url,
 242                               WindowOpenDisposition disposition,
 243                               bool is_most_visited_item_url) {
 244   render_view()->Send(new ChromeViewHostMsg_SearchBoxNavigate(
 245       render_view()->GetRoutingID(), render_view()->GetPageId(), url,
 246       disposition, is_most_visited_item_url));
 247 }
 248
 249 void SearchBox::Paste(const base::string16& text) {
 250   render_view()->Send(new ChromeViewHostMsg_PasteAndOpenDropdown(
 251       render_view()->GetRoutingID(), render_view()->GetPageId(), text));
 252 }
 253
 254 void SearchBox::SetVoiceSearchSupported(bool supported) {
 255   render_view()->Send(new ChromeViewHostMsg_SetVoiceSearchSupported(
 256       render_view()->GetRoutingID(), render_view()->GetPageId(), supported));
 257 }
 258
 259 void SearchBox::StartCapturingKeyStrokes() {
 260   render_view()->Send(new ChromeViewHostMsg_FocusOmnibox(
 261       render_view()->GetRoutingID(), render_view()->GetPageId(),
 262       OMNIBOX_FOCUS_INVISIBLE));
 263 }
 264
 265 void SearchBox::StopCapturingKeyStrokes() {
 266   render_view()->Send(new ChromeViewHostMsg_FocusOmnibox(
 267       render_view()->GetRoutingID(), render_view()->GetPageId(),
 268       OMNIBOX_FOCUS_NONE));
 269 }
 270
 271 void SearchBox::UndoAllMostVisitedDeletions() {
 272   render_view()->Send(
 273       new ChromeViewHostMsg_SearchBoxUndoAllMostVisitedDeletions(
 274       render_view()->GetRoutingID(), render_view()->GetPageId()));
 275 }
 276
 277 void SearchBox::UndoMostVisitedDeletion(
 278     InstantRestrictedID most_visited_item_id) {
 279   render_view()->Send(new ChromeViewHostMsg_SearchBoxUndoMostVisitedDeletion(
 280       render_view()->GetRoutingID(), render_view()->GetPageId(),
 281       GetURLForMostVisitedItem(most_visited_item_id)));
 282 }
 283
 284 bool SearchBox::OnMessageReceived(const IPC::Message& message) {
 285   bool handled = true;
 286   IPC_BEGIN_MESSAGE_MAP(SearchBox, message)
 287     IPC_MESSAGE_HANDLER(ChromeViewMsg_ChromeIdentityCheckResult,
 288                         OnChromeIdentityCheckResult)
 289     IPC_MESSAGE_HANDLER(ChromeViewMsg_DetermineIfPageSupportsInstant,
 290                         OnDetermineIfPageSupportsInstant)
 291     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxFocusChanged, OnFocusChanged)
 292     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxMarginChange, OnMarginChange)
 293     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxMostVisitedItemsChanged,
 294                         OnMostVisitedChanged)
 295     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxPromoInformation,
 296                         OnPromoInformationReceived)
 297     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetDisplayInstantResults,
 298                         OnSetDisplayInstantResults)
 299     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetInputInProgress,
 300                         OnSetInputInProgress)
 301     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetSuggestionToPrefetch,
 302                         OnSetSuggestionToPrefetch)
 303     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSubmit, OnSubmit)
 304     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxThemeChanged,
 305                         OnThemeChanged)
 306     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxToggleVoiceSearch,
 307                         OnToggleVoiceSearch)
 308     IPC_MESSAGE_UNHANDLED(handled = false)
 309   IPC_END_MESSAGE_MAP()
 310   return handled;
 311 }
 312
 313 void SearchBox::OnChromeIdentityCheckResult(const base::string16& identity,
 314                                             bool identity_match) {
 315   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 316     extensions_v8::SearchBoxExtension::DispatchChromeIdentityCheckResult(
 317         render_view()->GetWebView()->mainFrame(), identity, identity_match);
 318   }
 319 }
 320
 321 void SearchBox::OnDetermineIfPageSupportsInstant() {
 322   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 323     bool result = extensions_v8::SearchBoxExtension::PageSupportsInstant(
 324         render_view()->GetWebView()->mainFrame());
 325     DVLOG(1) << render_view() << " PageSupportsInstant: " << result;
 326     render_view()->Send(new ChromeViewHostMsg_InstantSupportDetermined(
 327         render_view()->GetRoutingID(), render_view()->GetPageId(), result));
 328   }
 329 }
 330
 331 void SearchBox::OnFocusChanged(OmniboxFocusState new_focus_state,
 332                                OmniboxFocusChangeReason reason) {
 333   bool key_capture_enabled = new_focus_state == OMNIBOX_FOCUS_INVISIBLE;
 334   if (key_capture_enabled != is_key_capture_enabled_) {
 335     // Tell the page if the key capture mode changed unless the focus state
 336     // changed because of TYPING. This is because in that case, the browser
 337     // hasn't really stopped capturing key strokes.
 338     //
 339     // (More practically, if we don't do this check, the page would receive
 340     // onkeycapturechange before the corresponding onchange, and the page would
 341     // have no way of telling whether the keycapturechange happened because of
 342     // some actual user action or just because they started typing.)
 343     if (reason != OMNIBOX_FOCUS_CHANGE_TYPING &&
 344         render_view()->GetWebView() &&
 345         render_view()->GetWebView()->mainFrame()) {
 346       is_key_capture_enabled_ = key_capture_enabled;
 347       DVLOG(1) << render_view() << " OnKeyCaptureChange";
 348       extensions_v8::SearchBoxExtension::DispatchKeyCaptureChange(
 349           render_view()->GetWebView()->mainFrame());
 350     }
 351   }
 352   bool is_focused = new_focus_state == OMNIBOX_FOCUS_VISIBLE;
 353   if (is_focused != is_focused_) {
 354     is_focused_ = is_focused;
 355     DVLOG(1) << render_view() << " OnFocusChange";
 356     if (render_view()->GetWebView() &&
 357         render_view()->GetWebView()->mainFrame()) {
 358       extensions_v8::SearchBoxExtension::DispatchFocusChange(
 359           render_view()->GetWebView()->mainFrame());
 360     }
 361   }
 362 }
 363
 364 void SearchBox::OnMarginChange(int margin, int width) {
 365   start_margin_ = margin;
 366   width_ = width;
 367   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 368     extensions_v8::SearchBoxExtension::DispatchMarginChange(
 369         render_view()->GetWebView()->mainFrame());
 370   }
 371 }
 372
 373 void SearchBox::OnMostVisitedChanged(
 374     const std::vector<InstantMostVisitedItem>& items) {
 375   std::vector<InstantMostVisitedItemIDPair> last_known_items;
 376   GetMostVisitedItems(&last_known_items);
 377
 378   if (AreMostVisitedItemsEqual(last_known_items, items))
 379     return;  // Do not send duplicate onmostvisitedchange events.
 380
 381   most_visited_items_cache_.AddItems(items);
 382   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 383     extensions_v8::SearchBoxExtension::DispatchMostVisitedChanged(
 384         render_view()->GetWebView()->mainFrame());
 385   }
 386 }
 387
 388 void SearchBox::OnPromoInformationReceived(bool is_app_launcher_enabled) {
 389   app_launcher_enabled_ = is_app_launcher_enabled;
 390 }
 391
 392 void SearchBox::OnSetDisplayInstantResults(bool display_instant_results) {
 393   display_instant_results_ = display_instant_results;
 394 }
 395
 396 void SearchBox::OnSetInputInProgress(bool is_input_in_progress) {
 397   if (is_input_in_progress_ != is_input_in_progress) {
 398     is_input_in_progress_ = is_input_in_progress;
 399     DVLOG(1) << render_view() << " OnSetInputInProgress";
 400     if (render_view()->GetWebView() &&
 401         render_view()->GetWebView()->mainFrame()) {
 402       if (is_input_in_progress_) {
 403         extensions_v8::SearchBoxExtension::DispatchInputStart(
 404             render_view()->GetWebView()->mainFrame());
 405       } else {
 406         extensions_v8::SearchBoxExtension::DispatchInputCancel(
 407             render_view()->GetWebView()->mainFrame());
 408       }
 409     }
 410   }
 411 }
 412
 413 void SearchBox::OnSetSuggestionToPrefetch(const InstantSuggestion& suggestion) {
 414   suggestion_ = suggestion;
 415   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 416     DVLOG(1) << render_view() << " OnSetSuggestionToPrefetch";
 417     extensions_v8::SearchBoxExtension::DispatchSuggestionChange(
 418         render_view()->GetWebView()->mainFrame());
 419   }
 420 }
 421
 422 void SearchBox::OnSubmit(const base::string16& query) {
 423   query_ = query;
 424   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 425     DVLOG(1) << render_view() << " OnSubmit";
 426     extensions_v8::SearchBoxExtension::DispatchSubmit(
 427         render_view()->GetWebView()->mainFrame());
 428   }
 429   if (!query.empty())
 430     Reset();
 431 }
 432
 433 void SearchBox::OnThemeChanged(const ThemeBackgroundInfo& theme_info) {
 434   // Do not send duplicate notifications.
 435   if (theme_info_ == theme_info)
 436     return;
 437
 438   theme_info_ = theme_info;
 439   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 440     extensions_v8::SearchBoxExtension::DispatchThemeChange(
 441         render_view()->GetWebView()->mainFrame());
 442   }
 443 }
 444
 445 void SearchBox::OnToggleVoiceSearch() {
 446   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
 447     extensions_v8::SearchBoxExtension::DispatchToggleVoiceSearch(
 448         render_view()->GetWebView()->mainFrame());
 449   }
 450 }
 451
 452 GURL SearchBox::GetURLForMostVisitedItem(InstantRestrictedID item_id) const {
 453   InstantMostVisitedItem item;
 454   return GetMostVisitedItemWithID(item_id, &item) ? item.url : GURL();
 455 }
 456
 457 void SearchBox::Reset() {
 458   query_.clear();
 459   suggestion_ = InstantSuggestion();
 460   start_margin_ = 0;
 461   width_ = 0;
 462   is_focused_ = false;
 463   is_key_capture_enabled_ = false;
 464   theme_info_ = ThemeBackgroundInfo();
 465 }