Add stubs for some SAPIs

For apache2handler, fpm, litespeed, phpdbg, specifically.
Partially implements GH-5295

Author: kocsismate

ext/standard/dl.c

@@ -38,7 +38,7 @@
 #endif
 #endif /* defined(HAVE_LIBDL) */
 
-/* {{{ proto int dl(string extension_filename)
+/* {{{ proto bool dl(string extension_filename)
    Load a PHP extension at runtime */
 PHPAPI PHP_FUNCTION(dl)
 {

ext/standard/dl.stub.php

@@ -0,0 +1,3 @@
+<?php
+
+function dl(string $extension_filename): bool {}

ext/standard/dl_arginfo.h

@@ -0,0 +1,5 @@
+/* This is a generated file, edit the .stub.php file instead. */
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_dl, 0, 1, _IS_BOOL, 0)
+	ZEND_ARG_TYPE_INFO(0, extension_filename, IS_STRING, 0)
+ZEND_END_ARG_INFO()

sapi/apache2handler/php_functions.c

@@ -476,20 +476,6 @@ PHP_MINFO_FUNCTION(apache)
 	}
 }
 
-static const zend_function_entry apache_functions[] = {
-	PHP_FE(apache_lookup_uri, 		arginfo_apache_lookup_uri)
-	PHP_FE(virtual, 				arginfo_virtual)
-	PHP_FE(apache_request_headers, 	arginfo_apache_request_headers)
-	PHP_FE(apache_response_headers, arginfo_apache_response_headers)
-	PHP_FE(apache_setenv, 		arginfo_apache_setenv)
-	PHP_FE(apache_getenv, 		arginfo_apache_getenv)
-	PHP_FE(apache_note, 		arginfo_apache_note)
-	PHP_FE(apache_get_version, 	arginfo_apache_get_version)
-	PHP_FE(apache_get_modules, 	arginfo_apache_get_modules)
-	PHP_FALIAS(getallheaders, 	apache_request_headers, arginfo_getallheaders)
-	{NULL, NULL, NULL}
-};
-
 PHP_INI_BEGIN()
 	STD_PHP_INI_ENTRY("xbithack",		"0",	PHP_INI_ALL,	OnUpdateBool,	xbithack,	php_apache2_info_struct, php_apache2_info)
 	STD_PHP_INI_ENTRY("engine",		"1",	PHP_INI_ALL,	OnUpdateBool,	engine, 	php_apache2_info_struct, php_apache2_info)
@@ -514,7 +500,7 @@ static PHP_MSHUTDOWN_FUNCTION(apache)
 zend_module_entry php_apache_module = {
 	STANDARD_MODULE_HEADER,
 	"apache2handler",
-	apache_functions,
+	ext_functions,
 	PHP_MINIT(apache),
 	PHP_MSHUTDOWN(apache),
 	NULL,

sapi/apache2handler/php_functions.stub.php

@@ -1,11 +1,14 @@
 <?php
 
+/** @generate-function-entries */
+
 function apache_lookup_uri(string $filename): object|false {}
 
 function virtual(string $uri): bool {}
 
 function apache_request_headers(): array {}
 
+/** @alias apache_request_headers */
 function getallheaders(): array {}
 
 function apache_response_headers(): array {}

sapi/apache2handler/php_functions_arginfo.h

@@ -35,3 +35,29 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_apache_get_version, 0, 0, MAY_BE
 ZEND_END_ARG_INFO()
 
 #define arginfo_apache_get_modules arginfo_apache_request_headers
+
+
+ZEND_FUNCTION(apache_lookup_uri);
+ZEND_FUNCTION(virtual);
+ZEND_FUNCTION(apache_request_headers);
+ZEND_FUNCTION(apache_response_headers);
+ZEND_FUNCTION(apache_note);
+ZEND_FUNCTION(apache_setenv);
+ZEND_FUNCTION(apache_getenv);
+ZEND_FUNCTION(apache_get_version);
+ZEND_FUNCTION(apache_get_modules);
+
+
+static const zend_function_entry ext_functions[] = {
+	ZEND_FE(apache_lookup_uri, arginfo_apache_lookup_uri)
+	ZEND_FE(virtual, arginfo_virtual)
+	ZEND_FE(apache_request_headers, arginfo_apache_request_headers)
+	ZEND_FALIAS(getallheaders, apache_request_headers, arginfo_getallheaders)
+	ZEND_FE(apache_response_headers, arginfo_apache_response_headers)
+	ZEND_FE(apache_note, arginfo_apache_note)
+	ZEND_FE(apache_setenv, arginfo_apache_setenv)
+	ZEND_FE(apache_getenv, arginfo_apache_getenv)
+	ZEND_FE(apache_get_version, arginfo_apache_get_version)
+	ZEND_FE(apache_get_modules, arginfo_apache_get_modules)
+	ZEND_FE_END
+};

sapi/fpm/fpm/fpm_main.c

@@ -82,6 +82,7 @@ int __riscosify_control = __RISCOSIFY_STRICT_UNIX_SPECS;
 
 #include <php_config.h>
 #include "fpm.h"
+#include "fpm_main_arginfo.h"
 #include "fpm_request.h"
 #include "fpm_status.h"
 #include "fpm_signals.h"
@@ -1457,9 +1458,6 @@ static PHP_MINFO_FUNCTION(cgi)
 }
 /* }}} */
 
