/usr/share/pyshared/sphinxcontrib/packetdiag.py is in python-sphinxcontrib.nwdiag 0.7.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | # -*- coding: utf-8 -*-
"""
packetdiag.sphinx_ext
~~~~~~~~~~~~~~~~~~~~~~
Allow packetdiag-formatted diagrams to be included in Sphinx-generated
documents inline.
:copyright: Copyright 2010 by Takeshi Komiya.
:license: BSDL.
"""
import io
import os
import posixpath
import traceback
from collections import namedtuple
try:
from hashlib import sha1 as sha
except ImportError:
from sha import sha
from docutils import nodes
from sphinx.errors import SphinxError
from sphinx.util.osutil import ensuredir
import packetdiag_sphinxhelper as packetdiag
class PacketdiagError(SphinxError):
category = 'Packetdiag error'
class Packetdiag(packetdiag.utils.rst.directives.PacketdiagDirective):
def run(self):
try:
return super(Packetdiag, self).run()
except packetdiag.core.parser.ParseException as e:
if self.content:
msg = '[%s] ParseError: %s\n%s' % (self.name, e, "\n".join(self.content))
else:
msg = '[%s] ParseError: %s\n%r' % (self.name, e, self.arguments[0])
reporter = self.state.document.reporter
return [reporter.warning(msg, line=self.lineno)]
def node2image(self, node, diagram):
return node
def get_image_filename(self, code, format, options, prefix='packetdiag'):
"""
Get path of output file.
"""
if format.upper() not in ('PNG', 'PDF', 'SVG'):
raise PacketdiagError('packetdiag error:\nunknown format: %s\n' % format)
if format.upper() == 'PDF':
try:
import reportlab
except ImportError:
msg = 'packetdiag error:\n' + \
'colud not output PDF format; Install reportlab\n'
raise PacketdiagError(msg)
hashkey = (code + str(options)).encode('utf-8')
fname = '%s-%s.%s' % (prefix, sha(hashkey).hexdigest(), format.lower())
if hasattr(self.builder, 'imgpath'):
# HTML
relfn = posixpath.join(self.builder.imgpath, fname)
outfn = os.path.join(self.builder.outdir, '_images', fname)
else:
# LaTeX
relfn = fname
outfn = os.path.join(self.builder.outdir, fname)
if os.path.isfile(outfn):
return relfn, outfn
ensuredir(os.path.dirname(outfn))
return relfn, outfn
def get_fontmap(self):
FontMap = packetdiag.utils.fontmap.FontMap
try:
fontmappath = self.builder.config.packetdiag_fontmap
fontmap = FontMap(fontmappath)
except:
attrname = '_packetdiag_fontmap_warned'
if not hasattr(self.builder, attrname):
msg = ('packetdiag cannot load "%s" as fontmap file, '
'check the packetdiag_fontmap setting' % fontmappath)
self.builder.warn(msg)
setattr(self.builder, attrname, True)
fontmap = FontMap(None)
try:
fontpath = self.builder.config.packetdiag_fontpath
if isinstance(fontpath, packetdiag.utils.compat.string_types):
fontpath = [fontpath]
if fontpath:
config = namedtuple('Config', 'font')(fontpath)
_fontpath = packetdiag.utils.bootstrap.detectfont(config)
fontmap.set_default_font(_fontpath)
except:
attrname = '_packetdiag_fontpath_warned'
if not hasattr(self.builder, attrname):
msg = ('packetdiag cannot load "%s" as truetype font, '
'check the packetdiag_fontpath setting' % fontpath)
self.builder.warn(msg)
setattr(self.builder, attrname, True)
return fontmap
def create_packetdiag(self, code, format, filename, options, prefix='packetdiag'):
"""
Render packetdiag code into a PNG output file.
"""
draw = None
fontmap = get_fontmap(self)
try:
tree = packetdiag.core.parser.parse_string(code)
diagram = packetdiag.core.builder.ScreenNodeBuilder.build(tree)
antialias = self.builder.config.packetdiag_antialias
draw = packetdiag.core.drawer.DiagramDraw(format, diagram, filename,
fontmap=fontmap, antialias=antialias)
except Exception as e:
if self.builder.config.packetdiag_debug:
traceback.print_exc()
raise PacketdiagError('packetdiag error:\n%s\n' % e)
return draw
def make_svgtag(self, image, relfn, trelfn, outfn,
alt, thumb_size, image_size):
svgtag_format = """<svg xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
alt="%s" width="%s" height="%s">%s
</svg>"""
code = io.open(outfn, 'r', encoding='utf-8-sig').read()
return (svgtag_format %
(alt, image_size[0], image_size[1], code))
def make_imgtag(self, image, relfn, trelfn, outfn,
alt, thumb_size, image_size):
result = ""
imgtag_format = '<img src="%s" alt="%s" width="%s" height="%s" />\n'
if trelfn:
result += ('<a href="%s">' % relfn)
result += (imgtag_format %
(trelfn, alt, thumb_size[0], thumb_size[1]))
result += ('</a>')
else:
result += (imgtag_format %
(relfn, alt, image_size[0], image_size[1]))
return result
def render_dot_html(self, node, code, options, prefix='packetdiag',
imgcls=None, alt=None):
trelfn = None
thumb_size = None
try:
format = self.builder.config.packetdiag_html_image_format
relfn, outfn = get_image_filename(self, code, format, options, prefix)
image = create_packetdiag(self, code, format, outfn, options, prefix)
if not os.path.isfile(outfn):
image.draw()
image.save()
# generate thumbnails
image_size = image.pagesize()
if 'maxwidth' in options and options['maxwidth'] < image_size[0]:
thumb_prefix = prefix + '_thumb'
trelfn, toutfn = get_image_filename(self, code, format,
options, thumb_prefix)
ratio = float(options['maxwidth']) / image_size[0]
thumb_size = (options['maxwidth'], image_size[1] * ratio)
if not os.path.isfile(toutfn):
image.filename = toutfn
image.save(thumb_size)
except UnicodeEncodeError:
msg = ("packetdiag error: UnicodeEncodeError caught "
"(check your font settings)")
self.builder.warn(msg)
raise nodes.SkipNode
except PacketdiagError as exc:
self.builder.warn('dot code %r: ' % code + str(exc))
raise nodes.SkipNode
self.body.append(self.starttag(node, 'p', CLASS='packetdiag'))
if relfn is None:
self.body.append(self.encode(code))
else:
if alt is None:
alt = node.get('alt', self.encode(code).strip())
if format.upper() == 'SVG':
tagfunc = make_svgtag
else:
tagfunc = make_imgtag
self.body.append(tagfunc(self, image, relfn, trelfn, outfn, alt,
thumb_size, image_size))
self.body.append('</p>\n')
raise nodes.SkipNode
def html_visit_packetdiag(self, node):
render_dot_html(self, node, node['code'], node['options'])
def render_dot_latex(self, node, code, options, prefix='packetdiag'):
try:
format = self.builder.config.packetdiag_tex_image_format
fname, outfn = get_image_filename(self, code, format, options, prefix)
image = create_packetdiag(self, code, format, outfn, options, prefix)
if not os.path.isfile(outfn):
image.draw()
image.save()
except PacketdiagError as exc:
self.builder.warn('dot code %r: ' % code + str(exc))
raise nodes.SkipNode
if fname is not None:
self.body.append('\\par\\includegraphics{%s}\\par' % fname)
raise nodes.SkipNode
def latex_visit_packetdiag(self, node):
render_dot_latex(self, node, node['code'], node['options'])
def on_doctree_resolved(self, doctree, docname):
if self.builder.name in ('gettext', 'singlehtml', 'html', 'latex', 'epub'):
return
for node in doctree.traverse(packetdiag.utils.rst.nodes.packetdiag):
code = node['code']
prefix = 'packetdiag'
format = 'PNG'
options = node['options']
relfn, outfn = get_image_filename(self, code, format, options, prefix)
image = create_packetdiag(self, code, format, outfn, options, prefix)
if not os.path.isfile(outfn):
image.draw()
image.save()
candidates = {'image/png': outfn}
image = nodes.image(uri=outfn, candidates=candidates)
node.parent.replace(node, image)
def setup(app):
app.add_node(packetdiag.utils.rst.nodes.packetdiag,
html=(html_visit_packetdiag, None),
latex=(latex_visit_packetdiag, None))
app.add_directive('packetdiag', Packetdiag)
app.add_config_value('packetdiag_fontpath', None, 'html')
app.add_config_value('packetdiag_fontmap', None, 'html')
app.add_config_value('packetdiag_antialias', False, 'html')
app.add_config_value('packetdiag_debug', False, 'html')
app.add_config_value('packetdiag_html_image_format', 'PNG', 'html')
app.add_config_value('packetdiag_tex_image_format', 'PNG', 'html')
app.connect("doctree-resolved", on_doctree_resolved)
|