xref: /plugin/button/syntax.php (revision ce70c671b839cef6d2bfaf1e11d59287507dc075)

<?php
/**
 * Plugin Button : Add button with image support syntax for links
 *
 * To be run with Dokuwiki only

 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Rémi Peyronnet  <remi+xslt@via.ecp.fr>

 Full Syntax :
     [[{namespace:image|extra css}wiki page|Title of the link]]

 All fields optional, minimal syntax:
    [[{}Simple button]]

 Configuration :
    [[{conf.styles}style|css]]
    [[{conf.target}style|target]]

 19/05/2013 : Initial release
 20/04/2014 : Added target support (feature request from Andrew St Hilaire)
 07/06/2014 : Added dokuwiki formatting support in title section (not working in wiki page section) (feature request from Willi Lethert)
 30/08/2014 : Added toolbar button (contribution from Xavier Decuyper) and fixed local anchor (bug reported by Andreas Kuzma)
 06/09/2014 : Refactored to add backlinks support (feature request from Schümmer Hans-Jürgen)
 28/04/2015 : Refactored global config handling, add internal media link support, add escaping of userinput (contribution from Peter Stumm   https://github.com/lisps/plugin-button)
 05/08/2015 : Merged lisps default style option and added french translation
 12/09/2015 : Fixed PHP error
 30/04/2020 : Fixed spaces in image field
 04/08/2020 : Quick hack to add compatibility with hogfather
 07/02/2022 : Added Português do Brasil translation (PR by mac-sousa)
 26/11/2022 : Fixed PHP8.1 warnings
 13/12/2022 : Fixed PHP7 with str_contains polyfill
 05/01/2025 : Added support for interwiki links  (#35)

 @author ThisNameIsNotAllowed
 17/11/2016 : Added generation of metadata
 18/11/2016 : Added default target for external links

 @author lisps
 05/03/2017 : Merged lisps move compatibility fixes

 @author nerun
 18/08/2023 : Fixed deprecation warnings in PHP 8+  (#33)

 @author kmlucy
 14/07/2026 : Fixed compatibility with DokuWiki Mort (#37)

 Knwon bugs:
 - handle / render repartition is not optimal regarding caching, most of the processing should be moved (#14)
*/


use dokuwiki\File\PageResolver;
use dokuwiki\File\MediaResolver;

if (!defined('DOKU_INC'))
    die();
if (!defined('DOKU_PLUGIN'))
    define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');

/*  2020-08-04 - This is a quick hack to fix compatibility issue with hogfather (see issue #13) :
 *  It seems that the handler.php file is no more loaded when rendering cached contents, causing a crash.
 *  This is due to a bad initial conception of this plugin that does not comply to dokuwiki's guidance of handle / render repartition.
 *
 *  FIXME : refactor handle / render repartition ; most of the processing should be moved in the handle section.
 *  /!\ to be able to do that (and thus, modify the cached content structure) need to find a way to clear the cache while upgrading the plugin...
 *
 * 2026-06-14 : This hack is no more needed, you may need to uncomment this line if you are using an old version of dokuwiki (2020-2025)
 *
 * require_once(DOKU_INC . 'inc/parser/handler.php');
 */

// str_contains polyfill for PHP versions before PHP8  (by jnv - #26)
if (!function_exists('str_contains')) {
    function str_contains(string $haystack, string $needle): bool
    {
        return '' === $needle || false !== strpos($haystack, $needle);
    }
}

class syntax_plugin_button extends DokuWiki_Syntax_Plugin
{

    function getType()
    {
        return 'substition';
    }
    function getPType()
    {
        return 'normal';
    }
    function getSort()
    {
        return 25;
    } // Internal link is 300

    function connectTo($mode)
    {
        $this->Lexer->addSpecialPattern('\[\[{conf[^}]*}[^\]]*\]\]', $mode, 'plugin_button');
        $this->Lexer->addEntryPattern('\[\[{[^}]*}[^\]\|]*\|?', $mode, 'plugin_button');
        $this->Lexer->addExitPattern(']]', 'plugin_button');
    }
    function postConnect()
    {
    }
    function getAllowedTypes()
    {
        return array('formatting', 'substition');
    }



