xref: /plugin/extab4/syntax.php (revision ec44bd345477c6537b6cbcfa2992b97fc97f19e0)

<?php
/**
 * DokuWiki Plugin Extab4 (Syntax component)
 *
 * Allows extended (MediaWiki-style) tables inside DokuWiki
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Satoshi Sahara <sahara.satoshi@gmail.com>
 */
class syntax_plugin_extab4 extends DokuWiki_Syntax_Plugin
{
    public function getType()
    {   // Syntax Type
        return 'container';
    }

    public function getAllowedTypes()
    {   // Allowed Mode Types
        return array(
            'container',
            'formatting',
            'substition',
            'disabled',
            'protected',
            'paragraphs',
        );
    }

    public function getPType()
    {   // Paragraph Type
        return 'block';
    }


    protected $stack = array();  // stack of current open tag - used by handle() method
    protected $tagsmap;
    protected $attrsmap;

    /**
     * Connect pattern to lexer
     */
    protected $mode;

    public function preConnect()
    {
        // drop 'syntax_' from class name
        $this->mode = substr(get_class($this), 7);
    }

    public function connectTo($mode)
    {
        // table start:  {| attrs
        $this->Lexer->addEntryPattern('\n\{\|[^\n]*',$mode, $this->mode);
    }

    public function postConnect()
    {
        // table end:    |}
        $this->Lexer->addExitPattern('[ \t]*\n\|\}', $this->mode);

        // match pattern for attributes
        $attrs = '[^\n\{\|\!\[]+';

        // caption:      |+ attrs | caption
        $this->Lexer->addPattern("\n\|\+ *(?:$attrs\|(?!\|))?", $this->mode);
        // table row:    |- attrs
        $this->Lexer->addPattern(' *?\n\|\-+[^\n]*', $this->mode);
        // table header: ! attrs |
        $this->Lexer->addPattern("(?: *?\n|\!)\!(?:$attrs\|(?!\|))?", $this->mode);
        // table data:   | attrs |
        $this->Lexer->addPattern("(?: *?\n|\|)\|(?:$attrs\|(?!\|))?", $this->mode);
    }

    public function accepts($mode)
    {   // plugin accepts its own entry syntax
        if ($mode == $this->mode) return true;
        return parent::accepts($mode);
    }

    public function getSort()
    {   // sort number used to determine priority of this mode
        return 59; // = Doku_Parser_Mode_table-1
    }


    /**
     * helper function to simplify writing plugin calls to the instruction list
     * first three arguments are passed to function render as $data
     */
    protected function writeCall($tag, $attr, $state, $pos, $match, $handler)
    {
        $data = array($state, $tag, $attr);
        $handler->addPluginCall($this->getPluginName(), $data, $state, $pos, $match);
    }

    protected function open($tag, $attr, $pos, $match, $handler)
    {
      //$this->writeCall($tag,$attr,DOKU_LEXER_ENTER, $pos,$match,$handler);
        $match = array(DOKU_LEXER_ENTER, $tag, $attr);
        $handler->plugin($match, 'addPluginCall', $pos, $this->getPluginName());
    }

    protected function close($tag, $pos, $match, $handler)
    {
      //$this->writeCall($tag,'',DOKU_LEXER_EXIT, $pos,$match,$handler);
        $match = array(DOKU_LEXER_EXIT, $tag, '');
        $handler->plugin($match, 'addPluginCall', $pos, $this->getPluginName());
    }

    /**
     * helper function for exttab syntax translation to html
     *
     * @param string $match       matched string
     * @return array              tag name and attributes
     */
    protected function interpret($match = '')
    {
        $markup = ltrim($match);
        $len = 2;
        switch (substr($markup, 0, $len)) {
            case '{|': $tag = 'table';   break;
            case '|}': $tag = '/table';  break;
            case '|+': $tag = 'caption'; break;
            case '|-': $tag = 'tr';      break;
            case '||': $tag = 'td';      break;
            case '!!': $tag = 'th';      break;
            default:
                $len = 1;
                switch (substr($markup, 0, $len)) {
                    case '!': $tag = 'th'; break;
                    case '|': $tag = 'td'; break;
                }
        }
        if (isset($tag)) {
            $attrs = substr($markup, $len);
            return array($tag, $attrs);
        } else {
            msg($this->getPluginName().' ERROR: unknown syntax: '.hsc($markup) ,-1);
            return false;
        }
    }

    /**
     * append specified class name to attributes
     *
     * @param string $class       class name
     * @param string $attr        attributes of html tag
     * @return string             modified $attr
     */
    private function appendClass($class, $attr)
    {
        $regex = '/\bclass\s*=\s*(["\'])(.*?)\1/i';
        if (preg_match($regex, $attr, $matches) !== 1) {
            // class attribute is not specified
            return rtrim($attr).' class="'.$class.'"';
        }

        $items = preg_split('/\s+/', trim($matches[2]), -1, PREG_SPLIT_NO_EMPTY);
        if (in_array($class, $items, true)) {
            // class already exists in the class attribute
            return $attr;
        }

        $items[] = $class;
        $replace = 'class='.$matches[1].implode(' ', $items).$matches[1];
        return preg_replace($regex, $replace, $attr, 1);
    }


