xref: /plugin/include/syntax/include.php (revision 993fccf38cd0351b20d2a1dea45a0629289eca85)
171ec1101SGina Haeussge<?php
271ec1101SGina Haeussge/**
371ec1101SGina Haeussge * Include Plugin: displays a wiki page within another
471ec1101SGina Haeussge * Usage:
571ec1101SGina Haeussge * {{page>page}} for "page" in same namespace
671ec1101SGina Haeussge * {{page>:page}} for "page" in top namespace
771ec1101SGina Haeussge * {{page>namespace:page}} for "page" in namespace "namespace"
871ec1101SGina Haeussge * {{page>.namespace:page}} for "page" in subnamespace "namespace"
971ec1101SGina Haeussge * {{page>page#section}} for a section of "page"
1071ec1101SGina Haeussge *
1171ec1101SGina Haeussge * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
1271ec1101SGina Haeussge * @author     Esther Brunner <wikidesign@gmail.com>
1371ec1101SGina Haeussge * @author     Christopher Smith <chris@jalakai.co.uk>
1471ec1101SGina Haeussge * @author     Gina Häußge, Michael Klier <dokuwiki@chimeric.de>
1571ec1101SGina Haeussge */
1671ec1101SGina Haeussge
1771ec1101SGina Haeussgeif(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
1871ec1101SGina Haeussgeif(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
1971ec1101SGina Haeussgerequire_once(DOKU_PLUGIN.'syntax.php');
2071ec1101SGina Haeussge
2171ec1101SGina Haeussge/**
2271ec1101SGina Haeussge * All DokuWiki plugins to extend the parser/rendering mechanism
2371ec1101SGina Haeussge * need to inherit from this class
2471ec1101SGina Haeussge */
2571ec1101SGina Haeussgeclass syntax_plugin_include_include extends DokuWiki_Syntax_Plugin {
2671ec1101SGina Haeussge
2761053b04SMichael Klier    var $helper = null;
2861053b04SMichael Klier
2971ec1101SGina Haeussge    function getType() { return 'substition'; }
3071ec1101SGina Haeussge    function getSort() { return 303; }
3171ec1101SGina Haeussge    function getPType() { return 'block'; }
3271ec1101SGina Haeussge
3371ec1101SGina Haeussge    function connectTo($mode) {
3471ec1101SGina Haeussge        $this->Lexer->addSpecialPattern("{{page>.+?}}", $mode, 'plugin_include_include');
3571ec1101SGina Haeussge        $this->Lexer->addSpecialPattern("{{section>.+?}}", $mode, 'plugin_include_include');
368b99501bSMichael Klier        $this->Lexer->addSpecialPattern("{{namespace>.+?}}", $mode, 'plugin_include_include');
37a0a6f8fbSMichael Klier        $this->Lexer->addSpecialPattern("{{tagtopic>.+?}}", $mode, 'plugin_include_include');
3871ec1101SGina Haeussge    }
3971ec1101SGina Haeussge
4071ec1101SGina Haeussge    function handle($match, $state, $pos, &$handler) {
4171ec1101SGina Haeussge
4271ec1101SGina Haeussge        $match = substr($match, 2, -2); // strip markup
4371ec1101SGina Haeussge        list($match, $flags) = explode('&', $match, 2);
4471ec1101SGina Haeussge
4561053b04SMichael Klier        // break the pattern up into its parts
466f0ad9d7SMichael Klier        list($mode, $page, $sect) = preg_split('/>|#/u', $match, 3);
476f0ad9d7SMichael Klier        return array($mode, $page, cleanID($sect), explode('&', $flags));
4871ec1101SGina Haeussge    }
4971ec1101SGina Haeussge
501a25f14bSMichael Hamann    /**
511a25f14bSMichael Hamann     * Renders the included page(s)
521a25f14bSMichael Hamann     *
531a25f14bSMichael Hamann     * @author Michael Hamann <michael@content-space.de>
541a25f14bSMichael Hamann     */
5571ec1101SGina Haeussge    function render($format, &$renderer, $data) {
561a25f14bSMichael Hamann        global $ID, $conf;
571a25f14bSMichael Hamann
581a25f14bSMichael Hamann        // static stack that records all ancestors of the child pages
591a25f14bSMichael Hamann        static $page_stack = array();
601a25f14bSMichael Hamann
611a25f14bSMichael Hamann        // when there is no id just assume the global $ID is the current id
621a25f14bSMichael Hamann        if (empty($page_stack)) $page_stack[] = $ID;
631a25f14bSMichael Hamann
641a25f14bSMichael Hamann        $parent_id = $page_stack[count($page_stack)-1];
651a25f14bSMichael Hamann        $root_id = $page_stack[0];
661a25f14bSMichael Hamann
671a25f14bSMichael Hamann        list($mode, $page, $sect, $flags, $level) = $data;
681a25f14bSMichael Hamann
691a25f14bSMichael Hamann        if (!$this->helper)
701a25f14bSMichael Hamann            $this->helper =& plugin_load('helper', 'include');
711a25f14bSMichael Hamann        $flags = $this->helper->get_flags($flags);
721a25f14bSMichael Hamann
73791e1550SMichael Hamann        $pages = $this->helper->_get_included_pages($mode, $page, $sect, $parent_id);
74791e1550SMichael Hamann
75791e1550SMichael Hamann        if ($format == 'metadata') {
76791e1550SMichael Hamann            $renderer->meta['plugin_include']['instructions'][] = array('mode' => $mode, 'page' => $page, 'sect' => $sect, 'parent_id' => $parent_id);
77791e1550SMichael Hamann            if (!isset($renderer->meta['plugin_include']['pages']))
78791e1550SMichael Hamann               $renderer->meta['plugin_include']['pages'] = array(); // add an array for array_merge
79791e1550SMichael Hamann            $renderer->meta['plugin_include']['pages'] = array_merge($renderer->meta['plugin_include']['pages'], $pages);
801a25f14bSMichael Hamann        }
811a25f14bSMichael Hamann
821a25f14bSMichael Hamann        foreach ($pages as $page) {
83791e1550SMichael Hamann            extract($page);
841a25f14bSMichael Hamann
85791e1550SMichael Hamann            if (in_array($id, $page_stack)) continue;
86791e1550SMichael Hamann            array_push($page_stack, $id);
871a25f14bSMichael Hamann
88791e1550SMichael Hamann            if(!$exists) {
891a25f14bSMichael Hamann                if($flags['footer']) {
90d8e4e8ddSMichael Hamann                    $footer_ins = array();
91d8e4e8ddSMichael Hamann                    if($flags['editbtn'] && (auth_quickaclcheck($id) >= AUTH_EDIT)) {
92d8e4e8ddSMichael Hamann                        $this->helper->_editbtn($footer_ins, $id, $sect, '', $root_id);
93d8e4e8ddSMichael Hamann                    }
94d8e4e8ddSMichael Hamann                    $footer_ins[] = $this->helper->_footer($id, $sect, '', $flags, $level, $root_id);
95d8e4e8ddSMichael Hamann                    $renderer->nest($footer_ins);
961a25f14bSMichael Hamann                }
971a25f14bSMichael Hamann            } else {
98791e1550SMichael Hamann                $instructions = $this->helper->_get_instructions($id, $sect, $mode, $level, $flags, $root_id);
99*993fccf3SMichael Hamann
100*993fccf3SMichael Hamann                if ($format == 'xhtml') {
101*993fccf3SMichael Hamann                    $renderer->startSectionEdit(0, 'plugin_include_start', $id);
102*993fccf3SMichael Hamann                    $renderer->finishSectionEdit();
103*993fccf3SMichael Hamann                    // Start a new section with type != section so headers in the included page
104*993fccf3SMichael Hamann                    // won't print section edit buttons of the parent page
105*993fccf3SMichael Hamann                    $renderer->startSectionEdit(0, 'plugin_include_end', $id);
106*993fccf3SMichael Hamann                }
107*993fccf3SMichael Hamann
1081a25f14bSMichael Hamann                $renderer->nest($instructions);
109*993fccf3SMichael Hamann
110*993fccf3SMichael Hamann                if ($format == 'xhtml') {
111*993fccf3SMichael Hamann                   $renderer->finishSectionEdit();
112*993fccf3SMichael Hamann                }
1131a25f14bSMichael Hamann            }
1141a25f14bSMichael Hamann
1151a25f14bSMichael Hamann            array_pop($page_stack);
1161a25f14bSMichael Hamann        }
1171a25f14bSMichael Hamann
1181a25f14bSMichael Hamann        // When all includes have been handled remove the current id
1191a25f14bSMichael Hamann        // in order to allow the rendering of other pages
1201a25f14bSMichael Hamann        if (count($page_stack) == 1) array_pop($page_stack);
1211a25f14bSMichael Hamann
1221a25f14bSMichael Hamann        return true;
12361053b04SMichael Klier    }
12471ec1101SGina Haeussge}
1252524d407SMichael Hamann// vim:ts=4:sw=4:et:
126