    protected $confStyles;
    protected $styles = array();
    protected $targets = array();
    protected function setStyle($name, $value)
    {
        global $ID;
        $this->styles[$ID][$name] = $value;
    }
    protected function getStyle($name)
    {
        global $ID;
        return isset($this->styles[$ID][$name]) ? $this->styles[$ID][$name] : $this->getConfStyles($name);
    }
    protected function hasStyle($name)
    {
        global $ID;
        return (array_key_exists($ID, $this->styles) && is_array($this->styles[$ID]) && array_key_exists($name, $this->styles[$ID]))
            || $this->getConfStyles($name) ? true : false;
    }
    protected function getConfStyles($name = null)
    {
        if ($this->confStyles === null) {
            $this->confStyles = array();

            $styles = $this->getConf('styles');
            if (!$styles)
                return;

            $styles = explode("\n", $styles);
            if (!is_array($styles))
                return;

            foreach ($styles as $style) {
                $style = trim($style);
                if (!$style)
                    continue;

                if (str_contains($style, '|')) {

                    $style = explode('|', $style, 2);
                    if (!is_array($style) || !$style[0] || !$style[1])
                        continue;

                    $this->confStyles[trim($style[0])] = trim($style[1]);
                }
            }
            //dbg($this->confStyles);

        }

        if ($name) {
            if (!isset($this->confStyles[$name]))
                return false;

            return $this->confStyles[$name];
        }
        return $this->confStyles;

    }


    protected function setTarget($name, $value)
    {
        global $ID;
        $this->targets[$ID][$name] = $value;
    }
    protected function getTarget($name)
    {
        global $ID;
        return $this->targets[$ID][$name];
    }
    protected function hasTarget($name)
    {
        global $ID;
        return (array_key_exists($ID, $this->targets) && is_array($this->targets[$ID]) && array_key_exists($name, $this->targets[$ID])) ? true : false;
    }

    function handle($match, $state, $pos, Doku_Handler $handler)
    {
        global $plugin_button_styles;
        global $plugin_button_target;

        switch ($state) {
            case DOKU_LEXER_SPECIAL:
            case DOKU_LEXER_ENTER:
                $data = '';
                // Button
                if (preg_match('/\[\[{ *(?<image>[^}\|]*) *\|?(?<css>[^}]*)}(?<link>[^\]\|]*)\|?(?<title>[^\]]*)/', $match, $matches)) {
                    $data = $matches;
                }
                if (is_array($data)) {
                    if ($data['image'] == 'conf.styles') {
                        $this->setStyle($data['link'], $data['title']);
                    } else if ($data['image'] == 'conf.target') {
                        $this->setTarget($data['link'], $data['title']);
                    } else {
                        $data['target'] = "";
                        if ($this->hasTarget($data['css'])) {
                            $data['target'] = $this->getTarget($data['css']);
                        } else if ($this->hasTarget('default')) {
                            $data['target'] = $this->getTarget('default');
                        }


                        if ($data['css'] != "" && $this->hasStyle($data['css'])) {
                            $data['css'] = $this->getStyle($data['css']);
                        }

                        if ($this->hasStyle('default') && ($data['css'] != 'default')) {
                            $data['css'] = $this->getStyle('default') . ' ; ' . $data['css'];
                        }
                    }
                }

                return array($state, $data);

            case DOKU_LEXER_UNMATCHED:
                return array($state, $match);
            case DOKU_LEXER_EXIT:
                return array($state, '');
        }
        return array();
    }

