2 +----------------------------------------------------------------------+
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
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"
39 ZEND_EXTERN_MODULE_GLOBALS(http
);
41 #define USE_STATIC_PROP() USE_STATIC_PROP_EX(http_response_object_ce)
42 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_response_object_ce, n)
43 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_response_object_ce, n, v)
44 #define SET_STATIC_PROP_STRING(n, s, d) SET_STATIC_PROP_STRING_EX(http_response_object_ce, n, s, d)
45 #define SET_STATIC_PROP_STRINGL(n, s, l, d) SET_STATIC_PROP_STRINGL_EX(http_response_object_ce, n, s, l, d)
47 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpResponse, method, 0, req_args)
48 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpResponse, method, ret_ref)
49 #define HTTP_RESPONSE_ME(method, visibility) PHP_ME(HttpResponse, method, HTTP_ARGS(HttpResponse, method), visibility|ZEND_ACC_STATIC)
51 HTTP_EMPTY_ARGS(getETag
, 0);
52 HTTP_BEGIN_ARGS(setETag
, 1)
56 HTTP_EMPTY_ARGS(getCache
, 0);
57 HTTP_BEGIN_ARGS(setCache
, 1)
58 HTTP_ARG_VAL(cache
, 0)
61 HTTP_EMPTY_ARGS(getGzip
, 0);
62 HTTP_BEGIN_ARGS(setGzip
, 1)
66 HTTP_EMPTY_ARGS(getCacheControl
, 0);
67 HTTP_BEGIN_ARGS(setCacheControl
, 1)
68 HTTP_ARG_VAL(cache_control
, 0)
69 HTTP_ARG_VAL(max_age
, 0)
72 HTTP_EMPTY_ARGS(getContentType
, 0);
73 HTTP_BEGIN_ARGS(setContentType
, 1)
74 HTTP_ARG_VAL(content_type
, 0)
77 HTTP_EMPTY_ARGS(getContentDisposition
, 0);
78 HTTP_BEGIN_ARGS(setContentDisposition
, 1)
79 HTTP_ARG_VAL(filename
, 0)
80 HTTP_ARG_VAL(send_inline
, 0)
83 HTTP_EMPTY_ARGS(getThrottleDelay
, 0);
84 HTTP_BEGIN_ARGS(setThrottleDelay
, 1)
85 HTTP_ARG_VAL(seconds
, 0)
88 HTTP_EMPTY_ARGS(getBufferSize
, 0);
89 HTTP_BEGIN_ARGS(setBufferSize
, 1)
90 HTTP_ARG_VAL(bytes
, 0)
93 HTTP_EMPTY_ARGS(getData
, 0);
94 HTTP_BEGIN_ARGS(setData
, 1)
98 HTTP_EMPTY_ARGS(getStream
, 0);
99 HTTP_BEGIN_ARGS(setStream
, 1)
100 HTTP_ARG_VAL(stream
, 0)
103 HTTP_EMPTY_ARGS(getFile
, 0);
104 HTTP_BEGIN_ARGS(setFile
, 1)
105 HTTP_ARG_VAL(filepath
, 0)
108 HTTP_BEGIN_ARGS(send
, 0)
109 HTTP_ARG_VAL(clean_ob
, 0)
112 #define http_response_object_declare_default_properties() _http_response_object_declare_default_properties(TSRMLS_C)
113 static inline void _http_response_object_declare_default_properties(TSRMLS_D
);
115 zend_class_entry
*http_response_object_ce
;
116 zend_function_entry http_response_object_fe
[] = {
118 HTTP_RESPONSE_ME(setETag
, ZEND_ACC_PUBLIC
)
119 HTTP_RESPONSE_ME(getETag
, ZEND_ACC_PUBLIC
)
121 HTTP_RESPONSE_ME(setContentDisposition
, ZEND_ACC_PUBLIC
)
122 HTTP_RESPONSE_ME(getContentDisposition
, ZEND_ACC_PUBLIC
)
124 HTTP_RESPONSE_ME(setContentType
, ZEND_ACC_PUBLIC
)
125 HTTP_RESPONSE_ME(getContentType
, ZEND_ACC_PUBLIC
)
127 HTTP_RESPONSE_ME(setCache
, ZEND_ACC_PUBLIC
)
128 HTTP_RESPONSE_ME(getCache
, ZEND_ACC_PUBLIC
)
130 HTTP_RESPONSE_ME(setCacheControl
, ZEND_ACC_PUBLIC
)
131 HTTP_RESPONSE_ME(getCacheControl
, ZEND_ACC_PUBLIC
)
133 HTTP_RESPONSE_ME(setGzip
, ZEND_ACC_PUBLIC
)
134 HTTP_RESPONSE_ME(getGzip
, ZEND_ACC_PUBLIC
)
136 HTTP_RESPONSE_ME(setThrottleDelay
, ZEND_ACC_PUBLIC
)
137 HTTP_RESPONSE_ME(getThrottleDelay
, ZEND_ACC_PUBLIC
)
139 HTTP_RESPONSE_ME(setBufferSize
, ZEND_ACC_PUBLIC
)
140 HTTP_RESPONSE_ME(getBufferSize
, ZEND_ACC_PUBLIC
)
142 HTTP_RESPONSE_ME(setData
, ZEND_ACC_PUBLIC
)
143 HTTP_RESPONSE_ME(getData
, ZEND_ACC_PUBLIC
)
145 HTTP_RESPONSE_ME(setFile
, ZEND_ACC_PUBLIC
)
146 HTTP_RESPONSE_ME(getFile
, ZEND_ACC_PUBLIC
)
148 HTTP_RESPONSE_ME(setStream
, ZEND_ACC_PUBLIC
)
149 HTTP_RESPONSE_ME(getStream
, ZEND_ACC_PUBLIC
)
151 HTTP_RESPONSE_ME(send
, ZEND_ACC_PUBLIC
)
155 static zend_object_handlers http_response_object_handlers
;
157 void _http_response_object_init(INIT_FUNC_ARGS
)
159 HTTP_REGISTER_CLASS(HttpResponse
, http_response_object
, NULL
, 0);
160 http_response_object_declare_default_properties();
163 static inline void _http_response_object_declare_default_properties(TSRMLS_D
)
165 zend_class_entry
*ce
= http_response_object_ce
;
167 DCL_STATIC_PROP(PRIVATE
, bool, sent
, 0);
168 DCL_STATIC_PROP(PRIVATE
, bool, catch, 0);
169 DCL_STATIC_PROP(PRIVATE
, long, mode
, -1);
170 DCL_STATIC_PROP(PROTECTED
, bool, cache
, 0);
171 DCL_STATIC_PROP(PROTECTED
, bool, gzip
, 0);
172 DCL_STATIC_PROP(PROTECTED
, long, stream
, 0);
173 DCL_STATIC_PROP_N(PROTECTED
, file
);
174 DCL_STATIC_PROP_N(PROTECTED
, data
);
175 DCL_STATIC_PROP_N(PROTECTED
, eTag
);
176 DCL_STATIC_PROP(PROTECTED
, long, lastModified
, 0);
177 DCL_STATIC_PROP_N(PROTECTED
, cacheControl
);
178 DCL_STATIC_PROP_N(PROTECTED
, contentType
);
179 DCL_STATIC_PROP_N(PROTECTED
, contentDisposition
);
180 DCL_STATIC_PROP(PROTECTED
, long, bufferSize
, HTTP_SENDBUF_SIZE
);
181 DCL_STATIC_PROP(PROTECTED
, double, throttleDelay
, 0.0);
184 /* ### USERLAND ### */
186 /* {{{ proto bool HttpResponse::setCache(bool cache)
188 * Whether it sould be attempted to cache the entitity.
189 * This will result in necessary caching headers and checks of clients
190 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
191 * matches a "304 Not Modified" status code will be issued.
193 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
194 * to something more appropriate than "no-cache"!
196 PHP_METHOD(HttpResponse
, setCache
)
198 zend_bool do_cache
= 0;
200 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_cache
)) {
204 ZVAL_BOOL(GET_STATIC_PROP(cache
), do_cache
);
209 /* {{{ proto bool HttpResponse::getCache()
211 * Get current caching setting.
213 PHP_METHOD(HttpResponse
, getCache
)
218 RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(cache
)));
223 /* {{{ proto bool HttpResponse::setGzip(bool gzip)
225 * Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET.
227 PHP_METHOD(HttpResponse
, setGzip
)
229 zend_bool do_gzip
= 0;
231 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "b", &do_gzip
)) {
235 ZVAL_BOOL(GET_STATIC_PROP(gzip
), do_gzip
);
240 /* {{{ proto bool HttpResponse::getGzip()
242 * Get current gzipping setting.
244 PHP_METHOD(HttpResponse
, getGzip
)
249 RETURN_BOOL(Z_LVAL_P(GET_STATIC_PROP(gzip
)));
254 /* {{{ proto bool HttpResponse::setCacheControl(string control[, long max_age = 0])
256 * Set a custom cache-control header, usually being "private" or "public";
257 * The max_age parameter controls how long the cache entry is valid on the client side.
259 PHP_METHOD(HttpResponse
, setCacheControl
)
261 char *ccontrol
, *cctl
;
265 #define HTTP_CACHECONTROL_TEMPLATE "%s, must-revalidate, max_age=%ld"
267 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &ccontrol
, &cc_len
, &max_age
)) {
271 if (strcmp(ccontrol
, "public") && strcmp(ccontrol
, "private") && strcmp(ccontrol
, "no-cache")) {
272 http_error_ex(E_WARNING
, HTTP_E_PARAM
, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol
);
276 spprintf(&cctl
, 0, HTTP_CACHECONTROL_TEMPLATE
, ccontrol
, max_age
);
277 SET_STATIC_PROP_STRING(cacheControl
, cctl
, 0);
283 /* {{{ proto string HttpResponse::getCacheControl()
285 * Get current Cache-Control header setting.
287 PHP_METHOD(HttpResponse
, getCacheControl
)
292 zval
*ccontrol
= GET_STATIC_PROP(cacheControl
);
293 RETURN_STRINGL(Z_STRVAL_P(ccontrol
), Z_STRLEN_P(ccontrol
), 1);
298 /* {{{ proto bool HttpResponse::setContentType(string content_type)
300 * Set the content-type of the sent entity.
302 PHP_METHOD(HttpResponse
, setContentType
)
307 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ctype_len
)) {
311 if (!strchr(ctype
, '/')) {
312 http_error_ex(E_WARNING
, HTTP_E_PARAM
, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype
);
317 SET_STATIC_PROP_STRINGL(contentType
, ctype
, ctype_len
, 1);
322 /* {{{ proto string HttpResponse::getContentType()
324 * Get current Content-Type header setting.
326 PHP_METHOD(HttpResponse
, getContentType
)
331 zval
*ctype
= GET_STATIC_PROP(contentType
);
332 RETURN_STRINGL(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
337 /* {{{ proto bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
339 * Set the Content-Disposition of the sent entity. This setting aims to suggest
340 * the receiveing user agent how to handle the sent entity; usually the client
341 * will show the user a "Save As..." popup.
343 PHP_METHOD(HttpResponse
, setContentDisposition
)
347 zend_bool send_inline
= 0;
349 #define HTTP_CONTENTDISPOSITION_TEMPLATE "%s; filename=\"%s\""
351 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &file
, &file_len
, &send_inline
)) {
355 spprintf(&cd
, 0, HTTP_CONTENTDISPOSITION_TEMPLATE
, send_inline
? "inline" : "attachment", file
);
356 SET_STATIC_PROP_STRING(contentDisposition
, cd
, 0);
361 /* {{{ proto string HttpResponse::getContentDisposition()
363 * Get current Content-Disposition setting.
365 PHP_METHOD(HttpResponse
, getContentDisposition
)
370 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
371 RETURN_STRINGL(Z_STRVAL_P(cd
), Z_STRLEN_P(cd
), 1);
376 /* {{{ proto bool HttpResponse::setETag(string etag)
378 * Set a custom ETag. Use this only if you know what you're doing.
380 PHP_METHOD(HttpResponse
, setETag
)
385 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &etag
, &etag_len
)) {
390 SET_STATIC_PROP_STRINGL(eTag
, etag
, etag_len
, 1);
395 /* {{{ proto string HttpResponse::getETag()
397 * Get the previously set custom ETag.
399 PHP_METHOD(HttpResponse
, getETag
)
404 zval
*etag
= GET_STATIC_PROP(eTag
);
405 RETURN_STRINGL(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), 1);
410 /* {{{ proto void HttpResponse::setThrottleDelay(double seconds)
413 PHP_METHOD(HttpResponse
, setThrottleDelay
)
417 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d", &seconds
)) {
418 ZVAL_DOUBLE(GET_STATIC_PROP(throttleDelay
), seconds
);
423 /* {{{ proto double HttpResponse::getThrottleDelay()
426 PHP_METHOD(HttpResponse
, getThrottleDelay
)
431 RETURN_DOUBLE(Z_DVAL_P(GET_STATIC_PROP(throttleDelay
)));
436 /* {{{ proto void HttpResponse::setBufferSize(long bytes)
439 PHP_METHOD(HttpResponse
, setBufferSize
)
443 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &bytes
)) {
444 ZVAL_LONG(GET_STATIC_PROP(bufferSize
), bytes
);
449 /* {{{ proto long HttpResponse::getBufferSize()
452 PHP_METHOD(HttpResponse
, getBufferSize
)
457 RETURN_LONG(Z_LVAL_P(GET_STATIC_PROP(bufferSize
)));
462 /* {{{ proto bool HttpResponse::setData(string data)
464 * Set the data to be sent.
466 PHP_METHOD(HttpResponse
, setData
)
468 zval
*the_data
, **data
;
470 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_data
)) {
473 convert_to_string_ex(&the_data
);
476 SET_STATIC_PROP(data
, the_data
);
477 ZVAL_LONG(GET_STATIC_PROP(lastModified
), http_last_modified(the_data
, SEND_DATA
));
478 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_DATA
);
483 /* {{{ proto string HttpResponse::getData()
485 * Get the previously set data to be sent.
487 PHP_METHOD(HttpResponse
, getData
)
492 zval
*the_data
= GET_STATIC_PROP(data
);
493 RETURN_STRINGL(Z_STRVAL_P(the_data
), Z_STRLEN_P(the_data
), 1);
498 /* {{{ proto bool HttpResponse::setStream(resource stream)
500 * Set the resource to be sent.
502 PHP_METHOD(HttpResponse
, setStream
)
505 php_stream
*the_real_stream
;
507 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &the_stream
)) {
512 php_stream_from_zval(the_real_stream
, &the_stream
);
513 ZVAL_LONG(GET_STATIC_PROP(stream
), Z_LVAL_P(the_stream
));
514 ZVAL_LONG(GET_STATIC_PROP(lastModified
), http_last_modified(the_real_stream
, SEND_RSRC
));
515 ZVAL_LONG(GET_STATIC_PROP(mode
), SEND_RSRC
);
520 /* {{{ proto resource HttpResponse::getStream()
522 * Get the previously set resource to be sent.
524 PHP_METHOD(HttpResponse
, getStream
)
529 RETURN_RESOURCE(Z_LVAL_P(GET_STATIC_PROP(stream
)));
534 /* {{{ proto bool HttpResponse::setFile(string file)
536 * Set the file to be sent.
538 PHP_METHOD(HttpResponse
, setFile
)
542 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &the_file
)) {
546 convert_to_string_ex(&the_file
);
548 SET_STATIC_PROP(file
, the_file
);
549 ZVAL_LONG(GET_STATIC_PROP(lastModified
), http_last_modified(the_file
, -1));
550 ZVAL_LONG(GET_STATIC_PROP(mode
), -1);
556 /* {{{ proto string HttpResponse::getFile()
558 * Get the previously set file to be sent.
560 PHP_METHOD(HttpResponse
, getFile
)
565 zval
*the_file
= GET_STATIC_PROP(file
);
566 RETURN_STRINGL(Z_STRVAL_P(the_file
), Z_STRLEN_P(the_file
), 1);
571 /* {{{ proto bool HttpResponse::send([bool clean_ob = true])
573 * Finally send the entity.
575 PHP_METHOD(HttpResponse
, send
)
577 zval
*do_cache
, *do_gzip
;
578 zend_bool clean_ob
= 1;
580 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &clean_ob
)) {
585 /* interrupt on-the-fly etag generation */
586 HTTP_G(etag
).started
= 0;
587 /* discard previous output buffers */
588 php_end_ob_buffers(0 TSRMLS_CC
);
592 if (Z_LVAL_P(GET_STATIC_PROP(gzip
))) {
593 php_start_ob_buffer_named("ob_gzhandler", 0, 1 TSRMLS_CC
);
595 php_start_ob_buffer(NULL
, 0, 0 TSRMLS_CC
);
599 if (Z_LVAL_P(GET_STATIC_PROP(cache
))) {
602 zval
*cctl
, *etag
, *lmod
;
604 etag
= GET_STATIC_PROP(eTag
);
605 lmod
= GET_STATIC_PROP(lastModified
);
606 cctl
= GET_STATIC_PROP(cacheControl
);
608 http_cache_etag(Z_STRVAL_P(etag
), Z_STRLEN_P(etag
), Z_STRVAL_P(cctl
), Z_STRLEN_P(cctl
));
609 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
));
614 zval
*ctype
= GET_STATIC_PROP(contentType
);
615 if (Z_STRLEN_P(ctype
)) {
616 http_send_content_type(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
));
618 char *ctypes
= INI_STR("default_mimetype");
619 size_t ctlen
= ctypes
? strlen(ctypes
) : 0;
622 http_send_content_type(ctypes
, ctlen
);
624 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
629 /* content disposition */
631 zval
*cd
= GET_STATIC_PROP(contentDisposition
);
632 if (Z_STRLEN_P(cd
)) {
635 spprintf(&cds
, 0, "Content-Disposition: %s", Z_STRVAL_P(cd
));
636 http_send_header(cds
);
643 HTTP_G(send
).buffer_size
= Z_LVAL_P(GET_STATIC_PROP(bufferSize
));
644 HTTP_G(send
).throttle_delay
= Z_DVAL_P(GET_STATIC_PROP(throttleDelay
));
649 switch (Z_LVAL_P(GET_STATIC_PROP(mode
)))
653 zval
*zdata
= GET_STATIC_PROP(data
);
654 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
659 php_stream
*the_real_stream
;
660 zval
*the_stream
= GET_STATIC_PROP(stream
);
661 php_stream_from_zval(the_real_stream
, &the_stream
);
662 RETURN_SUCCESS(http_send_stream(the_real_stream
));
667 RETURN_SUCCESS(http_send_file(Z_STRVAL_P(GET_STATIC_PROP(file
))));
674 #endif /* ZEND_ENGINE_2 */
681 * vim600: noet sw=4 ts=4 fdm=marker
682 * vim<600: noet sw=4 ts=4