lib/plugin/VisualWiki.php

   1 <?php
   2
   3 /*
   4  * Copyright (C) 2002 Johannes Große (Johannes Gro&szlig;e)
   5  *
   6  * This file is part of PhpWiki.
   7  *
   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.
  12  *
  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.
  17  *
  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.
  21  */
  22
  23 /**
  24  * Produces graphical site map of PhpWiki
  25  * Example for an image map creating plugin. It produces a graphical
  26  * sitemap of PhpWiki by calling the <code>dot</code> commandline tool
  27  * from graphviz (http://www.graphviz.org).
  28  * @author Johannes Große
  29  * @version 0.9
  30  */
  31 /* define('VISUALWIKI_ALLOWOPTIONS', true); */
  32 if (!defined('VISUALWIKI_ALLOWOPTIONS'))
  33     define('VISUALWIKI_ALLOWOPTIONS', false);
  34
  35 require_once 'lib/plugin/GraphViz.php';
  36
  37 class WikiPlugin_VisualWiki
  38     extends WikiPlugin_GraphViz
  39 {
  40     /**
  41      * Sets plugin type to map production
  42      */
  43     function getPluginType()
  44     {
  45         return ($GLOBALS['request']->getArg('debug')) ? PLUGIN_CACHED_IMG_ONDEMAND
  46             : PLUGIN_CACHED_MAP;
  47     }
  48
  49     /**
  50      * Sets the plugin's name to VisualWiki. It can be called by
  51      * <code>&lt;?plugin VisualWiki?&gt;</code>, now. This
  52      * name must correspond to the filename and the class name.
  53      */
  54     function getName()
  55     {
  56         return "VisualWiki";
  57     }
  58
  59     /**
  60      * Sets textual description.
  61      */
  62     function getDescription()
  63     {
  64         return _("Visualizes the Wiki structure in a graph using the 'dot' commandline tool from graphviz.");
  65     }
  66
  67     /**
  68      * Returns default arguments. This is put into a separate
  69      * function to allow its usage by both <code>getDefaultArguments</code>
  70      * and <code>checkArguments</code>
  71      */
  72     function defaultarguments()
  73     {
  74         return array('imgtype' => 'png',
  75             'width' => false, // was 5, scale it automatically
  76             'height' => false, // was 7, scale it automatically
  77             'colorby' => 'age', // sort by 'age' or 'revtime'
  78             'fillnodes' => 'off',
  79             'label' => 'name',
  80             'shape' => 'ellipse',
  81             'large_nb' => 5,
  82             'recent_nb' => 5,
  83             'refined_nb' => 15,
  84             'backlink_nb' => 5,
  85             'neighbour_list' => '',
  86             'exclude_list' => '',
  87             'include_list' => '',
  88             'fontsize' => 9,
  89             'debug' => false,
  90             'help' => false);
  91     }
  92
  93     /**
  94      * Sets the default arguments. WikiPlugin also regards these as
  95      * the allowed arguments. Since WikiPluginCached stores an image
  96      * for each different set of parameters, there can be a lot of
  97      * these (large) graphs if you allow different parameters.
  98      * Set <code>VISUALWIKI_ALLOWOPTIONS</code> to <code>false</code>
  99      * to allow no options to be set and use only the default parameters.
 100      * This will need an disk space of about 20 Kbyte all the time.
 101      */
 102     function getDefaultArguments()
 103     {
 104         if (VISUALWIKI_ALLOWOPTIONS)
 105             return $this->defaultarguments();
 106         else
 107             return array();
 108     }
 109
 110     /**
 111      * Substitutes each forbidden parameter value by the default value
 112      * defined in <code>defaultarguments</code>.
 113      */
 114     function checkArguments(&$arg)
 115     {
 116         extract($arg);
 117         $def = $this->defaultarguments();
 118         if (($width < 3) || ($width > 15))
 119             $arg['width'] = $def['width'];
 120         if (($height < 3) || ($height > 20))
 121             $arg['height'] = $def['height'];
 122         if (($fontsize < 8) || ($fontsize > 24))
 123             $arg['fontsize'] = $def['fontsize'];
 124         if (!in_array($label, array('name', 'number')))
 125             $arg['label'] = $def['label'];
 126
 127         if (!in_array($shape, array('ellipse', 'box', 'point', 'circle',
 128             'plaintext'))
 129         )
 130             $arg['shape'] = $def['shape'];
 131         if (!in_array($colorby, array('age', 'revtime')))
 132             $arg['colorby'] = $def['colorby'];
 133         if (!in_array($fillnodes, array('on', 'off')))
 134             $arg['fillnodes'] = $def['fillnodes'];
 135         if (($large_nb < 0) || ($large_nb > 50))
 136             $arg['large_nb'] = $def['large_nb'];
 137         if (($recent_nb < 0) || ($recent_nb > 50))
 138             $arg['recent_nb'] = $def['recent_nb'];
 139         if (($refined_nb < 0) || ($refined_nb > 50))
 140             $arg['refined_nb'] = $def['refined_nb'];
 141         if (($backlink_nb < 0) || ($backlink_nb > 50))
 142             $arg['backlink_nb'] = $def['backlink_nb'];
 143         // ToDo: check if "ImageCreateFrom$imgtype"() exists.
 144         if (!in_array($imgtype, $GLOBALS['PLUGIN_CACHED_IMGTYPES']))
 145             $arg['imgtype'] = $def['imgtype'];
 146         if (empty($fontname))
 147             $arg['fontname'] = VISUALWIKIFONT;
 148     }
 149
 150     /**
 151      * Checks options, creates help page if necessary, calls both
 152      * database access and image map production functions.
 153      * @param WikiDB $dbi
 154      * @param array $argarray
 155      * @param Request $request
 156      * @return array($map,$html)
 157      */
 158     function getMap($dbi, $argarray, $request)
 159     {
 160         if (!VISUALWIKI_ALLOWOPTIONS)
 161             $argarray = $this->defaultarguments();
 162         $this->checkArguments($argarray);
 163         $request->setArg('debug', $argarray['debug']);
 164         //extract($argarray);
 165         if ($argarray['help'])
 166             return array($this->helpImage(), ' '); // FIXME
 167         $this->createColors();
 168         $this->extract_wikipages($dbi, $argarray);
 169         /* ($dbi,  $large, $recent, $refined, $backlink,
 170             $neighbour, $excludelist, $includelist, $color); */
 171         $result = $this->invokeDot($argarray);
 172         if (isa($result, 'HtmlElement'))
 173             return array(false, $result);
 174         else
 175             return $result;
 176         /* => ($width, $height, $color, $shape, $text); */
 177     }
 178
 179     // ------------------------------------------------------------------------------------------
 180
 181     /**
 182      * Returns an image containing a usage description of the plugin.
 183      * @return string image handle
 184      */
 185     function helpImage()
 186     {
 187         $def = $this->defaultarguments();
 188         $other_imgtypes = $GLOBALS['PLUGIN_CACHED_IMGTYPES'];
 189         unset ($other_imgtypes[$def['imgtype']]);
 190         $helparr = array(
 191             '<<' . $this->getName() .
 192                 ' img' => ' = "' . $def['imgtype'] . "(default)|" . join('|', $GLOBALS['PLUGIN_CACHED_IMGTYPES']) . '"',
 193             'width' => ' = "width in inches"',
 194             'height' => ' = "height in inches"',
 195             'fontname' => ' = "font family"',
 196             'fontsize' => ' = "fontsize in points"',
 197             'colorby' => ' = "age|revtime|none"',
 198             'fillnodes' => ' = "on|off"',
 199             'shape' => ' = "ellipse(default)|box|circle|point"',
 200             'label' => ' = "name|number"',
 201             'large_nb' => ' = "number of largest pages to be selected"',
 202             'recent_nb' => ' = "number of youngest pages"',
 203             'refined_nb' => ' = "#pages with smallest time between revisions"',
 204             'backlink_nb' => ' = "number of pages with most backlinks"',
 205             'neighbour_list' => ' = "find pages linked from and to these pages"',
 206             'exclude_list' => ' = "colon separated list of pages to be excluded"',
 207             'include_list' => ' = "colon separated list"     >>'
 208         );
 209         $length = 0;
 210         foreach ($helparr as $alignright => $alignleft) {
 211             $length = max($length, strlen($alignright));
 212         }
 213         $helptext = '';
 214         foreach ($helparr as $alignright => $alignleft) {
 215             $helptext .= substr('                                                        '
 216                 . $alignright, -$length) . $alignleft . "\n";
 217         }
 218         return $this->text2img($helptext, 4, array(1, 0, 0),
 219             array(255, 255, 255));
 220     }
 221
 222     /**
 223      * Selects the first (smallest or biggest) WikiPages in
 224      * a given category.
 225      *
 226      * @param int $number
 227      * @param string $category
 228      * @param bool $minimum
 229      * @internal param int $number number of page names to be found
 230      * @internal param string $category attribute of the pages which is used
 231      *                           to compare them
 232      * @internal param bool $minimum true finds smallest, false finds biggest
 233      * @return array list of page names found to be the best
 234      */
 235     function findbest($number, $category, $minimum)
 236     {
 237         // select the $number best in the category '$category'
 238         $pages = &$this->pages;
 239         $names = &$this->names;
 240
 241         $selected = array();
 242         $i = 0;
 243         foreach ($names as $name) {
 244             if ($i++ >= $number)
 245                 break;
 246             $selected[$name] = $pages[$name][$category];
 247         }
 248         //echo "<pre>$category "; var_dump($selected); "</pre>";
 249         $compareto = $minimum ? 0x79999999 : -0x79999999;
 250
 251         $i = 0;
 252         foreach ($names as $name) {
 253             if ($i++ < $number)
 254                 continue;
 255             if ($minimum) {
 256                 if (($crit = $pages[$name][$category]) < $compareto) {
 257                     $selected[$name] = $crit;
 258                     asort($selected, SORT_NUMERIC);
 259                     array_pop($selected);
 260                     $compareto = end($selected);
 261                 }
 262             } elseif (($crit = $pages[$name][$category]) > $compareto) {
 263                 $selected[$name] = $crit;
 264                 arsort($selected, SORT_NUMERIC);
 265                 array_pop($selected);
 266                 $compareto = end($selected);
 267             }
 268         }
 269         //echo "<pre>$category "; var_dump($selected); "</pre>";
 270
 271         return array_keys($selected);
 272     }
 273
 274     /**
 275      * Extracts a subset of all pages from the wiki and find their
 276      * connections to other pages. Also collects some page features
 277      * like size, age, revision number which are used to find the
 278      * most attractive pages.
 279      *
 280      * @param WikiDB $dbi
 281      * @param $argarray
 282      * @internal param \WikiDB $dbi database handle to access all Wiki pages
 283      * @internal param int $LARGE number of largest pages which should
 284      *                              be included
 285      * @internal param int $RECENT number of the youngest pages to be included
 286      * @internal param int $REFINED number of the pages with shortes revision
 287      *                              interval
 288      * @internal param int $BACKLINK number of the pages with most backlinks
 289      * @internal param string $EXCLUDELIST colon ':' separated list of page names which
 290      *                              should not be displayed (like PhpWiki, for
 291      *                              example)
 292      * @internal param string $INCLUDELIST colon separated list of pages which are
 293      *                              always included (for example your own
 294      *                              page :)
 295      * @internal param string $COLOR 'age', 'revtime' or 'none'; Selects which
 296      *                              page feature is used to determine the
 297      *                              filling color of the nodes in the graph.
 298      * @return void
 299      */
 300     function extract_wikipages($dbi, $argarray)
 301     {
 302         // $LARGE, $RECENT, $REFINED, $BACKLINK, $NEIGHBOUR,
 303         // $EXCLUDELIST, $INCLUDELIST,$COLOR
 304         $now = time();
 305
 306         extract($argarray);
 307         // FIXME: gettextify?
 308         $exclude_list = $exclude_list ? explode(':', $exclude_list) : array();
 309         $include_list = $include_list ? explode(':', $include_list) : array();
 310         $neighbour_list = $neighbour_list ? explode(':', $neighbour_list) : array();
 311
 312         // remove INCLUDED from EXCLUDED, includes override excludes.
 313         if ($exclude_list and $include_list) {
 314             $diff = array_diff($exclude_list, $include_list);
 315             if ($diff)
 316                 $exclude_list = $diff;
 317         }
 318
 319         // collect all pages
 320         $allpages = $dbi->getAllPages(false, false, false, $exclude_list);
 321         $pages = &$this->pages;
 322         $countpages = 0;
 323         while ($page = $allpages->next()) {
 324             $name = $page->getName();
 325
 326             // skip excluded pages
 327             if (in_array($name, $exclude_list)) {
 328                 $page->free();
 329                 continue;
 330             }
 331
 332             // false = get links from actual page
 333             // true  = get links to actual page ("backlinks")
 334             $backlinks = $page->getLinks(true);
 335             unset($bconnection);
 336             $bconnection = array();
 337             while ($blink = $backlinks->next()) {
 338                 array_push($bconnection, $blink->getName());
 339             }
 340             $backlinks->free();
 341             unset($backlinks);
 342
 343             // include all neighbours of pages listed in $NEIGHBOUR
 344             if (in_array($name, $neighbour_list)) {
 345                 $ln = $page->getLinks(false);
 346                 $con = array();
 347                 while ($link = $ln->next()) {
 348                     array_push($con, $link->getName());
 349                 }
 350                 $include_list = array_merge($include_list, $bconnection, $con);
 351                 $ln->free();
 352                 unset($l);
 353                 unset($con);
 354             }
 355
 356             unset($rev);
 357             $rev = $page->getCurrentRevision();
 358
 359             $pages[$name] = array(
 360                 'age' => $now - $rev->get('mtime'),
 361                 'revnr' => $rev->getVersion(),
 362                 'links' => array(),
 363                 'backlink_nb' => count($bconnection),
 364                 'backlinks' => $bconnection,
 365                 'size' => 1000 // FIXME
 366             );
 367             $pages[$name]['revtime'] = $pages[$name]['age'] / ($pages[$name]['revnr']);
 368
 369             unset($page);
 370         }
 371         $allpages->free();
 372         unset($allpages);
 373         $this->names = array_keys($pages);
 374
 375         $countpages = count($pages);
 376
 377         // now select each page matching to given parameters
 378         $all_selected = array_unique(array_merge(
 379             $this->findbest($recent_nb, 'age', true),
 380             $this->findbest($refined_nb, 'revtime', true),
 381             $x = $this->findbest($backlink_nb, 'backlink_nb', false),
 382 //          $this->findbest($large_nb,    'size',        false),
 383             $include_list));
 384
 385         foreach ($all_selected as $name)
 386             if (isset($pages[$name]))
 387                 $newpages[$name] = $pages[$name];
 388         unset($this->names);
 389         unset($this->pages);
 390         $this->pages = $newpages;
 391         $pages = &$this->pages;
 392         $this->names = array_keys($pages);
 393         unset($newpages);
 394         unset($all_selected);
 395
 396         $countpages = count($pages);
 397
 398         // remove dead links and collect links
 399         reset($pages);
 400         while (list($name, $page) = each($pages)) {
 401             if (is_array($page['backlinks'])) {
 402                 reset($page['backlinks']);
 403                 while (list($index, $link) = each($page['backlinks'])) {
 404                     if (!isset($pages[$link]) || $link == $name) {
 405                         unset($pages[$name]['backlinks'][$index]);
 406                     } else {
 407                         array_push($pages[$link]['links'], $name);
 408                         //array_push($this->everylink, array($link,$name));
 409                     }
 410                 }
 411             }
 412         }
 413
 414         if ($colorby == 'none')
 415             return;
 416         list($oldestname) = $this->findbest(1, $colorby, false);
 417         $this->oldest = $pages[$oldestname][$colorby];
 418         foreach ($this->names as $name)
 419             $pages[$name]['color'] = $this->getColor($pages[$name][$colorby] / $this->oldest);
 420     }
 421
 422     /**
 423      * Creates the text file description of the graph needed to invoke
 424      * <code>dot</code>.
 425      *
 426      * @param string $filename
 427      * @param bool $argarray
 428      * @internal param string $filename name of the dot file to be created
 429      * @internal param float $width width of the output graph in inches
 430      * @internal param float $height height of the graph in inches
 431      * @internal param string $colorby color sceme beeing used ('age', 'revtime',
 432      *                                                   'none')
 433      * @internal param string $shape node shape; 'ellipse', 'box', 'circle', 'point'
 434      * @internal param string $label 'name': label by name,
 435      *                          'number': label by unique number
 436      * @return boolean error status; true=ok; false=error
 437      */
 438     function createDotFile($filename, $argarray)
 439     {
 440         extract($argarray);
 441         if (!$fp = fopen($filename, 'w'))
 442             return false;
 443
 444         $fillstring = ($fillnodes == 'on') ? 'style=filled,' : '';
 445
 446         $ok = true;
 447         $names = &$this->names;
 448         $pages = &$this->pages;
 449         if ($names)
 450             $nametonumber = array_flip($names);
 451
 452         $dot = "digraph VisualWiki {\n" // }
 453             . (!empty($fontpath) ? "    fontpath=\"$fontpath\"\n" : "");
 454         if ($width and $height)
 455             $dot .= "    size=\"$width,$height\";\n    ";
 456
 457         switch ($shape) {
 458             case 'point':
 459                 $dot .= "edge [arrowhead=none];\nnode [shape=$shape,fontname=$fontname,width=0.15,height=0.15,fontsize=$fontsize];\n";
 460                 break;
 461             case 'box':
 462                 $dot .= "node [shape=$shape,fontname=$fontname,width=0.4,height=0.4,fontsize=$fontsize];\n";
 463                 break;
 464             case 'circle':
 465                 $dot .= "node [shape=$shape,fontname=$fontname,width=0.25,height=0.25,fontsize=$fontsize];\n";
 466                 break;
 467             default :
 468                 $dot .= "node [fontname=$fontname,shape=$shape,fontsize=$fontsize];\n";
 469         }
 470         $dot .= "\n";
 471         $i = 0;
 472         foreach ($names as $name) {
 473
 474             $url = rawurlencode($name);
 475             // patch to allow Page/SubPage
 476             $url = str_replace(urlencode(SUBPAGE_SEPARATOR), SUBPAGE_SEPARATOR, $url);
 477             $nodename = ($label != 'name' ? $nametonumber[$name] + 1 : $name);
 478
 479             $dot .= "    \"$nodename\" [URL=\"$url\"";
 480             if ($colorby != 'none') {
 481                 $col = $pages[$name]['color'];
 482                 $dot .= sprintf(',%scolor="#%02X%02X%02X"', $fillstring,
 483                     $col[0], $col[1], $col[2]);
 484             }
 485             $dot .= "];\n";
 486
 487             if (!empty($pages[$name]['links'])) {
 488                 unset($linkarray);
 489                 if ($label != 'name')
 490                     foreach ($pages[$name]['links'] as $linkname)
 491                         $linkarray[] = $nametonumber[$linkname] + 1;
 492                 else
 493                     $linkarray = $pages[$name]['links'];
 494                 $linkstring = join('"; "', $linkarray);
 495
 496                 $c = count($pages[$name]['links']);
 497                 $dot .= "        \"$nodename\" -> "
 498                     . ($c > 1 ? '{' : '')
 499                     . "\"$linkstring\";"
 500                     . ($c > 1 ? '}' : '')
 501                     . "\n";
 502             }
 503         }
 504         if ($colorby != 'none') {
 505             $dot .= "\n    subgraph cluster_legend {\n"
 506                 . "         node[fontname=$fontname,shape=box,width=0.4,height=0.4,fontsize=$fontsize];\n"
 507                 . "         fillcolor=lightgrey;\n"
 508                 . "         style=filled;\n"
 509                 . "         fontname=$fontname;\n"
 510                 . "         fontsize=$fontsize;\n"
 511                 . "         label=\"" . gettext("Legend") . "\";\n";
 512             $oldest = ceil($this->oldest / (24 * 3600));
 513             $max = 5;
 514             $legend = array();
 515             for ($i = 0; $i < $max; $i++) {
 516                 $time = floor($i / $max * $oldest);
 517                 $name = '"' . $time . ' ' . _("days") . '"';
 518                 $col = $this->getColor($i / $max);
 519                 $dot .= sprintf('       %s [%scolor="#%02X%02X%02X"];',
 520                     $name, $fillstring, $col[0], $col[1], $col[2])
 521                     . "\n";
 522                 $legend[] = $name;
 523             }
 524             $dot .= '        ' . join(' -> ', $legend)
 525                 . ";\n    }\n";
 526         }
 527
 528         // {
 529         $dot .= "}\n";
 530         $this->source = $dot;
 531         // write a temp file
 532         $ok = fwrite($fp, $dot);
 533         $ok = fclose($fp) && $ok; // close anyway
 534
 535         return $ok;
 536     }
 537
 538     /**
 539      * static workaround on broken Cache or broken dot executable,
 540      * called only if debug=static.
 541      *
 542      * @access private
 543      * @param string $url
 544      * @param WikiDB $dbi
 545      * @param array $argarray
 546      * @param  request  Request ???
 547      * @internal param string $url url pointing to the image part of the map
 548      * @internal param string $map &lt;area&gt; tags defining active
 549      *                          regions in the map
 550      * @internal param \WikiDB $dbi database abstraction class
 551      * @internal param array $argarray complete (!) arguments to produce
 552      *                          image. It is not necessary to call
 553      *                          WikiPlugin->getArgs anymore.
 554      * @return string html output
 555      */
 556     function embedImg($url, &$dbi, $argarray, &$request)
 557     {
 558         if (!VISUALWIKI_ALLOWOPTIONS)
 559             $argarray = $this->defaultarguments();
 560         $this->checkArguments($argarray);
 561         //extract($argarray);
 562         if ($argarray['help'])
 563             return array($this->helpImage(), ' '); // FIXME
 564         $this->createColors();
 565         $this->extract_wikipages($dbi, $argarray);
 566         list($imagehandle, $content['html']) = $this->invokeDot($argarray);
 567         // write to uploads and produce static url
 568         $file_dir = getUploadFilePath();
 569         $upload_dir = getUploadDataPath();
 570         $tmpfile = tempnam($file_dir, "VisualWiki") . "." . $argarray['imgtype'];
 571         WikiPluginCached::writeImage($argarray['imgtype'], $imagehandle, $tmpfile);
 572         ImageDestroy($imagehandle);
 573         return WikiPluginCached::embedMap(1, $upload_dir . basename($tmpfile), $content['html'],
 574             $dbi, $argarray, $request);
 575     }
 576
 577     /**
 578      * Prepares some rainbow colors for the nodes of the graph
 579      * and stores them in an array which may be accessed with
 580      * <code>getColor</code>.
 581      */
 582     function createColors()
 583     {
 584         $predefcolors = array(
 585             array('red' => 255, 'green' => 0, 'blue' => 0),
 586             array('red' => 255, 'green' => 255, 'blue' => 0),
 587             array('red' => 0, 'green' => 255, 'blue' => 0),
 588             array('red' => 0, 'green' => 255, 'blue' => 255),
 589             array('red' => 0, 'green' => 0, 'blue' => 255),
 590             array('red' => 100, 'green' => 100, 'blue' => 100)
 591         );
 592
 593         $steps = 2;
 594         $numberofcolors = count($predefcolors) * $steps;
 595
 596         $promille = -1;
 597         foreach ($predefcolors as $color) {
 598             if ($promille < 0) {
 599                 $oldcolor = $color;
 600                 $promille = 0;
 601                 continue;
 602             }
 603             for ($i = 0; $i < $steps; $i++)
 604                 $this->ColorTab[++$promille / $numberofcolors * 1000] = array(
 605                     floor(interpolate($oldcolor['red'], $color['red'], $i / $steps)),
 606                     floor(interpolate($oldcolor['green'], $color['green'], $i / $steps)),
 607                     floor(interpolate($oldcolor['blue'], $color['blue'], $i / $steps))
 608                 );
 609             $oldcolor = $color;
 610         }
 611 //echo"<pre>";  var_dump($this->ColorTab); echo "</pre>";
 612     }
 613
 614     /**
 615      * Translates a value from 0.0 to 1.0 into rainbow color.
 616      * red -&gt; orange -&gt; green -&gt; blue -&gt; gray
 617      *
 618      * @param float $promille
 619      * @internal param float $promille value between 0.0 and 1.0
 620      * @return array(red,green,blue)
 621      */
 622     function getColor($promille)
 623     {
 624         foreach ($this->ColorTab as $pro => $col) {
 625             if ($promille * 1000 < $pro)
 626                 return $col;
 627         }
 628         $lastcol = end($this->ColorTab);
 629         return $lastcol;
 630     }
 631 }
 632
 633 /**
 634  * Linear interpolates a value between two point a and b
 635  * at a value pos.
 636  * @param $a
 637  * @param $b
 638  * @param $pos
 639  * @return float  interpolated value
 640  */
 641 function interpolate($a, $b, $pos)
 642 {
 643     return $a + ($b - $a) * $pos;
 644 }
 645
 646 // Local Variables:
 647 // mode: php
 648 // tab-width: 8
 649 // c-basic-offset: 4
 650 // c-hanging-comment-ender-p: nil
 651 // indent-tabs-mode: nil
 652 // End: