- add ob_(deflate|inflate)handler
[m6w6/ext-http] / http_response_object.c
index 72289b65f291fc71025eb04262abb32fdd03695c..4cbba7299d668eb4521970d20a52259e02e747d1 100644 (file)
@@ -1,16 +1,13 @@
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
-   | If you did not receive a copy of the PHP license and are unable to   |
-   | obtain it through the world-wide-web, please send a note to          |
-   | license@php.net so we can mail you a copy immediately.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2005, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
@@ -19,9 +16,9 @@
 #ifdef HAVE_CONFIG_H
 #      include "config.h"
 #endif
-#include "php.h"
 
-#include "missing.h"
+#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)
@@ -214,10 +200,11 @@ zend_function_entry http_response_object_fe[] = {
        EMPTY_FUNCTION_ENTRY
 };
 
-void _http_response_object_init(INIT_FUNC_ARGS)
+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)
@@ -245,26 +232,6 @@ static inline void _http_response_object_declare_default_properties(TSRMLS_D)
        DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM);
        DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST);
        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 */
 }
 
@@ -295,7 +262,7 @@ PHP_METHOD(HttpResponse, setHeader)
        zend_bool replace = 1;
        char *name;
        int name_len = 0;
-       zval *value = NULL;
+       zval *value = NULL, *orig = NULL;
 
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz/!|b", &name, &name_len, &value, &replace)) {
                RETURN_FALSE;
@@ -316,20 +283,31 @@ PHP_METHOD(HttpResponse, setHeader)
        /* send multiple header if replace is false and value is an array */
        if (!replace && Z_TYPE_P(value) == IS_ARRAY) {
                zval **data;
+               HashPosition pos;
                
-               FOREACH_VAL(value, data) {
+               FOREACH_VAL(pos, value, data) {
+                       zval *orig = *data;
+                       
                        convert_to_string_ex(data);
                        if (SUCCESS != http_send_header_ex(name, name_len, Z_STRVAL_PP(data), Z_STRLEN_PP(data), 0, NULL)) {
+                               if (orig != *data) {
+                                       zval_ptr_dtor(data);
+                               }
                                RETURN_FALSE;
                        }
+                       if (orig != *data) {
+                               zval_ptr_dtor(data);
+                       }
                }
                RETURN_TRUE;
        }
        /* send standard header */
-       if (Z_TYPE_P(value) != IS_STRING) {
-               convert_to_string_ex(&value);
+       orig = value;
+       convert_to_string_ex(&value);
+       RETVAL_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL));
+       if (orig != value) {
+               zval_ptr_dtor(&value);
        }
-       RETURN_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL));
 }
 /* }}} */
 
@@ -416,9 +394,13 @@ PHP_METHOD(HttpResponse, getCache)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache));
+               zval *cache_p, *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache), &cache_p);
                
-               RETURN_ZVAL(cache, 1, 0);
+               RETVAL_ZVAL(cache, 1, 0);
+
+               if (cache_p) {
+                       zval_ptr_dtor(&cache_p);
+               }
        }
 }
 /* }}}*/
@@ -454,9 +436,13 @@ PHP_METHOD(HttpResponse, getGzip)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip));
+               zval *gzip_p, *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip), &gzip_p);
                
-               RETURN_ZVAL(gzip, 1, 0);
+               RETVAL_ZVAL(gzip, 1, 0);
+
+               if (gzip_p) {
+                       zval_ptr_dtor(&gzip_p);
+               }
        }
 }
 /* }}} */
@@ -488,7 +474,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, must-revalidate, max-age=%ld", ccontrol, max_age);
                RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl, cctl, cctl_len));
                efree(cctl);
        }
@@ -506,9 +492,13 @@ PHP_METHOD(HttpResponse, getCacheControl)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl));
+               zval *ccontrol_p, *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl), &ccontrol_p);
                
-               RETURN_ZVAL(ccontrol, 1, 0);
+               RETVAL_ZVAL(ccontrol, 1, 0);
+
+               if (ccontrol_p) {
+                       zval_ptr_dtor(&ccontrol_p);
+               }
        }
 }
 /* }}} */
@@ -549,9 +539,13 @@ PHP_METHOD(HttpResponse, getContentType)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType));
+               zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p);
                
-               RETURN_ZVAL(ctype, 1, 0);
+               RETVAL_ZVAL(ctype, 1, 0);
+
+               if (ctype_p) {
+                       zval_ptr_dtor(&ctype_p);
+               }
        }
 }
 /* }}} */
@@ -658,9 +652,13 @@ PHP_METHOD(HttpResponse, getContentDisposition)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition));
+               zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p);
                
-               RETURN_ZVAL(cd, 1, 0);
+               RETVAL_ZVAL(cd, 1, 0);
+
+               if (cd_p) {
+                       zval_ptr_dtor(&cd_p);
+               }
        }
 }
 /* }}} */
@@ -697,9 +695,13 @@ PHP_METHOD(HttpResponse, getETag)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag));
+               zval *etag_p, *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p);
                
-               RETURN_ZVAL(etag, 1, 0);
+               RETVAL_ZVAL(etag, 1, 0);
+
+               if (etag_p) {
+                       zval_ptr_dtor(&etag_p);
+               }
        }
 }
 /* }}} */
@@ -736,9 +738,13 @@ PHP_METHOD(HttpResponse, getLastModified)
        NO_ARGS;
        
        IF_RETVAL_USED {
-               zval *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified));
+               zval *lm_p, *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified), &lm_p);
                
-               RETURN_ZVAL(lm, 1, 0);
+               RETVAL_ZVAL(lm, 1, 0);
+
+               if (lm_p) {
+                       zval_ptr_dtor(&lm_p);
+               }
        }
 }
 /* }}} */
