git.m6w6.name Git - m6w6/ext-http/blob - php_http_std_defs.h

   1 /*
   2     +--------------------------------------------------------------------+
   3     | PECL :: http                                                       |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted provided that the conditions mentioned |
   7     | in the accompanying LICENSE file are met.                          |
   8     +--------------------------------------------------------------------+
   9     | Copyright (c) 2004-2010, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #ifndef PHP_HTTP_STD_DEFS_H
  16 #define PHP_HTTP_STD_DEFS_H
  17
  18 #if defined(PHP_WIN32)
  19 #       if defined(HTTP_EXPORTS)
  20 #               define PHP_HTTP_API __declspec(dllexport)
  21 #       elif defined(COMPILE_DL_HTTP)
  22 #               define PHP_HTTP_API __declspec(dllimport)
  23 #       else
  24 #               define PHP_HTTP_API
  25 #       endif
  26 #else
  27 #       define PHP_HTTP_API
  28 #endif
  29
  30 /* make functions that return SUCCESS|FAILURE more obvious */
  31 typedef int STATUS;
  32
  33 /* lenof() */
  34 #define lenof(S) (sizeof(S) - 1)
  35
  36 #ifndef MIN
  37 #       define MIN(a,b) (a<b?a:b)
  38 #endif
  39 #ifndef MAX
  40 #       define MAX(a,b) (a>b?a:b)
  41 #endif
  42
  43 /* STR_SET() */
  44 #ifndef STR_SET
  45 #       define STR_SET(STR, SET) \
  46         { \
  47                 STR_FREE(STR); \
  48                 STR = SET; \
  49         }
  50 #endif
  51
  52 #define STR_PTR(s) (s?s:"")
  53
  54 #define INIT_ZARR(zv, ht) \
  55         { \
  56                 INIT_PZVAL(&(zv)); \
  57                 Z_TYPE(zv) = IS_ARRAY; \
  58                 Z_ARRVAL(zv) = (ht); \
  59         }
  60
  61 #ifndef MAKE_COPY_ZVAL
  62 # define MAKE_COPY_ZVAL(ppzv, pzv) \
  63         *(pzv) = **(ppzv);            \
  64         zval_copy_ctor((pzv));        \
  65         INIT_PZVAL((pzv));
  66 #endif
  67
  68 /* return bool (v == SUCCESS) */
  69 #define RETVAL_SUCCESS(v) RETVAL_BOOL(SUCCESS == (v))
  70 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
  71 /* return object(values) */
  72 #define RETVAL_OBJECT(o, addref) \
  73         RETVAL_OBJVAL((o)->value.obj, addref)
  74 #define RETURN_OBJECT(o, addref) \
  75         RETVAL_OBJECT(o, addref); \
  76         return
  77 #define RETVAL_OBJVAL(ov, addref) \
  78         ZVAL_OBJVAL(return_value, ov, addref)
  79 #define RETURN_OBJVAL(ov, addref) \
  80         RETVAL_OBJVAL(ov, addref); \
  81         return
  82 #define ZVAL_OBJVAL(zv, ov, addref) \
  83         (zv)->type = IS_OBJECT; \
  84         (zv)->value.obj = (ov);\
  85         if (addref && Z_OBJ_HT_P(zv)->add_ref) { \
  86                 Z_OBJ_HT_P(zv)->add_ref((zv) TSRMLS_CC); \
  87         }
  88 /* return property */
  89 #define RETVAL_PROP(n) RETVAL_PROP_EX(getThis(), n)
  90 #define RETURN_PROP(n) RETURN_PROP_EX(getThis(), n)
  91 #define RETVAL_PROP_EX(this, n) \
  92         { \
  93                 zval *__prop = zend_read_property(THIS_CE, this, ZEND_STRS(#n)-1, 0 TSRMLS_CC); \
  94                 RETVAL_ZVAL(__prop, 1, 0); \
  95         }
  96 #define RETURN_PROP_EX(this, n) \
  97         { \
  98                 zval *__prop = zend_read_property(THIS_CE, this, ZEND_STRS(#n)-1, 0 TSRMLS_CC); \
  99                 RETURN_ZVAL(__prop, 1, 0); \
 100         }
 101
 102 /* function accepts no args */
 103 #define NO_ARGS zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "");
 104
 105 /* CR LF */
 106 #define HTTP_CRLF "\r\n"
 107
 108 /* default cache control */
 109 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
 110
 111 /* max URL length */
 112 #define HTTP_URL_MAXLEN 4096
 113
 114 /* max request method length */
 115 #define HTTP_REQUEST_METHOD_MAXLEN 31
 116
 117 /* def URL arg separator */
 118 #define HTTP_URL_ARGSEP "&"
 119
 120 /* send buffer size */
 121 #define HTTP_SENDBUF_SIZE 40960
 122
 123 /* CURL buffer size */
 124 #define HTTP_CURLBUF_SIZE 16384
 125
 126 /* known methods */
 127 #define HTTP_KNOWN_METHODS \
 128                 /* HTTP 1.1 */ \
 129                 "GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, CONNECT, " \
 130                 /* WebDAV - RFC 2518 */ \
 131                 "PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, " \
 132                 /* WebDAV Versioning - RFC 3253 */ \
 133                 "VERSION-CONTROL, REPORT, CHECKOUT, CHECKIN, UNCHECKOUT, " \
 134                 "MKWORKSPACE, UPDATE, LABEL, MERGE, BASELINE-CONTROL, MKACTIVITY, " \
 135                 /* WebDAV Access Control - RFC 3744 */ \
 136                 "ACL, " \
 137                 /* END */
 138
 139 #ifdef ZEND_ENGINE_2
 140 #       include "ext/standard/file.h"
 141 #       define HTTP_DEFAULT_STREAM_CONTEXT FG(default_context)
 142 #else
 143 #       define HTTP_DEFAULT_STREAM_CONTEXT NULL
 144 #endif
 145
 146 #define HTTP_PHP_INI_ENTRY(entry, default, scope, updater, global) \
 147         STD_PHP_INI_ENTRY(entry, default, scope, updater, global, zend_http_globals, http_globals)
 148 #define HTTP_PHP_INI_ENTRY_EX(entry, default, scope, updater, displayer, global) \
 149         STD_PHP_INI_ENTRY_EX(entry, default, scope, updater, global, zend_http_globals, http_globals, displayer)
 150
 151
 152 #define HTTP_LONG_CONSTANT(name, const) REGISTER_LONG_CONSTANT(name, const, CONST_CS | CONST_PERSISTENT)
 153
 154 /* {{{ objects & properties */
 155 #ifdef ZEND_ENGINE_2
 156
 157 #       define HTTP_STATIC_ME_ALIAS(me, al, ai) ZEND_FENTRY(me, ZEND_FN(al), ai, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
 158
 159 #       define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
 160         { \
 161                 zend_class_entry ce; \
 162                 memset(&ce, 0, sizeof(zend_class_entry)); \
 163                 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
 164                 ce.create_object = _ ##name## _new; \
 165                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 166                 name## _ce->ce_flags |= flags;  \
 167                 memcpy(& name## _handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
 168         }
 169
 170 #       define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
 171         { \
 172                 zend_class_entry ce; \
 173                 memset(&ce, 0, sizeof(zend_class_entry)); \
 174                 INIT_CLASS_ENTRY(ce, #classname, name## _fe); \
 175                 ce.create_object = NULL; \
 176                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 177                 name## _ce->ce_flags |= flags;  \
 178         }
 179
 180 #       define HTTP_REGISTER_EXCEPTION(classname, cename, parent) \
 181         { \
 182                 zend_class_entry ce; \
 183                 memset(&ce, 0, sizeof(zend_class_entry)); \
 184                 INIT_CLASS_ENTRY(ce, #classname, NULL); \
 185                 ce.create_object = NULL; \
 186                 cename = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
 187         }
 188
 189 #       define getObject(t, o) getObjectEx(t, o, getThis())
 190 #       define getObjectEx(t, o, v) t * o = ((t *) zend_object_store_get_object(v TSRMLS_CC))
 191 #       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);
 192 #       define freeObject(o) \
 193                         zend_object_std_dtor(&o->zo TSRMLS_CC); \
 194                         efree(o);
 195 #       define OBJ_PROP(o) (o)->zo.properties
 196 #       define OBJ_GUARDS(o) (o)->zo.guards
 197
 198 #       define ACC_PROP_PRIVATE(ce, flags)              ((flags & ZEND_ACC_PRIVATE) && (EG(scope) && ce == EG(scope))
 199 #       define ACC_PROP_PROTECTED(ce, flags)    ((flags & ZEND_ACC_PROTECTED) && (zend_check_protected(ce, EG(scope))))
 200 #       define ACC_PROP_PUBLIC(flags)                   (flags & ZEND_ACC_PUBLIC)
 201 #       define ACC_PROP(ce, flags)                              (ACC_PROP_PUBLIC(flags) || ACC_PROP_PRIVATE(ce, flags) || ACC_PROP_PROTECTED(ce, flags))
 202
 203 #       define SET_EH_THROW_HTTP() SET_EH_THROW_EX(http_exception_get_default())
 204 #       define SET_EH_THROW_EX(ex) php_set_error_handling(EH_THROW, ex TSRMLS_CC)
 205 #       define SET_EH_NORMAL() php_set_error_handling(EH_NORMAL, NULL TSRMLS_CC)
 206
 207 #endif /* ZEND_ENGINE_2 */
 208 /* }}} */
 209
 210 #ifdef ZEND_ENGINE_2
 211 #       define with_error_handling(eh, ec) \
 212         { \
 213                 error_handling_t __eh = GLOBAL_ERROR_HANDLING; \
 214                 zend_class_entry *__ec= GLOBAL_EXCEPTION_CLASS; \
 215                 php_set_error_handling(eh, ec TSRMLS_CC);
 216 #       define end_error_handling() \
 217                 php_set_error_handling(__eh, __ec TSRMLS_CC); \
 218         }
 219 #else
 220 #       define with_error_handling(eh, ec)
 221 #       define end_error_handling()
 222 #endif
 223
 224 #if (PHP_MAJOR_VERSION == 5 && PHP_MINOR_VERSION >= 2) || PHP_MAJOR_VERSION > 5
 225 #       define  ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default(TSRMLS_C)
 226 #else
 227 #       define  ZEND_EXCEPTION_GET_DEFAULT() zend_exception_get_default()
 228 #endif
 229
 230 #ifndef E_THROW
 231 #       define E_THROW 0
 232 #endif
 233 #ifdef ZEND_ENGINE_2
 234 #       define HE_THROW         E_THROW TSRMLS_CC
 235 #       define HE_NOTICE        (HTTP_G->only_exceptions ? E_THROW : E_NOTICE) TSRMLS_CC
 236 #       define HE_WARNING       (HTTP_G->only_exceptions ? E_THROW : E_WARNING) TSRMLS_CC
 237 #       define HE_ERROR         (HTTP_G->only_exceptions ? E_THROW : E_ERROR) TSRMLS_CC
 238 #else
 239 #       define HE_THROW         E_WARNING TSRMLS_CC
 240 #       define HE_NOTICE        E_NOTICE TSRMLS_CC
 241 #       define HE_WARNING       E_WARNING TSRMLS_CC
 242 #       define HE_ERROR         E_ERROR TSRMLS_CC
 243 #endif
 244
 245 #define HTTP_E_RUNTIME                          1L
 246 #define HTTP_E_INVALID_PARAM            2L
 247 #define HTTP_E_HEADER                           3L
 248 #define HTTP_E_MALFORMED_HEADERS        4L
 249 #define HTTP_E_REQUEST_METHOD           5L
 250 #define HTTP_E_MESSAGE_TYPE                     6L
 251 #define HTTP_E_ENCODING                         7L
 252 #define HTTP_E_REQUEST                          8L
 253 #define HTTP_E_REQUEST_POOL                     9L
 254 #define HTTP_E_SOCKET                           10L
 255 #define HTTP_E_RESPONSE                         11L
 256 #define HTTP_E_URL                                      12L
 257 #define HTTP_E_QUERYSTRING                      13L
 258
 259 #ifdef ZEND_ENGINE_2
 260 #       define HTTP_BEGIN_ARGS_EX(class, method, ret_ref, req_args)     HTTP_STATIC_ARG_INFO ZEND_BEGIN_ARG_INFO_EX(args_for_ ##class## _ ##method , 0, ret_ref, req_args)
 261 #       define HTTP_BEGIN_ARGS_AR(class, method, ret_ref, req_args)     HTTP_STATIC_ARG_INFO ZEND_BEGIN_ARG_INFO_EX(args_for_ ##class## _ ##method , 1, ret_ref, req_args)
 262 #       define HTTP_END_ARGS                                                                            }
 263 #       define HTTP_EMPTY_ARGS_EX(class, method, ret_ref)                       HTTP_BEGIN_ARGS_EX(class, method, ret_ref, 0) HTTP_END_ARGS
 264 #       define HTTP_ARGS(class, method)                                                         args_for_ ##class## _ ##method
 265 #       define HTTP_ARG_VAL(name, pass_ref)                                                     ZEND_ARG_INFO(pass_ref, name)
 266 #       define HTTP_ARG_OBJ(class, name, allow_null)                            ZEND_ARG_OBJ_INFO(0, name, class, allow_null)
 267 #endif
 268
 269 #ifdef ZEND_ENGINE_2
 270 #       define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
 271 #else
 272 #       define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL}
 273 #endif
 274
 275 #ifdef HTTP_HAVE_CURL
 276 #       ifdef ZEND_ENGINE_2
 277 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 278                         HTTP_STATIC_ARG_INFO \
 279                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
 280                                 ZEND_ARG_PASS_INFO(0) \
 281                                 ZEND_ARG_PASS_INFO(1) \
 282                         ZEND_END_ARG_INFO(); \
 283  \
 284                         HTTP_STATIC_ARG_INFO \
 285                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_3, 0) \
 286                                 ZEND_ARG_PASS_INFO(0) \
 287                                 ZEND_ARG_PASS_INFO(0) \
 288                                 ZEND_ARG_PASS_INFO(1) \
 289                         ZEND_END_ARG_INFO(); \
 290  \
 291                         HTTP_STATIC_ARG_INFO \
 292                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
 293                                 ZEND_ARG_PASS_INFO(0) \
 294                                 ZEND_ARG_PASS_INFO(0) \
 295                                 ZEND_ARG_PASS_INFO(0) \
 296                                 ZEND_ARG_PASS_INFO(1) \
 297                         ZEND_END_ARG_INFO(); \
 298  \
 299                         HTTP_STATIC_ARG_INFO \
 300                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_5, 0) \
 301                                 ZEND_ARG_PASS_INFO(0) \
 302                                 ZEND_ARG_PASS_INFO(0) \
 303                                 ZEND_ARG_PASS_INFO(0) \
 304                                 ZEND_ARG_PASS_INFO(0) \
 305                                 ZEND_ARG_PASS_INFO(1) \
 306                         ZEND_END_ARG_INFO();
 307
 308 #       else
 309 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 310                         static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
 311                         static unsigned char http_arg_pass_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 312                         static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE}; \
 313                         static unsigned char http_arg_pass_ref_5[] = {5, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
 314 #       endif /* ZEND_ENGINE_2 */
 315 #else
 316 #       ifdef ZEND_ENGINE_2
 317 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 318                         HTTP_STATIC_ARG_INFO \
 319                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_2, 0) \
 320                                 ZEND_ARG_PASS_INFO(0) \
 321                                 ZEND_ARG_PASS_INFO(1) \
 322                         ZEND_END_ARG_INFO(); \
 323 \
 324                         HTTP_STATIC_ARG_INFO \
 325                         ZEND_BEGIN_ARG_INFO(http_arg_pass_ref_4, 0) \
 326                                 ZEND_ARG_PASS_INFO(0) \
 327                                 ZEND_ARG_PASS_INFO(0) \
 328                                 ZEND_ARG_PASS_INFO(0) \
 329                                 ZEND_ARG_PASS_INFO(1) \
 330                         ZEND_END_ARG_INFO();
 331 #       else
 332 #               define HTTP_DECLARE_ARG_PASS_INFO() \
 333                         static unsigned char http_arg_pass_ref_2[] = {2, BYREF_NONE, BYREF_FORCE}; \
 334                         static unsigned char http_arg_pass_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
 335 #       endif /* ZEND_ENGINE_2 */
 336 #endif /* HTTP_HAVE_CURL */
 337
 338
 339 #ifndef HAVE_CURL_SHARE_STRERROR
 340 #       define curl_share_strerror(dummy) "unknown error"
 341 #endif
 342 #ifndef HAVE_CURL_EASY_STRERROR
 343 #       define curl_easy_strerror(dummy) "unknown error"
 344 #endif
 345 #ifndef HAVE_CURL_MULTI_STRERROR
 346 #       define curl_multi_strerror(dummy) "unknown error"
 347 #endif
 348
 349 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
 350 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
 351 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
 352 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
 353
 354 #define Z_OBJ_DELREF(z) \
 355         if (Z_OBJ_HT(z)->del_ref) { \
 356                 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
 357         }
 358 #define Z_OBJ_ADDREF(z) \
 359         if (Z_OBJ_HT(z)->add_ref) { \
 360                 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
 361         }
 362 #define Z_OBJ_DELREF_P(z) \
 363         if (Z_OBJ_HT_P(z)->del_ref) { \
 364                 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
 365         }
 366 #define Z_OBJ_ADDREF_P(z) \
 367         if (Z_OBJ_HT_P(z)->add_ref) { \
 368                 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
 369         }
 370 #define Z_OBJ_DELREF_PP(z) \
 371         if (Z_OBJ_HT_PP(z)->del_ref) { \
 372                 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
 373         }
 374 #define Z_OBJ_ADDREF_PP(z) \
 375         if (Z_OBJ_HT_PP(z)->add_ref) { \
 376                 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
 377         }
 378
 379 #endif /* PHP_HTTP_STD_DEFS_H */
 380
 381 /*
 382  * Local variables:
 383  * tab-width: 4
 384  * c-basic-offset: 4
 385  * End:
 386  * vim600: noet sw=4 ts=4 fdm=marker
 387  * vim<600: noet sw=4 ts=4
 388  */
 389