xref: /plugin/dbquery/syntax/query.php (revision 19d0a884dddeec9e1724d72d24545e2e89a66bae)

<?php

use dokuwiki\Extension\SyntaxPlugin;

/**
 * DokuWiki Plugin dbquery (Syntax Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr <dokuwiki@cosmocode.de>
 */
class syntax_plugin_dbquery_query extends SyntaxPlugin
{
    /** @inheritDoc */
    public function getType()
    {
        return 'substition';
    }

    /** @inheritDoc */
    public function getPType()
    {
        return 'block';
    }

    /** @inheritDoc */
    public function getSort()
    {
        return 135;
    }

    /** @inheritDoc */
    public function connectTo($mode)
    {
        $this->Lexer->addSpecialPattern('{{QUERY:\w+}}', $mode, 'plugin_dbquery_query');
    }

    /** @inheritDoc */
    public function handle($match, $state, $pos, Doku_Handler $handler)
    {
        return ['name' => substr($match, 8, -2)];
    }

    /** @inheritDoc */
    public function render($mode, Doku_Renderer $renderer, $data)
    {
        if ($mode !== 'xhtml') {
            return false;
        }

        /** @var helper_plugin_dbquery $hlp */
        $hlp = plugin_load('helper', 'dbquery');
        try {
            $qdata = $hlp->loadDataFromPage($data['name']);
            $result = $hlp->executeQuery($qdata['codeblocks']['_'], $qdata['macros']['dsn'] ?? null);
        } catch (\Exception $e) {
            msg(hsc($e->getMessage()), -1);
            return true;
        }

        if (count($result) === 1 && isset($result[0]['status']) && isset($qdata['codeblocks'][$result[0]['status']])) {
            $this->renderStatus($result, $qdata['codeblocks'][$result[0]['status']], $renderer);
        } elseif ($qdata['macros']['transpose']) {
            $this->renderTransposedResultTable($result, $renderer);
        } else {
            $this->renderResultTable($result, $renderer);
        }

        return true;
    }

    /**
     * Render given result via the given status HTML
     *
     * @param string[][] $result
     * @param string $html
     * @param Doku_Renderer $R
     */
    public function renderStatus($result, $html, Doku_Renderer $R)
    {
        $value = $result[0]['result'] ?? '';
        $html = str_replace(':result', hsc($value), $html);
        $R->doc .= $html;
    }

    /**
     * Render the given result as a table
     *
     * @param string[][] $result
     * @param Doku_Renderer $R
     */
    public function renderResultTable($result, Doku_Renderer $R)
    {
        global $lang;

        if (!count($result)) {
            $R->cdata($lang['nothingfound']);
            return;
        }

        $R->table_open();
        $R->tablethead_open();
        $R->tablerow_open();
        foreach (array_keys($result[0]) as $header) {
            $header = preg_replace('/_wiki$/', ' ', $header); // remove _wiki type suffix
            $R->tableheader_open();
            $R->cdata($header);
            $R->tableheader_close();
        }
        $R->tablerow_close();
        $R->tablethead_close();

        $R->tabletbody_open();
        foreach ($result as $row) {
            $R->tablerow_open();
            foreach ($row as $col =>  $cell) {
                $R->tablecell_open();
                $this->cellFormat($cell, $R, $col);
                $R->tablecell_close();
            }
            $R->tablerow_close();
        }
        $R->tabletbody_close();
        $R->table_close();
    }

    /**
     * Render the given result as a table, but turned 90 degrees
     *
     * @param string[][] $result
     * @param Doku_Renderer $R
     */
    public function renderTransposedResultTable($result, Doku_Renderer $R)
    {
        global $lang;

        if (!count($result)) {
            $R->cdata($lang['nothingfound']);
            return;
        }

        $width = count($result[0]);
        $height = count($result);

        $R->table_open();
        for ($x = 0; $x < $width; $x++) {
            $col = array_keys($result[0])[$x];
            $header = preg_replace('/_wiki$/', ' ', $col); // remove _wiki type suffix

            $R->tablerow_open();
            $R->tableheader_open();
            $R->cdata($header);
            $R->tableheader_close();

            for ($y = 0; $y < $height; $y++) {
                $R->tablecell_open();
                $this->cellFormat(array_values($result[$y])[$x], $R, $col);
                $R->tablecell_close();
            }
            $R->tablerow_close();
        }
        $R->table_close();
    }

    /**
     * Pass the given cell content to the correct renderer call
     *
     * Detects a subset of the wiki link syntax
     *
     * @param string $content
     * @param Doku_Renderer $R
     * @param string $name Name of the selected column
     * @return void
     */
    protected function cellFormat($content, Doku_Renderer $R, $name)
    {
        if(trim($content) === '') {
            return;
        }

        // parse wiki syntax
        if(str_ends_with($name, '_wiki')) {
            $this->renderInject($R, $content);
            return;
        }

        // external urls
        if (preg_match('/^\[\[(https?:\/\/[^|\]]+)(|.*?)?]]$/', $content, $m)) {
            $url = $m[1];
            $title = $m[2] ?? '';
            $title = trim($title, '|');
            $R->externallink($url, $title);
            return;
        }

        // internal urls
        if (preg_match('/^\[\[([^|\]]+)(|.*?)?]]$/', $content, $m)) {
            $page = cleanID($m[1]);
            $title = $m[2] ?? '';
            $title = trim($title, '|');
            $R->internallink($page, $title);
            return;
        }

        $R->cdata($content);
    }

    /**
     * Injects the given syntax into the current renderer
     *
     * @param Doku_Renderer $R
     * @param string $syntax
     * @return void
     */
    protected function renderInject(Doku_Renderer $R, $syntax)
    {
        $instructions = p_get_instructions($syntax);
        foreach ($instructions as $instruction) {
            // not these
            if(in_array($instruction[0], ['document_start', 'document_end'])) {
                continue;
            }

            // no headers
            if($instruction[0] === 'header') {
                $R->p_open();
                $R->strong_open();
                $R->cdata($instruction[1][0]);
                $R->strong_close();
                $R->p_close();
                continue;
            }

            call_user_func_array([$R, $instruction[0]], $instruction[1]);
        }
    }
}