xref: /plugin/include/helper.php (revision ffe98079c525975ac66d89e29437bf5d77e70cb7) 
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                    $perm = auth_quickaclcheck($page);
235
236                    array_push($this->hasparts, $page);
237                    if($perm < AUTH_READ) continue;
238
239                    $sect  = $ins[$i][1][1][2];
240                    $flags = $ins[$i][1][1][3];
241
242                    resolve_pageid(getNS($scope), $page, $exists); // resolve shortcuts
243                    $ins[$i][1][1][4] = $scope;
244                    $scope = $page;
245                    $flags = $this->get_flags($flags);
246
247                    if(!page_exists($page)) {
248                        if($flags['footer']) {
249                            $ins[$i] = $this->_footer($page, $sect, '', $flags, 0);
250                        } else {
251                            unset($ins[$i]);
252                        }
253                    } else {
254                        $ins_inc = $this->_get_instructions($page, $sect, $mode, $lvl, $flags);
255                        if(!empty($ins_inc)) {
256                            // combine instructions and reset counter
257                            $ins_start = array_slice($ins, 0, $i+1);
258                            $ins_end   = array_slice($ins, $i+1);
259                            $range = $i + count($ins_inc);
260                            $ins = array_merge($ins_start, $ins_inc, $ins_end);
261                            $num = count($ins);
262                        }
263                    }
264                }
265            }
266
267            // check if we left the range of possible sub includes and reset lvl and scope to toplevel_id
268            if($range && ($i >= $range)) {
269                $lvl = ($prev_lvl == 0) ? 0 : $prev_lvl;
270                $range    = false;
271                // reset scope to toplevel_id
272                $scope = $this->toplevel_id;
273            }
274        }
275
276        if(!empty($INFO['userinfo'])) {
277            $include_key = $INFO['userinfo']['name'] . '|' . implode('|', $INFO['userinfo']['grps']);
278        } else {
279            $include_key = '@ALL';
280        }
281
282        // handle meta data
283        $meta = array();
284        $meta = p_get_metadata($id, 'plugin_include');
285        $meta['pages'] = array_unique($this->hasparts);
286        $meta['keys'][$include_key] = true;
287        $ins_meta    = array();
288        $ins_meta[0] = 'plugin';
289        $ins_meta[1] = array('include_meta', array($meta));
290        array_push($ins, $ins_meta);
291    }
292
293    /**
294     * Returns the converted instructions of a give page/section
295     *
296     * @author Michael Klier <chi@chimeric.de>
297     */
298    function _get_instructions($page, $sect, $mode, $lvl, $flags) {
299        $key = ($sect) ? $page . '#' . $sect : $page;
300
301        // prevent recursion
302        if(!$this->includes[$key]) {
303            $ins = p_cached_instructions(wikiFN($page));
304            $this->includes[$key] = true;
305            $this->_convert_instructions($ins, $lvl, $page, $sect, $flags);
306            return $ins;
307        }
308    }
309
310    /**
311     * Converts instructions of the included page
312     *
313     * The funcion iterates over the given list of instructions and generates
314     * an index of header and section indicies. It also removes document
315     * start/end instructions, converts links, and removes unwanted
316     * instructions like tags, comments, linkbacks.
317     *
318     * Later all header/section levels are convertet to match the current
319     * inclusion level.
320     *
321     * @author Michael Klier <chi@chimeric.de>
322     */
323    function _convert_instructions(&$ins, $lvl, $page, $sect, $flags) {
324
325        // filter instructions if needed
326        if(!empty($sect)) {
327            $this->_get_section($ins, $sect);   // section required
328        }
329
330        if($flags['firstsec']) {
331            $this->_get_firstsec($ins, $page);  // only first section
332        }
333
334        $ns  = getNS($page);
335        $num = count($ins);
336
337        $conv_idx = array(); // conversion index
338        $lvl_max  = false;   // max level
339        $first_header = -1;
340        $no_header  = false;
341        $sect_title = false;
342
343        for($i=0; $i<$num; $i++) {
344            switch($ins[$i][0]) {
345                case 'document_start':
346                case 'document_end':
347                case 'section_edit':
348                    unset($ins[$i]);
349                    break;
350                case 'header':
351                    // get section title of first section
352                    if($sect && !$sect_title) {
353                        $sect_title = $ins[$i][1][0];
354                    }
355                    // check if we need to skip the first header
356                    if((!$no_header) && $flags['noheader']) {
357                        $no_header = true;
358                    }
359
360                    $conv_idx[] = $i;
361                    // get index of first header
362                    if($first_header == -1) $first_header = $i;
363                    // get max level of this instructions set
364                    if(!$lvl_max || ($ins[$i][1][1] < $lvl_max)) {
365                        $lvl_max = $ins[$i][1][1];
366                    }
367                    break;
368                case 'section_open':
369                    $conv_idx[] = $i;
370                    break;
371                case 'internallink':
372                case 'internalmedia':
373                    if($ins[$i][1][0]{0} == '.') {
374                        if($ins[$i][1][0]{1} == '.') {
375                            $ins[$i][1][0] = getNS($ns) . ':' . substr($ins[$i][1][0], 2); // parent namespace
376                        } else {
377                            $ins[$i][1][0] = $ns . ':' . substr($ins[$i][1][0], 1); // current namespace
378                        }
379                    } elseif (strpos($ins[$i][1][0], ':') === false) {
380                        $ins[$i][1][0] = $ns . ':' . $ins[$i][1][0]; // relative links
381                    }
382                    break;
383                case 'plugin':
384                    // FIXME skip other plugins?
385                    switch($ins[$i][1][0]) {
386                        case 'tag_tag':                 // skip tags
387                        case 'discussion_comments':     // skip comments
388                        case 'linkback':                // skip linkbacks
389                        case 'data_entry':              // skip data plugin
390                        case 'meta':                    // skip meta plugin
391                            unset($ins[$i]);
392                            break;
393                    }
394                    break;
395                default:
396                    break;
397            }
398        }
399
400        // calculate difference between header/section level and include level
401        $diff = 0;
402        if (!isset($lvl_max)) $lvl_max = 0; // if no level found in target, set to 0
403        $diff = $lvl - $lvl_max + 1;
404        if ($no_header) $diff -= 1;  // push up one level if "noheader"
405
406        // convert headers and set footer/permalink
407        $hdr_deleted   = false;
408        $has_permalink = false;
409        $footer_lvl    = false;
410        foreach($conv_idx as $idx) {
411            if($ins[$idx][0] == 'header') {
412                if($no_header && !$hdr_deleted) {
413                    unset ($ins[$idx]);
414                    $hdr_deleted = true;
415                    continue;
416                }
417
418                if($flags['indent']) {
419                    $lvl_new = (($ins[$idx][1][1] + $diff) > 5) ? 5 : ($ins[$idx][1][1] + $diff);
420                    $ins[$idx][1][1] = $lvl_new;
421                }
422
423                // set permalink
424                if($flags['link'] && !$has_permalink && ($idx == $first_header)) {
425                    $this->_permalink($ins[$idx], $page, $sect, $flags);
426                    $has_permalink = true;
427                }
428
429                // set footer level
430                if(!$footer_lvl && ($idx == $first_header) && !$no_header) {
431                    if($flags['indent']) {
432                        $footer_lvl = $lvl_new;
433                    } else {
434                        $footer_lvl = $lvl_max;
435                    }
436                }
437            } else {
438                // it's a section
439                if($flags['indent']) {
440                    $lvl_new = (($ins[$idx][1][0] + $diff) > 5) ? 5 : ($ins[$idx][1][0] + $diff);
441                    $ins[$idx][1][0] = $lvl_new;
442                }
443
444                // check if noheader is used and set the footer level to the first section
445                if($no_header && !$footer_lvl) {
446                    if($flags['indent']) {
447                        $footer_lvl = $lvl_new;
448                    } else {
449                        $footer_lvl = $lvl_max;
450                    }
451                }
452            }
453        }
454
455        // add edit button
456        if($flags['editbtn'] && (auth_quickaclcheck($page) >= AUTH_EDIT)) {
457            $this->_editbtn($ins, $page, $sect, $sect_title);
458        }
459
460        // add footer
461        if($flags['footer']) {
462            $ins[] = $this->_footer($page, $sect, $sect_title, $flags, $footer_lvl);
463        }
464
465        // add instructions entry divs
466        array_unshift($ins, array('plugin', array('include_div', array('open', $page))));
467        array_push($ins, array('plugin', array('include_div', array('close'))));
468
469        // close previous section if any and re-open after inclusion
470        if($lvl != 0 && $this->sec_close) {
471            array_unshift($ins, array('section_close', array()));
472            $ins[] = array('section_open', array($lvl));
473        }
474    }
475
476    /**
477     * Creates include instructions for the namespace/tagtopic modes
478     *
479     * @author Michael Klier <chi@chimeric.de>
480     */
481    function _append_includeins(&$ins, $id, $flags) {
482        if(auth_quickaclcheck($id) >= AUTH_READ) {
483            array_push($this->hasparts, $id);
484            $ins_tmp[0]       = 'plugin';
485            $ins_tmp[1][0]    = 'include_include';
486            $ins_tmp[1][1][0] = 'page';
487            $ins_tmp[1][1][1] = $id;
488            $ins_tmp[1][1][2] = '';
489            $ins_tmp[1][1][3] = $flags;
490            $ins = array_merge($ins, array($ins_tmp));
491        }
492    }
493
494    /**
495     * Appends instruction item for the include plugin footer
496     *
497     * @author Michael Klier <chi@chimeric.de>
498     */
499    function _footer($page, $sect, $sect_title, $flags, $footer_lvl) {
500        $footer = array();
501        $footer[0] = 'plugin';
502        $footer[1] = array('include_footer', array($page, $sect, $sect_title, $flags, $this->toplevel_id, $footer_lvl));
503        return $footer;
504    }
505
506    /**
507     * Appends instruction item for an edit button
508     *
509     * @author Michael Klier <chi@chimeric.de>
510     */
511    function _editbtn(&$ins, $page, $sect, $sect_title) {
512        $editbtn = array();
513        $editbtn[0] = 'plugin';
514        $editbtn[1] = array('include_editbtn', array($page, $sect, $sect_title, $this->toplevel_id));
515        $ins[] = $editbtn;
516    }
517
518    /**
519     * Convert instruction item for a permalink header
520     *
521     * @author Michael Klier <chi@chimeric.de>
522     */
523    function _permalink(&$ins, $page, $sect, $flags) {
524        $ins[0] = 'plugin';
525        $ins[1] = array('include_header', array($ins[1][0], $ins[1][1], $page, $sect, $flags));
526    }
527
528    /**
529     * Get a section including its subsections
530     *
531     * @author Michael Klier <chi@chimeric.de>
532     */
533    function _get_section(&$ins, $sect) {
534        $num = count($ins);
535        $offset = false;
536        $lvl    = false;
537        $end    = false;
538
539        for($i=0; $i<$num; $i++) {
540            if ($ins[$i][0] == 'header') {
541
542                // found the right header
543                if (cleanID($ins[$i][1][0]) == $sect) {
544                    $offset = $i;
545                    $lvl    = $ins[$i][1][1];
546                } elseif ($offset && $lvl && ($ins[$i][1][1] <= $lvl)) {
547                    $end = $i - $offset;
548                    break;
549                }
550            }
551        }
552        $offset = $offset ? $offset : 0;
553        $end = $end ? $end : ($num - 1);
554        if(is_array($ins)) {
555            $ins = array_slice($ins, $offset, $end);
556        }
557    }
558
559    /**
560     * Only display the first section of a page and a readmore link
561     *
562     * @author Michael Klier <chi@chimeric.de>
563     */
564    function _get_firstsec(&$ins, $page) {
565        $num = count($ins);
566        $first_sect = false;
567        for($i=0; $i<$num; $i++) {
568            if($ins[$i][0] == 'section_close') {
569                $first_sect = $i;
570            }
571            if(($first_sect) && ($ins[$i][0] == 'section_open')) {
572                $ins = array_slice($ins, 0, $first_sect);
573                $ins[] = array('p_open', array());
574                $ins[] = array('internallink', array($page, $this->getLang('readmore')));
575                $ins[] = array('p_close', array());
576                $ins[] = array('section_close', array());
577                return;
578            }
579        }
580    }
581
582    /**
583     * Makes user or date dependent includes possible
584     */
585    function _apply_macro($id) {
586        global $INFO;
587        global $auth;
588
589        // if we don't have an auth object, do nothing
590        if (!$auth) return $id;
591
592        $user     = $_SERVER['REMOTE_USER'];
593        $group    = $INFO['userinfo']['grps'][0];
594
595        $replace = array(
596                '@USER@'  => cleanID($user),
597                '@NAME@'  => cleanID($INFO['userinfo']['name']),
598                '@GROUP@' => cleanID($group),
599                '@YEAR@'  => date('Y'),
600                '@MONTH@' => date('m'),
601                '@DAY@'   => date('d'),
602                );
603        return str_replace(array_keys($replace), array_values($replace), $id);
604    }
605}
606//vim:ts=4:sw=4:et:enc=utf-8:
607