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