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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
// Copyright (c) 2012 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 CHROME_BROWSER_UI_WEBUI_SYNC_SETUP_HANDLER_H_
#define CHROME_BROWSER_UI_WEBUI_SYNC_SETUP_HANDLER_H_
#include "base/gtest_prod_util.h"
#include "base/memory/scoped_ptr.h"
#include "chrome/browser/signin/signin_tracker.h"
#include "chrome/browser/ui/webui/options2/options_ui2.h"
#include "chrome/browser/ui/webui/signin/login_ui_service.h"
class LoginUIService;
class ProfileManager;
class ProfileSyncService;
class SigninManager;
class SyncSetupHandler : public options2::OptionsPageUIHandler,
public SigninTracker::Observer,
public LoginUIService::LoginUI {
public:
// Constructs a new SyncSetupHandler. |profile_manager| may be NULL.
explicit SyncSetupHandler(ProfileManager* profile_manager);
virtual ~SyncSetupHandler();
// OptionsPageUIHandler implementation.
virtual void GetLocalizedValues(base::DictionaryValue* localized_strings)
OVERRIDE;
virtual void RegisterMessages() OVERRIDE;
// SigninTracker::Observer implementation.
virtual void GaiaCredentialsValid() OVERRIDE;
virtual void SigninFailed(const GoogleServiceAuthError& error) OVERRIDE;
virtual void SigninSuccess() OVERRIDE;
// LoginUIService::LoginUI implementation.
virtual void FocusUI() OVERRIDE;
virtual void CloseUI() OVERRIDE;
static void GetStaticLocalizedValues(
base::DictionaryValue* localized_strings,
content::WebUI* web_ui);
// Initializes the sync setup flow and shows the setup UI. If |force_login| is
// true, then the user is forced through the login flow even if they are
// already signed in (useful for when we need to force the user to re-enter
// credentials so we can fetch new tokens).
void OpenSyncSetup(bool force_login);
// Terminates the sync setup flow.
void CloseSyncSetup();
// Displays an error message to the user due to an unrecoverable error during
// sync setup.
void ShowFatalError();
protected:
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, GaiaErrorInitializingSync);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, HandleCaptcha);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, HandleGaiaAuthFailure);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, SelectCustomEncryption);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, SuccessfullySetPassphrase);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, TestSyncEverything);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, TestSyncAllManually);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, TestPassphraseStillRequired);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, TestSyncIndividualTypes);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, TurnOnEncryptAll);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest,
UnrecoverableErrorInitializingSync);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, UnsuccessfullySetPassphrase);
FRIEND_TEST_ALL_PREFIXES(SyncSetupHandlerTest, SubmitAuthWithInvalidUsername);
// Subclasses must implement this to show the setup UI that's appropriate
// for the page this is contained in.
virtual void ShowSetupUI() = 0;
// Overridden by subclasses (like SyncPromoHandler) to log stats about the
// user's signin activity.
virtual void RecordSignin();
// Display the configure sync UI. If |show_advanced| is true, we skip directly
// to the "advanced settings" dialog, otherwise we give the user the simpler
// "Sync Everything" dialog. Overridden by subclasses to allow them to skip
// the sync setup dialog if desired.
// If |passphrase_failed| is true, then the user previously tried to enter an
// invalid passphrase.
virtual void DisplayConfigureSync(bool show_advanced, bool passphrase_failed);
// Called when we are done configuring sync (so we want to close the dialog
// and start syncing).
void ConfigureSyncDone();
// Helper routine that gets the ProfileSyncService associated with the parent
// profile.
ProfileSyncService* GetSyncService() const;
private:
// Callbacks from the page.
void OnDidClosePage(const base::ListValue* args);
void HandleSubmitAuth(const base::ListValue* args);
void HandleConfigure(const base::ListValue* args);
void HandlePassphraseEntry(const base::ListValue* args);
void HandlePassphraseCancel(const base::ListValue* args);
void HandleAttachHandler(const base::ListValue* args);
void HandleShowErrorUI(const base::ListValue* args);
void HandleShowSetupUI(const base::ListValue* args);
void HandleStopSyncing(const base::ListValue* args);
// Helper routine that gets the Profile associated with this object (virtual
// so tests can override).
virtual Profile* GetProfile() const;
// Shows the GAIA login success page then exits.
void DisplayGaiaSuccessAndClose();
// Displays the GAIA login success page then transitions to sync setup.
void DisplayGaiaSuccessAndSettingUp();
// Displays the GAIA login form. If |fatal_error| is true, displays the fatal
// error UI.
void DisplayGaiaLogin(bool fatal_error);
// Displays the GAIA login form with a custom error message (used for errors
// like "email address already in use by another profile"). No message
// displayed if |error_message| is empty. Displays fatal error UI if
// |fatal_error| = true.
void DisplayGaiaLoginWithErrorMessage(const string16& error_message,
bool fatal_error);
// Instead of signing in, prepare requirements for showing the advanced
// configuration dialog.
void PrepareConfigDialog();
// Displays spinner-only UI indicating that something is going on in the
// background.
// TODO(kochi): better to show some message that the user can understand what
// is running in the background.
void DisplaySpinner();
// Returns true if we're the active login object.
bool IsActiveLogin() const;
// Initiates a login via the signin manager.
void TryLogin(const std::string& username,
const std::string& password,
const std::string& captcha,
const std::string& access_code);
// If a wizard already exists, focus it and return true.
bool FocusExistingWizardIfPresent();
// Invokes the javascript call to close the setup overlay.
void CloseOverlay();
// Returns true if the given login data is valid, false otherwise. If the
// login data is not valid then on return |error_message| will be set to a
// localized error message. Note, |error_message| must not be NULL.
bool IsLoginAuthDataValid(const std::string& username,
string16* error_message);
// Returns the SigninManager for the parent profile.
SigninManager* GetSignin() const;
// Returns the LoginUIService for the parent profile.
LoginUIService* GetLoginUIService() const;
// The SigninTracker object used to determine when the user has fully signed
// in (this requires waiting for various services to initialize and tracking
// errors from multiple sources). Should only be non-null while the login UI
// is visible.
scoped_ptr<SigninTracker> signin_tracker_;
// Set to true whenever the sync configure UI is visible. This is used so we
// can tell what stage of the setup wizard the user was in so we can update
// the UMA histograms in the case that the user cancels out.
bool configuring_sync_;
// Weak reference to the profile manager.
ProfileManager* const profile_manager_;
// Cache of the last name the client attempted to authenticate.
std::string last_attempted_user_email_;
// The error from the last signin attempt.
GoogleServiceAuthError last_signin_error_;
DISALLOW_COPY_AND_ASSIGN(SyncSetupHandler);
};
#endif // CHROME_BROWSER_UI_WEBUI_SYNC_SETUP_HANDLER_H_
|
