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