Partially deprecate Serializable

nikic · nikic · commit 6326389bc7e4 · 2020-12-07T16:17:17.000+01:00
If Serializable is implemented, require that __serialize() and
__unserialize() are implemented as well, else issue a deprecation
warning.
diff --git a/Zend/tests/bug64354.phpt b/Zend/tests/bug64354.phpt
@@ -20,5 +20,6 @@ try {
     var_dump($e->getMessage());
 }
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 string(9) "serialize"
diff --git a/Zend/tests/serializable_deprecation.phpt b/Zend/tests/serializable_deprecation.phpt
@@ -0,0 +1,23 @@
+--TEST--
+Serializable deprecation
+--FILE--
+<?php
+
+interface I extends Serializable {}
+abstract class A implements Serializable {}
+
+class C extends A implements I {
+    public function serialize(): string {}
+    public function unserialize(string $data) {}
+}
+
+class D extends A implements I {
+    public function serialize(): string {}
+    public function unserialize(string $data) {}
+    public function __serialize(): array {}
+    public function __unserialize(array $data) {}
+}
+
+?>
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line 6
diff --git a/Zend/tests/traits/interface_003.phpt b/Zend/tests/traits/interface_003.phpt
@@ -21,6 +21,7 @@ var_dump(unserialize($o));
 
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 string(20) "C:3:"bar":6:{foobar}"
 string(6) "foobar"
 object(bar)#%d (0) {
diff --git a/Zend/zend_interfaces.c b/Zend/zend_interfaces.c
@@ -429,6 +429,10 @@ static int zend_implement_serializable(zend_class_entry *interface, zend_class_e
 	if (!class_type->unserialize) {
 		class_type->unserialize = zend_user_unserialize;
 	}
+	if (!(class_type->ce_flags & ZEND_ACC_EXPLICIT_ABSTRACT_CLASS)
+			&& (!class_type->__serialize || !class_type->__unserialize)) {
+		zend_error(E_DEPRECATED, "The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them");
+	}
 	return SUCCESS;
 }
 /* }}}*/
diff --git a/ext/session/tests/bug79031.phpt b/ext/session/tests/bug79031.phpt
@@ -48,22 +48,29 @@ echo "\n\n";
 var_dump($_SESSION);
 
 ?>
---EXPECT--
-obj1|C:17:"SerializableClass":65:{a:1:{s:10:"sharedProp";O:8:"stdClass":1:{s:4:"name";s:4:"test";}}}obj2|C:17:"SerializableClass":28:{a:1:{s:10:"sharedProp";r:3;}}
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
+Warning: session_start(): Session cannot be started after headers have already been sent in %s on line %d
+
+Warning: session_encode(): Cannot encode non-existent session in %s on line %d
+
+Warning: session_decode(): Session data cannot be decoded when there is no active session in %s on line %d
+
 
 array(2) {
   ["obj1"]=>
-  object(SerializableClass)#4 (1) {
+  object(SerializableClass)#2 (1) {
     ["sharedProp"]=>
-    object(stdClass)#5 (1) {
+    object(stdClass)#1 (1) {
       ["name"]=>
       string(4) "test"
     }
   }
   ["obj2"]=>
-  object(SerializableClass)#6 (1) {
+  object(SerializableClass)#3 (1) {
     ["sharedProp"]=>
-    object(stdClass)#5 (1) {
+    object(stdClass)#1 (1) {
       ["name"]=>
       string(4) "test"
     }
diff --git a/ext/standard/tests/serialize/005.phpt b/ext/standard/tests/serialize/005.phpt
@@ -128,6 +128,7 @@ echo "===AutoNA===\n";
 var_dump(unserialize('O:22:"autoload_not_available":0:{}'));
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 ===O1===
 TestOld::__sleep()
 string(18) "O:7:"TestOld":0:{}"
@@ -152,12 +153,16 @@ object(TestNAOld)#%d (0) {
 ===NANew===
 unserializer(TestNANew)
 
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
 Warning: Erroneous data format for unserializing 'TestNANew' in %s005.php on line %d
 
 Notice: unserialize(): Error at offset 19 of 20 bytes in %s005.php on line %d
 bool(false)
 ===NANew2===
 unserializer(TestNANew2)
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 TestNew::unserialize()
 object(TestNANew2)#%d (0) {
 }
