xref: /plugin/mikioplugin/syntax/core.php (revision 7935713e90ae66bca4380ea057ab7fd4f3e18daa)

<?php
/**
 * Mikio Core Syntax Plugin
 *
 * @link        http://github.com/nomadjimbob/mikioplugin
 * @license     GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author      James Collins <james.collins@outlook.com.au>
 */
if (!defined('DOKU_INC')) die();
if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');

define('MIKIO_LEXER_AUTO', 0);
define('MIKIO_LEXER_ENTER', 1);
define('MIKIO_LEXER_EXIT', 2);
define('MIKIO_LEXER_SPECIAL', 3);

class syntax_plugin_mikioplugin_core extends DokuWiki_Syntax_Plugin
{
    public $pattern_entry       = '';
    public $pattern             = '';
    public $pattern_exit        = '';
    public $tag                 = '';
    public $hasEndTag           = true;
    public $options             = array();

    protected $tagPrefix          = ''; //'mikio-';
    protected $classPrefix        = 'mikiop-';
    protected $elemClass          = 'mikiop';

    private $values              = array();


    function __construct() { }
    public function getType() { return 'formatting'; }
    public function getAllowedTypes() { return array('formatting', 'substition', 'disabled', 'paragraphs'); }
    // public function getAllowedTypes() { return array('formatting', 'substition', 'disabled'); }
    public function getSort() { return 32; }
    public function getPType() { return 'stack'; }


    public function connectTo($mode)
    {
        if ($this->pattern_entry == '' && $this->tag != '') {
            if ($this->hasEndTag) {
                $this->pattern_entry = '<(?i:' . $this->tagPrefix . $this->tag . ')(?=[ >]).*?>(?=.*?</(?i:' . $this->tagPrefix . $this->tag . ')>)';
            } else {
                $this->pattern_entry = '<(?i:' . $this->tagPrefix . $this->tag . ').*?>';
            }
        }

        if ($this->pattern_entry != '') {
            if ($this->hasEndTag) {
                $this->Lexer->addEntryPattern($this->pattern_entry, $mode, 'plugin_mikioplugin_' . $this->getPluginComponent());
            } else {
                $this->Lexer->addSpecialPattern($this->pattern_entry, $mode, 'plugin_mikioplugin_' . $this->getPluginComponent());
            }
        }
    }


    public function postConnect()
    {
        if ($this->hasEndTag) {
            if ($this->pattern_exit == '' && $this->tag != '') {
                $this->pattern_exit = '</(?i:' . $this->tagPrefix . $this->tag . ')>';
            }

            if ($this->pattern_exit != '') {
                $this->Lexer->addExitPattern($this->pattern_exit, 'plugin_mikioplugin_' . $this->getPluginComponent());
            }
        }
    }

    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        switch ($state) {
            case DOKU_LEXER_ENTER:
            case DOKU_LEXER_SPECIAL:
                $optionlist = preg_split('/\s(?=([^"]*"[^"]*")*[^"]*$)/', trim(substr($match, strlen($this->tagPrefix . $this->tag) + 1, -1)));

                $options = array();
                foreach ($optionlist as $item) {
                    $i = strpos($item, '=');
                    if ($i !== false) {
                        $value = substr($item, $i + 1);

                        if (substr($value, 0, 1) == '"') $value = substr($value, 1);
                        if (substr($value, -1) == '"') $value = substr($value, 0, -1);

                        $options[substr($item, 0, $i)] = $value;
                    } else {
                        $options[$item] = true;
                    }
                }

                if(count($this->options) > 0) {
                    $options_clean = $this->cleanOptions($options);
                } else {
                    $options_clean = $options;
                }

                $this->values = $options_clean;

                return array($state, $options_clean);

            case DOKU_LEXER_MATCHED:
                return array($state, $match);

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

            case DOKU_LEXER_EXIT:
                return array($state, $this->values);
        }

