- get rid of 1001 strict-aliasing warnings
[m6w6/ext-http] / http_response_object.c
index 0d6cfa7cd59d2c150e7ab86a2c238c947fe0029e..9fb4771d8b2726850f2a7c3274b4d40e9f4e51a1 100644 (file)
@@ -6,48 +6,30 @@
     | 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_MAGIC
-#      include <magic.h>
-#endif
-
-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 UPD_STATIC_STRL(n, v, l)       UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
+#include "php_http_response_object.h"
+#include "php_http_send_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_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))
 
@@ -61,33 +43,34 @@ HTTP_BEGIN_ARGS(getHeader, 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;
@@ -97,33 +80,33 @@ HTTP_BEGIN_ARGS(guessContentType, 1)
        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;
@@ -132,7 +115,7 @@ HTTP_BEGIN_ARGS(send, 0)
        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)
@@ -145,14 +128,13 @@ HTTP_BEGIN_ARGS(status, 1)
        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);
 #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[] = {
 
@@ -211,14 +193,7 @@ zend_function_entry http_response_object_fe[] = {
 PHP_MINIT_FUNCTION(http_response_object)
 {
        HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0);
-       http_response_object_declare_default_properties();
-       return SUCCESS;
-}
-
-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);
@@ -238,9 +213,13 @@ 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);
 #endif /* WONKY */
+       
+       return SUCCESS;
 }
 
 static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC)
@@ -327,6 +306,8 @@ PHP_METHOD(HttpResponse, setHeader)
  * header to read.  If the parameter is empty or omitted, an associative array
  * with all headers will be returned.
  * 
+ * NOTE: In Apache2 this only works for PHP-5.1.3 and greater.
+ * 
  * Returns either a string containing the value of the header matching name,
  * FALSE on failure, or an associative array with all headers. 
  */
@@ -350,7 +331,7 @@ PHP_METHOD(HttpResponse, getHeader)
                
                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))) {
+                               (SUCCESS == zend_hash_find(&headers_ht, name, name_len + 1, (void *) &header))) {
                        RETVAL_ZVAL(*header, 1, 0);
                } else {
                        RETVAL_NULL();
@@ -367,17 +348,17 @@ PHP_METHOD(HttpResponse, getHeader)
 
 /* {{{ 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)
 {
@@ -455,13 +436,15 @@ PHP_METHOD(HttpResponse, getGzip)
 }
 /* }}} */
 
-/* {{{ 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".
@@ -473,8 +456,9 @@ 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;
        }
 
@@ -482,7 +466,7 @@ PHP_METHOD(HttpResponse, setCacheControl)
                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);
        }
@@ -574,15 +558,12 @@ PHP_METHOD(HttpResponse, getContentType)
  */
 PHP_METHOD(HttpResponse, guessContentType)
 {
+#ifdef HTTP_HAVE_MAGIC
        char *magic_file, *ct = NULL;
        int magic_file_len;
-       long magic_mode = 0;
+       long magic_mode = MAGIC_MIME;
        
        RETVAL_FALSE;
-       
-#ifdef HTTP_HAVE_MAGIC
-       magic_mode = MAGIC_MIME;
-       
        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))) {
@@ -615,6 +596,7 @@ PHP_METHOD(HttpResponse, guessContentType)
        SET_EH_NORMAL();
 #else
        http_error(HE_THROW, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available");
+       RETURN_FALSE;
 #endif
 }
 /* }}} */
@@ -625,7 +607,7 @@ PHP_METHOD(HttpResponse, guessContentType)
  * 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.
@@ -1030,14 +1012,14 @@ PHP_METHOD(HttpResponse, getFile)
  *
  * 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>
@@ -1096,7 +1078,7 @@ PHP_METHOD(HttpResponse, send)
 
        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);
        }
@@ -1104,21 +1086,24 @@ PHP_METHOD(HttpResponse, send)
        /* 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);
-
-               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 (Z_LVAL_P(lmod) || Z_STRLEN_P(etag)) {
+                       http_send_cache_control(Z_STRVAL_P(cctl), Z_STRLEN_P(cctl));
+                       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));
+                       }
+               }
+               
                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 */
@@ -1156,17 +1141,17 @@ PHP_METHOD(HttpResponse, send)
        {
                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)))
@@ -1174,7 +1159,7 @@ PHP_METHOD(HttpResponse, send)
                case SEND_DATA:
                {
                        zval *zdata_p, *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data), &zdata_p);
-                       RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
+                       RETVAL_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
                        if (zdata_p) zval_ptr_dtor(&zdata_p);
                        return;
                }
@@ -1185,7 +1170,7 @@ PHP_METHOD(HttpResponse, send)
                        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_ex(the_real_stream, 0, 1));
+                       RETVAL_SUCCESS(http_send_stream(the_real_stream));
                        if (the_stream_p) zval_ptr_dtor(&the_stream_p);
                        return;
                }
@@ -1193,7 +1178,7 @@ PHP_METHOD(HttpResponse, send)
                default:
                {
                        zval *file_p;
-                       RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &file_p)), 1));
+                       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;
                }