Skip to content

Implement "Followup improvements for ext/uri" RFC - RFC 3986 URI building #22173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kocsismate wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Implement "Followup improvements for ext/uri" RFC - RFC 3986 URI building #22173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f99c5ee
Implement "Followup improvements for ext/uri" RFC - RFC 3986 URI buil…
kocsismate May 28, 2026
ae4c905
Review fixes + optimize property reads + fix leak
kocsismate May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 205 additions & 0 deletions ext/uri/php_uri.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
#include "php_uri_arginfo.h"
#include "uriparser/Uri.h"

zend_class_entry *php_uri_ce_rfc3986_uri_builder;
zend_class_entry *php_uri_ce_rfc3986_uri;
zend_class_entry *php_uri_ce_rfc3986_uri_type;
zend_class_entry *php_uri_ce_rfc3986_uri_host_type;
Expand All @@ -46,13 +47,24 @@ zend_class_entry *php_uri_ce_whatwg_url_validation_error;
static zend_object_handlers object_handlers_rfc3986_uri;
static zend_object_handlers object_handlers_whatwg_uri;

typedef bool (*php_uri_component_validator_string)(const zend_string *component);
typedef bool (*php_uri_component_validator_long)(zend_long component);

static const zend_module_dep uri_deps[] = {
ZEND_MOD_REQUIRED("lexbor")
ZEND_MOD_END
};

static zend_array uri_parsers;

#define Z_RFC3986_URI_PROP_SCHEME_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 0)
#define Z_RFC3986_URI_PROP_USERINFO_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 1)
#define Z_RFC3986_URI_PROP_HOST_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 2)
#define Z_RFC3986_URI_PROP_PORT_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 3)
#define Z_RFC3986_URI_PROP_PATH_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 4)
#define Z_RFC3986_URI_PROP_QUERY_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 5)
#define Z_RFC3986_URI_PROP_FRAGMENT_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 6)

static HashTable *uri_get_debug_properties(php_uri_object *object)
{
const HashTable *std_properties = zend_std_get_properties(&object->std);
Expand Down Expand Up @@ -1044,6 +1056,197 @@ PHP_METHOD(Uri_WhatWg_Url, __debugInfo)
RETURN_ARR(uri_get_debug_properties(uri_object));
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, __construct)
{
ZEND_PARSE_PARAMETERS_NONE();
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, reset)
{
ZEND_PARSE_PARAMETERS_NONE();

ZVAL_NULL(Z_RFC3986_URI_PROP_SCHEME_P(ZEND_THIS));
ZVAL_NULL(Z_RFC3986_URI_PROP_USERINFO_P(ZEND_THIS));
ZVAL_NULL(Z_RFC3986_URI_PROP_HOST_P(ZEND_THIS));
ZVAL_NULL(Z_RFC3986_URI_PROP_PORT_P(ZEND_THIS));
ZVAL_EMPTY_STRING(Z_RFC3986_URI_PROP_PATH_P(ZEND_THIS));
ZVAL_NULL(Z_RFC3986_URI_PROP_QUERY_P(ZEND_THIS));
ZVAL_NULL(Z_RFC3986_URI_PROP_FRAGMENT_P(ZEND_THIS));

RETVAL_COPY(ZEND_THIS);
}

ZEND_ATTRIBUTE_NONNULL static void php_uri_builder_set_component_string(
INTERNAL_FUNCTION_PARAMETERS, const char *name, size_t name_length,
const php_uri_component_validator_string validator
) {
zend_string *component;

ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_STR(component)
ZEND_PARSE_PARAMETERS_END();

if (!validator(component)) {
zend_throw_exception_ex(php_uri_ce_invalid_uri_exception, 0, "The specified %s is malformed", name);
RETURN_THROWS();
}

zend_update_property_str(Z_OBJCE_P(ZEND_THIS), Z_OBJ_P(ZEND_THIS), name, name_length, component);

RETVAL_COPY(ZEND_THIS);
}

ZEND_ATTRIBUTE_NONNULL static void php_uri_builder_set_component_string_or_null(
INTERNAL_FUNCTION_PARAMETERS, const char *name, size_t name_length,
const php_uri_component_validator_string validator
) {
zend_string *component;

ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_STR_OR_NULL(component)
ZEND_PARSE_PARAMETERS_END();

if (component == NULL) {
zend_update_property_null(Z_OBJCE_P(ZEND_THIS), Z_OBJ_P(ZEND_THIS), name, name_length);
} else {
if (!validator(component)) {
zend_throw_exception_ex(php_uri_ce_invalid_uri_exception, 0, "The specified %s is malformed", name);
RETURN_THROWS();
}

zend_update_property_str(Z_OBJCE_P(ZEND_THIS), Z_OBJ_P(ZEND_THIS), name, name_length, component);
}

RETVAL_COPY(ZEND_THIS);
}