diff --git a/ext/standard/tests/serialize/bug36424.phpt b/ext/standard/tests/serialize/bug36424.phpt
@@ -44,7 +44,13 @@ echo "Done\n";
 
 ?>
 --EXPECTF--
-%aTEST
+-TEST
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 C:1:"c":108:{a:1:{s:1:"a";C:1:"a":81:{a:3:{s:1:"b";C:1:"b":30:{a:2:{s:1:"c";r:1;s:1:"a";r:3;}}s:1:"c";r:1;s:1:"a";r:3;}}}}
 bool(true)
 bool(true)
diff --git a/ext/standard/tests/serialize/bug64146.phpt b/ext/standard/tests/serialize/bug64146.phpt
@@ -53,8 +53,10 @@ print $a->a[1]->b->c . "\n";
 
 ?>
 Done
---EXPECT--
+--EXPECTF--
 Test
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 1
 2
 Done
diff --git a/ext/standard/tests/serialize/bug64354_3.phpt b/ext/standard/tests/serialize/bug64354_3.phpt
@@ -25,5 +25,6 @@ try {
     var_dump($e->getMessage());
 }
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 string(6) "Failed"
diff --git a/ext/standard/tests/serialize/bug65481.phpt b/ext/standard/tests/serialize/bug65481.phpt
@@ -35,6 +35,8 @@ $token = serialize($token);
 
 ?>
 Done
