2 +--------------------------------------------------------------------+
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 +--------------------------------------------------------------------+
19 #define HTTP_WANT_ZLIB
20 #define HTTP_WANT_MAGIC
24 #include "php_streams.h"
25 #include "ext/standard/php_lcg.h"
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"
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
)
38 PHPWRITE(data
, data_len
);
39 php_end_ob_buffer(1, 1 TSRMLS_CC
);
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)
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
;
56 req
.tv_sec
= (time_t) HTTP_G(send
).throttle_delay
;
57 req
.tv_nsec
= HTTP_NSEC(HTTP_G(send
).throttle_delay
) % HTTP_NANOSEC
;
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
;
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
)
74 if ((encoding
= http_encoding_response_start(content_length
))) {
76 *buffer
= http_encoding_deflate_stream_init(NULL
,
77 (encoding
== HTTP_ENCODING_GZIP
) ?
78 HTTP_DEFLATE_TYPE_GZIP
: HTTP_DEFLATE_TYPE_ZLIB
);
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
)
88 if (HTTP_G(send
).deflate
.encoding
) {
92 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
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
);
98 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
101 phpstr_chunked_output((phpstr
**) buffer
, data
, data_len
, HTTP_G(send
).buffer_size
, _http_flush TSRMLS_CC
);
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
)
111 long len
= end
- begin
, chunk_size
= 40960;
117 php_stream
*s
= (php_stream
*) data
;
119 if (SUCCESS
== php_stream_seek(s
, begin
, SEEK_SET
)) {
120 char *buf
= emalloc(chunk_size
);
122 while (HTTP_CHUNK_AVAIL(len
, chunk_size
)) {
123 http_send_response_data_plain(buffer
, buf
, php_stream_read(s
, buf
, chunk_size
));
125 /* read & write left over */
127 http_send_response_data_plain(buffer
, buf
, php_stream_read(s
, buf
, chunk_size
+ len
));
137 char *s
= (char *) data
+ begin
;
139 while (HTTP_CHUNK_AVAIL(len
, chunk_size
)) {
140 http_send_response_data_plain(buffer
, s
, chunk_size
);
143 /* write left over */
145 http_send_response_data_plain(buffer
, s
, chunk_size
+ len
);
150 EMPTY_SWITCH_DEFAULT_CASE();
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
)
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
);
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
);
170 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
173 phpstr_chunked_output((phpstr
**) buffer
, NULL
, 0, 0, _http_flush TSRMLS_CC
);
179 PHP_MINIT_FUNCTION(http_send
)
181 HTTP_LONG_CONSTANT("HTTP_REDIRECT", HTTP_REDIRECT
);
182 HTTP_LONG_CONSTANT("HTTP_REDIRECT_AUTO", HTTP_REDIRECT_AUTO
);
183 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PERM", HTTP_REDIRECT_PERM
);
184 HTTP_LONG_CONSTANT("HTTP_REDIRECT_POST", HTTP_REDIRECT_POST
);
185 HTTP_LONG_CONSTANT("HTTP_REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
192 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
193 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
)
196 size_t header_len
= sizeof(": ") + name_len
+ value_len
+ 1;
197 char *header
= emalloc(header_len
+ 1);
199 header
[header_len
] = '\0';
200 header_len
= snprintf(header
, header_len
, "%s: %s", name
, value
);
201 ret
= http_send_header_string_ex(header
, header_len
, replace
);
203 *sent_header
= header
;
211 /* {{{ STATUS http_send_status_header(int, char *) */
212 PHP_HTTP_API STATUS
_http_send_status_header_ex(int status
, const char *header
, size_t header_len
, zend_bool replace TSRMLS_DC
)
215 sapi_header_line h
= {(char *) header
, header_len
, status
};
216 if (SUCCESS
!= (ret
= sapi_header_op(replace
? SAPI_HEADER_REPLACE
: SAPI_HEADER_ADD
, &h TSRMLS_CC
))) {
217 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Could not send header: %s (%d)", header
, status
);
223 /* {{{ STATUS http_send_last_modified(int) */
224 PHP_HTTP_API STATUS
_http_send_last_modified_ex(time_t t
, char **sent_header TSRMLS_DC
)
227 char *date
= http_date(t
);
233 ret
= http_send_header_ex("Last-Modified", lenof("Last-Modified"), date
, strlen(date
), 1, sent_header
);
237 HTTP_G(send
).last_modified
= t
;
243 /* {{{ STATUS http_send_etag(char *, size_t) */
244 PHP_HTTP_API STATUS
_http_send_etag_ex(const char *etag
, size_t etag_len
, char **sent_header TSRMLS_DC
)
250 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Attempt to send empty ETag (previous: %s)\n", HTTP_G(send
).unquoted_etag
);
255 STR_SET(HTTP_G(send
).unquoted_etag
, estrndup(etag
, etag_len
));
257 etag_len
= spprintf(&etag_header
, 0, "ETag: \"%s\"", etag
);
258 status
= http_send_header_string_ex(etag_header
, etag_len
, 1);
261 *sent_header
= etag_header
;
270 /* {{{ STATUS http_send_content_type(char *, size_t) */
271 PHP_HTTP_API STATUS
_http_send_content_type(const char *content_type
, size_t ct_len TSRMLS_DC
)
273 HTTP_CHECK_CONTENT_TYPE(content_type
, return FAILURE
);
275 /* remember for multiple ranges */
276 STR_FREE(HTTP_G(send
).content_type
);
277 HTTP_G(send
).content_type
= estrndup(content_type
, ct_len
);
279 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type
, ct_len
, 1, NULL
);
283 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
284 PHP_HTTP_API STATUS
_http_send_content_disposition(const char *filename
, size_t f_len
, zend_bool send_inline TSRMLS_DC
)
290 cd_header
= ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len
);
291 sprintf(cd_header
, "Content-Disposition: inline; filename=\"%s\"", filename
);
293 cd_header
= ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len
);
294 sprintf(cd_header
, "Content-Disposition: attachment; filename=\"%s\"", filename
);
297 status
= http_send_header_string(cd_header
);
303 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
304 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
)
308 http_range_status range_status
;
309 int cache_etag
= http_interrupt_ob_etaghandler();
318 /* enable partial dl and resume */
319 http_send_header_string("Accept-Ranges: bytes");
321 zend_hash_init(&ranges
, 0, NULL
, ZVAL_PTR_DTOR
, 0);
322 range_status
= http_get_request_ranges(&ranges
, data_size
);
324 switch (range_status
)
328 zend_hash_destroy(&ranges
);
329 http_send_status(416);
334 /* Range Request - only send ranges if entity hasn't changed */
335 if ( http_match_etag_ex("HTTP_IF_MATCH", HTTP_G(send
).unquoted_etag
, 0) &&
336 http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G(send
).last_modified
, 0) &&
337 http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G(send
).last_modified
, 0)) {
339 if (zend_hash_num_elements(&ranges
) == 1) {
341 zval
**range
, **begin
, **end
;
343 if ( SUCCESS
== zend_hash_index_find(&ranges
, 0, (void **) &range
) &&
344 SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void **) &begin
) &&
345 SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void **) &end
)) {
346 char range_header_str
[256];
347 size_t range_header_len
;
349 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
);
350 http_send_status_header_ex(206, range_header_str
, range_header_len
, 1);
351 http_send_response_start(&s
, Z_LVAL_PP(end
)-Z_LVAL_PP(begin
)+1);
352 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
353 http_send_response_finish(&s
);
354 zend_hash_destroy(&ranges
);
360 zval
**range
, **begin
, **end
;
361 const char *content_type
= HTTP_G(send
).content_type
;
362 char boundary_str
[32], range_header_str
[256];
363 size_t boundary_len
, range_header_len
;
365 boundary_len
= snprintf(boundary_str
, lenof(boundary_str
), "%lu%0.9f", (ulong
) time(NULL
), (float) php_combined_lcg(TSRMLS_C
));
366 range_header_len
= snprintf(range_header_str
, lenof(range_header_str
), "Content-Type: multipart/byteranges; boundary=%s", boundary_str
);
368 http_send_status_header_ex(206, range_header_str
, range_header_len
, 1);
369 http_send_response_start(&s
, 0);
372 content_type
= "application/x-octetstream";
375 FOREACH_HASH_VAL(pos
, &ranges
, range
) {
376 if ( SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void **) &begin
) &&
377 SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void **) &end
)) {
378 char preface_str
[512];
381 #define HTTP_RANGE_PREFACE \
383 HTTP_CRLF "Content-Type: %s" \
384 HTTP_CRLF "Content-Range: bytes %ld-%ld/%zu" \
387 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
);
388 http_send_response_data_plain(&s
, preface_str
, preface_len
);
389 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
393 http_send_response_data_plain(&s
, HTTP_CRLF
"--", lenof(HTTP_CRLF
"--"));
394 http_send_response_data_plain(&s
, boundary_str
, boundary_len
);
395 http_send_response_data_plain(&s
, "--", lenof("--"));
397 http_send_response_finish(&s
);
398 zend_hash_destroy(&ranges
);
405 zend_hash_destroy(&ranges
);
407 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
408 if (!no_cache
&& cache_etag
) {
411 if ((etag
= http_etag(data_ptr
, data_size
, data_mode
))) {
412 char *sent_header
= NULL
;
414 http_send_etag_ex(etag
, strlen(etag
), &sent_header
);
415 if (http_match_etag("HTTP_IF_NONE_MATCH", etag
)) {
416 return http_exit_ex(304, sent_header
, NULL
, 0);
418 STR_FREE(sent_header
);
424 /* send 304 Not Modified if last modified matches */
425 if (!no_cache
&& http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G(send
).last_modified
)) {
426 char *sent_header
= NULL
;
427 http_send_last_modified_ex(HTTP_G(send
).last_modified
, &sent_header
);
428 return http_exit_ex(304, sent_header
, NULL
, 0);
431 /* send full response */
432 http_send_response_start(&s
, data_size
);
433 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, 0, data_size
);
434 http_send_response_finish(&s
);
442 /* {{{ STATUS http_send_stream(php_stream *) */
443 PHP_HTTP_API STATUS
_http_send_stream_ex(php_stream
*file
, zend_bool close_stream
, zend_bool no_cache TSRMLS_DC
)
446 php_stream_statbuf ssb
;
448 if ((!file
) || php_stream_stat(file
, &ssb
)) {
452 status
= http_send_ex(file
, ssb
.sb
.st_size
, SEND_RSRC
, no_cache
);
455 php_stream_close(file
);
462 /* {{{ char *http_guess_content_type(char *magic_file, long magic_mode, void *data, size_t size, http_send_mode mode) */
463 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
)
467 #ifdef HTTP_HAVE_MAGIC
468 struct magic_set
*magic
;
470 HTTP_CHECK_OPEN_BASEDIR(magicfile
, return NULL
);
472 /* magic_load() fails if MAGIC_MIME is set because it
473 cowardly adds .mime to the file name */
474 magic
= magic_open(magicmode
&~ MAGIC_MIME
);
477 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid magic mode: %ld", magicmode
);
478 } else if (-1 == magic_load(magic
, magicfile
)) {
479 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to load magic database '%s' (%s)", magicfile
, magic_error(magic
));
481 const char *ctype
= NULL
;
483 magic_setflags(magic
, magicmode
);
492 b_len
= php_stream_copy_to_mem(data_ptr
, &buffer
, 65536, 0);
493 ctype
= magic_buffer(magic
, buffer
, b_len
);
499 ctype
= magic_buffer(magic
, data_ptr
, data_len
);
503 HTTP_CHECK_OPEN_BASEDIR(data_ptr
, magic_close(magic
); return NULL
);
504 ctype
= magic_file(magic
, data_ptr
);
511 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to guess Content-Type: %s", magic_error(magic
));
518 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
530 * vim600: sw=4 ts=4 fdm=marker