git.m6w6.name Git - m6w6/ext-http/blob - http_response_object.c

   1 /*
   2    +----------------------------------------------------------------------+
   3    | PECL :: http                                                         |
   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    +----------------------------------------------------------------------+
  14 */
  15
  16 /* $Id$ */
  17
  18
  19 #ifdef HAVE_CONFIG_H
  20 #       include "config.h"
  21 #endif
  22 #include "php.h"
  23
  24 #include "missing.h"
  25
  26 /* broken static properties in PHP 5.0 */
  27 #if defined(ZEND_ENGINE_2) && !defined(WONKY)
  28
  29 #include "SAPI.h"
  30 #include "php_ini.h"
  31
  32 #include "php_http.h"
  33 #include "php_http_api.h"
  34 #include "php_http_std_defs.h"
  35 #include "php_http_response_object.h"
  36 #include "php_http_exception_object.h"
  37 #include "php_http_send_api.h"
  38 #include "php_http_cache_api.h"
  39 #include "php_http_headers_api.h"
  40
  41 #ifdef HTTP_HAVE_MHASH
  42 #       include <mhash.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 void _http_response_object_init(INIT_FUNC_ARGS)
 215 {
 216         HTTP_REGISTER_CLASS(HttpResponse, http_response_object, NULL, 0);
 217         http_response_object_declare_default_properties();
 218 }
 219
 220 static inline void _http_response_object_declare_default_properties(TSRMLS_D)
 221 {
 222         zend_class_entry *ce = http_response_object_ce;
 223
 224         DCL_STATIC_PROP(PRIVATE, bool, sent, 0);
 225         DCL_STATIC_PROP(PRIVATE, bool, catch, 0);
 226         DCL_STATIC_PROP(PRIVATE, long, mode, -1);
 227         DCL_STATIC_PROP(PRIVATE, long, stream, 0);
 228         DCL_STATIC_PROP_N(PRIVATE, file);
 229         DCL_STATIC_PROP_N(PRIVATE, data);
 230         DCL_STATIC_PROP(PROTECTED, bool, cache, 0);
 231         DCL_STATIC_PROP(PROTECTED, bool, gzip, 0);
 232         DCL_STATIC_PROP_N(PROTECTED, eTag);
 233         DCL_STATIC_PROP(PROTECTED, long, lastModified, 0);
 234         DCL_STATIC_PROP_N(PROTECTED, cacheControl);
 235         DCL_STATIC_PROP_N(PROTECTED, contentType);
 236         DCL_STATIC_PROP_N(PROTECTED, contentDisposition);
 237         DCL_STATIC_PROP(PROTECTED, long, bufferSize, HTTP_SENDBUF_SIZE);
 238         DCL_STATIC_PROP(PROTECTED, double, throttleDelay, 0.0);
 239
 240 #ifndef WONKY
 241         DCL_CONST(long, "ETAG_MD5", HTTP_ETAG_MD5);
 242         DCL_CONST(long, "ETAG_SHA1", HTTP_ETAG_SHA1);
 243
 244 #       ifdef HTTP_HAVE_MHASH
 245         {
 246                 int l, i, c = mhash_count();
 247
 248                 for (i = 0; i <= c; ++i) {
 249                         char const_name[256] = {0};
 250                         const char *hash_name = mhash_get_hash_name_static(i);
 251
 252                         if (hash_name) {
 253                                 l = snprintf(const_name, 255, "ETAG_MHASH_%s", hash_name);
 254                                 zend_declare_class_constant_long(ce, const_name, l, i TSRMLS_CC);
 255                         }
 256                 }
 257         }
 258 #       endif /* HTTP_HAVE_MHASH */
 259 #endif /* WONKY */
 260 }
 261
 262 static void _http_grab_response_headers(void *data, void *arg TSRMLS_DC)
 263 {
 264         phpstr_appendl(PHPSTR(arg), ((sapi_header_struct *)data)->header);
 265         phpstr_appends(PHPSTR(arg), HTTP_CRLF);
 266 }
 267
 268 /* ### USERLAND ### */
 269
 270 /* {{{ proto static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)
 271  */
 272 PHP_METHOD(HttpResponse, setHeader)
 273 {
 274         zend_bool replace = 1;
 275         char *name;
 276         int name_len = 0;
 277         zval *value = NULL;
 278
 279         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sz/!|b", &name, &name_len, &value, &replace)) {
 280                 RETURN_FALSE;
 281         }
 282         if (SG(headers_sent)) {
 283                 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot add another header when headers have already been sent");
 284                 RETURN_FALSE;
 285         }
 286         if (!name_len) {
 287                 http_error(HE_WARNING, HTTP_E_HEADER, "Cannot send anonymous headers");
 288                 RETURN_FALSE;
 289         }
 290
 291         /* delete header if value == null */
 292         if (!value || Z_TYPE_P(value) == IS_NULL) {
 293                 RETURN_SUCCESS(http_send_header_ex(name, name_len, "", 0, replace, NULL));
 294         }
 295         /* send multiple header if replace is false and value is an array */
 296         if (!replace && Z_TYPE_P(value) == IS_ARRAY) {
 297                 zval **data;
 298
 299                 FOREACH_VAL(value, data) {
 300                         convert_to_string_ex(data);
 301                         if (SUCCESS != http_send_header_ex(name, name_len, Z_STRVAL_PP(data), Z_STRLEN_PP(data), 0, NULL)) {
 302                                 RETURN_FALSE;
 303                         }
 304                 }
 305                 RETURN_TRUE;
 306         }
 307         /* send standard header */
 308         if (Z_TYPE_P(value) != IS_STRING) {
 309                 convert_to_string_ex(&value);
 310         }
 311         RETURN_SUCCESS(http_send_header_ex(name, name_len, Z_STRVAL_P(value), Z_STRLEN_P(value), replace, NULL));
 312 }
 313 /* }}} */
 314
 315 /* {{{ proto static mixed HttpResponse::getHeader([string name])
 316  */
 317 PHP_METHOD(HttpResponse, getHeader)
 318 {
 319         char *name = NULL;
 320         int name_len = 0;
 321         phpstr headers;
 322
 323         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &name, &name_len)) {
 324                 RETURN_FALSE;
 325         }
 326
 327         phpstr_init(&headers);
 328         zend_llist_apply_with_argument(&SG(sapi_headers).headers, http_grab_response_headers, &headers TSRMLS_CC);
 329         phpstr_fix(&headers);
 330
 331         if (name && name_len) {
 332                 zval **header;
 333                 HashTable headers_ht;
 334
 335                 zend_hash_init(&headers_ht, sizeof(zval *), NULL, ZVAL_PTR_DTOR, 0);
 336                 if (    (SUCCESS == http_parse_headers_ex(PHPSTR_VAL(&headers), &headers_ht, 1)) &&
 337                                 (SUCCESS == zend_hash_find(&headers_ht, name, name_len + 1, (void **) &header))) {
 338                         RETVAL_ZVAL(*header, 1, 0);
 339                 } else {
 340                         RETVAL_NULL();
 341                 }
 342                 zend_hash_destroy(&headers_ht);
 343         } else {
 344                 array_init(return_value);
 345                 http_parse_headers_ex(PHPSTR_VAL(&headers), Z_ARRVAL_P(return_value), 1);
 346         }
 347
 348         phpstr_dtor(&headers);
 349 }
 350 /* }}} */
 351
 352 /* {{{ proto static bool HttpResponse::setCache(bool cache)
 353  *
 354  * Whether it sould be attempted to cache the entitity.
 355  * This will result in necessary caching headers and checks of clients
 356  * "If-Modified-Since" and "If-None-Match" headers.  If one of those headers
 357  * matches a "304 Not Modified" status code will be issued.
 358  *
 359  * NOTE: If you're using sessions, be shure that you set session.cache_limiter
 360  * to something more appropriate than "no-cache"!
 361  */
 362 PHP_METHOD(HttpResponse, setCache)
 363 {
 364         zend_bool do_cache = 0;
 365
 366         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) {
 367                 RETURN_FALSE;
 368         }
 369
 370         RETURN_SUCCESS(UPD_STATIC_PROP(bool, cache, do_cache));
 371 }
 372 /* }}} */
 373
 374 /* {{{ proto static bool HttpResponse::getCache()
 375  *
 376  * Get current caching setting.
 377  */
 378 PHP_METHOD(HttpResponse, getCache)
 379 {
 380         NO_ARGS;
 381
 382         IF_RETVAL_USED {
 383                 zval *cache = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(cache));
 384
 385                 RETURN_ZVAL(cache, 1, 0);
 386         }
 387 }
 388 /* }}}*/
 389
 390 /* {{{ proto static bool HttpResponse::setGzip(bool gzip)
 391  *
 392  * Enable on-thy-fly gzipping of the sent entity.
 393  */
 394 PHP_METHOD(HttpResponse, setGzip)
 395 {
 396         zend_bool do_gzip = 0;
 397
 398         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) {
 399                 RETURN_FALSE;
 400         }
 401
 402         RETURN_SUCCESS(UPD_STATIC_PROP(bool, gzip, do_gzip));
 403 }
 404 /* }}} */
 405
 406 /* {{{ proto static bool HttpResponse::getGzip()
 407  *
 408  * Get current gzipping setting.
 409  */
 410 PHP_METHOD(HttpResponse, getGzip)
 411 {
 412         NO_ARGS;
 413
 414         IF_RETVAL_USED {
 415                 zval *gzip = convert_to_type_ex(IS_BOOL, GET_STATIC_PROP(gzip));
 416
 417                 RETURN_ZVAL(gzip, 1, 0);
 418         }
 419 }
 420 /* }}} */
 421
 422 /* {{{ proto static bool HttpResponse::setCacheControl(string control[, long max_age = 0])
 423  *
 424  * Set a custom cache-control header, usually being "private" or "public";
 425  * The max_age parameter controls how long the cache entry is valid on the client side.
 426  */
 427 PHP_METHOD(HttpResponse, setCacheControl)
 428 {
 429         char *ccontrol, *cctl;
 430         int cc_len;
 431         long max_age = 0;
 432
 433         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &ccontrol, &cc_len, &max_age)) {
 434                 RETURN_FALSE;
 435         }
 436
 437         if (strcmp(ccontrol, "public") && strcmp(ccontrol, "private") && strcmp(ccontrol, "no-cache")) {
 438                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol);
 439                 RETURN_FALSE;
 440         } else {
 441                 size_t cctl_len = spprintf(&cctl, 0, "%s, must-revalidate, max_age=%ld", ccontrol, max_age);
 442                 RETVAL_SUCCESS(UPD_STATIC_STRL(cacheControl, cctl, cctl_len));
 443                 efree(cctl);
 444         }
 445 }
 446 /* }}} */
 447
 448 /* {{{ proto static string HttpResponse::getCacheControl()
 449  *
 450  * Get current Cache-Control header setting.
 451  */
 452 PHP_METHOD(HttpResponse, getCacheControl)
 453 {
 454         NO_ARGS;
 455
 456         IF_RETVAL_USED {
 457                 zval *ccontrol = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl));
 458
 459                 RETURN_ZVAL(ccontrol, 1, 0);
 460         }
 461 }
 462 /* }}} */
 463
 464 /* {{{ proto static bool HttpResponse::setContentType(string content_type)
 465  *
 466  * Set the content-type of the sent entity.
 467  */
 468 PHP_METHOD(HttpResponse, setContentType)
 469 {
 470         char *ctype;
 471         int ctype_len;
 472
 473         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) {
 474                 RETURN_FALSE;
 475         }
 476
 477         if (!strchr(ctype, '/')) {
 478                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype);
 479                 RETURN_FALSE;
 480         }
 481
 482         RETURN_SUCCESS(UPD_STATIC_STRL(contentType, ctype, ctype_len));
 483 }
 484 /* }}} */
 485
 486 /* {{{ proto static string HttpResponse::getContentType()
 487  *
 488  * Get current Content-Type header setting.
 489  */
 490 PHP_METHOD(HttpResponse, getContentType)
 491 {
 492         NO_ARGS;
 493
 494         IF_RETVAL_USED {
 495                 zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType));
 496
 497                 RETURN_ZVAL(ctype, 1, 0);
 498         }
 499 }
 500 /* }}} */
 501
 502 /* {{{ proto static string HttpResponse::guessContentType(string magic_file[, long magic_mode])
 503  *
 504  * Attempts to guess the content type of supplied payload through libmagic.
 505  */
 506 PHP_METHOD(HttpResponse, guessContentType)
 507 {
 508         char *magic_file, *ct = NULL;
 509         int magic_file_len;
 510         long magic_mode = 0;
 511
 512         RETVAL_NULL();
 513
 514         SET_EH_THROW_HTTP();
 515         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &magic_file, &magic_file_len, &magic_mode)) {
 516                 switch (Z_LVAL_P(GET_STATIC_PROP(mode))) {
 517                         case SEND_DATA:
 518                         {
 519                                 zval *data = GET_STATIC_PROP(data);
 520                                 ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(data), Z_STRLEN_P(data), SEND_DATA);
 521                         }
 522                         break;
 523
 524                         case SEND_RSRC:
 525                         {
 526                                 php_stream *s;
 527                                 zval *z = GET_STATIC_PROP(stream);
 528                                 z->type = IS_RESOURCE;
 529                                 php_stream_from_zval(s, &z);
 530                                 ct = http_guess_content_type(magic_file, magic_mode, s, 0, SEND_RSRC);
 531                         }
 532                         break;
 533
 534                         default:
 535                                 ct = http_guess_content_type(magic_file, magic_mode, Z_STRVAL_P(GET_STATIC_PROP(file)), 0, -1);
 536                         break;
 537                 }
 538                 if (ct) {
 539                         UPD_STATIC_PROP(string, contentType, ct);
 540                         RETVAL_STRING(ct, 0);
 541                 }
 542         }
 543         SET_EH_NORMAL();
 544 }
 545 /* }}} */
 546
 547 /* {{{ proto static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
 548  *
 549  * Set the Content-Disposition of the sent entity.  This setting aims to suggest
 550  * the receiveing user agent how to handle the sent entity;  usually the client
 551  * will show the user a "Save As..." popup.
 552  */
 553 PHP_METHOD(HttpResponse, setContentDisposition)
 554 {
 555         char *file, *cd;
 556         int file_len;
 557         size_t cd_len;
 558         zend_bool send_inline = 0;
 559
 560         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &send_inline)) {
 561                 RETURN_FALSE;
 562         }
 563
 564         cd_len = spprintf(&cd, 0, "%s; filename=\"%s\"", send_inline ? "inline" : "attachment", file);
 565         RETVAL_SUCCESS(UPD_STATIC_STRL(contentDisposition, cd, cd_len));
 566         efree(cd);
 567 }
 568 /* }}} */
 569
 570 /* {{{ proto static string HttpResponse::getContentDisposition()
 571  *
 572  * Get current Content-Disposition setting.
 573  */
 574 PHP_METHOD(HttpResponse, getContentDisposition)
 575 {
 576         NO_ARGS;
 577
 578         IF_RETVAL_USED {
 579                 zval *cd = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentDisposition));
 580
 581                 RETURN_ZVAL(cd, 1, 0);
 582         }
 583 }
 584 /* }}} */
 585
 586 /* {{{ proto static bool HttpResponse::setETag(string etag)
 587  *
 588  * Set a custom ETag.  Use this only if you know what you're doing.
 589  */
 590 PHP_METHOD(HttpResponse, setETag)
 591 {
 592         char *etag;
 593         int etag_len;
 594
 595         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) {
 596                 RETURN_FALSE;
 597         }
 598
 599         RETURN_SUCCESS(UPD_STATIC_STRL(eTag, etag, etag_len));
 600 }
 601 /* }}} */
 602
 603 /* {{{ proto static string HttpResponse::getETag()
 604  *
 605  * Get calculated or previously set custom ETag.
 606  */
 607 PHP_METHOD(HttpResponse, getETag)
 608 {
 609         NO_ARGS;
 610
 611         IF_RETVAL_USED {
 612                 zval *etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag));
 613
 614                 RETURN_ZVAL(etag, 1, 0);
 615         }
 616 }
 617 /* }}} */
 618
 619 /* {{{ proto static bool HttpResponse::setLastModified(long timestamp)
 620  *
 621  * Set a custom Last-Modified date.
 622  */
 623 PHP_METHOD(HttpResponse, setLastModified)
 624 {
 625         long lm;
 626
 627         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &lm)) {
 628                 RETURN_FALSE;
 629         }
 630
 631         RETURN_SUCCESS(UPD_STATIC_PROP(long, lastModified, lm));
 632 }
 633 /* }}} */
 634
 635 /* {{{ proto static HttpResponse::getLastModified()
 636  *
 637  * Get calculated or previously set custom Last-Modified date.
 638  */
 639 PHP_METHOD(HttpResponse, getLastModified)
 640 {
 641         NO_ARGS;
 642
 643         IF_RETVAL_USED {
 644                 zval *lm = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified));
 645
 646                 RETURN_ZVAL(lm, 1, 0);
 647         }
 648 }
 649 /* }}} */
 650
 651 /* {{{ proto static bool HttpResponse::setThrottleDelay(double seconds)
 652  *
 653  */
 654 PHP_METHOD(HttpResponse, setThrottleDelay)
 655 {
 656         double seconds;
 657
 658         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d", &seconds)) {
 659                 RETURN_FALSE;
 660         }
 661         RETURN_SUCCESS(UPD_STATIC_PROP(double, throttleDelay, seconds));
 662 }
 663 /* }}} */
 664
 665 /* {{{ proto static double HttpResponse::getThrottleDelay()
 666  *
 667  */
 668 PHP_METHOD(HttpResponse, getThrottleDelay)
 669 {
 670         NO_ARGS;
 671
 672         IF_RETVAL_USED {
 673                 zval *delay = convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay));
 674
 675                 RETURN_ZVAL(delay, 1, 0);
 676         }
 677 }
 678 /* }}} */
 679
 680 /* {{{ proto static bool HttpResponse::setBufferSize(long bytes)
 681  *
 682  */
 683 PHP_METHOD(HttpResponse, setBufferSize)
 684 {
 685         long bytes;
 686
 687         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &bytes)) {
 688                 RETURN_FALSE;
 689         }
 690         RETURN_SUCCESS(UPD_STATIC_PROP(long, bufferSize, bytes));
 691 }
 692 /* }}} */
 693
 694 /* {{{ proto static long HttpResponse::getBufferSize()
 695  *
 696  */
 697 PHP_METHOD(HttpResponse, getBufferSize)
 698 {
 699         NO_ARGS;
 700
 701         IF_RETVAL_USED {
 702                 zval *size = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize));
 703
 704                 RETURN_ZVAL(size, 1, 0);
 705         }
 706 }
 707 /* }}} */
 708
 709 /* {{{ proto static bool HttpResponse::setData(string data)
 710  *
 711  * Set the data to be sent.
 712  */
 713 PHP_METHOD(HttpResponse, setData)
 714 {
 715         zval *the_data;
 716
 717         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) {
 718                 RETURN_FALSE;
 719         }
 720         if (Z_TYPE_P(the_data) != IS_STRING) {
 721                 convert_to_string_ex(&the_data);
 722         }
 723
 724         if (    (SUCCESS != SET_STATIC_PROP(data, the_data)) ||
 725                         (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_DATA))) {
 726                 RETURN_FALSE;
 727         }
 728
 729         if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) {
 730                 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_data, SEND_DATA));
 731         }
 732         if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
 733                 char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA);
 734                 if (etag) {
 735                         UPD_STATIC_PROP(string, eTag, etag);
 736                         efree(etag);
 737                 }
 738         }
 739
 740         RETURN_TRUE;
 741 }
 742 /* }}} */
 743
 744 /* {{{ proto static string HttpResponse::getData()
 745  *
 746  * Get the previously set data to be sent.
 747  */
 748 PHP_METHOD(HttpResponse, getData)
 749 {
 750         NO_ARGS;
 751
 752         IF_RETVAL_USED {
 753                 zval *the_data = GET_STATIC_PROP(data);
 754
 755                 RETURN_ZVAL(the_data, 1, 0);
 756         }
 757 }
 758 /* }}} */
 759
 760 /* {{{ proto static bool HttpResponse::setStream(resource stream)
 761  *
 762  * Set the resource to be sent.
 763  */
 764 PHP_METHOD(HttpResponse, setStream)
 765 {
 766         zval *the_stream;
 767         php_stream *the_real_stream;
 768         php_stream_statbuf ssb;
 769
 770         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) {
 771                 RETURN_FALSE;
 772         }
 773
 774         php_stream_from_zval(the_real_stream, &the_stream);
 775         if (php_stream_stat(the_real_stream, &ssb)) {
 776                 RETURN_FALSE;
 777         }
 778
 779         if (    (SUCCESS != UPD_STATIC_PROP(long, stream, Z_LVAL_P(the_stream))) ||
 780                         (SUCCESS != UPD_STATIC_PROP(long, mode, SEND_RSRC))) {
 781                 RETURN_FALSE;
 782         }
 783         zend_list_addref(Z_LVAL_P(the_stream));
 784
 785         if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) {
 786                 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_real_stream, SEND_RSRC));
 787         }
 788         if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
 789                 char *etag = http_etag(the_real_stream, 0, SEND_RSRC);
 790                 if (etag) {
 791                         UPD_STATIC_PROP(string, eTag, etag);
 792                         efree(etag);
 793                 }
 794         }
 795
 796         RETURN_TRUE;
 797 }
 798 /* }}} */
 799
 800 /* {{{ proto static resource HttpResponse::getStream()
 801  *
 802  * Get the previously set resource to be sent.
 803  */
 804 PHP_METHOD(HttpResponse, getStream)
 805 {
 806         NO_ARGS;
 807
 808         IF_RETVAL_USED {
 809                 RETURN_RESOURCE(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream))));
 810         }
 811 }
 812 /* }}} */
 813
 814 /* {{{ proto static bool HttpResponse::setFile(string file)
 815  *
 816  * Set the file to be sent.
 817  */
 818 PHP_METHOD(HttpResponse, setFile)
 819 {
 820         char *the_file;
 821         int file_len;
 822         php_stream_statbuf ssb;
 823
 824         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &the_file, &file_len)) {
 825                 RETURN_FALSE;
 826         }
 827
 828         if (php_stream_stat_path(the_file, &ssb)) {
 829                 RETURN_FALSE;
 830         }
 831
 832         if (    (SUCCESS != UPD_STATIC_STRL(file, the_file, file_len)) ||
 833                         (SUCCESS != UPD_STATIC_PROP(long, mode, -1))) {
 834                 RETURN_FALSE;
 835         }
 836
 837         if (!(Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified))) > 0)) {
 838                 UPD_STATIC_PROP(long, lastModified, http_last_modified(the_file, -1));
 839         }
 840         if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
 841                 char *etag = http_etag(the_file, 0, -1);
 842                 if (etag) {
 843                         UPD_STATIC_PROP(string, eTag, etag);
 844                         efree(etag);
 845                 }
 846         }
 847
 848         RETURN_TRUE;
 849 }
 850 /* }}} */
 851
 852 /* {{{ proto static string HttpResponse::getFile()
 853  *
 854  * Get the previously set file to be sent.
 855  */
 856 PHP_METHOD(HttpResponse, getFile)
 857 {
 858         NO_ARGS;
 859
 860         IF_RETVAL_USED {
 861                 zval *the_file = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file));
 862
 863                 RETURN_ZVAL(the_file, 1, 0);
 864         }
 865 }
 866 /* }}} */
 867
 868 /* {{{ proto static bool HttpResponse::send([bool clean_ob = true])
 869  *
 870  * Finally send the entity.
 871  *
 872  * Example:
 873  * <pre>
 874  * <?php
 875  * HttpResponse::setCache(true);
 876  * HttpResponse::setContentType('application/pdf');
 877  * HttpResponse::setContentDisposition("$user.pdf", false);
 878  * HttpResponse::setFile('sheet.pdf');
 879  * HttpResponse::send();
 880  * ?>
 881  * </pre>
 882  */
 883 PHP_METHOD(HttpResponse, send)
 884 {
 885         zval *sent;
 886         zend_bool clean_ob = 1;
 887
 888         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &clean_ob)) {
 889                 RETURN_FALSE;
 890         }
 891         if (SG(headers_sent)) {
 892                 http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, headers have already been sent");
 893                 RETURN_FALSE;
 894         }
 895
 896         sent = GET_STATIC_PROP(sent);
 897         if (zval_is_true(sent)) {
 898                 http_error(HE_WARNING, HTTP_E_RESPONSE, "Cannot send HttpResponse, response has already been sent");
 899                 RETURN_FALSE;
 900         } else {
 901                 Z_LVAL_P(sent) = 1;
 902         }
 903
 904         /* capture mode */
 905         if (zval_is_true(GET_STATIC_PROP(catch))) {
 906                 zval *the_data;
 907
 908                 MAKE_STD_ZVAL(the_data);
 909                 php_ob_get_buffer(the_data TSRMLS_CC);
 910                 SET_STATIC_PROP(data, the_data);
 911                 ZVAL_LONG(GET_STATIC_PROP(mode), SEND_DATA);
 912
 913                 if (!Z_STRLEN_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag)))) {
 914                         char *etag = http_etag(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), SEND_DATA);
 915                         if (etag) {
 916                                 UPD_STATIC_PROP(string, eTag, etag);
 917                                 efree(etag);
 918                         }
 919                 }
 920                 zval_ptr_dtor(&the_data);
 921
 922                 clean_ob = 1;
 923         }
 924
 925         if (clean_ob) {
 926                 /* interrupt on-the-fly etag generation */
 927                 HTTP_G(etag).started = 0;
 928                 /* discard previous output buffers */
 929                 php_end_ob_buffers(0 TSRMLS_CC);
 930         }
 931
 932         /* gzip */
 933         if (zval_is_true(GET_STATIC_PROP(gzip))) {
 934                 php_start_ob_buffer_named("ob_gzhandler", 0, 0 TSRMLS_CC);
 935         } else {
 936                 php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
 937         }
 938
 939         /* caching */
 940         if (zval_is_true(GET_STATIC_PROP(cache))) {
 941                 zval *cctl, *etag, *lmod;
 942
 943                 etag = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(eTag));
 944                 lmod = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(lastModified));
 945                 cctl = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(cacheControl));
 946
 947                 http_cache_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag), Z_STRVAL_P(cctl), Z_STRLEN_P(cctl));
 948                 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));
 949         }
 950
 951         /* content type */
 952         {
 953                 zval *ctype = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(contentType));
 954                 if (Z_STRLEN_P(ctype)) {
 955                         http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype));
 956                 } else {
 957                         char *ctypes = INI_STR("default_mimetype");
 958                         size_t ctlen = ctypes ? strlen(ctypes) : 0;
 959
 960                         if (ctlen) {
 961                                 http_send_content_type(ctypes, ctlen);
 962                         } else {
 963                                 http_send_content_type("application/x-octetstream", lenof("application/x-octetstream"));
 964                         }
 965                 }
 966         }
 967
 968         /* content disposition */
 969         {
 970                 zval *cd = GET_STATIC_PROP(contentDisposition);
 971                 if (Z_STRLEN_P(cd)) {
 972                         http_send_header_ex("Content-Disposition", lenof("Content-Disposition"), Z_STRVAL_P(cd), Z_STRLEN_P(cd), 1, NULL);
 973                 }
 974         }
 975
 976         /* throttling */
 977         {
 978                 HTTP_G(send).buffer_size    = Z_LVAL_P(convert_to_type_ex(IS_LONG, GET_STATIC_PROP(bufferSize)));
 979                 HTTP_G(send).throttle_delay = Z_DVAL_P(convert_to_type_ex(IS_DOUBLE, GET_STATIC_PROP(throttleDelay)));
 980         }
 981
 982         /* send */
 983         {
 984                 switch (Z_LVAL_P(GET_STATIC_PROP(mode)))
 985                 {
 986                         case SEND_DATA:
 987                         {
 988                                 zval *zdata = convert_to_type_ex(IS_STRING, GET_STATIC_PROP(data));
 989                                 RETURN_SUCCESS(http_send_data_ex(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata), 1));
 990                         }
 991
 992                         case SEND_RSRC:
 993                         {
 994                                 php_stream *the_real_stream;
 995                                 zval *the_stream = convert_to_type_ex(IS_LONG, GET_STATIC_PROP(stream));
 996                                 the_stream->type = IS_RESOURCE;
 997                                 php_stream_from_zval(the_real_stream, &the_stream);
 998                                 RETURN_SUCCESS(http_send_stream_ex(the_real_stream, 0, 1));
 999                         }
1000
1001                         default:
1002                         {
1003                                 RETURN_SUCCESS(http_send_file_ex(Z_STRVAL_P(convert_to_type_ex(IS_STRING, GET_STATIC_PROP(file))), 1));
1004                         }
1005                 }
1006         }
1007 }
1008 /* }}} */
1009
1010 /* {{{ proto static void HttpResponse::capture()
1011  *
1012  * Capture script output.
1013  *
1014  * Example:
1015  * <pre>
1016  * <?php
1017  * HttpResponse::setCache(true);
1018  * HttpResponse::capture();
1019  * // script follows
1020  * ?>
1021  * </pre>
1022  */
1023 PHP_METHOD(HttpResponse, capture)
1024 {
1025         NO_ARGS;
1026
1027         UPD_STATIC_PROP(long, catch, 1);
1028
1029         php_end_ob_buffers(0 TSRMLS_CC);
1030         php_start_ob_buffer(NULL, 0, 0 TSRMLS_CC);
1031
1032         /* register shutdown function */
1033         {
1034                 zval func, retval, arg, *argp[1];
1035
1036                 INIT_PZVAL(&arg);
1037                 INIT_PZVAL(&func);
1038                 INIT_PZVAL(&retval);
1039                 ZVAL_STRINGL(&func, "register_shutdown_function", lenof("register_shutdown_function"), 0);
1040
1041                 array_init(&arg);
1042                 add_next_index_stringl(&arg, "HttpResponse", lenof("HttpResponse"), 1);
1043                 add_next_index_stringl(&arg, "send", lenof("send"), 1);
1044                 argp[0] = &arg;
1045                 call_user_function(EG(function_table), NULL, &func, &retval, 1, argp TSRMLS_CC);
1046                 zval_dtor(&arg);
1047         }
1048 }
1049 /* }}} */
1050
1051 #endif /* ZEND_ENGINE_2 && !WONKY */
1052
1053 /*
1054  * Local variables:
1055  * tab-width: 4
1056  * c-basic-offset: 4
1057  * End:
1058  * vim600: noet sw=4 ts=4 fdm=marker
1059  * vim<600: noet sw=4 ts=4
1060  */
1061