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