Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(16)

Side by Side Diff: chrome/browser/profile_resetter/automatic_profile_resetter_delegate.h

Issue 62193002: Integrate UI and reset logic into AutomaticProfileResetter. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Reduced boilerplate in unit tests. Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright 2013 The Chromium Authors. All rights reserved. 1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H_ 5 #ifndef CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H_
6 #define CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H_ 6 #define CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H_
7 7
8 #include "base/basictypes.h" 8 #include "base/basictypes.h"
9 #include "base/callback_forward.h" 9 #include "base/callback_forward.h"
10 #include "base/memory/scoped_ptr.h" 10 #include "base/memory/scoped_ptr.h"
11 #include "base/memory/weak_ptr.h"
12 #include "chrome/browser/profile_resetter/profile_resetter.h"
11 #include "chrome/browser/search_engines/template_url_service_observer.h" 13 #include "chrome/browser/search_engines/template_url_service_observer.h"
12 #include "content/public/browser/notification_observer.h" 14 #include "content/public/browser/notification_observer.h"
13 #include "content/public/browser/notification_registrar.h" 15 #include "content/public/browser/notification_registrar.h"
14 #include "extensions/common/one_shot_event.h" 16 #include "extensions/common/one_shot_event.h"
15 17
18 class BrandcodeConfigFetcher;
19 class GlobalErrorService;
20 class Profile;
21 class ResettableSettingsSnapshot;
16 class TemplateURLService; 22 class TemplateURLService;
17 23
18 namespace base { 24 namespace base {
19 class DictionaryValue; 25 class DictionaryValue;
20 class ListValue; 26 class ListValue;
21 } 27 }
22 28
23 // Defines the interface for the delegate that will interact with the rest of 29 // Defines the interface for the delegate that will interact with the rest of
24 // the browser on behalf of the AutomaticProfileResetter. 30 // the browser on behalf of the AutomaticProfileResetter.
25 // The primary reason for this separation is to facilitate unit testing. 31 // The primary reason for this separation is to facilitate unit testing.
(...skipping 11 matching lines...) Expand all
37 const base::Closure& ready_callback) const = 0; 43 const base::Closure& ready_callback) const = 0;
38 44
39 // Requests the template URL service to load its database (asynchronously). 45 // Requests the template URL service to load its database (asynchronously).
40 virtual void LoadTemplateURLServiceIfNeeded() = 0; 46 virtual void LoadTemplateURLServiceIfNeeded() = 0;
41 47
42 // Requests |ready_callback| to be posted on the UI thread once the template 48 // Requests |ready_callback| to be posted on the UI thread once the template
43 // URL service has finished loading its database. 49 // URL service has finished loading its database.
44 virtual void RequestCallbackWhenTemplateURLServiceIsLoaded( 50 virtual void RequestCallbackWhenTemplateURLServiceIsLoaded(
45 const base::Closure& ready_callback) const = 0; 51 const base::Closure& ready_callback) const = 0;
46 52
53 // Starts downloading the configuration file containing the default settings
54 // for the current brandcode, or establishes that we are running a vanilla
55 // (non-branded) build.
56 virtual void FetchBrandcodedDefaultSettingsIfNeeded() = 0;
57
58 // Requests |ready_callback| to be posted on the UI thread once the brandcoded
59 // default settings have been downloaded.
60 virtual void RequestCallbackWhenBrandcodedDefaultsAreFetched(
61 const base::Closure& ready_callback) const = 0;
62
47 // Returns a list of loaded module name digests. 63 // Returns a list of loaded module name digests.
48 virtual scoped_ptr<base::ListValue> GetLoadedModuleNameDigests() const = 0; 64 virtual scoped_ptr<base::ListValue> GetLoadedModuleNameDigests() const = 0;
49 65
50 // Returns attributes of the search engine currently set as the default (or 66 // Returns attributes of the search engine currently set as the default (or
51 // an empty dictionary if there is none). 67 // an empty dictionary if there is none).
52 // The returned attributes correspond in meaning and format to the user 68 // The returned attributes correspond in meaning and format to the user
53 // preferences stored by TemplateURLService::SaveDefaultSearchProviderToPrefs, 69 // preferences stored by TemplateURLService::SaveDefaultSearchProviderToPrefs,
54 // and will be named after the second path name segment of the respective 70 // and will be named after the second path name segment of the respective
55 // preference (i.e. the part after "default_search_provider."). 71 // preference (i.e. the part after "default_search_provider.").
56 // Note that: 72 // Note that:
57 // 1.) the "enabled" attribute will not be present, as it is not technically 73 // 1.) the "enabled" attribute will not be present, as it is not technically
58 // an attribute of a search provider, 74 // an attribute of a search provider,
59 // 2.) "encodings" will be a list of strings, in contrast to a single string 75 // 2.) "encodings" will be a list of strings, in contrast to a single string
60 // with tokens delimited by semicolons, but the order will be the same. 76 // with tokens delimited by semicolons, but the order will be the same.
61 virtual scoped_ptr<base::DictionaryValue> 77 virtual scoped_ptr<base::DictionaryValue>
62 GetDefaultSearchProviderDetails() const = 0; 78 GetDefaultSearchProviderDetails() const = 0;
63 79
64 // Returns whether or not the default search provider is set by policy. 80 // Returns whether or not the default search provider is set by policy.
65 virtual bool IsDefaultSearchProviderManaged() const = 0; 81 virtual bool IsDefaultSearchProviderManaged() const = 0;
66 82
67 // Returns a list of dictionaries, each containing attributes for each of the 83 // Returns a list of dictionaries, each containing attributes for each of the
68 // pre-populated search engines, in the format described above. 84 // pre-populated search engines, in the format described above.
69 virtual scoped_ptr<base::ListValue> 85 virtual scoped_ptr<base::ListValue>
70 GetPrepopulatedSearchProvidersDetails() const = 0; 86 GetPrepopulatedSearchProvidersDetails() const = 0;
71 87
72 // Triggers showing the one-time profile settings reset prompt. 88 // Triggers showing the one-time profile settings reset prompt, which consists
73 virtual void ShowPrompt() = 0; 89 // of two parts: (1.) the profile reset (pop-up) bubble, and (2.) a menu item
90 // in the wrench menu. Showing the bubble might be delayed if there is another
91 // bubble currently shown, in which case the bubble will be shown the first
92 // time a new browser window is opened.
93 // Returns true unless the reset prompt is not supported on the current
94 // platform, in which case it returns false and does nothing.
95 virtual bool ShowPrompt() = 0;
96
97 // Triggers the ProfileResetter to reset all supported settings and optionally
98 // |send_feedback|. Will post |completion| on the UI thread once completed.
99 // Brandcoded default settings will be fetched if they are not yet available,
100 // the reset will be performed once the download is complete.
101 // NOTE: Should only be called at most once during the lifetime of the object.
102 virtual void TriggerProfileSettingsReset(bool send_feedback,
103 const base::Closure& completion) = 0;
104
105 // Dismisses the one-time profile settings reset prompt, if it is currently
106 // active. Will synchronously destroy the corresponding GlobalError.
107 virtual void DismissPrompt() = 0;
74 }; 108 };
75 109
76 // Implementation for AutomaticProfileResetterDelegate. 110 // Implementation for AutomaticProfileResetterDelegate.
77 // To facilitate unit testing, having the TemplateURLService available is only
78 // required when using search engine related methods.
79 class AutomaticProfileResetterDelegateImpl 111 class AutomaticProfileResetterDelegateImpl
80 : public AutomaticProfileResetterDelegate, 112 : public AutomaticProfileResetterDelegate,
113 public base::SupportsWeakPtr<AutomaticProfileResetterDelegateImpl>,
81 public TemplateURLServiceObserver, 114 public TemplateURLServiceObserver,
82 public content::NotificationObserver { 115 public content::NotificationObserver {
83 public: 116 public:
84 // The |template_url_service| may be NULL in unit tests. Must be non-NULL for
85 // callers who wish to call:
86 // * LoadTemplateURLServiceIfNeeded(),
87 // * GetDefaultSearchProviderDetails(),
88 // * GetPrepopulatedSearchProvidersDetails(), or
89 // * IsDefaultSearchManaged().
90 explicit AutomaticProfileResetterDelegateImpl( 117 explicit AutomaticProfileResetterDelegateImpl(
91 TemplateURLService* template_url_service); 118 Profile* profile,
119 ProfileResetter::ResettableFlags resettable_aspects);
92 virtual ~AutomaticProfileResetterDelegateImpl(); 120 virtual ~AutomaticProfileResetterDelegateImpl();
93 121
122 // Exposed for unit tests.
123 const BrandcodedDefaultSettings* brandcoded_defaults() const {
124 return brandcoded_defaults_.get();
125 }
126
94 // AutomaticProfileResetterDelegate: 127 // AutomaticProfileResetterDelegate:
95 virtual void EnumerateLoadedModulesIfNeeded() OVERRIDE; 128 virtual void EnumerateLoadedModulesIfNeeded() OVERRIDE;
96 virtual void RequestCallbackWhenLoadedModulesAreEnumerated( 129 virtual void RequestCallbackWhenLoadedModulesAreEnumerated(
97 const base::Closure& ready_callback) const OVERRIDE; 130 const base::Closure& ready_callback) const OVERRIDE;
98 virtual void LoadTemplateURLServiceIfNeeded() OVERRIDE; 131 virtual void LoadTemplateURLServiceIfNeeded() OVERRIDE;
99 virtual void RequestCallbackWhenTemplateURLServiceIsLoaded( 132 virtual void RequestCallbackWhenTemplateURLServiceIsLoaded(
100 const base::Closure& ready_callback) const OVERRIDE; 133 const base::Closure& ready_callback) const OVERRIDE;
134 virtual void FetchBrandcodedDefaultSettingsIfNeeded() OVERRIDE;
135 virtual void RequestCallbackWhenBrandcodedDefaultsAreFetched(
136 const base::Closure& ready_callback) const OVERRIDE;
101 virtual scoped_ptr<base::ListValue> 137 virtual scoped_ptr<base::ListValue>
102 GetLoadedModuleNameDigests() const OVERRIDE; 138 GetLoadedModuleNameDigests() const OVERRIDE;
103 virtual scoped_ptr<base::DictionaryValue> 139 virtual scoped_ptr<base::DictionaryValue>
104 GetDefaultSearchProviderDetails() const OVERRIDE; 140 GetDefaultSearchProviderDetails() const OVERRIDE;
105 virtual bool IsDefaultSearchProviderManaged() const OVERRIDE; 141 virtual bool IsDefaultSearchProviderManaged() const OVERRIDE;
106 virtual scoped_ptr<base::ListValue> 142 virtual scoped_ptr<base::ListValue>
107 GetPrepopulatedSearchProvidersDetails() const OVERRIDE; 143 GetPrepopulatedSearchProvidersDetails() const OVERRIDE;
108 virtual void ShowPrompt() OVERRIDE; 144 virtual bool ShowPrompt() OVERRIDE;
145 virtual void TriggerProfileSettingsReset(
146 bool send_feedback,
147 const base::Closure& completion) OVERRIDE;
148 virtual void DismissPrompt() OVERRIDE;
109 149
110 // TemplateURLServiceObserver: 150 // TemplateURLServiceObserver:
111 virtual void OnTemplateURLServiceChanged() OVERRIDE; 151 virtual void OnTemplateURLServiceChanged() OVERRIDE;
112 152
113 // content::NotificationObserver: 153 // content::NotificationObserver:
114 virtual void Observe(int type, 154 virtual void Observe(int type,
115 const content::NotificationSource& source, 155 const content::NotificationSource& source,
116 const content::NotificationDetails& details) OVERRIDE; 156 const content::NotificationDetails& details) OVERRIDE;
117 157
118 private: 158 private:
159 // Sends a feedback |report|, where |report| is supposed to be result of
160 // ::SerializeSettingsReport(). Virtual, so it can be mocked out for tests.
161 virtual void SendFeedback(const std::string& report) const;
162
163 // Triggers the ProfileResetter to reset |resettable_aspects_| and optionally
164 // |send_feedback|. Will invoke |completion| on the UI thread once completed
165 // The |brandcoded_defaults_| must already be fetched when this is called.
166 void RunProfileSettingsReset(bool send_feedback,
167 const base::Closure& completion);
168
169 // Called by |brandcoded_config_fetcher_| when it finishes downloading the
170 // brandcoded default settings (or the download times out).
171 void OnBrandcodedDefaultsFetched();
172
173 // Called back by the ProfileResetter once resetting the profile settings has
174 // been completed. If |old_settings_snapshot| is non-NULL, will compare it to
175 // the new settings and send the differences to Google for analysis. Finally,
176 // will post |user_callback|.
177 void OnProfileSettingsResetCompleted(
178 const base::Closure& user_callback,
179 scoped_ptr<ResettableSettingsSnapshot> old_settings_snapshot);
180
181 Profile* profile_;
182 GlobalErrorService* global_error_service_;
119 TemplateURLService* template_url_service_; 183 TemplateURLService* template_url_service_;
120 184
185 scoped_ptr<BrandcodeConfigFetcher> brandcoded_config_fetcher_;
186 scoped_ptr<BrandcodedDefaultSettings> brandcoded_defaults_;
187
188 const ProfileResetter::ResettableFlags resettable_aspects_;
189 scoped_ptr<ProfileResetter> profile_resetter_;
190
121 content::NotificationRegistrar registrar_; 191 content::NotificationRegistrar registrar_;
122 192
123 // The list of modules found. Even when |modules_have_been_enumerated_event_| 193 // The list of modules found. Even when |modules_have_been_enumerated_event_|
124 // is signaled, this may still be NULL. 194 // is signaled, this may still be NULL.
125 scoped_ptr<base::ListValue> module_list_; 195 scoped_ptr<base::ListValue> module_list_;
126 196
127 // This event is signaled once module enumeration has been attempted. If 197 // This event is signaled once module enumeration has been attempted. If
128 // during construction, EnumerateModulesModel can supply a non-empty list of 198 // during construction, EnumerateModulesModel can supply a non-empty list of
129 // modules, module enumeration has clearly already happened, so the event will 199 // modules, module enumeration has clearly already happened, so the event will
130 // be signaled immediately; otherwise, when EnumerateLoadedModulesIfNeeded() 200 // be signaled immediately; otherwise, when EnumerateLoadedModulesIfNeeded()
131 // is called, it will ask the model to scan the modules, and then signal the 201 // is called, it will ask the model to scan the modules, and then signal the
132 // event once this process is completed. 202 // event once this process is completed.
133 extensions::OneShotEvent modules_have_been_enumerated_event_; 203 extensions::OneShotEvent modules_have_been_enumerated_event_;
134 204
135 // This event is signaled once the TemplateURLService has loaded. If the 205 // This event is signaled once the TemplateURLService has loaded. If the
136 // TemplateURLService was already loaded prior to the creation of this class, 206 // TemplateURLService was already loaded prior to the creation of this class,
137 // the event will be signaled during construction. 207 // the event will be signaled during construction.
138 extensions::OneShotEvent template_url_service_ready_event_; 208 extensions::OneShotEvent template_url_service_ready_event_;
139 209
210 // This event is signaled once brandcoded default settings have been
211 // downloaded, or it has been established that this is not a branded build.
212 extensions::OneShotEvent brandcoded_defaults_fetched_event_;
213
140 DISALLOW_COPY_AND_ASSIGN(AutomaticProfileResetterDelegateImpl); 214 DISALLOW_COPY_AND_ASSIGN(AutomaticProfileResetterDelegateImpl);
141 }; 215 };
142 216
143 #endif // CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H _ 217 #endif // CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H _
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698