# HG changeset patch # User Paul Boddie # Date 1326570047 -3600 # Node ID 93b8e78cfcc2d87793ff405b6cd21c7f5a3dfcb3 # Parent 30f695aa03b1c8414b722fbc28ce34740207aecd Moved the module into the parsers directory. Expanded the documentation. Added copyright and licensing information. diff -r 30f695aa03b1 -r 93b8e78cfcc2 README.txt --- a/README.txt Sat Jan 14 19:17:36 2012 +0100 +++ b/README.txt Sat Jan 14 20:40:47 2012 +0100 @@ -1,7 +1,27 @@ +Introduction +------------ + +The graphviz parser module allows descriptions of graphs suitable for +interpretation by the Graphviz suite of tools to be embedded within Wiki +pages. + +Installation +------------ + +First, make sure that the BINARY_PATH setting in the graphviz.py module (found +in the parsers directory) is suitable for your system. Then, copy the +graphviz.py module into your Wiki's parsers directory. + +With moinsetup and a suitable configuration file (see "Recommended Software" +below), you can perform this last step as follows, with $GVDIR referring to the +GraphvizParser distribution directory: + + python moinsetup.py -f moinsetup.cfg -m install_parsers $GVDIR/parsers + Basic Usage ----------- -Embed a visualization of a graph in a wiki page: +To embed a visualisation of a graph in a Wiki page, try the following: {{{#!graphviz digraph G { @@ -14,23 +34,23 @@ This parser will check the first lines of the Graphviz data for C++ style comments instructing it to use a different filter (dot, neato, twopi, circo, -or fdp - see http://graphviz.org/ for more info), use a different format for -the output (see the FORMATS list in the Parser class), or to generate and pass -a client-side image map. +or fdp - see http://graphviz.org/ for more information), use a different +format for the output (see the OUTPUT_FORMATS list in the Parser class), or to +generate and pass a client-side imagemap. Options: filter - the filter to use (see Parser.FILTERS) -format - the output format (see Parser.FORMATS) -cmapx - the map name to use for the client-side image map; this must match +format - the output format (see Parser.OUTPUT_FORMATS) +cmapx - the map name to use for the client-side imagemap; this must match the graph name in the graph definition and shouldn't conflict with any other graphs that are used on the same page; for SVG images, the cmapx option is superfluous since SVG supports linking natively and Graphviz converts "href" attributes appropriately -Embed a visualization of a graph in a wiki page, using the dot filter and -providing a client-side image map (the filter=dot and format=png options are -redundant since those are the defaults for this parser): +To embed a visualisation of a graph in a Wiki page, using the dot filter and +providing a client-side imagemap (the filter=dot and format=png options are +redundant since those are the defaults for this parser), try the following: {{{#!graphviz //filter=dot @@ -50,16 +70,73 @@ }; }}} -Known Bugs ----------- +As noted above, for SVG output an imagemap definition need not be used, since +SVG as a format supports hyperlinks. + +Known Issues +------------ + + * The parser could benefit from being checked for potential methods of + injecting arbitrary HTML into the page output, even though the formatter + interface is being used to generate the output. + + * The parser only be useful or compatible with HTML rendering, although the + generic formatter interface is used to format the output and could support + any page format that can present images and objects in a similar fashion. + + * The code may not use all of the MoinMoin interfaces properly. Particularly + the manipulation of attachments might be better done through any + Moin-level abstractions instead of at the file level. + + * Comments must start at the beginning of the graphviz block and at the + beginning of their respective lines. They must also not contain any extra + whitespace surrounding the = sign. + + * SVG image sizing can only be done by extracting the dimensions from an + uncompressed ("svg" format, not "svgz" format) output representation. + Moreover, the extraction process assumes that the "width" and "height" + attributes appear in an "svg" start tag of a particular form. + + * Beyond SVG size detection there is no support for determining the size of + output representations that cannot be inserted into a page as an image. + Thus, most of the supported output formats may cause inappropriately sized + objects to appear in a page because the browser has not been able to + determine the size of the object in advance. - - Hasn't been thoroughly checked for potential methods of injecting - arbitrary HTML into the output. - - Only compatible with HTML rendering - - May not use all of the MoinMoin interfaces properly - this is a - quick hack based on looking at an example and digging through the - MoinMoin source. The MoinMoin development docs haven't been - consulted (yet). - - Comments must start at the beginning of the graphviz block, and at the - beginning of their respective lines. They must also not contain - any extra whitespace surrounding the = sign. +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 graphviz parser has the following basic dependencies: + +Packages Release Information +-------- ------------------- + +graphviz Tested with 2.16 + Source: http://www.graphviz.org/ + +Contact, Copyright and Licence Information +------------------------------------------ + +See the following Web page for more information about this work: + +http://moinmo.in/ParserMarket/graphviz + +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. diff -r 30f695aa03b1 -r 93b8e78cfcc2 docs/COPYING.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/COPYING.txt Sat Jan 14 20:40:47 2012 +0100 @@ -0,0 +1,20 @@ +Licence Agreement +----------------- + +Copyright (C) 2008 Wayne Tucker +Copyright (C) 2011, 2012 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 30f695aa03b1 -r 93b8e78cfcc2 docs/LICENCE.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/LICENCE.txt Sat Jan 14 20:40:47 2012 +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. diff -r 30f695aa03b1 -r 93b8e78cfcc2 graphviz.py --- a/graphviz.py Sat Jan 14 19:17:36 2012 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,318 +0,0 @@ -# -*- coding: iso-8859-1 -*- -""" - MoinMoin - Graphviz Parser - Based loosely on GNUPLOT parser by MoinMoin:KwonChanYoung - - @copyright: 2008 Wayne Tucker - @copyright: 2011, 2012 Paul Boddie - @license: GNU GPL, see COPYING for details. -""" - -# Change this to the directory that the Graphviz binaries (dot, neato, etc.) -# are installed in. - -BINARY_PATH = '/usr/bin' - -from os.path import join -import os -import subprocess -import sha -import re - -from MoinMoin import config -from MoinMoin.action import AttachFile -from MoinMoin import log -from MoinMoin import wikiutil - -logging = log.getLogger(__name__) - -class GraphVizError(RuntimeError): - pass - -Dependencies = ["pages"] - -class Parser: - - "Uses the Graphviz programs to create a visualization of a graph." - - extensions = [] - Dependencies = Dependencies - - FILTERS = ['dot', 'neato', 'twopi', 'circo', 'fdp'] - IMAGE_FORMATS = ['png', 'gif'] - SVG_FORMATS = ['svg', 'svgz'] - OUTPUT_FORMATS = IMAGE_FORMATS + SVG_FORMATS + \ - ['ps', 'fig', 'mif', 'hpgl', 'pcl', 'dia', 'imap'] - - attach_regexp = re.compile( - r"graphviz_" - r"(?P.*?)" - r"(?:" # begin optional section - r"_(?P.*?)_(?P.*?)" # dimensions - r")?" # end optional section - r"\.(?P.*)" - r"$") - - attr_regexp = re.compile( - r"(?Pwidth|height)" - r"\s*=\s*" - r"""(?P['"])""" # start quote - r"(?P.*?)" - r"""(?P=quote)""", # matching quote - re.UNICODE) - - def __init__(self, raw, request, **kw): - self.raw = raw - self.request = request - - def format(self, formatter): - - "Using the 'formatter', return the formatted page output." - - request = self.request - page = request.page - _ = request.getText - - request.flush() # to identify error text - - filter = self.FILTERS[0] - format = 'png' - cmapx = None - width = None - height = None - - raw_lines = self.raw.splitlines() - for l in raw_lines: - if not l[0:2] == '//': - break - - parts = l[2:].split("=") - directive = parts[0] - value = "=".join(parts[1:]) - - if directive == 'filter': - filter = value.lower() - if filter not in self.FILTERS: - logging.warn('unknown filter %s' % filter) - - elif directive == 'format': - value = value.lower() - if value in self.OUTPUT_FORMATS: - format = value - - elif directive == 'cmapx': - cmapx = wikiutil.escape(value) - - if not format in self.OUTPUT_FORMATS: - raise NotImplementedError, "only formats %s are currently supported" % \ - self.OUTPUT_FORMATS - - if cmapx and not format in self.IMAGE_FORMATS: - logging.warn('format %s is incompatible with cmapx option' % format) - cmapx = None - - digest = sha.new(self.raw).hexdigest() - - # Make sure that an attachments directory exists and that old graphs are - # deleted. - - self.attach_dir = AttachFile.getAttachDir(request, page.page_name, create=1) - self.delete_old_graphs(formatter) - - # Find the details of the graph, rendering a new graph if necessary. - - attrs = self.find_graph(digest, format) - if not attrs: - attrs = self.graphviz(filter, self.raw, digest, format) - - chart = self.get_chartname(digest, format, attrs) - url = AttachFile.getAttachUrl(page.page_name, chart, request) - - # Images are displayed using the HTML "img" element (or equivalent) - # and may provide an imagemap. - - if format in self.IMAGE_FORMATS: - if cmapx: - request.write('\n' + self.graphviz(filter, self.raw, digest, "cmapx") + '\n') - request.write(formatter.image(src="%s" % url, usemap="#%s" % cmapx, **self.get_format_attrs(attrs))) - else: - request.write(formatter.image(src="%s" % url, alt="graphviz image", **self.get_format_attrs(attrs))) - - # Other objects are embedded using the HTML "object" element (or - # equivalent). - - else: - request.write(formatter.transclusion(1, data=url, **self.get_format_attrs(attrs))) - request.write(formatter.text(_("graphviz image"))) - request.write(formatter.transclusion(0)) - - def find_graph(self, digest, format): - - "Find an existing graph using 'digest' and 'format'." - - attach_files = AttachFile._get_files(self.request, self.request.page.page_name) - - for chart in attach_files: - match = self.attach_regexp.match(chart) - - if match and \ - match.group("digest") == digest and \ - match.group("format") == format: - - return match.groupdict() - - return None - - def get_chartname(self, digest, format, attrs=None): - - "Return the chart name for the 'digest', 'format' and 'attrs'." - - wh = self.get_dimensions(attrs) - if wh: - dimensions = "_%s_%s" % wh - else: - dimensions = "" - return "graphviz_%s%s.%s" % (digest, dimensions, format) - - def delete_old_graphs(self, formatter): - - "Using the 'formatter' for page information, delete old graphs." - - page_info = formatter.page.lastEditInfo() - try: - page_date = page_info['time'] - except KeyError, ex: - return - - attach_files = AttachFile._get_files(self.request, self.request.page.page_name) - - for chart in attach_files: - match = self.attach_regexp.match(chart) - - if match and match.group("format") in self.OUTPUT_FORMATS: - fullpath = join(self.attach_dir, chart).encode(config.charset) - st = os.stat(fullpath) - chart_date = self.request.user.getFormattedDateTime(st.st_mtime) - if chart_date < page_date: - os.remove(fullpath) - - def graphviz(self, filter, graph_def, digest, format): - - """ - Using the 'filter' with the given 'graph_def' (and 'digest'), generate - output in the given 'format'. - """ - - need_output = format in ("cmapx", "svg") - - # Either write the output straight to a file. - - if not need_output: - chart = self.get_chartname(digest, format) - filename = join(self.attach_dir, chart).encode(config.charset) - - p = subprocess.Popen([ - join(BINARY_PATH, filter), '-T%s' % format, '-o%s' % filename - ], - shell=False, - stdin=subprocess.PIPE, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - - # Or intercept the output. - - else: - p = subprocess.Popen([ - join(BINARY_PATH, filter), '-T%s' % format - ], - shell=False, - stdin=subprocess.PIPE, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE) - - p.stdin.write(graph_def) - p.stdin.flush() - p.stdin.close() - - p.wait() - - # Graph data always goes via standard output so that we can extract the - # width and height if possible. - - if need_output: - output, attrs = self.process_output(p.stdout, format) - else: - output, attrs = None, {} - - # Test for errors. - - errors = p.stderr.read() - - if len(errors) > 0: - raise GraphVizError, errors - - # Return the output for imagemaps. - - if format == "cmapx": - return output - - # Copy to a file, if necessary. - - elif need_output: - chart = self.get_chartname(digest, format, attrs) - filename = join(self.attach_dir, chart).encode(config.charset) - - f = open(filename, "wb") - try: - f.write(output) - finally: - f.close() - - # Return the dimensions, if defined. - - return attrs - - def process_output(self, output, format): - - "Process graph 'output' in the given 'format'." - - # Return the raw output if SVG is not being produced. - - if format != "svg": - return output.read(), {} - - # Otherwise, return the processed SVG output. - - processed = [] - found = False - attrs = {} - - for line in output.xreadlines(): - if not found and line.startswith(" + @license: GNU GPL, see COPYING for details. +""" + +# Change this to the directory that the Graphviz binaries (dot, neato, etc.) +# are installed in. + +BINARY_PATH = '/usr/bin' + +from os.path import join +import os +import subprocess +import sha +import re + +from MoinMoin import config +from MoinMoin.action import AttachFile +from MoinMoin import log +from MoinMoin import wikiutil + +logging = log.getLogger(__name__) + +class GraphVizError(RuntimeError): + pass + +Dependencies = ["pages"] + +class Parser: + + "Uses the Graphviz programs to create a visualization of a graph." + + extensions = [] + Dependencies = Dependencies + + FILTERS = ['dot', 'neato', 'twopi', 'circo', 'fdp'] + IMAGE_FORMATS = ['png', 'gif'] + SVG_FORMATS = ['svg', 'svgz'] + OUTPUT_FORMATS = IMAGE_FORMATS + SVG_FORMATS + \ + ['ps', 'fig', 'mif', 'hpgl', 'pcl', 'dia', 'imap'] + + attach_regexp = re.compile( + r"graphviz_" + r"(?P.*?)" + r"(?:" # begin optional section + r"_(?P.*?)_(?P.*?)" # dimensions + r")?" # end optional section + r"\.(?P.*)" + r"$") + + attr_regexp = re.compile( + r"(?Pwidth|height)" + r"\s*=\s*" + r"""(?P['"])""" # start quote + r"(?P.*?)" + r"""(?P=quote)""", # matching quote + re.UNICODE) + + def __init__(self, raw, request, **kw): + self.raw = raw + self.request = request + + def format(self, formatter): + + "Using the 'formatter', return the formatted page output." + + request = self.request + page = request.page + _ = request.getText + + request.flush() # to identify error text + + filter = self.FILTERS[0] + format = 'png' + cmapx = None + width = None + height = None + + raw_lines = self.raw.splitlines() + for l in raw_lines: + if not l[0:2] == '//': + break + + parts = l[2:].split("=") + directive = parts[0] + value = "=".join(parts[1:]) + + if directive == 'filter': + filter = value.lower() + if filter not in self.FILTERS: + logging.warn('unknown filter %s' % filter) + + elif directive == 'format': + value = value.lower() + if value in self.OUTPUT_FORMATS: + format = value + + elif directive == 'cmapx': + cmapx = wikiutil.escape(value) + + if not format in self.OUTPUT_FORMATS: + raise NotImplementedError, "only formats %s are currently supported" % \ + self.OUTPUT_FORMATS + + if cmapx and not format in self.IMAGE_FORMATS: + logging.warn('format %s is incompatible with cmapx option' % format) + cmapx = None + + digest = sha.new(self.raw).hexdigest() + + # Make sure that an attachments directory exists and that old graphs are + # deleted. + + self.attach_dir = AttachFile.getAttachDir(request, page.page_name, create=1) + self.delete_old_graphs(formatter) + + # Find the details of the graph, rendering a new graph if necessary. + + attrs = self.find_graph(digest, format) + if not attrs: + attrs = self.graphviz(filter, self.raw, digest, format) + + chart = self.get_chartname(digest, format, attrs) + url = AttachFile.getAttachUrl(page.page_name, chart, request) + + # Images are displayed using the HTML "img" element (or equivalent) + # and may provide an imagemap. + + if format in self.IMAGE_FORMATS: + if cmapx: + request.write('\n' + self.graphviz(filter, self.raw, digest, "cmapx") + '\n') + request.write(formatter.image(src="%s" % url, usemap="#%s" % cmapx, **self.get_format_attrs(attrs))) + else: + request.write(formatter.image(src="%s" % url, alt="graphviz image", **self.get_format_attrs(attrs))) + + # Other objects are embedded using the HTML "object" element (or + # equivalent). + + else: + request.write(formatter.transclusion(1, data=url, **self.get_format_attrs(attrs))) + request.write(formatter.text(_("graphviz image"))) + request.write(formatter.transclusion(0)) + + def find_graph(self, digest, format): + + "Find an existing graph using 'digest' and 'format'." + + attach_files = AttachFile._get_files(self.request, self.request.page.page_name) + + for chart in attach_files: + match = self.attach_regexp.match(chart) + + if match and \ + match.group("digest") == digest and \ + match.group("format") == format: + + return match.groupdict() + + return None + + def get_chartname(self, digest, format, attrs=None): + + "Return the chart name for the 'digest', 'format' and 'attrs'." + + wh = self.get_dimensions(attrs) + if wh: + dimensions = "_%s_%s" % wh + else: + dimensions = "" + return "graphviz_%s%s.%s" % (digest, dimensions, format) + + def delete_old_graphs(self, formatter): + + "Using the 'formatter' for page information, delete old graphs." + + page_info = formatter.page.lastEditInfo() + try: + page_date = page_info['time'] + except KeyError, ex: + return + + attach_files = AttachFile._get_files(self.request, self.request.page.page_name) + + for chart in attach_files: + match = self.attach_regexp.match(chart) + + if match and match.group("format") in self.OUTPUT_FORMATS: + fullpath = join(self.attach_dir, chart).encode(config.charset) + st = os.stat(fullpath) + chart_date = self.request.user.getFormattedDateTime(st.st_mtime) + if chart_date < page_date: + os.remove(fullpath) + + def graphviz(self, filter, graph_def, digest, format): + + """ + Using the 'filter' with the given 'graph_def' (and 'digest'), generate + output in the given 'format'. + """ + + need_output = format in ("cmapx", "svg") + + # Either write the output straight to a file. + + if not need_output: + chart = self.get_chartname(digest, format) + filename = join(self.attach_dir, chart).encode(config.charset) + + p = subprocess.Popen([ + join(BINARY_PATH, filter), '-T%s' % format, '-o%s' % filename + ], + shell=False, + stdin=subprocess.PIPE, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + + # Or intercept the output. + + else: + p = subprocess.Popen([ + join(BINARY_PATH, filter), '-T%s' % format + ], + shell=False, + stdin=subprocess.PIPE, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + + p.stdin.write(graph_def) + p.stdin.flush() + p.stdin.close() + + p.wait() + + # Graph data always goes via standard output so that we can extract the + # width and height if possible. + + if need_output: + output, attrs = self.process_output(p.stdout, format) + else: + output, attrs = None, {} + + # Test for errors. + + errors = p.stderr.read() + + if len(errors) > 0: + raise GraphVizError, errors + + # Return the output for imagemaps. + + if format == "cmapx": + return output + + # Copy to a file, if necessary. + + elif need_output: + chart = self.get_chartname(digest, format, attrs) + filename = join(self.attach_dir, chart).encode(config.charset) + + f = open(filename, "wb") + try: + f.write(output) + finally: + f.close() + + # Return the dimensions, if defined. + + return attrs + + def process_output(self, output, format): + + "Process graph 'output' in the given 'format'." + + # Return the raw output if SVG is not being produced. + + if format != "svg": + return output.read(), {} + + # Otherwise, return the processed SVG output. + + processed = [] + found = False + attrs = {} + + for line in output.xreadlines(): + if not found and line.startswith("