[autofill] Adding new API to request an interactive autocomplete UI flow.

chrome/renderer/autofill/autofill_agent.cc

 // Copyright (c) 2012 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 "chrome/renderer/autofill/autofill_agent.h"
 
 #include "base/bind.h"
 #include "base/message_loop.h"
 #include "base/string_util.h"
 #include "base/string_split.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/common/autofill_messages.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/form_data.h"
 #include "chrome/common/form_data_predictions.h"
 #include "chrome/common/form_field_data.h"
 #include "chrome/renderer/autofill/form_autofill_util.h"
 #include "chrome/renderer/autofill/password_autofill_manager.h"
 #include "content/public/common/password_form.h"
 #include "content/public/renderer/render_view.h"
 #include "grit/chromium_strings.h"
 #include "grit/generated_resources.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebRect.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDocument.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFormControlElement.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebFormElement.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrame.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebNode.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebNodeCollection.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebOptionElement.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/base/l10n/l10n_util.h"
 
 using WebKit::WebAutofillClient;
@@ skipping 113 matching lines @@
     IPC_MESSAGE_HANDLER(AutofillMsg_SetAutofillActionPreview,
                         OnSetAutofillActionPreview)
     IPC_MESSAGE_HANDLER(AutofillMsg_ClearPreviewedForm,
                         OnClearPreviewedForm)
     IPC_MESSAGE_HANDLER(AutofillMsg_SetNodeText,
                         OnSetNodeText)
     IPC_MESSAGE_HANDLER(AutofillMsg_AcceptDataListSuggestion,
                         OnAcceptDataListSuggestion)
     IPC_MESSAGE_HANDLER(AutofillMsg_AcceptPasswordAutofillSuggestion,
                         OnAcceptPasswordAutofillSuggestion)
+    IPC_MESSAGE_HANDLER(AutofillMsg_RequestAutocompleteFinished,
+                        OnRequestAutocompleteFinished)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void AutofillAgent::DidFinishDocumentLoad(WebFrame* frame) {
   // The document has now been fully loaded.  Scan for forms to be sent up to
   // the browser.
   std::vector<FormData> forms;
   form_cache_.ExtractForms(*frame, &forms);
@@ skipping 34 matching lines @@
   Send(new AutofillHostMsg_HideAutofillPopup(routing_id()));
 }
 
 void AutofillAgent::DidChangeScrollOffset(WebKit::WebFrame*) {
   // Any time the scroll offset changes, the page's content moves, so Autofill
   // popups should be hidden. This is only needed for the new Autofill UI
   // because WebKit already knows to hide the old UI when this occurs.
   Send(new AutofillHostMsg_HideAutofillPopup(routing_id()));
 }
 
