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-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #ifndef PHP_HTTP_STD_DEFS_H
16 #define PHP_HTTP_STD_DEFS_H
18 #if defined(PHP_WIN32)
19 # if defined(HTTP_EXPORTS)
20 # define PHP_HTTP_API __declspec(dllexport)
21 # elif defined(COMPILE_DL_HTTP)
22 # define PHP_HTTP_API __declspec(dllimport)
30 /* make functions that return SUCCESS|FAILURE more obvious */
34 #define lenof(S) (sizeof(S) - 1)
37 # define MIN(a,b) (a<b?a:b)
40 # define MAX(a,b) (a>b?a:b)
45 # define STR_SET(STR, SET) \
52 #define INIT_ZARR(zv, ht) \
55 Z_TYPE(zv) = IS_ARRAY; \
56 Z_ARRVAL(zv) = (ht); \
59 /* return bool (v == SUCCESS) */
60 #define RETVAL_SUCCESS(v) RETVAL_BOOL(SUCCESS == (v))
61 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
62 /* return object(values) */
63 #define RETVAL_OBJECT(o) \
64 RETVAL_OBJVAL((o)->value.obj)
65 #define RETURN_OBJECT(o) \
68 #define RETVAL_OBJVAL(ov) \
69 ZVAL_OBJVAL(return_value, ov)
70 #define RETURN_OBJVAL(ov) \
73 #define ZVAL_OBJVAL(zv, ov) \
75 (zv)->type = IS_OBJECT; \
76 (zv)->value.obj = (ov); \
77 if (Z_OBJ_HT_P(zv)->add_ref) { \
78 Z_OBJ_HT_P(zv)->add_ref((zv) TSRMLS_CC); \
81 /* function accepts no args */
83 if (ZEND_NUM_ARGS()) { \
84 zend_error(E_NOTICE, "Wrong parameter count for %s()", get_active_function_name(TSRMLS_C)); \
87 /* check if return value is used */
88 #define IF_RETVAL_USED \
89 if (!return_value_used) { \
94 #define HTTP_CRLF "\r\n"
96 /* default cache control */
97 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
100 #define HTTP_URL_MAXLEN 2048
101 #define HTTP_URI_MAXLEN HTTP_URL_MAXLEN
103 /* def URL arg separator */
104 #define HTTP_URL_ARGSEP "&"
105 #define HTTP_URI_ARGSEP HTTP_URL_ARGSEP
107 /* send buffer size */
108 #define HTTP_SENDBUF_SIZE 40960
110 /* CURL buffer size */
111 #define HTTP_CURLBUF_SIZE 16384
114 #define HTTP_KNOWN_METHODS \
116 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
117 /* WebDAV - RFC 2518 */ \
118 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
119 /* WebDAV Versioning - RFC 3253 */ \
120 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
121 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
122 /* WebDAV Access Control - RFC 3744 */ \
127 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
128 STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
129 #define HTTP_PHP_INI_ENTRY_EX(entry, default, scope, updater, displayer, global) \
130 STD_PHP_INI_ENTRY_EX(entry, default, scope, updater, global, zend_http_globals, http_globals, displayer)
133 #define FOREACH_VAL(array, val) FOREACH_HASH_VAL(Z_ARRVAL_P(array), val)
134 #define FOREACH_HASH_VAL(hash, val) \
135 for ( zend_hash_internal_pointer_reset(hash); \
136 zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
137 zend_hash_move_forward(hash))
139 #define FOREACH_KEY(array, strkey, numkey) FOREACH_HASH_KEY(Z_ARRVAL_P(array), strkey, numkey)
140 #define FOREACH_HASH_KEY(hash, strkey, numkey) \
141 for ( zend_hash_internal_pointer_reset(hash); \
142 zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT; \
143 zend_hash_move_forward(hash)) \
145 #define FOREACH_KEYVAL(array, strkey, numkey, val) FOREACH_HASH_KEYVAL(Z_ARRVAL_P(array), strkey, numkey, val)
146 #define FOREACH_HASH_KEYVAL(hash, strkey, numkey, val) \
147 for ( zend_hash_internal_pointer_reset(hash); \
148 zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT && \
149 zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
150 zend_hash_move_forward(hash)) \
152 #define array_copy(src, dst) zend_hash_copy(Z_ARRVAL_P(dst), Z_ARRVAL_P(src), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
153 #define array_merge(src, dst) zend_hash_merge(Z_ARRVAL_P(dst), Z_ARRVAL_P(src), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *), 1)
154 #define array_append(src, dst) \
161 for ( zend_hash_internal_pointer_reset(Z_ARRVAL_P(src)); \
162 zend_hash_get_current_key_ex(Z_ARRVAL_P(src), &key, &klen, &idx, 0, NULL) != HASH_KEY_NON_EXISTANT && \
163 zend_hash_get_current_data(Z_ARRVAL_P(src), (void **) &data) == SUCCESS; \
164 zend_hash_move_forward(Z_ARRVAL_P(src))) \
169 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(dst), key, klen, (void **) &tmp)) { \
170 if (Z_TYPE_PP(tmp) != IS_ARRAY) { \
171 convert_to_array_ex(tmp); \
173 add_next_index_zval(*tmp, *data); \
175 add_assoc_zval(dst, key, *data); \
177 ZVAL_ADDREF(*data); \
184 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
186 /* {{{ objects & properties */
189 # define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
191 # define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
193 zend_class_entry ce; \
194 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
195 ce.create_object = _ ##name## _new; \
196 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
197 name## _ce->ce_flags |= flags; \
198 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
199 zend_hash_init(& name## _ce->constants_table, 0, NULL, ZVAL_INTERNAL_PTR_DTOR, 1); \
200 name## _declare_default_properties(); \
203 # define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
205 zend_class_entry ce; \
206 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
207 ce.create_object = NULL; \
208 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
209 name## _ce->ce_flags |= flags; \
212 # define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
214 zend_class_entry ce; \
215 INIT_CLASS_ENTRY(ce, #classname, NULL); \
216 ce.create_object = NULL; \
217 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
220 # define getObject(t, o) getObjectEx(t, o, getThis())
221 # define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
222 # define putObject(t, o) zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, (zend_objects_free_object_storage_t) _ ##t## _free, NULL TSRMLS_CC);
223 # define OBJ_PROP(o) (o)->zo.properties
225 # define DCL_STATIC_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
226 # define DCL_STATIC_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
227 # define DCL_STATIC_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
228 # define GET_STATIC_PROP_EX(ce, n) zend_std_get_static_property(ce, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
229 # define UPD_STATIC_PROP_EX(ce, t, n, v) zend_update_static_property_ ##t(ce, #n, sizeof(#n)-1, (v) TSRMLS_CC)
230 # define UPD_STATIC_STRL_EX(ce, n, v, l) zend_update_static_property_stringl(ce, #n, sizeof(#n)-1, (v), (l) TSRMLS_CC)
231 # define SET_STATIC_PROP_EX(ce, n, v) zend_update_static_property(ce, #n, sizeof(#n)-1, v TSRMLS_CC)
233 # define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
234 # define DCL_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
235 # define DCL_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a) TSRMLS_CC)
236 # define UPD_PROP(o, t, n, v) UPD_PROP_EX(o, getThis(), t, n, v)
237 # define UPD_PROP_EX(o, this, t, n, v) zend_update_property_ ##t(o->zo.ce, this, (#n), sizeof(#n)-1, (v) TSRMLS_CC)
238 # define UPD_STRL(o, n, v, l) zend_update_property_stringl(o->zo.ce, getThis(), (#n), sizeof(#n)-1, (v), (l) TSRMLS_CC)
239 # define SET_PROP(o, n, z) SET_PROP_EX(o, getThis(), n, z)
240 # define SET_PROP_EX(o, this, n, z) zend_update_property(o->zo.ce, this, (#n), sizeof(#n)-1, (z) TSRMLS_CC)
241 # define GET_PROP(o, n) GET_PROP_EX(o, getThis(), n)
242 # define GET_PROP_EX(o, this, n) zend_read_property(o->zo.ce, this, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
244 # define DCL_CONST(t, n, v) zend_declare_class_constant_ ##t(ce, (n), sizeof(n)-1, (v) TSRMLS_CC)
246 # define ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
247 # define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
248 # define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
249 # define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
251 # define INIT_PARR(o, n) \
254 MAKE_STD_ZVAL(__tmp); \
256 SET_PROP(o, n, __tmp); \
259 # define FREE_PARR(o, p) \
261 zval *__tmp = GET_PROP(o, p); \
263 zval_ptr_dtor(&__tmp); \
268 * the property *MUST* be updated after SEP_PROP()
270 # define SEP_PROP(zpp) \
273 SEPARATE_ZVAL_IF_NOT_REF(zpp); \
279 # define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
280 # define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
281 # define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
282 # define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
284 #endif /* ZEND_ENGINE_2 */
291 # define HE_THROW E_THROW TSRMLS_CC
292 # define HE_NOTICE (HTTP_G(only_exceptions) ? E_THROW : E_NOTICE) TSRMLS_CC
293 # define HE_WARNING (HTTP_G(only_exceptions) ? E_THROW : E_WARNING) TSRMLS_CC
294 # define HE_ERROR (HTTP_G(only_exceptions) ? E_THROW : E_ERROR) TSRMLS_CC
296 # define HE_THROW E_WARNING TSRMLS_CC
297 # define HE_NOTICE E_NOTICE TSRMLS_CC
298 # define HE_WARNING E_WARNING TSRMLS_CC
299 # define HE_ERROR E_ERROR TSRMLS_CC
302 #define HTTP_E_RUNTIME 1L
303 #define HTTP_E_INVALID_PARAM 2L
304 #define HTTP_E_HEADER 3L
305 #define HTTP_E_MALFORMED_HEADERS 4L
306 #define HTTP_E_REQUEST_METHOD 5L
307 #define HTTP_E_MESSAGE_TYPE 6L
308 #define HTTP_E_ENCODING 7L
309 #define HTTP_E_REQUEST 8L
310 #define HTTP_E_REQUEST_POOL 9L
311 #define HTTP_E_SOCKET 10L
312 #define HTTP_E_RESPONSE 11L
313 #define HTTP_E_URL 12L
316 # define HTTP_BEGIN_ARGS_EX(class, method, ret_ref, req_args) static ZEND_BEGIN_ARG_INFO_EX(args_for_ ##class## _ ##method , 0, ret_ref, req_args)
317 # define HTTP_BEGIN_ARGS_AR(class, method, ret_ref, req_args) static ZEND_BEGIN_ARG_INFO_EX(args_for_ ##class## _ ##method , 1, ret_ref, req_args)
318 # define HTTP_END_ARGS }
319 # define HTTP_EMPTY_ARGS_EX(class, method, ret_ref) HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
320 # define HTTP_ARGS(class, method) args_for_ ##class## _ ##method
321 # define HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
322 # define HTTP_ARG_OBJ(class, name, allow_null) ZEND_ARG_OBJ_INFO(0, name, class, allow_null)
326 # define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
328 # define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL}
331 #ifdef HTTP_HAVE_CURL
332 # ifdef ZEND_ENGINE_2
333 # define HTTP_DECLARE_ARG_PASS_INFO() \
335 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
336 ZEND_ARG_PASS_INFO(0) \
337 ZEND_ARG_PASS_INFO(1) \
338 ZEND_END_ARG_INFO(); \
341 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
342 ZEND_ARG_PASS_INFO(0) \
343 ZEND_ARG_PASS_INFO(0) \
344 ZEND_ARG_PASS_INFO(1) \
345 ZEND_END_ARG_INFO(); \
348 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
349 ZEND_ARG_PASS_INFO(0) \
350 ZEND_ARG_PASS_INFO(0) \
351 ZEND_ARG_PASS_INFO(0) \
352 ZEND_ARG_PASS_INFO(1) \
353 ZEND_END_ARG_INFO(); \
356 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
357 ZEND_ARG_PASS_INFO(0) \
358 ZEND_ARG_PASS_INFO(0) \
359 ZEND_ARG_PASS_INFO(0) \
360 ZEND_ARG_PASS_INFO(0) \
361 ZEND_ARG_PASS_INFO(1) \
365 # define HTTP_DECLARE_ARG_PASS_INFO() \
366 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
367 static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
368 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
369 static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
370 # endif /* ZEND_ENGINE_2 */
372 # ifdef ZEND_ENGINE_2
373 # define HTTP_DECLARE_ARG_PASS_INFO() \
375 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
376 ZEND_ARG_PASS_INFO(0) \
377 ZEND_ARG_PASS_INFO(1) \
380 # define HTTP_DECLARE_ARG_PASS_INFO() \
381 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE};
382 # endif /* ZEND_ENGINE_2 */
383 #endif /* HTTP_HAVE_CURL */
386 #ifndef TSRMLS_FETCH_FROM_CTX
388 # define TSRMLS_FETCH_FROM_CTX(ctx) void ***tsrm_ls = (void ***) ctx
390 # define TSRMLS_FETCH_FROM_CTX(ctx)
394 #ifndef TSRMLS_SET_CTX
396 # define TSRMLS_SET_CTX(ctx) ctx = (void ***) tsrm_ls
398 # define TSRMLS_SET_CTX(ctx)
403 #define ZVAL_ZVAL(z, zv, copy, dtor) { \
404 int is_ref, refcount; \
405 is_ref = (z)->is_ref; \
406 refcount = (z)->refcount; \
415 zval_ptr_dtor(&zv); \
417 (z)->is_ref = is_ref; \
418 (z)->refcount = refcount; \
422 #define RETVAL_ZVAL(zv, copy, dtor) ZVAL_ZVAL(return_value, zv, copy, dtor)
425 #define RETURN_ZVAL(zv, copy, dtor) { RETVAL_ZVAL(zv, copy, dtor); return; }
428 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
429 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
430 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
431 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
433 #define Z_OBJ_DELREF(z) \
434 if (Z_OBJ_HT(z)->del_ref) { \
435 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
437 #define Z_OBJ_ADDREF(z) \
438 if (Z_OBJ_HT(z)->add_ref) { \
439 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
441 #define Z_OBJ_DELREF_P(z) \
442 if (Z_OBJ_HT_P(z)->del_ref) { \
443 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
445 #define Z_OBJ_ADDREF_P(z) \
446 if (Z_OBJ_HT_P(z)->add_ref) { \
447 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
449 #define Z_OBJ_DELREF_PP(z) \
450 if (Z_OBJ_HT_PP(z)->del_ref) { \
451 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
453 #define Z_OBJ_ADDREF_PP(z) \
454 if (Z_OBJ_HT_PP(z)->add_ref) { \
455 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
458 #endif /* PHP_HTTP_STD_DEFS_H */
465 * vim600: noet sw=4 ts=4 fdm=marker
466 * vim<600: noet sw=4 ts=4