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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_VIEWS_PROFILES_PROFILE_MANAGEMENT_FLOW_CONTROLLER_H_
#define CHROME_BROWSER_UI_VIEWS_PROFILES_PROFILE_MANAGEMENT_FLOW_CONTROLLER_H_
#include <string>
#include "base/containers/flat_map.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/ui/profiles/profile_picker.h"
#include "chrome/browser/ui/views/profiles/profile_management_types.h"
#include "chrome/browser/ui/views/profiles/profile_picker_web_contents_host.h"
#include "content/public/browser/web_contents.h"
class Profile;
class ProfileManagementStepController;
class ProfilePickerWebContentsHost;
// Represents an abstract user facing flow related to profile management.
//
// A profile management flow is made of a series of steps, implemented as
// `ProfileManagementStepController`s and owned by this object.
//
// Typical usage starts with calling `Init()` on the instantiated flow, which
// will register and switch to the first step. Then as the user interacts with
// the flow, this controller will handle instantiating and navigating between
// the next steps.
class ProfileManagementFlowController {
public:
// TODO(crbug.com/40237131): Split the steps more granularly across
// logical steps instead of according to implementation details.
enum class Step {
kUnknown,
// Renders the `chrome://profile-picker` app, covering the profile picker,
// the profile type choice at the beginning of the profile creation
// flow and the account selection.
kProfilePicker,
#if BUILDFLAG(ENABLE_DICE_SUPPORT)
// Renders the sign in screen on Dice platforms.
kAccountSelection,
// Moves the rest of the flow to a browser tab so that the user can complete
// the SAML sign in they started at the previous step.
kFinishSamlSignin,
// Renders the reauth page.
kReauth,
#endif
// Renders all post-sign in screens: enterprise management consent, profile
// switch, sync opt-in, etc.
kPostSignInFlow,
// Renders the beginning of the First Run Experience.
kIntro,
// Renders a default browser promo.
kDefaultBrowser,
// Renders the search engine choice screen.
kSearchEngineChoice,
kFinishFlow,
};
// Creates a flow controller that will start showing UI when `Init()`-ed.
// `clear_host_callback` will be called if `host` needs to be closed.
explicit ProfileManagementFlowController(
ProfilePickerWebContentsHost* host,
ClearHostClosure clear_host_callback);
virtual ~ProfileManagementFlowController();
// Starts the flow by registering and switching to the first step.
virtual void Init() = 0;
// Instructs a step registered as `step` to be shown.
// If `step_switch_finished_callback` is provided, it will be called
// with `true` when the navigation to `step` succeeded, or with
// `false` otherwise.
// Also see `ProfileManagementStepController::Show()`.
void SwitchToStep(Step step,
bool reset_state,
StepSwitchFinishedCallback step_switch_finished_callback =
StepSwitchFinishedCallback(),
base::OnceClosure pop_step_callback = base::OnceClosure());
void OnNavigateBackRequested();
#if BUILDFLAG(ENABLE_DICE_SUPPORT)
void OnReloadRequested();
#endif
// Cancel the signed-in profile setup and returns back to the main picker
// screen (if the original EntryPoint was to open the picker).
virtual void CancelPostSignInFlow() = 0;
// Picks the profile with `profile_path`.
virtual void PickProfile(const base::FilePath& profile_path,
ProfilePicker::ProfilePickingArgs args) = 0;
// Clears the current state and reset it to the initial state that shows the
// main screen. When calling this function the state should not be the
// initial one. Executes `callback` when the initial state is shown.
void Reset(StepSwitchFinishedCallback callback);
// Returns a string to use as title for the window, for accessibility
// purposes. It is used in case the host is not able to obtain a title from
// the content it's rendering. As a final fallback, if this value is empty
// (which is the default), the host will choose itself some generic title.
virtual std::u16string GetFallbackAccessibleWindowTitle() const;
// A helper method to create a pop callback that will switch to the given
// step (can be used with `current_step()` to facilitate switching back to the
// current active step).
base::OnceClosure CreateSwitchToStepPopCallback(Step step);
protected:
void RegisterStep(Step step,
std::unique_ptr<ProfileManagementStepController>);
void UnregisterStep(Step step);
bool IsStepInitialized(Step step) const;
// Checks whether the flow has already attempted to exit.
bool HasFlowExited() const;
// Closes the flow, calling `clear_host_callback_`, which would cause the
// `host()` to be deleted.
void ExitFlow();
// Opens a browser window for `profile`, closes the flow and then runs
// `callback` (if it's non-null).
//
// Since the flow and its host will be destroyed by the time `callback` runs,
// it should be longer lived than these.
void FinishFlowAndRunInBrowser(Profile* profile,
PostHostClearedCallback callback);
// Will be called at the beginning of `FinishFlowAndRunInBrowser`.
//
// Subclasses should override it if they want to perform some additional
// operations when the flow is closing. If they are going to open a browser
// themselves, they should return `true`. The default implementation does
// nothing and returns `false`.
virtual bool PreFinishWithBrowser();
Step current_step() const { return current_step_; }
ProfilePickerWebContentsHost* host() { return host_; }
// Creates the web contents associated with `profile` and stores them in
// `signed_out_flow_web_contents_`.
void CreateSignedOutFlowWebContents(Profile* profile);
// Returns a pointer to `signed_out_flow_web_contents_`.
content::WebContents* GetSignedOutFlowWebContents() const;
private:
// Called after a browser is open. Clears the host and then runs the callback.
void CloseHostAndRunCallback(
PostHostClearedCallback post_host_cleared_callback,
Browser* browser);
Step current_step_ = Step::kUnknown;
// The signed out flow web contents are used in some steps inside
// `initialized_steps_`. They have to be destroyed after `initialized_steps_`.
std::unique_ptr<content::WebContents> signed_out_flow_web_contents_;
raw_ptr<ProfilePickerWebContentsHost> host_;
ClearHostClosure clear_host_callback_;
base::flat_map<Step, std::unique_ptr<ProfileManagementStepController>>
initialized_steps_;
base::WeakPtrFactory<ProfileManagementFlowController> weak_factory_{this};
};
#endif // CHROME_BROWSER_UI_VIEWS_PROFILES_PROFILE_MANAGEMENT_FLOW_CONTROLLER_H_
|
