Chromium Code Reviews| OLD | NEW |
|---|---|
| (Empty) | |
| 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 | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H_ | |
| 6 #define CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H_ | |
| 7 | |
| 8 #include "base/basictypes.h" | |
| 9 #include "base/callback_forward.h" | |
| 10 #include "base/memory/scoped_ptr.h" | |
| 11 #include "chrome/browser/search_engines/template_url_service_observer.h" | |
| 12 #include "content/public/browser/notification_observer.h" | |
| 13 #include "content/public/browser/notification_registrar.h" | |
| 14 #include "extensions/common/one_shot_event.h" | |
| 15 | |
| 16 class TemplateURLService; | |
| 17 | |
| 18 namespace base { | |
| 19 class DictionaryValue; | |
| 20 class ListValue; | |
| 21 } | |
| 22 | |
| 23 // Defines the interface for the delegate that will interact with the rest of | |
| 24 // the browser on behalf of the AutomaticProfileResetter. | |
| 25 // The primary reason for this separation is to facilitate unit testing. | |
| 26 class AutomaticProfileResetterDelegate { | |
| 27 public: | |
| 28 virtual ~AutomaticProfileResetterDelegate() {} | |
| 29 | |
| 30 // Requests the module enumerator to start scanning for loaded modules now, if | |
| 31 // it has not done so already. | |
| 32 virtual void EnumerateLoadedModulesIfNeeded() = 0; | |
| 33 | |
| 34 // Requests |ready_callback| to be posted on the UI thread once the module | |
| 35 // enumerator has finished scanning for loaded modules. | |
| 36 virtual void RequestCallbackWhenLoadedModulesAreEnumerated( | |
| 37 const base::Closure& ready_callback) const = 0; | |
| 38 | |
| 39 // Requests the template URL service to load its database (asynchronously). | |
| 40 virtual void LoadTemplateURLServiceIfNeeded() = 0; | |
| 41 | |
| 42 // Requests |ready_callback| to be posted on the UI thread once the template | |
| 43 // URL service has finished loading its database. | |
| 44 virtual void RequestCallbackWhenTemplateURLServiceIsLoaded( | |
| 45 const base::Closure& ready_callback) const = 0; | |
| 46 | |
| 47 // Returns a list of loaded module name digests. | |
| 48 virtual scoped_ptr<base::ListValue> GetLoadedModuleNameDigests() const = 0; | |
| 49 | |
| 50 // Returns attributes of the search engine currently set as the default (or | |
| 51 // an empty dictionary if there is none). | |
| 52 // The returned attributes correspond in meaning and format to the user | |
| 53 // preferences stored by TemplateURLService::SaveDefaultSearchProviderToPrefs, | |
| 54 // and will be named after the second path name segment of the respective | |
| 55 // preference (i.e. the part after "default_search_provider."). | |
| 56 // Note that: | |
| 57 // 1.) the "enabled" attribute will not be present, as it is not technically | |
| 58 // an attribute of a search provider, | |
| 59 // 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. | |
| 61 virtual scoped_ptr<base::DictionaryValue> | |
| 62 GetDefaultSearchProviderDetails() const = 0; | |
| 63 | |
| 64 // Returns whether or not the default search provider is set by policy. | |
| 65 virtual bool IsDefaultSearchProviderManaged() const = 0; | |
| 66 | |
| 67 // Returns a list of dictionaries, each containing attributes for each of the | |
| 68 // pre-populated search engines, in the format described above. | |
| 69 virtual scoped_ptr<base::ListValue> | |
| 70 GetPrepopulatedSearchProvidersDetails() const = 0; | |
| 71 | |
| 72 // Triggers showing the one-time profile settings reset prompt. | |
| 73 virtual void ShowPrompt() = 0; | |
| 74 }; | |
| 75 | |
| 76 // 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 | |
| 80 : public AutomaticProfileResetterDelegate, | |
| 81 public TemplateURLServiceObserver, | |
| 82 public content::NotificationObserver { | |
| 83 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 // * GetDefaultSerachProviderDetails(), | |
|
robertshield
2013/10/24 00:36:33
Serach -> Search
engedy
2013/10/24 09:23:36
Done.
| |
| 88 // * GetPrepopulatedSearchProvidersDetails(), or | |
| 89 // * IsDefaultSearchManaged(). | |
| 90 explicit AutomaticProfileResetterDelegateImpl( | |
| 91 TemplateURLService* template_url_service); | |
| 92 virtual ~AutomaticProfileResetterDelegateImpl(); | |
| 93 | |
| 94 // AutomaticProfileResetterDelegate: | |
| 95 virtual void EnumerateLoadedModulesIfNeeded() OVERRIDE; | |
| 96 virtual void RequestCallbackWhenLoadedModulesAreEnumerated( | |
| 97 const base::Closure& ready_callback) const OVERRIDE; | |
| 98 virtual void LoadTemplateURLServiceIfNeeded() OVERRIDE; | |
| 99 virtual void RequestCallbackWhenTemplateURLServiceIsLoaded( | |
| 100 const base::Closure& ready_callback) const OVERRIDE; | |
| 101 virtual scoped_ptr<base::ListValue> | |
| 102 GetLoadedModuleNameDigests() const OVERRIDE; | |
| 103 virtual scoped_ptr<base::DictionaryValue> | |
| 104 GetDefaultSearchProviderDetails() const OVERRIDE; | |
| 105 virtual bool IsDefaultSearchProviderManaged() const OVERRIDE; | |
| 106 virtual scoped_ptr<base::ListValue> | |
| 107 GetPrepopulatedSearchProvidersDetails() const OVERRIDE; | |
| 108 virtual void ShowPrompt() OVERRIDE; | |
| 109 | |
| 110 // TemplateURLServiceObserver: | |
| 111 virtual void OnTemplateURLServiceChanged() OVERRIDE; | |
| 112 | |
| 113 // content::NotificationObserver: | |
| 114 virtual void Observe(int type, | |
| 115 const content::NotificationSource& source, | |
| 116 const content::NotificationDetails& details) OVERRIDE; | |
| 117 | |
| 118 private: | |
| 119 TemplateURLService* template_url_service_; | |
| 120 | |
| 121 content::NotificationRegistrar registrar_; | |
| 122 | |
| 123 // The list of modules found. Even when |modules_have_been_enumerated_event_| | |
| 124 // is signaled, this may still be NULL. | |
| 125 scoped_ptr<base::ListValue> module_list_; | |
| 126 | |
| 127 // This event is signaled once module enumeration has been attempted. If | |
| 128 // during construction, EnumerateModulesModel can supply a non-empty list of | |
| 129 // modules, module enumeration has clearly already happened, so the event will | |
| 130 // be signaled immediately; otherwise, when EnumerateLoadedModulesIfNeeded() | |
| 131 // is called, it will ask the model to scan the modules, and then signal the | |
| 132 // event once this process is completed. | |
| 133 extensions::OneShotEvent modules_have_been_enumerated_event_; | |
| 134 | |
| 135 // This event is signaled once the TemplateURLService has loaded. If the | |
| 136 // TemplateURLService was already loaded prior to the creation of this class, | |
| 137 // the event will be signaled during construction. | |
| 138 extensions::OneShotEvent template_url_service_ready_event_; | |
| 139 | |
| 140 DISALLOW_COPY_AND_ASSIGN(AutomaticProfileResetterDelegateImpl); | |
| 141 }; | |
| 142 | |
| 143 #endif // CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_DELEGATE_H _ | |
| OLD | NEW |