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