chrome/browser/ui/omnibox/omnibox_controller.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "chrome/browser/ui/omnibox/omnibox_controller.h"
   6
   7 #include "base/metrics/histogram.h"
   8 #include "chrome/browser/autocomplete/autocomplete_classifier.h"
   9 #include "chrome/browser/autocomplete/autocomplete_match.h"
  10 #include "chrome/browser/autocomplete/search_provider.h"
  11 #include "chrome/browser/net/predictor.h"
  12 #include "chrome/browser/predictors/autocomplete_action_predictor.h"
  13 #include "chrome/browser/prerender/prerender_field_trial.h"
  14 #include "chrome/browser/prerender/prerender_manager.h"
  15 #include "chrome/browser/prerender/prerender_manager_factory.h"
  16 #include "chrome/browser/profiles/profile.h"
  17 #include "chrome/browser/search/search.h"
  18 #include "chrome/browser/ui/omnibox/omnibox_edit_controller.h"
  19 #include "chrome/browser/ui/omnibox/omnibox_edit_model.h"
  20 #include "chrome/browser/ui/omnibox/omnibox_popup_model.h"
  21 #include "chrome/browser/ui/omnibox/omnibox_popup_view.h"
  22 #include "chrome/common/instant_types.h"
  23 #include "extensions/common/constants.h"
  24 #include "ui/gfx/rect.h"
  25
  26 namespace {
  27
  28 // Returns the AutocompleteMatch that the InstantController should prefetch, if
  29 // any.
  30 //
  31 // The SearchProvider may mark some suggestions to be prefetched based on
  32 // instructions from the suggest server. If such a match ranks sufficiently
  33 // highly, we'll return it.
  34 //
  35 // We only care about matches that are the default or the very first entry in
  36 // the dropdown (which can happen for non-default matches only if we're hiding
  37 // a top verbatim match) or the second entry in the dropdown (which can happen
  38 // for non-default matches when a top verbatim match is shown); for other
  39 // matches, we think the likelihood of the user selecting them is low enough
  40 // that prefetching isn't worth doing.
  41 const AutocompleteMatch* GetMatchToPrefetch(const AutocompleteResult& result) {
  42   // If the default match should be prefetched, do that.
  43   const AutocompleteResult::const_iterator default_match(
  44       result.default_match());
  45   if ((default_match != result.end()) &&
  46       SearchProvider::ShouldPrefetch(*default_match))
  47     return &(*default_match);
  48
  49   // Otherwise, if the top match is a verbatim match and the very next match is
  50   // prefetchable, fetch that.
  51   if ((result.ShouldHideTopMatch() ||
  52        result.TopMatchIsStandaloneVerbatimMatch()) &&
  53       (result.size() > 1) &&
  54       SearchProvider::ShouldPrefetch(result.match_at(1)))
  55     return &result.match_at(1);
  56
  57   return NULL;
  58 }
  59
  60 }  // namespace
  61
  62 OmniboxController::OmniboxController(OmniboxEditModel* omnibox_edit_model,
  63                                      Profile* profile)
  64     : omnibox_edit_model_(omnibox_edit_model),
  65       profile_(profile),
  66       popup_(NULL),
  67       autocomplete_controller_(new AutocompleteController(profile, this,
  68           AutocompleteClassifier::kDefaultOmniboxProviders)) {
  69 }
  70
  71 OmniboxController::~OmniboxController() {
  72 }
  73
  74 void OmniboxController::StartAutocomplete(
  75     const AutocompleteInput& input) const {
  76   ClearPopupKeywordMode();
  77   popup_->SetHoveredLine(OmniboxPopupModel::kNoMatch);
  78
  79   // We don't explicitly clear OmniboxPopupModel::manually_selected_match, as
  80   // Start ends up invoking OmniboxPopupModel::OnResultChanged which clears it.
  81   autocomplete_controller_->Start(input);
  82 }
  83
  84 void OmniboxController::OnResultChanged(bool default_match_changed) {
  85   const bool was_open = popup_->IsOpen();
  86   if (default_match_changed) {
  87     // The default match has changed, we need to let the OmniboxEditModel know
  88     // about new inline autocomplete text (blue highlight).
  89     const AutocompleteResult& result = this->result();
  90     const AutocompleteResult::const_iterator match(result.default_match());
  91     if (match != result.end()) {
  92       current_match_ = *match;
  93       if (!prerender::IsOmniboxEnabled(profile_))
  94         DoPreconnect(*match);
  95       omnibox_edit_model_->OnCurrentMatchChanged();
  96
  97       if (chrome::IsInstantExtendedAPIEnabled()) {
  98         InstantSuggestion prefetch_suggestion;
  99         const AutocompleteMatch* match_to_prefetch = GetMatchToPrefetch(result);
 100         if (match_to_prefetch) {
 101           prefetch_suggestion.text = match_to_prefetch->contents;
 102           prefetch_suggestion.metadata =
 103               SearchProvider::GetSuggestMetadata(*match_to_prefetch);
 104         }
 105         // Send the prefetch suggestion unconditionally to the InstantPage. If
 106         // there is no suggestion to prefetch, we need to send a blank query to
 107         // clear the prefetched results.
 108         omnibox_edit_model_->SetSuggestionToPrefetch(prefetch_suggestion);
 109       }
 110     } else {
 111       InvalidateCurrentMatch();
 112       popup_->OnResultChanged();
 113       omnibox_edit_model_->OnPopupDataChanged(base::string16(), NULL,
 114                                               base::string16(), false);
 115     }
 116   } else {
 117     popup_->OnResultChanged();
 118   }
 119
 120   if (!popup_->IsOpen() && was_open) {
 121     // Accept the temporary text as the user text, because it makes little sense
 122     // to have temporary text when the popup is closed.
 123     omnibox_edit_model_->AcceptTemporaryTextAsUserText();
 124   }
 125 }
 126
 127 void OmniboxController::InvalidateCurrentMatch() {
 128   current_match_ = AutocompleteMatch();
 129 }
 130
 131 void OmniboxController::ClearPopupKeywordMode() const {
 132   if (popup_->IsOpen() &&
 133       popup_->selected_line_state() == OmniboxPopupModel::KEYWORD)
 134     popup_->SetSelectedLineState(OmniboxPopupModel::NORMAL);
 135 }
 136
 137 void OmniboxController::DoPreconnect(const AutocompleteMatch& match) {
 138   if (!match.destination_url.SchemeIs(extensions::kExtensionScheme)) {
 139     // Warm up DNS Prefetch cache, or preconnect to a search service.
 140     UMA_HISTOGRAM_ENUMERATION("Autocomplete.MatchType", match.type,
 141                               AutocompleteMatchType::NUM_TYPES);
 142     if (profile_->GetNetworkPredictor()) {
 143       profile_->GetNetworkPredictor()->AnticipateOmniboxUrl(
 144           match.destination_url,
 145           predictors::AutocompleteActionPredictor::IsPreconnectable(match));
 146     }
 147     // We could prefetch the alternate nav URL, if any, but because there
 148     // can be many of these as a user types an initial series of characters,
 149     // the OS DNS cache could suffer eviction problems for minimal gain.
 150   }
 151 }