30275971304

Committed 27 Jul 2026 02:32PM UTC coverage: 94.928% (+0.4%) from 94.512%

Build Type

push

github

Committed by

Commit Message

Released version 3.1.6

Coverage Stats

6064 of 6388 relevant lines covered (94.93%)

0.95 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.13

/src/Latte/Compiler/TemplateParserHtml.php

<?php declare(strict_types=1);

/**
 * This file is part of the Latte (https://latte.nette.org)
 * Copyright (c) 2008 David Grudl (https://davidgrudl.com)
 */

namespace Latte\Compiler;

use Latte;
use Latte\CompileException;
use Latte\Compiler\Nodes\AreaNode;
use Latte\Compiler\Nodes\FragmentNode;
use Latte\Compiler\Nodes\Html;
use Latte\ContentType;
use Latte\Helpers;
use Latte\SecurityViolationException;
use function array_keys, array_pop, end, implode, in_array, key, preg_replace, str_starts_with, strlen, substr;


/**
 * Template parser extension for HTML.
 */
final class TemplateParserHtml
{
        private ?Html\ElementNode $element = null;

        /** @var array{string, ?Nodes\Php\ExpressionNode, ?Position}|null */
        private ?array $endName = null;

        /** @var \WeakMap<Html\ElementNode, object{tag: mixed, textualName: string, unclosedTags?: array<string>}> */
        private \WeakMap $elementData;


        public function __construct(
                private readonly TemplateParser $parser,
                /** @var array<string, \Closure(Tag, TemplateParser): (Node|\Generator|void)> */
                private readonly array $attrParsers,
        ) {
                $this->elementData = new \WeakMap;
        }


        public function getElement(): ?Html\ElementNode
        {
                return $this->element;
        }


        public function inTextResolve(): ?Node
        {
                $stream = $this->parser->getStream();
                $token = $stream->peek();
                return match ($token->type) {
                        Token::Html_TagOpen => $this->parseTag(),
                        Token::Html_CommentOpen => $this->parseComment(),
                        Token::Html_BogusOpen => $this->parseBogusTag(),
                        default => $this->parser->inTextResolve(),
                };
        }


        public function inTagResolve(FragmentNode $fragment): ?Node
        {
                $stream = $this->parser->getStream();
                $token = $stream->peek();
                return match ($token->type) {
                        Token::Html_Name => str_starts_with($token->text, TemplateLexer::NPrefix)
                                ? $this->parseNAttribute()
                                : $this->parseAttribute($fragment),
                        Token::Latte_TagOpen => $this->parseAttribute($fragment),
                        Token::Whitespace => $this->parseAttributeWhitespace(),
                        Token::Html_TagClose => null,
                        default => $this->parser->inTextResolve(),
                };
        }


        private function parseTag(): ?Node
        {
                $stream = $this->parser->getStream();
                $lexer = $this->parser->getLexer();
                $lexer->pushState(TemplateLexer::StateHtmlTag);
                $closing = $stream->tryPeek(1)?->is(Token::Slash);
                $lexer->popState();
                if (!$closing) {
                        return $this->parseElement();
                }

                if ($this->element
                        && $this->parser->peekTag() === $this->elementData[$this->element]->tag // is directly in the element
                ) {
                        $save = $stream->getIndex();
                        $this->endName = [$endText] = $this->parseEndTag();
                        if ($this->element->is($endText) || $this->elementData[$this->element]->textualName === $endText) {
                                return null; // go to parseElement() one level up to close the element
                        }
                        $stream->seek($save);
                        if (!in_array($endText, $this->elementData[$this->element]->unclosedTags ?? [], strict: true)) {
                                return null; // go to parseElement() one level up to collapse
                        }
                }

                if ($this->parser->strict) {
                        $stream->throwUnexpectedException(excerpt: '/');
                }
                return $this->parseBogusEndTag();
        }


