xref: /plugin/include/syntax/include.php (revision 7475482baf8e0860732268b04aa0a5265c0bb32c) 
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        return array($mode, $page, sectionID($sect, $check), explode('&', $flags));
49    }
50
51    /**
52     * Renders the included page(s)
53     *
54     * @author Michael Hamann <michael@content-space.de>
55     */
56    function render($format, &$renderer, $data) {
57        global $ID, $conf;
58
59        // static stack that records all ancestors of the child pages
60        static $page_stack = array();
61
62        // when there is no id just assume the global $ID is the current id
63        if (empty($page_stack)) $page_stack[] = $ID;
64
65        $parent_id = $page_stack[count($page_stack)-1];
66        $root_id = $page_stack[0];
67
68        list($mode, $page, $sect, $flags, $level) = $data;
69
70        if (!$this->helper)
71            $this->helper =& plugin_load('helper', 'include');
72        $flags = $this->helper->get_flags($flags);
73
74        $pages = $this->helper->_get_included_pages($mode, $page, $sect, $parent_id);
75
76        if ($format == 'metadata') {
77
78            // remove old persistent metadata of previous versions of the include plugin
79            if (isset($renderer->persistent['plugin_include'])) {
80                unset($renderer->persistent['plugin_include']);
81                unset($renderer->meta['plugin_include']);
82            }
83
84            $renderer->meta['plugin_include']['instructions'][] = compact('mode', 'page', 'sect', 'parent_id');
85            if (!isset($renderer->meta['plugin_include']['pages']))
86               $renderer->meta['plugin_include']['pages'] = array(); // add an array for array_merge
87            $renderer->meta['plugin_include']['pages'] = array_merge($renderer->meta['plugin_include']['pages'], $pages);
88            $renderer->meta['plugin_include']['include_content'] = isset($_REQUEST['include_content']);
89        }
90
91        foreach ($pages as $page) {
92            extract($page);
93
94            if (in_array($id, $page_stack)) continue;
95            array_push($page_stack, $id);
96
97            // add references for backlink
98            if ($format == 'metadata')
99                $renderer->meta['relation']['references'][$id] = $exists;
100
101            $instructions = $this->helper->_get_instructions($id, $sect, $mode, $level, $flags, $root_id);
102
103            $renderer->nest($instructions);
104
105            array_pop($page_stack);
106        }
107
108        // When all includes have been handled remove the current id
109        // in order to allow the rendering of other pages
110        if (count($page_stack) == 1) array_pop($page_stack);
111
112        return true;
113    }
114}
115// vim:ts=4:sw=4:et:
116