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