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