2 +--------------------------------------------------------------------+
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-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #ifndef PHP_HTTP_API_H
16 #define PHP_HTTP_API_H
18 #include "php_http_std_defs.h"
19 #include "php_http_send_api.h"
21 #define HTTP_SUPPORT 0x01L
22 #define HTTP_SUPPORT_REQUESTS 0x02L
23 #define HTTP_SUPPORT_MAGICMIME 0x04L
24 #define HTTP_SUPPORT_ENCODINGS 0x08L
25 #define HTTP_SUPPORT_MHASHETAGS 0x10L
26 #define HTTP_SUPPORT_SSLREQUESTS 0x20L
28 extern PHP_MINIT_FUNCTION(http_support
);
30 #define http_support(f) _http_support(f)
31 PHP_HTTP_API
long _http_support(long feature
);
33 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
34 extern char *_http_pretty_key(char *key
, size_t key_len
, zend_bool uctitle
, zend_bool xhyphen
);
36 typedef void (*http_key_list_decode_t
)(const char *encoded
, size_t encoded_len
, char **decoded
, size_t *decoded_len TSRMLS_DC
);
37 #define http_key_list_default_decoder _http_key_list_default_decoder
38 extern void _http_key_list_default_decoder(const char *encoded
, size_t encoded_len
, char **decoded
, size_t *decoded_len TSRMLS_DC
);
40 #define http_parse_cookie(l, i) _http_parse_key_list((l), (i), ';', http_key_list_default_decoder, 1 TSRMLS_CC)
41 #define http_parse_key_list(l, i, s, d, f) _http_parse_key_list((l), (i), (s), (d), (f) TSRMLS_CC)
42 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
);
44 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
45 #define http_error_ex _http_error_ex
46 extern void _http_error_ex(long type TSRMLS_DC
, long code
, const char *format
, ...);
48 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
49 if ((!(ch)) && (!((ch) = init))) { \
50 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
53 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
54 if (!strchr((ct), '/')) { \
55 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
56 "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
59 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
60 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
61 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
64 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
65 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
66 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
69 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
70 if (level < -1 || level > 9) { \
71 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
75 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
76 extern void http_log_ex(char *file
, const char *ident
, const char *message TSRMLS_DC
);
78 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
79 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
80 extern STATUS
_http_exit_ex(int status
, char *header
, char *body
, zend_bool send_header TSRMLS_DC
);
82 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
83 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
84 extern STATUS
_http_check_method_ex(const char *method
, const char *methods
);
86 #define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret)
87 #define HTTP_GSP(var, name, ret) \
88 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
91 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
92 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
93 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
94 PHP_HTTP_API zval
*_http_get_server_var_ex(const char *key
, size_t key_size
, zend_bool check TSRMLS_DC
);
96 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
97 #define http_get_Request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
98 PHP_HTTP_API STATUS
_http_get_request_body_ex(char **body
, size_t *length
, zend_bool dup TSRMLS_DC
);
100 #define http_guess_content_type(mf, mm, d, l, m) _http_guess_content_type((mf), (mm), (d), (l), (m) TSRMLS_CC)
101 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
);
104 #define http_locate_body _http_locate_body
105 static inline const char *_http_locate_body(const char *message
)
107 const char *cr
= strstr(message
, "\r\n\r\n");
108 const char *lf
= strstr(message
, "\n\n");
111 return MIN(lf
+ 2, cr
+ 4);
112 } else if (lf
|| cr
) {
113 return MAX(lf
+ 2, cr
+ 4);
119 #define http_locate_eol _http_locate_eol
120 static inline const char *_http_locate_eol(const char *line
, int *eol_len
)
122 const char *eol
= strpbrk(line
, "\r\n");
125 *eol_len
= eol
? ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1) : 0;
130 #define convert_to_type(t, z) _convert_to_type((t), (z))
131 static inline zval
*_convert_to_type(int type
, zval
*z
)
133 if (Z_TYPE_P(z
) != type
) {
136 case IS_NULL
: convert_to_null(z
); break;
137 case IS_BOOL
: convert_to_boolean(z
); break;
138 case IS_LONG
: convert_to_long(z
); break;
139 case IS_DOUBLE
: convert_to_array(z
); break;
140 case IS_STRING
: convert_to_string(z
); break;
141 case IS_ARRAY
: convert_to_array(z
); break;
142 case IS_OBJECT
: convert_to_object(z
); break;
147 #define convert_to_type_ex(t, z, p) _convert_to_type_ex((t), (z), (p))
148 static inline zval
*_convert_to_type_ex(int type
, zval
*z
, zval
**p
)
151 if (Z_TYPE_P(z
) != type
) {
154 case IS_NULL
: convert_to_null_ex(&z
); break;
155 case IS_BOOL
: convert_to_boolean_ex(&z
); break;
156 case IS_LONG
: convert_to_long_ex(&z
); break;
157 case IS_DOUBLE
: convert_to_array_ex(&z
); break;
158 case IS_STRING
: convert_to_string_ex(&z
); break;
159 case IS_ARRAY
: convert_to_array_ex(&z
); break;
160 case IS_OBJECT
: convert_to_object_ex(&z
); break;
179 * vim600: noet sw=4 ts=4 fdm=marker
180 * vim<600: noet sw=4 ts=4