[VarDumper] Add VAR_DUMPER_FORMAT=server format

Author: ogizanagi

src/Symfony/Component/VarDumper/CHANGELOG.md

@@ -5,6 +5,8 @@ CHANGELOG
 -----
 
  * added `RdKafka` support
+ * added `VAR_DUMPER_FORMAT=server` support
+ * register & lock the handler to use as soon as the `VAR_DUMPER_FORMAT` env var is set
 
 4.4.0
 -----

src/Symfony/Component/VarDumper/Resources/functions/dump.php

@@ -11,6 +11,11 @@
 
 use Symfony\Component\VarDumper\VarDumper;
 
+// Register & lock the handler with expected format as soon as the env var was set:
+if (isset($_SERVER['VAR_DUMPER_FORMAT'])) {
+    VarDumper::register(true);
+}
+
 if (!function_exists('dump')) {
     /**
      * @author Nicolas Grekas <p@tchwork.com>

src/Symfony/Component/VarDumper/VarDumper.php

@@ -11,12 +11,19 @@
 
 namespace Symfony\Component\VarDumper;
 
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Symfony\Component\VarDumper\Caster\ReflectionCaster;
 use Symfony\Component\VarDumper\Cloner\VarCloner;
 use Symfony\Component\VarDumper\Dumper\CliDumper;
+use Symfony\Component\VarDumper\Dumper\ContextProvider\CliContextProvider;
+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;
 
 // Load the global dump() function
 require_once __DIR__.'/Resources/functions/dump.php';
@@ -27,34 +34,87 @@
 class VarDumper
 {
     private static $handler;
+    private static $locked = false;
 
-    public static function dump($var)
+    /**
+     * @final
+     *
+     * @param bool $lock lock the registered handler so it cannot be replaced
+     */
+    public static function register(bool $lock = false): void
     {
-        if (null === self::$handler) {
-            $cloner = new VarCloner();
-            $cloner->addCasters(ReflectionCaster::UNSET_CLOSURE_FILE_INFO);
+        self::$locked = $lock;
+        $cloner = new VarCloner();
+        $cloner->addCasters(ReflectionCaster::UNSET_CLOSURE_FILE_INFO);
+
+        switch ($_SERVER['VAR_DUMPER_FORMAT'] ?? null) {
+            case 'html':
+                $dumper = new HtmlDumper();
+                break;
+            case 'cli':
+                $dumper = new CliDumper();
+                break;
+            case 'server':
+                $host = $_SERVER['VAR_DUMPER_SERVER'] ?? '127.0.0.1:9912';
+                $dumper = new ServerDumper($host, self::getDefaultDumper(), self::getDefaultContextProviders());
+                break;
+            default:
+                $dumper = self::getDefaultDumper();
+        }
 
-            if (isset($_SERVER['VAR_DUMPER_FORMAT'])) {
-                $dumper = 'html' === $_SERVER['VAR_DUMPER_FORMAT'] ? new HtmlDumper() : new CliDumper();
-            } else {
-                $dumper = \in_array(\PHP_SAPI, ['cli', 'phpdbg']) ? new CliDumper() : new HtmlDumper();
-            }
+        $dumper = !$dumper instanceof ServerDumper ? new ContextualizedDumper($dumper, [new SourceContextProvider()]) : $dumper;
 
-            $dumper = new ContextualizedDumper($dumper, [new SourceContextProvider()]);
+        self::$handler = function ($var) use ($cloner, $dumper) {
+            $dumper->dump($cloner->cloneVar($var));
+        };
+    }
 
-            self::$handler = function ($var) use ($cloner, $dumper) {
-                $dumper->dump($cloner->cloneVar($var));
-            };
+    public static function dump($var)
+    {
+        if (null === self::$handler) {
+            self::register();
         }
 
         return (self::$handler)($var);
     }
 
     public static function setHandler(callable $callable = null)
     {
+        $lock = \func_num_args() > 1 ? func_get_arg(1) : false;
         $prevHandler = self::$handler;
+
+        if (self::$locked) {
+            return $prevHandler;
+        }
+        if ($lock) {
+            self::$locked = true;
+        }
+
         self::$handler = $callable;
 
         return $prevHandler;
     }
+
+    private static function getDefaultDumper(): DataDumperInterface
+    {
+        return \in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? new CliDumper() : new HtmlDumper();
+    }
+
+    private static function getDefaultContextProviders(): array
+    {
+        $contextProviders = [];
+
+        if ('cli' !== \PHP_SAPI && (class_exists(Request::class))) {
+            $requestStack = new RequestStack();
+            $requestStack->push(Request::createFromGlobals());
+            $contextProviders['request'] = new RequestContextProvider($requestStack);
+        }
+
+        $fileLinkFormatter = class_exists(FileLinkFormatter::class) ? new FileLinkFormatter(null, $requestStack ?? null) : null;
+
+        return $contextProviders + [
+            'cli' => new CliContextProvider(),
+            'source' => new SourceContextProvider(null, null, $fileLinkFormatter),
+        ];
+    }
 }