X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_response_object.c;h=a0b8817cc218563e95fc758e23af0a826da952eb;hp=5e588eae0ef4010ebb953adfb0864f3dfef379e5;hb=8d25696948ed61d50c417275222117f43069ddd1;hpb=061fbbe598d6e28b35c408b35beec1a6508abac9 diff --git a/http_response_object.c b/http_response_object.c index 5e588ea..a0b8817 100644 --- a/http_response_object.c +++ b/http_response_object.c @@ -1,16 +1,13 @@ /* - +----------------------------------------------------------------------+ - | PECL :: http | - +----------------------------------------------------------------------+ - | This source file is subject to version 3.0 of the PHP license, that | - | is bundled with this package in the file LICENSE, and is available | - | through the world-wide-web at http://www.php.net/license/3_0.txt. | - | If you did not receive a copy of the PHP license and are unable to | - | obtain it through the world-wide-web, please send a note to | - | license@php.net so we can mail you a copy immediately. | - +----------------------------------------------------------------------+ - | Copyright (c) 2004-2005 Michael Wallner | - +----------------------------------------------------------------------+ + +--------------------------------------------------------------------+ + | PECL :: http | + +--------------------------------------------------------------------+ + | Redistribution and use in source and binary forms, with or without | + | modification, are permitted provided that the conditions mentioned | + | in the accompanying LICENSE file are met. | + +--------------------------------------------------------------------+ + | Copyright (c) 2004-2005, Michael Wallner | + +--------------------------------------------------------------------+ */ /* $Id$ */ @@ -21,7 +18,10 @@ #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" @@ -33,14 +33,21 @@ #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 +#ifdef HTTP_HAVE_MAGIC +# 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) @@ -88,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) @@ -141,8 +153,8 @@ 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); - -HashTable http_response_statics; +#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[] = { @@ -161,6 +173,8 @@ zend_function_entry http_response_object_fe[] = { 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) @@ -194,13 +208,14 @@ zend_function_entry http_response_object_fe[] = { HTTP_RESPONSE_ALIAS(getRequestHeaders, http_get_request_headers) HTTP_RESPONSE_ALIAS(getRequestBody, http_get_request_body) - {NULL, NULL, NULL} + EMPTY_FUNCTION_ENTRY }; -void _http_response_object_init(INIT_FUNC_ARGS) +PHP_MINIT_FUNCTION(http_response_object) { HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0); http_response_object_declare_default_properties(); + return SUCCESS; } static inline void _http_response_object_declare_default_properties(TSRMLS_D) @@ -210,11 +225,11 @@ static inline void _http_response_object_declare_default_properties(TSRMLS_D) 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(PROTECTED, long, stream, 0); - DCL_STATIC_PROP_N(PROTECTED, file); - DCL_STATIC_PROP_N(PROTECTED, data); DCL_STATIC_PROP_N(PROTECTED, eTag); DCL_STATIC_PROP(PROTECTED, long, lastModified, 0); DCL_STATIC_PROP_N(PROTECTED, cacheControl); @@ -222,78 +237,154 @@ static inline void _http_response_object_declare_default_properties(TSRMLS_D) DCL_STATIC_PROP_N(PROTECTED, contentDisposition); DCL_STATIC_PROP(PROTECTED, long, bufferSize, HTTP_SENDBUF_SIZE); DCL_STATIC_PROP(PROTECTED, double, throttleDelay, 0.0); - DCL_STATIC_PROP_N(PROTECTED, headers); + +#ifndef WONKY + DCL_CONST(long, "REDIRECT", HTTP_REDIRECT); + DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM); + DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST); + DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP); + + 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 */ +} + +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); } /* ### USERLAND ### */ -/* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true) +/* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true]) + * + * Send an HTTP header. + * + * Expects a string parameter containing the name of the header and a mixed + * parameter containing the value of the header, which will be converted to + * a string. Additionally accepts an optional boolean parameter, which + * specifies whether an existing header should be replaced. If the second + * parameter is unset no header with this name will be sent. + * + * Returns TRUE on success, or FALSE on failure. + * + * Throws HttpHeaderException if http.only_exceptions is TRUE. */ PHP_METHOD(HttpResponse, setHeader) { zend_bool replace = 1; char *name; int name_len = 0; - zval *value = NULL, *headers, **header; + zval *value = NULL, *orig = 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; } - headers = GET_STATIC_PROP(headers); - - if (Z_TYPE_P(headers) != IS_ARRAY) { - convert_to_array(headers); - } - /* delete header if value == null */ if (!value || Z_TYPE_P(value) == IS_NULL) { - RETURN_SUCCESS(zend_hash_del(Z_ARRVAL_P(headers), name, name_len + 1)); + RETURN_SUCCESS(http_send_header_ex(name, name_len, "", 0, replace, NULL)); } - - if (Z_TYPE_P(value) != IS_STRING) { - convert_to_string_ex(&value); + /* send multiple header if replace is false and value is an array */ + if (!replace && Z_TYPE_P(value) == IS_ARRAY) { + zval **data; + HashPosition pos; + + FOREACH_VAL(pos, value, data) { + zval *orig = *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)) { + if (orig != *data) { + zval_ptr_dtor(data); + } + RETURN_FALSE; + } + if (orig != *data) { + zval_ptr_dtor(data); + } + } + RETURN_TRUE; } - - /* convert old header to an array and add new one if header exists and replace == false */ - if (replace || (SUCCESS != zend_hash_find(Z_ARRVAL_P(headers), name, name_len + 1, (void **) &header))) { - RETURN_SUCCESS(add_assoc_stringl_ex(headers, name, name_len + 1, Z_STRVAL_P(value), Z_STRLEN_P(value), 1)); - } else { - convert_to_array(*header); - RETURN_SUCCESS(add_next_index_stringl(*header, Z_STRVAL_P(value), Z_STRLEN_P(value), 1)); + /* send standard header */ + orig = value; + convert_to_string_ex(&value); + RETVAL_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL)); + if (orig != value) { + zval_ptr_dtor(&value); } } /* }}} */ /* {{{ proto static mixed HttpResponse::getHeader([string name]) + * + * Get header(s) about to be sent. + * + * Accepts a string as optional parameter which specifies the name of the + * header to read. If the parameter is empty or omitted, an associative array + * with all headers will be returned. + * + * Returns either a string containing the value of the header matching name, + * FALSE on failure, or an associative array with all headers. */ PHP_METHOD(HttpResponse, getHeader) { char *name = NULL; int name_len = 0; - zval *headers, **header; + phpstr headers; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &name, &name_len)) { RETURN_FALSE; } - headers = GET_STATIC_PROP(headers); - if (Z_TYPE_P(headers) != IS_ARRAY) { - convert_to_array(headers); - } + 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) { - array_init(return_value); - array_copy(headers, return_value); - } else if (SUCCESS == zend_hash_find(Z_ARRVAL_P(headers), name, name_len + 1, (void **) &header)) { - RETURN_ZVAL(*header, ZVAL_PTR_DTOR, 1); + 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 { - RETURN_NULL(); + array_init(return_value); + http_parse_headers_ex(PHPSTR_VAL(&headers), Z_ARRVAL_P(return_value), 1); } + + phpstr_dtor(&headers); } /* }}} */ @@ -306,6 +397,10 @@ PHP_METHOD(HttpResponse, getHeader) * * NOTE: If you're using sessions, be shure that you set session.cache_limiter * to something more appropriate than "no-cache"! + * + * Expects a boolean as parameter specifying whether caching should be attempted. + * + * Returns TRUE ons success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setCache) { @@ -322,20 +417,32 @@ PHP_METHOD(HttpResponse, setCache) /* {{{ proto static bool HttpResponse::getCache() * * Get current caching setting. + * + * Returns TRUE if caching should be attempted, else FALSE. */ PHP_METHOD(HttpResponse, getCache) { NO_ARGS; IF_RETVAL_USED { - RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(cache))); + zval *cache_p, *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache), &cache_p); + + RETVAL_ZVAL(cache, 1, 0); + + if (cache_p) { + zval_ptr_dtor(&cache_p); + } } } /* }}}*/ /* {{{ proto static bool HttpResponse::setGzip(bool gzip) * - * Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET. + * Enable on-thy-fly gzipping of the sent entity. + * + * Expects a boolean as parameter indicating if GZip compression should be enabled. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setGzip) { @@ -352,21 +459,37 @@ PHP_METHOD(HttpResponse, setGzip) /* {{{ proto static bool HttpResponse::getGzip() * * Get current gzipping setting. + * + * Returns TRUE if GZip compression is enabled, else FALSE. */ PHP_METHOD(HttpResponse, getGzip) { NO_ARGS; IF_RETVAL_USED { - RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(gzip))); + zval *gzip_p, *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip), &gzip_p); + + RETVAL_ZVAL(gzip, 1, 0); + + if (gzip_p) { + zval_ptr_dtor(&gzip_p); + } } } /* }}} */ -/* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0]) +/* {{{ proto static bool HttpResponse::setCacheControl(string control[, int 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. + * + * Expects a string parameter containing the primary cache control setting. + * Addtitionally accepts an int parameter specifying the max-age setting. + * + * Returns TRUE on success, or FALSE if control does not match one of + * "public" , "private" or "no-cache". + * + * Throws HttpInvalidParamException if http.only_exceptions is TRUE. */ PHP_METHOD(HttpResponse, setCacheControl) { @@ -382,8 +505,8 @@ PHP_METHOD(HttpResponse, setCacheControl) http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol); RETURN_FALSE; } else { - spprintf(&cctl, 0, "%s, must-revalidate, max_age=%ld", ccontrol, max_age); - RETVAL_SUCCESS(UPD_STATIC_PROP(string, cacheControl, cctl)); + 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); } } @@ -392,14 +515,21 @@ PHP_METHOD(HttpResponse, setCacheControl) /* {{{ proto static string HttpResponse::getCacheControl() * * Get current Cache-Control header setting. + * + * Returns the current cache control setting as a string like sent in a header. */ PHP_METHOD(HttpResponse, getCacheControl) { NO_ARGS; IF_RETVAL_USED { - zval *ccontrol = GET_STATIC_PROP(cacheControl); - RETURN_STRINGL(Z_STRVAL_P(ccontrol), Z_STRLEN_P(ccontrol), 1); + zval *ccontrol_p, *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl), &ccontrol_p); + + RETVAL_ZVAL(ccontrol, 1, 0); + + if (ccontrol_p) { + zval_ptr_dtor(&ccontrol_p); + } } } /* }}} */ @@ -407,6 +537,13 @@ PHP_METHOD(HttpResponse, getCacheControl) /* {{{ proto static bool HttpResponse::setContentType(string content_type) * * Set the content-type of the sent entity. + * + * Expects a string as parameter specifying the content type of the sent entity. + * + * Returns TRUE on success, or FALSE if the content type does not seem to + * contain a primary and secondary content type part. + * + * Throws HttpInvalidParamException if http.only_exceptions is TRUE. */ PHP_METHOD(HttpResponse, setContentType) { @@ -417,48 +554,120 @@ PHP_METHOD(HttpResponse, setContentType) 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_PROP(string, contentType, ctype)); + HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE); + RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len)); } /* }}} */ /* {{{ proto static string HttpResponse::getContentType() * * Get current Content-Type header setting. + * + * Returns the currently set content type as string. */ PHP_METHOD(HttpResponse, getContentType) { NO_ARGS; IF_RETVAL_USED { - zval *ctype = GET_STATIC_PROP(contentType); - RETURN_STRINGL(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1); + zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p); + + RETVAL_ZVAL(ctype, 1, 0); + + if (ctype_p) { + zval_ptr_dtor(&ctype_p); + } + } +} +/* }}} */ + +/* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME]) + * + * Attempts to guess the content type of supplied payload through libmagic. + * If the attempt is successful, the guessed content type will automatically + * be set as response content type. + * + * Expects a string parameter specifying the magic.mime database to use. + * Additionally accepts an optional int parameter, being flags for libmagic. + * + * Returns the guessed content type on success, or FALSE on failure. + * + * Throws HttpRuntimeException, HttpInvalidParamException + * if http.only_exceptions is TRUE. + */ +PHP_METHOD(HttpResponse, guessContentType) +{ + char *magic_file, *ct = NULL; + int magic_file_len; + long magic_mode = 0; + + RETVAL_FALSE; + +#ifdef HTTP_HAVE_MAGIC + magic_mode = MAGIC_MIME; + + 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(); +#else + http_error(HE_THROW, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available"); +#endif } /* }}} */ /* {{{ 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. + * Set the Content-Disposition. The Content-Disposition header is very useful + * if the data actually sent came from a file or something similar, that should + * be "saved" by the client/user (i.e. by browsers "Save as..." popup window). + * + * Expects a string parameter specifying the file name the "Save as..." dialogue + * should display. Optionally accepts a bool parameter, which, if set to true + * and the user agent knows how to handle the content type, will probably not + * cause the popup window to be shown. + * + * Returns TRUE on success or FALSE on failure. */ 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; } - spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file); - RETVAL_SUCCESS(UPD_STATIC_PROP(string, contentDisposition, cd)); + cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file); + RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len)); efree(cd); } /* }}} */ @@ -466,14 +675,21 @@ PHP_METHOD(HttpResponse, setContentDisposition) /* {{{ proto static string HttpResponse::getContentDisposition() * * Get current Content-Disposition setting. + * + * Returns the current content disposition as string like sent in a header. */ PHP_METHOD(HttpResponse, getContentDisposition) { NO_ARGS; IF_RETVAL_USED { - zval *cd = GET_STATIC_PROP(contentDisposition); - RETURN_STRINGL(Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1); + zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p); + + RETVAL_ZVAL(cd, 1, 0); + + if (cd_p) { + zval_ptr_dtor(&cd_p); + } } } /* }}} */ @@ -481,6 +697,10 @@ PHP_METHOD(HttpResponse, getContentDisposition) /* {{{ proto static bool HttpResponse::setETag(string etag) * * Set a custom ETag. Use this only if you know what you're doing. + * + * Expects an unquoted string as parameter containing the ETag. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setETag) { @@ -491,28 +711,40 @@ PHP_METHOD(HttpResponse, setETag) RETURN_FALSE; } - RETURN_SUCCESS(UPD_STATIC_PROP(string, eTag, etag)); + RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len)); } /* }}} */ /* {{{ proto static string HttpResponse::getETag() * * Get calculated or previously set custom ETag. + * + * Returns the calculated or previously set ETag as unquoted string. */ PHP_METHOD(HttpResponse, getETag) { NO_ARGS; IF_RETVAL_USED { - zval *etag = GET_STATIC_PROP(eTag); - RETURN_STRINGL(Z_STRVAL_P(etag), Z_STRLEN_P(etag), 1); + zval *etag_p, *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p); + + RETVAL_ZVAL(etag, 1, 0); + + if (etag_p) { + zval_ptr_dtor(&etag_p); + } } } /* }}} */ -/* {{{ proto static bool HttpResponse::setLastModified(long timestamp) +/* {{{ proto static bool HttpResponse::setLastModified(int timestamp) * * Set a custom Last-Modified date. + * + * Expects an unix timestamp as parameter representing the last modification + * time of the sent entity. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setLastModified) { @@ -526,22 +758,41 @@ PHP_METHOD(HttpResponse, setLastModified) } /* }}} */ -/* {{{ proto static HttpResponse::getLastModified() +/* {{{ proto static int HttpResponse::getLastModified() * * Get calculated or previously set custom Last-Modified date. + * + * Returns the calculated or previously set unix timestamp. */ PHP_METHOD(HttpResponse, getLastModified) { NO_ARGS; IF_RETVAL_USED { - RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(lastModified))); + zval *lm_p, *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified), &lm_p); + + RETVAL_ZVAL(lm, 1, 0); + + if (lm_p) { + zval_ptr_dtor(&lm_p); + } } } /* }}} */ /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds) * + * Sets the throttle delay for use with HttpResponse::setBufferSize(). + * + * Provides a basic throttling mechanism, which will yield the current process + * resp. thread until the entity has been completely sent, though. + * + * Note: This doesn't really work with the FastCGI SAPI. + * + * Expects a double parameter specifying the seconds too sleep() after + * each chunk sent. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setThrottleDelay) { @@ -556,19 +807,38 @@ PHP_METHOD(HttpResponse, setThrottleDelay) /* {{{ proto static double HttpResponse::getThrottleDelay() * + * Get the current throttle delay. + * + * Returns a double representing the throttle delay in seconds. */ PHP_METHOD(HttpResponse, getThrottleDelay) { NO_ARGS; IF_RETVAL_USED { - RETURN_DOUBLE(Z_DVAL_P(GET_STATIC_PROP(throttleDelay))); + zval *delay_p, *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay), &delay_p); + + RETVAL_ZVAL(delay, 1, 0); + + if (delay_p) { + zval_ptr_dtor(&delay_p); + } } } /* }}} */ -/* {{{ proto static bool HttpResponse::setBufferSize(long bytes) +/* {{{ proto static bool HttpResponse::setBufferSize(int bytes) * + * Sets the send buffer size for use with HttpResponse::setThrottleDelay(). + * + * Provides a basic throttling mechanism, which will yield the current process + * resp. thread until the entity has been completely sent, though. + * + * Note: This doesn't really work with the FastCGI SAPI. + * + * Expects an int parameter representing the chunk size in bytes. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setBufferSize) { @@ -581,25 +851,40 @@ PHP_METHOD(HttpResponse, setBufferSize) } /* }}} */ -/* {{{ proto static long HttpResponse::getBufferSize() +/* {{{ proto static int HttpResponse::getBufferSize() * + * Get current buffer size. + * + * Returns an int representing the current buffer size in bytes. */ PHP_METHOD(HttpResponse, getBufferSize) { NO_ARGS; IF_RETVAL_USED { - RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(bufferSize))); + zval *size_p, *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize), &size_p); + + RETVAL_ZVAL(size, 1, 0); + + if (size_p) { + zval_ptr_dtor(&size_p); + } } } /* }}} */ -/* {{{ proto static bool HttpResponse::setData(string data) +/* {{{ proto static bool HttpResponse::setData(mixed data) * * Set the data to be sent. + * + * Expects one parameter, which will be converted to a string and contains + * the data to send. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setData) { + char *etag; zval *the_data; if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) { @@ -614,11 +899,8 @@ PHP_METHOD(HttpResponse, setData) RETURN_FALSE; } - if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified)) > 0)) { - UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA)); - } - if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) { - char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA); + UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA)); + if (etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA)) { UPD_STATIC_PROP(string, eTag, etag); efree(etag); } @@ -630,6 +912,8 @@ PHP_METHOD(HttpResponse, setData) /* {{{ proto static string HttpResponse::getData() * * Get the previously set data to be sent. + * + * Returns a string containing the previously set data to send. */ PHP_METHOD(HttpResponse, getData) { @@ -637,7 +921,8 @@ PHP_METHOD(HttpResponse, getData) IF_RETVAL_USED { zval *the_data = GET_STATIC_PROP(data); - RETURN_STRINGL(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), 1); + + RETURN_ZVAL(the_data, 1, 0); } } /* }}} */ @@ -645,28 +930,36 @@ PHP_METHOD(HttpResponse, getData) /* {{{ proto static bool HttpResponse::setStream(resource stream) * * Set the resource to be sent. + * + * Expects a resource parameter referencing an already opened stream from + * which the data to send will be read. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setStream) { + char *etag; 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; } - zend_list_addref(Z_LVAL_P(the_stream)); + 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; } - - if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified)) > 0)) { - UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC)); - } - if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) { - char *etag = http_etag(the_real_stream, 0, SEND_RSRC); + zend_list_addref(Z_LVAL_P(the_stream)); + + UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC)); + if (etag = http_etag(the_real_stream, 0, SEND_RSRC)) { UPD_STATIC_PROP(string, eTag, etag); efree(etag); } @@ -678,13 +971,21 @@ PHP_METHOD(HttpResponse, setStream) /* {{{ proto static resource HttpResponse::getStream() * * Get the previously set resource to be sent. + * + * Returns the previously set resource. */ PHP_METHOD(HttpResponse, getStream) { NO_ARGS; IF_RETVAL_USED { - RETURN_RESOURCE(Z_LVAL_P(GET_STATIC_PROP(stream))); + zval *stream_p; + + RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream), &stream_p))); + + if (stream_p) { + zval_ptr_dtor(&stream_p); + } } } /* }}} */ @@ -692,26 +993,32 @@ PHP_METHOD(HttpResponse, getStream) /* {{{ proto static bool HttpResponse::setFile(string file) * * Set the file to be sent. + * + * Expects a string as parameter, specifying the path to the file to send. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpResponse, setFile) { - char *the_file; + char *the_file, *etag; 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 ( (SUCCESS != UPD_STATIC_PROP(string, file, the_file)) || + 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(GET_STATIC_PROP(lastModified)))) { - UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1)); - } - if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) { - char *etag = http_etag(the_file, 0, -1); + UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1)); + if (etag = http_etag(the_file, 0, -1)) { UPD_STATIC_PROP(string, eTag, etag); efree(etag); } @@ -723,14 +1030,21 @@ PHP_METHOD(HttpResponse, setFile) /* {{{ proto static string HttpResponse::getFile() * * Get the previously set file to be sent. + * + * Returns the previously set path to the file to send as string. */ PHP_METHOD(HttpResponse, getFile) { NO_ARGS; IF_RETVAL_USED { - zval *the_file = GET_STATIC_PROP(file); - RETURN_STRINGL(Z_STRVAL_P(the_file), Z_STRLEN_P(the_file), 1); + zval *the_file_p, *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &the_file_p); + + RETVAL_ZVAL(the_file, 1, 0); + + if (the_file_p) { + zval_ptr_dtor(&the_file_p); + } } } /* }}} */ @@ -738,6 +1052,15 @@ PHP_METHOD(HttpResponse, getFile) /* {{{ proto static bool HttpResponse::send([bool clean_ob = true]) * * Finally send the entity. + * + * Accepts an optional boolean parameter, specifying wheter the ouput + * buffers should be discarded prior sending. A successful caching attempt + * will cause a script termination, and write a log entry if the INI setting + * http.cache_log is set. + * + * Returns TRUE on success, or FALSE on failure. + * + * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE. * * Example: *
@@ -752,16 +1075,14 @@ PHP_METHOD(HttpResponse, getFile)
  */
 PHP_METHOD(HttpResponse, send)
 {
-	zval *sent, *headers;
+	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;
-	}
+	
+	HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
 
 	sent = GET_STATIC_PROP(sent);
 	if (Z_LVAL_P(sent)) {
@@ -772,20 +1093,26 @@ PHP_METHOD(HttpResponse, send)
 	}
 
 	/* capture mode */
