// 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_PASSWORD_MANAGER_ANDROID_SAVE_UPDATE_PASSWORD_MESSAGE_DELEGATE_H_
#define CHROME_BROWSER_PASSWORD_MANAGER_ANDROID_SAVE_UPDATE_PASSWORD_MESSAGE_DELEGATE_H_
#include <memory>
#include <optional>
#include "base/functional/callback.h"
#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/password_edit_dialog/android/password_edit_dialog_bridge.h"
#include "chrome/browser/password_manager/android/local_passwords_migration_warning_util.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/passwords/manage_passwords_state.h"
#include "components/browser_ui/device_lock/android/device_lock_bridge.h"
#include "components/messages/android/message_enums.h"
#include "components/messages/android/message_wrapper.h"
#include "components/password_manager/core/browser/password_form_manager_for_ui.h"
#include "components/password_manager/core/browser/password_manager_metrics_util.h"
#include "components/signin/public/identity_manager/account_info.h"
namespace content {
class WebContents;
} // namespace content
namespace password_manager {
class PasswordManagerClient;
} // namespace password_manager
// This class provides simplified interface for ChromePasswordManagerClient to
// display a prompt to save and update password through Messages API. The class
// is responsible for populating message properties, managing message's
// lifetime, saving password form in response to user interactions and recording
// metrics.
class SaveUpdatePasswordMessageDelegate
: public PasswordEditDialogBridgeDelegate {
public:
using PasswordEditDialogFactory =
base::RepeatingCallback<std::unique_ptr<PasswordEditDialog>(
content::WebContents*,
PasswordEditDialogBridgeDelegate*)>;
SaveUpdatePasswordMessageDelegate();
~SaveUpdatePasswordMessageDelegate() override;
// Test-only constructor. Allows test class to set device_lock_bridge_.
SaveUpdatePasswordMessageDelegate(
base::PassKey<class SaveUpdatePasswordMessageDelegateTest>,
PasswordEditDialogFactory password_edit_dialog_factory,
base::RepeatingCallback<void(
gfx::NativeWindow,
Profile*,
password_manager::metrics_util::PasswordMigrationWarningTriggers)>
password_migration_warning_bridge_callback,
std::unique_ptr<DeviceLockBridge> device_lock_bridge);
// Displays a "Save password" message for current |web_contents| and
// |form_to_save|.
void DisplaySaveUpdatePasswordPrompt(
content::WebContents* web_contents,
std::unique_ptr<password_manager::PasswordFormManagerForUI> form_to_save,
bool update_password,
password_manager::PasswordManagerClient* password_manager_client);
// Dismisses currently displayed message or dialog. Because the implementation
// uses some of the dependencies (e.g. log manager) this method needs to be
// called before the object is destroyed.
void DismissSaveUpdatePasswordPrompt();
// Implementation of PasswordEditDialogBridgeDelegate interface.
void HandleDialogDismissed(bool dialogAccepted) override;
void HandleSavePasswordFromDialog(const std::u16string& username,
const std::u16string& password) override;
bool IsUsingAccountStorage(const std::u16string& username) override;
private:
friend class SaveUpdatePasswordMessageDelegateTest;
enum class SavePasswordDialogMenuItem { kNeverSave = 0, kEditPassword = 1 };
SaveUpdatePasswordMessageDelegate(
PasswordEditDialogFactory password_edit_dialog_factory,
base::RepeatingCallback<void(
gfx::NativeWindow,
Profile*,
password_manager::metrics_util::PasswordMigrationWarningTriggers)>
password_migration_warning_bridge_callback);
void DismissSaveUpdatePasswordMessage(messages::DismissReason dismiss_reason);
void DisplaySaveUpdatePasswordPromptInternal(
content::WebContents* web_contents,
std::unique_ptr<password_manager::PasswordFormManagerForUI> form_to_save,
std::optional<AccountInfo> account_info,
bool update_password,
password_manager::PasswordManagerClient* password_manager_client);
void CreateMessage(bool update_password);
void SetupCogMenu(std::unique_ptr<messages::MessageWrapper>& message,
bool update_password);
void HandleSaveMessageMenuItemClick(int item_id);
// Returns the message description depending on whether the password is being
// saved or updated.
std::u16string GetMessageDescription(
const password_manager::PasswordForm& pending_credentials,
bool update_password);
// Gets account name or email that should be displayed in the description
// messages. Returns a nullopt if account info should not be displayed.
std::optional<std::string> GetAccountForMessageDescription(
const std::optional<AccountInfo>& account_info);
// Returns string id for the message primary button. Takes into account
// whether this is save or update password scenario and whether the update
// message will be followed by a username confirmation dialog.
int GetPrimaryButtonTextId(bool update_password,
bool use_followup_button_text);
// Populates |usernames| with the list of usernames from best saved matches to
// be presented to the user in a dropdown.
// Returns the vector index of the currently pending username in
// the form manager.
unsigned int GetDisplayUsernames(std::vector<std::u16string>* usernames);
// Following methods handle events associated with user interaction with UI.
void HandleSaveButtonClicked();
void HandleNeverSaveClicked();
void HandleUpdateButtonClicked();
void DisplayEditDialog(bool update_password);
void HandleMessageDismissed(messages::DismissReason dismiss_reason);
bool HasMultipleCredentialsStored();
void CreatePasswordEditDialog();
void ClearState();
void RecordMessageShownMetrics();
void RecordDismissalReasonMetrics(
password_manager::metrics_util::UIDismissalReason ui_dismissal_reason);
static password_manager::metrics_util::UIDismissalReason
MessageDismissReasonToPasswordManagerUIDismissalReason(
messages::DismissReason dismiss_reason);
void MaybeNudgeToUpdateGmsCore();
PasswordEditDialogFactory password_edit_dialog_factory_;
raw_ptr<content::WebContents> web_contents_ = nullptr;
// Can be a nullopt, the account email, or the account full name.
std::optional<std::string> account_email_;
bool update_password_ = false;
// ManagePasswordsState maintains the password form that is being
// saved/updated. It provides helper functions for populating username list.
ManagePasswordsState passwords_state_;
std::unique_ptr<messages::MessageWrapper> message_;
std::unique_ptr<PasswordEditDialog> password_edit_dialog_;
base::RepeatingCallback<void(
gfx::NativeWindow,
Profile*,
password_manager::metrics_util::PasswordMigrationWarningTriggers)>
create_migration_warning_callback_;
std::unique_ptr<DeviceLockBridge> device_lock_bridge_;
void SavePassword();
void SavePasswordAfterDeviceLockUi(bool is_device_lock_set);
base::WeakPtrFactory<SaveUpdatePasswordMessageDelegate> weak_ptr_factory_{
this};
};
#endif // CHROME_BROWSER_PASSWORD_MANAGER_ANDROID_SAVE_UPDATE_PASSWORD_MESSAGE_DELEGATE_H_
Codebase Browser
chromium