// 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/browser/ui/omnibox/omnibox_edit_model.h"
#include <algorithm>
#include <string>
#include "base/auto_reset.h"
#include "base/format_macros.h"
#include "base/metrics/histogram.h"
#include "base/prefs/pref_service.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/strings/utf_string_conversions.h"
#include "chrome/app/chrome_command_ids.h"
#include "chrome/browser/autocomplete/autocomplete_classifier.h"
#include "chrome/browser/autocomplete/autocomplete_classifier_factory.h"
#include "chrome/browser/autocomplete/chrome_autocomplete_scheme_classifier.h"
#include "chrome/browser/autocomplete/history_url_provider.h"
#include "chrome/browser/bookmarks/bookmark_model_factory.h"
#include "chrome/browser/bookmarks/bookmark_stats.h"
#include "chrome/browser/chrome_notification_types.h"
#include "chrome/browser/command_updater.h"
#include "chrome/browser/extensions/api/omnibox/omnibox_api.h"
#include "chrome/browser/favicon/favicon_tab_helper.h"
#include "chrome/browser/google/google_url_tracker_factory.h"
#include "chrome/browser/net/predictor.h"
#include "chrome/browser/omnibox/omnibox_log.h"
#include "chrome/browser/predictors/autocomplete_action_predictor.h"
#include "chrome/browser/predictors/autocomplete_action_predictor_factory.h"
#include "chrome/browser/prerender/prerender_field_trial.h"
#include "chrome/browser/prerender/prerender_manager.h"
#include "chrome/browser/prerender/prerender_manager_factory.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/search/search.h"
#include "chrome/browser/search_engines/template_url_service_factory.h"
#include "chrome/browser/search_engines/ui_thread_search_terms_data.h"
#include "chrome/browser/sessions/session_tab_helper.h"
#include "chrome/browser/ui/browser_list.h"
#include "chrome/browser/ui/omnibox/omnibox_current_page_delegate_impl.h"
#include "chrome/browser/ui/omnibox/omnibox_edit_controller.h"
#include "chrome/browser/ui/omnibox/omnibox_navigation_observer.h"
#include "chrome/browser/ui/omnibox/omnibox_popup_model.h"
#include "chrome/browser/ui/omnibox/omnibox_popup_view.h"
#include "chrome/browser/ui/omnibox/omnibox_view.h"
#include "chrome/browser/ui/search/instant_search_prerenderer.h"
#include "chrome/browser/ui/search/search_tab_helper.h"
#include "chrome/browser/ui/toolbar/toolbar_model.h"
#include "chrome/common/chrome_switches.h"
#include "chrome/common/pref_names.h"
#include "chrome/common/url_constants.h"
#include "components/bookmarks/browser/bookmark_model.h"
#include "components/google/core/browser/google_url_tracker.h"
#include "components/metrics/proto/omnibox_event.pb.h"
#include "components/omnibox/autocomplete_provider.h"
#include "components/omnibox/keyword_provider.h"
#include "components/omnibox/search_provider.h"
#include "components/search_engines/template_url.h"
#include "components/search_engines/template_url_prepopulate_data.h"
#include "components/search_engines/template_url_service.h"
#include "components/url_fixer/url_fixer.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/navigation_entry.h"
#include "content/public/browser/notification_service.h"
#include "content/public/browser/render_view_host.h"
#include "content/public/browser/user_metrics.h"
#include "extensions/common/constants.h"
#include "ui/gfx/image/image.h"
#include "url/url_util.h"
using metrics::OmniboxEventProto;
using predictors::AutocompleteActionPredictor;
// Helpers --------------------------------------------------------------------
namespace {
// Histogram name which counts the number of times that the user text is
// cleared. IME users are sometimes in the situation that IME was
// unintentionally turned on and failed to input latin alphabets (ASCII
// characters) or the opposite case. In that case, users may delete all
// the text and the user text gets cleared. We'd like to measure how often
// this scenario happens.
//
// Note that since we don't currently correlate "text cleared" events with
// IME usage, this also captures many other cases where users clear the text;
// though it explicitly doesn't log deleting all the permanent text as
// the first action of an editing sequence (see comments in
// OnAfterPossibleChange()).
const char kOmniboxUserTextClearedHistogram[] = "Omnibox.UserTextCleared";
enum UserTextClearedType {
OMNIBOX_USER_TEXT_CLEARED_BY_EDITING = 0,
OMNIBOX_USER_TEXT_CLEARED_WITH_ESCAPE = 1,
OMNIBOX_USER_TEXT_CLEARED_NUM_OF_ITEMS,
};
// Histogram name which counts the number of times the user enters
// keyword hint mode and via what method. The possible values are listed
// in the EnteredKeywordModeMethod enum which is defined in the .h file.
const char kEnteredKeywordModeHistogram[] = "Omnibox.EnteredKeywordMode";
// Histogram name which counts the number of milliseconds a user takes
// between focusing and editing the omnibox.
const char kFocusToEditTimeHistogram[] = "Omnibox.FocusToEditTime";
// Histogram name which counts the number of milliseconds a user takes
// between focusing and opening an omnibox match.
const char kFocusToOpenTimeHistogram[] = "Omnibox.FocusToOpenTimeAnyPopupState";
// Split the percentage match histograms into buckets based on the width of the
// omnibox.
const int kPercentageMatchHistogramWidthBuckets[] = { 400, 700, 1200 };
void RecordPercentageMatchHistogram(const base::string16& old_text,
const base::string16& new_text,
bool url_replacement_active,
ui::PageTransition transition,
int omnibox_width) {
size_t avg_length = (old_text.length() + new_text.length()) / 2;
int percent = 0;
if (!old_text.empty() && !new_text.empty()) {
size_t shorter_length = std::min(old_text.length(), new_text.length());
base::string16::const_iterator end(old_text.begin() + shorter_length);
base::string16::const_iterator mismatch(
std::mismatch(old_text.begin(), end, new_text.begin()).first);
size_t matching_characters = mismatch - old_text.begin();
percent = static_cast<float>(matching_characters) / avg_length * 100;
}
std::string histogram_name;
if (url_replacement_active) {
if (transition == ui::PAGE_TRANSITION_TYPED) {
histogram_name = "InstantExtended.PercentageMatchV2_QuerytoURL";
UMA_HISTOGRAM_PERCENTAGE(histogram_name, percent);
} else {
histogram_name = "InstantExtended.PercentageMatchV2_QuerytoQuery";
UMA_HISTOGRAM_PERCENTAGE(histogram_name, percent);
}
} else {
if (transition == ui::PAGE_TRANSITION_TYPED) {
histogram_name = "InstantExtended.PercentageMatchV2_URLtoURL";
UMA_HISTOGRAM_PERCENTAGE(histogram_name, percent);
} else {
histogram_name = "InstantExtended.PercentageMatchV2_URLtoQuery";
UMA_HISTOGRAM_PERCENTAGE(histogram_name, percent);
}
}
std::string suffix = "large";
for (size_t i = 0; i < arraysize(kPercentageMatchHistogramWidthBuckets);
++i) {
if (omnibox_width < kPercentageMatchHistogramWidthBuckets[i]) {
suffix = base::IntToString(kPercentageMatchHistogramWidthBuckets[i]);
break;
}
}
// Cannot rely on UMA histograms macro because the name of the histogram is
// generated dynamically.
base::HistogramBase* counter = base::LinearHistogram::FactoryGet(
histogram_name + "_" + suffix, 1, 101, 102,
base::Histogram::kUmaTargetedHistogramFlag);
counter->Add(percent);
}
} // namespace
// OmniboxEditModel::State ----------------------------------------------------
OmniboxEditModel::State::State(bool user_input_in_progress,
const base::string16& user_text,
const base::string16& gray_text,
const base::string16& keyword,
bool is_keyword_hint,
bool url_replacement_enabled,
OmniboxFocusState focus_state,
FocusSource focus_source,
const AutocompleteInput& autocomplete_input)
: user_input_in_progress(user_input_in_progress),
user_text(user_text),
gray_text(gray_text),
keyword(keyword),
is_keyword_hint(is_keyword_hint),
url_replacement_enabled(url_replacement_enabled),
focus_state(focus_state),
focus_source(focus_source),
autocomplete_input(autocomplete_input) {
}
OmniboxEditModel::State::~State() {
}
// OmniboxEditModel -----------------------------------------------------------
OmniboxEditModel::OmniboxEditModel(OmniboxView* view,
OmniboxEditController* controller,
Profile* profile)
: view_(view),
controller_(controller),
focus_state_(OMNIBOX_FOCUS_NONE),
focus_source_(INVALID),
user_input_in_progress_(false),
user_input_since_focus_(true),
just_deleted_text_(false),
has_temporary_text_(false),
paste_state_(NONE),
control_key_state_(UP),
is_keyword_hint_(false),
profile_(profile),
in_revert_(false),
allow_exact_keyword_match_(false) {
omnibox_controller_.reset(new OmniboxController(this, profile));
delegate_.reset(new OmniboxCurrentPageDelegateImpl(controller, profile));
}
OmniboxEditModel::~OmniboxEditModel() {
}
const OmniboxEditModel::State OmniboxEditModel::GetStateForTabSwitch() {
// Like typing, switching tabs "accepts" the temporary text as the user
// text, because it makes little sense to have temporary text when the
// popup is closed.
if (user_input_in_progress_) {
// Weird edge case to match other browsers: if the edit is empty, revert to
// the permanent text (so the user can get it back easily) but select it (so
// on switching back, typing will "just work").
const base::string16 user_text(UserTextFromDisplayText(view_->GetText()));
if (user_text.empty()) {
base::AutoReset<bool> tmp(&in_revert_, true);
view_->RevertAll();
view_->SelectAll(true);
} else {
InternalSetUserText(user_text);
}
}
UMA_HISTOGRAM_BOOLEAN("Omnibox.SaveStateForTabSwitch.UserInputInProgress",
user_input_in_progress_);
return State(
user_input_in_progress_, user_text_, view_->GetGrayTextAutocompletion(),
keyword_, is_keyword_hint_,
controller_->GetToolbarModel()->url_replacement_enabled(),
focus_state_, focus_source_, input_);
}
void OmniboxEditModel::RestoreState(const State* state) {
// We need to update the permanent text correctly and revert the view
// regardless of whether there is saved state.
bool url_replacement_enabled = !state || state->url_replacement_enabled;
controller_->GetToolbarModel()->set_url_replacement_enabled(
url_replacement_enabled);
controller_->GetToolbarModel()->set_origin_chip_enabled(
url_replacement_enabled);
permanent_text_ = controller_->GetToolbarModel()->GetText();
// Don't muck with the search term replacement state, as we've just set it
// correctly.
view_->RevertWithoutResettingSearchTermReplacement();
// Restore the autocomplete controller's input, or clear it if this is a new
// tab.
input_ = state ? state->autocomplete_input : AutocompleteInput();
if (!state)
return;
SetFocusState(state->focus_state, OMNIBOX_FOCUS_CHANGE_TAB_SWITCH);
focus_source_ = state->focus_source;
// Restore any user editing.
if (state->user_input_in_progress) {
// NOTE: Be sure and set keyword-related state BEFORE invoking
// DisplayTextFromUserText(), as its result depends upon this state.
keyword_ = state->keyword;
is_keyword_hint_ = state->is_keyword_hint;
view_->SetUserText(state->user_text,
DisplayTextFromUserText(state->user_text), false);
view_->SetGrayTextAutocompletion(state->gray_text);
}
}
AutocompleteMatch OmniboxEditModel::CurrentMatch(
GURL* alternate_nav_url) const {
// If we have a valid match use it. Otherwise get one for the current text.
AutocompleteMatch match = omnibox_controller_->current_match();
if (!match.destination_url.is_valid()) {
GetInfoForCurrentText(&match, alternate_nav_url);
} else if (alternate_nav_url) {
*alternate_nav_url = AutocompleteResult::ComputeAlternateNavUrl(
input_, match);
}
return match;
}
bool OmniboxEditModel::UpdatePermanentText() {
SearchProvider* search_provider =
autocomplete_controller()->search_provider();
if (search_provider && delegate_->CurrentPageExists())
search_provider->set_current_page_url(delegate_->GetURL());
// When there's new permanent text, and the user isn't interacting with the
// omnibox, we want to revert the edit to show the new text. We could simply
// define "interacting" as "the omnibox has focus", but we still allow updates
// when the omnibox has focus as long as the user hasn't begun editing, isn't
// seeing zerosuggestions (because changing this text would require changing
// or hiding those suggestions), and hasn't toggled on "Show URL" (because
// this update will re-enable search term replacement, which will be annoying
// if the user is trying to copy the URL). When the omnibox doesn't have
// focus, we assume the user may have abandoned their interaction and it's
// always safe to change the text; this also prevents someone toggling "Show
// URL" (which sounds as if it might be persistent) from seeing just that URL
// forever afterwards.
//
// If the page is auto-committing gray text, however, we generally don't want
// to make any change to the edit. While auto-commits modify the underlying
// permanent URL, they're intended to have no effect on the user's editing
// process -- before and after the auto-commit, the omnibox should show the
// same user text and the same instant suggestion, even if the auto-commit
// happens while the edit doesn't have focus.
base::string16 new_permanent_text = controller_->GetToolbarModel()->GetText();
base::string16 gray_text = view_->GetGrayTextAutocompletion();
const bool visibly_changed_permanent_text =
(permanent_text_ != new_permanent_text) &&
(!has_focus() ||
(!user_input_in_progress_ &&
!(popup_model() && popup_model()->IsOpen()) &&
controller_->GetToolbarModel()->url_replacement_enabled())) &&
(gray_text.empty() ||
new_permanent_text != user_text_ + gray_text);
permanent_text_ = new_permanent_text;
return visibly_changed_permanent_text;
}
GURL OmniboxEditModel::PermanentURL() {
return url_fixer::FixupURL(base::UTF16ToUTF8(permanent_text_), std::string());
}
void OmniboxEditModel::SetUserText(const base::string16& text) {
SetInputInProgress(true);
InternalSetUserText(text);
omnibox_controller_->InvalidateCurrentMatch();
paste_state_ = NONE;
has_temporary_text_ = false;
}
bool OmniboxEditModel::CommitSuggestedText() {
const base::string16 suggestion = view_->GetGrayTextAutocompletion();
if (suggestion.empty())
return false;
const base::string16 final_text = view_->GetText() + suggestion;
view_->OnBeforePossibleChange();
view_->SetWindowTextAndCaretPos(final_text, final_text.length(), false,
false);
view_->OnAfterPossibleChange();
return true;
}
void OmniboxEditModel::OnChanged() {
// Don't call CurrentMatch() when there's no editing, as in this case we'll
// never actually use it. This avoids running the autocomplete providers (and
// any systems they then spin up) during startup.
const AutocompleteMatch& current_match = user_input_in_progress_ ?
CurrentMatch(NULL) : AutocompleteMatch();
AutocompleteActionPredictor::Action recommended_action =
AutocompleteActionPredictor::ACTION_NONE;
if (user_input_in_progress_) {
InstantSearchPrerenderer* prerenderer =
InstantSearchPrerenderer::GetForProfile(profile_);
if (prerenderer &&
prerenderer->IsAllowed(current_match, controller_->GetWebContents()) &&
popup_model()->IsOpen() && has_focus()) {
recommended_action = AutocompleteActionPredictor::ACTION_PRERENDER;
} else {
AutocompleteActionPredictor* action_predictor =
predictors::AutocompleteActionPredictorFactory::GetForProfile(
profile_);
action_predictor->RegisterTransitionalMatches(user_text_, result());
// Confer with the AutocompleteActionPredictor to determine what action,
// if any, we should take. Get the recommended action here even if we
// don't need it so we can get stats for anyone who is opted in to UMA,
// but only get it if the user has actually typed something to avoid
// constructing it before it's needed. Note: This event is triggered as
// part of startup when the initial tab transitions to the start page.
recommended_action =
action_predictor->RecommendAction(user_text_, current_match);
}
}
UMA_HISTOGRAM_ENUMERATION("AutocompleteActionPredictor.Action",
recommended_action,
AutocompleteActionPredictor::LAST_PREDICT_ACTION);
// Hide any suggestions we might be showing.
view_->SetGrayTextAutocompletion(base::string16());
switch (recommended_action) {
case AutocompleteActionPredictor::ACTION_PRERENDER:
// It's possible that there is no current page, for instance if the tab
// has been closed or on return from a sleep state.
// (http://crbug.com/105689)
if (!delegate_->CurrentPageExists())
break;
// Ask for prerendering if the destination URL is different than the
// current URL.
if (current_match.destination_url != delegate_->GetURL())
delegate_->DoPrerender(current_match);
break;
case AutocompleteActionPredictor::ACTION_PRECONNECT:
omnibox_controller_->DoPreconnect(current_match);
break;
case AutocompleteActionPredictor::ACTION_NONE:
break;
}
controller_->OnChanged();
}
void OmniboxEditModel::GetDataForURLExport(GURL* url,
base::string16* title,
gfx::Image* favicon) {
*url = CurrentMatch(NULL).destination_url;
if (*url == delegate_->GetURL()) {
content::WebContents* web_contents = controller_->GetWebContents();
*title = web_contents->GetTitle();
*favicon = FaviconTabHelper::FromWebContents(web_contents)->GetFavicon();
}
}
bool OmniboxEditModel::CurrentTextIsURL() const {
if (controller_->GetToolbarModel()->WouldReplaceURL())
return false;
// If current text is not composed of replaced search terms and
// !user_input_in_progress_, then permanent text is showing and should be a
// URL, so no further checking is needed. By avoiding checking in this case,
// we avoid calling into the autocomplete providers, and thus initializing the
// history system, as long as possible, which speeds startup.
if (!user_input_in_progress_)
return true;
return !AutocompleteMatch::IsSearchType(CurrentMatch(NULL).type);
}
AutocompleteMatch::Type OmniboxEditModel::CurrentTextType() const {
return CurrentMatch(NULL).type;
}
void OmniboxEditModel::AdjustTextForCopy(int sel_min,
bool is_all_selected,
base::string16* text,
GURL* url,
bool* write_url) {
*write_url = false;
// Do not adjust if selection did not start at the beginning of the field, or
// if the URL was omitted.
if ((sel_min != 0) || controller_->GetToolbarModel()->WouldReplaceURL())
return;
if (!user_input_in_progress_ && is_all_selected) {
// The user selected all the text and has not edited it. Use the url as the
// text so that if the scheme was stripped it's added back, and the url
// is unescaped (we escape parts of the url for display).
*url = PermanentURL();
*text = base::UTF8ToUTF16(url->spec());
*write_url = true;
return;
}
// We can't use CurrentTextIsURL() or GetDataForURLExport() because right now
// the user is probably holding down control to cause the copy, which will
// screw up our calculation of the desired_tld.
AutocompleteMatch match;
AutocompleteClassifierFactory::GetForProfile(profile_)->Classify(
*text, is_keyword_selected(), true, ClassifyPage(), &match, NULL);
if (AutocompleteMatch::IsSearchType(match.type))
return;
*url = match.destination_url;
// Prefix the text with 'http://' if the text doesn't start with 'http://',
// the text parses as a url with a scheme of http, the user selected the
// entire host, and the user hasn't edited the host or manually removed the
// scheme.
GURL perm_url(PermanentURL());
if (perm_url.SchemeIs(url::kHttpScheme) &&
url->SchemeIs(url::kHttpScheme) && perm_url.host() == url->host()) {
*write_url = true;
base::string16 http = base::ASCIIToUTF16(url::kHttpScheme) +
base::ASCIIToUTF16(url::kStandardSchemeSeparator);
if (text->compare(0, http.length(), http) != 0)
*text = http + *text;
}
}
void OmniboxEditModel::SetInputInProgress(bool in_progress) {
if (in_progress && !user_input_since_focus_) {
base::TimeTicks now = base::TimeTicks::Now();
DCHECK(last_omnibox_focus_ <= now);
UMA_HISTOGRAM_TIMES(kFocusToEditTimeHistogram, now - last_omnibox_focus_);
user_input_since_focus_ = true;
}
if (user_input_in_progress_ == in_progress)
return;
user_input_in_progress_ = in_progress;
if (user_input_in_progress_) {
time_user_first_modified_omnibox_ = base::TimeTicks::Now();
content::RecordAction(base::UserMetricsAction("OmniboxInputInProgress"));
autocomplete_controller()->ResetSession();
}
// The following code handles two cases:
// * For HIDE_ON_USER_INPUT and ON_SRP, it hides the chip when user input
// begins.
// * For HIDE_ON_MOUSE_RELEASE, which only hides the chip on mouse release if
// the omnibox is empty, it handles the "omnibox was not empty" case by
// acting like HIDE_ON_USER_INPUT.
if (chrome::ShouldDisplayOriginChip() && in_progress)
controller()->GetToolbarModel()->set_origin_chip_enabled(false);
controller_->GetToolbarModel()->set_input_in_progress(in_progress);
controller_->EndOriginChipAnimations(true);
controller_->Update(NULL);
if (user_input_in_progress_ || !in_revert_)
delegate_->OnInputStateChanged();
}
void OmniboxEditModel::Revert() {
SetInputInProgress(false);
paste_state_ = NONE;
InternalSetUserText(base::string16());
keyword_.clear();
is_keyword_hint_ = false;
has_temporary_text_ = false;
view_->SetWindowTextAndCaretPos(permanent_text_,
has_focus() ? permanent_text_.length() : 0,
false, true);
AutocompleteActionPredictor* action_predictor =
predictors::AutocompleteActionPredictorFactory::GetForProfile(profile_);
action_predictor->ClearTransitionalMatches();
action_predictor->CancelPrerender();
}
void OmniboxEditModel::StartAutocomplete(
bool has_selected_text,
bool prevent_inline_autocomplete) {
size_t cursor_position;
if (inline_autocomplete_text_.empty()) {
// Cursor position is equivalent to the current selection's end.
size_t start;
view_->GetSelectionBounds(&start, &cursor_position);
// Adjust cursor position taking into account possible keyword in the user
// text. We rely on DisplayTextFromUserText() method which is consistent
// with keyword extraction done in KeywordProvider/SearchProvider.
const size_t cursor_offset =
user_text_.length() - DisplayTextFromUserText(user_text_).length();
cursor_position += cursor_offset;
} else {
// There are some cases where StartAutocomplete() may be called
// with non-empty |inline_autocomplete_text_|. In such cases, we cannot
// use the current selection, because it could result with the cursor
// position past the last character from the user text. Instead,
// we assume that the cursor is simply at the end of input.
// One example is when user presses Ctrl key while having a highlighted
// inline autocomplete text.
// TODO: Rethink how we are going to handle this case to avoid
// inconsistent behavior when user presses Ctrl key.
// See http://crbug.com/165961 and http://crbug.com/165968 for more details.
cursor_position = user_text_.length();
}
GURL current_url =
(delegate_->CurrentPageExists() && view_->IsIndicatingQueryRefinement()) ?
delegate_->GetURL() : GURL();
input_ = AutocompleteInput(
user_text_, cursor_position, base::string16(), current_url,
ClassifyPage(),
prevent_inline_autocomplete || just_deleted_text_ ||
(has_selected_text && inline_autocomplete_text_.empty()) ||
(paste_state_ != NONE),
is_keyword_selected(),
is_keyword_selected() || allow_exact_keyword_match_,
true, ChromeAutocompleteSchemeClassifier(profile_));
omnibox_controller_->StartAutocomplete(input_);
}
void OmniboxEditModel::StopAutocomplete() {
autocomplete_controller()->Stop(true);
}
bool OmniboxEditModel::CanPasteAndGo(const base::string16& text) const {
if (!view_->command_updater()->IsCommandEnabled(IDC_OPEN_CURRENT_URL))
return false;
AutocompleteMatch match;
ClassifyStringForPasteAndGo(text, &match, NULL);
return match.destination_url.is_valid();
}
void OmniboxEditModel::PasteAndGo(const base::string16& text) {
DCHECK(CanPasteAndGo(text));
UMA_HISTOGRAM_COUNTS("Omnibox.PasteAndGo", 1);
view_->RevertAll();
AutocompleteMatch match;
GURL alternate_nav_url;
ClassifyStringForPasteAndGo(text, &match, &alternate_nav_url);
view_->OpenMatch(match, CURRENT_TAB, alternate_nav_url, text,
OmniboxPopupModel::kNoMatch);
}
bool OmniboxEditModel::IsPasteAndSearch(const base::string16& text) const {
AutocompleteMatch match;
ClassifyStringForPasteAndGo(text, &match, NULL);
return AutocompleteMatch::IsSearchType(match.type);
}
void OmniboxEditModel::AcceptInput(WindowOpenDisposition disposition,
bool for_drop) {
// Get the URL and transition type for the selected entry.
GURL alternate_nav_url;
AutocompleteMatch match = CurrentMatch(&alternate_nav_url);
// If CTRL is down it means the user wants to append ".com" to the text he
// typed. If we can successfully generate a URL_WHAT_YOU_TYPED match doing
// that, then we use this. These matches are marked as generated by the
// HistoryURLProvider so we only generate them if this provider is present.
if (control_key_state_ == DOWN_WITHOUT_CHANGE && !is_keyword_selected() &&
autocomplete_controller()->history_url_provider()) {
// Generate a new AutocompleteInput, copying the latest one but using "com"
// as the desired TLD. Then use this autocomplete input to generate a
// URL_WHAT_YOU_TYPED AutocompleteMatch. Note that using the most recent
// input instead of the currently visible text means we'll ignore any
// visible inline autocompletion: if a user types "foo" and is autocompleted
// to "foodnetwork.com", ctrl-enter will navigate to "foo.com", not
// "foodnetwork.com". At the time of writing, this behavior matches
// Internet Explorer, but not Firefox.
input_ = AutocompleteInput(
has_temporary_text_ ?
UserTextFromDisplayText(view_->GetText()) : input_.text(),
input_.cursor_position(), base::ASCIIToUTF16("com"), GURL(),
input_.current_page_classification(),
input_.prevent_inline_autocomplete(), input_.prefer_keyword(),
input_.allow_exact_keyword_match(), input_.want_asynchronous_matches(),
ChromeAutocompleteSchemeClassifier(profile_));
AutocompleteMatch url_match(
autocomplete_controller()->history_url_provider()->SuggestExactInput(
input_.text(), input_.canonicalized_url(), false));
if (url_match.destination_url.is_valid()) {
// We have a valid URL, we use this newly generated AutocompleteMatch.
match = url_match;
alternate_nav_url = GURL();
}
}
if (!match.destination_url.is_valid())
return;
if ((match.transition == ui::PAGE_TRANSITION_TYPED) &&
(match.destination_url == PermanentURL())) {
// When the user hit enter on the existing permanent URL, treat it like a
// reload for scoring purposes. We could detect this by just checking
// user_input_in_progress_, but it seems better to treat "edits" that end
// up leaving the URL unchanged (e.g. deleting the last character and then
// retyping it) as reloads too. We exclude non-TYPED transitions because if
// the transition is GENERATED, the user input something that looked
// different from the current URL, even if it wound up at the same place
// (e.g. manually retyping the same search query), and it seems wrong to
// treat this as a reload.
match.transition = ui::PAGE_TRANSITION_RELOAD;
} else if (for_drop || ((paste_state_ != NONE) &&
match.is_history_what_you_typed_match)) {
// When the user pasted in a URL and hit enter, score it like a link click
// rather than a normal typed URL, so it doesn't get inline autocompleted
// as aggressively later.
match.transition = ui::PAGE_TRANSITION_LINK;
}
TemplateURLService* service =
TemplateURLServiceFactory::GetForProfile(profile_);
const TemplateURL* template_url = match.GetTemplateURL(service, false);
if (template_url && template_url->url_ref().HasGoogleBaseURLs(
UIThreadSearchTermsData(profile_))) {
GoogleURLTracker* tracker =
GoogleURLTrackerFactory::GetForProfile(profile_);
if (tracker)
tracker->SearchCommitted();
}
DCHECK(popup_model());
view_->OpenMatch(match, disposition, alternate_nav_url, base::string16(),
popup_model()->selected_line());
}
void OmniboxEditModel::OpenMatch(AutocompleteMatch match,
WindowOpenDisposition disposition,
const GURL& alternate_nav_url,
const base::string16& pasted_text,
size_t index) {
const base::TimeTicks& now(base::TimeTicks::Now());
base::TimeDelta elapsed_time_since_user_first_modified_omnibox(
now - time_user_first_modified_omnibox_);
autocomplete_controller()->UpdateMatchDestinationURLWithQueryFormulationTime(
elapsed_time_since_user_first_modified_omnibox, &match);
base::string16 input_text(pasted_text);
if (input_text.empty())
input_text = user_input_in_progress_ ? user_text_ : permanent_text_;
scoped_ptr<OmniboxNavigationObserver> observer(
new OmniboxNavigationObserver(
profile_, input_text, match,
autocomplete_controller()->history_url_provider()->SuggestExactInput(
input_text, alternate_nav_url,
AutocompleteInput::HasHTTPScheme(input_text))));
base::TimeDelta elapsed_time_since_last_change_to_default_match(
now - autocomplete_controller()->last_time_default_match_changed());
DCHECK(match.provider);
// These elapsed times don't really make sense for ZeroSuggest matches
// (because the user does not modify the omnibox for ZeroSuggest), so for
// those we set the elapsed times to something that will be ignored by
// metrics_log.cc. They also don't necessarily make sense if the omnibox
// dropdown is closed or the user used a paste-and-go action. (In most
// cases when this happens, the user never modified the omnibox.)
if ((match.provider->type() == AutocompleteProvider::TYPE_ZERO_SUGGEST) ||
!popup_model()->IsOpen() || !pasted_text.empty()) {
const base::TimeDelta default_time_delta =
base::TimeDelta::FromMilliseconds(-1);
elapsed_time_since_user_first_modified_omnibox = default_time_delta;
elapsed_time_since_last_change_to_default_match = default_time_delta;
}
// If the popup is closed or this is a paste-and-go action (meaning the
// contents of the dropdown are ignored regardless), we record for logging
// purposes a selected_index of 0 and a suggestion list as having a single
// entry of the match used.
ACMatches fake_single_entry_matches;
fake_single_entry_matches.push_back(match);
AutocompleteResult fake_single_entry_result;
fake_single_entry_result.AppendMatches(fake_single_entry_matches);
OmniboxLog log(
input_text,
just_deleted_text_,
input_.type(),
popup_model()->IsOpen(),
(!popup_model()->IsOpen() || !pasted_text.empty()) ? 0 : index,
!pasted_text.empty(),
-1, // don't yet know tab ID; set later if appropriate
ClassifyPage(),
elapsed_time_since_user_first_modified_omnibox,
match.allowed_to_be_default_match ? match.inline_autocompletion.length() :
base::string16::npos,
elapsed_time_since_last_change_to_default_match,
(!popup_model()->IsOpen() || !pasted_text.empty()) ?
fake_single_entry_result : result());
DCHECK(!popup_model()->IsOpen() || !pasted_text.empty() ||
(log.elapsed_time_since_user_first_modified_omnibox >=
log.elapsed_time_since_last_change_to_default_match))
<< "We should've got the notification that the user modified the "
<< "omnibox text at same time or before the most recent time the "
<< "default match changed.";
if ((disposition == CURRENT_TAB) && delegate_->CurrentPageExists()) {
// If we know the destination is being opened in the current tab,
// we can easily get the tab ID. (If it's being opened in a new
// tab, we don't know the tab ID yet.)
log.tab_id = delegate_->GetSessionID().id();
}
autocomplete_controller()->AddProvidersInfo(&log.providers_info);
content::NotificationService::current()->Notify(
chrome::NOTIFICATION_OMNIBOX_OPENED_URL,
content::Source<Profile>(profile_),
content::Details<OmniboxLog>(&log));
LOCAL_HISTOGRAM_BOOLEAN("Omnibox.EventCount", true);
DCHECK(!last_omnibox_focus_.is_null())
<< "An omnibox focus should have occurred before opening a match.";
UMA_HISTOGRAM_TIMES(kFocusToOpenTimeHistogram, now - last_omnibox_focus_);
TemplateURLService* service =
TemplateURLServiceFactory::GetForProfile(profile_);
TemplateURL* template_url = match.GetTemplateURL(service, false);
if (template_url) {
if (match.transition == ui::PAGE_TRANSITION_KEYWORD) {
// The user is using a non-substituting keyword or is explicitly in
// keyword mode.
// Don't increment usage count for extension keywords.
if (delegate_->ProcessExtensionKeyword(template_url, match,
disposition)) {
observer->OnSuccessfulNavigation();
if (disposition != NEW_BACKGROUND_TAB)
view_->RevertAll();
return;
}
content::RecordAction(base::UserMetricsAction("AcceptedKeyword"));
TemplateURLServiceFactory::GetForProfile(profile_)->IncrementUsageCount(
template_url);
} else {
DCHECK_EQ(ui::PAGE_TRANSITION_GENERATED, match.transition);
// NOTE: We purposefully don't increment the usage count of the default
// search engine here like we do for explicit keywords above; see comments
// in template_url.h.
}
UMA_HISTOGRAM_ENUMERATION(
"Omnibox.SearchEngineType",
TemplateURLPrepopulateData::GetEngineType(
*template_url, UIThreadSearchTermsData(profile_)),
SEARCH_ENGINE_MAX);
}
// Get the current text before we call RevertAll() which will clear it.
base::string16 current_text = view_->GetText();
if (disposition != NEW_BACKGROUND_TAB) {
base::AutoReset<bool> tmp(&in_revert_, true);
view_->RevertAll(); // Revert the box to its unedited state.
}
RecordPercentageMatchHistogram(
permanent_text_, current_text,
controller_->GetToolbarModel()->WouldReplaceURL(),
match.transition, view_->GetWidth());
// Track whether the destination URL sends us to a search results page
// using the default search provider.
if (TemplateURLServiceFactory::GetForProfile(profile_)->
IsSearchResultsPageFromDefaultSearchProvider(match.destination_url)) {
content::RecordAction(
base::UserMetricsAction("OmniboxDestinationURLIsSearchOnDSP"));
}
if (match.destination_url.is_valid()) {
// This calls RevertAll again.
base::AutoReset<bool> tmp(&in_revert_, true);
controller_->OnAutocompleteAccept(
match.destination_url, disposition,
ui::PageTransitionFromInt(
match.transition | ui::PAGE_TRANSITION_FROM_ADDRESS_BAR));
if (observer->load_state() != OmniboxNavigationObserver::LOAD_NOT_SEEN)
ignore_result(observer.release()); // The observer will delete itself.
}
BookmarkModel* bookmark_model = BookmarkModelFactory::GetForProfile(profile_);
if (bookmark_model && bookmark_model->IsBookmarked(match.destination_url))
RecordBookmarkLaunch(NULL, BOOKMARK_LAUNCH_LOCATION_OMNIBOX);
}
bool OmniboxEditModel::AcceptKeyword(EnteredKeywordModeMethod entered_method) {
DCHECK(is_keyword_hint_ && !keyword_.empty());
autocomplete_controller()->Stop(false);
is_keyword_hint_ = false;
if (popup_model() && popup_model()->IsOpen())
popup_model()->SetSelectedLineState(OmniboxPopupModel::KEYWORD);
else
StartAutocomplete(false, true);
// Ensure the current selection is saved before showing keyword mode
// so that moving to another line and then reverting the text will restore
// the current state properly.
bool save_original_selection = !has_temporary_text_;
has_temporary_text_ = true;
view_->OnTemporaryTextMaybeChanged(
DisplayTextFromUserText(CurrentMatch(NULL).fill_into_edit),
save_original_selection, true);
view_->UpdatePlaceholderText();
content::RecordAction(base::UserMetricsAction("AcceptedKeywordHint"));
UMA_HISTOGRAM_ENUMERATION(kEnteredKeywordModeHistogram, entered_method,
ENTERED_KEYWORD_MODE_NUM_ITEMS);
return true;
}
void OmniboxEditModel::AcceptTemporaryTextAsUserText() {
InternalSetUserText(UserTextFromDisplayText(view_->GetText()));
has_temporary_text_ = false;
if (user_input_in_progress_ || !in_revert_)
delegate_->OnInputStateChanged();
}
void OmniboxEditModel::ClearKeyword(const base::string16& visible_text) {
autocomplete_controller()->Stop(false);
omnibox_controller_->ClearPopupKeywordMode();
const base::string16 window_text(keyword_ + visible_text);
// Only reset the result if the edit text has changed since the
// keyword was accepted, or if the popup is closed.
if (just_deleted_text_ || !visible_text.empty() ||
!(popup_model() && popup_model()->IsOpen())) {
view_->OnBeforePossibleChange();
view_->SetWindowTextAndCaretPos(window_text.c_str(), keyword_.length(),
false, false);
keyword_.clear();
is_keyword_hint_ = false;
view_->OnAfterPossibleChange();
just_deleted_text_ = true; // OnAfterPossibleChange() fails to clear this
// since the edit contents have actually grown
// longer.
} else {
is_keyword_hint_ = true;
view_->SetWindowTextAndCaretPos(window_text.c_str(), keyword_.length(),
false, true);
}
view_->UpdatePlaceholderText();
}
void OmniboxEditModel::OnSetFocus(bool control_down) {
last_omnibox_focus_ = base::TimeTicks::Now();
user_input_since_focus_ = false;
// If the omnibox lost focus while the caret was hidden and then regained
// focus, OnSetFocus() is called and should restore visibility. Note that
// focus can be regained without an accompanying call to
// OmniboxView::SetFocus(), e.g. by tabbing in.
SetFocusState(OMNIBOX_FOCUS_VISIBLE, OMNIBOX_FOCUS_CHANGE_EXPLICIT);
control_key_state_ = control_down ? DOWN_WITHOUT_CHANGE : UP;
// Try to get ZeroSuggest suggestions if a page is loaded and the user has
// not been typing in the omnibox. The |user_input_in_progress_| check is
// used to detect the case where this function is called after right-clicking
// in the omnibox and selecting paste in Linux (in which case we actually get
// the OnSetFocus() call after the process of handling the paste has kicked
// off).
// TODO(hfung): Remove this when crbug/271590 is fixed.
if (delegate_->CurrentPageExists() && !user_input_in_progress_) {
// TODO(jered): We may want to merge this into Start() and just call that
// here rather than having a special entry point for zero-suggest. Note
// that we avoid PermanentURL() here because it's not guaranteed to give us
// the actual underlying current URL, e.g. if we're on the NTP and the
// |permanent_text_| is empty.
autocomplete_controller()->StartZeroSuggest(AutocompleteInput(
permanent_text_, base::string16::npos, base::string16(),
delegate_->GetURL(), ClassifyPage(), false, false, true, true,
ChromeAutocompleteSchemeClassifier(profile_)));
}
if (user_input_in_progress_ || !in_revert_)
delegate_->OnInputStateChanged();
}
void OmniboxEditModel::SetCaretVisibility(bool visible) {
// Caret visibility only matters if the omnibox has focus.
if (focus_state_ != OMNIBOX_FOCUS_NONE) {
SetFocusState(visible ? OMNIBOX_FOCUS_VISIBLE : OMNIBOX_FOCUS_INVISIBLE,
OMNIBOX_FOCUS_CHANGE_EXPLICIT);
}
}
void OmniboxEditModel::OnWillKillFocus(gfx::NativeView view_gaining_focus) {
if (user_input_in_progress_ || !in_revert_)
delegate_->OnInputStateChanged();
}
void OmniboxEditModel::OnKillFocus() {
SetFocusState(OMNIBOX_FOCUS_NONE, OMNIBOX_FOCUS_CHANGE_EXPLICIT);
focus_source_ = INVALID;
control_key_state_ = UP;
paste_state_ = NONE;
}
bool OmniboxEditModel::OnEscapeKeyPressed() {
const AutocompleteMatch& match = CurrentMatch(NULL);
if (has_temporary_text_) {
if (match.destination_url != original_url_) {
RevertTemporaryText(true);
return true;
}
}
// We do not clear the pending entry from the omnibox when a load is first
// stopped. If the user presses Escape while stopped, we clear it.
if (delegate_->CurrentPageExists() && !delegate_->IsLoading()) {
delegate_->GetNavigationController().DiscardNonCommittedEntries();
view_->Update();
}
// When using the origin chip, hitting escape to revert all should either
// display the URL (when search term replacement would not be performed for
// this page) or the search terms (when it would). To accomplish this,
// we'll need to disable URL replacement iff it's currently enabled and
// search term replacement wouldn't normally happen.
bool should_disable_url_replacement =
controller_->GetToolbarModel()->url_replacement_enabled() &&
!controller_->GetToolbarModel()->WouldPerformSearchTermReplacement(true);
// If the user wasn't editing, but merely had focus in the edit, allow <esc>
// to be processed as an accelerator, so it can still be used to stop a load.
// When the permanent text isn't all selected we still fall through to the
// SelectAll() call below so users can arrow around in the text and then hit
// <esc> to quickly replace all the text; this matches IE.
const bool has_zero_suggest_match = match.provider &&
(match.provider->type() == AutocompleteProvider::TYPE_ZERO_SUGGEST);
if (!has_zero_suggest_match && !should_disable_url_replacement &&
!user_input_in_progress_ && view_->IsSelectAll())
return false;
if (!user_text_.empty()) {
UMA_HISTOGRAM_ENUMERATION(kOmniboxUserTextClearedHistogram,
OMNIBOX_USER_TEXT_CLEARED_WITH_ESCAPE,
OMNIBOX_USER_TEXT_CLEARED_NUM_OF_ITEMS);
}
if (should_disable_url_replacement) {
controller_->GetToolbarModel()->set_url_replacement_enabled(false);
UpdatePermanentText();
}
view_->RevertWithoutResettingSearchTermReplacement();
view_->SelectAll(true);
return true;
}
void OmniboxEditModel::OnControlKeyChanged(bool pressed) {
if (pressed == (control_key_state_ == UP))
control_key_state_ = pressed ? DOWN_WITHOUT_CHANGE : UP;
}
void OmniboxEditModel::OnPaste() {
UMA_HISTOGRAM_COUNTS("Omnibox.Paste", 1);
paste_state_ = PASTING;
}
void OmniboxEditModel::OnUpOrDownKeyPressed(int count) {
// NOTE: This purposefully doesn't trigger any code that resets paste_state_.
if (popup_model() && popup_model()->IsOpen()) {
// The popup is open, so the user should be able to interact with it
// normally.
popup_model()->Move(count);
return;
}
if (!query_in_progress()) {
// The popup is neither open nor working on a query already. So, start an
// autocomplete query for the current text. This also sets
// user_input_in_progress_ to true, which we want: if the user has started
// to interact with the popup, changing the permanent_text_ shouldn't change
// the displayed text.
// Note: This does not force the popup to open immediately.
// TODO(pkasting): We should, in fact, force this particular query to open
// the popup immediately.
if (!user_input_in_progress_)
InternalSetUserText(permanent_text_);
view_->UpdatePopup();
return;
}
// TODO(pkasting): The popup is working on a query but is not open. We should
// force it to open immediately.
}
void OmniboxEditModel::OnPopupDataChanged(
const base::string16& text,
GURL* destination_for_temporary_text_change,
const base::string16& keyword,
bool is_keyword_hint) {
// The popup changed its data, the match in the controller is no longer valid.
omnibox_controller_->InvalidateCurrentMatch();
// Update keyword/hint-related local state.
bool keyword_state_changed = (keyword_ != keyword) ||
((is_keyword_hint_ != is_keyword_hint) && !keyword.empty());
if (keyword_state_changed) {
keyword_ = keyword;
is_keyword_hint_ = is_keyword_hint;
// |is_keyword_hint_| should always be false if |keyword_| is empty.
DCHECK(!keyword_.empty() || !is_keyword_hint_);
}
// Handle changes to temporary text.
if (destination_for_temporary_text_change != NULL) {
const bool save_original_selection = !has_temporary_text_;
if (save_original_selection) {
// Save the original selection and URL so it can be reverted later.
has_temporary_text_ = true;
original_url_ = *destination_for_temporary_text_change;
inline_autocomplete_text_.clear();
view_->OnInlineAutocompleteTextCleared();
}
if (control_key_state_ == DOWN_WITHOUT_CHANGE) {
// Arrowing around the popup cancels control-enter.
control_key_state_ = DOWN_WITH_CHANGE;
// Now things are a bit screwy: the desired_tld has changed, but if we
// update the popup, the new order of entries won't match the old, so the
// user's selection gets screwy; and if we don't update the popup, and the
// user reverts, then the selected item will be as if control is still
// pressed, even though maybe it isn't any more. There is no obvious
// right answer here :(
}
view_->OnTemporaryTextMaybeChanged(DisplayTextFromUserText(text),
save_original_selection, true);
return;
}
bool call_controller_onchanged = true;
inline_autocomplete_text_ = text;
if (inline_autocomplete_text_.empty())
view_->OnInlineAutocompleteTextCleared();
const base::string16& user_text =
user_input_in_progress_ ? user_text_ : permanent_text_;
if (keyword_state_changed && is_keyword_selected()) {
// If we reach here, the user most likely entered keyword mode by inserting
// a space between a keyword name and a search string (as pressing space or
// tab after the keyword name alone would have been be handled in
// MaybeAcceptKeywordBySpace() by calling AcceptKeyword(), which won't reach
// here). In this case, we don't want to call
// OnInlineAutocompleteTextMaybeChanged() as normal, because that will
// correctly change the text (to the search string alone) but move the caret
// to the end of the string; instead we want the caret at the start of the
// search string since that's where it was in the original input. So we set
// the text and caret position directly.
//
// It may also be possible to reach here if we're reverting from having
// temporary text back to a default match that's a keyword search, but in
// that case the RevertTemporaryText() call below will reset the caret or
// selection correctly so the caret positioning we do here won't matter.
view_->SetWindowTextAndCaretPos(DisplayTextFromUserText(user_text), 0,
false, false);
} else if (view_->OnInlineAutocompleteTextMaybeChanged(
DisplayTextFromUserText(user_text + inline_autocomplete_text_),
DisplayTextFromUserText(user_text).length())) {
call_controller_onchanged = false;
}
// If |has_temporary_text_| is true, then we previously had a manual selection
// but now don't (or |destination_for_temporary_text_change| would have been
// non-NULL). This can happen when deleting the selected item in the popup.
// In this case, we've already reverted the popup to the default match, so we
// need to revert ourselves as well.
if (has_temporary_text_) {
RevertTemporaryText(false);
call_controller_onchanged = false;
}
// We need to invoke OnChanged in case the destination url changed (as could
// happen when control is toggled).
if (call_controller_onchanged)
OnChanged();
}
bool OmniboxEditModel::OnAfterPossibleChange(const base::string16& old_text,
const base::string16& new_text,
size_t selection_start,
size_t selection_end,
bool selection_differs,
bool text_differs,
bool just_deleted_text,
bool allow_keyword_ui_change) {
// Update the paste state as appropriate: if we're just finishing a paste
// that replaced all the text, preserve that information; otherwise, if we've
// made some other edit, clear paste tracking.
if (paste_state_ == PASTING)
paste_state_ = PASTED;
else if (text_differs)
paste_state_ = NONE;
if (text_differs || selection_differs) {
// Record current focus state for this input if we haven't already.
if (focus_source_ == INVALID) {
// We should generally expect the omnibox to have focus at this point, but
// it doesn't always on Linux. This is because, unlike other platforms,
// right clicking in the omnibox on Linux doesn't focus it. So pasting via
// right-click can change the contents without focusing the omnibox.
// TODO(samarth): fix Linux focus behavior and add a DCHECK here to
// check that the omnibox does have focus.
focus_source_ = (focus_state_ == OMNIBOX_FOCUS_INVISIBLE) ?
FAKEBOX : OMNIBOX;
}
// Restore caret visibility whenever the user changes text or selection in
// the omnibox.
SetFocusState(OMNIBOX_FOCUS_VISIBLE, OMNIBOX_FOCUS_CHANGE_TYPING);
}
// Modifying the selection counts as accepting the autocompleted text.
const bool user_text_changed =
text_differs || (selection_differs && !inline_autocomplete_text_.empty());
// If something has changed while the control key is down, prevent
// "ctrl-enter" until the control key is released.
if ((text_differs || selection_differs) &&
(control_key_state_ == DOWN_WITHOUT_CHANGE))
control_key_state_ = DOWN_WITH_CHANGE;
if (!user_text_changed)
return false;
// If the user text has not changed, we do not want to change the model's
// state associated with the text. Otherwise, we can get surprising behavior
// where the autocompleted text unexpectedly reappears, e.g. crbug.com/55983
InternalSetUserText(UserTextFromDisplayText(new_text));
has_temporary_text_ = false;
// Track when the user has deleted text so we won't allow inline
// autocomplete.
just_deleted_text_ = just_deleted_text;
if (user_input_in_progress_ && user_text_.empty()) {
// Log cases where the user started editing and then subsequently cleared
// all the text. Note that this explicitly doesn't catch cases like
// "hit ctrl-l to select whole edit contents, then hit backspace", because
// in such cases, |user_input_in_progress| won't be true here.
UMA_HISTOGRAM_ENUMERATION(kOmniboxUserTextClearedHistogram,
OMNIBOX_USER_TEXT_CLEARED_BY_EDITING,
OMNIBOX_USER_TEXT_CLEARED_NUM_OF_ITEMS);
}
const bool no_selection = selection_start == selection_end;
// Update the popup for the change, in the process changing to keyword mode
// if the user hit space in mid-string after a keyword.
// |allow_exact_keyword_match_| will be used by StartAutocomplete() method,
// which will be called by |view_->UpdatePopup()|; so after that returns we
// can safely reset this flag.
allow_exact_keyword_match_ = text_differs && allow_keyword_ui_change &&
!just_deleted_text && no_selection &&
CreatedKeywordSearchByInsertingSpaceInMiddle(old_text, user_text_,
selection_start);
view_->UpdatePopup();
if (allow_exact_keyword_match_) {
view_->UpdatePlaceholderText();
UMA_HISTOGRAM_ENUMERATION(kEnteredKeywordModeHistogram,
ENTERED_KEYWORD_MODE_VIA_SPACE_IN_MIDDLE,
ENTERED_KEYWORD_MODE_NUM_ITEMS);
allow_exact_keyword_match_ = false;
}
// Change to keyword mode if the user is now pressing space after a keyword
// name. Note that if this is the case, then even if there was no keyword
// hint when we entered this function (e.g. if the user has used space to
// replace some selected text that was adjoined to this keyword), there will
// be one now because of the call to UpdatePopup() above; so it's safe for
// MaybeAcceptKeywordBySpace() to look at |keyword_| and |is_keyword_hint_| to
// determine what keyword, if any, is applicable.
//
// If MaybeAcceptKeywordBySpace() accepts the keyword and returns true, that
// will have updated our state already, so in that case we don't also return
// true from this function.
return !(text_differs && allow_keyword_ui_change && !just_deleted_text &&
no_selection && (selection_start == user_text_.length()) &&
MaybeAcceptKeywordBySpace(user_text_));
}
// TODO(beaudoin): Merge OnPopupDataChanged with this method once the popup
// handling has completely migrated to omnibox_controller.
void OmniboxEditModel::OnCurrentMatchChanged() {
has_temporary_text_ = false;
const AutocompleteMatch& match = omnibox_controller_->current_match();
// We store |keyword| and |is_keyword_hint| in temporary variables since
// OnPopupDataChanged use their previous state to detect changes.
base::string16 keyword;
bool is_keyword_hint;
TemplateURLService* service =
TemplateURLServiceFactory::GetForProfile(profile_);
match.GetKeywordUIState(service, &keyword, &is_keyword_hint);
if (popup_model())
popup_model()->OnResultChanged();
// OnPopupDataChanged() resets OmniboxController's |current_match_| early
// on. Therefore, copy match.inline_autocompletion to a temp to preserve
// its value across the entire call.
const base::string16 inline_autocompletion(match.inline_autocompletion);
OnPopupDataChanged(inline_autocompletion, NULL, keyword, is_keyword_hint);
}
void OmniboxEditModel::SetSuggestionToPrefetch(
const InstantSuggestion& suggestion) {
delegate_->SetSuggestionToPrefetch(suggestion);
}
// static
const char OmniboxEditModel::kCutOrCopyAllTextHistogram[] =
"Omnibox.CutOrCopyAllText";
bool OmniboxEditModel::query_in_progress() const {
return !autocomplete_controller()->done();
}
void OmniboxEditModel::InternalSetUserText(const base::string16& text) {
user_text_ = text;
just_deleted_text_ = false;
inline_autocomplete_text_.clear();
view_->OnInlineAutocompleteTextCleared();
}
void OmniboxEditModel::ClearPopupKeywordMode() const {
omnibox_controller_->ClearPopupKeywordMode();
}
base::string16 OmniboxEditModel::DisplayTextFromUserText(
const base::string16& text) const {
return is_keyword_selected() ?
KeywordProvider::SplitReplacementStringFromInput(text, false) : text;
}
base::string16 OmniboxEditModel::UserTextFromDisplayText(
const base::string16& text) const {
return is_keyword_selected() ? (keyword_ + base::char16(' ') + text) : text;
}
void OmniboxEditModel::GetInfoForCurrentText(AutocompleteMatch* match,
GURL* alternate_nav_url) const {
DCHECK(match != NULL);
if (controller_->GetToolbarModel()->WouldPerformSearchTermReplacement(
false)) {
// Any time the user hits enter on the unchanged omnibox, we should reload.
// When we're not extracting search terms, AcceptInput() will take care of
// this (see code referring to PAGE_TRANSITION_RELOAD there), but when we're
// extracting search terms, the conditionals there won't fire, so we
// explicitly set up a match that will reload here.
// It's important that we fetch the current visible URL to reload instead of
// just getting a "search what you typed" URL from
// SearchProvider::CreateSearchSuggestion(), since the user may be in a
// non-default search mode such as image search.
match->type = AutocompleteMatchType::SEARCH_WHAT_YOU_TYPED;
match->provider = autocomplete_controller()->search_provider();
match->destination_url =
delegate_->GetNavigationController().GetVisibleEntry()->GetURL();
match->transition = ui::PAGE_TRANSITION_RELOAD;
} else if (query_in_progress() ||
(popup_model() && popup_model()->IsOpen())) {
if (query_in_progress()) {
// It's technically possible for |result| to be empty if no provider
// returns a synchronous result but the query has not completed
// synchronously; pratically, however, that should never actually happen.
if (result().empty())
return;
// The user cannot have manually selected a match, or the query would have
// stopped. So the default match must be the desired selection.
*match = *result().default_match();
} else {
// If there are no results, the popup should be closed, so we shouldn't
// have gotten here.
CHECK(!result().empty());
CHECK(popup_model()->selected_line() < result().size());
*match = result().match_at(popup_model()->selected_line());
}
if (alternate_nav_url &&
(!popup_model() || popup_model()->manually_selected_match().empty()))
*alternate_nav_url = result().alternate_nav_url();
} else {
AutocompleteClassifierFactory::GetForProfile(profile_)->Classify(
UserTextFromDisplayText(view_->GetText()), is_keyword_selected(), true,
ClassifyPage(), match, alternate_nav_url);
}
}
void OmniboxEditModel::RevertTemporaryText(bool revert_popup) {
// The user typed something, then selected a different item. Restore the
// text they typed and change back to the default item.
// NOTE: This purposefully does not reset paste_state_.
just_deleted_text_ = false;
has_temporary_text_ = false;
if (revert_popup && popup_model())
popup_model()->ResetToDefaultMatch();
view_->OnRevertTemporaryText();
}
bool OmniboxEditModel::MaybeAcceptKeywordBySpace(
const base::string16& new_text) {
size_t keyword_length = new_text.length() - 1;
return (paste_state_ == NONE) && is_keyword_hint_ && !keyword_.empty() &&
inline_autocomplete_text_.empty() &&
(keyword_.length() == keyword_length) &&
IsSpaceCharForAcceptingKeyword(new_text[keyword_length]) &&
!new_text.compare(0, keyword_length, keyword_, 0, keyword_length) &&
AcceptKeyword(ENTERED_KEYWORD_MODE_VIA_SPACE_AT_END);
}
bool OmniboxEditModel::CreatedKeywordSearchByInsertingSpaceInMiddle(
const base::string16& old_text,
const base::string16& new_text,
size_t caret_position) const {
DCHECK_GE(new_text.length(), caret_position);
// Check simple conditions first.
if ((paste_state_ != NONE) || (caret_position < 2) ||
(old_text.length() < caret_position) ||
(new_text.length() == caret_position))
return false;
size_t space_position = caret_position - 1;
if (!IsSpaceCharForAcceptingKeyword(new_text[space_position]) ||
IsWhitespace(new_text[space_position - 1]) ||
new_text.compare(0, space_position, old_text, 0, space_position) ||
!new_text.compare(space_position, new_text.length() - space_position,
old_text, space_position,
old_text.length() - space_position)) {
return false;
}
// Then check if the text before the inserted space matches a keyword.
base::string16 keyword;
base::TrimWhitespace(new_text.substr(0, space_position), base::TRIM_LEADING,
&keyword);
return !keyword.empty() && !autocomplete_controller()->keyword_provider()->
GetKeywordForText(keyword).empty();
}
// static
bool OmniboxEditModel::IsSpaceCharForAcceptingKeyword(wchar_t c) {
switch (c) {
case 0x0020: // Space
case 0x3000: // Ideographic Space
return true;
default:
return false;
}
}
OmniboxEventProto::PageClassification OmniboxEditModel::ClassifyPage() const {
if (!delegate_->CurrentPageExists())
return OmniboxEventProto::OTHER;
if (delegate_->IsInstantNTP()) {
// Note that we treat OMNIBOX as the source if focus_source_ is INVALID,
// i.e., if input isn't actually in progress.
return (focus_source_ == FAKEBOX) ?
OmniboxEventProto::INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS :
OmniboxEventProto::INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS;
}
const GURL& gurl = delegate_->GetURL();
if (!gurl.is_valid())
return OmniboxEventProto::INVALID_SPEC;
const std::string& url = gurl.spec();
if (url == chrome::kChromeUINewTabURL)
return OmniboxEventProto::NTP;
if (url == url::kAboutBlankURL)
return OmniboxEventProto::BLANK;
if (url == profile()->GetPrefs()->GetString(prefs::kHomePage))
return OmniboxEventProto::HOME_PAGE;
if (controller_->GetToolbarModel()->WouldPerformSearchTermReplacement(true))
return OmniboxEventProto::SEARCH_RESULT_PAGE_DOING_SEARCH_TERM_REPLACEMENT;
if (delegate_->IsSearchResultsPage())
return OmniboxEventProto::SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT;
return OmniboxEventProto::OTHER;
}
void OmniboxEditModel::ClassifyStringForPasteAndGo(
const base::string16& text,
AutocompleteMatch* match,
GURL* alternate_nav_url) const {
DCHECK(match);
AutocompleteClassifierFactory::GetForProfile(profile_)->Classify(
text, false, false, ClassifyPage(), match, alternate_nav_url);
}
void OmniboxEditModel::SetFocusState(OmniboxFocusState state,
OmniboxFocusChangeReason reason) {
if (state == focus_state_)
return;
// Update state and notify view if the omnibox has focus and the caret
// visibility changed.
const bool was_caret_visible = is_caret_visible();
focus_state_ = state;
if (focus_state_ != OMNIBOX_FOCUS_NONE &&
is_caret_visible() != was_caret_visible)
view_->ApplyCaretVisibility();
delegate_->OnFocusChanged(focus_state_, reason);
}