Convert resource to object in XML-RPC extension

Author: kocsismate

UPGRADING

@@ -409,6 +409,12 @@ PHP 8.0 UPGRADE NOTES
     instead the XmlParser instance is automatically destroyed if it is no longer
     referenced.
 
+- XML-RPC:
+  . xmlrpc_server_create() will now return an XmlRpcServer object rather than a resource.
+    The xmlrpc_server_destroy() function no longer has an effect,
+    instead the XmlRpcServer instance is automatically destroyed if it is no longer
+    referenced.
+
 - XMLWriter:
   . The XMLWriter functions now accept and return, respectively, XMLWriter
     objects instead of resources.

ext/xmlrpc/xmlrpc-epi-php.c

@@ -70,7 +70,7 @@
 #include "xmlrpc.h"
 #include "xmlrpc_arginfo.h"
 
-static int le_xmlrpc_server;
+#include "Zend/zend_interfaces.h"
 
 zend_module_entry xmlrpc_module_entry = {
 	STANDARD_MODULE_HEADER,
@@ -98,6 +98,7 @@ typedef struct _xmlrpc_server_data {
 	zval method_map;
 	zval introspection_map;
 	XMLRPC_SERVER server_ptr;
+	zend_object std;
 } xmlrpc_server_data;
 
 
@@ -172,36 +173,74 @@ XMLRPC_VECTOR_TYPE xmlrpc_str_as_vector_type(const char* str);
 int set_zval_xmlrpc_type(zval* value, XMLRPC_VALUE_TYPE type);
 
 /*********************
-* startup / shutdown *
+* XmlRpcServer object *
 *********************/
 
-static void destroy_server_data(xmlrpc_server_data *server)
+zend_class_entry *xmlrpc_server_ce;
+static zend_object_handlers xmlrpc_server_object_handlers;
+static const zend_function_entry xmlrpc_server_object_methods[] = {
+	PHP_FE_END
+};
+
+static inline xmlrpc_server_data *xmlrpc_server_from_obj(zend_object *obj) {
+	return (xmlrpc_server_data *)((char *)(obj) - XtOffsetOf(xmlrpc_server_data, std));
+}
+
+#define Z_XMLRPC_SERVER_P(zv) xmlrpc_server_from_obj(Z_OBJ_P(zv))
+
+static zend_object *xmlrpc_server_create_object(zend_class_entry *class_type) {
+	xmlrpc_server_data *intern = zend_object_alloc(sizeof(xmlrpc_server_data), class_type);
+
+	zend_object_std_init(&intern->std, class_type);
+	object_properties_init(&intern->std, class_type);
+	intern->std.handlers = &xmlrpc_server_object_handlers;
+
+	return &intern->std;
+}
+
+static zend_function *xmlrpc_server_get_constructor(zend_object *object) {
+	zend_throw_error(NULL, "Cannot directly construct XmlRpcServer, use xmlrpc_server_create() instead");
+	return NULL;
+}
+
+static void xmlrpc_server_free_obj(zend_object *object)
 {
-	if (server) {
-		XMLRPC_ServerDestroy(server->server_ptr);
+	xmlrpc_server_data *server = xmlrpc_server_from_obj(object);
 
-		zval_ptr_dtor(&server->method_map);
-		zval_ptr_dtor(&server->introspection_map);
+	XMLRPC_ServerDestroy(server->server_ptr);
 
-		efree(server);
-	}
+	zval_ptr_dtor(&server->method_map);
+	zval_ptr_dtor(&server->introspection_map);
+	zend_object_std_dtor(&server->std);
 }
 
-/* called when server is being destructed. either when xmlrpc_server_destroy
- * is called, or when request ends.  */
-static void xmlrpc_server_destructor(zend_resource *rsrc)
+static HashTable *xmlrpc_server_get_gc(zend_object *object, zval **table, int *n)
 {
-	if (rsrc && rsrc->ptr) {
-		GC_ADDREF(rsrc);
-		destroy_server_data((xmlrpc_server_data*) rsrc->ptr);
-		GC_DELREF(rsrc);
-	}
+	xmlrpc_server_data *xmlrpc_server = xmlrpc_server_from_obj(object);
+
+	*table = &xmlrpc_server->method_map;
+	*n = 2;
+
+	return zend_std_get_properties(object);
 }
 
 /* module init */
 PHP_MINIT_FUNCTION(xmlrpc)
 {
-	le_xmlrpc_server = zend_register_list_destructors_ex(xmlrpc_server_destructor, NULL, "xmlrpc server", module_number);
+	zend_class_entry ce;
+	INIT_CLASS_ENTRY(ce, "XmlRpcServer", xmlrpc_server_object_methods);
+	xmlrpc_server_ce = zend_register_internal_class(&ce);
+	xmlrpc_server_ce->ce_flags |= ZEND_ACC_FINAL;
+	xmlrpc_server_ce->create_object = xmlrpc_server_create_object;
+	xmlrpc_server_ce->serialize = zend_class_serialize_deny;
+	xmlrpc_server_ce->unserialize = zend_class_unserialize_deny;
+
+	memcpy(&xmlrpc_server_object_handlers, &std_object_handlers, sizeof(zend_object_handlers));
+	xmlrpc_server_object_handlers.offset = XtOffsetOf(xmlrpc_server_data, std);
+	xmlrpc_server_object_handlers.free_obj = xmlrpc_server_free_obj;
+	xmlrpc_server_object_handlers.get_gc = xmlrpc_server_get_gc;
+	xmlrpc_server_object_handlers.get_constructor = xmlrpc_server_get_constructor;
+	xmlrpc_server_object_handlers.clone_obj = NULL;
 
 	return SUCCESS;
 }
@@ -735,7 +774,7 @@ PHP_FUNCTION(xmlrpc_decode)
 * server related methods *
 *************************/
 
-/* {{{ proto resource xmlrpc_server_create(void)
+/* {{{ proto XmlRpcServer xmlrpc_server_create(void)
    Creates an xmlrpc server */
 PHP_FUNCTION(xmlrpc_server_create)
 {
@@ -744,42 +783,31 @@ PHP_FUNCTION(xmlrpc_server_create)
 	}
 
 	if (USED_RET()) {
-		xmlrpc_server_data *server = emalloc(sizeof(xmlrpc_server_data));
+		xmlrpc_server_data *server;
+
+		object_init_ex(return_value, xmlrpc_server_ce);
+		server = Z_XMLRPC_SERVER_P(return_value);
 
-		/* allocate server data.  free'd in destroy_server_data() */
 		array_init(&server->method_map);
 		array_init(&server->introspection_map);
 		server->server_ptr = XMLRPC_ServerCreate();
 
 		XMLRPC_ServerRegisterIntrospectionCallback(server->server_ptr, php_xmlrpc_introspection_callback);
-
-		/* store for later use */
-		RETURN_RES(zend_register_resource(server, le_xmlrpc_server));
 	}
 }
 /* }}} */
 