        private function parseElement(): Node
        {
                $res = new FragmentNode;
                $res->append($this->extractIndentation());
                $res->append($this->parseStartTag($this->element));
                $elem = $this->element;

                $stream = $this->parser->getStream();
                $void = $this->resolveVoidness($elem);
                $attrs = $this->prepareNAttrs($elem->nAttributes, $void);
                $outerNodes = $this->openNAttrNodes($attrs[Tag::PrefixNone] ?? []);
                $tagNodes = $this->openNAttrNodes($attrs[Tag::PrefixTag] ?? []);
                if ($tagNodes) {
                        $elem->dynamicTag = $this->finishNAttrNodes($elem->dynamicTag ?? new Nodes\Html\TagNode($elem), $tagNodes);
                }

                if (!$void) {
                        if ($elem->isRawText()) {
                                $this->parser->getLexer()->pushState(TemplateLexer::StateHtmlRawText, $elem->name);
                        }
                        $content = new FragmentNode;
                        if ($token = $stream->tryConsume(Token::Newline)) {
                                $content->append(new Nodes\TextNode($token->text, $token->position, $token->end));
                        }

                        $innerNodes = $this->openNAttrNodes($attrs[Tag::PrefixInner] ?? []);
                        $this->elementData[$elem]->tag = $this->parser->peekTag();
                        $frag = $this->parser->parseFragment($this->inTextResolve(...));
                        $content->append($this->finishNAttrNodes($frag, $innerNodes));
                        if ($elem->isRawText()) {
                                $this->parser->getLexer()->popState();
                        }

                        [$endText, $endVariable, $endRange] = $this->endName ?? [null, null, null];
                        $this->endName = null;
                        if ($endText && ($this->element->is($endText) || $this->elementData[$this->element]->textualName === $endText)) {
                                $elem->content = $content;
                                $elem->content->append($this->extractIndentation());
                                $elem->end = $endRange ?? $elem->end;

                        } elseif ($outerNodes || $innerNodes
                                || $elem->dynamicTag
                                || $this->parser->strict
                                || $endVariable
                                || $elem->isRawText()
                        ) {
                                $stream->throwUnexpectedException(
                                        addendum: ", expecting </{$this->elementData[$elem]->textualName}> for element started $elem->position",
                                        excerpt: $endText ? "/{$endText}>" : ($stream->tryPeek(1)->text ?? '') . ($stream->tryPeek(2)->text ?? ''),
                                );
                        } else { // element collapsed to tags
                                $res->append($content);
                                $this->element = $elem->parent;
                                if ($this->element && !$stream->is(Token::Html_TagOpen)) {
                                        $this->elementData[$this->element]->unclosedTags[] = $elem->name;
                                }
                                return $res;
                        }
                }

                if ($token = $stream->tryConsume(Token::Newline)) {
                        $res->append(new Nodes\TextNode($token->text, $token->position, $token->end));
                }

                $res = $this->finishNAttrNodes($res, $outerNodes);
                $this->element = $elem->parent;
                return $res;
        }


        private function extractIndentation(): AreaNode
        {
                if ($this->parser->lastIndentation) {
                        $dolly = clone $this->parser->lastIndentation;
                        $this->parser->lastIndentation->clear();
                        return $dolly;
                } else {
                        return new Nodes\NopNode;
                }
        }


        /** @param-out Html\ElementNode $elem */
        private function parseStartTag(&$elem = null): Html\ElementNode
        {
                $stream = $this->parser->getStream();
                $lexer = $this->parser->getLexer();
                $openToken = $stream->consume(Token::Html_TagOpen);
                $lexer->pushState(TemplateLexer::StateHtmlTag);

                [$textual, $variable] = $this->parseTagName($this->parser->strict);
                if (($this->parser->strict || $variable)
                        && !$stream->is(Token::Whitespace, Token::Slash, Token::Html_TagClose)
                ) {
                        $stream->throwUnexpectedException();
                }

                $this->parser->lastIndentation = null;
                $this->parser->inHead = false;
                $elem = new Html\ElementNode(
                        name: $variable ? '' : $textual,
                        position: $openToken->position,
                        parent: $this->element,
                        contentType: $this->parser->getContentType(),
                );
                $this->elementData[$elem] = (object) [
                        'tag' => $this->parser->peekTag(),
                        'textualName' => $textual,
                ];
                $elem->attributes = $this->parser->parseFragment($this->inTagResolve(...));
                $elem->selfClosing = (bool) $stream->tryConsume(Token::Slash);
                if ($variable) {
                        $elem->dynamicTag = new Nodes\Html\TagNode($elem, $variable);
                }
                $elem->end = $stream->consume(Token::Html_TagClose)->end;
                $lexer->popState();
                return $elem;
        }


