File: compose_manager_impl.cc

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (251 lines) | stat: -rw-r--r-- 10,059 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/compose/core/browser/compose_manager_impl.h"

#include <memory>
#include <optional>
#include <string>
#include <utility>

#include "base/feature_list.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "components/autofill/core/browser/foundations/autofill_client.h"
#include "components/autofill/core/browser/foundations/autofill_manager.h"
#include "components/autofill/core/browser/foundations/browser_autofill_manager.h"
#include "components/autofill/core/browser/suggestions/suggestion.h"
#include "components/autofill/core/browser/suggestions/suggestion_type.h"
#include "components/compose/core/browser/compose_client.h"
#include "components/compose/core/browser/compose_features.h"
#include "components/compose/core/browser/compose_metrics.h"
#include "components/compose/core/browser/compose_utils.h"
#include "components/compose/core/browser/config.h"
#include "components/strings/grit/components_strings.h"
#include "ui/base/l10n/l10n_util.h"
#include "url/origin.h"

namespace compose {

namespace {

using autofill::AutofillDriver;
using autofill::AutofillSuggestionTriggerSource;
using autofill::FieldGlobalId;
using autofill::FormGlobalId;
using autofill::Suggestion;
using autofill::SuggestionType;

// Passes the autofill `text` back into the `field` the dialog was opened on.
// Called upon insertion.
void FillTextWithAutofill(base::WeakPtr<autofill::AutofillManager> manager,
                          const autofill::FormData& form,
                          const autofill::FormFieldData& field,
                          const std::u16string& text) {
  std::u16string trimmed_text;
  base::TrimString(text, u" \t\n\r\f\v", &trimmed_text);
  if (!manager) {
    return;
  }
  static_cast<autofill::BrowserAutofillManager*>(manager.get())
      ->FillOrPreviewField(autofill::mojom::ActionPersistence::kFill,
                           autofill::mojom::FieldActionType::kReplaceSelection,
                           form, field, trimmed_text,
                           SuggestionType::kComposeResumeNudge,
                           /*field_type_used=*/std::nullopt);
}

}  // namespace

ComposeManagerImpl::ComposeManagerImpl(ComposeClient* client)
    : client_(*client) {}

ComposeManagerImpl::~ComposeManagerImpl() = default;

void ComposeManagerImpl::OpenCompose(AutofillDriver& driver,
                                     FormGlobalId form_id,
                                     FieldGlobalId field_id,
                                     UiEntryPoint entry_point) {
  if (entry_point == UiEntryPoint::kContextMenu) {
    client_->GetPageUkmTracker()->MenuItemClicked();
    LogComposeContextMenuCtr(ComposeContextMenuCtrEvent::kMenuItemClicked);
  }
  driver.ExtractForm(
      form_id,
      base::BindOnce(&ComposeManagerImpl::OpenComposeWithUpdatedSelection,
                     weak_ptr_factory_.GetWeakPtr(), field_id, entry_point));
}

void ComposeManagerImpl::OpenComposeWithUpdatedSelection(
    FieldGlobalId field_id,
    ComposeManagerImpl::UiEntryPoint ui_entry_point,
    AutofillDriver* driver,
    const std::optional<autofill::FormData>& form_data) {
  if (!form_data) {
    LogOpenComposeDialogResult(
        OpenComposeDialogResult::kAutofillFormDataNotFound);
    client_->GetPageUkmTracker()->ShowDialogAbortedDueToMissingFormData();
    return;
  }

  const autofill::FormFieldData* form_field_data =
      form_data->FindFieldByGlobalId(field_id);
  if (!form_field_data) {
    LogOpenComposeDialogResult(
        OpenComposeDialogResult::kAutofillFormFieldDataNotFound);
    client_->GetPageUkmTracker()->ShowDialogAbortedDueToMissingFormFieldData();
    return;
  }

  // Select all text if the current selection is one or zero words.
  if (IsWordCountWithinBounds(
          base::UTF16ToUTF8(form_field_data->selected_text()), 0, 1)) {
    driver->ApplyFieldAction(autofill::mojom::FieldActionType::kSelectAll,
                             autofill::mojom::ActionPersistence::kFill,
                             field_id, u"");

    // Calling `driver->ExtractForm()` here does not always pick up the newly
    // selected text when the form is in an IFRAME. Instead, just edit form data
    // manually to reflect the newly selected text.
    std::optional<autofill::FormData> updated_form_data = form_data;
    std::vector<autofill::FormFieldData> fields =
        updated_form_data->ExtractFields();
    for (auto& field : fields) {
      if (field.global_id() == field_id) {
        field.set_selected_text(field.value());
      }
    }
    updated_form_data->set_fields(std::move(fields));

    OpenComposeWithFormData(field_id, ui_entry_point, driver,
                            updated_form_data);
    LogComposeSelectAllStatus(ComposeSelectAllStatus::kSelectedAll);
    return;
  }
  OpenComposeWithFormData(field_id, ui_entry_point, driver, form_data);
  LogComposeSelectAllStatus(ComposeSelectAllStatus::kNoSelectAll);
}

void ComposeManagerImpl::OpenComposeWithFormData(
    FieldGlobalId field_id,
    ComposeManagerImpl::UiEntryPoint ui_entry_point,
    AutofillDriver* driver,
    const std::optional<autofill::FormData>& form_data) {
  if (!form_data) {
    LogOpenComposeDialogResult(
        OpenComposeDialogResult::kAutofillFormDataNotFoundAfterSelectAll);
    client_->GetPageUkmTracker()->ShowDialogAbortedDueToMissingFormData();
    return;
  }

  const autofill::FormFieldData* form_field_data =
      form_data->FindFieldByGlobalId(field_id);
  if (!form_field_data) {
    LogOpenComposeDialogResult(
        OpenComposeDialogResult::kAutofillFormFieldDataNotFound);
    client_->GetPageUkmTracker()->ShowDialogAbortedDueToMissingFormFieldData();
    return;
  }

  autofill::AutofillManager& manager = driver->GetAutofillManager();
  ComposeCallback compose_callback =
      base::BindOnce(&FillTextWithAutofill, manager.GetWeakPtr(),
                     form_data.value(), *form_field_data);

  OpenComposeWithFormFieldData(ui_entry_point, *form_field_data,
                               manager.client().GetPopupScreenLocation(),
                               std::move(compose_callback));
}

void ComposeManagerImpl::OpenComposeWithFormFieldData(
    UiEntryPoint ui_entry_point,
    const autofill::FormFieldData& trigger_field,
    std::optional<PopupScreenLocation> popup_screen_location,
    ComposeCallback callback) {
  client_->ShowComposeDialog(ui_entry_point, trigger_field,
                             popup_screen_location, std::move(callback));
}

std::optional<Suggestion> ComposeManagerImpl::GetSuggestion(
    const autofill::FormData& form,
    const autofill::FormFieldData& field,
    AutofillSuggestionTriggerSource trigger_source) {
  if (!client_->ShouldTriggerPopup(form, field, trigger_source)) {
    return std::nullopt;
  }
  std::u16string suggestion_text;
  std::u16string label_text;
  Suggestion suggestion;
  // State is saved as a `ComposeSession` in the `ComposeClient`. A user can
  // resume where they left off in a field if the `ComposeClient` has a
  // `ComposeSession` for that field.
  const bool has_session = client_->HasSession(field.global_id());
  if (has_session) {
    // The nudge text indicates that the user can resume where they left off in
    // the Compose dialog.
    suggestion.main_text = Suggestion::Text(
        l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_SAVED_TEXT),
        Suggestion::Text::IsPrimary(true));
    label_text = l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_SAVED_LABEL);
    suggestion.type =
        trigger_source ==
                AutofillSuggestionTriggerSource::kComposeDialogLostFocus
            ? SuggestionType::kComposeSavedStateNotification
            : SuggestionType::kComposeResumeNudge;
    suggestion.feature_for_new_badge = &features::kEnableComposeSavedStateNudge;
  } else {
    // Text for a new Compose session.
    suggestion.main_text = Suggestion::Text(
        l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_MAIN_TEXT),
        Suggestion::Text::IsPrimary(true));
    label_text = l10n_util::GetStringUTF16(IDS_COMPOSE_SUGGESTION_LABEL);
    suggestion.type = SuggestionType::kComposeProactiveNudge;
    suggestion.feature_for_new_badge = &features::kEnableComposeProactiveNudge;
  }
  suggestion.icon = Suggestion::Icon::kPenSpark;
  // Add footer label if not using compact ui.
  if (!GetComposeConfig().proactive_nudge_compact_ui) {
    suggestion.labels = {{Suggestion::Text(std::move(label_text))}};
  }

  if (!has_session &&
      base::FeatureList::IsEnabled(features::kEnableComposeProactiveNudge)) {
    // Add compose child suggestions
    Suggestion never_show_on_site = Suggestion(
        l10n_util::GetStringUTF16(
            IDS_COMPOSE_DONT_SHOW_ON_THIS_SITE_CHILD_SUGGESTION_TEXT),
        SuggestionType::kComposeNeverShowOnThisSiteAgain);
    Suggestion disable =
        Suggestion(l10n_util::GetStringUTF16(
                       IDS_COMPOSE_DISABLE_HELP_ME_WRITE_CHILD_SUGGESTION_TEXT),
                   SuggestionType::kComposeDisable);
    Suggestion go_to_settings =
        Suggestion(l10n_util::GetStringUTF16(
                       IDS_COMPOSE_GO_TO_SETTINGS_CHILD_SUGGESTION_TEXT),
                   SuggestionType::kComposeGoToSettings);
    suggestion.children = {std::move(never_show_on_site), std::move(disable),
                           std::move(go_to_settings)};
  }

  return suggestion;
}

void ComposeManagerImpl::NeverShowComposeForOrigin(const url::Origin& origin) {
  client_->AddSiteToNeverPromptList(origin);
}

void ComposeManagerImpl::DisableCompose() {
  client_->DisableProactiveNudge();
}

void ComposeManagerImpl::GoToSettings() {
  client_->OpenProactiveNudgeSettings();
  LogComposeProactiveNudgeCtr(ComposeNudgeCtrEvent::kOpenSettings);
}

bool ComposeManagerImpl::ShouldAnchorNudgeOnCaret() {
  return GetComposeConfig().is_nudge_shown_at_cursor;
}

}  // namespace compose