don't sanitize URL path by default, and add http\Url::SANITIZE_PATH flag for that
[m6w6/ext-http] / php_http_url.h
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
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 +--------------------------------------------------------------------+
11 */
12
13 #ifndef PHP_HTTP_URL_H
14 #define PHP_HTTP_URL_H
15
16 #include <ext/standard/url.h>
17
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 \
34 )
35 #define PHP_HTTP_URL_FROM_ENV 0x1000
36 #define PHP_HTTP_URL_SANITIZE_PATH 0x2000
37
38 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);
39
40 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);
41 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);
42
43 static inline void php_http_url_argsep(const char **str, size_t *len TSRMLS_DC)
44 {
45 if (SUCCESS != php_http_ini_entry(ZEND_STRL("arg_separator.output"), str, len, 0 TSRMLS_CC) || !*len) {
46 *str = PHP_HTTP_URL_ARGSEP;
47 *len = lenof(PHP_HTTP_URL_ARGSEP);
48 }
49 }
50
51 static inline php_url *php_http_url_from_struct(php_url *url, HashTable *ht TSRMLS_DC)
52 {
53 zval **e;
54
55 if (!url) {
56 url = emalloc(sizeof(*url));
57 }
58 memset(url, 0, sizeof(*url));
59
60 if (SUCCESS == zend_hash_find(ht, "scheme", sizeof("scheme"), (void *) &e)) {
61 zval *cpy = php_http_ztyp(IS_STRING, *e);
62 url->scheme = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
63 zval_ptr_dtor(&cpy);
64 }
65 if (SUCCESS == zend_hash_find(ht, "user", sizeof("user"), (void *) &e)) {
66 zval *cpy = php_http_ztyp(IS_STRING, *e);
67 url->user = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
68 zval_ptr_dtor(&cpy);
69 }
70 if (SUCCESS == zend_hash_find(ht, "pass", sizeof("pass"), (void *) &e)) {
71 zval *cpy = php_http_ztyp(IS_STRING, *e);
72 url->pass = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
73 zval_ptr_dtor(&cpy);
74 }
75 if (SUCCESS == zend_hash_find(ht, "host", sizeof("host"), (void *) &e)) {
76 zval *cpy = php_http_ztyp(IS_STRING, *e);
77 url->host = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
78 zval_ptr_dtor(&cpy);
79 }
80 if (SUCCESS == zend_hash_find(ht, "path", sizeof("path"), (void *) &e)) {
81 zval *cpy = php_http_ztyp(IS_STRING, *e);
82 url->path = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
83 zval_ptr_dtor(&cpy);
84 }
85 if (SUCCESS == zend_hash_find(ht, "query", sizeof("query"), (void *) &e)) {
86 zval *cpy = php_http_ztyp(IS_STRING, *e);
87 url->query = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
88 zval_ptr_dtor(&cpy);
89 }
90 if (SUCCESS == zend_hash_find(ht, "fragment", sizeof("fragment"), (void *) &e)) {
91 zval *cpy = php_http_ztyp(IS_STRING, *e);
92 url->fragment = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
93 zval_ptr_dtor(&cpy);
94 }
95 if (SUCCESS == zend_hash_find(ht, "port", sizeof("port"), (void *) &e)) {
96 zval *cpy = php_http_ztyp(IS_LONG, *e);
97 url->port = (unsigned short) Z_LVAL_P(cpy);
98 zval_ptr_dtor(&cpy);
99 }
100
101 return url;
102 }
103
104 static inline HashTable *php_http_url_to_struct(php_url *url, zval *strct TSRMLS_DC)
105 {
106 zval arr;
107
108 if (strct) {
109 switch (Z_TYPE_P(strct)) {
110 default:
111 zval_dtor(strct);
112 array_init(strct);
113 /* no break */
114 case IS_ARRAY:
115 case IS_OBJECT:
116 INIT_PZVAL_ARRAY((&arr), HASH_OF(strct));
117 break;
118 }
119 } else {
120 INIT_PZVAL(&arr);
121 array_init(&arr);
122 }
123
124 if (url) {
125 if (url->scheme) {
126 add_assoc_string(&arr, "scheme", url->scheme, 1);
127 }
128 if (url->user) {
129 add_assoc_string(&arr, "user", url->user, 1);
130 }
131 if (url->pass) {
132 add_assoc_string(&arr, "pass", url->pass, 1);
133 }
134 if (url->host) {
135 add_assoc_string(&arr, "host", url->host, 1);
136 }
137 if (url->port) {
138 add_assoc_long(&arr, "port", (long) url->port);
139 }
140 if (url->path) {
141 add_assoc_string(&arr, "path", url->path, 1);
142 }
143 if (url->query) {
144 add_assoc_string(&arr, "query", url->query, 1);
145 }
146 if (url->fragment) {
147 add_assoc_string(&arr, "fragment", url->fragment, 1);
148 }
149 }
150
151 return Z_ARRVAL(arr);
152 }
153
154 zend_class_entry *php_http_url_get_class_entry(void);
155
156 #define php_http_url_object_new php_http_object_new
157 #define php_http_url_object_new_ex php_http_object_new_ex
158
159 PHP_METHOD(HttpUrl, __construct);
160 PHP_METHOD(HttpUrl, mod);
161 PHP_METHOD(HttpUrl, toString);
162 PHP_METHOD(HttpUrl, toArray);
163
164 PHP_MINIT_FUNCTION(http_url);
165
166 #endif
167
168 /*
169 * Local variables:
170 * tab-width: 4
171 * c-basic-offset: 4
172 * End:
173 * vim600: noet sw=4 ts=4 fdm=marker
174 * vim<600: noet sw=4 ts=4
175 */
176