1 # This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
2 # Copyright © Fundacja Wolne Lektury. See NOTICE for more information.
4 from collections import Counter
8 from xml.parsers.expat import ExpatError
10 from lxml.etree import XMLSyntaxError, XSLTApplyError
11 from librarian import ValidationError, NoDublinCore, ParseError, NoProvider
12 from librarian import RDFNS
13 from librarian.cover import make_cover
14 from librarian import dcparser
15 from .elements import WL_ELEMENTS
18 class WLElementLookup(etree.CustomElementClassLookup):
19 def lookup(self, node_type, document, namespace, name):
20 if node_type != 'element':
25 return WL_ELEMENTS[name]
30 parser = etree.XMLParser()
31 parser.set_element_class_lookup(
38 """Legacy class, to be replaced with documents.WLDocument."""
39 LINE_SWAP_EXPR = re.compile(r'/\s', re.MULTILINE | re.UNICODE)
42 def __init__(self, edoc, parse_dublincore=True, provider=None,
43 strict=False, meta_fallbacks=None):
45 self.provider = provider
47 root_elem = edoc.getroot()
49 dc_path = './/' + RDFNS('RDF')
51 if root_elem.tag != 'utwor':
52 raise ValidationError(
53 "Invalid root element. Found '%s', should be 'utwor'"
58 self.rdf_elem = root_elem.find(dc_path)
60 if self.rdf_elem is None:
62 "Document must have a '%s' element." % RDFNS('RDF')
65 self.book_info = dcparser.BookInfo.from_element(
66 self.rdf_elem, fallbacks=meta_fallbacks, strict=strict)
71 def from_bytes(cls, xml, *args, **kwargs):
72 return cls.from_file(io.BytesIO(xml), *args, **kwargs)
75 def from_file(cls, xmlfile, *args, **kwargs):
77 # first, prepare for parsing
78 if isinstance(xmlfile, str):
79 file = open(xmlfile, 'rb')
87 if not isinstance(data, str):
88 data = data.decode('utf-8')
90 data = data.replace('\ufeff', '')
93 parser = etree.XMLParser(remove_blank_text=False)
94 tree = etree.parse(io.BytesIO(data.encode('utf-8')), parser)
96 return cls(tree, *args, **kwargs)
97 except (ExpatError, XMLSyntaxError, XSLTApplyError) as e:
100 def swap_endlines(self):
101 """Converts line breaks in stanzas into <br/> tags."""
102 # only swap inside stanzas
103 for elem in self.edoc.iter('strofa'):
104 for child in list(elem):
106 chunks = self.LINE_SWAP_EXPR.split(child.tail)
107 ins_index = elem.index(child) + 1
108 while len(chunks) > 1:
109 ins = etree.Element('br')
110 ins.tail = chunks.pop()
111 elem.insert(ins_index, ins)
112 child.tail = chunks.pop(0)
114 chunks = self.LINE_SWAP_EXPR.split(elem.text)
115 while len(chunks) > 1:
116 ins = etree.Element('br')
117 ins.tail = chunks.pop()
119 elem.text = chunks.pop(0)
121 def parts(self, pass_part_errors=False):
122 if self.provider is None:
123 raise NoProvider('No document provider supplied.')
124 if self.book_info is None:
125 raise NoDublinCore('No Dublin Core in document.')
126 for part_uri in self.book_info.parts:
128 with self.provider.by_slug(part_uri.slug) as f:
129 yield self.from_file(f, provider=self.provider)
130 except Exception as e:
136 def chunk(self, path):
137 # convert the path to XPath
138 expr = self.path_to_xpath(path)
139 elems = self.edoc.xpath(expr)
146 def path_to_xpath(self, path):
149 for part in path.split('/'):
150 match = re.match(r'([^\[]+)\[(\d+)\]', part)
154 tag, n = match.groups()
155 parts.append("*[%d][name() = '%s']" % (int(n)+1, tag))
160 return '/'.join(parts)
162 def transform(self, stylesheet, **options):
163 return self.edoc.xslt(stylesheet, **options)
167 parent = self.rdf_elem.getparent()
168 parent.replace(self.rdf_elem, self.book_info.to_etree(parent))
172 return etree.tostring(self.edoc, encoding='unicode', pretty_print=True)
174 def merge_chunks(self, chunk_dict):
177 for key, data in chunk_dict.iteritems():
179 xpath = self.path_to_xpath(key)
180 node = self.edoc.xpath(xpath)[0]
181 repl = etree.fromstring(
182 "<%s>%s</%s>" % (node.tag, data, node.tag)
184 node.getparent().replace(node, repl)
185 except Exception as e:
186 unmerged.append(repr((key, xpath, e)))
190 def clean_ed_note(self, note_tag='nota_red'):
191 """ deletes forbidden tags from nota_red """
193 for node in self.edoc.xpath('|'.join(
194 '//%s//%s' % (note_tag, tag) for tag in
195 ('pa', 'pe', 'pr', 'pt', 'begin', 'end', 'motyw'))):
201 def fix_pa_akap(self):
202 for pa in ('pa','pe','pr','pt'):
203 for akap in self.edoc.findall(f'//{pa}/akap'):
204 akap.getparent().set('blocks', 'true')
205 if not akap.getparent().index(akap):
206 akap.set('inline', 'true')
209 """Returns a set of all editors for book and its children.
211 :returns: set of dcparser.Person objects
213 if self.book_info is None:
214 raise NoDublinCore('No Dublin Core in document.')
215 persons = set(self.book_info.editors
216 + self.book_info.technical_editors)
217 for child in self.parts():
218 persons.update(child.editors())
225 def as_html(self, *args, **kwargs):
226 from librarian import html
227 return html.transform(self, *args, **kwargs)
229 def as_text(self, *args, **kwargs):
230 from librarian import text
231 return text.transform(self, *args, **kwargs)
233 def as_pdf(self, *args, **kwargs):
234 from librarian import pdf
235 return pdf.transform(self, *args, **kwargs)
237 def as_fb2(self, *args, **kwargs):
238 from librarian import fb2
239 return fb2.transform(self, *args, **kwargs)
241 def as_cover(self, cover_class=None, *args, **kwargs):
242 if cover_class is None:
243 cover_class = make_cover
244 return cover_class(self.book_info, *args, **kwargs).output_file()
247 def latex_dir(self, *args, **kwargs):
248 kwargs['latex_dir'] = True
249 from librarian import pdf
250 return pdf.transform(self, *args, **kwargs)
252 def save_output_file(self, output_file, output_path=None,
253 output_dir_path=None, make_author_dir=False,
256 save_path = output_dir_path
258 save_path = os.path.join(
260 str(self.book_info.author).encode('utf-8')
262 save_path = os.path.join(save_path, self.book_info.url.slug)
264 save_path += '.%s' % ext
266 save_path = output_path
268 output_file.save_as(save_path)