- relicense with a BSD style license
[m6w6/ext-http] / http_response_object.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
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 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15
16 #ifdef HAVE_CONFIG_H
17 # include "config.h"
18 #endif
19 #include "php.h"
20
21 #include "missing.h"
22
23 /* broken static properties in PHP 5.0 */
24 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
25
26 #include "SAPI.h"
27 #include "php_ini.h"
28
29 #include "php_http.h"
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"
37
38 #ifdef HTTP_HAVE_MHASH
39 # include <mhash.h>
40 #endif
41 #ifdef HTTP_HAVE_MAGIC
42 # include <magic.h>
43 #endif
44
45 ZEND_EXTERN_MODULE_GLOBALS(http);
46
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)
51
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))
56
57 HTTP_BEGIN_ARGS(setHeader, 2)
58 HTTP_ARG_VAL(name, 0)
59 HTTP_ARG_VAL(value, 0)
60 HTTP_ARG_VAL(replace, 0)
61 HTTP_END_ARGS;
62
63 HTTP_BEGIN_ARGS(getHeader, 0)
64 HTTP_ARG_VAL(name, 0)
65 HTTP_END_ARGS;
66
67 HTTP_EMPTY_ARGS(getETag, 0);
68 HTTP_BEGIN_ARGS(setETag, 1)
69 HTTP_ARG_VAL(etag, 0)
70 HTTP_END_ARGS;
71
72 HTTP_EMPTY_ARGS(getLastModified, 0);
73 HTTP_BEGIN_ARGS(setLastModified, 1)
74 HTTP_ARG_VAL(timestamp, 0)
75 HTTP_END_ARGS;
76
77 HTTP_EMPTY_ARGS(getCache, 0);
78 HTTP_BEGIN_ARGS(setCache, 1)
79 HTTP_ARG_VAL(cache, 0)
80 HTTP_END_ARGS;
81
82 HTTP_EMPTY_ARGS(getGzip, 0);
83 HTTP_BEGIN_ARGS(setGzip, 1)
84 HTTP_ARG_VAL(gzip, 0)
85 HTTP_END_ARGS;
86
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)
91 HTTP_END_ARGS;
92
93 HTTP_EMPTY_ARGS(getContentType, 0);
94 HTTP_BEGIN_ARGS(setContentType, 1)
95 HTTP_ARG_VAL(content_type, 0)
96 HTTP_END_ARGS;
97
98 HTTP_BEGIN_ARGS(guessContentType, 1)
99 HTTP_ARG_VAL(magic_file, 0)
100 HTTP_ARG_VAL(magic_mode, 0)
101 HTTP_END_ARGS;
102
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)
107 HTTP_END_ARGS;
108
109 HTTP_EMPTY_ARGS(getThrottleDelay, 0);
110 HTTP_BEGIN_ARGS(setThrottleDelay, 1)
111 HTTP_ARG_VAL(seconds, 0)
112 HTTP_END_ARGS;
113
114 HTTP_EMPTY_ARGS(getBufferSize, 0);
115 HTTP_BEGIN_ARGS(setBufferSize, 1)
116 HTTP_ARG_VAL(bytes, 0)
117 HTTP_END_ARGS;
118
119 HTTP_EMPTY_ARGS(getData, 0);
120 HTTP_BEGIN_ARGS(setData, 1)
121 HTTP_ARG_VAL(data, 0)
122 HTTP_END_ARGS;
123
124 HTTP_EMPTY_ARGS(getStream, 0);
125 HTTP_BEGIN_ARGS(setStream, 1)
126 HTTP_ARG_VAL(stream, 0)
127 HTTP_END_ARGS;
128
129 HTTP_EMPTY_ARGS(getFile, 0);
130 HTTP_BEGIN_ARGS(setFile, 1)
131 HTTP_ARG_VAL(filepath, 0)
132 HTTP_END_ARGS;
133
134 HTTP_BEGIN_ARGS(send, 0)
135 HTTP_ARG_VAL(clean_ob, 0)
136 HTTP_END_ARGS;
137
138 HTTP_EMPTY_ARGS(capture, 0);
139
140 HTTP_BEGIN_ARGS(redirect, 0)
141 HTTP_ARG_VAL(url, 0)
142 HTTP_ARG_VAL(params, 0)
143 HTTP_ARG_VAL(session, 0)
144 HTTP_ARG_VAL(permanent, 0)
145 HTTP_END_ARGS;
146
147 HTTP_BEGIN_ARGS(status, 1)
148 HTTP_ARG_VAL(code, 0)
149 HTTP_END_ARGS;
150
151 HTTP_EMPTY_ARGS(getRequestHeaders, 0);
152 HTTP_EMPTY_ARGS(getRequestBody, 0);
153
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);
158
159 zend_class_entry *http_response_object_ce;
160 zend_function_entry http_response_object_fe[] = {
161
162 HTTP_RESPONSE_ME(setHeader, ZEND_ACC_PUBLIC)
163 HTTP_RESPONSE_ME(getHeader, ZEND_ACC_PUBLIC)
164
165 HTTP_RESPONSE_ME(setETag, ZEND_ACC_PUBLIC)
166 HTTP_RESPONSE_ME(getETag, ZEND_ACC_PUBLIC)
167
168 HTTP_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
169 HTTP_RESPONSE_ME(getLastModified, ZEND_ACC_PUBLIC)
170
171 HTTP_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
172 HTTP_RESPONSE_ME(getContentDisposition, ZEND_ACC_PUBLIC)
173
174 HTTP_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
175 HTTP_RESPONSE_ME(getContentType, ZEND_ACC_PUBLIC)
176
177 HTTP_RESPONSE_ME(guessContentType, ZEND_ACC_PUBLIC)
178
179 HTTP_RESPONSE_ME(setCache, ZEND_ACC_PUBLIC)
180 HTTP_RESPONSE_ME(getCache, ZEND_ACC_PUBLIC)
181
182 HTTP_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
183 HTTP_RESPONSE_ME(getCacheControl, ZEND_ACC_PUBLIC)
184
185 HTTP_RESPONSE_ME(setGzip, ZEND_ACC_PUBLIC)
186 HTTP_RESPONSE_ME(getGzip, ZEND_ACC_PUBLIC)
187
188 HTTP_RESPONSE_ME(setThrottleDelay, ZEND_ACC_PUBLIC)
189 HTTP_RESPONSE_ME(getThrottleDelay, ZEND_ACC_PUBLIC)
190
191 HTTP_RESPONSE_ME(setBufferSize, ZEND_ACC_PUBLIC)
192 HTTP_RESPONSE_ME(getBufferSize, ZEND_ACC_PUBLIC)
193
194 HTTP_RESPONSE_ME(setData, ZEND_ACC_PUBLIC)
195 HTTP_RESPONSE_ME(getData, ZEND_ACC_PUBLIC)
196
197 HTTP_RESPONSE_ME(setFile, ZEND_ACC_PUBLIC)
198 HTTP_RESPONSE_ME(getFile, ZEND_ACC_PUBLIC)
199
200 HTTP_RESPONSE_ME(setStream, ZEND_ACC_PUBLIC)
201 HTTP_RESPONSE_ME(getStream, ZEND_ACC_PUBLIC)
202
203 HTTP_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
204 HTTP_RESPONSE_ME(capture, ZEND_ACC_PUBLIC)
205
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)
210
211 EMPTY_FUNCTION_ENTRY
212 };
213
214 PHP_MINIT_FUNCTION(http_response_object)
215 {
216 HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0);
217 http_response_object_declare_default_properties();
218 return SUCCESS;
219 }
220
221 static inline void _http_response_object_declare_default_properties(TSRMLS_D)
222 {
223 zend_class_entry *ce = http_response_object_ce;
224
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);
240
241 #ifndef WONKY
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);
246
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);
250
251 # ifdef HTTP_HAVE_MHASH
252 {
253 int l, i, c = mhash_count();
254
255 for (i = 0; i <= c; ++i) {
256 char const_name[256] = {0};
257 const char *hash_name = mhash_get_hash_name_static(i);
258
259 if (hash_name) {
260 l = snprintf(const_name, 255, "ETAG_MHASH_%s", hash_name);
261 zend_declare_class_constant_long(ce, const_name, l, i TSRMLS_CC);
262 }
263 }
264 }
265 # endif /* HTTP_HAVE_MHASH */
266 #endif /* WONKY */
267 }
268
269 static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC)
270 {
271 phpstr_appendl(PHPSTR(arg), ((sapi_header_struct *)data)->header);
272 phpstr_appends(PHPSTR(arg), HTTP_CRLF);
273 }
274
275 /* ### USERLAND ### */
276
277 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
278 *
279 * Send an HTTP header.
280 *
281 * Expects a string parameter containing the name of the header and a mixed
282 * parameter containing the value of the header, which will be converted to
283 * a string. Additionally accepts an optional boolean parameter, which
284 * specifies whether an existing header should be replaced. If the second
285 * parameter is unset no header with this name will be sent.
286 *
287 * Returns TRUE on success, or FALSE on failure.
288 *
289 * Throws HttpHeaderException if http.only_exceptions is TRUE.
290 */
291 PHP_METHOD(HttpResponse, setHeader)
292 {
293 zend_bool replace = 1;
294 char *name;
295 int name_len = 0;
296 zval *value = NULL;
297
298 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz/!|b", &name, &name_len, &value, &replace)) {
299 RETURN_FALSE;
300 }
301 if (SG(headers_sent)) {
302 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot add another header when headers have already been sent");
303 RETURN_FALSE;
304 }
305 if (!name_len) {
306 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot send anonymous headers");
307 RETURN_FALSE;
308 }
309
310 /* delete header if value == null */
311 if (!value || Z_TYPE_P(value) == IS_NULL) {
312 RETURN_SUCCESS(http_send_header_ex(name, name_len, "", 0, replace, NULL));
313 }
314 /* send multiple header if replace is false and value is an array */
315 if (!replace && Z_TYPE_P(value) == IS_ARRAY) {
316 zval **data;
317
318 FOREACH_VAL(value, data) {
319 convert_to_string_ex(data);
320 if (SUCCESS != http_send_header_ex(name, name_len, Z_STRVAL_PP(data), Z_STRLEN_PP(data), 0, NULL)) {
321 RETURN_FALSE;
322 }
323 }
324 RETURN_TRUE;
325 }
326 /* send standard header */
327 if (Z_TYPE_P(value) != IS_STRING) {
328 convert_to_string_ex(&value);
329 }
330 RETURN_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL));
331 }
332 /* }}} */
333
334 /* {{{ proto static mixed HttpResponse::getHeader([string name])
335 *
336 * Get header(s) about to be sent.
337 *
338 * Accepts a string as optional parameter which specifies the name of the
339 * header to read. If the parameter is empty or omitted, an associative array
340 * with all headers will be returned.
341 *
342 * Returns either a string containing the value of the header matching name,
343 * FALSE on failure, or an associative array with all headers.
344 */
345 PHP_METHOD(HttpResponse, getHeader)
346 {
347 char *name = NULL;
348 int name_len = 0;
349 phpstr headers;
350
351 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &name, &name_len)) {
352 RETURN_FALSE;
353 }
354
355 phpstr_init(&headers);
356 zend_llist_apply_with_argument(&SG(sapi_headers).headers, http_grab_response_headers, &headers TSRMLS_CC);
357 phpstr_fix(&headers);
358
359 if (name && name_len) {
360 zval **header;
361 HashTable headers_ht;
362
363 zend_hash_init(&headers_ht, sizeof(zval *), NULL, ZVAL_PTR_DTOR, 0);
364 if ( (SUCCESS == http_parse_headers_ex(PHPSTR_VAL(&headers), &headers_ht, 1)) &&
365 (SUCCESS == zend_hash_find(&headers_ht, name, name_len + 1, (void **) &header))) {
366 RETVAL_ZVAL(*header, 1, 0);
367 } else {
368 RETVAL_NULL();
369 }
370 zend_hash_destroy(&headers_ht);
371 } else {
372 array_init(return_value);
373 http_parse_headers_ex(PHPSTR_VAL(&headers), Z_ARRVAL_P(return_value), 1);
374 }
375
376 phpstr_dtor(&headers);
377 }
378 /* }}} */
379
380 /* {{{ proto static bool HttpResponse::setCache(bool cache)
381 *
382 * Whether it sould be attempted to cache the entitity.
383 * This will result in necessary caching headers and checks of clients
384 * "If-Modified-Since" and "If-None-Match" headers. If one of those headers
385 * matches a "304 Not Modified" status code will be issued.
386 *
387 * NOTE: If you're using sessions, be shure that you set session.cache_limiter
388 * to something more appropriate than "no-cache"!
389 *
390 * Expects a boolean as parameter specifying whether caching should be attempted.
391 *
392 * Returns TRUE ons success, or FALSE on failure.
393 */
394 PHP_METHOD(HttpResponse, setCache)
395 {
396 zend_bool do_cache = 0;
397
398 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) {
399 RETURN_FALSE;
400 }
401
402 RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache, do_cache));
403 }
404 /* }}} */
405
406 /* {{{ proto static bool HttpResponse::getCache()
407 *
408 * Get current caching setting.
409 *
410 * Returns TRUE if caching should be attempted, else FALSE.
411 */
412 PHP_METHOD(HttpResponse, getCache)
413 {
414 NO_ARGS;
415
416 IF_RETVAL_USED {
417 zval *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache));
418
419 RETURN_ZVAL(cache, 1, 0);
420 }
421 }
422 /* }}}*/
423
424 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
425 *
426 * Enable on-thy-fly gzipping of the sent entity.
427 *
428 * Expects a boolean as parameter indicating if GZip compression should be enabled.
429 *
430 * Returns TRUE on success, or FALSE on failure.
431 */
432 PHP_METHOD(HttpResponse, setGzip)
433 {
434 zend_bool do_gzip = 0;
435
436 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) {
437 RETURN_FALSE;
438 }
439
440 RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip, do_gzip));
441 }
442 /* }}} */
443
444 /* {{{ proto static bool HttpResponse::getGzip()
445 *
446 * Get current gzipping setting.
447 *
448 * Returns TRUE if GZip compression is enabled, else FALSE.
449 */
450 PHP_METHOD(HttpResponse, getGzip)
451 {
452 NO_ARGS;
453
454 IF_RETVAL_USED {
455 zval *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip));
456
457 RETURN_ZVAL(gzip, 1, 0);
458 }
459 }
460 /* }}} */
461
462 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, int max_age = 0])
463 *
464 * Set a custom cache-control header, usually being "private" or "public";
465 * The max_age parameter controls how long the cache entry is valid on the client side.
466 *
467 * Expects a string parameter containing the primary cache control setting.
468 * Addtitionally accepts an int parameter specifying the max-age setting.
469 *
470 * Returns TRUE on success, or FALSE if control does not match one of
471 * "public" , "private" or "no-cache".
472 *
473 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
474 */
475 PHP_METHOD(HttpResponse, setCacheControl)
476 {
477 char *ccontrol, *cctl;
478 int cc_len;
479 long max_age = 0;
480
481 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &ccontrol, &cc_len, &max_age)) {
482 RETURN_FALSE;
483 }
484
485 if (strcmp(ccontrol, "public") && strcmp(ccontrol, "private") && strcmp(ccontrol, "no-cache")) {
486 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
487 RETURN_FALSE;
488 } else {
489 size_t cctl_len = spprintf(&cctl, 0, "%s, must-revalidate, max_age=%ld", ccontrol, max_age);
490 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl, cctl, cctl_len));
491 efree(cctl);
492 }
493 }
494 /* }}} */
495
496 /* {{{ proto static string HttpResponse::getCacheControl()
497 *
498 * Get current Cache-Control header setting.
499 *
500 * Returns the current cache control setting as a string like sent in a header.
501 */
502 PHP_METHOD(HttpResponse, getCacheControl)
503 {
504 NO_ARGS;
505
506 IF_RETVAL_USED {
507 zval *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl));
508
509 RETURN_ZVAL(ccontrol, 1, 0);
510 }
511 }
512 /* }}} */
513
514 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
515 *
516 * Set the content-type of the sent entity.
517 *
518 * Expects a string as parameter specifying the content type of the sent entity.
519 *
520 * Returns TRUE on success, or FALSE if the content type does not seem to
521 * contain a primary and secondary content type part.
522 *
523 * Throws HttpInvalidParamException if http.only_exceptions is TRUE.
524 */
525 PHP_METHOD(HttpResponse, setContentType)
526 {
527 char *ctype;
528 int ctype_len;
529
530 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) {
531 RETURN_FALSE;
532 }
533
534 HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE);
535 RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len));
536 }
537 /* }}} */
538
539 /* {{{ proto static string HttpResponse::getContentType()
540 *
541 * Get current Content-Type header setting.
542 *
543 * Returns the currently set content type as string.
544 */
545 PHP_METHOD(HttpResponse, getContentType)
546 {
547 NO_ARGS;
548
549 IF_RETVAL_USED {
550 zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType));
551
552 RETURN_ZVAL(ctype, 1, 0);
553 }
554 }
555 /* }}} */
556
557 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
558 *
559 * Attempts to guess the content type of supplied payload through libmagic.
560 * If the attempt is successful, the guessed content type will automatically
561 * be set as response content type.
562 *
563 * Expects a string parameter specifying the magic.mime database to use.
564 * Additionally accepts an optional int parameter, being flags for libmagic.
565 *
566 * Returns the guessed content type on success, or FALSE on failure.
567 *
568 * Throws HttpRuntimeException, HttpInvalidParamException
569 * if http.only_exceptions is TRUE.
570 */
571 PHP_METHOD(HttpResponse, guessContentType)
572 {
573 char *magic_file, *ct = NULL;
574 int magic_file_len;
575 long magic_mode = 0;
576
577 RETVAL_FALSE;
578
579 #ifdef HTTP_HAVE_MAGIC
580 magic_mode = MAGIC_MIME;
581
582 SET_EH_THROW_HTTP();
583 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &magic_file, &magic_file_len, &magic_mode)) {
584 switch (Z_LVAL_P(GET_STATIC_PROP(mode))) {
585 case SEND_DATA:
586 {
587 zval *data = GET_STATIC_PROP(data);
588 ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(data), Z_STRLEN_P(data), SEND_DATA);
589 }
590 break;
591
592 case SEND_RSRC:
593 {
594 php_stream *s;
595 zval *z = GET_STATIC_PROP(stream);
596 z->type = IS_RESOURCE;
597 php_stream_from_zval(s, &z);
598 ct = http_guess_content_type(magic_file, magic_mode, s, 0, SEND_RSRC);
599 }
600 break;
601
602 default:
603 ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(GET_STATIC_PROP(file)), 0, -1);
604 break;
605 }
606 if (ct) {
607 UPD_STATIC_PROP(string, contentType, ct);
608 RETVAL_STRING(ct, 0);
609 }
610 }
611 SET_EH_NORMAL();
612 #else
613 http_error(HE_THROW, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available");
614 #endif
615 }
616 /* }}} */
617
618 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
619 *
620 * Set the Content-Disposition. The Content-Disposition header is very useful
621 * if the data actually sent came from a file or something similar, that should
622 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
623 *
624 * Expects a string parameter specifying the file name the "Save as..." dialogue
625 * should display. Optionally accepts a bool parameter, which, if set to true
626 * and the user agent knows how to handle the content type, will probably not
627 * cause the popup window to be shown.
628 *
629 * Returns TRUE on success or FALSE on failure.
630 */
631 PHP_METHOD(HttpResponse, setContentDisposition)
632 {
633 char *file, *cd;
634 int file_len;
635 size_t cd_len;
636 zend_bool send_inline = 0;
637
638 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) {
639 RETURN_FALSE;
640 }
641
642 cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file);
643 RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len));
644 efree(cd);
645 }
646 /* }}} */
647
648 /* {{{ proto static string HttpResponse::getContentDisposition()
649 *
650 * Get current Content-Disposition setting.
651 *
652 * Returns the current content disposition as string like sent in a header.
653 */
654 PHP_METHOD(HttpResponse, getContentDisposition)
655 {
656 NO_ARGS;
657
658 IF_RETVAL_USED {
659 zval *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition));
660
661 RETURN_ZVAL(cd, 1, 0);
662 }
663 }
664 /* }}} */
665
666 /* {{{ proto static bool HttpResponse::setETag(string etag)
667 *
668 * Set a custom ETag. Use this only if you know what you're doing.
669 *
670 * Expects an unquoted string as parameter containing the ETag.
671 *
672 * Returns TRUE on success, or FALSE on failure.
673 */
674 PHP_METHOD(HttpResponse, setETag)
675 {
676 char *etag;
677 int etag_len;
678
679 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) {
680 RETURN_FALSE;
681 }
682
683 RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len));
684 }
685 /* }}} */
686
687 /* {{{ proto static string HttpResponse::getETag()
688 *
689 * Get calculated or previously set custom ETag.
690 *
691 * Returns the calculated or previously set ETag as unquoted string.
692 */
693 PHP_METHOD(HttpResponse, getETag)
694 {
695 NO_ARGS;
696
697 IF_RETVAL_USED {
698 zval *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag));
699
700 RETURN_ZVAL(etag, 1, 0);
701 }
702 }
703 /* }}} */
704
705 /* {{{ proto static bool HttpResponse::setLastModified(int timestamp)
706 *
707 * Set a custom Last-Modified date.
708 *
709 * Expects an unix timestamp as parameter representing the last modification
710 * time of the sent entity.
711 *
712 * Returns TRUE on success, or FALSE on failure.
713 */
714 PHP_METHOD(HttpResponse, setLastModified)
715 {
716 long lm;
717
718 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &lm)) {
719 RETURN_FALSE;
720 }
721
722 RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified, lm));
723 }
724 /* }}} */
725
726 /* {{{ proto static int HttpResponse::getLastModified()
727 *
728 * Get calculated or previously set custom Last-Modified date.
729 *
730 * Returns the calculated or previously set unix timestamp.
731 */
732 PHP_METHOD(HttpResponse, getLastModified)
733 {
734 NO_ARGS;
735
736 IF_RETVAL_USED {
737 zval *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified));
738
739 RETURN_ZVAL(lm, 1, 0);
740 }
741 }
742 /* }}} */
743
744 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
745 *
746 * Sets the throttle delay for use with HttpResponse::setBufferSize().
747 *
748 * Provides a basic throttling mechanism, which will yield the current process
749 * resp. thread until the entity has been completely sent, though.
750 *
751 * Note: This doesn't really work with the FastCGI SAPI.
752 *
753 * Expects a double parameter specifying the seconds too sleep() after
754 * each chunk sent.
755 *
756 * Returns TRUE on success, or FALSE on failure.
757 */
758 PHP_METHOD(HttpResponse, setThrottleDelay)
759 {
760 double seconds;
761
762 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d", &seconds)) {
763 RETURN_FALSE;
764 }
765 RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay, seconds));
766 }
767 /* }}} */
768
769 /* {{{ proto static double HttpResponse::getThrottleDelay()
770 *
771 * Get the current throttle delay.
772 *
773 * Returns a double representing the throttle delay in seconds.
774 */
775 PHP_METHOD(HttpResponse, getThrottleDelay)
776 {
777 NO_ARGS;
778
779 IF_RETVAL_USED {
780 zval *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay));
781
782 RETURN_ZVAL(delay, 1, 0);
783 }
784 }
785 /* }}} */
786
787 /* {{{ proto static bool HttpResponse::setBufferSize(int bytes)
788 *
789 * Sets the send buffer size for use with HttpResponse::setThrottleDelay().
790 *
791 * Provides a basic throttling mechanism, which will yield the current process
792 * resp. thread until the entity has been completely sent, though.
793 *
794 * Note: This doesn't really work with the FastCGI SAPI.
795 *
796 * Expects an int parameter representing the chunk size in bytes.
797 *
798 * Returns TRUE on success, or FALSE on failure.
799 */
800 PHP_METHOD(HttpResponse, setBufferSize)
801 {
802 long bytes;
803
804 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &bytes)) {
805 RETURN_FALSE;
806 }
807 RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize, bytes));
808 }
809 /* }}} */
810
811 /* {{{ proto static int HttpResponse::getBufferSize()
812 *
813 * Get current buffer size.
814 *
815 * Returns an int representing the current buffer size in bytes.
816 */
817 PHP_METHOD(HttpResponse, getBufferSize)
818 {
819 NO_ARGS;
820
821 IF_RETVAL_USED {
822 zval *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize));
823
824 RETURN_ZVAL(size, 1, 0);
825 }
826 }
827 /* }}} */
828
829 /* {{{ proto static bool HttpResponse::setData(mixed data)
830 *
831 * Set the data to be sent.
832 *
833 * Expects one parameter, which will be converted to a string and contains
834 * the data to send.
835 *
836 * Returns TRUE on success, or FALSE on failure.
837 */
838 PHP_METHOD(HttpResponse, setData)
839 {
840 char *etag;
841 zval *the_data;
842
843 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) {
844 RETURN_FALSE;
845 }
846 if (Z_TYPE_P(the_data) != IS_STRING) {
847 convert_to_string_ex(&the_data);
848 }
849
850 if ( (SUCCESS != SET_STATIC_PROP(data, the_data)) ||
851 (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_DATA))) {
852 RETURN_FALSE;
853 }
854
855 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA));
856 if (etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA)) {
857 UPD_STATIC_PROP(string, eTag, etag);
858 efree(etag);
859 }
860
861 RETURN_TRUE;
862 }
863 /* }}} */
864
865 /* {{{ proto static string HttpResponse::getData()
866 *
867 * Get the previously set data to be sent.
868 *
869 * Returns a string containing the previously set data to send.
870 */
871 PHP_METHOD(HttpResponse, getData)
872 {
873 NO_ARGS;
874
875 IF_RETVAL_USED {
876 zval *the_data = GET_STATIC_PROP(data);
877
878 RETURN_ZVAL(the_data, 1, 0);
879 }
880 }
881 /* }}} */
882
883 /* {{{ proto static bool HttpResponse::setStream(resource stream)
884 *
885 * Set the resource to be sent.
886 *
887 * Expects a resource parameter referencing an already opened stream from
888 * which the data to send will be read.
889 *
890 * Returns TRUE on success, or FALSE on failure.
891 */
892 PHP_METHOD(HttpResponse, setStream)
893 {
894 char *etag;
895 zval *the_stream;
896 php_stream *the_real_stream;
897 php_stream_statbuf ssb;
898
899 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) {
900 RETURN_FALSE;
901 }
902
903 php_stream_from_zval(the_real_stream, &the_stream);
904 if (php_stream_stat(the_real_stream, &ssb)) {
905 RETURN_FALSE;
906 }
907
908 if ( (SUCCESS != UPD_STATIC_PROP(long, stream, Z_LVAL_P(the_stream))) ||
909 (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_RSRC))) {
910 RETURN_FALSE;
911 }
912 zend_list_addref(Z_LVAL_P(the_stream));
913
914 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC));
915 if (etag = http_etag(the_real_stream, 0, SEND_RSRC)) {
916 UPD_STATIC_PROP(string, eTag, etag);
917 efree(etag);
918 }
919
920 RETURN_TRUE;
921 }
922 /* }}} */
923
924 /* {{{ proto static resource HttpResponse::getStream()
925 *
926 * Get the previously set resource to be sent.
927 *
928 * Returns the previously set resource.
929 */
930 PHP_METHOD(HttpResponse, getStream)
931 {
932 NO_ARGS;
933
934 IF_RETVAL_USED {
935 RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream))));
936 }
937 }
938 /* }}} */
939
940 /* {{{ proto static bool HttpResponse::setFile(string file)
941 *
942 * Set the file to be sent.
943 *
944 * Expects a string as parameter, specifying the path to the file to send.
945 *
946 * Returns TRUE on success, or FALSE on failure.
947 */
948 PHP_METHOD(HttpResponse, setFile)
949 {
950 char *the_file, *etag;
951 int file_len;
952 php_stream_statbuf ssb;
953
954 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &the_file, &file_len)) {
955 RETURN_FALSE;
956 }
957
958 if (php_stream_stat_path(the_file, &ssb)) {
959 RETURN_FALSE;
960 }
961
962 if ( (SUCCESS != UPD_STATIC_STRL(file, the_file, file_len)) ||
963 (SUCCESS != UPD_STATIC_PROP(long, mode, -1))) {
964 RETURN_FALSE;
965 }
966
967 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
968 if (etag = http_etag(the_file, 0, -1)) {
969 UPD_STATIC_PROP(string, eTag, etag);
970 efree(etag);
971 }
972
973 RETURN_TRUE;
974 }
975 /* }}} */
976
977 /* {{{ proto static string HttpResponse::getFile()
978 *
979 * Get the previously set file to be sent.
980 *
981 * Returns the previously set path to the file to send as string.
982 */
983 PHP_METHOD(HttpResponse, getFile)
984 {
985 NO_ARGS;
986
987 IF_RETVAL_USED {
988 zval *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file));
989
990 RETURN_ZVAL(the_file, 1, 0);
991 }
992 }
993 /* }}} */
994
995 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
996 *
997 * Finally send the entity.
998 *
999 * Accepts an optional boolean parameter, specifying wheter the ouput
1000 * buffers should be discarded prior sending. A successful caching attempt
1001 * will cause a script termination, and write a log entry if the INI setting
1002 * http.cache_log is set.
1003 *
1004 * Returns TRUE on success, or FALSE on failure.
1005 *
1006 * Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.
1007 *
1008 * Example:
1009 * <pre>
1010 * <?php
1011 * HttpResponse::setCache(true);
1012 * HttpResponse::setContentType('application/pdf');
1013 * HttpResponse::setContentDisposition("$user.pdf", false);
1014 * HttpResponse::setFile('sheet.pdf');
1015 * HttpResponse::send();
1016 * ?>
1017 * </pre>
1018 */
1019 PHP_METHOD(HttpResponse, send)
1020 {
1021 zval *sent;
1022 zend_bool clean_ob = 1;
1023
1024 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &clean_ob)) {
1025 RETURN_FALSE;
1026 }
1027 if (SG(headers_sent)) {
1028 http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, headers have already been sent");
1029 RETURN_FALSE;
1030 }
1031
1032 sent = GET_STATIC_PROP(sent);
1033 if (zval_is_true(sent)) {
1034 http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, response has already been sent");
1035 RETURN_FALSE;
1036 } else {
1037 Z_LVAL_P(sent) = 1;
1038 }
1039
1040 /* capture mode */
1041 if (zval_is_true(GET_STATIC_PROP(catch))) {
1042 zval *the_data;
1043
1044 MAKE_STD_ZVAL(the_data);
1045 php_ob_get_buffer(the_data TSRMLS_CC);
1046 SET_STATIC_PROP(data, the_data);
1047 ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
1048
1049 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
1050 char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA);
1051 if (etag) {
1052 UPD_STATIC_PROP(string, eTag, etag);
1053 efree(etag);
1054 }
1055 }
1056 zval_ptr_dtor(&the_data);
1057
1058 clean_ob = 1;
1059 }
1060
1061 if (clean_ob) {
1062 /* interrupt on-the-fly etag generation */
1063 HTTP_G(etag).started = 0;
1064 /* discard previous output buffers */
1065 php_end_ob_buffers(0 TSRMLS_CC);
1066 }
1067
1068 /* caching */
1069 if (zval_is_true(GET_STATIC_PROP(cache))) {
1070 zval *cctl, *etag, *lmod;
1071
1072 etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag));
1073 lmod = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified));
1074 cctl = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl));
1075
1076 http_cache_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag), Z_STRVAL_P(cctl), Z_STRLEN_P(cctl));
1077 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));
1078 }
1079
1080 /* content type */
1081 {
1082 zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType));
1083 if (Z_STRLEN_P(ctype)) {
1084 http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype));
1085 } else {
1086 char *ctypes = INI_STR("default_mimetype");
1087 size_t ctlen = ctypes ? strlen(ctypes) : 0;
1088
1089 if (ctlen) {
1090 http_send_content_type(ctypes, ctlen);
1091 } else {
1092 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
1093 }
1094 }
1095 }
1096
1097 /* content disposition */
1098 {
1099 zval *cd = GET_STATIC_PROP(contentDisposition);
1100 if (Z_STRLEN_P(cd)) {
1101 http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL);
1102 }
1103 }
1104
1105 /* throttling */
1106 HTTP_G(send).buffer_size = Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize)));
1107 HTTP_G(send).throttle_delay = Z_DVAL_P(convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay)));
1108
1109 /* gzip */
1110 HTTP_G(send).gzip_encoding = zval_is_true(GET_STATIC_PROP(gzip));
1111
1112 /* start ob */
1113 php_start_ob_buffer(NULL, HTTP_G(send).buffer_size, 0 TSRMLS_CC);
1114
1115 /* send */
1116 switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
1117 {
1118 case SEND_DATA:
1119 {
1120 zval *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data));
1121 RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
1122 }
1123
1124 case SEND_RSRC:
1125 {
1126 php_stream *the_real_stream;
1127 zval *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream));
1128 the_stream->type = IS_RESOURCE;
1129 php_stream_from_zval(the_real_stream, &the_stream);
1130 RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
1131 }
1132
1133 default:
1134 {
1135 RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1));
1136 }
1137 }
1138 }
1139 /* }}} */
1140
1141 /* {{{ proto static void HttpResponse::capture()
1142 *
1143 * Capture script output.
1144 *
1145 * Example:
1146 * <pre>
1147 * <?php
1148 * HttpResponse::setCache(true);
1149 * HttpResponse::capture();
1150 * // script follows
1151 * ?>
1152 * </pre>
1153 */
1154 PHP_METHOD(HttpResponse, capture)
1155 {
1156 NO_ARGS;
1157
1158 UPD_STATIC_PROP(long, catch, 1);
1159
1160 php_end_ob_buffers(0 TSRMLS_CC);
1161 php_start_ob_buffer(NULL, 40960, 0 TSRMLS_CC);
1162
1163 /* register shutdown function */
1164 {
1165 zval func, retval, arg, *argp[1];
1166
1167 INIT_PZVAL(&arg);
1168 INIT_PZVAL(&func);
1169 INIT_PZVAL(&retval);
1170 ZVAL_STRINGL(&func, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1171
1172 array_init(&arg);
1173 add_next_index_stringl(&arg, "HttpResponse", lenof("HttpResponse"), 1);
1174 add_next_index_stringl(&arg, "send", lenof("send"), 1);
1175 argp[0] = &arg;
1176 call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC);
1177 zval_dtor(&arg);
1178 }
1179 }
1180 /* }}} */
1181
1182 #endif /* ZEND_ENGINE_2 && !WONKY */
1183
1184 /*
1185 * Local variables:
1186 * tab-width: 4
1187 * c-basic-offset: 4
1188 * End:
1189 * vim600: noet sw=4 ts=4 fdm=marker
1190 * vim<600: noet sw=4 ts=4
1191 */
1192