| // 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/renderer/searchbox/searchbox.h" |
| |
| #include <string> |
| |
| #include "base/logging.h" |
| #include "base/strings/string_number_conversions.h" |
| #include "base/strings/string_split.h" |
| #include "base/strings/string_util.h" |
| #include "base/strings/utf_string_conversions.h" |
| #include "base/time/time.h" |
| #include "chrome/common/chrome_switches.h" |
| #include "chrome/common/render_messages.h" |
| #include "chrome/common/url_constants.h" |
| #include "chrome/renderer/searchbox/searchbox_extension.h" |
| #include "components/favicon_base/fallback_icon_url_parser.h" |
| #include "components/favicon_base/favicon_types.h" |
| #include "components/favicon_base/favicon_url_parser.h" |
| #include "components/favicon_base/large_icon_url_parser.h" |
| #include "components/omnibox/common/omnibox_focus_state.h" |
| #include "content/public/renderer/render_frame.h" |
| #include "content/public/renderer/render_view.h" |
| #include "net/base/escape.h" |
| #include "third_party/WebKit/public/web/WebDocument.h" |
| #include "third_party/WebKit/public/web/WebFrame.h" |
| #include "third_party/WebKit/public/web/WebLocalFrame.h" |
| #include "third_party/WebKit/public/web/WebPerformance.h" |
| #include "third_party/WebKit/public/web/WebView.h" |
| #include "url/gurl.h" |
| |
| namespace { |
| |
| // The size of the InstantMostVisitedItem cache. |
| const size_t kMaxInstantMostVisitedItemCacheSize = 100; |
| |
| // Returns true if items stored in |old_item_id_pairs| and |new_items| are |
| // equal. |
| bool AreMostVisitedItemsEqual( |
| const std::vector<InstantMostVisitedItemIDPair>& old_item_id_pairs, |
| const std::vector<InstantMostVisitedItem>& new_items) { |
| if (old_item_id_pairs.size() != new_items.size()) |
| return false; |
| |
| for (size_t i = 0; i < new_items.size(); ++i) { |
| if (new_items[i].url != old_item_id_pairs[i].second.url || |
| new_items[i].title != old_item_id_pairs[i].second.title) { |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| const char* GetIconTypeUrlHost(SearchBox::ImageSourceType type) { |
| switch (type) { |
| case SearchBox::FAVICON: |
| return "favicon"; |
| case SearchBox::LARGE_ICON: |
| return "large-icon"; |
| case SearchBox::FALLBACK_ICON: |
| return "fallback-icon"; |
| case SearchBox::THUMB: |
| return "thumb"; |
| default: |
| NOTREACHED(); |
| } |
| return nullptr; |
| } |
| |
| // Given |path| from an image URL, returns starting index of the page URL, |
| // depending on |type| of image URL. Returns -1 if parse fails. |
| int GetImagePathStartOfPageURL(SearchBox::ImageSourceType type, |
| const std::string& path) { |
| // TODO(huangs): Refactor this: http://crbug.com/468320. |
| switch (type) { |
| case SearchBox::FAVICON: { |
| chrome::ParsedFaviconPath parsed; |
| return chrome::ParseFaviconPath( |
| path, favicon_base::FAVICON, &parsed) ? parsed.path_index : -1; |
| } |
| case SearchBox::LARGE_ICON: { |
| LargeIconUrlParser parser; |
| return parser.Parse(path) ? parser.path_index() : -1; |
| } |
| case SearchBox::FALLBACK_ICON: { |
| chrome::ParsedFallbackIconPath parser; |
| return parser.Parse(path) ? parser.path_index() : -1; |
| } |
| case SearchBox::THUMB: { |
| return 0; |
| } |
| default: { |
| NOTREACHED(); |
| break; |
| } |
| } |
| return -1; |
| } |
| |
| // Helper for SearchBox::GenerateImageURLFromTransientURL(). |
| class SearchBoxIconURLHelper: public SearchBox::IconURLHelper { |
| public: |
| explicit SearchBoxIconURLHelper(const SearchBox* search_box); |
| ~SearchBoxIconURLHelper() override; |
| int GetViewID() const override; |
| std::string GetURLStringFromRestrictedID(InstantRestrictedID rid) const |
| override; |
| |
| private: |
| const SearchBox* search_box_; |
| }; |
| |
| SearchBoxIconURLHelper::SearchBoxIconURLHelper(const SearchBox* search_box) |
| : search_box_(search_box) { |
| } |
| |
| SearchBoxIconURLHelper::~SearchBoxIconURLHelper() { |
| } |
| |
| int SearchBoxIconURLHelper::GetViewID() const { |
| return search_box_->render_view()->GetRoutingID(); |
| } |
| |
| std::string SearchBoxIconURLHelper::GetURLStringFromRestrictedID( |
| InstantRestrictedID rid) const { |
| InstantMostVisitedItem item; |
| if (!search_box_->GetMostVisitedItemWithID(rid, &item)) |
| return std::string(); |
| |
| return item.url.spec(); |
| } |
| |
| } // namespace |
| |
| namespace internal { // for testing |
| |
| // Parses "<view_id>/<restricted_id>". If successful, assigns |
| // |*view_id| := "<view_id>", |*rid| := "<restricted_id>", and returns true. |
| bool ParseViewIdAndRestrictedId(const std::string& id_part, |
| int* view_id_out, |
| InstantRestrictedID* rid_out) { |
| DCHECK(view_id_out); |
| DCHECK(rid_out); |
| // Check that the path is of Most visited item ID form. |
| std::vector<base::StringPiece> tokens = base::SplitStringPiece( |
| id_part, "/", base::KEEP_WHITESPACE, base::SPLIT_WANT_NONEMPTY); |
| if (tokens.size() != 2) |
| return false; |
| |
| int view_id; |
| InstantRestrictedID rid; |
| if (!base::StringToInt(tokens[0], &view_id) || view_id < 0 || |
| !base::StringToInt(tokens[1], &rid) || rid < 0) |
| return false; |
| |
| *view_id_out = view_id; |
| *rid_out = rid; |
| return true; |
| } |
| |
| // Takes icon |url| of given |type|, e.g., FAVICON looking like |
| // |
| // chrome-search://favicon/<view_id>/<restricted_id> |
| // chrome-search://favicon/<parameters>/<view_id>/<restricted_id> |
| // |
| // If successful, assigns |*param_part| := "" or "<parameters>/" (note trailing |
| // slash), |*view_id| := "<view_id>", |*rid| := "rid", and returns true. |
| bool ParseIconRestrictedUrl(const GURL& url, |
| SearchBox::ImageSourceType type, |
| std::string* param_part, |
| int* view_id, |
| InstantRestrictedID* rid) { |
| DCHECK(param_part); |
| DCHECK(view_id); |
| DCHECK(rid); |
| // Strip leading slash. |
| std::string raw_path = url.path(); |
| DCHECK_GT(raw_path.length(), (size_t) 0); |
| DCHECK_EQ(raw_path[0], '/'); |
| raw_path = raw_path.substr(1); |
| |
| int path_index = GetImagePathStartOfPageURL(type, raw_path); |
| if (path_index < 0) |
| return false; |
| |
| std::string id_part = raw_path.substr(path_index); |
| if (!ParseViewIdAndRestrictedId(id_part, view_id, rid)) |
| return false; |
| |
| *param_part = raw_path.substr(0, path_index); |
| return true; |
| } |
| |
| bool TranslateIconRestrictedUrl(const GURL& transient_url, |
| SearchBox::ImageSourceType type, |
| const SearchBox::IconURLHelper& helper, |
| GURL* url) { |
| std::string params; |
| int view_id = -1; |
| InstantRestrictedID rid = -1; |
| |
| if (!internal::ParseIconRestrictedUrl( |
| transient_url, type, ¶ms, &view_id, &rid) || |
| view_id != helper.GetViewID()) { |
| if (type == SearchBox::FAVICON) { |
| *url = GURL(base::StringPrintf("chrome-search://%s/", |
| GetIconTypeUrlHost(SearchBox::FAVICON))); |
| return true; |
| } |
| return false; |
| } |
| |
| std::string item_url = helper.GetURLStringFromRestrictedID(rid); |
| *url = GURL(base::StringPrintf("chrome-search://%s/%s%s", |
| GetIconTypeUrlHost(type), |
| params.c_str(), |
| item_url.c_str())); |
| return true; |
| } |
| |
| } // namespace internal |
| |
| SearchBox::IconURLHelper::IconURLHelper() { |
| } |
| |
| SearchBox::IconURLHelper::~IconURLHelper() { |
| } |
| |
| SearchBox::SearchBox(content::RenderView* render_view) |
| : content::RenderViewObserver(render_view), |
| content::RenderViewObserverTracker<SearchBox>(render_view), |
| page_seq_no_(0), |
| app_launcher_enabled_(false), |
| is_focused_(false), |
| is_input_in_progress_(false), |
| is_key_capture_enabled_(false), |
| display_instant_results_(false), |
| most_visited_items_cache_(kMaxInstantMostVisitedItemCacheSize), |
| query_(), |
| start_margin_(0) { |
| } |
| |
| SearchBox::~SearchBox() { |
| } |
| |
| void SearchBox::LogEvent(NTPLoggingEventType event) { |
| // The main frame for the current RenderView may be out-of-process, in which |
| // case it won't have performance(). Use the default delta of 0 in this |
| // case. |
| base::TimeDelta delta; |
| if (render_view()->GetWebView()->mainFrame()->isWebLocalFrame()) { |
| // navigation_start in ms. |
| uint64 start = 1000 * (render_view()->GetMainRenderFrame()->GetWebFrame()-> |
| performance().navigationStart()); |
| uint64 now = (base::TimeTicks::Now() - base::TimeTicks::UnixEpoch()) |
| .InMilliseconds(); |
| DCHECK(now >= start); |
| delta = base::TimeDelta::FromMilliseconds(now - start); |
| } |
| render_view()->Send(new ChromeViewHostMsg_LogEvent( |
| render_view()->GetRoutingID(), page_seq_no_, event, delta)); |
| } |
| |
| void SearchBox::LogMostVisitedImpression(int position, |
| const base::string16& provider) { |
| render_view()->Send(new ChromeViewHostMsg_LogMostVisitedImpression( |
| render_view()->GetRoutingID(), page_seq_no_, position, provider)); |
| } |
| |
| void SearchBox::LogMostVisitedNavigation(int position, |
| const base::string16& provider) { |
| render_view()->Send(new ChromeViewHostMsg_LogMostVisitedNavigation( |
| render_view()->GetRoutingID(), page_seq_no_, position, provider)); |
| } |
| |
| void SearchBox::CheckIsUserSignedInToChromeAs(const base::string16& identity) { |
| render_view()->Send(new ChromeViewHostMsg_ChromeIdentityCheck( |
| render_view()->GetRoutingID(), page_seq_no_, identity)); |
| } |
| |
| void SearchBox::CheckIsUserSyncingHistory() { |
| render_view()->Send(new ChromeViewHostMsg_HistorySyncCheck( |
| render_view()->GetRoutingID(), page_seq_no_)); |
| } |
| |
| void SearchBox::DeleteMostVisitedItem( |
| InstantRestrictedID most_visited_item_id) { |
| render_view()->Send(new ChromeViewHostMsg_SearchBoxDeleteMostVisitedItem( |
| render_view()->GetRoutingID(), |
| page_seq_no_, |
| GetURLForMostVisitedItem(most_visited_item_id))); |
| } |
| |
| bool SearchBox::GenerateImageURLFromTransientURL(const GURL& transient_url, |
| ImageSourceType type, |
| GURL* url) const { |
| SearchBoxIconURLHelper helper(this); |
| return internal::TranslateIconRestrictedUrl(transient_url, type, helper, url); |
| } |
| |
| void SearchBox::GetMostVisitedItems( |
| std::vector<InstantMostVisitedItemIDPair>* items) const { |
| return most_visited_items_cache_.GetCurrentItems(items); |
| } |
| |
| bool SearchBox::GetMostVisitedItemWithID( |
| InstantRestrictedID most_visited_item_id, |
| InstantMostVisitedItem* item) const { |
| return most_visited_items_cache_.GetItemWithRestrictedID(most_visited_item_id, |
| item); |
| } |
| |
| const ThemeBackgroundInfo& SearchBox::GetThemeBackgroundInfo() { |
| return theme_info_; |
| } |
| |
| const EmbeddedSearchRequestParams& SearchBox::GetEmbeddedSearchRequestParams() { |
| return embedded_search_request_params_; |
| } |
| |
| void SearchBox::Focus() { |
| render_view()->Send(new ChromeViewHostMsg_FocusOmnibox( |
| render_view()->GetRoutingID(), page_seq_no_, OMNIBOX_FOCUS_VISIBLE)); |
| } |
| |
| void SearchBox::NavigateToURL(const GURL& url, |
| WindowOpenDisposition disposition, |
| bool is_most_visited_item_url) { |
| render_view()->Send(new ChromeViewHostMsg_SearchBoxNavigate( |
| render_view()->GetRoutingID(), page_seq_no_, url, |
| disposition, is_most_visited_item_url)); |
| } |
| |
| void SearchBox::Paste(const base::string16& text) { |
| render_view()->Send(new ChromeViewHostMsg_PasteAndOpenDropdown( |
| render_view()->GetRoutingID(), page_seq_no_, text)); |
| } |
| |
| void SearchBox::SetVoiceSearchSupported(bool supported) { |
| render_view()->Send(new ChromeViewHostMsg_SetVoiceSearchSupported( |
| render_view()->GetRoutingID(), page_seq_no_, supported)); |
| } |
| |
| void SearchBox::StartCapturingKeyStrokes() { |
| render_view()->Send(new ChromeViewHostMsg_FocusOmnibox( |
| render_view()->GetRoutingID(), page_seq_no_, OMNIBOX_FOCUS_INVISIBLE)); |
| } |
| |
| void SearchBox::StopCapturingKeyStrokes() { |
| render_view()->Send(new ChromeViewHostMsg_FocusOmnibox( |
| render_view()->GetRoutingID(), page_seq_no_, OMNIBOX_FOCUS_NONE)); |
| } |
| |
| void SearchBox::UndoAllMostVisitedDeletions() { |
| render_view()->Send( |
| new ChromeViewHostMsg_SearchBoxUndoAllMostVisitedDeletions( |
| render_view()->GetRoutingID(), page_seq_no_)); |
| } |
| |
| void SearchBox::UndoMostVisitedDeletion( |
| InstantRestrictedID most_visited_item_id) { |
| render_view()->Send(new ChromeViewHostMsg_SearchBoxUndoMostVisitedDeletion( |
| render_view()->GetRoutingID(), page_seq_no_, |
| GetURLForMostVisitedItem(most_visited_item_id))); |
| } |
| |
| bool SearchBox::OnMessageReceived(const IPC::Message& message) { |
| bool handled = true; |
| IPC_BEGIN_MESSAGE_MAP(SearchBox, message) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SetPageSequenceNumber, |
| OnSetPageSequenceNumber) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_ChromeIdentityCheckResult, |
| OnChromeIdentityCheckResult) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_DetermineIfPageSupportsInstant, |
| OnDetermineIfPageSupportsInstant) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_HistorySyncCheckResult, |
| OnHistorySyncCheckResult) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxFocusChanged, OnFocusChanged) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxMarginChange, OnMarginChange) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxMostVisitedItemsChanged, |
| OnMostVisitedChanged) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxPromoInformation, |
| OnPromoInformationReceived) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetDisplayInstantResults, |
| OnSetDisplayInstantResults) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetInputInProgress, |
| OnSetInputInProgress) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetSuggestionToPrefetch, |
| OnSetSuggestionToPrefetch) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSubmit, OnSubmit) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxThemeChanged, |
| OnThemeChanged) |
| IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxToggleVoiceSearch, |
| OnToggleVoiceSearch) |
| IPC_MESSAGE_UNHANDLED(handled = false) |
| IPC_END_MESSAGE_MAP() |
| return handled; |
| } |
| |
| void SearchBox::OnSetPageSequenceNumber(int page_seq_no) { |
| page_seq_no_ = page_seq_no; |
| } |
| |
| void SearchBox::OnChromeIdentityCheckResult(const base::string16& identity, |
| bool identity_match) { |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchChromeIdentityCheckResult( |
| render_view()->GetWebView()->mainFrame(), identity, identity_match); |
| } |
| } |
| |
| void SearchBox::OnDetermineIfPageSupportsInstant() { |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| bool result = extensions_v8::SearchBoxExtension::PageSupportsInstant( |
| render_view()->GetWebView()->mainFrame()); |
| DVLOG(1) << render_view() << " PageSupportsInstant: " << result; |
| render_view()->Send(new ChromeViewHostMsg_InstantSupportDetermined( |
| render_view()->GetRoutingID(), page_seq_no_, result)); |
| } |
| } |
| |
| void SearchBox::OnFocusChanged(OmniboxFocusState new_focus_state, |
| OmniboxFocusChangeReason reason) { |
| bool key_capture_enabled = new_focus_state == OMNIBOX_FOCUS_INVISIBLE; |
| if (key_capture_enabled != is_key_capture_enabled_) { |
| // Tell the page if the key capture mode changed unless the focus state |
| // changed because of TYPING. This is because in that case, the browser |
| // hasn't really stopped capturing key strokes. |
| // |
| // (More practically, if we don't do this check, the page would receive |
| // onkeycapturechange before the corresponding onchange, and the page would |
| // have no way of telling whether the keycapturechange happened because of |
| // some actual user action or just because they started typing.) |
| if (reason != OMNIBOX_FOCUS_CHANGE_TYPING && |
| render_view()->GetWebView() && |
| render_view()->GetWebView()->mainFrame()) { |
| is_key_capture_enabled_ = key_capture_enabled; |
| DVLOG(1) << render_view() << " OnKeyCaptureChange"; |
| extensions_v8::SearchBoxExtension::DispatchKeyCaptureChange( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| bool is_focused = new_focus_state == OMNIBOX_FOCUS_VISIBLE; |
| if (is_focused != is_focused_) { |
| is_focused_ = is_focused; |
| DVLOG(1) << render_view() << " OnFocusChange"; |
| if (render_view()->GetWebView() && |
| render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchFocusChange( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| } |
| |
| void SearchBox::OnHistorySyncCheckResult(bool sync_history) { |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchHistorySyncCheckResult( |
| render_view()->GetWebView()->mainFrame(), sync_history); |
| } |
| } |
| |
| void SearchBox::OnMarginChange(int margin) { |
| start_margin_ = margin; |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchMarginChange( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| |
| void SearchBox::OnMostVisitedChanged( |
| const std::vector<InstantMostVisitedItem>& items) { |
| std::vector<InstantMostVisitedItemIDPair> last_known_items; |
| GetMostVisitedItems(&last_known_items); |
| |
| if (AreMostVisitedItemsEqual(last_known_items, items)) |
| return; // Do not send duplicate onmostvisitedchange events. |
| |
| most_visited_items_cache_.AddItems(items); |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchMostVisitedChanged( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| |
| void SearchBox::OnPromoInformationReceived(bool is_app_launcher_enabled) { |
| app_launcher_enabled_ = is_app_launcher_enabled; |
| } |
| |
| void SearchBox::OnSetDisplayInstantResults(bool display_instant_results) { |
| display_instant_results_ = display_instant_results; |
| } |
| |
| void SearchBox::OnSetInputInProgress(bool is_input_in_progress) { |
| if (is_input_in_progress_ != is_input_in_progress) { |
| is_input_in_progress_ = is_input_in_progress; |
| DVLOG(1) << render_view() << " OnSetInputInProgress"; |
| if (render_view()->GetWebView() && |
| render_view()->GetWebView()->mainFrame()) { |
| if (is_input_in_progress_) { |
| extensions_v8::SearchBoxExtension::DispatchInputStart( |
| render_view()->GetWebView()->mainFrame()); |
| } else { |
| extensions_v8::SearchBoxExtension::DispatchInputCancel( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| } |
| } |
| |
| void SearchBox::OnSetSuggestionToPrefetch(const InstantSuggestion& suggestion) { |
| suggestion_ = suggestion; |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| DVLOG(1) << render_view() << " OnSetSuggestionToPrefetch"; |
| extensions_v8::SearchBoxExtension::DispatchSuggestionChange( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| |
| void SearchBox::OnSubmit(const base::string16& query, |
| const EmbeddedSearchRequestParams& params) { |
| query_ = query; |
| embedded_search_request_params_ = params; |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| DVLOG(1) << render_view() << " OnSubmit"; |
| extensions_v8::SearchBoxExtension::DispatchSubmit( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| if (!query.empty()) |
| Reset(); |
| } |
| |
| void SearchBox::OnThemeChanged(const ThemeBackgroundInfo& theme_info) { |
| // Do not send duplicate notifications. |
| if (theme_info_ == theme_info) |
| return; |
| |
| theme_info_ = theme_info; |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchThemeChange( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| |
| void SearchBox::OnToggleVoiceSearch() { |
| if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) { |
| extensions_v8::SearchBoxExtension::DispatchToggleVoiceSearch( |
| render_view()->GetWebView()->mainFrame()); |
| } |
| } |
| |
| GURL SearchBox::GetURLForMostVisitedItem(InstantRestrictedID item_id) const { |
| InstantMostVisitedItem item; |
| return GetMostVisitedItemWithID(item_id, &item) ? item.url : GURL(); |
| } |
| |
| void SearchBox::Reset() { |
| query_.clear(); |
| embedded_search_request_params_ = EmbeddedSearchRequestParams(); |
| suggestion_ = InstantSuggestion(); |
| start_margin_ = 0; |
| is_focused_ = false; |
| is_key_capture_enabled_ = false; |
| theme_info_ = ThemeBackgroundInfo(); |
| } |