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 /* 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                 zend_hash_init(& name## _ce->constants_table, 0, NULL, ZVAL_INTERNAL_PTR_DTOR, 1); \
 182                 name## _declare_default_properties(); \
 183         }
 184
 185 #       define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
 186         { \
 187                 zend_class_entry ce; \
 188                 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
 189                 ce.create_object = NULL; \
 190                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 191                 name## _ce->ce_flags |= flags;  \
 192         }
 193
 194 #       define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
 195         { \
 196                 zend_class_entry ce; \
 197                 INIT_CLASS_ENTRY(ce, #classname, NULL); \
 198                 ce.create_object = NULL; \
 199                 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 200         }
 201
 202 #       define getObject(t, o) getObjectEx(t, o, getThis())
 203 #       define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
 204 #       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);
 205 #       define OBJ_PROP(o) (o)->zo.properties
 206 #       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)
 207 #       define DCL_STATIC_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
 208 #       define DCL_STATIC_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n), (ZEND_ACC_ ##a | ZEND_ACC_STATIC) TSRMLS_CC)
 209 #       define GET_STATIC_PROP_EX(ce, n) zend_std_get_static_property(ce, (#n), sizeof(#n), 0 TSRMLS_CC)
 210 #ifdef zend_update_class_constants
 211 #       define USE_STATIC_PROP_EX(ce) zend_update_class_constants(ce TSRMLS_CC)
 212 #else
 213 #       define USE_STATIC_PROP_EX(ce)
 214 #endif
 215 #       define SET_STATIC_PROP_EX(ce, n, v) zend_update_static_property(ce, #n, sizeof(#n), v TSRMLS_CC)
 216 #       define SET_STATIC_PROP_STRING_EX(ce, n, s, d) \
 217         { \
 218                 char *c = (s); \
 219                 zend_update_static_property_string(ce, #n, sizeof(#n), (c) TSRMLS_CC); \
 220                 if (!d) { \
 221                         efree(c); \
 222                 } \
 223         }
 224 #       define SET_STATIC_PROP_STRINGL_EX(ce, n, s, l, d) \
 225         { \
 226                 char *c = (s); \
 227                 zend_update_static_property_stringl(ce, #n, sizeof(#n), (c), (l) TSRMLS_CC); \
 228                 if (!d) { \
 229                         efree(c); \
 230                 }\
 231         }
 232 #       define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
 233 #       define DCL_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n)-1, (v), (ZEND_ACC_ ##a) TSRMLS_CC)
 234 #       define DCL_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n)-1, (ZEND_ACC_ ##a) TSRMLS_CC)
 235 #       define UPD_PROP(o, t, n, v) UPD_PROP_EX(o, getThis(), t, n, v)
 236 #       define UPD_PROP_EX(o, this, t, n, v) zend_update_property_ ##t(o->zo.ce, this, (#n), sizeof(#n)-1, (v) TSRMLS_CC)
 237 #       define SET_PROP(o, n, z) SET_PROP_EX(o, getThis(), n, z)
 238 #       define SET_PROP_EX(o, this, n, z) zend_update_property(o->zo.ce, this, (#n), sizeof(#n)-1, (z) TSRMLS_CC)
 239 #       define GET_PROP(o, n) GET_PROP_EX(o, getThis(), n)
 240 #       define GET_PROP_EX(o, this, n) zend_read_property(o->zo.ce, this, (#n), sizeof(#n)-1, 0 TSRMLS_CC)
 241
 242 #       define DCL_CONST(t, n, v) zend_declare_class_constant_ ##t(ce, (n), sizeof(n), (v) TSRMLS_CC)
 243
 244 #       define ACC_PROP_PRIVATE(ce, flags)              ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
 245 #       define ACC_PROP_PROTECTED(ce, flags)    ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
 246 #       define ACC_PROP_PUBLIC(flags)                   (flags & ZEND_ACC_PUBLIC)
 247 #       define ACC_PROP(ce, flags)                              (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
 248
 249 #       define INIT_PARR(o, n) \
 250         { \
 251                 zval *__tmp; \
 252                 MAKE_STD_ZVAL(__tmp); \
 253                 array_init(__tmp); \
 254                 SET_PROP(o, n, __tmp); \
 255         }
 256
 257 #       define FREE_PARR(o, p) \
 258         { \
 259                 zval *__tmp = GET_PROP(o, p); \
 260                 if (__tmp) { \
 261                         zval_dtor(__tmp); \
 262                         FREE_ZVAL(__tmp); \
 263                         __tmp = NULL; \
 264                 } \
 265         }
 266
 267 #       define SET_EH_THROW() SET_EH_THROW_EX(zend_exception_get_default())
 268 #       define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
 269 #       define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
 270 #       define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
 271
 272 #endif /* ZEND_ENGINE_2 */
 273 /* }}} */
 274
 275 #ifndef E_THROW
 276 #       define E_THROW 0
 277 #endif
 278 #define HE_THROW        E_THROW
 279 #ifdef ZEND_ENGINE_2
 280 #       define HE_NOTICE        (HTTP_G(only_exceptions) ? E_THROW : E_NOTICE)
 281 #       define HE_WARNING       (HTTP_G(only_exceptions) ? E_THROW : E_WARNING)
 282 #       define HE_ERROR         (HTTP_G(only_exceptions) ? E_THROW : E_ERROR)
 283 #else
 284 #       define HE_NOTICE        E_NOTICE
 285 #       define HE_WARNING       E_WARNING
 286 #       define HE_ERROR         E_ERROR
 287 #endif
 288
 289 #define HTTP_E_RUNTIME                          1L
 290 #define HTTP_E_INVALID_PARAM            2L
 291 #define HTTP_E_HEADER                           3L
 292 #define HTTP_E_MALFORMED_HEADERS        4L
 293 #define HTTP_E_REQUEST_METHOD           5L
 294 #define HTTP_E_MESSAGE_TYPE                     6L
 295 #define HTTP_E_ENCODING                         7L
 296 #define HTTP_E_REQUEST                          8L
 297 #define HTTP_E_REQUEST_POOL                     9L
 298 #define HTTP_E_SOCKET                           10L
 299 #define HTTP_E_RESPONSE                         11L
 300 #define HTTP_E_URL                                      12L
 301
 302 #ifdef ZEND_ENGINE_2
 303 #       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)
 304 #       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)
 305 #       define HTTP_END_ARGS                                                                            }
 306 #       define HTTP_EMPTY_ARGS_EX(class, method, ret_ref)                       HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
 307 #       define HTTP_ARGS(class, method)                                                         args_for_ ##class## _ ##method
 308 #       define HTTP_ARG_VAL(name, pass_ref)                                                     ZEND_ARG_INFO(pass_ref, name)
 309 #       define HTTP_ARG_OBJ(class, name, allow_null)                            ZEND_ARG_OBJ_INFO(1, name, class, allow_null)
 310 #endif
 311
 312 #ifdef HTTP_HAVE_CURL
 313 #       ifdef ZEND_ENGINE_2
 314 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 315                         static \
 316                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 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_4, 0) \
 324                                 ZEND_ARG_PASS_INFO(0) \
 325                                 ZEND_ARG_PASS_INFO(0) \
 326                                 ZEND_ARG_PASS_INFO(0) \
 327                                 ZEND_ARG_PASS_INFO(1) \
 328                         ZEND_END_ARG_INFO(); \
 329  \
 330                         static \
 331                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
 332                                 ZEND_ARG_PASS_INFO(0) \
 333                                 ZEND_ARG_PASS_INFO(0) \
 334                                 ZEND_ARG_PASS_INFO(0) \
 335                                 ZEND_ARG_PASS_INFO(0) \
 336                                 ZEND_ARG_PASS_INFO(1) \
 337                         ZEND_END_ARG_INFO(); \
 338  \
 339                         static \
 340                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_all, 1) \
 341                                 ZEND_ARG_PASS_INFO(1) \
 342                         ZEND_END_ARG_INFO()
 343 #       else
 344 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 345                         static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 346                         static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 347                         static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 348                         static unsigned char http_arg_pass_ref_all[]={1, BYREF_FORCE_REST}
 349 #       endif /* ZEND_ENGINE_2 */
 350 #else
 351 #       define HTTP_DECLARE_ARG_PASS_INFO()
 352 #endif /* HTTP_HAVE_CURL */
 353
 354
 355 #ifndef TSRMLS_FETCH_FROM_CTX
 356 #       ifdef ZTS
 357 #               define TSRMLS_FETCH_FROM_CTX(ctx)       void ***tsrm_ls = (void ***) ctx
 358 #       else
 359 #               define TSRMLS_FETCH_FROM_CTX(ctx)
 360 #       endif
 361 #endif
 362
 363 #ifndef TSRMLS_SET_CTX
 364 #       ifdef ZTS
 365 #               define TSRMLS_SET_CTX(ctx)      ctx = (void ***) tsrm_ls
 366 #       else
 367 #               define TSRMLS_SET_CTX(ctx)
 368 #       endif
 369 #endif
 370
 371
 372
 373 #endif /* PHP_HTTP_STD_DEFS_H */
 374
 375 /*
 376  * Local variables:
 377  * tab-width: 4
 378  * c-basic-offset: 4
 379  * End:
 380  * vim600: noet sw=4 ts=4 fdm=marker
 381  * vim<600: noet sw=4 ts=4
 382  */
 383