Add Illuminate\Support\EncodedHtmlString (#54737)

* wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * Apply fixes from StyleCI * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * Apply fixes from StyleCI * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * Update EncodedHtmlString.php * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * Apply fixes from StyleCI * Update EncodedHtmlString.php * Update Markdown.php * Update src/Illuminate/Mail/Markdown.php Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * Apply fixes from StyleCI * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * formatting * formatting " --------- Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com> Co-authored-by: Taylor Otwell <taylor@laravel.com>

Author: 4 people

src/Illuminate/Foundation/Testing/Concerns/InteractsWithTestCaseLifecycle.php

@@ -26,6 +26,7 @@
 use Illuminate\Queue\Console\WorkCommand;
 use Illuminate\Queue\Queue;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\EncodedHtmlString;
 use Illuminate\Support\Facades\Facade;
 use Illuminate\Support\Facades\ParallelTesting;
 use Illuminate\Support\Once;
@@ -171,6 +172,7 @@ protected function tearDownTheTestEnvironment(): void
  Component::forgetFactory();
  ConvertEmptyStringsToNull::flushState();
  Factory::flushState();
+ EncodedHtmlString::flushState();
  EncryptCookies::flushState();
  HandleExceptions::flushState();
  Migrator::withoutMigrations([]);

src/Illuminate/Mail/Mailable.php

@@ -13,6 +13,7 @@
 use Illuminate\Contracts\Support\Renderable;
 use Illuminate\Contracts\Translation\HasLocalePreference;
 use Illuminate\Support\Collection;
+use Illuminate\Support\EncodedHtmlString;
 use Illuminate\Support\HtmlString;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Conditionable;
@@ -1371,7 +1372,7 @@ public function assertHasSubject($subject)
  */
  public function assertSeeInHtml($string, $escape = true)
  {
- $string = $escape ? e($string) : $string;
+ $string = $escape ? EncodedHtmlString::convert($string, withQuote: isset($this->markdown)) : $string;
 
  [$html, $text] = $this->renderForAssertions();
 
@@ -1393,7 +1394,7 @@ public function assertSeeInHtml($string, $escape = true)
  */
  public function assertDontSeeInHtml($string, $escape = true)
  {
- $string = $escape ? e($string) : $string;
+ $string = $escape ? EncodedHtmlString::convert($string, withQuote: isset($this->markdown)) : $string;
 
  [$html, $text] = $this->renderForAssertions();
 
@@ -1415,7 +1416,9 @@ public function assertDontSeeInHtml($string, $escape = true)
  */
  public function assertSeeInOrderInHtml($strings, $escape = true)
  {
- $strings = $escape ? array_map('e', $strings) : $strings;
+ $strings = $escape ? array_map(function ($string) {
+ return EncodedHtmlString::convert($string, withQuote: isset($this->markdown));
+ }, $strings) : $strings;
 
  [$html, $text] = $this->renderForAssertions();
 

src/Illuminate/Mail/Markdown.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Mail;
 
 use Illuminate\Contracts\View\Factory as ViewFactory;
+use Illuminate\Support\EncodedHtmlString;
 use Illuminate\Support\HtmlString;
 use Illuminate\Support\Str;
 use League\CommonMark\Environment\Environment;
@@ -60,9 +61,19 @@ public function render($view, array $data = [], $inliner = null)
  {
  $this->view->flushFinderCache();
 
- $contents = $this->view->replaceNamespace(
- 'mail', $this->htmlComponentPaths()
- )->make($view, $data)->render();
+ $bladeCompiler = $this->view
+ ->getEngineResolver()
+ ->resolve('blade')
+ ->getCompiler();
+
+ $contents = $bladeCompiler->usingEchoFormat(
+ 'new \Illuminate\Support\EncodedHtmlString(%s)',
+ function () use ($view, $data) {
+ return $this->view->replaceNamespace(
+ 'mail', $this->htmlComponentPaths()
+ )->make($view, $data)->render();
+ }
+ );
 
  if ($this->view->exists($customTheme = Str::start($this->theme, 'mail.'))) {
  $theme = $customTheme;
@@ -105,16 +116,48 @@ public function renderText($view, array $data = [])
  */
  public static function parse($text)
  {
- $environment = new Environment([
+ EncodedHtmlString::encodeUsing(function ($value) {
+ $replacements = [
+ '[' => '\[',
+ '<' => '\<',
+ ];
+
+ $html = str_replace(array_keys($replacements), array_values($replacements), $value);
+
+ return static::converter([
+ 'html_input' => 'escape',
+ ])->convert($html)->getContent();
+ });
+
+ $html = '';
+
+ try {
+ $html = static::converter()->convert($text)->getContent();
+ } finally {
+ EncodedHtmlString::flushState();
+ }
+
+ return new HtmlString($html);
+ }
+
+ /**
+ * Get a Markdown converter instance.
+ *
+ * @internal
+ *
+ * @param array<string, mixed> $config
+ * @return \League\CommonMark\MarkdownConverter
+ */
+ public static function converter(array $config = [])
+ {
+ $environment = new Environment(array_merge([
  'allow_unsafe_links' => false,
- ]);
+ ], $config));
 
  $environment->addExtension(new CommonMarkCoreExtension);
  $environment->addExtension(new TableExtension);
 
- $converter = new MarkdownConverter($environment);
-
- return new HtmlString($converter->convert($text)->getContent());
+ return new MarkdownConverter($environment);
  }
 
  /**

src/Illuminate/Support/EncodedHtmlString.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Illuminate\Support;
+
+class EncodedHtmlString extends HtmlString
+{
+ /**
+ * The callback that should be used to encode the HTML strings.
+ *
+ * @var callable|null
+ */
+ protected static $encodeUsingFactory;
+
+ /**
+ * Create a new encoded HTML string instance.
+ *
+ * @param string $html
+ * @param bool $doubleEncode
+ * @return void
+ */
+ public function __construct($html = '', protected bool $doubleEncode = true)
+ {
+ parent::__construct($html);
+ }
+
+ /**
+ * Convert the special characters in the given value.
+ *
+ * @internal
+ *
+ * @param string|null $value
+ * @param int $withQuote
+ * @param bool $doubleEncode
+ * @return string
+ */
+ public static function convert($value, bool $withQuote = true, bool $doubleEncode = true)
+ {
+ $flag = $withQuote ? ENT_QUOTES : ENT_NOQUOTES;
+
+ return htmlspecialchars($value ?? '', $flag | ENT_SUBSTITUTE, 'UTF-8', $doubleEncode);
+ }
+
+ /**
+ * Get the HTML string.
+ *
+ * @return string
+ */
+ #[\Override]
+ public function toHtml()
+ {
+ return (static::$encodeUsingFactory ?? function ($value, $doubleEncode) {
+ return static::convert($value, doubleEncode: $doubleEncode);
+ })($this->html, $this->doubleEncode);
+ }
+
+ /**
+ * Set the callable that will be used to encode the HTML strings.
+ *
+ * @param callable|null $factory
+ * @return void
+ */
+ public static function encodeUsing(?callable $factory = null)
+ {
+ static::$encodeUsingFactory = $factory;
+ }
+
+ /**
+ * Flush the class's global state.
+ *
+ * @return void
+ */
+ public static function flushState()
+ {
+ static::$encodeUsingFactory = null;
+ }
+}

src/Illuminate/View/Compilers/BladeCompiler.php

@@ -1003,6 +1003,28 @@ public function precompiler(callable $precompiler)
  $this->precompilers[] = $precompiler;
  }
 
+ /**
+ * Execute the given callback using a custom echo format.
+ *
+ * @param string $format
+ * @param callable $callback
+ * @return string
+ */
+ public function usingEchoFormat($format, callable $callback)
+ {
+ $originalEchoFormat = $this->echoFormat;
+
+ $this->setEchoFormat($format);
+
+ try {
+ $output = call_user_func($callback);
+ } finally {
+ $this->setEchoFormat($originalEchoFormat);
+ }
+
+ return $output;
+ }
+
  /**
  * Set the echo format to be used by the compiler.
  *

tests/Integration/Mail/MailableTest.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Mail;
+
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Orchestra\Testbench\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+class MailableTest extends TestCase
+{
+ /** {@inheritdoc} */
+ #[\Override]
+ protected function defineEnvironment($app)
+ {
+ $app['view']->addLocation(__DIR__.'/Fixtures');
+ }
+
+ #[DataProvider('markdownEncodedDataProvider')]
+ public function testItCanAssertMarkdownEncodedString($given, $expected)
+ {
+ $mailable = new class($given) extends Mailable
+ {
+ public function __construct(public string $message)
+ {
+ //
+ }
+
+ public function envelope()
+ {
+ return new Envelope(
+ subject: 'My basic title',
+ );
+ }
+
+ public function content()
+ {
+ return new Content(
+ markdown: 'message',
+ );
+ }
+ };
+
+ $mailable->assertSeeInHtml($expected, false);
+ }
+
+ public static function markdownEncodedDataProvider()
+ {
+ yield ['[Laravel](https://laravel.com)', 'My message is: [Laravel](https://laravel.com)'];
+
+ yield [
+ '![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)',
+ 'My message is: ![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)',
+ ];
+
+ yield [
+ 'Visit https://laravel.com/docs to browse the documentation',
+ 'My message is: Visit https://laravel.com/docs to browse the documentation',
+ ];
+
+ yield [
+ 'Visit <https://laravel.com/docs> to browse the documentation',
+ 'My message is: Visit &lt;https://laravel.com/docs&gt; to browse the documentation',
+ ];
+
+ yield [
+ 'Visit <span>https://laravel.com/docs</span> to browse the documentation',
+ 'My message is: Visit &lt;span&gt;https://laravel.com/docs&lt;/span&gt; to browse the documentation',
+ ];
+ }
+}

tests/Integration/Mail/MarkdownParserTest.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Mail;
+
+use Illuminate\Mail\Markdown;
+use Illuminate\Support\EncodedHtmlString;
+use Illuminate\Support\HtmlString;
+use Orchestra\Testbench\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+class MarkdownParserTest extends TestCase
+{
+ #[DataProvider('markdownDataProvider')]
+ public function testItCanParseMarkdownString($given, $expected)
+ {
+ tap(Markdown::parse($given), function ($html) use ($expected) {
+ $this->assertInstanceOf(HtmlString::class, $html);
+
+ $this->assertStringEqualsStringIgnoringLineEndings($expected.PHP_EOL, (string) $html);
+ $this->assertSame((string) $html, (string) $html->toHtml());
+ });
+ }
+
+ #[DataProvider('markdownEncodedDataProvider')]
+ public function testItCanParseMarkdownEncodedString($given, $expected)
+ {
+ tap(Markdown::parse($given), function ($html) use ($expected) {
+ $this->assertInstanceOf(HtmlString::class, $html);
+
+ $this->assertStringEqualsStringIgnoringLineEndings($expected.PHP_EOL, (string) $html);
+ });
+ }
+
+ public static function markdownDataProvider()
+ {
+ yield ['[Laravel](https://laravel.com)', '<p><a href="https://laravel.com">Laravel</a></p>'];
+ yield ['\[Laravel](https://laravel.com)', '<p>[Laravel](https://laravel.com)</p>'];
+ yield ['![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)', '<p><img src="https://laravel.com/assets/img/welcome/background.svg" alt="Welcome to Laravel" /></p>'];
+ yield ['!\[Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)', '<p>![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)</p>'];
+ yield ['Visit https://laravel.com/docs to browse the documentation', '<p>Visit https://laravel.com/docs to browse the documentation</p>'];
+ yield ['Visit <https://laravel.com/docs> to browse the documentation', '<p>Visit <a href="https://laravel.com/docs">https://laravel.com/docs</a> to browse the documentation</p>'];
+ yield ['Visit <span>https://laravel.com/docs</span> to browse the documentation', '<p>Visit <span>https://laravel.com/docs</span> to browse the documentation</p>'];
+ }
+
+ public static function markdownEncodedDataProvider()
+ {
+ yield [new EncodedHtmlString('[Laravel](https://laravel.com)'), '<p>[Laravel](https://laravel.com)</p>'];
+
+ yield [
+ new EncodedHtmlString('![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)'),
+ '<p>![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)</p>',
+ ];
+
+ yield [
+ new EncodedHtmlString('Visit https://laravel.com/docs to browse the documentation'),
+ '<p>Visit https://laravel.com/docs to browse the documentation</p>',
+ ];
+
+ yield [
+ new EncodedHtmlString('Visit <https://laravel.com/docs> to browse the documentation'),
+ '<p>Visit &lt;https://laravel.com/docs&gt; to browse the documentation</p>',
+ ];
+
+ yield [
+ new EncodedHtmlString('Visit <span>https://laravel.com/docs</span> to browse the documentation'),
+ '<p>Visit &lt;span&gt;https://laravel.com/docs&lt;/span&gt; to browse the documentation</p>',
+ ];
+
+ yield [
+ '![Welcome to Laravel](https://laravel.com/assets/img/welcome/background.svg)<br />'.new EncodedHtmlString('Visit <span>https://laravel.com/docs</span> to browse the documentation'),
+ '<p><img src="https://laravel.com/assets/img/welcome/background.svg" alt="Welcome to Laravel" /><br />Visit &lt;span&gt;https://laravel.com/docs&lt;/span&gt; to browse the documentation</p>',
+ ];
+ }
+}