X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_response_object.c;h=c95956c853600a5b205fdefb695373efe53faf6f;hp=add22bf4fd83f8857a830cc2443ffffdd54e1280;hb=6deee2e3d2d6282dd76e3725fe2de6c7833bd57f;hpb=402ada5cf64b817dd4c4cfd4c112b59b1139dff5
diff --git a/http_response_object.c b/http_response_object.c
index add22bf..c95956c 100644
--- a/http_response_object.c
+++ b/http_response_object.c
@@ -25,6 +25,7 @@
#include "SAPI.h"
#include "php_ini.h"
+#include "ext/standard/head.h"
#include "php_http.h"
#include "php_http_api.h"
@@ -38,11 +39,16 @@
ZEND_EXTERN_MODULE_GLOBALS(http);
-#define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
+#define USE_STATIC_PROP() USE_STATIC_PROP_EX(http_response_object_ce)
+#define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
+#define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
+#define SET_STATIC_PROP_STRING(n, s, d) SET_STATIC_PROP_STRING_EX(http_response_object_ce, n, s, d)
+#define SET_STATIC_PROP_STRINGL(n, s, l, d) SET_STATIC_PROP_STRINGL_EX(http_response_object_ce, n, s, l, d)
#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_EMPTY_ARGS(getETag, 0);
HTTP_BEGIN_ARGS(setETag, 1)
@@ -105,6 +111,28 @@ 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(sendStatus, 1)
+ HTTP_ARG_VAL(status, 0)
+HTTP_END_ARGS;
+
+HTTP_BEGIN_ARGS(sendHeader, 1)
+ HTTP_ARG_VAL(header, 0)
+ HTTP_ARG_VAL(replace, 0)
+ HTTP_ARG_VAL(status, 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);
@@ -145,10 +173,18 @@ 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)
+
+ HTTP_RESPONSE_ALIAS(redirect, http_redirect)
+
+ HTTP_RESPONSE_ALIAS(sendStatus, http_send_status)
+ HTTP_RESPONSE_ALIAS(sendHeader, header)
+
+ HTTP_RESPONSE_ALIAS(getRequestHeaders, http_get_request_headers)
+ HTTP_RESPONSE_ALIAS(getRequestBody, http_get_request_body)
{NULL, NULL, NULL}
};
-static zend_object_handlers http_response_object_handlers;
void _http_response_object_init(INIT_FUNC_ARGS)
{
@@ -166,20 +202,22 @@ static inline void _http_response_object_declare_default_properties(TSRMLS_D)
DCL_STATIC_PROP(PROTECTED, bool, cache, 0);
DCL_STATIC_PROP(PROTECTED, bool, gzip, 0);
DCL_STATIC_PROP(PROTECTED, long, stream, 0);
- DCL_STATIC_PROP(PROTECTED, string, file, "");
- DCL_STATIC_PROP(PROTECTED, string, data, "");
- DCL_STATIC_PROP(PROTECTED, string, eTag, "");
+ 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(PROTECTED, string, cacheControl, HTTP_DEFAULT_CACHECONTROL);
- DCL_STATIC_PROP(PROTECTED, string, contentType, INI_STR("default_content_type"));
- DCL_STATIC_PROP(PROTECTED, string, contentDisposition, "");
+ 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);
+
+ DCL_STATIC_PROP(PUBLIC, string, dummy, "EMPTY");
}
/* ### USERLAND ### */
-/* {{{ proto bool HttpResponse::setCache(bool cache)
+/* {{{ 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
@@ -197,12 +235,12 @@ PHP_METHOD(HttpResponse, setCache)
RETURN_FALSE;
}
- ZVAL_LONG(GET_STATIC_PROP(cache), do_cache);
+ ZVAL_BOOL(GET_STATIC_PROP(cache), do_cache);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto bool HttpResponse::getCache()
+/* {{{ proto static bool HttpResponse::getCache()
*
* Get current caching setting.
*/
@@ -216,7 +254,7 @@ PHP_METHOD(HttpResponse, getCache)
}
/* }}}*/
-/* {{{ proto bool HttpResponse::setGzip(bool gzip)
+/* {{{ proto static bool HttpResponse::setGzip(bool gzip)
*
* Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET.
*/
@@ -228,12 +266,12 @@ PHP_METHOD(HttpResponse, setGzip)
RETURN_FALSE;
}
- ZVAL_LONG(GET_STATIC_PROP(gzip), do_gzip);
+ ZVAL_BOOL(GET_STATIC_PROP(gzip), do_gzip);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto bool HttpResponse::getGzip()
+/* {{{ proto static bool HttpResponse::getGzip()
*
* Get current gzipping setting.
*/
@@ -247,7 +285,7 @@ PHP_METHOD(HttpResponse, getGzip)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setCacheControl(string control[, long max_age = 0])
+/* {{{ 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.
@@ -260,7 +298,7 @@ PHP_METHOD(HttpResponse, setCacheControl)
#define HTTP_CACHECONTROL_TEMPLATE "%s, must-revalidate, max_age=%ld"
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &ccontrol, &cc_len, &max_age)) {
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &ccontrol, &cc_len, &max_age)) {
RETURN_FALSE;
}
@@ -268,14 +306,15 @@ PHP_METHOD(HttpResponse, setCacheControl)
http_error_ex(E_WARNING, HTTP_E_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
RETURN_FALSE;
} else {
+ USE_STATIC_PROP();
spprintf(&cctl, 0, HTTP_CACHECONTROL_TEMPLATE, ccontrol, max_age);
- ZVAL_STRING_FREE(GET_STATIC_PROP(cacheControl), cctl, 0);
+ SET_STATIC_PROP_STRING(cacheControl, cctl, 0);
RETURN_TRUE;
}
}
/* }}} */
-/* {{{ proto string HttpResponse::getCacheControl()
+/* {{{ proto static string HttpResponse::getCacheControl()
*
* Get current Cache-Control header setting.
*/
@@ -290,7 +329,7 @@ PHP_METHOD(HttpResponse, getCacheControl)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setContentType(string content_type)
+/* {{{ proto static bool HttpResponse::setContentType(string content_type)
*
* Set the content-type of the sent entity.
*/
@@ -308,12 +347,13 @@ PHP_METHOD(HttpResponse, setContentType)
RETURN_FALSE;
}
- ZVAL_STRINGL_FREE(GET_STATIC_PROP(contentType), ctype, ctype_len, 1);
+ USE_STATIC_PROP();
+ SET_STATIC_PROP_STRINGL(contentType, ctype, ctype_len, 1);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getContentType()
+/* {{{ proto static string HttpResponse::getContentType()
*
* Get current Content-Type header setting.
*/
@@ -328,7 +368,7 @@ PHP_METHOD(HttpResponse, getContentType)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
+/* {{{ 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
@@ -347,12 +387,12 @@ PHP_METHOD(HttpResponse, setContentDisposition)
}
spprintf(&cd, 0, HTTP_CONTENTDISPOSITION_TEMPLATE, send_inline ? "inline" : "attachment", file);
- ZVAL_STRING_FREE(GET_STATIC_PROP(contentDisposition), cd, 0);
+ SET_STATIC_PROP_STRING(contentDisposition, cd, 0);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getContentDisposition()
+/* {{{ proto static string HttpResponse::getContentDisposition()
*
* Get current Content-Disposition setting.
*/
@@ -367,7 +407,7 @@ PHP_METHOD(HttpResponse, getContentDisposition)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setETag(string etag)
+/* {{{ proto static bool HttpResponse::setETag(string etag)
*
* Set a custom ETag. Use this only if you know what you're doing.
*/
@@ -380,12 +420,13 @@ PHP_METHOD(HttpResponse, setETag)
RETURN_FALSE;
}
- ZVAL_STRINGL_FREE(GET_STATIC_PROP(eTag), etag, etag_len, 1);
+ USE_STATIC_PROP();
+ SET_STATIC_PROP_STRINGL(eTag, etag, etag_len, 1);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getETag()
+/* {{{ proto static string HttpResponse::getETag()
*
* Get the previously set custom ETag.
*/
@@ -400,7 +441,7 @@ PHP_METHOD(HttpResponse, getETag)
}
/* }}} */
-/* {{{ proto void HttpResponse::setThrottleDelay(double seconds)
+/* {{{ proto static void HttpResponse::setThrottleDelay(double seconds)
*
*/
PHP_METHOD(HttpResponse, setThrottleDelay)
@@ -413,7 +454,7 @@ PHP_METHOD(HttpResponse, setThrottleDelay)
}
/* }}} */
-/* {{{ proto double HttpResponse::getThrottleDelay()
+/* {{{ proto static double HttpResponse::getThrottleDelay()
*
*/
PHP_METHOD(HttpResponse, getThrottleDelay)
@@ -426,7 +467,7 @@ PHP_METHOD(HttpResponse, getThrottleDelay)
}
/* }}} */
-/* {{{ proto void HttpResponse::setBufferSize(long bytes)
+/* {{{ proto static void HttpResponse::setBufferSize(long bytes)
*
*/
PHP_METHOD(HttpResponse, setBufferSize)
@@ -439,7 +480,7 @@ PHP_METHOD(HttpResponse, setBufferSize)
}
/* }}} */
-/* {{{ proto long HttpResponse::getBufferSize()
+/* {{{ proto static long HttpResponse::getBufferSize()
*
*/
PHP_METHOD(HttpResponse, getBufferSize)
@@ -452,28 +493,32 @@ PHP_METHOD(HttpResponse, getBufferSize)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setData(string data)
+/* {{{ proto static bool HttpResponse::setData(string data)
*
* Set the data to be sent.
*/
PHP_METHOD(HttpResponse, setData)
{
- zval *the_data, *data;
+ 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;
}
-
convert_to_string_ex(&the_data);
- data = GET_STATIC_PROP(data);
- ZVAL_STRINGL_FREE(data, Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), 1);
+
+ USE_STATIC_PROP();
+ SET_STATIC_PROP(data, the_data);
ZVAL_LONG(GET_STATIC_PROP(lastModified), http_last_modified(the_data, SEND_DATA));
ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
+ if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
+ SET_STATIC_PROP_STRING(eTag, http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA), 0);
+ }
+
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getData()
+/* {{{ proto static string HttpResponse::getData()
*
* Get the previously set data to be sent.
*/
@@ -488,7 +533,7 @@ PHP_METHOD(HttpResponse, getData)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setStream(resource stream)
+/* {{{ proto static bool HttpResponse::setStream(resource stream)
*
* Set the resource to be sent.
*/
@@ -500,16 +545,22 @@ PHP_METHOD(HttpResponse, setStream)
if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) {
RETURN_FALSE;
}
-
+ zend_list_addref(Z_LVAL_P(the_stream));
php_stream_from_zval(the_real_stream, &the_stream);
+
+ USE_STATIC_PROP();
ZVAL_LONG(GET_STATIC_PROP(stream), Z_LVAL_P(the_stream));
ZVAL_LONG(GET_STATIC_PROP(lastModified), http_last_modified(the_real_stream, SEND_RSRC));
ZVAL_LONG(GET_STATIC_PROP(mode), SEND_RSRC);
+ if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
+ SET_STATIC_PROP_STRING(eTag, http_etag(the_real_stream, 0, SEND_RSRC), 0);
+ }
+
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto resource HttpResponse::getStream()
+/* {{{ proto static resource HttpResponse::getStream()
*
* Get the previously set resource to be sent.
*/
@@ -523,7 +574,7 @@ PHP_METHOD(HttpResponse, getStream)
}
/* }}} */
-/* {{{ proto bool HttpResponse::setFile(string file)
+/* {{{ proto static bool HttpResponse::setFile(string file)
*
* Set the file to be sent.
*/
@@ -531,20 +582,24 @@ PHP_METHOD(HttpResponse, setFile)
{
zval *the_file;
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &the_file)) {
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_file)) {
RETURN_FALSE;
}
convert_to_string_ex(&the_file);
- ZVAL_STRINGL_FREE(GET_STATIC_PROP(file), Z_STRVAL_P(the_file), Z_STRLEN_P(the_file), 1);
+ USE_STATIC_PROP();
+ SET_STATIC_PROP(file, the_file);
ZVAL_LONG(GET_STATIC_PROP(lastModified), http_last_modified(the_file, -1));
ZVAL_LONG(GET_STATIC_PROP(mode), -1);
+ if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
+ SET_STATIC_PROP_STRING(eTag, http_etag(the_file, 0, -1), 0);
+ }
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getFile()
+/* {{{ proto static string HttpResponse::getFile()
*
* Get the previously set file to be sent.
*/
@@ -559,42 +614,84 @@ PHP_METHOD(HttpResponse, getFile)
}
/* }}} */
-/* {{{ proto bool HttpResponse::send([bool clean_ob = true])
+/* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
*
* Finally send the entity.
+ *
+ * Example:
+ *
+ *
+ *
*/
PHP_METHOD(HttpResponse, send)
{
- zval *do_cache, *do_gzip;
+ 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(E_WARNING, HTTP_E_HEADER, "Cannot send HttpResponse, headers have already been sent");
+ RETURN_FALSE;
+ }
+
+ sent = GET_STATIC_PROP(sent);
+ if (Z_LVAL_P(sent)) {
+ http_error(E_WARNING, HTTP_E_UNKOWN, "Cannot send HttpResponse, response has already been sent");
+ RETURN_FALSE;
+ } else {
+ Z_LVAL_P(sent) = 1;
+ }
+
+ /* capture mode */
+ if (Z_LVAL_P(GET_STATIC_PROP(catch))) {
+ zval the_data;
+
+ INIT_PZVAL(&the_data);
+ php_ob_get_buffer(&the_data TSRMLS_CC);
+
+ USE_STATIC_PROP();
+ SET_STATIC_PROP(data, &the_data);
+ ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
+
+ if (!Z_STRLEN_P(GET_STATIC_PROP(eTag))) {
+ SET_STATIC_PROP_STRING(eTag, http_etag(Z_STRVAL(the_data), Z_STRLEN(the_data), SEND_DATA), 0);
+ }
+ zval_dtor(&the_data);
+
+ 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);
+ php_end_ob_buffers(0 TSRMLS_CC);
}
/* gzip */
if (Z_LVAL_P(GET_STATIC_PROP(gzip))) {
php_start_ob_buffer_named("ob_gzhandler", 0, 1 TSRMLS_CC);
+ } else {
+ php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
}
/* caching */
if (Z_LVAL_P(GET_STATIC_PROP(cache))) {
- char *cc_hdr;
- int cc_len;
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_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));
}
@@ -604,7 +701,14 @@ PHP_METHOD(HttpResponse, send)
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"));
+ 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"));
+ }
}
}
@@ -640,6 +744,7 @@ PHP_METHOD(HttpResponse, send)
{
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(the_real_stream));
}
@@ -653,6 +758,52 @@ PHP_METHOD(HttpResponse, send)
}
/* }}} */
+/* {{{ proto static void HttpResponse::capture()
+ *
+ * Capture script output.
+ *
+ * Example:
+ *
+ *
+ *
+ */
+PHP_METHOD(HttpResponse, capture)
+{
+ zval do_catch;
+
+ NO_ARGS;
+
+ INIT_PZVAL(&do_catch);
+ ZVAL_LONG(&do_catch, 1);
+ USE_STATIC_PROP();
+ SET_STATIC_PROP(catch, &do_catch);
+
+ 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);
+ }
+}
+/* }}} */
+
#endif /* ZEND_ENGINE_2 */
/*