4 * Copyright 2004 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
8 * PhpWiki is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * PhpWiki is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * The Ploticus plugin passes all its arguments to the ploticus
25 * binary and displays the result as PNG, GIF, EPS, SVG or SWF.
26 * Ploticus is a free, GPL, non-interactive software package
27 * for producing plots, charts, and graphics from data.
28 * See http://ploticus.sourceforge.net/doc/welcome.html
30 * @Author: Reini Urban
33 * - For windows you need either a gd library with GIF support or
34 * a ploticus with PNG support. This comes e.g. with the cygwin build.
35 * - We support only images supported by GD so far (PNG most likely).
36 * No EPS, PS, SWF, SVG or SVGZ support yet, due to limitations in WikiPluginCached.
37 * This will be fixed soon.
40 <<Ploticus device=png [ploticus options...]
41 multiline ploticus script ...
43 * or without any script: (not tested)
44 <<Ploticus -prefab vbars data=myfile.dat delim=tab y=1 clickmapurl="http://mywiki.url/wiki/?pagename=@2" clickmaplabel="@3" -csmap >>
46 * TODO: PloticusSql - create intermediate data from SQL. Similar to SqlResult, just in graphic form.
47 * For example to produce nice looking pagehit statistics or ratings statistics.
48 * Ploticus has its own sql support within #getproc data, but this would expose security information.
51 if (!defined("PLOTICUS_EXE"))
53 define('PLOTICUS_EXE', 'pl.exe');
55 define('PLOTICUS_EXE', '/usr/local/bin/pl');
56 //TODO: check $_ENV['PLOTICUS_PREFABS'] and default directory
58 require_once 'lib/WikiPluginCached.php';
60 class WikiPlugin_Ploticus
61 extends WikiPluginCached
64 * Sets plugin type to MAP if -csmap (-map or -mapdemo or -csmapdemo not supported)
65 * or HTML if the imagetype is not supported by GD (EPS, SVG, SVGZ) (not yet)
66 * or IMG_INLINE if device = png, gif or jpeg
68 function getPluginType()
70 if (!empty($this->_args['-csmap']))
71 return PLUGIN_CACHED_MAP; // not yet tested
72 // produce these on-demand so far, uncached.
73 // will get better support in WikiPluginCached soon.
74 // FIXME: html also? what about ''?
75 $type = $this->decideImgType($this->_args['device']);
76 if ($type == $this->_args['device'])
77 return PLUGIN_CACHED_IMG_INLINE;
78 $device = strtolower($this->_args['device']);
79 if (in_array($device, array('svg', 'swf', 'svgz', 'eps', 'ps', 'pdf', 'html'))) {
80 switch ($this->_args['device']) {
83 return PLUGIN_CACHED_STATIC | PLUGIN_CACHED_SVG_PNG;
85 return PLUGIN_CACHED_STATIC | PLUGIN_CACHED_SWF;
87 return PLUGIN_CACHED_STATIC | PLUGIN_CACHED_HTML;
90 return PLUGIN_CACHED_IMG_INLINE; // normal cached libgd image handles
98 function getDescription()
100 return _("Ploticus image creation");
103 function managesValidators()
108 function getDefaultArguments()
111 'device' => 'png', // png,gif,svgz,svg,...
114 'data' => false, // <!plugin-list !> support
120 function handle_plugin_args_cruft(&$argstr, &$args)
122 $this->source = $argstr;
126 * Sets the expire time to one day (so the image producing
127 * functions are called seldomly) or to about two minutes
128 * if a help screen is created.
130 function getExpire($dbi, $argarray, $request)
132 if (!empty($argarray['help']))
133 return '+120'; // 2 minutes
134 return sprintf('+%d', 3 * 86000); // approx 3 days
138 * Sets the imagetype according to user wishes and
139 * relies on WikiPluginCached to catch illegal image
141 * (I feel unsure whether this option is reasonable in
142 * this case, because png will definitely have the
145 * @return string 'png', 'jpeg', 'gif'
147 function getImageType($dbi, $argarray, $request)
149 return $argarray['device'];
153 * This gives an alternative text description of
156 function getAlt($dbi, $argstr, $request)
158 return (!empty($this->_args['alt'])) ? $this->_args['alt']
159 : $this->getDescription();
163 * Returns an image containing a usage description of the plugin.
165 * TODO: -csmap pointing to the Ploticus documentation at sf.net.
166 * @return string image handle
170 $def = $this->defaultArguments();
171 //$other_imgtypes = $GLOBALS['PLUGIN_CACHED_IMGTYPES'];
172 //unset ($other_imgtypes[$def['imgtype']]);
175 'device' => ' = "' . $def['device'] . "(default)|"
176 . join('|', $GLOBALS['PLUGIN_CACHED_IMGTYPES']) . '"',
177 'data' => ' <!plugin-list !>: pagelist as input',
178 'alt' => ' = "alternate text"',
179 '-csmap' => ' bool: clickable map?',
180 'help' => ' bool: displays this screen',
181 '...' => ' all further lines below the first plugin line ',
182 '' => ' and inside the tags are the ploticus script.',
186 foreach ($helparr as $alignright => $alignleft) {
187 $length = max($length, strlen($alignright));
190 foreach ($helparr as $alignright => $alignleft) {
191 $helptext .= substr(' '
192 . $alignright, -$length) . $alignleft . "\n";
194 return $this->text2img($helptext, 4, array(1, 0, 0),
195 array(255, 255, 255));
198 function withShellCommand($script)
201 $pos = strpos($script, $findme); // uppercase?
207 function getImage($dbi, $argarray, $request)
209 //extract($this->getArgs($argstr, $request));
210 //extract($argarray);
211 $source =& $this->source;
212 if (!empty($source)) {
213 if ($this->withShellCommand($source)) {
214 $this->_errortext .= _("shell commands not allowed in Ploticus");
217 if (is_array($argarray['data'])) { // support <!plugin-list !> pagelists
218 $src = "#proc getdata\ndata:";
220 foreach ($argarray['data'] as $data) {
223 $src .= ("\t" . join(" ", $data) . "\n");
225 $src .= ("\t" . '"' . $data . '" ' . $i++ . "\n");
230 $tempfile = $this->tempnam('Ploticus', 'plo');
232 $gif = $argarray['device'];
233 $args = "-$gif -o $tempfile.$gif";
234 if (!empty($argarray['-csmap'])) {
235 $args .= " -csmap -mapfile $tempfile.map";
236 $this->_mapfile = "$tempfile.map";
238 if (!empty($argarray['-prefab'])) {
239 //check $_ENV['PLOTICUS_PREFABS'] and default directory
240 global $HTTP_ENV_VARS;
241 if (empty($HTTP_ENV_VARS['PLOTICUS_PREFABS'])) {
242 if (file_exists("/usr/share/ploticus"))
243 $HTTP_ENV_VARS['PLOTICUS_PREFABS'] = "/usr/share/ploticus";
244 elseif (defined('PLOTICUS_PREFABS'))
245 $HTTP_ENV_VARS['PLOTICUS_PREFABS'] = constant('PLOTICUS_PREFABS');
247 $args .= (" -prefab " . $argarray['-prefab']);
250 $fp = fopen("$tempfile.plo", "w");
251 fwrite($fp, $source);
253 $code = $this->execute(PLOTICUS_EXE . " $tempfile.plo $args", $tempfile . ".$gif");
255 $code = $this->filterThroughCmd($source, PLOTICUS_EXE . " -stdin $args");
259 // return $this->error(fmt("Couldn't start commandline '%s'", $commandLine));
260 if (!file_exists($tempfile . ".$gif")) {
261 $this->_errortext .= sprintf(_("%s error: outputfile '%s' not created"),
262 "Ploticus", "$tempfile.$gif");
264 $this->_errortext .= ("\ncmd-line: " . PLOTICUS_EXE . " $tempfile.plo $args");
266 $this->_errortext .= ("\ncmd-line: cat script | " . PLOTICUS_EXE . " $args");
267 @unlink("$tempfile.pl");
268 @unlink("$tempfile");
271 $ImageCreateFromFunc = "ImageCreateFrom$gif";
272 if (function_exists($ImageCreateFromFunc)) {
273 $handle = $ImageCreateFromFunc("$tempfile.$gif");
275 @unlink("$tempfile.$gif");
276 @unlink("$tempfile.plo");
277 @unlink("$tempfile");
281 return "$tempfile.$gif";
283 return $this->error(fmt("empty source"));
287 // which argument must be set to 'png', for the fallback image when svg will fail on the client.
294 function getMap($dbi, $argarray, $request)
296 $img = $this->getImage($dbi, $argarray, $request);
297 return array($this->_mapfile, $img);
307 // c-hanging-comment-ender-p: nil
308 // indent-tabs-mode: nil