projects / m6w6 / ext-http / blob
? search:
summary | shortlog | log | commit | commitdiff | tree | github
history | raw | HEAD
- no pecl/event for ya
[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-2007, 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
31 extern PHP_MINIT_FUNCTION(http_support);
32
33 #define http_support(f) _http_support(f)
34 PHP_HTTP_API long _http_support(long feature);
35
36 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
37 extern char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
38
39 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
40 #define http_error_ex _http_error_ex
41 extern void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...);
42
43
44 #ifdef ZEND_ENGINE_2
45 #define http_exception_wrap(o, n, ce) _http_exception_wrap((o), (n), (ce) TSRMLS_CC)
46 extern zval *_http_exception_wrap(zval *old_exception, zval *new_exception, zend_class_entry *ce TSRMLS_DC);
47
48 #define http_try \
49 { \
50 zval *old_exception = EG(exception); \
51 EG(exception) = NULL;
52 #define http_catch(ex_ce) \
53 if (EG(exception) && old_exception) { \
54 EG(exception) = http_exception_wrap(old_exception, EG(exception), ex_ce); \
55 } \
56 }
57 #define http_final(ex_ce) \
58 if (EG(exception)) { \
59 EG(exception) = http_exception_wrap(EG(exception), NULL, ex_ce); \
60 }
61
62 typedef zend_object_value (*http_object_new_t)(zend_class_entry *ce, void *, void ** TSRMLS_DC);
63
64 #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)
65 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);
66 #endif /* ZEND_ENGINE_2 */
67
68
69 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
70 if ((!(ch)) && (!((ch) = init))) { \
71 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
72 action; \
73 }
74 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
75 if (!strchr((ct), '/')) { \
76 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
77 "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
78 action; \
79 }
80 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
81 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
82 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
83 action; \
84 }
85 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
86 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
87 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
88 action; \
89 }
90 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
91 if (level < -1 || level > 9) { \
92 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
93 action; \
94 }
95
96 #define HTTP_CHECK_HEADERS_SENT(action) \
97 if (SG(headers_sent) && !SG(request_info).no_headers) { \
98 char *output_start_filename = php_get_output_start_filename(TSRMLS_C); \
99 int output_start_lineno = php_get_output_start_lineno(TSRMLS_C); \
100 \
101 if (output_start_filename) { \
102 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent by (output started at %s:%d)", \
103 output_start_filename, output_start_lineno); \
104 } else { \
105 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent"); \
106 } \
107 action; \
108 }
109
110 #define HTTP_CHECK_OPEN_BASEDIR(file, act) \
111 if ((PG(open_basedir) && *PG(open_basedir)) || PG(safe_mode)) \
112 { \
113 const char *tmp = file; \
114 \
115 if (!strncasecmp(tmp, "file:", lenof("file:"))) { \
116 tmp += lenof("file:"); \
117 while ((tmp - (const char *)file < 7) && (*tmp == '/' || *tmp == '\\')) ++tmp; \
118 } \
119 \
120 if ( (tmp != file || !strstr(file, "://")) && \
121 (!*tmp || php_check_open_basedir(tmp TSRMLS_CC) || \
122 (PG(safe_mode) && !php_checkuid(tmp, "rb+", CHECKUID_CHECK_MODE_PARAM)))) { \
123 act; \
124 } \
125 }
126
127 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
128 extern void _http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC);
129
130 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
131 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
132 extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC);
133
134 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
135 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
136 extern STATUS _http_check_method_ex(const char *method, const char *methods);
137
138 #define http_got_server_var(v) (NULL != http_get_server_var_ex((v), strlen(v), 1))
139 #define http_get_server_var(v, c) http_get_server_var_ex((v), strlen(v), (c))
140 #define http_get_server_var_ex(v, l, c) _http_get_server_var_ex((v), (l), (c) TSRMLS_CC)
141 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_len, zend_bool check TSRMLS_DC);
142
143 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
144 #define http_get_request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
145 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
146
147 #define http_get_request_body_stream() _http_get_request_body_stream(TSRMLS_C)
148 PHP_HTTP_API php_stream *_http_get_request_body_stream(TSRMLS_D);
149
150
151 typedef void (*http_parse_params_callback)(void *cb_arg, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
152
153 #define http_parse_params_default_callback _http_parse_params_default_callback
154 PHP_HTTP_API void _http_parse_params_default_callback(void *ht, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
155
156 #define http_parse_params(s, f, ht) _http_parse_params_ex((s), (f), _http_parse_params_default_callback, (ht) TSRMLS_CC)
157 #define http_parse_params_ex(s, f, cb, a) _http_parse_params_ex((s), (f), (cb), (a) TSRMLS_CC)
158 PHP_HTTP_API STATUS _http_parse_params_ex(const char *params, int flags, http_parse_params_callback cb, void *cb_arg TSRMLS_DC);
159
160
161 #define http_sleep(s) _http_sleep(s)
162 static inline void _http_sleep(double s)
163 {
164 #define HTTP_DIFFSEC (0.001)
165 #define HTTP_MLLISEC (1000)
166 #define HTTP_MCROSEC (1000 * 1000)
167 #define HTTP_NANOSEC (1000 * 1000 * 1000)
168 #define HTTP_MSEC(s) (s * HTTP_MLLISEC)
169 #define HTTP_USEC(s) (s * HTTP_MCROSEC)
170 #define HTTP_NSEC(s) (s * HTTP_NANOSEC)
171
172 #if defined(PHP_WIN32)
173 Sleep((DWORD) HTTP_MSEC(s));
174 #elif defined(HAVE_USLEEP)
175 usleep(HTTP_USEC(s));
176 #elif defined(HAVE_NANOSLEEP)
177 struct timespec req, rem;
178
179 req.tv_sec = (time_t) s;
180 req.tv_nsec = HTTP_NSEC(s) % HTTP_NANOSEC;
181
182 while (nanosleep(&req, &rem) && (errno == EINTR) && (HTTP_NSEC(rem.tv_sec) + rem.tv_nsec) > HTTP_NSEC(HTTP_DIFFSEC))) {
183 req.tv_sec = rem.tv_sec;
184 req.tv_nsec = rem.tv_nsec;
185 }
186 #else
187 struct timeval timeout;
188
189 timeout.tv.sec = (time_t) s;
190 timeout.tv_usec = HTTP_USEC(s) % HTTP_MCROSEC;
191
192 select(0, NULL, NULL, NULL, &timeout);
193 #endif
194 }
195
196 #define http_locate_str _http_locate_str
197 static inline const char *_http_locate_str(const char *h, size_t h_len, const char *n, size_t n_len)
198 {
199 const char *p, *e;
200
201 if (n_len && h_len) {
202 e = h + h_len;
203 do {
204 if (*h == *n) {
205 for (p = n; *p == h[p-n]; ++p) {
206 if (p == n+n_len-1) {
207 return h;
208 }
209 }
210 }
211 } while (h++ != e);
212 }
213
214 return NULL;
215 }
216
217 #define http_locate_body _http_locate_body
218 static inline const char *_http_locate_body(const char *message)
219 {
220 const char *body = NULL, *msg = message;
221
222 while (*msg) {
223 if (*msg == '\n') {
224 if (*(msg+1) == '\n') {
225 body = msg + 2;
226 break;
227 } else if (*(msg+1) == '\r' && *(msg+2) == '\n' && msg != message && *(msg-1) == '\r') {
228 body = msg + 3;
229 break;
230 }
231 }
232 ++msg;
233 }
234 return body;
235 }
236
237 #define http_locate_eol _http_locate_eol
238 static inline const char *_http_locate_eol(const char *line, int *eol_len)
239 {
240 const char *eol = strpbrk(line, "\r\n");
241
242 if (eol_len) {
243 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
244 }
245 return eol;
246 }
247
248 #define convert_to_type(t, z) _convert_to_type((t), (z))
249 static inline zval *_convert_to_type(int type, zval *z)
250 {
251 if (Z_TYPE_P(z) != type) {
252 switch (type) {
253 case IS_NULL: convert_to_null(z); break;
254 case IS_BOOL: convert_to_boolean(z); break;
255 case IS_LONG: convert_to_long(z); break;
256 case IS_DOUBLE: convert_to_double(z); break;
257 case IS_STRING: convert_to_string(z); break;
258 case IS_ARRAY: convert_to_array(z); break;
259 case IS_OBJECT: convert_to_object(z); break;
260 }
261 }
262 return z;
263 }
264 #define convert_to_type_ex(t, z, p) _convert_to_type_ex((t), (z), (p))
265 static inline zval *_convert_to_type_ex(int type, zval *z, zval **p)
266 {
267 *p = z;
268 if (Z_TYPE_P(z) != type) {
269 switch (type) {
270 case IS_NULL: convert_to_null_ex(&z); break;
271 case IS_BOOL: convert_to_boolean_ex(&z); break;
272 case IS_LONG: convert_to_long_ex(&z); break;
273 case IS_DOUBLE: convert_to_double_ex(&z); break;
274 case IS_STRING: convert_to_string_ex(&z); break;
275 case IS_ARRAY: convert_to_array_ex(&z); break;
276 case IS_OBJECT: convert_to_object_ex(&z); break;
277 }
278 }
279 if (*p == z) {
280 *p = NULL;
281 } else {
282 *p = z;
283 }
284 return z;
285 }
286
287 #define zval_copy(t, z) _zval_copy((t), (z) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC)
288 static inline zval *_zval_copy(int type, zval *z ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC)
289 {
290 zval *copy;
291
292 copy = emalloc_rel(sizeof(zval));
293 *copy = *z;
294 zval_copy_ctor(copy);
295 convert_to_type(type, copy);
296 copy->refcount = 0;
297 copy->is_ref = 0;
298
299 return copy;
300 }
301
302 #define zval_free(z) _zval_free(z)
303 static inline void _zval_free(zval **z)
304 {
305 zval_dtor(*z);
306 FREE_ZVAL(*z);
307 *z = NULL;
308 }
309
310 typedef struct _HashKey {
311 char *str;
312 uint len;
313 ulong num;
314 uint dup:1;
315 uint type:31;
316 } HashKey;
317 #define initHashKey(dup) {NULL, 0, 0, (dup), 0}
318
319 #define FOREACH_VAL(pos, array, val) FOREACH_HASH_VAL(pos, Z_ARRVAL_P(array), val)
320 #define FOREACH_HASH_VAL(pos, hash, val) \
321 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
322 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
323 zend_hash_move_forward_ex(hash, &pos))
324
325 #define FOREACH_KEY(pos, array, key) FOREACH_HASH_KEY(pos, Z_ARRVAL_P(array), key)
326 #define FOREACH_HASH_KEY(pos, hash, _key) \
327 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
328 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT; \
329 zend_hash_move_forward_ex(hash, &pos)) \
330
331 #define FOREACH_KEYVAL(pos, array, key, val) FOREACH_HASH_KEYVAL(pos, Z_ARRVAL_P(array), key, val)
332 #define FOREACH_HASH_KEYVAL(pos, hash, _key, val) \
333 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
334 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT && \
335 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
336 zend_hash_move_forward_ex(hash, &pos))
337
338 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
339 #define ARRAY_JOIN_STRONLY 1
340 #define ARRAY_JOIN_PRETTIFY 2
341 #define array_join(src, dst, append, flags) zend_hash_apply_with_arguments(src, (append)?apply_array_append_func:apply_array_merge_func, 2, dst, (int)flags)
342
343 extern int apply_array_append_func(void *pDest, int num_args, va_list args, zend_hash_key *hash_key);
344 extern int apply_array_merge_func(void *pDest, int num_args, va_list args, zend_hash_key *hash_key);
345
346 #endif
347
348 /*
349 * Local variables:
350 * tab-width: 4
351 * c-basic-offset: 4
352 * End:
353 * vim600: noet sw=4 ts=4 fdm=marker
354 * vim<600: noet sw=4 ts=4
355 */
356
Extended HTTP Support