class CheckLibraryDialog(QDialog):
is_deletable = 1
is_fixable = 2
def __init__(self, parent, db):
QDialog.__init__(self, parent)
self.db = db
self.setWindowTitle(_('Check library -- Problems found'))
self.setWindowIcon(QIcon(I('debug.png')))
self._tl = QHBoxLayout()
self.setLayout(self._tl)
self.splitter = QSplitter(self)
self.left = QWidget(self)
self.splitter.addWidget(self.left)
self.helpw = QTextEdit(self)
self.splitter.addWidget(self.helpw)
self._tl.addWidget(self.splitter)
self._layout = QVBoxLayout()
self.left.setLayout(self._layout)
self.helpw.setReadOnly(True)
self.helpw.setText(
_('''\
<h1>Help</h1>
<p>calibre stores the list of your books and their metadata in a
database. The actual book files and covers are stored as normal
files in the calibre library folder. The database contains a list of the files
and covers belonging to each book entry. This tool checks that the
actual files in the library folder on your computer match the
information in the database.</p>
<p>The result of each type of check is shown to the left. The various
checks are:
</p>
<ul>
<li><b>Invalid titles</b>: These are files and folders appearing
in the library where books titles should, but that do not have the
correct form to be a book title.</li>
<li><b>Extra titles</b>: These are extra files in your calibre
library that appear to be correctly-formed titles, but have no corresponding
entries in the database</li>
<li><b>Invalid authors</b>: These are files appearing
in the library where only author folders should be.</li>
<li><b>Extra authors</b>: These are folders in the
calibre library that appear to be authors but that do not have entries
in the database</li>
<li><b>Missing book formats</b>: These are book formats that are in
the database but have no corresponding format file in the book's folder.
<li><b>Extra book formats</b>: These are book format files found in
the book's folder but not in the database.
<li><b>Unknown files in books</b>: These are extra files in the
folder of each book that do not correspond to a known format or cover
file.</li>
<li><b>Missing cover files</b>: These represent books that are marked
in the database as having covers but the actual cover files are
missing.</li>
<li><b>Cover files not in database</b>: These are books that have
cover files but are marked as not having covers in the database.</li>
<li><b>Folder raising exception</b>: These represent folders in the
calibre library that could not be processed/understood by this
tool.</li>
</ul>
<p>There are two kinds of automatic fixes possible: <i>Delete
marked</i> and <i>Fix marked</i>.</p>
<p><i>Delete marked</i> is used to remove extra files/folders/covers that
have no entries in the database. Check the box next to the item you want
to delete. Use with caution.</p>
<p><i>Fix marked</i> is applicable only to covers and missing formats
(the three lines marked 'fixable'). In the case of missing cover files,
checking the fixable box and pushing this button will tell calibre that
there is no cover for all of the books listed. Use this option if you
are not going to restore the covers from a backup. In the case of extra
cover files, checking the fixable box and pushing this button will tell
calibre that the cover files it found are correct for all the books
listed. Use this when you are not going to delete the file(s). In the
case of missing formats, checking the fixable box and pushing this
button will tell calibre that the formats are really gone. Use this if
you are not going to restore the formats from a backup.</p>
'''))
self.log = QTreeWidget(self)
self.log.itemChanged.connect(self.item_changed)
self.log.itemExpanded.connect(self.item_expanded_or_collapsed)
self.log.itemCollapsed.connect(self.item_expanded_or_collapsed)
self._layout.addWidget(self.log)
self.check_button = QPushButton(_('&Run the check again'))
self.check_button.setDefault(False)
self.check_button.clicked.connect(self.run_the_check)
self.copy_button = QPushButton(_('Copy &to clipboard'))
self.copy_button.setDefault(False)
self.copy_button.clicked.connect(self.copy_to_clipboard)
self.ok_button = QPushButton(_('&Done'))
self.ok_button.setDefault(True)
self.ok_button.clicked.connect(self.accept)
self.mark_delete_button = QPushButton(_('Mark &all for delete'))
self.mark_delete_button.setToolTip(_('Mark all deletable subitems'))
self.mark_delete_button.setDefault(False)
self.mark_delete_button.clicked.connect(self.mark_for_delete)
self.delete_button = QPushButton(_('Delete &marked'))
self.delete_button.setToolTip(
_('Delete marked files (checked subitems)'))
self.delete_button.setDefault(False)
self.delete_button.clicked.connect(self.delete_marked)
self.mark_fix_button = QPushButton(_('Mar&k all for fix'))
self.mark_fix_button.setToolTip(_('Mark all fixable items'))
self.mark_fix_button.setDefault(False)
self.mark_fix_button.clicked.connect(self.mark_for_fix)
self.fix_button = QPushButton(_('&Fix marked'))
self.fix_button.setDefault(False)
self.fix_button.setEnabled(False)
self.fix_button.setToolTip(
_('Fix marked sections (checked fixable items)'))
self.fix_button.clicked.connect(self.fix_items)
self.bbox = QGridLayout()
self.bbox.addWidget(self.check_button, 0, 0)
self.bbox.addWidget(self.copy_button, 0, 1)
self.bbox.addWidget(self.ok_button, 0, 2)
self.bbox.addWidget(self.mark_delete_button, 1, 0)
self.bbox.addWidget(self.delete_button, 1, 1)
self.bbox.addWidget(self.mark_fix_button, 2, 0)
self.bbox.addWidget(self.fix_button, 2, 1)
h = QHBoxLayout()
ln = QLabel(_('Names to ignore:'))
h.addWidget(ln)
self.name_ignores = QLineEdit()
self.name_ignores.setText(
db.prefs.get('check_library_ignore_names', ''))
self.name_ignores.setToolTip(
_('Enter comma-separated standard file name wildcards, such as synctoy*.dat'
))
ln.setBuddy(self.name_ignores)
h.addWidget(self.name_ignores)
le = QLabel(_('Extensions to ignore:'))
h.addWidget(le)
self.ext_ignores = QLineEdit()
self.ext_ignores.setText(
db.prefs.get('check_library_ignore_extensions', ''))
self.ext_ignores.setToolTip(
_('Enter comma-separated extensions without a leading dot. Used only in book folders'
))
le.setBuddy(self.ext_ignores)
h.addWidget(self.ext_ignores)
self._layout.addLayout(h)
self._layout.addLayout(self.bbox)
self.resize(950, 500)
def do_exec(self):
self.run_the_check()
probs = 0
for c in self.problem_count:
probs += self.problem_count[c]
if probs == 0:
return False
self.exec_()
return True
def accept(self):
self.db.new_api.set_pref('check_library_ignore_extensions',
unicode_type(self.ext_ignores.text()))
self.db.new_api.set_pref('check_library_ignore_names',
unicode_type(self.name_ignores.text()))
QDialog.accept(self)
def box_to_list(self, txt):
return [f.strip() for f in txt.split(',') if f.strip()]
def run_the_check(self):
checker = CheckLibrary(self.db.library_path, self.db)
checker.scan_library(
self.box_to_list(unicode_type(self.name_ignores.text())),
self.box_to_list(unicode_type(self.ext_ignores.text())))
plaintext = []
def builder(tree, checker, check):
attr, h, checkable, fixable = check
list_ = getattr(checker, attr, None)
if list_ is None:
self.problem_count[attr] = 0
return
else:
self.problem_count[attr] = len(list_)
tl = Item()
tl.setText(0, h)
if fixable and list:
tl.setData(1, Qt.UserRole, self.is_fixable)
tl.setText(1, _('(fixable)'))
tl.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
tl.setCheckState(1, False)
else:
tl.setData(1, Qt.UserRole, self.is_deletable)
tl.setData(2, Qt.UserRole, self.is_deletable)
tl.setText(1, _('(deletable)'))
tl.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
tl.setCheckState(1, False)
if attr == 'extra_covers':
tl.setData(2, Qt.UserRole, self.is_deletable)
tl.setText(2, _('(deletable)'))
tl.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
tl.setCheckState(2, False)
self.top_level_items[attr] = tl
for problem in list_:
it = Item()
if checkable:
it.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
it.setCheckState(2, False)
it.setData(2, Qt.UserRole, self.is_deletable)
else:
it.setFlags(Qt.ItemIsEnabled)
it.setText(0, problem[0])
it.setData(0, Qt.UserRole, problem[2])
it.setText(2, problem[1])
tl.addChild(it)
self.all_items.append(it)
plaintext.append(','.join([h, problem[0], problem[1]]))
tree.addTopLevelItem(tl)
t = self.log
t.clear()
t.setColumnCount(3)
t.setHeaderLabels([_('Name'), '', _('Path from library')])
self.all_items = []
self.top_level_items = {}
self.problem_count = {}
for check in CHECKS:
builder(t, checker, check)
t.resizeColumnToContents(0)
t.resizeColumnToContents(1)
self.delete_button.setEnabled(False)
self.fix_button.setEnabled(False)
self.text_results = '\n'.join(plaintext)
def item_expanded_or_collapsed(self, item):
self.log.resizeColumnToContents(0)
self.log.resizeColumnToContents(1)
def item_changed(self, item, column):
def set_delete_boxes(node, col, to_what):
self.log.blockSignals(True)
if col:
node.setCheckState(col, to_what)
for i in range(0, node.childCount()):
node.child(i).setCheckState(2, to_what)
self.log.blockSignals(False)
def is_child_delete_checked(node):
checked = False
all_checked = True
for i in range(0, node.childCount()):
c = node.child(i).checkState(2)
checked = checked or c == Qt.Checked
all_checked = all_checked and c == Qt.Checked
return (checked, all_checked)
def any_child_delete_checked():
for parent in self.top_level_items.values():
(c, _) = is_child_delete_checked(parent)
if c:
return True
return False
def any_fix_checked():
for parent in self.top_level_items.values():
if (parent.data(1, Qt.UserRole) == self.is_fixable
and parent.checkState(1) == Qt.Checked):
return True
return False
if item in self.top_level_items.values():
if item.childCount() > 0:
if item.data(1,
Qt.UserRole) == self.is_fixable and column == 1:
if item.data(2, Qt.UserRole) == self.is_deletable:
set_delete_boxes(item, 2, False)
else:
set_delete_boxes(item, column, item.checkState(column))
if column == 2:
self.log.blockSignals(True)
item.setCheckState(1, False)
self.log.blockSignals(False)
else:
item.setCheckState(column, Qt.Unchecked)
else:
for parent in self.top_level_items.values():
if parent.data(2, Qt.UserRole) == self.is_deletable:
(child_chkd, all_chkd) = is_child_delete_checked(parent)
if all_chkd and child_chkd:
check_state = Qt.Checked
elif child_chkd:
check_state = Qt.PartiallyChecked
else:
check_state = Qt.Unchecked
self.log.blockSignals(True)
if parent.data(1, Qt.UserRole) == self.is_fixable:
parent.setCheckState(2, check_state)
else:
parent.setCheckState(1, check_state)
if child_chkd and parent.data(
1, Qt.UserRole) == self.is_fixable:
parent.setCheckState(1, Qt.Unchecked)
self.log.blockSignals(False)
self.delete_button.setEnabled(any_child_delete_checked())
self.fix_button.setEnabled(any_fix_checked())
def mark_for_fix(self):
for it in self.top_level_items.values():
if (it.flags() & Qt.ItemIsUserCheckable
and it.data(1, Qt.UserRole) == self.is_fixable
and it.childCount() > 0):
it.setCheckState(1, Qt.Checked)
def mark_for_delete(self):
for it in self.all_items:
if (it.flags() & Qt.ItemIsUserCheckable
and it.data(2, Qt.UserRole) == self.is_deletable):
it.setCheckState(2, Qt.Checked)
def delete_marked(self):
if not confirm(
'<p>' + _('The marked files and folders will be '
'<b>permanently deleted</b>. Are you sure?') +
'</p>', 'check_library_editor_delete', self):
return
# Sort the paths in reverse length order so that we can be sure that
# if an item is in another item, the sub-item will be deleted first.
items = sorted(self.all_items,
key=lambda x: len(x.text(1)),
reverse=True)
for it in items:
if it.checkState(2) == Qt.Checked:
try:
p = os.path.join(self.db.library_path,
unicode_type(it.text(2)))
if os.path.isdir(p):
delete_tree(p)
else:
delete_file(p)
except:
prints(
'failed to delete',
os.path.join(self.db.library_path,
unicode_type(it.text(2))))
self.run_the_check()
def fix_missing_formats(self):
tl = self.top_level_items['missing_formats']
child_count = tl.childCount()
for i in range(0, child_count):
item = tl.child(i)
id = int(item.data(0, Qt.UserRole))
all = self.db.formats(id, index_is_id=True, verify_formats=False)
all = {f.strip() for f in all.split(',')} if all else set()
valid = self.db.formats(id, index_is_id=True, verify_formats=True)
valid = {f.strip() for f in valid.split(',')} if valid else set()
for fmt in all - valid:
self.db.remove_format(id, fmt, index_is_id=True, db_only=True)
def fix_missing_covers(self):
tl = self.top_level_items['missing_covers']
child_count = tl.childCount()
for i in range(0, child_count):
item = tl.child(i)
id = int(item.data(0, Qt.UserRole))
self.db.set_has_cover(id, False)
def fix_extra_covers(self):
tl = self.top_level_items['extra_covers']
child_count = tl.childCount()
for i in range(0, child_count):
item = tl.child(i)
id = int(item.data(0, Qt.UserRole))
self.db.set_has_cover(id, True)
def fix_items(self):
for check in CHECKS:
attr = check[0]
fixable = check[3]
tl = self.top_level_items[attr]
if fixable and tl.checkState(1):
func = getattr(self, 'fix_' + attr, None)
if func is not None and callable(func):
func()
self.run_the_check()
def copy_to_clipboard(self):
QApplication.clipboard().setText(self.text_results)
class ConfigWidget(QWidget):
def __init__(self, plugin_action):
QWidget.__init__(self)
self.plugin_action = plugin_action
self.gui = plugin_action.gui
self._initialise_layout()
self.blank_icon = QIcon(I('blank.png'))
fav_menus = plugin_prefs[STORE_MENUS]
# Rebuild this into a map for comparison purposes
lookup_menu_map = self._build_lookup_menu_map(fav_menus)
self._populate_actions_tree(lookup_menu_map)
self.items_list.populate_list(fav_menus)
# Hook up our events
self.tv.itemChanged.connect(self._tree_item_changed)
self.items_list.currentRowChanged.connect(self._update_button_states)
self._update_button_states()
def _initialise_layout(self):
layout = QHBoxLayout(self)
self.setLayout(layout)
self.tv = QTreeWidget(self.gui)
self.tv.setIconSize(QSize(ICON_SIZE, ICON_SIZE))
self.tv.header().hide()
layout.addWidget(self.tv, 1)
self.items_list = FavMenusListWidget(self.gui)
self.items_list.setIconSize(QSize(ICON_SIZE, ICON_SIZE))
layout.addWidget(self.items_list, 1)
button_layout = QVBoxLayout()
layout.addLayout(button_layout)
self.up_btn = QToolButton(self.gui)
self.up_btn.setIcon(get_icon('arrow-up.png'))
self.up_btn.setToolTip('Move the selected menu item up')
self.up_btn.clicked.connect(self._move_item_up)
self.down_btn = QToolButton(self.gui)
self.down_btn.setIcon(get_icon('arrow-down.png'))
self.down_btn.setToolTip('Move the selected menu item down')
self.down_btn.clicked.connect(self._move_item_down)
self.remove_btn = QToolButton(self.gui)
self.remove_btn.setIcon(get_icon('trash.png'))
self.remove_btn.setToolTip('Remove the selected item from the menu')
self.remove_btn.clicked.connect(self._remove_item)
self.sep_btn = QToolButton(self.gui)
self.sep_btn.setIcon(get_icon('plus.png'))
self.sep_btn.setToolTip('Add a separator to the menu following the selected item')
self.sep_btn.clicked.connect(self._add_separator)
self.rename_btn = QToolButton(self.gui)
self.rename_btn.setIcon(get_icon('edit-undo.png'))
self.rename_btn.setToolTip('Rename the menu item for when it appears on your Favourites menu')
self.rename_btn.clicked.connect(self._rename_item)
button_layout.addWidget(self.up_btn)
button_layout.addStretch(1)
button_layout.addWidget(self.rename_btn)
button_layout.addStretch(1)
button_layout.addWidget(self.sep_btn)
button_layout.addStretch(1)
button_layout.addWidget(self.remove_btn)
button_layout.addStretch(1)
button_layout.addWidget(self.down_btn)
def _move_item_up(self):
idx = self.items_list.currentRow()
if idx > 0:
self.items_list.swap_list_widgets(idx-1)
self.items_list.setCurrentRow(idx-1)
self._update_button_states()
def _move_item_down(self):
idx = self.items_list.currentRow()
if idx < self.items_list.count() - 1:
self.items_list.swap_list_widgets(idx)
self.items_list.setCurrentRow(idx+1)
self._update_button_states()
def _add_separator(self):
idx = self.items_list.currentRow()
self.items_list.populate_list_item(None, idx)
self.items_list.setCurrentRow(idx+1)
def _remove_item(self):
def find_child(twi, paths):
for i in range(0, twi.childCount()):
c = twi.child(i)
text = unicode(c.text(0))
if text == paths[0]:
if len(paths) == 1:
return c
else:
return find_child(c, paths[1:])
idx = self.items_list.currentRow()
if idx < 0:
return
item = self.items_list.currentItem()
data = convert_qvariant(item.data(Qt.UserRole))
if data is not None:
# Not removing a separator
fav_menu = data[0]
# Lookup the item to uncheck it.
self.tv.blockSignals(True)
paths = fav_menu['path']
plugin = paths[0]
# Find the top-level item for the plugin
tree_item = None
if plugin in self.top_level_items_map:
tree_item = self.top_level_items_map[plugin]
if len(paths) > 1:
tree_item = find_child(tree_item, paths[1:])
if tree_item is not None:
tree_item.setCheckState(0, Qt.Unchecked)
self.tv.blockSignals(False)
self.items_list.takeItem(idx)
self._update_button_states()
def _rename_item(self):
idx = self.items_list.currentRow()
if idx < 0:
return
item = self.items_list.currentItem()
data = convert_qvariant(item.data(Qt.UserRole))
if data is not None:
self.items_list.editItem(item)
def _update_button_states(self):
idx = self.items_list.currentRow()
self.up_btn.setEnabled(idx > 0)
self.down_btn.setEnabled(idx < self.items_list.count() - 1)
self.remove_btn.setEnabled(self.items_list.count() > 0)
self.sep_btn.setEnabled(self.items_list.count() > 0)
data = None
if idx >= 0:
item = self.items_list.currentItem()
data = convert_qvariant(item.data(Qt.UserRole))
self.rename_btn.setEnabled(data is not None)
def _build_lookup_menu_map(self, fav_menus):
m = {}
for fav_menu in fav_menus:
if fav_menu is None:
continue
path = fav_menu['path']
plugin = path[0]
if plugin not in m:
m[plugin] = []
fav_menu['paths_text'] = '|'.join(path[1:])
m[plugin].append(fav_menu)
return m
def _get_scaled_icon(self, icon):
if icon.isNull():
return self.blank_icon
# We need the icon scaled to 16x16
src = icon.pixmap(ICON_SIZE, ICON_SIZE)
if src.width() == ICON_SIZE and src.height() == ICON_SIZE:
return icon
# Need a new version of the icon
pm = QPixmap(ICON_SIZE, ICON_SIZE)
pm.fill(Qt.transparent)
p = QPainter(pm)
p.drawPixmap(QPoint((ICON_SIZE - src.width()) / 2, (ICON_SIZE - src.height()) / 2), src)
p.end()
return QIcon(pm)
def _populate_actions_tree(self, lookup_menu_map):
# Lets re-sort the keys so that items will appear on screen sorted
# by their display name (not by their key)
skeys_map = {}
for plugin_name, iaction in six.iteritems(self.gui.iactions):
if plugin_name == self.plugin_action.name:
continue
if 'toolbar' in iaction.dont_add_to and 'toolbar-device' in iaction.dont_add_to:
print(('Not adding:', plugin_name))
continue
display_name = unicode(iaction.qaction.text())
if plugin_name == 'Choose Library':
display_name = 'Library'
skeys_map[display_name] = (plugin_name, iaction.qaction)
# Add a special case item for the location manager
skeys_map['Location Manager'] = ('Location Manager', None)
self.top_level_items_map = {}
for display_name in sorted(skeys_map.keys()):
plugin_name, qaction = skeys_map[display_name]
possible_menus = lookup_menu_map.get(plugin_name, [])
# Create a node for our top level plugin name
tl = Item()
tl.setText(0, display_name)
tl.setData(0, Qt.UserRole, plugin_name)
if plugin_name == 'Location Manager':
# Special case handling
tl.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
tl.setCheckState(0, Qt.PartiallyChecked)
tl.setIcon(0, self._get_scaled_icon(get_icon('reader.png')))
# Put all actions except library within this node.
actions = self.gui.location_manager.all_actions[1:]
self._populate_action_children(actions, tl, possible_menus, [], plugin_name,
is_location_mgr_child=True)
else:
# Normal top-level checkable plugin iaction handling
tl.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
tl.setCheckState(0, Qt.Unchecked)
tl.setIcon(0, self._get_scaled_icon(qaction.icon()))
# Lookup to see if we have a menu item for this top-level plugin
if possible_menus:
fav_menu = self._is_in_menu(possible_menus)
if fav_menu is not None:
fav_menu['icon'] = tl.icon(0)
tl.setCheckState(0, Qt.Checked)
m = qaction.menu()
if m:
# Iterate through all the children of this node
self._populate_action_children(QMenu.actions(m), tl,
possible_menus, [], plugin_name)
self.tv.addTopLevelItem(tl)
self.top_level_items_map[plugin_name] = tl
def _populate_action_children(self, children, parent, possible_menus, paths,
plugin_name, is_location_mgr_child=False):
for ac in children:
if ac.isSeparator():
continue
if not ac.isVisible() and not is_location_mgr_child:
# That is special case of location mgr visibility, since it has child
# actions that will not be visible if device not plugged in at the
# moment but we want to always be able to configure them.
continue
text = get_safe_title(ac)
it = Item(parent)
it.setText(0, text)
it.setFlags(Qt.ItemIsEnabled | Qt.ItemIsUserCheckable)
it.setCheckState(0, Qt.Unchecked)
it.setIcon(0, self._get_scaled_icon(ac.icon()))
new_paths = list(paths)
new_paths.append(text)
if possible_menus:
fav_menu = self._is_in_menu(possible_menus, new_paths)
if fav_menu is not None:
fav_menu['icon'] = it.icon(0)
it.setCheckState(0, Qt.Checked)
if ac.menu():
self._populate_action_children(QMenu.actions(ac.menu()), it,
possible_menus, new_paths, plugin_name)
def _is_in_menu(self, possible_menus, paths=[]):
path_text = '|'.join(paths)
for x in range(0, len(possible_menus)):
fav_menu = possible_menus[x]
if fav_menu['paths_text'] == path_text:
del possible_menus[x]
return fav_menu
return None
def _tree_item_changed(self, item, column):
# Checkstate has been changed - are we adding or removing this item?
if unicode(item.text(column)) == 'Location Manager':
# Special case of not allowing this since it is not a "real" plugin,
# just a special placeholder used for configuring menus that resolves
# down to a collection of underlying actions.
self.tv.blockSignals(True)
item.setCheckState(column, Qt.PartiallyChecked)
self.tv.blockSignals(False)
return
is_checked = item.checkState(column) == Qt.Checked
paths = []
fav_menu = {'icon': item.icon(column),
'display': unicode(item.text(column)),
'path': paths}
while True:
parent = item.parent()
if parent is None:
paths.insert(0, convert_qvariant(item.data(column, Qt.UserRole)))
break
else:
paths.insert(0, unicode(item.text(column)))
item = parent
if is_checked:
# We want to add this item to the list
self.items_list.populate_list_item(fav_menu)
self.items_list.setCurrentRow(self.items_list.count() -1)
else:
# We want to remove the matching item from the list
self.items_list.remove_matching_item(fav_menu)
self._update_button_states()
def save_settings(self):
plugin_prefs[STORE_MENUS] = self.items_list.get_fav_menus()