lib/WikiPluginCached.php

   1 <?php // rcs_id('$Id$');
   2 /*
   3  * Copyright (C) 2002 Johannes Große
   4  * Copyright (C) 2004,2007 Reini Urban
   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
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /**
  24  * You should set up the options in config/config.ini at Part seven:
  25  * $ pear install http://pear.php.net/get/Cache
  26  * This file belongs to WikiPluginCached.
  27  */
  28
  29 require_once "lib/WikiPlugin.php";
  30 // require_once "lib/plugincache-config.php"; // replaced by config.ini settings!
  31
  32 // types:
  33 define('PLUGIN_CACHED_HTML', 0);         // cached html (extensive calculation)
  34 define('PLUGIN_CACHED_IMG_INLINE', 1);   // gd images
  35 define('PLUGIN_CACHED_MAP', 2);          // area maps
  36 define('PLUGIN_CACHED_SVG', 3);          // special SVG/SVGZ object
  37 define('PLUGIN_CACHED_SVG_PNG', 4);      // special SVG/SVGZ object with PNG fallback
  38 define('PLUGIN_CACHED_SWF', 5);          // special SWF (flash) object
  39 define('PLUGIN_CACHED_PDF', 6);          // special PDF object (inlinable?)
  40 define('PLUGIN_CACHED_PS', 7);           // special PS object (inlinable?)
  41 // boolean tests:
  42 define('PLUGIN_CACHED_IMG_ONDEMAND', 64);// don't cache
  43 define('PLUGIN_CACHED_STATIC', 128);     // make it available via /uploads/, not via /getimg.php?id=
  44
  45 /**
  46  * An extension of the WikiPlugin class to allow image output and
  47  * cacheing.
  48  * There are several abstract functions to be overloaded.
  49  * Have a look at the example files
  50  * <ul><li>plugin/TexToPng.php</li>
  51  *     <li>plugin/CacheTest.php (extremely simple example)</li>
  52  *     <li>plugin/RecentChangesCached.php</li>
  53  *     <li>plugin/VisualWiki.php</li>
  54  *     <li>plugin/Ploticus.php</li>
  55  * </ul>
  56  *
  57  * @author  Johannes Große, Reini Urban
  58  */
  59 class WikiPluginCached extends WikiPlugin
  60 {
  61     var $_static;
  62     /**
  63      * Produces URL and id number from plugin arguments which later on,
  64      * will allow to find a cached image or to reconstruct the complete
  65      * plugin call to recreate the image.
  66      *
  67      * @param cache    object the cache object used to store the images
  68      * @param argarray array  all parameters (including those set to
  69      *                        default values) of the plugin call to be
  70      *                        prepared
  71      * @access private
  72      * @return array(id,url)
  73      *
  74      * TODO: check if args is needed at all (on lost cache)
  75      */
  76     function genUrl($cache, $argarray) {
  77         global $request;
  78         //$cacheparams = $GLOBALS['CacheParams'];
  79
  80         $plugincall = serialize( array(
  81             'pluginname' => $this->getName(),
  82             'arguments'  => $argarray ) );
  83         $id = $cache->generateId( $plugincall );
  84         $plugincall_arg = rawurlencode($plugincall);
  85         //$plugincall_arg = md5($plugincall);
  86         // will not work if plugin has to recreate content and cache is lost
  87
  88         $url = DATA_PATH . '/getimg.php?';
  89         if (($lastchar = substr($url,-1)) == '/') {
  90             $url = substr($url, 0, -1);
  91         }
  92         if (strlen($plugincall_arg) > PLUGIN_CACHED_MAXARGLEN) {
  93             // we can't send the data as URL so we just send the id
  94             if (!$request->getSessionVar('imagecache'.$id)) {
  95                 $request->setSessionVar('imagecache'.$id, $plugincall);
  96             }
  97             $plugincall_arg = false; // not needed anymore
  98         }
  99
 100         if ($lastchar == '?') {
 101             // this indicates that a direct call of the image creation
 102             // script is wished ($url is assumed to link to the script)
 103             $url .= "id=$id" . ($plugincall_arg ? '&args='.$plugincall_arg : '');
 104         } else {
 105             // Not yet supported.
 106             // We are supposed to use the indirect 404 ErrorDocument method
 107             // ($url is assumed to be the url of the image in
 108             //  cache_dir and the image creation script is referred to in the
 109             //  ErrorDocument 404 directive.)
 110             $url .= '/' . PLUGIN_CACHED_FILENAME_PREFIX . $id . '.img'
 111                 . ($plugincall_arg ? '?args='.$plugincall_arg : '');
 112         }
 113         if ($request->getArg("start_debug") and (DEBUG & _DEBUG_REMOTE))
 114             $url .= "&start_debug=1";
 115         return array($id, $url);
 116     } // genUrl
 117
 118     /**
 119      * Replaces the abstract run method of WikiPlugin to implement
 120      * a cache check which can avoid redundant runs.
 121      * <b>Do not override this method in a subclass. Instead you may
 122      * rename your run method to getHtml, getImage or getMap.
 123      * Have a close look on the arguments and required return values,
 124      * however. </b>
 125      *
 126      * @access protected
 127      * @param  dbi       WikiDB  database abstraction class
 128      * @param  argstr    string  plugin arguments in the call from PhpWiki
 129      * @param  request   Request ???
 130      * @param  string    basepage Pagename to use to interpret links [/relative] page names.
 131      * @return           string  HTML output to be printed to browser
 132      *
 133      * @see #getHtml
 134      * @see #getImage
 135      * @see #getMap
 136      */
 137     function run ($dbi, $argstr, &$request, $basepage) {
 138         $cache = $this->newCache();
 139         //$cacheparams = $GLOBALS['CacheParams'];
 140
 141         $sortedargs = $this->getArgs($argstr, $request);
 142         if (is_array($sortedargs) )
 143             ksort($sortedargs);
 144         $this->_args =& $sortedargs;
 145         $this->_type = $this->getPluginType();
 146         $this->_static = false;
 147         if ($this->_type & PLUGIN_CACHED_STATIC
 148             or $request->getArg('action') == 'pdf') // htmldoc doesn't grok subrequests
 149         {
 150             $this->_type = $this->_type & ~PLUGIN_CACHED_STATIC;
 151             $this->_static = true;
 152         }
 153
 154         // ---------- embed static image, no getimg.php? url -----------------
 155         if (0 and $this->_static) {
 156             //$content = $cache->get($id, 'imagecache');
 157             $content = array();
 158             if ($this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html')) {
 159                 // save the image in uploads
 160                 return $this->embedImg($content['url'], $dbi, $sortedargs, $request);
 161             } else {
 162                 // copy the cached image into uploads if older
 163                 return HTML();
 164             }
 165         }
 166
 167         list($id, $url) = $this->genUrl($cache, $sortedargs);
 168         // ---------- don't check cache: html and img gen. -----------------
 169         // override global PLUGIN_CACHED_USECACHE for a plugin
 170         if ($this->getPluginType() & PLUGIN_CACHED_IMG_ONDEMAND) {
 171             if ($this->_static and $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html'))
 172                 $url = $content['url'];
 173             return $this->embedImg($url, $dbi, $sortedargs, $request);
 174         }
 175
 176         $do_save = false;
 177         $content = $cache->get($id, 'imagecache');
 178         switch ($this->_type) {
 179             case PLUGIN_CACHED_HTML:
 180                 if (!$content || !$content['html']) {
 181                     $this->resetError();
 182                     $content['html'] = $this->getHtml($dbi, $sortedargs, $request, $basepage);
 183                     if ($errortext = $this->getError()) {
 184                         $this->printError($errortext, 'html');
 185                         return HTML();
 186                     }
 187                     $do_save = true;
 188                 }
 189                 break;
 190             case PLUGIN_CACHED_IMG_INLINE:
 191                 if (PLUGIN_CACHED_USECACHE && (!$content || !$content['image'])) { // new
 192                     $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
 193                     if ($this->_static) $url = $content['url'];
 194                     $content['html'] = $do_save ? $this->embedImg($url, $dbi, $sortedargs, $request) : false;
 195                 } elseif (!empty($content['url']) && $this->_static) {   // already in cache
 196                     $content['html'] = $this->embedImg($content['url'], $dbi, $sortedargs, $request);
 197                 } elseif (!empty($content['image']) && $this->_static) { // copy from cache to upload
 198                     $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
 199                     $url = $content['url'];
 200                     $content['html'] = $do_save ? $this->embedImg($url, $dbi, $sortedargs, $request) : false;
 201                 }
 202                 break;
 203             case PLUGIN_CACHED_MAP:
 204                 if (!$content || !$content['image'] || !$content['html'] ) {
 205                     $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
 206                     if ($this->_static) $url = $content['url'];
 207                     $content['html'] = $do_save
 208                         ? $this->embedMap($id, $url, $content['html'], $dbi, $sortedargs, $request)
 209                         : false;
 210                 }
 211                 break;
 212             case PLUGIN_CACHED_SVG:
 213                 if (!$content || !$content['html'] ) {
 214                     $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
 215                     if ($this->_static) $url = $content['url'];
 216                     $args = array(); //width+height => object args
 217                     if (!empty($sortedargs['width'])) $args['width'] = $sortedargs['width'];
 218                     if (!empty($sortedargs['height'])) $args['height'] = $sortedargs['height'];
 219                     $content['html'] = $do_save
 220                         ? $this->embedObject($url, 'image/svg+xml', $args,
 221                                              HTML::embed(array_merge(
 222                                              array('src'=>$url, 'type'=>'image/svg+xml'),
 223                                              $args)))
 224                         : false;
 225                 }
 226                 break;
 227             case PLUGIN_CACHED_SVG_PNG:
 228                 if (!$content || !$content['html'] ) {
 229                     $do_save_svg = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
 230                     if ($this->_static) $url = $content['url'];
 231                     // hack alert! somehow we should know which argument will produce the secondary image (PNG)
 232                     $args = $sortedargs;
 233                     $args[$this->pngArg()] = $content['imagetype']; // default type: PNG or GIF
 234                     $do_save = $this->produceImage($pngcontent, $this, $dbi, $args, $request, $content['imagetype']);
 235                     $args = array(); //width+height => object args
 236                     if (!empty($sortedargs['width'])) $args['width'] = $sortedargs['width'];
 237                     if (!empty($sortedargs['height'])) $args['height'] = $sortedargs['height'];
 238                     $content['html'] = $do_save_svg
 239                         ? $this->embedObject($url, 'image/svg+xml', $args,
 240                                              $this->embedImg($pngcontent['url'], $dbi, $sortedargs, $request))
 241                         : false;
 242                 }
 243                 break;
 244         }
 245         if ($do_save) {
 246             $content['args'] = md5($this->_pi);
 247             $expire = $this->getExpire($dbi, $content['args'], $request);
 248             $cache->save($id, $content, $expire, 'imagecache');
 249         }
 250         if ($content['html'])
 251             return $content['html'];
 252         return HTML();
 253     } // run
 254
 255
 256     /* --------------------- virtual or abstract functions ----------- */
 257
 258     /**
 259      * Sets the type of the plugin to html, image or map
 260      * production
 261      *
 262      * @access protected
 263      * @return int determines the plugin to produce either html,
 264      *             an image or an image map; uses on of the
 265      *             following predefined values
 266      *             <ul>
 267      *             <li>PLUGIN_CACHED_HTML</li>
 268      *             <li>PLUGIN_CACHED_IMG_INLINE</li>
 269      *             <li>PLUGIN_CACHED_IMG_ONDEMAND</li>
 270      *             <li>PLUGIN_CACHED_MAP</li>
 271      *             </ul>
 272      */
 273     function getPluginType() {
 274         return PLUGIN_CACHED_IMG_ONDEMAND;
 275     }
 276
 277     /**
 278      * Creates an image handle from the given user arguments.
 279      * This method is only called if the return value of
 280      * <code>getPluginType</code> is set to
 281      * PLUGIN_CACHED_IMG_INLINE or PLUGIN_CACHED_IMG_ONDEMAND.
 282      *
 283      * @access protected pure virtual
 284      * @param  dbi       WikiDB       database abstraction class
 285      * @param  argarray  array        complete (!) arguments to produce
 286      *                                image. It is not necessary to call
 287      *                                WikiPlugin->getArgs anymore.
 288      * @param  request   Request      ???
 289      * @return           imagehandle  image handle if successful
 290      *                                false if an error occured
 291      */
 292     function getImage($dbi,$argarray,$request) {
 293         trigger_error('WikiPluginCached::getImage: pure virtual function in file '
 294                       . __FILE__ . ' line ' . __LINE__, E_USER_ERROR);
 295         return false;
 296     }
 297
 298     /**
 299      * Sets the life time of a cache entry in seconds.
 300      * Expired entries are not used anymore.
 301      * During a garbage collection each expired entry is
 302      * removed. If removing all expired entries is not
 303      * sufficient, the expire time is ignored and removing
 304      * is determined by the last "touch" of the entry.
 305      *
 306      * @access protected virtual
 307      * @param  dbi       WikiDB       database abstraction class
 308      * @param  argarray  array        complete (!) arguments. It is
 309      *                                not necessary to call
 310      *                                WikiPlugin->getArgs anymore.
 311      * @param  request   Request      ???
 312      * @return           string       format: '+seconds'
 313      *                                '0' never expires
 314      */
 315     function getExpire($dbi,$argarray,$request) {
 316         return '0'; // persist forever
 317     }
 318
 319     /**
 320      * Decides the image type of an image output.
 321      * Always used unless plugin type is PLUGIN_CACHED_HTML.
 322      *
 323      * @access protected virtual
 324      * @param  dbi       WikiDB       database abstraction class
 325      * @param  argarray  array        complete (!) arguments. It is
 326      *                                not necessary to call
 327      *                                WikiPlugin->getArgs anymore.
 328      * @param  request   Request      ???
 329      * @return           string       'png', 'jpeg' or 'gif'
 330      */
 331     function getImageType(&$dbi, $argarray, &$request) {
 332         if (in_array($argarray['imgtype'], preg_split('/\s*:\s*/', PLUGIN_CACHED_IMGTYPES)))
 333             return $argarray['imgtype'];
 334         else
 335             return 'png';
 336     }
 337
 338     /**
 339      * Produces the alt text for an image.
 340      * <code> &lt;img src=... alt="getAlt(...)"&gt; </code>
 341      *
 342      * @access protected virtual
 343      * @param  dbi       WikiDB       database abstraction class
 344      * @param  argarray  array        complete (!) arguments. It is
 345      *                                not necessary to call
 346      *                                WikiPlugin->getArgs anymore.
 347      * @param  request   Request      ???
 348      * @return           string       "alt" description of the image
 349      */
 350     function getAlt($dbi,$argarray,$request) {
 351         return '<?plugin '.$this->getName().' '.$this->glueArgs($argarray).'?>';
 352     }
 353
 354     /**
 355      * Creates HTML output to be cached.
 356      * This method is only called if the plugin_type is set to
 357      * PLUGIN_CACHED_HTML.
 358      *
 359      * @access protected pure virtual
 360      * @param  dbi       WikiDB       database abstraction class
 361      * @param  argarray  array        complete (!) arguments to produce
 362      *                                image. It is not necessary to call
 363      *                                WikiPlugin->getArgs anymore.
 364      * @param  request   Request      ???
 365      * @param  string    $basepage    Pagename to use to interpret links [/relative] page names.
 366      * @return           string       html to be printed in place of the plugin command
 367      *                                false if an error occured
 368      */
 369     function getHtml($dbi, $argarray, $request, $basepage) {
 370         trigger_error('WikiPluginCached::getHtml: pure virtual function in file '
 371                       . __FILE__ . ' line ' . __LINE__, E_USER_ERROR);
 372     }
 373
 374     /**
 375      * Creates HTML output to be cached.
 376      * This method is only called if the plugin_type is set to
 377      * PLUGIN_CACHED_HTML.
 378      *
 379      * @access protected pure virtual
 380      * @param  dbi       WikiDB       database abstraction class
 381      * @param  argarray  array        complete (!) arguments to produce
 382      *                                image. It is not necessary to call
 383      *                                WikiPlugin->getArgs anymore.
 384      * @param  request   Request      ???
 385      * @return array(html,handle)     html for the map interior (to be specific,
 386      *                                only &lt;area;&gt; tags defining hot spots)
 387      *                                handle is an imagehandle to the corresponding
 388      *                                image.
 389      *                                array(false,false) if an error occured
 390      */
 391     function getMap($dbi, $argarray, $request) {
 392         trigger_error('WikiPluginCached::getHtml: pure virtual function in file '
 393                       . __FILE__ . ' line ' . __LINE__, E_USER_ERROR);
 394     }
 395
 396     /* --------------------- produce Html ----------------------------- */
 397
 398     /**
 399      * Creates an HTML map hyperlinked to the image specified
 400      * by url and containing the hotspots given by map.
 401      *
 402      * @access private
 403      * @param  id       string  unique id for the plugin call
 404      * @param  url      string  url pointing to the image part of the map
 405      * @param  map      string  &lt;area&gt; tags defining active
 406      *                          regions in the map
 407      * @param  dbi      WikiDB  database abstraction class
 408      * @param  argarray array   complete (!) arguments to produce
 409      *                          image. It is not necessary to call
 410      *                          WikiPlugin->getArgs anymore.
 411      * @param  request  Request ???
 412      * @return          string  html output
 413      */
 414     function embedMap($id,$url,$map,&$dbi,$argarray,&$request) {
 415         // id is not unique if the same map is produced twice
 416         $key = substr($id,0,8).substr(microtime(),0,6);
 417         return HTML(HTML::map(array( 'name' => $key ), $map ),
 418                     HTML::img( array(
 419                    'src'    => $url,
 420                    //  'alt'    => htmlspecialchars($this->getAlt($dbi,$argarray,$request))
 421                    'usemap' => '#'.$key ))
 422                );
 423     }
 424
 425     /**
 426      * Creates an HTML &lt;img&gt; tag hyperlinking to the specified
 427      * url and produces an alternative text for non-graphical
 428      * browsers.
 429      *
 430      * @access private
 431      * @param  url      string  url pointing to the image part of the map
 432      * @param  map      string  &lt;area&gt; tags defining active
 433      *                          regions in the map
 434      * @param  dbi      WikiDB  database abstraction class
 435      * @param  argarray array   complete (!) arguments to produce
 436      *                          image. It is not necessary to call
 437      *                          WikiPlugin->getArgs anymore.
 438      * @param  request  Request ???
 439      * @return          string  html output
 440      */
 441     function embedImg($url, $dbi, $argarray, $request) {
 442         return HTML::img( array(
 443             'src' => $url,
 444             'alt' => htmlspecialchars($this->getAlt($dbi, $argarray, $request)) ) );
 445     }
 446
 447     /**
 448      * svg?, swf, ...
 449      <object type="audio/x-wav" standby="Loading Audio" data="example.wav">
 450        <param name="src" value="example.wav" valuetype="data"></param>
 451        <param name="autostart" value="false" valuetype="data"></param>
 452        <param name="controls" value="ControlPanel" valuetype="data"></param>
 453        <a href="example.wav">Example Audio File</a>
 454      </object>
 455      * See http://www.protocol7.com/svg-wiki/?EmbedingSvgInHTML
 456      <object data="sample.svgz" type="image/svg+xml"
 457              width="400" height="300">
 458        <embed src="sample.svgz" type="image/svg+xml"
 459               width="400" height="300" />
 460        <p>Alternate Content like <img src="" /></p>
 461      </object>
 462      */
 463     // how to handle alternate images? always provide alternate static images?
 464     function embedObject($url, $type, $args = false, $params = false) {
 465         if (!$args) $args = array();
 466         $object = HTML::object(array_merge($args, array('src' => $url, 'type' => $type)));
 467         if ($params)
 468             $object->pushContent($params);
 469         return $object;
 470     }
 471
 472
 473 // --------------------------------------------------------------------------
 474 // ---------------------- static member functions ---------------------------
 475 // --------------------------------------------------------------------------
 476
 477     /**
 478      * Creates one static PEAR Cache object and returns copies afterwards.
 479      * FIXME: There should be references returned
 480      *
 481      * @access static protected
 482      * @return Cache  copy of the cache object
 483      */
 484     function newCache() {
 485         static $staticcache;
 486
 487         if (!is_object($staticcache)) {
 488             if (!class_exists('Cache')) {
 489                 // uuh, pear not in include_path! should print a warning.
 490                 // search some possible pear paths.
 491                 $pearFinder = new PearFileFinder;
 492                 if ($lib = $pearFinder->findFile('Cache.php', 'missing_ok'))
 493                     require_once($lib);
 494                 else // fall back to our own copy
 495                     require_once('lib/pear/Cache.php');
 496             }
 497             $cacheparams = array();
 498             foreach (explode(':','database:cache_dir:filename_prefix:highwater:lowwater'
 499                              .':maxlifetime:maxarglen:usecache:force_syncmap') as $key) {
 500                 $cacheparams[$key] = constant('PLUGIN_CACHED_'.strtoupper($key));
 501             }
 502             $cacheparams['imgtypes'] = preg_split('/\s*:\s*/', PLUGIN_CACHED_IMGTYPES);
 503             $staticcache = new Cache(PLUGIN_CACHED_DATABASE, $cacheparams);
 504             $staticcache->gc_maxlifetime = PLUGIN_CACHED_MAXLIFETIME;
 505
 506             if (! PLUGIN_CACHED_USECACHE ) {
 507                 $staticcache->setCaching(false);
 508             }
 509         }
 510         return $staticcache; // FIXME: use references ?
 511     }
 512
 513     /**
 514      * Determines whether a needed image type may is available
 515      * from the GD library and gives an alternative otherwise.
 516      *
 517      * @access  public static
 518      * @param   wish   string one of 'png', 'gif', 'jpeg', 'jpg'
 519      * @return         string the image type to be used ('png', 'gif', 'jpeg')
 520      *                        'html' in case of an error
 521      */
 522
 523     function decideImgType($wish) {
 524         if ($wish=='html') return $wish;
 525         if ($wish=='jpg') { $wish = 'jpeg'; }
 526
 527         $supportedtypes = array();
 528         // Todo: swf, pdf, ...
 529         $imagetypes = array(
 530             'png'   => IMG_PNG,
 531             'gif'   => IMG_GIF,
 532             'jpeg'  => IMG_JPEG,
 533             'wbmp'  => IMG_WBMP,
 534             'xpm'   => IMG_XPM,
 535             /* // these do work but not with the ImageType bitmask
 536             'gd'    => IMG_GD,
 537             'gd2'   => IMG_GD,
 538             'xbm'   => IMG_XBM,
 539             */
 540             );
 541         if (function_exists('ImageTypes')) {
 542             $presenttypes = ImageTypes();
 543             foreach ($imagetypes as $imgtype => $bitmask)
 544                 if ( $presenttypes && $bitmask )
 545                     array_push($supportedtypes, $imgtype);
 546         } else {
 547             foreach ($imagetypes as $imgtype => $bitmask)
 548                 if (function_exists("Image".$imgtype))
 549                     array_push($supportedtypes, $imgtype);
 550         }
 551         if (in_array($wish, $supportedtypes))
 552             return $wish;
 553         elseif (!empty($supportedtypes))
 554             return reset($supportedtypes);
 555         else
 556             return 'html';
 557
 558     } // decideImgType
 559
 560
 561     /**
 562      * Writes an image into a file or to the browser.
 563      * Note that there is no check if the image can
 564      * be written.
 565      *
 566      * @access  public static
 567      * @param   imgtype   string 'png', 'gif' or 'jpeg'
 568      * @param   imghandle string image handle containing the image
 569      * @param   imgfile   string file name of the image to be produced
 570      * @return  void
 571      * @see     decideImageType
 572      */
 573     function writeImage($imgtype, $imghandle, $imgfile=false) {
 574         if ($imgtype != 'html') {
 575             $func = "Image" . strtoupper($imgtype);
 576             if ($imgfile) {
 577                 $func($imghandle,$imgfile);
 578             } else {
 579                 $func($imghandle);
 580             }
 581         }
 582     } // writeImage
 583
 584
 585     /**
 586      * Sends HTTP Header for some predefined file types.
 587      * There is no parameter check.
 588      *
 589      * @access  public static
 590      * @param   doctype string 'gif', 'png', 'jpeg', 'html'
 591      * @return  void
 592      */
 593     function writeHeader($doctype) {
 594         static $IMAGEHEADER = array(
 595             'gif'  => 'Content-type: image/gif',
 596             'png'  => 'Content-type: image/png',
 597             'jpeg' => 'Content-type: image/jpeg',
 598             'xbm'  => 'Content-type: image/xbm',
 599             'xpm'  => 'Content-type: image/xpm',
 600             'gd'   => 'Content-type: image/gd',
 601             'gd2'  => 'Content-type: image/gd2',
 602             'wbmp' => 'Content-type: image/vnd.wap.wbmp', // wireless bitmaps for PDA's and such.
 603             'html' => 'Content-type: text/html' );
 604        // Todo: swf, pdf, svg, svgz
 605        Header($IMAGEHEADER[$doctype]);
 606     }
 607
 608
 609     /**
 610      * Converts argument array to a string of format option="value".
 611      * This should only be used for displaying plugin options for
 612      * the quoting of arguments is not safe, yet.
 613      *
 614      * @access public static
 615      * @param  argarray array   contains all arguments to be converted
 616      * @return          string  concated arguments
 617      */
 618     function glueArgs($argarray) {
 619         if (!empty($argarray)) {
 620             $argstr = '';
 621             while (list($key,$value)=each($argarray)) {
 622                 $argstr .= $key. '=' . '"' . $value . '" ';
 623                 // FIXME: How are values quoted? Can a value contain '"'?
 624                 // TODO: rawurlencode(value)
 625             }
 626             return substr($argstr, 0, strlen($argstr)-1);
 627         }
 628         return '';
 629     } // glueArgs
 630
 631     // ---------------------- FetchImageFromCache ------------------------------
 632
 633     /**
 634      * Extracts the cache entry id from the url and the plugin call
 635      * parameters if available.
 636      *
 637      * @access private static
 638      * @param  id           string   return value. Image is stored under this id.
 639      * @param  plugincall   string   return value. Only returned if present in url.
 640      *                               Contains all parameters to reconstruct
 641      *                               plugin call.
 642      * @param  cache        Cache    PEAR Cache object
 643      * @param  request      Request  ???
 644      * @param  errorformat  string   format which should be used to
 645      *                               output errors ('html', 'png', 'gif', 'jpeg')
 646      * @return boolean               false if an error occurs, true otherwise.
 647      *                               Param id and param plugincall are
 648      *                               also return values.
 649      */
 650     function checkCall1(&$id, &$plugincall, $cache, $request, $errorformat) {
 651         $id = $request->getArg('id');
 652         $plugincall = rawurldecode($request->getArg('args'));
 653
 654         if (!$id) {
 655            if (!$plugincall) {
 656                 // This should never happen, so do not gettextify.
 657                 $errortext = "Neither 'args' nor 'id' given. Cannot proceed without parameters.";
 658                 $this->printError($errorformat, $errortext);
 659                 return false;
 660             } else {
 661                 $id = $cache->generateId( $plugincall );
 662             }
 663         }
 664         return true;
 665     } // checkCall1
 666
 667
 668     /**
 669      * Extracts the parameters necessary to reconstruct the plugin
 670      * call needed to produce the requested image.
 671      *
 672      * @access static private
 673      * @param  plugincall string   reference to serialized array containing both
 674      *                             name and parameters of the plugin call
 675      * @param  request    Request  ???
 676      * @return            boolean  false if an error occurs, true otherwise.
 677      *
 678      */
 679     function checkCall2(&$plugincall, $request) {
 680         // if plugincall wasn't sent by URL, it must have been
 681         // stored in a session var instead and we can retreive it from there
 682         if (!$plugincall) {
 683             if (!$plugincall=$request->getSessionVar('imagecache'.$id)) {
 684                 // I think this is the only error which may occur
 685                 // without having written bad code. So gettextify it.
 686                 $errortext = sprintf(
 687                     gettext ("There is no image creation data available to id '%s'. Please reload referring page." ),
 688                     $id );
 689                 $this->printError($errorformat, $errortext);
 690                 return false;
 691             }
 692         }
 693         $plugincall = unserialize($plugincall);
 694         return true;
 695     } // checkCall2
 696
 697
 698     /**
 699      * Creates an image or image map depending on the plugin type.
 700      * @access static private
 701      * @param  content array             reference to created array which overwrite the keys
 702      *                                   'image', 'imagetype' and possibly 'html'
 703      * @param  plugin  WikiPluginCached  plugin which is called to create image or map
 704      * @param  dbi     WikiDB            handle to database
 705      * @param  argarray array            Contains all arguments needed by plugin
 706      * @param  request Request           ????
 707      * @param  errorformat string        outputs errors in 'png', 'gif', 'jpg' or 'html'
 708      * @return boolean                   error status; true=ok; false=error
 709      */
 710     function produceImage(&$content, $plugin, $dbi, $argarray, $request, $errorformat) {
 711         $plugin->resetError();
 712         $content['html'] = $imagehandle = false;
 713         if ($plugin->getPluginType() == PLUGIN_CACHED_MAP ) {
 714             list($imagehandle,$content['html']) = $plugin->getMap($dbi, $argarray, $request);
 715         } else {
 716             $imagehandle = $plugin->getImage($dbi, $argarray, $request);
 717         }
 718
 719         $content['imagetype']
 720             = $this->decideImgType($plugin->getImageType($dbi, $argarray, $request));
 721         $errortext = $plugin->getError();
 722
 723         if (!$imagehandle||$errortext) {
 724             if (!$errortext) {
 725                 $errortext = "'<?plugin ".$plugin->getName(). ' '
 726                     . $this->glueArgs($argarray)." ?>' returned no image, "
 727                     . " although no error was reported.";
 728             }
 729             $this->printError($errorformat, $errortext);
 730             return false;
 731         }
 732
 733         // image handle -> image data
 734         if (!empty($this->_static)) {
 735             $ext = "." . $content['imagetype'];
 736             if (is_string($imagehandle) and file_exists($imagehandle)) {
 737                 if (preg_match("/.(\w+)$/",$imagehandle,$m)) {
 738                     $ext = "." . $m[1];
 739                 }
 740             }
 741             $tmpfile = tempnam(getUploadFilePath(), PLUGIN_CACHED_FILENAME_PREFIX . $ext);
 742             if (!strstr(basename($tmpfile), $ext)) {
 743                 unlink($tmpfile);
 744                 $tmpfile .= $ext;
 745             }
 746             $tmpfile = getUploadFilePath() . basename($tmpfile);
 747             if (is_string($imagehandle) and file_exists($imagehandle)) {
 748                 rename($imagehandle, $tmpfile);
 749             }
 750         } else {
 751             $tmpfile = $this->tempnam();
 752         }
 753         if (is_resource($imagehandle)) {
 754             $this->writeImage($content['imagetype'], $imagehandle, $tmpfile);
 755             ImageDestroy($imagehandle);
 756             sleep(0.2);
 757         } elseif (is_string($imagehandle)) {
 758             $content['file'] = getUploadFilePath() . basename($tmpfile);
 759             $content['url'] = getUploadDataPath() . basename($tmpfile);
 760             return true;
 761         }
 762         if (file_exists($tmpfile)) {
 763             $fp = fopen($tmpfile,'rb');
 764             $content['image'] = fread($fp, filesize($tmpfile));
 765             fclose($fp);
 766             if (!empty($this->_static)) {
 767                 // on static it is in "uploads/" but in wikicached also
 768                 $content['file'] = $tmpfile;
 769                 $content['url'] = getUploadDataPath() . basename($tmpfile);
 770                 return true;
 771             }
 772             unlink($tmpfile);
 773             if ($content['image'])
 774                 return true;
 775         }
 776         return false;
 777     }
 778
 779     function staticUrl ($tmpfile) {
 780         $content['file'] = $tmpfile;
 781         $content['url'] = getUploadDataPath() . basename($tmpfile);
 782         return $content;
 783     }
 784
 785     function tempnam($prefix = "") {
 786         if (preg_match("/^(.+)\.(\w{2,4})$/", $prefix, $m)) {
 787             $prefix = $m[1];
 788             $ext = ".".$m[2];
 789         } else {
 790             $ext = isWindows()? ".tmp" : "";
 791         }
 792         $temp = tempnam(isWindows() ? str_replace('/', "\\", PLUGIN_CACHED_CACHE_DIR)
 793                                     : PLUGIN_CACHED_CACHE_DIR,
 794                        $prefix ? $prefix : PLUGIN_CACHED_FILENAME_PREFIX);
 795         if (isWindows()) {
 796             if ($ext != ".tmp") unlink($temp);
 797             $temp = preg_replace("/\.tmp$/", $ext, $temp);
 798         } else {
 799             $temp .= $ext;
 800         }
 801         return $temp;
 802     }
 803
 804     /**
 805      * Main function for obtaining images from cache or generating on-the-fly
 806      * from parameters sent by url or session vars.
 807      *
 808      * @access static public
 809      * @param  dbi     WikiDB            handle to database
 810      * @param  request Request           ???
 811      * @param  errorformat string        outputs errors in 'png', 'gif', 'jpeg' or 'html'
 812      */
 813     function fetchImageFromCache($dbi, $request, $errorformat='png') {
 814         $cache   = $this->newCache();
 815         $errorformat = $this->decideImgType($errorformat);
 816         // get id
 817         if (!$this->checkCall1($id, $plugincall, $cache, $request, $errorformat)) return false;
 818         // check cache
 819         $content = $cache->get($id, 'imagecache');
 820
 821         if (!empty($content['image'])) {
 822             $this->writeHeader($content['imagetype']);
 823             print $content['image'];
 824             return true;
 825         }
 826         if (!empty($content['html'])) {
 827             print $content['html'];
 828             return true;
 829         }
 830         // static version?
 831         if (!empty($content['file']) && !empty($content['url']) && file_exists($content['file'])) {
 832             print $this->embedImg($content['url'], $dbi, array(), $request);
 833             return true;
 834         }
 835
 836         // re-produce image. At first, we need the plugincall parameters.
 837         // Cached args with matching id override given args to shorten getimg.php?id=md5
 838         if (!empty($content['args']))
 839             $plugincall['arguments'] = $content['args'];
 840         if (!$this->checkCall2($plugincall, $request)) return false;
 841
 842         $pluginname = $plugincall['pluginname'];
 843         $argarray   = $plugincall['arguments'];
 844
 845         $loader = new WikiPluginLoader;
 846         $plugin = $loader->getPlugin($pluginname);
 847
 848         // cache empty, but image maps have to be created _inline_
 849         // so ask user to reload wiki page instead
 850         if (($plugin->getPluginType() & PLUGIN_CACHED_MAP) && PLUGIN_CACHED_FORCE_SYNCMAP) {
 851             $errortext = _("Image map expired. Reload wiki page to recreate its html part.");
 852             $this->printError($errorformat, $errortext);
 853         }
 854
 855         if (!$this->produceImage($content, $plugin, $dbi, $argarray,
 856                                  $request, $errorformat))
 857             return false;
 858
 859         $expire = $plugin->getExpire($dbi, $argarray, $request);
 860
 861         if ($content['image']) {
 862             $cache->save($id, $content, $expire, 'imagecache');
 863             $this->writeHeader($content['imagetype']);
 864             print $content['image'];
 865             return true;
 866         }
 867
 868         $errortext = "Could not create image file from imagehandle.";
 869         $this->printError($errorformat, $errortext);
 870         return false;
 871     } // FetchImageFromCache
 872
 873     // -------------------- error handling ----------------------------
 874
 875     /**
 876      * Resets buffer containing all error messages. This is allways
 877      * done before invoking any abstract creation routines like
 878      * <code>getImage</code>.
 879      *
 880      * @access private
 881      * @return void
 882      */
 883     function resetError() {
 884         $this->_errortext = '';
 885     }
 886
 887     /**
 888      * Returns all accumulated error messages.
 889      *
 890      * @access protected
 891      * @return string error messages printed with <code>complain</code>.
 892      */
 893     function getError() {
 894         return $this->_errortext;
 895     }
 896
 897     /**
 898      * Collects the error messages in a string for later output
 899      * by WikiPluginCached. This should be used for any errors
 900      * that occur during data (html,image,map) creation.
 901      *
 902      * @access protected
 903      * @param  addtext string errormessage to be printed (separate
 904      *                        multiple lines with '\n')
 905      * @return void
 906      */
 907     function complain($addtext) {
 908         $this->_errortext .= $addtext;
 909     }
 910
 911     /**
 912      * Outputs the error as image if possible or as html text
 913      * if wished or html header has already been sent.
 914      *
 915      * @access static protected
 916      * @param  imgtype string 'png', 'gif', 'jpeg' or 'html'
 917      * @param  errortext string guess what?
 918      * @return void
 919      */
 920     function printError($imgtype, $errortext) {
 921        $imgtype = $this->decideImgType($imgtype);
 922
 923        $talkedallready = ob_get_contents() || headers_sent();
 924        if (($imgtype=='html') || $talkedallready) {
 925            if (is_object($errortext))
 926                $errortext = $errortext->asXml();
 927            trigger_error($errortext, E_USER_WARNING);
 928        } else {
 929            $red = array(255,0,0);
 930            $grey = array(221,221,221);
 931            if (is_object($errortext))
 932                $errortext = $errortext->asString();
 933            $im = $this->text2img($errortext, 2, $red, $grey);
 934            if (!$im) {
 935                trigger_error($errortext, E_USER_WARNING);
 936                return;
 937            }
 938            $this->writeHeader($imgtype);
 939            $this->writeImage($imgtype, $im);
 940            ImageDestroy($im);
 941        }
 942     } // printError
 943
 944
 945     /**
 946      * Basic text to image converter for error handling which allows
 947      * multiple line output.
 948      * It will only output the first 25 lines of 80 characters. Both
 949      * values may be smaller if the chosen font is to big for there
 950      * is further restriction to 600 pixel in width and 350 in height.
 951      *
 952      * @access static public
 953      * @param  txt     string  multi line text to be converted
 954      * @param  fontnr  integer number (1-5) telling gd which internal font to use;
 955      *                         I recommend font 2 for errors and 4 for help texts.
 956      * @param  textcol array   text color as a list of the rgb components; array(red,green,blue)
 957      * @param  bgcol   array   background color; array(red,green,blue)
 958      * @return string          image handle for gd routines
 959      */
 960     function text2img($txt,$fontnr,$textcol,$bgcol) {
 961         // basic (!) output for error handling
 962
 963         // check parameters
 964         if ($fontnr<1 || $fontnr>5) {
 965             $fontnr = 2;
 966         }
 967         if (!is_array($textcol) || !is_array($bgcol)) {
 968                 $textcol = array(0,0,0);
 969                 $bgcol = array(255,255,255);
 970         }
 971         foreach( array_merge($textcol,$bgcol) as $component) {
 972             if ($component<0 || $component > 255) {
 973                 $textcol = array(0,0,0);
 974                 $bgcol = array(255,255,255);
 975                 break;
 976             }
 977         }
 978
 979         // prepare Parameters
 980
 981         // set maximum values
 982         $IMAGESIZE  = array(
 983             'cols'   => 80,
 984             'rows'   => 25,
 985             'width'  => 600,
 986             'height' => 350 );
 987
 988         if (function_exists('ImageFontWidth')) {
 989             $charx    = ImageFontWidth($fontnr);
 990             $chary    = ImageFontHeight($fontnr);
 991         } else {
 992             $charx = 10; $chary = 10;
 993         }
 994         $marginx  = $charx;
 995         $marginy  = floor($chary/2);
 996
 997         $IMAGESIZE['cols'] = min($IMAGESIZE['cols'], floor(($IMAGESIZE['width']  - 2*$marginx )/$charx));
 998         $IMAGESIZE['rows'] = min($IMAGESIZE['rows'], floor(($IMAGESIZE['height'] - 2*$marginy )/$chary));
 999
1000         // split lines
1001         $y = 0;
1002         $wx = 0;
1003         do {
1004             $len = strlen($txt);
1005             $npos = strpos($txt, "\n");
1006
1007             if ($npos===false) {
1008                 $breaklen = min($IMAGESIZE['cols'],$len);
1009             } else {
1010                 $breaklen = min($npos+1, $IMAGESIZE['cols']);
1011             }
1012             $lines[$y] = chop(substr($txt, 0, $breaklen));
1013             $wx = max($wx,strlen($lines[$y++]));
1014             $txt = substr($txt, $breaklen);
1015         } while ($txt && ($y < $IMAGESIZE['rows']));
1016
1017         // recalculate image size
1018         $IMAGESIZE['rows'] = $y;
1019         $IMAGESIZE['cols'] = $wx;
1020
1021         $IMAGESIZE['width']  = $IMAGESIZE['cols'] * $charx + 2*$marginx;
1022         $IMAGESIZE['height'] = $IMAGESIZE['rows'] * $chary + 2*$marginy;
1023
1024         // create blank image
1025         $im = @ImageCreate($IMAGESIZE['width'],$IMAGESIZE['height']);
1026
1027         $col = ImageColorAllocate($im, $textcol[0], $textcol[1], $textcol[2]);
1028         $bg  = ImageColorAllocate($im, $bgcol[0], $bgcol[1], $bgcol[2]);
1029
1030         ImageFilledRectangle($im, 0, 0, $IMAGESIZE['width']-1, $IMAGESIZE['height']-1, $bg);
1031
1032         // write text lines
1033         foreach($lines as $nr => $textstr) {
1034             ImageString( $im, $fontnr, $marginx, $marginy+$nr*$chary,
1035                          $textstr, $col );
1036         }
1037         return $im;
1038     } // text2img
1039
1040     function newFilterThroughCmd($input, $commandLine) {
1041         $descriptorspec = array(
1042                0 => array("pipe", "r"),  // stdin is a pipe that the child will read from
1043                1 => array("pipe", "w"),  // stdout is a pipe that the child will write to
1044                2 => array("pipe", "w"),  // stdout is a pipe that the child will write to
1045         );
1046
1047         $process = proc_open("$commandLine", $descriptorspec, $pipes);
1048         if (is_resource($process)) {
1049             // $pipes now looks like this:
1050             // 0 => writeable handle connected to child stdin
1051             // 1 => readable  handle connected to child stdout
1052             // 2 => readable  handle connected to child stderr
1053             fwrite($pipes[0], $input);
1054             fclose($pipes[0]);
1055             $buf = "";
1056             while(!feof($pipes[1])) {
1057                 $buf .= fgets($pipes[1], 1024);
1058             }
1059             fclose($pipes[1]);
1060             $stderr = '';
1061             while(!feof($pipes[2])) {
1062                 $stderr .= fgets($pipes[2], 1024);
1063             }
1064             fclose($pipes[2]);
1065             // It is important that you close any pipes before calling
1066             // proc_close in order to avoid a deadlock
1067             $return_value = proc_close($process);
1068             if (empty($buf)) printXML($this->error($stderr));
1069             return $buf;
1070         }
1071     }
1072
1073     // run "echo $source | $commandLine" and return result
1074     function filterThroughCmd($source, $commandLine) {
1075         return $this->newFilterThroughCmd($source, $commandLine);
1076     }
1077
1078     /**
1079      * Execute system command and wait until the outfile $until exists.
1080      *
1081      * @param  cmd   string   command to be invoked
1082      * @param  until string   expected output filename
1083      * @return       boolean  error status; true=ok; false=error
1084      */
1085     function execute($cmd, $until = false) {
1086         // cmd must redirect stderr to stdout though!
1087         $errstr = exec($cmd); //, $outarr, $returnval); // normally 127
1088         //$errstr = join('',$outarr);
1089         $ok = empty($errstr);
1090         if (!$ok) {
1091             trigger_error("\n".$cmd." failed: $errstr", E_USER_WARNING);
1092         } elseif ($GLOBALS['request']->getArg('debug'))
1093             trigger_error("\n".$cmd.": success\n", E_USER_NOTICE);
1094         if (!isWindows()) {
1095             if ($until) {
1096                 $loop = 100000;
1097                 while (!file_exists($until) and $loop > 0) {
1098                     $loop -= 100;
1099                     usleep(100);
1100                 }
1101             } else {
1102                 usleep(5000);
1103             }
1104         }
1105         if ($until)
1106             return file_exists($until);
1107         return $ok;
1108     }
1109
1110 }
1111
1112 // Local Variables:
1113 // mode: php
1114 // tab-width: 8
1115 // c-basic-offset: 4
1116 // c-hanging-comment-ender-p: nil
1117 // indent-tabs-mode: nil
1118 // End:
1119 ?>