xref: /dokuwiki/inc/parserutils.php (revision 0d24b616cdb7336b978e6ecd0c1f845c1804f85f)
1c112d578Sandi<?php
2c112d578Sandi/**
3b8595a66SAndreas Gohr * Utilities for accessing the parser
4c112d578Sandi *
5c112d578Sandi * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6c112d578Sandi * @author     Harry Fuecks <hfuecks@gmail.com>
7c112d578Sandi * @author     Andreas Gohr <andi@splitbrain.org>
8c112d578Sandi */
9c112d578Sandi
10fa8adffeSAndreas Gohrif(!defined('DOKU_INC')) die('meh.');
11c112d578Sandi
12c112d578Sandi/**
1365aa8490SMichael Hamann * How many pages shall be rendered for getting metadata during one request
1465aa8490SMichael Hamann * at maximum? Note that this limit isn't respected when METADATA_RENDER_UNLIMITED
1565aa8490SMichael Hamann * is passed as render parameter to p_get_metadata.
16ff725173SMichael Hamann */
1765aa8490SMichael Hamannif (!defined('P_GET_METADATA_RENDER_LIMIT')) define('P_GET_METADATA_RENDER_LIMIT', 5);
1867c15eceSMichael Hamann
1967c15eceSMichael Hamann/** Don't render metadata even if it is outdated or doesn't exist */
2067c15eceSMichael Hamanndefine('METADATA_DONT_RENDER', 0);
2165aa8490SMichael Hamann/**
2265aa8490SMichael Hamann * Render metadata when the page is really newer or the metadata doesn't exist.
2365aa8490SMichael Hamann * Uses just a simple check, but should work pretty well for loading simple
2465aa8490SMichael Hamann * metadata values like the page title and avoids rendering a lot of pages in
2565aa8490SMichael Hamann * one request. The P_GET_METADATA_RENDER_LIMIT is used in this mode.
2665aa8490SMichael Hamann * Use this if it is unlikely that the metadata value you are requesting
2765aa8490SMichael Hamann * does depend e.g. on pages that are included in the current page using
2865aa8490SMichael Hamann * the include plugin (this is very likely the case for the page title, but
2965aa8490SMichael Hamann * not for relation references).
3065aa8490SMichael Hamann */
3167c15eceSMichael Hamanndefine('METADATA_RENDER_USING_SIMPLE_CACHE', 1);
3265aa8490SMichael Hamann/**
3365aa8490SMichael Hamann * Render metadata using the metadata cache logic. The P_GET_METADATA_RENDER_LIMIT
3465aa8490SMichael Hamann * is used in this mode. Use this mode when you are requesting more complex
3565aa8490SMichael Hamann * metadata. Although this will cause rendering more often it might actually have
3665aa8490SMichael Hamann * the effect that less current metadata is returned as it is more likely than in
3765aa8490SMichael Hamann * the simple cache mode that metadata needs to be rendered for all pages at once
3865aa8490SMichael Hamann * which means that when the metadata for the page is requested that actually needs
3965aa8490SMichael Hamann * to be updated the limit might have been reached already.
4065aa8490SMichael Hamann */
4167c15eceSMichael Hamanndefine('METADATA_RENDER_USING_CACHE', 2);
4265aa8490SMichael Hamann/**
4365aa8490SMichael Hamann * Render metadata without limiting the number of pages for which metadata is
4465aa8490SMichael Hamann * rendered. Use this mode with care, normally it should only be used in places
4565aa8490SMichael Hamann * like the indexer or in cli scripts where the execution time normally isn't
4665aa8490SMichael Hamann * limited. This can be combined with the simple cache using
4765aa8490SMichael Hamann * METADATA_RENDER_USING_CACHE | METADATA_RENDER_UNLIMITED.
4865aa8490SMichael Hamann */
4965aa8490SMichael Hamanndefine('METADATA_RENDER_UNLIMITED', 4);
50ff725173SMichael Hamann
51ff725173SMichael Hamann/**
52c112d578Sandi * Returns the parsed Wikitext in XHTML for the given id and revision.
53c112d578Sandi *
54c112d578Sandi * If $excuse is true an explanation is returned if the file
55c112d578Sandi * wasn't found
56c112d578Sandi *
57c112d578Sandi * @author Andreas Gohr <andi@splitbrain.org>
58c112d578Sandi */
59c112d578Sandifunction p_wiki_xhtml($id, $rev='', $excuse=true){
60c112d578Sandi    $file = wikiFN($id,$rev);
61c112d578Sandi    $ret  = '';
62c112d578Sandi
63c112d578Sandi    //ensure $id is in global $ID (needed for parsing)
641e76272cSandi    global $ID;
653ff8773bSAndreas Gohr    $keep = $ID;
661e76272cSandi    $ID   = $id;
67c112d578Sandi
68c112d578Sandi    if($rev){
69c112d578Sandi        if(@file_exists($file)){
70bde4e341SGalaxyMaster            $ret = p_render('xhtml',p_get_instructions(io_readWikiPage($file,$id,$rev)),$info); //no caching on old revisions
71c112d578Sandi        }elseif($excuse){
72c112d578Sandi            $ret = p_locale_xhtml('norev');
73c112d578Sandi        }
74c112d578Sandi    }else{
75c112d578Sandi        if(@file_exists($file)){
764b5f4f4eSchris            $ret = p_cached_output($file,'xhtml',$id);
77c112d578Sandi        }elseif($excuse){
78c112d578Sandi            $ret = p_locale_xhtml('newpage');
79c112d578Sandi        }
80c112d578Sandi    }
81c112d578Sandi
823ff8773bSAndreas Gohr    //restore ID (just in case)
833ff8773bSAndreas Gohr    $ID = $keep;
843ff8773bSAndreas Gohr
85c112d578Sandi    return $ret;
86c112d578Sandi}
87c112d578Sandi
88c112d578Sandi/**
896b7b33dcShfuecks * Returns starting summary for a page (e.g. the first few
906b7b33dcShfuecks * paragraphs), marked up in XHTML.
916b7b33dcShfuecks *
926b7b33dcShfuecks * If $excuse is true an explanation is returned if the file
936b7b33dcShfuecks * wasn't found
946b7b33dcShfuecks *
956b7b33dcShfuecks * @param string wiki page id
966b7b33dcShfuecks * @param reference populated with page title from heading or page id
978716966dSAndreas Gohr * @deprecated
988716966dSAndreas Gohr * @author Harry Fuecks <hfuecks@gmail.com>
996b7b33dcShfuecks */
1006b7b33dcShfuecksfunction p_wiki_xhtml_summary($id, &$title, $rev='', $excuse=true){
1016b7b33dcShfuecks    $file = wikiFN($id,$rev);
1026b7b33dcShfuecks    $ret  = '';
1036b7b33dcShfuecks
1046b7b33dcShfuecks    //ensure $id is in global $ID (needed for parsing)
1056b7b33dcShfuecks    global $ID;
1066b7b33dcShfuecks    $keep = $ID;
1076b7b33dcShfuecks    $ID   = $id;
1086b7b33dcShfuecks
1096b7b33dcShfuecks    if($rev){
1106b7b33dcShfuecks        if(@file_exists($file)){
1116b7b33dcShfuecks            //no caching on old revisions
112bde4e341SGalaxyMaster            $ins = p_get_instructions(io_readWikiPage($file,$id,$rev));
1136b7b33dcShfuecks        }elseif($excuse){
1146b7b33dcShfuecks            $ret = p_locale_xhtml('norev');
1156b7b33dcShfuecks            //restore ID (just in case)
1166b7b33dcShfuecks            $ID = $keep;
1176b7b33dcShfuecks            return $ret;
1186b7b33dcShfuecks        }
1196b7b33dcShfuecks
1206b7b33dcShfuecks    }else{
1216b7b33dcShfuecks
1226b7b33dcShfuecks        if(@file_exists($file)){
1236b7b33dcShfuecks            // The XHTML for a summary is not cached so use the instruction cache
1246b7b33dcShfuecks            $ins = p_cached_instructions($file);
1256b7b33dcShfuecks        }elseif($excuse){
1266b7b33dcShfuecks            $ret = p_locale_xhtml('newpage');
1276b7b33dcShfuecks            //restore ID (just in case)
1286b7b33dcShfuecks            $ID = $keep;
1296b7b33dcShfuecks            return $ret;
1306b7b33dcShfuecks        }
1316b7b33dcShfuecks    }
1326b7b33dcShfuecks
1336b7b33dcShfuecks    $ret = p_render('xhtmlsummary',$ins,$info);
1346b7b33dcShfuecks
1356b7b33dcShfuecks    if ( $info['sum_pagetitle'] ) {
1366b7b33dcShfuecks        $title = $info['sum_pagetitle'];
1376b7b33dcShfuecks    } else {
1386b7b33dcShfuecks        $title = $id;
1396b7b33dcShfuecks    }
1406b7b33dcShfuecks
1416b7b33dcShfuecks    $ID = $keep;
1426b7b33dcShfuecks    return $ret;
1436b7b33dcShfuecks}
1446b7b33dcShfuecks
1456b7b33dcShfuecks/**
146c112d578Sandi * Returns the specified local text in parsed format
147c112d578Sandi *
148c112d578Sandi * @author Andreas Gohr <andi@splitbrain.org>
149c112d578Sandi */
150c112d578Sandifunction p_locale_xhtml($id){
151c112d578Sandi    //fetch parsed locale
1524b5f4f4eSchris    $html = p_cached_output(localeFN($id));
153c112d578Sandi    return $html;
154c112d578Sandi}
155c112d578Sandi
156c112d578Sandi/**
1574b5f4f4eSchris *     *** DEPRECATED ***
1584b5f4f4eSchris *
1594b5f4f4eSchris * use p_cached_output()
1604b5f4f4eSchris *
161c112d578Sandi * Returns the given file parsed to XHTML
162c112d578Sandi *
163c112d578Sandi * Uses and creates a cachefile
164c112d578Sandi *
1654b5f4f4eSchris * @deprecated
166c112d578Sandi * @author Andreas Gohr <andi@splitbrain.org>
1679dc2c2afSandi * @todo   rewrite to use mode instead of hardcoded XHTML
168c112d578Sandi */
169c112d578Sandifunction p_cached_xhtml($file){
1704b5f4f4eSchris    return p_cached_output($file);
1714b5f4f4eSchris}
1724b5f4f4eSchris
1734b5f4f4eSchris/**
1744b5f4f4eSchris * Returns the given file parsed into the requested output format
1754b5f4f4eSchris *
1764b5f4f4eSchris * @author Andreas Gohr <andi@splitbrain.org>
1774b5f4f4eSchris * @author Chris Smith <chris@jalakai.co.uk>
1784b5f4f4eSchris */
1794b5f4f4eSchrisfunction p_cached_output($file, $format='xhtml', $id='') {
180c112d578Sandi    global $conf;
181c112d578Sandi
1824b5f4f4eSchris    $cache = new cache_renderer($id, $file, $format);
1834b5f4f4eSchris    if ($cache->useCache()) {
18485767031SAndreas Gohr        $parsed = $cache->retrieveCache(false);
185ea2a4271SAndreas Gohr        if($conf['allowdebug'] && $format=='xhtml') $parsed .= "\n<!-- cachefile {$cache->cache} used -->\n";
186c112d578Sandi    } else {
1874b5f4f4eSchris        $parsed = p_render($format, p_cached_instructions($file,false,$id), $info);
188c112d578Sandi
1899dc2c2afSandi        if ($info['cache']) {
1904b5f4f4eSchris            $cache->storeCache($parsed);               //save cachefile
191ea2a4271SAndreas Gohr            if($conf['allowdebug'] && $format=='xhtml') $parsed .= "\n<!-- no cachefile used, but created {$cache->cache} -->\n";
192c112d578Sandi        }else{
1934b5f4f4eSchris            $cache->removeCache();                     //try to delete cachefile
194ea2a4271SAndreas Gohr            if($conf['allowdebug'] && $format=='xhtml') $parsed .= "\n<!-- no cachefile used, caching forbidden -->\n";
195c112d578Sandi        }
196c112d578Sandi    }
197c112d578Sandi
198c112d578Sandi    return $parsed;
199c112d578Sandi}
200c112d578Sandi
201c112d578Sandi/**
202c112d578Sandi * Returns the render instructions for a file
203c112d578Sandi *
204c112d578Sandi * Uses and creates a serialized cache file
205c112d578Sandi *
206c112d578Sandi * @author Andreas Gohr <andi@splitbrain.org>
207c112d578Sandi */
2084b5f4f4eSchrisfunction p_cached_instructions($file,$cacheonly=false,$id='') {
209c112d578Sandi    global $conf;
21047b2d319SAndreas Gohr    static $run = null;
21147b2d319SAndreas Gohr    if(is_null($run)) $run = array();
212c112d578Sandi
2134b5f4f4eSchris    $cache = new cache_instructions($id, $file);
214c112d578Sandi
215*0d24b616SMichael Hamann    if ($cacheonly || $cache->useCache() || (isset($run[$file]) && !defined('DOKU_UNITTEST'))) {
2164b5f4f4eSchris        return $cache->retrieveCache();
217c112d578Sandi    } else if (@file_exists($file)) {
218c112d578Sandi        // no cache - do some work
219bde4e341SGalaxyMaster        $ins = p_get_instructions(io_readWikiPage($file,$id));
220cbaf4259SChris Smith        if ($cache->storeCache($ins)) {
22147b2d319SAndreas Gohr            $run[$file] = true; // we won't rebuild these instructions in the same run again
222cbaf4259SChris Smith        } else {
223cbaf4259SChris Smith            msg('Unable to save cache file. Hint: disk full; file permissions; safe_mode setting.',-1);
224cbaf4259SChris Smith        }
225c112d578Sandi        return $ins;
226c112d578Sandi    }
227c112d578Sandi
2283b3f8916SAndreas Gohr    return null;
229c112d578Sandi}
230c112d578Sandi
231c112d578Sandi/**
232c112d578Sandi * turns a page into a list of instructions
233c112d578Sandi *
234c112d578Sandi * @author Harry Fuecks <hfuecks@gmail.com>
235c112d578Sandi * @author Andreas Gohr <andi@splitbrain.org>
236c112d578Sandi */
2376bbae538Sandifunction p_get_instructions($text){
238c112d578Sandi
239107b01d6Sandi    $modes = p_get_parsermodes();
240ee20e7d1Sandi
241c112d578Sandi    // Create the parser
24267f9913dSAndreas Gohr    $Parser = new Doku_Parser();
243c112d578Sandi
244c112d578Sandi    // Add the Handler
24567f9913dSAndreas Gohr    $Parser->Handler = new Doku_Handler();
246c112d578Sandi
247107b01d6Sandi    //add modes to parser
248107b01d6Sandi    foreach($modes as $mode){
249107b01d6Sandi        $Parser->addMode($mode['mode'],$mode['obj']);
250c112d578Sandi    }
251c112d578Sandi
252c112d578Sandi    // Do the parsing
253677844afSchris    trigger_event('PARSER_WIKITEXT_PREPROCESS', $text);
254a2d649c4Sandi    $p = $Parser->parse($text);
255ee20e7d1Sandi    //  dbg($p);
256a2d649c4Sandi    return $p;
257c112d578Sandi}
258c112d578Sandi
259c112d578Sandi/**
26039a89382SEsther Brunner * returns the metadata of a page
26139a89382SEsther Brunner *
2624a819402SMichael Hamann * @param string $id The id of the page the metadata should be returned from
2634a819402SMichael Hamann * @param string $key The key of the metdata value that shall be read (by default everything) - separate hierarchies by " " like "date created"
26467c15eceSMichael Hamann * @param int $render If the page should be rendererd - possible values:
26565aa8490SMichael Hamann *     METADATA_DONT_RENDER, METADATA_RENDER_USING_SIMPLE_CACHE, METADATA_RENDER_USING_CACHE
26665aa8490SMichael Hamann *     METADATA_RENDER_UNLIMITED (also combined with the previous two options),
26765aa8490SMichael Hamann *     default: METADATA_RENDER_USING_CACHE
2684a819402SMichael Hamann * @return mixed The requested metadata fields
2694a819402SMichael Hamann *
27039a89382SEsther Brunner * @author Esther Brunner <esther@kaffeehaus.ch>
27198214867SMichael Hamann * @author Michael Hamann <michael@content-space.de>
27239a89382SEsther Brunner */
27367c15eceSMichael Hamannfunction p_get_metadata($id, $key='', $render=METADATA_RENDER_USING_CACHE){
2741172f8dcSAdrian Lang    global $ID;
27565aa8490SMichael Hamann    static $render_count = 0;
27665aa8490SMichael Hamann    // track pages that have already been rendered in order to avoid rendering the same page
27765aa8490SMichael Hamann    // again
27865aa8490SMichael Hamann    static $rendered_pages = array();
2796afe8dcaSchris
2800a7e3bceSchris    // cache the current page
2810a7e3bceSchris    // Benchmarking shows the current page's metadata is generally the only page metadata
2820a7e3bceSchris    // accessed several times. This may catch a few other pages, but that shouldn't be an issue.
2830a7e3bceSchris    $cache = ($ID == $id);
2840a7e3bceSchris    $meta = p_read_metadata($id, $cache);
28539a89382SEsther Brunner
28667c15eceSMichael Hamann    if (!is_numeric($render)) {
28767c15eceSMichael Hamann        if ($render) {
28867c15eceSMichael Hamann            $render = METADATA_RENDER_USING_SIMPLE_CACHE;
28967c15eceSMichael Hamann        } else {
29067c15eceSMichael Hamann            $render = METADATA_DONT_RENDER;
29167c15eceSMichael Hamann        }
29267c15eceSMichael Hamann    }
29367c15eceSMichael Hamann
29498214867SMichael Hamann    // prevent recursive calls in the cache
29598214867SMichael Hamann    static $recursion = false;
29665aa8490SMichael Hamann    if (!$recursion && $render != METADATA_DONT_RENDER && !isset($rendered_pages[$id])&& page_exists($id)){
29798214867SMichael Hamann        $recursion = true;
29898214867SMichael Hamann
29998214867SMichael Hamann        $cachefile = new cache_renderer($id, wikiFN($id), 'metadata');
30098214867SMichael Hamann
30167c15eceSMichael Hamann        $do_render = false;
30265aa8490SMichael Hamann        if ($render & METADATA_RENDER_UNLIMITED || $render_count < P_GET_METADATA_RENDER_LIMIT) {
30365aa8490SMichael Hamann            if ($render & METADATA_RENDER_USING_SIMPLE_CACHE) {
30467c15eceSMichael Hamann                $pagefn = wikiFN($id);
30567c15eceSMichael Hamann                $metafn = metaFN($id, '.meta');
30667c15eceSMichael Hamann                if (!@file_exists($metafn) || @filemtime($pagefn) > @filemtime($cachefile->cache)) {
30767c15eceSMichael Hamann                    $do_render = true;
30867c15eceSMichael Hamann                }
30967c15eceSMichael Hamann            } elseif (!$cachefile->useCache()){
31067c15eceSMichael Hamann                $do_render = true;
31167c15eceSMichael Hamann            }
31265aa8490SMichael Hamann        }
31367c15eceSMichael Hamann        if ($do_render) {
314*0d24b616SMichael Hamann            if (!defined('DOKU_UNITTEST')) {
31565aa8490SMichael Hamann                ++$render_count;
31665aa8490SMichael Hamann                $rendered_pages[$id] = true;
317*0d24b616SMichael Hamann            }
31869ba640bSMichael Hamann            $old_meta = $meta;
31939a89382SEsther Brunner            $meta = p_render_metadata($id, $meta);
32069ba640bSMichael Hamann            // only update the file when the metadata has been changed
32169ba640bSMichael Hamann            if ($meta == $old_meta || p_save_metadata($id, $meta)) {
32298214867SMichael Hamann                // store a timestamp in order to make sure that the cachefile is touched
3233d6feb16SMichael Hamann                // this timestamp is also stored when the meta data is still the same
32498214867SMichael Hamann                $cachefile->storeCache(time());
3253d6feb16SMichael Hamann            } else {
32698214867SMichael Hamann                msg('Unable to save metadata file. Hint: disk full; file permissions; safe_mode setting.',-1);
32798214867SMichael Hamann            }
32898214867SMichael Hamann        }
32998214867SMichael Hamann
33098214867SMichael Hamann        $recursion = false;
3316afe8dcaSchris    }
33239a89382SEsther Brunner
333ebf65d37SAdrian Lang    $val = $meta['current'];
334ebf65d37SAdrian Lang
33539a89382SEsther Brunner    // filter by $key
336569a0019SAdrian Lang    foreach(preg_split('/\s+/', $key, 2, PREG_SPLIT_NO_EMPTY) as $cur_key) {
337ebf65d37SAdrian Lang        if (!isset($val[$cur_key])) {
338ebf65d37SAdrian Lang            return null;
33966d29756SChris Smith        }
340ebf65d37SAdrian Lang        $val = $val[$cur_key];
34139a89382SEsther Brunner    }
342ebf65d37SAdrian Lang    return $val;
34339a89382SEsther Brunner}
34439a89382SEsther Brunner
34539a89382SEsther Brunner/**
34639a89382SEsther Brunner * sets metadata elements of a page
34739a89382SEsther Brunner *
348a365baeeSDominik Eckelmann * @see http://www.dokuwiki.org/devel:metadata#functions_to_get_and_set_metadata
349a365baeeSDominik Eckelmann *
350a365baeeSDominik Eckelmann * @param String  $id         is the ID of a wiki page
351a365baeeSDominik Eckelmann * @param Array   $data       is an array with key ⇒ value pairs to be set in the metadata
352a365baeeSDominik Eckelmann * @param Boolean $render     whether or not the page metadata should be generated with the renderer
353a365baeeSDominik Eckelmann * @param Boolean $persistent indicates whether or not the particular metadata value will persist through
354a365baeeSDominik Eckelmann *                            the next metadata rendering.
355a365baeeSDominik Eckelmann * @return boolean true on success
356a365baeeSDominik Eckelmann *
35739a89382SEsther Brunner * @author Esther Brunner <esther@kaffeehaus.ch>
3580e5fde48SMichael Hamann * @author Michael Hamann <michael@content-space.de>
35939a89382SEsther Brunner */
3600a7e3bceSchrisfunction p_set_metadata($id, $data, $render=false, $persistent=true){
36139a89382SEsther Brunner    if (!is_array($data)) return false;
36239a89382SEsther Brunner
3630e5fde48SMichael Hamann    global $ID, $METADATA_RENDERERS;
3640a7e3bceSchris
3650e5fde48SMichael Hamann    // if there is currently a renderer change the data in the renderer instead
3660e5fde48SMichael Hamann    if (isset($METADATA_RENDERERS[$id])) {
3670e5fde48SMichael Hamann        $orig =& $METADATA_RENDERERS[$id];
3680e5fde48SMichael Hamann        $meta = $orig;
3690e5fde48SMichael Hamann    } else {
3700a7e3bceSchris        // cache the current page
3710a7e3bceSchris        $cache = ($ID == $id);
3720a7e3bceSchris        $orig = p_read_metadata($id, $cache);
37339a89382SEsther Brunner
37439a89382SEsther Brunner        // render metadata first?
3750a7e3bceSchris        $meta = $render ? p_render_metadata($id, $orig) : $orig;
3760e5fde48SMichael Hamann    }
37739a89382SEsther Brunner
37839a89382SEsther Brunner    // now add the passed metadata
37939a89382SEsther Brunner    $protected = array('description', 'date', 'contributor');
38039a89382SEsther Brunner    foreach ($data as $key => $value){
38139a89382SEsther Brunner
38239a89382SEsther Brunner        // be careful with sub-arrays of $meta['relation']
38339a89382SEsther Brunner        if ($key == 'relation'){
3840a7e3bceSchris
38539a89382SEsther Brunner            foreach ($value as $subkey => $subvalue){
38666d29756SChris Smith                $meta['current'][$key][$subkey] = !empty($meta['current'][$key][$subkey]) ? array_merge($meta['current'][$key][$subkey], $subvalue) : $subvalue;
3870a7e3bceSchris                if ($persistent)
38866d29756SChris Smith                    $meta['persistent'][$key][$subkey] = !empty($meta['persistent'][$key][$subkey]) ? array_merge($meta['persistent'][$key][$subkey], $subvalue) : $subvalue;
38939a89382SEsther Brunner            }
39039a89382SEsther Brunner
39139a89382SEsther Brunner            // be careful with some senisitive arrays of $meta
39239a89382SEsther Brunner        } elseif (in_array($key, $protected)){
3930a7e3bceSchris
39466d29756SChris Smith            // these keys, must have subkeys - a legitimate value must be an array
39539a89382SEsther Brunner            if (is_array($value)) {
39666d29756SChris Smith                $meta['current'][$key] = !empty($meta['current'][$key]) ? array_merge($meta['current'][$key],$value) : $value;
3970a7e3bceSchris
3980a7e3bceSchris                if ($persistent) {
39966d29756SChris Smith                    $meta['persistent'][$key] = !empty($meta['persistent'][$key]) ? array_merge($meta['persistent'][$key],$value) : $value;
4000a7e3bceSchris                }
40139a89382SEsther Brunner            }
40239a89382SEsther Brunner
40339a89382SEsther Brunner            // no special treatment for the rest
40439a89382SEsther Brunner        } else {
4050a7e3bceSchris            $meta['current'][$key] = $value;
4060a7e3bceSchris            if ($persistent) $meta['persistent'][$key] = $value;
40739a89382SEsther Brunner        }
40839a89382SEsther Brunner    }
40939a89382SEsther Brunner
41039a89382SEsther Brunner    // save only if metadata changed
41139a89382SEsther Brunner    if ($meta == $orig) return true;
4126afe8dcaSchris
4130e5fde48SMichael Hamann    if (isset($METADATA_RENDERERS[$id])) {
4140e5fde48SMichael Hamann        // set both keys individually as the renderer has references to the individual keys
4150e5fde48SMichael Hamann        $METADATA_RENDERERS[$id]['current']    = $meta['current'];
4160e5fde48SMichael Hamann        $METADATA_RENDERERS[$id]['persistent'] = $meta['persistent'];
4171c56be7bSMichael Hamann        return true;
4180e5fde48SMichael Hamann    } else {
4191172f8dcSAdrian Lang        return p_save_metadata($id, $meta);
42039a89382SEsther Brunner    }
4210e5fde48SMichael Hamann}
42239a89382SEsther Brunner
42339a89382SEsther Brunner/**
4243d1f9ec3SMichael Klier * Purges the non-persistant part of the meta data
4253d1f9ec3SMichael Klier * used on page deletion
4263d1f9ec3SMichael Klier *
4273d1f9ec3SMichael Klier * @author Michael Klier <chi@chimeric.de>
4283d1f9ec3SMichael Klier */
4293d1f9ec3SMichael Klierfunction p_purge_metadata($id) {
4303d1f9ec3SMichael Klier    $meta = p_read_metadata($id);
4313d1f9ec3SMichael Klier    foreach($meta['current'] as $key => $value) {
4323d1f9ec3SMichael Klier        if(is_array($meta[$key])) {
4333d1f9ec3SMichael Klier            $meta['current'][$key] = array();
4343d1f9ec3SMichael Klier        } else {
4353d1f9ec3SMichael Klier            $meta['current'][$key] = '';
4363d1f9ec3SMichael Klier        }
4371172f8dcSAdrian Lang
4383d1f9ec3SMichael Klier    }
4391172f8dcSAdrian Lang    return p_save_metadata($id, $meta);
4403d1f9ec3SMichael Klier}
4413d1f9ec3SMichael Klier
4423d1f9ec3SMichael Klier/**
4430a7e3bceSchris * read the metadata from source/cache for $id
4440a7e3bceSchris * (internal use only - called by p_get_metadata & p_set_metadata)
4450a7e3bceSchris *
4460a7e3bceSchris * @author   Christopher Smith <chris@jalakai.co.uk>
4470a7e3bceSchris *
4480a7e3bceSchris * @param    string   $id      absolute wiki page id
4490a7e3bceSchris * @param    bool     $cache   whether or not to cache metadata in memory
4500a7e3bceSchris *                             (only use for metadata likely to be accessed several times)
4510a7e3bceSchris *
4520a7e3bceSchris * @return   array             metadata
4530a7e3bceSchris */
4540a7e3bceSchrisfunction p_read_metadata($id,$cache=false) {
4550a7e3bceSchris    global $cache_metadata;
4560a7e3bceSchris
4573a50618cSgweissbach    if (isset($cache_metadata[(string)$id])) return $cache_metadata[(string)$id];
4580a7e3bceSchris
4590a7e3bceSchris    $file = metaFN($id, '.meta');
4600a7e3bceSchris    $meta = @file_exists($file) ? unserialize(io_readFile($file, false)) : array('current'=>array(),'persistent'=>array());
4610a7e3bceSchris
4620a7e3bceSchris    if ($cache) {
4633a50618cSgweissbach        $cache_metadata[(string)$id] = $meta;
4640a7e3bceSchris    }
4650a7e3bceSchris
4660a7e3bceSchris    return $meta;
4670a7e3bceSchris}
4680a7e3bceSchris
4690a7e3bceSchris/**
4701172f8dcSAdrian Lang * This is the backend function to save a metadata array to a file
4711172f8dcSAdrian Lang *
4721172f8dcSAdrian Lang * @param    string   $id      absolute wiki page id
4731172f8dcSAdrian Lang * @param    array    $meta    metadata
4741172f8dcSAdrian Lang *
4751172f8dcSAdrian Lang * @return   bool              success / fail
4761172f8dcSAdrian Lang */
4771172f8dcSAdrian Langfunction p_save_metadata($id, $meta) {
4781172f8dcSAdrian Lang    // sync cached copies, including $INFO metadata
4791172f8dcSAdrian Lang    global $cache_metadata, $INFO;
4801172f8dcSAdrian Lang
4811172f8dcSAdrian Lang    if (isset($cache_metadata[$id])) $cache_metadata[$id] = $meta;
4821172f8dcSAdrian Lang    if (!empty($INFO) && ($id == $INFO['id'])) { $INFO['meta'] = $meta['current']; }
4831172f8dcSAdrian Lang
4841172f8dcSAdrian Lang    return io_saveFile(metaFN($id, '.meta'), serialize($meta));
4851172f8dcSAdrian Lang}
4861172f8dcSAdrian Lang
4871172f8dcSAdrian Lang/**
48839a89382SEsther Brunner * renders the metadata of a page
48939a89382SEsther Brunner *
49039a89382SEsther Brunner * @author Esther Brunner <esther@kaffeehaus.ch>
49139a89382SEsther Brunner */
49239a89382SEsther Brunnerfunction p_render_metadata($id, $orig){
49348924015SAndreas Gohr    // make sure the correct ID is in global ID
4940e5fde48SMichael Hamann    global $ID, $METADATA_RENDERERS;
4950e5fde48SMichael Hamann
4960e5fde48SMichael Hamann    // avoid recursive rendering processes for the same id
4970e5fde48SMichael Hamann    if (isset($METADATA_RENDERERS[$id]))
4980e5fde48SMichael Hamann        return $orig;
4990e5fde48SMichael Hamann
5000e5fde48SMichael Hamann    // store the original metadata in the global $METADATA_RENDERERS so p_set_metadata can use it
5010e5fde48SMichael Hamann    $METADATA_RENDERERS[$id] =& $orig;
5020e5fde48SMichael Hamann
50348924015SAndreas Gohr    $keep = $ID;
50448924015SAndreas Gohr    $ID   = $id;
50548924015SAndreas Gohr
5060a7e3bceSchris    // add an extra key for the event - to tell event handlers the page whose metadata this is
5070a7e3bceSchris    $orig['page'] = $id;
5080a7e3bceSchris    $evt = new Doku_Event('PARSER_METADATA_RENDER', $orig);
5090a7e3bceSchris    if ($evt->advise_before()) {
5100a7e3bceSchris
51139a89382SEsther Brunner        require_once DOKU_INC."inc/parser/metadata.php";
51239a89382SEsther Brunner
51339a89382SEsther Brunner        // get instructions
5144b5f4f4eSchris        $instructions = p_cached_instructions(wikiFN($id),false,$id);
51548924015SAndreas Gohr        if(is_null($instructions)){
51648924015SAndreas Gohr            $ID = $keep;
5170e5fde48SMichael Hamann            unset($METADATA_RENDERERS[$id]);
51848924015SAndreas Gohr            return null; // something went wrong with the instructions
51948924015SAndreas Gohr        }
52039a89382SEsther Brunner
52139a89382SEsther Brunner        // set up the renderer
52267f9913dSAndreas Gohr        $renderer = new Doku_Renderer_metadata();
5230e5fde48SMichael Hamann        $renderer->meta =& $orig['current'];
5240e5fde48SMichael Hamann        $renderer->persistent =& $orig['persistent'];
52539a89382SEsther Brunner
52639a89382SEsther Brunner        // loop through the instructions
52739a89382SEsther Brunner        foreach ($instructions as $instruction){
52839a89382SEsther Brunner            // execute the callback against the renderer
5293b748871SAndreas Gohr            call_user_func_array(array(&$renderer, $instruction[0]), (array) $instruction[1]);
53039a89382SEsther Brunner        }
53139a89382SEsther Brunner
5320e5fde48SMichael Hamann        $evt->result = array('current'=>&$renderer->meta,'persistent'=>&$renderer->persistent);
5330a7e3bceSchris    }
5340a7e3bceSchris    $evt->advise_after();
5350a7e3bceSchris
5360e5fde48SMichael Hamann    // clean up
53748924015SAndreas Gohr    $ID = $keep;
5380e5fde48SMichael Hamann    unset($METADATA_RENDERERS[$id]);
5390a7e3bceSchris    return $evt->result;
54039a89382SEsther Brunner}
54139a89382SEsther Brunner
54239a89382SEsther Brunner/**
543107b01d6Sandi * returns all available parser syntax modes in correct order
544107b01d6Sandi *
545107b01d6Sandi * @author Andreas Gohr <andi@splitbrain.org>
546107b01d6Sandi */
547107b01d6Sandifunction p_get_parsermodes(){
548107b01d6Sandi    global $conf;
549107b01d6Sandi
550107b01d6Sandi    //reuse old data
551107b01d6Sandi    static $modes = null;
552*0d24b616SMichael Hamann    if($modes != null && !defined('DOKU_UNITTEST')){
553107b01d6Sandi        return $modes;
554107b01d6Sandi    }
555107b01d6Sandi
556107b01d6Sandi    //import parser classes and mode definitions
557107b01d6Sandi    require_once DOKU_INC . 'inc/parser/parser.php';
558107b01d6Sandi
559107b01d6Sandi    // we now collect all syntax modes and their objects, then they will
560107b01d6Sandi    // be sorted and added to the parser in correct order
561107b01d6Sandi    $modes = array();
562107b01d6Sandi
563107b01d6Sandi    // add syntax plugins
564107b01d6Sandi    $pluginlist = plugin_list('syntax');
565107b01d6Sandi    if(count($pluginlist)){
566107b01d6Sandi        global $PARSER_MODES;
567107b01d6Sandi        $obj = null;
568107b01d6Sandi        foreach($pluginlist as $p){
569c90b2fb1Schris            if(!$obj =& plugin_load('syntax',$p)) continue; //attempt to load plugin into $obj
570107b01d6Sandi            $PARSER_MODES[$obj->getType()][] = "plugin_$p"; //register mode type
571107b01d6Sandi            //add to modes
572107b01d6Sandi            $modes[] = array(
573107b01d6Sandi                    'sort' => $obj->getSort(),
574107b01d6Sandi                    'mode' => "plugin_$p",
575107b01d6Sandi                    'obj'  => $obj,
576107b01d6Sandi                    );
577a46d0d65SAndreas Gohr            unset($obj); //remove the reference
578107b01d6Sandi        }
579107b01d6Sandi    }
580107b01d6Sandi
581107b01d6Sandi    // add default modes
582107b01d6Sandi    $std_modes = array('listblock','preformatted','notoc','nocache',
583107b01d6Sandi            'header','table','linebreak','footnote','hr',
584107b01d6Sandi            'unformatted','php','html','code','file','quote',
585e77ea1bcSAndreas Gohr            'internallink','rss','media','externallink',
586e77ea1bcSAndreas Gohr            'emaillink','windowssharelink','eol');
587e77ea1bcSAndreas Gohr    if($conf['typography']){
588e77ea1bcSAndreas Gohr        $std_modes[] = 'quotes';
589e77ea1bcSAndreas Gohr        $std_modes[] = 'multiplyentity';
590e77ea1bcSAndreas Gohr    }
591107b01d6Sandi    foreach($std_modes as $m){
592107b01d6Sandi        $class = "Doku_Parser_Mode_$m";
593107b01d6Sandi        $obj   = new $class();
594107b01d6Sandi        $modes[] = array(
595107b01d6Sandi                'sort' => $obj->getSort(),
596107b01d6Sandi                'mode' => $m,
597107b01d6Sandi                'obj'  => $obj
598107b01d6Sandi                );
599107b01d6Sandi    }
600107b01d6Sandi
601107b01d6Sandi    // add formatting modes
602107b01d6Sandi    $fmt_modes = array('strong','emphasis','underline','monospace',
603107b01d6Sandi            'subscript','superscript','deleted');
604107b01d6Sandi    foreach($fmt_modes as $m){
605107b01d6Sandi        $obj   = new Doku_Parser_Mode_formatting($m);
606107b01d6Sandi        $modes[] = array(
607107b01d6Sandi                'sort' => $obj->getSort(),
608107b01d6Sandi                'mode' => $m,
609107b01d6Sandi                'obj'  => $obj
610107b01d6Sandi                );
611107b01d6Sandi    }
612107b01d6Sandi
613107b01d6Sandi    // add modes which need files
614107b01d6Sandi    $obj     = new Doku_Parser_Mode_smiley(array_keys(getSmileys()));
615107b01d6Sandi    $modes[] = array('sort' => $obj->getSort(), 'mode' => 'smiley','obj'  => $obj );
616107b01d6Sandi    $obj     = new Doku_Parser_Mode_acronym(array_keys(getAcronyms()));
617107b01d6Sandi    $modes[] = array('sort' => $obj->getSort(), 'mode' => 'acronym','obj'  => $obj );
618107b01d6Sandi    $obj     = new Doku_Parser_Mode_entity(array_keys(getEntities()));
619107b01d6Sandi    $modes[] = array('sort' => $obj->getSort(), 'mode' => 'entity','obj'  => $obj );
620107b01d6Sandi
621107b01d6Sandi    // add optional camelcase mode
622107b01d6Sandi    if($conf['camelcase']){
623107b01d6Sandi        $obj     = new Doku_Parser_Mode_camelcaselink();
624107b01d6Sandi        $modes[] = array('sort' => $obj->getSort(), 'mode' => 'camelcaselink','obj'  => $obj );
625107b01d6Sandi    }
626107b01d6Sandi
627107b01d6Sandi    //sort modes
628107b01d6Sandi    usort($modes,'p_sort_modes');
629107b01d6Sandi
630107b01d6Sandi    return $modes;
631107b01d6Sandi}
632107b01d6Sandi
633107b01d6Sandi/**
634107b01d6Sandi * Callback function for usort
635107b01d6Sandi *
636107b01d6Sandi * @author Andreas Gohr <andi@splitbrain.org>
637107b01d6Sandi */
638107b01d6Sandifunction p_sort_modes($a, $b){
639107b01d6Sandi    if($a['sort'] == $b['sort']) return 0;
640107b01d6Sandi    return ($a['sort'] < $b['sort']) ? -1 : 1;
641107b01d6Sandi}
642107b01d6Sandi
643107b01d6Sandi/**
644ac83b9d8Sandi * Renders a list of instruction to the specified output mode
645c112d578Sandi *
6467a8cc57eSElan Ruusamäe * In the $info array is information from the renderer returned
6479dc2c2afSandi *
648c112d578Sandi * @author Harry Fuecks <hfuecks@gmail.com>
649c112d578Sandi * @author Andreas Gohr <andi@splitbrain.org>
650c112d578Sandi */
6519dc2c2afSandifunction p_render($mode,$instructions,&$info){
652c112d578Sandi    if(is_null($instructions)) return '';
653c112d578Sandi
654d968d3e5SChris Smith    $Renderer =& p_get_renderer($mode);
655d968d3e5SChris Smith    if (is_null($Renderer)) return null;
656c327d6c4SAndreas Gohr
657d968d3e5SChris Smith    $Renderer->reset();
658c112d578Sandi
659c112d578Sandi    $Renderer->smileys = getSmileys();
660c112d578Sandi    $Renderer->entities = getEntities();
661c112d578Sandi    $Renderer->acronyms = getAcronyms();
662c112d578Sandi    $Renderer->interwiki = getInterwiki();
663c112d578Sandi
664c112d578Sandi    // Loop through the instructions
665c112d578Sandi    foreach ( $instructions as $instruction ) {
666c112d578Sandi        // Execute the callback against the Renderer
667c112d578Sandi        call_user_func_array(array(&$Renderer, $instruction[0]),$instruction[1]);
668c112d578Sandi    }
6699dc2c2afSandi
6709dc2c2afSandi    //set info array
6719dc2c2afSandi    $info = $Renderer->info;
6729dc2c2afSandi
673677844afSchris    // Post process and return the output
674677844afSchris    $data = array($mode,& $Renderer->doc);
675677844afSchris    trigger_event('RENDERER_CONTENT_POSTPROCESS',$data);
676c112d578Sandi    return $Renderer->doc;
677c112d578Sandi}
678c112d578Sandi
679d968d3e5SChris Smithfunction & p_get_renderer($mode) {
6807aea91afSChris Smith    global $conf, $plugin_controller;
681d968d3e5SChris Smith
682d968d3e5SChris Smith    $rname = !empty($conf['renderer_'.$mode]) ? $conf['renderer_'.$mode] : $mode;
6830cacf91fSLucas    $rclass = "Doku_Renderer_$rname";
6840cacf91fSLucas
6850cacf91fSLucas    if( class_exists($rclass) ) {
6860cacf91fSLucas        return new $rclass();
6870cacf91fSLucas    }
688d968d3e5SChris Smith
689d968d3e5SChris Smith    // try default renderer first:
690d968d3e5SChris Smith    $file = DOKU_INC."inc/parser/$rname.php";
691d968d3e5SChris Smith    if(@file_exists($file)){
692d968d3e5SChris Smith        require_once $file;
693d968d3e5SChris Smith
694d968d3e5SChris Smith        if ( !class_exists($rclass) ) {
695d968d3e5SChris Smith            trigger_error("Unable to resolve render class $rclass",E_USER_WARNING);
696d968d3e5SChris Smith            msg("Renderer '$rname' for $mode not valid",-1);
697d968d3e5SChris Smith            return null;
698d968d3e5SChris Smith        }
69967f9913dSAndreas Gohr        $Renderer = new $rclass();
700d968d3e5SChris Smith    }else{
7017b27382cSGina Haeussge        // Maybe a plugin/component is available?
7027b27382cSGina Haeussge        list($plugin, $component) = $plugin_controller->_splitName($rname);
7037b27382cSGina Haeussge        if (!$plugin_controller->isdisabled($plugin)){
704f6ec8df8SAdrian Lang            $Renderer =& $plugin_controller->load('renderer',$rname);
7057aea91afSChris Smith        }
7067aea91afSChris Smith
707d968d3e5SChris Smith        if(is_null($Renderer)){
708d968d3e5SChris Smith            msg("No renderer '$rname' found for mode '$mode'",-1);
709d968d3e5SChris Smith            return null;
710d968d3e5SChris Smith        }
711d968d3e5SChris Smith    }
712d968d3e5SChris Smith
713d968d3e5SChris Smith    return $Renderer;
714d968d3e5SChris Smith}
715d968d3e5SChris Smith
716bb0a59d4Sjan/**
717bb0a59d4Sjan * Gets the first heading from a file
718bb0a59d4Sjan *
719fc18c0fbSchris * @param   string   $id       dokuwiki page id
72067c15eceSMichael Hamann * @param   int      $render   rerender if first heading not known
72167c15eceSMichael Hamann *                             default: METADATA_RENDER_USING_SIMPLE_CACHE
72267c15eceSMichael Hamann *                             Possible values: METADATA_DONT_RENDER,
72367c15eceSMichael Hamann *                                              METADATA_RENDER_USING_SIMPLE_CACHE,
72465aa8490SMichael Hamann *                                              METADATA_RENDER_USING_CACHE,
72565aa8490SMichael Hamann *                                              METADATA_RENDER_UNLIMITED
726fc18c0fbSchris *
72795dbfe57SAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
728bf0c93c2SMichael Hamann * @author Michael Hamann <michael@content-space.de>
729bb0a59d4Sjan */
73067c15eceSMichael Hamannfunction p_get_first_heading($id, $render=METADATA_RENDER_USING_SIMPLE_CACHE){
73165aa8490SMichael Hamann    return p_get_metadata(cleanID($id),'title',$render);
732bb0a59d4Sjan}
733bb0a59d4Sjan
7348f7d700cSchris/**
7358f7d700cSchris * Wrapper for GeSHi Code Highlighter, provides caching of its output
7368f7d700cSchris *
7375d568b99SChris Smith * @param  string   $code       source code to be highlighted
7385d568b99SChris Smith * @param  string   $language   language to provide highlighting
7395d568b99SChris Smith * @param  string   $wrapper    html element to wrap the returned highlighted text
7405d568b99SChris Smith *
7418f7d700cSchris * @author Christopher Smith <chris@jalakai.co.uk>
74235fbe9efSAndreas Gohr * @author Andreas Gohr <andi@splitbrain.org>
7438f7d700cSchris */
7445d568b99SChris Smithfunction p_xhtml_cached_geshi($code, $language, $wrapper='pre') {
745ff1769deSAndreas Gohr    global $conf, $config_cascade, $INPUT;
74635fbe9efSAndreas Gohr    $language = strtolower($language);
7475d568b99SChris Smith
7485d568b99SChris Smith    // remove any leading or trailing blank lines
7495d568b99SChris Smith    $code = preg_replace('/^\s*?\n|\s*?\n$/','',$code);
7505d568b99SChris Smith
7518f7d700cSchris    $cache = getCacheName($language.$code,".code");
75235fbe9efSAndreas Gohr    $ctime = @filemtime($cache);
753ff1769deSAndreas Gohr    if($ctime && !$INPUT->bool('purge') &&
754f8121585SChris Smith            $ctime > filemtime(DOKU_INC.'inc/geshi.php') &&                 // geshi changed
755f8121585SChris Smith            $ctime > @filemtime(DOKU_INC.'inc/geshi/'.$language.'.php') &&  // language syntax definition changed
756f8121585SChris Smith            $ctime > filemtime(reset($config_cascade['main']['default']))){ // dokuwiki changed
7578f7d700cSchris        $highlighted_code = io_readFile($cache, false);
7588f7d700cSchris
7598f7d700cSchris    } else {
7608f7d700cSchris
76135fbe9efSAndreas Gohr        $geshi = new GeSHi($code, $language, DOKU_INC . 'inc/geshi');
7628f7d700cSchris        $geshi->set_encoding('utf-8');
7638f7d700cSchris        $geshi->enable_classes();
7648f7d700cSchris        $geshi->set_header_type(GESHI_HEADER_PRE);
7658f7d700cSchris        $geshi->set_link_target($conf['target']['extern']);
7668f7d700cSchris
7675d568b99SChris Smith        // remove GeSHi's wrapper element (we'll replace it with our own later)
7685d568b99SChris Smith        // we need to use a GeSHi wrapper to avoid <BR> throughout the highlighted text
76969ddc332SAnika Henke        $highlighted_code = trim(preg_replace('!^<pre[^>]*>|</pre>$!','',$geshi->parse_code()),"\n\r");
7708f7d700cSchris        io_saveFile($cache,$highlighted_code);
7718f7d700cSchris    }
7728f7d700cSchris
7735d568b99SChris Smith    // add a wrapper element if required
7745d568b99SChris Smith    if ($wrapper) {
7755d568b99SChris Smith        return "<$wrapper class=\"code $language\">$highlighted_code</$wrapper>";
7765d568b99SChris Smith    } else {
7778f7d700cSchris        return $highlighted_code;
7788f7d700cSchris    }
7795d568b99SChris Smith}
7808f7d700cSchris
781