Add contextual search to the template url system

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_
 
 #include <string>
 #include <utility>
 #include <vector>
@@ skipping 35 matching lines @@
 
   // Which kind of URL within our owner we are.  This allows us to get at the
   // correct string field. Use |INDEXED| to indicate that the numerical
   // |index_in_owner_| should be used instead.
   enum Type {
     SEARCH,
     SUGGEST,
     INSTANT,
     IMAGE,
     NEW_TAB,
+    CONTEXTUAL_SEARCH,
     INDEXED
   };
 
   // Type to store <content_type, post_data> pair for POST URLs.
   // The |content_type|(first part of the pair) is the content-type of
   // the |post_data|(second part of the pair) which is encoded in
   // "multipart/form-data" format, it also contains the MIME boundary used in
   // the |post_data|. See http://tools.ietf.org/html/rfc2046 for the details.
   typedef std::pair<std::string, std::string> PostContent;
 
   // 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 base::string16& search_terms);
     ~SearchTermsArgs();
 
+    struct ContextualSearchParams {
+      ContextualSearchParams();
+
+      // The version of contextual search.
+      int version;
+
+      // Offset into content of the start of the user selection.

[Peter Kasting, 2014/06/06 17:51:33]

Nit: Should "content" be "the page content" everywhere?

[jeremycho, 2014/06/06 21:51:45]

Done.

+      size_t start;
+
+      // Offset into content of the end of the user selection.
+      size_t end;
+
+      // The user selection.
+      std::string selection;
+
+      // The text including and surrounding the user selection.
+      std::string content;
+
+      // The URL of the page containing the user selection.
+      std::string base_page_url;
+
+      // The encoding of content.
+      std::string encoding;
+    };
+
     // The search terms (query).
     base::string16 search_terms;
 
     // The original (input) query.
     base::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
@@ skipping 50 matching lines @@
 
     // If set, ReplaceSearchTerms() will append a param to the TemplateURLRef to
     // update the search results page incrementally even if that is otherwise
     // disabled by google.com preferences. See comments on
     // chrome::ForceInstantResultsParam().
     bool force_instant_results;
 
     // True if the search was made using the app list search box. Otherwise, the
     // search was made using the omnibox.
     bool from_app_list;
+
+    ContextualSearchParams contextual_search_params;
   };
 
   TemplateURLRef(TemplateURL* owner, Type type);
   TemplateURLRef(TemplateURL* owner, size_t index_in_owner);
   ~TemplateURLRef();
 
   // Returns the raw URL. None of the parameters will have been replaced.
   std::string GetURL() const;
 
   // Returns the raw string of the post params. Please see comments in
@@ skipping 111 matching lines @@
     GOOGLE_CURSOR_POSITION,
     GOOGLE_IMAGE_ORIGINAL_HEIGHT,
     GOOGLE_IMAGE_ORIGINAL_WIDTH,
     GOOGLE_IMAGE_SEARCH_SOURCE,
     GOOGLE_IMAGE_THUMBNAIL,
     GOOGLE_IMAGE_URL,
     GOOGLE_FORCE_INSTANT_RESULTS,
     GOOGLE_INSTANT_EXTENDED_ENABLED,
     GOOGLE_NTP_IS_THEMED,
     GOOGLE_OMNIBOX_START_MARGIN,
+    GOOGLE_CONTEXTUAL_SEARCH_VERSION,
+    GOOGLE_CONTEXTUAL_SEARCH_CONTEXT_DATA,

[Peter Kasting, 2014/06/06 17:51:33]

Nit: Should this just be named GOOGLE_CONTEXTUAL_SEARCH_PARAMS (and similarly
everywhere else)?  That would be both shorter and matching the struct name.  Or
maybe everything should be named "contextual search data" (i.e. drop "context")?

[jeremycho, 2014/06/06 21:51:45]

