- initialize default compression level
[m6w6/ext-http] / 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 pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
25 extern char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
26
27 typedef void (*http_key_list_decode_t)(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
28 #define http_key_list_default_decoder _http_key_list_default_decoder
29 extern void _http_key_list_default_decoder(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
30
31 #define http_parse_cookie(l, i) _http_parse_key_list((l), (i), ';', http_key_list_default_decoder, 1 TSRMLS_CC)
32 #define http_parse_key_list(l, i, s, d, f) _http_parse_key_list((l), (i), (s), (d), (f) TSRMLS_CC)
33 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);
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_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
67 extern void http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC);
68
69 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
70 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
71 extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC);
72
73 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
74 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
75 extern STATUS _http_check_method_ex(const char *method, const char *methods);
76
77 #define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret)
78 #define HTTP_GSP(var, name, ret) \
79 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
80 ret; \
81 }
82 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
83 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
84 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
85 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC);
86
87 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
88 #define http_get_Request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
89 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
90
91 #define http_guess_content_type(mf, mm, d, l, m) _http_guess_content_type((mf), (mm), (d), (l), (m) TSRMLS_CC)
92 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);
93
94
95 #define http_locate_body _http_locate_body
96 static inline const char *_http_locate_body(const char *message)
97 {
98 const char *cr = strstr(message, "\r\n\r\n");
99 const char *lf = strstr(message, "\n\n");
100
101 if (lf && cr) {
102 return MIN(lf + 2, cr + 4);
103 } else if (lf || cr) {
104 return MAX(lf + 2, cr + 4);
105 } else {
106 return NULL;
107 }
108 }
109
110 #define http_locate_eol _http_locate_eol
111 static inline const char *_http_locate_eol(const char *line, int *eol_len)
112 {
113 const char *eol = strpbrk(line, "\r\n");
114
115 if (eol_len) {
116 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
117 }
118 return eol;
119 }
120
121 #define convert_to_type(t, z) _convert_to_type((t), (z))
122 static inline zval *_convert_to_type(int type, zval *z)
123 {
124 if (Z_TYPE_P(z) != type) {
125 switch (type)
126 {
127 case IS_NULL: convert_to_null(z); break;
128 case IS_BOOL: convert_to_boolean(z); break;
129 case IS_LONG: convert_to_long(z); break;
130 case IS_DOUBLE: convert_to_array(z); break;
131 case IS_STRING: convert_to_string(z); break;
132 case IS_ARRAY: convert_to_array(z); break;
133 case IS_OBJECT: convert_to_object(z); break;
134 }
135 }
136 return z;
137 }
138 #define convert_to_type_ex(t, z) _convert_to_type_ex((t), (z))
139 static inline zval *_convert_to_type_ex(int type, zval *z)
140 {
141 if (Z_TYPE_P(z) != type) {
142 switch (type)
143 {
144 case IS_NULL: convert_to_null_ex(&z); break;
145 case IS_BOOL: convert_to_boolean_ex(&z); break;
146 case IS_LONG: convert_to_long_ex(&z); break;
147 case IS_DOUBLE: convert_to_array_ex(&z); break;
148 case IS_STRING: convert_to_string_ex(&z); break;
149 case IS_ARRAY: convert_to_array_ex(&z); break;
150 case IS_OBJECT: convert_to_object_ex(&z); break;
151 }
152 }
153 return z;
154 }
155
156
157 #endif
158
159 /*
160 * Local variables:
161 * tab-width: 4
162 * c-basic-offset: 4
163 * End:
164 * vim600: noet sw=4 ts=4 fdm=marker
165 * vim<600: noet sw=4 ts=4
166 */
167