Implement FR #77377 handle CTRL+C in Windows

Author: weltling

ext/standard/basic_functions.c

@@ -2722,6 +2722,16 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_sapi_windows_cp_conv, 0, 0, 3)
 	ZEND_ARG_INFO(0, out_codepage)
 	ZEND_ARG_TYPE_INFO(0, subject, IS_STRING, 0)
 ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_INFO_EX(arginfo_sapi_windows_set_ctrl_handler, 0, 0, 1)
+	ZEND_ARG_INFO(0, callable)
+	ZEND_ARG_INFO(0, add)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_INFO_EX(arginfo_sapi_windows_generate_ctrl_event, 0, 0, 1)
+	ZEND_ARG_INFO(0, event)
+	ZEND_ARG_INFO(0, pid)
+ZEND_END_ARG_INFO()
 #endif
 /* }}} */
 /* }}} */
@@ -3437,6 +3447,8 @@ static const zend_function_entry basic_functions[] = { /* {{{ */
 	PHP_FE(sapi_windows_cp_get, arginfo_sapi_windows_cp_get)
 	PHP_FE(sapi_windows_cp_is_utf8, arginfo_sapi_windows_cp_is_utf8)
 	PHP_FE(sapi_windows_cp_conv, arginfo_sapi_windows_cp_conv)
+	PHP_FE(sapi_windows_set_ctrl_handler, arginfo_sapi_windows_set_ctrl_handler)
+	PHP_FE(sapi_windows_generate_ctrl_event, arginfo_sapi_windows_generate_ctrl_event)
 #endif
 	PHP_FE_END
 };

ext/standard/basic_functions.h

@@ -138,6 +138,8 @@ PHP_FUNCTION(sapi_windows_cp_set);
 PHP_FUNCTION(sapi_windows_cp_get);
 PHP_FUNCTION(sapi_windows_cp_is_utf8);
 PHP_FUNCTION(sapi_windows_cp_conv);
+PHP_FUNCTION(sapi_windows_set_ctrl_handler);
+PHP_FUNCTION(sapi_windows_generate_ctrl_event);
 #endif
 
 PHP_FUNCTION(str_rot13);

ext/standard/proc_open.c

@@ -438,6 +438,7 @@ PHP_FUNCTION(proc_open)
 	int suppress_errors = 0;
 	int bypass_shell = 0;
 	int blocking_pipes = 0;
+	int create_process_group = 0;
 #endif
 #if PHP_CAN_DO_PTS
 	php_file_descriptor_t dev_ptmx = -1;	/* master */
@@ -478,6 +479,13 @@ PHP_FUNCTION(proc_open)
 				blocking_pipes = 1;
 			}
 		}
+
+		item = zend_hash_str_find(Z_ARRVAL_P(other_options), "create_process_group", sizeof("create_process_group") - 1);
+		if (item != NULL) {
+			if (Z_TYPE_P(item) == IS_TRUE || ((Z_TYPE_P(item) == IS_LONG) && Z_LVAL_P(item))) {
+				create_process_group = 1;
+			}
+		}
 	}
 #endif
 
@@ -716,6 +724,9 @@ PHP_FUNCTION(proc_open)
 	if(strcmp(sapi_module.name, "cli") != 0) {
 		dwCreateFlags |= CREATE_NO_WINDOW;
 	}
