Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[11.x] Fix EncodedHtmlString to ignore instance of HtmlString #55543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Apr 25, 2025
Merged

[11.x] Fix EncodedHtmlString to ignore instance of HtmlString #55543

merged 8 commits into from
Apr 25, 2025

Conversation

jbraband
Copy link

@jbraband jbraband commented Apr 24, 2025 •
edited
Loading

I do not see existing tests for the sub-mail components (header, footer, table, etc) and so are excluded from this PR. The related PR #55149 also do not contain tests for similar changes to button, header, layout, message, and panel.

After updating to Laravel 11.44.3 yesterday, the mail components started rendering escaped HTML. Note that some mail components were fixed by @crynobone in #55149.

Here is a sample markdown template that demonstrates the 3 mail components included in this PR, subcopy, table, and footer

<x-mail::message subcopy="This is my subcopy">

<x-mail::table>
| Laravel       | Table         | Example       |
| ------------- | :-----------: | ------------: |
| Col 2 is      | Centered      | $10           |
| Col 3 is      | Right-Aligned | $20           |
</x-mail::table>

</x-mail::message>

The resulting rendered mailable.

image

Note: the closing } seen at the end of the sub-copy in the image has already been fixed by @crynobone in #55530 and is waiting for release next week

I am happy to makes changes or additions.

@jbraband
Copy link
Author

I should add that with this PR, the mailable renders properly

image

@crynobone
add tests
1cbe8f6 
Signed-off-by: Mior Muhammad Zaki <[email protected]>
@crynobone
wip
6137290 
Signed-off-by: Mior Muhammad Zaki <[email protected]>
@crynobone
wip
deb1638 
Signed-off-by: Mior Muhammad Zaki <[email protected]>
@crynobone
Markdown::parse() returns HtmlString() so that should be enough to
13d57d5 
avoid double encoding

Signed-off-by: Mior Muhammad Zaki <[email protected]>
@crynobone
wip
9218996 
Signed-off-by: Mior Muhammad Zaki <[email protected]>
@crynobone
Copy link
Member

crynobone commented Apr 25, 2025 •
edited
Loading

@jbraband I made some changes to how we solve this. Markdown::parse() should already return an instance of HtmlString and that shouldn't be encoded again.

Also add some integration tests to cover this usage

crynobone
crynobone reviewed Apr 25, 2025
View reviewed changes
src/Illuminate/Support/EncodedHtmlString.php

if ($value instanceof BackedEnum) {
$value = $value->value;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy the logic from e() function

framework/src/Illuminate/Support/helpers.php

Lines 127 to 142 in 18a2f33

function e($value, $doubleEncode = true)
{
if ($value instanceof DeferringDisplayableValue) {
$value = $value->resolveDisplayableValue();
}
if ($value instanceof Htmlable) {
return $value->toHtml();
}
if ($value instanceof BackedEnum) {
$value = $value->value;
}
return htmlspecialchars($value ?? '', ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8', $doubleEncode);
}

@jbraband
Copy link
Author

jbraband commented Apr 25, 2025 •
edited
Loading

@crynobone I'm not at a computer at the moment, but one of the other templates in the mail folder had the parse method with the unescaped blade {!! !!}

@jbraband
Copy link
Author

@crynobone I'm not at a computer at the moment, but one of the other templates in the mail folder had the parse method with the unescaped blade {!! !!}

It's panel.blade.php @crynobone

@jbraband
Copy link
Author

@crynobone I'm not at a computer at the moment, but one of the other templates in the mail folder had the parse method with the unescaped blade {!! !!}

It's panel.blade.php @crynobone

Was able to commit it from mobile

@jbraband
Copy link
Author

I'll look to add a test for panel in the morning (CST)

@crynobone
wip
7e40482 
Signed-off-by: Mior Muhammad Zaki <[email protected]>
@crynobone crynobone changed the title [11.x] Do not escape slots in additional mail components [11.x] Fix EncodedHtmlString to ignore instance of HtmlString Apr 25, 2025
@crynobone crynobone merged commit ec51a66 into laravel:11.x Apr 25, 2025
57 checks passed
@jbraband
Copy link
Author

Thanks @crynobone!

🎉

@stefvanesch stefvanesch mentioned this pull request Apr 28, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crynobone crynobone crynobone approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jbraband @crynobone