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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #define HTTP_WANT_SAPI
16 #define HTTP_WANT_MAGIC
19 /* broken static properties in PHP 5.0 */
20 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
24 #include "php_http_api.h"
25 #include "php_http_cache_api.h"
26 #include "php_http_exception_object.h"
27 #include "php_http_headers_api.h"
28 #include "php_http_response_object.h"
29 #include "php_http_send_api.h"
31 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
32 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpResponse, method, 0)
33 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
34 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
36 HTTP_BEGIN_ARGS(setHeader
, 2)
38 HTTP_ARG_VAL(value
, 0)
39 HTTP_ARG_VAL(replace
, 0)
42 HTTP_BEGIN_ARGS(getHeader
, 0)
46 HTTP_EMPTY_ARGS(getETag
);
47 HTTP_BEGIN_ARGS(setETag
, 1)
51 HTTP_EMPTY_ARGS(getLastModified
);
52 HTTP_BEGIN_ARGS(setLastModified
, 1)
53 HTTP_ARG_VAL(timestamp
, 0)
56 HTTP_EMPTY_ARGS(getCache
);
57 HTTP_BEGIN_ARGS(setCache
, 1)
58 HTTP_ARG_VAL(cache
, 0)
61 HTTP_EMPTY_ARGS(getGzip
);
62 HTTP_BEGIN_ARGS(setGzip
, 1)
66 HTTP_EMPTY_ARGS(getCacheControl
);
67 HTTP_BEGIN_ARGS(setCacheControl
, 1)
68 HTTP_ARG_VAL(cache_control
, 0)
69 HTTP_ARG_VAL(max_age
, 0)
70 HTTP_ARG_VAL(must_revalidate
, 0)
73 HTTP_EMPTY_ARGS(getContentType
);
74 HTTP_BEGIN_ARGS(setContentType
, 1)
75 HTTP_ARG_VAL(content_type
, 0)
78 HTTP_BEGIN_ARGS(guessContentType
, 1)
79 HTTP_ARG_VAL(magic_file
, 0)
80 HTTP_ARG_VAL(magic_mode
, 0)
83 HTTP_EMPTY_ARGS(getContentDisposition
);
84 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
85 HTTP_ARG_VAL(filename
, 0)
86 HTTP_ARG_VAL(send_inline
, 0)
89 HTTP_EMPTY_ARGS(getThrottleDelay
);
90 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
91 HTTP_ARG_VAL(seconds
, 0)
94 HTTP_EMPTY_ARGS(getBufferSize
);
95 HTTP_BEGIN_ARGS(setBufferSize
, 1)
96 HTTP_ARG_VAL(bytes
, 0)
99 HTTP_EMPTY_ARGS(getData
);
100 HTTP_BEGIN_ARGS(setData
, 1)
101 HTTP_ARG_VAL(data
, 0)
104 HTTP_EMPTY_ARGS(getStream
);
105 HTTP_BEGIN_ARGS(setStream
, 1)
106 HTTP_ARG_VAL(stream
, 0)
109 HTTP_EMPTY_ARGS(getFile
);
110 HTTP_BEGIN_ARGS(setFile
, 1)
111 HTTP_ARG_VAL(filepath
, 0)
114 HTTP_BEGIN_ARGS(send
, 0)
115 HTTP_ARG_VAL(clean_ob
, 0)
118 HTTP_EMPTY_ARGS(capture
);
120 HTTP_BEGIN_ARGS(redirect
, 0)
122 HTTP_ARG_VAL(params
, 0)
123 HTTP_ARG_VAL(session
, 0)
124 HTTP_ARG_VAL(permanent
, 0)
127 HTTP_BEGIN_ARGS(status
, 1)
128 HTTP_ARG_VAL(code
, 0)
131 HTTP_EMPTY_ARGS(getRequestHeaders
);
132 HTTP_EMPTY_ARGS(getRequestBody
);
133 HTTP_EMPTY_ARGS(getRequestBodyStream
);
135 #define http_grab_response_headers _http_grab_response_headers
136 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
138 #define OBJ_PROP_CE http_response_object_ce
139 zend_class_entry
*http_response_object_ce
;
140 zend_function_entry http_response_object_fe
[] = {
142 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
143 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
145 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
146 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
148 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
149 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
151 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
152 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
154 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
155 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
157 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
159 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
162 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
178 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
181 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
184 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
187 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
188 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
189 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
190 HTTP_RESPONSE_ALIAS(getRequestBodyStream
, http_get_request_body_stream
)
195 PHP_MINIT_FUNCTION(http_response_object
)
197 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
199 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
200 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
201 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
202 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
203 DCL_STATIC_PROP_N(PRIVATE
, file
);
204 DCL_STATIC_PROP_N(PRIVATE
, data
);
205 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
206 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
207 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
208 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
209 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
210 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
211 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
212 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
213 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
216 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
217 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
218 DCL_CONST(long, "REDIRECT_FOUND", HTTP_REDIRECT_FOUND
);
219 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
220 DCL_CONST(long, "REDIRECT_PROXY", HTTP_REDIRECT_PROXY
);
221 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
227 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
229 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
230 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
233 /* ### USERLAND ### */
235 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
237 * Send an HTTP header.
239 * Expects a string parameter containing the name of the header and a mixed
240 * parameter containing the value of the header, which will be converted to
241 * a string. Additionally accepts an optional boolean parameter, which
242 * specifies whether an existing header should be replaced. If the second
243 * parameter is unset no header with this name will be sent.
245 * Returns TRUE on success, or FALSE on failure.
247 * Throws HttpHeaderException if http.only_exceptions is TRUE.
249 PHP_METHOD(HttpResponse
, setHeader
)
251 zend_bool replace
= 1;
254 zval
*value
= NULL
, *orig
= NULL
;
256 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
259 if (SG(headers_sent
)) {
260 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
264 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
268 /* delete header if value == null */
269 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
270 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
272 /* send multiple header if replace is false and value is an array */
273 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
277 FOREACH_VAL(pos
, value
, data
) {
280 convert_to_string_ex(data
);
281 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
293 /* send standard header */
295 convert_to_string_ex(&value
);
296 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
298 zval_ptr_dtor(&value
);
303 /* {{{ proto static mixed HttpResponse::getHeader([string name])
305 * Get header(s) about to be sent.
307 * Accepts a string as optional parameter which specifies the name of the
308 * header to read. If the parameter is empty or omitted, an associative array
309 * with all headers will be returned.
311 * NOTE: In Apache2 this only works for PHP-5.1.3 and greater.
313 * Returns either a string containing the value of the header matching name,
314 * FALSE on failure, or an associative array with all headers.
316 PHP_METHOD(HttpResponse
, getHeader
)
322 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
326 phpstr_init(&headers
);
327 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
328 phpstr_fix(&headers
);
330 if (name
&& name_len
) {
332 HashTable headers_ht
;
334 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
335 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
336 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void *) &header
))) {
337 RETVAL_ZVAL(*header
, 1, 0);
341 zend_hash_destroy(&headers_ht
);
343 array_init(return_value
);
344 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
347 phpstr_dtor(&headers
);
351 /* {{{ proto static bool HttpResponse::setCache(bool cache)
353 * Whether it should be attempted to cache the entity.
354 * This will result in necessary caching headers and checks of clients
355 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
356 * matches a "304 Not Modified" status code will be issued.
358 * NOTE: If you're using sessions, be sure that you set session.cache_limiter
359 * to something more appropriate than "no-cache"!
361 * Expects a boolean as parameter specifying whether caching should be attempted.
363 * Returns TRUE on success, or FALSE on failure.
365 PHP_METHOD(HttpResponse
, setCache
)
367 zend_bool do_cache
= 0;
369 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
373 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
377 /* {{{ proto static bool HttpResponse::getCache()
379 * Get current caching setting.
381 * Returns TRUE if caching should be attempted, else FALSE.
383 PHP_METHOD(HttpResponse
, getCache
)
387 if (return_value_used
) {
388 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
390 RETVAL_ZVAL(cache
, 1, 0);
393 zval_ptr_dtor(&cache_p
);
399 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
401 * Enable on-thy-fly gzipping of the sent entity.
403 * Expects a boolean as parameter indicating if GZip compression should be enabled.
405 * Returns TRUE on success, or FALSE on failure.
407 PHP_METHOD(HttpResponse
, setGzip
)
409 zend_bool do_gzip
= 0;
411 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
415 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
419 /* {{{ proto static bool HttpResponse::getGzip()
421 * Get current gzipping setting.
423 * Returns TRUE if GZip compression is enabled, else FALSE.
425 PHP_METHOD(HttpResponse
, getGzip
)
429 if (return_value_used
) {
430 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
432 RETVAL_ZVAL(gzip
, 1, 0);
435 zval_ptr_dtor(&gzip_p
);
441 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0[, bool must_revalidate = true]])
443 * Set a custom cache-control header, usually being "private" or "public";
444 * The max_age parameter controls how long the cache entry is valid on the client side.
446 * Expects a string parameter containing the primary cache control setting.
447 * Additionally accepts an int parameter specifying the max-age setting.
448 * Accepts an optional third bool parameter indicating whether the cache
449 * must be revalidated every request.
451 * Returns TRUE on success, or FALSE if control does not match one of
452 * "public" , "private" or "no-cache".
454 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
456 PHP_METHOD(HttpResponse
, setCacheControl
)
458 char *ccontrol
, *cctl
;
461 zend_bool must_revalidate
= 1;
463 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|lb", &ccontrol
, &cc_len
, &max_age
, &must_revalidate
)) {
467 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
468 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
471 size_t cctl_len
= spprintf(&cctl
, 0, "%s,%s max-age=%ld", ccontrol
, must_revalidate
?" must-revalidate,":"", max_age
);
472 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
478 /* {{{ proto static string HttpResponse::getCacheControl()
480 * Get current Cache-Control header setting.
482 * Returns the current cache control setting as a string like sent in a header.
484 PHP_METHOD(HttpResponse
, getCacheControl
)
488 if (return_value_used
) {
489 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
491 RETVAL_ZVAL(ccontrol
, 1, 0);
494 zval_ptr_dtor(&ccontrol_p
);
500 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
502 * Set the content-type of the sent entity.
504 * Expects a string as parameter specifying the content type of the sent entity.
506 * Returns TRUE on success, or FALSE if the content type does not seem to
507 * contain a primary and secondary content type part.
509 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
511 PHP_METHOD(HttpResponse
, setContentType
)
516 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
520 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
521 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
525 /* {{{ proto static string HttpResponse::getContentType()
527 * Get current Content-Type header setting.
529 * Returns the currently set content type as string.
531 PHP_METHOD(HttpResponse
, getContentType
)
535 if (return_value_used
) {
536 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
538 RETVAL_ZVAL(ctype
, 1, 0);
541 zval_ptr_dtor(&ctype_p
);
547 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
549 * Attempts to guess the content type of supplied payload through libmagic.
550 * If the attempt is successful, the guessed content type will automatically
551 * be set as response content type.
553 * Expects a string parameter specifying the magic.mime database to use.
554 * Additionally accepts an optional int parameter, being flags for libmagic.
556 * Returns the guessed content type on success, or FALSE on failure.
558 * Throws HttpRuntimeException, HttpInvalidParamException
559 * if http.only_exceptions is TRUE.
561 PHP_METHOD(HttpResponse
, guessContentType
)
563 #ifdef HTTP_HAVE_MAGIC
564 char *magic_file
, *ct
= NULL
;
566 long magic_mode
= MAGIC_MIME
;
570 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
571 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
574 zval
*data
= GET_STATIC_PROP(data
);
575 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
582 zval
*z
= GET_STATIC_PROP(stream
);
583 z
->type
= IS_RESOURCE
;
584 php_stream_from_zval(s
, &z
);
585 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
590 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
594 UPD_STATIC_PROP(string
, contentType
, ct
);
595 RETVAL_STRING(ct
, 0);
600 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
606 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
608 * Set the Content-Disposition. The Content-Disposition header is very useful
609 * if the data actually sent came from a file or something similar, that should
610 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
612 * Expects a string parameter specifying the file name the "Save as..." dialog
613 * should display. Optionally accepts a bool parameter, which, if set to true
614 * and the user agent knows how to handle the content type, will probably not
615 * cause the popup window to be shown.
617 * Returns TRUE on success or FALSE on failure.
619 PHP_METHOD(HttpResponse
, setContentDisposition
)
624 zend_bool send_inline
= 0;
626 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
630 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
631 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
636 /* {{{ proto static string HttpResponse::getContentDisposition()
638 * Get current Content-Disposition setting.
640 * Returns the current content disposition as string like sent in a header.
642 PHP_METHOD(HttpResponse
, getContentDisposition
)
646 if (return_value_used
) {
647 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
649 RETVAL_ZVAL(cd
, 1, 0);
652 zval_ptr_dtor(&cd_p
);
658 /* {{{ proto static bool HttpResponse::setETag(string etag)
660 * Set a custom ETag. Use this only if you know what you're doing.
662 * Expects an unquoted string as parameter containing the ETag.
664 * Returns TRUE on success, or FALSE on failure.
666 PHP_METHOD(HttpResponse
, setETag
)
671 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
675 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
679 /* {{{ proto static string HttpResponse::getETag()
681 * Get calculated or previously set custom ETag.
683 * Returns the calculated or previously set ETag as unquoted string.
685 PHP_METHOD(HttpResponse
, getETag
)
689 if (return_value_used
) {
690 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
692 RETVAL_ZVAL(etag
, 1, 0);
695 zval_ptr_dtor(&etag_p
);
701 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
703 * Set a custom Last-Modified date.
705 * Expects an unix timestamp as parameter representing the last modification
706 * time of the sent entity.
708 * Returns TRUE on success, or FALSE on failure.
710 PHP_METHOD(HttpResponse
, setLastModified
)
714 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
718 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
722 /* {{{ proto static int HttpResponse::getLastModified()
724 * Get calculated or previously set custom Last-Modified date.
726 * Returns the calculated or previously set unix timestamp.
728 PHP_METHOD(HttpResponse
, getLastModified
)
732 if (return_value_used
) {
733 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
735 RETVAL_ZVAL(lm
, 1, 0);
738 zval_ptr_dtor(&lm_p
);
744 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
746 * Sets the throttle delay for use with HttpResponse::setBufferSize().
748 * Provides a basic throttling mechanism, which will yield the current process
749 * resp. thread until the entity has been completely sent, though.
751 * Note: This doesn't really work with the FastCGI SAPI.
753 * Expects a double parameter specifying the seconds too sleep() after
756 * Returns TRUE on success, or FALSE on failure.
758 PHP_METHOD(HttpResponse
, setThrottleDelay
)
762 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
765 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
769 /* {{{ proto static double HttpResponse::getThrottleDelay()
771 * Get the current throttle delay.
773 * Returns a double representing the throttle delay in seconds.
775 PHP_METHOD(HttpResponse
, getThrottleDelay
)
779 if (return_value_used
) {
780 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
782 RETVAL_ZVAL(delay
, 1, 0);
785 zval_ptr_dtor(&delay_p
);
791 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
793 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
795 * Provides a basic throttling mechanism, which will yield the current process
796 * resp. thread until the entity has been completely sent, though.
798 * Note: This doesn't really work with the FastCGI SAPI.
800 * Expects an int parameter representing the chunk size in bytes.
802 * Returns TRUE on success, or FALSE on failure.
804 PHP_METHOD(HttpResponse
, setBufferSize
)
808 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
811 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
815 /* {{{ proto static int HttpResponse::getBufferSize()
817 * Get current buffer size.
819 * Returns an int representing the current buffer size in bytes.
821 PHP_METHOD(HttpResponse
, getBufferSize
)
825 if (return_value_used
) {
826 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
828 RETVAL_ZVAL(size
, 1, 0);
831 zval_ptr_dtor(&size_p
);
837 /* {{{ proto static bool HttpResponse::setData(mixed data)
839 * Set the data to be sent.
841 * Expects one parameter, which will be converted to a string and contains
844 * Returns TRUE on success, or FALSE on failure.
846 PHP_METHOD(HttpResponse
, setData
)
851 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
854 if (Z_TYPE_P(the_data
) != IS_STRING
) {
855 convert_to_string_ex(&the_data
);
858 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
859 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
863 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
864 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
865 UPD_STATIC_PROP(string
, eTag
, etag
);
873 /* {{{ proto static string HttpResponse::getData()
875 * Get the previously set data to be sent.
877 * Returns a string containing the previously set data to send.
879 PHP_METHOD(HttpResponse
, getData
)
883 if (return_value_used
) {
884 zval
*the_data
= GET_STATIC_PROP(data
);
886 RETURN_ZVAL(the_data
, 1, 0);
891 /* {{{ proto static bool HttpResponse::setStream(resource stream)
893 * Set the resource to be sent.
895 * Expects a resource parameter referencing an already opened stream from
896 * which the data to send will be read.
898 * Returns TRUE on success, or FALSE on failure.
900 PHP_METHOD(HttpResponse
, setStream
)
904 php_stream
*the_real_stream
;
905 php_stream_statbuf ssb
;
907 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
911 php_stream_from_zval(the_real_stream
, &the_stream
);
912 if (php_stream_stat(the_real_stream
, &ssb
)) {
916 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
917 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
920 zend_list_addref(Z_LVAL_P(the_stream
));
922 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
923 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
924 UPD_STATIC_PROP(string
, eTag
, etag
);
932 /* {{{ proto static resource HttpResponse::getStream()
934 * Get the previously set resource to be sent.
936 * Returns the previously set resource.
938 PHP_METHOD(HttpResponse
, getStream
)
942 if (return_value_used
) {
945 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
948 zval_ptr_dtor(&stream_p
);
954 /* {{{ proto static bool HttpResponse::setFile(string file)
956 * Set the file to be sent.
958 * Expects a string as parameter, specifying the path to the file to send.
960 * Returns TRUE on success, or FALSE on failure.
962 PHP_METHOD(HttpResponse
, setFile
)
964 char *the_file
, *etag
;
966 php_stream_statbuf ssb
;
968 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
972 if (php_stream_stat_path(the_file
, &ssb
)) {
976 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
977 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
981 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
982 if ((etag
= http_etag(the_file
, 0, -1))) {
983 UPD_STATIC_PROP(string
, eTag
, etag
);
991 /* {{{ proto static string HttpResponse::getFile()
993 * Get the previously set file to be sent.
995 * Returns the previously set path to the file to send as string.
997 PHP_METHOD(HttpResponse
, getFile
)
1001 if (return_value_used
) {
1002 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1004 RETVAL_ZVAL(the_file
, 1, 0);
1007 zval_ptr_dtor(&the_file_p
);
1013 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1015 * Finally send the entity.
1017 * Accepts an optional boolean parameter, specifying whether the output
1018 * buffers should be discarded prior sending. A successful caching attempt
1019 * will cause a script termination, and write a log entry if the INI setting
1020 * http.cache_log is set.
1022 * Returns TRUE on success, or FALSE on failure.
1024 * Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.
1029 * HttpResponse::setCache(true);
1030 * HttpResponse::setContentType('application/pdf');
1031 * HttpResponse::setContentDisposition("$user.pdf", false);
1032 * HttpResponse::setFile('sheet.pdf');
1033 * HttpResponse::send();
1037 PHP_METHOD(HttpResponse
, send
)
1040 zend_bool clean_ob
= 1;
1042 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1046 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1048 sent
= GET_STATIC_PROP(sent
);
1049 if (Z_LVAL_P(sent
)) {
1050 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1057 if (zval_is_true(GET_STATIC_PROP(catch))) {
1058 zval
*etag_p
, *the_data
;
1060 MAKE_STD_ZVAL(the_data
);
1061 php_ob_get_buffer(the_data TSRMLS_CC
);
1062 SET_STATIC_PROP(data
, the_data
);
1063 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1065 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1066 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1068 UPD_STATIC_PROP(string
, eTag
, etag
);
1072 zval_ptr_dtor(&the_data
);
1075 zval_ptr_dtor(&etag_p
);
1082 /* interrupt on-the-fly etag generation */
1083 HTTP_G
->etag
.started
= 0;
1084 /* discard previous output buffers */
1085 php_end_ob_buffers(0 TSRMLS_CC
);
1089 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1090 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1092 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1093 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1094 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1096 if (Z_LVAL_P(lmod
) || Z_STRLEN_P(etag
)) {
1097 if (Z_STRLEN_P(cctl
)) {
1098 http_send_cache_control(Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1100 http_send_cache_control(HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
));
1102 if (Z_STRLEN_P(etag
)) {
1103 http_send_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
));
1105 if (Z_LVAL_P(lmod
)) {
1106 http_send_last_modified(Z_LVAL_P(lmod
));
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
);
1117 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1118 if (Z_STRLEN_P(ctype
)) {
1119 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1121 char *ctypes
= INI_STR("default_mimetype");
1122 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1125 http_send_content_type(ctypes
, ctlen
);
1127 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1131 zval_ptr_dtor(&ctype_p
);
1135 /* content disposition */
1137 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1138 if (Z_STRLEN_P(cd
)) {
1139 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1142 zval_ptr_dtor(&cd_p
);
1148 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1149 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1150 HTTP_G
->send
.buffer_size
= Z_LVAL_P(bsize
);
1151 HTTP_G
->send
.throttle_delay
= Z_DVAL_P(delay
);
1152 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1153 if (delay_p
) zval_ptr_dtor(&delay_p
);
1157 HTTP_G
->send
.deflate
.encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1160 php_start_ob_buffer(NULL
, HTTP_G
->send
.buffer_size
, 0 TSRMLS_CC
);
1163 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
1166 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1167 RETVAL_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
1168 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1174 php_stream
*the_real_stream
;
1175 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1176 the_stream
->type
= IS_RESOURCE
;
1177 php_stream_from_zval(the_real_stream
, &the_stream
);
1178 RETVAL_SUCCESS(http_send_stream(the_real_stream
));
1179 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1186 RETVAL_SUCCESS(http_send_file(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
))));
1187 if (file_p
) zval_ptr_dtor(&file_p
);
1194 /* {{{ proto static void HttpResponse::capture()
1196 * Capture script output.
1201 * HttpResponse::setCache(true);
1202 * HttpResponse::capture();
1207 PHP_METHOD(HttpResponse
, capture
)
1211 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1213 UPD_STATIC_PROP(long, catch, 1);
1215 php_end_ob_buffers(0 TSRMLS_CC
);
1216 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1218 /* register shutdown function */
1220 zval func
, retval
, arg
, *argp
[1];
1224 INIT_PZVAL(&retval
);
1225 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1228 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1229 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1231 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1237 #endif /* ZEND_ENGINE_2 && !WONKY */
1244 * vim600: noet sw=4 ts=4 fdm=marker
1245 * vim<600: noet sw=4 ts=4