forked from ObsidianToAnki/Obsidian_to_Anki
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.ts
275 lines (254 loc) · 8.07 KB
/
main.ts
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
import { Notice, Plugin, addIcon, TFile, TFolder } from 'obsidian'
import * as AnkiConnect from './src/anki'
import { PluginSettings, ParsedSettings } from './src/interfaces/settings-interface'
import { DEFAULT_IGNORED_FILE_GLOBS, SettingsTab } from './src/settings'
import { ANKI_ICON } from './src/constants'
import { settingToData } from './src/setting-to-data'
import { FileManager } from './src/files-manager'
export default class MyPlugin extends Plugin {
settings: PluginSettings
note_types: Array<string>
fields_dict: Record<string, string[]>
added_media: string[]
file_hashes: Record<string, string>
async getDefaultSettings(): Promise<PluginSettings> {
let settings: PluginSettings = {
CUSTOM_REGEXPS: {},
FILE_LINK_FIELDS: {},
CONTEXT_FIELDS: {},
FOLDER_DECKS: {},
FOLDER_TAGS: {},
Syntax: {
"Begin Note": "START",
"End Note": "END",
"Begin Inline Note": "STARTI",
"End Inline Note": "ENDI",
"Target Deck Line": "TARGET DECK",
"File Tags Line": "FILE TAGS",
"Delete Note Line": "DELETE",
"Frozen Fields Line": "FROZEN"
},
Defaults: {
"Scan Directory": "",
"Tag": "Obsidian_to_Anki",
"Deck": "Default",
"Scheduling Interval": 0,
"Add File Link": false,
"Add Context": false,
"CurlyCloze": false,
"CurlyCloze - Highlights to Clozes": false,
"ID Comments": true,
"Add Obsidian Tags": false,
"Use Path as Deck" : false,
"Add Card link": false
},
IGNORED_FILE_GLOBS: DEFAULT_IGNORED_FILE_GLOBS,
}
/*Making settings from scratch, so need note types*/
this.note_types = await AnkiConnect.invoke('modelNames') as Array<string>
this.fields_dict = await this.generateFieldsDict()
for (let note_type of this.note_types) {
settings["CUSTOM_REGEXPS"][note_type] = ""
const field_names: string[] = await AnkiConnect.invoke(
'modelFieldNames', {modelName: note_type}
) as string[]
this.fields_dict[note_type] = field_names
settings["FILE_LINK_FIELDS"][note_type] = field_names[0]
}
return settings
}
async generateFieldsDict(): Promise<Record<string, string[]>> {
let fields_dict = {}
for (let note_type of this.note_types) {
const field_names: string[] = await AnkiConnect.invoke(
'modelFieldNames', {modelName: note_type}
) as string[]
fields_dict[note_type] = field_names
}
return fields_dict
}
async saveDefault(): Promise<void> {
const default_sets = await this.getDefaultSettings()
this.saveData(
{
settings: default_sets,
"Added Media": [],
"File Hashes": {},
fields_dict: {}
}
)
}
async loadSettings(): Promise<PluginSettings> {
let current_data = await this.loadData()
if (current_data == null || Object.keys(current_data).length != 4) {
new Notice("Need to connect to Anki generate default settings...")
const default_sets = await this.getDefaultSettings()
this.saveData(
{
settings: default_sets,
"Added Media": [],
"File Hashes": {},
fields_dict: {}
}
)
new Notice("Default settings successfully generated!")
return default_sets
} else {
return current_data.settings
}
}
async loadAddedMedia(): Promise<string[]> {
let current_data = await this.loadData()
if (current_data == null) {
await this.saveDefault()
return []
} else {
return current_data["Added Media"]
}
}
async loadFileHashes(): Promise<Record<string, string>> {
let current_data = await this.loadData()
if (current_data == null) {
await this.saveDefault()
return {}
} else {
return current_data["File Hashes"]
}
}
async loadFieldsDict(): Promise<Record<string, string[]>> {
let current_data = await this.loadData()
if (current_data == null) {
await this.saveDefault()
const fields_dict = await this.generateFieldsDict()
return fields_dict
}
return current_data.fields_dict
}
async saveAllData(): Promise<void> {
this.saveData(
{
settings: this.settings,
"Added Media": this.added_media,
"File Hashes": this.file_hashes,
fields_dict: this.fields_dict
}
)
}
regenerateSettingsRegexps() {
let regexp_section = this.settings["CUSTOM_REGEXPS"]
// For new note types
for (let note_type of this.note_types) {
this.settings["CUSTOM_REGEXPS"][note_type] = regexp_section.hasOwnProperty(note_type) ? regexp_section[note_type] : ""
}
// Removing old note types
for (let note_type of Object.keys(this.settings["CUSTOM_REGEXPS"])) {
if (!this.note_types.includes(note_type)) {
delete this.settings["CUSTOM_REGEXPS"][note_type]
}
}
}
/**
* Recursively traverse a TFolder and return all TFiles.
* @param tfolder - The TFolder to start the traversal from.
* @returns An array of TFiles found within the folder and its subfolders.
*/
getAllTFilesInFolder(tfolder) {
const allTFiles = [];
// Check if the provided object is a TFolder
if (!(tfolder instanceof TFolder)) {
return allTFiles;
}
// Iterate through the contents of the folder
tfolder.children.forEach((child) => {
// If it's a TFile, add it to the result
if (child instanceof TFile) {
allTFiles.push(child);
} else if (child instanceof TFolder) {
// If it's a TFolder, recursively call the function on it
const filesInSubfolder = this.getAllTFilesInFolder(child);
allTFiles.push(...filesInSubfolder);
}
// Ignore other types of files or objects
});
return allTFiles;
}
async scanVault() {
new Notice('Scanning vault, check console for details...');
console.info("Checking connection to Anki...")
try {
await AnkiConnect.invoke('modelNames')
}
catch(e) {
new Notice("Error, couldn't connect to Anki! Check console for error message.")
return
}
new Notice("Successfully connected to Anki! This could take a few minutes - please don't close Anki until the plugin is finished")
const data: ParsedSettings = await settingToData(this.app, this.settings, this.fields_dict)
const scanDir = this.app.vault.getAbstractFileByPath(this.settings.Defaults["Scan Directory"])
let manager = null;
if (scanDir !== null) {
let markdownFiles = [];
if (scanDir instanceof TFolder) {
console.info("Using custom scan directory: " + scanDir.path)
markdownFiles = this.getAllTFilesInFolder(scanDir);
} else {
new Notice("Error: incorrect path for scan directory " + this.settings.Defaults["Scan Directory"])
return
}
manager = new FileManager(this.app, data, markdownFiles, this.file_hashes, this.added_media)
} else {
manager = new FileManager(this.app, data, this.app.vault.getMarkdownFiles(), this.file_hashes, this.added_media);
}
await manager.initialiseFiles()
await manager.requests_1()
this.added_media = Array.from(manager.added_media_set)
const hashes = manager.getHashes()
for (let key in hashes) {
this.file_hashes[key] = hashes[key]
}
new Notice("All done! Saving file hashes and added media now...")
this.saveAllData()
}
async onload() {
console.log('loading Obsidian_to_Anki...');
addIcon('anki', ANKI_ICON)
try {
this.settings = await this.loadSettings()
}
catch(e) {
new Notice("Couldn't connect to Anki! Check console for error message.")
return
}
this.note_types = Object.keys(this.settings["CUSTOM_REGEXPS"])
this.fields_dict = await this.loadFieldsDict()
if (Object.keys(this.fields_dict).length == 0) {
new Notice('Need to connect to Anki to generate fields dictionary...')
try {
this.fields_dict = await this.generateFieldsDict()
new Notice("Fields dictionary successfully generated!")
}
catch(e) {
new Notice("Couldn't connect to Anki! Check console for error message.")
return
}
}
this.added_media = await this.loadAddedMedia()
this.file_hashes = await this.loadFileHashes()
this.addSettingTab(new SettingsTab(this.app, this));
this.addRibbonIcon('anki', 'Obsidian_to_Anki - Scan Vault', async () => {
await this.scanVault()
})
this.addCommand({
id: 'anki-scan-vault',
name: 'Scan Vault',
callback: async () => {
await this.scanVault()
}
})
}
async onunload() {
console.log("Saving settings for Obsidian_to_Anki...")
this.saveAllData()
console.log('unloading Obsidian_to_Anki...');
}
}