ITX.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

// +----------------------------------------------------------------------+
// +----------------------------------------------------------------------+
// | This source file is subject to the New BSD license, That is bundled  |
// | the world-wide-web at                                                |
// | http://www.opensource.org/licenses/bsd-license.php                   |
// | If you did not receive a copy of the new BSD license and are unable  |
// | to obtain it through the world-wide-web, please send a note to       |
// | pajoye@php.net, so we can mail you a copy immediately.               |
// +----------------------------------------------------------------------+
// | Author: Ulf Wendel <ulf.wendel@phpdoc.de>                            |
// |         Pierre-Alain Joye <pajoye@php.net>                           |
// +----------------------------------------------------------------------+
class HTML_Template_ITX extends HTML_Template_IT
{
    public array $warn = [];

    public bool $printWarning = false;

    public bool $haltOnWarning = false;

    public string $checkblocknameRegExp = '';

    public string $functionPrefix = 'func_';

    public string $functionnameRegExp = '[_a-zA-Z]+[A-Za-z_0-9]*';

    public string $functionRegExp = '';

    public array $functions = [];

    public array $callback = [];

    public function __construct(string $root = '')
    {
        $this->checkblocknameRegExp = '@' . $this->blocknameRegExp . '@';
        $this->functionRegExp = '@' . $this->functionPrefix . '(' .
            $this->functionnameRegExp . ')\s*\(@sm';

        parent::__construct($root);
    }

    protected function init(): void
    {
        $this->free();
        $this->buildFunctionlist();
        $this->findBlocks($this->template);
        // we don't need it any more
        $this->template = '';
        $this->buildBlockvariablelist();
    }

    public function replaceBlock(string $block, string $template, bool $keep_content = false): bool
    {
        if (!isset($this->blocklist[$block])) {
            throw new ilTemplateException("The block " . "'$block'" . " does not exist in the template and thus it can't be replaced.");
        }

        if ($template === '') {
            throw new ilTemplateException('No block content given.');
        }

        if ($keep_content) {
            $blockdata = $this->blockdata[$block];
        }

        // remove all kinds of links to the block / data of the block
        $this->removeBlockData($block);

        $template = "<!-- BEGIN $block -->" . $template . "<!-- END $block -->";
        $parents = $this->blockparents[$block];
        $this->findBlocks($template);
        $this->blockparents[$block] = $parents;

        // KLUDGE: rebuild the list for all block - could be done faster
        $this->buildBlockvariablelist();

        if ($keep_content) {
            $this->blockdata[$block] = $blockdata;
        }

        return true;
    }

    public function addBlock(string $placeholder, string $blockname, string $template): bool
    {
        // Don't trust any user even if it's a programmer or yourself...
        if ($placeholder === '') {
            throw new ilTemplateException('No variable placeholder given.');
        }

        if ($blockname === '' ||
            !preg_match($this->checkblocknameRegExp, $blockname)) {
            throw new ilTemplateException("No or invalid blockname '$blockname' given.");
        }

        if ($template === '') {
            throw new ilTemplateException('No block content given.');
        }

        if (isset($this->blocklist[$blockname])) {
            throw new ilTemplateException('The block ' . $blockname . ' already exists.');
        }

        // find out where to insert the new block
        $parents = $this->findPlaceholderBlocks($placeholder);
        if (count($parents) === 0) {
            throw (new ilTemplateException("The variable placeholder" .
                " '$placeholder' was not found in the template."));
        }

        if (count($parents) > 1) {
            $msg = '';
            foreach ($parents as $index => $parent) {
                $msg .= (isset($parents[$index + 1])) ?
                    "$parent, " : $parent;
            }

            throw new ilTemplateException("The variable placeholder " . "'$placeholder'" . " must be unique, found in multiple blocks '$msg'.");
        }

        $template = "<!-- BEGIN $blockname -->" . $template . "<!-- END $blockname -->";
        $this->findBlocks($template);
        if ($this->flagBlocktrouble) {
            return false;    // findBlocks() already throws an exception
        }
        $this->blockinner[$parents[0]][] = $blockname;
        $this->blocklist[$parents[0]] = preg_replace(
            '@' . $this->openingDelimiter . $placeholder .
            $this->closingDelimiter . '@',
            $this->openingDelimiter . '__' . $blockname . '__' .
            $this->closingDelimiter,
            $this->blocklist[$parents[0]]
        );

        $this->deleteFromBlockvariablelist($parents[0], $placeholder);
        $this->updateBlockvariablelist($blockname);

        return true;
    }

    public function addBlockfile(string $placeholder, string $blockname, string $filename): bool
    {
        return $this->addBlock($placeholder, $blockname, $this->getFile($filename));
    }

