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>
 
 #include "base/gtest_prod_util.h"
 #include "base/time.h"
 #include "chrome/browser/search_engines/template_url_id.h"
 #include "googleurl/src/gurl.h"
 
 class Profile;
 class SearchTermsData;
 class TemplateURL;
 
 
+// SearchTermsArgs ------------------------------------------------------------

[Peter Kasting, 2012/06/16 03:14:17]

Nit: While I'm loathe to spoil the simplicity of the "SearchTermsArgs(...)"
calls you've changed to everywhere else, I think this should be a member class
of TemplateURLRef.  This would serve to namespace it, which seems good (the name
"SearchTermsArgs" is a bit generic to be floating in the global namespace, not
that we don't have the same problem many other places...)

It also emphasizes that it's sort of an implementation detail of how
TemplateURLRef does search term construction.

[Bart N, 2012/06/16 23:38:10]

Yes. I also think it makes more sense.

+
+// 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;
+  // Teh optional query stats, aka AQS, used for logging purposes.

[Peter Kasting, 2012/06/16 03:14:17]

Nit: Teh->The

[Bart N, 2012/06/16 23:38:10]

Done.

+  string16 assisted_query_stats;

[Peter Kasting, 2012/06/16 03:14:17]

Use a std::string here.  This isn't a UI string, and it's both created and
ultimately used as a UTF-8 string, so converting to and from UTF-16 is just a
waste.

[Bart N, 2012/06/16 23:38:10]

Done.

+
+  // TODO: Remove along with "aq" CGI param.
+  int accepted_suggestion;
+};
+
 // TemplateURLRef -------------------------------------------------------------
 
 // A TemplateURLRef represents a single URL within the larger TemplateURL class
 // (which represents an entire "search engine", see below).  If
 // SupportsReplacement() is true, this URL has placeholders in it, for which
 // callers can substitute values to get a "real" URL using ReplaceSearchTerms().
 //
 // TemplateURLRefs always have a non-NULL |owner_| TemplateURL, which they
 // access in order to get at important data like the underlying URL string or
 // the associated Profile.
@@ skipping 23 matching lines @@
   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_