summaryrefslogtreecommitdiff
path: root/ext/bg/js/anki.js
blob: 021cb4c44fdc83769269215dd11ce57c4fd36923 (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
/*
 * 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/>.
 */

/* global
 * requestJson
 */

/*
 * AnkiConnect
 */

class AnkiConnect {
    constructor(server) {
        this._server = server;
        this._localVersion = 2;
        this._remoteVersion = 0;
    }

    async addNote(note) {
        await this._checkVersion();
        return await this._ankiInvoke('addNote', {note});
    }

    async canAddNotes(notes) {
        await this._checkVersion();
        return await this._ankiInvoke('canAddNotes', {notes});
    }

    async getDeckNames() {
        await this._checkVersion();
        return await this._ankiInvoke('deckNames');
    }

    async getModelNames() {
        await this._checkVersion();
        return await this._ankiInvoke('modelNames');
    }

    async getModelFieldNames(modelName) {
        await this._checkVersion();
        return await this._ankiInvoke('modelFieldNames', {modelName});
    }

    async guiBrowse(query) {
        await this._checkVersion();
        return await this._ankiInvoke('guiBrowse', {query});
    }

    async storeMediaFile(filename, dataBase64) {
        await this._checkVersion();
        return await this._ankiInvoke('storeMediaFile', {filename, data: dataBase64});
    }

    async findNoteIds(notes) {
        await this._checkVersion();
        const actions = notes.map((note) => ({
            action: 'findNotes',
            params: {
                query: `deck:"${this._escapeQuery(note.deckName)}" ${this._fieldsToQuery(note.fields)}`
            }
        }));
        return await this._ankiInvoke('multi', {actions});
    }

    // Private

    async _checkVersion() {
        if (this._remoteVersion < this._localVersion) {
            this._remoteVersion = await this._ankiInvoke('version');
            if (this._remoteVersion < this._localVersion) {
                throw new Error('Extension and plugin versions incompatible');
            }
        }
    }

    _ankiInvoke(action, params) {
        return requestJson(this._server, 'POST', {action, params, version: this._localVersion});
    }

    _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])}"`;
    }
}


/*
 * AnkiNull
 */

class AnkiNull {
    async addNote() {
        return null;
    }

    async canAddNotes() {
        return [];
    }

    async getDeckNames() {
        return [];
    }

    async getModelNames() {
        return [];
    }

    async getModelFieldNames() {
        return [];
    }

    async guiBrowse() {
        return [];
    }

    async findNoteIds() {
        return [];
    }
}