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

Open in your IDE?
  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.     public function parse(TokenStream $stream, $test = null, bool $dropNeedle = false): ModuleNode
  80.     {
  81.         $vars = get_object_vars($this);
  82.         unset($vars['stack'], $vars['env'], $vars['handlers'], $vars['visitors'], $vars['expressionParser'], $vars['reservedMacroNames'], $vars['varNameSalt']);
  83.         $this->stack[] = $vars;
  85.         // node visitors
  86.         if (null === $this->visitors) {
  87.             $this->visitors = $this->env->getNodeVisitors();
  88.         }
  90.         $this->stream = $stream;
  91.         $this->parent = null;
  92.         $this->blocks = [];
  93.         $this->macros = [];
  94.         $this->traits = [];
  95.         $this->blockStack = [];
  96.         $this->importedSymbols = [[]];
  97.         $this->embeddedTemplates = [];
  98.         $this->expressionRefs = new \WeakMap();
  100.         try {
  101.             $body = $this->subparse($test, $dropNeedle);
  103.             if (null !== $this->parent && null === $body = $this->filterBodyNodes($body)) {
  104.                 $body = new EmptyNode();
  105.             }
  106.         } catch (SyntaxError $e) {
  107.             if (!$e->getSourceContext()) {
  108.                 $e->setSourceContext($this->stream->getSourceContext());
  109.             }
  111.             if (!$e->getTemplateLine()) {
  112.                 $e->setTemplateLine($this->getCurrentToken()->getLine());
  113.             }
  115.             throw $e;
  116.         } finally {
  117.             $this->expressionRefs = null;
  118.         }
  120.         $node = new ModuleNode(
  121.             new BodyNode([$body]),
  122.             $this->parent,
  123.             $this->blocks ? new Nodes($this->blocks) : new EmptyNode(),
  124.             $this->macros ? new Nodes($this->macros) : new EmptyNode(),
  125.             $this->traits ? new Nodes($this->traits) : new EmptyNode(),
  126.             $this->embeddedTemplates ? new Nodes($this->embeddedTemplates) : new EmptyNode(),
  127.             $stream->getSourceContext(),
  128.         );
  130.         $traverser = new NodeTraverser($this->env, $this->visitors);
  132.         /**
  133.          * @var ModuleNode $node
  134.          */
  135.         $node = $traverser->traverse($node);
  137.         // restore previous stack so previous parse() call can resume working
  138.         foreach (array_pop($this->stack) as $key => $val) {
  139.             $this->$key = $val;
  140.         }
  142.         return $node;
  143.     }
  145.     public function shouldIgnoreUnknownTwigCallables(): bool
  146.     {
  147.         return $this->ignoreUnknownTwigCallables;
  148.     }
  150.     public function subparseIgnoreUnknownTwigCallables($test, bool $dropNeedle = false): void
  151.     {
  152.         $previous = $this->ignoreUnknownTwigCallables;
  153.         $this->ignoreUnknownTwigCallables = true;
  154.         try {
  155.             $this->subparse($test, $dropNeedle);
  156.         } finally {
  157.             $this->ignoreUnknownTwigCallables = $previous;
  158.         }
  159.     }
  161.     public function subparse($test, bool $dropNeedle = false): Node
  162.     {
  163.         $lineno = $this->getCurrentToken()->getLine();
  164.         $rv = [];
  165.         while (!$this->stream->isEOF()) {
  166.             switch (true) {
  167.                 case $this->stream->getCurrent()->test(Token::TEXT_TYPE):
  168.                     $token = $this->stream->next();
  169.                     $rv[] = new TextNode($token->getValue(), $token->getLine());
  170.                     break;
  172.                 case $this->stream->getCurrent()->test(Token::VAR_START_TYPE):
  173.                     $token = $this->stream->next();
  174.                     $expr = $this->parseExpression();
  175.                     $this->stream->expect(Token::VAR_END_TYPE);
  176.                     $rv[] = new PrintNode($expr, $token->getLine());
  177.                     break;
  179.                 case $this->stream->getCurrent()->test(Token::BLOCK_START_TYPE):
  180.                     $this->stream->next();
  181.                     $token = $this->getCurrentToken();
  183.                     if (!$token->test(Token::NAME_TYPE)) {
  184.                         throw new SyntaxError('A block must start with a tag name.', $token->getLine(), $this->stream->getSourceContext());
  185.                     }
  187.                     if (null !== $test && $test($token)) {
  188.                         if ($dropNeedle) {
  189.                             $this->stream->next();
  190.                         }
  192.                         if (1 === \count($rv)) {
  193.                             return $rv[0];
  194.                         }
  196.                         return new Nodes($rv, $lineno);
  197.                     }
  199.                     if (!$subparser = $this->env->getTokenParser($token->getValue())) {
  200.                         if (null !== $test) {
  201.                             $e = new SyntaxError(\sprintf('Unexpected "%s" tag', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());
  203.                             $callable = (new ReflectionCallable(new TwigTest('decision', $test)))->getCallable();
  204.                             if (\is_array($callable) && $callable[0] instanceof TokenParserInterface) {
  205.                                 $e->appendMessage(\sprintf(' (expecting closing tag for the "%s" tag defined near line %s).', $callable[0]->getTag(), $lineno));
  206.                             }
  207.                         } else {
  208.                             $e = new SyntaxError(\sprintf('Unknown "%s" tag.', $token->getValue()), $token->getLine(), $this->stream->getSourceContext());
  209.                             $e->addSuggestions($token->getValue(), array_keys($this->env->getTokenParsers()));
  210.                         }
  212.                         throw $e;
  213.                     }
  215.                     $this->stream->next();
  217.                     $subparser->setParser($this);
  218.                     $node = $subparser->parse($token);
  219.                     if (!$node) {
  220.                         trigger_deprecation('twig/twig', '3.12', 'Returning "null" from "%s" is deprecated and forbidden by "TokenParserInterface".', $subparser::class);
  221.                     } else {
  222.                         $node->setNodeTag($subparser->getTag());
  223.                         $rv[] = $node;
  224.                     }
  225.                     break;
  227.                 default:
  228.                     throw new SyntaxError('The lexer or the parser ended up in an unsupported state.', $this->getCurrentToken()->getLine(), $this->stream->getSourceContext());
  229.             }
  230.         }
  232.         if (1 === \count($rv)) {
  233.             return $rv[0];
  234.         }
  236.         return new Nodes($rv, $lineno);
  237.     }
  239.     public function getBlockStack(): array
  240.     {
  241.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  243.         return $this->blockStack;
  244.     }
  246.     /**
  247.      * @return string|null
  248.      */
  249.     public function peekBlockStack()
  250.     {
  251.         return $this->blockStack[\count($this->blockStack) - 1] ?? null;
  252.     }
  254.     public function popBlockStack(): void
  255.     {
  256.         array_pop($this->blockStack);
  257.     }
  259.     public function pushBlockStack($name): void
  260.     {
  261.         $this->blockStack[] = $name;
  262.     }
  264.     public function hasBlock(string $name): bool
  265.     {
  266.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  268.         return isset($this->blocks[$name]);
  269.     }
  271.     public function getBlock(string $name): Node
  272.     {
  273.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  275.         return $this->blocks[$name];
  276.     }
  278.     public function setBlock(string $name, BlockNode $value): void
  279.     {
  280.         if (isset($this->blocks[$name])) {
  281.             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());
  282.         }
  284.         $this->blocks[$name] = new BodyNode([$value], [], $value->getTemplateLine());
  285.     }
  287.     public function hasMacro(string $name): bool
  288.     {
  289.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  291.         return isset($this->macros[$name]);
  292.     }
  294.     public function setMacro(string $name, MacroNode $node): void
  295.     {
  296.         $this->macros[$name] = $node;
  297.     }
  299.     public function addTrait($trait): void
  300.     {
  301.         $this->traits[] = $trait;
  302.     }
  304.     public function hasTraits(): bool
  305.     {
  306.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  308.         return \count($this->traits) > 0;
  309.     }
  311.     /**
  312.      * @return void
  313.      */
  314.     public function embedTemplate(ModuleNode $template)
  315.     {
  316.         $template->setIndex(mt_rand());
  318.         $this->embeddedTemplates[] = $template;
  319.     }
  321.     public function addImportedSymbol(string $type, string $alias, ?string $name = null, AbstractExpression|AssignTemplateVariable|null $internalRef = null): void
  322.     {
  323.         if ($internalRef && !$internalRef instanceof AssignTemplateVariable) {
  324.             trigger_deprecation('twig/twig', '3.15', 'Not passing a "%s" instance as an internal reference is deprecated ("%s" given).', __METHOD__, AssignTemplateVariable::class, $internalRef::class);
  326.             $internalRef = new AssignTemplateVariable(new TemplateVariable($internalRef->getAttribute('name'), $internalRef->getTemplateLine()), $internalRef->getAttribute('global'));
  327.         }
  329.         $this->importedSymbols[0][$type][$alias] = ['name' => $name, 'node' => $internalRef];
  330.     }
  332.     /**
  333.      * @return array{name: string, node: AssignTemplateVariable|null}|null
  334.      */
  335.     public function getImportedSymbol(string $type, string $alias)
  336.     {
  337.         // if the symbol does not exist in the current scope (0), try in the main/global scope (last index)
  338.         return $this->importedSymbols[0][$type][$alias] ?? ($this->importedSymbols[\count($this->importedSymbols) - 1][$type][$alias] ?? null);
  339.     }
  341.     public function isMainScope(): bool
  342.     {
  343.         return 1 === \count($this->importedSymbols);
  344.     }
  346.     public function pushLocalScope(): void
  347.     {
  348.         array_unshift($this->importedSymbols, []);
  349.     }
  351.     public function popLocalScope(): void
  352.     {
  353.         array_shift($this->importedSymbols);
  354.     }
  356.     /**
  357.      * @deprecated since Twig 3.21
  358.      */
  359.     public function getExpressionParser(): ExpressionParser
  360.     {
  361.         trigger_deprecation('twig/twig', '3.21', 'Method "%s()" is deprecated, use "parseExpression()" instead.', __METHOD__);
  363.         if (null === $this->expressionParser) {
  364.             $this->expressionParser = new ExpressionParser($this, $this->env);
  365.         }
  367.         return $this->expressionParser;
  368.     }
  370.     public function parseExpression(int $precedence = 0): AbstractExpression
  371.     {
  372.         $token = $this->getCurrentToken();
  373.         if ($token->test(Token::OPERATOR_TYPE) && $ep = $this->parsers->getByName(PrefixExpressionParserInterface::class, $token->getValue())) {
  374.             $this->getStream()->next();
  375.             $expr = $ep->parse($this, $token);
  376.             $this->checkPrecedenceDeprecations($ep, $expr);
  377.         } else {
  378.             $expr = $this->parsers->getByClass(LiteralExpressionParser::class)->parse($this, $token);
  379.         }
  381.         $token = $this->getCurrentToken();
  382.         while ($token->test(Token::OPERATOR_TYPE) && ($ep = $this->parsers->getByName(InfixExpressionParserInterface::class, $token->getValue())) && $ep->getPrecedence() >= $precedence) {
  383.             $this->getStream()->next();
  384.             $expr = $ep->parse($this, $expr, $token);
  385.             $this->checkPrecedenceDeprecations($ep, $expr);
  386.             $token = $this->getCurrentToken();
  387.         }
  389.         return $expr;
  390.     }
  392.     public function getParent(): ?Node
  393.     {
  394.         trigger_deprecation('twig/twig', '3.12', 'Method "%s()" is deprecated.', __METHOD__);
  396.         return $this->parent;
  397.     }
  399.     /**
  400.      * @return bool
  401.      */
  402.     public function hasInheritance()
  403.     {
  404.         return $this->parent || 0 < \count($this->traits);
  405.     }
  407.     public function setParent(?Node $parent): void
  408.     {
  409.         if (null === $parent) {
  410.             trigger_deprecation('twig/twig', '3.12', 'Passing "null" to "%s()" is deprecated.', __METHOD__);
  411.         }
  413.         if (null !== $this->parent) {
  414.             throw new SyntaxError('Multiple extends tags are forbidden.', $parent->getTemplateLine(), $parent->getSourceContext());
  415.         }
  417.         $this->parent = $parent;
  418.     }
  420.     public function getStream(): TokenStream
  421.     {
  422.         return $this->stream;
  423.     }
  425.     public function getCurrentToken(): Token
  426.     {
  427.         return $this->stream->getCurrent();
  428.     }
  430.     public function getFunction(string $name, int $line): TwigFunction
  431.     {
  432.         try {
  433.             $function = $this->env->getFunction($name);
  434.         } catch (SyntaxError $e) {
  435.             if (!$this->shouldIgnoreUnknownTwigCallables()) {
  436.                 throw $e;
  437.             }
  439.             $function = null;
  440.         }
  442.         if (!$function) {
  443.             if ($this->shouldIgnoreUnknownTwigCallables()) {
  444.                 return new TwigFunction($name, fn () => '');
  445.             }
  446.             $e = new SyntaxError(\sprintf('Unknown "%s" function.', $name), $line, $this->stream->getSourceContext());
  447.             $e->addSuggestions($name, array_keys($this->env->getFunctions()));
  449.             throw $e;
  450.         }
  452.         if ($function->isDeprecated()) {
  453.             $src = $this->stream->getSourceContext();
  454.             $function->triggerDeprecation($src->getPath() ?: $src->getName(), $line);
  455.         }
  457.         return $function;
  458.     }
  460.     public function getFilter(string $name, int $line): TwigFilter
  461.     {
  462.         try {
  463.             $filter = $this->env->getFilter($name);
  464.         } catch (SyntaxError $e) {
  465.             if (!$this->shouldIgnoreUnknownTwigCallables()) {
  466.                 throw $e;
  467.             }
  469.             $filter = null;
  470.         }
  471.         if (!$filter) {
  472.             if ($this->shouldIgnoreUnknownTwigCallables()) {
  473.                 return new TwigFilter($name, fn () => '');
  474.             }
  475.             $e = new SyntaxError(\sprintf('Unknown "%s" filter.', $name), $line, $this->stream->getSourceContext());
  476.             $e->addSuggestions($name, array_keys($this->env->getFilters()));
  478.             throw $e;
  479.         }
  481.         if ($filter->isDeprecated()) {
  482.             $src = $this->stream->getSourceContext();
  483.             $filter->triggerDeprecation($src->getPath() ?: $src->getName(), $line);
  484.         }
  486.         return $filter;
  487.     }
  489.     public function getTest(int $line): TwigTest
  490.     {
  491.         $name = $this->stream->expect(Token::NAME_TYPE)->getValue();
  493.         if ($this->stream->test(Token::NAME_TYPE)) {
  494.             // try 2-words tests
  495.             $name = $name.' '.$this->getCurrentToken()->getValue();
  497.             if ($test = $this->env->getTest($name)) {
  498.                 $this->stream->next();
  499.             }
  500.         } else {
  501.             $test = $this->env->getTest($name);
  502.         }
  504.         if (!$test) {
  505.             if ($this->shouldIgnoreUnknownTwigCallables()) {
  506.                 return new TwigTest($name, fn () => '');
  507.             }
  508.             $e = new SyntaxError(\sprintf('Unknown "%s" test.', $name), $line, $this->stream->getSourceContext());
  509.             $e->addSuggestions($name, array_keys($this->env->getTests()));
  511.             throw $e;
  512.         }
  514.         if ($test->isDeprecated()) {
  515.             $src = $this->stream->getSourceContext();
  516.             $test->triggerDeprecation($src->getPath() ?: $src->getName(), $this->stream->getCurrent()->getLine());
  517.         }
  519.         return $test;
  520.     }
  522.     private function filterBodyNodes(Node $node, bool $nested = false): ?Node
  523.     {
  524.         // check that the body does not contain non-empty output nodes
  525.         if (
  526.             ($node instanceof TextNode && !ctype_space($node->getAttribute('data')))
  527.             || (!$node instanceof TextNode && !$node instanceof BlockReferenceNode && $node instanceof NodeOutputInterface)
  528.         ) {
  529.             if (str_contains((string) $node, \chr(0xEF).\chr(0xBB).\chr(0xBF))) {
  530.                 $t = substr($node->getAttribute('data'), 3);
  531.                 if ('' === $t || ctype_space($t)) {
  532.                     // bypass empty nodes starting with a BOM
  533.                     return null;
  534.                 }
  535.             }
  537.             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());
  538.         }
  540.         // bypass nodes that "capture" the output
  541.         if ($node instanceof NodeCaptureInterface) {
  542.             // a "block" tag in such a node will serve as a block definition AND be displayed in place as well
  543.             return $node;
  544.         }
  546.         // "block" tags that are not captured (see above) are only used for defining
  547.         // the content of the block. In such a case, nesting it does not work as
  548.         // expected as the definition is not part of the default template code flow.
  549.         if ($nested && $node instanceof BlockReferenceNode) {
  550.             throw new SyntaxError('A block definition cannot be nested under non-capturing nodes.', $node->getTemplateLine(), $this->stream->getSourceContext());
  551.         }
  553.         if ($node instanceof NodeOutputInterface) {
  554.             return null;
  555.         }
  557.         // here, $nested means "being at the root level of a child template"
  558.         // we need to discard the wrapping "Node" for the "body" node
  559.         // Node::class !== \get_class($node) should be removed in Twig 4.0
  560.         $nested = $nested || (Node::class !== $node::class && !$node instanceof Nodes);
  561.         foreach ($node as $k => $n) {
  562.             if (null !== $n && null === $this->filterBodyNodes($n, $nested)) {
  563.                 $node->removeNode($k);
  564.             }
  565.         }
  567.         return $node;
  568.     }
  570.     private function checkPrecedenceDeprecations(ExpressionParserInterface $expressionParser, AbstractExpression $expr)
  571.     {
  572.         $this->expressionRefs[$expr] = $expressionParser;
  573.         $precedenceChanges = $this->parsers->getPrecedenceChanges();
  575.         // Check that the all nodes that are between the 2 precedences have explicit parentheses
  576.         if (!isset($precedenceChanges[$expressionParser])) {
  577.             return;
  578.         }
  580.         if ($expr->hasExplicitParentheses()) {
  581.             return;
  582.         }
  584.         if ($expressionParser instanceof PrefixExpressionParserInterface) {
  585.             /** @var AbstractExpression $node */
  586.             $node = $expr->getNode('node');
  587.             foreach ($precedenceChanges as $ep => $changes) {
  588.                 if (!\in_array($expressionParser, $changes, true)) {
  589.                     continue;
  590.                 }
  591.                 if (isset($this->expressionRefs[$node]) && $ep === $this->expressionRefs[$node]) {
  592.                     $change = $expressionParser->getPrecedenceChange();
  593.                     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()));
  594.                 }
  595.             }
  596.         }
  598.         foreach ($precedenceChanges[$expressionParser] as $ep) {
  599.             foreach ($expr as $node) {
  600.                 /** @var AbstractExpression $node */
  601.                 if (isset($this->expressionRefs[$node]) && $ep === $this->expressionRefs[$node] && !$node->hasExplicitParentheses()) {
  602.                     $change = $ep->getPrecedenceChange();
  603.                     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()));
  604.                 }
  605.             }
  606.         }
  607.     }
  608. }