blob: d49be23802aceb5d4fb6f527204d9dc87f37818f [file] [log] [blame]
// Copyright 2014 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.
#include <memory>
#include <string>
#include <vector>
#include "base/callback_forward.h"
#include "base/i18n/rtl.h"
#include "base/memory/weak_ptr.h"
#include "base/strings/string16.h"
#include "base/values.h"
#include "components/autofill/core/browser/risk_data_loader.h"
#include "components/security_state/core/security_state.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "ui/base/window_open_disposition.h"
#include "url/gurl.h"
class PrefService;
namespace content {
class RenderFrameHost;
namespace gfx {
class RectF;
namespace identity {
class IdentityManager;
namespace syncer {
class SyncService;
namespace ukm {
class UkmRecorder;
namespace autofill {
class AddressNormalizer;
class AutofillPopupDelegate;
class AutofillProfile;
class AutofillWebDataService;
class CardUnmaskDelegate;
class CreditCard;
class FormStructure;
class PersonalDataManager;
struct Suggestion;
// A client interface that needs to be supplied to the Autofill component by the
// embedder.
// Each client instance is associated with a given context within which an
// AutofillManager is used (e.g. a single tab), so when we say "for the client"
// below, we mean "in the execution context the client is associated with" (e.g.
// for the tab the AutofillManager is attached to).
class AutofillClient : public RiskDataLoader {
enum PaymentsRpcResult {
// Empty result. Used for initializing variables and should generally
// not be returned nor passed as arguments unless explicitly allowed by
// the API.
// Request succeeded.
// Request failed; try again.
// Request failed; don't try again.
// Unable to connect to Payments servers. Prompt user to check internet
// connection.
enum UnmaskCardReason {
// The card is being unmasked for PaymentRequest.
// The card is being unmasked for Autofill.
typedef base::Callback<void(const CreditCard&)> CreditCardScanCallback;
~AutofillClient() override {}
// Gets the PersonalDataManager instance associated with the client.
virtual PersonalDataManager* GetPersonalDataManager() = 0;
// Gets the AutofillWebDataService instance associated with the client.
virtual scoped_refptr<AutofillWebDataService> GetDatabase() = 0;
// Gets the preferences associated with the client.
virtual PrefService* GetPrefs() = 0;
// Gets the sync service associated with the client.
virtual syncer::SyncService* GetSyncService() = 0;
// Gets the IdentityManager associated with the client.
virtual identity::IdentityManager* GetIdentityManager() = 0;
// Gets the UKM service associated with this client (for metrics).
virtual ukm::UkmRecorder* GetUkmRecorder() = 0;
// Gets the UKM source id associated with this client (for metrics).
virtual ukm::SourceId GetUkmSourceId() = 0;
// Gets an AddressNormalizer instance (can be null).
virtual AddressNormalizer* GetAddressNormalizer() = 0;
// Gets the security level used for recording histograms for the current
// context if possible, SECURITY_LEVEL_COUNT otherwise.
virtual security_state::SecurityLevel GetSecurityLevelForUmaHistograms() = 0;
// Causes the Autofill settings UI to be shown.
virtual void ShowAutofillSettings() = 0;
// Runs |callback| if the |profile| should be imported as personal data.
virtual void ConfirmSaveAutofillProfile(const AutofillProfile& profile,
base::OnceClosure callback) = 0;
// A user has attempted to use a masked card. Prompt them for further
// information to proceed.
virtual void ShowUnmaskPrompt(const CreditCard& card,
UnmaskCardReason reason,
base::WeakPtr<CardUnmaskDelegate> delegate) = 0;
virtual void OnUnmaskVerificationResult(PaymentsRpcResult result) = 0;
// Runs |closure| if the user accepts the migration process.
virtual void ShowLocalCardMigrationPrompt(base::OnceClosure closure) = 0;
// Runs |callback| if the |card| should be imported as personal data.
// |metric_logger| can be used to log user actions.
virtual void ConfirmSaveCreditCardLocally(const CreditCard& card,
const base::Closure& callback) = 0;
// Runs |callback| if the |card| should be uploaded to Payments. Displays the
// contents of |legal_message| to the user. Displays a cardholder name
// textfield in the bubble if |should_request_name_from_user| is true.
virtual void ConfirmSaveCreditCardToCloud(
const CreditCard& card,
std::unique_ptr<base::DictionaryValue> legal_message,
bool should_request_name_from_user,
base::OnceCallback<void(const base::string16&)> callback) = 0;
// Will show an infobar to get user consent for Credit Card assistive filling.
// Will run |callback| on success.
virtual void ConfirmCreditCardFillAssist(const CreditCard& card,
const base::Closure& callback) = 0;
// Returns true if both the platform and the device support scanning credit
// cards. Should be called before ScanCreditCard().
virtual bool HasCreditCardScanFeature() = 0;
// Shows the user interface for scanning a credit card. Invokes the |callback|
// when a credit card is scanned successfully. Should be called only if
// HasCreditCardScanFeature() returns true.
virtual void ScanCreditCard(const CreditCardScanCallback& callback) = 0;
// Shows an Autofill popup with the given |values|, |labels|, |icons|, and
// |identifiers| for the element at |element_bounds|. |delegate| will be
// notified of popup events.
virtual void ShowAutofillPopup(
const gfx::RectF& element_bounds,
base::i18n::TextDirection text_direction,
const std::vector<Suggestion>& suggestions,
bool autoselect_first_suggestion,
base::WeakPtr<AutofillPopupDelegate> delegate) = 0;
// Update the data list values shown by the Autofill popup, if visible.
virtual void UpdateAutofillPopupDataListValues(
const std::vector<base::string16>& values,
const std::vector<base::string16>& labels) = 0;
// Hide the Autofill popup if one is currently showing.
virtual void HideAutofillPopup() = 0;
// Whether the Autocomplete feature of Autofill should be enabled.
virtual bool IsAutocompleteEnabled() = 0;
// Pass the form structures to the password manager to choose correct username
// and to the password generation manager to detect account creation forms.
virtual void PropagateAutofillPredictions(
content::RenderFrameHost* rfh,
const std::vector<autofill::FormStructure*>& forms) = 0;
// Inform the client that the field has been filled.
virtual void DidFillOrPreviewField(
const base::string16& autofilled_value,
const base::string16& profile_full_name) = 0;
// Inform the client that the user interacted with a non-secure credit card
// field.
virtual void DidInteractWithNonsecureCreditCardInput() = 0;
// If the context is secure.
virtual bool IsContextSecure() = 0;
// Whether it is appropriate to show a signin promo for this user.
virtual bool ShouldShowSigninPromo() = 0;
// Whether Autofill is currently supported by the client. If false, all
// features of Autofill are disabled, including Autocomplete.
virtual bool IsAutofillSupported() = 0;
// Whether server side cards are supported by the client. If false, only
// local cards will be shown.
virtual bool AreServerCardsSupported() = 0;
// Handles simple actions for the autofill popups.
virtual void ExecuteCommand(int id) = 0;
} // namespace autofill