- happy new year

[m6w6/ext-http] / http_response_object.c

/*
    +--------------------------------------------------------------------+
    | 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-2006, Michael Wallner <mike@php.net>            |
    +--------------------------------------------------------------------+
*/

/* $Id$ */


#ifdef HAVE_CONFIG_H
#       include "config.h"
#endif

#define HTTP_WANT_MAGIC
#include "php_http.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_api.h"
#include "php_http_cache_api.h"
#include "php_http_exception_object.h"
#include "php_http_headers_api.h"
#include "php_http_response_object.h"
#include "php_http_send_api.h"

#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|ZEND_ACC_STATIC)
#define HTTP_RESPONSE_ALIAS(method, func)               HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))

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);
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)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getGzip, 0);
HTTP_BEGIN_ARGS(setGzip, 1)
        HTTP_ARG_VAL(gzip, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getCacheControl, 0);
HTTP_BEGIN_ARGS(setCacheControl, 1)
        HTTP_ARG_VAL(cache_control, 0)
        HTTP_ARG_VAL(max_age, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getContentType, 0);
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)
        HTTP_ARG_VAL(send_inline, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getThrottleDelay, 0);
HTTP_BEGIN_ARGS(setThrottleDelay, 1)
        HTTP_ARG_VAL(seconds, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getBufferSize, 0);
HTTP_BEGIN_ARGS(setBufferSize, 1)
        HTTP_ARG_VAL(bytes, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getData, 0);
HTTP_BEGIN_ARGS(setData, 1)
        HTTP_ARG_VAL(data, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getStream, 0);
HTTP_BEGIN_ARGS(setStream, 1)
        HTTP_ARG_VAL(stream, 0)
HTTP_END_ARGS;

HTTP_EMPTY_ARGS(getFile, 0);
HTTP_BEGIN_ARGS(setFile, 1)
        HTTP_ARG_VAL(filepath, 0)
HTTP_END_ARGS;

HTTP_BEGIN_ARGS(send, 0)
        HTTP_ARG_VAL(clean_ob, 0)
HTTP_END_ARGS;

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(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)

        HTTP_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
        HTTP_RESPONSE_ME(getCacheControl, ZEND_ACC_PUBLIC)

        HTTP_RESPONSE_ME(setGzip, ZEND_ACC_PUBLIC)
        HTTP_RESPONSE_ME(getGzip, ZEND_ACC_PUBLIC)

        HTTP_RESPONSE_ME(setThrottleDelay, ZEND_ACC_PUBLIC)
        HTTP_RESPONSE_ME(getThrottleDelay, 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)

        HTTP_RESPONSE_ME(setFile, ZEND_ACC_PUBLIC)
        HTTP_RESPONSE_ME(getFile, ZEND_ACC_PUBLIC)

        HTTP_RESPONSE_ME(setStream, ZEND_ACC_PUBLIC)
        HTTP_RESPONSE_ME(getStream, ZEND_ACC_PUBLIC)

        HTTP_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
        HTTP_RESPONSE_ME(capture, ZEND_ACC_PUBLIC)

        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
};

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)
{
        zend_class_entry *ce = http_response_object_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, "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);
#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])
 *
 * 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, *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;
        }

        /* 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;
                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;
        }
        /* 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;
        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"!
 * 
 * Expects a boolean as parameter specifying whether caching should be attempted.
 * 
 * Returns TRUE ons success, or FALSE on failure.
 */
PHP_METHOD(HttpResponse, setCache)
{
        zend_bool do_cache = 0;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) {
                RETURN_FALSE;
        }

        RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache, do_cache));
}
/* }}} */

/* {{{ 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 {
                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.
 * 
 * Expects a boolean as parameter indicating if GZip compression should be enabled.
 * 
 * Returns TRUE on success, or FALSE on failure.
 */
PHP_METHOD(HttpResponse, setGzip)
{
        zend_bool do_gzip = 0;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) {
                RETURN_FALSE;
        }

        RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip, do_gzip));
}
/* }}} */

/* {{{ 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 {
                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[, 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)
{
        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.
 * 
 * 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_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);
                }
        }
}
/* }}} */

/* {{{ 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)
{
        char *ctype;
        int ctype_len;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) {
                RETURN_FALSE;
        }

        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_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.  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;
        }

        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.
 * 
 * Returns the current content disposition as string like sent in a header.
 */
PHP_METHOD(HttpResponse, getContentDisposition)
{
        NO_ARGS;

        IF_RETVAL_USED {
                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);
                }
        }
}
/* }}} */

/* {{{ 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)
{
        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.
 * 
 * Returns the calculated or previously set ETag as unquoted string.
 */
PHP_METHOD(HttpResponse, getETag)
{
        NO_ARGS;

        IF_RETVAL_USED {
                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(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)
{
        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 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 {
                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)
{
        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()
 *
 * Get the current throttle delay.
 * 
 * Returns a double representing the throttle delay in seconds.
 */
PHP_METHOD(HttpResponse, getThrottleDelay)
{
        NO_ARGS;

        IF_RETVAL_USED {
                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(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)
{
        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 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 {
                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(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)) {
                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;
        }
        
        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);
        }

        RETURN_TRUE;
}
/* }}} */

/* {{{ 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)
{
        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.
 * 
 * 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;
        }
        
        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));
        
        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);
        }

        RETURN_TRUE;
}
/* }}} */

/* {{{ 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 {
                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);
                }
        }
}
/* }}} */

/* {{{ 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, *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 (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;
        }

        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);
        }

        RETURN_TRUE;
}
/* }}} */

/* {{{ 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_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);
                }
        }
}
/* }}} */

/* {{{ 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:
 * <pre>
 * <?php
 * HttpResponse::setCache(true);
 * HttpResponse::setContentType('application/pdf');
 * HttpResponse::setContentDisposition("$user.pdf", false);
 * HttpResponse::setFile('sheet.pdf');
 * HttpResponse::send();
 * ?>
 * </pre>
 */
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;
        }
        
        HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);

        sent = GET_STATIC_PROP(sent);
        if (Z_LVAL_P(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 *etag_p, *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), &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);
                }

                clean_ob = 1;
        }

        if (clean_ob) {
                /* interrupt on-the-fly etag generation */
                HTTP_G(etag).started = 0;
                /* discard previous output buffers */
                php_end_ob_buffers(0 TSRMLS_CC);
        }

        /* caching */
        if (zval_is_true(GET_STATIC_PROP(cache))) {
                zval *cctl, *cctl_p, *etag, *etag_p, *lmod, *lmod_p;

                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_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 {
                        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"));
                        }
                }
                if (ctype_p) {
                        zval_ptr_dtor(&ctype_p);
                }
        }

        /* content disposition */
        {
                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 */
        {
                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).deflate.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)))
        {
                case SEND_DATA:
                {
                        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_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:
                {
                        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;
                }
        }
}
/* }}} */

/* {{{ proto static void HttpResponse::capture()
 *
 * Capture script output.
 *
 * Example:
 * <pre>
 * <?php
 * HttpResponse::setCache(true);
 * HttpResponse::capture();
 * // script follows
 * ?>
 * </pre>
 */
PHP_METHOD(HttpResponse, capture)
{
        NO_ARGS;
        
        HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);

        UPD_STATIC_PROP(long, catch, 1);

        php_end_ob_buffers(0 TSRMLS_CC);
        php_start_ob_buffer(NULL, 40960, 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 && !WONKY */

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */