2 +----------------------------------------------------------------------+
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
26 /* broken static properties in PHP 5.0 */
27 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
33 #include "php_http_api.h"
34 #include "php_http_std_defs.h"
35 #include "php_http_response_object.h"
36 #include "php_http_exception_object.h"
37 #include "php_http_send_api.h"
38 #include "php_http_cache_api.h"
40 ZEND_EXTERN_MODULE_GLOBALS(http
);
42 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
43 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
44 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
46 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
47 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
48 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
49 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
51 HTTP_BEGIN_ARGS(setHeader
, 2)
53 HTTP_ARG_VAL(value
, 0)
54 HTTP_ARG_VAL(replace
, 0)
57 HTTP_BEGIN_ARGS(getHeader
, 0)
61 HTTP_EMPTY_ARGS(getETag
, 0);
62 HTTP_BEGIN_ARGS(setETag
, 1)
66 HTTP_EMPTY_ARGS(getLastModified
, 0);
67 HTTP_BEGIN_ARGS(setLastModified
, 1)
68 HTTP_ARG_VAL(timestamp
, 0)
71 HTTP_EMPTY_ARGS(getCache
, 0);
72 HTTP_BEGIN_ARGS(setCache
, 1)
73 HTTP_ARG_VAL(cache
, 0)
76 HTTP_EMPTY_ARGS(getGzip
, 0);
77 HTTP_BEGIN_ARGS(setGzip
, 1)
81 HTTP_EMPTY_ARGS(getCacheControl
, 0);
82 HTTP_BEGIN_ARGS(setCacheControl
, 1)
83 HTTP_ARG_VAL(cache_control
, 0)
84 HTTP_ARG_VAL(max_age
, 0)
87 HTTP_EMPTY_ARGS(getContentType
, 0);
88 HTTP_BEGIN_ARGS(setContentType
, 1)
89 HTTP_ARG_VAL(content_type
, 0)
92 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
93 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
94 HTTP_ARG_VAL(filename
, 0)
95 HTTP_ARG_VAL(send_inline
, 0)
98 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
99 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
100 HTTP_ARG_VAL(seconds
, 0)
103 HTTP_EMPTY_ARGS(getBufferSize
, 0);
104 HTTP_BEGIN_ARGS(setBufferSize
, 1)
105 HTTP_ARG_VAL(bytes
, 0)
108 HTTP_EMPTY_ARGS(getData
, 0);
109 HTTP_BEGIN_ARGS(setData
, 1)
110 HTTP_ARG_VAL(data
, 0)
113 HTTP_EMPTY_ARGS(getStream
, 0);
114 HTTP_BEGIN_ARGS(setStream
, 1)
115 HTTP_ARG_VAL(stream
, 0)
118 HTTP_EMPTY_ARGS(getFile
, 0);
119 HTTP_BEGIN_ARGS(setFile
, 1)
120 HTTP_ARG_VAL(filepath
, 0)
123 HTTP_BEGIN_ARGS(send
, 0)
124 HTTP_ARG_VAL(clean_ob
, 0)
127 HTTP_EMPTY_ARGS(capture
, 0);
129 HTTP_BEGIN_ARGS(redirect
, 0)
131 HTTP_ARG_VAL(params
, 0)
132 HTTP_ARG_VAL(session
, 0)
133 HTTP_ARG_VAL(permanent
, 0)
136 HTTP_BEGIN_ARGS(status
, 1)
137 HTTP_ARG_VAL(code
, 0)
140 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
141 HTTP_EMPTY_ARGS(getRequestBody
, 0);
143 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
144 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
147 HashTable http_response_statics
;
150 zend_class_entry
*http_response_object_ce
;
151 zend_function_entry http_response_object_fe
[] = {
153 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
154 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
156 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
157 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
159 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
162 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
178 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
181 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
184 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
187 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
190 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
193 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
196 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
197 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
198 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
203 void _http_response_object_init(INIT_FUNC_ARGS
)
205 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
206 http_response_object_declare_default_properties();
209 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
211 zend_class_entry
*ce
= http_response_object_ce
;
213 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
214 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
215 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
216 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
217 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
218 DCL_STATIC_PROP(PROTECTED
, long, stream
, 0);
219 DCL_STATIC_PROP_N(PROTECTED
, file
);
220 DCL_STATIC_PROP_N(PROTECTED
, data
);
221 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
222 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
223 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
224 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
225 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
226 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
227 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
228 DCL_STATIC_PROP_N(PROTECTED
, headers
);
231 /* ### USERLAND ### */
233 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
235 PHP_METHOD(HttpResponse
, setHeader
)
237 zend_bool replace
= 1;
240 zval
*value
= NULL
, *headers
, **header
;
242 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
246 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
250 headers
= GET_STATIC_PROP(headers
);
252 if (Z_TYPE_P(headers
) != IS_ARRAY
) {
253 convert_to_array(headers
);
256 /* delete header if value == null */
257 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
258 RETURN_SUCCESS(zend_hash_del(Z_ARRVAL_P(headers
), name
, name_len
+ 1));
261 if (Z_TYPE_P(value
) != IS_STRING
) {
262 convert_to_string_ex(&value
);
265 /* convert old header to an array and add new one if header exists and replace == false */
266 if (replace
|| (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(headers
), name
, name_len
+ 1, (void **) &header
))) {
267 RETURN_SUCCESS(add_assoc_stringl_ex(headers
, name
, name_len
+ 1, Z_STRVAL_P(value
), Z_STRLEN_P(value
), 1));
269 convert_to_array(*header
);
270 RETURN_SUCCESS(add_next_index_stringl(*header
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), 1));
275 /* {{{ proto static mixed HttpResponse::getHeader([string name])
277 PHP_METHOD(HttpResponse
, getHeader
)
281 zval
*headers
, **header
;
283 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
287 headers
= GET_STATIC_PROP(headers
);
288 if (Z_TYPE_P(headers
) != IS_ARRAY
) {
289 convert_to_array(headers
);
292 if (!name
|| !name_len
) {
293 array_init(return_value
);
294 array_copy(headers
, return_value
);
295 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(headers
), name
, name_len
+ 1, (void **) &header
)) {
296 RETURN_ZVAL(*header
, ZVAL_PTR_DTOR
, 1);
303 /* {{{ proto static bool HttpResponse::setCache(bool cache)
305 * Whether it sould be attempted to cache the entitity.
306 * This will result in necessary caching headers and checks of clients
307 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
308 * matches a "304 Not Modified" status code will be issued.
310 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
311 * to something more appropriate than "no-cache"!
313 PHP_METHOD(HttpResponse
, setCache
)
315 zend_bool do_cache
= 0;
317 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
321 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
325 /* {{{ proto static bool HttpResponse::getCache()
327 * Get current caching setting.
329 PHP_METHOD(HttpResponse
, getCache
)
334 RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(cache
)));
339 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
341 * Enable on-thy-fly gzipping of the sent entity.
343 PHP_METHOD(HttpResponse
, setGzip
)
345 zend_bool do_gzip
= 0;
347 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
351 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
355 /* {{{ proto static bool HttpResponse::getGzip()
357 * Get current gzipping setting.
359 PHP_METHOD(HttpResponse
, getGzip
)
364 RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(gzip
)));
369 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0])
371 * Set a custom cache-control header, usually being "private" or "public";
372 * The max_age parameter controls how long the cache entry is valid on the client side.
374 PHP_METHOD(HttpResponse
, setCacheControl
)
376 char *ccontrol
, *cctl
;
380 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
384 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
385 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
388 spprintf(&cctl
, 0, "%s, must-revalidate, max_age=%ld", ccontrol
, max_age
);
389 RETVAL_SUCCESS(UPD_STATIC_PROP(string
, cacheControl
, cctl
));
395 /* {{{ proto static string HttpResponse::getCacheControl()
397 * Get current Cache-Control header setting.
399 PHP_METHOD(HttpResponse
, getCacheControl
)
404 zval
*ccontrol
= GET_STATIC_PROP(cacheControl
);
405 RETURN_STRINGL(Z_STRVAL_P(ccontrol
), Z_STRLEN_P(ccontrol
), 1);
410 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
412 * Set the content-type of the sent entity.
414 PHP_METHOD(HttpResponse
, setContentType
)
419 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
423 if (!strchr(ctype
, '/')) {
424 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype
);
428 RETURN_SUCCESS(UPD_STATIC_PROP(string
, contentType
, ctype
));
432 /* {{{ proto static string HttpResponse::getContentType()
434 * Get current Content-Type header setting.
436 PHP_METHOD(HttpResponse
, getContentType
)
441 zval
*ctype
= GET_STATIC_PROP(contentType
);
442 RETURN_STRINGL(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
447 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
449 * Set the Content-Disposition of the sent entity. This setting aims to suggest
450 * the receiveing user agent how to handle the sent entity; usually the client
451 * will show the user a "Save As..." popup.
453 PHP_METHOD(HttpResponse
, setContentDisposition
)
457 zend_bool send_inline
= 0;
459 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
463 spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
464 RETVAL_SUCCESS(UPD_STATIC_PROP(string
, contentDisposition
, cd
));
469 /* {{{ proto static string HttpResponse::getContentDisposition()
471 * Get current Content-Disposition setting.
473 PHP_METHOD(HttpResponse
, getContentDisposition
)
478 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
479 RETURN_STRINGL(Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1);
484 /* {{{ proto static bool HttpResponse::setETag(string etag)
486 * Set a custom ETag. Use this only if you know what you're doing.
488 PHP_METHOD(HttpResponse
, setETag
)
493 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
497 RETURN_SUCCESS(UPD_STATIC_PROP(string
, eTag
, etag
));
501 /* {{{ proto static string HttpResponse::getETag()
503 * Get calculated or previously set custom ETag.
505 PHP_METHOD(HttpResponse
, getETag
)
510 zval
*etag
= GET_STATIC_PROP(eTag
);
511 RETURN_STRINGL(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), 1);
516 /* {{{ proto static bool HttpResponse::setLastModified(long timestamp)
518 * Set a custom Last-Modified date.
520 PHP_METHOD(HttpResponse
, setLastModified
)
524 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
528 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
532 /* {{{ proto static HttpResponse::getLastModified()
534 * Get calculated or previously set custom Last-Modified date.
536 PHP_METHOD(HttpResponse
, getLastModified
)
541 RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(lastModified
)));
546 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
549 PHP_METHOD(HttpResponse
, setThrottleDelay
)
553 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
556 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
560 /* {{{ proto static double HttpResponse::getThrottleDelay()
563 PHP_METHOD(HttpResponse
, getThrottleDelay
)
568 RETURN_DOUBLE(Z_DVAL_P(GET_STATIC_PROP(throttleDelay
)));
573 /* {{{ proto static bool HttpResponse::setBufferSize(long bytes)
576 PHP_METHOD(HttpResponse
, setBufferSize
)
580 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
583 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
587 /* {{{ proto static long HttpResponse::getBufferSize()
590 PHP_METHOD(HttpResponse
, getBufferSize
)
595 RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(bufferSize
)));
600 /* {{{ proto static bool HttpResponse::setData(string data)
602 * Set the data to be sent.
604 PHP_METHOD(HttpResponse
, setData
)
608 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
611 if (Z_TYPE_P(the_data
) != IS_STRING
) {
612 convert_to_string_ex(&the_data
);
615 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
616 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
620 if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified
)) > 0)) {
621 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
623 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
624 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
625 UPD_STATIC_PROP(string
, eTag
, etag
);
633 /* {{{ proto static string HttpResponse::getData()
635 * Get the previously set data to be sent.
637 PHP_METHOD(HttpResponse
, getData
)
642 zval
*the_data
= GET_STATIC_PROP(data
);
643 RETURN_STRINGL(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), 1);
648 /* {{{ proto static bool HttpResponse::setStream(resource stream)
650 * Set the resource to be sent.
652 PHP_METHOD(HttpResponse
, setStream
)
655 php_stream
*the_real_stream
;
657 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
660 zend_list_addref(Z_LVAL_P(the_stream
));
661 php_stream_from_zval(the_real_stream
, &the_stream
);
663 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
664 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
668 if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified
)) > 0)) {
669 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
671 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
672 char *etag
= http_etag(the_real_stream
, 0, SEND_RSRC
);
673 UPD_STATIC_PROP(string
, eTag
, etag
);
681 /* {{{ proto static resource HttpResponse::getStream()
683 * Get the previously set resource to be sent.
685 PHP_METHOD(HttpResponse
, getStream
)
690 RETURN_RESOURCE(Z_LVAL_P(GET_STATIC_PROP(stream
)));
695 /* {{{ proto static bool HttpResponse::setFile(string file)
697 * Set the file to be sent.
699 PHP_METHOD(HttpResponse
, setFile
)
704 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
708 if ( (SUCCESS
!= UPD_STATIC_PROP(string
, file
, the_file
)) ||
709 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
713 if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified
)))) {
714 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
716 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
717 char *etag
= http_etag(the_file
, 0, -1);
718 UPD_STATIC_PROP(string
, eTag
, etag
);
726 /* {{{ proto static string HttpResponse::getFile()
728 * Get the previously set file to be sent.
730 PHP_METHOD(HttpResponse
, getFile
)
735 zval
*the_file
= GET_STATIC_PROP(file
);
736 RETURN_STRINGL(Z_STRVAL_P(the_file
), Z_STRLEN_P(the_file
), 1);
741 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
743 * Finally send the entity.
748 * HttpResponse::setCache(true);
749 * HttpResponse::setContentType('application/pdf');
750 * HttpResponse::setContentDisposition("$user.pdf", false);
751 * HttpResponse::setFile('sheet.pdf');
752 * HttpResponse::send();
756 PHP_METHOD(HttpResponse
, send
)
758 zval
*sent
, *headers
;
759 zend_bool clean_ob
= 1;
761 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
764 if (SG(headers_sent
)) {
765 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, headers have already been sent");
769 sent
= GET_STATIC_PROP(sent
);
770 if (Z_LVAL_P(sent
)) {
771 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
778 if (Z_BVAL_P(GET_STATIC_PROP(catch))) {
781 INIT_PZVAL(&the_data
);
782 php_ob_get_buffer(&the_data TSRMLS_CC
);
783 SET_STATIC_PROP(data
, &the_data
);
784 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
786 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
787 char *etag
= http_etag(Z_STRVAL(the_data
), Z_STRLEN(the_data
), SEND_DATA
);
788 UPD_STATIC_PROP(string
, eTag
, etag
);
791 zval_dtor(&the_data
);
797 /* interrupt on-the-fly etag generation */
798 HTTP_G(etag
).started
= 0;
799 /* discard previous output buffers */
800 php_end_ob_buffers(0 TSRMLS_CC
);
804 headers
= GET_STATIC_PROP(headers
);
805 if (Z_TYPE_P(headers
) == IS_ARRAY
) {
810 FOREACH_KEYVAL(headers
, name
, idx
, value
) {
812 if (Z_TYPE_PP(value
) == IS_ARRAY
) {
816 FOREACH_VAL(*value
, data
) {
817 http_send_header_ex(name
, strlen(name
), Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), first
, NULL
);
821 http_send_header_ex(name
, strlen(name
), Z_STRVAL_PP(value
), Z_STRLEN_PP(value
), 1, NULL
);
829 if (Z_LVAL_P(GET_STATIC_PROP(gzip
))) {
830 php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC
);
832 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
836 if (Z_LVAL_P(GET_STATIC_PROP(cache
))) {
837 zval
*cctl
, *etag
, *lmod
;
839 etag
= GET_STATIC_PROP(eTag
);
840 lmod
= GET_STATIC_PROP(lastModified
);
841 cctl
= GET_STATIC_PROP(cacheControl
);
843 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
844 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
));
849 zval
*ctype
= GET_STATIC_PROP(contentType
);
850 if (Z_STRLEN_P(ctype
)) {
851 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
853 char *ctypes
= INI_STR("default_mimetype");
854 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
857 http_send_content_type(ctypes
, ctlen
);
859 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
864 /* content disposition */
866 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
867 if (Z_STRLEN_P(cd
)) {
868 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
874 HTTP_G(send
).buffer_size
= Z_LVAL_P(GET_STATIC_PROP(bufferSize
));
875 HTTP_G(send
).throttle_delay
= Z_DVAL_P(GET_STATIC_PROP(throttleDelay
));
880 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
884 zval
*zdata
= GET_STATIC_PROP(data
);
885 RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
890 php_stream
*the_real_stream
;
891 zval
*the_stream
= GET_STATIC_PROP(stream
);
892 the_stream
->type
= IS_RESOURCE
;
893 php_stream_from_zval(the_real_stream
, &the_stream
);
894 RETURN_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
899 RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(GET_STATIC_PROP(file
)), 1));
906 /* {{{ proto static void HttpResponse::capture()
908 * Capture script output.
913 * HttpResponse::setCache(true);
914 * HttpResponse::capture();
916 * // note that you need to call
917 * HttpResponse::send();
918 * // at the end of the script unless
919 * // you use PHP-5.1 or greater
923 PHP_METHOD(HttpResponse
, capture
)
929 INIT_PZVAL(&do_catch
);
930 ZVAL_LONG(&do_catch
, 1);
932 SET_STATIC_PROP(catch, &do_catch
);
934 php_end_ob_buffers(0 TSRMLS_CC
);
935 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
937 #if (PHP_MAJOR_VERSION > 5) || (PHP_MINOR_VERSION > 0)
938 /* register shutdown function --
939 messing around with ob and headers only works in PHP-5.1 or greater */
941 zval func
, retval
, arg
, *argp
[1];
946 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
949 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
950 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
952 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
959 #endif /* ZEND_ENGINE_2 */
966 * vim600: noet sw=4 ts=4 fdm=marker
967 * vim<600: noet sw=4 ts=4