// Copyright 2013 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. #ifndef COMPONENTS_AUTOFILL_CONTENT_RENDERER_AUTOFILL_AGENT_H_ #define COMPONENTS_AUTOFILL_CONTENT_RENDERER_AUTOFILL_AGENT_H_ #include <vector> #include "base/basictypes.h" #include "base/compiler_specific.h" #include "base/gtest_prod_util.h" #include "base/memory/weak_ptr.h" #include "base/time/time.h" #include "base/timer/timer.h" #include "components/autofill/content/renderer/form_cache.h" #include "components/autofill/content/renderer/page_click_listener.h" #include "content/public/renderer/render_view_observer.h" #include "third_party/WebKit/public/web/WebAutofillClient.h" #include "third_party/WebKit/public/web/WebFormControlElement.h" #include "third_party/WebKit/public/web/WebFormElement.h" #include "third_party/WebKit/public/web/WebInputElement.h" namespace blink { class WebNode; class WebView; struct WebAutocompleteParams; } namespace autofill { struct FormData; struct FormFieldData; struct WebElementDescriptor; class PasswordAutofillAgent; class PasswordGenerationAgent; // AutofillAgent deals with Autofill related communications between WebKit and // the browser. There is one AutofillAgent per RenderView. // This code was originally part of RenderView. // Note that Autofill encompasses: // - single text field suggestions, that we usually refer to as Autocomplete, // - password form fill, refered to as Password Autofill, and // - entire form fill based on one field entry, referred to as Form Autofill. class AutofillAgent : public content::RenderViewObserver, public PageClickListener, public blink::WebAutofillClient { public: // PasswordAutofillAgent is guaranteed to outlive AutofillAgent. // PasswordGenerationAgent may be NULL. If it is not, then it is also // guaranteed to outlive AutofillAgent. AutofillAgent(content::RenderView* render_view, PasswordAutofillAgent* password_autofill_manager, PasswordGenerationAgent* password_generation_agent); virtual ~AutofillAgent(); private: // content::RenderViewObserver: virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; virtual void DidFinishDocumentLoad(blink::WebLocalFrame* frame) OVERRIDE; virtual void DidCommitProvisionalLoad(blink::WebLocalFrame* frame, bool is_new_navigation) OVERRIDE; virtual void FrameDetached(blink::WebFrame* frame) OVERRIDE; virtual void FrameWillClose(blink::WebFrame* frame) OVERRIDE; virtual void WillSubmitForm(blink::WebLocalFrame* frame, const blink::WebFormElement& form) OVERRIDE; virtual void DidChangeScrollOffset(blink::WebLocalFrame* frame) OVERRIDE; virtual void FocusedNodeChanged(const blink::WebNode& node) OVERRIDE; virtual void OrientationChangeEvent() OVERRIDE; virtual void Resized() OVERRIDE; // PageClickListener: virtual void FormControlElementClicked( const blink::WebFormControlElement& element, bool was_focused) OVERRIDE; // blink::WebAutofillClient: virtual void textFieldDidEndEditing( const blink::WebInputElement& element); virtual void textFieldDidChange( const blink::WebFormControlElement& element); virtual void textFieldDidReceiveKeyDown( const blink::WebInputElement& element, const blink::WebKeyboardEvent& event); virtual void didRequestAutocomplete( const blink::WebFormElement& form); virtual void setIgnoreTextChanges(bool ignore); virtual void didAssociateFormControls( const blink::WebVector<blink::WebNode>& nodes); virtual void openTextDataListChooser(const blink::WebInputElement& element); virtual void firstUserGestureObserved(); void OnFieldTypePredictionsAvailable( const std::vector<FormDataPredictions>& forms); void OnFillForm(int query_id, const FormData& form); void OnPing(); void OnPreviewForm(int query_id, const FormData& form); // For external Autofill selection. void OnClearForm(); void OnClearPreviewedForm(); void OnFillFieldWithValue(const base::string16& value); void OnPreviewFieldWithValue(const base::string16& value); void OnAcceptDataListSuggestion(const base::string16& value); void OnFillPasswordSuggestion(const base::string16& username, const base::string16& password); void OnPreviewPasswordSuggestion(const base::string16& username, const base::string16& password); // Called when interactive autocomplete finishes. |message| is printed to // the console if non-empty. void OnRequestAutocompleteResult( blink::WebFormElement::AutocompleteResult result, const base::string16& message, const FormData& form_data); // Called when an autocomplete request succeeds or fails with the |result|. void FinishAutocompleteRequest( blink::WebFormElement::AutocompleteResult result); // Called in a posted task by textFieldDidChange() to work-around a WebKit bug // http://bugs.webkit.org/show_bug.cgi?id=16976 void TextFieldDidChangeImpl(const blink::WebFormControlElement& element); // Shows the autofill suggestions for |element|. // This call is asynchronous and may or may not lead to the showing of a // suggestion popup (no popup is shown if there are no available suggestions). // |autofill_on_empty_values| specifies whether suggestions should be shown // when |element| contains no text. // |requires_caret_at_end| specifies whether suggestions should be shown when // the caret is not after the last character in |element|. // |display_warning_if_disabled| specifies whether a warning should be // displayed to the user if Autofill has suggestions available, but cannot // fill them because it is disabled (e.g. when trying to fill a credit card // form on a non-secure website). // |datalist_only| specifies whether all of <datalist> suggestions and no // autofill suggestions are shown. |autofill_on_empty_values| and // |requires_caret_at_end| are ignored if |datalist_only| is true. // |show_full_suggestion_list| specifies that all autofill suggestions should // be shown and none should be elided because of the current value of // |element| (relevant for inline autocomplete). // |show_password_suggestions_only| specifies that only show a suggestions box // if |element| is part of a password form, otherwise show no suggestions. void ShowSuggestions(const blink::WebFormControlElement& element, bool autofill_on_empty_values, bool requires_caret_at_end, bool display_warning_if_disabled, bool datalist_only, bool show_full_suggestion_list, bool show_password_suggestions_only); // Queries the browser for Autocomplete and Autofill suggestions for the given // |element|. void QueryAutofillSuggestions(const blink::WebFormControlElement& element, bool display_warning_if_disabled, bool datalist_only); // Sets the element value to reflect the selected |suggested_value|. void AcceptDataListSuggestion(const base::string16& suggested_value); // Fills |form| and |field| with the FormData and FormField corresponding to // |node|. Returns true if the data was found; and false otherwise. bool FindFormAndFieldForNode( const blink::WebNode& node, FormData* form, FormFieldData* field) WARN_UNUSED_RESULT; // Set |node| to display the given |value|. void FillFieldWithValue(const base::string16& value, blink::WebInputElement* node); // Set |node| to display the given |value| as a preview. The preview is // visible on screen to the user, but not visible to the page via the DOM or // JavaScript. void PreviewFieldWithValue(const base::string16& value, blink::WebInputElement* node); // Notifies browser of new fillable forms in |frame|. void ProcessForms(const blink::WebLocalFrame& frame); // Hides any currently showing Autofill popup. void HidePopup(); FormCache form_cache_; PasswordAutofillAgent* password_autofill_agent_; // Weak reference. PasswordGenerationAgent* password_generation_agent_; // Weak reference. // The ID of the last request sent for form field Autofill. Used to ignore // out of date responses. int autofill_query_id_; // The element corresponding to the last request sent for form field Autofill. blink::WebFormControlElement element_; // The form element currently requesting an interactive autocomplete. blink::WebFormElement in_flight_request_form_; // Pointer to the WebView. Used to access page scale factor. blink::WebView* web_view_; // Should we display a warning if autofill is disabled? bool display_warning_if_disabled_; // Was the query node autofilled prior to previewing the form? bool was_query_node_autofilled_; // Have we already shown Autofill suggestions for the field the user is // currently editing? Used to keep track of state for metrics logging. bool has_shown_autofill_popup_for_current_edit_; // If true we just set the node text so we shouldn't show the popup. bool did_set_node_text_; // Whether or not to ignore text changes. Useful for when we're committing // a composition when we are defocusing the WebView and we don't want to // trigger an autofill popup to show. bool ignore_text_changes_; // Whether the Autofill popup is possibly visible. This is tracked as a // performance improvement, so that the IPC channel isn't flooded with // messages to close the Autofill popup when it can't possibly be showing. bool is_popup_possibly_visible_; // True if a message has already been sent about forms for the main frame. // When the main frame is first loaded, a message is sent even if no forms // exist in the frame. Otherwise, such messages are supressed. bool main_frame_processed_; base::WeakPtrFactory<AutofillAgent> weak_ptr_factory_; DISALLOW_COPY_AND_ASSIGN(AutofillAgent); }; } // namespace autofill #endif // COMPONENTS_AUTOFILL_CONTENT_RENDERER_AUTOFILL_AGENT_H_