X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_response_object.c;h=dfc2476a8819259df634f5b2dbad0577cf9c3cf2;hp=9f5d3c14befa4e6608e8c2a6458405fb4343ce1d;hb=afd561b680a07837192efbdb9ffe248def36f8e9;hpb=73ca84f4751d2197ee39b92c3b924b8e64b0ff0d diff --git a/http_response_object.c b/http_response_object.c index 9f5d3c1..dfc2476 100644 --- a/http_response_object.c +++ b/http_response_object.c @@ -21,27 +21,47 @@ #endif #include "php.h" -#ifdef ZEND_ENGINE_2 +#include "missing.h" + +/* broken static properties in PHP 5.0 */ +#if defined(ZEND_ENGINE_2) && !defined(WONKY) + +#include "SAPI.h" +#include "php_ini.h" #include "php_http.h" #include "php_http_api.h" #include "php_http_std_defs.h" #include "php_http_response_object.h" +#include "php_http_exception_object.h" #include "php_http_send_api.h" #include "php_http_cache_api.h" +#include "php_http_headers_api.h" -#include "missing.h" +#ifdef HTTP_HAVE_MHASH +# include +#endif ZEND_EXTERN_MODULE_GLOBALS(http); +#define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n) +#define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v) +#define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v) +#define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l) + #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args) #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref) -#define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility) +#define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC) +#define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method)) -HTTP_EMPTY_ARGS(__destruct, 0); -HTTP_BEGIN_ARGS(__construct, 0) - HTTP_ARG_VAL(cache, 0) - HTTP_ARG_VAL(gzip, 0) +HTTP_BEGIN_ARGS(setHeader, 2) + HTTP_ARG_VAL(name, 0) + HTTP_ARG_VAL(value, 0) + HTTP_ARG_VAL(replace, 0) +HTTP_END_ARGS; + +HTTP_BEGIN_ARGS(getHeader, 0) + HTTP_ARG_VAL(name, 0) HTTP_END_ARGS; HTTP_EMPTY_ARGS(getETag, 0); @@ -49,6 +69,11 @@ HTTP_BEGIN_ARGS(setETag, 1) HTTP_ARG_VAL(etag, 0) HTTP_END_ARGS; +HTTP_EMPTY_ARGS(getLastModified, 0); +HTTP_BEGIN_ARGS(setLastModified, 1) + HTTP_ARG_VAL(timestamp, 0) +HTTP_END_ARGS; + HTTP_EMPTY_ARGS(getCache, 0); HTTP_BEGIN_ARGS(setCache, 1) HTTP_ARG_VAL(cache, 0) @@ -62,7 +87,7 @@ HTTP_END_ARGS; HTTP_EMPTY_ARGS(getCacheControl, 0); HTTP_BEGIN_ARGS(setCacheControl, 1) HTTP_ARG_VAL(cache_control, 0) - HTTP_ARG_VAL(raw, 0) + HTTP_ARG_VAL(max_age, 0) HTTP_END_ARGS; HTTP_EMPTY_ARGS(getContentType, 0); @@ -70,6 +95,11 @@ HTTP_BEGIN_ARGS(setContentType, 1) HTTP_ARG_VAL(content_type, 0) HTTP_END_ARGS; +HTTP_BEGIN_ARGS(guessContentType, 1) + HTTP_ARG_VAL(magic_file, 0) + HTTP_ARG_VAL(magic_mode, 0) +HTTP_END_ARGS; + HTTP_EMPTY_ARGS(getContentDisposition, 0); HTTP_BEGIN_ARGS(setContentDisposition, 1) HTTP_ARG_VAL(filename, 0) @@ -81,8 +111,8 @@ HTTP_BEGIN_ARGS(setThrottleDelay, 1) HTTP_ARG_VAL(seconds, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getSendBuffersize, 0); -HTTP_BEGIN_ARGS(setSendBuffersize, 1) +HTTP_EMPTY_ARGS(getBufferSize, 0); +HTTP_BEGIN_ARGS(setBufferSize, 1) HTTP_ARG_VAL(bytes, 0) HTTP_END_ARGS; @@ -105,26 +135,46 @@ HTTP_BEGIN_ARGS(send, 0) HTTP_ARG_VAL(clean_ob, 0) HTTP_END_ARGS; -HTTP_BEGIN_ARGS(catchOutput, 0) - HTTP_ARG_VAL(clean_ob, 0) +HTTP_EMPTY_ARGS(capture, 0); + +HTTP_BEGIN_ARGS(redirect, 0) + HTTP_ARG_VAL(url, 0) + HTTP_ARG_VAL(params, 0) + HTTP_ARG_VAL(session, 0) + HTTP_ARG_VAL(permanent, 0) HTTP_END_ARGS; +HTTP_BEGIN_ARGS(status, 1) + HTTP_ARG_VAL(code, 0) +HTTP_END_ARGS; + +HTTP_EMPTY_ARGS(getRequestHeaders, 0); +HTTP_EMPTY_ARGS(getRequestBody, 0); + #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C) static inline void _http_response_object_declare_default_properties(TSRMLS_D); +#define http_grab_response_headers _http_grab_response_headers +static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC); zend_class_entry *http_response_object_ce; zend_function_entry http_response_object_fe[] = { - HTTP_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR) - HTTP_RESPONSE_ME(__destruct, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR) + + HTTP_RESPONSE_ME(setHeader, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(getHeader, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(setETag, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getETag, ZEND_ACC_PUBLIC) + + HTTP_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(getLastModified, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getContentDisposition, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getContentType, ZEND_ACC_PUBLIC) + + HTTP_RESPONSE_ME(guessContentType, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(setCache, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getCache, ZEND_ACC_PUBLIC) @@ -138,8 +188,8 @@ zend_function_entry http_response_object_fe[] = { HTTP_RESPONSE_ME(setThrottleDelay, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getThrottleDelay, ZEND_ACC_PUBLIC) - HTTP_RESPONSE_ME(setSendBuffersize, ZEND_ACC_PUBLIC) - HTTP_RESPONSE_ME(getSendBuffersize, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(setBufferSize, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(getBufferSize, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(setData, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getData, ZEND_ACC_PUBLIC) @@ -151,81 +201,727 @@ zend_function_entry http_response_object_fe[] = { HTTP_RESPONSE_ME(getStream, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(send, ZEND_ACC_PUBLIC) - HTTP_RESPONSE_ME(catchOutput, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(capture, ZEND_ACC_PUBLIC) - {NULL, NULL, NULL} + HTTP_RESPONSE_ALIAS(redirect, http_redirect) + HTTP_RESPONSE_ALIAS(status, http_send_status) + HTTP_RESPONSE_ALIAS(getRequestHeaders, http_get_request_headers) + HTTP_RESPONSE_ALIAS(getRequestBody, http_get_request_body) + + EMPTY_FUNCTION_ENTRY }; -static zend_object_handlers http_response_object_handlers; void _http_response_object_init(INIT_FUNC_ARGS) { - HTTP_REGISTER_CLASS_EX(HttpResponse, http_response_object, NULL, 0); + HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0); + http_response_object_declare_default_properties(); } -zend_object_value _http_response_object_new(zend_class_entry *ce TSRMLS_DC) +static inline void _http_response_object_declare_default_properties(TSRMLS_D) { - zend_object_value ov; - http_response_object *o; + zend_class_entry *ce = http_response_object_ce; - o = ecalloc(1, sizeof(http_response_object)); - o->zo.ce = ce; + DCL_STATIC_PROP(PRIVATE, bool, sent, 0); + DCL_STATIC_PROP(PRIVATE, bool, catch, 0); + DCL_STATIC_PROP(PRIVATE, long, mode, -1); + DCL_STATIC_PROP(PRIVATE, long, stream, 0); + DCL_STATIC_PROP_N(PRIVATE, file); + DCL_STATIC_PROP_N(PRIVATE, data); + DCL_STATIC_PROP(PROTECTED, bool, cache, 0); + DCL_STATIC_PROP(PROTECTED, bool, gzip, 0); + DCL_STATIC_PROP_N(PROTECTED, eTag); + DCL_STATIC_PROP(PROTECTED, long, lastModified, 0); + DCL_STATIC_PROP_N(PROTECTED, cacheControl); + DCL_STATIC_PROP_N(PROTECTED, contentType); + DCL_STATIC_PROP_N(PROTECTED, contentDisposition); + DCL_STATIC_PROP(PROTECTED, long, bufferSize, HTTP_SENDBUF_SIZE); + DCL_STATIC_PROP(PROTECTED, double, throttleDelay, 0.0); + +#ifndef WONKY + DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5); + DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1); + DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32); + +# ifdef HTTP_HAVE_MHASH + { + int l, i, c = mhash_count(); + + for (i = 0; i <= c; ++i) { + char const_name[256] = {0}; + const char *hash_name = mhash_get_hash_name_static(i); + + if (hash_name) { + l = snprintf(const_name, 255, "ETAG_MHASH_%s", hash_name); + zend_declare_class_constant_long(ce, const_name, l, i TSRMLS_CC); + } + } + } +# endif /* HTTP_HAVE_MHASH */ +#endif /* WONKY */ +} - ALLOC_HASHTABLE(OBJ_PROP(o)); - zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0); - zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); +static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC) +{ + phpstr_appendl(PHPSTR(arg), ((sapi_header_struct *)data)->header); + phpstr_appends(PHPSTR(arg), HTTP_CRLF); +} - ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_response_object_free, NULL TSRMLS_CC); - ov.handlers = &http_response_object_handlers; +/* ### USERLAND ### */ - return ov; +/* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true) + */ +PHP_METHOD(HttpResponse, setHeader) +{ + zend_bool replace = 1; + char *name; + int name_len = 0; + zval *value = NULL; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz/!|b", &name, &name_len, &value, &replace)) { + RETURN_FALSE; + } + if (SG(headers_sent)) { + http_error(HE_WARNING, HTTP_E_HEADER, "Cannot add another header when headers have already been sent"); + RETURN_FALSE; + } + if (!name_len) { + http_error(HE_WARNING, HTTP_E_HEADER, "Cannot send anonymous headers"); + RETURN_FALSE; + } + + /* delete header if value == null */ + if (!value || Z_TYPE_P(value) == IS_NULL) { + RETURN_SUCCESS(http_send_header_ex(name, name_len, "", 0, replace, NULL)); + } + /* send multiple header if replace is false and value is an array */ + if (!replace && Z_TYPE_P(value) == IS_ARRAY) { + zval **data; + + FOREACH_VAL(value, data) { + convert_to_string_ex(data); + if (SUCCESS != http_send_header_ex(name, name_len, Z_STRVAL_PP(data), Z_STRLEN_PP(data), 0, NULL)) { + RETURN_FALSE; + } + } + RETURN_TRUE; + } + /* send standard header */ + if (Z_TYPE_P(value) != IS_STRING) { + convert_to_string_ex(&value); + } + RETURN_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL)); } +/* }}} */ -static inline void _http_response_object_declare_default_properties(TSRMLS_D) +/* {{{ proto static mixed HttpResponse::getHeader([string name]) + */ +PHP_METHOD(HttpResponse, getHeader) { - zend_class_entry *ce = http_response_object_ce; + char *name = NULL; + int name_len = 0; + phpstr headers; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &name, &name_len)) { + RETURN_FALSE; + } + + phpstr_init(&headers); + zend_llist_apply_with_argument(&SG(sapi_headers).headers, http_grab_response_headers, &headers TSRMLS_CC); + phpstr_fix(&headers); + + if (name && name_len) { + zval **header; + HashTable headers_ht; + + zend_hash_init(&headers_ht, sizeof(zval *), NULL, ZVAL_PTR_DTOR, 0); + if ( (SUCCESS == http_parse_headers_ex(PHPSTR_VAL(&headers), &headers_ht, 1)) && + (SUCCESS == zend_hash_find(&headers_ht, name, name_len + 1, (void **) &header))) { + RETVAL_ZVAL(*header, 1, 0); + } else { + RETVAL_NULL(); + } + zend_hash_destroy(&headers_ht); + } else { + array_init(return_value); + http_parse_headers_ex(PHPSTR_VAL(&headers), Z_ARRVAL_P(return_value), 1); + } + + phpstr_dtor(&headers); +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setCache(bool cache) + * + * Whether it sould be attempted to cache the entitity. + * This will result in necessary caching headers and checks of clients + * "If-Modified-Since" and "If-None-Match" headers. If one of those headers + * matches a "304 Not Modified" status code will be issued. + * + * NOTE: If you're using sessions, be shure that you set session.cache_limiter + * to something more appropriate than "no-cache"! + */ +PHP_METHOD(HttpResponse, setCache) +{ + zend_bool do_cache = 0; - DCL_PROP(PROTECTED, string, contentType, "application/x-octetstream"); - DCL_PROP(PROTECTED, string, eTag, ""); - DCL_PROP(PROTECTED, string, dispoFile, ""); - DCL_PROP(PROTECTED, string, cacheControl, "public"); - DCL_PROP(PROTECTED, string, data, ""); - DCL_PROP(PROTECTED, string, file, ""); - DCL_PROP(PROTECTED, long, stream, 0); - DCL_PROP(PROTECTED, long, lastModified, 0); - DCL_PROP(PROTECTED, long, dispoInline, 0); - DCL_PROP(PROTECTED, long, cache, 0); - DCL_PROP(PROTECTED, long, gzip, 0); - DCL_PROP(PROTECTED, long, sendBuffersize, HTTP_SENDBUF_SIZE); - DCL_PROP(PROTECTED, double, throttleDelay, 0.0); + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) { + RETURN_FALSE; + } - DCL_PROP(PRIVATE, long, raw_cache_header, 0); - DCL_PROP(PRIVATE, long, send_mode, -1); - DCL_PROP(PRIVATE, long, sent, 0); - DCL_PROP(PRIVATE, long, catch_ob, 0); + RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache, do_cache)); } +/* }}} */ -void _http_response_object_free(zend_object *object TSRMLS_DC) +/* {{{ proto static bool HttpResponse::getCache() + * + * Get current caching setting. + */ +PHP_METHOD(HttpResponse, getCache) { - http_response_object *o = (http_response_object *) object; + NO_ARGS; - if (OBJ_PROP(o)) { - zend_hash_destroy(OBJ_PROP(o)); - FREE_HASHTABLE(OBJ_PROP(o)); + IF_RETVAL_USED { + zval *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache)); + + RETURN_ZVAL(cache, 1, 0); } - efree(o); } +/* }}}*/ -void _http_response_object_sendhandler(zval *this_ptr, http_response_object *obj, zend_bool clean_ob, zval *return_value TSRMLS_DC) +/* {{{ proto static bool HttpResponse::setGzip(bool gzip) + * + * Enable on-thy-fly gzipping of the sent entity. + */ +PHP_METHOD(HttpResponse, setGzip) { - zval *do_cache, *do_gzip; + zend_bool do_gzip = 0; - if (!obj) { - getObject(http_response_object, o); - obj = o; + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) { + RETURN_FALSE; } - do_cache = GET_PROP(obj, cache); - do_gzip = GET_PROP(obj, gzip); + RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip, do_gzip)); +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::getGzip() + * + * Get current gzipping setting. + */ +PHP_METHOD(HttpResponse, getGzip) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip)); + + RETURN_ZVAL(gzip, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0]) + * + * Set a custom cache-control header, usually being "private" or "public"; + * The max_age parameter controls how long the cache entry is valid on the client side. + */ +PHP_METHOD(HttpResponse, setCacheControl) +{ + char *ccontrol, *cctl; + int cc_len; + long max_age = 0; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &ccontrol, &cc_len, &max_age)) { + RETURN_FALSE; + } + + if (strcmp(ccontrol, "public") && strcmp(ccontrol, "private") && strcmp(ccontrol, "no-cache")) { + http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol); + RETURN_FALSE; + } else { + size_t cctl_len = spprintf(&cctl, 0, "%s, must-revalidate, max_age=%ld", ccontrol, max_age); + RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl, cctl, cctl_len)); + efree(cctl); + } +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getCacheControl() + * + * Get current Cache-Control header setting. + */ +PHP_METHOD(HttpResponse, getCacheControl) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl)); + + RETURN_ZVAL(ccontrol, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setContentType(string content_type) + * + * Set the content-type of the sent entity. + */ +PHP_METHOD(HttpResponse, setContentType) +{ + char *ctype; + int ctype_len; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) { + RETURN_FALSE; + } + + if (!strchr(ctype, '/')) { + http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype); + RETURN_FALSE; + } + + RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len)); +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getContentType() + * + * Get current Content-Type header setting. + */ +PHP_METHOD(HttpResponse, getContentType) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType)); + + RETURN_ZVAL(ctype, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static string HttpResponse::guessContentType(string magic_file[, long magic_mode]) + * + * Attempts to guess the content type of supplied payload through libmagic. + */ +PHP_METHOD(HttpResponse, guessContentType) +{ + char *magic_file, *ct = NULL; + int magic_file_len; + long magic_mode = 0; + + RETVAL_NULL(); + + SET_EH_THROW_HTTP(); + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &magic_file, &magic_file_len, &magic_mode)) { + switch (Z_LVAL_P(GET_STATIC_PROP(mode))) { + case SEND_DATA: + { + zval *data = GET_STATIC_PROP(data); + ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(data), Z_STRLEN_P(data), SEND_DATA); + } + break; + + case SEND_RSRC: + { + php_stream *s; + zval *z = GET_STATIC_PROP(stream); + z->type = IS_RESOURCE; + php_stream_from_zval(s, &z); + ct = http_guess_content_type(magic_file, magic_mode, s, 0, SEND_RSRC); + } + break; + + default: + ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(GET_STATIC_PROP(file)), 0, -1); + break; + } + if (ct) { + UPD_STATIC_PROP(string, contentType, ct); + RETVAL_STRING(ct, 0); + } + } + SET_EH_NORMAL(); +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false]) + * + * Set the Content-Disposition of the sent entity. This setting aims to suggest + * the receiveing user agent how to handle the sent entity; usually the client + * will show the user a "Save As..." popup. + */ +PHP_METHOD(HttpResponse, setContentDisposition) +{ + char *file, *cd; + int file_len; + size_t cd_len; + zend_bool send_inline = 0; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) { + RETURN_FALSE; + } + + cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file); + RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len)); + efree(cd); +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getContentDisposition() + * + * Get current Content-Disposition setting. + */ +PHP_METHOD(HttpResponse, getContentDisposition) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition)); + + RETURN_ZVAL(cd, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setETag(string etag) + * + * Set a custom ETag. Use this only if you know what you're doing. + */ +PHP_METHOD(HttpResponse, setETag) +{ + char *etag; + int etag_len; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) { + RETURN_FALSE; + } + + RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len)); +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getETag() + * + * Get calculated or previously set custom ETag. + */ +PHP_METHOD(HttpResponse, getETag) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)); + + RETURN_ZVAL(etag, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setLastModified(long timestamp) + * + * Set a custom Last-Modified date. + */ +PHP_METHOD(HttpResponse, setLastModified) +{ + long lm; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &lm)) { + RETURN_FALSE; + } + + RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified, lm)); +} +/* }}} */ + +/* {{{ proto static HttpResponse::getLastModified() + * + * Get calculated or previously set custom Last-Modified date. + */ +PHP_METHOD(HttpResponse, getLastModified) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified)); + + RETURN_ZVAL(lm, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds) + * + */ +PHP_METHOD(HttpResponse, setThrottleDelay) +{ + double seconds; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d", &seconds)) { + RETURN_FALSE; + } + RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay, seconds)); +} +/* }}} */ + +/* {{{ proto static double HttpResponse::getThrottleDelay() + * + */ +PHP_METHOD(HttpResponse, getThrottleDelay) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay)); + + RETURN_ZVAL(delay, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setBufferSize(long bytes) + * + */ +PHP_METHOD(HttpResponse, setBufferSize) +{ + long bytes; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &bytes)) { + RETURN_FALSE; + } + RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize, bytes)); +} +/* }}} */ + +/* {{{ proto static long HttpResponse::getBufferSize() + * + */ +PHP_METHOD(HttpResponse, getBufferSize) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize)); + + RETURN_ZVAL(size, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setData(string data) + * + * Set the data to be sent. + */ +PHP_METHOD(HttpResponse, setData) +{ + zval *the_data; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) { + RETURN_FALSE; + } + if (Z_TYPE_P(the_data) != IS_STRING) { + convert_to_string_ex(&the_data); + } + + if ( (SUCCESS != SET_STATIC_PROP(data, the_data)) || + (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_DATA))) { + RETURN_FALSE; + } + + if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) { + UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA)); + } + if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) { + char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA); + if (etag) { + UPD_STATIC_PROP(string, eTag, etag); + efree(etag); + } + } + + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getData() + * + * Get the previously set data to be sent. + */ +PHP_METHOD(HttpResponse, getData) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *the_data = GET_STATIC_PROP(data); + + RETURN_ZVAL(the_data, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setStream(resource stream) + * + * Set the resource to be sent. + */ +PHP_METHOD(HttpResponse, setStream) +{ + zval *the_stream; + php_stream *the_real_stream; + php_stream_statbuf ssb; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) { + RETURN_FALSE; + } + + php_stream_from_zval(the_real_stream, &the_stream); + if (php_stream_stat(the_real_stream, &ssb)) { + RETURN_FALSE; + } + + if ( (SUCCESS != UPD_STATIC_PROP(long, stream, Z_LVAL_P(the_stream))) || + (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_RSRC))) { + RETURN_FALSE; + } + zend_list_addref(Z_LVAL_P(the_stream)); + + if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) { + UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC)); + } + if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) { + char *etag = http_etag(the_real_stream, 0, SEND_RSRC); + if (etag) { + UPD_STATIC_PROP(string, eTag, etag); + efree(etag); + } + } + + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto static resource HttpResponse::getStream() + * + * Get the previously set resource to be sent. + */ +PHP_METHOD(HttpResponse, getStream) +{ + NO_ARGS; + + IF_RETVAL_USED { + RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream)))); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setFile(string file) + * + * Set the file to be sent. + */ +PHP_METHOD(HttpResponse, setFile) +{ + char *the_file; + int file_len; + php_stream_statbuf ssb; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &the_file, &file_len)) { + RETURN_FALSE; + } + + if (php_stream_stat_path(the_file, &ssb)) { + RETURN_FALSE; + } + + if ( (SUCCESS != UPD_STATIC_STRL(file, the_file, file_len)) || + (SUCCESS != UPD_STATIC_PROP(long, mode, -1))) { + RETURN_FALSE; + } + + if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) { + UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1)); + } + if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) { + char *etag = http_etag(the_file, 0, -1); + if (etag) { + UPD_STATIC_PROP(string, eTag, etag); + efree(etag); + } + } + + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getFile() + * + * Get the previously set file to be sent. + */ +PHP_METHOD(HttpResponse, getFile) +{ + NO_ARGS; + + IF_RETVAL_USED { + zval *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file)); + + RETURN_ZVAL(the_file, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::send([bool clean_ob = true]) + * + * Finally send the entity. + * + * Example: + * 
+ * 
+ *
+ */ +PHP_METHOD(HttpResponse, send) +{ + zval *sent; + zend_bool clean_ob = 1; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &clean_ob)) { + RETURN_FALSE; + } + if (SG(headers_sent)) { + http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, headers have already been sent"); + RETURN_FALSE; + } + + sent = GET_STATIC_PROP(sent); + if (zval_is_true(sent)) { + http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, response has already been sent"); + RETURN_FALSE; + } else { + Z_LVAL_P(sent) = 1; + } + + /* capture mode */ + if (zval_is_true(GET_STATIC_PROP(catch))) { + zval *the_data; + + MAKE_STD_ZVAL(the_data); + php_ob_get_buffer(the_data TSRMLS_CC); + SET_STATIC_PROP(data, the_data); + ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA); + + if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) { + char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA); + if (etag) { + UPD_STATIC_PROP(string, eTag, etag); + efree(etag); + } + } + zval_ptr_dtor(&the_data); + + clean_ob = 1; + } if (clean_ob) { /* interrupt on-the-fly etag generation */ @@ -235,92 +931,125 @@ void _http_response_object_sendhandler(zval *this_ptr, http_response_object *obj } /* gzip */ - if (Z_LVAL_P(do_gzip)) { - php_start_ob_buffer_named("ob_gzhandler", 0, 1 TSRMLS_CC); + if (zval_is_true(GET_STATIC_PROP(gzip))) { + php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC); + } else { + php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC); } /* caching */ - if (Z_LVAL_P(do_cache)) { - char *cc_hdr; - int cc_len; - zval *cctrl, *etag, *lmod, *ccraw; - - etag = GET_PROP(obj, eTag); - lmod = GET_PROP(obj, lastModified); - cctrl = GET_PROP(obj, cacheControl); - ccraw = GET_PROP(obj, raw_cache_header); - - if (Z_LVAL_P(ccraw)) { - cc_hdr = Z_STRVAL_P(cctrl); - cc_len = Z_STRLEN_P(cctrl); - } else { - char cc_header[42] = {0}; - sprintf(cc_header, "%s, must-revalidate, max-age=0", Z_STRVAL_P(cctrl)); - cc_hdr = cc_header; - cc_len = Z_STRLEN_P(cctrl) + lenof(", must-revalidate, max-age=0"); - } + if (zval_is_true(GET_STATIC_PROP(cache))) { + zval *cctl, *etag, *lmod; - http_cache_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag), cc_hdr, cc_len); - http_cache_last_modified(Z_LVAL_P(lmod), Z_LVAL_P(lmod) ? Z_LVAL_P(lmod) : time(NULL), cc_hdr, cc_len); + etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)); + lmod = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified)); + cctl = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl)); + + http_cache_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag), Z_STRVAL_P(cctl), Z_STRLEN_P(cctl)); + http_cache_last_modified(Z_LVAL_P(lmod), Z_LVAL_P(lmod) ? Z_LVAL_P(lmod) : time(NULL), Z_STRVAL_P(cctl), Z_STRLEN_P(cctl)); } /* content type */ { - zval *ctype = GET_PROP(obj, contentType); + zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType)); if (Z_STRLEN_P(ctype)) { http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype)); } else { - http_send_content_type("application/x-octetstream", lenof("application/x-octetstream")); + char *ctypes = INI_STR("default_mimetype"); + size_t ctlen = ctypes ? strlen(ctypes) : 0; + + if (ctlen) { + http_send_content_type(ctypes, ctlen); + } else { + http_send_content_type("application/x-octetstream", lenof("application/x-octetstream")); + } } } /* content disposition */ { - zval *dispo_file = GET_PROP(obj, dispoFile); - if (Z_STRLEN_P(dispo_file)) { - zval *dispo_inline = GET_PROP(obj, dispoInline); - http_send_content_disposition(Z_STRVAL_P(dispo_file), Z_STRLEN_P(dispo_file), (zend_bool) Z_LVAL_P(dispo_inline)); + zval *cd = GET_STATIC_PROP(contentDisposition); + if (Z_STRLEN_P(cd)) { + http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL); } } /* throttling */ { - zval *send_buffersize, *throttle_delay; - send_buffersize = GET_PROP(obj, sendBuffersize); - throttle_delay = GET_PROP(obj, throttleDelay); - HTTP_G(send).buffer_size = Z_LVAL_P(send_buffersize); - HTTP_G(send).throttle_delay = Z_DVAL_P(throttle_delay); + HTTP_G(send).buffer_size = Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize))); + HTTP_G(send).throttle_delay = Z_DVAL_P(convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay))); } /* send */ { - zval *send_mode = GET_PROP(obj, send_mode); - switch (Z_LVAL_P(send_mode)) + switch (Z_LVAL_P(GET_STATIC_PROP(mode))) { case SEND_DATA: { - zval *zdata = GET_PROP(obj, data); - RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata))); + zval *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data)); + RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1)); } case SEND_RSRC: { php_stream *the_real_stream; - zval *the_stream = GET_PROP(obj, stream); + zval *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream)); + the_stream->type = IS_RESOURCE; php_stream_from_zval(the_real_stream, &the_stream); - RETURN_SUCCESS(http_send_stream(the_real_stream)); + RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1)); } default: { - zval *zfile = GET_PROP(obj, file); - RETURN_SUCCESS(http_send_file(Z_STRVAL_P(zfile))); + RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1)); } } } } +/* }}} */ + +/* {{{ proto static void HttpResponse::capture() + * + * Capture script output. + * + * Example: + * 
+ * 
+ *
+ */ +PHP_METHOD(HttpResponse, capture) +{ + NO_ARGS; + + UPD_STATIC_PROP(long, catch, 1); + + php_end_ob_buffers(0 TSRMLS_CC); + php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC); + + /* register shutdown function */ + { + zval func, retval, arg, *argp[1]; + + INIT_PZVAL(&arg); + INIT_PZVAL(&func); + INIT_PZVAL(&retval); + ZVAL_STRINGL(&func, "register_shutdown_function", lenof("register_shutdown_function"), 0); + + array_init(&arg); + add_next_index_stringl(&arg, "HttpResponse", lenof("HttpResponse"), 1); + add_next_index_stringl(&arg, "send", lenof("send"), 1); + argp[0] = &arg; + call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC); + zval_dtor(&arg); + } +} +/* }}} */ -#endif /* ZEND_ENGINE_2 */ +#endif /* ZEND_ENGINE_2 && !WONKY */ /* * Local variables: