Add supports that allow Autofill to be initiated from textarea field

components/autofill/content/renderer/autofill_agent.cc

 // 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.
 
 #include "components/autofill/content/renderer/autofill_agent.h"
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/message_loop/message_loop.h"
 #include "base/strings/string_split.h"
@@ skipping 37 matching lines @@
 using blink::WebAutofillClient;
 using blink::WebFormControlElement;
 using blink::WebFormElement;
 using blink::WebFrame;
 using blink::WebInputElement;
 using blink::WebKeyboardEvent;
 using blink::WebNode;
 using blink::WebNodeCollection;
 using blink::WebOptionElement;
 using blink::WebString;
+using blink::WebTextAreaElement;
 
 namespace autofill {
 
 namespace {
 
 // Gets all the data list values (with corresponding label) for the given
 // element.
 void GetDataListSuggestions(const blink::WebInputElement& element,
                             bool ignore_current_value,
                             std::vector<base::string16>* values,
@@ skipping 216 matching lines @@
 
 void AutofillAgent::setIgnoreTextChanges(bool ignore) {
   ignore_text_changes_ = ignore;
 }
 
 void AutofillAgent::InputElementClicked(const WebInputElement& element,
                                         bool was_focused,
                                         bool is_focused) {
   if (was_focused)
     ShowSuggestions(element, true, false, true, false);
 }

[Ilya Sherman, 2014/02/14 02:44:40]

Is this method needed in addition to the TextAreaElementClicked() method, or can
the two be merged into a single TextFormControlElementClicked() method?

[ziran.sun, 2014/02/17 15:43:45]

Done.

 
-void AutofillAgent::InputElementLostFocus() {
+void AutofillAgent::TextAreaElementClicked(const WebTextAreaElement& element,
+                                           bool was_focused,
+                                           bool is_focused) {

[Ilya Sherman, 2014/02/14 02:44:40]

Is is_focused needed?

[ziran.sun, 2014/02/17 15:43:45]

I'm not sure. It doesn't seem that it's called here. But I wonder why this
variable was introduced...

[Ilya Sherman, 2014/02/22 06:24:20]

Let's go ahead and remove it if it's not used anymore.

+  if (was_focused)
+    ShowSuggestions(element, true, false, true, false);
+}
+
+// This applies to both input and textarea elements
+void AutofillAgent::FormControlElementLostFocus() {
   HideAutofillUI();
 }
 
 void AutofillAgent::textFieldDidEndEditing(const WebInputElement& element) {
   password_autofill_agent_->TextFieldDidEndEditing(element);
   has_shown_autofill_popup_for_current_edit_ = false;
   Send(new AutofillHostMsg_DidEndTextFieldEditing(routing_id()));
 }
 
+// This function is to be removed once next Blink roll is done

[Ilya Sherman, 2014/02/14 02:44:40]

Please add a TODO.

[ziran.sun, 2014/02/17 15:43:45]

Done.

 void AutofillAgent::textFieldDidChange(const WebInputElement& element) {
   if (ignore_text_changes_)
     return;
 
   if (did_set_node_text_) {
     did_set_node_text_ = false;
     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();
   base::MessageLoop::current()->PostTask(
       FROM_HERE,
       base::Bind(&AutofillAgent::TextFieldDidChangeImpl,
                  weak_ptr_factory_.GetWeakPtr(),
                  element));

[Ilya Sherman, 2014/02/14 02:44:40]

Can you call into the other textFieldDidChange function from this one, rather
than duplicating the code?

[ziran.sun, 2014/02/17 15:43:45]

Done.

 }
 
-void AutofillAgent::TextFieldDidChangeImpl(const WebInputElement& element) {
+// Text changes in input text field or textarea field
+void AutofillAgent::textFieldDidChange(const WebFormControlElement& element) {
+  if (ignore_text_changes_)
+    return;
+
+  if (did_set_node_text_) {
+    did_set_node_text_ = false;
+    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();
+  base::MessageLoop::current()->PostTask(
+      FROM_HERE,
+      base::Bind(&AutofillAgent::TextFieldDidChangeImpl,
+                 weak_ptr_factory_.GetWeakPtr(),
+                 element));
+}
+
+void AutofillAgent::TextFieldDidChangeImpl(const WebFormControlElement& element)
+{
   // 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;
 
-  if (password_generation_agent_ &&
-      password_generation_agent_->TextDidChangeInTextField(element)) {
-    return;
-  }
+  const WebInputElement* input_element = toWebInputElement(&element);
+  if (IsAutofillableInputElement(input_element)) {
+    if (password_generation_agent_ &&
+      password_generation_agent_->TextDidChangeInTextField(*input_element)) {

[Ilya Sherman, 2014/02/14 02:44:40]

nit: Indent this line by two more spaces.

[ziran.sun, 2014/02/17 15:43:45]

Done.

+        return;

[Ilya Sherman, 2014/02/14 02:44:40]

nit: Indent this line by two fewer spaces.

[ziran.sun, 2014/02/17 15:43:45]

Done.

+    }
 
-  if (password_autofill_agent_->TextDidChangeInTextField(element)) {
-    element_ = element;
-    return;
+    if (password_autofill_agent_->TextDidChangeInTextField(*input_element)) {
+      element_ = element;
+      return;
+    }
   }
 
   ShowSuggestions(element, false, true, false, false);
 
   FormData form;
   FormFieldData field;
-  if (FindFormAndFieldForInputElement(element, &form, &field, REQUIRE_NONE)) {
+  if ((IsAutofillableInputElement(input_element) ||
+       IsTextAreaElement(element)) &&

[Ilya Sherman, 2014/02/14 02:44:40]

Please move the check for whether this is an autofillable input element or a
textarea to the top of the method, and return early if not.

[ziran.sun, 2014/02/17 15:43:45]

Done.

+       FindFormAndFieldForFormControlElement(element,
+                                             &form,
+                                             &field,
+                                             REQUIRE_NONE)) {
     Send(new AutofillHostMsg_TextFieldDidChange(routing_id(), form, field,
                                                 base::TimeTicks::Now()));
   }
 }
 
 void AutofillAgent::textFieldDidReceiveKeyDown(const WebInputElement& element,
                                                const WebKeyboardEvent& event) {
   if (password_autofill_agent_->TextFieldHandlingKeyDown(element, event)) {
     element_ = element;
     return;
   }
 
   if (event.windowsKeyCode == ui::VKEY_DOWN ||
       event.windowsKeyCode == ui::VKEY_UP)
     ShowSuggestions(element, true, true, true, false);
 }
 
 void AutofillAgent::openTextDataListChooser(const WebInputElement& element) {
     ShowSuggestions(element, true, false, false, true);
 }
 
 void AutofillAgent::AcceptDataListSuggestion(
     const base::string16& suggested_value) {
+  WebInputElement* input_element = toWebInputElement(&element_);

[Ilya Sherman, 2014/02/14 02:44:40]

nit: Please add a DCHECK that this conversion succeeded, with a comment
explaining that datalist suggestions should only appear in conjunction with
input elements, not textareas.

[ziran.sun, 2014/02/17 15:43:45]

Done.

   base::string16 new_value = suggested_value;
   // If this element takes multiple values then replace the last part with
   // the suggestion.
-  if (element_.isMultiple() &&
-      element_.formControlType() == WebString::fromUTF8("email")) {
+  if (input_element->isMultiple() &&
+      input_element->formControlType() == WebString::fromUTF8("email")) {
     std::vector<base::string16> parts;
 
-    base::SplitStringDontTrim(element_.editingValue(), ',', &parts);
+    base::SplitStringDontTrim(input_element->editingValue(), ',', &parts);
     if (parts.size() == 0)
       parts.push_back(base::string16());
 
     base::string16 last_part = parts.back();
     // We want to keep just the leading whitespace.
     for (size_t i = 0; i < last_part.size(); ++i) {
       if (!IsWhitespace(last_part[i])) {
         last_part = last_part.substr(0, i);
         break;
       }
     }
     last_part.append(suggested_value);
     parts[parts.size() - 1] = last_part;
 
     new_value = JoinString(parts, ',');
   }
-  SetNodeText(new_value, &element_);
+  SetNodeText(new_value, input_element);
 }
 
 void AutofillAgent::OnFormDataFilled(int query_id,
                                      const FormData& form) {
   if (!render_view()->GetWebView() || query_id != autofill_query_id_)
     return;
 
   was_query_node_autofilled_ = element_.isAutofilled();
 
   switch (autofill_action_) {
@@ skipping 41 matching lines @@
     // TODO(isherman): There seem to be rare cases where this code *is*
     // reachable: see [ http://crbug.com/96321#c6 ].  Ideally we would
     // understand those cases and fix the code to avoid them.  However, so far I
     // have been unable to reproduce such a case locally.  If you hit this
     // NOTREACHED(), please file a bug against me.
     NOTREACHED();
   }
 }
 
 void AutofillAgent::OnSetNodeText(const base::string16& value) {
-  SetNodeText(value, &element_);
+  WebInputElement* input_element = toWebInputElement(&element_);

[Ilya Sherman, 2014/02/14 02:44:40]

Ditto.

[ziran.sun, 2014/02/17 15:43:45]

Done.

+  SetNodeText(value, input_element);
 }
 
 void AutofillAgent::OnAcceptDataListSuggestion(const base::string16& value) {
   AcceptDataListSuggestion(value);
 }
 
 void AutofillAgent::OnAcceptPasswordAutofillSuggestion(
     const base::string16& username) {
   // 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
@@ skipping 15 matching lines @@
       result = WebFormElement::AutocompleteResultErrorInvalid;
   }
 
   in_flight_request_form_.finishRequestAutocomplete(result);
   in_flight_request_form_.reset();
 }
 
 void AutofillAgent::OnPageShown() {
 }
 
-void AutofillAgent::ShowSuggestions(const WebInputElement& element,
+void AutofillAgent::ShowSuggestions(const WebFormControlElement& element,
                                     bool autofill_on_empty_values,
                                     bool requires_caret_at_end,
                                     bool display_warning_if_disabled,
                                     bool datalist_only) {
-  if (!element.isEnabled() || element.isReadOnly() || !element.isTextField() ||
-      element.isPasswordField())
-    return;
-  if (!datalist_only && !element.suggestedValue().isEmpty())
+  const WebInputElement* input_element = toWebInputElement(&element);
+  if (!element.isEnabled() || element.isReadOnly())
     return;
 
-  // Don't attempt to autofill with values that are too large or if filling
-  // criteria are not met.
-  WebString value = element.editingValue();
-  if (!datalist_only &&
-      (value.length() > kMaxDataLength ||
-       (!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.
-    HideAutofillUI();
+  if (IsAutofillableInputElement(input_element)) {
+    if (!input_element->isTextField() || input_element->isPasswordField())
+      return;
+    if (!datalist_only && !input_element->suggestedValue().isEmpty())
+      return;
+    // Don't attempt to autofill with values that are too large or if filling
+    // criteria are not met.
+    WebString value = input_element->editingValue();
+    if (!datalist_only &&
+        (value.length() > kMaxDataLength ||
+         (!autofill_on_empty_values && value.isEmpty()) ||
+         (requires_caret_at_end &&
+          (input_element->selectionStart() != input_element->selectionEnd() ||
+           input_element->selectionEnd() !=
+               static_cast<int>(value.length()))))) {
+      // Any popup currently showing is obsolete.
+      HideAutofillUI();
+      return;
+    }
+
+    if (password_autofill_agent_->ShowSuggestions(*input_element))
+      return;

[Ilya Sherman, 2014/02/14 02:44:40]

It's important that this follow the assignment of "element_ = element"

[ziran.sun, 2014/02/17 15:43:45]

Done.

+  } else if (IsTextAreaElement(element) &&
+             !element.toConst<WebTextAreaElement>().suggestedValue().isEmpty())
     return;

[Ilya Sherman, 2014/02/14 02:44:40]

nit: Please include curly braces on the else, since they're present on the if.

[ziran.sun, 2014/02/17 15:43:45]

Done.

-  }
 
   element_ = element;
-  if (password_autofill_agent_->ShowSuggestions(element))
-    return;
 
   // If autocomplete is disabled at the field level, ensure that the native
   // UI won't try to show a warning, since that may conflict with a custom
   // popup. Note that we cannot use the WebKit method element.autoComplete()
   // as it does not allow us to distinguish the case where autocomplete is
   // disabled for *both* the element and for the form.
   const base::string16 autocomplete_attribute =
       element.getAttribute("autocomplete");
   if (LowerCaseEqualsASCII(autocomplete_attribute, "off"))
     display_warning_if_disabled = false;
 
   QueryAutofillSuggestions(element,
                            display_warning_if_disabled,
                            datalist_only);
 }
 
-void AutofillAgent::QueryAutofillSuggestions(const WebInputElement& element,
-                                             bool display_warning_if_disabled,
-                                             bool datalist_only) {
+void AutofillAgent::QueryAutofillSuggestions(
+    const WebFormControlElement& element,
+    bool display_warning_if_disabled,
+    bool datalist_only) {
   if (!element.document().frame())
     return;
 
   static int query_counter = 0;
   autofill_query_id_ = query_counter++;
   display_warning_if_disabled_ = display_warning_if_disabled;
+  const WebInputElement* input_element = toWebInputElement(&element);
 
   // If autocomplete is disabled at the form level, we want to see if there
   // would have been any suggestions were it enabled, so that we can show a
   // warning.  Otherwise, we want to ignore fields that disable autocomplete, so
   // that the suggestions list does not include suggestions for these form
   // fields -- see comment 1 on http://crbug.com/69914
-  const RequirementsMask requirements =
-      element.autoComplete() ? REQUIRE_AUTOCOMPLETE : REQUIRE_NONE;
+  RequirementsMask requirements = REQUIRE_NONE;
+  if (IsAutofillableInputElement(input_element))
+    requirements =
+        input_element->autoComplete() ? REQUIRE_AUTOCOMPLETE : REQUIRE_NONE;

[Ilya Sherman, 2014/02/14 02:44:40]

nit: Please add curly braces, since this spans multiple lines.

[ziran.sun, 2014/02/17 15:43:45]

Done.

 
   FormData form;
   FormFieldData field;
-  if (!FindFormAndFieldForInputElement(element, &form, &field, requirements)) {
+  if (!FindFormAndFieldForFormControlElement(element, &form,
+                                             &field, requirements)) {

[Ilya Sherman, 2014/02/14 02:44:40]

nit: This is a strange way to wrap the line.  Probably keep "&field" on the line
above.

[ziran.sun, 2014/02/17 15:43:45]

Done.

     // If we didn't find the cached form, at least let autocomplete have a shot
     // at providing suggestions.
     WebFormControlElementToFormField(element, EXTRACT_VALUE, &field);
   }
   if (datalist_only)
     field.should_autocomplete = false;
 
   gfx::RectF bounding_box_scaled =
       GetScaledBoundingBox(web_view_->pageScaleFactor(), &element_);
 
-  // Find the datalist values and send them to the browser process.
-  std::vector<base::string16> data_list_values;
-  std::vector<base::string16> data_list_labels;
-  GetDataListSuggestions(element_,
+  if (IsAutofillableInputElement(input_element)) {
+    // Find the datalist values and send them to the browser process.
+    std::vector<base::string16> data_list_values;
+    std::vector<base::string16> data_list_labels;
+    GetDataListSuggestions(*input_element,
                          datalist_only,
                          &data_list_values,
                          &data_list_labels);
-  TrimStringVectorForIPC(&data_list_values);
-  TrimStringVectorForIPC(&data_list_labels);
+    TrimStringVectorForIPC(&data_list_values);
+    TrimStringVectorForIPC(&data_list_labels);
 
-  Send(new AutofillHostMsg_SetDataList(routing_id(),
+    Send(new AutofillHostMsg_SetDataList(routing_id(),
                                        data_list_values,
                                        data_list_labels));
-
+  }
   Send(new AutofillHostMsg_QueryFormFieldAutofill(routing_id(),
                                                   autofill_query_id_,
                                                   form,
                                                   field,
                                                   bounding_box_scaled,
                                                   display_warning_if_disabled));
 }
 
 void AutofillAgent::FillAutofillFormData(const WebNode& node,
                                          int unique_id,
                                          AutofillAction action) {
   DCHECK_GT(unique_id, 0);
 
   static int query_counter = 0;
   autofill_query_id_ = query_counter++;
 
   FormData form;
   FormFieldData field;
-  if (!FindFormAndFieldForInputElement(node.toConst<WebInputElement>(), &form,
-                                       &field, REQUIRE_AUTOCOMPLETE)) {
+  if (!FindFormAndFieldForFormControlElement(
+      node.toConst<WebFormControlElement>(),

[Ilya Sherman, 2014/02/14 02:44:40]

nit: This should be indented four spaces from the 'F' in "Find" above, i.e. five
more spaces than it currently is.

[ziran.sun, 2014/02/17 15:43:45]

Done.

+      &form,
+      &field,
+      REQUIRE_AUTOCOMPLETE)) {
     return;
   }
 
   autofill_action_ = action;
   Send(new AutofillHostMsg_FillAutofillFormData(
       routing_id(), autofill_query_id_, form, field, unique_id));
 }
 
 void AutofillAgent::SetNodeText(const base::string16& value,
                                 blink::WebInputElement* node) {
@@ skipping 19 matching lines @@
     // Only monitors dynamic forms created in the top frame. Dynamic forms
     // inserted in iframes are not captured yet.
     if (!frame->parent()) {
       password_autofill_agent_->OnDynamicFormsSeen(frame);
       return;
     }
   }
 }
 
 }  // namespace autofill