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 GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
32 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
33 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
34 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
36 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
37 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpResponse, method, 0)
38 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
39 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
41 HTTP_BEGIN_ARGS(setHeader
, 2)
43 HTTP_ARG_VAL(value
, 0)
44 HTTP_ARG_VAL(replace
, 0)
47 HTTP_BEGIN_ARGS(getHeader
, 0)
51 HTTP_EMPTY_ARGS(getETag
);
52 HTTP_BEGIN_ARGS(setETag
, 1)
56 HTTP_EMPTY_ARGS(getLastModified
);
57 HTTP_BEGIN_ARGS(setLastModified
, 1)
58 HTTP_ARG_VAL(timestamp
, 0)
61 HTTP_EMPTY_ARGS(getCache
);
62 HTTP_BEGIN_ARGS(setCache
, 1)
63 HTTP_ARG_VAL(cache
, 0)
66 HTTP_EMPTY_ARGS(getGzip
);
67 HTTP_BEGIN_ARGS(setGzip
, 1)
71 HTTP_EMPTY_ARGS(getCacheControl
);
72 HTTP_BEGIN_ARGS(setCacheControl
, 1)
73 HTTP_ARG_VAL(cache_control
, 0)
74 HTTP_ARG_VAL(max_age
, 0)
75 HTTP_ARG_VAL(must_revalidate
, 0)
78 HTTP_EMPTY_ARGS(getContentType
);
79 HTTP_BEGIN_ARGS(setContentType
, 1)
80 HTTP_ARG_VAL(content_type
, 0)
83 HTTP_BEGIN_ARGS(guessContentType
, 1)
84 HTTP_ARG_VAL(magic_file
, 0)
85 HTTP_ARG_VAL(magic_mode
, 0)
88 HTTP_EMPTY_ARGS(getContentDisposition
);
89 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
90 HTTP_ARG_VAL(filename
, 0)
91 HTTP_ARG_VAL(send_inline
, 0)
94 HTTP_EMPTY_ARGS(getThrottleDelay
);
95 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
96 HTTP_ARG_VAL(seconds
, 0)
99 HTTP_EMPTY_ARGS(getBufferSize
);
100 HTTP_BEGIN_ARGS(setBufferSize
, 1)
101 HTTP_ARG_VAL(bytes
, 0)
104 HTTP_EMPTY_ARGS(getData
);
105 HTTP_BEGIN_ARGS(setData
, 1)
106 HTTP_ARG_VAL(data
, 0)
109 HTTP_EMPTY_ARGS(getStream
);
110 HTTP_BEGIN_ARGS(setStream
, 1)
111 HTTP_ARG_VAL(stream
, 0)
114 HTTP_EMPTY_ARGS(getFile
);
115 HTTP_BEGIN_ARGS(setFile
, 1)
116 HTTP_ARG_VAL(filepath
, 0)
119 HTTP_BEGIN_ARGS(send
, 0)
120 HTTP_ARG_VAL(clean_ob
, 0)
123 HTTP_EMPTY_ARGS(capture
);
125 HTTP_BEGIN_ARGS(redirect
, 0)
127 HTTP_ARG_VAL(params
, 0)
128 HTTP_ARG_VAL(session
, 0)
129 HTTP_ARG_VAL(permanent
, 0)
132 HTTP_BEGIN_ARGS(status
, 1)
133 HTTP_ARG_VAL(code
, 0)
136 HTTP_EMPTY_ARGS(getRequestHeaders
);
137 HTTP_EMPTY_ARGS(getRequestBody
);
139 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
140 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
141 #define http_grab_response_headers _http_grab_response_headers
142 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
144 zend_class_entry
*http_response_object_ce
;
145 zend_function_entry http_response_object_fe
[] = {
147 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
148 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
150 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
151 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
153 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
154 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
156 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
157 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
159 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
162 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
164 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
165 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
167 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
170 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
173 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
176 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
179 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
182 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
185 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
188 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
191 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
192 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
193 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
194 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
199 PHP_MINIT_FUNCTION(http_response_object
)
201 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
202 http_response_object_declare_default_properties();
206 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
208 zend_class_entry
*ce
= http_response_object_ce
;
210 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
211 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
212 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
213 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
214 DCL_STATIC_PROP_N(PRIVATE
, file
);
215 DCL_STATIC_PROP_N(PRIVATE
, data
);
216 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
217 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
218 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
219 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
220 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
221 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
222 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
223 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
224 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
227 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
228 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
229 DCL_CONST(long, "REDIRECT_FOUND", HTTP_REDIRECT_FOUND
);
230 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
231 DCL_CONST(long, "REDIRECT_PROXY", HTTP_REDIRECT_PROXY
);
232 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
236 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
238 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
239 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
242 /* ### USERLAND ### */
244 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
246 * Send an HTTP header.
248 * Expects a string parameter containing the name of the header and a mixed
249 * parameter containing the value of the header, which will be converted to
250 * a string. Additionally accepts an optional boolean parameter, which
251 * specifies whether an existing header should be replaced. If the second
252 * parameter is unset no header with this name will be sent.
254 * Returns TRUE on success, or FALSE on failure.
256 * Throws HttpHeaderException if http.only_exceptions is TRUE.
258 PHP_METHOD(HttpResponse
, setHeader
)
260 zend_bool replace
= 1;
263 zval
*value
= NULL
, *orig
= NULL
;
265 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
268 if (SG(headers_sent
)) {
269 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
273 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
277 /* delete header if value == null */
278 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
279 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
281 /* send multiple header if replace is false and value is an array */
282 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
286 FOREACH_VAL(pos
, value
, data
) {
289 convert_to_string_ex(data
);
290 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
302 /* send standard header */
304 convert_to_string_ex(&value
);
305 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
307 zval_ptr_dtor(&value
);
312 /* {{{ proto static mixed HttpResponse::getHeader([string name])
314 * Get header(s) about to be sent.
316 * Accepts a string as optional parameter which specifies the name of the
317 * header to read. If the parameter is empty or omitted, an associative array
318 * with all headers will be returned.
320 * Returns either a string containing the value of the header matching name,
321 * FALSE on failure, or an associative array with all headers.
323 PHP_METHOD(HttpResponse
, getHeader
)
329 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
333 phpstr_init(&headers
);
334 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
335 phpstr_fix(&headers
);
337 if (name
&& name_len
) {
339 HashTable headers_ht
;
341 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
342 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
343 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
344 RETVAL_ZVAL(*header
, 1, 0);
348 zend_hash_destroy(&headers_ht
);
350 array_init(return_value
);
351 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
354 phpstr_dtor(&headers
);
358 /* {{{ proto static bool HttpResponse::setCache(bool cache)
360 * Whether it should be attempted to cache the entity.
361 * This will result in necessary caching headers and checks of clients
362 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
363 * matches a "304 Not Modified" status code will be issued.
365 * NOTE: If you're using sessions, be sure that you set session.cache_limiter
366 * to something more appropriate than "no-cache"!
368 * Expects a boolean as parameter specifying whether caching should be attempted.
370 * Returns TRUE on success, or FALSE on failure.
372 PHP_METHOD(HttpResponse
, setCache
)
374 zend_bool do_cache
= 0;
376 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
380 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
384 /* {{{ proto static bool HttpResponse::getCache()
386 * Get current caching setting.
388 * Returns TRUE if caching should be attempted, else FALSE.
390 PHP_METHOD(HttpResponse
, getCache
)
395 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
397 RETVAL_ZVAL(cache
, 1, 0);
400 zval_ptr_dtor(&cache_p
);
406 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
408 * Enable on-thy-fly gzipping of the sent entity.
410 * Expects a boolean as parameter indicating if GZip compression should be enabled.
412 * Returns TRUE on success, or FALSE on failure.
414 PHP_METHOD(HttpResponse
, setGzip
)
416 zend_bool do_gzip
= 0;
418 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
422 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
426 /* {{{ proto static bool HttpResponse::getGzip()
428 * Get current gzipping setting.
430 * Returns TRUE if GZip compression is enabled, else FALSE.
432 PHP_METHOD(HttpResponse
, getGzip
)
437 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
439 RETVAL_ZVAL(gzip
, 1, 0);
442 zval_ptr_dtor(&gzip_p
);
448 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0[, bool must_revalidate = true]])
450 * Set a custom cache-control header, usually being "private" or "public";
451 * The max_age parameter controls how long the cache entry is valid on the client side.
453 * Expects a string parameter containing the primary cache control setting.
454 * Additionally accepts an int parameter specifying the max-age setting.
455 * Accepts an optional third bool parameter indicating whether the cache
456 * must be revalidated every request.
458 * Returns TRUE on success, or FALSE if control does not match one of
459 * "public" , "private" or "no-cache".
461 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
463 PHP_METHOD(HttpResponse
, setCacheControl
)
465 char *ccontrol
, *cctl
;
468 zend_bool must_revalidate
= 1;
470 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|lb", &ccontrol
, &cc_len
, &max_age
, &must_revalidate
)) {
474 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
475 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
478 size_t cctl_len
= spprintf(&cctl
, 0, "%s,%s max-age=%ld", ccontrol
, must_revalidate
?" must-revalidate,":"", max_age
);
479 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
485 /* {{{ proto static string HttpResponse::getCacheControl()
487 * Get current Cache-Control header setting.
489 * Returns the current cache control setting as a string like sent in a header.
491 PHP_METHOD(HttpResponse
, getCacheControl
)
496 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
498 RETVAL_ZVAL(ccontrol
, 1, 0);
501 zval_ptr_dtor(&ccontrol_p
);
507 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
509 * Set the content-type of the sent entity.
511 * Expects a string as parameter specifying the content type of the sent entity.
513 * Returns TRUE on success, or FALSE if the content type does not seem to
514 * contain a primary and secondary content type part.
516 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
518 PHP_METHOD(HttpResponse
, setContentType
)
523 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
527 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
528 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
532 /* {{{ proto static string HttpResponse::getContentType()
534 * Get current Content-Type header setting.
536 * Returns the currently set content type as string.
538 PHP_METHOD(HttpResponse
, getContentType
)
543 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
545 RETVAL_ZVAL(ctype
, 1, 0);
548 zval_ptr_dtor(&ctype_p
);
554 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
556 * Attempts to guess the content type of supplied payload through libmagic.
557 * If the attempt is successful, the guessed content type will automatically
558 * be set as response content type.
560 * Expects a string parameter specifying the magic.mime database to use.
561 * Additionally accepts an optional int parameter, being flags for libmagic.
563 * Returns the guessed content type on success, or FALSE on failure.
565 * Throws HttpRuntimeException, HttpInvalidParamException
566 * if http.only_exceptions is TRUE.
568 PHP_METHOD(HttpResponse
, guessContentType
)
570 char *magic_file
, *ct
= NULL
;
576 #ifdef HTTP_HAVE_MAGIC
577 magic_mode
= MAGIC_MIME
;
580 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
581 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
584 zval
*data
= GET_STATIC_PROP(data
);
585 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
592 zval
*z
= GET_STATIC_PROP(stream
);
593 z
->type
= IS_RESOURCE
;
594 php_stream_from_zval(s
, &z
);
595 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
600 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
604 UPD_STATIC_PROP(string
, contentType
, ct
);
605 RETVAL_STRING(ct
, 0);
610 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
615 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
617 * Set the Content-Disposition. The Content-Disposition header is very useful
618 * if the data actually sent came from a file or something similar, that should
619 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
621 * Expects a string parameter specifying the file name the "Save as..." dialog
622 * should display. Optionally accepts a bool parameter, which, if set to true
623 * and the user agent knows how to handle the content type, will probably not
624 * cause the popup window to be shown.
626 * Returns TRUE on success or FALSE on failure.
628 PHP_METHOD(HttpResponse
, setContentDisposition
)
633 zend_bool send_inline
= 0;
635 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
639 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
640 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
645 /* {{{ proto static string HttpResponse::getContentDisposition()
647 * Get current Content-Disposition setting.
649 * Returns the current content disposition as string like sent in a header.
651 PHP_METHOD(HttpResponse
, getContentDisposition
)
656 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
658 RETVAL_ZVAL(cd
, 1, 0);
661 zval_ptr_dtor(&cd_p
);
667 /* {{{ proto static bool HttpResponse::setETag(string etag)
669 * Set a custom ETag. Use this only if you know what you're doing.
671 * Expects an unquoted string as parameter containing the ETag.
673 * Returns TRUE on success, or FALSE on failure.
675 PHP_METHOD(HttpResponse
, setETag
)
680 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
684 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
688 /* {{{ proto static string HttpResponse::getETag()
690 * Get calculated or previously set custom ETag.
692 * Returns the calculated or previously set ETag as unquoted string.
694 PHP_METHOD(HttpResponse
, getETag
)
699 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
701 RETVAL_ZVAL(etag
, 1, 0);
704 zval_ptr_dtor(&etag_p
);
710 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
712 * Set a custom Last-Modified date.
714 * Expects an unix timestamp as parameter representing the last modification
715 * time of the sent entity.
717 * Returns TRUE on success, or FALSE on failure.
719 PHP_METHOD(HttpResponse
, setLastModified
)
723 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
727 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
731 /* {{{ proto static int HttpResponse::getLastModified()
733 * Get calculated or previously set custom Last-Modified date.
735 * Returns the calculated or previously set unix timestamp.
737 PHP_METHOD(HttpResponse
, getLastModified
)
742 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
744 RETVAL_ZVAL(lm
, 1, 0);
747 zval_ptr_dtor(&lm_p
);
753 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
755 * Sets the throttle delay for use with HttpResponse::setBufferSize().
757 * Provides a basic throttling mechanism, which will yield the current process
758 * resp. thread until the entity has been completely sent, though.
760 * Note: This doesn't really work with the FastCGI SAPI.
762 * Expects a double parameter specifying the seconds too sleep() after
765 * Returns TRUE on success, or FALSE on failure.
767 PHP_METHOD(HttpResponse
, setThrottleDelay
)
771 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
774 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
778 /* {{{ proto static double HttpResponse::getThrottleDelay()
780 * Get the current throttle delay.
782 * Returns a double representing the throttle delay in seconds.
784 PHP_METHOD(HttpResponse
, getThrottleDelay
)
789 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
791 RETVAL_ZVAL(delay
, 1, 0);
794 zval_ptr_dtor(&delay_p
);
800 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
802 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
804 * Provides a basic throttling mechanism, which will yield the current process
805 * resp. thread until the entity has been completely sent, though.
807 * Note: This doesn't really work with the FastCGI SAPI.
809 * Expects an int parameter representing the chunk size in bytes.
811 * Returns TRUE on success, or FALSE on failure.
813 PHP_METHOD(HttpResponse
, setBufferSize
)
817 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
820 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
824 /* {{{ proto static int HttpResponse::getBufferSize()
826 * Get current buffer size.
828 * Returns an int representing the current buffer size in bytes.
830 PHP_METHOD(HttpResponse
, getBufferSize
)
835 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
837 RETVAL_ZVAL(size
, 1, 0);
840 zval_ptr_dtor(&size_p
);
846 /* {{{ proto static bool HttpResponse::setData(mixed data)
848 * Set the data to be sent.
850 * Expects one parameter, which will be converted to a string and contains
853 * Returns TRUE on success, or FALSE on failure.
855 PHP_METHOD(HttpResponse
, setData
)
860 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
863 if (Z_TYPE_P(the_data
) != IS_STRING
) {
864 convert_to_string_ex(&the_data
);
867 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
868 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
872 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
873 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
874 UPD_STATIC_PROP(string
, eTag
, etag
);
882 /* {{{ proto static string HttpResponse::getData()
884 * Get the previously set data to be sent.
886 * Returns a string containing the previously set data to send.
888 PHP_METHOD(HttpResponse
, getData
)
893 zval
*the_data
= GET_STATIC_PROP(data
);
895 RETURN_ZVAL(the_data
, 1, 0);
900 /* {{{ proto static bool HttpResponse::setStream(resource stream)
902 * Set the resource to be sent.
904 * Expects a resource parameter referencing an already opened stream from
905 * which the data to send will be read.
907 * Returns TRUE on success, or FALSE on failure.
909 PHP_METHOD(HttpResponse
, setStream
)
913 php_stream
*the_real_stream
;
914 php_stream_statbuf ssb
;
916 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
920 php_stream_from_zval(the_real_stream
, &the_stream
);
921 if (php_stream_stat(the_real_stream
, &ssb
)) {
925 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
926 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
929 zend_list_addref(Z_LVAL_P(the_stream
));
931 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
932 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
933 UPD_STATIC_PROP(string
, eTag
, etag
);
941 /* {{{ proto static resource HttpResponse::getStream()
943 * Get the previously set resource to be sent.
945 * Returns the previously set resource.
947 PHP_METHOD(HttpResponse
, getStream
)
954 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
957 zval_ptr_dtor(&stream_p
);
963 /* {{{ proto static bool HttpResponse::setFile(string file)
965 * Set the file to be sent.
967 * Expects a string as parameter, specifying the path to the file to send.
969 * Returns TRUE on success, or FALSE on failure.
971 PHP_METHOD(HttpResponse
, setFile
)
973 char *the_file
, *etag
;
975 php_stream_statbuf ssb
;
977 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
981 if (php_stream_stat_path(the_file
, &ssb
)) {
985 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
986 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
990 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
991 if ((etag
= http_etag(the_file
, 0, -1))) {
992 UPD_STATIC_PROP(string
, eTag
, etag
);
1000 /* {{{ proto static string HttpResponse::getFile()
1002 * Get the previously set file to be sent.
1004 * Returns the previously set path to the file to send as string.
1006 PHP_METHOD(HttpResponse
, getFile
)
1011 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1013 RETVAL_ZVAL(the_file
, 1, 0);
1016 zval_ptr_dtor(&the_file_p
);
1022 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1024 * Finally send the entity.
1026 * Accepts an optional boolean parameter, specifying whether the output
1027 * buffers should be discarded prior sending. A successful caching attempt
1028 * will cause a script termination, and write a log entry if the INI setting
1029 * http.cache_log is set.
1031 * Returns TRUE on success, or FALSE on failure.
1033 * Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.
1038 * HttpResponse::setCache(true);
1039 * HttpResponse::setContentType('application/pdf');
1040 * HttpResponse::setContentDisposition("$user.pdf", false);
1041 * HttpResponse::setFile('sheet.pdf');
1042 * HttpResponse::send();
1046 PHP_METHOD(HttpResponse
, send
)
1049 zend_bool clean_ob
= 1;
1051 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1055 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1057 sent
= GET_STATIC_PROP(sent
);
1058 if (Z_LVAL_P(sent
)) {
1059 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1066 if (zval_is_true(GET_STATIC_PROP(catch))) {
1067 zval
*etag_p
, *the_data
;
1069 MAKE_STD_ZVAL(the_data
);
1070 php_ob_get_buffer(the_data TSRMLS_CC
);
1071 SET_STATIC_PROP(data
, the_data
);
1072 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1074 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1075 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1077 UPD_STATIC_PROP(string
, eTag
, etag
);
1081 zval_ptr_dtor(&the_data
);
1084 zval_ptr_dtor(&etag_p
);
1091 /* interrupt on-the-fly etag generation */
1092 HTTP_G
->etag
.started
= 0;
1093 /* discard previous output buffers */
1094 php_end_ob_buffers(0 TSRMLS_CC
);
1098 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1099 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1101 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1102 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1103 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1105 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1106 http_cache_last_modified(Z_LVAL_P(lmod
), Z_LVAL_P(lmod
) ? Z_LVAL_P(lmod
) : HTTP_GET_REQUEST_TIME(), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1108 if (etag_p
) zval_ptr_dtor(&etag_p
);
1109 if (lmod_p
) zval_ptr_dtor(&lmod_p
);
1110 if (cctl_p
) zval_ptr_dtor(&cctl_p
);
1112 if (php_ob_handler_used("blackhole" TSRMLS_CC
)) {
1119 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1120 if (Z_STRLEN_P(ctype
)) {
1121 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1123 char *ctypes
= INI_STR("default_mimetype");
1124 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1127 http_send_content_type(ctypes
, ctlen
);
1129 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1133 zval_ptr_dtor(&ctype_p
);
1137 /* content disposition */
1139 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1140 if (Z_STRLEN_P(cd
)) {
1141 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1144 zval_ptr_dtor(&cd_p
);
1150 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1151 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1152 HTTP_G
->send
.buffer_size
= Z_LVAL_P(bsize
);
1153 HTTP_G
->send
.throttle_delay
= Z_DVAL_P(delay
);
1154 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1155 if (delay_p
) zval_ptr_dtor(&delay_p
);
1159 HTTP_G
->send
.deflate
.encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1162 php_start_ob_buffer(NULL
, HTTP_G
->send
.buffer_size
, 0 TSRMLS_CC
);
1165 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
1169 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1170 RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1171 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1177 php_stream
*the_real_stream
;
1178 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1179 the_stream
->type
= IS_RESOURCE
;
1180 php_stream_from_zval(the_real_stream
, &the_stream
);
1181 RETVAL_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1182 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1189 RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
)), 1));
1190 if (file_p
) zval_ptr_dtor(&file_p
);
1197 /* {{{ proto static void HttpResponse::capture()
1199 * Capture script output.
1204 * HttpResponse::setCache(true);
1205 * HttpResponse::capture();
1210 PHP_METHOD(HttpResponse
, capture
)
1214 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1216 UPD_STATIC_PROP(long, catch, 1);
1218 php_end_ob_buffers(0 TSRMLS_CC
);
1219 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1221 /* register shutdown function */
1223 zval func
, retval
, arg
, *argp
[1];
1227 INIT_PZVAL(&retval
);
1228 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1231 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1232 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1234 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1240 #endif /* ZEND_ENGINE_2 && !WONKY */
1247 * vim600: noet sw=4 ts=4 fdm=marker
1248 * vim<600: noet sw=4 ts=4