0a80180d210dde01166ff35ae1ca03af3933354b
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-2006, 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 STR_PTR(s) (s?s:"")
54 #define INIT_ZARR(zv, ht) \
57 Z_TYPE(zv) = IS_ARRAY; \
58 Z_ARRVAL(zv) = (ht); \
61 /* return bool (v == SUCCESS) */
62 #define RETVAL_SUCCESS(v) RETVAL_BOOL(SUCCESS == (v))
63 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
64 /* return object(values) */
65 #define RETVAL_OBJECT(o, addref) \
66 RETVAL_OBJVAL((o)->value.obj, addref)
67 #define RETURN_OBJECT(o, addref) \
68 RETVAL_OBJECT(o, addref); \
70 #define RETVAL_OBJVAL(ov, addref) \
71 ZVAL_OBJVAL(return_value, ov, addref)
72 #define RETURN_OBJVAL(ov, addref) \
73 RETVAL_OBJVAL(ov, addref); \
75 #define ZVAL_OBJVAL(zv, ov, addref) \
76 (zv)->type = IS_OBJECT; \
77 (zv)->value.obj = (ov);\
78 if (addref && Z_OBJ_HT_P(zv)->add_ref) { \
79 Z_OBJ_HT_P(zv)->add_ref((zv) TSRMLS_CC); \
82 #define RETVAL_PROP(n) RETVAL_PROP_EX(getThis(), n)
83 #define RETURN_PROP(n) RETURN_PROP_EX(getThis(), n)
84 #define RETVAL_PROP_EX(this, n) \
86 zval *__prop = GET_PROP_EX(this, n); \
87 RETVAL_ZVAL(__prop, 1, 0); \
89 #define RETURN_PROP_EX(this, n) \
91 zval *__prop = GET_PROP_EX(this, n); \
92 RETURN_ZVAL(__prop, 1, 0); \
95 /* function accepts no args */
97 if (ZEND_NUM_ARGS()) { \
98 zend_error(E_NOTICE, "Wrong parameter count for %s()", get_active_function_name(TSRMLS_C)); \
102 #define HTTP_CRLF "\r\n"
104 /* default cache control */
105 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
108 #define HTTP_URL_MAXLEN 4096
110 /* def URL arg separator */
111 #define HTTP_URL_ARGSEP "&"
113 /* send buffer size */
114 #define HTTP_SENDBUF_SIZE 8000 /*40960*/
116 /* CURL buffer size */
117 #define HTTP_CURLBUF_SIZE 16384
120 #define HTTP_KNOWN_METHODS \
122 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
123 /* WebDAV - RFC 2518 */ \
124 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
125 /* WebDAV Versioning - RFC 3253 */ \
126 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
127 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
128 /* WebDAV Access Control - RFC 3744 */ \
133 # include "ext/standard/file.h"
134 # define HTTP_DEFAULT_STREAM_CONTEXT FG(default_context)
136 # define HTTP_DEFAULT_STREAM_CONTEXT NULL
139 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
140 STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
141 #define HTTP_PHP_INI_ENTRY_EX(entry, default, scope, updater, displayer, global) \
142 STD_PHP_INI_ENTRY_EX(entry, default, scope, updater, global, zend_http_globals, http_globals, displayer)
145 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
147 /* {{{ objects & properties */
150 # define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
152 # define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
154 zend_class_entry ce; \
155 memset(&ce, 0, sizeof(zend_class_entry)); \
156 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
157 ce.create_object = _ ##name## _new; \
158 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
159 name## _ce->ce_flags |= flags; \
160 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
163 # define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
165 zend_class_entry ce; \
166 memset(&ce, 0, sizeof(zend_class_entry)); \
167 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
168 ce.create_object = NULL; \
169 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
170 name## _ce->ce_flags |= flags; \
173 # define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
175 zend_class_entry ce; \
176 memset(&ce, 0, sizeof(zend_class_entry)); \
177 INIT_CLASS_ENTRY(ce, #classname, NULL); \
178 ce.create_object = NULL; \
179 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
182 # define getObject(t, o) getObjectEx(t, o, getThis())
183 # define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
184 # 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);
186 # define freeObject(o) \
187 if (OBJ_GUARDS(o)) { \
188 zend_hash_destroy(OBJ_GUARDS(o)); \
189 FREE_HASHTABLE(OBJ_GUARDS(o)); \
192 zend_hash_destroy(OBJ_PROP(o)); \
193 FREE_HASHTABLE(OBJ_PROP(o)); \
197 # define freeObject(o) \
199 zend_hash_destroy(OBJ_PROP(o)); \
200 FREE_HASHTABLE(OBJ_PROP(o)); \
204 # define OBJ_PROP(o) (o)->zo.properties
205 # define OBJ_GUARDS(o) (o)->zo.guards
207 # define DCL_STATIC_PROP(a, t, n, v) zend_declare_property_ ##t(OBJ_PROP_CE, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
208 # define DCL_STATIC_PROP_Z(a, n, v) zend_declare_property(OBJ_PROP_CE, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
209 # define DCL_STATIC_PROP_N(a, n) zend_declare_property_null(OBJ_PROP_CE, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
210 # define GET_STATIC_PROP_EX(ce, n) zend_std_get_static_property(ce, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
211 # define UPD_STATIC_PROP_EX(ce, t, n, v) zend_update_static_property_ ##t(ce, #n, sizeof(#n)-1, (v) TSRMLS_CC)
212 # define UPD_STATIC_STRL_EX(ce, n, v, l) zend_update_static_property_stringl(ce, #n, sizeof(#n)-1, (v), (l) TSRMLS_CC)
213 # define SET_STATIC_PROP_EX(ce, n, v) zend_update_static_property(ce, #n, sizeof(#n)-1, v TSRMLS_CC)
214 # define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(OBJ_PROP_CE, n)
215 # define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(OBJ_PROP_CE, t, n, v)
216 # define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(OBJ_PROP_CE, n, v)
217 # define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(OBJ_PROP_CE, n, v, l)
219 # define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(OBJ_PROP_CE, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
220 # define DCL_PROP_Z(a, n, v) zend_declare_property(OBJ_PROP_CE, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
221 # define DCL_PROP_N(a, n) zend_declare_property_null(OBJ_PROP_CE, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a) TSRMLS_CC)
222 # define UPD_PROP(t, n, v) UPD_PROP_EX(getThis(), t, n, v)
223 # define UPD_PROP_EX(this, t, n, v) zend_update_property_ ##t(OBJ_PROP_CE, this, (#n), sizeof(#n)-1, (v) TSRMLS_CC)
224 # define UPD_STRL(n, v, l) zend_update_property_stringl(OBJ_PROP_CE, getThis(), (#n), sizeof(#n)-1, (v), (l) TSRMLS_CC)
225 # define SET_PROP(n, z) SET_PROP_EX(getThis(), n, z)
226 # define SET_PROP_EX(this, n, z) zend_update_property(OBJ_PROP_CE, this, (#n), sizeof(#n)-1, (z) TSRMLS_CC)
227 # define GET_PROP(n) GET_PROP_EX(getThis(), n)
228 # define GET_PROP_EX(this, n) zend_read_property(OBJ_PROP_CE, this, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
230 # define DCL_CONST(t, n, v) zend_declare_class_constant_ ##t(OBJ_PROP_CE, (n), sizeof(n)-1, (v) TSRMLS_CC)
232 # define ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
233 # define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
234 # define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
235 # define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
237 # define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
238 # define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
239 # define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
240 # define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
242 #endif /* ZEND_ENGINE_2 */
246 # define with_error_handling(eh, ec) \
248 error_handling_t __eh = PG(error_handling); \
249 zend_class_entry *__ec= PG(exception_class); \
250 php_set_error_handling(eh, ec TSRMLS_CC);
251 # define end_error_handling() \
252 php_set_error_handling(__eh, __ec TSRMLS_CC); \
255 # define with_error_handling(eh, ec)
256 # define end_error_handling()
259 #if (PHP_MAJOR_VERSION == 5 && PHP_MINOR_VERSION >= 2) || PHP_MAJOR_VERSION > 5
260 # define ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default(TSRMLS_C)
262 # define ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default()
269 # define HE_THROW E_THROW TSRMLS_CC
270 # define HE_NOTICE (HTTP_G->only_exceptions ? E_THROW : E_NOTICE) TSRMLS_CC
271 # define HE_WARNING (HTTP_G->only_exceptions ? E_THROW : E_WARNING) TSRMLS_CC
272 # define HE_ERROR (HTTP_G->only_exceptions ? E_THROW : E_ERROR) TSRMLS_CC
274 # define HE_THROW E_WARNING TSRMLS_CC
275 # define HE_NOTICE E_NOTICE TSRMLS_CC
276 # define HE_WARNING E_WARNING TSRMLS_CC
277 # define HE_ERROR E_ERROR TSRMLS_CC
280 #define HTTP_E_RUNTIME 1L
281 #define HTTP_E_INVALID_PARAM 2L
282 #define HTTP_E_HEADER 3L
283 #define HTTP_E_MALFORMED_HEADERS 4L
284 #define HTTP_E_REQUEST_METHOD 5L
285 #define HTTP_E_MESSAGE_TYPE 6L
286 #define HTTP_E_ENCODING 7L
287 #define HTTP_E_REQUEST 8L
288 #define HTTP_E_REQUEST_POOL 9L
289 #define HTTP_E_SOCKET 10L
290 #define HTTP_E_RESPONSE 11L
291 #define HTTP_E_URL 12L
292 #define HTTP_E_QUERYSTRING 13L
295 # 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)
296 # 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)
297 # define HTTP_END_ARGS }
298 # define HTTP_EMPTY_ARGS_EX(class, method, ret_ref) HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
299 # define HTTP_ARGS(class, method) args_for_ ##class## _ ##method
300 # define HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
301 # define HTTP_ARG_OBJ(class, name, allow_null) ZEND_ARG_OBJ_INFO(0, name, class, allow_null)
305 # define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
307 # define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL}
310 #ifdef HTTP_HAVE_CURL
311 # ifdef ZEND_ENGINE_2
312 # define HTTP_DECLARE_ARG_PASS_INFO() \
314 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
315 ZEND_ARG_PASS_INFO(0) \
316 ZEND_ARG_PASS_INFO(1) \
317 ZEND_END_ARG_INFO(); \
320 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
321 ZEND_ARG_PASS_INFO(0) \
322 ZEND_ARG_PASS_INFO(0) \
323 ZEND_ARG_PASS_INFO(1) \
324 ZEND_END_ARG_INFO(); \
327 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
328 ZEND_ARG_PASS_INFO(0) \
329 ZEND_ARG_PASS_INFO(0) \
330 ZEND_ARG_PASS_INFO(0) \
331 ZEND_ARG_PASS_INFO(1) \
332 ZEND_END_ARG_INFO(); \
335 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
336 ZEND_ARG_PASS_INFO(0) \
337 ZEND_ARG_PASS_INFO(0) \
338 ZEND_ARG_PASS_INFO(0) \
339 ZEND_ARG_PASS_INFO(0) \
340 ZEND_ARG_PASS_INFO(1) \
344 # define HTTP_DECLARE_ARG_PASS_INFO() \
345 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
346 static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
347 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
348 static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
349 # endif /* ZEND_ENGINE_2 */
351 # ifdef ZEND_ENGINE_2
352 # define HTTP_DECLARE_ARG_PASS_INFO() \
354 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 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) \
367 # define HTTP_DECLARE_ARG_PASS_INFO() \
368 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
369 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
370 # endif /* ZEND_ENGINE_2 */
371 #endif /* HTTP_HAVE_CURL */
374 #ifndef TSRMLS_FETCH_FROM_CTX
376 # define TSRMLS_FETCH_FROM_CTX(ctx) void ***tsrm_ls = (void ***) ctx
378 # define TSRMLS_FETCH_FROM_CTX(ctx)
382 #ifndef TSRMLS_SET_CTX
384 # define TSRMLS_SET_CTX(ctx) ctx = (void ***) tsrm_ls
386 # define TSRMLS_SET_CTX(ctx)
391 #define ZVAL_ZVAL(z, zv, copy, dtor) { \
392 int is_ref, refcount; \
393 is_ref = (z)->is_ref; \
394 refcount = (z)->refcount; \
403 zval_ptr_dtor(&zv); \
405 (z)->is_ref = is_ref; \
406 (z)->refcount = refcount; \
410 #define RETVAL_ZVAL(zv, copy, dtor) ZVAL_ZVAL(return_value, zv, copy, dtor)
413 #define RETURN_ZVAL(zv, copy, dtor) { RETVAL_ZVAL(zv, copy, dtor); return; }
416 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
417 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
418 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
419 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
421 #define Z_OBJ_DELREF(z) \
422 if (Z_OBJ_HT(z)->del_ref) { \
423 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
425 #define Z_OBJ_ADDREF(z) \
426 if (Z_OBJ_HT(z)->add_ref) { \
427 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
429 #define Z_OBJ_DELREF_P(z) \
430 if (Z_OBJ_HT_P(z)->del_ref) { \
431 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
433 #define Z_OBJ_ADDREF_P(z) \
434 if (Z_OBJ_HT_P(z)->add_ref) { \
435 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
437 #define Z_OBJ_DELREF_PP(z) \
438 if (Z_OBJ_HT_PP(z)->del_ref) { \
439 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
441 #define Z_OBJ_ADDREF_PP(z) \
442 if (Z_OBJ_HT_PP(z)->add_ref) { \
443 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
446 #endif /* PHP_HTTP_STD_DEFS_H */
453 * vim600: noet sw=4 ts=4 fdm=marker
454 * vim<600: noet sw=4 ts=4