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