Support datalist UI for <input type=email multiple>

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/time.h"
+#include "base/string_util.h"
+#include "base/string_split.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/common/autofill_messages.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/renderer/autofill/form_autofill_util.h"
 #include "chrome/renderer/autofill/password_autofill_manager.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"
@@ skipping 16 matching lines @@
 using WebKit::WebFormElement;
 using WebKit::WebFrame;
 using WebKit::WebInputElement;
 using WebKit::WebKeyboardEvent;
 using WebKit::WebNode;
 using WebKit::WebNodeCollection;
 using WebKit::WebOptionElement;
 using WebKit::WebString;
 using webkit::forms::FormData;
 using webkit::forms::FormDataPredictions;
-
+#include <iostream>

[Ilya Sherman, 2012/05/07 23:34:52]

nit: Did you mean to add this #include, or was it for debugging purposes?  If
you meant to add it, this should go on line 7 (preceding the other #includes),
and should be followed by a blank line (separating it from the #includes of
Chromium code, as opposed to system library code).

[keishi, 2012/05/09 01:38:21]

Sorry my mistake.

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

[Ilya Sherman, 2012/05/07 23:34:52]

What is the difference between element.value() and element.editingValue()?

[keishi, 2012/05/09 01:38:21]

There is no difference for <input type=text>. But for others types like email,
element.value() returns the sanitized value and editingValue() will return the
raw visible value.

For example, if you type in "a@a.com, b" (separated with comma and space)
element.value() returns "a@a.com,b" without the extra space
element.selectionEnd() returns the position with the extra space

so you can't use element.value().length() and element.selectionEnd() to tell if
the caret is at the end or not.

+  if (element.isMultiple() &&
+      element.formControlType() == WebString::fromUTF8("email")) {
+    std::vector<string16> parts;
+    base::SplitStringDontTrim(prefix, ',', &parts);
+    if (parts.size() > 0)
+      TrimWhitespace(parts[parts.size() - 1], TRIM_LEADING, &prefix);
+  }
   for (WebOptionElement option = options.firstItem().to<WebOptionElement>();
       !option.isNull(); option = options.nextItem().to<WebOptionElement>()) {

[Ilya Sherman, 2012/05/07 23:34:52]

nit: This line should be indented one more space.  (Not related to this CL, but
might as well fix it while you're here.)

[keishi, 2012/05/09 01:38:21]

ok.

-    if (!StartsWith(option.value(), element.value(), false))
+    if (!StartsWith(option.value(), prefix, false))
       continue;
 
     values->push_back(option.value());
     if (option.value() != option.label())
       labels->push_back(option.label());
     else
       labels->push_back(string16());
     icons->push_back(string16());
     item_ids->push_back(WebAutofillClient::MenuItemIDDataListEntry);
   }
@@ skipping 127 matching lines @@
     case WebAutofillClient::MenuItemIDAutofillOptions:
       // User selected 'Autofill Options'.
       Send(new AutofillHostMsg_ShowAutofillDialog(routing_id()));
       break;
     case WebAutofillClient::MenuItemIDClearForm:
       // User selected 'Clear form'.
       form_cache_.ClearFormWithElement(element_);
       break;
     case WebAutofillClient::MenuItemIDAutocompleteEntry:
     case WebAutofillClient::MenuItemIDPasswordEntry:
-    case WebAutofillClient::MenuItemIDDataListEntry:
-      // User selected an Autocomplete or password or datalist entry, so we
-      // fill directly.
+      // User selected an Autocomplete or password entry, so we fill directly.
       SetNodeText(value, &element_);
       break;
+    case WebAutofillClient::MenuItemIDDataListEntry: {
+      string16 new_value = value;
+      // If this element takes multiple values then replace the last part with
+      // the suggestion.
+      if (element_.isMultiple() &&
+          element_.formControlType() == WebString::fromUTF8("email")) {
+        std::vector<string16> parts;
+
+        base::SplitStringDontTrim(element_.editingValue(), ',', &parts);
+        if (parts.size() == 0)
+          parts.push_back(string16());
+
+        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(value);
+        parts[parts.size() - 1] = last_part;
+
+        new_value = JoinString(parts, ',');
+      }
+      SetNodeText(new_value, &element_);
+      break;
+    }
     default:
       // A positive item_id is a unique id for an autofill (vs. autocomplete)
       // suggestion.
       DCHECK_GT(item_id, 0);
       // Fill the values for the whole form.
       FillAutofillFormData(node, item_id, AUTOFILL_FILL);
   }
 }
 
 void AutofillAgent::didSelectAutofillSuggestion(const WebNode& node,
@@ skipping 179 matching lines @@
   l.insert(l.end(), labels.begin(), labels.end());
   i.insert(i.end(), icons.begin(), icons.end());
   ids.insert(ids.end(), item_ids.begin(), item_ids.end());
 
   WebKit::WebView* web_view = render_view()->GetWebView();
   if (!web_view)
     return;
 
   if (v.empty()) {
     // No suggestions, any popup currently showing is obsolete.
-    web_view->hidePopups();
+    HidePopups();
     return;
   }
 
   // Send to WebKit for display.
   web_view->applyAutofillSuggestions(element, v, l, i, ids);
 
   Send(new AutofillHostMsg_DidShowAutofillSuggestions(
       routing_id(),
       has_autofill_item && !has_shown_autofill_popup_for_current_edit_));
   has_shown_autofill_popup_for_current_edit_ |= has_autofill_item;
@@ skipping 68 matching lines @@
 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.value();
+  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
@@ skipping 54 matching lines @@
   autofill_action_ = action;
   Send(new AutofillHostMsg_FillAutofillFormData(
       routing_id(), autofill_query_id_, form, field, unique_id));
 }
 
 void AutofillAgent::SetNodeText(const string16& value,
                                 WebKit::WebInputElement* node) {
   string16 substring = value;
   substring = substring.substr(0, node->maxLength());
 
-  node->setValue(substring, true);
+  WebKit::WebView* web_view = render_view()->GetWebView();
+  if (!web_view || !web_view->focusedFrame())
+    return;
+
+  web_view->focusedFrame()->executeCommand(WebString::fromUTF8("selectAll"));
+  web_view->focusedFrame()->executeCommand(WebString::fromUTF8("InsertText"),
+                                           substring);

[Ilya Sherman, 2012/05/07 23:34:52]

Is there really no more direct way to achieve the desired effect?  Passing
strings as method calls feels very off for C++ code.

[keishi, 2012/05/09 01:38:21]

There is an inner text field that's being edited but we don't want to expose
that in the WebKit API.

[Ilya Sherman, 2012/05/09 02:38:58]

If we are exposing |editingValue()|, it makes sense to me to expose
|setEditingValue()| as well.  What is the motivation for not wanting to expose
it, and instead making clients jump through hoops for this sort of
functionality?

+  weak_ptr_factory_.InvalidateWeakPtrs();
+  MessageLoop::current()->PostTask(FROM_HERE,
+                                   base::Bind(&AutofillAgent::HidePopups,
+                                              weak_ptr_factory_.GetWeakPtr()));

[Ilya Sherman, 2012/05/07 23:34:52]

Hmm, I don't understand the motivation for the change to this method.  What's
wrong with calling into node->setValue()?

[keishi, 2012/05/09 01:38:21]

if you do setValue("a@.com, b@b.com"), the text field will show
"a@a.com,b@b.com".

I did this because it bugged me that the space kept vanishing.

+}
+
+void AutofillAgent::HidePopups() {
+  WebKit::WebView* web_view = render_view()->GetWebView();
+  if (web_view)
+    web_view->hidePopups();
 }
 
 }  // namespace autofill