forked from jgoguen/calibre-kobo-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
common.py
291 lines (242 loc) · 10.7 KB
/
common.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
# vim:fileencoding=UTF-8:ts=4:sw=4:sta:et:sts=4:ai
"""Common functions and variables needed by more than one plugin."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
__license__ = "GPL v3"
__copyright__ = "2013, Joel Goguen <[email protected]>"
__docformat__ = "markdown en"
# Be careful editing this! This file has to work in multiple packages at once,
# so don't import anything from calibre_plugins
import os
import re
import sys
import time
import traceback
from functools import partial
from calibre import prints
from calibre.constants import config_dir
from calibre.constants import preferred_encoding
from calibre.ebooks.metadata.book.base import Metadata
from calibre.ebooks.metadata.book.base import NULL_VALUES
from calibre.ebooks.oeb.polish.container import EpubContainer
from calibre.ebooks.oeb.polish.container import OPF_NAMESPACES
from calibre.ptempfile import PersistentTemporaryFile
from calibre.utils.logging import ANSIStream
from polyglot.builtins import is_py3
from polyglot.io import PolyglotStringIO
from lxml.etree import _Element
if is_py3:
from typing import Dict
from typing import List
from typing import Optional
from typing import Union
KOBO_JS_RE = re.compile(r".*/?kobo.*?\.js$", re.IGNORECASE)
XML_NAMESPACE = "https://www.w3.org/XML/1998/namespace"
CONFIGDIR = os.path.join(config_dir, "plugins") # type: str
REFERENCE_KEPUB = os.path.join(CONFIGDIR, "reference.kepub.epub") # type: str
PLUGIN_VERSION = (3, 4, 1)
PLUGIN_MINIMUM_CALIBRE_VERSION = (3, 42, 0)
class Logger:
LEVELS = {"DEBUG": 0, "INFO": 1, "WARN": 2, "ERROR": 3}
def __init__(self):
self.log_level = "INFO"
if (
"CALIBRE_DEVELOP_FROM" in os.environ
or "CALIBRE_DEBUG" in os.environ
or "calibre-debug" in sys.argv[0]
):
self.log_level = "DEBUG"
# According to Kovid, calibre always uses UTF-8 for the Python 3 version
self.preferred_encoding = "UTF-8" if is_py3 else preferred_encoding
self.outputs = [ANSIStream()]
self.debug = partial(self.print_formatted_log, "DEBUG")
self.info = partial(self.print_formatted_log, "INFO")
self.warn = self.warning = partial(self.print_formatted_log, "WARN")
self.error = partial(self.print_formatted_log, "ERROR")
def __call__(self, logmsg):
self.info(logmsg)
def _tag_args(self, level, *args):
now = time.localtime()
buf = PolyglotStringIO()
tagged_args = []
for arg in args:
prints(time.strftime("%Y-%m-%d %H:%M:%S", now), file=buf, end=" ")
buf.write("[")
prints(level, file=buf, end="")
buf.write("] ")
prints(arg, file=buf, end="")
tagged_args.append(buf.getvalue())
buf.truncate(0)
return tagged_args
def _prints(self, level, *args, **kwargs):
for o in self.outputs:
o.prints(self.LEVELS[level], *args, **kwargs)
if hasattr(o, "flush"):
o.flush()
def print_formatted_log(self, level, *args, **kwargs):
tagged_args = self._tag_args(level, *args)
self._prints(level, *tagged_args, **kwargs)
def exception(self, *args, **kwargs):
limit = kwargs.pop("limit", None)
tagged_args = self._tag_args("ERROR", *args)
self._prints("ERROR", *tagged_args, **kwargs)
self._prints("ERROR", traceback.format_exc(limit))
log = Logger()
# The logic here to detect a cover image is mostly duplicated from
# metadata/writer.py. Updates to the logic here probably need an accompanying
# update over there.
def modify_epub(
container, # type: EpubContainer
filename, # type: str
metadata=None, # type: Optional[Metadata]
opts={}, # type: Dict[str, Union[str, bool]]
): # type: (...) -> None
"""Modify the ePub file to make it KePub-compliant."""
_modify_start = time.time()
# Search for the ePub cover
# TODO: Refactor out cover detection logic so it can be directly used in
# metadata/writer.py
found_cover = False # type: bool
opf = container.opf # type: _Element
cover_meta_node_list = opf.xpath(
'./opf:metadata/opf:meta[@name="cover"]', namespaces=OPF_NAMESPACES
) # List[_Element]
if len(cover_meta_node_list) > 0:
cover_meta_node = cover_meta_node_list[0] # type: _Element
cover_id = cover_meta_node.attrib.get("content", None)
log.debug("Found meta node with name=cover")
if cover_id:
log.info("Found cover image ID '{0}'".format(cover_id))
cover_node_list = opf.xpath(
'./opf:manifest/opf:item[@id="{0}"]'.format(cover_id),
namespaces=OPF_NAMESPACES,
) # type: List[_Element]
if len(cover_node_list) > 0:
cover_node = cover_node_list[0] # type: _Element
log.debug("Found an item node with cover ID")
if cover_node.attrib.get("properties", "") != "cover-image":
log.info("Setting cover-image property")
cover_node.set("properties", "cover-image")
container.dirty(container.opf_name)
else:
log.warning("Item node is already set as cover-image")
found_cover = True
# It's possible that the cover image can't be detected this way. Try
# looking for the cover image ID in the OPF manifest.
if not found_cover:
log.debug("Looking for cover image in OPF manifest")
node_list = opf.xpath(
"./opf:manifest/opf:item[(translate(@id, "
+ "'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')"
+ '="cover" or starts-with(translate(@id, '
+ "'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz')"
+ ', "cover")) and starts-with(@media-type, "image")]',
namespaces=OPF_NAMESPACES,
) # type: List[_Element]
if len(node_list) > 0:
log.info(
"Found {0:d} nodes, assuming the first is the "
"right node".format(len(node_list))
)
node = node_list[0] # type: _Element
if node.attrib.get("properties", "") != "cover-image":
log.info("Setting cover-image property")
node.set("properties", "cover-image")
container.dirty(container.opf_name)
else:
log.warning("Item node is already set as cover-image")
found_cover = True
# Hyphenate files?
if opts.get("no-hyphens", False):
nohyphen_css = PersistentTemporaryFile(
suffix="_nohyphen", prefix="kepub_"
) # type: PersistentTemporaryFile
nohyphen_css.write(get_resources("css/no-hyphens.css")) # noqa: F821
nohyphen_css.close()
css_path = os.path.basename(
container.copy_file_to_container(
nohyphen_css.name, name="kte-css/no-hyphens.css"
)
) # type: str
container.add_content_file_reference("kte-css/{0}".format(css_path))
os.unlink(nohyphen_css.name)
elif opts.get("hyphenate", False) and opts.get("hyphen_min_chars", 6) > 0:
if metadata and metadata.language == NULL_VALUES["language"]:
log.warning(
"Hyphenation is enabled but not overriding content file "
"language. Hyphenation may use the wrong dictionary."
)
hyphen_css = PersistentTemporaryFile(
suffix="_hyphenate", prefix="kepub_"
) # type: PersistentTemporaryFile
css_template = get_resources("css/hyphenation.css.tmpl").decode() # noqa: F821
hyphen_limit_lines = opts.get("hyphen_limit_lines", 2)
if hyphen_limit_lines == 0:
hyphen_limit_lines = "no-limit"
hyphen_css.write(
css_template.format(
hyphen_min_chars=opts.get("hyphen_min_chars"),
hyphen_min_chars_before=opts.get("hyphen_min_chars_before", 3),
hyphen_min_chars_after=opts.get("hyphen_min_chars_after", 3),
hyphen_limit_lines=hyphen_limit_lines,
).encode()
)
hyphen_css.close()
css_path = os.path.basename(
container.copy_file_to_container(
hyphen_css.name, name="kte-css/hyphenation.css"
)
) # type: str
container.add_content_file_reference("kte-css/{0}".format(css_path))
os.unlink(hyphen_css.name)
# Now smarten punctuation
if opts.get("smarten_punctuation", False):
container.smarten_punctuation()
if opts.get("extended_kepub_features", True):
if metadata is not None:
log.info(
"Adding extended Kobo features to {0} by {1}".format(
metadata.title, " and ".join(metadata.authors)
)
)
# Add the Kobo span and div tags
container.convert()
# Check to see if there's already a kobo*.js in the ePub
skip_js = False # type: str
for name in container.name_path_map:
if KOBO_JS_RE.match(name):
skip_js = True
break
if not skip_js:
if os.path.isfile(REFERENCE_KEPUB):
reference_container = EpubContainer(REFERENCE_KEPUB, log)
for name in reference_container.name_path_map:
if KOBO_JS_RE.match(name):
jsname = container.copy_file_to_container(
os.path.join(reference_container.root, name), name="kobo.js"
)
container.add_content_file_reference(jsname)
break
# Add the Kobo style hacks
stylehacks_css = PersistentTemporaryFile(suffix="_stylehacks", prefix="kepub_")
stylehacks_css.write(get_resources("css/style-hacks.css")) # noqa: F821
stylehacks_css.close()
css_path = os.path.basename(
container.copy_file_to_container(
stylehacks_css.name, name="kte-css/stylehacks.css"
)
)
container.add_content_file_reference("kte-css/{0}".format(css_path))
os.unlink(filename)
container.commit(filename)
_modify_time = time.time() - _modify_start
log.info("modify_epub took {0:f} seconds".format(_modify_time))
def intValueChanged(widget, singular, plural, *args, **kwargs):
try:
from PyQt5 import Qt as QtGui
except ImportError:
from PyQt4 import QtGui
if isinstance(widget, (QtGui.QSpinBox, QtGui.QDoubleSpinBox)):
widget.setSuffix(" " + ngettext(singular, plural, widget.value())) # noqa: F821