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-2014, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
13 #ifndef PHP_HTTP_URL_H
14 #define PHP_HTTP_URL_H
16 #include <ext/standard/url.h>
18 #define PHP_HTTP_URL_REPLACE 0x000
19 #define PHP_HTTP_URL_JOIN_PATH 0x001
20 #define PHP_HTTP_URL_JOIN_QUERY 0x002
21 #define PHP_HTTP_URL_STRIP_USER 0x004
22 #define PHP_HTTP_URL_STRIP_PASS 0x008
23 #define PHP_HTTP_URL_STRIP_AUTH (PHP_HTTP_URL_STRIP_USER|PHP_HTTP_URL_STRIP_PASS)
24 #define PHP_HTTP_URL_STRIP_PORT 0x020
25 #define PHP_HTTP_URL_STRIP_PATH 0x040
26 #define PHP_HTTP_URL_STRIP_QUERY 0x080
27 #define PHP_HTTP_URL_STRIP_FRAGMENT 0x100
28 #define PHP_HTTP_URL_STRIP_ALL ( \
29 PHP_HTTP_URL_STRIP_AUTH | \
30 PHP_HTTP_URL_STRIP_PORT | \
31 PHP_HTTP_URL_STRIP_PATH | \
32 PHP_HTTP_URL_STRIP_QUERY | \
33 PHP_HTTP_URL_STRIP_FRAGMENT \
35 #define PHP_HTTP_URL_FROM_ENV 0x1000
36 #define PHP_HTTP_URL_SANITIZE_PATH 0x2000
38 typedef struct php_http_url_part
{
41 } php_http_url_part_t
;
43 /* parse multibyte according to locale */
44 #define PHP_HTTP_URL_PARSE_MBLOC 0x001
45 /* parse utf8 multibyte sequences */
46 #define PHP_HTTP_URL_PARSE_MBUTF8 0x002
47 /* convert multibyte hostnames to IDNA */
48 #define PHP_HTTP_URL_PARSE_TOIDN 0x010
49 /* percent encode multibyte sequences in userinfo, path, query and fragment */
50 #define PHP_HTTP_URL_PARSE_TOPCT 0x020
52 typedef struct php_http_url
{
53 /* compatible to php_url, but do not use php_url_free() */
64 PHP_HTTP_API php_http_url_t
*php_http_url_parse(const char *str
, size_t len
, unsigned flags TSRMLS_DC
);
65 PHP_HTTP_API
void php_http_url_free(php_http_url_t
**url
);
67 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
);
69 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
);
70 PHP_HTTP_API STATUS
php_http_url_encode_hash_ex(HashTable
*hash
, php_http_buffer_t
*qstr
, const char *arg_sep_str
, size_t arg_sep_len
, const char *val_sep_str
, size_t val_sep_len
, const char *pre_encoded_str
, size_t pre_encoded_len TSRMLS_DC
);
72 static inline void php_http_url_argsep(const char **str
, size_t *len TSRMLS_DC
)
74 if (SUCCESS
!= php_http_ini_entry(ZEND_STRL("arg_separator.output"), str
, len
, 0 TSRMLS_CC
) || !*len
) {
75 *str
= PHP_HTTP_URL_ARGSEP
;
76 *len
= lenof(PHP_HTTP_URL_ARGSEP
);
80 static inline void php_http_url_to_string(php_url
*url
, char **url_str
, size_t *url_len TSRMLS_DC
)
82 php_http_buffer_t buf
;
84 php_http_buffer_init(&buf
);
86 if (url
->scheme
&& *url
->scheme
) {
87 php_http_buffer_appendl(&buf
, url
->scheme
);
88 php_http_buffer_appends(&buf
, "://");
90 php_http_buffer_appends(&buf
, "//");
93 if (url
->user
&& *url
->user
) {
94 php_http_buffer_appendl(&buf
, url
->user
);
95 if (url
->pass
&& *url
->pass
) {
96 php_http_buffer_appends(&buf
, ":");
97 php_http_buffer_appendl(&buf
, url
->pass
);
99 php_http_buffer_appends(&buf
, "@");
102 if (url
->host
&& *url
->host
) {
103 php_http_buffer_appendl(&buf
, url
->host
);
105 php_http_buffer_appends(&buf
, "localhost");
109 php_http_buffer_appendf(&buf
, ":%hu", url
->port
);
112 if (url
->path
&& *url
->path
) {
113 php_http_buffer_appendl(&buf
, url
->path
);
116 if (url
->query
&& *url
->query
) {
117 php_http_buffer_appends(&buf
, "?");
118 php_http_buffer_appendl(&buf
, url
->query
);
121 if (url
->fragment
&& *url
->fragment
) {
122 php_http_buffer_appends(&buf
, "#");
123 php_http_buffer_appendl(&buf
, url
->fragment
);
126 php_http_buffer_shrink(&buf
);
127 php_http_buffer_fix(&buf
);
136 php_http_buffer_dtor(&buf
);
140 static inline php_url
*php_http_url_from_struct(php_url
*url
, HashTable
*ht TSRMLS_DC
)
145 url
= emalloc(sizeof(*url
));
147 memset(url
, 0, sizeof(*url
));
149 if (SUCCESS
== zend_hash_find(ht
, "scheme", sizeof("scheme"), (void *) &e
)) {
150 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
151 url
->scheme
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
154 if (SUCCESS
== zend_hash_find(ht
, "user", sizeof("user"), (void *) &e
)) {
155 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
156 url
->user
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
159 if (SUCCESS
== zend_hash_find(ht
, "pass", sizeof("pass"), (void *) &e
)) {
160 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
161 url
->pass
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
164 if (SUCCESS
== zend_hash_find(ht
, "host", sizeof("host"), (void *) &e
)) {
165 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
166 url
->host
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
169 if (SUCCESS
== zend_hash_find(ht
, "path", sizeof("path"), (void *) &e
)) {
170 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
171 url
->path
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
174 if (SUCCESS
== zend_hash_find(ht
, "query", sizeof("query"), (void *) &e
)) {
175 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
176 url
->query
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
179 if (SUCCESS
== zend_hash_find(ht
, "fragment", sizeof("fragment"), (void *) &e
)) {
180 zval
*cpy
= php_http_ztyp(IS_STRING
, *e
);
181 url
->fragment
= estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
184 if (SUCCESS
== zend_hash_find(ht
, "port", sizeof("port"), (void *) &e
)) {
185 zval
*cpy
= php_http_ztyp(IS_LONG
, *e
);
186 url
->port
= (unsigned short) Z_LVAL_P(cpy
);
193 static inline HashTable
*php_http_url_to_struct(php_url
*url
, zval
*strct TSRMLS_DC
)
198 switch (Z_TYPE_P(strct
)) {
205 INIT_PZVAL_ARRAY((&arr
), HASH_OF(strct
));
215 add_assoc_string(&arr
, "scheme", url
->scheme
, 1);
218 add_assoc_string(&arr
, "user", url
->user
, 1);
221 add_assoc_string(&arr
, "pass", url
->pass
, 1);
224 add_assoc_string(&arr
, "host", url
->host
, 1);
227 add_assoc_long(&arr
, "port", (long) url
->port
);
230 add_assoc_string(&arr
, "path", url
->path
, 1);
233 add_assoc_string(&arr
, "query", url
->query
, 1);
236 add_assoc_string(&arr
, "fragment", url
->fragment
, 1);
240 return Z_ARRVAL(arr
);
243 PHP_HTTP_API zend_class_entry
*php_http_url_class_entry
;
244 PHP_MINIT_FUNCTION(http_url
);
246 #define php_http_url_object_new php_http_object_new
247 #define php_http_url_object_new_ex php_http_object_new_ex
256 * vim600: noet sw=4 ts=4 fdm=marker
257 * vim<600: noet sw=4 ts=4