3 * Copyright (C) 2002 Johannes Große
4 * Copyright (C) 2004,2007 Reini Urban
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 * 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.
29 require_once 'lib/WikiPlugin.php';
30 // require_once "lib/plugincache-config.php"; // replaced by config.ini settings!
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?)
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=
46 * An extension of the WikiPlugin class to allow image output and
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>
57 * @author Johannes Große, Reini Urban
59 class WikiPluginCached extends WikiPlugin
64 * Produces URL and id number from plugin arguments which later on,
65 * will allow to find a cached image or to reconstruct the complete
66 * plugin call to recreate the image.
68 * @param object $cache the cache object used to store the images
69 * @param array $argarray all parameters (including those set to
70 * default values) of the plugin call to be
72 * @return array(id,url)
74 * TODO: check if args is needed at all (on lost cache)
76 private function genUrl($cache, $argarray)
79 //$cacheparams = $GLOBALS['CacheParams'];
81 $plugincall = serialize(array(
82 'pluginname' => $this->getName(),
83 'arguments' => $argarray));
84 $id = $cache->generateId($plugincall);
85 $plugincall_arg = rawurlencode($plugincall);
86 //$plugincall_arg = md5($plugincall);
87 // will not work if plugin has to recreate content and cache is lost
89 $url = DATA_PATH . '/getimg.php?';
90 if (($lastchar = substr($url, -1)) == '/') {
91 $url = substr($url, 0, -1);
93 if (strlen($plugincall_arg) > PLUGIN_CACHED_MAXARGLEN) {
94 // we can't send the data as URL so we just send the id
95 if (!$request->getSessionVar('imagecache' . $id)) {
96 $request->setSessionVar('imagecache' . $id, $plugincall);
98 $plugincall_arg = false; // not needed anymore
101 if ($lastchar == '?') {
102 // this indicates that a direct call of the image creation
103 // script is wished ($url is assumed to link to the script)
104 $url .= "id=$id" . ($plugincall_arg ? '&args=' . $plugincall_arg : '');
106 // Not yet supported.
107 // We are supposed to use the indirect 404 ErrorDocument method
108 // ($url is assumed to be the url of the image in
109 // cache_dir and the image creation script is referred to in the
110 // ErrorDocument 404 directive.)
111 $url .= '/' . PLUGIN_CACHED_FILENAME_PREFIX . $id . '.img'
112 . ($plugincall_arg ? '?args=' . $plugincall_arg : '');
114 if ($request->getArg("start_debug") and (DEBUG & _DEBUG_REMOTE))
115 $url .= "&start_debug=1";
116 return array($id, $url);
120 * Replaces the abstract run method of WikiPlugin to implement
121 * a cache check which can avoid redundant runs.
122 * <b>Do not override this method in a subclass. Instead you may
123 * rename your run method to getHtml, getImage or getMap.
124 * Have a close look on the arguments and required return values,
127 * @param WikiDB $dbi database abstraction class
128 * @param string $argstr 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
137 public function run($dbi, $argstr, &$request, $basepage)
139 $cache = $this->newCache();
140 //$cacheparams = $GLOBALS['CacheParams'];
142 $sortedargs = $this->getArgs($argstr, $request);
143 if (is_array($sortedargs))
145 $this->_args =& $sortedargs;
146 $this->_type = $this->getPluginType();
147 $this->_static = false;
148 if ($this->_type & PLUGIN_CACHED_STATIC
149 or $request->getArg('action') == 'pdf'
150 ) // htmldoc doesn't grok subrequests
152 $this->_type = $this->_type & ~PLUGIN_CACHED_STATIC;
153 $this->_static = true;
156 // ---------- embed static image, no getimg.php? url -----------------
157 if (0 and $this->_static) {
158 //$content = $cache->get($id, 'imagecache');
160 if ($this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html')) {
161 // save the image in uploads
162 return $this->embedImg($content['url'], $dbi, $sortedargs, $request);
164 // copy the cached image into uploads if older
169 list($id, $url) = $this->genUrl($cache, $sortedargs);
170 // ---------- don't check cache: html and img gen. -----------------
171 // override global PLUGIN_CACHED_USECACHE for a plugin
172 if ($this->getPluginType() & PLUGIN_CACHED_IMG_ONDEMAND) {
173 if ($this->_static and $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html'))
174 $url = $content['url'];
175 return $this->embedImg($url, $dbi, $sortedargs, $request);
179 $content = $cache->get($id, 'imagecache');
180 switch ($this->_type) {
181 case PLUGIN_CACHED_HTML:
182 if (!$content || !$content['html']) {
184 $content['html'] = $this->getHtml($dbi, $sortedargs, $request, $basepage);
185 if ($errortext = $this->getError()) {
186 $this->printError($errortext, 'html');
192 case PLUGIN_CACHED_IMG_INLINE:
193 if (PLUGIN_CACHED_USECACHE && (!$content || !$content['image'])) { // new
194 $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
195 if ($this->_static) $url = $content['url'];
196 $content['html'] = $do_save ? $this->embedImg($url, $dbi, $sortedargs, $request) : false;
197 } elseif (!empty($content['url']) && $this->_static) { // already in cache
198 $content['html'] = $this->embedImg($content['url'], $dbi, $sortedargs, $request);
199 } elseif (!empty($content['image']) && $this->_static) { // copy from cache to upload
200 $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
201 $url = $content['url'];
202 $content['html'] = $do_save ? $this->embedImg($url, $dbi, $sortedargs, $request) : false;
205 case PLUGIN_CACHED_MAP:
206 if (!$content || !$content['image'] || !$content['html']) {
207 $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
208 if ($this->_static) $url = $content['url'];
209 $content['html'] = $do_save
210 ? $this->embedMap($id, $url, $content['html'], $dbi, $sortedargs, $request)
214 case PLUGIN_CACHED_SVG:
215 if (!$content || !$content['html']) {
216 $do_save = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
217 if ($this->_static) $url = $content['url'];
218 $args = array(); //width+height => object args
219 if (!empty($sortedargs['width'])) $args['width'] = $sortedargs['width'];
220 if (!empty($sortedargs['height'])) $args['height'] = $sortedargs['height'];
221 $content['html'] = $do_save
222 ? $this->embedObject($url, 'image/svg+xml', $args,
223 HTML::embed(array_merge(
224 array('src' => $url, 'type' => 'image/svg+xml'),
229 case PLUGIN_CACHED_SVG_PNG:
230 if (!$content || !$content['html']) {
231 $do_save_svg = $this->produceImage($content, $this, $dbi, $sortedargs, $request, 'html');
232 if ($this->_static) $url = $content['url'];
233 // hack alert! somehow we should know which argument will produce the secondary image (PNG)
235 $args[$this->pngArg()] = $content['imagetype']; // default type: PNG or GIF
236 $do_save = $this->produceImage($pngcontent, $this, $dbi, $args, $request, $content['imagetype']);
237 $args = array(); //width+height => object args
238 if (!empty($sortedargs['width'])) $args['width'] = $sortedargs['width'];
239 if (!empty($sortedargs['height'])) $args['height'] = $sortedargs['height'];
240 $content['html'] = $do_save_svg
241 ? $this->embedObject($url, 'image/svg+xml', $args,
242 $this->embedImg($pngcontent['url'], $dbi, $sortedargs, $request))
248 $content['args'] = md5($this->_pi);
249 $expire = $this->getExpire($dbi, $content['args'], $request);
250 $cache->save($id, $content, $expire, 'imagecache');
252 if ($content['html'])
253 return $content['html'];
257 /* --------------------- virtual or abstract functions ----------- */
260 * Sets the type of the plugin to html, image or map
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
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>
273 protected function getPluginType()
275 return PLUGIN_CACHED_IMG_ONDEMAND;
279 * Creates an image handle from the given user arguments.
280 * This method is only called if the return value of
281 * <code>getPluginType</code> is set to
282 * PLUGIN_CACHED_IMG_INLINE or PLUGIN_CACHED_IMG_ONDEMAND.
284 * @param WikiDB $dbi database abstraction class
285 * @param array $argarray complete (!) arguments to produce
286 * image. It is not necessary to call
287 * WikiPlugin->getArgs anymore.
288 * @param Request $request
289 * @return mixed imagehandle image handle if successful
290 * false if an error occured
292 protected function getImage($dbi, $argarray, $request)
294 trigger_error('WikiPluginCached::getImage: pure virtual function in file '
295 . __FILE__ . ' line ' . __LINE__, E_USER_ERROR);
300 * Sets the life time of a cache entry in seconds.
301 * Expired entries are not used anymore.
302 * During a garbage collection each expired entry is
303 * removed. If removing all expired entries is not
304 * sufficient, the expire time is ignored and removing
305 * is determined by the last "touch" of the entry.
307 * @param WikiDB $dbi database abstraction class
308 * @param array $argarray complete (!) arguments. It is
309 * not necessary to call
310 * WikiPlugin->getArgs anymore.
311 * @param Request $request
312 * @return string format: '+seconds'
315 protected function getExpire($dbi, $argarray, $request)
317 return '0'; // persist forever
321 * Decides the image type of an image output.
322 * Always used unless plugin type is PLUGIN_CACHED_HTML.
324 * @param WikiDB $dbi database abstraction class
325 * @param array $argarray complete (!) arguments. It is
326 * not necessary to call
327 * WikiPlugin->getArgs anymore.
328 * @param Request $request
329 * @return string 'png', 'jpeg' or 'gif'
331 protected function getImageType(&$dbi, $argarray, &$request)
333 if (in_array($argarray['imgtype'], preg_split('/\s*:\s*/', PLUGIN_CACHED_IMGTYPES)))
334 return $argarray['imgtype'];
340 * Produces the alt text for an image.
341 * <code> <img src=... alt="getAlt(...)"> </code>
343 * @param WikiDB $dbi database abstraction class
344 * @param array $argarray 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
350 protected function getAlt($dbi, $argarray, $request)
352 return '<?plugin ' . $this->getName() . ' ' . $this->glueArgs($argarray) . '?>';
356 * Creates HTML output to be cached.
357 * This method is only called if the plugin_type is set to
358 * PLUGIN_CACHED_HTML.
360 * @param WikiDB $dbi database abstraction class
361 * @param array $argarray 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
369 protected function getHtml($dbi, $argarray, $request, $basepage)
371 trigger_error('WikiPluginCached::getHtml: pure virtual function in file '
372 . __FILE__ . ' line ' . __LINE__, E_USER_ERROR);
376 * Creates HTML output to be cached.
377 * This method is only called if the plugin_type is set to
378 * PLUGIN_CACHED_HTML.
380 * @param WikiDB $dbi database abstraction class
381 * @param array $argarray 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 <area;> tags defining hot spots)
387 * handle is an imagehandle to the corresponding
389 * array(false,false) if an error occured
391 protected function getMap($dbi, $argarray, $request)
393 trigger_error('WikiPluginCached::getHtml: pure virtual function in file '
394 . __FILE__ . ' line ' . __LINE__, E_USER_ERROR);
397 /* --------------------- produce Html ----------------------------- */
400 * Creates an HTML map hyperlinked to the image specified
401 * by url and containing the hotspots given by map.
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 <area> tags defining active
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
414 private function embedMap($id, $url, $map, &$dbi, $argarray, &$request)
416 // id is not unique if the same map is produced twice
417 $key = substr($id, 0, 8) . substr(microtime(), 0, 6);
418 return HTML(HTML::map(array('name' => $key), $map),
421 // 'alt' => htmlspecialchars($this->getAlt($dbi,$argarray,$request))
422 'usemap' => '#' . $key))
427 * Creates an HTML <img> tag hyperlinking to the specified
428 * url and produces an alternative text for non-graphical
431 * @param string $url url pointing to the image part of the map
432 * @param WikiDB $dbi database abstraction class
433 * @param array $argarray complete (!) arguments to produce
434 * image. It is not necessary to call
435 * WikiPlugin->getArgs anymore.
436 * @param Request $request
437 * @return string html output
439 private function embedImg($url, $dbi, $argarray, $request)
441 return HTML::img(array(
443 'alt' => htmlspecialchars($this->getAlt($dbi, $argarray, $request))));
448 <object type="audio/x-wav" standby="Loading Audio" data="example.wav">
449 <param name="src" value="example.wav" valuetype="data"></param>
450 <param name="autostart" value="false" valuetype="data"></param>
451 <param name="controls" value="ControlPanel" valuetype="data"></param>
452 <a href="example.wav">Example Audio File</a>
454 * See http://www.protocol7.com/svg-wiki/?EmbedingSvgInHTML
455 <object data="sample.svgz" type="image/svg+xml"
456 width="400" height="300">
457 <embed src="sample.svgz" type="image/svg+xml"
458 width="400" height="300" />
459 <p>Alternate Content like <img src="" /></p>
462 // how to handle alternate images? always provide alternate static images?
463 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)));
468 $object->pushContent($params);
472 // --------------------------------------------------------------------------
473 // ---------------------- static member functions ---------------------------
474 // --------------------------------------------------------------------------
477 * Creates one static PEAR Cache object and returns copies afterwards.
478 * FIXME: There should be references returned
480 * @return Cache copy of the cache object
482 static public function newCache()
486 if (!is_object($staticcache)) {
487 if (!class_exists('Cache')) {
488 // uuh, pear not in include_path! should print a warning.
489 // search some possible pear paths.
490 $pearFinder = new PearFileFinder;
491 if ($lib = $pearFinder->findFile('Cache.php', 'missing_ok'))
493 else // fall back to our own copy
494 require_once 'lib/pear/Cache.php';
496 $cacheparams = array();
497 foreach (explode(':', 'database:cache_dir:filename_prefix:highwater:lowwater'
498 . ':maxlifetime:maxarglen:usecache:force_syncmap') as $key) {
499 $cacheparams[$key] = constant('PLUGIN_CACHED_' . strtoupper($key));
501 $cacheparams['imgtypes'] = preg_split('/\s*:\s*/', PLUGIN_CACHED_IMGTYPES);
502 $staticcache = new Cache(PLUGIN_CACHED_DATABASE, $cacheparams);
503 $staticcache->gc_maxlifetime = PLUGIN_CACHED_MAXLIFETIME;
505 if (!PLUGIN_CACHED_USECACHE) {
506 $staticcache->setCaching(false);
509 return $staticcache; // FIXME: use references ?
513 * Determines whether a needed image type may is available
514 * from the GD library and gives an alternative otherwise.
516 * @param string $wish one of 'png', 'gif', 'jpeg', 'jpg'
517 * @return string the image type to be used ('png', 'gif', 'jpeg')
518 * 'html' in case of an error
521 public static function decideImgType($wish)
523 if ($wish == 'html') return $wish;
524 if ($wish == 'jpg') {
528 $supportedtypes = array();
529 // Todo: swf, pdf, ...
536 /* // these do work but not with the ImageType bitmask
542 if (function_exists('ImageTypes')) {
543 $presenttypes = ImageTypes();
544 foreach ($imagetypes as $imgtype => $bitmask)
545 if ($presenttypes && $bitmask)
546 array_push($supportedtypes, $imgtype);
548 foreach ($imagetypes as $imgtype => $bitmask)
549 if (function_exists("Image" . $imgtype))
550 array_push($supportedtypes, $imgtype);
552 if (in_array($wish, $supportedtypes))
554 elseif (!empty($supportedtypes))
555 return reset($supportedtypes); else
561 * Writes an image into a file or to the browser.
562 * Note that there is no check if the image can
565 * @param string $imgtype 'png', 'gif' or 'jpeg'
566 * @param string $imghandle image handle containing the image
567 * @param string $imgfile file name of the image to be produced
569 * @see decideImageType
571 public static function writeImage($imgtype, $imghandle, $imgfile = '')
573 if ($imgtype != 'html') {
574 $func = "Image" . strtoupper($imgtype);
576 $func($imghandle, $imgfile);
584 * Sends HTTP Header for some predefined file types.
585 * There is no parameter check.
587 * @param string $doctype 'gif', 'png', 'jpeg', 'html'
590 public static function writeHeader($doctype)
592 static $IMAGEHEADER = array(
593 'gif' => 'Content-type: image/gif',
594 'png' => 'Content-type: image/png',
595 'jpeg' => 'Content-type: image/jpeg',
596 'xbm' => 'Content-type: image/xbm',
597 'xpm' => 'Content-type: image/xpm',
598 'gd' => 'Content-type: image/gd',
599 'gd2' => 'Content-type: image/gd2',
600 'wbmp' => 'Content-type: image/vnd.wap.wbmp', // wireless bitmaps for PDA's and such.
601 'html' => 'Content-type: text/html');
602 // Todo: swf, pdf, svg, svgz
603 Header($IMAGEHEADER[$doctype]);
607 * Converts argument array to a string of format option="value".
608 * This should only be used for displaying plugin options for
609 * the quoting of arguments is not safe, yet.
611 * @param array $argarray contains all arguments to be converted
612 * @return string concated arguments
614 public static function glueArgs($argarray)
616 if (!empty($argarray)) {
618 while (list($key, $value) = each($argarray)) {
619 $argstr .= $key . '=' . '"' . $value . '" ';
620 // FIXME: How are values quoted? Can a value contain '"'?
621 // TODO: rawurlencode(value)
623 return substr($argstr, 0, strlen($argstr) - 1);
628 // ---------------------- FetchImageFromCache ------------------------------
631 * Extracts the cache entry id from the url and the plugin call
632 * parameters if available.
634 * @param string $id return value. Image is stored under this id.
635 * @param string $plugincall return value. Only returned if present in url.
636 * Contains all parameters to reconstruct
638 * @param Cache $cache PEAR Cache object
639 * @param Request $request
640 * @param string $errorformat format which should be used to
641 * output errors ('html', 'png', 'gif', 'jpeg')
642 * @return bool false if an error occurs, true otherwise.
643 * Param id and param plugincall are
644 * also return values.
646 private static function checkCall1(&$id, &$plugincall, $cache, $request, $errorformat)
648 $id = $request->getArg('id');
649 $plugincall = rawurldecode($request->getArg('args'));
653 // This should never happen, so do not gettextify.
654 $errortext = "Neither 'args' nor 'id' given. Cannot proceed without parameters.";
655 $this->printError($errorformat, $errortext);
658 $id = $cache->generateId($plugincall);
665 * Extracts the parameters necessary to reconstruct the plugin
666 * call needed to produce the requested image.
668 * @param $plugincall string reference to serialized array containing both
669 * name and parameters of the plugin call
670 * @param $request Request ???
671 * @return bool false if an error occurs, true otherwise.
674 static private function checkCall2(&$plugincall, $request)
676 // if plugincall wasn't sent by URL, it must have been
677 // stored in a session var instead and we can retreive it from there
679 if (!$plugincall = $request->getSessionVar('imagecache' . $id)) {
680 // I think this is the only error which may occur
681 // without having written bad code. So gettextify it.
682 $errortext = sprintf(
683 gettext("There is no image creation data available to id “%s”. Please reload referring page."),
685 $this->printError($errorformat, $errortext);
689 $plugincall = unserialize($plugincall);
694 * Creates an image or image map depending on the plugin type.
695 * @param $content array reference to created array which overwrite the keys
696 * 'image', 'imagetype' and possibly 'html'
697 * @param $plugin WikiPluginCached plugin which is called to create image or map
698 * @param $dbi WikiDB handle to database
699 * @param $argarray array Contains all arguments needed by plugin
700 * @param $request Request ????
701 * @param $errorformat string outputs errors in 'png', 'gif', 'jpg' or 'html'
702 * @return bool error status; true=ok; false=error
704 static private function produceImage(&$content, $plugin, $dbi, $argarray, $request, $errorformat)
706 $plugin->resetError();
707 $content['html'] = $imagehandle = false;
708 if ($plugin->getPluginType() == PLUGIN_CACHED_MAP) {
709 list($imagehandle, $content['html']) = $plugin->getMap($dbi, $argarray, $request);
711 $imagehandle = $plugin->getImage($dbi, $argarray, $request);
714 $content['imagetype']
715 = $this->decideImgType($plugin->getImageType($dbi, $argarray, $request));
716 $errortext = $plugin->getError();
718 if (!$imagehandle || $errortext) {
720 $errortext = "'<?plugin " . $plugin->getName() . ' '
721 . $this->glueArgs($argarray) . " ?>' returned no image, "
722 . " although no error was reported.";
724 $this->printError($errorformat, $errortext);
728 // image handle -> image data
729 if (!empty($this->_static)) {
730 $ext = "." . $content['imagetype'];
731 if (is_string($imagehandle) and file_exists($imagehandle)) {
732 if (preg_match("/.(\w+)$/", $imagehandle, $m)) {
736 $tmpfile = tempnam(getUploadFilePath(), PLUGIN_CACHED_FILENAME_PREFIX . $ext);
737 if (!strstr(basename($tmpfile), $ext)) {
741 $tmpfile = getUploadFilePath() . basename($tmpfile);
742 if (is_string($imagehandle) and file_exists($imagehandle)) {
743 rename($imagehandle, $tmpfile);
746 $tmpfile = $this->tempnam();
748 if (is_resource($imagehandle)) {
749 $this->writeImage($content['imagetype'], $imagehandle, $tmpfile);
750 ImageDestroy($imagehandle);
752 } elseif (is_string($imagehandle)) {
753 $content['file'] = getUploadFilePath() . basename($tmpfile);
754 $content['url'] = getUploadDataPath() . basename($tmpfile);
757 if (file_exists($tmpfile)) {
758 $fp = fopen($tmpfile, 'rb');
759 $content['image'] = fread($fp, filesize($tmpfile));
761 if (!empty($this->_static)) {
762 // on static it is in "uploads/" but in wikicached also
763 $content['file'] = $tmpfile;
764 $content['url'] = getUploadDataPath() . basename($tmpfile);
768 if ($content['image'])
774 function staticUrl($tmpfile)
776 $content['file'] = $tmpfile;
777 $content['url'] = getUploadDataPath() . basename($tmpfile);
781 function tempnam($prefix = "")
783 if (preg_match("/^(.+)\.(\w{2,4})$/", $prefix, $m)) {
787 $ext = isWindows() ? ".tmp" : "";
789 $temp = tempnam(isWindows() ? str_replace('/', "\\", PLUGIN_CACHED_CACHE_DIR)
790 : PLUGIN_CACHED_CACHE_DIR,
791 $prefix ? $prefix : PLUGIN_CACHED_FILENAME_PREFIX);
793 if ($ext != ".tmp") unlink($temp);
794 $temp = preg_replace("/\.tmp$/", $ext, $temp);
802 * Main function for obtaining images from cache or generating on-the-fly
803 * from parameters sent by url or session vars.
805 * @param WikiDB $dbi handle to database
806 * @param Request $request ???
807 * @param string $errorformat outputs errors in 'png', 'gif', 'jpeg' or 'html'
810 static public function fetchImageFromCache($dbi, $request, $errorformat = 'png')
812 $cache = $this->newCache();
813 $errorformat = $this->decideImgType($errorformat);
815 if (!$this->checkCall1($id, $plugincall, $cache, $request, $errorformat)) return false;
817 $content = $cache->get($id, 'imagecache');
819 if (!empty($content['image'])) {
820 $this->writeHeader($content['imagetype']);
821 print $content['image'];
824 if (!empty($content['html'])) {
825 print $content['html'];
829 if (!empty($content['file']) && !empty($content['url']) && file_exists($content['file'])) {
830 print $this->embedImg($content['url'], $dbi, array(), $request);
834 // re-produce image. At first, we need the plugincall parameters.
835 // Cached args with matching id override given args to shorten getimg.php?id=md5
836 if (!empty($content['args']))
837 $plugincall['arguments'] = $content['args'];
838 if (!$this->checkCall2($plugincall, $request)) return false;
840 $pluginname = $plugincall['pluginname'];
841 $argarray = $plugincall['arguments'];
843 $loader = new WikiPluginLoader();
844 $plugin = $loader->getPlugin($pluginname);
846 // cache empty, but image maps have to be created _inline_
847 // so ask user to reload wiki page instead
848 if (($plugin->getPluginType() & PLUGIN_CACHED_MAP) && PLUGIN_CACHED_FORCE_SYNCMAP) {
849 $errortext = _("Image map expired. Reload wiki page to recreate its html part.");
850 $this->printError($errorformat, $errortext);
853 if (!$this->produceImage($content, $plugin, $dbi, $argarray,
854 $request, $errorformat)
858 $expire = $plugin->getExpire($dbi, $argarray, $request);
860 if ($content['image']) {
861 $cache->save($id, $content, $expire, 'imagecache');
862 $this->writeHeader($content['imagetype']);
863 print $content['image'];
867 $errortext = "Could not create image file from imagehandle.";
868 $this->printError($errorformat, $errortext);
870 } // FetchImageFromCache
872 // -------------------- error handling ----------------------------
875 * Resets buffer containing all error messages. This is allways
876 * done before invoking any abstract creation routines like
877 * <code>getImage</code>.
881 private function resetError()
883 $this->_errortext = '';
887 * Returns all accumulated error messages.
889 * @return string error messages printed with <code>complain</code>.
891 protected function getError()
893 return $this->_errortext;
897 * Collects the error messages in a string for later output
898 * by WikiPluginCached. This should be used for any errors
899 * that occur during data (html,image,map) creation.
901 * @param string $addtext errormessage to be printed (separate
902 * multiple lines with '\n')
905 protected function complain($addtext)
907 $this->_errortext .= $addtext;
911 * Outputs the error as image if possible or as html text
912 * if wished or html header has already been sent.
914 * @param string $imgtype 'png', 'gif', 'jpeg' or 'html'
915 * @param string $errortext guess what?
918 static protected function printError($imgtype, $errortext)
920 $imgtype = $this->decideImgType($imgtype);
922 $talkedallready = ob_get_contents() || headers_sent();
923 if (($imgtype == 'html') || $talkedallready) {
924 if (is_object($errortext))
925 $errortext = $errortext->asXml();
926 trigger_error($errortext, E_USER_WARNING);
928 $red = array(255, 0, 0);
929 $grey = array(221, 221, 221);
930 if (is_object($errortext))
931 $errortext = $errortext->asString();
932 $im = $this->text2img($errortext, 2, $red, $grey);
934 trigger_error($errortext, E_USER_WARNING);
937 $this->writeHeader($imgtype);
938 $this->writeImage($imgtype, $im);
944 * Basic text to image converter for error handling which allows
945 * multiple line output.
946 * It will only output the first 25 lines of 80 characters. Both
947 * values may be smaller if the chosen font is to big for there
948 * is further restriction to 600 pixel in width and 350 in height.
950 * @param $txt string multi line text to be converted
951 * @param $fontnr integer number (1-5) telling gd which internal font to use;
952 * I recommend font 2 for errors and 4 for help texts.
953 * @param $textcol array text color as a list of the rgb components; array(red,green,blue)
954 * @param $bgcol array background color; array(red,green,blue)
955 * @return string image handle for gd routines
957 static public function text2img($txt, $fontnr, $textcol, $bgcol)
959 // basic (!) output for error handling
962 if ($fontnr < 1 || $fontnr > 5) {
965 if (!is_array($textcol) || !is_array($bgcol)) {
966 $textcol = array(0, 0, 0);
967 $bgcol = array(255, 255, 255);
969 foreach (array_merge($textcol, $bgcol) as $component) {
970 if ($component < 0 || $component > 255) {
971 $textcol = array(0, 0, 0);
972 $bgcol = array(255, 255, 255);
977 // prepare Parameters
979 // set maximum values
986 if (function_exists('ImageFontWidth')) {
987 $charx = ImageFontWidth($fontnr);
988 $chary = ImageFontHeight($fontnr);
994 $marginy = floor($chary / 2);
996 $IMAGESIZE['cols'] = min($IMAGESIZE['cols'], floor(($IMAGESIZE['width'] - 2 * $marginx) / $charx));
997 $IMAGESIZE['rows'] = min($IMAGESIZE['rows'], floor(($IMAGESIZE['height'] - 2 * $marginy) / $chary));
1003 $len = strlen($txt);
1004 $npos = strpos($txt, "\n");
1006 if ($npos === false) {
1007 $breaklen = min($IMAGESIZE['cols'], $len);
1009 $breaklen = min($npos + 1, $IMAGESIZE['cols']);
1011 $lines[$y] = chop(substr($txt, 0, $breaklen));
1012 $wx = max($wx, strlen($lines[$y++]));
1013 $txt = substr($txt, $breaklen);
1014 } while ($txt && ($y < $IMAGESIZE['rows']));
1016 // recalculate image size
1017 $IMAGESIZE['rows'] = $y;
1018 $IMAGESIZE['cols'] = $wx;
1020 $IMAGESIZE['width'] = $IMAGESIZE['cols'] * $charx + 2 * $marginx;
1021 $IMAGESIZE['height'] = $IMAGESIZE['rows'] * $chary + 2 * $marginy;
1023 // create blank image
1024 $im = @ImageCreate($IMAGESIZE['width'], $IMAGESIZE['height']);
1026 $col = ImageColorAllocate($im, $textcol[0], $textcol[1], $textcol[2]);
1027 $bg = ImageColorAllocate($im, $bgcol[0], $bgcol[1], $bgcol[2]);
1029 ImageFilledRectangle($im, 0, 0, $IMAGESIZE['width'] - 1, $IMAGESIZE['height'] - 1, $bg);
1032 foreach ($lines as $nr => $textstr) {
1033 ImageString($im, $fontnr, $marginx, $marginy + $nr * $chary,
1039 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
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);
1056 while (!feof($pipes[1])) {
1057 $buf .= fgets($pipes[1], 1024);
1061 while (!feof($pipes[2])) {
1062 $stderr .= fgets($pipes[2], 1024);
1065 // It is important that you close any pipes before calling
1066 // proc_close in order to avoid a deadlock
1067 proc_close($process);
1068 if (empty($buf)) printXML($this->error($stderr));
1074 // run "echo $source | $commandLine" and return result
1075 function filterThroughCmd($source, $commandLine)
1077 return $this->newFilterThroughCmd($source, $commandLine);
1081 * Execute system command and wait until the outfile $until exists.
1083 * @param string $cmd command to be invoked
1084 * @param string $until expected output filename
1085 * @return bool error status; true=ok; false=error
1087 function execute($cmd, $until = '')
1089 // cmd must redirect stderr to stdout though!
1090 $errstr = exec($cmd); //, $outarr, $returnval); // normally 127
1091 //$errstr = join('',$outarr);
1092 $ok = empty($errstr);
1094 trigger_error("\n" . $cmd . " failed: $errstr", E_USER_WARNING);
1095 } elseif ($GLOBALS['request']->getArg('debug'))
1096 trigger_error("\n" . $cmd . ": success\n", E_USER_NOTICE);
1100 while (!file_exists($until) and $loop > 0) {
1109 return file_exists($until);
1118 // c-basic-offset: 4
1119 // c-hanging-comment-ender-p: nil
1120 // indent-tabs-mode: nil