Add Uri\WhatWg classes to ext/uri (#18672)

Relates to #14461 and https://wiki.php.net/rfc/url_parsing_api

Co-authored-by: Niels Dossche <[email protected]>
Co-authored-by: Tim Düsterhus <[email protected]>

Author: 3 people

UPGRADING.INTERNALS

@@ -34,6 +34,9 @@ PHP 8.5 INTERNALS UPGRADE NOTES
   . Added ZEND_NONSTRING attribute macro for character arrays that do not
     represent strings. This allows to silence the GCC 15.x
     `-Wunterminated-string-initialization` warning.
+  . Added the zend_update_exception_properties() function for instantiating
+    Exception child classes. It updates the $message, $code, and $previous
+    properties.
 
 ========================
 2. Build system changes

Zend/zend_exceptions.c

@@ -329,42 +329,51 @@ ZEND_COLD ZEND_METHOD(Exception, __clone)
 }
 /* }}} */
 
-/* {{{ Exception constructor */
-ZEND_METHOD(Exception, __construct)
+ZEND_API zend_result zend_update_exception_properties(INTERNAL_FUNCTION_PARAMETERS, zend_string *message, zend_long code, zval *previous)
 {
-	zend_string *message = NULL;
-	zend_long   code = 0;
-	zval  tmp, *object, *previous = NULL;
-
-	object = ZEND_THIS;
-
-	if (zend_parse_parameters(ZEND_NUM_ARGS(), "|SlO!", &message, &code, &previous, zend_ce_throwable) == FAILURE) {
-		RETURN_THROWS();
-	}
+	zval tmp, *object = ZEND_THIS;
 
 	if (message) {
 		ZVAL_STR_COPY(&tmp, message);
 		zend_update_property_num_checked(NULL, Z_OBJ_P(object), ZEND_EXCEPTION_MESSAGE_OFF, ZSTR_KNOWN(ZEND_STR_MESSAGE), &tmp);
 		if (UNEXPECTED(EG(exception))) {
-			RETURN_THROWS();
+			return FAILURE;
 		}
 	}
 
 	if (code) {
 		ZVAL_LONG(&tmp, code);
 		zend_update_property_num_checked(NULL, Z_OBJ_P(object), ZEND_EXCEPTION_CODE_OFF, ZSTR_KNOWN(ZEND_STR_CODE), &tmp);
 		if (UNEXPECTED(EG(exception))) {
-			RETURN_THROWS();
+			return FAILURE;
 		}
 	}
 
 	if (previous) {
 		Z_ADDREF_P(previous);
 		zend_update_property_num_checked(zend_ce_exception, Z_OBJ_P(object), ZEND_EXCEPTION_PREVIOUS_OFF, ZSTR_KNOWN(ZEND_STR_PREVIOUS), previous);
 		if (UNEXPECTED(EG(exception))) {
-			RETURN_THROWS();
+			return FAILURE;
 		}
 	}
+
+	return SUCCESS;
+}
+
+/* {{{ Exception constructor */
+ZEND_METHOD(Exception, __construct)
+{
+	zend_string *message = NULL;
+	zend_long   code = 0;
+	zval *previous = NULL;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "|SlO!", &message, &code, &previous, zend_ce_throwable) == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	if (zend_update_exception_properties(INTERNAL_FUNCTION_PARAM_PASSTHRU, message, code, previous) == FAILURE) {
+		RETURN_THROWS();
+	}
 }
 /* }}} */
 
@@ -401,28 +410,8 @@ ZEND_METHOD(ErrorException, __construct)
 
 	object = ZEND_THIS;
 
