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"
39 #include "php_http_headers_api.h"
41 #ifdef HTTP_HAVE_MHASH
44 #ifdef HTTP_HAVE_MAGIC
48 ZEND_EXTERN_MODULE_GLOBALS(http
);
50 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
51 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
52 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
53 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
55 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
56 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
57 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
58 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
60 HTTP_BEGIN_ARGS(setHeader
, 2)
62 HTTP_ARG_VAL(value
, 0)
63 HTTP_ARG_VAL(replace
, 0)
66 HTTP_BEGIN_ARGS(getHeader
, 0)
70 HTTP_EMPTY_ARGS(getETag
, 0);
71 HTTP_BEGIN_ARGS(setETag
, 1)
75 HTTP_EMPTY_ARGS(getLastModified
, 0);
76 HTTP_BEGIN_ARGS(setLastModified
, 1)
77 HTTP_ARG_VAL(timestamp
, 0)
80 HTTP_EMPTY_ARGS(getCache
, 0);
81 HTTP_BEGIN_ARGS(setCache
, 1)
82 HTTP_ARG_VAL(cache
, 0)
85 HTTP_EMPTY_ARGS(getGzip
, 0);
86 HTTP_BEGIN_ARGS(setGzip
, 1)
90 HTTP_EMPTY_ARGS(getCacheControl
, 0);
91 HTTP_BEGIN_ARGS(setCacheControl
, 1)
92 HTTP_ARG_VAL(cache_control
, 0)
93 HTTP_ARG_VAL(max_age
, 0)
96 HTTP_EMPTY_ARGS(getContentType
, 0);
97 HTTP_BEGIN_ARGS(setContentType
, 1)
98 HTTP_ARG_VAL(content_type
, 0)
101 HTTP_BEGIN_ARGS(guessContentType
, 1)
102 HTTP_ARG_VAL(magic_file
, 0)
103 HTTP_ARG_VAL(magic_mode
, 0)
106 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
107 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
108 HTTP_ARG_VAL(filename
, 0)
109 HTTP_ARG_VAL(send_inline
, 0)
112 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
113 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
114 HTTP_ARG_VAL(seconds
, 0)
117 HTTP_EMPTY_ARGS(getBufferSize
, 0);
118 HTTP_BEGIN_ARGS(setBufferSize
, 1)
119 HTTP_ARG_VAL(bytes
, 0)
122 HTTP_EMPTY_ARGS(getData
, 0);
123 HTTP_BEGIN_ARGS(setData
, 1)
124 HTTP_ARG_VAL(data
, 0)
127 HTTP_EMPTY_ARGS(getStream
, 0);
128 HTTP_BEGIN_ARGS(setStream
, 1)
129 HTTP_ARG_VAL(stream
, 0)
132 HTTP_EMPTY_ARGS(getFile
, 0);
133 HTTP_BEGIN_ARGS(setFile
, 1)
134 HTTP_ARG_VAL(filepath
, 0)
137 HTTP_BEGIN_ARGS(send
, 0)
138 HTTP_ARG_VAL(clean_ob
, 0)
141 HTTP_EMPTY_ARGS(capture
, 0);
143 HTTP_BEGIN_ARGS(redirect
, 0)
145 HTTP_ARG_VAL(params
, 0)
146 HTTP_ARG_VAL(session
, 0)
147 HTTP_ARG_VAL(permanent
, 0)
150 HTTP_BEGIN_ARGS(status
, 1)
151 HTTP_ARG_VAL(code
, 0)
154 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
155 HTTP_EMPTY_ARGS(getRequestBody
, 0);
157 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
158 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
159 #define http_grab_response_headers _http_grab_response_headers
160 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
162 zend_class_entry
*http_response_object_ce
;
163 zend_function_entry http_response_object_fe
[] = {
165 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
178 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
182 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
185 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
188 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
191 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
194 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
197 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
198 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
200 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
201 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
203 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
204 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
206 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
207 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
209 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
210 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
211 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
212 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
217 void _http_response_object_init(INIT_FUNC_ARGS
)
219 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
220 http_response_object_declare_default_properties();
223 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
225 zend_class_entry
*ce
= http_response_object_ce
;
227 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
228 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
229 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
230 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
231 DCL_STATIC_PROP_N(PRIVATE
, file
);
232 DCL_STATIC_PROP_N(PRIVATE
, data
);
233 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
234 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
235 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
236 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
237 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
238 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
239 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
240 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
241 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
244 DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5
);
245 DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1
);
246 DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32
);
248 # ifdef HTTP_HAVE_MHASH
250 int l
, i
, c
= mhash_count();
252 for (i
= 0; i
<= c
; ++i
) {
253 char const_name
[256] = {0};
254 const char *hash_name
= mhash_get_hash_name_static(i
);
257 l
= snprintf(const_name
, 255, "ETAG_MHASH_%s", hash_name
);
258 zend_declare_class_constant_long(ce
, const_name
, l
, i TSRMLS_CC
);
262 # endif /* HTTP_HAVE_MHASH */
266 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
268 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
269 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
272 /* ### USERLAND ### */
274 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
276 PHP_METHOD(HttpResponse
, setHeader
)
278 zend_bool replace
= 1;
283 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
286 if (SG(headers_sent
)) {
287 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
291 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
295 /* delete header if value == null */
296 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
297 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
299 /* send multiple header if replace is false and value is an array */
300 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
303 FOREACH_VAL(value
, data
) {
304 convert_to_string_ex(data
);
305 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
311 /* send standard header */
312 if (Z_TYPE_P(value
) != IS_STRING
) {
313 convert_to_string_ex(&value
);
315 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
319 /* {{{ proto static mixed HttpResponse::getHeader([string name])
321 PHP_METHOD(HttpResponse
, getHeader
)
327 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
331 phpstr_init(&headers
);
332 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
333 phpstr_fix(&headers
);
335 if (name
&& name_len
) {
337 HashTable headers_ht
;
339 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
340 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
341 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
342 RETVAL_ZVAL(*header
, 1, 0);
346 zend_hash_destroy(&headers_ht
);
348 array_init(return_value
);
349 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
352 phpstr_dtor(&headers
);
356 /* {{{ proto static bool HttpResponse::setCache(bool cache)
358 * Whether it sould be attempted to cache the entitity.
359 * This will result in necessary caching headers and checks of clients
360 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
361 * matches a "304 Not Modified" status code will be issued.
363 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
364 * to something more appropriate than "no-cache"!
366 PHP_METHOD(HttpResponse
, setCache
)
368 zend_bool do_cache
= 0;
370 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
374 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
378 /* {{{ proto static bool HttpResponse::getCache()
380 * Get current caching setting.
382 PHP_METHOD(HttpResponse
, getCache
)
387 zval
*cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
));
389 RETURN_ZVAL(cache
, 1, 0);
394 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
396 * Enable on-thy-fly gzipping of the sent entity.
398 PHP_METHOD(HttpResponse
, setGzip
)
400 zend_bool do_gzip
= 0;
402 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
406 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
410 /* {{{ proto static bool HttpResponse::getGzip()
412 * Get current gzipping setting.
414 PHP_METHOD(HttpResponse
, getGzip
)
419 zval
*gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
));
421 RETURN_ZVAL(gzip
, 1, 0);
426 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0])
428 * Set a custom cache-control header, usually being "private" or "public";
429 * The max_age parameter controls how long the cache entry is valid on the client side.
431 PHP_METHOD(HttpResponse
, setCacheControl
)
433 char *ccontrol
, *cctl
;
437 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
441 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
442 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
445 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max_age=%ld", ccontrol
, max_age
);
446 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
452 /* {{{ proto static string HttpResponse::getCacheControl()
454 * Get current Cache-Control header setting.
456 PHP_METHOD(HttpResponse
, getCacheControl
)
461 zval
*ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
));
463 RETURN_ZVAL(ccontrol
, 1, 0);
468 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
470 * Set the content-type of the sent entity.
472 PHP_METHOD(HttpResponse
, setContentType
)
477 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
481 if (!strchr(ctype
, '/')) {
482 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype
);
486 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
490 /* {{{ proto static string HttpResponse::getContentType()
492 * Get current Content-Type header setting.
494 PHP_METHOD(HttpResponse
, getContentType
)
499 zval
*ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
));
501 RETURN_ZVAL(ctype
, 1, 0);
506 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, long magic_mode = MAGIC_MIME])
508 * Attempts to guess the content type of supplied payload through libmagic.
510 PHP_METHOD(HttpResponse
, guessContentType
)
512 char *magic_file
, *ct
= NULL
;
518 #ifdef HTTP_HAVE_MAGIC
519 magic_mode
= MAGIC_MIME
;
522 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
523 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
526 zval
*data
= GET_STATIC_PROP(data
);
527 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
534 zval
*z
= GET_STATIC_PROP(stream
);
535 z
->type
= IS_RESOURCE
;
536 php_stream_from_zval(s
, &z
);
537 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
542 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
546 UPD_STATIC_PROP(string
, contentType
, ct
);
547 RETVAL_STRING(ct
, 0);
552 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
557 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
559 * Set the Content-Disposition of the sent entity. This setting aims to suggest
560 * the receiveing user agent how to handle the sent entity; usually the client
561 * will show the user a "Save As..." popup.
563 PHP_METHOD(HttpResponse
, setContentDisposition
)
568 zend_bool send_inline
= 0;
570 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
574 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
575 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
580 /* {{{ proto static string HttpResponse::getContentDisposition()
582 * Get current Content-Disposition setting.
584 PHP_METHOD(HttpResponse
, getContentDisposition
)
589 zval
*cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
));
591 RETURN_ZVAL(cd
, 1, 0);
596 /* {{{ proto static bool HttpResponse::setETag(string etag)
598 * Set a custom ETag. Use this only if you know what you're doing.
600 PHP_METHOD(HttpResponse
, setETag
)
605 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
609 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
613 /* {{{ proto static string HttpResponse::getETag()
615 * Get calculated or previously set custom ETag.
617 PHP_METHOD(HttpResponse
, getETag
)
622 zval
*etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
));
624 RETURN_ZVAL(etag
, 1, 0);
629 /* {{{ proto static bool HttpResponse::setLastModified(long timestamp)
631 * Set a custom Last-Modified date.
633 PHP_METHOD(HttpResponse
, setLastModified
)
637 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
641 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
645 /* {{{ proto static HttpResponse::getLastModified()
647 * Get calculated or previously set custom Last-Modified date.
649 PHP_METHOD(HttpResponse
, getLastModified
)
654 zval
*lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
));
656 RETURN_ZVAL(lm
, 1, 0);
661 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
664 PHP_METHOD(HttpResponse
, setThrottleDelay
)
668 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
671 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
675 /* {{{ proto static double HttpResponse::getThrottleDelay()
678 PHP_METHOD(HttpResponse
, getThrottleDelay
)
683 zval
*delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
));
685 RETURN_ZVAL(delay
, 1, 0);
690 /* {{{ proto static bool HttpResponse::setBufferSize(long bytes)
693 PHP_METHOD(HttpResponse
, setBufferSize
)
697 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
700 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
704 /* {{{ proto static long HttpResponse::getBufferSize()
707 PHP_METHOD(HttpResponse
, getBufferSize
)
712 zval
*size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
));
714 RETURN_ZVAL(size
, 1, 0);
719 /* {{{ proto static bool HttpResponse::setData(string data)
721 * Set the data to be sent.
723 PHP_METHOD(HttpResponse
, setData
)
727 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
730 if (Z_TYPE_P(the_data
) != IS_STRING
) {
731 convert_to_string_ex(&the_data
);
734 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
735 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
739 if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
))) > 0)) {
740 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
742 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
743 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
745 UPD_STATIC_PROP(string
, eTag
, etag
);
754 /* {{{ proto static string HttpResponse::getData()
756 * Get the previously set data to be sent.
758 PHP_METHOD(HttpResponse
, getData
)
763 zval
*the_data
= GET_STATIC_PROP(data
);
765 RETURN_ZVAL(the_data
, 1, 0);
770 /* {{{ proto static bool HttpResponse::setStream(resource stream)
772 * Set the resource to be sent.
774 PHP_METHOD(HttpResponse
, setStream
)
777 php_stream
*the_real_stream
;
778 php_stream_statbuf ssb
;
780 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
784 php_stream_from_zval(the_real_stream
, &the_stream
);
785 if (php_stream_stat(the_real_stream
, &ssb
)) {
789 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
790 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
793 zend_list_addref(Z_LVAL_P(the_stream
));
795 if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
))) > 0)) {
796 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
798 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
799 char *etag
= http_etag(the_real_stream
, 0, SEND_RSRC
);
801 UPD_STATIC_PROP(string
, eTag
, etag
);
810 /* {{{ proto static resource HttpResponse::getStream()
812 * Get the previously set resource to be sent.
814 PHP_METHOD(HttpResponse
, getStream
)
819 RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
))));
824 /* {{{ proto static bool HttpResponse::setFile(string file)
826 * Set the file to be sent.
828 PHP_METHOD(HttpResponse
, setFile
)
832 php_stream_statbuf ssb
;
834 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
838 if (php_stream_stat_path(the_file
, &ssb
)) {
842 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
843 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
847 if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
))) > 0)) {
848 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
850 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
851 char *etag
= http_etag(the_file
, 0, -1);
853 UPD_STATIC_PROP(string
, eTag
, etag
);
862 /* {{{ proto static string HttpResponse::getFile()
864 * Get the previously set file to be sent.
866 PHP_METHOD(HttpResponse
, getFile
)
871 zval
*the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
));
873 RETURN_ZVAL(the_file
, 1, 0);
878 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
880 * Finally send the entity.
885 * HttpResponse::setCache(true);
886 * HttpResponse::setContentType('application/pdf');
887 * HttpResponse::setContentDisposition("$user.pdf", false);
888 * HttpResponse::setFile('sheet.pdf');
889 * HttpResponse::send();
893 PHP_METHOD(HttpResponse
, send
)
896 zend_bool clean_ob
= 1;
898 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
901 if (SG(headers_sent
)) {
902 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, headers have already been sent");
906 sent
= GET_STATIC_PROP(sent
);
907 if (zval_is_true(sent
)) {
908 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
915 if (zval_is_true(GET_STATIC_PROP(catch))) {
918 MAKE_STD_ZVAL(the_data
);
919 php_ob_get_buffer(the_data TSRMLS_CC
);
920 SET_STATIC_PROP(data
, the_data
);
921 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
923 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
924 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
926 UPD_STATIC_PROP(string
, eTag
, etag
);
930 zval_ptr_dtor(&the_data
);
936 /* interrupt on-the-fly etag generation */
937 HTTP_G(etag
).started
= 0;
938 /* discard previous output buffers */
939 php_end_ob_buffers(0 TSRMLS_CC
);
943 if (zval_is_true(GET_STATIC_PROP(gzip
))) {
944 php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC
);
946 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
950 if (zval_is_true(GET_STATIC_PROP(cache
))) {
951 zval
*cctl
, *etag
, *lmod
;
953 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
));
954 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
));
955 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
));
957 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
958 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
));
963 zval
*ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
));
964 if (Z_STRLEN_P(ctype
)) {
965 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
967 char *ctypes
= INI_STR("default_mimetype");
968 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
971 http_send_content_type(ctypes
, ctlen
);
973 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
978 /* content disposition */
980 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
981 if (Z_STRLEN_P(cd
)) {
982 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
988 HTTP_G(send
).buffer_size
= Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
)));
989 HTTP_G(send
).throttle_delay
= Z_DVAL_P(convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
)));
994 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
998 zval
*zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
));
999 RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1004 php_stream
*the_real_stream
;
1005 zval
*the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
));
1006 the_stream
->type
= IS_RESOURCE
;
1007 php_stream_from_zval(the_real_stream
, &the_stream
);
1008 RETURN_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1013 RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
))), 1));
1020 /* {{{ proto static void HttpResponse::capture()
1022 * Capture script output.
1027 * HttpResponse::setCache(true);
1028 * HttpResponse::capture();
1033 PHP_METHOD(HttpResponse
, capture
)
1037 UPD_STATIC_PROP(long, catch, 1);
1039 php_end_ob_buffers(0 TSRMLS_CC
);
1040 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
1042 /* register shutdown function */
1044 zval func
, retval
, arg
, *argp
[1];
1048 INIT_PZVAL(&retval
);
1049 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1052 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1053 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1055 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1061 #endif /* ZEND_ENGINE_2 && !WONKY */
1068 * vim600: noet sw=4 ts=4 fdm=marker
1069 * vim<600: noet sw=4 ts=4