        /** @return array{string, ?Nodes\Php\ExpressionNode, ?Position} */
        private function parseEndTag(): array
        {
                $stream = $this->parser->getStream();
                $lexer = $this->parser->getLexer();
                $stream->consume(Token::Html_TagOpen);
                $lexer->pushState(TemplateLexer::StateHtmlTag);
                $stream->consume(Token::Slash);
                if (isset($this->element->nAttributes['syntax'])) {  // hardcoded
                        $lexer->popSyntax();
                }
                [$text, $variable] = $this->parseTagName();
                $stream->tryConsume(Token::Whitespace);
                $closeToken = $stream->consume(Token::Html_TagClose);
                $lexer->popState();
                return [$text, $variable, $closeToken->end];
        }


        /** @return array{string, ?Nodes\Php\ExpressionNode} */
        private function parseTagName(bool $strict = true): array
        {
                $variable = null;
                $text = '';
                $parts = [];
                $stream = $this->parser->getStream();
                do {
                        if ($stream->is(Token::Latte_TagOpen)) {
                                $save = $stream->getIndex();
                                $statement = $this->parser->parseLatteStatement($this->inTagResolve(...));
                                if (!$statement instanceof Nodes\PrintNode) {
                                        if (!$parts || $strict) {
                                                throw new CompileException('Only expression can be used as a HTML tag name.', $statement?->position);
                                        }
                                        $stream->seek($save);
                                        break;
                                }
                                $parts[] = $statement->expression;
                                $save -= $stream->getIndex();
                                while ($save < 0) {
                                        $text .= $stream->peek($save++)->text;
                                }
                                $variable = true;

                        } elseif ($token = $stream->tryConsume(Token::Html_Name)) {
                                $parts[] = new Latte\Compiler\Nodes\Php\Scalar\StringNode($token->text, $token->position, $token->end);
                                $text .= $token->text;

                        } elseif (!$parts) {
                                $stream->throwUnexpectedException([Token::Html_Name, Token::Latte_TagOpen]);
                        } else {
                                break;
                        }
                } while (true);

                $variable = $variable
                        ? Latte\Compiler\Nodes\Php\Expression\BinaryOpNode::nest('.', ...$parts)
                        : null;
                return [$text, $variable];
        }


        private function parseBogusEndTag(): Html\BogusTagNode
        {
                $stream = $this->parser->getStream();
                $lexer = $this->parser->getLexer();
                $openToken = $stream->consume(Token::Html_TagOpen);
                $lexer->pushState(TemplateLexer::StateHtmlTag);
                $this->parser->lastIndentation = null;
                $this->parser->inHead = false;
                $openDelimiter = $openToken->text . $stream->consume(Token::Slash)->text . $stream->consume(Token::Html_Name)->text;
                $wsToken = $stream->tryConsume(Token::Whitespace);
                $closeToken = $stream->consume(Token::Html_TagClose);
                $node = new Html\BogusTagNode(
                        openDelimiter: $openDelimiter,
                        content: new Nodes\TextNode($wsToken->text ?? '', $wsToken?->position, $wsToken?->end),
                        endDelimiter: $closeToken->text,
                        position: $openToken->position,
                        end: $closeToken->end,
                );
                $lexer->popState();
                return $node;
        }


