Add Datalist Support to New Autofill UI

chrome/browser/autofill/autofill_external_delegate.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 "base/utf_string_conversions.h"
 #include "chrome/browser/autocomplete_history_manager.h"
 #include "chrome/browser/autofill/autofill_external_delegate.h"
 #include "chrome/browser/autofill/autofill_manager.h"
 #include "chrome/common/autofill_messages.h"
 #include "chrome/common/chrome_constants.h"
@@ skipping 12 matching lines @@
 
 AutofillExternalDelegate::AutofillExternalDelegate(
     TabContentsWrapper* tab_contents_wrapper,
     AutofillManager* autofill_manager)
     : tab_contents_wrapper_(tab_contents_wrapper),
       autofill_manager_(autofill_manager),
       password_autofill_manager_(
           tab_contents_wrapper ? tab_contents_wrapper->web_contents() : NULL),
       autofill_query_id_(0),
       display_warning_if_disabled_(false),
-      has_shown_autofill_popup_for_current_edit_(false) {
+      has_shown_autofill_popup_for_current_edit_(false),
+      popup_visible_(false) {
 }
 
 void AutofillExternalDelegate::SelectAutofillSuggestionAtIndex(int unique_id) {
-  if (unique_id == WebAutofillClient::MenuItemIDAutofillOptions ||
-      unique_id == WebAutofillClient::MenuItemIDClearForm ||
-      unique_id == WebAutofillClient::MenuItemIDSeparator ||
-      unique_id == WebAutofillClient::MenuItemIDWarningMessage)
-    return;
-
   ClearPreviewedForm();
 
-  if (unique_id == WebAutofillClient::MenuItemIDPasswordEntry)
-    return;
-
-  FillAutofillFormData(unique_id, true);
+  // Only preview the data if it is a profile.
+  if (unique_id > 0)
+    FillAutofillFormData(unique_id, true);
 }
 
 void AutofillExternalDelegate::OnQuery(int query_id,
                                        const webkit::forms::FormData& form,
                                        const webkit::forms::FormField& field,
                                        const gfx::Rect& bounds,
                                        bool display_warning_if_disabled) {
   autofill_query_form_ = form;
   autofill_query_field_ = field;
   display_warning_if_disabled_ = display_warning_if_disabled;
   autofill_query_id_ = query_id;
 
   OnQueryPlatformSpecific(query_id, form, field, bounds);
 }
 
 void AutofillExternalDelegate::OnSuggestionsReturned(
     int query_id,
     const std::vector<string16>& values,
     const std::vector<string16>& labels,
     const std::vector<string16>& icons,
     const std::vector<int>& unique_ids) {
   if (query_id != autofill_query_id_)
     return;
 
-  if (values.empty()) {
-    // No suggestions, any popup currently showing is obsolete.
-    HideAutofillPopup();
-    return;
-  }
-
   std::vector<string16> v(values);
   std::vector<string16> l(labels);
   std::vector<string16> i(icons);
   std::vector<int> ids(unique_ids);
 
   // Add a separator to go between the values and menu items.
   v.push_back(string16());
   l.push_back(string16());
   i.push_back(string16());
   ids.push_back(WebAutofillClient::MenuItemIDSeparator);
 
-  DCHECK_GT(ids.size(), 0U);
-  if (!autofill_query_field_.should_autocomplete) {
-    // If autofill is disabled and we had suggestions, show a warning instead.
-    v.assign(1, l10n_util::GetStringUTF16(IDS_AUTOFILL_WARNING_FORM_DISABLED));
-    l.assign(1, string16());
-    i.assign(1, string16());
-    ids.assign(1, WebAutofillClient::MenuItemIDWarningMessage);
-  } else if (ids[0] < 0 && ids.size() > 1) {
-    // If we received a warning instead of suggestions from autofill but regular
-    // suggestions from autocomplete, don't show the autofill warning.
-    v.erase(v.begin());
-    l.erase(l.begin());
-    i.erase(i.begin());
-    ids.erase(ids.begin());
-  }
-
-  // If we were about to show a warning and we shouldn't, don't.
-  if (ids[0] < 0 && !display_warning_if_disabled_)
-    return;

[Ilya Sherman, 2012/06/04 22:05:01]

What happened to this early return?

[csharp, 2012/06/06 14:06:52]

Because we now have datalist elements that might appear in the popup we don't
want to return here because then we fail to show them. The code in
ApplyAutofillWarnings deletes the warning now if we added it and shouldn't show
it.

-
   // Only include "Autofill Options" special menu item if we have Autofill
   // items, identified by |unique_ids| having at least one valid value.
   bool has_autofill_item = false;
   for (size_t i = 0; i < ids.size(); ++i) {
     if (ids[i] > 0) {
       has_autofill_item = true;
       break;
     }
   }
 
-  // The form has been auto-filled, so give the user the chance to clear the
-  // form.  Append the 'Clear form' menu item.
-  if (has_autofill_item && autofill_query_field_.is_autofilled) {
-    v.push_back(l10n_util::GetStringUTF16(IDS_AUTOFILL_CLEAR_FORM_MENU_ITEM));
-    l.push_back(string16());
-    i.push_back(string16());
-    ids.push_back(WebAutofillClient::MenuItemIDClearForm);
-  }
+  ApplyAutofillWarnings(&v, &l, &i, &ids);

[Ilya Sherman, 2012/06/04 22:05:01]

This should happen before determining the value of |has_autofill_item|, since
suggestions can be replaced by a warning.

[csharp, 2012/06/06 14:06:52]

Done.

 
-  if (has_autofill_item) {
-    // Append the 'Chrome Autofill options' menu item;
-    v.push_back(l10n_util::GetStringUTF16(IDS_AUTOFILL_OPTIONS_POPUP));
-    l.push_back(string16());
-    i.push_back(string16());
-    ids.push_back(WebAutofillClient::MenuItemIDAutofillOptions);
-  }
+  if (has_autofill_item)
+    ApplyAutofillOptions(&v, &l, &i, &ids);
+
+  InsertDataListValues(&v, &l, &i, &ids);
 
   // Remove the separator if it is the last element.
   if (*(ids.rbegin()) == WebAutofillClient::MenuItemIDSeparator) {
     v.pop_back();
     l.pop_back();
     i.pop_back();
     ids.pop_back();
   }
 
+  if (v.empty()) {
+    // No suggestions, any popup currently showing is obsolete.
+    HideAutofillPopup();
+    return;
+  }
+
   // Send to display.
-  if (!v.empty() && autofill_query_field_.is_focusable)
+  if (!v.empty() && autofill_query_field_.is_focusable) {
+    popup_visible_ = true;
     ApplyAutofillSuggestions(v, l, i, ids);
+  }
 
   tab_contents_wrapper_->autofill_manager()->OnDidShowAutofillSuggestions(
       has_autofill_item && !has_shown_autofill_popup_for_current_edit_);
   has_shown_autofill_popup_for_current_edit_ |= has_autofill_item;
 }
 
 void AutofillExternalDelegate::OnShowPasswordSuggestions(
     const std::vector<string16>& suggestions,
     const webkit::forms::FormField& field,
     const gfx::Rect& bounds) {
   autofill_query_field_ = field;
 
   if (suggestions.empty()) {
     HideAutofillPopup();
     return;
   }
 
   SetBounds(bounds);
 
   std::vector<string16> empty(suggestions.size());
   std::vector<int> password_ids(suggestions.size(),
                                 WebAutofillClient::MenuItemIDPasswordEntry);
   ApplyAutofillSuggestions(suggestions, empty, empty, password_ids);
 }
 
+void AutofillExternalDelegate::SetCurrentDataListValues(
+    const std::vector<string16>& data_list_values,
+    const std::vector<string16>& data_list_labels,
+    const std::vector<string16>& data_list_icons,
+    const std::vector<int>& data_list_unique_ids) {
+  // TODO(csharp): Modify the code to allow the data list values to change
+  // even if the popup is visible.
+  // crbug.com/131003

[Ilya Sherman, 2012/06/04 22:05:01]

nit: Please prepend http:// to the link URL

[csharp, 2012/06/06 14:06:52]

Done.

+  if (!popup_visible_) {
+    data_list_values_ = data_list_values;
+    data_list_labels_ = data_list_labels;
+    data_list_icons_ = data_list_icons;
+    data_list_unique_ids_ = data_list_unique_ids;
+  }
+}
+
 void AutofillExternalDelegate::RemoveAutocompleteEntry(const string16& value) {
   if (tab_contents_wrapper_) {
     tab_contents_wrapper_->autocomplete_history_manager()->
         OnRemoveAutocompleteEntry(autofill_query_field_.name, value);
   }
 }
 
 void AutofillExternalDelegate::RemoveAutofillProfileOrCreditCard(
     int unique_id) {
   autofill_manager_->RemoveAutofillProfileOrCreditCard(unique_id);
 }
 
 
 void AutofillExternalDelegate::DidEndTextFieldEditing() {
   HideAutofillPopup();
 
   has_shown_autofill_popup_for_current_edit_ = false;
 }
 
 bool AutofillExternalDelegate::DidAcceptAutofillSuggestions(
     const string16& value,
     int unique_id,
     unsigned index) {
   // If the selected element is a warning we don't want to do anything.
   if (unique_id == WebAutofillClient::MenuItemIDWarningMessage)
     return false;
 
+  RenderViewHost* host =
+      tab_contents_wrapper_->web_contents()->GetRenderViewHost();
+
   if (unique_id == WebAutofillClient::MenuItemIDAutofillOptions) {
     // User selected 'Autofill Options'.
     autofill_manager_->OnShowAutofillDialog();
   } else if (unique_id == WebAutofillClient::MenuItemIDClearForm) {
     // User selected 'Clear form'.
-    RenderViewHost* host =
-        tab_contents_wrapper_->web_contents()->GetRenderViewHost();
     host->Send(new AutofillMsg_ClearForm(host->GetRoutingID()));
   } else if (unique_id == WebAutofillClient::MenuItemIDPasswordEntry &&
              password_autofill_manager_.DidAcceptAutofillSuggestion(
                  autofill_query_field_, value)) {
     // DidAcceptAutofillSuggestion has already handled the work to fill in
     // the page as required.
+  } else if (unique_id == WebAutofillClient::MenuItemIDDataListEntry) {
+    host->Send(new AutofillMsg_AcceptDataListSuggestion(host->GetRoutingID(),
+                                                        value));
   } else if (unique_id == WebAutofillClient::MenuItemIDAutocompleteEntry) {
     // User selected an Autocomplete, so we fill directly.
-    RenderViewHost* host =
-        tab_contents_wrapper_->web_contents()->GetRenderViewHost();
     host->Send(new AutofillMsg_SetNodeText(
         host->GetRoutingID(),
         value));
   } else {
     FillAutofillFormData(unique_id, false);
   }
 
   HideAutofillPopup();
 
   return true;
 }
 
 void AutofillExternalDelegate::ClearPreviewedForm() {
   RenderViewHost* host =
       tab_contents_wrapper_->web_contents()->GetRenderViewHost();
   host->Send(new AutofillMsg_ClearPreviewedForm(host->GetRoutingID()));
 }
 
 void AutofillExternalDelegate::HideAutofillPopup() {
+  popup_visible_ = false;
+
   HideAutofillPopupInternal();
 }
 
 void AutofillExternalDelegate::Reset() {
   HideAutofillPopup();
 
   password_autofill_manager_.Reset();
 }
 
 void AutofillExternalDelegate::AddPasswordFormMapping(
@@ skipping 15 matching lines @@
         host->GetRoutingID()));
   }
 
   // Fill the values for the whole form.
   autofill_manager_->OnFillAutofillFormData(autofill_query_id_,
                                             autofill_query_form_,
                                             autofill_query_field_,
                                             unique_id);
 }
 
