aboutsummaryrefslogtreecommitdiff
path: root/ext/js/background/offscreen.js
blob: 3b8b6a3e8952c247c870ad081c331a0a5e53ff83 (plain)
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
/*
 * 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 {ClipboardReader} from '../comm/clipboard-reader.js';
import {createApiMap, invokeApiMapHandler} from '../core/api-map.js';
import {arrayBufferToBase64} from '../data/sandbox/array-buffer-util.js';
import {DictionaryDatabase} from '../dictionary/dictionary-database.js';
import {Translator} from '../language/translator.js';

/**
 * This class controls the core logic of the extension, including API calls
 * and various forms of communication between browser tabs and external applications.
 */
export class Offscreen {
    /**
     * Creates a new instance.
     */
    constructor() {
        /** @type {DictionaryDatabase} */
        this._dictionaryDatabase = new DictionaryDatabase();
        /** @type {Translator} */
        this._translator = new Translator(this._dictionaryDatabase);
        /** @type {ClipboardReader} */
        this._clipboardReader = new ClipboardReader(
            (typeof document === 'object' && document !== null ? document : null),
            '#clipboard-paste-target',
            '#clipboard-rich-content-paste-target'
        );


        /* eslint-disable @stylistic/no-multi-spaces */
        /** @type {import('offscreen').ApiMap} */
        this._apiMap = createApiMap([
            ['clipboardGetTextOffscreen',    this._getTextHandler.bind(this)],
            ['clipboardGetImageOffscreen',   this._getImageHandler.bind(this)],
            ['clipboardSetBrowserOffscreen', this._setClipboardBrowser.bind(this)],
            ['databasePrepareOffscreen',     this._prepareDatabaseHandler.bind(this)],
            ['getDictionaryInfoOffscreen',   this._getDictionaryInfoHandler.bind(this)],
            ['databasePurgeOffscreen',       this._purgeDatabaseHandler.bind(this)],
            ['databaseGetMediaOffscreen',    this._getMediaHandler.bind(this)],
            ['translatorPrepareOffscreen',   this._prepareTranslatorHandler.bind(this)],
            ['findKanjiOffscreen',           this._findKanjiHandler.bind(this)],
            ['findTermsOffscreen',           this._findTermsHandler.bind(this)],
            ['getTermFrequenciesOffscreen',  this._getTermFrequenciesHandler.bind(this)],
            ['clearDatabaseCachesOffscreen', this._clearDatabaseCachesHandler.bind(this)]
        ]);
        /* eslint-enable @stylistic/no-multi-spaces */

        /** @type {?Promise<void>} */
        this._prepareDatabasePromise = null;
    }

    /** */
    prepare() {
        chrome.runtime.onMessage.addListener(this._onMessage.bind(this));
    }

    /** @type {import('offscreen').ApiHandler<'clipboardGetTextOffscreen'>} */
    async _getTextHandler({useRichText}) {
        return await this._clipboardReader.getText(useRichText);
    }

    /** @type {import('offscreen').ApiHandler<'clipboardGetImageOffscreen'>} */
    async _getImageHandler() {
        return await this._clipboardReader.getImage();
    }

    /** @type {import('offscreen').ApiHandler<'clipboardSetBrowserOffscreen'>} */
    _setClipboardBrowser({value}) {
        this._clipboardReader.browser = value;
    }

    /** @type {import('offscreen').ApiHandler<'databasePrepareOffscreen'>} */
    _prepareDatabaseHandler() {
        if (this._prepareDatabasePromise !== null) {
            return this._prepareDatabasePromise;
        }
        this._prepareDatabasePromise = this._dictionaryDatabase.prepare();
        return this._prepareDatabasePromise;
    }

    /** @type {import('offscreen').ApiHandler<'getDictionaryInfoOffscreen'>} */
    async _getDictionaryInfoHandler() {
        return await this._dictionaryDatabase.getDictionaryInfo();
    }

    /** @type {import('offscreen').ApiHandler<'databasePurgeOffscreen'>} */
    async _purgeDatabaseHandler() {
        return await this._dictionaryDatabase.purge();
    }

    /** @type {import('offscreen').ApiHandler<'databaseGetMediaOffscreen'>} */
    async _getMediaHandler({targets}) {
        const media = await this._dictionaryDatabase.getMedia(targets);
        return media.map((m) => ({...m, content: arrayBufferToBase64(m.content)}));
    }

    /** @type {import('offscreen').ApiHandler<'translatorPrepareOffscreen'>} */
    _prepareTranslatorHandler({descriptor}) {
        this._translator.prepare(descriptor);
    }

    /** @type {import('offscreen').ApiHandler<'findKanjiOffscreen'>} */
    async _findKanjiHandler({text, options}) {
        /** @type {import('translation').FindKanjiOptions} */
        const modifiedOptions = {
            ...options,
            enabledDictionaryMap: new Map(options.enabledDictionaryMap)
        };
        return await this._translator.findKanji(text, modifiedOptions);
    }

    /** @type {import('offscreen').ApiHandler<'findTermsOffscreen'>} */
    async _findTermsHandler({mode, text, options}) {
        const enabledDictionaryMap = new Map(options.enabledDictionaryMap);
        const excludeDictionaryDefinitions = (
            options.excludeDictionaryDefinitions !== null ?
            new Set(options.excludeDictionaryDefinitions) :
            null
        );
        const textReplacements = options.textReplacements.map((group) => {
            if (group === null) { return null; }
            return group.map((opt) => {
                // https://stackoverflow.com/a/33642463
                const match = opt.pattern.match(/\/(.*?)\/([a-z]*)?$/i);
                const [, pattern, flags] = match !== null ? match : ['', '', ''];
                return {...opt, pattern: new RegExp(pattern, flags ?? '')};
            });
        });
        /** @type {import('translation').FindTermsOptions} */
        const modifiedOptions = {
            ...options,
            enabledDictionaryMap,
            excludeDictionaryDefinitions,
            textReplacements
        };
        return this._translator.findTerms(mode, text, modifiedOptions);
    }

    /** @type {import('offscreen').ApiHandler<'getTermFrequenciesOffscreen'>} */
    _getTermFrequenciesHandler({termReadingList, dictionaries}) {
        return this._translator.getTermFrequencies(termReadingList, dictionaries);
    }

    /** @type {import('offscreen').ApiHandler<'clearDatabaseCachesOffscreen'>} */
    _clearDatabaseCachesHandler() {
        this._translator.clearDatabaseCaches();
    }

    /** @type {import('extension').ChromeRuntimeOnMessageCallback<import('offscreen').ApiMessageAny>} */
    _onMessage({action, params}, _sender, callback) {
        return invokeApiMapHandler(this._apiMap, action, params, [], callback);
    }
}