@@ -779,9 +785,13 @@ PHP_METHOD(HttpResponse, getThrottleDelay)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay));
+               zval *delay_p, *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay), &delay_p);
                
-               RETURN_ZVAL(delay, 1, 0);
+               RETVAL_ZVAL(delay, 1, 0);
+
+               if (delay_p) {
+                       zval_ptr_dtor(&delay_p);
+               }
        }
 }
 /* }}} */
@@ -821,9 +831,13 @@ PHP_METHOD(HttpResponse, getBufferSize)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize));
+               zval *size_p, *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize), &size_p);
                
-               RETURN_ZVAL(size, 1, 0);
+               RETVAL_ZVAL(size, 1, 0);
+
+               if (size_p) {
+                       zval_ptr_dtor(&size_p);
+               }
        }
 }
 /* }}} */
@@ -855,7 +869,7 @@ PHP_METHOD(HttpResponse, setData)
        }
        
        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);
        }
@@ -914,7 +928,7 @@ PHP_METHOD(HttpResponse, setStream)
        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);
        }
@@ -934,7 +948,13 @@ PHP_METHOD(HttpResponse, getStream)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream))));
+               zval *stream_p;
+               
+               RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream), &stream_p)));
+
+               if (stream_p) {
+                       zval_ptr_dtor(&stream_p);
+               }
        }
 }
 /* }}} */
@@ -967,7 +987,7 @@ PHP_METHOD(HttpResponse, setFile)
        }
 
        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);
        }
@@ -987,9 +1007,13 @@ PHP_METHOD(HttpResponse, getFile)
        NO_ARGS;
 
        IF_RETVAL_USED {
-               zval *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file));
+               zval *the_file_p, *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file), &the_file_p);
                
-               RETURN_ZVAL(the_file, 1, 0);
+               RETVAL_ZVAL(the_file, 1, 0);
+
+               if (the_file_p) {
+                       zval_ptr_dtor(&the_file_p);
+               }
        }
 }
 /* }}} */
@@ -1026,13 +1050,11 @@ PHP_METHOD(HttpResponse, send)
        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 {
@@ -1041,14 +1063,14 @@ PHP_METHOD(HttpResponse, send)
 
        /* capture mode */
        if (zval_is_true(GET_STATIC_PROP(catch))) {
-               zval *the_data;
+               zval *etag_p, *the_data;
 
                MAKE_STD_ZVAL(the_data);
                php_ob_get_buffer(the_data TSRMLS_CC);
                SET_STATIC_PROP(data, the_data);
                ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
 
-               if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
+               if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag), &etag_p))) {
                        char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA);
                        if (etag) {
                                UPD_STATIC_PROP(string, eTag, etag);
@@ -1056,6 +1078,10 @@ PHP_METHOD(HttpResponse, send)
                        }
                }
                zval_ptr_dtor(&the_data);
+               
+               if (etag_p) {
+                       zval_ptr_dtor(&etag_p);
+               }
 
                clean_ob = 1;
        }
@@ -1069,19 +1095,27 @@ PHP_METHOD(HttpResponse, send)
 
        /* caching */
        if (zval_is_true(GET_STATIC_PROP(cache))) {
-               zval *cctl, *etag, *lmod;
+               zval *cctl, *cctl_p, *etag, *etag_p, *lmod, *lmod_p;
 
-               etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag));
-               lmod = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified));
-               cctl = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl));
+               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 (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 *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType));
+               zval *ctype_p, *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType), &ctype_p);
                if (Z_STRLEN_P(ctype)) {
                        http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype));
                } else {
@@ -1094,50 +1128,66 @@ PHP_METHOD(HttpResponse, send)
                                http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
                        }
                }
+               if (ctype_p) {
+                       zval_ptr_dtor(&ctype_p);
+               }
        }
 
        /* content disposition */
        {
-               zval *cd = GET_STATIC_PROP(contentDisposition);
+               zval *cd_p, *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition), &cd_p);
                if (Z_STRLEN_P(cd)) {
                        http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL);
                }
+               if (cd_p) {
+                       zval_ptr_dtor(&cd_p);
+               }
        }
 
        /* throttling */
        {
-               HTTP_G(send).buffer_size    = Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize)));
-               HTTP_G(send).throttle_delay = Z_DVAL_P(convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay)));
+               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);
+               if (bsize_p) zval_ptr_dtor(&bsize_p);
+               if (delay_p) zval_ptr_dtor(&delay_p);
        }
 
        /* gzip */
-       if (zval_is_true(GET_STATIC_PROP(gzip))) {
-               php_start_ob_buffer_named("ob_gzhandler", HTTP_G(send).buffer_size, 0 TSRMLS_CC);
-       } else {
-               php_start_ob_buffer(NULL, HTTP_G(send).buffer_size, 0 TSRMLS_CC);
-       }
+       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);
 
        /* send */
        switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
        {
                case SEND_DATA:
                {
-                       zval *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data));
-                       RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
+                       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));
+                       if (zdata_p) zval_ptr_dtor(&zdata_p);
+                       return;
                }
 
                case SEND_RSRC:
                {
                        php_stream *the_real_stream;
-                       zval *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream));
+                       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);
-                       RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
+                       RETVAL_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
+                       if (the_stream_p) zval_ptr_dtor(&the_stream_p);
+                       return;
                }
 
                default:
                {
-                       RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1));
+                       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));
+                       if (file_p) zval_ptr_dtor(&file_p);
+                       return;
                }
        }
 }
@@ -1159,6 +1209,8 @@ PHP_METHOD(HttpResponse, send)
 PHP_METHOD(HttpResponse, capture)
 {
        NO_ARGS;
+       
+       HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
 
        UPD_STATIC_PROP(long, catch, 1);