[VarDumper] Only select HtmlDumper if Accept header is set with non-cli SAPI

alexandre-daubois · alexandre-daubois · commit 21042dfa258a · 2024-08-23T14:04:46.000+02:00
diff --git a/src/Symfony/Component/VarDumper/CHANGELOG.md b/src/Symfony/Component/VarDumper/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add support for `FORCE_COLOR` environment variable
  * Add support for virtual properties
+ * Add automatic HTML output when `Accept: text/html` is set in the request headers
 
 7.1
 ---
diff --git a/src/Symfony/Component/VarDumper/Tests/Dumper/functions/dump_with_accept_header_html.phpt b/src/Symfony/Component/VarDumper/Tests/Dumper/functions/dump_with_accept_header_html.phpt
@@ -0,0 +1,16 @@
+--TEST--
+Test dump() with "Accept: text/html" uses CLI dumper with CLI SAPI
+--FILE--
+<?php
+putenv('NO_COLOR=1');
+
+$vendor = __DIR__;
+while (!file_exists($vendor.'/vendor')) {
+    $vendor = \dirname($vendor);
+}
+require $vendor.'/vendor/autoload.php';
+
+$_SERVER['HTTP_ACCEPT'] = 'text/html';
+dump('Test with HTML');
+--EXPECT--
+"Test with HTML"
diff --git a/src/Symfony/Component/VarDumper/VarDumper.php b/src/Symfony/Component/VarDumper/VarDumper.php
@@ -21,6 +21,7 @@
 use Symfony\Component\VarDumper\Dumper\ContextProvider\RequestContextProvider;
 use Symfony\Component\VarDumper\Dumper\ContextProvider\SourceContextProvider;
 use Symfony\Component\VarDumper\Dumper\ContextualizedDumper;
+use Symfony\Component\VarDumper\Dumper\DataDumperInterface;
 use Symfony\Component\VarDumper\Dumper\HtmlDumper;
 use Symfony\Component\VarDumper\Dumper\ServerDumper;
 
@@ -76,11 +77,11 @@ private static function register(): void
             case 'server' === $format:
             case $format && 'tcp' === parse_url($format, \PHP_URL_SCHEME):
                 $host = 'server' === $format ? $_SERVER['VAR_DUMPER_SERVER'] ?? '127.0.0.1:9912' : $format;
-                $dumper = \in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true) ? new CliDumper() : new HtmlDumper();
+                $dumper = self::guessMostSuitableDumper();
                 $dumper = new ServerDumper($host, $dumper, self::getDefaultContextProviders());
                 break;
             default:
-                $dumper = \in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true) ? new CliDumper() : new HtmlDumper();
+                $dumper = self::guessMostSuitableDumper();
         }
 
         if (!$dumper instanceof ServerDumper) {
@@ -115,4 +116,18 @@ private static function getDefaultContextProviders(): array
             'source' => new SourceContextProvider(null, null, $fileLinkFormatter),
         ];
     }
+
+    private static function guessMostSuitableDumper(): DataDumperInterface
+    {
+        if (\in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true)) {
+            return new CliDumper();
+        }
+
+        $accepted = array_map('trim', explode(',', $_SERVER['HTTP_ACCEPT'] ?? ''));
+        if (array_intersect($accepted, ['text/html', '*/*'])) {
+            return new HtmlDumper();
+        }
+
+        return new CliDumper();
+    }
 }
