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