xref: /template/ad-hominem/my_template.php (revision 1c8dc2ca0efc04870f765135698df86425917d9c) 
1<?php
2/**
3 * Overwriting DokuWiki template functions
4 *
5 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
6 * @author     Sascha Leib <sascha@leib.be>
7 * @author     Andreas Gohr <andi@splitbrain.org>
8 */
9
10use dokuwiki\Extension\Event;
11
12/**
13 * Print the specific HTML meta headers
14 *
15 * Overrides the original version by modifying the headers and the way it is printed
16 *
17 * @author Sascha Leib <sascha@leib.be>
18 * @author Andreas Gohr <andi@splitbrain.org>
19 *
20 * @triggers TPL_METAHEADER_OUTPUT
21 * @param  bool $alt Should feeds and alternative format links be added?
22 * @return bool
23 */
24function my_metaheaders($alt = true) {
25    global $ID;
26    global $REV;
27    global $INFO;
28    global $JSINFO;
29    global $ACT;
30    global $QUERY;
31    global $lang;
32    global $conf;
33    global $updateVersion;
34    /** @var Input $INPUT */
35    global $INPUT;
36
37    // prepare the head array
38    $head = array();
39
40    // prepare seed for js and css
41    $tseed   = $updateVersion;
42    $depends = getConfigFiles('main');
43    $depends[] = DOKU_CONF."tpl/".$conf['template']."/style.ini";
44    foreach($depends as $f) $tseed .= @filemtime($f);
45    $tseed   = md5($tseed);
46
47	// Open Graph information
48	$meta = p_get_metadata($ID);
49	if ($meta['title'] !== null) {
50		$head['meta'][] = array('property' => 'og:title', 'content' => tpl_pagetitle($ID, true));
51		$head['meta'][] = array('property' => 'og:site_name ', 'content' => $conf['title']);
52		$head['meta'][] = array('property' => 'og:type', 'content' => 'website');
53		$head['meta'][] = array('property' => 'og:url', 'content' => wl($ID, '', true, '&'));
54
55		$parts = explode("\n", $meta['description']['abstract']);
56		$head['meta'][] = array('property' => 'og:description', 'content' => $parts[2]);
57	}
58
59    // the usual stuff
60    $head['meta'][] = array('name'=> 'generator', 'content'=> 'DokuWiki');
61    if(actionOK('search')) {
62        $head['link'][] = array(
63            'rel' => 'search', 'type'=> 'application/opensearchdescription+xml',
64            'href'=> DOKU_BASE.'lib/exe/opensearch.php', 'title'=> $conf['title']
65        );
66    }
67
68    $head['link'][] = array('rel'=> 'start', 'href'=> DOKU_BASE);
69    if(actionOK('index')) {
70        $head['link'][] = array(
71            'rel'  => 'contents', 'href'=> wl($ID, 'do=index', false, '&'),
72            'title'=> $lang['btn_index']
73        );
74    }
75
76    if (actionOK('manifest')) {
77        $head['link'][] = array('rel'=> 'manifest', 'href'=> DOKU_BASE.'lib/exe/manifest.php');
78    }
79
80    $styleUtil = new \dokuwiki\StyleUtils();
81    $styleIni = $styleUtil->cssStyleini();
82    $replacements = $styleIni['replacements'];
83    if (!empty($replacements['__theme_color__'])) {
84        $head['meta'][] = array('name' => 'theme-color', 'content' => $replacements['__theme_color__']);
85    }
86
87    if($alt) {
88        if(actionOK('rss')) {
89            $head['link'][] = array(
90                'rel'  => 'alternate', 'type'=> 'application/rss+xml',
91                'title'=> $lang['btn_recent'], 'href'=> DOKU_BASE.'feed.php'
92            );
93            $head['link'][] = array(
94                'rel'  => 'alternate', 'type'=> 'application/rss+xml',
95                'title'=> $lang['currentns'],
96                'href' => DOKU_BASE.'feed.php?mode=list&ns='.(isset($INFO) ? $INFO['namespace'] : '')
97            );
98        }
99        if(($ACT == 'show' || $ACT == 'search') && $INFO['writable']) {
100            $head['link'][] = array(
101                'rel'  => 'edit',
102                'title'=> $lang['btn_edit'],
103                'href' => wl($ID, 'do=edit', false, '&')
104            );
105        }
106
107        if(actionOK('rss') && $ACT == 'search') {
108            $head['link'][] = array(
109                'rel'  => 'alternate', 'type'=> 'application/rss+xml',
110                'title'=> $lang['searchresult'],
111                'href' => DOKU_BASE.'feed.php?mode=search&q='.$QUERY
112            );
113        }
114
115        if(actionOK('export_xhtml')) {
116            $head['link'][] = array(
117                'rel' => 'alternate', 'type'=> 'text/html', 'title'=> $lang['plainhtml'],
118                'href'=> exportlink($ID, 'xhtml', '', false, '&')
119            );
120        }
121
122        if(actionOK('export_raw')) {
123            $head['link'][] = array(
124                'rel' => 'alternate', 'type'=> 'text/plain', 'title'=> $lang['wikimarkup'],
125                'href'=> exportlink($ID, 'raw', '', false, '&')
126            );
127        }
128    }
129
130    // setup robot tags apropriate for different modes
131    if(($ACT == 'show' || $ACT == 'export_xhtml') && !$REV) {
132        if($INFO['exists']) {
133            //delay indexing:
134            if((time() - $INFO['lastmod']) >= $conf['indexdelay'] && !isHiddenPage($ID) ) {
135                $head['meta'][] = array('name'=> 'robots', 'content'=> 'index,follow');
136            } else {
137                $head['meta'][] = array('name'=> 'robots', 'content'=> 'noindex,nofollow');
138            }
139            $canonicalUrl = wl($ID, '', true, '&');
140            if ($ID == $conf['start']) {
141                $canonicalUrl = DOKU_URL;
142            }
143            $head['link'][] = array('rel'=> 'canonical', 'href'=> $canonicalUrl);
144        } else {
145            $head['meta'][] = array('name'=> 'robots', 'content'=> 'noindex,follow');
146        }
147    } elseif(defined('DOKU_MEDIADETAIL')) {
148        $head['meta'][] = array('name'=> 'robots', 'content'=> 'index,follow');
149    } else {
150        $head['meta'][] = array('name'=> 'robots', 'content'=> 'noindex,nofollow');
151    }
152
153    // set metadata
154    if($ACT == 'show' || $ACT == 'export_xhtml') {
155        // keywords (explicit or implicit)
156        if(!empty($INFO['meta']['subject'])) {
157            $head['meta'][] = array('name'=> 'keywords', 'content'=> join(',', $INFO['meta']['subject']));
158        } else {
159            $head['meta'][] = array('name'=> 'keywords', 'content'=> str_replace(':', ',', $ID));
160        }
161    }
162
163    // load stylesheets
164    $head['link'][] = array(
165        'rel' => 'stylesheet',
166        'href'=> DOKU_BASE . 'lib/exe/css.php?t='.rawurlencode($conf['template']).'&tseed='.$tseed
167    );
168
169    $script = "var NS='".(isset($INFO)?$INFO['namespace']:'')."';\n\t\t";
170    if($conf['useacl'] && $INPUT->server->str('REMOTE_USER')) {
171        $script .= "var SIG=".toolbar_signature().";\n\t\t";
172    }
173
174    if($conf['basedir']) {
175        $script .= 'var BASEDIR="'.$conf['basedir']."\";\n\t\t";
176    }
177
178    jsinfo();
179    $script .= 'var JSINFO = ' . json_encode($JSINFO).';';
180    $head['script'][] = array('_data'=> $script);
181
182    // load jquery
183    $jquery = getCdnUrls();
184    foreach($jquery as $src) {
185        $head['script'][] = array(
186            /* 'charset' => 'utf-8', -- obsolete */
187            '_data' => '',
188            'src' => $src,
189        ) + ($conf['defer_js'] ? [ 'defer' => 'defer'] : []);
190    }
191
192    // load our javascript dispatcher
193    $head['script'][] = array(
194        /* 'charset'=> 'utf-8', -- obsolete */
195		'_data'=> '',
196        'src' => DOKU_BASE . 'lib/exe/js.php'.'?t='.rawurlencode($conf['template']).'&tseed='.$tseed,
197    ) + ($conf['defer_js'] ? [ 'defer' => 'defer'] : []);
198
199    // trigger event here
200    Event::createAndTrigger('TPL_METAHEADER_OUTPUT', $head, '_my_metaheaders_action', true);
201    return true;
202}
203
204/**
205 * prints the array build by my_metaheaders
206 *
207 * Overrides the original version by adding a tab before each line for neater HTML code
208 *
209 * @author Sascha Leib <sascha@leib.be>
210 * @author Andreas Gohr <andi@splitbrain.org>
211 *
212 * @param array $data
213 */
214function _my_metaheaders_action($data) {
215    foreach($data as $tag => $inst) {
216        foreach($inst as $attr) {
217            if ( empty($attr) ) { continue; }
218            echo "\t<", $tag, ' ', buildAttributes($attr);
219            if(isset($attr['_data']) || $tag == 'script') {
220                if($tag == 'script' && $attr['_data'])
221                    $attr['_data'] = "/*<![CDATA[*/".
222                        $attr['_data'].
223                        "\n/*!]]>*/";
224
225                echo '>', $attr['_data'], '</', $tag, '>';
226            } else {
227                echo '/>';
228            }
229            echo "\n";
230        }
231    }
232}
233
234/**
235 * get a link to the homepage.
236 *
237 * wraps the original wl() function to allow overriding in the options
238 *
239 * @author Sascha Leib <sascha@leib.be>
240 *
241 * @returns string (link)
242 */
243function my_homelink() {
244    global $conf;
245
246	$hl = trim(tpl_getConf('homelink'));
247
248	if ( $hl !== '' ) {
249		return $hl;
250	} else {
251		return wl(); // default homelink
252	}
253}
254
255/**
256 * Print the breadcrumbs trace
257 *
258 * Cleanup of the original code to create neater and more accessible HTML
259 *
260 * @author Sascha Leib <sascha@leib.be>
261 * @author Andreas Gohr <andi@splitbrain.org>
262 *
263 * @param string $prefix inserted before each line
264 *
265 * @return void
266 */
267function my_breadcrumbs($prefix = '') {
268    global $lang;
269    global $conf;
270
271    //check if enabled
272    if(!$conf['breadcrumbs']) return false;
273
274    $crumbs = breadcrumbs(); //setup crumb trace
275
276	/* begin listing */
277	echo $prefix . "<nav id=\"navBreadCrumbs\">\n";
278	echo $prefix . "\t<h4>" . $lang['breadcrumb'] . "</h4>\n";
279	echo $prefix . "\t<ol reversed>\n";
280
281    $last = count($crumbs);
282    $i    = 0;
283    foreach($crumbs as $id => $name) {
284        $i++;
285		echo $prefix . "\t\t<li" . ($i == $last ? ' class="current"' : '') . '><bdi>' . tpl_link(wl($id), hsc($name), '', true) .  "</bdi></li>\n";
286    }
287	echo $prefix . "\t</ol>\n";
288	echo $prefix . "</nav>\n";
289}
290
291/**
292 * Hierarchical breadcrumbs
293 *
294 * Cleanup of the original code to create neater and more accessible HTML
295 *
296 * @author Sascha Leib <sascha@leib.be>
297 * @author Andreas Gohr <andi@splitbrain.org>
298 * @author Nigel McNie <oracle.shinoda@gmail.com>
299 * @author Sean Coates <sean@caedmon.net>
300 * @author <fredrik@averpil.com>
301 *
302 * @param  string $prefix to be added before each line
303 *
304 */
305function my_youarehere($prefix = '') {
306    global $conf;
307    global $ID;
308    global $lang;
309
310    // check if enabled
311    if(!$conf['youarehere']) return false;
312
313    $parts = explode(':', $ID);
314    $count = count($parts);
315	$isdir = ( $parts[$count-1] == $conf['start']);
316
317	$hl = trim(tpl_getConf('homelink'));
318
319	echo $prefix . "<nav id=\"navYouAreHere\">\n";
320	echo $prefix . "\t<h4>" . $lang['youarehere'] . "</h4>\n";
321	echo $prefix . "\t<ol>\n";
322
323    // always print the startpage
324	if ( $hl !== '' ) {
325		echo $prefix . "\t\t<li class=\"home\">" . tpl_link( $hl, htmlentities(tpl_getLang('homepage')), ' title="' . htmlentities(tpl_getLang('homepage')) . '"', true) . "</li>\n";
326		echo $prefix . "\t\t<li>" . tpl_pagelink(':'.$conf['start'], null, true) . "</li>\n";
327	} else {
328		echo $prefix . "\t\t<li class=\"home\">" . tpl_pagelink(':'.$conf['start'], null, true) . "</li>\n";
329	}
330
331    // print intermediate namespace links
332    $part = '';
333    for($i = 0; $i < $count - 1; $i++) {
334        $part .= $parts[$i].':';
335        $page = $part;
336        //if($page !== $conf['start']) { // Skip startpage
337
338			if ($i == $count-2 && $isdir)  break; // Skip last if it is an index page
339
340			echo $prefix . "\t\t<li>" . tpl_pagelink($page, null, true) . "</li>\n";
341		//}
342    }
343
344    // chould the current page be included in the listing?
345	$trail = tpl_getConf('navtrail');
346
347	if ($trail !== 'none' && $trail !== '') {
348		resolve_pageid('', $page, $exists);
349		//if ( !(isset($page) && $page == $part.$parts[$i]) || !($page == $conf['start']) ) {
350			echo $prefix . "\t\t<li>";
351			if ($trail == 'text') {
352				echo tpl_pagetitle(null, true);
353			} else if ($trail == 'link') {
354				echo tpl_pagelink($ID, null, true);
355			}
356			echo "</li>\n";
357		//}
358	}
359
360	echo $prefix . "\t</ol>\n";
361	echo $prefix . "</nav>\n";
362}
363
364/**
365 * My implementation of the basic userinfo (in the global banner)
366 *
367 *
368 * @author Sascha Leib <sascha@leib.be>
369 *
370 * @param  string $prefix to be added before each line
371 *
372 * @return void
373 */
374function my_userinfo($prefix = '') {
375    global $lang;
376    global $INPUT;
377
378	// add login/logout button:
379	$items = (new \dokuwiki\Menu\UserMenu())->getItems();
380	foreach($items as $it) {
381		$typ = $it->getType();
382
383		if ($typ === 'profile') { // special case for user profile:
384
385			echo $prefix . '<li class="action profile"><span class="sronly">' . $lang['loggedinas'] .
386				' </span><a href="' . htmlentities($it->getLink()) . '" title="' . $it->getTitle() . '">' .
387				userlink() . "</a></li>\n";
388
389		} else {
390
391			echo $prefix . "<li class=\"action $typ\"><a href=\"" . htmlentities($it->getLink()) .
392				'" title="' . $it->getTitle() . '">' . ($typ === 'profile'? userlink() : $it->getLabel() ) .
393				"</a></li>\n";
394		}
395	}
396}
397
398/**
399 *Inserts a cleaner version of the TOC
400 *
401 * This is an update of the original function that renders the TOC directly.
402 *
403 * @author Sascha Leib <sascha@leib.be>
404 * @author Andreas Gohr <andi@splitbrain.org>
405 *
406 * @param  string $prefix to be added before each line
407 *
408 * @return void
409 */
410function my_toc($prefix = '') {
411    global $TOC;
412    global $ACT;
413    global $ID;
414    global $REV;
415    global $INFO;
416    global $conf;
417    global $lang;
418    $toc = array();
419
420    if(is_array($TOC)) {
421        // if a TOC was prepared in global scope, always use it
422        $toc = $TOC;
423    } elseif(($ACT == 'show' || substr($ACT, 0, 6) == 'export') && !$REV && $INFO['exists']) {
424        // get TOC from metadata, render if neccessary
425        $meta = p_get_metadata($ID, '', METADATA_RENDER_USING_CACHE);
426        if(isset($meta['internal']['toc'])) {
427            $tocok = $meta['internal']['toc'];
428        } else {
429            $tocok = true;
430        }
431        $toc = isset($meta['description']['tableofcontents']) ? $meta['description']['tableofcontents'] : null;
432        if(!$tocok || !is_array($toc) || !$conf['tocminheads'] || count($toc) < $conf['tocminheads']) {
433            $toc = array();
434        }
435    } elseif($ACT == 'admin') {
436        // try to load admin plugin TOC
437        /** @var $plugin AdminPlugin */
438        if ($plugin = plugin_getRequestAdminPlugin()) {
439            $toc = $plugin->getTOC();
440            $TOC = $toc; // avoid later rebuild
441        }
442    }
443
444	/* Build the hierarchical list of headline links: */
445	if (count($toc) >= intval($conf['tocminheads'])) {
446		echo $prefix . "<aside id=\"toc\" class=\"toggle hide\">\n";
447		echo $prefix . "\t<h3 class=\"tg_button\" title=\"" . htmlentities($lang['toc']) . '"><span>' . htmlentities($lang['toc']) . "</span></h3>\n" . $prefix . "\t<div class=\"tg_content\">";
448		$level = intval("0");
449		foreach($toc as $it) {
450
451			$nl = intval($it['level']);
452			$cp = ($nl <=> $level);
453
454			if ($cp > 0) {
455				echo "\n" . $prefix . str_repeat("\t", $level*2 + 2) . "<ol>\n";
456			} else if ($cp < 0) {
457				echo "\n" . $prefix . str_repeat("\t", $level*2) . "</ol></li>\n";
458			} else {
459				echo "</li>\n";
460			}
461
462			$href = $it['link'] . ( $it['hid'] == '' ? '' : '#' . $it['hid'] );
463
464			echo $prefix . str_repeat("\t", $nl*2 + 1) . '<li><a href="' . $href . '">' . htmlentities($it['title']) . "</a>";
465			$level = $nl;
466		}
467
468		for ($i = $level-1; $i > 0; $i--) {
469			echo "</li>\n" . $prefix . str_repeat("\t", $i*2 + 1) . "</ol>";
470		}
471
472		echo "</li>\n" . $prefix . "\t\t</ol>\n" . $prefix . "\t</div>\n" . $prefix . "</aside>\n";
473	}
474}
475
476/**
477 * Print last change date
478 *
479 * @author Sascha Leib <sascha@leib.be>
480 *
481 * @param  string $prefix to be added before each line
482 *
483 * @return void
484 */
485function my_lastchange($prefix = '') {
486
487    global $lang;
488    global $INFO;
489
490	$format = '%Y-%m-%dT%T%z';	/* e.g. 2021-21-05T16:45:12+02:00 */
491
492	$date = $INFO['lastmod'];
493
494	echo $prefix . '<bdi>' . $lang['lastmod'] . "</bdi>\n";
495	echo $prefix . '<time datetime="' . strftime($format, $date) . '">' . dformat($date) . "</time>\n";
496
497	/* user name for last change (is this really interesting to the visitor?) */
498	/* echo $prefix .'<span class="editorname" tabindex="0">' . $lang['by'] . ' <bdi>' . editorinfo($INFO['editor']) . "</bdi></span>\n"; */
499}
500
501/**
502 * Returns a description list of the metatags of the current image
503 *
504 * @return string html of description list
505 */
506function my_img_meta($prefix = '') {
507    global $lang;
508
509	$format = '%Y-%m-%dT%T%z';	/* e.g. 2021-21-05T16:45:12+02:00 */
510
511    $tags = tpl_get_img_meta();
512
513    foreach($tags as $tag) {
514        $label = $lang[$tag['langkey']];
515        if(!$label) $label = $tag['langkey'] . ':';
516
517        echo $prefix . '<tr><th>'.$label.'</th><td>';
518        if ($tag['type'] == 'date') {
519            echo '<time datetime="' . strftime($format, $tag['value']) . '">' . dformat($tag['value']) . '</time>';
520        } else {
521            echo hsc($tag['value']);
522        }
523        echo "</td></tr>\n";
524    }
525}
526
527/**
528 * Creates the Site logo image link
529 *
530 */
531function my_sitelogo() {
532    global $conf;
533
534	// get logo either out of the template images folder or data/media folder
535	$logoSize = array();
536	$logo = tpl_getMediaFile(array(':logo.svg', ':wiki:logo.svg', ':logo.png', ':wiki:logo.png', 'images/sitelogo.svg'), false, $logoSize);
537	tpl_link( my_homelink(),
538		'<img src="'.$logo.'" ' . $logoSize[3] . ' alt="' . htmlentities($conf['title']) . '" />', 'accesskey="h" title="[H]" class="logo"');
539}
540
541/**
542 * Creates the various favicon and similar links:
543 *
544 * @param  string $color overwrite the theme color.
545 *
546 * @return null
547 */
548function my_favicons($color = null) {
549
550	$logoSize = array();
551
552	// Theme color:
553	if ($color == null) {
554
555		/* get the style config */
556		$styleUtil = new \dokuwiki\StyleUtils();
557		$styleIni = $styleUtil->cssStyleini();
558		$replacements = $styleIni['replacements'];
559		$color = $replacements['__theme_color__'];
560
561		if ($color== null) { $color = '#2b73b7'; }
562	}
563	echo "\t<meta name=\"theme-color\" content=\"" . $color . "\" />\n";
564
565	// get the favicon:
566	$link = tpl_getMediaFile(array(':favicon.ico', ':favicon.png', ':favicon.svg', ':wiki:favicon.ico', ':wiki:favicon.png', ':wiki:favicon.svg'), false, $logoSize);
567	echo "\t<link rel=\"icon\" href=\"" . $link . "\" />\n";
568
569	// Apple Touch Icon
570	$logoSize = array();
571	$link = tpl_getMediaFile(array(':apple-touch-icon.png', ':wiki:apple-touch-icon.png', 'images/apple-touch-icon.png'), false, $logoSize);
572	echo "\t<link rel=\"apple-touch-icon\" href=\"" . $link . "\" />\n";
573
574}
575
576/**
577 * inserts the Cookies banner, if appropriate.
578 * This is based on Michal Koutny’s "cookielaw" plugin
579 *
580 * @param  string $prefix to be added before each line
581 */
582function my_cookiebanner($prefix = '') {
583
584	// get the configuration settings:
585	$msg = tpl_getConf('cookiemsg', '(no message configured)');
586	$position = tpl_getConf('cookiepos', 'bottom');
587	$link = tpl_getConf('cookielink', 'about:cookies');
588
589	// if the cookie is already set or position is set to hide, do nothing.
590	if ( isset($_COOKIE['cookielaw']) or $position == 'hide') {
591		return;
592	}
593
594	// output the HTML code:
595	echo $prefix . "<div id=\"cookiebanner\" class=\"cb_" . $position . "\">\n";
596	echo $prefix . "\t<p class=\"cb_info\"><span class=\"cb_icon\"></span>\n";
597	echo $prefix . "\t\t<span class=\"cb_msg\">". $msg . "</span>\r";
598	echo $prefix . "\t</p>\n";
599	echo $prefix . "\t<p class=\"cb_action\">\n";
600	echo $prefix . "\t\t<button>" . hsc(tpl_getLang('cookie_consent')) . "</button>\n";
601	echo $prefix . "\t\t";
602	if ( substr($link, 0, 7) == 'http://' || substr($link, 0, 8) == 'https://') {
603		echo '<a href="' . $link . '" target="_blank">' . hsc(tpl_getLang('cookie_linktext')) . '</a>';
604	} else {
605		tpl_pagelink($link, tpl_getLang('cookie_linktext'));
606	}
607	echo $prefix . "\n\t</p>\n" . $prefix . "</div>\n";
608
609}
610