2 +----------------------------------------------------------------------+
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 +----------------------------------------------------------------------+
18 #ifndef PHP_HTTP_API_H
19 #define PHP_HTTP_API_H
22 # define PHP_HTTP_API __declspec(dllexport)
28 # include "php_http_build_query.h"
31 /* make functions that return SUCCESS|FAILURE more obvious */
34 /* {{{ enum http_range_status */
42 /* {{{ enum http_send_mode */
50 #define HTTP_CRLF "\r\n"
52 /* default cache control */
53 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
56 #define HTTP_URI_MAXLEN 2048
59 #define HTTP_BUF_SIZE 2097152
61 /* server vars shorthand */
62 #define HTTP_SERVER_VARS Z_ARRVAL_P(PG(http_globals)[TRACK_VARS_SERVER])
66 #include <curl/curl.h>
68 /* CURL buffer size */
69 #define HTTP_CURLBUF_BODYSIZE 16384
70 #define HTTP_CURLBUF_HDRSSIZE 4096
72 /* {{{ http_curlbuf_member */
77 } http_curlbuf_member
;
82 /* {{{ HTTP_GSC(var, name, ret) */
83 #define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret)
86 /* {{{ HTTP_GSP(var, name, ret) */
87 #define HTTP_GSP(var, name, ret) \
88 if (!(var = http_get_server_var(name))) { \
91 if (!Z_STRLEN_P(var)) { \
97 #define http_date(t) _http_date((t) TSRMLS_CC)
98 PHP_HTTP_API
char *_http_date(time_t t TSRMLS_DC
);
100 #define http_parse_date(d) _http_parse_date((d))
101 PHP_HTTP_API
time_t _http_parse_date(const char *date
);
103 #define http_send_status(s) _http_send_status((s) TSRMLS_CC)
104 PHP_HTTP_API
inline STATUS
_http_send_status(const int status TSRMLS_DC
);
106 #define http_send_header(h) _http_send_header((h) TSRMLS_CC)
107 PHP_HTTP_API
inline STATUS
_http_send_header(const char *header TSRMLS_DC
);
109 #define http_send_status_header(s, h) _http_send_status_header((s), (h) TSRMLS_CC)
110 PHP_HTTP_API
inline STATUS
_http_send_status_header(const int status
, const char *header TSRMLS_DC
);
112 #define http_get_server_var(v) _http_get_server_var((v) TSRMLS_CC)
113 PHP_HTTP_API
inline zval
*_http_get_server_var(const char *key TSRMLS_DC
);
115 #define http_etag(p, l, m) _http_etag((p), (l), (m) TSRMLS_CC)
116 PHP_HTTP_API
inline char *_http_etag(const void *data_ptr
, const size_t data_len
, const http_send_mode data_mode TSRMLS_DC
);
118 #define http_lmod(p, m) _http_lmod((p), (m) TSRMLS_CC)
119 PHP_HTTP_API
inline time_t _http_lmod(const void *data_ptr
, const http_send_mode data_mode TSRMLS_DC
);
121 #define http_is_range_request() _http_is_range_request(TSRMLS_C)
122 PHP_HTTP_API
inline int _http_is_range_request(TSRMLS_D
);
124 #define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC)
125 PHP_HTTP_API
void _http_ob_etaghandler(char *output
, uint output_len
, char **handled_output
, uint
*handled_output_len
, int mode TSRMLS_DC
);
127 #define http_start_ob_handler(f, h, s, e) _http_start_ob_handler((f), (h), (s), (e) TSRMLS_CC)
128 PHP_HTTP_API STATUS
_http_start_ob_handler(php_output_handler_func_t handler_func
, char *handler_name
, uint chunk_size
, zend_bool erase TSRMLS_DC
);
130 #define http_modified_match(entry, modified) _http_modified_match((entry), (modified) TSRMLS_CC)
131 PHP_HTTP_API
int _http_modified_match(const char *entry
, const time_t t TSRMLS_DC
);
133 #define http_etag_match(entry, etag) _http_etag_match((entry), (etag) TSRMLS_CC)
134 PHP_HTTP_API
int _http_etag_match(const char *entry
, const char *etag TSRMLS_DC
);
136 #define http_send_last_modified(t) _http_send_last_modified((t) TSRMLS_CC)
137 PHP_HTTP_API STATUS
_http_send_last_modified(const time_t t TSRMLS_DC
);
139 #define http_send_etag(e, l) _http_send_etag((e), (l) TSRMLS_CC)
140 PHP_HTTP_API STATUS
_http_send_etag(const char *etag
, const int etag_len TSRMLS_DC
);
142 #define http_send_cache_control(c, l) _http_send_cache_control((c), (l) TSRMLS_CC)
143 PHP_HTTP_API STATUS
_http_send_cache_control(const char *cache_control
, const size_t cc_len TSRMLS_DC
);
145 #define http_send_content_type(c, l) _http_send_content_type((c), (l) TSRMLS_CC)
146 PHP_HTTP_API STATUS
_http_send_content_type(const char *content_type
, const size_t ct_len TSRMLS_DC
);
148 #define http_send_content_disposition(f, l, i) _http_send_content_disposition((f), (l), (i) TSRMLS_CC)
149 PHP_HTTP_API STATUS
_http_send_content_disposition(const char *filename
, const size_t f_len
, const int send_inline TSRMLS_DC
);
151 #define http_cache_last_modified(l, s, cc, ccl) _http_cache_last_modified((l), (s), (cc), (ccl) TSRMLS_CC)
152 PHP_HTTP_API STATUS
_http_cache_last_modified(const time_t last_modified
, const time_t send_modified
, const char *cache_control
, const size_t cc_len TSRMLS_DC
);
154 #define http_cache_etag(e, el, cc, ccl) _http_cache_etag((e), (el), (cc), (ccl) TSRMLS_CC)
155 PHP_HTTP_API STATUS
_http_cache_etag(const char *etag
, const size_t etag_len
, const char *cache_control
, const size_t cc_len TSRMLS_DC
);
157 #define http_absolute_uri(url, proto) _http_absolute_uri((url), (proto) TSRMLS_CC)
158 PHP_HTTP_API
char *_http_absolute_uri(const char *url
, const char *proto TSRMLS_DC
);
160 #define http_negotiate_language(supported, def) _http_negotiate_q("HTTP_ACCEPT_LANGUAGE", (supported), (def) TSRMLS_CC)
161 #define http_negotiate_charset(supported, def) _http_negotiate_q("HTTP_ACCEPT_CHARSET", (supported), (def) TSRMLS_CC)
162 #define http_negotiate_q(e, s, d, t) _http_negotiate_q((e), (s), (d), (t) TSRMLS_CC)
163 PHP_HTTP_API
char *_http_negotiate_q(const char *entry
, const zval
*supported
, const char *def TSRMLS_DC
);
165 #define http_get_request_ranges(r, l) _http_get_request_ranges((r), (l) TSRMLS_CC)
166 PHP_HTTP_API http_range_status
_http_get_request_ranges(zval
*zranges
, const size_t length TSRMLS_DC
);
168 #define http_send_ranges(r, d, s, m) _http_send_ranges((r), (d), (s), (m) TSRMLS_CC)
169 PHP_HTTP_API STATUS
_http_send_ranges(zval
*zranges
, const void *data
, const size_t size
, const http_send_mode mode TSRMLS_DC
);
171 #define http_send(d, s, m) _http_send((d), (s), (m) TSRMLS_CC)
172 PHP_HTTP_API STATUS
_http_send(const void *data
, const size_t data_size
, const http_send_mode mode TSRMLS_DC
);
174 #define http_send_data(z) _http_send_data((z) TSRMLS_CC)
175 PHP_HTTP_API STATUS
_http_send_data(const zval
*zdata TSRMLS_DC
);
177 #define http_send_stream(s) _http_send_stream((s) TSRMLS_CC)
178 PHP_HTTP_API STATUS
_http_send_stream(const php_stream
*s TSRMLS_DC
);
180 #define http_send_file(f) _http_send_file((f) TSRMLS_CC)
181 PHP_HTTP_API STATUS
_http_send_file(const zval
*zfile TSRMLS_DC
);
183 #define http_chunked_decode(e, el, d, dl) _http_chunked_decode((e), (el), (d), (dl) TSRMLS_CC)
184 PHP_HTTP_API STATUS
_http_chunked_decode(const char *encoded
, const size_t encoded_len
, char **decoded
, size_t *decoded_len TSRMLS_DC
);
186 #define http_split_response(r, h, b) _http_split_response_ex(Z_STRVAL_P(r), Z_STRLEN_P(r), (h), (b) TSRMLS_CC)
187 #define http_split_response_ex(r, l, h, b) _http_split_response_ex((r), (l), (h), (b) TSRMLS_CC)
188 PHP_HTTP_API STATUS
_http_split_response(char *response
, size_t repsonse_len
, zval
*zheaders
, zval
*zbody TSRMLS_DC
);
190 #define http_parse_headers(h, l, a) _http_parse_headers((h), (l), (a) TSRMLS_CC)
191 PHP_HTTP_API STATUS
_http_parse_headers(char *header
, int header_len
, zval
*array TSRMLS_DC
);
193 #define http_get_request_headers(h) _http_get_request_headers((h) TSRMLS_CC)
194 PHP_HTTP_API
void _http_get_request_headers(zval
*array TSRMLS_DC
);
197 #ifdef HTTP_HAVE_CURL
199 #define http_get(u, o, i, d, l) _http_get((u), (o), (i), (d), (l) TSRMLS_CC)
200 PHP_HTTP_API STATUS
_http_get(const char *URL
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
201 #define http_get_ex(c, u, o, i, d, l) _http_get_ex((c), (u), (o), (i), (d), (l) TSRMLS_CC)
202 PHP_HTTP_API STATUS
_http_get_ex(CURL
*ch
, const char *URL
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
204 #define http_head(u, o, i, d, l) _http_head((u), (o), (i), (d), (l) TSRMLS_CC)
205 PHP_HTTP_API STATUS
_http_head(const char *URL
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
206 #define http_head_ex(c, u, o, i, d, l) _http_head_ex((c), (u), (o), (i), (d), (l) TSRMLS_CC)
207 PHP_HTTP_API STATUS
_http_head_ex(CURL
*ch
, const char *URL
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
209 #define http_post_data(u, pd, pl, o, i, d, l) _http_post_data((u), (pd), (pl), (o), (i), (d), (l) TSRMLS_CC)
210 PHP_HTTP_API STATUS
_http_post_data(const char *URL
, char *postdata
, size_t postdata_len
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
211 #define http_post_data_ex(c, u, pd, pl, o, i, d, l) _http_post_data_ex((c), (u), (pd), (pl), (o), (i), (d), (l) TSRMLS_CC)
212 PHP_HTTP_API STATUS
_http_post_data_ex(CURL
*ch
, const char *URL
, char *postdata
, size_t postdata_len
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
214 #define http_post_array(u, p, o, i, d, l) _http_post_array((u), (p), (o), (i), (d), (l) TSRMLS_CC)
215 PHP_HTTP_API STATUS
_http_post_array(const char *URL
, HashTable
*postarray
, HashTable
*options
, HashTable
*info
, char **data
, size_t *data_len TSRMLS_DC
);
220 #define http_auth_credentials(u, p) _http_auth_credentials((u), (p) TSRMLS_CC)
221 PHP_HTTP_API STATUS
_http_auth_credentials(char **user
, char **pass TSRMLS_DC
);
223 #define http_auth_header(t, r) _http_auth_header((t), (r) TSRMLS_CC)
224 PHP_HTTP_API STATUS
_http_auth_header(const char *type
, const char *realm TSRMLS_DC
);
235 * vim600: noet sw=4 ts=4 fdm=marker
236 * vim<600: noet sw=4 ts=4