summaryrefslogtreecommitdiff
path: root/ext/mixed/js/api.js
blob: 0bc91759602bdca27a88c048a59e00375e753d3f (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
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
/*
 * Copyright (C) 2016-2020  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/>.
 */


function apiOptionsSchemaGet() {
    return _apiInvoke('optionsSchemaGet');
}

function apiOptionsGet(optionsContext) {
    return _apiInvoke('optionsGet', {optionsContext});
}

function apiOptionsGetFull() {
    return _apiInvoke('optionsGetFull');
}

function apiOptionsSave(source) {
    return _apiInvoke('optionsSave', {source});
}

function apiTermsFind(text, details, optionsContext) {
    return _apiInvoke('termsFind', {text, details, optionsContext});
}

function apiTextParse(text, optionsContext) {
    return _apiInvoke('textParse', {text, optionsContext});
}

function apiKanjiFind(text, optionsContext) {
    return _apiInvoke('kanjiFind', {text, optionsContext});
}

function apiDefinitionAdd(definition, mode, context, details, optionsContext) {
    return _apiInvoke('definitionAdd', {definition, mode, context, details, optionsContext});
}

function apiDefinitionsAddable(definitions, modes, context, optionsContext) {
    return _apiInvoke('definitionsAddable', {definitions, modes, context, optionsContext});
}

function apiNoteView(noteId) {
    return _apiInvoke('noteView', {noteId});
}

function apiTemplateRender(template, data) {
    return _apiInvoke('templateRender', {data, template});
}

function apiAudioGetUri(definition, source, details) {
    return _apiInvoke('audioGetUri', {definition, source, details});
}

function apiCommandExec(command, params) {
    return _apiInvoke('commandExec', {command, params});
}

function apiScreenshotGet(options) {
    return _apiInvoke('screenshotGet', {options});
}

function apiSendMessageToFrame(frameId, action, params) {
    return _apiInvoke('sendMessageToFrame', {frameId, action, params});
}

function apiBroadcastTab(action, params) {
    return _apiInvoke('broadcastTab', {action, params});
}

function apiFrameInformationGet() {
    return _apiInvoke('frameInformationGet');
}

function apiInjectStylesheet(type, value) {
    return _apiInvoke('injectStylesheet', {type, value});
}

function apiGetEnvironmentInfo() {
    return _apiInvoke('getEnvironmentInfo');
}

function apiClipboardGet() {
    return _apiInvoke('clipboardGet');
}

function apiGetDisplayTemplatesHtml() {
    return _apiInvoke('getDisplayTemplatesHtml');
}

function apiGetQueryParserTemplatesHtml() {
    return _apiInvoke('getQueryParserTemplatesHtml');
}

function apiGetZoom() {
    return _apiInvoke('getZoom');
}

function apiGetDefaultAnkiFieldTemplates() {
    return _apiInvoke('getDefaultAnkiFieldTemplates');
}

function apiGetAnkiDeckNames() {
    return _apiInvoke('getAnkiDeckNames');
}

function apiGetAnkiModelNames() {
    return _apiInvoke('getAnkiModelNames');
}

function apiGetAnkiModelFieldNames(modelName) {
    return _apiInvoke('getAnkiModelFieldNames', {modelName});
}

function apiGetDictionaryInfo() {
    return _apiInvoke('getDictionaryInfo');
}

function apiGetDictionaryCounts(dictionaryNames, getTotal) {
    return _apiInvoke('getDictionaryCounts', {dictionaryNames, getTotal});
}

function apiPurgeDatabase() {
    return _apiInvoke('purgeDatabase');
}

function apiGetMedia(targets) {
    return _apiInvoke('getMedia', {targets});
}

function apiLog(error, level, context) {
    return _apiInvoke('log', {error, level, context});
}

function apiLogIndicatorClear() {
    return _apiInvoke('logIndicatorClear');
}

function apiImportDictionaryArchive(archiveContent, details, onProgress) {
    return _apiInvokeWithProgress('importDictionaryArchive', {archiveContent, details}, onProgress);
}

function apiDeleteDictionary(dictionaryName, onProgress) {
    return _apiInvokeWithProgress('deleteDictionary', {dictionaryName}, onProgress);
}

function apiModifySettings(targets, source) {
    return _apiInvoke('modifySettings', {targets, source});
}

function _apiCreateActionPort(timeout=5000) {
    return new Promise((resolve, reject) => {
        let timer = null;
        let portNameResolve;
        let portNameReject;
        const portNamePromise = new Promise((resolve2, reject2) => {
            portNameResolve = resolve2;
            portNameReject = reject2;
        });

        const onConnect = async (port) => {
            try {
                const portName = await portNamePromise;
                if (port.name !== portName || timer === null) { return; }
            } catch (e) {
                return;
            }

            clearTimeout(timer);
            timer = null;

            chrome.runtime.onConnect.removeListener(onConnect);
            resolve(port);
        };

        const onError = (e) => {
            if (timer !== null) {
                clearTimeout(timer);
                timer = null;
            }
            chrome.runtime.onConnect.removeListener(onConnect);
            portNameReject(e);
            reject(e);
        };

        timer = setTimeout(() => onError(new Error('Timeout')), timeout);

        chrome.runtime.onConnect.addListener(onConnect);
        _apiInvoke('createActionPort').then(portNameResolve, onError);
    });
}

function _apiInvokeWithProgress(action, params, onProgress, timeout=5000) {
    return new Promise((resolve, reject) => {
        let timer = null;
        let port = null;

        if (typeof onProgress !== 'function') {
            onProgress = () => {};
        }

        const onMessage = (message) => {
            switch (message.type) {
                case 'ack':
                    if (timer !== null) {
                        clearTimeout(timer);
                        timer = null;
                    }
                    break;
                case 'progress':
                    try {
                        onProgress(...message.data);
                    } catch (e) {
                        // NOP
                    }
                    break;
                case 'complete':
                    cleanup();
                    resolve(message.data);
                    break;
                case 'error':
                    cleanup();
                    reject(jsonToError(message.data));
                    break;
            }
        };

        const onDisconnect = () => {
            cleanup();
            reject(new Error('Disconnected'));
        };

        const cleanup = () => {
            if (timer !== null) {
                clearTimeout(timer);
                timer = null;
            }
            if (port !== null) {
                port.onMessage.removeListener(onMessage);
                port.onDisconnect.removeListener(onDisconnect);
                port.disconnect();
                port = null;
            }
            onProgress = null;
        };

        timer = setTimeout(() => {
            cleanup();
            reject(new Error('Timeout'));
        }, timeout);

        (async () => {
            try {
                port = await _apiCreateActionPort(timeout);
                port.onMessage.addListener(onMessage);
                port.onDisconnect.addListener(onDisconnect);
                port.postMessage({action, params});
            } catch (e) {
                cleanup();
                reject(e);
            } finally {
                action = null;
                params = null;
            }
        })();
    });
}

function _apiInvoke(action, params={}) {
    const data = {action, params};
    return new Promise((resolve, reject) => {
        try {
            chrome.runtime.sendMessage(data, (response) => {
                _apiCheckLastError(chrome.runtime.lastError);
                if (response !== null && typeof response === 'object') {
                    if (typeof response.error !== 'undefined') {
                        reject(jsonToError(response.error));
                    } else {
                        resolve(response.result);
                    }
                } else {
                    const message = response === null ? 'Unexpected null response' : `Unexpected response of type ${typeof response}`;
                    reject(new Error(`${message} (${JSON.stringify(data)})`));
                }
            });
        } catch (e) {
            reject(e);
            yomichan.triggerOrphaned(e);
        }
    });
}

function _apiCheckLastError() {
    // NOP
}

let _apiForwardLogsToBackendEnabled = false;
function apiForwardLogsToBackend() {
    if (_apiForwardLogsToBackendEnabled) { return; }
    _apiForwardLogsToBackendEnabled = true;

    yomichan.on('log', async ({error, level, context}) => {
        try {
            await apiLog(errorToJson(error), level, context);
        } catch (e) {
            // NOP
        }
    });
}