Changeset 1601

Timestamp:

11/25/06 18:00:34 (2 years ago)

Author:

pkropf

Message:

GraphvizPlugin:

Merged changes from the v0.6 branch that happened after the v0.7 branch was created.

Files:

• graphvizplugin/branches/v0.7 (modified) (1 prop)
• graphvizplugin/branches/v0.7/graphviz/graphviz.py (modified) (19 diffs)
• graphvizplugin/branches/v0.7/graphviz/__init__.py (modified) (1 diff)
• graphvizplugin/branches/v0.7/README.txt (modified) (7 diffs)
• graphvizplugin/branches/v0.7/ReleaseNotes.txt (modified) (2 diffs)
• graphvizplugin/branches/v0.7/setup.py (modified) (1 diff)

graphvizplugin/branches/v0.7/graphviz/graphviz.py

@@ -29 +29 @@
-from trac.core import *
-from trac.wiki.api import IWikiMacroProvider
+from trac.mimeview.api import IHTMLPreviewRenderer, MIME_MAP
+from trac.web.main import IRequestHandler
-from trac.util import escape
-from trac.wiki.formatter import wiki_to_oneliner
@@ -34 +36 @@
-
-
-
-_TRUE_VALUES = ('yes', 'true', 'on', 'aye', '1', 1, True)
-
-
-
-class GraphvizMacro(Component):
-    """
-
+
+
+
-    """
-
+HTMLPreviewRenderer, I
-
-    # Available formats and processors, default first (dot/png)
@@ -50 +52 @@
-    vector_formats = ['svg', 'svgz']
-    formats = bitmap_formats + vector_formats 
+    cmd_paths = {'linux2':   '/usr/bin',
+                 'win32':    'c:\\Program Files\\ATT\\Graphviz\\bin',
+                 'freebsd6': '/usr/local/bin',
+                 'freebsd5': '/usr/local/bin',
+                 }
-
-    def __init__(self):
@@ -59 +66 @@
-    def get_macros(self):
-        """Return an iterable that provides the names of the provided macros."""
+        self.load_config()
-        for p in ['.' + p for p in GraphvizMacro.processors] + ['']: 
-            for f in ['/' + f for f in GraphvizMacro.formats] + ['']:
@@ -65 +73 @@
-
-    def get_macro_description(self, name):
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
@@ -73 +90 @@
-
-        req - ?
-
+
-        name - Wiki macro command that resulted in this method being
-               called. In this case, it should be 'graphviz', followed
@@ -149 +166 @@
-            return buf.getvalue()
-
-
+
+
+
+
+
+
+
+
-        img_name = '%s.%s.%s' % (sha_key, self.processor, self.out_format) # cache: hash.<dot>.<png>
-        img_path = os.path.join(self.cache_dir, img_name)
@@ -224 +248 @@
-                dimensions = 'width="100%" height="100%"'
-            # insert SVG, IE compatibility
-%s" type="image/svg+xml" %s></embed><![endif]--> ' % (self.prefix
-%s" type="image/svg+xml" %s>SVG Object</object><![endif]>' % (self.prefix
+graphviz/%s" type="image/svg+xml" %s></embed><![endif]--> ' % (req.base
+graphviz/%s" type="image/svg+xml" %s>SVG Object</object><![endif]>' % (req.base
-
-        # for binary formats, add map
@@ -234 +258 @@
-            map = "".join(map).replace('\n', '')
-            buf.write('<map id="%s" name="%s">%s</map>' % (sha_key, sha_key, map))
-%s" usemap="#%s" alt="GraphViz image"/>' % (sha_key, self.prefix
-
-
-%s"/>' % (self.prefix
+graphviz/%s" usemap="#%s" alt="GraphViz image"/>' % (sha_key, req.base
+
+
+graphviz/%s"/>' % (req.base
-
-        return buf.getvalue()
@@ -243 +267 @@
-
-    def expand_wiki_links(self, match):
-        #self.log.debug('expand_wiki_links.match.groups: %s' % str(match.groups()))
-        
-        wiki_url = match.groups()[0]                     # TracLink ([1], source:file/, ...)
-        html_url = wiki_to_oneliner(wiki_url, self.env)  # <a href="http://someurl">...</a>
-        href     = re.search('href="(.*?)"', html_url)   # http://someurl
-
-
-
-
-
+
+
+
+
+
+
-
-
@@ -281 +304 @@
-                #self.log.debug('self.cache_dir: %s' % self.cache_dir)
-
+
+            #Get optional configuration parameters from trac.ini.
+
+            # check for the default processor - processor
+            self.processor = self.config.get('graphviz', 'processor', GraphvizMacro.processors[0])
+            #self.log.debug('self.processor: %s' % self.processor)
+
-            # check for the cmd_path entry
-
+
+
+
+
-            if not self.cmd_path:
-.'
+ and there is no default for %s.' % sys.platform
-                buf = self.show_err(msg)
-                trouble = True
@@ -292 +325 @@
-                trouble = True
-
+                #self.log.debug('self.cmd_path: %s' % self.cmd_path)
+
+            else:
+                pname = os.path.join(self.cmd_path, self.processor) + self.exe_suffix
+                if not os.path.exists(pname):
+                    msg = 'The default processor, <b>%s</b>, was not found.' % pname
+                    buf = self.show_err(msg)
+                    trouble = True
+
-                for name in GraphvizMacro.processors:
-                    pname = os.path.join(self.cmd_path, name) + self.exe_suffix
-                    if not os.path.exists(pname):
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-            # check for the default output format - out_format
@@ -316 +344 @@
-            #self.log.debug('self.out_format: %s' % self.out_format)
-
-            # check for the default processor - processor
-            self.processor = self.config.get('graphviz', 'processor', GraphvizMacro.processors[0])
-            #self.log.debug('self.processor: %s' % self.processor)
-
-            # check if png anti aliasing should be done - png_antialias
-            self.png_anti_alias = self.boolean(self.config.get('graphviz', 'png_antialias', False))
@@ -325 +349 @@
-
-            if self.png_anti_alias == True:
-'/usr/bin/rsvg'
+os.path.join(self.cmd_path, 'rsvg')
-
-                if not os.path.exists(self.rsvg_path):
@@ -364 +388 @@
-            self.dpi = int(self.config.get('graphviz', 'default_graph_dpi', 96))
-
+        # setup mimetypes to support the IHTMLPreviewRenderer interface
+        if 'graphviz' not in MIME_MAP:
+            MIME_MAP['graphviz'] = 'application/graphviz'
+        for processor in GraphvizMacro.processors:
+            if processor not in MIME_MAP:
+                MIME_MAP[processor] = 'application/graphviz'
+
-        return trouble, buf
-
@@ -369 +400 @@
-    def launch(self, cmd, input):
-        """Launch a process (cmd), and returns exitcode, stdout + stderr"""
-       
+        
-        if input:
-lines
+
-        p_in.close()
-        out = p_out.read()
@@ -384 +415 @@
-                   <strong>Graphviz macro processor has detected an error. Please fix the problem before continuing.</strong> \n\
-                   <pre>%s</pre> \n\
-msg
+escape(msg)
-        self.log.error(msg)
-        return buf
@@ -451 +482 @@
-
-
-    # IRequestHandler methods
-    def match_request(self, req):
-        return req.path_info.startswith('/graphviz')
-    
-
-    def process_request(self, req):
-        pieces = [item for item in req.path_info.split('/graphviz') if len(item)]
-        self.log.debug('process_request:pieces %s' % str(pieces))
-
-        trouble, msg = self.load_config()
-        if trouble:
-            return msg.getvalue()
-
-        img_path = os.path.join(self.cache_dir, pieces[0])
-
-        if os.path.exists(img_path):
-            req.send_file(img_path)
-
-        self.log.warning('File %s not found', img_path)
-        raise HTTPNotFound('File %s not found', img_path)
-
-
-    # Extra helper functions
-    def boolean(self, value):
@@ -479 +488 @@
-            value = value.lower() in _TRUE_VALUES
-        return bool(value)
+
+
+    MIME_TYPES = ('application/graphviz')
+
+    # IHTMLPreviewRenderer methods
+
+    def get_quality_ratio(self, mimetype):
+        self.log.error(mimetype)
+        if mimetype in self.MIME_TYPES:
+            return 2
+        return 0
+
+    def render(self, req, mimetype, content, filename=None, url=None):
+        ext = filename.split('.')[1]
+        name = ext == 'graphviz' and 'graphviz' or 'graphviz.%s' % ext
+        text = hasattr(content, 'read') and content.read() or content
+        return self.render_macro(req, name, text)
+
+
+    # IRequestHandler methods
+    def match_request(self, req):
+        return req.path_info.startswith('/graphviz')
+
+
+    def process_request(self, req):
+        # check and load the configuration
+        trouble, msg = self.load_config()
+        if trouble:
+            return msg.getvalue()
+
+        pieces = [item for item in req.path_info.split('/graphviz') if len(item)]
+
+        if len(pieces):
+            pieces = [item for item in pieces[0].split('/') if len(item)]
+
+            if len(pieces):
+                name = pieces[0]
+                img_path = os.path.join(self.cache_dir, name)
+                return req.send_file(img_path)
+        return

