Add contextual search to the template url system

chrome/browser/search_engines/template_url.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/search_engines/template_url.h"
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
@@ skipping 84 matching lines @@
     "google:unescapedSearchTerms";
 const char kGoogleUnescapedSearchTermsParameterFull[] =
     "{google:unescapedSearchTerms}";
 
 const char kGoogleImageSearchSource[] = "google:imageSearchSource";
 const char kGoogleImageThumbnailParameter[] = "google:imageThumbnail";
 const char kGoogleImageURLParameter[] = "google:imageURL";
 const char kGoogleImageOriginalWidth[] = "google:imageOriginalWidth";
 const char kGoogleImageOriginalHeight[] = "google:imageOriginalHeight";
 
+// Contextual search parameters.

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

Nit: It seems like these and the image search constants just above should be
rolled into the larger alphabetized list above them.

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

Done.

+const char kGoogleContextualSearchVersion[] = "google:contextualSearchVersion";
+const char kGoogleContextualSearchContextData[] =
+    "google:contextualSearchContextData";
+
 // Display value for kSearchTermsParameter.
 const char kDisplaySearchTerms[] = "%s";
 
 // Display value for kGoogleUnescapedSearchTermsParameter.
 const char kDisplayUnescapedSearchTerms[] = "%S";
 
 // Used if the count parameter is not optional. Indicates we want 10 search
 // results.
 const char kDefaultCount[] = "10";
 
@@ skipping 86 matching lines @@
 TemplateURLRef::SearchTermsArgs::SearchTermsArgs(
     const base::string16& search_terms)
     : search_terms(search_terms),
       accepted_suggestion(NO_SUGGESTIONS_AVAILABLE),
       cursor_position(base::string16::npos),
       omnibox_start_margin(-1),
       page_classification(AutocompleteInput::INVALID_SPEC),
       bookmark_bar_pinned(false),
       append_extra_query_params(false),
       force_instant_results(false),
