2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
23 /* broken static properties in PHP 5.0 */
24 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
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"
36 #include "php_http_headers_api.h"
38 #ifdef HTTP_HAVE_MHASH
41 #ifdef HTTP_HAVE_MAGIC
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 PHP_MINIT_FUNCTION(http_response_object
)
216 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
217 http_response_object_declare_default_properties();
221 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
223 zend_class_entry
*ce
= http_response_object_ce
;
225 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
226 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
227 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
228 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
229 DCL_STATIC_PROP_N(PRIVATE
, file
);
230 DCL_STATIC_PROP_N(PRIVATE
, data
);
231 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
232 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
233 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
234 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
235 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
236 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
237 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
238 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
239 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
242 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
243 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
244 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
245 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
247 DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5
);
248 DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1
);
249 DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32
);
251 # ifdef HTTP_HAVE_MHASH
253 int l
, i
, c
= mhash_count();
255 for (i
= 0; i
<= c
; ++i
) {
256 char const_name
[256] = {0};
257 const char *hash_name
= mhash_get_hash_name_static(i
);
260 l
= snprintf(const_name
, 255, "ETAG_MHASH_%s", hash_name
);
261 zend_declare_class_constant_long(ce
, const_name
, l
, i TSRMLS_CC
);
265 # endif /* HTTP_HAVE_MHASH */
269 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
271 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
272 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
275 /* ### USERLAND ### */
277 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
279 * Send an HTTP header.
281 * Expects a string parameter containing the name of the header and a mixed
282 * parameter containing the value of the header, which will be converted to
283 * a string. Additionally accepts an optional boolean parameter, which
284 * specifies whether an existing header should be replaced. If the second
285 * parameter is unset no header with this name will be sent.
287 * Returns TRUE on success, or FALSE on failure.
289 * Throws HttpHeaderException if http.only_exceptions is TRUE.
291 PHP_METHOD(HttpResponse
, setHeader
)
293 zend_bool replace
= 1;
296 zval
*value
= NULL
, *orig
= NULL
;
298 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
301 if (SG(headers_sent
)) {
302 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
306 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
310 /* delete header if value == null */
311 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
312 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
314 /* send multiple header if replace is false and value is an array */
315 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
319 FOREACH_VAL(pos
, value
, data
) {
322 convert_to_string_ex(data
);
323 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
335 /* send standard header */
337 convert_to_string_ex(&value
);
338 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
340 zval_ptr_dtor(&value
);
345 /* {{{ proto static mixed HttpResponse::getHeader([string name])
347 * Get header(s) about to be sent.
349 * Accepts a string as optional parameter which specifies the name of the
350 * header to read. If the parameter is empty or omitted, an associative array
351 * with all headers will be returned.
353 * Returns either a string containing the value of the header matching name,
354 * FALSE on failure, or an associative array with all headers.
356 PHP_METHOD(HttpResponse
, getHeader
)
362 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
366 phpstr_init(&headers
);
367 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
368 phpstr_fix(&headers
);
370 if (name
&& name_len
) {
372 HashTable headers_ht
;
374 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
375 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
376 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
377 RETVAL_ZVAL(*header
, 1, 0);
381 zend_hash_destroy(&headers_ht
);
383 array_init(return_value
);
384 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
387 phpstr_dtor(&headers
);
391 /* {{{ proto static bool HttpResponse::setCache(bool cache)
393 * Whether it sould be attempted to cache the entitity.
394 * This will result in necessary caching headers and checks of clients
395 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
396 * matches a "304 Not Modified" status code will be issued.
398 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
399 * to something more appropriate than "no-cache"!
401 * Expects a boolean as parameter specifying whether caching should be attempted.
403 * Returns TRUE ons success, or FALSE on failure.
405 PHP_METHOD(HttpResponse
, setCache
)
407 zend_bool do_cache
= 0;
409 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
413 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
417 /* {{{ proto static bool HttpResponse::getCache()
419 * Get current caching setting.
421 * Returns TRUE if caching should be attempted, else FALSE.
423 PHP_METHOD(HttpResponse
, getCache
)
428 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
430 RETVAL_ZVAL(cache
, 1, 0);
433 zval_ptr_dtor(&cache_p
);
439 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
441 * Enable on-thy-fly gzipping of the sent entity.
443 * Expects a boolean as parameter indicating if GZip compression should be enabled.
445 * Returns TRUE on success, or FALSE on failure.
447 PHP_METHOD(HttpResponse
, setGzip
)
449 zend_bool do_gzip
= 0;
451 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
455 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
459 /* {{{ proto static bool HttpResponse::getGzip()
461 * Get current gzipping setting.
463 * Returns TRUE if GZip compression is enabled, else FALSE.
465 PHP_METHOD(HttpResponse
, getGzip
)
470 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
472 RETVAL_ZVAL(gzip
, 1, 0);
475 zval_ptr_dtor(&gzip_p
);
481 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
483 * Set a custom cache-control header, usually being "private" or "public";
484 * The max_age parameter controls how long the cache entry is valid on the client side.
486 * Expects a string parameter containing the primary cache control setting.
487 * Addtitionally accepts an int parameter specifying the max-age setting.
489 * Returns TRUE on success, or FALSE if control does not match one of
490 * "public" , "private" or "no-cache".
492 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
494 PHP_METHOD(HttpResponse
, setCacheControl
)
496 char *ccontrol
, *cctl
;
500 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
504 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
505 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
508 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max-age=%ld", ccontrol
, max_age
);
509 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
515 /* {{{ proto static string HttpResponse::getCacheControl()
517 * Get current Cache-Control header setting.
519 * Returns the current cache control setting as a string like sent in a header.
521 PHP_METHOD(HttpResponse
, getCacheControl
)
526 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
528 RETVAL_ZVAL(ccontrol
, 1, 0);
531 zval_ptr_dtor(&ccontrol_p
);
537 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
539 * Set the content-type of the sent entity.
541 * Expects a string as parameter specifying the content type of the sent entity.
543 * Returns TRUE on success, or FALSE if the content type does not seem to
544 * contain a primary and secondary content type part.
546 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
548 PHP_METHOD(HttpResponse
, setContentType
)
553 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
557 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
558 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
562 /* {{{ proto static string HttpResponse::getContentType()
564 * Get current Content-Type header setting.
566 * Returns the currently set content type as string.
568 PHP_METHOD(HttpResponse
, getContentType
)
573 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
575 RETVAL_ZVAL(ctype
, 1, 0);
578 zval_ptr_dtor(&ctype_p
);
584 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
586 * Attempts to guess the content type of supplied payload through libmagic.
587 * If the attempt is successful, the guessed content type will automatically
588 * be set as response content type.
590 * Expects a string parameter specifying the magic.mime database to use.
591 * Additionally accepts an optional int parameter, being flags for libmagic.
593 * Returns the guessed content type on success, or FALSE on failure.
595 * Throws HttpRuntimeException, HttpInvalidParamException
596 * if http.only_exceptions is TRUE.
598 PHP_METHOD(HttpResponse
, guessContentType
)
600 char *magic_file
, *ct
= NULL
;
606 #ifdef HTTP_HAVE_MAGIC
607 magic_mode
= MAGIC_MIME
;
610 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
611 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
614 zval
*data
= GET_STATIC_PROP(data
);
615 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
622 zval
*z
= GET_STATIC_PROP(stream
);
623 z
->type
= IS_RESOURCE
;
624 php_stream_from_zval(s
, &z
);
625 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
630 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
634 UPD_STATIC_PROP(string
, contentType
, ct
);
635 RETVAL_STRING(ct
, 0);
640 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
645 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
647 * Set the Content-Disposition. The Content-Disposition header is very useful
648 * if the data actually sent came from a file or something similar, that should
649 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
651 * Expects a string parameter specifying the file name the "Save as..." dialogue
652 * should display. Optionally accepts a bool parameter, which, if set to true
653 * and the user agent knows how to handle the content type, will probably not
654 * cause the popup window to be shown.
656 * Returns TRUE on success or FALSE on failure.
658 PHP_METHOD(HttpResponse
, setContentDisposition
)
663 zend_bool send_inline
= 0;
665 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
669 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
670 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
675 /* {{{ proto static string HttpResponse::getContentDisposition()
677 * Get current Content-Disposition setting.
679 * Returns the current content disposition as string like sent in a header.
681 PHP_METHOD(HttpResponse
, getContentDisposition
)
686 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
688 RETVAL_ZVAL(cd
, 1, 0);
691 zval_ptr_dtor(&cd_p
);
697 /* {{{ proto static bool HttpResponse::setETag(string etag)
699 * Set a custom ETag. Use this only if you know what you're doing.
701 * Expects an unquoted string as parameter containing the ETag.
703 * Returns TRUE on success, or FALSE on failure.
705 PHP_METHOD(HttpResponse
, setETag
)
710 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
714 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
718 /* {{{ proto static string HttpResponse::getETag()
720 * Get calculated or previously set custom ETag.
722 * Returns the calculated or previously set ETag as unquoted string.
724 PHP_METHOD(HttpResponse
, getETag
)
729 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
731 RETVAL_ZVAL(etag
, 1, 0);
734 zval_ptr_dtor(&etag_p
);
740 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
742 * Set a custom Last-Modified date.
744 * Expects an unix timestamp as parameter representing the last modification
745 * time of the sent entity.
747 * Returns TRUE on success, or FALSE on failure.
749 PHP_METHOD(HttpResponse
, setLastModified
)
753 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
757 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
761 /* {{{ proto static int HttpResponse::getLastModified()
763 * Get calculated or previously set custom Last-Modified date.
765 * Returns the calculated or previously set unix timestamp.
767 PHP_METHOD(HttpResponse
, getLastModified
)
772 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
774 RETVAL_ZVAL(lm
, 1, 0);
777 zval_ptr_dtor(&lm_p
);
783 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
785 * Sets the throttle delay for use with HttpResponse::setBufferSize().
787 * Provides a basic throttling mechanism, which will yield the current process
788 * resp. thread until the entity has been completely sent, though.
790 * Note: This doesn't really work with the FastCGI SAPI.
792 * Expects a double parameter specifying the seconds too sleep() after
795 * Returns TRUE on success, or FALSE on failure.
797 PHP_METHOD(HttpResponse
, setThrottleDelay
)
801 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
804 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
808 /* {{{ proto static double HttpResponse::getThrottleDelay()
810 * Get the current throttle delay.
812 * Returns a double representing the throttle delay in seconds.
814 PHP_METHOD(HttpResponse
, getThrottleDelay
)
819 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
821 RETVAL_ZVAL(delay
, 1, 0);
824 zval_ptr_dtor(&delay_p
);
830 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
832 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
834 * Provides a basic throttling mechanism, which will yield the current process
835 * resp. thread until the entity has been completely sent, though.
837 * Note: This doesn't really work with the FastCGI SAPI.
839 * Expects an int parameter representing the chunk size in bytes.
841 * Returns TRUE on success, or FALSE on failure.
843 PHP_METHOD(HttpResponse
, setBufferSize
)
847 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
850 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
854 /* {{{ proto static int HttpResponse::getBufferSize()
856 * Get current buffer size.
858 * Returns an int representing the current buffer size in bytes.
860 PHP_METHOD(HttpResponse
, getBufferSize
)
865 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
867 RETVAL_ZVAL(size
, 1, 0);
870 zval_ptr_dtor(&size_p
);
876 /* {{{ proto static bool HttpResponse::setData(mixed data)
878 * Set the data to be sent.
880 * Expects one parameter, which will be converted to a string and contains
883 * Returns TRUE on success, or FALSE on failure.
885 PHP_METHOD(HttpResponse
, setData
)
890 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
893 if (Z_TYPE_P(the_data
) != IS_STRING
) {
894 convert_to_string_ex(&the_data
);
897 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
898 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
902 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
903 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
904 UPD_STATIC_PROP(string
, eTag
, etag
);
912 /* {{{ proto static string HttpResponse::getData()
914 * Get the previously set data to be sent.
916 * Returns a string containing the previously set data to send.
918 PHP_METHOD(HttpResponse
, getData
)
923 zval
*the_data
= GET_STATIC_PROP(data
);
925 RETURN_ZVAL(the_data
, 1, 0);
930 /* {{{ proto static bool HttpResponse::setStream(resource stream)
932 * Set the resource to be sent.
934 * Expects a resource parameter referencing an already opened stream from
935 * which the data to send will be read.
937 * Returns TRUE on success, or FALSE on failure.
939 PHP_METHOD(HttpResponse
, setStream
)
943 php_stream
*the_real_stream
;
944 php_stream_statbuf ssb
;
946 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
950 php_stream_from_zval(the_real_stream
, &the_stream
);
951 if (php_stream_stat(the_real_stream
, &ssb
)) {
955 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
956 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
959 zend_list_addref(Z_LVAL_P(the_stream
));
961 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
962 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
963 UPD_STATIC_PROP(string
, eTag
, etag
);
971 /* {{{ proto static resource HttpResponse::getStream()
973 * Get the previously set resource to be sent.
975 * Returns the previously set resource.
977 PHP_METHOD(HttpResponse
, getStream
)
984 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
987 zval_ptr_dtor(&stream_p
);
993 /* {{{ proto static bool HttpResponse::setFile(string file)
995 * Set the file to be sent.
997 * Expects a string as parameter, specifying the path to the file to send.
999 * Returns TRUE on success, or FALSE on failure.
1001 PHP_METHOD(HttpResponse
, setFile
)
1003 char *the_file
, *etag
;
1005 php_stream_statbuf ssb
;
1007 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
1011 if (php_stream_stat_path(the_file
, &ssb
)) {
1015 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
1016 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
1020 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
1021 if ((etag
= http_etag(the_file
, 0, -1))) {
1022 UPD_STATIC_PROP(string
, eTag
, etag
);
1030 /* {{{ proto static string HttpResponse::getFile()
1032 * Get the previously set file to be sent.
1034 * Returns the previously set path to the file to send as string.
1036 PHP_METHOD(HttpResponse
, getFile
)
1041 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1043 RETVAL_ZVAL(the_file
, 1, 0);
1046 zval_ptr_dtor(&the_file_p
);
1052 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1054 * Finally send the entity.
1056 * Accepts an optional boolean parameter, specifying wheter the ouput
1057 * buffers should be discarded prior sending. A successful caching attempt
1058 * will cause a script termination, and write a log entry if the INI setting
1059 * http.cache_log is set.
1061 * Returns TRUE on success, or FALSE on failure.
1063 * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
1068 * HttpResponse::setCache(true);
1069 * HttpResponse::setContentType('application/pdf');
1070 * HttpResponse::setContentDisposition("$user.pdf", false);
1071 * HttpResponse::setFile('sheet.pdf');
1072 * HttpResponse::send();
1076 PHP_METHOD(HttpResponse
, send
)
1079 zend_bool clean_ob
= 1;
1081 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1085 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1087 sent
= GET_STATIC_PROP(sent
);
1088 if (Z_LVAL_P(sent
)) {
1089 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1096 if (zval_is_true(GET_STATIC_PROP(catch))) {
1097 zval
*etag_p
, *the_data
;
1099 MAKE_STD_ZVAL(the_data
);
1100 php_ob_get_buffer(the_data TSRMLS_CC
);
1101 SET_STATIC_PROP(data
, the_data
);
1102 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1104 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1105 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1107 UPD_STATIC_PROP(string
, eTag
, etag
);
1111 zval_ptr_dtor(&the_data
);
1114 zval_ptr_dtor(&etag_p
);
1121 /* interrupt on-the-fly etag generation */
1122 HTTP_G(etag
).started
= 0;
1123 /* discard previous output buffers */
1124 php_end_ob_buffers(0 TSRMLS_CC
);
1128 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1129 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1131 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1132 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1133 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1135 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1136 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
));
1138 if (etag_p
) zval_ptr_dtor(&etag_p
);
1139 if (lmod_p
) zval_ptr_dtor(&lmod_p
);
1140 if (cctl_p
) zval_ptr_dtor(&cctl_p
);
1142 if (php_ob_handler_used("blackhole" TSRMLS_CC
)) {
1149 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1150 if (Z_STRLEN_P(ctype
)) {
1151 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1153 char *ctypes
= INI_STR("default_mimetype");
1154 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1157 http_send_content_type(ctypes
, ctlen
);
1159 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1163 zval_ptr_dtor(&ctype_p
);
1167 /* content disposition */
1169 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1170 if (Z_STRLEN_P(cd
)) {
1171 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1174 zval_ptr_dtor(&cd_p
);
1180 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1181 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1182 HTTP_G(send
).buffer_size
= Z_LVAL_P(bsize
);
1183 HTTP_G(send
).throttle_delay
= Z_DVAL_P(delay
);
1184 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1185 if (delay_p
) zval_ptr_dtor(&delay_p
);
1189 HTTP_G(send
).gzip_encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1192 php_start_ob_buffer(NULL
, HTTP_G(send
).buffer_size
, 0 TSRMLS_CC
);
1195 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
1199 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1200 RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1201 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1207 php_stream
*the_real_stream
;
1208 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1209 the_stream
->type
= IS_RESOURCE
;
1210 php_stream_from_zval(the_real_stream
, &the_stream
);
1211 RETVAL_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1212 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1219 RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
)), 1));
1220 if (file_p
) zval_ptr_dtor(&file_p
);
1227 /* {{{ proto static void HttpResponse::capture()
1229 * Capture script output.
1234 * HttpResponse::setCache(true);
1235 * HttpResponse::capture();
1240 PHP_METHOD(HttpResponse
, capture
)
1244 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1246 UPD_STATIC_PROP(long, catch, 1);
1248 php_end_ob_buffers(0 TSRMLS_CC
);
1249 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1251 /* register shutdown function */
1253 zval func
, retval
, arg
, *argp
[1];
1257 INIT_PZVAL(&retval
);
1258 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1261 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1262 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1264 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1270 #endif /* ZEND_ENGINE_2 && !WONKY */
1277 * vim600: noet sw=4 ts=4 fdm=marker
1278 * vim<600: noet sw=4 ts=4