xref: /dokuwiki/inc/parserutils.php (revision 7ae265d3e681ebbb637211616aac15b18b8689a1) 
1<?php
2/**
3 * Utilities for accessing the parser
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Harry Fuecks <hfuecks@gmail.com>
7 * @author     Andreas Gohr <andi@splitbrain.org>
8 */
9
10if(!defined('DOKU_INC')) die('meh.');
11
12/**
13 * Returns the parsed Wikitext in XHTML for the given id and revision.
14 *
15 * If $excuse is true an explanation is returned if the file
16 * wasn't found
17 *
18 * @author Andreas Gohr <andi@splitbrain.org>
19 */
20function p_wiki_xhtml($id, $rev='', $excuse=true){
21    $file = wikiFN($id,$rev);
22    $ret  = '';
23
24    //ensure $id is in global $ID (needed for parsing)
25    global $ID;
26    $keep = $ID;
27    $ID   = $id;
28
29    if($rev){
30        if(@file_exists($file)){
31            $ret = p_render('xhtml',p_get_instructions(io_readWikiPage($file,$id,$rev)),$info); //no caching on old revisions
32        }elseif($excuse){
33            $ret = p_locale_xhtml('norev');
34        }
35    }else{
36        if(@file_exists($file)){
37            $ret = p_cached_output($file,'xhtml',$id);
38        }elseif($excuse){
39            $ret = p_locale_xhtml('newpage');
40        }
41    }
42
43    //restore ID (just in case)
44    $ID = $keep;
45
46    return $ret;
47}
48
49/**
50 * Returns starting summary for a page (e.g. the first few
51 * paragraphs), marked up in XHTML.
52 *
53 * If $excuse is true an explanation is returned if the file
54 * wasn't found
55 *
56 * @param string wiki page id
57 * @param reference populated with page title from heading or page id
58 * @deprecated
59 * @author Harry Fuecks <hfuecks@gmail.com>
60 */
61function p_wiki_xhtml_summary($id, &$title, $rev='', $excuse=true){
62    $file = wikiFN($id,$rev);
63    $ret  = '';
64
65    //ensure $id is in global $ID (needed for parsing)
66    global $ID;
67    $keep = $ID;
68    $ID   = $id;
69
70    if($rev){
71        if(@file_exists($file)){
72            //no caching on old revisions
73            $ins = p_get_instructions(io_readWikiPage($file,$id,$rev));
74        }elseif($excuse){
75            $ret = p_locale_xhtml('norev');
76            //restore ID (just in case)
77            $ID = $keep;
78            return $ret;
79        }
80
81    }else{
82
83        if(@file_exists($file)){
84            // The XHTML for a summary is not cached so use the instruction cache
85            $ins = p_cached_instructions($file);
86        }elseif($excuse){
87            $ret = p_locale_xhtml('newpage');
88            //restore ID (just in case)
89            $ID = $keep;
90            return $ret;
91        }
92    }
93
94    $ret = p_render('xhtmlsummary',$ins,$info);
95
96    if ( $info['sum_pagetitle'] ) {
97        $title = $info['sum_pagetitle'];
98    } else {
99        $title = $id;
100    }
101
102    $ID = $keep;
103    return $ret;
104}
105
106/**
107 * Returns the specified local text in parsed format
108 *
109 * @author Andreas Gohr <andi@splitbrain.org>
110 */
111function p_locale_xhtml($id){
112    //fetch parsed locale
113    $html = p_cached_output(localeFN($id));
114    return $html;
115}
116
117/**
118 *     *** DEPRECATED ***
119 *
120 * use p_cached_output()
121 *
122 * Returns the given file parsed to XHTML
123 *
124 * Uses and creates a cachefile
125 *
126 * @deprecated
127 * @author Andreas Gohr <andi@splitbrain.org>
128 * @todo   rewrite to use mode instead of hardcoded XHTML
129 */
130function p_cached_xhtml($file){
131    return p_cached_output($file);
132}
133
134/**
135 * Returns the given file parsed into the requested output format
136 *
137 * @author Andreas Gohr <andi@splitbrain.org>
138 * @author Chris Smith <chris@jalakai.co.uk>
139 */
140function p_cached_output($file, $format='xhtml', $id='') {
141    global $conf;
142
143    $cache = new cache_renderer($id, $file, $format);
144    if ($cache->useCache()) {
145        $parsed = $cache->retrieveCache(false);
146        if($conf['allowdebug'] && $format=='xhtml') $parsed .= "\n<!-- cachefile {$cache->cache} used -->\n";
147    } else {
148        $parsed = p_render($format, p_cached_instructions($file,false,$id), $info);
149
150        if ($info['cache']) {
151            $cache->storeCache($parsed);               //save cachefile
152            if($conf['allowdebug'] && $format=='xhtml') $parsed .= "\n<!-- no cachefile used, but created {$cache->cache} -->\n";
153        }else{
154            $cache->removeCache();                     //try to delete cachefile
155            if($conf['allowdebug'] && $format=='xhtml') $parsed .= "\n<!-- no cachefile used, caching forbidden -->\n";
156        }
157    }
158
159    return $parsed;
160}
161
162/**
163 * Returns the render instructions for a file
164 *
165 * Uses and creates a serialized cache file
166 *
167 * @author Andreas Gohr <andi@splitbrain.org>
168 */
169function p_cached_instructions($file,$cacheonly=false,$id='') {
170    global $conf;
171    static $run = null;
172    if(is_null($run)) $run = array();
173
174    $cache = new cache_instructions($id, $file);
175
176    if ($cacheonly || $cache->useCache() || isset($run[$file])) {
177        return $cache->retrieveCache();
178    } else if (@file_exists($file)) {
179        // no cache - do some work
180        $ins = p_get_instructions(io_readWikiPage($file,$id));
181        if ($cache->storeCache($ins)) {
182            $run[$file] = true; // we won't rebuild these instructions in the same run again
183        } else {
184            msg('Unable to save cache file. Hint: disk full; file permissions; safe_mode setting.',-1);
185        }
186        return $ins;
187    }
188
189    return null;
190}
191
192/**
193 * turns a page into a list of instructions
194 *
195 * @author Harry Fuecks <hfuecks@gmail.com>
196 * @author Andreas Gohr <andi@splitbrain.org>
197 */
198function p_get_instructions($text){
199
200    $modes = p_get_parsermodes();
201
202    // Create the parser
203    $Parser = new Doku_Parser();
204
205    // Add the Handler
206    $Parser->Handler = new Doku_Handler();
207
208    //add modes to parser
209    foreach($modes as $mode){
210        $Parser->addMode($mode['mode'],$mode['obj']);
211    }
212
213    // Do the parsing
214    trigger_event('PARSER_WIKITEXT_PREPROCESS', $text);
215    $p = $Parser->parse($text);
216    //  dbg($p);
217    return $p;
218}
219
220/**
221 * returns the metadata of a page
222 *
223 * @author Esther Brunner <esther@kaffeehaus.ch>
224 */
225function p_get_metadata($id, $key='', $render=false){
226    global $ID;
227
228    // cache the current page
229    // Benchmarking shows the current page's metadata is generally the only page metadata
230    // accessed several times. This may catch a few other pages, but that shouldn't be an issue.
231    $cache = ($ID == $id);
232    $meta = p_read_metadata($id, $cache);
233
234    // metadata has never been rendered before - do it! (but not for non-existent pages)
235    if ($render && !isset($meta['current']['description']['abstract']) && page_exists($id)){
236        $meta = p_render_metadata($id, $meta);
237        p_save_metadata($id, $meta);
238    }
239
240    $val = $meta['current'];
241
242    // filter by $key
243    foreach(preg_split('/\s+/', $key, 2, PREG_SPLIT_NO_EMPTY) as $cur_key) {
244        if (!isset($val[$cur_key])) {
245            return null;
246        }
247        $val = $val[$cur_key];
248    }
249    return $val;
250}
251
252/**
253 * sets metadata elements of a page
254 *
255 * @see http://www.dokuwiki.org/devel:metadata#functions_to_get_and_set_metadata
256 *
257 * @param String  $id         is the ID of a wiki page
258 * @param Array   $data       is an array with key ⇒ value pairs to be set in the metadata
259 * @param Boolean $render     whether or not the page metadata should be generated with the renderer
260 * @param Boolean $persistent indicates whether or not the particular metadata value will persist through
261 *                            the next metadata rendering.
262 * @return boolean true on success
263 *
264 * @author Esther Brunner <esther@kaffeehaus.ch>
265 */
266function p_set_metadata($id, $data, $render=false, $persistent=true){
267    if (!is_array($data)) return false;
268
269    global $ID;
270
271    // cache the current page
272    $cache = ($ID == $id);
273    $orig = p_read_metadata($id, $cache);
274
275    // render metadata first?
276    $meta = $render ? p_render_metadata($id, $orig) : $orig;
277
278    // now add the passed metadata
279    $protected = array('description', 'date', 'contributor');
280    foreach ($data as $key => $value){
281
282        // be careful with sub-arrays of $meta['relation']
283        if ($key == 'relation'){
284
285            foreach ($value as $subkey => $subvalue){
286                $meta['current'][$key][$subkey] = !empty($meta['current'][$key][$subkey]) ? array_merge($meta['current'][$key][$subkey], $subvalue) : $subvalue;
287                if ($persistent)
288                    $meta['persistent'][$key][$subkey] = !empty($meta['persistent'][$key][$subkey]) ? array_merge($meta['persistent'][$key][$subkey], $subvalue) : $subvalue;
289            }
290
291            // be careful with some senisitive arrays of $meta
292        } elseif (in_array($key, $protected)){
293
294            // these keys, must have subkeys - a legitimate value must be an array
295            if (is_array($value)) {
296                $meta['current'][$key] = !empty($meta['current'][$key]) ? array_merge($meta['current'][$key],$value) : $value;
297
298                if ($persistent) {
299                    $meta['persistent'][$key] = !empty($meta['persistent'][$key]) ? array_merge($meta['persistent'][$key],$value) : $value;
300                }
301            }
302
303            // no special treatment for the rest
304        } else {
305            $meta['current'][$key] = $value;
306            if ($persistent) $meta['persistent'][$key] = $value;
307        }
308    }
309
310    // save only if metadata changed
311    if ($meta == $orig) return true;
312
313    return p_save_metadata($id, $meta);
314}
315
316/**
317 * Purges the non-persistant part of the meta data
318 * used on page deletion
319 *
320 * @author Michael Klier <chi@chimeric.de>
321 */
322function p_purge_metadata($id) {
323    $meta = p_read_metadata($id);
324    foreach($meta['current'] as $key => $value) {
325        if(is_array($meta[$key])) {
326            $meta['current'][$key] = array();
327        } else {
328            $meta['current'][$key] = '';
329        }
330
331    }
332    return p_save_metadata($id, $meta);
333}
334
335/**
336 * read the metadata from source/cache for $id
337 * (internal use only - called by p_get_metadata & p_set_metadata)
338 *
339 * @author   Christopher Smith <chris@jalakai.co.uk>
340 *
341 * @param    string   $id      absolute wiki page id
342 * @param    bool     $cache   whether or not to cache metadata in memory
343 *                             (only use for metadata likely to be accessed several times)
344 *
345 * @return   array             metadata
346 */
347function p_read_metadata($id,$cache=false) {
348    global $cache_metadata;
349
350    if (isset($cache_metadata[(string)$id])) return $cache_metadata[(string)$id];
351
352    $file = metaFN($id, '.meta');
353    $meta = @file_exists($file) ? unserialize(io_readFile($file, false)) : array('current'=>array(),'persistent'=>array());
354
355    if ($cache) {
356        $cache_metadata[(string)$id] = $meta;
357    }
358
359    return $meta;
360}
361
362/**
363 * This is the backend function to save a metadata array to a file
364 *
365 * @param    string   $id      absolute wiki page id
366 * @param    array    $meta    metadata
367 *
368 * @return   bool              success / fail
369 */
370function p_save_metadata($id, $meta) {
371    // sync cached copies, including $INFO metadata
372    global $cache_metadata, $INFO;
373
374    if (isset($cache_metadata[$id])) $cache_metadata[$id] = $meta;
375    if (!empty($INFO) && ($id == $INFO['id'])) { $INFO['meta'] = $meta['current']; }
376
377    return io_saveFile(metaFN($id, '.meta'), serialize($meta));
378}
379
380/**
381 * renders the metadata of a page
382 *
383 * @author Esther Brunner <esther@kaffeehaus.ch>
384 */
385function p_render_metadata($id, $orig){
386    // make sure the correct ID is in global ID
387    global $ID;
388    $keep = $ID;
389    $ID   = $id;
390
391    // add an extra key for the event - to tell event handlers the page whose metadata this is
392    $orig['page'] = $id;
393    $evt = new Doku_Event('PARSER_METADATA_RENDER', $orig);
394    if ($evt->advise_before()) {
395
396        require_once DOKU_INC."inc/parser/metadata.php";
397
398        // get instructions
399        $instructions = p_cached_instructions(wikiFN($id),false,$id);
400        if(is_null($instructions)){
401            $ID = $keep;
402            return null; // something went wrong with the instructions
403        }
404
405        // set up the renderer
406        $renderer = new Doku_Renderer_metadata();
407        $renderer->meta = $orig['current'];
408        $renderer->persistent = $orig['persistent'];
409
410        // loop through the instructions
411        foreach ($instructions as $instruction){
412            // execute the callback against the renderer
413            call_user_func_array(array(&$renderer, $instruction[0]), (array) $instruction[1]);
414        }
415
416        $evt->result = array('current'=>$renderer->meta,'persistent'=>$renderer->persistent);
417    }
418    $evt->advise_after();
419
420    $ID = $keep;
421    return $evt->result;
422}
423
424/**
425 * returns all available parser syntax modes in correct order
426 *
427 * @author Andreas Gohr <andi@splitbrain.org>
428 */
429function p_get_parsermodes(){
430    global $conf;
431
432    //reuse old data
433    static $modes = null;
434    if($modes != null){
435        return $modes;
436    }
437
438    //import parser classes and mode definitions
439    require_once DOKU_INC . 'inc/parser/parser.php';
440
441    // we now collect all syntax modes and their objects, then they will
442    // be sorted and added to the parser in correct order
443    $modes = array();
444
445    // add syntax plugins
446    $pluginlist = plugin_list('syntax');
447    if(count($pluginlist)){
448        global $PARSER_MODES;
449        $obj = null;
450        foreach($pluginlist as $p){
451            if(!$obj =& plugin_load('syntax',$p)) continue; //attempt to load plugin into $obj
452            $PARSER_MODES[$obj->getType()][] = "plugin_$p"; //register mode type
453            //add to modes
454            $modes[] = array(
455                    'sort' => $obj->getSort(),
456                    'mode' => "plugin_$p",
457                    'obj'  => $obj,
458                    );
459            unset($obj); //remove the reference
460        }
461    }
462
463    // add default modes
464    $std_modes = array('listblock','preformatted','notoc','nocache',
465            'header','table','linebreak','footnote','hr',
466            'unformatted','php','html','code','file','quote',
467            'internallink','rss','media','externallink',
468            'emaillink','windowssharelink','eol');
469    if($conf['typography']){
470        $std_modes[] = 'quotes';
471        $std_modes[] = 'multiplyentity';
472    }
473    foreach($std_modes as $m){
474        $class = "Doku_Parser_Mode_$m";
475        $obj   = new $class();
476        $modes[] = array(
477                'sort' => $obj->getSort(),
478                'mode' => $m,
479                'obj'  => $obj
480                );
481    }
482
483    // add formatting modes
484    $fmt_modes = array('strong','emphasis','underline','monospace',
485            'subscript','superscript','deleted');
486    foreach($fmt_modes as $m){
487        $obj   = new Doku_Parser_Mode_formatting($m);
488        $modes[] = array(
489                'sort' => $obj->getSort(),
490                'mode' => $m,
491                'obj'  => $obj
492                );
493    }
494
495    // add modes which need files
496    $obj     = new Doku_Parser_Mode_smiley(array_keys(getSmileys()));
497    $modes[] = array('sort' => $obj->getSort(), 'mode' => 'smiley','obj'  => $obj );
498    $obj     = new Doku_Parser_Mode_acronym(array_keys(getAcronyms()));
499    $modes[] = array('sort' => $obj->getSort(), 'mode' => 'acronym','obj'  => $obj );
500    $obj     = new Doku_Parser_Mode_entity(array_keys(getEntities()));
501    $modes[] = array('sort' => $obj->getSort(), 'mode' => 'entity','obj'  => $obj );
502
503    // add optional camelcase mode
504    if($conf['camelcase']){
505        $obj     = new Doku_Parser_Mode_camelcaselink();
506        $modes[] = array('sort' => $obj->getSort(), 'mode' => 'camelcaselink','obj'  => $obj );
507    }
508
509    //sort modes
510    usort($modes,'p_sort_modes');
511
512    return $modes;
513}
514
515/**
516 * Callback function for usort
517 *
518 * @author Andreas Gohr <andi@splitbrain.org>
519 */
520function p_sort_modes($a, $b){
521    if($a['sort'] == $b['sort']) return 0;
522    return ($a['sort'] < $b['sort']) ? -1 : 1;
523}
524
525/**
526 * Renders a list of instruction to the specified output mode
527 *
528 * In the $info array is information from the renderer returned
529 *
530 * @author Harry Fuecks <hfuecks@gmail.com>
531 * @author Andreas Gohr <andi@splitbrain.org>
532 */
533function p_render($mode,$instructions,&$info){
534    if(is_null($instructions)) return '';
535
536    $Renderer =& p_get_renderer($mode);
537    if (is_null($Renderer)) return null;
538
539    $Renderer->reset();
540
541    $Renderer->smileys = getSmileys();
542    $Renderer->entities = getEntities();
543    $Renderer->acronyms = getAcronyms();
544    $Renderer->interwiki = getInterwiki();
545
546    // Loop through the instructions
547    foreach ( $instructions as $instruction ) {
548        // Execute the callback against the Renderer
549        call_user_func_array(array(&$Renderer, $instruction[0]),$instruction[1]);
550    }
551
552    //set info array
553    $info = $Renderer->info;
554
555    // Post process and return the output
556    $data = array($mode,& $Renderer->doc);
557    trigger_event('RENDERER_CONTENT_POSTPROCESS',$data);
558    return $Renderer->doc;
559}
560
561function & p_get_renderer($mode) {
562    global $conf, $plugin_controller;
563
564    $rname = !empty($conf['renderer_'.$mode]) ? $conf['renderer_'.$mode] : $mode;
565
566    // try default renderer first:
567    $file = DOKU_INC."inc/parser/$rname.php";
568    if(@file_exists($file)){
569        require_once $file;
570        $rclass = "Doku_Renderer_$rname";
571
572        if ( !class_exists($rclass) ) {
573            trigger_error("Unable to resolve render class $rclass",E_USER_WARNING);
574            msg("Renderer '$rname' for $mode not valid",-1);
575            return null;
576        }
577        $Renderer = new $rclass();
578    }else{
579        // Maybe a plugin/component is available?
580        list($plugin, $component) = $plugin_controller->_splitName($rname);
581        if (!$plugin_controller->isdisabled($plugin)){
582            $Renderer =& $plugin_controller->load('renderer',$rname);
583        }
584
585        if(is_null($Renderer)){
586            msg("No renderer '$rname' found for mode '$mode'",-1);
587            return null;
588        }
589    }
590
591    return $Renderer;
592}
593
594/**
595 * Gets the first heading from a file
596 *
597 * @param   string   $id       dokuwiki page id
598 * @param   bool     $render   rerender if first heading not known
599 *                             default: true  -- must be set to false for calls from the metadata renderer to
600 *                                               protects against loops and excessive resource usage when pages
601 *                                               for which only a first heading is required will attempt to
602 *                                               render metadata for all the pages for which they require first
603 *                                               headings ... and so on.
604 *
605 * @author Andreas Gohr <andi@splitbrain.org>
606 */
607function p_get_first_heading($id, $render=true){
608    return p_get_metadata($id,'title',$render);
609}
610
611/**
612 * Wrapper for GeSHi Code Highlighter, provides caching of its output
613 *
614 * @param  string   $code       source code to be highlighted
615 * @param  string   $language   language to provide highlighting
616 * @param  string   $wrapper    html element to wrap the returned highlighted text
617 *
618 * @author Christopher Smith <chris@jalakai.co.uk>
619 * @author Andreas Gohr <andi@splitbrain.org>
620 */
621function p_xhtml_cached_geshi($code, $language, $wrapper='pre') {
622    global $conf, $config_cascade;
623    $language = strtolower($language);
624
625    // remove any leading or trailing blank lines
626    $code = preg_replace('/^\s*?\n|\s*?\n$/','',$code);
627
628    $cache = getCacheName($language.$code,".code");
629    $ctime = @filemtime($cache);
630    if($ctime && !$_REQUEST['purge'] &&
631            $ctime > filemtime(DOKU_INC.'inc/geshi.php') &&                 // geshi changed
632            $ctime > @filemtime(DOKU_INC.'inc/geshi/'.$language.'.php') &&  // language syntax definition changed
633            $ctime > filemtime(reset($config_cascade['main']['default']))){ // dokuwiki changed
634        $highlighted_code = io_readFile($cache, false);
635
636    } else {
637
638        $geshi = new GeSHi($code, $language, DOKU_INC . 'inc/geshi');
639        $geshi->set_encoding('utf-8');
640        $geshi->enable_classes();
641        $geshi->set_header_type(GESHI_HEADER_PRE);
642        $geshi->set_link_target($conf['target']['extern']);
643
644        // remove GeSHi's wrapper element (we'll replace it with our own later)
645        // we need to use a GeSHi wrapper to avoid <BR> throughout the highlighted text
646        $highlighted_code = trim(preg_replace('!^<pre[^>]*>|</pre>$!','',$geshi->parse_code()),"\n\r");
647        io_saveFile($cache,$highlighted_code);
648    }
649
650    // add a wrapper element if required
651    if ($wrapper) {
652        return "<$wrapper class=\"code $language\">$highlighted_code</$wrapper>";
653    } else {
654        return $highlighted_code;
655    }
656}
657
658