/*
- +----------------------------------------------------------------------+
- | PECL :: http |
- +----------------------------------------------------------------------+
- | This source file is subject to version 3.0 of the PHP license, that |
- | is bundled with this package in the file LICENSE, and is available |
- | through the world-wide-web at http://www.php.net/license/3_0.txt. |
- | If you did not receive a copy of the PHP license and are unable to |
- | obtain it through the world-wide-web, please send a note to |
- | license@php.net so we can mail you a copy immediately. |
- +----------------------------------------------------------------------+
- | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
- +----------------------------------------------------------------------+
+ +--------------------------------------------------------------------+
+ | PECL :: http |
+ +--------------------------------------------------------------------+
+ | Redistribution and use in source and binary forms, with or without |
+ | modification, are permitted provided that the conditions mentioned |
+ | in the accompanying LICENSE file are met. |
+ +--------------------------------------------------------------------+
+ | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
+ +--------------------------------------------------------------------+
*/
/* $Id$ */
#include "php_http_headers_api.h"
#include "php_http_date_api.h"
#include "php_http_cache_api.h"
+#include "php_http_encoding_api.h"
ZEND_EXTERN_MODULE_GLOBALS(http);
-#define http_flush() _http_flush(TSRMLS_C)
+#define http_flush(d, l) _http_flush((d), (l) SRMLS_CC)
/* {{{ static inline void http_flush() */
-static inline void _http_flush(TSRMLS_D)
+static inline void _http_flush(const char *data, size_t data_len TSRMLS_DC)
{
+ PHPWRITE(data, data_len);
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_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(); \
- } \
+/* {{{ http_send_response_start */
+#define http_send_response_start(b, cl) _http_send_response_start((b), (cl) TSRMLS_CC)
+static inline void _http_send_response_start(void **buffer, size_t content_length TSRMLS_DC)
+{
+ if (http_encoding_response_start(content_length)) {
+#ifdef HTTP_HAVE_ZLIB
+ char *encoded;
+ size_t encoded_len;
+ http_encoding_stream *s = emalloc(sizeof(http_encoding_stream));
+
+ http_encoding_stream_init(s, HTTP_G(send).gzip_encoding == HTTP_ENCODING_GZIP, -1, &encoded, &encoded_len);
+ phpstr_chunked_output(&s->storage, encoded, encoded_len, HTTP_G(send).buffer_size, _http_flush TSRMLS_CC);
+ STR_FREE(encoded);
+ *buffer = s;
+#endif
}
+}
+/* }}} */
-#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)
+/* {{{ http_send_response_data_plain */
+#define http_send_response_data_plain(b, d, dl) _http_send_response_data_plain((b), (d), (dl) TSRMLS_CC)
+static inline void _http_send_response_data_plain(void **buffer, const char *data, size_t data_len TSRMLS_DC)
{
- long len = end - begin;
+ if (HTTP_G(send).gzip_encoding) {
+#ifdef HTTP_HAVE_ZLIB
+ char *encoded;
+ size_t encoded_len;
+ http_encoding_stream *s = *((http_encoding_stream **) buffer);
+
+ http_encoding_stream_update(s, data, data_len, &encoded, &encoded_len);
+ phpstr_chunked_output(&s->storage, encoded, encoded_len, HTTP_G(send).buffer_size, _http_flush TSRMLS_CC);
+ efree(encoded);
+#else
+ http_error(HE_ERROR, HTTP_E_RESPONSE, "Attempt to send GZIP response despite being able to do so; please report this bug");
+#endif
+ } else {
+ phpstr_chunked_output((phpstr **) buffer, data, data_len, HTTP_G(send).buffer_size, _http_flush TSRMLS_CC);
+ }
+}
+/* }}} */
+#define HTTP_CHUNK_AVAIL(len, cs) ((len -= cs) >= 0)
+/* {{{ http_send_response_data_fetch */
+#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)
+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)
+{
+ long len = end - begin, chunk_size = 40960;
+
switch (mode)
{
case SEND_RSRC:
{
- char *buf;
php_stream *s = (php_stream *) data;
- if (php_stream_seek(s, begin, SEEK_SET)) {
- return FAILURE;
- }
+ if (SUCCESS == php_stream_seek(s, begin, SEEK_SET)) {
+ char *buf = emalloc(chunk_size);
- 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) {
- HTTP_CHUNK_WRITE(buf, php_stream_read(s, buf, HTTP_G(send).buffer_size + len), 1, 0);
+ while (HTTP_CHUNK_AVAIL(len, chunk_size)) {
+ http_send_response_data_plain(buffer, buf, php_stream_read(s, buf, chunk_size));
+ }
+ /* read & write left over */
+ if (len) {
+ http_send_response_data_plain(buffer, buf, php_stream_read(s, buf, chunk_size + len));
+ }
+
+ efree(buf);
}
-
- efree(buf);
- return SUCCESS;
}
+ break;
case SEND_DATA:
{
char *s = (char *) data + begin;
- while (HTTP_CHUNK_AVAIL(len)) {
- HTTP_CHUNK_WRITE(s, HTTP_G(send).buffer_size, 0, 1);
- s += HTTP_G(send).buffer_size;
+ while (HTTP_CHUNK_AVAIL(len, chunk_size)) {
+ http_send_response_data_plain(buffer, s, chunk_size);
+ s += chunk_size;
}
-
/* write left over */
if (len) {
- HTTP_CHUNK_WRITE(s, HTTP_G(send).buffer_size + len, 0, 0);
+ http_send_response_data_plain(buffer, s, chunk_size + len);
}
-
- return SUCCESS;
}
-
- default:
- return FAILURE;
break;
+
+ EMPTY_SWITCH_DEFAULT_CASE();
+ }
+}
+/* }}} */
+
+/* {{{ http_send_response_finish */
+#define http_send_response_finish(b) _http_send_response_finish((b) TSRMLS_CC)
+static inline void _http_send_response_finish(void **buffer TSRMLS_DC)
+{
+ if (HTTP_G(send).gzip_encoding) {
+#ifdef HTTP_HAVE_ZLIB
+ char *encoded = NULL;
+ size_t encoded_len = 0;
+ http_encoding_stream *s = *((http_encoding_stream **) buffer);
+
+ http_encoding_stream_finish(s, &encoded, &encoded_len);
+ phpstr_chunked_output(&s->storage, encoded, encoded_len, 0, _http_flush TSRMLS_CC);
+ STR_FREE(encoded);
+ efree(s);
+#else
+ http_error(HE_ERROR, HTTP_E_RESPONSE, "Attempt to send GZIP response despite being able to do so; please report this bug");
+#endif
+ } else {
+ phpstr_chunked_output((phpstr **) buffer, NULL, 0, 0, _http_flush TSRMLS_CC);
}
}
/* }}} */
+
/* {{{ 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)
{
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);
+ header_len = snprintf(header, header_len, "%s: %s", name, value);
+ ret = http_send_header_string_ex(header, header_len, replace);
+ if (sent_header) {
+ *sent_header = header;
+ } else {
+ efree(header);
+ }
return ret;
}
/* }}} */
/* {{{ STATUS http_send_status_header(int, char *) */
-PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, zend_bool replace TSRMLS_DC)
+PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, size_t header_len, zend_bool replace TSRMLS_DC)
{
STATUS ret;
- sapi_header_line h = {(char *) header, header ? strlen(header) : 0, status};
+ sapi_header_line h = {(char *) header, header_len, 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 FAILURE;
}
- ret = http_send_header_ex("Last-Modified", lenof("Last-Modifed"), date, strlen(date), 1, sent_header);
+ ret = http_send_header_ex("Last-Modified", lenof("Last-Modified"), date, strlen(date), 1, sent_header);
efree(date);
/* remember */
}
/* remember */
- STR_FREE(HTTP_G(send).unquoted_etag);
- HTTP_G(send).unquoted_etag = estrdup(etag);
+ STR_SET(HTTP_G(send).unquoted_etag, estrndup(etag, etag_len));
- etag_header = ecalloc(1, sizeof("ETag: \"\"") + etag_len);
- sprintf(etag_header, "ETag: \"%s\"", etag);
- status = http_send_header_string(etag_header);
+ etag_len = spprintf(&etag_header, 0, "ETag: \"%s\"", etag);
+ status = http_send_header_string_ex(etag_header, etag_len, 1);
if (sent_header) {
*sent_header = etag_header;
/* {{{ 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)
{
- if (!strchr(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;
- }
+ HTTP_CHECK_CONTENT_TYPE(content_type, return FAILURE);
/* remember for multiple ranges */
STR_FREE(HTTP_G(send).content_type);
}
/* }}} */
-/* {{{ 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;
-
- /* 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)) {
- 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 %ld-%ld/%lu", **begin, **end, (ulong) size);
- http_send_header_string(range_header);
-
- /* send requested chunk */
- return http_send_chunk(data, **begin, **end + 1, mode);
- }
-
- /* multi range */
- else {
- char bound[23] = {0}, preface[1024] = {0},
- multi_header[68] = "Content-Type: multipart/byteranges; boundary=";
-
- /* Send HTTP 206 Partial Content */
- http_send_status(206);
-
- /* send multipart/byteranges header */
- snprintf(bound, 22, "--%lu%0.9f", (ulong) time(NULL), php_combined_lcg(TSRMLS_C));
- strncat(multi_header, bound + 2, 21);
- 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)) {
- break;
- }
-
- snprintf(preface, 1023,
- HTTP_CRLF "%s"
- HTTP_CRLF "Content-Type: %s"
- HTTP_CRLF "Content-Range: bytes %ld-%ld/%lu"
- HTTP_CRLF
- HTTP_CRLF,
-
- bound,
- HTTP_G(send).content_type ? HTTP_G(send).content_type : "application/x-octetstream",
- **begin,
- **end,
- (ulong) size
- );
-
- PHPWRITE(preface, strlen(preface));
- http_send_chunk(data, **begin, **end + 1, mode);
- }
-
- /* write boundary once more */
- PHPWRITE(HTTP_CRLF, lenof(HTTP_CRLF));
- PHPWRITE(bound, strlen(bound));
- PHPWRITE("--", lenof("--"));
-
- return SUCCESS;
- }
-}
-/* }}} */
-
/* {{{ 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)
{
+ void *s = NULL;
HashTable ranges;
http_range_status range_status;
- int cache_etag = 0;
-
+ int cache_etag = http_interrupt_ob_etaghandler();
+
if (!data_ptr) {
return FAILURE;
}
if (!data_size) {
return SUCCESS;
}
-
- /* stop on-the-fly etag generation */
- if (cache_etag = HTTP_G(etag).started) {
- /* interrupt ob_etaghandler */
- HTTP_G(etag).started = 0;
- }
-
+
/* enable partial dl and resume */
http_send_header_string("Accept-Ranges: bytes");
http_send_status(416);
return FAILURE;
}
-
- /* Range Request - only send ranges if entity hasn't changed */
- if ( range_status == RANGE_OK &&
- 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;
- }
-
- zend_hash_destroy(&ranges);
-
- /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
- if (cache_etag) {
- char *etag = NULL;
-
- if (!(etag = http_etag(data_ptr, data_size, data_mode))) {
- http_error(HE_NOTICE, HTTP_E_RUNTIME, "Failed to generate ETag for data source");
- } else {
- char *sent_header = NULL;
+
+ switch (range_status)
+ {
+ case RANGE_OK:
+ {
+ /* Range Request - only send ranges if entity hasn't changed */
+ if ( 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)) {
+
+ if (zend_hash_num_elements(&ranges) == 1) {
+ /* single range */
+ zval **range, **begin, **end;
+
+ if ( SUCCESS == zend_hash_index_find(&ranges, 0, (void **) &range) &&
+ SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void **) &begin) &&
+ SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void **) &end)) {
+ char range_header_str[256];
+ size_t range_header_len;
+
+ 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), (ulong) data_size);
+ http_send_status_header_ex(206, range_header_str, range_header_len, 1);
+ http_send_response_start(&s, Z_LVAL_PP(end)-Z_LVAL_PP(begin)+1);
+ http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, Z_LVAL_PP(begin), Z_LVAL_PP(end) + 1);
+ http_send_response_finish(&s);
+ zend_hash_destroy(&ranges);
+ return SUCCESS;
+ }
+ } else {
+ /* multi range */
+ zval **range, **begin, **end;
+ const char *content_type = HTTP_G(send).content_type;
+ char boundary_str[32], range_header_str[256];
+ size_t boundary_len, range_header_len;
+
+ boundary_len = snprintf(boundary_str, lenof(boundary_str), "%lu%0.9f", (ulong) time(NULL), (float) php_combined_lcg(TSRMLS_C));
+ range_header_len = snprintf(range_header_str, lenof(range_header_str), "Content-Type: multipart/byteranges; boundary=%s", boundary_str);
+
+ http_send_status_header_ex(206, range_header_str, range_header_len, 1);
+ http_send_response_start(&s, 0);
+
+ if (!content_type) {
+ content_type = "application/x-octetstream";
+ }
+
+ FOREACH_HASH_VAL(&ranges, range) {
+ if ( SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void **) &begin) &&
+ SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void **) &end)) {
+ char preface_str[512];
+ size_t preface_len;
+
+#define HTTP_RANGE_PREFACE \
+ HTTP_CRLF "--%s" \
+ HTTP_CRLF "Content-Type: %s" \
+ HTTP_CRLF "Content-Range: bytes %ld-%ld/%lu" \
+ HTTP_CRLF HTTP_CRLF
+
+ 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);
+ http_send_response_data_plain(&s, preface_str, preface_len);
+ http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, Z_LVAL_PP(begin), Z_LVAL_PP(end) + 1);
+ }
+ }
+
+ http_send_response_data_plain(&s, HTTP_CRLF "--", lenof(HTTP_CRLF "--"));
+ http_send_response_data_plain(&s, boundary_str, boundary_len);
+ http_send_response_data_plain(&s, "--", lenof("--"));
+
+ http_send_response_finish(&s);
+ zend_hash_destroy(&ranges);
+ return SUCCESS;
+ }
+ }
+ }
+ case RANGE_NO:
+ {
+ zend_hash_destroy(&ranges);
- http_send_etag_ex(etag, 32, &sent_header);
- if (http_match_etag("HTTP_IF_NONE_MATCH", 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)) {
+ char *sent_header = NULL;
+
+ http_send_etag_ex(etag, strlen(etag), &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);
+ }
+ }
+
+ /* send 304 Not Modified if last modified matches */
+ 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);
- } else {
- STR_FREE(sent_header);
}
- efree(etag);
+
+ /* send full response */
+ http_send_response_start(&s, data_size);
+ http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, 0, data_size);
+ http_send_response_finish(&s);
+ return SUCCESS;
}
}
-
- /* send 304 Not Modified if last modified matches */
- if (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);
+ return FAILURE;
}
/* }}} */
/* {{{ 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;
return FAILURE;
}
- status = http_send(file, 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);