-	if (Z_BVAL_P(GET_STATIC_PROP(catch))) {
-		zval the_data;
+	if (zval_is_true(GET_STATIC_PROP(catch))) {
+		zval *etag_p, *the_data;
 
-		INIT_PZVAL(&the_data);
-		php_ob_get_buffer(&the_data TSRMLS_CC);
-		SET_STATIC_PROP(data, &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(GET_STATIC_PROP(eTag))) {
-			char *etag = http_etag(Z_STRVAL(the_data), Z_STRLEN(the_data), SEND_DATA);
-			UPD_STATIC_PROP(string, eTag, etag);
-			efree(etag);
+		if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p))) {
+			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);
+		
+		if (etag_p) {
+			zval_ptr_dtor(&etag_p);
 		}
-		zval_dtor(&the_data);
 
 		clean_ob = 1;
 	}
@@ -797,53 +1124,29 @@ PHP_METHOD(HttpResponse, send)
 		php_end_ob_buffers(0 TSRMLS_CC);
 	}
 
-	/* custom headers */
-	headers = GET_STATIC_PROP(headers);
-	if (Z_TYPE_P(headers) == IS_ARRAY) {
-		char *name = NULL;
-		ulong idx = 0;
-		zval **value;
-
-		FOREACH_KEYVAL(headers, name, idx, value) {
-			if (name) {
-				if (Z_TYPE_PP(value) == IS_ARRAY) {
-					zend_bool first = 1;
-					zval **data;
-
-					FOREACH_VAL(*value, data) {
-						http_send_header_ex(name, strlen(name), Z_STRVAL_PP(data), Z_STRLEN_PP(data), first, NULL);
-						first = 0;
-					}
-				} else {
-					http_send_header_ex(name, strlen(name), Z_STRVAL_PP(value), Z_STRLEN_PP(value), 1, NULL);
-				}
-				name = NULL;
-			}
-		}
-	}
-
-	/* gzip */
-	if (Z_LVAL_P(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(GET_STATIC_PROP(cache))) {
-		zval *cctl, *etag, *lmod;
+	if (zval_is_true(GET_STATIC_PROP(cache))) {
+		zval *cctl, *cctl_p, *etag, *etag_p, *lmod, *lmod_p;
 
-		etag = GET_STATIC_PROP(eTag);
-		lmod = GET_STATIC_PROP(lastModified);
-		cctl = GET_STATIC_PROP(cacheControl);
+		etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p);
+		lmod = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified), &lmod_p);
+		cctl = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl), &cctl_p);
 
 		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));