-ZEND_BEGIN_ARG_INFO(cgi_fcgi_sapi_no_arginfo, 0)
-ZEND_END_ARG_INFO()
-
 PHP_FUNCTION(fastcgi_finish_request) /* {{{ */
 {
 	fcgi_request *request = (fcgi_request*) SG(server_context);
@@ -1510,18 +1508,10 @@ PHP_FUNCTION(fpm_get_status) /* {{{ */
 }
 /* }}} */
 
-static const zend_function_entry cgi_fcgi_sapi_functions[] = {
-	PHP_FE(fastcgi_finish_request,                    cgi_fcgi_sapi_no_arginfo)
-	PHP_FE(fpm_get_status,                            cgi_fcgi_sapi_no_arginfo)
-	PHP_FE(apache_request_headers,                    cgi_fcgi_sapi_no_arginfo)
-	PHP_FALIAS(getallheaders, apache_request_headers, cgi_fcgi_sapi_no_arginfo)
-	PHP_FE_END
-};
-
 static zend_module_entry cgi_module_entry = {
 	STANDARD_MODULE_HEADER,
 	"cgi-fcgi",
-	cgi_fcgi_sapi_functions,
+	ext_functions,
 	PHP_MINIT(cgi),
 	PHP_MSHUTDOWN(cgi),
 	NULL,

sapi/fpm/fpm/fpm_main.stub.php

@@ -0,0 +1,12 @@
+<?php
+
+/** @generate-function-entries */
+
+function fastcgi_finish_request(): bool {}
+
+function apache_request_headers(): array {}
+
+/** @alias apache_request_headers */
+function getallheaders(): array {}
+
+function fpm_get_status(): array|false {}

sapi/fpm/fpm/fpm_main_arginfo.h

@@ -0,0 +1,26 @@
+/* This is a generated file, edit the .stub.php file instead. */
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_fastcgi_finish_request, 0, 0, _IS_BOOL, 0)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_apache_request_headers, 0, 0, IS_ARRAY, 0)
+ZEND_END_ARG_INFO()
+
+#define arginfo_getallheaders arginfo_apache_request_headers
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_fpm_get_status, 0, 0, MAY_BE_ARRAY|MAY_BE_FALSE)
+ZEND_END_ARG_INFO()
+
+
+ZEND_FUNCTION(fastcgi_finish_request);
+ZEND_FUNCTION(apache_request_headers);
+ZEND_FUNCTION(fpm_get_status);
+
+
+static const zend_function_entry ext_functions[] = {
+	ZEND_FE(fastcgi_finish_request, arginfo_fastcgi_finish_request)
+	ZEND_FE(apache_request_headers, arginfo_apache_request_headers)
+	ZEND_FALIAS(getallheaders, apache_request_headers, arginfo_getallheaders)
+	ZEND_FE(fpm_get_status, arginfo_fpm_get_status)
+	ZEND_FE_END
+};

sapi/litespeed/lsapi_main.c

@@ -24,6 +24,7 @@
 #include "ext/standard/basic_functions.h"
 #include "ext/standard/info.h"
 #include "lsapilib.h"
+#include "lsapi_main_arginfo.h"
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -1615,29 +1616,13 @@ int main( int argc, char * argv[] )
 
 /*   LiteSpeed PHP module starts here */
 
-/* {{{ arginfo */
-ZEND_BEGIN_ARG_INFO(arginfo_litespeed__void, 0)
-ZEND_END_ARG_INFO()
-/* }}} */
-
 PHP_FUNCTION(litespeed_request_headers);
 PHP_FUNCTION(litespeed_response_headers);
 PHP_FUNCTION(apache_get_modules);
 PHP_FUNCTION(litespeed_finish_request);
 
 PHP_MINFO_FUNCTION(litespeed);
 
