my_template.php

<?php
/**
 * Overwriting DokuWiki template functions
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Sascha Leib <sascha@leib.be>
 */

use dokuwiki\Extension\Event;
use dokuwiki\File\PageResolver;

/**
 * Creates the Site logo image link
 *
 */
function my_sitelogo() {
    global $conf;

	// get logo either out of the template images folder or data/media folder
	$logoSize = array();
	$logo = tpl_getMediaFile(array(':logo.svg', ':wiki:logo.svg', ':logo.png', ':wiki:logo.png', 'images/sitelogo.svg'), false, $logoSize);
	tpl_link( my_homelink(),
		'<img src="'.$logo.'" ' . (is_array($logoSize) && array_key_exists(3, $logoSize) ? $logoSize[3] : '') . ' alt="' . htmlentities($conf['title']) . '">', 'class="logo"');
}

/**
 * get a link to the homepage.
 *
 * wraps the original wl() function to allow overriding in the options
 *
 * @author Sascha Leib <sascha@leib.be>
 *
 * @returns string (link)
 */
function my_homelink() {
    global $conf;

	$hl = trim(tpl_getConf('homelink'));

	if ( $hl !== '' ) {
		return $hl;
	} else {
		return wl(); // default homelink
	}
}

/**
 * My implementation of the basic userinfo (in the global banner)
 *
 *
 * @author Sascha Leib <sascha@leib.be>
 *
 * @param  string $prefix to be added before each line
 *
 * @return void
 */
function my_userinfo($prefix = '') {
    global $lang;
    global $INPUT;
    global $INFO;
    global $USERINFO;

    // is there a user logged in?
    $userid = $INPUT->server->str('REMOTE_USER');

    // get the user menu items:
    $items = (new \dokuwiki\Menu\UserMenu())->getItems();

    if (isset($USERINFO['name'])) { // user is loggd in:

        // output the button:
        echo $prefix . "<button id=\"user-button\" aria-haspopup=\"menu\" aria-controls=\"user-action-menu\">\n";
        echo $prefix . "\t<svg class=\"icon\" viewBox=\"0 0 24 24\"><path d=\"M12,4A4,4 0 0,1 16,8A4,4 0 0,1 12,12A4,4 0 0,1 8,8A4,4 0 0,1 12,4M12,14C16.42,14 20,15.79 20,18V20H4V18C4,15.79 7.58,14 12,14Z\" /></svg>\n";
        echo $prefix . "\t<span class=\"label\"><span class=\"sr-only\">" . htmlentities($lang['loggedinas']) . ' </span>' . htmlentities($USERINFO['name']) . "</span>\n";
        echo $prefix . "</button>\n";

        // add the menu:
        my_actionlist($prefix, 'user-action-menu', $items, ['admin'], '', true);

    } else {
        my_actionlist($prefix, 'user-action-buttons', $items, ['admin']);
    }

}

/**
 * Hierarchical breadcrumbs
 *
 * Cleanup of the original code to create neater and more accessible HTML
 *
 * @author Sascha Leib <sascha@leib.be>
 * @author Andreas Gohr <andi@splitbrain.org>
 * @author Nigel McNie <oracle.shinoda@gmail.com>
 * @author Sean Coates <sean@caedmon.net>
 * @author <fredrik@averpil.com>
 *
 * @param  string $prefix to be added before each line
 *
 */
