yomichan/ext/bg/js/anki.js

138 lines
3.8 KiB
JavaScript
Raw Normal View History

2016-10-11 02:50:55 +00:00
/*
* Copyright (C) 2016-2020 Yomichan Authors
2016-10-11 02:50:55 +00:00
*
* 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
2020-01-01 17:00:31 +00:00
* along with this program. If not, see <https://www.gnu.org/licenses/>.
2016-10-11 02:50:55 +00:00
*/
2020-03-11 02:30:36 +00:00
/* global
* requestJson
*/
2017-03-03 05:01:49 +00:00
2016-10-11 02:50:55 +00:00
class AnkiConnect {
2017-02-05 19:44:59 +00:00
constructor(server) {
2020-04-12 16:38:33 +00:00
this._enabled = false;
2020-04-12 16:20:02 +00:00
this._server = server;
this._localVersion = 2;
this._remoteVersion = 0;
2016-10-11 02:50:55 +00:00
}
2020-04-12 16:37:13 +00:00
setServer(server) {
this._server = server;
}
getServer() {
return this._server;
}
setEnabled(enabled) {
this._enabled = enabled;
}
isEnabled() {
return this._enabled;
}
2017-07-10 23:24:31 +00:00
async addNote(note) {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return null; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('addNote', {note});
2016-10-11 02:50:55 +00:00
}
2017-07-10 23:24:31 +00:00
async canAddNotes(notes) {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return []; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('canAddNotes', {notes});
2016-10-11 02:50:55 +00:00
}
2017-07-10 23:24:31 +00:00
async getDeckNames() {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return []; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('deckNames');
2016-10-11 02:50:55 +00:00
}
2017-07-10 23:24:31 +00:00
async getModelNames() {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return []; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('modelNames');
2016-10-11 02:50:55 +00:00
}
2017-07-10 23:24:31 +00:00
async getModelFieldNames(modelName) {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return []; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('modelFieldNames', {modelName});
2017-07-02 01:27:49 +00:00
}
2017-07-10 23:24:31 +00:00
async guiBrowse(query) {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return []; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('guiBrowse', {query});
2016-10-11 02:50:55 +00:00
}
async storeMediaFile(filename, dataBase64) {
2020-04-12 16:37:13 +00:00
if (!this._enabled) {
2020-04-12 16:43:24 +00:00
throw new Error('AnkiConnect not enabled');
2020-04-12 16:37:13 +00:00
}
2020-04-12 16:20:02 +00:00
await this._checkVersion();
return await this._invoke('storeMediaFile', {filename, data: dataBase64});
2016-10-11 02:50:55 +00:00
}
2019-10-10 00:27:05 +00:00
async findNoteIds(notes) {
2020-04-12 16:37:13 +00:00
if (!this._enabled) { return []; }
2020-04-12 16:20:02 +00:00
await this._checkVersion();
2019-11-27 03:01:54 +00:00
const actions = notes.map((note) => ({
2019-10-10 00:27:05 +00:00
action: 'findNotes',
params: {
2020-04-12 16:20:02 +00:00
query: `deck:"${this._escapeQuery(note.deckName)}" ${this._fieldsToQuery(note.fields)}`
2019-10-10 00:27:05 +00:00
}
}));
return await this._invoke('multi', {actions});
2020-04-12 16:20:02 +00:00
}
// Private
async _checkVersion() {
if (this._remoteVersion < this._localVersion) {
this._remoteVersion = await this._invoke('version');
2020-04-12 16:20:02 +00:00
if (this._remoteVersion < this._localVersion) {
throw new Error('Extension and plugin versions incompatible');
}
}
2019-10-10 00:27:05 +00:00
}
async _invoke(action, params) {
2020-04-12 16:43:24 +00:00
const result = await requestJson(this._server, 'POST', {action, params, version: this._localVersion});
2020-04-17 23:25:07 +00:00
if (isObject(result)) {
2020-04-12 16:43:24 +00:00
const error = result.error;
if (typeof error !== 'undefined') {
throw new Error(`AnkiConnect error: ${error}`);
}
}
return result;
2016-10-11 02:50:55 +00:00
}
2019-10-10 00:27:05 +00:00
2020-04-12 16:20:02 +00:00
_escapeQuery(text) {
2019-10-10 00:27:05 +00:00
return text.replace(/"/g, '');
}
2020-04-12 16:20:02 +00:00
_fieldsToQuery(fields) {
2019-10-10 00:27:05 +00:00
const fieldNames = Object.keys(fields);
if (fieldNames.length === 0) {
return '';
}
const key = fieldNames[0];
2020-04-12 16:20:02 +00:00
return `${key.toLowerCase()}:"${this._escapeQuery(fields[key])}"`;
2019-10-10 00:27:05 +00:00
}
2016-10-11 02:50:55 +00:00
}