bpmnio/syntax/bpmnio.php

<?php

use dokuwiki\Extension\SyntaxPlugin;
use dokuwiki\File\MediaResolver;

/**
 * @license    See LICENSE file
 */
// See help: https://www.dokuwiki.org/devel:syntax_plugins
// The HTML structure generated by this syntax plugin is:
//
// <div class="plugin-bpmnio" id="__(bpmn|dmn)_js_<hash>">
//   <div class="bpmn_js_data">
//      ... base64 encoded xml
//   </div>
//   <div class="bpmn_js_canvas {$class}">
//     <div class="bpmn_js_container">... rendered herein</div>
//   </div>
// </div>
class syntax_plugin_bpmnio_bpmnio extends SyntaxPlugin
{
    protected string $type = ''; // 'bpmn' or 'dmn'
    protected string $src = ''; // media file
    protected string $zoom = ''; // optional scaling factor
    protected string $lint = ''; // optional bpmnlint mode: on|off|inactive

    private function loadLinkProcessor(): void
    {
        require_once __DIR__ . '/../inc/link_processor.php';
    }

    public function getPType(): string
    {
        return 'block';
    }

    public function getType(): string
    {
        return 'protected';
    }

    public function getSort(): int
    {
        return 0;
    }

    public function connectTo($mode): void
    {
        $this->Lexer->addEntryPattern('<bpmnio.*?>(?=.*?</bpmnio>)', $mode, 'plugin_bpmnio_bpmnio');
    }

    public function postConnect(): void
    {
        $this->Lexer->addExitPattern('</bpmnio>', 'plugin_bpmnio_bpmnio');
    }

    public function handle($match, $state, $pos, Doku_Handler $handler): array
    {
        switch ($state) {
            case DOKU_LEXER_ENTER:
                $matched = [];
                preg_match('/<bpmnio\s+([^>]+)>/', $match, $matched);

                $attrs = [];
                if (!empty($matched[1])) {
                    $attrs = $this->buildAttributes($matched[1]);
                }

                $this->type = $attrs['type'] ?? 'bpmn';
                $this->src = $attrs['src'] ?? '';
                $this->zoom = $this->normalizeZoom($attrs['zoom'] ?? null) ?? '';
                $this->lint = $this->resolveLint($attrs['lint'] ?? null, $this->type);

                return [$state, $this->type, '', $pos, '', false, $this->zoom, $this->lint];

            case DOKU_LEXER_UNMATCHED:
                $posStart = $pos;
                $posEnd = $pos + strlen($match);

                $inline = empty($this->src);
                if (!$inline) {
                    $match = $this->getMedia($this->src);
                }
                return [
                    $state, $this->type, base64_encode(trim($match)),
                    $posStart, $posEnd, $inline, $this->zoom, $this->lint,
                ];

            case DOKU_LEXER_EXIT:
                $this->type = '';
                $this->src = '';
                $this->zoom = '';
                $this->lint = '';
                return [$state, '', '', '', '', false, '', ''];
        }
        return [];
    }

    private function buildAttributes($string)
    {
        $attrs = [];
        preg_match_all('/(\w+)=["\'](.*?)["\']/', $string, $matches, PREG_SET_ORDER);
        foreach ($matches as $match) {
            $attrs[$match[1]] = $match[2];
        }
        return $attrs;
    }

    private function normalizeZoom($zoom): ?string
    {
        if ($zoom === null || $zoom === '') {
            return null;
        }

        if (!is_numeric($zoom)) {
            return null;
        }

        $zoom = (float) $zoom;
        if ($zoom <= 0) {
            return null;
        }

        return rtrim(rtrim(number_format($zoom, 4, '.', ''), '0'), '.');
    }

    /**
     * Resolve the effective bpmnlint mode for the diagram.
     *
     * Per-diagram `lint` attribute wins when valid; otherwise the global plugin
     * setting is used. Linting only applies to BPMN diagrams; for any other
     * type the result is an empty string and no data-lint attribute is emitted.
     *
     * @param mixed  $lint Raw attribute value (string|null|other)
     * @param string $type Diagram type (`bpmn` or `dmn`)
     */
    private function resolveLint($lint, string $type): string
    {
        if ($type !== 'bpmn') {
            return '';
        }

        $allowed = ['on', 'off', 'inactive'];

        if (is_string($lint)) {
            $normalized = strtolower(trim($lint));
            if (in_array($normalized, $allowed, true)) {
                return $normalized;
            }
        }

        $default = strtolower((string) $this->getConf('lint'));
        return in_array($default, $allowed, true) ? $default : 'off';
    }

    private function getMedia($src)
    {
        global $ID;

        $id = (new MediaResolver($ID))->resolveId($src);
        if (auth_quickaclcheck($id) < AUTH_READ) {
            return "Error: Access denied for file $src";
        }

        $file = mediaFN($id);
        if (!file_exists($file) || !is_readable($file)) {
            return "Error: Cannot load file $src";
        }

        return file_get_contents($file);
    }

    public function render($mode, Doku_Renderer $renderer, $data): bool
    {
        [$state, $type, $match, $posStart, $posEnd, $inline, $zoom, $lint] = array_pad($data, 8, '');

        if (is_a($renderer, 'renderer_plugin_dw2pdf')) {
            if ($state == DOKU_LEXER_EXIT) {
                $renderer->doc .= <<<HTML
                    <div class="plugin-bpmnio">
                        <a href="https://github.com/Color-Of-Code/dokuwiki-plugin-bpmnio/issues/4">
                            DW2PDF support missing: Help wanted
                        </a>
                    </div>
                    HTML;
            }
            return true;
        }

        if ($mode == 'xhtml' || $mode == 'odt') {
            switch ($state) {
                case DOKU_LEXER_ENTER:
                    $bpmnid = "__{$type}_js_{$posStart}";
                    $renderer->doc .= <<<HTML
                        <div class="plugin-bpmnio" id="{$bpmnid}">
                        HTML;
                    break;

                case DOKU_LEXER_UNMATCHED:
                    $xml = base64_decode($match, true);
                    if ($xml === false) {
                        $xml = $match;
                    }

                    $this->loadLinkProcessor();
                    $payload = plugin_bpmnio_link_processor::buildPayload($xml);
                    $encodedXml = base64_encode($payload['xml']);
                    $encodedLinks = base64_encode(json_encode($payload['links']));
                    $renderer->doc .= <<<HTML
                        <div class="{$type}_js_data">
                            {$encodedXml}
                        </div>
                        <div class="{$type}_js_links">
                            {$encodedLinks}
                        </div>
                        HTML;
                    if ($inline) {
                        $target = "plugin_bpmnio_{$type}";
                        $sectionEditData = ['target' => $target];
                        $class = $renderer->startSectionEdit($posStart, $sectionEditData);
                    } else {
                        $class = '';
                    }
                    $zoomAttr = $zoom !== '' ? " data-zoom=\"{$zoom}\"" : '';
                    $lintAttr = $lint !== '' ? " data-lint=\"{$lint}\"" : '';
                    $renderer->doc .= <<<HTML
                        <div class="{$type}_js_canvas {$class}">
                            <div class="{$type}_js_container"{$zoomAttr}{$lintAttr}></div>
                        </div>
                        HTML;
                    if ($inline) {
                        $renderer->finishSectionEdit($posEnd);
                    }
                    break;

                case DOKU_LEXER_EXIT:
                    $renderer->doc .= <<<HTML
                        </div>
                        HTML;
                    break;
            }
            return true;
        }
        return false;
    }
}