    function render($mode, Doku_Renderer $renderer, $data)
    {
        global $plugin_button_styles;
        global $plugin_button_target;
        global $ID;
        global $conf;

        if ($mode == 'xhtml') {
            list($state, $match) = $data;
            switch ($state) {
                case DOKU_LEXER_SPECIAL:
                case DOKU_LEXER_ENTER:
                    if (is_array($match)) {
                        $image = $match['image'];
                        if (($image != "conf.target") && ($image != "conf.styles")) {
                            // Test if internal or external link (from handler.php / internallink)
                            // 2020-07-09 : added special prefix '!' to allow other URI schemes without '//' in it (ex : apt,...)
                            $force_uri_prefix = "!"; // "/" can be confused with url, "!" not working
                            if ((substr($match['link'], 0, strlen($force_uri_prefix)) === $force_uri_prefix) || (preg_match('#^mailto:|^([a-z0-9\-\.+]+?)://#i', $match['link']))) {
                                // External
                                $link['url'] = $match['link'];
                                // Strip trailing prefix
                                if (substr($link['url'], 0, strlen($force_uri_prefix)) === $force_uri_prefix) {
                                    $link['url'] = substr($link['url'], strlen($force_uri_prefix));
                                }
                                // Check if it is an allowed protocol
                                $link_items = explode(":", $link['url']);
                                // Adds mailto as it is implicitely allowed wih mail syntax.
                                if (!in_array($link_items[0], getSchemes() + array('mailto'))) {
                                    $link['url'] = "Unauthorized URI scheme";
                                }
                                $link['name'] = $match['title'];
                                if ($link['name'] == "")
                                    $link['name'] = $match['link'];
                                $link['class'] = 'urlextern';
                                if (strlen($match['target']) == 0) {
                                    $match['target'] = $conf['target']['extern'];
                                }
                            } else {
                                // Internal
                                $link = $this->dokuwiki_get_link($renderer, $match['link'], $match['title']);
                            }
                            $target = $match['target'];
                            if ($target)
                                $target = " target ='" . hsc($target) . "' ";

                            $link['name'] = str_replace('\\\\', '<br />', $link['name']); //textbreak support
                            if ($image != '') {
                                $image = Doku_Handler_Parse_Media("{{" . $image . "}}");
                                $image = $this->internalmedia($renderer, $image['src'], null, null, $image['width'], $image['height']);
                                $image = "<span class='plugin_button_image'>" . $image['name'] . "</span>";
                            }
                            $text = "<a " . $target . " href='" . $link['url'] . "'><span class='plugin_button' style='" . hsc($match['css']) . "'>$image<span class='plugin_button_text ${link['class']}'>";
                            if (substr($match[0], -1) != "|")
                                $text .= $link['name'];
                            $renderer->doc .= $text;
                            // Update meta data for move
                            p_set_metadata(
                                $ID,
                                array(
                                    'relation' => array(
                                        'references' => array(
                                            $match['link'] => true,
                                        ),
                                        'media' => array(
                                            $match['image'] => true,
                                        ),
                                    ),
                                    'plugin_move' => array(
                                        'pages' => array(
                                            $match['link'],
                                        ),
                                        'medias' => array(
                                            $match['image'],
                                        ),
                                    ),
                                )
                            );
                        }
                    }
                    break;

                case DOKU_LEXER_UNMATCHED:
                    $renderer->doc .= $renderer->_xmlEntities($match);
                    break;
                case DOKU_LEXER_EXIT:
                    $renderer->doc .= "</span></span></a>";
                    break;
            }
            return true;
        } elseif ($mode == 'metadata') {
            list($state, $match) = $data;
            switch ($state) {
                case DOKU_LEXER_SPECIAL:
                case DOKU_LEXER_ENTER:
                    if (is_array($match)) {
                        /** @var Doku_Renderer_metadata $renderer */
                        $renderer->internallink($match['link']);
                        // I am assuming that when processing in handle(), you have stored
                        // the link destination in $data[0]
                        return true;
                    }
                    break;
                case DOKU_LEXER_UNMATCHED:
                    break;
                case DOKU_LEXER_EXIT:
                    break;
            }
            return true;
        }
        return false;
    }

    // TODO: the way we get links from dokuwiki should be completely rewritten
    // - target: rework repartition between parser/renderer to match dokuwiki guidelines
    // - try to override $xhtml->_formatLink($link); to avoid the code duplication of the functions below

    function dokuwiki_get_link(&$xhtml, $id, $name = NULL)
    {
        global $ID;

        if (link_isinterwiki($id)) {
            [$wikiName, $wikiUri] = sexplode('>', $id, 2, '');
            $exists = null;
            //$url = $xhtml->_resolveInterWiki($wikiName, $wikiUri, $exists);
            $link = $this->interwikilink($xhtml, $id, $name, $wikiName, $wikiUri, true);
            return $link;
        }

        $resolveid = $id; // To prevent resolve_pageid to change $id value
        $resolveid = (new PageResolver($ID))->resolveId($resolveid);
        $exists = page_exists($resolveid);
        if ($exists) {
            return $this->internallink($xhtml, $id, $name);
        }
        $resolveid = $id;
        $resolveid = (new MediaResolver($ID))->resolveId($resolveid);
        $exists = media_exists($resolveid);
        if ($exists) {
            return $this->internalmedia($xhtml, $id, $name);
        } else {
            return $this->internallink($xhtml, $id, $name);
        }
    }

