X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=php_http_api.h;h=826f6cd198572b66b0192f8c26f46e431513f0ea;hp=c776ba82e5a904df3d9f696c2a44e258dbc16701;hb=ec76b279f999eaa62eeb83478f953ad477c6fe66;hpb=318bb3459a12dc26362978413cde00cde6616d89 diff --git a/php_http_api.h b/php_http_api.h index c776ba8..826f6cd 100644 --- a/php_http_api.h +++ b/php_http_api.h @@ -18,184 +18,117 @@ #ifndef PHP_HTTP_API_H #define PHP_HTTP_API_H -#ifdef PHP_WIN32 -# define PHP_HTTP_API __declspec(dllexport) -#else -# define PHP_HTTP_API -#endif - -#ifndef ZEND_ENGINE_2 -# include "php_http_build_query.h" -#endif - -/* make functions that return SUCCESS|FAILURE more obvious */ -typedef int STATUS; - -/* {{{ enum http_range_status */ -typedef enum { - RANGE_OK, - RANGE_NO, - RANGE_ERR -} http_range_status; -/* }}} */ - -/* {{{ enum http_send_mode */ -typedef enum { - SEND_DATA, - SEND_RSRC -} http_send_mode; -/* }}} */ - -/* CR LF */ -#define HTTP_CRLF "\r\n" - -/* max URI length */ -#define HTTP_URI_MAXLEN 2048 - -/* buffer size */ -#define HTTP_BUF_SIZE 2097152 - -/* server vars shorthand */ -#define HTTP_SERVER_VARS Z_ARRVAL_P(PG(http_globals)[TRACK_VARS_SERVER]) - -/* {{{ HAVE_CURL */ -#ifdef HTTP_HAVE_CURL -#include - -/* CURL buffer size */ -#define HTTP_CURLBUF_BODYSIZE 16384 -#define HTTP_CURLBUF_HDRSSIZE 4096 - -/* {{{ http_curlbuf_member */ -typedef enum { - CURLBUF_BODY = 1, - CURLBUF_HDRS = 2, - CURLBUF_EVRY = 3 -} http_curlbuf_member; -/* }}} */ -#endif -/* }}} HAVE_CURL */ - -/* {{{ HTTP_GSC(var, name, ret) */ -#define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret) -/* }}} */ - -/* {{{ HTTP_GSP(var, name, ret) */ -#define HTTP_GSP(var, name, ret) \ - if (!(var = http_get_server_var(name))) { \ - ret; \ - } \ - if (!Z_STRLEN_P(var)) { \ - ret; \ - } -/* }}} */ - -/* {{{ public API */ -#define http_date(t) _http_date((t) TSRMLS_CC) -PHP_HTTP_API char *_http_date(time_t t TSRMLS_DC); - -#define http_parse_date(d) _http_parse_date((d)) -PHP_HTTP_API time_t _http_parse_date(const char *date); - -#define http_send_status(s) _http_send_status((s) TSRMLS_CC) -PHP_HTTP_API inline STATUS _http_send_status(const int status TSRMLS_DC); - -#define http_send_header(h) _http_send_header((h) TSRMLS_CC) -PHP_HTTP_API inline STATUS _http_send_header(const char *header TSRMLS_DC); - -#define http_send_status_header(s, h) _http_send_status_header((s), (h) TSRMLS_CC) -PHP_HTTP_API inline STATUS _http_send_status_header(const int status, const char *header TSRMLS_DC); - -#define http_get_server_var(v) _http_get_server_var((v) TSRMLS_CC) -PHP_HTTP_API inline zval *_http_get_server_var(const char *key TSRMLS_DC); - -#define http_ob_etaghandler(o, l, ho, hl, m) _http_ob_etaghandler((o), (l), (ho), (hl), (m) TSRMLS_CC) -PHP_HTTP_API void _http_ob_etaghandler(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC); - -#define http_start_ob_handler(f, h, s, e) _http_start_ob_handler((f), (h), (s), (e) TSRMLS_CC) -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); - -#define http_modified_match(entry, modified) _http_modified_match((entry), (modified) TSRMLS_CC) -PHP_HTTP_API int _http_modified_match(const char *entry, const time_t t TSRMLS_DC); +#include "php_http_std_defs.h" +#include "php_http_send_api.h" -#define http_etag_match(entry, etag) _http_etag_match((entry), (etag) TSRMLS_CC) -PHP_HTTP_API int _http_etag_match(const char *entry, const char *etag TSRMLS_DC); +#define pretty_key(key, key_len, uctitle, xhyphen) _http_pretty_key(key, key_len, uctitle, xhyphen) +extern char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen); -#define http_send_last_modified(t) _http_send_last_modified((t) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send_last_modified(const time_t t TSRMLS_DC); +typedef void (*http_key_list_decode_t)(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC); +#define http_key_list_default_decoder _http_key_list_default_decoder +extern void _http_key_list_default_decoder(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC); -#define http_send_etag(e, l) _http_send_etag((e), (l) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send_etag(const char *etag, const int etag_len TSRMLS_DC); +#define http_parse_cookie(l, i) _http_parse_key_list((l), (i), ';', http_key_list_default_decoder, 1 TSRMLS_CC) +#define http_parse_key_list(l, i, s, d, f) _http_parse_key_list((l), (i), (s), (d), (f) TSRMLS_CC) +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); -#define http_absolute_uri(url, proto) _http_absolute_uri((url), (proto) TSRMLS_CC) -PHP_HTTP_API char *_http_absolute_uri(const char *url, const char *proto TSRMLS_DC); +#define http_error(type, code, string) _http_error_ex(type, code, "%s", string) +#define http_error_ex _http_error_ex +extern void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...); -#define http_negotiate_language(supported, def) _http_negotiate_q("HTTP_ACCEPT_LANGUAGE", (supported), (def) TSRMLS_CC) -#define http_negotiate_charset(supported, def) _http_negotiate_q("HTTP_ACCEPT_CHARSET", (supported), (def) TSRMLS_CC) -#define http_negotiate_q(e, s, d, t) _http_negotiate_q((e), (s), (d), (t) TSRMLS_CC) -PHP_HTTP_API char *_http_negotiate_q(const char *entry, const zval *supported, const char *def TSRMLS_DC); +#define http_log(f, i, m) _http_log_ex((f), (i), (m) TSRMLS_CC) +extern void http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC); -#define http_get_request_ranges(r, l) _http_get_request_ranges((r), (l) TSRMLS_CC) -PHP_HTTP_API http_range_status _http_get_request_ranges(zval *zranges, const size_t length TSRMLS_DC); +#define http_exit(s, h) http_exit_ex((s), (h), NULL, 1) +#define http_exit_ex(s, h, b, e) _http_exit_ex((s), (h), (b), (e) TSRMLS_CC) +extern STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC); -#define http_send_ranges(r, d, s, m) _http_send_ranges((r), (d), (s), (m) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send_ranges(zval *zranges, const void *data, const size_t size, const http_send_mode mode TSRMLS_DC); +#define http_check_method(m) http_check_method_ex((m), HTTP_KNOWN_METHODS) +#define http_check_method_ex(m, a) _http_check_method_ex((m), (a)) +extern STATUS _http_check_method_ex(const char *method, const char *methods); -#define http_send(d, s, m) _http_send((d), (s), (m) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send(const void *data, const size_t data_size, const http_send_mode mode TSRMLS_DC); - -#define http_send_data(z) _http_send_data((z) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send_data(const zval *zdata TSRMLS_DC); - -#define http_send_stream(s) _http_send_stream((s) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send_stream(const php_stream *s TSRMLS_DC); +#define HTTP_GSC(var, name, ret) HTTP_GSP(var, name, return ret) +#define HTTP_GSP(var, name, ret) \ + if (!(var = _http_get_server_var_ex(name, strlen(name)+1, 1 TSRMLS_CC))) { \ + ret; \ + } +#define http_got_server_var(v) (NULL != _http_get_server_var_ex((v), sizeof(v), 1 TSRMLS_CC)) +#define http_get_server_var(v) http_get_server_var_ex((v), sizeof(v)) +#define http_get_server_var_ex(v, s) _http_get_server_var_ex((v), (s), 0 TSRMLS_CC) +PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC); -#define http_send_file(f) _http_send_file((f) TSRMLS_CC) -PHP_HTTP_API STATUS _http_send_file(const zval *zfile TSRMLS_DC); +#define http_get_request_body(b, l) _http_get_request_body_ex((b), (l), 1 TSRMLS_CC) +#define http_get_Request_body_ex(b, l, d) _http_get_request_body_ex((b), (l), (d) TSRMLS_CC) +PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC); #define http_chunked_decode(e, el, d, dl) _http_chunked_decode((e), (el), (d), (dl) TSRMLS_CC) -PHP_HTTP_API STATUS _http_chunked_decode(const char *encoded, const size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC); - -#define http_split_response(r, h, b) _http_split_response((r), (h), (b) TSRMLS_CC) -PHP_HTTP_API STATUS _http_split_response(const zval *zresponse, zval *zheaders, zval *zbody TSRMLS_DC); - -#define http_parse_headers(h, l, a) _http_parse_headers((h), (l), (a) TSRMLS_CC) -PHP_HTTP_API STATUS _http_parse_headers(char *header, int header_len, zval *array TSRMLS_DC); - -#define http_get_request_headers(h) _http_get_request_headers((h) TSRMLS_CC) -PHP_HTTP_API void _http_get_request_headers(zval *array TSRMLS_DC); - -/* {{{ HAVE_CURL */ -#ifdef HTTP_HAVE_CURL - -#define http_get(u, o, i, d, l) _http_get((u), (o), (i), (d), (l) TSRMLS_CC) -PHP_HTTP_API STATUS _http_get(const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC); -#define http_get_ex(c, u, o, i, d, l) _http_get_ex((c), (u), (o), (i), (d), (l) TSRMLS_CC) -PHP_HTTP_API STATUS _http_get_ex(CURL *ch, const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC); - -#define http_head(u, o, i, d, l) _http_head((u), (o), (i), (d), (l) TSRMLS_CC) -PHP_HTTP_API STATUS _http_head(const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC); -#define http_head_ex(c, u, o, i, d, l) _http_head_ex((c), (u), (o), (i), (d), (l) TSRMLS_CC) -PHP_HTTP_API STATUS _http_head_ex(CURL *ch, const char *URL, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC); - -#define http_post_data(u, pd, pl, o, i, d, l) _http_post_data((u), (pd), (pl), (o), (i), (d), (l) TSRMLS_CC) -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); -#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) -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); - -#define http_post_array(u, p, o, i, d, l) _http_post_array((u), (p), (o), (i), (d), (l) TSRMLS_CC) -PHP_HTTP_API STATUS _http_post_array(const char *URL, HashTable *postarray, HashTable *options, HashTable *info, char **data, size_t *data_len TSRMLS_DC); - -#endif -/* }}} HAVE_CURL */ - -#define http_auth_credentials(u, p) _http_auth_credentials((u), (p) TSRMLS_CC) -PHP_HTTP_API STATUS _http_auth_credentials(char **user, char **pass TSRMLS_DC); - -#define http_auth_header(t, r) _http_auth_header((t), (r) TSRMLS_CC) -PHP_HTTP_API STATUS _http_auth_header(const char *type, const char *realm TSRMLS_DC); +PHP_HTTP_API const char *_http_chunked_decode(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC); + +#define http_guess_content_type(mf, mm, d, l, m) _http_guess_content_type((mf), (mm), (d), (l), (m) TSRMLS_CC) +PHP_HTTP_API char *_http_guess_content_type(const char *magic_file, long magic_mode, void *data_ptr, size_t data_len, http_send_mode mode TSRMLS_DC); + + +#define http_locate_body _http_locate_body +static inline const char *_http_locate_body(const char *message) +{ + const char *cr = strstr(message, "\r\n\r\n"); + const char *lf = strstr(message, "\n\n"); + + if (lf && cr) { + return MIN(lf + 2, cr + 4); + } else if (lf || cr) { + return MAX(lf + 2, cr + 4); + } else { + return NULL; + } +} + +#define http_locate_eol _http_locate_eol +static inline const char *_http_locate_eol(const char *line, int *eol_len) +{ + const char *eol = strpbrk(line, "\r\n"); + + if (eol_len) { + *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0; + } + return eol; +} + +#define convert_to_type(t, z) _convert_to_type((t), (z)) +static inline zval *_convert_to_type(int type, zval *z) +{ + if (Z_TYPE_P(z) != type) { + switch (type) + { + case IS_NULL: convert_to_null(z); break; + case IS_BOOL: convert_to_boolean(z); break; + case IS_LONG: convert_to_long(z); break; + case IS_DOUBLE: convert_to_array(z); break; + case IS_STRING: convert_to_string(z); break; + case IS_ARRAY: convert_to_array(z); break; + case IS_OBJECT: convert_to_object(z); break; + } + } + return z; +} +#define convert_to_type_ex(t, z) _convert_to_type_ex((t), (z)) +static inline zval *_convert_to_type_ex(int type, zval *z) +{ + if (Z_TYPE_P(z) != type) { + switch (type) + { + case IS_NULL: convert_to_null_ex(&z); break; + case IS_BOOL: convert_to_boolean_ex(&z); break; + case IS_LONG: convert_to_long_ex(&z); break; + case IS_DOUBLE: convert_to_array_ex(&z); break; + case IS_STRING: convert_to_string_ex(&z); break; + case IS_ARRAY: convert_to_array_ex(&z); break; + case IS_OBJECT: convert_to_object_ex(&z); break; + } + } + return z; +} -/* }}} */ #endif