Implement optional stringable behaviour for http_build_query

Author: nielsdos

ext/standard/http.c

@@ -95,6 +95,61 @@ static void php_url_encode_scalar(zval *scalar, smart_str *form_str,
 	}
 }
 
+enum property_status {
+	PROPERTY_STATUS_UNDEF,
+	PROPERTY_STATUS_DYNAMIC,
+	PROPERTY_STATUS_NOT_DYNAMIC,
+};
+
+static zend_always_inline zval* compute_is_undef_or_dynamic_property(zval *zdata, enum property_status* status) {
+	if (Z_TYPE_P(zdata) == IS_INDIRECT) {
+		zdata = Z_INDIRECT_P(zdata);
+		if (Z_ISUNDEF_P(zdata)) {
+			*status = PROPERTY_STATUS_UNDEF;
+		}
+
+		*status = PROPERTY_STATUS_NOT_DYNAMIC;
+	} else {
+		*status = PROPERTY_STATUS_DYNAMIC;
+	}
+	
+	return zdata;
+}
+
+static bool has_public_properties(HashTable *ht, zval *type) {
+	zend_string *key = NULL;
+	zend_ulong _unused_idx;
+	zval *zdata = NULL;
+	ZEND_ASSERT(ht);
+	ZEND_ASSERT(type);
+
+	ZEND_HASH_FOREACH_KEY_VAL(ht, _unused_idx, key, zdata) {
+		enum property_status status;
+		zdata = compute_is_undef_or_dynamic_property(zdata, &status);
+		if (status == PROPERTY_STATUS_UNDEF) {
+			continue;
+		}
+		bool is_dynamic = status == PROPERTY_STATUS_DYNAMIC;
+
+		if (zend_check_property_access(Z_OBJ_P(type), key, is_dynamic) == SUCCESS) {
+			/* property visible in this scope */
+			return true;
+		}
+	} ZEND_HASH_FOREACH_END();
+
+	return false;
+}
+
+static bool should_handle_object_as_stringable(zval *zdata, zval *tmp) {
+	/* If the data object is stringable and has no properties handle it like a string instead of recursively */
+	if (Z_TYPE_P(zdata) == IS_OBJECT &&
+		!has_public_properties(HASH_OF(zdata), zdata) &&
+		Z_OBJ_HT_P(zdata)->cast_object(Z_OBJ_P(zdata), tmp, IS_STRING) == SUCCESS) {
+			return true;
+	}
+	return false;
+}
+
 /* {{{ php_url_encode_hash */
 PHPAPI void php_url_encode_hash_ex(HashTable *ht, smart_str *formstr,
 				const char *num_prefix, size_t num_prefix_len,
@@ -124,21 +179,15 @@ PHPAPI void php_url_encode_hash_ex(HashTable *ht, smart_str *formstr,
 	arg_sep_len = strlen(arg_sep);
 
 	ZEND_HASH_FOREACH_KEY_VAL(ht, idx, key, zdata) {
-		bool is_dynamic = 1;
-		if (Z_TYPE_P(zdata) == IS_INDIRECT) {
-			zdata = Z_INDIRECT_P(zdata);
-			if (Z_ISUNDEF_P(zdata)) {
-				continue;
-			}
-
-			is_dynamic = 0;
+		enum property_status status;
+		zdata = compute_is_undef_or_dynamic_property(zdata, &status);
+		if (status == PROPERTY_STATUS_UNDEF) {
+			continue;
 		}
+		bool is_dynamic = status == PROPERTY_STATUS_DYNAMIC;
 
 		/* handling for private & protected object properties */
 		if (key) {
-			prop_name = ZSTR_VAL(key);
-			prop_len = ZSTR_LEN(key);
-
 			if (type != NULL && zend_check_property_access(Z_OBJ_P(type), key, is_dynamic) != SUCCESS) {
 				/* property not visible in this scope */
 				continue;
@@ -158,17 +207,16 @@ PHPAPI void php_url_encode_hash_ex(HashTable *ht, smart_str *formstr,
 
 		ZVAL_DEREF(zdata);
 		if (Z_TYPE_P(zdata) == IS_ARRAY || Z_TYPE_P(zdata) == IS_OBJECT) {
-			/* If the data object is stringable handle it like a string instead of recursively */
 			zval tmp;
-			if (Z_TYPE_P(zdata) == IS_OBJECT &&
-				Z_OBJ_HT_P(zdata)->cast_object(Z_OBJ_P(zdata), &tmp, IS_STRING) == SUCCESS) {
+			if (should_handle_object_as_stringable(zdata, &tmp)) {
 				php_url_encode_scalar(&tmp, formstr,
 					enc_type, idx,
 					prop_name, prop_len,
 					num_prefix, num_prefix_len,
 					key_prefix, key_prefix_len,
 					key_suffix, key_suffix_len,
 					arg_sep, arg_sep_len);
+				zval_ptr_dtor(&tmp);
 				continue;
 			}
 
@@ -269,7 +317,20 @@ PHP_FUNCTION(http_build_query)
 		Z_PARAM_LONG(enc_type)
 	ZEND_PARSE_PARAMETERS_END();
 
-	php_url_encode_hash_ex(HASH_OF(formdata), &formstr, prefix, prefix_len, NULL, 0, NULL, 0, (Z_TYPE_P(formdata) == IS_OBJECT ? formdata : NULL), arg_sep, (int)enc_type);
+	/* Special case when we get an object that's stringable as input */
+	zval tmp;
+	if (should_handle_object_as_stringable(formdata, &tmp)) {
+		php_url_encode_scalar(&tmp, &formstr,
+			enc_type, 0,
+			NULL, 0,
+			prefix, prefix_len,
+			NULL, 0,
+			NULL, 0,
+			arg_sep, arg_sep_len);
+		zval_ptr_dtor(&tmp);
+	} else {
+		php_url_encode_hash_ex(HASH_OF(formdata), &formstr, prefix, prefix_len, NULL, 0, NULL, 0, (Z_TYPE_P(formdata) == IS_OBJECT ? formdata : NULL), arg_sep, (int)enc_type);
+	}
 
 	if (!formstr.s) {
 		RETURN_EMPTY_STRING();

ext/standard/tests/http/http_build_query/bug26817.phpt

@@ -22,5 +22,5 @@ $obj->foo();
 var_dump(http_build_query($obj));
 ?>
 --EXPECT--
-string(27) "test=test&bar=meuh&foo=lala"
+string(27) "foo=lala&bar=meuh&test=test"
 string(9) "test=test"

ext/standard/tests/http/http_build_query/http_build_query_object_just_stringable.phpt

@@ -10,6 +10,19 @@ class StringableObject {
 
 $o = new StringableObject();
 
+var_dump(http_build_query(['hello', $o]));
+var_dump(http_build_query($o));
+var_dump(http_build_query(['hello', $o], numeric_prefix: 'prefix_'));
+var_dump(http_build_query($o, numeric_prefix: 'prefix_'));
+
+class StringableObjectWithNonInternedString {
+    public function __toString() : string {
+        return str_repeat("abcd", 3);
+    }
+}
+
+$o = new StringableObjectWithNonInternedString();
+
 var_dump(http_build_query(['hello', $o]));
 var_dump(http_build_query($o));
 var_dump(http_build_query(['hello', $o], numeric_prefix: 'prefix_'));
@@ -20,3 +33,7 @@ string(20) "0=hello&1=Stringable"
 string(12) "0=Stringable"
 string(34) "prefix_0=hello&prefix_1=Stringable"
 string(19) "prefix_0=Stringable"
+string(22) "0=hello&1=abcdabcdabcd"
+string(14) "0=abcdabcdabcd"
+string(36) "prefix_0=hello&prefix_1=abcdabcdabcd"
+string(21) "prefix_0=abcdabcdabcd"