- Fixed build on php-trunk
[m6w6/ext-http] / php_http_api.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-2010, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #ifndef PHP_HTTP_API_H
16 #define PHP_HTTP_API_H
17
18 #define HTTP_SUPPORT 0x01L
19 #define HTTP_SUPPORT_REQUESTS 0x02L
20 #define HTTP_SUPPORT_MAGICMIME 0x04L
21 #define HTTP_SUPPORT_ENCODINGS 0x08L
22 #define HTTP_SUPPORT_SSLREQUESTS 0x20L
23 #define HTTP_SUPPORT_PERSISTENCE 0x40L
24 #define HTTP_SUPPORT_EVENTS 0x80L
25
26 #define HTTP_PARAMS_ALLOW_COMMA 0x01
27 #define HTTP_PARAMS_ALLOW_FAILURE 0x02
28 #define HTTP_PARAMS_RAISE_ERROR 0x04
29 #define HTTP_PARAMS_DEFAULT (HTTP_PARAMS_ALLOW_COMMA|HTTP_PARAMS_ALLOW_FAILURE|HTTP_PARAMS_RAISE_ERROR)
30 #define HTTP_PARAMS_COLON_SEPARATOR 0x10
31
32 extern PHP_MINIT_FUNCTION(http_support);
33
34 #define http_support(f) _http_support(f)
35 PHP_HTTP_API long _http_support(long feature);
36
37 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
38 extern char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
39
40 #define http_boundary(b, l) _http_boundary((b), (l) TSRMLS_CC)
41 extern size_t _http_boundary(char *buf, size_t len TSRMLS_DC);
42
43 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
44 #define http_error_ex _http_error_ex
45 extern void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...);
46
47
48 #ifdef ZEND_ENGINE_2
49 #define http_exception_wrap(o, n, ce) _http_exception_wrap((o), (n), (ce) TSRMLS_CC)
50 extern zval *_http_exception_wrap(zval *old_exception, zval *new_exception, zend_class_entry *ce TSRMLS_DC);
51
52 #define http_try \
53 { \
54 zval *old_exception = EG(exception); \
55 EG(exception) = NULL;
56 #define http_catch(ex_ce) \
57 if (EG(exception) && old_exception) { \
58 EG(exception) = http_exception_wrap(old_exception, EG(exception), ex_ce); \
59 } \
60 }
61 #define http_final(ex_ce) \
62 if (EG(exception)) { \
63 EG(exception) = http_exception_wrap(EG(exception), NULL, ex_ce); \
64 }
65
66 typedef zend_object_value (*http_object_new_t)(zend_class_entry *ce, void *, void ** TSRMLS_DC);
67
68 #define http_object_new(ov, cn, cl, co, ce, i, pp) _http_object_new((ov), (cn), (cl), (http_object_new_t) (co), (ce), (i), (void *) (pp) TSRMLS_CC)
69 extern STATUS _http_object_new(zend_object_value *ov, const char *cname_str, uint cname_len, http_object_new_t create, zend_class_entry *parent_ce, void *intern_ptr, void **obj_ptr TSRMLS_DC);
70 #endif /* ZEND_ENGINE_2 */
71
72
73 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
74 if ((!(ch)) && (!((ch) = init))) { \
75 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
76 action; \
77 }
78 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
79 if (!strchr((ct), '/')) { \
80 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
81 "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
82 action; \
83 }
84 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
85 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
86 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
87 action; \
88 }
89 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
90 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
91 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
92 action; \
93 }
94 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
95 if (level < -1 || level > 9) { \
96 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
97 action; \
98 }
99
100 #define HTTP_CHECK_HEADERS_SENT(action) \
101 if (SG(headers_sent) && !SG(request_info).no_headers) { \
102 char *output_start_filename = php_get_output_start_filename(TSRMLS_C); \
103 int output_start_lineno = php_get_output_start_lineno(TSRMLS_C); \
104 \
105 if (output_start_filename) { \
106 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent by (output started at %s:%d)", \
107 output_start_filename, output_start_lineno); \
108 } else { \
109 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent"); \
110 } \
111 action; \
112 }
113
114 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
115 extern void _http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC);
116
117 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
118 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
119 extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC);
120
121 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
122 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
123 extern STATUS _http_check_method_ex(const char *method, const char *methods);
124
125 #define http_got_server_var(v) (NULL != http_get_server_var_ex((v), strlen(v), 1))
126 #define http_get_server_var(v, c) http_get_server_var_ex((v), strlen(v), (c))
127 #define http_get_server_var_ex(v, l, c) _http_get_server_var_ex((v), (l), (c) TSRMLS_CC)
128 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_len, zend_bool check TSRMLS_DC);
129
130 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
131 #define http_get_request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
132 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
133
134 #define http_get_request_body_stream() _http_get_request_body_stream(TSRMLS_C)
135 PHP_HTTP_API php_stream *_http_get_request_body_stream(TSRMLS_D);
136
137
138 typedef void (*http_parse_params_callback)(void *cb_arg, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
139
140 #define http_parse_params_default_callback _http_parse_params_default_callback
141 PHP_HTTP_API void _http_parse_params_default_callback(void *ht, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
142
143 #define http_parse_params(s, f, ht) _http_parse_params_ex((s), (f), _http_parse_params_default_callback, (ht) TSRMLS_CC)
144 #define http_parse_params_ex(s, f, cb, a) _http_parse_params_ex((s), (f), (cb), (a) TSRMLS_CC)
145 PHP_HTTP_API STATUS _http_parse_params_ex(const char *params, int flags, http_parse_params_callback cb, void *cb_arg TSRMLS_DC);
146
147
148 #define http_sleep(s) _http_sleep(s)
149 static inline void _http_sleep(double s)
150 {
151 #define HTTP_DIFFSEC (0.001)
152 #define HTTP_MLLISEC (1000)
153 #define HTTP_MCROSEC (1000 * 1000)
154 #define HTTP_NANOSEC (1000 * 1000 * 1000)
155 #define HTTP_MSEC(s) ((long)(s * HTTP_MLLISEC))
156 #define HTTP_USEC(s) ((long)(s * HTTP_MCROSEC))
157 #define HTTP_NSEC(s) ((long)(s * HTTP_NANOSEC))
158
159 #if defined(PHP_WIN32)
160 Sleep((DWORD) HTTP_MSEC(s));
161 #elif defined(HAVE_USLEEP)
162 usleep(HTTP_USEC(s));
163 #elif defined(HAVE_NANOSLEEP)
164 struct timespec req, rem;
165
166 req.tv_sec = (time_t) s;
167 req.tv_nsec = HTTP_NSEC(s) % HTTP_NANOSEC;
168
169 while (nanosleep(&req, &rem) && (errno == EINTR) && (HTTP_NSEC(rem.tv_sec) + rem.tv_nsec) > HTTP_NSEC(HTTP_DIFFSEC))) {
170 req.tv_sec = rem.tv_sec;
171 req.tv_nsec = rem.tv_nsec;
172 }
173 #else
174 struct timeval timeout;
175
176 timeout.tv.sec = (time_t) s;
177 timeout.tv_usec = HTTP_USEC(s) % HTTP_MCROSEC;
178
179 select(0, NULL, NULL, NULL, &timeout);
180 #endif
181 }
182
183 #define http_locate_str _http_locate_str
184 static inline const char *_http_locate_str(const char *h, size_t h_len, const char *n, size_t n_len)
185 {
186 const char *p, *e;
187
188 if (n_len && h_len) {
189 e = h + h_len;
190 do {
191 if (*h == *n) {
192 for (p = n; *p == h[p-n]; ++p) {
193 if (p == n+n_len-1) {
194 return h;
195 }
196 }
197 }
198 } while (h++ != e);
199 }
200
201 return NULL;
202 }
203
204 #define http_locate_body _http_locate_body
205 static inline const char *_http_locate_body(const char *message)
206 {
207 const char *body = NULL, *msg = message;
208
209 while (*msg) {
210 if (*msg == '\n') {
211 if (*(msg+1) == '\n') {
212 body = msg + 2;
213 break;
214 } else if (*(msg+1) == '\r' && *(msg+2) == '\n') {
215 body = msg + 3;
216 break;
217 }
218 }
219 ++msg;
220 }
221 return body;
222 }
223
224 #define http_locate_eol _http_locate_eol
225 static inline const char *_http_locate_eol(const char *line, int *eol_len)
226 {
227 const char *eol = strpbrk(line, "\r\n");
228
229 if (eol_len) {
230 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
231 }
232 return eol;
233 }
234
235 #define http_zset(t, z) _http_zset((t), (z))
236 static inline zval *_http_zset(int type, zval *z)
237 {
238 if (Z_TYPE_P(z) != type) {
239 switch (type) {
240 case IS_NULL: convert_to_null(z); break;
241 case IS_BOOL: convert_to_boolean(z); break;
242 case IS_LONG: convert_to_long(z); break;
243 case IS_DOUBLE: convert_to_double(z); break;
244 case IS_STRING: convert_to_string(z); break;
245 case IS_ARRAY: convert_to_array(z); break;
246 case IS_OBJECT: convert_to_object(z); break;
247 }
248 }
249 return z;
250 }
251 #define http_zsep(t, z) _http_zsep_ex((t), (z), NULL)
252 #define http_zsep_ex(t, z, p) _http_zsep_ex((t), (z), (p))
253 static inline zval *_http_zsep_ex(int type, zval *z, zval **p) {
254 SEPARATE_ARG_IF_REF(z);
255 if (Z_TYPE_P(z) != type) {
256 switch (type) {
257 case IS_NULL: convert_to_null_ex(&z); break;
258 case IS_BOOL: convert_to_boolean_ex(&z); break;
259 case IS_LONG: convert_to_long_ex(&z); break;
260 case IS_DOUBLE: convert_to_double_ex(&z); break;
261 case IS_STRING: convert_to_string_ex(&z); break;
262 case IS_ARRAY: convert_to_array_ex(&z); break;
263 case IS_OBJECT: convert_to_object_ex(&z); break;
264 }
265 }
266 if (p) {
267 *p = z;
268 }
269 return z;
270 }
271
272 typedef struct _HashKey {
273 char *str;
274 uint len;
275 ulong num;
276 uint dup:1;
277 uint type:31;
278 } HashKey;
279 #define initHashKey(dup) {NULL, 0, 0, (dup), 0}
280
281 #define FOREACH_VAL(pos, array, val) FOREACH_HASH_VAL(pos, Z_ARRVAL_P(array), val)
282 #define FOREACH_HASH_VAL(pos, hash, val) \
283 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
284 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
285 zend_hash_move_forward_ex(hash, &pos))
286
287 #define FOREACH_KEY(pos, array, key) FOREACH_HASH_KEY(pos, Z_ARRVAL_P(array), key)
288 #define FOREACH_HASH_KEY(pos, hash, _key) \
289 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
290 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT; \
291 zend_hash_move_forward_ex(hash, &pos)) \
292
293 #define FOREACH_KEYVAL(pos, array, key, val) FOREACH_HASH_KEYVAL(pos, Z_ARRVAL_P(array), key, val)
294 #define FOREACH_HASH_KEYVAL(pos, hash, _key, val) \
295 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
296 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT && \
297 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
298 zend_hash_move_forward_ex(hash, &pos))
299
300 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
301 #define ARRAY_JOIN_STRONLY 1
302 #define ARRAY_JOIN_PRETTIFY 2
303 #define array_join(src, dst, append, flags) zend_hash_apply_with_arguments(src HTTP_ZAPI_HASH_TSRMLS_CC, (append)?apply_array_append_func:apply_array_merge_func, 2, dst, (int)flags)
304
305 extern int apply_array_append_func(void *pDest HTTP_ZAPI_HASH_TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
306 extern int apply_array_merge_func(void *pDest HTTP_ZAPI_HASH_TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
307
308 #endif
309
310 /*
311 * Local variables:
312 * tab-width: 4
313 * c-basic-offset: 4
314 * End:
315 * vim600: noet sw=4 ts=4 fdm=marker
316 * vim<600: noet sw=4 ts=4
317 */
318