git.m6w6.name Git - m6w6/ext-http/blob - 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 #ifdef PHP_WIN32
  22 #       define PHP_HTTP_API __declspec(dllexport)
  23 #else
  24 #       define PHP_HTTP_API
  25 #endif
  26
  27 #ifndef ZEND_ENGINE_2
  28 #       include "php_http_build_query.h"
  29 #endif
  30
  31 /* make functions that return SUCCESS|FAILURE more obvious */
  32 typedef int STATUS;
  33
  34 /* {{{ enum http_range_status */
  35 typedef enum {
  36         RANGE_OK,
  37         RANGE_NO,
  38         RANGE_ERR
  39 } http_range_status;
  40 /* }}} */
  41
  42 /* {{{ enum http_send_mode */
  43 typedef enum {
  44         SEND_DATA,
  45         SEND_RSRC
  46 } http_send_mode;
  47 /* }}} */
  48
  49 /* CR LF */
  50 #define HTTP_CRLF "\r\n"
  51
  52 /* default cache control */
  53 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
  54
  55 /* max URI length */
  56 #define HTTP_URI_MAXLEN 2048
  57
  58 /* buffer size */
  59 #define HTTP_BUF_SIZE 2097152
  60
  61 /* server vars shorthand */
  62 #define HTTP_SERVER_VARS Z_ARRVAL_P(PG(http_globals)[TRACK_VARS_SERVER])
  63
  64 /* override arg_separator.output to "&" for data used in outgoing requests */
  65 #include "zend_ini.h"
  66 #define HTTP_URL_ARGSEP_OVERRIDE zend_alter_ini_entry("arg_separator.output", sizeof("arg_separator.output") - 1, "&", 1, ZEND_INI_ALL, ZEND_INI_STAGE_RUNTIME)
  67 #define HTTP_URL_ARGSEP_RESTORE zend_restore_ini_entry("arg_separator.output", sizeof("arg_separator.output") - 1, ZEND_INI_STAGE_RUNTIME)
  68
  69 /* {{{ HAVE_CURL */
  70 #ifdef HTTP_HAVE_CURL
  71 #include <curl/curl.h>
  72
  73 /* CURL buffer size */
  74 #define HTTP_CURLBUF_BODYSIZE 16384
  75 #define HTTP_CURLBUF_HDRSSIZE  4096
  76
  77 /* {{{ http_curlbuf_member */
  78 typedef enum {
  79         CURLBUF_BODY = 1,
  80         CURLBUF_HDRS = 2,
  81         CURLBUF_EVRY = 3
  82 } http_curlbuf_member;
  83 /* }}} */
  84 #endif
  85 /* }}} HAVE_CURL */
  86
  87 /* {{{ HTTP_GSC(var, name, ret) */
  88 #define HTTP_GSC(var, name, ret)  HTTP_GSP(var, name, return ret)
  89 /* }}} */
  90
  91 /* {{{ HTTP_GSP(var, name, ret) */
  92 #define HTTP_GSP(var, name, ret) \
  93                 if (!(var = http_get_server_var(name))) { \
  94                         ret; \
  95                 } \
  96                 if (!Z_STRLEN_P(var)) { \
  97                         ret; \
  98                 }
  99 /* }}} */
 100
 101 /* {{{ public API */
 102 #define http_date(t) _http_date((t) TSRMLS_CC)
 103 PHP_HTTP_API char *_http_date(time_t t TSRMLS_DC);
 104
 105 #define http_parse_date(d) _http_parse_date((d))
 106 PHP_HTTP_API time_t _http_parse_date(const char *date);
 107
 108 #define http_send_status(s) _http_send_status((s) TSRMLS_CC)
 109 PHP_HTTP_API inline STATUS _http_send_status(const int status TSRMLS_DC);
 110
 111 #define http_send_header(h) _http_send_header((h) TSRMLS_CC)
 112 PHP_HTTP_API inline STATUS _http_send_header(const char *header TSRMLS_DC);
 113
 114 #define http_send_status_header(s, h) _http_send_status_header((s), (h) TSRMLS_CC)
 115 PHP_HTTP_API inline STATUS _http_send_status_header(const int status, const char *header TSRMLS_DC);
 116
 117 #define http_get_server_var(v) _http_get_server_var((v) TSRMLS_CC)
 118 PHP_HTTP_API inline zval *_http_get_server_var(const char *key TSRMLS_DC);
 119
 120 #define http_etag(p, l, m) _http_etag((p), (l), (m) TSRMLS_CC)
 121 PHP_HTTP_API inline char *_http_etag(const void *data_ptr, const size_t data_len, const http_send_mode data_mode TSRMLS_DC);
 122
 123 #define http_lmod(p, m) _http_lmod((p), (m) TSRMLS_CC)
 124 PHP_HTTP_API inline time_t _http_lmod(const void *data_ptr, const http_send_mode data_mode TSRMLS_DC);
 125
 126 #define http_is_range_request() _http_is_range_request(TSRMLS_C)
 127 PHP_HTTP_API inline int _http_is_range_request(TSRMLS_D);
 128
 129 #define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC)
 130 PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC);
 131
 132 #define http_start_ob_handler(f, h, s, e) _http_start_ob_handler((f), (h), (s), (e) TSRMLS_CC)
 133 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);
 134
 135 #define http_modified_match(entry, modified) _http_modified_match((entry), (modified) TSRMLS_CC)
 136 PHP_HTTP_API int _http_modified_match(const char *entry, const time_t t TSRMLS_DC);
 137
 138 #define http_etag_match(entry, etag) _http_etag_match((entry), (etag) TSRMLS_CC)
 139 PHP_HTTP_API int _http_etag_match(const char *entry, const char *etag TSRMLS_DC);
 140
 141 #define http_send_last_modified(t) _http_send_last_modified((t) TSRMLS_CC)
 142 PHP_HTTP_API STATUS _http_send_last_modified(const time_t t TSRMLS_DC);
 143
 144 #define http_send_etag(e, l) _http_send_etag((e), (l) TSRMLS_CC)
 145 PHP_HTTP_API STATUS _http_send_etag(const char *etag, const int etag_len TSRMLS_DC);
 146
 147 #define http_send_cache_control(c, l) _http_send_cache_control((c), (l) TSRMLS_CC)
 148 PHP_HTTP_API STATUS _http_send_cache_control(const char *cache_control, const size_t cc_len TSRMLS_DC);
 149
 150 #define http_send_content_type(c, l) _http_send_content_type((c), (l) TSRMLS_CC)
 151 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, const size_t ct_len TSRMLS_DC);
 152
 153 #define http_send_content_disposition(f, l, i) _http_send_content_disposition((f), (l), (i) TSRMLS_CC)
 154 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, const size_t f_len, const int send_inline TSRMLS_DC);
 155
 156 #define http_cache_last_modified(l, s, cc, ccl) _http_cache_last_modified((l), (s), (cc), (ccl) TSRMLS_CC)
 157 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);
 158
 159 #define http_cache_etag(e, el, cc, ccl) _http_cache_etag((e), (el), (cc), (ccl) TSRMLS_CC)
 160 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);
 161
 162 #define http_absolute_uri(url, proto) _http_absolute_uri((url), (proto) TSRMLS_CC)
 163 PHP_HTTP_API char *_http_absolute_uri(const char *url, const char *proto TSRMLS_DC);
 164
 165 #define http_negotiate_language(supported, def) _http_negotiate_q("HTTP_ACCEPT_LANGUAGE", (supported), (def) TSRMLS_CC)
 166 #define http_negotiate_charset(supported, def)  _http_negotiate_q("HTTP_ACCEPT_CHARSET", (supported), (def) TSRMLS_CC)
 167 #define http_negotiate_q(e, s, d, t) _http_negotiate_q((e), (s), (d), (t) TSRMLS_CC)
 168 PHP_HTTP_API char *_http_negotiate_q(const char *entry, const zval *supported, const char *def TSRMLS_DC);
 169
 170 #define http_get_request_ranges(r, l) _http_get_request_ranges((r), (l) TSRMLS_CC)
 171 PHP_HTTP_API http_range_status _http_get_request_ranges(zval *zranges, const size_t length TSRMLS_DC);
 172
 173 #define http_send_ranges(r, d, s, m) _http_send_ranges((r), (d), (s), (m) TSRMLS_CC)
 174 PHP_HTTP_API STATUS _http_send_ranges(zval *zranges, const void *data, const size_t size, const http_send_mode mode TSRMLS_DC);
 175
 176 #define http_send(d, s, m) _http_send((d), (s), (m) TSRMLS_CC)
 177 PHP_HTTP_API STATUS _http_send(const void *data, const size_t data_size, const http_send_mode mode TSRMLS_DC);
 178
 179 #define http_send_data(z) _http_send_data((z) TSRMLS_CC)
 180 PHP_HTTP_API STATUS _http_send_data(const zval *zdata TSRMLS_DC);
 181
 182 #define http_send_stream(s) _http_send_stream((s) TSRMLS_CC)
 183 PHP_HTTP_API STATUS _http_send_stream(const php_stream *s TSRMLS_DC);
 184
 185 #define http_send_file(f) _http_send_file((f) TSRMLS_CC)
 186 PHP_HTTP_API STATUS _http_send_file(const zval *zfile TSRMLS_DC);
 187
 188 #define http_chunked_decode(e, el, d, dl) _http_chunked_decode((e), (el), (d), (dl) TSRMLS_CC)
 189 PHP_HTTP_API STATUS _http_chunked_decode(const char *encoded, const size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
 190
 191 #define http_split_response(r, h, b) _http_split_response_ex(Z_STRVAL_P(r), Z_STRLEN_P(r), (h), (b) TSRMLS_CC)
 192 #define http_split_response_ex(r, l, h, b) _http_split_response_ex((r), (l), (h), (b) TSRMLS_CC)
 193 PHP_HTTP_API STATUS _http_split_response_ex(char *response, size_t repsonse_len, zval *zheaders, zval *zbody TSRMLS_DC);
 194
 195 #define http_parse_headers(h, l, a) _http_parse_headers((h), (l), (a) TSRMLS_CC)
 196 PHP_HTTP_API STATUS _http_parse_headers(char *header, int header_len, zval *array TSRMLS_DC);
 197
 198 #define http_get_request_headers(h) _http_get_request_headers((h) TSRMLS_CC)
 199 PHP_HTTP_API void _http_get_request_headers(zval *array TSRMLS_DC);
 200
 201 /* {{{ HAVE_CURL */
 202 #ifdef HTTP_HAVE_CURL
 203
 204 #define http_get(u, o, i, d, l) _http_get((u), (o), (i), (d), (l) TSRMLS_CC)
 205 PHP_HTTP_API STATUS _http_get(const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC);
 206 #define http_get_ex(c, u, o, i, d, l) _http_get_ex((c), (u), (o), (i), (d), (l) TSRMLS_CC)
 207 PHP_HTTP_API STATUS _http_get_ex(CURL *ch, const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC);
 208
 209 #define http_head(u, o, i, d, l) _http_head((u), (o), (i), (d), (l) TSRMLS_CC)
 210 PHP_HTTP_API STATUS _http_head(const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC);
 211 #define http_head_ex(c, u, o, i, d, l) _http_head_ex((c), (u), (o), (i), (d), (l) TSRMLS_CC)
 212 PHP_HTTP_API STATUS _http_head_ex(CURL *ch, const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC);
 213
 214 #define http_post_data(u, pd, pl, o, i, d, l) _http_post_data((u), (pd), (pl), (o), (i), (d), (l) TSRMLS_CC)
 215 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);
 216 #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)
 217 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);
 218
 219 #define http_post_array(u, p, o, i, d, l) _http_post_array_ex(NULL, (u), (p), (o), (i), (d), (l) TSRMLS_CC)
 220 #define http_post_array_ex(c, u, p, o, i, d, l) _http_post_array_ex((c), (u), (p), (o), (i), (d), (l) TSRMLS_CC)
 221 PHP_HTTP_API STATUS _http_post_array_ex(CURL *ch, const char *URL, HashTable *postarray, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC);
 222
 223 #define http_post_curldata_ex(c, u, h, o, i, d, l) _http_post_curldata_ex((c), (u), (h), (o), (i), (d), (l) TSRMLS_CC)
 224 PHP_HTTP_API STATUS _http_post_curldata_ex(CURL *ch, const char *URL, struct curl_httppost *curldata, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC);
 225
 226 #endif
 227 /* }}} HAVE_CURL */
 228
 229 #define http_auth_credentials(u, p) _http_auth_credentials((u), (p) TSRMLS_CC)
 230 PHP_HTTP_API STATUS _http_auth_credentials(char **user, char **pass TSRMLS_DC);
 231
 232 #define http_auth_header(t, r) _http_auth_header((t), (r) TSRMLS_CC)
 233 PHP_HTTP_API STATUS _http_auth_header(const char *type, const char *realm TSRMLS_DC);
 234
 235 /* }}} */
 236
 237 #endif
 238
 239 /*
 240  * Local variables:
 241  * tab-width: 4
 242  * c-basic-offset: 4
 243  * End:
 244  * vim600: noet sw=4 ts=4 fdm=marker
 245  * vim<600: noet sw=4 ts=4
 246  */
 247