git.m6w6.name Git - m6w6/ext-http/blob - php_http_api.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_API_H
  16 #define PHP_HTTP_API_H
  17
  18 #define HTTP_SUPPORT                            0x01L
  19 #define HTTP_SUPPORT_REQUESTS           0x02L
  20 #define HTTP_SUPPORT_MAGICMIME          0x04L
  21 #define HTTP_SUPPORT_ENCODINGS          0x08L
  22 #define HTTP_SUPPORT_SSLREQUESTS        0x20L
  23 #define HTTP_SUPPORT_PERSISTENCE        0x40L
  24 #define HTTP_SUPPORT_EVENTS                     0x80L
  25
  26 #define HTTP_PARAMS_ALLOW_COMMA         0x01
  27 #define HTTP_PARAMS_ALLOW_FAILURE       0x02
  28 #define HTTP_PARAMS_RAISE_ERROR         0x04
  29 #define HTTP_PARAMS_DEFAULT     (HTTP_PARAMS_ALLOW_COMMA|HTTP_PARAMS_ALLOW_FAILURE|HTTP_PARAMS_RAISE_ERROR)
  30 #define HTTP_PARAMS_COLON_SEPARATOR     0x10
  31
  32 extern PHP_MINIT_FUNCTION(http_support);
  33
  34 #define http_support(f) _http_support(f)
  35 PHP_HTTP_API long _http_support(long feature);
  36
  37 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
  38 extern char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
  39
  40 #define http_boundary(b, l) _http_boundary((b), (l) TSRMLS_CC)
  41 extern size_t _http_boundary(char *buf, size_t len TSRMLS_DC);
  42
  43 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
  44 #define http_error_ex _http_error_ex
  45 extern void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...);
  46
  47
  48 #ifdef ZEND_ENGINE_2
  49 #define http_exception_wrap(o, n, ce) _http_exception_wrap((o), (n), (ce) TSRMLS_CC)
  50 extern zval *_http_exception_wrap(zval *old_exception, zval *new_exception, zend_class_entry *ce TSRMLS_DC);
  51
  52 #define http_try \
  53 { \
  54                 zval *old_exception = EG(exception); \
  55                 EG(exception) = NULL;
  56 #define http_catch(ex_ce) \
  57                 if (EG(exception) && old_exception) { \
  58                         EG(exception) = http_exception_wrap(old_exception, EG(exception), ex_ce); \
  59                 } \
  60 }
  61 #define http_final(ex_ce) \
  62         if (EG(exception)) { \
  63                 EG(exception) = http_exception_wrap(EG(exception), NULL, ex_ce); \
  64         }
  65
  66 typedef zend_object_value (*http_object_new_t)(zend_class_entry *ce, void *, void ** TSRMLS_DC);
  67
  68 #define http_object_new(ov, cn, cl, co, ce, i, pp) _http_object_new((ov), (cn), (cl), (http_object_new_t) (co), (ce), (i), (void *) (pp) TSRMLS_CC)
  69 extern STATUS _http_object_new(zend_object_value *ov, const char *cname_str, uint cname_len, http_object_new_t create, zend_class_entry *parent_ce, void *intern_ptr, void **obj_ptr TSRMLS_DC);
  70 #endif /* ZEND_ENGINE_2 */
  71
  72
  73 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
  74         if ((!(ch)) && (!((ch) = init))) { \
  75                 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
  76                 action; \
  77         }
  78 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
  79         if (!strchr((ct), '/')) { \
  80                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
  81                         "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
  82                 action; \
  83         }
  84 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
  85                 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
  86                         http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
  87                         action; \
  88                 }
  89 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
  90                 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
  91                         http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
  92                         action; \
  93                 }
  94 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
  95         if (level < -1 || level > 9) { \
  96                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
  97                 action; \
  98         }
  99 #ifndef PHP_OUTPUT_NEWAPI
 100 #       define HTTP_GET_OUTPUT_START() \
 101                 char *output_start_filename = php_get_output_start_filename(TSRMLS_C); \
 102                 int output_start_lineno = php_get_output_start_lineno(TSRMLS_C)
 103 #else
 104 #       define HTTP_GET_OUTPUT_START() \
 105                 char *output_start_filename = php_output_get_start_filename(TSRMLS_C); \
 106                 int output_start_lineno = php_output_get_start_lineno(TSRMLS_C)
 107 #endif
 108 #define HTTP_CHECK_HEADERS_SENT(action) \
 109         if (SG(headers_sent) && !SG(request_info).no_headers) { \
 110                 HTTP_GET_OUTPUT_START(); \
 111                 if (output_start_filename) { \
 112                         http_error_ex(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent by (output started at %s:%d)", \
 113                                 output_start_filename, output_start_lineno); \
 114                 } else { \
 115                         http_error(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent"); \
 116                 } \
 117                 action; \
 118         }
 119
 120 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
 121 extern void _http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC);
 122
 123 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
 124 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
 125 extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC);
 126
 127 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
 128 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
 129 extern STATUS _http_check_method_ex(const char *method, const char *methods);
 130
 131 #define http_got_server_var(v) (NULL != http_get_server_var_ex((v), strlen(v), 1))
 132 #define http_get_server_var(v, c) http_get_server_var_ex((v), strlen(v), (c))
 133 #define http_get_server_var_ex(v, l, c) _http_get_server_var_ex((v), (l), (c) TSRMLS_CC)
 134 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_len, zend_bool check TSRMLS_DC);
 135
 136 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
 137 #define http_get_request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
 138 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
 139
 140 #define http_get_request_body_stream() _http_get_request_body_stream(TSRMLS_C)
 141 PHP_HTTP_API php_stream *_http_get_request_body_stream(TSRMLS_D);
 142
 143
 144 typedef void (*http_parse_params_callback)(void *cb_arg, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
 145
 146 #define http_parse_params_default_callback _http_parse_params_default_callback
 147 PHP_HTTP_API void _http_parse_params_default_callback(void *ht, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
 148
 149 #define http_parse_params(s, f, ht) _http_parse_params_ex((s), (f), _http_parse_params_default_callback, (ht) TSRMLS_CC)
 150 #define http_parse_params_ex(s, f, cb, a) _http_parse_params_ex((s), (f), (cb), (a) TSRMLS_CC)
 151 PHP_HTTP_API STATUS _http_parse_params_ex(const char *params, int flags, http_parse_params_callback cb, void *cb_arg TSRMLS_DC);
 152
 153
 154 #define http_sleep(s) _http_sleep(s)
 155 static inline void _http_sleep(double s)
 156 {
 157 #define HTTP_DIFFSEC (0.001)
 158 #define HTTP_MLLISEC (1000)
 159 #define HTTP_MCROSEC (1000 * 1000)
 160 #define HTTP_NANOSEC (1000 * 1000 * 1000)
 161 #define HTTP_MSEC(s) ((long)(s * HTTP_MLLISEC))
 162 #define HTTP_USEC(s) ((long)(s * HTTP_MCROSEC))
 163 #define HTTP_NSEC(s) ((long)(s * HTTP_NANOSEC))
 164
 165 #if defined(PHP_WIN32)
 166         Sleep((DWORD) HTTP_MSEC(s));
 167 #elif defined(HAVE_USLEEP)
 168         usleep(HTTP_USEC(s));
 169 #elif defined(HAVE_NANOSLEEP)
 170         struct timespec req, rem;
 171
 172         req.tv_sec = (time_t) s;
 173         req.tv_nsec = HTTP_NSEC(s) % HTTP_NANOSEC;
 174
 175         while (nanosleep(&req, &rem) && (errno == EINTR) && (HTTP_NSEC(rem.tv_sec) + rem.tv_nsec) > HTTP_NSEC(HTTP_DIFFSEC))) {
 176                 req.tv_sec = rem.tv_sec;
 177                 req.tv_nsec = rem.tv_nsec;
 178         }
 179 #else
 180         struct timeval timeout;
 181
 182         timeout.tv.sec = (time_t) s;
 183         timeout.tv_usec = HTTP_USEC(s) % HTTP_MCROSEC;
 184
 185         select(0, NULL, NULL, NULL, &timeout);
 186 #endif
 187 }
 188
 189 #define http_locate_str _http_locate_str
 190 static inline const char *_http_locate_str(const char *h, size_t h_len, const char *n, size_t n_len)
 191 {
 192         const char *p, *e;
 193
 194         if (n_len && h_len) {
 195                 e = h + h_len;
 196                 do {
 197                         if (*h == *n) {
 198                                 for (p = n; *p == h[p-n]; ++p) {
 199                                         if (p == n+n_len-1) {
 200                                                 return h;
 201                                         }
 202                                 }
 203                         }
 204                 } while (h++ != e);
 205         }
 206
 207         return NULL;
 208 }
 209
 210 #define http_locate_body _http_locate_body
 211 static inline const char *_http_locate_body(const char *message)
 212 {
 213         const char *body = NULL, *msg = message;
 214
 215         while (*msg) {
 216                 if (*msg == '\n') {
 217                         if (*(msg+1) == '\n') {
 218                                 body = msg + 2;
 219                                 break;
 220                         } else if (*(msg+1) == '\r' && *(msg+2) == '\n') {
 221                                 body = msg + 3;
 222                                 break;
 223                         }
 224                 }
 225                 ++msg;
 226         }
 227         return body;
 228 }
 229
 230 #define http_locate_eol _http_locate_eol
 231 static inline const char *_http_locate_eol(const char *line, int *eol_len)
 232 {
 233         const char *eol = strpbrk(line, "\r\n");
 234
 235         if (eol_len) {
 236                 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
 237         }
 238         return eol;
 239 }
 240
 241 #define http_zset(t, z) _http_zset((t), (z))
 242 static inline zval *_http_zset(int type, zval *z)
 243 {
 244         if (Z_TYPE_P(z) != type) {
 245                 switch (type) {
 246                         case IS_NULL:   convert_to_null(z);             break;
 247                         case IS_BOOL:   convert_to_boolean(z);  break;
 248                         case IS_LONG:   convert_to_long(z);             break;
 249                         case IS_DOUBLE: convert_to_double(z);   break;
 250                         case IS_STRING: convert_to_string(z);   break;
 251                         case IS_ARRAY:  convert_to_array(z);    break;
 252                         case IS_OBJECT: convert_to_object(z);   break;
 253                 }
 254         }
 255         return z;
 256 }
 257 #define http_zsep(t, z) _http_zsep_ex((t), (z), NULL)
 258 #define http_zsep_ex(t, z, p) _http_zsep_ex((t), (z), (p))
 259 static inline zval *_http_zsep_ex(int type, zval *z, zval **p) {
 260         ZVAL_ADDREF(z);
 261         if (Z_TYPE_P(z) != type) {
 262                 switch (type) {
 263                         case IS_NULL:   convert_to_null_ex(&z);         break;
 264                         case IS_BOOL:   convert_to_boolean_ex(&z);      break;
 265                         case IS_LONG:   convert_to_long_ex(&z);         break;
 266                         case IS_DOUBLE: convert_to_double_ex(&z);       break;
 267                         case IS_STRING: convert_to_string_ex(&z);       break;
 268                         case IS_ARRAY:  convert_to_array_ex(&z);        break;
 269                         case IS_OBJECT: convert_to_object_ex(&z);       break;
 270                 }
 271         } else {
 272                 SEPARATE_ZVAL_IF_NOT_REF(&z);
 273         }
 274         if (p) {
 275                 *p = z;
 276         }
 277         return z;
 278 }
 279
 280 typedef struct _HashKey {
 281         char *str;
 282         uint len;
 283         ulong num;
 284         uint dup:1;
 285         uint type:31;
 286 } HashKey;
 287 #define initHashKey(dup) {NULL, 0, 0, (dup), 0}
 288
 289 #define FOREACH_VAL(pos, array, val) FOREACH_HASH_VAL(pos, Z_ARRVAL_P(array), val)
 290 #define FOREACH_HASH_VAL(pos, hash, val) \
 291         for (   zend_hash_internal_pointer_reset_ex(hash, &pos); \
 292                         zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
 293                         zend_hash_move_forward_ex(hash, &pos))
 294
 295 #define FOREACH_KEY(pos, array, key) FOREACH_HASH_KEY(pos, Z_ARRVAL_P(array), key)
 296 #define FOREACH_HASH_KEY(pos, hash, _key) \
 297         for (   zend_hash_internal_pointer_reset_ex(hash, &pos); \
 298                         ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT; \
 299                         zend_hash_move_forward_ex(hash, &pos)) \
 300
 301 #define FOREACH_KEYVAL(pos, array, key, val) FOREACH_HASH_KEYVAL(pos, Z_ARRVAL_P(array), key, val)
 302 #define FOREACH_HASH_KEYVAL(pos, hash, _key, val) \
 303         for (   zend_hash_internal_pointer_reset_ex(hash, &pos); \
 304                         ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT && \
 305                         zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
 306                         zend_hash_move_forward_ex(hash, &pos))
 307
 308 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
 309 #define ARRAY_JOIN_STRONLY 1
 310 #define ARRAY_JOIN_PRETTIFY 2
 311 #define array_join(src, dst, append, flags) zend_hash_apply_with_arguments(src HTTP_ZAPI_HASH_TSRMLS_CC, (append)?apply_array_append_func:apply_array_merge_func, 2, dst, (int)flags)
 312
 313 extern int apply_array_append_func(void *pDest HTTP_ZAPI_HASH_TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
 314 extern int apply_array_merge_func(void *pDest HTTP_ZAPI_HASH_TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
 315
 316 #endif
 317
 318 /*
 319  * Local variables:
 320  * tab-width: 4
 321  * c-basic-offset: 4
 322  * End:
 323  * vim600: noet sw=4 ts=4 fdm=marker
 324  * vim<600: noet sw=4 ts=4
 325  */
 326