GH-14111 main/streams: adding SO_LINGER to stream options.

devnexen · devnexen · commit adb3644e6fa1 · 2024-05-04T13:04:39.000+01:00
diff --git a/ext/standard/tests/network/gh14111.phpt b/ext/standard/tests/network/gh14111.phpt
@@ -0,0 +1,23 @@
+--TEST--
+Testing so_linger `socket` option.
+--SKIPIF--
+<?php
+if (getenv("SKIP_ONLINE_TESTS")) die('skip online test');
+if (!in_array('https', stream_get_wrappers())) die('skip: https wrapper is required');
+?>
+--FILE--
+<?php
+$context = stream_context_create(['socket' => ['so_linger' => false]]);
+var_dump(file_get_contents('https://httpbin.org/get', false, $context) !== false);
+$context = stream_context_create(['socket' => ['so_linger' => PHP_INT_MAX + 1]]);
+var_dump(file_get_contents('https://httpbin.org/get', false, $context) !== false);
+$context = stream_context_create(['socket' => ['so_linger' => 3]]);
+var_dump(file_get_contents('https://httpbin.org/get', false, $context) !== false);
+?>
+--EXPECTF--
+Warning: file_get_contents(https://httpbin.org/get): Failed to open stream: Invalid `so_linger` value in %s on line %d
+bool(false)
+
+Warning: file_get_contents(https://httpbin.org/get): Failed to open stream: Invalid `so_linger` value in %s on line %d
+bool(false)
+bool(true)
diff --git a/main/network.c b/main/network.c
@@ -402,7 +402,7 @@ static inline void sub_times(struct timeval a, struct timeval b, struct timeval
  * */
 /* {{{ php_network_bind_socket_to_local_addr */
 php_socket_t php_network_bind_socket_to_local_addr(const char *host, unsigned port,
-		int socktype, long sockopts, zend_string **error_string, int *error_code
+		int socktype, long sockopts, long linger, zend_string **error_string, int *error_code
 		)
 {
 	int num_addrs, n, err = 0;
@@ -470,6 +470,15 @@ php_socket_t php_network_bind_socket_to_local_addr(const char *host, unsigned po
 			setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, (char*)&sockoptval, sizeof(sockoptval));
 		}
 #endif
+#ifdef SO_LINGER
+		if (sockopts & STREAM_SOCKOP_SO_LINGER) {
+			struct linger val = {
+				.l_onoff = (linger > 0),
+				.l_linger = (int)linger
+			};
+			setsockopt(sock, IPPROTO_TCP, SO_LINGER, (char*)&val, sizeof(val));
+		}
+#endif
 
 		n = bind(sock, sa, socklen);
 
@@ -766,7 +775,8 @@ PHPAPI php_socket_t php_network_accept_incoming(php_socket_t srvsock,
 /* {{{ php_network_connect_socket_to_host */
 php_socket_t php_network_connect_socket_to_host(const char *host, unsigned short port,
 		int socktype, int asynchronous, struct timeval *timeout, zend_string **error_string,
-		int *error_code, const char *bindto, unsigned short bindport, long sockopts
+		int *error_code, const char *bindto, unsigned short bindport, long sockopts,
+		long linger
 		)
 {
 	int num_addrs, n, fatal = 0;
@@ -896,6 +906,17 @@ php_socket_t php_network_connect_socket_to_host(const char *host, unsigned short
 				setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, (char*)&val, sizeof(val));
 			}
 		}
+#endif
+#ifdef SO_LINGER
+		{
+			if (sockopts & STREAM_SOCKOP_SO_LINGER) {
+				struct linger val = {
+					.l_onoff = linger > 0,
+					.l_linger = (int)linger
+				};
+				setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, (char*)&val, sizeof(val));
+			}
+		}
 #endif
 		n = php_network_connect_socket(sock, sa, socklen, asynchronous,
 				timeout ? &working_timeout : NULL,
diff --git a/main/php_network.h b/main/php_network.h
@@ -116,6 +116,7 @@ typedef int php_socket_t;
 #define STREAM_SOCKOP_IPV6_V6ONLY         (1 << 3)
 #define STREAM_SOCKOP_IPV6_V6ONLY_ENABLED (1 << 4)
 #define STREAM_SOCKOP_TCP_NODELAY         (1 << 5)
+#define STREAM_SOCKOP_SO_LINGER           (1 << 6)
 
 
 /* uncomment this to debug poll(2) emulation on systems that have poll(2) */
@@ -265,7 +266,8 @@ PHPAPI void php_network_freeaddresses(struct sockaddr **sal);
 
 PHPAPI php_socket_t php_network_connect_socket_to_host(const char *host, unsigned short port,
 		int socktype, int asynchronous, struct timeval *timeout, zend_string **error_string,
-		int *error_code, const char *bindto, unsigned short bindport, long sockopts
+		int *error_code, const char *bindto, unsigned short bindport, long sockopts,
+		long linger
 		);
 
 PHPAPI int php_network_connect_socket(php_socket_t sockfd,
@@ -280,7 +282,7 @@ PHPAPI int php_network_connect_socket(php_socket_t sockfd,
 	php_network_connect_socket((sock), (addr), (addrlen), 0, (timeout), NULL, NULL)
 
 PHPAPI php_socket_t php_network_bind_socket_to_local_addr(const char *host, unsigned port,
-		int socktype, long sockopts, zend_string **error_string, int *error_code
+		int socktype, long sockopts, long linger, zend_string **error_string, int *error_code
 		);
 
 PHPAPI php_socket_t php_network_accept_incoming(php_socket_t srvsock,
diff --git a/main/streams/xp_socket.c b/main/streams/xp_socket.c
@@ -654,12 +654,41 @@ static inline char *parse_ip_address(php_stream_xport_param *xparam, int *portno
 	return parse_ip_address_ex(xparam->inputs.name, xparam->inputs.namelen, portno, xparam->want_errortext, &xparam->outputs.error_text);
 }
 
+static long parse_linger(zval *arg, bool *failed)
+{
+	long lval;
+	*failed = false;
+	if (Z_TYPE_P(arg) == IS_STRING) {
+		zend_string *val = Z_STR_P(arg);
+		uint8_t r = is_numeric_string(ZSTR_VAL(val), ZSTR_LEN(val), &lval, NULL, false);
+
+		switch (r) {
+		case IS_LONG:
+			break;
+		default:
+			*failed = true;
+			return -1;
+		}
+	} else if (Z_TYPE_P(arg) == IS_LONG) {
+		lval = Z_LVAL_P(arg);
+	} else {
+		*failed = true;
+		return -1;
+	}
+
+	if (lval < 0 || lval > INT_MAX) {
+		*failed = true;
+	}
+	return lval;
+}
+
 static inline int php_tcp_sockop_bind(php_stream *stream, php_netstream_data_t *sock,
 		php_stream_xport_param *xparam)
 {
 	char *host = NULL;
 	int portno, err;
 	long sockopts = STREAM_SOCKOP_NONE;
+	long linger = -1;
 	zval *tmpzval = NULL;
 
 #ifdef AF_UNIX
@@ -719,9 +748,27 @@ static inline int php_tcp_sockop_bind(php_stream *stream, php_netstream_data_t *
 	}
 #endif
 
+#ifdef SO_LINGER
+	if (PHP_STREAM_CONTEXT(stream)
+		&& (tmpzval = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "socket", "so_linger")) != NULL) {
+		bool failed;
+		linger = parse_linger(tmpzval, &failed);
+
+		if (failed) {
+			if (xparam->want_errortext) {
+				xparam->outputs.error_text = strpprintf(0, "Invalid `so_linger` value");
+			}
+			return -1;
+		} else {
+			sockopts |= STREAM_SOCKOP_SO_LINGER;
+		}
+	}
+#endif
+
 	sock->socket = php_network_bind_socket_to_local_addr(host, portno,
 			stream->ops == &php_stream_udp_socket_ops ? SOCK_DGRAM : SOCK_STREAM,
 			sockopts,
+			linger,
 			xparam->want_errortext ? &xparam->outputs.error_text : NULL,
 			&err
 			);
@@ -742,6 +789,7 @@ static inline int php_tcp_sockop_connect(php_stream *stream, php_netstream_data_
 	int ret;
 	zval *tmpzval = NULL;
 	long sockopts = STREAM_SOCKOP_NONE;
+	long linger = -1;
 
 #ifdef AF_UNIX
 	if (stream->ops == &php_stream_unix_socket_ops || stream->ops == &php_stream_unixdg_socket_ops) {
@@ -797,6 +845,23 @@ static inline int php_tcp_sockop_connect(php_stream *stream, php_netstream_data_
 	}
 #endif
 
+#ifdef SO_LINGER
+	if (PHP_STREAM_CONTEXT(stream)
+		&& (tmpzval = php_stream_context_get_option(PHP_STREAM_CONTEXT(stream), "socket", "so_linger")) != NULL) {
+		bool failed;
+		linger = parse_linger(tmpzval, &failed);
+
+		if (failed) {
+			if (xparam->want_errortext) {
+				xparam->outputs.error_text = strpprintf(0, "Invalid `so_linger` value");
+			}
+			return -1;
+		} else {
+			sockopts |= STREAM_SOCKOP_SO_LINGER;
+		}
+	}
+#endif
+
 	if (stream->ops != &php_stream_udp_socket_ops /* TCP_NODELAY is only applicable for TCP */
 #ifdef AF_UNIX
 		&& stream->ops != &php_stream_unix_socket_ops
@@ -821,7 +886,8 @@ static inline int php_tcp_sockop_connect(php_stream *stream, php_netstream_data_
 			&err,
 			bindto,
 			bindport,
-			sockopts
+			sockopts,
+			linger
 			);
 
 	ret = sock->socket == -1 ? -1 : 0;