ZEND_ATTRIBUTE_NONNULL_ARGS(1) static void php_uri_builder_set_component_long_or_null(
INTERNAL_FUNCTION_PARAMETERS, const char *name, size_t name_length,
const php_uri_component_validator_long validator
) {
zend_long component;
bool component_is_null;

ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_LONG_OR_NULL(component, component_is_null)
ZEND_PARSE_PARAMETERS_END();

if (component_is_null) {
zend_update_property_null(Z_OBJCE_P(ZEND_THIS), Z_OBJ_P(ZEND_THIS), name, name_length);
} else {
if (!validator(component)) {
zend_throw_exception_ex(php_uri_ce_invalid_uri_exception, 0, "The specified %s is malformed", name);
RETURN_THROWS();
}

zend_update_property_long(Z_OBJCE_P(ZEND_THIS), Z_OBJ_P(ZEND_THIS), name, name_length, component);
}

RETVAL_COPY(ZEND_THIS);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setScheme)
{
php_uri_builder_set_component_string_or_null(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("scheme"),
php_uri_parser_rfc3986_validate_scheme
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setUserInfo)
{
php_uri_builder_set_component_string_or_null(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("userinfo"),
php_uri_parser_rfc3986_validate_userinfo
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setHost)
{
php_uri_builder_set_component_string_or_null(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("host"),
php_uri_parser_rfc3986_validate_host
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setPort)
{
php_uri_builder_set_component_long_or_null(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("port"),
php_uri_parser_rfc3986_validate_port
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setPath)
{
php_uri_builder_set_component_string(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("path"),
php_uri_parser_rfc3986_validate_path
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setQuery)
{
php_uri_builder_set_component_string_or_null(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("query"),
php_uri_parser_rfc3986_validate_query
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, setFragment)
{
php_uri_builder_set_component_string_or_null(
INTERNAL_FUNCTION_PARAM_PASSTHRU,
ZEND_STRL("fragment"),
php_uri_parser_rfc3986_validate_fragment
);
}

PHP_METHOD(Uri_Rfc3986_UriBuilder, build)
{
zval *base_url = NULL;

ZEND_PARSE_PARAMETERS_START(0, 1)
Z_PARAM_OPTIONAL
Z_PARAM_OBJECT_OF_CLASS_OR_NULL(base_url, php_uri_ce_rfc3986_uri)
ZEND_PARSE_PARAMETERS_END();

const zval *scheme = Z_RFC3986_URI_PROP_SCHEME_P(ZEND_THIS);
const zval *userinfo = Z_RFC3986_URI_PROP_USERINFO_P(ZEND_THIS);
const zval *host = Z_RFC3986_URI_PROP_HOST_P(ZEND_THIS);
const zval *port = Z_RFC3986_URI_PROP_PORT_P(ZEND_THIS);
const zval *path = Z_RFC3986_URI_PROP_PATH_P(ZEND_THIS);
const zval *query = Z_RFC3986_URI_PROP_QUERY_P(ZEND_THIS);
const zval *fragment = Z_RFC3986_URI_PROP_FRAGMENT_P(ZEND_THIS);

zend_string *uri_str = php_uri_parser_rfc3986_recompose_from_zval(scheme, userinfo, host, port, path, query, fragment);
if (uri_str == NULL) {
RETURN_THROWS();
}

php_uri_parser_rfc3986_uris *base_uri = NULL;
if (base_url != NULL) {
base_uri = Z_URI_OBJECT_P(base_url)->uri;
}

php_uri_parser_rfc3986_uris *uri = php_uri_parser_rfc3986_parse_ex(ZSTR_VAL(uri_str), ZSTR_LEN(uri_str), base_uri, false);
zend_string_release(uri_str);
if (uri == NULL) {
RETURN_THROWS();
}

object_init_ex(return_value, php_uri_ce_rfc3986_uri);
php_uri_object *uri_object = Z_URI_OBJECT_P(return_value);
uri_object->parser = &php_uri_parser_rfc3986;
uri_object->uri = uri;
}

PHPAPI php_uri_object *php_uri_object_create(zend_class_entry *class_type, const php_uri_parser *parser)
{
php_uri_object *uri_object = zend_object_alloc(sizeof(*uri_object), class_type);
Expand Down Expand Up @@ -1113,6 +1316,8 @@ PHPAPI zend_result php_uri_parser_register(const php_uri_parser *uri_parser)

static PHP_MINIT_FUNCTION(uri)
{
php_uri_ce_rfc3986_uri_builder = register_class_Uri_Rfc3986_UriBuilder();

php_uri_ce_rfc3986_uri = register_class_Uri_Rfc3986_Uri();
php_uri_ce_rfc3986_uri->create_object = php_uri_object_create_rfc3986;
php_uri_ce_rfc3986_uri->default_object_handlers = &object_handlers_rfc3986_uri;
Expand Down
31 changes: 31 additions & 0 deletions ext/uri/php_uri.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,37 @@ enum UriHostType
case RegisteredName;
}

final class UriBuilder
{
private ?string $scheme = null;
private ?string $userinfo = null;
private ?string $host = null;
private ?int $port = null;
private string $path = "";
private ?string $query = null;
private ?string $fragment = null;

public function __construct() {}

public function reset(): static {}

public function setScheme(?string $scheme): static {}

public function setUserInfo(#[\SensitiveParameter] ?string $userInfo): static {}

public function setHost(?string $host): static {}

public function setPort(?int $port): static {}

public function setPath(string $path): static {}

public function setQuery(?string $query): static {}

public function setFragment(?string $fragment): static {}

public function build(?\Uri\Rfc3986\Uri $baseUrl = null): \Uri\Rfc3986\Uri {}
}

/** @strict-properties */
final readonly class Uri
{
Expand Down
Loading
Loading