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 +--------------------------------------------------------------------+
20 #define HTTP_WANT_MAGIC
23 /* broken static properties in PHP 5.0 */
24 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
29 #include "php_http_api.h"
30 #include "php_http_cache_api.h"
31 #include "php_http_exception_object.h"
32 #include "php_http_headers_api.h"
33 #include "php_http_response_object.h"
34 #include "php_http_send_api.h"
37 ZEND_EXTERN_MODULE_GLOBALS(http
);
39 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
40 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
41 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
42 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
44 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
45 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
46 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
47 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
49 HTTP_BEGIN_ARGS(setHeader
, 2)
51 HTTP_ARG_VAL(value
, 0)
52 HTTP_ARG_VAL(replace
, 0)
55 HTTP_BEGIN_ARGS(getHeader
, 0)
59 HTTP_EMPTY_ARGS(getETag
, 0);
60 HTTP_BEGIN_ARGS(setETag
, 1)
64 HTTP_EMPTY_ARGS(getLastModified
, 0);
65 HTTP_BEGIN_ARGS(setLastModified
, 1)
66 HTTP_ARG_VAL(timestamp
, 0)
69 HTTP_EMPTY_ARGS(getCache
, 0);
70 HTTP_BEGIN_ARGS(setCache
, 1)
71 HTTP_ARG_VAL(cache
, 0)
74 HTTP_EMPTY_ARGS(getGzip
, 0);
75 HTTP_BEGIN_ARGS(setGzip
, 1)
79 HTTP_EMPTY_ARGS(getCacheControl
, 0);
80 HTTP_BEGIN_ARGS(setCacheControl
, 1)
81 HTTP_ARG_VAL(cache_control
, 0)
82 HTTP_ARG_VAL(max_age
, 0)
85 HTTP_EMPTY_ARGS(getContentType
, 0);
86 HTTP_BEGIN_ARGS(setContentType
, 1)
87 HTTP_ARG_VAL(content_type
, 0)
90 HTTP_BEGIN_ARGS(guessContentType
, 1)
91 HTTP_ARG_VAL(magic_file
, 0)
92 HTTP_ARG_VAL(magic_mode
, 0)
95 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
96 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
97 HTTP_ARG_VAL(filename
, 0)
98 HTTP_ARG_VAL(send_inline
, 0)
101 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
102 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
103 HTTP_ARG_VAL(seconds
, 0)
106 HTTP_EMPTY_ARGS(getBufferSize
, 0);
107 HTTP_BEGIN_ARGS(setBufferSize
, 1)
108 HTTP_ARG_VAL(bytes
, 0)
111 HTTP_EMPTY_ARGS(getData
, 0);
112 HTTP_BEGIN_ARGS(setData
, 1)
113 HTTP_ARG_VAL(data
, 0)
116 HTTP_EMPTY_ARGS(getStream
, 0);
117 HTTP_BEGIN_ARGS(setStream
, 1)
118 HTTP_ARG_VAL(stream
, 0)
121 HTTP_EMPTY_ARGS(getFile
, 0);
122 HTTP_BEGIN_ARGS(setFile
, 1)
123 HTTP_ARG_VAL(filepath
, 0)
126 HTTP_BEGIN_ARGS(send
, 0)
127 HTTP_ARG_VAL(clean_ob
, 0)
130 HTTP_EMPTY_ARGS(capture
, 0);
132 HTTP_BEGIN_ARGS(redirect
, 0)
134 HTTP_ARG_VAL(params
, 0)
135 HTTP_ARG_VAL(session
, 0)
136 HTTP_ARG_VAL(permanent
, 0)
139 HTTP_BEGIN_ARGS(status
, 1)
140 HTTP_ARG_VAL(code
, 0)
143 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
144 HTTP_EMPTY_ARGS(getRequestBody
, 0);
146 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
147 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
148 #define http_grab_response_headers _http_grab_response_headers
149 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
151 zend_class_entry
*http_response_object_ce
;
152 zend_function_entry http_response_object_fe
[] = {
154 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
155 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
157 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
158 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
161 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
164 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
167 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
178 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
181 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
184 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
187 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
190 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
193 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
196 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
198 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
199 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
200 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
201 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
206 PHP_MINIT_FUNCTION(http_response_object
)
208 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
209 http_response_object_declare_default_properties();
213 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
215 zend_class_entry
*ce
= http_response_object_ce
;
217 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
218 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
219 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
220 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
221 DCL_STATIC_PROP_N(PRIVATE
, file
);
222 DCL_STATIC_PROP_N(PRIVATE
, data
);
223 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
224 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
225 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
226 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
227 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
228 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
229 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
230 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
231 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
234 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
235 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
236 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
237 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
241 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
243 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
244 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
247 /* ### USERLAND ### */
249 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
251 * Send an HTTP header.
253 * Expects a string parameter containing the name of the header and a mixed
254 * parameter containing the value of the header, which will be converted to
255 * a string. Additionally accepts an optional boolean parameter, which
256 * specifies whether an existing header should be replaced. If the second
257 * parameter is unset no header with this name will be sent.
259 * Returns TRUE on success, or FALSE on failure.
261 * Throws HttpHeaderException if http.only_exceptions is TRUE.
263 PHP_METHOD(HttpResponse
, setHeader
)
265 zend_bool replace
= 1;
268 zval
*value
= NULL
, *orig
= NULL
;
270 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
273 if (SG(headers_sent
)) {
274 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
278 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
282 /* delete header if value == null */
283 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
284 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
286 /* send multiple header if replace is false and value is an array */
287 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
291 FOREACH_VAL(pos
, value
, data
) {
294 convert_to_string_ex(data
);
295 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
307 /* send standard header */
309 convert_to_string_ex(&value
);
310 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
312 zval_ptr_dtor(&value
);
317 /* {{{ proto static mixed HttpResponse::getHeader([string name])
319 * Get header(s) about to be sent.
321 * Accepts a string as optional parameter which specifies the name of the
322 * header to read. If the parameter is empty or omitted, an associative array
323 * with all headers will be returned.
325 * Returns either a string containing the value of the header matching name,
326 * FALSE on failure, or an associative array with all headers.
328 PHP_METHOD(HttpResponse
, getHeader
)
334 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
338 phpstr_init(&headers
);
339 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
340 phpstr_fix(&headers
);
342 if (name
&& name_len
) {
344 HashTable headers_ht
;
346 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
347 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
348 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
349 RETVAL_ZVAL(*header
, 1, 0);
353 zend_hash_destroy(&headers_ht
);
355 array_init(return_value
);
356 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
359 phpstr_dtor(&headers
);
363 /* {{{ proto static bool HttpResponse::setCache(bool cache)
365 * Whether it sould be attempted to cache the entitity.
366 * This will result in necessary caching headers and checks of clients
367 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
368 * matches a "304 Not Modified" status code will be issued.
370 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
371 * to something more appropriate than "no-cache"!
373 * Expects a boolean as parameter specifying whether caching should be attempted.
375 * Returns TRUE ons success, or FALSE on failure.
377 PHP_METHOD(HttpResponse
, setCache
)
379 zend_bool do_cache
= 0;
381 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
385 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
389 /* {{{ proto static bool HttpResponse::getCache()
391 * Get current caching setting.
393 * Returns TRUE if caching should be attempted, else FALSE.
395 PHP_METHOD(HttpResponse
, getCache
)
400 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
402 RETVAL_ZVAL(cache
, 1, 0);
405 zval_ptr_dtor(&cache_p
);
411 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
413 * Enable on-thy-fly gzipping of the sent entity.
415 * Expects a boolean as parameter indicating if GZip compression should be enabled.
417 * Returns TRUE on success, or FALSE on failure.
419 PHP_METHOD(HttpResponse
, setGzip
)
421 zend_bool do_gzip
= 0;
423 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
427 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
431 /* {{{ proto static bool HttpResponse::getGzip()
433 * Get current gzipping setting.
435 * Returns TRUE if GZip compression is enabled, else FALSE.
437 PHP_METHOD(HttpResponse
, getGzip
)
442 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
444 RETVAL_ZVAL(gzip
, 1, 0);
447 zval_ptr_dtor(&gzip_p
);
453 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
455 * Set a custom cache-control header, usually being "private" or "public";
456 * The max_age parameter controls how long the cache entry is valid on the client side.
458 * Expects a string parameter containing the primary cache control setting.
459 * Addtitionally accepts an int parameter specifying the max-age setting.
461 * Returns TRUE on success, or FALSE if control does not match one of
462 * "public" , "private" or "no-cache".
464 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
466 PHP_METHOD(HttpResponse
, setCacheControl
)
468 char *ccontrol
, *cctl
;
472 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
476 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
477 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
480 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max-age=%ld", ccontrol
, max_age
);
481 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
487 /* {{{ proto static string HttpResponse::getCacheControl()
489 * Get current Cache-Control header setting.
491 * Returns the current cache control setting as a string like sent in a header.
493 PHP_METHOD(HttpResponse
, getCacheControl
)
498 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
500 RETVAL_ZVAL(ccontrol
, 1, 0);
503 zval_ptr_dtor(&ccontrol_p
);
509 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
511 * Set the content-type of the sent entity.
513 * Expects a string as parameter specifying the content type of the sent entity.
515 * Returns TRUE on success, or FALSE if the content type does not seem to
516 * contain a primary and secondary content type part.
518 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
520 PHP_METHOD(HttpResponse
, setContentType
)
525 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
529 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
530 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
534 /* {{{ proto static string HttpResponse::getContentType()
536 * Get current Content-Type header setting.
538 * Returns the currently set content type as string.
540 PHP_METHOD(HttpResponse
, getContentType
)
545 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
547 RETVAL_ZVAL(ctype
, 1, 0);
550 zval_ptr_dtor(&ctype_p
);
556 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
558 * Attempts to guess the content type of supplied payload through libmagic.
559 * If the attempt is successful, the guessed content type will automatically
560 * be set as response content type.
562 * Expects a string parameter specifying the magic.mime database to use.
563 * Additionally accepts an optional int parameter, being flags for libmagic.
565 * Returns the guessed content type on success, or FALSE on failure.
567 * Throws HttpRuntimeException, HttpInvalidParamException
568 * if http.only_exceptions is TRUE.
570 PHP_METHOD(HttpResponse
, guessContentType
)
572 char *magic_file
, *ct
= NULL
;
578 #ifdef HTTP_HAVE_MAGIC
579 magic_mode
= MAGIC_MIME
;
582 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
583 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
586 zval
*data
= GET_STATIC_PROP(data
);
587 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
594 zval
*z
= GET_STATIC_PROP(stream
);
595 z
->type
= IS_RESOURCE
;
596 php_stream_from_zval(s
, &z
);
597 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
602 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
606 UPD_STATIC_PROP(string
, contentType
, ct
);
607 RETVAL_STRING(ct
, 0);
612 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
617 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
619 * Set the Content-Disposition. The Content-Disposition header is very useful
620 * if the data actually sent came from a file or something similar, that should
621 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
623 * Expects a string parameter specifying the file name the "Save as..." dialogue
624 * should display. Optionally accepts a bool parameter, which, if set to true
625 * and the user agent knows how to handle the content type, will probably not
626 * cause the popup window to be shown.
628 * Returns TRUE on success or FALSE on failure.
630 PHP_METHOD(HttpResponse
, setContentDisposition
)
635 zend_bool send_inline
= 0;
637 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
641 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
642 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
647 /* {{{ proto static string HttpResponse::getContentDisposition()
649 * Get current Content-Disposition setting.
651 * Returns the current content disposition as string like sent in a header.
653 PHP_METHOD(HttpResponse
, getContentDisposition
)
658 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
660 RETVAL_ZVAL(cd
, 1, 0);
663 zval_ptr_dtor(&cd_p
);
669 /* {{{ proto static bool HttpResponse::setETag(string etag)
671 * Set a custom ETag. Use this only if you know what you're doing.
673 * Expects an unquoted string as parameter containing the ETag.
675 * Returns TRUE on success, or FALSE on failure.
677 PHP_METHOD(HttpResponse
, setETag
)
682 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
686 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
690 /* {{{ proto static string HttpResponse::getETag()
692 * Get calculated or previously set custom ETag.
694 * Returns the calculated or previously set ETag as unquoted string.
696 PHP_METHOD(HttpResponse
, getETag
)
701 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
703 RETVAL_ZVAL(etag
, 1, 0);
706 zval_ptr_dtor(&etag_p
);
712 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
714 * Set a custom Last-Modified date.
716 * Expects an unix timestamp as parameter representing the last modification
717 * time of the sent entity.
719 * Returns TRUE on success, or FALSE on failure.
721 PHP_METHOD(HttpResponse
, setLastModified
)
725 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
729 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
733 /* {{{ proto static int HttpResponse::getLastModified()
735 * Get calculated or previously set custom Last-Modified date.
737 * Returns the calculated or previously set unix timestamp.
739 PHP_METHOD(HttpResponse
, getLastModified
)
744 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
746 RETVAL_ZVAL(lm
, 1, 0);
749 zval_ptr_dtor(&lm_p
);
755 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
757 * Sets the throttle delay for use with HttpResponse::setBufferSize().
759 * Provides a basic throttling mechanism, which will yield the current process
760 * resp. thread until the entity has been completely sent, though.
762 * Note: This doesn't really work with the FastCGI SAPI.
764 * Expects a double parameter specifying the seconds too sleep() after
767 * Returns TRUE on success, or FALSE on failure.
769 PHP_METHOD(HttpResponse
, setThrottleDelay
)
773 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
776 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
780 /* {{{ proto static double HttpResponse::getThrottleDelay()
782 * Get the current throttle delay.
784 * Returns a double representing the throttle delay in seconds.
786 PHP_METHOD(HttpResponse
, getThrottleDelay
)
791 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
793 RETVAL_ZVAL(delay
, 1, 0);
796 zval_ptr_dtor(&delay_p
);
802 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
804 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
806 * Provides a basic throttling mechanism, which will yield the current process
807 * resp. thread until the entity has been completely sent, though.
809 * Note: This doesn't really work with the FastCGI SAPI.
811 * Expects an int parameter representing the chunk size in bytes.
813 * Returns TRUE on success, or FALSE on failure.
815 PHP_METHOD(HttpResponse
, setBufferSize
)
819 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
822 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
826 /* {{{ proto static int HttpResponse::getBufferSize()
828 * Get current buffer size.
830 * Returns an int representing the current buffer size in bytes.
832 PHP_METHOD(HttpResponse
, getBufferSize
)
837 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
839 RETVAL_ZVAL(size
, 1, 0);
842 zval_ptr_dtor(&size_p
);
848 /* {{{ proto static bool HttpResponse::setData(mixed data)
850 * Set the data to be sent.
852 * Expects one parameter, which will be converted to a string and contains
855 * Returns TRUE on success, or FALSE on failure.
857 PHP_METHOD(HttpResponse
, setData
)
862 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
865 if (Z_TYPE_P(the_data
) != IS_STRING
) {
866 convert_to_string_ex(&the_data
);
869 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
870 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
874 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
875 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
876 UPD_STATIC_PROP(string
, eTag
, etag
);
884 /* {{{ proto static string HttpResponse::getData()
886 * Get the previously set data to be sent.
888 * Returns a string containing the previously set data to send.
890 PHP_METHOD(HttpResponse
, getData
)
895 zval
*the_data
= GET_STATIC_PROP(data
);
897 RETURN_ZVAL(the_data
, 1, 0);
902 /* {{{ proto static bool HttpResponse::setStream(resource stream)
904 * Set the resource to be sent.
906 * Expects a resource parameter referencing an already opened stream from
907 * which the data to send will be read.
909 * Returns TRUE on success, or FALSE on failure.
911 PHP_METHOD(HttpResponse
, setStream
)
915 php_stream
*the_real_stream
;
916 php_stream_statbuf ssb
;
918 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
922 php_stream_from_zval(the_real_stream
, &the_stream
);
923 if (php_stream_stat(the_real_stream
, &ssb
)) {
927 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
928 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
931 zend_list_addref(Z_LVAL_P(the_stream
));
933 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
934 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
935 UPD_STATIC_PROP(string
, eTag
, etag
);
943 /* {{{ proto static resource HttpResponse::getStream()
945 * Get the previously set resource to be sent.
947 * Returns the previously set resource.
949 PHP_METHOD(HttpResponse
, getStream
)
956 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
959 zval_ptr_dtor(&stream_p
);
965 /* {{{ proto static bool HttpResponse::setFile(string file)
967 * Set the file to be sent.
969 * Expects a string as parameter, specifying the path to the file to send.
971 * Returns TRUE on success, or FALSE on failure.
973 PHP_METHOD(HttpResponse
, setFile
)
975 char *the_file
, *etag
;
977 php_stream_statbuf ssb
;
979 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
983 if (php_stream_stat_path(the_file
, &ssb
)) {
987 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
988 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
992 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
993 if ((etag
= http_etag(the_file
, 0, -1))) {
994 UPD_STATIC_PROP(string
, eTag
, etag
);
1002 /* {{{ proto static string HttpResponse::getFile()
1004 * Get the previously set file to be sent.
1006 * Returns the previously set path to the file to send as string.
1008 PHP_METHOD(HttpResponse
, getFile
)
1013 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1015 RETVAL_ZVAL(the_file
, 1, 0);
1018 zval_ptr_dtor(&the_file_p
);
1024 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1026 * Finally send the entity.
1028 * Accepts an optional boolean parameter, specifying wheter the ouput
1029 * buffers should be discarded prior sending. A successful caching attempt
1030 * will cause a script termination, and write a log entry if the INI setting
1031 * http.cache_log is set.
1033 * Returns TRUE on success, or FALSE on failure.
1035 * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
1040 * HttpResponse::setCache(true);
1041 * HttpResponse::setContentType('application/pdf');
1042 * HttpResponse::setContentDisposition("$user.pdf", false);
1043 * HttpResponse::setFile('sheet.pdf');
1044 * HttpResponse::send();
1048 PHP_METHOD(HttpResponse
, send
)
1051 zend_bool clean_ob
= 1;
1053 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1057 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1059 sent
= GET_STATIC_PROP(sent
);
1060 if (Z_LVAL_P(sent
)) {
1061 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1068 if (zval_is_true(GET_STATIC_PROP(catch))) {
1069 zval
*etag_p
, *the_data
;
1071 MAKE_STD_ZVAL(the_data
);
1072 php_ob_get_buffer(the_data TSRMLS_CC
);
1073 SET_STATIC_PROP(data
, the_data
);
1074 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1076 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1077 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1079 UPD_STATIC_PROP(string
, eTag
, etag
);
1083 zval_ptr_dtor(&the_data
);
1086 zval_ptr_dtor(&etag_p
);
1093 /* interrupt on-the-fly etag generation */
1094 HTTP_G(etag
).started
= 0;
1095 /* discard previous output buffers */
1096 php_end_ob_buffers(0 TSRMLS_CC
);
1100 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1101 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1103 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1104 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1105 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1107 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1108 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
));
1110 if (etag_p
) zval_ptr_dtor(&etag_p
);
1111 if (lmod_p
) zval_ptr_dtor(&lmod_p
);
1112 if (cctl_p
) zval_ptr_dtor(&cctl_p
);
1114 if (php_ob_handler_used("blackhole" TSRMLS_CC
)) {
1121 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1122 if (Z_STRLEN_P(ctype
)) {
1123 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1125 char *ctypes
= INI_STR("default_mimetype");
1126 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1129 http_send_content_type(ctypes
, ctlen
);
1131 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1135 zval_ptr_dtor(&ctype_p
);
1139 /* content disposition */
1141 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1142 if (Z_STRLEN_P(cd
)) {
1143 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1146 zval_ptr_dtor(&cd_p
);
1152 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1153 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1154 HTTP_G(send
).buffer_size
= Z_LVAL_P(bsize
);
1155 HTTP_G(send
).throttle_delay
= Z_DVAL_P(delay
);
1156 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1157 if (delay_p
) zval_ptr_dtor(&delay_p
);
1161 HTTP_G(send
).gzip_encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1164 php_start_ob_buffer(NULL
, HTTP_G(send
).buffer_size
, 0 TSRMLS_CC
);
1167 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
1171 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1172 RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1173 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1179 php_stream
*the_real_stream
;
1180 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1181 the_stream
->type
= IS_RESOURCE
;
1182 php_stream_from_zval(the_real_stream
, &the_stream
);
1183 RETVAL_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1184 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1191 RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
)), 1));
1192 if (file_p
) zval_ptr_dtor(&file_p
);
1199 /* {{{ proto static void HttpResponse::capture()
1201 * Capture script output.
1206 * HttpResponse::setCache(true);
1207 * HttpResponse::capture();
1212 PHP_METHOD(HttpResponse
, capture
)
1216 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1218 UPD_STATIC_PROP(long, catch, 1);
1220 php_end_ob_buffers(0 TSRMLS_CC
);
1221 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1223 /* register shutdown function */
1225 zval func
, retval
, arg
, *argp
[1];
1229 INIT_PZVAL(&retval
);
1230 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1233 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1234 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1236 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1242 #endif /* ZEND_ENGINE_2 && !WONKY */
1249 * vim600: noet sw=4 ts=4 fdm=marker
1250 * vim<600: noet sw=4 ts=4