Support inexact path matching when extracting terms from Template URL.

components/search_engines/template_url.h

 // Copyright 2014 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 COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_H_
 #define COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_H_
 
 #include <stddef.h>
 
 #include <memory>
@@ skipping 237 matching lines @@
 
   // Converts a string as returned by DisplayURL back into a string as
   // understood by TemplateURLRef.
   static std::string DisplayURLToURLRef(const base::string16& display_url);
 
   // If this TemplateURLRef is valid and contains one search term, this returns
   // the host/path of the URL, otherwise this returns an empty string.
   const std::string& GetHost(const SearchTermsData& search_terms_data) const;
   const std::string& GetPath(const SearchTermsData& search_terms_data) const;
 
+  // If this TemplateURLRef is valid and contains one search term, this returns
+  // whether its path ends with text "{google:ignorePathEnding}", otherwise this
+  // returns false.
+  bool GetIgnorePathEnding(const SearchTermsData& search_terms_data) const;
+
   // If this TemplateURLRef is valid and contains one search term
   // in its query or ref, this returns the key of the search term,
   // otherwise this returns an empty string.
   const std::string& GetSearchTermKey(
       const SearchTermsData& search_terms_data) const;
 
-  // If this TemplateURLRef is valid and contains one search term
-  // in its path, this returns the length of the subpath before the search term,
-  // otherwise this returns std::string::npos.
-  size_t GetSearchTermPositionInPath(
-      const SearchTermsData& search_terms_data) const;
-
   // If this TemplateURLRef is valid and contains one search term,
   // this returns the location of the search term,
   // otherwise this returns url::Parsed::QUERY.
   url::Parsed::ComponentType GetSearchTermKeyLocation(
       const SearchTermsData& search_terms_data) const;
 
+  // If this TemplateURLRef is valid and contains one search term,
+  // this returns the fixed prefix of the value of the search term,
+  // otherwise this returns an empty string.
+  const std::string& GetSearchTermValuePrefix(
+      const SearchTermsData& search_terms_data) const;
+
+  // If this TemplateURLRef is valid and contains one search term,
+  // this returns the fixed suffix of the value of the search term,
+  // otherwise this returns an empty string.
+  const std::string& GetSearchTermValueSuffix(
+      const SearchTermsData& search_terms_data) const;
+
   // Converts the specified term in our owner's encoding to a base::string16.
   base::string16 SearchTermToString16(const std::string& term) const;
 
   // Returns true if this TemplateURLRef has a replacement term of
   // {google:baseURL} or {google:baseSuggestURL}.
   bool HasGoogleBaseURLs(const SearchTermsData& search_terms_data) const;
 
   // Use the pattern referred to by this TemplateURLRef to match the provided
   // |url| and extract |search_terms| from it. Returns true if the pattern
   // matches, even if |search_terms| is empty. In this case
@@ skipping 76 matching lines @@
   struct PostParam {
     std::string name;
     std::string value;
     std::string content_type;
   };
 
   // The list of elements to replace.
   typedef std::vector<struct Replacement> Replacements;
   typedef std::vector<PostParam> PostParams;
 
+  // Checks that |path| matches to this TemplateURLRef's path.
+  // This is a helper function for extracting search terms from URL.
+  bool MatchPath(const std::string& path) const;
+
+  // Checks that |path| matches to this TemplateURLRef's path and
+  // extracts the position of the search terms inside |path|.
+  // This is a helper function for extracting search terms from URL.
+  bool MatchPathWithSearchTerms(const std::string& path,
+                                url::Component* search_terms_position) const;
+
   // TemplateURLRef internally caches values to make replacement quick. This
   // method invalidates any cached values.
   void InvalidateCachedValues() const;
 
   // Parses the parameter in url at the specified offset. start/end specify the
   // range of the parameter in the url, including the braces. If the parameter
   // is valid, url is updated to reflect the appropriate parameter. If
   // the parameter is one of the known parameters an element is added to
   // replacements indicating the type and range of the element. The original
   // parameter is erased from the url.
@@ skipping 75 matching lines @@
 
   // The replaceable parts of url (parsed_url_). These are ordered by index
   // into the string, and may be empty.
   mutable Replacements replacements_;
 
   // Host, port, path, key and location of the search term. These are only set
   // if the url contains one search term.
   mutable std::string host_;
   mutable std::string port_;
   mutable std::string path_;
+  mutable bool ignore_path_ending_;
   mutable std::string search_term_key_;
-  mutable size_t search_term_position_in_path_;
   mutable url::Parsed::ComponentType search_term_key_location_;
   mutable std::string search_term_value_prefix_;
   mutable std::string search_term_value_suffix_;
 
   mutable PostParams post_params_;
 
   // Whether the contained URL is a pre-populated URL.
   bool prepopulated_;
 };
 
@@ skipping 269 matching lines @@
   TemplateURLRef new_tab_url_ref_;
   TemplateURLRef contextual_search_url_ref_;
   std::unique_ptr<AssociatedExtensionInfo> extension_info_;
 
   // TODO(sky): Add date last parsed OSD file.
 
   DISALLOW_COPY_AND_ASSIGN(TemplateURL);
 };
 
 #endif  // COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_H_