- fixed a gotcha in http_chunked_decode (-size_t is always > 0)
[m6w6/ext-http] / http_send_api.c
index 0fa18daa01c546c12b34c120c5b318eda0e1586a..3f6f2a6ef524c75e9b5071b9ba8e52cd55338eba 100644 (file)
 #ifdef HAVE_CONFIG_H
 #      include "config.h"
 #endif
-
 #include "php.h"
+
+#include "SAPI.h"
 #include "php_streams.h"
 #include "ext/standard/php_lcg.h"
-#include "SAPI.h"
 
 #include "php_http.h"
 #include "php_http_std_defs.h"
 
 ZEND_EXTERN_MODULE_GLOBALS(http);
 
+#define http_flush() _http_flush(TSRMLS_C)
+/* {{{ static inline void http_flush() */
+static inline void _http_flush(TSRMLS_D)
+{
+       php_end_ob_buffer(1, 1 TSRMLS_CC);
+       sapi_flush(TSRMLS_C);
+}
+/* }}} */
+
+#define http_sleep() _http_sleep(TSRMLS_C)
+/* {{{ static inline void http_sleep() */
+static inline void _http_sleep(TSRMLS_D)
+{
+#define HTTP_MSEC(s) (s * 1000)
+#define HTTP_USEC(s) (HTTP_MSEC(s) * 1000)
+#define HTTP_NSEC(s) (HTTP_USEC(s) * 1000)
+#define HTTP_NANOSEC (1000 * 1000 * 1000)
+#define HTTP_DIFFSEC (0.001)
+
+       if (HTTP_G(send).throttle_delay >= HTTP_DIFFSEC) {
+#if defined(PHP_WIN32)
+               Sleep((DWORD) HTTP_MSEC(HTTP_G(send).throttle_delay));
+#elif defined(HAVE_USLEEP)
+               usleep(HTTP_USEC(HTTP_G(send).throttle_delay));
+#elif defined(HAVE_NANOSLEEP)
+               struct timespec req, rem;
+
+               req.tv_sec = (time_t) HTTP_G(send).throttle_delay;
+               req.tv_nsec = HTTP_NSEC(HTTP_G(send).throttle_delay) % HTTP_NANOSEC;
+
+               while (nanosleep(&req, &rem) && (errno == EINTR) && (HTTP_NSEC(rem.tv_sec) + rem.tv_nsec) > HTTP_NSEC(HTTP_DIFFSEC))) {
+                       req.tv_sec = rem.tv_sec;
+                       req.tv_nsec = rem.tv_nsec;
+               }
+#endif
+       }
+}
+/* }}} */
+
+#define HTTP_CHUNK_AVAIL(len) ((len -= HTTP_G(send).buffer_size) >= 0)
+#define HTTP_CHUNK_WRITE(data, l, dofree, dosleep) \
+       { \
+               long size = (long) l; \
+ \
+               if ((1 > size) || (size - PHPWRITE(data, size))) { \
+                       if (dofree) { \
+                               efree(data); \
+                       } \
+                       return FAILURE; \
+               } \
+ \
+               http_flush(); \
+               if (dosleep) { \
+                       http_sleep(); \
+               } \
+       }
+
 #define http_send_chunk(d, b, e, m) _http_send_chunk((d), (b), (e), (m) TSRMLS_CC)
 /* {{{ static STATUS http_send_chunk(const void *, size_t, size_t, http_send_mode) */
 static STATUS _http_send_chunk(const void *data, size_t begin, size_t end, http_send_mode mode TSRMLS_DC)