The struct also contains version, which is why I named this something else to
avoid associating the two.  "Context" was used since this data does relate to
the user's context (what they were looking at, etc).

     GOOGLE_ORIGINAL_QUERY_FOR_SUGGESTION,
     GOOGLE_PAGE_CLASSIFICATION,
     GOOGLE_RLZ,
     GOOGLE_SEARCH_CLIENT,
     GOOGLE_SEARCH_FIELDTRIAL_GROUP,
     GOOGLE_SESSION_TOKEN,
     GOOGLE_SUGGEST_CLIENT,
     GOOGLE_SUGGEST_REQUEST_ID,
     GOOGLE_UNESCAPED_SEARCH_TERMS,
     LANGUAGE,
@@ skipping 153 matching lines @@
   // The raw URL for the TemplateURL, which may not be valid as-is (e.g. because
   // it requires substitutions first).  This must be non-empty.
   void SetURL(const std::string& url);
   const std::string& url() const { return url_; }
 
   // Optional additional raw URLs.
   std::string suggestions_url;
   std::string instant_url;
   std::string image_url;
   std::string new_tab_url;
+  std::string contextual_search_url;
 
   // The following post_params are comma-separated lists used to specify the
   // post parameters for the corresponding URL.
   std::string search_url_post_params;
   std::string suggestions_url_post_params;
   std::string instant_url_post_params;
   std::string image_url_post_params;
 
   // Optional favicon for the TemplateURL.
   GURL favicon_url;
@@ skipping 127 matching lines @@
   // displayed even if it is LTR and the UI is RTL.
   base::string16 AdjustedShortNameForLocaleDirection() const;
 
   const base::string16& keyword() const { return data_.keyword(); }
 
   const std::string& url() const { return data_.url(); }
   const std::string& suggestions_url() const { return data_.suggestions_url; }
   const std::string& instant_url() const { return data_.instant_url; }
   const std::string& image_url() const { return data_.image_url; }
   const std::string& new_tab_url() const { return data_.new_tab_url; }
+  const std::string& contextual_search_url() const {
+    return data_.contextual_search_url;
+  }
   const std::string& search_url_post_params() const {
     return data_.search_url_post_params;
   }
   const std::string& suggestions_url_post_params() const {
     return data_.suggestions_url_post_params;
   }
   const std::string& instant_url_post_params() const {
     return data_.instant_url_post_params;
   }
   const std::string& image_url_post_params() const {
@@ skipping 35 matching lines @@
     return data_.search_terms_replacement_key;
   }
 
   const TemplateURLRef& url_ref() const { return url_ref_; }
   const TemplateURLRef& suggestions_url_ref() const {
     return suggestions_url_ref_;
   }
   const TemplateURLRef& instant_url_ref() const { return instant_url_ref_; }
   const TemplateURLRef& image_url_ref() const { return image_url_ref_; }
   const TemplateURLRef& new_tab_url_ref() const { return new_tab_url_ref_; }
+  const TemplateURLRef& contextual_search_url_ref() const {
+    return contextual_search_url_ref_;
+  }
 
   // Returns true if |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 true if any URLRefs use Googe base URLs.
   bool HasGoogleBaseURLs() const;
@@ skipping 110 matching lines @@
                             url::Parsed::ComponentType* search_terms_component,
                             url::Component* search_terms_position);
 
   Profile* profile_;
   TemplateURLData data_;
   TemplateURLRef url_ref_;
   TemplateURLRef suggestions_url_ref_;
   TemplateURLRef instant_url_ref_;
   TemplateURLRef image_url_ref_;
   TemplateURLRef new_tab_url_ref_;
+  TemplateURLRef contextual_search_url_ref_;
   scoped_ptr<AssociatedExtensionInfo> extension_info_;
 
   // TODO(sky): Add date last parsed OSD file.
 
   DISALLOW_COPY_AND_ASSIGN(TemplateURL);
 };
 
 #endif  // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_