xref: /plugin/include/helper.php (revision ee335396ec7ab2f4d4f5e337a7b96e82be02fa6a) 
1<?php
2/**
3 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
4 * @author     Esther Brunner <wikidesign@gmail.com>
5 */
6
7// must be run within Dokuwiki
8if (!defined('DOKU_INC')) die();
9
10if (!defined('DOKU_LF')) define('DOKU_LF', "\n");
11if (!defined('DOKU_TAB')) define('DOKU_TAB', "\t");
12if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC.'lib/plugins/');
13
14class helper_plugin_include extends DokuWiki_Plugin { // DokuWiki_Helper_Plugin
15
16  var $pages     = array();   // filechain of included pages
17  var $page      = array();   // associative array with data about the page to include
18  var $ins       = array();   // instructions array
19  var $doc       = '';        // the final output XHTML string
20  var $mode      = 'section'; // inclusion mode: 'page' or 'section'
21  var $clevel    = 0;         // current section level
22  var $firstsec  = 0;         // show first section only
23  var $editbtn   = 1;         // show edit button
24  var $footer    = 1;         // show metaline below page
25  var $noheader  = 0;         // omit header
26  var $header    = array();   // included page / section header
27  var $renderer  = NULL;      // DokuWiki renderer object
28
29  // private variables
30  var $_offset   = NULL;
31
32  /**
33   * Constructor loads some config settings
34   */
35  function helper_plugin_include(){
36    $this->firstsec = $this->getConf('firstseconly');
37    $this->editbtn  = $this->getConf('showeditbtn');
38    $this->footer   = $this->getConf('showfooter');
39    $this->noheader = 0;
40    $this->header   = array();
41  }
42
43  function getInfo(){
44    return array(
45      'author' => 'Esther Brunner',
46      'email'  => 'wikidesign@gmail.com',
47      'date'   => '2007-08-22',
48      'name'   => 'Include Plugin (helper class)',
49      'desc'   => 'Functions to include another page in a wiki page',
50      'url'    => 'http://www.wikidesign/en/plugin/include/start',
51    );
52  }
53
54  function getMethods(){
55    $result = array();
56    $result[] = array(
57      'name'   => 'setPage',
58      'desc'   => 'sets the page to include',
59      'params' => array("page attributes, 'id' required, 'section' for filtering" => 'array'),
60      'return' => array('success' => 'boolean'),
61    );
62    $result[] = array(
63      'name'   => 'setMode',
64      'desc'   => 'sets inclusion mode: should indention be merged?',
65      'params' => array("'page' (original) or 'section' (merged indention)" => 'string'),
66    );
67    $result[] = array(
68      'name'   => 'setLevel',
69      'desc'   => 'sets the indention for the current section level',
70      'params' => array('level: 0 to 5' => 'integer'),
71      'return' => array('success' => 'boolean'),
72    );
73    $result[] = array(
74      'name'   => 'setFlags',
75      'desc'   => 'overrides standard values for showfooter and firstseconly settings',
76      'params' => array('flags' => 'array'),
77    );
78    $result[] = array(
79      'name'   => 'renderXHTML',
80      'desc'   => 'renders the XHTML output of the included page',
81      'params' => array('DokuWiki renderer' => 'object'),
82      'return' => array('XHTML' => 'string'),
83    );
84    return $result;
85  }
86
87  /**
88   * Sets the page to include if it is not already included (prevent recursion)
89   * and the current user is allowed to read it
90   */
91  function setPage($page){
92    global $ID;
93
94    $id     = $page['id'];
95    $fullid = $id.'#'.$page['section'];
96
97    if (!$id) return false;       // no page id given
98    if ($id == $ID) return false; // page can't include itself
99
100    // prevent include recursion
101    if ((isset($this->pages[$id.'#'])) || (isset($this->pages[$fullid]))) return false;
102
103    // we need to make sure 'perm', 'file' and 'exists' are set
104    if (!isset($page['perm'])) $page['perm'] = auth_quickaclcheck($page['id']);
105    if (!isset($page['file'])) $page['file'] = wikiFN($page['id']);
106    if (!isset($page['exists'])) $page['exists'] = @file_exists($page['file']);
107
108    // check permission
109    if ($page['perm'] < AUTH_READ) return false;
110
111    // add the page to the filechain
112    $this->pages[$fullid] = $page;
113    $this->page =& $this->pages[$fullid];
114    return true;
115  }
116
117  /**
118   * Sets the inclusion mode: 'page' or 'section'
119   */
120  function setMode($mode){
121    $this->mode = $mode;
122  }
123
124  /**
125   * Sets the right indention for a given section level
126   */
127  function setLevel($level){
128    if ((is_numeric($level)) && ($level >= 0) && ($level <= 5)){
129      $this->clevel = $level;
130      return true;
131    }
132    return false;
133  }
134
135  /**
136   * Overrides standard values for showfooter and firstseconly settings
137   */
138  function setFlags($flags){
139    foreach ($flags as $flag){
140      switch ($flag){
141      case 'footer':
142        $this->footer = 1;
143        break;
144      case 'nofooter':
145        $this->footer = 0;
146        break;
147      case 'firstseconly':
148      case 'firstsectiononly':
149        $this->firstsec = 1;
150        break;
151      case 'fullpage':
152        $this->firstsec = 0;
153        break;
154      case 'noheader':
155        $this->noheader = 1;
156        break;
157      case 'editbtn':
158      case 'editbutton':
159        $this->editbtn = 1;
160        break;
161      case 'noeditbtn':
162      case 'noeditbutton':
163        $this->editbtn = 0;
164        break;
165      }
166    }
167  }
168
169  /**
170   * Builds the XHTML to embed the page to include
171   */
172  function renderXHTML(&$renderer){
173    global $ID;
174
175    if (!$this->page['id']) return ''; // page must be set first
176    if (!$this->page['exists'] && ($this->page['perm'] < AUTH_CREATE)) return '';
177
178    // prepare variables
179    $this->doc      = '';
180    $this->renderer =& $renderer;
181
182    // get instructions and render them on the fly
183    $this->ins = p_cached_instructions($this->page['file']);
184
185    // show only a given section?
186    if ($this->page['section'] && $this->page['exists']) $this->_getSection();
187
188    // convert relative links
189    $this->_convertInstructions();
190
191    // render the included page
192    $backupID = $ID;               // store the current ID
193    $ID       = $this->page['id']; // change ID to the included page
194    $content = '<div class="entry-content">'.DOKU_LF.
195      $this->_cleanXHTML(p_render('xhtml', $this->ins, $info)).DOKU_LF.
196      '</div>'.DOKU_LF;
197    $ID = $backupID;               // restore ID
198
199    // embed the included page
200    $class = ($this->page['draft'] ? 'include draft' : 'include');
201    $this->doc .= '<div class="'.$class.' hentry"'.$this->_showTagLogos().'>'.DOKU_LF;
202    if (!$this->header && $this->clevel && ($this->mode == 'section'))
203      $this->doc .= '<div class="level'.$this->clevel.'">'.DOKU_LF;
204    if ((@file_exists(DOKU_PLUGIN.'editsections/action.php'))
205      && (!plugin_isdisabled('editsections'))){ // for Edit Section Reorganizer Plugin
206      $this->doc .= $this->_editButton().$content;
207    } else {
208      $this->doc .= $content.$this->_editButton();
209    }
210
211    // output meta line (if wanted) and remove page from filechain
212    $this->doc .= $this->_footer(array_pop($this->pages));
213
214    if (!$this->header && $this->clevel && ($this->mode == 'section'))
215      $this->doc .= '</div>'.DOKU_LF; // class="level?"
216    $this->doc .= '</div>'.DOKU_LF; // class="include hentry"
217
218    // reset defaults
219    $this->helper_plugin_include();
220
221    // return XHTML
222    $renderer->doc .= $this->doc;
223    return $this->doc;
224  }
225
226/* ---------- Private Methods ---------- */
227
228  /**
229   * Get a section including its subsections
230   */
231  function _getSection(){
232    foreach ($this->ins as $ins){
233      if ($ins[0] == 'header'){
234
235        // found the right header
236        if (cleanID($ins[1][0]) == $this->page['section']){
237          $level = $ins[1][1];
238          $i[] = $ins;
239
240        // next header of the same or higher level -> exit
241        } elseif ($ins[1][1] <= $level){
242          $this->ins = $i;
243          return true;
244        } elseif (isset($level)){
245          $i[] = $ins;
246        }
247
248      // add instructions from our section
249      } elseif (isset($level)){
250        $i[] = $ins;
251      }
252    }
253    $this->ins = $i;
254    return true;
255  }
256
257  /**
258   * Corrects relative internal links and media and
259   * converts headers of included pages to subheaders of the current page
260   */
261  function _convertInstructions(){
262    global $ID;
263
264    if (!$this->page['exists']) return false;
265
266    // check if included page is in same namespace
267    $ns      = getNS($this->page['id']);
268    $convert = (getNS($ID) == $ns ? false : true);
269
270    $n = count($this->ins);
271    for ($i = 0; $i < $n; $i++){
272      $current = $this->ins[$i][0];
273
274      // convert internal links and media from relative to absolute
275      if ($convert && (substr($current, 0, 8) == 'internal')){
276        $this->ins[$i][1][0] = $this->_convertInternalLink($this->ins[$i][1][0], $ns);
277
278      // set header level to current section level + header level
279      } elseif ($current == 'header'){
280        $this->_convertHeader($i);
281
282      // the same for sections
283      } elseif (($current == 'section_open') && ($this->mode == 'section')){
284        $this->ins[$i][1][0] = $this->_convertSectionLevel($this->ins[$i][1][0]);
285
286      // show only the first section?
287      } elseif ($this->firstsec && ($current == 'section_close')
288        && ($this->ins[$i-1][0] != 'section_open')){
289        $this->_readMore($i);
290        return true;
291      }
292    }
293    $this->_finishConvert();
294    return true;
295  }
296
297  /**
298   * Convert relative internal links and media
299   *
300   * @param    integer $i: counter for current instruction
301   * @param    string  $ns: namespace of included page
302   * @return   string  $link: converted, now absolute link
303   */
304  function _convertInternalLink($link, $ns){
305
306    // relative subnamespace
307    if ($link{0} == '.'){
308      if ($link{1} == '.') return getNS($ns).':'.substr($link, 2); // parent namespace
309      else return $ns.':'.substr($link, 1);                        // current namespace
310
311    // relative link
312    } elseif (strpos($link, ':') === false){
313      return $ns.':'.$link;
314
315    // absolute link - don't change
316    } else {
317      return $link;
318    }
319  }
320
321  /**
322   * Convert header level and add header to TOC
323   *
324   * @param    integer $i: counter for current instruction
325   * @return   boolean true
326   */
327  function _convertHeader($i){
328    global $conf;
329
330    $text = $this->ins[$i][1][0];
331    $hid  = $this->renderer->_headerToLink($text, 'true');
332    if (empty($this->header)){
333      $this->_offset = $this->clevel - $this->ins[$i][1][1] + 1;
334      $level = $this->_convertSectionLevel(1);
335      $this->header = array('hid' => $hid, 'title' => hsc($text), 'level' => $level);
336      if ($this->noheader){
337        unset($this->ins[$i]);
338        return true;
339      }
340    } else {
341      $level = $this->_convertSectionLevel($this->ins[$i][1][1]);
342    }
343    if ($this->mode == 'section') $this->ins[$i][1][1] = $level;
344
345    // add TOC item
346    if (($level >= $conf['toptoclevel']) && ($level <= $conf['maxtoclevel'])){
347      $this->renderer->toc[] = array(
348        'hid'   => $hid,
349        'title' => $text,
350        'type'  => 'ul',
351        'level' => $level - $conf['toptoclevel'] + 1
352      );
353    }
354    return true;
355  }
356
357  /**
358   * Convert the level of headers and sections
359   *
360   * @param    integer $in: current level
361   * @return   integer $out: converted level
362   */
363  function _convertSectionLevel($in){
364    $out = $in + $this->_offset;
365    if ($out >= 5) return 5;
366    if ($out <= $this->clevel + 1) return $this->clevel + 1;
367    return $out;
368  }
369
370  /**
371   * Adds a read more... link at the bottom of the first section
372   *
373   * @param    integer $i: counter for current instruction
374   * @return   boolean true
375   */
376  function _readMore($i){
377    $more = ((is_array($this->ins[$i+1])) && ($this->ins[$i+1][0] != 'document_end'));
378
379    if ($this->ins[0][0] == 'document_start') $this->ins = array_slice($this->ins, 1, $i);
380    else $this->ins = array_slice($this->ins, 0, $i);
381
382    if ($more){
383      array_unshift($this->ins, array('document_start', array(), 0));
384      $last = array_pop($this->ins);
385      $this->ins[] = array('p_open', array(), $last[2]);
386      $this->ins[] = array('internallink',array($this->page['id'], $this->getLang('readmore')),$last[2]);
387      $this->ins[] = array('p_close', array(), $last[2]);
388      $this->ins[] = $last;
389      $this->ins[] = array('document_end', array(), $last[2]);
390    } else {
391      $this->_finishConvert();
392    }
393    return true;
394  }
395
396  /**
397   * Adds 'document_start' and 'document_end' instructions if not already there
398   */
399  function _finishConvert(){
400    if ($this->ins[0][0] != 'document_start')
401      array_unshift($this->ins, array('document_start', array(), 0));
402    $c = count($this->ins) - 1;
403    if ($this->ins[$c][0] != 'document_end')
404      $this->ins[] = array('document_end', array(), 0);
405  }
406
407  /**
408   * Remove TOC, section edit buttons and tags
409   */
410  function _cleanXHTML($xhtml){
411    $replace = array(
412      '!<div class="toc">.*?(</div>\n</div>)!s'   => '', // remove toc
413      '#<!-- SECTION "(.*?)" \[(\d+-\d*)\] -->#e' => '', // remove section edit buttons
414      '!<div class="tags">.*?(</div>)!s'          => '', // remove category tags
415    );
416    if ($this->clevel)
417      $replace['#<div class="footnotes">#s'] = '<div class="footnotes level'.$this->clevel.'">';
418    $xhtml  = preg_replace(array_keys($replace), array_values($replace), $xhtml);
419    return $xhtml;
420  }
421
422  /**
423   * Optionally display logo for the first tag found in the included page
424   */
425  function _showTagLogos(){
426    if ((!$this->getConf('showtaglogos'))
427      || (plugin_isdisabled('tag'))
428      || (!$taghelper =& plugin_load('helper', 'tag')))
429      return '';
430
431    $subject = p_get_metadata($this->page['id'], 'subject');
432    if (is_array($subject)) $tag = $subject[0];
433    else list($tag, $rest) = explode(' ', $subject, 2);
434    $title = str_replace('_', ' ', noNS($tag));
435    resolve_pageid($taghelper->namespace, $tag, $exists); // resolve shortcuts
436
437    $logosrc = mediaFN($logoID);
438    $types = array('.png', '.jpg', '.gif'); // auto-detect filetype
439    foreach ($types as $type){
440      if (!@file_exists($logosrc.$type)) continue;
441      $logoID   = $tag.$type;
442      $logosrc .= $type;
443      list($w, $h, $t, $a) = getimagesize($logosrc);
444      return ' style="min-height: '.$h.'px">'.
445        '<img class="mediaright" src="'.ml($logoID).'" alt="'.$title.'"/';
446    }
447    return '';
448  }
449
450  /**
451   * Display an edit button for the included page
452   */
453  function _editButton(){
454    if ($this->page['exists']){
455      if (($this->page['perm'] >= AUTH_EDIT) && (is_writable($this->page['file'])))
456        $action = 'edit';
457      else return '';
458    } elseif ($this->page['perm'] >= AUTH_CREATE){
459      $action = 'create';
460    }
461    if ($this->editbtn){
462      return '<div class="secedit">'.DOKU_LF.DOKU_TAB.
463        html_btn($action, $this->page['id'], '', array('do' => 'edit'), 'post').DOKU_LF.
464        '</div>'.DOKU_LF;
465    } else {
466      return '';
467    }
468  }
469
470  /**
471   * Returns the meta line below the included page
472   */
473  function _footer($page){
474    global $conf, $ID;
475
476    if (!$this->footer) return ''; // '<div class="inclmeta">&nbsp;</div>'.DOKU_LF;
477
478    $id   = $page['id'];
479    $meta = p_get_metadata($id);
480    $ret  = array();
481
482    // permalink
483    if ($this->getConf('showlink')){
484      $title = ($page['title'] ? $page['title'] : $meta['title']);
485      if (!$title) $title = str_replace('_', ' ', noNS($id));
486      $class = ($page['exists'] ? 'wikilink1' : 'wikilink2');
487      $link = array(
488        'url'    => wl($id),
489        'title'  => $id,
490        'name'   => hsc($title),
491        'target' => $conf['target']['wiki'],
492        'class'  => $class.' permalink',
493        'more'   => 'rel="bookmark"',
494      );
495      $ret[] = $this->renderer->_formatLink($link);
496    }
497
498    // date
499    if ($this->getConf('showdate')){
500      $date = ($page['date'] ? $page['date'] : $meta['date']['created']);
501      if ($date)
502        $ret[] = '<abbr class="published" title="'.strftime('%Y-%m-%dT%H:%M:%SZ', $date).'">'.
503        strftime($conf['dformat'], $date).
504        '</abbr>';
505    }
506
507    // author
508    if ($this->getConf('showuser')){
509      $author   = ($page['user'] ? $page['user'] : $meta['creator']);
510      if ($author){
511        $userpage = cleanID($this->getConf('usernamespace').':'.$author);
512        resolve_pageid(getNS($ID), $userpage, $exists);
513        $class = ($exists ? 'wikilink1' : 'wikilink2');
514        $link = array(
515          'url'    => wl($userpage),
516          'title'  => $userpage,
517          'name'   => hsc($author),
518          'target' => $conf['target']['wiki'],
519          'class'  => $class.' url fn',
520          'pre'    => '<span class="vcard author">',
521          'suf'    => '</span>',
522        );
523        $ret[]    = $this->renderer->_formatLink($link);
524      }
525    }
526
527    // comments - let Discussion Plugin do the work for us
528    if (!$page['section'] && $this->getConf('showcomments')
529      && (!plugin_isdisabled('discussion'))
530      && ($discussion =& plugin_load('helper', 'discussion'))){
531      $disc = $discussion->td($id);
532      if ($disc) $ret[] = '<span class="comment">'.$disc.'</span>';
533    }
534
535    // linkbacks - let Linkback Plugin do the work for us
536    if (!$page['section'] && $this->getConf('showlinkbacks')
537      && (!plugin_isdisabled('linkback'))
538      && ($linkback =& plugin_load('helper', 'linkback'))){
539      $link = $linkback->td($id);
540      if ($link) $ret[] = '<span class="linkback">'.$link.'</span>';
541    }
542
543    $ret = implode(DOKU_LF.DOKU_TAB.'&middot; ', $ret);
544
545    // tags - let Tag Plugin do the work for us
546    if (!$page['section'] && $this->getConf('showtags')
547      && (!plugin_isdisabled('tag'))
548      && ($tag =& plugin_load('helper', 'tag'))){
549      $page['tags'] = '<div class="tags"><span>'.DOKU_LF.
550        DOKU_TAB.$tag->td($id).DOKU_LF.
551        DOKU_TAB.'</span></div>'.DOKU_LF;
552      $ret = $page['tags'].DOKU_TAB.$ret;
553    }
554
555    if (!$ret) $ret = '&nbsp;';
556    $class = 'inclmeta';
557    if ($this->header && $this->clevel && ($this->mode == 'section'))
558      $class .= ' level'.$this->clevel;
559    return '<div class="'.$class.'">'.DOKU_LF.DOKU_TAB.$ret.DOKU_LF.'</div>'.DOKU_LF;
560  }
561
562}
563
564//Setup VIM: ex: et ts=4 enc=utf-8 :
565