fune/toolkit/components/satchel/nsFormFillController.h
Dimi 0fa0555629 Bug 1894889 - Trigger autocomplete action from the parent process r=credential-management-reviewers,geckoview-reviewers,NeilDeakin,owlish
This patch adds the following messages to the autocomplete item:
1. For address and credit card autofill, use the `FormAutofill:FillForm` message.
2. For login autofill, use the `PasswordManager:OnFieldAutoComplete` message.
3. For generated password autofill, use the `PasswordManager:FillGeneratedPassword` message.
After adding the above three messages, every autocomplete item that performs an action
upon being clicked has a corresponding `fillMessageName`.

Here is how the new architecture works:

1. Whenever a user selects an autocomplete entry, the `AutoCompleteChild` sends
   the `AutoComplete:SelectEntry` message to the parent process.
2. `AutoCompleteParent` extracts `fillMessageName` from the message and uses
   the prefix of the message name to determine which actor should process this message.
3. The `OnFieldAutoCompleteEntrySelected` method of the actor is called. The actor in
   the parent process determines what action to take.

Differential Revision: https://phabricator.services.mozilla.com/D209353
2024-05-21 19:06:35 +00:00

146 lines
4.7 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef __nsFormFillController__
#define __nsFormFillController__
#include "mozilla/TimeStamp.h"
#include "nsIFormFillController.h"
#include "nsIAutoCompleteInput.h"
#include "nsIAutoCompleteSearch.h"
#include "nsIAutoCompleteController.h"
#include "nsIAutoCompletePopup.h"
#include "nsIDOMEventListener.h"
#include "nsCOMPtr.h"
#include "nsStubMutationObserver.h"
#include "nsTHashMap.h"
#include "nsInterfaceHashtable.h"
#include "nsIDocShell.h"
#include "nsIMutationObserver.h"
#include "nsIObserver.h"
#include "nsCycleCollectionParticipant.h"
class nsFormHistory;
class nsINode;
namespace mozilla {
class CancelableRunnable;
namespace dom {
class EventTarget;
class HTMLInputElement;
} // namespace dom
} // namespace mozilla
class nsFormFillController final : public nsIFormFillController,
public nsIAutoCompleteInput,
public nsIAutoCompleteSearch,
public nsIFormFillCompleteObserver,
public nsIDOMEventListener,
public nsIObserver,
public nsMultiMutationObserver {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_NSIFORMFILLCONTROLLER
NS_DECL_NSIAUTOCOMPLETESEARCH
NS_DECL_NSIAUTOCOMPLETEINPUT
NS_DECL_NSIFORMFILLCOMPLETEOBSERVER
NS_DECL_NSIDOMEVENTLISTENER
NS_DECL_NSIOBSERVER
NS_DECL_NSIMUTATIONOBSERVER
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsFormFillController,
nsIFormFillController)
MOZ_CAN_RUN_SCRIPT nsresult Focus(mozilla::dom::Event* aEvent);
MOZ_CAN_RUN_SCRIPT nsresult KeyDown(mozilla::dom::Event* aKeyEvent);
MOZ_CAN_RUN_SCRIPT nsresult MouseDown(mozilla::dom::Event* aMouseEvent);
nsFormFillController();
static already_AddRefed<nsFormFillController> GetSingleton();
protected:
MOZ_CAN_RUN_SCRIPT virtual ~nsFormFillController();
MOZ_CAN_RUN_SCRIPT
void StartControllingInput(mozilla::dom::HTMLInputElement* aInput);
MOZ_CAN_RUN_SCRIPT void StopControllingInput();
bool IsFocusedInputControlled() const;
MOZ_CAN_RUN_SCRIPT
nsresult HandleFocus(mozilla::dom::HTMLInputElement* aInput);
void AttachListeners(mozilla::dom::EventTarget* aEventTarget);
/**
* Checks that aElement is a type of element we want to fill, then calls
* StartControllingInput on it.
*/
MOZ_CAN_RUN_SCRIPT
void MaybeStartControllingInput(mozilla::dom::HTMLInputElement* aElement);
// clears the reference mRestartAfterAttributeChangeTask before running
// MaybeStartControllingInput()
MOZ_CAN_RUN_SCRIPT
void MaybeStartControllingInputScheduled(
mozilla::dom::HTMLInputElement* aElement);
// cancels a scheduled AttributeChangeTask and clears the reference
// mRestartAfterAttributeChangeTask
MOZ_CAN_RUN_SCRIPT
void MaybeCancelAttributeChangeTask();
void MaybeObserveDataListMutations();
MOZ_CAN_RUN_SCRIPT void RevalidateDataList();
bool RowMatch(nsFormHistory* aHistory, uint32_t aIndex,
const nsAString& aInputName, const nsAString& aInputValue);
inline nsIDocShell* GetDocShellForInput(
mozilla::dom::HTMLInputElement* aInput);
void MaybeRemoveMutationObserver(nsINode* aNode);
void RemoveForDocument(mozilla::dom::Document* aDoc);
bool IsTextControl(nsINode* aNode);
// members //////////////////////////////////////////
nsCOMPtr<nsIAutoCompleteController> mController;
mozilla::dom::HTMLInputElement* mFocusedInput;
RefPtr<mozilla::CancelableRunnable> mRestartAfterAttributeChangeTask;
// mListNode is a <datalist> element which, is set, has the form fill
// controller as a mutation observer for it.
nsINode* mListNode;
nsCOMPtr<nsIAutoCompletePopup> mFocusedPopup;
// The observer passed to StartSearch. It will be notified when the search
// is complete or the data from a datalist changes.
nsCOMPtr<nsIAutoCompleteObserver> mLastListener;
// This is cleared by StopSearch().
nsString mLastSearchString;
nsTHashMap<nsPtrHashKey<const nsINode>, bool> mAutoCompleteInputs;
uint16_t mFocusAfterRightClickThreshold;
uint32_t mTimeout;
uint32_t mMinResultsForPopup;
uint32_t mMaxRows;
mozilla::TimeStamp mLastRightClickTimeStamp;
bool mDisableAutoComplete;
bool mCompleteDefaultIndex;
bool mCompleteSelectedIndex;
bool mForceComplete;
bool mSuppressOnInput;
bool mPasswordPopupAutomaticallyOpened;
bool mAutoCompleteActive = false;
bool mInvalidatePreviousResult = false;
};
#endif // __nsFormFillController__