Skip to content

Commit 633b651

Browse files
kocsismatekocsismate
committed
Try to address comments + add documentation
1 parent 9b88d13 commit 633b651

File tree

7 files changed

+240
-44
lines changed

7 files changed

+240
-44
lines changed

‎ext/standard/http_fopen_wrapper.c‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -753,33 +753,32 @@ static php_stream *php_stream_url_wrap_http_ex(php_stream_wrapper *wrapper,
753753

754754
/* auth header if it was specified */
755755
if (((have_header & HTTP_HEADER_AUTH) == 0) && resource->user) {
756-
/* make scratch large enough to hold the whole URL (over-estimate) */
757-
size_t scratch_len = strlen(path) + 1;
758-
char *scratch = emalloc(scratch_len);
756+
smart_str scratch = {0};
759757
zend_string *stmp;
760758

761759
/* decode the strings first */
762760
php_url_decode(ZSTR_VAL(resource->user), ZSTR_LEN(resource->user));
763761

764-
strcpy(scratch, ZSTR_VAL(resource->user));
765-
strcat(scratch, ":");
762+
smart_str_appendl(&scratch, ZSTR_VAL(resource->user), ZSTR_LEN(resource->user));
763+
smart_str_appendc(&scratch, ':');
766764

767765
/* Note: password is optional! */
768766
if (resource->password) {
769767
php_url_decode(ZSTR_VAL(resource->password), ZSTR_LEN(resource->password));
770-
strcat(scratch, ZSTR_VAL(resource->password));
768+
smart_str_appendl(&scratch, ZSTR_VAL(resource->password), ZSTR_LEN(resource->password));
771769
}
772770

773-
stmp = php_base64_encode((unsigned char*)scratch, strlen(scratch));
771+
zend_string *scratch_str = smart_str_extract(&scratch);
772+
stmp = php_base64_encode((unsigned char*)ZSTR_VAL(scratch_str), ZSTR_LEN(scratch_str));
774773

775774
smart_str_appends(&req_buf, "Authorization: Basic ");
776-
smart_str_appends(&req_buf, ZSTR_VAL(stmp));
775+
smart_str_appendl(&req_buf, ZSTR_VAL(stmp), ZSTR_LEN(stmp));
777776
smart_str_appends(&req_buf, "\r\n");
778777

779778
php_stream_notify_info(context, PHP_STREAM_NOTIFY_AUTH_REQUIRED, NULL, 0);
780779

781780
zend_string_free(stmp);
782-
efree(scratch);
781+
smart_str_free(&scratch);
783782
}
784783

785784
/* if the user has configured who they are, send a From: line */

‎ext/standard/url.c‎

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -321,12 +321,26 @@ PHPAPI php_url *php_url_parse_ex2(char const *str, size_t length, bool *has_port
321321
return ret;
322322
}
323323

324+
static void parse_url_decode_component(zval *zv, uri_component_read_mode_t read_mode)
325+
{
326+
if (Z_TYPE_P(zv) != IS_STRING) {
327+
return;
328+
}
329+
330+
if (read_mode != URI_COMPONENT_READ_NORMALIZED_ASCII && read_mode != URI_COMPONENT_READ_NORMALIZED_UNICODE) {
331+
return;
332+
}
333+
334+
php_url_decode(Z_STRVAL_P(zv), Z_STRLEN_P(zv));
335+
}
336+
324337
static zend_result parse_url_read_scheme(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *retval)
325338
{
326339
php_url *parse_url_uri = internal_uri->uri;
327340

328341
if (parse_url_uri->scheme) {
329342
ZVAL_STR_COPY(retval, parse_url_uri->scheme);
343+
parse_url_decode_component(retval, read_mode);
330344
} else {
331345
ZVAL_NULL(retval);
332346
}
@@ -340,6 +354,7 @@ static zend_result parse_url_read_username(const uri_internal_t *internal_uri, u
340354

341355
if (parse_url_uri->user) {
342356
ZVAL_STR_COPY(retval, parse_url_uri->user);
357+
parse_url_decode_component(retval, read_mode);
343358
} else {
344359
ZVAL_NULL(retval);
345360
}
@@ -353,6 +368,7 @@ static zend_result parse_url_read_password(const uri_internal_t *internal_uri, u
353368

354369
if (parse_url_uri->pass) {
355370
ZVAL_STR_COPY(retval, parse_url_uri->pass);
371+
parse_url_decode_component(retval, read_mode);
356372
} else {
357373
ZVAL_NULL(retval);
358374
}
@@ -366,6 +382,7 @@ static zend_result parse_url_read_host(const uri_internal_t *internal_uri, uri_c
366382

367383
if (parse_url_uri->host) {
368384
ZVAL_STR_COPY(retval, parse_url_uri->host);
385+
parse_url_decode_component(retval, read_mode);
369386
} else {
370387
ZVAL_NULL(retval);
371388
}
@@ -379,6 +396,7 @@ static zend_result parse_url_read_port(const uri_internal_t *internal_uri, uri_c
379396

380397
if (parse_url_uri->port) {
381398
ZVAL_LONG(retval, parse_url_uri->port);
399+
parse_url_decode_component(retval, read_mode);
382400
} else {
383401
ZVAL_NULL(retval);
384402
}
@@ -392,6 +410,7 @@ static zend_result parse_url_read_path(const uri_internal_t *internal_uri, uri_c
392410

393411
if (parse_url_uri->path) {
394412
ZVAL_STR_COPY(retval, parse_url_uri->path);
413+
parse_url_decode_component(retval, read_mode);
395414
} else {
396415
ZVAL_NULL(retval);
397416
}
@@ -405,6 +424,7 @@ static zend_result parse_url_read_query(const uri_internal_t *internal_uri, uri_
405424

406425
if (parse_url_uri->query) {
407426
ZVAL_STR_COPY(retval, parse_url_uri->query);
427+
parse_url_decode_component(retval, read_mode);
408428
} else {
409429
ZVAL_NULL(retval);
410430
}
@@ -418,18 +438,14 @@ static zend_result parse_url_read_fragment(const uri_internal_t *internal_uri, u
418438

419439
if (parse_url_uri->fragment) {
420440
ZVAL_STR_COPY(retval, parse_url_uri->fragment);
441+
parse_url_decode_component(retval, read_mode);
421442
} else {
422443
ZVAL_NULL(retval);
423444
}
424445

425446
return SUCCESS;
426447
}
427448

428-
static void *parse_url_clone_uri(void *uri)
429-
{
430-
ZEND_UNREACHABLE();
431-
}
432-
433449
static void throw_invalid_uri_exception(void)
434450
{
435451
zend_throw_exception(uri_invalid_uri_exception_ce, "The specified URI is malformed", 0);
@@ -447,16 +463,11 @@ static void *parse_url_parse_uri(const char *uri_str, size_t uri_str_len, const
447463
return url;
448464
}
449465

450-
static zend_string *parse_url_uri_to_string(void *uri, uri_recomposition_mode_t recomposition_mode, bool exclude_fragment)
451-
{
452-
ZEND_UNREACHABLE();
453-
}
454-
455466
const uri_handler_t parse_url_uri_handler = {
456467
.name = URI_PARSER_PHP,
457468
.parse_uri = parse_url_parse_uri,
458-
.clone_uri = parse_url_clone_uri,
459-
.uri_to_string = parse_url_uri_to_string,
469+
.clone_uri = NULL,
470+
.uri_to_string = NULL,
460471
.free_uri = parse_url_free_uri,
461472
{
462473
.scheme = {.read_func = parse_url_read_scheme, .write_func = NULL},

‎ext/uri/php_uri.c‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,11 @@ ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_get_property(const uri_interna
136136
return FAILURE;
137137
}
138138

139-
return property_handler->read_func(internal_uri, read_mode, zv);
139+
zend_result result = property_handler->read_func(internal_uri, read_mode, zv);
140+
141+
ZEND_ASSERT(result == FAILURE || (Z_TYPE_P(zv) == IS_STRING && GC_REFCOUNT(Z_STR_P(zv)) == 2) || Z_TYPE_P(zv) == IS_NULL || Z_TYPE_P(zv) == IS_LONG);
142+
143+
return result;
140144
}
141145

142146
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_scheme(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv)
@@ -1011,14 +1015,14 @@ ZEND_ATTRIBUTE_NONNULL PHPAPI void php_uri_implementation_set_object_handlers(ze
10111015
object_handlers->clone_obj = uri_clone_obj_handler;
10121016
}
10131017

1014-
zend_result uri_handler_register(const uri_handler_t *uri_handler)
1018+
PHPAPI zend_result uri_handler_register(const uri_handler_t *uri_handler)
10151019
{
1016-
zend_string *key = zend_string_init_interned(uri_handler->name, strlen(uri_handler->name), 1);
1020+
zend_string *key = zend_string_init_interned(uri_handler->name, strlen(uri_handler->name), true);
10171021

1018-
ZEND_ASSERT(uri_handler->name != NULL);
1022+
ZEND_ASSERT(uri_handler->name != NULL && (strlen(uri_handler->name) > 0 || strcmp(uri_handler->name, URI_PARSER_PHP) == 0));
10191023
ZEND_ASSERT(uri_handler->parse_uri != NULL);
1020-
ZEND_ASSERT(uri_handler->clone_uri != NULL);
1021-
ZEND_ASSERT(uri_handler->uri_to_string != NULL);
1024+
ZEND_ASSERT(uri_handler->clone_uri != NULL || strcmp(uri_handler->name, URI_PARSER_PHP) == 0);
1025+
ZEND_ASSERT(uri_handler->uri_to_string != NULL || strcmp(uri_handler->name, URI_PARSER_PHP) == 0);
10221026
ZEND_ASSERT(uri_handler->free_uri != NULL);
10231027

10241028
zend_result result = zend_hash_add_ptr(&uri_handlers, key, (void *) uri_handler) != NULL ? SUCCESS : FAILURE;
@@ -1045,7 +1049,7 @@ static PHP_MINIT_FUNCTION(uri)
10451049

10461050
zend_hash_init(&uri_handlers, 4, NULL, NULL, true);
10471051

1048-
if (PHP_MINIT(uri_uriparser)(INIT_FUNC_ARGS_PASSTHRU) == FAILURE) {
1052+
if (uri_handler_register(&uriparser_uri_handler) == FAILURE) {
10491053
return FAILURE;
10501054
}
10511055

‎ext/uri/php_uri.h‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,26 +33,182 @@ typedef struct php_uri {
3333
zend_string *fragment;
3434
} php_uri;
3535

36+
/**
37+
* Registers a URI handler. The handler must have a unique name.
38+
*
39+
* @param uri_handler The URI handler
40+
* @return SUCCESS in case of success, FAILURE otherwise
41+
*/
42+
PHPAPI zend_result uri_handler_register(const uri_handler_t *uri_handler);
43+
44+
/**
45+
* Returns the registered URI handler based on uri_handler_name.
46+
*
47+
* @param uri_handler_name The URI handler name
48+
* @return The URI handler
49+
*/
3650
PHPAPI uri_handler_t *php_uri_get_handler(const zend_string *uri_handler_name);
51+
3752
ZEND_ATTRIBUTE_NONNULL PHPAPI uri_internal_t *php_uri_parse(const uri_handler_t *uri_handler, const char *uri_str, size_t uri_str_len, bool silent);
53+
54+
/**
55+
* Retrieves the scheme component based on the read_mode and passes it to the zv ZVAL in case of success.
56+
*
57+
* Read_mode can be one of the following:
58+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
59+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
60+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
61+
*
62+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
63+
* @param read_mode The read mode
64+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
65+
* @return SUCCESS in case of success, FAILURE otherwise.
66+
*/
3867
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_scheme(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
68+
69+
/**
70+
* Retrieves the username component based on the read_mode and passes it to the zv ZVAL in case of success.
71+
*
72+
* Read_mode can be one of the following:
73+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
74+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
75+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
76+
*
77+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
78+
* @param read_mode The read mode
79+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
80+
* @return SUCCESS in case of success, FAILURE otherwise.
81+
*/
3982
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_username(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
83+
84+
/**
85+
* Retrieves the password component based on the read_mode and passes it to the zv ZVAL in case of success.
86+
*
87+
* Read_mode can be one of the following:
88+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
89+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
90+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
91+
*
92+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
93+
* @param read_mode The read mode
94+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
95+
* @return SUCCESS in case of success, FAILURE otherwise.
96+
*/
4097
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_password(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
98+
99+
/**
100+
* Retrieves the host component based on the read_mode and passes it to the zv ZVAL in case of success.
101+
*
102+
* Read_mode can be one of the following:
103+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
104+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
105+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
106+
*
107+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
108+
* @param read_mode The read mode
109+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
110+
* @return SUCCESS in case of success, FAILURE otherwise.
111+
*/
41112
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_host(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
113+
114+
/**
115+
* Retrieves the port component based on the read_mode and passes it to the zv ZVAL in case of success.
116+
*
117+
* Read_mode can be one of the following:
118+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
119+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
120+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
121+
*
122+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
123+
* @param read_mode The read mode
124+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_LONG or IS_NULL).
125+
* @return SUCCESS in case of success, FAILURE otherwise.
126+
*/
42127
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_port(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
128+
129+
/**
130+
* Retrieves the path component based on the read_mode and passes it to the zv ZVAL in case of success.
131+
*
132+
* Read_mode can be one of the following:
133+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
134+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
135+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
136+
*
137+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
138+
* @param read_mode The read mode
139+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
140+
* @return SUCCESS in case of success, FAILURE otherwise.
141+
*/
43142
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_path(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
143+
144+
/**
145+
* Retrieves the query component based on the read_mode and passes it to the zv ZVAL in case of success.
146+
*
147+
* Read_mode can be one of the following:
148+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
149+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
150+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
151+
*
152+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
153+
* @param read_mode The read mode
154+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
155+
* @return SUCCESS in case of success, FAILURE otherwise.
156+
*/
44157
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_query(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
158+
159+
/**
160+
* Retrieves the fragment component based on the read_mode and passes it to the zv ZVAL in case of success.
161+
*
162+
* Read_mode can be one of the following:
163+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
164+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
165+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
166+
*
167+
* @param internal_uri The internal URI whose uri member is used to retrieve the component
168+
* @param read_mode The read mode
169+
* @param zv The output parameter containing the retrieved component as a ZVAL (either IS_STRING or IS_NULL).
170+
* @return SUCCESS in case of success, FAILURE otherwise.
171+
*/
45172
ZEND_ATTRIBUTE_NONNULL PHPAPI zend_result php_uri_get_fragment(const uri_internal_t *internal_uri, uri_component_read_mode_t read_mode, zval *zv);
173+
174+
/**
175+
* Frees the uri member within the provided internal URI.
176+
*
177+
* @param internal_uri The internal URI
178+
*/
46179
ZEND_ATTRIBUTE_NONNULL PHPAPI void php_uri_free(uri_internal_t *internal_uri);
180+
181+
/**
182+
* Creates a new php_uri struct containing all the URI components. The components are retrieved based on the read_mode parameter.
183+
*
184+
* Read_mode can be one of the following:
185+
* - URI_COMPONENT_READ_RAW: Retrieves the raw, non-normalized variant of the URI component
186+
* - URI_COMPONENT_READ_NORMALIZED_ASCII: Retrieves the normalized variant of the requested URI component that must only contain ASCII characters
187+
* - URI_COMPONENT_READ_NORMALIZED_UNICODE: Retrieves the normalized variant of the requested URI component that may contain Unicode codepoints
188+
*
189+
* @param uri_handler The URI handler whose parse_uri() handler is called
190+
* @param uri_str The input string that is going to be parsed
191+
* @param uri_str_len Length of the input string
192+
* @param read_mode The read mode based on which components are retrieved
193+
* @param silent Whether to throw a Uri\InvalidUriException in case of failure
194+
* @return The created php_uri struct in case of success, NULL otherwise
195+
*/
47196
ZEND_ATTRIBUTE_NONNULL PHPAPI php_uri *php_uri_parse_to_struct(
48197
const uri_handler_t *uri_handler, const char *uri_str, size_t uri_str_len, uri_component_read_mode_t read_mode, bool silent
49198
);
199+
200+
/**
201+
* Frees the provided php_uri struct.
202+
*
203+
* @param uri The php_uri struct to free
204+
*/
50205
ZEND_ATTRIBUTE_NONNULL PHPAPI void php_uri_struct_free(php_uri *uri);
51206

52207
ZEND_ATTRIBUTE_NONNULL_ARGS(1, 2) PHPAPI void php_uri_instantiate_uri(
53208
INTERNAL_FUNCTION_PARAMETERS, const uri_handler_t *handler, const zend_string *uri_str, const zend_object *base_url_object,
54209
bool should_throw, bool should_update_this_object, zval *errors_zv
55210
);
211+
56212
ZEND_ATTRIBUTE_NONNULL PHPAPI void php_uri_implementation_set_object_handlers(zend_class_entry *ce, zend_object_handlers *object_handlers);
57213

58214
#endif

0 commit comments

Comments
 (0)