@@ -46,44 +103,23 @@ static STATUS _http_send_chunk(const void *data, size_t begin, size_t end, http_
                case SEND_RSRC:
                {
                        char *buf;
-                       size_t read = 0;
                        php_stream *s = (php_stream *) data;
 
                        if (php_stream_seek(s, begin, SEEK_SET)) {
                                return FAILURE;
                        }
 
-                       buf = (char *) ecalloc(1, HTTP_SENDBUF_SIZE);
-                       /* read into buf and write out */
-                       while ((len -= HTTP_SENDBUF_SIZE) >= 0) {
-                               if (!(read = php_stream_read(s, buf, HTTP_SENDBUF_SIZE))) {
-                                       efree(buf);
-                                       return FAILURE;
-                               }
-                               if (read - php_body_write(buf, read TSRMLS_CC)) {
-                                       efree(buf);
-                                       return FAILURE;
-                               }
-                               /* ob_flush() && flush() */
-                               php_end_ob_buffer(1, 1 TSRMLS_CC);
-                               sapi_flush(TSRMLS_C);
+                       buf = emalloc(HTTP_G(send).buffer_size);
+
+                       while (HTTP_CHUNK_AVAIL(len)) {
+                               HTTP_CHUNK_WRITE(buf, php_stream_read(s, buf, HTTP_G(send).buffer_size), 1, 1);
                        }
 
                        /* read & write left over */
                        if (len) {
-                               if (read = php_stream_read(s, buf, HTTP_SENDBUF_SIZE + len)) {
-                                       if (read - php_body_write(buf, read TSRMLS_CC)) {
-                                               efree(buf);
-                                               return FAILURE;
-                                       }
-                               } else {
-                                       efree(buf);
-                                       return FAILURE;
-                               }
-                               /* ob_flush() & flush() */
-                               php_end_ob_buffer(1, 1 TSRMLS_CC);
-                               sapi_flush(TSRMLS_C);
+                               HTTP_CHUNK_WRITE(buf, php_stream_read(s, buf, HTTP_G(send).buffer_size + len), 1, 0);
                        }
+
                        efree(buf);
                        return SUCCESS;
                }
@@ -92,25 +128,16 @@ static STATUS _http_send_chunk(const void *data, size_t begin, size_t end, http_
                {
                        char *s = (char *) data + begin;
 
-                       while ((len -= HTTP_SENDBUF_SIZE) >= 0) {
-                               if (HTTP_SENDBUF_SIZE - php_body_write(s, HTTP_SENDBUF_SIZE TSRMLS_CC)) {
-                                       return FAILURE;
-                               }
-                               s += HTTP_SENDBUF_SIZE;
-                               /* ob_flush() & flush() */
-                               php_end_ob_buffer(1, 1 TSRMLS_CC);
-                               sapi_flush(TSRMLS_C);
+                       while (HTTP_CHUNK_AVAIL(len)) {
+                               HTTP_CHUNK_WRITE(s, HTTP_G(send).buffer_size, 0, 1);
+                               s += HTTP_G(send).buffer_size;
                        }
 
                        /* write left over */
                        if (len) {
-                               if (HTTP_SENDBUF_SIZE + len - php_body_write(s, HTTP_SENDBUF_SIZE + len TSRMLS_CC)) {
-                                               return FAILURE;
-                               }
-                               /* ob_flush() & flush() */
-                               php_end_ob_buffer(1, 1 TSRMLS_CC);
-                               sapi_flush(TSRMLS_C);
+                               HTTP_CHUNK_WRITE(s, HTTP_G(send).buffer_size + len, 0, 0);
                        }
+
                        return SUCCESS;
                }
 
@@ -121,71 +148,78 @@ static STATUS _http_send_chunk(const void *data, size_t begin, size_t end, http_
 }
 /* }}} */
 
+/* {{{ STATUS http_send_header(char *, char *, zend_bool) */
+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)
+{
+       STATUS ret;
+       size_t header_len = sizeof(": ") + name_len + value_len + 1;
+       char *header = emalloc(header_len + 1);
+
+       header[header_len] = '\0';
+       snprintf(header, header_len, "%s: %s", name, value);
+       ret = http_send_header_string_ex(header, replace);
+       efree(header);
+       return ret;
+}
+/* }}} */
 
 /* {{{ STATUS http_send_status_header(int, char *) */
-PHP_HTTP_API STATUS _http_send_status_header(int status, const char *header TSRMLS_DC)
+PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, zend_bool replace TSRMLS_DC)
 {
        STATUS ret;
        sapi_header_line h = {(char *) header, header ? strlen(header) : 0, status};
-       if (SUCCESS != (ret = sapi_header_op(SAPI_HEADER_REPLACE, &h TSRMLS_CC))) {
-               http_error_ex(E_WARNING, HTTP_E_HEADER, "Could not send header: %s (%d)", header, status);
+       if (SUCCESS != (ret = sapi_header_op(replace ? SAPI_HEADER_REPLACE : SAPI_HEADER_ADD, &h TSRMLS_CC))) {
+               http_error_ex(HE_WARNING, HTTP_E_HEADER, "Could not send header: %s (%d)", header, status);
        }
        return ret;
 }
 /* }}} */
 
 /* {{{ STATUS http_send_last_modified(int) */
-PHP_HTTP_API STATUS _http_send_last_modified(time_t t TSRMLS_DC)
+PHP_HTTP_API STATUS _http_send_last_modified_ex(time_t t, char **sent_header TSRMLS_DC)
 {
-       char *date = NULL;
-       if (date = http_date(t)) {
-               char modified[96] = "Last-Modified: ";
-               strcat(modified, date);
-               efree(date);
-
-               /* remember */
-               HTTP_G(lmod) = t;
+       STATUS ret;
+       char *date = http_date(t);
 
-               return http_send_header(modified);
+       if (!date) {
+               return FAILURE;
        }
-       return FAILURE;
+
+       ret = http_send_header_ex("Last-Modified", lenof("Last-Modifed"), date, strlen(date), 1, sent_header);
+       efree(date);
+
+       /* remember */
+       HTTP_G(send).last_modified = t;
+
+       return ret;
 }
 /* }}} */
 
 /* {{{ STATUS http_send_etag(char *, size_t) */
-PHP_HTTP_API STATUS _http_send_etag(const char *etag, size_t etag_len TSRMLS_DC)
+PHP_HTTP_API STATUS _http_send_etag_ex(const char *etag, size_t etag_len, char **sent_header TSRMLS_DC)
 {
        STATUS status;
        char *etag_header;
 
        if (!etag_len){
-               http_error_ex(E_WARNING, HTTP_E_HEADER, "Attempt to send empty ETag (previous: %s)\n", HTTP_G(etag));
+               http_error_ex(HE_WARNING, HTTP_E_HEADER, "Attempt to send empty ETag (previous: %s)\n", HTTP_G(send).unquoted_etag);
                return FAILURE;
        }
 
        /* remember */
-       if (HTTP_G(etag)) {
-               efree(HTTP_G(etag));
-       }
-       HTTP_G(etag) = estrdup(etag);
+       STR_FREE(HTTP_G(send).unquoted_etag);
+       HTTP_G(send).unquoted_etag = estrdup(etag);
 
        etag_header = ecalloc(1, sizeof("ETag: \"\"") + etag_len);
        sprintf(etag_header, "ETag: \"%s\"", etag);
-       status = http_send_header(etag_header);
-       efree(etag_header);
-       return status;
-}
-/* }}} */
-
-/* {{{ STATUS http_send_cache_control(char *, size_t) */
-PHP_HTTP_API STATUS _http_send_cache_control(const char *cache_control, size_t cc_len TSRMLS_DC)
-{
-       STATUS status;
-       char *cc_header = ecalloc(1, sizeof("Cache-Control: ") + cc_len);
-
-       sprintf(cc_header, "Cache-Control: %s", cache_control);
-       status = http_send_header(cc_header);
-       efree(cc_header);
+       status = http_send_header_string(etag_header);
+       
+       if (sent_header) {
+               *sent_header = etag_header;
+       } else {
+               efree(etag_header);
+       }
+       
        return status;
 }
 /* }}} */
@@ -193,25 +227,16 @@ PHP_HTTP_API STATUS _http_send_cache_control(const char *cache_control, size_t c
 /* {{{ STATUS http_send_content_type(char *, size_t) */
 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, size_t ct_len TSRMLS_DC)
 {
-       STATUS status;
-       char *ct_header;
-
        if (!strchr(content_type, '/')) {
-               http_error_ex(E_WARNING, HTTP_E_PARAM, "Content-Type '%s' doesn't seem to consist of a primary and a secondary part", content_type);
+               http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Content-Type '%s' doesn't seem to consist of a primary and a secondary part", content_type);
                return FAILURE;
        }
 
        /* remember for multiple ranges */
-       if (HTTP_G(ctype)) {
-               efree(HTTP_G(ctype));
-       }
-       HTTP_G(ctype) = estrndup(content_type, ct_len);
+       STR_FREE(HTTP_G(send).content_type);
+       HTTP_G(send).content_type = estrndup(content_type, ct_len);
 
-       ct_header = ecalloc(1, sizeof("Content-Type: ") + ct_len);
-       sprintf(ct_header, "Content-Type: %s", content_type);
-       status = http_send_header(ct_header);
-       efree(ct_header);
-       return status;
+       return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type, ct_len, 1, NULL);
 }
 /* }}} */
 
@@ -229,7 +254,7 @@ PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, size_t
                sprintf(cd_header, "Content-Disposition: attachment; filename=\"%s\"", filename);
        }
 
-       status = http_send_header(cd_header);
+       status = http_send_header_string(cd_header);
        efree(cd_header);
        return status;
 }
@@ -238,32 +263,33 @@ PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, size_t
 /* {{{ STATUS http_send_ranges(HashTable *, void *, size_t, http_send_mode) */
 PHP_HTTP_API STATUS _http_send_ranges(HashTable *ranges, const void *data, size_t size, http_send_mode mode TSRMLS_DC)
 {
-       long **begin, **end;
-       zval **zrange;
+       zval **zbegin, **zend, **zrange;
 
        /* single range */
        if (zend_hash_num_elements(ranges) == 1) {
                char range_header[256] = {0};
 
                if (SUCCESS != zend_hash_index_find(ranges, 0, (void **) &zrange) ||
-                       SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &begin) ||
-                       SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &end)) {
+                       SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &zbegin) ||
+                       SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &zend)) {
+                       http_send_status(500);
                        return FAILURE;
                }