function my_youarehere($prefix, $position, $return = false) {
	global $conf;
	global $ID;
	global $lang;
	
	// check if enabled
	if (!$conf['youarehere']) return false;
	
    // check if right position:
    if(tpl_getConf('youareherepos') !== $position) return false;
	
	// prepare output string:
	$out =  $prefix . '<h2 class="sr-only">' . $lang['youarehere'] . "</h2>\n";
	
	$parts = explode(':', $ID);
	$count = count($parts);

	/* start the list: */
	$out .= $prefix . "<ol class=\"youarehere\">\n";
	
	/* is there a higher-level homepage defined? */
	$hl = trim(tpl_getConf('homelink'));
	if ( $hl !== '' ) {
		
		$homeIcon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 5.69L17 10.19V18H15V12H9V18H7V10.19L12 5.69M12 3L2 12H5V20H11V14H13V20H19V12H22" /></svg>';
		
		$out .= $prefix . "\t<li class=\"home hasicon\">" . tpl_link( $hl, $homeIcon . '<span>' . htmlentities(tpl_getLang('homepage')) . '</span>', ' title="' . htmlentities(tpl_getLang('homepage')) . '"', true) . "</li>\n";
	}
	
	// always print the startpage
	$out .= $prefix . "\t<li" . ( $hl == '' ? ' class="home"' : '' ) . '>' . tpl_pagelink(':' . $conf['start'], null, true) . "</li>\n";
	
	// print intermediate namespace links
	$part = '';
	for ($i = 0; $i < $count - 1; $i++) {
		$part .= $parts[$i] . ':';
		$page = $part;
		if ($page == $conf['start']) continue; // Skip startpage
	
		// output
		$out .= $prefix . "\t<li>" . tpl_pagelink($page, null, true) . "</li>\n";
	}
	
	// print current page, skipping start page, skipping for namespace index
	if (isset($page)) {
		$page = (new PageResolver('root'))->resolveId($page);
		if ($page == $part . $parts[$i]) {
			$out .= $prefix . "</ol>\n";
			if ($return) return $out;
			echo $out;
			return true;
		}
	}
	$page = $part . $parts[$i];
	if ($page == $conf['start']) {
		$out .= $prefix . "</ol>\n";
		if ($return) return $out;
		echo $out;
		return true;
	}
	
	/* actual page link and end: */
	$out .= $prefix . "\t<li>" .tpl_pagelink($page, null, true) . "</li>\n";
	$out .= $prefix . "</ol>\n";

	if ($return) return $out;
	echo $out;
	return (bool)$out;
}

/**
 * Print the breadcrumbs trace
 *
 * Cleanup of the original code to create neater and more accessible HTML
 *
 * @author Sascha Leib <sascha@leib.be>
 * @author Andreas Gohr <andi@splitbrain.org>
 *
 * @param string $prefix inserted before each line
 *
 * @return void
 */
function my_breadcrumbs($prefix, $position) {
    global $lang;
    global $conf;

    //check if enabled
    if(!$conf['breadcrumbs']) return false;

    // check if right position:
    if(tpl_getConf('breadcrumbpos', 'none') !== $position) return false;

    $crumbs = breadcrumbs(); //setup crumb trace

	/* begin listing */
	echo $prefix . '<p class="sr-only">' . $lang['breadcrumb'] . "</p>\n";
	echo $prefix . "<ol class=\"trace\" reversed>";

    $last = count($crumbs);
    $i    = 0;
    foreach($crumbs as $id => $name) {
        $i++;
		echo '<li' . ($i == $last ? ' class="current"' : '') . '><bdi>' . tpl_link(wl($id), hsc($name), '', true) .  '</bdi></li>';
    }
	echo "</ol>\n";
}

/**
 * Inserts a cleaner version of the TOC
 *
 * This is an update of the original function that renders the TOC directly.
 *
 * @author Sascha Leib <sascha@leib.be>
 * @author Andreas Gohr <andi@splitbrain.org>
 *
 * @param  string $prefix to be added before each line
 *
 * @return void
 */
