git.m6w6.name Git - m6w6/ext-http/blob - php_http_api.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | PECL :: http                                                         |
   4    +----------------------------------------------------------------------+
   5    | This source file is subject to version 3.0 of the PHP license, that  |
   6    | is bundled with this package in the file LICENSE, and is available   |
   7    | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
   8    | If you did not receive a copy of the PHP license and are unable to   |
   9    | obtain it through the world-wide-web, please send a note to          |
  10    | license@php.net so we can mail you a copy immediately.               |
  11    +----------------------------------------------------------------------+
  12    | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
  13    +----------------------------------------------------------------------+
  14 */
  15
  16 /* $Id$ */
  17
  18 #ifndef PHP_HTTP_API_H
  19 #define PHP_HTTP_API_H
  20
  21 #include "php_http_std_defs.h"
  22 #include "php_http_send_api.h"
  23
  24 #define HTTP_SUPPORT                            0x01L
  25 #define HTTP_SUPPORT_REQUESTS           0x02L
  26 #define HTTP_SUPPORT_MAGICMIME          0x04L
  27 #define HTTP_SUPPORT_ENCODINGS          0x08L
  28 #define HTTP_SUPPORT_MHASHETAGS         0x10L
  29 #define HTTP_SUPPORT_SSLREQUESTS        0x20L
  30
  31 #define http_support_global_init() _http_support_global_init(INIT_FUNC_ARGS_PASSTHRU)
  32 extern STATUS _http_support_global_init(INIT_FUNC_ARGS);
  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 typedef void (*http_key_list_decode_t)(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
  41 #define http_key_list_default_decoder _http_key_list_default_decoder
  42 extern void _http_key_list_default_decoder(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
  43
  44 #define http_parse_cookie(l, i) _http_parse_key_list((l), (i), ';', http_key_list_default_decoder, 1 TSRMLS_CC)
  45 #define http_parse_key_list(l, i, s, d, f) _http_parse_key_list((l), (i), (s), (d), (f) TSRMLS_CC)
  46 extern STATUS _http_parse_key_list(const char *list, HashTable *items, char separator, http_key_list_decode_t decode, zend_bool first_entry_is_name_value_pair TSRMLS_DC);
  47
  48 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
  49 #define http_error_ex _http_error_ex
  50 extern void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...);
  51
  52 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
  53         if ((!(ch)) && (!((ch) = init))) { \
  54                 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
  55                 action; \
  56         }
  57 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
  58         if (!strchr((ct), '/')) { \
  59                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
  60                         "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
  61                 action; \
  62         }
  63 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
  64                 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
  65                         http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
  66                         action; \
  67                 }
  68 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
  69                 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
  70                         http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
  71                         action; \
  72                 }
  73 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
  74         if (level < -1 || level > 9) { \
  75                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
  76                 action; \
  77         }
  78
  79 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
  80 extern void http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC);
  81
  82 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
  83 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
  84 extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC);
  85
  86 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
  87 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
  88 extern STATUS _http_check_method_ex(const char *method, const char *methods);
  89
  90 #define HTTP_GSC(var, name, ret)  HTTP_GSP(var, name, return ret)
  91 #define HTTP_GSP(var, name, ret) \
  92                 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
  93                         ret; \
  94                 }
  95 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
  96 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
  97 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
  98 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC);
  99
 100 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
 101 #define http_get_Request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
 102 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
 103
 104 #define http_guess_content_type(mf, mm, d, l, m) _http_guess_content_type((mf), (mm), (d), (l), (m) TSRMLS_CC)
 105 PHP_HTTP_API char *_http_guess_content_type(const char *magic_file, long magic_mode, void *data_ptr, size_t data_len, http_send_mode mode TSRMLS_DC);
 106
 107
 108 #define http_locate_body _http_locate_body
 109 static inline const char *_http_locate_body(const char *message)
 110 {
 111         const char *cr = strstr(message, "\r\n\r\n");
 112         const char *lf = strstr(message, "\n\n");
 113
 114         if (lf && cr) {
 115                 return MIN(lf + 2, cr + 4);
 116         } else if (lf || cr) {
 117                 return MAX(lf + 2, cr + 4);
 118         } else {
 119                 return NULL;
 120         }
 121 }
 122
 123 #define http_locate_eol _http_locate_eol
 124 static inline const char *_http_locate_eol(const char *line, int *eol_len)
 125 {
 126         const char *eol = strpbrk(line, "\r\n");
 127
 128         if (eol_len) {
 129                 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
 130         }
 131         return eol;
 132 }
 133
 134 #define convert_to_type(t, z) _convert_to_type((t), (z))
 135 static inline zval *_convert_to_type(int type, zval *z)
 136 {
 137         if (Z_TYPE_P(z) != type) {
 138                 switch (type)
 139                 {
 140                         case IS_NULL:   convert_to_null(z);             break;
 141                         case IS_BOOL:   convert_to_boolean(z);  break;
 142                         case IS_LONG:   convert_to_long(z);             break;
 143                         case IS_DOUBLE: convert_to_array(z);    break;
 144                         case IS_STRING: convert_to_string(z);   break;
 145                         case IS_ARRAY:  convert_to_array(z);    break;
 146                         case IS_OBJECT: convert_to_object(z);   break;
 147                 }
 148         }
 149         return z;
 150 }
 151 #define convert_to_type_ex(t, z) _convert_to_type_ex((t), (z))
 152 static inline zval *_convert_to_type_ex(int type, zval *z)
 153 {
 154         if (Z_TYPE_P(z) != type) {
 155                 switch (type)
 156                 {
 157                         case IS_NULL:   convert_to_null_ex(&z);         break;
 158                         case IS_BOOL:   convert_to_boolean_ex(&z);      break;
 159                         case IS_LONG:   convert_to_long_ex(&z);         break;
 160                         case IS_DOUBLE: convert_to_array_ex(&z);        break;
 161                         case IS_STRING: convert_to_string_ex(&z);       break;
 162                         case IS_ARRAY:  convert_to_array_ex(&z);        break;
 163                         case IS_OBJECT: convert_to_object_ex(&z);       break;
 164                 }
 165         }
 166         return z;
 167 }
 168
 169
 170 #endif
 171
 172 /*
 173  * Local variables:
 174  * tab-width: 4
 175  * c-basic-offset: 4
 176  * End:
 177  * vim600: noet sw=4 ts=4 fdm=marker
 178  * vim<600: noet sw=4 ts=4
 179  */
 180