lib/plugin/Chart.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright 2007 $ThePhpWikiProgrammingTeam
   5  * Copyright 2009 Marc-Etienne Vargenau, Alcatel-Lucent
   6  *
   7  * This file is part of PhpWiki.
   8  *
   9  * PhpWiki is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * PhpWiki is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 /*
  25  * Standard Alcatel-Lucent disclaimer for contributing to open source
  26  *
  27  * "The ChartPlugin ("Contribution") has not been tested and/or
  28  * validated for release as or in products, combinations with products or
  29  * other commercial use. Any use of the Contribution is entirely made at
  30  * the user's own responsibility and the user can not rely on any features,
  31  * functionalities or performances Alcatel-Lucent has attributed to the
  32  * Contribution.
  33  *
  34  * THE CONTRIBUTION BY ALCATEL-LUCENT IS PROVIDED AS IS, WITHOUT WARRANTY
  35  * OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  36  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, COMPLIANCE,
  37  * NON-INTERFERENCE AND/OR INTERWORKING WITH THE SOFTWARE TO WHICH THE
  38  * CONTRIBUTION HAS BEEN MADE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  39  * ALCATEL-LUCENT BE LIABLE FOR ANY DAMAGES OR OTHER LIABLITY, WHETHER IN
  40  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  41  * CONTRIBUTION OR THE USE OR OTHER DEALINGS IN THE CONTRIBUTION, WHETHER
  42  * TOGETHER WITH THE SOFTWARE TO WHICH THE CONTRIBUTION RELATES OR ON A STAND
  43  * ALONE BASIS."
  44  */
  45
  46 class WikiPlugin_Chart
  47 extends WikiPlugin
  48 {
  49     function getName() {
  50         return _("Chart");
  51     }
  52
  53     function getDescription() {
  54         return _("Render SVG charts");
  55     }
  56
  57     function getDefaultArguments() {
  58         return array('width'  => 200,
  59                      'height' => 200,
  60                      'type' => 'line', // or 'area', 'bar', 'pie'
  61                      // 'xlabel' => 'x', // TODO
  62                      // 'ylabel' => 'y', // TODO
  63                      'color' => 'green',
  64                      // 'legend' => false, // TODO
  65                      'data' => false // required
  66                      );
  67     }
  68     function handle_plugin_args_cruft(&$argstr, &$args) {
  69         $this->source = $argstr;
  70     }
  71
  72     function run($dbi, $argstr, &$request, $basepage) {
  73
  74         global $WikiTheme;
  75         $args = $this->getArgs($argstr, $request);
  76         if (!$args['data']) {
  77             return $this->error(sprintf(_("A required argument '%s' is missing."), 'data'));
  78         }
  79         extract($args);
  80
  81         $html = HTML();
  82         $js = JavaScript('', array ('src' => $WikiTheme->_findData('ASCIIsvg.js')));
  83         $html->pushContent($js);
  84
  85         $values = explode(",", $data);
  86
  87         // x_min = 0
  88         // x_max = number of elements in data
  89         // y_min = 0 or smallest element in data if negative
  90         // y_max = biggest element in data
  91
  92         $x_max = sizeof($values) + 1;
  93         $y_min = min($values);
  94         if ($y_min > 0) {
  95             $y_min = 0;
  96         }
  97         $y_max = max($values);
  98         // sum is used for the pie only, so we ignore negative values
  99         $sum = 0;
 100         foreach ($values as $value) {
 101             if ($value > 0) {
 102                 $sum += $value;
 103             }
 104         }
 105
 106         $source = 'initPicture(0,'.$x_max.','.$y_min.','.$y_max.'); axes(); stroke = "'.$color.'"; strokewidth = 5;';
 107
 108         if ($type == "bar") {
 109             $abscisse = 1;
 110             $source .= 'strokewidth = 10; ';
 111             foreach ($values as $value) {
 112                 $source .= 'point1 = ['.$abscisse.', 0];'
 113                         .  'point2 = ['.$abscisse.','.$value.'];'
 114                         .  'line(point1, point2);';
 115                 $abscisse += 1;
 116             }
 117         } elseif ($type == "line") {
 118             $abscisse = 0;
 119             $source .= 'strokewidth = 3; p = []; ';
 120             foreach ($values as $value) {
 121                 $source .= 'for (t = 1; t < 1.01; t += 1) p[p.length] = ['
 122                         .  $abscisse
 123                         .  ', t*'
 124                         .  trim($value)
 125                         .  '];';
 126                 $abscisse += 1;
 127             }
 128             $source .= 'path(p);';
 129         } elseif ($type == "pie") {
 130             $source = 'initPicture(-1.1,1.1,-1.1,1.1); stroke = "'.$color.'"; strokewidth = 1;'
 131                     . 'center = [0, 0]; circle(center, 1);'
 132                     . 'point = [1, 0]; line(center, point);';
 133             $angle = 0;
 134             foreach ($values as $value) {
 135                 if ($value > 0) {
 136                     $angle += $value/$sum;
 137                     $source .= 'point = [cos(2*pi*'.$angle.'), sin(2*pi*'.$angle.')]; line(center, point);';
 138                 }
 139             }
 140         }
 141
 142         $embedargs = array('width'  => $args['width'],
 143                            'height' => $args['height'],
 144                            'script' => $source);
 145         $embed = new SVG_HTML("embed", $embedargs);
 146         $html->pushContent($embed);
 147         return $html;
 148     }
 149 };
 150
 151 class SVG_HTML extends HtmlElement {
 152     function startTag() {
 153         $start = "<" . $this->_tag;
 154         $this->_setClasses();
 155         foreach ($this->_attr as $attr => $val) {
 156             if (is_bool($val)) {
 157                 if (!$val)
 158                     continue;
 159                 $val = $attr;
 160             }
 161             $qval = str_replace("\"", '&quot;', $this->_quote((string)$val));
 162             if ($attr == 'script')
 163                 // note the ' not "
 164                 $start .= " $attr='$qval'";
 165             else
 166                 $start .= " $attr=\"$qval\"";
 167         }
 168         $start .= ">";
 169         return $start;
 170     }
 171 }
 172
 173 // Local Variables:
 174 // mode: php
 175 // tab-width: 8
 176 // c-basic-offset: 4
 177 // c-hanging-comment-ender-p: nil
 178 // indent-tabs-mode: nil
 179 // End:
 180 ?>