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
|
// 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 ASH_IN_SESSION_AUTH_AUTH_DIALOG_CONTENTS_VIEW_H_
#define ASH_IN_SESSION_AUTH_AUTH_DIALOG_CONTENTS_VIEW_H_
#include <string>
#include "ash/ash_export.h"
#include "ash/public/cpp/login_types.h"
#include "base/memory/raw_ptr.h"
#include "ui/views/view.h"
namespace views {
class BoxLayout;
class Label;
class LabelButton;
class MdTextButton;
} // namespace views
namespace ash {
class AnimatedRoundedImageView;
class LoginPasswordView;
class LoginPinView;
class LoginPinInputView;
// Contains the debug views that allows the developer to interact with the
// AuthDialogController.
class AuthDialogContentsView : public views::View {
public:
// Flags which describe the set of currently visible auth methods.
enum AuthMethods {
kAuthNone = 0, // No auth methods.
kAuthPassword = 1 << 0, // Display password.
kAuthPin = 1 << 1, // Display PIN keyboard.
kAuthFingerprint = 1 << 2, // Use fingerprint to unlock.
};
// Extra control parameters to be passed when setting the auth methods.
struct AuthMethodsMetadata {
// User's pin length to use for autosubmit.
size_t autosubmit_pin_length = 0;
};
class ASH_EXPORT TestApi {
public:
explicit TestApi(AuthDialogContentsView* view);
~TestApi();
TestApi(const TestApi&) = delete;
TestApi& operator=(const TestApi&) = delete;
void PasswordOrPinAuthComplete(bool authenticated_by_pin,
bool success,
bool can_use_pin) const;
void FingerprintAuthComplete(bool success,
FingerprintState fingerprint_state) const;
raw_ptr<LoginPasswordView, ExperimentalAsh> GetPasswordView() const;
raw_ptr<LoginPasswordView, ExperimentalAsh> GetPinTextInputView() const;
private:
const raw_ptr<AuthDialogContentsView, ExperimentalAsh> view_;
};
AuthDialogContentsView(uint32_t auth_methods,
const std::string& origin_name,
const AuthMethodsMetadata& auth_metadata,
const UserAvatar& avatar);
AuthDialogContentsView(const AuthDialogContentsView&) = delete;
AuthDialogContentsView& operator=(const AuthDialogContentsView&) = delete;
~AuthDialogContentsView() override;
// views::Views:
void GetAccessibleNodeData(ui::AXNodeData* node_data) override;
void RequestFocus() override;
uint32_t auth_methods() const { return auth_methods_; }
private:
class TitleLabel;
class FingerprintView;
// views::View:
void AddedToWidget() override;
// Add a view for user avatar.
void AddAvatarView(const UserAvatar& avatar);
// Add a view for dialog title.
void AddTitleView();
// Add a view that shows which website/app we are authenticating for.
void AddOriginNameView();
// Add a view for entering PIN (if autosubmit is off).
void AddPinTextInputView();
// Add a view for entering password.
void AddPasswordView();
// Add a PIN pad view.
void AddPinPadView();
// Add a PIN input view that automatically submits PIN.
void AddPinDigitInputView();
// Add a vertical spacing view.
void AddVerticalSpacing(int height);
// Add a view for action buttons.
void AddActionButtonsView();
// Called when the user taps a digit on the PIN pad.
void OnInsertDigitFromPinPad(int digit);
// Called when the user taps backspace on the PIN pad.
void OnBackspaceFromPinPad();
// Called when either:
// 1. the user inserts or deletes a character in
// |pin_text_input_view_| or |pin_digit_input_view_| without using the PIN
// pad, or
// 2. the user inserts or deletes a character in |password_view_|, or
// 3. contents of |pin_text_input_view_|, |password_view_|, or
// |pin_digit_input_view_| are cleared by a Reset() call.
void OnInputTextChanged(bool is_empty);
// Called when the user submits password or PIN. If authenticated_by_pin is
// false, the user authenticated by password.
void OnAuthSubmit(bool authenticated_by_pin, const std::u16string& password);
// Called when password or PIN authentication of the user completes. If
// authenticated_by_pin is false, the user authenticated by password.
// |can_use_pin| specifies whether PIN is available after the authentication,
// as it might be locked out.
void OnPasswordOrPinAuthComplete(bool authenticated_by_pin,
bool success,
bool can_use_pin);
// Called when fingerprint authentication completes.
void OnFingerprintAuthComplete(bool success,
FingerprintState fingerprint_state);
// Called when the cancel button is pressed.
void OnCancelButtonPressed(const ui::Event& event);
// Called when the "Need help?" button is pressed.
void OnNeedHelpButtonPressed(const ui::Event& event);
// Debug container which holds the entire debug UI.
raw_ptr<views::View, ExperimentalAsh> container_ = nullptr;
// Layout for |container_|.
raw_ptr<views::BoxLayout, ExperimentalAsh> main_layout_ = nullptr;
// User avatar to indicate this is an OS dialog.
raw_ptr<AnimatedRoundedImageView, ExperimentalAsh> avatar_view_ = nullptr;
// Title of the auth dialog, also used to show PIN auth error message..
raw_ptr<TitleLabel, ExperimentalAsh> title_ = nullptr;
// Prompt message to the user.
raw_ptr<views::Label, ExperimentalAsh> origin_name_view_ = nullptr;
// Whether PIN can be auto submitted.
bool pin_autosubmit_on_ = false;
// Whether PIN is locked out.
bool pin_locked_out_ = false;
// Text input field for PIN if PIN cannot be auto submitted.
raw_ptr<LoginPasswordView, ExperimentalAsh> pin_text_input_view_ = nullptr;
// PIN input view that's shown if PIN can be auto submitted.
raw_ptr<LoginPinInputView, ExperimentalAsh> pin_digit_input_view_ = nullptr;
// Text input field for password.
raw_ptr<LoginPasswordView, ExperimentalAsh> password_view_ = nullptr;
// PIN pad view.
raw_ptr<LoginPinView, ExperimentalAsh> pin_pad_view_ = nullptr;
raw_ptr<FingerprintView, ExperimentalAsh> fingerprint_view_ = nullptr;
// A button to cancel authentication and close the dialog.
raw_ptr<views::MdTextButton, ExperimentalAsh> cancel_button_ = nullptr;
// A button to show a help center article.
raw_ptr<views::LabelButton, ExperimentalAsh> help_button_ = nullptr;
// Flags of auth methods that should be visible.
uint32_t auth_methods_ = 0u;
const std::string origin_name_;
// Extra parameters to control the UI.
AuthMethodsMetadata auth_metadata_;
// Container which holds action buttons.
raw_ptr<views::View, ExperimentalAsh> action_view_container_ = nullptr;
base::WeakPtrFactory<AuthDialogContentsView> weak_factory_{this};
};
} // namespace ash
#endif // ASH_IN_SESSION_AUTH_AUTH_DIALOG_CONTENTS_VIEW_H_
|