-
Notifications
You must be signed in to change notification settings - Fork 2
/
KanjiOverlay.py
289 lines (235 loc) · 11.1 KB
/
KanjiOverlay.py
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
#-*- coding: utf-8 -*-
#
# Kanji Overlay Anki Plugin
#
# Comments & Suggestions at: fanatic84@gmail.com
#
# Use at your own Risk :)
#
# Insperated from the Work of Brian Bush on Anki v1 plugin, thank you very much
# Thanks for Roland Sieker <ospalh@gmail.com> and his plugin Local css for Anki 2
#
import os, pickle, datetime, codecs, shutil
from aqt import mw
from anki.hooks import addHook
from anki.utils import ids2str
from anki.cards import Card
import kol.KolConfig as KolConfig
from kol.AnkiHelper import *
from aqt.utils import showInfo
class KanjiOverlay:
################# CUSTOMIZE ###################
# switch the next Variable to True, if you don't want to use the GUI to configure
__useTheProfilesConfiguredInThisFile = False
Profiles = {
KolConfig.DEFAULTCONFIGNAME : #Profile by default
KolConfig.KolConfig(
ProfileName = KolConfig.DEFAULTCONFIGNAME,
KanjiUseCustomDeck = False,
KanjiDeckName = u'',
KanjiExpression = '',
KanjiKeyword = '',
KanjiDisplayWithFuriganaMod = True,
KanjiLoadDefaultValuesForNonExistingValues = False,
KanjiShowColorsForKnownKanji = True,
KanjiUseLink = False,
KanjiUseLinkUrl = '')
,"User 1" : #Other Profile Name
KolConfig.KolConfig(
#ProfileName = 'User 1',
KanjiUseCustomDeck = True,
KanjiDeckName = u'dictdec2',
KanjiExpression = 'Front',
KanjiKeyword = 'Back',
KanjiDisplayWithFuriganaMod = True,
KanjiLoadDefaultValuesForNonExistingValues = False,
KanjiShowColorsForKnownKanji = True,
KanjiUseLink = False,
KanjiUseLinkUrl = '')
}
# Add other Profile name
################################################
# usually data is only loaded, if modiefiet. if (True): always load data in the load-method
__alwaysLoadNewDictData = True
__DEBUG__ShowExceptions = False
__CssClassOfNotReviewedKanji = " unknown"
__CssClassOfUnknownKanji = 'kol-missing'
Profile = None
def load(self):
log("Load Plugin")
profileName = mw.pm.name
pf = None
if (self.__useTheProfilesConfiguredInThisFile):
pf = self.Profiles
else:
pf = KolConfig.getKolConfigManager(self.getConfigFilePathName()).allProfiles
self.Profile = pf[KolConfig.DEFAULTCONFIGNAME] if not profileName in pf else pf[profileName]
if(not (self.Profile.KanjiShowColorsForKnownKanji)):
self.__CssClassOfNotReviewedKanji = ""
self.__CssClassOfUnknownKanji = ''
self.__setupObjectData(self.Profile)
self.__loadKanjiDict()
self.__addCSS()
self.__addHooks()
log("End Load Plugin")
def __addCSS(self):
KanjiOverlay.css = self.loadCss()
KanjiOverlay.oldCss = Card.css
Card.css = injectCss
def __addHooks(self):
addHook('fmod_kol', self.injectKanjiOverlay)
if self.Profile.KanjiDisplayWithFuriganaMod:
addHook('fmod_furigana', self.injectKanjiOverlay)
addHook('fmod_kanji', self.injectKanjiOverlay)
def __loadKanjiDict(self):
# ------------ define an inner function for overall readiness -----------
def __loadKanjiDB(loadCustomDB):
kanjiDict = dict()
if (loadCustomDB):
if os.path.exists(self.kanjiCustomDictPath):
kanjiFile = open(self.kanjiCustomDictPath, "rb")
self.dlmod, self.nlmod, self.clmod, kanjiDict = pickle.load(kanjiFile)
deck = mw.col.decks.byName(self.Profile.KanjiDeckName)
if (AnkiHelper.isDeckModified(self.dlmod, self.nlmod, self.clmod, deck)
or self.__alwaysLoadNewDictData ):
kanjiDict = self.loadFromCustomDeck()
else:
kanjiDict = self.loadFromCustomDeck()
pass
else:
if os.path.exists(self.kanjiDefaultDictPath) == False:
raise Exception('Missing Default Dict')
kanjiFile = open(self.kanjiDefaultDictPath, "rb")
self.dlmod, self.nlmod, self.clmod, kanjiDict = pickle.load(kanjiFile)
pass
return kanjiDict
# --------------- the actual function starts here -------------
self.kanjiDict = dict()
if(self.Profile.KanjiLoadDefaultValuesForNonExistingValues):
# first load the default DB, so the Values from the custom DB
# overwrite/update the default values
self.kanjiDict = __loadKanjiDB(False)
try:
tmpDict = __loadKanjiDB(self.Profile.KanjiUseCustomDeck)
except Exception as e:
showInfo('Kanji Overlay Error: User defined Database could not be loaded.' +
' please check your settings. \nusing default Database instead')
tmpDict = __loadKanjiDB(False)
if(self.__DEBUG__ShowExceptions):
raise(e)
self.kanjiDict.update(tmpDict)
def __setupObjectData(self, profileVar):
self.kanjiCustomDictPath = os.path.join(mw.pm.profileFolder(), 'custom-kol.db')
self.kanjiDefaultDictPath = os.path.join(mw.pm.addonFolder(), 'kol', 'english-kol.db')
self.cssFileInPlugin = os.path.join(mw.pm.addonFolder(), 'kol', 'styles-kol.css')
self.cssFileInProfile = os.path.join(mw.pm.profileFolder(), 'styles-kol.css')
self.kanjiDict = None
def reload(self):
self.unload()
oldValue = self.__alwaysLoadNewDictData
self.__alwaysLoadNewDictData = True
self.load()
# restore old value
self.__alwaysLoadNewDictData = oldValue
def getConfigFilePathName(self):
return os.path.join(mw.pm.addonFolder(), 'kol', KolConfig.CONFIGFILENAME)
def loadCss(self):
try:
f = open(self.cssFileInPlugin, 'r')
css = unicode(f.read(), 'utf-8')
f.close()
if os.path.exists(self.cssFileInProfile):
f = open(self.cssFileInProfile, 'r')
cssInProfile = unicode(f.read(), 'utf-8')
css += cssInProfile
f.close()
except:
css = u''
return css
def unload(self):
Card.css = KanjiOverlay.oldCss
def injectKanjiOverlay(self, txt, *args):
#TODO: seems to crash Anki when using the browser :/
#if self.KanjiUseCustomDeck and os.path.exists(self.kanjiCustomDictPath): # reload if deck modified,
# deck = mw.col.decks.byName(self.KanjiDeckName)
# log("test deck modified")
# if AnkiHelper.isDeckModified(self.dlmod, self.nlmod, self.clmod, deck): # seems to crash Anki when search
# self.kanjiDict = self.loadFromCustomDeck()
def remap():
for c in txt:
if c >= u'\u4E00' and c <= u'\u9FBF': #Kanji
if c in self.kanjiDict:
kw, ivl = self.kanjiDict.get(c)
unkown = self.__CssClassOfNotReviewedKanji if ivl <= 0 and self.Profile.KanjiUseCustomDeck else ""
res = '<span class="kol%s">%s<span>%s</span></span>' % (unkown, c, kw)
if self.Profile.KanjiUseLink:
url = self.Profile.KanjiUseLinkUrl
url = url % c if '%s' in url else url + c
res = '<a style="text-decoration:none;" href="%s">%s</a>' % (url, res)
yield res
else: yield '<span class="' + self.__CssClassOfUnknownKanji + '">%s</span>' % (c)
else: yield c
return ''.join([x for x in remap()])
def loadFromCustomDeck(self):
log("loadFromCustomDeck")
deck = mw.col.decks.byName(self.Profile.KanjiDeckName)
cards = AnkiHelper.getCards(deck["id"])
kanjiDict = dict()
for card in cards:
note = card.note
try:
kanjiDict[note[self.Profile.KanjiExpression]] = (note[self.Profile.KanjiKeyword], card.ivl)
except: continue
self.dlmod = deck["mod"]
self.nlmod, self.clmod = AnkiHelper.getLastModified(deck["id"])
kanjiFile = open(self.kanjiCustomDictPath, "wb")
pickle.dump((self.dlmod, self.nlmod, self.clmod, kanjiDict), kanjiFile, 2)
return kanjiDict
def injectCss(self):
return '<style>%s</style>' % KanjiOverlay.css + KanjiOverlay.oldCss(self)
def log(msg):
logPath = os.path.join(mw.pm.addonFolder(), 'kol', 'main.log')
txt = '%s: %s' % (datetime.datetime.now(), msg)
f = codecs.open(logPath, 'a', 'utf-8')
f.write(txt + '\n')
f.close()
# ------------------------------------------------------------------------------
# ----------------------- For Menu in Anki -----------------------------------
# ------------------------------------------------------------------------------
def callConfigDialog():
AnkiConnection = KolConfig.ankiConnection(mw)
#for testing:
#AnkiConnection = KolConfig.ankiConnectionMOCK()
KolConfig.startUi(AnkiConnection, kanji.getConfigFilePathName(),mw)
kanji.reload()
pass
def reloadKol():
kanji.reload()
def addToMenuBar():
# The menu goes to
# Tools -> Add-Ons -> KanjiOverlay
for child in mw.form.menuPlugins.children():
try:
if(child.title() == 'KanjiOverlay'):
child.addAction(actionKolConfigDlg)
child.addAction(actionReloadKol)
return True
except:
continue
# in case - for whatever reason - there is no Point 'KanjiOverlay'
mw.form.menuPlugins.addAction(actionKolConfigDlg)
mw.form.menuPlugins.addAction(actionReloadKol)
from aqt.qt import *
actionKolConfigDlg = QAction("Kol Config Dialog", mw)
mw.connect(actionKolConfigDlg, SIGNAL("triggered()"), callConfigDialog)
actionReloadKol = QAction("Reload (in case of changes)", mw)
mw.connect(actionReloadKol, SIGNAL("triggered()"), reloadKol)
# If you want to call the config dialog directly from the Add-Ons-Menu, then enable this one
#mw.form.menuPlugins.addAction(action)
# ------------------------------------------------------------------------------
# ------------------------- hooks -------------------------------------------
# ------------------------------------------------------------------------------
kanji = KanjiOverlay()
addHook("profileLoaded", addToMenuBar)
addHook("profileLoaded", kanji.load)
addHook("unloadProfile", kanji.unload)