autocomplete_controller.h revision effb81e5f8246d0db0270817048dc992db66e9fb
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 asynchronous fetch of zero-suggest suggestions. The |input| should 78 // contain current omnibox input, the URL of the page we are on, and 79 // that page's classification. 80 void StartZeroSuggest(const AutocompleteInput& input); 81 82 // Asks the relevant provider to delete |match|, and ensures observers are 83 // notified of resulting changes immediately. This should only be called when 84 // no query is running. 85 void DeleteMatch(const AutocompleteMatch& match); 86 87 // Removes any entries that were copied from the last result. This is used by 88 // the popup to ensure it's not showing an out-of-date query. 89 void ExpireCopiedEntries(); 90 91 // AutocompleteProviderListener: 92 virtual void OnProviderUpdate(bool updated_matches) OVERRIDE; 93 94 // Called when an omnibox event log entry is generated. 95 // Populates provider_info with diagnostic information about the status 96 // of various providers. In turn, calls 97 // AutocompleteProvider::AddProviderInfo() so each provider can add 98 // provider-specific information, information we want to log for a particular 99 // provider but not others. 100 void AddProvidersInfo(ProvidersInfo* provider_info) const; 101 102 // Called when a new omnibox session starts. 103 // We start a new session when the user first begins modifying the omnibox 104 // content; see |OmniboxEditModel::user_input_in_progress_|. 105 void ResetSession(); 106 107 // Constructs the final destination URL for a given match using additional 108 // parameters otherwise not available at initial construction time. This 109 // method should be called from OmniboxEditModel::OpenMatch() before the user 110 // navigates to the selected match. 111 void UpdateMatchDestinationURL(base::TimeDelta query_formulation_time, 112 AutocompleteMatch* match) const; 113 114 HistoryURLProvider* history_url_provider() const { 115 return history_url_provider_; 116 } 117 KeywordProvider* keyword_provider() const { return keyword_provider_; } 118 SearchProvider* search_provider() const { return search_provider_; } 119 120 const AutocompleteInput& input() const { return input_; } 121 const AutocompleteResult& result() const { return result_; } 122 bool done() const { return done_; } 123 const ACProviders* providers() const { return &providers_; } 124 125 const base::TimeTicks& last_time_default_match_changed() const { 126 return last_time_default_match_changed_; 127 } 128 129 private: 130 friend class AutocompleteProviderTest; 131 FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, 132 RedundantKeywordsIgnoredInResult); 133 FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, UpdateAssistedQueryStats); 134 FRIEND_TEST_ALL_PREFIXES(AutocompleteProviderTest, GetDestinationURL); 135 136 // Updates |result_| to reflect the current provider state and fires 137 // notifications. If |regenerate_result| then we clear the result 138 // so when we incorporate the current provider state we end up 139 // implicitly removing all expired matches. (Normally we allow 140 // matches from the previous result set carry over. These stale 141 // results may outrank legitimate matches from the current result 142 // set. Sometimes we just want the current matches; the easier way 143 // to do this is to throw everything out and reconstruct the result 144 // set from the providers' current data.) 145 // If |force_notify_default_match_changed|, we tell NotifyChanged 146 // the default match has changed even if it hasn't. This is 147 // necessary in some cases; for instance, if the user typed a new 148 // character, the edit model needs to repaint (highlighting changed) 149 // even if the default match didn't change. 150 void UpdateResult(bool regenerate_result, 151 bool force_notify_default_match_changed); 152 153 // Updates |result| to populate each match's |associated_keyword| if that 154 // match can show a keyword hint. |result| should be sorted by 155 // relevance before this is called. 156 void UpdateAssociatedKeywords(AutocompleteResult* result); 157 158 // For each group of contiguous matches from the same TemplateURL, show the 159 // provider name as a description on the first match in the group. 160 void UpdateKeywordDescriptions(AutocompleteResult* result); 161 162 // For each AutocompleteMatch returned by SearchProvider, updates the 163 // destination_url iff the provider's TemplateURL supports assisted query 164 // stats. 165 void UpdateAssistedQueryStats(AutocompleteResult* result); 166 167 // Calls AutocompleteControllerDelegate::OnResultChanged() and if done sends 168 // AUTOCOMPLETE_CONTROLLER_RESULT_READY. 169 void NotifyChanged(bool notify_default_match); 170 171 // Updates |done_| to be accurate with respect to current providers' statuses. 172 void CheckIfDone(); 173 174 // Starts |expire_timer_|. 175 void StartExpireTimer(); 176 177 // Starts |stop_timer_|. 178 void StartStopTimer(); 179 180 AutocompleteControllerDelegate* delegate_; 181 182 // A list of all providers. 183 ACProviders providers_; 184 185 HistoryURLProvider* history_url_provider_; 186 187 KeywordProvider* keyword_provider_; 188 189 SearchProvider* search_provider_; 190 191 ZeroSuggestProvider* zero_suggest_provider_; 192 193 // Input passed to Start. 194 AutocompleteInput input_; 195 196 // Data from the autocomplete query. 197 AutocompleteResult result_; 198 199 // The most recent time the default match (inline match) changed. This may 200 // be earlier than the most recent keystroke if the recent keystrokes didn't 201 // change the suggested match in the omnibox. (For instance, if 202 // a user typed "mail.goog" and the match https://mail.google.com/ was 203 // the destination match ever since the user typed "ma" then this is 204 // the time that URL first appeared as the default match.) This may 205 // also be more recent than the last keystroke if there was an 206 // asynchronous provider that returned and changed the default 207 // match. See UpdateResult() for details on when we consider a 208 // match to have changed. 209 base::TimeTicks last_time_default_match_changed_; 210 211 // Timer used to remove any matches copied from the last result. When run 212 // invokes |ExpireCopiedEntries|. 213 base::OneShotTimer<AutocompleteController> expire_timer_; 214 215 // Timer used to tell the providers to Stop() searching for matches. 216 base::OneShotTimer<AutocompleteController> stop_timer_; 217 218 // Amount of time (in ms) between when the user stops typing and 219 // when we send Stop() to every provider. This is intended to avoid 220 // the disruptive effect of belated omnibox updates, updates that 221 // come after the user has had to time to read the whole dropdown 222 // and doesn't expect it to change. 223 const base::TimeDelta stop_timer_duration_; 224 225 // True if a query is not currently running. 226 bool done_; 227 228 // Are we in Start()? This is used to avoid updating |result_| and sending 229 // notifications until Start() has been invoked on all providers. 230 bool in_start_; 231 232 Profile* profile_; 233 234 DISALLOW_COPY_AND_ASSIGN(AutocompleteController); 235}; 236 237#endif // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_CONTROLLER_H_ 238