A working implementation of AQS (Assisted Query Stats).

chrome/browser/search_engines/template_url.h

 // 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.
 
 #ifndef CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_
 #define CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 30 matching lines @@
   };
 
   // Which kind of URL within our owner we are.  This allows us to get at the
   // correct string field.
   enum Type {
     SEARCH,
     SUGGEST,
     INSTANT,
   };
 
+  // This struct encapsulates arguments passed to
+  // TemplateURLRef::ReplaceSearchTerms methods.  By default, only search_terms
+  // is required and is passed in the constructor.
+  struct SearchTermsArgs {
+    explicit SearchTermsArgs(const string16& search_terms);
+
+    // The search terms (query).
+    const string16 search_terms;
+    // The original (input) query.
+    string16 original_query;
+    // The optional assisted query stats, aka AQS, used for logging purposes.
+    // This string contains impressions of all autocomplete matches shown
+    // at the query submission time.  For privacy reasons, we require the
+    // search provider to support HTTPS protocol in order to receive the AQS
+    // param.
+    // For more details, see http://goto.google.com/binary-clients-logging .
+    std::string assisted_query_stats;
+
+    // TODO: Remove along with "aq" CGI param.
+    int accepted_suggestion;
+  };
+
   TemplateURLRef(TemplateURL* owner, Type type);
   ~TemplateURLRef();
 
   // Returns the raw URL. None of the parameters will have been replaced.
   std::string GetURL() const;
 
   // Returns true if this URL supports replacement.
   bool SupportsReplacement() const;
 
   // Like SupportsReplacement but usable on threads other than the UI thread.
   bool SupportsReplacementUsingTermsData(
       const SearchTermsData& search_terms_data) const;
 
   // Returns a string that is the result of replacing the search terms in
-  // the url with the specified value.  We use our owner's input encoding.
+  // the url with the specified arguments.  We use our owner's input encoding.
   //
   // If this TemplateURLRef does not support replacement (SupportsReplacement
   // returns false), an empty string is returned.
   std::string ReplaceSearchTerms(
-      const string16& terms,
-      int accepted_suggestion,
-      const string16& original_query_for_suggestion) const;
+      const SearchTermsArgs& search_terms_args) const;
 
   // Just like ReplaceSearchTerms except that it takes SearchTermsData to supply
   // the data for some search terms. Most of the time ReplaceSearchTerms should
   // be called.
   std::string ReplaceSearchTermsUsingTermsData(
-      const string16& terms,
-      int accepted_suggestion,
-      const string16& original_query_for_suggestion,
+      const SearchTermsArgs& search_terms_args,
       const SearchTermsData& search_terms_data) const;
 
   // Returns true if the TemplateURLRef is valid. An invalid TemplateURLRef is
   // one that contains unknown terms, or invalid characters.
   bool IsValid() const;
 
   // Like IsValid but usable on threads other than the UI thread.
   bool IsValidUsingTermsData(const SearchTermsData& search_terms_data) const;
 
   // Returns a string representation of this TemplateURLRef suitable for
@@ skipping 28 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseURLEmpty);
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseURLNoTemplateEnd);
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseURLNoKnownParameters);
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseURLTwoParameters);
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseURLNestedParameter);
 
   // Enumeration of the known types.
   enum ReplacementType {
     ENCODING,
     GOOGLE_ACCEPTED_SUGGESTION,
+    GOOGLE_ASSISTED_QUERY_STATS,
     GOOGLE_BASE_URL,
     GOOGLE_BASE_SUGGEST_URL,
     GOOGLE_INSTANT_ENABLED,
     GOOGLE_ORIGINAL_QUERY_FOR_SUGGESTION,
     GOOGLE_RLZ,
     GOOGLE_SEARCH_FIELDTRIAL_GROUP,
     GOOGLE_UNESCAPED_SEARCH_TERMS,
     LANGUAGE,
     SEARCH_TERMS,
   };
@@ skipping 285 matching lines @@
   TemplateURLRef url_ref_;
   TemplateURLRef suggestions_url_ref_;
   TemplateURLRef instant_url_ref_;
 
   // TODO(sky): Add date last parsed OSD file.
 
   DISALLOW_COPY_AND_ASSIGN(TemplateURL);
 };
 
 #endif  // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_