# HG changeset patch # User Paul Boddie # Date 1383259560 -3600 # Node ID bb07949085d121510ae64ae0c8037a430ea24b6a An export action for MoinMoin producing PDF documents for wiki pages. diff -r 000000000000 -r bb07949085d1 README.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Thu Oct 31 23:46:00 2013 +0100 @@ -0,0 +1,100 @@ +Introduction +------------ + +The ExportPDF action enables the export of MoinMoin wiki pages as PDF +documents using XSLT, DocBook and XSL-FO external tools. + +Installation +------------ + +The following configuration settings are present in the ExportPDF.py module: + +XSLT_PROCESSOR Path to the xsltproc program +FO_PROCESSOR Path to the fop program +DOCBOOK_STYLESHEET_BASE Path to the directory containing DocBook resources + +Another setting that should not need modifying is the following: + +DOCBOOK_TO_FO_STYLESHEET Relative path to the docbook.xsl stylesheet file + from the DOCBOOK_STYLESHEET_BASE path (putting + them together should reference the file with an + absolute path) + +Once configured, copy the ExportPDF.py module into your wiki's actions +directory. + +With moinsetup and a suitable configuration file (see "Recommended Software" +below), you can perform this last step as follows, with $EPDIR referring to +the ExportPDF distribution directory: + + python moinsetup.py -f moinsetup.cfg -m install_actions $EPDIR/actions + +Basic Usage +----------- + +Select the ExportPDF action from the actions menu; a PDF document should be +offered for download. + +Recommended Software +-------------------- + +See the "Dependencies" section below for essential software. + +The moinsetup tool is recommended for installation since it aims to support +all versions of MoinMoin that are supported for use with this software. + +See the following page for information on moinsetup: + +http://moinmo.in/ScriptMarket/moinsetup + +Dependencies +------------ + +The ExportPDF action has the following basic dependencies: + +Packages Release Information +-------- ------------------- + +xsltproc Tested with 1.1.26 + Debian package: xsltproc + Source: http://www.xmlsoft.org/XSLT.html + +Apache FOP Tested with 1.0 + Debian package: fop + Source: http://xmlgraphics.apache.org/fop/ + +DocBook XSL Tested with 1.76.1 + Debian package: docbook-xsl + Source: http://docbook.sourceforge.net/ + +Java Tested with a Java 6 runtime + Debian package: openjdk-6-jre-headless + Source: http://www.oracle.com/technetwork/java/index.html + +The Java dependency is unfortunate and would ideally be avoided by using +something other than Apache FOP. + +Contact, Copyright and Licence Information +------------------------------------------ + +See the following Web page for more information about this work: + +http://moinmo.in/ActionMarket/ExportPDF + +The author of this packaging of the original work can be contacted at the +following e-mail address: + +paul@boddie.org.uk + +Copyright and licence information can be found in the docs directory - see +docs/COPYING.txt and docs/LICENCE.txt for more information. + +Release Procedures +------------------ + +Update the actions/ExportPDF.py __version__ attribute. +Change the version number and package filename/directory in the documentation. +Update the release notes (see above). +Tag, export. +Archive, upload. +Update the ActionMarket and ActionMarket/ExportPDF page. diff -r 000000000000 -r bb07949085d1 actions/ExportPDF.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/actions/ExportPDF.py Thu Oct 31 23:46:00 2013 +0100 @@ -0,0 +1,180 @@ +# -*- coding: iso-8859-1 -*- +""" + MoinMoin - Export as PDF action + + @copyright: 2013 by Paul Boddie + @license: GNU GPL (v2 or later), see COPYING.txt for details. +""" + +from MoinMoin.action import ActionBase +from MoinMoin.wikiutil import escape +from MoinSupport import ActionSupport, escattr, getFormatterClass, formatText, get_send_headers +from os.path import join +import subprocess + +__version__ = "0.1" + +Dependencies = ['page'] + +# Configuration settings. + +XSLT_PROCESSOR = "/usr/bin/xsltproc" +FO_PROCESSOR = "/usr/bin/fop" +DOCBOOK_STYLESHEET_BASE = "/usr/share/xml/docbook/stylesheet" + +# Tool settings. + +DOCBOOK_TO_FO_STYLESHEET = "docbook-xsl/fo/docbook.xsl" + +# NOTE: From docbook-xsl/fo/param.xsl. + +paper_sizes = [ + "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7", "A8", "A9", "A10", + "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7", "B8", "B9", "B10", + "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7", "C8", "C9", "C10", + "A4landscape", "USletter", "USlandscape", "4A0", "2A0", + ] + +paper_size_labels = { + "A4landscape" : "A4 landscape", + "USletter" : "US letter", + "USlandscape" : "US landscape", + "4A0" : "Quadruple A0", + "2A0" : "Double A0" + } + +class ExportPDF(ActionBase, ActionSupport): + + "Export the current page as PDF." + + def get_form_html(self, buttons_html): + + "Return the action's form incorporating the 'buttons_html'." + + _ = self._ + request = self.request + form = self.get_form() + + paper_size = form.get("paper-size", ["A4"])[0] + + paper_size_options = [] + + for size in paper_sizes: + paper_size_options.append('' % ( + escattr(size), self._get_selected(size, paper_size), + escape(_(paper_size_labels.get(size) or size)) + )) + + d = { + "paper_size_label" : escape(_("Paper size")), + "paper_size_options" : u"".join(paper_size_options), + "buttons_html" : buttons_html, + } + + return u"""\ + + + + + + + + + +
%(buttons_html)s
+""" % d + + def do_action(self): + + "Attempt to post a comment." + + _ = self._ + request = self.request + form = self.get_form() + page = self.page + + paper_size = form.get("paper-size", [""])[0] + + if not paper_size in paper_sizes: + return 0, _("A paper size must be chosen.") + + # Get the page in DocBook format. + + fmt = getFormatterClass(request, "text_docbook")(request) + fmt.setPage(page) + + # The DocBook formatter needs to pretend a full document is being made. + + page_as_docbook = [] + append = page_as_docbook.append + + append(fmt.startDocument(page.page_name)) + append(fmt.startContent()) + append(formatText(page.get_raw_body(), request, fmt, inhibit_p=False).encode("utf-8")) + append(fmt.endContent()) + append(fmt.endDocument()) + + # Send the DocBook XML to the XSLT processor. + + p1 = subprocess.Popen([ + XSLT_PROCESSOR, + "-stringparam", "fop1.extensions", "1", + "--stringparam", "paper.type", paper_size, + join(DOCBOOK_STYLESHEET_BASE, DOCBOOK_TO_FO_STYLESHEET), + "-" + ], + shell=False, + stdin=subprocess.PIPE, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + + p1.stdin.write("".join(page_as_docbook)) + p1.stdin.close() + + # Pipe the XML-FO output to the FO processor. + + p2 = subprocess.Popen([ + FO_PROCESSOR, + "-fo", "-", + "-pdf", "-", + ], + shell=False, + stdin=p1.stdout, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + + out, err = p2.communicate() + + retcode = p1.wait() + + if retcode != 0: + return 0, err + + retcode = p2.wait() + + if retcode != 0: + return 0, err + + send_headers = get_send_headers(request) + headers = ["Content-Type: application/pdf"] + send_headers(headers) + request.write(out) + + return 1, None + + def render_success(self, msg, msgtype=None): + + """ + Render neither 'msg' nor 'msgtype' since a resource has already been + produced. + NOTE: msgtype is optional because MoinMoin 1.5.x does not support it. + """ + + pass + +# Action invocation function. + +def execute(pagename, request): + ExportPDF(pagename, request).render() + +# vim: tabstop=4 expandtab shiftwidth=4 diff -r 000000000000 -r bb07949085d1 docs/COPYING.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/COPYING.txt Thu Oct 31 23:46:00 2013 +0100 @@ -0,0 +1,19 @@ +Licence Agreement +----------------- + +Copyright (C) 2013 Paul Boddie + +This software is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation; either version 2 of +the License, or (at your option) any later version. + +This software is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public +License along with this library; see the file LICENCE.txt +If not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA diff -r 000000000000 -r bb07949085d1 docs/LICENCE.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/LICENCE.txt Thu Oct 31 23:46:00 2013 +0100 @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License.