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 */
96 #define NO_ARGS zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "");
99 #define HTTP_CRLF "\r\n"
101 /* default cache control */
102 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
105 #define HTTP_URL_MAXLEN 4096
107 /* def URL arg separator */
108 #define HTTP_URL_ARGSEP "&"
110 /* send buffer size */
111 #define HTTP_SENDBUF_SIZE 8000 /*40960*/
113 /* CURL buffer size */
114 #define HTTP_CURLBUF_SIZE 16384
117 #define HTTP_KNOWN_METHODS \
119 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
120 /* WebDAV - RFC 2518 */ \
121 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
122 /* WebDAV Versioning - RFC 3253 */ \
123 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
124 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
125 /* WebDAV Access Control - RFC 3744 */ \
130 # include "ext/standard/file.h"
131 # define HTTP_DEFAULT_STREAM_CONTEXT FG(default_context)
133 # define HTTP_DEFAULT_STREAM_CONTEXT NULL
136 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
137 STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
138 #define HTTP_PHP_INI_ENTRY_EX(entry, default, scope, updater, displayer, global) \
139 STD_PHP_INI_ENTRY_EX(entry, default, scope, updater, global, zend_http_globals, http_globals, displayer)
142 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
144 /* {{{ objects & properties */
147 # define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
149 # define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
151 zend_class_entry ce; \
152 memset(&ce, 0, sizeof(zend_class_entry)); \
153 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
154 ce.create_object = _ ##name## _new; \
155 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
156 name## _ce->ce_flags |= flags; \
157 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
160 # define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
162 zend_class_entry ce; \
163 memset(&ce, 0, sizeof(zend_class_entry)); \
164 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
165 ce.create_object = NULL; \
166 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
167 name## _ce->ce_flags |= flags; \
170 # define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
172 zend_class_entry ce; \
173 memset(&ce, 0, sizeof(zend_class_entry)); \
174 INIT_CLASS_ENTRY(ce, #classname, NULL); \
175 ce.create_object = NULL; \
176 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
179 # define getObject(t, o) getObjectEx(t, o, getThis())
180 # define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
181 # 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);
183 # define freeObject(o) \
184 if (OBJ_GUARDS(o)) { \
185 zend_hash_destroy(OBJ_GUARDS(o)); \
186 FREE_HASHTABLE(OBJ_GUARDS(o)); \
189 zend_hash_destroy(OBJ_PROP(o)); \
190 FREE_HASHTABLE(OBJ_PROP(o)); \
194 # define freeObject(o) \
196 zend_hash_destroy(OBJ_PROP(o)); \
197 FREE_HASHTABLE(OBJ_PROP(o)); \
201 # define OBJ_PROP(o) (o)->zo.properties
202 # define OBJ_GUARDS(o) (o)->zo.guards
204 # 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)
205 # 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)
206 # 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)
207 # define GET_STATIC_PROP_EX(ce, n) zend_std_get_static_property(ce, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
208 # define UPD_STATIC_PROP_EX(ce, t, n, v) zend_update_static_property_ ##t(ce, #n, sizeof(#n)-1, (v) TSRMLS_CC)
209 # define UPD_STATIC_STRL_EX(ce, n, v, l) zend_update_static_property_stringl(ce, #n, sizeof(#n)-1, (v), (l) TSRMLS_CC)
210 # define SET_STATIC_PROP_EX(ce, n, v) zend_update_static_property(ce, #n, sizeof(#n)-1, v TSRMLS_CC)
211 # define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(OBJ_PROP_CE, n)
212 # define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(OBJ_PROP_CE, t, n, v)
213 # define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(OBJ_PROP_CE, n, v)
214 # define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(OBJ_PROP_CE, n, v, l)
216 # define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(OBJ_PROP_CE, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
217 # define DCL_PROP_Z(a, n, v) zend_declare_property(OBJ_PROP_CE, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
218 # define DCL_PROP_N(a, n) zend_declare_property_null(OBJ_PROP_CE, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a) TSRMLS_CC)
219 # define UPD_PROP(t, n, v) UPD_PROP_EX(getThis(), t, n, v)
220 # define UPD_PROP_EX(this, t, n, v) zend_update_property_ ##t(OBJ_PROP_CE, this, (#n), sizeof(#n)-1, (v) TSRMLS_CC)
221 # define UPD_STRL(n, v, l) zend_update_property_stringl(OBJ_PROP_CE, getThis(), (#n), sizeof(#n)-1, (v), (l) TSRMLS_CC)
222 # define SET_PROP(n, z) SET_PROP_EX(getThis(), n, z)
223 # define SET_PROP_EX(this, n, z) zend_update_property(OBJ_PROP_CE, this, (#n), sizeof(#n)-1, (z) TSRMLS_CC)
224 # define GET_PROP(n) GET_PROP_EX(getThis(), n)
225 # define GET_PROP_EX(this, n) zend_read_property(OBJ_PROP_CE, this, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
227 # define DCL_CONST(t, n, v) zend_declare_class_constant_ ##t(OBJ_PROP_CE, (n), sizeof(n)-1, (v) TSRMLS_CC)
229 # define ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
230 # define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
231 # define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
232 # define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
234 # define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
235 # define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
236 # define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
237 # define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
239 #endif /* ZEND_ENGINE_2 */
243 # define with_error_handling(eh, ec) \
245 error_handling_t __eh = PG(error_handling); \
246 zend_class_entry *__ec= PG(exception_class); \
247 php_set_error_handling(eh, ec TSRMLS_CC);
248 # define end_error_handling() \
249 php_set_error_handling(__eh, __ec TSRMLS_CC); \
252 # define with_error_handling(eh, ec)
253 # define end_error_handling()
256 #if (PHP_MAJOR_VERSION == 5 && PHP_MINOR_VERSION >= 2) || PHP_MAJOR_VERSION > 5
257 # define ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default(TSRMLS_C)
259 # define ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default()
266 # define HE_THROW E_THROW TSRMLS_CC
267 # define HE_NOTICE (HTTP_G->only_exceptions ? E_THROW : E_NOTICE) TSRMLS_CC
268 # define HE_WARNING (HTTP_G->only_exceptions ? E_THROW : E_WARNING) TSRMLS_CC
269 # define HE_ERROR (HTTP_G->only_exceptions ? E_THROW : E_ERROR) TSRMLS_CC
271 # define HE_THROW E_WARNING TSRMLS_CC
272 # define HE_NOTICE E_NOTICE TSRMLS_CC
273 # define HE_WARNING E_WARNING TSRMLS_CC
274 # define HE_ERROR E_ERROR TSRMLS_CC
277 #define HTTP_E_RUNTIME 1L
278 #define HTTP_E_INVALID_PARAM 2L
279 #define HTTP_E_HEADER 3L
280 #define HTTP_E_MALFORMED_HEADERS 4L
281 #define HTTP_E_REQUEST_METHOD 5L
282 #define HTTP_E_MESSAGE_TYPE 6L
283 #define HTTP_E_ENCODING 7L
284 #define HTTP_E_REQUEST 8L
285 #define HTTP_E_REQUEST_POOL 9L
286 #define HTTP_E_SOCKET 10L
287 #define HTTP_E_RESPONSE 11L
288 #define HTTP_E_URL 12L
289 #define HTTP_E_QUERYSTRING 13L
292 # 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)
293 # 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)
294 # define HTTP_END_ARGS }
295 # define HTTP_EMPTY_ARGS_EX(class, method, ret_ref) HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
296 # define HTTP_ARGS(class, method) args_for_ ##class## _ ##method
297 # define HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
298 # define HTTP_ARG_OBJ(class, name, allow_null) ZEND_ARG_OBJ_INFO(0, name, class, allow_null)
302 # define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
304 # define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL}
307 #ifdef HTTP_HAVE_CURL
308 # ifdef ZEND_ENGINE_2
309 # define HTTP_DECLARE_ARG_PASS_INFO() \
311 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
312 ZEND_ARG_PASS_INFO(0) \
313 ZEND_ARG_PASS_INFO(1) \
314 ZEND_END_ARG_INFO(); \
317 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
318 ZEND_ARG_PASS_INFO(0) \
319 ZEND_ARG_PASS_INFO(0) \
320 ZEND_ARG_PASS_INFO(1) \
321 ZEND_END_ARG_INFO(); \
324 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
325 ZEND_ARG_PASS_INFO(0) \
326 ZEND_ARG_PASS_INFO(0) \
327 ZEND_ARG_PASS_INFO(0) \
328 ZEND_ARG_PASS_INFO(1) \
329 ZEND_END_ARG_INFO(); \
332 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
333 ZEND_ARG_PASS_INFO(0) \
334 ZEND_ARG_PASS_INFO(0) \
335 ZEND_ARG_PASS_INFO(0) \
336 ZEND_ARG_PASS_INFO(0) \
337 ZEND_ARG_PASS_INFO(1) \
341 # define HTTP_DECLARE_ARG_PASS_INFO() \
342 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
343 static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
344 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
345 static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
346 # endif /* ZEND_ENGINE_2 */
348 # ifdef ZEND_ENGINE_2
349 # define 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(); \
357 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 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) \
364 # define HTTP_DECLARE_ARG_PASS_INFO() \
365 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
366 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
367 # endif /* ZEND_ENGINE_2 */
368 #endif /* HTTP_HAVE_CURL */
371 #ifndef TSRMLS_FETCH_FROM_CTX
373 # define TSRMLS_FETCH_FROM_CTX(ctx) void ***tsrm_ls = (void ***) ctx
375 # define TSRMLS_FETCH_FROM_CTX(ctx)
379 #ifndef TSRMLS_SET_CTX
381 # define TSRMLS_SET_CTX(ctx) ctx = (void ***) tsrm_ls
383 # define TSRMLS_SET_CTX(ctx)
388 #define ZVAL_ZVAL(z, zv, copy, dtor) { \
389 int is_ref, refcount; \
390 is_ref = (z)->is_ref; \
391 refcount = (z)->refcount; \
400 zval_ptr_dtor(&zv); \
402 (z)->is_ref = is_ref; \
403 (z)->refcount = refcount; \
407 #define RETVAL_ZVAL(zv, copy, dtor) ZVAL_ZVAL(return_value, zv, copy, dtor)
410 #define RETURN_ZVAL(zv, copy, dtor) { RETVAL_ZVAL(zv, copy, dtor); return; }
413 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
414 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
415 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
416 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
418 #define Z_OBJ_DELREF(z) \
419 if (Z_OBJ_HT(z)->del_ref) { \
420 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
422 #define Z_OBJ_ADDREF(z) \
423 if (Z_OBJ_HT(z)->add_ref) { \
424 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
426 #define Z_OBJ_DELREF_P(z) \
427 if (Z_OBJ_HT_P(z)->del_ref) { \
428 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
430 #define Z_OBJ_ADDREF_P(z) \
431 if (Z_OBJ_HT_P(z)->add_ref) { \
432 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
434 #define Z_OBJ_DELREF_PP(z) \
435 if (Z_OBJ_HT_PP(z)->del_ref) { \
436 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
438 #define Z_OBJ_ADDREF_PP(z) \
439 if (Z_OBJ_HT_PP(z)->add_ref) { \
440 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
443 #endif /* PHP_HTTP_STD_DEFS_H */
450 * vim600: noet sw=4 ts=4 fdm=marker
451 * vim<600: noet sw=4 ts=4