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 +----------------------------------------------------------------------+
30 #include "php_http_api.h"
31 #include "php_http_std_defs.h"
32 #include "php_http_response_object.h"
33 #include "php_http_exception_object.h"
34 #include "php_http_send_api.h"
35 #include "php_http_cache_api.h"
39 ZEND_EXTERN_MODULE_GLOBALS(http
);
41 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
42 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
43 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
45 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
46 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
47 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
48 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
50 HTTP_BEGIN_ARGS(setHeader
, 2)
52 HTTP_ARG_VAL(value
, 0)
53 HTTP_ARG_VAL(replace
, 0)
56 HTTP_BEGIN_ARGS(getHeader
, 0)
60 HTTP_EMPTY_ARGS(getETag
, 0);
61 HTTP_BEGIN_ARGS(setETag
, 1)
65 HTTP_EMTPY_ARGS(getLastModified
, 0);
66 HTTP_BEGIN_ARGS(setLastModified
, 1)
67 HTTP_ARG_VAL(timestamp
, 0)
70 HTTP_EMPTY_ARGS(getCache
, 0);
71 HTTP_BEGIN_ARGS(setCache
, 1)
72 HTTP_ARG_VAL(cache
, 0)
75 HTTP_EMPTY_ARGS(getGzip
, 0);
76 HTTP_BEGIN_ARGS(setGzip
, 1)
80 HTTP_EMPTY_ARGS(getCacheControl
, 0);
81 HTTP_BEGIN_ARGS(setCacheControl
, 1)
82 HTTP_ARG_VAL(cache_control
, 0)
83 HTTP_ARG_VAL(max_age
, 0)
86 HTTP_EMPTY_ARGS(getContentType
, 0);
87 HTTP_BEGIN_ARGS(setContentType
, 1)
88 HTTP_ARG_VAL(content_type
, 0)
91 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
92 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
93 HTTP_ARG_VAL(filename
, 0)
94 HTTP_ARG_VAL(send_inline
, 0)
97 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
98 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
99 HTTP_ARG_VAL(seconds
, 0)
102 HTTP_EMPTY_ARGS(getBufferSize
, 0);
103 HTTP_BEGIN_ARGS(setBufferSize
, 1)
104 HTTP_ARG_VAL(bytes
, 0)
107 HTTP_EMPTY_ARGS(getData
, 0);
108 HTTP_BEGIN_ARGS(setData
, 1)
109 HTTP_ARG_VAL(data
, 0)
112 HTTP_EMPTY_ARGS(getStream
, 0);
113 HTTP_BEGIN_ARGS(setStream
, 1)
114 HTTP_ARG_VAL(stream
, 0)
117 HTTP_EMPTY_ARGS(getFile
, 0);
118 HTTP_BEGIN_ARGS(setFile
, 1)
119 HTTP_ARG_VAL(filepath
, 0)
122 HTTP_BEGIN_ARGS(send
, 0)
123 HTTP_ARG_VAL(clean_ob
, 0)
126 HTTP_EMPTY_ARGS(capture
, 0);
128 HTTP_BEGIN_ARGS(redirect
, 0)
130 HTTP_ARG_VAL(params
, 0)
131 HTTP_ARG_VAL(session
, 0)
132 HTTP_ARG_VAL(permanent
, 0)
135 HTTP_BEGIN_ARGS(status
, 1)
136 HTTP_ARG_VAL(code
, 0)
139 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
140 HTTP_EMPTY_ARGS(getRequestBody
, 0);
142 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
143 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
145 HashTable http_response_statics
;
147 zend_class_entry
*http_response_object_ce
;
148 zend_function_entry http_response_object_fe
[] = {
150 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
151 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
153 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
154 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
156 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
157 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
159 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
162 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
178 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
181 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
184 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
187 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
190 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
193 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
194 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
195 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
200 void _http_response_object_init(INIT_FUNC_ARGS
)
202 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
203 http_response_object_declare_default_properties();
206 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
208 zend_class_entry
*ce
= http_response_object_ce
;
210 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
211 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
212 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
213 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
214 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
215 DCL_STATIC_PROP(PROTECTED
, long, stream
, 0);
216 DCL_STATIC_PROP_N(PROTECTED
, file
);
217 DCL_STATIC_PROP_N(PROTECTED
, data
);
218 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
219 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
220 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
221 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
222 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
223 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
224 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
225 DCL_STATIC_PROP_N(PROTECTED
, headers
);
228 /* ### USERLAND ### */
230 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
232 PHP_METHOD(HttpResponse
, setHeader
)
234 zend_bool replace
= 1;
237 zval
*value
= NULL
, *headers
, **header
;
239 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
243 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
247 headers
= GET_STATIC_PROP(headers
);
249 if (Z_TYPE_P(headers
) != IS_ARRAY
) {
250 convert_to_array(headers
);
253 /* delete header if value == null */
254 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
255 RETURN_SUCCESS(zend_hash_del(Z_ARRVAL_P(headers
), name
, name_len
+ 1));
258 if (Z_TYPE_P(value
) != IS_STRING
) {
259 convert_to_string_ex(&value
);
262 /* convert old header to an array and add new one if header exists and replace == false */
263 if (replace
|| (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(headers
), name
, name_len
+ 1, (void **) &header
))) {
264 RETURN_SUCCESS(add_assoc_stringl_ex(headers
, name
, name_len
+ 1, Z_STRVAL_P(value
), Z_STRLEN_P(value
), 1));
266 convert_to_array(*header
);
267 RETURN_SUCCESS(add_next_index_stringl(*header
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), 1));
272 /* {{{ proto static mixed HttpResponse::getHeader([string name])
274 PHP_METHOD(HttpResponse
, getHeader
)
278 zval
*headers
, **header
;
280 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
284 headers
= GET_STATIC_PROP(headers
);
285 if (Z_TYPE_P(headers
) != IS_ARRAY
) {
286 convert_to_array(headers
);
289 if (!name
|| !name_len
) {
290 array_init(return_value
);
291 array_copy(headers
, return_value
);
292 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(headers
), name
, name_len
+ 1, (void **) &header
)) {
293 RETURN_ZVAL(*header
, ZVAL_PTR_DTOR
, 1);
300 /* {{{ proto static bool HttpResponse::setCache(bool cache)
302 * Whether it sould be attempted to cache the entitity.
303 * This will result in necessary caching headers and checks of clients
304 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
305 * matches a "304 Not Modified" status code will be issued.
307 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
308 * to something more appropriate than "no-cache"!
310 PHP_METHOD(HttpResponse
, setCache
)
312 zend_bool do_cache
= 0;
314 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
318 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
322 /* {{{ proto static bool HttpResponse::getCache()
324 * Get current caching setting.
326 PHP_METHOD(HttpResponse
, getCache
)
331 RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(cache
)));
336 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
338 * Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET.
340 PHP_METHOD(HttpResponse
, setGzip
)
342 zend_bool do_gzip
= 0;
344 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
348 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
352 /* {{{ proto static bool HttpResponse::getGzip()
354 * Get current gzipping setting.
356 PHP_METHOD(HttpResponse
, getGzip
)
361 RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(gzip
)));
366 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0])
368 * Set a custom cache-control header, usually being "private" or "public";
369 * The max_age parameter controls how long the cache entry is valid on the client side.
371 PHP_METHOD(HttpResponse
, setCacheControl
)
373 char *ccontrol
, *cctl
;
377 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
381 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
382 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
385 spprintf(&cctl
, 0, "%s, must-revalidate, max_age=%ld", ccontrol
, max_age
);
386 RETVAL_SUCCESS(UPD_STATIC_PROP(string
, cacheControl
, cctl
));
392 /* {{{ proto static string HttpResponse::getCacheControl()
394 * Get current Cache-Control header setting.
396 PHP_METHOD(HttpResponse
, getCacheControl
)
401 zval
*ccontrol
= GET_STATIC_PROP(cacheControl
);
402 RETURN_STRINGL(Z_STRVAL_P(ccontrol
), Z_STRLEN_P(ccontrol
), 1);
407 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
409 * Set the content-type of the sent entity.
411 PHP_METHOD(HttpResponse
, setContentType
)
416 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
420 if (!strchr(ctype
, '/')) {
421 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype
);
425 RETURN_SUCCESS(UPD_STATIC_PROP(string
, contentType
, ctype
));
429 /* {{{ proto static string HttpResponse::getContentType()
431 * Get current Content-Type header setting.
433 PHP_METHOD(HttpResponse
, getContentType
)
438 zval
*ctype
= GET_STATIC_PROP(contentType
);
439 RETURN_STRINGL(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
444 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
446 * Set the Content-Disposition of the sent entity. This setting aims to suggest
447 * the receiveing user agent how to handle the sent entity; usually the client
448 * will show the user a "Save As..." popup.
450 PHP_METHOD(HttpResponse
, setContentDisposition
)
454 zend_bool send_inline
= 0;
456 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
460 spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
461 RETVAL_SUCCESS(UPD_STATIC_PROP(string
, contentDisposition
, cd
));
466 /* {{{ proto static string HttpResponse::getContentDisposition()
468 * Get current Content-Disposition setting.
470 PHP_METHOD(HttpResponse
, getContentDisposition
)
475 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
476 RETURN_STRINGL(Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1);
481 /* {{{ proto static bool HttpResponse::setETag(string etag)
483 * Set a custom ETag. Use this only if you know what you're doing.
485 PHP_METHOD(HttpResponse
, setETag
)
490 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
494 RETURN_SUCCESS(UPD_STATIC_PROP(string
, eTag
, etag
));
498 /* {{{ proto static string HttpResponse::getETag()
500 * Get calculated or previously set custom ETag.
502 PHP_METHOD(HttpResponse
, getETag
)
507 zval
*etag
= GET_STATIC_PROP(eTag
);
508 RETURN_STRINGL(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), 1);
513 /* {{{ proto static bool HttpResponse::setLastModified(long timestamp)
515 * Set a custom Last-Modified date.
517 PHP_METHOD(HttpResponse
, setLastModified
)
521 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
525 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
529 /* {{{ proto static HttpResponse::getLastModified()
531 * Get calculated or previously set custom Last-Modified date.
533 PHP_METHOD(HttpResponse
, getLastModified
)
538 RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(lastModified
)));
543 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
546 PHP_METHOD(HttpResponse
, setThrottleDelay
)
550 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
553 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
557 /* {{{ proto static double HttpResponse::getThrottleDelay()
560 PHP_METHOD(HttpResponse
, getThrottleDelay
)
565 RETURN_DOUBLE(Z_DVAL_P(GET_STATIC_PROP(throttleDelay
)));
570 /* {{{ proto static bool HttpResponse::setBufferSize(long bytes)
573 PHP_METHOD(HttpResponse
, setBufferSize
)
577 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
580 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
584 /* {{{ proto static long HttpResponse::getBufferSize()
587 PHP_METHOD(HttpResponse
, getBufferSize
)
592 RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(bufferSize
)));
597 /* {{{ proto static bool HttpResponse::setData(string data)
599 * Set the data to be sent.
601 PHP_METHOD(HttpResponse
, setData
)
605 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
608 if (Z_TYPE_P(the_data
) != IS_STRING
) {
609 convert_to_string_ex(&the_data
);
612 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
613 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
617 if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified
)) > 0)) {
618 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
620 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
621 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
622 UPD_STATIC_PROP(string
, eTag
, etag
);
630 /* {{{ proto static string HttpResponse::getData()
632 * Get the previously set data to be sent.
634 PHP_METHOD(HttpResponse
, getData
)
639 zval
*the_data
= GET_STATIC_PROP(data
);
640 RETURN_STRINGL(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), 1);
645 /* {{{ proto static bool HttpResponse::setStream(resource stream)
647 * Set the resource to be sent.
649 PHP_METHOD(HttpResponse
, setStream
)
652 php_stream
*the_real_stream
;
654 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
657 zend_list_addref(Z_LVAL_P(the_stream
));
658 php_stream_from_zval(the_real_stream
, &the_stream
);
660 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
661 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
665 if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified
)) > 0)) {
666 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
668 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
669 char *etag
= http_etag(the_real_stream
, 0, SEND_RSRC
);
670 UPD_STATIC_PROP(string
, eTag
, etag
);
678 /* {{{ proto static resource HttpResponse::getStream()
680 * Get the previously set resource to be sent.
682 PHP_METHOD(HttpResponse
, getStream
)
687 RETURN_RESOURCE(Z_LVAL_P(GET_STATIC_PROP(stream
)));
692 /* {{{ proto static bool HttpResponse::setFile(string file)
694 * Set the file to be sent.
696 PHP_METHOD(HttpResponse
, setFile
)
701 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
705 if ( (SUCCESS
!= UPD_STATIC_PROP(string
, file
, the_file
)) ||
706 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
710 if (!(Z_LVAL_P(GET_STATIC_PROP(lastModified
)))) {
711 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
713 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
714 char *etag
= http_etag(the_file
, 0, -1);
715 UPD_STATIC_PROP(string
, eTag
, etag
);
723 /* {{{ proto static string HttpResponse::getFile()
725 * Get the previously set file to be sent.
727 PHP_METHOD(HttpResponse
, getFile
)
732 zval
*the_file
= GET_STATIC_PROP(file
);
733 RETURN_STRINGL(Z_STRVAL_P(the_file
), Z_STRLEN_P(the_file
), 1);
738 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
740 * Finally send the entity.
745 * HttpResponse::setCache(true);
746 * HttpResponse::setContentType('application/pdf');
747 * HttpResponse::setContentDisposition("$user.pdf", false);
748 * HttpResponse::setFile('sheet.pdf');
749 * HttpResponse::send();
753 PHP_METHOD(HttpResponse
, send
)
755 zval
*sent
, *headers
;
756 zend_bool clean_ob
= 1;
758 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
761 if (SG(headers_sent
)) {
762 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, headers have already been sent");
766 sent
= GET_STATIC_PROP(sent
);
767 if (Z_LVAL_P(sent
)) {
768 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
775 if (Z_BVAL_P(GET_STATIC_PROP(catch))) {
778 MAKE_STD_ZVAL(the_data
);
779 php_ob_get_buffer(the_data TSRMLS_CC
);
781 SET_STATIC_PROP(data
, the_data
);
782 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
784 if (!Z_STRLEN_P(GET_STATIC_PROP(eTag
))) {
785 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
786 UPD_STATIC_PROP(string
, eTag
, etag
);
794 /* interrupt on-the-fly etag generation */
795 HTTP_G(etag
).started
= 0;
796 /* discard previous output buffers */
797 php_end_ob_buffers(0 TSRMLS_CC
);
801 headers
= GET_STATIC_PROP(headers
);
802 if (Z_TYPE_P(headers
) == IS_ARRAY
) {
807 FOREACH_KEYVAL(headers
, name
, idx
, value
) {
809 if (Z_TYPE_PP(value
) == IS_ARRAY
) {
813 FOREACH_VAL(*value
, data
) {
814 http_send_header_ex(name
, strlen(name
), Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), first
);
818 http_send_header_ex(name
, strlen(name
), Z_STRVAL_PP(value
), Z_STRLEN_PP(value
), 1);
826 if (Z_LVAL_P(GET_STATIC_PROP(gzip
))) {
827 php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC
);
829 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
833 if (Z_LVAL_P(GET_STATIC_PROP(cache
))) {
834 zval
*cctl
, *etag
, *lmod
;
836 etag
= GET_STATIC_PROP(eTag
);
837 lmod
= GET_STATIC_PROP(lastModified
);
838 cctl
= GET_STATIC_PROP(cacheControl
);
840 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
841 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
));
846 zval
*ctype
= GET_STATIC_PROP(contentType
);
847 if (Z_STRLEN_P(ctype
)) {
848 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
850 char *ctypes
= INI_STR("default_mimetype");
851 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
854 http_send_content_type(ctypes
, ctlen
);
856 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
861 /* content disposition */
863 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
864 if (Z_STRLEN_P(cd
)) {
865 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1);
871 HTTP_G(send
).buffer_size
= Z_LVAL_P(GET_STATIC_PROP(bufferSize
));
872 HTTP_G(send
).throttle_delay
= Z_DVAL_P(GET_STATIC_PROP(throttleDelay
));
877 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
881 zval
*zdata
= GET_STATIC_PROP(data
);
882 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
887 php_stream
*the_real_stream
;
888 zval
*the_stream
= GET_STATIC_PROP(stream
);
889 the_stream
->type
= IS_RESOURCE
;
890 php_stream_from_zval(the_real_stream
, &the_stream
);
891 RETURN_SUCCESS(http_send_stream(the_real_stream
));
896 RETURN_SUCCESS(http_send_file(Z_STRVAL_P(GET_STATIC_PROP(file
))));
903 /* {{{ proto static void HttpResponse::capture()
905 * Capture script output.
910 * HttpResponse::setCache(true);
911 * HttpResponse::capture();
913 * // note that you need to call
914 * HttpResponse::send();
915 * // at the end of the script unless
916 * // you use PHP-5.1 or greater
920 PHP_METHOD(HttpResponse
, capture
)
926 MAKE_STD_ZVAL(do_catch
);
927 ZVAL_LONG(do_catch
, 1);
929 SET_STATIC_PROP(catch, do_catch
);
931 php_end_ob_buffers(0 TSRMLS_CC
);
932 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
934 #if (PHP_MAJOR_VERSION > 5) || (PHP_MINOR_VERSION > 0)
935 /* register shutdown function --
936 messing around with ob and headers only works in PHP-5.1 or greater */
938 zval func
, retval
, arg
, *argp
[1];
943 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
946 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
947 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
949 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
956 #endif /* ZEND_ENGINE_2 */
963 * vim600: noet sw=4 ts=4 fdm=marker
964 * vim<600: noet sw=4 ts=4