Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-12-27 07:10:19 -05:00
Code Issues Packages Projects Releases Wiki Activity
calibre/src/calibre/gui2/__init__.py

1800 lines
67 KiB
Python
Raw Blame History

__license__ = 'GPL v3'
__copyright__ = '2008, Kovid Goyal <kovid at kovidgoyal.net>'
""" The GUI """
import glob
import os
import signal
import sys
import threading
from contextlib import contextmanager, suppress
from functools import lru_cache
from threading import Lock, RLock
from qt.core import (
QApplication,
QBuffer,
QByteArray,
QColor,
QDateTime,
QDesktopServices,
QDialog,
QDialogButtonBox,
QEvent,
QFile,
QFileDialog,
QFileIconProvider,
QFileInfo,
QFont,
QFontDatabase,
QFontInfo,
QFontMetrics,
QGuiApplication,
QIcon,
QImageReader,
QImageWriter,
QIODevice,
QLocale,
QNetworkProxyFactory,
QObject,
QPainterPath,
QPalette,
QRectF,
QResource,
QSettings,
QSocketNotifier,
QStringListModel,
Qt,
QThread,
QTimer,
QTranslator,
QUrl,
QWidget,
pyqtSignal,
pyqtSlot,
)
import calibre.gui2.pyqt6_compat as pqc
from calibre import as_unicode, prints
from calibre.constants import (
DEBUG,
__version__,
builtin_colors_dark,
builtin_colors_light,
config_dir,
is_running_from_develop,
isbsd,
isfrozen,
islinux,
ismacos,
iswindows,
isxp,
numeric_version,
plugins_loc,
)
from calibre.constants import __appname__ as APP_UID
from calibre.ebooks.metadata import MetaInformation
from calibre.gui2.geometry import geometry_for_restore_as_dict
from calibre.gui2.linux_file_dialogs import check_for_linux_native_dialogs, linux_native_dialog
from calibre.gui2.palette import PaletteManager
from calibre.gui2.qt_file_dialogs import FileDialog
from calibre.ptempfile import base_dir
from calibre.utils.config import Config, ConfigProxy, JSONConfig, dynamic
from calibre.utils.config_base import tweaks
from calibre.utils.date import UNDEFINED_DATE
from calibre.utils.file_type_icons import EXT_MAP
from calibre.utils.img import set_image_allocation_limit
from calibre.utils.localization import get_lang
from calibre.utils.resources import get_image_path as I
from calibre.utils.resources import get_path as P
from calibre.utils.resources import user_dir
from polyglot import queue
from polyglot.builtins import iteritems, string_or_bytes
del pqc, geometry_for_restore_as_dict
NO_URL_FORMATTING = QUrl.UrlFormattingOption.None_
BOOK_DETAILS_DISPLAY_DEBOUNCE_DELAY = 100 # 100 ms is threshold for human visual response
class IconResourceManager:
def __init__(self):
self.override_icon_path = None
self.initialized = False
self.dark_theme_name = self.default_dark_theme_name = 'calibre-default-dark'
self.light_theme_name = self.default_light_theme_name = 'calibre-default-light'
self.user_any_theme_name = self.user_dark_theme_name = self.user_light_theme_name = None
self.registered_user_resource_files = ()
self.color_palette = 'light'
self.icon_cache = {}
def user_theme_resource_file(self, which):
return os.path.join(config_dir, f'icons-{which}.rcc')
def remove_user_theme(self, which):
path = self.user_theme_resource_file(which)
if path in self.registered_user_resource_files:
QResource.unregisterResource(path)
self.registered_user_resource_files = tuple(x for x in self.registered_user_resource_files if x != path)
with suppress(FileNotFoundError):
os.remove(path)
def register_user_resource_files(self):
self.user_icon_theme_metadata.cache_clear()
for x in self.registered_user_resource_files:
QResource.unregisterResource(x)
r = []
self.user_any_theme_name = self.user_dark_theme_name = self.user_light_theme_name = None
for x in ('any', 'light', 'dark'):
path = self.user_theme_resource_file(x)
if os.path.exists(path):
QResource.registerResource(path)
r.append(path)
setattr(self, f'user_{x}_theme_name', f'calibre-user-{x}')
self.registered_user_resource_files = tuple(r)
any_dark = (self.user_any_theme_name + '-dark') if self.user_any_theme_name else ''
any_light = (self.user_any_theme_name + '-light') if self.user_any_theme_name else ''
self.dark_theme_name = self.user_dark_theme_name or any_dark or self.default_dark_theme_name
self.light_theme_name = self.user_light_theme_name or any_light or self.default_light_theme_name
@lru_cache(maxsize=4)
def user_icon_theme_metadata(self, which):
path = self.user_theme_resource_file(which)
if path not in self.registered_user_resource_files:
return {}
f = QFile(f':/icons/calibre-user-{which}/metadata.json')
if not f.open(QIODevice.OpenModeFlag.ReadOnly):
return {}
try:
import json
return json.loads(bytes(f.readAll()))
finally:
f.close()
@property
def active_user_theme_metadata(self):
q = QIcon.themeName()
if q in (self.default_dark_theme_name, self.default_light_theme_name):
return {}
if q == self.user_dark_theme_name:
return self.user_icon_theme_metadata('dark')
if q == self.user_light_theme_name:
return self.user_icon_theme_metadata('light')
return self.user_icon_theme_metadata('any')
@property
def user_theme_title(self):
return self.active_user_theme_metadata.get('title', _('Default icons'))
@property
def user_theme_name(self):
return self.active_user_theme_metadata.get('name', 'default')
def initialize(self):
if self.initialized:
return
self.icon_cache = {}
self.initialized = True
QResource.registerResource(P('icons.rcc', allow_user_override=False))
QIcon.setFallbackSearchPaths([])
QIcon.setThemeSearchPaths([':/icons'])
self.override_icon_path = None
q = os.path.join(user_dir, 'images')
items = []
with suppress(Exception):
items = os.listdir(q)
if items:
self.override_icon_path = q
legacy_theme_metadata = os.path.join(q, 'icon-theme.json')
if os.path.exists(legacy_theme_metadata):
self.migrate_legacy_icon_theme(legacy_theme_metadata)
items = os.listdir(q)
self.override_items = {'': frozenset(items)}
for k in ('devices', 'mimetypes', 'plugins'):
items = frozenset()
with suppress(OSError):
items = frozenset(os.listdir(os.path.join(self.override_icon_path, k)))
self.override_items[k] = items
self.register_user_resource_files()
def migrate_legacy_icon_theme(self, legacy_theme_metadata):
import shutil
from calibre.utils.rcc import compile_icon_dir_as_themes
images = os.path.dirname(legacy_theme_metadata)
os.replace(legacy_theme_metadata, os.path.join(images, 'metadata.json'))
compile_icon_dir_as_themes(
images, self.user_theme_resource_file('any'), theme_name='calibre-user-any', inherits='calibre-default')
for x in os.listdir(images):
q = os.path.join(images, x)
if os.path.isdir(q) and q != 'textures':
shutil.rmtree(q)
else:
os.remove(q)
def overriden_icon_path(self, name):
parts = name.replace(os.sep, '/').split('/')
ans = os.path.join(self.override_icon_path, name)
if len(parts) == 1:
sq, ext = os.path.splitext(parts[0])
sq = f'{sq}-for-{self.color_palette}-theme{ext}'
if sq in self.override_items['']:
ans = os.path.join(self.override_icon_path, sq)
else:
subfolder = '/'.join(parts[:-1])
entries = self.override_items.get(subfolder)
if entries is None and self.override_icon_path:
try:
self.override_items[subfolder] = entries = frozenset(os.listdir(os.path.join(self.override_icon_path, subfolder)))
except OSError:
self.override_items[subfolder] = entries = frozenset()
if entries:
sq, ext = os.path.splitext(parts[-1])
sq = f'{sq}-for-{self.color_palette}-theme{ext}'
if sq in entries:
ans = os.path.join(self.override_icon_path, subfolder, sq)
return ans
def cached_icon(self, name=''):
'''
Keep these icons in a cache. This is intended to be used in dialogs like
manage categories where thousands of icon instances can be needed.
It is a new method to avoid breaking QIcon.ic() if names are reused
in different contexts. It isn't clear if this can ever happen.
'''
icon = self.icon_cache.get(name)
if icon is None:
icon = self.icon_cache[name] = self(name)
return icon
def __call__(self, name):
if isinstance(name, QIcon):
return name
if not name:
return QIcon()
if os.path.isabs(name):
return QIcon(name)
if self.override_icon_path:
qi = QIcon(self.overriden_icon_path(name))
if qi.is_ok():
return qi
icon_name = os.path.splitext(name.replace('\\', '__').replace('/', '__'))[0]
ans = QIcon.fromTheme(icon_name)
if not ans.is_ok():
if 'user-any' in QIcon.themeName():
q = QIcon(f':/icons/calibre-default-{self.color_palette}/images/{name}')
if q.is_ok():
ans = q
return ans
def icon_as_png(self, name, as_bytearray=False, compression_level=0):
ans = self(name)
ba = QByteArray()
if ans.availableSizes():
pmap = ans.pixmap(ans.availableSizes()[0])
buf = QBuffer(ba)
buf.open(QIODevice.OpenModeFlag.WriteOnly)
w = QImageWriter(buf, b'PNG')
cl = min(9, max(0, compression_level))
w.setQuality(10 * (9-cl))
w.setQuality(90)
w.write(pmap.toImage())
return ba if as_bytearray else ba.data()
def set_theme(self):
self.icon_cache = {}
current = QIcon.themeName()
is_dark = QApplication.instance().is_dark_theme
self.color_palette = 'dark' if is_dark else 'light'
new = self.dark_theme_name if is_dark else self.light_theme_name
if current == new and current not in (self.default_dark_theme_name, self.default_light_theme_name):
# force reload of user icons by first changing theme to default and
# then to user
QIcon.setThemeName(self.default_dark_theme_name if QApplication.instance().is_dark_theme else self.default_light_theme_name)
QIcon.setThemeName(new)
icon_resource_manager = IconResourceManager()
QIcon.ic = icon_resource_manager
QIcon.icon_as_png = icon_resource_manager.icon_as_png
QIcon.is_ok = lambda self: not self.isNull() and len(self.availableSizes()) > 0
QIcon.cached_icon = icon_resource_manager.cached_icon
# Setup gprefs {{{
gprefs = JSONConfig('gui')
native_menubar_defaults = {
'action-layout-menubar': (
'Add Books', 'Edit Metadata', 'Convert Books',
'Choose Library', 'Save To Disk', 'Preferences',
'Help',
),
'action-layout-menubar-device': (
'Add Books', 'Edit Metadata', 'Convert Books',
'Location Manager', 'Send To Device',
'Save To Disk', 'Preferences', 'Help',
)
}
def create_defs():
defs = gprefs.defaults
if ismacos:
defs['action-layout-menubar'] = native_menubar_defaults['action-layout-menubar']
defs['action-layout-menubar-device'] = native_menubar_defaults['action-layout-menubar-device']
defs['action-layout-toolbar'] = (
'Add Books', 'Edit Metadata', None, 'Convert Books', 'View', None,
'Choose Library', 'Donate', None, 'Fetch News', 'Store', 'Save To Disk',
'Connect Share', None, 'Remove Books', 'Tweak ePub'
)
defs['action-layout-toolbar-device'] = (
'Add Books', 'Edit Metadata', None, 'Convert Books', 'View',
'Send To Device', None, None, 'Location Manager', None, None,
'Fetch News', 'Store', 'Save To Disk', 'Connect Share', None,
'Remove Books',
)
else:
defs['action-layout-menubar'] = ()
defs['action-layout-menubar-device'] = ()
defs['action-layout-toolbar'] = (
'Add Books', 'Edit Metadata', None, 'Convert Books', 'View', None,
'Store', 'Donate', 'Fetch News', 'Help', None, 'Preferences',
'Remove Books', 'Choose Library', 'Save To Disk', 'Connect Share',
'Tweak ePub',
)
defs['action-layout-toolbar-device'] = (
'Add Books', 'Edit Metadata', None, 'Convert Books', 'View',
'Send To Device', None, None, 'Location Manager', None, None,
'Fetch News', 'Save To Disk', 'Store', 'Connect Share', None,
'Remove Books', None, 'Help', 'Preferences',
)
defs['action-layout-toolbar-child'] = ()
defs['action-layout-searchbar'] = ('Saved searches',)
defs['action-layout-context-menu'] = (
'Edit Metadata', 'Send To Device', 'Save To Disk',
'Connect Share', 'Copy To Library', None,
'Convert Books', 'View', 'Open Folder', 'Show Book Details',
'Similar Books', 'Tweak ePub', None, 'Remove Books',
)
defs['action-layout-context-menu-split'] = (
'Edit Metadata', 'Send To Device', 'Save To Disk',
'Connect Share', 'Copy To Library', None,
'Convert Books', 'View', 'Open Folder', 'Show Book Details',
'Similar Books', 'Tweak ePub', None, 'Remove Books',
)
defs['action-layout-context-menu-device'] = (
'View', 'Save To Disk', None, 'Remove Books', None,
'Add To Library', 'Edit Collections', 'Match Books',
'Show Matched Book In Library'
)
defs['action-layout-context-menu-cover-browser'] = (
'Edit Metadata', 'Send To Device', 'Save To Disk',
'Connect Share', 'Copy To Library', None,
'Convert Books', 'View', 'Open Folder', 'Show Book Details',
'Similar Books', 'Tweak ePub', None, 'Remove Books', None,
'Autoscroll Books'
)
defs['show_splash_screen'] = True
defs['toolbar_icon_size'] = 'medium'
defs['automerge'] = 'ignore'
defs['toolbar_text'] = 'always'
defs['font'] = None
defs['tags_browser_partition_method'] = 'first letter'
defs['tags_browser_collapse_at'] = 100
defs['tags_browser_collapse_fl_at'] = 5
defs['tag_browser_dont_collapse'] = []
defs['edit_metadata_single_layout'] = 'default'
defs['preserve_date_on_ctl'] = True
defs['manual_add_auto_convert'] = False
defs['auto_convert_same_fmt'] = False
defs['cb_fullscreen'] = False
defs['worker_max_time'] = 0
defs['show_files_after_save'] = True
defs['auto_add_path'] = None
defs['auto_add_check_for_duplicates'] = False
defs['blocked_auto_formats'] = []
defs['auto_add_auto_convert'] = True
defs['auto_add_everything'] = False
defs['ui_style'] = 'calibre' if iswindows or ismacos else 'system'
defs['color_palette'] = 'system'
defs['tag_browser_old_look'] = False
defs['tag_browser_hide_empty_categories'] = False
defs['tag_browser_always_autocollapse'] = False
defs['tag_browser_restore_tree_expansion'] = False
defs['tag_browser_allow_keyboard_focus'] = False
defs['book_list_tooltips'] = True
defs['show_layout_buttons'] = False
defs['bd_show_cover'] = True
defs['bd_overlay_cover_size'] = False
defs['tags_browser_category_icons'] = {}
defs['cover_browser_reflections'] = True
defs['book_list_extra_row_spacing'] = 0
defs['refresh_book_list_on_bulk_edit'] = True
defs['cover_grid_width'] = 0
defs['cover_grid_height'] = 0
defs['cover_grid_spacing'] = 0
defs['cover_grid_color'] = (80, 80, 80)
defs['cover_grid_cache_size_multiple'] = 5
defs['cover_grid_disk_cache_size'] = 2500
defs['cover_grid_show_title'] = False
defs['cover_grid_texture'] = None
defs['cover_corner_radius'] = 0
defs['cover_corner_radius_unit'] = 'px'
defs['show_vl_tabs'] = False
defs['vl_tabs_closable'] = True
defs['show_highlight_toggle_button'] = False
defs['add_comments_to_email'] = False
defs['cb_preserve_aspect_ratio'] = False
defs['cb_double_click_to_activate'] = False
defs['gpm_template_editor_font_size'] = 10
defs['show_emblems'] = False
defs['emblem_size'] = 32
defs['emblem_position'] = 'left'
defs['metadata_diff_mark_rejected'] = False
defs['tag_browser_show_counts'] = True
defs['tag_browser_show_tooltips'] = True
defs['row_numbers_in_book_list'] = True
defs['tag_browser_item_padding'] = 0.5
defs['paste_isbn_prefixes'] = ['isbn', 'url', 'amazon', 'google']
defs['qv_respects_vls'] = True
defs['qv_dclick_changes_column'] = True
defs['qv_retkey_changes_column'] = True
defs['qv_follows_column'] = False
defs['book_details_comments_heading_pos'] = 'hide'
defs['book_list_split'] = False
defs['wrap_toolbar_text'] = False
defs['dnd_merge'] = True
defs['booklist_grid'] = False
defs['browse_annots_restrict_to_user'] = None
defs['browse_annots_restrict_to_type'] = None
defs['browse_annots_use_stemmer'] = True
defs['browse_notes_use_stemmer'] = True
defs['fts_library_use_stemmer'] = True
defs['fts_library_restrict_books'] = False
defs['annots_export_format'] = 'txt'
defs['books_autoscroll_time'] = 2.0
defs['edit_metadata_single_use_2_cols_for_custom_fields'] = True
defs['edit_metadata_elide_labels'] = True
defs['edit_metadata_elision_point'] = "right"
defs['edit_metadata_bulk_cc_label_length'] = 25
defs['edit_metadata_single_cc_label_length'] = 12
defs['edit_metadata_templates_only_F2_on_booklist'] = False
# JSON dumps converts integer keys to strings, so do it explicitly
defs['tb_search_order'] = {'0': 1, '1': 2, '2': 3, '3': 4, '4': 0}
defs['search_tool_bar_shows_text'] = True
defs['allow_keyboard_search_in_library_views'] = True
defs['show_links_in_tag_browser'] = False
defs['show_notes_in_tag_browser'] = False
defs['icons_on_right_in_tag_browser'] = True
defs['cover_browser_narrow_view_position'] = 'automatic'
defs['dark_palette_name'] = ''
defs['light_palette_name'] = ''
defs['dark_palettes'] = {}
defs['light_palettes'] = {}
defs['saved_layouts'] = {}
def migrate_tweak(tweak_name, pref_name):
# If the tweak has been changed then leave the tweak in the file so
# that the user can bounce between versions with and without the
# migration. For versions before the migration the tweak wins. For
# versions after the migration any changes win.
v = tweaks.get(tweak_name, None)
migrated_tweak_name = pref_name + '_tweak_migrated'
m = gprefs.get(migrated_tweak_name, None)
if m is None and v is not None:
gprefs[pref_name] = v
gprefs[migrated_tweak_name] = True
migrate_tweak('metadata_edit_elide_labels', 'edit_metadata_elide_labels')
migrate_tweak('metadata_edit_elision_point', 'edit_metadata_elision_point')
migrate_tweak('metadata_edit_bulk_cc_label_length', 'edit_metadata_bulk_cc_label_length')
migrate_tweak('metadata_edit_single_cc_label_length', 'edit_metadata_single_cc_label_length')
migrate_tweak('metadata_single_use_2_cols_for_custom_fields', 'edit_metadata_single_use_2_cols_for_custom_fields')
create_defs()
del create_defs
# }}}
UNDEFINED_QDATETIME = QDateTime(
UNDEFINED_DATE.year, UNDEFINED_DATE.month, UNDEFINED_DATE.day, UNDEFINED_DATE.hour, UNDEFINED_DATE.minute, UNDEFINED_DATE.second)
QT_HIDDEN_CLEAR_ACTION = '_q_qlineeditclearaction'
ALL_COLUMNS = ['title', 'ondevice', 'authors', 'size', 'timestamp', 'rating', 'publisher',
'tags', 'series', 'pubdate']
def _config(): # {{{
c = Config('gui', 'preferences for the calibre GUI')
c.add_opt('send_to_storage_card_by_default', default=False,
help=_('Send file to storage card instead of main memory by default'))
c.add_opt('confirm_delete', default=False,
help=_('Confirm before deleting'))
c.add_opt('main_window_geometry', default=None,
help=_('Main window geometry'))
c.add_opt('new_version_notification', default=True,
help=_('Notify when a new version is available'))
c.add_opt('use_roman_numerals_for_series_number', default=True,
help=_('Use Roman numerals for series number'))
c.add_opt('sort_tags_by', default='name',
help=_('Sort tags list by name, popularity, or rating'))
c.add_opt('match_tags_type', default='any',
help=_('Match tags by any or all.'))
c.add_opt('cover_flow_queue_length', default=6,
help=_('Number of covers to show in the cover browsing mode'))
c.add_opt('LRF_conversion_defaults', default=[],
help=_('Defaults for conversion to LRF'))
c.add_opt('LRF_ebook_viewer_options', default=None,
help=_('Options for the LRF e-book viewer'))
c.add_opt('internally_viewed_formats', default=['LRF', 'EPUB', 'LIT',
'MOBI', 'PRC', 'POBI', 'AZW', 'AZW3', 'HTML', 'FB2', 'FBZ', 'PDB', 'RB',
'SNB', 'HTMLZ', 'KEPUB'], help=_(
'Formats that are viewed using the internal viewer'))
c.add_opt('column_map', default=ALL_COLUMNS,
help=_('Columns to be displayed in the book list'))
c.add_opt('autolaunch_server', default=False, help=_('Automatically launch Content server on application startup'))
c.add_opt('oldest_news', default=60, help=_('Oldest news kept in database'))
c.add_opt('systray_icon', default=False, help=_('Show system tray icon'))
c.add_opt('upload_news_to_device', default=True,
help=_('Upload downloaded news to device'))
c.add_opt('delete_news_from_library_on_upload', default=False,
help=_('Delete news books from library after uploading to device'))
c.add_opt('separate_cover_flow', default=False,
help=_('Show the cover flow in a separate window instead of in the main calibre window'))
c.add_opt('disable_tray_notification', default=False,
help=_('Disable notifications from the system tray icon'))
c.add_opt('default_send_to_device_action', default=None,
help=_('Default action to perform when the "Send to device" button is '
'clicked'))
c.add_opt('asked_library_thing_password', default=False,
help='Asked library thing password at least once.')
c.add_opt('search_as_you_type', default=False,
help=_('Start searching as you type. If this is disabled then search will '
'only take place when the Enter key is pressed.'))
c.add_opt('highlight_search_matches', default=False,
help=_('When searching, show all books with search results '
'highlighted instead of showing only the matches. You can use the '
'N or F3 keys to go to the next match.'))
c.add_opt('save_to_disk_template_history', default=[],
help='Previously used Save to disk templates')
c.add_opt('send_to_device_template_history', default=[],
help='Previously used Send to Device templates')
c.add_opt('main_search_history', default=[],
help='Search history for the main GUI')
c.add_opt('viewer_search_history', default=[],
help='Search history for the e-book viewer')
c.add_opt('viewer_toc_search_history', default=[],
help='Search history for the ToC in the e-book viewer')
c.add_opt('lrf_viewer_search_history', default=[],
help='Search history for the LRF viewer')
c.add_opt('scheduler_search_history', default=[],
help='Search history for the recipe scheduler')
c.add_opt('plugin_search_history', default=[],
help='Search history for the plugin preferences')
c.add_opt('shortcuts_search_history', default=[],
help='Search history for the keyboard preferences')
c.add_opt('jobs_search_history', default=[],
help='Search history for the tweaks preferences')
c.add_opt('tweaks_search_history', default=[],
help='Search history for tweaks')
c.add_opt('worker_limit', default=6,
help=_(
'Maximum number of simultaneous conversion/news download jobs. '
'This number is twice the actual value for historical reasons.'))
c.add_opt('get_social_metadata', default=True,
help=_('Download social metadata (tags/rating/etc.)'))
c.add_opt('overwrite_author_title_metadata', default=True,
help=_('Overwrite author and title with new metadata'))
c.add_opt('auto_download_cover', default=False,
help=_('Automatically download the cover, if available'))
c.add_opt('enforce_cpu_limit', default=True,
help=_('Limit max simultaneous jobs to number of CPUs'))
c.add_opt('gui_layout', choices=['wide', 'narrow'],
help=_('The layout of the user interface. Wide has the '
'Book details panel on the right and narrow has '
'it at the bottom.'), default='wide')
c.add_opt('show_avg_rating', default=True,
help=_('Show the average rating per item indication in the Tag browser'))
c.add_opt('disable_animations', default=False,
help=_('Disable UI animations'))
# This option is no longer used. It remains for compatibility with upgrades
# so the value can be migrated
c.add_opt('tag_browser_hidden_categories', default=set(),
help=_('Tag browser categories not to display'))
c.add_opt
return ConfigProxy(c)
config = _config()
# }}}
QSettings.setPath(QSettings.Format.IniFormat, QSettings.Scope.UserScope, config_dir)
QSettings.setPath(QSettings.Format.IniFormat, QSettings.Scope.SystemScope, config_dir)
QSettings.setDefaultFormat(QSettings.Format.IniFormat)
def default_author_link():
from calibre.ebooks.metadata.book.render import DEFAULT_AUTHOR_LINK
ans = gprefs.get('default_author_link')
if ans == 'https://en.wikipedia.org/w/index.php?search={author}':
# The old default value for this setting
ans = DEFAULT_AUTHOR_LINK
return ans or DEFAULT_AUTHOR_LINK
def available_heights():
return tuple(s.availableSize().height() for s in QGuiApplication.screens())
def available_height():
return QApplication.instance().primaryScreen().availableSize().height()
def available_width():
return QApplication.instance().primaryScreen().availableSize().width()
def max_available_height():
return max(available_heights())
def min_available_height():
return min(available_heights())
def get_screen_dpi():
s = QApplication.instance().primaryScreen()
return s.logicalDotsPerInchX(), s.logicalDotsPerInchY()
_is_widescreen = None
def is_widescreen():
global _is_widescreen
if _is_widescreen is None:
try:
_is_widescreen = available_width()/available_height() > 1.4
except:
_is_widescreen = False
return _is_widescreen
def extension(path):
return os.path.splitext(path)[1][1:].lower()
def warning_dialog(parent, title, msg, det_msg='', show=False,
show_copy_button=True):
from calibre.gui2.dialogs.message_box import MessageBox
d = MessageBox(MessageBox.WARNING, _('WARNING:'
)+ ' ' + title, msg, det_msg, parent=parent,
show_copy_button=show_copy_button)
if show:
return d.exec()
return d
def error_dialog(parent, title, msg, det_msg='', show=False,
show_copy_button=True):
from calibre.gui2.dialogs.message_box import MessageBox
d = MessageBox(MessageBox.ERROR, _('ERROR:'
) + ' ' + title, msg, det_msg, parent=parent,
show_copy_button=show_copy_button)
if show:
return d.exec()
return d
class Aborted(Exception):
pass
def question_dialog(parent, title, msg, det_msg='', show_copy_button=False,
default_yes=True,
# Skippable dialogs
# Set skip_dialog_name to a unique name for this dialog
# Set skip_dialog_msg to a message displayed to the user
skip_dialog_name=None, skip_dialog_msg=_('Show this confirmation again'),
skip_dialog_skipped_value=True, skip_dialog_skip_precheck=True,
# Override icon (QIcon to be used as the icon for this dialog or string for QIcon.ic())
override_icon=None,
# Change the text/icons of the yes and no buttons.
# The icons must be QIcon objects or strings for QIcon.ic()
yes_text=None, no_text=None, yes_icon=None, no_icon=None,
# Add an Abort button which if clicked will cause this function to raise
# the Aborted exception
add_abort_button=False,
):
from calibre.gui2.dialogs.message_box import MessageBox
prefs = gui_prefs()
if not isinstance(skip_dialog_name, str):
skip_dialog_name = None
try:
auto_skip = set(prefs.get('questions_to_auto_skip', ()))
except Exception:
auto_skip = set()
if (skip_dialog_name is not None and skip_dialog_name in auto_skip):
return bool(skip_dialog_skipped_value)
d = MessageBox(MessageBox.QUESTION, title, msg, det_msg, parent=parent,
show_copy_button=show_copy_button, default_yes=default_yes,
q_icon=override_icon, yes_text=yes_text, no_text=no_text,
yes_icon=yes_icon, no_icon=no_icon, add_abort_button=add_abort_button)
if skip_dialog_name is not None and skip_dialog_msg:
tc = d.toggle_checkbox
tc.setVisible(True)
tc.setText(skip_dialog_msg)
tc.setChecked(bool(skip_dialog_skip_precheck))
d.resize_needed.emit()
ret = d.exec() == QDialog.DialogCode.Accepted
if add_abort_button and d.aborted:
raise Aborted()
if skip_dialog_name is not None and not d.toggle_checkbox.isChecked():
auto_skip.add(skip_dialog_name)
prefs.set('questions_to_auto_skip', list(auto_skip))
return ret
def info_dialog(parent, title, msg, det_msg='', show=False,
show_copy_button=True, only_copy_details=False):
from calibre.gui2.dialogs.message_box import MessageBox
d = MessageBox(MessageBox.INFO, title, msg, det_msg, parent=parent,
show_copy_button=show_copy_button, only_copy_details=only_copy_details)
if show:
return d.exec()
return d
def show_restart_warning(msg, parent=None):
d = warning_dialog(parent, _('Restart needed'), msg,
show_copy_button=False)
b = d.bb.addButton(_('&Restart calibre now'), QDialogButtonBox.ButtonRole.AcceptRole)
b.setIcon(QIcon.ic('lt.png'))
d.do_restart = False
def rf():
d.do_restart = True
b.clicked.connect(rf)
d.set_details('')
d.exec()
b.clicked.disconnect()
return d.do_restart
class Dispatcher(QObject):
'''
Convenience class to use Qt signals with arbitrary python callables.
By default, ensures that a function call always happens in the
thread this Dispatcher was created in.
Note that if you create the Dispatcher in a thread without an event loop of
its own, the function call will happen in the GUI thread (I think).
'''
dispatch_signal = pyqtSignal(object, object)
def __init__(self, func, queued=True, parent=None):
QObject.__init__(self, parent)
self.func = func
typ = Qt.ConnectionType.QueuedConnection
if not queued:
typ = Qt.ConnectionType.AutoConnection if queued is None else Qt.ConnectionType.DirectConnection
self.dispatch_signal.connect(self.dispatch, type=typ)
def __call__(self, *args, **kwargs):
self.dispatch_signal.emit(args, kwargs)
def dispatch(self, args, kwargs):
self.func(*args, **kwargs)
class FunctionDispatcher(QObject):
'''
Convenience class to use Qt signals with arbitrary python functions.
By default, ensures that a function call always happens in the
thread this FunctionDispatcher was created in.
Note that you must create FunctionDispatcher objects in the GUI thread.
'''
dispatch_signal = pyqtSignal(object, object, object)
def __init__(self, func, queued=True, parent=None):
global gui_thread
if gui_thread is None:
gui_thread = QThread.currentThread()
if not is_gui_thread():
raise ValueError(
'You can only create a FunctionDispatcher in the GUI thread')
QObject.__init__(self, parent)
self.func = func
typ = Qt.ConnectionType.QueuedConnection
if not queued:
typ = Qt.ConnectionType.AutoConnection if queued is None else Qt.ConnectionType.DirectConnection
self.dispatch_signal.connect(self.dispatch, type=typ)
self.q = queue.Queue()
self.lock = threading.Lock()
def __call__(self, *args, **kwargs):
if is_gui_thread():
return self.func(*args, **kwargs)
with self.lock:
self.dispatch_signal.emit(self.q, args, kwargs)
res = self.q.get()
return res
def dispatch(self, q, args, kwargs):
try:
res = self.func(*args, **kwargs)
except:
res = None
q.put(res)
class GetMetadata(QObject):
'''
Convenience class to ensure that metadata readers are used only in the
GUI thread. Must be instantiated in the GUI thread.
'''
edispatch = pyqtSignal(object, object, object)
idispatch = pyqtSignal(object, object, object)
metadataf = pyqtSignal(object, object)
metadata = pyqtSignal(object, object)
def __init__(self):
QObject.__init__(self)
self.edispatch.connect(self._get_metadata, type=Qt.ConnectionType.QueuedConnection)
self.idispatch.connect(self._from_formats, type=Qt.ConnectionType.QueuedConnection)
def __call__(self, id, *args, **kwargs):
self.edispatch.emit(id, args, kwargs)
def from_formats(self, id, *args, **kwargs):
self.idispatch.emit(id, args, kwargs)
def _from_formats(self, id, args, kwargs):
from calibre.ebooks.metadata.meta import metadata_from_formats
try:
mi = metadata_from_formats(*args, **kwargs)
except:
mi = MetaInformation('', [_('Unknown')])
self.metadataf.emit(id, mi)
def _get_metadata(self, id, args, kwargs):
from calibre.ebooks.metadata.meta import get_metadata
try:
mi = get_metadata(*args, **kwargs)
except:
mi = MetaInformation('', [_('Unknown')])
self.metadata.emit(id, mi)
class FileIconProvider(QFileIconProvider):
ICONS = EXT_MAP
def __init__(self):
super().__init__()
self.icons = {k:f'mimetypes/{v}.png' for k, v in self.ICONS.items()}
self.icons['calibre'] = I('lt.png', allow_user_override=False)
for i in ('dir', 'default', 'zero'):
self.icons[i] = QIcon.ic(self.icons[i])
def key_from_ext(self, ext):
key = ext if ext in self.icons else 'default'
if key == 'default' and '.' in ext:
ext = ext.rpartition('.')[2]
key = ext if ext in self.icons else 'default'
if key == 'default' and ext.startswith('original_'):
ext = ext.partition('_')[2]
key = ext if ext in self.icons else 'default'
if key == 'default':
key = ext
return key
def cached_icon(self, key):
candidate = self.icons.get(key)
if isinstance(candidate, QIcon):
return candidate
candidate = candidate or f'mimetypes/{key}.png'
icon = QIcon.ic(candidate)
if not icon.is_ok():
icon = self.icons['default']
self.icons[key] = icon
return icon
def icon_from_ext(self, ext):
key = self.key_from_ext(ext.lower() if ext else '')
return self.cached_icon(key)
def load_icon(self, fileinfo):
key = 'default'
if fileinfo.isSymLink():
if not fileinfo.exists():
return self.icons['zero']
fileinfo = QFileInfo(fileinfo.symLinkTarget())
if fileinfo.isDir():
key = 'dir'
else:
ext = str(fileinfo.completeSuffix()).lower()
key = self.key_from_ext(ext)
return self.cached_icon(key)
def icon(self, arg):
if isinstance(arg, QFileInfo):
return self.load_icon(arg)
if arg == QFileIconProvider.IconType.Folder:
return self.icons['dir']
if arg == QFileIconProvider.IconType.File:
return self.icons['default']
return QFileIconProvider.icon(self, arg)
_file_icon_provider = None
def initialize_file_icon_provider():
global _file_icon_provider
if _file_icon_provider is None:
_file_icon_provider = FileIconProvider()
def file_icon_provider():
global _file_icon_provider
initialize_file_icon_provider()
return _file_icon_provider
has_windows_file_dialog_helper = False
if iswindows and 'CALIBRE_NO_NATIVE_FILEDIALOGS' not in os.environ:
from calibre.gui2.win_file_dialogs import is_ok as has_windows_file_dialog_helper
has_windows_file_dialog_helper = has_windows_file_dialog_helper()
has_linux_file_dialog_helper = False
if not iswindows and not ismacos and 'CALIBRE_NO_NATIVE_FILEDIALOGS' not in os.environ and getattr(sys, 'frozen', False):
has_linux_file_dialog_helper = check_for_linux_native_dialogs()
if has_windows_file_dialog_helper:
from calibre.gui2.win_file_dialogs import choose_dir, choose_files, choose_images, choose_save_file
elif has_linux_file_dialog_helper:
choose_dir, choose_files, choose_save_file, choose_images = map(
linux_native_dialog, 'dir files save_file images'.split())
else:
from calibre.gui2.qt_file_dialogs import choose_dir, choose_files, choose_images, choose_save_file
choose_files, choose_images, choose_dir, choose_save_file
def choose_files_and_remember_all_files(
window, name, title, filters=[], select_only_single_file=False, default_dir='~'
):
pref_name = f'{name}-last-used-filter-spec-all-files'
lufs = dynamic.get(pref_name, False)
af = _('All files'), ['*']
filters = list(filters)
filters.insert(0, af) if lufs else filters.append(af)
paths = choose_files(window, name, title, list(filters), False, select_only_single_file, default_dir)
if paths:
ext = paths[0].rpartition(os.extsep)[-1].lower()
used_all_files = True
for i, (name, exts) in enumerate(filters):
if ext in exts:
used_all_files = False
break
dynamic.set(pref_name, used_all_files)
return paths
def is_dark_theme():
app = QApplication.instance()
if app is not None:
pal = QApplication.instance().palette()
return pal.is_dark_theme()
return False
def choose_osx_app(window, name, title, default_dir='/Applications'):
fd = FileDialog(title=title, parent=window, name=name, mode=QFileDialog.FileMode.ExistingFile,
default_dir=default_dir)
app = fd.get_files()
fd.setParent(None)
if app:
return app
def pixmap_to_data(pixmap, format='JPEG', quality=None):
'''
Return the QPixmap pixmap as a string saved in the specified format.
'''
if quality is None:
if format.upper() == "PNG":
# For some reason on windows with Qt 5.6 using a quality of 90
# generates invalid PNG data. Many other quality values work
# but we use -1 for the default quality which is most likely to
# work
quality = -1
else:
quality = 90
ba = QByteArray()
buf = QBuffer(ba)
buf.open(QIODevice.OpenModeFlag.WriteOnly)
pixmap.save(buf, format, quality=quality)
return ba.data()
def decouple(prefix):
' Ensure that config files used by utility code are not the same as those used by the main calibre GUI '
dynamic.decouple(prefix)
from calibre.gui2.widgets import history
history.decouple(prefix)
_gui_prefs = gprefs
def gui_prefs():
return _gui_prefs
def set_gui_prefs(prefs):
global _gui_prefs
_gui_prefs = prefs
class ResizableDialog(QDialog):
# This class is present only for backwards compat with third party plugins
# that might use it. Do not use it in new code.
def __init__(self, *args, **kwargs):
QDialog.__init__(self, *args)
self.setupUi(self)
geom = self.screen().availableSize()
nh, nw = max(550, geom.height()-25), max(700, geom.width()-10)
nh = min(self.height(), nh)
nw = min(self.width(), nw)
self.resize(nw, nh)
class Translator(QTranslator):
'''
Translator to load translations for strings in Qt from the calibre
translations. Does not support advanced features of Qt like disambiguation
and plural forms.
'''
def translate(self, *args, **kwargs):
try:
src = str(args[1])
except:
return ''
t = _
return t(src)
gui_thread = None
qt_app = None
def calibre_font_files():
return glob.glob(P('fonts/liberation/*.?tf')) + [P('fonts/calibreSymbols.otf')] + \
glob.glob(os.path.join(config_dir, 'fonts', '*.?tf'))
def load_builtin_fonts():
global _rating_font, builtin_fonts_loaded
# Load the builtin fonts and any fonts added to calibre by the user to
# Qt
if hasattr(load_builtin_fonts, 'done'):
return
load_builtin_fonts.done = True
for ff in calibre_font_files():
if ff.rpartition('.')[-1].lower() in {'ttf', 'otf'}:
with open(ff, 'rb') as s:
# Windows requires font files to be executable for them to be
# loaded successfully, so we use the in memory loader
fid = QFontDatabase.addApplicationFontFromData(s.read())
if fid > -1:
fam = QFontDatabase.applicationFontFamilies(fid)
fam = set(map(str, fam))
if 'calibre Symbols' in fam:
_rating_font = 'calibre Symbols'
def setup_gui_option_parser(parser):
if islinux:
parser.add_option('--detach', default=False, action='store_true',
help=_('Detach from the controlling terminal, if any (Linux only)'))
def show_temp_dir_error(err):
import traceback
extra = _('Click "Show details" for more information.')
if 'CALIBRE_TEMP_DIR' in os.environ:
extra = _('The %s environment variable is set. Try unsetting it.') % 'CALIBRE_TEMP_DIR'
error_dialog(None, _('Could not create temporary folder'), _(
'Could not create temporary folder, calibre cannot start.') + ' ' + extra, det_msg=traceback.format_exc(), show=True)
def setup_unix_signals(self):
if hasattr(os, 'pipe2'):
read_fd, write_fd = os.pipe2(os.O_CLOEXEC | os.O_NONBLOCK)
else:
import fcntl
read_fd, write_fd = os.pipe()
cloexec_flag = getattr(fcntl, 'FD_CLOEXEC', 1)
for fd in (read_fd, write_fd):
flags = fcntl.fcntl(fd, fcntl.F_GETFD)
if flags != -1:
fcntl.fcntl(fd, fcntl.F_SETFD, flags | cloexec_flag)
flags = fcntl.fcntl(fd, fcntl.F_GETFL)
if flags != -1:
fcntl.fcntl(fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
original_handlers = {}
for sig in (signal.SIGINT, signal.SIGTERM):
original_handlers[sig] = signal.signal(sig, lambda x, y: None)
signal.siginterrupt(sig, False)
signal.set_wakeup_fd(write_fd)
self.signal_notifier = QSocketNotifier(read_fd, QSocketNotifier.Type.Read, self)
self.signal_notifier.setEnabled(True)
self.signal_notifier.activated.connect(self.signal_received, type=Qt.ConnectionType.QueuedConnection)
return original_handlers
def setup_to_run_webengine():
# Allow import of webengine after construction of QApplication on new enough PyQt
QApplication.setAttribute(Qt.ApplicationAttribute.AA_ShareOpenGLContexts)
try:
# this import is needed to have Qt call qt_registerDefaultPlatformBackingStoreOpenGLSupport
from qt.core import QOpenGLWidget
del QOpenGLWidget
from qt.core import QQuickWindow, QSGRendererInterface
QQuickWindow.setGraphicsApi(QSGRendererInterface.GraphicsApi.OpenGL)
except ImportError:
# for people running from source
if numeric_version >= (6, 3):
raise
class Application(QApplication):
shutdown_signal_received = pyqtSignal()
palette_changed = pyqtSignal()
def __init__(self, args=(), force_calibre_style=False, override_program_name=None, headless=False, color_prefs=gprefs, windows_app_uid=None):
if not args:
args = sys.argv[:1]
args = [args[0]]
sys.excepthook = simple_excepthook
QNetworkProxyFactory.setUseSystemConfiguration(True)
setup_to_run_webengine()
if iswindows:
self.windows_app_uid = None
if windows_app_uid:
windows_app_uid = str(windows_app_uid)
if set_app_uid(windows_app_uid):
self.windows_app_uid = windows_app_uid
self.file_event_hook = None
if override_program_name:
args = [override_program_name] + args[1:]
self.palette_manager = PaletteManager(force_calibre_style, headless)
if headless:
args.extend(('-platformpluginpath', plugins_loc, '-platform', os.environ.get('CALIBRE_HEADLESS_PLATFORM', 'headless')))
else:
args.extend(self.palette_manager.args_to_qt)
self.headless = headless
from calibre_extensions import progress_indicator
self.pi = progress_indicator
self._file_open_paths = []
self._file_open_lock = RLock()
QApplication.setOrganizationName('calibre-ebook.com')
QApplication.setOrganizationDomain(QApplication.organizationName())
QApplication.setApplicationVersion(__version__)
QApplication.setApplicationName(APP_UID)
if override_program_name and hasattr(QApplication, 'setDesktopFileName'):
QApplication.setDesktopFileName(override_program_name)
QApplication.setAttribute(Qt.ApplicationAttribute.AA_ShareOpenGLContexts, True) # needed for webengine
QApplication.__init__(self, args)
set_image_allocation_limit()
self.palette_manager.initialize()
icon_resource_manager.initialize()
sh = self.styleHints()
if hasattr(sh, 'setShowShortcutsInContextMenus'):
sh.setShowShortcutsInContextMenus(True)
if ismacos:
from calibre_extensions.cocoa import disable_cocoa_ui_elements
disable_cocoa_ui_elements()
self.setAttribute(Qt.ApplicationAttribute.AA_SynthesizeTouchForUnhandledMouseEvents, False)
try:
base_dir()
except OSError as err:
if not headless:
show_temp_dir_error(err)
raise SystemExit('Failed to create temporary folder')
if DEBUG and not headless:
prints('QPA platform:', self.platformName())
prints('devicePixelRatio:', self.devicePixelRatio())
s = self.primaryScreen()
if s:
prints('logicalDpi:', s.logicalDotsPerInchX(), 'x', s.logicalDotsPerInchY())
prints('physicalDpi:', s.physicalDotsPerInchX(), 'x', s.physicalDotsPerInchY())
if not iswindows:
self.setup_unix_signals()
if islinux or isbsd:
self.setAttribute(Qt.ApplicationAttribute.AA_DontUseNativeMenuBar, 'CALIBRE_NO_NATIVE_MENUBAR' in os.environ)
self.palette_manager.setup_styles()
self.setup_ui_font()
fi = gprefs['font']
if fi is not None:
font = QFont(*(fi[:4]))
s = gprefs.get('font_stretch', None)
if s is not None:
font.setStretch(s)
QApplication.setFont(font)
if not ismacos and not iswindows:
# Qt 5.10.1 on Linux resets the global font on first event loop tick.
# So workaround it by setting the font once again in a timer.
font_from_prefs = self.font()
QTimer.singleShot(0, lambda : QApplication.setFont(font_from_prefs))
self.line_height = max(12, QFontMetrics(self.font()).lineSpacing())
dl = QLocale(get_lang())
if str(dl.bcp47Name()) != 'C':
QLocale.setDefault(dl)
global gui_thread, qt_app
gui_thread = QThread.currentThread()
self._translator = None
self.load_translations()
qt_app = self
if not ismacos:
# OS X uses a native color dialog that does not support custom
# colors
self.color_prefs = color_prefs
self.read_custom_colors()
self.lastWindowClosed.connect(self.save_custom_colors)
if isxp:
error_dialog(None, _('Windows XP not supported'), '<p>' + _(
'calibre versions newer than 2.0 do not run on Windows XP. This is'
' because the graphics toolkit calibre uses (Qt 5) crashes a lot'
' on Windows XP. We suggest you stay with <a href="%s">calibre 1.48</a>'
' which works well on Windows XP.') % 'https://download.calibre-ebook.com/1.48.0/', show=True)
raise SystemExit(1)
if iswindows:
# Prevent text copied to the clipboard from being lost on quit due to
# Qt 5 bug: https://bugreports.qt-project.org/browse/QTBUG-41125
self.aboutToQuit.connect(self.flush_clipboard)
if ismacos:
from calibre_extensions.cocoa import cursor_blink_time
cft = cursor_blink_time()
if cft >= 0:
self.setCursorFlashTime(int(cft))
@property
def using_calibre_style(self) -> bool:
return self.palette_manager.using_calibre_style
@property
def is_dark_theme(self):
return self.palette_manager.is_dark_theme
@property
def emphasis_window_background_color(self):
return (builtin_colors_dark if self.is_dark_theme else builtin_colors_light)['yellow']
@pyqtSlot(int, result=QIcon)
def get_qt_standard_icon(self, standard_pixmap):
return self.palette_manager.get_qt_standard_icon(standard_pixmap)
def safe_restore_geometry(self, widget, geom):
# See https://bugreports.qt.io/browse/QTBUG-77385
if not geom:
return
restored = widget.restoreGeometry(geom)
self.ensure_window_on_screen(widget)
return restored
def ensure_window_on_screen(self, widget):
screen_rect = widget.screen().availableGeometry()
g = widget.geometry()
w = min(screen_rect.width(), g.width())
h = min(screen_rect.height(), g.height())
if w != g.width() or h != g.height():
widget.resize(w, h)
if not widget.geometry().intersects(screen_rect):
w = min(widget.width(), screen_rect.width() - 10)
h = min(widget.height(), screen_rect.height() - 10)
widget.resize(w, h)
widget.move((screen_rect.width() - w) // 2, (screen_rect.height() - h) // 2)
def setup_ui_font(self):
f = QFont(QApplication.font())
q = (f.family(), f.pointSize())
if iswindows:
if q == ('MS Shell Dlg 2', 8): # Qt default setting
# Microsoft recommends the default font be Segoe UI at 9 pt
# https://msdn.microsoft.com/en-us/library/windows/desktop/dn742483(v=vs.85).aspx
f.setFamily('Segoe UI')
f.setPointSize(9)
QApplication.setFont(f)
else:
if q == ('Sans Serif', 9): # Hard coded Qt settings, no user preference detected
f.setPointSize(10)
QApplication.setFont(f)
f = QFontInfo(f)
self.original_font = (f.family(), f.pointSize(), f.weight(), f.italic(), 100)
def flush_clipboard(self):
try:
if self.clipboard().ownsClipboard():
import ctypes
ctypes.WinDLL('ole32.dll').OleFlushClipboard()
except Exception:
import traceback
traceback.print_exc()
def load_builtin_fonts(self, scan_for_fonts=False):
if scan_for_fonts:
from calibre.utils.fonts.scanner import font_scanner
# Start scanning the users computer for fonts
font_scanner
load_builtin_fonts()
@lru_cache(maxsize=256)
def cached_qimage(self, name, device_pixel_ratio=0):
return self.cached_qpixmap(name, device_pixel_ratio).toImage()
@lru_cache(maxsize=256)
def cached_qpixmap(self, name, device_pixel_ratio=0):
# get the actual size of the image since QIcon does not tell us this for
# icons loaded from a theme
path = I(name, allow_user_override=False)
r = QImageReader(path)
ic = QIcon.ic(name)
if not device_pixel_ratio:
device_pixel_ratio = self.devicePixelRatio()
ans = ic.pixmap(r.size())
ans.setDevicePixelRatio(device_pixel_ratio)
return ans
def _send_file_open_events(self):
with self._file_open_lock:
if self._file_open_paths:
if callable(self.file_event_hook):
self.file_event_hook(self._file_open_paths)
self._file_open_paths = []
def get_pending_file_open_events(self):
with self._file_open_lock:
ans = self._file_open_paths
self._file_open_paths = []
return ans
def load_translations(self):
if self._translator is not None:
self.removeTranslator(self._translator)
self._translator = Translator(self)
self.installTranslator(self._translator)
def event(self, e):
etype = e.type()
if etype == QEvent.Type.FileOpen:
added_event = False
qurl = e.url()
if qurl.isLocalFile():
with self._file_open_lock:
path = qurl.toLocalFile()
if os.access(path, os.R_OK):
self._file_open_paths.append(path)
added_event = True
elif qurl.isValid():
if qurl.scheme() == 'calibre':
url = qurl.toString(QUrl.ComponentFormattingOption.FullyEncoded)
with self._file_open_lock:
self._file_open_paths.append(url)
added_event = True
if added_event:
QTimer.singleShot(1000, self._send_file_open_events)
return True
else:
if etype == QEvent.Type.ApplicationPaletteChange:
self.palette_manager.on_qt_palette_change()
return QApplication.event(self, e)
@property
def current_custom_colors(self):
from qt.core import QColorDialog
return [col.getRgb() for col in
(QColorDialog.customColor(i) for i in range(QColorDialog.customCount()))]
@current_custom_colors.setter
def current_custom_colors(self, colors):
from qt.core import QColorDialog
num = min(len(colors), QColorDialog.customCount())
for i in range(num):
QColorDialog.setCustomColor(i, QColor(*colors[i]))
def read_custom_colors(self):
colors = self.color_prefs.get('custom_colors_for_color_dialog', None)
if colors is not None:
self.current_custom_colors = colors
def save_custom_colors(self):
# Qt 5 regression, it no longer saves custom colors
colors = self.current_custom_colors
if colors != self.color_prefs.get('custom_colors_for_color_dialog', None):
self.color_prefs.set('custom_colors_for_color_dialog', colors)
def __enter__(self):
self.setQuitOnLastWindowClosed(False)
def __exit__(self, *args):
self.setQuitOnLastWindowClosed(True)
def setup_unix_signals(self):
setup_unix_signals(self)
def signal_received(self):
try:
os.read(int(self.signal_notifier.socket()), 1024)
except OSError:
return
self.shutdown_signal_received.emit()
_store_app = None
@contextmanager
def sanitize_env_vars():
'''Unset various environment variables that calibre uses. This
is needed to prevent library conflicts when launching external utilities.'''
if islinux and isfrozen:
env_vars = {
'LD_LIBRARY_PATH':'/lib', 'OPENSSL_MODULES': '/lib/ossl-modules',
}
elif iswindows:
env_vars = {'OPENSSL_MODULES': None, 'QTWEBENGINE_DISABLE_SANDBOX': None}
if os.environ.get('CALIBRE_USE_SYSTEM_CERTIFICATES', '') != '1':
env_vars['SSL_CERT_FILE'] = None
elif ismacos:
env_vars = {k:None for k in (
'FONTCONFIG_FILE FONTCONFIG_PATH OPENSSL_ENGINES OPENSSL_MODULES').split()}
if os.environ.get('CALIBRE_USE_SYSTEM_CERTIFICATES', '') != '1':
env_vars['SSL_CERT_FILE'] = None
else:
env_vars = {}
originals = {x:os.environ.get(x, '') for x in env_vars}
changed = {x:False for x in env_vars}
for var, suffix in env_vars.items():
paths = [x for x in originals[var].split(os.pathsep) if x]
npaths = [] if suffix is None else [x for x in paths if x != (sys.frozen_path + suffix)]
if len(npaths) < len(paths):
if npaths:
os.environ[var] = os.pathsep.join(npaths)
else:
del os.environ[var]
changed[var] = True
try:
yield
finally:
for var, orig in originals.items():
if changed[var]:
if orig:
os.environ[var] = orig
elif var in os.environ:
del os.environ[var]
SanitizeLibraryPath = sanitize_env_vars # For old plugins
def open_url(qurl):
if isinstance(qurl, string_or_bytes):
qurl = QUrl(qurl)
scheme = qurl.scheme().lower() or 'file'
import fnmatch
opener = []
with suppress(Exception):
for scheme_pat, spec in tweaks['openers_by_scheme'].items():
if fnmatch.fnmatch(scheme, scheme_pat):
with suppress(Exception):
import shlex
opener = shlex.split(spec)
break
def run_cmd(cmd):
import subprocess
subprocess.Popen(cmd, stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
with sanitize_env_vars():
if opener:
cmd = [x.replace('%u', qurl.toString()) for x in opener]
if DEBUG:
print('Running opener:', cmd)
run_cmd(cmd)
else:
# Qt 5 requires QApplication to be constructed before trying to use
# QDesktopServices::openUrl()
ensure_app()
cmd = ['xdg-open', qurl.toLocalFile() if qurl.isLocalFile() else qurl.toString(QUrl.ComponentFormattingOption.FullyEncoded)]
if isfrozen and QApplication.instance().platformName() == "wayland":
# See https://bugreports.qt.io/browse/QTBUG-119438
run_cmd(cmd)
ok = True
else:
ok = QDesktopServices.openUrl(qurl)
if not ok:
# this happens a lot with Qt 6.5.3. On Wayland, Qt requires
# BOTH a QApplication AND a top level window so it can use the
# xdg activation token system Wayland imposes.
print('QDesktopServices::openUrl() failed for url:', qurl, file=sys.stderr)
if islinux:
if DEBUG:
print('Opening with xdg-open:', cmd)
run_cmd(cmd)
def safe_open_url(qurl):
if isinstance(qurl, string_or_bytes):
qurl = QUrl(qurl)
if qurl.scheme() in ('', 'file'):
path = qurl.toLocalFile()
ext = os.path.splitext(path)[-1].lower()[1:]
if ext in ('exe', 'com', 'cmd', 'bat', 'sh', 'psh', 'ps1', 'vbs', 'js', 'wsf', 'vba', 'py', 'rb', 'pl', 'app'):
prints('Refusing to open file:', path, file=sys.stderr)
return
open_url(qurl)
def get_current_db():
'''
This method will try to return the current database in use by the user as
efficiently as possible, i.e. without constructing duplicate
LibraryDatabase objects.
'''
from calibre.gui2.ui import get_gui
gui = get_gui()
if gui is not None and gui.current_db is not None:
return gui.current_db
from calibre.library import db
return db()
def open_local_file(path):
if iswindows:
with sanitize_env_vars():
os.startfile(os.path.normpath(path))
else:
url = QUrl.fromLocalFile(path)
open_url(url)
_ea_lock = Lock()
def simple_excepthook(t, v, tb):
return sys.__excepthook__(t, v, tb)
def ensure_app(headless=True):
global _store_app
with _ea_lock:
if _store_app is None and QApplication.instance() is None:
args = sys.argv[:1]
has_headless = ismacos or islinux or isbsd
if headless and has_headless:
args += ['-platformpluginpath', plugins_loc, '-platform', os.environ.get('CALIBRE_HEADLESS_PLATFORM', 'headless')]
if ismacos:
os.environ['QT_MAC_DISABLE_FOREGROUND_APPLICATION_TRANSFORM'] = '1'
if headless and iswindows:
QApplication.setAttribute(Qt.ApplicationAttribute.AA_UseSoftwareOpenGL, True)
QApplication.setAttribute(Qt.ApplicationAttribute.AA_ShareOpenGLContexts)
_store_app = QApplication(args)
set_image_allocation_limit()
if headless and has_headless:
_store_app.headless = True
# This is needed because as of PyQt 5.4 if sys.execpthook ==
# sys.__excepthook__ PyQt will abort the application on an
# unhandled python exception in a slot or virtual method. Since ensure_app()
# is used in worker processes for background work like rendering html
# or running a headless browser, we circumvent this as I really
# dont feel like going through all the code and making sure no
# unhandled exceptions ever occur. All the actual GUI apps already
# override sys.excepthook with a proper error handler.
sys.excepthook = simple_excepthook
return _store_app
def destroy_app():
global _store_app
_store_app = None
def app_is_headless():
return getattr(_store_app, 'headless', False)
def must_use_qt(headless=True):
''' This function should be called if you want to use Qt for some non-GUI
task like rendering HTML/SVG or using a headless browser. It will raise a
RuntimeError if using Qt is not possible, which will happen if the current
thread is not the main GUI thread. On linux, it uses a special QPA headless
plugin, so that the X server does not need to be running. '''
global gui_thread
ensure_app(headless=headless)
if gui_thread is None:
gui_thread = QThread.currentThread()
if gui_thread is not QThread.currentThread():
raise RuntimeError('Cannot use Qt in non GUI thread')
def is_ok_to_use_qt():
try:
must_use_qt()
except RuntimeError:
return False
return True
def is_gui_thread():
global gui_thread
return gui_thread is QThread.currentThread()
_rating_font = 'Arial Unicode MS' if iswindows else 'sans-serif'
def rating_font():
global _rating_font
return _rating_font
def elided_text(text, font=None, width=300, pos='middle'):
''' Return a version of text that is no wider than width pixels when
rendered, replacing characters from the left, middle or right (as per pos)
of the string with an ellipsis. Results in a string much closer to the
limit than Qt's elidedText().'''
from qt.core import QApplication, QFontMetrics
if font is None:
font = QApplication.instance().font()
fm = (font if isinstance(font, QFontMetrics) else QFontMetrics(font))
delta = 4
ellipsis = '\u2026'
def remove_middle(x):
mid = len(x) // 2
return x[:max(0, mid - (delta//2))] + ellipsis + x[mid + (delta//2):]
chomp = {'middle':remove_middle, 'left':lambda x:(ellipsis + x[delta:]), 'right':lambda x:(x[:-delta] + ellipsis)}[pos]
while len(text) > delta and fm.horizontalAdvance(text) > width:
text = chomp(text)
return str(text)
if is_running_from_develop:
from calibre.build_forms import build_forms
build_forms(os.path.abspath(os.environ['CALIBRE_DEVELOP_FROM']), check_for_migration=True)
def event_type_name(ev_or_etype):
etype = ev_or_etype.type() if isinstance(ev_or_etype, QEvent) else ev_or_etype
for name, num in iteritems(vars(QEvent)):
if num == etype:
return name
return 'UnknownEventType'
empty_model = QStringListModel([''])
empty_index = empty_model.index(0)
def set_app_uid(val):
import ctypes
from ctypes import HRESULT, wintypes
try:
AppUserModelID = ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID
except Exception: # Vista has no app uids
return False
AppUserModelID.argtypes = [wintypes.LPCWSTR]
AppUserModelID.restype = HRESULT
try:
AppUserModelID(str(val))
except Exception as err:
prints('Failed to set app uid with error:', as_unicode(err))
return False
return True
def add_to_recent_docs(path):
from calibre_extensions import winutil
app = QApplication.instance()
winutil.add_to_recent_docs(str(path), app.windows_app_uid)
def make_view_use_window_background(view):
p = view.palette()
p.setColor(QPalette.ColorRole.Base, p.color(QPalette.ColorRole.Window))
p.setColor(QPalette.ColorRole.AlternateBase, p.color(QPalette.ColorRole.Window))
view.setPalette(p)
return view
def timed_print(*a, **kw):
if not DEBUG:
return
from time import monotonic
if not hasattr(timed_print, 'startup_time'):
timed_print.startup_time = monotonic()
print(f'[{monotonic() - timed_print.startup_time:.2f}]', *a, **kw)
def local_path_for_resource(qurl: QUrl, base_qurl: 'QUrl | None' = None) -> str:
if base_qurl and qurl.isRelative():
qurl = base_qurl.resolved(qurl)
if qurl.isLocalFile():
return qurl.toLocalFile()
if qurl.isRelative(): # this means has no scheme
return qurl.path()
return ''
def raise_and_focus(self: QWidget) -> None:
self.raise_()
self.activateWindow()
def raise_without_focus(self: QWidget) -> None:
if QApplication.instance().platformName() == 'wayland':
# On fucking Wayland, we cant raise a dialog without also giving it
# keyboard focus. What a joke.
self.raise_and_focus()
else:
self.raise_()
QWidget.raise_and_focus = raise_and_focus
QWidget.raise_without_focus = raise_without_focus
@contextmanager
def clip_border_radius(painter, rect):
painter.save()
r = gprefs['cover_corner_radius']
if r > 0:
pp = QPainterPath()
pp.addRoundedRect(QRectF(rect), r, r, Qt.SizeMode.RelativeSize if gprefs['cover_corner_radius_unit'] == '%' else Qt.SizeMode.AbsoluteSize)
painter.setClipPath(pp)
try:
yield
finally:
painter.restore()
Reference in New Issue View Git Blame Copy Permalink