+void AutofillExternalDelegate::ApplyAutofillWarnings(
+    std::vector<string16>* autofill_values,
+    std::vector<string16>* autofill_labels,
+    std::vector<string16>* autofill_icons,
+    std::vector<int>* autofill_unique_ids) {
+  if (!autofill_query_field_.should_autocomplete) {
+    // If autofill is disabled and we had suggestions, show a warning instead.
+    autofill_values->assign(
+        1,
+        l10n_util::GetStringUTF16(IDS_AUTOFILL_WARNING_FORM_DISABLED));

[Ilya Sherman, 2012/06/04 22:05:01]

nit: I would probably move this to previous line, but it's also fine as-is if
you prefer this formatting.

[csharp, 2012/06/06 14:06:52]

Done.

+    autofill_labels->assign(1, string16());
+    autofill_icons->assign(1, string16());
+    autofill_unique_ids->assign(1, WebAutofillClient::MenuItemIDWarningMessage);
+  } else if ((*autofill_unique_ids)[0] ==

[Ilya Sherman, 2012/06/04 22:05:01]

What if the vector is empty?

[csharp, 2012/06/06 14:06:52]

Done.

+               WebAutofillClient::MenuItemIDWarningMessage &&

[Ilya Sherman, 2012/06/04 22:05:01]

nit: This should probably be indented two more spaces

[csharp, 2012/06/06 14:06:52]

Done.

+             autofill_unique_ids->size() > 1) {
+    // If we received a warning instead of suggestions from autofill but regular
+    // suggestions from autocomplete, don't show the autofill warning.
+    autofill_values->erase(autofill_values->begin());
+    autofill_labels->erase(autofill_labels->begin());
+    autofill_icons->erase(autofill_icons->begin());
+    autofill_unique_ids->erase(autofill_unique_ids->begin());
+  }
+
+  // If we were about to show a warning and we shouldn't, don't.
+  if ((*autofill_unique_ids)[0] ==

[Ilya Sherman, 2012/06/04 22:05:01]

What if the vector is empty?

[csharp, 2012/06/06 14:06:52]

Done.

+      WebAutofillClient::MenuItemIDWarningMessage &&

[Ilya Sherman, 2012/06/04 22:05:01]

nit: This should probably be indented 4 more spaces.

[csharp, 2012/06/06 14:06:52]

Done.

+      !display_warning_if_disabled_) {
+    autofill_values->clear();
+    autofill_labels->clear();
+    autofill_icons->clear();
+    autofill_unique_ids->clear();
+  }
+}
+
+void AutofillExternalDelegate::ApplyAutofillOptions(
+    std::vector<string16>* autofill_values,
+    std::vector<string16>* autofill_labels,
+    std::vector<string16>* autofill_icons,
+    std::vector<int>* autofill_unique_ids) {
+  // The form has been auto-filled, so give the user the chance to clear the
+  // form.  Append the 'Clear form' menu item.
+  if (autofill_query_field_.is_autofilled) {
+    autofill_values->push_back(
+        l10n_util::GetStringUTF16(IDS_AUTOFILL_CLEAR_FORM_MENU_ITEM));
+    autofill_labels->push_back(string16());
+    autofill_icons->push_back(string16());
+    autofill_unique_ids->push_back(WebAutofillClient::MenuItemIDClearForm);
+  }
+
+  // Append the 'Chrome Autofill options' menu item;
+  autofill_values->push_back(
+      l10n_util::GetStringUTF16(IDS_AUTOFILL_OPTIONS_POPUP));
+  autofill_labels->push_back(string16());
+  autofill_icons->push_back(string16());
+  autofill_unique_ids->push_back(WebAutofillClient::MenuItemIDAutofillOptions);
+}
+
+void AutofillExternalDelegate::InsertDataListValues(
+    std::vector<string16>* autofill_values,
+    std::vector<string16>* autofill_labels,
+    std::vector<string16>* autofill_icons,
+    std::vector<int>* autofill_unique_ids) {
+  if (!data_list_values_.empty()) {

[Ilya Sherman, 2012/06/04 22:05:01]

nit: Please write this as an early-return.  This allows you to reduce the
indentation level for the body of the implementation.

[csharp, 2012/06/06 14:06:52]

Done.

+    // Insert the separator between the datalist and Autofill values (if there
+    // are any).
+    if (autofill_values->size() != 0) {

[Ilya Sherman, 2012/06/04 22:05:01]

nit: if (!autofill_values.empty())

[csharp, 2012/06/06 14:06:52]

Done.

+      autofill_values->insert(autofill_values->begin(), string16());
+      autofill_labels->insert(autofill_labels->begin(), string16());
+      autofill_icons->insert(autofill_icons->begin(), string16());
+      autofill_unique_ids->insert(autofill_unique_ids->begin(),
+                                  WebAutofillClient::MenuItemIDSeparator);
+    }
+
+    // Insert the datalist elements.
+    autofill_values->insert(autofill_values->begin(),
+                            data_list_values_.begin(),
+                            data_list_values_.end());
+    autofill_labels->insert(autofill_labels->begin(),
+                            data_list_labels_.begin(),
+                            data_list_labels_.end());
+    autofill_icons->insert(autofill_icons->begin(),
+                           data_list_icons_.begin(),
+                           data_list_icons_.end());
+    autofill_unique_ids->insert(autofill_unique_ids->begin(),
+                                data_list_unique_ids_.begin(),
+                                data_list_unique_ids_.end());
+  }
+}
+
 // Add a "!defined(OS_YOUROS) for each platform that implements this
 // in an autofill_external_delegate_YOUROS.cc.  Currently there are
 // none, so all platforms use the default.
 
 #if !defined(OS_ANDROID) && !defined(TOOLKIT_GTK)
 
 AutofillExternalDelegate* AutofillExternalDelegate::Create(
     TabContentsWrapper*, AutofillManager*) {
   return NULL;
 }
 
 #endif