+
+		if (etag_p) zval_ptr_dtor(&etag_p);
+		if (lmod_p) zval_ptr_dtor(&lmod_p);
+		if (cctl_p) zval_ptr_dtor(&cctl_p);
+	
+		if (php_ob_handler_used("blackhole" TSRMLS_CC)) {
+			RETURN_TRUE;
+		}
 	}
 
 	/* content type */
 	{
-		zval *ctype = GET_STATIC_PROP(contentType);
+		zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p);
 		if (Z_STRLEN_P(ctype)) {
 			http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype));
 		} else {
@@ -856,45 +1159,66 @@ PHP_METHOD(HttpResponse, send)
 				http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
 			}
 		}
+		if (ctype_p) {
+			zval_ptr_dtor(&ctype_p);
+		}
 	}
 
 	/* content disposition */
 	{
-		zval *cd = GET_STATIC_PROP(contentDisposition);
+		zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p);
 		if (Z_STRLEN_P(cd)) {
 			http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL);
 		}
+		if (cd_p) {
+			zval_ptr_dtor(&cd_p);
+		}
 	}
 
 	/* throttling */
 	{
-		HTTP_G(send).buffer_size    = Z_LVAL_P(GET_STATIC_PROP(bufferSize));
-		HTTP_G(send).throttle_delay = Z_DVAL_P(GET_STATIC_PROP(throttleDelay));
+		zval *bsize_p, *bsize = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize), &bsize_p);
+		zval *delay_p, *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay), &delay_p);
+		HTTP_G(send).buffer_size    = Z_LVAL_P(bsize);
+		HTTP_G(send).throttle_delay = Z_DVAL_P(delay);
+		if (bsize_p) zval_ptr_dtor(&bsize_p);
+		if (delay_p) zval_ptr_dtor(&delay_p);
 	}
 