-/* {{{ proto int xmlrpc_server_destroy(resource server)
+/* {{{ proto bool xmlrpc_server_destroy(XmlRpcServer server)
    Destroys server resources */
 PHP_FUNCTION(xmlrpc_server_destroy)
 {
 	zval *arg1;
-	int bSuccess = FAILURE;
-	xmlrpc_server_data *server;
-
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "r", &arg1) == FAILURE) {
-		RETURN_THROWS();
-	}
 
-	if ((server = (xmlrpc_server_data *)zend_fetch_resource(Z_RES_P(arg1), "xmlrpc server", le_xmlrpc_server)) == NULL) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "O", &arg1, xmlrpc_server_ce) == FAILURE) {
 		RETURN_THROWS();
 	}
 
-	bSuccess = zend_list_close(Z_RES_P(arg1));
-	/* called by hashtable destructor
-	 * destroy_server_data(server);
-	 */
-	RETURN_BOOL(bSuccess == SUCCESS);
+	RETURN_TRUE;
 }
 /* }}} */
 
@@ -881,7 +909,7 @@ static void php_xmlrpc_introspection_callback(XMLRPC_SERVER server, void* data)
 }
 /* }}} */
 
-/* {{{ proto bool xmlrpc_server_register_method(resource server, string method_name, string function)
+/* {{{ proto bool xmlrpc_server_register_method(XmlRpcServer server, string method_name, string function)
    Register a PHP function to handle method matching method_name */
 PHP_FUNCTION(xmlrpc_server_register_method)
 {
@@ -890,13 +918,11 @@ PHP_FUNCTION(xmlrpc_server_register_method)
 	zval *handle, *method_name;
 	xmlrpc_server_data* server;
 
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "rsz", &handle, &method_key, &method_key_len, &method_name) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "Osz", &handle, xmlrpc_server_ce, &method_key, &method_key_len, &method_name) == FAILURE) {
 		RETURN_THROWS();
 	}
 