-static const zend_function_entry litespeed_functions[] = {
-    PHP_FE(litespeed_request_headers,   arginfo_litespeed__void)
-    PHP_FE(litespeed_response_headers,  arginfo_litespeed__void)
-    PHP_FE(apache_get_modules,          arginfo_litespeed__void)
-    PHP_FE(litespeed_finish_request,    arginfo_litespeed__void)
-    PHP_FALIAS(getallheaders,           litespeed_request_headers,  arginfo_litespeed__void)
-    PHP_FALIAS(apache_request_headers,  litespeed_request_headers,  arginfo_litespeed__void)
-    PHP_FALIAS(apache_response_headers, litespeed_response_headers, arginfo_litespeed__void)
-    {NULL, NULL, NULL}
-};
-
 static PHP_MINIT_FUNCTION(litespeed)
 {
     user_config_cache_init();
@@ -1675,7 +1660,7 @@ static PHP_MSHUTDOWN_FUNCTION(litespeed)
 zend_module_entry litespeed_module_entry = {
     STANDARD_MODULE_HEADER,
     "litespeed",
-    litespeed_functions,
+    ext_functions,
     PHP_MINIT(litespeed),
     PHP_MSHUTDOWN(litespeed),
     NULL,
@@ -1697,14 +1682,13 @@ static int add_associate_array( const char * pKey, int keyLen, const char * pVal
    Fetch all HTTP request headers */
 PHP_FUNCTION(litespeed_request_headers)
 {
-    /* TODO: */
-    if (ZEND_NUM_ARGS() > 0) {
-        WRONG_PARAM_COUNT;
+    if (zend_parse_parameters_none() == FAILURE) {
+        RETURN_THROWS();
     }
+
     array_init(return_value);
 
     LSAPI_ForeachOrgHeader( add_associate_array, return_value );
-
 }
 /* }}} */
 
@@ -1720,9 +1704,9 @@ PHP_FUNCTION(litespeed_response_headers)
     int          len;
     char         headerBuf[SAPI_LSAPI_MAX_HEADER_LENGTH];
 
-    if (ZEND_NUM_ARGS() > 0) {
-        WRONG_PARAM_COUNT;
-    }
+    if (zend_parse_parameters_none() == FAILURE) {
+		RETURN_THROWS();
+	}
 
     if (!&SG(sapi_headers).headers) {
         RETURN_FALSE;
@@ -1762,10 +1746,11 @@ PHP_FUNCTION(apache_get_modules)
         "mod_rewrite", "mod_mime", "mod_headers", "mod_expires", "mod_auth_basic", NULL
     };
     const char **name = mod_names;
-    /* TODO: */
-    if (ZEND_NUM_ARGS() > 0) {
-        WRONG_PARAM_COUNT;
-    }
+
+    if (zend_parse_parameters_none() == FAILURE) {
+		RETURN_THROWS();
+	}
+
     array_init(return_value);
     while( *name )
     {
@@ -1776,13 +1761,13 @@ PHP_FUNCTION(apache_get_modules)
 /* }}} */
 
 
-/* {{{ proto array litespeed_finish_request(void)
+/* {{{ proto bool litespeed_finish_request(void)
    Flushes all response data to the client */
 PHP_FUNCTION(litespeed_finish_request)
 {
-    if (ZEND_NUM_ARGS() > 0) {
-        WRONG_PARAM_COUNT;
-    }
+	if (zend_parse_parameters_none() == FAILURE) {
+		RETURN_THROWS();
+	}
 
     php_output_end_all();
     php_header();

sapi/litespeed/lsapi_main.stub.php

@@ -0,0 +1,20 @@
+<?php
+
+/** @generate-function-entries */
+
+function litespeed_request_headers(): array {}
+
+/** @alias litespeed_request_headers */
+function getallheaders(): array {}
+
+/** @alias litespeed_request_headers */
+function apache_request_headers(): array {}
+
+function litespeed_response_headers(): array|false {}
+
+/** @alias litespeed_response_headers */
+function apache_response_headers(): array|false {}
+
+function apache_get_modules(): array {}
+
+function litespeed_finish_request(): bool {}

sapi/litespeed/lsapi_main_arginfo.h

@@ -0,0 +1,36 @@
+/* This is a generated file, edit the .stub.php file instead. */
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_litespeed_request_headers, 0, 0, IS_ARRAY, 0)
+ZEND_END_ARG_INFO()
+
+#define arginfo_getallheaders arginfo_litespeed_request_headers
+
+#define arginfo_apache_request_headers arginfo_litespeed_request_headers
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_litespeed_response_headers, 0, 0, MAY_BE_ARRAY|MAY_BE_FALSE)
+ZEND_END_ARG_INFO()
+
+#define arginfo_apache_response_headers arginfo_litespeed_response_headers
+
+#define arginfo_apache_get_modules arginfo_litespeed_request_headers
+
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_litespeed_finish_request, 0, 0, _IS_BOOL, 0)
+ZEND_END_ARG_INFO()
+
+
+ZEND_FUNCTION(litespeed_request_headers);
+ZEND_FUNCTION(litespeed_response_headers);
+ZEND_FUNCTION(apache_get_modules);
+ZEND_FUNCTION(litespeed_finish_request);
+
+
+static const zend_function_entry ext_functions[] = {
+	ZEND_FE(litespeed_request_headers, arginfo_litespeed_request_headers)
+	ZEND_FALIAS(getallheaders, litespeed_request_headers, arginfo_getallheaders)
+	ZEND_FALIAS(apache_request_headers, litespeed_request_headers, arginfo_apache_request_headers)
+	ZEND_FE(litespeed_response_headers, arginfo_litespeed_response_headers)
+	ZEND_FALIAS(apache_response_headers, litespeed_response_headers, arginfo_apache_response_headers)
+	ZEND_FE(apache_get_modules, arginfo_apache_get_modules)
+	ZEND_FE(litespeed_finish_request, arginfo_litespeed_finish_request)
+	ZEND_FE_END
+};