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