/*
- +----------------------------------------------------------------------+
- | 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 <mike@php.net> |
- +----------------------------------------------------------------------+
+ +--------------------------------------------------------------------+
+ | 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
-#include "php.h"
-
-#include "missing.h"
+#define HTTP_WANT_SAPI
+#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.h"
#include "php_http_api.h"
-#include "php_http_std_defs.h"
-#include "php_http_response_object.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"
-#include "php_http_cache_api.h"
-
-ZEND_EXTERN_MODULE_GLOBALS(http);
-
-#define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
-#define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
-#define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
#define 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_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, 2)
+HTTP_BEGIN_ARGS(setHeader, 1)
HTTP_ARG_VAL(name, 0)
HTTP_ARG_VAL(value, 0)
HTTP_ARG_VAL(replace, 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(getLastModified, 0);
+HTTP_EMPTY_ARGS(getLastModified);
HTTP_BEGIN_ARGS(setLastModified, 1)
HTTP_ARG_VAL(timestamp, 0)
HTTP_END_ARGS;
-HTTP_EMPTY_ARGS(getCache, 0);
+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(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_ARG_VAL(magic_mode, 0)
HTTP_END_ARGS;
-HTTP_EMPTY_ARGS(getContentDisposition, 0);
+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(getBufferSize, 0);
+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;
HTTP_ARG_VAL(clean_ob, 0)
HTTP_END_ARGS;
-HTTP_EMPTY_ARGS(capture, 0);
+HTTP_EMPTY_ARGS(capture);
HTTP_BEGIN_ARGS(redirect, 0)
HTTP_ARG_VAL(url, 0)
HTTP_ARG_VAL(code, 0)
HTTP_END_ARGS;
-HTTP_EMPTY_ARGS(getRequestHeaders, 0);
-HTTP_EMPTY_ARGS(getRequestBody, 0);
+HTTP_EMPTY_ARGS(getRequestHeaders);
+HTTP_EMPTY_ARGS(getRequestBody);
+HTTP_EMPTY_ARGS(getRequestBodyStream);
-#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);
+#define OBJ_PROP_CE http_response_object_ce
zend_class_entry *http_response_object_ce;
zend_function_entry http_response_object_fe[] = {
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)
- {NULL, NULL, NULL}
+ EMPTY_FUNCTION_ENTRY
};
-void _http_response_object_init(INIT_FUNC_ARGS)
+PHP_MINIT_FUNCTION(http_response_object)
{
HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0);
- http_response_object_declare_default_properties();
-}
-
-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(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);
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, long, bufferSize, 0);
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_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;
+}
+
+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. */
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)) {
+ 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;
}
-
- 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));
- }
-
- 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));
- }
+ 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;
- 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);
}
/* }}} */
/* {{{ 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"!
- */
+ Whether it should be attempted to cache the entity. */
PHP_METHOD(HttpResponse, setCache)
{
zend_bool do_cache = 0;
/* }}} */
/* {{{ proto static bool HttpResponse::getCache()
- *
- * Get current caching setting.
- */
+ Get current caching setting. */
PHP_METHOD(HttpResponse, getCache)
{
NO_ARGS;
- IF_RETVAL_USED {
- RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(cache)));
+ 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.
- */
+ Enable on-thy-fly gzipping of the sent entity. */
PHP_METHOD(HttpResponse, setGzip)
{
zend_bool do_gzip = 0;
/* }}} */
/* {{{ proto static bool HttpResponse::getGzip()
- *
- * Get current gzipping setting.
- */
+ Get current gzipping setting. */
PHP_METHOD(HttpResponse, getGzip)
{
NO_ARGS;
- IF_RETVAL_USED {
- RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(gzip)));
+ 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[, long max_age = 0])
- *
- * Set a custom cache-control header, usually being "private" or "public";
- * The max_age parameter controls how long the cache entry is valid on the client side.
- */
+/* {{{ 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|l", &ccontrol, &cc_len, &max_age)) {
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|lb", &ccontrol, &cc_len, &max_age, &must_revalidate)) {
RETURN_FALSE;
}
http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
RETURN_FALSE;
} else {
- spprintf(&cctl, 0, "%s, must-revalidate, max_age=%ld", ccontrol, max_age);
- RETVAL_SUCCESS(UPD_STATIC_PROP(string, cacheControl, cctl));
+ size_t cctl_len = spprintf(&cctl, 0, "%s,%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.
- */
+ Get current Cache-Control header setting. */
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);
+ 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.
- */
+ Set the content-type of the sent entity. */
PHP_METHOD(HttpResponse, setContentType)
{
char *ctype;
RETURN_FALSE;
}
- if (!strchr(ctype, '/')) {
- http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype);
- RETURN_FALSE;
- }
-
- RETURN_SUCCESS(UPD_STATIC_PROP(string, contentType, ctype));
+ HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE);
+ RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len));
}
/* }}} */
/* {{{ proto static string HttpResponse::getContentType()
- *
- * Get current Content-Type header setting.
- */
+ Get current Content-Type header setting. */
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);
+ 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[, long magic_mode])
- *
- * Attempts to guess the content type of supplied payload through libmagic.
- * See docs/KnownIssues.txt!
- */
+/* {{{ 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 = 0;
-
- RETVAL_NULL();
+ 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))) {
{
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;
}
- break;
case SEND_RSRC:
{
z->type = IS_RESOURCE;
php_stream_from_zval(s, &z);
ct = http_guess_content_type(magic_file, magic_mode, s, 0, SEND_RSRC);
+ break;
}
- break;
default:
ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(GET_STATIC_PROP(file)), 0, -1);
- break;
+ break;
}
if (ct) {
UPD_STATIC_PROP(string, contentType, ct);
}
}
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 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. */
PHP_METHOD(HttpResponse, setContentDisposition)
{
char *file, *cd;
int file_len;
+ size_t cd_len;
zend_bool send_inline = 0;
if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) {
RETURN_FALSE;
}
- spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file);
- RETVAL_SUCCESS(UPD_STATIC_PROP(string, contentDisposition, cd));
+ cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file);
+ RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len));
efree(cd);
}
/* }}} */
/* {{{ proto static string HttpResponse::getContentDisposition()
- *
- * Get current Content-Disposition setting.
- */
+ Get current Content-Disposition setting. */
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);
+ 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.
- */
+ Set a custom ETag. Use this only if you know what you're doing. */
PHP_METHOD(HttpResponse, setETag)
{
char *etag;
RETURN_FALSE;
}
- RETURN_SUCCESS(UPD_STATIC_PROP(string, eTag, etag));
+ RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len));
}
/* }}} */
/* {{{ proto static string HttpResponse::getETag()
- *
- * Get calculated or previously set custom ETag.
- */
+ Get calculated or previously set custom ETag. */
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);
+ 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(long timestamp)
- *
- * Set a custom Last-Modified date.
- */
+/* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
+ Set a custom Last-Modified date. */
PHP_METHOD(HttpResponse, setLastModified)
{
long lm;
}
/* }}} */
-/* {{{ proto static HttpResponse::getLastModified()
- *
- * Get calculated or previously set custom Last-Modified date.
- */
+/* {{{ proto static int HttpResponse::getLastModified()
+ Get calculated or previously set custom Last-Modified date. */
PHP_METHOD(HttpResponse, getLastModified)
{
NO_ARGS;
- IF_RETVAL_USED {
- RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(lastModified)));
+ 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;
/* }}} */
/* {{{ proto static double HttpResponse::getThrottleDelay()
- *
- */
+ Get the current throttle delay. */
PHP_METHOD(HttpResponse, getThrottleDelay)
{
NO_ARGS;
- IF_RETVAL_USED {
- RETURN_DOUBLE(Z_DVAL_P(GET_STATIC_PROP(throttleDelay)));
+ 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(long bytes)
- *
- */
+/* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
+ Sets the send buffer size for use with HttpResponse::setThrottleDelay(). */
PHP_METHOD(HttpResponse, setBufferSize)
{
long bytes;
}
/* }}} */
-/* {{{ proto static long HttpResponse::getBufferSize()
- *
- */
+/* {{{ proto static int HttpResponse::getBufferSize()
+ Get current buffer size. */
PHP_METHOD(HttpResponse, getBufferSize)
{
NO_ARGS;
- IF_RETVAL_USED {
- RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(bufferSize)));
+ 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(string data)
- *
- * Set the data to be sent.
- */
+/* {{{ 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)) {
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &the_data)) {
RETURN_FALSE;
}
if (Z_TYPE_P(the_data) != IS_STRING) {
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);
}
/* }}} */
/* {{{ proto static string HttpResponse::getData()
- *
- * Get the previously set data to be sent.
- */
+ Get the previously set data to be sent. */
PHP_METHOD(HttpResponse, getData)
{
NO_ARGS;
- IF_RETVAL_USED {
+ if (return_value_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);
}
}
/* }}} */
/* {{{ proto static bool HttpResponse::setStream(resource stream)
- *
- * Set the resource to be sent.
- */
+ Set the resource to be sent. */
PHP_METHOD(HttpResponse, setStream)
{
+ char *etag;
zval *the_stream;
php_stream *the_real_stream;
php_stream_statbuf ssb;
}
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);
}
/* }}} */
/* {{{ proto static resource HttpResponse::getStream()
- *
- * Get the previously set resource to be sent.
- */
+ Get the previously set resource to be sent. */
PHP_METHOD(HttpResponse, getStream)
{
NO_ARGS;
- IF_RETVAL_USED {
- RETURN_RESOURCE(Z_LVAL_P(GET_STATIC_PROP(stream)));
+ if (return_value_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.
- */
+ Set the file to be sent. */
PHP_METHOD(HttpResponse, setFile)
{
- char *the_file;
+ char *the_file, *etag;
int file_len;
php_stream_statbuf ssb;
RETURN_FALSE;
}
- if ( (SUCCESS != UPD_STATIC_PROP(string, file, the_file)) ||
+ if ( (SUCCESS != UPD_STATIC_STRL(file, the_file, file_len)) ||
(SUCCESS != UPD_STATIC_PROP(long, mode, -1))) {
RETURN_FALSE;
}
- if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified)))) {
- UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
- }
- if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
- char *etag = http_etag(the_file, 0, -1);
+ UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
+ if ((etag = http_etag(the_file, 0, -1))) {
UPD_STATIC_PROP(string, eTag, etag);
efree(etag);
}
/* }}} */
/* {{{ proto static string HttpResponse::getFile()
- *
- * Get the previously set file to be sent.
- */
+ Get the previously set file to be sent. */
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);
+ 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);
+
+ if (the_file_p) {
+ zval_ptr_dtor(&the_file_p);
+ }
}
}
/* }}} */
/* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
- *
- * Finally send the entity.
- *
- * Example:
- * <pre>
- * <?php
- * HttpResponse::setCache(true);
- * HttpResponse::setContentType('application/pdf');
- * HttpResponse::setContentDisposition("$user.pdf", false);
- * HttpResponse::setFile('sheet.pdf');
- * HttpResponse::send();
- * ?>
- * </pre>
- */
+ Finally send the entity. */
PHP_METHOD(HttpResponse, send)
{
- zval *sent, *headers;
+ zval *sent;
zend_bool clean_ob = 1;
if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &clean_ob)) {
RETURN_FALSE;
}
- if (SG(headers_sent)) {
- http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, headers have already been sent");
- RETURN_FALSE;
- }
+
+ HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
sent = GET_STATIC_PROP(sent);
if (Z_LVAL_P(sent)) {
}
/* capture mode */
- if (Z_BVAL_P(GET_STATIC_PROP(catch))) {
- zval *the_data;
+ if (zval_is_true(GET_STATIC_PROP(catch))) {
+ zval *etag_p, *the_data;
MAKE_STD_ZVAL(the_data);
php_ob_get_buffer(the_data TSRMLS_CC);
SET_STATIC_PROP(data, the_data);
ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
- if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
+ 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);
- UPD_STATIC_PROP(string, eTag, etag);
- efree(etag);
+ 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;
+ HTTP_G->etag.started = 0;
/* discard previous output buffers */
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;
+ /* 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));
}
}
- }
-
- /* gzip */
- if (Z_LVAL_P(GET_STATIC_PROP(gzip))) {
- php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC);
- } else {
- php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
- }
-
- /* caching */
- if (Z_LVAL_P(GET_STATIC_PROP(cache))) {
- zval *cctl, *etag, *lmod;
-
- etag = GET_STATIC_PROP(eTag);
- lmod = GET_STATIC_PROP(lastModified);
- cctl = 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));
+
+ 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 = GET_STATIC_PROP(contentType);
+ zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p);
if (Z_STRLEN_P(ctype)) {
http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype));
} else {
http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
}
}
+ if (ctype_p) {
+ zval_ptr_dtor(&ctype_p);
+ }
}
/* content disposition */
{
- zval *cd = GET_STATIC_PROP(contentDisposition);
+ zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p);
if (Z_STRLEN_P(cd)) {
http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL);
}
+ if (cd_p) {
+ zval_ptr_dtor(&cd_p);
+ }
}
/* throttling */
{
- HTTP_G(send).buffer_size = Z_LVAL_P(GET_STATIC_PROP(bufferSize));
- HTTP_G(send).throttle_delay = Z_DVAL_P(GET_STATIC_PROP(throttleDelay));
+ zval *bsize_p, *bsize = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize), &bsize_p);
+ zval *delay_p, *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay), &delay_p);
+ HTTP_G->send.buffer_size = Z_LVAL_P(bsize);
+ HTTP_G->send.throttle_delay = Z_DVAL_P(delay);
+ if (bsize_p) zval_ptr_dtor(&bsize_p);
+ if (delay_p) zval_ptr_dtor(&delay_p);
}
+ /* gzip */
+ HTTP_G->send.deflate.response = zval_is_true(GET_STATIC_PROP(gzip));
+
/* 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_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 = 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_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:
- {
- RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(GET_STATIC_PROP(file)), 1));
- }
+ 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;
}
}
}
/* }}} */
/* {{{ proto static void HttpResponse::capture()
- *
- * Capture script output.
- *
- * Example:
- * <pre>
- * <?php
- * HttpResponse::setCache(true);
- * HttpResponse::capture();
- * // script follows
- * ?>
- * </pre>
+ Capture script output.
*/
PHP_METHOD(HttpResponse, capture)
{
- zval do_catch;
-
NO_ARGS;
+
+ HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
- INIT_PZVAL(&do_catch);
- ZVAL_LONG(&do_catch, 1);
-
- SET_STATIC_PROP(catch, &do_catch);
+ UPD_STATIC_PROP(long, catch, 1);
php_end_ob_buffers(0 TSRMLS_CC);
php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
-#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];
call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC);
zval_dtor(&arg);
}
-#endif
}
/* }}} */