[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 10 matching lines @@
 namespace {
 
 // The size above which we stop triggering autofill for an input text field
 // (so to avoid sending long strings through IPC).
 const size_t kMaximumTextSizeForAutofill = 1000;
 
 // The maximum number of data list elements to send to the browser process
 // via IPC (to prevent long IPC messages).
 const size_t kMaximumDataListSizeForAutofill = 30;
 
+// A query counter for requests to show an interactive autocomplete UI.
+int request_autocomplete_query_id_ = 0;

[Ilya Sherman, 2012/10/27 07:44:11]

This should be a private member of the class.  Also, it doesn't seem like a
single id will work if there can be multiple tabs in a single renderer, each
showing a dialog.

[Dan Beam, 2012/10/29 19:17:05]

I don't think this is relevant any more.

+
 void AppendDataListSuggestions(const WebKit::WebInputElement& element,
                                std::vector<string16>* values,
                                std::vector<string16>* labels,
                                std::vector<string16>* icons,
                                std::vector<int>* item_ids) {
   WebNodeCollection options = element.dataListOptions();
   if (options.isNull())
     return;
 
   string16 prefix = element.editingValue();
@@ skipping 85 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) {
+  request_autocomplete_query_id_ += 1;

[Evan Stade, 2012/10/29 17:54:28]

++

[Dan Beam, 2012/10/29 19:17:05]

Done.

+
+  // Cancel any pending autofill requests.
+  autofill_query_id_ += 1;
+
+  // Any popup currently showing is obsolete.
+  HidePopups();
+
+  FormData form_data;
+  if (WebFormElementToFormData(form,
+                               WebFormControlElement(),
+                               REQUIRE_AUTOCOMPLETE,
+                               EXTRACT_NONE,
+                               &form_data,
+                               NULL)) {
+    form_ = form;
+    Send(new AutofillHostMsg_RequestAutocomplete(
+        routing_id(), request_autocomplete_query_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 349 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(int query_id, int result) {
+  DCHECK_GT(query_id, 0);
+  if (query_id != request_autocomplete_query_id_)
+    return;
+
+  if (result == WebFormElement::AutocompleteSuccess ||
+      result == WebFormElement::AutocompleteError) {
+    form_.finishRequestAutocomplete(
+        static_cast<WebFormElement::AutocompleteResult>(result));
+  } else {
+    NOTREACHED() << "Unknown autocomplete result.";

[Ilya Sherman, 2012/10/27 07:44:11]

nit: Please remove the logged text; you can add it as a comment instead.  (It's
inferable just from the line number for the NOTREACHED(), and the logged string
adds unnecessary weight to the binary, or something like that.)

[Dan Beam, 2012/10/29 19:17:05]

Done.

+  }
+}
+
 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();

[Ilya Sherman, 2012/10/27 07:44:11]

You should also hide any popups that might be showing in the browser process's
UI.

[Dan Beam, 2012/10/29 19:17:05]

The code wasn't doing this before and I'm simply pulling this out into a helper
method.

[Ilya Sherman, 2012/10/29 21:27:47]

Feel free to file a bug against csharp@ and annotate this code with that bug #
if you prefer.

[Dan Beam, 2012/10/29 23:08:23]

https://chromiumcodereview.appspot.com/11273096/

+}
+

[Evan Stade, 2012/10/29 17:54:28]

extra newline

[Dan Beam, 2012/10/29 19:17:05]

Done.

+
 }  // namespace autofill