Pierwszy poważny import.
[redakcja.git] / lib / librarian / html.py
diff --git a/lib/librarian/html.py b/lib/librarian/html.py
new file mode 100644 (file)
index 0000000..ad18952
--- /dev/null
@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+import os
+import cStringIO
+import re
+import copy
+import pkgutil
+
+from lxml import etree
+
+
+ENTITY_SUBSTITUTIONS = [
+    (u'---', u'—'),
+    (u'--', u'–'),
+    (u'...', u'…'),
+    (u',,', u'„'),
+    (u'"', u'”'),
+]
+
+
+def substitute_entities(context, text):
+    """XPath extension function converting all entites in passed text."""
+    if isinstance(text, list):
+        text = ''.join(text)
+    for entity, substitutution in ENTITY_SUBSTITUTIONS:
+        text = text.replace(entity, substitutution)
+    return text
+
+
+# Register substitute_entities function with lxml
+ns = etree.FunctionNamespace('http://wolnelektury.pl/functions')
+ns['substitute_entities'] = substitute_entities
+
+
+def transform(input_filename, output_filename=None, is_file=True):
+    """Transforms file input_filename in XML to output_filename in XHTML."""
+    # Parse XSLT
+    style_filename = os.path.join(os.path.dirname(__file__), 'book2html.xslt')
+    style = etree.parse(style_filename)
+
+    doc_file = cStringIO.StringIO()
+    expr = re.compile(r'/\s', re.MULTILINE | re.UNICODE);
+
+    if is_file:
+        f = open(input_filename, 'rb')
+        input_filename = f.read()
+        f.close()
+    
+    data = input_filename.decode('utf-8')
+    data = expr.sub(u'<br />\n', data)
+    doc_file.write(data.encode('utf-8'))
+    doc_file.seek(0);
+
+    parser = etree.XMLParser(remove_blank_text=True)
+    doc = etree.parse(doc_file, parser)
+
+    result = doc.xslt(style)
+    if result.find('//p') is not None:
+        add_anchors(result.getroot())
+        add_table_of_contents(result.getroot())
+        
+        if output_filename is not None:
+            result.write(output_filename, xml_declaration=False, pretty_print=True, encoding='utf-8')
+        else:
+            return result
+        return True
+    else:
+        return False
+
+
+class Fragment(object):
+    def __init__(self, id, themes):
+        super(Fragment, self).__init__()
+        self.id = id
+        self.themes = themes
+        self.events = []
+
+    def append(self, event, element):
+        self.events.append((event, element))
+
+    def closed_events(self):
+        stack = []
+        for event, element in self.events:
+            if event == 'start':
+                stack.append(('end', element))
+            elif event == 'end':
+                try:
+                    stack.pop()
+                except IndexError:
+                    print 'CLOSED NON-OPEN TAG:', element
+
+        stack.reverse()
+        return self.events + stack
+
+    def to_string(self):
+        result = []
+        for event, element in self.closed_events():
+            if event == 'start':
+                result.append(u'<%s %s>' % (element.tag, ' '.join('%s="%s"' % (k, v) for k, v in element.attrib.items())))
+                if element.text:
+                    result.append(element.text)
+            elif event == 'end':
+                result.append(u'</%s>' % element.tag)
+                if element.tail:
+                    result.append(element.tail)
+            else:
+                result.append(element)
+
+        return ''.join(result)
+
+    def __unicode__(self):
+        return self.to_string()
+
+
+def extract_fragments(input_filename):
+    """Extracts theme fragments from input_filename."""
+    open_fragments = {}
+    closed_fragments = {}
+
+    for event, element in etree.iterparse(input_filename, events=('start', 'end')):
+        # Process begin and end elements
+        if element.get('class', '') in ('theme-begin', 'theme-end'):
+            if not event == 'end': continue # Process elements only once, on end event
+
+            # Open new fragment
+            if element.get('class', '') == 'theme-begin':
+                fragment = Fragment(id=element.get('fid'), themes=element.text)
+
+                # Append parents
+                if element.getparent().get('id', None) != 'book-text':
+                    parents = [element.getparent()]
+                    while parents[-1].getparent().get('id', None) != 'book-text':
+                        parents.append(parents[-1].getparent())
+
+                    parents.reverse()
+                    for parent in parents:
+                        fragment.append('start', parent)
+
+                open_fragments[fragment.id] = fragment
+
+            # Close existing fragment
+            else:
+                try:
+                    fragment = open_fragments[element.get('fid')]
+                except KeyError:
+                    print '%s:closed not open fragment #%s' % (input_filename, element.get('fid'))
+                else:
+                    closed_fragments[fragment.id] = fragment
+                    del open_fragments[fragment.id]
+
+            # Append element tail to lost_text (we don't want to lose any text)
+            if element.tail:
+                for fragment_id in open_fragments:
+                    open_fragments[fragment_id].append('text', element.tail)
+
+
+        # Process all elements except begin and end
+        else:
+            # Omit annotation tags
+            if len(element.get('name', '')) or element.get('class', '') == 'annotation':
+                if event == 'end' and element.tail:
+                    for fragment_id in open_fragments:
+                        open_fragments[fragment_id].append('text', element.tail)
+            else:
+                for fragment_id in open_fragments:
+                    open_fragments[fragment_id].append(event, copy.copy(element))
+
+    return closed_fragments, open_fragments
+
+
+def add_anchor(element, prefix, with_link=True, with_target=True, link_text=None):
+    if with_link:
+        if link_text is None:
+            link_text = prefix
+        anchor = etree.Element('a', href='#%s' % prefix)
+        anchor.set('class', 'anchor')
+        anchor.text = unicode(link_text)
+        if element.text:
+            anchor.tail = element.text
+            element.text = u''
+        element.insert(0, anchor)
+    
+    if with_target:
+        anchor_target = etree.Element('a', name='%s' % prefix)
+        anchor_target.set('class', 'target')
+        anchor_target.text = u' '
+        if element.text:
+            anchor_target.tail = element.text
+            element.text = u''
+        element.insert(0, anchor_target)
+
+
+def any_ancestor(element, test):
+    for ancestor in element.iterancestors():
+        if test(ancestor):
+            return True
+    return False
+
+
+def add_anchors(root):
+    counter = 1
+    for element in root.iterdescendants():
+        if any_ancestor(element, lambda e: e.get('class') in ('note', 'motto', 'motto_podpis', 'dedication')
+        or e.tag == 'blockquote'):
+            continue
+        
+        if element.tag == 'p' and 'verse' in element.get('class', ''):
+            if counter == 1 or counter % 5 == 0:
+                add_anchor(element, "f%d" % counter, link_text=counter)
+            counter += 1
+        elif 'paragraph' in element.get('class', ''):
+            add_anchor(element, "f%d" % counter, link_text=counter)
+            counter += 1
+
+
+def add_table_of_contents(root):
+    sections = []
+    counter = 1
+    for element in root.iterdescendants():
+        if element.tag in ('h2', 'h3'):
+            if any_ancestor(element, lambda e: e.get('id') in ('footnotes',) or e.get('class') in ('person-list',)):
+                continue
+            
+            if element.tag == 'h3' and len(sections) and sections[-1][1] == 'h2':
+                sections[-1][3].append((counter, element.tag, ''.join(element.xpath('text()')), []))
+            else:
+                sections.append((counter, element.tag, ''.join(element.xpath('text()')), []))
+            add_anchor(element, "s%d" % counter, with_link=False)
+            counter += 1
+    
+    toc = etree.Element('div')
+    toc.set('id', 'toc')
+    toc_header = etree.SubElement(toc, 'h2')
+    toc_header.text = u'Spis treści'
+    toc_list = etree.SubElement(toc, 'ol')
+
+    for n, section, text, subsections in sections:
+        section_element = etree.SubElement(toc_list, 'li')
+        add_anchor(section_element, "s%d" % n, with_target=False, link_text=text)
+        
+        if len(subsections):
+            subsection_list = etree.SubElement(section_element, 'ol')
+            for n, subsection, text, _ in subsections:
+                subsection_element = etree.SubElement(subsection_list, 'li')
+                add_anchor(subsection_element, "s%d" % n, with_target=False, link_text=text)
+    
+    root.insert(0, toc)
+