paul@0 | 1 | # -*- coding: iso-8859-1 -*- |
paul@0 | 2 | """ |
paul@0 | 3 | MoinMoin - Export as PDF action |
paul@0 | 4 | |
paul@0 | 5 | @copyright: 2013 by Paul Boddie <paul@boddie.org.uk> |
paul@0 | 6 | @license: GNU GPL (v2 or later), see COPYING.txt for details. |
paul@0 | 7 | """ |
paul@0 | 8 | |
paul@0 | 9 | from MoinMoin.action import ActionBase |
paul@0 | 10 | from MoinMoin.wikiutil import escape |
paul@0 | 11 | from MoinSupport import ActionSupport, escattr, getFormatterClass, formatText, get_send_headers |
paul@0 | 12 | from os.path import join |
paul@0 | 13 | import subprocess |
paul@0 | 14 | |
paul@0 | 15 | __version__ = "0.1" |
paul@0 | 16 | |
paul@0 | 17 | Dependencies = ['page'] |
paul@0 | 18 | |
paul@0 | 19 | # Configuration settings. |
paul@0 | 20 | |
paul@0 | 21 | XSLT_PROCESSOR = "/usr/bin/xsltproc" |
paul@0 | 22 | FO_PROCESSOR = "/usr/bin/fop" |
paul@0 | 23 | DOCBOOK_STYLESHEET_BASE = "/usr/share/xml/docbook/stylesheet" |
paul@0 | 24 | |
paul@0 | 25 | # Tool settings. |
paul@0 | 26 | |
paul@0 | 27 | DOCBOOK_TO_FO_STYLESHEET = "docbook-xsl/fo/docbook.xsl" |
paul@0 | 28 | |
paul@0 | 29 | # NOTE: From docbook-xsl/fo/param.xsl. |
paul@0 | 30 | |
paul@0 | 31 | paper_sizes = [ |
paul@0 | 32 | "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", |
paul@0 | 33 | "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7", "B8", "B9", "B10", |
paul@0 | 34 | "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7", "C8", "C9", "C10", |
paul@0 | 35 | "A4landscape", "USletter", "USlandscape", "4A0", "2A0", |
paul@0 | 36 | ] |
paul@0 | 37 | |
paul@0 | 38 | paper_size_labels = { |
paul@0 | 39 | "A4landscape" : "A4 landscape", |
paul@0 | 40 | "USletter" : "US letter", |
paul@0 | 41 | "USlandscape" : "US landscape", |
paul@0 | 42 | "4A0" : "Quadruple A0", |
paul@0 | 43 | "2A0" : "Double A0" |
paul@0 | 44 | } |
paul@0 | 45 | |
paul@0 | 46 | class ExportPDF(ActionBase, ActionSupport): |
paul@0 | 47 | |
paul@0 | 48 | "Export the current page as PDF." |
paul@0 | 49 | |
paul@0 | 50 | def get_form_html(self, buttons_html): |
paul@0 | 51 | |
paul@0 | 52 | "Return the action's form incorporating the 'buttons_html'." |
paul@0 | 53 | |
paul@0 | 54 | _ = self._ |
paul@0 | 55 | request = self.request |
paul@0 | 56 | form = self.get_form() |
paul@0 | 57 | |
paul@0 | 58 | paper_size = form.get("paper-size", ["A4"])[0] |
paul@0 | 59 | |
paul@0 | 60 | paper_size_options = [] |
paul@0 | 61 | |
paul@0 | 62 | for size in paper_sizes: |
paul@0 | 63 | paper_size_options.append('<option value="%s" %s>%s</option>' % ( |
paul@0 | 64 | escattr(size), self._get_selected(size, paper_size), |
paul@0 | 65 | escape(_(paper_size_labels.get(size) or size)) |
paul@0 | 66 | )) |
paul@0 | 67 | |
paul@0 | 68 | d = { |
paul@0 | 69 | "paper_size_label" : escape(_("Paper size")), |
paul@0 | 70 | "paper_size_options" : u"".join(paper_size_options), |
paul@0 | 71 | "buttons_html" : buttons_html, |
paul@0 | 72 | } |
paul@0 | 73 | |
paul@0 | 74 | return u"""\ |
paul@0 | 75 | <table> |
paul@0 | 76 | <tr> |
paul@0 | 77 | <td class="label"><label>%(paper_size_label)s</label></td> |
paul@0 | 78 | <td><select name="paper-size">%(paper_size_options)s</select></td> |
paul@0 | 79 | </tr> |
paul@0 | 80 | <tr> |
paul@0 | 81 | <td></td> |
paul@0 | 82 | <td class="buttons">%(buttons_html)s</td> |
paul@0 | 83 | </tr> |
paul@0 | 84 | </table> |
paul@0 | 85 | """ % d |
paul@0 | 86 | |
paul@0 | 87 | def do_action(self): |
paul@0 | 88 | |
paul@0 | 89 | "Attempt to post a comment." |
paul@0 | 90 | |
paul@0 | 91 | _ = self._ |
paul@0 | 92 | request = self.request |
paul@0 | 93 | form = self.get_form() |
paul@0 | 94 | page = self.page |
paul@0 | 95 | |
paul@0 | 96 | paper_size = form.get("paper-size", [""])[0] |
paul@0 | 97 | |
paul@0 | 98 | if not paper_size in paper_sizes: |
paul@0 | 99 | return 0, _("A paper size must be chosen.") |
paul@0 | 100 | |
paul@0 | 101 | # Get the page in DocBook format. |
paul@0 | 102 | |
paul@0 | 103 | fmt = getFormatterClass(request, "text_docbook")(request) |
paul@0 | 104 | fmt.setPage(page) |
paul@0 | 105 | |
paul@0 | 106 | # The DocBook formatter needs to pretend a full document is being made. |
paul@0 | 107 | |
paul@0 | 108 | page_as_docbook = [] |
paul@0 | 109 | append = page_as_docbook.append |
paul@0 | 110 | |
paul@0 | 111 | append(fmt.startDocument(page.page_name)) |
paul@0 | 112 | append(fmt.startContent()) |
paul@0 | 113 | append(formatText(page.get_raw_body(), request, fmt, inhibit_p=False).encode("utf-8")) |
paul@0 | 114 | append(fmt.endContent()) |
paul@0 | 115 | append(fmt.endDocument()) |
paul@0 | 116 | |
paul@0 | 117 | # Send the DocBook XML to the XSLT processor. |
paul@0 | 118 | |
paul@0 | 119 | p1 = subprocess.Popen([ |
paul@0 | 120 | XSLT_PROCESSOR, |
paul@0 | 121 | "-stringparam", "fop1.extensions", "1", |
paul@0 | 122 | "--stringparam", "paper.type", paper_size, |
paul@0 | 123 | join(DOCBOOK_STYLESHEET_BASE, DOCBOOK_TO_FO_STYLESHEET), |
paul@0 | 124 | "-" |
paul@0 | 125 | ], |
paul@0 | 126 | shell=False, |
paul@0 | 127 | stdin=subprocess.PIPE, |
paul@0 | 128 | stdout=subprocess.PIPE, |
paul@0 | 129 | stderr=subprocess.PIPE) |
paul@0 | 130 | |
paul@0 | 131 | p1.stdin.write("".join(page_as_docbook)) |
paul@0 | 132 | p1.stdin.close() |
paul@0 | 133 | |
paul@0 | 134 | # Pipe the XML-FO output to the FO processor. |
paul@0 | 135 | |
paul@0 | 136 | p2 = subprocess.Popen([ |
paul@0 | 137 | FO_PROCESSOR, |
paul@0 | 138 | "-fo", "-", |
paul@0 | 139 | "-pdf", "-", |
paul@0 | 140 | ], |
paul@0 | 141 | shell=False, |
paul@0 | 142 | stdin=p1.stdout, |
paul@0 | 143 | stdout=subprocess.PIPE, |
paul@0 | 144 | stderr=subprocess.PIPE) |
paul@0 | 145 | |
paul@0 | 146 | out, err = p2.communicate() |
paul@0 | 147 | |
paul@0 | 148 | retcode = p1.wait() |
paul@0 | 149 | |
paul@0 | 150 | if retcode != 0: |
paul@0 | 151 | return 0, err |
paul@0 | 152 | |
paul@0 | 153 | retcode = p2.wait() |
paul@0 | 154 | |
paul@0 | 155 | if retcode != 0: |
paul@0 | 156 | return 0, err |
paul@0 | 157 | |
paul@0 | 158 | send_headers = get_send_headers(request) |
paul@0 | 159 | headers = ["Content-Type: application/pdf"] |
paul@0 | 160 | send_headers(headers) |
paul@0 | 161 | request.write(out) |
paul@0 | 162 | |
paul@0 | 163 | return 1, None |
paul@0 | 164 | |
paul@0 | 165 | def render_success(self, msg, msgtype=None): |
paul@0 | 166 | |
paul@0 | 167 | """ |
paul@0 | 168 | Render neither 'msg' nor 'msgtype' since a resource has already been |
paul@0 | 169 | produced. |
paul@0 | 170 | NOTE: msgtype is optional because MoinMoin 1.5.x does not support it. |
paul@0 | 171 | """ |
paul@0 | 172 | |
paul@0 | 173 | pass |
paul@0 | 174 | |
paul@0 | 175 | # Action invocation function. |
paul@0 | 176 | |
paul@0 | 177 | def execute(pagename, request): |
paul@0 | 178 | ExportPDF(pagename, request).render() |
paul@0 | 179 | |
paul@0 | 180 | # vim: tabstop=4 expandtab shiftwidth=4 |