| modification, are permitted provided that the conditions mentioned |
| in the accompanying LICENSE file are met. |
+--------------------------------------------------------------------+
- | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
+ | 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_exception_object.h"
-#include "php_http_send_api.h"
#include "php_http_cache_api.h"
+#include "php_http_exception_object.h"
#include "php_http_headers_api.h"
-
-#ifdef HTTP_HAVE_MHASH
-# include <mhash.h>
-#endif
-#ifdef HTTP_HAVE_MAGIC
-# include <magic.h>
-#endif
-
-ZEND_EXTERN_MODULE_GLOBALS(http);
+#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 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_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_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);
#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);
#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);
-
- DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5);
- DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1);
- DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32);
-
-# ifdef HTTP_HAVE_MHASH
- {
- int l, i, c = mhash_count();
-
- for (i = 0; i <= c; ++i) {
- char const_name[256] = {0};
- const char *hash_name = mhash_get_hash_name_static(i);
-
- if (hash_name) {
- l = snprintf(const_name, 255, "ETAG_MHASH_%s", hash_name);
- zend_declare_class_constant_long(ce, const_name, l, i TSRMLS_CC);
- }
- }
- }
-# endif /* HTTP_HAVE_MHASH */
#endif /* WONKY */
}
/* {{{ proto static bool HttpResponse::setCache(bool cache)
*
- * Whether it sould be attempted to cache the entitity.
+ * Whether it should be attempted to cache the entity.
* 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
+ * NOTE: If you're using sessions, be sure 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.
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_METHOD(HttpResponse, setCache)
{
}
/* }}} */
-/* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
+/* {{{ 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.
*
* Expects a string parameter containing the primary cache control setting.
- * Addtitionally accepts an int parameter specifying the max-age setting.
+ * Additionally accepts an int parameter specifying the max-age setting.
+ * Accepts an optional third bool parameter indicating whether the cache
+ * must be revalidated every request.
*
* Returns TRUE on success, or FALSE if control does not match one of
* "public" , "private" or "no-cache".
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 {
- size_t cctl_len = spprintf(&cctl, 0, "%s, must-revalidate, max-age=%ld", ccontrol, max_age);
+ 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);
}
* 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
+ * Expects a string parameter specifying the file name the "Save as..." dialog
* 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.
}
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)) {
+ if ((etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA))) {
UPD_STATIC_PROP(string, eTag, etag);
efree(etag);
}
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)) {
+ if ((etag = http_etag(the_real_stream, 0, SEND_RSRC))) {
UPD_STATIC_PROP(string, eTag, etag);
efree(etag);
}
}
UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
- if (etag = http_etag(the_file, 0, -1)) {
+ if ((etag = http_etag(the_file, 0, -1))) {
UPD_STATIC_PROP(string, eTag, etag);
efree(etag);
}
*
* Finally send the entity.
*
- * Accepts an optional boolean parameter, specifying wheter the ouput
+ * Accepts an optional boolean parameter, specifying whether the output
* 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.
+ * Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.
*
* Example:
* <pre>
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 (zval_is_true(sent)) {
+ if (Z_LVAL_P(sent)) {
http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, response has already been sent");
RETURN_FALSE;
} else {
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);
}
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));
+ http_cache_last_modified(Z_LVAL_P(lmod), Z_LVAL_P(lmod) ? Z_LVAL_P(lmod) : HTTP_GET_REQUEST_TIME(), 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 *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);
+ HTTP_G->send.buffer_size = Z_LVAL_P(bsize);
+ HTTP_G->send.throttle_delay = Z_DVAL_P(delay);
if (bsize_p) zval_ptr_dtor(&bsize_p);
if (delay_p) zval_ptr_dtor(&delay_p);
}
/* gzip */
- HTTP_G(send).gzip_encoding = zval_is_true(GET_STATIC_PROP(gzip));
+ 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);
+ php_start_ob_buffer(NULL, HTTP_G->send.buffer_size, 0 TSRMLS_CC);
/* send */
switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
PHP_METHOD(HttpResponse, capture)
{
NO_ARGS;
+
+ HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
UPD_STATIC_PROP(long, catch, 1);