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-2006, 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
  24 #define HTTP_PARAMS_ALLOW_COMMA         0x01
  25 #define HTTP_PARAMS_ALLOW_FAILURE       0x02
  26 #define HTTP_PARAMS_RAISE_ERROR         0x04
  27 #define HTTP_PARAMS_DEFAULT     (HTTP_PARAMS_ALLOW_COMMA|HTTP_PARAMS_ALLOW_FAILURE|HTTP_PARAMS_RAISE_ERROR)
  28
  29 extern PHP_MINIT_FUNCTION(http_support);
  30
  31 #define http_support(f) _http_support(f)
  32 PHP_HTTP_API long _http_support(long feature);
  33
  34 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
  35 extern char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
  36
  37 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
  38 #define http_error_ex _http_error_ex
  39 extern void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...);
  40
  41
  42 #ifdef ZEND_ENGINE_2
  43 #define http_exception_wrap(o, n, ce) _http_exception_wrap((o), (n), (ce) TSRMLS_CC)
  44 extern zval *_http_exception_wrap(zval *old_exception, zval *new_exception, zend_class_entry *ce TSRMLS_DC);
  45
  46 #define http_try \
  47 { \
  48                 zval *old_exception = EG(exception); \
  49                 EG(exception) = NULL;
  50 #define http_catch(ex_ce) \
  51                 if (EG(exception) && old_exception) { \
  52                         EG(exception) = http_exception_wrap(old_exception, EG(exception), ex_ce); \
  53                 } \
  54 }
  55 #define http_final(ex_ce) \
  56         if (EG(exception)) { \
  57                 EG(exception) = http_exception_wrap(EG(exception), NULL, ex_ce); \
  58         }
  59 #endif /* ZEND_ENGINE_2 */
  60
  61
  62 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
  63         if ((!(ch)) && (!((ch) = init))) { \
  64                 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
  65                 action; \
  66         }
  67 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
  68         if (!strchr((ct), '/')) { \
  69                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
  70                         "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
  71                 action; \
  72         }
  73 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
  74                 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
  75                         http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
  76                         action; \
  77                 }
  78 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
  79                 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
  80                         http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
  81                         action; \
  82                 }
  83 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
  84         if (level < -1 || level > 9) { \
  85                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
  86                 action; \
  87         }
  88
  89 #define HTTP_CHECK_HEADERS_SENT(action) \
  90         if (SG(headers_sent) && !SG(request_info).no_headers) { \
  91                 char *output_start_filename = php_get_output_start_filename(TSRMLS_C); \
  92                 int output_start_lineno = php_get_output_start_lineno(TSRMLS_C); \
  93                  \
  94                 if (output_start_filename) { \
  95                         http_error_ex(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent by (output started at %s:%d)", \
  96                                 output_start_filename, output_start_lineno); \
  97                 } else { \
  98                         http_error(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent"); \
  99                 } \
 100                 action; \
 101         }
 102
 103 #define HTTP_CHECK_OPEN_BASEDIR(file, act) \
 104         if ((PG(open_basedir) && *PG(open_basedir)) || PG(safe_mode)) \
 105         { \
 106                 const char *tmp = file; \
 107  \
 108                 if (!strncasecmp(tmp, "file:", lenof("file:"))) { \
 109                         tmp += lenof("file:"); \
 110                         while ((tmp - (const char *)file < 7) && (*tmp == '/' || *tmp == '\\')) ++tmp; \
 111                 } \
 112  \
 113                 if (    (tmp != file || !strstr(file, "://")) && \
 114                                 (!*tmp || php_check_open_basedir(tmp TSRMLS_CC) || \
 115                                 (PG(safe_mode) && !php_checkuid(tmp, "rb+", CHECKUID_CHECK_MODE_PARAM)))) { \
 116                                 act; \
 117                 } \
 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_GSC(var, name, ret)  HTTP_GSP(var, name, return ret)
 132 #define HTTP_GSP(var, name, ret) \
 133                 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
 134                         ret; \
 135                 }
 136 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
 137 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
 138 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
 139 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC);
 140
 141 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
 142 #define http_get_request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
 143 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
 144
 145 #define http_get_request_body_stream() _http_get_request_body_stream(TSRMLS_C)
 146 PHP_HTTP_API php_stream *_http_get_request_body_stream(TSRMLS_D);
 147
 148
 149 typedef void (*http_parse_params_callback)(void *cb_arg, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
 150
 151 #define http_parse_params_default_callback _http_parse_params_default_callback
 152 PHP_HTTP_API void _http_parse_params_default_callback(void *ht, const char *key, int keylen, const char *val, int vallen TSRMLS_DC);
 153
 154 #define http_parse_params(s, f, ht) _http_parse_params_ex((s), (f), _http_parse_params_default_callback, (ht) TSRMLS_CC)
 155 #define http_parse_params_ex(s, f, cb, a) _http_parse_params_ex((s), (f), (cb), (a) TSRMLS_CC)
 156 PHP_HTTP_API STATUS _http_parse_params_ex(const char *params, int flags, http_parse_params_callback cb, void *cb_arg TSRMLS_DC);
 157
 158
 159 #define http_locate_body _http_locate_body
 160 static inline const char *_http_locate_body(const char *message)
 161 {
 162         const char *body = NULL, *msg = message;
 163
 164         while (*msg) {
 165                 if (*msg == '\n') {
 166                         if (*(msg+1) == '\n') {
 167                                 body = msg + 2;
 168                                 break;
 169                         } else if (*(msg+1) == '\r' && *(msg+2) == '\n' && msg != message && *(msg-1) == '\r') {
 170                                 body = msg + 3;
 171                                 break;
 172                         }
 173                 }
 174                 ++msg;
 175         }
 176         return body;
 177 }
 178
 179 #define http_locate_eol _http_locate_eol
 180 static inline const char *_http_locate_eol(const char *line, int *eol_len)
 181 {
 182         const char *eol = strpbrk(line, "\r\n");
 183
 184         if (eol_len) {
 185                 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
 186         }
 187         return eol;
 188 }
 189
 190 #define convert_to_type(t, z) _convert_to_type((t), (z))
 191 static inline zval *_convert_to_type(int type, zval *z)
 192 {
 193         if (Z_TYPE_P(z) != type) {
 194                 switch (type) {
 195                         case IS_NULL:   convert_to_null(z);             break;
 196                         case IS_BOOL:   convert_to_boolean(z);  break;
 197                         case IS_LONG:   convert_to_long(z);             break;
 198                         case IS_DOUBLE: convert_to_double(z);   break;
 199                         case IS_STRING: convert_to_string(z);   break;
 200                         case IS_ARRAY:  convert_to_array(z);    break;
 201                         case IS_OBJECT: convert_to_object(z);   break;
 202                 }
 203         }
 204         return z;
 205 }
 206 #define convert_to_type_ex(t, z, p) _convert_to_type_ex((t), (z), (p))
 207 static inline zval *_convert_to_type_ex(int type, zval *z, zval **p)
 208 {
 209         *p = z;
 210         if (Z_TYPE_P(z) != type) {
 211                 switch (type) {
 212                         case IS_NULL:   convert_to_null_ex(&z);         break;
 213                         case IS_BOOL:   convert_to_boolean_ex(&z);      break;
 214                         case IS_LONG:   convert_to_long_ex(&z);         break;
 215                         case IS_DOUBLE: convert_to_double_ex(&z);       break;
 216                         case IS_STRING: convert_to_string_ex(&z);       break;
 217                         case IS_ARRAY:  convert_to_array_ex(&z);        break;
 218                         case IS_OBJECT: convert_to_object_ex(&z);       break;
 219                 }
 220         }
 221         if (*p == z) {
 222                 *p = NULL;
 223         } else {
 224                 *p = z;
 225         }
 226         return z;
 227 }
 228
 229 #define zval_copy(t, z) _zval_copy((t), (z) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC)
 230 static inline zval *_zval_copy(int type, zval *z ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC)
 231 {
 232         zval *copy;
 233
 234         copy = emalloc_rel(sizeof(zval));
 235         *copy = *z;
 236         zval_copy_ctor(copy);
 237         convert_to_type(type, copy);
 238         copy->refcount = 0;
 239         copy->is_ref = 0;
 240
 241         return copy;
 242 }
 243
 244 #define zval_free(z) _zval_free(z)
 245 static inline void _zval_free(zval **z)
 246 {
 247         zval_dtor(*z);
 248         FREE_ZVAL(*z);
 249         *z = NULL;
 250 }
 251
 252 #endif
 253
 254 /*
 255  * Local variables:
 256  * tab-width: 4
 257  * c-basic-offset: 4
 258  * End:
 259  * vim600: noet sw=4 ts=4 fdm=marker
 260  * vim<600: noet sw=4 ts=4
 261  */
 262