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