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 #define RETURN_SUCCESS(v)       RETURN_BOOL(SUCCESS == (v))
  32 #define HASH_ORNULL(z)          ((z) ? Z_ARRVAL_P(z) : NULL)
  33 #define NO_ARGS                         if (ZEND_NUM_ARGS()) WRONG_PARAM_COUNT
  34
  35 #define array_copy(src, dst)    zend_hash_copy(Z_ARRVAL_P(dst), Z_ARRVAL_P(src), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
  36 #define array_merge(src, dst)   zend_hash_merge(Z_ARRVAL_P(dst), Z_ARRVAL_P(src), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *), 1)
  37
  38 #ifdef ZEND_ENGINE_2
  39
  40 #       define HTTP_REGISTER_CLASS_EX(classname, name, parent, flags) \
  41         { \
  42                 zend_class_entry ce; \
  43                 INIT_CLASS_ENTRY(ce, #classname, name## _class_methods); \
  44                 ce.create_object = name## _new_object; \
  45                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
  46                 name## _ce->ce_flags |= flags;  \
  47                 memcpy(& name## _object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers)); \
  48                 name## _object_handlers.clone_obj = NULL; \
  49                 name## _declare_default_properties(name## _ce); \
  50         }
  51
  52 #       define HTTP_REGISTER_CLASS(classname, name, parent, flags) \
  53         { \
  54                 zend_class_entry ce; \
  55                 INIT_CLASS_ENTRY(ce, #classname, name## _class_methods); \
  56                 ce.create_object = NULL; \
  57                 name## _ce = zend_register_internal_class_ex(&ce, parent, NULL TSRMLS_CC); \
  58                 name## _ce->ce_flags |= flags;  \
  59         }
  60
  61 #       define getObject(t, o) t * o = ((t *) zend_object_store_get_object(getThis() TSRMLS_CC))
  62 #       define OBJ_PROP(o) o->zo.properties
  63 #       define DCL_PROP(a, t, n, v) zend_declare_property_ ##t(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a) TSRMLS_CC)
  64 #       define DCL_PROP_Z(a, n, v) zend_declare_property(ce, (#n), sizeof(#n), (v), (ZEND_ACC_ ##a) TSRMLS_CC)
  65 #       define DCL_PROP_N(a, n) zend_declare_property_null(ce, (#n), sizeof(#n), (ZEND_ACC_ ##a) TSRMLS_CC)
  66 #       define UPD_PROP(o, t, n, v) zend_update_property_ ##t(o->zo.ce, getThis(), (#n), sizeof(#n), (v) TSRMLS_CC)
  67 #       define SET_PROP(o, n, z) zend_update_property(o->zo.ce, getThis(), (#n), sizeof(#n), (z) TSRMLS_CC)
  68 #       define GET_PROP(o, n) zend_read_property(o->zo.ce, getThis(), (#n), sizeof(#n), 0 TSRMLS_CC)
  69
  70 #       define INIT_PARR(o, n) \
  71         { \
  72                 zval *__tmp; \
  73                 MAKE_STD_ZVAL(__tmp); \
  74                 array_init(__tmp); \
  75                 SET_PROP(o, n, __tmp); \
  76         }
  77
  78 #       define FREE_PARR(o, p) \
  79         { \
  80                 zval *__tmp = NULL; \
  81                 if (__tmp = GET_PROP(o, p)) { \
  82                         zval_dtor(__tmp); \
  83                         FREE_ZVAL(__tmp); \
  84                         __tmp = NULL; \
  85                 } \
  86         }
  87
  88 #endif /* ZEND_ENGINE_2 */
  89
  90 /* make functions that return SUCCESS|FAILURE more obvious */
  91 typedef int STATUS;
  92
  93 /* {{{ enum http_range_status */
  94 typedef enum {
  95         RANGE_OK,
  96         RANGE_NO,
  97         RANGE_ERR
  98 } http_range_status;
  99 /* }}} */
 100
 101 /* {{{ enum http_send_mode */
 102 typedef enum {
 103         SEND_DATA,
 104         SEND_RSRC
 105 } http_send_mode;
 106 /* }}} */
 107
 108 /* CR LF */
 109 #define HTTP_CRLF "\r\n"
 110
 111 /* default cache control */
 112 #define HTTP_DEFAULT_CACHECONTROL "private, must-revalidate, max-age=0"
 113
 114 /* max URI length */
 115 #define HTTP_URI_MAXLEN 2048
 116
 117 /* buffer size */
 118 #define HTTP_BUF_SIZE 2097152
 119
 120 /* server vars shorthand */
 121 #define HTTP_SERVER_VARS Z_ARRVAL_P(PG(http_globals)[TRACK_VARS_SERVER])
 122
 123
 124 /* {{{ HTTP_GSC(var, name, ret) */
 125 #define HTTP_GSC(var, name, ret)  HTTP_GSP(var, name, return ret)
 126 /* }}} */
 127
 128 /* {{{ HTTP_GSP(var, name, ret) */
 129 #define HTTP_GSP(var, name, ret) \
 130                 if (!(var = http_get_server_var(name))) { \
 131                         ret; \
 132                 } \
 133                 if (!Z_STRLEN_P(var)) { \
 134                         ret; \
 135                 }
 136 /* }}} */
 137
 138 char *pretty_key(char *key, int key_len, int uctitle, int xhyphen);
 139
 140 /* {{{ public API */
 141 #define http_date(t) _http_date((t) TSRMLS_CC)
 142 PHP_HTTP_API char *_http_date(time_t t TSRMLS_DC);
 143
 144 #define http_parse_date(d) _http_parse_date((d))
 145 PHP_HTTP_API time_t _http_parse_date(const char *date);
 146
 147 #define http_send_status(s) _http_send_status((s) TSRMLS_CC)
 148 PHP_HTTP_API inline STATUS _http_send_status(const int status TSRMLS_DC);
 149
 150 #define http_send_header(h) _http_send_header((h) TSRMLS_CC)
 151 PHP_HTTP_API inline STATUS _http_send_header(const char *header TSRMLS_DC);
 152
 153 #define http_send_status_header(s, h) _http_send_status_header((s), (h) TSRMLS_CC)
 154 PHP_HTTP_API inline STATUS _http_send_status_header(const int status, const char *header TSRMLS_DC);
 155
 156 #define http_get_server_var(v) _http_get_server_var((v) TSRMLS_CC)
 157 PHP_HTTP_API inline zval *_http_get_server_var(const char *key TSRMLS_DC);
 158
 159 #define http_etag(p, l, m) _http_etag((p), (l), (m) TSRMLS_CC)
 160 PHP_HTTP_API inline char *_http_etag(const void *data_ptr, const size_t data_len, const http_send_mode data_mode TSRMLS_DC);
 161
 162 #define http_lmod(p, m) _http_lmod((p), (m) TSRMLS_CC)
 163 PHP_HTTP_API inline time_t _http_lmod(const void *data_ptr, const http_send_mode data_mode TSRMLS_DC);
 164
 165 #define http_is_range_request() _http_is_range_request(TSRMLS_C)
 166 PHP_HTTP_API inline int _http_is_range_request(TSRMLS_D);
 167
 168 #define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC)
 169 PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC);
 170
 171 #define http_start_ob_handler(f, h, s, e) _http_start_ob_handler((f), (h), (s), (e) TSRMLS_CC)
 172 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);
 173
 174 #define http_modified_match(entry, modified) _http_modified_match((entry), (modified) TSRMLS_CC)
 175 PHP_HTTP_API int _http_modified_match(const char *entry, const time_t t TSRMLS_DC);
 176
 177 #define http_etag_match(entry, etag) _http_etag_match((entry), (etag) TSRMLS_CC)
 178 PHP_HTTP_API int _http_etag_match(const char *entry, const char *etag TSRMLS_DC);
 179
 180 #define http_send_last_modified(t) _http_send_last_modified((t) TSRMLS_CC)
 181 PHP_HTTP_API STATUS _http_send_last_modified(const time_t t TSRMLS_DC);
 182
 183 #define http_send_etag(e, l) _http_send_etag((e), (l) TSRMLS_CC)
 184 PHP_HTTP_API STATUS _http_send_etag(const char *etag, const int etag_len TSRMLS_DC);
 185
 186 #define http_send_cache_control(c, l) _http_send_cache_control((c), (l) TSRMLS_CC)
 187 PHP_HTTP_API STATUS _http_send_cache_control(const char *cache_control, const size_t cc_len TSRMLS_DC);
 188
 189 #define http_send_content_type(c, l) _http_send_content_type((c), (l) TSRMLS_CC)
 190 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, const size_t ct_len TSRMLS_DC);
 191
 192 #define http_send_content_disposition(f, l, i) _http_send_content_disposition((f), (l), (i) TSRMLS_CC)
 193 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, const size_t f_len, const int send_inline TSRMLS_DC);
 194
 195 #define http_cache_last_modified(l, s, cc, ccl) _http_cache_last_modified((l), (s), (cc), (ccl) TSRMLS_CC)
 196 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);
 197
 198 #define http_cache_etag(e, el, cc, ccl) _http_cache_etag((e), (el), (cc), (ccl) TSRMLS_CC)
 199 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);
 200
 201 #define http_absolute_uri(url, proto) _http_absolute_uri((url), (proto) TSRMLS_CC)
 202 PHP_HTTP_API char *_http_absolute_uri(const char *url, const char *proto TSRMLS_DC);
 203
 204 #define http_negotiate_language(supported, def) _http_negotiate_q("HTTP_ACCEPT_LANGUAGE", (supported), (def) TSRMLS_CC)
 205 #define http_negotiate_charset(supported, def)  _http_negotiate_q("HTTP_ACCEPT_CHARSET", (supported), (def) TSRMLS_CC)
 206 #define http_negotiate_q(e, s, d, t) _http_negotiate_q((e), (s), (d), (t) TSRMLS_CC)
 207 PHP_HTTP_API char *_http_negotiate_q(const char *entry, const zval *supported, const char *def TSRMLS_DC);
 208
 209 #define http_get_request_ranges(r, l) _http_get_request_ranges((r), (l) TSRMLS_CC)
 210 PHP_HTTP_API http_range_status _http_get_request_ranges(zval *zranges, const size_t length TSRMLS_DC);
 211
 212 #define http_send_ranges(r, d, s, m) _http_send_ranges((r), (d), (s), (m) TSRMLS_CC)
 213 PHP_HTTP_API STATUS _http_send_ranges(zval *zranges, const void *data, const size_t size, const http_send_mode mode TSRMLS_DC);
 214
 215 #define http_send(d, s, m) _http_send((d), (s), (m) TSRMLS_CC)
 216 PHP_HTTP_API STATUS _http_send(const void *data, const size_t data_size, const http_send_mode mode TSRMLS_DC);
 217
 218 #define http_send_data(z) _http_send_data((z) TSRMLS_CC)
 219 PHP_HTTP_API STATUS _http_send_data(const zval *zdata TSRMLS_DC);
 220
 221 #define http_send_stream(s) _http_send_stream((s) TSRMLS_CC)
 222 PHP_HTTP_API STATUS _http_send_stream(const php_stream *s TSRMLS_DC);
 223
 224 #define http_send_file(f) _http_send_file((f) TSRMLS_CC)
 225 PHP_HTTP_API STATUS _http_send_file(const zval *zfile TSRMLS_DC);
 226
 227 #define http_chunked_decode(e, el, d, dl) _http_chunked_decode((e), (el), (d), (dl) TSRMLS_CC)
 228 PHP_HTTP_API STATUS _http_chunked_decode(const char *encoded, const size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
 229
 230 #define http_split_response(r, h, b) _http_split_response_ex(Z_STRVAL_P(r), Z_STRLEN_P(r), (h), (b) TSRMLS_CC)
 231 #define http_split_response_ex(r, l, h, b) _http_split_response_ex((r), (l), (h), (b) TSRMLS_CC)
 232 PHP_HTTP_API STATUS _http_split_response_ex(char *response, size_t repsonse_len, zval *zheaders, zval *zbody TSRMLS_DC);
 233
 234 #define http_parse_headers(h, l, a) _http_parse_headers((h), (l), (a) TSRMLS_CC)
 235 PHP_HTTP_API STATUS _http_parse_headers(char *header, int header_len, zval *array TSRMLS_DC);
 236
 237 #define http_get_request_headers(h) _http_get_request_headers((h) TSRMLS_CC)
 238 PHP_HTTP_API void _http_get_request_headers(zval *array TSRMLS_DC);
 239
 240 #define http_auth_credentials(u, p) _http_auth_credentials((u), (p) TSRMLS_CC)
 241 PHP_HTTP_API STATUS _http_auth_credentials(char **user, char **pass TSRMLS_DC);
 242
 243 #define http_auth_header(t, r) _http_auth_header((t), (r) TSRMLS_CC)
 244 PHP_HTTP_API STATUS _http_auth_header(const char *type, const char *realm TSRMLS_DC);
 245
 246 /* }}} */
 247
 248 #endif
 249
 250 /*
 251  * Local variables:
 252  * tab-width: 4
 253  * c-basic-offset: 4
 254  * End:
 255  * vim600: noet sw=4 ts=4 fdm=marker
 256  * vim<600: noet sw=4 ts=4
 257  */
 258