xref: /plugin/mikioplugin/syntax/core.php (revision 54ee1ccc7785b38784260a90c9c3f0f32b2f5eea)
117e6d639SJames Collins<?php
217e6d639SJames Collins/**
317e6d639SJames Collins * Mikio Core Syntax Plugin
417e6d639SJames Collins *
57935713eSJames Collins * @link        http://github.com/nomadjimbob/mikioplugin
617e6d639SJames Collins * @license     GPL 2 (http://www.gnu.org/licenses/gpl.html)
717e6d639SJames Collins * @author      James Collins <james.collins@outlook.com.au>
817e6d639SJames Collins */
917e6d639SJames Collinsif (!defined('DOKU_INC')) die();
1017e6d639SJames Collinsif (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/');
1117e6d639SJames Collins
127935713eSJames Collinsdefine('MIKIO_LEXER_AUTO', 0);
137935713eSJames Collinsdefine('MIKIO_LEXER_ENTER', 1);
147935713eSJames Collinsdefine('MIKIO_LEXER_EXIT', 2);
157935713eSJames Collinsdefine('MIKIO_LEXER_SPECIAL', 3);
1617e6d639SJames Collins
177935713eSJames Collinsclass syntax_plugin_mikioplugin_core extends DokuWiki_Syntax_Plugin
187935713eSJames Collins{
1917e6d639SJames Collins    public $pattern_entry       = '';
203deaf3a5SJames Collins    public $pattern             = '';
2117e6d639SJames Collins    public $pattern_exit        = '';
2217e6d639SJames Collins    public $tag                 = '';
237935713eSJames Collins    public $hasEndTag           = true;
2417e6d639SJames Collins    public $options             = array();
257935713eSJames Collins
267935713eSJames Collins    protected $tagPrefix          = ''; //'mikio-';
277935713eSJames Collins    protected $classPrefix        = 'mikiop-';
287935713eSJames Collins    protected $elemClass          = 'mikiop';
297935713eSJames Collins
307935713eSJames Collins    private $values              = array();
3117e6d639SJames Collins
3217e6d639SJames Collins
337935713eSJames Collins    function __construct() { }
347935713eSJames Collins    public function getType() { return 'formatting'; }
357935713eSJames Collins    public function getAllowedTypes() { return array('formatting', 'substition', 'disabled', 'paragraphs'); }
367935713eSJames Collins    // public function getAllowedTypes() { return array('formatting', 'substition', 'disabled'); }
3717e6d639SJames Collins    public function getSort() { return 32; }
387935713eSJames Collins    public function getPType() { return 'stack'; }
3917e6d639SJames Collins
4017e6d639SJames Collins
417935713eSJames Collins    public function connectTo($mode)
427935713eSJames Collins    {
4317e6d639SJames Collins        if ($this->pattern_entry == '' && $this->tag != '') {
447935713eSJames Collins            if ($this->hasEndTag) {
457935713eSJames Collins                $this->pattern_entry = '<(?i:' . $this->tagPrefix . $this->tag . ')(?=[ >]).*?>(?=.*?</(?i:' . $this->tagPrefix . $this->tag . ')>)';
4617e6d639SJames Collins            } else {
477935713eSJames Collins                $this->pattern_entry = '<(?i:' . $this->tagPrefix . $this->tag . ').*?>';
4817e6d639SJames Collins            }
4917e6d639SJames Collins        }
5017e6d639SJames Collins
5117e6d639SJames Collins        if ($this->pattern_entry != '') {
527935713eSJames Collins            if ($this->hasEndTag) {
5317e6d639SJames Collins                $this->Lexer->addEntryPattern($this->pattern_entry, $mode, 'plugin_mikioplugin_' . $this->getPluginComponent());
547935713eSJames Collins            } else {
557935713eSJames Collins                $this->Lexer->addSpecialPattern($this->pattern_entry, $mode, 'plugin_mikioplugin_' . $this->getPluginComponent());
567935713eSJames Collins            }
5717e6d639SJames Collins        }
5817e6d639SJames Collins    }
593deaf3a5SJames Collins
6017e6d639SJames Collins
617935713eSJames Collins    public function postConnect()
627935713eSJames Collins    {
637935713eSJames Collins        if ($this->hasEndTag) {
6417e6d639SJames Collins            if ($this->pattern_exit == '' && $this->tag != '') {
657935713eSJames Collins                $this->pattern_exit = '</(?i:' . $this->tagPrefix . $this->tag . ')>';
6617e6d639SJames Collins            }
6717e6d639SJames Collins
6817e6d639SJames Collins            if ($this->pattern_exit != '') {
6917e6d639SJames Collins                $this->Lexer->addExitPattern($this->pattern_exit, 'plugin_mikioplugin_' . $this->getPluginComponent());
7017e6d639SJames Collins            }
7117e6d639SJames Collins        }
7217e6d639SJames Collins    }
7317e6d639SJames Collins
747935713eSJames Collins    public function handle($match, $state, $pos, Doku_Handler $handler)
757935713eSJames Collins    {
7617e6d639SJames Collins        switch ($state) {
7717e6d639SJames Collins            case DOKU_LEXER_ENTER:
7817e6d639SJames Collins            case DOKU_LEXER_SPECIAL:
79c5f7fed6SJames Collins                $match_fix = preg_replace('/\s*=\s*/', '=', trim(substr($match, strlen($this->tagPrefix . $this->tag) + 1, -1)));
80c5f7fed6SJames Collins                $optionlist = preg_split('/\s(?=([^"]*"[^"]*")*[^"]*$)/', $match_fix);
8117e6d639SJames Collins
8217e6d639SJames Collins                $options = array();
8317e6d639SJames Collins                foreach ($optionlist as $item) {
8417e6d639SJames Collins                    $i = strpos($item, '=');
8517e6d639SJames Collins                    if ($i !== false) {
8617e6d639SJames Collins                        $value = substr($item, $i + 1);
8717e6d639SJames Collins
8817e6d639SJames Collins                        if (substr($value, 0, 1) == '"') $value = substr($value, 1);
8917e6d639SJames Collins                        if (substr($value, -1) == '"') $value = substr($value, 0, -1);
9017e6d639SJames Collins
9117e6d639SJames Collins                        $options[substr($item, 0, $i)] = $value;
9217e6d639SJames Collins                    } else {
9317e6d639SJames Collins                        $options[$item] = true;
9417e6d639SJames Collins                    }
9517e6d639SJames Collins                }
9617e6d639SJames Collins
977935713eSJames Collins                if(count($this->options) > 0) {
9831359b6fSJames Collins                    $options_clean = $this->cleanOptions($options);
997935713eSJames Collins                } else {
1007935713eSJames Collins                    $options_clean = $options;
1017935713eSJames Collins                }
10231359b6fSJames Collins
10331359b6fSJames Collins                $this->values = $options_clean;
10431359b6fSJames Collins
10531359b6fSJames Collins                return array($state, $options_clean);
10631359b6fSJames Collins
1073deaf3a5SJames Collins            case DOKU_LEXER_MATCHED:
1083deaf3a5SJames Collins                return array($state, $match);
1093deaf3a5SJames Collins
11031359b6fSJames Collins            case DOKU_LEXER_UNMATCHED:
11131359b6fSJames Collins                return array($state, $match);
11231359b6fSJames Collins
11331359b6fSJames Collins            case DOKU_LEXER_EXIT:
114f4aa5cdcSJames Collins                return array($state, $this->values);
11531359b6fSJames Collins        }
11631359b6fSJames Collins
11731359b6fSJames Collins        return array();
11831359b6fSJames Collins    }
11931359b6fSJames Collins
12031359b6fSJames Collins
1217935713eSJames Collins    /*
1227935713eSJames Collins    * clean element options to only supported attributes, setting defaults if required
1237935713eSJames Collins    *
1247935713eSJames Collins    * @param $options   options passed to element
1257935713eSJames Collins    * @return           array of options supported with default set
1267935713eSJames Collins    */
1277935713eSJames Collins    protected function cleanOptions($data, $options=null)
1287935713eSJames Collins    {
1297935713eSJames Collins        $optionsCleaned = array();
13031359b6fSJames Collins
1317935713eSJames Collins        if($options == null) $options = $this->options;
1327935713eSJames Collins
1337935713eSJames Collins        // Match DokuWiki passed options to syntax options
1347935713eSJames Collins        foreach ($data as $optionKey => $optionValue) {
1357935713eSJames Collins            foreach ($options as $syntaxKey => $syntaxValue) {
1367935713eSJames Collins                if (strcasecmp($optionKey, $syntaxKey) == 0) {
1377935713eSJames Collins                    if (array_key_exists('type', $options[$syntaxKey])) {
1387935713eSJames Collins                        $type = $options[$syntaxKey]['type'];
1397935713eSJames Collins
1407935713eSJames Collins                        switch ($type) {
1417935713eSJames Collins                            case 'boolean':
1427935713eSJames Collins                                $optionsCleaned[$syntaxKey] = filter_var($optionValue, FILTER_VALIDATE_BOOLEAN);
1437935713eSJames Collins                                break;
1447935713eSJames Collins                            case 'number':
1457935713eSJames Collins                                $optionsCleaned[$syntaxKey] = filter_var($optionValue, FILTER_VALIDATE_INT);
1467935713eSJames Collins                                break;
1477935713eSJames Collins                            case 'float':
1487935713eSJames Collins                                $optionsCleaned[$syntaxKey] = filter_var($optionValue, FILTER_VALIDATE_FLOAT);
1497935713eSJames Collins                                break;
1507935713eSJames Collins                            case 'text':
1517935713eSJames Collins                                $optionsCleaned[$syntaxKey] = $optionValue;
1527935713eSJames Collins                                break;
1537935713eSJames Collins                            case 'size':
1547935713eSJames Collins                                $s = strtolower($optionValue);
1557935713eSJames Collins                                $i = '';
1567935713eSJames Collins                                if (substr($s, -3) == 'rem') {
1577935713eSJames Collins                                    $i = substr($s, 0, -3);
1587935713eSJames Collins                                    $s = 'rem';
1597935713eSJames Collins                                } elseif (substr($s, -2) == 'em') {
1607935713eSJames Collins                                    $i = substr($s, 0, -2);
1617935713eSJames Collins                                    $s = 'em';
1627935713eSJames Collins                                }
1637935713eSJames Collins                                elseif (substr($s, -2) == 'px') {
1647935713eSJames Collins                                    $i = substr($s, 0, -2);
1657935713eSJames Collins                                    $s = 'px';
1667935713eSJames Collins                                }
1677935713eSJames Collins                                elseif (substr($s, -1) == '%') {
1687935713eSJames Collins                                    $i = substr($s, 0, -1);
1697935713eSJames Collins                                    $s = '%';
1707935713eSJames Collins                                }
1717935713eSJames Collins                                else {
17218e323fdSJames Collins                                    if($s != 'auto') {
1737935713eSJames Collins                                        $i = filter_var($s, FILTER_VALIDATE_INT);
1747935713eSJames Collins                                        if ($i == '') $i = '1';
1757935713eSJames Collins                                        $s = 'rem';
1767935713eSJames Collins                                    }
17718e323fdSJames Collins                                }
1787935713eSJames Collins
1797935713eSJames Collins                                $optionsCleaned[$syntaxKey] = $i . $s;
1807935713eSJames Collins                                break;
18118e323fdSJames Collins                            case 'multisize':
18218e323fdSJames Collins                                $val = '';
18318e323fdSJames Collins                                $parts = explode(' ', $optionValue);
18418e323fdSJames Collins                                foreach($parts as &$part) {
18518e323fdSJames Collins                                    $s = strtolower($part);
18618e323fdSJames Collins                                    $i = '';
18718e323fdSJames Collins                                    if (substr($s, -3) == 'rem') {
18818e323fdSJames Collins                                        $i = substr($s, 0, -3);
18918e323fdSJames Collins                                        $s = 'rem';
19018e323fdSJames Collins                                    } elseif (substr($s, -2) == 'em') {
19118e323fdSJames Collins                                        $i = substr($s, 0, -2);
19218e323fdSJames Collins                                        $s = 'em';
19318e323fdSJames Collins                                    }
19418e323fdSJames Collins                                    elseif (substr($s, -2) == 'px') {
19518e323fdSJames Collins                                        $i = substr($s, 0, -2);
19618e323fdSJames Collins                                        $s = 'px';
19718e323fdSJames Collins                                    }
1982608c53cSJames Collins                                    elseif (substr($s, -2) == 'fr') {
1992608c53cSJames Collins                                        $i = substr($s, 0, -2);
2002608c53cSJames Collins                                        $s = 'fr';
2012608c53cSJames Collins                                    }
20218e323fdSJames Collins                                    elseif (substr($s, -1) == '%') {
20318e323fdSJames Collins                                        $i = substr($s, 0, -1);
20418e323fdSJames Collins                                        $s = '%';
20518e323fdSJames Collins                                    }
20618e323fdSJames Collins                                    else {
20718e323fdSJames Collins                                        if($s != 'auto') {
20818e323fdSJames Collins                                            $i = filter_var($s, FILTER_VALIDATE_INT);
20918e323fdSJames Collins                                            if ($i === '') $i = '1';
21018e323fdSJames Collins                                            if ($i != 0) {
21118e323fdSJames Collins                                                $s = 'rem';
21218e323fdSJames Collins                                            } else {
21318e323fdSJames Collins                                                $s = '';
21418e323fdSJames Collins                                            }
21518e323fdSJames Collins                                        }
21618e323fdSJames Collins                                    }
21718e323fdSJames Collins
21818e323fdSJames Collins                                    $part = $i . $s;
21918e323fdSJames Collins                                }
22018e323fdSJames Collins
22118e323fdSJames Collins                                $optionsCleaned[$syntaxKey] = implode(' ' , $parts);
22218e323fdSJames Collins                                break;
2237935713eSJames Collins                            case 'color':
2247935713eSJames Collins                                if (strlen($optionValue) == 3 || strlen($optionValue) == 6) {
2257935713eSJames Collins                                    preg_match('/([[:xdigit:]]{3}){1,2}/', $optionValue, $matches);
2267935713eSJames Collins                                    if (count($matches) > 1) {
2277935713eSJames Collins                                        $optionsCleaned[$syntaxKey] = '#' . $matches[0];
2287935713eSJames Collins                                    }
22917e6d639SJames Collins                                } else {
2307935713eSJames Collins                                    $optionsCleaned[$syntaxKey] = $optionValue;
23117e6d639SJames Collins                                }
2327935713eSJames Collins                                break;
2337935713eSJames Collins                            case 'url':
2347935713eSJames Collins                                $optionsCleaned[$syntaxKey] = $this->buildLink($optionValue);
2357935713eSJames Collins                                break;
2367935713eSJames Collins                            case 'media':
2377935713eSJames Collins                                $optionsCleaned[$syntaxKey] = $this->buildMediaLink($optionValue);
2387935713eSJames Collins                                break;
2397935713eSJames Collins                            case 'choice':
2407935713eSJames Collins                                if (array_key_exists('data', $options[$syntaxKey])) {
2417935713eSJames Collins                                    foreach ($options[$syntaxKey]['data'] as $choiceKey => $choiceValue) {
24218e323fdSJames Collins                                        if (strcasecmp($optionValue, $choiceKey) == 0) {
24318e323fdSJames Collins                                            $optionsCleaned[$syntaxKey] = $choiceKey;
24418e323fdSJames Collins                                            break;
24518e323fdSJames Collins                                        }
24618e323fdSJames Collins
2477935713eSJames Collins                                        if (is_array($choiceValue)) {
2487935713eSJames Collins                                            foreach ($choiceValue as $choiceItem) {
2497935713eSJames Collins                                                if (strcasecmp($optionValue, $choiceItem) == 0) {
2507935713eSJames Collins                                                    $optionsCleaned[$syntaxKey] = $choiceKey;
2517935713eSJames Collins                                                    break 2;
25217e6d639SJames Collins                                                }
25317e6d639SJames Collins                                            }
254ebb7bc5aSJames Collins                                        } else {
2557935713eSJames Collins                                            if (strcasecmp($optionValue, $choiceValue) == 0) {
2567935713eSJames Collins                                                $optionsCleaned[$syntaxKey] = $choiceValue;
2577935713eSJames Collins                                                break;
2587935713eSJames Collins                                            }
2597935713eSJames Collins                                        }
2607935713eSJames Collins                                    }
2617935713eSJames Collins                                }
2627935713eSJames Collins                                break;
2637935713eSJames Collins                            case 'set':
2647935713eSJames Collins                                if (array_key_exists('option', $options[$syntaxKey]) && array_key_exists('data', $options[$syntaxKey])) {
2657935713eSJames Collins                                    $optionsCleaned[$options[$syntaxKey]['option']] = $options[$syntaxKey]['data'];
2667935713eSJames Collins                                }
2677935713eSJames Collins                                break;
2687935713eSJames Collins                        }
269ebb7bc5aSJames Collins                    }
27017e6d639SJames Collins
2717935713eSJames Collins                    break;
2727935713eSJames Collins                }
2737935713eSJames Collins            }
2749a439316SJames Collins        }
2759a439316SJames Collins
276ec319cf1SJames Collins
2779a439316SJames Collins        foreach ($data as $optionKey => $optionValue) {
278ec319cf1SJames Collins          if (!array_key_exists($optionKey, $optionsCleaned)) {
279ec319cf1SJames Collins            foreach ($options as $syntaxKey => $syntaxValue) {
280ec319cf1SJames Collins              if (array_key_exists('type', $options[$syntaxKey])) {
281*54ee1cccSJames Collins                if (array_key_exists('data', $options[$syntaxKey]) && is_array($options[$syntaxKey]['data'])) {
282ec319cf1SJames Collins                  foreach ($options[$syntaxKey]['data'] as $choiceKey => $choiceValue) {
283ec319cf1SJames Collins                    if(is_array($choiceValue)) {
284ec319cf1SJames Collins                      if(in_array($optionKey, $choiceValue)) {
285ec319cf1SJames Collins                        $optionsCleaned[$syntaxKey] = $choiceKey;
286ec319cf1SJames Collins                      }
287ec319cf1SJames Collins                    } else {
288ec319cf1SJames Collins                      if(strcasecmp($choiceValue, $optionKey) == 0) {
289ec319cf1SJames Collins                        $optionsCleaned[$syntaxKey] = $choiceValue;
290ec319cf1SJames Collins                      }
291ec319cf1SJames Collins                    }
292ec319cf1SJames Collins                  }
293ec319cf1SJames Collins                }
294ec319cf1SJames Collins              }
2957935713eSJames Collins            }
2967935713eSJames Collins          }
2977935713eSJames Collins        }
29817e6d639SJames Collins
2997935713eSJames Collins        // Add in syntax options that are missing
3007935713eSJames Collins        foreach ($options as $optionKey => $optionValue) {
3017935713eSJames Collins            if (!array_key_exists($optionKey, $optionsCleaned)) {
3027935713eSJames Collins                if (array_key_exists('default', $options[$optionKey])) {
3037935713eSJames Collins                    switch ($options[$optionKey]['type']) {
3047935713eSJames Collins                        case 'boolean':
3057935713eSJames Collins                            $optionsCleaned[$optionKey] = filter_var($options[$optionKey]['default'], FILTER_VALIDATE_BOOLEAN);
3067935713eSJames Collins                            break;
3077935713eSJames Collins                        case 'number':
3087935713eSJames Collins                            $optionsCleaned[$optionKey] = filter_var($options[$optionKey]['default'], FILTER_VALIDATE_INT);
3097935713eSJames Collins                            break;
3107935713eSJames Collins                        default:
3117935713eSJames Collins                            $optionsCleaned[$optionKey] = $options[$optionKey]['default'];
3127935713eSJames Collins                            break;
3137935713eSJames Collins                    }
3147935713eSJames Collins                }
3157935713eSJames Collins            }
31617e6d639SJames Collins        }
31717e6d639SJames Collins
3187935713eSJames Collins        return $optionsCleaned;
31917e6d639SJames Collins    }
32017e6d639SJames Collins
3217935713eSJames Collins    /* Lexer renderers */
3227935713eSJames Collins    protected function render_lexer_enter(Doku_Renderer $renderer, $data) { }
3237935713eSJames Collins    protected function render_lexer_unmatched(Doku_Renderer $renderer, $data) { $renderer->doc .= $renderer->_xmlEntities($data); }
3247935713eSJames Collins    protected function render_lexer_exit(Doku_Renderer $renderer, $data) { }
3257935713eSJames Collins    protected function render_lexer_special(Doku_Renderer $renderer, $data) { }
3267935713eSJames Collins    protected function render_lexer_match(Doku_Renderer $renderer, $data) { }
32717e6d639SJames Collins
3287935713eSJames Collins    /* Renderer */
3297935713eSJames Collins    public function render($mode, Doku_Renderer $renderer, $data)
3307935713eSJames Collins    {
33117e6d639SJames Collins        if ($mode == 'xhtml') {
33217e6d639SJames Collins            list($state, $match) = $data;
33317e6d639SJames Collins
33417e6d639SJames Collins            switch ($state) {
33517e6d639SJames Collins                case DOKU_LEXER_ENTER:
33617e6d639SJames Collins                    $this->render_lexer_enter($renderer, $match);
33717e6d639SJames Collins                    return true;
33817e6d639SJames Collins
33917e6d639SJames Collins                case DOKU_LEXER_UNMATCHED:
34017e6d639SJames Collins                    $this->render_lexer_unmatched($renderer, $match);
34117e6d639SJames Collins                    return true;
34217e6d639SJames Collins
3433deaf3a5SJames Collins                case DOKU_LEXER_MATCHED:
3443deaf3a5SJames Collins                    $this->render_lexer_match($renderer, $match);
3453deaf3a5SJames Collins                    return true;
3463deaf3a5SJames Collins
34717e6d639SJames Collins                case DOKU_LEXER_EXIT:
34817e6d639SJames Collins                    $this->render_lexer_exit($renderer, $match);
34917e6d639SJames Collins                    return true;
35017e6d639SJames Collins
35117e6d639SJames Collins                case DOKU_LEXER_SPECIAL:
35217e6d639SJames Collins                    $this->render_lexer_special($renderer, $match);
35317e6d639SJames Collins                    return true;
35417e6d639SJames Collins            }
35517e6d639SJames Collins
35617e6d639SJames Collins            return true;
35717e6d639SJames Collins        }
35817e6d639SJames Collins
35917e6d639SJames Collins        return false;
36017e6d639SJames Collins    }
36117e6d639SJames Collins
3627935713eSJames Collins    /*
3637935713eSJames Collins    * return a class list with mikiop- prefix
3647935713eSJames Collins    *
3657935713eSJames Collins    * @param $options       options of syntax element. Options with key 'class'=true are automatically added
3667935713eSJames Collins    * @param $classes       classes to build from options as array
3677935713eSJames Collins    * @param $inclAttr      include class="" in the return string
3689d56a2c2SJames Collins    * @param $optionsTemplate   allow a different options template instead of $this->options (for findTags)
3697935713eSJames Collins    * @return               a string of classes from options/classes variable
3707935713eSJames Collins    */
3719d56a2c2SJames Collins    public function buildClass($options = null, $classes = null, $inclAttr = false, $optionsTemplate = null)
3727935713eSJames Collins    {
37317e6d639SJames Collins        $s = array();
37417e6d639SJames Collins
3757935713eSJames Collins        if (is_array($options)) {
3767935713eSJames Collins            if($classes == null) $classes = array();
3779d56a2c2SJames Collins            if($optionsTemplate == null) $optionsTemplate = $this->options;
37817e6d639SJames Collins
3799d56a2c2SJames Collins            foreach($optionsTemplate as $key => $value) {
3807935713eSJames Collins                if(array_key_exists('class', $value) && $value['class'] == TRUE) {
3817935713eSJames Collins                    array_push($classes, $key);
38217e6d639SJames Collins                }
38317e6d639SJames Collins            }
38417e6d639SJames Collins
3857935713eSJames Collins            foreach ($classes as $class) {
3867935713eSJames Collins                if (array_key_exists($class, $options) && $options[$class] !== FALSE && $options[$class] != '') {
3877935713eSJames Collins                    $prefix = $this->classPrefix;
3887935713eSJames Collins
3899d56a2c2SJames Collins                    if (array_key_exists($class, $optionsTemplate) && array_key_exists('prefix', $optionsTemplate[$class])) {
3909d56a2c2SJames Collins                        $prefix .= $optionsTemplate[$class]['prefix'];
39117e6d639SJames Collins                    }
3927935713eSJames Collins
3932f5b9ce6SJames Collins                    if (array_key_exists($class, $optionsTemplate) && array_key_exists('classNoSuffix', $optionsTemplate[$class]) && $optionsTemplate[$class]['classNoSuffix'] == TRUE) {
3942f5b9ce6SJames Collins                        $s[] = $prefix . $class;
3952f5b9ce6SJames Collins                    } else {
3967935713eSJames Collins                        $s[] = $prefix . $class . ($options[$class] !== TRUE ? '-' . $options[$class] : '');
39717e6d639SJames Collins                    }
39817e6d639SJames Collins                }
3992f5b9ce6SJames Collins            }
40017e6d639SJames Collins
401a007b54fSJames Collins        }
40217e6d639SJames Collins
4037935713eSJames Collins        $s = implode(' ', $s);
4047935713eSJames Collins        if($s != '') $s = ' ' . $s;
4058f786230SJames Collins
4067935713eSJames Collins        if($inclAttr) $s = ' classes="' . $s . '"';
4076cfe6dadSJames Collins
408ad1dae96SJames Collins        return $s;
409ad1dae96SJames Collins    }
41017e6d639SJames Collins
4117935713eSJames Collins
4127935713eSJames Collins
4137935713eSJames Collins
4147935713eSJames Collins    /*
4157935713eSJames Collins    * build style string
4167935713eSJames Collins    *
4177935713eSJames Collins    * @param $list          style list as key => value. Empty values are not included
4187935713eSJames Collins    * @param $inclAttr      include style="" in the return string
4197935713eSJames Collins    * @return               style list string
4207935713eSJames Collins    */
4217935713eSJames Collins    public function buildStyle($list, $inclAttr = false)
4227935713eSJames Collins    {
4237935713eSJames Collins        $s = '';
4247935713eSJames Collins
4257935713eSJames Collins        if (is_array($list) && count($list) > 0) {
4267935713eSJames Collins            foreach ($list as $key => $value) {
4277935713eSJames Collins                if($value != '') {
4287935713eSJames Collins                    $s .= $key . ':' . $value . ';';
4297935713eSJames Collins                }
4307935713eSJames Collins            }
4317935713eSJames Collins        }
4327935713eSJames Collins
4337935713eSJames Collins        if($s != '' && $inclAttr) {
4347935713eSJames Collins            $s = ' style="' . $s . '"';
4357935713eSJames Collins        }
4367935713eSJames Collins
4377935713eSJames Collins        return $s;
4387935713eSJames Collins    }
4397935713eSJames Collins
4407935713eSJames Collins
4417935713eSJames Collins    public function buildTooltipString($options)
4427935713eSJames Collins    {
443a401c3b7SJames Collins        $dataPlacement = 'top';
444a401c3b7SJames Collins        $dataHtml = false;
445a401c3b7SJames Collins        $title = '';
446a401c3b7SJames Collins
447a401c3b7SJames Collins        if ($options != null) {
448a401c3b7SJames Collins            if (array_key_exists('tooltip-html-top', $options) && $options['tooltip-html-top'] != '') {
449a401c3b7SJames Collins                $title = $options['tooltip-html-top'];
450a401c3b7SJames Collins                $dataPlacement = 'top';
451a401c3b7SJames Collins            }
452a401c3b7SJames Collins
453a401c3b7SJames Collins            if (array_key_exists('tooltip-html-left', $options) && $options['tooltip-html-left'] != '') {
454a401c3b7SJames Collins                $title = $options['tooltip-html-left'];
455a401c3b7SJames Collins                $dataPlacement = 'left';
456a401c3b7SJames Collins            }
457a401c3b7SJames Collins
458a401c3b7SJames Collins            if (array_key_exists('tooltip-html-bottom', $options) && $options['tooltip-html-bottom'] != '') {
459a401c3b7SJames Collins                $title = $options['tooltip-html-bottom'];
460a401c3b7SJames Collins                $dataPlacement = 'bottom';
461a401c3b7SJames Collins            }
462a401c3b7SJames Collins
463a401c3b7SJames Collins            if (array_key_exists('tooltip-html-right', $options) && $options['tooltip-html-right'] != '') {
464a401c3b7SJames Collins                $title = $options['tooltip-html-right'];
465a401c3b7SJames Collins                $dataPlacement = 'right';
466a401c3b7SJames Collins            }
467a401c3b7SJames Collins
468a401c3b7SJames Collins            if (array_key_exists('tooltip-top', $options) && $options['tooltip-top'] != '') {
469a401c3b7SJames Collins                $title = $options['tooltip-top'];
470a401c3b7SJames Collins                $dataPlacement = 'top';
471a401c3b7SJames Collins            }
472a401c3b7SJames Collins
473a401c3b7SJames Collins            if (array_key_exists('tooltip-left', $options) && $options['tooltip-left'] != '') {
474a401c3b7SJames Collins                $title = $options['tooltip-left'];
475a401c3b7SJames Collins                $dataPlacement = 'left';
476a401c3b7SJames Collins            }
477a401c3b7SJames Collins
478a401c3b7SJames Collins            if (array_key_exists('tooltip-bottom', $options) && $options['tooltip-bottom'] != '') {
479a401c3b7SJames Collins                $title = $options['tooltip-bottom'];
480a401c3b7SJames Collins                $dataPlacement = 'bottom';
481a401c3b7SJames Collins            }
482a401c3b7SJames Collins
483a401c3b7SJames Collins            if (array_key_exists('tooltip-right', $options) && $options['tooltip-right'] != '') {
484a401c3b7SJames Collins                $title = $options['tooltip-right'];
485a401c3b7SJames Collins                $dataPlacement = 'right';
486a401c3b7SJames Collins            }
487a401c3b7SJames Collins
488a401c3b7SJames Collins            if (array_key_exists('tooltip-html', $options) && $options['tooltip-html'] != '') {
489a401c3b7SJames Collins                $title = $options['tooltip-html'];
490a401c3b7SJames Collins                $dataPlacement = 'top';
491a401c3b7SJames Collins            }
492a401c3b7SJames Collins
493a401c3b7SJames Collins            if (array_key_exists('tooltip', $options) && $options['tooltip'] != '') {
494a401c3b7SJames Collins                $title = $options['tooltip'];
495a401c3b7SJames Collins                $dataPlacement = 'top';
496a401c3b7SJames Collins            }
497a401c3b7SJames Collins        }
498a401c3b7SJames Collins
499a401c3b7SJames Collins        if ($title != '') {
500a401c3b7SJames Collins            return ' data-toggle="tooltip" data-placement="' . $dataPlacement . '" ' . ($dataHtml == true ? 'data-html="true" ' : '') . 'title="' . $title . '" ';
501a401c3b7SJames Collins        }
502a401c3b7SJames Collins
503a401c3b7SJames Collins        return '';
504a401c3b7SJames Collins    }
505a401c3b7SJames Collins
5067935713eSJames Collins    /*
5077935713eSJames Collins    * convert the URL to a DokuWiki media link (if required)
5087935713eSJames Collins    *
5097935713eSJames Collins    * @param $url   url to parse
5107935713eSJames Collins    * @return       url string
5117935713eSJames Collins    */
5127935713eSJames Collins    public function buildMediaLink($url)
5137935713eSJames Collins    {
5147935713eSJames Collins        $i = strpos($url, '?');
5157935713eSJames Collins        if ($i !== FALSE) $url = substr($url, 0, $i);
51617e6d639SJames Collins
51766f3b00dSJames Collins        $url = preg_replace('/[^\da-zA-Z:_.-]+/', '', $url);
51817e6d639SJames Collins
5197935713eSJames Collins        return (tpl_getMediaFile(array($url), FALSE));
52017e6d639SJames Collins    }
52117e6d639SJames Collins
52217e6d639SJames Collins
5237935713eSJames Collins    /*
5247935713eSJames Collins    * returns either a url or dokuwiki link
5257935713eSJames Collins    *
5267935713eSJames Collins    * @param    $url    link to build from
5277935713eSJames Collins    * @return           built link
5287935713eSJames Collins    */
5297935713eSJames Collins    public function buildLink($url)
5307935713eSJames Collins    {
5317935713eSJames Collins        $i = strpos($url, '://');
53221a27edbSJames Collins        if ($i !== FALSE || substr($url, 0, 1) == '#') return $url;
533f1a539d8SJames Collins
5347935713eSJames Collins        return wl($url);
535f1a539d8SJames Collins    }
536f1a539d8SJames Collins
5377935713eSJames Collins    /*
5387935713eSJames Collins    * Call syntax renderer of mikio syntax plugin
5397935713eSJames Collins    *
5407935713eSJames Collins    * @param $renderer          DokuWiki renderer object
5417935713eSJames Collins    * @param $className         mikio syntax class to call
5427935713eSJames Collins    * @param $text              unmatched text to pass outside of lexer. Only used when $lexer=MIKIO_LEXER_AUTO
5437935713eSJames Collins    * @param $data              tag options to pass to syntax class. Runs through cleanOptions to validate first
5447935713eSJames Collins    * @param $lexer             which lexer to call
5457935713eSJames Collins    */
5467935713eSJames Collins    public function syntaxRender(Doku_Renderer $renderer, $className, $text, $data = null, $lexer = MIKIO_LEXER_AUTO)
5477935713eSJames Collins    {
5487935713eSJames Collins        $className = 'syntax_plugin_mikioplugin_'.$className;
5497935713eSJames Collins
5507935713eSJames Collins        if(class_exists($className)) {
55117e6d639SJames Collins            $class = new $className;
55217e6d639SJames Collins
55331359b6fSJames Collins            if(!is_array($data)) $data = array();
55431359b6fSJames Collins
55518e323fdSJames Collins
5567935713eSJames Collins            if(count($class->options) > 0) {
55718e323fdSJames Collins                $data = $class->cleanOptions($data, $class->options);
5587935713eSJames Collins            }
55931359b6fSJames Collins
5607935713eSJames Collins            switch($lexer) {
5617935713eSJames Collins                case MIKIO_LEXER_AUTO:
5627935713eSJames Collins                    if ($class->hasEndTag) {
5637935713eSJames Collins                        if(method_exists($class, 'render_lexer_enter')) $class->render_lexer_enter($renderer, $data);
56417e6d639SJames Collins                        $renderer->doc .= $text;
5657935713eSJames Collins                        if(method_exists($class, 'render_lexer_exit')) $class->render_lexer_exit($renderer, $data);
5667935713eSJames Collins                    } else {
5677935713eSJames Collins                        if(method_exists($class, 'render_lexer_special')) $class->render_lexer_special($renderer, $data);
5687935713eSJames Collins                    }
5697935713eSJames Collins
5707935713eSJames Collins                    break;
5717935713eSJames Collins                case MIKIO_LEXER_ENTER:
5727935713eSJames Collins                    if(method_exists($class, 'render_lexer_enter')) $class->render_lexer_enter($renderer, $data);
5737935713eSJames Collins                    break;
5747935713eSJames Collins                case MIKIO_LEXER_EXIT:
5757935713eSJames Collins                    if(method_exists($class, 'render_lexer_exit')) $class->render_lexer_exit($renderer, $data);
5767935713eSJames Collins                    break;
5777935713eSJames Collins                case MIKIO_LEXER_SPECIAL:
5787935713eSJames Collins                    if(method_exists($class, 'render_lexer_special')) $class->render_lexer_special($renderer, $data);
5797935713eSJames Collins                    break;
5807935713eSJames Collins            }
58117e6d639SJames Collins        }
58217e6d639SJames Collins    }
583ebb7bc5aSJames Collins
5842f5b9ce6SJames Collins
58518e323fdSJames Collins    protected function callMikioTag($className, $data) {
58618e323fdSJames Collins        // $className = 'syntax_plugin_mikioplugin_'.$className;
5872f5b9ce6SJames Collins
5882f5b9ce6SJames Collins
58918e323fdSJames Collins        // if(class_exists($className)) {
59018e323fdSJames Collins            //$class = new $className;
59118e323fdSJames Collins            if(!plugin_isdisabled('mikioplugin')) {
59218e323fdSJames Collins                $class = plugin_load('syntax', 'mikioplugin_' . $className);
59318e323fdSJames Collins                // echo '^^'.$className.'^^';
59418e323fdSJames Collins
59518e323fdSJames Collins
59618e323fdSJames Collins                if(method_exists($class, 'mikioCall')) return $class->mikioCall($data);
59718e323fdSJames Collins
5982f5b9ce6SJames Collins            }
5992f5b9ce6SJames Collins
60018e323fdSJames Collins        // }
60118e323fdSJames Collins
6022f5b9ce6SJames Collins        return '';
6032f5b9ce6SJames Collins    }
6042f5b9ce6SJames Collins
6052f5b9ce6SJames Collins
606f003e4a8SJames Collins    protected function callMikioOptionDefault($className, $option) {
607f003e4a8SJames Collins        $className = 'syntax_plugin_mikioplugin_'.$className;
608f003e4a8SJames Collins
609f003e4a8SJames Collins        if(class_exists($className)) {
610f003e4a8SJames Collins            $class = new $className;
611f003e4a8SJames Collins
612f003e4a8SJames Collins            if(array_key_exists($option, $class->options) && array_key_exists('default', $class->options[$option])) {
613f003e4a8SJames Collins                return $class->options[$option]['default'];
614f003e4a8SJames Collins            }
615f003e4a8SJames Collins        }
616f003e4a8SJames Collins
617f003e4a8SJames Collins        return '';
618f003e4a8SJames Collins    }
619f003e4a8SJames Collins
620f003e4a8SJames Collins
6212f5b9ce6SJames Collins    protected function buildTooltip($text) {
6222f5b9ce6SJames Collins        if($text != '') {
6232f5b9ce6SJames Collins            return ' data-tooltip="' . $text . '"';
6242f5b9ce6SJames Collins        }
6252f5b9ce6SJames Collins
6262f5b9ce6SJames Collins        return '';
6272f5b9ce6SJames Collins    }
6282f5b9ce6SJames Collins
6297935713eSJames Collins    /*
6307935713eSJames Collins    * Create array with passed elements and include them if their values are not empty
6317935713eSJames Collins    *
6327935713eSJames Collins    * @param ...        array items
6337935713eSJames Collins    */
6347935713eSJames Collins    protected function arrayRemoveEmpties($items) {
6357935713eSJames Collins        $result = array();
6367935713eSJames Collins
6377935713eSJames Collins        foreach($items as $key => $value) {
6387935713eSJames Collins            if($value != '') {
6397935713eSJames Collins                $result[$key] = $value;
6407935713eSJames Collins            }
6417935713eSJames Collins        }
6427935713eSJames Collins
6437935713eSJames Collins        return $result;
6447935713eSJames Collins    }
6457935713eSJames Collins
6467935713eSJames Collins    public function getFirstArrayKey($data)
6477935713eSJames Collins    {
648ebb7bc5aSJames Collins        if (!function_exists('array_key_first')) {
649ebb7bc5aSJames Collins            foreach ($data as $key => $unused) {
650ebb7bc5aSJames Collins                return $key;
651ebb7bc5aSJames Collins            }
652ebb7bc5aSJames Collins        }
653ebb7bc5aSJames Collins
654ebb7bc5aSJames Collins        return array_key_first($data);
655ebb7bc5aSJames Collins    }
6567935713eSJames Collins
6577935713eSJames Collins
6587935713eSJames Collins    /*
6597935713eSJames Collins    * add common options to options
6607935713eSJames Collins    *
6617935713eSJames Collins    * @param $typelist      common option to add
6627935713eSJames Collins    * @param $options   save in options
6637935713eSJames Collins    */
6647935713eSJames Collins    public function addCommonOptions($typelist) {
6657935713eSJames Collins        $types = explode(' ', $typelist);
6667935713eSJames Collins        foreach($types as $type) {
6677935713eSJames Collins            if(strcasecmp($type, 'shadow') == 0) {
6687935713eSJames Collins                $this->options['shadow'] =          array('type'     => 'choice',
6697935713eSJames Collins                                                          'data'     => array('large'=> array('shadow-large', 'shadow-lg'), 'small' => array('shadow-small', 'shadow-sm'), true),
6707935713eSJames Collins                                                          'default'  => '',
6717935713eSJames Collins                                                          'class'    => true);
6727935713eSJames Collins            }
6737935713eSJames Collins
6747935713eSJames Collins            if(strcasecmp($type, 'width') == 0) {
6757935713eSJames Collins                $this->options['width'] =           array('type'     => 'size',
6767935713eSJames Collins                                                          'default'  => '');
6777935713eSJames Collins            }
6787935713eSJames Collins
6797935713eSJames Collins            if(strcasecmp($type, 'height') == 0) {
6807935713eSJames Collins                $this->options['height'] =          array('type'     => 'size',
6817935713eSJames Collins                                                          'default'  => '');
6827935713eSJames Collins            }
6837935713eSJames Collins
68418e323fdSJames Collins            if(strcasecmp($type, 'text-color') == 0) {
68518e323fdSJames Collins                $this->options['text-color'] =          array('type'      => 'color',
68618e323fdSJames Collins                                                          'default'  => '');
68718e323fdSJames Collins            }
68818e323fdSJames Collins
6897935713eSJames Collins            if(strcasecmp($type, 'type') == 0) {
690358ba801SJames Collins              $this->options['type'] =              array('type'     => 'text',
691e84ad5e7SJames Collins                                                        'data'     => array('primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark', 'outline-primary', 'outline-secondary', 'outline-success', 'outline-danger', 'outline-warning', 'outline-info', 'outline-light', 'outline-dark'),
6927935713eSJames Collins                                                        'default'  => '',
6937935713eSJames Collins                                                        'class'    => true);
6947935713eSJames Collins            }
6957935713eSJames Collins
6967935713eSJames Collins            if(strcasecmp($type, 'text-align') == 0) {
6977935713eSJames Collins                $this->options['text-align'] =      array('type'     => 'choice',
6987935713eSJames Collins                                                          'data'     => array('left' => array('text-left'), 'center' => array('text-center'), 'right' => array('text-right')),
6997935713eSJames Collins                                                          'default'  => '',
7007935713eSJames Collins                                                          'class'    => true);
7017935713eSJames Collins            }
7027935713eSJames Collins
7037935713eSJames Collins            if(strcasecmp($type, 'align') == 0) {
7047935713eSJames Collins                $this->options['align'] =           array('type'     => 'choice',
7057935713eSJames Collins                                                          'data'     => array('left' => array('align-left'), 'center' => array('align-center'), 'right' => array('align-right')),
7067935713eSJames Collins                                                          'default'  => '',
7077935713eSJames Collins                                                          'class'    => true);
7087935713eSJames Collins            }
7092f5b9ce6SJames Collins
7102f5b9ce6SJames Collins            if(strcasecmp($type, 'tooltip') == 0) {
7112f5b9ce6SJames Collins                $this->options['tooltip'] =         array('type'     => 'text',
7122f5b9ce6SJames Collins                                                          'default'  => '',
7132f5b9ce6SJames Collins                                                          'class'    => true,
7142f5b9ce6SJames Collins                                                          'classNoSuffix'   => true);
7152f5b9ce6SJames Collins            }
71618e323fdSJames Collins
71718e323fdSJames Collins            if(strcasecmp($type, 'vertical-align') == 0) {
71818e323fdSJames Collins                $this->options['vertical-align'] =  array('type'    => 'choice',
71918e323fdSJames Collins                                                          'data'    => array('top' => array('align-top'), 'middle' => array('align-middle'), 'bottom' => array('align-bottom')),
72018e323fdSJames Collins                                                          'default' => '',
72118e323fdSJames Collins                                                          'class'   => true);
72218e323fdSJames Collins            }
72318e323fdSJames Collins
72418e323fdSJames Collins            if(strcasecmp($type, 'links-match') == 0) {
72518e323fdSJames Collins                $this->options['links-match'] =     array('type'    => 'boolean',
72618e323fdSJames Collins                                                          'default' => 'false',
72718e323fdSJames Collins                                                          'class'   => true);
72818e323fdSJames Collins            }
72918e323fdSJames Collins
7307935713eSJames Collins        }
7317935713eSJames Collins    }
7327935713eSJames Collins
7337935713eSJames Collins
7347935713eSJames Collins    /*
7357935713eSJames Collins    * Find HTML tags in string. Parse tags options. Used in parsing subtags
7367935713eSJames Collins    *
7377935713eSJames Collins    * @param $tagName       tagName to search for. Name is exclusive
7387935713eSJames Collins    * @param $content       search within content
7397935713eSJames Collins    * @param $options       parse options similar to syntax element options
740f0df6cccSJames Collins    * @param $hasEndTag     tagName search also looks for an end tag
7417935713eSJames Collins    * @return               array of tags containing 'options' => array of 'name' => 'value', 'content' => content inside the tag
7427935713eSJames Collins    */
743f0df6cccSJames Collins    protected function findTags($tagName, $content, $options, $hasEndTag = true) {
7447935713eSJames Collins        $items = array();
745f0df6cccSJames Collins        $search = '/<(?i:' . $tagName . ')(.*?)>(.*?)<\/(?i:' . $tagName . ')>/s';
7467935713eSJames Collins
747f0df6cccSJames Collins        if(!$hasEndTag) {
748f0df6cccSJames Collins            $search = '/<(?i:' . $tagName . ')(.*?)>/s';
749f0df6cccSJames Collins        }
750f0df6cccSJames Collins
751f0df6cccSJames Collins        if(preg_match_all($search, $content, $match)) {
7527935713eSJames Collins            if(count($match) >= 2) {
7537935713eSJames Collins                for($i = 0; $i < count($match[1]); $i++) {
7547935713eSJames Collins                    $item = array('options' => array(), 'content' => $this->render_text($match[2][$i]));
7557935713eSJames Collins
7567935713eSJames Collins                    $optionlist = preg_split('/\s(?=([^"]*"[^"]*")*[^"]*$)/', trim($match[1][$i]));
7577935713eSJames Collins
7587935713eSJames Collins                    foreach ($optionlist as $option) {
7597935713eSJames Collins                        $j = strpos($option, '=');
7607935713eSJames Collins                        if ($j !== false) {
7617935713eSJames Collins                            $value = substr($option, $j + 1);
7627935713eSJames Collins
7637935713eSJames Collins                            if (substr($value, 0, 1) == '"') $value = substr($value, 1);
7647935713eSJames Collins                            if (substr($value, -1) == '"') $value = substr($value, 0, -1);
7657935713eSJames Collins
7667935713eSJames Collins                            $item['options'][substr($option, 0, $j)] = $value;
7677935713eSJames Collins                        } else {
7687935713eSJames Collins                            $item['options'][$option] = true;
7697935713eSJames Collins                        }
7707935713eSJames Collins                    }
7717935713eSJames Collins
7723cbf07a0SJames Collins                    $item['options'] = $this->cleanOptions($item['options'], $options);
7737935713eSJames Collins
7747935713eSJames Collins                    $items[] = $item;
7757935713eSJames Collins                }
7767935713eSJames Collins            }
7777935713eSJames Collins        }
7787935713eSJames Collins
7797935713eSJames Collins        return $items;
7807935713eSJames Collins    }
78131359b6fSJames Collins}