blob: 072a05c8955b557b872cce612b9feda866247f48 [file] [log] [blame]
// 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/browser/ui/autofill/autofill_popup_controller_impl.h"
#include <algorithm>
#include <utility>
#include "base/bind.h"
#include "base/command_line.h"
#include "base/i18n/rtl.h"
#include "base/logging.h"
#include "base/macros.h"
#include "base/optional.h"
#include "base/strings/utf_string_conversions.h"
#include "build/build_config.h"
#include "chrome/browser/ui/autofill/autofill_popup_view.h"
#include "components/autofill/content/browser/content_autofill_driver.h"
#include "components/autofill/core/browser/ui/autofill_popup_delegate.h"
#include "components/autofill/core/browser/ui/popup_item_ids.h"
#include "components/autofill/core/browser/ui/suggestion.h"
#include "content/public/browser/native_web_keyboard_event.h"
#include "ui/events/event.h"
#include "ui/gfx/canvas.h"
#include "ui/gfx/text_elider.h"
#include "ui/gfx/text_utils.h"
#if defined(OS_ANDROID)
#include "chrome/browser/autofill/manual_filling_controller_impl.h"
#include "chrome/browser/password_manager/touch_to_fill_controller.h"
using FillingSource = ManualFillingController::FillingSource;
#endif
using base::WeakPtr;
namespace autofill {
#if !defined(OS_MACOSX)
// static
WeakPtr<AutofillPopupControllerImpl> AutofillPopupControllerImpl::GetOrCreate(
WeakPtr<AutofillPopupControllerImpl> previous,
WeakPtr<AutofillPopupDelegate> delegate,
content::WebContents* web_contents,
gfx::NativeView container_view,
const gfx::RectF& element_bounds,
base::i18n::TextDirection text_direction) {
if (previous.get() && previous->delegate_.get() == delegate.get() &&
previous->container_view() == container_view) {
previous->SetElementBounds(element_bounds);
previous->ClearState();
return previous;
}
if (previous.get())
previous->Hide();
AutofillPopupControllerImpl* controller =
new AutofillPopupControllerImpl(
delegate, web_contents, container_view, element_bounds,
text_direction);
return controller->GetWeakPtr();
}
#endif
AutofillPopupControllerImpl::AutofillPopupControllerImpl(
base::WeakPtr<AutofillPopupDelegate> delegate,
content::WebContents* web_contents,
gfx::NativeView container_view,
const gfx::RectF& element_bounds,
base::i18n::TextDirection text_direction)
: controller_common_(element_bounds, text_direction, container_view),
web_contents_(web_contents),
layout_model_(this, delegate->GetPopupType() == PopupType::kCreditCards),
delegate_(delegate) {
ClearState();
delegate->RegisterDeletionCallback(base::BindOnce(
&AutofillPopupControllerImpl::HideViewAndDie, GetWeakPtr()));
}
AutofillPopupControllerImpl::~AutofillPopupControllerImpl() {}
void AutofillPopupControllerImpl::Show(
const std::vector<autofill::Suggestion>& suggestions,
bool autoselect_first_suggestion,
PopupType popup_type) {
SetValues(suggestions);
DCHECK_EQ(suggestions_.size(), elided_values_.size());
DCHECK_EQ(suggestions_.size(), elided_labels_.size());
bool just_created = false;
if (!view_) {
view_ = AutofillPopupView::Create(this);
// It is possible to fail to create the popup, in this case
// treat the popup as hiding right away.
if (!view_) {
delegate_->OnPopupSuppressed();
Hide();
return;
}
just_created = true;
}
#if !defined(OS_ANDROID)
// Android displays the long text with ellipsis using the view attributes.
layout_model_.UpdatePopupBounds();
// Elide the name and label strings so that the popup fits in the available
// space.
for (int i = 0; i < GetLineCount(); ++i) {
bool has_label = !suggestions_[i].label.empty();
ElideValueAndLabelForRow(
i, layout_model_.GetAvailableWidthForRow(i, has_label));
}
#endif
if (just_created) {
#if defined(OS_ANDROID)
if (popup_type == PopupType::kPasswords &&
TouchToFillController::AllowedForWebContents(web_contents_)) {
TouchToFillController::GetOrCreate(web_contents_)->Show(suggestions);
}
ManualFillingController::GetOrCreate(web_contents_)
->UpdateSourceAvailability(FillingSource::AUTOFILL,
!suggestions.empty());
#endif
view_->Show();
if (autoselect_first_suggestion)
SetSelectedLine(0);
} else {
if (selected_line_ && *selected_line_ >= GetLineCount())
selected_line_.reset();
OnSuggestionsChanged();
}
static_cast<ContentAutofillDriver*>(delegate_->GetAutofillDriver())
->RegisterKeyPressHandler(
base::Bind(&AutofillPopupControllerImpl::HandleKeyPressEvent,
base::Unretained(this)));
delegate_->OnPopupShown();
DCHECK_EQ(suggestions_.size(), elided_values_.size());
DCHECK_EQ(suggestions_.size(), elided_labels_.size());
}
void AutofillPopupControllerImpl::UpdateDataListValues(
const std::vector<base::string16>& values,
const std::vector<base::string16>& labels) {
DCHECK_EQ(suggestions_.size(), elided_values_.size());
DCHECK_EQ(suggestions_.size(), elided_labels_.size());
// Remove all the old data list values, which should always be at the top of
// the list if they are present.
while (!suggestions_.empty() &&
suggestions_[0].frontend_id == POPUP_ITEM_ID_DATALIST_ENTRY) {
suggestions_.erase(suggestions_.begin());
elided_values_.erase(elided_values_.begin());
elided_labels_.erase(elided_labels_.begin());
}
// If there are no new data list values, exit (clearing the separator if there
// is one).
if (values.empty()) {
if (!suggestions_.empty() &&
suggestions_[0].frontend_id == POPUP_ITEM_ID_SEPARATOR) {
suggestions_.erase(suggestions_.begin());
elided_values_.erase(elided_values_.begin());
elided_labels_.erase(elided_labels_.begin());
}
// The popup contents have changed, so either update the bounds or hide it.
if (HasSuggestions())
OnSuggestionsChanged();
else
Hide();
return;
}
// Add a separator if there are any other values.
if (!suggestions_.empty() &&
suggestions_[0].frontend_id != POPUP_ITEM_ID_SEPARATOR) {
suggestions_.insert(suggestions_.begin(), autofill::Suggestion());
suggestions_[0].frontend_id = POPUP_ITEM_ID_SEPARATOR;
elided_values_.insert(elided_values_.begin(), base::string16());
elided_labels_.insert(elided_labels_.begin(), base::string16());
}
// Prepend the parameters to the suggestions we already have.
suggestions_.insert(suggestions_.begin(), values.size(), Suggestion());
elided_values_.insert(elided_values_.begin(), values.size(),
base::string16());
elided_labels_.insert(elided_labels_.begin(), values.size(),
base::string16());
for (size_t i = 0; i < values.size(); i++) {
suggestions_[i].value = values[i];
suggestions_[i].label = labels[i];
suggestions_[i].frontend_id = POPUP_ITEM_ID_DATALIST_ENTRY;
// TODO(brettw) it looks like these should be elided.
elided_values_[i] = values[i];
elided_labels_[i] = labels[i];
}
OnSuggestionsChanged();
DCHECK_EQ(suggestions_.size(), elided_values_.size());
DCHECK_EQ(suggestions_.size(), elided_labels_.size());
}
void AutofillPopupControllerImpl::Hide() {
if (delegate_) {
delegate_->ClearPreviewedForm();
delegate_->OnPopupHidden();
static_cast<ContentAutofillDriver*>(delegate_->GetAutofillDriver())
->RemoveKeyPressHandler();
}
HideViewAndDie();
}
void AutofillPopupControllerImpl::ViewDestroyed() {
// The view has already been destroyed so clear the reference to it.
view_ = NULL;
Hide();
}
bool AutofillPopupControllerImpl::HandleKeyPressEvent(
const content::NativeWebKeyboardEvent& event) {
switch (event.windows_key_code) {
case ui::VKEY_UP:
SelectPreviousLine();
return true;
case ui::VKEY_DOWN:
SelectNextLine();
return true;
case ui::VKEY_PRIOR: // Page up.
// Set no line and then select the next line in case the first line is not
// selectable.
SetSelectedLine(base::nullopt);
SelectNextLine();
return true;
case ui::VKEY_NEXT: // Page down.
SetSelectedLine(GetLineCount() - 1);
return true;
case ui::VKEY_ESCAPE:
Hide();
return true;
case ui::VKEY_DELETE:
return (event.GetModifiers() &
content::NativeWebKeyboardEvent::kShiftKey) &&
RemoveSelectedLine();
case ui::VKEY_TAB:
// A tab press should cause the selected line to be accepted, but still
// return false so the tab key press propagates and changes the cursor
// location.
AcceptSelectedLine();
return false;
case ui::VKEY_RETURN:
return AcceptSelectedLine();
default:
return false;
}
}
void AutofillPopupControllerImpl::OnSuggestionsChanged() {
#if !defined(OS_ANDROID)
// TODO(csharp): Since UpdatePopupBounds can change the position of the popup,
// the popup could end up jumping from above the element to below it.
// It is unclear if it is better to keep the popup where it was, or if it
// should try and move to its desired position.
layout_model_.UpdatePopupBounds();
#else
// Assume that suggestions are (still) available. If this is wrong, the method
// |HideViewAndDie| will be called soon after and will hide all suggestions.
ManualFillingController::GetOrCreate(web_contents_)
->UpdateSourceAvailability(FillingSource::AUTOFILL,
/*has_suggestions=*/true);
#endif
// Platform-specific draw call.
view_->OnSuggestionsChanged();
}
void AutofillPopupControllerImpl::SetSelectionAtPoint(const gfx::Point& point) {
SetSelectedLine(layout_model_.LineFromY(point.y()));
}
bool AutofillPopupControllerImpl::AcceptSelectedLine() {
if (!selected_line_)
return false;
DCHECK_LT(*selected_line_, GetLineCount());
if (!CanAccept(suggestions_[*selected_line_].frontend_id))
return false;
AcceptSuggestion(*selected_line_);
return true;
}
void AutofillPopupControllerImpl::SelectionCleared() {
SetSelectedLine(base::nullopt);
}
bool AutofillPopupControllerImpl::HasSelection() const {
return selected_line_.has_value();
}
void AutofillPopupControllerImpl::AcceptSuggestion(int index) {
const autofill::Suggestion& suggestion = suggestions_[index];
#if defined(OS_ANDROID)
auto mf_controller = ManualFillingController::GetOrCreate(web_contents_);
// Accepting a suggestion should hide all suggestions. To prevent them from
// coming up in Multi-Window mode, mark the source as unavailable.
mf_controller->UpdateSourceAvailability(FillingSource::AUTOFILL,
/*has_suggestions=*/false);
mf_controller->Hide();
#endif
delegate_->DidAcceptSuggestion(suggestion.value, suggestion.frontend_id,
index);
}
gfx::Rect AutofillPopupControllerImpl::popup_bounds() const {
return layout_model_.popup_bounds();
}
gfx::NativeView AutofillPopupControllerImpl::container_view() const {
return controller_common_.container_view;
}
const gfx::RectF& AutofillPopupControllerImpl::element_bounds() const {
return controller_common_.element_bounds;
}
void AutofillPopupControllerImpl::SetElementBounds(const gfx::RectF& bounds) {
controller_common_.element_bounds.set_origin(bounds.origin());
controller_common_.element_bounds.set_size(bounds.size());
}
bool AutofillPopupControllerImpl::IsRTL() const {
return controller_common_.text_direction == base::i18n::RIGHT_TO_LEFT;
}
const std::vector<autofill::Suggestion>
AutofillPopupControllerImpl::GetSuggestions() {
return suggestions_;
}
#if !defined(OS_ANDROID)
void AutofillPopupControllerImpl::SetTypesetter(gfx::Typesetter typesetter) {
typesetter_ = typesetter;
}
int AutofillPopupControllerImpl::GetElidedValueWidthForRow(int row) {
return gfx::GetStringWidth(GetElidedValueAt(row),
layout_model_.GetValueFontListForRow(row),
typesetter_);
}
int AutofillPopupControllerImpl::GetElidedLabelWidthForRow(int row) {
return gfx::GetStringWidth(GetElidedLabelAt(row),
layout_model_.GetLabelFontListForRow(row),
typesetter_);
}
#endif
int AutofillPopupControllerImpl::GetLineCount() const {
return suggestions_.size();
}
const autofill::Suggestion& AutofillPopupControllerImpl::GetSuggestionAt(
int row) const {
return suggestions_[row];
}
const base::string16& AutofillPopupControllerImpl::GetElidedValueAt(
int row) const {
return elided_values_[row];
}
const base::string16& AutofillPopupControllerImpl::GetElidedLabelAt(
int row) const {
return elided_labels_[row];
}
bool AutofillPopupControllerImpl::GetRemovalConfirmationText(
int list_index,
base::string16* title,
base::string16* body) {
return delegate_->GetDeletionConfirmationText(
suggestions_[list_index].value, suggestions_[list_index].frontend_id,
title, body);
}
bool AutofillPopupControllerImpl::RemoveSuggestion(int list_index) {
if (!delegate_->RemoveSuggestion(suggestions_[list_index].value,
suggestions_[list_index].frontend_id)) {
return false;
}
// Remove the deleted element.
suggestions_.erase(suggestions_.begin() + list_index);
elided_values_.erase(elided_values_.begin() + list_index);
elided_labels_.erase(elided_labels_.begin() + list_index);
selected_line_.reset();
if (HasSuggestions()) {
delegate_->ClearPreviewedForm();
OnSuggestionsChanged();
} else {
Hide();
}
return true;
}
base::Optional<int> AutofillPopupControllerImpl::selected_line() const {
return selected_line_;
}
const AutofillPopupLayoutModel& AutofillPopupControllerImpl::layout_model()
const {
return layout_model_;
}
void AutofillPopupControllerImpl::SetSelectedLine(
base::Optional<int> selected_line) {
if (selected_line_ == selected_line)
return;
if (selected_line) {
DCHECK_LT(*selected_line, GetLineCount());
if (!CanAccept(suggestions_[*selected_line].frontend_id))
selected_line = base::nullopt;
}
auto previous_selected_line(selected_line_);
selected_line_ = selected_line;
view_->OnSelectedRowChanged(previous_selected_line, selected_line_);
if (selected_line_) {
delegate_->DidSelectSuggestion(suggestions_[*selected_line_].value,
suggestions_[*selected_line_].frontend_id);
} else {
delegate_->ClearPreviewedForm();
}
}
void AutofillPopupControllerImpl::SelectNextLine() {
int new_selected_line = selected_line_ ? *selected_line_ + 1 : 0;
// Skip over any lines that can't be selected.
while (new_selected_line < GetLineCount() &&
!CanAccept(suggestions_[new_selected_line].frontend_id)) {
++new_selected_line;
}
if (new_selected_line >= GetLineCount())
new_selected_line = 0;
SetSelectedLine(new_selected_line);
}
void AutofillPopupControllerImpl::SelectPreviousLine() {
int new_selected_line = selected_line_.value_or(0) - 1;
// Skip over any lines that can't be selected.
while (new_selected_line >= 0 &&
!CanAccept(GetSuggestionAt(new_selected_line).frontend_id)) {
--new_selected_line;
}
if (new_selected_line < 0)
new_selected_line = GetLineCount() - 1;
SetSelectedLine(new_selected_line);
}
bool AutofillPopupControllerImpl::RemoveSelectedLine() {
if (!selected_line_)
return false;
DCHECK_LT(*selected_line_, GetLineCount());
return RemoveSuggestion(*selected_line_);
}
bool AutofillPopupControllerImpl::CanAccept(int id) {
return id != POPUP_ITEM_ID_SEPARATOR &&
id != POPUP_ITEM_ID_INSECURE_CONTEXT_PAYMENT_DISABLED_MESSAGE &&
id != POPUP_ITEM_ID_TITLE;
}
bool AutofillPopupControllerImpl::HasSuggestions() {
if (suggestions_.empty())
return false;
int id = suggestions_[0].frontend_id;
return id > 0 || id == POPUP_ITEM_ID_AUTOCOMPLETE_ENTRY ||
id == POPUP_ITEM_ID_PASSWORD_ENTRY ||
id == POPUP_ITEM_ID_USERNAME_ENTRY ||
id == POPUP_ITEM_ID_DATALIST_ENTRY ||
id == POPUP_ITEM_ID_SCAN_CREDIT_CARD;
}
void AutofillPopupControllerImpl::SetValues(
const std::vector<autofill::Suggestion>& suggestions) {
suggestions_ = suggestions;
elided_values_.resize(suggestions.size());
elided_labels_.resize(suggestions.size());
for (size_t i = 0; i < suggestions.size(); i++) {
elided_values_[i] = suggestions[i].value;
elided_labels_[i] = suggestions[i].label;
}
}
WeakPtr<AutofillPopupControllerImpl> AutofillPopupControllerImpl::GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
#if !defined(OS_ANDROID)
void AutofillPopupControllerImpl::ElideValueAndLabelForRow(
int row,
int available_width) {
int value_width = gfx::GetStringWidth(
suggestions_[row].value, layout_model_.GetValueFontListForRow(row),
typesetter_);
int label_width = gfx::GetStringWidth(
suggestions_[row].label, layout_model_.GetLabelFontListForRow(row),
typesetter_);
int total_text_length = value_width + label_width;
// The line can have no strings if it represents a UI element, such as
// a separator line.
if (total_text_length == 0)
return;
// Each field receives space in proportion to its length.
int value_size = available_width * value_width / total_text_length;
elided_values_[row] = gfx::ElideText(
suggestions_[row].value, layout_model_.GetValueFontListForRow(row),
value_size, gfx::ELIDE_TAIL, typesetter_);
int label_size = available_width * label_width / total_text_length;
elided_labels_[row] = gfx::ElideText(
suggestions_[row].label, layout_model_.GetLabelFontListForRow(row),
label_size, gfx::ELIDE_TAIL, typesetter_);
}
#endif
void AutofillPopupControllerImpl::ClearState() {
// Don't clear view_, because otherwise the popup will have to get regenerated
// and this will cause flickering.
suggestions_.clear();
elided_values_.clear();
elided_labels_.clear();
selected_line_.reset();
}
void AutofillPopupControllerImpl::HideViewAndDie() {
#if defined(OS_ANDROID)
ManualFillingController::GetOrCreate(web_contents_)
->UpdateSourceAvailability(FillingSource::AUTOFILL,
/*has_suggestions=*/false);
#endif
if (view_)
view_->Hide();
delete this;
}
} // namespace autofill