-
+               
                /* Send HTTP 206 Partial Content */
                http_send_status(206);
 
                /* send content range header */
-               snprintf(range_header, 255, "Content-Range: bytes %d-%d/%d", **begin, **end, size);
-               http_send_header(range_header);
+               snprintf(range_header, 255, "Content-Range: bytes %ld-%ld/%lu", Z_LVAL_PP(zbegin), Z_LVAL_PP(zend), (ulong) size);
+               http_send_header_string(range_header);
 
                /* send requested chunk */
-               return http_send_chunk(data, **begin, **end + 1, mode);
+               return http_send_chunk(data, Z_LVAL_PP(zbegin), Z_LVAL_PP(zend) + 1, mode);
        }
 
        /* multi range */
        else {
+               size_t preface_len;
                char bound[23] = {0}, preface[1024] = {0},
                        multi_header[68] = "Content-Type: multipart/byteranges; boundary=";
 
@@ -271,39 +297,39 @@ PHP_HTTP_API STATUS _http_send_ranges(HashTable *ranges, const void *data, size_
                http_send_status(206);
 
                /* send multipart/byteranges header */
-               snprintf(bound, 22, "--%d%0.9f", time(NULL), php_combined_lcg(TSRMLS_C));
+               snprintf(bound, 22, "--%lu%0.9f", (ulong) time(NULL), php_combined_lcg(TSRMLS_C));
                strncat(multi_header, bound + 2, 21);
-               http_send_header(multi_header);
+               http_send_header_string(multi_header);
 
                /* send each requested chunk */
                FOREACH_HASH_VAL(ranges, zrange) {
-                       if (SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &begin) ||
-                               SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &end)) {
+                       if (SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &zbegin) ||
+                               SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &zend)) {
                                break;
                        }
 
