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