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