-                       snprintf(preface, 1023,
+                       preface_len = snprintf(preface, 1023,
                                HTTP_CRLF "%s"
                                HTTP_CRLF "Content-Type: %s"
-                               HTTP_CRLF "Content-Range: bytes %ld-%ld/%ld"
+                               HTTP_CRLF "Content-Range: bytes %ld-%ld/%lu"
                                HTTP_CRLF
                                HTTP_CRLF,
 
                                bound,
-                               HTTP_G(ctype) ? HTTP_G(ctype) : "application/x-octetstream",
-                               **begin,
-                               **end,
-                               size
+                               HTTP_G(send).content_type ? HTTP_G(send).content_type : "application/x-octetstream",
+                               Z_LVAL_PP(zbegin),
+                               Z_LVAL_PP(zend),
+                               (ulong) size
                        );
 
-                       php_body_write(preface, strlen(preface) TSRMLS_CC);
-                       http_send_chunk(data, **begin, **end + 1, mode);
+                       PHPWRITE(preface, preface_len);
+                       http_send_chunk(data, Z_LVAL_PP(zbegin), Z_LVAL_PP(zend) + 1, mode);
                }
 
                /* write boundary once more */
-               php_body_write(HTTP_CRLF, sizeof(HTTP_CRLF) - 1 TSRMLS_CC);
-               php_body_write(bound, strlen(bound) TSRMLS_CC);
-               php_body_write("--", 2 TSRMLS_CC);
+               PHPWRITE(HTTP_CRLF, lenof(HTTP_CRLF));
+               PHPWRITE(bound, strlen(bound));
+               PHPWRITE("--", lenof("--"));
 
                return SUCCESS;
        }
