modifier flags WIP

nette · Jan 10, 2024 · a29e5a0 · a29e5a0
1 parent aaf493e
commit a29e5a0
Show file tree

Hide file tree

Showing 11 changed files with 109 additions and 48 deletions.
diff --git a/src/Latte/Compiler/Nodes/Php/ModifierNode.php b/src/Latte/Compiler/Nodes/Php/ModifierNode.php
@@ -18,17 +18,45 @@
 
 class ModifierNode extends Node
 {
+	/** @var array<string, FilterNode> */
+	public array $flags = [];
+	public bool $check = false;
+
+
 	public function __construct(
 		/** @var FilterNode[] */
 		public array $filters,
 		public bool $escape = false,
-		public bool $check = true,
 		public ?Position $position = null,
 	) {
 		(function (FilterNode ...$args) {})(...$filters);
 	}
 
 
+	public function defineFlags(string ...$names): void
+	{
+		foreach ($this->filters as $i => $filter) {
+			$name = $filter->name->name;
+			if (in_array($name, $names, true)) {
+				if ($filter->nullsafe || $filter->args) {
+					throw new CompileException("Flag |$name cannot have arguments or nullsafe pipe.", $filter->position);
+				}
+				unset($this->filters[$i]);
+				$this->flags[$name] = $filter;
+			}
+		}
+		$this->escape = in_array('noescape', $names, true)
+			? empty($this->flags['noescape'])
+			: $this->escape;
+	}
+
+
+	public function hasFlag(string $name): bool
+	{
+		return isset($this->flags[$name]);
+	}
+
+
 	public function hasFilter(string $name): bool
 	{
 		foreach ($this->filters as $filter) {
@@ -49,30 +77,15 @@ public function print(PrintContext $context): string
 
 	public function printSimple(PrintContext $context, string $expr): string
 	{
-		$escape = $this->escape;
-		$check = $this->check;
-		$filters = [];
-		foreach ($this->filters as $filter) {
-			$name = $filter->name->name;
-			if ($name === 'nocheck' || $name === 'noCheck') {
-				$check = false;
-			} elseif ($name === 'noescape') {
-				$escape = false;
-			} else {
-				if ($name === 'datastream' || $name === 'dataStream') {
-					$check = false;
-				}
-				$filters[] = $filter;
-			}
-		}
-		$expr = FiltersCallNode::printFilters($context, $filters, $expr);
+		$this->checkUnallowedFlags();
+		$expr = FiltersCallNode::printFilters($context, $this->filters, $expr);
 
 		$escaper = $context->getEscaper();
-		if ($check) {
+		if ($this->check) {
 			$expr = $escaper->check($expr);
 		}
 
-		$expr = $escape
+		$expr = $this->escape
 			? $escaper->escape($expr)
 			: $escaper->escapeMandatory($expr);
 
@@ -82,12 +95,9 @@ public function printSimple(PrintContext $context, string $expr): string
 
 	public function printContentAware(PrintContext $context, string $expr): string
 	{
+		$this->checkUnallowedFlags();
 		foreach ($this->filters as $filter) {
-			$name = $filter->name->name;
-			if ($name === 'noescape') {
-				$noescape = true;
-				continue;
-			} elseif ($filter->nullsafe) {
+			if ($filter->nullsafe) {
 				throw new CompileException('Nullsafe pipe is not allowed here', $filter->position);
 			}
 
@@ -99,7 +109,7 @@ public function printContentAware(PrintContext $context, string $expr): string
 				. ')';
 		}
 
-		if ($this->escape && empty($noescape)) {
+		if ($this->escape) {
 			$expr = 'LR\Filters::convertTo($ʟ_fi, '
 				. var_export($context->getEscaper()->export(), true) . ', '
 				. $expr
@@ -115,5 +125,22 @@ public function &getIterator(): \Generator
 		foreach ($this->filters as &$filter) {
 			yield $filter;
 		}
+		foreach ($this->flags as &$filter) {
+			yield $filter;
+		}
+	}
+
+
+	private function checkUnallowedFlags(): void
+	{
+		foreach ($this->filters as $filter) {
+			$name = $filter->name->name;
+			if ($this->escape && $name === 'noescape') { // back compatibility
+				$this->defineFlags('noescape');
+				$this->escape = false;
+			} elseif ($name === 'noescape' || $name === 'nocheck' || $name === 'noCheck') {
+				throw new CompileException("Filter |$name is not allowed here.", $filter->position);
+			}
+		}
 	}
 }
diff --git a/src/Latte/Essential/Nodes/BlockNode.php b/src/Latte/Essential/Nodes/BlockNode.php
@@ -56,8 +56,9 @@ public static function create(Tag $tag, TemplateParser $parser): \Generator
 		}
 
 		$node->modifier = $tag->parser->parseModifier();
-		$node->modifier->escape = (bool) $node->modifier->filters;
-		if ($node->modifier->hasFilter('noescape') && count($node->modifier->filters) === 1) {
+		$node->modifier->defineFlags('noescape');
+		$node->modifier->escape = $node->modifier->escape && $node->modifier->filters;
+		if ($node->modifier->hasFlag('noescape') && !$node->modifier->filters) {
 			throw new CompileException('Filter |noescape is not expected here.', $tag->position);
 		}
 

diff --git a/src/Latte/Essential/Nodes/ForeachNode.php b/src/Latte/Essential/Nodes/ForeachNode.php
@@ -50,12 +50,11 @@ public static function create(Tag $tag): \Generator
 		self::parseArguments($tag->parser, $node);
 
 		$modifier = $tag->parser->parseModifier();
-		foreach ($modifier->filters as $filter) {
-			match ($filter->name->name) {
-				'nocheck', 'noCheck' => $node->checkArgs = false,
-				'noiterator', 'noIterator' => $node->iterator = false,
-				default => throw new CompileException('Only modifiers |noiterator and |nocheck are allowed here.', $tag->position),
-			};
+		$modifier->defineFlags('nocheck', 'noCheck', 'noiterator', 'noIterator');
+		$node->checkArgs = !$modifier->hasFlag('nocheck') && !$modifier->hasFlag('noCheck');
+		$node->iterator = $modifier->hasFlag('noiterator') || $modifier->hasFlag('noIterator') ? false : null;
+		if ($modifier->filters) {
+			throw new CompileException('Only modifiers |noiterator and |nocheck are allowed here.', $tag->position);
 		}
 
 		if ($tag->void) {

diff --git a/src/Latte/Essential/Nodes/IncludeBlockNode.php b/src/Latte/Essential/Nodes/IncludeBlockNode.php
@@ -58,7 +58,6 @@ public static function create(Tag $tag, TemplateParser $parser): static
 		$stream->tryConsume(',');
 		$node->args = $tag->parser->parseArguments();
 		$node->modifier = $tag->parser->parseModifier();
-		$node->modifier->escape = (bool) $node->modifier->filters;
 
 		$node->parent = $tokenName->is('parent');
 		if ($node->parent && $node->modifier->filters) {
@@ -76,6 +75,8 @@ public static function create(Tag $tag, TemplateParser $parser): static
 			$node->name = $item->node->block->name;
 		}
 
+		$node->modifier->defineFlags('noescape');
+		$node->modifier->escape = $node->modifier->escape && $node->modifier->filters;
 		$node->blocks = &$parser->blocks;
 		$node->layer = $parser->blockLayer;
 		return $node;
@@ -84,13 +85,12 @@ public static function create(Tag $tag, TemplateParser $parser): static
 
 	public function print(PrintContext $context): string
 	{
-		$noEscape = $this->modifier->hasFilter('noescape');
-		$modArg = count($this->modifier->filters) > (int) $noEscape
+		$modArg = $this->modifier->filters
 			? $context->format(
 				'function ($s, $type) { $ʟ_fi = new LR\FilterInfo($type); return %modifyContent($s); }',
 				$this->modifier,
 			)
-			: ($noEscape || $this->parent ? '' : PhpHelpers::dump($context->getEscaper()->export()));
+			: ($this->modifier->hasFlag('noescape') || $this->parent ? '' : PhpHelpers::dump($context->getEscaper()->export()));
 
 		return $this->from
 			? $this->printBlockFrom($context, $modArg)

diff --git a/src/Latte/Essential/Nodes/IncludeFileNode.php b/src/Latte/Essential/Nodes/IncludeFileNode.php
@@ -48,25 +48,25 @@ public static function create(Tag $tag): static
 		$stream->tryConsume(',');
 		$node->args = $tag->parser->parseArguments();
 		$node->modifier = $tag->parser->parseModifier();
-		$node->modifier->escape = (bool) $node->modifier->filters;
+		$node->modifier->defineFlags('noescape');
+		$node->modifier->escape = $node->modifier->escape && $node->modifier->filters;
 		return $node;
 	}
 
 
 	public function print(PrintContext $context): string
 	{
-		$noEscape = $this->modifier->hasFilter('noescape');
 		return $context->format(
 			'$this->createTemplate(%node, %node? + $this->params, %dump)->renderToContentType(%raw) %line;',
 			$this->file,
 			$this->args,
 			$this->mode,
-			count($this->modifier->filters) > (int) $noEscape
+			$this->modifier->filters
 				? $context->format(
 					'function ($s, $type) { $ʟ_fi = new LR\FilterInfo($type); return %modifyContent($s); }',
 					$this->modifier,
 				)
-				: PhpHelpers::dump($noEscape ? null : $context->getEscaper()->export()),
+				: PhpHelpers::dump($this->modifier->hasFlag('noescape') ? null : $context->getEscaper()->export()),
 			$this->position,
 		);
 	}

diff --git a/src/Latte/Essential/Nodes/PrintNode.php b/src/Latte/Essential/Nodes/PrintNode.php
@@ -38,16 +38,24 @@ public static function create(Tag $tag, TemplateParser $parser): static
 			: null;
 		$node->expression = $tag->parser->parseExpression();
 		$node->modifier = $tag->parser->parseModifier();
-		$node->modifier->escape = true;
+		$node->modifier->defineFlags('noescape');
 		return $node;
 	}
 
 
 	public function print(PrintContext $context): string
 	{
-		if ($this->followsQuote && $context->getEscaper()->export() === 'html/raw/js') {
+		$escaper = $context->getEscaper();
+		if ($this->followsQuote && $escaper->export() === 'html/raw/js') {
 			throw new CompileException("Do not place {$this->followsQuote} inside quotes in JavaScript.", $this->position);
 		}
+
+		if ($escaper->export() === 'html/attr/url') {
+			$this->modifier->defineFlags('nocheck', 'noCheck');
+			$this->modifier->check = !$this->modifier->hasFlag('nocheck') && !$this->modifier->hasFlag('noCheck')
+				&& !$this->modifier->hasFilter('datastream') && !$this->modifier->hasFilter('dataStream');
+		}
+
 		return $context->format(
 			"echo %modify(%node) %line;\n",
 			$this->modifier,

diff --git a/src/Latte/Essential/Nodes/TranslateNode.php b/src/Latte/Essential/Nodes/TranslateNode.php
@@ -38,7 +38,7 @@ public static function create(Tag $tag, ?callable $translator): \Generator
 		$node = $tag->node = new static;
 		$args = $tag->parser->parseArguments();
 		$node->modifier = $tag->parser->parseModifier();
-		$node->modifier->escape = true;
+		$node->modifier->defineFlags('noescape');
 		if ($tag->void) {
 			return new NopNode;
 		}

diff --git a/src/Latte/Essential/TranslatorExtension.php b/src/Latte/Essential/TranslatorExtension.php
@@ -78,7 +78,7 @@ public function parseTranslate(Tag $tag): PrintNode
 		}
 
 		$node->modifier = $tag->parser->parseModifier();
-		$node->modifier->escape = true;
+		$node->modifier->defineFlags('noescape');
 
 		if ($this->translator
 			&& $this->key

diff --git a/tests/common/Compiler.errors.phpt b/tests/common/Compiler.errors.phpt
@@ -356,3 +356,27 @@ Assert::exception(
 	Latte\CompileException::class,
 	'Nullsafe pipe is not allowed here (on line 1 at column 13)',
 );
+
+Assert::exception(
+	fn() => $latte->compile('{capture $foo|noescape}...{/capture}'),
+	Latte\CompileException::class,
+	'Filter |noescape is not allowed here (on line 1 at column 14)',
+);
+
+Assert::exception(
+	fn() => $latte->compile('{$foo|nocheck}'),
+	Latte\CompileException::class,
+	'Filter |nocheck is not allowed here (on line 1 at column 6)',
+);
+
+Assert::exception(
+	fn() => $latte->compile('{$foo?|noescape}'),
+	Latte\CompileException::class,
+	'Flag |noescape cannot have arguments or nullsafe pipe (on line 1 at column 6)',
+);
+
+Assert::exception(
+	fn() => $latte->compile('{$foo|noescape:123}'),
+	Latte\CompileException::class,
+	'Flag |noescape cannot have arguments or nullsafe pipe (on line 1 at column 6)',
+);
diff --git a/tests/phpParser/modifier.phpt b/tests/phpParser/modifier.phpt
@@ -28,6 +28,8 @@ Assert::same(
 
 __halt_compiler();
 Latte\Compiler\Nodes\Php\ModifierNode
+   flags: array (0)
+   check: false
    filters: array (2)
    |  0 => Latte\Compiler\Nodes\Php\FilterNode
    |  |  name: Latte\Compiler\Nodes\Php\IdentifierNode
@@ -72,5 +74,4 @@ Latte\Compiler\Nodes\Php\ModifierNode
    |  |  nullsafe: false
    |  |  position: 1:26 (offset 25)
    escape: false
-   check: true
    position: 1:1 (offset 0)
diff --git a/tests/phpParser/modifierNullsafe.phpt b/tests/phpParser/modifierNullsafe.phpt
@@ -28,6 +28,8 @@ Assert::same(
 
 __halt_compiler();
 Latte\Compiler\Nodes\Php\ModifierNode
+   flags: array (0)
+   check: false
    filters: array (2)
    |  0 => Latte\Compiler\Nodes\Php\FilterNode
    |  |  name: Latte\Compiler\Nodes\Php\IdentifierNode
@@ -72,5 +74,4 @@ Latte\Compiler\Nodes\Php\ModifierNode
    |  |  nullsafe: true
    |  |  position: 1:28 (offset 27)
    escape: false
-   check: true
    position: 1:1 (offset 0)