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