| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #include "chrome/browser/autocomplete/zero_suggest_provider.h" | 5 #include "chrome/browser/autocomplete/zero_suggest_provider.h" |
| 6 | 6 |
| 7 #include "base/callback.h" | 7 #include "base/callback.h" |
| 8 #include "base/i18n/case_conversion.h" | 8 #include "base/i18n/case_conversion.h" |
| 9 #include "base/json/json_string_value_serializer.h" | 9 #include "base/json/json_string_value_serializer.h" |
| 10 #include "base/metrics/histogram.h" | 10 #include "base/metrics/histogram.h" |
| 11 #include "base/metrics/user_metrics.h" | 11 #include "base/metrics/user_metrics.h" |
| 12 #include "base/prefs/pref_service.h" | 12 #include "base/prefs/pref_service.h" |
| 13 #include "base/strings/string16.h" | 13 #include "base/strings/string16.h" |
| 14 #include "base/strings/string_util.h" | 14 #include "base/strings/string_util.h" |
| 15 #include "base/strings/utf_string_conversions.h" | 15 #include "base/strings/utf_string_conversions.h" |
| 16 #include "base/time/time.h" | 16 #include "base/time/time.h" |
| 17 #include "chrome/browser/autocomplete/autocomplete_classifier.h" | 17 #include "chrome/browser/autocomplete/autocomplete_classifier.h" |
| 18 #include "chrome/browser/autocomplete/autocomplete_classifier_factory.h" | 18 #include "chrome/browser/autocomplete/autocomplete_classifier_factory.h" |
| 19 #include "chrome/browser/autocomplete/chrome_autocomplete_provider_client.h" | 19 #include "chrome/browser/autocomplete/chrome_autocomplete_provider_client.h" |
| 20 #include "chrome/browser/autocomplete/chrome_autocomplete_scheme_classifier.h" | 20 #include "chrome/browser/autocomplete/chrome_autocomplete_scheme_classifier.h" |
| 21 #include "chrome/browser/autocomplete/history_url_provider.h" | 21 #include "chrome/browser/autocomplete/history_url_provider.h" |
| 22 #include "chrome/browser/history/top_sites.h" | 22 #include "chrome/browser/history/top_sites.h" |
| 23 #include "chrome/browser/profiles/profile.h" | 23 #include "chrome/browser/profiles/profile.h" |
| 24 #include "chrome/browser/search_engines/template_url_service_factory.h" |
| 24 #include "chrome/common/pref_names.h" | 25 #include "chrome/common/pref_names.h" |
| 25 #include "components/history/core/browser/history_types.h" | 26 #include "components/history/core/browser/history_types.h" |
| 26 #include "components/metrics/proto/omnibox_input_type.pb.h" | 27 #include "components/metrics/proto/omnibox_input_type.pb.h" |
| 27 #include "components/omnibox/autocomplete_input.h" | 28 #include "components/omnibox/autocomplete_input.h" |
| 28 #include "components/omnibox/autocomplete_match.h" | 29 #include "components/omnibox/autocomplete_match.h" |
| 29 #include "components/omnibox/autocomplete_provider_listener.h" | 30 #include "components/omnibox/autocomplete_provider_listener.h" |
| 30 #include "components/omnibox/omnibox_field_trial.h" | 31 #include "components/omnibox/omnibox_field_trial.h" |
| 31 #include "components/omnibox/search_provider.h" | 32 #include "components/omnibox/search_provider.h" |
| 32 #include "components/pref_registry/pref_registry_syncable.h" | 33 #include "components/pref_registry/pref_registry_syncable.h" |
| 33 #include "components/search_engines/template_url_service.h" | 34 #include "components/search_engines/template_url_service.h" |
| (...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 109 if (default_provider == NULL) | 110 if (default_provider == NULL) |
| 110 return; | 111 return; |
| 111 | 112 |
| 112 base::string16 prefix; | 113 base::string16 prefix; |
| 113 TemplateURLRef::SearchTermsArgs search_term_args(prefix); | 114 TemplateURLRef::SearchTermsArgs search_term_args(prefix); |
| 114 GURL suggest_url(default_provider->suggestions_url_ref().ReplaceSearchTerms( | 115 GURL suggest_url(default_provider->suggestions_url_ref().ReplaceSearchTerms( |
| 115 search_term_args, template_url_service_->search_terms_data())); | 116 search_term_args, template_url_service_->search_terms_data())); |
| 116 if (!suggest_url.is_valid()) | 117 if (!suggest_url.is_valid()) |
| 117 return; | 118 return; |
| 118 | 119 |
| 119 // No need to send the current page URL in personalized suggest field trial. | 120 // No need to send the current page URL in personalized suggest or |
| 121 // most visited field trials. |
| 120 if (CanSendURL(input.current_url(), suggest_url, default_provider, | 122 if (CanSendURL(input.current_url(), suggest_url, default_provider, |
| 121 current_page_classification_, | 123 current_page_classification_, |
| 122 template_url_service_->search_terms_data(), client_.get()) && | 124 template_url_service_->search_terms_data(), client_.get()) && |
| 123 !OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial()) { | 125 !OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial() && |
| 126 !OmniboxFieldTrial::InZeroSuggestMostVisitedFieldTrial()) { |
| 124 // Update suggest_url to include the current_page_url. | 127 // Update suggest_url to include the current_page_url. |
| 125 search_term_args.current_page_url = current_query_; | 128 search_term_args.current_page_url = current_query_; |
| 126 suggest_url = GURL(default_provider->suggestions_url_ref(). | 129 suggest_url = GURL(default_provider->suggestions_url_ref(). |
| 127 ReplaceSearchTerms( | 130 ReplaceSearchTerms( |
| 128 search_term_args, | 131 search_term_args, |
| 129 template_url_service_->search_terms_data())); | 132 template_url_service_->search_terms_data())); |
| 130 } else if (!CanShowZeroSuggestWithoutSendingURL(suggest_url, | 133 } else if (!ShouldShowNonContextualZeroSuggest(suggest_url, |
| 131 input.current_url())) { | 134 input.current_url())) { |
| 132 return; | 135 return; |
| 133 } | 136 } |
| 134 | 137 |
| 135 done_ = false; | 138 done_ = false; |
| 136 // TODO(jered): Consider adding locally-sourced zero-suggestions here too. | 139 // TODO(jered): Consider adding locally-sourced zero-suggestions here too. |
| 137 // These may be useful on the NTP or more relevant to the user than server | 140 // These may be useful on the NTP or more relevant to the user than server |
| 138 // suggestions, if based on local browsing history. | 141 // suggestions, if based on local browsing history. |
| 139 MaybeUseCachedSuggestions(); | 142 MaybeUseCachedSuggestions(); |
| 140 Run(suggest_url); | 143 Run(suggest_url); |
| 141 } | 144 } |
| 142 | 145 |
| 143 void ZeroSuggestProvider::Stop(bool clear_cached_results) { | 146 void ZeroSuggestProvider::Stop(bool clear_cached_results) { |
| 144 if (fetcher_) | 147 if (fetcher_) |
| 145 LogOmniboxZeroSuggestRequest(ZERO_SUGGEST_REQUEST_INVALIDATED); | 148 LogOmniboxZeroSuggestRequest(ZERO_SUGGEST_REQUEST_INVALIDATED); |
| 146 fetcher_.reset(); | 149 fetcher_.reset(); |
| 150 waiting_for_most_visited_urls_request_ = false; |
| 147 done_ = true; | 151 done_ = true; |
| 148 | 152 |
| 149 if (clear_cached_results) { | 153 if (clear_cached_results) { |
| 150 // We do not call Clear() on |results_| to retain |verbatim_relevance| | 154 // We do not call Clear() on |results_| to retain |verbatim_relevance| |
| 151 // value in the |results_| object. |verbatim_relevance| is used at the | 155 // value in the |results_| object. |verbatim_relevance| is used at the |
| 152 // beginning of the next StartZeroSuggest() call to determine the current | 156 // beginning of the next StartZeroSuggest() call to determine the current |
| 153 // url match relevance. | 157 // url match relevance. |
| 154 results_.suggest_results.clear(); | 158 results_.suggest_results.clear(); |
| 155 results_.navigation_results.clear(); | 159 results_.navigation_results.clear(); |
| 156 current_query_.clear(); | 160 current_query_.clear(); |
| (...skipping 27 matching lines...) Expand all Loading... |
| 184 AutocompleteProviderListener* listener, | 188 AutocompleteProviderListener* listener, |
| 185 TemplateURLService* template_url_service, | 189 TemplateURLService* template_url_service, |
| 186 Profile* profile) | 190 Profile* profile) |
| 187 : BaseSearchProvider(template_url_service, | 191 : BaseSearchProvider(template_url_service, |
| 188 scoped_ptr<AutocompleteProviderClient>( | 192 scoped_ptr<AutocompleteProviderClient>( |
| 189 new ChromeAutocompleteProviderClient(profile)), | 193 new ChromeAutocompleteProviderClient(profile)), |
| 190 AutocompleteProvider::TYPE_ZERO_SUGGEST), | 194 AutocompleteProvider::TYPE_ZERO_SUGGEST), |
| 191 listener_(listener), | 195 listener_(listener), |
| 192 profile_(profile), | 196 profile_(profile), |
| 193 results_from_cache_(false), | 197 results_from_cache_(false), |
| 198 waiting_for_most_visited_urls_request_(false), |
| 194 weak_ptr_factory_(this) { | 199 weak_ptr_factory_(this) { |
| 195 } | 200 } |
| 196 | 201 |
| 197 ZeroSuggestProvider::~ZeroSuggestProvider() { | 202 ZeroSuggestProvider::~ZeroSuggestProvider() { |
| 198 } | 203 } |
| 199 | 204 |
| 200 const TemplateURL* ZeroSuggestProvider::GetTemplateURL(bool is_keyword) const { | 205 const TemplateURL* ZeroSuggestProvider::GetTemplateURL(bool is_keyword) const { |
| 201 // Zero suggest provider should not receive keyword results. | 206 // Zero suggest provider should not receive keyword results. |
| 202 DCHECK(!is_keyword); | 207 DCHECK(!is_keyword); |
| 203 return template_url_service_->GetDefaultSearchProvider(); | 208 return template_url_service_->GetDefaultSearchProvider(); |
| (...skipping 98 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 302 | 307 |
| 303 match.description = | 308 match.description = |
| 304 AutocompleteMatch::SanitizeString(navigation.description()); | 309 AutocompleteMatch::SanitizeString(navigation.description()); |
| 305 AutocompleteMatch::ClassifyLocationInString(base::string16::npos, 0, | 310 AutocompleteMatch::ClassifyLocationInString(base::string16::npos, 0, |
| 306 match.description.length(), ACMatchClassification::NONE, | 311 match.description.length(), ACMatchClassification::NONE, |
| 307 &match.description_class); | 312 &match.description_class); |
| 308 return match; | 313 return match; |
| 309 } | 314 } |
| 310 | 315 |
| 311 void ZeroSuggestProvider::Run(const GURL& suggest_url) { | 316 void ZeroSuggestProvider::Run(const GURL& suggest_url) { |
| 312 const int kFetcherID = 1; | |
| 313 fetcher_.reset( | |
| 314 net::URLFetcher::Create(kFetcherID, | |
| 315 suggest_url, | |
| 316 net::URLFetcher::GET, this)); | |
| 317 fetcher_->SetRequestContext(profile_->GetRequestContext()); | |
| 318 fetcher_->SetLoadFlags(net::LOAD_DO_NOT_SAVE_COOKIES); | |
| 319 // Add Chrome experiment state to the request headers. | |
| 320 net::HttpRequestHeaders headers; | |
| 321 variations::VariationsHttpHeaderProvider::GetInstance()->AppendHeaders( | |
| 322 fetcher_->GetOriginalURL(), profile_->IsOffTheRecord(), false, &headers); | |
| 323 fetcher_->SetExtraRequestHeaders(headers.ToString()); | |
| 324 fetcher_->Start(); | |
| 325 | |
| 326 if (OmniboxFieldTrial::InZeroSuggestMostVisitedFieldTrial()) { | 317 if (OmniboxFieldTrial::InZeroSuggestMostVisitedFieldTrial()) { |
| 327 most_visited_urls_.clear(); | 318 most_visited_urls_.clear(); |
| 328 history::TopSites* ts = profile_->GetTopSites(); | 319 history::TopSites* ts = profile_->GetTopSites(); |
| 329 if (ts) { | 320 if (ts) { |
| 321 waiting_for_most_visited_urls_request_ = true; |
| 330 ts->GetMostVisitedURLs( | 322 ts->GetMostVisitedURLs( |
| 331 base::Bind(&ZeroSuggestProvider::OnMostVisitedUrlsAvailable, | 323 base::Bind(&ZeroSuggestProvider::OnMostVisitedUrlsAvailable, |
| 332 weak_ptr_factory_.GetWeakPtr()), false); | 324 weak_ptr_factory_.GetWeakPtr()), false); |
| 333 } | 325 } |
| 326 } else { |
| 327 const int kFetcherID = 1; |
| 328 fetcher_.reset( |
| 329 net::URLFetcher::Create(kFetcherID, |
| 330 suggest_url, |
| 331 net::URLFetcher::GET, this)); |
| 332 fetcher_->SetRequestContext(profile_->GetRequestContext()); |
| 333 fetcher_->SetLoadFlags(net::LOAD_DO_NOT_SAVE_COOKIES); |
| 334 // Add Chrome experiment state to the request headers. |
| 335 net::HttpRequestHeaders headers; |
| 336 variations::VariationsHttpHeaderProvider::GetInstance()->AppendHeaders( |
| 337 fetcher_->GetOriginalURL(), profile_->IsOffTheRecord(), false, |
| 338 &headers); |
| 339 fetcher_->SetExtraRequestHeaders(headers.ToString()); |
| 340 fetcher_->Start(); |
| 341 LogOmniboxZeroSuggestRequest(ZERO_SUGGEST_REQUEST_SENT); |
| 334 } | 342 } |
| 335 LogOmniboxZeroSuggestRequest(ZERO_SUGGEST_REQUEST_SENT); | |
| 336 } | 343 } |
| 337 | 344 |
| 338 void ZeroSuggestProvider::OnMostVisitedUrlsAvailable( | 345 void ZeroSuggestProvider::OnMostVisitedUrlsAvailable( |
| 339 const history::MostVisitedURLList& urls) { | 346 const history::MostVisitedURLList& urls) { |
| 347 if (!waiting_for_most_visited_urls_request_) return; |
| 340 most_visited_urls_ = urls; | 348 most_visited_urls_ = urls; |
| 349 waiting_for_most_visited_urls_request_ = false; |
| 350 done_ = true; |
| 351 ConvertResultsToAutocompleteMatches(); |
| 352 listener_->OnProviderUpdate(true); |
| 341 } | 353 } |
| 342 | 354 |
| 343 void ZeroSuggestProvider::ConvertResultsToAutocompleteMatches() { | 355 void ZeroSuggestProvider::ConvertResultsToAutocompleteMatches() { |
| 344 matches_.clear(); | 356 matches_.clear(); |
| 345 | 357 |
| 346 const TemplateURL* default_provider = | 358 const TemplateURL* default_provider = |
| 347 template_url_service_->GetDefaultSearchProvider(); | 359 template_url_service_->GetDefaultSearchProvider(); |
| 348 // Fail if we can't set the clickthrough URL for query suggestions. | 360 // Fail if we can't set the clickthrough URL for query suggestions. |
| 349 if (default_provider == NULL || !default_provider->SupportsReplacement( | 361 if (default_provider == NULL || !default_provider->SupportsReplacement( |
| 350 template_url_service_->search_terms_data())) | 362 template_url_service_->search_terms_data())) |
| (...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 417 match.relevance = GetVerbatimRelevance(); | 429 match.relevance = GetVerbatimRelevance(); |
| 418 | 430 |
| 419 return match; | 431 return match; |
| 420 } | 432 } |
| 421 | 433 |
| 422 int ZeroSuggestProvider::GetVerbatimRelevance() const { | 434 int ZeroSuggestProvider::GetVerbatimRelevance() const { |
| 423 return results_.verbatim_relevance >= 0 ? | 435 return results_.verbatim_relevance >= 0 ? |
| 424 results_.verbatim_relevance : kDefaultVerbatimZeroSuggestRelevance; | 436 results_.verbatim_relevance : kDefaultVerbatimZeroSuggestRelevance; |
| 425 } | 437 } |
| 426 | 438 |
| 427 bool ZeroSuggestProvider::CanShowZeroSuggestWithoutSendingURL( | 439 bool ZeroSuggestProvider::ShouldShowNonContextualZeroSuggest( |
| 428 const GURL& suggest_url, | 440 const GURL& suggest_url, |
| 429 const GURL& current_page_url) const { | 441 const GURL& current_page_url) const { |
| 430 if (!ZeroSuggestEnabled(suggest_url, | 442 if (!ZeroSuggestEnabled(suggest_url, |
| 431 template_url_service_->GetDefaultSearchProvider(), | 443 template_url_service_->GetDefaultSearchProvider(), |
| 432 current_page_classification_, | 444 current_page_classification_, |
| 433 template_url_service_->search_terms_data(), | 445 template_url_service_->search_terms_data(), |
| 434 client_.get())) | 446 client_.get())) |
| 435 return false; | 447 return false; |
| 436 | 448 |
| 437 // If we cannot send URLs, then only the MostVisited and Personalized | 449 // If we cannot send URLs, then only the MostVisited and Personalized |
| 438 // variations can be shown. | 450 // variations can be shown. |
| 439 if (!OmniboxFieldTrial::InZeroSuggestMostVisitedFieldTrial() && | 451 if (!OmniboxFieldTrial::InZeroSuggestMostVisitedFieldTrial() && |
| 440 !OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial()) | 452 !OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial()) |
| 441 return false; | 453 return false; |
| 442 | 454 |
| 443 // Only show zero suggest for HTTP[S] pages. | 455 // Only show zero suggest for HTTP[S] pages. |
| 444 // TODO(mariakhomenko): We may be able to expand this set to include pages | 456 // TODO(mariakhomenko): We may be able to expand this set to include pages |
| 445 // with other schemes (e.g. chrome://). That may require improvements to | 457 // with other schemes (e.g. chrome://). That may require improvements to |
| 446 // the formatting of the verbatim result returned by MatchForCurrentURL(). | 458 // the formatting of the verbatim result returned by MatchForCurrentURL(). |
| 447 if (!current_page_url.is_valid() || | 459 if (!current_page_url.is_valid() || |
| 448 ((current_page_url.scheme() != url::kHttpScheme) && | 460 ((current_page_url.scheme() != url::kHttpScheme) && |
| 449 (current_page_url.scheme() != url::kHttpsScheme))) | 461 (current_page_url.scheme() != url::kHttpsScheme))) |
| 450 return false; | 462 return false; |
| 451 | 463 |
| 464 if (OmniboxFieldTrial::InZeroSuggestMostVisitedWithoutSerpFieldTrial() && |
| 465 template_url_service_-> |
| 466 IsSearchResultsPageFromDefaultSearchProvider(current_page_url)) |
| 467 return false; |
| 468 |
| 452 return true; | 469 return true; |
| 453 } | 470 } |
| 454 | 471 |
| 455 void ZeroSuggestProvider::MaybeUseCachedSuggestions() { | 472 void ZeroSuggestProvider::MaybeUseCachedSuggestions() { |
| 456 if (!OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial()) | 473 if (!OmniboxFieldTrial::InZeroSuggestPersonalizedFieldTrial()) |
| 457 return; | 474 return; |
| 458 | 475 |
| 459 std::string json_data = profile_->GetPrefs()->GetString( | 476 std::string json_data = profile_->GetPrefs()->GetString( |
| 460 prefs::kZeroSuggestCachedResults); | 477 prefs::kZeroSuggestCachedResults); |
| 461 if (!json_data.empty()) { | 478 if (!json_data.empty()) { |
| 462 scoped_ptr<base::Value> data( | 479 scoped_ptr<base::Value> data( |
| 463 SearchSuggestionParser::DeserializeJsonData(json_data)); | 480 SearchSuggestionParser::DeserializeJsonData(json_data)); |
| 464 if (data && ParseSuggestResults( | 481 if (data && ParseSuggestResults( |
| 465 *data, kDefaultZeroSuggestRelevance, false, &results_)) { | 482 *data, kDefaultZeroSuggestRelevance, false, &results_)) { |
| 466 ConvertResultsToAutocompleteMatches(); | 483 ConvertResultsToAutocompleteMatches(); |
| 467 results_from_cache_ = !matches_.empty(); | 484 results_from_cache_ = !matches_.empty(); |
| 468 } | 485 } |
| 469 } | 486 } |
| 470 } | 487 } |
| OLD | NEW |