+	if (create_process_group) {
+		dwCreateFlags |= CREATE_NEW_PROCESS_GROUP;
+	}
 
 	envpw = php_win32_cp_env_any_to_w(env.envp);
 	if (envpw) {

main/main.c

@@ -2191,6 +2191,7 @@ int php_module_startup(sapi_module_struct *sf, zend_module_entry *additional_mod
 		php_printf("\nwinsock.dll unusable. %d\n", WSAGetLastError());
 		return FAILURE;
 	}
+	php_win32_signal_ctrl_handler_init();
 #endif
 
 	le_index_ptr = zend_register_list_destructors_ex(NULL, NULL, "index pointer", 0);
@@ -2478,6 +2479,7 @@ void php_module_shutdown(void)
 
 #ifdef PHP_WIN32
 	(void)php_win32_shutdown_random_bytes();
+	php_win32_signal_ctrl_handler_shutdown();
 #endif
 
 	sapi_flush();

sapi/cli/tests/sapi_windows_set_ctrl_handler.phpt

@@ -0,0 +1,75 @@
+--TEST--
+sapi_windows_set_ctrl_handler() 
+--SKIPIF--
+<?php
+
+include "skipinf.inc";
+
+if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN')
+  die("skip this test is for Windows platforms only");
+?>
+--FILE--
+<?php
+
+$is_child = isset($argv[1]);
+
+
+if ($is_child) {
+	function handler($evt)
+	{
+		echo "\nCaught " . get_evt_name($evt), ", wait, wait ...!\n";
+		exit;
+	}
+
+	sapi_windows_set_ctrl_handler('handler');
+
+	while(1) usleep(100);
+} else {
+	$cmd = PHP_BINARY . " -n " . $argv[0] . " 1";
+	$spec = [0 => ["pipe", "r"], 1 => ["pipe", "w"]];
+
+	$proc = proc_open($cmd, $spec, $pipes, NULL, NULL, ["bypass_shell" => true, "create_process_group" => true]);
+
+	if (!is_resource($proc)) {
+		die("Failed to start child. ");
+	}
+
+	$child_pid = proc_get_status($proc)["pid"];
+	echo "Started child $child_pid\n";
+	usleep(300);
+
+	$cmd = "tasklist /FI \"PID eq $child_pid\" /NH";
+	echo "Running `$cmd` to check the process indeed exists:\n";
+	echo trim(shell_exec($cmd)) . "\n";
+
+	$evt = PHP_WINDOWS_EVENT_CTRL_C;
+	echo "Sending ", get_evt_name($evt), " to child $child_pid\n";
+	$ret = sapi_windows_generate_ctrl_event($evt, $child_pid);
+
+	echo "Child said: \"",  trim(fread($pipes[1], 48)), "\"\n";
+
+	echo ($ret ? "Successfully" : "Unsuccessfuly"), " sent ", get_evt_name($evt), " to child $child_pid\n";
+
+	proc_close($proc);
+}
+
+function get_evt_name(int $evt) : ?string
+{
+	if (PHP_WINDOWS_EVENT_CTRL_C == $evt) {
+		return "CTRL+C";
+	} if (PHP_WINDOWS_EVENT_CTRL_BREAK == $evt) {
+		return "CTRL+BREAK";
+	}
+
+	return NULL;
+}
+
+?>
+--EXPECTF--
+Started child %d
+Running `tasklist /FI "PID eq %d" /NH` to check the process indeed exists:
+php.exe%w%d%s1%s
+Sending CTRL+C to child %d
+Child said: "Caught CTRL+C, wait, wait ...!"
+Successfully sent CTRL+C to child %d
+

win32/build/config.w32

@@ -268,7 +268,7 @@ if (VS_TOOLSET && VCVERS >= 1914) {
 ADD_SOURCES("win32", "dllmain.c glob.c readdir.c \
 	registry.c select.c sendmail.c time.c winutil.c wsyslog.c globals.c \
 	getrusage.c ftok.c ioutil.c codepage.c nice.c \
-	inet.c fnmatch.c sockets.c console.c");
+	inet.c fnmatch.c sockets.c console.c signal.c");
 
 ADD_FLAG("CFLAGS_BD_WIN32", "/D ZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
 if (VS_TOOLSET && VCVERS >= 1914) {

win32/codepage.c

@@ -22,6 +22,8 @@
 #include "SAPI.h"
 #include <emmintrin.h>
 
+#include "win32/console.h"
+
 ZEND_TLS const struct php_win32_cp *cur_cp = NULL;
 ZEND_TLS const struct php_win32_cp *orig_cp = NULL;
 ZEND_TLS const struct php_win32_cp *cur_out_cp = NULL;
@@ -289,11 +291,6 @@ __forceinline static char *php_win32_cp_get_enc(void)
 	return enc;
 }/*}}}*/
 
-__forceinline static BOOL php_win32_cp_is_cli_sapi()
-{/*{{{*/
-	return strlen(sapi_module.name) >= sizeof("cli") - 1 && !strncmp(sapi_module.name, "cli", sizeof("cli") - 1);
-}/*}}}*/
-
 PW32CP const struct php_win32_cp *php_win32_cp_get_current(void)
 {/*{{{*/
 	return cur_cp;
@@ -473,7 +470,7 @@ PW32CP const struct php_win32_cp *php_win32_cp_do_setup(const char *enc)
 	if (!orig_cp) {
 		orig_cp = php_win32_cp_get_by_id(GetACP());
 	}
-	if (php_win32_cp_is_cli_sapi()) {
+	if (php_win32_console_is_cli_sapi()) {
 		if (!orig_in_cp) {
 			orig_in_cp = php_win32_cp_get_by_id(GetConsoleCP());
 			if (!orig_in_cp) {
@@ -499,7 +496,7 @@ PW32CP const struct php_win32_cp *php_win32_cp_do_update(const char *enc)
 	}
 	cur_cp = php_win32_cp_get_by_enc(enc);
 
-	if (php_win32_cp_is_cli_sapi()) {
+	if (php_win32_console_is_cli_sapi()) {
 		php_win32_cp_cli_do_setup(cur_cp->id);
 	}
 
@@ -574,7 +571,7 @@ PHP_FUNCTION(sapi_windows_cp_set)
 		RETURN_FALSE;
 	}
 
-	if (php_win32_cp_is_cli_sapi()) {
+	if (php_win32_console_is_cli_sapi()) {
 		cp = php_win32_cp_cli_do_setup((DWORD)id);
 	} else {
 		cp = php_win32_cp_set_by_id((DWORD)id);

win32/console.c

@@ -16,6 +16,8 @@
    +----------------------------------------------------------------------+
  */
 
+#include "php.h"
+#include "SAPI.h"
 #include "win32/console.h"
 
 
@@ -108,3 +110,9 @@ PHP_WINUTIL_API BOOL php_win32_console_is_own(void)
 
 	return FALSE;
 }/*}}}*/
+
+PHP_WINUTIL_API BOOL php_win32_console_is_cli_sapi(void)
+{/*{{{*/
+	return strlen(sapi_module.name) >= sizeof("cli") - 1 && !strncmp(sapi_module.name, "cli", sizeof("cli") - 1);
+}/*}}}*/
+

win32/console.h

@@ -59,4 +59,7 @@ PHP_WINUTIL_API BOOL php_win32_console_fileno_set_vt100(zend_long fileno, BOOL e
 	http://support.microsoft.com/kb/99115 */
 PHP_WINUTIL_API BOOL php_win32_console_is_own(void);
 
+/* Check whether the current SAPI is run on console. */
+PHP_WINUTIL_API BOOL php_win32_console_is_cli_sapi(void);
+
 #endif