nystudio107 / craft-templatecomments

src/web/twig/TemplateCommentsParser.php

<?php
/**
 * Template Comments plugin for Craft CMS
 *
 * Adds a HTML comment to demarcate each Twig template that is included or extended.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c)  nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

/**
 * This is a wholesale copy pasta of the Twig Parser class; with one modification so that it
 * does not throw a "A block definition cannot be nested under non-capturing nodes" SyntaxError exception
 *
 * This exception is explained in detail here: https://github.com/twigphp/Twig/issues/3926
 *
 * So that Template Comments can add HTML comments that indicate any {% include %} or {% extends %} templates
 * with execution timing, it uses its own CommentTemplateLoader which wraps the loaded template
 * with {% comments 'templateName' %}<loaded-template>{% endcomments %}
 *
 * There is a corresponding CommentsTokenParser that takes care of parsing the {% comments %} tags
 *
 * This worked in Twig 1.x and 2.x, but they added a check for block definitions nested under non-capturing
 * blocks in Twig 3.x, which causes it to throw an exception in that case. So if you end up with something like:
 *
 * {% comments 'index' %}
 *     {% block conent %}
 *     {% endblock %}
 * {% encomments %}
 *
 * ...the SyntaxError exception will be thrown.
 *
 * I tried adding implements NodeCaptureInterface to the CommentsNode but that resulted in the Parser returning
 * the node, causing duplicate rendering for every {% include %} or {% extends %} that was wrapped in a
 * {% comments %} tag
 *
 * We can't just subclass the Parser class, because the properties and methods are private
 *
 * So here we are.
 *
 * Don't judge me
 */

namespace nystudio107\templatecomments\web\twig;

use Twig\Environment;
use Twig\Error\SyntaxError;
use Twig\ExpressionParser;
use Twig\Node\BlockNode;
use Twig\Node\BlockReferenceNode;
use Twig\Node\BodyNode;
use Twig\Node\Expression\AbstractExpression;
use Twig\Node\MacroNode;
use Twig\Node\ModuleNode;
use Twig\Node\Node;
use Twig\Node\NodeCaptureInterface;
use Twig\Node\NodeOutputInterface;
use Twig\Node\PrintNode;
use Twig\Node\TextNode;
use Twig\NodeTraverser;
use Twig\Parser;
use Twig\Token;
use Twig\TokenParser\TokenParserInterface;
use Twig\TokenStream;
use function chr;
use function count;
use function get_class;
use function is_array;

/**

Missing short description in doc comment

 * @author Fabien Potencier <fabien@symfony.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class TemplateCommentsParser extends Parser
{
    private $stack = [];

Private member variable "stack" must be prefixed with an underscore

    private $stream;

Private member variable "stream" must be prefixed with an underscore

    private $parent;

Private member variable "parent" must be prefixed with an underscore

    private $visitors;

Private member variable "visitors" must be prefixed with an underscore

    private $expressionParser;

Private member variable "expressionParser" must be prefixed with an underscore

    private $blocks;

Private member variable "blocks" must be prefixed with an underscore

    private $blockStack;

Private member variable "blockStack" must be prefixed with an underscore

    private $macros;

Private member variable "macros" must be prefixed with an underscore

    private $env;

Private member variable "env" must be prefixed with an underscore

    private $importedSymbols;

Private member variable "importedSymbols" must be prefixed with an underscore

    private $traits;

Private member variable "traits" must be prefixed with an underscore

    private $embeddedTemplates = [];

Private member variable "embeddedTemplates" must be prefixed with an underscore

    private $varNameSalt = 0;

Private member variable "varNameSalt" must be prefixed with an underscore

    public function __construct(Environment $env)

Missing doc comment for function __construct()

    {
        $this->env = $env;
    }

    public function getVarName(): string

Missing doc comment for function getVarName()

    {
        return sprintf('__internal_parse_%d', $this->varNameSalt++);
    }

    public function parse(TokenStream $stream, $test = null, bool $dropNeedle = false): ModuleNode

Missing doc comment for function parse()

    {
        $vars = get_object_vars($this);
        unset($vars['stack'], $vars['env'], $vars['handlers'], $vars['visitors'], $vars['expressionParser'], $vars['reservedMacroNames'], $vars['varNameSalt']);
        $this->stack[] = $vars;

        // node visitors
        if (null === $this->visitors) {
            $this->visitors = $this->env->getNodeVisitors();
        }

        if (null === $this->expressionParser) {
            $this->expressionParser = new ExpressionParser($this, $this->env);
        }

        $this->stream = $stream;
        $this->parent = null;
        $this->blocks = [];
        $this->macros = [];
        $this->traits = [];
        $this->blockStack = [];
        $this->importedSymbols = [[]];
        $this->embeddedTemplates = [];

        try {
            $body = $this->subparse($test, $dropNeedle);

            if (null !== $this->parent && null === $body = $this->filterBodyNodes($body)) {
                $body = new Node();
            }
        } catch (SyntaxError $e) {
            if (!$e->getSourceContext()) {
                $e->setSourceContext($this->stream->getSourceContext());
            }

            if (!$e->getTemplateLine()) {
                $e->setTemplateLine($this->stream->getCurrent()->getLine());
            }

            throw $e;
        }

        $node = new ModuleNode(new BodyNode([$body]), $this->parent, new Node($this->blocks), new Node($this->macros), new Node($this->traits), $this->embeddedTemplates, $stream->getSourceContext());

        $traverser = new NodeTraverser($this->env, $this->visitors);

        /** @var ModuleNode $node */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $node = $traverser->traverse($node);

        // restore previous stack so previous parse() call can resume working
        foreach (array_pop($this->stack) as $key => $val) {
            $this->$key = $val;
        }

        return $node;
    }

    public function subparse($test, bool $dropNeedle = false): Node

