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-2007, 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 = zend_read_property(THIS_CE, this, ZEND_STRS(#n)-1, 0 TSRMLS_CC); \
87 RETVAL_ZVAL(__prop, 1, 0); \
89 #define RETURN_PROP_EX(this, n) \
91 zval *__prop = zend_read_property(THIS_CE, this, ZEND_STRS(#n)-1, 0 TSRMLS_CC); \
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 ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
205 # define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
206 # define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
207 # define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
209 # define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
210 # define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
211 # define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
213 #endif /* ZEND_ENGINE_2 */
217 # define with_error_handling(eh, ec) \
219 error_handling_t __eh = PG(error_handling); \
220 zend_class_entry *__ec= PG(exception_class); \
221 php_set_error_handling(eh, ec TSRMLS_CC);
222 # define end_error_handling() \
223 php_set_error_handling(__eh, __ec TSRMLS_CC); \
226 # define with_error_handling(eh, ec)
227 # define end_error_handling()
230 #if (PHP_MAJOR_VERSION == 5 && PHP_MINOR_VERSION >= 2) || PHP_MAJOR_VERSION > 5
231 # define ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default(TSRMLS_C)
233 # define ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default()
240 # define HE_THROW E_THROW TSRMLS_CC
241 # define HE_NOTICE (HTTP_G->only_exceptions ? E_THROW : E_NOTICE) TSRMLS_CC
242 # define HE_WARNING (HTTP_G->only_exceptions ? E_THROW : E_WARNING) TSRMLS_CC
243 # define HE_ERROR (HTTP_G->only_exceptions ? E_THROW : E_ERROR) TSRMLS_CC
245 # define HE_THROW E_WARNING TSRMLS_CC
246 # define HE_NOTICE E_NOTICE TSRMLS_CC
247 # define HE_WARNING E_WARNING TSRMLS_CC
248 # define HE_ERROR E_ERROR TSRMLS_CC
251 #define HTTP_E_RUNTIME 1L
252 #define HTTP_E_INVALID_PARAM 2L
253 #define HTTP_E_HEADER 3L
254 #define HTTP_E_MALFORMED_HEADERS 4L
255 #define HTTP_E_REQUEST_METHOD 5L
256 #define HTTP_E_MESSAGE_TYPE 6L
257 #define HTTP_E_ENCODING 7L
258 #define HTTP_E_REQUEST 8L
259 #define HTTP_E_REQUEST_POOL 9L
260 #define HTTP_E_SOCKET 10L
261 #define HTTP_E_RESPONSE 11L
262 #define HTTP_E_URL 12L
263 #define HTTP_E_QUERYSTRING 13L
266 # 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)
267 # 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)
268 # define HTTP_END_ARGS }
269 # define HTTP_EMPTY_ARGS_EX(class, method, ret_ref) HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
270 # define HTTP_ARGS(class, method) args_for_ ##class## _ ##method
271 # define HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
272 # define 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 EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL}
281 #ifdef HTTP_HAVE_CURL
282 # ifdef ZEND_ENGINE_2
283 # define HTTP_DECLARE_ARG_PASS_INFO() \
285 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
286 ZEND_ARG_PASS_INFO(0) \
287 ZEND_ARG_PASS_INFO(1) \
288 ZEND_END_ARG_INFO(); \
291 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
292 ZEND_ARG_PASS_INFO(0) \
293 ZEND_ARG_PASS_INFO(0) \
294 ZEND_ARG_PASS_INFO(1) \
295 ZEND_END_ARG_INFO(); \
298 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
299 ZEND_ARG_PASS_INFO(0) \
300 ZEND_ARG_PASS_INFO(0) \
301 ZEND_ARG_PASS_INFO(0) \
302 ZEND_ARG_PASS_INFO(1) \
303 ZEND_END_ARG_INFO(); \
306 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
307 ZEND_ARG_PASS_INFO(0) \
308 ZEND_ARG_PASS_INFO(0) \
309 ZEND_ARG_PASS_INFO(0) \
310 ZEND_ARG_PASS_INFO(0) \
311 ZEND_ARG_PASS_INFO(1) \
315 # define HTTP_DECLARE_ARG_PASS_INFO() \
316 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
317 static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
318 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
319 static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
320 # endif /* ZEND_ENGINE_2 */
322 # ifdef ZEND_ENGINE_2
323 # define HTTP_DECLARE_ARG_PASS_INFO() \
325 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
326 ZEND_ARG_PASS_INFO(0) \
327 ZEND_ARG_PASS_INFO(1) \
328 ZEND_END_ARG_INFO(); \
331 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
332 ZEND_ARG_PASS_INFO(0) \
333 ZEND_ARG_PASS_INFO(0) \
334 ZEND_ARG_PASS_INFO(0) \
335 ZEND_ARG_PASS_INFO(1) \
338 # define HTTP_DECLARE_ARG_PASS_INFO() \
339 static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
340 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
341 # endif /* ZEND_ENGINE_2 */
342 #endif /* HTTP_HAVE_CURL */
345 #ifndef HAVE_CURL_SHARE_STRERROR
346 # define curl_share_strerror(dummy) "unknown error"
348 #ifndef HAVE_CURL_EASY_STRERROR
349 # define curl_easy_strerror(dummy) "unknown error"
351 #ifndef HAVE_CURL_MULTI_STRERROR
352 # define curl_multi_strerror(dummy) "unknown error"
355 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
356 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
357 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
358 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
360 #define Z_OBJ_DELREF(z) \
361 if (Z_OBJ_HT(z)->del_ref) { \
362 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
364 #define Z_OBJ_ADDREF(z) \
365 if (Z_OBJ_HT(z)->add_ref) { \
366 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
368 #define Z_OBJ_DELREF_P(z) \
369 if (Z_OBJ_HT_P(z)->del_ref) { \
370 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
372 #define Z_OBJ_ADDREF_P(z) \
373 if (Z_OBJ_HT_P(z)->add_ref) { \
374 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
376 #define Z_OBJ_DELREF_PP(z) \
377 if (Z_OBJ_HT_PP(z)->del_ref) { \
378 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
380 #define Z_OBJ_ADDREF_PP(z) \
381 if (Z_OBJ_HT_PP(z)->add_ref) { \
382 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
385 #endif /* PHP_HTTP_STD_DEFS_H */
392 * vim600: noet sw=4 ts=4 fdm=marker
393 * vim<600: noet sw=4 ts=4