xref: /template/ad-hominem/my_template.php (revision 7f40b6b7d17c69589ac074463a8d50e9f8031410) 
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 * Print the breadcrumbs trace
236 *
237 * Cleanup of the original code to create neater and more accessible HTML
238 *
239 * @author Sascha Leib <sascha@leib.be>
240 * @author Andreas Gohr <andi@splitbrain.org>
241 *
242 * @param string $prefix inserted before each line
243 *
244 * @return void
245 */
246function my_breadcrumbs($prefix = '') {
247    global $lang;
248    global $conf;
249
250    //check if enabled
251    if(!$conf['breadcrumbs']) return false;
252
253    $crumbs = breadcrumbs(); //setup crumb trace
254
255	/* begin listing */
256	echo $prefix . "<nav id=\"navBreadCrumbs\">\n";
257	echo $prefix . "\t<h4>" . $lang['breadcrumb'] . "</h4>\n";
258	echo $prefix . "\t<ol reversed>\n";
259
260    $last = count($crumbs);
261    $i    = 0;
262    foreach($crumbs as $id => $name) {
263        $i++;
264		echo $prefix . "\t\t<li" . ($i == $last ? ' class="current"' : '') . '><bdi>' . tpl_link(wl($id), hsc($name), '', true) .  "</bdi></li>\n";
265    }
266	echo $prefix . "\t</ol>\n";
267	echo $prefix . "</nav>\n";
268}
269
270/**
271 * Hierarchical breadcrumbs
272 *
273 * Cleanup of the original code to create neater and more accessible HTML
274 *
275 * @author Sascha Leib <sascha@leib.be>
276 * @author Andreas Gohr <andi@splitbrain.org>
277 * @author Nigel McNie <oracle.shinoda@gmail.com>
278 * @author Sean Coates <sean@caedmon.net>
279 * @author <fredrik@averpil.com>
280 *
281 * @param  string $prefix to be added before each line
282 *
283 */
284function my_youarehere($prefix = '') {
285    global $conf;
286    global $ID;
287    global $lang;
288
289    // check if enabled
290    if(!$conf['youarehere']) return false;
291
292    $parts = explode(':', $ID);
293    $count = count($parts);
294	$isdir = ( $parts[$count-1] == $conf['start']);
295
296	echo $prefix . "<nav id=\"navYouAreHere\">\n";
297	echo $prefix . "\t<h4>" . $lang['youarehere'] . "</h4>\n";
298	echo $prefix . "\t<ol>\n";
299
300    // always print the startpage
301    echo $prefix . "\t\t<li class=\"home\">" . tpl_pagelink(':'.$conf['start'], null, true) . "</li>\n";
302
303    // print intermediate namespace links
304    $part = '';
305    for($i = 0; $i < $count - 1; $i++) {
306        $part .= $parts[$i].':';
307        $page = $part;
308        //if($page !== $conf['start']) { // Skip startpage
309
310			if ($i == $count-2 && $isdir)  break; // Skip last if it is an index page
311
312			echo $prefix . "\t\t<li>" . tpl_pagelink($page, null, true) . "</li>\n";
313		//}
314    }
315
316    // chould the current page be included in the listing?
317	$trail = tpl_getConf('navtrail');
318
319	if ($trail !== 'none' && $trail !== '') {
320		resolve_pageid('', $page, $exists);
321		//if ( !(isset($page) && $page == $part.$parts[$i]) || !($page == $conf['start']) ) {
322			echo $prefix . "\t\t<li>";
323			if ($trail == 'text') {
324				echo tpl_pagetitle(null, true);
325			} else if ($trail == 'link') {
326				echo tpl_pagelink($ID, null, true);
327			}
328			echo "</li>\n";
329		//}
330	}
331
332	echo $prefix . "\t</ol>\n";
333	echo $prefix . "</nav>\n";
334}
335
336/**
337 * My implementation of the basic userinfo (in the global banner)
338 *
339 *
340 * @author Sascha Leib <sascha@leib.be>
341 *
342 * @param  string $prefix to be added before each line
343 *
344 * @return void
345 */
346function my_userinfo($prefix = '') {
347    global $lang;
348    global $INPUT;
349
350	// add login/logout button:
351	$items = (new \dokuwiki\Menu\UserMenu())->getItems();
352	foreach($items as $it) {
353		$typ = $it->getType();
354
355		// special case for user profile, otherwise just write the items out:
356		echo $prefix . "<li class=\"action $typ\"><span class=\"sronly\">" . $lang['loggedinas'] .
357			' </span><a href="' . htmlentities($it->getLink()) . '" title="' . $it->getTitle() . '">' .
358			($typ === 'profile'? userlink() : $it->getLabel() ) . "</a></li>\n";
359	}
360}
361
362/**
363 *Inserts a cleaner version of the TOC
364 *
365 * This is an update of the original function that renders the TOC directly.
366 *
367 * @author Sascha Leib <sascha@leib.be>
368 * @author Andreas Gohr <andi@splitbrain.org>
369 *
370 * @param  string $prefix to be added before each line
371 *
372 * @return void
373 */
374function my_toc($prefix = '') {
375    global $TOC;
376    global $ACT;
377    global $ID;
378    global $REV;
379    global $INFO;
380    global $conf;
381    global $lang;
382    $toc = array();
383
384    if(is_array($TOC)) {
385        // if a TOC was prepared in global scope, always use it
386        $toc = $TOC;
387    } elseif(($ACT == 'show' || substr($ACT, 0, 6) == 'export') && !$REV && $INFO['exists']) {
388        // get TOC from metadata, render if neccessary
389        $meta = p_get_metadata($ID, '', METADATA_RENDER_USING_CACHE);
390        if(isset($meta['internal']['toc'])) {
391            $tocok = $meta['internal']['toc'];
392        } else {
393            $tocok = true;
394        }
395        $toc = isset($meta['description']['tableofcontents']) ? $meta['description']['tableofcontents'] : null;
396        if(!$tocok || !is_array($toc) || !$conf['tocminheads'] || count($toc) < $conf['tocminheads']) {
397            $toc = array();
398        }
399    } elseif($ACT == 'admin') {
400        // try to load admin plugin TOC
401        /** @var $plugin AdminPlugin */
402        if ($plugin = plugin_getRequestAdminPlugin()) {
403            $toc = $plugin->getTOC();
404            $TOC = $toc; // avoid later rebuild
405        }
406    }
407
408	/* Build the hierarchical list of headline links: */
409	if (count($toc) >= intval($conf['tocminheads'])) {
410		echo $prefix . "<aside id=\"toc\" class=\"toggle hide\">\n";
411		echo $prefix . "\t<h3 class=\"tg_button\" title=\"" . htmlentities($lang['toc']) . '"><span>' . htmlentities($lang['toc']) . "</span></h3>\n" . $prefix . "\t<div class=\"tg_content\">";
412		$level = intval("0");
413		foreach($toc as $it) {
414
415			$nl = intval($it['level']);
416			$cp = ($nl <=> $level);
417
418			if ($cp > 0) {
419				echo "\n" . $prefix . str_repeat("\t", $level*2 + 2) . "<ol>\n";
420			} else if ($cp < 0) {
421				echo "\n" . $prefix . str_repeat("\t", $level*2) . "</ol></li>\n";
422			} else {
423				echo "</li>\n";
424			}
425
426			$href = $it['link'] . ( $it['hid'] == '' ? '' : '#' . $it['hid'] );
427
428			echo $prefix . str_repeat("\t", $nl*2 + 1) . '<li><a href="' . $href . '">' . htmlentities($it['title']) . "</a>";
429			$level = $nl;
430		}
431
432		for ($i = $level-1; $i > 0; $i--) {
433			echo "</li>\n" . $prefix . str_repeat("\t", $i*2 + 1) . "</ol>";
434		}
435
436		echo "</li>\n" . $prefix . "\t\t</ol>\n" . $prefix . "\t</div>\n" . $prefix . "</aside>\n";
437	}
438}
439
440/**
441 * Print last change date
442 *
443 * @author Sascha Leib <sascha@leib.be>
444 *
445 * @param  string $prefix to be added before each line
446 *
447 * @return void
448 */
449function my_lastchange($prefix = '') {
450
451    global $lang;
452    global $INFO;
453
454	$format = '%Y-%m-%dT%T%z';	/* e.g. 2021-21-05T16:45:12+02:00 */
455
456	$date = $INFO['lastmod'];
457
458	echo $prefix . '<bdi>' . $lang['lastmod'] . "</bdi>\n";
459	echo $prefix . '<time datetime="' . strftime($format, $date) . '">' . dformat($date) . "</time>\n";
460
461	/* user name for last change (is this really interesting to the visitor?) */
462	/* echo $prefix .'<span class="editorname" tabindex="0">' . $lang['by'] . ' <bdi>' . editorinfo($INFO['editor']) . "</bdi></span>\n"; */
463}
464
465/**
466 * Returns a description list of the metatags of the current image
467 *
468 * @return string html of description list
469 */
470function my_img_meta($prefix = '') {
471    global $lang;
472
473	$format = '%Y-%m-%dT%T%z';	/* e.g. 2021-21-05T16:45:12+02:00 */
474
475    $tags = tpl_get_img_meta();
476
477    foreach($tags as $tag) {
478        $label = $lang[$tag['langkey']];
479        if(!$label) $label = $tag['langkey'] . ':';
480
481        echo $prefix . '<tr><th>'.$label.'</th><td>';
482        if ($tag['type'] == 'date') {
483            echo '<time datetime="' . strftime($format, $tag['value']) . '">' . dformat($tag['value']) . '</time>';
484        } else {
485            echo hsc($tag['value']);
486        }
487        echo "</td></tr>\n";
488    }
489}
490
491/**
492 * Creates the Site logo image link
493 *
494 */
495function my_sitelogo() {
496    global $conf;
497
498	// get logo either out of the template images folder or data/media folder
499	$logoSize = array();
500	$logo = tpl_getMediaFile(array(':logo.svg', ':wiki:logo.svg', ':logo.png', ':wiki:logo.png', 'images/sitelogo.svg'), false, $logoSize);
501	tpl_link( wl(),
502		'<img src="'.$logo.'" ' . $logoSize[3] . ' alt="' . htmlentities($conf['title']) . '" />', 'accesskey="h" title="[H]" class="logo"');
503}
504
505/**
506 * Creates the various favicon and similar links:
507 *
508 * @param  string $color overwrite the theme color.
509 *
510 * @return null
511 */
512function my_favicons($color = null) {
513
514	$logoSize = array();
515
516	// Theme color:
517	if ($color == null) {
518
519		/* get the style config */
520		$styleUtil = new \dokuwiki\StyleUtils();
521		$styleIni = $styleUtil->cssStyleini();
522		$replacements = $styleIni['replacements'];
523		$color = $replacements['__theme_color__'];
524
525		if ($color== null) { $color = '#2b73b7'; }
526	}
527	echo "\t<meta name=\"theme-color\" content=\"" . $color . "\" />\n";
528
529	// get the favicon:
530	$link = tpl_getMediaFile(array(':favicon.ico', ':favicon.png', ':favicon.svg', ':wiki:favicon.ico', ':wiki:favicon.png', ':wiki:favicon.svg'), false, $logoSize);
531	echo "\t<link rel=\"icon\" href=\"" . $link . "\" />\n";
532
533	// Apple Touch Icon
534	$logoSize = array();
535	$link = tpl_getMediaFile(array(':apple-touch-icon.png', ':wiki:apple-touch-icon.png', 'images/apple-touch-icon.png'), false, $logoSize);
536	echo "\t<link rel=\"apple-touch-icon\" href=\"" . $link . "\" />\n";
537
538}
539
540/**
541 * inserts the Cookies banner, if appropriate.
542 * This is based on Michal Koutny’s "cookielaw" plugin
543 *
544 * @param  string $prefix to be added before each line
545 */
546function my_cookiebanner($prefix = '') {
547
548	// get the configuration settings:
549	$msg = tpl_getConf('cookiemsg', '(no message configured)');
550	$position = tpl_getConf('cookiepos', 'bottom');
551	$link = tpl_getConf('cookielink', 'about:cookies');
552
553	// if the cookie is already set or position is set to hide, do nothing.
554	if ( isset($_COOKIE['cookielaw']) or $position == 'hide') {
555		return;
556	}
557
558	// output the HTML code:
559	echo $prefix . "<div id=\"cookiebanner\" class=\"cb_" . $position . "\">\n";
560	echo $prefix . "\t<p class=\"cb_info\"><span class=\"cb_icon\"></span>\n";
561	echo $prefix . "\t\t<span class=\"cb_msg\">". $msg . "</span>\r";
562	echo $prefix . "\t</p>\n";
563	echo $prefix . "\t<p class=\"cb_action\">\n";
564	echo $prefix . "\t\t<button>" . hsc(tpl_getLang('cookie_consent')) . "</button>\n";
565	echo $prefix . "\t\t";
566	if ( substr($link, 0, 7) == 'http://' || substr($link, 0, 8) == 'https://') {
567		echo '<a href="' . $link . '" target="_blank">' . hsc(tpl_getLang('cookie_linktext')) . '</a>';
568	} else {
569		tpl_pagelink($link, tpl_getLang('cookie_linktext'));
570	}
571	echo $prefix . "\n\t</p>\n" . $prefix . "</div>\n";
572
573}
574