Modify TemplateURLRef to remove unknown URL parameters, but only when it represents a prepopulate...

chrome/browser/search_engines/template_url.h

 // Copyright (c) 2011 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>
@@ skipping 117 matching lines @@
   // {google:baseURL} or {google:baseSuggestURL}.
   bool HasGoogleBaseURLs() const;
 
   // Returns true if both refs are NULL or have the same values.
   static bool SameUrlRefs(const TemplateURLRef* ref1,
                           const TemplateURLRef* ref2);
 
   // Collects metrics whether searches through Google are sent with RLZ string.
   void CollectRLZMetrics() const;
 
+  // Sets whether this URL is pre-populated or not.
+  void set_prepopulated(bool prepopulated) { prepopulated_ = prepopulated; }
+
  private:
   friend class SearchHostToURLsMapTest;
   friend class TemplateURL;
   friend class TemplateURLServiceTestUtil;
   friend class TemplateURLTest;
+  FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, SetPrepopulatedAndParse);
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseParameterKnown);
   FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseParameterUnknown);
-  FRIEND_TEST_ALL_PREFIXES(TemplateURLTest, ParseParameterReallyUnknown);
   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,
@@ skipping 24 matching lines @@
   // Resets the url.
   void Set(const std::string& url, int index_offset, int page_offset);
 
   // 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.
   //
-  // If the parameter is not a known parameter, it's not erased and false is
-  // returned.
+  // If the parameter is not a known parameter, false is returned. If this is a
+  // prepopulated URL, the parameter is erased, otherwise it is left alone.
   bool ParseParameter(size_t start,
                       size_t end,
                       std::string* url,
                       Replacements* replacements) const;
 
   // Parses the specified url, replacing parameters as necessary. If
   // successful, valid is set to true, and the parsed url is returned. For all
   // known parameters that are encountered an entry is added to replacements.
   // If there is an error parsing the url, valid is set to false, and an empty
   // string is returned.
@@ skipping 43 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, path and key of the search term. These are only set if the url
   // contains one search term.
   mutable std::string host_;
   mutable std::string path_;
   mutable std::string search_term_key_;
+
+  // Whether the contained URL is a pre-populated URL.
+  bool prepopulated_;
 };
 
 // Describes the relevant portions of a single OSD document.
 class TemplateURL {
  public:
   // Describes a single image reference. Each TemplateURL may have
   // any number (including 0) of ImageRefs.
   //
   // If a TemplateURL has no images, the favicon for the generated URL
   // should be used.
@@ skipping 202 matching lines @@
   }
 
   void set_logo_id(int logo_id) { logo_id_ = logo_id; }
   int logo_id() const { return logo_id_; }
 
   // Returns the unique identifier of this TemplateURL. The unique ID is set
   // by the TemplateURLService when the TemplateURL is added to it.
   TemplateURLID id() const { return id_; }
 
   // If this TemplateURL comes from prepopulated data the prepopulate_id is > 0.
-  void set_prepopulate_id(int id) { prepopulate_id_ = id; }
+  // SetPrepopulateId also sets any TemplateURLRef's prepopulated flag to true
+  // if |id| > 0 and false otherwise.
+  void SetPrepopulateId(int id);
   int prepopulate_id() const { return prepopulate_id_; }
 
   std::string GetExtensionId() const;
   bool IsExtensionKeyword() const;
 
  private:
   friend void MergeEnginesFromPrepopulateData(
       PrefService* prefs,
       WebDataService* service,
       std::vector<TemplateURL*>* template_urls,
       const TemplateURL** default_search_provider);
   friend class KeywordTable;
   friend class KeywordTableTest;
   friend class SearchHostToURLsMap;
   friend class TemplateURLService;
 
   // Invalidates cached values on this object and its child TemplateURLRefs.
   void InvalidateCachedValues() const;
 
+  // Sets all TemplateURLRefs prepopulated flags.
+  void SetTemplateURLRefsPrepopulated(bool prepopulated);
+
   // Unique identifier, used when archived to the database.
   void set_id(TemplateURLID id) { id_ = id; }
 
   string16 short_name_;
   string16 description_;
   TemplateURLRef suggestions_url_;
   TemplateURLRef url_;
   TemplateURLRef instant_url_;
   GURL originating_url_;
   mutable string16 keyword_;
@@ skipping 14 matching lines @@
   bool created_by_policy_;
   int usage_count_;
   SearchEngineType search_engine_type_;
   int logo_id_;
   int prepopulate_id_;
 
   // TODO(sky): Add date last parsed OSD file.
 };
 
 #endif  // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_H_