OLD | NEW |
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_H_ | 5 #ifndef CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_H_ |
6 #define CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_H_ | 6 #define CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
| 11 #include "base/memory/ref_counted.h" |
11 #include "base/memory/scoped_ptr.h" | 12 #include "base/memory/scoped_ptr.h" |
12 #include "base/memory/weak_ptr.h" | 13 #include "base/memory/weak_ptr.h" |
13 #include "base/strings/string_piece.h" | 14 #include "base/strings/string_piece.h" |
14 #include "base/values.h" | 15 #include "base/task_runner.h" |
15 #include "chrome/browser/profile_resetter/automatic_profile_resetter_mementos.h" | 16 #include "chrome/browser/profile_resetter/automatic_profile_resetter_mementos.h" |
16 #include "components/browser_context_keyed_service/browser_context_keyed_service
.h" | 17 #include "components/browser_context_keyed_service/browser_context_keyed_service
.h" |
17 | 18 |
| 19 class AutomaticProfileResetterDelegate; |
18 class Profile; | 20 class Profile; |
19 | 21 |
20 // Defines the interface for the delegate that will actually show the prompt | 22 namespace base { |
21 // and/or report statistics on behalf of the AutomaticProfileResetter. | 23 class DictionaryValue; |
22 // The primary reason for this separation is to facilitate unit testing. | 24 class ListValue; |
23 class AutomaticProfileResetterDelegate { | 25 } |
24 public: | |
25 virtual ~AutomaticProfileResetterDelegate() {} | |
26 | |
27 // Triggers showing the one-time profile settings reset prompt. | |
28 virtual void ShowPrompt() = 0; | |
29 | |
30 // Reports the given metrics through UMA. | |
31 virtual void ReportStatistics(uint32 satisfied_criteria_mask, | |
32 uint32 combined_status_mask) = 0; | |
33 }; | |
34 | 26 |
35 // This service becomes busy shortly after start-up, and is responsible for | 27 // This service becomes busy shortly after start-up, and is responsible for |
36 // evaluating if the criteria for showing the one-time profile reset prompt | 28 // evaluating if the criteria for showing the one-time profile reset prompt |
37 // are satisfied, and will potentially trigger the prompt, but only a single | 29 // are satisfied, and will potentially trigger the prompt, but only a single |
38 // time during the lifetime of a profile on disk (this is achieved by storing | 30 // time during the lifetime of a profile on disk (this is achieved by storing |
39 // "mementos"). All methods in this class shall be called on the UI thread. | 31 // "memento"-s, see "automatic_profile_resetter_mementos.h" for details). |
| 32 // All methods in this class shall be called on the UI thread. |
40 class AutomaticProfileResetter : public BrowserContextKeyedService { | 33 class AutomaticProfileResetter : public BrowserContextKeyedService { |
41 public: | 34 public: |
| 35 // Number of bits, and maximum value (exclusive) for the mask whose bits |
| 36 // indicate which of reset criteria were satisfied. |
| 37 static const size_t kSatisfiedCriteriaMaskNumberOfBits; |
| 38 static const uint32 kSatisfiedCriteriaMaskMaximumValue; |
| 39 |
| 40 // Number of bits, and maximum value (exclusive) for the mask whose bits |
| 41 // indicate if any of reset criteria were satisfied, and which of the mementos |
| 42 // were already present. |
| 43 static const size_t kCombinedStatusMaskNumberOfBits; |
| 44 static const uint32 kCombinedStatusMaskMaximumValue; |
| 45 |
42 explicit AutomaticProfileResetter(Profile* profile); | 46 explicit AutomaticProfileResetter(Profile* profile); |
43 virtual ~AutomaticProfileResetter(); | 47 virtual ~AutomaticProfileResetter(); |
44 | 48 |
45 // Initializes the service, and sets up the asynchronous evaluation flow. | 49 // Fires up the service by unleashing the asynchronous evaluation flow, unless |
46 // Called by AutomaticProfileResetterFactory. | 50 // the service has been already disabled in Initialize() or there is no |
47 void Initialize(); | 51 // |program_| to run (in which case the service also gets disabled). |
| 52 // Called by the AutomaticProfileResetterFactory. |
| 53 void Activate(); |
48 | 54 |
49 // Should be called after Initialize(). | 55 // Should be called before Activate(). |
50 void SetHashSeedForTesting(const base::StringPiece& hash_seed); | 56 void SetHashSeedForTesting(const base::StringPiece& hash_seed); |
51 | 57 |
52 // Should be called after Initialize(). | 58 // Should be called before Activate(). |
53 void SetProgramForTesting(const base::StringPiece& program); | 59 void SetProgramForTesting(const base::StringPiece& program); |
54 | 60 |
55 // Should be called after Initialize(). Takes ownership. | 61 // Should be called before Activate(). Takes ownership. |
56 void SetDelegateForTesting(AutomaticProfileResetterDelegate* delegate); | 62 void SetDelegateForTesting(AutomaticProfileResetterDelegate* delegate); |
57 | 63 |
| 64 // Should be called before Activate(). Sets the task runner to be used to post |
| 65 // task |PrepareEvaluationFlow| in a delayed manner. |
| 66 void SetTaskRunnerForWaitingForTesting( |
| 67 const scoped_refptr<base::TaskRunner>& task_runner); |
| 68 |
58 private: | 69 private: |
59 struct EvaluationResults; | 70 struct EvaluationResults; |
60 | 71 |
61 enum State { | 72 enum State { |
62 STATE_UNINITIALIZED, | 73 STATE_UNINITIALIZED, |
| 74 STATE_INITIALIZED, |
63 STATE_DISABLED, | 75 STATE_DISABLED, |
| 76 STATE_WAITING_ON_DEPENDENCIES, |
64 STATE_READY, | 77 STATE_READY, |
65 STATE_WORKING, | 78 STATE_WORKING, |
66 STATE_DONE | 79 STATE_DONE |
67 }; | 80 }; |
68 | 81 |
69 // Returns whether or not a dry-run shall be performed. | 82 // Initializes the service if it is enabled in the field trial, otherwise, |
70 bool ShouldPerformDryRun() const; | 83 // skips the initialization steps and also permanently disables the service. |
| 84 void Initialize(); |
71 | 85 |
72 // Returns whether or not a live-run shall be performed. | 86 // Prepares the asynchronous evaluation flow by requesting services that it |
73 bool ShouldPerformLiveRun() const; | 87 // depends on to make themselves ready. |
| 88 void PrepareEvaluationFlow(); |
| 89 |
| 90 // Called back by |resetter_delegate_| when the template URL service is ready. |
| 91 void OnTemplateURLServiceIsLoaded(); |
| 92 |
| 93 // Called back by |resetter_delegate_| when the loaded modules have been |
| 94 // enumerated. |
| 95 void OnLoadedModulesAreEnumerated(); |
| 96 |
| 97 // Invoked by the above two methods. Kicks off the actual evaluation flow. |
| 98 void OnDependencyIsReady(); |
74 | 99 |
75 // Begins the asynchronous evaluation flow, which will assess whether the | 100 // Begins the asynchronous evaluation flow, which will assess whether the |
76 // criteria for showing the reset prompt are met, whether we have already | 101 // criteria for showing the reset prompt are met, whether we have already |
77 // shown the prompt, and, in the end, will potentially trigger the prompt. | 102 // shown the prompt, and, in the end, will potentially trigger the prompt. |
78 void BeginEvaluationFlow(); | 103 void BeginEvaluationFlow(); |
79 | 104 |
80 // Called back by |memento_in_file_| once it has finished reading the value of | 105 // Called back by |memento_in_file_| once it has finished reading the value of |
81 // the file-based memento. Continues the evaluation flow with collecting state | 106 // the file-based memento. Continues the evaluation flow with collecting state |
82 // information and assembling it as the input for the evaluator program. | 107 // information and assembling it as the input for the evaluator program. |
83 void ContinueWithEvaluationFlow(const std::string& memento_value_in_file); | 108 void ContinueWithEvaluationFlow(const std::string& memento_value_in_file); |
(...skipping 12 matching lines...) Expand all Loading... |
96 static scoped_ptr<EvaluationResults> EvaluateConditionsOnWorkerPoolThread( | 121 static scoped_ptr<EvaluationResults> EvaluateConditionsOnWorkerPoolThread( |
97 const base::StringPiece& hash_seed, | 122 const base::StringPiece& hash_seed, |
98 const base::StringPiece& program, | 123 const base::StringPiece& program, |
99 scoped_ptr<base::DictionaryValue> program_input); | 124 scoped_ptr<base::DictionaryValue> program_input); |
100 | 125 |
101 // Called back when EvaluateConditionsOnWorkerPoolThread completes executing | 126 // Called back when EvaluateConditionsOnWorkerPoolThread completes executing |
102 // the program with |results|. Finishes the evaluation flow, and, based on the | 127 // the program with |results|. Finishes the evaluation flow, and, based on the |
103 // result, will potentially show the reset prompt. | 128 // result, will potentially show the reset prompt. |
104 void FinishEvaluationFlow(scoped_ptr<EvaluationResults> results); | 129 void FinishEvaluationFlow(scoped_ptr<EvaluationResults> results); |
105 | 130 |
| 131 // Reports the given metrics through UMA. Virtual, so it can be mocked out in |
| 132 // tests to verify that the correct value are being reported. |
| 133 virtual void ReportStatistics(uint32 satisfied_criteria_mask, |
| 134 uint32 combined_status_mask); |
| 135 |
106 // BrowserContextKeyedService overrides: | 136 // BrowserContextKeyedService overrides: |
107 virtual void Shutdown() OVERRIDE; | 137 virtual void Shutdown() OVERRIDE; |
108 | 138 |
109 Profile* profile_; | 139 Profile* profile_; |
110 | 140 |
111 State state_; | 141 State state_; |
| 142 bool enumeration_of_loaded_modules_ready_; |
| 143 bool template_url_service_ready_; |
112 | 144 |
113 base::StringPiece hash_seed_; | 145 base::StringPiece hash_seed_; |
114 base::StringPiece program_; | 146 base::StringPiece program_; |
115 | 147 |
116 PreferenceHostedPromptMemento memento_in_prefs_; | 148 PreferenceHostedPromptMemento memento_in_prefs_; |
117 LocalStateHostedPromptMemento memento_in_local_state_; | 149 LocalStateHostedPromptMemento memento_in_local_state_; |
118 FileHostedPromptMemento memento_in_file_; | 150 FileHostedPromptMemento memento_in_file_; |
119 | 151 |
120 scoped_ptr<AutomaticProfileResetterDelegate> delegate_; | 152 scoped_ptr<AutomaticProfileResetterDelegate> delegate_; |
| 153 scoped_refptr<base::TaskRunner> task_runner_for_waiting_; |
121 | 154 |
122 base::WeakPtrFactory<AutomaticProfileResetter> weak_ptr_factory_; | 155 base::WeakPtrFactory<AutomaticProfileResetter> weak_ptr_factory_; |
123 | 156 |
124 DISALLOW_COPY_AND_ASSIGN(AutomaticProfileResetter); | 157 DISALLOW_COPY_AND_ASSIGN(AutomaticProfileResetter); |
125 }; | 158 }; |
126 | 159 |
127 #endif // CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_H_ | 160 #endif // CHROME_BROWSER_PROFILE_RESETTER_AUTOMATIC_PROFILE_RESETTER_H_ |
OLD | NEW |