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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #ifndef PHP_HTTP_API_H
16 #define PHP_HTTP_API_H
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
24 #define HTTP_PARAMS_ALLOW_COMMA 0x01
25 #define HTTP_PARAMS_ALLOW_FAILURE 0x02
26 #define HTTP_PARAMS_RAISE_ERROR 0x04
27 #define HTTP_PARAMS_DEFAULT (HTTP_PARAMS_ALLOW_COMMA|HTTP_PARAMS_ALLOW_FAILURE|HTTP_PARAMS_RAISE_ERROR)
29 extern PHP_MINIT_FUNCTION(http_support
);
31 #define http_support(f) _http_support(f)
32 PHP_HTTP_API
long _http_support(long feature
);
34 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
35 extern char *_http_pretty_key(char *key
, size_t key_len
, zend_bool uctitle
, zend_bool xhyphen
);
37 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
38 #define http_error_ex _http_error_ex
39 extern void _http_error_ex(long type TSRMLS_DC
, long code
, const char *format
, ...);
43 #define http_exception_wrap(o, n, ce) _http_exception_wrap((o), (n), (ce) TSRMLS_CC)
44 extern zval
*_http_exception_wrap(zval
*old_exception
, zval
*new_exception
, zend_class_entry
*ce TSRMLS_DC
);
48 zval *old_exception = EG(exception); \
50 #define http_catch(ex_ce) \
51 if (EG(exception) && old_exception) { \
52 EG(exception) = http_exception_wrap(old_exception, EG(exception), ex_ce); \
55 #define http_final(ex_ce) \
56 if (EG(exception)) { \
57 zval *exception = http_exception_wrap(EG(exception), NULL, ex_ce); \
58 EG(exception) = NULL; \
59 zend_throw_exception_object(exception TSRMLS_CC); \
61 #endif /* ZEND_ENGINE_2 */
64 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
65 if ((!(ch)) && (!((ch) = init))) { \
66 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
69 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
70 if (!strchr((ct), '/')) { \
71 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
72 "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
75 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
76 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
77 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
80 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
81 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
82 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
85 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
86 if (level < -1 || level > 9) { \
87 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
91 #define HTTP_CHECK_HEADERS_SENT(action) \
92 if (SG(headers_sent) && !SG(request_info).no_headers) { \
93 char *output_start_filename = php_get_output_start_filename(TSRMLS_C); \
94 int output_start_lineno = php_get_output_start_lineno(TSRMLS_C); \
96 if (output_start_filename) { \
97 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent by (output started at %s:%d)", \
98 output_start_filename, output_start_lineno); \
100 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent"); \
105 #define HTTP_CHECK_OPEN_BASEDIR(file, act) \
106 if ((PG(open_basedir) && *PG(open_basedir)) || PG(safe_mode)) \
108 const char *tmp = file; \
110 if (!strncasecmp(tmp, "file:", lenof("file:"))) { \
111 tmp += lenof("file:"); \
112 while ((tmp - (const char *)file < 7) && (*tmp == '/' || *tmp == '\\')) ++tmp; \
115 if ( (tmp != file || !strstr(file, "://")) && \
116 (!*tmp || php_check_open_basedir(tmp TSRMLS_CC) || \
117 (PG(safe_mode) && !php_checkuid(tmp, "rb+", CHECKUID_CHECK_MODE_PARAM)))) { \
122 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
123 extern void http_log_ex(char *file
, const char *ident
, const char *message TSRMLS_DC
);
125 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
126 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
127 extern STATUS
_http_exit_ex(int status
, char *header
, char *body
, zend_bool send_header TSRMLS_DC
);
129 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
130 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
131 extern STATUS
_http_check_method_ex(const char *method
, const char *methods
);
133 #define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret)
134 #define HTTP_GSP(var, name, ret) \
135 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
138 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
139 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
140 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
141 PHP_HTTP_API zval
*_http_get_server_var_ex(const char *key
, size_t key_size
, zend_bool check TSRMLS_DC
);
143 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
144 #define http_get_request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
145 PHP_HTTP_API STATUS
_http_get_request_body_ex(char **body
, size_t *length
, zend_bool dup TSRMLS_DC
);
147 #define http_get_request_body_stream() _http_get_request_body_stream(TSRMLS_C)
148 PHP_HTTP_API php_stream
*_http_get_request_body_stream(TSRMLS_D
);
151 typedef void (*http_parse_params_callback
)(void *cb_arg
, const char *key
, int keylen
, const char *val
, int vallen TSRMLS_DC
);
153 #define http_parse_params_default_callback _http_parse_params_default_callback
154 PHP_HTTP_API
void _http_parse_params_default_callback(void *ht
, const char *key
, int keylen
, const char *val
, int vallen TSRMLS_DC
);
156 #define http_parse_params(s, f, ht) _http_parse_params_ex((s), (f), _http_parse_params_default_callback, (ht) TSRMLS_CC)
157 #define http_parse_params_ex(s, f, cb, a) _http_parse_params_ex((s), (f), (cb), (a) TSRMLS_CC)
158 PHP_HTTP_API STATUS
_http_parse_params_ex(const char *params
, int flags
, http_parse_params_callback cb
, void *cb_arg TSRMLS_DC
);
161 #define http_locate_body _http_locate_body
162 static inline const char *_http_locate_body(const char *message
)
164 const char *body
= NULL
, *msg
= message
;
168 if (*(msg
+1) == '\n') {
171 } else if (*(msg
+1) == '\r' && *(msg
+2) == '\n' && msg
!= message
&& *(msg
-1) == '\r') {
181 #define http_locate_eol _http_locate_eol
182 static inline const char *_http_locate_eol(const char *line
, int *eol_len
)
184 const char *eol
= strpbrk(line
, "\r\n");
187 *eol_len
= eol
? ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1) : 0;
192 #define convert_to_type(t, z) _convert_to_type((t), (z))
193 static inline zval
*_convert_to_type(int type
, zval
*z
)
195 if (Z_TYPE_P(z
) != type
) {
197 case IS_NULL
: convert_to_null(z
); break;
198 case IS_BOOL
: convert_to_boolean(z
); break;
199 case IS_LONG
: convert_to_long(z
); break;
200 case IS_DOUBLE
: convert_to_double(z
); break;
201 case IS_STRING
: convert_to_string(z
); break;
202 case IS_ARRAY
: convert_to_array(z
); break;
203 case IS_OBJECT
: convert_to_object(z
); break;
208 #define convert_to_type_ex(t, z, p) _convert_to_type_ex((t), (z), (p))
209 static inline zval
*_convert_to_type_ex(int type
, zval
*z
, zval
**p
)
212 if (Z_TYPE_P(z
) != type
) {
214 case IS_NULL
: convert_to_null_ex(&z
); break;
215 case IS_BOOL
: convert_to_boolean_ex(&z
); break;
216 case IS_LONG
: convert_to_long_ex(&z
); break;
217 case IS_DOUBLE
: convert_to_double_ex(&z
); break;
218 case IS_STRING
: convert_to_string_ex(&z
); break;
219 case IS_ARRAY
: convert_to_array_ex(&z
); break;
220 case IS_OBJECT
: convert_to_object_ex(&z
); break;
231 #define zval_copy(t, z) _zval_copy((t), (z) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC)
232 static inline zval
*_zval_copy(int type
, zval
*z ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC
)
236 copy
= emalloc_rel(sizeof(zval
));
238 zval_copy_ctor(copy
);
239 convert_to_type(type
, copy
);
246 #define zval_free(z) _zval_free(z)
247 static inline void _zval_free(zval
**z
)
261 * vim600: noet sw=4 ts=4 fdm=marker
262 * vim<600: noet sw=4 ts=4