2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
20 #define HTTP_WANT_MAGIC
23 /* broken static properties in PHP 5.0 */
24 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
29 #include "php_http_api.h"
30 #include "php_http_cache_api.h"
31 #include "php_http_exception_object.h"
32 #include "php_http_headers_api.h"
33 #include "php_http_response_object.h"
34 #include "php_http_send_api.h"
36 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
37 #define UPD_STATIC_PROP(t, n, v) UPD_STATIC_PROP_EX(http_response_object_ce, t, n, v)
38 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
39 #define UPD_STATIC_STRL(n, v, l) UPD_STATIC_STRL_EX(http_response_object_ce, n, v, l)
41 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
42 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
43 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
44 #define HTTP_RESPONSE_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpResponse, method))
46 HTTP_BEGIN_ARGS(setHeader
, 2)
48 HTTP_ARG_VAL(value
, 0)
49 HTTP_ARG_VAL(replace
, 0)
52 HTTP_BEGIN_ARGS(getHeader
, 0)
56 HTTP_EMPTY_ARGS(getETag
, 0);
57 HTTP_BEGIN_ARGS(setETag
, 1)
61 HTTP_EMPTY_ARGS(getLastModified
, 0);
62 HTTP_BEGIN_ARGS(setLastModified
, 1)
63 HTTP_ARG_VAL(timestamp
, 0)
66 HTTP_EMPTY_ARGS(getCache
, 0);
67 HTTP_BEGIN_ARGS(setCache
, 1)
68 HTTP_ARG_VAL(cache
, 0)
71 HTTP_EMPTY_ARGS(getGzip
, 0);
72 HTTP_BEGIN_ARGS(setGzip
, 1)
76 HTTP_EMPTY_ARGS(getCacheControl
, 0);
77 HTTP_BEGIN_ARGS(setCacheControl
, 1)
78 HTTP_ARG_VAL(cache_control
, 0)
79 HTTP_ARG_VAL(max_age
, 0)
82 HTTP_EMPTY_ARGS(getContentType
, 0);
83 HTTP_BEGIN_ARGS(setContentType
, 1)
84 HTTP_ARG_VAL(content_type
, 0)
87 HTTP_BEGIN_ARGS(guessContentType
, 1)
88 HTTP_ARG_VAL(magic_file
, 0)
89 HTTP_ARG_VAL(magic_mode
, 0)
92 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
93 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
94 HTTP_ARG_VAL(filename
, 0)
95 HTTP_ARG_VAL(send_inline
, 0)
98 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
99 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
100 HTTP_ARG_VAL(seconds
, 0)
103 HTTP_EMPTY_ARGS(getBufferSize
, 0);
104 HTTP_BEGIN_ARGS(setBufferSize
, 1)
105 HTTP_ARG_VAL(bytes
, 0)
108 HTTP_EMPTY_ARGS(getData
, 0);
109 HTTP_BEGIN_ARGS(setData
, 1)
110 HTTP_ARG_VAL(data
, 0)
113 HTTP_EMPTY_ARGS(getStream
, 0);
114 HTTP_BEGIN_ARGS(setStream
, 1)
115 HTTP_ARG_VAL(stream
, 0)
118 HTTP_EMPTY_ARGS(getFile
, 0);
119 HTTP_BEGIN_ARGS(setFile
, 1)
120 HTTP_ARG_VAL(filepath
, 0)
123 HTTP_BEGIN_ARGS(send
, 0)
124 HTTP_ARG_VAL(clean_ob
, 0)
127 HTTP_EMPTY_ARGS(capture
, 0);
129 HTTP_BEGIN_ARGS(redirect
, 0)
131 HTTP_ARG_VAL(params
, 0)
132 HTTP_ARG_VAL(session
, 0)
133 HTTP_ARG_VAL(permanent
, 0)
136 HTTP_BEGIN_ARGS(status
, 1)
137 HTTP_ARG_VAL(code
, 0)
140 HTTP_EMPTY_ARGS(getRequestHeaders
, 0);
141 HTTP_EMPTY_ARGS(getRequestBody
, 0);
143 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
144 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
145 #define http_grab_response_headers _http_grab_response_headers
146 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
);
148 zend_class_entry
*http_response_object_ce
;
149 zend_function_entry http_response_object_fe
[] = {
151 HTTP_RESPONSE_ME(setHeader
, ZEND_ACC_PUBLIC
)
152 HTTP_RESPONSE_ME(getHeader
, ZEND_ACC_PUBLIC
)
154 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
155 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
157 HTTP_RESPONSE_ME(setLastModified
, ZEND_ACC_PUBLIC
)
158 HTTP_RESPONSE_ME(getLastModified
, ZEND_ACC_PUBLIC
)
160 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
161 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
163 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
164 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
166 HTTP_RESPONSE_ME(guessContentType
, ZEND_ACC_PUBLIC
)
168 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
169 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
171 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
172 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
174 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
175 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
177 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
178 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
180 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
181 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
183 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
184 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
186 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
187 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
189 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
190 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
192 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
193 HTTP_RESPONSE_ME(capture
, ZEND_ACC_PUBLIC
)
195 HTTP_RESPONSE_ALIAS(redirect
, http_redirect
)
196 HTTP_RESPONSE_ALIAS(status
, http_send_status
)
197 HTTP_RESPONSE_ALIAS(getRequestHeaders
, http_get_request_headers
)
198 HTTP_RESPONSE_ALIAS(getRequestBody
, http_get_request_body
)
203 PHP_MINIT_FUNCTION(http_response_object
)
205 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
206 http_response_object_declare_default_properties();
210 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
212 zend_class_entry
*ce
= http_response_object_ce
;
214 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
215 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
216 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
217 DCL_STATIC_PROP(PRIVATE
, long, stream
, 0);
218 DCL_STATIC_PROP_N(PRIVATE
, file
);
219 DCL_STATIC_PROP_N(PRIVATE
, data
);
220 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
221 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
222 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
223 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
224 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
225 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
226 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
227 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
228 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
231 DCL_CONST(long, "REDIRECT", HTTP_REDIRECT
);
232 DCL_CONST(long, "REDIRECT_PERM", HTTP_REDIRECT_PERM
);
233 DCL_CONST(long, "REDIRECT_POST", HTTP_REDIRECT_POST
);
234 DCL_CONST(long, "REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
238 static void _http_grab_response_headers(void *data
, void *arg TSRMLS_DC
)
240 phpstr_appendl(PHPSTR(arg
), ((sapi_header_struct
*)data
)->header
);
241 phpstr_appends(PHPSTR(arg
), HTTP_CRLF
);
244 /* ### USERLAND ### */
246 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
248 * Send an HTTP header.
250 * Expects a string parameter containing the name of the header and a mixed
251 * parameter containing the value of the header, which will be converted to
252 * a string. Additionally accepts an optional boolean parameter, which
253 * specifies whether an existing header should be replaced. If the second
254 * parameter is unset no header with this name will be sent.
256 * Returns TRUE on success, or FALSE on failure.
258 * Throws HttpHeaderException if http.only_exceptions is TRUE.
260 PHP_METHOD(HttpResponse
, setHeader
)
262 zend_bool replace
= 1;
265 zval
*value
= NULL
, *orig
= NULL
;
267 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz/!|b", &name
, &name_len
, &value
, &replace
)) {
270 if (SG(headers_sent
)) {
271 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot add another header when headers have already been sent");
275 http_error(HE_WARNING
, HTTP_E_HEADER
, "Cannot send anonymous headers");
279 /* delete header if value == null */
280 if (!value
|| Z_TYPE_P(value
) == IS_NULL
) {
281 RETURN_SUCCESS(http_send_header_ex(name
, name_len
, "", 0, replace
, NULL
));
283 /* send multiple header if replace is false and value is an array */
284 if (!replace
&& Z_TYPE_P(value
) == IS_ARRAY
) {
288 FOREACH_VAL(pos
, value
, data
) {
291 convert_to_string_ex(data
);
292 if (SUCCESS
!= http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), 0, NULL
)) {
304 /* send standard header */
306 convert_to_string_ex(&value
);
307 RETVAL_SUCCESS(http_send_header_ex(name
, name_len
, Z_STRVAL_P(value
), Z_STRLEN_P(value
), replace
, NULL
));
309 zval_ptr_dtor(&value
);
314 /* {{{ proto static mixed HttpResponse::getHeader([string name])
316 * Get header(s) about to be sent.
318 * Accepts a string as optional parameter which specifies the name of the
319 * header to read. If the parameter is empty or omitted, an associative array
320 * with all headers will be returned.
322 * Returns either a string containing the value of the header matching name,
323 * FALSE on failure, or an associative array with all headers.
325 PHP_METHOD(HttpResponse
, getHeader
)
331 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name
, &name_len
)) {
335 phpstr_init(&headers
);
336 zend_llist_apply_with_argument(&SG(sapi_headers
).headers
, http_grab_response_headers
, &headers TSRMLS_CC
);
337 phpstr_fix(&headers
);
339 if (name
&& name_len
) {
341 HashTable headers_ht
;
343 zend_hash_init(&headers_ht
, sizeof(zval
*), NULL
, ZVAL_PTR_DTOR
, 0);
344 if ( (SUCCESS
== http_parse_headers_ex(PHPSTR_VAL(&headers
), &headers_ht
, 1)) &&
345 (SUCCESS
== zend_hash_find(&headers_ht
, name
, name_len
+ 1, (void **) &header
))) {
346 RETVAL_ZVAL(*header
, 1, 0);
350 zend_hash_destroy(&headers_ht
);
352 array_init(return_value
);
353 http_parse_headers_ex(PHPSTR_VAL(&headers
), Z_ARRVAL_P(return_value
), 1);
356 phpstr_dtor(&headers
);
360 /* {{{ proto static bool HttpResponse::setCache(bool cache)
362 * Whether it sould be attempted to cache the entitity.
363 * This will result in necessary caching headers and checks of clients
364 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
365 * matches a "304 Not Modified" status code will be issued.
367 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
368 * to something more appropriate than "no-cache"!
370 * Expects a boolean as parameter specifying whether caching should be attempted.
372 * Returns TRUE ons success, or FALSE on failure.
374 PHP_METHOD(HttpResponse
, setCache
)
376 zend_bool do_cache
= 0;
378 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
382 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache
, do_cache
));
386 /* {{{ proto static bool HttpResponse::getCache()
388 * Get current caching setting.
390 * Returns TRUE if caching should be attempted, else FALSE.
392 PHP_METHOD(HttpResponse
, getCache
)
397 zval
*cache_p
, *cache
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(cache
), &cache_p
);
399 RETVAL_ZVAL(cache
, 1, 0);
402 zval_ptr_dtor(&cache_p
);
408 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
410 * Enable on-thy-fly gzipping of the sent entity.
412 * Expects a boolean as parameter indicating if GZip compression should be enabled.
414 * Returns TRUE on success, or FALSE on failure.
416 PHP_METHOD(HttpResponse
, setGzip
)
418 zend_bool do_gzip
= 0;
420 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
424 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip
, do_gzip
));
428 /* {{{ proto static bool HttpResponse::getGzip()
430 * Get current gzipping setting.
432 * Returns TRUE if GZip compression is enabled, else FALSE.
434 PHP_METHOD(HttpResponse
, getGzip
)
439 zval
*gzip_p
, *gzip
= convert_to_type_ex(IS_BOOL
, GET_STATIC_PROP(gzip
), &gzip_p
);
441 RETVAL_ZVAL(gzip
, 1, 0);
444 zval_ptr_dtor(&gzip_p
);
450 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
452 * Set a custom cache-control header, usually being "private" or "public";
453 * The max_age parameter controls how long the cache entry is valid on the client side.
455 * Expects a string parameter containing the primary cache control setting.
456 * Addtitionally accepts an int parameter specifying the max-age setting.
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
;
469 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &ccontrol
, &cc_len
, &max_age
)) {
473 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
474 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
477 size_t cctl_len
= spprintf(&cctl
, 0, "%s, must-revalidate, max-age=%ld", ccontrol
, max_age
);
478 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl
, cctl
, cctl_len
));
484 /* {{{ proto static string HttpResponse::getCacheControl()
486 * Get current Cache-Control header setting.
488 * Returns the current cache control setting as a string like sent in a header.
490 PHP_METHOD(HttpResponse
, getCacheControl
)
495 zval
*ccontrol_p
, *ccontrol
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &ccontrol_p
);
497 RETVAL_ZVAL(ccontrol
, 1, 0);
500 zval_ptr_dtor(&ccontrol_p
);
506 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
508 * Set the content-type of the sent entity.
510 * Expects a string as parameter specifying the content type of the sent entity.
512 * Returns TRUE on success, or FALSE if the content type does not seem to
513 * contain a primary and secondary content type part.
515 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
517 PHP_METHOD(HttpResponse
, setContentType
)
522 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
526 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
527 RETURN_SUCCESS(UPD_STATIC_STRL(contentType
, ctype
, ctype_len
));
531 /* {{{ proto static string HttpResponse::getContentType()
533 * Get current Content-Type header setting.
535 * Returns the currently set content type as string.
537 PHP_METHOD(HttpResponse
, getContentType
)
542 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
544 RETVAL_ZVAL(ctype
, 1, 0);
547 zval_ptr_dtor(&ctype_p
);
553 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
555 * Attempts to guess the content type of supplied payload through libmagic.
556 * If the attempt is successful, the guessed content type will automatically
557 * be set as response content type.
559 * Expects a string parameter specifying the magic.mime database to use.
560 * Additionally accepts an optional int parameter, being flags for libmagic.
562 * Returns the guessed content type on success, or FALSE on failure.
564 * Throws HttpRuntimeException, HttpInvalidParamException
565 * if http.only_exceptions is TRUE.
567 PHP_METHOD(HttpResponse
, guessContentType
)
569 char *magic_file
, *ct
= NULL
;
575 #ifdef HTTP_HAVE_MAGIC
576 magic_mode
= MAGIC_MIME
;
579 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &magic_file
, &magic_file_len
, &magic_mode
)) {
580 switch (Z_LVAL_P(GET_STATIC_PROP(mode
))) {
583 zval
*data
= GET_STATIC_PROP(data
);
584 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), SEND_DATA
);
591 zval
*z
= GET_STATIC_PROP(stream
);
592 z
->type
= IS_RESOURCE
;
593 php_stream_from_zval(s
, &z
);
594 ct
= http_guess_content_type(magic_file
, magic_mode
, s
, 0, SEND_RSRC
);
599 ct
= http_guess_content_type(magic_file
, magic_mode
, Z_STRVAL_P(GET_STATIC_PROP(file
)), 0, -1);
603 UPD_STATIC_PROP(string
, contentType
, ct
);
604 RETVAL_STRING(ct
, 0);
609 http_error(HE_THROW
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
614 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
616 * Set the Content-Disposition. The Content-Disposition header is very useful
617 * if the data actually sent came from a file or something similar, that should
618 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
620 * Expects a string parameter specifying the file name the "Save as..." dialogue
621 * should display. Optionally accepts a bool parameter, which, if set to true
622 * and the user agent knows how to handle the content type, will probably not
623 * cause the popup window to be shown.
625 * Returns TRUE on success or FALSE on failure.
627 PHP_METHOD(HttpResponse
, setContentDisposition
)
632 zend_bool send_inline
= 0;
634 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
638 cd_len
= spprintf(&cd
, 0, "%s; filename=\"%s\"", send_inline
? "inline" : "attachment", file
);
639 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition
, cd
, cd_len
));
644 /* {{{ proto static string HttpResponse::getContentDisposition()
646 * Get current Content-Disposition setting.
648 * Returns the current content disposition as string like sent in a header.
650 PHP_METHOD(HttpResponse
, getContentDisposition
)
655 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
657 RETVAL_ZVAL(cd
, 1, 0);
660 zval_ptr_dtor(&cd_p
);
666 /* {{{ proto static bool HttpResponse::setETag(string etag)
668 * Set a custom ETag. Use this only if you know what you're doing.
670 * Expects an unquoted string as parameter containing the ETag.
672 * Returns TRUE on success, or FALSE on failure.
674 PHP_METHOD(HttpResponse
, setETag
)
679 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
683 RETURN_SUCCESS(UPD_STATIC_STRL(eTag
, etag
, etag_len
));
687 /* {{{ proto static string HttpResponse::getETag()
689 * Get calculated or previously set custom ETag.
691 * Returns the calculated or previously set ETag as unquoted string.
693 PHP_METHOD(HttpResponse
, getETag
)
698 zval
*etag_p
, *etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
700 RETVAL_ZVAL(etag
, 1, 0);
703 zval_ptr_dtor(&etag_p
);
709 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
711 * Set a custom Last-Modified date.
713 * Expects an unix timestamp as parameter representing the last modification
714 * time of the sent entity.
716 * Returns TRUE on success, or FALSE on failure.
718 PHP_METHOD(HttpResponse
, setLastModified
)
722 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &lm
)) {
726 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified
, lm
));
730 /* {{{ proto static int HttpResponse::getLastModified()
732 * Get calculated or previously set custom Last-Modified date.
734 * Returns the calculated or previously set unix timestamp.
736 PHP_METHOD(HttpResponse
, getLastModified
)
741 zval
*lm_p
, *lm
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lm_p
);
743 RETVAL_ZVAL(lm
, 1, 0);
746 zval_ptr_dtor(&lm_p
);
752 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
754 * Sets the throttle delay for use with HttpResponse::setBufferSize().
756 * Provides a basic throttling mechanism, which will yield the current process
757 * resp. thread until the entity has been completely sent, though.
759 * Note: This doesn't really work with the FastCGI SAPI.
761 * Expects a double parameter specifying the seconds too sleep() after
764 * Returns TRUE on success, or FALSE on failure.
766 PHP_METHOD(HttpResponse
, setThrottleDelay
)
770 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
773 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay
, seconds
));
777 /* {{{ proto static double HttpResponse::getThrottleDelay()
779 * Get the current throttle delay.
781 * Returns a double representing the throttle delay in seconds.
783 PHP_METHOD(HttpResponse
, getThrottleDelay
)
788 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
790 RETVAL_ZVAL(delay
, 1, 0);
793 zval_ptr_dtor(&delay_p
);
799 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
801 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
803 * Provides a basic throttling mechanism, which will yield the current process
804 * resp. thread until the entity has been completely sent, though.
806 * Note: This doesn't really work with the FastCGI SAPI.
808 * Expects an int parameter representing the chunk size in bytes.
810 * Returns TRUE on success, or FALSE on failure.
812 PHP_METHOD(HttpResponse
, setBufferSize
)
816 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
819 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize
, bytes
));
823 /* {{{ proto static int HttpResponse::getBufferSize()
825 * Get current buffer size.
827 * Returns an int representing the current buffer size in bytes.
829 PHP_METHOD(HttpResponse
, getBufferSize
)
834 zval
*size_p
, *size
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &size_p
);
836 RETVAL_ZVAL(size
, 1, 0);
839 zval_ptr_dtor(&size_p
);
845 /* {{{ proto static bool HttpResponse::setData(mixed data)
847 * Set the data to be sent.
849 * Expects one parameter, which will be converted to a string and contains
852 * Returns TRUE on success, or FALSE on failure.
854 PHP_METHOD(HttpResponse
, setData
)
859 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
862 if (Z_TYPE_P(the_data
) != IS_STRING
) {
863 convert_to_string_ex(&the_data
);
866 if ( (SUCCESS
!= SET_STATIC_PROP(data
, the_data
)) ||
867 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_DATA
))) {
871 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_data
, SEND_DATA
));
872 if ((etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
))) {
873 UPD_STATIC_PROP(string
, eTag
, etag
);
881 /* {{{ proto static string HttpResponse::getData()
883 * Get the previously set data to be sent.
885 * Returns a string containing the previously set data to send.
887 PHP_METHOD(HttpResponse
, getData
)
892 zval
*the_data
= GET_STATIC_PROP(data
);
894 RETURN_ZVAL(the_data
, 1, 0);
899 /* {{{ proto static bool HttpResponse::setStream(resource stream)
901 * Set the resource to be sent.
903 * Expects a resource parameter referencing an already opened stream from
904 * which the data to send will be read.
906 * Returns TRUE on success, or FALSE on failure.
908 PHP_METHOD(HttpResponse
, setStream
)
912 php_stream
*the_real_stream
;
913 php_stream_statbuf ssb
;
915 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
919 php_stream_from_zval(the_real_stream
, &the_stream
);
920 if (php_stream_stat(the_real_stream
, &ssb
)) {
924 if ( (SUCCESS
!= UPD_STATIC_PROP(long, stream
, Z_LVAL_P(the_stream
))) ||
925 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, SEND_RSRC
))) {
928 zend_list_addref(Z_LVAL_P(the_stream
));
930 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_real_stream
, SEND_RSRC
));
931 if ((etag
= http_etag(the_real_stream
, 0, SEND_RSRC
))) {
932 UPD_STATIC_PROP(string
, eTag
, etag
);
940 /* {{{ proto static resource HttpResponse::getStream()
942 * Get the previously set resource to be sent.
944 * Returns the previously set resource.
946 PHP_METHOD(HttpResponse
, getStream
)
953 RETVAL_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &stream_p
)));
956 zval_ptr_dtor(&stream_p
);
962 /* {{{ proto static bool HttpResponse::setFile(string file)
964 * Set the file to be sent.
966 * Expects a string as parameter, specifying the path to the file to send.
968 * Returns TRUE on success, or FALSE on failure.
970 PHP_METHOD(HttpResponse
, setFile
)
972 char *the_file
, *etag
;
974 php_stream_statbuf ssb
;
976 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &the_file
, &file_len
)) {
980 if (php_stream_stat_path(the_file
, &ssb
)) {
984 if ( (SUCCESS
!= UPD_STATIC_STRL(file
, the_file
, file_len
)) ||
985 (SUCCESS
!= UPD_STATIC_PROP(long, mode
, -1))) {
989 UPD_STATIC_PROP(long, lastModified
, http_last_modified(the_file
, -1));
990 if ((etag
= http_etag(the_file
, 0, -1))) {
991 UPD_STATIC_PROP(string
, eTag
, etag
);
999 /* {{{ proto static string HttpResponse::getFile()
1001 * Get the previously set file to be sent.
1003 * Returns the previously set path to the file to send as string.
1005 PHP_METHOD(HttpResponse
, getFile
)
1010 zval
*the_file_p
, *the_file
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &the_file_p
);
1012 RETVAL_ZVAL(the_file
, 1, 0);
1015 zval_ptr_dtor(&the_file_p
);
1021 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
1023 * Finally send the entity.
1025 * Accepts an optional boolean parameter, specifying wheter the ouput
1026 * buffers should be discarded prior sending. A successful caching attempt
1027 * will cause a script termination, and write a log entry if the INI setting
1028 * http.cache_log is set.
1030 * Returns TRUE on success, or FALSE on failure.
1032 * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
1037 * HttpResponse::setCache(true);
1038 * HttpResponse::setContentType('application/pdf');
1039 * HttpResponse::setContentDisposition("$user.pdf", false);
1040 * HttpResponse::setFile('sheet.pdf');
1041 * HttpResponse::send();
1045 PHP_METHOD(HttpResponse
, send
)
1048 zend_bool clean_ob
= 1;
1050 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
1054 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1056 sent
= GET_STATIC_PROP(sent
);
1057 if (Z_LVAL_P(sent
)) {
1058 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "Cannot send HttpResponse, response has already been sent");
1065 if (zval_is_true(GET_STATIC_PROP(catch))) {
1066 zval
*etag_p
, *the_data
;
1068 MAKE_STD_ZVAL(the_data
);
1069 php_ob_get_buffer(the_data TSRMLS_CC
);
1070 SET_STATIC_PROP(data
, the_data
);
1071 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
1073 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
))) {
1074 char *etag
= http_etag(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), SEND_DATA
);
1076 UPD_STATIC_PROP(string
, eTag
, etag
);
1080 zval_ptr_dtor(&the_data
);
1083 zval_ptr_dtor(&etag_p
);
1090 /* interrupt on-the-fly etag generation */
1091 HTTP_G(etag
).started
= 0;
1092 /* discard previous output buffers */
1093 php_end_ob_buffers(0 TSRMLS_CC
);
1097 if (zval_is_true(GET_STATIC_PROP(cache
))) {
1098 zval
*cctl
, *cctl_p
, *etag
, *etag_p
, *lmod
, *lmod_p
;
1100 etag
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(eTag
), &etag_p
);
1101 lmod
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(lastModified
), &lmod_p
);
1102 cctl
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(cacheControl
), &cctl_p
);
1104 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
1105 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
));
1107 if (etag_p
) zval_ptr_dtor(&etag_p
);
1108 if (lmod_p
) zval_ptr_dtor(&lmod_p
);
1109 if (cctl_p
) zval_ptr_dtor(&cctl_p
);
1111 if (php_ob_handler_used("blackhole" TSRMLS_CC
)) {
1118 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentType
), &ctype_p
);
1119 if (Z_STRLEN_P(ctype
)) {
1120 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
1122 char *ctypes
= INI_STR("default_mimetype");
1123 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
1126 http_send_content_type(ctypes
, ctlen
);
1128 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1132 zval_ptr_dtor(&ctype_p
);
1136 /* content disposition */
1138 zval
*cd_p
, *cd
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(contentDisposition
), &cd_p
);
1139 if (Z_STRLEN_P(cd
)) {
1140 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1, NULL
);
1143 zval_ptr_dtor(&cd_p
);
1149 zval
*bsize_p
, *bsize
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(bufferSize
), &bsize_p
);
1150 zval
*delay_p
, *delay
= convert_to_type_ex(IS_DOUBLE
, GET_STATIC_PROP(throttleDelay
), &delay_p
);
1151 HTTP_G(send
).buffer_size
= Z_LVAL_P(bsize
);
1152 HTTP_G(send
).throttle_delay
= Z_DVAL_P(delay
);
1153 if (bsize_p
) zval_ptr_dtor(&bsize_p
);
1154 if (delay_p
) zval_ptr_dtor(&delay_p
);
1158 HTTP_G(send
).deflate
.encoding
= zval_is_true(GET_STATIC_PROP(gzip
));
1161 php_start_ob_buffer(NULL
, HTTP_G(send
).buffer_size
, 0 TSRMLS_CC
);
1164 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
1168 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(data
), &zdata_p
);
1169 RETVAL_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
), 1));
1170 if (zdata_p
) zval_ptr_dtor(&zdata_p
);
1176 php_stream
*the_real_stream
;
1177 zval
*the_stream_p
, *the_stream
= convert_to_type_ex(IS_LONG
, GET_STATIC_PROP(stream
), &the_stream_p
);
1178 the_stream
->type
= IS_RESOURCE
;
1179 php_stream_from_zval(the_real_stream
, &the_stream
);
1180 RETVAL_SUCCESS(http_send_stream_ex(the_real_stream
, 0, 1));
1181 if (the_stream_p
) zval_ptr_dtor(&the_stream_p
);
1188 RETVAL_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING
, GET_STATIC_PROP(file
), &file_p
)), 1));
1189 if (file_p
) zval_ptr_dtor(&file_p
);
1196 /* {{{ proto static void HttpResponse::capture()
1198 * Capture script output.
1203 * HttpResponse::setCache(true);
1204 * HttpResponse::capture();
1209 PHP_METHOD(HttpResponse
, capture
)
1213 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
1215 UPD_STATIC_PROP(long, catch, 1);
1217 php_end_ob_buffers(0 TSRMLS_CC
);
1218 php_start_ob_buffer(NULL
, 40960, 0 TSRMLS_CC
);
1220 /* register shutdown function */
1222 zval func
, retval
, arg
, *argp
[1];
1226 INIT_PZVAL(&retval
);
1227 ZVAL_STRINGL(&func
, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1230 add_next_index_stringl(&arg
, "HttpResponse", lenof("HttpResponse"), 1);
1231 add_next_index_stringl(&arg
, "send", lenof("send"), 1);
1233 call_user_function(EG(function_table
), NULL
, &func
, &retval
, 1, argp TSRMLS_CC
);
1239 #endif /* ZEND_ENGINE_2 && !WONKY */
1246 * vim600: noet sw=4 ts=4 fdm=marker
1247 * vim<600: noet sw=4 ts=4