forked from mozilla-mobile/android-components
-
Notifications
You must be signed in to change notification settings - Fork 1
/
GeckoWebExtension.kt
427 lines (365 loc) · 15.4 KB
/
GeckoWebExtension.kt
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/* 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/. */
package mozilla.components.browser.engine.gecko.webextension
import android.graphics.Bitmap
import androidx.annotation.VisibleForTesting
import mozilla.components.browser.engine.gecko.GeckoEngineSession
import mozilla.components.browser.engine.gecko.await
import mozilla.components.concept.engine.EngineSession
import mozilla.components.concept.engine.Settings
import mozilla.components.concept.engine.webextension.Action
import mozilla.components.concept.engine.webextension.ActionHandler
import mozilla.components.concept.engine.webextension.DisabledFlags
import mozilla.components.concept.engine.webextension.MessageHandler
import mozilla.components.concept.engine.webextension.Metadata
import mozilla.components.concept.engine.webextension.Port
import mozilla.components.concept.engine.webextension.TabHandler
import mozilla.components.concept.engine.webextension.WebExtension
import mozilla.components.support.base.log.logger.Logger
import org.json.JSONObject
import org.mozilla.geckoview.AllowOrDeny
import org.mozilla.geckoview.GeckoResult
import org.mozilla.geckoview.GeckoRuntime
import org.mozilla.geckoview.GeckoSession
import org.mozilla.geckoview.WebExtension as GeckoNativeWebExtension
import org.mozilla.geckoview.WebExtension.Action as GeckoNativeWebExtensionAction
/**
* Gecko-based implementation of [WebExtension], wrapping the native web
* extension object provided by GeckoView.
*/
class GeckoWebExtension(
val nativeExtension: GeckoNativeWebExtension,
val runtime: GeckoRuntime
) : WebExtension(nativeExtension.id, nativeExtension.location, true) {
private val connectedPorts: MutableMap<PortId, GeckoPort> = mutableMapOf()
private val logger = Logger("GeckoWebExtension")
/**
* Uniquely identifies a port using its name and the session it
* was opened for. Ports connected from background scripts will
* have a null session.
*/
data class PortId(val name: String, val session: EngineSession? = null)
/**
* See [WebExtension.registerBackgroundMessageHandler].
*/
override fun registerBackgroundMessageHandler(name: String, messageHandler: MessageHandler) {
val portDelegate = object : GeckoNativeWebExtension.PortDelegate {
override fun onPortMessage(message: Any, port: GeckoNativeWebExtension.Port) {
messageHandler.onPortMessage(message, GeckoPort(port))
}
override fun onDisconnect(port: GeckoNativeWebExtension.Port) {
val connectedPort = connectedPorts[PortId(name)]
if (connectedPort != null && connectedPort.nativePort == port) {
connectedPorts.remove(PortId(name))
messageHandler.onPortDisconnected(GeckoPort(port))
}
}
}
val messageDelegate = object : GeckoNativeWebExtension.MessageDelegate {
override fun onConnect(port: GeckoNativeWebExtension.Port) {
port.setDelegate(portDelegate)
val geckoPort = GeckoPort(port)
connectedPorts[PortId(name)] = geckoPort
messageHandler.onPortConnected(geckoPort)
}
override fun onMessage(
// We don't use the same delegate instance for multiple apps so we don't need to verify the name.
name: String,
message: Any,
sender: GeckoNativeWebExtension.MessageSender
): GeckoResult<Any>? {
val response = messageHandler.onMessage(message, null)
return response?.let { GeckoResult.fromValue(it) }
}
}
nativeExtension.setMessageDelegate(messageDelegate, name)
}
/**
* See [WebExtension.registerContentMessageHandler].
*/
override fun registerContentMessageHandler(session: EngineSession, name: String, messageHandler: MessageHandler) {
val portDelegate = object : GeckoNativeWebExtension.PortDelegate {
override fun onPortMessage(message: Any, port: GeckoNativeWebExtension.Port) {
messageHandler.onPortMessage(message, GeckoPort(port, session))
}
override fun onDisconnect(port: GeckoNativeWebExtension.Port) {
val connectedPort = connectedPorts[PortId(name, session)]
if (connectedPort != null && connectedPort.nativePort == port) {
connectedPorts.remove(PortId(name, session))
messageHandler.onPortDisconnected(connectedPort)
}
}
}
val messageDelegate = object : GeckoNativeWebExtension.MessageDelegate {
override fun onConnect(port: GeckoNativeWebExtension.Port) {
port.setDelegate(portDelegate)
val geckoPort = GeckoPort(port, session)
connectedPorts[PortId(name, session)] = geckoPort
messageHandler.onPortConnected(geckoPort)
}
override fun onMessage(
// We don't use the same delegate instance for multiple apps so we don't need to verify the name.
name: String,
message: Any,
sender: GeckoNativeWebExtension.MessageSender
): GeckoResult<Any>? {
val response = messageHandler.onMessage(message, session)
return response?.let { GeckoResult.fromValue(it) }
}
}
val geckoSession = (session as GeckoEngineSession).geckoSession
geckoSession.webExtensionController.setMessageDelegate(nativeExtension, messageDelegate, name)
}
/**
* See [WebExtension.hasContentMessageHandler].
*/
override fun hasContentMessageHandler(session: EngineSession, name: String): Boolean {
val geckoSession = (session as GeckoEngineSession).geckoSession
return geckoSession.webExtensionController.getMessageDelegate(nativeExtension, name) != null
}
/**
* See [WebExtension.getConnectedPort].
*/
override fun getConnectedPort(name: String, session: EngineSession?): Port? {
return connectedPorts[PortId(name, session)]
}
/**
* See [WebExtension.disconnectPort].
*/
override fun disconnectPort(name: String, session: EngineSession?) {
val portId = PortId(name, session)
val port = connectedPorts[portId]
port?.let {
it.disconnect()
connectedPorts.remove(portId)
}
}
/**
* See [WebExtension.registerActionHandler].
*/
override fun registerActionHandler(actionHandler: ActionHandler) {
if (!supportActions) {
logger.error("Attempt to register default action handler but browser and page " +
"action support is turned off for this extension: $id")
return
}
val actionDelegate = object : GeckoNativeWebExtension.ActionDelegate {
override fun onBrowserAction(
ext: GeckoNativeWebExtension,
// Session will always be null here for the global default delegate
session: GeckoSession?,
action: GeckoNativeWebExtensionAction
) {
actionHandler.onBrowserAction(this@GeckoWebExtension, null, action.convert())
}
override fun onPageAction(
ext: GeckoNativeWebExtension,
// Session will always be null here for the global default delegate
session: GeckoSession?,
action: GeckoNativeWebExtensionAction
) {
actionHandler.onPageAction(this@GeckoWebExtension, null, action.convert())
}
override fun onTogglePopup(
ext: GeckoNativeWebExtension,
action: GeckoNativeWebExtensionAction
): GeckoResult<GeckoSession>? {
val session = actionHandler.onToggleActionPopup(this@GeckoWebExtension, action.convert())
return session?.let { GeckoResult.fromValue((session as GeckoEngineSession).geckoSession) }
}
}
nativeExtension.setActionDelegate(actionDelegate)
}
/**
* See [WebExtension.registerActionHandler].
*/
override fun registerActionHandler(session: EngineSession, actionHandler: ActionHandler) {
if (!supportActions) {
logger.error("Attempt to register action handler on session but browser and page " +
"action support is turned off for this extension: $id")
return
}
val actionDelegate = object : GeckoNativeWebExtension.ActionDelegate {
override fun onBrowserAction(
ext: GeckoNativeWebExtension,
geckoSession: GeckoSession?,
action: GeckoNativeWebExtensionAction
) {
actionHandler.onBrowserAction(this@GeckoWebExtension, session, action.convert())
}
override fun onPageAction(
ext: GeckoNativeWebExtension,
geckoSession: GeckoSession?,
action: GeckoNativeWebExtensionAction
) {
actionHandler.onPageAction(this@GeckoWebExtension, session, action.convert())
}
}
val geckoSession = (session as GeckoEngineSession).geckoSession
geckoSession.webExtensionController.setActionDelegate(nativeExtension, actionDelegate)
}
/**
* See [WebExtension.hasActionHandler].
*/
override fun hasActionHandler(session: EngineSession): Boolean {
val geckoSession = (session as GeckoEngineSession).geckoSession
return geckoSession.webExtensionController.getActionDelegate(nativeExtension) != null
}
/**
* See [WebExtension.registerTabHandler].
*/
override fun registerTabHandler(tabHandler: TabHandler, defaultSettings: Settings?) {
val tabDelegate = object : GeckoNativeWebExtension.TabDelegate {
override fun onNewTab(
ext: GeckoNativeWebExtension,
tabDetails: GeckoNativeWebExtension.CreateTabDetails
): GeckoResult<GeckoSession>? {
val geckoEngineSession = GeckoEngineSession(
runtime,
defaultSettings = defaultSettings,
openGeckoSession = false
)
tabHandler.onNewTab(
this@GeckoWebExtension,
geckoEngineSession,
tabDetails.active == true,
tabDetails.url ?: ""
)
return GeckoResult.fromValue(geckoEngineSession.geckoSession)
}
override fun onOpenOptionsPage(ext: GeckoNativeWebExtension) {
ext.metaData.optionsPageUrl?.let { optionsPageUrl ->
tabHandler.onNewTab(
this@GeckoWebExtension,
GeckoEngineSession(runtime,
defaultSettings = defaultSettings),
false,
optionsPageUrl
)
}
}
}
nativeExtension.tabDelegate = tabDelegate
}
/**
* See [WebExtension.registerTabHandler].
*/
override fun registerTabHandler(session: EngineSession, tabHandler: TabHandler) {
val tabDelegate = object : GeckoNativeWebExtension.SessionTabDelegate {
override fun onUpdateTab(
ext: GeckoNativeWebExtension,
geckoSession: GeckoSession,
tabDetails: GeckoNativeWebExtension.UpdateTabDetails
): GeckoResult<AllowOrDeny> {
return if (tabHandler.onUpdateTab(
this@GeckoWebExtension,
session,
tabDetails.active == true,
tabDetails.url)
) {
GeckoResult.allow()
} else {
GeckoResult.deny()
}
}
override fun onCloseTab(
ext: GeckoNativeWebExtension?,
geckoSession: GeckoSession
): GeckoResult<AllowOrDeny> {
return if (ext != null) {
if (tabHandler.onCloseTab(this@GeckoWebExtension, session)) {
GeckoResult.allow()
} else {
GeckoResult.deny()
}
} else {
GeckoResult.deny()
}
}
}
val geckoSession = (session as GeckoEngineSession).geckoSession
geckoSession.webExtensionController.setTabDelegate(nativeExtension, tabDelegate)
}
/**
* See [WebExtension.hasTabHandler].
*/
override fun hasTabHandler(session: EngineSession): Boolean {
val geckoSession = (session as GeckoEngineSession).geckoSession
return geckoSession.webExtensionController.getTabDelegate(nativeExtension) != null
}
/**
* See [WebExtension.getMetadata].
*/
override fun getMetadata(): Metadata? {
return nativeExtension.metaData.let {
Metadata(
name = it.name,
description = it.description,
developerName = it.creatorName,
developerUrl = it.creatorUrl,
homePageUrl = it.homepageUrl,
version = it.version,
permissions = it.permissions.toList(),
// Origins is marked as @NonNull but may be null: https://bugzilla.mozilla.org/show_bug.cgi?id=1629957
hostPermissions = it.origins.orEmpty().toList(),
disabledFlags = DisabledFlags.select(it.disabledFlags),
optionsPageUrl = it.optionsPageUrl,
openOptionsPageInTab = it.openOptionsPageInTab,
baseUrl = it.baseUrl,
temporary = it.temporary
)
}
}
override fun isBuiltIn(): Boolean {
return nativeExtension.isBuiltIn
}
override fun isEnabled(): Boolean {
return nativeExtension.metaData.enabled
}
override fun isAllowedInPrivateBrowsing(): Boolean {
return isBuiltIn() || nativeExtension.metaData.allowedInPrivateBrowsing
}
override suspend fun loadIcon(size: Int): Bitmap? {
return getIcon(size).await()
}
@VisibleForTesting
internal fun getIcon(size: Int): GeckoResult<Bitmap> {
return nativeExtension.metaData.icon.getBitmap(size)
}
}
/**
* Gecko-based implementation of [Port], wrapping the native port provided by GeckoView.
*/
class GeckoPort(
internal val nativePort: GeckoNativeWebExtension.Port,
engineSession: EngineSession? = null
) : Port(engineSession) {
override fun postMessage(message: JSONObject) {
nativePort.postMessage(message)
}
override fun name(): String {
return nativePort.name
}
override fun senderUrl(): String {
return nativePort.sender.url
}
override fun disconnect() {
nativePort.disconnect()
}
}
private fun GeckoNativeWebExtensionAction.convert(): Action {
val loadIcon: (suspend (Int) -> Bitmap?)? = icon?.let {
{ size -> icon?.getBitmap(size)?.await() }
}
val onClick = { click() }
return Action(
title,
enabled,
loadIcon,
badgeText,
badgeTextColor,
badgeBackgroundColor,
onClick
)
}