feature #58989 [VarDumper] Add caster for AddressInfo objects (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit baf98b91dbf5 · 2024-11-28T15:08:53.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [VarDumper] Add caster for `AddressInfo` objects | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | - | License | MIT ![image](https://github.com/user-attachments/assets/d596aba6-aba7-4673-bf79-6314f215f324) Commits ------- 9d85c55 [VarDumper] Add caster for AddressInfo objects
diff --git a/src/Symfony/Component/VarDumper/Caster/AddressInfoCaster.php b/src/Symfony/Component/VarDumper/Caster/AddressInfoCaster.php
@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Caster;
+
+use Symfony\Component\VarDumper\Cloner\Stub;
+
+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+final class AddressInfoCaster
+{
+    private const MAPS = [
+        'ai_flags' => [
+            1 => 'AI_PASSIVE',
+            2 => 'AI_CANONNAME',
+            4 => 'AI_NUMERICHOST',
+            8 => 'AI_V4MAPPED',
+            16 => 'AI_ALL',
+            32 => 'AI_ADDRCONFIG',
+            64 => 'AI_IDN',
+            128 => 'AI_CANONIDN',
+            1024 => 'AI_NUMERICSERV',
+        ],
+        'ai_family' => [
+            1 => 'AF_UNIX',
+            2 => 'AF_INET',
+            10 => 'AF_INET6',
+            44 => 'AF_DIVERT',
+        ],
+        'ai_socktype' => [
+            1 => 'SOCK_STREAM',
+            2 => 'SOCK_DGRAM',
+            3 => 'SOCK_RAW',
+            4 => 'SOCK_RDM',
+            5 => 'SOCK_SEQPACKET',
+        ],
+        'ai_protocol' => [
+            1 => 'SOL_SOCKET',
+            6 => 'SOL_TCP',
+            17 => 'SOL_UDP',
+            136 => 'SOL_UDPLITE',
+        ],
+    ];
+
+    public static function castAddressInfo(\AddressInfo $h, array $a, Stub $stub, bool $isNested): array
+    {
+        static $resolvedMaps;
+
+        if (!$resolvedMaps) {
+            foreach (self::MAPS as $k => $map) {
+                foreach ($map as $v => $name) {
+                    if (\defined($name)) {
+                        $resolvedMaps[$k][\constant($name)] = $name;
+                    } elseif (!isset($resolvedMaps[$k][$v])) {
+                        $resolvedMaps[$k][$v] = $name;
+                    }
+                }
+            }
+        }
+
+        foreach (socket_addrinfo_explain($h) as $k => $v) {
+            $a[Caster::PREFIX_VIRTUAL.$k] = match (true) {
+                'ai_flags' === $k => ConstStub::fromBitfield($v, $resolvedMaps[$k]),
+                isset($resolvedMaps[$k][$v]) => new ConstStub($resolvedMaps[$k][$v], $v),
+                default => $v,
+            };
+        }
+
+        return $a;
+    }
+}
diff --git a/src/Symfony/Component/VarDumper/Caster/ConstStub.php b/src/Symfony/Component/VarDumper/Caster/ConstStub.php
@@ -30,4 +30,23 @@ public function __toString(): string
     {
         return (string) $this->value;
     }
+
+    /**
+     * @param array<int, string> $values
+     */
+    public static function fromBitfield(int $value, array $values): self
+    {
+        $names = [];
+        foreach ($values as $v => $name) {
+            if ($value & $v) {
+                $names[] = $name;
+            }
+        }
+
+        if (!$names) {
+            $names[] = $values[0] ?? 0;
+        }
+
+        return new self(implode(' | ', $names), $value);
+    }
 }
diff --git a/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php b/src/Symfony/Component/VarDumper/Cloner/AbstractCloner.php
@@ -24,6 +24,8 @@ abstract class AbstractCloner implements ClonerInterface
     public static array $defaultCasters = [
         '__PHP_Incomplete_Class' => ['Symfony\Component\VarDumper\Caster\Caster', 'castPhpIncompleteClass'],
 
+        'AddressInfo' => ['Symfony\Component\VarDumper\Caster\AddressInfoCaster', 'castAddressInfo'],
+
         'Symfony\Component\VarDumper\Caster\CutStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
         'Symfony\Component\VarDumper\Caster\CutArrayStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castCutArray'],
         'Symfony\Component\VarDumper\Caster\ConstStub' => ['Symfony\Component\VarDumper\Caster\StubCaster', 'castStub'],
diff --git a/src/Symfony/Component/VarDumper/Tests/Caster/AddressInfoCasterTest.php b/src/Symfony/Component/VarDumper/Tests/Caster/AddressInfoCasterTest.php
@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\VarDumper\Tests\Caster;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\VarDumper\Test\VarDumperTestTrait;
+
+/**
+ * @requires extension sockets
+ */
+class AddressInfoCasterTest extends TestCase
+{
+    use VarDumperTestTrait;
+
+    public function testCaster()
+    {
+        $xDump = <<<EODUMP
+AddressInfo {
+  ai_flags: 0
+  ai_family: AF_INET%A
+}
+EODUMP;
+
+        $this->assertDumpMatchesFormat($xDump, socket_addrinfo_lookup('localhost')[0]);
+    }
+}
