// Copyright (c) 2011 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/browser/autocomplete/search_provider.h"
#include <algorithm>
#include <cmath>
#include "base/callback.h"
#include "base/i18n/icu_string_conversions.h"
#include "base/message_loop.h"
#include "base/string16.h"
#include "base/utf_string_conversions.h"
#include "chrome/browser/autocomplete/autocomplete_classifier.h"
#include "chrome/browser/autocomplete/keyword_provider.h"
#include "chrome/browser/autocomplete/autocomplete_match.h"
#include "chrome/browser/google/google_util.h"
#include "chrome/browser/history/history.h"
#include "chrome/browser/instant/instant_controller.h"
#include "chrome/browser/net/url_fixer_upper.h"
#include "chrome/browser/prefs/pref_service.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/history/in_memory_database.h"
#include "chrome/browser/search_engines/template_url_model.h"
#include "chrome/common/pref_names.h"
#include "chrome/common/url_constants.h"
#include "content/common/json_value_serializer.h"
#include "googleurl/src/url_util.h"
#include "grit/generated_resources.h"
#include "net/base/escape.h"
#include "net/http/http_response_headers.h"
#include "net/url_request/url_request_status.h"
#include "ui/base/l10n/l10n_util.h"
using base::Time;
using base::TimeDelta;
// static
const int SearchProvider::kDefaultProviderURLFetcherID = 1;
// static
const int SearchProvider::kKeywordProviderURLFetcherID = 2;
// static
bool SearchProvider::query_suggest_immediately_ = false;
void SearchProvider::Providers::Set(const TemplateURL* default_provider,
const TemplateURL* keyword_provider) {
// TODO(pkasting): http://b/1162970 We shouldn't need to structure-copy
// this. Nor should we need |default_provider_| and |keyword_provider_|
// just to know whether the provider changed.
default_provider_ = default_provider;
if (default_provider)
cached_default_provider_ = *default_provider;
keyword_provider_ = keyword_provider;
if (keyword_provider)
cached_keyword_provider_ = *keyword_provider;
}
SearchProvider::SearchProvider(ACProviderListener* listener, Profile* profile)
: AutocompleteProvider(listener, profile, "Search"),
suggest_results_pending_(0),
have_suggest_results_(false),
instant_finalized_(false) {
}
void SearchProvider::FinalizeInstantQuery(const string16& input_text,
const string16& suggest_text) {
if (done_ || instant_finalized_)
return;
instant_finalized_ = true;
UpdateDone();
if (input_text.empty()) {
// We only need to update the listener if we're actually done.
if (done_)
listener_->OnProviderUpdate(false);
return;
}
default_provider_suggest_text_ = suggest_text;
string16 adjusted_input_text(input_text);
AutocompleteInput::RemoveForcedQueryStringIfNecessary(input_.type(),
&adjusted_input_text);
const string16 text = adjusted_input_text + suggest_text;
// Remove any matches that are identical to |text|. We don't use the
// destination_url for comparison as it varies depending upon the index passed
// to TemplateURL::ReplaceSearchTerms.
for (ACMatches::iterator i = matches_.begin(); i != matches_.end();) {
// Reset the description/description_class of all searches. We'll set the
// description of the new first match in the call to
// UpdateFirstSearchMatchDescription() below.
if ((i->type == AutocompleteMatch::SEARCH_HISTORY) ||
(i->type == AutocompleteMatch::SEARCH_SUGGEST) ||
(i->type == AutocompleteMatch::SEARCH_WHAT_YOU_TYPED)) {
i->description.clear();
i->description_class.clear();
}
if (((i->type == AutocompleteMatch::SEARCH_HISTORY) ||
(i->type == AutocompleteMatch::SEARCH_SUGGEST)) &&
(i->fill_into_edit == text)) {
i = matches_.erase(i);
} else {
++i;
}
}
// Add the new suggest result. We give it a rank higher than
// SEARCH_WHAT_YOU_TYPED so that it gets autocompleted.
int did_not_accept_default_suggestion = default_suggest_results_.empty() ?
TemplateURLRef::NO_SUGGESTIONS_AVAILABLE :
TemplateURLRef::NO_SUGGESTION_CHOSEN;
MatchMap match_map;
AddMatchToMap(text, adjusted_input_text,
CalculateRelevanceForWhatYouTyped() + 1,
AutocompleteMatch::SEARCH_SUGGEST,
did_not_accept_default_suggestion, false,
input_.initial_prevent_inline_autocomplete(), &match_map);
DCHECK_EQ(1u, match_map.size());
matches_.push_back(match_map.begin()->second);
// Sort the results so that UpdateFirstSearchDescription does the right thing.
std::sort(matches_.begin(), matches_.end(), &AutocompleteMatch::MoreRelevant);
UpdateFirstSearchMatchDescription();
listener_->OnProviderUpdate(true);
}
void SearchProvider::Start(const AutocompleteInput& input,
bool minimal_changes) {
matches_.clear();
instant_finalized_ =
(input.matches_requested() != AutocompleteInput::ALL_MATCHES);
// Can't return search/suggest results for bogus input or without a profile.
if (!profile_ || (input.type() == AutocompleteInput::INVALID)) {
Stop();
return;
}
keyword_input_text_.clear();
const TemplateURL* keyword_provider =
KeywordProvider::GetSubstitutingTemplateURLForInput(profile_, input,
&keyword_input_text_);
if (keyword_input_text_.empty())
keyword_provider = NULL;
const TemplateURL* default_provider =
profile_->GetTemplateURLModel()->GetDefaultSearchProvider();
if (!TemplateURL::SupportsReplacement(default_provider))
default_provider = NULL;
if (keyword_provider == default_provider)
keyword_provider = NULL; // No use in querying the same provider twice.
if (!default_provider && !keyword_provider) {
// No valid providers.
Stop();
return;
}
// If we're still running an old query but have since changed the query text
// or the providers, abort the query.
if (!minimal_changes ||
!providers_.equals(default_provider, keyword_provider)) {
if (done_)
default_provider_suggest_text_.clear();
else
Stop();
} else if (minimal_changes &&
(input_.original_text() != input.original_text())) {
default_provider_suggest_text_.clear();
}
providers_.Set(default_provider, keyword_provider);
if (input.text().empty()) {
// User typed "?" alone. Give them a placeholder result indicating what
// this syntax does.
if (default_provider) {
AutocompleteMatch match;
match.provider = this;
match.contents.assign(l10n_util::GetStringUTF16(IDS_EMPTY_KEYWORD_VALUE));
match.contents_class.push_back(
ACMatchClassification(0, ACMatchClassification::NONE));
matches_.push_back(match);
UpdateFirstSearchMatchDescription();
}
Stop();
return;
}
input_ = input;
DoHistoryQuery(minimal_changes);
StartOrStopSuggestQuery(minimal_changes);
ConvertResultsToAutocompleteMatches();
}
void SearchProvider::Run() {
// Start a new request with the current input.
DCHECK(!done_);
suggest_results_pending_ = 0;
if (providers_.valid_suggest_for_keyword_provider()) {
suggest_results_pending_++;
keyword_fetcher_.reset(
CreateSuggestFetcher(kKeywordProviderURLFetcherID,
providers_.keyword_provider(),
keyword_input_text_));
}
if (providers_.valid_suggest_for_default_provider()) {
suggest_results_pending_++;
default_fetcher_.reset(
CreateSuggestFetcher(kDefaultProviderURLFetcherID,
providers_.default_provider(), input_.text()));
}
// We should only get here if we have a suggest url for the keyword or default
// providers.
DCHECK_GT(suggest_results_pending_, 0);
}
void SearchProvider::Stop() {
StopSuggest();
done_ = true;
default_provider_suggest_text_.clear();
}
void SearchProvider::OnURLFetchComplete(const URLFetcher* source,
const GURL& url,
const net::URLRequestStatus& status,
int response_code,
const ResponseCookies& cookie,
const std::string& data) {
DCHECK(!done_);
suggest_results_pending_--;
DCHECK_GE(suggest_results_pending_, 0); // Should never go negative.
const net::HttpResponseHeaders* const response_headers =
source->response_headers();
std::string json_data(data);
// JSON is supposed to be UTF-8, but some suggest service providers send JSON
// files in non-UTF-8 encodings. The actual encoding is usually specified in
// the Content-Type header field.
if (response_headers) {
std::string charset;
if (response_headers->GetCharset(&charset)) {
string16 data_16;
// TODO(jungshik): Switch to CodePageToUTF8 after it's added.
if (base::CodepageToUTF16(data, charset.c_str(),
base::OnStringConversionError::FAIL,
&data_16))
json_data = UTF16ToUTF8(data_16);
}
}
bool is_keyword_results = (source == keyword_fetcher_.get());
SuggestResults* suggest_results = is_keyword_results ?
&keyword_suggest_results_ : &default_suggest_results_;
if (status.is_success() && response_code == 200) {
JSONStringValueSerializer deserializer(json_data);
deserializer.set_allow_trailing_comma(true);
scoped_ptr<Value> root_val(deserializer.Deserialize(NULL, NULL));
const string16& input_text =
is_keyword_results ? keyword_input_text_ : input_.text();
have_suggest_results_ =
root_val.get() &&
ParseSuggestResults(root_val.get(), is_keyword_results, input_text,
suggest_results);
}
ConvertResultsToAutocompleteMatches();
listener_->OnProviderUpdate(!suggest_results->empty());
}
SearchProvider::~SearchProvider() {
}
void SearchProvider::DoHistoryQuery(bool minimal_changes) {
// The history query results are synchronous, so if minimal_changes is true,
// we still have the last results and don't need to do anything.
if (minimal_changes)
return;
keyword_history_results_.clear();
default_history_results_.clear();
HistoryService* const history_service =
profile_->GetHistoryService(Profile::EXPLICIT_ACCESS);
history::URLDatabase* url_db = history_service ?
history_service->InMemoryDatabase() : NULL;
if (!url_db)
return;
// Request history for both the keyword and default provider.
if (providers_.valid_keyword_provider()) {
url_db->GetMostRecentKeywordSearchTerms(
providers_.keyword_provider().id(),
keyword_input_text_,
static_cast<int>(kMaxMatches),
&keyword_history_results_);
}
if (providers_.valid_default_provider()) {
url_db->GetMostRecentKeywordSearchTerms(
providers_.default_provider().id(),
input_.text(),
static_cast<int>(kMaxMatches),
&default_history_results_);
}
}
void SearchProvider::StartOrStopSuggestQuery(bool minimal_changes) {
// Don't send any queries to the server until some time has elapsed after
// the last keypress, to avoid flooding the server with requests we are
// likely to end up throwing away anyway.
static const int kQueryDelayMs = 200;
if (!IsQuerySuitableForSuggest()) {
StopSuggest();
return;
}
// For the minimal_changes case, if we finished the previous query and still
// have its results, or are allowed to keep running it, just do that, rather
// than starting a new query.
if (minimal_changes &&
(have_suggest_results_ ||
(!done_ &&
input_.matches_requested() == AutocompleteInput::ALL_MATCHES)))
return;
// We can't keep running any previous query, so halt it.
StopSuggest();
// We can't start a new query if we're only allowed synchronous results.
if (input_.matches_requested() != AutocompleteInput::ALL_MATCHES)
return;
// We'll have at least one pending fetch. Set it to 1 now, but the value is
// correctly set in Run. As Run isn't invoked immediately we need to set this
// now, else we won't think we're waiting on results from the server when we
// really are.
suggest_results_pending_ = 1;
// Kick off a timer that will start the URL fetch if it completes before
// the user types another character.
int delay = query_suggest_immediately_ ? 0 : kQueryDelayMs;
timer_.Start(TimeDelta::FromMilliseconds(delay), this, &SearchProvider::Run);
}
bool SearchProvider::IsQuerySuitableForSuggest() const {
// Don't run Suggest in incognito mode, the engine doesn't support it, or
// the user has disabled it.
if (profile_->IsOffTheRecord() ||
(!providers_.valid_suggest_for_keyword_provider() &&
!providers_.valid_suggest_for_default_provider()) ||
!profile_->GetPrefs()->GetBoolean(prefs::kSearchSuggestEnabled))
return false;
// If the input type might be a URL, we take extra care so that private data
// isn't sent to the server.
// FORCED_QUERY means the user is explicitly asking us to search for this, so
// we assume it isn't a URL and/or there isn't private data.
if (input_.type() == AutocompleteInput::FORCED_QUERY)
return true;
// Next we check the scheme. If this is UNKNOWN/REQUESTED_URL/URL with a
// scheme that isn't http/https/ftp, we shouldn't send it. Sending things
// like file: and data: is both a waste of time and a disclosure of
// potentially private, local data. Other "schemes" may actually be
// usernames, and we don't want to send passwords. If the scheme is OK, we
// still need to check other cases below. If this is QUERY, then the presence
// of these schemes means the user explicitly typed one, and thus this is
// probably a URL that's being entered and happens to currently be invalid --
// in which case we again want to run our checks below. Other QUERY cases are
// less likely to be URLs and thus we assume we're OK.
if (!LowerCaseEqualsASCII(input_.scheme(), chrome::kHttpScheme) &&
!LowerCaseEqualsASCII(input_.scheme(), chrome::kHttpsScheme) &&
!LowerCaseEqualsASCII(input_.scheme(), chrome::kFtpScheme))
return (input_.type() == AutocompleteInput::QUERY);
// Don't send URLs with usernames, queries or refs. Some of these are
// private, and the Suggest server is unlikely to have any useful results
// for any of them. Also don't send URLs with ports, as we may initially
// think that a username + password is a host + port (and we don't want to
// send usernames/passwords), and even if the port really is a port, the
// server is once again unlikely to have and useful results.
const url_parse::Parsed& parts = input_.parts();
if (parts.username.is_nonempty() || parts.port.is_nonempty() ||
parts.query.is_nonempty() || parts.ref.is_nonempty())
return false;
// Don't send anything for https except the hostname. Hostnames are OK
// because they are visible when the TCP connection is established, but the
// specific path may reveal private information.
if (LowerCaseEqualsASCII(input_.scheme(), chrome::kHttpsScheme) &&
parts.path.is_nonempty())
return false;
return true;
}
void SearchProvider::StopSuggest() {
suggest_results_pending_ = 0;
timer_.Stop();
// Stop any in-progress URL fetches.
keyword_fetcher_.reset();
default_fetcher_.reset();
keyword_suggest_results_.clear();
default_suggest_results_.clear();
keyword_navigation_results_.clear();
default_navigation_results_.clear();
have_suggest_results_ = false;
}
URLFetcher* SearchProvider::CreateSuggestFetcher(int id,
const TemplateURL& provider,
const string16& text) {
const TemplateURLRef* const suggestions_url = provider.suggestions_url();
DCHECK(suggestions_url->SupportsReplacement());
URLFetcher* fetcher = URLFetcher::Create(id,
GURL(suggestions_url->ReplaceSearchTerms(
provider, text,
TemplateURLRef::NO_SUGGESTIONS_AVAILABLE, string16())),
URLFetcher::GET, this);
fetcher->set_request_context(profile_->GetRequestContext());
fetcher->Start();
return fetcher;
}
bool SearchProvider::ParseSuggestResults(Value* root_val,
bool is_keyword,
const string16& input_text,
SuggestResults* suggest_results) {
if (!root_val->IsType(Value::TYPE_LIST))
return false;
ListValue* root_list = static_cast<ListValue*>(root_val);
Value* query_val;
string16 query_str;
Value* result_val;
if ((root_list->GetSize() < 2) || !root_list->Get(0, &query_val) ||
!query_val->GetAsString(&query_str) ||
(query_str != input_text) ||
!root_list->Get(1, &result_val) || !result_val->IsType(Value::TYPE_LIST))
return false;
ListValue* description_list = NULL;
if (root_list->GetSize() > 2) {
// 3rd element: Description list.
Value* description_val;
if (root_list->Get(2, &description_val) &&
description_val->IsType(Value::TYPE_LIST))
description_list = static_cast<ListValue*>(description_val);
}
// We don't care about the query URL list (the fourth element in the
// response) for now.
// Parse optional data in the results from the Suggest server if any.
ListValue* type_list = NULL;
// 5th argument: Optional key-value pairs.
// TODO: We may iterate the 5th+ arguments of the root_list if any other
// optional data are defined.
if (root_list->GetSize() > 4) {
Value* optional_val;
if (root_list->Get(4, &optional_val) &&
optional_val->IsType(Value::TYPE_DICTIONARY)) {
DictionaryValue* dict_val = static_cast<DictionaryValue*>(optional_val);
// Parse Google Suggest specific type extension.
static const std::string kGoogleSuggestType("google:suggesttype");
if (dict_val->HasKey(kGoogleSuggestType))
dict_val->GetList(kGoogleSuggestType, &type_list);
}
}
ListValue* result_list = static_cast<ListValue*>(result_val);
for (size_t i = 0; i < result_list->GetSize(); ++i) {
Value* suggestion_val;
string16 suggestion_str;
if (!result_list->Get(i, &suggestion_val) ||
!suggestion_val->GetAsString(&suggestion_str))
return false;
// Google search may return empty suggestions for weird input characters,
// they make no sense at all and can cause problem in our code.
// See http://crbug.com/56214
if (!suggestion_str.length())
continue;
Value* type_val;
std::string type_str;
if (type_list && type_list->Get(i, &type_val) &&
type_val->GetAsString(&type_str) && (type_str == "NAVIGATION")) {
Value* site_val;
string16 site_name;
NavigationResults& navigation_results =
is_keyword ? keyword_navigation_results_ :
default_navigation_results_;
if ((navigation_results.size() < kMaxMatches) &&
description_list && description_list->Get(i, &site_val) &&
site_val->IsType(Value::TYPE_STRING) &&
site_val->GetAsString(&site_name)) {
// We can't blindly trust the URL coming from the server to be valid.
GURL result_url(URLFixerUpper::FixupURL(UTF16ToUTF8(suggestion_str),
std::string()));
if (result_url.is_valid()) {
navigation_results.push_back(NavigationResult(result_url, site_name));
}
}
} else {
// TODO(kochi): Currently we treat a calculator result as a query, but it
// is better to have better presentation for caluculator results.
if (suggest_results->size() < kMaxMatches)
suggest_results->push_back(suggestion_str);
}
}
return true;
}
void SearchProvider::ConvertResultsToAutocompleteMatches() {
// Convert all the results to matches and add them to a map, so we can keep
// the most relevant match for each result.
MatchMap map;
const Time no_time;
int did_not_accept_keyword_suggestion = keyword_suggest_results_.empty() ?
TemplateURLRef::NO_SUGGESTIONS_AVAILABLE :
TemplateURLRef::NO_SUGGESTION_CHOSEN;
// Keyword what you typed results are handled by the KeywordProvider.
int did_not_accept_default_suggestion = default_suggest_results_.empty() ?
TemplateURLRef::NO_SUGGESTIONS_AVAILABLE :
TemplateURLRef::NO_SUGGESTION_CHOSEN;
if (providers_.valid_default_provider()) {
AddMatchToMap(input_.text(), input_.text(),
CalculateRelevanceForWhatYouTyped(),
AutocompleteMatch::SEARCH_WHAT_YOU_TYPED,
did_not_accept_default_suggestion, false,
input_.initial_prevent_inline_autocomplete(), &map);
if (!default_provider_suggest_text_.empty()) {
AddMatchToMap(input_.text() + default_provider_suggest_text_,
input_.text(), CalculateRelevanceForWhatYouTyped() + 1,
AutocompleteMatch::SEARCH_SUGGEST,
did_not_accept_default_suggestion, false,
input_.initial_prevent_inline_autocomplete(), &map);
}
}
AddHistoryResultsToMap(keyword_history_results_, true,
did_not_accept_keyword_suggestion, &map);
AddHistoryResultsToMap(default_history_results_, false,
did_not_accept_default_suggestion, &map);
AddSuggestResultsToMap(keyword_suggest_results_, true,
did_not_accept_keyword_suggestion, &map);
AddSuggestResultsToMap(default_suggest_results_, false,
did_not_accept_default_suggestion, &map);
// Now add the most relevant matches from the map to |matches_|.
matches_.clear();
for (MatchMap::const_iterator i(map.begin()); i != map.end(); ++i)
matches_.push_back(i->second);
AddNavigationResultsToMatches(keyword_navigation_results_, true);
AddNavigationResultsToMatches(default_navigation_results_, false);
const size_t max_total_matches = kMaxMatches + 1; // 1 for "what you typed"
std::partial_sort(matches_.begin(),
matches_.begin() + std::min(max_total_matches, matches_.size()),
matches_.end(), &AutocompleteMatch::MoreRelevant);
if (matches_.size() > max_total_matches)
matches_.erase(matches_.begin() + max_total_matches, matches_.end());
UpdateFirstSearchMatchDescription();
UpdateStarredStateOfMatches();
UpdateDone();
}
void SearchProvider::AddNavigationResultsToMatches(
const NavigationResults& navigation_results,
bool is_keyword) {
if (!navigation_results.empty()) {
// TODO(kochi): http://b/1170574 We add only one results for navigational
// suggestions. If we can get more useful information about the score,
// consider adding more results.
const size_t num_results = is_keyword ?
keyword_navigation_results_.size() : default_navigation_results_.size();
matches_.push_back(NavigationToMatch(navigation_results.front(),
CalculateRelevanceForNavigation(num_results, 0, is_keyword),
is_keyword));
}
}
void SearchProvider::AddHistoryResultsToMap(const HistoryResults& results,
bool is_keyword,
int did_not_accept_suggestion,
MatchMap* map) {
int last_relevance = 0;
AutocompleteClassifier* classifier = profile_->GetAutocompleteClassifier();
for (HistoryResults::const_iterator i(results.begin()); i != results.end();
++i) {
// History returns results sorted for us. We force the relevance to decrease
// so that the sort from history is honored. We should never end up with a
// match having a relevance greater than the previous, but they might be
// equal. If we didn't force the relevance to decrease and we ended up in a
// situation where the relevance was equal, then which was shown first would
// be random.
// This uses >= to handle the case where 3 or more results have the same
// relevance.
bool term_looks_like_url = false;
// Don't autocomplete search terms that would normally be treated as URLs
// when typed. For example, if the user searched for google.com and types
// goog, don't autocomplete to the search term google.com. Otherwise, the
// input will look like a URL but act like a search, which is confusing.
// NOTE: We don't check this in the following cases:
// * When inline autocomplete is disabled, we won't be inline
// autocompleting this term, so we don't need to worry about confusion as
// much. This also prevents calling Classify() again from inside the
// classifier (which will corrupt state and likely crash), since the
// classifier always disabled inline autocomplete.
// * When the user has typed the whole term, the "what you typed" history
// match will outrank us for URL-like inputs anyway, so we need not do
// anything special.
if (!input_.prevent_inline_autocomplete() && classifier &&
i->term != input_.text()) {
AutocompleteMatch match;
classifier->Classify(i->term, string16(), false, &match, NULL);
term_looks_like_url = match.transition == PageTransition::TYPED;
}
int relevance = CalculateRelevanceForHistory(i->time, term_looks_like_url,
is_keyword);
if (i != results.begin() && relevance >= last_relevance)
relevance = last_relevance - 1;
last_relevance = relevance;
AddMatchToMap(i->term,
is_keyword ? keyword_input_text_ : input_.text(),
relevance,
AutocompleteMatch::SEARCH_HISTORY, did_not_accept_suggestion,
is_keyword, input_.initial_prevent_inline_autocomplete(),
map);
}
}
void SearchProvider::AddSuggestResultsToMap(
const SuggestResults& suggest_results,
bool is_keyword,
int did_not_accept_suggestion,
MatchMap* map) {
for (size_t i = 0; i < suggest_results.size(); ++i) {
AddMatchToMap(suggest_results[i],
is_keyword ? keyword_input_text_ : input_.text(),
CalculateRelevanceForSuggestion(suggest_results.size(), i,
is_keyword),
AutocompleteMatch::SEARCH_SUGGEST,
static_cast<int>(i), is_keyword,
input_.initial_prevent_inline_autocomplete(), map);
}
}
int SearchProvider::CalculateRelevanceForWhatYouTyped() const {
if (providers_.valid_keyword_provider())
return 250;
switch (input_.type()) {
case AutocompleteInput::UNKNOWN:
case AutocompleteInput::QUERY:
case AutocompleteInput::FORCED_QUERY:
return 1300;
case AutocompleteInput::REQUESTED_URL:
return 1150;
case AutocompleteInput::URL:
return 850;
default:
NOTREACHED();
return 0;
}
}
int SearchProvider::CalculateRelevanceForHistory(const Time& time,
bool looks_like_url,
bool is_keyword) const {
// The relevance of past searches falls off over time. There are two distinct
// equations used. If the first equation is used (searches to the primary
// provider with a type other than URL that don't autocomplete to a url) the
// score starts at 1399 and falls to 1300. If the second equation is used the
// relevance of a search 15 minutes ago is discounted about 50 points, while
// the relevance of a search two weeks ago is discounted about 450 points.
double elapsed_time = std::max((Time::Now() - time).InSecondsF(), 0.);
if (providers_.is_primary_provider(is_keyword) &&
input_.type() != AutocompleteInput::URL &&
!input_.prevent_inline_autocomplete() && !looks_like_url) {
// Searches with the past two days get a different curve.
const double autocomplete_time= 2 * 24 * 60 * 60;
if (elapsed_time < autocomplete_time) {
return 1399 - static_cast<int>(99 *
std::pow(elapsed_time / autocomplete_time, 2.5));
}
elapsed_time -= autocomplete_time;
}
const int score_discount =
static_cast<int>(6.5 * std::pow(elapsed_time, 0.3));
// Don't let scores go below 0. Negative relevance scores are meaningful in
// a different way.
int base_score;
if (!providers_.is_primary_provider(is_keyword))
base_score = 200;
else
base_score = (input_.type() == AutocompleteInput::URL) ? 750 : 1050;
return std::max(0, base_score - score_discount);
}
int SearchProvider::CalculateRelevanceForSuggestion(size_t num_results,
size_t result_number,
bool is_keyword) const {
DCHECK(result_number < num_results);
int base_score;
if (!providers_.is_primary_provider(is_keyword))
base_score = 100;
else
base_score = (input_.type() == AutocompleteInput::URL) ? 300 : 600;
return base_score +
static_cast<int>(num_results - 1 - result_number);
}
int SearchProvider::CalculateRelevanceForNavigation(size_t num_results,
size_t result_number,
bool is_keyword) const {
DCHECK(result_number < num_results);
// TODO(kochi): http://b/784900 Use relevance score from the NavSuggest
// server if possible.
return (providers_.is_primary_provider(is_keyword) ? 800 : 150) +
static_cast<int>(num_results - 1 - result_number);
}
void SearchProvider::AddMatchToMap(const string16& query_string,
const string16& input_text,
int relevance,
AutocompleteMatch::Type type,
int accepted_suggestion,
bool is_keyword,
bool prevent_inline_autocomplete,
MatchMap* map) {
AutocompleteMatch match(this, relevance, false, type);
std::vector<size_t> content_param_offsets;
const TemplateURL& provider = is_keyword ? providers_.keyword_provider() :
providers_.default_provider();
match.contents.assign(query_string);
// We do intra-string highlighting for suggestions - the suggested segment
// will be highlighted, e.g. for input_text = "you" the suggestion may be
// "youtube", so we'll bold the "tube" section: you*tube*.
if (input_text != query_string) {
size_t input_position = match.contents.find(input_text);
if (input_position == string16::npos) {
// The input text is not a substring of the query string, e.g. input
// text is "slasdot" and the query string is "slashdot", so we bold the
// whole thing.
match.contents_class.push_back(
ACMatchClassification(0, ACMatchClassification::MATCH));
} else {
// TODO(beng): ACMatchClassification::MATCH now seems to just mean
// "bold" this. Consider modifying the terminology.
// We don't iterate over the string here annotating all matches because
// it looks odd to have every occurrence of a substring that may be as
// short as a single character highlighted in a query suggestion result,
// e.g. for input text "s" and query string "southwest airlines", it
// looks odd if both the first and last s are highlighted.
if (input_position != 0) {
match.contents_class.push_back(
ACMatchClassification(0, ACMatchClassification::NONE));
}
match.contents_class.push_back(
ACMatchClassification(input_position, ACMatchClassification::DIM));
size_t next_fragment_position = input_position + input_text.length();
if (next_fragment_position < query_string.length()) {
match.contents_class.push_back(
ACMatchClassification(next_fragment_position,
ACMatchClassification::NONE));
}
}
} else {
// Otherwise, we're dealing with the "default search" result which has no
// completion.
match.contents_class.push_back(
ACMatchClassification(0, ACMatchClassification::NONE));
}
// When the user forced a query, we need to make sure all the fill_into_edit
// values preserve that property. Otherwise, if the user starts editing a
// suggestion, non-Search results will suddenly appear.
size_t search_start = 0;
if (input_.type() == AutocompleteInput::FORCED_QUERY) {
match.fill_into_edit.assign(ASCIIToUTF16("?"));
++search_start;
}
if (is_keyword) {
match.fill_into_edit.append(
providers_.keyword_provider().keyword() + char16(' '));
match.template_url = &providers_.keyword_provider();
}
match.fill_into_edit.append(query_string);
// Not all suggestions start with the original input.
if (!prevent_inline_autocomplete &&
!match.fill_into_edit.compare(search_start, input_text.length(),
input_text))
match.inline_autocomplete_offset = search_start + input_text.length();
const TemplateURLRef* const search_url = provider.url();
DCHECK(search_url->SupportsReplacement());
match.destination_url =
GURL(search_url->ReplaceSearchTerms(provider,
query_string,
accepted_suggestion,
input_text));
// Search results don't look like URLs.
match.transition =
is_keyword ? PageTransition::KEYWORD : PageTransition::GENERATED;
// Try to add |match| to |map|. If a match for |query_string| is already in
// |map|, replace it if |match| is more relevant.
// NOTE: Keep this ToLower() call in sync with url_database.cc.
const std::pair<MatchMap::iterator, bool> i = map->insert(
std::pair<string16, AutocompleteMatch>(
l10n_util::ToLower(query_string), match));
// NOTE: We purposefully do a direct relevance comparison here instead of
// using AutocompleteMatch::MoreRelevant(), so that we'll prefer "items added
// first" rather than "items alphabetically first" when the scores are equal.
// The only case this matters is when a user has results with the same score
// that differ only by capitalization; because the history system returns
// results sorted by recency, this means we'll pick the most recent such
// result even if the precision of our relevance score is too low to
// distinguish the two.
if (!i.second && (match.relevance > i.first->second.relevance))
i.first->second = match;
}
AutocompleteMatch SearchProvider::NavigationToMatch(
const NavigationResult& navigation,
int relevance,
bool is_keyword) {
const string16& input_text =
is_keyword ? keyword_input_text_ : input_.text();
AutocompleteMatch match(this, relevance, false,
AutocompleteMatch::NAVSUGGEST);
match.destination_url = navigation.url;
match.contents =
StringForURLDisplay(navigation.url, true, !HasHTTPScheme(input_text));
AutocompleteMatch::ClassifyMatchInString(input_text, match.contents,
ACMatchClassification::URL,
&match.contents_class);
match.description = navigation.site_name;
AutocompleteMatch::ClassifyMatchInString(input_text, navigation.site_name,
ACMatchClassification::NONE,
&match.description_class);
// When the user forced a query, we need to make sure all the fill_into_edit
// values preserve that property. Otherwise, if the user starts editing a
// suggestion, non-Search results will suddenly appear.
if (input_.type() == AutocompleteInput::FORCED_QUERY)
match.fill_into_edit.assign(ASCIIToUTF16("?"));
match.fill_into_edit.append(
AutocompleteInput::FormattedStringWithEquivalentMeaning(navigation.url,
match.contents));
// TODO(pkasting): http://b/1112879 These should perhaps be
// inline-autocompletable?
return match;
}
void SearchProvider::UpdateDone() {
// We're done when there are no more suggest queries pending (this is set to 1
// when the timer is started) and we're not waiting on instant.
done_ = ((suggest_results_pending_ == 0) &&
(instant_finalized_ || !InstantController::IsEnabled(profile_)));
}
void SearchProvider::UpdateFirstSearchMatchDescription() {
if (!providers_.valid_default_provider() || matches_.empty())
return;
for (ACMatches::iterator i = matches_.begin(); i != matches_.end(); ++i) {
AutocompleteMatch& match = *i;
switch (match.type) {
case AutocompleteMatch::SEARCH_WHAT_YOU_TYPED:
case AutocompleteMatch::SEARCH_HISTORY:
case AutocompleteMatch::SEARCH_SUGGEST:
match.description.assign(l10n_util::GetStringFUTF16(
IDS_AUTOCOMPLETE_SEARCH_DESCRIPTION,
providers_.default_provider().
AdjustedShortNameForLocaleDirection()));
match.description_class.push_back(
ACMatchClassification(0, ACMatchClassification::DIM));
// Only the first search match gets a description.
return;
default:
break;
}
}
}