    /**
     * Handle the match
     */
    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        switch ($state) {
            case 'addPluginCall':
                // write plugin instruction to call list of the handler
                // Note: $match is array, not matched text
                return $data = $match;

            case DOKU_LEXER_ENTER:
                // table start
                list($tag, $attr) = $this->interpret($match);
                // ensure that class attribute cotains "exttable"
                $attr = $this->appendClass('exttable', $attr);
                array_push($this->stack, $tag);
                $this->open($tag, $attr, $pos, $match, $handler);
                break;
            case DOKU_LEXER_EXIT:
                do { // rewind table
                    $oldtag = array_pop($this->stack);
                    $this->close($oldtag, $pos, $match, $handler);
                } while ($oldtag != 'table');
                break;
            case DOKU_LEXER_MATCHED:
                $tag_prev = end($this->stack);
                list($tag, $attr) = $this->interpret($match);
                switch ($tag_prev) {
                    case 'caption':
                                $oldtag = array_pop($this->stack);
                                $this->close($oldtag, $pos, $match, $handler);
                    case 'table':
                        switch ($tag) {
                            case 'caption':
                            case 'tr':
                                array_push($this->stack, $tag);
                                $this->open($tag, $attr, $pos, $match, $handler);
                                break;
                            case 'th':
                            case 'td':
                                array_push($this->stack, 'tr');
                                $this->open('tr', '', $pos, $match, $handler);
                                array_push($this->stack, $tag);
                                $this->open($tag, $attr, $pos, $match, $handler);
                                break;
                        }
                        break;
                    case 'tr':
                        switch ($tag) {
                            case 'caption':
                                msg($this->getPluginName().' Syntax ERROR: match='.hsc(trim($match)) ,-1);
                                break;
                            case 'tr':
                                $oldtag = array_pop($this->stack);
                                $this->close($oldtag, $pos, $match, $handler);
                                array_push($this->stack, $tag);
                                $this->open($tag, $attr, $pos, $match, $handler);
                                break;
                            case 'th':
                            case 'td':
                                array_push($this->stack, $tag);
                                $this->open($tag, $attr, $pos, $match, $handler);
                                break;
                        }
                        break;
                    case 'th':
                    case 'td':
                        switch ($tag) {
                            case 'caption':
                                msg($this->getPluginName().' Syntax ERROR: match='.hsc(trim($match)) ,-1);
                                break;
                            case 'tr':
                                do { // rewind old row prior to start new row
                                    $oldtag = array_pop($this->stack);
                                    $this->close($oldtag, $pos, $match, $handler);
                                } while ($oldtag != 'tr');
                                array_push($this->stack, $tag);
                                $this->open($tag, $attr, $pos, $match, $handler);
                                break;
                            case 'th':
                            case 'td':
                                $oldtag = array_pop($this->stack);
                                $this->close($oldtag, $pos, $match, $handler);
                                array_push($this->stack, $tag);
                                $this->open($tag, $attr, $pos, $match, $handler);
                                break;
                        }
                        break;
                }
                break;
            case DOKU_LEXER_UNMATCHED:
                $tag_prev = end($this->stack);
                switch ($tag_prev) {
                    case 'caption':
                                // cdata --- use base() instead of $this->_writeCall()
                                $handler->base($match, $state, $pos);
                                break;
                    case 'table':
                                array_push($this->stack, 'tr');
                                $this->open('tr', '', $pos, $match, $handler);
                    case 'tr':
                                array_push($this->stack, 'td');
                                $this->open('td', '', $pos, $match, $handler);
                    case 'th':
                    case 'td':
                                // cdata --- use base() instead of $this->_writeCall()
                                $handler->base($match, $state, $pos);
                                break;
                }
                break;
        }
        return false;
    }


   /**
    * Create output
    */
    public function render($format, Doku_Renderer $renderer, $data)
    {
        if (empty($data)) return false;

        switch ($format) {
            case 'xhtml' :
                return $this->render_xhtml($renderer, $data);
            case 'odt'   :
            case 'odt_pdf':
                $odt = $this->loadHelper('extab4_odt');
                return $odt->render($renderer, $data);
            default:
                return false;
        }
    }

    protected function render_xhtml(Doku_Renderer $renderer, $data)
    {
        // prepare class properties
        isset($this->tagsmap) || $this->setTagsmap();
        isset($this->attrsmap) || $this->setAllowedAttributes();

        list($state, $tag, $attr) = $data;

        switch ($state) {
            case DOKU_LEXER_ENTER:    // open tag
                $renderer->doc.= $this->tag_open($tag, $attr);
                break;
            case DOKU_LEXER_MATCHED:  // defensive, shouldn't occur
            case DOKU_LEXER_UNMATCHED:
                $renderer->cdata($tag);
                break;
            case DOKU_LEXER_EXIT:     // close tag
                $renderer->doc.= $this->tag_close($tag);
                break;
        }
        return true;
    }

    /**
     * open a exttab tag, used in render_xhtml()
     *
     * @param  string $tag        'table','caption','tr','th' or 'td'
     * @param  string $attr       attibutes of tag element
     * @return string             html used to open the tag
     */
    protected function tag_open($tag, $attr = null)
    {
        $before = $this->tagsmap[$tag][0];
        $after  = $this->tagsmap[$tag][1];
        $attr = $this->cleanAttrString($attr, $this->attrsmap);
        return $before.'<'.$tag.$attr.'>'.$after;
    }

    /**
     * close a exttab tag, used in render_xhtml()
     *
     * @param  string $tag        'table','caption','tr','th' or 'td'
     * @return string             html used to close the tag
     */
    protected function tag_close($tag)
    {
        $before = $this->tagsmap['/'.$tag][0];
        $after  = $this->tagsmap['/'.$tag][1];
        return $before.'</'.$tag.'>'.$after;
    }

    /**
     * prepare tagsmap used in tag_open() and tag_close()
     */
    protected function setTagsmap()
    {
        // define name, prefix and postfix of tags
        $this->tagsmap = array(
                'table'    => array("", "\n" ),     // table start  : {|
                '/table'   => array("", "\n"),      // table end    : |}
                'caption'  => array("", ""),        // caption      : |+
                '/caption' => array("", "\n"),
                'tr'       => array("", "\n"),      // table row    : |-
                '/tr'      => array("", "\n"),
                'th'       => array("", ""),        // table header : !
                '/th'      => array("", "\n"),
                'td'       => array("", ""),        // table data   : |
                '/td'      => array("", "\n"),
        );
    }

    /**
     * prepare attrsmap used in cleanAttrString()
     */
    protected function setAllowedAttributes()
    {
        // define allowable attibutes for table tags
        $this->attrsmap = array(
            // html5 HTML Global Attributes
            'accesskey', 'class', 'contenteditable', 'contextmenu',
            'dir', 'draggable', 'dropzone', 'hidden', 'id', 'lang',
            'spellcheck', 'style', 'tabindex', 'title', 'translate',
            'xml:lang',
            // html5 table tag
            'border', 'sortable',
            // html5 th and td tag
            'abbr', 'colspan', 'headers', 'rowspan', 'scope', 'sorted',
            // deprecated in html5
            'align', 'valign', 'width', 'height', 'bgcolor', 'nowrap',
        );
    }


    /**
     * Make the attribute string safe to avoid XSS attacks.
     *
     * @author Ashish Myles <marcianx@gmail.com>
     *
     * @param  string $attr           attibutes to be checked
     * @param  array  $allowed_keys   allowed attribute name map
     *                                ex: array('border','bgcolor');
     * @return string                 cleaned attibutes
     *
     * WATCH OUT FOR
     * - event handlers (e.g. onclick="javascript:...", etc)
     * - CSS (e.g. background: url(javascript:...))
     * - closing the tag and opening a new one
     * WHAT IS DONE
     * - turn all whitespace into ' ' (to protect from removal)
     * - remove all non-printable characters and < and >
     * - parse and filter attributes using a whitelist
     * - styles with 'url' in them are altogether removed
     * (I know this is brutally aggressive and doesn't allow
     * some safe stuff, but better safe than sorry.)
     * NOTE: Attribute values MUST be in quotes now.
     */
    protected function cleanAttrString($attr, $allowed_keys)
    {
        if (is_null($attr)) return null;

        // Keep spaces simple
        $attr = trim(preg_replace('/\s+/', ' ', $attr));
        // Remove non-printable characters and angle brackets
        $attr = preg_replace('/[<>[:^print:]]+/', '', $attr);
        // This regular expression parses the value of an attribute and
        // the quotation marks surrounding it.
        // It assumes that all quotes within the value itself must be escaped,
        // which is not technically true.
        // To keep the parsing simple (no look-ahead), the value must be in
        // quotes.
        $val = "([\"'`])(?:[^\\\\\"'`]|\\\\.)*\g{-1}";

        $nattr = preg_match_all("/(\w+)\s*=\s*($val)/", $attr, $matches, PREG_SET_ORDER);
        if (!$nattr) return null;

        $clean_attr = '';
        for ($i = 0; $i < $nattr; ++$i) {
            $m = $matches[$i];
            $attrname = strtolower($m[1]);
            $attrval  = $m[2];
            // allow only recognized attributes
            if (in_array($attrname, $allowed_keys, true)) {
                // make sure that style attributes do not have a url in them
                if ($attrname != 'style' ||
                      (stristr($attrval, 'url') === false &&
                      stristr($attrval, 'import') === false)) {
                    $clean_attr.= " $attrname=$attrval";
                }
            }
        }
        return $clean_attr;
    }

}