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_MAGIC
42 ZEND_EXTERN_MODULE_GLOBALS(http
);
44 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
45 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
46 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
47 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
49 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
50 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
51 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
52 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
54 HTTP_BEGIN_ARGS(setHeader
, 2)
56 HTTP_ARG_VAL(value
, 0)
57 HTTP_ARG_VAL(replace
, 0)
60 HTTP_BEGIN_ARGS(getHeader
, 0)
64 HTTP_EMPTY_ARGS(getETag
, 0);
65 HTTP_BEGIN_ARGS(setETag
, 1)
69 HTTP_EMPTY_ARGS(getLastModified
, 0);
70 HTTP_BEGIN_ARGS(setLastModified
, 1)
71 HTTP_ARG_VAL(timestamp
, 0)
74 HTTP_EMPTY_ARGS(getCache
, 0);
75 HTTP_BEGIN_ARGS(setCache
, 1)
76 HTTP_ARG_VAL(cache
, 0)
79 HTTP_EMPTY_ARGS(getGzip
, 0);
80 HTTP_BEGIN_ARGS(setGzip
, 1)
84 HTTP_EMPTY_ARGS(getCacheControl
, 0);
85 HTTP_BEGIN_ARGS(setCacheControl
, 1)
86 HTTP_ARG_VAL(cache_control
, 0)
87 HTTP_ARG_VAL(max_age
, 0)
90 HTTP_EMPTY_ARGS(getContentType
, 0);
91 HTTP_BEGIN_ARGS(setContentType
, 1)
92 HTTP_ARG_VAL(content_type
, 0)
95 HTTP_BEGIN_ARGS(guessContentType
, 1)
96 HTTP_ARG_VAL(magic_file
, 0)
97 HTTP_ARG_VAL(magic_mode
, 0)
100 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
101 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
102 HTTP_ARG_VAL(filename
, 0)
103 HTTP_ARG_VAL(send_inline
, 0)
106 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
107 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
108 HTTP_ARG_VAL(seconds
, 0)
111 HTTP_EMPTY_ARGS(getBufferSize
, 0);
112 HTTP_BEGIN_ARGS(setBufferSize
, 1)
113 HTTP_ARG_VAL(bytes
, 0)
116 HTTP_EMPTY_ARGS(getData
, 0);
117 HTTP_BEGIN_ARGS(setData
, 1)
118 HTTP_ARG_VAL(data
, 0)
121 HTTP_EMPTY_ARGS(getStream
, 0);
122 HTTP_BEGIN_ARGS(setStream
, 1)
123 HTTP_ARG_VAL(stream
, 0)
126 HTTP_EMPTY_ARGS(getFile
, 0);
127 HTTP_BEGIN_ARGS(setFile
, 1)
128 HTTP_ARG_VAL(filepath
, 0)
131 HTTP_BEGIN_ARGS(send
, 0)
132 HTTP_ARG_VAL(clean_ob
, 0)
135 HTTP_EMPTY_ARGS(capture
, 0);
137 HTTP_BEGIN_ARGS(redirect
, 0)
139 HTTP_ARG_VAL(params
, 0)
140 HTTP_ARG_VAL(session
, 0)
141 HTTP_ARG_VAL(permanent
, 0)
144 HTTP_BEGIN_ARGS(status
, 1)
145 HTTP_ARG_VAL(code
, 0)
148 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
149 HTTP_EMPTY_ARGS(getRequestBody
, 0);
151 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
152 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
153 #define http_grab_response_headers _http_grab_response_headers
154 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
156 zend_class_entry
*http_response_object_ce
;
157 zend_function_entry http_response_object_fe
[] = {
159 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
162 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
176 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
179 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
182 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
185 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
188 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
191 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
194 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
197 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
198 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
200 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
201 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
203 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
204 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
205 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
206 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
211 PHP_MINIT_FUNCTION(http_response_object
)
213 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
214 http_response_object_declare_default_properties();
218 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
220 zend_class_entry
*ce
= http_response_object_ce
;
222 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
223 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
224 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
225 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
226 DCL_STATIC_PROP_N(PRIVATE
, file
);
227 DCL_STATIC_PROP_N(PRIVATE
, data
);
228 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
229 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
230 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
231 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
232 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
233 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
234 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
235 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
236 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
239 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
240 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
241 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
242 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
246 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
248 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
249 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
252 /* ### USERLAND ### */
254 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
256 * Send an HTTP header.
258 * Expects a string parameter containing the name of the header and a mixed
259 * parameter containing the value of the header, which will be converted to
260 * a string. Additionally accepts an optional boolean parameter, which
261 * specifies whether an existing header should be replaced. If the second
262 * parameter is unset no header with this name will be sent.
264 * Returns TRUE on success, or FALSE on failure.
266 * Throws HttpHeaderException if http.only_exceptions is TRUE.
268 PHP_METHOD(HttpResponse
, setHeader
)
270 zend_bool replace
= 1;
273 zval
*value
= NULL
, *orig
= NULL
;
275 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
278 if (SG(headers_sent
)) {
279 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
283 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
287 /* delete header if value == null */
288 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
289 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
291 /* send multiple header if replace is false and value is an array */
292 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
296 FOREACH_VAL(pos
, value
, data
) {
299 convert_to_string_ex(data
);
300 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
312 /* send standard header */
314 convert_to_string_ex(&value
);
315 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
317 zval_ptr_dtor(&value
);
322 /* {{{ proto static mixed HttpResponse::getHeader([string name])
324 * Get header(s) about to be sent.
326 * Accepts a string as optional parameter which specifies the name of the
327 * header to read. If the parameter is empty or omitted, an associative array
328 * with all headers will be returned.
330 * Returns either a string containing the value of the header matching name,
331 * FALSE on failure, or an associative array with all headers.
333 PHP_METHOD(HttpResponse
, getHeader
)
339 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
343 phpstr_init(&headers
);
344 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
345 phpstr_fix(&headers
);
347 if (name
&& name_len
) {
349 HashTable headers_ht
;
351 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
352 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
353 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
354 RETVAL_ZVAL(*header
, 1, 0);
358 zend_hash_destroy(&headers_ht
);
360 array_init(return_value
);
361 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
364 phpstr_dtor(&headers
);
368 /* {{{ proto static bool HttpResponse::setCache(bool cache)
370 * Whether it sould be attempted to cache the entitity.
371 * This will result in necessary caching headers and checks of clients
372 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
373 * matches a "304 Not Modified" status code will be issued.
375 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
376 * to something more appropriate than "no-cache"!
378 * Expects a boolean as parameter specifying whether caching should be attempted.
380 * Returns TRUE ons success, or FALSE on failure.
382 PHP_METHOD(HttpResponse
, setCache
)
384 zend_bool do_cache
= 0;
386 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
390 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
394 /* {{{ proto static bool HttpResponse::getCache()
396 * Get current caching setting.
398 * Returns TRUE if caching should be attempted, else FALSE.
400 PHP_METHOD(HttpResponse
, getCache
)
405 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
407 RETVAL_ZVAL(cache
, 1, 0);
410 zval_ptr_dtor(&cache_p
);
416 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
418 * Enable on-thy-fly gzipping of the sent entity.
420 * Expects a boolean as parameter indicating if GZip compression should be enabled.
422 * Returns TRUE on success, or FALSE on failure.
424 PHP_METHOD(HttpResponse
, setGzip
)
426 zend_bool do_gzip
= 0;
428 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
432 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
436 /* {{{ proto static bool HttpResponse::getGzip()
438 * Get current gzipping setting.
440 * Returns TRUE if GZip compression is enabled, else FALSE.
442 PHP_METHOD(HttpResponse
, getGzip
)
447 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
449 RETVAL_ZVAL(gzip
, 1, 0);
452 zval_ptr_dtor(&gzip_p
);
458 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
460 * Set a custom cache-control header, usually being "private" or "public";
461 * The max_age parameter controls how long the cache entry is valid on the client side.
463 * Expects a string parameter containing the primary cache control setting.
464 * Addtitionally accepts an int parameter specifying the max-age setting.
466 * Returns TRUE on success, or FALSE if control does not match one of
467 * "public" , "private" or "no-cache".
469 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
471 PHP_METHOD(HttpResponse
, setCacheControl
)
473 char *ccontrol
, *cctl
;
477 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
481 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
482 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
485 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max-age=%ld", ccontrol
, max_age
);
486 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
492 /* {{{ proto static string HttpResponse::getCacheControl()
494 * Get current Cache-Control header setting.
496 * Returns the current cache control setting as a string like sent in a header.
498 PHP_METHOD(HttpResponse
, getCacheControl
)
503 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
505 RETVAL_ZVAL(ccontrol
, 1, 0);
508 zval_ptr_dtor(&ccontrol_p
);
514 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
516 * Set the content-type of the sent entity.
518 * Expects a string as parameter specifying the content type of the sent entity.
520 * Returns TRUE on success, or FALSE if the content type does not seem to
521 * contain a primary and secondary content type part.
523 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
525 PHP_METHOD(HttpResponse
, setContentType
)
530 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
534 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
535 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
539 /* {{{ proto static string HttpResponse::getContentType()
541 * Get current Content-Type header setting.
543 * Returns the currently set content type as string.
545 PHP_METHOD(HttpResponse
, getContentType
)
550 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
552 RETVAL_ZVAL(ctype
, 1, 0);
555 zval_ptr_dtor(&ctype_p
);
561 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
563 * Attempts to guess the content type of supplied payload through libmagic.
564 * If the attempt is successful, the guessed content type will automatically
565 * be set as response content type.
567 * Expects a string parameter specifying the magic.mime database to use.
568 * Additionally accepts an optional int parameter, being flags for libmagic.
570 * Returns the guessed content type on success, or FALSE on failure.
572 * Throws HttpRuntimeException, HttpInvalidParamException
573 * if http.only_exceptions is TRUE.
575 PHP_METHOD(HttpResponse
, guessContentType
)
577 char *magic_file
, *ct
= NULL
;
583 #ifdef HTTP_HAVE_MAGIC
584 magic_mode
= MAGIC_MIME
;
587 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
588 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
591 zval
*data
= GET_STATIC_PROP(data
);
592 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
599 zval
*z
= GET_STATIC_PROP(stream
);
600 z
->type
= IS_RESOURCE
;
601 php_stream_from_zval(s
, &z
);
602 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
607 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
611 UPD_STATIC_PROP(string
, contentType
, ct
);
612 RETVAL_STRING(ct
, 0);
617 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
622 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
624 * Set the Content-Disposition. The Content-Disposition header is very useful
625 * if the data actually sent came from a file or something similar, that should
626 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
628 * Expects a string parameter specifying the file name the "Save as..." dialogue
629 * should display. Optionally accepts a bool parameter, which, if set to true
630 * and the user agent knows how to handle the content type, will probably not
631 * cause the popup window to be shown.
633 * Returns TRUE on success or FALSE on failure.
635 PHP_METHOD(HttpResponse
, setContentDisposition
)
640 zend_bool send_inline
= 0;
642 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
646 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
647 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
652 /* {{{ proto static string HttpResponse::getContentDisposition()
654 * Get current Content-Disposition setting.
656 * Returns the current content disposition as string like sent in a header.
658 PHP_METHOD(HttpResponse
, getContentDisposition
)
663 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
665 RETVAL_ZVAL(cd
, 1, 0);
668 zval_ptr_dtor(&cd_p
);
674 /* {{{ proto static bool HttpResponse::setETag(string etag)
676 * Set a custom ETag. Use this only if you know what you're doing.
678 * Expects an unquoted string as parameter containing the ETag.
680 * Returns TRUE on success, or FALSE on failure.
682 PHP_METHOD(HttpResponse
, setETag
)
687 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
691 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
695 /* {{{ proto static string HttpResponse::getETag()
697 * Get calculated or previously set custom ETag.
699 * Returns the calculated or previously set ETag as unquoted string.
701 PHP_METHOD(HttpResponse
, getETag
)
706 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
708 RETVAL_ZVAL(etag
, 1, 0);
711 zval_ptr_dtor(&etag_p
);
717 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
719 * Set a custom Last-Modified date.
721 * Expects an unix timestamp as parameter representing the last modification
722 * time of the sent entity.
724 * Returns TRUE on success, or FALSE on failure.
726 PHP_METHOD(HttpResponse
, setLastModified
)
730 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
734 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
738 /* {{{ proto static int HttpResponse::getLastModified()
740 * Get calculated or previously set custom Last-Modified date.
742 * Returns the calculated or previously set unix timestamp.
744 PHP_METHOD(HttpResponse
, getLastModified
)
749 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
751 RETVAL_ZVAL(lm
, 1, 0);
754 zval_ptr_dtor(&lm_p
);
760 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
762 * Sets the throttle delay for use with HttpResponse::setBufferSize().
764 * Provides a basic throttling mechanism, which will yield the current process
765 * resp. thread until the entity has been completely sent, though.
767 * Note: This doesn't really work with the FastCGI SAPI.
769 * Expects a double parameter specifying the seconds too sleep() after
772 * Returns TRUE on success, or FALSE on failure.
774 PHP_METHOD(HttpResponse
, setThrottleDelay
)
778 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
781 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
785 /* {{{ proto static double HttpResponse::getThrottleDelay()
787 * Get the current throttle delay.
789 * Returns a double representing the throttle delay in seconds.
791 PHP_METHOD(HttpResponse
, getThrottleDelay
)
796 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
798 RETVAL_ZVAL(delay
, 1, 0);
801 zval_ptr_dtor(&delay_p
);
807 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
809 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
811 * Provides a basic throttling mechanism, which will yield the current process
812 * resp. thread until the entity has been completely sent, though.
814 * Note: This doesn't really work with the FastCGI SAPI.
816 * Expects an int parameter representing the chunk size in bytes.
818 * Returns TRUE on success, or FALSE on failure.
820 PHP_METHOD(HttpResponse
, setBufferSize
)
824 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
827 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
831 /* {{{ proto static int HttpResponse::getBufferSize()
833 * Get current buffer size.
835 * Returns an int representing the current buffer size in bytes.
837 PHP_METHOD(HttpResponse
, getBufferSize
)
842 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
844 RETVAL_ZVAL(size
, 1, 0);
847 zval_ptr_dtor(&size_p
);
853 /* {{{ proto static bool HttpResponse::setData(mixed data)
855 * Set the data to be sent.
857 * Expects one parameter, which will be converted to a string and contains
860 * Returns TRUE on success, or FALSE on failure.
862 PHP_METHOD(HttpResponse
, setData
)
867 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
870 if (Z_TYPE_P(the_data
) != IS_STRING
) {
871 convert_to_string_ex(&the_data
);
874 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
875 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
879 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
880 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
881 UPD_STATIC_PROP(string
, eTag
, etag
);
889 /* {{{ proto static string HttpResponse::getData()
891 * Get the previously set data to be sent.
893 * Returns a string containing the previously set data to send.
895 PHP_METHOD(HttpResponse
, getData
)
900 zval
*the_data
= GET_STATIC_PROP(data
);
902 RETURN_ZVAL(the_data
, 1, 0);
907 /* {{{ proto static bool HttpResponse::setStream(resource stream)
909 * Set the resource to be sent.
911 * Expects a resource parameter referencing an already opened stream from
912 * which the data to send will be read.
914 * Returns TRUE on success, or FALSE on failure.
916 PHP_METHOD(HttpResponse
, setStream
)
920 php_stream
*the_real_stream
;
921 php_stream_statbuf ssb
;
923 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
927 php_stream_from_zval(the_real_stream
, &the_stream
);
928 if (php_stream_stat(the_real_stream
, &ssb
)) {
932 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
933 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
936 zend_list_addref(Z_LVAL_P(the_stream
));
938 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
939 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
940 UPD_STATIC_PROP(string
, eTag
, etag
);
948 /* {{{ proto static resource HttpResponse::getStream()
950 * Get the previously set resource to be sent.
952 * Returns the previously set resource.
954 PHP_METHOD(HttpResponse
, getStream
)
961 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
964 zval_ptr_dtor(&stream_p
);
970 /* {{{ proto static bool HttpResponse::setFile(string file)
972 * Set the file to be sent.
974 * Expects a string as parameter, specifying the path to the file to send.
976 * Returns TRUE on success, or FALSE on failure.
978 PHP_METHOD(HttpResponse
, setFile
)
980 char *the_file
, *etag
;
982 php_stream_statbuf ssb
;
984 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
988 if (php_stream_stat_path(the_file
, &ssb
)) {
992 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
993 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
997 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
998 if ((etag
= http_etag(the_file
, 0, -1))) {
999 UPD_STATIC_PROP(string
, eTag
, etag
);
1007 /* {{{ proto static string HttpResponse::getFile()
1009 * Get the previously set file to be sent.
1011 * Returns the previously set path to the file to send as string.
1013 PHP_METHOD(HttpResponse
, getFile
)
1018 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1020 RETVAL_ZVAL(the_file
, 1, 0);
1023 zval_ptr_dtor(&the_file_p
);
1029 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1031 * Finally send the entity.
1033 * Accepts an optional boolean parameter, specifying wheter the ouput
1034 * buffers should be discarded prior sending. A successful caching attempt
1035 * will cause a script termination, and write a log entry if the INI setting
1036 * http.cache_log is set.
1038 * Returns TRUE on success, or FALSE on failure.
1040 * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
1045 * HttpResponse::setCache(true);
1046 * HttpResponse::setContentType('application/pdf');
1047 * HttpResponse::setContentDisposition("$user.pdf", false);
1048 * HttpResponse::setFile('sheet.pdf');
1049 * HttpResponse::send();
1053 PHP_METHOD(HttpResponse
, send
)
1056 zend_bool clean_ob
= 1;
1058 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1062 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1064 sent
= GET_STATIC_PROP(sent
);
1065 if (Z_LVAL_P(sent
)) {
1066 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1073 if (zval_is_true(GET_STATIC_PROP(catch))) {
1074 zval
*etag_p
, *the_data
;
1076 MAKE_STD_ZVAL(the_data
);
1077 php_ob_get_buffer(the_data TSRMLS_CC
);
1078 SET_STATIC_PROP(data
, the_data
);
1079 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1081 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1082 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1084 UPD_STATIC_PROP(string
, eTag
, etag
);
1088 zval_ptr_dtor(&the_data
);
1091 zval_ptr_dtor(&etag_p
);
1098 /* interrupt on-the-fly etag generation */
1099 HTTP_G(etag
).started
= 0;
1100 /* discard previous output buffers */
1101 php_end_ob_buffers(0 TSRMLS_CC
);
1105 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1106 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1108 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1109 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1110 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1112 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1113 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
));
1115 if (etag_p
) zval_ptr_dtor(&etag_p
);
1116 if (lmod_p
) zval_ptr_dtor(&lmod_p
);
1117 if (cctl_p
) zval_ptr_dtor(&cctl_p
);
1119 if (php_ob_handler_used("blackhole" TSRMLS_CC
)) {
1126 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1127 if (Z_STRLEN_P(ctype
)) {
1128 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1130 char *ctypes
= INI_STR("default_mimetype");
1131 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1134 http_send_content_type(ctypes
, ctlen
);
1136 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1140 zval_ptr_dtor(&ctype_p
);
1144 /* content disposition */
1146 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1147 if (Z_STRLEN_P(cd
)) {
1148 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1151 zval_ptr_dtor(&cd_p
);
1157 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1158 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1159 HTTP_G(send
).buffer_size
= Z_LVAL_P(bsize
);
1160 HTTP_G(send
).throttle_delay
= Z_DVAL_P(delay
);
1161 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1162 if (delay_p
) zval_ptr_dtor(&delay_p
);
1166 HTTP_G(send
).gzip_encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1169 php_start_ob_buffer(NULL
, HTTP_G(send
).buffer_size
, 0 TSRMLS_CC
);
1172 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
1176 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1177 RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1178 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1184 php_stream
*the_real_stream
;
1185 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1186 the_stream
->type
= IS_RESOURCE
;
1187 php_stream_from_zval(the_real_stream
, &the_stream
);
1188 RETVAL_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1189 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1196 RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
)), 1));
1197 if (file_p
) zval_ptr_dtor(&file_p
);
1204 /* {{{ proto static void HttpResponse::capture()
1206 * Capture script output.
1211 * HttpResponse::setCache(true);
1212 * HttpResponse::capture();
1217 PHP_METHOD(HttpResponse
, capture
)
1221 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1223 UPD_STATIC_PROP(long, catch, 1);
1225 php_end_ob_buffers(0 TSRMLS_CC
);
1226 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1228 /* register shutdown function */
1230 zval func
, retval
, arg
, *argp
[1];
1234 INIT_PZVAL(&retval
);
1235 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1238 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1239 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1241 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1247 #endif /* ZEND_ENGINE_2 && !WONKY */
1254 * vim600: noet sw=4 ts=4 fdm=marker
1255 * vim<600: noet sw=4 ts=4