-	if (message) {
-		ZVAL_STR_COPY(&tmp, message);
-		zend_update_property_num_checked(NULL, Z_OBJ_P(object), ZEND_EXCEPTION_MESSAGE_OFF, ZSTR_KNOWN(ZEND_STR_MESSAGE), &tmp);
-		if (UNEXPECTED(EG(exception))) {
-			RETURN_THROWS();
-		}
-	}
-
-	if (code) {
-		ZVAL_LONG(&tmp, code);
-		zend_update_property_num_checked(NULL, Z_OBJ_P(object), ZEND_EXCEPTION_CODE_OFF, ZSTR_KNOWN(ZEND_STR_CODE), &tmp);
-		if (UNEXPECTED(EG(exception))) {
-			RETURN_THROWS();
-		}
-	}
-
-	if (previous) {
-		Z_ADDREF_P(previous);
-		zend_update_property_num_checked(zend_ce_exception, Z_OBJ_P(object), ZEND_EXCEPTION_PREVIOUS_OFF, ZSTR_KNOWN(ZEND_STR_PREVIOUS), previous);
-		if (UNEXPECTED(EG(exception))) {
-			RETURN_THROWS();
-		}
+	if (zend_update_exception_properties(INTERNAL_FUNCTION_PARAM_PASSTHRU, message, code, previous) == FAILURE) {
+		RETURN_THROWS();
 	}
 
 	ZVAL_LONG(&tmp, severity);

Zend/zend_exceptions.h

@@ -69,6 +69,8 @@ ZEND_API zend_object *zend_throw_error_exception(zend_class_entry *exception_ce,
 
 extern ZEND_API void (*zend_throw_exception_hook)(zend_object *ex);
 
+ZEND_API zend_result zend_update_exception_properties(INTERNAL_FUNCTION_PARAMETERS, zend_string *message, zend_long code, zval *previous);
+
 /* show an exception using zend_error(severity,...), severity should be E_ERROR */
 ZEND_API ZEND_COLD zend_result zend_exception_error(zend_object *exception, int severity);
 ZEND_NORETURN void zend_exception_uncaught_error(const char *prefix, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2);

Zend/zend_string.h

@@ -597,7 +597,9 @@ EMPTY_SWITCH_DEFAULT_CASE()
 	_(ZEND_STR_HOST,                   "host") \
 	_(ZEND_STR_PORT,                   "port") \
 	_(ZEND_STR_USER,                   "user") \
+	_(ZEND_STR_USERNAME,               "username") \
 	_(ZEND_STR_PASS,                   "pass") \
+	_(ZEND_STR_PASSWORD,               "password") \
 	_(ZEND_STR_PATH,                   "path") \
 	_(ZEND_STR_QUERY,                  "query") \
 	_(ZEND_STR_FRAGMENT,               "fragment") \

build/gen_stub.php

@@ -3055,6 +3055,8 @@ class PropertyInfo extends VariableLike
     private const PHP_85_KNOWN = [
         "self" => "ZEND_STR_SELF",
         "parent" => "ZEND_STR_PARENT",
+        "username" => "ZEND_STR_USERNAME",
+        "password" => "ZEND_STR_PASSWORD",
     ];
 
     /**

ext/uri/config.m4

@@ -2,7 +2,9 @@ dnl Configure options
 dnl
 
 PHP_INSTALL_HEADERS([ext/uri], m4_normalize([
+  php_lexbor.h
   php_uri.h
+  php_uri_common.h
 ]))
 
 AC_DEFINE([URI_ENABLE_ANSI], [1], [Define to 1 for enabling ANSI support of uriparser.])
@@ -15,6 +17,6 @@ $URIPARSER_DIR/src/UriMemory.c $URIPARSER_DIR/src/UriNormalize.c $URIPARSER_DIR/
 $URIPARSER_DIR/src/UriParse.c $URIPARSER_DIR/src/UriParseBase.c $URIPARSER_DIR/src/UriQuery.c \
 $URIPARSER_DIR/src/UriRecompose.c $URIPARSER_DIR/src/UriResolve.c $URIPARSER_DIR/src/UriShorten.c"
 
-PHP_NEW_EXTENSION(uri, [php_uri.c $URIPARSER_SOURCES], [no],,[-I$ext_srcdir/$URIPARSER_DIR/include -DURI_STATIC_BUILD -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1])
+PHP_NEW_EXTENSION(uri, [php_lexbor.c php_uri.c php_uri_common.c $URIPARSER_SOURCES], [no],,[-I$ext_srcdir/$URIPARSER_DIR/include -DURI_STATIC_BUILD -DZEND_ENABLE_STATIC_TSRMLS_CACHE=1])
 PHP_ADD_EXTENSION_DEP(uri, lexbor)
 PHP_ADD_BUILD_DIR($ext_builddir/$URIPARSER_DIR/src $ext_builddir/$URIPARSER_DIR/include)

ext/uri/config.w32

@@ -1,9 +1,9 @@
-EXTENSION("uri", "php_uri.c", false /* never shared */, "/I ext/lexbor /I ext/uri/uriparser/include /DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
+EXTENSION("uri", "php_lexbor.c php_uri.c php_uri_common.c", false /* never shared */, "/I ext/lexbor /I ext/uri/uriparser/include /DZEND_ENABLE_STATIC_TSRMLS_CACHE=1");
 
 AC_DEFINE("URI_ENABLE_ANSI", 1, "Define to 1 for enabling ANSI support of uriparser.")
 AC_DEFINE("URI_NO_UNICODE", 1, "Define to 1 for disabling unicode support of uriparser.")
 ADD_FLAG("CFLAGS_URI", "/D URI_STATIC_BUILD");
 
 ADD_EXTENSION_DEP('uri', 'lexbor');
 ADD_SOURCES("ext/uri/uriparser/src", "UriCommon.c UriCompare.c UriEscape.c UriFile.c UriIp4.c UriIp4Base.c UriMemory.c UriNormalize.c UriNormalizeBase.c UriParse.c UriParseBase.c UriQuery.c UriRecompose.c UriShorten.c", "uri");
-PHP_INSTALL_HEADERS("ext/uri", "php_uri.h uriparser/src uriparser/include");
+PHP_INSTALL_HEADERS("ext/uri", "php_lexbor.h php_uri.h php_uri_common.h uriparser/src uriparser/include");