From 9c003ec233136690c4efcee15341352400ce145d Mon Sep 17 00:00:00 2001 From: praschke Date: Sun, 29 Oct 2023 16:08:53 +0000 Subject: remove webRequest from chrome for real --- dev/data/manifest-variants.json | 10 +++++++++- docs/permissions.md | 15 +++++---------- ext/js/background/request-builder.js | 2 +- ext/permissions.html | 16 ++-------------- 4 files changed, 17 insertions(+), 26 deletions(-) diff --git a/dev/data/manifest-variants.json b/dev/data/manifest-variants.json index c9e7cd03..858dba65 100644 --- a/dev/data/manifest-variants.json +++ b/dev/data/manifest-variants.json @@ -81,7 +81,6 @@ "clipboardWrite", "unlimitedStorage", "declarativeNetRequest", - "webRequest", "scripting", "offscreen" ], @@ -249,6 +248,15 @@ "nativeMessaging" ] }, + { + "action": "add", + "path": [ + "permissions" + ], + "items": [ + "webRequest" + ] + }, { "action": "add", "path": [ diff --git a/docs/permissions.md b/docs/permissions.md index 57f9f0b2..3fdf72d8 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -9,13 +9,8 @@ `unlimitedStorage` is used to help prevent web browsers from unexpectedly deleting dictionary data. -* `webRequest`
- Yomichan uses this permission to collect audio or create Anki notes using - [AnkiConnect](https://ankiweb.net/shared/info/2055492159). - It is also required to surface error information from failed requests. - -* `webRequestBlocking` _(Firefox only)_
- Yomichan uses this permission to ensure certain requests have valid and secure headers. +* `webRequest` and `webRequestBlocking` _(Firefox only)_
+ Yomichan uses these permissions to ensure certain requests have valid and secure headers. This sometimes involves removing or changing the `Origin` request header, as this can be used to fingerprint browser configuration. @@ -24,11 +19,11 @@ This sometimes involves removing or changing the `Origin` request header, as this can be used to fingerprint browser configuration. -* `scripting` _(Manifest V3 only)_
- Yomichan will sometimes need to inject stylesheets into webpages in order to +* `scripting`
+ Yomichan needs to inject content scripts and stylesheets into webpages in order to properly display the search popup. -* `offscreen` __(Chrome only)_
+* `offscreen` _(Chrome only)_
Yomitan uses this permission to create a secondary backend document that has DOM access, given that Manifest v3 service workers do not. Service workers can then reach out to out to this document in order to complete actions that require access to DOM APIs, such as any that require clipboard access. diff --git a/ext/js/background/request-builder.js b/ext/js/background/request-builder.js index 663e242b..bf770964 100644 --- a/ext/js/background/request-builder.js +++ b/ext/js/background/request-builder.js @@ -313,7 +313,7 @@ class RequestBuilder { await this._updateDynamicRules({addRules}); try { - return await this._fetchInternal(url, init, null); + return await fetch(url, init); } finally { await this._tryUpdateDynamicRules({removeRuleIds: [id]}); } diff --git a/ext/permissions.html b/ext/permissions.html index 9ede7d27..4aaef3c1 100644 --- a/ext/permissions.html +++ b/ext/permissions.html @@ -47,24 +47,12 @@ -
-
-
webRequest
-
-

- Yomitan uses this permission to collect audio or create Anki notes using - AnkiConnect. - It is also required to surface error information from failed requests. -

-
-
-
-
webRequestBlocking
+
webRequest and webRequestBlocking

- Yomitan uses this permission to ensure certain requests have valid and secure headers. + Yomitan uses these permissions to ensure certain requests have valid and secure headers. This sometimes involves removing or changing the Origin request header, as this can be used to fingerprint browser configuration.

-- cgit v1.2.3 From 0adf9cef27de2641718116b91a0c7426aac6814e Mon Sep 17 00:00:00 2001 From: praschke Date: Sun, 29 Oct 2023 20:50:45 +0000 Subject: fix: _getDynamicRules() returns a promise dynamic rules were never cleared, as the promise is not iterable as expected. --- ext/js/background/request-builder.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ext/js/background/request-builder.js b/ext/js/background/request-builder.js index bf770964..03088fac 100644 --- a/ext/js/background/request-builder.js +++ b/ext/js/background/request-builder.js @@ -263,7 +263,7 @@ class RequestBuilder { async _clearDynamicRules() { if (!isObject(chrome.declarativeNetRequest)) { return; } - const rules = this._getDynamicRules(); + const rules = await this._getDynamicRules(); if (rules.length === 0) { return; } -- cgit v1.2.3 From ba8eec942c60cc8b676408efd99e3fbbb9670c06 Mon Sep 17 00:00:00 2001 From: praschke Date: Sun, 29 Oct 2023 20:59:05 +0000 Subject: fix: session rules should be used instead of dynamic rules session rules are less persistent than dynamic rules, and the intention of RequestBuilder is to only have rules active for the lifetime of specific requests. --- ext/js/background/request-builder.js | 50 +++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 4 deletions(-) diff --git a/ext/js/background/request-builder.js b/ext/js/background/request-builder.js index 03088fac..32c4a788 100644 --- a/ext/js/background/request-builder.js +++ b/ext/js/background/request-builder.js @@ -42,6 +42,7 @@ class RequestBuilder { async prepare() { try { await this._clearDynamicRules(); + await this._clearSessionRules(); } catch (e) { // NOP } @@ -260,6 +261,21 @@ class RequestBuilder { } } + async _clearSessionRules() { + if (!isObject(chrome.declarativeNetRequest)) { return; } + + const rules = await this._getSessionRules(); + + if (rules.length === 0) { return; } + + const removeRuleIds = []; + for (const {id} of rules) { + removeRuleIds.push(id); + } + + await this._updateSessionRules({removeRuleIds}); + } + async _clearDynamicRules() { if (!isObject(chrome.declarativeNetRequest)) { return; } @@ -311,17 +327,43 @@ class RequestBuilder { } }]; - await this._updateDynamicRules({addRules}); + await this._updateSessionRules({addRules}); try { return await fetch(url, init); } finally { - await this._tryUpdateDynamicRules({removeRuleIds: [id]}); + await this._tryUpdateSessionRules({removeRuleIds: [id]}); } } finally { this._ruleIds.delete(id); } } + _getSessionRules() { + return new Promise((resolve, reject) => { + chrome.declarativeNetRequest.getSessionRules((result) => { + const e = chrome.runtime.lastError; + if (e) { + reject(new Error(e.message)); + } else { + resolve(result); + } + }); + }); + } + + _updateSessionRules(options) { + return new Promise((resolve, reject) => { + chrome.declarativeNetRequest.updateSessionRules(options, () => { + const e = chrome.runtime.lastError; + if (e) { + reject(new Error(e.message)); + } else { + resolve(); + } + }); + }); + } + _getDynamicRules() { return new Promise((resolve, reject) => { chrome.declarativeNetRequest.getDynamicRules((result) => { @@ -348,9 +390,9 @@ class RequestBuilder { }); } - async _tryUpdateDynamicRules(options) { + async _tryUpdateSessionRules(options) { try { - await this._updateDynamicRules(options); + await this._updateSessionRules(options); return true; } catch (e) { return false; -- cgit v1.2.3 From e61a69fb9ed8ad1dc94b4695d9b9052f4a533a52 Mon Sep 17 00:00:00 2001 From: praschke Date: Sun, 29 Oct 2023 21:20:29 +0000 Subject: remove webRequest and webRequestBlocking firefox was previously unable to use declarativeNetRequest, as some browser state (ExtensionDNRStore) wasn't correctly initialized wrt yomitan's use of the DNR API. this bug manifested as an unexpected error on calls to updateDynamicRules(), specifically after the browser has been restarted. switching to the use of session rules instead of dynamic rules fixes this bug. i have tested audio info requests (custom JSON, JPod Alternate, Jisho) that exhibited the bug after browser restart on version 115 and 118, and the audio plays instead of the request failing. webRequest can now be entirely removed. --- dev/data/manifest-variants.json | 25 --- docs/permissions.md | 7 +- ext/js/background/request-builder.js | 306 ++++++++--------------------------- ext/permissions.html | 33 +--- 4 files changed, 74 insertions(+), 297 deletions(-) diff --git a/dev/data/manifest-variants.json b/dev/data/manifest-variants.json index 858dba65..4d4ec301 100644 --- a/dev/data/manifest-variants.json +++ b/dev/data/manifest-variants.json @@ -248,31 +248,6 @@ "nativeMessaging" ] }, - { - "action": "add", - "path": [ - "permissions" - ], - "items": [ - "webRequest" - ] - }, - { - "action": "add", - "path": [ - "permissions" - ], - "items": [ - "webRequestBlocking" - ] - }, - { - "action": "remove", - "path": [ - "permissions" - ], - "item": "declarativeNetRequest" - }, { "action": "remove", "path": [ diff --git a/docs/permissions.md b/docs/permissions.md index 3fdf72d8..8ab3bba5 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -9,12 +9,7 @@ `unlimitedStorage` is used to help prevent web browsers from unexpectedly deleting dictionary data. -* `webRequest` and `webRequestBlocking` _(Firefox only)_
- Yomichan uses these permissions to ensure certain requests have valid and secure headers. - This sometimes involves removing or changing the `Origin` request header, - as this can be used to fingerprint browser configuration. - -* `declarativeNetRequest` _(Chrome only)_
+* `declarativeNetRequest`
Yomichan uses this permission to ensure certain requests have valid and secure headers. This sometimes involves removing or changing the `Origin` request header, as this can be used to fingerprint browser configuration. diff --git a/ext/js/background/request-builder.js b/ext/js/background/request-builder.js index 32c4a788..7ee89539 100644 --- a/ext/js/background/request-builder.js +++ b/ext/js/background/request-builder.js @@ -31,7 +31,6 @@ class RequestBuilder { * Creates a new instance. */ constructor() { - this._onBeforeSendHeadersExtraInfoSpec = ['blocking', 'requestHeaders', 'extraHeaders']; this._textEncoder = new TextEncoder(); this._ruleIds = new Set(); } @@ -55,15 +54,50 @@ class RequestBuilder { * @returns {Promise} The response of the `fetch` call. */ async fetchAnonymous(url, init) { - if (isObject(chrome.declarativeNetRequest)) { - return await this._fetchAnonymousDeclarative(url, init); + const id = this._getNewRuleId(); + const originUrl = this._getOriginURL(url); + url = encodeURI(decodeURI(url)); + + this._ruleIds.add(id); + try { + const addRules = [{ + id, + priority: 1, + condition: { + urlFilter: `|${this._escapeDnrUrl(url)}|`, + resourceTypes: ['xmlhttprequest'] + }, + action: { + type: 'modifyHeaders', + requestHeaders: [ + { + operation: 'remove', + header: 'Cookie' + }, + { + operation: 'set', + header: 'Origin', + value: originUrl + } + ], + responseHeaders: [ + { + operation: 'remove', + header: 'Set-Cookie' + } + ] + } + }]; + + await this._updateSessionRules({addRules}); + try { + return await fetch(url, init); + } finally { + await this._tryUpdateSessionRules({removeRuleIds: [id]}); + } + } finally { + this._ruleIds.delete(id); } - const originURL = this._getOriginURL(url); - const headerModifications = [ - ['cookie', null], - ['origin', {name: 'Origin', value: originURL}] - ]; - return await this._fetchInternal(url, init, headerModifications); } /** @@ -126,144 +160,7 @@ class RequestBuilder { // Private - async _fetchInternal(url, init, headerModifications) { - const filter = { - urls: [this._getMatchURL(url)], - types: ['xmlhttprequest'] - }; - - let requestId = null; - const onBeforeSendHeadersCallback = (details) => { - if (requestId !== null || details.url !== url) { return {}; } - ({requestId} = details); - - if (headerModifications === null) { return {}; } - - const requestHeaders = details.requestHeaders; - this._modifyHeaders(requestHeaders, headerModifications); - return {requestHeaders}; - }; - - let errorDetailsTimer = null; - let {promise: errorDetailsPromise, resolve: errorDetailsResolve} = deferPromise(); - const onErrorOccurredCallback = (details) => { - if (errorDetailsResolve === null || details.requestId !== requestId) { return; } - if (errorDetailsTimer !== null) { - clearTimeout(errorDetailsTimer); - errorDetailsTimer = null; - } - errorDetailsResolve(details); - errorDetailsResolve = null; - }; - - const eventListeners = []; - const onBeforeSendHeadersExtraInfoSpec = (headerModifications !== null ? this._onBeforeSendHeadersExtraInfoSpec : []); - this._addWebRequestEventListener(chrome.webRequest.onBeforeSendHeaders, onBeforeSendHeadersCallback, filter, onBeforeSendHeadersExtraInfoSpec, eventListeners); - this._addWebRequestEventListener(chrome.webRequest.onErrorOccurred, onErrorOccurredCallback, filter, void 0, eventListeners); - - try { - return await fetch(url, init); - } catch (e) { - // onErrorOccurred is not always invoked by this point, so a delay is needed - if (errorDetailsResolve !== null) { - errorDetailsTimer = setTimeout(() => { - errorDetailsTimer = null; - if (errorDetailsResolve === null) { return; } - errorDetailsResolve(null); - errorDetailsResolve = null; - }, 100); - } - const details = await errorDetailsPromise; - if (details !== null) { - const data = {details}; - this._assignErrorData(e, data); - } - throw e; - } finally { - this._removeWebRequestEventListeners(eventListeners); - } - } - - _addWebRequestEventListener(target, callback, filter, extraInfoSpec, eventListeners) { - try { - for (let i = 0; i < 2; ++i) { - try { - if (typeof extraInfoSpec === 'undefined') { - target.addListener(callback, filter); - } else { - target.addListener(callback, filter, extraInfoSpec); - } - break; - } catch (e) { - // Firefox doesn't support the 'extraHeaders' option and will throw the following error: - // Type error for parameter extraInfoSpec (Error processing 2: Invalid enumeration value "extraHeaders") for [target]. - if (i === 0 && `${e.message}`.includes('extraHeaders') && Array.isArray(extraInfoSpec)) { - const index = extraInfoSpec.indexOf('extraHeaders'); - if (index >= 0) { - extraInfoSpec.splice(index, 1); - continue; - } - } - throw e; - } - } - } catch (e) { - console.log(e); - return; - } - eventListeners.push({target, callback}); - } - - _removeWebRequestEventListeners(eventListeners) { - for (const {target, callback} of eventListeners) { - try { - target.removeListener(callback); - } catch (e) { - console.log(e); - } - } - } - - _getMatchURL(url) { - const url2 = new URL(url); - return `${url2.protocol}//${url2.host}${url2.pathname}${url2.search}`.replace(/\*/g, '%2a'); - } - - _getOriginURL(url) { - const url2 = new URL(url); - return `${url2.protocol}//${url2.host}`; - } - - _modifyHeaders(headers, modifications) { - modifications = new Map(modifications); - - for (let i = 0, ii = headers.length; i < ii; ++i) { - const header = headers[i]; - const name = header.name.toLowerCase(); - const modification = modifications.get(name); - if (typeof modification === 'undefined') { continue; } - - modifications.delete(name); - - if (modification === null) { - headers.splice(i, 1); - --i; - --ii; - } else { - headers[i] = modification; - } - } - - for (const header of modifications.values()) { - if (header !== null) { - headers.push(header); - } - } - } - async _clearSessionRules() { - if (!isObject(chrome.declarativeNetRequest)) { return; } - const rules = await this._getSessionRules(); if (rules.length === 0) { return; } @@ -276,68 +173,6 @@ class RequestBuilder { await this._updateSessionRules({removeRuleIds}); } - async _clearDynamicRules() { - if (!isObject(chrome.declarativeNetRequest)) { return; } - - const rules = await this._getDynamicRules(); - - if (rules.length === 0) { return; } - - const removeRuleIds = []; - for (const {id} of rules) { - removeRuleIds.push(id); - } - - await this._updateDynamicRules({removeRuleIds}); - } - - async _fetchAnonymousDeclarative(url, init) { - const id = this._getNewRuleId(); - const originUrl = this._getOriginURL(url); - url = encodeURI(decodeURI(url)); - - this._ruleIds.add(id); - try { - const addRules = [{ - id, - priority: 1, - condition: { - urlFilter: `|${this._escapeDnrUrl(url)}|`, - resourceTypes: ['xmlhttprequest'] - }, - action: { - type: 'modifyHeaders', - requestHeaders: [ - { - operation: 'remove', - header: 'Cookie' - }, - { - operation: 'set', - header: 'Origin', - value: originUrl - } - ], - responseHeaders: [ - { - operation: 'remove', - header: 'Set-Cookie' - } - ] - } - }]; - - await this._updateSessionRules({addRules}); - try { - return await fetch(url, init); - } finally { - await this._tryUpdateSessionRules({removeRuleIds: [id]}); - } - } finally { - this._ruleIds.delete(id); - } - } - _getSessionRules() { return new Promise((resolve, reject) => { chrome.declarativeNetRequest.getSessionRules((result) => { @@ -364,6 +199,28 @@ class RequestBuilder { }); } + async _tryUpdateSessionRules(options) { + try { + await this._updateSessionRules(options); + return true; + } catch (e) { + return false; + } + } + + async _clearDynamicRules() { + const rules = await this._getDynamicRules(); + + if (rules.length === 0) { return; } + + const removeRuleIds = []; + for (const {id} of rules) { + removeRuleIds.push(id); + } + + await this._updateDynamicRules({removeRuleIds}); + } + _getDynamicRules() { return new Promise((resolve, reject) => { chrome.declarativeNetRequest.getDynamicRules((result) => { @@ -390,15 +247,6 @@ class RequestBuilder { }); } - async _tryUpdateSessionRules(options) { - try { - await this._updateSessionRules(options); - return true; - } catch (e) { - return false; - } - } - _getNewRuleId() { let id = 1; while (this._ruleIds.has(id)) { @@ -409,6 +257,11 @@ class RequestBuilder { return id; } + _getOriginURL(url) { + const url2 = new URL(url); + return `${url2.protocol}//${url2.host}`; + } + _escapeDnrUrl(url) { return url.replace(/[|*^]/g, (char) => this._urlEncodeUtf8(char)); } @@ -422,25 +275,6 @@ class RequestBuilder { return result; } - _assignErrorData(error, data) { - try { - error.data = data; - } catch (e) { - // On Firefox, assigning DOMException.data can fail in certain contexts. - // https://bugzilla.mozilla.org/show_bug.cgi?id=1776555 - try { - Object.defineProperty(error, 'data', { - configurable: true, - enumerable: true, - writable: true, - value: data - }); - } catch (e2) { - // NOP - } - } - } - static _joinUint8Arrays(items, totalLength) { if (items.length === 1) { const {array, length} = items[0]; diff --git a/ext/permissions.html b/ext/permissions.html index 4aaef3c1..f6956cd7 100644 --- a/ext/permissions.html +++ b/ext/permissions.html @@ -47,22 +47,7 @@
-
-
-
webRequest and webRequestBlocking
-
-

- Yomitan uses these permissions to ensure certain requests have valid and secure headers. - This sometimes involves removing or changing the Origin request header, - as this can be used to fingerprint browser configuration. -

-

- Example: Origin: -

-
-
-
-
+
declarativeNetRequest
@@ -77,11 +62,11 @@
-
+
scripting
- Yomitan will sometimes need to inject stylesheets into webpages in order to + Yomitan needs to inject content scripts and stylesheets into webpages in order to properly display the search popup.
@@ -123,18 +108,6 @@
-
-
-
webNavigation (optional)
-
- Yomitan may require this permission to inject content scripts for certain browsers - if Google Docs accessibility mode is enabled. -
-
-
- -
-
Allow in private windows (optional)
-- cgit v1.2.3 From bbefd8a07ba71d7fe5e9c707ddb06e99bfd2a502 Mon Sep 17 00:00:00 2001 From: praschke Date: Sun, 29 Oct 2023 22:17:08 +0000 Subject: nativeMessaging can always be optional this is the only blocker to Firefox for Android. --- dev/data/manifest-variants.json | 29 ++++++----------------------- docs/permissions.md | 5 ++--- ext/js/extension/environment.js | 16 ++++++---------- ext/permissions.html | 4 ++-- ext/settings.html | 2 +- 5 files changed, 17 insertions(+), 39 deletions(-) diff --git a/dev/data/manifest-variants.json b/dev/data/manifest-variants.json index 4d4ec301..139814fd 100644 --- a/dev/data/manifest-variants.json +++ b/dev/data/manifest-variants.json @@ -229,25 +229,12 @@ "gecko": { "id": "{cb7c0bec-7085-4f84-8422-7b55a7c4467c}", "strict_min_version": "115.0" + }, + "gecko_android": { + "strict_min_version": "115.0" } } }, - { - "action": "remove", - "path": [ - "optional_permissions" - ], - "item": "nativeMessaging" - }, - { - "action": "add", - "path": [ - "permissions" - ], - "items": [ - "nativeMessaging" - ] - }, { "action": "remove", "path": [ @@ -327,13 +314,6 @@ ], "item": "clipboardRead" }, - { - "action": "remove", - "path": [ - "permissions" - ], - "item": "webRequestBlocking" - }, { "action": "remove", "path": [ @@ -365,6 +345,9 @@ ], "excludeFiles": [ "sw.js", + "offscreen.html", + "js/background/offscreen.js", + "js/background/offscreen-main.js", "js/dom/simple-dom-parser.js", "lib/parse5.js" ] diff --git a/docs/permissions.md b/docs/permissions.md index 8ab3bba5..b2b1a34c 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -27,15 +27,14 @@ Yomichan supports simulating the `Ctrl+C` (copy to clipboard) keyboard shortcut when a definitions popup is open and focused. -* `clipboardRead` (optional)
+* `clipboardRead` _(optional)_
Yomichan supports automatically opening a search window when Japanese text is copied to the clipboard while the browser is running, depending on how certain settings are configured. This allows Yomichan to support scanning text from external applications, provided there is a way to copy text from those applications to the clipboard. -* `nativeMessaging` (optional on Chrome)
+* `nativeMessaging` _(optional, unavailable on Firefox for Android)_
Yomichan has the ability to communicate with an optional native messaging component in order to support parsing large blocks of Japanese text using [MeCab](https://en.wikipedia.org/wiki/MeCab). The installation of this component is optional and is not included by default. - This permission is optional on Chrome, but required on Firefox, because Firefox does not permit it to be optional. diff --git a/ext/js/extension/environment.js b/ext/js/extension/environment.js index ec1e8612..ad5a19ae 100644 --- a/ext/js/extension/environment.js +++ b/ext/js/extension/environment.js @@ -31,8 +31,9 @@ class Environment { } async _loadEnvironmentInfo() { - const browser = await this._getBrowser(); const os = await this._getOperatingSystem(); + const browser = await this._getBrowser(os); + return { browser, platform: {os} @@ -64,7 +65,7 @@ class Environment { }); } - async _getBrowser() { + async _getBrowser(os) { try { if (chrome.runtime.getURL('/').startsWith('ms-browser-extension://')) { return 'edge-legacy'; @@ -76,17 +77,12 @@ class Environment { // NOP } if (typeof browser !== 'undefined') { - try { - const info = await browser.runtime.getBrowserInfo(); - if (info.name === 'Fennec') { - return 'firefox-mobile'; - } - } catch (e) { - // NOP - } if (this._isSafari()) { return 'safari'; } + if (os === 'android') { + return 'firefox-mobile'; + } return 'firefox'; } else { return 'chrome'; diff --git a/ext/permissions.html b/ext/permissions.html index f6956cd7..376a9de5 100644 --- a/ext/permissions.html +++ b/ext/permissions.html @@ -94,9 +94,9 @@
-
+
-
nativeMessaging (optional)
+
nativeMessaging (optional)
Yomitan has the ability to communicate with an optional native messaging component in order to support parsing large blocks of Japanese text using diff --git a/ext/settings.html b/ext/settings.html index f1001f90..8d5f0a76 100644 --- a/ext/settings.html +++ b/ext/settings.html @@ -1372,7 +1372,7 @@

-
+
-- cgit v1.2.3