PHPC-1956: Remove disabled __wakeup function in non-serializable classes (#1513)

* Remove shared function entries for disabled __construct and __wakeup methods

These have been obsolete since the PHONGO_DISABLED_CONSTRUCTOR and PHONGO_DISABLED_WAKEUP macros were introduced in 6887226.

* Remove extra vim foldmarkers and fix balancing for last marker

* PHPC-1956: Remove disabled __wakeup function in non-serializable classes

This function was not necessary since PHP 7.0 allowed disabling serialization via object handlers.

The PHONGO_DISABLED_WAKEUP macro is no longer used and has been removed.

* Remove obsolete serialization test

This is superseded by the new manager-serialization_error tests.

Author: jmikola

php_phongo.c

@@ -56,27 +56,28 @@ zend_object_handlers* phongo_get_std_object_handlers(void)
 /* }}} */
 
 /* {{{ Memory allocation wrappers */
-static void* php_phongo_malloc(size_t num_bytes) /* {{{ */
+static void* php_phongo_malloc(size_t num_bytes)
 {
 	return pemalloc(num_bytes, 1);
-} /* }}} */
+}
 
-static void* php_phongo_calloc(size_t num_members, size_t num_bytes) /* {{{ */
+static void* php_phongo_calloc(size_t num_members, size_t num_bytes)
 {
 	return pecalloc(num_members, num_bytes, 1);
-} /* }}} */
+}
 
-static void* php_phongo_realloc(void* mem, size_t num_bytes) /* {{{ */
+static void* php_phongo_realloc(void* mem, size_t num_bytes)
 {
 	return perealloc(mem, num_bytes, 1);
-} /* }}} */
+}
 
-static void php_phongo_free(void* mem) /* {{{ */
+static void php_phongo_free(void* mem)
 {
 	if (mem) {
 		pefree(mem, 1);
 	}
-} /* }}} */
+}
+/* }}} */
 
 PHP_RINIT_FUNCTION(mongodb) /* {{{ */
 {
@@ -153,12 +154,12 @@ static zend_class_entry* php_phongo_fetch_internal_class(const char* class_name,
 	return NULL;
 }
 
-static HashTable* php_phongo_std_get_gc(phongo_compat_object_handler_type* object, zval** table, int* n) /* {{{ */
+static HashTable* php_phongo_std_get_gc(phongo_compat_object_handler_type* object, zval** table, int* n)
 {
 	*table = NULL;
 	*n     = 0;
 	return zend_std_get_properties(object);
-} /* }}} */
+}
 
 PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 {
@@ -515,20 +516,6 @@ PHP_MINFO_FUNCTION(mongodb) /* {{{ */
 	phongo_display_ini_entries(ZEND_MODULE_INFO_FUNC_ARGS_PASSTHRU);
 } /* }}} */
 
-/* {{{ Shared function entries for disabling constructors and unserialize() */
-PHP_FUNCTION(MongoDB_disabled___construct) /* {{{ */
-{
-	phongo_throw_exception(PHONGO_ERROR_RUNTIME, "Accessing private constructor");
-} /* }}} */
-
-PHP_FUNCTION(MongoDB_disabled___wakeup) /* {{{ */
-{
-	PHONGO_PARSE_PARAMETERS_NONE();
-
-	phongo_throw_exception(PHONGO_ERROR_RUNTIME, "%s", "MongoDB\\Driver objects cannot be serialized");
-} /* }}} */
-/* }}} */
-
 /* {{{ Module dependencies and module entry */
 static const zend_module_dep mongodb_deps[] = {
 	/* clang-format off */

php_phongo.h

@@ -117,15 +117,4 @@ zend_object_handlers* phongo_get_std_object_handlers(void);
 		phongo_throw_exception(PHONGO_ERROR_RUNTIME, "Accessing private constructor"); \
 	}
 
-#define PHONGO_DISABLED_WAKEUP(classname)                                                             \
-	static PHP_METHOD(classname, __wakeup)                                                            \
-	{                                                                                                 \
-		PHONGO_PARSE_PARAMETERS_NONE();                                                               \
-		phongo_throw_exception(PHONGO_ERROR_RUNTIME, "MongoDB\\Driver objects cannot be serialized"); \
-	}
-
-/* Shared function entries for disabling constructors and unserialize() */
-PHP_FUNCTION(MongoDB_disabled___construct);
-PHP_FUNCTION(MongoDB_disabled___wakeup);
-
 #endif /* PHONGO_H */

src/BSON/Iterator.c

@@ -169,7 +169,6 @@ static HashTable* php_phongo_iterator_get_properties_hash(phongo_compat_object_h
 }
 
 PHONGO_DISABLED_CONSTRUCTOR(MongoDB_BSON_Iterator)
