Files
tubestation/toolkit/components/satchel/nsFormFillController.h
Matthew Noorenberghe e24ba068b6 Bug 1538952 - Don't automatically open the password autocomplete popup when we only have the footer to show. r=jaws,mak
Normally autocomplete results are cached based upon the search string but to get the desired behaviour we want two different sets of results for the same search string depending on how the autocomplete search was started:
a) Via automatically focusing a password field.
b) Every other method of starting an autocomplete search.

In order to not have cached results used, the result code for case (a) [an empty result] will be `RESULT_FAILURE` and I've updated the autocomplete code to not re-use an error result.

In the coming months we may be rewriting our content autocomplete code but that would be too risky to uplift to 67 so for now I'm tracking when satchel automatically opens the popup upon focus and then using that state in the autocomplete result creation code to know whether to include the footer.

Differential Revision: https://phabricator.services.mozilla.com/D25173
2019-03-30 04:20:20 +00:00

145 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 "nsIFormFillController.h"
#include "nsIAutoCompleteInput.h"
#include "nsIAutoCompleteSearch.h"
#include "nsIAutoCompleteController.h"
#include "nsIAutoCompletePopup.h"
#include "nsIFormAutoComplete.h"
#include "nsIDOMEventListener.h"
#include "nsCOMPtr.h"
#include "nsDataHashtable.h"
#include "nsIDocShell.h"
#include "nsILoginManager.h"
#include "nsIMutationObserver.h"
#include "nsTArray.h"
#include "nsCycleCollectionParticipant.h"
#include "nsILoginReputation.h"
// X.h defines KeyPress
#ifdef KeyPress
# undef KeyPress
#endif
class nsFormHistory;
class nsINode;
class nsPIDOMWindowOuter;
namespace mozilla {
namespace dom {
class HTMLInputElement;
} // namespace dom
} // namespace mozilla
class nsFormFillController final : public nsIFormFillController,
public nsIAutoCompleteInput,
public nsIAutoCompleteSearch,
public nsIDOMEventListener,
public nsIFormAutoCompleteObserver,
public nsIMutationObserver {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_NSIFORMFILLCONTROLLER
NS_DECL_NSIAUTOCOMPLETESEARCH
NS_DECL_NSIAUTOCOMPLETEINPUT
NS_DECL_NSIFORMAUTOCOMPLETEOBSERVER
NS_DECL_NSIDOMEVENTLISTENER
NS_DECL_NSIMUTATIONOBSERVER
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsFormFillController,
nsIFormFillController)
nsresult Focus(mozilla::dom::Event* aEvent);
nsresult KeyDown(mozilla::dom::Event* aKeyEvent);
nsresult KeyPress(mozilla::dom::Event* aKeyEvent);
nsresult MouseDown(mozilla::dom::Event* aMouseEvent);
nsFormFillController();
protected:
virtual ~nsFormFillController();
void AddWindowListeners(nsPIDOMWindowOuter* aWindow);
void RemoveWindowListeners(nsPIDOMWindowOuter* aWindow);
void AddKeyListener(nsINode* aInput);
void RemoveKeyListener();
void StartControllingInput(mozilla::dom::HTMLInputElement* aInput);
void StopControllingInput();
nsresult HandleFocus(mozilla::dom::HTMLInputElement* aInput);
/**
* Checks that aElement is a type of element we want to fill, then calls
* StartControllingInput on it.
*/
void MaybeStartControllingInput(mozilla::dom::HTMLInputElement* aElement);
nsresult PerformInputListAutoComplete(const nsAString& aSearch,
nsIAutoCompleteResult** aResult);
void RevalidateDataList();
bool RowMatch(nsFormHistory* aHistory, uint32_t aIndex,
const nsAString& aInputName, const nsAString& aInputValue);
inline nsIDocShell* GetDocShellForInput(
mozilla::dom::HTMLInputElement* aInput);
inline nsPIDOMWindowOuter* GetWindowForDocShell(nsIDocShell* aDocShell);
inline int32_t GetIndexOfDocShell(nsIDocShell* aDocShell);
void MaybeRemoveMutationObserver(nsINode* aNode);
void RemoveForDocument(mozilla::dom::Document* aDoc);
bool IsTextControl(nsINode* aNode);
nsresult StartQueryLoginReputation(mozilla::dom::HTMLInputElement* aInput);
// members //////////////////////////////////////////
nsCOMPtr<nsIAutoCompleteController> mController;
nsCOMPtr<nsILoginManager> mLoginManager;
nsCOMPtr<nsILoginReputationService> mLoginReputationService;
mozilla::dom::HTMLInputElement* mFocusedInput;
// mListNode is a <datalist> element which, is set, has the form fill
// controller as a mutation observer for it.
nsINode* mListNode;
nsCOMPtr<nsIAutoCompletePopup> mFocusedPopup;
nsTArray<nsCOMPtr<nsIDocShell> > mDocShells;
nsTArray<nsCOMPtr<nsIAutoCompletePopup> > mPopups;
// 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().
nsCOMPtr<nsIFormAutoComplete> mLastFormAutoComplete;
nsString mLastSearchString;
nsDataHashtable<nsPtrHashKey<const nsINode>, bool> mPwmgrInputs;
nsDataHashtable<nsPtrHashKey<const nsINode>, bool> mAutofillInputs;
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;
};
#endif // __nsFormFillController__