autocomplete_controller.h revision 23730a6e56a168d1879203e4b3819bb36e3d8f1f
1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_ 6#define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_ 7 8#include "base/basictypes.h" 9#include "base/compiler_specific.h" 10#include "base/gtest_prod_util.h" 11#include "base/strings/string16.h" 12#include "base/time/time.h" 13#include "base/timer/timer.h" 14#include "chrome/browser/autocomplete/autocomplete_input.h" 15#include "chrome/browser/autocomplete/autocomplete_provider.h" 16#include "chrome/browser/autocomplete/autocomplete_provider_listener.h" 17#include "chrome/browser/autocomplete/autocomplete_result.h" 18 19class AutocompleteControllerDelegate; 20class HistoryURLProvider; 21class KeywordProvider; 22class Profile; 23class SearchProvider; 24class ZeroSuggestProvider; 25 26// The AutocompleteController is the center of the autocomplete system. A 27// class creates an instance of the controller, which in turn creates a set of 28// AutocompleteProviders to serve it. The owning class can ask the controller 29// to Start() a query; the controller in turn passes this call down to the 30// providers, each of which keeps track of its own matches and whether it has 31// finished processing the query. When a provider gets more matches or finishes 32// processing, it notifies the controller, which merges the combined matches 33// together and makes the result available to interested observers. 34// 35// The owner may also cancel the current query by calling Stop(), which the 36// controller will in turn communicate to all the providers. No callbacks will 37// happen after a request has been stopped. 38// 39// IMPORTANT: There is NO THREAD SAFETY built into this portion of the 40// autocomplete system. All calls to and from the AutocompleteController should 41// happen on the same thread. AutocompleteProviders are responsible for doing 42// their own thread management when they need to return matches asynchronously. 43// 44// The coordinator for autocomplete queries, responsible for combining the 45// matches from a series of providers into one AutocompleteResult. 46class AutocompleteController : public AutocompleteProviderListener { 47 public: 48 // |provider_types| is a bitmap containing AutocompleteProvider::Type values 49 // that will (potentially, depending on platform, flags, etc.) be 50 // instantiated. 51 AutocompleteController(Profile* profile, 52 AutocompleteControllerDelegate* delegate, 53 int provider_types); 54 ~AutocompleteController(); 55 56 // Starts an autocomplete query, which continues until all providers are 57 // done or the query is Stop()ed. It is safe to Start() a new query without 58 // Stop()ing the previous one. 59 // 60 // See AutocompleteInput::AutocompleteInput(...) for more details regarding 61 // |input| params. 62 // 63 // The controller calls AutocompleteControllerDelegate::OnResultChanged() from 64 // inside this call at least once. If matches are available later on that 65 // result in changing the result set the delegate is notified again. When the 66 // controller is done the notification AUTOCOMPLETE_CONTROLLER_RESULT_READY is 67 // sent. 68 void Start(const AutocompleteInput& input); 69 70 // Cancels the current query, ensuring there will be no future notifications 71 // fired. If new matches have come in since the most recent notification was 72 // fired, they will be discarded. 73 // 74 // If |clear_result| is true, the controller will also erase the result set. 75 void Stop(bool clear_result); 76 77 // Begin asynchronously fetching zero-suggest suggestions for |url| of 78 // classification |page_classification|. |permanent_text| is the omnibox 79 // text for the current page. 80 void StartZeroSuggest( 81 const GURL& url, 82 AutocompleteInput::PageClassification page_classification, 83 const base::string16& permanent_text); 84 85 // Cancels any pending zero-suggest fetch. 86 void StopZeroSuggest(); 87 88 // Asks the relevant provider to delete |match|, and ensures observers are 89 // notified of resulting changes immediately. This should only be called when 90 // no query is running. 91 void DeleteMatch(const AutocompleteMatch& match); 92 93 // Removes any entries that were copied from the last result. This is used by 94 // the popup to ensure it's not showing an out-of-date query. 95 void ExpireCopiedEntries(); 96 97 // AutocompleteProviderListener: 98 virtual void OnProviderUpdate(bool updated_matches) OVERRIDE; 99 100 // Called when an omnibox event log entry is generated. 101 // Populates provider_info with diagnostic information about the status 102 // of various providers. In turn, calls 103 // AutocompleteProvider::AddProviderInfo() so each provider can add 104 // provider-specific information, information we want to log for a particular 105 // provider but not others. 106 void AddProvidersInfo(ProvidersInfo* provider_info) const; 107 108 // Called when a new omnibox session starts. 109 // We start a new session when the user first begins modifying the omnibox 110 // content; see |OmniboxEditModel::user_input_in_progress_|. 111 void ResetSession(); 112 113 // Constructs the final destination URL for a given match using additional 114 // parameters otherwise not available at initial construction time. This 115 // method should be called from OmniboxEditModel::OpenMatch() before the user 116 // navigates to the selected match. 117 void UpdateMatchDestinationURL(base::TimeDelta query_formulation_time, 118 AutocompleteMatch* match) const; 119 120 HistoryURLProvider* history_url_provider() const { 121 return history_url_provider_; 122 } 123 KeywordProvider* keyword_provider() const { return keyword_provider_; } 124 SearchProvider* search_provider() const { return search_provider_; } 125 126 const AutocompleteInput& input() const { return input_; } 127 const AutocompleteResult& result() const { return result_; } 128 bool done() const { return done_; } 129 const ACProviders* providers() const { return &providers_; } 130 131 const base::TimeTicks& last_time_default_match_changed() const { 132 return last_time_default_match_changed_; 133 } 134 135 private: 136 friend class AutocompleteProviderTest; 137 FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, 138 RedundantKeywordsIgnoredInResult); 139 FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, UpdateAssistedQueryStats); 140 FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, GetDestinationURL); 141 142 // Updates |result_| to reflect the current provider state and fires 143 // notifications. If |regenerate_result| then we clear the result 144 // so when we incorporate the current provider state we end up 145 // implicitly removing all expired matches. (Normally we allow 146 // matches from the previous result set carry over. These stale 147 // results may outrank legitimate matches from the current result 148 // set. Sometimes we just want the current matches; the easier way 149 // to do this is to throw everything out and reconstruct the result 150 // set from the providers' current data.) 151 // If |force_notify_default_match_changed|, we tell NotifyChanged 152 // the default match has changed even if it hasn't. This is 153 // necessary in some cases; for instance, if the user typed a new 154 // character, the edit model needs to repaint (highlighting changed) 155 // even if the default match didn't change. 156 void UpdateResult(bool regenerate_result, 157 bool force_notify_default_match_changed); 158 159 // Updates |result| to populate each match's |associated_keyword| if that 160 // match can show a keyword hint. |result| should be sorted by 161 // relevance before this is called. 162 void UpdateAssociatedKeywords(AutocompleteResult* result); 163 164 // For each group of contiguous matches from the same TemplateURL, show the 165 // provider name as a description on the first match in the group. 166 void UpdateKeywordDescriptions(AutocompleteResult* result); 167 168 // For each AutocompleteMatch returned by SearchProvider, updates the 169 // destination_url iff the provider's TemplateURL supports assisted query 170 // stats. 171 void UpdateAssistedQueryStats(AutocompleteResult* result); 172 173 // Calls AutocompleteControllerDelegate::OnResultChanged() and if done sends 174 // AUTOCOMPLETE_CONTROLLER_RESULT_READY. 175 void NotifyChanged(bool notify_default_match); 176 177 // Updates |done_| to be accurate with respect to current providers' statuses. 178 void CheckIfDone(); 179 180 // Starts |expire_timer_|. 181 void StartExpireTimer(); 182 183 // Starts |stop_timer_|. 184 void StartStopTimer(); 185 186 AutocompleteControllerDelegate* delegate_; 187 188 // A list of all providers. 189 ACProviders providers_; 190 191 HistoryURLProvider* history_url_provider_; 192 193 KeywordProvider* keyword_provider_; 194 195 SearchProvider* search_provider_; 196 197 ZeroSuggestProvider* zero_suggest_provider_; 198 199 // Input passed to Start. 200 AutocompleteInput input_; 201 202 // Data from the autocomplete query. 203 AutocompleteResult result_; 204 205 // The most recent time the default match (inline match) changed. This may 206 // be earlier than the most recent keystroke if the recent keystrokes didn't 207 // change the suggested match in the omnibox. (For instance, if 208 // a user typed "mail.goog" and the match https://mail.google.com/ was 209 // the destination match ever since the user typed "ma" then this is 210 // the time that URL first appeared as the default match.) This may 211 // also be more recent than the last keystroke if there was an 212 // asynchronous provider that returned and changed the default 213 // match. See UpdateResult() for details on when we consider a 214 // match to have changed. 215 base::TimeTicks last_time_default_match_changed_; 216 217 // Timer used to remove any matches copied from the last result. When run 218 // invokes |ExpireCopiedEntries|. 219 base::OneShotTimer<AutocompleteController> expire_timer_; 220 221 // Timer used to tell the providers to Stop() searching for matches. 222 base::OneShotTimer<AutocompleteController> stop_timer_; 223 224 // Amount of time (in ms) between when the user stops typing and 225 // when we send Stop() to every provider. This is intended to avoid 226 // the disruptive effect of belated omnibox updates, updates that 227 // come after the user has had to time to read the whole dropdown 228 // and doesn't expect it to change. 229 const base::TimeDelta stop_timer_duration_; 230 231 // True if a query is not currently running. 232 bool done_; 233 234 // Are we in Start()? This is used to avoid updating |result_| and sending 235 // notifications until Start() has been invoked on all providers. 236 bool in_start_; 237 238 Profile* profile_; 239 240 DISALLOW_COPY_AND_ASSIGN(AutocompleteController); 241}; 242 243#endif // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_ 244