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
|
/*
* Copyright (C) 2023-2024 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 <https://www.gnu.org/licenses/>.
*/
import {ExtensionError} from '../core/extension-error.js';
import {isObject} from '../core/utilities.js';
import {base64ToArrayBuffer} from '../data/sandbox/array-buffer-util.js';
export class OffscreenProxy {
/**
* @param {import('../extension/web-extension.js').WebExtension} webExtension
*/
constructor(webExtension) {
/** @type {import('../extension/web-extension.js').WebExtension} */
this._webExtension = webExtension;
/** @type {?Promise<void>} */
this._creatingOffscreen = null;
}
/**
* @see https://developer.chrome.com/docs/extensions/reference/offscreen/
*/
async prepare() {
if (await this._hasOffscreenDocument()) {
return;
}
if (this._creatingOffscreen) {
await this._creatingOffscreen;
return;
}
this._creatingOffscreen = chrome.offscreen.createDocument({
url: 'offscreen.html',
reasons: [
/** @type {chrome.offscreen.Reason} */ ('CLIPBOARD')
],
justification: 'Access to the clipboard'
});
await this._creatingOffscreen;
this._creatingOffscreen = null;
}
/**
* @returns {Promise<boolean>}
*/
async _hasOffscreenDocument() {
const offscreenUrl = chrome.runtime.getURL('offscreen.html');
if (!chrome.runtime.getContexts) { // chrome version below 116
// Clients: https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/clients
// @ts-expect-error - Types not set up for service workers yet
const matchedClients = await clients.matchAll();
// @ts-expect-error - Types not set up for service workers yet
return await matchedClients.some((client) => client.url === offscreenUrl);
}
const contexts = await chrome.runtime.getContexts({
contextTypes: [
/** @type {chrome.runtime.ContextType} */ ('OFFSCREEN_DOCUMENT')
],
documentUrls: [offscreenUrl]
});
return contexts.length > 0;
}
/**
* @template {import('offscreen').ApiNames} TMessageType
* @param {import('offscreen').ApiMessage<TMessageType>} message
* @returns {Promise<import('offscreen').ApiReturn<TMessageType>>}
*/
async sendMessagePromise(message) {
const response = await this._webExtension.sendMessagePromise(message);
return this._getMessageResponseResult(/** @type {import('core').Response<import('offscreen').ApiReturn<TMessageType>>} */ (response));
}
/**
* @template [TReturn=unknown]
* @param {import('core').Response<TReturn>} response
* @returns {TReturn}
* @throws {Error}
*/
_getMessageResponseResult(response) {
const runtimeError = chrome.runtime.lastError;
if (typeof runtimeError !== 'undefined') {
throw new Error(runtimeError.message);
}
if (!isObject(response)) {
throw new Error('Offscreen document did not respond');
}
const responseError = response.error;
if (responseError) {
throw ExtensionError.deserialize(responseError);
}
return response.result;
}
}
export class DictionaryDatabaseProxy {
/**
* @param {OffscreenProxy} offscreen
*/
constructor(offscreen) {
/** @type {OffscreenProxy} */
this._offscreen = offscreen;
}
/**
* @returns {Promise<void>}
*/
async prepare() {
await this._offscreen.sendMessagePromise({action: 'databasePrepareOffscreen'});
}
/**
* @returns {Promise<import('dictionary-importer').Summary[]>}
*/
async getDictionaryInfo() {
return this._offscreen.sendMessagePromise({action: 'getDictionaryInfoOffscreen'});
}
/**
* @returns {Promise<boolean>}
*/
async purge() {
return await this._offscreen.sendMessagePromise({action: 'databasePurgeOffscreen'});
}
/**
* @param {import('dictionary-database').MediaRequest[]} targets
* @returns {Promise<import('dictionary-database').Media[]>}
*/
async getMedia(targets) {
const serializedMedia = /** @type {import('dictionary-database').Media<string>[]} */ (await this._offscreen.sendMessagePromise({action: 'databaseGetMediaOffscreen', params: {targets}}));
const media = serializedMedia.map((m) => ({...m, content: base64ToArrayBuffer(m.content)}));
return media;
}
}
export class TranslatorProxy {
/**
* @param {OffscreenProxy} offscreen
*/
constructor(offscreen) {
/** @type {OffscreenProxy} */
this._offscreen = offscreen;
}
/**
* @param {import('language-transformer').LanguageTransformDescriptor} descriptor
*/
async prepare(descriptor) {
await this._offscreen.sendMessagePromise({action: 'translatorPrepareOffscreen', params: {descriptor}});
}
/**
* @param {string} text
* @param {import('translation').FindKanjiOptions} options
* @returns {Promise<import('dictionary').KanjiDictionaryEntry[]>}
*/
async findKanji(text, options) {
const enabledDictionaryMapList = [...options.enabledDictionaryMap];
/** @type {import('offscreen').FindKanjiOptionsOffscreen} */
const modifiedOptions = {
...options,
enabledDictionaryMap: enabledDictionaryMapList
};
return this._offscreen.sendMessagePromise({action: 'findKanjiOffscreen', params: {text, options: modifiedOptions}});
}
/**
* @param {import('translator').FindTermsMode} mode
* @param {string} text
* @param {import('translation').FindTermsOptions} options
* @returns {Promise<import('translator').FindTermsResult>}
*/
async findTerms(mode, text, options) {
const {enabledDictionaryMap, excludeDictionaryDefinitions, textReplacements} = options;
const enabledDictionaryMapList = [...enabledDictionaryMap];
const excludeDictionaryDefinitionsList = excludeDictionaryDefinitions ? [...excludeDictionaryDefinitions] : null;
const textReplacementsSerialized = textReplacements.map((group) => {
return group !== null ? group.map((opt) => ({...opt, pattern: opt.pattern.toString()})) : null;
});
/** @type {import('offscreen').FindTermsOptionsOffscreen} */
const modifiedOptions = {
...options,
enabledDictionaryMap: enabledDictionaryMapList,
excludeDictionaryDefinitions: excludeDictionaryDefinitionsList,
textReplacements: textReplacementsSerialized
};
return this._offscreen.sendMessagePromise({action: 'findTermsOffscreen', params: {mode, text, options: modifiedOptions}});
}
/**
* @param {import('translator').TermReadingList} termReadingList
* @param {string[]} dictionaries
* @returns {Promise<import('translator').TermFrequencySimple[]>}
*/
async getTermFrequencies(termReadingList, dictionaries) {
return this._offscreen.sendMessagePromise({action: 'getTermFrequenciesOffscreen', params: {termReadingList, dictionaries}});
}
/** */
async clearDatabaseCaches() {
await this._offscreen.sendMessagePromise({action: 'clearDatabaseCachesOffscreen'});
}
}
export class ClipboardReaderProxy {
/**
* @param {OffscreenProxy} offscreen
*/
constructor(offscreen) {
/** @type {?import('environment').Browser} */
this._browser = null;
/** @type {OffscreenProxy} */
this._offscreen = offscreen;
}
/** @type {?import('environment').Browser} */
get browser() { return this._browser; }
set browser(value) {
if (this._browser === value) { return; }
this._browser = value;
this._offscreen.sendMessagePromise({action: 'clipboardSetBrowserOffscreen', params: {value}});
}
/**
* @param {boolean} useRichText
* @returns {Promise<string>}
*/
async getText(useRichText) {
return await this._offscreen.sendMessagePromise({action: 'clipboardGetTextOffscreen', params: {useRichText}});
}
/**
* @returns {Promise<?string>}
*/
async getImage() {
return await this._offscreen.sendMessagePromise({action: 'clipboardGetImageOffscreen'});
}
}
|