function my_toc($prefix = '') {
    global $TOC;
    global $ACT;
    global $ID;
    global $REV;
    global $INFO;
    global $conf;
    global $lang;
    $toc = array();

    if(is_array($TOC)) {
        // if a TOC was prepared in global scope, always use it
        $toc = $TOC;
    } elseif(($ACT == 'show' || substr($ACT, 0, 6) == 'export') && !$REV && $INFO['exists']) {
        // get TOC from metadata, render if neccessary
        $meta = p_get_metadata($ID, '', METADATA_RENDER_USING_CACHE);
        if(isset($meta['internal']['toc'])) {
            $tocok = $meta['internal']['toc'];
        } else {
            $tocok = true;
        }
        $toc = isset($meta['description']['tableofcontents']) ? $meta['description']['tableofcontents'] : null;
        if(!$tocok || !is_array($toc) || !$conf['tocminheads'] || count($toc) < $conf['tocminheads']) {
            $toc = array();
        }
    } elseif($ACT == 'admin') {
        // try to load admin plugin TOC
        /** @var $plugin AdminPlugin */
        if ($plugin = plugin_getRequestAdminPlugin()) {
            $toc = $plugin->getTOC();
            $TOC = $toc; // avoid later rebuild
        }
    }

	/* inline icons: */
	$iconSvg = "<svg width='100%' height='100%' viewBox='0 0 24 24' version='1.1' xmlns='http://www.w3.org/2000/svg'><rect class='top-bar' x='5' y='6' width='14' height='2'></rect><rect class='middle-bar' x='5' y='11' width='14' height='2'></rect><rect class='bottom-bar' x='5' y='16' width='14' height='2'></rect></svg>";

	$tocView = tpl_getConf('showtoc', 'hide');
	if (in_array($ACT, array('admin'))) {
		$tocView = 'hide';
	}
	
	/* Build the hierarchical list of headline links: */
	if (count($toc) >= intval($conf['tocminheads'])) {
		echo $prefix . "<aside id=\"toc\" class=\"toggle_{$tocView}\">\n";
		echo $prefix . "\t<div id=\"toc_header\"><h2>" . htmlentities($lang['toc']) . "</h2><button type=\"button\" id=\"toc-menubutton\" class=\"tg_button\" title=\"" . htmlentities($lang['toc']) . '" aria-haspopup="true" aria-controls="toc-menu"><span class="sr-only">' . htmlentities($lang['toc']) . "</span>" . $iconSvg . "</button></div>\n";
		echo $prefix . "\t<div id=\"toc-menu\" class=\"tg_content\" role=\"menu\" aria-labelledby=\"toc-menubutton\">";
		
		$level = 0;
		foreach($toc as $it) {
			
			$nl = intval($it['level']);
			$cp = ($nl <=> $level);

			if ($cp > 0) {
				while ($level < $nl) {
					echo "\n" . $prefix . str_repeat("\t", $level*2 + 2) . "<ol>\n";
					$level++;
				}
			} else if ($cp < 0) {
				while ($level > $nl) {
					echo "\n" . $prefix . str_repeat("\t", $level*2) . "</ol>\n" . $prefix . str_repeat("\t", $level*2-1) . "</li>\n";
					$level--;
				}
			} else {
				echo "</li>\n";
			}
			
			$href = ( array_key_exists('link', $it ) ? $it['link'] : '' ) . ( array_key_exists('hid', $it) && $it['hid'] !== '' ? '#' . $it['hid'] : '' );

			echo $prefix . str_repeat("\t", $nl*2 + 1) . '<li  role="presentation"><a role="menuitem" href="' . $href . '">' . htmlentities($it['title']) . "</a>";
			$level = $nl;
		}
		
		for ($i = $level-1; $i > 0; $i--) {
			echo "</li>\n" . $prefix . str_repeat("\t", $i*2 + 1) . "</ol>";
		}
			
		echo "</li>\n" . $prefix . "\t\t</ol>\n" . $prefix . "\t</div>\n" . $prefix . "</aside>\n";
	}
}

/**
 * Insert the main headline for the page
 *
 * provides additional configuration options for this element
 *
 * @author Sascha Leib <sascha@leib.be>
 *
 * @param string $prefix inserted before each line
 *
 * @return void
 */
function my_pagetitle($prefix) {
    global $ID;
    global $conf;
	
	/* get the header style */
	$type = my_headerstyle();

	/* build the headline section */
	echo $prefix . '<div class="type-' . $type . "\">\n";
	switch ($type) {
		case 'file':
			tpl_includeFile('title.html');
			break;
		case 'sitename':
			echo $prefix . "\t<h2 class=\"title\">" . $conf['title'] . "</h2>\n";
			if ($conf['tagline'] && $conf['tagline'] !== '') {
				echo $prefix . "\t<p class=\"tagline\">" . $conf['tagline'] . "</p>\n";
			}
			break;
		case 'pagename':
			echo $prefix . "\t<h1>" . tpl_pagetitle($ID, true) . "</h1>\n";
			break;
		default:
			echo "<pre>UNKNOWN:" . tpl_getConf('pageheadline') . "</pre>";
			break;
	}
	echo $prefix . "</div>\n";

}

/**
 * Print the breadcrumbs trace
 *
 * Cleanup of the original code to create neater and more accessible HTML
 *
 * @author Sascha Leib <sascha@leib.be>
 * @author Andreas Gohr <andi@splitbrain.org>
 *
 * @param string $prefix inserted before each line
 *
 * @return void
 */
