AC-3170: Incorrect processing order of Email template directives

Author: dvoskoboinikov

lib/internal/Magento/Framework/Filter/Template.php

@@ -18,6 +18,7 @@
 use Magento\Framework\Filter\DirectiveProcessor\TemplateDirective;
 use Magento\Framework\Filter\DirectiveProcessor\VarDirective;
 use Magento\Framework\Stdlib\StringUtils;
+use Magento\Framework\Filter\Template\SignatureProvider;
 
 /**
  * Template filter
@@ -100,23 +101,32 @@ class Template implements \Zend_Filter_Interface
      */
     private $variableResolver;
 
+    /**
+     * @var SignatureProvider|null
+     */
+    private $signatureProvider;
+
     /**
      * @param StringUtils $string
      * @param array $variables
      * @param DirectiveProcessorInterface[] $directiveProcessors
      * @param VariableResolverInterface|null $variableResolver
+     * @param SignatureProvider|null $signatureProvider
      */
     public function __construct(
         StringUtils $string,
         $variables = [],
         $directiveProcessors = [],
-        VariableResolverInterface $variableResolver = null
+        VariableResolverInterface $variableResolver = null,
+        SignatureProvider $signatureProvider = null
     ) {
         $this->string = $string;
         $this->setVariables($variables);
         $this->directiveProcessors = $directiveProcessors;
         $this->variableResolver = $variableResolver ?? ObjectManager::getInstance()
                 ->get(VariableResolverInterface::class);
+        $this->signatureProvider = $signatureProvider ?? ObjectManager::getInstance()
+                ->get(SignatureProvider::class);
 
         if (empty($directiveProcessors)) {
             $this->directiveProcessors = [
@@ -180,22 +190,83 @@ public function filter($value)
             )->render());
         }
 
+        // Processing of template directives.
+        $templateDirectivesResults = $this->processDirectives($value);
+
+        foreach ($templateDirectivesResults as $result) {
+            $value = str_replace($result['directive'], $result['output'], $value);
+        }
+
+        // Processing of deferred directives received from child templates.
+        $deferredDirectivesResults = $this->processDirectives($value, true);
+
+        foreach ($deferredDirectivesResults as $result) {
+            $value = str_replace($result['directive'], $result['output'], $value);
+        }
+
+        // Signing own deferred directives (if any).
+        $signature = $this->signatureProvider->get();
+
+        foreach ($templateDirectivesResults as $result) {
+            if ($result['directive'] === $result['output']) {
+                $value = str_replace(
+                    $result['output'],
+                    $signature . $result['output'] . $signature,
+                    $value
+                );
+            }
+        }
+
+        $value = $this->afterFilter($value);
+
+        return $value;
+    }
+
+    /**
+     * Processes template directives and returns an array
+     * that contains results produced by each directive.
+     *
+     * @param string $value
+     * @param bool $isSigned
+     *
+     * @return array
+     *
+     * @throws InvalidArgumentException
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    private function processDirectives($value, $isSigned = false)
+    {
+        $results = [];
+
         foreach ($this->directiveProcessors as $directiveProcessor) {
             if (!$directiveProcessor instanceof DirectiveProcessorInterface) {
                 throw new InvalidArgumentException(
                     'Directive processors must implement ' . DirectiveProcessorInterface::class
                 );
             }
 
-            if (preg_match_all($directiveProcessor->getRegularExpression(), $value, $constructions, PREG_SET_ORDER)) {
+            $pattern = $directiveProcessor->getRegularExpression();
+
+            if ($isSigned) {
+                $signature = $this->signatureProvider->get();
+
+                $pattern = substr_replace($pattern, $signature, strpos($pattern, '/') + 1, 0);
+                $pattern = substr_replace($pattern, $signature, strrpos($pattern, '/'), 0);
+            }
+
+            if (preg_match_all($pattern, $value, $constructions, PREG_SET_ORDER)) {
                 foreach ($constructions as $construction) {
                     $replacedValue = $directiveProcessor->process($construction, $this, $this->templateVars);
-                    $value = str_replace($construction[0], $replacedValue, $value);
+
+                    $results[] = [
+                        'directive' => $construction[0],
+                        'output' => $replacedValue
+                    ];
                 }
             }
         }
 
-        return $this->afterFilter($value);
+        return $results;
     }
 
     /**

lib/internal/Magento/Framework/Filter/Template/SignatureProvider.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Filter\Template;
+
+/**
+ * Provider of a signature.
+ *
+ * Provides a signature which should be used to sign deferred directives
+ * (directives that should be processed in scope of a parent template
+ * instead of own scope, e.g. {{inlinecss}}).
+ */
+class SignatureProvider
+{
+    /**
+     * @var string|null
+     */
+    private $signature;
+
+    /**
+     * @var \Magento\Framework\Math\Random
+     */
+    private $random;
+
+    /**
+     * @param \Magento\Framework\Math\Random $random
+     */
+    public function __construct(
+        \Magento\Framework\Math\Random $random
+    ) {
+        $this->random = $random;
+    }
+
+    /**
+     * Generates a random string which will be used as a signature during runtime.
+     *
+     * @return string
+     *
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function get()
+    {
+        if ($this->signature === null) {
+            $this->signature = $this->random->getRandomString(32);
+        }
+
+        return $this->signature;
+    }
+}

lib/internal/Magento/Framework/Filter/Test/Unit/Template/SignatureProviderTest.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Filter\Test\Unit\Template;
+
+class SignatureProviderTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var \Magento\Framework\Filter\Template\SignatureProvider
+     */
+    protected $signatureProvider;
+
+    /**
+     * @var \Magento\Framework\Math\Random|\PHPUnit\Framework\MockObject\MockObject
+     */
+    protected $random;
+
+    protected function setUp(): void
+    {
+        $this->random = $this->createPartialMock(
+            \Magento\Framework\Math\Random::class,
+            ['getRandomString']
+        );
+
+        $this->signatureProvider = new \Magento\Framework\Filter\Template\SignatureProvider(
+            $this->random
+        );
+    }
+
+    public function testGet()
+    {
+        $expectedResult = 'Z0FFbeCU2R8bsVGJuTdkXyiiZBzsaceV';
+
+        $this->random->expects($this->once())
+            ->method('getRandomString')
+            ->with(32)
+            ->willReturn($expectedResult);
+
+        $this->assertEquals($expectedResult, $this->signatureProvider->get());
+
+        $this->random->expects($this->never())
+            ->method('getRandomString');
+
+        $this->assertEquals($expectedResult, $this->signatureProvider->get());
+    }
+}