    public function removeBlockData(string $block): void
    {
        if (isset($this->blockinner[$block])) {
            foreach ($this->blockinner[$block] as $inner) {
                $this->removeBlockData($inner);
            }

            unset($this->blockinner[$block]);
        }

        unset(
            $this->blocklist[$block],
            $this->blockdata[$block],
            $this->blockvariables[$block],
            $this->touchedBlocks[$block]
        );
    }

    public function blockExists(string $blockname): bool
    {
        return isset($this->blocklist[$blockname]);
    }

    public function buildFunctionlist(): void
    {
        $this->functions = [];

        $template = $this->template;
        $num = 0;

        while (preg_match($this->functionRegExp, $template, $regs)) {
            $pos = strpos($template, $regs[0]);
            $template = substr($template, $pos + strlen($regs[0]));

            $head = $this->getValue($template, ')');
            $args = [];

            $search = $regs[0] . $head . ')';

            $replace = $this->openingDelimiter .
                '__function' . $num . '__' .
                $this->closingDelimiter;

            $this->template = str_replace($search, $replace, $this->template);
            $template = str_replace($search, $replace, $template);

            while ($head !== '' && $args2 = $this->getValue($head, ',')) {
                $arg2 = trim($args2);
                $args[] = ('"' === $arg2[0] || "'" === $arg2[0]) ?
                    substr($arg2, 1, -1) : $arg2;
                if ($arg2 === $head) {
                    break;
                }
                $head = substr($head, strlen($arg2) + 1);
            }

            $this->functions[$num++] = [
                'name' => $regs[1],
                'args' => $args
            ];
        }
    }

    public function getValue(string $code, $delimiter): string
    {
        if ($code === '') {
            return '';
        }

        if (!is_array($delimiter)) {
            $delimiter = [$delimiter => true];
        }

        $len = strlen($code);
        $enclosed = false;
        $enclosed_by = '';

        if (isset($delimiter[$code[0]])) {
            $i = 1;
        } else {
            for ($i = 0; $i < $len; ++$i) {
                $char = $code[$i];

                if (
                    ($char === '"' || $char === "'") &&
                    ($char === $enclosed_by || '' === $enclosed_by) &&
                    (0 === $i || ($i > 0 && '\\' !== $code[$i - 1]))
                ) {
                    if (!$enclosed) {
                        $enclosed_by = $char;
                    } else {
                        $enclosed_by = "";
                    }
                    $enclosed = !$enclosed;
                }

                if (!$enclosed && isset($delimiter[$char])) {
                    break;
                }
            }
        }

        return substr($code, 0, $i);
    }

    public function deleteFromBlockvariablelist(string $block, $variables): void
    {
        if (!is_array($variables)) {
            $variables = [$variables => true];
        }

        reset($this->blockvariables[$block]);
        foreach ($this->blockvariables[$block] as $varname => $val) {
            if (isset($variables[$varname])) {
                unset($this->blockvariables[$block][$varname]);
            }
        }
    }

    public function updateBlockvariablelist(string $block): void
    {
        preg_match_all(
            $this->variablesRegExp,
            $this->blocklist[$block],
            $regs
        );

        if (count($regs[1]) !== 0) {
            foreach ($regs[1] as $var) {
                $this->blockvariables[$block][$var] = true;
            }
        } else {
            $this->blockvariables[$block] = [];
        }

        // check if any inner blocks were found
        if (isset($this->blockinner[$block]) &&
            is_array($this->blockinner[$block]) &&
            count($this->blockinner[$block]) > 0
        ) {
            /*
             * loop through inner blocks, registering the variable
             * placeholders in each
             */
            foreach ($this->blockinner[$block] as $childBlock) {
                $this->updateBlockvariablelist($childBlock);
            }
        }
    }

    public function findPlaceholderBlocks(string $variable): array
    {
        $parents = [];
        reset($this->blocklist);
        foreach ($this->blocklist as $blockname => $content) {
            reset($this->blockvariables[$blockname]);
            foreach ($this->blockvariables[$blockname] as $varname => $val) {
                if ($variable === $varname) {
                    $parents[] = $blockname;
                }
            }
        }

        return $parents;
    }

    public function warning(string $message, string $file = '', int $line = 0): void
    {
        $message = sprintf(
            'HTML_Template_ITX Warning: %s [File: %s, Line: %d]',
            $message,
            $file,
            $line
        );

        $this->warn[] = $message;

        if ($this->printWarning) {
            print $message;
        }

        if ($this->haltOnWarning) {
            die($message);
        }
    }
}