default_search_manager.cc 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. // Copyright 2014 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "components/search_engines/default_search_manager.h"
  5. #include <stddef.h>
  6. #include <stdint.h>
  7. #include <algorithm>
  8. #include <memory>
  9. #include <utility>
  10. #include "base/bind.h"
  11. #include "base/callback_helpers.h"
  12. #include "base/check.h"
  13. #include "base/compiler_specific.h"
  14. #include "base/i18n/case_conversion.h"
  15. #include "base/strings/string_split.h"
  16. #include "base/strings/string_util.h"
  17. #include "base/strings/utf_string_conversions.h"
  18. #include "base/time/time.h"
  19. #include "components/pref_registry/pref_registry_syncable.h"
  20. #include "components/prefs/pref_service.h"
  21. #include "components/prefs/pref_value_map.h"
  22. #include "components/search_engines/search_engines_pref_names.h"
  23. #include "components/search_engines/template_url_data.h"
  24. #include "components/search_engines/template_url_data_util.h"
  25. #include "components/search_engines/template_url_prepopulate_data.h"
  26. namespace {
  27. bool g_fallback_search_engines_disabled = false;
  28. } // namespace
  29. // A dictionary to hold all data related to the Default Search Engine.
  30. // Eventually, this should replace all the data stored in the
  31. // default_search_provider.* prefs.
  32. const char DefaultSearchManager::kDefaultSearchProviderDataPrefName[] =
  33. "default_search_provider_data.template_url_data";
  34. const char DefaultSearchManager::kID[] = "id";
  35. const char DefaultSearchManager::kShortName[] = "short_name";
  36. const char DefaultSearchManager::kKeyword[] = "keyword";
  37. const char DefaultSearchManager::kPrepopulateID[] = "prepopulate_id";
  38. const char DefaultSearchManager::kSyncGUID[] = "synced_guid";
  39. const char DefaultSearchManager::kURL[] = "url";
  40. const char DefaultSearchManager::kSuggestionsURL[] = "suggestions_url";
  41. const char DefaultSearchManager::kImageURL[] = "image_url";
  42. const char DefaultSearchManager::kNewTabURL[] = "new_tab_url";
  43. const char DefaultSearchManager::kContextualSearchURL[] =
  44. "contextual_search_url";
  45. const char DefaultSearchManager::kFaviconURL[] = "favicon_url";
  46. const char DefaultSearchManager::kLogoURL[] = "logo_url";
  47. const char DefaultSearchManager::kDoodleURL[] = "doodle_url";
  48. const char DefaultSearchManager::kOriginatingURL[] = "originating_url";
  49. const char DefaultSearchManager::kSearchURLPostParams[] =
  50. "search_url_post_params";
  51. const char DefaultSearchManager::kSuggestionsURLPostParams[] =
  52. "suggestions_url_post_params";
  53. const char DefaultSearchManager::kImageURLPostParams[] =
  54. "image_url_post_params";
  55. const char DefaultSearchManager::kSideSearchParam[] = "side_search_param";
  56. const char DefaultSearchManager::kSafeForAutoReplace[] = "safe_for_autoreplace";
  57. const char DefaultSearchManager::kInputEncodings[] = "input_encodings";
  58. const char DefaultSearchManager::kDateCreated[] = "date_created";
  59. const char DefaultSearchManager::kLastModified[] = "last_modified";
  60. const char DefaultSearchManager::kLastVisited[] = "last_visited";
  61. const char DefaultSearchManager::kUsageCount[] = "usage_count";
  62. const char DefaultSearchManager::kAlternateURLs[] = "alternate_urls";
  63. const char DefaultSearchManager::kCreatedByPolicy[] = "created_by_policy";
  64. const char DefaultSearchManager::kDisabledByPolicy[] = "disabled_by_policy";
  65. const char DefaultSearchManager::kCreatedFromPlayAPI[] =
  66. "created_from_play_api";
  67. const char DefaultSearchManager::kPreconnectToSearchUrl[] =
  68. "preconnect_to_search_url";
  69. const char DefaultSearchManager::kPrefetchLikelyNavigations[] =
  70. "prefetch_likely_navigations";
  71. const char DefaultSearchManager::kIsActive[] = "is_active";
  72. const char DefaultSearchManager::kStarterPackId[] = "starter_pack_id";
  73. DefaultSearchManager::DefaultSearchManager(
  74. PrefService* pref_service,
  75. const ObserverCallback& change_observer)
  76. : pref_service_(pref_service), change_observer_(change_observer) {
  77. if (pref_service_) {
  78. pref_change_registrar_.Init(pref_service_);
  79. pref_change_registrar_.Add(
  80. kDefaultSearchProviderDataPrefName,
  81. base::BindRepeating(&DefaultSearchManager::OnDefaultSearchPrefChanged,
  82. base::Unretained(this)));
  83. pref_change_registrar_.Add(
  84. prefs::kSearchProviderOverrides,
  85. base::BindRepeating(&DefaultSearchManager::OnOverridesPrefChanged,
  86. base::Unretained(this)));
  87. }
  88. LoadPrepopulatedDefaultSearch();
  89. LoadDefaultSearchEngineFromPrefs();
  90. }
  91. DefaultSearchManager::~DefaultSearchManager() {
  92. }
  93. // static
  94. void DefaultSearchManager::RegisterProfilePrefs(
  95. user_prefs::PrefRegistrySyncable* registry) {
  96. registry->RegisterDictionaryPref(kDefaultSearchProviderDataPrefName);
  97. }
  98. // static
  99. void DefaultSearchManager::AddPrefValueToMap(base::Value::Dict value,
  100. PrefValueMap* pref_value_map) {
  101. pref_value_map->SetValue(kDefaultSearchProviderDataPrefName,
  102. base::Value(std::move(value)));
  103. }
  104. // static
  105. void DefaultSearchManager::SetFallbackSearchEnginesDisabledForTesting(
  106. bool disabled) {
  107. g_fallback_search_engines_disabled = disabled;
  108. }
  109. const TemplateURLData* DefaultSearchManager::GetDefaultSearchEngine(
  110. Source* source) const {
  111. if (default_search_mandatory_by_policy_) {
  112. if (source)
  113. *source = FROM_POLICY;
  114. return prefs_default_search_.get();
  115. }
  116. if (default_search_recommended_by_policy_) {
  117. if (source)
  118. *source = FROM_POLICY_RECOMMENDED;
  119. return prefs_default_search_.get();
  120. }
  121. if (extension_default_search_) {
  122. if (source)
  123. *source = FROM_EXTENSION;
  124. return extension_default_search_.get();
  125. }
  126. if (prefs_default_search_) {
  127. if (source)
  128. *source = FROM_USER;
  129. return prefs_default_search_.get();
  130. }
  131. if (source)
  132. *source = FROM_FALLBACK;
  133. return GetFallbackSearchEngine();
  134. }
  135. std::unique_ptr<TemplateURLData>
  136. DefaultSearchManager::GetDefaultSearchEngineIgnoringExtensions() const {
  137. if (prefs_default_search_)
  138. return std::make_unique<TemplateURLData>(*prefs_default_search_);
  139. if (default_search_mandatory_by_policy_ ||
  140. default_search_recommended_by_policy_) {
  141. // If a policy specified a specific engine, it would be returned above
  142. // as |prefs_default_search_|. The only other scenario is that policy has
  143. // disabled default search, in which case we return null.
  144. return nullptr;
  145. }
  146. // |prefs_default_search_| may not be populated even if there is a user
  147. // preference; check prefs directly as the source of truth.
  148. const base::Value* user_value =
  149. pref_service_->GetUserPrefValue(kDefaultSearchProviderDataPrefName);
  150. if (user_value && user_value->is_dict()) {
  151. auto turl_data = TemplateURLDataFromDictionary(user_value->GetDict());
  152. if (turl_data)
  153. return turl_data;
  154. }
  155. const TemplateURLData* fallback = GetFallbackSearchEngine();
  156. if (fallback)
  157. return std::make_unique<TemplateURLData>(*fallback);
  158. return nullptr;
  159. }
  160. DefaultSearchManager::Source
  161. DefaultSearchManager::GetDefaultSearchEngineSource() const {
  162. Source source;
  163. GetDefaultSearchEngine(&source);
  164. return source;
  165. }
  166. const TemplateURLData* DefaultSearchManager::GetFallbackSearchEngine() const {
  167. return g_fallback_search_engines_disabled ? nullptr
  168. : fallback_default_search_.get();
  169. }
  170. void DefaultSearchManager::SetUserSelectedDefaultSearchEngine(
  171. const TemplateURLData& data) {
  172. if (!pref_service_) {
  173. prefs_default_search_ = std::make_unique<TemplateURLData>(data);
  174. MergePrefsDataWithPrepopulated();
  175. NotifyObserver();
  176. return;
  177. }
  178. pref_service_->Set(kDefaultSearchProviderDataPrefName,
  179. *TemplateURLDataToDictionary(data));
  180. }
  181. void DefaultSearchManager::ClearUserSelectedDefaultSearchEngine() {
  182. if (pref_service_) {
  183. pref_service_->ClearPref(kDefaultSearchProviderDataPrefName);
  184. } else {
  185. prefs_default_search_.reset();
  186. NotifyObserver();
  187. }
  188. }
  189. void DefaultSearchManager::OnDefaultSearchPrefChanged() {
  190. bool source_was_fallback = GetDefaultSearchEngineSource() == FROM_FALLBACK;
  191. LoadDefaultSearchEngineFromPrefs();
  192. // The effective DSE may have changed unless we were using the fallback source
  193. // both before and after the above load.
  194. if (!source_was_fallback || (GetDefaultSearchEngineSource() != FROM_FALLBACK))
  195. NotifyObserver();
  196. }
  197. void DefaultSearchManager::OnOverridesPrefChanged() {
  198. LoadPrepopulatedDefaultSearch();
  199. const TemplateURLData* effective_data = GetDefaultSearchEngine(nullptr);
  200. if (effective_data && effective_data->prepopulate_id) {
  201. // A user-selected, policy-selected or fallback pre-populated engine is
  202. // active and may have changed with this event.
  203. NotifyObserver();
  204. }
  205. }
  206. void DefaultSearchManager::MergePrefsDataWithPrepopulated() {
  207. if (!prefs_default_search_ || !prefs_default_search_->prepopulate_id)
  208. return;
  209. // TODO(crbug.com/1049784): Parameters for search engine created from play api
  210. // should be preserved even if corresponding prepopulated search engine
  211. // exists. This logic will be revisited as part of implementation of
  212. // crbug.com/1049784, which will enable updating play api search engine
  213. // parameters with prepopulated data.
  214. if (prefs_default_search_->created_from_play_api)
  215. return;
  216. std::vector<std::unique_ptr<TemplateURLData>> prepopulated_urls =
  217. TemplateURLPrepopulateData::GetPrepopulatedEngines(pref_service_,
  218. nullptr);
  219. auto default_engine = std::find_if(
  220. prepopulated_urls.begin(), prepopulated_urls.end(),
  221. [&](const std::unique_ptr<TemplateURLData>& url) {
  222. return url->prepopulate_id == prefs_default_search_->prepopulate_id;
  223. });
  224. if (default_engine == prepopulated_urls.end())
  225. return;
  226. auto& engine = *default_engine;
  227. if (!prefs_default_search_->safe_for_autoreplace) {
  228. engine->safe_for_autoreplace = false;
  229. engine->SetKeyword(prefs_default_search_->keyword());
  230. engine->SetShortName(prefs_default_search_->short_name());
  231. }
  232. engine->id = prefs_default_search_->id;
  233. engine->sync_guid = prefs_default_search_->sync_guid;
  234. engine->date_created = prefs_default_search_->date_created;
  235. engine->last_modified = prefs_default_search_->last_modified;
  236. engine->last_visited = prefs_default_search_->last_visited;
  237. engine->favicon_url = prefs_default_search_->favicon_url;
  238. prefs_default_search_ = std::move(engine);
  239. }
  240. void DefaultSearchManager::LoadDefaultSearchEngineFromPrefs() {
  241. if (!pref_service_)
  242. return;
  243. prefs_default_search_.reset();
  244. extension_default_search_.reset();
  245. const PrefService::Preference* pref =
  246. pref_service_->FindPreference(kDefaultSearchProviderDataPrefName);
  247. DCHECK(pref);
  248. default_search_mandatory_by_policy_ = pref->IsManaged();
  249. default_search_recommended_by_policy_ = pref->IsRecommended();
  250. const base::Value::Dict& url_dict =
  251. pref_service_->GetValueDict(kDefaultSearchProviderDataPrefName);
  252. if (url_dict.empty())
  253. return;
  254. if (default_search_mandatory_by_policy_ ||
  255. default_search_recommended_by_policy_) {
  256. if (url_dict.FindBool(kDisabledByPolicy).value_or(false))
  257. return;
  258. }
  259. auto turl_data = TemplateURLDataFromDictionary(url_dict);
  260. if (!turl_data)
  261. return;
  262. // Check if default search preference is overriden by extension.
  263. if (pref->IsExtensionControlled()) {
  264. extension_default_search_ = std::move(turl_data);
  265. } else {
  266. prefs_default_search_ = std::move(turl_data);
  267. MergePrefsDataWithPrepopulated();
  268. }
  269. }
  270. void DefaultSearchManager::LoadPrepopulatedDefaultSearch() {
  271. std::unique_ptr<TemplateURLData> data =
  272. TemplateURLPrepopulateData::GetPrepopulatedDefaultSearch(pref_service_);
  273. fallback_default_search_ = std::move(data);
  274. MergePrefsDataWithPrepopulated();
  275. }
  276. void DefaultSearchManager::NotifyObserver() {
  277. if (!change_observer_.is_null()) {
  278. Source source = FROM_FALLBACK;
  279. const TemplateURLData* data = GetDefaultSearchEngine(&source);
  280. change_observer_.Run(data, source);
  281. }
  282. }