xref: /dokuwiki/inc/template.php (revision ec8c92afc2539cfd92999e4765b805453b9aef21) 
1<?php
2/**
3 * DokuWiki template functions
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Andreas Gohr <andi@splitbrain.org>
7 */
8
9if(!defined('DOKU_INC')) die('meh.');
10
11/**
12 * Returns the path to the given template, uses
13 * default one if the custom version doesn't exist.
14 *
15 * @author Andreas Gohr <andi@splitbrain.org>
16 */
17function template($tpl){
18  global $conf;
19
20  if(@is_readable(DOKU_INC.'lib/tpl/'.$conf['template'].'/'.$tpl))
21    return DOKU_INC.'lib/tpl/'.$conf['template'].'/'.$tpl;
22
23  return DOKU_INC.'lib/tpl/default/'.$tpl;
24}
25
26/**
27 * Print the content
28 *
29 * This function is used for printing all the usual content
30 * (defined by the global $ACT var) by calling the appropriate
31 * outputfunction(s) from html.php
32 *
33 * Everything that doesn't use the main template file isn't
34 * handled by this function. ACL stuff is not done here either.
35 *
36 * @author Andreas Gohr <andi@splitbrain.org>
37 */
38function tpl_content($prependTOC=true) {
39    global $ACT;
40    global $INFO;
41    $INFO['prependTOC'] = $prependTOC;
42
43    ob_start();
44    trigger_event('TPL_ACT_RENDER',$ACT,'tpl_content_core');
45    $html_output = ob_get_clean();
46    trigger_event('TPL_CONTENT_DISPLAY',$html_output,'ptln');
47
48    return !empty($html_output);
49}
50
51function tpl_content_core(){
52  global $ACT;
53  global $TEXT;
54  global $PRE;
55  global $SUF;
56  global $SUM;
57  global $IDX;
58
59  switch($ACT){
60    case 'show':
61      html_show();
62      break;
63    case 'preview':
64      html_edit($TEXT);
65      html_show($TEXT);
66      break;
67    case 'recover':
68      html_edit($TEXT);
69      break;
70    case 'edit':
71      html_edit();
72      break;
73    case 'draft':
74      html_draft();
75      break;
76    case 'wordblock':
77      html_edit($TEXT,'wordblock');
78      break;
79    case 'search':
80      html_search();
81      break;
82    case 'revisions':
83      $first = is_numeric($_REQUEST['first']) ? intval($_REQUEST['first']) : 0;
84      html_revisions($first);
85      break;
86    case 'diff':
87      html_diff();
88      break;
89    case 'recent':
90      if (is_array($_REQUEST['first'])) {
91        $_REQUEST['first'] = array_keys($_REQUEST['first']);
92        $_REQUEST['first'] = $_REQUEST['first'][0];
93      }
94      $first = is_numeric($_REQUEST['first']) ? intval($_REQUEST['first']) : 0;
95      html_recent($first);
96      break;
97    case 'index':
98      html_index($IDX); #FIXME can this be pulled from globals? is it sanitized correctly?
99      break;
100    case 'backlink':
101      html_backlinks();
102      break;
103    case 'conflict':
104      html_conflict(con($PRE,$TEXT,$SUF),$SUM);
105      html_diff(con($PRE,$TEXT,$SUF),false);
106      break;
107    case 'locked':
108      html_locked();
109      html_edit();
110      break;
111    case 'login':
112      html_login();
113      break;
114    case 'register':
115      html_register();
116      break;
117    case 'resendpwd':
118      html_resendpwd();
119      break;
120    case 'denied':
121      print p_locale_xhtml('denied');
122      break;
123    case 'profile' :
124      html_updateprofile();
125      break;
126    case 'admin':
127      tpl_admin();
128      break;
129    default:
130      $evt = new Doku_Event('TPL_ACT_UNKNOWN',$ACT);
131      if ($evt->advise_before())
132        msg("Failed to handle command: ".hsc($ACT),-1);
133      $evt->advise_after();
134      unset($evt);
135      return false;
136  }
137  return true;
138}
139
140/**
141 * Places the TOC where the function is called
142 *
143 * If you use this you most probably want to call tpl_content with
144 * a false argument
145 *
146 * @author Andreas Gohr <andi@splitbrain.org>
147 */
148function tpl_toc($return=false){
149    global $TOC;
150    global $ACT;
151    global $ID;
152    global $REV;
153    global $INFO;
154    global $conf;
155    $toc = array();
156
157    if(is_array($TOC)){
158        // if a TOC was prepared in global scope, always use it
159        $toc = $TOC;
160    }elseif(($ACT == 'show' || substr($ACT,0,6) == 'export') && !$REV && $INFO['exists']){
161        // get TOC from metadata, render if neccessary
162        $meta = p_get_metadata($ID, false, true);
163        if(isset($meta['internal']['toc'])){
164            $tocok = $meta['internal']['toc'];
165        }else{
166            $tocok = true;
167        }
168        $toc   = $meta['description']['tableofcontents'];
169        if(!$tocok || !is_array($toc) || !$conf['tocminheads'] || count($toc) < $conf['tocminheads']){
170            $toc = array();
171        }
172    }elseif($ACT == 'admin'){
173        // try to load admin plugin TOC FIXME: duplicates code from tpl_admin
174        $plugin = null;
175        if (!empty($_REQUEST['page'])) {
176            $pluginlist = plugin_list('admin');
177            if (in_array($_REQUEST['page'], $pluginlist)) {
178                // attempt to load the plugin
179                $plugin =& plugin_load('admin',$_REQUEST['page']);
180            }
181        }
182        if ( ($plugin !== null) &&
183             (!$plugin->forAdminOnly() || $INFO['isadmin']) ){
184            $toc = $plugin->getTOC();
185            $TOC = $toc; // avoid later rebuild
186        }
187    }
188
189    trigger_event('TPL_TOC_RENDER', $toc, NULL, false);
190    $html = html_TOC($toc);
191    if($return) return $html;
192    echo $html;
193}
194
195/**
196 * Handle the admin page contents
197 *
198 * @author Andreas Gohr <andi@splitbrain.org>
199 */
200function tpl_admin(){
201    global $INFO;
202    global $TOC;
203
204    $plugin = null;
205    if (!empty($_REQUEST['page'])) {
206        $pluginlist = plugin_list('admin');
207
208        if (in_array($_REQUEST['page'], $pluginlist)) {
209
210          // attempt to load the plugin
211          $plugin =& plugin_load('admin',$_REQUEST['page']);
212        }
213    }
214
215    if ($plugin !== null){
216        if($plugin->forAdminOnly() && !$INFO['isadmin']){
217            msg('For admins only',-1);
218            html_admin();
219        }else{
220            if(!is_array($TOC)) $TOC = $plugin->getTOC(); //if TOC wasn't requested yet
221            if($INFO['prependTOC']) tpl_toc();
222            $plugin->html();
223        }
224    }else{
225        html_admin();
226    }
227    return true;
228}
229
230/**
231 * Print the correct HTML meta headers
232 *
233 * This has to go into the head section of your template.
234 *
235 * @triggers TPL_METAHEADER_OUTPUT
236 * @param  boolean $alt Should feeds and alternative format links be added?
237 * @author Andreas Gohr <andi@splitbrain.org>
238 */
239function tpl_metaheaders($alt=true){
240  global $ID;
241  global $REV;
242  global $INFO;
243  global $ACT;
244  global $QUERY;
245  global $lang;
246  global $conf;
247  $it=2;
248
249  // prepare the head array
250  $head = array();
251
252
253  // the usual stuff
254  $head['meta'][] = array( 'name'=>'generator', 'content'=>'DokuWiki '.getVersion() );
255  $head['link'][] = array( 'rel'=>'search', 'type'=>'application/opensearchdescription+xml',
256                           'href'=>DOKU_BASE.'lib/exe/opensearch.php', 'title'=>$conf['title'] );
257  $head['link'][] = array( 'rel'=>'start', 'href'=>DOKU_BASE );
258  if(actionOK('index')){
259    $head['link'][] = array( 'rel'=>'contents', 'href'=> wl($ID,'do=index',false,'&'),
260                           'title'=>$lang['btn_index'] );
261  }
262
263  if($alt){
264    $head['link'][] = array( 'rel'=>'alternate', 'type'=>'application/rss+xml',
265                             'title'=>'Recent Changes', 'href'=>DOKU_BASE.'feed.php');
266    $head['link'][] = array( 'rel'=>'alternate', 'type'=>'application/rss+xml',
267                             'title'=>'Current Namespace',
268                             'href'=>DOKU_BASE.'feed.php?mode=list&ns='.$INFO['namespace']);
269    if(($ACT == 'show' || $ACT == 'search') && $INFO['writable']){
270        $head['link'][] = array( 'rel'=>'edit',
271                                 'title'=>$lang['btn_edit'],
272                                 'href'=> wl($ID,'do=edit',false,'&'));
273    }
274
275    if($ACT == 'search'){
276      $head['link'][] = array( 'rel'=>'alternate', 'type'=>'application/rss+xml',
277                               'title'=>'Search Result',
278                               'href'=>DOKU_BASE.'feed.php?mode=search&q='.$QUERY);
279    }
280
281    if(actionOK('export_xhtml')){
282      $head['link'][] = array( 'rel'=>'alternate', 'type'=>'text/html', 'title'=>'Plain HTML',
283                               'href'=>exportlink($ID, 'xhtml', '', false, '&'));
284    }
285
286    if(actionOK('export_raw')){
287      $head['link'][] = array( 'rel'=>'alternate', 'type'=>'text/plain', 'title'=>'Wiki Markup',
288                               'href'=>exportlink($ID, 'raw', '', false, '&'));
289    }
290  }
291
292  // setup robot tags apropriate for different modes
293  if( ($ACT=='show' || $ACT=='export_xhtml') && !$REV){
294    if($INFO['exists']){
295      //delay indexing:
296      if((time() - $INFO['lastmod']) >= $conf['indexdelay']){
297        $head['meta'][] = array( 'name'=>'robots', 'content'=>'index,follow');
298      }else{
299        $head['meta'][] = array( 'name'=>'robots', 'content'=>'noindex,nofollow');
300      }
301      $head['link'][] = array( 'rel'=>'canonical', 'href'=>wl($ID,'',true,'&') );
302    }else{
303      $head['meta'][] = array( 'name'=>'robots', 'content'=>'noindex,follow');
304    }
305  }elseif(defined('DOKU_MEDIADETAIL')){
306    $head['meta'][] = array( 'name'=>'robots', 'content'=>'index,follow');
307  }else{
308    $head['meta'][] = array( 'name'=>'robots', 'content'=>'noindex,nofollow');
309  }
310
311  // set metadata
312  if($ACT == 'show' || $ACT=='export_xhtml'){
313    // date of modification
314    if($REV){
315      $head['meta'][] = array( 'name'=>'date', 'content'=>date('Y-m-d\TH:i:sO',$REV));
316    }else{
317      $head['meta'][] = array( 'name'=>'date', 'content'=>date('Y-m-d\TH:i:sO',$INFO['lastmod']));
318    }
319
320    // keywords (explicit or implicit)
321    if(!empty($INFO['meta']['subject'])){
322      $head['meta'][] = array( 'name'=>'keywords', 'content'=>join(',',$INFO['meta']['subject']));
323    }else{
324      $head['meta'][] = array( 'name'=>'keywords', 'content'=>str_replace(':',',',$ID));
325    }
326  }
327
328  // load stylesheets
329  $head['link'][] = array('rel'=>'stylesheet', 'media'=>'all', 'type'=>'text/css',
330                          'href'=>DOKU_BASE.'lib/exe/css.php?s=all&t='.$conf['template']);
331  $head['link'][] = array('rel'=>'stylesheet', 'media'=>'screen', 'type'=>'text/css',
332                          'href'=>DOKU_BASE.'lib/exe/css.php?t='.$conf['template']);
333  $head['link'][] = array('rel'=>'stylesheet', 'media'=>'print', 'type'=>'text/css',
334                          'href'=>DOKU_BASE.'lib/exe/css.php?s=print&t='.$conf['template']);
335
336  // load javascript
337  $js_edit  = ($ACT=='edit' || $ACT=='preview' || $ACT=='recover' || $ACT=='wordblock' ) ? 1 : 0;
338  $js_write = ($INFO['writable']) ? 1 : 0;
339  if(defined('DOKU_MEDIAMANAGER')){
340    $js_edit  = 1;
341    $js_write = 0;
342  }
343  if(($js_edit && $js_write) || defined('DOKU_MEDIAMANAGER')){
344    $script = "NS='".$INFO['namespace']."';";
345    if($conf['useacl'] && $_SERVER['REMOTE_USER']){
346      require_once(DOKU_INC.'inc/toolbar.php');
347      $script .= "SIG='".toolbar_signature()."';";
348    }
349    $head['script'][] = array( 'type'=>'text/javascript', 'charset'=>'utf-8',
350                               '_data'=> $script);
351  }
352  $head['script'][] = array( 'type'=>'text/javascript', 'charset'=>'utf-8', '_data'=>'',
353                             'src'=>DOKU_BASE.'lib/exe/js.php?edit='.$js_edit.'&write='.$js_write);
354
355  // trigger event here
356  trigger_event('TPL_METAHEADER_OUTPUT',$head,'_tpl_metaheaders_action',true);
357  return true;
358}
359
360/**
361 * prints the array build by tpl_metaheaders
362 *
363 * $data is an array of different header tags. Each tag can have multiple
364 * instances. Attributes are given as key value pairs. Values will be HTML
365 * encoded automatically so they should be provided as is in the $data array.
366 *
367 * For tags having a body attribute specify the the body data in the special
368 * attribute '_data'. This field will NOT BE ESCAPED automatically.
369 *
370 * @author Andreas Gohr <andi@splitbrain.org>
371 */
372function _tpl_metaheaders_action($data){
373  foreach($data as $tag => $inst){
374    foreach($inst as $attr){
375      echo '<',$tag,' ',buildAttributes($attr);
376      if(isset($attr['_data']) || $tag == 'script'){
377          if($tag == 'script' && $attr['_data'])
378            $attr['_data'] = "<!--//--><![CDATA[//><!--\n".
379                             $attr['_data'].
380                             "\n//--><!]]>";
381
382          echo '>',$attr['_data'],'</',$tag,'>';
383      }else{
384        echo '/>';
385      }
386      echo "\n";
387    }
388  }
389}
390
391/**
392 * Print a link
393 *
394 * Just builds a link.
395 *
396 * @author Andreas Gohr <andi@splitbrain.org>
397 */
398function tpl_link($url,$name,$more='',$return=false){
399  $out = '<a href="'.$url.'" ';
400  if ($more) $out .= ' '.$more;
401  $out .= ">$name</a>";
402  if ($return) return $out;
403  print $out;
404  return true;
405}
406
407/**
408 * Prints a link to a WikiPage
409 *
410 * Wrapper around html_wikilink
411 *
412 * @author Andreas Gohr <andi@splitbrain.org>
413 */
414function tpl_pagelink($id,$name=NULL){
415  print html_wikilink($id,$name);
416  return true;
417}
418
419/**
420 * get the parent page
421 *
422 * Tries to find out which page is parent.
423 * returns false if none is available
424 *
425 * @author Andreas Gohr <andi@splitbrain.org>
426 */
427function tpl_getparent($id){
428  global $conf;
429  $parent = getNS($id).':';
430  resolve_pageid('',$parent,$exists);
431  if($parent == $id) {
432    $pos = strrpos (getNS($id),':');
433    $parent = substr($parent,0,$pos).':';
434    resolve_pageid('',$parent,$exists);
435    if($parent == $id) return false;
436  }
437  return $parent;
438}
439
440/**
441 * Print one of the buttons
442 *
443 * Available Buttons are
444 *
445 *  edit        - edit/create/show/draft button
446 *  history     - old revisions
447 *  recent      - recent changes
448 *  login       - login/logout button - if ACL enabled
449 *  profile     - user profile button (if logged in)
450 *  index       - The index
451 *  admin       - admin page - if enough rights
452 *  top         - a back to top button
453 *  back        - a back to parent button - if available
454 *  backlink    - links to the list of backlinks
455 *  subscription- subscribe/unsubscribe button
456 *
457 * @author Andreas Gohr <andi@splitbrain.org>
458 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
459 */
460function tpl_button($type,$return=false){
461  global $ACT;
462  global $ID;
463  global $REV;
464  global $NS;
465  global $INFO;
466  global $conf;
467  global $auth;
468
469  // check disabled actions and fix the badly named ones
470  $ctype = $type;
471  if($type == 'history') $ctype='revisions';
472  if(!actionOK($ctype)) return false;
473
474  $out = '';
475  switch($type){
476    case 'edit':
477      #most complicated type - we need to decide on current action
478      if($ACT == 'show' || $ACT == 'search'){
479        if($INFO['writable']){
480          if(!empty($INFO['draft'])){
481            $out .= html_btn('draft',$ID,'e',array('do' => 'draft'),'post');
482          }else{
483            if($INFO['exists']){
484              $out .= html_btn('edit',$ID,'e',array('do' => 'edit','rev' => $REV),'post');
485            }else{
486              $out .= html_btn('create',$ID,'e',array('do' => 'edit','rev' => $REV),'post');
487            }
488          }
489        }else{
490          if(!actionOK('source')) return false; //pseudo action
491          $out .= html_btn('source',$ID,'v',array('do' => 'edit','rev' => $REV),'post');
492        }
493      }else{
494          $out .= html_btn('show',$ID,'v',array('do' => 'show'));
495      }
496      break;
497    case 'history':
498      if(actionOK('revisions'))
499        $out .= html_btn('revs',$ID,'o',array('do' => 'revisions'));
500      break;
501    case 'recent':
502      if(actionOK('recent'))
503        $out .= html_btn('recent',$ID,'r',array('do' => 'recent'));
504      break;
505    case 'index':
506      if(actionOK('index'))
507        $out .= html_btn('index',$ID,'x',array('do' => 'index'));
508      break;
509    case 'back':
510      if ($parent = tpl_getparent($ID)) {
511        $out .= html_btn('back',$parent,'b',array('do' => 'show'));
512      }
513      break;
514    case 'top':
515      $out .= html_topbtn();
516      break;
517    case 'login':
518      if($conf['useacl'] && $auth){
519        if($_SERVER['REMOTE_USER']){
520          $out .= html_btn('logout',$ID,'',array('do' => 'logout', 'sectok' => getSecurityToken()));
521        }else{
522          $out .= html_btn('login',$ID,'',array('do' => 'login', 'sectok' => getSecurityToken()));
523        }
524      }
525      break;
526    case 'admin':
527      if($INFO['ismanager']){
528        $out .= html_btn('admin',$ID,'',array('do' => 'admin'));
529      }
530      break;
531    case 'subscribe':
532    case 'subscription':
533      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
534        if($_SERVER['REMOTE_USER']){
535          if($INFO['subscribed']){
536            if(actionOK('unsubscribe'))
537              $out .= html_btn('unsubscribe',$ID,'',array('do' => 'unsubscribe',));
538          } else {
539            if(actionOK('subscribe'))
540              $out .= html_btn('subscribe',$ID,'',array('do' => 'subscribe',));
541          }
542        }
543      }
544      if($type == 'subscribe') break;
545      // else: fall through for backward compatibility
546    case 'subscribens':
547      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
548        if($_SERVER['REMOTE_USER']){
549          if($INFO['subscribedns']){
550            if(actionOK('unsubscribens'))
551              $out .= html_btn('unsubscribens',$ID,'',array('do' => 'unsubscribens',));
552          } else {
553            if(actionOK('subscribens'))
554              $out .= html_btn('subscribens',$ID,'',array('do' => 'subscribens',));
555          }
556        }
557      }
558      break;
559    case 'backlink':
560      if(actionOK('backlink'))
561        $out .= html_btn('backlink',$ID,'',array('do' => 'backlink'));
562    case 'profile':
563      if($conf['useacl'] && $_SERVER['REMOTE_USER'] && $auth &&
564          $auth->canDo('Profile') && ($ACT!='profile')){
565        $out .= html_btn('profile',$ID,'',array('do' => 'profile'));
566      }
567      break;
568    default:
569      $out .= '[unknown button type]';
570      break;
571  }
572  if ($return) return $out;
573  print $out;
574  return $out ? true : false;
575}
576
577/**
578 * Like the action buttons but links
579 *
580 * Available links are
581 *
582 *  edit    - edit/create/show link
583 *  history - old revisions
584 *  recent  - recent changes
585 *  login   - login/logout link - if ACL enabled
586 *  profile - user profile link (if logged in)
587 *  index   - The index
588 *  admin   - admin page - if enough rights
589 *  top     - a back to top link
590 *  back    - a back to parent link - if available
591 *  backlink - links to the list of backlinks
592 *  subscribe/subscription - subscribe/unsubscribe link
593 *
594 * @author Andreas Gohr <andi@splitbrain.org>
595 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
596 * @see    tpl_button
597 */
598function tpl_actionlink($type,$pre='',$suf='',$inner='',$return=false){
599  global $ID;
600  global $INFO;
601  global $REV;
602  global $ACT;
603  global $conf;
604  global $lang;
605  global $auth;
606
607  // check disabled actions and fix the badly named ones
608  $ctype = $type;
609  if($type == 'history') $ctype='revisions';
610  if(!actionOK($ctype)) return false;
611
612  $out = '';
613  switch($type){
614    case 'edit':
615      #most complicated type - we need to decide on current action
616      if($ACT == 'show' || $ACT == 'search'){
617        if($INFO['writable']){
618          if(!empty($INFO['draft'])) {
619            $out .= tpl_link(wl($ID,'do=draft'),
620                       $pre.(($inner)?$inner:$lang['btn_draft']).$suf,
621                       'class="action edit" accesskey="e" rel="nofollow"',1);
622          } else {
623            if($INFO['exists']){
624              $out .= tpl_link(wl($ID,'do=edit&amp;rev='.$REV),
625                       $pre.(($inner)?$inner:$lang['btn_edit']).$suf,
626                       'class="action edit" accesskey="e" rel="nofollow"',1);
627            }else{
628              $out .= tpl_link(wl($ID,'do=edit&amp;rev='.$REV),
629                       $pre.(($inner)?$inner:$lang['btn_create']).$suf,
630                       'class="action create" accesskey="e" rel="nofollow"',1);
631            }
632          }
633        }else{
634          if(actionOK('source')) //pseudo action
635            $out .= tpl_link(wl($ID,'do=edit&amp;rev='.$REV),
636                   $pre.(($inner)?$inner:$lang['btn_source']).$suf,
637                   'class="action source" accesskey="v" rel="nofollow"',1);
638        }
639      }else{
640          $out .= tpl_link(wl($ID,'do=show'),
641                   $pre.(($inner)?$inner:$lang['btn_show']).$suf,
642                   'class="action show" accesskey="v" rel="nofollow"',1);
643      }
644      break;
645    case 'history':
646      if(actionOK('revisions'))
647        $out .= tpl_link(wl($ID,'do=revisions'),
648               $pre.(($inner)?$inner:$lang['btn_revs']).$suf,
649               'class="action revisions" accesskey="o" rel="nofollow"',1);
650      break;
651    case 'recent':
652      if(actionOK('recent'))
653        $out .= tpl_link(wl($ID,'do=recent'),
654               $pre.(($inner)?$inner:$lang['btn_recent']).$suf,
655              'class="action recent" accesskey="r" rel="nofollow"',1);
656      break;
657    case 'index':
658      if(actionOK('index'))
659        $out .= tpl_link(wl($ID,'do=index'),
660               $pre.(($inner)?$inner:$lang['btn_index']).$suf,
661              'class="action index" accesskey="x" rel="nofollow"',1);
662      break;
663    case 'top':
664      $out .= '<a href="#dokuwiki__top" class="action top" accesskey="x">'.
665            $pre.(($inner)?$inner:$lang['btn_top']).$suf.'</a>';
666      break;
667    case 'back':
668      if ($parent = tpl_getparent($ID)) {
669        $out .= tpl_link(wl($parent,'do=show'),
670        $pre.(($inner)?$inner:$lang['btn_back']).$suf,
671        'class="action back" accesskey="b" rel="nofollow"',1);
672      }
673      break;
674    case 'login':
675      if($conf['useacl'] && $auth){
676        if($_SERVER['REMOTE_USER']){
677          $out .= tpl_link(wl($ID,'do=logout&amp;sectok='.getSecurityToken()),
678                   $pre.(($inner)?$inner:$lang['btn_logout']).$suf,
679                   'class="action logout" rel="nofollow"',1);
680        }else{
681          $out .= tpl_link(wl($ID,'do=login&amp;sectok='.getSecurityToken()),
682                   $pre.(($inner)?$inner:$lang['btn_login']).$suf,
683                   'class="action login" rel="nofollow"',1);
684        }
685      }
686      break;
687    case 'admin':
688      if($INFO['ismanager']){
689        $out .= tpl_link(wl($ID,'do=admin'),
690                 $pre.(($inner)?$inner:$lang['btn_admin']).$suf,
691                 'class="action admin" rel="nofollow"',1);
692      }
693      break;
694   case 'subscribe':
695   case 'subscription':
696      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
697        if($_SERVER['REMOTE_USER']){
698          if($INFO['subscribed']) {
699            if(actionOK('unsubscribe'))
700              $out .= tpl_link(wl($ID,'do=unsubscribe'),
701                     $pre.(($inner)?$inner:$lang['btn_unsubscribe']).$suf,
702                     'class="action unsubscribe" rel="nofollow"',1);
703          } else {
704            if(actionOK('subscribe'))
705              $out .= tpl_link(wl($ID,'do=subscribe'),
706                     $pre.(($inner)?$inner:$lang['btn_subscribe']).$suf,
707                     'class="action subscribe" rel="nofollow"',1);
708          }
709        }
710      }
711      if($type == 'subscribe') break;
712      // else: fall through for backward compatibility
713    case 'subscribens':
714      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
715        if($_SERVER['REMOTE_USER']){
716          if($INFO['subscribedns']) {
717            if(actionOK('unsubscribens'))
718              $out .= tpl_link(wl($ID,'do=unsubscribens'),
719                     $pre.(($inner)?$inner:$lang['btn_unsubscribens']).$suf,
720                     'class="action unsubscribens" rel="nofollow"',1);
721          } else {
722            if(actionOK('subscribens'))
723              $out .= tpl_link(wl($ID,'do=subscribens'),
724                     $pre.(($inner)?$inner:$lang['btn_subscribens']).$suf,
725                     'class="action subscribens" rel="nofollow"',1);
726          }
727        }
728      }
729      break;
730    case 'backlink':
731      if(actionOK('backlink'))
732        $out .= tpl_link(wl($ID,'do=backlink'),
733               $pre.(($inner)?$inner:$lang['btn_backlink']).$suf,
734               'class="action backlink" rel="nofollow"',1);
735      break;
736    case 'profile':
737      if($conf['useacl'] && $auth && $_SERVER['REMOTE_USER'] &&
738         $auth->canDo('Profile') && ($ACT!='profile')){
739        $out .= tpl_link(wl($ID,'do=profile'),
740                 $pre.(($inner)?$inner:$lang['btn_profile']).$suf,
741                 'class="action profile" rel="nofollow"',1);
742      }
743      break;
744    default:
745      $out .= '[unknown link type]';
746      break;
747  }
748  if ($return) return $out;
749  print $out;
750  return $out ? true : false;
751}
752
753/**
754 * Wrapper around tpl_button() and tpl_actionlink()
755 *
756 * @author Anika Henke <anika@selfthinker.org>
757 */
758function tpl_action($type,$link=0,$wrapper=false,$return=false,$pre='',$suf='',$inner='') {
759    $out = '';
760    if ($link) $out .= tpl_actionlink($type,$pre,$suf,$inner,1);
761    else $out .= tpl_button($type,1);
762    if ($out && $wrapper) $out = "<$wrapper>$out</$wrapper>";
763
764    if ($return) return $out;
765    print $out;
766    return $out ? true : false;
767}
768
769/**
770 * Print the search form
771 *
772 * If the first parameter is given a div with the ID 'qsearch_out' will
773 * be added which instructs the ajax pagequicksearch to kick in and place
774 * its output into this div. The second parameter controls the propritary
775 * attribute autocomplete. If set to false this attribute will be set with an
776 * value of "off" to instruct the browser to disable it's own built in
777 * autocompletion feature (MSIE and Firefox)
778 *
779 * @author Andreas Gohr <andi@splitbrain.org>
780 */
781function tpl_searchform($ajax=true,$autocomplete=true){
782  global $lang;
783  global $ACT;
784
785  // don't print the search form if search action has been disabled
786  if (!actionOk('search')) return false;
787
788  print '<form action="'.wl().'" accept-charset="utf-8" class="search" id="dw__search"><div class="no">';
789  print '<input type="hidden" name="do" value="search" />';
790  print '<input type="text" ';
791  if($ACT == 'search') print 'value="'.htmlspecialchars($_REQUEST['id']).'" ';
792  if(!$autocomplete) print 'autocomplete="off" ';
793  print 'id="qsearch__in" accesskey="f" name="id" class="edit" title="[F]" />';
794  print '<input type="submit" value="'.$lang['btn_search'].'" class="button" title="'.$lang['btn_search'].'" />';
795  if($ajax) print '<div id="qsearch__out" class="ajax_qsearch JSpopup"></div>';
796  print '</div></form>';
797  return true;
798}
799
800/**
801 * Print the breadcrumbs trace
802 *
803 * @author Andreas Gohr <andi@splitbrain.org>
804 */
805function tpl_breadcrumbs($sep='&raquo;'){
806  global $lang;
807  global $conf;
808
809  //check if enabled
810  if(!$conf['breadcrumbs']) return false;
811
812  $crumbs = breadcrumbs(); //setup crumb trace
813
814  //reverse crumborder in right-to-left mode, add RLM character to fix heb/eng display mixups
815  if($lang['direction'] == 'rtl') {
816    $crumbs = array_reverse($crumbs,true);
817    $crumbs_sep = ' &#8207;<span class="bcsep">'.$sep.'</span>&#8207; ';
818  } else {
819    $crumbs_sep = ' <span class="bcsep">'.$sep.'</span> ';
820  }
821
822  //render crumbs, highlight the last one
823  print '<span class="bchead">'.$lang['breadcrumb'].':</span>';
824  $last = count($crumbs);
825  $i = 0;
826  foreach ($crumbs as $id => $name){
827    $i++;
828    echo $crumbs_sep;
829    if ($i == $last) print '<span class="curid">';
830    tpl_link(wl($id),hsc($name),'class="breadcrumbs" title="'.$id.'"');
831    if ($i == $last) print '</span>';
832  }
833  return true;
834}
835
836/**
837 * Hierarchical breadcrumbs
838 *
839 * This code was suggested as replacement for the usual breadcrumbs.
840 * It only makes sense with a deep site structure.
841 *
842 * @author Andreas Gohr <andi@splitbrain.org>
843 * @author Nigel McNie <oracle.shinoda@gmail.com>
844 * @author Sean Coates <sean@caedmon.net>
845 * @author <fredrik@averpil.com>
846 * @todo   May behave strangely in RTL languages
847 */
848function tpl_youarehere($sep=' &raquo; '){
849  global $conf;
850  global $ID;
851  global $lang;
852
853  // check if enabled
854  if(!$conf['youarehere']) return false;
855
856  $parts = explode(':', $ID);
857  $count = count($parts);
858
859  if($GLOBALS['ACT'] == 'search')
860  {
861    $parts = array($conf['start']);
862    $count = 1;
863  }
864
865  echo '<span class="bchead">'.$lang['youarehere'].': </span>';
866
867  // always print the startpage
868  $title = useHeading('navigation') ? p_get_first_heading($conf['start']) : $conf['start'];
869  if(!$title) $title = $conf['start'];
870  tpl_link(wl($conf['start']),hsc($title),'title="'.$conf['start'].'"');
871
872  // print intermediate namespace links
873  $part = '';
874  for($i=0; $i<$count - 1; $i++){
875    $part .= $parts[$i].':';
876    $page = $part;
877    resolve_pageid('',$page,$exists);
878    if ($page == $conf['start']) continue; // Skip startpage
879
880    // output
881    echo $sep;
882    if($exists){
883      $title = useHeading('navigation') ? p_get_first_heading($page) : $parts[$i];
884      tpl_link(wl($page),hsc($title),'title="'.$page.'"');
885    }else{
886      tpl_link(wl($page),$parts[$i],'title="'.$page.'" class="wikilink2" rel="nofollow"');
887    }
888  }
889
890  // print current page, skipping start page, skipping for namespace index
891  if(isset($page) && $page==$part.$parts[$i]) return;
892  $page = $part.$parts[$i];
893  if($page == $conf['start']) return;
894  echo $sep;
895  if(page_exists($page)){
896    $title = useHeading('navigation') ? p_get_first_heading($page) : $parts[$i];
897    tpl_link(wl($page),hsc($title),'title="'.$page.'"');
898  }else{
899    tpl_link(wl($page),$parts[$i],'title="'.$page.'" class="wikilink2" rel="nofollow"');
900  }
901  return true;
902}
903
904/**
905 * Print info if the user is logged in
906 * and show full name in that case
907 *
908 * Could be enhanced with a profile link in future?
909 *
910 * @author Andreas Gohr <andi@splitbrain.org>
911 */
912function tpl_userinfo(){
913  global $lang;
914  global $INFO;
915  if($_SERVER['REMOTE_USER']){
916    print $lang['loggedinas'].': '.$INFO['userinfo']['name'].' ('.$_SERVER['REMOTE_USER'].')';
917    return true;
918  }
919  return false;
920}
921
922/**
923 * Print some info about the current page
924 *
925 * @author Andreas Gohr <andi@splitbrain.org>
926 */
927function tpl_pageinfo($ret=false){
928  global $conf;
929  global $lang;
930  global $INFO;
931  global $REV;
932  global $ID;
933
934  // return if we are not allowed to view the page
935  if (!auth_quickaclcheck($ID)) { return false; }
936
937  // prepare date and path
938  $fn = $INFO['filepath'];
939  if(!$conf['fullpath']){
940    if($REV){
941      $fn = str_replace(fullpath($conf['olddir']).'/','',$fn);
942    }else{
943      $fn = str_replace(fullpath($conf['datadir']).'/','',$fn);
944    }
945  }
946  $fn = utf8_decodeFN($fn);
947  $date = strftime($conf['dformat'],$INFO['lastmod']);
948
949  // print it
950  if($INFO['exists']){
951    $out = '';
952    $out .= $fn;
953    $out .= ' &middot; ';
954    $out .= $lang['lastmod'];
955    $out .= ': ';
956    $out .= $date;
957    if($INFO['editor']){
958      $out .= ' '.$lang['by'].' ';
959      $out .= editorinfo($INFO['editor']);
960    }else{
961      $out .= ' ('.$lang['external_edit'].')';
962    }
963    if($INFO['locked']){
964      $out .= ' &middot; ';
965      $out .= $lang['lockedby'];
966      $out .= ': ';
967      $out .= editorinfo($INFO['locked']);
968    }
969    if($ret){
970        return $out;
971    }else{
972        echo $out;
973        return true;
974    }
975  }
976  return false;
977}
978
979/**
980 * Prints or returns the name of the given page (current one if none given).
981 *
982 * If useheading is enabled this will use the first headline else
983 * the given ID is used.
984 *
985 * @author Andreas Gohr <andi@splitbrain.org>
986 */
987function tpl_pagetitle($id=null, $ret=false){
988  global $conf;
989  if(is_null($id)){
990    global $ID;
991    $id = $ID;
992  }
993
994  $name = $id;
995  if (useHeading('navigation')) {
996    $title = p_get_first_heading($id);
997    if ($title) $name = $title;
998  }
999
1000  if ($ret) {
1001      return hsc($name);
1002  } else {
1003      print hsc($name);
1004      return true;
1005  }
1006}
1007
1008/**
1009 * Returns the requested EXIF/IPTC tag from the current image
1010 *
1011 * If $tags is an array all given tags are tried until a
1012 * value is found. If no value is found $alt is returned.
1013 *
1014 * Which texts are known is defined in the functions _exifTagNames
1015 * and _iptcTagNames() in inc/jpeg.php (You need to prepend IPTC
1016 * to the names of the latter one)
1017 *
1018 * Only allowed in: detail.php
1019 *
1020 * @author Andreas Gohr <andi@splitbrain.org>
1021 */
1022function tpl_img_getTag($tags,$alt='',$src=null){
1023  // Init Exif Reader
1024  global $SRC;
1025
1026  if(is_null($src)) $src = $SRC;
1027
1028  static $meta = null;
1029  if(is_null($meta)) $meta = new JpegMeta($src);
1030  if($meta === false) return $alt;
1031  $info = $meta->getField($tags);
1032  if($info == false) return $alt;
1033  return $info;
1034}
1035
1036/**
1037 * Prints the image with a link to the full sized version
1038 *
1039 * Only allowed in: detail.php
1040 */
1041function tpl_img($maxwidth=0,$maxheight=0){
1042  global $IMG;
1043  $w = tpl_img_getTag('File.Width');
1044  $h = tpl_img_getTag('File.Height');
1045
1046  //resize to given max values
1047  $ratio = 1;
1048  if($w >= $h){
1049    if($maxwidth && $w >= $maxwidth){
1050      $ratio = $maxwidth/$w;
1051    }elseif($maxheight && $h > $maxheight){
1052      $ratio = $maxheight/$h;
1053    }
1054  }else{
1055    if($maxheight && $h >= $maxheight){
1056      $ratio = $maxheight/$h;
1057    }elseif($maxwidth && $w > $maxwidth){
1058      $ratio = $maxwidth/$w;
1059    }
1060  }
1061  if($ratio){
1062    $w = floor($ratio*$w);
1063    $h = floor($ratio*$h);
1064  }
1065
1066  //prepare URLs
1067  $url=ml($IMG,array('cache'=>$_REQUEST['cache']));
1068  $src=ml($IMG,array('cache'=>$_REQUEST['cache'],'w'=>$w,'h'=>$h));
1069
1070  //prepare attributes
1071  $alt=tpl_img_getTag('Simple.Title');
1072  $p = array();
1073  if($w) $p['width']  = $w;
1074  if($h) $p['height'] = $h;
1075         $p['class']  = 'img_detail';
1076  if($alt){
1077    $p['alt']   = $alt;
1078    $p['title'] = $alt;
1079  }else{
1080    $p['alt'] = '';
1081  }
1082  $p = buildAttributes($p);
1083
1084  print '<a href="'.$url.'">';
1085  print '<img src="'.$src.'" '.$p.'/>';
1086  print '</a>';
1087  return true;
1088}
1089
1090/**
1091 * This function inserts a 1x1 pixel gif which in reality
1092 * is the inexer function.
1093 *
1094 * Should be called somewhere at the very end of the main.php
1095 * template
1096 */
1097function tpl_indexerWebBug(){
1098  global $ID;
1099  global $INFO;
1100  if(!$INFO['exists']) return false;
1101
1102  if(isHiddenPage($ID)) return false; //no need to index hidden pages
1103
1104  $p = array();
1105  $p['src']    = DOKU_BASE.'lib/exe/indexer.php?id='.rawurlencode($ID).
1106                 '&'.time();
1107  $p['width']  = 1;
1108  $p['height'] = 1;
1109  $p['alt']    = '';
1110  $att = buildAttributes($p);
1111  print "<img $att />";
1112  return true;
1113}
1114
1115// configuration methods
1116/**
1117 * tpl_getConf($id)
1118 *
1119 * use this function to access template configuration variables
1120 */
1121function tpl_getConf($id){
1122  global $conf;
1123  global $tpl_configloaded;
1124
1125  $tpl = $conf['template'];
1126
1127  if (!$tpl_configloaded){
1128    $tconf = tpl_loadConfig();
1129    if ($tconf !== false){
1130      foreach ($tconf as $key => $value){
1131        if (isset($conf['tpl'][$tpl][$key])) continue;
1132        $conf['tpl'][$tpl][$key] = $value;
1133      }
1134      $tpl_configloaded = true;
1135    }
1136  }
1137
1138  return $conf['tpl'][$tpl][$id];
1139}
1140
1141/**
1142 * tpl_loadConfig()
1143 * reads all template configuration variables
1144 * this function is automatically called by tpl_getConf()
1145 */
1146function tpl_loadConfig(){
1147
1148  $file = DOKU_TPLINC.'/conf/default.php';
1149  $conf = array();
1150
1151  if (!@file_exists($file)) return false;
1152
1153  // load default config file
1154  include($file);
1155
1156  return $conf;
1157}
1158
1159/**
1160 * prints the "main content" in the mediamanger popup
1161 *
1162 * Depending on the user's actions this may be a list of
1163 * files in a namespace, the meta editing dialog or
1164 * a message of referencing pages
1165 *
1166 * Only allowed in mediamanager.php
1167 *
1168 * @author Andreas Gohr <andi@splitbrain.org>
1169 */
1170function tpl_mediaContent(){
1171  global $IMG;
1172  global $AUTH;
1173  global $INUSE;
1174  global $NS;
1175  global $JUMPTO;
1176
1177  ptln('<div id="media__content">');
1178  if($_REQUEST['edit']){
1179    media_metaform($IMG,$AUTH);
1180  }elseif(is_array($INUSE)){
1181    media_filesinuse($INUSE,$IMG);
1182  }else{
1183    media_filelist($NS,$AUTH,$JUMPTO);
1184  }
1185  ptln('</div>');
1186}
1187
1188/**
1189 * prints the namespace tree in the mediamanger popup
1190 *
1191 * Only allowed in mediamanager.php
1192 *
1193 * @author Andreas Gohr <andi@splitbrain.org>
1194 */
1195function tpl_mediaTree(){
1196  global $NS;
1197
1198  ptln('<div id="media__tree">');
1199  media_nstree($NS);
1200  ptln('</div>');
1201}
1202
1203
1204/**
1205 * Print a dropdown menu with all DokuWiki actions
1206 *
1207 * Note: this will not use any pretty URLs
1208 *
1209 * @author Andreas Gohr <andi@splitbrain.org>
1210 */
1211function tpl_actiondropdown($empty='',$button='&gt;'){
1212    global $ID;
1213    global $INFO;
1214    global $REV;
1215    global $ACT;
1216    global $conf;
1217    global $lang;
1218    global $auth;
1219
1220
1221    echo '<form method="post" accept-charset="utf-8">'; #FIXME action
1222    echo '<input type="hidden" name="id" value="'.$ID.'" />';
1223    if($REV) echo '<input type="hidden" name="rev" value="'.$REV.'" />';
1224    echo '<input type="hidden" name="sectok" value="'.getSecurityToken().'" />';
1225
1226    echo '<select name="do" id="action__selector" class="edit">';
1227    echo '<option value="">'.$empty.'</option>';
1228
1229    echo '<optgroup label=" &mdash; ">';
1230        // 'edit' - most complicated type, we need to decide on current action
1231        if($ACT == 'show' || $ACT == 'search'){
1232            if($INFO['writable']){
1233                if(!empty($INFO['draft'])) {
1234                    echo '<option value="edit">'.$lang['btn_draft'].'</option>';
1235                } else {
1236                    if($INFO['exists']){
1237                        echo '<option value="edit">'.$lang['btn_edit'].'</option>';
1238                    }else{
1239                        echo '<option value="edit">'.$lang['btn_create'].'</option>';
1240                    }
1241                }
1242            }else if(actionOK('source')) { //pseudo action
1243                echo '<option value="edit">'.$lang['btn_source'].'</option>';
1244            }
1245        }else{
1246            echo '<option value="show">'.$lang['btn_show'].'</option>';
1247        }
1248
1249        echo '<option value="revisions">'.$lang['btn_revs'].'</option>';
1250        echo '<option value="backlink">'.$lang['btn_backlink'].'</option>';
1251    echo '</optgroup>';
1252
1253    echo '<optgroup label=" &mdash; ">';
1254        echo '<option value="recent">'.$lang['btn_recent'].'</option>';
1255        echo '<option value="index">'.$lang['btn_index'].'</option>';
1256    echo '</optgroup>';
1257
1258    echo '<optgroup label=" &mdash; ">';
1259        if($conf['useacl'] && $auth){
1260            if($_SERVER['REMOTE_USER']){
1261                echo '<option value="logout">'.$lang['btn_logout'].'</option>';
1262            }else{
1263                echo '<option value="login">'.$lang['btn_login'].'</option>';
1264            }
1265        }
1266
1267        if($conf['useacl'] && $auth && $_SERVER['REMOTE_USER'] &&
1268             $auth->canDo('Profile') && ($ACT!='profile')){
1269            echo '<option value="profile">'.$lang['btn_profile'].'</option>';
1270        }
1271
1272        if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
1273            if($_SERVER['REMOTE_USER']){
1274                if($INFO['subscribed']) {
1275                    echo '<option value="unsubscribe">'.$lang['btn_unsubscribe'].'</option>';
1276                } else {
1277                    echo '<option value="subscribe">'.$lang['btn_subscribe'].'</option>';
1278                }
1279            }
1280        }
1281
1282        if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
1283            if($_SERVER['REMOTE_USER']){
1284                if($INFO['subscribedns']) {
1285                    echo '<option value="unsubscribens">'.$lang['btn_unsubscribens'].'</option>';
1286                } else {
1287                    echo '<option value="subscribens">'.$lang['btn_subscribens'].'</option>';
1288                }
1289            }
1290        }
1291
1292        if($INFO['ismanager']){
1293            echo '<option value="admin">'.$lang['btn_admin'].'</option>';
1294        }
1295    echo '</optgroup>';
1296
1297    echo '</select>';
1298    echo '<input type="submit" value="'.$button.'" id="action__selectorbtn" />';
1299    echo '</form>';
1300}
1301
1302/**
1303 * Print a informational line about the used license
1304 *
1305 * @author Andreas Gohr <andi@splitbrain.org>
1306 * @param  string $img    - print image? (|button|badge)
1307 * @param  bool   $return - when true don't print, but return HTML
1308 */
1309function tpl_license($img='badge',$imgonly=false,$return=false){
1310    global $license;
1311    global $conf;
1312    global $lang;
1313    if(!$conf['license']) return '';
1314    if(!is_array($license[$conf['license']])) return '';
1315    $lic = $license[$conf['license']];
1316
1317    $out  = '<div class="license">';
1318    if($img){
1319        $src = license_img($img);
1320        if($src){
1321            $out .= '<a href="'.$lic['url'].'" rel="license"';
1322            if($conf['target']['external']) $out .= ' target="'.$conf['target']['external'].'"';
1323            $out .= '><img src="'.DOKU_BASE.$src.'" class="medialeft lic'.$img.'" alt="'.$lic['name'].'" /></a> ';
1324        }
1325    }
1326    if(!$imgonly) {
1327        $out .= $lang['license'];
1328        $out .= '<a href="'.$lic['url'].'" rel="license" class="urlextern"';
1329        if($conf['target']['external']) $out .= ' target="'.$conf['target']['external'].'"';
1330        $out .= '>'.$lic['name'].'</a>';
1331        $out .= '</div>';
1332    }
1333
1334    if($return) return $out;
1335    echo $out;
1336}
1337
1338
1339/**
1340 * Includes the rendered XHTML of a given page
1341 *
1342 * This function is useful to populate sidebars or similar features in a
1343 * template
1344 */
1345function tpl_include_page($pageid,$print=true){
1346    global $ID;
1347    $oldid = $ID;
1348    $html = p_wiki_xhtml($pageid,'',false);
1349    $ID = $oldid;
1350
1351    if(!$print) return $html;
1352    echo $html;
1353}
1354
1355//Setup VIM: ex: et ts=4 enc=utf-8 :
1356
1357