xref: /plugin/include/helper.php (revision 9a5e9896632a72ab765035ea4b606dec2af8f55f)
1f9f65fc3Swikidesign<?php
2f9f65fc3Swikidesign/**
3f9f65fc3Swikidesign * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
4f9f65fc3Swikidesign * @author     Esther Brunner <wikidesign@gmail.com>
5dbdadbd9SGina Haeussge * @author     Christopher Smith <chris@jalakai.co.uk>
6dbdadbd9SGina Haeussge * @author     Gina Häußge, Michael Klier <dokuwiki@chimeric.de>
7f9f65fc3Swikidesign */
8f9f65fc3Swikidesign
9f9f65fc3Swikidesign// must be run within Dokuwiki
10f9f65fc3Swikidesignif (!defined('DOKU_INC')) die();
11f9f65fc3Swikidesign
12f9f65fc3Swikidesignif (!defined('DOKU_LF')) define('DOKU_LF', "\n");
13f9f65fc3Swikidesignif (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
14f9f65fc3Swikidesignif (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
15f9f65fc3Swikidesign
16f9f65fc3Swikidesignclass helper_plugin_include extends DokuWiki_Plugin { // DokuWiki_Helper_Plugin
17f9f65fc3Swikidesign
186f0ad9d7SMichael Klier    var $includes     = array();
1961053b04SMichael Klier    var $toplevel_id  = NULL;
204d3c3e05SMichael Klier    var $toplevel     = NULL;
216f0ad9d7SMichael Klier    var $defaults     = array();
22a58d2b0aSwikidesign
2352e31fceSwikidesign    /**
246f0ad9d7SMichael Klier     * Constructor loads default config settings once
2552e31fceSwikidesign     */
2652e31fceSwikidesign    function helper_plugin_include() {
276f0ad9d7SMichael Klier        $this->defaults['firstsec']  = $this->getConf('firstseconly');
286f0ad9d7SMichael Klier        $this->defaults['editbtn']   = $this->getConf('showeditbtn');
296f0ad9d7SMichael Klier        $this->defaults['taglogos']  = $this->getConf('showtaglogos');
306f0ad9d7SMichael Klier        $this->defaults['footer']    = $this->getConf('showfooter');
316f0ad9d7SMichael Klier        $this->defaults['redirect']  = $this->getConf('doredirect');
326f0ad9d7SMichael Klier        $this->defaults['date']      = $this->getConf('showdate');
336f0ad9d7SMichael Klier        $this->defaults['user']      = $this->getConf('showuser');
346f0ad9d7SMichael Klier        $this->defaults['comments']  = $this->getConf('showcomments');
357a09d26bSMichael Klier        $this->defaults['linkbacks'] = $this->getConf('showlinkbacks');
367a09d26bSMichael Klier        $this->defaults['tags']      = $this->getConf('showtags');
376f0ad9d7SMichael Klier        $this->defaults['link']      = $this->getConf('showlink');
38b68e5bd3SMichael Klier        $this->defaults['permalink'] = $this->getConf('showpermalink');
3952e31fceSwikidesign    }
4052e31fceSwikidesign
41f9f65fc3Swikidesign    function getInfo() {
42f9f65fc3Swikidesign        return array(
4371ec1101SGina Haeussge                'author' => 'Gina Häußge, Michael Klier, Esther Brunner',
44dbdadbd9SGina Haeussge                'email'  => 'dokuwiki@chimeric.de',
454052f233SGina Haeussge                'date'   => @file_get_contents(DOKU_PLUGIN . 'blog/VERSION'),
46f9f65fc3Swikidesign                'name'   => 'Include Plugin (helper class)',
47f9f65fc3Swikidesign                'desc'   => 'Functions to include another page in a wiki page',
481f7a99c4SMichael Klier                'url'    => 'http://wiki.splitbrain.org/plugin:include',
49f9f65fc3Swikidesign                );
50f9f65fc3Swikidesign    }
51f9f65fc3Swikidesign
526f0ad9d7SMichael Klier    /**
536f0ad9d7SMichael Klier     * Available methods for other plugins
546f0ad9d7SMichael Klier     */
55f9f65fc3Swikidesign    function getMethods() {
56f9f65fc3Swikidesign        $result = array();
57f9f65fc3Swikidesign        $result[] = array(
586f0ad9d7SMichael Klier                'name'   => 'get_flags',
596b088758Swikidesign                'desc'   => 'overrides standard values for showfooter and firstseconly settings',
60656a5d08Swikidesign                'params' => array('flags' => 'array'),
61656a5d08Swikidesign                );
62f9f65fc3Swikidesign        return $result;
63f9f65fc3Swikidesign    }
64f9f65fc3Swikidesign
65f9f65fc3Swikidesign    /**
666b088758Swikidesign     * Overrides standard values for showfooter and firstseconly settings
67656a5d08Swikidesign     */
686f0ad9d7SMichael Klier    function get_flags($setflags) {
696f0ad9d7SMichael Klier        // load defaults
706f0ad9d7SMichael Klier        $flags = array();
716f0ad9d7SMichael Klier        $flags = $this->defaults;
726f0ad9d7SMichael Klier        foreach ($setflags as $flag) {
73656a5d08Swikidesign            switch ($flag) {
746b088758Swikidesign                case 'footer':
756f0ad9d7SMichael Klier                    $flags['footer'] = 1;
76656a5d08Swikidesign                    break;
776b088758Swikidesign                case 'nofooter':
786f0ad9d7SMichael Klier                    $flags['footer'] = 0;
79656a5d08Swikidesign                    break;
80656a5d08Swikidesign                case 'firstseconly':
8143dcb6deSwikidesign                case 'firstsectiononly':
826f0ad9d7SMichael Klier                    $flags['firstsec'] = 1;
83656a5d08Swikidesign                    break;
84656a5d08Swikidesign                case 'fullpage':
856f0ad9d7SMichael Klier                    $flags['firstsec'] = 0;
86656a5d08Swikidesign                    break;
87990ad87fSwikidesign                case 'noheader':
886f0ad9d7SMichael Klier                    $flags['noheader'] = 1;
89990ad87fSwikidesign                    break;
9043dcb6deSwikidesign                case 'editbtn':
91a3a7e530Swikidesign                case 'editbutton':
926f0ad9d7SMichael Klier                    $flags['editbtn'] = 1;
936c836050Swikidesign                    break;
9443dcb6deSwikidesign                case 'noeditbtn':
95a3a7e530Swikidesign                case 'noeditbutton':
966f0ad9d7SMichael Klier                    $flags['editbtn'] = 0;
976c836050Swikidesign                    break;
9871ec1101SGina Haeussge                case 'permalink':
996f0ad9d7SMichael Klier                    $flags['permalink'] = 1;
10071ec1101SGina Haeussge                    break;
10171ec1101SGina Haeussge                case 'nopermalink':
1026f0ad9d7SMichael Klier                    $flags['permalink'] = 0;
10371ec1101SGina Haeussge                    break;
104c44026dcSMichael Hamann                case 'redirect':
1056f0ad9d7SMichael Klier                    $flags['redirect'] = 1;
106c44026dcSMichael Hamann                    break;
107c44026dcSMichael Hamann                case 'noredirect':
1086f0ad9d7SMichael Klier                    $flags['redirect'] = 0;
109c44026dcSMichael Hamann                    break;
110b68e5bd3SMichael Klier                case 'link':
111b68e5bd3SMichael Klier                    $flags['link'] = 1;
112b68e5bd3SMichael Klier                    break;
113656a5d08Swikidesign            }
114656a5d08Swikidesign        }
1156f0ad9d7SMichael Klier        return $flags;
1166f0ad9d7SMichael Klier    }
1176f0ad9d7SMichael Klier
1186f0ad9d7SMichael Klier    /**
1194d3c3e05SMichael Klier     * Parses the instructions list of the page which contains the includes
1206f0ad9d7SMichael Klier     *
1216f0ad9d7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
1226f0ad9d7SMichael Klier     */
1236f0ad9d7SMichael Klier    function parse_instructions($id, &$ins) {
1246f0ad9d7SMichael Klier        $num = count($ins);
1256f0ad9d7SMichael Klier
1264d3c3e05SMichael Klier        $lvl      = false;
1274d3c3e05SMichael Klier        $prev_lvl = false;
1286f0ad9d7SMichael Klier        $mode  = '';
1296f0ad9d7SMichael Klier        $page  = '';
1306f0ad9d7SMichael Klier        $flags = array();
1314d3c3e05SMichael Klier        $range = false;
1326f0ad9d7SMichael Klier
1336f0ad9d7SMichael Klier        for($i=0; $i<$num; $i++) {
1346f0ad9d7SMichael Klier            // set current level
1356f0ad9d7SMichael Klier            if($ins[$i][0] == 'section_open') {
1366f0ad9d7SMichael Klier                $lvl = $ins[$i][1][0];
1374d3c3e05SMichael Klier                if($i > $range) $prev_lvl = $lvl;
1386f0ad9d7SMichael Klier            }
1396f0ad9d7SMichael Klier            if($ins[$i][0] == 'plugin' && $ins[$i][1][0] == 'include_include' ) {
1404d3c3e05SMichael Klier                // found no previous section set lvl to 0
1414d3c3e05SMichael Klier                if(!$lvl) $lvl = 0;
1424d3c3e05SMichael Klier
1434d3c3e05SMichael Klier                // check if toplevel is set already
1444d3c3e05SMichael Klier                if(!isset($this->toplevel)) $this->toplevel = $lvl;
1454d3c3e05SMichael Klier
1466f0ad9d7SMichael Klier                $mode  = $ins[$i][1][1][0];
1476f0ad9d7SMichael Klier                $page  = $ins[$i][1][1][1];
1486f0ad9d7SMichael Klier                $sect  = $ins[$i][1][1][2];
1496f0ad9d7SMichael Klier                $flags = $ins[$i][1][1][3];
1506f0ad9d7SMichael Klier
1514d3c3e05SMichael Klier                // check if we left the range of possible sub includes and reset lvl to toplevel
1524d3c3e05SMichael Klier                if($range && ($i > $range)) {
1534d3c3e05SMichael Klier                    if($prev_lvl) {
1544d3c3e05SMichael Klier                        $lvl = $prev_lvl;
1554d3c3e05SMichael Klier                        $prev_lvl = false;
1564d3c3e05SMichael Klier                    } else {
1574d3c3e05SMichael Klier                        $lvl = $this->toplevel;
1584d3c3e05SMichael Klier                    }
1594d3c3e05SMichael Klier                }
1604d3c3e05SMichael Klier
1616f0ad9d7SMichael Klier                $page = $this->_apply_macro($page);
1626f0ad9d7SMichael Klier                resolve_pageid(getNS($id), $page, $exists); // resolve shortcuts
1636f0ad9d7SMichael Klier                $flags  = $this->get_flags($flags);
1644d3c3e05SMichael Klier
1656f0ad9d7SMichael Klier                $ins_inc = $this->_get_instructions($page, $sect, $mode, $lvl, $flags);
1666f0ad9d7SMichael Klier
1676f0ad9d7SMichael Klier                if(!empty($ins_inc)) {
1686f0ad9d7SMichael Klier                    // combine instructions and reset counter
1696f0ad9d7SMichael Klier                    $ins_start = array_slice($ins, 0, $i+1);
1706f0ad9d7SMichael Klier                    $ins_end   = array_slice($ins, $i+1);
1714d3c3e05SMichael Klier                    $range = $i + count($ins_inc);
1726f0ad9d7SMichael Klier                    $ins = array_merge($ins_start, $ins_inc, $ins_end);
1736f0ad9d7SMichael Klier                    $num = count($ins);
1746f0ad9d7SMichael Klier                }
1756f0ad9d7SMichael Klier            }
1766f0ad9d7SMichael Klier        }
177656a5d08Swikidesign    }
178656a5d08Swikidesign
179656a5d08Swikidesign    /**
1806f0ad9d7SMichael Klier     * Returns the converted instructions of a give page/section
1816f0ad9d7SMichael Klier     *
1826f0ad9d7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
183f9f65fc3Swikidesign     */
1846f0ad9d7SMichael Klier    function _get_instructions($page, $sect, $mode, $lvl, $flags) {
18551b9ed81Swikidesign        global $ID;
18651b9ed81Swikidesign
1876f0ad9d7SMichael Klier        if($ID == $page || !page_exists($page) || (page_exists($page) && auth_quickaclcheck($page) < AUTH_READ)) return array();
1885ceddc03SMichael Klier        $key = ($sect) ? $page . '#' . $sect : $page;
189f9f65fc3Swikidesign
1906f0ad9d7SMichael Klier        // prevent recursion
1916f0ad9d7SMichael Klier        if(!$this->includes[$key]) {
1926f0ad9d7SMichael Klier            $ins = p_cached_instructions(wikiFN($page));
1936f0ad9d7SMichael Klier            $this->includes[$key] = true;
1946f0ad9d7SMichael Klier            $this->_convert_instructions($ins, $lvl, $page, $sect, $flags);
1956f0ad9d7SMichael Klier            return $ins;
1966f0ad9d7SMichael Klier        }
1976f0ad9d7SMichael Klier    }
198c01ce462SGina Haeussge
1996f0ad9d7SMichael Klier    /**
2006f0ad9d7SMichael Klier     * Converts instructions of the included page
2016f0ad9d7SMichael Klier     *
2024d3c3e05SMichael Klier     * The funcion iterates over the given list of instructions and generates
2034d3c3e05SMichael Klier     * an index of header and section indicies. It also removes document
2044d3c3e05SMichael Klier     * start/end instructions, converts links, and removes unwanted
2054d3c3e05SMichael Klier     * instructions like tags, comments, linkbacks.
2064d3c3e05SMichael Klier     *
2074d3c3e05SMichael Klier     * Later all header/section levels are convertet to match the current
2084d3c3e05SMichael Klier     * inclusion level.
2094d3c3e05SMichael Klier     *
2106f0ad9d7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
2116f0ad9d7SMichael Klier     */
2126f0ad9d7SMichael Klier    function _convert_instructions(&$ins, $lvl, $page, $sect, $flags) {
213f9f65fc3Swikidesign
2144d3c3e05SMichael Klier        // filter instructions if needed
2156f0ad9d7SMichael Klier        if(!empty($sect)) {
2166f0ad9d7SMichael Klier            $this->_get_section($ins, $sect);   // section required
2179a5081d2SMichael Klier        }
2189a5081d2SMichael Klier
2199a5081d2SMichael Klier        if($flags['firstsec']) {
2206f0ad9d7SMichael Klier            $this->_get_firstsec($ins, $page);  // only first section
2216f0ad9d7SMichael Klier        }
222c01ce462SGina Haeussge
2236f0ad9d7SMichael Klier        $ns  = getNS($page);
2246f0ad9d7SMichael Klier        $num = count($ins);
2254d3c3e05SMichael Klier
2264d3c3e05SMichael Klier        $conv_idx = array(); // conversion index
2274d3c3e05SMichael Klier        $lvl_max  = false;   // max level
2284d3c3e05SMichael Klier        $first_header = -1;
2297b46e3e0SMichael Klier        $no_header  = false;
230952393d3SMichael Klier        $sect_title = false;
2314d3c3e05SMichael Klier
2326f0ad9d7SMichael Klier        for($i=0; $i<$num; $i++) {
2336f0ad9d7SMichael Klier            switch($ins[$i][0]) {
2346f0ad9d7SMichael Klier                case 'document_start':
2356f0ad9d7SMichael Klier                case 'document_end':
2366f0ad9d7SMichael Klier                case 'section_edit':
2376f0ad9d7SMichael Klier                    unset($ins[$i]);
2386f0ad9d7SMichael Klier                    break;
2396f0ad9d7SMichael Klier                case 'header':
240952393d3SMichael Klier                    // get section title of first section
241952393d3SMichael Klier                    if($sect && !$sect_title) {
242952393d3SMichael Klier                        $sect_title = $ins[$i][1][0];
243952393d3SMichael Klier                    }
2447b46e3e0SMichael Klier                    // check if we need to skip the first header
2457b46e3e0SMichael Klier                    if((!$no_header) && $flags['noheader']) {
2467b46e3e0SMichael Klier                        unset($ins[$i]);
2477b46e3e0SMichael Klier                        $no_header = true;
2487b46e3e0SMichael Klier                        continue;
2497b46e3e0SMichael Klier                    }
2504d3c3e05SMichael Klier                    $conv_idx[] = $i;
2514d3c3e05SMichael Klier                    // get index of first header
2524d3c3e05SMichael Klier                    if($first_header == -1) $first_header = $i;
2534d3c3e05SMichael Klier                    // get max level if this instructions set
2544d3c3e05SMichael Klier                    if(!$lvl_max || ($ins[$i][1][1] < $lvl_max)) {
2554d3c3e05SMichael Klier                        $lvl_max = $ins[$i][1][1];
2566f0ad9d7SMichael Klier                    }
2576f0ad9d7SMichael Klier                    break;
2586f0ad9d7SMichael Klier                case 'section_open':
2594d3c3e05SMichael Klier                    $conv_idx[] = $i;
2606f0ad9d7SMichael Klier                    break;
2616f0ad9d7SMichael Klier                case 'internallink':
2626f0ad9d7SMichael Klier                case 'internalmedia':
2636f0ad9d7SMichael Klier                    if($ins[$i][1][0]{0} == '.') {
2646f0ad9d7SMichael Klier                        if($ins[$i][1][0]{1} == '.') {
2656f0ad9d7SMichael Klier                            $ins[$i][1][0] = getNS($ns) . ':' . substr($ins[$i][1][0], 2); // parent namespace
2666cad866dSwikidesign                        } else {
2676f0ad9d7SMichael Klier                            $ins[$i][1][0] = $ns . ':' . substr($ins[$i][1][0], 1); // current namespace
2686f0ad9d7SMichael Klier                        }
2696f0ad9d7SMichael Klier                    } elseif (strpos($ins[$i][1][0], ':') === false) {
2706f0ad9d7SMichael Klier                        $ins[$i][1][0] = $ns . ':' . $ins[$i][1][0]; // relative links
2716f0ad9d7SMichael Klier                    }
2726f0ad9d7SMichael Klier                    break;
2736f0ad9d7SMichael Klier                case 'plugin':
2744d3c3e05SMichael Klier                    // FIXME skip other plugins?
275c8a489faSMichael Klier                    switch($ins[$i][1][0]) {
276c8a489faSMichael Klier                        case 'tag_tag':                 // skip tags
277c8a489faSMichael Klier                        case 'discussion_comments':     // skip comments
278c8a489faSMichael Klier                        case 'linkback':                // skip linkbacks
279c8a489faSMichael Klier                        case 'data_entry':              // skip data plugin
280c8a489faSMichael Klier                            unset($ins[$i]);
281c8a489faSMichael Klier                            break;
282c8a489faSMichael Klier                    }
2836f0ad9d7SMichael Klier                    break;
2846f0ad9d7SMichael Klier                default:
2856f0ad9d7SMichael Klier                    break;
2866f0ad9d7SMichael Klier            }
2876cad866dSwikidesign        }
288656a5d08Swikidesign
2894d3c3e05SMichael Klier        // calculate difference between header/section level and include level
2904d3c3e05SMichael Klier        $diff = 0;
2914d3c3e05SMichael Klier        if($lvl_max) {
2924d3c3e05SMichael Klier            // max level equals inclusion level diff is 1
2934d3c3e05SMichael Klier            if($lvl_max == $lvl) {
2944d3c3e05SMichael Klier                $diff = 1;
2954d3c3e05SMichael Klier            }
2964d3c3e05SMichael Klier            // max level is les than inclusion level, we have to convert downwards
2974d3c3e05SMichael Klier            if($lvl_max < $lvl) {
2984d3c3e05SMichael Klier                $diff = (($lvl - $lvl_max) + 1);
2994d3c3e05SMichael Klier            }
3004d3c3e05SMichael Klier            // max level is greate inclusion level, we have to convert upwards
3014d3c3e05SMichael Klier            if($lvl_max > $lvl) {
3024d3c3e05SMichael Klier                if($lvl == 0) {
3034d3c3e05SMichael Klier                    // we had no previous section pretend it was 1
3044d3c3e05SMichael Klier                    $diff = (1 - $lvl_max);
3054d3c3e05SMichael Klier                } elseif(($lvl - $lvl_max) == -1) {
3064d3c3e05SMichael Klier                    // we don't need to convert anything up diff is 0
3074d3c3e05SMichael Klier                    $diff = 0;
3084d3c3e05SMichael Klier                } else {
3094d3c3e05SMichael Klier                    // convert everything up
3104d3c3e05SMichael Klier                    $diff = ($lvl - $lvl_max);
3114d3c3e05SMichael Klier                }
3124d3c3e05SMichael Klier            }
3134d3c3e05SMichael Klier        }
3144d3c3e05SMichael Klier
3154d3c3e05SMichael Klier        // convert headers and set footer/permalink
3164d3c3e05SMichael Klier        $has_permalink = false;
3174d3c3e05SMichael Klier        $footer_lvl    = false;
3184d3c3e05SMichael Klier        foreach($conv_idx as $idx) {
3194d3c3e05SMichael Klier            if($ins[$idx][0] == 'header') {
3204d3c3e05SMichael Klier                $new_lvl = (($ins[$idx][1][1] + $diff) > 5) ? 5 : ($ins[$idx][1][1] + $diff);
3214d3c3e05SMichael Klier                $ins[$idx][1][1] = $new_lvl;
3224d3c3e05SMichael Klier
3234d3c3e05SMichael Klier                // set permalink
3244d3c3e05SMichael Klier                if($flags['link'] && !$has_permalink && ($idx == $first_header)) {
3253a39ce39SMichael Klier                    $this->_permalink($ins[$idx], $page, $sect, $flags);
3264d3c3e05SMichael Klier                    $has_permalink = true;
3274d3c3e05SMichael Klier                }
3284d3c3e05SMichael Klier            } else {
3294d3c3e05SMichael Klier                // it's a section
3304d3c3e05SMichael Klier                $new_lvl = (($ins[$idx][1][0] + $diff) > 5) ? 5 : ($ins[$idx][1][0] + $diff);
3314d3c3e05SMichael Klier                $ins[$idx][1][0] = $new_lvl;
33212121da4SMichael Klier                // check if noheader is used and set the footer level to the first section
33312121da4SMichael Klier                if($no_header && !$footer_lvl) $footer_lvl = $new_lvl;
3344d3c3e05SMichael Klier            }
3354d3c3e05SMichael Klier
3364d3c3e05SMichael Klier            // set footer level
3374d3c3e05SMichael Klier            if(!$footer_lvl && ($idx == $first_header)) $footer_lvl = $new_lvl;
3384d3c3e05SMichael Klier        }
3394d3c3e05SMichael Klier
3406a1594b7SMichael Klier        // add edit button
3416a1594b7SMichael Klier        if($flags['editbtn']) $this->_editbtn($ins, $page, $sect, $sect_title);
3426a1594b7SMichael Klier
3434d3c3e05SMichael Klier        // add footer
3446f0ad9d7SMichael Klier        if($flags['footer']) $this->_footer($ins, $page, $sect, $sect_title, $flags, $footer_lvl);
345ec00fca6Swikidesign
3464dd0672cSMichael Klier        // add instructions entry divs
347225daccdSMichael Klier        array_unshift($ins, array('plugin', array('include_div', array('open', $page))));
3484dd0672cSMichael Klier        array_push($ins, array('plugin', array('include_div', array('close'))));
3494dd0672cSMichael Klier
3506f0ad9d7SMichael Klier        // close previous section if any and re-open after inclusion
3514d3c3e05SMichael Klier        if($lvl != 0) {
3526f0ad9d7SMichael Klier            array_unshift($ins, array('section_close'));
3534d3c3e05SMichael Klier            $ins[] = array('section_open', array($lvl));
3546f0ad9d7SMichael Klier        }
355f9f65fc3Swikidesign    }
356f9f65fc3Swikidesign
3576f0ad9d7SMichael Klier    /**
3586f0ad9d7SMichael Klier     * Appends instruction item for the include plugin footer
3596f0ad9d7SMichael Klier     *
3606f0ad9d7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
3616f0ad9d7SMichael Klier     */
3626f0ad9d7SMichael Klier    function _footer(&$ins, $page, $sect, $sect_title, $flags, $footer_lvl) {
3636f0ad9d7SMichael Klier        $footer = array();
3646f0ad9d7SMichael Klier        $footer[0] = 'plugin';
3656f0ad9d7SMichael Klier        $footer[1] = array('include_footer', array($page, $sect, $sect_title, $flags, $this->toplevel_id, $footer_lvl));
3666f0ad9d7SMichael Klier        $ins[] = $footer;
3676f0ad9d7SMichael Klier    }
3686f0ad9d7SMichael Klier
3696f0ad9d7SMichael Klier    /**
3706a1594b7SMichael Klier     * Appends instruction item for an edit button
3716a1594b7SMichael Klier     *
3726a1594b7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
3736a1594b7SMichael Klier     */
3746a1594b7SMichael Klier    function _editbtn(&$ins, $page, $sect, $sect_title) {
3756a1594b7SMichael Klier        $editbtn = array();
3766a1594b7SMichael Klier        $editbtn[0] = 'plugin';
3776a1594b7SMichael Klier        $editbtn[1] = array('include_editbtn', array($page, $sect, $sect_title, $this->toplevel_id));
3786a1594b7SMichael Klier        $ins[] = $editbtn;
3796a1594b7SMichael Klier    }
3806a1594b7SMichael Klier
3816a1594b7SMichael Klier    /**
3823a39ce39SMichael Klier     * Convert instruction item for a permalink header
3833a39ce39SMichael Klier     *
3843a39ce39SMichael Klier     * @author Michael Klier <chi@chimeric.de>
3853a39ce39SMichael Klier     */
3863a39ce39SMichael Klier    function _permalink(&$ins, $page, $sect, $flags) {
3873a39ce39SMichael Klier        $ins[0] = 'plugin';
3883a39ce39SMichael Klier        $ins[1] = array('include_header', array($ins[1][0], $ins[1][1], $page, $sect, $flags));
3893a39ce39SMichael Klier    }
3903a39ce39SMichael Klier
3913a39ce39SMichael Klier    /**
392f9f65fc3Swikidesign     * Get a section including its subsections
3936f0ad9d7SMichael Klier     *
3946f0ad9d7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
395f9f65fc3Swikidesign     */
3966f0ad9d7SMichael Klier    function _get_section(&$ins, $sect) {
3976f0ad9d7SMichael Klier        $num = count($ins);
3986f0ad9d7SMichael Klier        $offset = false;
3996f0ad9d7SMichael Klier        $lvl    = false;
4006f0ad9d7SMichael Klier
4016f0ad9d7SMichael Klier        for($i=0; $i<$num; $i++) {
4026f0ad9d7SMichael Klier            if ($ins[$i][0] == 'header') {
403f9f65fc3Swikidesign
404f9f65fc3Swikidesign                // found the right header
4056f0ad9d7SMichael Klier                if (cleanID($ins[$i][1][0]) == $sect) {
4066f0ad9d7SMichael Klier                    $offset = $i;
4076f0ad9d7SMichael Klier                    $lvl    = $ins[$i][1][1];
4086f0ad9d7SMichael Klier                } elseif ($offset && $lvl && ($ins[$i][1][1] <= $lvl)) {
4096f0ad9d7SMichael Klier                    $ins = array_slice($ins, $offset, ($i - $offset));
410f9f65fc3Swikidesign                }
411f9f65fc3Swikidesign            }
4126f0ad9d7SMichael Klier        }
413f9f65fc3Swikidesign    }
414f9f65fc3Swikidesign
415f9f65fc3Swikidesign    /**
4166f0ad9d7SMichael Klier     * Only display the first section of a page and a readmore link
417a58d2b0aSwikidesign     *
4186f0ad9d7SMichael Klier     * @author Michael Klier <chi@chimeric.de>
419a58d2b0aSwikidesign     */
4206f0ad9d7SMichael Klier    function _get_firstsec(&$ins, $page) {
4216f0ad9d7SMichael Klier        $num = count($ins);
422*9a5e9896SMichael Klier        $first_sect = false;
4236f0ad9d7SMichael Klier        for($i=0; $i<$num; $i++) {
4246f0ad9d7SMichael Klier            if($ins[$i][0] == 'section_close') {
425*9a5e9896SMichael Klier                $first_sect = $i;
426*9a5e9896SMichael Klier            }
427*9a5e9896SMichael Klier            if(($first_sect) && ($ins[$i][0] == 'section_open')) {
428*9a5e9896SMichael Klier                $ins = array_slice($ins, 0, $first_sect);
4296f0ad9d7SMichael Klier                $ins[] = array('p_open', array());
4306f0ad9d7SMichael Klier                $ins[] = array('internallink',array($page, $this->getLang('readmore')));
4316f0ad9d7SMichael Klier                $ins[] = array('p_close', array());
4326f0ad9d7SMichael Klier                $ins[] = array('section_close');
4336f0ad9d7SMichael Klier                return;
4346f0ad9d7SMichael Klier            }
435a58d2b0aSwikidesign        }
436f9f65fc3Swikidesign    }
437f9f65fc3Swikidesign
438a58d2b0aSwikidesign    /**
4396f0ad9d7SMichael Klier     * Makes user or date dependent includes possible
440a58d2b0aSwikidesign     */
4416f0ad9d7SMichael Klier    function _apply_macro($id) {
4426f0ad9d7SMichael Klier        global $INFO;
4436f0ad9d7SMichael Klier        global $auth;
444cf0272c0Swikidesign
4456f0ad9d7SMichael Klier        // if we don't have an auth object, do nothing
4466f0ad9d7SMichael Klier        if (!$auth) return $id;
447990ad87fSwikidesign
4486f0ad9d7SMichael Klier        $user     = $_SERVER['REMOTE_USER'];
4496f0ad9d7SMichael Klier        $userdata = $auth->getUserData($user);
4506f0ad9d7SMichael Klier        $group    = $userdata['grps'][0];
45161053b04SMichael Klier
4526f0ad9d7SMichael Klier        $replace = array(
4536f0ad9d7SMichael Klier                '@USER@'  => cleanID($user),
4546f0ad9d7SMichael Klier                '@NAME@'  => cleanID($INFO['userinfo']['name']),
4556f0ad9d7SMichael Klier                '@GROUP@' => cleanID($group),
4566f0ad9d7SMichael Klier                '@YEAR@'  => date('Y'),
4576f0ad9d7SMichael Klier                '@MONTH@' => date('m'),
4586f0ad9d7SMichael Klier                '@DAY@'   => date('d'),
459656a5d08Swikidesign                );
4606f0ad9d7SMichael Klier        return str_replace(array_keys($replace), array_values($replace), $id);
461a58d2b0aSwikidesign    }
462f9f65fc3Swikidesign}
463df4e907bSMichael Klier//vim:ts=4:sw=4:et:enc=utf-8:
464