Adding a custom function to twig to use in e-mail templates

I’ve created an extension with my custom function in it.

class AppExtension extends \Twig_Extension { private $_container; public function __construct($container) { $this->_container = $container; } public function getFunctions() { return [ new \Twig_SimpleFunction('autologin', [$this, 'autologin'], ['is_safe' => ['all']]) ]; } public function autologin($customer, $url) { return sprintf(''); } public function getName() { return 'xxx_app_extension'; } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

class AppExtension extends \Twig_Extension     {         private $_container;              public function __construct($container)         {             $this->_container = $container;         }              public function getFunctions()         {             return [                 new \Twig_SimpleFunction('autologin', [$this, 'autologin'], ['is_safe' => ['all']])             ];         }              public function autologin($customer, $url)         {             return sprintf('');         }              public function getName()         {             return 'xxx_app_extension';         }     }

I’ve added it to services.yml:

xxx_opportunity.twig.helper: class: 'OpportunityBundle\Twig\AppExtension' public: false arguments: - '@service_container' tags: - { name: twig.extension }

1 2 3 4 5 6 7

xxx_opportunity.twig.helper:         class: 'OpportunityBundle\Twig\AppExtension'         public: false         arguments:             - '@service_container'         tags:             - { name: twig.extension }

When I look if it is found by ORO/Symfony by doing “php bin/console debug:twig”, I can see my custom function appear in the list. When I try to implement it in an email template using the email template editor in OROcrm, I get the following error:

The template for xxxx has syntax error: Unknown "autologin" function at line 18.

1	The template for xxxx has syntax error: Unknown "autologin" function at line 18.

After a while I figured I should check out what the compiler did, and noticed the getOroEmail_EmailRendererService.php file(s) did not contain my extension.

$instance = new \Oro\Bundle\EmailBundle\Provider\EmailRenderer(${($_ = isset($this->services['oro_email $instance->addExtension(${($_ = isset($this->services['oro_ui.twig.html_tag']) ? $this->services['oro_u $instance->addExtension(${($_ = isset($this->services['oro_config.twig.config_extension']) ? $this->ser $instance->addExtension(${($_ = isset($this->services['oro_ui.twig.extension.formatter']) ? $this->serv $instance->addExtension(${($_ = isset($this->services['oro_locale.twig.address']) ? $this->services['or $instance->addExtension(${($_ = isset($this->services['oro_locale.twig.date_time']) ? $this->services[' $instance->addExtension(${($_ = isset($this->services['oro_entity.twig.extension.entity']) ? $this->ser $instance->addExtension(${($_ = isset($this->services['twig.extension.intl']) ? $this->services['twig.e $instance->addExtension(${($_ = isset($this->services['oro_locale.twig.date_time_organization']) ? $thi $instance->addExtension(${($_ = isset($this->services['oro_calendar.twig.dateformat']) ? $this->service $instance->addExtension(${($_ = isset($this->services['oro_calendar.twig.recurrence']) ? $this->service $instance->addExtension(${($_ = isset($this->services['oro_currency.twig.currency']) ? $this->services[ $instance->addExtension(${($_ = isset($this->services['twig.extension.routing']) ? $this->services['twi

1 2 3 4 5 6 7 8 9 10 11 12 13

$instance = new \Oro\Bundle\EmailBundle\Provider\EmailRenderer(${($_ = isset($this->services['oro_email $instance->addExtension(${($_ = isset($this->services['oro_ui.twig.html_tag']) ? $this->services['oro_u $instance->addExtension(${($_ = isset($this->services['oro_config.twig.config_extension']) ? $this->ser $instance->addExtension(${($_ = isset($this->services['oro_ui.twig.extension.formatter']) ? $this->serv $instance->addExtension(${($_ = isset($this->services['oro_locale.twig.address']) ? $this->services['or $instance->addExtension(${($_ = isset($this->services['oro_locale.twig.date_time']) ? $this->services[' $instance->addExtension(${($_ = isset($this->services['oro_entity.twig.extension.entity']) ? $this->ser $instance->addExtension(${($_ = isset($this->services['twig.extension.intl']) ? $this->services['twig.e $instance->addExtension(${($_ = isset($this->services['oro_locale.twig.date_time_organization']) ? $thi $instance->addExtension(${($_ = isset($this->services['oro_calendar.twig.dateformat']) ? $this->service $instance->addExtension(${($_ = isset($this->services['oro_calendar.twig.recurrence']) ? $this->service $instance->addExtension(${($_ = isset($this->services['oro_currency.twig.currency']) ? $this->services[ $instance->addExtension(${($_ = isset($this->services['twig.extension.routing']) ? $this->services['twi

I’ve tried manually adding them to the generated file just to see what happens, and resaving the template, which went without errors this time. Yet, when I try to send it using my notificationrules, nothing gets sent. To make sure it wasn’t just a mail server error, I updated the template with nothing but “hello”, which did arrive in my inbox this time.

So right now I’m probably facing 2 issues, one is that Oro/Symfony doesn’t add the extension to getOroEmail_EmailRendererService.php, and the other is that even if I add it manually just for testing purposes, it still won’t send the email.

I’ve been stuck on this issue for a few days now and it’s really doing my head in. Anyone got the solution to this problem?

Topic

[Andrey YatsenkoModerator]

Emails have independent twig renderer with the sandbox to disable all not required twig functions there.

Here is an example, how to add twig extensions to email renderer:
1) You need a compiler pass, that will add an extension to the email renderer and exclusion to email renderer security policy service:
https://github.com/oroinc/orocommerce/blob/master/src/Oro/Bundle/ProductBundle/DependencyInjection/CompilerPass/TwigSandboxConfigurationPass.php
2) also this compiler pass should be registered to the container at the bundle class
https://github.com/oroinc/orocommerce/blob/master/src/Oro/Bundle/ProductBundle/OroProductBundle.php#L41

[mathijsParticipant]

Thanks Andrey for pointing me in the right direction. I’ve looked at the snippets you linked and recreated my own versions of them and I see both the function and the extension being injected in their respective compiled files, I can also save the template with my function in it. Yet, when I try to send an e-mail using the template containing my function, it won’t send.

I’ve tried adding the function with and without parameters, I tried having the function return nothing more than ‘hello’ but whatever I attempt, it still seems like the function is blocked somewhere. I don’t see any errors while running oro:message-queue:consume -v either.

Here are my versions of the TwigSandboxConfigurationPass class and the bundle class:

PHP

<?php namespace OpportunityBundle\DependencyInjection\CompilerPass; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\Reference; /** * Adds TWIG filters to the list of TWIG filters allowed for execution during email templates rendering. */ class TwigSandboxConfigurationPass implements CompilerPassInterface { const EMAIL_TEMPLATE_SANDBOX_SECURITY_POLICY_SERVICE_KEY = 'oro_email.twig.email_security_policy'; const EMAIL_TEMPLATE_RENDERER_SERVICE_KEY = 'oro_email.email_renderer'; /** * {@inheritDoc} */ public function process(ContainerBuilder $container) { if ($container->has(self::EMAIL_TEMPLATE_SANDBOX_SECURITY_POLICY_SERVICE_KEY) && $container->has(self::EMAIL_TEMPLATE_RENDERER_SERVICE_KEY) ) { $securityPolicyDef = $container->getDefinition(self::EMAIL_TEMPLATE_SANDBOX_SECURITY_POLICY_SERVICE_KEY); $functions = $securityPolicyDef->getArgument(1); $functions = array_merge( $functions, [ 'autologin' ] ); $securityPolicyDef->replaceArgument(1, $functions); $rendererDef = $container->getDefinition(self::EMAIL_TEMPLATE_RENDERER_SERVICE_KEY); $rendererDef->addMethodCall('addExtension', [new Reference('twm_opportunity.twig.extension')]); } } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

<?php   namespace OpportunityBundle\DependencyInjection\CompilerPass;   use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\Reference;   /** * Adds TWIG filters to the list of TWIG filters allowed for execution during email templates rendering. */ class TwigSandboxConfigurationPass implements CompilerPassInterface {     const EMAIL_TEMPLATE_SANDBOX_SECURITY_POLICY_SERVICE_KEY = 'oro_email.twig.email_security_policy';     const EMAIL_TEMPLATE_RENDERER_SERVICE_KEY = 'oro_email.email_renderer';       /**      * {@inheritDoc}      */     public function process(ContainerBuilder $container)     {         if ($container->has(self::EMAIL_TEMPLATE_SANDBOX_SECURITY_POLICY_SERVICE_KEY) &&             $container->has(self::EMAIL_TEMPLATE_RENDERER_SERVICE_KEY)         ) {             $securityPolicyDef = $container->getDefinition(self::EMAIL_TEMPLATE_SANDBOX_SECURITY_POLICY_SERVICE_KEY);             $functions = $securityPolicyDef->getArgument(1);             $functions = array_merge(                 $functions,                 [                     'autologin'                 ]             );             $securityPolicyDef->replaceArgument(1, $functions);               $rendererDef = $container->getDefinition(self::EMAIL_TEMPLATE_RENDERER_SERVICE_KEY);             $rendererDef->addMethodCall('addExtension', [new Reference('twm_opportunity.twig.extension')]);         }     } }

PHP

<?php namespace OpportunityBundle; use OpportunityBundle\DependencyInjection\CompilerPass\TwigSandboxConfigurationPass; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\HttpKernel\Bundle\Bundle; class OpportunityBundle extends Bundle { public function getParent() { return 'OroSalesBundle'; } public function build(ContainerBuilder $container) { parent::build($container); // TODO: Change the autogenerated stub $container->addCompilerPass(new TwigSandboxConfigurationPass()); } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

<?php   namespace OpportunityBundle;   use OpportunityBundle\DependencyInjection\CompilerPass\TwigSandboxConfigurationPass; use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\HttpKernel\Bundle\Bundle;   class OpportunityBundle extends Bundle {     public function getParent()     {         return 'OroSalesBundle';     }       public function build(ContainerBuilder $container)     {         parent::build($container); // TODO: Change the autogenerated stub           $container->addCompilerPass(new TwigSandboxConfigurationPass());     } }

• This reply was modified 5 years, 7 months ago by  mathijs.

[Andrey YatsenkoModerator]

Please check the signature of the SecurityPolicy:__construct method.

You are adding functions, not filters as in my example.

Arguments list index starts from zero,

PHP

public function __construct( array $allowedTags = [], #argumentIndex=0 array $allowedFilters = [], #argumentIndex=1 array $allowedMethods = [], #argumentIndex=2 array $allowedProperties = [], #argumentIndex=3 array $allowedFunctions = [] #argumentIndex=4 ) {

1 2 3 4 5 6 7

public function __construct(         array $allowedTags = [], #argumentIndex=0         array $allowedFilters = [], #argumentIndex=1         array $allowedMethods = [], #argumentIndex=2         array $allowedProperties = [], #argumentIndex=3         array $allowedFunctions = [] #argumentIndex=4     ) {

To extend the list of allowed functions you need to replace argument with index 4

[mathijsParticipant]

If we ever run into eachother in this lifetime, remind me to buy you a drink Andrey. Thanks for the help!

[Author]

Replies