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 Haeussge/** 1871ec1101SGina Haeussge * All DokuWiki plugins to extend the parser/rendering mechanism 1971ec1101SGina Haeussge * need to inherit from this class 2071ec1101SGina Haeussge */ 2171ec1101SGina Haeussgeclass syntax_plugin_include_include extends DokuWiki_Syntax_Plugin { 2271ec1101SGina Haeussge 23d34e85a5SMichael Hamann /** @var $helper helper_plugin_include */ 2461053b04SMichael Klier var $helper = null; 2561053b04SMichael Klier 26d34e85a5SMichael Hamann /** 27d34e85a5SMichael Hamann * Get syntax plugin type. 28d34e85a5SMichael Hamann * 29d34e85a5SMichael Hamann * @return string The plugin type. 30d34e85a5SMichael Hamann */ 3171ec1101SGina Haeussge function getType() { return 'substition'; } 32d34e85a5SMichael Hamann 33d34e85a5SMichael Hamann /** 34d34e85a5SMichael Hamann * Get sort order of syntax plugin. 35d34e85a5SMichael Hamann * 36d34e85a5SMichael Hamann * @return int The sort order. 37d34e85a5SMichael Hamann */ 3871ec1101SGina Haeussge function getSort() { return 303; } 39d34e85a5SMichael Hamann 40d34e85a5SMichael Hamann /** 41d34e85a5SMichael Hamann * Get paragraph type. 42d34e85a5SMichael Hamann * 43d34e85a5SMichael Hamann * @return string The paragraph type. 44d34e85a5SMichael Hamann */ 4571ec1101SGina Haeussge function getPType() { return 'block'; } 4671ec1101SGina Haeussge 47d34e85a5SMichael Hamann /** 48d34e85a5SMichael Hamann * Connect patterns/modes 49d34e85a5SMichael Hamann * 50d34e85a5SMichael Hamann * @param $mode mixed The current mode 51d34e85a5SMichael Hamann */ 5271ec1101SGina Haeussge function connectTo($mode) { 5371ec1101SGina Haeussge $this->Lexer->addSpecialPattern("{{page>.+?}}", $mode, 'plugin_include_include'); 5471ec1101SGina Haeussge $this->Lexer->addSpecialPattern("{{section>.+?}}", $mode, 'plugin_include_include'); 558b99501bSMichael Klier $this->Lexer->addSpecialPattern("{{namespace>.+?}}", $mode, 'plugin_include_include'); 56a0a6f8fbSMichael Klier $this->Lexer->addSpecialPattern("{{tagtopic>.+?}}", $mode, 'plugin_include_include'); 5771ec1101SGina Haeussge } 5871ec1101SGina Haeussge 59d34e85a5SMichael Hamann /** 60d34e85a5SMichael Hamann * Handle syntax matches 61d34e85a5SMichael Hamann * 62d34e85a5SMichael Hamann * @param string $match The current match 63d34e85a5SMichael Hamann * @param int $state The match state 64d34e85a5SMichael Hamann * @param int $pos The position of the match 65d34e85a5SMichael Hamann * @param Doku_Handler $handler The hanlder object 66d34e85a5SMichael Hamann * @return array The instructions of the plugin 67d34e85a5SMichael Hamann */ 684aa23dc0SGerrit Uitslag function handle($match, $state, $pos, Doku_Handler $handler) { 6971ec1101SGina Haeussge 7071ec1101SGina Haeussge $match = substr($match, 2, -2); // strip markup 71*3e552d80SMichael Hamann list($match, $flags) = array_pad(explode('&', $match, 2), 2, ''); 7271ec1101SGina Haeussge 7361053b04SMichael Klier // break the pattern up into its parts 74*3e552d80SMichael Hamann list($mode, $page, $sect) = array_pad(preg_split('/>|#/u', $match, 3), 3, null); 75df062bd2SMichael Hamann $check = false; 765534e4ebSMichael Hamann if (isset($sect)) $sect = sectionID($sect, $check); 77b0c45c90SMichael Hamann $level = NULL; 78b0c45c90SMichael Hamann return array($mode, $page, $sect, explode('&', $flags), $level, $pos); 7971ec1101SGina Haeussge } 8071ec1101SGina Haeussge 811a25f14bSMichael Hamann /** 821a25f14bSMichael Hamann * Renders the included page(s) 831a25f14bSMichael Hamann * 841a25f14bSMichael Hamann * @author Michael Hamann <michael@content-space.de> 851a25f14bSMichael Hamann */ 864aa23dc0SGerrit Uitslag function render($format, Doku_Renderer $renderer, $data) { 87df062bd2SMichael Hamann global $ID; 881a25f14bSMichael Hamann 891a25f14bSMichael Hamann // static stack that records all ancestors of the child pages 901a25f14bSMichael Hamann static $page_stack = array(); 911a25f14bSMichael Hamann 921a25f14bSMichael Hamann // when there is no id just assume the global $ID is the current id 931a25f14bSMichael Hamann if (empty($page_stack)) $page_stack[] = $ID; 941a25f14bSMichael Hamann 951a25f14bSMichael Hamann $parent_id = $page_stack[count($page_stack)-1]; 961a25f14bSMichael Hamann $root_id = $page_stack[0]; 971a25f14bSMichael Hamann 98b0c45c90SMichael Hamann list($mode, $page, $sect, $flags, $level, $pos) = $data; 991a25f14bSMichael Hamann 1001a25f14bSMichael Hamann if (!$this->helper) 1018611cb4cSMichael Hamann $this->helper = plugin_load('helper', 'include'); 1021a25f14bSMichael Hamann $flags = $this->helper->get_flags($flags); 1031a25f14bSMichael Hamann 104ff4c1966SMichael Hamann $pages = $this->helper->_get_included_pages($mode, $page, $sect, $parent_id, $flags); 105791e1550SMichael Hamann 106791e1550SMichael Hamann if ($format == 'metadata') { 107d34e85a5SMichael Hamann /** @var Doku_Renderer_metadata $renderer */ 108560e27a0SMichael Hamann 109560e27a0SMichael Hamann // remove old persistent metadata of previous versions of the include plugin 110560e27a0SMichael Hamann if (isset($renderer->persistent['plugin_include'])) { 111560e27a0SMichael Hamann unset($renderer->persistent['plugin_include']); 112560e27a0SMichael Hamann unset($renderer->meta['plugin_include']); 113560e27a0SMichael Hamann } 114560e27a0SMichael Hamann 11520b61c98SMichael Hamann $renderer->meta['plugin_include']['instructions'][] = compact('mode', 'page', 'sect', 'parent_id', 'flags'); 116791e1550SMichael Hamann if (!isset($renderer->meta['plugin_include']['pages'])) 117791e1550SMichael Hamann $renderer->meta['plugin_include']['pages'] = array(); // add an array for array_merge 118791e1550SMichael Hamann $renderer->meta['plugin_include']['pages'] = array_merge($renderer->meta['plugin_include']['pages'], $pages); 119b11b2b9dSMichael Hamann $renderer->meta['plugin_include']['include_content'] = isset($_REQUEST['include_content']); 1201a25f14bSMichael Hamann } 1211a25f14bSMichael Hamann 122b0c45c90SMichael Hamann $secids = array(); 12322752482SLarsDW223 if ($format == 'xhtml' || $format == 'odt') { 124b0c45c90SMichael Hamann $secids = p_get_metadata($ID, 'plugin_include secids'); 125b0c45c90SMichael Hamann } 126b0c45c90SMichael Hamann 1271a25f14bSMichael Hamann foreach ($pages as $page) { 128791e1550SMichael Hamann extract($page); 129d34e85a5SMichael Hamann $id = $page['id']; 130d34e85a5SMichael Hamann $exists = $page['exists']; 1311a25f14bSMichael Hamann 132791e1550SMichael Hamann if (in_array($id, $page_stack)) continue; 133791e1550SMichael Hamann array_push($page_stack, $id); 134b3159774SBart Louwers 1356db19c84SMichael Hamann // add references for backlink 13667e87481SMichael Hamann if ($format == 'metadata') { 1376db19c84SMichael Hamann $renderer->meta['relation']['references'][$id] = $exists; 13867e87481SMichael Hamann $renderer->meta['relation']['haspart'][$id] = $exists; 139b0c45c90SMichael Hamann if (!$sect && !$flags['firstsec'] && !$flags['linkonly'] && !isset($renderer->meta['plugin_include']['secids'][$id])) { 140b0c45c90SMichael Hamann $renderer->meta['plugin_include']['secids'][$id] = array('hid' => 'plugin_include__'.str_replace(':', '__', $id), 'pos' => $pos); 141b0c45c90SMichael Hamann } 14267e87481SMichael Hamann } 1436db19c84SMichael Hamann 144b0c45c90SMichael Hamann if (isset($secids[$id]) && $pos === $secids[$id]['pos']) { 145b0c45c90SMichael Hamann $flags['include_secid'] = $secids[$id]['hid']; 146b0c45c90SMichael Hamann } else { 147b0c45c90SMichael Hamann unset($flags['include_secid']); 148b0c45c90SMichael Hamann } 149b0c45c90SMichael Hamann 150b0c45c90SMichael Hamann $instructions = $this->helper->_get_instructions($id, $sect, $mode, $level, $flags, $root_id, $secids); 151993fccf3SMichael Hamann 152df1d74c6SMichael Grosse if (!$flags['editbtn']) { 153df1d74c6SMichael Grosse global $conf; 154df1d74c6SMichael Grosse $maxseclevel_org = $conf['maxseclevel']; 155df1d74c6SMichael Grosse $conf['maxseclevel'] = 0; 156df1d74c6SMichael Grosse } 1571a25f14bSMichael Hamann $renderer->nest($instructions); 158df1d74c6SMichael Grosse if (isset($maxseclevel_org)) { 159df1d74c6SMichael Grosse $conf['maxseclevel'] = $maxseclevel_org; 160df1d74c6SMichael Grosse unset($maxseclevel_org); 161df1d74c6SMichael Grosse } 162993fccf3SMichael Hamann 1631a25f14bSMichael Hamann array_pop($page_stack); 1641a25f14bSMichael Hamann } 1651a25f14bSMichael Hamann 1661a25f14bSMichael Hamann // When all includes have been handled remove the current id 1671a25f14bSMichael Hamann // in order to allow the rendering of other pages 1681a25f14bSMichael Hamann if (count($page_stack) == 1) array_pop($page_stack); 1691a25f14bSMichael Hamann 1701a25f14bSMichael Hamann return true; 17161053b04SMichael Klier } 17271ec1101SGina Haeussge} 1732524d407SMichael Hamann// vim:ts=4:sw=4:et: 174