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 +--------------------------------------------------------------------+
15 #define HTTP_WANT_SAPI
16 #define HTTP_WANT_ZLIB
17 #define HTTP_WANT_MAGIC
20 #include "php_streams.h"
21 #include "ext/standard/php_lcg.h"
23 #include "php_http_api.h"
24 #include "php_http_cache_api.h"
25 #include "php_http_date_api.h"
26 #include "php_http_encoding_api.h"
27 #include "php_http_headers_api.h"
28 #include "php_http_send_api.h"
30 #define http_flush(d, l) _http_flush(NULL, (d), (l) TSRMLS_CC)
31 /* {{{ static inline void http_flush() */
32 static inline void _http_flush(void *nothing
, const char *data
, size_t data_len TSRMLS_DC
)
34 PHPWRITE(data
, data_len
);
35 php_end_ob_buffer(1, 1 TSRMLS_CC
);
38 #define HTTP_MSEC(s) (s * 1000)
39 #define HTTP_USEC(s) (HTTP_MSEC(s) * 1000)
40 #define HTTP_NSEC(s) (HTTP_USEC(s) * 1000)
41 #define HTTP_NANOSEC (1000 * 1000 * 1000)
42 #define HTTP_DIFFSEC (0.001)
44 if (HTTP_G
->send
.throttle_delay
>= HTTP_DIFFSEC
) {
45 #if defined(PHP_WIN32)
46 Sleep((DWORD
) HTTP_MSEC(HTTP_G
->send
.throttle_delay
));
47 #elif defined(HAVE_USLEEP)
48 usleep(HTTP_USEC(HTTP_G
->send
.throttle_delay
));
49 #elif defined(HAVE_NANOSLEEP)
50 struct timespec req
, rem
;
52 req
.tv_sec
= (time_t) HTTP_G
->send
.throttle_delay
;
53 req
.tv_nsec
= HTTP_NSEC(HTTP_G
->send
.throttle_delay
) % HTTP_NANOSEC
;
55 while (nanosleep(&req
, &rem
) && (errno
== EINTR
) && (HTTP_NSEC(rem
.tv_sec
) + rem
.tv_nsec
) > HTTP_NSEC(HTTP_DIFFSEC
))) {
56 req
.tv_sec
= rem
.tv_sec
;
57 req
.tv_nsec
= rem
.tv_nsec
;
64 /* {{{ http_send_response_start */
65 #define http_send_response_start(b, cl) _http_send_response_start((b), (cl) TSRMLS_CC)
66 static inline void _http_send_response_start(void **buffer
, size_t content_length TSRMLS_DC
)
70 if ((encoding
= http_encoding_response_start(content_length
))) {
72 *buffer
= http_encoding_deflate_stream_init(NULL
,
73 (encoding
== HTTP_ENCODING_GZIP
) ?
74 HTTP_DEFLATE_TYPE_GZIP
: HTTP_DEFLATE_TYPE_ZLIB
);
80 /* {{{ http_send_response_data_plain */
81 #define http_send_response_data_plain(b, d, dl) _http_send_response_data_plain((b), (d), (dl) TSRMLS_CC)
82 static inline void _http_send_response_data_plain(void **buffer
, const char *data
, size_t data_len TSRMLS_DC
)
84 if (HTTP_G
->send
.deflate
.encoding
) {
88 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
90 http_encoding_deflate_stream_update(s
, data
, data_len
, &encoded
, &encoded_len
);
91 phpstr_chunked_output((phpstr
**) &s
->storage
, encoded
, encoded_len
, HTTP_G
->send
.buffer_size
, _http_flush
, NULL TSRMLS_CC
);
94 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
97 phpstr_chunked_output((phpstr
**) buffer
, data
, data_len
, HTTP_G
->send
.buffer_size
, _http_flush
, NULL TSRMLS_CC
);
102 /* {{{ http_send_response_data_fetch */
103 #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)
104 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
)
107 long got
, len
= end
- begin
;
112 php_stream
*s
= (php_stream
*) data
;
114 if (SUCCESS
== php_stream_seek(s
, begin
, SEEK_SET
)) {
115 buf
= emalloc(HTTP_SENDBUF_SIZE
);
118 got
= php_stream_read(s
, buf
, MIN(len
, HTTP_SENDBUF_SIZE
));
119 http_send_response_data_plain(buffer
, buf
, got
);
130 buf
= (char *) data
+ begin
;
133 got
= MIN(len
, HTTP_SENDBUF_SIZE
);
134 http_send_response_data_plain(buffer
, buf
, got
);
141 EMPTY_SWITCH_DEFAULT_CASE();
146 /* {{{ http_send_response_finish */
147 #define http_send_response_finish(b) _http_send_response_finish((b) TSRMLS_CC)
148 static inline void _http_send_response_finish(void **buffer TSRMLS_DC
)
150 if (HTTP_G
->send
.deflate
.encoding
) {
151 #ifdef HTTP_HAVE_ZLIB
152 char *encoded
= NULL
;
153 size_t encoded_len
= 0;
154 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
156 http_encoding_deflate_stream_finish(s
, &encoded
, &encoded_len
);
157 phpstr_chunked_output((phpstr
**) &s
->storage
, encoded
, encoded_len
, 0, _http_flush
, NULL TSRMLS_CC
);
158 http_encoding_deflate_stream_free(&s
);
161 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
164 phpstr_chunked_output((phpstr
**) buffer
, NULL
, 0, 0, _http_flush
, NULL TSRMLS_CC
);
170 PHP_MINIT_FUNCTION(http_send
)
172 HTTP_LONG_CONSTANT("HTTP_REDIRECT", HTTP_REDIRECT
);
173 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PERM", HTTP_REDIRECT_PERM
);
174 HTTP_LONG_CONSTANT("HTTP_REDIRECT_FOUND", HTTP_REDIRECT_FOUND
);
175 HTTP_LONG_CONSTANT("HTTP_REDIRECT_POST", HTTP_REDIRECT_POST
);
176 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PROXY", HTTP_REDIRECT_PROXY
);
177 HTTP_LONG_CONSTANT("HTTP_REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
184 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
185 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 size_t header_len
= sizeof(": ") + name_len
+ value_len
+ 1;
189 char *header
= emalloc(header_len
+ 1);
191 header
[header_len
] = '\0';
192 header_len
= snprintf(header
, header_len
, "%s: %s", name
, value
);
193 ret
= http_send_header_string_ex(header
, header_len
, replace
);
195 *sent_header
= header
;
203 /* {{{ STATUS http_send_status_header(int, char *) */
204 PHP_HTTP_API STATUS
_http_send_status_header_ex(int status
, const char *header
, size_t header_len
, zend_bool replace TSRMLS_DC
)
207 sapi_header_line h
= {(char *) header
, header_len
, status
};
208 if (SUCCESS
!= (ret
= sapi_header_op(replace
? SAPI_HEADER_REPLACE
: SAPI_HEADER_ADD
, &h TSRMLS_CC
))) {
209 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Could not send header: %s (%d)", header
, status
);
215 /* {{{ STATUS http_send_last_modified(int) */
216 PHP_HTTP_API STATUS
_http_send_last_modified_ex(time_t t
, char **sent_header TSRMLS_DC
)
219 char *date
= http_date(t
);
225 ret
= http_send_header_ex("Last-Modified", lenof("Last-Modified"), date
, strlen(date
), 1, sent_header
);
229 HTTP_G
->send
.last_modified
= t
;
235 /* {{{ STATUS http_send_etag(char *, size_t) */
236 PHP_HTTP_API STATUS
_http_send_etag_ex(const char *etag
, size_t etag_len
, char **sent_header TSRMLS_DC
)
240 size_t etag_header_len
;
243 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Attempt to send empty ETag (previous: %s)\n", HTTP_G
->send
.unquoted_etag
);
247 etag_header_len
= spprintf(&etag_header
, 0, "ETag: \"%s\"", etag
);
248 status
= http_send_header_string_ex(etag_header
, etag_header_len
, 1);
251 STR_SET(HTTP_G
->send
.unquoted_etag
, estrndup(etag
, etag_len
));
254 *sent_header
= etag_header
;
263 /* {{{ STATUS http_send_content_type(char *, size_t) */
264 PHP_HTTP_API STATUS
_http_send_content_type(const char *content_type
, size_t ct_len TSRMLS_DC
)
266 HTTP_CHECK_CONTENT_TYPE(content_type
, return FAILURE
);
268 /* remember for multiple ranges */
269 STR_FREE(HTTP_G
->send
.content_type
);
270 HTTP_G
->send
.content_type
= estrndup(content_type
, ct_len
);
272 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type
, ct_len
, 1, NULL
);
276 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
277 PHP_HTTP_API STATUS
_http_send_content_disposition(const char *filename
, size_t f_len
, zend_bool send_inline TSRMLS_DC
)
283 cd_header
= ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len
);
284 sprintf(cd_header
, "Content-Disposition: inline; filename=\"%s\"", filename
);
286 cd_header
= ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len
);
287 sprintf(cd_header
, "Content-Disposition: attachment; filename=\"%s\"", filename
);
290 status
= http_send_header_string(cd_header
);
296 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
297 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
)
301 http_range_status range_status
;
310 /* enable partial dl and resume */
311 http_send_header_string("Accept-Ranges: bytes");
313 zend_hash_init(&ranges
, 0, NULL
, ZVAL_PTR_DTOR
, 0);
314 range_status
= http_get_request_ranges(&ranges
, data_size
);
316 switch (range_status
) {
319 zend_hash_destroy(&ranges
);
320 http_send_status(416);
325 /* Range Request - only send ranges if entity hasn't changed */
326 if ( http_got_server_var("HTTP_IF_RANGE") &&
327 !http_match_etag("HTTP_IF_RANGE", HTTP_G
->send
.unquoted_etag
) &&
328 !http_match_last_modified("HTTP_IF_RANGE", HTTP_G
->send
.last_modified
)) {
329 /* fallthrough to send full entity with 200 Ok */
331 } else if ( !http_match_etag_ex("HTTP_IF_MATCH", HTTP_G
->send
.unquoted_etag
, 0) ||
332 !http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G
->send
.last_modified
, 0) ||
333 !http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G
->send
.last_modified
, 0)) {
334 /* 412 Precondition failed */
335 zend_hash_destroy(&ranges
);
336 http_send_status(412);
338 } else if (zend_hash_num_elements(&ranges
) == 1) {
340 zval
**range
, **begin
, **end
;
342 if ( SUCCESS
!= zend_hash_index_find(&ranges
, 0, (void *) &range
) ||
343 SUCCESS
!= zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void *) &begin
) ||
344 SUCCESS
!= zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void *) &end
)) {
345 /* this should never happen */
346 zend_hash_destroy(&ranges
);
347 http_send_status(500);
350 char range_header_str
[256];
351 size_t range_header_len
;
353 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
);
354 http_send_status_header_ex(206, range_header_str
, range_header_len
, 1);
355 http_send_response_start(&s
, Z_LVAL_PP(end
)-Z_LVAL_PP(begin
)+1);
356 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
357 http_send_response_finish(&s
);
358 zend_hash_destroy(&ranges
);
364 zval
**range
, **begin
, **end
;
365 const char *content_type
= HTTP_G
->send
.content_type
;
366 char boundary_str
[32], range_header_str
[256];
367 size_t boundary_len
, range_header_len
;
369 boundary_len
= snprintf(boundary_str
, lenof(boundary_str
), "%lu%0.9f", (ulong
) HTTP_G
->request
.time
, (float) php_combined_lcg(TSRMLS_C
));
370 range_header_len
= snprintf(range_header_str
, lenof(range_header_str
), "Content-Type: multipart/byteranges; boundary=%s", boundary_str
);
372 http_send_status_header_ex(206, range_header_str
, range_header_len
, 1);
373 http_send_response_start(&s
, 0);
376 content_type
= "application/x-octetstream";
379 FOREACH_HASH_VAL(pos
, &ranges
, range
) {
380 if ( SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void *) &begin
) &&
381 SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void *) &end
)) {
382 char preface_str
[512];
385 #define HTTP_RANGE_PREFACE \
387 HTTP_CRLF "Content-Type: %s" \
388 HTTP_CRLF "Content-Range: bytes %ld-%ld/%zu" \
391 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
);
392 http_send_response_data_plain(&s
, preface_str
, preface_len
);
393 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
397 http_send_response_data_plain(&s
, HTTP_CRLF
"--", lenof(HTTP_CRLF
"--"));
398 http_send_response_data_plain(&s
, boundary_str
, boundary_len
);
399 http_send_response_data_plain(&s
, "--", lenof("--"));
401 http_send_response_finish(&s
);
402 zend_hash_destroy(&ranges
);
408 zend_hash_destroy(&ranges
);
410 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
411 if (!no_cache
&& (http_interrupt_ob_etaghandler() || (HTTP_G
->send
.unquoted_etag
!= NULL
))) {
414 if (HTTP_G
->send
.unquoted_etag
) {
415 etag
= estrdup(HTTP_G
->send
.unquoted_etag
);
418 if (etag
|| (etag
= http_etag(data_ptr
, data_size
, data_mode
))) {
419 char *sent_header
= NULL
;
421 http_send_etag_ex(etag
, strlen(etag
), &sent_header
);
422 if (http_match_etag("HTTP_IF_NONE_MATCH", etag
)) {
423 return http_exit_ex(304, sent_header
, NULL
, 0);
425 STR_FREE(sent_header
);
426 /* no caching for Last-Modified if ETags really don't match */
427 no_cache
= http_got_server_var("HTTP_IF_NONE_MATCH");
433 /* send 304 Not Modified if last modified matches */
434 if (!no_cache
&& http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G
->send
.last_modified
)) {
435 char *sent_header
= NULL
;
436 http_send_last_modified_ex(HTTP_G
->send
.last_modified
, &sent_header
);
437 return http_exit_ex(304, sent_header
, NULL
, 0);
440 /* send full response */
441 http_send_response_start(&s
, data_size
);
442 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, 0, data_size
);
443 http_send_response_finish(&s
);
451 /* {{{ STATUS http_send_stream(php_stream *) */
452 PHP_HTTP_API STATUS
_http_send_stream_ex(php_stream
*file
, zend_bool close_stream
, zend_bool no_cache TSRMLS_DC
)
455 php_stream_statbuf ssb
;
457 if ((!file
) || php_stream_stat(file
, &ssb
)) {
458 char *defct
= sapi_get_default_content_type(TSRMLS_C
);
460 http_send_content_type(defct
, strlen(defct
));
461 http_send_header_string("Content-Disposition:");
462 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "File not found; stat failed");
465 if (HTTP_G
->send
.not_found_404
) {
466 http_exit_ex(404, NULL
, estrdup("File not found\n"), 0);
471 status
= http_send_ex(file
, ssb
.sb
.st_size
, SEND_RSRC
, no_cache
);
474 php_stream_close(file
);
481 /* {{{ char *http_guess_content_type(char *magic_file, long magic_mode, void *data, size_t size, http_send_mode mode) */
482 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
)
486 #ifdef HTTP_HAVE_MAGIC
487 struct magic_set
*magic
= NULL
;
489 HTTP_CHECK_OPEN_BASEDIR(magicfile
, return NULL
);
492 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Supplied payload is empty");
493 } else if (!(magic
= magic_open(magicmode
&~ MAGIC_MIME
))) {
494 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid magic mode: %ld", magicmode
);
495 } else if (-1 == magic_load(magic
, magicfile
)) {
496 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to load magic database '%s' (%s)", magicfile
, magic_error(magic
));
498 const char *ctype
= NULL
;
500 magic_setflags(magic
, magicmode
);
508 b_len
= php_stream_copy_to_mem(data_ptr
, &buffer
, 65536, 0);
509 ctype
= magic_buffer(magic
, buffer
, b_len
);
515 ctype
= magic_buffer(magic
, data_ptr
, data_len
);
519 HTTP_CHECK_OPEN_BASEDIR(data_ptr
, magic_close(magic
); return NULL
);
520 ctype
= magic_file(magic
, data_ptr
);
527 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to guess Content-Type: %s", magic_error(magic
));
534 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
546 * vim600: sw=4 ts=4 fdm=marker