    // Copied and adapted from inc/parser/xhtml.php, function internallink (see RPHACK)
    // Should use wl instead (from commons), but this won't do the trick for the name
    function internallink(&$xhtml, $id, $name = NULL, $search = NULL, $returnonly = false, $linktype = 'content')
    {
        global $conf;
        global $ID;
        global $INFO;


        $params = '';
        $parts = explode('?', $id, 2);
        if (count($parts) === 2) {
            $id = $parts[0];
            $params = $parts[1];
        }

        // For empty $id we need to know the current $ID
        // We need this check because _simpleTitle needs
        // correct $id and resolve_pageid() use cleanID($id)
        // (some things could be lost)
        if ($id === '') {
            $id = $ID;
        }

        // RPHACK for get_link to work with local links '#id'
        if (substr($id, 0, 1) === '#') {
            $id = $ID . $id;
        }
        // -------

        // default name is based on $id as given
        $default = $xhtml->_simpleTitle($id);

        // now first resolve and clean up the $id
        $id = (new PageResolver($ID))->resolveId($id);
        $exists = page_exists($id);

        $name = $xhtml->_getLinkTitle($name, $default, $isImage, $id, $linktype);
        if (!$isImage) {
            if ($exists) {
                $class = 'wikilink1';
            } else {
                $class = 'wikilink2';
                $link['rel'] = 'nofollow';
            }
        } else {
            $class = 'media';
        }

        //keep hash anchor
        $hash = NULL;
        if (str_contains($id, '#'))
            list($id, $hash) = explode('#', $id, 2);
        if (!empty($hash))
            $hash = $xhtml->_headerToLink($hash);

        //prepare for formating
        $link['target'] = $conf['target']['wiki'];
        $link['style'] = '';
        $link['pre'] = '';
        $link['suf'] = '';
        // highlight link to current page
        if ($id == $INFO['id']) {
            $link['pre'] = '<span class="curid">';
            $link['suf'] = '</span>';
        }
        $link['more'] = '';
        $link['class'] = $class;
        $link['url'] = wl($id, $params);
        $link['name'] = $name;
        $link['title'] = $id;
        //add search string
        if ($search) {
            ($conf['userewrite']) ? $link['url'] .= '?' : $link['url'] .= '&amp;';
            if (is_array($search)) {
                $search = array_map('rawurlencode', $search);
                $link['url'] .= 's[]=' . join('&amp;s[]=', $search);
            } else {
                $link['url'] .= 's=' . rawurlencode($search);
            }
        }

        //keep hash
        if ($hash)
            $link['url'] .= '#' . $hash;

        return $link;
        //output formatted
        //if($returnonly){
        //    return $this->_formatLink($link);
        //}else{
        //    $this->doc .= $this->_formatLink($link);
        //}
    }


    function internalmedia(
        &$xhtml,
        $src,
        $title = NULL,
        $align = NULL,
        $width = NULL,
        $height = NULL,
        $cache = NULL,
        $linking = NULL
    ) {
        global $ID;

        $hash = NULL;
        if (str_contains($src, '#'))
            list($src, $hash) = explode('#', $src, 2);
        $src = (new MediaResolver($ID))->resolveId($src);
        $exists = media_exists($src);

        $noLink = false;
        $render = ($linking == 'linkonly') ? false : true;
        $link = $xhtml->_getMediaLinkConf($src, $title, $align, $width, $height, $cache, $render);

        list($ext, $mime, $dl) = mimetype($src, false);
        if (substr($mime, 0, 5) == 'image' && $render) {
            $link['url'] = ml($src, array('id' => $ID, 'cache' => $cache), ($linking == 'direct'));
        } elseif ($mime == 'application/x-shockwave-flash' && $render) {
            // don't link flash movies
            $noLink = true;
        } else {
            // add file icons
            $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $ext);
            $link['class'] .= ' mediafile mf_' . $class;
            $link['url'] = ml($src, array('id' => $ID, 'cache' => $cache), true);
            if ($exists)
                $link['title'] .= ' (' . filesize_h(filesize(mediaFN($src))) . ')';
        }

        if ($hash)
            $link['url'] .= '#' . $hash;

        //markup non existing files
        if (!$exists) {
            $link['class'] .= ' wikilink2';
        }

        return $link;
        //output formatted
        //if ($linking == 'nolink' || $noLink) $this->doc .= $link['name'];
        //else $this->doc .= $this->_formatLink($link);
    }

    public function interwikilink(&$xhtml, $match, $name, $wikiName, $wikiUri, $returnonly = false)
    {
        global $conf;

        $link = [];
        $link['target'] = $conf['target']['interwiki'];
        $link['pre'] = '';
        $link['suf'] = '';
        $link['more'] = '';
        $link['name'] = $xhtml->_getLinkTitle($name, $wikiUri, $isImage);
        $link['rel'] = '';

        //get interwiki URL
        $exists = null;
        $url = $xhtml->_resolveInterWiki($wikiName, $wikiUri, $exists);

        if (!$isImage) {
            $class = preg_replace('/[^_\-a-z0-9]+/i', '_', $wikiName);
            $link['class'] = "interwiki iw_$class";
        } else {
            $link['class'] = 'media';
        }

        //do we stay at the same server? Use local target
        if (strpos($url, DOKU_URL) === 0 || strpos($url, DOKU_BASE) === 0) {
            $link['target'] = $conf['target']['wiki'];
        }
        if ($exists !== null && !$isImage) {
            if ($exists) {
                $link['class'] .= ' wikilink1';
            } else {
                $link['class'] .= ' wikilink2';
                $link['rel'] .= ' nofollow';
            }
        }
        if ($conf['target']['interwiki']) $link['rel'] .= ' noopener';

        $link['url'] = $url;
        $link['title'] = $xhtml->_xmlEntities($link['url']);

        // return non formatted link
        return $link;

        /*
        // output formatted
        if ($returnonly) {
            if ($url == '') return $link['name'];
            return $this->_formatLink($link);
        } elseif ($url == '') {
            $this->doc .= $link['name'];
        } else $this->doc .= $this->_formatLink($link);
        */
    }
}

?>