        private function parseBogusTag(): Html\BogusTagNode
        {
                $stream = $this->parser->getStream();
                $lexer = $this->parser->getLexer();
                $openToken = $stream->consume(Token::Html_BogusOpen);
                $lexer->pushState(TemplateLexer::StateHtmlBogus);
                $this->parser->lastIndentation = null;
                $this->parser->inHead = false;
                $content = $this->parser->parseFragment($this->parser->inTextResolve(...));
                $lexer->popState();
                $closeToken = $stream->consume(Token::Html_TagClose);
                return new Html\BogusTagNode(
                        openDelimiter: $openToken->text,
                        content: $content,
                        endDelimiter: $closeToken->text,
                        position: $openToken->position,
                        end: $closeToken->end,
                );
        }


        private function resolveVoidness(Html\ElementNode $elem): bool
        {
                if ($elem->contentType !== ContentType::Html) {
                        return $elem->selfClosing;
                } elseif (Latte\Runtime\HtmlHelpers::isVoidElement($elem->name)) {
                        return true;
                } elseif ($elem->selfClosing) { // auto-correct
                        $elem->content = new Nodes\NopNode;
                        $elem->selfClosing = false;
                        $last = end($elem->attributes->children);
                        if ($last instanceof Nodes\TextNode && $last->isWhitespace()) {
                                array_pop($elem->attributes->children);
                        }
                        return true;
                }

                return $elem->selfClosing;
        }


        private function parseAttributeWhitespace(): Node
        {
                $stream = $this->parser->getStream();
                $token = $stream->consume(Token::Whitespace);
                return $stream->is(Token::Html_Name) && str_starts_with($stream->peek()->text, TemplateLexer::NPrefix)
                        ? new Nodes\NopNode
                        : new Nodes\TextNode($token->text, $token->position, $token->end);
        }


        private function parseAttribute(FragmentNode $fragment): ?Node
        {
                $stream = $this->parser->getStream();
                if ($stream->is(Token::Latte_TagOpen)) {
                        $name = $this->parser->parseLatteStatement();
                        if (!$name instanceof Nodes\PrintNode) {
                                return $name; // value like '<span {if true}attr1=val{/if}>'
                        }
                } else {
                        $name = $this->parser->parseText();
                }

                [$value, $quote] = $this->parseAttributeValue() ?? [null, null];
                $attrEnd = $this->parser->getStream()->peek(-1)->end;
                if ($name instanceof Nodes\TextNode && $value instanceof Nodes\PrintNode && $value->modifier->escape) {
                        if (($indent = end($fragment->children)) instanceof Nodes\TextNode && $indent->isWhitespace()) {
                                array_pop($fragment->children);
                        }
                        $value->modifier->escape = false;
                        return new Html\ExpressionAttributeNode(
                                name: $name->content,
                                value: $value->expression,
                                modifier: $value->modifier,
                                indentation: $indent->content ?? null,
                                position: $name->position,
                                end: $attrEnd,
                        );
                }

                return new Html\AttributeNode(
                        name: $name,
                        value: $value,
                        quote: $quote,
                        position: $name->position,
                        end: $attrEnd,
                );
        }


        /** @return ?array{AreaNode|Nodes\PrintNode, ?string} */
        private function parseAttributeValue(): ?array
        {
                $stream = $this->parser->getStream();
                $save = $stream->getIndex();
                $this->consumeIgnored();
                if (!$stream->tryConsume(Token::Equals)) {
                        $stream->seek($save);
                        return null;
                }

                $this->consumeIgnored();
                if ($quoteToken = $stream->tryConsume(Token::Quote)) {
                        $lexer = $this->parser->getLexer();
                        $lexer->pushState(TemplateLexer::StateHtmlQuotedValue, $quoteToken->text);
                        $value = $this->parser->parseFragment($this->parser->inTextResolve(...))->simplify(allowsNull: false);
                        assert($value !== null);
                        $stream->tryConsume(Token::Quote) || $stream->throwUnexpectedException([$quoteToken->text], addendum: ", end of HTML attribute started $quoteToken->position");
                        $lexer->popState();
                        return [$value, $quoteToken->text];
                }

                $value = $this->parser->parseFragment(
                        fn() => match ($stream->peek()->type) {
                                Token::Html_Name => $this->parser->parseText(),
                                Token::Latte_TagOpen => $this->parser->parseLatteStatement(),
                                Token::Latte_CommentOpen => $this->parser->parseLatteComment(),
                                default => null,
                        },
                )->simplify() ?? $stream->throwUnexpectedException();
                return [$value, null];
        }


