2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
23 /* broken static properties in PHP 5.0 */
24 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
30 #include "php_http_api.h"
31 #include "php_http_std_defs.h"
32 #include "php_http_response_object.h"
33 #include "php_http_exception_object.h"
34 #include "php_http_send_api.h"
35 #include "php_http_cache_api.h"
36 #include "php_http_headers_api.h"
38 #ifdef HTTP_HAVE_MHASH
41 #ifdef HTTP_HAVE_MAGIC
45 ZEND_EXTERN_MODULE_GLOBALS(http
);
47 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
48 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
49 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
50 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
52 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
53 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
54 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
55 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
57 HTTP_BEGIN_ARGS(setHeader
, 2)
59 HTTP_ARG_VAL(value
, 0)
60 HTTP_ARG_VAL(replace
, 0)
63 HTTP_BEGIN_ARGS(getHeader
, 0)
67 HTTP_EMPTY_ARGS(getETag
, 0);
68 HTTP_BEGIN_ARGS(setETag
, 1)
72 HTTP_EMPTY_ARGS(getLastModified
, 0);
73 HTTP_BEGIN_ARGS(setLastModified
, 1)
74 HTTP_ARG_VAL(timestamp
, 0)
77 HTTP_EMPTY_ARGS(getCache
, 0);
78 HTTP_BEGIN_ARGS(setCache
, 1)
79 HTTP_ARG_VAL(cache
, 0)
82 HTTP_EMPTY_ARGS(getGzip
, 0);
83 HTTP_BEGIN_ARGS(setGzip
, 1)
87 HTTP_EMPTY_ARGS(getCacheControl
, 0);
88 HTTP_BEGIN_ARGS(setCacheControl
, 1)
89 HTTP_ARG_VAL(cache_control
, 0)
90 HTTP_ARG_VAL(max_age
, 0)
93 HTTP_EMPTY_ARGS(getContentType
, 0);
94 HTTP_BEGIN_ARGS(setContentType
, 1)
95 HTTP_ARG_VAL(content_type
, 0)
98 HTTP_BEGIN_ARGS(guessContentType
, 1)
99 HTTP_ARG_VAL(magic_file
, 0)
100 HTTP_ARG_VAL(magic_mode
, 0)
103 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
104 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
105 HTTP_ARG_VAL(filename
, 0)
106 HTTP_ARG_VAL(send_inline
, 0)
109 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
110 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
111 HTTP_ARG_VAL(seconds
, 0)
114 HTTP_EMPTY_ARGS(getBufferSize
, 0);
115 HTTP_BEGIN_ARGS(setBufferSize
, 1)
116 HTTP_ARG_VAL(bytes
, 0)
119 HTTP_EMPTY_ARGS(getData
, 0);
120 HTTP_BEGIN_ARGS(setData
, 1)
121 HTTP_ARG_VAL(data
, 0)
124 HTTP_EMPTY_ARGS(getStream
, 0);
125 HTTP_BEGIN_ARGS(setStream
, 1)
126 HTTP_ARG_VAL(stream
, 0)
129 HTTP_EMPTY_ARGS(getFile
, 0);
130 HTTP_BEGIN_ARGS(setFile
, 1)
131 HTTP_ARG_VAL(filepath
, 0)
134 HTTP_BEGIN_ARGS(send
, 0)
135 HTTP_ARG_VAL(clean_ob
, 0)
138 HTTP_EMPTY_ARGS(capture
, 0);
140 HTTP_BEGIN_ARGS(redirect
, 0)
142 HTTP_ARG_VAL(params
, 0)
143 HTTP_ARG_VAL(session
, 0)
144 HTTP_ARG_VAL(permanent
, 0)
147 HTTP_BEGIN_ARGS(status
, 1)
148 HTTP_ARG_VAL(code
, 0)
151 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
152 HTTP_EMPTY_ARGS(getRequestBody
, 0);
154 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
155 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
156 #define http_grab_response_headers _http_grab_response_headers
157 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
159 zend_class_entry
*http_response_object_ce
;
160 zend_function_entry http_response_object_fe
[] = {
162 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
179 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
182 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
185 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
188 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
191 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
194 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
197 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
198 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
200 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
201 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
203 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
204 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
206 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
207 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
208 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
209 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
214 PHP_MINIT_FUNCTION(http_response_object
)
216 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
217 http_response_object_declare_default_properties();
221 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
223 zend_class_entry
*ce
= http_response_object_ce
;
225 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
226 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
227 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
228 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
229 DCL_STATIC_PROP_N(PRIVATE
, file
);
230 DCL_STATIC_PROP_N(PRIVATE
, data
);
231 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
232 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
233 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
234 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
235 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
236 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
237 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
238 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
239 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
242 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
243 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
244 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
245 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
247 DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5
);
248 DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1
);
249 DCL_CONST(long, "ETAG_CRC32", HTTP_ETAG_CRC32
);
251 # ifdef HTTP_HAVE_HASH_EXT
252 DCL_CONST(long, "ETAG_SHA256", HTTP_ETAG_SHA256
);
253 DCL_CONST(long, "ETAG_SHA384", HTTP_ETAG_SHA384
);
254 DCL_CONST(long, "ETAG_SHA512", HTTP_ETAG_SHA512
);
255 DCL_CONST(long, "ETAG_RIPEMD128", HTTP_ETAG_RIPEMD128
);
256 DCL_CONST(long, "ETAG_RIPEMD160", HTTP_ETAG_RIPEMD160
);
259 # ifdef HTTP_HAVE_MHASH
261 int l
, i
, c
= mhash_count();
263 for (i
= 0; i
<= c
; ++i
) {
264 char const_name
[256] = {0};
265 const char *hash_name
= mhash_get_hash_name_static(i
);
268 l
= snprintf(const_name
, 255, "ETAG_MHASH_%s", hash_name
);
269 zend_declare_class_constant_long(ce
, const_name
, l
, i TSRMLS_CC
);
273 # endif /* HTTP_HAVE_MHASH */
277 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
279 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
280 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
283 /* ### USERLAND ### */
285 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
287 * Send an HTTP header.
289 * Expects a string parameter containing the name of the header and a mixed
290 * parameter containing the value of the header, which will be converted to
291 * a string. Additionally accepts an optional boolean parameter, which
292 * specifies whether an existing header should be replaced. If the second
293 * parameter is unset no header with this name will be sent.
295 * Returns TRUE on success, or FALSE on failure.
297 * Throws HttpHeaderException if http.only_exceptions is TRUE.
299 PHP_METHOD(HttpResponse
, setHeader
)
301 zend_bool replace
= 1;
304 zval
*value
= NULL
, *orig
= NULL
;
306 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
309 if (SG(headers_sent
)) {
310 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
314 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
318 /* delete header if value == null */
319 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
320 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
322 /* send multiple header if replace is false and value is an array */
323 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
327 FOREACH_VAL(pos
, value
, data
) {
330 convert_to_string_ex(data
);
331 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
343 /* send standard header */
345 convert_to_string_ex(&value
);
346 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
348 zval_ptr_dtor(&value
);
353 /* {{{ proto static mixed HttpResponse::getHeader([string name])
355 * Get header(s) about to be sent.
357 * Accepts a string as optional parameter which specifies the name of the
358 * header to read. If the parameter is empty or omitted, an associative array
359 * with all headers will be returned.
361 * Returns either a string containing the value of the header matching name,
362 * FALSE on failure, or an associative array with all headers.
364 PHP_METHOD(HttpResponse
, getHeader
)
370 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
374 phpstr_init(&headers
);
375 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
376 phpstr_fix(&headers
);
378 if (name
&& name_len
) {
380 HashTable headers_ht
;
382 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
383 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
384 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
385 RETVAL_ZVAL(*header
, 1, 0);
389 zend_hash_destroy(&headers_ht
);
391 array_init(return_value
);
392 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
395 phpstr_dtor(&headers
);
399 /* {{{ proto static bool HttpResponse::setCache(bool cache)
401 * Whether it sould be attempted to cache the entitity.
402 * This will result in necessary caching headers and checks of clients
403 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
404 * matches a "304 Not Modified" status code will be issued.
406 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
407 * to something more appropriate than "no-cache"!
409 * Expects a boolean as parameter specifying whether caching should be attempted.
411 * Returns TRUE ons success, or FALSE on failure.
413 PHP_METHOD(HttpResponse
, setCache
)
415 zend_bool do_cache
= 0;
417 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
421 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
425 /* {{{ proto static bool HttpResponse::getCache()
427 * Get current caching setting.
429 * Returns TRUE if caching should be attempted, else FALSE.
431 PHP_METHOD(HttpResponse
, getCache
)
436 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
438 RETVAL_ZVAL(cache
, 1, 0);
441 zval_ptr_dtor(&cache_p
);
447 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
449 * Enable on-thy-fly gzipping of the sent entity.
451 * Expects a boolean as parameter indicating if GZip compression should be enabled.
453 * Returns TRUE on success, or FALSE on failure.
455 PHP_METHOD(HttpResponse
, setGzip
)
457 zend_bool do_gzip
= 0;
459 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
463 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
467 /* {{{ proto static bool HttpResponse::getGzip()
469 * Get current gzipping setting.
471 * Returns TRUE if GZip compression is enabled, else FALSE.
473 PHP_METHOD(HttpResponse
, getGzip
)
478 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
480 RETVAL_ZVAL(gzip
, 1, 0);
483 zval_ptr_dtor(&gzip_p
);
489 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
491 * Set a custom cache-control header, usually being "private" or "public";
492 * The max_age parameter controls how long the cache entry is valid on the client side.
494 * Expects a string parameter containing the primary cache control setting.
495 * Addtitionally accepts an int parameter specifying the max-age setting.
497 * Returns TRUE on success, or FALSE if control does not match one of
498 * "public" , "private" or "no-cache".
500 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
502 PHP_METHOD(HttpResponse
, setCacheControl
)
504 char *ccontrol
, *cctl
;
508 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
512 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
513 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
516 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max-age=%ld", ccontrol
, max_age
);
517 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
523 /* {{{ proto static string HttpResponse::getCacheControl()
525 * Get current Cache-Control header setting.
527 * Returns the current cache control setting as a string like sent in a header.
529 PHP_METHOD(HttpResponse
, getCacheControl
)
534 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
536 RETVAL_ZVAL(ccontrol
, 1, 0);
539 zval_ptr_dtor(&ccontrol_p
);
545 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
547 * Set the content-type of the sent entity.
549 * Expects a string as parameter specifying the content type of the sent entity.
551 * Returns TRUE on success, or FALSE if the content type does not seem to
552 * contain a primary and secondary content type part.
554 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
556 PHP_METHOD(HttpResponse
, setContentType
)
561 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
565 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
566 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
570 /* {{{ proto static string HttpResponse::getContentType()
572 * Get current Content-Type header setting.
574 * Returns the currently set content type as string.
576 PHP_METHOD(HttpResponse
, getContentType
)
581 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
583 RETVAL_ZVAL(ctype
, 1, 0);
586 zval_ptr_dtor(&ctype_p
);
592 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
594 * Attempts to guess the content type of supplied payload through libmagic.
595 * If the attempt is successful, the guessed content type will automatically
596 * be set as response content type.
598 * Expects a string parameter specifying the magic.mime database to use.
599 * Additionally accepts an optional int parameter, being flags for libmagic.
601 * Returns the guessed content type on success, or FALSE on failure.
603 * Throws HttpRuntimeException, HttpInvalidParamException
604 * if http.only_exceptions is TRUE.
606 PHP_METHOD(HttpResponse
, guessContentType
)
608 char *magic_file
, *ct
= NULL
;
614 #ifdef HTTP_HAVE_MAGIC
615 magic_mode
= MAGIC_MIME
;
618 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
619 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
622 zval
*data
= GET_STATIC_PROP(data
);
623 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
630 zval
*z
= GET_STATIC_PROP(stream
);
631 z
->type
= IS_RESOURCE
;
632 php_stream_from_zval(s
, &z
);
633 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
638 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
642 UPD_STATIC_PROP(string
, contentType
, ct
);
643 RETVAL_STRING(ct
, 0);
648 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
653 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
655 * Set the Content-Disposition. The Content-Disposition header is very useful
656 * if the data actually sent came from a file or something similar, that should
657 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
659 * Expects a string parameter specifying the file name the "Save as..." dialogue
660 * should display. Optionally accepts a bool parameter, which, if set to true
661 * and the user agent knows how to handle the content type, will probably not
662 * cause the popup window to be shown.
664 * Returns TRUE on success or FALSE on failure.
666 PHP_METHOD(HttpResponse
, setContentDisposition
)
671 zend_bool send_inline
= 0;
673 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
677 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
678 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
683 /* {{{ proto static string HttpResponse::getContentDisposition()
685 * Get current Content-Disposition setting.
687 * Returns the current content disposition as string like sent in a header.
689 PHP_METHOD(HttpResponse
, getContentDisposition
)
694 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
696 RETVAL_ZVAL(cd
, 1, 0);
699 zval_ptr_dtor(&cd_p
);
705 /* {{{ proto static bool HttpResponse::setETag(string etag)
707 * Set a custom ETag. Use this only if you know what you're doing.
709 * Expects an unquoted string as parameter containing the ETag.
711 * Returns TRUE on success, or FALSE on failure.
713 PHP_METHOD(HttpResponse
, setETag
)
718 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
722 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
726 /* {{{ proto static string HttpResponse::getETag()
728 * Get calculated or previously set custom ETag.
730 * Returns the calculated or previously set ETag as unquoted string.
732 PHP_METHOD(HttpResponse
, getETag
)
737 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
739 RETVAL_ZVAL(etag
, 1, 0);
742 zval_ptr_dtor(&etag_p
);
748 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
750 * Set a custom Last-Modified date.
752 * Expects an unix timestamp as parameter representing the last modification
753 * time of the sent entity.
755 * Returns TRUE on success, or FALSE on failure.
757 PHP_METHOD(HttpResponse
, setLastModified
)
761 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
765 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
769 /* {{{ proto static int HttpResponse::getLastModified()
771 * Get calculated or previously set custom Last-Modified date.
773 * Returns the calculated or previously set unix timestamp.
775 PHP_METHOD(HttpResponse
, getLastModified
)
780 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
782 RETVAL_ZVAL(lm
, 1, 0);
785 zval_ptr_dtor(&lm_p
);
791 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
793 * Sets the throttle delay for use with HttpResponse::setBufferSize().
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 a double parameter specifying the seconds too sleep() after
803 * Returns TRUE on success, or FALSE on failure.
805 PHP_METHOD(HttpResponse
, setThrottleDelay
)
809 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
812 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
816 /* {{{ proto static double HttpResponse::getThrottleDelay()
818 * Get the current throttle delay.
820 * Returns a double representing the throttle delay in seconds.
822 PHP_METHOD(HttpResponse
, getThrottleDelay
)
827 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
829 RETVAL_ZVAL(delay
, 1, 0);
832 zval_ptr_dtor(&delay_p
);
838 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
840 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
842 * Provides a basic throttling mechanism, which will yield the current process
843 * resp. thread until the entity has been completely sent, though.
845 * Note: This doesn't really work with the FastCGI SAPI.
847 * Expects an int parameter representing the chunk size in bytes.
849 * Returns TRUE on success, or FALSE on failure.
851 PHP_METHOD(HttpResponse
, setBufferSize
)
855 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
858 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
862 /* {{{ proto static int HttpResponse::getBufferSize()
864 * Get current buffer size.
866 * Returns an int representing the current buffer size in bytes.
868 PHP_METHOD(HttpResponse
, getBufferSize
)
873 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
875 RETVAL_ZVAL(size
, 1, 0);
878 zval_ptr_dtor(&size_p
);
884 /* {{{ proto static bool HttpResponse::setData(mixed data)
886 * Set the data to be sent.
888 * Expects one parameter, which will be converted to a string and contains
891 * Returns TRUE on success, or FALSE on failure.
893 PHP_METHOD(HttpResponse
, setData
)
898 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
901 if (Z_TYPE_P(the_data
) != IS_STRING
) {
902 convert_to_string_ex(&the_data
);
905 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
906 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
910 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
911 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
912 UPD_STATIC_PROP(string
, eTag
, etag
);
920 /* {{{ proto static string HttpResponse::getData()
922 * Get the previously set data to be sent.
924 * Returns a string containing the previously set data to send.
926 PHP_METHOD(HttpResponse
, getData
)
931 zval
*the_data
= GET_STATIC_PROP(data
);
933 RETURN_ZVAL(the_data
, 1, 0);
938 /* {{{ proto static bool HttpResponse::setStream(resource stream)
940 * Set the resource to be sent.
942 * Expects a resource parameter referencing an already opened stream from
943 * which the data to send will be read.
945 * Returns TRUE on success, or FALSE on failure.
947 PHP_METHOD(HttpResponse
, setStream
)
951 php_stream
*the_real_stream
;
952 php_stream_statbuf ssb
;
954 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
958 php_stream_from_zval(the_real_stream
, &the_stream
);
959 if (php_stream_stat(the_real_stream
, &ssb
)) {
963 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
964 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
967 zend_list_addref(Z_LVAL_P(the_stream
));
969 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
970 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
971 UPD_STATIC_PROP(string
, eTag
, etag
);
979 /* {{{ proto static resource HttpResponse::getStream()
981 * Get the previously set resource to be sent.
983 * Returns the previously set resource.
985 PHP_METHOD(HttpResponse
, getStream
)
992 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
995 zval_ptr_dtor(&stream_p
);
1001 /* {{{ proto static bool HttpResponse::setFile(string file)
1003 * Set the file to be sent.
1005 * Expects a string as parameter, specifying the path to the file to send.
1007 * Returns TRUE on success, or FALSE on failure.
1009 PHP_METHOD(HttpResponse
, setFile
)
1011 char *the_file
, *etag
;
1013 php_stream_statbuf ssb
;
1015 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
1019 if (php_stream_stat_path(the_file
, &ssb
)) {
1023 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
1024 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
1028 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
1029 if ((etag
= http_etag(the_file
, 0, -1))) {
1030 UPD_STATIC_PROP(string
, eTag
, etag
);
1038 /* {{{ proto static string HttpResponse::getFile()
1040 * Get the previously set file to be sent.
1042 * Returns the previously set path to the file to send as string.
1044 PHP_METHOD(HttpResponse
, getFile
)
1049 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1051 RETVAL_ZVAL(the_file
, 1, 0);
1054 zval_ptr_dtor(&the_file_p
);
1060 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1062 * Finally send the entity.
1064 * Accepts an optional boolean parameter, specifying wheter the ouput
1065 * buffers should be discarded prior sending. A successful caching attempt
1066 * will cause a script termination, and write a log entry if the INI setting
1067 * http.cache_log is set.
1069 * Returns TRUE on success, or FALSE on failure.
1071 * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
1076 * HttpResponse::setCache(true);
1077 * HttpResponse::setContentType('application/pdf');
1078 * HttpResponse::setContentDisposition("$user.pdf", false);
1079 * HttpResponse::setFile('sheet.pdf');
1080 * HttpResponse::send();
1084 PHP_METHOD(HttpResponse
, send
)
1087 zend_bool clean_ob
= 1;
1089 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1093 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1095 sent
= GET_STATIC_PROP(sent
);
1096 if (Z_LVAL_P(sent
)) {
1097 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1104 if (zval_is_true(GET_STATIC_PROP(catch))) {
1105 zval
*etag_p
, *the_data
;
1107 MAKE_STD_ZVAL(the_data
);
1108 php_ob_get_buffer(the_data TSRMLS_CC
);
1109 SET_STATIC_PROP(data
, the_data
);
1110 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1112 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1113 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1115 UPD_STATIC_PROP(string
, eTag
, etag
);
1119 zval_ptr_dtor(&the_data
);
1122 zval_ptr_dtor(&etag_p
);
1129 /* interrupt on-the-fly etag generation */
1130 HTTP_G(etag
).started
= 0;
1131 /* discard previous output buffers */
1132 php_end_ob_buffers(0 TSRMLS_CC
);
1136 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1137 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1139 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1140 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1141 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1143 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1144 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
));
1146 if (etag_p
) zval_ptr_dtor(&etag_p
);
1147 if (lmod_p
) zval_ptr_dtor(&lmod_p
);
1148 if (cctl_p
) zval_ptr_dtor(&cctl_p
);
1150 if (php_ob_handler_used("blackhole" TSRMLS_CC
)) {
1157 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1158 if (Z_STRLEN_P(ctype
)) {
1159 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1161 char *ctypes
= INI_STR("default_mimetype");
1162 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1165 http_send_content_type(ctypes
, ctlen
);
1167 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1171 zval_ptr_dtor(&ctype_p
);
1175 /* content disposition */
1177 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1178 if (Z_STRLEN_P(cd
)) {
1179 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1182 zval_ptr_dtor(&cd_p
);
1188 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1189 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1190 HTTP_G(send
).buffer_size
= Z_LVAL_P(bsize
);
1191 HTTP_G(send
).throttle_delay
= Z_DVAL_P(delay
);
1192 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1193 if (delay_p
) zval_ptr_dtor(&delay_p
);
1197 HTTP_G(send
).gzip_encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1200 php_start_ob_buffer(NULL
, HTTP_G(send
).buffer_size
, 0 TSRMLS_CC
);
1203 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
1207 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1208 RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1209 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1215 php_stream
*the_real_stream
;
1216 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1217 the_stream
->type
= IS_RESOURCE
;
1218 php_stream_from_zval(the_real_stream
, &the_stream
);
1219 RETVAL_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1220 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1227 RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
)), 1));
1228 if (file_p
) zval_ptr_dtor(&file_p
);
1235 /* {{{ proto static void HttpResponse::capture()
1237 * Capture script output.
1242 * HttpResponse::setCache(true);
1243 * HttpResponse::capture();
1248 PHP_METHOD(HttpResponse
, capture
)
1252 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1254 UPD_STATIC_PROP(long, catch, 1);
1256 php_end_ob_buffers(0 TSRMLS_CC
);
1257 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1259 /* register shutdown function */
1261 zval func
, retval
, arg
, *argp
[1];
1265 INIT_PZVAL(&retval
);
1266 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1269 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1270 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1272 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1278 #endif /* ZEND_ENGINE_2 && !WONKY */
1285 * vim600: noet sw=4 ts=4 fdm=marker
1286 * vim<600: noet sw=4 ts=4