- simplify http_send_header API
[m6w6/ext-http] / php_http_std_defs.h
1 /*
2 +----------------------------------------------------------------------+
3 | PECL :: http |
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 +----------------------------------------------------------------------+
14 */
15
16 /* $Id$ */
17
18 #ifndef PHP_HTTP_STD_DEFS_H
19 #define PHP_HTTP_STD_DEFS_H
20
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)
26 # else
27 # define PHP_HTTP_API
28 # endif
29 #else
30 # define PHP_HTTP_API
31 #endif
32
33 /* make functions that return SUCCESS|FAILURE more obvious */
34 typedef int STATUS;
35
36 /* lenof() */
37 #define lenof(S) (sizeof(S) - 1)
38
39 /* STR_SET() */
40 #define STR_SET(target, source) \
41 if(target) efree(target); \
42 target = source
43
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) \
51 RETVAL_OBJECT(o); \
52 return
53 #define RETVAL_OBJVAL(ov) \
54 return_value->is_ref = 1; \
55 return_value->type = IS_OBJECT; \
56 return_value->value.obj = (ov); \
57 zend_objects_store_add_ref(return_value TSRMLS_CC)
58 #define RETURN_OBJVAL(ov) \
59 RETVAL_OBJVAL(ov); \
60 return
61
62 /* function accepts no args */
63 #define NO_ARGS \
64 if (ZEND_NUM_ARGS()) { \
65 zend_error(E_NOTICE, "Wrong parameter count for %s()", get_active_function_name(TSRMLS_C)); \
66 }
67
68 /* check if return value is used */
69 #define IF_RETVAL_USED \
70 if (!return_value_used) { \
71 return; \
72 } else
73
74 /* CR LF */
75 #define HTTP_CRLF "\r\n"
76
77 /* default cache control */
78 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
79
80 /* max URL length */
81 #define HTTP_URL_MAXLEN 2048
82 #define HTTP_URI_MAXLEN HTTP_URL_MAXLEN
83
84 /* def URL arg separator */
85 #define HTTP_URL_ARGSEP "&"
86 #define HTTP_URI_ARGSEP HTTP_URL_ARGSEP
87
88 /* send buffer size */
89 #define HTTP_SENDBUF_SIZE 2097152
90
91 /* CURL buffer size */
92 #define HTTP_CURLBUF_SIZE 16384
93
94 /* known methods */
95 #define HTTP_KNOWN_METHODS \
96 /* HTTP 1.1 */ \
97 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
98 /* WebDAV - RFC 2518 */ \
99 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
100 /* WebDAV Versioning - RFC 3253 */ \
101 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
102 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
103 /* WebDAV Access Control - RFC 3744 */ \
104 "ACL, " \
105 /* END */
106
107
108 /* server vars shorthand */
109 #define HTTP_SERVER_VARS Z_ARRVAL_P(PG(http_globals)[TRACK_VARS_SERVER])
110
111 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
112 STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
113
114 /* {{{ arrays */
115 #define FOREACH_VAL(array, val) FOREACH_HASH_VAL(Z_ARRVAL_P(array), val)
116 #define FOREACH_HASH_VAL(hash, val) \
117 for ( zend_hash_internal_pointer_reset(hash); \
118 zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
119 zend_hash_move_forward(hash))
120
121 #define FOREACH_KEY(array, strkey, numkey) FOREACH_HASH_KEY(Z_ARRVAL_P(array), strkey, numkey)
122 #define FOREACH_HASH_KEY(hash, strkey, numkey) \
123 for ( zend_hash_internal_pointer_reset(hash); \
124 zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT; \
125 zend_hash_move_forward(hash)) \
126
127 #define FOREACH_KEYVAL(array, strkey, numkey, val) FOREACH_HASH_KEYVAL(Z_ARRVAL_P(array), strkey, numkey, val)
128 #define FOREACH_HASH_KEYVAL(hash, strkey, numkey, val) \
129 for ( zend_hash_internal_pointer_reset(hash); \
130 zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT && \
131 zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
132 zend_hash_move_forward(hash)) \
133
134 #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 *))
135 #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)
136 #define array_append(src, dst) \
137 { \
138 ulong idx; \
139 uint klen; \
140 char *key = NULL; \
141 zval **data; \
142 \
143 for ( zend_hash_internal_pointer_reset(Z_ARRVAL_P(src)); \
144 zend_hash_get_current_key_ex(Z_ARRVAL_P(src), &key, &klen, &idx, 0, NULL) != HASH_KEY_NON_EXISTANT && \
145 zend_hash_get_current_data(Z_ARRVAL_P(src), (void **) &data) == SUCCESS; \
146 zend_hash_move_forward(Z_ARRVAL_P(src))) \
147 { \
148 if (key) { \
149 zval **tmp; \
150 \
151 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(dst), key, klen, (void **) &tmp)) { \
152 if (Z_TYPE_PP(tmp) != IS_ARRAY) { \
153 convert_to_array_ex(tmp); \
154 } \
155 add_next_index_zval(*tmp, *data); \
156 } else { \
157 add_assoc_zval(dst, key, *data); \
158 } \
159 zval_add_ref(data); \
160 key = NULL; \
161 } \
162 } \
163 }
164 /* }}} */
165
166 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
167
168 /* {{{ objects & properties */
169 #ifdef ZEND_ENGINE_2
170
171 # define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
172
173 # define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
174 { \
175 zend_class_entry ce; \
176 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
177 ce.create_object = name## _new; \
178 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
179 name## _ce->ce_flags |= flags; \
180 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
181 name## _declare_default_properties(); \
182 }
183
184 # define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
185 { \
186 zend_class_entry ce; \
187 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
188 ce.create_object = NULL; \
189 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
190 name## _ce->ce_flags |= flags; \
191 }
192
193 # define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
194 { \
195 zend_class_entry ce; \
196 INIT_CLASS_ENTRY(ce, #classname, NULL); \
197 ce.create_object = NULL; \
198 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
199 }
200
201 # define getObject(t, o) getObjectEx(t, o, getThis())
202 # define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
203 # 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);
204 # define OBJ_PROP(o) (o)->zo.properties
205 # 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)
206 # define DCL_STATIC_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
207 # define DCL_STATIC_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
208 # define GET_STATIC_PROP_EX(ce, n) zend_std_get_static_property(ce, (#n), sizeof(#n), 0 TSRMLS_CC)
209 #ifdef zend_update_class_constants
210 # define USE_STATIC_PROP_EX(ce) zend_update_class_constants(ce TSRMLS_CC)
211 #else
212 # define USE_STATIC_PROP_EX(ce)
213 #endif
214 # define SET_STATIC_PROP_EX(ce, n, v) \
215 { \
216 int refcount; \
217 zend_uchar is_ref; \
218 zval **__static = GET_STATIC_PROP_EX(ce, n); \
219 \
220 refcount = (*__static)->refcount; \
221 is_ref = (*__static)->is_ref; \
222 switch (Z_TYPE_PP(__static)) \
223 { \
224 case IS_BOOL: case IS_LONG: case IS_NULL: \
225 break; \
226 case IS_RESOURCE: \
227 zend_list_delete(Z_LVAL_PP(__static)); \
228 break; \
229 case IS_STRING: case IS_CONSTANT: \
230 free(Z_STRVAL_PP(__static)); \
231 break; \
232 case IS_OBJECT: \
233 Z_OBJ_HT_PP(__static)->del_ref(*__static TSRMLS_CC); \
234 break; \
235 case IS_ARRAY: case IS_CONSTANT_ARRAY: \
236 if (Z_ARRVAL_PP(__static) && Z_ARRVAL_PP(__static) != &EG(symbol_table)) { \
237 zend_hash_destroy(Z_ARRVAL_PP(__static)); \
238 free(Z_ARRVAL_PP(__static)); \
239 } \
240 break; \
241 } \
242 **__static = *(v); \
243 switch (Z_TYPE_PP(__static)) \
244 { \
245 case IS_BOOL: case IS_LONG: case IS_NULL: \
246 break; \
247 case IS_RESOURCE: \
248 zend_list_addref(Z_LVAL_PP(__static)); \
249 break; \
250 case IS_STRING: case IS_CONSTANT: \
251 Z_STRVAL_PP(__static) = (char *) zend_strndup(Z_STRVAL_PP(__static), Z_STRLEN_PP(__static)); \
252 break; \
253 case IS_OBJECT: \
254 { \
255 Z_OBJ_HT_PP(__static)->add_ref(*__static TSRMLS_CC); \
256 } \
257 break; \
258 case IS_ARRAY: case IS_CONSTANT_ARRAY: \
259 { \
260 if (Z_ARRVAL_PP(__static) != &EG(symbol_table)) { \
261 zval *tmp; \
262 HashTable *old = Z_ARRVAL_PP(__static); \
263 Z_ARRVAL_PP(__static) = (HashTable *) malloc(sizeof(HashTable)); \
264 zend_hash_init(Z_ARRVAL_PP(__static), 0, NULL, ZVAL_PTR_DTOR, 0); \
265 zend_hash_copy(Z_ARRVAL_PP(__static), old, (copy_ctor_func_t) zval_add_ref, (void *) &tmp, sizeof(zval *)); \
266 } \
267 } \
268 break; \
269 } \
270 (*__static)->refcount = refcount; \
271 (*__static)->is_ref = is_ref; \
272 }
273 #define SET_STATIC_PROP_STRING_EX(ce, n, s, d) \
274 { \
275 zval *__tmp; \
276 MAKE_STD_ZVAL(__tmp); \
277 ZVAL_STRING(__tmp, (s), (d)); \
278 SET_STATIC_PROP_EX(ce, n, __tmp); \
279 zval_dtor(__tmp); \
280 efree(__tmp); \
281 }
282 #define SET_STATIC_PROP_STRINGL_EX(ce, n, s, l, d) \
283 { \
284 zval *__tmp; \
285 MAKE_STD_ZVAL(__tmp); \
286 ZVAL_STRINGL(__tmp, (s), (l), (d)); \
287 SET_STATIC_PROP_EX(ce, n, __tmp); \
288 zval_dtor(__tmp); \
289 efree(__tmp); \
290 }
291 # define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
292 # define DCL_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
293 # define DCL_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a) TSRMLS_CC)
294 # define UPD_PROP(o, t, n, v) UPD_PROP_EX(o, getThis(), t, n, v)
295 # define UPD_PROP_EX(o, this, t, n, v) zend_update_property_ ##t(o->zo.ce, this, (#n), sizeof(#n)-1, (v) TSRMLS_CC)
296 # define SET_PROP(o, n, z) SET_PROP_EX(o, getThis(), n, z)
297 # define SET_PROP_EX(o, this, n, z) zend_update_property(o->zo.ce, this, (#n), sizeof(#n)-1, (z) TSRMLS_CC)
298 # define GET_PROP(o, n) GET_PROP_EX(o, getThis(), n)
299 # define GET_PROP_EX(o, this, n) zend_read_property(o->zo.ce, this, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
300
301 # define ACC_PROP_PRIVATE(ce, flags) ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
302 # define ACC_PROP_PROTECTED(ce, flags) ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
303 # define ACC_PROP_PUBLIC(flags) (flags & ZEND_ACC_PUBLIC)
304 # define ACC_PROP(ce, flags) (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
305
306 # define INIT_PARR(o, n) \
307 { \
308 zval *__tmp; \
309 MAKE_STD_ZVAL(__tmp); \
310 array_init(__tmp); \
311 SET_PROP(o, n, __tmp); \
312 }
313
314 # define FREE_PARR(o, p) \
315 { \
316 zval *__tmp = GET_PROP(o, p); \
317 if (__tmp) { \
318 zval_dtor(__tmp); \
319 FREE_ZVAL(__tmp); \
320 __tmp = NULL; \
321 } \
322 }
323
324 # define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
325 # define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
326 # define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
327 # define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
328
329 #endif /* ZEND_ENGINE_2 */
330 /* }}} */
331
332 #ifndef E_THROW
333 # define E_THROW 0
334 #endif
335 #define HE_THROW E_THROW
336 #define HE_NOTICE (HTTP_G(only_exceptions) ? E_THROW : E_NOTICE)
337 #define HE_WARNING (HTTP_G(only_exceptions) ? E_THROW : E_WARNING)
338 #define HE_ERROR (HTTP_G(only_exceptions) ? E_THROW : E_ERROR)
339
340 #define HTTP_E_RUNTIME 1L
341 #define HTTP_E_INVALID_PARAM 2L
342 #define HTTP_E_HEADER 3L
343 #define HTTP_E_MALFORMED_HEADERS 4L
344 #define HTTP_E_REQUEST_METHOD 5L
345 #define HTTP_E_MESSAGE_TYPE 6L
346 #define HTTP_E_ENCODING 7L
347 #define HTTP_E_REQUEST 8L
348 #define HTTP_E_REQUEST_POOL 9L
349 #define HTTP_E_SOCKET 10L
350 #define HTTP_E_RESPONSE 11L
351 #define HTTP_E_URL 12L
352
353 #ifdef ZEND_ENGINE_2
354 # 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)
355 # 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)
356 # define HTTP_END_ARGS }
357 # define HTTP_EMPTY_ARGS_EX(class, method, ret_ref) HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
358 # define HTTP_ARGS(class, method) args_for_ ##class## _ ##method
359 # define HTTP_ARG_VAL(name, pass_ref) ZEND_ARG_INFO(pass_ref, name)
360 # define HTTP_ARG_OBJ(class, name, allow_null) ZEND_ARG_OBJ_INFO(1, name, class, allow_null)
361 #endif
362
363 #ifdef HTTP_HAVE_CURL
364 # ifdef ZEND_ENGINE_2
365 # define HTTP_DECLARE_ARG_PASS_INFO() \
366 static \
367 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
368 ZEND_ARG_PASS_INFO(0) \
369 ZEND_ARG_PASS_INFO(0) \
370 ZEND_ARG_PASS_INFO(1) \
371 ZEND_END_ARG_INFO(); \
372 \
373 static \
374 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
375 ZEND_ARG_PASS_INFO(0) \
376 ZEND_ARG_PASS_INFO(0) \
377 ZEND_ARG_PASS_INFO(0) \
378 ZEND_ARG_PASS_INFO(1) \
379 ZEND_END_ARG_INFO(); \
380 \
381 static \
382 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
383 ZEND_ARG_PASS_INFO(0) \
384 ZEND_ARG_PASS_INFO(0) \
385 ZEND_ARG_PASS_INFO(0) \
386 ZEND_ARG_PASS_INFO(0) \
387 ZEND_ARG_PASS_INFO(1) \
388 ZEND_END_ARG_INFO(); \
389 \
390 static \
391 ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_all, 1) \
392 ZEND_ARG_PASS_INFO(1) \
393 ZEND_END_ARG_INFO()
394 # else
395 # define HTTP_DECLARE_ARG_PASS_INFO() \
396 static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
397 static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
398 static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
399 static unsigned char http_arg_pass_ref_all[]={1, BYREF_FORCE_REST}
400 # endif /* ZEND_ENGINE_2 */
401 #else
402 # define HTTP_DECLARE_ARG_PASS_INFO()
403 #endif /* HTTP_HAVE_CURL */
404
405
406 #ifndef TSRMLS_FETCH_FROM_CTX
407 # ifdef ZTS
408 # define TSRMLS_FETCH_FROM_CTX(ctx) void ***tsrm_ls = (void ***) ctx
409 # else
410 # define TSRMLS_FETCH_FROM_CTX(ctx)
411 # endif
412 #endif
413
414 #ifndef TSRMLS_SET_CTX
415 # ifdef ZTS
416 # define TSRMLS_SET_CTX(ctx) (void ***) ctx = tsrm_ls
417 # else
418 # define TSRMLS_SET_CTX(ctx)
419 # endif
420 #endif
421
422
423
424 #endif /* PHP_HTTP_STD_DEFS_H */
425
426 /*
427 * Local variables:
428 * tab-width: 4
429 * c-basic-offset: 4
430 * End:
431 * vim600: noet sw=4 ts=4 fdm=marker
432 * vim<600: noet sw=4 ts=4
433 */
434