        private function parseNAttribute(): Nodes\TextNode
        {
                assert($this->element !== null);
                $elem = $this->element;
                $stream = $this->parser->getStream();
                $nameToken = $stream->consume(Token::Html_Name);
                $save = $stream->getIndex();
                $pos = $stream->peek()->position;
                $name = substr($nameToken->text, strlen(TemplateLexer::NPrefix));
                if ($this->parser->peekTag() !== $this->elementData[$elem]->tag) {
                        throw new CompileException("Attribute n:$name must not appear inside {tags}", $nameToken->position);

                } elseif (isset($elem->nAttributes[$name])) {
                        throw new CompileException("Found multiple attributes n:$name.", $nameToken->position);
                }

                $this->consumeIgnored();
                $endToken = $nameToken;
                if ($stream->tryConsume(Token::Equals)) {
                        $lexer = $this->parser->getLexer();
                        $this->consumeIgnored();
                        if ($quoteToken = $stream->tryConsume(Token::Quote)) {
                                $lexer->pushState(TemplateLexer::StateHtmlQuotedNAttrValue, $quoteToken->text);
                                $valueToken = $stream->tryConsume(Token::Text);
                                $pos = $stream->peek()->position;
                                $endToken = $stream->tryConsume(Token::Quote) ?? $stream->throwUnexpectedException([$quoteToken->text], addendum: ", end of n:attribute started $quoteToken->position");
                                $lexer->popState();
                                $tokens = $valueToken ? (new TagLexer)->tokenize($valueToken->text, $valueToken->position) : null;

                        } elseif ($openToken = $stream->tryConsume(Token::Latte_TagOpen)) {
                                $lexer->pushState(TemplateLexer::StateLatteContent);
                                $tokens = $this->parser->consumeTag();
                                $endToken = $stream->tryConsume(Token::Latte_TagClose) ?? $stream->throwUnexpectedException([Token::Latte_TagClose], addendum: " started $openToken->position");
                                $lexer->popState();

                        } else {
                                $endToken = $valueToken = $stream->consume(Token::Html_Name);
                                $tokens = (new TagLexer)->tokenize($valueToken->text, $valueToken->position);
                        }
                } else {
                        $stream->seek($save);
                }
                $tokens ??= [new Token(Token::End, '', $pos)];

                $elem->nAttributes[$name] = new Tag(
                        name: preg_replace('~^(inner-|tag-)~', '', $name),
                        tokens: $tokens,
                        position: $nameToken->position,
                        end: $endToken->end,
                        prefix: $this->getPrefix($name),
                        inTag: true,
                        htmlElement: $elem,
                        nAttribute: $node = new Nodes\TextNode(''),
                );
                return $node;
        }


        private function parseComment(): Html\CommentNode
        {
                $lexer = $this->parser->getLexer();
                $this->parser->lastIndentation = null;
                $this->parser->inHead = false;
                $lexer->pushState(TemplateLexer::StateHtmlComment);
                $stream = $this->parser->getStream();
                $openToken = $stream->consume(Token::Html_CommentOpen);
                $node = new Html\CommentNode(
                        position: $openToken->position,
                        content: $this->parser->parseFragment($this->parser->inTextResolve(...)),
                );
                $closeToken = $stream->tryConsume(Token::Html_CommentClose) ?? $stream->throwUnexpectedException([Token::Html_CommentClose], addendum: " started $openToken->position");
                $node->end = $closeToken->end;
                $lexer->popState();
                return $node;
        }


