librarian/html.py

   1 # -*- coding: utf-8 -*-
   2 import os
   3 import cStringIO
   4 import re
   5 import copy
   6
   7 from lxml import etree
   8 from librarian.parser import WLDocument
   9
  10
  11 ENTITY_SUBSTITUTIONS = [
  12     (u'---', u'—'),
  13     (u'--', u'–'),
  14     (u'...', u'…'),
  15     (u',,', u'„'),
  16     (u'"', u'”'),
  17 ]
  18
  19
  20 def substitute_entities(context, text):
  21     """XPath extension function converting all entites in passed text."""
  22     if isinstance(text, list):
  23         text = ''.join(text)
  24     for entity, substitutution in ENTITY_SUBSTITUTIONS:
  25         text = text.replace(entity, substitutution)
  26     return text
  27
  28
  29 # Register substitute_entities function with lxml
  30 ns = etree.FunctionNamespace('http://wolnelektury.pl/functions')
  31 ns['substitute_entities'] = substitute_entities
  32
  33
  34 def transform(input, output_filename=None, is_file=True):
  35     """Transforms file input_filename in XML to output_filename in XHTML."""
  36     # Parse XSLT
  37     style_filename = os.path.join(os.path.dirname(__file__), 'book2html.xslt')
  38     style = etree.parse(style_filename)
  39
  40     if is_file:
  41         document = WLDocument.from_file(input, True)
  42     else:
  43         document = WLDocument.from_string(input, True)
  44
  45     result = document.transform(style)
  46     del document # no longer needed large object :)
  47
  48     if result.find('//p') is not None:
  49         add_anchors(result.getroot())
  50         add_table_of_contents(result.getroot())
  51
  52         if output_filename is not None:
  53             result.write(output_filename, xml_declaration=False, pretty_print=True, encoding='utf-8')
  54         else:
  55             return result
  56         return True
  57     else:
  58         return False
  59
  60
  61 class Fragment(object):
  62     def __init__(self, id, themes):
  63         super(Fragment, self).__init__()
  64         self.id = id
  65         self.themes = themes
  66         self.events = []
  67
  68     def append(self, event, element):
  69         self.events.append((event, element))
  70
  71     def closed_events(self):
  72         stack = []
  73         for event, element in self.events:
  74             if event == 'start':
  75                 stack.append(('end', element))
  76             elif event == 'end':
  77                 try:
  78                     stack.pop()
  79                 except IndexError:
  80                     print 'CLOSED NON-OPEN TAG:', element
  81
  82         stack.reverse()
  83         return self.events + stack
  84
  85     def to_string(self):
  86         result = []
  87         for event, element in self.closed_events():
  88             if event == 'start':
  89                 result.append(u'<%s %s>' % (element.tag, ' '.join('%s="%s"' % (k, v) for k, v in element.attrib.items())))
  90                 if element.text:
  91                     result.append(element.text)
  92             elif event == 'end':
  93                 result.append(u'</%s>' % element.tag)
  94                 if element.tail:
  95                     result.append(element.tail)
  96             else:
  97                 result.append(element)
  98
  99         return ''.join(result)
 100
 101     def __unicode__(self):
 102         return self.to_string()
 103
 104
 105 def extract_fragments(input_filename):
 106     """Extracts theme fragments from input_filename."""
 107     open_fragments = {}
 108     closed_fragments = {}
 109
 110     for event, element in etree.iterparse(input_filename, events=('start', 'end')):
 111         # Process begin and end elements
 112         if element.get('class', '') in ('theme-begin', 'theme-end'):
 113             if not event == 'end': continue # Process elements only once, on end event
 114
 115             # Open new fragment
 116             if element.get('class', '') == 'theme-begin':
 117                 fragment = Fragment(id=element.get('fid'), themes=element.text)
 118
 119                 # Append parents
 120                 if element.getparent().get('id', None) != 'book-text':
 121                     parents = [element.getparent()]
 122                     while parents[-1].getparent().get('id', None) != 'book-text':
 123                         parents.append(parents[-1].getparent())
 124
 125                     parents.reverse()
 126                     for parent in parents:
 127                         fragment.append('start', parent)
 128
 129                 open_fragments[fragment.id] = fragment
 130
 131             # Close existing fragment
 132             else:
 133                 try:
 134                     fragment = open_fragments[element.get('fid')]
 135                 except KeyError:
 136                     print '%s:closed not open fragment #%s' % (input_filename, element.get('fid'))
 137                 else:
 138                     closed_fragments[fragment.id] = fragment
 139                     del open_fragments[fragment.id]
 140
 141             # Append element tail to lost_text (we don't want to lose any text)
 142             if element.tail:
 143                 for fragment_id in open_fragments:
 144                     open_fragments[fragment_id].append('text', element.tail)
 145
 146
 147         # Process all elements except begin and end
 148         else:
 149             # Omit annotation tags
 150             if len(element.get('name', '')) or element.get('class', '') == 'annotation':
 151                 if event == 'end' and element.tail:
 152                     for fragment_id in open_fragments:
 153                         open_fragments[fragment_id].append('text', element.tail)
 154             else:
 155                 for fragment_id in open_fragments:
 156                     open_fragments[fragment_id].append(event, copy.copy(element))
 157
 158     return closed_fragments, open_fragments
 159
 160
 161 def add_anchor(element, prefix, with_link=True, with_target=True, link_text=None):
 162     if with_link:
 163         if link_text is None:
 164             link_text = prefix
 165         anchor = etree.Element('a', href='#%s' % prefix)
 166         anchor.set('class', 'anchor')
 167         anchor.text = unicode(link_text)
 168         if element.text:
 169             anchor.tail = element.text
 170             element.text = u''
 171         element.insert(0, anchor)
 172
 173     if with_target:
 174         anchor_target = etree.Element('a', name='%s' % prefix)
 175         anchor_target.set('class', 'target')
 176         anchor_target.text = u' '
 177         if element.text:
 178             anchor_target.tail = element.text
 179             element.text = u''
 180         element.insert(0, anchor_target)
 181
 182
 183 def any_ancestor(element, test):
 184     for ancestor in element.iterancestors():
 185         if test(ancestor):
 186             return True
 187     return False
 188
 189
 190 def add_anchors(root):
 191     counter = 1
 192     for element in root.iterdescendants():
 193         if any_ancestor(element, lambda e: e.get('class') in ('note', 'motto', 'motto_podpis', 'dedication')
 194         or e.tag == 'blockquote'):
 195             continue
 196
 197         if element.tag == 'p' and 'verse' in element.get('class', ''):
 198             if counter == 1 or counter % 5 == 0:
 199                 add_anchor(element, "f%d" % counter, link_text=counter)
 200             counter += 1
 201         elif 'paragraph' in element.get('class', ''):
 202             add_anchor(element, "f%d" % counter, link_text=counter)
 203             counter += 1
 204
 205
 206 def add_table_of_contents(root):
 207     sections = []
 208     counter = 1
 209     for element in root.iterdescendants():
 210         if element.tag in ('h2', 'h3'):
 211             if any_ancestor(element, lambda e: e.get('id') in ('footnotes',) or e.get('class') in ('person-list',)):
 212                 continue
 213
 214             if element.tag == 'h3' and len(sections) and sections[-1][1] == 'h2':
 215                 sections[-1][3].append((counter, element.tag, ''.join(element.xpath('text()')), []))
 216             else:
 217                 sections.append((counter, element.tag, ''.join(element.xpath('text()')), []))
 218             add_anchor(element, "s%d" % counter, with_link=False)
 219             counter += 1
 220
 221     toc = etree.Element('div')
 222     toc.set('id', 'toc')
 223     toc_header = etree.SubElement(toc, 'h2')
 224     toc_header.text = u'Spis treści'
 225     toc_list = etree.SubElement(toc, 'ol')
 226
 227     for n, section, text, subsections in sections:
 228         section_element = etree.SubElement(toc_list, 'li')
 229         add_anchor(section_element, "s%d" % n, with_target=False, link_text=text)
 230
 231         if len(subsections):
 232             subsection_list = etree.SubElement(section_element, 'ol')
 233             for n, subsection, text, _ in subsections:
 234                 subsection_element = etree.SubElement(subsection_list, 'li')
 235                 add_anchor(subsection_element, "s%d" % n, with_target=False, link_text=text)
 236
 237     root.insert(0, toc)
 238