---EXPECT--
+--EXPECTF--
 Test
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 Done
diff --git a/ext/standard/tests/serialize/bug70172.phpt b/ext/standard/tests/serialize/bug70172.phpt
@@ -41,6 +41,7 @@ function ptr2str($ptr)
 }
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 array(2) {
   [0]=>
   int(1)
diff --git a/ext/standard/tests/serialize/bug70172_2.phpt b/ext/standard/tests/serialize/bug70172_2.phpt
@@ -48,6 +48,7 @@ function ptr2str($ptr)
 }
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 array(2) {
   [0]=>
   object(obj2)#%d (1) {
diff --git a/ext/standard/tests/serialize/bug70219.phpt b/ext/standard/tests/serialize/bug70219.phpt
@@ -29,7 +29,11 @@ for ($i = 0; $i < 5; $i++) {
 var_dump($data);
 ?>
 --EXPECTF--
-Warning: session_decode(): Failed to decode session object. Session has been destroyed in %s on line %d
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
+Warning: session_start(): Session cannot be started after headers have already been sent in %s on line %d
+
+Warning: session_decode(): Session data cannot be decoded when there is no active session in %s on line %d
 
 Notice: unserialize(): Error at offset 55 of 56 bytes in %s on line %d
 bool(false)
diff --git a/ext/standard/tests/serialize/bug70219_1.phpt b/ext/standard/tests/serialize/bug70219_1.phpt
@@ -34,6 +34,7 @@ var_dump($data);
 var_dump($_SESSION);
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 array(2) {
   [0]=>
   object(obj)#%d (1) {
diff --git a/ext/standard/tests/serialize/bug70436.phpt b/ext/standard/tests/serialize/bug70436.phpt
@@ -46,6 +46,8 @@ function ptr2str($ptr)
 ?>
 DONE
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
 Notice: unserialize(): Error at offset 0 of 3 bytes in %sbug70436.php on line %d
 
 Notice: unserialize(): Error at offset 93 of 94 bytes in %sbug70436.php on line %d
diff --git a/ext/standard/tests/serialize/bug71940.phpt b/ext/standard/tests/serialize/bug71940.phpt
@@ -43,7 +43,8 @@ $serialized = serialize([$entry1, $entry2]);
 print_r(unserialize($serialized));
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 Array
 (
     [0] => Entry Object
diff --git a/ext/standard/tests/serialize/bug72663_2.phpt b/ext/standard/tests/serialize/bug72663_2.phpt
@@ -19,6 +19,8 @@ var_dump(unserialize($exploit));
 
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
 Notice: unserialize(): Unexpected end of serialized data in %s on line %d
 
 Notice: unserialize(): Error at offset 46 of 47 bytes in %s on line %d
diff --git a/ext/standard/tests/serialize/bug80411.phpt b/ext/standard/tests/serialize/bug80411.phpt
@@ -21,7 +21,8 @@ $recovered = unserialize($data);
 var_export($recovered);
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 a:4:{i:0;N;i:1;N;i:2;s:6:"endcap";i:3;R:4;}
 array (
   0 => NULL,
diff --git a/ext/standard/tests/serialize/max_depth.phpt b/ext/standard/tests/serialize/max_depth.phpt
@@ -134,6 +134,8 @@ Warning: unserialize(): Maximum depth of 256 exceeded. The depth limit can be ch
 
 Notice: unserialize(): Error at offset 2309 of 2574 bytes in %s on line %d
 bool(false)
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 Nested unserialize combined depth limit:
 
 Warning: unserialize(): Maximum depth of 256 exceeded. The depth limit can be changed using the max_depth unserialize() option or the unserialize_max_depth ini setting in %s on line %d
@@ -142,6 +144,8 @@ Notice: unserialize(): Error at offset 1157 of 1294 bytes in %s on line %d
 bool(false)
 bool(true)
 bool(true)
+
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 Nested unserialize overridden depth limit:
 
 Warning: unserialize(): Maximum depth of 256 exceeded. The depth limit can be changed using the max_depth unserialize() option or the unserialize_max_depth ini setting in %s on line %d
diff --git a/ext/standard/tests/serialize/ref_to_failed_serialize.phpt b/ext/standard/tests/serialize/ref_to_failed_serialize.phpt
@@ -18,7 +18,8 @@ var_dump($s = serialize($data));
 var_dump(unserialize($s));
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 string(18) "a:2:{i:0;N;i:1;N;}"
 array(2) {
   [0]=>
diff --git a/ext/standard/tests/serialize/serialization_objects_010.phpt b/ext/standard/tests/serialize/serialization_objects_010.phpt
@@ -19,6 +19,7 @@ try {
 
 echo "Done";
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 C::serialize() must return a string or NULL
 Done
diff --git a/ext/standard/tests/strings/bug72663.phpt b/ext/standard/tests/strings/bug72663.phpt
@@ -19,6 +19,8 @@ var_dump(unserialize($exploit));
 ?>
 DONE
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
+
 Notice: unserialize(): Unexpected end of serialized data in %sbug72663.php on line %d
 
 Notice: unserialize(): Error at offset 46 of 47 bytes in %sbug72663.php on line %d
diff --git a/tests/classes/serialize_001.phpt b/tests/classes/serialize_001.phpt
@@ -46,6 +46,7 @@ foreach($tests as $data)
 
 ?>
 --EXPECTF--
+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d
 ==========
 string(6) "String"
 Test::__construct(String)

Original file line number	Diff line number	Diff line change
`@@ -20,5 +20,6 @@ try {`
`20`	`20`	`var_dump($e->getMessage());`
`21`	`21`	`}`
`22`	`22`	`?>`
`23`		`---EXPECT--`
	`23`	`+--EXPECTF--`
	`24`	`+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d`
`24`	`25`	`string(9) "serialize"`
Original file line number	Diff line number	Diff line change
`@@ -429,6 +429,10 @@ static int zend_implement_serializable(zend_class_entry *interface, zend_class_e`
`429`	`429`	`if (!class_type->unserialize) {`
`430`	`430`	`class_type->unserialize = zend_user_unserialize;`
`431`	`431`	`}`
	`432`	`+ if (!(class_type->ce_flags & ZEND_ACC_EXPLICIT_ABSTRACT_CLASS)`
	`433`	`+ && (!class_type->__serialize \|\| !class_type->__unserialize)) {`
	`434`	`+ zend_error(E_DEPRECATED, "The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them");`
	`435`	`+ }`
`432`	`436`	`return SUCCESS;`
`433`	`437`	`}`
`434`	`438`	`/* }}}*/`
Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,10 @@ print $a->a[1]->b->c . "\n";`
`53`	`53`
`54`	`54`	`?>`
`55`	`55`	`Done`
`56`		`---EXPECT--`
	`56`	`+--EXPECTF--`
`57`	`57`	`Test`
	`58`	`+`
	`59`	`+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d`
`58`	`60`	`1`
`59`	`61`	`2`
`60`	`62`	`Done`
Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,6 @@ try {`
`25`	`25`	`var_dump($e->getMessage());`
`26`	`26`	`}`
`27`	`27`	`?>`
`28`		`---EXPECT--`
	`28`	`+--EXPECTF--`
	`29`	`+Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line %d`
`29`	`30`	`string(6) "Failed"`