From 9a39d0a7e2896edd4a6deebad00b8550cfffc15b Mon Sep 17 00:00:00 2001 From: jbukl Date: Fri, 20 Oct 2023 02:37:47 -0400 Subject: fix: chromium clipboard access on chromium, backend calls to clipboardGet are forwarded to an offscreen script --- dev/data/manifest-variants.json | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'dev/data') diff --git a/dev/data/manifest-variants.json b/dev/data/manifest-variants.json index 26d91d26..7f91e582 100644 --- a/dev/data/manifest-variants.json +++ b/dev/data/manifest-variants.json @@ -167,6 +167,15 @@ "pattern": "^(.*)(?:\\.\\s*)?$", "patternFlags": "", "replacement": "$1. This is a development build." + }, + { + "action": "add", + "path": [ + "permissions" + ], + "items": [ + "offscreen" + ] } ] }, -- cgit v1.2.3 From 379fdcf2280939c72e1be4e4f38567149a108873 Mon Sep 17 00:00:00 2001 From: jbukl Date: Sat, 21 Oct 2023 12:33:51 -0400 Subject: fix: clipboard getImage, review comments implement getImage for offscreen requests move offscreen files, offscreen prep is done in sw prep update permissions document for offscreen rearrange permissions --- dev/data/manifest-variants.json | 26 ++++++++----- docs/permissions.md | 5 +++ ext/css/offscreen.css | 30 --------------- ext/js/background/backend.js | 52 ++++++++++++++++---------- ext/js/background/offscreen-main.js | 25 +++++++++++++ ext/js/background/offscreen.js | 74 +++++++++++++++++++++++++++++++++++++ ext/js/offscreen/offscreen-main.js | 25 ------------- ext/js/offscreen/offscreen.js | 69 ---------------------------------- ext/offscreen.html | 4 +- 9 files changed, 154 insertions(+), 156 deletions(-) delete mode 100644 ext/css/offscreen.css create mode 100644 ext/js/background/offscreen-main.js create mode 100644 ext/js/background/offscreen.js delete mode 100644 ext/js/offscreen/offscreen-main.js delete mode 100644 ext/js/offscreen/offscreen.js (limited to 'dev/data') diff --git a/dev/data/manifest-variants.json b/dev/data/manifest-variants.json index 7f91e582..82f78961 100644 --- a/dev/data/manifest-variants.json +++ b/dev/data/manifest-variants.json @@ -82,7 +82,8 @@ "unlimitedStorage", "webRequest", "declarativeNetRequest", - "scripting" + "scripting", + "offscreen" ], "optional_permissions": [ "clipboardRead", @@ -167,15 +168,6 @@ "pattern": "^(.*)(?:\\.\\s*)?$", "patternFlags": "", "replacement": "$1. This is a development build." - }, - { - "action": "add", - "path": [ - "permissions" - ], - "items": [ - "offscreen" - ] } ] }, @@ -263,6 +255,13 @@ "permissions" ], "item": "declarativeNetRequest" + }, + { + "action": "remove", + "path": [ + "permissions" + ], + "item": "offscreen" } ], "excludeFiles": [ @@ -337,6 +336,13 @@ ], "item": "webRequestBlocking" }, + { + "action": "remove", + "path": [ + "permissions" + ], + "item": "offscreen" + }, { "action": "delete", "path": [ diff --git a/docs/permissions.md b/docs/permissions.md index b337bb31..4fa7ab83 100644 --- a/docs/permissions.md +++ b/docs/permissions.md @@ -23,6 +23,11 @@ Yomichan will sometimes need to inject stylesheets into webpages in order to properly display the search popup. +* `offscreen` __(Manifest v3 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. + * `clipboardWrite`
Yomichan supports simulating the `Ctrl+C` (copy to clipboard) keyboard shortcut when a definitions popup is open and focused. diff --git a/ext/css/offscreen.css b/ext/css/offscreen.css deleted file mode 100644 index ab283025..00000000 --- a/ext/css/offscreen.css +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright (C) 2023 Yomitan Authors - * Copyright (C) 2022 Yomichan Authors - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -/* stylelint-disable declaration-no-important */ -#clipboard-rich-content-paste-target * { - background-image: none !important; - list-style-image: none !important; - content: none !important; - cursor: auto !important; - border-image-source: none !important; - offset-path: none !important; - -webkit-mask-image: none !important; - mask-image: none !important; -} -/* stylelint-enable declaration-no-important */ diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js index f5cbb349..308ae4d5 100644 --- a/ext/js/background/backend.js +++ b/ext/js/background/backend.js @@ -58,16 +58,18 @@ class Backend { this._anki = new AnkiConnect(); this._mecab = new Mecab(); - this._clipboardReader = { - getText: this._getTextOffscreen.bind(this) - }; - if (!chrome || !chrome.offscreen) { + if (!chrome.offscreen) { this._clipboardReader = new ClipboardReader({ // eslint-disable-next-line no-undef document: (typeof document === 'object' && document !== null ? document : null), pasteTargetSelector: '#clipboard-paste-target', richContentPasteTargetSelector: '#clipboard-rich-content-paste-target' }); + } else { + this._clipboardReader = { + getText: this._getTextOffscreen.bind(this), + getImage: this._getImageOffscreen.bind(this) + }; } this._clipboardMonitor = new ClipboardMonitor({ @@ -227,6 +229,9 @@ class Backend { await this._requestBuilder.prepare(); await this._environment.prepare(); + if (chrome.offscreen) { + await this._setupOffscreenDocument(); + } this._clipboardReader.browser = this._environment.getInfo().browser; try { @@ -566,21 +571,6 @@ class Backend { return this._clipboardReader.getText(false); } - async _getTextOffscreen(useRichText) { - await this._setupOffscreenDocument(); - return new Promise((resolve, reject) => { - const callback = (response) => { - try { - resolve(this._getMessageResponseResult(response)); - } catch (error) { - reject(error); - } - }; - - chrome.runtime.sendMessage({action: 'clipboardGetOffscreen', params: {useRichText}}, callback); - }); - } - async _onApiGetDisplayTemplatesHtml() { return await this._fetchAsset('/display-templates.html'); } @@ -1634,6 +1624,20 @@ class Backend { return await (json ? response.json() : response.text()); } + _sendMessagePromise(...args) { + return new Promise((resolve, reject) => { + const callback = (response) => { + try { + resolve(this._getMessageResponseResult(response)); + } catch (error) { + reject(error); + } + }; + + chrome.runtime.sendMessage(...args, callback); + }); + } + _sendMessageIgnoreResponse(...args) { const callback = () => this._checkLastError(chrome.runtime.lastError); chrome.runtime.sendMessage(...args, callback); @@ -2244,6 +2248,14 @@ class Backend { return results; } + async _getTextOffscreen(useRichText) { + return this._sendMessagePromise({action: 'clipboardGetTextOffscreen', params: {useRichText}}); + } + + async _getImageOffscreen() { + return this._sendMessagePromise({action: 'clipboardGetImageOffscreen'}); + } + _onApiOpenCrossFramePort({targetTabId, targetFrameId}, sender) { const sourceTabId = (sender && sender.tab ? sender.tab.id : null); if (typeof sourceTabId !== 'number') { @@ -2300,7 +2312,7 @@ class Backend { this._creatingOffscreen = chrome.offscreen.createDocument({ url: 'offscreen.html', reasons: ['CLIPBOARD'], - justification: 'reason for needing the document' + justification: 'Access to the clipboard' }); await this._creatingOffscreen; this._creatingOffscreen = null; diff --git a/ext/js/background/offscreen-main.js b/ext/js/background/offscreen-main.js new file mode 100644 index 00000000..808e7766 --- /dev/null +++ b/ext/js/background/offscreen-main.js @@ -0,0 +1,25 @@ +/* + * Copyright (C) 2023 Yomitan Authors + * Copyright (C) 2020-2022 Yomichan Authors + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/* global + * Offscreen + */ + +(() => { + new Offscreen(); +})(); diff --git a/ext/js/background/offscreen.js b/ext/js/background/offscreen.js new file mode 100644 index 00000000..bc41d189 --- /dev/null +++ b/ext/js/background/offscreen.js @@ -0,0 +1,74 @@ +/* + * Copyright (C) 2023 Yomitan Authors + * Copyright (C) 2016-2022 Yomichan Authors + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/* global + * ClipboardReader + */ + +/** + * This class controls the core logic of the extension, including API calls + * and various forms of communication between browser tabs and external applications. + */ +class Offscreen { + /** + * Creates a new instance. + */ + constructor() { + this._clipboardReader = new ClipboardReader({ + // eslint-disable-next-line no-undef + document: (typeof document === 'object' && document !== null ? document : null), + pasteTargetSelector: '#clipboard-paste-target', + richContentPasteTargetSelector: '#clipboard-rich-content-paste-target' + }); + + this._messageHandlers = new Map([ + ['clipboardGetTextOffscreen', {async: true, contentScript: true, handler: this._getTextHandler.bind(this)}], + ['clipboardGetImageOffscreen', {async: true, contentScript: true, handler: this._getImageHandler.bind(this)}] + ]); + + const onMessage = this._onMessage.bind(this); + chrome.runtime.onMessage.addListener(onMessage); + } + + _getTextHandler({useRichText}) { + return this._clipboardReader.getText(useRichText); + } + + _getImageHandler() { + return this._clipboardReader.getImage(); + } + + _onMessage({action, params}, sender, callback) { + const messageHandler = this._messageHandlers.get(action); + if (typeof messageHandler === 'undefined') { return false; } + this._validatePrivilegedMessageSender(sender); + + return invokeMessageHandler(messageHandler, params, callback, sender); + } + + _validatePrivilegedMessageSender(sender) { + let {url} = sender; + if (typeof url === 'string' && yomichan.isExtensionUrl(url)) { return; } + const {tab} = url; + if (typeof tab === 'object' && tab !== null) { + ({url} = tab); + if (typeof url === 'string' && yomichan.isExtensionUrl(url)) { return; } + } + throw new Error('Invalid message sender'); + } +} diff --git a/ext/js/offscreen/offscreen-main.js b/ext/js/offscreen/offscreen-main.js deleted file mode 100644 index 808e7766..00000000 --- a/ext/js/offscreen/offscreen-main.js +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (C) 2023 Yomitan Authors - * Copyright (C) 2020-2022 Yomichan Authors - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -/* global - * Offscreen - */ - -(() => { - new Offscreen(); -})(); diff --git a/ext/js/offscreen/offscreen.js b/ext/js/offscreen/offscreen.js deleted file mode 100644 index 31e2c5d6..00000000 --- a/ext/js/offscreen/offscreen.js +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Copyright (C) 2023 Yomitan Authors - * Copyright (C) 2016-2022 Yomichan Authors - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -/* global - * ClipboardReader - */ - -/** - * This class controls the core logic of the extension, including API calls - * and various forms of communication between browser tabs and external applications. - */ -class Offscreen { - /** - * Creates a new instance. - */ - constructor() { - this._clipboardReader = new ClipboardReader({ - // eslint-disable-next-line no-undef - document: (typeof document === 'object' && document !== null ? document : null), - pasteTargetSelector: '#clipboard-paste-target', - richContentPasteTargetSelector: '#clipboard-rich-content-paste-target' - }); - - this._messageHandlers = new Map([ - ['clipboardGetOffscreen', {async: true, contentScript: true, handler: this._getTextHandler.bind(this)}] - ]); - - const onMessage = this._onMessage.bind(this); - chrome.runtime.onMessage.addListener(onMessage); - } - - _getTextHandler({useRichText}) { - return this._clipboardReader.getText(useRichText); - } - - _onMessage({action, params}, sender, callback) { - const messageHandler = this._messageHandlers.get(action); - if (typeof messageHandler === 'undefined') { return false; } - this._validatePrivilegedMessageSender(sender); - - return invokeMessageHandler(messageHandler, params, callback, sender); - } - - _validatePrivilegedMessageSender(sender) { - let {url} = sender; - if (typeof url === 'string' && yomichan.isExtensionUrl(url)) { return; } - const {tab} = url; - if (typeof tab === 'object' && tab !== null) { - ({url} = tab); - if (typeof url === 'string' && yomichan.isExtensionUrl(url)) { return; } - } - throw new Error('Invalid message sender'); - } -} diff --git a/ext/offscreen.html b/ext/offscreen.html index 11694636..f773e5b1 100644 --- a/ext/offscreen.html +++ b/ext/offscreen.html @@ -24,8 +24,8 @@ - - + +