-PHONGO_DISABLED_WAKEUP(MongoDB_BSON_Iterator)
 
 static PHP_METHOD(MongoDB_BSON_Iterator, current)
 {

src/BSON/Iterator.stub.php

@@ -30,6 +30,4 @@ final public function next(): void {}
     final public function rewind(): void {}
 
     final public function valid(): bool {}
-
-    final public function __wakeup(): void {}
 }

src/BSON/Iterator_arginfo.h

@@ -542,8 +542,6 @@ static PHP_METHOD(MongoDB_Driver_BulkWrite, count)
 	RETURN_LONG(intern->num_ops);
 }
 
-PHONGO_DISABLED_WAKEUP(MongoDB_Driver_BulkWrite)
-
 /* MongoDB\Driver\BulkWrite object handlers */
 static zend_object_handlers php_phongo_handler_bulkwrite;
 

src/MongoDB/BulkWrite.c

@@ -39,6 +39,4 @@ public function update(array|object $filter, array|object $newObj, ?array $updat
      */
     public function update($filter, $newObj, ?array $updateOptions = null): void {}
 #endif
-
-    final public function __wakeup(): void {}
 }

src/MongoDB/BulkWrite.stub.php

@@ -473,8 +473,6 @@ static PHP_METHOD(MongoDB_Driver_ClientEncryption, rewrapManyDataKey)
 	mongoc_client_encryption_rewrap_many_datakey_result_destroy(result);
 }
 
-PHONGO_DISABLED_WAKEUP(MongoDB_Driver_ClientEncryption)
-
 /* MongoDB\Driver\ClientEncryption object handlers */
 static zend_object_handlers php_phongo_handler_clientencryption;
 

src/MongoDB/BulkWrite_arginfo.h

@@ -94,6 +94,4 @@ final public function rewrapManyDataKey(array|object $filter, ?array $options =
     /** @param array|object $filter */
     final public function rewrapManyDataKey($filter, ?array $options = null): object {}
 #endif
-
-    final public function __wakeup(): void {}
 }

src/MongoDB/ClientEncryption.c

@@ -115,8 +115,6 @@ static PHP_METHOD(MongoDB_Driver_Command, __construct)
 	php_phongo_command_init(intern, document, options);
 }
 
-PHONGO_DISABLED_WAKEUP(MongoDB_Driver_Command)
-
 /* MongoDB\Driver\Command object handlers */
 static zend_object_handlers php_phongo_handler_command;
 

src/MongoDB/ClientEncryption.stub.php

@@ -15,6 +15,4 @@ final public function __construct(array|object $document, ?array $commandOptions
     /** @param array|object $document */
     final public function __construct($document, ?array $commandOptions = null) {}
 #endif
-
-    final public function __wakeup(): void {}
 }

src/MongoDB/ClientEncryption_arginfo.h

@@ -289,7 +289,6 @@ static PHP_METHOD(MongoDB_Driver_Cursor, rewind)
 }
 
 PHONGO_DISABLED_CONSTRUCTOR(MongoDB_Driver_Cursor)
-PHONGO_DISABLED_WAKEUP(MongoDB_Driver_Cursor)
 
 /* MongoDB\Driver\Cursor object handlers */
 static zend_object_handlers php_phongo_handler_cursor;

src/MongoDB/Command.c

@@ -35,6 +35,4 @@ final public function setTypeMap(array $typemap): void {}
     final public function toArray(): array {}
 
     public function valid(): bool {}
-
-    final public function __wakeup(): void {}
 }

src/MongoDB/Command.stub.php

@@ -242,8 +242,6 @@ static bool php_phongo_manager_select_server(bool for_writes, bool inherit_read_
 	return false;
 }
 
-PHONGO_DISABLED_WAKEUP(MongoDB_Driver_Manager)
-
 /* Constructs a new Manager */
 static PHP_METHOD(MongoDB_Driver_Manager, __construct)
 {

src/MongoDB/Command_arginfo.h

@@ -62,6 +62,4 @@ final public function removeSubscriber(Monitoring\Subscriber $subscriber): void
     final public function selectServer(?ReadPreference $readPreference = null): Server {}
 
     final public function startSession(?array $options = null): Session {}
-
-    final public function __wakeup(): void {}
 }

src/MongoDB/Cursor.c

@@ -30,7 +30,6 @@
 zend_class_entry* php_phongo_commandfailedevent_ce;
 
 PHONGO_DISABLED_CONSTRUCTOR(MongoDB_Driver_Monitoring_CommandFailedEvent)
-PHONGO_DISABLED_WAKEUP(MongoDB_Driver_Monitoring_CommandFailedEvent)
 
 /* Returns the command name for this event */
 static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getCommandName)

src/MongoDB/Cursor.stub.php

@@ -28,6 +28,4 @@ final public function getServer(): \MongoDB\Driver\Server {}
     final public function getServiceId(): ?\MongoDB\BSON\ObjectId {}
 
     final public function getServerConnectionId(): ?int {}
-
-    final public function __wakeup(): void {}
 }