X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_response_object.c;h=72289b65f291fc71025eb04262abb32fdd03695c;hp=68de2a43fde6a82cc9800fe3804e013a23761e25;hb=39feb7a7e30bb4b393a6f76aa2f35d4e9275523e;hpb=b562e34cf4f8c8fae7b8fe773e0eed71592b09c2 diff --git a/http_response_object.c b/http_response_object.c index 68de2a4..72289b6 100644 --- a/http_response_object.c +++ b/http_response_object.c @@ -36,6 +36,14 @@ #include "php_http_exception_object.h" #include "php_http_send_api.h" #include "php_http_cache_api.h" +#include "php_http_headers_api.h" + +#ifdef HTTP_HAVE_MHASH +# include +#endif +#ifdef HTTP_HAVE_MAGIC +# include +#endif ZEND_EXTERN_MODULE_GLOBALS(http); @@ -148,6 +156,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); +#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[] = { @@ -217,11 +227,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); @@ -229,78 +239,143 @@ 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; 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)); } - + /* 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); } - - /* 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)); - } + RETURN_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL)); } /* }}} */ /* {{{ 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, 1, 0); + 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); } /* }}} */ @@ -313,6 +388,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) { @@ -329,13 +408,17 @@ 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 = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache)); + + RETURN_ZVAL(cache, 1, 0); } } /* }}}*/ @@ -343,6 +426,10 @@ PHP_METHOD(HttpResponse, getCache) /* {{{ proto static bool HttpResponse::setGzip(bool gzip) * * 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) { @@ -359,21 +446,33 @@ 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 = 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]) +/* {{{ 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) { @@ -399,14 +498,17 @@ 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 = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl)); + + RETURN_ZVAL(ccontrol, 1, 0); } } /* }}} */ @@ -414,6 +516,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) { @@ -424,11 +533,7 @@ 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; - } - + HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE); RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len)); } /* }}} */ @@ -436,22 +541,34 @@ PHP_METHOD(HttpResponse, setContentType) /* {{{ 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 = 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]) +/* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME]) * * Attempts to guess the content type of supplied payload through libmagic. - * See docs/KnownIssues.txt! + * 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) { @@ -459,7 +576,10 @@ PHP_METHOD(HttpResponse, guessContentType) int magic_file_len; long magic_mode = 0; - RETVAL_NULL(); + 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)) { @@ -491,14 +611,24 @@ PHP_METHOD(HttpResponse, guessContentType) } } 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) { @@ -520,14 +650,17 @@ 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 = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition)); + + RETURN_ZVAL(cd, 1, 0); } } /* }}} */ @@ -535,6 +668,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) { @@ -552,21 +689,29 @@ PHP_METHOD(HttpResponse, setETag) /* {{{ 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 = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)); + + RETURN_ZVAL(etag, 1, 0); } } /* }}} */ -/* {{{ 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) { @@ -580,22 +725,37 @@ 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 = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified)); + + RETURN_ZVAL(lm, 1, 0); } } /* }}} */ /* {{{ 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) { @@ -610,19 +770,34 @@ 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 = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay)); + + RETURN_ZVAL(delay, 1, 0); } } /* }}} */ -/* {{{ 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) { @@ -635,25 +810,36 @@ 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 = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize)); + + RETURN_ZVAL(size, 1, 0); } } /* }}} */ -/* {{{ 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)) { @@ -668,11 +854,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); } @@ -684,6 +867,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) { @@ -691,7 +876,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); } } /* }}} */ @@ -699,9 +885,15 @@ 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; @@ -721,11 +913,8 @@ PHP_METHOD(HttpResponse, setStream) } zend_list_addref(Z_LVAL_P(the_stream)); - 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); + 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); } @@ -737,13 +926,15 @@ 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))); + RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream)))); } } /* }}} */ @@ -751,10 +942,14 @@ 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; @@ -771,11 +966,8 @@ PHP_METHOD(HttpResponse, setFile) 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); } @@ -787,14 +979,17 @@ 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 = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file)); + + RETURN_ZVAL(the_file, 1, 0); } } /* }}} */ @@ -802,6 +997,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: *
@@ -816,7 +1020,7 @@ 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)) {
@@ -828,7 +1032,7 @@ PHP_METHOD(HttpResponse, send)
 	}
 
 	sent = GET_STATIC_PROP(sent);
-	if (Z_LVAL_P(sent)) {
+	if (zval_is_true(sent)) {
 		http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, response has already been sent");
 		RETURN_FALSE;
 	} else {
@@ -836,7 +1040,7 @@ PHP_METHOD(HttpResponse, send)
 	}
 
 	/* capture mode */
-	if (Z_BVAL_P(GET_STATIC_PROP(catch))) {
+	if (zval_is_true(GET_STATIC_PROP(catch))) {
 		zval *the_data;
 
 		MAKE_STD_ZVAL(the_data);
@@ -844,10 +1048,12 @@ PHP_METHOD(HttpResponse, send)
 		SET_STATIC_PROP(data, the_data);
 		ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
 
-		if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
+		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);
-			UPD_STATIC_PROP(string, eTag, etag);
-			efree(etag);
+			if (etag) {
+				UPD_STATIC_PROP(string, eTag, etag);
+				efree(etag);
+			}
 		}
 		zval_ptr_dtor(&the_data);
 
@@ -861,45 +1067,13 @@ 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))) {
+	if (zval_is_true(GET_STATIC_PROP(cache))) {
 		zval *cctl, *etag, *lmod;
 
-		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));
+		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));
@@ -907,7 +1081,7 @@ PHP_METHOD(HttpResponse, send)
 
 	/* content type */
 	{
-		zval *ctype = GET_STATIC_PROP(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 {
@@ -932,33 +1106,38 @@ PHP_METHOD(HttpResponse, send)
 
 	/* 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));
+		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)));
+	}
+
+	/* gzip */
+	if (zval_is_true(GET_STATIC_PROP(gzip))) {
+		php_start_ob_buffer_named("ob_gzhandler", HTTP_G(send).buffer_size, 0 TSRMLS_CC);
+	} else {
+		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_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
-			}
+			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_STATIC_PROP(stream);
-				the_stream->type = IS_RESOURCE;
-				php_stream_from_zval(the_real_stream, &the_stream);
-				RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
-			}
+		case SEND_RSRC:
+		{
+			php_stream *the_real_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_ex(the_real_stream, 0, 1));
+		}
 
-			default:
-			{
-				RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(GET_STATIC_PROP(file)), 1));
-			}
+		default:
+		{
+			RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1));
 		}
 	}
 }
@@ -979,21 +1158,14 @@ PHP_METHOD(HttpResponse, send)
  */
 PHP_METHOD(HttpResponse, capture)
 {
-	zval do_catch;
-
 	NO_ARGS;
 
-	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);
 
-#ifndef WONKY
-	/* 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];
 
@@ -1009,7 +1181,6 @@ PHP_METHOD(HttpResponse, capture)
 		call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC);
 		zval_dtor(&arg);
 	}
-#endif
 }
 /* }}} */