forked from davidfor/calibre-annotations
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcommon_utils.py
1270 lines (1059 loc) · 45.4 KB
/
common_utils.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# coding: utf-8
from __future__ import (unicode_literals, division, absolute_import,
print_function)
__license__ = 'GPL v3'
__copyright__ = '2013, Greg Riker <[email protected]>, 2014-2020 additions by David Forrester <[email protected]>'
__docformat__ = 'restructuredtext en'
import re, os, sys, zipfile
from collections import defaultdict
from time import sleep
# calibre Python 3 compatibility.
try:
from urllib.parse import urlparse
except ImportError as e:
from urlparse import urlparse
import six
from six import text_type as unicode
import collections
try:
from PyQt5.QtCore import pyqtSignal
from PyQt5.Qt import (Qt, QAction, QApplication,
QCheckBox, QComboBox, QDial, QDialog, QDialogButtonBox, QDoubleSpinBox, QIcon,
QKeySequence, QLabel, QLineEdit, QPixmap, QProgressBar, QPlainTextEdit,
QRadioButton, QSize, QSizePolicy, QSlider, QSpinBox, QThread, QUrl,
QVBoxLayout, QHBoxLayout, QFont
)
from PyQt5.Qt import QTextEdit as QWebView # Renaming to keep backwards compatibility.
from PyQt5.uic import compileUi
except ImportError as e:
from calibre.devices.usbms.driver import debug_print
debug_print("Error loading QT5: ", e)
from PyQt4.Qt import (Qt, QAction, QApplication,
QCheckBox, QComboBox, QDial, QDialog, QDialogButtonBox, QDoubleSpinBox, QIcon,
QKeySequence, QLabel, QLineEdit, QPixmap, QProgressBar, QPlainTextEdit,
QRadioButton, QSize, QSizePolicy, QSlider, QSpinBox, QThread, QUrl,
QVBoxLayout, QHBoxLayout, QFont,
pyqtSignal)
from PyQt4.QtWebKit import QWebView
from PyQt4.uic import compileUi
from calibre.constants import iswindows
from calibre.devices.usbms.driver import debug_print
from calibre.ebooks import normalize
from calibre.ebooks.BeautifulSoup import BeautifulSoup, BeautifulStoneSoup
from calibre.ebooks.metadata import MetaInformation
from calibre.gui2 import Application, gprefs, error_dialog, info_dialog, UNDEFINED_QDATETIME
from calibre.gui2.dialogs.message_box import MessageBox
from calibre.library import current_library_name
from calibre.utils.config import config_dir
from calibre.utils.logging import Log
from calibre_plugins.annotations.message_box_ui import Ui_Dialog, COVER_ICON_SIZE
from calibre_plugins.annotations.reader_app_support import ReaderApp
try:
debug_print("Annotations::common_utils.py - loading translations")
load_translations()
except NameError:
debug_print("Annotations::common_utils.py - exception when loading translations")
pass # load_translations() added in calibre 1.9
try:
from calibre.gui2 import QVariant
del QVariant
except ImportError:
is_qt4 = False
convert_qvariant = lambda x: x
else:
is_qt4 = True
def convert_qvariant(x):
vt = x.type()
if vt == x.String:
return unicode(x.toString())
if vt == x.List:
return [convert_qvariant(i) for i in x.toList()]
return x.toPyObject()
# Stateful controls: (<class>,<list_name>,<get_method>,<default>,<set_method(s)>)
# multiple set_methods are chained, i.e. the results of the first call are passed to the second
# Currently a max of two chained CONTROL_SET methods are implemented, explicity for comboBox
CONTROLS = [
(QCheckBox, 'checkBox_controls', 'isChecked', False, 'setChecked'),
(QComboBox, 'comboBox_controls', 'currentText', '', ('findText', 'setCurrentIndex')),
(QDial, 'dial_controls', 'value', 0, 'setValue'),
(QDoubleSpinBox, 'doubleSpinBox_controls', 'value', 0, 'setValue'),
(QLineEdit, 'lineEdit_controls', 'text', '', 'setText'),
(QRadioButton, 'radioButton_controls', 'isChecked', False, 'setChecked'),
(QSlider, 'slider_controls', 'value', 0, 'setValue'),
(QSpinBox, 'spinBox_controls', 'value', 0, 'setValue'),
]
CONTROL_CLASSES = [control[0] for control in CONTROLS]
CONTROL_TYPES = [control[1] for control in CONTROLS]
CONTROL_GET = [control[2] for control in CONTROLS]
CONTROL_DEFAULT = [control[3] for control in CONTROLS]
CONTROL_SET = [control[4] for control in CONTROLS]
plugin_tmpdir = 'calibre_annotations_plugin'
plugin_icon_resources = {}
''' Base classes '''
class Logger():
LOCATION_TEMPLATE = "{cls}:{func}({arg1}) {arg2}"
def _log(self, msg=None):
'''
Print msg to console
'''
from calibre_plugins.annotations.config import plugin_prefs
if not plugin_prefs.get('cfg_plugin_debug_log_checkbox', False):
return
if msg:
debug_print(" %s" % str(msg))
else:
debug_print()
def _log_location(self, *args):
'''
Print location, args to console
'''
from calibre_plugins.annotations.config import plugin_prefs
if not plugin_prefs.get('cfg_plugin_debug_log_checkbox', False):
return
arg1 = arg2 = ''
if len(args) > 0:
arg1 = str(args[0])
if len(args) > 1:
arg2 = str(args[1])
debug_print(self.LOCATION_TEMPLATE.format(cls=self.__class__.__name__,
func=sys._getframe(1).f_code.co_name,
arg1=arg1, arg2=arg2))
class Struct(dict):
"""
Create an object with dot-referenced members or dictionary
"""
def __init__(self, **kwds):
dict.__init__(self, kwds)
self.__dict__ = self
def __repr__(self):
return '\n'.join([" %s: %s" % (key, repr(self[key])) for key in sorted(self.keys())])
class AnnotationStruct(Struct):
"""
Populate an empty annotation structure with fields for all possible values
"""
def __init__(self):
super(AnnotationStruct, self).__init__(
annotation_id=None,
book_id=None,
epubcfi=None,
genre=None,
highlight_color=None,
highlight_text=None,
last_modification=None,
location=None,
location_sort=None,
note_text=None,
reader=None,
)
class BookStruct(Struct):
"""
Populate an empty book structure with fields for all possible values
"""
def __init__(self):
super(BookStruct, self).__init__(
active=None,
author=None,
author_sort=None,
book_id=None,
genre='',
last_annotation=None,
path=None,
title=None,
title_sort=None,
uuid=None,
confidence=None
)
class PlainTextEdit(QPlainTextEdit, Logger):
"""
Subclass enabling drag 'n drop
"""
def __init__(self, parent):
QPlainTextEdit.__init__(self, parent.gui)
self.parent = parent
self.opts = parent.opts
self.setAcceptDrops(True)
def dragEnterEvent(self, event):
md = event.mimeData()
if md.hasFormat("text/uri-list"):
event.accept()
else:
event.ignore()
def dragMoveEvent(self, event):
md = event.mimeData()
if md.hasFormat("text/uri-list"):
event.acceptProposedAction()
else:
event.ignore()
def dropEvent(self, event):
data = event.mimeData()
mime = "text/uri-list"
url = str(data.data(mime))
path = urlparse(url).path.strip()
scheme = urlparse(url).scheme
path = re.sub('%20', ' ', path)
if iswindows:
if path.startswith('/Shared Folders'):
path = re.sub(r'\/Shared Folders', 'Z:', path)
elif path.startswith('/'):
path = path[1:]
extension = path.rpartition('.')[2]
if scheme == 'file' and extension in ['mrv', 'mrvi', 'txt']:
with open(path) as f:
raw = f.read()
u = unicode(raw, 'utf-8')
self.setPlainText(u)
else:
self._log_location("unsupported import: %s" % path)
class ImageTitleLayout(QHBoxLayout):
'''
A reusable layout widget displaying an image followed by a title
'''
def __init__(self, parent, icon_name, title, has_help=True):
QHBoxLayout.__init__(self)
self.title_image_label = QLabel(parent)
self.update_title_icon(icon_name)
self.addWidget(self.title_image_label)
title_font = QFont()
title_font.setPointSize(16)
shelf_label = QLabel(title, parent)
shelf_label.setFont(title_font)
self.addWidget(shelf_label)
self.insertStretch(-1)
# Add hyperlink to a help file at the right. We will replace the correct name when it is clicked.
if has_help:
help_label = QLabel(('<a href="http://www.foo.com/">{0}</a>').format(_("Help")), parent)
help_label.setTextInteractionFlags(Qt.LinksAccessibleByMouse | Qt.LinksAccessibleByKeyboard)
help_label.setAlignment(Qt.AlignRight)
help_label.linkActivated.connect(parent.help_link_activated)
self.addWidget(help_label)
def update_title_icon(self, icon_name):
pixmap = get_pixmap(icon_name)
if pixmap is None:
error_dialog(self.parent(), _("Restart required"),
_("Title image not found - you must restart Calibre before using this plugin!"), show=True)
else:
self.title_image_label.setPixmap(pixmap)
self.title_image_label.setMaximumSize(32, 32)
self.title_image_label.setScaledContents(True)
class SizePersistedDialog(QDialog):
'''
This dialog is a base class for any dialogs that want their size/position
restored when they are next opened.
'''
def __init__(self, parent, unique_pref_name):
QDialog.__init__(self, parent, Qt.WindowStaysOnTopHint)
self.unique_pref_name = unique_pref_name
# self.geom = self.prefs.get(unique_pref_name, None)
self.geom = gprefs.get(unique_pref_name, None)
self.finished.connect(self.dialog_closing)
self.help_anchor = ''
def resize_dialog(self):
if self.geom is None:
self.resize(self.sizeHint())
else:
self.restoreGeometry(self.geom)
def dialog_closing(self, result):
geom = bytearray(self.saveGeometry())
gprefs[self.unique_pref_name] = geom
def help_link_activated(self, url):
self.plugin_action.show_help(anchor=self.help_anchor)
''' Exceptions '''
class AnnotationsException(Exception):
''' '''
pass
class DeviceNotMountedException(Exception):
''' '''
pass
class ExpiredException(Exception):
pass
class UnknownAnnotationTypeException(Exception):
pass
''' Dialogs '''
class ImportAnnotationsDialog(QDialog):
def __init__(self, parent, friendly_name, rac):
#self.dialog = QDialog(parent.gui)
QDialog.__init__(self, parent.gui)
self.parent = parent
self.opts = parent.opts
self.rac = rac
parent_loc = self.parent.gui.pos()
self.move(parent_loc.x(), parent_loc.y())
self.setWindowTitle(rac.import_dialog_title)
self.setWindowIcon(self.opts.icon)
l = QVBoxLayout()
self.setLayout(l)
self.pte = PlainTextEdit(self.parent)
self.pte.setPlainText(rac.initial_dialog_text)
self.pte.setMinimumWidth(400)
l.addWidget(self.pte)
self.dialogButtonBox = QDialogButtonBox(QDialogButtonBox.Cancel|QDialogButtonBox.Help)
self.import_button = self.dialogButtonBox.addButton(self.dialogButtonBox.Ok)
self.import_button.setText(_('Import'))
self.dialogButtonBox.clicked.connect(self.import_annotations_dialog_clicked)
l.addWidget(self.dialogButtonBox)
self.rejected.connect(self.close)
self.exec_()
self.text = str(self.pte.toPlainText())
def close(self):
# Catch ESC and close button
self.pte.setPlainText('')
self.accept()
def import_annotations_dialog_clicked(self, button):
BUTTON_ROLES = ['AcceptRole', 'RejectRole', 'DestructiveRole', 'ActionRole',
'HelpRole', 'YesRole', 'NoRole', 'ApplyRole', 'ResetRole']
if self.dialogButtonBox.buttonRole(button) == QDialogButtonBox.AcceptRole:
# Remove initial_dialog_text if user clicks OK without dropping file
if self.text() == self.rac.initial_dialog_text:
self.pte.clear()
self.accept()
elif self.dialogButtonBox.buttonRole(button) == QDialogButtonBox.HelpRole:
hv = HelpView(self, self.opts.icon, self.opts.prefs, html=self.rac.import_help_text)
hv.show()
else:
self.close()
def text(self):
return unicode(self.pte.toPlainText())
class CoverMessageBox(QDialog, Ui_Dialog):
ERROR = 0
WARNING = 1
INFO = 2
QUESTION = 3
def __init__(self, type_, title, msg, opts,
det_msg='',
q_icon=None,
show_copy_button=True,
parent=None, default_yes=True):
QDialog.__init__(self, parent)
if q_icon is None:
icon = {
self.ERROR: 'error',
self.WARNING: 'warning',
self.INFO: 'information',
self.QUESTION: 'question',
}[type_]
icon = 'dialog_%s.png' % icon
self.icon = QIcon(I(icon))
else:
self.icon = q_icon
self.setupUi(self)
self.setWindowTitle(title)
self.setWindowIcon(opts.icon)
#self.icon_label.setPixmap(self.icon.pixmap(self.COVER_SIZE, self.COVER_SIZE))
self.icon_label.setPixmap(self.icon.pixmap(COVER_ICON_SIZE))
self.msg.setText(msg)
self.msg.setOpenExternalLinks(True)
self.det_msg.setPlainText(det_msg)
self.det_msg.setVisible(False)
self.toggle_checkbox.setVisible(False)
if show_copy_button:
self.ctc_button = self.bb.addButton(_('&Copy to clipboard'),
self.bb.ActionRole)
self.ctc_button.clicked.connect(self.copy_to_clipboard)
self.show_det_msg = _('Show &details')
self.hide_det_msg = _('Hide &details')
self.det_msg_toggle = self.bb.addButton(self.show_det_msg, self.bb.ActionRole)
self.det_msg_toggle.clicked.connect(self.toggle_det_msg)
self.det_msg_toggle.setToolTip(_('Show detailed information'))
self.copy_action = QAction(self)
self.addAction(self.copy_action)
self.copy_action.setShortcuts(QKeySequence.Copy)
self.copy_action.triggered.connect(self.copy_to_clipboard)
self.is_question = type_ == self.QUESTION
if self.is_question:
self.bb.setStandardButtons(self.bb.Yes | self.bb.No)
self.bb.button(self.bb.Yes if default_yes else self.bb.No
).setDefault(True)
self.default_yes = default_yes
else:
self.bb.button(self.bb.Ok).setDefault(True)
if not det_msg:
self.det_msg_toggle.setVisible(False)
self.do_resize()
def toggle_det_msg(self, *args):
vis = unicode(self.det_msg_toggle.text()) == self.hide_det_msg
self.det_msg_toggle.setText(self.show_det_msg if vis else
self.hide_det_msg)
self.det_msg.setVisible(not vis)
self.do_resize()
def do_resize(self):
sz = self.sizeHint() + QSize(100, 0)
sz.setWidth(min(500, sz.width()))
sz.setHeight(min(500, sz.height()))
self.resize(sz)
def copy_to_clipboard(self, *args):
QApplication.clipboard().setText(
'calibre, version %s\n%s: %s\n\n%s' %
(__version__, unicode(self.windowTitle()),
unicode(self.msg.text()),
unicode(self.det_msg.toPlainText())))
if hasattr(self, 'ctc_button'):
self.ctc_button.setText(_('Copied'))
def showEvent(self, ev):
ret = QDialog.showEvent(self, ev)
if self.is_question:
try:
self.bb.button(self.bb.Yes if self.default_yes else self.bb.No
).setFocus(Qt.OtherFocusReason)
except:
# Buttons were changed
pass
else:
self.bb.button(self.bb.Ok).setFocus(Qt.OtherFocusReason)
return ret
def set_details(self, msg):
if not msg:
msg = ''
self.det_msg.setPlainText(msg)
self.det_msg_toggle.setText(self.show_det_msg)
self.det_msg_toggle.setVisible(bool(msg))
self.det_msg.setVisible(False)
self.do_resize()
class HelpView(SizePersistedDialog):
'''
Modeless dialog for presenting HTML help content
'''
def __init__(self, parent, icon, prefs, html=None, page=None, title=''):
self.prefs = prefs
#QDialog.__init__(self, parent=parent)
super(HelpView, self).__init__(parent, 'help_dialog')
self.setWindowTitle(title)
self.setWindowIcon(icon)
self.l = QVBoxLayout(self)
self.setLayout(self.l)
self.wv = QWebView()
if html is not None:
self.wv.setHtml(html)
elif page is not None:
self.wv.load(QUrl(page))
self.wv.setMinimumHeight(100)
self.wv.setMaximumHeight(16777215)
self.wv.setMinimumWidth(400)
self.wv.setMaximumWidth(16777215)
self.wv.setGeometry(0, 0, 400, 100)
self.wv.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
self.l.addWidget(self.wv)
# Sizing
sizePolicy = QSizePolicy(QSizePolicy.Preferred, QSizePolicy.Preferred)
sizePolicy.setHorizontalStretch(0)
sizePolicy.setVerticalStretch(0)
sizePolicy.setHeightForWidth(self.sizePolicy().hasHeightForWidth())
self.setSizePolicy(sizePolicy)
self.resize_dialog()
class ProgressBar(QDialog):
def __init__(self, parent=None, max_items=100, window_title=_('Progress Bar'),
label=_('Label goes here'), on_top=False):
if on_top:
QDialog.__init__(self, parent=parent, flags=Qt.WindowStaysOnTopHint)
else:
QDialog.__init__(self, parent=parent)
self.application = Application
self.setWindowTitle(window_title)
self.l = QVBoxLayout(self)
self.setLayout(self.l)
self.label = QLabel(label)
self.label.setAlignment(Qt.AlignHCenter)
self.l.addWidget(self.label)
self.progressBar = QProgressBar(self)
self.progressBar.setRange(0, max_items)
self.progressBar.setValue(0)
self.l.addWidget(self.progressBar)
def increment(self):
self.progressBar.setValue(self.progressBar.value() + 1)
self.refresh()
def refresh(self):
self.application.processEvents()
def set_label(self, value):
self.label.setText(value)
self.refresh()
def set_maximum(self, value):
self.progressBar.setMaximum(value)
self.refresh()
def set_value(self, value):
self.progressBar.setValue(value)
self.refresh()
''' Threads '''
class IndexLibrary(QThread):
'''
Build two indexes of library
{uuid: {'title':..., 'author':...}}
{'title': {'uuid':..., 'author':...}}
'''
signal = pyqtSignal(object)
def __init__(self, parent):
QThread.__init__(self, parent)
self.cdb = parent.opts.gui.current_db
self.title_map = None
self.uuid_map = None
def run(self):
self.title_map = self.index_by_title()
self.uuid_map = self.index_by_uuid()
self.signal.emit("library_index_complete")
def index_by_title(self):
'''
By default, any search restrictions or virtual libraries are applied
calibre.db.view:search_getting_ids()
'''
"""
id = self.cdb.FIELD_MAP['id']
uuid = self.cdb.FIELD_MAP['uuid']
title = self.cdb.FIELD_MAP['title']
authors = self.cdb.FIELD_MAP['authors']
by_title = {}
for record in self.cdb.data.iterall():
by_title[record[title]] = {
'authors': record[authors].split(','),
'id': record[id],
'uuid': record[uuid],
}
return by_title
"""
by_title = {}
cids = self.cdb.search_getting_ids('', '')
for cid in cids:
title = normalize(self.cdb.title(cid, index_is_id=True))
authors = self.cdb.authors(cid, index_is_id=True)
authors = authors.split(',') if authors else []
by_title[title] = {
'authors': authors,
'id': cid,
'uuid': self.cdb.uuid(cid, index_is_id=True)
}
return by_title
def index_by_uuid(self):
'''
By default, any search restrictions or virtual libraries are applied
calibre.db.view:search_getting_ids()
'''
"""
id = self.cdb.FIELD_MAP['id']
uuid = self.cdb.FIELD_MAP['uuid']
title = self.cdb.FIELD_MAP['title']
authors = self.cdb.FIELD_MAP['authors']
by_uuid = {}
for record in self.cdb.data.iterall():
by_uuid[record[uuid]] = {
'authors': record[authors].split(','),
'id': record[id],
'title': record[title],
}
return by_uuid
"""
by_uuid = {}
cids = self.cdb.search_getting_ids('', '')
for cid in cids:
uuid = self.cdb.uuid(cid, index_is_id=True)
authors = self.cdb.authors(cid, index_is_id=True)
authors = authors.split(',') if authors else []
by_uuid[uuid] = {
'authors': authors,
'id': cid,
'title': normalize(self.cdb.title(cid, index_is_id=True)),
}
return by_uuid
''' Helper Classes '''
class CompileUI(Logger):
'''
Compile Qt Creator .ui files at runtime
'''
def __init__(self, parent, verbose=True):
self.compiled_forms = {}
self.help_file = None
self.parent = parent
self.verbose = verbose
# self.compiled_forms = self.compile_ui()
# def compile_ui(self):
# pat = re.compile(r'''(['"]):/images/([^'"]+)\1''')
#
# def sub(match):
# ans = 'I(%s%s%s)' % (match.group(1), match.group(2), match.group(1))
# return ans
#
# # >>> Entry point
# self._log_location()
#
# compiled_forms = {}
# self._find_forms()
#
# # Cribbed from gui2.__init__:build_forms()
# for form in self.forms:
# with open(form) as form_file:
# soup = BeautifulStoneSoup(form_file.read())
# property = soup.find('property', attrs={'name': 'windowTitle'})
# string = property.find('string')
# window_title = string.renderContents()
#
# compiled_form = self._form_to_compiled_form(form)
# if (not os.path.exists(compiled_form) or
# os.stat(form).st_mtime > os.stat(compiled_form).st_mtime):
#
# if not os.path.exists(compiled_form):
# self._log(' compiling %s' % form)
# else:
# self._log(' recompiling %s' % form)
# os.remove(compiled_form)
# buf = io.BytesIO()
# buf = cStringIO.StringIO()
# compileUi(form, buf)
# dat = buf.getvalue()
# dat = dat.replace('__appname__', 'calibre')
# dat = dat.replace('import images_rc', '')
# dat = re.compile(r'(?:QtGui.QApplication.translate|(?<!def )_translate)\(.+?,\s+"(.+?)(?<!\\)",.+?\)').sub(r'_("\1")', dat)
# dat = dat.replace('_("MMM yyyy")', '"MMM yyyy"')
# dat = pat.sub(sub, dat)
# with open(compiled_form, 'wb') as cf:
# cf.write(dat)
#
# compiled_forms[window_title] = compiled_form.rpartition(os.sep)[2].partition('.')[0]
# return compiled_forms
def _find_forms(self):
forms = []
for root, _, files in os.walk(self.parent.resources_path):
for name in files:
if name.endswith('.ui'):
forms.append(os.path.abspath(os.path.join(root, name)))
self.forms = forms
def _form_to_compiled_form(self, form):
compiled_form = form.rpartition('.')[0]+'_ui.py'
return compiled_form
''' Helper functions '''
def _log(msg=None):
'''
Print msg to console
'''
from calibre_plugins.annotations.config import plugin_prefs
if not plugin_prefs.get('cfg_plugin_debug_log_checkbox', False):
return
if msg:
debug_print(" %s" % str(msg))
else:
debug_print()
def _log_location(*args):
LOCATION_TEMPLATE = "{cls}:{func}({arg1}) {arg2}"
from calibre_plugins.annotations.config import plugin_prefs
if not plugin_prefs.get('cfg_plugin_debug_log_checkbox', False):
return
arg1 = arg2 = ''
if len(args) > 0:
arg1 = str(args[0])
if len(args) > 1:
arg2 = str(args[1])
debug_print(LOCATION_TEMPLATE.format(cls='common_utils',
func=sys._getframe(1).f_code.co_name,
arg1=arg1, arg2=arg2))
def existing_annotations(parent, field, return_all=False):
'''
Return count of existing annotations, or existence of any
'''
import calibre_plugins.annotations.config as cfg
annotation_map = []
if field:
db = parent.opts.gui.current_db
id = db.FIELD_MAP['id']
for i, record in enumerate(db.data.iterall()):
mi = db.get_metadata(record[id], index_is_id=True)
if field == 'Comments':
if mi.comments:
soup = BeautifulSoup(mi.comments)
else:
continue
else:
soup = BeautifulSoup(mi.get_user_metadata(field, False)['#value#'])
if soup.find('div', 'user_annotations') is not None:
annotation_map.append(mi.id)
if not return_all:
break
if return_all:
_log_location("Identified %d annotated books of %d total books" %
(len(annotation_map), len(db.data)))
return annotation_map
def get_cc_mapping(cc_name, element, default=None):
'''
Return the element mapped to cc_name in prefs
'''
from calibre_plugins.annotations.config import plugin_prefs
if element not in ['field', 'combobox']:
raise ValueError("invalid element '{0}' requested for custom column '{1}'".format(
element, cc_name))
ans = default
cc_mappings = plugin_prefs.get('cc_mappings', {})
current_library = current_library_name()
if (current_library in cc_mappings and
cc_name in cc_mappings[current_library] and
element in cc_mappings[current_library][cc_name]):
ans = cc_mappings[current_library][cc_name][element]
return ans
def get_clippings_cid(parent, title):
'''
Find or create cid for title
'''
cid = None
try:
cid = list(parent.opts.gui.current_db.data.parse('title:"%s" and tag:Clippings' % title))[0]
except:
mi = MetaInformation(title, authors = ['Various'])
mi.tags = ['Clippings']
cid = parent.opts.gui.current_db.create_book_entry(mi, cover=None,
add_duplicates=False, force_id=None)
return cid
def get_icon(icon_name):
'''
Retrieve a QIcon for the named image from the zip file if it exists,
or if not then from Calibre's image cache.
'''
if icon_name:
pixmap = get_pixmap(icon_name)
if pixmap is None:
# Look in Calibre's cache for the icon
return QIcon(I(icon_name))
else:
return QIcon(pixmap)
return QIcon()
def get_local_images_dir(subfolder=None):
'''
Returns a path to the user's local resources/images folder
If a subfolder name parameter is specified, appends this to the path
'''
images_dir = os.path.join(config_dir, 'resources/images')
if subfolder:
images_dir = os.path.join(images_dir, subfolder)
if iswindows:
images_dir = os.path.normpath(images_dir)
return images_dir
def get_pixmap(icon_name):
'''
Retrieve a QPixmap for the named image
Any icons belonging to the plugin must be prefixed with 'images/'
'''
global plugin_icon_resources, plugin_name
if not icon_name.startswith('images/'):
# We know this is definitely not an icon belonging to this plugin
pixmap = QPixmap()
pixmap.load(I(icon_name))
return pixmap
# Check to see whether the icon exists as a Calibre resource
# This will enable skinning if the user stores icons within a folder like:
# ...\AppData\Roaming\calibre\resources\images\Plugin Name\
if plugin_name:
local_images_dir = get_local_images_dir(plugin_name)
local_image_path = os.path.join(local_images_dir, icon_name.replace('images/', ''))
if os.path.exists(local_image_path):
pixmap = QPixmap()
pixmap.load(local_image_path)
return pixmap
# As we did not find an icon elsewhere, look within our zip resources
if icon_name in plugin_icon_resources:
pixmap = QPixmap()
pixmap.loadFromData(plugin_icon_resources[icon_name])
return pixmap
return None
def get_resource_files(path, folder=None):
namelist = []
with zipfile.ZipFile(path) as zf:
namelist = zf.namelist()
if folder and folder.endswith('/'):
namelist = [item for item in namelist if item.startswith(folder) and item > folder]
return namelist
def get_selected_book_mi(opts, msg=None, det_msg=None):
# Get currently selected books
rows = opts.gui.library_view.selectionModel().selectedRows()
if len(rows) == 0 or len(rows) > 1:
MessageBox(MessageBox.WARNING,
_('Select a book to receive annotations'),
msg,
det_msg=det_msg,
show_copy_button=False,
parent=opts.gui).exec_()
return None
# Get the current metadata for this book from the db
ids = list(map(opts.gui.library_view.model().id, rows))
if ids:
mi = opts.gui.current_db.get_metadata(ids[0], index_is_id=True)
return mi
else:
return None
def inventory_controls(ui, dump_controls=False):
'''
Build an inventory of stateful controls
Exclude controls listed in ui.EXCLUDED_CONTROLS
'''
controls = {'owner': ui.__class__.__name__}
control_dict = defaultdict(list)
for control_type in CONTROL_TYPES:
control_dict[control_type] = []
# Inventory existing controls
for item in ui.__dict__:
if type(ui.__dict__[item]) in CONTROL_CLASSES:
if (hasattr(ui, 'EXCLUDED_CONTROLS') and
str(ui.__dict__[item].objectName()) in ui.EXCLUDED_CONTROLS):
continue
index = CONTROL_CLASSES.index(type(ui.__dict__[item]))
control_dict[CONTROL_TYPES[index]].append(str(ui.__dict__[item].objectName()))
for control_list in CONTROL_TYPES:
if control_dict[control_list]:
controls[control_list] = control_dict[control_list]
if dump_controls:
for control_type in CONTROL_TYPES:
if control_type in controls:
print(" %s: %s" % (control_type, controls[control_type]))
return controls
def move_annotations(parent, annotation_map, old_destination_field, new_destination_field,
window_title=_("Moving annotations")):
'''
Move annotations from old_destination_field to new_destination_field
annotation_map precalculated in thread in config.py
'''
import calibre_plugins.annotations.config as cfg
_log_location("%s -> %s" % (old_destination_field, new_destination_field))
library_db = parent.opts.gui.current_db
id = library_db.FIELD_MAP['id']
# Show progress
pb = ProgressBar(parent=parent, window_title=window_title, on_top=True)
total_books = len(annotation_map)
pb.set_maximum(total_books)
pb.set_value(1)
pb.set_label('{:^100}'.format('%s for %d books' % (window_title, total_books)))
pb.show()
id_map_old_destination_field = {}
id_map_new_destination_field = {}
transient_db = 'transient'
# Prepare a new COMMENTS_DIVIDER
comments_divider = '<div class="comments_divider"><p style="text-align:center;margin:1em 0 1em 0">{0}</p></div>'.format(
cfg.plugin_prefs.get('COMMENTS_DIVIDER', '· · • · ✦ · • · ·'))
for cid in annotation_map:
mi = library_db.get_metadata(cid, index_is_id=True)
# Comments -> custom
if old_destination_field == 'Comments' and new_destination_field.startswith('#'):
if mi.comments:
old_soup = BeautifulSoup(mi.comments)
uas = old_soup.find('div', 'user_annotations')
if uas:
# Remove user_annotations from Comments
uas.extract()
# Remove comments_divider from Comments
cd = old_soup.find('div', 'comments_divider')
if cd:
cd.extract()