components/autofill/content/renderer/form_tracker.cc - chromium/src.git - Git at Google

 // Copyright 2017 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 "components/autofill/content/renderer/form_tracker.h"

 #include "components/autofill/content/renderer/form_autofill_util.h"
 #include "content/public/renderer/document_state.h"
 #include "content/public/renderer/navigation_state.h"
 #include "content/public/renderer/render_frame.h"
 #include "third_party/blink/public/web/modules/autofill/web_form_element_observer.h"
 #include "third_party/blink/public/web/modules/autofill/web_form_element_observer_callback.h"
 #include "third_party/blink/public/web/web_input_element.h"
 #include "third_party/blink/public/web/web_local_frame.h"
 #include "third_party/blink/public/web/web_user_gesture_indicator.h"
 #include "ui/base/page_transition_types.h"

 using blink::WebDocumentLoader;
 using blink::WebInputElement;
 using blink::WebFormControlElement;
 using blink::WebFormElement;

 namespace autofill {

 class FormTracker::FormElementObserverCallback
     : public blink::WebFormElementObserverCallback {
  public:
   explicit FormElementObserverCallback(FormTracker* tracker)
       : tracker_(tracker) {}
   ~FormElementObserverCallback() override = default;

   void ElementWasHiddenOrRemoved() override {
     tracker_->FireInferredFormSubmission(
         SubmissionSource::DOM_MUTATION_AFTER_XHR);
   }

  private:
   FormTracker* tracker_;

   DISALLOW_COPY_AND_ASSIGN(FormElementObserverCallback);
 };

 FormTracker::FormTracker(content::RenderFrame* render_frame)
     : content::RenderFrameObserver(render_frame), weak_ptr_factory_(this) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
 }

 FormTracker::~FormTracker() {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   ResetLastInteractedElements();
 }

 void FormTracker::AddObserver(Observer* observer) {
   DCHECK(observer);
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   observers_.AddObserver(observer);
 }

 void FormTracker::RemoveObserver(Observer* observer) {
   DCHECK(observer);
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   observers_.RemoveObserver(observer);
 }

 void FormTracker::AjaxSucceeded() {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   FireSubmissionIfFormDisappear(SubmissionSource::XHR_SUCCEEDED);
 }

 void FormTracker::TextFieldDidChange(const WebFormControlElement& element) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   DCHECK(ToWebInputElement(&element) || form_util::IsTextAreaElement(element));

   if (ignore_control_changes_)
     return;

   // If the element isn't focused then the changes don't matter. This check is
   // required to properly handle IME interactions.
   if (!element.Focused())
     return;

   const WebInputElement* input_element = ToWebInputElement(&element);
   if (!input_element)
     return;

   // Disregard text changes that aren't caused by user gestures or pastes. Note
   // that pastes aren't necessarily user gestures because Blink's conception of
   // user gestures is centered around creating new windows/tabs.
   if (user_gesture_required_ &&
       !blink::WebUserGestureIndicator::IsProcessingUserGesture(
           render_frame()->GetWebFrame()) &&
       !render_frame()->IsPasting())
     return;

   // We post a task for doing the Autofill as the caret position is not set
   // properly at this point (http://bugs.webkit.org/show_bug.cgi?id=16976) and
   // it is needed to trigger autofill.
   weak_ptr_factory_.InvalidateWeakPtrs();
   render_frame()
       ->GetWebFrame()
       ->GetTaskRunner(blink::TaskType::kInternalUserInteraction)
       ->PostTask(FROM_HERE,
                  base::BindRepeating(
                      &FormTracker::FormControlDidChangeImpl,
                      weak_ptr_factory_.GetWeakPtr(), element,
                      Observer::ElementChangeSource::TEXTFIELD_CHANGED));
 }

 void FormTracker::SelectControlDidChange(const WebFormControlElement& element) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);

   if (ignore_control_changes_)
     return;

   // Post a task to avoid processing select control change while it is changing.
   weak_ptr_factory_.InvalidateWeakPtrs();
   render_frame()
       ->GetWebFrame()
       ->GetTaskRunner(blink::TaskType::kInternalUserInteraction)
       ->PostTask(FROM_HERE, base::BindRepeating(
                                 &FormTracker::FormControlDidChangeImpl,
                                 weak_ptr_factory_.GetWeakPtr(), element,
                                 Observer::ElementChangeSource::SELECT_CHANGED));
 }

 void FormTracker::FireProbablyFormSubmittedForTesting() {
   FireProbablyFormSubmitted();
 }

 void FormTracker::FormControlDidChangeImpl(
     const WebFormControlElement& element,
     Observer::ElementChangeSource change_source) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   // Render frame could be gone as this is the post task.
   if (!render_frame()) return;

   if (element.Form().IsNull()) {
     last_interacted_formless_element_ = element;
   } else {
     last_interacted_form_ = element.Form();
   }

   for (auto& observer : observers_) {
     observer.OnProvisionallySaveForm(element.Form(), element, change_source);
   }
 }

 void FormTracker::DidCommitProvisionalLoad(bool is_same_document_navigation,
                                            ui::PageTransition transition) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   if (!is_same_document_navigation) {
     ResetLastInteractedElements();
     return;
   }

   FireSubmissionIfFormDisappear(SubmissionSource::SAME_DOCUMENT_NAVIGATION);
 }

 void FormTracker::DidStartProvisionalLoad(WebDocumentLoader* document_loader,
                                           bool is_content_initiated) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   blink::WebLocalFrame* navigated_frame = render_frame()->GetWebFrame();
   // Ony handle main frame.
   if (navigated_frame->Parent())
     return;

   // Bug fix for crbug.com/368690. isProcessingUserGesture() is false when
   // the user is performing actions outside the page (e.g. typed url,
   // history navigation). We don't want to trigger saving in these cases.

   // We are interested only in content initiated navigations.  Explicit browser
   // initiated navigations (e.g. via omnibox) are discarded here.  Similarly
   // PlzNavigate navigations originating from the browser are discarded because
   // they were already processed as a content initiated one
   // (i.e. DidStartProvisionalLoad is called twice in this case).  The check for
   // kWebNavigationTypeLinkClicked is reliable only for content initiated
   // navigations.
   if (is_content_initiated && document_loader->GetNavigationType() !=
                                   blink::kWebNavigationTypeLinkClicked) {
     FireProbablyFormSubmitted();
   }
 }

 void FormTracker::FrameDetached() {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   FireInferredFormSubmission(SubmissionSource::FRAME_DETACHED);
 }

 void FormTracker::WillSendSubmitEvent(const WebFormElement& form) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   last_interacted_form_ = form;
   for (auto& observer : observers_) {
     observer.OnProvisionallySaveForm(
         form, blink::WebFormControlElement(),
         Observer::ElementChangeSource::WILL_SEND_SUBMIT_EVENT);
   }
 }

 void FormTracker::WillSubmitForm(const WebFormElement& form) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   FireFormSubmitted(form);
 }

 void FormTracker::OnDestruct() {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   ResetLastInteractedElements();
 }

 void FormTracker::FireFormSubmitted(const blink::WebFormElement& form) {
   for (auto& observer : observers_)
     observer.OnFormSubmitted(form);
   ResetLastInteractedElements();
 }

 void FormTracker::FireProbablyFormSubmitted() {
   for (auto& observer : observers_)
     observer.OnProbablyFormSubmitted();
   ResetLastInteractedElements();
 }

 void FormTracker::FireInferredFormSubmission(SubmissionSource source) {
   DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
   for (auto& observer : observers_)
     observer.OnInferredFormSubmission(source);
   ResetLastInteractedElements();
 }

 void FormTracker::FireSubmissionIfFormDisappear(SubmissionSource source) {
   if (CanInferFormSubmitted()) {
     FireInferredFormSubmission(source);
     return;
   }
   TrackElement();
 }

 bool FormTracker::CanInferFormSubmitted() {
   // If last interacted form is available, assume form submission only if the
   // form is now gone, either invisible or removed from the DOM.
   // Otherwise (i.e., there is no form tag), we check if the last element the
   // user has interacted with are gone, to decide if submission has occurred.
   if (!last_interacted_form_.IsNull())
     return !form_util::AreFormContentsVisible(last_interacted_form_);
   else if (!last_interacted_formless_element_.IsNull())
     return !form_util::IsWebElementVisible(last_interacted_formless_element_);

   return false;
 }

 void FormTracker::TrackElement() {
   // Already has observer for last interacted element.
   if (form_element_observer_)
     return;
   std::unique_ptr<FormElementObserverCallback> callback =
       std::make_unique<FormElementObserverCallback>(this);

   if (!last_interacted_form_.IsNull()) {
     form_element_observer_ = blink::WebFormElementObserver::Create(
         last_interacted_form_, std::move(callback));
   } else if (!last_interacted_formless_element_.IsNull()) {
     form_element_observer_ = blink::WebFormElementObserver::Create(
         last_interacted_formless_element_, std::move(callback));
   }
 }

 void FormTracker::ResetLastInteractedElements() {
   last_interacted_form_.Reset();
   last_interacted_formless_element_.Reset();
   if (form_element_observer_) {
     form_element_observer_->Disconnect();
     form_element_observer_ = nullptr;
   }
 }

 }  // namespace autofill
	// Copyright 2017 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 "components/autofill/content/renderer/form_tracker.h"

	#include "components/autofill/content/renderer/form_autofill_util.h"
	#include "content/public/renderer/document_state.h"
	#include "content/public/renderer/navigation_state.h"
	#include "content/public/renderer/render_frame.h"
	#include "third_party/blink/public/web/modules/autofill/web_form_element_observer.h"
	#include "third_party/blink/public/web/modules/autofill/web_form_element_observer_callback.h"
	#include "third_party/blink/public/web/web_input_element.h"
	#include "third_party/blink/public/web/web_local_frame.h"
	#include "third_party/blink/public/web/web_user_gesture_indicator.h"
	#include "ui/base/page_transition_types.h"

	using blink::WebDocumentLoader;
	using blink::WebInputElement;
	using blink::WebFormControlElement;
	using blink::WebFormElement;

	namespace autofill {

	class FormTracker::FormElementObserverCallback
	: public blink::WebFormElementObserverCallback {
	public:
	explicit FormElementObserverCallback(FormTracker* tracker)
	: tracker_(tracker) {}
	~FormElementObserverCallback() override = default;

	void ElementWasHiddenOrRemoved() override {
	tracker_->FireInferredFormSubmission(
	SubmissionSource::DOM_MUTATION_AFTER_XHR);
	}

	private:
	FormTracker* tracker_;

	DISALLOW_COPY_AND_ASSIGN(FormElementObserverCallback);
	};

	FormTracker::FormTracker(content::RenderFrame* render_frame)
	: content::RenderFrameObserver(render_frame), weak_ptr_factory_(this) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	}

	FormTracker::~FormTracker() {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	ResetLastInteractedElements();
	}

	void FormTracker::AddObserver(Observer* observer) {
	DCHECK(observer);
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	observers_.AddObserver(observer);
	}

	void FormTracker::RemoveObserver(Observer* observer) {
	DCHECK(observer);
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	observers_.RemoveObserver(observer);
	}

	void FormTracker::AjaxSucceeded() {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	FireSubmissionIfFormDisappear(SubmissionSource::XHR_SUCCEEDED);
	}

	void FormTracker::TextFieldDidChange(const WebFormControlElement& element) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	DCHECK(ToWebInputElement(&element) \|\| form_util::IsTextAreaElement(element));

	if (ignore_control_changes_)
	return;

	// If the element isn't focused then the changes don't matter. This check is
	// required to properly handle IME interactions.
	if (!element.Focused())
	return;

	const WebInputElement* input_element = ToWebInputElement(&element);
	if (!input_element)
	return;

	// Disregard text changes that aren't caused by user gestures or pastes. Note
	// that pastes aren't necessarily user gestures because Blink's conception of
	// user gestures is centered around creating new windows/tabs.
	if (user_gesture_required_ &&
	!blink::WebUserGestureIndicator::IsProcessingUserGesture(
	render_frame()->GetWebFrame()) &&
	!render_frame()->IsPasting())
	return;

	// We post a task for doing the Autofill as the caret position is not set
	// properly at this point (http://bugs.webkit.org/show_bug.cgi?id=16976) and
	// it is needed to trigger autofill.
	weak_ptr_factory_.InvalidateWeakPtrs();
	render_frame()
	->GetWebFrame()
	->GetTaskRunner(blink::TaskType::kInternalUserInteraction)
	->PostTask(FROM_HERE,
	base::BindRepeating(
	&FormTracker::FormControlDidChangeImpl,
	weak_ptr_factory_.GetWeakPtr(), element,
	Observer::ElementChangeSource::TEXTFIELD_CHANGED));
	}

	void FormTracker::SelectControlDidChange(const WebFormControlElement& element) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);

	if (ignore_control_changes_)
	return;

	// Post a task to avoid processing select control change while it is changing.
	weak_ptr_factory_.InvalidateWeakPtrs();
	render_frame()
	->GetWebFrame()
	->GetTaskRunner(blink::TaskType::kInternalUserInteraction)
	->PostTask(FROM_HERE, base::BindRepeating(
	&FormTracker::FormControlDidChangeImpl,
	weak_ptr_factory_.GetWeakPtr(), element,
	Observer::ElementChangeSource::SELECT_CHANGED));
	}

	void FormTracker::FireProbablyFormSubmittedForTesting() {
	FireProbablyFormSubmitted();
	}

	void FormTracker::FormControlDidChangeImpl(
	const WebFormControlElement& element,
	Observer::ElementChangeSource change_source) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	// Render frame could be gone as this is the post task.
	if (!render_frame()) return;

	if (element.Form().IsNull()) {
	last_interacted_formless_element_ = element;
	} else {
	last_interacted_form_ = element.Form();
	}

	for (auto& observer : observers_) {
	observer.OnProvisionallySaveForm(element.Form(), element, change_source);
	}
	}

	void FormTracker::DidCommitProvisionalLoad(bool is_same_document_navigation,
	ui::PageTransition transition) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	if (!is_same_document_navigation) {
	ResetLastInteractedElements();
	return;
	}

	FireSubmissionIfFormDisappear(SubmissionSource::SAME_DOCUMENT_NAVIGATION);
	}

	void FormTracker::DidStartProvisionalLoad(WebDocumentLoader* document_loader,
	bool is_content_initiated) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	blink::WebLocalFrame* navigated_frame = render_frame()->GetWebFrame();
	// Ony handle main frame.
	if (navigated_frame->Parent())
	return;

	// Bug fix for crbug.com/368690. isProcessingUserGesture() is false when
	// the user is performing actions outside the page (e.g. typed url,
	// history navigation). We don't want to trigger saving in these cases.

	// We are interested only in content initiated navigations. Explicit browser
	// initiated navigations (e.g. via omnibox) are discarded here. Similarly
	// PlzNavigate navigations originating from the browser are discarded because
	// they were already processed as a content initiated one
	// (i.e. DidStartProvisionalLoad is called twice in this case). The check for
	// kWebNavigationTypeLinkClicked is reliable only for content initiated
	// navigations.
	if (is_content_initiated && document_loader->GetNavigationType() !=
	blink::kWebNavigationTypeLinkClicked) {
	FireProbablyFormSubmitted();
	}
	}

	void FormTracker::FrameDetached() {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	FireInferredFormSubmission(SubmissionSource::FRAME_DETACHED);
	}

	void FormTracker::WillSendSubmitEvent(const WebFormElement& form) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	last_interacted_form_ = form;
	for (auto& observer : observers_) {
	observer.OnProvisionallySaveForm(
	form, blink::WebFormControlElement(),
	Observer::ElementChangeSource::WILL_SEND_SUBMIT_EVENT);
	}
	}

	void FormTracker::WillSubmitForm(const WebFormElement& form) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	FireFormSubmitted(form);
	}

	void FormTracker::OnDestruct() {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	ResetLastInteractedElements();
	}

	void FormTracker::FireFormSubmitted(const blink::WebFormElement& form) {
	for (auto& observer : observers_)
	observer.OnFormSubmitted(form);
	ResetLastInteractedElements();
	}

	void FormTracker::FireProbablyFormSubmitted() {
	for (auto& observer : observers_)
	observer.OnProbablyFormSubmitted();
	ResetLastInteractedElements();
	}

	void FormTracker::FireInferredFormSubmission(SubmissionSource source) {
	DCHECK_CALLED_ON_VALID_SEQUENCE(form_tracker_sequence_checker_);
	for (auto& observer : observers_)
	observer.OnInferredFormSubmission(source);
	ResetLastInteractedElements();
	}

	void FormTracker::FireSubmissionIfFormDisappear(SubmissionSource source) {
	if (CanInferFormSubmitted()) {
	FireInferredFormSubmission(source);
	return;
	}
	TrackElement();
	}

	bool FormTracker::CanInferFormSubmitted() {
	// If last interacted form is available, assume form submission only if the
	// form is now gone, either invisible or removed from the DOM.
	// Otherwise (i.e., there is no form tag), we check if the last element the
	// user has interacted with are gone, to decide if submission has occurred.
	if (!last_interacted_form_.IsNull())
	return !form_util::AreFormContentsVisible(last_interacted_form_);
	else if (!last_interacted_formless_element_.IsNull())
	return !form_util::IsWebElementVisible(last_interacted_formless_element_);

	return false;
	}

	void FormTracker::TrackElement() {
	// Already has observer for last interacted element.
	if (form_element_observer_)
	return;
	std::unique_ptr<FormElementObserverCallback> callback =
	std::make_unique<FormElementObserverCallback>(this);

	if (!last_interacted_form_.IsNull()) {
	form_element_observer_ = blink::WebFormElementObserver::Create(
	last_interacted_form_, std::move(callback));
	} else if (!last_interacted_formless_element_.IsNull()) {
	form_element_observer_ = blink::WebFormElementObserver::Create(
	last_interacted_formless_element_, std::move(callback));
	}
	}

	void FormTracker::ResetLastInteractedElements() {
	last_interacted_form_.Reset();
	last_interacted_formless_element_.Reset();
	if (form_element_observer_) {
	form_element_observer_->Disconnect();
	form_element_observer_ = nullptr;
	}
	}

	} // namespace autofill