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