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