+	/* gzip */
+	HTTP_G(send).gzip_encoding = zval_is_true(GET_STATIC_PROP(gzip));
+	
+	/* start ob */
+	php_start_ob_buffer(NULL, HTTP_G(send).buffer_size, 0 TSRMLS_CC);
+
 	/* send */
+	switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
 	{
-		switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
+		case SEND_DATA:
 		{
-			case SEND_DATA:
-			{
-				zval *zdata = GET_STATIC_PROP(data);
-				RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
-			}
+			zval *zdata_p, *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data), &zdata_p);
+			RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
+			if (zdata_p) zval_ptr_dtor(&zdata_p);
+			return;
+		}
 
-			case SEND_RSRC:
-			{
-				php_stream *the_real_stream;
-				zval *the_stream = 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));
-			}
+		case SEND_RSRC:
+		{
+			php_stream *the_real_stream;
+			zval *the_stream_p, *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream), &the_stream_p);
+			the_stream->type = IS_RESOURCE;
+			php_stream_from_zval(the_real_stream, &the_stream);
+			RETVAL_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
+			if (the_stream_p) zval_ptr_dtor(&the_stream_p);
+			return;
+		}
 
-			default:
-			{
-				RETURN_SUCCESS(http_send_file(Z_STRVAL_P(GET_STATIC_PROP(file))));
-			}
+		default:
+		{
+			zval *file_p;
+			RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &file_p)), 1));
+			if (file_p) zval_ptr_dtor(&file_p);
+			return;
 		}
 	}
 }
