1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
// Copyright (c) 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/browser/ui/webui/omnibox/omnibox_ui_handler.h"
#include <string>
#include "base/auto_reset.h"
#include "base/bind.h"
#include "base/strings/string16.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chrome/browser/autocomplete/autocomplete_classifier.h"
#include "chrome/browser/autocomplete/autocomplete_controller.h"
#include "chrome/browser/autocomplete/autocomplete_input.h"
#include "chrome/browser/autocomplete/autocomplete_match.h"
#include "chrome/browser/autocomplete/autocomplete_provider.h"
#include "chrome/browser/history/history_service.h"
#include "chrome/browser/history/history_service_factory.h"
#include "chrome/browser/history/url_database.h"
#include "chrome/browser/search/search.h"
#include "chrome/browser/search_engines/template_url.h"
#include "content/public/browser/web_ui.h"
OmniboxUIHandler::OmniboxUIHandler(Profile* profile): profile_(profile) {
ResetController();
}
OmniboxUIHandler::~OmniboxUIHandler() {}
void OmniboxUIHandler::RegisterMessages() {
web_ui()->RegisterMessageCallback("startOmniboxQuery",
base::Bind(&OmniboxUIHandler::StartOmniboxQuery,
base::Unretained(this)));
}
// This function gets called when the AutocompleteController possibly
// has new results. We package those results in a DictionaryValue
// object result_to_output and call the javascript function
// handleNewAutocompleteResult. Here's an example populated
// result_to_output object:
// {
// 'done': false,
// 'time_since_omnibox_started_ms': 15,
// 'host': 'mai',
// 'is_typed_host': false,
// 'combined_results' : {
// 'num_items': 4,
// 'item_0': {
// 'destination_url': 'http://mail.google.com',
// 'provider_name': 'HistoryURL',
// 'relevance': 1410,
// ...
// }
// 'item_1: {
// ...
// }
// ...
// }
// 'results_by_provider': {
// 'HistoryURL' : {
// 'num_items': 3,
// ...
// }
// 'Search' : {
// 'num_items': 1,
// ...
// }
// ...
// }
// }
// For reference, the javascript code that unpacks this object and
// displays it is in chrome/browser/resources/omnibox.js
void OmniboxUIHandler::OnResultChanged(bool default_match_changed) {
base::DictionaryValue result_to_output;
// Fill in general information.
result_to_output.SetBoolean("done", controller_->done());
result_to_output.SetInteger("time_since_omnibox_started_ms",
(base::Time::Now() - time_omnibox_started_).InMilliseconds());
const base::string16& host = controller_->input().text().substr(
controller_->input().parts().host.begin,
controller_->input().parts().host.len);
result_to_output.SetString("host", host);
bool is_typed_host;
if (LookupIsTypedHost(host, &is_typed_host)) {
// If we successfully looked up whether the host part of the omnibox
// input (this interprets the input as a host plus optional path) as
// a typed host, then record this information in the output.
result_to_output.SetBoolean("is_typed_host", is_typed_host);
}
// Fill in the merged/combined results the controller has provided.
AddResultToDictionary("combined_results", controller_->result().begin(),
controller_->result().end(), &result_to_output);
// Fill results from each individual provider as well.
for (ACProviders::const_iterator it(controller_->providers()->begin());
it != controller_->providers()->end(); ++it) {
AddResultToDictionary(
std::string("results_by_provider.") + (*it)->GetName(),
(*it)->matches().begin(), (*it)->matches().end(), &result_to_output);
}
// Add done; send the results.
web_ui()->CallJavascriptFunction("omniboxDebug.handleNewAutocompleteResult",
result_to_output);
}
// For details on the format of the DictionaryValue that this function
// populates, see the comments by OnResultChanged().
void OmniboxUIHandler::AddResultToDictionary(const std::string& prefix,
ACMatches::const_iterator it,
ACMatches::const_iterator end,
base::DictionaryValue* output) {
int i = 0;
for (; it != end; ++it, ++i) {
std::string item_prefix(prefix + base::StringPrintf(".item_%d", i));
if (it->provider != NULL) {
output->SetString(item_prefix + ".provider_name",
it->provider->GetName());
output->SetBoolean(item_prefix + ".provider_done", it->provider->done());
}
output->SetInteger(item_prefix + ".relevance", it->relevance);
output->SetBoolean(item_prefix + ".deletable", it->deletable);
output->SetString(item_prefix + ".fill_into_edit", it->fill_into_edit);
output->SetString(item_prefix + ".inline_autocompletion",
it->inline_autocompletion);
output->SetString(item_prefix + ".destination_url",
it->destination_url.spec());
output->SetString(item_prefix + ".contents", it->contents);
// At this time, we're not bothering to send along the long vector that
// represent contents classification. i.e., for each character, what
// type of text it is.
output->SetString(item_prefix + ".description", it->description);
// At this time, we're not bothering to send along the long vector that
// represents description classification. i.e., for each character, what
// type of text it is.
output->SetInteger(item_prefix + ".transition", it->transition);
output->SetBoolean(item_prefix + ".is_history_what_you_typed_match",
it->is_history_what_you_typed_match);
output->SetBoolean(item_prefix + ".allowed_to_be_default_match",
it->allowed_to_be_default_match);
output->SetString(item_prefix + ".type",
AutocompleteMatchType::ToString(it->type));
if (it->associated_keyword.get() != NULL) {
output->SetString(item_prefix + ".associated_keyword",
it->associated_keyword->keyword);
}
output->SetString(item_prefix + ".keyword", it->keyword);
output->SetBoolean(item_prefix + ".starred", it->starred);
output->SetBoolean(item_prefix + ".from_previous", it->from_previous);
for (AutocompleteMatch::AdditionalInfo::const_iterator j =
it->additional_info.begin(); j != it->additional_info.end(); ++j) {
output->SetString(item_prefix + ".additional_info." + j->first,
j->second);
}
}
output->SetInteger(prefix + ".num_items", i);
}
bool OmniboxUIHandler::LookupIsTypedHost(const base::string16& host,
bool* is_typed_host) const {
HistoryService* const history_service =
HistoryServiceFactory::GetForProfile(profile_,
Profile::EXPLICIT_ACCESS);
if (!history_service)
return false;
history::URLDatabase* url_db = history_service->InMemoryDatabase();
if (!url_db)
return false;
*is_typed_host = url_db->IsTypedHost(UTF16ToUTF8(host));
return true;
}
void OmniboxUIHandler::StartOmniboxQuery(const base::ListValue* input) {
DCHECK_EQ(4u, input->GetSize());
base::string16 input_string;
bool return_val = input->GetString(0, &input_string);
DCHECK(return_val);
int cursor_position;
return_val = input->GetInteger(1, &cursor_position);
DCHECK(return_val);
bool prevent_inline_autocomplete;
return_val = input->GetBoolean(2, &prevent_inline_autocomplete);
DCHECK(return_val);
bool prefer_keyword;
return_val = input->GetBoolean(3, &prefer_keyword);
DCHECK(return_val);
// Reset the controller. If we don't do this, then the
// AutocompleteController might inappropriately set its |minimal_changes|
// variable (or something else) and some providers will short-circuit
// important logic and return stale results. In short, we want the
// actual results to not depend on the state of the previous request.
ResetController();
time_omnibox_started_ = base::Time::Now();
controller_->Start(AutocompleteInput(
input_string,
cursor_position,
base::string16(), // user's desired tld (top-level domain)
GURL(),
AutocompleteInput::INVALID_SPEC,
prevent_inline_autocomplete,
prefer_keyword,
true, // allow exact keyword matches
AutocompleteInput::ALL_MATCHES)); // want all matches
}
void OmniboxUIHandler::ResetController() {
controller_.reset(new AutocompleteController(profile_, this,
AutocompleteClassifier::kDefaultOmniboxProviders));
}
|
