-
Notifications
You must be signed in to change notification settings - Fork 2
/
config.py
179 lines (146 loc) · 6.82 KB
/
config.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
from __future__ import unicode_literals, division, absolute_import, print_function
__license__ = 'GPL v3'
__copyright__ = '2011, Grant Drake'
import copy
try:
from qt.core import QWidget, QVBoxLayout, QPushButton
except ImportError:
from PyQt5.Qt import QWidget, QVBoxLayout, QPushButton
from calibre.gui2 import dynamic, info_dialog
from calibre.utils.config import JSONConfig
from calibre_plugins.find_duplicates.common_dialogs import KeyboardConfigDialog, PrefsViewerDialog
try:
load_translations()
except NameError:
pass
PREFS_NAMESPACE = 'FindDuplicatesPlugin'
PREFS_KEY_SETTINGS = 'settings'
KEY_LAST_LIBRARY_COMPARE = 'lastLibraryCompare'
KEY_BOOK_EXEMPTIONS = 'bookExemptions'
KEY_AUTHOR_EXEMPTIONS = 'authorExemptions'
KEY_SCHEMA_VERSION = 'SchemaVersion'
DEFAULT_SCHEMA_VERSION = 1.7
KEY_SEARCH_TYPE = 'searchType'
KEY_IDENTIFIER_TYPE = 'identifierType'
KEY_TITLE_MATCH = 'titleMatch'
KEY_AUTHOR_MATCH = 'authorMatch'
KEY_SHOW_ALL_GROUPS = 'showAllGroups'
KEY_SORT_GROUPS_TITLE = 'sortGroupsByTitle'
KEY_SHOW_TAG_AUTHOR = 'showTagAuthor'
KEY_TITLE_SOUNDEX = 'titleSoundexLength'
KEY_AUTHOR_SOUNDEX = 'authorSoundexLength'
KEY_PUBLISHER_SOUNDEX = 'publisherSoundexLength'
KEY_SERIES_SOUNDEX = 'seriesSoundexLength'
KEY_TAGS_SOUNDEX = 'tagsSoundexLength'
KEY_INCLUDE_LANGUAGES = 'includeLanguages'
KEY_DISPLAY_LIBRARY_RESULTS = 'displayLibraryResults'
KEY_AUTO_DELETE_BINARY_DUPS = 'autoDeleteBinaryDups'
KEY_SHOW_VARIATION_BOOKS = 'showVariationBooks'
DEFAULT_LIBRARIES_VALUES = {}
DEFAULT_LIBRARY_VALUES = {
KEY_LAST_LIBRARY_COMPARE: '',
KEY_BOOK_EXEMPTIONS: [],
KEY_AUTHOR_EXEMPTIONS: [],
KEY_SCHEMA_VERSION: DEFAULT_SCHEMA_VERSION
}
# This is where all preferences for this plugin will be stored
plugin_prefs = JSONConfig('plugins/Find Duplicates')
def migrate_library_config_if_required(db, library_config):
schema_version = library_config.get(KEY_SCHEMA_VERSION, 0)
if schema_version == DEFAULT_SCHEMA_VERSION:
return
# We have changes to be made - mark schema as updated
library_config[KEY_SCHEMA_VERSION] = DEFAULT_SCHEMA_VERSION
# Any migration code in future will exist in here.
#if schema_version < 1.x:
set_library_config(db, library_config)
def get_library_config(db):
library_id = db.library_id
library_config = {}
# Check whether this is a view needing to be migrated from json into database
if 'libraries' in plugin_prefs:
libraries = plugin_prefs['libraries']
if library_id in libraries:
# We will migrate this below
library_config = libraries[library_id]
# Cleanup from json file so we don't ever do this again
del libraries[library_id]
if len(libraries) == 0:
# We have migrated the last library for this user
del plugin_prefs['libraries']
else:
plugin_prefs['libraries'] = libraries
if not library_config:
library_config = db.prefs.get_namespaced(PREFS_NAMESPACE, PREFS_KEY_SETTINGS,
copy.deepcopy(DEFAULT_LIBRARY_VALUES))
migrate_library_config_if_required(db, library_config)
return library_config
def set_library_config(db, library_config):
db.prefs.set_namespaced(PREFS_NAMESPACE, PREFS_KEY_SETTINGS, library_config)
def get_exemption_lists(db):
# When migrating from v1.0 or earlier to v1.1, exemptions have changed
# Too problematic to actually migrate the data, so just discard previous maps
library_config = get_library_config(db)
if 'bookNotDuplicates' in library_config:
del library_config['bookNotDuplicates']
set_exemption_list(db, KEY_BOOK_EXEMPTIONS, [])
if 'authorNotDuplicates' in library_config:
del library_config['authorNotDuplicates']
set_exemption_list(db, KEY_AUTHOR_EXEMPTIONS, [])
book_exemptions = library_config.get(KEY_BOOK_EXEMPTIONS, [])
is_changed = False
for idx in range(0, len(book_exemptions)):
old_list = book_exemptions[idx]
new_list = [book_id for book_id in old_list if db.data.has_id(book_id)]
if len(old_list) != len(new_list):
book_exemptions[idx] = new_list
is_changed = True
if is_changed:
book_exemptions = [l for l in book_exemptions if len(l) > 0]
set_exemption_list(db, KEY_BOOK_EXEMPTIONS, book_exemptions)
author_exemptions = library_config.get(KEY_AUTHOR_EXEMPTIONS, [])
return book_exemptions, author_exemptions
def set_exemption_list(db, config_key, exemptions_list):
library_config = get_library_config(db)
library_config[config_key] = exemptions_list
set_library_config(db, library_config)
class ConfigWidget(QWidget):
def __init__(self, plugin_action):
QWidget.__init__(self)
self.plugin_action = plugin_action
layout = QVBoxLayout(self)
self.setLayout(layout)
keyboard_shortcuts_button = QPushButton(_('Keyboard shortcuts')+'...', self)
keyboard_shortcuts_button.setToolTip(
_('Edit the keyboard shortcuts associated with this plugin'))
keyboard_shortcuts_button.clicked.connect(self.edit_shortcuts)
layout.addWidget(keyboard_shortcuts_button)
reset_confirmation_button = QPushButton(_('Reset &confirmation dialogs'), self)
reset_confirmation_button.setToolTip(_(
'Reset all show me again dialogs for the Find Duplicates plugin'))
reset_confirmation_button.clicked.connect(self.reset_dialogs)
layout.addWidget(reset_confirmation_button)
view_prefs_button = QPushButton(_('&View library preferences')+'...', self)
view_prefs_button.setToolTip(_(
'View data stored in the library database for this plugin'))
view_prefs_button.clicked.connect(self.view_prefs)
layout.addWidget(view_prefs_button)
layout.addStretch(1)
def save_settings(self):
# Delete the legacy keyboard setting options as no longer required
if 'options' in plugin_prefs:
del plugin_prefs['options']
def reset_dialogs(self):
for key in list(dynamic.keys()):
if key.startswith('find_duplicates_') and key.endswith('_again') \
and dynamic[key] is False:
dynamic[key] = True
info_dialog(self, _('Done'),
_('Confirmation dialogs have all been reset'), show=True)
def edit_shortcuts(self):
d = KeyboardConfigDialog(self.plugin_action.gui, self.plugin_action.action_spec[0])
if d.exec_() == d.Accepted:
self.plugin_action.gui.keyboard.finalize()
def view_prefs(self):
d = PrefsViewerDialog(self.plugin_action.gui, PREFS_NAMESPACE)
d.exec_()