@@ -910,30 +1234,21 @@ PHP_METHOD(HttpResponse, send)
  * HttpResponse::setCache(true);
  * HttpResponse::capture();
  * // script follows
- * // note that you need to call
- * HttpResponse::send();
- * // at the end of the script unless 
- * // you use PHP-5.1 or greater
  * ?>
  * 
*/ PHP_METHOD(HttpResponse, capture) { - zval do_catch; - NO_ARGS; + + HTTP_CHECK_HEADERS_SENT(RETURN_FALSE); - INIT_PZVAL(&do_catch); - ZVAL_LONG(&do_catch, 1); - - SET_STATIC_PROP(catch, &do_catch); + UPD_STATIC_PROP(long, catch, 1); php_end_ob_buffers(0 TSRMLS_CC); - php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC); + php_start_ob_buffer(NULL, 40960, 0 TSRMLS_CC); -#if (PHP_MAJOR_VERSION > 5) || (PHP_MINOR_VERSION > 0) - /* register shutdown function -- - messing around with ob and headers only works in PHP-5.1 or greater */ + /* register shutdown function */ { zval func, retval, arg, *argp[1]; @@ -949,11 +1264,10 @@ PHP_METHOD(HttpResponse, capture) call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC); zval_dtor(&arg); } -#endif } /* }}} */ -#endif /* ZEND_ENGINE_2 */ +#endif /* ZEND_ENGINE_2 && !WONKY */ /* * Local variables: