xref: /dokuwiki/inc/template.php (revision 1af98a771b7b7c4fffb91956e37fb05e77f2a3bc) 
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 = '';
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 * Print the search form
755 *
756 * If the first parameter is given a div with the ID 'qsearch_out' will
757 * be added which instructs the ajax pagequicksearch to kick in and place
758 * its output into this div. The second parameter controls the propritary
759 * attribute autocomplete. If set to false this attribute will be set with an
760 * value of "off" to instruct the browser to disable it's own built in
761 * autocompletion feature (MSIE and Firefox)
762 *
763 * @author Andreas Gohr <andi@splitbrain.org>
764 */
765function tpl_searchform($ajax=true,$autocomplete=true){
766  global $lang;
767  global $ACT;
768
769  // don't print the search form if search action has been disabled
770  if (!actionOk('search')) return false;
771
772  print '<form action="'.wl().'" accept-charset="utf-8" class="search" id="dw__search"><div class="no">';
773  print '<input type="hidden" name="do" value="search" />';
774  print '<input type="text" ';
775  if($ACT == 'search') print 'value="'.htmlspecialchars($_REQUEST['id']).'" ';
776  if(!$autocomplete) print 'autocomplete="off" ';
777  print 'id="qsearch__in" accesskey="f" name="id" class="edit" title="[F]" />';
778  print '<input type="submit" value="'.$lang['btn_search'].'" class="button" title="'.$lang['btn_search'].'" />';
779  if($ajax) print '<div id="qsearch__out" class="ajax_qsearch JSpopup"></div>';
780  print '</div></form>';
781  return true;
782}
783
784/**
785 * Print the breadcrumbs trace
786 *
787 * @author Andreas Gohr <andi@splitbrain.org>
788 */
789function tpl_breadcrumbs($sep='&raquo;'){
790  global $lang;
791  global $conf;
792
793  //check if enabled
794  if(!$conf['breadcrumbs']) return false;
795
796  $crumbs = breadcrumbs(); //setup crumb trace
797
798  //reverse crumborder in right-to-left mode, add RLM character to fix heb/eng display mixups
799  if($lang['direction'] == 'rtl') {
800    $crumbs = array_reverse($crumbs,true);
801    $crumbs_sep = ' &#8207;<span class="bcsep">'.$sep.'</span>&#8207; ';
802  } else {
803    $crumbs_sep = ' <span class="bcsep">'.$sep.'</span> ';
804  }
805
806  //render crumbs, highlight the last one
807  print '<span class="bchead">'.$lang['breadcrumb'].':</span>';
808  $last = count($crumbs);
809  $i = 0;
810  foreach ($crumbs as $id => $name){
811    $i++;
812    echo $crumbs_sep;
813    if ($i == $last) print '<span class="curid">';
814    tpl_link(wl($id),hsc($name),'class="breadcrumbs" title="'.$id.'"');
815    if ($i == $last) print '</span>';
816  }
817  return true;
818}
819
820/**
821 * Hierarchical breadcrumbs
822 *
823 * This code was suggested as replacement for the usual breadcrumbs.
824 * It only makes sense with a deep site structure.
825 *
826 * @author Andreas Gohr <andi@splitbrain.org>
827 * @author Nigel McNie <oracle.shinoda@gmail.com>
828 * @author Sean Coates <sean@caedmon.net>
829 * @author <fredrik@averpil.com>
830 * @todo   May behave strangely in RTL languages
831 */
832function tpl_youarehere($sep=' &raquo; '){
833  global $conf;
834  global $ID;
835  global $lang;
836
837  // check if enabled
838  if(!$conf['youarehere']) return false;
839
840  $parts = explode(':', $ID);
841  $count = count($parts);
842
843  echo '<span class="bchead">'.$lang['youarehere'].': </span>';
844
845  // always print the startpage
846  $title = useHeading('navigation') ? p_get_first_heading($conf['start']) : $conf['start'];
847  if(!$title) $title = $conf['start'];
848  tpl_link(wl($conf['start']),hsc($title),'title="'.$conf['start'].'"');
849
850  // print intermediate namespace links
851  $part = '';
852  for($i=0; $i<$count - 1; $i++){
853    $part .= $parts[$i].':';
854    $page = $part;
855    resolve_pageid('',$page,$exists);
856    if ($page == $conf['start']) continue; // Skip startpage
857
858    // output
859    echo $sep;
860    if($exists){
861      $title = useHeading('navigation') ? p_get_first_heading($page) : $parts[$i];
862      tpl_link(wl($page),hsc($title),'title="'.$page.'"');
863    }else{
864      tpl_link(wl($page),$parts[$i],'title="'.$page.'" class="wikilink2" rel="nofollow"');
865    }
866  }
867
868  // print current page, skipping start page, skipping for namespace index
869  if(isset($page) && $page==$part.$parts[$i]) return;
870  $page = $part.$parts[$i];
871  if($page == $conf['start']) return;
872  echo $sep;
873  if(page_exists($page)){
874    $title = useHeading('navigation') ? p_get_first_heading($page) : $parts[$i];
875    tpl_link(wl($page),hsc($title),'title="'.$page.'"');
876  }else{
877    tpl_link(wl($page),$parts[$i],'title="'.$page.'" class="wikilink2" rel="nofollow"');
878  }
879  return true;
880}
881
882/**
883 * Print info if the user is logged in
884 * and show full name in that case
885 *
886 * Could be enhanced with a profile link in future?
887 *
888 * @author Andreas Gohr <andi@splitbrain.org>
889 */
890function tpl_userinfo(){
891  global $lang;
892  global $INFO;
893  if($_SERVER['REMOTE_USER']){
894    print $lang['loggedinas'].': '.$INFO['userinfo']['name'].' ('.$_SERVER['REMOTE_USER'].')';
895    return true;
896  }
897  return false;
898}
899
900/**
901 * Print some info about the current page
902 *
903 * @author Andreas Gohr <andi@splitbrain.org>
904 */
905function tpl_pageinfo($ret=false){
906  global $conf;
907  global $lang;
908  global $INFO;
909  global $REV;
910  global $ID;
911
912  // return if we are not allowed to view the page
913  if (!auth_quickaclcheck($ID)) { return false; }
914
915  // prepare date and path
916  $fn = $INFO['filepath'];
917  if(!$conf['fullpath']){
918    if($REV){
919      $fn = str_replace(fullpath($conf['olddir']).'/','',$fn);
920    }else{
921      $fn = str_replace(fullpath($conf['datadir']).'/','',$fn);
922    }
923  }
924  $fn = utf8_decodeFN($fn);
925  $date = strftime($conf['dformat'],$INFO['lastmod']);
926
927  // print it
928  if($INFO['exists']){
929    $out = '';
930    $out .= $fn;
931    $out .= ' &middot; ';
932    $out .= $lang['lastmod'];
933    $out .= ': ';
934    $out .= $date;
935    if($INFO['editor']){
936      $out .= ' '.$lang['by'].' ';
937      $out .= editorinfo($INFO['editor']);
938    }else{
939      $out .= ' ('.$lang['external_edit'].')';
940    }
941    if($INFO['locked']){
942      $out .= ' &middot; ';
943      $out .= $lang['lockedby'];
944      $out .= ': ';
945      $out .= editorinfo($INFO['locked']);
946    }
947    if($ret){
948        return $out;
949    }else{
950        echo $out;
951        return true;
952    }
953  }
954  return false;
955}
956
957/**
958 * Prints or returns the name of the given page (current one if none given).
959 *
960 * If useheading is enabled this will use the first headline else
961 * the given ID is used.
962 *
963 * @author Andreas Gohr <andi@splitbrain.org>
964 */
965function tpl_pagetitle($id=null, $ret=false){
966  global $conf;
967  if(is_null($id)){
968    global $ID;
969    $id = $ID;
970  }
971
972  $name = $id;
973  if (useHeading('navigation')) {
974    $title = p_get_first_heading($id);
975    if ($title) $name = $title;
976  }
977
978  if ($ret) {
979      return hsc($name);
980  } else {
981      print hsc($name);
982      return true;
983  }
984}
985
986/**
987 * Returns the requested EXIF/IPTC tag from the current image
988 *
989 * If $tags is an array all given tags are tried until a
990 * value is found. If no value is found $alt is returned.
991 *
992 * Which texts are known is defined in the functions _exifTagNames
993 * and _iptcTagNames() in inc/jpeg.php (You need to prepend IPTC
994 * to the names of the latter one)
995 *
996 * Only allowed in: detail.php
997 *
998 * @author Andreas Gohr <andi@splitbrain.org>
999 */
1000function tpl_img_getTag($tags,$alt='',$src=null){
1001  // Init Exif Reader
1002  global $SRC;
1003
1004  if(is_null($src)) $src = $SRC;
1005
1006  static $meta = null;
1007  if(is_null($meta)) $meta = new JpegMeta($src);
1008  if($meta === false) return $alt;
1009  $info = $meta->getField($tags);
1010  if($info == false) return $alt;
1011  return $info;
1012}
1013
1014/**
1015 * Prints the image with a link to the full sized version
1016 *
1017 * Only allowed in: detail.php
1018 */
1019function tpl_img($maxwidth=0,$maxheight=0){
1020  global $IMG;
1021  $w = tpl_img_getTag('File.Width');
1022  $h = tpl_img_getTag('File.Height');
1023
1024  //resize to given max values
1025  $ratio = 1;
1026  if($w >= $h){
1027    if($maxwidth && $w >= $maxwidth){
1028      $ratio = $maxwidth/$w;
1029    }elseif($maxheight && $h > $maxheight){
1030      $ratio = $maxheight/$h;
1031    }
1032  }else{
1033    if($maxheight && $h >= $maxheight){
1034      $ratio = $maxheight/$h;
1035    }elseif($maxwidth && $w > $maxwidth){
1036      $ratio = $maxwidth/$w;
1037    }
1038  }
1039  if($ratio){
1040    $w = floor($ratio*$w);
1041    $h = floor($ratio*$h);
1042  }
1043
1044  //prepare URLs
1045  $url=ml($IMG,array('cache'=>$_REQUEST['cache']));
1046  $src=ml($IMG,array('cache'=>$_REQUEST['cache'],'w'=>$w,'h'=>$h));
1047
1048  //prepare attributes
1049  $alt=tpl_img_getTag('Simple.Title');
1050  $p = array();
1051  if($w) $p['width']  = $w;
1052  if($h) $p['height'] = $h;
1053         $p['class']  = 'img_detail';
1054  if($alt){
1055    $p['alt']   = $alt;
1056    $p['title'] = $alt;
1057  }else{
1058    $p['alt'] = '';
1059  }
1060  $p = buildAttributes($p);
1061
1062  print '<a href="'.$url.'">';
1063  print '<img src="'.$src.'" '.$p.'/>';
1064  print '</a>';
1065  return true;
1066}
1067
1068/**
1069 * This function inserts a 1x1 pixel gif which in reality
1070 * is the inexer function.
1071 *
1072 * Should be called somewhere at the very end of the main.php
1073 * template
1074 */
1075function tpl_indexerWebBug(){
1076  global $ID;
1077  global $INFO;
1078  if(!$INFO['exists']) return false;
1079
1080  if(isHiddenPage($ID)) return false; //no need to index hidden pages
1081
1082  $p = array();
1083  $p['src']    = DOKU_BASE.'lib/exe/indexer.php?id='.rawurlencode($ID).
1084                 '&'.time();
1085  $p['width']  = 1;
1086  $p['height'] = 1;
1087  $p['alt']    = '';
1088  $att = buildAttributes($p);
1089  print "<img $att />";
1090  return true;
1091}
1092
1093// configuration methods
1094/**
1095 * tpl_getConf($id)
1096 *
1097 * use this function to access template configuration variables
1098 */
1099function tpl_getConf($id){
1100  global $conf;
1101  global $tpl_configloaded;
1102
1103  $tpl = $conf['template'];
1104
1105  if (!$tpl_configloaded){
1106    $tconf = tpl_loadConfig();
1107    if ($tconf !== false){
1108      foreach ($tconf as $key => $value){
1109        if (isset($conf['tpl'][$tpl][$key])) continue;
1110        $conf['tpl'][$tpl][$key] = $value;
1111      }
1112      $tpl_configloaded = true;
1113    }
1114  }
1115
1116  return $conf['tpl'][$tpl][$id];
1117}
1118
1119/**
1120 * tpl_loadConfig()
1121 * reads all template configuration variables
1122 * this function is automatically called by tpl_getConf()
1123 */
1124function tpl_loadConfig(){
1125
1126  $file = DOKU_TPLINC.'/conf/default.php';
1127  $conf = array();
1128
1129  if (!@file_exists($file)) return false;
1130
1131  // load default config file
1132  include($file);
1133
1134  return $conf;
1135}
1136
1137/**
1138 * prints the "main content" in the mediamanger popup
1139 *
1140 * Depending on the user's actions this may be a list of
1141 * files in a namespace, the meta editing dialog or
1142 * a message of referencing pages
1143 *
1144 * Only allowed in mediamanager.php
1145 *
1146 * @author Andreas Gohr <andi@splitbrain.org>
1147 */
1148function tpl_mediaContent(){
1149  global $IMG;
1150  global $AUTH;
1151  global $INUSE;
1152  global $NS;
1153  global $JUMPTO;
1154
1155  ptln('<div id="media__content">');
1156  if($_REQUEST['edit']){
1157    media_metaform($IMG,$AUTH);
1158  }elseif(is_array($INUSE)){
1159    media_filesinuse($INUSE,$IMG);
1160  }else{
1161    media_filelist($NS,$AUTH,$JUMPTO);
1162  }
1163  ptln('</div>');
1164}
1165
1166/**
1167 * prints the namespace tree in the mediamanger popup
1168 *
1169 * Only allowed in mediamanager.php
1170 *
1171 * @author Andreas Gohr <andi@splitbrain.org>
1172 */
1173function tpl_mediaTree(){
1174  global $NS;
1175
1176  ptln('<div id="media__tree">');
1177  media_nstree($NS);
1178  ptln('</div>');
1179}
1180
1181
1182/**
1183 * Print a dropdown menu with all DokuWiki actions
1184 *
1185 * Note: this will not use any pretty URLs
1186 *
1187 * @author Andreas Gohr <andi@splitbrain.org>
1188 */
1189function tpl_actiondropdown($empty='',$button='&gt;'){
1190    global $ID;
1191    global $INFO;
1192    global $REV;
1193    global $ACT;
1194    global $conf;
1195    global $lang;
1196    global $auth;
1197
1198
1199    echo '<form method="post" accept-charset="utf-8">'; #FIXME action
1200    echo '<input type="hidden" name="id" value="'.$ID.'" />';
1201    if($REV) echo '<input type="hidden" name="rev" value="'.$REV.'" />';
1202    echo '<input type="hidden" name="sectok" value="'.getSecurityToken().'" />';
1203
1204    echo '<select name="do" id="action__selector" class="edit">';
1205    echo '<option value="">'.$empty.'</option>';
1206
1207    echo '<optgroup label=" &mdash; ">';
1208        // 'edit' - most complicated type, we need to decide on current action
1209        if($ACT == 'show' || $ACT == 'search'){
1210            if($INFO['writable']){
1211                if(!empty($INFO['draft'])) {
1212                    echo '<option value="edit">'.$lang['btn_draft'].'</option>';
1213                } else {
1214                    if($INFO['exists']){
1215                        echo '<option value="edit">'.$lang['btn_edit'].'</option>';
1216                    }else{
1217                        echo '<option value="edit">'.$lang['btn_create'].'</option>';
1218                    }
1219                }
1220            }else if(actionOK('source')) { //pseudo action
1221                echo '<option value="edit">'.$lang['btn_source'].'</option>';
1222            }
1223        }else{
1224            echo '<option value="show">'.$lang['btn_show'].'</option>';
1225        }
1226
1227        echo '<option value="revisions">'.$lang['btn_revs'].'</option>';
1228        echo '<option value="backlink">'.$lang['btn_backlink'].'</option>';
1229    echo '</optgroup>';
1230
1231    echo '<optgroup label=" &mdash; ">';
1232        echo '<option value="recent">'.$lang['btn_recent'].'</option>';
1233        echo '<option value="index">'.$lang['btn_index'].'</option>';
1234    echo '</optgroup>';
1235
1236    echo '<optgroup label=" &mdash; ">';
1237        if($conf['useacl'] && $auth){
1238            if($_SERVER['REMOTE_USER']){
1239                echo '<option value="logout">'.$lang['btn_logout'].'</option>';
1240            }else{
1241                echo '<option value="login">'.$lang['btn_login'].'</option>';
1242            }
1243        }
1244
1245        if($conf['useacl'] && $auth && $_SERVER['REMOTE_USER'] &&
1246             $auth->canDo('Profile') && ($ACT!='profile')){
1247            echo '<option value="profile">'.$lang['btn_profile'].'</option>';
1248        }
1249
1250        if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
1251            if($_SERVER['REMOTE_USER']){
1252                if($INFO['subscribed']) {
1253                    echo '<option value="unsubscribe">'.$lang['btn_unsubscribe'].'</option>';
1254                } else {
1255                    echo '<option value="subscribe">'.$lang['btn_subscribe'].'</option>';
1256                }
1257            }
1258        }
1259
1260        if($conf['useacl'] && $auth && $ACT == 'show' && $conf['subscribers'] == 1){
1261            if($_SERVER['REMOTE_USER']){
1262                if($INFO['subscribedns']) {
1263                    echo '<option value="unsubscribens">'.$lang['btn_unsubscribens'].'</option>';
1264                } else {
1265                    echo '<option value="subscribens">'.$lang['btn_subscribens'].'</option>';
1266                }
1267            }
1268        }
1269
1270        if($INFO['ismanager']){
1271            echo '<option value="admin">'.$lang['btn_admin'].'</option>';
1272        }
1273    echo '</optgroup>';
1274
1275    echo '</select>';
1276    echo '<input type="submit" value="'.$button.'" id="action__selectorbtn" />';
1277    echo '</form>';
1278}
1279
1280/**
1281 * Print a informational line about the used license
1282 *
1283 * @author Andreas Gohr <andi@splitbrain.org>
1284 * @param  string $img    - print image? (|button|badge)
1285 * @param  bool   $return - when true don't print, but return HTML
1286 */
1287function tpl_license($img='badge',$imgonly=false,$return=false){
1288    global $license;
1289    global $conf;
1290    global $lang;
1291    if(!$conf['license']) return '';
1292    if(!is_array($license[$conf['license']])) return '';
1293    $lic = $license[$conf['license']];
1294
1295    $out  = '<div class="license">';
1296    if($img){
1297        $src = license_img($img);
1298        if($src){
1299            $out .= '<a href="'.$lic['url'].'" rel="license"';
1300            if($conf['target']['external']) $out .= ' target="'.$conf['target']['external'].'"';
1301            $out .= '><img src="'.DOKU_BASE.$src.'" class="medialeft lic'.$img.'" alt="'.$lic['name'].'" /></a> ';
1302        }
1303    }
1304    if(!$imgonly) {
1305        $out .= $lang['license'];
1306        $out .= '<a href="'.$lic['url'].'" rel="license" class="urlextern"';
1307        if($conf['target']['external']) $out .= ' target="'.$conf['target']['external'].'"';
1308        $out .= '>'.$lic['name'].'</a>';
1309        $out .= '</div>';
1310    }
1311
1312    if($return) return $out;
1313    echo $out;
1314}
1315
1316//Setup VIM: ex: et ts=4 enc=utf-8 :
1317
1318