Missing doc comment for function subparse()

    {
        $lineno = $this->getCurrentToken()->getLine();
        $rv = [];
        while (!$this->stream->isEOF()) {
            switch ($this->getCurrentToken()->getType()) {
                case /* Token::TEXT_TYPE */ 0:

Line indented incorrectly; expected 12 spaces, found 16

                    $token = $this->stream->next();
                    $rv[] = new TextNode($token->getValue(), $token->getLine());
                    break;

                case /* Token::VAR_START_TYPE */ 2:

Line indented incorrectly; expected 12 spaces, found 16

                    $token = $this->stream->next();
                    $expr = $this->expressionParser->parseExpression();
                    $this->stream->expect(/* Token::VAR_END_TYPE */ 4);
                    $rv[] = new PrintNode($expr, $token->getLine());
                    break;

                case /* Token::BLOCK_START_TYPE */ 1:

Line indented incorrectly; expected 12 spaces, found 16

                    $this->stream->next();
                    $token = $this->getCurrentToken();

                    if (/* Token::NAME_TYPE */ 5 !== $token->getType()) {

Line indented incorrectly; expected 16 spaces, found 20

                        throw new SyntaxError('A block must start with a tag name.', $token->getLine(), $this->stream->getSourceContext());
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    if (null !== $test && $test($token)) {

Line indented incorrectly; expected 16 spaces, found 20

                        if ($dropNeedle) {

Line indented incorrectly; expected 20 spaces, found 24

                            $this->stream->next();
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        if (1 === count($rv)) {

Line indented incorrectly; expected 20 spaces, found 24

                            return $rv[0];
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        return new Node($rv, [], $lineno);
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    if (!$subparser = $this->env->getTokenParser($token->getValue())) {

Line indented incorrectly; expected 16 spaces, found 20

                        if (null !== $test) {

Line indented incorrectly; expected 20 spaces, found 24

                            $e = new SyntaxError(sprintf('Unexpected "%s" tag', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());

                            if (is_array($test) && isset($test[0]) && $test[0] instanceof TokenParserInterface) {

Line indented incorrectly; expected 24 spaces, found 28

                                $e->appendMessage(sprintf(' (expecting closing tag for the "%s" tag defined near line %s).', $test[0]->getTag(), $lineno));
                            }

Line indented incorrectly; expected 24 spaces, found 28

                        } else {

Line indented incorrectly; expected 20 spaces, found 24

                            $e = new SyntaxError(sprintf('Unknown "%s" tag.', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());
                            $e->addSuggestions($token->getValue(), array_keys($this->env->getTokenParsers()));
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        throw $e;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    $this->stream->next();

                    $subparser->setParser($this);
                    $node = $subparser->parse($token);
                    if (null !== $node) {

Line indented incorrectly; expected 16 spaces, found 20

                        $rv[] = $node;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;

                default:

Line indented incorrectly; expected 12 spaces, found 16

                    throw new SyntaxError('Lexer or parser ended up in unsupported state.', $this->getCurrentToken()->getLine(), $this->stream->getSourceContext());
            }
        }

        if (1 === count($rv)) {
            return $rv[0];
        }

        return new Node($rv, [], $lineno);
    }

    public function getBlockStack(): array

Missing doc comment for function getBlockStack()

    {
        return $this->blockStack;
    }

    public function peekBlockStack()

Missing doc comment for function peekBlockStack()

    {
        return $this->blockStack[count($this->blockStack) - 1] ?? null;
    }

    public function popBlockStack(): void

Missing doc comment for function popBlockStack()

    {
        array_pop($this->blockStack);
    }

    public function pushBlockStack($name): void

Missing doc comment for function pushBlockStack()

    {
        $this->blockStack[] = $name;
    }

    public function hasBlock(string $name): bool

Missing doc comment for function hasBlock()

    {
        return isset($this->blocks[$name]);
    }

    public function getBlock(string $name): Node

Missing doc comment for function getBlock()

    {
        return $this->blocks[$name];
    }

    public function setBlock(string $name, BlockNode $value): void

Missing doc comment for function setBlock()

    {
        $this->blocks[$name] = new BodyNode([$value], [], $value->getTemplateLine());
    }

    public function hasMacro(string $name): bool

Missing doc comment for function hasMacro()

    {
        return isset($this->macros[$name]);
    }

    public function setMacro(string $name, MacroNode $node): void

Missing doc comment for function setMacro()

    {
        $this->macros[$name] = $node;
    }

    public function addTrait($trait): void

Missing doc comment for function addTrait()

    {
        $this->traits[] = $trait;
    }

    public function hasTraits(): bool

Missing doc comment for function hasTraits()

    {
        return count($this->traits) > 0;
    }

    public function embedTemplate(ModuleNode $template)

Missing doc comment for function embedTemplate()

    {
        $template->setIndex(mt_rand());

        $this->embeddedTemplates[] = $template;
    }

    public function addImportedSymbol(string $type, string $alias, string $name = null, AbstractExpression $node = null): void

Missing doc comment for function addImportedSymbol()

    {
        $this->importedSymbols[0][$type][$alias] = ['name' => $name, 'node' => $node];
    }

    public function getImportedSymbol(string $type, string $alias)

Missing doc comment for function getImportedSymbol()

    {
        // if the symbol does not exist in the current scope (0), try in the main/global scope (last index)
        return $this->importedSymbols[0][$type][$alias] ?? ($this->importedSymbols[count($this->importedSymbols) - 1][$type][$alias] ?? null);
    }

    public function isMainScope(): bool

Missing doc comment for function isMainScope()

    {
        return 1 === count($this->importedSymbols);
    }

    public function pushLocalScope(): void

Missing doc comment for function pushLocalScope()

    {
        array_unshift($this->importedSymbols, []);
    }

    public function popLocalScope(): void

Missing doc comment for function popLocalScope()

    {
        array_shift($this->importedSymbols);
    }

    public function getExpressionParser(): ExpressionParser

Missing doc comment for function getExpressionParser()

    {
        return $this->expressionParser;
    }

    public function getParent(): ?Node

Missing doc comment for function getParent()

    {
        return $this->parent;
    }

    public function setParent(?Node $parent): void

Missing doc comment for function setParent()

    {
        $this->parent = $parent;
    }

    public function getStream(): TokenStream

Missing doc comment for function getStream()

    {
        return $this->stream;
    }

    public function getCurrentToken(): Token

Missing doc comment for function getCurrentToken()

    {
        return $this->stream->getCurrent();
    }

    private function filterBodyNodes(Node $node, bool $nested = false): ?Node

Missing doc comment for function filterBodyNodes()

Private method name "TemplateCommentsParser::filterBodyNodes" must be prefixed with an underscore

    {
        // check that the body does not contain non-empty output nodes
        if (

First condition of a multi-line IF statement must directly follow the opening parenthesis

            ($node instanceof TextNode && !ctype_space($node->getAttribute('data')))

Each line in a multi-line IF statement must begin with a boolean operator

            || (!$node instanceof TextNode && !$node instanceof BlockReferenceNode && $node instanceof NodeOutputInterface)
        ) {
            if (str_contains((string)$node, chr(0xEF) . chr(0xBB) . chr(0xBF))) {
                $t = substr($node->getAttribute('data'), 3);
                if ('' === $t || ctype_space($t)) {
                    // bypass empty nodes starting with a BOM
                    return null;
                }
            }

            throw new SyntaxError('A template that extends another one cannot include content outside Twig blocks. Did you forget to put the content inside a {% block %} tag?', $node->getTemplateLine(), $this->stream->getSourceContext());
        }

        // bypass nodes that "capture" the output
        if ($node instanceof NodeCaptureInterface) {
            // a "block" tag in such a node will serve as a block definition AND be displayed in place as well
            return $node;
        }

        /**
         * We intentionally skip this check to avoid throwing an exception, so our {% comments %} tag can
         * render correctly
         * // "block" tags that are not captured (see above) are only used for defining
         * // the content of the block. In such a case, nesting it does not work as
         * // expected as the definition is not part of the default template code flow.
         * if ($nested && $node instanceof BlockReferenceNode) {
         * throw new SyntaxError('A block definition cannot be nested under non-capturing nodes.', $node->getTemplateLine(), $this->stream->getSourceContext());
         * }
         */
        if ($node instanceof NodeOutputInterface) {
            return null;
        }

        // here, $nested means "being at the root level of a child template"
        // we need to discard the wrapping "Node" for the "body" node
        $nested = $nested || Node::class !== get_class($node);
        foreach ($node as $k => $n) {
            if (null !== $n && null === $this->filterBodyNodes($n, $nested)) {
                $node->removeNode($k);
            }
        }

        return $node;
    }
}