1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
// 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_DEFAULT_SEARCH_MANAGER_H_
#define COMPONENTS_SEARCH_ENGINES_DEFAULT_SEARCH_MANAGER_H_
#include <memory>
#include "base/callback.h"
#include "base/macros.h"
#include "components/prefs/pref_change_registrar.h"
namespace base {
class DictionaryValue;
}
namespace user_prefs {
class PrefRegistrySyncable;
}
class PrefService;
class PrefValueMap;
struct TemplateURLData;
// DefaultSearchManager handles the loading and writing of the user's default
// search engine selection to and from prefs.
class DefaultSearchManager {
public:
static const char kDefaultSearchProviderDataPrefName[];
static const char kID[];
static const char kShortName[];
static const char kKeyword[];
static const char kPrepopulateID[];
static const char kSyncGUID[];
static const char kURL[];
static const char kSuggestionsURL[];
static const char kInstantURL[];
static const char kImageURL[];
static const char kNewTabURL[];
static const char kContextualSearchURL[];
static const char kFaviconURL[];
static const char kLogoURL[];
static const char kOriginatingURL[];
static const char kSearchURLPostParams[];
static const char kSuggestionsURLPostParams[];
static const char kInstantURLPostParams[];
static const char kImageURLPostParams[];
static const char kSafeForAutoReplace[];
static const char kInputEncodings[];
static const char kDateCreated[];
static const char kLastModified[];
static const char kLastVisited[];
static const char kUsageCount[];
static const char kAlternateURLs[];
static const char kSearchTermsReplacementKey[];
static const char kCreatedByPolicy[];
static const char kDisabledByPolicy[];
enum Source {
// Default search engine chosen either from prepopulated engines set for
// current country or overriden from kSearchProviderOverrides preference.
FROM_FALLBACK = 0,
// User selected engine.
FROM_USER,
// Search engine set by extension overriding default search.
FROM_EXTENSION,
// Search engine controlled externally through enterprise configuration
// management (e.g. windows group policy).
FROM_POLICY,
};
typedef base::Callback<void(const TemplateURLData*, Source)> ObserverCallback;
DefaultSearchManager(PrefService* pref_service,
const ObserverCallback& change_observer);
~DefaultSearchManager();
// Register prefs needed for tracking the default search provider.
static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
// Save default search provider pref values into the map provided.
static void AddPrefValueToMap(std::unique_ptr<base::DictionaryValue> value,
PrefValueMap* pref_value_map);
// Testing code can call this with |disabled| set to true to cause
// GetDefaultSearchEngine() to return nullptr instead of
// |fallback_default_search_| in cases where the DSE source is FROM_FALLBACK.
static void SetFallbackSearchEnginesDisabledForTesting(bool disabled);
// Gets a pointer to the current Default Search Engine. If NULL, indicates
// that Default Search is explicitly disabled. |source|, if not NULL, will be
// filled in with the source of the result.
const TemplateURLData* GetDefaultSearchEngine(Source* source) const;
// Gets the source of the current Default Search Engine value.
Source GetDefaultSearchEngineSource() const;
// Returns a pointer to the fallback engine.
const TemplateURLData* GetFallbackSearchEngine() const;
// Write default search provider data to |pref_service_|.
void SetUserSelectedDefaultSearchEngine(const TemplateURLData& data);
// Clear the user's default search provider choice from |pref_service_|. Does
// not explicitly disable Default Search. The new default search
// engine will be defined by policy, extensions, or pre-populated data.
void ClearUserSelectedDefaultSearchEngine();
private:
// Handles changes to kDefaultSearchProviderData pref. This includes sync and
// policy changes. Calls LoadDefaultSearchEngineFromPrefs() and
// NotifyObserver() if the effective DSE might have changed.
void OnDefaultSearchPrefChanged();
// Handles changes to kSearchProviderOverrides pref. Calls
// LoadPrepopulatedDefaultSearch() and NotifyObserver() if the effective DSE
// might have changed.
void OnOverridesPrefChanged();
// Updates |prefs_default_search_| with values from its corresponding
// pre-populated search provider record, if any.
void MergePrefsDataWithPrepopulated();
// Reads default search provider data from |pref_service_|, updating
// |prefs_default_search_| and |default_search_controlled_by_policy_|.
// Invokes MergePrefsDataWithPrepopulated().
void LoadDefaultSearchEngineFromPrefs();
// Reads pre-populated search providers, which will be built-in or overridden
// by kSearchProviderOverrides. Updates |fallback_default_search_|. Invoke
// MergePrefsDataWithPrepopulated().
void LoadPrepopulatedDefaultSearch();
// Invokes |change_observer_| if it is not NULL.
void NotifyObserver();
PrefService* pref_service_;
const ObserverCallback change_observer_;
PrefChangeRegistrar pref_change_registrar_;
// Default search engine provided by pre-populated data or by the
// |kSearchProviderOverrides| pref. This will be used when no other default
// search engine has been selected.
std::unique_ptr<TemplateURLData> fallback_default_search_;
// Default search engine provided by extension (usings Settings Override API).
// This will be null if there are no extensions installed which provide
// default search engines.
std::unique_ptr<TemplateURLData> extension_default_search_;
// Default search engine provided by prefs (either user prefs or policy
// prefs). This will be null if no value was set in the pref store.
std::unique_ptr<TemplateURLData> prefs_default_search_;
// True if the default search is currently enforced by policy.
bool default_search_controlled_by_policy_;
DISALLOW_COPY_AND_ASSIGN(DefaultSearchManager);
};
#endif // COMPONENTS_SEARCH_ENGINES_DEFAULT_SEARCH_MANAGER_H_
|
