Change behaivor to decide whether a search engine should be shown in the default list

components/search_engines/template_url_service.cc

 // 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.
 
 #include "components/search_engines/template_url_service.h"
 
 #include <algorithm>
 #include <utility>
 
 #include "base/auto_reset.h"
@@ skipping 377 matching lines @@
   // We don't have a TemplateURL with keyword.  We still may not allow this
   // keyword if there's evidence we may have created this keyword before and
   // the user renamed it (because, for instance, the keyword is a common word
   // that may interfere with search queries).  An easy heuristic for this is
   // whether the user has a TemplateURL that has been manually modified (e.g.,
   // renamed) connected to the same host.
   return !url.is_valid() || url.host().empty() ||
       CanAddAutogeneratedKeywordForHost(url.host());
 }
 
+bool TemplateURLService::ShowInDefaultList(const TemplateURL* t_url) {
+  return t_url == default_search_provider_ || t_url->prepopulate_id() > 0 ||
+         t_url->created_by_policy();
+}
+
 void TemplateURLService::AddMatchingKeywords(
     const base::string16& prefix,
     bool supports_replacement_only,
     TURLsAndMeaningfulLengths* matches) {
   AddMatchingKeywordsHelper(
       keyword_to_turl_and_length_, prefix, supports_replacement_only, matches);
 }
 
 void TemplateURLService::AddMatchingDomainKeywords(
     const base::string16& prefix,
@@ skipping 62 matching lines @@
 }
 
 TemplateURL* TemplateURLService::AddExtensionControlledTURL(
     std::unique_ptr<TemplateURL> template_url,
     std::unique_ptr<TemplateURL::AssociatedExtensionInfo> info) {
   DCHECK(loaded_);
   DCHECK(template_url);
   DCHECK_EQ(kInvalidTemplateURLID, template_url->id());
   DCHECK(info);
   DCHECK_NE(TemplateURL::NORMAL, template_url->type());
-  DCHECK_EQ(info->wants_to_be_default_engine,
-            template_url->show_in_default_list());
   DCHECK(
       !FindTemplateURLForExtension(info->extension_id, template_url->type()));
   template_url->extension_info_.swap(info);
 
   KeywordWebDataService::BatchModeScoper scoper(web_data_service_.get());
   TemplateURL* template_url_ptr = AddNoNotify(std::move(template_url), true);
   if (template_url_ptr) {
     if (template_url_ptr->extension_info_->wants_to_be_default_engine) {
       UpdateExtensionDefaultSearchEngine();
     }
     NotifyObservers();
   }
 
+  DCHECK_EQ(template_url_ptr->extension_info_->wants_to_be_default_engine,
+            ShowInDefaultList(template_url_ptr));

[Peter Kasting, 2016/11/10 06:41:07]

Hmm... is this safe?

In the future, if ShowInDefaultList() returns true for "recently used" engines,
could it not return true for engines which have been recently but don't "want to
be default"?

I might just remove this DCHECK.

[ltian, 2016/11/11 03:52:13]

I guess for most cases it is fine because within
UpdateExtensionDefaultSearchEngine() it calls
SetExtensionControlledDefaultSearchEngine()
(https://codesearch.chromium.org/chromium/src/components/search_engines/templa...)
to set that extension as default search engine so ShowInDefaultList() will
return the same value as wants_to_be_default_engine. However there is one
exception that is SupportsReplacement()
(https://codesearch.chromium.org/chromium/src/components/search_engines/templa...)
returns false, the DCHECK will fail. So remove DCHECK is definitely safer.

+
   return template_url_ptr;
 }
 
 void TemplateURLService::Remove(TemplateURL* template_url) {
   RemoveNoNotify(template_url);
   NotifyObservers();
 }
 
 void TemplateURLService::RemoveExtensionControlledTURL(
     const std::string& extension_id,
@@ skipping 732 matching lines @@
       specifics.mutable_search_engine();
   se_specifics->set_short_name(base::UTF16ToUTF8(turl.short_name()));
   se_specifics->set_keyword(base::UTF16ToUTF8(turl.keyword()));
   se_specifics->set_favicon_url(turl.favicon_url().spec());
   se_specifics->set_url(turl.url());
   se_specifics->set_safe_for_autoreplace(turl.safe_for_autoreplace());
   se_specifics->set_originating_url(turl.originating_url().spec());
   se_specifics->set_date_created(turl.date_created().ToInternalValue());
   se_specifics->set_input_encodings(
       base::JoinString(turl.input_encodings(), ";"));
-  se_specifics->set_show_in_default_list(turl.show_in_default_list());
   se_specifics->set_suggestions_url(turl.suggestions_url());
   se_specifics->set_prepopulate_id(turl.prepopulate_id());
   se_specifics->set_instant_url(turl.instant_url());
   if (!turl.image_url().empty())
     se_specifics->set_image_url(turl.image_url());
   se_specifics->set_new_tab_url(turl.new_tab_url());
   if (!turl.search_url_post_params().empty())
     se_specifics->set_search_url_post_params(turl.search_url_post_params());
   if (!turl.suggestions_url_post_params().empty()) {
     se_specifics->set_suggestions_url_post_params(
@@ skipping 59 matching lines @@
   data.SetURL(specifics.url());
   data.suggestions_url = specifics.suggestions_url();
   data.instant_url = specifics.instant_url();
   data.image_url = specifics.image_url();
   data.new_tab_url = specifics.new_tab_url();
   data.search_url_post_params = specifics.search_url_post_params();
   data.suggestions_url_post_params = specifics.suggestions_url_post_params();
   data.instant_url_post_params = specifics.instant_url_post_params();
   data.image_url_post_params = specifics.image_url_post_params();
   data.favicon_url = GURL(specifics.favicon_url());
-  data.show_in_default_list = specifics.show_in_default_list();
   data.safe_for_autoreplace = specifics.safe_for_autoreplace();
   data.input_encodings = base::SplitString(
       specifics.input_encodings(), ";",
       base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
   // If the server data has duplicate encodings, we'll want to push an update
   // below to correct it.  Note that we also fix this in
   // GetSearchProvidersUsingKeywordResult(), since otherwise we'd never correct
   // local problems for clients which have disabled search engine sync.
   bool deduped = DeDupeEncodings(&data.input_encodings);
   data.date_created = base::Time::FromInternalValue(specifics.date_created());
@@ skipping 296 matching lines @@
   if (!urls)
     return true;
   for (TemplateURLSet::const_iterator i(urls->begin()); i != urls->end(); ++i) {
     if (!(*i)->safe_for_autoreplace())
       return false;
   }
   return true;
 }
 
 bool TemplateURLService::CanReplace(const TemplateURL* t_url) {
-  return (t_url != default_search_provider_ && !t_url->show_in_default_list() &&
-          t_url->safe_for_autoreplace());
+  return !ShowInDefaultList(t_url) && t_url->safe_for_autoreplace();
 }
 
 TemplateURL* TemplateURLService::FindNonExtensionTemplateURLForKeyword(
     const base::string16& keyword) {
   TemplateURL* keyword_turl = GetTemplateURLForKeyword(keyword);
   if (!keyword_turl || (keyword_turl->type() == TemplateURL::NORMAL))
     return keyword_turl;
   // The extension keyword in the model may be hiding a replaceable
   // non-extension keyword.  Look for it.
   for (const auto& turl : template_urls_) {
@@ skipping 304 matching lines @@
       if (AddNoNotify(std::move(new_dse_ptr), true))
         default_search_provider_ = new_dse;
     }
   } else if (source == DefaultSearchManager::FROM_USER) {
     default_search_provider_ = GetTemplateURLForGUID(data->sync_guid);
     if (!default_search_provider_ && data->prepopulate_id) {
       default_search_provider_ =
           FindPrepopulatedTemplateURL(data->prepopulate_id);
     }
     TemplateURLData new_data(*data);
-    new_data.show_in_default_list = true;
     if (default_search_provider_) {
       UpdateNoNotify(default_search_provider_, TemplateURL(new_data));
     } else {
       new_data.id = kInvalidTemplateURLID;
       std::unique_ptr<TemplateURL> new_dse_ptr =
           base::MakeUnique<TemplateURL>(new_data);
       TemplateURL* new_dse = new_dse_ptr.get();
       if (AddNoNotify(std::move(new_dse_ptr), true))
         default_search_provider_ = new_dse;
     }
@@ skipping 492 matching lines @@
 
   if (most_recently_intalled_default) {
     base::AutoReset<DefaultSearchChangeOrigin> change_origin(
         &dsp_change_origin_, DSP_CHANGE_OVERRIDE_SETTINGS_EXTENSION);
     default_search_manager_.SetExtensionControlledDefaultSearchEngine(
         most_recently_intalled_default->data());
   } else {
     default_search_manager_.ClearExtensionControlledDefaultSearchEngine();
   }
 }