X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/ee1f5f9be7d4e2bb843c01a118cc090ab97e6cc6..5c8b83a904d5dd988c0bfd86729b91a1ac763164:/librarian/epub.py?ds=inline
diff --git a/librarian/epub.py b/librarian/epub.py
index a0d9742..527d050 100644
--- a/librarian/epub.py
+++ b/librarian/epub.py
@@ -7,41 +7,22 @@ from __future__ import with_statement
import os
import os.path
-import shutil
-import sys
+import subprocess
+from StringIO import StringIO
from copy import deepcopy
from lxml import etree
import zipfile
+from tempfile import mkdtemp
+from shutil import rmtree
-from librarian import XMLNamespace, RDFNS, DCNS, WLNS, XHTMLNS, NoDublinCore
-from librarian.parser import WLDocument
-
-#TODO: shouldn't be repeated here
-NCXNS = XMLNamespace("http://www.daisy.org/z3986/2005/ncx/")
-OPFNS = XMLNamespace("http://www.idpf.org/2007/opf")
-
-
-class DocProvider(object):
- class DoesNotExist(Exception):
- pass
-
- def by_slug(self, slug):
- raise NotImplemented
-
- def __getitem__(self, slug):
- return self.by_slug(slug)
-
- def by_uri(self, uri):
- return self.by_slug(uri.rsplit('/', 1)[1])
+import sys
+from librarian import XMLNamespace, RDFNS, DCNS, WLNS, NCXNS, OPFNS, NoDublinCore
+from librarian.dcparser import BookInfo
-class DirDocProvider(DocProvider):
- def __init__(self, dir):
- self.dir = dir
- self.files = {}
+from librarian import functions, get_resource
- def by_slug(self, slug):
- return open(os.path.join(self.dir, '%s.xml' % slug))
+functions.reg_person_name()
def inner_xml(node):
@@ -63,7 +44,6 @@ def set_inner_xml(node, text):
xyz
"""
-
p = etree.fromstring('%s' % text)
node.text = p.text
node[:] = p[:]
@@ -94,21 +74,16 @@ def xslt(xml, sheet):
return xml.xslt(etree.parse(xsltf))
-_resdir = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'epub')
-def res(fname):
- return os.path.join(_resdir, fname)
-
-
def replace_characters(node):
def replace_chars(text):
if text is None:
return None
- return text.replace("&", "&")\
- .replace("---", "—")\
- .replace("--", "–")\
- .replace(",,", "„")\
- .replace('"', "”")\
- .replace("'", "’")
+ return text.replace(u"\ufeff", u"")\
+ .replace("---", u"\u2014")\
+ .replace("--", u"\u2013")\
+ .replace(",,", u"\u201E")\
+ .replace('"', u"\u201D")\
+ .replace("'", u"\u2019")
if node.tag == 'extra':
node.clear()
else:
@@ -131,7 +106,7 @@ def find_annotations(annotations, source, part_no):
child.clear()
child.tail = tail
child.text = number
- if child.tag not in ('extra', 'podtytul'):
+ if child.tag not in ('extra',):
find_annotations(annotations, child, part_no)
@@ -234,6 +209,14 @@ class TOC(object):
return counter
+def used_chars(element):
+ """ Lists characters used in an ETree Element """
+ chars = set((element.text or '') + (element.tail or ''))
+ for child in element:
+ chars = chars.union(used_chars(child))
+ return chars
+
+
def chop(main_text):
""" divide main content of the XML file into chunks """
@@ -258,8 +241,8 @@ def chop(main_text):
yield part_xml
-def transform_chunk(chunk_xml, chunk_no, annotations):
- """ transforms one chunk, returns a HTML string and a TOC object """
+def transform_chunk(chunk_xml, chunk_no, annotations, empty=False, _empty_html_static=[]):
+ """ transforms one chunk, returns a HTML string, a TOC object and a set of used characters """
toc = TOC()
for element in chunk_xml[0]:
@@ -268,35 +251,61 @@ def transform_chunk(chunk_xml, chunk_no, annotations):
elif element.tag in ('naglowek_podrozdzial', 'naglowek_scena'):
subnumber = toc.add(node_name(element), chunk_no, level=1, is_part=False)
element.set('sub', str(subnumber))
- find_annotations(annotations, chunk_xml, chunk_no)
- replace_by_verse(chunk_xml)
- output_html = etree.tostring(xslt(chunk_xml, res('xsltScheme.xsl')), pretty_print=True)
- return output_html, toc
-
-
-def transform(provider, slug, output_file):
- """ produces an epub
-
- provider is a DocProvider
- output_file should be filelike object
+ if empty:
+ if not _empty_html_static:
+ _empty_html_static.append(open(get_resource('epub/emptyChunk.html')).read())
+ chars = set()
+ output_html = _empty_html_static[0]
+ else:
+ find_annotations(annotations, chunk_xml, chunk_no)
+ replace_by_verse(chunk_xml)
+ html_tree = xslt(chunk_xml, get_resource('epub/xsltScheme.xsl'))
+ chars = used_chars(html_tree.getroot())
+ output_html = etree.tostring(html_tree, method="html", pretty_print=True)
+ return output_html, toc, chars
+
+
+def transform(provider, slug=None, file_path=None, output_file=None, output_dir=None, make_dir=False, verbose=False,
+ sample=None, cover_fn=None, flags=None):
+ """ produces a EPUB file
+
+ provider: a DocProvider
+ slug: slug of file to process, available by provider
+ output_file: file-like object or path to output file
+ output_dir: path to directory to save output file to; either this or output_file must be present
+ make_dir: writes output to //.epub instead of /.epub
+ sample=n: generate sample e-book (with at least n paragraphs)
+ cover_fn: function(author, title) -> cover image
+ flags: less-advertising,
"""
- def transform_file(input_xml, chunk_counter=1, first=True):
+ def transform_file(input_xml, chunk_counter=1, first=True, sample=None):
""" processes one input file and proceeds to its children """
+ replace_characters(input_xml.getroot())
+
children = [child.text for child in input_xml.findall('.//'+DCNS('relation.hasPart'))]
# every input file will have a TOC entry,
# pointing to starting chunk
toc = TOC(node_name(input_xml.find('.//'+DCNS('title'))), chunk_counter)
+ chars = set()
if first:
# write book title page
+ html_tree = xslt(input_xml, get_resource('epub/xsltTitle.xsl'))
+ chars = used_chars(html_tree.getroot())
zip.writestr('OPS/title.html',
- etree.tostring(xslt(input_xml, res('xsltTitle.xsl')), pretty_print=True))
+ etree.tostring(html_tree, method="html", pretty_print=True))
elif children:
# write title page for every parent
- zip.writestr('OPS/part%d.html' % chunk_counter,
- etree.tostring(xslt(input_xml, res('xsltChunkTitle.xsl')), pretty_print=True))
+ if sample is not None and sample <= 0:
+ chars = set()
+ html_string = open(get_resource('epub/emptyChunk.html')).read()
+ else:
+ html_tree = xslt(input_xml, get_resource('epub/xsltChunkTitle.xsl'))
+ chars = used_chars(html_tree.getroot())
+ html_string = etree.tostring(html_tree, method="html", pretty_print=True)
+ zip.writestr('OPS/part%d.html' % chunk_counter, html_string)
add_to_manifest(manifest, chunk_counter)
add_to_spine(spine, chunk_counter)
chunk_counter += 1
@@ -311,11 +320,17 @@ def transform(provider, slug, output_file):
main_text = None
if main_text is not None:
- replace_characters(main_text)
+ for chunk_xml in chop(main_text):
+ empty = False
+ if sample is not None:
+ if sample <= 0:
+ empty = True
+ else:
+ sample -= len(chunk_xml.xpath('//strofa|//akap|//akap_cd|//akap_dialog'))
+ chunk_html, chunk_toc, chunk_chars = transform_chunk(chunk_xml, chunk_counter, annotations, empty)
- for chunk_no, chunk_xml in enumerate(chop(main_text), chunk_counter):
- chunk_html, chunk_toc = transform_chunk(chunk_xml, chunk_counter, annotations)
toc.extend(chunk_toc)
+ chars = chars.union(chunk_chars)
zip.writestr('OPS/part%d.html' % chunk_counter, chunk_html)
add_to_manifest(manifest, chunk_counter)
add_to_spine(spine, chunk_counter)
@@ -324,11 +339,47 @@ def transform(provider, slug, output_file):
if children:
for child in children:
child_xml = etree.parse(provider.by_uri(child))
- child_toc, chunk_counter = transform_file(child_xml, chunk_counter, first=False)
+ child_toc, chunk_counter, chunk_chars, sample = transform_file(child_xml, chunk_counter, first=False, sample=sample)
toc.append(child_toc)
+ chars = chars.union(chunk_chars)
+
+ return toc, chunk_counter, chars, sample
- return toc, chunk_counter
+ # read metadata from the first file
+ if file_path:
+ if slug:
+ raise ValueError('slug or file_path should be specified, not both')
+ f = open(file_path, 'r')
+ input_xml = etree.parse(f)
+ f.close()
+ else:
+ if not slug:
+ raise ValueError('either slug or file_path should be specified')
+ input_xml = etree.parse(provider[slug])
+ if flags:
+ for flag in flags:
+ input_xml.getroot().set(flag, 'yes')
+
+ metadata = input_xml.find('.//'+RDFNS('Description'))
+ if metadata is None:
+ raise NoDublinCore('Document has no DublinCore - which is required.')
+ book_info = BookInfo.from_element(input_xml)
+ metadata = etree.ElementTree(metadata)
+
+ # if output to dir, create the file
+ if output_dir is not None:
+ if make_dir:
+ author = unicode(book_info.author)
+ output_dir = os.path.join(output_dir, author)
+ try:
+ os.makedirs(output_dir)
+ except OSError:
+ pass
+ if slug:
+ output_file = open(os.path.join(output_dir, '%s.epub' % slug), 'w')
+ else:
+ output_file = open(os.path.join(output_dir, os.path.splitext(os.path.basename(file_path))[0] + '.epub'), 'w')
zip = zipfile.ZipFile(output_file, 'w', zipfile.ZIP_DEFLATED)
@@ -343,19 +394,28 @@ def transform(provider, slug, output_file):
'' \
'')
- for fname in 'style.css', 'logo_wolnelektury.png':
- zip.write(res(fname), os.path.join('OPS', fname))
+ zip.write(get_resource('epub/style.css'), os.path.join('OPS', 'style.css'))
+ zip.write(get_resource('res/wl-logo-small.png'), os.path.join('OPS', 'logo_wolnelektury.png'))
- # metadata from first file
- input_xml = etree.parse(provider[slug])
- metadata = input_xml.find('.//'+RDFNS('Description'))
- if metadata is None:
- raise NoDublinCore('Document has no DublinCore - which is required.')
- metadata = etree.ElementTree(metadata)
- opf = xslt(metadata, res('xsltContent.xsl'))
+ opf = xslt(metadata, get_resource('epub/xsltContent.xsl'))
manifest = opf.find('.//' + OPFNS('manifest'))
spine = opf.find('.//' + OPFNS('spine'))
+ if cover_fn:
+ cover = StringIO()
+ cover_fn(book_info.author.readable(), book_info.title).save(cover, format='JPEG')
+ zip.writestr(os.path.join('OPS', 'cover.jpg'), cover.getvalue())
+ del cover
+ zip.writestr('OPS/cover.html', open(get_resource('epub/cover.html')).read())
+ manifest.append(etree.fromstring(
+ '