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