xref: /plugin/include/helper.php (revision 75668fa90184ea2394730e9a5f5e6f72a797e94a) 
1<?php
2/**
3 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
4 * @author     Esther Brunner <wikidesign@gmail.com>
5 * @author     Christopher Smith <chris@jalakai.co.uk>
6 * @author     Gina Häußge, Michael Klier <dokuwiki@chimeric.de>
7 */
8
9// must be run within Dokuwiki
10if (!defined('DOKU_INC')) die();
11
12if (!defined('DOKU_LF')) define('DOKU_LF', "\n");
13if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
14if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
15
16require_once(DOKU_INC.'inc/search.php');
17
18class helper_plugin_include extends DokuWiki_Plugin { // DokuWiki_Helper_Plugin
19
20    var $includes     = array();
21    var $hasparts     = array();
22    var $toplevel_id  = NULL;
23    var $toplevel     = 0;
24    var $defaults     = array();
25    var $include_key  = '';
26    var $sec_close    = true;
27
28    /**
29     * Constructor loads default config settings once
30     */
31    function helper_plugin_include() {
32        $this->defaults['firstsec']  = $this->getConf('firstseconly');
33        $this->defaults['editbtn']   = $this->getConf('showeditbtn');
34        $this->defaults['taglogos']  = $this->getConf('showtaglogos');
35        $this->defaults['footer']    = $this->getConf('showfooter');
36        $this->defaults['redirect']  = $this->getConf('doredirect');
37        $this->defaults['date']      = $this->getConf('showdate');
38        $this->defaults['user']      = $this->getConf('showuser');
39        $this->defaults['comments']  = $this->getConf('showcomments');
40        $this->defaults['linkbacks'] = $this->getConf('showlinkbacks');
41        $this->defaults['tags']      = $this->getConf('showtags');
42        $this->defaults['link']      = $this->getConf('showlink');
43        $this->defaults['permalink'] = $this->getConf('showpermalink');
44        $this->defaults['indent']    = $this->getConf('doindent');
45    }
46
47    /**
48     * Available methods for other plugins
49     */
50    function getMethods() {
51        $result = array();
52        $result[] = array(
53                'name'   => 'get_flags',
54                'desc'   => 'overrides standard values for showfooter and firstseconly settings',
55                'params' => array('flags' => 'array'),
56                );
57        return $result;
58    }
59
60    /**
61     * Overrides standard values for showfooter and firstseconly settings
62     */
63    function get_flags($setflags) {
64        // load defaults
65        $flags = array();
66        $flags = $this->defaults;
67        foreach ($setflags as $flag) {
68            switch ($flag) {
69                case 'footer':
70                    $flags['footer'] = 1;
71                    break;
72                case 'nofooter':
73                    $flags['footer'] = 0;
74                    break;
75                case 'firstseconly':
76                case 'firstsectiononly':
77                    $flags['firstsec'] = 1;
78                    break;
79                case 'fullpage':
80                    $flags['firstsec'] = 0;
81                    break;
82                case 'noheader':
83                    $flags['noheader'] = 1;
84                    break;
85                case 'editbtn':
86                case 'editbutton':
87                    $flags['editbtn'] = 1;
88                    break;
89                case 'noeditbtn':
90                case 'noeditbutton':
91                    $flags['editbtn'] = 0;
92                    break;
93                case 'permalink':
94                    $flags['permalink'] = 1;
95                    break;
96                case 'nopermalink':
97                    $flags['permalink'] = 0;
98                    break;
99                case 'redirect':
100                    $flags['redirect'] = 1;
101                    break;
102                case 'noredirect':
103                    $flags['redirect'] = 0;
104                    break;
105                case 'link':
106                    $flags['link'] = 1;
107                    break;
108                case 'nolink':
109                    $flags['link'] = 0;
110                    break;
111                case 'user':
112                    $flags['user'] = 1;
113                    break;
114                case 'nouser':
115                    $flags['user'] = 0;
116                    break;
117                case 'comments':
118                    $flags['comments'] = 1;
119                    break;
120                case 'nocomments':
121                    $flags['comments'] = 0;
122                    break;
123                case 'linkbacks':
124                    $flags['linkbacks'] = 1;
125                    break;
126                case 'nolinkbacks':
127                    $flags['linkbacks'] = 0;
128                    break;
129                case 'tags':
130                    $flags['tags'] = 1;
131                    break;
132                case 'notags':
133                    $flags['tags'] = 0;
134                    break;
135                case 'date':
136                    $flags['date'] = 1;
137                    break;
138                case 'nodate':
139                    $flags['date'] = 0;
140                    break;
141                case 'indent':
142                    $flags['indent'] = 1;
143                    break;
144                case 'noindent':
145                    $flags['indent'] = 0;
146                    break;
147            }
148        }
149        return $flags;
150    }
151
152    /**
153     * Parses the instructions list of the page which contains the includes
154     *
155     * @author Michael Klier <chi@chimeric.de>
156     */
157    function parse_instructions($id, &$ins) {
158        global $conf;
159        global $INFO;
160
161        $num = count($ins);
162
163        $lvl      = false;
164        $prev_lvl = 0;
165        $mode     = '';
166        $page     = '';
167        $flags    = array();
168        $range    = false;
169        $scope    = $id;
170
171        for($i=0; $i<$num; $i++) {
172            // set current level
173            if($ins[$i][0] == 'section_open') {
174                $lvl = $ins[$i][1][0];
175                if($i > $range) $prev_lvl = $lvl;
176            }
177
178            if($ins[$i][0] == 'plugin' && $ins[$i][1][0] == 'include_include' ) {
179                // found no previous section set lvl to 0
180                if(!$lvl) $lvl = 0;
181
182                $mode  = $ins[$i][1][1][0];
183
184                if($mode == 'namespace') {
185                    $ns    = str_replace(':', '/', cleanID($ins[$i][1][1][1]));
186                    $sect  = '';
187                    $flags = $ins[$i][1][1][3];
188
189                    $pages = array();
190                    search($pages, $conf['datadir'], 'search_list', '', $ns);
191                    sort($pages);
192
193                    if(!empty($pages)) {
194                        $ins_inc = array();
195                        foreach($pages as $page) {
196                            $this->_append_includeins($ins_inc, $page['id'], $flags);
197                        }
198                        $ins_start = array_slice($ins, 0, $i+1);
199                        $ins_end   = array_slice($ins, $i+1);
200                        $ins       = array_merge($ins_start, $ins_inc, $ins_end);
201                    }
202                    unset($ins[$i]);
203                    $i--;
204                }
205
206                if($mode == 'tagtopic') {
207                    $this->taghelper =& plugin_load('helper', 'tag');
208                    if(!$this->taghelper) {
209                        msg('You have to install the tag plugin to use this functionality!', -1);
210                        return;
211                    }
212                    $tag   = $ins[$i][1][1][1];
213                    $sect  = '';
214                    $flags = $ins[$i][1][1][3];
215
216                    $pages = array();
217                    $pages = $this->taghelper->getTopic('', null, $tag);
218
219                    if(!empty($pages)) {
220                        $ins_inc = array();
221                        foreach($pages as $title => $page) {
222                            $this->_append_includeins($ins_inc, $page['id'], $flags);
223                        }
224                        $ins_start = array_slice($ins, 0, $i+1);
225                        $ins_end   = array_slice($ins, $i+1);
226                        $ins       = array_merge($ins_start, $ins_inc, $ins_end);
227                    }
228                    unset($ins[$i]);
229                    $i--;
230                }
231
232                if($mode == 'page' || $mode == 'section') {
233                    $page = cleanID($this->_apply_macro($ins[$i][1][1][1]));
234
235                    resolve_pageid(getNS($scope), $page, $exists); // resolve shortcuts
236
237                    $perm = auth_quickaclcheck($page);
238
239                    array_push($this->hasparts, $page);
240                    if($perm < AUTH_READ) continue;
241
242                    $sect  = $ins[$i][1][1][2];
243                    $flags = $ins[$i][1][1][3];
244
245                    $ins[$i][1][1][4] = $scope;
246                    $scope = $page;
247                    $flags = $this->get_flags($flags);
248
249                    if(!page_exists($page)) {
250                        if($flags['footer']) {
251                            $ins[$i] = $this->_footer($page, $sect, '', $flags, 0);
252                        } else {
253                            unset($ins[$i]);
254                        }
255                    } else {
256                        $ins_inc = $this->_get_instructions($page, $sect, $mode, $lvl, $flags);
257                        if(!empty($ins_inc)) {
258                            // combine instructions and reset counter
259                            $ins_start = array_slice($ins, 0, $i+1);
260                            $ins_end   = array_slice($ins, $i+1);
261                            $range = $i + count($ins_inc);
262                            $ins = array_merge($ins_start, $ins_inc, $ins_end);
263                            $num = count($ins);
264                        }
265                    }
266                }
267            }
268
269            // check if we left the range of possible sub includes and reset lvl and scope to toplevel_id
270            if($range && ($i >= $range)) {
271                $lvl = ($prev_lvl == 0) ? 0 : $prev_lvl;
272                $range    = false;
273                // reset scope to toplevel_id
274                $scope = $this->toplevel_id;
275            }
276        }
277
278        if(!empty($INFO['userinfo'])) {
279            $include_key = $INFO['userinfo']['name'] . '|' . implode('|', $INFO['userinfo']['grps']);
280        } else {
281            $include_key = '@ALL';
282        }
283
284        // handle meta data
285        $meta = array();
286        $meta = p_get_metadata($id, 'plugin_include');
287        $meta['pages'] = array_unique($this->hasparts);
288        $meta['keys'][$include_key] = true;
289        $ins_meta    = array();
290        $ins_meta[0] = 'plugin';
291        $ins_meta[1] = array('include_meta', array($meta));
292        array_push($ins, $ins_meta);
293    }
294
295    /**
296     * Returns the converted instructions of a give page/section
297     *
298     * @author Michael Klier <chi@chimeric.de>
299     */
300    function _get_instructions($page, $sect, $mode, $lvl, $flags) {
301        $key = ($sect) ? $page . '#' . $sect : $page;
302
303        // prevent recursion
304        if(!$this->includes[$key]) {
305            $ins = p_cached_instructions(wikiFN($page));
306            $this->includes[$key] = true;
307            $this->_convert_instructions($ins, $lvl, $page, $sect, $flags);
308            return $ins;
309        }
310    }
311
312    /**
313     * Converts instructions of the included page
314     *
315     * The funcion iterates over the given list of instructions and generates
316     * an index of header and section indicies. It also removes document
317     * start/end instructions, converts links, and removes unwanted
318     * instructions like tags, comments, linkbacks.
319     *
320     * Later all header/section levels are convertet to match the current
321     * inclusion level.
322     *
323     * @author Michael Klier <chi@chimeric.de>
324     */
325    function _convert_instructions(&$ins, $lvl, $page, $sect, $flags) {
326
327        // filter instructions if needed
328        if(!empty($sect)) {
329            $this->_get_section($ins, $sect);   // section required
330        }
331
332        if($flags['firstsec']) {
333            $this->_get_firstsec($ins, $page);  // only first section
334        }
335
336        $ns  = getNS($page);
337        $num = count($ins);
338
339        $conv_idx = array(); // conversion index
340        $lvl_max  = false;   // max level
341        $first_header = -1;
342        $no_header  = false;
343        $sect_title = false;
344
345        for($i=0; $i<$num; $i++) {
346            switch($ins[$i][0]) {
347                case 'document_start':
348                case 'document_end':
349                case 'section_edit':
350                    unset($ins[$i]);
351                    break;
352                case 'header':
353                    // get section title of first section
354                    if($sect && !$sect_title) {
355                        $sect_title = $ins[$i][1][0];
356                    }
357                    // check if we need to skip the first header
358                    if((!$no_header) && $flags['noheader']) {
359                        $no_header = true;
360                    }
361
362                    $conv_idx[] = $i;
363                    // get index of first header
364                    if($first_header == -1) $first_header = $i;
365                    // get max level of this instructions set
366                    if(!$lvl_max || ($ins[$i][1][1] < $lvl_max)) {
367                        $lvl_max = $ins[$i][1][1];
368                    }
369                    break;
370                case 'section_open':
371                    $conv_idx[] = $i;
372                    break;
373                case 'internallink':
374                case 'internalmedia':
375                    if($ins[$i][1][0]{0} == '.') {
376                        if($ins[$i][1][0]{1} == '.') {
377                            $ins[$i][1][0] = getNS($ns) . ':' . substr($ins[$i][1][0], 2); // parent namespace
378                        } else {
379                            $ins[$i][1][0] = $ns . ':' . substr($ins[$i][1][0], 1); // current namespace
380                        }
381                    } elseif (strpos($ins[$i][1][0], ':') === false) {
382                        $ins[$i][1][0] = $ns . ':' . $ins[$i][1][0]; // relative links
383                    }
384                    break;
385                case 'plugin':
386                    // FIXME skip other plugins?
387                    switch($ins[$i][1][0]) {
388                        case 'tag_tag':                 // skip tags
389                        case 'discussion_comments':     // skip comments
390                        case 'linkback':                // skip linkbacks
391                        case 'data_entry':              // skip data plugin
392                        case 'meta':                    // skip meta plugin
393                            unset($ins[$i]);
394                            break;
395                    }
396                    break;
397                default:
398                    break;
399            }
400        }
401
402        // calculate difference between header/section level and include level
403        $diff = 0;
404        if (!isset($lvl_max)) $lvl_max = 0; // if no level found in target, set to 0
405        $diff = $lvl - $lvl_max + 1;
406        if ($no_header) $diff -= 1;  // push up one level if "noheader"
407
408        // convert headers and set footer/permalink
409        $hdr_deleted   = false;
410        $has_permalink = false;
411        $footer_lvl    = false;
412        foreach($conv_idx as $idx) {
413            if($ins[$idx][0] == 'header') {
414                if($no_header && !$hdr_deleted) {
415                    unset ($ins[$idx]);
416                    $hdr_deleted = true;
417                    continue;
418                }
419
420                if($flags['indent']) {
421                    $lvl_new = (($ins[$idx][1][1] + $diff) > 5) ? 5 : ($ins[$idx][1][1] + $diff);
422                    $ins[$idx][1][1] = $lvl_new;
423                }
424
425                // set permalink
426                if($flags['link'] && !$has_permalink && ($idx == $first_header)) {
427                    $this->_permalink($ins[$idx], $page, $sect, $flags);
428                    $has_permalink = true;
429                }
430
431                // set footer level
432                if(!$footer_lvl && ($idx == $first_header) && !$no_header) {
433                    if($flags['indent']) {
434                        $footer_lvl = $lvl_new;
435                    } else {
436                        $footer_lvl = $lvl_max;
437                    }
438                }
439            } else {
440                // it's a section
441                if($flags['indent']) {
442                    $lvl_new = (($ins[$idx][1][0] + $diff) > 5) ? 5 : ($ins[$idx][1][0] + $diff);
443                    $ins[$idx][1][0] = $lvl_new;
444                }
445
446                // check if noheader is used and set the footer level to the first section
447                if($no_header && !$footer_lvl) {
448                    if($flags['indent']) {
449                        $footer_lvl = $lvl_new;
450                    } else {
451                        $footer_lvl = $lvl_max;
452                    }
453                }
454            }
455        }
456
457        // add edit button
458        if($flags['editbtn'] && (auth_quickaclcheck($page) >= AUTH_EDIT)) {
459            $this->_editbtn($ins, $page, $sect, $sect_title);
460        }
461
462        // add footer
463        if($flags['footer']) {
464            $ins[] = $this->_footer($page, $sect, $sect_title, $flags, $footer_lvl);
465        }
466
467        // add instructions entry divs
468        array_unshift($ins, array('plugin', array('include_div', array('open', $page))));
469        array_push($ins, array('plugin', array('include_div', array('close'))));
470
471        // close previous section if any and re-open after inclusion
472        if($lvl != 0 && $this->sec_close) {
473            array_unshift($ins, array('section_close', array()));
474            $ins[] = array('section_open', array($lvl));
475        }
476    }
477
478    /**
479     * Creates include instructions for the namespace/tagtopic modes
480     *
481     * @author Michael Klier <chi@chimeric.de>
482     */
483    function _append_includeins(&$ins, $id, $flags) {
484        if(auth_quickaclcheck($id) >= AUTH_READ) {
485            array_push($this->hasparts, $id);
486            $ins_tmp[0]       = 'plugin';
487            $ins_tmp[1][0]    = 'include_include';
488            $ins_tmp[1][1][0] = 'page';
489            $ins_tmp[1][1][1] = $id;
490            $ins_tmp[1][1][2] = '';
491            $ins_tmp[1][1][3] = $flags;
492            $ins = array_merge($ins, array($ins_tmp));
493        }
494    }
495
496    /**
497     * Appends instruction item for the include plugin footer
498     *
499     * @author Michael Klier <chi@chimeric.de>
500     */
501    function _footer($page, $sect, $sect_title, $flags, $footer_lvl) {
502        $footer = array();
503        $footer[0] = 'plugin';
504        $footer[1] = array('include_footer', array($page, $sect, $sect_title, $flags, $this->toplevel_id, $footer_lvl));
505        return $footer;
506    }
507
508    /**
509     * Appends instruction item for an edit button
510     *
511     * @author Michael Klier <chi@chimeric.de>
512     */
513    function _editbtn(&$ins, $page, $sect, $sect_title) {
514        $editbtn = array();
515        $editbtn[0] = 'plugin';
516        $editbtn[1] = array('include_editbtn', array($page, $sect, $sect_title, $this->toplevel_id));
517        $ins[] = $editbtn;
518    }
519
520    /**
521     * Convert instruction item for a permalink header
522     *
523     * @author Michael Klier <chi@chimeric.de>
524     */
525    function _permalink(&$ins, $page, $sect, $flags) {
526        $ins[0] = 'plugin';
527        $ins[1] = array('include_header', array($ins[1][0], $ins[1][1], $page, $sect, $flags));
528    }
529
530    /**
531     * Get a section including its subsections
532     *
533     * @author Michael Klier <chi@chimeric.de>
534     */
535    function _get_section(&$ins, $sect) {
536        $num = count($ins);
537        $offset = false;
538        $lvl    = false;
539        $end    = false;
540
541        for($i=0; $i<$num; $i++) {
542            if ($ins[$i][0] == 'header') {
543
544                // found the right header
545                if (cleanID($ins[$i][1][0]) == $sect) {
546                    $offset = $i;
547                    $lvl    = $ins[$i][1][1];
548                } elseif ($offset && $lvl && ($ins[$i][1][1] <= $lvl)) {
549                    $end = $i - $offset;
550                    break;
551                }
552            }
553        }
554        $offset = $offset ? $offset : 0;
555        $end = $end ? $end : ($num - 1);
556        if(is_array($ins)) {
557            $ins = array_slice($ins, $offset, $end);
558        }
559    }
560
561    /**
562     * Only display the first section of a page and a readmore link
563     *
564     * @author Michael Klier <chi@chimeric.de>
565     */
566    function _get_firstsec(&$ins, $page) {
567        $num = count($ins);
568        $first_sect = false;
569        for($i=0; $i<$num; $i++) {
570            if($ins[$i][0] == 'section_close') {
571                $first_sect = $i;
572            }
573            if(($first_sect) && ($ins[$i][0] == 'section_open')) {
574                $ins = array_slice($ins, 0, $first_sect);
575                $ins[] = array('p_open', array());
576                $ins[] = array('internallink', array($page, $this->getLang('readmore')));
577                $ins[] = array('p_close', array());
578                $ins[] = array('section_close', array());
579                return;
580            }
581        }
582    }
583
584    /**
585     * Makes user or date dependent includes possible
586     */
587    function _apply_macro($id) {
588        global $INFO;
589        global $auth;
590
591        // if we don't have an auth object, do nothing
592        if (!$auth) return $id;
593
594        $user     = $_SERVER['REMOTE_USER'];
595        $group    = $INFO['userinfo']['grps'][0];
596
597        $replace = array(
598                '@USER@'  => cleanID($user),
599                '@NAME@'  => cleanID($INFO['userinfo']['name']),
600                '@GROUP@' => cleanID($group),
601                '@YEAR@'  => date('Y'),
602                '@MONTH@' => date('m'),
603                '@DAY@'   => date('d'),
604                );
605        return str_replace(array_keys($replace), array_values($replace), $id);
606    }
607}
608//vim:ts=4:sw=4:et:enc=utf-8:
609