[TwigBridge] Fix rendering of currency by MoneyType #26663

ro0NL · 2018-03-24T17:05:15Z

Q	A
Branch?	2.7
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	todo
Fixed tickets	#25135
License	MIT
Doc PR	-

Split from #25167 as suggested by @nicolas-grekas to see if this can be reasonably fixed on 2.7, the right way using this itsy-bitsy new feature.

#25167 still contains some valuable changes regarding tests. Ill continue either one PR depending on the target branch / proposed fix.

nicolas-grekas · 2018-03-25T13:28:00Z

src/Symfony/Bridge/Twig/Extension/HtmlEntitiesExtension.php

+ *
+ * @author Roland Franssen <[email protected]>
+ */
+class HtmlEntitiesExtension extends AbstractExtension


instead of a dedicated exception, can't we make it in an existing one?

FormExtension sounds good yes, and to really be conflict-safe id even suggest form_html_entities

the conflict-safe id is solved by not providing a legacy extension name at all (we don't have BC issues with this extension)

but we still need a filter name. html[_]entities has higher chance to be already defined in userland, hence var|form_html_entities.

nicolas-grekas · 2018-03-25T17:34:02Z

Tests are red (and lowest deps need to be updated.)

javiereguiluz · 2018-03-27T13:45:09Z

I consider this solution "too big" for the tiny use case being solved. Can't this be solved using some PHP code somewhere in Symfony Forms? Roland suggested this: htmlentities(self::getPattern($options['currency']), ENT_QUOTES | (defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8') but Nico said that the place was wrong (#25167 (comment)). Could some Form expert help us here? Thanks!

stof · 2018-03-27T14:29:47Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_3_layout.html.twig

@@ -25,11 +25,11 @@
    {% if prepend or append %}
        <div class="input-group">
            {% if prepend %}
-                <span class="input-group-addon">{{ money_pattern|replace({ '{{ widget }}':''}) }}</span>
+                <span class="input-group-addon">{{ money_pattern|html_entities|replace({ '{{ widget }}':''})|raw }}</span>


replacing {{ widget }} should be done before encoding entities IMO.

actually no.. 🤔 that would display a HTML literal as {{widget}} contains the <input>

What do you mean ? {{ widget }} is replaced by an empty string here

confused the templates :) now updated.

stof · 2018-03-27T14:30:40Z

src/Symfony/Bridge/Twig/Extension/HtmlEntitiesExtension.php

