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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
// Copyright 2021 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.
#ifndef COMPONENTS_AUTOFILL_CONTENT_BROWSER_CONTENT_AUTOFILL_ROUTER_H_
#define COMPONENTS_AUTOFILL_CONTENT_BROWSER_CONTENT_AUTOFILL_ROUTER_H_
#include <string>
#include <utility>
#include "base/containers/flat_map.h"
#include "base/memory/raw_ptr.h"
#include "components/autofill/content/browser/form_forest.h"
#include "components/autofill/core/browser/autofill_driver.h"
#include "components/autofill/core/browser/field_types.h"
#include "components/autofill/core/common/form_data.h"
#include "components/autofill/core/common/form_data_predictions.h"
#include "components/autofill/core/common/form_field_data.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/render_widget_host.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "ui/gfx/geometry/rect_f.h"
namespace autofill {
class AutofillableData;
class ContentAutofillDriver;
// ContentAutofillRouter routes events between ContentAutofillDriver objects in
// order to handle frame-transcending forms.
//
// A *frame-transcending* form is a form whose logical fields live in different
// frames. For example, credit card forms often have the credit card number
// field in an iframe hosted by a payment service provider.
//
// A frame-transcending form therefore consists of multiple *renderer forms*.
// ContentAutofillRouter *flattens* these forms into a single *browser form*,
// and maps all events concerning the renderer forms to that browser form, and
// vice versa.
//
// That way, the collection of renderer forms appears as one ordinary form to
// the browser.
//
// For example, consider the following pseudo HTML code:
// <html>
// <form id="Form-1">
// <input id="Field-1">
// <iframe id="Frame-1">
// <input id="Field-2">
// </iframe>
// <iframe id="Frame-2">
// <iframe id="Frame-3">
// <form id="Form-2">
// <input id="Field-3">
// </form>
// <form id="Form-3">
// <input id="Field-4">
// </form>
// </iframe>
// </iframe>
// <input id="Field-5">
// </form>
//
// Forms can be actual <form> elements or synthetic forms: <input>, <select>,
// and <iframe> elements that are not in the scope of any <form> belong to the
// enclosing frame's synthetic form.
//
// The five renderer forms are therefore, in pseudo C++ code:
// FormData{
// .host_frame = "Frame-0", // The main frame.
// .name = "Form-1",
// .fields = { "Field-1", "Field-5" },
// .child_frames = { "Frame-1", "Frame-2" }
// }
// FormData{
// .host_frame = "Frame-1",
// .name = "synthetic",
// .fields = { "Field-2" },
// .child_frames = { }
// }
// FormData{
// .host_frame = "Frame-2",
// .name = "synthetic",
// .fields = { },
// .child_frames = { "Frame-3" }
// }
// FormData{
// .host_frame = "Frame-3",
// .name = "Form-2",
// .fields = { "Field-3" },
// .child_frames = { }
// }
// FormData{
// .host_frame = "Frame-3",
// .name = "Form-3",
// .fields = { "Field-4" },
// .child_frames = { }
// }
//
// The browser form of these renderer forms is obtained by flattening the fields
// into the root form:
// FormData{
// .name = "Form-1",
// .fields = { "Field-1", "Field-2", "Field-3", "Field-4", "Field-5" }
// }
//
// Let AutofillAgent-N, ContentAutofillRouter-N, and AutofillManager-N
// correspond to the Frame-N. ContentAutofillRouter would route an event
// concerning any of the forms in Frame-3 from ContentAutofillDriver-3 to
// ContentAutofillDriver-0:
//
// +---Tab---+ +---Tab----+ +----Tab----+
// | Agent-0 | +---> | Driver-0 | ---------> | Manager-0 |
// | | | | | | |
// | Agent-1 | | | Driver-1 | | Manager-1 |
// | | | | | | |
// | Agent-2 | | | Driver-2 | | Manager-2 |
// | | | | | | |
// | Agent-3 | -----|---> | Driver-3 | -----+ | Manager-3 |
// +---------+ | +----------+ | +-----------+
// | |
// | +--Tab---+ |
// +----- | Router | <-----+
// +--------+
//
// If the event name is `f`, the control flow is as follows:
// Driver-3's ContentAutofillDriver::f(args...) calls
// Router's ContentAutofillRouter::f(this, args...) calls
// Driver-0's ContentAutofillDriver::fImpl(args...).
//
// Every function in ContentAutofillRouter takes a |source_driver| parameter,
// which points to the ContentAutofillDriver that triggered the event. In events
// triggered by the renderer, the source driver is the driver the associated
// renderer form originates from.
//
// See ContentAutofillDriver for details on the naming pattern and an example.
//
// See FormForest for details on (un)flattening.
class ContentAutofillRouter {
public:
ContentAutofillRouter();
ContentAutofillRouter(const ContentAutofillRouter&) = delete;
ContentAutofillRouter& operator=(const ContentAutofillRouter&) = delete;
~ContentAutofillRouter();
// Deletes all forms and fields related to |driver| (and this driver only).
// Must be called whenever |driver| is destroyed.
// As a simple performance optimization, if |driver| is a main frame, the
// whole router is reset to the initial state.
void UnregisterDriver(ContentAutofillDriver* driver);
// Returns the ContentAutofillDriver* for which AskForValuesToFill() was
// called last.
// TODO(crbug.com/1224846) QueryFormFieldAutofill() was renamed to
// AskForValuesToFill(), so we should rename last_queried_source() and
// last_queried_source_ as well.
ContentAutofillDriver* last_queried_source() const {
return last_queried_source_;
}
// Registers the key-press handler with the driver that last called
// AskForValuesToFill(), that is, |last_queried_source_|.
void SetKeyPressHandler(
ContentAutofillDriver* source_driver,
const content::RenderWidgetHost::KeyPressEventCallback& handler);
void UnsetKeyPressHandler(ContentAutofillDriver* source_driver);
// Routing of events called by the renderer:
void SetFormToBeProbablySubmitted(ContentAutofillDriver* source_driver,
const absl::optional<FormData>& form);
void FormsSeen(ContentAutofillDriver* source_driver,
const std::vector<FormData>& updated_forms,
const std::vector<FormGlobalId>& removed_forms);
void FormSubmitted(ContentAutofillDriver* source_driver,
const FormData& form,
bool known_success,
mojom::SubmissionSource submission_source);
void TextFieldDidChange(ContentAutofillDriver* source_driver,
const FormData& form,
const FormFieldData& field,
const gfx::RectF& bounding_box,
base::TimeTicks timestamp);
void TextFieldDidScroll(ContentAutofillDriver* source_driver,
const FormData& form,
const FormFieldData& field,
const gfx::RectF& bounding_box);
void SelectControlDidChange(ContentAutofillDriver* source_driver,
const FormData& form,
const FormFieldData& field,
const gfx::RectF& bounding_box);
void AskForValuesToFill(ContentAutofillDriver* source_driver,
int32_t id,
const FormData& form,
const FormFieldData& field,
const gfx::RectF& bounding_box,
bool autoselect_first_suggestion);
void HidePopup(ContentAutofillDriver* source_driver);
void FocusNoLongerOnForm(ContentAutofillDriver* source_driver,
bool had_interacted_form);
void FocusOnFormField(ContentAutofillDriver* source_driver,
const FormData& form,
const FormFieldData& field,
const gfx::RectF& bounding_box);
void DidFillAutofillFormData(ContentAutofillDriver* source_driver,
const FormData& form,
base::TimeTicks timestamp);
void DidPreviewAutofillFormData(ContentAutofillDriver* source_driver);
void DidEndTextFieldEditing(ContentAutofillDriver* source_driver);
void SelectFieldOptionsDidChange(ContentAutofillDriver* source_driver,
const FormData& form);
// Event called by Autofill Assistant as if it was called by the renderer.
void FillFormForAssistant(ContentAutofillDriver* source_driver,
const AutofillableData& fill_data,
const FormData& form,
const FormFieldData& field);
// Routing of events called by the browser:
std::vector<FieldGlobalId> FillOrPreviewForm(
ContentAutofillDriver* source_driver,
int query_id,
mojom::RendererFormDataAction action,
const FormData& data,
const url::Origin& triggered_origin,
const base::flat_map<FieldGlobalId, ServerFieldType>& field_type_map);
void SendAutofillTypePredictionsToRenderer(
ContentAutofillDriver* source_driver,
const std::vector<FormDataPredictions>& type_predictions);
void SendFieldsEligibleForManualFillingToRenderer(
ContentAutofillDriver* source_driver,
const std::vector<FieldGlobalId>& fields);
void RendererShouldAcceptDataListSuggestion(
ContentAutofillDriver* source_driver,
const FieldGlobalId& field,
const std::u16string& value);
void RendererShouldClearFilledSection(ContentAutofillDriver* source_driver);
void RendererShouldClearPreviewedForm(ContentAutofillDriver* source_driver);
void RendererShouldFillFieldWithValue(ContentAutofillDriver* source_driver,
const FieldGlobalId& field,
const std::u16string& value);
void RendererShouldPreviewFieldWithValue(ContentAutofillDriver* source_driver,
const FieldGlobalId& field,
const std::u16string& value);
void RendererShouldSetSuggestionAvailability(
ContentAutofillDriver* source_driver,
const FieldGlobalId& field,
const mojom::AutofillState state);
private:
friend class ContentAutofillRouterTestApi;
// Returns the driver of |frame| stored in |form_forest_|.
ContentAutofillDriver* DriverOfFrame(LocalFrameToken frame);
// Calls ContentAutofillDriver::TriggerReparse() for all drivers in
// |form_forest_| except for |exception|.
void TriggerReparseExcept(ContentAutofillDriver* exception);
// Update the last queried and source and do cleanup work.
void SetLastQueriedSource(ContentAutofillDriver* source);
void SetLastQueriedTarget(ContentAutofillDriver* target);
// The URL of a main frame managed by the ContentAutofillRouter.
// TODO(crbug.com/1240247): Remove.
std::string MainUrlForDebugging() const;
// The frame managed by the ContentAutofillRouter that was last passed to
// an event.
// TODO(crbug.com/1240247): Remove.
content::GlobalRenderFrameHostId some_rfh_for_debugging_;
// The forest of forms. See its documentation for the usage protocol.
internal::FormForest form_forest_;
// The driver that triggered the last AskForValuesToFill() call.
// Update with SetLastQueriedSource().
raw_ptr<ContentAutofillDriver> last_queried_source_ = nullptr;
// The driver to which the last AskForValuesToFill() call was routed.
// Update with SetLastQueriedTarget().
raw_ptr<ContentAutofillDriver> last_queried_target_ = nullptr;
// When the focus moves to a different frame, the order of the events
// FocusNoLongerOnForm() and FocusOnFormField() may be reversed due to race
// conditions. We use these members to correct the order of the events.
LocalFrameToken focused_frame_;
bool focus_no_longer_on_form_has_fired_ = true;
};
} // namespace autofill
#endif // COMPONENTS_AUTOFILL_CONTENT_BROWSER_CONTENT_AUTOFILL_ROUTER_H_
|
