Convert resources to objects in ext/sockets

Author: kocsismate

UPGRADING

@@ -399,9 +399,18 @@ PHP 8.0 UPGRADE NOTES
   . ReflectionType::isBuiltin() method has been moved to ReflectionNamedType.
     ReflectionUnionType does not have it.
 
-- Socket:
+- Sockets:
   . The deprecated AI_IDN_ALLOW_UNASSIGNED and AI_IDN_USE_STD3_ASCII_RULES
     flags for socket_addrinfo_lookup() have been removed.
+  . socket_create(), socket_create_listen(), socket_accept(),
+    socket_import_stream(), socket_addrinfo_connect(), socket_addrinfo_bind(),
+    and socket_wsaprotocol_info_import() will now return a Socket object rather
+    than a resource. Return value checks using is_resource() should be replaced
+    with checks for `false`. The socket_close() function is deprecated and no
+    longer has an effect, instead the Socket instance is automatically
+    destroyed if it is no longer referenced.
+  . socket_addrinfo_lookup() will now return an array of AddressInfo objects
+    rather than resources.
 
 - SPL:
   . SplFileObject::fgetss() has been removed.

ext/sockets/conversions.c

@@ -1339,29 +1339,26 @@ static void from_zval_write_fd_array_aux(zval *elem, unsigned i, void **args, se
 {
 	int *iarr = args[0];
 
-	if (Z_TYPE_P(elem) == IS_RESOURCE) {
-		php_stream *stream;
-		php_socket *sock;
+	if (Z_TYPE_P(elem) != IS_OBJECT || Z_OBJCE_P(elem) != socket_ce) {
+		php_socket *sock = Z_SOCKET_P(elem);
+		iarr[i] = sock->bsd_socket;
 
-		sock = (php_socket *)zend_fetch_resource_ex(elem, NULL, php_sockets_le_socket());
-		if (sock) {
-			iarr[i] = sock->bsd_socket;
-			return;
-		}
+		return;
+	} else if (Z_TYPE_P(elem) == IS_RESOURCE) {
+		php_stream *stream;
 
 		stream = (php_stream *)zend_fetch_resource2_ex(elem, NULL, php_file_le_stream(), php_file_le_pstream());
 		if (stream == NULL) {
-			do_from_zval_err(ctx, "resource is not a stream or a socket");
+			do_from_zval_err(ctx, "resource is not a stream");
 			return;
 		}
 
-		if (php_stream_cast(stream, PHP_STREAM_AS_FD, (void **)&iarr[i - 1],
-				REPORT_ERRORS) == FAILURE) {
+		if (php_stream_cast(stream, PHP_STREAM_AS_FD, (void **)&iarr[i - 1], REPORT_ERRORS) == FAILURE) {
 			do_from_zval_err(ctx, "cast stream to file descriptor failed");
 			return;
 		}
 	} else {
-		do_from_zval_err(ctx, "expected a resource variable");
+		do_from_zval_err(ctx, "expected a Socket object or a stream resource");
 	}
 }
 void from_zval_write_fd_array(const zval *arr, char *int_arr, ser_context *ctx)
@@ -1412,8 +1409,11 @@ void to_zval_read_fd_array(const char *data, zval *zv, res_context *ctx)
 			return;
 		}
 		if (S_ISSOCK(statbuf.st_mode)) {
-			php_socket *sock = socket_import_file_descriptor(fd);
-			ZVAL_RES(&elem, zend_register_resource(sock, php_sockets_le_socket()));
+
+			object_init_ex(&elem, socket_ce);
+			php_socket *sock = Z_SOCKET_P(&elem);
+
+			socket_import_file_descriptor(fd, sock);
 		} else {
 			php_stream *stream = php_stream_fopen_from_fd(fd, "rw", NULL);
 			php_stream_to_zval(stream, &elem);

ext/sockets/php_sockets.h

@@ -52,29 +52,33 @@ typedef int PHP_SOCKET;
 typedef SOCKET PHP_SOCKET;
 #endif
 
+/* Socket class */
+
 typedef struct {
 	PHP_SOCKET	bsd_socket;
 	int			type;
 	int			error;
 	int			blocking;
 	zval		zstream;
+	zend_object std;
 } php_socket;
 
+zend_class_entry *socket_ce;
+
+static inline php_socket *socket_from_obj(zend_object *obj) {
+	return (php_socket *)((char *)(obj) - XtOffsetOf(php_socket, std));
+}
+
+#define Z_SOCKET_P(zv) socket_from_obj(Z_OBJ_P(zv))
+
+
 #ifdef PHP_WIN32
 struct	sockaddr_un {
 	short	sun_family;
 	char	sun_path[108];
 };
 #endif
 
-PHP_SOCKETS_API int php_sockets_le_socket(void);
-PHP_SOCKETS_API php_socket *php_create_socket(void);
-PHP_SOCKETS_API void php_destroy_socket(zend_resource *rsrc);
-PHP_SOCKETS_API void php_destroy_sockaddr(zend_resource *rsrc);
-
-#define php_sockets_le_socket_name "Socket"
-#define php_sockets_le_addrinfo_name "AddressInfo"
-
 #define PHP_SOCKET_ERROR(socket, msg, errn) \
 		do { \
 			int _err = (errn); /* save value to avoid repeated calls to WSAGetLastError() on Windows */ \
@@ -104,7 +108,7 @@ enum sockopt_return {
 };
 
 char *sockets_strerror(int error);
-php_socket *socket_import_file_descriptor(PHP_SOCKET sock);
+int socket_import_file_descriptor(PHP_SOCKET socket, php_socket *retsock);
 
 #else
 #define phpext_sockets_ptr NULL

ext/sockets/sendrecvmsg.c

@@ -172,16 +172,13 @@ PHP_FUNCTION(socket_sendmsg)
 	ssize_t			res;
 
 	/* zmsg should be passed by ref */
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "ra|l", &zsocket, &zmsg, &flags) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "Oa|l", &zsocket, socket_ce, &zmsg, &flags) == FAILURE) {
 		RETURN_THROWS();
 	}
 
 	LONG_CHECK_VALID_INT(flags, 3);
 
-	if ((php_sock = (php_socket *)zend_fetch_resource(Z_RES_P(zsocket),
-					php_sockets_le_socket_name, php_sockets_le_socket())) == NULL) {
-		RETURN_THROWS();
-	}
+	php_sock = Z_SOCKET_P(zsocket);
 
 	msghdr = from_zval_run_conversions(zmsg, php_sock, from_zval_write_msghdr_send,
 			sizeof(*msghdr), "msghdr", &allocations, &err);
@@ -216,17 +213,13 @@ PHP_FUNCTION(socket_recvmsg)
 	struct err_s	err = {0};
 
 	//ssize_t recvmsg(int sockfd, struct msghdr *msg, int flags);
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "ra|l",
-			&zsocket, &zmsg, &flags) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "Oa|l", &zsocket, socket_ce, &zmsg, &flags) == FAILURE) {
 		RETURN_THROWS();
 	}
 
 	LONG_CHECK_VALID_INT(flags, 3);
 
-	if ((php_sock = (php_socket *)zend_fetch_resource(Z_RES_P(zsocket),
-					php_sockets_le_socket_name, php_sockets_le_socket())) == NULL) {
-		RETURN_THROWS();
-	}
+	php_sock = Z_SOCKET_P(zsocket);
 
 	msghdr = from_zval_run_conversions(zmsg, php_sock, from_zval_write_msghdr_recv,
 			sizeof(*msghdr), "msghdr", &allocations, &err);