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
|
/*
* 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/>.
*/
/* global
* AnkiUtil
*/
class AnkiConnect {
constructor() {
this._enabled = false;
this._server = null;
this._localVersion = 2;
this._remoteVersion = 0;
this._versionCheckPromise = null;
}
get server() {
return this._server;
}
set server(value) {
this._server = value;
}
get enabled() {
return this._enabled;
}
set enabled(value) {
this._enabled = value;
}
async isConnected() {
try {
await this._invoke('version');
return true;
} catch (e) {
return false;
}
}
async getVersion() {
if (!this._enabled) { return null; }
await this._checkVersion();
return await this._invoke('version', {});
}
async addNote(note) {
if (!this._enabled) { return null; }
await this._checkVersion();
return await this._invoke('addNote', {note});
}
async canAddNotes(notes) {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('canAddNotes', {notes});
}
async notesInfo(notes) {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('notesInfo', {notes});
}
async getDeckNames() {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('deckNames');
}
async getModelNames() {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('modelNames');
}
async getModelFieldNames(modelName) {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('modelFieldNames', {modelName});
}
async guiBrowse(query) {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('guiBrowse', {query});
}
async guiBrowseNote(noteId) {
return await this.guiBrowse(`nid:${noteId}`);
}
async storeMediaFile(fileName, dataBase64) {
if (!this._enabled) {
throw new Error('AnkiConnect not enabled');
}
await this._checkVersion();
return await this._invoke('storeMediaFile', {filename: fileName, data: dataBase64});
}
async findNoteIds(notes) {
if (!this._enabled) { return []; }
await this._checkVersion();
const actions = notes.map((note) => {
let query = '';
switch (this._getDuplicateScopeFromNote(note)) {
case 'deck':
query = `"deck:${this._escapeQuery(note.deckName)}" `;
break;
case 'deck-root':
query = `"deck:${this._escapeQuery(AnkiUtil.getRootDeckName(note.deckName))}" `;
break;
}
query += this._fieldsToQuery(note.fields);
return {action: 'findNotes', params: {query}};
});
return await this._invoke('multi', {actions});
}
async suspendCards(cardIds) {
if (!this._enabled) { return false; }
await this._checkVersion();
return await this._invoke('suspend', {cards: cardIds});
}
async findCards(query) {
if (!this._enabled) { return []; }
await this._checkVersion();
return await this._invoke('findCards', {query});
}
async findCardsForNote(noteId) {
return await this.findCards(`nid:${noteId}`);
}
// Private
async _checkVersion() {
if (this._remoteVersion < this._localVersion) {
if (this._versionCheckPromise === null) {
const promise = this._invoke('version');
promise
.catch(() => {})
.finally(() => { this._versionCheckPromise = null; });
this._versionCheckPromise = promise;
}
this._remoteVersion = await this._versionCheckPromise;
if (this._remoteVersion < this._localVersion) {
throw new Error('Extension and plugin versions incompatible');
}
}
}
async _invoke(action, params) {
let response;
try {
response = await fetch(this._server, {
method: 'POST',
mode: 'cors',
cache: 'default',
credentials: 'omit',
headers: {
'Content-Type': 'application/json'
},
redirect: 'follow',
referrerPolicy: 'no-referrer',
body: JSON.stringify({action, params, version: this._localVersion})
});
} catch (e) {
const error = new Error('Anki connection failure');
error.data = {action, params, originalError: e};
throw error;
}
if (!response.ok) {
const error = new Error(`Anki connection error: ${response.status}`);
error.data = {action, params, status: response.status};
throw error;
}
let responseText = null;
let result;
try {
responseText = await response.text();
result = JSON.parse(responseText);
} catch (e) {
const error = new Error('Invalid Anki response');
error.data = {action, params, status: response.status, responseText, originalError: e};
throw error;
}
if (isObject(result)) {
const apiError = result.error;
if (typeof apiError !== 'undefined') {
const error = new Error(`Anki error: ${apiError}`);
error.data = {action, params, status: response.status, apiError};
throw error;
}
}
return result;
}
_escapeQuery(text) {
return text.replace(/"/g, '');
}
_fieldsToQuery(fields) {
const fieldNames = Object.keys(fields);
if (fieldNames.length === 0) {
return '';
}
const key = fieldNames[0];
return `"${key.toLowerCase()}:${this._escapeQuery(fields[key])}"`;
}
_getDuplicateScopeFromNote(note) {
const {options} = note;
if (typeof options === 'object' && options !== null) {
const {duplicateScope} = options;
if (typeof duplicateScope !== 'undefined') {
return duplicateScope;
}
}
return null;
}
}
|