git.m6w6.name Git - m6w6/ext-http/blob - 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 #ifndef MIN
  40 #       define MIN(a,b) (a<b?a:b)
  41 #endif
  42 #ifndef MAX
  43 #       define MAX(a,b) (a>b?a:b)
  44 #endif
  45
  46 /* STR_SET() */
  47 #ifndef STR_SET
  48 #       define STR_SET(STR, SET) \
  49         { \
  50                 STR_FREE(STR); \
  51                 STR = SET; \
  52         }
  53 #endif
  54
  55 /* return bool (v == SUCCESS) */
  56 #define RETVAL_SUCCESS(v) RETVAL_BOOL(SUCCESS == (v))
  57 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
  58 /* return object(values) */
  59 #define RETVAL_OBJECT(o) \
  60         RETVAL_OBJVAL((o)->value.obj)
  61 #define RETURN_OBJECT(o) \
  62         RETVAL_OBJECT(o); \
  63         return
  64 #define RETVAL_OBJVAL(ov) \
  65         return_value->is_ref = 1; \
  66         return_value->type = IS_OBJECT; \
  67         return_value->value.obj = (ov); \
  68         zend_objects_store_add_ref(return_value TSRMLS_CC)
  69 #define RETURN_OBJVAL(ov) \
  70         RETVAL_OBJVAL(ov); \
  71         return
  72
  73 /* function accepts no args */
  74 #define NO_ARGS \
  75         if (ZEND_NUM_ARGS()) { \
  76                 zend_error(E_NOTICE, "Wrong parameter count for %s()", get_active_function_name(TSRMLS_C)); \
  77         }
  78
  79 /* check if return value is used */
  80 #define IF_RETVAL_USED \
  81         if (!return_value_used) { \
  82                 return; \
  83         } else
  84
  85 /* CR LF */
  86 #define HTTP_CRLF "\r\n"
  87
  88 /* default cache control */
  89 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
  90
  91 /* max URL length */
  92 #define HTTP_URL_MAXLEN 2048
  93 #define HTTP_URI_MAXLEN HTTP_URL_MAXLEN
  94
  95 /* def URL arg separator */
  96 #define HTTP_URL_ARGSEP "&"
  97 #define HTTP_URI_ARGSEP HTTP_URL_ARGSEP
  98
  99 /* send buffer size */
 100 #define HTTP_SENDBUF_SIZE 2097152
 101
 102 /* CURL buffer size */
 103 #define HTTP_CURLBUF_SIZE 16384
 104
 105 /* known methods */
 106 #define HTTP_KNOWN_METHODS \
 107                 /* HTTP 1.1 */ \
 108                 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
 109                 /* WebDAV - RFC 2518 */ \
 110                 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
 111                 /* WebDAV Versioning - RFC 3253 */ \
 112                 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
 113                 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
 114                 /* WebDAV Access Control - RFC 3744 */ \
 115                 "ACL, " \
 116                 /* END */
 117
 118
 119 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
 120         STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
 121
 122 /* {{{ arrays */
 123 #define FOREACH_VAL(array, val) FOREACH_HASH_VAL(Z_ARRVAL_P(array), val)
 124 #define FOREACH_HASH_VAL(hash, val) \
 125         for (   zend_hash_internal_pointer_reset(hash); \
 126                         zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
 127                         zend_hash_move_forward(hash))
 128
 129 #define FOREACH_KEY(array, strkey, numkey) FOREACH_HASH_KEY(Z_ARRVAL_P(array), strkey, numkey)
 130 #define FOREACH_HASH_KEY(hash, strkey, numkey) \
 131         for (   zend_hash_internal_pointer_reset(hash); \
 132                         zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT; \
 133                         zend_hash_move_forward(hash)) \
 134
 135 #define FOREACH_KEYVAL(array, strkey, numkey, val) FOREACH_HASH_KEYVAL(Z_ARRVAL_P(array), strkey, numkey, val)
 136 #define FOREACH_HASH_KEYVAL(hash, strkey, numkey, val) \
 137         for (   zend_hash_internal_pointer_reset(hash); \
 138                         zend_hash_get_current_key(hash, &strkey, &numkey, 0) != HASH_KEY_NON_EXISTANT && \
 139                         zend_hash_get_current_data(hash, (void **) &val) == SUCCESS; \
 140                         zend_hash_move_forward(hash)) \
 141
 142 #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 *))
 143 #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)
 144 #define array_append(src, dst)  \
 145         { \
 146                 ulong idx; \
 147                 uint klen; \
 148                 char *key = NULL; \
 149                 zval **data; \
 150                  \
 151                 for (   zend_hash_internal_pointer_reset(Z_ARRVAL_P(src)); \
 152                                 zend_hash_get_current_key_ex(Z_ARRVAL_P(src), &key, &klen, &idx, 0, NULL) != HASH_KEY_NON_EXISTANT && \
 153                                 zend_hash_get_current_data(Z_ARRVAL_P(src), (void **) &data) == SUCCESS; \
 154                                 zend_hash_move_forward(Z_ARRVAL_P(src))) \
 155                 { \
 156                         if (key) { \
 157                                 zval **tmp; \
 158                                  \
 159                                 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(dst), key, klen, (void **) &tmp)) { \
 160                                         if (Z_TYPE_PP(tmp) != IS_ARRAY) { \
 161                                                 convert_to_array_ex(tmp); \
 162                                         } \
 163                                         add_next_index_zval(*tmp, *data); \
 164                                 } else { \
 165                                         add_assoc_zval(dst, key, *data); \
 166                                 } \
 167                                 zval_add_ref(data); \
 168                                 key = NULL; \
 169                         } \
 170                 } \
 171         }
 172 /* }}} */
 173
 174 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
 175
 176 /* {{{ objects & properties */
 177 #ifdef ZEND_ENGINE_2
 178
 179 #       define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
 180
 181 #       define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
 182         { \
 183                 zend_class_entry ce; \
 184                 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
 185                 ce.create_object = name## _new; \
 186                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 187                 name## _ce->ce_flags |= flags;  \
 188                 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
 189                 zend_hash_init(& name## _ce->constants_table, 0, NULL, ZVAL_INTERNAL_PTR_DTOR, 1); \
 190                 name## _declare_default_properties(); \
 191         }
 192
 193 #       define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
 194         { \
 195                 zend_class_entry ce; \
 196                 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
 197                 ce.create_object = NULL; \
 198                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 199                 name## _ce->ce_flags |= flags;  \
 200         }
 201
 202 #       define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
 203         { \
 204                 zend_class_entry ce; \
 205                 INIT_CLASS_ENTRY(ce, #classname, NULL); \
 206                 ce.create_object = NULL; \
 207                 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 208         }
 209
 210 #       define getObject(t, o) getObjectEx(t, o, getThis())
 211 #       define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
 212 #       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);
 213 #       define OBJ_PROP(o) (o)->zo.properties
 214
 215 #       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)
 216 #       define DCL_STATIC_PROP_Z(a, n, v)               zend_declare_property(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
 217 #       define DCL_STATIC_PROP_N(a, n)                  zend_declare_property_null(ce, (#n), sizeof(#n), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
 218 #       define GET_STATIC_PROP_EX(ce, n)                zend_std_get_static_property(ce, (#n), sizeof(#n), 0 TSRMLS_CC)
 219 #       define UPD_STATIC_PROP_EX(ce, t, n, v)  zend_update_static_property_ ##t(ce, #n, sizeof(#n), (v) TSRMLS_CC)
 220 #       define SET_STATIC_PROP_EX(ce, n, v)             zend_update_static_property(ce, #n, sizeof(#n), v TSRMLS_CC)
 221
 222 #       define DCL_PROP(a, t, n, v)                             zend_declare_property_ ##t(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
 223 #       define DCL_PROP_Z(a, n, v)                              zend_declare_property(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
 224 #       define DCL_PROP_N(a, n)                                 zend_declare_property_null(ce, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a) TSRMLS_CC)
 225 #       define UPD_PROP(o, t, n, v)                             UPD_PROP_EX(o, getThis(), t, n, v)
 226 #       define UPD_PROP_EX(o, this, t, n, v)    zend_update_property_ ##t(o->zo.ce, this, (#n), sizeof(#n)-1, (v) TSRMLS_CC)
 227 #       define SET_PROP(o, n, z)                                SET_PROP_EX(o, getThis(), n, z)
 228 #       define SET_PROP_EX(o, this, n, z)               zend_update_property(o->zo.ce, this, (#n), sizeof(#n)-1, (z) TSRMLS_CC)
 229 #       define GET_PROP(o, n)                                   GET_PROP_EX(o, getThis(), n)
 230 #       define GET_PROP_EX(o, this, n)                  zend_read_property(o->zo.ce, this, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
 231
 232 #       define DCL_CONST(t, n, v) zend_declare_class_constant_ ##t(ce, (n), sizeof(n), (v) TSRMLS_CC)
 233
 234 #       define ACC_PROP_PRIVATE(ce, flags)              ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
 235 #       define ACC_PROP_PROTECTED(ce, flags)    ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
 236 #       define ACC_PROP_PUBLIC(flags)                   (flags & ZEND_ACC_PUBLIC)
 237 #       define ACC_PROP(ce, flags)                              (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
 238
 239 #       define INIT_PARR(o, n) \
 240         { \
 241                 zval *__tmp; \
 242                 MAKE_STD_ZVAL(__tmp); \
 243                 array_init(__tmp); \
 244                 SET_PROP(o, n, __tmp); \
 245         }
 246
 247 #       define FREE_PARR(o, p) \
 248         { \
 249                 zval *__tmp = GET_PROP(o, p); \
 250                 if (__tmp) { \
 251                         zval_dtor(__tmp); \
 252                         FREE_ZVAL(__tmp); \
 253                         __tmp = NULL; \
 254                 } \
 255         }
 256
 257 #       define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
 258 #       define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
 259 #       define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
 260 #       define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
 261
 262 #endif /* ZEND_ENGINE_2 */
 263 /* }}} */
 264
 265 #ifndef E_THROW
 266 #       define E_THROW 0
 267 #endif
 268 #define HE_THROW        E_THROW
 269 #ifdef ZEND_ENGINE_2
 270 #       define HE_NOTICE        (HTTP_G(only_exceptions) ? E_THROW : E_NOTICE)
 271 #       define HE_WARNING       (HTTP_G(only_exceptions) ? E_THROW : E_WARNING)
 272 #       define HE_ERROR         (HTTP_G(only_exceptions) ? E_THROW : E_ERROR)
 273 #else
 274 #       define HE_NOTICE        E_NOTICE
 275 #       define HE_WARNING       E_WARNING
 276 #       define HE_ERROR         E_ERROR
 277 #endif
 278
 279 #define HTTP_E_RUNTIME                          1L
 280 #define HTTP_E_INVALID_PARAM            2L
 281 #define HTTP_E_HEADER                           3L
 282 #define HTTP_E_MALFORMED_HEADERS        4L
 283 #define HTTP_E_REQUEST_METHOD           5L
 284 #define HTTP_E_MESSAGE_TYPE                     6L
 285 #define HTTP_E_ENCODING                         7L
 286 #define HTTP_E_REQUEST                          8L
 287 #define HTTP_E_REQUEST_POOL                     9L
 288 #define HTTP_E_SOCKET                           10L
 289 #define HTTP_E_RESPONSE                         11L
 290 #define HTTP_E_URL                                      12L
 291
 292 #ifdef ZEND_ENGINE_2
 293 #       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)
 294 #       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)
 295 #       define HTTP_END_ARGS                                                                            }
 296 #       define HTTP_EMPTY_ARGS_EX(class, method, ret_ref)                       HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
 297 #       define HTTP_ARGS(class, method)                                                         args_for_ ##class## _ ##method
 298 #       define HTTP_ARG_VAL(name, pass_ref)                                                     ZEND_ARG_INFO(pass_ref, name)
 299 #       define HTTP_ARG_OBJ(class, name, allow_null)                            ZEND_ARG_OBJ_INFO(1, name, class, allow_null)
 300 #endif
 301
 302 #ifdef HTTP_HAVE_CURL
 303 #       ifdef ZEND_ENGINE_2
 304 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 305                         static \
 306                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
 307                                 ZEND_ARG_PASS_INFO(0) \
 308                                 ZEND_ARG_PASS_INFO(0) \
 309                                 ZEND_ARG_PASS_INFO(1) \
 310                         ZEND_END_ARG_INFO(); \
 311  \
 312                         static \
 313                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
 314                                 ZEND_ARG_PASS_INFO(0) \
 315                                 ZEND_ARG_PASS_INFO(0) \
 316                                 ZEND_ARG_PASS_INFO(0) \
 317                                 ZEND_ARG_PASS_INFO(1) \
 318                         ZEND_END_ARG_INFO(); \
 319  \
 320                         static \
 321                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
 322                                 ZEND_ARG_PASS_INFO(0) \
 323                                 ZEND_ARG_PASS_INFO(0) \
 324                                 ZEND_ARG_PASS_INFO(0) \
 325                                 ZEND_ARG_PASS_INFO(0) \
 326                                 ZEND_ARG_PASS_INFO(1) \
 327                         ZEND_END_ARG_INFO(); \
 328  \
 329                         static \
 330                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_all, 1) \
 331                                 ZEND_ARG_PASS_INFO(1) \
 332                         ZEND_END_ARG_INFO()
 333 #       else
 334 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 335                         static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 336                         static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 337                         static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 338                         static unsigned char http_arg_pass_ref_all[]={1, BYREF_FORCE_REST}
 339 #       endif /* ZEND_ENGINE_2 */
 340 #else
 341 #       define HTTP_DECLARE_ARG_PASS_INFO()
 342 #endif /* HTTP_HAVE_CURL */
 343
 344
 345 #ifndef TSRMLS_FETCH_FROM_CTX
 346 #       ifdef ZTS
 347 #               define TSRMLS_FETCH_FROM_CTX(ctx)       void ***tsrm_ls = (void ***) ctx
 348 #       else
 349 #               define TSRMLS_FETCH_FROM_CTX(ctx)
 350 #       endif
 351 #endif
 352
 353 #ifndef TSRMLS_SET_CTX
 354 #       ifdef ZTS
 355 #               define TSRMLS_SET_CTX(ctx)      ctx = (void ***) tsrm_ls
 356 #       else
 357 #               define TSRMLS_SET_CTX(ctx)
 358 #       endif
 359 #endif
 360
 361
 362
 363 #endif /* PHP_HTTP_STD_DEFS_H */
 364
 365 /*
 366  * Local variables:
 367  * tab-width: 4
 368  * c-basic-offset: 4
 369  * End:
 370  * vim600: noet sw=4 ts=4 fdm=marker
 371  * vim<600: noet sw=4 ts=4
 372  */
 373