Changeset 4398

Timestamp:

10/06/08 12:16:37 (2 months ago)

Author:

cboos

Message:

GraphvizPlugin: use Option, IntOption and BoolOption where relevant.

This also fixes the potential problem where the local, block parameters, for the processor and output format were assigned to the Graphviz component itself (which is a singleton per environment per process).

Files:

• graphvizplugin/0.11/graphviz/graphviz.py (modified) (19 diffs)
• graphvizplugin/0.11/README.txt (modified) (1 diff)

graphvizplugin/0.11/graphviz/graphviz.py

@@ -26 +26 @@
-import subprocess
-
-
+BoolOption, IntOption, 
-from trac.core import *
-from trac.wiki.api import IWikiMacroProvider
@@ -32 +32 @@
-from trac.util import escape
-from trac.util.text import to_unicode
+from trac.util.translation import _
-from trac.wiki.formatter import wiki_to_oneliner
-from trac.web.api import IRequestHandler
-
-
-_TRUE_VALUES = ('yes', 'true', 'on', 'aye', '1', 1, True)
-
-
-
@@ -47 +44 @@
-    """
-    implements(IWikiMacroProvider, IHTMLPreviewRenderer, IRequestHandler)
-
-    cache_dir_option = Option("graphviz", "cache_dir", "gvcache",
-            """The directory that will be used to cache the generated images
-            (note that the directory must exist).
-            If not given as an absolute path, the path will be relative to 
-            the Trac environment's directory.
-            """)
-
-    encoding = Option("graphviz", "encoding", 'utf-8',
-            """The encoding which should be used for communicating with
-            Graphviz (should match -Gcharset if given).
-            """)
-
-    # Available formats and processors, default first (dot/png)
@@ -84 +69 @@
-        }
-
+    # Note: the following options named "..._option" are those which need
+    #       some additional processing, see `load_config()` below.
+
+
+    cache_dir_option = Option("graphviz", "cache_dir", "gvcache",
+            """The directory that will be used to cache the generated images
+            (note that the directory must exist).
+            If not given as an absolute path, the path will be relative to 
+            the Trac environment's directory.
+            """)
+
+    encoding = Option("graphviz", "encoding", 'utf-8',
+            """The encoding which should be used for communicating with
+            Graphviz (should match -Gcharset if given).
+            """)
+
+    cmd_path = Option("graphviz", "cmd_path", '',
+            r"""Full path to the directory where the graphviz
+            programs are located. If not specified, the
+            default is /usr/bin on Linux, c:\Program
+            Files\ATT\Graphviz\bin on Windows and
+            /usr/local/bin on FreeBSD 6.
+            """)
+
+    out_format = Option("graphviz", "out_format", Formats[0],
+            """Graph output format. Valid formats are: png, jpg,
+            svg, svgz, gif. If not specified, the default is
+            png. This setting can be overrided on a per-graph
+            basis.
+            """)
+
+    processor = Option("graphviz", "processor", Processors[0],
+            """Graphviz default processor. Valid processors
+            are: dot, neato, twopi, fdp, circo. If not
+            specified, the default is dot. This setting can
+            be overrided on a per-graph basis.
+
+            GraphvizMacro will verify that the default
+            processor is installed and will not work if it
+            is missing. All other processors are optional.
+            If any of the other processors are missing, a
+            warning message will be sent to the trac log and
+            GraphvizMacro will continue to work.
+            """)
+
+    png_anti_alias = BoolOption("graphviz", "png_antialias", False,
+            """If this entry exists in the configuration file,
+            then PNG outputs will be antialiased.
+            Note that this requires `rsvg` to be installed.
+            """)
+
+    rsvg_path_option = Option("graphviz", "rsvg_path", "",
+            """Full path to where the rsvg binary can be found.
+            The default is cmd_path + rsvg.
+            """)
+
+    cache_manager = BoolOption("graphviz", "cache_manager", False,
+            """If this entry exists and set to true in the configuration file,
+            then the cache management logic will be invoked
+            and the cache_max_size, cache_min_size,
+            cache_max_count and cache_min_count must be
+            defined.
+            """)
+
+    cache_max_size = IntOption("graphviz", "cache_max_size", 1024*1024*10,
+            """The maximum size in bytes that the cache should
+            consume. This is the high watermark for disk space
+            used.
+            """)
+
+    cache_min_size = IntOption("graphviz", "cache_min_size", 1024*1024*5,
+            """When cleaning out the cache, remove files until
+            this size in bytes is used by the cache. This is
+            the low watermark for disk space used.
+            """)
+
+    cache_max_count = IntOption("graphviz", "cache_max_count", 2000,
+            """The maximum number of files that the cache should
+            contain. This is the high watermark for the
+            directory entry count.
+            """)
+
+    cache_min_count = IntOption("graphviz", "cache_minax_count", 1500,
+            """The maximum number of files that the cache should
+            contain. This is the high watermark for the
+            directory entry count.
+            """)
+
+    dpi = IntOption('graphviz', 'default_graph_dpi', 96,
+            """Default dpi setting for graphviz, used during SVG to PNG 
+            rasterization.
+            """)
+
-
-    def __init__(self):
@@ -90 +168 @@
-        #self.log.info('formats: %s' % str(Graphviz.Formats))
-
+    # IWikiMacroProvider methods
-
-    def get_macros(self):
@@ -138 +217 @@
-        content - The text the user entered for the macro to process.
-        """
-
-        self.formatter = formatter
-        self.env = formatter.env
-        req = formatter.req
-
-        # check and load the configuration
-trouble, 
-trouble
-msg.getvalue(
+err
+errmsg
+self.show_err(errmsg
-
-        buf = StringIO()
-
-        ## Extract processor and format from name
-l_proc = l_out_format = ''
+processor = out_format = None
-
-        # first try with the RegExp engine
-        try: 
-            m = re.match('graphviz\.?([a-z]*)\/?([a-z]*)', name)
-l_proc, l_
+processor, 
-
-        # or use the string.split method
@@ -164 +240 @@
-                s_sp = d_sp[1].split('/')
-                if len(s_sp) > 1:
-l_
-l_proc
+
+processor
-            elif len(s_sp) > 1:
-l_
+
-            
-        # assign default values, if instance ones are empty
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-        else:
-
-
-
+
+
+
+
-           
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-                .encode(self.encoding)
-        encoded_content = content.encode(self.encoding)
-        sha_key  = sha.new(encoded_cmd + encoded_content).hexdigest()
-self.processor, self.
+processor, 
-        # cache: hash.<dot>.<png>
-        img_path = os.path.join(self.cache_dir, img_name)
-self.
+
-        # cache: hash.<dot>.map
-        map_path = os.path.join(self.cache_dir, map_name)
@@ -207 +287 @@
-            #self.log.debug('render_macro.URL_in_graph: %s' % str(URL_in_graph))
-            if URL_in_graph: # translate wiki TracLinks in URL
-
+formatter, out_format, 
-
-            # Antialias PNGs with rsvg, if requested
-self.
+
-                # 1. SVG output
-                cmd = [proc_cmd] + self.processor_options + \
@@ -228 +308 @@
-            else: # Render other image formats
-                cmd = [proc_cmd] + self.processor_options + \
-self.
+
-                out, err = self.launch(cmd, encoded_content)
-                if len(out) or len(err):
@@ -235 +315 @@
-
-            # Generate a map file for binary formats
-self.
+
-
-                # Create the map if not in cache
@@ -249 +329 @@
-        # Generate HTML output
-        # for SVG(z)
-self.
+
-            try: # try to get SVG dimensions
-                f = open(img_path, 'r')
@@ -287 +367 @@
-
-
-
+formatter, out_format, 
-        """Expand TracLinks that follow all URL= patterns."""
-return re.sub(r'URL="(.*?)"', self._expand_wiki_links, content)
-
-def _expand_wiki_links(self, match):
-wiki_url = match.groups()[0] # TracLink ([1], source:file/, ...)
-
-# <a href="http://someurl">...</a>
-
-href     = re.search('href="(.*?)"', html_url)   # http://someurl
-url      = href and href.groups()[0] or html_url
-if self.out_format == 'svg'
-format = 'URL="javascript:window.parent.location.href=\'%s\'
-else:
-    format = 'URL="%s"'
-
+def expand(match):
+
+        html_url = wiki_to_oneliner(wiki_url, self.env, req=formatter.req)
+    # <a href="http://someurl">...</a>
+
+    href     = re.search('href="(.*?)"', html_url)   # http://someurl
+
+    if out_format == 'svg':
+        format = 'URL="javascript:window.parent.location.href=\'%s\'"'
+    else
+    format = 'URL="%s
+    return format % url
+return re.sub(r'URL="(.*?)"', expand, content)
+
-
-    def load_config(self):
-
-
-
-
-
-
+
+
+
+
-
-        # check for the cache_dir entry
-        self.cache_dir = self.cache_dir_option
-        if not self.cache_dir:
-
-
+
-
-        if not os.path.isabs(self.cache_dir):
@@ -322 +399 @@
-
-        if not os.path.exists(self.cache_dir):
-
-
-
+
+
-
-        # Get optional configuration parameters from trac.ini.
-
-
-
-
-
+
-        cmd_paths = Graphviz.Cmd_Paths.get(sys.platform, [])
-
-cfg_path = self.config.get('graphviz', 'cmd_path')
-if cfg_path
-if not os.path.exists(cfg_path):
-msg = 'The cmd_path is set to "%s" but that path does not exist.' % cfg_path
-return True, self.show_err(msg
-cfg
+if self.cmd_path:
+    if not os.path.exists(self.cmd_path)
+    return _("The '[graphviz] cmd_path' configuration entry "
+         "is set to '%(path)s' but that path does not exist.", 
+         path=self.cmd_path
+self.cmd
-
-        if not cmd_paths:
-msg = 'The [graphviz] section is missing the cmd_path field and there is no default for %s.' % sys.platform
-return True, self.show_err(msg)
-
+return _("The '[graphviz] cmd_path' configuration entry "
+         "is not set and there is no default for %(platform)s.",
+
-
-        self.cmds = {}
-        pname = self._find_cmd(self.processor, cmd_paths)
-        if not pname:
-msg = 'The default processor, %s, was not found in %s.' % (self.processor, str(cmd_paths))
-return True, self.show_err(msg
+return _("The default processor '%(proc)s' was not found "
+         "in '%(paths)s'.", proc=self.processor, paths=cmd_paths
-
-        for name in Graphviz.Processors:
@@ -356 +429 @@
-
-            if not pname:
-
+
+
+
-                Graphviz.Processors.remove(name)
-
-            self.cmds[name] = pname
-
-        # check for the default output format - out_format
-        self.out_format = self.config.get('graphviz', 'out_format', 
-                                          Graphviz.Formats[0])
-
-        # check if png anti aliasing should be done - png_antialias
-        self.png_anti_alias = self.config.getbool(
-                'graphviz', 'png_antialias', False)
-
-        if self.png_anti_alias:
-config.get('graphviz', 'rsvg_path',
-                         self._find_cmd('rsvg', cmd_paths)
-
+rsvg_path_option or \
+self._find_cmd('rsvg', cmd_paths
+
-            if not os.path.exists(self.rsvg_path):
-err = 'The rsvg program is set to "%s" but that path does not exist.' % self.rsvg_path
-return True, self.show_err(err
+return _("The rsvg program is set to '%(path)s' but that path "
+         "does not exist.", path=self.rsvg_path
-
-        # get default graph/node/edge attributes
@@ -390 +457 @@
-                            (optkey, name.replace(prefix,''), value))
-
-        # check if we should run the cache manager
-        self.cache_manager = self.boolean(self.config.get('graphviz', 'cache_manager', False))
-        if self.cache_manager:
-            # use IntOption
-            self.cache_max_size  = int(self.config.get('graphviz', 'cache_max_size',  10000000))
-            self.cache_min_size  = int(self.config.get('graphviz', 'cache_min_size',  5000000))
-            self.cache_max_count = int(self.config.get('graphviz', 'cache_max_count', 2000))
-            self.cache_min_count = int(self.config.get('graphviz', 'cache_min_count', 1500))
-
-        # is there a graphviz default DPI setting?
-        self.dpi = int(self.config.get('graphviz', 'default_graph_dpi', 96))
-
-        # setup mimetypes to support the IHTMLPreviewRenderer interface
-        if 'graphviz' not in MIME_MAP:
@@ -408 +463 @@
-            if processor not in MIME_MAP:
-                MIME_MAP[processor] = 'application/graphviz'
-
-        return False, buf
-
-
@@ -503 +556 @@
-                        size = size - entry_list[file][6]
-
-    # Extra helper functions
-    def boolean(self, value):
-        # This code is almost directly from trac.config in the 0.10 line...
-        if isinstance(value, basestring):
-            value = value.lower() in _TRUE_VALUES
-        return bool(value)
-
-
-    MIME_TYPES = ('application/graphviz')
-
@@ -521 +566 @@
-        return 0
-
-req
+context
-        ext = filename.split('.')[1]
-        name = ext == 'graphviz' and 'graphviz' or 'graphviz.%s' % ext
-        text = hasattr(content, 'read') and content.read() or content
-req
+context
-
-
@@ -536 +581 @@
-    def process_request(self, req):
-        # check and load the configuration
-trouble, 
-trouble
-msg.getvalue(
+err
+errmsg
+self.show_err(errmsg
-
-        pieces = [item for item in req.path_info.split('/graphviz') if item]

graphvizplugin/0.11/README.txt

@@ -113 +113 @@
-
-    cache_dir       - The directory that will be used to cache the 
-
+ That directory must exist.
-
-    cmd_path        - Full path to the directory where the graphviz