import os
import os.path
-import shutil
-import sys
+import subprocess
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])
-
-
-class DirDocProvider(DocProvider):
- def __init__(self, dir):
- self.dir = dir
- self.files = {}
+import sys
+sys.path.append('..') # for running from working copy
- def by_slug(self, slug):
- return open(os.path.join(self.dir, '%s.xml' % slug))
+from librarian import XMLNamespace, RDFNS, DCNS, WLNS, NCXNS, OPFNS, NoDublinCore
+from librarian.dcparser import BookInfo
def inner_xml(node):
<a>x<b>y</b>z</a>
"""
-
p = etree.fromstring('<x>%s</x>' % text)
node.text = p.text
node[:] = p[:]
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 """
def transform_chunk(chunk_xml, chunk_no, annotations):
- """ transforms one chunk, returns a HTML string and a TOC object """
+ """ transforms one chunk, returns a HTML string, a TOC object and a set of used characters """
toc = TOC()
for element in chunk_xml[0]:
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
+ html_tree = xslt(chunk_xml, res('xsltScheme.xsl'))
+ chars = used_chars(html_tree.getroot())
+ output_html = etree.tostring(html_tree, pretty_print=True)
+ return output_html, toc, chars
-def transform(provider, slug, output_file):
+def transform(provider, slug, output_file=None, output_dir=None):
""" produces an epub
provider is a DocProvider
- output_file should be filelike object
+ either output_file (a file-like object) or output_dir (path to file/dir) should be specified
+ if output_dir is specified, file will be written to <output_dir>/<author>/<slug>.epub
"""
def transform_file(input_xml, chunk_counter=1, first=True):
# 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, res('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, pretty_print=True))
elif children:
# write title page for every parent
+ html_tree = xslt(input_xml, res('xsltChunkTitle.xsl'))
+ chars = used_chars(html_tree.getroot())
zip.writestr('OPS/part%d.html' % chunk_counter,
- etree.tostring(xslt(input_xml, res('xsltChunkTitle.xsl')), pretty_print=True))
+ etree.tostring(html_tree, pretty_print=True))
add_to_manifest(manifest, chunk_counter)
add_to_spine(spine, chunk_counter)
chunk_counter += 1
if main_text is not None:
replace_characters(main_text)
- for chunk_no, chunk_xml in enumerate(chop(main_text), chunk_counter):
- chunk_html, chunk_toc = transform_chunk(chunk_xml, chunk_counter, annotations)
+ for chunk_xml in chop(main_text):
+ chunk_html, chunk_toc, chunk_chars = 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)
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 = transform_file(child_xml, chunk_counter, first=False)
toc.append(child_toc)
+ chars = chars.union(chunk_chars)
- return toc, chunk_counter
+ return toc, chunk_counter, chars
+
+ # read metadata from the 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.')
+ book_info = BookInfo.from_element(input_xml)
+ metadata = etree.ElementTree(metadata)
+
+ # if output to dir, create the file
+ if output_dir is not None:
+ author = unicode(book_info.author)
+ author_dir = os.path.join(output_dir, author)
+ try:
+ os.makedirs(author_dir)
+ except OSError:
+ pass
+ output_file = open(os.path.join(author_dir, '%s.epub' % slug), 'w')
zip = zipfile.ZipFile(output_file, 'w', zipfile.ZIP_DEFLATED)
for fname in 'style.css', 'logo_wolnelektury.png':
zip.write(res(fname), os.path.join('OPS', fname))
- # 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'))
manifest = opf.find('.//' + OPFNS('manifest'))
spine = opf.find('.//' + OPFNS('spine'))
'version="2005-1"><head></head><docTitle></docTitle><navMap>' \
'<navPoint id="NavPoint-1" playOrder="1"><navLabel>' \
'<text>Strona tytułowa</text></navLabel><content src="title.html" />' \
- '</navPoint><navPoint id="NavPoint-2" playOrder="2"><navLabel>' \
- '<text>Początek utworu</text></navLabel><content src="part1.html" />' \
'</navPoint></navMap></ncx>')
nav_map = toc_file[-1]
- toc, chunk_counter = transform_file(input_xml)
- toc_counter = toc.write_to_xml(nav_map, 3) # we already have 2 navpoints
+ toc, chunk_counter, chars = transform_file(input_xml)
+
+ if not toc.children:
+ toc.add(u"Początek utworu", 1)
+ toc_counter = toc.write_to_xml(nav_map, 2)
# Last modifications in container files and EPUB creation
if len(annotations) > 0:
spine.append(etree.fromstring(
'<itemref idref="annotations" />'))
replace_by_verse(annotations)
+ html_tree = xslt(annotations, res("xsltAnnotations.xsl"))
+ chars = chars.union(used_chars(html_tree.getroot()))
zip.writestr('OPS/annotations.html', etree.tostring(
- xslt(annotations, res("xsltAnnotations.xsl")), pretty_print=True))
+ html_tree, pretty_print=True))
+
+ # strip fonts
+ tmpdir = mkdtemp('-librarian-epub')
+ cwd = os.getcwd()
+
+ os.chdir(os.path.join(os.path.dirname(os.path.realpath(__file__)), '../font-optimizer'))
+ for fname in 'DejaVuSerif.ttf', 'DejaVuSerif-Bold.ttf', 'DejaVuSerif-Italic.ttf', 'DejaVuSerif-BoldItalic.ttf':
+ subprocess.check_call(['./subset.pl', '--chars', ''.join(chars).encode('utf-8'), res('../fonts/' + fname), os.path.join(tmpdir, fname)])
+ zip.write(os.path.join(tmpdir, fname), os.path.join('OPS', fname))
+ rmtree(tmpdir)
+ os.chdir(cwd)
zip.writestr('OPS/content.opf', etree.tostring(opf, pretty_print=True))
contents = []
if __name__ == '__main__':
+ from librarian import DirDocProvider
+
if len(sys.argv) < 2:
print >> sys.stderr, 'Usage: python epub.py <input file>'
sys.exit(1)
main_input = sys.argv[1]
basepath, ext = os.path.splitext(main_input)
path, slug = os.path.realpath(basepath).rsplit('/', 1)
- output = basepath + '.epub'
provider = DirDocProvider(path)
- transform(provider, slug, open(output, 'w'))
+ transform(provider, slug, output_dir=path)