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
|
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
/* 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/. */
"use strict";
var USERSCRIPT_PREFNAME = "extensions.webextensions.userScripts.enabled";
var USERSCRIPT_DISABLED_ERRORMSG = `userScripts APIs are currently experimental and must be enabled with the ${USERSCRIPT_PREFNAME} preference.`;
XPCOMUtils.defineLazyPreferenceGetter(
this,
"userScriptsEnabled",
USERSCRIPT_PREFNAME,
false
);
// eslint-disable-next-line mozilla/reject-importGlobalProperties
Cu.importGlobalProperties(["crypto", "TextEncoder"]);
var { DefaultMap, ExtensionError, getUniqueId } = ExtensionUtils;
/**
* Represents a registered userScript in the child extension process.
*
* @param {ExtensionPageContextChild} context
* The extension context which has registered the user script.
* @param {string} scriptId
* An unique id that represents the registered user script
* (generated and used internally to identify it across the different processes).
*/
class UserScriptChild {
constructor({ context, scriptId, onScriptUnregister }) {
this.context = context;
this.scriptId = scriptId;
this.onScriptUnregister = onScriptUnregister;
this.unregistered = false;
}
async unregister() {
if (this.unregistered) {
throw new ExtensionError("User script already unregistered");
}
this.unregistered = true;
await this.context.childManager.callParentAsyncFunction(
"userScripts.unregister",
[this.scriptId]
);
this.context = null;
this.onScriptUnregister();
}
api() {
const { context } = this;
// Returns the RegisteredUserScript API object.
return {
unregister: () => {
return context.wrapPromise(this.unregister());
},
};
}
}
this.userScripts = class extends ExtensionAPI {
getAPI(context) {
// Cache of the script code already converted into blob urls:
// Map<textHash, blobURLs>
const blobURLsByHash = new Map();
// Keep track of the userScript that are sharing the same blob urls,
// so that we can revoke any blob url that is not used by a registered
// userScripts:
// Map<blobURL, Set<scriptId>>
const userScriptsByBlobURL = new DefaultMap(() => new Set());
function revokeBlobURLs(scriptId, options) {
let revokedUrls = new Set();
for (let url of options.js) {
if (userScriptsByBlobURL.has(url)) {
let scriptIds = userScriptsByBlobURL.get(url);
scriptIds.delete(scriptId);
if (scriptIds.size === 0) {
revokedUrls.add(url);
userScriptsByBlobURL.delete(url);
context.cloneScope.URL.revokeObjectURL(url);
}
}
}
// Remove all the removed urls from the map of known computed hashes.
for (let [hash, url] of blobURLsByHash) {
if (revokedUrls.has(url)) {
blobURLsByHash.delete(hash);
}
}
}
// Convert a script code string into a blob URL (and use a cached one
// if the script hash is already associated to a blob URL).
const getBlobURL = async (text, scriptId) => {
// Compute the hash of the js code string and reuse the blob url if we already have
// for the same hash.
const buffer = await crypto.subtle.digest(
"SHA-1",
new TextEncoder().encode(text)
);
const hash = String.fromCharCode(...new Uint16Array(buffer));
let blobURL = blobURLsByHash.get(hash);
if (blobURL) {
userScriptsByBlobURL.get(blobURL).add(scriptId);
return blobURL;
}
const blob = new context.cloneScope.Blob([text], {
type: "text/javascript",
});
blobURL = context.cloneScope.URL.createObjectURL(blob);
// Start to track this blob URL.
userScriptsByBlobURL.get(blobURL).add(scriptId);
blobURLsByHash.set(hash, blobURL);
return blobURL;
};
function convertToAPIObject(scriptId, options) {
const registeredScript = new UserScriptChild({
context,
scriptId,
onScriptUnregister: () => revokeBlobURLs(scriptId, options),
});
const scriptAPI = Cu.cloneInto(
registeredScript.api(),
context.cloneScope,
{ cloneFunctions: true }
);
return scriptAPI;
}
// Revoke all the created blob urls once the context is destroyed.
context.callOnClose({
close() {
if (!context.cloneScope) {
return;
}
for (let blobURL of blobURLsByHash.values()) {
context.cloneScope.URL.revokeObjectURL(blobURL);
}
},
});
return {
userScripts: {
register(options) {
if (!userScriptsEnabled) {
throw new ExtensionError(USERSCRIPT_DISABLED_ERRORMSG);
}
let scriptId = getUniqueId();
return context.cloneScope.Promise.resolve().then(async () => {
options.scriptId = scriptId;
options.js = await Promise.all(
options.js.map(js => {
return js.file || getBlobURL(js.code, scriptId);
})
);
await context.childManager.callParentAsyncFunction(
"userScripts.register",
[options]
);
return convertToAPIObject(scriptId, options);
});
},
},
};
}
};
|