        return array();
    }


    /*
    * clean element options to only supported attributes, setting defaults if required
    *
    * @param $options   options passed to element
    * @return           array of options supported with default set
    */
    protected function cleanOptions($data, $options=null)
    {
        $optionsCleaned = array();

        if($options == null) $options = $this->options;

        // Match DokuWiki passed options to syntax options
        foreach ($data as $optionKey => $optionValue) {
            foreach ($options as $syntaxKey => $syntaxValue) {
                if (strcasecmp($optionKey, $syntaxKey) == 0) {
                    if (array_key_exists('type', $options[$syntaxKey])) {
                        $type = $options[$syntaxKey]['type'];

                        switch ($type) {
                            case 'boolean':
                                $optionsCleaned[$syntaxKey] = filter_var($optionValue, FILTER_VALIDATE_BOOLEAN);
                                break;
                            case 'number':
                                $optionsCleaned[$syntaxKey] = filter_var($optionValue, FILTER_VALIDATE_INT);
                                break;
                            case 'float':
                                $optionsCleaned[$syntaxKey] = filter_var($optionValue, FILTER_VALIDATE_FLOAT);
                                break;
                            case 'text':
                                $optionsCleaned[$syntaxKey] = $optionValue;
                                break;
                            case 'size':
                                $s = strtolower($optionValue);
                                $i = '';
                                if (substr($s, -3) == 'rem') {
                                    $i = substr($s, 0, -3);
                                    $s = 'rem';
                                } elseif (substr($s, -2) == 'em') {
                                    $i = substr($s, 0, -2);
                                    $s = 'em';
                                }
                                elseif (substr($s, -2) == 'px') {
                                    $i = substr($s, 0, -2);
                                    $s = 'px';
                                }
                                elseif (substr($s, -1) == '%') {
                                    $i = substr($s, 0, -1);
                                    $s = '%';
                                }
                                else {
                                    $i = filter_var($s, FILTER_VALIDATE_INT);
                                    if ($i == '') $i = '1';
                                    $s = 'rem';
                                }

                                $optionsCleaned[$syntaxKey] = $i . $s;
                                break;
                            case 'color':
                                if (strlen($optionValue) == 3 || strlen($optionValue) == 6) {
                                    preg_match('/([[:xdigit:]]{3}){1,2}/', $optionValue, $matches);
                                    if (count($matches) > 1) {
                                        $optionsCleaned[$syntaxKey] = '#' . $matches[0];
                                    }
                                } else {
                                    $optionsCleaned[$syntaxKey] = $optionValue;
                                }
                                break;
                            case 'url':
                                $optionsCleaned[$syntaxKey] = $this->buildLink($optionValue);
                                break;
                            case 'media':
                                $optionsCleaned[$syntaxKey] = $this->buildMediaLink($optionValue);
                                break;
                            case 'choice':
                                if (array_key_exists('data', $options[$syntaxKey])) {
                                    foreach ($options[$syntaxKey]['data'] as $choiceKey => $choiceValue) {
                                        if (is_array($choiceValue)) {
                                            foreach ($choiceValue as $choiceItem) {
                                                if (strcasecmp($optionValue, $choiceItem) == 0) {
                                                    $optionsCleaned[$syntaxKey] = $choiceKey;
                                                    break 2;
                                                }
                                            }
                                        } else {
                                            if (strcasecmp($optionValue, $choiceValue) == 0) {
                                                $optionsCleaned[$syntaxKey] = $choiceValue;
                                                break;
                                            }
                                        }
                                    }
                                }
                                break;
                            case 'set':
                                if (array_key_exists('option', $options[$syntaxKey]) && array_key_exists('data', $options[$syntaxKey])) {
                                    $optionsCleaned[$options[$syntaxKey]['option']] = $options[$syntaxKey]['data'];
                                }
                                break;
                        }
                    }

                    break;
                } else {
                    if (array_key_exists('type', $options[$syntaxKey]) && $options[$syntaxKey]['type'] == 'choice' && array_key_exists('data', $options[$syntaxKey])) {
                        foreach ($options[$syntaxKey]['data'] as $choiceKey => $choiceValue) {
                            if (is_array($choiceValue)) {
                                foreach ($choiceValue as $choiceItem) {
                                    if (strcasecmp($optionKey, $choiceItem) == 0) {
                                        $optionsCleaned[$syntaxKey] = $choiceKey;
                                        break 2;
                                    }
                                }
                            } else {
                                if (strcasecmp($optionKey, $choiceValue) == 0) {
                                    $optionsCleaned[$syntaxKey] = $choiceValue;
                                    break;
                                }
                            }
                        }
                    }
                }
            }
        }

        // Add in syntax options that are missing
        foreach ($options as $optionKey => $optionValue) {
            if (!array_key_exists($optionKey, $optionsCleaned)) {
                if (array_key_exists('default', $options[$optionKey])) {
                    switch ($options[$optionKey]['type']) {
                        case 'boolean':
                            $optionsCleaned[$optionKey] = filter_var($options[$optionKey]['default'], FILTER_VALIDATE_BOOLEAN);
                            break;
                        case 'number':
                            $optionsCleaned[$optionKey] = filter_var($options[$optionKey]['default'], FILTER_VALIDATE_INT);
                            break;
                        default:
                            $optionsCleaned[$optionKey] = $options[$optionKey]['default'];
                            break;
                    }
                }
            }
        }

        return $optionsCleaned;
    }

    /* Lexer renderers */
    protected function render_lexer_enter(Doku_Renderer $renderer, $data) { }
    protected function render_lexer_unmatched(Doku_Renderer $renderer, $data) { $renderer->doc .= $renderer->_xmlEntities($data); }
    protected function render_lexer_exit(Doku_Renderer $renderer, $data) { }
    protected function render_lexer_special(Doku_Renderer $renderer, $data) { }
    protected function render_lexer_match(Doku_Renderer $renderer, $data) { }

    /* Renderer */
    public function render($mode, Doku_Renderer $renderer, $data)
    {
        if ($mode == 'xhtml') {
            list($state, $match) = $data;

            switch ($state) {
                case DOKU_LEXER_ENTER:
                    $this->render_lexer_enter($renderer, $match);
                    return true;

                case DOKU_LEXER_UNMATCHED:
                    $this->render_lexer_unmatched($renderer, $match);
                    return true;

                case DOKU_LEXER_MATCHED:
                    $this->render_lexer_match($renderer, $match);
                    return true;

                case DOKU_LEXER_EXIT:
                    $this->render_lexer_exit($renderer, $match);
                    return true;

                case DOKU_LEXER_SPECIAL:
                    $this->render_lexer_special($renderer, $match);
                    return true;
            }

            return true;
        }

        return false;
    }

    /*
    * return a class list with mikiop- prefix
    *
    * @param $options       options of syntax element. Options with key 'class'=true are automatically added
    * @param $classes       classes to build from options as array
    * @param $inclAttr      include class="" in the return string
    * @return               a string of classes from options/classes variable
    */
    public function buildClass($options = null, $classes = null, $inclAttr = false)
    {
        $s = array();

        if (is_array($options)) {
            if($classes == null) $classes = array();

            foreach($this->options as $key => $value) {
                if(array_key_exists('class', $value) && $value['class'] == TRUE) {
                    array_push($classes, $key);
                }
            }

            foreach ($classes as $class) {
                if (array_key_exists($class, $options) && $options[$class] !== FALSE && $options[$class] != '') {
                    $prefix = $this->classPrefix;

                    if (array_key_exists($class, $this->options) && array_key_exists('prefix', $this->options[$class])) {
                        $prefix .= $this->options[$class]['prefix'];
                    }

                    $s[] = $prefix . $class . ($options[$class] !== TRUE ? '-' . $options[$class] : '');
                }
            }

        }

        $s = implode(' ', $s);
        if($s != '') $s = ' ' . $s;

        if($inclAttr) $s = ' classes="' . $s . '"';

        return $s;
    }




    /*
    * build style string
    *
    * @param $list          style list as key => value. Empty values are not included
    * @param $inclAttr      include style="" in the return string
    * @return               style list string
    */
    public function buildStyle($list, $inclAttr = false)
    {
        $s = '';

        if (is_array($list) && count($list) > 0) {
            foreach ($list as $key => $value) {
                if($value != '') {
                    $s .= $key . ':' . $value . ';';
                }
            }
        }

        if($s != '' && $inclAttr) {
            $s = ' style="' . $s . '"';
        }

        return $s;
    }


    public function buildTooltipString($options)
    {
        $dataPlacement = 'top';
        $dataHtml = false;
        $title = '';

        if ($options != null) {
            if (array_key_exists('tooltip-html-top', $options) && $options['tooltip-html-top'] != '') {
                $title = $options['tooltip-html-top'];
                $dataPlacement = 'top';
            }

            if (array_key_exists('tooltip-html-left', $options) && $options['tooltip-html-left'] != '') {
                $title = $options['tooltip-html-left'];
                $dataPlacement = 'left';
            }

            if (array_key_exists('tooltip-html-bottom', $options) && $options['tooltip-html-bottom'] != '') {
                $title = $options['tooltip-html-bottom'];
                $dataPlacement = 'bottom';
            }

            if (array_key_exists('tooltip-html-right', $options) && $options['tooltip-html-right'] != '') {
                $title = $options['tooltip-html-right'];
                $dataPlacement = 'right';
            }

            if (array_key_exists('tooltip-top', $options) && $options['tooltip-top'] != '') {
                $title = $options['tooltip-top'];
                $dataPlacement = 'top';
            }

            if (array_key_exists('tooltip-left', $options) && $options['tooltip-left'] != '') {
                $title = $options['tooltip-left'];
                $dataPlacement = 'left';
            }

            if (array_key_exists('tooltip-bottom', $options) && $options['tooltip-bottom'] != '') {
                $title = $options['tooltip-bottom'];
                $dataPlacement = 'bottom';
            }

            if (array_key_exists('tooltip-right', $options) && $options['tooltip-right'] != '') {
                $title = $options['tooltip-right'];
                $dataPlacement = 'right';
            }

            if (array_key_exists('tooltip-html', $options) && $options['tooltip-html'] != '') {
                $title = $options['tooltip-html'];
                $dataPlacement = 'top';
            }

            if (array_key_exists('tooltip', $options) && $options['tooltip'] != '') {
                $title = $options['tooltip'];
                $dataPlacement = 'top';
            }
        }

        if ($title != '') {
            return ' data-toggle="tooltip" data-placement="' . $dataPlacement . '" ' . ($dataHtml == true ? 'data-html="true" ' : '') . 'title="' . $title . '" ';
        }

        return '';
    }

    /*
    * convert the URL to a DokuWiki media link (if required)
    *
    * @param $url   url to parse
    * @return       url string
    */
    public function buildMediaLink($url)
    {
        $i = strpos($url, '?');
        if ($i !== FALSE) $url = substr($url, 0, $i);

        $url = preg_replace('/[^\da-zA-Z:_.]+/', '', $url);

        return (tpl_getMediaFile(array($url), FALSE));
    }


    /*
    * returns either a url or dokuwiki link
    *
    * @param    $url    link to build from
    * @return           built link
    */
    public function buildLink($url)
    {
        $i = strpos($url, '://');
        if ($i !== FALSE) return $url;

        return wl($url);
    }






    /*
    * Call syntax renderer of mikio syntax plugin
    *
    * @param $renderer          DokuWiki renderer object
    * @param $className         mikio syntax class to call
    * @param $text              unmatched text to pass outside of lexer. Only used when $lexer=MIKIO_LEXER_AUTO
    * @param $data              tag options to pass to syntax class. Runs through cleanOptions to validate first
    * @param $lexer             which lexer to call
    */
    public function syntaxRender(Doku_Renderer $renderer, $className, $text, $data = null, $lexer = MIKIO_LEXER_AUTO)
    {
        $className = 'syntax_plugin_mikioplugin_'.$className;

        if(class_exists($className)) {
            $class = new $className;

            if (!is_array($data)) $data = array();

            if(count($class->options) > 0) {
                $data = $class->cleanOptions($data);
            }

            switch($lexer) {
                case MIKIO_LEXER_AUTO:
                    if ($class->hasEndTag) {
                        if(method_exists($class, 'render_lexer_enter')) $class->render_lexer_enter($renderer, $data);
                        $renderer->doc .= $text;
                        if(method_exists($class, 'render_lexer_exit')) $class->render_lexer_exit($renderer, $data);
                    } else {
                        if(method_exists($class, 'render_lexer_special')) $class->render_lexer_special($renderer, $data);
                    }

                    break;
                case MIKIO_LEXER_ENTER:
                    if(method_exists($class, 'render_lexer_enter')) $class->render_lexer_enter($renderer, $data);
                    break;
                case MIKIO_LEXER_EXIT:
                    if(method_exists($class, 'render_lexer_exit')) $class->render_lexer_exit($renderer, $data);
                    break;
                case MIKIO_LEXER_SPECIAL:
                    if(method_exists($class, 'render_lexer_special')) $class->render_lexer_special($renderer, $data);
                    break;
            }
        }
    }

    /*
    * Create array with passed elements and include them if their values are not empty
    *
    * @param ...        array items
    */
    protected function arrayRemoveEmpties($items) {
        $result = array();

        foreach($items as $key => $value) {
            if($value != '') {
                $result[$key] = $value;
            }
        }

        return $result;
    }

    public function getFirstArrayKey($data)
    {
        if (!function_exists('array_key_first')) {
            foreach ($data as $key => $unused) {
                return $key;
            }
        }

        return array_key_first($data);
    }


    /*
    * add common options to options
    *
    * @param $typelist      common option to add
    * @param $options   save in options
    */
    public function addCommonOptions($typelist) {
        $types = explode(' ', $typelist);
        foreach($types as $type) {
            if(strcasecmp($type, 'shadow') == 0) {
                $this->options['shadow'] =          array('type'     => 'choice',
                                                          'data'     => array('large'=> array('shadow-large', 'shadow-lg'), 'small' => array('shadow-small', 'shadow-sm'), true),
                                                          'default'  => '',
                                                          'class'    => true);
            }

            if(strcasecmp($type, 'width') == 0) {
                $this->options['width'] =           array('type'     => 'size',
                                                          'default'  => '');
            }

            if(strcasecmp($type, 'height') == 0) {
                $this->options['height'] =          array('type'     => 'size',
                                                          'default'  => '');
            }

            if(strcasecmp($type, 'type') == 0) {
                $this->options['type'] =            array('type'     => 'choice',
                                                          'data'     => array('primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'),
                                                          'default'  => '',
                                                          'class'    => true);
            }

            if(strcasecmp($type, 'text-align') == 0) {
                $this->options['text-align'] =      array('type'     => 'choice',
                                                          'data'     => array('left' => array('text-left'), 'center' => array('text-center'), 'right' => array('text-right')),
                                                          'default'  => '',
                                                          'class'    => true);
            }

            if(strcasecmp($type, 'align') == 0) {
                $this->options['align'] =           array('type'     => 'choice',
                                                          'data'     => array('left' => array('align-left'), 'center' => array('align-center'), 'right' => array('align-right')),
                                                          'default'  => '',
                                                          'class'    => true);
            }
        }
    }


    /*
    * Find HTML tags in string. Parse tags options. Used in parsing subtags
    *
    * @param $tagName       tagName to search for. Name is exclusive
    * @param $content       search within content
    * @param $options       parse options similar to syntax element options
    * @return               array of tags containing 'options' => array of 'name' => 'value', 'content' => content inside the tag
    */
    protected function findTags($tagName, $content, $options) {
        $items = array();

        if(preg_match_all('/<(?i:' . $tagName . ')(.*?)>(.*?)<\/(?i:' . $tagName . ')>/s', $content, $match)) {
            if(count($match) >= 2) {
                for($i = 0; $i < count($match[1]); $i++) {
                    $item = array('options' => array(), 'content' => $this->render_text($match[2][$i]));

                    $optionlist = preg_split('/\s(?=([^"]*"[^"]*")*[^"]*$)/', trim($match[1][$i]));

                    foreach ($optionlist as $option) {
                        $j = strpos($option, '=');
                        if ($j !== false) {
                            $value = substr($option, $j + 1);

                            if (substr($value, 0, 1) == '"') $value = substr($value, 1);
                            if (substr($value, -1) == '"') $value = substr($value, 0, -1);

                            $item['options'][substr($option, 0, $j)] = $value;
                        } else {
                            $item['options'][$option] = true;
                        }
                    }

                    $this->cleanOptions($item['options'], $options);

                    $items[] = $item;
                }
            }
        }

        return $items;
    }
}