vendor/twig/twig/src/Parser.php line 624

  1. <?php
  3. /*
  4.  * This file is part of Twig.
  5.  *
  6.  * (c) Fabien Potencier
  7.  * (c) Armin Ronacher
  8.  *
  9.  * For the full copyright and license information, please view the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace Twig;
  15. use Twig\Error\SyntaxError;
  16. use Twig\ExpressionParser\ExpressionParserInterface;
  17. use Twig\ExpressionParser\ExpressionParsers;
  18. use Twig\ExpressionParser\ExpressionParserType;
  19. use Twig\ExpressionParser\InfixExpressionParserInterface;
  20. use Twig\ExpressionParser\Prefix\LiteralExpressionParser;
  21. use Twig\ExpressionParser\PrefixExpressionParserInterface;
  22. use Twig\Node\BlockNode;
  23. use Twig\Node\BlockReferenceNode;
  24. use Twig\Node\BodyNode;
  25. use Twig\Node\EmptyNode;
  26. use Twig\Node\Expression\AbstractExpression;
  27. use Twig\Node\Expression\Variable\AssignTemplateVariable;
  28. use Twig\Node\Expression\Variable\TemplateVariable;
  29. use Twig\Node\MacroNode;
  30. use Twig\Node\ModuleNode;
  31. use Twig\Node\Node;
  32. use Twig\Node\NodeCaptureInterface;
  33. use Twig\Node\NodeOutputInterface;
  34. use Twig\Node\Nodes;
  35. use Twig\Node\PrintNode;
  36. use Twig\Node\TextNode;
  37. use Twig\TokenParser\TokenParserInterface;
  38. use Twig\Util\ReflectionCallable;
  40. /**
  41.  * @author Fabien Potencier <fabien@symfony.com>
  42.  */
  43. class Parser
  44. {
  45.     private $stack = [];
  46.     private ?\WeakMap $expressionRefs = null;
  47.     private $stream;
  48.     private $parent;
  49.     private $visitors;
  50.     private $expressionParser;
  51.     private $blocks;
  52.     private $blockStack;
  53.     private $macros;
  54.     private $importedSymbols;
  55.     private $traits;
  56.     private $embeddedTemplates = [];
  57.     private $varNameSalt = 0;
  58.     private $ignoreUnknownTwigCallables = false;
  59.     private ExpressionParsers $parsers;
  61.     public function __construct(
  62.         private Environment $env,
  63.     ) {
  64.         $this->parsers = $env->getExpressionParsers();
  65.     }
  67.     public function getEnvironment(): Environment
  68.     {
  69.         return $this->env;
  70.     }
  72.     public function getVarName(): string
  73.     {
  74.         trigger_deprecation('twig/twig', '3.15', 'The "%s()" method is deprecated.', __METHOD__);
  76.         return \sprintf('__internal_parse_%d', $this->varNameSalt++);
  77.     }
  79.     /**
  80.      * @throws SyntaxError
  81.      */
  82.     public function parse(TokenStream $stream, $test = null, bool $dropNeedle = false): ModuleNode
  83.     {
  84.         $vars = get_object_vars($this);
  85.         unset($vars['stack'], $vars['env'], $vars['handlers'], $vars['visitors'], $vars['expressionParser'], $vars['reservedMacroNames'], $vars['varNameSalt']);
  86.         $this->stack[] = $vars;
  88.         // node visitors
  89.         if (null === $this->visitors) {
  90.             $this->visitors = $this->env->getNodeVisitors();
  91.         }
  93.         $this->stream = $stream;
  94.         $this->parent = null;
  95.         $this->blocks = [];
  96.         $this->macros = [];
  97.         $this->traits = [];
  98.         $this->blockStack = [];
  99.         $this->importedSymbols = [[]];
  100.         $this->embeddedTemplates = [];
  101.         $this->expressionRefs = new \WeakMap();
  103.         try {
  104.             $body = $this->subparse($test, $dropNeedle);
  106.             if (null !== $this->parent && null === $body = $this->filterBodyNodes($body)) {
  107.                 $body = new EmptyNode();
  108.             }
  109.         } catch (SyntaxError $e) {
  110.             if (!$e->getSourceContext()) {
  111.                 $e->setSourceContext($this->stream->getSourceContext());
  112.             }
  114.             if (!$e->getTemplateLine()) {
  115.                 $e->setTemplateLine($this->getCurrentToken()->getLine());
  116.             }
  118.             throw $e;
  119.         } finally {
  120.             $this->expressionRefs = null;
  121.         }
  123.         $node = new ModuleNode(
  124.             new BodyNode([$body]),
  125.             $this->parent,
  126.             $this->blocks ? new Nodes($this->blocks) : new EmptyNode(),
  127.             $this->macros ? new Nodes($this->macros) : new EmptyNode(),
  128.             $this->traits ? new Nodes($this->traits) : new EmptyNode(),
  129.             $this->embeddedTemplates ? new Nodes($this->embeddedTemplates) : new EmptyNode(),
  130.             $stream->getSourceContext(),
  131.         );
  133.         $traverser = new NodeTraverser($this->env, $this->visitors);
  135.         /**
  136.          * @var ModuleNode $node
  137.          */
  138.         $node = $traverser->traverse($node);
  140.         // restore previous stack so previous parse() call can resume working
  141.         foreach (array_pop($this->stack) as $key => $val) {
  142.             $this->$key = $val;
  143.         }
  145.         return $node;
  146.     }
  148.     public function shouldIgnoreUnknownTwigCallables(): bool
  149.     {
  150.         return $this->ignoreUnknownTwigCallables;
  151.     }
  153.     public function subparseIgnoreUnknownTwigCallables($test, bool $dropNeedle = false): void
  154.     {
  155.         $previous = $this->ignoreUnknownTwigCallables;
  156.         $this->ignoreUnknownTwigCallables = true;
  157.         try {
  158.             $this->subparse($test, $dropNeedle);
  159.         } finally {
  160.             $this->ignoreUnknownTwigCallables = $previous;
  161.         }
  162.     }
  164.     /**
  165.      * @throws SyntaxError
  166.      */
  167.     public function subparse($test, bool $dropNeedle = false): Node
  168.     {
  169.         $lineno = $this->getCurrentToken()->getLine();
  170.         $rv = [];
  171.         while (!$this->stream->isEOF()) {
  172.             switch (true) {
  173.                 case $this->stream->getCurrent()->test(Token::TEXT_TYPE):
  174.                     $token = $this->stream->next();
  175.                     $rv[] = new TextNode($token->getValue(), $token->getLine());
  176.                     break;
  178.                 case $this->stream->getCurrent()->test(Token::VAR_START_TYPE):
  179.                     $token = $this->stream->next();
  180.                     $expr = $this->parseExpression();
  181.                     $this->stream->expect(Token::VAR_END_TYPE);
  182.                     $rv[] = new PrintNode($expr, $token->getLine());
  183.                     break;
  185.                 case $this->stream->getCurrent()->test(Token::BLOCK_START_TYPE):
  186.                     $this->stream->next();
  187.                     $token = $this->getCurrentToken();
  189.                     if (!$token->test(Token::NAME_TYPE)) {
  190.                         throw new SyntaxError('A block must start with a tag name.', $token->getLine(), $this->stream->getSourceContext());
  191.                     }
  193.                     if (null !== $test && $test($token)) {
  194.                         if ($dropNeedle) {
  195.                             $this->stream->next();
  196.                         }
  198.                         if (1 === \count($rv)) {
  199.                             return $rv[0];
  200.                         }
  202.                         return new Nodes($rv, $lineno);
  203.                     }
  205.                     if (!$subparser = $this->env->getTokenParser($token->getValue())) {
  206.                         if (null !== $test) {
  207.                             $e = new SyntaxError(\sprintf('Unexpected "%s" tag', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());
  209.                             $callable = (new ReflectionCallable(new TwigTest('decision', $test)))->getCallable();
  210.                             if (\is_array($callable) && $callable[0] instanceof TokenParserInterface) {
  211.                                 $e->appendMessage(\sprintf(' (expecting closing tag for the "%s" tag defined near line %s).', $callable[0]->getTag(), $lineno));
  212.                             }
  213.                         } else {
  214.                             $e = new SyntaxError(\sprintf('Unknown "%s" tag.', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());
  215.                             $e->addSuggestions($token->getValue(), array_keys($this->env->getTokenParsers()));
  216.                         }
  218.                         throw $e;
  219.                     }
  221.                     $this->stream->next();
  223.                     $subparser->setParser($this);
  224.                     $node = $subparser->parse($token);
  225.                     if (!$node) {
  226.                         trigger_deprecation('twig/twig', '3.12', 'Returning "null" from "%s" is deprecated and forbidden by "TokenParserInterface".', $subparser::class);
  227.                     } else {
  228.                         $node->setNodeTag($subparser->getTag());
  229.                         $rv[] = $node;
  230.                     }
  231.                     break;
  233.                 default:
  234.                     throw new SyntaxError('The lexer or the parser ended up in an unsupported state.', $this->getCurrentToken()->getLine(), $this->stream->getSourceContext());
  235.             }
  236.         }
  238.         if (1 === \count($rv)) {
  239.             return $rv[0];
  240.         }
  242.         return new Nodes($rv, $lineno);
  243.     }
  245.     public function getBlockStack(): array
  246.     {
  247.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  249.         return $this->blockStack;
  250.     }
  252.     /**
  253.      * @return string|null
  254.      */
  255.     public function peekBlockStack()
  256.     {
  257.         return $this->blockStack[\count($this->blockStack) - 1] ?? null;
  258.     }
  260.     public function popBlockStack(): void
  261.     {
  262.         array_pop($this->blockStack);
  263.     }
  265.     public function pushBlockStack($name): void
  266.     {
  267.         $this->blockStack[] = $name;
  268.     }
  270.     public function hasBlock(string $name): bool
  271.     {
  272.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  274.         return isset($this->blocks[$name]);
  275.     }
  277.     public function getBlock(string $name): Node
  278.     {
  279.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  281.         return $this->blocks[$name];
  282.     }
  284.     public function setBlock(string $name, BlockNode $value): void
  285.     {
  286.         if (isset($this->blocks[$name])) {
  287.             throw new SyntaxError(\sprintf("The block '%s' has already been defined line %d.", $name, $this->blocks[$name]->getTemplateLine()), $this->getCurrentToken()->getLine(), $this->blocks[$name]->getSourceContext());
  288.         }
  290.         $this->blocks[$name] = new BodyNode([$value], [], $value->getTemplateLine());
  291.     }
  293.     public function hasMacro(string $name): bool
  294.     {
  295.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  297.         return isset($this->macros[$name]);
  298.     }
  300.     public function setMacro(string $name, MacroNode $node): void
  301.     {
  302.         $this->macros[$name] = $node;
  303.     }
  305.     public function addTrait($trait): void
  306.     {
  307.         $this->traits[] = $trait;
  308.     }
  310.     public function hasTraits(): bool
  311.     {
  312.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  314.         return \count($this->traits) > 0;
  315.     }
  317.     /**
  318.      * @return void
  319.      */
  320.     public function embedTemplate(ModuleNode $template)
  321.     {
  322.         $template->setIndex(mt_rand());
  324.         $this->embeddedTemplates[] = $template;
  325.     }
  327.     public function addImportedSymbol(string $type, string $alias, ?string $name = null, AbstractExpression|AssignTemplateVariable|null $internalRef = null): void
  328.     {
  329.         if ($internalRef && !$internalRef instanceof AssignTemplateVariable) {
  330.             trigger_deprecation('twig/twig', '3.15', 'Not passing a "%s" instance as an internal reference is deprecated ("%s" given).', __METHOD__, AssignTemplateVariable::class, $internalRef::class);
  332.             $internalRef = new AssignTemplateVariable(new TemplateVariable($internalRef->getAttribute('name'), $internalRef->getTemplateLine()), $internalRef->getAttribute('global'));
  333.         }
  335.         $this->importedSymbols[0][$type][$alias] = ['name' => $name, 'node' => $internalRef];
  336.     }
  338.     /**
  339.      * @return array{name: string, node: AssignTemplateVariable|null}|null
  340.      */
  341.     public function getImportedSymbol(string $type, string $alias)
  342.     {
  343.         // if the symbol does not exist in the current scope (0), try in the main/global scope (last index)
  344.         return $this->importedSymbols[0][$type][$alias] ?? ($this->importedSymbols[\count($this->importedSymbols) - 1][$type][$alias] ?? null);
  345.     }
  347.     public function isMainScope(): bool
  348.     {
  349.         return 1 === \count($this->importedSymbols);
  350.     }
  352.     public function pushLocalScope(): void
  353.     {
  354.         array_unshift($this->importedSymbols, []);
  355.     }
  357.     public function popLocalScope(): void
  358.     {
  359.         array_shift($this->importedSymbols);
  360.     }
  362.     /**
  363.      * @deprecated since Twig 3.21
  364.      */
  365.     public function getExpressionParser(): ExpressionParser
  366.     {
  367.         trigger_deprecation('twig/twig', '3.21', 'Method "%s()" is deprecated, use "parseExpression()" instead.', __METHOD__);
  369.         if (null === $this->expressionParser) {
  370.             $this->expressionParser = new ExpressionParser($this, $this->env);
  371.         }
  373.         return $this->expressionParser;
  374.     }
  376.     public function parseExpression(int $precedence = 0): AbstractExpression
  377.     {
  378.         $token = $this->getCurrentToken();
  379.         if ($token->test(Token::OPERATOR_TYPE) && $ep = $this->parsers->getByName(PrefixExpressionParserInterface::class, $token->getValue())) {
  380.             $this->getStream()->next();
  381.             $expr = $ep->parse($this, $token);
  382.             $this->checkPrecedenceDeprecations($ep, $expr);
  383.         } else {
  384.             $expr = $this->parsers->getByClass(LiteralExpressionParser::class)->parse($this, $token);
  385.         }
  387.         $token = $this->getCurrentToken();
  388.         while ($token->test(Token::OPERATOR_TYPE) && ($ep = $this->parsers->getByName(InfixExpressionParserInterface::class, $token->getValue())) && $ep->getPrecedence() >= $precedence) {
  389.             $this->getStream()->next();
  390.             $expr = $ep->parse($this, $expr, $token);
  391.             $this->checkPrecedenceDeprecations($ep, $expr);
  392.             $token = $this->getCurrentToken();
  393.         }
  395.         return $expr;
  396.     }
  398.     public function getParent(): ?Node
  399.     {
  400.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  402.         return $this->parent;
  403.     }
  405.     /**
  406.      * @return bool
  407.      */
  408.     public function hasInheritance()
  409.     {
  410.         return $this->parent || 0 < \count($this->traits);
  411.     }
  413.     public function setParent(?Node $parent): void
  414.     {
  415.         if (null === $parent) {
  416.             trigger_deprecation('twig/twig', '3.12', 'Passing "null" to "%s()" is deprecated.', __METHOD__);
  417.         }
  419.         if (null !== $this->parent) {
  420.             throw new SyntaxError('Multiple extends tags are forbidden.', $parent->getTemplateLine(), $parent->getSourceContext());
  421.         }
  423.         $this->parent = $parent;
  424.     }
  426.     public function getStream(): TokenStream
  427.     {
  428.         return $this->stream;
  429.     }
  431.     public function getCurrentToken(): Token
  432.     {
  433.         return $this->stream->getCurrent();
  434.     }
  436.     public function getFunction(string $name, int $line): TwigFunction
  437.     {
  438.         try {
  439.             $function = $this->env->getFunction($name);
  440.         } catch (SyntaxError $e) {
  441.             if (!$this->shouldIgnoreUnknownTwigCallables()) {
  442.                 throw $e;
  443.             }
  445.             $function = null;
  446.         }
  448.         if (!$function) {
  449.             if ($this->shouldIgnoreUnknownTwigCallables()) {
  450.                 return new TwigFunction($name, fn () => '');
  451.             }
  452.             $e = new SyntaxError(\sprintf('Unknown "%s" function.', $name), $line, $this->stream->getSourceContext());
  453.             $e->addSuggestions($name, array_keys($this->env->getFunctions()));
  455.             throw $e;
  456.         }
  458.         if ($function->isDeprecated()) {
  459.             $src = $this->stream->getSourceContext();
  460.             $function->triggerDeprecation($src->getPath() ?: $src->getName(), $line);
  461.         }
  463.         return $function;
  464.     }
  466.     public function getFilter(string $name, int $line): TwigFilter
  467.     {
  468.         try {
  469.             $filter = $this->env->getFilter($name);
  470.         } catch (SyntaxError $e) {
  471.             if (!$this->shouldIgnoreUnknownTwigCallables()) {
  472.                 throw $e;
  473.             }
  475.             $filter = null;
  476.         }
  477.         if (!$filter) {
  478.             if ($this->shouldIgnoreUnknownTwigCallables()) {
  479.                 return new TwigFilter($name, fn () => '');
  480.             }
  481.             $e = new SyntaxError(\sprintf('Unknown "%s" filter.', $name), $line, $this->stream->getSourceContext());
  482.             $e->addSuggestions($name, array_keys($this->env->getFilters()));
  484.             throw $e;
  485.         }
  487.         if ($filter->isDeprecated()) {
  488.             $src = $this->stream->getSourceContext();
  489.             $filter->triggerDeprecation($src->getPath() ?: $src->getName(), $line);
  490.         }
  492.         return $filter;
  493.     }
  495.     public function getTest(int $line): TwigTest
  496.     {
  497.         $name = $this->stream->expect(Token::NAME_TYPE)->getValue();
  499.         if ($this->stream->test(Token::NAME_TYPE)) {
  500.             // try 2-words tests
  501.             $name = $name.' '.$this->getCurrentToken()->getValue();
  503.             try {
  504.                 $test = $this->env->getTest($name);
  505.             } catch (SyntaxError $e) {
  506.                 if (!$this->shouldIgnoreUnknownTwigCallables()) {
  507.                     throw $e;
  508.                 }
  510.                 $test = null;
  511.             }
  512.             $this->stream->next();
  513.         } else {
  514.             try {
  515.                 $test = $this->env->getTest($name);
  516.             } catch (SyntaxError $e) {
  517.                 if (!$this->shouldIgnoreUnknownTwigCallables()) {
  518.                     throw $e;
  519.                 }
  521.                 $test = null;
  522.             }
  523.         }
  525.         if (!$test) {
  526.             if ($this->shouldIgnoreUnknownTwigCallables()) {
  527.                 return new TwigTest($name, fn () => '');
  528.             }
  529.             $e = new SyntaxError(\sprintf('Unknown "%s" test.', $name), $line, $this->stream->getSourceContext());
  530.             $e->addSuggestions($name, array_keys($this->env->getTests()));
  532.             throw $e;
  533.         }
  535.         if ($test->isDeprecated()) {
  536.             $src = $this->stream->getSourceContext();
  537.             $test->triggerDeprecation($src->getPath() ?: $src->getName(), $this->stream->getCurrent()->getLine());
  538.         }
  540.         return $test;
  541.     }
  543.     private function filterBodyNodes(Node $node, bool $nested = false): ?Node
  544.     {
  545.         // check that the body does not contain non-empty output nodes
  546.         if (
  547.             ($node instanceof TextNode && !ctype_space($node->getAttribute('data')))
  548.             || (!$node instanceof TextNode && !$node instanceof BlockReferenceNode && $node instanceof NodeOutputInterface)
  549.         ) {
  550.             if (str_contains((string) $node, \chr(0xEF).\chr(0xBB).\chr(0xBF))) {
  551.                 $t = substr($node->getAttribute('data'), 3);
  552.                 if ('' === $t || ctype_space($t)) {
  553.                     // bypass empty nodes starting with a BOM
  554.                     return null;
  555.                 }
  556.             }
  558.             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());
  559.         }
  561.         // bypass nodes that "capture" the output
  562.         if ($node instanceof NodeCaptureInterface) {
  563.             // a "block" tag in such a node will serve as a block definition AND be displayed in place as well
  564.             return $node;
  565.         }
  567.         // "block" tags that are not captured (see above) are only used for defining
  568.         // the content of the block. In such a case, nesting it does not work as
  569.         // expected as the definition is not part of the default template code flow.
  570.         if ($nested && $node instanceof BlockReferenceNode) {
  571.             throw new SyntaxError('A block definition cannot be nested under non-capturing nodes.', $node->getTemplateLine(), $this->stream->getSourceContext());
  572.         }
  574.         if ($node instanceof NodeOutputInterface) {
  575.             return null;
  576.         }
  578.         // here, $nested means "being at the root level of a child template"
  579.         // we need to discard the wrapping "Node" for the "body" node
  580.         // Node::class !== \get_class($node) should be removed in Twig 4.0
  581.         $nested = $nested || (Node::class !== $node::class && !$node instanceof Nodes);
  582.         foreach ($node as $k => $n) {
  583.             if (null !== $n && null === $this->filterBodyNodes($n, $nested)) {
  584.                 $node->removeNode($k);
  585.             }
  586.         }
  588.         return $node;
  589.     }
  591.     private function checkPrecedenceDeprecations(ExpressionParserInterface $expressionParser, AbstractExpression $expr)
  592.     {
  593.         $this->expressionRefs[$expr] = $expressionParser;
  594.         $precedenceChanges = $this->parsers->getPrecedenceChanges();
  596.         // Check that the all nodes that are between the 2 precedences have explicit parentheses
  597.         if (!isset($precedenceChanges[$expressionParser])) {
  598.             return;
  599.         }
  601.         if ($expr->hasExplicitParentheses()) {
  602.             return;
  603.         }
  605.         if ($expressionParser instanceof PrefixExpressionParserInterface) {
  606.             /** @var AbstractExpression $node */
  607.             $node = $expr->getNode('node');
  608.             foreach ($precedenceChanges as $ep => $changes) {
  609.                 if (!\in_array($expressionParser, $changes, true)) {
  610.                     continue;
  611.                 }
  612.                 if (isset($this->expressionRefs[$node]) && $ep === $this->expressionRefs[$node]) {
  613.                     $change = $expressionParser->getPrecedenceChange();
  614.                     trigger_deprecation($change->getPackage(), $change->getVersion(), \sprintf('As the "%s" %s operator will change its precedence in the next major version, add explicit parentheses to avoid behavior change in "%s" at line %d.', $expressionParser->getName(), ExpressionParserType::getType($expressionParser)->value, $this->getStream()->getSourceContext()->getName(), $node->getTemplateLine()));
  615.                 }
  616.             }
  617.         }
  619.         foreach ($precedenceChanges[$expressionParser] as $ep) {
  620.             foreach ($expr as $node) {
  621.                 /** @var AbstractExpression $node */
  622.                 if (isset($this->expressionRefs[$node]) && $ep === $this->expressionRefs[$node] && !$node->hasExplicitParentheses()) {
  623.                     $change = $ep->getPrecedenceChange();
  624.                     trigger_deprecation($change->getPackage(), $change->getVersion(), \sprintf('As the "%s" %s operator will change its precedence in the next major version, add explicit parentheses to avoid behavior change in "%s" at line %d.', $ep->getName(), ExpressionParserType::getType($ep)->value, $this->getStream()->getSourceContext()->getName(), $node->getTemplateLine()));
  625.                 }
  626.             }
  627.         }
  628.     }
  629. }