function my_banner_style() {
    global $ID;
    global $conf;

    /* don't run if banner image is disabled */
    if (trim(tpl_getConf('bannerimg')) == '') return;

    $background = null;

    /* list of extensions to look for (in reverse order) */
    $exts = array('jpg','jpeg','png','svg');

    /* build a list of paths to look at: */
    $cpath = '';
    $paths = array();
    foreach (explode(':', $ID) as $it) {
        foreach ($exts as $ext) {
            array_push($paths, $cpath . trim(tpl_getConf('bannerimg')) . '.' . $ext);
        }
        $cpath .= $it . ':';
    }
    $paths = array_reverse($paths); /* reverse the order */

    /* check if an image exists in one of the paths: */
    foreach ($paths as $rpath) {
        $lpath = mediaFN($rpath);
        if (file_exists($lpath)) {
            $background = ml($rpath, '', true, '', false);
            break;
        }
    }
	/* if not found, use the template banner: */
	if (!$background) {
		$background = tpl_basedir() . 'images/banner.jpg';
	}

    /* find the element height */
    $height = tpl_getConf('bannersize', 'inherit');


    if ($background) {
        echo "background-image: url('" . $background . "');min-height: " . $height . ';';
    }
}

/**
 * Modification of the original tpl_license in the DokuWiki code
 *
 * @author Andreas Gohr <andi@splitbrain.org>
 * @author Sascha Leib <ad@hominem.info>
 *
 * @param string $target open link in new tab?
 */
function my_license_button($target) {
    global $license;
    global $conf;
    global $lang;
    if(!$conf['license']) return '';
    if(!is_array($license[$conf['license']])) return '';
    $lic = $license[$conf['license']];
    $trg = ($target) ? ' target="'.$target.'"' : '';

    $src = 'lib/tpl/nuropa/images/license/'.$conf['license'].'.svg';

    echo "\t<a href=\"".$lic['url'].'" rel="license"'.$trg.'><img src="'.DOKU_BASE.$src.'" alt="'.$lic['name'].'" width="80" height="15" /></a>';
}

/**
 * Wrapper for tpl_classes to add template classes
 *
 * @author Sascha Leib <ad@hominem.info>
 */
function my_bodyclasses() {

    global $conf;
	
	$cls = tpl_classes();
	
	/* enable darkmode? */
	if (tpl_getConf('darkmode') === 'auto') {
		$cls .= ' darkmode';
	}
	
	return $cls;
}

/* private helper function to putput a list of action items: */
function my_actionlist($prefix, $id, $list, $exclude, $type = '', $hidden = false) {

	/* build menu */
	echo $prefix . '<ul id="' . $id . '" class="' . htmlentities($type) . '"'  . ($hidden ? ' style="display:none"' : '') . ">\n";
	foreach($list as $it) {
		//echo '<!-- ' . print_r($it, true) . ' -->';
		$typ = htmlentities($it->getType());
		if (!in_array($typ, $exclude)) {
			
		echo $prefix . "\t<li data-type=\"" . $typ . '">'
					 . my_HtmlLink($it, false, true)
					 . "</li>\n";
		}
	}
	echo $prefix . "</ul>\n";
};

/* overwrite the asHtmlLink function for my purposes */
function my_HtmlLink($item, $classprefix = 'menuitem ', $svg = true) {

	$attr = buildAttributes($item->getLinkAttributes($classprefix));
	$html = "<a $attr>";
	if ($svg) {
		$html .= inlineSVG($item->getSvg());
		$html .= '<span>' . hsc($item->getLabel()) . '</span>';
	} else {
		$html .= hsc($item->getLabel());
	}
	$html .= "</a>";
	return $html;
}

/* helper function to determine the headline style: */
function my_headerstyle() {
	global $ID;
    global $conf;
	
	/* what kind of headline should be included? */
	$type = tpl_getConf('pageheadline');
	if ($type == 'siteonhp') {
		if ($ID == $conf['start']) {
			$type = 'sitename';
		} else {
			$type = 'pagename';
		}
	}
	return $type;
}

/**
 * creates a back to top button
 *
 * Buids the HTML code to insert the "to top" button
 *
 * @author Sascha Leib <sascha@leib.be>
 * @author Andreas Gohr <andi@splitbrain.org>
 *
 * @param string $prefix inserted before each line
 *
 * @return string html
**/
function my_topbtn($prefix)
{
    global $lang;

	$iconSvg = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M7.41,15.41L12,10.83L16.59,15.41L18,14L12,8L6,14L7.41,15.41Z" style="fill:#166DDF" /></svg>';

	$html = $prefix . "<div id=\"to-top-block\">\n"
					. "\t<a href=\"#main-content\" title=\"" . $lang['btn_top'] ." [t]\" rel=\"nofollow\" accesskey=\"t\">\n"
					. "\t<span class=\"sr-only\">" . $lang['btn_top'] ." </span>\n"
					. "\t\t" . $iconSvg . "</a></div>\n";

    return $html;
}