graphvizplugin/branches/v0.7/graphviz/__init__.py

@@ -3 +3 @@
-$HeadURL$
-
-
+, 2006
-
-Module file for the graphviz trac wiki processor.

graphvizplugin/branches/v0.7/README.txt

@@ -51 +51 @@
-#!graphviz.dot/png
-#!graphviz.circo/gif
+
+
+Platform Specific Requirements
+==============================
+
+FreeBSD
++++++++
+
+On FreeBSD systems, installing the x11-fonts/urwfonts package will
+provide the fonts needed for graphviz to correctly generate images.
-
-
@@ -105 +115 @@
-                      generated images.
-
-    prefix_url      - The url to be used to find the cached images. This
-                      must point to the trac server's view of the
-                      cache_dir location.
-
-    cmd_path        - Full path to the directory where the graphviz
-
+
+
+
+
-
-    out_format      - Graph output format. Valid formats are: png, jpg,
@@ -117 +126 @@
-                      basis.
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-    png_antialias   - If this entry exists in the configuration file,
-
-
+
-
-    rsvg_path       - Full path to where the rsvg binary can be found.
+                      The default is cmd_path + rsvg.
-
-    default_*       - These settings define the default graph, node and
@@ -154 +170 @@
-                      contain. This is the high watermark for the
-                      directory entry count.
-
-The cache_dir and prefix_url entries are related to each other. The
-cache_dir entry points to a location on the file system and the
-prefix_url points to the same location but from the trac server's
-point of view. This allows the graphviz programs to generate the
-images and the user's web browser to view them.
-
-The cache_dir directory must exist and the trac server must have read
@@ -182 +192 @@
-[graphviz]
-cache_dir = /tmp/trac/htdocs/graphviz
-prefix_url = http://localhost:8000/trac/chrome/site/graphviz
-cmd_path = /usr/bin
-out_format = png
-png_antialias = true
-rsvg_path = /usr/bin/rsvg
-default_graph_fontname = "Andale Mono"
-default_graph_fontsize = 10
@@ -195 +201 @@
-[graphviz]
-cache_dir = /tmp/trac/htdocs/graphviz
-prefix_url = http://localhost:8000/trac/chrome/site/graphviz
-cmd_path = /usr/bin
-out_format = png
-png_antialias = true
-rsvg_path = /usr/bin/rsvg
-default_graph_fontname = "Andale Mono"
-default_graph_fontsize = 10
@@ -222 +224 @@
-[graphviz]
-cache_dir = C:\projects\plugins\env\trac\htdocs\graphviz
-prefix_url = http://localhost:8080/trac/chrome/site/graphviz
-cmd_path = c:\Program Files\ATT\Graphviz\bin
-out_format = png
-cache_manager = yes
-cache_max_size = 10000000

