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 size_t stop_at
= strspn(Z_STRVAL_P(zhost
), "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-.");
97 url
->host
= estrndup(Z_STRVAL_P(zhost
), stop_at
);
99 url
->host
= localhostname();
103 if (SG(request_info
).request_uri
&& SG(request_info
).request_uri
[0]) {
104 const char *q
= strchr(SG(request_info
).request_uri
, '?');
107 url
->path
= estrndup(SG(request_info
).request_uri
, q
- SG(request_info
).request_uri
);
109 url
->path
= estrdup(SG(request_info
).request_uri
);
114 if (SG(request_info
).query_string
&& SG(request_info
).query_string
[0]) {
115 url
->query
= estrdup(SG(request_info
).query_string
);
121 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
)
123 php_url
*url
, *tmp_url
= NULL
;
124 #ifdef HAVE_GETSERVBYNAME
128 /* set from env if requested */
129 if (flags
& PHP_HTTP_URL_FROM_ENV
) {
130 php_url
*env_url
= php_http_url_from_env(NULL TSRMLS_CC
);
132 php_http_url(flags
^ PHP_HTTP_URL_FROM_ENV
, env_url
, old_url
, &tmp_url
, NULL
, NULL TSRMLS_CC
);
134 php_url_free(env_url
);
138 url
= ecalloc(1, sizeof(*url
));
140 #define __URLSET(u,n) \
142 #define __URLCPY(n) \
143 url->n = __URLSET(new_url,n) ? estrdup(new_url->n) : (__URLSET(old_url,n) ? estrdup(old_url->n) : NULL)
145 if (!(flags
& PHP_HTTP_URL_STRIP_PORT
)) {
146 url
->port
= __URLSET(new_url
, port
) ? new_url
->port
: ((old_url
) ? old_url
->port
: 0);
148 if (!(flags
& PHP_HTTP_URL_STRIP_USER
)) {
151 if (!(flags
& PHP_HTTP_URL_STRIP_PASS
)) {
158 if (!(flags
& PHP_HTTP_URL_STRIP_PATH
)) {
159 if ((flags
& PHP_HTTP_URL_JOIN_PATH
) && __URLSET(old_url
, path
) && __URLSET(new_url
, path
) && *new_url
->path
!= '/') {
160 size_t old_path_len
= strlen(old_url
->path
), new_path_len
= strlen(new_url
->path
);
162 url
->path
= ecalloc(1, old_path_len
+ new_path_len
+ 1 + 1);
164 strcat(url
->path
, old_url
->path
);
165 if (url
->path
[old_path_len
- 1] != '/') {
166 php_dirname(url
->path
, old_path_len
);
167 strcat(url
->path
, "/");
169 strcat(url
->path
, new_url
->path
);
174 if (!(flags
& PHP_HTTP_URL_STRIP_QUERY
)) {
175 if ((flags
& PHP_HTTP_URL_JOIN_QUERY
) && __URLSET(new_url
, query
) && __URLSET(old_url
, query
)) {
182 ZVAL_STRING(&qstr
, old_url
->query
, 0);
183 php_http_querystring_update(&qarr
, &qstr
, NULL TSRMLS_CC
);
184 ZVAL_STRING(&qstr
, new_url
->query
, 0);
185 php_http_querystring_update(&qarr
, &qstr
, NULL TSRMLS_CC
);
188 php_http_querystring_update(&qarr
, NULL
, &qstr TSRMLS_CC
);
189 url
->query
= Z_STRVAL(qstr
);
195 if (!(flags
& PHP_HTTP_URL_STRIP_FRAGMENT
)) {
199 /* done with copy & combine & strip */
201 if (flags
& PHP_HTTP_URL_FROM_ENV
) {
202 /* free old_url we tainted above */
203 php_url_free(tmp_url
);
206 /* set some sane defaults */
209 url
->scheme
= estrndup("http", lenof("http"));
213 url
->host
= estrndup("localhost", lenof("localhost"));
217 url
->path
= estrndup("/", 1);
218 } else if (url
->path
[0] != '/') {
219 size_t plen
= strlen(url
->path
);
220 char *path
= emalloc(plen
+ 1 + 1);
223 memcpy(&path
[1], url
->path
, plen
+ 1);
224 STR_SET(url
->path
, path
);
226 /* replace directory references if path is not a single slash */
227 if ((flags
& PHP_HTTP_URL_SANITIZE_PATH
)
228 && url
->path
[0] && (url
->path
[0] != '/' || url
->path
[1])) {
229 char *ptr
, *end
= url
->path
+ strlen(url
->path
) + 1;
231 for (ptr
= strchr(url
->path
, '/'); ptr
; ptr
= strchr(ptr
, '/')) {
234 memmove(&ptr
[1], &ptr
[2], end
- &ptr
[2]);
244 memmove(&ptr
[1], &ptr
[3], end
- &ptr
[3]);
250 while (ptr
!= url
->path
) {
255 memmove(&ptr
[1], pos
, end
- pos
);
257 } else if (!ptr
[3]) {
276 /* unset default ports */
278 if ( ((url
->port
== 80) && !strcmp(url
->scheme
, "http"))
279 || ((url
->port
==443) && !strcmp(url
->scheme
, "https"))
280 #ifdef HAVE_GETSERVBYNAME
281 || ((se
= getservbyname(url
->scheme
, "tcp")) && se
->s_port
&&
282 (url
->port
== ntohs(se
->s_port
)))
292 *url_str
= emalloc(PHP_HTTP_URL_MAXLEN
+ 1);
295 strlcat(*url_str
, url
->scheme
, PHP_HTTP_URL_MAXLEN
);
296 strlcat(*url_str
, "://", PHP_HTTP_URL_MAXLEN
);
298 if (url
->user
&& *url
->user
) {
299 strlcat(*url_str
, url
->user
, PHP_HTTP_URL_MAXLEN
);
300 if (url
->pass
&& *url
->pass
) {
301 strlcat(*url_str
, ":", PHP_HTTP_URL_MAXLEN
);
302 strlcat(*url_str
, url
->pass
, PHP_HTTP_URL_MAXLEN
);
304 strlcat(*url_str
, "@", PHP_HTTP_URL_MAXLEN
);
307 strlcat(*url_str
, url
->host
, PHP_HTTP_URL_MAXLEN
);
312 snprintf(port_str
, sizeof(port_str
), "%d", (int) url
->port
);
313 strlcat(*url_str
, ":", PHP_HTTP_URL_MAXLEN
);
314 strlcat(*url_str
, port_str
, PHP_HTTP_URL_MAXLEN
);
317 strlcat(*url_str
, url
->path
, PHP_HTTP_URL_MAXLEN
);
319 if (url
->query
&& *url
->query
) {
320 strlcat(*url_str
, "?", PHP_HTTP_URL_MAXLEN
);
321 strlcat(*url_str
, url
->query
, PHP_HTTP_URL_MAXLEN
);
324 if (url
->fragment
&& *url
->fragment
) {
325 strlcat(*url_str
, "#", PHP_HTTP_URL_MAXLEN
);
326 strlcat(*url_str
, url
->fragment
, PHP_HTTP_URL_MAXLEN
);
329 if (PHP_HTTP_URL_MAXLEN
== (len
= strlen(*url_str
))) {
330 php_http_error(HE_NOTICE
, PHP_HTTP_E_URL
, "Length of URL exceeds PHP_HTTP_URL_MAXLEN");
344 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
)
346 const char *arg_sep_str
;
348 php_http_buffer_t
*qstr
= php_http_buffer_new();
350 php_http_url_argsep(&arg_sep_str
, &arg_sep_len TSRMLS_CC
);
352 if (pre_encoded_len
&& pre_encoded_str
) {
353 php_http_buffer_append(qstr
, pre_encoded_str
, pre_encoded_len
);
356 if (SUCCESS
!= php_http_url_encode_hash_ex(hash
, qstr
, arg_sep_str
, arg_sep_len
, ZEND_STRL("="), NULL
, 0 TSRMLS_CC
)) {
357 php_http_buffer_free(&qstr
);
361 php_http_buffer_data(qstr
, encoded_str
, encoded_len
);
362 php_http_buffer_free(&qstr
);
367 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
)
369 php_http_array_hashkey_t key
= php_http_array_hashkey_init(0);
374 php_http_error(HE_WARNING
, PHP_HTTP_E_INVALID_PARAM
, "Invalid parameters");
377 if (ht
->nApplyCount
> 0) {
381 FOREACH_HASH_KEYVAL(pos
, ht
, key
, data
) {
384 php_http_buffer_t new_prefix
;
386 if (!data
|| !*data
) {
387 php_http_buffer_dtor(str
);
391 if (key
.type
== HASH_KEY_IS_STRING
) {
393 /* only public properties */
396 if (key
.len
&& key
.str
[key
.len
- 1] == '\0') {
399 encoded_key
= php_url_encode(key
.str
, key
.len
, &encoded_len
);
401 encoded_len
= spprintf(&encoded_key
, 0, "%ld", key
.num
);
405 php_http_buffer_init(&new_prefix
);
406 if (prefix_str
&& prefix_len
) {
407 php_http_buffer_append(&new_prefix
, prefix_str
, prefix_len
);
408 php_http_buffer_appends(&new_prefix
, "%5B");
411 php_http_buffer_append(&new_prefix
, encoded_key
, encoded_len
);
414 if (prefix_str
&& prefix_len
) {
415 php_http_buffer_appends(&new_prefix
, "%5D");
417 php_http_buffer_fix(&new_prefix
);
420 if (Z_TYPE_PP(data
) == IS_ARRAY
|| Z_TYPE_PP(data
) == IS_OBJECT
) {
423 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
);
425 if (SUCCESS
!= status
) {
426 php_http_buffer_dtor(&new_prefix
);
427 php_http_buffer_dtor(str
);
431 zval
*val
= php_http_ztyp(IS_STRING
, *data
);
433 if (PHP_HTTP_BUFFER_LEN(str
)) {
434 php_http_buffer_append(str
, arg_sep_str
, arg_sep_len
);
436 php_http_buffer_append(str
, PHP_HTTP_BUFFER_VAL(&new_prefix
), PHP_HTTP_BUFFER_LEN(&new_prefix
));
437 php_http_buffer_append(str
, val_sep_str
, val_sep_len
);
439 if (Z_STRLEN_P(val
) && Z_STRVAL_P(val
)) {
443 encoded_val
= php_url_encode(Z_STRVAL_P(val
), Z_STRLEN_P(val
), &encoded_len
);
444 php_http_buffer_append(str
, encoded_val
, encoded_len
);
450 php_http_buffer_dtor(&new_prefix
);
455 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpUrl, method, 0, req_args)
456 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpUrl, method, 0)
457 #define PHP_HTTP_URL_ME(method, visibility) PHP_ME(HttpUrl, method, PHP_HTTP_ARGS(HttpUrl, method), visibility)
459 PHP_HTTP_BEGIN_ARGS(__construct
, 0)
460 PHP_HTTP_ARG_VAL(old_url
, 0)
461 PHP_HTTP_ARG_VAL(new_url
, 0)
462 PHP_HTTP_ARG_VAL(flags
, 0)
464 PHP_HTTP_EMPTY_ARGS(toString
);
465 PHP_HTTP_EMPTY_ARGS(toArray
);
467 PHP_HTTP_BEGIN_ARGS(mod
, 1)
468 PHP_HTTP_ARG_VAL(more_url_parts
, 0)
469 PHP_HTTP_ARG_VAL(flags
, 0)
472 static zend_class_entry
*php_http_url_class_entry
;
474 zend_class_entry
*php_http_url_get_class_entry(void)
476 return php_http_url_class_entry
;
479 static zend_function_entry php_http_url_method_entry
[] = {
480 PHP_HTTP_URL_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
481 PHP_HTTP_URL_ME(mod
, ZEND_ACC_PUBLIC
)
482 PHP_HTTP_URL_ME(toString
, ZEND_ACC_PUBLIC
)
483 ZEND_MALIAS(HttpUrl
, __toString
, toString
, PHP_HTTP_ARGS(HttpUrl
, toString
), ZEND_ACC_PUBLIC
)
484 PHP_HTTP_URL_ME(toArray
, ZEND_ACC_PUBLIC
)
488 PHP_METHOD(HttpUrl
, __construct
)
490 with_error_handling(EH_THROW
, php_http_exception_get_class_entry()) {
491 zval
*new_url
= NULL
, *old_url
= NULL
;
492 long flags
= PHP_HTTP_URL_FROM_ENV
;
494 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|z!z!l", &old_url
, &new_url
, &flags
)) {
495 with_error_handling(EH_THROW
, php_http_exception_get_class_entry()) {
496 php_url
*res_purl
, *new_purl
= NULL
, *old_purl
= NULL
;
499 switch (Z_TYPE_P(new_url
)) {
502 new_purl
= php_http_url_from_struct(NULL
, HASH_OF(new_url
) TSRMLS_CC
);
505 zval
*cpy
= php_http_ztyp(IS_STRING
, new_url
);
507 new_purl
= php_url_parse(Z_STRVAL_P(cpy
));
517 switch (Z_TYPE_P(old_url
)) {
520 old_purl
= php_http_url_from_struct(NULL
, HASH_OF(old_url
) TSRMLS_CC
);
523 zval
*cpy
= php_http_ztyp(IS_STRING
, old_url
);
525 old_purl
= php_url_parse(Z_STRVAL_P(cpy
));
532 php_url_free(new_purl
);
538 php_http_url(flags
, old_purl
, new_purl
, &res_purl
, NULL
, NULL TSRMLS_CC
);
539 php_http_url_to_struct(res_purl
, getThis() TSRMLS_CC
);
541 php_url_free(res_purl
);
543 php_url_free(old_purl
);
546 php_url_free(new_purl
);
548 } end_error_handling();
550 } end_error_handling();
553 PHP_METHOD(HttpUrl
, mod
)
555 zval
*new_url
= NULL
;
556 long flags
= PHP_HTTP_URL_JOIN_PATH
| PHP_HTTP_URL_JOIN_QUERY
;
558 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!|l", &new_url
, &flags
)) {
559 php_url
*new_purl
= NULL
, *old_purl
= NULL
;
562 switch (Z_TYPE_P(new_url
)) {
565 new_purl
= php_http_url_from_struct(NULL
, HASH_OF(new_url
) TSRMLS_CC
);
568 zval
*cpy
= php_http_ztyp(IS_STRING
, new_url
);
570 new_purl
= php_url_parse(Z_STRVAL_P(new_url
));
580 if ((old_purl
= php_http_url_from_struct(NULL
, HASH_OF(getThis()) TSRMLS_CC
))) {
583 ZVAL_OBJVAL(return_value
, zend_objects_clone_obj(getThis() TSRMLS_CC
), 0);
585 php_http_url(flags
, old_purl
, new_purl
, &res_purl
, NULL
, NULL TSRMLS_CC
);
586 php_http_url_to_struct(res_purl
, return_value TSRMLS_CC
);
588 php_url_free(res_purl
);
589 php_url_free(old_purl
);
592 php_url_free(new_purl
);
597 PHP_METHOD(HttpUrl
, toString
)
599 if (SUCCESS
== zend_parse_parameters_none()) {
602 if ((purl
= php_http_url_from_struct(NULL
, HASH_OF(getThis()) TSRMLS_CC
))) {
606 php_http_url(0, purl
, NULL
, NULL
, &str
, &len TSRMLS_CC
);
608 RETURN_STRINGL(str
, len
, 0);
611 RETURN_EMPTY_STRING();
614 PHP_METHOD(HttpUrl
, toArray
)
616 if (SUCCESS
!= zend_parse_parameters_none()) {
619 array_init(return_value
);
620 array_copy(HASH_OF(getThis()), HASH_OF(return_value
));
623 PHP_MINIT_FUNCTION(http_url
)
625 PHP_HTTP_REGISTER_CLASS(http
, Url
, http_url
, php_http_object_get_class_entry(), 0);
627 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("scheme"), ZEND_ACC_PUBLIC TSRMLS_CC
);
628 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("user"), ZEND_ACC_PUBLIC TSRMLS_CC
);
629 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("pass"), ZEND_ACC_PUBLIC TSRMLS_CC
);
630 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("host"), ZEND_ACC_PUBLIC TSRMLS_CC
);
631 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("port"), ZEND_ACC_PUBLIC TSRMLS_CC
);
632 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("path"), ZEND_ACC_PUBLIC TSRMLS_CC
);
633 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("query"), ZEND_ACC_PUBLIC TSRMLS_CC
);
634 zend_declare_property_null(php_http_url_class_entry
, ZEND_STRL("fragment"), ZEND_ACC_PUBLIC TSRMLS_CC
);
636 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("REPLACE"), PHP_HTTP_URL_REPLACE TSRMLS_CC
);
637 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("JOIN_PATH"), PHP_HTTP_URL_JOIN_PATH TSRMLS_CC
);
638 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("JOIN_QUERY"), PHP_HTTP_URL_JOIN_QUERY TSRMLS_CC
);
639 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_USER"), PHP_HTTP_URL_STRIP_USER TSRMLS_CC
);
640 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_PASS"), PHP_HTTP_URL_STRIP_PASS TSRMLS_CC
);
641 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_AUTH"), PHP_HTTP_URL_STRIP_AUTH TSRMLS_CC
);
642 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_PORT"), PHP_HTTP_URL_STRIP_PORT TSRMLS_CC
);
643 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_PATH"), PHP_HTTP_URL_STRIP_PATH TSRMLS_CC
);
644 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_QUERY"), PHP_HTTP_URL_STRIP_QUERY TSRMLS_CC
);
645 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_FRAGMENT"), PHP_HTTP_URL_STRIP_FRAGMENT TSRMLS_CC
);
646 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("STRIP_ALL"), PHP_HTTP_URL_STRIP_ALL TSRMLS_CC
);
647 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("FROM_ENV"), PHP_HTTP_URL_FROM_ENV TSRMLS_CC
);
648 zend_declare_class_constant_long(php_http_url_class_entry
, ZEND_STRL("SANITIZE_PATH"), PHP_HTTP_URL_SANITIZE_PATH TSRMLS_CC
);
659 * vim600: noet sw=4 ts=4 fdm=marker
660 * vim<600: noet sw=4 ts=4