+void AutofillAgent::didRequestAutocomplete(WebKit::WebFrame* frame,
+                                           const WebFormElement& form) {
+  FormData form_data;
+  if (!form_.isNull() ||
+      !WebFormElementToFormData(form,
+                                WebFormControlElement(),
+                                REQUIRE_AUTOCOMPLETE,
+                                EXTRACT_NONE,
+                                &form_data,
+                                NULL)) {
+    WebFormElement non_const_form(form);

[Ilya Sherman, 2012/11/02 02:56:57]

nit: Seems like we shouldn't be passing in a const form to this method if we're
just going to cast the constness away.

[Dan Beam, 2012/11/02 03:10:15]

So I removed const but there were issues with this, IIRC.  We're only copying a
pointer here, I think.  Is there a better way?  Just removing const didn't work
very well and passing by value wasn't so hot either, I think.

[Ilya Sherman, 2012/11/02 03:24:45]

What are the issues with removing const?  I agree that the pointer copy is safe,
but it seems rather weird to have "const WebFormElement" in the signature of the
method if we treat the form as non-const.

[Dan Beam, 2012/11/02 22:37:55]

So it looks like this is already being done every time you see:

  element_ = element;

in this file (3 times) as well as someone pointed out to me that even
WebNode::appendChild() is passed a const WebNode& (which seems that it'll
*always* be changed).

I know this is every-so-slightly misleading, but can you find any
counter-examples that'd actually make it worth going against this seemingly
pervasive convention?

[Ilya Sherman, 2012/11/02 22:47:36]

No counter-examples that I'm aware of, no.

+    non_const_form.finishRequestAutocomplete(
+        WebFormElement::AutocompleteResultError);
+    return;
+  }
+
+  // Cancel any pending Autofill requests and hide any currently showing popups.
+  ++autofill_query_id_;
+  HidePopups();
+
+  form_ = form;
+  Send(new AutofillHostMsg_RequestAutocomplete(routing_id(), form_data));
+}
+
 bool AutofillAgent::InputElementClicked(const WebInputElement& element,
                                         bool was_focused,
                                         bool is_focused) {
   if (was_focused)
     ShowSuggestions(element, true, false, true);
 
   return false;
 }
 
 bool AutofillAgent::InputElementLostFocus() {
@@ skipping 343 matching lines @@
 void AutofillAgent::OnAcceptPasswordAutofillSuggestion(const string16& value) {
   // We need to make sure this is handled here because the browser process
   // skipped it handling because it believed it would be handled here. If it
   // isn't handled here then the browser logic needs to be updated.
   bool handled = password_autofill_manager_->DidAcceptAutofillSuggestion(
       element_,
       value);
   DCHECK(handled);
 }
 
+void AutofillAgent::OnRequestAutocompleteFinished(
+    WebFormElement::AutocompleteResult result) {
+  if (form_.isNull())
+    return;

[Ilya Sherman, 2012/11/02 02:56:57]

When can this happen?

[Dan Beam, 2012/11/02 03:10:15]

I'd think it's possible that the form *could* be removed from the DOM and set =
null, but maybe this doesn't cause it to be null if it's wrapped in a
WebFormElement?  Also what would happen if the tab's closed during this time -
would this ever fire?  Or what if a tab is refreshed mid-IPC?  We've had issues
with this in the past in WebUI code.

[Ilya Sherman, 2012/11/02 03:24:45]

The form could be removed from the DOM, but I don't think that would cause it to
become null, since we still have a reference to it from the event.
Can either of these actually happen, given that the dialog is modal?  Even if
they can, I think that either the AutofillAgent will be torn down, or the form
will remain non-null, since we're holding a reference to it.

[Dan Beam, 2012/11/02 21:06:08]

True, I definitely think you're right here and rescind that original guess.
The issue in WebUI is that while IPC was in flight the WebUI handlers were
complete destroyed and recreated so it looked like a valid IPC message coming at
a totally weird time. It seems possible if somebody in their script does:

  form.requestAutocomplete();
  location.reload();

(which I just did many times in various ways by slamming my CPU and
form.requestAutocomplete(); and didn't do anything)

I'll make a DCHECK() for now and change if people start hitting it.

+
+  form_.finishRequestAutocomplete(result);
+  form_.reset();
+}
+
 void AutofillAgent::ShowSuggestions(const WebInputElement& element,
                                     bool autofill_on_empty_values,
                                     bool requires_caret_at_end,
                                     bool display_warning_if_disabled) {
   if (!element.isEnabled() || element.isReadOnly() || !element.isTextField() ||
       element.isPasswordField() || !element.suggestedValue().isEmpty())
     return;
 
   // Don't attempt to autofill with values that are too large or if filling
   // criteria are not met.
   WebString value = element.editingValue();
   if (value.length() > kMaximumTextSizeForAutofill ||
       (!autofill_on_empty_values && value.isEmpty()) ||
       (requires_caret_at_end &&
        (element.selectionStart() != element.selectionEnd() ||
         element.selectionEnd() != static_cast<int>(value.length())))) {
     // Any popup currently showing is obsolete.
-    WebKit::WebView* web_view = render_view()->GetWebView();
-    if (web_view)
-      web_view->hidePopups();
-
+    HidePopups();
     return;
   }
 
   element_ = element;
 
   // If autocomplete is disabled at the form level, then we might want to show
   // a warning in place of suggestions. However, if autocomplete is disabled
   // specifically for this field, we never want to show a warning. Otherwise,
   // we might interfere with custom popups (e.g. search suggestions) used by
   // the website. Also, if the field has no name, then we won't have values.
@@ skipping 79 matching lines @@
 
 void AutofillAgent::SetNodeText(const string16& value,
                                 WebKit::WebInputElement* node) {
   did_set_node_text_ = true;
   string16 substring = value;
   substring = substring.substr(0, node->maxLength());
 
   node->setEditingValue(substring);
 }
 
+void AutofillAgent::HidePopups() {
+  WebKit::WebView* web_view = render_view()->GetWebView();
+  if (web_view)
+    web_view->hidePopups();
+}
+
 }  // namespace autofill