-	if ((server = (xmlrpc_server_data *)zend_fetch_resource(Z_RES_P(handle), "xmlrpc server", le_xmlrpc_server)) == NULL) {
-		RETURN_THROWS();
-	}
+	server = Z_XMLRPC_SERVER_P(handle);
 
 	/* register with C engine. every method just calls our standard callback,
 	 * and it then dispatches to php as necessary
@@ -913,20 +939,18 @@ PHP_FUNCTION(xmlrpc_server_register_method)
 }
 /* }}} */
 
-/* {{{ proto bool xmlrpc_server_register_introspection_callback(resource server, string function)
+/* {{{ proto bool xmlrpc_server_register_introspection_callback(XmlRpcServer server, string function)
    Register a PHP function to generate documentation */
 PHP_FUNCTION(xmlrpc_server_register_introspection_callback)
 {
 	zval *method_name, *handle;
 	xmlrpc_server_data* server;
 
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "rz", &handle, &method_name) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "Oz", &handle, xmlrpc_server_ce, &method_name) == FAILURE) {
 		RETURN_THROWS();
 	}
 
-	if ((server = (xmlrpc_server_data *)zend_fetch_resource(Z_RES_P(handle), "xmlrpc server", le_xmlrpc_server)) == NULL) {
-		RETURN_THROWS();
-	}
+	server = Z_XMLRPC_SERVER_P(handle);
 
 	Z_TRY_ADDREF_P(method_name);
 	/* register our php method */
@@ -938,7 +962,7 @@ PHP_FUNCTION(xmlrpc_server_register_introspection_callback)
 
 /* this function is itchin for a re-write */
 
-/* {{{ proto mixed xmlrpc_server_call_method(resource server, string xml, mixed user_data [, array output_options])
+/* {{{ proto mixed xmlrpc_server_call_method(XmlRpcServer server, string xml, mixed user_data [, array output_options])
    Parses XML requests and call methods */
 PHP_FUNCTION(xmlrpc_server_call_method)
 {
@@ -952,7 +976,7 @@ PHP_FUNCTION(xmlrpc_server_call_method)
 	php_output_options out;
 	int argc = ZEND_NUM_ARGS();
 
-	if (zend_parse_parameters(argc, "rsz|a", &handle, &rawxml, &rawxml_len, &caller_params, &output_opts) != SUCCESS) {
+	if (zend_parse_parameters(argc, "Osz|a", &handle, xmlrpc_server_ce, &rawxml, &rawxml_len, &caller_params, &output_opts) != SUCCESS) {
 		RETURN_THROWS();
 	}
 	/* user output options */
@@ -962,9 +986,7 @@ PHP_FUNCTION(xmlrpc_server_call_method)
 		set_output_options(&out, output_opts);
 	}
 
-	if ((server = (xmlrpc_server_data *)zend_fetch_resource(Z_RES_P(handle), "xmlrpc server", le_xmlrpc_server)) == NULL) {
-		RETURN_THROWS();
-	}
+	server = Z_XMLRPC_SERVER_P(handle);
 
 	/* HACK: use output encoding for now */
 	input_opts.xml_elem_opts.encoding = utf8_get_encoding_id_from_string(out.xmlrpc_out.xml_elem_opts.encoding);
@@ -1046,21 +1068,19 @@ PHP_FUNCTION(xmlrpc_server_call_method)
 }
 /* }}} */
 
-/* {{{ proto int xmlrpc_server_add_introspection_data(resource server, array desc)
+/* {{{ proto int xmlrpc_server_add_introspection_data(XmlRpcServer server, array desc)
    Adds introspection documentation  */
 PHP_FUNCTION(xmlrpc_server_add_introspection_data)
 {
 	zval *handle, *desc;
 	xmlrpc_server_data* server;
 	XMLRPC_VALUE xDesc;
 
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "ra", &handle, &desc) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "Oa", &handle, xmlrpc_server_ce, &desc) == FAILURE) {
 		RETURN_THROWS();
 	}
 
