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