#include "SAPI.h"
#include "php_ini.h"
+#include "ext/standard/head.h"
#include "php_http.h"
#include "php_http_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|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(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);
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(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)
{NULL, NULL, NULL}
};
-static zend_object_handlers http_response_object_handlers;
void _http_response_object_init(INIT_FUNC_ARGS)
{
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_N(PROTECTED, headers);
}
/* ### USERLAND ### */
-/* {{{ proto bool HttpResponse::setCache(bool cache)
+/* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
+ */
+PHP_METHOD(HttpResponse, setHeader)
+{
+ zend_bool replace = 1;
+ char *name;
+ int name_len = 0;
+ zval *value = NULL, *headers, **header;
+
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz/!|b", &name, &name_len, &value, &replace)) {
+ RETURN_FALSE;
+ }
+ if (!name_len) {
+ http_error(HE_WARNING, HTTP_E_HEADER, "Cannot send anonymous headers");
+ RETURN_FALSE;
+ }
+
+ USE_STATIC_PROP();
+ 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));
+ }
+}
+/* }}} */
+
+/* {{{ proto static mixed HttpResponse::getHeader([string name])
+ */
+PHP_METHOD(HttpResponse, getHeader)
+{
+ char *name = NULL;
+ int name_len = 0;
+ zval *headers, **header;
+
+ 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);
+ }
+
+ 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, ZVAL_PTR_DTOR, 1);
+ } else {
+ RETURN_NULL();
+ }
+}
+/* }}} */
+
+/* {{{ 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
}
/* }}} */
-/* {{{ proto bool HttpResponse::getCache()
+/* {{{ proto static bool HttpResponse::getCache()
*
* Get current caching setting.
*/
}
/* }}}*/
-/* {{{ 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.
*/
}
/* }}} */
-/* {{{ proto bool HttpResponse::getGzip()
+/* {{{ proto static bool HttpResponse::getGzip()
*
* Get current gzipping setting.
*/
}
/* }}} */
-/* {{{ 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.
#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;
}
if (strcmp(ccontrol, "public") && strcmp(ccontrol, "private") && strcmp(ccontrol, "no-cache")) {
- http_error_ex(E_WARNING, HTTP_E_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
+ http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
RETURN_FALSE;
} else {
USE_STATIC_PROP();
}
/* }}} */
-/* {{{ proto string HttpResponse::getCacheControl()
+/* {{{ proto static string HttpResponse::getCacheControl()
*
* Get current Cache-Control header setting.
*/
}
/* }}} */
-/* {{{ proto bool HttpResponse::setContentType(string content_type)
+/* {{{ proto static bool HttpResponse::setContentType(string content_type)
*
* Set the content-type of the sent entity.
*/
}
if (!strchr(ctype, '/')) {
- http_error_ex(E_WARNING, HTTP_E_PARAM, "Content type '%s' doesn't seem to contain a primary and a secondary part", 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;
}
}
/* }}} */
-/* {{{ proto string HttpResponse::getContentType()
+/* {{{ proto static string HttpResponse::getContentType()
*
* Get current Content-Type header setting.
*/
}
/* }}} */
-/* {{{ 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
int file_len;
zend_bool send_inline = 0;
-#define HTTP_CONTENTDISPOSITION_TEMPLATE "%s; filename=\"%s\""
-
if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) {
RETURN_FALSE;
}
- spprintf(&cd, 0, HTTP_CONTENTDISPOSITION_TEMPLATE, send_inline ? "inline" : "attachment", file);
+ spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file);
+ USE_STATIC_PROP();
SET_STATIC_PROP_STRING(contentDisposition, cd, 0);
RETURN_TRUE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getContentDisposition()
+/* {{{ proto static string HttpResponse::getContentDisposition()
*
* Get current Content-Disposition setting.
*/
}
/* }}} */
-/* {{{ 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.
*/
}
/* }}} */
-/* {{{ proto string HttpResponse::getETag()
+/* {{{ proto static string HttpResponse::getETag()
*
* Get the previously set custom ETag.
*/
}
/* }}} */
-/* {{{ proto void HttpResponse::setThrottleDelay(double seconds)
+/* {{{ proto static void HttpResponse::setThrottleDelay(double seconds)
*
*/
PHP_METHOD(HttpResponse, setThrottleDelay)
}
/* }}} */
-/* {{{ proto double HttpResponse::getThrottleDelay()
+/* {{{ proto static double HttpResponse::getThrottleDelay()
*
*/
PHP_METHOD(HttpResponse, getThrottleDelay)
}
/* }}} */
-/* {{{ proto void HttpResponse::setBufferSize(long bytes)
+/* {{{ proto static void HttpResponse::setBufferSize(long bytes)
*
*/
PHP_METHOD(HttpResponse, setBufferSize)
}
/* }}} */
-/* {{{ proto long HttpResponse::getBufferSize()
+/* {{{ proto static long HttpResponse::getBufferSize()
*
*/
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)) {
RETURN_FALSE;
}
/* }}} */
-/* {{{ proto string HttpResponse::getData()
+/* {{{ proto static string HttpResponse::getData()
*
* Get the previously set data to be sent.
*/
}
/* }}} */
-/* {{{ proto bool HttpResponse::setStream(resource stream)
+/* {{{ proto static bool HttpResponse::setStream(resource stream)
*
* Set the resource to be sent.
*/
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();
}
/* }}} */
-/* {{{ proto resource HttpResponse::getStream()
+/* {{{ proto static resource HttpResponse::getStream()
*
* Get the previously set resource to be sent.
*/
}
/* }}} */
-/* {{{ proto bool HttpResponse::setFile(string file)
+/* {{{ proto static bool HttpResponse::setFile(string file)
*
* Set the file to be sent.
*/
}
/* }}} */
-/* {{{ proto string HttpResponse::getFile()
+/* {{{ proto static string HttpResponse::getFile()
*
* Get the previously set file to be sent.
*/
}
/* }}} */
-/* {{{ proto bool HttpResponse::send([bool clean_ob = true])
+/* {{{ 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>
*/
PHP_METHOD(HttpResponse, send)
{
- zval *do_cache, *do_gzip;
+ zval *sent, *headers;
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;
+ }
+
+ 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 (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 */
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);
+ first = 0;
+ }
+ } else {
+ http_send_header_ex(name, strlen(name), Z_STRVAL_PP(value), Z_STRLEN_PP(value), 1);
+ }
+ name = NULL;
+ }
+ }
+ }
+
/* gzip */
if (Z_LVAL_P(GET_STATIC_PROP(gzip))) {
- php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC);
+ 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);
{
zval *cd = GET_STATIC_PROP(contentDisposition);
if (Z_STRLEN_P(cd)) {
- char *cds;
-
- spprintf(&cds, 0, "Content-Disposition: %s", Z_STRVAL_P(cd));
- http_send_header(cds);
- efree(cds);
+ http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1);
}
}
{
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));
}
}
/* }}} */
+/* {{{ proto static void HttpResponse::capture()
+ *
+ * Capture script output.
+ *
+ * Example:
+ * <pre>
+ * <?php
+ * HttpResponse::setCache(true);
+ * HttpResponse::capture();
+ * // script follows
+ * ?>
+ * </pre>
+ */
+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 */
/*
projects / m6w6 / ext-http / blobdiff