2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2011, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
13 #include "php_http_api.h"
15 static inline char *localhostname(void)
17 char hostname
[1024] = {0};
20 if (SUCCESS
== gethostname(hostname
, lenof(hostname
))) {
21 return estrdup(hostname
);
23 #elif defined(HAVE_GETHOSTNAME)
24 if (SUCCESS
== gethostname(hostname
, lenof(hostname
))) {
25 # if defined(HAVE_GETDOMAINNAME)
26 size_t hlen
= strlen(hostname
);
27 if (hlen
<= lenof(hostname
) - lenof("(none)")) {
28 hostname
[hlen
++] = '.';
29 if (SUCCESS
== getdomainname(&hostname
[hlen
], lenof(hostname
) - hlen
)) {
30 if (!strcmp(&hostname
[hlen
], "(none)")) {
31 hostname
[hlen
- 1] = '\0';
33 return estrdup(hostname
);
37 if (strcmp(hostname
, "(none)")) {
38 return estrdup(hostname
);
42 return estrndup("localhost", lenof("localhost"));
45 static php_url
*php_http_url_from_env(php_url
*url TSRMLS_DC
)
47 zval
*https
, *zhost
, *zport
;
49 #ifdef HAVE_GETSERVBYPORT
54 url
= ecalloc(1, sizeof(*url
));
58 zport
= php_http_env_get_server_var(ZEND_STRL("SERVER_PORT"), 1 TSRMLS_CC
);
59 if (zport
&& IS_LONG
== is_numeric_string(Z_STRVAL_P(zport
), Z_STRLEN_P(zport
), &port
, NULL
, 0)) {
64 https
= php_http_env_get_server_var(ZEND_STRL("HTTPS"), 1 TSRMLS_CC
);
65 if (https
&& !strcasecmp(Z_STRVAL_P(https
), "ON")) {
66 url
->scheme
= estrndup("https", lenof("https"));
67 } else switch (url
->port
) {
69 url
->scheme
= estrndup("https", lenof("https"));
72 #ifndef HAVE_GETSERVBYPORT
77 url
->scheme
= estrndup("http", lenof("http"));
80 #ifdef HAVE_GETSERVBYPORT
82 if ((se
= getservbyport(htons(url
->port
), "tcp")) && se
->s_name
) {
83 url
->scheme
= estrdup(se
->s_name
);
85 url
->scheme
= estrndup("http", lenof("http"));
92 if ((((zhost
= php_http_env_get_server_var(ZEND_STRL("HTTP_HOST"), 1 TSRMLS_CC
)) ||
93 (zhost
= php_http_env_get_server_var(ZEND_STRL("SERVER_NAME"), 1 TSRMLS_CC
)) ||
94 (zhost
= php_http_env_get_server_var(ZEND_STRL("SERVER_ADDR"), 1 TSRMLS_CC
)))) && Z_STRLEN_P(zhost
)) {
95 url
->host
= estrndup(Z_STRVAL_P(zhost
), Z_STRLEN_P(zhost
));
97 url
->host
= localhostname();
101 if (SG(request_info
).request_uri
&& SG(request_info
).request_uri
[0]) {
102 const char *q
= strchr(SG(request_info
).request_uri
, '?');
105 url
->path
= estrndup(SG(request_info
).request_uri
, q
- SG(request_info
).request_uri
);
107 url
->path
= estrdup(SG(request_info
).request_uri
);
112 if (SG(request_info
).query_string
&& SG(request_info
).query_string
[0]) {
113 url
->query
= estrdup(SG(request_info
).query_string
);
119 PHP_HTTP_API
void php_http_url(int flags
, const php_url
*old_url
, const php_url
*new_url
, php_url
**url_ptr
, char **url_str
, size_t *url_len TSRMLS_DC
)
121 php_url
*url
, *tmp_url
= NULL
;
122 #ifdef HAVE_GETSERVBYNAME
126 /* set from env if requested */
127 if (flags
& PHP_HTTP_URL_FROM_ENV
) {
128 php_url
*env_url
= php_http_url_from_env(NULL TSRMLS_CC
);
130 php_http_url(flags
^ PHP_HTTP_URL_FROM_ENV
, env_url
, old_url
, &tmp_url
, NULL
, NULL TSRMLS_CC
);
132 php_url_free(env_url
);
136 url
= ecalloc(1, sizeof(*url
));
138 #define __URLSET(u,n) \
140 #define __URLCPY(n) \
141 url->n = __URLSET(new_url,n) ? estrdup(new_url->n) : (__URLSET(old_url,n) ? estrdup(old_url->n) : NULL)
143 if (!(flags
& PHP_HTTP_URL_STRIP_PORT
)) {
144 url
->port
= __URLSET(new_url
, port
) ? new_url
->port
: ((old_url
) ? old_url
->port
: 0);
146 if (!(flags
& PHP_HTTP_URL_STRIP_USER
)) {
149 if (!(flags
& PHP_HTTP_URL_STRIP_PASS
)) {
156 if (!(flags
& PHP_HTTP_URL_STRIP_PATH
)) {
157 if ((flags
& PHP_HTTP_URL_JOIN_PATH
) && __URLSET(old_url
, path
) && __URLSET(new_url
, path
) && *new_url
->path
!= '/') {
158 size_t old_path_len
= strlen(old_url
->path
), new_path_len
= strlen(new_url
->path
);
160 url
->path
= ecalloc(1, old_path_len
+ new_path_len
+ 1 + 1);
162 strcat(url
->path
, old_url
->path
);
163 if (url
->path
[old_path_len
- 1] != '/') {
164 php_dirname(url
->path
, old_path_len
);
165 strcat(url
->path
, "/");
167 strcat(url
->path
, new_url
->path
);
172 if (!(flags
& PHP_HTTP_URL_STRIP_QUERY
)) {
173 if ((flags
& PHP_HTTP_URL_JOIN_QUERY
) && __URLSET(new_url
, query
) && __URLSET(old_url
, query
)) {
180 ZVAL_STRING(&qstr
, old_url
->query
, 0);
181 php_http_querystring_update(&qarr
, &qstr
, NULL TSRMLS_CC
);
182 ZVAL_STRING(&qstr
, new_url
->query
, 0);
183 php_http_querystring_update(&qarr
, &qstr
, NULL TSRMLS_CC
);
186 php_http_querystring_update(&qarr
, NULL
, &qstr TSRMLS_CC
);
187 url
->query
= Z_STRVAL(qstr
);
193 if (!(flags
& PHP_HTTP_URL_STRIP_FRAGMENT
)) {
197 /* done with copy & combine & strip */
199 if (flags
& PHP_HTTP_URL_FROM_ENV
) {
200 /* free old_url we tainted above */
201 php_url_free(tmp_url
);
204 /* set some sane defaults */
207 url
->scheme
= estrndup("http", lenof("http"));
211 url
->host
= estrndup("localhost", lenof("localhost"));
215 url
->path
= estrndup("/", 1);
216 } else if (url
->path
[0] != '/') {
217 size_t plen
= strlen(url
->path
);
218 char *path
= emalloc(plen
+ 1 + 1);
221 memcpy(&path
[1], url
->path
, plen
+ 1);
222 STR_SET(url
->path
, path
);
224 /* replace directory references if path is not a single slash */
225 if (url
->path
[0] && (url
->path
[0] != '/' || url
->path
[1])) {
226 char *ptr
, *end
= url
->path
+ strlen(url
->path
) + 1;
228 for (ptr
= strchr(url
->path
, '/'); ptr
; ptr
= strchr(ptr
, '/')) {
231 memmove(&ptr
[1], &ptr
[2], end
- &ptr
[2]);
241 memmove(&ptr
[1], &ptr
[3], end
- &ptr
[3]);
247 while (ptr
!= url
->path
) {
252 memmove(&ptr
[1], pos
, end
- pos
);
254 } else if (!ptr
[3]) {
273 /* unset default ports */
275 if ( ((url
->port
== 80) && !strcmp(url
->scheme
, "http"))
276 || ((url
->port
==443) && !strcmp(url
->scheme
, "https"))
277 #ifdef HAVE_GETSERVBYNAME
278 || ((se
= getservbyname(url
->scheme
, "tcp")) && se
->s_port
&&
279 (url
->port
== ntohs(se
->s_port
)))
289 *url_str
= emalloc(PHP_HTTP_URL_MAXLEN
+ 1);
292 strlcat(*url_str
, url
->scheme
, PHP_HTTP_URL_MAXLEN
);
293 strlcat(*url_str
, "://", PHP_HTTP_URL_MAXLEN
);
295 if (url
->user
&& *url
->user
) {
296 strlcat(*url_str
, url
->user
, PHP_HTTP_URL_MAXLEN
);
297 if (url
->pass
&& *url
->pass
) {
298 strlcat(*url_str
, ":", PHP_HTTP_URL_MAXLEN
);
299 strlcat(*url_str
, url
->pass
, PHP_HTTP_URL_MAXLEN
);
301 strlcat(*url_str
, "@", PHP_HTTP_URL_MAXLEN
);
304 strlcat(*url_str
, url
->host
, PHP_HTTP_URL_MAXLEN
);
309 snprintf(port_str
, sizeof(port_str
), "%d", (int) url
->port
);
310 strlcat(*url_str
, ":", PHP_HTTP_URL_MAXLEN
);
311 strlcat(*url_str
, port_str
, PHP_HTTP_URL_MAXLEN
);
314 strlcat(*url_str
, url
->path
, PHP_HTTP_URL_MAXLEN
);
316 if (url
->query
&& *url
->query
) {
317 strlcat(*url_str
, "?", PHP_HTTP_URL_MAXLEN
);
318 strlcat(*url_str
, url
->query
, PHP_HTTP_URL_MAXLEN
);
321 if (url
->fragment
&& *url
->fragment
) {
322 strlcat(*url_str
, "#", PHP_HTTP_URL_MAXLEN
);
323 strlcat(*url_str
, url
->fragment
, PHP_HTTP_URL_MAXLEN
);
326 if (PHP_HTTP_URL_MAXLEN
== (len
= strlen(*url_str
))) {
327 php_http_error(HE_NOTICE
, PHP_HTTP_E_URL
, "Length of URL exceeds PHP_HTTP_URL_MAXLEN");
341 PHP_HTTP_API STATUS
php_http_url_encode_hash(HashTable
*hash
, const char *pre_encoded_str
, size_t pre_encoded_len
, char **encoded_str
, size_t *encoded_len TSRMLS_DC
)
343 const char *arg_sep_str
;
345 php_http_buffer_t
*qstr
= php_http_buffer_new();
347 php_http_url_argsep(&arg_sep_str
, &arg_sep_len TSRMLS_CC
);
349 if (pre_encoded_len
&& pre_encoded_str
) {
350 php_http_buffer_append(qstr
, pre_encoded_str
, pre_encoded_len
);
353 if (SUCCESS
!= php_http_url_encode_hash_ex(hash
, qstr
, arg_sep_str
, arg_sep_len
, ZEND_STRL("="), NULL
, 0 TSRMLS_CC
)) {
354 php_http_buffer_free(&qstr
);
358 php_http_buffer_data(qstr
, encoded_str
, encoded_len
);
359 php_http_buffer_free(&qstr
);
364 PHP_HTTP_API STATUS
php_http_url_encode_hash_ex(HashTable
*ht
, php_http_buffer_t
*str
, const char *arg_sep_str
, size_t arg_sep_len
, const char *val_sep_str
, size_t val_sep_len
, const char *prefix_str
, size_t prefix_len TSRMLS_DC
)
366 php_http_array_hashkey_t key
= php_http_array_hashkey_init(0);
371 php_http_error(HE_WARNING
, PHP_HTTP_E_INVALID_PARAM
, "Invalid parameters");
374 if (ht
->nApplyCount
> 0) {
378 FOREACH_HASH_KEYVAL(pos
, ht
, key
, data
) {
381 php_http_buffer_t new_prefix
;
383 if (!data
|| !*data
) {
384 php_http_buffer_dtor(str
);
388 if (key
.type
== HASH_KEY_IS_STRING
) {
390 /* only public properties */
393 if (key
.len
&& key
.str
[key
.len
- 1] == '\0') {
396 encoded_key
= php_url_encode(key
.str
, key
.len
, &encoded_len
);
398 encoded_len
= spprintf(&encoded_key
, 0, "%ld", key
.num
);
402 php_http_buffer_init(&new_prefix
);
403 if (prefix_str
&& prefix_len
) {
404 php_http_buffer_append(&new_prefix
, prefix_str
, prefix_len
);
405 php_http_buffer_appends(&new_prefix
, "%5B");
408 php_http_buffer_append(&new_prefix
, encoded_key
, encoded_len
);
411 if (prefix_str
&& prefix_len
) {
412 php_http_buffer_appends(&new_prefix
, "%5D");
414 php_http_buffer_fix(&new_prefix
);
417 if (Z_TYPE_PP(data
) == IS_ARRAY
|| Z_TYPE_PP(data
) == IS_OBJECT
) {
420 status
= php_http_url_encode_hash_ex(HASH_OF(*data
), str
, arg_sep_str
, arg_sep_len
, val_sep_str
, val_sep_len
, PHP_HTTP_BUFFER_VAL(&new_prefix
), PHP_HTTP_BUFFER_LEN(&new_prefix
) TSRMLS_CC
);
422 if (SUCCESS
!= status
) {
423 php_http_buffer_dtor(&new_prefix
);
424 php_http_buffer_dtor(str
);
428 zval
*val
= php_http_ztyp(IS_STRING
, *data
);
430 if (PHP_HTTP_BUFFER_LEN(str
)) {
431 php_http_buffer_append(str
, arg_sep_str
, arg_sep_len
);
433 php_http_buffer_append(str
, PHP_HTTP_BUFFER_VAL(&new_prefix
), PHP_HTTP_BUFFER_LEN(&new_prefix
));
434 php_http_buffer_append(str
, val_sep_str
, val_sep_len
);
436 if (Z_STRLEN_P(val
) && Z_STRVAL_P(val
)) {
440 encoded_val
= php_url_encode(Z_STRVAL_P(val
), Z_STRLEN_P(val
), &encoded_len
);
441 php_http_buffer_append(str
, encoded_val
, encoded_len
);
447 php_http_buffer_dtor(&new_prefix
);
452 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpUrl, method, 0, req_args)
453 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpUrl, method, 0)
454 #define PHP_HTTP_URL_ME(method, visibility) PHP_ME(HttpUrl, method, PHP_HTTP_ARGS(HttpUrl, method), visibility)
456 PHP_HTTP_BEGIN_ARGS(__construct
, 0)
457 PHP_HTTP_ARG_VAL(old_url
, 0)
458 PHP_HTTP_ARG_VAL(new_url
, 0)
459 PHP_HTTP_ARG_VAL(flags
, 0)
461 PHP_HTTP_EMPTY_ARGS(toString
);
462 PHP_HTTP_EMPTY_ARGS(toArray
);
464 PHP_HTTP_BEGIN_ARGS(mod
, 1)
465 PHP_HTTP_ARG_VAL(more_url_parts
, 0)
466 PHP_HTTP_ARG_VAL(flags
, 0)
469 zend_class_entry
*php_http_url_class_entry
;
470 zend_function_entry php_http_url_method_entry
[] = {
471 PHP_HTTP_URL_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
472 PHP_HTTP_URL_ME(mod
, ZEND_ACC_PUBLIC
)
473 PHP_HTTP_URL_ME(toString
, ZEND_ACC_PUBLIC
)
474 ZEND_MALIAS(HttpUrl
, __toString
, toString
, PHP_HTTP_ARGS(HttpUrl
, toString
), ZEND_ACC_PUBLIC
)
475 PHP_HTTP_URL_ME(toArray
, ZEND_ACC_PUBLIC
)
479 PHP_METHOD(HttpUrl
, __construct
)
481 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
482 zval
*new_url
= NULL
, *old_url
= NULL
;
483 long flags
= PHP_HTTP_URL_FROM_ENV
;
485 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|z!z!l", &old_url
, &new_url
, &flags
)) {
486 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
487 php_url
*res_purl
, *new_purl
= NULL
, *old_purl
= NULL
;
490 switch (Z_TYPE_P(new_url
)) {
493 new_purl
= php_http_url_from_struct(NULL
, HASH_OF(new_url
) TSRMLS_CC
);
496 zval
*cpy
= php_http_ztyp(IS_STRING
, new_url
);
498 new_purl
= php_url_parse(Z_STRVAL_P(cpy
));
508 switch (Z_TYPE_P(old_url
)) {
511 old_purl
= php_http_url_from_struct(NULL
, HASH_OF(old_url
) TSRMLS_CC
);
514 zval
*cpy
= php_http_ztyp(IS_STRING
, old_url
);
516 old_purl
= php_url_parse(Z_STRVAL_P(cpy
));
523 php_url_free(new_purl
);
529 php_http_url(flags
, old_purl
, new_purl
, &res_purl
, NULL
, NULL TSRMLS_CC
);
530 php_http_url_to_struct(res_purl
, getThis() TSRMLS_CC
);
532 php_url_free(res_purl
);
534 php_url_free(old_purl
);
537 php_url_free(new_purl
);
539 } end_error_handling();
541 } end_error_handling();
544 PHP_METHOD(HttpUrl
, mod
)
546 zval
*new_url
= NULL
;
547 long flags
= PHP_HTTP_URL_JOIN_PATH
| PHP_HTTP_URL_JOIN_QUERY
;
549 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!|l", &new_url
, &flags
)) {
550 php_url
*new_purl
= NULL
, *old_purl
= NULL
;
553 switch (Z_TYPE_P(new_url
)) {
556 new_purl
= php_http_url_from_struct(NULL
, HASH_OF(new_url
) TSRMLS_CC
);
559 zval
*cpy
= php_http_ztyp(IS_STRING
, new_url
);
561 new_purl
= php_url_parse(Z_STRVAL_P(new_url
));
571 if ((old_purl
= php_http_url_from_struct(NULL
, HASH_OF(getThis()) TSRMLS_CC
))) {
574 ZVAL_OBJVAL(return_value
, zend_objects_clone_obj(getThis() TSRMLS_CC
), 0);
576 php_http_url(flags
, old_purl
, new_purl
, &res_purl
, NULL
, NULL TSRMLS_CC
);
577 php_http_url_to_struct(res_purl
, return_value TSRMLS_CC
);
579 php_url_free(res_purl
);
580 php_url_free(old_purl
);
583 php_url_free(new_purl
);
588 PHP_METHOD(HttpUrl
, toString
)
590 if (SUCCESS
== zend_parse_parameters_none()) {
593 if ((purl
= php_http_url_from_struct(NULL
, HASH_OF(getThis()) TSRMLS_CC
))) {
597 php_http_url(0, purl
, NULL
, NULL
, &str
, &len TSRMLS_CC
);
599 RETURN_STRINGL(str
, len
, 0);
602 RETURN_EMPTY_STRING();
605 PHP_METHOD(HttpUrl
, toArray
)
607 if (SUCCESS
!= zend_parse_parameters_none()) {
610 array_init(return_value
);
611 array_copy(HASH_OF(getThis()), HASH_OF(return_value
));
614 PHP_MINIT_FUNCTION(http_url
)
616 PHP_HTTP_REGISTER_CLASS(http
, Url
, http_url
, php_http_object_class_entry
, 0);
618 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("scheme"), ZEND_ACC_PUBLIC TSRMLS_CC
);
619 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("user"), ZEND_ACC_PUBLIC TSRMLS_CC
);
620 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("pass"), ZEND_ACC_PUBLIC TSRMLS_CC
);
621 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("host"), ZEND_ACC_PUBLIC TSRMLS_CC
);
622 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("port"), ZEND_ACC_PUBLIC TSRMLS_CC
);
623 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("path"), ZEND_ACC_PUBLIC TSRMLS_CC
);
624 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("query"), ZEND_ACC_PUBLIC TSRMLS_CC
);
625 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("fragment"), ZEND_ACC_PUBLIC TSRMLS_CC
);
627 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("REPLACE"), PHP_HTTP_URL_REPLACE TSRMLS_CC
);
628 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("JOIN_PATH"), PHP_HTTP_URL_JOIN_PATH TSRMLS_CC
);
629 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("JOIN_QUERY"), PHP_HTTP_URL_JOIN_QUERY TSRMLS_CC
);
630 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_USER"), PHP_HTTP_URL_STRIP_USER TSRMLS_CC
);
631 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_PASS"), PHP_HTTP_URL_STRIP_PASS TSRMLS_CC
);
632 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_AUTH"), PHP_HTTP_URL_STRIP_AUTH TSRMLS_CC
);
633 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_PORT"), PHP_HTTP_URL_STRIP_PORT TSRMLS_CC
);
634 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_PATH"), PHP_HTTP_URL_STRIP_PATH TSRMLS_CC
);
635 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_QUERY"), PHP_HTTP_URL_STRIP_QUERY TSRMLS_CC
);
636 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_FRAGMENT"), PHP_HTTP_URL_STRIP_FRAGMENT TSRMLS_CC
);
637 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_ALL"), PHP_HTTP_URL_STRIP_ALL TSRMLS_CC
);
638 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("FROM_ENV"), PHP_HTTP_URL_FROM_ENV TSRMLS_CC
);
649 * vim600: noet sw=4 ts=4 fdm=marker
650 * vim<600: noet sw=4 ts=4