-      from_app_list(false) {
+      from_app_list(false),
+      contextual_search_params(ContextualSearchParams()) {
 }
 
 TemplateURLRef::SearchTermsArgs::~SearchTermsArgs() {
 }
 
+TemplateURLRef::SearchTermsArgs::ContextualSearchParams::
+    ContextualSearchParams()
+    : version(-1),
+      start(base::string16::npos),
+      end(base::string16::npos) {
+}
 
 // TemplateURLRef -------------------------------------------------------------
 
 TemplateURLRef::TemplateURLRef(TemplateURL* owner, Type type)
     : owner_(owner),
       type_(type),
       index_in_owner_(-1),
       parsed_(false),
       valid_(false),
       supports_replacements_(false),
@@ skipping 16 matching lines @@
       showing_search_terms_(ShowingSearchTermsOnSRP()) {
   DCHECK(owner_);
   DCHECK_LT(index_in_owner_, owner_->URLCount());
 }
 
 TemplateURLRef::~TemplateURLRef() {
 }
 
 std::string TemplateURLRef::GetURL() const {
   switch (type_) {
-    case SEARCH:  return owner_->url();
-    case SUGGEST: return owner_->suggestions_url();
-    case INSTANT: return owner_->instant_url();
-    case IMAGE:   return owner_->image_url();
-    case NEW_TAB: return owner_->new_tab_url();
-    case INDEXED: return owner_->GetURL(index_in_owner_);
-    default:      NOTREACHED(); return std::string();  // NOLINT
+    case SEARCH:            return owner_->url();
+    case SUGGEST:           return owner_->suggestions_url();
+    case INSTANT:           return owner_->instant_url();
+    case IMAGE:             return owner_->image_url();
+    case NEW_TAB:           return owner_->new_tab_url();
+    case CONTEXTUAL_SEARCH: return owner_->contextual_search_url();
+    case INDEXED:           return owner_->GetURL(index_in_owner_);
+    default:       NOTREACHED(); return std::string();  // NOLINT
   }
 }
 
 std::string TemplateURLRef::GetPostParamsString() const {
   switch (type_) {
     case INDEXED:
-    case SEARCH:  return owner_->search_url_post_params();
-    case SUGGEST: return owner_->suggestions_url_post_params();
-    case INSTANT: return owner_->instant_url_post_params();
-    case NEW_TAB: return std::string();
-    case IMAGE:   return owner_->image_url_post_params();
+    case SEARCH:            return owner_->search_url_post_params();
+    case SUGGEST:           return owner_->suggestions_url_post_params();
+    case INSTANT:           return owner_->instant_url_post_params();
+    case NEW_TAB:           return std::string();
+    case CONTEXTUAL_SEARCH: return std::string();
+    case IMAGE:             return owner_->image_url_post_params();
     default:      NOTREACHED(); return std::string();  // NOLINT
   }
 }
 
 bool TemplateURLRef::UsesPOSTMethodUsingTermsData(
     const SearchTermsData* search_terms_data) const {
   if (search_terms_data)
     ParseIfNecessaryUsingTermsData(*search_terms_data);
   else
     ParseIfNecessary();
@@ skipping 303 matching lines @@
     replacements->push_back(Replacement(GOOGLE_FORCE_INSTANT_RESULTS, start));
   } else if (parameter == kGoogleInstantExtendedEnabledParameter) {
     replacements->push_back(Replacement(GOOGLE_INSTANT_EXTENDED_ENABLED,
                                         start));
   } else if (parameter == kGoogleInstantExtendedEnabledKey) {
     url->insert(start, google_util::kInstantExtendedAPIParam);
   } else if (parameter == kGoogleNTPIsThemedParameter) {
     replacements->push_back(Replacement(GOOGLE_NTP_IS_THEMED, start));
   } else if (parameter == kGoogleOmniboxStartMarginParameter) {
     replacements->push_back(Replacement(GOOGLE_OMNIBOX_START_MARGIN, start));
+  } else if (parameter == kGoogleContextualSearchVersion) {
+    replacements->push_back(
+        Replacement(GOOGLE_CONTEXTUAL_SEARCH_VERSION, start));
+  } else if (parameter == kGoogleContextualSearchContextData) {
+    replacements->push_back(
+        Replacement(GOOGLE_CONTEXTUAL_SEARCH_CONTEXT_DATA, start));
   } else if (parameter == kGoogleOriginalQueryForSuggestionParameter) {
     replacements->push_back(Replacement(GOOGLE_ORIGINAL_QUERY_FOR_SUGGESTION,
                                         start));
   } else if (parameter == kGooglePageClassificationParameter) {
     replacements->push_back(Replacement(GOOGLE_PAGE_CLASSIFICATION, start));
   } else if (parameter == kGoogleRLZParameter) {
     replacements->push_back(Replacement(GOOGLE_RLZ, start));
   } else if (parameter == kGoogleSearchClient) {
     replacements->push_back(Replacement(GOOGLE_SEARCH_CLIENT, start));
   } else if (parameter == kGoogleSearchFieldtrialParameter) {
@@ skipping 316 matching lines @@
         DCHECK(!i->is_post_param);
         if (search_terms_args.omnibox_start_margin >= 0) {
           HandleReplacement(
               "es_sm",
               base::IntToString(search_terms_args.omnibox_start_margin),
               *i,
               &url);
         }
         break;
 
+      case GOOGLE_CONTEXTUAL_SEARCH_VERSION:
+        if (search_terms_args.contextual_search_params.version >= 0) {
+          HandleReplacement(
+              "ctxs",
+              base::IntToString(
+                  search_terms_args.contextual_search_params.version),
+              *i,
+              &url);
+        }
+        break;
+
+      case GOOGLE_CONTEXTUAL_SEARCH_CONTEXT_DATA: {
+        DCHECK(!i->is_post_param);
+        std::string context_data;
+
+        if (search_terms_args.contextual_search_params.start !=

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

Nit: If above all these you do something like this:

  const ContextualSearchParams& params =
      search_terms_args.contextual_search_params;

Then you can use "params.<member>" everywhere below, reducing wordiness and
allowing you to eliminate the "const std::string" temps that you create just to
shorten the names.

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

Done.

+            std::string::npos) {
+          context_data.append("ctxs_start=" + base::IntToString(
+              search_terms_args.contextual_search_params.start) + "&");
+        }
+
+        if (search_terms_args.contextual_search_params.end !=
+            std::string::npos) {
+          context_data.append("ctxs_end=" + base::IntToString(
+              search_terms_args.contextual_search_params.end) + "&");
+        }
+
+        const std::string selection =
+            search_terms_args.contextual_search_params.selection;
+        if (!selection.empty())
+          context_data.append("q=" + selection + "&");
+
+        const std::string content =
+            search_terms_args.contextual_search_params.content;
+        if (!content.empty())
+          context_data.append("ctxs_content=" + content + "&");
+
+        const std::string base_page_url =
+            search_terms_args.contextual_search_params.base_page_url;
+        if (!base_page_url.empty())
+          context_data.append("ctxs_url=" + base_page_url + "&");
+
+        const std::string encoding =
+            search_terms_args.contextual_search_params.encoding;
+        if (!encoding.empty()) {
+          context_data.append("ctxs_encoding=" + encoding + "&");
+        }
+
+        HandleReplacement(std::string(), context_data, *i, &url);
+        break;
+      }
+
       case GOOGLE_ORIGINAL_QUERY_FOR_SUGGESTION:
         DCHECK(!i->is_post_param);
         if (search_terms_args.accepted_suggestion >= 0 ||
             !search_terms_args.assisted_query_stats.empty()) {
           HandleReplacement(
               "oq", base::UTF16ToUTF8(encoded_original_query), *i, &url);
         }
         break;
 
       case GOOGLE_PAGE_CLASSIFICATION:
@@ skipping 151 matching lines @@
 
 TemplateURL::TemplateURL(Profile* profile, const TemplateURLData& data)
     : profile_(profile),
       data_(data),
       url_ref_(this, TemplateURLRef::SEARCH),
       suggestions_url_ref_(this,
                            TemplateURLRef::SUGGEST),
       instant_url_ref_(this,
                        TemplateURLRef::INSTANT),
       image_url_ref_(this, TemplateURLRef::IMAGE),
-      new_tab_url_ref_(this, TemplateURLRef::NEW_TAB) {
+      new_tab_url_ref_(this, TemplateURLRef::NEW_TAB),
+      contextual_search_url_ref_(this, TemplateURLRef::CONTEXTUAL_SEARCH) {
   SetPrepopulateId(data_.prepopulate_id);
 
   if (data_.search_terms_replacement_key ==
       kGoogleInstantExtendedEnabledKeyFull) {
     data_.search_terms_replacement_key = google_util::kInstantExtendedAPIParam;
   }
 }
 
 TemplateURL::~TemplateURL() {
 }
@@ skipping 267 matching lines @@
       // patterns. This means that given patterns
       //    [ "http://foo/#q={searchTerms}", "http://foo/?q={searchTerms}" ],
       // calling ExtractSearchTermsFromURL() on "http://foo/?q=bar#q=' would
       // return false. This is important for at least Google, where such URLs
       // are invalid.
       return !search_terms->empty();
     }
   }
   return false;
 }