From 56fea5995d513ff658dc663c35ec0046332eff48 Mon Sep 17 00:00:00 2001 From: Niels Dossche <7771979+nielsdos@users.noreply.github.com> Date: Sun, 8 Sep 2024 13:19:16 +0200 Subject: [PATCH 1/3] Introduce get_serialization_string_from_zval() and use it in to_xml_string() For now this new function only returns a copy of the string, but its functionality will be expanded by later commits. to_xml_string() now uses this function and the memory management is simplified as well. --- ext/soap/php_encoding.c | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/ext/soap/php_encoding.c b/ext/soap/php_encoding.c index ee3b9ccc9bb..1b863061ad5 100644 --- a/ext/soap/php_encoding.c +++ b/ext/soap/php_encoding.c @@ -24,6 +24,7 @@ #include #include "zend_strtod.h" #include "zend_interfaces.h" +#include "zend_enum.h" /* zval type decode */ static zval *to_zval_double(zval* ret, encodeTypePtr type, xmlNodePtr data); @@ -822,25 +823,25 @@ static zval *to_zval_hexbin(zval *ret, encodeTypePtr type, xmlNodePtr data) return ret; } +static zend_string *get_serialization_string_from_zval(zval *data) +{ + switch (Z_TYPE_P(data)) { + default: + return zval_get_string_func(data); + } +} + static xmlNodePtr to_xml_string(encodeTypePtr type, zval *data, int style, xmlNodePtr parent) { xmlNodePtr ret, text; - char *str; - int new_len; ret = xmlNewNode(NULL, BAD_CAST("BOGUS")); xmlAddChild(parent, ret); FIND_ZVAL_NULL(data, ret, style); - if (Z_TYPE_P(data) == IS_STRING) { - str = estrndup(Z_STRVAL_P(data), Z_STRLEN_P(data)); - new_len = Z_STRLEN_P(data); - } else { - zend_string *tmp = zval_get_string_func(data); - str = estrndup(ZSTR_VAL(tmp), ZSTR_LEN(tmp)); - new_len = ZSTR_LEN(tmp); - zend_string_release_ex(tmp, 0); - } + zend_string *serialization = get_serialization_string_from_zval(data); + char *str = ZSTR_VAL(serialization); + size_t new_len = ZSTR_LEN(serialization); if (SOAP_GLOBAL(encoding) != NULL) { xmlBufferPtr in = xmlBufferCreateStatic(str, new_len); @@ -848,7 +849,8 @@ static xmlNodePtr to_xml_string(encodeTypePtr type, zval *data, int style, xmlNo int n = xmlCharEncInFunc(SOAP_GLOBAL(encoding), out, in); if (n >= 0) { - efree(str); + zend_string_release(serialization); + serialization = NULL; str = estrdup((char*)xmlBufferContent(out)); new_len = n; } @@ -899,7 +901,11 @@ static xmlNodePtr to_xml_string(encodeTypePtr type, zval *data, int style, xmlNo text = xmlNewTextLen(BAD_CAST(str), new_len); xmlAddChild(ret, text); - efree(str); + if (serialization) { + zend_string_release(serialization); + } else { + efree(str); + } if (style == SOAP_ENCODED) { set_ns_and_type(ret, type); From ca66a11c369d0ce7809bd803c7f7406c8d367971 Mon Sep 17 00:00:00 2001 From: Niels Dossche <7771979+nielsdos@users.noreply.github.com> Date: Sun, 8 Sep 2024 13:27:42 +0200 Subject: [PATCH 2/3] Use get_serialization_string_from_zval() in all encoding functions --- ext/soap/php_encoding.c | 26 +++++++++----------------- 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/ext/soap/php_encoding.c b/ext/soap/php_encoding.c index 1b863061ad5..790a7029a63 100644 --- a/ext/soap/php_encoding.c +++ b/ext/soap/php_encoding.c @@ -916,19 +916,14 @@ static xmlNodePtr to_xml_string(encodeTypePtr type, zval *data, int style, xmlNo static xmlNodePtr to_xml_base64(encodeTypePtr type, zval *data, int style, xmlNodePtr parent) { xmlNodePtr ret, text; - zend_string *str; ret = xmlNewNode(NULL, BAD_CAST("BOGUS")); xmlAddChild(parent, ret); FIND_ZVAL_NULL(data, ret, style); - if (Z_TYPE_P(data) == IS_STRING) { - str = php_base64_encode((unsigned char*)Z_STRVAL_P(data), Z_STRLEN_P(data)); - } else { - zend_string *tmp = zval_get_string_func(data); - str = php_base64_encode((unsigned char*) ZSTR_VAL(tmp), ZSTR_LEN(tmp)); - zend_string_release_ex(tmp, 0); - } + zend_string *serialization = get_serialization_string_from_zval(data); + zend_string *str = php_base64_encode((unsigned char *) ZSTR_VAL(serialization), ZSTR_LEN(serialization)); + zend_string_release(serialization); text = xmlNewTextLen(BAD_CAST(ZSTR_VAL(str)), ZSTR_LEN(str)); xmlAddChild(ret, text); @@ -953,7 +948,7 @@ static xmlNodePtr to_xml_hexbin(encodeTypePtr type, zval *data, int style, xmlNo FIND_ZVAL_NULL(data, ret, style); if (Z_TYPE_P(data) != IS_STRING) { - ZVAL_STR(&tmp, zval_get_string_func(data)); + ZVAL_STR(&tmp, get_serialization_string_from_zval(data)); data = &tmp; } str = (unsigned char *) safe_emalloc(Z_STRLEN_P(data) * 2, sizeof(char), 1); @@ -3006,7 +3001,7 @@ static xmlNodePtr to_xml_list(encodeTypePtr enc, zval *data, int style, xmlNodeP smart_str list = {0}; if (Z_TYPE_P(data) != IS_STRING) { - ZVAL_STR(&tmp, zval_get_string_func(data)); + ZVAL_STR(&tmp, get_serialization_string_from_zval(data)); data = &tmp; } str = estrndup(Z_STRVAL_P(data), Z_STRLEN_P(data)); @@ -3115,13 +3110,10 @@ static xmlNodePtr to_xml_any(encodeTypePtr type, zval *data, int style, xmlNodeP } ZEND_HASH_FOREACH_END(); return ret; } - if (Z_TYPE_P(data) == IS_STRING) { - ret = xmlNewTextLen(BAD_CAST(Z_STRVAL_P(data)), Z_STRLEN_P(data)); - } else { - zend_string *tmp = zval_get_string_func(data); - ret = xmlNewTextLen(BAD_CAST(ZSTR_VAL(tmp)), ZSTR_LEN(tmp)); - zend_string_release_ex(tmp, 0); - } + + zend_string *serialization = get_serialization_string_from_zval(data); + ret = xmlNewTextLen(BAD_CAST(ZSTR_VAL(serialization)), ZSTR_LEN(serialization)); + zend_string_release_ex(serialization, false); ret->name = xmlStringTextNoenc; ret->parent = parent; From 25289dd08eccea020798f4512c3bd1aee5ff4d4f Mon Sep 17 00:00:00 2001 From: Niels Dossche <7771979+nielsdos@users.noreply.github.com> Date: Sun, 8 Sep 2024 13:58:29 +0200 Subject: [PATCH 3/3] Fix GH-15711: SoapClient can't convert BackedEnum to scalar value Allow SoapClient to use the backing value during response serialization. Closes GH-15803. --- NEWS | 2 + ext/soap/php_encoding.c | 37 +++++++++++++++- ext/soap/tests/gh15711.phpt | 88 +++++++++++++++++++++++++++++++++++++ ext/soap/tests/gh15711.wsdl | 39 ++++++++++++++++ 4 files changed, 165 insertions(+), 1 deletion(-) create mode 100644 ext/soap/tests/gh15711.phpt create mode 100644 ext/soap/tests/gh15711.wsdl diff --git a/NEWS b/NEWS index 1c1cf6acae6..44c6a11c17c 100644 --- a/NEWS +++ b/NEWS @@ -10,6 +10,8 @@ PHP NEWS . Fixed bug #73182 (PHP SOAPClient does not support stream context HTTP headers in array form). (nielsdos) . Fixed bug #62900 (Wrong namespace on xsd import error message). (nielsdos) + . Fixed bug GH-15711 (SoapClient can't convert BackedEnum to scalar value). + (nielsdos) 12 Sep 2024, PHP 8.3.12 diff --git a/ext/soap/php_encoding.c b/ext/soap/php_encoding.c index 790a7029a63..fda34b080e3 100644 --- a/ext/soap/php_encoding.c +++ b/ext/soap/php_encoding.c @@ -826,11 +826,46 @@ static zval *to_zval_hexbin(zval *ret, encodeTypePtr type, xmlNodePtr data) static zend_string *get_serialization_string_from_zval(zval *data) { switch (Z_TYPE_P(data)) { + case IS_OBJECT: + if (Z_OBJCE_P(data)->ce_flags & ZEND_ACC_ENUM) { + if (UNEXPECTED(Z_OBJCE_P(data)->enum_backing_type == IS_UNDEF)) { + zend_value_error("Non-backed enums have no default serialization"); + return zend_empty_string; + } else { + zval *value = zend_enum_fetch_case_value(Z_OBJ_P(data)); + return zval_get_string_func(value); + } + } + ZEND_FALLTHROUGH; default: return zval_get_string_func(data); } } +static zend_long get_serialization_long_from_zval(zval *data) +{ + switch (Z_TYPE_P(data)) { + case IS_OBJECT: + if (Z_OBJCE_P(data)->ce_flags & ZEND_ACC_ENUM) { + if (UNEXPECTED(Z_OBJCE_P(data)->enum_backing_type != IS_LONG)) { + if (Z_OBJCE_P(data)->enum_backing_type == IS_UNDEF) { + zend_value_error("Non-backed enums have no default serialization"); + } else { + zend_value_error("String-backed enum cannot be serialized as int"); + } + return 0; + } else { + zval *value = zend_enum_fetch_case_value(Z_OBJ_P(data)); + ZEND_ASSERT(Z_TYPE_P(value) == IS_LONG); + return Z_LVAL_P(value); + } + } + ZEND_FALLTHROUGH; + default: + return zval_get_long(data); + } +} + static xmlNodePtr to_xml_string(encodeTypePtr type, zval *data, int style, xmlNodePtr parent) { xmlNodePtr ret, text; @@ -1056,7 +1091,7 @@ static xmlNodePtr to_xml_long(encodeTypePtr type, zval *data, int style, xmlNode snprintf(s, sizeof(s), "%0.0F",floor(Z_DVAL_P(data))); xmlNodeSetContent(ret, BAD_CAST(s)); } else { - zend_string *str = zend_long_to_str(zval_get_long(data)); + zend_string *str = zend_long_to_str(get_serialization_long_from_zval(data)); xmlNodeSetContentLen(ret, BAD_CAST(ZSTR_VAL(str)), ZSTR_LEN(str)); zend_string_release_ex(str, 0); } diff --git a/ext/soap/tests/gh15711.phpt b/ext/soap/tests/gh15711.phpt new file mode 100644 index 00000000000..a49ff280fee --- /dev/null +++ b/ext/soap/tests/gh15711.phpt @@ -0,0 +1,88 @@ +--TEST-- +GH-15711 (SoapClient can't convert BackedEnum to scalar value) +--EXTENSIONS-- +soap +--INI-- +soap.wsdl_cache_enabled=0 +--FILE-- + ['book' => 'book']]); + +echo "--- Test with backed enum ---\n"; + +$book = new stdClass(); +$book->base64 = StringBackedEnum::First; +$book->string = StringBackedEnum::Second; +$book->any = StringBackedEnum::Third; +$book->hexbin = StringBackedEnum::Fourth; +$book->nmtokens = StringBackedEnum::Fifth; +$book->integer = IntBackedEnum::First; +$book->short = IntBackedEnum::Second; + +try { + $client->dotest($book); +} catch (Throwable) {} + +echo "--- Test with non-backed enum ---\n"; + +$book = new stdClass(); +$book->base64 = NonBackedEnum::First; +$book->string = NonBackedEnum::First; +$book->any = NonBackedEnum::First; +$book->hexbin = NonBackedEnum::First; +$book->nmtokens = NonBackedEnum::First; +$book->integer = NonBackedEnum::First; +$book->short = NonBackedEnum::First; + +try { + $client->dotest($book); +} catch (ValueError $e) { + echo "ValueError: ", $e->getMessage(), "\n"; +} + +echo "--- Test with mismatched enum backing type ---\n"; + +$book->integer = StringBackedEnum::First; +$book->short = StringBackedEnum::First; +try { + $client->dotest($book); +} catch (ValueError $e) { + echo "ValueError: ", $e->getMessage(), "\n"; +} + +?> +--EXPECT-- +--- Test with backed enum --- + +QmFja2luZ1ZhbHVlMQ==BackingValue2ThirdBackingValue34261636B696E6756616C756534BackingValue512 +--- Test with non-backed enum --- +ValueError: Non-backed enums have no default serialization +--- Test with mismatched enum backing type --- +ValueError: String-backed enum cannot be serialized as int diff --git a/ext/soap/tests/gh15711.wsdl b/ext/soap/tests/gh15711.wsdl new file mode 100644 index 00000000000..b49ef987b82 --- /dev/null +++ b/ext/soap/tests/gh15711.wsdl @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +