Enable Chrome to tweak search engines for some locales

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 481 matching lines @@
 // is made a friend so that it can be the exception to this pattern.
 class TemplateURL {
  public:
   enum Type {
     // Regular search engine.
     NORMAL,
     // Installed by extension through Override Settings API.
     NORMAL_CONTROLLED_BY_EXTENSION,
     // The keyword associated with an extension that uses the Omnibox API.
     OMNIBOX_API_EXTENSION,
+    // Installed only on this device. Should not be sync'd.

[Peter Kasting, 2016/09/19 21:06:23]

Nit: synced

[Ian Wen, 2016/09/20 04:48:03]

Done.

+    LOCAL,
   };
 
   // An AssociatedExtensionInfo represents information about the extension that
   // added the search engine.
   struct AssociatedExtensionInfo {
     AssociatedExtensionInfo(Type type, const std::string& extension_id);
     ~AssociatedExtensionInfo();
 
     Type type;
 
@@ skipping 121 matching lines @@
       const SearchTermsData& search_terms_data) const;
 
   // Returns true if the keywords match or if
   // IsGoogleSearchURLWithReplaceableKeyword() is true for both |this| and
   // |other|.
   bool HasSameKeywordAs(const TemplateURLData& other,
                         const SearchTermsData& search_terms_data) const;
 
   Type GetType() const;
 
+  void SetType(Type type);
+
   // Returns the id of the extension that added this search engine. Only call
   // this for TemplateURLs of type NORMAL_CONTROLLED_BY_EXTENSION or
   // OMNIBOX_API_EXTENSION.
   std::string GetExtensionId() const;
 
   // Returns the type of this search engine, or SEARCH_ENGINE_OTHER if no
   // engines match.
   SearchEngineType GetEngineType(
       const SearchTermsData& search_terms_data) const;
 
@@ skipping 98 matching lines @@
   TemplateURLRef suggestions_url_ref_;
   TemplateURLRef instant_url_ref_;
   TemplateURLRef image_url_ref_;
   TemplateURLRef new_tab_url_ref_;
   TemplateURLRef contextual_search_url_ref_;
   std::unique_ptr<AssociatedExtensionInfo> extension_info_;
 
   // Caches the computed engine type across successive calls to GetEngineType().
   mutable SearchEngineType engine_type_;
 
+  Type type_;

[Peter Kasting, 2016/09/19 21:06:23]

If you're going to elevate the "type" concept to not necessarily be connected
with an extension anymore, then it probably needs to be removed from
AssociatedExtensionInfo so it is set in one fundamental place on every
TemplateURL.  (That would also allow converting GetType() into an inline type()
accessor.)

Then TemplateURL's constructor could take a type argument (that can be defaulted
to NORMAL), instead of adding the setter you've added above, since you just want
to set your type at construction.

The problem is how this interacts with places that use set_extension_info()
today.  I'm a little uneasy about that function, since TemplateURLs are meant to
be mostly immutable, so I'm wondering whether this should similarly only be
happening at construction time, or whether there's some way existing callers use
this where they actually need to toggle the type of a TemplateURL after
creation.  I don't know how the extension code uses this enough to answer this;
I'm hoping you've looked at more of this than I have and can figure it out?

[Ian Wen, 2016/09/20 04:48:03]

In one case about omnibox extension I do need to change the turl's type. Other
than this TURL is pretty much immutable.

I followed your guide and moved type to TURL's constructor, and also makes
type() and set_type() inline methods.

Done.

+
   // TODO(sky): Add date last parsed OSD file.
 
   DISALLOW_COPY_AND_ASSIGN(TemplateURL);
 };
 
 #endif  // COMPONENTS_SEARCH_ENGINES_TEMPLATE_URL_H_