Add support for matching query parameters in URLMatcher

components/url_matcher/url_matcher.cc

 // Copyright 2013 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 "components/url_matcher/url_matcher.h"
 
 #include <algorithm>
 #include <iterator>
 
 #include "base/logging.h"
@@ skipping 178 matching lines @@
   return false;
 }
 
 bool URLMatcherCondition::IsFullURLCondition() const {
   // For these criteria the SubstringMatcher needs to be executed on the
   // GURL that is canonicalized with
   // URLMatcherConditionFactory::CanonicalizeURLForFullSearches.
   switch (criterion_) {
     case HOST_CONTAINS:
     case PATH_CONTAINS:
-    case QUERY_CONTAINS:
     case URL_PREFIX:
     case URL_SUFFIX:
     case URL_CONTAINS:
     case URL_EQUALS:
       return true;
     default:
       break;
   }
   return false;
 }
 
 bool URLMatcherCondition::IsRegexCondition() const {
   return IsRegexCriterion(criterion_);
 }
 
 bool URLMatcherCondition::IsOriginAndPathRegexCondition() const {
   return IsOriginAndPathRegexCriterion(criterion_);
 }
 
 bool URLMatcherCondition::IsMatch(
     const std::set<StringPattern::ID>& matching_patterns,
     const GURL& url) const {
   DCHECK(string_pattern_);
   if (!ContainsKey(matching_patterns, string_pattern_->id()))
     return false;
-  // The criteria HOST_CONTAINS, PATH_CONTAINS, QUERY_CONTAINS are based on
-  // a substring match on the raw URL. In case of a match, we need to verify
-  // that the match was found in the correct component of the URL.
+  // The criteria HOST_CONTAINS, PATH_CONTAINS are based on a substring match on
+  // the raw URL. In case of a match, we need to verify that the match was found
+  // in the correct component of the URL.
   switch (criterion_) {
     case HOST_CONTAINS:
       return url.host().find(string_pattern_->pattern()) !=
           std::string::npos;
     case PATH_CONTAINS:
       return url.path().find(string_pattern_->pattern()) !=
           std::string::npos;
-    case QUERY_CONTAINS:
-      return url.query().find(string_pattern_->pattern()) !=
-          std::string::npos;
     default:
       break;
   }
   return true;
 }
 
 //
 // URLMatcherConditionFactory
 //
 
 namespace {
 // These are symbols that are not contained in 7-bit ASCII used in GURLs.
 const char kBeginningOfURL[] = {static_cast<char>(-1), 0};
 const char kEndOfDomain[] = {static_cast<char>(-2), 0};
 const char kEndOfPath[] = {static_cast<char>(-3), 0};
-const char kEndOfURL[] = {static_cast<char>(-4), 0};
+const char kBeginningOfQueryComponent[] = {static_cast<char>(-4), 0};
+const char kEndOfURL[] = {static_cast<char>(-5), 0};
+const char kQuerySeperator = '&';
+
+std::string PrepareQuery(std::string query, bool prepend_query_start = true) {

[battre, 2014/04/01 08:23:00]

Please add a description of the function.

Please add a comment and describe that you intentionally pass |query| via the
stack instead of a const-ref.

I think that prepend_query_start is not an adequate description of what the
parameter does. How about prepend_beginning_of_query_component?

[Joao da Silva, 2014/04/01 09:18:47]

Default parameters are not allowed by the style guide:

http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Default_Arguments

[battre, 2014/04/01 09:29:40]

I thought so as well and then removed the comment. They are allowed for
functions in the anonymous namespace.

[kaliamoorthi, 2014/04/01 13:11:17]

Done.

[kaliamoorthi, 2014/04/01 13:11:17]

I have removed the default parameter anyway.

+  for (std::string::iterator it = query.begin(); it != query.end(); ++it) {
+    if (*it == kQuerySeperator)
+      *it = kBeginningOfQueryComponent[0];
+  }
+  return prepend_query_start ? kBeginningOfQueryComponent + query : query;
+}
 }  // namespace
 
 URLMatcherConditionFactory::URLMatcherConditionFactory() : id_counter_(0) {}
 
 URLMatcherConditionFactory::~URLMatcherConditionFactory() {
   STLDeleteElements(&substring_pattern_singletons_);
   STLDeleteElements(&regex_pattern_singletons_);
   STLDeleteElements(&origin_and_path_regex_pattern_singletons_);
 }
 
 std::string URLMatcherConditionFactory::CanonicalizeURLForComponentSearches(
     const GURL& url) const {
   return kBeginningOfURL + CanonicalizeHostname(url.host()) + kEndOfDomain +
          url.path() + kEndOfPath +
-         (url.has_query() ? "?" + url.query() : std::string()) + kEndOfURL;
+         (url.has_query() ? PrepareQuery(url.query()) : std::string()) +
+         kEndOfURL;
 }
 
 URLMatcherCondition URLMatcherConditionFactory::CreateHostPrefixCondition(
     const std::string& prefix) {
   return CreateCondition(URLMatcherCondition::HOST_PREFIX,
       kBeginningOfURL + CanonicalizeHostname(prefix));
 }
 
 URLMatcherCondition URLMatcherConditionFactory::CreateHostSuffixCondition(
     const std::string& suffix) {
@@ skipping 30 matching lines @@
 
 URLMatcherCondition URLMatcherConditionFactory::CreatePathEqualsCondition(
     const std::string& str) {
   return CreateCondition(URLMatcherCondition::PATH_EQUALS,
       kEndOfDomain + str + kEndOfPath);
 }
 
 URLMatcherCondition URLMatcherConditionFactory::CreateQueryPrefixCondition(
     const std::string& prefix) {
   std::string pattern;
-  if (!prefix.empty() && prefix[0] == '?')
-    pattern = kEndOfPath + prefix;
-  else
-    pattern = kEndOfPath + ('?' + prefix);
+  pattern =

[battre, 2014/04/01 08:23:00]

Either the assignment should become part of the constructor, or we we may
re-introduce the if statement. I think the latter may help for readability.

[kaliamoorthi, 2014/04/01 13:11:17]

I have reintroduced the if else.

+      kEndOfPath + PrepareQuery((!prefix.empty() && prefix[0] == '?')
+                                    ? prefix.substr(1, prefix.length() - 1)

[battre, 2014/04/01 08:23:00]

nit: prefix.substr(1) should be sufficient, right?

[kaliamoorthi, 2014/04/01 13:11:17]

That simplifies the expression. Fixed it.

+                                    : prefix);
 
   return CreateCondition(URLMatcherCondition::QUERY_PREFIX, pattern);
 }
 
 URLMatcherCondition URLMatcherConditionFactory::CreateQuerySuffixCondition(
     const std::string& suffix) {
   if (!suffix.empty() && suffix[0] == '?') {
     return CreateQueryEqualsCondition(suffix);
   } else {
     return CreateCondition(URLMatcherCondition::QUERY_SUFFIX,
-                           suffix + kEndOfURL);
+                           PrepareQuery(suffix, false) + kEndOfURL);
   }
 }
 
 URLMatcherCondition URLMatcherConditionFactory::CreateQueryContainsCondition(
     const std::string& str) {
-  if (!str.empty() && str[0] == '?')
-    return CreateQueryPrefixCondition(str);
-  else
-    return CreateCondition(URLMatcherCondition::QUERY_CONTAINS, str);
+  std::string query_condition;
+  query_condition =
+      (!str.empty() && str[0] == '?') ? str.substr(1, str.length() - 1) : str;

[battre, 2014/04/01 08:23:00]

Can you re-introduce the if statement (also below)? I think that is easier to
read.

[kaliamoorthi, 2014/04/01 13:11:17]

Done.

+  return CreateCondition(URLMatcherCondition::QUERY_CONTAINS,
+                         PrepareQuery(query_condition));
 }
 
 URLMatcherCondition URLMatcherConditionFactory::CreateQueryEqualsCondition(
     const std::string& str) {
   std::string pattern;
-  if (!str.empty() && str[0] == '?')
-    pattern = kEndOfPath + str + kEndOfURL;
-  else
-    pattern = kEndOfPath + ('?' + str) + kEndOfURL;
+  pattern = kEndOfPath + PrepareQuery((!str.empty() && str[0] == '?')
+                                          ? str.substr(1, str.length() - 1)
+                                          : str) +
+            kEndOfURL;
 
   return CreateCondition(URLMatcherCondition::QUERY_EQUALS, pattern);
 }
 
 URLMatcherCondition
     URLMatcherConditionFactory::CreateHostSuffixPathPrefixCondition(
     const std::string& host_suffix,
     const std::string& path_prefix) {
   return CreateCondition(URLMatcherCondition::HOST_SUFFIX_PATH_PREFIX,
       host_suffix + kEndOfDomain + path_prefix);
@@ skipping 509 matching lines @@
 
 void URLMatcher::UpdateInternalDatastructures() {
   UpdateSubstringSetMatcher(false);
   UpdateSubstringSetMatcher(true);
   UpdateRegexSetMatcher();
   UpdateTriggers();
   UpdateConditionFactory();
 }
 
 }  // namespace url_matcher