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 /* make functions that return SUCCESS|FAILURE more obvious */
  28 typedef int STATUS;
  29
  30 /* {{{ enum http_range_status */
  31 typedef enum {
  32         RANGE_OK,
  33         RANGE_NO,
  34         RANGE_ERR
  35 } http_range_status;
  36 /* }}} */
  37
  38 /* {{{ enum http_send_mode */
  39 typedef enum {
  40         SEND_DATA,
  41         SEND_RSRC
  42 } http_send_mode;
  43 /* }}} */
  44
  45 char *pretty_key(char *key, int key_len, int uctitle, int xhyphen);
  46
  47 /* {{{ public API */
  48 #define http_date(t) _http_date((t) TSRMLS_CC)
  49 PHP_HTTP_API char *_http_date(time_t t TSRMLS_DC);
  50
  51 #define http_parse_date(d) _http_parse_date((d))
  52 PHP_HTTP_API time_t _http_parse_date(const char *date);
  53
  54 #define http_send_status(s) sapi_header_op(SAPI_HEADER_SET_STATUS, (void *) (s) TSRMLS_CC)
  55 #define http_send_header(h) http_send_status_header(0, (h))
  56 #define http_send_status_header(s, h) _http_send_status_header((s), (h) TSRMLS_CC)
  57 PHP_HTTP_API STATUS _http_send_status_header(const int status, const char *header TSRMLS_DC);
  58
  59 #define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC))
  60 #define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v))
  61 #define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC)
  62 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC);
  63
  64 #define http_etag(p, l, m) _http_etag((p), (l), (m) TSRMLS_CC)
  65 PHP_HTTP_API char *_http_etag(const void *data_ptr, const size_t data_len, const http_send_mode data_mode TSRMLS_DC);
  66
  67 #define http_lmod(p, m) _http_lmod((p), (m) TSRMLS_CC)
  68 PHP_HTTP_API time_t _http_lmod(const void *data_ptr, const http_send_mode data_mode TSRMLS_DC);
  69
  70 #define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC)
  71 PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC);
  72
  73 #define http_start_ob_handler(f, h, s, e) _http_start_ob_handler((f), (h), (s), (e) TSRMLS_CC)
  74 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);
  75
  76 #define http_modified_match(entry, modified) _http_modified_match_ex((entry), (modified), 1 TSRMLS_CC)
  77 #define http_modified_match_ex(entry, modified, ep) _http_modified_match_ex((entry), (modified), (ep) TSRMLS_CC)
  78 PHP_HTTP_API int _http_modified_match_ex(const char *entry, const time_t t, const int enforce_presence TSRMLS_DC);
  79
  80 #define http_etag_match(entry, etag) _http_etag_match_ex((entry), (etag), 1 TSRMLS_CC)
  81 #define http_etag_match_ex(entry, etag, ep) _http_etag_match_ex((entry), (etag), (ep) TSRMLS_CC)
  82 PHP_HTTP_API int _http_etag_match_ex(const char *entry, const char *etag, const int enforce_presence TSRMLS_DC);
  83
  84 #define http_send_last_modified(t) _http_send_last_modified((t) TSRMLS_CC)
  85 PHP_HTTP_API STATUS _http_send_last_modified(const time_t t TSRMLS_DC);
  86
  87 #define http_send_etag(e, l) _http_send_etag((e), (l) TSRMLS_CC)
  88 PHP_HTTP_API STATUS _http_send_etag(const char *etag, const int etag_len TSRMLS_DC);
  89
  90 #define http_send_cache_control(c, l) _http_send_cache_control((c), (l) TSRMLS_CC)
  91 PHP_HTTP_API STATUS _http_send_cache_control(const char *cache_control, const size_t cc_len TSRMLS_DC);
  92
  93 #define http_send_content_type(c, l) _http_send_content_type((c), (l) TSRMLS_CC)
  94 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, const size_t ct_len TSRMLS_DC);
  95
  96 #define http_send_content_disposition(f, l, i) _http_send_content_disposition((f), (l), (i) TSRMLS_CC)
  97 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, const size_t f_len, const int send_inline TSRMLS_DC);
  98
  99 #define http_cache_last_modified(l, s, cc, ccl) _http_cache_last_modified((l), (s), (cc), (ccl) TSRMLS_CC)
 100 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);
 101
 102 #define http_cache_etag(e, el, cc, ccl) _http_cache_etag((e), (el), (cc), (ccl) TSRMLS_CC)
 103 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);
 104
 105 #define http_absolute_uri(url) http_absolute_uri_ex((url), strlen(url), NULL, 0, NULL, 0, 0)
 106 #define http_absolute_uri_ex(url, url_len, proto, proto_len, host, host_len, port) _http_absolute_uri_ex((url), (url_len), (proto), (proto_len), (host), (host_len), (port) TSRMLS_CC)
 107 PHP_HTTP_API char *_http_absolute_uri_ex(const char *url, size_t url_len, const char *proto, size_t proto_len, const char *host, size_t host_len, unsigned port TSRMLS_DC);
 108
 109 #define http_negotiate_language(zsupported, def) http_negotiate_language_ex(Z_ARRVAL_P(zsupported), (def))
 110 #define http_negotiate_language_ex(supported, def) http_negotiate_q("HTTP_ACCEPT_LANGUAGE", (supported), (def))
 111 #define http_negotiate_charset(zsupported, def) http_negotiate_charset_ex(Z_ARRVAL_P(zsupported), (def))
 112 #define http_negotiate_charset_ex(supported, def)  http_negotiate_q("HTTP_ACCEPT_CHARSET", (supported), (def))
 113 #define http_negotiate_q(e, s, d) _http_negotiate_q((e), (s), (d) TSRMLS_CC)
 114 PHP_HTTP_API char *_http_negotiate_q(const char *entry, const HashTable *supported, const char *def TSRMLS_DC);
 115
 116 #define http_get_request_ranges(r, l) _http_get_request_ranges((r), (l) TSRMLS_CC)
 117 PHP_HTTP_API http_range_status _http_get_request_ranges(HashTable *ranges, const size_t length TSRMLS_DC);
 118
 119 #define http_send_ranges(r, d, s, m) _http_send_ranges((r), (d), (s), (m) TSRMLS_CC)
 120 PHP_HTTP_API STATUS _http_send_ranges(HashTable *ranges, const void *data, const size_t size, const http_send_mode mode TSRMLS_DC);
 121
 122 #define http_send_data(d, l) http_send((d), (l), SEND_DATA)
 123 #define http_send(d, s, m) _http_send((d), (s), (m) TSRMLS_CC)
 124 PHP_HTTP_API STATUS _http_send(const void *data, const size_t data_size, const http_send_mode mode TSRMLS_DC);
 125
 126 #define http_send_file(f) http_send_stream_ex(php_stream_open_wrapper(f, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL), 1)
 127 #define http_send_stream(s) http_send_stream_ex((s), 0)
 128 #define http_send_stream_ex(s, c) _http_send_stream_ex((s), (c) TSRMLS_CC)
 129 PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *s, zend_bool close_stream TSRMLS_DC);
 130
 131 #define http_chunked_decode(e, el, d, dl) _http_chunked_decode((e), (el), (d), (dl) TSRMLS_CC)
 132 PHP_HTTP_API STATUS _http_chunked_decode(const char *encoded, const size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
 133
 134 #define http_urlencode_hash(h, q) _http_urlencode_hash_ex((h), 1, NULL, 0, (q), NULL TSRMLS_CC)
 135 #define http_urlencode_hash_ex(h, o, p, pl, q, ql) _http_urlencode_hash_ex((h), (o), (p), (pl), (q), (ql) TSRMLS_CC)
 136 PHP_HTTP_API STATUS _http_urlencode_hash_ex(HashTable *hash, int override_argsep, char *pre_encoded_data, size_t pre_encoded_len, char **encoded_data, size_t *encoded_len TSRMLS_DC);
 137
 138 #define http_split_response(r, h, b) _http_split_response((r), (h), (b) TSRMLS_CC)
 139 PHP_HTTP_API STATUS _http_split_response(zval *response, zval *headers, zval *body TSRMLS_DC);
 140 #define http_split_response_ex(r, rl, h, b, bl) _http_split_response_ex((r), (rl), (h), (b), (bl) TSRMLS_CC)
 141 PHP_HTTP_API STATUS _http_split_response_ex(char *response, size_t repsonse_len, HashTable *headers, char **body, size_t *body_len TSRMLS_DC);
 142
 143 #define http_parse_headers(h, l, a) _http_parse_headers_ex((h), (l), Z_ARRVAL_P(a), 1 TSRMLS_CC)
 144 #define http_parse_headers_ex(h, l, ht, p) _http_parse_headers_ex((h), (l), (ht), (p) TSRMLS_CC)
 145 PHP_HTTP_API STATUS _http_parse_headers_ex(char *header, int header_len, HashTable *headers, zend_bool prettify TSRMLS_DC);
 146
 147 #define http_get_request_headers(h) _http_get_request_headers_ex(Z_ARRVAL_P(h), 1 TSRMLS_CC)
 148 #define http_get_request_headers_ex(h, p) _http_get_request_headers_ex((h), (s) TSRMLS_CC)
 149 PHP_HTTP_API void _http_get_request_headers_ex(HashTable *headers, zend_bool prettify TSRMLS_DC);
 150
 151 #define http_auth_credentials(u, p) _http_auth_credentials((u), (p) TSRMLS_CC)
 152 PHP_HTTP_API STATUS _http_auth_credentials(char **user, char **pass TSRMLS_DC);
 153
 154 #define http_auth_header(t, r) _http_auth_header((t), (r) TSRMLS_CC)
 155 PHP_HTTP_API STATUS _http_auth_header(const char *type, const char *realm TSRMLS_DC);
 156
 157 #ifndef ZEND_ENGINE_2
 158 #define php_url_encode_hash(ht, formstr)        php_url_encode_hash_ex((ht), (formstr), NULL, 0, NULL, 0, NULL, 0, NULL TSRMLS_CC)
 159 PHP_HTTP_API STATUS php_url_encode_hash_ex(HashTable *ht, smart_str *formstr,
 160                                 const char *num_prefix, int num_prefix_len,
 161                                 const char *key_prefix, int key_prefix_len,
 162                                 const char *key_suffix, int key_suffix_len,
 163                                 zval *type TSRMLS_DC);
 164 #endif
 165
 166 /* }}} */
 167
 168 #endif
 169
 170 /*
 171  * Local variables:
 172  * tab-width: 4
 173  * c-basic-offset: 4
 174  * End:
 175  * vim600: noet sw=4 ts=4 fdm=marker
 176  * vim<600: noet sw=4 ts=4
 177  */
 178