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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
FirefoxRelay: "resource://gre/modules/FirefoxRelay.sys.mjs",
FirefoxRelayTelemetry: "resource://gre/modules/FirefoxRelayTelemetry.mjs",
FormHistory: "resource://gre/modules/FormHistory.sys.mjs",
LoginHelper: "resource://gre/modules/LoginHelper.sys.mjs",
});
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"PREFERENCE_PREFIX_WEIGHT",
"browser.formfill.prefixWeight"
);
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"PREFERENCE_BOUNDARY_WEIGHT",
"browser.formfill.boundaryWeight"
);
export class FormHistoryParent extends JSWindowActorParent {
receiveMessage({ name, data }) {
switch (name) {
case "FormHistory:FormSubmitEntries":
this.#onFormSubmitEntries(data);
break;
case "FormHistory:AutoCompleteSearchAsync":
return this.#onAutoCompleteSearch(data);
case "FormHistory:RemoveEntry":
this.#onRemoveEntry(data);
break;
case "PasswordManager:offerRelayIntegration": {
lazy.FirefoxRelayTelemetry.recordRelayOfferedEvent(
"clicked",
data.telemetry.flowId,
data.telemetry.scenarioName
);
return this.#offerRelayIntegration();
}
case "PasswordManager:generateRelayUsername": {
lazy.FirefoxRelayTelemetry.recordRelayUsernameFilledEvent(
"clicked",
data.telemetry.flowId
);
return this.#generateRelayUsername();
}
}
return undefined;
}
#onFormSubmitEntries(entries) {
const changes = entries.map(entry => ({
op: "bump",
fieldname: entry.name,
value: entry.value,
}));
lazy.FormHistory.update(changes);
}
get formOrigin() {
return lazy.LoginHelper.getLoginOrigin(
this.manager.documentPrincipal?.originNoSuffix
);
}
async #onAutoCompleteSearch({ searchString, params, scenarioName }) {
searchString = searchString.trim().toLowerCase();
let formHistoryPromise;
if (
FormHistoryParent.canSearchIncrementally(
searchString,
this.previousSearchString
)
) {
formHistoryPromise = Promise.resolve(
FormHistoryParent.incrementalSearch(
searchString,
this.previousSearchString,
this.previousSearchResult
)
);
} else {
formHistoryPromise = lazy.FormHistory.getAutoCompleteResults(
searchString,
params
);
}
const relayPromise = lazy.FirefoxRelay.autocompleteItemsAsync({
formOrigin: this.formOrigin,
scenarioName,
hasInput: !!searchString.length,
});
const [formHistoryEntries, externalEntries] = await Promise.all([
formHistoryPromise,
relayPromise,
]);
this.previousSearchString = searchString;
this.previousSearchResult = formHistoryEntries;
return { formHistoryEntries, externalEntries };
}
#onRemoveEntry({ inputName, value, guid }) {
lazy.FormHistory.update({
op: "remove",
fieldname: inputName,
value,
guid,
});
}
getRootBrowser() {
return this.browsingContext.topFrameElement;
}
async #offerRelayIntegration() {
const browser = this.getRootBrowser();
return lazy.FirefoxRelay.offerRelayIntegration(browser, this.formOrigin);
}
async #generateRelayUsername() {
const browser = this.getRootBrowser();
return lazy.FirefoxRelay.generateUsername(browser, this.formOrigin);
}
async searchAutoCompleteEntries(searchString, data) {
const { inputName, scenarioName } = data;
const params = {
fieldname: inputName,
};
return this.#onAutoCompleteSearch({ searchString, params, scenarioName });
}
static canSearchIncrementally(searchString, previousSearchString) {
previousSearchString ||= "";
return (
previousSearchString.length > 1 &&
searchString.includes(previousSearchString)
);
}
static incrementalSearch(
searchString,
previousSearchString,
previousSearchResult
) {
const searchTokens = searchString.split(/\s+/);
// We have a list of results for a shorter search string, so just
// filter them further based on the new search string and add to a new array.
let filteredEntries = [];
for (const entry of previousSearchResult) {
// Remove results that do not contain the token
// XXX bug 394604 -- .toLowerCase can be wrong for some intl chars
if (searchTokens.some(tok => !entry.textLowerCase.includes(tok))) {
continue;
}
FormHistoryParent.calculateScore(entry, searchString, searchTokens);
filteredEntries.push(entry);
}
filteredEntries.sort((a, b) => b.totalScore - a.totalScore);
return filteredEntries;
}
/*
* calculateScore
*
* entry -- an nsIAutoCompleteResult entry
* searchString -- current value of the input (lowercase)
* searchTokens -- array of tokens of the search string
*
* Returns: an int
*/
static calculateScore(entry, searchString, searchTokens) {
let boundaryCalc = 0;
// for each word, calculate word boundary weights
for (const token of searchTokens) {
if (entry.textLowerCase.startsWith(token)) {
boundaryCalc++;
}
if (entry.textLowerCase.includes(" " + token)) {
boundaryCalc++;
}
}
boundaryCalc = boundaryCalc * lazy.PREFERENCE_BOUNDARY_WEIGHT;
// now add more weight if we have a traditional prefix match and
// multiply boundary bonuses by boundary weight
if (entry.textLowerCase.startsWith(searchString)) {
boundaryCalc += lazy.PREFERENCE_PREFIX_WEIGHT;
}
entry.totalScore = Math.round(entry.frecency * Math.max(1, boundaryCalc));
}
previewFields(_result) {
// Not implemented
}
autofillFields(_result) {
// Not implemented
}
}
|