graphvizplugin/branches/v0.7/ReleaseNotes.txt

@@ -1 +1 @@
-Trac Graphviz Plugin v0.7.0 Release Notes
-=========================================
-June 1
+November 25
-
-Graphviz plugin v0.7.0 for Trac is now available. The Graphviz wiki
@@ -15 +15 @@
-
-
+Changes for release v0.6.8
+--------------------------
+
+* Added better support for non-ascii characters in graphviz wiki
+  documents.
+
+
+Changes for release v0.6.7
+--------------------------
+
+* The GraphvizMacro v0.6.5 release introduced a bug with the now
+  optional cmd_path. If run on a platform whose sys.platform name is
+  not in the GraphvizMacro.cmd_paths dictionary, the self.cmd_path
+  variable isn't initialized. This caused a wee problem and stack
+  trace in Trac.
+
+
+Changes for release v0.6.6
+--------------------------
+
+* The GraphvizMacro v0.6.5 release introduced a bug with the
+  IHTMLPreviewRenderer interface. The render method assumed that the
+  content parameter was an object with a read method. Under trac 0.10
+  with a Subversion repository, this object is a svn.core.Stream.
+  Under trac 0.9 the object is a string with the contents from the
+  repository. As a result, the v0.6.5 wouldn't render the images and
+  the raw text was displayed.
+
+
+Changes for release v0.6.5
+--------------------------
+
+* The default graphviz processor is now the only processor that must
+  be found on the system. GraphvizMacro will not work without it. If
+  any of the other processors are missing, a warning message will be
+  sent to the trac log, the processor will be removed from the list of
+  known GraphvizMacro processors and GraphvizMacro will continue.
+  Resolves issue http://trac-hacks.org/ticket/159.
+
+* The cmd_path configuration parameter in trac.ini is now
+  optional. Reasonable default values have been set for Linux, Win32
+  and FreeBSD6.
+
+* Altered the way the GraphvizMacro description is returned in
+  get_macro_description. Instead of returning a description for each
+  variant (graphviz, graphviz/png, graphviz/svg, etc.) only return a
+  description for graphviz. This will cleanup the WikiMacros page a
+  bit to hopefully make it easier to navigate. It isn't a perfect
+  solution since all the graphviz macro names are still displayed but
+  it no longer repeats the same description for each
+  permutation. Resolves issue http://trac-hacks.org/ticket/284.
+
+* Implemented the IRequestHandler interface to return graphviz
+  generated images. This means that graphviz images can be referenced
+  via http://URL_TO_TRAC_SERVER/graphviz/HASH_KEY. As a result of this
+  change, the prefix_url configuration parameter is no longer needed
+  in the trac.ini file. Resolves issue
+  http://trac-hacks.org/ticket/86.
+
+* Links within images that are rendered as SVG are now automatically
+  prefixed with javascript:window.parent.location.href= to force the
+  link to be displayed in the parent window instead of the SVG object
+  window. Resolves issue http://trac-hacks.org/ticket/560.
+
+* Included the processor options when calculating the sha key used for
+  the image file name. This should help in testing various graphviz
+  settings in trac.ini. Resolves issue
+  http://trac-hacks.org/ticket/575.
+
+* Fixed expand_wiki_links to allow for javascript URL
+  references. Resolves issue http://trac-hacks.org/ticket/559.
+
+* GraphvizMacro is now also an IHTMLPreviewRenderer. This was done by
+  adding application/graphviz as the mimetype for files with the
+  extension of .graphviz, .dot, .neato, .twopi, .circo and .fdp. When
+  browsing the source code in the respoitory, any files with those
+  extensions will be treated as graphviz programs and will be rendered
+  via the GraphvizMacro. Resolves issue
+  http://trac-hacks.org/attachment/ticket/576.
+
+* Escaped the error message before displaying it. Resolves issue
+  http://trac-hacks.org/ticket/574.
+
+
-Changes for release v0.6.4
---------------------------

graphvizplugin/branches/v0.7/setup.py

@@ -33 +33 @@
-text of a wiki page can contain the source text for graphviz and the
-web browser will show the resulting image.""",
-
+ 
-All rights reserved.
-