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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
|
// Copyright 2020 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_PROFILES_PROFILE_PICKER_H_
#define CHROME_BROWSER_UI_PROFILES_PROFILE_PICKER_H_
#include <optional>
#include <variant>
#include "base/feature_list.h"
#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/functional/callback_forward.h"
#include "base/time/time.h"
#include "build/buildflag.h"
#include "components/signin/public/base/signin_buildflags.h"
#include "third_party/skia/include/core/SkColor.h"
#include "url/gurl.h"
class GURL;
class Profile;
namespace views {
class View;
class WebView;
} // namespace views
enum class StartupProfileModeReason;
class ForceSigninUIError;
class ProfilePicker {
public:
// This is used for logging, so do not remove or reorder existing entries.
enum class FirstRunExitStatus {
// The user completed the FRE and is continuing to launch the browser.
kCompleted = 0,
// `kQuitEarly = 1` used to be a lacros-only status. It has been removed
// but in order to keep backward compatibility, its value has been retired.
// The user finished the mandatory FRE steps but abandoned their task
// (closed the browser app).
kQuitAtEnd = 2,
// The user opens the first run again while it's still running.
kAbortTask = 3,
// The user does something that bypasses the FRE (opens new window etc..).
kAbandonedFlow = 4,
// Add any new values above this one, and update kMaxValue to the highest
// enumerator value.
kMaxValue = kAbandonedFlow
};
using FirstRunExitedCallback =
base::OnceCallback<void(FirstRunExitStatus status)>;
// Only work when passed as the argument 'on_select_profile_target_url' to
// ProfilePicker::Show.
static const char kTaskManagerUrl[];
// An entry point that triggers the profile picker window to open.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(EntryPoint)
enum class EntryPoint {
kOnStartup = 0,
kProfileMenuManageProfiles = 1,
kProfileMenuAddNewProfile = 2,
kOpenNewWindowAfterProfileDeletion = 3,
// A new session was started while Chrome was already running (e.g. by
// clicking on the tray icon on Windows).
kNewSessionOnExistingProcess = 4,
kProfileLocked = 5,
kUnableToCreateBrowser = 6,
kBackgroundModeManager = 7,
// `8` and `9` used to be lacros-only entry points. They has been removed
// but in order to keep backward compatibility, their values have been
// retired.
// The Profile became idle, due to the IdleProfileCloseTimeout policy.
kProfileIdle = 10,
// Opens the first run experience on desktop platforms to let the
// user sign in, opt in to sync, etc.
kFirstRun = 11,
// There was no usable profile on startup (e.g. the profiles were locked by
// force signin).
kOnStartupNoProfile = 12,
// There was no usable profile when starting a new session while Chrome is
// already running (e.g. the profiles were locked by force signin).
kNewSessionOnExistingProcessNoProfile = 13,
// Opens manage profile view from the app menu.
kAppMenuProfileSubMenuManageProfiles = 14,
// Opens the add new profile view from the app menu.
kAppMenuProfileSubMenuAddNewProfile = 15,
// Opens the Glic version of the Profile Picker
kGlicManager = 16,
kMaxValue = kGlicManager,
};
// LINT.ThenChange(/tools/metrics/histograms/metadata/profile/enums.xml:ProfilePickerEntryPoint)
class Params final {
public:
// Basic constructors and operators.
~Params();
Params(Params&&);
Params& operator=(Params&&);
Params(const Params&) = delete;
Params& operator=(const Params&) = delete;
// Basic constructor. Specifies only the entry point, and all other
// parameters have default values. Use specialized entry points when they
// are available (e.g. `ForBackgroundManager()`).
static Params FromEntryPoint(EntryPoint entry_point);
// Builds parameter with the `kBackgroundModeManager` entry point. Allows
// specifying extra parameters.
static Params ForBackgroundManager(
const GURL& on_select_profile_target_url);
EntryPoint entry_point() const { return entry_point_; }
// Returns the path to the profile to use to display the Web UI.
const base::FilePath& profile_path() const { return profile_path_; }
// May be non-empty only for the `kBackgroundModeManager` entry point.
const GURL& on_select_profile_target_url() const {
return on_select_profile_target_url_;
}
// Builds parameter with the `kFirstRun` (on Dice) entry point.
//
// `profile_path` is the profile for which to open the FRE.
// `first_run_exited_callback` is called when the first run experience is
// exited, with a `FirstRunExitStatus` indicating how the user responded to
// it.
static Params ForFirstRun(const base::FilePath& profile_path,
FirstRunExitedCallback first_run_exited_callback);
// Builds parameter with the `kForGlicManager` entry point.
//
// `picked_profile_callback` will be called when a Profile is selected
// (returning the loaded profile) or when the picker is closed (returning a
// nullptr profile).
static Params ForGlicManager(
base::OnceCallback<void(Profile*)> picked_profile_callback);
// Calls `first_run_exited_callback_`, forwarding `exit_status`.See
// `ForFirstRun()` for more details.
//
// If this method is not called by the time this `Param` is destroyed, an
// intent to quit will be assumed and `first_run_exited_callback_` will be
// called by the destructor with quit-related arguments.
void NotifyFirstRunExited(FirstRunExitStatus exit_status);
// Calls `picked_profile_callback_`, forwarding the `profile`. See
// `ForGlicManager()` for more details.
// This method will be called if the view/controller are destroyed without a
// profile being picked - the `profile` will be null in this case.
void NotifyProfilePicked(Profile* profile);
// Returns whether the current profile picker window can be reused for
// different parameters. If this returns false, the picker cannot be reused
// and must be closed and repoen.
bool CanReusePickerWindow(const Params& other) const;
private:
// Constructor is private, use static functions instead.
explicit Params(EntryPoint entry_point, const base::FilePath& profile_path);
EntryPoint entry_point_ = EntryPoint::kOnStartup;
GURL on_select_profile_target_url_;
base::FilePath profile_path_;
FirstRunExitedCallback first_run_exited_callback_;
base::OnceCallback<void(Profile*)> picked_profile_callback_;
};
// Values for the ProfilePickerOnStartupAvailability policy. Should not be
// re-numbered. See components/policy/resources/policy_templates.json for
// documentation.
enum class AvailabilityOnStartup {
kEnabled = 0,
kDisabled = 1,
kForced = 2,
kMax = kForced
};
ProfilePicker(const ProfilePicker&) = delete;
ProfilePicker& operator=(const ProfilePicker&) = delete;
// Shows the Profile picker for the given `Params` or re-activates an existing
// one (see `Params::ForAccountSelecAvailableAccount()` for details on
// re-activation). When reactivated, the displayed page is not updated.
static void Show(Params&& params);
#if BUILDFLAG(ENABLE_DICE_SUPPORT)
// Helper struct to allow passing different profile information for sign in:
// - An optional color for a new profile.
// - A file path for an existing profile.
using ProfileInfo = std::variant<std::optional<SkColor>, base::FilePath>;
// Starts the Dice sign-in flow. The layout of the window gets updated for the
// sign-in flow while the profiles are created/loaded.
// The sign in flow can be triggered for a new or existing profile.
// For new profiles, the expected color is expected to be given as the
// `profile_info` param. The creation of the new profile happens and then the
// sign-in page is rendered using the new profile. The new profile uses a
// theme generated from the given profile color if provided or the default
// theme.
// For an existing profile, the profile path is expected to given as the
// `profile_info` param. The profile is loaded then the sign-page will be
// rendered with the profile.
// `switch_finished_callback` gets informed whether the creation of the new
// profile succeeded and the sign-in page gets displayed.
static void SwitchToDiceSignIn(
ProfileInfo profile_info,
base::OnceCallback<void(bool)> switch_finished_callback);
// Starts the reauth for the existing primary account in the given `profile`.
// The flow will remain within the profile picker. The reauth is expected to
// be done only on the primary account, if done on another one (the UI may
// allow it), the reauth will fail and the signed in account will be signed
// out.
// On successful reauth, the profile is unlocked and a browser associated with
// the `profile` will be opened. On unsuccessful reauth, the user will be
// redirected to the profile picker main page, with a popup error dialog
// displayed through `on_error_callback`.
// `switch_finished_callback` will be called once the step was switched (or
// failed to switch to), the bool parameter indicating the success of the
// switch.
static void SwitchToReauth(
Profile* profile,
base::OnceCallback<void(bool)> switch_finished_callback,
base::OnceCallback<void(const ForceSigninUIError&)> on_error_callback);
#endif
// Switch to the flow that comes when the user decides to create a profile
// without signing in.
// `profile_color` is the profile's color. It is undefined for the default
// theme.
static void SwitchToSignedOutPostIdentityFlow(
std::optional<SkColor> profile_color);
struct ProfilePickingArgs {
// Opens the settings page of the profile once it is first picked.
bool open_settings = false;
// Whether we are recording timing metrics about loading the profile and
// opening the first web content.
bool should_record_startup_metrics = false;
};
// Picks the profile with `profile_path`.
// `pick_profile_complete_callback` will be called when a browser is opened
// with the profile associated with `profile_path`, the boolean parameter
// returning whether a browser was successfully opened or not.
static void PickProfile(
const base::FilePath& profile_path,
ProfilePickingArgs args,
base::OnceCallback<void(bool)> pick_profile_complete_callback);
// Cancel the signed-in flow and returns back to the main picker screen (if
// the original EntryPoint was to open the picker). Must only be called from
// within the signed-in flow. This will delete the profile previously created
// for the signed-in flow.
static void CancelSignedInFlow();
// Returns the path of the default profile used for rendering the picker.
static base::FilePath GetPickerProfilePath();
// Getter of the path of profile which is displayed on the profile switch
// screen.
static base::FilePath GetSwitchProfilePath();
// Hides the profile picker.
static void Hide();
// Returns whether the profile picker is currently open.
static bool IsOpen();
// Returns whether the profile picker is currently open and showing the First
// Run Experience.
static bool IsFirstRunOpen();
// Returns whether the Profile picker is showing and active.
static bool IsActive();
// Returns the global profile picker view for testing.
static views::View* GetViewForTesting();
// Returns the web view (embedded in the picker) for testing.
static views::WebView* GetWebViewForTesting();
// Add a callback that will be called the next time the picker is opened.
static void AddOnProfilePickerOpenedCallbackForTesting(
base::OnceClosure callback);
// Overrides the timeout delay for waiting for extended account info.
static void SetExtendedAccountInfoTimeoutForTesting(base::TimeDelta timeout);
// Returns a pref value indicating whether the profile picker has ever been
// shown to the user.
static bool Shown();
// Returns whether to show profile picker at launch. This can be called on
// startup or when Chrome is re-opened, e.g. when clicking on the dock icon on
// MacOS when there are no windows, or from Windows tray icon.
static StartupProfileModeReason GetStartupModeReason();
};
#endif // CHROME_BROWSER_UI_PROFILES_PROFILE_PICKER_H_
|