2 +----------------------------------------------------------------------+
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
18 #ifndef PHP_HTTP_STD_DEFS_H
19 #define PHP_HTTP_STD_DEFS_H
21 #if defined(PHP_WIN32)
22 # if defined(HTTP_EXPORTS)
23 # define PHP_HTTP_API __declspec(dllexport)
24 # elif defined(COMPILE_DL_HTTP)
25 # define PHP_HTTP_API __declspec(dllimport)
33 /* make functions that return SUCCESS|FAILURE more obvious */
37 #define lenof(S) (sizeof(S) - 1)
40 #define STR_SET(target, source) \
41 if(target) efree(target); \
44 /* return bool (v == SUCCESS) */
45 #define RETVAL_SUCCESS(v) RETVAL_BOOL(SUCCESS == (v))
46 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
47 /* return object(values) */
48 #define RETVAL_OBJECT(o) \
49 RETVAL_OBJVAL((o)->value.obj)
50 #define RETURN_OBJECT(o) \
53 #define RETVAL_OBJVAL(ov) \
54 return_value->is_ref = 1; \
55 return_value->type = IS_OBJECT; \
56 return_value->value.obj = (ov); \
57 zval_add_ref(&return_value); \
58 zend_objects_store_add_ref(return_value TSRMLS_CC)
59 #define RETURN_OBJVAL(ov) \
63 /* function accepts no args */
65 if (ZEND_NUM_ARGS()) { \
66 zend_error(E_NOTICE, "Wrong parameter count for %s()", get_active_function_name(TSRMLS_C)); \
69 /* check if return value is used */
70 #define IF_RETVAL_USED \
71 if (!return_value_used) { \
76 #define HTTP_CRLF "\r\n"
78 /* default cache control */
79 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
82 #define HTTP_URL_MAXLEN 2048
83 #define HTTP_URI_MAXLEN HTTP_URL_MAXLEN
85 /* def URL arg separator */
86 #define HTTP_URL_ARGSEP "&"
87 #define HTTP_URI_ARGSEP HTTP_URL_ARGSEP
89 /* send buffer size */
90 #define HTTP_SENDBUF_SIZE 2097152
92 /* CURL buffer size */
93 #define HTTP_CURLBUF_SIZE 16384
96 #define HTTP_KNOWN_METHODS \
98 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
99 /* WebDAV - RFC 2518 */ \
100 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
101 /* WebDAV Versioning - RFC 3253 */ \
102 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
103 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
104 /* WebDAV Access Control - RFC 3744 */ \
109 /* server vars shorthand */
110 #define HTTP_SERVER_VARS Z_ARRVAL_P(PG(http_globals)[TRACK_VARS_SERVER])
112 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
113 STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
116 #define FOREACH_VAL(array, val) FOREACH_HASH_VAL(Z_ARRVAL_P(array), val)
117 #define FOREACH_HASH_VAL(hash, val) \
118 for ( zend_hash_internal_pointer_reset(hash); \
119 zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
120 zend_hash_move_forward(hash))
122 #define FOREACH_KEY(array, strkey, numkey) FOREACH_HASH_KEY(Z_ARRVAL_P(array), strkey, numkey)
123 #define FOREACH_HASH_KEY(hash, strkey, numkey) \
124 for ( zend_hash_internal_pointer_reset(hash); \
125 zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT; \
126 zend_hash_move_forward(hash)) \
128 #define FOREACH_KEYVAL(array, strkey, numkey, val) FOREACH_HASH_KEYVAL(Z_ARRVAL_P(array), strkey, numkey, val)
129 #define FOREACH_HASH_KEYVAL(hash, strkey, numkey, val) \
130 for ( zend_hash_internal_pointer_reset(hash); \
131 zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT && \
132 zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
133 zend_hash_move_forward(hash)) \
135 #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 *))
136 #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)
137 #define array_append(src, dst) \
144 for ( zend_hash_internal_pointer_reset(Z_ARRVAL_P(src)); \
145 zend_hash_get_current_key_ex(Z_ARRVAL_P(src), &key, &klen, &idx, 0, NULL) != HASH_KEY_NON_EXISTANT && \
146 zend_hash_get_current_data(Z_ARRVAL_P(src), (void **) &data) == SUCCESS; \
147 zend_hash_move_forward(Z_ARRVAL_P(src))) \
152 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(dst), key, klen, (void **) &tmp)) { \
153 if (Z_TYPE_PP(tmp) != IS_ARRAY) { \
154 convert_to_array_ex(tmp); \
156 add_next_index_zval(*tmp, *data); \
158 add_assoc_zval(dst, key, *data); \
160 zval_add_ref(data); \
167 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
169 /* {{{ objects & properties */
172 # define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
174 # define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
176 zend_class_entry ce; \
177 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
178 ce.create_object = name## _new; \
179 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
180 name## _ce->ce_flags |= flags; \
181 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
182 name## _declare_default_properties(); \
185 # define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
187 zend_class_entry ce; \
188 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
189 ce.create_object = NULL; \
190 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
191 name## _ce->ce_flags |= flags; \
194 # define getObject(t, o) getObjectEx(t, o, getThis())
195 # define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
196 # 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);
197 # define OBJ_PROP(o) (o)->zo.properties
198 # define DCL_STATIC_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
199 # define DCL_STATIC_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
200 # define DCL_STATIC_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
201 # define GET_STATIC_PROP_EX(ce, n) zend_std_get_static_property(ce, (#n), sizeof(#n), 0 TSRMLS_CC)
202 #ifdef zend_update_class_constants
203 # define USE_STATIC_PROP_EX(ce) zend_update_class_constants(ce TSRMLS_CC)
205 # define USE_STATIC_PROP_EX(ce)
207 # define SET_STATIC_PROP_EX(ce, n, v) \
211 zval **__static = GET_STATIC_PROP_EX(ce, n); \
213 refcount = (*__static)->refcount; \
214 is_ref = (*__static)->is_ref; \
215 switch (Z_TYPE_PP(__static)) \
217 case IS_BOOL: case IS_LONG: case IS_NULL: \
220 zend_list_delete(Z_LVAL_PP(__static)); \
222 case IS_STRING: case IS_CONSTANT: \
223 free(Z_STRVAL_PP(__static)); \
226 Z_OBJ_HT_PP(__static)->del_ref(*__static TSRMLS_CC); \
228 case IS_ARRAY: case IS_CONSTANT_ARRAY: \
229 if (Z_ARRVAL_PP(__static) && Z_ARRVAL_PP(__static) != &EG(symbol_table)) { \
230 zend_hash_destroy(Z_ARRVAL_PP(__static)); \
231 free(Z_ARRVAL_PP(__static)); \
236 switch (Z_TYPE_PP(__static)) \
238 case IS_BOOL: case IS_LONG: case IS_NULL: \
241 zend_list_addref(Z_LVAL_PP(__static)); \
243 case IS_STRING: case IS_CONSTANT: \
244 Z_STRVAL_PP(__static) = (char *) zend_strndup(Z_STRVAL_PP(__static), Z_STRLEN_PP(__static)); \
248 Z_OBJ_HT_PP(__static)->add_ref(*__static TSRMLS_CC); \
251 case IS_ARRAY: case IS_CONSTANT_ARRAY: \
253 if (Z_ARRVAL_PP(__static) != &EG(symbol_table)) { \
255 HashTable *old = Z_ARRVAL_PP(__static); \
256 Z_ARRVAL_PP(__static) = (HashTable *) malloc(sizeof(HashTable)); \
257 zend_hash_init(Z_ARRVAL_PP(__static), 0, NULL, ZVAL_PTR_DTOR, 0); \
258 zend_hash_copy(Z_ARRVAL_PP(__static), old, (copy_ctor_func_t) zval_add_ref, (void *) &tmp, sizeof(zval *)); \
263 (*__static)->refcount = refcount; \
264 (*__static)->is_ref = is_ref; \
266 #define SET_STATIC_PROP_STRING_EX(ce, n, s, d) \
269 MAKE_STD_ZVAL(__tmp); \
270 ZVAL_STRING(__tmp, (s), (d)); \
271 SET_STATIC_PROP_EX(ce, n, __tmp); \
275 #define SET_STATIC_PROP_STRINGL_EX(ce, n, s, l, d) \
278 MAKE_STD_ZVAL(__tmp); \
279 ZVAL_STRINGL(__tmp, (s), (l), (d)); \
280 SET_STATIC_PROP_EX(ce, n, __tmp); \
284 # define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a) TSRMLS_CC)
285 # define DCL_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a) TSRMLS_CC)
286 # define DCL_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n), (ZEND_ACC_ ##a) TSRMLS_CC)
287 # define UPD_PROP(o, t, n, v) UPD_PROP_EX(o, getThis(), t, n, v)
288 # define UPD_PROP_EX(o, this, t, n, v) zend_update_property_ ##t(o->zo.ce, this, (#n), sizeof(#n), (v) TSRMLS_CC)
289 # define SET_PROP(o, n, z) SET_PROP_EX(o, getThis(), n, z)
290 # define SET_PROP_EX(o, this, n, z) zend_update_property(o->zo.ce, this, (#n), sizeof(#n), (z) TSRMLS_CC)
291 # define GET_PROP(o, n) GET_PROP_EX(o, getThis(), n)
292 # define GET_PROP_EX(o, this, n) zend_read_property(o->zo.ce, this, (#n), sizeof(#n), 0 TSRMLS_CC)
294 # define ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
295 # define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
296 # define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
297 # define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
299 # define INIT_PARR(o, n) \
302 MAKE_STD_ZVAL(__tmp); \
304 SET_PROP(o, n, __tmp); \
307 # define FREE_PARR(o, p) \
309 zval *__tmp = NULL; \
310 if (__tmp = GET_PROP(o, p)) { \
317 # define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
318 # define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
319 # define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
320 # define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
322 #endif /* ZEND_ENGINE_2 */
329 #define HTTP_E_UNKOWN 0L
330 #define HTTP_E_PARSE 1L
331 #define HTTP_E_HEADER 2L
332 #define HTTP_E_OBUFFER 3L
333 #define HTTP_E_CURL 4L
334 #define HTTP_E_ENCODE 5L
335 #define HTTP_E_PARAM 6L
336 #define HTTP_E_URL 7L
337 #define HTTP_E_MSG 8L
340 # 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)
341 # 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)
342 # define HTTP_END_ARGS }
343 # define HTTP_EMPTY_ARGS_EX(class, method, ret_ref) HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
344 # define HTTP_ARGS(class, method) args_for_ ##class## _ ##method
345 # define HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
346 # define HTTP_ARG_OBJ(class, name, allow_null) ZEND_ARG_OBJ_INFO(1, name, class, allow_null)
349 #ifdef HTTP_HAVE_CURL
350 # ifdef ZEND_ENGINE_2
351 # define HTTP_DECLARE_ARG_PASS_INFO() \
353 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
354 ZEND_ARG_PASS_INFO(0) \
355 ZEND_ARG_PASS_INFO(0) \
356 ZEND_ARG_PASS_INFO(1) \
357 ZEND_END_ARG_INFO(); \
360 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
361 ZEND_ARG_PASS_INFO(0) \
362 ZEND_ARG_PASS_INFO(0) \
363 ZEND_ARG_PASS_INFO(0) \
364 ZEND_ARG_PASS_INFO(1) \
365 ZEND_END_ARG_INFO(); \
368 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
369 ZEND_ARG_PASS_INFO(0) \
370 ZEND_ARG_PASS_INFO(0) \
371 ZEND_ARG_PASS_INFO(0) \
372 ZEND_ARG_PASS_INFO(0) \
373 ZEND_ARG_PASS_INFO(1) \
374 ZEND_END_ARG_INFO(); \
377 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_all, 1) \
378 ZEND_ARG_PASS_INFO(1) \
381 # define HTTP_DECLARE_ARG_PASS_INFO() \
382 static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
383 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
384 static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
385 static unsigned char http_arg_pass_ref_all[]={1, BYREF_FORCE_REST}
386 # endif /* ZEND_ENGINE_2 */
388 # define HTTP_DECLARE_ARG_PASS_INFO()
389 #endif /* HTTP_HAVE_CURL */
392 #ifndef TSRMLS_FETCH_FROM_CTX
394 # define TSRMLS_FETCH_FROM_CTX(ctx) void ***tsrm_ls = (void ***) ctx
396 # define TSRMLS_FETCH_FROM_CTX(ctx)
400 #ifndef TSRMLS_SET_CTX
402 # define TSRMLS_SET_CTX(ctx) (void ***) ctx = tsrm_ls
404 # define TSRMLS_SET_CTX(ctx)
410 #endif /* PHP_HTTP_STD_DEFS_H */
417 * vim600: noet sw=4 ts=4 fdm=marker
418 * vim<600: noet sw=4 ts=4