fnp / librarian.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
some cleanup
[librarian.git] / librarian / html.py
diff --git a/librarian/html.py b/librarian/html.py
index b279e5d..92fc134 100644 (file)
--- a/librarian/html.py
+++ b/librarian/html.py
@@ -1,12 +1,18 @@
 # -*- coding: utf-8 -*-
 # -*- 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.
+#
 import os
 import cStringIO
 import re
 import copy
 import os
 import cStringIO
 import re
 import copy
-import pkgutil
 
 from lxml import etree
 
 from lxml import etree
+from librarian.parser import WLDocument
+from librarian import XHTMLNS, ParseError
 
 
+from lxml.etree import XMLSyntaxError, XSLTApplyError
 
 ENTITY_SUBSTITUTIONS = [
     (u'---', u'—'),
 
 ENTITY_SUBSTITUTIONS = [
     (u'---', u'—'),
@@ -16,6 +22,14 @@ ENTITY_SUBSTITUTIONS = [
     (u'"', u'”'),
 ]
 
     (u'"', u'”'),
 ]
 
+STYLESHEETS = {
+    'legacy': 'xslt/book2html.xslt',
+    'full': 'xslt/wl2html_full.xslt',
+    'partial': 'xslt/wl2html_partial.xslt'
+}
+
+def get_stylesheet(name):
+    return os.path.join(os.path.dirname(__file__), STYLESHEETS[name])
 
 def substitute_entities(context, text):
     """XPath extension function converting all entites in passed text."""
 
 def substitute_entities(context, text):
     """XPath extension function converting all entites in passed text."""
@@ -25,42 +39,54 @@ def substitute_entities(context, text):
         text = text.replace(entity, substitutution)
     return text
 
         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
 
 # Register substitute_entities function with lxml
 ns = etree.FunctionNamespace('http://wolnelektury.pl/functions')
 ns['substitute_entities'] = substitute_entities
 
+def html_has_content(text):
+    return etree.ETXPath('//p|//{%(ns)s}p|//h1|//{%(ns)s}h1' % {'ns': str(XHTMLNS)})(text)
 
 
-def transform(input_filename, output_filename):
-    """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);
+def transform(input, output_filename=None, is_file=True, \
+    parse_dublincore=True, stylesheet='legacy', options={}):
+    """Transforms file input_filename in XML to output_filename in XHTML.
 
 
-    f = open(input_filename, 'r')
-    for line in f:
-        line = line.decode('utf-8')
-        line = expr.sub(u'<br/>\n', line)
-        doc_file.write(line.encode('utf-8'))
-    f.close()
+    If output_filename is None, returns an XML,
+    otherwise returns True if file has been written,False if it hasn't.
+    File won't be written if it has no content.
+    """
+    # Parse XSLT
+    try:
+        style_filename = get_stylesheet(stylesheet)
+        style = etree.parse(style_filename)
 
 
-    doc_file.seek(0);
+        if is_file:
+            document = WLDocument.from_file(input, True, \
+                parse_dublincore=parse_dublincore)
+        else:
+            document = WLDocument.from_string(input, True, \
+                parse_dublincore=parse_dublincore)
 
 
-    parser = etree.XMLParser(remove_blank_text=True)
-    doc = etree.parse(doc_file, parser)
+        result = document.transform(style, **options)
+        del document # no longer needed large object :)
 
 
-    result = doc.xslt(style)
-    if result.find('//p') is not None:
-        add_anchors(result.getroot())
-        add_table_of_contents(result.getroot())
-        result.write(output_filename, xml_declaration=False, pretty_print=True, encoding='utf-8')
-        return True
-    else:
-        return False
+        if html_has_content(result):
+            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:
+            if output_filename is not None:
+                return False
+            else:
+                return "<empty />"
+    except KeyError:
+        raise ValueError("'%s' is not a valid stylesheet.")
+    except (XMLSyntaxError, XSLTApplyError), e:
+        raise ParseError(e)
 
 class Fragment(object):
     def __init__(self, id, themes):
 
 class Fragment(object):
     def __init__(self, id, themes):
@@ -173,7 +199,7 @@ def add_anchor(element, prefix, with_link=True, with_target=True, link_text=None
             anchor.tail = element.text
             element.text = u''
         element.insert(0, anchor)
             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')
     if with_target:
         anchor_target = etree.Element('a', name='%s' % prefix)
         anchor_target.set('class', 'target')
@@ -197,7 +223,7 @@ def add_anchors(root):
         if any_ancestor(element, lambda e: e.get('class') in ('note', 'motto', 'motto_podpis', 'dedication')
         or e.tag == 'blockquote'):
             continue
         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)
         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)
@@ -214,14 +240,14 @@ def add_table_of_contents(root):
         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 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
             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 = etree.Element('div')
     toc.set('id', 'toc')
     toc_header = etree.SubElement(toc, 'h2')
@@ -231,12 +257,12 @@ def add_table_of_contents(root):
     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)
     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)
         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)
 
     root.insert(0, toc)