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
45 ZEND_EXTERN_MODULE_GLOBALS(http
);
47 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
48 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
49 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
50 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
52 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
53 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
54 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
55 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
57 HTTP_BEGIN_ARGS(setHeader
, 2)
59 HTTP_ARG_VAL(value
, 0)
60 HTTP_ARG_VAL(replace
, 0)
63 HTTP_BEGIN_ARGS(getHeader
, 0)
67 HTTP_EMPTY_ARGS(getETag
, 0);
68 HTTP_BEGIN_ARGS(setETag
, 1)
72 HTTP_EMPTY_ARGS(getLastModified
, 0);
73 HTTP_BEGIN_ARGS(setLastModified
, 1)
74 HTTP_ARG_VAL(timestamp
, 0)
77 HTTP_EMPTY_ARGS(getCache
, 0);
78 HTTP_BEGIN_ARGS(setCache
, 1)
79 HTTP_ARG_VAL(cache
, 0)
82 HTTP_EMPTY_ARGS(getGzip
, 0);
83 HTTP_BEGIN_ARGS(setGzip
, 1)
87 HTTP_EMPTY_ARGS(getCacheControl
, 0);
88 HTTP_BEGIN_ARGS(setCacheControl
, 1)
89 HTTP_ARG_VAL(cache_control
, 0)
90 HTTP_ARG_VAL(max_age
, 0)
93 HTTP_EMPTY_ARGS(getContentType
, 0);
94 HTTP_BEGIN_ARGS(setContentType
, 1)
95 HTTP_ARG_VAL(content_type
, 0)
98 HTTP_BEGIN_ARGS(guessContentType
, 1)
99 HTTP_ARG_VAL(magic_file
, 0)
100 HTTP_ARG_VAL(magic_mode
, 0)
103 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
104 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
105 HTTP_ARG_VAL(filename
, 0)
106 HTTP_ARG_VAL(send_inline
, 0)
109 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
110 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
111 HTTP_ARG_VAL(seconds
, 0)
114 HTTP_EMPTY_ARGS(getBufferSize
, 0);
115 HTTP_BEGIN_ARGS(setBufferSize
, 1)
116 HTTP_ARG_VAL(bytes
, 0)
119 HTTP_EMPTY_ARGS(getData
, 0);
120 HTTP_BEGIN_ARGS(setData
, 1)
121 HTTP_ARG_VAL(data
, 0)
124 HTTP_EMPTY_ARGS(getStream
, 0);
125 HTTP_BEGIN_ARGS(setStream
, 1)
126 HTTP_ARG_VAL(stream
, 0)
129 HTTP_EMPTY_ARGS(getFile
, 0);
130 HTTP_BEGIN_ARGS(setFile
, 1)
131 HTTP_ARG_VAL(filepath
, 0)
134 HTTP_BEGIN_ARGS(send
, 0)
135 HTTP_ARG_VAL(clean_ob
, 0)
138 HTTP_EMPTY_ARGS(capture
, 0);
140 HTTP_BEGIN_ARGS(redirect
, 0)
142 HTTP_ARG_VAL(params
, 0)
143 HTTP_ARG_VAL(session
, 0)
144 HTTP_ARG_VAL(permanent
, 0)
147 HTTP_BEGIN_ARGS(status
, 1)
148 HTTP_ARG_VAL(code
, 0)
151 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
152 HTTP_EMPTY_ARGS(getRequestBody
, 0);
154 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
155 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
156 #define http_grab_response_headers _http_grab_response_headers
157 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
159 zend_class_entry
*http_response_object_ce
;
160 zend_function_entry http_response_object_fe
[] = {
162 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
179 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
182 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
185 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
188 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
191 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
194 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
197 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
198 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
200 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
201 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
203 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
204 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
206 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
207 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
208 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
209 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
214 void _http_response_object_init(INIT_FUNC_ARGS
)
216 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
217 http_response_object_declare_default_properties();
220 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
222 zend_class_entry
*ce
= http_response_object_ce
;
224 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
225 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
226 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
227 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
228 DCL_STATIC_PROP_N(PRIVATE
, file
);
229 DCL_STATIC_PROP_N(PRIVATE
, data
);
230 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
231 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
232 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
233 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
234 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
235 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
236 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
237 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
238 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
241 DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5
);
242 DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1
);
243 DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32
);
245 # ifdef HTTP_HAVE_MHASH
247 int l
, i
, c
= mhash_count();
249 for (i
= 0; i
<= c
; ++i
) {
250 char const_name
[256] = {0};
251 const char *hash_name
= mhash_get_hash_name_static(i
);
254 l
= snprintf(const_name
, 255, "ETAG_MHASH_%s", hash_name
);
255 zend_declare_class_constant_long(ce
, const_name
, l
, i TSRMLS_CC
);
259 # endif /* HTTP_HAVE_MHASH */
263 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
265 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
266 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
269 /* ### USERLAND ### */
271 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
273 PHP_METHOD(HttpResponse
, setHeader
)
275 zend_bool replace
= 1;
280 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
283 if (SG(headers_sent
)) {
284 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
288 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
292 /* delete header if value == null */
293 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
294 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
296 /* send multiple header if replace is false and value is an array */
297 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
300 FOREACH_VAL(value
, data
) {
301 convert_to_string_ex(data
);
302 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
308 /* send standard header */
309 if (Z_TYPE_P(value
) != IS_STRING
) {
310 convert_to_string_ex(&value
);
312 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
316 /* {{{ proto static mixed HttpResponse::getHeader([string name])
318 PHP_METHOD(HttpResponse
, getHeader
)
324 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
328 phpstr_init(&headers
);
329 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
330 phpstr_fix(&headers
);
332 if (name
&& name_len
) {
334 HashTable headers_ht
;
336 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
337 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
338 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
339 RETVAL_ZVAL(*header
, 1, 0);
343 zend_hash_destroy(&headers_ht
);
345 array_init(return_value
);
346 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
349 phpstr_dtor(&headers
);
353 /* {{{ proto static bool HttpResponse::setCache(bool cache)
355 * Whether it sould be attempted to cache the entitity.
356 * This will result in necessary caching headers and checks of clients
357 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
358 * matches a "304 Not Modified" status code will be issued.
360 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
361 * to something more appropriate than "no-cache"!
363 PHP_METHOD(HttpResponse
, setCache
)
365 zend_bool do_cache
= 0;
367 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
371 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
375 /* {{{ proto static bool HttpResponse::getCache()
377 * Get current caching setting.
379 PHP_METHOD(HttpResponse
, getCache
)
384 zval
*cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
));
386 RETURN_ZVAL(cache
, 1, 0);
391 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
393 * Enable on-thy-fly gzipping of the sent entity.
395 PHP_METHOD(HttpResponse
, setGzip
)
397 zend_bool do_gzip
= 0;
399 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
403 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
407 /* {{{ proto static bool HttpResponse::getGzip()
409 * Get current gzipping setting.
411 PHP_METHOD(HttpResponse
, getGzip
)
416 zval
*gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
));
418 RETURN_ZVAL(gzip
, 1, 0);
423 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0])
425 * Set a custom cache-control header, usually being "private" or "public";
426 * The max_age parameter controls how long the cache entry is valid on the client side.
428 PHP_METHOD(HttpResponse
, setCacheControl
)
430 char *ccontrol
, *cctl
;
434 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
438 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
439 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
442 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max_age=%ld", ccontrol
, max_age
);
443 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
449 /* {{{ proto static string HttpResponse::getCacheControl()
451 * Get current Cache-Control header setting.
453 PHP_METHOD(HttpResponse
, getCacheControl
)
458 zval
*ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
));
460 RETURN_ZVAL(ccontrol
, 1, 0);
465 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
467 * Set the content-type of the sent entity.
469 PHP_METHOD(HttpResponse
, setContentType
)
474 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
478 if (!strchr(ctype
, '/')) {
479 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype
);
483 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
487 /* {{{ proto static string HttpResponse::getContentType()
489 * Get current Content-Type header setting.
491 PHP_METHOD(HttpResponse
, getContentType
)
496 zval
*ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
));
498 RETURN_ZVAL(ctype
, 1, 0);
503 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, long magic_mode = MAGIC_MIME])
505 * Attempts to guess the content type of supplied payload through libmagic.
507 PHP_METHOD(HttpResponse
, guessContentType
)
509 char *magic_file
, *ct
= NULL
;
515 #ifdef HTTP_HAVE_MAGIC
516 magic_mode
= MAGIC_MIME
;
519 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
520 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
523 zval
*data
= GET_STATIC_PROP(data
);
524 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
531 zval
*z
= GET_STATIC_PROP(stream
);
532 z
->type
= IS_RESOURCE
;
533 php_stream_from_zval(s
, &z
);
534 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
539 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
543 UPD_STATIC_PROP(string
, contentType
, ct
);
544 RETVAL_STRING(ct
, 0);
549 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
554 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
556 * Set the Content-Disposition of the sent entity. This setting aims to suggest
557 * the receiveing user agent how to handle the sent entity; usually the client
558 * will show the user a "Save As..." popup.
560 PHP_METHOD(HttpResponse
, setContentDisposition
)
565 zend_bool send_inline
= 0;
567 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
571 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
572 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
577 /* {{{ proto static string HttpResponse::getContentDisposition()
579 * Get current Content-Disposition setting.
581 PHP_METHOD(HttpResponse
, getContentDisposition
)
586 zval
*cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
));
588 RETURN_ZVAL(cd
, 1, 0);
593 /* {{{ proto static bool HttpResponse::setETag(string etag)
595 * Set a custom ETag. Use this only if you know what you're doing.
597 PHP_METHOD(HttpResponse
, setETag
)
602 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
606 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
610 /* {{{ proto static string HttpResponse::getETag()
612 * Get calculated or previously set custom ETag.
614 PHP_METHOD(HttpResponse
, getETag
)
619 zval
*etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
));
621 RETURN_ZVAL(etag
, 1, 0);
626 /* {{{ proto static bool HttpResponse::setLastModified(long timestamp)
628 * Set a custom Last-Modified date.
630 PHP_METHOD(HttpResponse
, setLastModified
)
634 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
638 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
642 /* {{{ proto static HttpResponse::getLastModified()
644 * Get calculated or previously set custom Last-Modified date.
646 PHP_METHOD(HttpResponse
, getLastModified
)
651 zval
*lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
));
653 RETURN_ZVAL(lm
, 1, 0);
658 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
661 PHP_METHOD(HttpResponse
, setThrottleDelay
)
665 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
668 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
672 /* {{{ proto static double HttpResponse::getThrottleDelay()
675 PHP_METHOD(HttpResponse
, getThrottleDelay
)
680 zval
*delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
));
682 RETURN_ZVAL(delay
, 1, 0);
687 /* {{{ proto static bool HttpResponse::setBufferSize(long bytes)
690 PHP_METHOD(HttpResponse
, setBufferSize
)
694 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
697 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
701 /* {{{ proto static long HttpResponse::getBufferSize()
704 PHP_METHOD(HttpResponse
, getBufferSize
)
709 zval
*size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
));
711 RETURN_ZVAL(size
, 1, 0);
716 /* {{{ proto static bool HttpResponse::setData(string data)
718 * Set the data to be sent.
720 PHP_METHOD(HttpResponse
, setData
)
724 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
727 if (Z_TYPE_P(the_data
) != IS_STRING
) {
728 convert_to_string_ex(&the_data
);
731 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
732 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
736 if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
))) > 0)) {
737 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
739 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
740 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
742 UPD_STATIC_PROP(string
, eTag
, etag
);
751 /* {{{ proto static string HttpResponse::getData()
753 * Get the previously set data to be sent.
755 PHP_METHOD(HttpResponse
, getData
)
760 zval
*the_data
= GET_STATIC_PROP(data
);
762 RETURN_ZVAL(the_data
, 1, 0);
767 /* {{{ proto static bool HttpResponse::setStream(resource stream)
769 * Set the resource to be sent.
771 PHP_METHOD(HttpResponse
, setStream
)
774 php_stream
*the_real_stream
;
775 php_stream_statbuf ssb
;
777 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
781 php_stream_from_zval(the_real_stream
, &the_stream
);
782 if (php_stream_stat(the_real_stream
, &ssb
)) {
786 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
787 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
790 zend_list_addref(Z_LVAL_P(the_stream
));
792 if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
))) > 0)) {
793 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
795 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
796 char *etag
= http_etag(the_real_stream
, 0, SEND_RSRC
);
798 UPD_STATIC_PROP(string
, eTag
, etag
);
807 /* {{{ proto static resource HttpResponse::getStream()
809 * Get the previously set resource to be sent.
811 PHP_METHOD(HttpResponse
, getStream
)
816 RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
))));
821 /* {{{ proto static bool HttpResponse::setFile(string file)
823 * Set the file to be sent.
825 PHP_METHOD(HttpResponse
, setFile
)
829 php_stream_statbuf ssb
;
831 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
835 if (php_stream_stat_path(the_file
, &ssb
)) {
839 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
840 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
844 if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
))) > 0)) {
845 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
847 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
848 char *etag
= http_etag(the_file
, 0, -1);
850 UPD_STATIC_PROP(string
, eTag
, etag
);
859 /* {{{ proto static string HttpResponse::getFile()
861 * Get the previously set file to be sent.
863 PHP_METHOD(HttpResponse
, getFile
)
868 zval
*the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
));
870 RETURN_ZVAL(the_file
, 1, 0);
875 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
877 * Finally send the entity.
882 * HttpResponse::setCache(true);
883 * HttpResponse::setContentType('application/pdf');
884 * HttpResponse::setContentDisposition("$user.pdf", false);
885 * HttpResponse::setFile('sheet.pdf');
886 * HttpResponse::send();
890 PHP_METHOD(HttpResponse
, send
)
893 zend_bool clean_ob
= 1;
895 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
898 if (SG(headers_sent
)) {
899 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, headers have already been sent");
903 sent
= GET_STATIC_PROP(sent
);
904 if (zval_is_true(sent
)) {
905 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
912 if (zval_is_true(GET_STATIC_PROP(catch))) {
915 MAKE_STD_ZVAL(the_data
);
916 php_ob_get_buffer(the_data TSRMLS_CC
);
917 SET_STATIC_PROP(data
, the_data
);
918 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
920 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
)))) {
921 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
923 UPD_STATIC_PROP(string
, eTag
, etag
);
927 zval_ptr_dtor(&the_data
);
933 /* interrupt on-the-fly etag generation */
934 HTTP_G(etag
).started
= 0;
935 /* discard previous output buffers */
936 php_end_ob_buffers(0 TSRMLS_CC
);
940 if (zval_is_true(GET_STATIC_PROP(gzip
))) {
941 php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC
);
943 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
947 if (zval_is_true(GET_STATIC_PROP(cache
))) {
948 zval
*cctl
, *etag
, *lmod
;
950 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
));
951 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
));
952 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
));
954 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
955 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
));
960 zval
*ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
));
961 if (Z_STRLEN_P(ctype
)) {
962 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
964 char *ctypes
= INI_STR("default_mimetype");
965 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
968 http_send_content_type(ctypes
, ctlen
);
970 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
975 /* content disposition */
977 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
978 if (Z_STRLEN_P(cd
)) {
979 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
985 HTTP_G(send
).buffer_size
= Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
)));
986 HTTP_G(send
).throttle_delay
= Z_DVAL_P(convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
)));
991 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
995 zval
*zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
));
996 RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1001 php_stream
*the_real_stream
;
1002 zval
*the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
));
1003 the_stream
->type
= IS_RESOURCE
;
1004 php_stream_from_zval(the_real_stream
, &the_stream
);
1005 RETURN_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1010 RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
))), 1));
1017 /* {{{ proto static void HttpResponse::capture()
1019 * Capture script output.
1024 * HttpResponse::setCache(true);
1025 * HttpResponse::capture();
1030 PHP_METHOD(HttpResponse
, capture
)
1034 UPD_STATIC_PROP(long, catch, 1);
1036 php_end_ob_buffers(0 TSRMLS_CC
);
1037 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
1039 /* register shutdown function */
1041 zval func
, retval
, arg
, *argp
[1];
1045 INIT_PZVAL(&retval
);
1046 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1049 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1050 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1052 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1058 #endif /* ZEND_ENGINE_2 && !WONKY */
1065 * vim600: noet sw=4 ts=4 fdm=marker
1066 * vim<600: noet sw=4 ts=4