librarian/pdf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # This file is part of Librarian, licensed under GNU Affero GPLv3 or later.
   4 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   5 #
   6 from __future__ import with_statement
   7 import os
   8 import os.path
   9 import shutil
  10 from StringIO import StringIO
  11 from tempfile import mkdtemp, NamedTemporaryFile
  12 import re
  13 from copy import deepcopy
  14 from subprocess import call, PIPE
  15
  16 from Texml.processor import process
  17 from lxml import etree
  18 from lxml.etree import XMLSyntaxError, XSLTApplyError
  19
  20 from librarian.dcparser import Person
  21 from librarian.parser import WLDocument
  22 from librarian import ParseError, DCNS, get_resource, OutputFile
  23 from librarian import functions
  24 from librarian.cover import ImageCover as WLCover
  25
  26
  27 functions.reg_substitute_entities()
  28 functions.reg_strip()
  29 functions.reg_starts_white()
  30 functions.reg_ends_white()
  31 functions.reg_texcommand()
  32
  33 STYLESHEETS = {
  34     'wl2tex': 'pdf/wl2tex.xslt',
  35 }
  36
  37 #CUSTOMIZATIONS = [
  38 #    'nofootnotes',
  39 #    'nothemes',
  40 #    'defaultleading',
  41 #    'onehalfleading',
  42 #    'doubleleading',
  43 #    'nowlfont',
  44 #    ]
  45
  46 def insert_tags(doc, split_re, tagname, exclude=None):
  47     """ inserts <tagname> for every occurence of `split_re' in text nodes in the `doc' tree
  48
  49     >>> t = etree.fromstring('<a><b>A-B-C</b>X-Y-Z</a>');
  50     >>> insert_tags(t, re.compile('-'), 'd');
  51     >>> print etree.tostring(t)
  52     <a><b>A<d/>B<d/>C</b>X<d/>Y<d/>Z</a>
  53     """
  54
  55     for elem in doc.iter(tag=etree.Element):
  56         if exclude and elem.tag in exclude:
  57             continue
  58         if elem.text:
  59             chunks = split_re.split(elem.text)
  60             while len(chunks) > 1:
  61                 ins = etree.Element(tagname)
  62                 ins.tail = chunks.pop()
  63                 elem.insert(0, ins)
  64             elem.text = chunks.pop(0)
  65         if elem.tail:
  66             chunks = split_re.split(elem.tail)
  67             parent = elem.getparent()
  68             ins_index = parent.index(elem) + 1
  69             while len(chunks) > 1:
  70                 ins = etree.Element(tagname)
  71                 ins.tail = chunks.pop()
  72                 parent.insert(ins_index, ins)
  73             elem.tail = chunks.pop(0)
  74
  75
  76 def substitute_hyphens(doc):
  77     insert_tags(doc,
  78                 re.compile("(?<=[^-\s])-(?=[^-\s])"),
  79                 "dywiz",
  80                 exclude=[DCNS("identifier.url"), DCNS("rights.license")]
  81                 )
  82
  83
  84 def fix_hanging(doc):
  85     insert_tags(doc,
  86                 re.compile("(?<=\s\w)\s+"),
  87                 "nbsp",
  88                 exclude=[DCNS("identifier.url"), DCNS("rights.license")]
  89                 )
  90
  91
  92 def move_motifs_inside(doc):
  93     """ moves motifs to be into block elements """
  94     for master in doc.xpath('//powiesc|//opowiadanie|//liryka_l|//liryka_lp|//dramat_wierszowany_l|//dramat_wierszowany_lp|//dramat_wspolczesny'):
  95         for motif in master.xpath('motyw'):
  96             for sib in motif.itersiblings():
  97                 if sib.tag not in ('sekcja_swiatlo', 'sekcja_asterysk', 'separator_linia', 'begin', 'end', 'motyw', 'extra', 'uwaga'):
  98                     # motif shouldn't have a tail - it would be untagged text
  99                     motif.tail = None
 100                     motif.getparent().remove(motif)
 101                     sib.insert(0, motif)
 102                     break
 103
 104
 105 def hack_motifs(doc):
 106     """ dirty hack for the marginpar-creates-orphans LaTeX problem
 107     see http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/2304
 108
 109     moves motifs in stanzas from first verse to second
 110     and from next to last to last, then inserts negative vspace before them
 111     """
 112     for motif in doc.findall('//strofa//motyw'):
 113         # find relevant verse-level tag
 114         verse, stanza = motif, motif.getparent()
 115         while stanza is not None and stanza.tag != 'strofa':
 116             verse, stanza = stanza, stanza.getparent()
 117         breaks_before = sum(1 for i in verse.itersiblings('br', preceding=True))
 118         breaks_after = sum(1 for i in verse.itersiblings('br'))
 119         if (breaks_before == 0 and breaks_after > 0) or breaks_after == 1:
 120             move_by = 1
 121             if breaks_after == 2:
 122                 move_by += 1
 123             moved_motif = deepcopy(motif)
 124             motif.tag = 'span'
 125             motif.text = None
 126             moved_motif.tail = None
 127             moved_motif.set('moved', str(move_by))
 128
 129             for br in verse.itersiblings('br'):
 130                 if move_by > 1:
 131                     move_by -= 1
 132                     continue
 133                 br.addnext(moved_motif)
 134                 break
 135
 136
 137 def parse_creator(doc):
 138     """ find all dc:creator and dc.contributor tags and add *_parsed versions with forenames first """
 139     for person in doc.xpath("|".join('//dc:'+(tag) for tag in (
 140                     'creator', 'contributor.translator', 'contributor.editor', 'contributor.technical_editor')),
 141                     namespaces = {'dc': str(DCNS)})[::-1]:
 142         if not person.text:
 143             continue
 144         p = Person.from_text(person.text)
 145         person_parsed = deepcopy(person)
 146         person_parsed.tag = person.tag + '_parsed'
 147         person_parsed.set('sortkey', person.text)
 148         person_parsed.text = p.readable()
 149         person.getparent().insert(0, person_parsed)
 150
 151
 152 def get_stylesheet(name):
 153     return get_resource(STYLESHEETS[name])
 154
 155
 156 def package_available(package, args='', verbose=False):
 157     """ check if a verion of a latex package accepting given args is available """
 158     tempdir = mkdtemp('-wl2pdf-test')
 159     fpath = os.path.join(tempdir, 'test.tex')
 160     f = open(fpath, 'w')
 161     f.write(r"""
 162         \documentclass{wl}
 163         \usepackage[%s]{%s}
 164         \begin{document}
 165         \end{document}
 166         """ % (args, package))
 167     f.close()
 168     if verbose:
 169         p = call(['xelatex', '-output-directory', tempdir, fpath])
 170     else:
 171         p = call(['xelatex', '-interaction=batchmode', '-output-directory', tempdir, fpath], stdout=PIPE, stderr=PIPE)
 172     shutil.rmtree(tempdir)
 173     return p == 0
 174
 175
 176 def transform(wldoc, verbose=False, save_tex=None, morefloats=None,
 177               cover=None, flags=None, customizations=None,
 178               imgdir=""):
 179     """ produces a PDF file with XeLaTeX
 180
 181     wldoc: a WLDocument
 182     verbose: prints all output from LaTeX
 183     save_tex: path to save the intermediary LaTeX file to
 184     morefloats (old/new/none): force specific morefloats
 185     cover: a cover.Cover object
 186     flags: less-advertising,
 187     customizations: user requested customizations regarding various formatting parameters (passed to wl LaTeX class)
 188     """
 189
 190     # Parse XSLT
 191     try:
 192         document = load_including_children(wldoc)
 193
 194         if cover:
 195             if cover is True:
 196                 cover = WLCover
 197             the_cover = cover(document.book_info)
 198             document.edoc.getroot().set('data-cover-width', str(the_cover.width))
 199             document.edoc.getroot().set('data-cover-height', str(the_cover.height))
 200             if the_cover.uses_dc_cover:
 201                 if document.book_info.cover_by:
 202                     document.edoc.getroot().set('data-cover-by', document.book_info.cover_by)
 203                 if document.book_info.cover_source:
 204                     document.edoc.getroot().set('data-cover-source', document.book_info.cover_source)
 205         if flags:
 206             for flag in flags:
 207                 document.edoc.getroot().set('flag-' + flag, 'yes')
 208
 209         # check for LaTeX packages
 210         if morefloats:
 211             document.edoc.getroot().set('morefloats', morefloats.lower())
 212         elif package_available('morefloats', 'maxfloats=19'):
 213             document.edoc.getroot().set('morefloats', 'new')
 214
 215         # add customizations
 216         if customizations is not None:
 217             document.edoc.getroot().set('customizations', u','.join(customizations))
 218
 219         # hack the tree
 220         #move_motifs_inside(document.edoc)
 221         #hack_motifs(document.edoc)
 222         parse_creator(document.edoc)
 223         if document.book_info.language == 'pol':
 224             substitute_hyphens(document.edoc)
 225         fix_hanging(document.edoc)
 226
 227         # wl -> TeXML
 228         style_filename = get_stylesheet("wl2tex")
 229         style = etree.parse(style_filename)
 230
 231         texml = document.transform(style)
 232         etree.dump(texml.getroot())
 233         # TeXML -> LaTeX
 234         temp = mkdtemp('-wl2pdf')
 235
 236         if cover:
 237             with open(os.path.join(temp, 'cover.jpg'), 'w') as f:
 238                 the_cover.save(f)
 239
 240         for img in document.edoc.findall('//ilustr'):
 241             shutil.copy(os.path.join(imgdir, img.get('src')), temp)
 242
 243
 244         del document # no longer needed large object :)
 245
 246         tex_path = os.path.join(temp, 'doc.tex')
 247         fout = open(tex_path, 'w')
 248         process(StringIO(texml), fout, 'utf-8')
 249         fout.close()
 250         del texml
 251
 252         if save_tex:
 253             shutil.copy(tex_path, save_tex)
 254
 255         # LaTeX -> PDF
 256         shutil.copy(get_resource('pdf/wl.cls'), temp)
 257         shutil.copy(get_resource('res/wl-logo.png'), temp)
 258         shutil.copy('logo.eps', temp)
 259
 260         cwd = os.getcwd()
 261         os.chdir(temp)
 262
 263         if verbose:
 264             p = call(['xelatex', tex_path])
 265         else:
 266             p = call(['xelatex', '-interaction=batchmode', tex_path], stdout=PIPE, stderr=PIPE)
 267         if p:
 268             raise ParseError("Error parsing .tex file")
 269
 270         os.chdir(cwd)
 271
 272         output_file = NamedTemporaryFile(prefix='librarian', suffix='.pdf', delete=False)
 273         pdf_path = os.path.join(temp, 'doc.pdf')
 274         shutil.move(pdf_path, output_file.name)
 275         shutil.rmtree(temp)
 276         return OutputFile.from_filename(output_file.name)
 277
 278     except (XMLSyntaxError, XSLTApplyError), e:
 279         print e
 280         raise ParseError(e)
 281
 282
 283 def load_including_children(wldoc=None, provider=None, uri=None):
 284     """ Makes one big xml file with children inserted at end.
 285
 286     Either wldoc or provider and URI must be provided.
 287     """
 288
 289     if uri and provider:
 290         f = provider.by_uri(uri)
 291         text = f.read().decode('utf-8')
 292         f.close()
 293     elif wldoc is not None:
 294         text = etree.tostring(wldoc.edoc, encoding=unicode)
 295         provider = wldoc.provider
 296     else:
 297         raise ValueError('Neither a WLDocument, nor provider and URI were provided.')
 298
 299     text = re.sub(ur"([\u0400-\u04ff]+)", ur"<alien>\1</alien>", text)
 300
 301     document = WLDocument.from_string(text, parse_dublincore=True)
 302     document.swap_endlines()
 303
 304     for child_uri in document.book_info.parts:
 305         child = load_including_children(provider=provider, uri=child_uri)
 306         document.edoc.getroot().append(child.edoc.getroot())
 307     return document