- example fixup
[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_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
40 extern void http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC);
41
42 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
43 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
44 extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC);
45
46 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
47 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
48 extern STATUS _http_check_method_ex(const char *method, const char *methods);
49
50 #define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret)
51 #define HTTP_GSP(var, name, ret) \
52 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
53 ret; \
54 }
55 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
56 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
57 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
58 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC);
59
60 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
61 #define http_get_Request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
62 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC);
63
64 #define http_chunked_decode(e, el, d, dl) _http_chunked_decode((e), (el), (d), (dl) TSRMLS_CC)
65 PHP_HTTP_API const char *_http_chunked_decode(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
66
67 #define http_guess_content_type(mf, mm, d, l, m) _http_guess_content_type((mf), (mm), (d), (l), (m) TSRMLS_CC)
68 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);
69
70
71 #define http_locate_body _http_locate_body
72 static inline const char *_http_locate_body(const char *message)
73 {
74 const char *cr = strstr(message, "\r\n\r\n");
75 const char *lf = strstr(message, "\n\n");
76
77 if (lf && cr) {
78 return MIN(lf + 2, cr + 4);
79 } else if (lf || cr) {
80 return MAX(lf + 2, cr + 4);
81 } else {
82 return NULL;
83 }
84 }
85
86 #define http_locate_eol _http_locate_eol
87 static inline const char *_http_locate_eol(const char *line, size_t *eol_len)
88 {
89 const char *eol = strpbrk(line, "\r\n");
90
91 if (eol_len) {
92 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
93 }
94 return eol;
95 }
96
97 #define convert_to_type(t, z) _convert_to_type((t), (z))
98 static inline zval *_convert_to_type(int type, zval *z)
99 {
100 if (Z_TYPE_P(z) != type) {
101 switch (type)
102 {
103 case IS_NULL: convert_to_null(z); break;
104 case IS_BOOL: convert_to_boolean(z); break;
105 case IS_LONG: convert_to_long(z); break;
106 case IS_DOUBLE: convert_to_array(z); break;
107 case IS_STRING: convert_to_string(z); break;
108 case IS_ARRAY: convert_to_array(z); break;
109 case IS_OBJECT: convert_to_object(z); break;
110 }
111 }
112 return z;
113 }
114 #define convert_to_type_ex(t, z) _convert_to_type_ex((t), (z))
115 static inline zval *_convert_to_type_ex(int type, zval *z)
116 {
117 if (Z_TYPE_P(z) != type) {
118 switch (type)
119 {
120 case IS_NULL: convert_to_null_ex(&z); break;
121 case IS_BOOL: convert_to_boolean_ex(&z); break;
122 case IS_LONG: convert_to_long_ex(&z); break;
123 case IS_DOUBLE: convert_to_array_ex(&z); break;
124 case IS_STRING: convert_to_string_ex(&z); break;
125 case IS_ARRAY: convert_to_array_ex(&z); break;
126 case IS_OBJECT: convert_to_object_ex(&z); break;
127 }
128 }
129 return z;
130 }
131
132
133 #endif
134
135 /*
136 * Local variables:
137 * tab-width: 4
138 * c-basic-offset: 4
139 * End:
140 * vim600: noet sw=4 ts=4 fdm=marker
141 * vim<600: noet sw=4 ts=4
142 */
143