-	if ((server = (xmlrpc_server_data *)zend_fetch_resource(Z_RES_P(handle), "xmlrpc server", le_xmlrpc_server)) == NULL) {
-		RETURN_THROWS();
-	}
+	server = Z_XMLRPC_SERVER_P(handle);
 
 	xDesc = PHP_to_XMLRPC(desc);
 	if (xDesc) {

ext/xmlrpc/xmlrpc.stub.php

@@ -19,26 +19,18 @@ function xmlrpc_set_type(&$value, string $type): bool {}
 
 function xmlrpc_is_fault(array $arg): bool {}
 
-/** @return resource */
-function xmlrpc_server_create() {}
+function xmlrpc_server_create(): XmlRpcServer {}
 
-/** @param resource $server */
-function xmlrpc_server_destroy($server): bool {}
+function xmlrpc_server_destroy(XmlRpcServer $server): bool {}
 
-/** @param resource $server */
-function xmlrpc_server_register_method($server, string $method_name, $function): bool {}
+function xmlrpc_server_register_method(XmlRpcServer $server, string $method_name, $function): bool {}
 
-/**
- * @param resource $server
- * @return mixed
- */
-function xmlrpc_server_call_method($server, string $xml, $user_data, array $output_options = UNKNOWN) {}
+/** @return mixed */
+function xmlrpc_server_call_method(XmlRpcServer $server, string $xml, $user_data, array $output_options = UNKNOWN) {}
 
 /** @return mixed */
 function xmlrpc_parse_method_descriptions(string $xml) {}
 
-/** @param resource $server */
-function xmlrpc_server_add_introspection_data($server, array $desc): int {}
+function xmlrpc_server_add_introspection_data(XmlRpcServer $server, array $desc): int {}
 
-/** @param resource $server */
-function xmlrpc_server_register_introspection_callback($server, $function): bool {}
+function xmlrpc_server_register_introspection_callback(XmlRpcServer $server, $function): bool {}

ext/xmlrpc/xmlrpc_arginfo.h

@@ -34,21 +34,21 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_xmlrpc_is_fault, 0, 1, _IS_BOOL,
 	ZEND_ARG_TYPE_INFO(0, arg, IS_ARRAY, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_INFO_EX(arginfo_xmlrpc_server_create, 0, 0, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_xmlrpc_server_create, 0, 0, XmlRpcServer, 0)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_xmlrpc_server_destroy, 0, 1, _IS_BOOL, 0)
-	ZEND_ARG_INFO(0, server)
+	ZEND_ARG_OBJ_INFO(0, server, XmlRpcServer, 0)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_xmlrpc_server_register_method, 0, 3, _IS_BOOL, 0)
-	ZEND_ARG_INFO(0, server)
+	ZEND_ARG_OBJ_INFO(0, server, XmlRpcServer, 0)
 	ZEND_ARG_TYPE_INFO(0, method_name, IS_STRING, 0)
 	ZEND_ARG_INFO(0, function)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_xmlrpc_server_call_method, 0, 0, 3)
-	ZEND_ARG_INFO(0, server)
+	ZEND_ARG_OBJ_INFO(0, server, XmlRpcServer, 0)
 	ZEND_ARG_TYPE_INFO(0, xml, IS_STRING, 0)
 	ZEND_ARG_INFO(0, user_data)
 	ZEND_ARG_TYPE_INFO(0, output_options, IS_ARRAY, 0)
@@ -59,12 +59,12 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_xmlrpc_parse_method_descriptions, 0, 0, 1)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_xmlrpc_server_add_introspection_data, 0, 2, IS_LONG, 0)
-	ZEND_ARG_INFO(0, server)
+	ZEND_ARG_OBJ_INFO(0, server, XmlRpcServer, 0)
 	ZEND_ARG_TYPE_INFO(0, desc, IS_ARRAY, 0)
 ZEND_END_ARG_INFO()
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_xmlrpc_server_register_introspection_callback, 0, 2, _IS_BOOL, 0)
-	ZEND_ARG_INFO(0, server)
+	ZEND_ARG_OBJ_INFO(0, server, XmlRpcServer, 0)
 	ZEND_ARG_INFO(0, function)
 ZEND_END_ARG_INFO()