bug #52618 [VarExporter] Fix handling mangled property names returned by __sleep() (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit a85ffa95c98c · 2023-11-17T11:47:07.000+01:00
This PR was merged into the 5.4 branch. Discussion ---------- [VarExporter] Fix handling mangled property names returned by __sleep() | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #52614 | License | MIT Did you know that __sleep can return mangled property names? I didn't :) https://3v4l.org/3ckU7 Fixes doctrine/orm#11063 also. Commits ------- c5bd676 [VarExporter] Fix handling mangled property names returned by __sleep()
diff --git a/src/Symfony/Component/VarExporter/Internal/Exporter.php b/src/Symfony/Component/VarExporter/Internal/Exporter.php
@@ -157,21 +157,19 @@ public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount
                     $n = substr($n, 1 + $i);
                 }
                 if (null !== $sleep) {
-                    if (!isset($sleep[$n]) || ($i && $c !== $class)) {
+                    if (!isset($sleep[$name]) && (!isset($sleep[$n]) || ($i && $c !== $class))) {
                         unset($arrayValue[$name]);
                         continue;
                     }
-                    $sleep[$n] = false;
+                    unset($sleep[$name], $sleep[$n]);
                 }
                 if (!\array_key_exists($name, $proto) || $proto[$name] !== $v || "\x00Error\x00trace" === $name || "\x00Exception\x00trace" === $name) {
                     $properties[$c][$n] = $v;
                 }
             }
             if ($sleep) {
                 foreach ($sleep as $n => $v) {
-                    if (false !== $v) {
-                        trigger_error(sprintf('serialize(): "%s" returned as member variable from __sleep() but does not exist', $n), \E_USER_NOTICE);
-                    }
+                    trigger_error(sprintf('serialize(): "%s" returned as member variable from __sleep() but does not exist', $n), \E_USER_NOTICE);
                 }
             }
             if (method_exists($class, '__unserialize')) {
diff --git a/src/Symfony/Component/VarExporter/Tests/Fixtures/var-on-sleep.php b/src/Symfony/Component/VarExporter/Tests/Fixtures/var-on-sleep.php
@@ -11,6 +11,14 @@
                 'night',
             ],
         ],
+        'Symfony\\Component\\VarExporter\\Tests\\GoodNight' => [
+            'foo' => [
+                'afternoon',
+            ],
+            'bar' => [
+                'morning',
+            ],
+        ],
     ],
     $o[0],
     []
diff --git a/src/Symfony/Component/VarExporter/Tests/VarExporterTest.php b/src/Symfony/Component/VarExporter/Tests/VarExporterTest.php
@@ -349,17 +349,21 @@ public function setFlags($flags): void
 class GoodNight
 {
     public $good;
+    protected $foo;
+    private $bar;
 
     public function __construct()
     {
         unset($this->good);
+        $this->foo = 'afternoon';
+        $this->bar = 'morning';
     }
 
     public function __sleep(): array
     {
         $this->good = 'night';
 
-        return ['good'];
+        return ['good', 'foo', "\0*\0foo", "\0".__CLASS__."\0bar"];
     }
 }
 
diff --git a/src/Symfony/Component/VarExporter/VarExporter.php b/src/Symfony/Component/VarExporter/VarExporter.php
@@ -83,7 +83,7 @@ public static function export($value, bool &$isStaticValue = null, array &$found
         ksort($states);
 
         $wakeups = [null];
-        foreach ($states as $k => $v) {
+        foreach ($states as $v) {
             if (\is_array($v)) {
                 $wakeups[-$v[0]] = $v[1];
             } else {

Original file line number	Diff line number	Diff line change
`@@ -157,21 +157,19 @@ public static function prepare($values, $objectsPool, &$refsPool, &$objectsCount`
`157`	`157`	`$n = substr($n, 1 + $i);`
`158`	`158`	`}`
`159`	`159`	`if (null !== $sleep) {`
`160`		`- if (!isset($sleep[$n]) \|\| ($i && $c !== $class)) {`
	`160`	`+ if (!isset($sleep[$name]) && (!isset($sleep[$n]) \|\| ($i && $c !== $class))) {`
`161`	`161`	`unset($arrayValue[$name]);`
`162`	`162`	`continue;`
`163`	`163`	`}`
`164`		`- $sleep[$n] = false;`
	`164`	`+ unset($sleep[$name], $sleep[$n]);`
`165`	`165`	`}`
`166`	`166`	`if (!\array_key_exists($name, $proto) \|\| $proto[$name] !== $v \|\| "\x00Error\x00trace" === $name \|\| "\x00Exception\x00trace" === $name) {`
`167`	`167`	`$properties[$c][$n] = $v;`
`168`	`168`	`}`
`169`	`169`	`}`
`170`	`170`	`if ($sleep) {`
`171`	`171`	`foreach ($sleep as $n => $v) {`
`172`		`- if (false !== $v) {`
`173`		`- trigger_error(sprintf('serialize(): "%s" returned as member variable from __sleep() but does not exist', $n), \E_USER_NOTICE);`
`174`		`- }`
	`172`	`+ trigger_error(sprintf('serialize(): "%s" returned as member variable from __sleep() but does not exist', $n), \E_USER_NOTICE);`
`175`	`173`	`}`
`176`	`174`	`}`
`177`	`175`	`if (method_exists($class, '__unserialize')) {`
Original file line number	Diff line number	Diff line change
`@@ -349,17 +349,21 @@ public function setFlags($flags): void`
`349`	`349`	`class GoodNight`
`350`	`350`	`{`
`351`	`351`	`public $good;`
	`352`	`+ protected $foo;`
	`353`	`+ private $bar;`
`352`	`354`
`353`	`355`	`public function __construct()`
`354`	`356`	`{`
`355`	`357`	`unset($this->good);`
	`358`	`+ $this->foo = 'afternoon';`
	`359`	`+ $this->bar = 'morning';`
`356`	`360`	`}`
`357`	`361`
`358`	`362`	`public function __sleep(): array`
`359`	`363`	`{`
`360`	`364`	`$this->good = 'night';`
`361`	`365`
`362`		`- return ['good'];`
	`366`	`+ return ['good', 'foo', "\0*\0foo", "\0".__CLASS__."\0bar"];`
`363`	`367`	`}`
`364`	`368`	`}`
`365`	`369`