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-2010, 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"
22 #include "php_http_api.h"
23 #include "php_http_cache_api.h"
24 #include "php_http_date_api.h"
25 #include "php_http_encoding_api.h"
26 #include "php_http_headers_api.h"
27 #include "php_http_send_api.h"
29 /* {{{ http_flush() */
30 #define http_flush(d, l) _http_flush(NULL, (d), (l) TSRMLS_CC)
31 static inline void _http_flush(void *nothing
, const char *data
, size_t data_len TSRMLS_DC
)
33 PHPWRITE(data
, data_len
);
34 /* we really only need to flush when throttling is enabled,
35 because we push the data as fast as possible anyway if not */
36 if (HTTP_G
->send
.throttle_delay
>= HTTP_DIFFSEC
) {
37 #if defined(PHP_VERSION_ID) && (PHP_VERSION_ID >= 50399)
38 php_output_end_all(TSRMLS_C
);
40 if (OG(ob_nesting_level
)) {
41 php_end_ob_buffer(1, 1 TSRMLS_CC
);
43 if (!OG(implicit_flush
)) {
47 http_sleep(HTTP_G
->send
.throttle_delay
);
52 /* {{{ http_send_response_start */
53 #define http_send_response_start(b, cl) _http_send_response_start((b), (cl) TSRMLS_CC)
54 static inline void _http_send_response_start(void **buffer
, size_t content_length TSRMLS_DC
)
58 if ((encoding
= http_encoding_response_start(content_length
, 0))) {
60 *((http_encoding_stream
**) buffer
) = http_encoding_deflate_stream_init(NULL
,
61 (encoding
== HTTP_ENCODING_GZIP
) ?
62 HTTP_DEFLATE_TYPE_GZIP
: HTTP_DEFLATE_TYPE_ZLIB
);
70 /* {{{ http_send_response_data_plain */
71 #define http_send_response_data_plain(b, d, dl) _http_send_response_data_plain((b), (d), (dl) TSRMLS_CC)
72 static inline void _http_send_response_data_plain(void **buffer
, const char *data
, size_t data_len TSRMLS_DC
)
74 if (HTTP_G
->send
.deflate
.response
&& HTTP_G
->send
.deflate
.encoding
) {
78 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
80 http_encoding_deflate_stream_update(s
, data
, data_len
, &encoded
, &encoded_len
);
81 if (HTTP_G
->send
.buffer_size
) {
82 phpstr_chunked_output((phpstr
**) &s
->storage
, encoded
, encoded_len
, HTTP_G
->send
.buffer_size
, _http_flush
, NULL TSRMLS_CC
);
84 http_flush(encoded
, encoded_len
);
88 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
90 } else if (HTTP_G
->send
.buffer_size
) {
91 phpstr_chunked_output((phpstr
**) buffer
, data
, data_len
, HTTP_G
->send
.buffer_size
, _http_flush
, NULL TSRMLS_CC
);
93 http_flush(data
, data_len
);
98 /* {{{ http_send_response_data_fetch */
99 #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)
100 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
)
102 long bsz
, got
, len
= end
- begin
;
104 if (!(bsz
= HTTP_G
->send
.buffer_size
)) {
105 bsz
= HTTP_SENDBUF_SIZE
;
110 php_stream
*s
= (php_stream
*) data
;
111 if (SUCCESS
== php_stream_seek(s
, begin
, SEEK_SET
)) {
112 char *buf
= emalloc(bsz
);
115 got
= php_stream_read(s
, buf
, MIN(len
, bsz
));
116 http_send_response_data_plain(buffer
, buf
, got
);
125 const char *buf
= ((const char *) data
) + begin
;
128 http_send_response_data_plain(buffer
, buf
, got
);
134 EMPTY_SWITCH_DEFAULT_CASE();
139 /* {{{ http_send_response_finish */
140 #define http_send_response_finish(b) _http_send_response_finish((b) TSRMLS_CC)
141 static inline void _http_send_response_finish(void **buffer TSRMLS_DC
)
143 if (HTTP_G
->send
.deflate
.response
&& HTTP_G
->send
.deflate
.encoding
) {
144 #ifdef HTTP_HAVE_ZLIB
145 char *encoded
= NULL
;
146 size_t encoded_len
= 0;
147 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
149 http_encoding_deflate_stream_finish(s
, &encoded
, &encoded_len
);
150 if (HTTP_G
->send
.buffer_size
) {
151 phpstr_chunked_output((phpstr
**) &s
->storage
, encoded
, encoded_len
, 0, _http_flush
, NULL TSRMLS_CC
);
153 http_flush(encoded
, encoded_len
);
155 http_encoding_deflate_stream_free(&s
);
158 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
160 } else if (HTTP_G
->send
.buffer_size
) {
161 phpstr_chunked_output((phpstr
**) buffer
, NULL
, 0, 0, _http_flush
, NULL TSRMLS_CC
);
167 PHP_MINIT_FUNCTION(http_send
)
169 HTTP_LONG_CONSTANT("HTTP_REDIRECT", HTTP_REDIRECT
);
170 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PERM", HTTP_REDIRECT_PERM
);
171 HTTP_LONG_CONSTANT("HTTP_REDIRECT_FOUND", HTTP_REDIRECT_FOUND
);
172 HTTP_LONG_CONSTANT("HTTP_REDIRECT_POST", HTTP_REDIRECT_POST
);
173 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PROXY", HTTP_REDIRECT_PROXY
);
174 HTTP_LONG_CONSTANT("HTTP_REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
180 /* {{{ http_find_header */
184 } http_response_header_t
;
186 static int http_find_header(void *data
, void *arg
)
188 http_response_header_t
*h
= arg
;
189 sapi_header_struct
*s
= data
;
191 return (!strncasecmp(s
->header
, h
->h
, h
->l
)) && s
->header
[h
->l
] == ':';
195 /* {{{ void http_hide_header(char *) */
196 PHP_HTTP_API
void _http_hide_header_ex(const char *name
, size_t name_len TSRMLS_DC
)
198 http_response_header_t h
= {name
, name_len
};
199 zend_llist_del_element(&SG(sapi_headers
).headers
, (void *) &h
, http_find_header
);
203 /* {{{ void http_send_header_zval(char*, zval **, zend_bool) */
204 PHP_HTTP_API
void _http_send_header_zval_ex(const char *name
, size_t name_len
, zval
**val
, zend_bool replace TSRMLS_DC
)
206 if (!val
|| !*val
|| Z_TYPE_PP(val
) == IS_NULL
|| (Z_TYPE_PP(val
) == IS_STRING
&& !Z_STRLEN_PP(val
))) {
207 http_hide_header_ex(name
, name_len
);
208 } else if (Z_TYPE_PP(val
) == IS_ARRAY
|| Z_TYPE_PP(val
) == IS_OBJECT
) {
209 zend_bool first
= replace
;
213 FOREACH_HASH_VAL(pos
, HASH_OF(*val
), data_ptr
) {
214 zval
*data
= http_zsep(IS_STRING
, *data_ptr
);
216 http_send_header_ex(name
, name_len
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), first
, NULL
);
217 zval_ptr_dtor(&data
);
221 zval
*data
= http_zsep(IS_STRING
, *val
);
223 http_send_header_ex(name
, name_len
, Z_STRVAL_P(data
), Z_STRLEN_P(data
), replace
, NULL
);
224 zval_ptr_dtor(&data
);
229 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
230 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
)
234 if (value
&& value_len
) {
235 size_t header_len
= sizeof(": ") + name_len
+ value_len
+ 1;
236 char *header
= emalloc(header_len
+ 1);
238 header
[header_len
] = '\0';
239 header_len
= snprintf(header
, header_len
, "%s: %s", name
, value
);
240 ret
= http_send_header_string_ex(header
, header_len
, replace
);
242 *sent_header
= header
;
247 http_hide_header_ex(name
, name_len
);
254 /* {{{ STATUS http_send_status_header(int, char *) */
255 PHP_HTTP_API STATUS
_http_send_status_header_ex(int status
, const char *header
, size_t header_len
, zend_bool replace TSRMLS_DC
)
258 sapi_header_line h
= {(char *) header
, header_len
, status
};
259 if (SUCCESS
!= (ret
= sapi_header_op(replace
? SAPI_HEADER_REPLACE
: SAPI_HEADER_ADD
, &h TSRMLS_CC
))) {
260 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Could not send header: %s (%d)", header
, status
);
266 /* {{{ STATUS http_send_last_modified(int) */
267 PHP_HTTP_API STATUS
_http_send_last_modified_ex(time_t t
, char **sent_header TSRMLS_DC
)
270 char *date
= http_date(t
);
276 ret
= http_send_header_ex("Last-Modified", lenof("Last-Modified"), date
, strlen(date
), 1, sent_header
);
280 HTTP_G
->send
.last_modified
= t
;
286 /* {{{ STATUS http_send_etag(char *, size_t) */
287 PHP_HTTP_API STATUS
_http_send_etag_ex(const char *etag
, size_t etag_len
, char **sent_header TSRMLS_DC
)
291 size_t etag_header_len
;
294 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Attempt to send empty ETag (previous: %s)\n", HTTP_G
->send
.unquoted_etag
);
298 etag_header_len
= spprintf(&etag_header
, 0, "ETag: \"%s\"", etag
);
299 status
= http_send_header_string_ex(etag_header
, etag_header_len
, 1);
302 STR_SET(HTTP_G
->send
.unquoted_etag
, estrndup(etag
, etag_len
));
305 *sent_header
= etag_header
;
314 /* {{{ STATUS http_send_content_type(char *, size_t) */
315 PHP_HTTP_API STATUS
_http_send_content_type(const char *content_type
, size_t ct_len TSRMLS_DC
)
317 HTTP_CHECK_CONTENT_TYPE(content_type
, return FAILURE
);
319 /* remember for multiple ranges */
320 STR_FREE(HTTP_G
->send
.content_type
);
321 HTTP_G
->send
.content_type
= estrndup(content_type
, ct_len
);
323 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type
, ct_len
, 1, NULL
);
327 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
328 PHP_HTTP_API STATUS
_http_send_content_disposition(const char *filename
, size_t f_len
, zend_bool send_inline TSRMLS_DC
)
334 cd_header
= ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len
);
335 sprintf(cd_header
, "Content-Disposition: inline; filename=\"%s\"", filename
);
337 cd_header
= ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len
);
338 sprintf(cd_header
, "Content-Disposition: attachment; filename=\"%s\"", filename
);
341 status
= http_send_header_string(cd_header
);
347 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
348 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
)
352 http_range_status range_status
;
361 /* enable partial dl and resume */
362 http_send_header_string("Accept-Ranges: bytes");
364 zend_hash_init(&ranges
, 0, NULL
, ZVAL_PTR_DTOR
, 0);
365 range_status
= http_get_request_ranges(&ranges
, data_size
);
367 switch (range_status
) {
370 zend_hash_destroy(&ranges
);
371 http_send_status(416);
376 /* Range Request - only send ranges if entity hasn't changed */
377 if ( http_got_server_var("HTTP_IF_RANGE") &&
378 !http_match_etag("HTTP_IF_RANGE", HTTP_G
->send
.unquoted_etag
) &&
379 !http_match_last_modified("HTTP_IF_RANGE", HTTP_G
->send
.last_modified
)) {
380 /* fallthrough to send full entity with 200 Ok */
382 } else if ( !http_match_etag_ex("HTTP_IF_MATCH", HTTP_G
->send
.unquoted_etag
, 0) ||
383 !http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G
->send
.last_modified
, 0) ||
384 !http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G
->send
.last_modified
, 0)) {
385 /* 412 Precondition failed */
386 zend_hash_destroy(&ranges
);
387 http_send_status(412);
389 } else if (zend_hash_num_elements(&ranges
) == 1) {
391 zval
**range
, **begin
, **end
;
393 if ( SUCCESS
!= zend_hash_index_find(&ranges
, 0, (void *) &range
) ||
394 SUCCESS
!= zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void *) &begin
) ||
395 SUCCESS
!= zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void *) &end
)) {
396 /* this should never happen */
397 zend_hash_destroy(&ranges
);
398 http_send_status(500);
403 phpstr_init(&header
);
404 phpstr_appendf(&header
, "Content-Range: bytes %ld-%ld/%zu", Z_LVAL_PP(begin
), Z_LVAL_PP(end
), data_size
);
406 http_send_status_header_ex(206, PHPSTR_VAL(&header
), PHPSTR_LEN(&header
), 1);
407 phpstr_dtor(&header
);
408 http_send_response_start(&s
, Z_LVAL_PP(end
)-Z_LVAL_PP(begin
)+1);
409 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
410 http_send_response_finish(&s
);
411 zend_hash_destroy(&ranges
);
417 zval
**range
, **begin
, **end
;
418 const char *content_type
= HTTP_G
->send
.content_type
;
419 char boundary_str
[32];
421 phpstr header
, preface
;
423 boundary_len
= http_boundary(boundary_str
, sizeof(boundary_str
));
424 phpstr_init(&header
);
425 phpstr_appendf(&header
, "Content-Type: multipart/byteranges; boundary=%s", boundary_str
);
427 http_send_status_header_ex(206, PHPSTR_VAL(&header
), PHPSTR_LEN(&header
), 1);
428 phpstr_dtor(&header
);
429 http_send_response_start(&s
, 0);
432 content_type
= "application/x-octetstream";
435 phpstr_init(&preface
);
436 FOREACH_HASH_VAL(pos
, &ranges
, range
) {
437 if ( SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void *) &begin
) &&
438 SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void *) &end
)) {
440 #define HTTP_RANGE_PREFACE \
442 HTTP_CRLF "Content-Type: %s" \
443 HTTP_CRLF "Content-Range: bytes %ld-%ld/%zu" \
446 phpstr_appendf(&preface
, HTTP_RANGE_PREFACE
, boundary_str
, content_type
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
), data_size
);
447 phpstr_fix(&preface
);
448 http_send_response_data_plain(&s
, PHPSTR_VAL(&preface
), PHPSTR_LEN(&preface
));
449 phpstr_reset(&preface
);
450 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
453 phpstr_dtor(&preface
);
455 http_send_response_data_plain(&s
, HTTP_CRLF
"--", lenof(HTTP_CRLF
"--"));
456 http_send_response_data_plain(&s
, boundary_str
, boundary_len
);
457 http_send_response_data_plain(&s
, "--", lenof("--"));
459 http_send_response_finish(&s
);
460 zend_hash_destroy(&ranges
);
466 zend_hash_destroy(&ranges
);
468 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
469 if (!no_cache
&& (http_interrupt_ob_etaghandler() || (HTTP_G
->send
.unquoted_etag
!= NULL
))) {
472 if (HTTP_G
->send
.unquoted_etag
) {
473 etag
= estrdup(HTTP_G
->send
.unquoted_etag
);
476 if (etag
|| (etag
= http_etag(data_ptr
, data_size
, data_mode
))) {
477 char *sent_header
= NULL
;
479 http_send_etag_ex(etag
, strlen(etag
), &sent_header
);
480 if (http_match_etag("HTTP_IF_NONE_MATCH", etag
)) {
481 return http_exit_ex(304, sent_header
, NULL
, 0);
483 STR_FREE(sent_header
);
484 /* no caching for Last-Modified if ETags really don't match */
485 no_cache
= http_got_server_var("HTTP_IF_NONE_MATCH");
491 /* send 304 Not Modified if last modified matches */
492 if (!no_cache
&& HTTP_G
->send
.last_modified
&& http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G
->send
.last_modified
)) {
493 char *sent_header
= NULL
;
494 http_send_last_modified_ex(HTTP_G
->send
.last_modified
, &sent_header
);
495 return http_exit_ex(304, sent_header
, NULL
, 0);
498 /* send full response */
499 http_send_response_start(&s
, data_size
);
500 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, 0, data_size
);
501 http_send_response_finish(&s
);
509 /* {{{ STATUS http_send_stream(php_stream *) */
510 PHP_HTTP_API STATUS
_http_send_stream_ex(php_stream
*file
, zend_bool close_stream
, zend_bool no_cache TSRMLS_DC
)
513 php_stream_statbuf ssb
;
516 if ((!file
) || php_stream_stat(file
, &ssb
)) {
517 char *defct
= sapi_get_default_content_type(TSRMLS_C
);
519 http_hide_header("Content-Disposition");
520 http_send_content_type(defct
, strlen(defct
));
521 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "File not found; stat failed");
524 if (HTTP_G
->send
.not_found_404
) {
525 http_exit_ex(404, NULL
, estrdup("File not found\n"), 0);
530 orig_flags
= file
->flags
;
531 file
->flags
|= PHP_STREAM_FLAG_NO_BUFFER
;
532 status
= http_send_ex(file
, ssb
.sb
.st_size
, SEND_RSRC
, no_cache
);
533 file
->flags
= orig_flags
;
536 php_stream_close(file
);
543 /* {{{ char *http_guess_content_type(char *magic_file, long magic_mode, void *data, size_t size, http_send_mode mode) */
544 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
)
548 #ifdef HTTP_HAVE_MAGIC
549 struct magic_set
*magic
= NULL
;
551 HTTP_CHECK_OPEN_BASEDIR(magicfile
, return NULL
);
554 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Supplied payload is empty");
555 } else if (!(magic
= magic_open(magicmode
&~ MAGIC_MIME
))) {
556 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid magic mode: %ld", magicmode
);
557 } else if (-1 == magic_load(magic
, magicfile
)) {
558 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to load magic database '%s' (%s)", magicfile
, magic_error(magic
));
560 const char *ctype
= NULL
;
562 magic_setflags(magic
, magicmode
);
570 b_len
= php_stream_copy_to_mem(data_ptr
, &buffer
, 65536, 0);
571 ctype
= magic_buffer(magic
, buffer
, b_len
);
577 ctype
= magic_buffer(magic
, data_ptr
, data_len
);
581 HTTP_CHECK_OPEN_BASEDIR(data_ptr
, magic_close(magic
); return NULL
);
582 ctype
= magic_file(magic
, data_ptr
);
589 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to guess Content-Type: %s", magic_error(magic
));
596 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
608 * vim600: sw=4 ts=4 fdm=marker