Experimental AutocompleteProvider for zerosuggest.

chrome/browser/autocomplete/autocomplete_controller.cc

 // 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/autocomplete/autocomplete_controller.h"
 
 #include <set>
 #include <string>
 
+#include "base/command_line.h"
 #include "base/format_macros.h"
 #include "base/logging.h"
 #include "base/metrics/histogram.h"
 #include "base/string_number_conversions.h"
 #include "base/stringprintf.h"
 #include "base/time.h"
 #include "chrome/browser/autocomplete/autocomplete_controller_delegate.h"
 #include "chrome/browser/autocomplete/builtin_provider.h"
 #include "chrome/browser/autocomplete/extension_app_provider.h"
 #include "chrome/browser/autocomplete/history_contents_provider.h"
 #include "chrome/browser/autocomplete/history_quick_provider.h"
 #include "chrome/browser/autocomplete/history_url_provider.h"
 #include "chrome/browser/autocomplete/keyword_provider.h"
 #include "chrome/browser/autocomplete/search_provider.h"
 #include "chrome/browser/autocomplete/shortcuts_provider.h"
+#include "chrome/browser/autocomplete/zero_suggest_provider.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/common/chrome_notification_types.h"
+#include "chrome/common/chrome_switches.h"
 #include "content/public/browser/notification_service.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
 namespace {
 
 // Converts the given type to an integer based on the AQS specification.
 // For more details, See http://goto.google.com/binary-clients-logging .
 int AutocompleteMatchToAssistedQueryType(const AutocompleteMatch::Type& type) {
@@ skipping 31 matching lines @@
 
 }  // namespace
 
 const int AutocompleteController::kNoItemSelected = -1;
 
 AutocompleteController::AutocompleteController(
     Profile* profile,
     AutocompleteControllerDelegate* delegate)
     : delegate_(delegate),
       keyword_provider_(NULL),
+      zero_suggest_provider_(NULL),
       done_(true),
       in_start_(false),
+      in_zero_suggest_(false),
       profile_(profile) {
   search_provider_ = new SearchProvider(this, profile);
   providers_.push_back(search_provider_);
 #if !defined(OS_ANDROID)
   // History quick provider is enabled on all platforms other than Android.
   bool hqp_enabled = true;
   providers_.push_back(new HistoryQuickProvider(this, profile));
   // Search provider/"tab to search" is enabled on all platforms other than
   // Android.
   keyword_provider_ = new KeywordProvider(this, profile);
   providers_.push_back(keyword_provider_);
 #else
   // TODO(mrossetti): Remove the following and permanently modify the
   // HistoryURLProvider to not search titles once HQP is turned on permanently.
   // TODO(jcivelli): Enable the History Quick Provider and figure out why it
   // reports the wrong results for some pages.
   bool hqp_enabled = false;
 #endif  // !OS_ANDROID
   providers_.push_back(new HistoryURLProvider(this, profile));
   providers_.push_back(new ShortcutsProvider(this, profile));
   providers_.push_back(new HistoryContentsProvider(this, profile, hqp_enabled));
   providers_.push_back(new BuiltinProvider(this, profile));
   providers_.push_back(new ExtensionAppProvider(this, profile));
+  // Create ZeroSuggest if its switch is present.
+  CommandLine* cl = CommandLine::ForCurrentProcess();
+  if (cl->HasSwitch(switches::kExperimentalZeroSuggestURLPrefix)) {
+    zero_suggest_provider_ = new ZeroSuggestProvider(this, profile,
+        cl->GetSwitchValueASCII(switches::kExperimentalZeroSuggestURLPrefix));
+    providers_.push_back(zero_suggest_provider_);
+  }
   for (ACProviders::iterator i(providers_.begin()); i != providers_.end(); ++i)
     (*i)->AddRef();
 }
 
 AutocompleteController::~AutocompleteController() {
   // The providers may have tasks outstanding that hold refs to them.  We need
   // to ensure they won't call us back if they outlive us.  (Practically,
   // calling Stop() should also cancel those tasks and make it so that we hold
   // the only refs.)  We also don't want to bother notifying anyone of our
   // result changes here, because the notification observer is in the midst of
@@ skipping 28 matching lines @@
   // get matches back more quickly).  Taking advantage of this reduces flicker.
   //
   // NOTE: This comes after constructing |input_| above since that construction
   // can change the text string (e.g. by stripping off a leading '?').
   const bool minimal_changes = (input_.text() == old_input_text) &&
       (input_.matches_requested() == old_matches_requested);
 
   expire_timer_.Stop();
 
   // Start the new query.
+  in_zero_suggest_ = false;
   in_start_ = true;
   base::TimeTicks start_time = base::TimeTicks::Now();
   for (ACProviders::iterator i(providers_.begin()); i != providers_.end();
        ++i) {
     (*i)->Start(input_, minimal_changes);
     if (matches_requested != AutocompleteInput::ALL_MATCHES)
       DCHECK((*i)->done());
   }
   if (matches_requested == AutocompleteInput::ALL_MATCHES &&
       (text.length() < 6)) {
@@ skipping 20 matching lines @@
   expire_timer_.Stop();
   done_ = true;
   if (clear_result && !result_.empty()) {
     result_.Reset();
     // NOTE: We pass in false since we're trying to only clear the popup, not
     // touch the edit... this is all a mess and should be cleaned up :(
     NotifyChanged(false);
   }
 }
 
+void AutocompleteController::StartZeroSuggest(
+    const GURL& url,
+    const string16& user_text) {
+  if (zero_suggest_provider_ != NULL) {
+    DCHECK(!in_start_);  // We should not be already running a query.
+    in_zero_suggest_ = true;
+    zero_suggest_provider_->StartZeroSuggest(url, user_text);
+  }
+}
+
+void AutocompleteController::StopZeroSuggest() {
+  if (zero_suggest_provider_ != NULL) {
+    DCHECK(!in_start_);  // We should not be already running a query.
+    zero_suggest_provider_->Stop(false);
+  }
+}
+
 void AutocompleteController::DeleteMatch(const AutocompleteMatch& match) {
   DCHECK(match.deletable);
   match.provider->DeleteMatch(match);  // This may synchronously call back to
                                        // OnProviderUpdate().
   // If DeleteMatch resulted in a callback to OnProviderUpdate and we're
   // not done, we might attempt to redisplay the deleted match. Make sure
   // we aren't displaying it by removing any old entries.
   ExpireCopiedEntries();
 }
 
 void AutocompleteController::ExpireCopiedEntries() {
   // Clear out the results. This ensures no results from the previous result set
   // are copied over.
   result_.Reset();
   // We allow matches from the previous result set to starve out matches from
   // the new result set. This means in order to expire matches we have to query
   // the providers again.
   UpdateResult(false);
 }
 
 void AutocompleteController::OnProviderUpdate(bool updated_matches) {
-  CheckIfDone();
-  // Multiple providers may provide synchronous results, so we only update the
-  // results if we're not in Start().
-  if (!in_start_ && (updated_matches || done_))
-    UpdateResult(false);
+  if (in_zero_suggest_) {
+    // We got ZeroSuggest results before Start(). Show only those results,
+    // because results from other providers are stale.
+    result_.Reset();
+    result_.AppendMatches(zero_suggest_provider_->matches());
+    result_.SortAndCull(input_);
+    NotifyChanged(true);
+  } else {
+    CheckIfDone();
+    // Multiple providers may provide synchronous results, so we only update the
+    // results if we're not in Start().
+    if (!in_start_ && (updated_matches || done_))
+      UpdateResult(false);
+  }
 }
 
 void AutocompleteController::AddProvidersInfo(
     ProvidersInfo* provider_info) const {
   provider_info->clear();
   for (ACProviders::const_iterator i(providers_.begin()); i != providers_.end();
        ++i) {
     // Add per-provider info, if any.
     (*i)->AddProviderInfo(provider_info);
 
@@ skipping 172 matching lines @@
   }
   done_ = true;
 }
 
 void AutocompleteController::StartExpireTimer() {
   if (result_.HasCopiedMatches())
     expire_timer_.Start(FROM_HERE,
                         base::TimeDelta::FromMilliseconds(kExpireTimeMS),
                         this, &AutocompleteController::ExpireCopiedEntries);
 }