b279e5dd54c0922ee0b705701029420995ee52bb
[librarian.git] / librarian / html.py
1 # -*- coding: utf-8 -*-
2 import os
3 import cStringIO
4 import re
5 import copy
6 import pkgutil
7
8 from lxml import etree
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_filename, output_filename):
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     doc_file = cStringIO.StringIO()
41     expr = re.compile(r'/\s', re.MULTILINE | re.UNICODE);
42
43     f = open(input_filename, 'r')
44     for line in f:
45         line = line.decode('utf-8')
46         line = expr.sub(u'<br/>\n', line)
47         doc_file.write(line.encode('utf-8'))
48     f.close()
49
50     doc_file.seek(0);
51
52     parser = etree.XMLParser(remove_blank_text=True)
53     doc = etree.parse(doc_file, parser)
54
55     result = doc.xslt(style)
56     if result.find('//p') is not None:
57         add_anchors(result.getroot())
58         add_table_of_contents(result.getroot())
59         result.write(output_filename, xml_declaration=False, pretty_print=True, encoding='utf-8')
60         return True
61     else:
62         return False
63
64
65 class Fragment(object):
66     def __init__(self, id, themes):
67         super(Fragment, self).__init__()
68         self.id = id
69         self.themes = themes
70         self.events = []
71
72     def append(self, event, element):
73         self.events.append((event, element))
74
75     def closed_events(self):
76         stack = []
77         for event, element in self.events:
78             if event == 'start':
79                 stack.append(('end', element))
80             elif event == 'end':
81                 try:
82                     stack.pop()
83                 except IndexError:
84                     print 'CLOSED NON-OPEN TAG:', element
85
86         stack.reverse()
87         return self.events + stack
88
89     def to_string(self):
90         result = []
91         for event, element in self.closed_events():
92             if event == 'start':
93                 result.append(u'<%s %s>' % (element.tag, ' '.join('%s="%s"' % (k, v) for k, v in element.attrib.items())))
94                 if element.text:
95                     result.append(element.text)
96             elif event == 'end':
97                 result.append(u'</%s>' % element.tag)
98                 if element.tail:
99                     result.append(element.tail)
100             else:
101                 result.append(element)
102
103         return ''.join(result)
104
105     def __unicode__(self):
106         return self.to_string()
107
108
109 def extract_fragments(input_filename):
110     """Extracts theme fragments from input_filename."""
111     open_fragments = {}
112     closed_fragments = {}
113
114     for event, element in etree.iterparse(input_filename, events=('start', 'end')):
115         # Process begin and end elements
116         if element.get('class', '') in ('theme-begin', 'theme-end'):
117             if not event == 'end': continue # Process elements only once, on end event
118
119             # Open new fragment
120             if element.get('class', '') == 'theme-begin':
121                 fragment = Fragment(id=element.get('fid'), themes=element.text)
122
123                 # Append parents
124                 if element.getparent().get('id', None) != 'book-text':
125                     parents = [element.getparent()]
126                     while parents[-1].getparent().get('id', None) != 'book-text':
127                         parents.append(parents[-1].getparent())
128
129                     parents.reverse()
130                     for parent in parents:
131                         fragment.append('start', parent)
132
133                 open_fragments[fragment.id] = fragment
134
135             # Close existing fragment
136             else:
137                 try:
138                     fragment = open_fragments[element.get('fid')]
139                 except KeyError:
140                     print '%s:closed not open fragment #%s' % (input_filename, element.get('fid'))
141                 else:
142                     closed_fragments[fragment.id] = fragment
143                     del open_fragments[fragment.id]
144
145             # Append element tail to lost_text (we don't want to lose any text)
146             if element.tail:
147                 for fragment_id in open_fragments:
148                     open_fragments[fragment_id].append('text', element.tail)
149
150
151         # Process all elements except begin and end
152         else:
153             # Omit annotation tags
154             if len(element.get('name', '')) or element.get('class', '') == 'annotation':
155                 if event == 'end' and element.tail:
156                     for fragment_id in open_fragments:
157                         open_fragments[fragment_id].append('text', element.tail)
158             else:
159                 for fragment_id in open_fragments:
160                     open_fragments[fragment_id].append(event, copy.copy(element))
161
162     return closed_fragments, open_fragments
163
164
165 def add_anchor(element, prefix, with_link=True, with_target=True, link_text=None):
166     if with_link:
167         if link_text is None:
168             link_text = prefix
169         anchor = etree.Element('a', href='#%s' % prefix)
170         anchor.set('class', 'anchor')
171         anchor.text = unicode(link_text)
172         if element.text:
173             anchor.tail = element.text
174             element.text = u''
175         element.insert(0, anchor)
176     
177     if with_target:
178         anchor_target = etree.Element('a', name='%s' % prefix)
179         anchor_target.set('class', 'target')
180         anchor_target.text = u' '
181         if element.text:
182             anchor_target.tail = element.text
183             element.text = u''
184         element.insert(0, anchor_target)
185
186
187 def any_ancestor(element, test):
188     for ancestor in element.iterancestors():
189         if test(ancestor):
190             return True
191     return False
192
193
194 def add_anchors(root):
195     counter = 1
196     for element in root.iterdescendants():
197         if any_ancestor(element, lambda e: e.get('class') in ('note', 'motto', 'motto_podpis', 'dedication')
198         or e.tag == 'blockquote'):
199             continue
200         
201         if element.tag == 'p' and 'verse' in element.get('class', ''):
202             if counter == 1 or counter % 5 == 0:
203                 add_anchor(element, "f%d" % counter, link_text=counter)
204             counter += 1
205         elif 'paragraph' in element.get('class', ''):
206             add_anchor(element, "f%d" % counter, link_text=counter)
207             counter += 1
208
209
210 def add_table_of_contents(root):
211     sections = []
212     counter = 1
213     for element in root.iterdescendants():
214         if element.tag in ('h2', 'h3'):
215             if any_ancestor(element, lambda e: e.get('id') in ('footnotes',) or e.get('class') in ('person-list',)):
216                 continue
217             
218             if element.tag == 'h3' and len(sections) and sections[-1][1] == 'h2':
219                 sections[-1][3].append((counter, element.tag, ''.join(element.xpath('text()')), []))
220             else:
221                 sections.append((counter, element.tag, ''.join(element.xpath('text()')), []))
222             add_anchor(element, "s%d" % counter, with_link=False)
223             counter += 1
224     
225     toc = etree.Element('div')
226     toc.set('id', 'toc')
227     toc_header = etree.SubElement(toc, 'h2')
228     toc_header.text = u'Spis treści'
229     toc_list = etree.SubElement(toc, 'ol')
230
231     for n, section, text, subsections in sections:
232         section_element = etree.SubElement(toc_list, 'li')
233         add_anchor(section_element, "s%d" % n, with_target=False, link_text=text)
234         
235         if len(subsections):
236             subsection_list = etree.SubElement(section_element, 'ol')
237             for n, subsection, text, _ in subsections:
238                 subsection_element = etree.SubElement(subsection_list, 'li')
239                 add_anchor(subsection_element, "s%d" % n, with_target=False, link_text=text)
240     
241     root.insert(0, toc)
242