# -*- coding: utf-8 -*-
#
# This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
-# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
#
from __future__ import with_statement
import os
import os.path
+import re
+import subprocess
+from StringIO import StringIO
from copy import deepcopy
from lxml import etree
import zipfile
+from tempfile import mkdtemp, NamedTemporaryFile
+from shutil import rmtree
-import sys
-sys.path.append('..') # for running from working copy
+from librarian import RDFNS, WLNS, NCXNS, OPFNS, XHTMLNS, OutputFile
+from librarian.cover import DefaultEbookCover
-from librarian import XMLNamespace, RDFNS, DCNS, WLNS, NCXNS, OPFNS, NoDublinCore
-from librarian.dcparser import BookInfo
+from librarian import functions, get_resource
+
+functions.reg_person_name()
def inner_xml(node):
"""
nt = node.text if node.text is not None else ''
- return ''.join([nt] + [etree.tostring(child) for child in node])
+ return ''.join([nt] + [etree.tostring(child) for child in node])
def set_inner_xml(node, text):
""" sets node's text and children from a string
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("---", u"\u2014")\
+ 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':
+ if node.tag in ('uwaga', 'extra'):
+ t = node.tail
node.clear()
- else:
- node.text = replace_chars(node.text)
- node.tail = replace_chars(node.tail)
- for child in node:
- replace_characters(child)
+ node.tail = t
+ node.text = replace_chars(node.text)
+ node.tail = replace_chars(node.tail)
+ for child in node:
+ replace_characters(child)
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', 'uwaga'):
find_annotations(annotations, child, part_no)
+class Stanza(object):
+ """
+ Converts / verse endings into verse elements in a stanza.
+
+ Slashes may only occur directly in the stanza. Any slashes in subelements
+ will be ignored, and the subelements will be put inside verse elements.
+
+ >>> s = etree.fromstring("<strofa>a <b>c</b> <b>c</b>/\\nb<x>x/\\ny</x>c/ \\nd</strofa>")
+ >>> Stanza(s).versify()
+ >>> print etree.tostring(s)
+ <strofa><wers_normalny>a <b>c</b> <b>c</b></wers_normalny><wers_normalny>b<x>x/
+ y</x>c</wers_normalny><wers_normalny>d</wers_normalny></strofa>
+
+ """
+ def __init__(self, stanza_elem):
+ self.stanza = stanza_elem
+ self.verses = []
+ self.open_verse = None
+
+ def versify(self):
+ self.push_text(self.stanza.text)
+ for elem in self.stanza:
+ self.push_elem(elem)
+ self.push_text(elem.tail)
+ tail = self.stanza.tail
+ self.stanza.clear()
+ self.stanza.tail = tail
+ self.stanza.extend(self.verses)
+
+ def open_normal_verse(self):
+ self.open_verse = self.stanza.makeelement("wers_normalny")
+ self.verses.append(self.open_verse)
+
+ def get_open_verse(self):
+ if self.open_verse is None:
+ self.open_normal_verse()
+ return self.open_verse
+
+ def push_text(self, text):
+ if not text:
+ return
+ for i, verse_text in enumerate(re.split(r"/\s*\n", text)):
+ if i:
+ self.open_normal_verse()
+ verse = self.get_open_verse()
+ if len(verse):
+ verse[-1].tail = (verse[-1].tail or "") + verse_text
+ else:
+ verse.text = (verse.text or "") + verse_text
+
+ def push_elem(self, elem):
+ if elem.tag.startswith("wers"):
+ verse = deepcopy(elem)
+ verse.tail = None
+ self.verses.append(verse)
+ self.open_verse = verse
+ else:
+ appended = deepcopy(elem)
+ appended.tail = None
+ self.get_open_verse().append(appended)
+
+
def replace_by_verse(tree):
""" Find stanzas and create new verses in place of a '/' character """
stanzas = tree.findall('.//' + WLNS('strofa'))
- for node in stanzas:
- for child_node in node:
- if child_node.tag in ('slowo_obce', 'wyroznienie'):
- foreign_verses = inner_xml(child_node).split('/\n')
- if len(foreign_verses) > 1:
- new_foreign = ''
- for foreign_verse in foreign_verses:
- if foreign_verse.startswith('<wers'):
- new_foreign += foreign_verse
- else:
- new_foreign += ''.join(('<wers_normalny>', foreign_verse, '</wers_normalny>'))
- set_inner_xml(child_node, new_foreign)
- verses = inner_xml(node).split('/\n')
- if len(verses) > 1:
- modified_inner_xml = ''
- for verse in verses:
- if verse.startswith('<wers') or verse.startswith('<extra'):
- modified_inner_xml += verse
- else:
- modified_inner_xml += ''.join(('<wers_normalny>', verse, '</wers_normalny>'))
- set_inner_xml(node, modified_inner_xml)
+ for stanza in stanzas:
+ Stanza(stanza).versify()
def add_to_manifest(manifest, partno):
class TOC(object):
- def __init__(self, name=None, part_number=None):
+ def __init__(self, name=None, part_href=None):
self.children = []
self.name = name
- self.part_number = part_number
+ self.part_href = part_href
self.sub_number = None
- def add(self, name, part_number, level=0, is_part=True):
+ def add(self, name, part_href, level=0, is_part=True, index=None):
+ assert level == 0 or index is None
if level > 0 and self.children:
- return self.children[-1].add(name, part_number, level-1, is_part)
+ return self.children[-1].add(name, part_href, level-1, is_part)
else:
t = TOC(name)
- t.part_number = part_number
- self.children.append(t)
+ t.part_href = part_href
+ if index is not None:
+ self.children.insert(index, t)
+ else:
+ self.children.append(t)
if not is_part:
t.sub_number = len(self.children) + 1
return t.sub_number
else:
return 0
- def write_to_xml(self, nav_map, counter):
+ def href(self):
+ src = self.part_href
+ if self.sub_number is not None:
+ src += '#sub%d' % self.sub_number
+ return src
+
+ def write_to_xml(self, nav_map, counter=1):
for child in self.children:
nav_point = nav_map.makeelement(NCXNS('navPoint'))
nav_point.set('id', 'NavPoint-%d' % counter)
nav_point.append(nav_label)
content = nav_map.makeelement(NCXNS('content'))
- src = 'part%d.html' % child.part_number
- if child.sub_number is not None:
- src += '#sub%d' % child.sub_number
- content.set('src', src)
+ content.set('src', child.href())
nav_point.append(content)
nav_map.append(nav_point)
counter = child.write_to_xml(nav_point, counter + 1)
return counter
+ def html_part(self, depth=0):
+ texts = []
+ for child in self.children:
+ texts.append(
+ "<div style='margin-left:%dem;'><a href='%s'>%s</a></div>" %
+ (depth, child.href(), child.name))
+ texts.append(child.html_part(depth+1))
+ return "\n".join(texts)
+
+ def html(self):
+ with open(get_resource('epub/toc.html')) as f:
+ t = unicode(f.read(), 'utf-8')
+ return t % self.html_part()
+
+
+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 """
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]:
if element.tag in ("naglowek_czesc", "naglowek_rozdzial", "naglowek_akt", "srodtytul"):
- toc.add(node_name(element), chunk_no)
+ toc.add(node_name(element), "part%d.html" % chunk_no)
elif element.tag in ('naglowek_podrozdzial', 'naglowek_scena'):
- subnumber = toc.add(node_name(element), chunk_no, level=1, is_part=False)
+ subnumber = toc.add(node_name(element), "part%d.html" % 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=None, output_dir=None):
- """ produces an epub
-
- provider is a DocProvider
- 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
+ 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(wldoc, verbose=False,
+ style=None, html_toc=False,
+ sample=None, cover=None, flags=None):
+ """ produces a EPUB file
+
+ sample=n: generate sample e-book (with at least n paragraphs)
+ cover: a cover.Cover factory or True for default
+ flags: less-advertising, without-fonts, working-copy
"""
- def transform_file(input_xml, chunk_counter=1, first=True):
+ def transform_file(wldoc, chunk_counter=1, first=True, sample=None):
""" processes one input file and proceeds to its children """
- children = [child.text for child in input_xml.findall('.//'+DCNS('relation.hasPart'))]
+ replace_characters(wldoc.edoc.getroot())
# every input file will have a TOC entry,
# pointing to starting chunk
- toc = TOC(node_name(input_xml.find('.//'+DCNS('title'))), chunk_counter)
+ toc = TOC(wldoc.book_info.title, "part%d.html" % chunk_counter)
+ chars = set()
if first:
# write book title page
+ html_tree = xslt(wldoc.edoc, 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))
- elif children:
+ etree.tostring(html_tree, method="html", pretty_print=True))
+ # add a title page TOC entry
+ toc.add(u"Strona tytułowa", "title.html")
+ elif wldoc.book_info.parts:
# 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(wldoc.edoc, 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
- if len(input_xml.getroot()) > 1:
+ if len(wldoc.edoc.getroot()) > 1:
# rdf before style master
- main_text = input_xml.getroot()[1]
+ main_text = wldoc.edoc.getroot()[1]
else:
# rdf in style master
- main_text = input_xml.getroot()[0]
+ main_text = wldoc.edoc.getroot()[0]
if main_text.tag == RDFNS('RDF'):
main_text = None
if main_text is not None:
- replace_characters(main_text)
-
for chunk_xml in chop(main_text):
- chunk_html, chunk_toc = transform_chunk(chunk_xml, chunk_counter, annotations)
+ 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)
+
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)
chunk_counter += 1
- 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)
- toc.append(child_toc)
-
- return toc, chunk_counter
-
- # 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')
+ for child in wldoc.parts():
+ child_toc, chunk_counter, chunk_chars, sample = transform_file(
+ child, chunk_counter, first=False, sample=sample)
+ toc.append(child_toc)
+ chars = chars.union(chunk_chars)
+
+ return toc, chunk_counter, chars, sample
+
+
+ document = deepcopy(wldoc)
+ del wldoc
+
+ if flags:
+ for flag in flags:
+ document.edoc.getroot().set(flag, 'yes')
+
+ # add editors info
+ document.edoc.getroot().set('editors', u', '.join(sorted(
+ editor.readable() for editor in document.editors())))
+ if document.book_info.funders:
+ document.edoc.getroot().set('funders', u', '.join(
+ document.book_info.funders))
+ if document.book_info.thanks:
+ document.edoc.getroot().set('thanks', document.book_info.thanks)
+ opf = xslt(document.book_info.to_etree(), get_resource('epub/xsltContent.xsl'))
+ manifest = opf.find('.//' + OPFNS('manifest'))
+ guide = opf.find('.//' + OPFNS('guide'))
+ spine = opf.find('.//' + OPFNS('spine'))
+ output_file = NamedTemporaryFile(prefix='librarian', suffix='.epub', delete=False)
zip = zipfile.ZipFile(output_file, 'w', zipfile.ZIP_DEFLATED)
# write static elements
'<rootfiles><rootfile full-path="OPS/content.opf" ' \
'media-type="application/oebps-package+xml" />' \
'</rootfiles></container>')
- for fname in 'style.css', 'logo_wolnelektury.png':
- zip.write(res(fname), os.path.join('OPS', fname))
+ zip.write(get_resource('res/wl-logo-small.png'), os.path.join('OPS', 'logo_wolnelektury.png'))
+ zip.write(get_resource('res/jedenprocent.png'), os.path.join('OPS', 'jedenprocent.png'))
+ if not style:
+ style = get_resource('epub/style.css')
+ zip.write(style, os.path.join('OPS', 'style.css'))
+
+ if cover:
+ if cover is True:
+ cover = DefaultEbookCover
+
+ cover_file = StringIO()
+ bound_cover = cover(document.book_info)
+ bound_cover.save(cover_file)
+ cover_name = 'cover.%s' % bound_cover.ext()
+ zip.writestr(os.path.join('OPS', cover_name), cover_file.getvalue())
+ del cover_file
+
+ cover_tree = etree.parse(get_resource('epub/cover.html'))
+ cover_tree.find('//' + XHTMLNS('img')).set('src', cover_name)
+ zip.writestr('OPS/cover.html', etree.tostring(
+ cover_tree, method="html", pretty_print=True))
+
+ if bound_cover.uses_dc_cover:
+ if document.book_info.cover_by:
+ document.edoc.getroot().set('data-cover-by', document.book_info.cover_by)
+ if document.book_info.cover_source:
+ document.edoc.getroot().set('data-cover-source', document.book_info.cover_source)
+
+ manifest.append(etree.fromstring(
+ '<item id="cover" href="cover.html" media-type="application/xhtml+xml" />'))
+ manifest.append(etree.fromstring(
+ '<item id="cover-image" href="%s" media-type="%s" />' % (cover_name, bound_cover.mime_type())))
+ spine.insert(0, etree.fromstring('<itemref idref="cover" linear="no" />'))
+ opf.getroot()[0].append(etree.fromstring('<meta name="cover" content="cover-image"/>'))
+ guide.append(etree.fromstring('<reference href="cover.html" type="cover" title="Okładka"/>'))
- opf = xslt(metadata, res('xsltContent.xsl'))
- manifest = opf.find('.//' + OPFNS('manifest'))
- spine = opf.find('.//' + OPFNS('spine'))
annotations = etree.Element('annotations')
'"-//NISO//DTD ncx 2005-1//EN" "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">' \
'<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" xml:lang="pl" ' \
'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></navMap></ncx>')
+ '</navMap></ncx>')
nav_map = toc_file[-1]
- toc, chunk_counter = transform_file(input_xml)
- if not toc.children:
- toc.add(u"Początek utworu", 1)
- toc_counter = toc.write_to_xml(nav_map, 2)
+ if html_toc:
+ manifest.append(etree.fromstring(
+ '<item id="html_toc" href="toc.html" media-type="application/xhtml+xml" />'))
+ spine.append(etree.fromstring(
+ '<itemref idref="html_toc" />'))
+ guide.append(etree.fromstring('<reference href="toc.html" type="toc" title="Spis treści"/>'))
+
+ toc, chunk_counter, chars, sample = transform_file(document, sample=sample)
+
+ if len(toc.children) < 2:
+ toc.add(u"Początek utworu", "part1.html")
# Last modifications in container files and EPUB creation
if len(annotations) > 0:
- nav_map.append(etree.fromstring(
- '<navPoint id="NavPoint-%(i)d" playOrder="%(i)d" ><navLabel><text>Przypisy</text>'\
- '</navLabel><content src="annotations.html" /></navPoint>' % {'i': toc_counter}))
+ toc.add("Przypisy", "annotations.html")
manifest.append(etree.fromstring(
'<item id="annotations" href="annotations.html" media-type="application/xhtml+xml" />'))
spine.append(etree.fromstring(
'<itemref idref="annotations" />'))
replace_by_verse(annotations)
+ html_tree = xslt(annotations, get_resource('epub/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, method="html", pretty_print=True))
+
+ toc.add("Wesprzyj Wolne Lektury", "support.html")
+ manifest.append(etree.fromstring(
+ '<item id="support" href="support.html" media-type="application/xhtml+xml" />'))
+ spine.append(etree.fromstring(
+ '<itemref idref="support" />'))
+ html_string = open(get_resource('epub/support.html')).read()
+ chars.update(used_chars(etree.fromstring(html_string)))
+ zip.writestr('OPS/support.html', html_string)
+
+ toc.add("Strona redakcyjna", "last.html")
+ manifest.append(etree.fromstring(
+ '<item id="last" href="last.html" media-type="application/xhtml+xml" />'))
+ spine.append(etree.fromstring(
+ '<itemref idref="last" />'))
+ html_tree = xslt(document.edoc, get_resource('epub/xsltLast.xsl'))
+ chars.update(used_chars(html_tree.getroot()))
+ zip.writestr('OPS/last.html', etree.tostring(
+ html_tree, method="html", pretty_print=True))
+
+ if not flags or not 'without-fonts' in flags:
+ # strip fonts
+ tmpdir = mkdtemp('-librarian-epub')
+ try:
+ cwd = os.getcwd()
+ except OSError:
+ cwd = None
+
+ 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':
+ optimizer_call = ['perl', 'subset.pl', '--chars', ''.join(chars).encode('utf-8'),
+ get_resource('fonts/' + fname), os.path.join(tmpdir, fname)]
+ if verbose:
+ print "Running font-optimizer"
+ subprocess.check_call(optimizer_call)
+ else:
+ subprocess.check_call(optimizer_call, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+ zip.write(os.path.join(tmpdir, fname), os.path.join('OPS', fname))
+ manifest.append(etree.fromstring(
+ '<item id="%s" href="%s" media-type="font/ttf" />' % (fname, fname)))
+ rmtree(tmpdir)
+ if cwd is not None:
+ os.chdir(cwd)
zip.writestr('OPS/content.opf', etree.tostring(opf, pretty_print=True))
- contents = []
- title = node_name(etree.ETXPath('.//'+DCNS('title'))(input_xml)[0])
+ title = document.book_info.title
attributes = "dtb:uid", "dtb:depth", "dtb:totalPageCount", "dtb:maxPageNumber"
for st in attributes:
meta = toc_file.makeelement(NCXNS('meta'))
toc_file[0][0].set('content', ''.join((title, 'WolneLektury.pl')))
toc_file[0][1].set('content', str(toc.depth()))
set_inner_xml(toc_file[1], ''.join(('<text>', title, '</text>')))
+
+ # write TOC
+ if html_toc:
+ toc.add(u"Spis treści", "toc.html", index=1)
+ zip.writestr('OPS/toc.html', toc.html().encode('utf-8'))
+ toc.write_to_xml(nav_map)
zip.writestr('OPS/toc.ncx', etree.tostring(toc_file, pretty_print=True))
zip.close()
-
-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)
- provider = DirDocProvider(path)
- transform(provider, slug, output_dir=path)
-
+ return OutputFile.from_filename(output_file.name)
fnp / librarian.git / blobdiff