+
+    public function encode($input)
+    {
+        return htmlentities($input, ENT_QUOTES | (defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');


Twig does not guarantee it always runs in UTF-8. The charset should be handled properly.

stof · 2018-03-27T14:31:45Z

src/Symfony/Bridge/Twig/Extension/HtmlEntitiesExtension.php

+     */
+    public function getName()
+    {
+        return 'html_entities';


not needed. The versions we support don't care about the name except for BC reasons (in latest 1.x), and we don't need to provide a BC layer for the name-based access for a new extension.

ro0NL · 2018-03-27T15:50:20Z

@javiereguiluz

I consider this solution "too big" for the tiny use case being solved.

I understand your point, but then again, to me anything related to escaping, raw vars, encoding etc. is serious topic. I prefer the twig filter to properly solve this on the right level, the templating level. Doing it beforehand in PHP / ignoring the issue feels weird.

To me the fix is just OK, this is really about 2.7 vs. master.

stof · 2018-03-28T08:56:25Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

+    public function encodeCurrency(Environment $environment, $text)
+    {
+        if ('UTF-8' === $charset = $environment->getCharset()) {
+            return htmlspecialchars($text, ENT_QUOTES | (defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');


please use \defined, so that OPCache can resolve this at compile-time for recent PHP versions as it will know it is defined.

stof · 2018-03-28T08:56:55Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_3_layout.html.twig

@@ -25,11 +25,11 @@
    {% if prepend or append %}
        <div class="input-group">
            {% if prepend %}
-                <span class="input-group-addon">{{ money_pattern|replace({ '{{ widget }}':''}) }}</span>
+                <span class="input-group-addon">{{ money_pattern|form_encode_currency|replace({ '{{ widget }}':''})|raw }}</span>


the replacement should be done first, which will avoid the need for the |raw filter.

stof · 2018-03-28T08:57:11Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_3_layout.html.twig

            {% endif %}
            {{- block('form_widget_simple') -}}
            {% if append %}
-                <span class="input-group-addon">{{ money_pattern|replace({ '{{ widget }}':''}) }}</span>
+                <span class="input-group-addon">{{ money_pattern|form_encode_currency|replace({ '{{ widget }}':''})|raw }}</span>


stof · 2018-03-28T08:59:31Z

src/Symfony/Component/Form/Tests/Extension/Core/Type/MoneyTypeTest.php

@@ -33,7 +33,7 @@ public function testPassMoneyPatternToView()
        $view = $this->factory->create(static::TESTED_TYPE)
            ->createView();

-        $this->assertSame('{{ widget }} €', $view->vars['money_pattern']);
+        $this->assertSame('{{ widget }} &euro;', $view->vars['money_pattern']);


These test changes look suspicious to me

yeah we need 2 tests for utf+iso. The entity is a direct effect of using htmlentities, and what this topic is about: euro sign not being available in ISO (hence we use entities).

ro0NL · 2018-03-28T10:36:52Z

apart from tests; this seems the proper fix. As discussed with @nicolas-grekas to move widget replacement to extension level, making the template concise.

functional-wise, ive tested both ISO+UTF on 2.7 without any problems.

ro0NL · 2018-03-28T11:53:39Z

HHVM strikes again :( https://3v4l.org/NCWh2

ro0NL

Now ready. Yay :}

ro0NL · 2018-03-28T12:02:26Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

+    public function encodeCurrency(Environment $environment, $text, $widget = '')
+    {
+        if ('UTF-8' === $charset = $environment->getCharset()) {
+            $text = htmlspecialchars($text, ENT_QUOTES | (\defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');


ENT_QUOTES | ENT_SUBSTITUTE as of 3.4 instead

ro0NL · 2018-03-28T12:05:18Z

src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_3_layout.html.twig

@@ -25,11 +25,11 @@
    {% if prepend or append %}
        <div class="input-group">
            {% if prepend %}
-                <span class="input-group-addon">{{ money_pattern|replace({ '{{ widget }}':''}) }}</span>
+                <span class="input-group-addon">{{ money_pattern|form_encode_currency }}</span>


bootstrap_base_layout.html.twig + bootstrap_4_layout.html.twig as of 3.4 instead

ro0NL · 2018-03-28T12:14:47Z

src/Symfony/Bundle/FrameworkBundle/composer.json

@@ -30,7 +30,7 @@
        "symfony/security-core": "~2.6.13|~2.7.9|~2.8",
        "symfony/security-csrf": "~2.6",
        "symfony/stopwatch": "~2.3",
-        "symfony/templating": "~2.1",
+        "symfony/templating": "~2.7",


perhaps a conditional test is better, let me know.

nicolas-grekas · 2018-03-28T17:13:27Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

+    /**
+     * @internal
+     */
+    public function encodeCurrency(Environment $environment, $text, $widget = '')


$currency instead of $text, and mandatory $widget

nicolas-grekas · 2018-03-28T17:15:02Z

src/Symfony/Bridge/Twig/Extension/FormExtension.php

+        } else {
+            $text = htmlentities($text, ENT_QUOTES | (\defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');
+            $text = iconv('UTF-8', $charset, $text);
+            $widget = iconv('UTF-8', $charset, $widget);


Are we sure $widget is always in UTF-8? This looks strange to me, because that would mean this is also bugged. Is it?

i think we can assume we get raw html in UTF from the form component. Here we include it in a new safe html value concerning the target charset, using htmlentities instead of htmlspecialchars for escaping.

In general we are consistent with regular escaped output (ie. also in target charset) from twig_escape_filter.

At least we treated this as UTF before also (result from block() in twig).

fabpot · 2018-03-29T13:55:31Z

Thank you @ro0NL.

@nicolas-grekas

This PR was squashed before being merged into the 2.7 branch (closes #26663). Discussion ---------- [TwigBridge] Fix rendering of currency by MoneyType | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | todo | Fixed tickets | #25135 | License | MIT | Doc PR | - Split from #25167 as suggested by @nicolas-grekas to see if this can be reasonably fixed on 2.7, the right way using this itsy-bitsy new feature. #25167 still contains some valuable changes regarding tests. Ill continue either one PR depending on the target branch / proposed fix. Commits ------- a3a2ff0 [TwigBridge] Fix rendering of currency by MoneyType

carsonbot added Status: Needs Review TwigBridge Bug Feature labels Mar 24, 2018

nicolas-grekas reviewed Mar 25, 2018

View reviewed changes

nicolas-grekas added this to the 2.7 milestone Mar 25, 2018

nicolas-grekas changed the title ~~[TwigBridge] Add html_entities filter~~ [TwigBridge] Add html_entities filter to fix rendering of currency by MoneyType Mar 25, 2018

stof reviewed Mar 27, 2018

View reviewed changes

ro0NL added 4 commits March 27, 2018 18:29

[TwigBridge] Add html_entities filter

0a94383

optim

95218e1

php templates

2c692c3

tests

f128bcf

ro0NL mentioned this pull request Mar 27, 2018

[Form][TwigBridge] Handle MoneyType with non UTF-8 charset #25167

Closed

favor consistency

3887e49

nicolas-grekas changed the title ~~[TwigBridge] Add html_entities filter to fix rendering of currency by MoneyType~~ [TwigBridge] Fix rendering of currency by MoneyType Mar 27, 2018

stof requested changes Mar 28, 2018

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Mar 28, 2018

revise

768d1e2

ro0NL added 4 commits March 28, 2018 12:39

revision round 2

9495826

revert form type tests

a9e9081

first tests

b078f7e

fix tests

73d5602

ro0NL added 2 commits March 28, 2018 13:58

for hhvm

ee50318

raise deps=low

1182c69

ro0NL commented Mar 28, 2018

View reviewed changes

nicolas-grekas removed the Feature label Mar 28, 2018

nicolas-grekas reviewed Mar 28, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Work labels Mar 29, 2018

nicolas-grekas approved these changes Mar 29, 2018

View reviewed changes

fabpot approved these changes Mar 29, 2018

View reviewed changes

fabpot closed this Mar 29, 2018

ro0NL deleted the htmlentities branch March 29, 2018 13:56

This was referenced Apr 2, 2018

Release v2.7.44 #26741

Merged

Release v2.8.37 #26742

Merged

Release v3.4.7 #26751

Merged

Release v4.0.7 #26752

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TwigBridge] Fix rendering of currency by MoneyType #26663

[TwigBridge] Fix rendering of currency by MoneyType #26663

ro0NL commented Mar 24, 2018 •

edited by nicolas-grekas

Loading

nicolas-grekas Mar 25, 2018

ro0NL Mar 25, 2018 •

edited

Loading

nicolas-grekas Mar 25, 2018

stof Mar 27, 2018

ro0NL Mar 27, 2018

nicolas-grekas commented Mar 25, 2018

javiereguiluz commented Mar 27, 2018

stof Mar 27, 2018

ro0NL Mar 27, 2018 •

edited

Loading

stof Mar 27, 2018

ro0NL Mar 27, 2018

stof Mar 27, 2018

stof Mar 27, 2018

ro0NL commented Mar 27, 2018 •

edited

Loading

stof Mar 28, 2018

stof Mar 28, 2018

stof Mar 28, 2018

stof Mar 28, 2018

ro0NL Mar 28, 2018 •

edited

Loading

ro0NL commented Mar 28, 2018 •

edited

Loading

ro0NL commented Mar 28, 2018 •

edited

Loading

ro0NL left a comment

ro0NL Mar 28, 2018

ro0NL Mar 28, 2018

ro0NL Mar 28, 2018

nicolas-grekas Mar 28, 2018

nicolas-grekas Mar 28, 2018

ro0NL Mar 28, 2018 •

edited

Loading

ro0NL Mar 28, 2018

fabpot commented Mar 29, 2018

[TwigBridge] Fix rendering of currency by MoneyType #26663

[TwigBridge] Fix rendering of currency by MoneyType #26663

Conversation

ro0NL commented Mar 24, 2018 • edited by nicolas-grekas Loading

Choose a reason for hiding this comment

ro0NL Mar 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Mar 25, 2018

javiereguiluz commented Mar 27, 2018

Choose a reason for hiding this comment

ro0NL Mar 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL commented Mar 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

ro0NL commented Mar 28, 2018 • edited Loading

ro0NL commented Mar 28, 2018 • edited Loading

ro0NL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL Mar 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Mar 29, 2018

ro0NL commented Mar 24, 2018 •

edited by nicolas-grekas

Loading

ro0NL Mar 25, 2018 •

edited

Loading

ro0NL Mar 27, 2018 •

edited

Loading

ro0NL commented Mar 27, 2018 •

edited

Loading

ro0NL Mar 28, 2018 •

edited

Loading

ro0NL commented Mar 28, 2018 •

edited

Loading

ro0NL commented Mar 28, 2018 •

edited

Loading

ro0NL Mar 28, 2018 •

edited

Loading