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 /* {{{ http_flush() */
31 #define http_flush(d, l) _http_flush(NULL, (d), (l) TSRMLS_CC)
32 static inline void _http_flush(void *nothing
, const char *data
, size_t data_len TSRMLS_DC
)
34 PHPWRITE(data
, data_len
);
35 /* we really only need to flush when throttling is enabled,
36 because we push the data as fast as possible anyway if not */
37 if (HTTP_G
->send
.throttle_delay
>= HTTP_DIFFSEC
) {
38 if (OG(ob_nesting_level
)) {
39 php_end_ob_buffer(1, 1 TSRMLS_CC
);
41 if (!OG(implicit_flush
)) {
44 http_sleep(HTTP_G
->send
.throttle_delay
);
49 /* {{{ http_send_response_start */
50 #define http_send_response_start(b, cl) _http_send_response_start((b), (cl) TSRMLS_CC)
51 static inline void _http_send_response_start(void **buffer
, size_t content_length TSRMLS_DC
)
55 if ((encoding
= http_encoding_response_start(content_length
, 0))) {
57 *((http_encoding_stream
**) buffer
) = http_encoding_deflate_stream_init(NULL
,
58 (encoding
== HTTP_ENCODING_GZIP
) ?
59 HTTP_DEFLATE_TYPE_GZIP
: HTTP_DEFLATE_TYPE_ZLIB
);
67 /* {{{ http_send_response_data_plain */
68 #define http_send_response_data_plain(b, d, dl) _http_send_response_data_plain((b), (d), (dl) TSRMLS_CC)
69 static inline void _http_send_response_data_plain(void **buffer
, const char *data
, size_t data_len TSRMLS_DC
)
71 if (HTTP_G
->send
.deflate
.response
&& HTTP_G
->send
.deflate
.encoding
) {
75 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
77 http_encoding_deflate_stream_update(s
, data
, data_len
, &encoded
, &encoded_len
);
78 if (HTTP_G
->send
.buffer_size
) {
79 phpstr_chunked_output((phpstr
**) &s
->storage
, encoded
, encoded_len
, HTTP_G
->send
.buffer_size
, _http_flush
, NULL TSRMLS_CC
);
81 http_flush(encoded
, encoded_len
);
85 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
87 } else if (HTTP_G
->send
.buffer_size
) {
88 phpstr_chunked_output((phpstr
**) buffer
, data
, data_len
, HTTP_G
->send
.buffer_size
, _http_flush
, NULL TSRMLS_CC
);
90 http_flush(data
, data_len
);
95 /* {{{ http_send_response_data_fetch */
96 #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)
97 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
)
99 long bsz
, got
, len
= end
- begin
;
101 if (!(bsz
= HTTP_G
->send
.buffer_size
)) {
102 bsz
= HTTP_SENDBUF_SIZE
;
107 php_stream
*s
= (php_stream
*) data
;
108 if (SUCCESS
== php_stream_seek(s
, begin
, SEEK_SET
)) {
109 char *buf
= emalloc(bsz
);
112 got
= php_stream_read(s
, buf
, MIN(len
, bsz
));
113 http_send_response_data_plain(buffer
, buf
, got
);
122 const char *buf
= ((const char *) data
) + begin
;
125 http_send_response_data_plain(buffer
, buf
, got
);
131 EMPTY_SWITCH_DEFAULT_CASE();
136 /* {{{ http_send_response_finish */
137 #define http_send_response_finish(b) _http_send_response_finish((b) TSRMLS_CC)
138 static inline void _http_send_response_finish(void **buffer TSRMLS_DC
)
140 if (HTTP_G
->send
.deflate
.response
&& HTTP_G
->send
.deflate
.encoding
) {
141 #ifdef HTTP_HAVE_ZLIB
142 char *encoded
= NULL
;
143 size_t encoded_len
= 0;
144 http_encoding_stream
*s
= *((http_encoding_stream
**) buffer
);
146 http_encoding_deflate_stream_finish(s
, &encoded
, &encoded_len
);
147 if (HTTP_G
->send
.buffer_size
) {
148 phpstr_chunked_output((phpstr
**) &s
->storage
, encoded
, encoded_len
, 0, _http_flush
, NULL TSRMLS_CC
);
150 http_flush(encoded
, encoded_len
);
152 http_encoding_deflate_stream_free(&s
);
155 http_error(HE_ERROR
, HTTP_E_RESPONSE
, "Attempt to send GZIP response despite being able to do so; please report this bug");
157 } else if (HTTP_G
->send
.buffer_size
) {
158 phpstr_chunked_output((phpstr
**) buffer
, NULL
, 0, 0, _http_flush
, NULL TSRMLS_CC
);
164 PHP_MINIT_FUNCTION(http_send
)
166 HTTP_LONG_CONSTANT("HTTP_REDIRECT", HTTP_REDIRECT
);
167 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PERM", HTTP_REDIRECT_PERM
);
168 HTTP_LONG_CONSTANT("HTTP_REDIRECT_FOUND", HTTP_REDIRECT_FOUND
);
169 HTTP_LONG_CONSTANT("HTTP_REDIRECT_POST", HTTP_REDIRECT_POST
);
170 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PROXY", HTTP_REDIRECT_PROXY
);
171 HTTP_LONG_CONSTANT("HTTP_REDIRECT_TEMP", HTTP_REDIRECT_TEMP
);
177 /* {{{ http_find_header */
181 } http_response_header_t
;
183 static int http_find_header(void *data
, void *arg
)
185 http_response_header_t
*h
= arg
;
186 sapi_header_struct
*s
= data
;
188 return (!strncasecmp(s
->header
, h
->h
, h
->l
)) && s
->header
[h
->l
] == ':';
192 /* {{{ void http_hide_header(char *) */
193 PHP_HTTP_API
void _http_hide_header_ex(const char *name
, size_t name_len TSRMLS_DC
)
195 http_response_header_t h
= {name
, name_len
};
196 zend_llist_del_element(&SG(sapi_headers
).headers
, (void *) &h
, http_find_header
);
200 /* {{{ void http_send_header_zval(char*, zval **, zend_bool) */
201 PHP_HTTP_API
void _http_send_header_zval_ex(const char *name
, size_t name_len
, zval
**val
, zend_bool replace TSRMLS_DC
)
203 if (!val
|| !*val
|| Z_TYPE_PP(val
) == IS_NULL
|| (Z_TYPE_PP(val
) == IS_STRING
&& !Z_STRLEN_PP(val
))) {
204 http_hide_header_ex(name
, name_len
);
205 } else if (Z_TYPE_PP(val
) == IS_ARRAY
|| Z_TYPE_PP(val
) == IS_OBJECT
) {
206 zend_bool first
= replace
;
210 FOREACH_HASH_VAL(pos
, HASH_OF(*val
), data
) {
213 convert_to_string_ex(data
);
214 http_send_header_ex(name
, name_len
, Z_STRVAL_PP(data
), Z_STRLEN_PP(data
), first
, NULL
);
223 convert_to_string_ex(val
);
224 http_send_header_ex(name
, name_len
, Z_STRVAL_PP(val
), Z_STRLEN_PP(val
), replace
, NULL
);
232 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
233 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
)
237 if (value
&& value_len
) {
238 size_t header_len
= sizeof(": ") + name_len
+ value_len
+ 1;
239 char *header
= emalloc(header_len
+ 1);
241 header
[header_len
] = '\0';
242 header_len
= snprintf(header
, header_len
, "%s: %s", name
, value
);
243 ret
= http_send_header_string_ex(header
, header_len
, replace
);
245 *sent_header
= header
;
250 http_hide_header_ex(name
, name_len
);
257 /* {{{ STATUS http_send_status_header(int, char *) */
258 PHP_HTTP_API STATUS
_http_send_status_header_ex(int status
, const char *header
, size_t header_len
, zend_bool replace TSRMLS_DC
)
261 sapi_header_line h
= {(char *) header
, header_len
, status
};
262 if (SUCCESS
!= (ret
= sapi_header_op(replace
? SAPI_HEADER_REPLACE
: SAPI_HEADER_ADD
, &h TSRMLS_CC
))) {
263 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Could not send header: %s (%d)", header
, status
);
269 /* {{{ STATUS http_send_last_modified(int) */
270 PHP_HTTP_API STATUS
_http_send_last_modified_ex(time_t t
, char **sent_header TSRMLS_DC
)
273 char *date
= http_date(t
);
279 ret
= http_send_header_ex("Last-Modified", lenof("Last-Modified"), date
, strlen(date
), 1, sent_header
);
283 HTTP_G
->send
.last_modified
= t
;
289 /* {{{ STATUS http_send_etag(char *, size_t) */
290 PHP_HTTP_API STATUS
_http_send_etag_ex(const char *etag
, size_t etag_len
, char **sent_header TSRMLS_DC
)
294 size_t etag_header_len
;
297 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Attempt to send empty ETag (previous: %s)\n", HTTP_G
->send
.unquoted_etag
);
301 etag_header_len
= spprintf(&etag_header
, 0, "ETag: \"%s\"", etag
);
302 status
= http_send_header_string_ex(etag_header
, etag_header_len
, 1);
305 STR_SET(HTTP_G
->send
.unquoted_etag
, estrndup(etag
, etag_len
));
308 *sent_header
= etag_header
;
317 /* {{{ STATUS http_send_content_type(char *, size_t) */
318 PHP_HTTP_API STATUS
_http_send_content_type(const char *content_type
, size_t ct_len TSRMLS_DC
)
320 HTTP_CHECK_CONTENT_TYPE(content_type
, return FAILURE
);
322 /* remember for multiple ranges */
323 STR_FREE(HTTP_G
->send
.content_type
);
324 HTTP_G
->send
.content_type
= estrndup(content_type
, ct_len
);
326 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type
, ct_len
, 1, NULL
);
330 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
331 PHP_HTTP_API STATUS
_http_send_content_disposition(const char *filename
, size_t f_len
, zend_bool send_inline TSRMLS_DC
)
337 cd_header
= ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len
);
338 sprintf(cd_header
, "Content-Disposition: inline; filename=\"%s\"", filename
);
340 cd_header
= ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len
);
341 sprintf(cd_header
, "Content-Disposition: attachment; filename=\"%s\"", filename
);
344 status
= http_send_header_string(cd_header
);
350 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
351 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
)
355 http_range_status range_status
;
364 /* enable partial dl and resume */
365 http_send_header_string("Accept-Ranges: bytes");
367 zend_hash_init(&ranges
, 0, NULL
, ZVAL_PTR_DTOR
, 0);
368 range_status
= http_get_request_ranges(&ranges
, data_size
);
370 switch (range_status
) {
373 zend_hash_destroy(&ranges
);
374 http_send_status(416);
379 /* Range Request - only send ranges if entity hasn't changed */
380 if ( http_got_server_var("HTTP_IF_RANGE") &&
381 !http_match_etag("HTTP_IF_RANGE", HTTP_G
->send
.unquoted_etag
) &&
382 !http_match_last_modified("HTTP_IF_RANGE", HTTP_G
->send
.last_modified
)) {
383 /* fallthrough to send full entity with 200 Ok */
385 } else if ( !http_match_etag_ex("HTTP_IF_MATCH", HTTP_G
->send
.unquoted_etag
, 0) ||
386 !http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G
->send
.last_modified
, 0) ||
387 !http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G
->send
.last_modified
, 0)) {
388 /* 412 Precondition failed */
389 zend_hash_destroy(&ranges
);
390 http_send_status(412);
392 } else if (zend_hash_num_elements(&ranges
) == 1) {
394 zval
**range
, **begin
, **end
;
396 if ( SUCCESS
!= zend_hash_index_find(&ranges
, 0, (void *) &range
) ||
397 SUCCESS
!= zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void *) &begin
) ||
398 SUCCESS
!= zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void *) &end
)) {
399 /* this should never happen */
400 zend_hash_destroy(&ranges
);
401 http_send_status(500);
404 char range_header_str
[256];
405 size_t range_header_len
;
407 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
);
408 http_send_status_header_ex(206, range_header_str
, range_header_len
, 1);
409 http_send_response_start(&s
, Z_LVAL_PP(end
)-Z_LVAL_PP(begin
)+1);
410 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
411 http_send_response_finish(&s
);
412 zend_hash_destroy(&ranges
);
418 zval
**range
, **begin
, **end
;
419 const char *content_type
= HTTP_G
->send
.content_type
;
420 char boundary_str
[32], range_header_str
[256];
421 size_t boundary_len
, range_header_len
;
423 boundary_len
= snprintf(boundary_str
, lenof(boundary_str
), "%lu%0.9f", (ulong
) HTTP_G
->request
.time
, (float) php_combined_lcg(TSRMLS_C
));
424 range_header_len
= snprintf(range_header_str
, lenof(range_header_str
), "Content-Type: multipart/byteranges; boundary=%s", boundary_str
);
426 http_send_status_header_ex(206, range_header_str
, range_header_len
, 1);
427 http_send_response_start(&s
, 0);
430 content_type
= "application/x-octetstream";
433 FOREACH_HASH_VAL(pos
, &ranges
, range
) {
434 if ( SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 0, (void *) &begin
) &&
435 SUCCESS
== zend_hash_index_find(Z_ARRVAL_PP(range
), 1, (void *) &end
)) {
436 char preface_str
[512];
439 #define HTTP_RANGE_PREFACE \
441 HTTP_CRLF "Content-Type: %s" \
442 HTTP_CRLF "Content-Range: bytes %ld-%ld/%zu" \
445 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
);
446 http_send_response_data_plain(&s
, preface_str
, preface_len
);
447 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, Z_LVAL_PP(begin
), Z_LVAL_PP(end
) + 1);
451 http_send_response_data_plain(&s
, HTTP_CRLF
"--", lenof(HTTP_CRLF
"--"));
452 http_send_response_data_plain(&s
, boundary_str
, boundary_len
);
453 http_send_response_data_plain(&s
, "--", lenof("--"));
455 http_send_response_finish(&s
);
456 zend_hash_destroy(&ranges
);
462 zend_hash_destroy(&ranges
);
464 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
465 if (!no_cache
&& (http_interrupt_ob_etaghandler() || (HTTP_G
->send
.unquoted_etag
!= NULL
))) {
468 if (HTTP_G
->send
.unquoted_etag
) {
469 etag
= estrdup(HTTP_G
->send
.unquoted_etag
);
472 if (etag
|| (etag
= http_etag(data_ptr
, data_size
, data_mode
))) {
473 char *sent_header
= NULL
;
475 http_send_etag_ex(etag
, strlen(etag
), &sent_header
);
476 if (http_match_etag("HTTP_IF_NONE_MATCH", etag
)) {
477 return http_exit_ex(304, sent_header
, NULL
, 0);
479 STR_FREE(sent_header
);
480 /* no caching for Last-Modified if ETags really don't match */
481 no_cache
= http_got_server_var("HTTP_IF_NONE_MATCH");
487 /* send 304 Not Modified if last modified matches */
488 if (!no_cache
&& http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G
->send
.last_modified
)) {
489 char *sent_header
= NULL
;
490 http_send_last_modified_ex(HTTP_G
->send
.last_modified
, &sent_header
);
491 return http_exit_ex(304, sent_header
, NULL
, 0);
494 /* send full response */
495 http_send_response_start(&s
, data_size
);
496 http_send_response_data_fetch(&s
, data_ptr
, data_size
, data_mode
, 0, data_size
);
497 http_send_response_finish(&s
);
505 /* {{{ STATUS http_send_stream(php_stream *) */
506 PHP_HTTP_API STATUS
_http_send_stream_ex(php_stream
*file
, zend_bool close_stream
, zend_bool no_cache TSRMLS_DC
)
509 php_stream_statbuf ssb
;
512 if ((!file
) || php_stream_stat(file
, &ssb
)) {
513 char *defct
= sapi_get_default_content_type(TSRMLS_C
);
515 http_hide_header("Content-Disposition");
516 http_send_content_type(defct
, strlen(defct
));
517 http_error(HE_WARNING
, HTTP_E_RESPONSE
, "File not found; stat failed");
520 if (HTTP_G
->send
.not_found_404
) {
521 http_exit_ex(404, NULL
, estrdup("File not found\n"), 0);
526 orig_flags
= file
->flags
;
527 file
->flags
|= PHP_STREAM_FLAG_NO_BUFFER
;
528 status
= http_send_ex(file
, ssb
.sb
.st_size
, SEND_RSRC
, no_cache
);
529 file
->flags
= orig_flags
;
532 php_stream_close(file
);
539 /* {{{ char *http_guess_content_type(char *magic_file, long magic_mode, void *data, size_t size, http_send_mode mode) */
540 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
)
544 #ifdef HTTP_HAVE_MAGIC
545 struct magic_set
*magic
= NULL
;
547 HTTP_CHECK_OPEN_BASEDIR(magicfile
, return NULL
);
550 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Supplied payload is empty");
551 } else if (!(magic
= magic_open(magicmode
&~ MAGIC_MIME
))) {
552 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid magic mode: %ld", magicmode
);
553 } else if (-1 == magic_load(magic
, magicfile
)) {
554 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to load magic database '%s' (%s)", magicfile
, magic_error(magic
));
556 const char *ctype
= NULL
;
558 magic_setflags(magic
, magicmode
);
566 b_len
= php_stream_copy_to_mem(data_ptr
, &buffer
, 65536, 0);
567 ctype
= magic_buffer(magic
, buffer
, b_len
);
573 ctype
= magic_buffer(magic
, data_ptr
, data_len
);
577 HTTP_CHECK_OPEN_BASEDIR(data_ptr
, magic_close(magic
); return NULL
);
578 ctype
= magic_file(magic
, data_ptr
);
585 http_error_ex(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to guess Content-Type: %s", magic_error(magic
));
592 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot guess Content-Type; libmagic not available");
604 * vim600: sw=4 ts=4 fdm=marker