xref: /dokuwiki/inc/template.php (revision 5267006fc0516e8787cbc6a79e55cd4efd3e52c9) 
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 * Access a template file
13 *
14 * Returns the path to the given file inside the current template, uses
15 * default template if the custom version doesn't exist.
16 *
17 * @author Andreas Gohr <andi@splitbrain.org>
18 * @param string $file
19 * @return string
20 */
21function template($file) {
22    global $conf;
23
24    if(@is_readable(DOKU_INC.'lib/tpl/'.$conf['template'].'/'.$file))
25        return DOKU_INC.'lib/tpl/'.$conf['template'].'/'.$file;
26
27    return DOKU_INC.'lib/tpl/dokuwiki/'.$file;
28}
29
30/**
31 * Convenience function to access template dir from local FS
32 *
33 * This replaces the deprecated DOKU_TPLINC constant
34 *
35 * @author Andreas Gohr <andi@splitbrain.org>
36 * @param string $tpl The template to use, default to current one
37 * @return string
38 */
39function tpl_incdir($tpl='') {
40    global $conf;
41    if(!$tpl) $tpl = $conf['template'];
42    return DOKU_INC.'lib/tpl/'.$tpl.'/';
43}
44
45/**
46 * Convenience function to access template dir from web
47 *
48 * This replaces the deprecated DOKU_TPL constant
49 *
50 * @author Andreas Gohr <andi@splitbrain.org>
51 * @param string $tpl The template to use, default to current one
52 * @return string
53 */
54function tpl_basedir($tpl='') {
55    global $conf;
56    if(!$tpl) $tpl = $conf['template'];
57    return DOKU_BASE.'lib/tpl/'.$tpl.'/';
58}
59
60/**
61 * Print the content
62 *
63 * This function is used for printing all the usual content
64 * (defined by the global $ACT var) by calling the appropriate
65 * outputfunction(s) from html.php
66 *
67 * Everything that doesn't use the main template file isn't
68 * handled by this function. ACL stuff is not done here either.
69 *
70 * @author Andreas Gohr <andi@splitbrain.org>
71 * @triggers TPL_ACT_RENDER
72 * @triggers TPL_CONTENT_DISPLAY
73 * @param bool $prependTOC should the TOC be displayed here?
74 * @return bool true if any output
75 */
76function tpl_content($prependTOC = true) {
77    global $ACT;
78    global $INFO;
79    $INFO['prependTOC'] = $prependTOC;
80
81    ob_start();
82    trigger_event('TPL_ACT_RENDER', $ACT, 'tpl_content_core');
83    $html_output = ob_get_clean();
84    trigger_event('TPL_CONTENT_DISPLAY', $html_output, 'ptln');
85
86    return !empty($html_output);
87}
88
89/**
90 * Default Action of TPL_ACT_RENDER
91 *
92 * @return bool
93 */
94function tpl_content_core() {
95    global $ACT;
96    global $TEXT;
97    global $PRE;
98    global $SUF;
99    global $SUM;
100    global $IDX;
101    global $INPUT;
102
103    switch($ACT) {
104        case 'show':
105            html_show();
106            break;
107        /** @noinspection PhpMissingBreakStatementInspection */
108        case 'locked':
109            html_locked();
110        case 'edit':
111        case 'recover':
112            html_edit();
113            break;
114        case 'preview':
115            html_edit();
116            html_show($TEXT);
117            break;
118        case 'draft':
119            html_draft();
120            break;
121        case 'search':
122            html_search();
123            break;
124        case 'revisions':
125            html_revisions($INPUT->int('first'));
126            break;
127        case 'diff':
128            html_diff();
129            break;
130        case 'recent':
131            $show_changes = $INPUT->str('show_changes');
132            if (empty($show_changes)) {
133                $show_changes = get_doku_pref('show_changes', $show_changes);
134            }
135            html_recent($INPUT->extract('first')->int('first'), $show_changes);
136            break;
137        case 'index':
138            html_index($IDX); #FIXME can this be pulled from globals? is it sanitized correctly?
139            break;
140        case 'backlink':
141            html_backlinks();
142            break;
143        case 'conflict':
144            html_conflict(con($PRE, $TEXT, $SUF), $SUM);
145            html_diff(con($PRE, $TEXT, $SUF), false);
146            break;
147        case 'login':
148            html_login();
149            break;
150        case 'register':
151            html_register();
152            break;
153        case 'resendpwd':
154            html_resendpwd();
155            break;
156        case 'denied':
157            html_denied();
158            break;
159        case 'profile' :
160            html_updateprofile();
161            break;
162        case 'admin':
163            tpl_admin();
164            break;
165        case 'subscribe':
166            tpl_subscribe();
167            break;
168        case 'media':
169            tpl_media();
170            break;
171        default:
172            $evt = new Doku_Event('TPL_ACT_UNKNOWN', $ACT);
173            if($evt->advise_before())
174                msg("Failed to handle command: ".hsc($ACT), -1);
175            $evt->advise_after();
176            unset($evt);
177            return false;
178    }
179    return true;
180}
181
182/**
183 * Places the TOC where the function is called
184 *
185 * If you use this you most probably want to call tpl_content with
186 * a false argument
187 *
188 * @author Andreas Gohr <andi@splitbrain.org>
189 * @param bool $return Should the TOC be returned instead to be printed?
190 * @return string
191 */
192function tpl_toc($return = false) {
193    global $TOC;
194    global $ACT;
195    global $ID;
196    global $REV;
197    global $INFO;
198    global $conf;
199    global $INPUT;
200    $toc = array();
201
202    if(is_array($TOC)) {
203        // if a TOC was prepared in global scope, always use it
204        $toc = $TOC;
205    } elseif(($ACT == 'show' || substr($ACT, 0, 6) == 'export') && !$REV && $INFO['exists']) {
206        // get TOC from metadata, render if neccessary
207        $meta = p_get_metadata($ID, false, METADATA_RENDER_USING_CACHE);
208        if(isset($meta['internal']['toc'])) {
209            $tocok = $meta['internal']['toc'];
210        } else {
211            $tocok = true;
212        }
213        $toc = isset($meta['description']['tableofcontents']) ? $meta['description']['tableofcontents'] : null;
214        if(!$tocok || !is_array($toc) || !$conf['tocminheads'] || count($toc) < $conf['tocminheads']) {
215            $toc = array();
216        }
217    } elseif($ACT == 'admin') {
218        // try to load admin plugin TOC FIXME: duplicates code from tpl_admin
219        $plugin = null;
220        $class  = $INPUT->str('page');
221        if(!empty($class)) {
222            $pluginlist = plugin_list('admin');
223            if(in_array($class, $pluginlist)) {
224                // attempt to load the plugin
225                /** @var $plugin DokuWiki_Admin_Plugin */
226                $plugin = plugin_load('admin', $class);
227            }
228        }
229        if( ($plugin !== null) && (!$plugin->forAdminOnly() || $INFO['isadmin']) ) {
230            $toc = $plugin->getTOC();
231            $TOC = $toc; // avoid later rebuild
232        }
233    }
234
235    trigger_event('TPL_TOC_RENDER', $toc, null, false);
236    $html = html_TOC($toc);
237    if($return) return $html;
238    echo $html;
239    return '';
240}
241
242/**
243 * Handle the admin page contents
244 *
245 * @author Andreas Gohr <andi@splitbrain.org>
246 */
247function tpl_admin() {
248    global $INFO;
249    global $TOC;
250    global $INPUT;
251
252    $plugin = null;
253    $class  = $INPUT->str('page');
254    if(!empty($class)) {
255        $pluginlist = plugin_list('admin');
256
257        if(in_array($class, $pluginlist)) {
258            // attempt to load the plugin
259            /** @var $plugin DokuWiki_Admin_Plugin */
260            $plugin = plugin_load('admin', $class);
261        }
262    }
263
264    if($plugin !== null) {
265        if(!is_array($TOC)) $TOC = $plugin->getTOC(); //if TOC wasn't requested yet
266        if($INFO['prependTOC']) tpl_toc();
267        $plugin->html();
268    } else {
269        html_admin();
270    }
271    return true;
272}
273
274/**
275 * Print the correct HTML meta headers
276 *
277 * This has to go into the head section of your template.
278 *
279 * @author Andreas Gohr <andi@splitbrain.org>
280 * @triggers TPL_METAHEADER_OUTPUT
281 * @param  bool $alt Should feeds and alternative format links be added?
282 * @return bool
283 */
284function tpl_metaheaders($alt = true) {
285    global $ID;
286    global $REV;
287    global $INFO;
288    global $JSINFO;
289    global $ACT;
290    global $QUERY;
291    global $lang;
292    global $conf;
293    global $updateVersion;
294    /** @var Input $INPUT */
295    global $INPUT;
296
297    // prepare the head array
298    $head = array();
299
300    // prepare seed for js and css
301    $tseed   = $updateVersion;
302    $depends = getConfigFiles('main');
303    foreach($depends as $f) $tseed .= @filemtime($f);
304    $tseed   = md5($tseed);
305
306    // the usual stuff
307    $head['meta'][] = array('name'=> 'generator', 'content'=> 'DokuWiki');
308    $head['link'][] = array(
309        'rel' => 'search', 'type'=> 'application/opensearchdescription+xml',
310        'href'=> DOKU_BASE.'lib/exe/opensearch.php', 'title'=> $conf['title']
311    );
312    $head['link'][] = array('rel'=> 'start', 'href'=> DOKU_BASE);
313    if(actionOK('index')) {
314        $head['link'][] = array(
315            'rel'  => 'contents', 'href'=> wl($ID, 'do=index', false, '&'),
316            'title'=> $lang['btn_index']
317        );
318    }
319
320    if($alt) {
321        $head['link'][] = array(
322            'rel'  => 'alternate', 'type'=> 'application/rss+xml',
323            'title'=> $lang['btn_recent'], 'href'=> DOKU_BASE.'feed.php'
324        );
325        $head['link'][] = array(
326            'rel'  => 'alternate', 'type'=> 'application/rss+xml',
327            'title'=> $lang['currentns'],
328            'href' => DOKU_BASE.'feed.php?mode=list&ns='.$INFO['namespace']
329        );
330        if(($ACT == 'show' || $ACT == 'search') && $INFO['writable']) {
331            $head['link'][] = array(
332                'rel'  => 'edit',
333                'title'=> $lang['btn_edit'],
334                'href' => wl($ID, 'do=edit', false, '&')
335            );
336        }
337
338        if($ACT == 'search') {
339            $head['link'][] = array(
340                'rel'  => 'alternate', 'type'=> 'application/rss+xml',
341                'title'=> $lang['searchresult'],
342                'href' => DOKU_BASE.'feed.php?mode=search&q='.$QUERY
343            );
344        }
345
346        if(actionOK('export_xhtml')) {
347            $head['link'][] = array(
348                'rel' => 'alternate', 'type'=> 'text/html', 'title'=> $lang['plainhtml'],
349                'href'=> exportlink($ID, 'xhtml', '', false, '&')
350            );
351        }
352
353        if(actionOK('export_raw')) {
354            $head['link'][] = array(
355                'rel' => 'alternate', 'type'=> 'text/plain', 'title'=> $lang['wikimarkup'],
356                'href'=> exportlink($ID, 'raw', '', false, '&')
357            );
358        }
359    }
360
361    // setup robot tags apropriate for different modes
362    if(($ACT == 'show' || $ACT == 'export_xhtml') && !$REV) {
363        if($INFO['exists']) {
364            //delay indexing:
365            if((time() - $INFO['lastmod']) >= $conf['indexdelay']) {
366                $head['meta'][] = array('name'=> 'robots', 'content'=> 'index,follow');
367            } else {
368                $head['meta'][] = array('name'=> 'robots', 'content'=> 'noindex,nofollow');
369            }
370            $head['link'][] = array('rel'=> 'canonical', 'href'=> wl($ID, '', true, '&'));
371        } else {
372            $head['meta'][] = array('name'=> 'robots', 'content'=> 'noindex,follow');
373        }
374    } elseif(defined('DOKU_MEDIADETAIL')) {
375        $head['meta'][] = array('name'=> 'robots', 'content'=> 'index,follow');
376    } else {
377        $head['meta'][] = array('name'=> 'robots', 'content'=> 'noindex,nofollow');
378    }
379
380    // set metadata
381    if($ACT == 'show' || $ACT == 'export_xhtml') {
382        // date of modification
383        if($REV) {
384            $head['meta'][] = array('name'=> 'date', 'content'=> date('Y-m-d\TH:i:sO', $REV));
385        } else {
386            $head['meta'][] = array('name'=> 'date', 'content'=> date('Y-m-d\TH:i:sO', $INFO['lastmod']));
387        }
388
389        // keywords (explicit or implicit)
390        if(!empty($INFO['meta']['subject'])) {
391            $head['meta'][] = array('name'=> 'keywords', 'content'=> join(',', $INFO['meta']['subject']));
392        } else {
393            $head['meta'][] = array('name'=> 'keywords', 'content'=> str_replace(':', ',', $ID));
394        }
395    }
396
397    // load stylesheets
398    $head['link'][] = array(
399        'rel' => 'stylesheet', 'type'=> 'text/css',
400        'href'=> DOKU_BASE.'lib/exe/css.php?t='.$conf['template'].'&tseed='.$tseed
401    );
402
403    // make $INFO and other vars available to JavaScripts
404    $json   = new JSON();
405    $script = "var NS='".$INFO['namespace']."';";
406    if($conf['useacl'] && $INPUT->server->str('REMOTE_USER')) {
407        $script .= "var SIG='".toolbar_signature()."';";
408    }
409    $script .= 'var JSINFO = '.$json->encode($JSINFO).';';
410    $head['script'][] = array('type'=> 'text/javascript', '_data'=> $script);
411
412    // load external javascript
413    $head['script'][] = array(
414        'type'=> 'text/javascript', 'charset'=> 'utf-8', '_data'=> '',
415        'src' => DOKU_BASE.'lib/exe/js.php'.'?tseed='.$tseed
416    );
417
418    // trigger event here
419    trigger_event('TPL_METAHEADER_OUTPUT', $head, '_tpl_metaheaders_action', true);
420    return true;
421}
422
423/**
424 * prints the array build by tpl_metaheaders
425 *
426 * $data is an array of different header tags. Each tag can have multiple
427 * instances. Attributes are given as key value pairs. Values will be HTML
428 * encoded automatically so they should be provided as is in the $data array.
429 *
430 * For tags having a body attribute specify the the body data in the special
431 * attribute '_data'. This field will NOT BE ESCAPED automatically.
432 *
433 * @author Andreas Gohr <andi@splitbrain.org>
434 */
435function _tpl_metaheaders_action($data) {
436    foreach($data as $tag => $inst) {
437        foreach($inst as $attr) {
438            echo '<', $tag, ' ', buildAttributes($attr);
439            if(isset($attr['_data']) || $tag == 'script') {
440                if($tag == 'script' && $attr['_data'])
441                    $attr['_data'] = "/*<![CDATA[*/".
442                        $attr['_data'].
443                        "\n/*!]]>*/";
444
445                echo '>', $attr['_data'], '</', $tag, '>';
446            } else {
447                echo '/>';
448            }
449            echo "\n";
450        }
451    }
452}
453
454/**
455 * Print a link
456 *
457 * Just builds a link.
458 *
459 * @author Andreas Gohr <andi@splitbrain.org>
460 */
461function tpl_link($url, $name, $more = '', $return = false) {
462    $out = '<a href="'.$url.'" ';
463    if($more) $out .= ' '.$more;
464    $out .= ">$name</a>";
465    if($return) return $out;
466    print $out;
467    return true;
468}
469
470/**
471 * Prints a link to a WikiPage
472 *
473 * Wrapper around html_wikilink
474 *
475 * @author Andreas Gohr <andi@splitbrain.org>
476 */
477function tpl_pagelink($id, $name = null) {
478    print '<bdi>'.html_wikilink($id, $name).'</bdi>';
479    return true;
480}
481
482/**
483 * get the parent page
484 *
485 * Tries to find out which page is parent.
486 * returns false if none is available
487 *
488 * @author Andreas Gohr <andi@splitbrain.org>
489 */
490function tpl_getparent($id) {
491    $parent = getNS($id).':';
492    resolve_pageid('', $parent, $exists);
493    if($parent == $id) {
494        $pos    = strrpos(getNS($id), ':');
495        $parent = substr($parent, 0, $pos).':';
496        resolve_pageid('', $parent, $exists);
497        if($parent == $id) return false;
498    }
499    return $parent;
500}
501
502/**
503 * Print one of the buttons
504 *
505 * @author Adrian Lang <mail@adrianlang.de>
506 * @see    tpl_get_action
507 */
508function tpl_button($type, $return = false) {
509    $data = tpl_get_action($type);
510    if($data === false) {
511        return false;
512    } elseif(!is_array($data)) {
513        $out = sprintf($data, 'button');
514    } else {
515        /**
516         * @var string $accesskey
517         * @var string $id
518         * @var string $method
519         * @var array  $params
520         */
521        extract($data);
522        if($id === '#dokuwiki__top') {
523            $out = html_topbtn();
524        } else {
525            $out = html_btn($type, $id, $accesskey, $params, $method);
526        }
527    }
528    if($return) return $out;
529    echo $out;
530    return true;
531}
532
533/**
534 * Like the action buttons but links
535 *
536 * @author Adrian Lang <mail@adrianlang.de>
537 * @see    tpl_get_action
538 */
539function tpl_actionlink($type, $pre = '', $suf = '', $inner = '', $return = false) {
540    global $lang;
541    $data = tpl_get_action($type);
542    if($data === false) {
543        return false;
544    } elseif(!is_array($data)) {
545        $out = sprintf($data, 'link');
546    } else {
547        /**
548         * @var string $accesskey
549         * @var string $id
550         * @var string $method
551         * @var bool   $nofollow
552         * @var array  $params
553         * @var string $replacement
554         */
555        extract($data);
556        if(strpos($id, '#') === 0) {
557            $linktarget = $id;
558        } else {
559            $linktarget = wl($id, $params);
560        }
561        $caption = $lang['btn_'.$type];
562        if(strpos($caption, '%s')){
563            $caption = sprintf($caption, $replacement);
564        }
565        $akey    = $addTitle = '';
566        if($accesskey) {
567            $akey     = 'accesskey="'.$accesskey.'" ';
568            $addTitle = ' ['.strtoupper($accesskey).']';
569        }
570        $rel = $nofollow ? 'rel="nofollow" ' : '';
571        $out = tpl_link(
572            $linktarget, $pre.(($inner) ? $inner : $caption).$suf,
573            'class="action '.$type.'" '.
574                $akey.$rel.
575                'title="'.hsc($caption).$addTitle.'"', 1
576        );
577    }
578    if($return) return $out;
579    echo $out;
580    return true;
581}
582
583/**
584 * Check the actions and get data for buttons and links
585 *
586 * Available actions are
587 *
588 *  edit        - edit/create/show/draft
589 *  history     - old revisions
590 *  recent      - recent changes
591 *  login       - login/logout - if ACL enabled
592 *  profile     - user profile (if logged in)
593 *  index       - The index
594 *  admin       - admin page - if enough rights
595 *  top         - back to top
596 *  back        - back to parent - if available
597 *  backlink    - links to the list of backlinks
598 *  subscribe/subscription- subscribe/unsubscribe
599 *
600 * @author Andreas Gohr <andi@splitbrain.org>
601 * @author Matthias Grimm <matthiasgrimm@users.sourceforge.net>
602 * @author Adrian Lang <mail@adrianlang.de>
603 * @param string $type
604 * @return array|bool|string
605 */
606function tpl_get_action($type) {
607    global $ID;
608    global $INFO;
609    global $REV;
610    global $ACT;
611    global $conf;
612    /** @var Input $INPUT */
613    global $INPUT;
614
615    // check disabled actions and fix the badly named ones
616    if($type == 'history') $type = 'revisions';
617    if ($type == 'subscription') $type = 'subscribe';
618    if(!actionOK($type)) return false;
619
620    $accesskey   = null;
621    $id          = $ID;
622    $method      = 'get';
623    $params      = array('do' => $type);
624    $nofollow    = true;
625    $replacement = '';
626    switch($type) {
627        case 'edit':
628            // most complicated type - we need to decide on current action
629            if($ACT == 'show' || $ACT == 'search') {
630                $method = 'post';
631                if($INFO['writable']) {
632                    $accesskey = 'e';
633                    if(!empty($INFO['draft'])) {
634                        $type         = 'draft';
635                        $params['do'] = 'draft';
636                    } else {
637                        $params['rev'] = $REV;
638                        if(!$INFO['exists']) {
639                            $type = 'create';
640                        }
641                    }
642                } else {
643                    if(!actionOK('source')) return false; //pseudo action
644                    $params['rev'] = $REV;
645                    $type          = 'source';
646                    $accesskey     = 'v';
647                }
648            } else {
649                $params    = array('do' => '');
650                $type      = 'show';
651                $accesskey = 'v';
652            }
653            break;
654        case 'revisions':
655            $type      = 'revs';
656            $accesskey = 'o';
657            break;
658        case 'recent':
659            $accesskey = 'r';
660            break;
661        case 'index':
662            $accesskey = 'x';
663            // allow searchbots to get to the sitemap from the homepage (when dokuwiki isn't providing a sitemap.xml)
664            if ($conf['start'] == $ID && !$conf['sitemap']) {
665                $nofollow = false;
666            }
667            break;
668        case 'top':
669            $accesskey = 't';
670            $params    = array('do' => '');
671            $id        = '#dokuwiki__top';
672            break;
673        case 'back':
674            $parent = tpl_getparent($ID);
675            if(!$parent) {
676                return false;
677            }
678            $id        = $parent;
679            $params    = array('do' => '');
680            $accesskey = 'b';
681            break;
682        case 'img_backto':
683            $params = array();
684            $accesskey = 'b';
685            $replacement = $ID;
686            break;
687        case 'login':
688            $params['sectok'] = getSecurityToken();
689            if($INPUT->server->has('REMOTE_USER')) {
690                if(!actionOK('logout')) {
691                    return false;
692                }
693                $params['do'] = 'logout';
694                $type         = 'logout';
695            }
696            break;
697        case 'register':
698            if($INPUT->server->str('REMOTE_USER')) {
699                return false;
700            }
701            break;
702        case 'resendpwd':
703            if($INPUT->server->str('REMOTE_USER')) {
704                return false;
705            }
706            break;
707        case 'admin':
708            if(!$INFO['ismanager']) {
709                return false;
710            }
711            break;
712        case 'revert':
713            if(!$INFO['ismanager'] || !$REV || !$INFO['writable']) {
714                return false;
715            }
716            $params['rev']    = $REV;
717            $params['sectok'] = getSecurityToken();
718            break;
719        case 'subscribe':
720            if(!$INPUT->server->str('REMOTE_USER')) {
721                return false;
722            }
723            break;
724        case 'backlink':
725            break;
726        case 'profile':
727            if(!$INPUT->server->has('REMOTE_USER')) {
728                return false;
729            }
730            break;
731        case 'media':
732            $params['ns'] = getNS($ID);
733            break;
734        case 'mediaManager':
735            // View image in media manager
736            global $IMG;
737            $imgNS = getNS($IMG);
738            $authNS = auth_quickaclcheck("$imgNS:*");
739            if ($authNS < AUTH_UPLOAD) {
740                return false;
741            }
742            $params = array(
743                'ns' => $imgNS,
744                'image' => $IMG,
745                'do' => 'media'
746            );
747            //$type = 'media';
748            break;
749        default:
750            return '[unknown %s type]';
751            break;
752    }
753    return compact('accesskey', 'type', 'id', 'method', 'params', 'nofollow', 'replacement');
754}
755
756/**
757 * Wrapper around tpl_button() and tpl_actionlink()
758 *
759 * @author Anika Henke <anika@selfthinker.org>
760 * @param
761 * @param bool   $link link or form button?
762 * @param bool   $wrapper HTML element wrapper
763 * @param bool   $return return or print
764 * @param string $pre prefix for links
765 * @param string $suf suffix for links
766 * @param string $inner inner HTML for links
767 * @return bool|string
768 */
769function tpl_action($type, $link = false, $wrapper = false, $return = false, $pre = '', $suf = '', $inner = '') {
770    $out = '';
771    if($link) {
772        $out .= tpl_actionlink($type, $pre, $suf, $inner, 1);
773    } else {
774        $out .= tpl_button($type, 1);
775    }
776    if($out && $wrapper) $out = "<$wrapper>$out</$wrapper>";
777
778    if($return) return $out;
779    print $out;
780    return $out ? true : false;
781}
782
783/**
784 * Print the search form
785 *
786 * If the first parameter is given a div with the ID 'qsearch_out' will
787 * be added which instructs the ajax pagequicksearch to kick in and place
788 * its output into this div. The second parameter controls the propritary
789 * attribute autocomplete. If set to false this attribute will be set with an
790 * value of "off" to instruct the browser to disable it's own built in
791 * autocompletion feature (MSIE and Firefox)
792 *
793 * @author Andreas Gohr <andi@splitbrain.org>
794 * @param bool $ajax
795 * @param bool $autocomplete
796 * @return bool
797 */
798function tpl_searchform($ajax = true, $autocomplete = true) {
799    global $lang;
800    global $ACT;
801    global $QUERY;
802
803    // don't print the search form if search action has been disabled
804    if(!actionOK('search')) return false;
805
806    print '<form action="'.wl().'" accept-charset="utf-8" class="search" id="dw__search" method="get" role="search"><div class="no">';
807    print '<input type="hidden" name="do" value="search" />';
808    print '<input type="text" ';
809    if($ACT == 'search') print 'value="'.htmlspecialchars($QUERY).'" ';
810    if(!$autocomplete) print 'autocomplete="off" ';
811    print 'id="qsearch__in" accesskey="f" name="id" class="edit" title="[F]" />';
812    print '<input type="submit" value="'.$lang['btn_search'].'" class="button" title="'.$lang['btn_search'].'" />';
813    if($ajax) print '<div id="qsearch__out" class="ajax_qsearch JSpopup"></div>';
814    print '</div></form>';
815    return true;
816}
817
818/**
819 * Print the breadcrumbs trace
820 *
821 * @author Andreas Gohr <andi@splitbrain.org>
822 * @param string $sep Separator between entries
823 * @return bool
824 */
825function tpl_breadcrumbs($sep = '•') {
826    global $lang;
827    global $conf;
828
829    //check if enabled
830    if(!$conf['breadcrumbs']) return false;
831
832    $crumbs = breadcrumbs(); //setup crumb trace
833
834    $crumbs_sep = ' <span class="bcsep">'.$sep.'</span> ';
835
836    //render crumbs, highlight the last one
837    print '<span class="bchead">'.$lang['breadcrumb'].':</span>';
838    $last = count($crumbs);
839    $i    = 0;
840    foreach($crumbs as $id => $name) {
841        $i++;
842        echo $crumbs_sep;
843        if($i == $last) print '<span class="curid">';
844        print '<bdi>';
845        tpl_link(wl($id), hsc($name), 'class="breadcrumbs" title="'.$id.'"');
846        print '</bdi>';
847        if($i == $last) print '</span>';
848    }
849    return true;
850}
851
852/**
853 * Hierarchical breadcrumbs
854 *
855 * This code was suggested as replacement for the usual breadcrumbs.
856 * It only makes sense with a deep site structure.
857 *
858 * @author Andreas Gohr <andi@splitbrain.org>
859 * @author Nigel McNie <oracle.shinoda@gmail.com>
860 * @author Sean Coates <sean@caedmon.net>
861 * @author <fredrik@averpil.com>
862 * @todo   May behave strangely in RTL languages
863 * @param string $sep Separator between entries
864 * @return bool
865 */
866function tpl_youarehere($sep = ' » ') {
867    global $conf;
868    global $ID;
869    global $lang;
870
871    // check if enabled
872    if(!$conf['youarehere']) return false;
873
874    $parts = explode(':', $ID);
875    $count = count($parts);
876
877    echo '<span class="bchead">'.$lang['youarehere'].': </span>';
878
879    // always print the startpage
880    echo '<span class="home">';
881    tpl_pagelink(':'.$conf['start']);
882    echo '</span>';
883
884    // print intermediate namespace links
885    $part = '';
886    for($i = 0; $i < $count - 1; $i++) {
887        $part .= $parts[$i].':';
888        $page = $part;
889        if($page == $conf['start']) continue; // Skip startpage
890
891        // output
892        echo $sep;
893        tpl_pagelink($page);
894    }
895
896    // print current page, skipping start page, skipping for namespace index
897    resolve_pageid('', $page, $exists);
898    if(isset($page) && $page == $part.$parts[$i]) return true;
899    $page = $part.$parts[$i];
900    if($page == $conf['start']) return true;
901    echo $sep;
902    tpl_pagelink($page);
903    return true;
904}
905
906/**
907 * Print info if the user is logged in
908 * and show full name in that case
909 *
910 * Could be enhanced with a profile link in future?
911 *
912 * @author Andreas Gohr <andi@splitbrain.org>
913 * @return bool
914 */
915function tpl_userinfo() {
916    global $lang;
917    /** @var Input $INPUT */
918    global $INPUT;
919
920    if($INPUT->server->str('REMOTE_USER')) {
921        print $lang['loggedinas'].': '.userlink();
922        return true;
923    }
924    return false;
925}
926
927/**
928 * Print some info about the current page
929 *
930 * @author Andreas Gohr <andi@splitbrain.org>
931 * @param bool $ret return content instead of printing it
932 * @return bool|string
933 */
934function tpl_pageinfo($ret = false) {
935    global $conf;
936    global $lang;
937    global $INFO;
938    global $ID;
939
940    // return if we are not allowed to view the page
941    if(!auth_quickaclcheck($ID)) {
942        return false;
943    }
944
945    // prepare date and path
946    $fn = $INFO['filepath'];
947    if(!$conf['fullpath']) {
948        if($INFO['rev']) {
949            $fn = str_replace(fullpath($conf['olddir']).'/', '', $fn);
950        } else {
951            $fn = str_replace(fullpath($conf['datadir']).'/', '', $fn);
952        }
953    }
954    $fn   = utf8_decodeFN($fn);
955    $date = dformat($INFO['lastmod']);
956
957    // print it
958    if($INFO['exists']) {
959        $out = '';
960        $out .= '<bdi>'.$fn.'</bdi>';
961        $out .= ' · ';
962        $out .= $lang['lastmod'];
963        $out .= ': ';
964        $out .= $date;
965        if($INFO['editor']) {
966            $out .= ' '.$lang['by'].' ';
967            $out .= '<bdi>'.editorinfo($INFO['editor']).'</bdi>';
968        } else {
969            $out .= ' ('.$lang['external_edit'].')';
970        }
971        if($INFO['locked']) {
972            $out .= ' · ';
973            $out .= $lang['lockedby'];
974            $out .= ': ';
975            $out .= '<bdi>'.editorinfo($INFO['locked']).'</bdi>';
976        }
977        if($ret) {
978            return $out;
979        } else {
980            echo $out;
981            return true;
982        }
983    }
984    return false;
985}
986
987/**
988 * Prints or returns the name of the given page (current one if none given).
989 *
990 * If useheading is enabled this will use the first headline else
991 * the given ID is used.
992 *
993 * @author Andreas Gohr <andi@splitbrain.org>
994 * @param string $id page id
995 * @param bool   $ret return content instead of printing
996 * @return bool|string
997 */
998function tpl_pagetitle($id = null, $ret = false) {
999    if(is_null($id)) {
1000        global $ID;
1001        $id = $ID;
1002    }
1003
1004    $name = $id;
1005    if(useHeading('navigation')) {
1006        $title = p_get_first_heading($id);
1007        if($title) $name = $title;
1008    }
1009
1010    if($ret) {
1011        return hsc($name);
1012    } else {
1013        print hsc($name);
1014        return true;
1015    }
1016}
1017
1018/**
1019 * Returns the requested EXIF/IPTC tag from the current image
1020 *
1021 * If $tags is an array all given tags are tried until a
1022 * value is found. If no value is found $alt is returned.
1023 *
1024 * Which texts are known is defined in the functions _exifTagNames
1025 * and _iptcTagNames() in inc/jpeg.php (You need to prepend IPTC
1026 * to the names of the latter one)
1027 *
1028 * Only allowed in: detail.php
1029 *
1030 * @author Andreas Gohr <andi@splitbrain.org>
1031 * @param array  $tags tags to try
1032 * @param string $alt alternative output if no data was found
1033 * @param null   $src the image src, uses global $SRC if not given
1034 * @return string
1035 */
1036function tpl_img_getTag($tags, $alt = '', $src = null) {
1037    // Init Exif Reader
1038    global $SRC;
1039
1040    if(is_null($src)) $src = $SRC;
1041
1042    static $meta = null;
1043    if(is_null($meta)) $meta = new JpegMeta($src);
1044    if($meta === false) return $alt;
1045    $info = $meta->getField($tags);
1046    if($info == false) return $alt;
1047    return $info;
1048}
1049
1050/**
1051 * Returns a description list of the metatags of the current image
1052 *
1053 * @return string html of description list
1054 */
1055function tpl_img_meta() {
1056    global $lang;
1057
1058    $tags = tpl_get_img_meta();
1059
1060    echo '<dl>';
1061    foreach($tags as $tag) {
1062        $label = $lang[$tag['langkey']];
1063        if(!$label) $label = $tag['langkey'];
1064
1065        echo '<dt>'.$label.':</dt><dd>';
1066        if ($tag['type'] == 'date') {
1067            echo dformat($tag['value']);
1068        } else {
1069            echo hsc($tag['value']);
1070        }
1071        echo '</dd>';
1072    }
1073    echo '</dl>';
1074}
1075
1076/**
1077 * Returns metadata as configured in mediameta config file, ready for creating html
1078 *
1079 * @return array with arrays containing the entries:
1080 *   - string langkey  key to lookup in the $lang var, if not found printed as is
1081 *   - string type     type of value
1082 *   - string value    tag value (unescaped)
1083 */
1084function tpl_get_img_meta() {
1085
1086    $config_files = getConfigFiles('mediameta');
1087    foreach ($config_files as $config_file) {
1088        if(@file_exists($config_file)) {
1089            include($config_file);
1090        }
1091    }
1092    /** @var array $fields the included array with metadata */
1093
1094    $tags = array();
1095    foreach($fields as $tag){
1096        $t = array();
1097        if (!empty($tag[0])) {
1098            $t = array($tag[0]);
1099        }
1100        if(is_array($tag[3])) {
1101            $t = array_merge($t,$tag[3]);
1102        }
1103        $value = tpl_img_getTag($t);
1104        if ($value) {
1105            $tags[] = array('langkey' => $tag[1], 'type' => $tag[2], 'value' => $value);
1106        }
1107    }
1108    return $tags;
1109}
1110
1111/**
1112 * Prints the image with a link to the full sized version
1113 *
1114 * Only allowed in: detail.php
1115 *
1116 * @triggers TPL_IMG_DISPLAY
1117 * @param $maxwidth  int - maximal width of the image
1118 * @param $maxheight int - maximal height of the image
1119 * @param $link bool     - link to the orginal size?
1120 * @param $params array  - additional image attributes
1121 * @return mixed Result of TPL_IMG_DISPLAY
1122 */
1123function tpl_img($maxwidth = 0, $maxheight = 0, $link = true, $params = null) {
1124    global $IMG;
1125    /** @var Input $INPUT */
1126    global $INPUT;
1127    $w = tpl_img_getTag('File.Width');
1128    $h = tpl_img_getTag('File.Height');
1129
1130    //resize to given max values
1131    $ratio = 1;
1132    if($w >= $h) {
1133        if($maxwidth && $w >= $maxwidth) {
1134            $ratio = $maxwidth / $w;
1135        } elseif($maxheight && $h > $maxheight) {
1136            $ratio = $maxheight / $h;
1137        }
1138    } else {
1139        if($maxheight && $h >= $maxheight) {
1140            $ratio = $maxheight / $h;
1141        } elseif($maxwidth && $w > $maxwidth) {
1142            $ratio = $maxwidth / $w;
1143        }
1144    }
1145    if($ratio) {
1146        $w = floor($ratio * $w);
1147        $h = floor($ratio * $h);
1148    }
1149
1150    //prepare URLs
1151    $url = ml($IMG, array('cache'=> $INPUT->str('cache')), true, '&');
1152    $src = ml($IMG, array('cache'=> $INPUT->str('cache'), 'w'=> $w, 'h'=> $h), true, '&');
1153
1154    //prepare attributes
1155    $alt = tpl_img_getTag('Simple.Title');
1156    if(is_null($params)) {
1157        $p = array();
1158    } else {
1159        $p = $params;
1160    }
1161    if($w) $p['width'] = $w;
1162    if($h) $p['height'] = $h;
1163    $p['class'] = 'img_detail';
1164    if($alt) {
1165        $p['alt']   = $alt;
1166        $p['title'] = $alt;
1167    } else {
1168        $p['alt'] = '';
1169    }
1170    $p['src'] = $src;
1171
1172    $data = array('url'=> ($link ? $url : null), 'params'=> $p);
1173    return trigger_event('TPL_IMG_DISPLAY', $data, '_tpl_img_action', true);
1174}
1175
1176/**
1177 * Default action for TPL_IMG_DISPLAY
1178 *
1179 * @param array $data
1180 * @return bool
1181 */
1182function _tpl_img_action($data) {
1183    global $lang;
1184    $p = buildAttributes($data['params']);
1185
1186    if($data['url']) print '<a href="'.hsc($data['url']).'" title="'.$lang['mediaview'].'">';
1187    print '<img '.$p.'/>';
1188    if($data['url']) print '</a>';
1189    return true;
1190}
1191
1192/**
1193 * This function inserts a small gif which in reality is the indexer function.
1194 *
1195 * Should be called somewhere at the very end of the main.php
1196 * template
1197 *
1198 * @return bool
1199 */
1200function tpl_indexerWebBug() {
1201    global $ID;
1202
1203    $p           = array();
1204    $p['src']    = DOKU_BASE.'lib/exe/indexer.php?id='.rawurlencode($ID).
1205        '&'.time();
1206    $p['width']  = 2; //no more 1x1 px image because we live in times of ad blockers...
1207    $p['height'] = 1;
1208    $p['alt']    = '';
1209    $att         = buildAttributes($p);
1210    print "<img $att />";
1211    return true;
1212}
1213
1214/**
1215 * tpl_getConf($id)
1216 *
1217 * use this function to access template configuration variables
1218 *
1219 * @param string $id      name of the value to access
1220 * @param mixed  $notset  what to return if the setting is not available
1221 * @return mixed
1222 */
1223function tpl_getConf($id, $notset=false) {
1224    global $conf;
1225    static $tpl_configloaded = false;
1226
1227    $tpl = $conf['template'];
1228
1229    if(!$tpl_configloaded) {
1230        $tconf = tpl_loadConfig();
1231        if($tconf !== false) {
1232            foreach($tconf as $key => $value) {
1233                if(isset($conf['tpl'][$tpl][$key])) continue;
1234                $conf['tpl'][$tpl][$key] = $value;
1235            }
1236            $tpl_configloaded = true;
1237        }
1238    }
1239
1240    if(isset($conf['tpl'][$tpl][$id])){
1241        return $conf['tpl'][$tpl][$id];
1242    }
1243
1244    return $notset;
1245}
1246
1247/**
1248 * tpl_loadConfig()
1249 *
1250 * reads all template configuration variables
1251 * this function is automatically called by tpl_getConf()
1252 *
1253 * @return array
1254 */
1255function tpl_loadConfig() {
1256
1257    $file = tpl_incdir().'/conf/default.php';
1258    $conf = array();
1259
1260    if(!@file_exists($file)) return false;
1261
1262    // load default config file
1263    include($file);
1264
1265    return $conf;
1266}
1267
1268// language methods
1269/**
1270 * tpl_getLang($id)
1271 *
1272 * use this function to access template language variables
1273 */
1274function tpl_getLang($id) {
1275    static $lang = array();
1276
1277    if(count($lang) === 0) {
1278        $path = tpl_incdir().'lang/';
1279
1280        $lang = array();
1281
1282        global $conf; // definitely don't invoke "global $lang"
1283        // don't include once
1284        @include($path.'en/lang.php');
1285        if($conf['lang'] != 'en') @include($path.$conf['lang'].'/lang.php');
1286    }
1287
1288    return $lang[$id];
1289}
1290
1291/**
1292 * Retrieve a language dependent file and pass to xhtml renderer for display
1293 * template equivalent of p_locale_xhtml()
1294 *
1295 * @param   string $id id of language dependent wiki page
1296 * @return  string     parsed contents of the wiki page in xhtml format
1297 */
1298function tpl_locale_xhtml($id) {
1299    return p_cached_output(tpl_localeFN($id));
1300}
1301
1302/**
1303 * Prepends appropriate path for a language dependent filename
1304 */
1305function tpl_localeFN($id) {
1306    $path = tpl_incdir().'lang/';
1307    global $conf;
1308    $file = DOKU_CONF.'/template_lang/'.$conf['template'].'/'.$conf['lang'].'/'.$id.'.txt';
1309    if (!@file_exists($file)){
1310        $file = $path.$conf['lang'].'/'.$id.'.txt';
1311        if(!@file_exists($file)){
1312            //fall back to english
1313            $file = $path.'en/'.$id.'.txt';
1314        }
1315    }
1316    return $file;
1317}
1318
1319/**
1320 * prints the "main content" in the mediamanger popup
1321 *
1322 * Depending on the user's actions this may be a list of
1323 * files in a namespace, the meta editing dialog or
1324 * a message of referencing pages
1325 *
1326 * Only allowed in mediamanager.php
1327 *
1328 * @triggers MEDIAMANAGER_CONTENT_OUTPUT
1329 * @param bool $fromajax - set true when calling this function via ajax
1330 * @author Andreas Gohr <andi@splitbrain.org>
1331 */
1332function tpl_mediaContent($fromajax = false, $sort='natural') {
1333    global $IMG;
1334    global $AUTH;
1335    global $INUSE;
1336    global $NS;
1337    global $JUMPTO;
1338    /** @var Input $INPUT */
1339    global $INPUT;
1340
1341    $do = $INPUT->extract('do')->str('do');
1342    if(in_array($do, array('save', 'cancel'))) $do = '';
1343
1344    if(!$do) {
1345        if($INPUT->bool('edit')) {
1346            $do = 'metaform';
1347        } elseif(is_array($INUSE)) {
1348            $do = 'filesinuse';
1349        } else {
1350            $do = 'filelist';
1351        }
1352    }
1353
1354    // output the content pane, wrapped in an event.
1355    if(!$fromajax) ptln('<div id="media__content">');
1356    $data = array('do' => $do);
1357    $evt  = new Doku_Event('MEDIAMANAGER_CONTENT_OUTPUT', $data);
1358    if($evt->advise_before()) {
1359        $do = $data['do'];
1360        if($do == 'filesinuse') {
1361            media_filesinuse($INUSE, $IMG);
1362        } elseif($do == 'filelist') {
1363            media_filelist($NS, $AUTH, $JUMPTO,false,$sort);
1364        } elseif($do == 'searchlist') {
1365            media_searchlist($INPUT->str('q'), $NS, $AUTH);
1366        } else {
1367            msg('Unknown action '.hsc($do), -1);
1368        }
1369    }
1370    $evt->advise_after();
1371    unset($evt);
1372    if(!$fromajax) ptln('</div>');
1373
1374}
1375
1376/**
1377 * Prints the central column in full-screen media manager
1378 * Depending on the opened tab this may be a list of
1379 * files in a namespace, upload form or search form
1380 *
1381 * @author Kate Arzamastseva <pshns@ukr.net>
1382 */
1383function tpl_mediaFileList() {
1384    global $AUTH;
1385    global $NS;
1386    global $JUMPTO;
1387    global $lang;
1388    /** @var Input $INPUT */
1389    global $INPUT;
1390
1391    $opened_tab = $INPUT->str('tab_files');
1392    if(!$opened_tab || !in_array($opened_tab, array('files', 'upload', 'search'))) $opened_tab = 'files';
1393    if($INPUT->str('mediado') == 'update') $opened_tab = 'upload';
1394
1395    echo '<h2 class="a11y">'.$lang['mediaselect'].'</h2>'.NL;
1396
1397    media_tabs_files($opened_tab);
1398
1399    echo '<div class="panelHeader">'.NL;
1400    echo '<h3>';
1401    $tabTitle = ($NS) ? $NS : '['.$lang['mediaroot'].']';
1402    printf($lang['media_'.$opened_tab], '<strong>'.hsc($tabTitle).'</strong>');
1403    echo '</h3>'.NL;
1404    if($opened_tab === 'search' || $opened_tab === 'files') {
1405        media_tab_files_options();
1406    }
1407    echo '</div>'.NL;
1408
1409    echo '<div class="panelContent">'.NL;
1410    if($opened_tab == 'files') {
1411        media_tab_files($NS, $AUTH, $JUMPTO);
1412    } elseif($opened_tab == 'upload') {
1413        media_tab_upload($NS, $AUTH, $JUMPTO);
1414    } elseif($opened_tab == 'search') {
1415        media_tab_search($NS, $AUTH);
1416    }
1417    echo '</div>'.NL;
1418}
1419
1420/**
1421 * Prints the third column in full-screen media manager
1422 * Depending on the opened tab this may be details of the
1423 * selected file, the meta editing dialog or
1424 * list of file revisions
1425 *
1426 * @author Kate Arzamastseva <pshns@ukr.net>
1427 */
1428function tpl_mediaFileDetails($image, $rev) {
1429    global $AUTH, $NS, $conf, $DEL, $lang;
1430    /** @var Input $INPUT */
1431    global $INPUT;
1432
1433    $removed = (!file_exists(mediaFN($image)) && file_exists(mediaMetaFN($image, '.changes')) && $conf['mediarevisions']);
1434    if(!$image || (!file_exists(mediaFN($image)) && !$removed) || $DEL) return;
1435    if($rev && !file_exists(mediaFN($image, $rev))) $rev = false;
1436    if(isset($NS) && getNS($image) != $NS) return;
1437    $do = $INPUT->str('mediado');
1438
1439    $opened_tab = $INPUT->str('tab_details');
1440
1441    $tab_array = array('view');
1442    list(, $mime) = mimetype($image);
1443    if($mime == 'image/jpeg') {
1444        $tab_array[] = 'edit';
1445    }
1446    if($conf['mediarevisions']) {
1447        $tab_array[] = 'history';
1448    }
1449
1450    if(!$opened_tab || !in_array($opened_tab, $tab_array)) $opened_tab = 'view';
1451    if($INPUT->bool('edit')) $opened_tab = 'edit';
1452    if($do == 'restore') $opened_tab = 'view';
1453
1454    media_tabs_details($image, $opened_tab);
1455
1456    echo '<div class="panelHeader"><h3>';
1457    list($ext) = mimetype($image, false);
1458    $class    = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext);
1459    $class    = 'select mediafile mf_'.$class;
1460    $tabTitle = '<strong><a href="'.ml($image).'" class="'.$class.'" title="'.$lang['mediaview'].'">'.$image.'</a>'.'</strong>';
1461    if($opened_tab === 'view' && $rev) {
1462        printf($lang['media_viewold'], $tabTitle, dformat($rev));
1463    } else {
1464        printf($lang['media_'.$opened_tab], $tabTitle);
1465    }
1466
1467    echo '</h3></div>'.NL;
1468
1469    echo '<div class="panelContent">'.NL;
1470
1471    if($opened_tab == 'view') {
1472        media_tab_view($image, $NS, $AUTH, $rev);
1473
1474    } elseif($opened_tab == 'edit' && !$removed) {
1475        media_tab_edit($image, $NS, $AUTH);
1476
1477    } elseif($opened_tab == 'history' && $conf['mediarevisions']) {
1478        media_tab_history($image, $NS, $AUTH);
1479    }
1480
1481    echo '</div>'.NL;
1482}
1483
1484/**
1485 * prints the namespace tree in the mediamanger popup
1486 *
1487 * Only allowed in mediamanager.php
1488 *
1489 * @author Andreas Gohr <andi@splitbrain.org>
1490 */
1491function tpl_mediaTree() {
1492    global $NS;
1493    ptln('<div id="media__tree">');
1494    media_nstree($NS);
1495    ptln('</div>');
1496}
1497
1498/**
1499 * Print a dropdown menu with all DokuWiki actions
1500 *
1501 * Note: this will not use any pretty URLs
1502 *
1503 * @author Andreas Gohr <andi@splitbrain.org>
1504 */
1505function tpl_actiondropdown($empty = '', $button = '&gt;') {
1506    global $ID;
1507    global $REV;
1508    global $lang;
1509    /** @var Input $INPUT */
1510    global $INPUT;
1511
1512    echo '<form action="'.script().'" method="get" accept-charset="utf-8">';
1513    echo '<div class="no">';
1514    echo '<input type="hidden" name="id" value="'.$ID.'" />';
1515    if($REV) echo '<input type="hidden" name="rev" value="'.$REV.'" />';
1516    if ($INPUT->server->str('REMOTE_USER')) {
1517        echo '<input type="hidden" name="sectok" value="'.getSecurityToken().'" />';
1518    }
1519
1520    echo '<select name="do" class="edit quickselect" title="'.$lang['tools'].'">';
1521    echo '<option value="">'.$empty.'</option>';
1522
1523    echo '<optgroup label="'.$lang['page_tools'].'">';
1524    $act = tpl_get_action('edit');
1525    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1526
1527    $act = tpl_get_action('revert');
1528    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1529
1530    $act = tpl_get_action('revisions');
1531    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1532
1533    $act = tpl_get_action('backlink');
1534    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1535
1536    $act = tpl_get_action('subscribe');
1537    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1538    echo '</optgroup>';
1539
1540    echo '<optgroup label="'.$lang['site_tools'].'">';
1541    $act = tpl_get_action('recent');
1542    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1543
1544    $act = tpl_get_action('media');
1545    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1546
1547    $act = tpl_get_action('index');
1548    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1549    echo '</optgroup>';
1550
1551    echo '<optgroup label="'.$lang['user_tools'].'">';
1552    $act = tpl_get_action('login');
1553    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1554
1555    $act = tpl_get_action('register');
1556    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1557
1558    $act = tpl_get_action('profile');
1559    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1560
1561    $act = tpl_get_action('admin');
1562    if($act) echo '<option value="'.$act['params']['do'].'">'.$lang['btn_'.$act['type']].'</option>';
1563    echo '</optgroup>';
1564
1565    echo '</select>';
1566    echo '<input type="submit" value="'.$button.'" />';
1567    echo '</div>';
1568    echo '</form>';
1569}
1570
1571/**
1572 * Print a informational line about the used license
1573 *
1574 * @author Andreas Gohr <andi@splitbrain.org>
1575 * @param  string $img     print image? (|button|badge)
1576 * @param  bool   $imgonly skip the textual description?
1577 * @param  bool   $return  when true don't print, but return HTML
1578 * @param  bool   $wrap    wrap in div with class="license"?
1579 * @return string
1580 */
1581function tpl_license($img = 'badge', $imgonly = false, $return = false, $wrap = true) {
1582    global $license;
1583    global $conf;
1584    global $lang;
1585    if(!$conf['license']) return '';
1586    if(!is_array($license[$conf['license']])) return '';
1587    $lic    = $license[$conf['license']];
1588    $target = ($conf['target']['extern']) ? ' target="'.$conf['target']['extern'].'"' : '';
1589
1590    $out = '';
1591    if($wrap) $out .= '<div class="license">';
1592    if($img) {
1593        $src = license_img($img);
1594        if($src) {
1595            $out .= '<a href="'.$lic['url'].'" rel="license"'.$target;
1596            $out .= '><img src="'.DOKU_BASE.$src.'" alt="'.$lic['name'].'" /></a>';
1597            if(!$imgonly) $out .= ' ';
1598        }
1599    }
1600    if(!$imgonly) {
1601        $out .= $lang['license'].' ';
1602        $out .= '<bdi><a href="'.$lic['url'].'" rel="license" class="urlextern"'.$target;
1603        $out .= '>'.$lic['name'].'</a></bdi>';
1604    }
1605    if($wrap) $out .= '</div>';
1606
1607    if($return) return $out;
1608    echo $out;
1609    return '';
1610}
1611
1612/**
1613 * Includes the rendered HTML of a given page
1614 *
1615 * This function is useful to populate sidebars or similar features in a
1616 * template
1617 */
1618function tpl_include_page($pageid, $print = true, $propagate = false) {
1619    if (!$pageid) return false;
1620    if ($propagate) $pageid = page_findnearest($pageid);
1621
1622    global $TOC;
1623    $oldtoc = $TOC;
1624    $html   = p_wiki_xhtml($pageid, '', false);
1625    $TOC    = $oldtoc;
1626
1627    if(!$print) return $html;
1628    echo $html;
1629    return $html;
1630}
1631
1632/**
1633 * Display the subscribe form
1634 *
1635 * @author Adrian Lang <lang@cosmocode.de>
1636 */
1637function tpl_subscribe() {
1638    global $INFO;
1639    global $ID;
1640    global $lang;
1641    global $conf;
1642    $stime_days = $conf['subscribe_time'] / 60 / 60 / 24;
1643
1644    echo p_locale_xhtml('subscr_form');
1645    echo '<h2>'.$lang['subscr_m_current_header'].'</h2>';
1646    echo '<div class="level2">';
1647    if($INFO['subscribed'] === false) {
1648        echo '<p>'.$lang['subscr_m_not_subscribed'].'</p>';
1649    } else {
1650        echo '<ul>';
1651        foreach($INFO['subscribed'] as $sub) {
1652            echo '<li><div class="li">';
1653            if($sub['target'] !== $ID) {
1654                echo '<code class="ns">'.hsc(prettyprint_id($sub['target'])).'</code>';
1655            } else {
1656                echo '<code class="page">'.hsc(prettyprint_id($sub['target'])).'</code>';
1657            }
1658            $sstl = sprintf($lang['subscr_style_'.$sub['style']], $stime_days);
1659            if(!$sstl) $sstl = hsc($sub['style']);
1660            echo ' ('.$sstl.') ';
1661
1662            echo '<a href="'.wl(
1663                $ID,
1664                array(
1665                     'do'        => 'subscribe',
1666                     'sub_target'=> $sub['target'],
1667                     'sub_style' => $sub['style'],
1668                     'sub_action'=> 'unsubscribe',
1669                     'sectok'    => getSecurityToken()
1670                )
1671            ).
1672                '" class="unsubscribe">'.$lang['subscr_m_unsubscribe'].
1673                '</a></div></li>';
1674        }
1675        echo '</ul>';
1676    }
1677    echo '</div>';
1678
1679    // Add new subscription form
1680    echo '<h2>'.$lang['subscr_m_new_header'].'</h2>';
1681    echo '<div class="level2">';
1682    $ns      = getNS($ID).':';
1683    $targets = array(
1684        $ID => '<code class="page">'.prettyprint_id($ID).'</code>',
1685        $ns => '<code class="ns">'.prettyprint_id($ns).'</code>',
1686    );
1687    $styles  = array(
1688        'every'  => $lang['subscr_style_every'],
1689        'digest' => sprintf($lang['subscr_style_digest'], $stime_days),
1690        'list'   => sprintf($lang['subscr_style_list'], $stime_days),
1691    );
1692
1693    $form = new Doku_Form(array('id' => 'subscribe__form'));
1694    $form->startFieldset($lang['subscr_m_subscribe']);
1695    $form->addRadioSet('sub_target', $targets);
1696    $form->startFieldset($lang['subscr_m_receive']);
1697    $form->addRadioSet('sub_style', $styles);
1698    $form->addHidden('sub_action', 'subscribe');
1699    $form->addHidden('do', 'subscribe');
1700    $form->addHidden('id', $ID);
1701    $form->endFieldset();
1702    $form->addElement(form_makeButton('submit', 'subscribe', $lang['subscr_m_subscribe']));
1703    html_form('SUBSCRIBE', $form);
1704    echo '</div>';
1705}
1706
1707/**
1708 * Tries to send already created content right to the browser
1709 *
1710 * Wraps around ob_flush() and flush()
1711 *
1712 * @author Andreas Gohr <andi@splitbrain.org>
1713 */
1714function tpl_flush() {
1715    ob_flush();
1716    flush();
1717}
1718
1719/**
1720 * Tries to find a ressource file in the given locations.
1721 *
1722 * If a given location starts with a colon it is assumed to be a media
1723 * file, otherwise it is assumed to be relative to the current template
1724 *
1725 * @param  array $search       locations to look at
1726 * @param  bool  $abs           if to use absolute URL
1727 * @param  array &$imginfo   filled with getimagesize()
1728 * @return string
1729 * @author Andreas  Gohr <andi@splitbrain.org>
1730 */
1731function tpl_getMediaFile($search, $abs = false, &$imginfo = null) {
1732    $img     = '';
1733    $file    = '';
1734    $ismedia = false;
1735    // loop through candidates until a match was found:
1736    foreach($search as $img) {
1737        if(substr($img, 0, 1) == ':') {
1738            $file    = mediaFN($img);
1739            $ismedia = true;
1740        } else {
1741            $file    = tpl_incdir().$img;
1742            $ismedia = false;
1743        }
1744
1745        if(file_exists($file)) break;
1746    }
1747
1748    // fetch image data if requested
1749    if(!is_null($imginfo)) {
1750        $imginfo = getimagesize($file);
1751    }
1752
1753    // build URL
1754    if($ismedia) {
1755        $url = ml($img, '', true, '', $abs);
1756    } else {
1757        $url = tpl_basedir().$img;
1758        if($abs) $url = DOKU_URL.substr($url, strlen(DOKU_REL));
1759    }
1760
1761    return $url;
1762}
1763
1764/**
1765 * PHP include a file
1766 *
1767 * either from the conf directory if it exists, otherwise use
1768 * file in the template's root directory.
1769 *
1770 * The function honours config cascade settings and looks for the given
1771 * file next to the ´main´ config files, in the order protected, local,
1772 * default.
1773 *
1774 * Note: no escaping or sanity checking is done here. Never pass user input
1775 * to this function!
1776 *
1777 * @author Anika Henke <anika@selfthinker.org>
1778 * @author Andreas Gohr <andi@splitbrain.org>
1779 */
1780function tpl_includeFile($file) {
1781    global $config_cascade;
1782    foreach(array('protected', 'local', 'default') as $config_group) {
1783        if(empty($config_cascade['main'][$config_group])) continue;
1784        foreach($config_cascade['main'][$config_group] as $conf_file) {
1785            $dir = dirname($conf_file);
1786            if(file_exists("$dir/$file")) {
1787                include("$dir/$file");
1788                return;
1789            }
1790        }
1791    }
1792
1793    // still here? try the template dir
1794    $file = tpl_incdir().$file;
1795    if(file_exists($file)) {
1796        include($file);
1797    }
1798}
1799
1800/**
1801 * Returns <link> tag for various icon types (favicon|mobile|generic)
1802 *
1803 * @author Anika Henke <anika@selfthinker.org>
1804 * @param  array $types - list of icon types to display (favicon|mobile|generic)
1805 * @return string
1806 */
1807function tpl_favicon($types = array('favicon')) {
1808
1809    $return = '';
1810
1811    foreach($types as $type) {
1812        switch($type) {
1813            case 'favicon':
1814                $look = array(':wiki:favicon.ico', ':favicon.ico', 'images/favicon.ico');
1815                $return .= '<link rel="shortcut icon" href="'.tpl_getMediaFile($look).'" />'.NL;
1816                break;
1817            case 'mobile':
1818                $look = array(':wiki:apple-touch-icon.png', ':apple-touch-icon.png', 'images/apple-touch-icon.png');
1819                $return .= '<link rel="apple-touch-icon" href="'.tpl_getMediaFile($look).'" />'.NL;
1820                break;
1821            case 'generic':
1822                // ideal world solution, which doesn't work in any browser yet
1823                $look = array(':wiki:favicon.svg', ':favicon.svg', 'images/favicon.svg');
1824                $return .= '<link rel="icon" href="'.tpl_getMediaFile($look).'" type="image/svg+xml" />'.NL;
1825                break;
1826        }
1827    }
1828
1829    return $return;
1830}
1831
1832/**
1833 * Prints full-screen media manager
1834 *
1835 * @author Kate Arzamastseva <pshns@ukr.net>
1836 */
1837function tpl_media() {
1838    global $NS, $IMG, $JUMPTO, $REV, $lang, $fullscreen, $INPUT;
1839    $fullscreen = true;
1840    require_once DOKU_INC.'lib/exe/mediamanager.php';
1841
1842    $rev   = '';
1843    $image = cleanID($INPUT->str('image'));
1844    if(isset($IMG)) $image = $IMG;
1845    if(isset($JUMPTO)) $image = $JUMPTO;
1846    if(isset($REV) && !$JUMPTO) $rev = $REV;
1847
1848    echo '<div id="mediamanager__page">'.NL;
1849    echo '<h1>'.$lang['btn_media'].'</h1>'.NL;
1850    html_msgarea();
1851
1852    echo '<div class="panel namespaces">'.NL;
1853    echo '<h2>'.$lang['namespaces'].'</h2>'.NL;
1854    echo '<div class="panelHeader">';
1855    echo $lang['media_namespaces'];
1856    echo '</div>'.NL;
1857
1858    echo '<div class="panelContent" id="media__tree">'.NL;
1859    media_nstree($NS);
1860    echo '</div>'.NL;
1861    echo '</div>'.NL;
1862
1863    echo '<div class="panel filelist">'.NL;
1864    tpl_mediaFileList();
1865    echo '</div>'.NL;
1866
1867    echo '<div class="panel file">'.NL;
1868    echo '<h2 class="a11y">'.$lang['media_file'].'</h2>'.NL;
1869    tpl_mediaFileDetails($image, $rev);
1870    echo '</div>'.NL;
1871
1872    echo '</div>'.NL;
1873}
1874
1875/**
1876 * Return useful layout classes
1877 *
1878 * @author Anika Henke <anika@selfthinker.org>
1879 */
1880function tpl_classes() {
1881    global $ACT, $conf, $ID, $INFO;
1882    /** @var Input $INPUT */
1883    global $INPUT;
1884
1885    $classes = array(
1886        'dokuwiki',
1887        'mode_'.$ACT,
1888        'tpl_'.$conf['template'],
1889        $INPUT->server->bool('REMOTE_USER') ? 'loggedIn' : '',
1890        $INFO['exists'] ? '' : 'notFound',
1891        ($ID == $conf['start']) ? 'home' : '',
1892    );
1893    return join(' ', $classes);
1894}
1895
1896//Setup VIM: ex: et ts=4 :
1897
1898