X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_response_object.c;h=a9f60c478aeeb5ec4bdb124abda922a9549a3b5e;hp=45dcb1db4ef79061a2a9497952f87bbee018da41;hb=121eac188fc0c1cabe3ea571a72867d3fd6b1b3f;hpb=5178ff512e676873a875cff22f65468d2d325fde diff --git a/http_response_object.c b/http_response_object.c index 45dcb1d..a9f60c4 100644 --- a/http_response_object.c +++ b/http_response_object.c @@ -1,95 +1,112 @@ /* - +----------------------------------------------------------------------+ - | 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-2006, Michael Wallner | + +--------------------------------------------------------------------+ */ /* $Id$ */ +#define HTTP_WANT_SAPI +#define HTTP_WANT_MAGIC +#include "php_http.h" -#ifdef HAVE_CONFIG_H -# include "config.h" -#endif -#include "php.h" +/* broken static properties in PHP 5.0 */ +#if defined(ZEND_ENGINE_2) && !defined(WONKY) -#ifdef ZEND_ENGINE_2 +#include "php_ini.h" -#include "php_http_std_defs.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 "missing.h" +#include "php_http_send_api.h" #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args) -#define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref) -#define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility) +#define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpResponse, method, 0) +#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, 1) + HTTP_ARG_VAL(name, 0) + HTTP_ARG_VAL(value, 0) + HTTP_ARG_VAL(replace, 0) +HTTP_END_ARGS; -HTTP_BEGIN_ARGS(__construct, 0) - HTTP_ARG_VAL(cache, 0) - HTTP_ARG_VAL(gzip, 0) +HTTP_BEGIN_ARGS(getHeader, 0) + HTTP_ARG_VAL(name, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getETag, 0); +HTTP_EMPTY_ARGS(getETag); HTTP_BEGIN_ARGS(setETag, 1) HTTP_ARG_VAL(etag, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getCache, 0); +HTTP_EMPTY_ARGS(getLastModified); +HTTP_BEGIN_ARGS(setLastModified, 1) + HTTP_ARG_VAL(timestamp, 0) +HTTP_END_ARGS; + +HTTP_EMPTY_ARGS(getCache); HTTP_BEGIN_ARGS(setCache, 1) HTTP_ARG_VAL(cache, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getGzip, 0); +HTTP_EMPTY_ARGS(getGzip); HTTP_BEGIN_ARGS(setGzip, 1) HTTP_ARG_VAL(gzip, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getCacheControl, 0); +HTTP_EMPTY_ARGS(getCacheControl); HTTP_BEGIN_ARGS(setCacheControl, 1) HTTP_ARG_VAL(cache_control, 0) - HTTP_ARG_VAL(raw, 0) + HTTP_ARG_VAL(max_age, 0) + HTTP_ARG_VAL(must_revalidate, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getContentType, 0); +HTTP_EMPTY_ARGS(getContentType); HTTP_BEGIN_ARGS(setContentType, 1) HTTP_ARG_VAL(content_type, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getContentDisposition, 0); +HTTP_BEGIN_ARGS(guessContentType, 1) + HTTP_ARG_VAL(magic_file, 0) + HTTP_ARG_VAL(magic_mode, 0) +HTTP_END_ARGS; + +HTTP_EMPTY_ARGS(getContentDisposition); 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_EMPTY_ARGS(getThrottleDelay); HTTP_BEGIN_ARGS(setThrottleDelay, 1) HTTP_ARG_VAL(seconds, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getSendBuffersize, 0); -HTTP_BEGIN_ARGS(setSendBuffersize, 1) +HTTP_EMPTY_ARGS(getBufferSize); +HTTP_BEGIN_ARGS(setBufferSize, 1) HTTP_ARG_VAL(bytes, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getData, 0); +HTTP_EMPTY_ARGS(getData); HTTP_BEGIN_ARGS(setData, 1) HTTP_ARG_VAL(data, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getStream, 0); +HTTP_EMPTY_ARGS(getStream); HTTP_BEGIN_ARGS(setStream, 1) HTTP_ARG_VAL(stream, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(getFile, 0); +HTTP_EMPTY_ARGS(getFile); HTTP_BEGIN_ARGS(setFile, 1) HTTP_ARG_VAL(filepath, 0) HTTP_END_ARGS; @@ -98,21 +115,43 @@ HTTP_BEGIN_ARGS(send, 0) HTTP_ARG_VAL(clean_ob, 0) HTTP_END_ARGS; -#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); +HTTP_EMPTY_ARGS(capture); + +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); +HTTP_EMPTY_ARGS(getRequestBody); +HTTP_EMPTY_ARGS(getRequestBodyStream); +#define OBJ_PROP_CE http_response_object_ce zend_class_entry *http_response_object_ce; zend_function_entry http_response_object_fe[] = { - HTTP_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR) + + HTTP_RESPONSE_ME(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) @@ -126,8 +165,8 @@ zend_function_entry http_response_object_fe[] = { HTTP_RESPONSE_ME(setThrottleDelay, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getThrottleDelay, ZEND_ACC_PUBLIC) - HTTP_RESPONSE_ME(setSendBuffersize, ZEND_ACC_PUBLIC) - HTTP_RESPONSE_ME(getSendBuffersize, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(setBufferSize, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(getBufferSize, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(setData, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(getData, ZEND_ACC_PUBLIC) @@ -139,68 +178,791 @@ zend_function_entry http_response_object_fe[] = { HTTP_RESPONSE_ME(getStream, ZEND_ACC_PUBLIC) HTTP_RESPONSE_ME(send, ZEND_ACC_PUBLIC) + HTTP_RESPONSE_ME(capture, ZEND_ACC_PUBLIC) - {NULL, NULL, NULL} + HTTP_RESPONSE_ALIAS(redirect, http_redirect) + HTTP_RESPONSE_ALIAS(status, http_send_status) + HTTP_RESPONSE_ALIAS(getRequestHeaders, http_get_request_headers) + HTTP_RESPONSE_ALIAS(getRequestBody, http_get_request_body) + HTTP_RESPONSE_ALIAS(getRequestBodyStream, http_get_request_body_stream) + + EMPTY_FUNCTION_ENTRY }; -static zend_object_handlers http_response_object_handlers; -void _http_response_object_init(INIT_FUNC_ARGS) +PHP_MINIT_FUNCTION(http_response_object) +{ + HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0); + + 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, 0); + 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_FOUND", HTTP_REDIRECT_FOUND); + DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST); + DCL_CONST(long, "REDIRECT_PROXY", HTTP_REDIRECT_PROXY); + DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP); +#endif /* WONKY */ + + return SUCCESS; +} + +/* ### USERLAND ### */ + +/* {{{ proto static bool HttpResponse::setHeader(string name[, mixed value[, bool replace = true]]) + Send an HTTP header. */ +PHP_METHOD(HttpResponse, setHeader) +{ + zend_bool replace = 1; + char *name; + int name_len = 0; + zval *value = NULL; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|z/!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; + } + http_send_header_zval_ex(name, name_len, &value, replace); + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto static mixed HttpResponse::getHeader([string name]) + Get header(s) about to be sent. */ +PHP_METHOD(HttpResponse, getHeader) +{ + char *name = NULL; + int name_len = 0; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &name, &name_len)) { + RETURN_FALSE; + } + + if (name && name_len) { + zval **header; + HashTable headers_ht; + + zend_hash_init(&headers_ht, sizeof(zval *), NULL, ZVAL_PTR_DTOR, 0); + if ( (SUCCESS == http_get_response_headers(&headers_ht)) && + (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_get_response_headers(Z_ARRVAL_P(return_value)); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setCache(bool cache) + Whether it should be attempted to cache the entity. */ +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. */ +PHP_METHOD(HttpResponse, getCache) +{ + NO_ARGS; + + if (return_value_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. */ +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. */ +PHP_METHOD(HttpResponse, getGzip) +{ + NO_ARGS; + + if (return_value_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[, bool must_revalidate = true]]) + Set a custom cache-control header, usually being "private" or "public"; The max_age parameter controls how long the cache entry is valid on the client side. */ +PHP_METHOD(HttpResponse, setCacheControl) +{ + char *ccontrol, *cctl; + int cc_len; + long max_age = 0; + zend_bool must_revalidate = 1; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|lb", &ccontrol, &cc_len, &max_age, &must_revalidate)) { + 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,%s max-age=%ld", ccontrol, must_revalidate?" must-revalidate,":"", max_age); + RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl, cctl, cctl_len)); + efree(cctl); + } +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getCacheControl() + Get current Cache-Control header setting. */ +PHP_METHOD(HttpResponse, getCacheControl) +{ + NO_ARGS; + + if (return_value_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. */ +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. */ +PHP_METHOD(HttpResponse, getContentType) +{ + NO_ARGS; + + if (return_value_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. */ +PHP_METHOD(HttpResponse, guessContentType) +{ +#ifdef HTTP_HAVE_MAGIC + char *magic_file, *ct = NULL; + int magic_file_len; + long magic_mode = MAGIC_MIME; + + RETVAL_FALSE; + 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"); + RETURN_FALSE; +#endif +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false]) + Set the Content-Disposition. */ +PHP_METHOD(HttpResponse, setContentDisposition) +{ + char *file, *cd; + int file_len; + size_t cd_len; + zend_bool send_inline = 0; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) { + RETURN_FALSE; + } + + cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file); + RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len)); + efree(cd); +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getContentDisposition() + Get current Content-Disposition setting. */ +PHP_METHOD(HttpResponse, getContentDisposition) +{ + NO_ARGS; + + if (return_value_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. */ +PHP_METHOD(HttpResponse, setETag) +{ + char *etag; + int etag_len; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) { + RETURN_FALSE; + } + + RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len)); +} +/* }}} */ + +/* {{{ proto static string HttpResponse::getETag() + Get calculated or previously set custom ETag. */ +PHP_METHOD(HttpResponse, getETag) +{ + NO_ARGS; + + if (return_value_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. */ +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. */ +PHP_METHOD(HttpResponse, getLastModified) +{ + NO_ARGS; + + if (return_value_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(). */ +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. */ +PHP_METHOD(HttpResponse, getThrottleDelay) +{ + NO_ARGS; + + if (return_value_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(). */ +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. */ +PHP_METHOD(HttpResponse, getBufferSize) +{ + NO_ARGS; + + if (return_value_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. */ +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. */ +PHP_METHOD(HttpResponse, getData) { - HTTP_REGISTER_CLASS_EX(HttpResponse, http_response_object, NULL, 0); + NO_ARGS; + + if (return_value_used) { + zval *the_data = GET_STATIC_PROP(data); + + RETURN_ZVAL(the_data, 1, 0); + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setStream(resource stream) + Set the resource to be sent. */ +PHP_METHOD(HttpResponse, setStream) +{ + 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; } +/* }}} */ -zend_object_value _http_response_object_new(zend_class_entry *ce TSRMLS_DC) +/* {{{ proto static resource HttpResponse::getStream() + Get the previously set resource to be sent. */ +PHP_METHOD(HttpResponse, getStream) { - zend_object_value ov; - http_response_object *o; + NO_ARGS; - o = ecalloc(1, sizeof(http_response_object)); - o->zo.ce = ce; + if (return_value_used) { + zval *stream_p; + + RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream), &stream_p))); - ALLOC_HASHTABLE(OBJ_PROP(o)); - zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0); - zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); + if (stream_p) { + zval_ptr_dtor(&stream_p); + } + } +} +/* }}} */ + +/* {{{ proto static bool HttpResponse::setFile(string file) + Set the file to be sent. */ +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; + } - ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_response_object_free, NULL TSRMLS_CC); - ov.handlers = &http_response_object_handlers; + 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 ov; + RETURN_TRUE; } +/* }}} */ -static inline void _http_response_object_declare_default_properties(TSRMLS_D) +/* {{{ proto static string HttpResponse::getFile() + Get the previously set file to be sent. */ +PHP_METHOD(HttpResponse, getFile) { - zend_class_entry *ce = http_response_object_ce; + NO_ARGS; - DCL_PROP(PROTECTED, string, contentType, "application/x-octetstream"); - DCL_PROP(PROTECTED, string, eTag, ""); - DCL_PROP(PROTECTED, string, dispoFile, ""); - DCL_PROP(PROTECTED, string, cacheControl, "public"); - DCL_PROP(PROTECTED, string, data, ""); - DCL_PROP(PROTECTED, string, file, ""); - DCL_PROP(PROTECTED, long, stream, 0); - DCL_PROP(PROTECTED, long, lastModified, 0); - DCL_PROP(PROTECTED, long, dispoInline, 0); - DCL_PROP(PROTECTED, long, cache, 0); - DCL_PROP(PROTECTED, long, gzip, 0); - DCL_PROP(PROTECTED, long, sendBuffersize, HTTP_SENDBUF_SIZE); - DCL_PROP(PROTECTED, double, throttleDelay, 0.0); + if (return_value_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); - DCL_PROP(PRIVATE, long, raw_cache_header, 0); - DCL_PROP(PRIVATE, long, send_mode, -1); + if (the_file_p) { + zval_ptr_dtor(&the_file_p); + } + } } +/* }}} */ -void _http_response_object_free(zend_object *object TSRMLS_DC) +/* {{{ proto static bool HttpResponse::send([bool clean_ob = true]) + Finally send the entity. */ +PHP_METHOD(HttpResponse, send) { - http_response_object *o = (http_response_object *) object; + 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); + + if (Z_LVAL_P(lmod) || Z_STRLEN_P(etag)) { + if (Z_STRLEN_P(cctl)) { + http_send_cache_control(Z_STRVAL_P(cctl), Z_STRLEN_P(cctl)); + } else { + http_send_cache_control(HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)); + } + if (Z_STRLEN_P(etag)) { + http_send_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag)); + } + if (Z_LVAL_P(lmod)) { + http_send_last_modified(Z_LVAL_P(lmod)); + } + } + + if (etag_p) zval_ptr_dtor(&etag_p); + if (lmod_p) zval_ptr_dtor(&lmod_p); + if (cctl_p) zval_ptr_dtor(&cctl_p); + } + + /* 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.response = zval_is_true(GET_STATIC_PROP(gzip)); + + /* 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(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata))); + 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(the_real_stream)); + if (the_stream_p) zval_ptr_dtor(&the_stream_p); + return; + } + + default: + { + zval *file_p; + RETVAL_SUCCESS(http_send_file(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &file_p)))); + if (file_p) zval_ptr_dtor(&file_p); + return; + } + } +} +/* }}} */ - if (OBJ_PROP(o)) { - zend_hash_destroy(OBJ_PROP(o)); - FREE_HASHTABLE(OBJ_PROP(o)); +/* {{{ proto static void HttpResponse::capture() + Capture script output. + */ +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, 0, 0 TSRMLS_CC); + + /* register shutdown function */ + { + zval func, retval, arg, *argp[1]; + + INIT_PZVAL(&arg); + INIT_PZVAL(&func); + INIT_PZVAL(&retval); + ZVAL_STRINGL(&func, "register_shutdown_function", lenof("register_shutdown_function"), 0); + + array_init(&arg); + add_next_index_stringl(&arg, "HttpResponse", lenof("HttpResponse"), 1); + add_next_index_stringl(&arg, "send", lenof("send"), 1); + argp[0] = &arg; + call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC); + zval_dtor(&arg); } - efree(o); } +/* }}} */ -#endif /* ZEND_ENGINE_2 */ +#endif /* ZEND_ENGINE_2 && !WONKY */ /* * Local variables: