2 +--------------------------------------------------------------------+
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 +--------------------------------------------------------------------+
13 /* $Id: php_http_api.h 298891 2010-05-03 08:26:38Z mike $ */
15 #ifndef PHP_HTTP_MISC_H
16 #define PHP_HTTP_MISC_H
20 /* DATE FORMAT RFC1123 */
21 #define PHP_HTTP_DATE_FORMAT "D, d M Y H:i:s \\G\\M\\T"
24 #define PHP_HTTP_CRLF "\r\n"
26 /* default cache control */
27 #define PHP_HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
30 #define PHP_HTTP_URL_MAXLEN 4096
32 /* max request method length */
33 #define PHP_HTTP_REQUEST_METHOD_MAXLEN 31
35 /* def URL arg separator */
36 #define PHP_HTTP_URL_ARGSEP "&"
38 /* send buffer size */
39 #define PHP_HTTP_SENDBUF_SIZE 40960
41 /* CURL buffer size */
42 #define PHP_HTTP_CURLBUF_SIZE 16384
46 #define PHP_HTTP_DIFFSEC (0.001)
47 #define PHP_HTTP_MLLISEC (1000)
48 #define PHP_HTTP_MCROSEC (1000 * 1000)
49 #define PHP_HTTP_NANOSEC (1000 * 1000 * 1000)
50 #define PHP_HTTP_MSEC(s) ((long)(s * PHP_HTTP_MLLISEC))
51 #define PHP_HTTP_USEC(s) ((long)(s * PHP_HTTP_MCROSEC))
52 #define PHP_HTTP_NSEC(s) ((long)(s * PHP_HTTP_NANOSEC))
54 PHP_HTTP_API
void php_http_sleep(double s
);
56 /* STRING UTILITIES */
58 #define PHP_HTTP_CHECK_CONTENT_TYPE(ct, action) \
59 if (!strchr((ct), '/')) { \
60 php_http_error(HE_WARNING, PHP_HTTP_E_INVALID_PARAM, \
61 "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
67 # define STR_SET(STR, SET) \
74 #define STR_PTR(s) (s?s:"")
76 #define lenof(S) (sizeof(S) - 1)
78 #define PHP_HTTP_MATCH_LOOSE 0
79 #define PHP_HTTP_MATCH_CASE 0x01
80 #define PHP_HTTP_MATCH_WORD 0x10
81 #define PHP_HTTP_MATCH_FULL 0x20
82 #define PHP_HTTP_MATCH_STRICT (PHP_HTTP_ENV_MATCH_CASE|PHP_HTTP_ENV_MATCH_FULL)
84 extern int php_http_match(const char *haystack
, const char *needle
, int flags
);
86 extern char *php_http_pretty_key(char *key
, size_t key_len
, zend_bool uctitle
, zend_bool xhyphen
);
87 extern size_t php_http_boundary(char *buf
, size_t len TSRMLS_DC
);
89 static inline const char *php_http_locate_str(const char *h
, size_t h_len
, const char *n
, size_t n_len
)
97 for (p
= n
; *p
== h
[p
-n
]; ++p
) {
109 static inline const char *php_http_locate_body(const char *message
)
111 const char *body
= NULL
, *msg
= message
;
115 if (*(msg
+1) == '\n') {
118 } else if (*(msg
+1) == '\r' && *(msg
+2) == '\n') {
128 static inline const char *php_http_locate_eol(const char *line
, int *eol_len
)
130 const char *eol
= strpbrk(line
, "\r\n");
133 *eol_len
= eol
? ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1) : 0;
138 static inline const char *php_http_locate_bin_eol(const char *bin
, size_t len
, int *eol_len
)
142 for (eol
= bin
; eol
- bin
< len
; ++eol
) {
143 if (*eol
== '\r' || *eol
== '\n') {
144 *eol_len
= eol
? ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1) : 0;
154 #define INIT_PZVAL_ARRAY(zv, ht) \
157 Z_TYPE_P(zv) = IS_ARRAY; \
158 Z_ARRVAL_P(zv) = (ht); \
161 static inline zval
*php_http_ztyp(int type
, zval
*z
)
163 SEPARATE_ARG_IF_REF(z
);
164 if (Z_TYPE_P(z
) != type
) {
166 case IS_NULL
: convert_to_null_ex(&z
); break;
167 case IS_BOOL
: convert_to_boolean_ex(&z
); break;
168 case IS_LONG
: convert_to_long_ex(&z
); break;
169 case IS_DOUBLE
: convert_to_double_ex(&z
); break;
170 case IS_STRING
: convert_to_string_ex(&z
); break;
171 case IS_ARRAY
: convert_to_array_ex(&z
); break;
172 case IS_OBJECT
: convert_to_object_ex(&z
); break;
178 static inline zval
*php_http_zsep(zend_bool add_ref
, int type
, zval
*z
) {
182 if (Z_TYPE_P(z
) != type
) {
184 case IS_NULL
: convert_to_null_ex(&z
); break;
185 case IS_BOOL
: convert_to_boolean_ex(&z
); break;
186 case IS_LONG
: convert_to_long_ex(&z
); break;
187 case IS_DOUBLE
: convert_to_double_ex(&z
); break;
188 case IS_STRING
: convert_to_string_ex(&z
); break;
189 case IS_ARRAY
: convert_to_array_ex(&z
); break;
190 case IS_OBJECT
: convert_to_object_ex(&z
); break;
193 SEPARATE_ZVAL_IF_NOT_REF(&z
);
199 /* return bool (v == SUCCESS) */
200 #define RETVAL_SUCCESS(v) RETVAL_BOOL(SUCCESS == (v))
201 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
202 /* return object(values) */
203 #define RETVAL_OBJECT(o, addref) \
204 RETVAL_OBJVAL((o)->value.obj, addref)
205 #define RETURN_OBJECT(o, addref) \
206 RETVAL_OBJECT(o, addref); \
208 #define RETVAL_OBJVAL(ov, addref) \
209 ZVAL_OBJVAL(return_value, ov, addref)
210 #define RETURN_OBJVAL(ov, addref) \
211 RETVAL_OBJVAL(ov, addref); \
213 #define ZVAL_OBJVAL(zv, ov, addref) \
214 (zv)->type = IS_OBJECT; \
215 (zv)->value.obj = (ov);\
216 if (addref && Z_OBJ_HT_P(zv)->add_ref) { \
217 Z_OBJ_HT_P(zv)->add_ref((zv) TSRMLS_CC); \
219 /* return property */
220 #define RETVAL_PROP(CE, n) RETVAL_PROP_EX(CE, getThis(), n)
221 #define RETURN_PROP(CE, n) RETURN_PROP_EX(CE, getThis(), n)
222 #define RETVAL_PROP_EX(CE, this, n) \
224 zval *__prop = zend_read_property(CE, this, ZEND_STRL(n), 0 TSRMLS_CC); \
225 RETVAL_ZVAL(__prop, 1, 0); \
227 #define RETURN_PROP_EX(CE, this, n) \
229 zval *__prop = zend_read_property(CE, this, ZEND_STRL(n), 0 TSRMLS_CC); \
230 RETURN_ZVAL(__prop, 1, 0); \
232 #define RETVAL_SPROP(CE, n) \
234 zval *__prop = zend_read_static_property(CE, ZEND_STRL(n), 0 TSRMLS_CC); \
235 RETVAL_ZVAL(__prop, 1, 0); \
237 #define RETURN_SPROP(CE, n) \
239 zval *__prop = zend_read_static_property(CE, ZEND_STRL(n), 0 TSRMLS_CC); \
240 RETURN_ZVAL(__prop, 1, 0); \
243 #define Z_OBJ_DELREF(z) \
244 if (Z_OBJ_HT(z)->del_ref) { \
245 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
247 #define Z_OBJ_ADDREF(z) \
248 if (Z_OBJ_HT(z)->add_ref) { \
249 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
251 #define Z_OBJ_DELREF_P(z) \
252 if (Z_OBJ_HT_P(z)->del_ref) { \
253 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
255 #define Z_OBJ_ADDREF_P(z) \
256 if (Z_OBJ_HT_P(z)->add_ref) { \
257 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
259 #define Z_OBJ_DELREF_PP(z) \
260 if (Z_OBJ_HT_PP(z)->del_ref) { \
261 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
263 #define Z_OBJ_ADDREF_PP(z) \
264 if (Z_OBJ_HT_PP(z)->add_ref) { \
265 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
268 #define PHP_HTTP_BEGIN_ARGS_EX(class, method, ret_ref, req_args) ZEND_BEGIN_ARG_INFO_EX(args_for_ ##class## _ ##method , 0, ret_ref, req_args)
269 #define PHP_HTTP_BEGIN_ARGS_AR(class, method, ret_ref, req_args) ZEND_BEGIN_ARG_INFO_EX(args_for_ ##class## _ ##method , 1, ret_ref, req_args)
270 #define PHP_HTTP_END_ARGS }
271 #define PHP_HTTP_EMPTY_ARGS_EX(class, method, ret_ref) PHP_HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) PHP_HTTP_END_ARGS
272 #define PHP_HTTP_ARGS(class, method) args_for_ ##class## _ ##method
273 #define PHP_HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
274 #define PHP_HTTP_ARG_OBJ(class, name, allow_null) ZEND_ARG_OBJ_INFO(0, name, class, allow_null)
276 #define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
278 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
279 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
280 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
281 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
284 #define PHP_HTTP_INI_ENTRY(entry, default, scope, updater, global) \
285 STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_php_http_globals, php_http_globals)
286 #define PHP_HTTP_INI_ENTRY_EX(entry, default, scope, updater, displayer, global) \
287 STD_PHP_INI_ENTRY_EX(entry, default, scope, updater, global, zend_php_http_globals, php_http_globals, displayer)
289 #define PHP_HTTP_REGISTER_CLASS(ns, classname, name, parent, flags) \
291 zend_class_entry ce; \
292 memset(&ce, 0, sizeof(zend_class_entry)); \
293 INIT_NS_CLASS_ENTRY(ce, #ns, #classname, php_ ##name## _method_entry); \
294 php_ ##name## _class_entry = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
295 php_ ##name## _class_entry->ce_flags |= flags; \
298 #define PHP_HTTP_REGISTER_INTERFACE(ns, ifacename, name, flags) \
300 zend_class_entry ce; \
301 memset(&ce, 0, sizeof(zend_class_entry)); \
302 INIT_NS_CLASS_ENTRY(ce, #ns, #ifacename, php_ ##name## _method_entry); \
303 php_ ##name## _class_entry = zend_register_internal_interface(&ce TSRMLS_CC); \
304 php_ ##name## _class_entry->ce_flags |= flags; \
307 #define PHP_HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
309 zend_class_entry ce; \
310 memset(&ce, 0, sizeof(zend_class_entry)); \
311 INIT_NS_CLASS_ENTRY(ce, "http", #classname, NULL); \
312 ce.create_object = NULL; \
313 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
316 #define ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
317 #define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
318 #define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
319 #define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
321 #ifdef PHP_HTTP_HAVE_CURL
322 # define PHP_HTTP_DECLARE_ARG_PASS_INFO() \
323 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
324 ZEND_ARG_PASS_INFO(0) \
325 ZEND_ARG_PASS_INFO(1) \
326 ZEND_END_ARG_INFO(); \
328 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
329 ZEND_ARG_PASS_INFO(0) \
330 ZEND_ARG_PASS_INFO(0) \
331 ZEND_ARG_PASS_INFO(1) \
332 ZEND_END_ARG_INFO(); \
334 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
335 ZEND_ARG_PASS_INFO(0) \
336 ZEND_ARG_PASS_INFO(0) \
337 ZEND_ARG_PASS_INFO(0) \
338 ZEND_ARG_PASS_INFO(1) \
339 ZEND_END_ARG_INFO(); \
341 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
342 ZEND_ARG_PASS_INFO(0) \
343 ZEND_ARG_PASS_INFO(0) \
344 ZEND_ARG_PASS_INFO(0) \
345 ZEND_ARG_PASS_INFO(0) \
346 ZEND_ARG_PASS_INFO(1) \
350 # define PHP_HTTP_DECLARE_ARG_PASS_INFO() \
351 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
352 ZEND_ARG_PASS_INFO(0) \
353 ZEND_ARG_PASS_INFO(1) \
354 ZEND_END_ARG_INFO(); \
356 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
357 ZEND_ARG_PASS_INFO(0) \
358 ZEND_ARG_PASS_INFO(0) \
359 ZEND_ARG_PASS_INFO(1) \
360 ZEND_END_ARG_INFO(); \
362 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
363 ZEND_ARG_PASS_INFO(0) \
364 ZEND_ARG_PASS_INFO(0) \
365 ZEND_ARG_PASS_INFO(0) \
366 ZEND_ARG_PASS_INFO(1) \
368 #endif /* PHP_HTTP_HAVE_CURL */
372 typedef struct php_http_array_hashkey
{
378 } php_http_array_hashkey_t
;
379 #define php_http_array_hashkey_init(dup) {NULL, 0, 0, (dup), 0}
381 #define FOREACH_VAL(pos, array, val) FOREACH_HASH_VAL(pos, HASH_OF(array), val)
382 #define FOREACH_HASH_VAL(pos, hash, val) \
383 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
384 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
385 zend_hash_move_forward_ex(hash, &pos))
387 #define FOREACH_KEY(pos, array, key) FOREACH_HASH_KEY(pos, HASH_OF(array), key)
388 #define FOREACH_HASH_KEY(pos, hash, _key) \
389 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
390 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT; \
391 zend_hash_move_forward_ex(hash, &pos)) \
393 #define FOREACH_KEYVAL(pos, array, key, val) FOREACH_HASH_KEYVAL(pos, HASH_OF(array), key, val)
394 #define FOREACH_HASH_KEYVAL(pos, hash, _key, val) \
395 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
396 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT && \
397 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
398 zend_hash_move_forward_ex(hash, &pos))
400 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
401 #define ARRAY_JOIN_STRONLY 1
402 #define ARRAY_JOIN_PRETTIFY 2
403 #define array_join(src, dst, append, flags) zend_hash_apply_with_arguments(src TSRMLS_CC, (append)?php_http_array_apply_append_func:php_http_array_apply_merge_func, 2, dst, (int)flags)
405 extern int php_http_array_apply_append_func(void *pDest TSRMLS_DC
, int num_args
, va_list args
, zend_hash_key
*hash_key
);
406 extern int php_http_array_apply_merge_func(void *pDest TSRMLS_DC
, int num_args
, va_list args
, zend_hash_key
*hash_key
);
410 typedef size_t (*php_http_pass_callback_t
)(void *cb_arg
, const char *str
, size_t len
);
411 typedef size_t (*php_http_pass_php_http_buffer_callback_t
)(void *cb_arg
, php_http_buffer_t
*str
);
413 typedef struct php_http_pass_callback_arg
{
414 size_t (*cb_zts
)(void *cb_arg
, const char *str
, size_t len TSRMLS_DC
);
416 } php_http_pass_callback_arg_t
;
418 PHP_HTTP_API
size_t php_http_pass_wrapper(php_http_pass_callback_arg_t
*cb_arg
, const char *str
, size_t len
);
422 extern void php_http_error(long type TSRMLS_DC
, long code
, const char *format
, ...);
424 #define with_error_handling(eh, ec) \
426 zend_error_handling __eh; \
427 zend_replace_error_handling((eh), (ec), &__eh TSRMLS_CC);
429 #define end_error_handling() \
430 zend_restore_error_handling(&__eh TSRMLS_CC); \
436 #define HE_THROW E_THROW TSRMLS_CC
437 #define HE_NOTICE E_NOTICE TSRMLS_CC
438 #define HE_WARNING E_WARNING TSRMLS_CC
439 #define HE_ERROR E_ERROR TSRMLS_CC
441 typedef enum php_http_error
{
442 PHP_HTTP_E_UNKNOWN
= 0,
444 PHP_HTTP_E_INVALID_PARAM
,
446 PHP_HTTP_E_MALFORMED_HEADERS
,
447 PHP_HTTP_E_REQUEST_METHOD
,
449 PHP_HTTP_E_MESSAGE_TYPE
,
450 PHP_HTTP_E_MESSAGE_BODY
,
453 PHP_HTTP_E_REQUEST_POOL
,
454 PHP_HTTP_E_REQUEST_DATASHARE
,
455 PHP_HTTP_E_REQUEST_FACTORY
,
459 PHP_HTTP_E_QUERYSTRING
,
469 * vim600: noet sw=4 ts=4 fdm=marker
470 * vim<600: noet sw=4 ts=4