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