- API juggling
[m6w6/ext-http] / http_response_object.c
index 7e8c77c92f5d8dcc9382d4cfc86388dca7ca6965..c95956c853600a5b205fdefb695373efe53faf6f 100644 (file)
@@ -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"
@@ -47,6 +48,7 @@ ZEND_EXTERN_MODULE_GLOBALS(http);
 #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)
@@ -111,6 +113,26 @@ 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);
 
@@ -153,9 +175,16 @@ zend_function_entry http_response_object_fe[] = {
        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)
 {
@@ -188,7 +217,7 @@ static inline void _http_response_object_declare_default_properties(TSRMLS_D)
 
 /* ### 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
@@ -211,7 +240,7 @@ PHP_METHOD(HttpResponse, setCache)
 }
 /* }}} */
 
-/* {{{ proto bool HttpResponse::getCache()
+/* {{{ proto static bool HttpResponse::getCache()
  *
  * Get current caching setting.
  */
@@ -225,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.
  */
@@ -242,7 +271,7 @@ PHP_METHOD(HttpResponse, setGzip)
 }
 /* }}} */
 
-/* {{{ proto bool HttpResponse::getGzip()
+/* {{{ proto static bool HttpResponse::getGzip()
  *
  * Get current gzipping setting.
  */
@@ -256,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.
@@ -269,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;
        }
 
@@ -285,7 +314,7 @@ PHP_METHOD(HttpResponse, setCacheControl)
 }
 /* }}} */
 
-/* {{{ proto string HttpResponse::getCacheControl()
+/* {{{ proto static string HttpResponse::getCacheControl()
  *
  * Get current Cache-Control header setting.
  */
@@ -300,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.
  */
@@ -324,7 +353,7 @@ PHP_METHOD(HttpResponse, setContentType)
 }
 /* }}} */
 
-/* {{{ proto string HttpResponse::getContentType()
+/* {{{ proto static string HttpResponse::getContentType()
  *
  * Get current Content-Type header setting.
  */
@@ -339,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
@@ -363,7 +392,7 @@ PHP_METHOD(HttpResponse, setContentDisposition)
 }
 /* }}} */
 
-/* {{{ proto string HttpResponse::getContentDisposition()
+/* {{{ proto static string HttpResponse::getContentDisposition()
  *
  * Get current Content-Disposition setting.
  */
@@ -378,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.
  */
@@ -397,7 +426,7 @@ PHP_METHOD(HttpResponse, setETag)
 }
 /* }}} */
 
-/* {{{ proto string HttpResponse::getETag()
+/* {{{ proto static string HttpResponse::getETag()
  *
  * Get the previously set custom ETag.
  */
@@ -412,7 +441,7 @@ PHP_METHOD(HttpResponse, getETag)
 }
 /* }}} */
 
-/* {{{ proto void HttpResponse::setThrottleDelay(double seconds)
+/* {{{ proto static void HttpResponse::setThrottleDelay(double seconds)
  *
  */
 PHP_METHOD(HttpResponse, setThrottleDelay)
@@ -425,7 +454,7 @@ PHP_METHOD(HttpResponse, setThrottleDelay)
 }
 /* }}} */
 
-/* {{{ proto double HttpResponse::getThrottleDelay()
+/* {{{ proto static double HttpResponse::getThrottleDelay()
  *
  */
 PHP_METHOD(HttpResponse, getThrottleDelay)
@@ -438,7 +467,7 @@ PHP_METHOD(HttpResponse, getThrottleDelay)
 }
 /* }}} */
 
-/* {{{ proto void HttpResponse::setBufferSize(long bytes)
+/* {{{ proto static void HttpResponse::setBufferSize(long bytes)
  *
  */
 PHP_METHOD(HttpResponse, setBufferSize)
@@ -451,7 +480,7 @@ PHP_METHOD(HttpResponse, setBufferSize)
 }
 /* }}} */
 
-/* {{{ proto long HttpResponse::getBufferSize()
+/* {{{ proto static long HttpResponse::getBufferSize()
  *
  */
 PHP_METHOD(HttpResponse, getBufferSize)
@@ -464,13 +493,13 @@ 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;
@@ -489,7 +518,7 @@ PHP_METHOD(HttpResponse, setData)
 }
 /* }}} */
 
-/* {{{ proto string HttpResponse::getData()
+/* {{{ proto static string HttpResponse::getData()
  *
  * Get the previously set data to be sent.
  */
@@ -504,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.
  */
@@ -531,7 +560,7 @@ PHP_METHOD(HttpResponse, setStream)
 }
 /* }}} */
 
-/* {{{ proto resource HttpResponse::getStream()
+/* {{{ proto static resource HttpResponse::getStream()
  *
  * Get the previously set resource to be sent.
  */
@@ -545,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.
  */
@@ -570,7 +599,7 @@ PHP_METHOD(HttpResponse, setFile)
 }
 /* }}} */
 
-/* {{{ proto string HttpResponse::getFile()
+/* {{{ proto static string HttpResponse::getFile()
  *
  * Get the previously set file to be sent.
  */
@@ -585,7 +614,7 @@ 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.
  *
@@ -602,7 +631,7 @@ PHP_METHOD(HttpResponse, getFile)
  */
 PHP_METHOD(HttpResponse, send)
 {
-       zval *do_cache, *do_gzip, *sent;
+       zval *sent;
        zend_bool clean_ob = 1;
 
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &clean_ob)) {
@@ -649,15 +678,13 @@ PHP_METHOD(HttpResponse, send)
 
        /* 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);
@@ -731,9 +758,18 @@ PHP_METHOD(HttpResponse, send)
 }
 /* }}} */
 
-/* {{{ proto void HttpResponse::capture()
+/* {{{ proto static void HttpResponse::capture()
  *
  * Capture script output.
+ *
+ * Example:
+ * <pre>
+ * <?php
+ * HttpResponse::setCache(true);
+ * HttpResponse::capture();
+ * // script follows
+ * ?>
+ * </pre>
  */
 PHP_METHOD(HttpResponse, capture)
 {