        private function consumeIgnored(): void
        {
                $stream = $this->parser->getStream();
                $lexer = $this->parser->getLexer();
                do {
                        if ($stream->tryConsume(Token::Whitespace)) {
                                continue;
                        }
                        if ($stream->tryConsume(Token::Latte_CommentOpen)) {
                                $lexer->pushState(TemplateLexer::StateLatteComment);
                                $stream->tryConsume(Token::Text);
                                $stream->consume(Token::Latte_CommentClose);
                                $lexer->popState();
                                $stream->tryConsume(Token::Newline);
                                continue;
                        }
                        return;
                } while (true);
        }


        /**
         * @param  array<Tag>  $attrs
         * @return array<string, list<Tag>>
         */
        private function prepareNAttrs(array $attrs, bool $void): array
        {
                $res = [];
                foreach ($this->attrParsers as $name => $foo) {
                        if ($tag = $attrs[$name] ?? null) {
                                $prefix = $this->getPrefix($name);
                                if (!$prefix || !$void) {
                                        $res[$prefix][] = $tag;
                                        unset($attrs[$name]);
                                }
                        }
                }

                if ($attrs) {
                        $hint = Helpers::getSuggestion(array_keys($this->attrParsers), $k = key($attrs));
                        throw new CompileException('Unexpected attribute n:'
                                . ($hint ? "$k, did you mean n:$hint?" : implode(' and n:', array_keys($attrs))), $attrs[$k]->position);
                }

                return $res;
        }


        /**
         * @param  array<Tag>  $toOpen
         * @return array<array{\Generator, Tag}>
         */
        private function openNAttrNodes(array $toOpen): array
        {
                $toClose = [];
                foreach ($toOpen as $tag) {
                        $parser = $this->getAttrParser($tag->name, $tag->position);
                        $this->parser->pushTag($tag);
                        $res = $parser($tag, $this->parser);
                        if ($res instanceof \Generator && $res->valid()) {
                                $toClose[] = [$res, $tag];

                        } elseif ($res instanceof AreaNode) {
                                $this->parser->ensureIsConsumed($tag);
                                $res->position = $tag->position;
                                $res->end ??= $tag->end;
                                $tag->replaceNAttribute($res);
                                $this->parser->popTag();

                        } elseif (!$res) {
                                $this->parser->ensureIsConsumed($tag);
                                $this->parser->popTag();

                        } else {
                                throw new CompileException("Unexpected value returned by {$tag->getNotation()} parser.", $tag->position);
                        }
                }

                return $toClose;
        }


        /** @param  array<array{\Generator, Tag}>  $toClose */
        private function finishNAttrNodes(AreaNode $node, array $toClose): AreaNode
        {
                while ([$gen, $tag] = array_pop($toClose)) {
                        $gen->send([$node, null]);
                        $gen->valid() && throw new \LogicException("Incorrect behavior of {$tag->getNotation()} parser, more yield calls than expected (on line {$tag->position->line})");
                        $node = $gen->getReturn();
                        if (!$node instanceof AreaNode) {
                                throw new CompileException("Unexpected value returned by {$tag->getNotation()} parser.", $tag->position);
                        }

                        $node->position = $tag->position;
                        $node->end ??= $tag->end;
                        $this->parser->ensureIsConsumed($tag);
                        $this->parser->popTag();
                }

                return $node;
        }


        /** @return \Closure(Tag, TemplateParser): (Node|\Generator|void) */
        private function getAttrParser(string $name, Position $pos): \Closure
        {
                if (!isset($this->attrParsers[$name])) {
                        $hint = ($t = Helpers::getSuggestion(array_keys($this->attrParsers), $name))
                                ? ", did you mean n:$t?"
                                : '';
                        throw new CompileException("Unknown n:{$name}{$hint}", $pos);
                } elseif (!$this->parser->isTagAllowed($name)) {
                        throw new SecurityViolationException("Attribute n:$name is not allowed", $pos);
                }
                return $this->attrParsers[$name];
        }


        private function getPrefix(string $name): string
        {
                return match (true) {
                        str_starts_with($name, 'inner-') => Tag::PrefixInner,
                        str_starts_with($name, 'tag-') => Tag::PrefixTag,
                        default => Tag::PrefixNone,
                };
        }
}

nette / latte / 30275971304

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous