xref: /dokuwiki/inc/template.php (revision 0a8ff8cb239beaba612306f8c76ba92b03ea938a) 
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    }else{
302      $head['meta'][] = array( 'name'=>'robots', 'content'=>'noindex,follow');
303    }
304  }elseif(defined('DOKU_MEDIADETAIL')){
305    $head['meta'][] = array( 'name'=>'robots', 'content'=>'index,follow');
306  }else{
307    $head['meta'][] = array( 'name'=>'robots', 'content'=>'noindex,nofollow');
308  }
309
310  // set metadata
311  if($ACT == 'show' || $ACT=='export_xhtml'){
312    // date of modification
313    if($REV){
314      $head['meta'][] = array( 'name'=>'date', 'content'=>date('Y-m-d\TH:i:sO',$REV));
315    }else{
316      $head['meta'][] = array( 'name'=>'date', 'content'=>date('Y-m-d\TH:i:sO',$INFO['lastmod']));
317    }
318
319    // keywords (explicit or implicit)
320    if(!empty($INFO['meta']['subject'])){
321      $head['meta'][] = array( 'name'=>'keywords', 'content'=>join(',',$INFO['meta']['subject']));
322    }else{
323      $head['meta'][] = array( 'name'=>'keywords', 'content'=>str_replace(':',',',$ID));
324    }
325  }
326
327  // load stylesheets
328  $head['link'][] = array('rel'=>'stylesheet', 'media'=>'all', 'type'=>'text/css',
329                          'href'=>DOKU_BASE.'lib/exe/css.php?s=all&t='.$conf['template']);
330  $head['link'][] = array('rel'=>'stylesheet', 'media'=>'screen', 'type'=>'text/css',
331                          'href'=>DOKU_BASE.'lib/exe/css.php?t='.$conf['template']);
332  $head['link'][] = array('rel'=>'stylesheet', 'media'=>'print', 'type'=>'text/css',
333                          'href'=>DOKU_BASE.'lib/exe/css.php?s=print&t='.$conf['template']);
334
335  // load javascript
336  $js_edit  = ($ACT=='edit' || $ACT=='preview' || $ACT=='recover' || $ACT=='wordblock' ) ? 1 : 0;
337  $js_write = ($INFO['writable']) ? 1 : 0;
338  if(defined('DOKU_MEDIAMANAGER')){
339    $js_edit  = 1;
340    $js_write = 0;
341  }
342  if(($js_edit && $js_write) || defined('DOKU_MEDIAMANAGER')){
343    $script = "NS='".$INFO['namespace']."';";
344    if($conf['useacl'] && $_SERVER['REMOTE_USER']){
345      require_once(DOKU_INC.'inc/toolbar.php');
346      $script .= "SIG='".toolbar_signature()."';";
347    }
348    $head['script'][] = array( 'type'=>'text/javascript', 'charset'=>'utf-8',
349                               '_data'=> $script);
350  }
351  $head['script'][] = array( 'type'=>'text/javascript', 'charset'=>'utf-8', '_data'=>'',
352                             'src'=>DOKU_BASE.'lib/exe/js.php?edit='.$js_edit.'&write='.$js_write);
353
354  // trigger event here
355  trigger_event('TPL_METAHEADER_OUTPUT',$head,'_tpl_metaheaders_action',true);
356  return true;
357}
358
359/**
360 * prints the array build by tpl_metaheaders
361 *
362 * $data is an array of different header tags. Each tag can have multiple
363 * instances. Attributes are given as key value pairs. Values will be HTML
364 * encoded automatically so they should be provided as is in the $data array.
365 *
366 * For tags having a body attribute specify the the body data in the special
367 * attribute '_data'. This field will NOT BE ESCAPED automatically.
368 *
369 * @author Andreas Gohr <andi@splitbrain.org>
370 */
371function _tpl_metaheaders_action($data){
372  foreach($data as $tag => $inst){
373    foreach($inst as $attr){
374      echo '<',$tag,' ',buildAttributes($attr);
375      if(isset($attr['_data']) || $tag == 'script'){
376          if($tag == 'script' && $attr['_data'])
377            $attr['_data'] = "<!--//--><![CDATA[//><!--\n".
378                             $attr['_data'].
379                             "\n//--><!]]>";
380
381          echo '>',$attr['_data'],'</',$tag,'>';
382      }else{
383        echo '/>';
384      }
385      echo "\n";
386    }
387  }
388}
389
390/**
391 * Print a link
392 *
393 * Just builds a link.
394 *
395 * @author Andreas Gohr <andi@splitbrain.org>
396 */
397function tpl_link($url,$name,$more='',$return=false){
398  $out = '<a href="'.$url.'" ';
399  if ($more) $out .= ' '.$more;
400  $out .= ">$name</a>";
401  if ($return) return $out;
402  print $out;
403  return true;
404}
405
406/**
407 * Prints a link to a WikiPage
408 *
409 * Wrapper around html_wikilink
410 *
411 * @author Andreas Gohr <andi@splitbrain.org>
412 */
413function tpl_pagelink($id,$name=NULL){
414  print html_wikilink($id,$name);
415  return true;
416}
417
418/**
419 * get the parent page
420 *
421 * Tries to find out which page is parent.
422 * returns false if none is available
423 *
424 * @author Andreas Gohr <andi@splitbrain.org>
425 */
426function tpl_getparent($id){
427  global $conf;
428  $parent = getNS($id).':';
429  resolve_pageid('',$parent,$exists);
430  if($parent == $id) {
431    $pos = strrpos (getNS($id),':');
432    $parent = substr($parent,0,$pos).':';
433    resolve_pageid('',$parent,$exists);
434    if($parent == $id) return false;
435  }
436  return $parent;
437}
438
439/**
440 * Print one of the buttons
441 *
442 * Available Buttons are
443 *
444 *  edit        - edit/create/show/draft button
445 *  history     - old revisions
446 *  recent      - recent changes
447 *  login       - login/logout button - if ACL enabled
448 *  profile     - user profile button (if logged in)
449 *  index       - The index
450 *  admin       - admin page - if enough rights
451 *  top         - a back to top button
452 *  back        - a back to parent button - if available
453 *  backlink    - links to the list of backlinks
454 *  subscription- subscribe/unsubscribe button
455 *
456 * @author Andreas Gohr <andi@splitbrain.org>
457 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
458 */
459function tpl_button($type,$return=false){
460  global $ACT;
461  global $ID;
462  global $REV;
463  global $NS;
464  global $INFO;
465  global $conf;
466  global $auth;
467
468  // check disabled actions and fix the badly named ones
469  $ctype = $type;
470  if($type == 'history') $ctype='revisions';
471  if(!actionOK($ctype)) return false;
472
473  $out = '';
474  switch($type){
475    case 'edit':
476      #most complicated type - we need to decide on current action
477      if($ACT == 'show' || $ACT == 'search'){
478        if($INFO['writable']){
479          if(!empty($INFO['draft'])){
480            $out .= html_btn('draft',$ID,'e',array('do' => 'draft'),'post');
481          }else{
482            if($INFO['exists']){
483              $out .= html_btn('edit',$ID,'e',array('do' => 'edit','rev' => $REV),'post');
484            }else{
485              $out .= html_btn('create',$ID,'e',array('do' => 'edit','rev' => $REV),'post');
486            }
487          }
488        }else{
489          if(!actionOK('source')) return false; //pseudo action
490          $out .= html_btn('source',$ID,'v',array('do' => 'edit','rev' => $REV),'post');
491        }
492      }else{
493          $out .= html_btn('show',$ID,'v',array('do' => 'show'));
494      }
495      break;
496    case 'history':
497      if(actionOK('revisions'))
498        $out .= html_btn('revs',$ID,'o',array('do' => 'revisions'));
499      break;
500    case 'recent':
501      if(actionOK('recent'))
502        $out .= html_btn('recent',$ID,'r',array('do' => 'recent'));
503      break;
504    case 'index':
505      if(actionOK('index'))
506        $out .= html_btn('index',$ID,'x',array('do' => 'index'));
507      break;
508    case 'back':
509      if ($parent = tpl_getparent($ID)) {
510        $out .= html_btn('back',$parent,'b',array('do' => 'show'));
511      }
512      break;
513    case 'top':
514      $out .= html_topbtn();
515      break;
516    case 'login':
517      if($conf['useacl'] && $auth){
518        if($_SERVER['REMOTE_USER']){
519          $out .= html_btn('logout',$ID,'',array('do' => 'logout', 'sectok' => getSecurityToken()));
520        }else{
521          $out .= html_btn('login',$ID,'',array('do' => 'login', 'sectok' => getSecurityToken()));
522        }
523      }
524      break;
525    case 'admin':
526      if($INFO['ismanager']){
527        $out .= html_btn('admin',$ID,'',array('do' => 'admin'));
528      }
529      break;
530    case 'subscribe':
531    case 'subscription':
532      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
533        if($_SERVER['REMOTE_USER']){
534          if($INFO['subscribed']){
535            if(actionOK('unsubscribe'))
536              $out .= html_btn('unsubscribe',$ID,'',array('do' => 'unsubscribe',));
537          } else {
538            if(actionOK('subscribe'))
539              $out .= html_btn('subscribe',$ID,'',array('do' => 'subscribe',));
540          }
541        }
542      }
543      if($type == 'subscribe') break;
544      // else: fall through for backward compatibility
545    case 'subscribens':
546      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
547        if($_SERVER['REMOTE_USER']){
548          if($INFO['subscribedns']){
549            if(actionOK('unsubscribens'))
550              $out .= html_btn('unsubscribens',$ID,'',array('do' => 'unsubscribens',));
551          } else {
552            if(actionOK('subscribens'))
553              $out .= html_btn('subscribens',$ID,'',array('do' => 'subscribens',));
554          }
555        }
556      }
557      break;
558    case 'backlink':
559      if(actionOK('backlink'))
560        $out .= html_btn('backlink',$ID,'',array('do' => 'backlink'));
561    case 'profile':
562      if($conf['useacl'] && $_SERVER['REMOTE_USER'] && $auth &&
563          $auth->canDo('Profile') && ($ACT!='profile')){
564        $out .= html_btn('profile',$ID,'',array('do' => 'profile'));
565      }
566      break;
567    default:
568      $out .= '[unknown button type]';
569      break;
570  }
571  if ($return) return $out;
572  print $out;
573  return $out ? true : false;
574}
575
576/**
577 * Like the action buttons but links
578 *
579 * Available links are
580 *
581 *  edit    - edit/create/show link
582 *  history - old revisions
583 *  recent  - recent changes
584 *  login   - login/logout link - if ACL enabled
585 *  profile - user profile link (if logged in)
586 *  index   - The index
587 *  admin   - admin page - if enough rights
588 *  top     - a back to top link
589 *  back    - a back to parent link - if available
590 *  backlink - links to the list of backlinks
591 *  subscribe/subscription - subscribe/unsubscribe link
592 *
593 * @author Andreas Gohr <andi@splitbrain.org>
594 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
595 * @see    tpl_button
596 */
597function tpl_actionlink($type,$pre='',$suf='',$inner='',$return=false){
598  global $ID;
599  global $INFO;
600  global $REV;
601  global $ACT;
602  global $conf;
603  global $lang;
604  global $auth;
605
606  // check disabled actions and fix the badly named ones
607  $ctype = $type;
608  if($type == 'history') $ctype='revisions';
609  if(!actionOK($ctype)) return false;
610
611  $out = '';
612  switch($type){
613    case 'edit':
614      #most complicated type - we need to decide on current action
615      if($ACT == 'show' || $ACT == 'search'){
616        if($INFO['writable']){
617          if(!empty($INFO['draft'])) {
618            $out .= tpl_link(wl($ID,'do=draft'),
619                       $pre.(($inner)?$inner:$lang['btn_draft']).$suf,
620                       'class="action edit" accesskey="e" rel="nofollow"',1);
621          } else {
622            if($INFO['exists']){
623              $out .= tpl_link(wl($ID,'do=edit&amp;rev='.$REV),
624                       $pre.(($inner)?$inner:$lang['btn_edit']).$suf,
625                       'class="action edit" accesskey="e" rel="nofollow"',1);
626            }else{
627              $out .= tpl_link(wl($ID,'do=edit&amp;rev='.$REV),
628                       $pre.(($inner)?$inner:$lang['btn_create']).$suf,
629                       'class="action create" accesskey="e" rel="nofollow"',1);
630            }
631          }
632        }else{
633          if(actionOK('source')) //pseudo action
634            $out .= tpl_link(wl($ID,'do=edit&amp;rev='.$REV),
635                   $pre.(($inner)?$inner:$lang['btn_source']).$suf,
636                   'class="action source" accesskey="v" rel="nofollow"',1);
637        }
638      }else{
639          $out .= tpl_link(wl($ID,'do=show'),
640                   $pre.(($inner)?$inner:$lang['btn_show']).$suf,
641                   'class="action show" accesskey="v" rel="nofollow"',1);
642      }
643      break;
644    case 'history':
645      if(actionOK('revisions'))
646        $out .= tpl_link(wl($ID,'do=revisions'),
647               $pre.(($inner)?$inner:$lang['btn_revs']).$suf,
648               'class="action revisions" accesskey="o" rel="nofollow"',1);
649      break;
650    case 'recent':
651      if(actionOK('recent'))
652        $out .= tpl_link(wl($ID,'do=recent'),
653               $pre.(($inner)?$inner:$lang['btn_recent']).$suf,
654              'class="action recent" accesskey="r" rel="nofollow"',1);
655      break;
656    case 'index':
657      if(actionOK('index'))
658        $out .= tpl_link(wl($ID,'do=index'),
659               $pre.(($inner)?$inner:$lang['btn_index']).$suf,
660              'class="action index" accesskey="x" rel="nofollow"',1);
661      break;
662    case 'top':
663      $out .= '<a href="#dokuwiki__top" class="action top" accesskey="x">'.
664            $pre.(($inner)?$inner:$lang['btn_top']).$suf.'</a>';
665      break;
666    case 'back':
667      if ($parent = tpl_getparent($ID)) {
668        $out .= tpl_link(wl($parent,'do=show'),
669        $pre.(($inner)?$inner:$lang['btn_back']).$suf,
670        'class="action back" accesskey="b" rel="nofollow"',1);
671      }
672      break;
673    case 'login':
674      if($conf['useacl'] && $auth){
675        if($_SERVER['REMOTE_USER']){
676          $out .= tpl_link(wl($ID,'do=logout&amp;sectok='.getSecurityToken()),
677                   $pre.(($inner)?$inner:$lang['btn_logout']).$suf,
678                   'class="action logout" rel="nofollow"',1);
679        }else{
680          $out .= tpl_link(wl($ID,'do=login&amp;sectok='.getSecurityToken()),
681                   $pre.(($inner)?$inner:$lang['btn_login']).$suf,
682                   'class="action login" rel="nofollow"',1);
683        }
684      }
685      break;
686    case 'admin':
687      if($INFO['ismanager']){
688        $out .= tpl_link(wl($ID,'do=admin'),
689                 $pre.(($inner)?$inner:$lang['btn_admin']).$suf,
690                 'class="action admin" rel="nofollow"',1);
691      }
692      break;
693   case 'subscribe':
694   case 'subscription':
695      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
696        if($_SERVER['REMOTE_USER']){
697          if($INFO['subscribed']) {
698            if(actionOK('unsubscribe'))
699              $out .= tpl_link(wl($ID,'do=unsubscribe'),
700                     $pre.(($inner)?$inner:$lang['btn_unsubscribe']).$suf,
701                     'class="action unsubscribe" rel="nofollow"',1);
702          } else {
703            if(actionOK('subscribe'))
704              $out .= tpl_link(wl($ID,'do=subscribe'),
705                     $pre.(($inner)?$inner:$lang['btn_subscribe']).$suf,
706                     'class="action subscribe" rel="nofollow"',1);
707          }
708        }
709      }
710      if($type == 'subscribe') break;
711      // else: fall through for backward compatibility
712    case 'subscribens':
713      if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
714        if($_SERVER['REMOTE_USER']){
715          if($INFO['subscribedns']) {
716            if(actionOK('unsubscribens'))
717              $out .= tpl_link(wl($ID,'do=unsubscribens'),
718                     $pre.(($inner)?$inner:$lang['btn_unsubscribens']).$suf,
719                     'class="action unsubscribens" rel="nofollow"',1);
720          } else {
721            if(actionOK('subscribens'))
722              $out .= tpl_link(wl($ID,'do=subscribens'),
723                     $pre.(($inner)?$inner:$lang['btn_subscribens']).$suf,
724                     'class="action subscribens" rel="nofollow"',1);
725          }
726        }
727      }
728      break;
729    case 'backlink':
730      if(actionOK('backlink'))
731        $out .= tpl_link(wl($ID,'do=backlink'),
732               $pre.(($inner)?$inner:$lang['btn_backlink']).$suf,
733               'class="action backlink" rel="nofollow"',1);
734      break;
735    case 'profile':
736      if($conf['useacl'] && $auth && $_SERVER['REMOTE_USER'] &&
737         $auth->canDo('Profile') && ($ACT!='profile')){
738        $out .= tpl_link(wl($ID,'do=profile'),
739                 $pre.(($inner)?$inner:$lang['btn_profile']).$suf,
740                 'class="action profile" rel="nofollow"',1);
741      }
742      break;
743    default:
744      $out .= '[unknown link type]';
745      break;
746  }
747  if ($return) return $out;
748  print $out;
749  return $out ? true : false;
750}
751
752/**
753 * Wrapper around tpl_button() and tpl_actionlink()
754 *
755 * @author Anika Henke <anika@selfthinker.org>
756 */
757function tpl_action($type,$link=0,$wrapper=false,$return=false,$pre='',$suf='',$inner='') {
758    $out = '';
759    if ($link) $out .= tpl_actionlink($type,$pre,$suf,$inner,1);
760    else $out .= tpl_button($type,1);
761    if ($out && $wrapper) $out = "<$wrapper>$out</$wrapper>";
762
763    if ($return) return $out;
764    print $out;
765    return $out ? true : false;
766}
767
768/**
769 * Print the search form
770 *
771 * If the first parameter is given a div with the ID 'qsearch_out' will
772 * be added which instructs the ajax pagequicksearch to kick in and place
773 * its output into this div. The second parameter controls the propritary
774 * attribute autocomplete. If set to false this attribute will be set with an
775 * value of "off" to instruct the browser to disable it's own built in
776 * autocompletion feature (MSIE and Firefox)
777 *
778 * @author Andreas Gohr <andi@splitbrain.org>
779 */
780function tpl_searchform($ajax=true,$autocomplete=true){
781  global $lang;
782  global $ACT;
783
784  // don't print the search form if search action has been disabled
785  if (!actionOk('search')) return false;
786
787  print '<form action="'.wl().'" accept-charset="utf-8" class="search" id="dw__search"><div class="no">';
788  print '<input type="hidden" name="do" value="search" />';
789  print '<input type="text" ';
790  if($ACT == 'search') print 'value="'.htmlspecialchars($_REQUEST['id']).'" ';
791  if(!$autocomplete) print 'autocomplete="off" ';
792  print 'id="qsearch__in" accesskey="f" name="id" class="edit" title="[F]" />';
793  print '<input type="submit" value="'.$lang['btn_search'].'" class="button" title="'.$lang['btn_search'].'" />';
794  if($ajax) print '<div id="qsearch__out" class="ajax_qsearch JSpopup"></div>';
795  print '</div></form>';
796  return true;
797}
798
799/**
800 * Print the breadcrumbs trace
801 *
802 * @author Andreas Gohr <andi@splitbrain.org>
803 */
804function tpl_breadcrumbs($sep='&raquo;'){
805  global $lang;
806  global $conf;
807
808  //check if enabled
809  if(!$conf['breadcrumbs']) return false;
810
811  $crumbs = breadcrumbs(); //setup crumb trace
812
813  //reverse crumborder in right-to-left mode, add RLM character to fix heb/eng display mixups
814  if($lang['direction'] == 'rtl') {
815    $crumbs = array_reverse($crumbs,true);
816    $crumbs_sep = ' &#8207;<span class="bcsep">'.$sep.'</span>&#8207; ';
817  } else {
818    $crumbs_sep = ' <span class="bcsep">'.$sep.'</span> ';
819  }
820
821  //render crumbs, highlight the last one
822  print '<span class="bchead">'.$lang['breadcrumb'].':</span>';
823  $last = count($crumbs);
824  $i = 0;
825  foreach ($crumbs as $id => $name){
826    $i++;
827    echo $crumbs_sep;
828    if ($i == $last) print '<span class="curid">';
829    tpl_link(wl($id),hsc($name),'class="breadcrumbs" title="'.$id.'"');
830    if ($i == $last) print '</span>';
831  }
832  return true;
833}
834
835/**
836 * Hierarchical breadcrumbs
837 *
838 * This code was suggested as replacement for the usual breadcrumbs.
839 * It only makes sense with a deep site structure.
840 *
841 * @author Andreas Gohr <andi@splitbrain.org>
842 * @author Nigel McNie <oracle.shinoda@gmail.com>
843 * @author Sean Coates <sean@caedmon.net>
844 * @author <fredrik@averpil.com>
845 * @todo   May behave strangely in RTL languages
846 */
847function tpl_youarehere($sep=' &raquo; '){
848  global $conf;
849  global $ID;
850  global $lang;
851
852  // check if enabled
853  if(!$conf['youarehere']) return false;
854
855  $parts = explode(':', $ID);
856  $count = count($parts);
857
858  if($GLOBALS['ACT'] == 'search')
859  {
860    $parts = array($conf['start']);
861    $count = 1;
862  }
863
864  echo '<span class="bchead">'.$lang['youarehere'].': </span>';
865
866  // always print the startpage
867  $title = useHeading('navigation') ? p_get_first_heading($conf['start']) : $conf['start'];
868  if(!$title) $title = $conf['start'];
869  tpl_link(wl($conf['start']),hsc($title),'title="'.$conf['start'].'"');
870
871  // print intermediate namespace links
872  $part = '';
873  for($i=0; $i<$count - 1; $i++){
874    $part .= $parts[$i].':';
875    $page = $part;
876    resolve_pageid('',$page,$exists);
877    if ($page == $conf['start']) continue; // Skip startpage
878
879    // output
880    echo $sep;
881    if($exists){
882      $title = useHeading('navigation') ? p_get_first_heading($page) : $parts[$i];
883      tpl_link(wl($page),hsc($title),'title="'.$page.'"');
884    }else{
885      tpl_link(wl($page),$parts[$i],'title="'.$page.'" class="wikilink2" rel="nofollow"');
886    }
887  }
888
889  // print current page, skipping start page, skipping for namespace index
890  if(isset($page) && $page==$part.$parts[$i]) return;
891  $page = $part.$parts[$i];
892  if($page == $conf['start']) return;
893  echo $sep;
894  if(page_exists($page)){
895    $title = useHeading('navigation') ? p_get_first_heading($page) : $parts[$i];
896    tpl_link(wl($page),hsc($title),'title="'.$page.'"');
897  }else{
898    tpl_link(wl($page),$parts[$i],'title="'.$page.'" class="wikilink2" rel="nofollow"');
899  }
900  return true;
901}
902
903/**
904 * Print info if the user is logged in
905 * and show full name in that case
906 *
907 * Could be enhanced with a profile link in future?
908 *
909 * @author Andreas Gohr <andi@splitbrain.org>
910 */
911function tpl_userinfo(){
912  global $lang;
913  global $INFO;
914  if($_SERVER['REMOTE_USER']){
915    print $lang['loggedinas'].': '.$INFO['userinfo']['name'].' ('.$_SERVER['REMOTE_USER'].')';
916    return true;
917  }
918  return false;
919}
920
921/**
922 * Print some info about the current page
923 *
924 * @author Andreas Gohr <andi@splitbrain.org>
925 */
926function tpl_pageinfo($ret=false){
927  global $conf;
928  global $lang;
929  global $INFO;
930  global $REV;
931  global $ID;
932
933  // return if we are not allowed to view the page
934  if (!auth_quickaclcheck($ID)) { return false; }
935
936  // prepare date and path
937  $fn = $INFO['filepath'];
938  if(!$conf['fullpath']){
939    if($REV){
940      $fn = str_replace(fullpath($conf['olddir']).'/','',$fn);
941    }else{
942      $fn = str_replace(fullpath($conf['datadir']).'/','',$fn);
943    }
944  }
945  $fn = utf8_decodeFN($fn);
946  $date = strftime($conf['dformat'],$INFO['lastmod']);
947
948  // print it
949  if($INFO['exists']){
950    $out = '';
951    $out .= $fn;
952    $out .= ' &middot; ';
953    $out .= $lang['lastmod'];
954    $out .= ': ';
955    $out .= $date;
956    if($INFO['editor']){
957      $out .= ' '.$lang['by'].' ';
958      $out .= editorinfo($INFO['editor']);
959    }else{
960      $out .= ' ('.$lang['external_edit'].')';
961    }
962    if($INFO['locked']){
963      $out .= ' &middot; ';
964      $out .= $lang['lockedby'];
965      $out .= ': ';
966      $out .= editorinfo($INFO['locked']);
967    }
968    if($ret){
969        return $out;
970    }else{
971        echo $out;
972        return true;
973    }
974  }
975  return false;
976}
977
978/**
979 * Prints or returns the name of the given page (current one if none given).
980 *
981 * If useheading is enabled this will use the first headline else
982 * the given ID is used.
983 *
984 * @author Andreas Gohr <andi@splitbrain.org>
985 */
986function tpl_pagetitle($id=null, $ret=false){
987  global $conf;
988  if(is_null($id)){
989    global $ID;
990    $id = $ID;
991  }
992
993  $name = $id;
994  if (useHeading('navigation')) {
995    $title = p_get_first_heading($id);
996    if ($title) $name = $title;
997  }
998
999  if ($ret) {
1000      return hsc($name);
1001  } else {
1002      print hsc($name);
1003      return true;
1004  }
1005}
1006
1007/**
1008 * Returns the requested EXIF/IPTC tag from the current image
1009 *
1010 * If $tags is an array all given tags are tried until a
1011 * value is found. If no value is found $alt is returned.
1012 *
1013 * Which texts are known is defined in the functions _exifTagNames
1014 * and _iptcTagNames() in inc/jpeg.php (You need to prepend IPTC
1015 * to the names of the latter one)
1016 *
1017 * Only allowed in: detail.php
1018 *
1019 * @author Andreas Gohr <andi@splitbrain.org>
1020 */
1021function tpl_img_getTag($tags,$alt='',$src=null){
1022  // Init Exif Reader
1023  global $SRC;
1024
1025  if(is_null($src)) $src = $SRC;
1026
1027  static $meta = null;
1028  if(is_null($meta)) $meta = new JpegMeta($src);
1029  if($meta === false) return $alt;
1030  $info = $meta->getField($tags);
1031  if($info == false) return $alt;
1032  return $info;
1033}
1034
1035/**
1036 * Prints the image with a link to the full sized version
1037 *
1038 * Only allowed in: detail.php
1039 */
1040function tpl_img($maxwidth=0,$maxheight=0){
1041  global $IMG;
1042  $w = tpl_img_getTag('File.Width');
1043  $h = tpl_img_getTag('File.Height');
1044
1045  //resize to given max values
1046  $ratio = 1;
1047  if($w >= $h){
1048    if($maxwidth && $w >= $maxwidth){
1049      $ratio = $maxwidth/$w;
1050    }elseif($maxheight && $h > $maxheight){
1051      $ratio = $maxheight/$h;
1052    }
1053  }else{
1054    if($maxheight && $h >= $maxheight){
1055      $ratio = $maxheight/$h;
1056    }elseif($maxwidth && $w > $maxwidth){
1057      $ratio = $maxwidth/$w;
1058    }
1059  }
1060  if($ratio){
1061    $w = floor($ratio*$w);
1062    $h = floor($ratio*$h);
1063  }
1064
1065  //prepare URLs
1066  $url=ml($IMG,array('cache'=>$_REQUEST['cache']));
1067  $src=ml($IMG,array('cache'=>$_REQUEST['cache'],'w'=>$w,'h'=>$h));
1068
1069  //prepare attributes
1070  $alt=tpl_img_getTag('Simple.Title');
1071  $p = array();
1072  if($w) $p['width']  = $w;
1073  if($h) $p['height'] = $h;
1074         $p['class']  = 'img_detail';
1075  if($alt){
1076    $p['alt']   = $alt;
1077    $p['title'] = $alt;
1078  }else{
1079    $p['alt'] = '';
1080  }
1081  $p = buildAttributes($p);
1082
1083  print '<a href="'.$url.'">';
1084  print '<img src="'.$src.'" '.$p.'/>';
1085  print '</a>';
1086  return true;
1087}
1088
1089/**
1090 * This function inserts a 1x1 pixel gif which in reality
1091 * is the inexer function.
1092 *
1093 * Should be called somewhere at the very end of the main.php
1094 * template
1095 */
1096function tpl_indexerWebBug(){
1097  global $ID;
1098  global $INFO;
1099  if(!$INFO['exists']) return false;
1100
1101  if(isHiddenPage($ID)) return false; //no need to index hidden pages
1102
1103  $p = array();
1104  $p['src']    = DOKU_BASE.'lib/exe/indexer.php?id='.rawurlencode($ID).
1105                 '&'.time();
1106  $p['width']  = 1;
1107  $p['height'] = 1;
1108  $p['alt']    = '';
1109  $att = buildAttributes($p);
1110  print "<img $att />";
1111  return true;
1112}
1113
1114// configuration methods
1115/**
1116 * tpl_getConf($id)
1117 *
1118 * use this function to access template configuration variables
1119 */
1120function tpl_getConf($id){
1121  global $conf;
1122  global $tpl_configloaded;
1123
1124  $tpl = $conf['template'];
1125
1126  if (!$tpl_configloaded){
1127    $tconf = tpl_loadConfig();
1128    if ($tconf !== false){
1129      foreach ($tconf as $key => $value){
1130        if (isset($conf['tpl'][$tpl][$key])) continue;
1131        $conf['tpl'][$tpl][$key] = $value;
1132      }
1133      $tpl_configloaded = true;
1134    }
1135  }
1136
1137  return $conf['tpl'][$tpl][$id];
1138}
1139
1140/**
1141 * tpl_loadConfig()
1142 * reads all template configuration variables
1143 * this function is automatically called by tpl_getConf()
1144 */
1145function tpl_loadConfig(){
1146
1147  $file = DOKU_TPLINC.'/conf/default.php';
1148  $conf = array();
1149
1150  if (!@file_exists($file)) return false;
1151
1152  // load default config file
1153  include($file);
1154
1155  return $conf;
1156}
1157
1158/**
1159 * prints the "main content" in the mediamanger popup
1160 *
1161 * Depending on the user's actions this may be a list of
1162 * files in a namespace, the meta editing dialog or
1163 * a message of referencing pages
1164 *
1165 * Only allowed in mediamanager.php
1166 *
1167 * @author Andreas Gohr <andi@splitbrain.org>
1168 */
1169function tpl_mediaContent(){
1170  global $IMG;
1171  global $AUTH;
1172  global $INUSE;
1173  global $NS;
1174  global $JUMPTO;
1175
1176  ptln('<div id="media__content">');
1177  if($_REQUEST['edit']){
1178    media_metaform($IMG,$AUTH);
1179  }elseif(is_array($INUSE)){
1180    media_filesinuse($INUSE,$IMG);
1181  }else{
1182    media_filelist($NS,$AUTH,$JUMPTO);
1183  }
1184  ptln('</div>');
1185}
1186
1187/**
1188 * prints the namespace tree in the mediamanger popup
1189 *
1190 * Only allowed in mediamanager.php
1191 *
1192 * @author Andreas Gohr <andi@splitbrain.org>
1193 */
1194function tpl_mediaTree(){
1195  global $NS;
1196
1197  ptln('<div id="media__tree">');
1198  media_nstree($NS);
1199  ptln('</div>');
1200}
1201
1202
1203/**
1204 * Print a dropdown menu with all DokuWiki actions
1205 *
1206 * Note: this will not use any pretty URLs
1207 *
1208 * @author Andreas Gohr <andi@splitbrain.org>
1209 */
1210function tpl_actiondropdown($empty='',$button='&gt;'){
1211    global $ID;
1212    global $INFO;
1213    global $REV;
1214    global $ACT;
1215    global $conf;
1216    global $lang;
1217    global $auth;
1218
1219
1220    echo '<form method="post" accept-charset="utf-8">'; #FIXME action
1221    echo '<input type="hidden" name="id" value="'.$ID.'" />';
1222    if($REV) echo '<input type="hidden" name="rev" value="'.$REV.'" />';
1223    echo '<input type="hidden" name="sectok" value="'.getSecurityToken().'" />';
1224
1225    echo '<select name="do" id="action__selector" class="edit">';
1226    echo '<option value="">'.$empty.'</option>';
1227
1228    echo '<optgroup label=" &mdash; ">';
1229        // 'edit' - most complicated type, we need to decide on current action
1230        if($ACT == 'show' || $ACT == 'search'){
1231            if($INFO['writable']){
1232                if(!empty($INFO['draft'])) {
1233                    echo '<option value="edit">'.$lang['btn_draft'].'</option>';
1234                } else {
1235                    if($INFO['exists']){
1236                        echo '<option value="edit">'.$lang['btn_edit'].'</option>';
1237                    }else{
1238                        echo '<option value="edit">'.$lang['btn_create'].'</option>';
1239                    }
1240                }
1241            }else if(actionOK('source')) { //pseudo action
1242                echo '<option value="edit">'.$lang['btn_source'].'</option>';
1243            }
1244        }else{
1245            echo '<option value="show">'.$lang['btn_show'].'</option>';
1246        }
1247
1248        echo '<option value="revisions">'.$lang['btn_revs'].'</option>';
1249        echo '<option value="backlink">'.$lang['btn_backlink'].'</option>';
1250    echo '</optgroup>';
1251
1252    echo '<optgroup label=" &mdash; ">';
1253        echo '<option value="recent">'.$lang['btn_recent'].'</option>';
1254        echo '<option value="index">'.$lang['btn_index'].'</option>';
1255    echo '</optgroup>';
1256
1257    echo '<optgroup label=" &mdash; ">';
1258        if($conf['useacl'] && $auth){
1259            if($_SERVER['REMOTE_USER']){
1260                echo '<option value="logout">'.$lang['btn_logout'].'</option>';
1261            }else{
1262                echo '<option value="login">'.$lang['btn_login'].'</option>';
1263            }
1264        }
1265
1266        if($conf['useacl'] && $auth && $_SERVER['REMOTE_USER'] &&
1267             $auth->canDo('Profile') && ($ACT!='profile')){
1268            echo '<option value="profile">'.$lang['btn_profile'].'</option>';
1269        }
1270
1271        if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
1272            if($_SERVER['REMOTE_USER']){
1273                if($INFO['subscribed']) {
1274                    echo '<option value="unsubscribe">'.$lang['btn_unsubscribe'].'</option>';
1275                } else {
1276                    echo '<option value="subscribe">'.$lang['btn_subscribe'].'</option>';
1277                }
1278            }
1279        }
1280
1281        if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
1282            if($_SERVER['REMOTE_USER']){
1283                if($INFO['subscribedns']) {
1284                    echo '<option value="unsubscribens">'.$lang['btn_unsubscribens'].'</option>';
1285                } else {
1286                    echo '<option value="subscribens">'.$lang['btn_subscribens'].'</option>';
1287                }
1288            }
1289        }
1290
1291        if($INFO['ismanager']){
1292            echo '<option value="admin">'.$lang['btn_admin'].'</option>';
1293        }
1294    echo '</optgroup>';
1295
1296    echo '</select>';
1297    echo '<input type="submit" value="'.$button.'" id="action__selectorbtn" />';
1298    echo '</form>';
1299}
1300
1301/**
1302 * Print a informational line about the used license
1303 *
1304 * @author Andreas Gohr <andi@splitbrain.org>
1305 * @param  string $img    - print image? (|button|badge)
1306 * @param  bool   $return - when true don't print, but return HTML
1307 */
1308function tpl_license($img='badge',$imgonly=false,$return=false){
1309    global $license;
1310    global $conf;
1311    global $lang;
1312    if(!$conf['license']) return '';
1313    if(!is_array($license[$conf['license']])) return '';
1314    $lic = $license[$conf['license']];
1315
1316    $out  = '<div class="license">';
1317    if($img){
1318        $src = license_img($img);
1319        if($src){
1320            $out .= '<a href="'.$lic['url'].'" rel="license"';
1321            if($conf['target']['external']) $out .= ' target="'.$conf['target']['external'].'"';
1322            $out .= '><img src="'.DOKU_BASE.$src.'" class="medialeft lic'.$img.'" alt="'.$lic['name'].'" /></a> ';
1323        }
1324    }
1325    if(!$imgonly) {
1326        $out .= $lang['license'];
1327        $out .= '<a href="'.$lic['url'].'" rel="license" class="urlextern"';
1328        if($conf['target']['external']) $out .= ' target="'.$conf['target']['external'].'"';
1329        $out .= '>'.$lic['name'].'</a>';
1330        $out .= '</div>';
1331    }
1332
1333    if($return) return $out;
1334    echo $out;
1335}
1336
1337
1338/**
1339 * Includes the rendered XHTML of a given page
1340 *
1341 * This function is useful to populate sidebars or similar features in a
1342 * template
1343 */
1344function tpl_include_page($pageid,$print=true){
1345    global $ID;
1346    $oldid = $ID;
1347    $html = p_wiki_xhtml($pageid,'',false);
1348    $ID = $oldid;
1349
1350    if(!$print) return $html;
1351    echo $html;
1352}
1353
1354//Setup VIM: ex: et ts=4 enc=utf-8 :
1355
1356