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 #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 extern PHP_MINIT_FUNCTION(http_support
);
26 #define http_support(f) _http_support(f)
27 PHP_HTTP_API
long _http_support(long feature
);
29 #define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen)
30 extern char *_http_pretty_key(char *key
, size_t key_len
, zend_bool uctitle
, zend_bool xhyphen
);
32 typedef void (*http_key_list_decode_t
)(const char *encoded
, size_t encoded_len
, char **decoded
, size_t *decoded_len TSRMLS_DC
);
33 #define http_key_list_default_decoder _http_key_list_default_decoder
34 extern void _http_key_list_default_decoder(const char *encoded
, size_t encoded_len
, char **decoded
, size_t *decoded_len TSRMLS_DC
);
36 #define http_parse_cookie(l, i) _http_parse_key_list((l), (i), ';', http_key_list_default_decoder, 1 TSRMLS_CC)
37 #define http_parse_key_list(l, i, s, d, f) _http_parse_key_list((l), (i), (s), (d), (f) TSRMLS_CC)
38 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
);
40 #define http_error(type, code, string) _http_error_ex(type, code, "%s", string)
41 #define http_error_ex _http_error_ex
42 extern void _http_error_ex(long type TSRMLS_DC
, long code
, const char *format
, ...);
44 #define HTTP_CHECK_CURL_INIT(ch, init, action) \
45 if ((!(ch)) && (!((ch) = init))) { \
46 http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl"); \
49 #define HTTP_CHECK_CONTENT_TYPE(ct, action) \
50 if (!strchr((ct), '/')) { \
51 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, \
52 "Content type \"%s\" does not seem to contain a primary and a secondary part", (ct)); \
55 #define HTTP_CHECK_MESSAGE_TYPE_RESPONSE(msg, action) \
56 if (!HTTP_MSG_TYPE(RESPONSE, (msg))) { \
57 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); \
60 #define HTTP_CHECK_MESSAGE_TYPE_REQUEST(msg, action) \
61 if (!HTTP_MSG_TYPE(REQUEST, (msg))) { \
62 http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); \
65 #define HTTP_CHECK_GZIP_LEVEL(level, action) \
66 if (level < -1 || level > 9) { \
67 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid compression level (-1 to 9): %d", level); \
71 #define HTTP_CHECK_HEADERS_SENT(action) \
72 if (SG(headers_sent) && !SG(request_info).no_headers) { \
73 char *output_start_filename = php_get_output_start_filename(TSRMLS_C); \
74 int output_start_lineno = php_get_output_start_lineno(TSRMLS_C); \
76 if (output_start_filename) { \
77 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent by (output started at %s:%d)", \
78 output_start_filename, output_start_lineno); \
80 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot modify header information - headers already sent"); \
85 #define HTTP_CHECK_OPEN_BASEDIR(file, act) \
86 if ((PG(open_basedir) && *PG(open_basedir)) || PG(safe_mode)) \
88 const char *tmp = file; \
90 if (!strncasecmp(tmp, "file:", lenof("file:"))) { \
91 tmp += lenof("file:"); \
92 while ((tmp - (const char *)file < 7) && (*tmp == '/' || *tmp == '\\')) ++tmp; \
95 if ( (tmp != file || !strstr(file, "://")) && \
96 (!*tmp || php_check_open_basedir(tmp TSRMLS_CC) || \
97 (PG(safe_mode) && !php_checkuid(tmp, "rb+", CHECKUID_CHECK_MODE_PARAM)))) { \
102 #define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC)
103 extern void http_log_ex(char *file
, const char *ident
, const char *message TSRMLS_DC
);
105 #define http_exit(s, h) http_exit_ex((s), (h), NULL, 1)
106 #define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC)
107 extern STATUS
_http_exit_ex(int status
, char *header
, char *body
, zend_bool send_header TSRMLS_DC
);
109 #define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS)
110 #define http_check_method_ex(m, a) _http_check_method_ex((m), (a))
111 extern STATUS
_http_check_method_ex(const char *method
, const char *methods
);
113 #define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret)
114 #define HTTP_GSP(var, name, ret) \
115 if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \
118 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
119 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
120 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
121 PHP_HTTP_API zval
*_http_get_server_var_ex(const char *key
, size_t key_size
, zend_bool check TSRMLS_DC
);
123 #define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC)
124 #define http_get_request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC)
125 PHP_HTTP_API STATUS
_http_get_request_body_ex(char **body
, size_t *length
, zend_bool dup TSRMLS_DC
);
128 #define http_locate_body _http_locate_body
129 static inline const char *_http_locate_body(const char *message
)
131 const char *cr
= strstr(message
, "\r\n\r\n");
132 const char *lf
= strstr(message
, "\n\n");
135 return MIN(lf
+ 2, cr
+ 4);
136 } else if (lf
|| cr
) {
137 return MAX(lf
+ 2, cr
+ 4);
143 #define http_locate_eol _http_locate_eol
144 static inline const char *_http_locate_eol(const char *line
, int *eol_len
)
146 const char *eol
= strpbrk(line
, "\r\n");
149 *eol_len
= eol
? ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1) : 0;
154 #define convert_to_type(t, z) _convert_to_type((t), (z))
155 static inline zval
*_convert_to_type(int type
, zval
*z
)
157 if (Z_TYPE_P(z
) != type
) {
160 case IS_NULL
: convert_to_null(z
); break;
161 case IS_BOOL
: convert_to_boolean(z
); break;
162 case IS_LONG
: convert_to_long(z
); break;
163 case IS_DOUBLE
: convert_to_array(z
); break;
164 case IS_STRING
: convert_to_string(z
); break;
165 case IS_ARRAY
: convert_to_array(z
); break;
166 case IS_OBJECT
: convert_to_object(z
); break;
171 #define convert_to_type_ex(t, z, p) _convert_to_type_ex((t), (z), (p))
172 static inline zval
*_convert_to_type_ex(int type
, zval
*z
, zval
**p
)
175 if (Z_TYPE_P(z
) != type
) {
178 case IS_NULL
: convert_to_null_ex(&z
); break;
179 case IS_BOOL
: convert_to_boolean_ex(&z
); break;
180 case IS_LONG
: convert_to_long_ex(&z
); break;
181 case IS_DOUBLE
: convert_to_array_ex(&z
); break;
182 case IS_STRING
: convert_to_string_ex(&z
); break;
183 case IS_ARRAY
: convert_to_array_ex(&z
); break;
184 case IS_OBJECT
: convert_to_object_ex(&z
); break;
202 * vim600: noet sw=4 ts=4 fdm=marker
203 * vim<600: noet sw=4 ts=4