xref: /plugin/include/syntax/include.php (revision 67e87481568af0b1f7e4686fef7a1d67384b3f75) 
1<?php
2/**
3 * Include Plugin: displays a wiki page within another
4 * Usage:
5 * {{page>page}} for "page" in same namespace
6 * {{page>:page}} for "page" in top namespace
7 * {{page>namespace:page}} for "page" in namespace "namespace"
8 * {{page>.namespace:page}} for "page" in subnamespace "namespace"
9 * {{page>page#section}} for a section of "page"
10 *
11 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
12 * @author     Esther Brunner <wikidesign@gmail.com>
13 * @author     Christopher Smith <chris@jalakai.co.uk>
14 * @author     Gina Häußge, Michael Klier <dokuwiki@chimeric.de>
15 */
16
17if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
18if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
19require_once(DOKU_PLUGIN.'syntax.php');
20
21/**
22 * All DokuWiki plugins to extend the parser/rendering mechanism
23 * need to inherit from this class
24 */
25class syntax_plugin_include_include extends DokuWiki_Syntax_Plugin {
26
27    var $helper = null;
28
29    function getType() { return 'substition'; }
30    function getSort() { return 303; }
31    function getPType() { return 'block'; }
32
33    function connectTo($mode) {
34        $this->Lexer->addSpecialPattern("{{page>.+?}}", $mode, 'plugin_include_include');
35        $this->Lexer->addSpecialPattern("{{section>.+?}}", $mode, 'plugin_include_include');
36        $this->Lexer->addSpecialPattern("{{namespace>.+?}}", $mode, 'plugin_include_include');
37        $this->Lexer->addSpecialPattern("{{tagtopic>.+?}}", $mode, 'plugin_include_include');
38    }
39
40    function handle($match, $state, $pos, &$handler) {
41
42        $match = substr($match, 2, -2); // strip markup
43        list($match, $flags) = explode('&', $match, 2);
44
45        // break the pattern up into its parts
46        list($mode, $page, $sect) = preg_split('/>|#/u', $match, 3);
47        $check = null;
48        if (isset($sect)) $sect = sectionID($sect, $check);
49        return array($mode, $page, $sect, explode('&', $flags));
50    }
51
52    /**
53     * Renders the included page(s)
54     *
55     * @author Michael Hamann <michael@content-space.de>
56     */
57    function render($format, &$renderer, $data) {
58        global $ID, $conf;
59
60        // static stack that records all ancestors of the child pages
61        static $page_stack = array();
62
63        // when there is no id just assume the global $ID is the current id
64        if (empty($page_stack)) $page_stack[] = $ID;
65
66        $parent_id = $page_stack[count($page_stack)-1];
67        $root_id = $page_stack[0];
68
69        list($mode, $page, $sect, $flags, $level) = $data;
70
71        if (!$this->helper)
72            $this->helper =& plugin_load('helper', 'include');
73        $flags = $this->helper->get_flags($flags);
74
75        $pages = $this->helper->_get_included_pages($mode, $page, $sect, $parent_id);
76
77        if ($format == 'metadata') {
78
79            // remove old persistent metadata of previous versions of the include plugin
80            if (isset($renderer->persistent['plugin_include'])) {
81                unset($renderer->persistent['plugin_include']);
82                unset($renderer->meta['plugin_include']);
83            }
84
85            $renderer->meta['plugin_include']['instructions'][] = compact('mode', 'page', 'sect', 'parent_id');
86            if (!isset($renderer->meta['plugin_include']['pages']))
87               $renderer->meta['plugin_include']['pages'] = array(); // add an array for array_merge
88            $renderer->meta['plugin_include']['pages'] = array_merge($renderer->meta['plugin_include']['pages'], $pages);
89            $renderer->meta['plugin_include']['include_content'] = isset($_REQUEST['include_content']);
90        }
91
92        foreach ($pages as $page) {
93            extract($page);
94
95            if (in_array($id, $page_stack)) continue;
96            array_push($page_stack, $id);
97
98            // add references for backlink
99            if ($format == 'metadata') {
100                $renderer->meta['relation']['references'][$id] = $exists;
101                $renderer->meta['relation']['haspart'][$id]    = $exists;
102            }
103
104            $instructions = $this->helper->_get_instructions($id, $sect, $mode, $level, $flags, $root_id);
105
106            $renderer->nest($instructions);
107
108            array_pop($page_stack);
109        }
110
111        // When all includes have been handled remove the current id
112        // in order to allow the rendering of other pages
113        if (count($page_stack) == 1) array_pop($page_stack);
114
115        return true;
116    }
117}
118// vim:ts=4:sw=4:et:
119