@@ -311,7 +337,7 @@ PHP_HTTP_API STATUS _http_send_ranges(HashTable *ranges, const void *data, size_
 /* }}} */
 
 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
-PHP_HTTP_API STATUS _http_send(const void *data_ptr, size_t data_size, http_send_mode data_mode TSRMLS_DC)
+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)
 {
        HashTable ranges;
        http_range_status range_status;
@@ -325,11 +351,14 @@ PHP_HTTP_API STATUS _http_send(const void *data_ptr, size_t data_size, http_send
        }
 
        /* stop on-the-fly etag generation */
-       if (cache_etag = HTTP_G(etag_started)) {
+       if (cache_etag = HTTP_G(etag).started) {
                /* interrupt ob_etaghandler */
-               HTTP_G(etag_started) = 0;
+               HTTP_G(etag).started = 0;
        }
 
+       /* enable partial dl and resume */
+       http_send_header_string("Accept-Ranges: bytes");
+
        zend_hash_init(&ranges, 0, NULL, ZVAL_PTR_DTOR, 0);
        range_status = http_get_request_ranges(&ranges, data_size);
 
@@ -341,8 +370,9 @@ PHP_HTTP_API STATUS _http_send(const void *data_ptr, size_t data_size, http_send
 
        /* Range Request - only send ranges if entity hasn't changed */
        if (    range_status == RANGE_OK &&
-                       http_match_etag_ex("HTTP_IF_MATCH", HTTP_G(etag), 0) &&
-                       http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G(lmod), 0)) {
+                       http_match_etag_ex("HTTP_IF_MATCH", HTTP_G(send).unquoted_etag, 0) &&
+                       http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G(send).last_modified, 0) &&
+                       http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G(send).last_modified, 0)) {
                STATUS result = http_send_ranges(&ranges, data_ptr, data_size, data_mode);
                zend_hash_destroy(&ranges);
                return result;
@@ -350,43 +380,55 @@ PHP_HTTP_API STATUS _http_send(const void *data_ptr, size_t data_size, http_send
 
        zend_hash_destroy(&ranges);
 
-       /* send 304 Not Modified if etag matches */
-       if (cache_etag) {
+       /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
+       if (!no_cache && cache_etag) {
                char *etag = NULL;
 
                if (!(etag = http_etag(data_ptr, data_size, data_mode))) {
-                       return FAILURE;
-               }
-               if (SUCCESS != http_send_etag(etag, 32)) {
+                       http_error(HE_NOTICE, HTTP_E_RUNTIME, "Failed to generate ETag for data source");
+               } else {
+                       char *sent_header = NULL;
+                       
+                       http_send_etag_ex(etag, 32, &sent_header);
+                       if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
+                               return http_exit_ex(304, sent_header, NULL, 0);
+                       } else {
+                               STR_FREE(sent_header);
+                       }
                        efree(etag);
-                       return FAILURE;
                }
-               if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
-                       return http_cache_exit(etag, 1, 1);
-               }
-               efree(etag);
        }
 
        /* send 304 Not Modified if last modified matches */
-       if (http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G(lmod))) {
-               return http_cache_exit(http_date(HTTP_G(lmod)), 0, 1);
+       if (!no_cache && http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G(send).last_modified)) {
+               char *sent_header = NULL;
+               http_send_last_modified_ex(HTTP_G(send).last_modified, &sent_header);
+               return http_exit_ex(304, sent_header, NULL, 0);
        }
 
+       /* emit a content-length header */
+       if (!php_ob_handler_used("ob_gzhandler" TSRMLS_CC)) {
+               char *cl;
+               spprintf(&cl, 0, "Content-Length: %lu", (unsigned long) data_size);
+               http_send_header_string(cl);
+               efree(cl);
+       }
        /* send full entity */
        return http_send_chunk(data_ptr, 0, data_size, data_mode);
 }
 /* }}} */
 
 /* {{{ STATUS http_send_stream(php_stream *) */
-PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_stream TSRMLS_DC)
+PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_stream, zend_bool no_cache TSRMLS_DC)
 {
        STATUS status;
+       php_stream_statbuf ssb;
 
-       if ((!file) || php_stream_stat(file, &HTTP_G(ssb))) {
+       if ((!file) || php_stream_stat(file, &ssb)) {
                return FAILURE;
        }
 
-       status = http_send(file, HTTP_G(ssb).sb.st_size, SEND_RSRC);
+       status = http_send_ex(file, ssb.sb.st_size, SEND_RSRC, no_cache);
 
        if (close_stream) {
                php_stream_close(file);
@@ -396,7 +438,6 @@ PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_strea
 }
 /* }}} */
 
-
 /*
  * Local variables:
  * tab-width: 4