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
|
--[[
Copyright: Ren Tatsumoto and contributors
License: GNU GPL, version 3 or later; http://www.gnu.org/licenses/gpl.html
AnkiConnect requests
]]
local utils = require('mp.utils')
local msg = require('mp.msg')
local h = require('helpers')
local self = {}
self.execute = function(request, completion_fn)
-- utils.format_json returns a string
-- On error, request_json will contain "null", not nil.
local request_json, error = utils.format_json(request)
if error ~= nil or request_json == "null" then
return completion_fn and completion_fn()
else
return self.platform.curl_request(self.config.ankiconnect_url, request_json, completion_fn)
end
end
self.parse_result = function(curl_output)
-- there are two values that we actually care about: result and error
-- but we need to crawl inside to get them.
if curl_output == nil then
return nil, "Failed to format json or no args passed"
end
if curl_output.status ~= 0 then
return nil, "Ankiconnect isn't running"
end
local stdout_json = utils.parse_json(curl_output.stdout)
if stdout_json == nil then
return nil, "Fatal error from Ankiconnect"
end
if stdout_json.error ~= nil then
return nil, tostring(stdout_json.error)
end
return stdout_json.result, nil
end
self.get_media_dir_path = function()
-- Ask AnkiConnect where to store media files.
-- If AnkiConnect isn't running, returns nil.
local ret = self.execute({
action = "getMediaDirPath",
version = 6,
})
local dir_path, error = self.parse_result(ret)
if not error then
return dir_path
else
msg.error(string.format("Couldn't retrieve path to collection.media folder: %s", error))
return nil
end
end
self.create_deck = function(deck_name)
local args = {
action = "changeDeck",
version = 6,
params = {
cards = {},
deck = deck_name
}
}
local result_notify = function(_, result, _)
local _, error = self.parse_result(result)
if not error then
msg.info(string.format("Deck %s: check completed.", deck_name))
else
msg.warn(string.format("Deck %s: check failed. Reason: %s.", deck_name, error))
end
end
self.execute(args, result_notify)
end
self.add_note = function(note_fields, tag, gui)
local action = gui and 'guiAddCards' or 'addNote'
local args = {
action = action,
version = 6,
params = {
note = {
deckName = self.config.deck_name,
modelName = self.config.model_name,
fields = note_fields,
options = {
allowDuplicate = self.config.allow_duplicates,
duplicateScope = "deck",
},
tags = h.is_empty(tag) and {} or { tag, },
}
}
}
local result_notify = function(_, result, _)
local note_id, error = self.parse_result(result)
if not error then
h.notify(string.format("Note added. ID = %s.", note_id))
else
h.notify(string.format("Error: %s.", error), "error", 2)
end
end
self.execute(args, result_notify)
end
self.get_last_note_ids = function(n_cards)
local ret = self.execute {
action = "findNotes",
version = 6,
params = {
query = "added:1" -- find all notes added today
}
}
local note_ids, _ = self.parse_result(ret)
if not h.is_empty(note_ids) then
return h.get_last_n_added_notes(note_ids, n_cards)
else
return {}
end
end
self.get_note_fields = function(note_id)
local ret = self.execute {
action = "notesInfo",
version = 6,
params = {
notes = { note_id }
}
}
local result, error = self.parse_result(ret)
if error == nil then
result = result[1].fields
for key, value in pairs(result) do
result[key] = value.value
end
return result
else
return nil
end
end
self.get_first_field = function(model_name)
local ret = self.execute {
action = "findModelsByName",
version = 6,
params = {
modelNames = { model_name }
}
}
local result, error = self.parse_result(ret)
if error == nil then
for _, field in pairs(result[1].flds) do
if field.ord == 0 then
return field.name
end
end
else
msg.error(string.format("Couldn't retrieve the first field's name of note type %s: %s", model_name, error))
return nil
end
end
self.gui_browse = function(query)
if not self.config.disable_gui_browse then
self.execute {
action = 'guiBrowse',
version = 6,
params = {
query = query
}
}
end
end
self.add_tag = function(note_id, tag)
if not h.is_empty(tag) then
self.execute {
action = 'addTags',
version = 6,
params = {
notes = { note_id },
tags = tag
}
}
end
end
self.append_media = function(note_id, fields, create_media_fn, tag)
-- AnkiConnect will fail to update the note if it's selected in the Anki Browser.
-- https://github.com/FooSoft/anki-connect/issues/82
-- Switch focus from the current note to avoid it.
self.gui_browse("nid:1") -- impossible nid
local args = {
action = "updateNoteFields",
version = 6,
params = {
note = {
id = note_id,
fields = fields,
}
}
}
local on_finish = function(_, result, _)
local _, error = self.parse_result(result)
if not error then
create_media_fn()
self.add_tag(note_id, tag)
self.gui_browse(string.format("nid:%s", note_id)) -- select the updated note in the card browser
h.notify(string.format("Note #%s updated.", note_id))
else
h.notify(string.format("Error: %s.", error), "error", 2)
end
end
self.execute(args, on_finish)
end
self.init = function(config, platform)
self.config = config
self.platform = platform
end
return self
|
