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

   1 /*
   2     +--------------------------------------------------------------------+
   3     | PECL :: http                                                       |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted provided that the conditions mentioned |
   7     | in the accompanying LICENSE file are met.                          |
   8     +--------------------------------------------------------------------+
   9     | Copyright (c) 2004-2005, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #       include "config.h"
  17 #endif
  18
  19 #define HTTP_WANT_MAGIC
  20 #include "php_http.h"
  21
  22 #include "SAPI.h"
  23 #include "php_streams.h"
  24 #include "ext/standard/php_lcg.h"
  25
  26 #include "php_http_api.h"
  27 #include "php_http_cache_api.h"
  28 #include "php_http_date_api.h"
  29 #include "php_http_encoding_api.h"
  30 #include "php_http_headers_api.h"
  31 #include "php_http_send_api.h"
  32
  33 ZEND_EXTERN_MODULE_GLOBALS(http);
  34
  35 #define http_flush(d, l) _http_flush((d), (l) SRMLS_CC)
  36 /* {{{ static inline void http_flush() */
  37 static inline void _http_flush(const char *data, size_t data_len TSRMLS_DC)
  38 {
  39         PHPWRITE(data, data_len);
  40         php_end_ob_buffer(1, 1 TSRMLS_CC);
  41         sapi_flush(TSRMLS_C);
  42
  43 #define HTTP_MSEC(s) (s * 1000)
  44 #define HTTP_USEC(s) (HTTP_MSEC(s) * 1000)
  45 #define HTTP_NSEC(s) (HTTP_USEC(s) * 1000)
  46 #define HTTP_NANOSEC (1000 * 1000 * 1000)
  47 #define HTTP_DIFFSEC (0.001)
  48
  49         if (HTTP_G(send).throttle_delay >= HTTP_DIFFSEC) {
  50 #if defined(PHP_WIN32)
  51                 Sleep((DWORD) HTTP_MSEC(HTTP_G(send).throttle_delay));
  52 #elif defined(HAVE_USLEEP)
  53                 usleep(HTTP_USEC(HTTP_G(send).throttle_delay));
  54 #elif defined(HAVE_NANOSLEEP)
  55                 struct timespec req, rem;
  56
  57                 req.tv_sec = (time_t) HTTP_G(send).throttle_delay;
  58                 req.tv_nsec = HTTP_NSEC(HTTP_G(send).throttle_delay) % HTTP_NANOSEC;
  59
  60                 while (nanosleep(&req, &rem) && (errno == EINTR) && (HTTP_NSEC(rem.tv_sec) + rem.tv_nsec) > HTTP_NSEC(HTTP_DIFFSEC))) {
  61                         req.tv_sec = rem.tv_sec;
  62                         req.tv_nsec = rem.tv_nsec;
  63                 }
  64 #endif
  65         }
  66 }
  67 /* }}} */
  68
  69 /* {{{ http_send_response_start */
  70 #define http_send_response_start(b, cl) _http_send_response_start((b), (cl) TSRMLS_CC)
  71 static inline void _http_send_response_start(void **buffer, size_t content_length TSRMLS_DC)
  72 {
  73         if (http_encoding_response_start(content_length)) {
  74 #ifdef HTTP_HAVE_ZLIB
  75                 char *encoded;
  76                 size_t encoded_len;
  77                 http_encoding_stream *s = emalloc(sizeof(http_encoding_stream));
  78
  79                 http_encoding_stream_init(s, HTTP_G(send).gzip_encoding == HTTP_ENCODING_GZIP, -1, &encoded, &encoded_len);
  80                 phpstr_chunked_output(&s->storage, encoded, encoded_len, HTTP_G(send).buffer_size, _http_flush TSRMLS_CC);
  81                 STR_FREE(encoded);
  82                 *buffer = s;
  83 #endif
  84         }
  85 }
  86 /* }}} */
  87
  88 /* {{{ http_send_response_data_plain */
  89 #define http_send_response_data_plain(b, d, dl) _http_send_response_data_plain((b), (d), (dl) TSRMLS_CC)
  90 static inline void _http_send_response_data_plain(void **buffer, const char *data, size_t data_len TSRMLS_DC)
  91 {
  92         if (HTTP_G(send).gzip_encoding) {
  93 #ifdef HTTP_HAVE_ZLIB
  94                 char *encoded;
  95                 size_t encoded_len;
  96                 http_encoding_stream *s = *((http_encoding_stream **) buffer);
  97
  98                 http_encoding_stream_update(s, data, data_len, &encoded, &encoded_len);
  99                 phpstr_chunked_output(&s->storage, encoded, encoded_len, HTTP_G(send).buffer_size, _http_flush TSRMLS_CC);
 100                 efree(encoded);
 101 #else
 102                 http_error(HE_ERROR, HTTP_E_RESPONSE, "Attempt to send GZIP response despite being able to do so; please report this bug");
 103 #endif
 104         } else {
 105                 phpstr_chunked_output((phpstr **) buffer, data, data_len, HTTP_G(send).buffer_size, _http_flush TSRMLS_CC);
 106         }
 107 }
 108 /* }}} */
 109
 110 #define HTTP_CHUNK_AVAIL(len, cs) ((len -= cs) >= 0)
 111 /* {{{ http_send_response_data_fetch */
 112 #define http_send_response_data_fetch(b, d, l, m, s, e) _http_send_response_data_fetch((b), (d), (l), (m), (s), (e) TSRMLS_CC)
 113 static inline void _http_send_response_data_fetch(void **buffer, const void *data, size_t data_len, http_send_mode mode, size_t begin, size_t end TSRMLS_DC)
 114 {
 115         long len = end - begin, chunk_size = 40960;
 116
 117         switch (mode)
 118         {
 119                 case SEND_RSRC:
 120                 {
 121                         php_stream *s = (php_stream *) data;
 122
 123                         if (SUCCESS == php_stream_seek(s, begin, SEEK_SET)) {
 124                                 char *buf = emalloc(chunk_size);
 125
 126                                 while (HTTP_CHUNK_AVAIL(len, chunk_size)) {
 127                                         http_send_response_data_plain(buffer, buf, php_stream_read(s, buf, chunk_size));
 128                                 }
 129                                 /* read & write left over */
 130                                 if (len) {
 131                                         http_send_response_data_plain(buffer, buf, php_stream_read(s, buf, chunk_size + len));
 132                                 }
 133
 134                                 efree(buf);
 135                         }
 136                 }
 137                 break;
 138
 139                 case SEND_DATA:
 140                 {
 141                         char *s = (char *) data + begin;
 142
 143                         while (HTTP_CHUNK_AVAIL(len, chunk_size)) {
 144                                 http_send_response_data_plain(buffer, s, chunk_size);
 145                                 s += chunk_size;
 146                         }
 147                         /* write left over */
 148                         if (len) {
 149                                 http_send_response_data_plain(buffer, s, chunk_size + len);
 150                         }
 151                 }
 152                 break;
 153
 154                 EMPTY_SWITCH_DEFAULT_CASE();
 155         }
 156 }
 157 /* }}} */
 158
 159 /* {{{ http_send_response_finish */
 160 #define http_send_response_finish(b) _http_send_response_finish((b) TSRMLS_CC)
 161 static inline void _http_send_response_finish(void **buffer TSRMLS_DC)
 162 {
 163         if (HTTP_G(send).gzip_encoding) {
 164 #ifdef HTTP_HAVE_ZLIB
 165                 char *encoded = NULL;
 166                 size_t encoded_len = 0;
 167                 http_encoding_stream *s = *((http_encoding_stream **) buffer);
 168
 169                 http_encoding_stream_finish(s, &encoded, &encoded_len);
 170                 phpstr_chunked_output(&s->storage, encoded, encoded_len, 0, _http_flush TSRMLS_CC);
 171                 STR_FREE(encoded);
 172                 efree(s);
 173 #else
 174                 http_error(HE_ERROR, HTTP_E_RESPONSE, "Attempt to send GZIP response despite being able to do so; please report this bug");
 175 #endif
 176         } else {
 177                 phpstr_chunked_output((phpstr **) buffer, NULL, 0, 0, _http_flush TSRMLS_CC);
 178         }
 179 }
 180 /* }}} */
 181
 182
 183 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
 184 PHP_HTTP_API STATUS _http_send_header_ex(const char *name, size_t name_len, const char *value, size_t value_len, zend_bool replace, char **sent_header TSRMLS_DC)
 185 {
 186         STATUS ret;
 187         size_t header_len = sizeof(": ") + name_len + value_len + 1;
 188         char *header = emalloc(header_len + 1);
 189
 190         header[header_len] = '\0';
 191         header_len = snprintf(header, header_len, "%s: %s", name, value);
 192         ret = http_send_header_string_ex(header, header_len, replace);
 193         if (sent_header) {
 194                 *sent_header = header;
 195         } else {
 196                 efree(header);
 197         }
 198         return ret;
 199 }
 200 /* }}} */
 201
 202 /* {{{ STATUS http_send_status_header(int, char *) */
 203 PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, size_t header_len, zend_bool replace TSRMLS_DC)
 204 {
 205         STATUS ret;
 206         sapi_header_line h = {(char *) header, header_len, status};
 207         if (SUCCESS != (ret = sapi_header_op(replace ? SAPI_HEADER_REPLACE : SAPI_HEADER_ADD, &h TSRMLS_CC))) {
 208                 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Could not send header: %s (%d)", header, status);
 209         }
 210         return ret;
 211 }
 212 /* }}} */
 213
 214 /* {{{ STATUS http_send_last_modified(int) */
 215 PHP_HTTP_API STATUS _http_send_last_modified_ex(time_t t, char **sent_header TSRMLS_DC)
 216 {
 217         STATUS ret;
 218         char *date = http_date(t);
 219
 220         if (!date) {
 221                 return FAILURE;
 222         }
 223
 224         ret = http_send_header_ex("Last-Modified", lenof("Last-Modified"), date, strlen(date), 1, sent_header);
 225         efree(date);
 226
 227         /* remember */
 228         HTTP_G(send).last_modified = t;
 229
 230         return ret;
 231 }
 232 /* }}} */
 233
 234 /* {{{ STATUS http_send_etag(char *, size_t) */
 235 PHP_HTTP_API STATUS _http_send_etag_ex(const char *etag, size_t etag_len, char **sent_header TSRMLS_DC)
 236 {
 237         STATUS status;
 238         char *etag_header;
 239
 240         if (!etag_len){
 241                 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Attempt to send empty ETag (previous: %s)\n", HTTP_G(send).unquoted_etag);
 242                 return FAILURE;
 243         }
 244
 245         /* remember */
 246         STR_SET(HTTP_G(send).unquoted_etag, estrndup(etag, etag_len));
 247
 248         etag_len = spprintf(&etag_header, 0, "ETag: \"%s\"", etag);
 249         status = http_send_header_string_ex(etag_header, etag_len, 1);
 250
 251         if (sent_header) {
 252                 *sent_header = etag_header;
 253         } else {
 254                 efree(etag_header);
 255         }
 256
 257         return status;
 258 }
 259 /* }}} */
 260
 261 /* {{{ STATUS http_send_content_type(char *, size_t) */
 262 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, size_t ct_len TSRMLS_DC)
 263 {
 264         HTTP_CHECK_CONTENT_TYPE(content_type, return FAILURE);
 265
 266         /* remember for multiple ranges */
 267         STR_FREE(HTTP_G(send).content_type);
 268         HTTP_G(send).content_type = estrndup(content_type, ct_len);
 269
 270         return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type, ct_len, 1, NULL);
 271 }
 272 /* }}} */
 273
 274 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
 275 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, size_t f_len, zend_bool send_inline TSRMLS_DC)
 276 {
 277         STATUS status;
 278         char *cd_header;
 279
 280         if (send_inline) {
 281                 cd_header = ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len);
 282                 sprintf(cd_header, "Content-Disposition: inline; filename=\"%s\"", filename);
 283         } else {
 284                 cd_header = ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len);
 285                 sprintf(cd_header, "Content-Disposition: attachment; filename=\"%s\"", filename);
 286         }
 287
 288         status = http_send_header_string(cd_header);
 289         efree(cd_header);
 290         return status;
 291 }
 292 /* }}} */
 293
 294 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
 295 PHP_HTTP_API STATUS _http_send_ex(const void *data_ptr, size_t data_size, http_send_mode data_mode, zend_bool no_cache TSRMLS_DC)
 296 {
 297         void *s = NULL;
 298         HashTable ranges;
 299         http_range_status range_status;
 300         int cache_etag = http_interrupt_ob_etaghandler();
 301
 302         if (!data_ptr) {
 303                 return FAILURE;
 304         }
 305         if (!data_size) {
 306                 return SUCCESS;
 307         }
 308
 309         /* enable partial dl and resume */
 310         http_send_header_string("Accept-Ranges: bytes");
 311
 312         zend_hash_init(&ranges, 0, NULL, ZVAL_PTR_DTOR, 0);
 313         range_status = http_get_request_ranges(&ranges, data_size);
 314
 315         switch (range_status)
 316         {
 317                 case RANGE_ERR:
 318                 {
 319                         zend_hash_destroy(&ranges);
 320                         http_send_status(416);
 321                         return FAILURE;
 322                 }
 323                 case RANGE_OK:
 324                 {
 325                         /* Range Request - only send ranges if entity hasn't changed */
 326                         if (    http_match_etag_ex("HTTP_IF_MATCH", HTTP_G(send).unquoted_etag, 0) &&
 327                                         http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G(send).last_modified, 0) &&
 328                                         http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G(send).last_modified, 0)) {
 329
 330                                 if (zend_hash_num_elements(&ranges) == 1) {
 331                                         /* single range */
 332                                         zval **range, **begin, **end;
 333
 334                                         if (    SUCCESS == zend_hash_index_find(&ranges, 0, (void **) &range) &&
 335                                                         SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void **) &begin) &&
 336                                                         SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void **) &end)) {
 337                                                 char range_header_str[256];
 338                                                 size_t range_header_len;
 339
 340                                                 range_header_len = snprintf(range_header_str, lenof(range_header_str), "Content-Range: bytes %ld-%ld/%zu", Z_LVAL_PP(begin), Z_LVAL_PP(end), data_size);
 341                                                 http_send_status_header_ex(206, range_header_str, range_header_len, 1);
 342                                                 http_send_response_start(&s, Z_LVAL_PP(end)-Z_LVAL_PP(begin)+1);
 343                                                 http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, Z_LVAL_PP(begin), Z_LVAL_PP(end) + 1);
 344                                                 http_send_response_finish(&s);
 345                                                 zend_hash_destroy(&ranges);
 346                                                 return SUCCESS;
 347                                         }
 348                                 } else {
 349                                         /* multi range */
 350                                         HashPosition pos;
 351                                         zval **range, **begin, **end;
 352                                         const char *content_type = HTTP_G(send).content_type;
 353                                         char boundary_str[32], range_header_str[256];
 354                                         size_t boundary_len, range_header_len;
 355
 356                                         boundary_len = snprintf(boundary_str, lenof(boundary_str), "%lu%0.9f", (ulong) time(NULL), (float) php_combined_lcg(TSRMLS_C));
 357                                         range_header_len = snprintf(range_header_str, lenof(range_header_str), "Content-Type: multipart/byteranges; boundary=%s", boundary_str);
 358
 359                                         http_send_status_header_ex(206, range_header_str, range_header_len, 1);
 360                                         http_send_response_start(&s, 0);
 361
 362                                         if (!content_type) {
 363                                                 content_type = "application/x-octetstream";
 364                                         }
 365
 366                                         FOREACH_HASH_VAL(pos, &ranges, range) {
 367                                                 if (    SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void **) &begin) &&
 368                                                                 SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void **) &end)) {
 369                                                         char preface_str[512];
 370                                                         size_t preface_len;
 371
 372 #define HTTP_RANGE_PREFACE \
 373         HTTP_CRLF "--%s" \
 374         HTTP_CRLF "Content-Type: %s" \
 375         HTTP_CRLF "Content-Range: bytes %ld-%ld/%zu" \
 376         HTTP_CRLF HTTP_CRLF
 377
 378                                                         preface_len = snprintf(preface_str, lenof(preface_str), HTTP_RANGE_PREFACE, boundary_str, content_type, Z_LVAL_PP(begin), Z_LVAL_PP(end), data_size);
 379                                                         http_send_response_data_plain(&s, preface_str, preface_len);
 380                                                         http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, Z_LVAL_PP(begin), Z_LVAL_PP(end) + 1);
 381                                                 }
 382                                         }
 383
 384                                         http_send_response_data_plain(&s, HTTP_CRLF "--", lenof(HTTP_CRLF "--"));
 385                                         http_send_response_data_plain(&s, boundary_str, boundary_len);
 386                                         http_send_response_data_plain(&s, "--", lenof("--"));
 387
 388                                         http_send_response_finish(&s);
 389                                         zend_hash_destroy(&ranges);
 390                                         return SUCCESS;
 391                                 }
 392                         }
 393                 }
 394                 case RANGE_NO:
 395                 {
 396                         zend_hash_destroy(&ranges);
 397
 398                         /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
 399                         if (!no_cache && cache_etag) {
 400                                 char *etag = NULL;
 401
 402                                 if ((etag = http_etag(data_ptr, data_size, data_mode))) {
 403                                         char *sent_header = NULL;
 404
 405                                         http_send_etag_ex(etag, strlen(etag), &sent_header);
 406                                         if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
 407                                                 return http_exit_ex(304, sent_header, NULL, 0);
 408                                         } else {
 409                                                 STR_FREE(sent_header);
 410                                         }
 411                                         efree(etag);
 412                                 }
 413                         }
 414
 415                         /* send 304 Not Modified if last modified matches */
 416                         if (!no_cache && http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G(send).last_modified)) {
 417                                 char *sent_header = NULL;
 418                                 http_send_last_modified_ex(HTTP_G(send).last_modified, &sent_header);
 419                                 return http_exit_ex(304, sent_header, NULL, 0);
 420                         }
 421
 422                         /* send full response */
 423                         http_send_response_start(&s, data_size);
 424                         http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, 0, data_size);
 425                         http_send_response_finish(&s);
 426                         return SUCCESS;
 427                 }
 428         }
 429         return FAILURE;
 430 }
 431 /* }}} */
 432
 433 /* {{{ STATUS http_send_stream(php_stream *) */
 434 PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_stream, zend_bool no_cache TSRMLS_DC)
 435 {
 436         STATUS status;
 437         php_stream_statbuf ssb;
 438
 439         if ((!file) || php_stream_stat(file, &ssb)) {
 440                 return FAILURE;
 441         }
 442
 443         status = http_send_ex(file, ssb.sb.st_size, SEND_RSRC, no_cache);
 444
 445         if (close_stream) {
 446                 php_stream_close(file);
 447         }
 448
 449         return status;
 450 }
 451 /* }}} */
 452
 453 /* {{{ char *http_guess_content_type(char *magic_file, long magic_mode, void *data, size_t size, http_send_mode mode) */
 454 PHP_HTTP_API char *_http_guess_content_type(const char *magicfile, long magicmode, void *data_ptr, size_t data_len, http_send_mode data_mode TSRMLS_DC)
 455 {
 456         char *ct = NULL;
 457
 458 #ifdef HTTP_HAVE_MAGIC
 459         /*      magic_load() fails if MAGIC_MIME is set because it
 460                 cowardly adds .mime to the file name */
 461         struct magic_set *magic = magic_open(magicmode &~ MAGIC_MIME);
 462
 463         if (!magic) {
 464                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid magic mode: %ld", magicmode);
 465         } else if (-1 == magic_load(magic, magicfile)) {
 466                 http_error_ex(HE_WARNING, HTTP_E_RUNTIME, "Failed to load magic database '%s' (%s)", magicfile, magic_error(magic));
 467         } else {
 468                 const char *ctype = NULL;
 469
 470                 magic_setflags(magic, magicmode);
 471
 472                 switch (data_mode)
 473                 {
 474                         case SEND_RSRC:
 475                         {
 476                                 char *buffer;
 477                                 size_t b_len;
 478
 479                                 b_len = php_stream_copy_to_mem(data_ptr, &buffer, 65536, 0);
 480                                 ctype = magic_buffer(magic, buffer, b_len);
 481                                 efree(buffer);
 482                         }
 483                         break;
 484
 485                         case SEND_DATA:
 486                                 ctype = magic_buffer(magic, data_ptr, data_len);
 487                         break;
 488
 489                         default:
 490                                 ctype = magic_file(magic, data_ptr);
 491                         break;
 492                 }
 493
 494                 if (ctype) {
 495                         ct = estrdup(ctype);
 496                 } else {
 497                         http_error_ex(HE_WARNING, HTTP_E_RUNTIME, "Failed to guess Content-Type: %s", magic_error(magic));
 498                 }
 499         }
 500         if (magic) {
 501                 magic_close(magic);
 502         }
 503 #else
 504         http_error(HE_WARNING, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available");
 505 #endif
 506
 507         return ct;
 508 }
 509 /* }}} */
 510
 511 /*
 512  * Local variables:
 513  * tab-width: 4
 514  * c-basic-offset: 4
 515  * End:
 516  * vim600: sw=4 ts=4 fdm=marker
 517  * vim<600: sw=4 ts=4
 518  */
 519