- get rid of 1001 strict-aliasing warnings
[m6w6/ext-http] / http_send_api.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
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 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #define HTTP_WANT_SAPI
16 #define HTTP_WANT_ZLIB
17 #define HTTP_WANT_MAGIC
18 #include "php_http.h"
19
20 #include "php_streams.h"
21 #include "ext/standard/php_lcg.h"
22
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"
29
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)
33 {
34 PHPWRITE(data, data_len);
35 php_end_ob_buffer(1, 1 TSRMLS_CC);
36 sapi_flush(TSRMLS_C);
37
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)
43
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;
51
52 req.tv_sec = (time_t) HTTP_G->send.throttle_delay;
53 req.tv_nsec = HTTP_NSEC(HTTP_G->send.throttle_delay) % HTTP_NANOSEC;
54
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;
58 }
59 #endif
60 }
61 }
62 /* }}} */
63
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)
67 {
68 int encoding;
69
70 if ((encoding = http_encoding_response_start(content_length))) {
71 #ifdef HTTP_HAVE_ZLIB
72 *buffer = http_encoding_deflate_stream_init(NULL,
73 (encoding == HTTP_ENCODING_GZIP) ?
74 HTTP_DEFLATE_TYPE_GZIP : HTTP_DEFLATE_TYPE_ZLIB);
75 #endif
76 }
77 }
78 /* }}} */
79
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)
83 {
84 if (HTTP_G->send.deflate.encoding) {
85 #ifdef HTTP_HAVE_ZLIB
86 char *encoded;
87 size_t encoded_len;
88 http_encoding_stream *s = *((http_encoding_stream **) buffer);
89
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);
92 efree(encoded);
93 #else
94 http_error(HE_ERROR, HTTP_E_RESPONSE, "Attempt to send GZIP response despite being able to do so; please report this bug");
95 #endif
96 } else {
97 phpstr_chunked_output((phpstr **) buffer, data, data_len, HTTP_G->send.buffer_size, _http_flush, NULL TSRMLS_CC);
98 }
99 }
100 /* }}} */
101
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)
105 {
106 char *buf;
107 long got, len = end - begin;
108
109 switch (mode)
110 {
111 case SEND_RSRC:
112 {
113 php_stream *s = (php_stream *) data;
114
115 if (SUCCESS == php_stream_seek(s, begin, SEEK_SET)) {
116 buf = emalloc(HTTP_SENDBUF_SIZE);
117
118 while (len > 0) {
119 got = php_stream_read(s, buf, MIN(len, HTTP_SENDBUF_SIZE));
120 http_send_response_data_plain(buffer, buf, got);
121 len -= got;
122 }
123
124 efree(buf);
125 }
126 }
127 break;
128
129 case SEND_DATA:
130 {
131 buf = (char *) data + begin;
132
133 while (len > 0) {
134 got = MIN(len, HTTP_SENDBUF_SIZE);
135 http_send_response_data_plain(buffer, buf, got);
136 len -= got;
137 buf += got;
138 }
139 }
140 break;
141
142 EMPTY_SWITCH_DEFAULT_CASE();
143 }
144 }
145 /* }}} */
146
147 /* {{{ http_send_response_finish */
148 #define http_send_response_finish(b) _http_send_response_finish((b) TSRMLS_CC)
149 static inline void _http_send_response_finish(void **buffer TSRMLS_DC)
150 {
151 if (HTTP_G->send.deflate.encoding) {
152 #ifdef HTTP_HAVE_ZLIB
153 char *encoded = NULL;
154 size_t encoded_len = 0;
155 http_encoding_stream *s = *((http_encoding_stream **) buffer);
156
157 http_encoding_deflate_stream_finish(s, &encoded, &encoded_len);
158 phpstr_chunked_output((phpstr **) &s->storage, encoded, encoded_len, 0, _http_flush, NULL TSRMLS_CC);
159 http_encoding_deflate_stream_free(&s);
160 STR_FREE(encoded);
161 #else
162 http_error(HE_ERROR, HTTP_E_RESPONSE, "Attempt to send GZIP response despite being able to do so; please report this bug");
163 #endif
164 } else {
165 phpstr_chunked_output((phpstr **) buffer, NULL, 0, 0, _http_flush, NULL TSRMLS_CC);
166 }
167 }
168 /* }}} */
169
170 /* {{{ */
171 PHP_MINIT_FUNCTION(http_send)
172 {
173 HTTP_LONG_CONSTANT("HTTP_REDIRECT", HTTP_REDIRECT);
174 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PERM", HTTP_REDIRECT_PERM);
175 HTTP_LONG_CONSTANT("HTTP_REDIRECT_FOUND", HTTP_REDIRECT_FOUND);
176 HTTP_LONG_CONSTANT("HTTP_REDIRECT_POST", HTTP_REDIRECT_POST);
177 HTTP_LONG_CONSTANT("HTTP_REDIRECT_PROXY", HTTP_REDIRECT_PROXY);
178 HTTP_LONG_CONSTANT("HTTP_REDIRECT_TEMP", HTTP_REDIRECT_TEMP);
179
180 return SUCCESS;
181 }
182 /* }}} */
183
184
185 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
186 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)
187 {
188 STATUS ret;
189 size_t header_len = sizeof(": ") + name_len + value_len + 1;
190 char *header = emalloc(header_len + 1);
191
192 header[header_len] = '\0';
193 header_len = snprintf(header, header_len, "%s: %s", name, value);
194 ret = http_send_header_string_ex(header, header_len, replace);
195 if (sent_header) {
196 *sent_header = header;
197 } else {
198 efree(header);
199 }
200 return ret;
201 }
202 /* }}} */
203
204 /* {{{ STATUS http_send_status_header(int, char *) */
205 PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, size_t header_len, zend_bool replace TSRMLS_DC)
206 {
207 STATUS ret;
208 sapi_header_line h = {(char *) header, header_len, status};
209 if (SUCCESS != (ret = sapi_header_op(replace ? SAPI_HEADER_REPLACE : SAPI_HEADER_ADD, &h TSRMLS_CC))) {
210 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Could not send header: %s (%d)", header, status);
211 }
212 return ret;
213 }
214 /* }}} */
215
216 /* {{{ STATUS http_send_last_modified(int) */
217 PHP_HTTP_API STATUS _http_send_last_modified_ex(time_t t, char **sent_header TSRMLS_DC)
218 {
219 STATUS ret;
220 char *date = http_date(t);
221
222 if (!date) {
223 return FAILURE;
224 }
225
226 ret = http_send_header_ex("Last-Modified", lenof("Last-Modified"), date, strlen(date), 1, sent_header);
227 efree(date);
228
229 /* remember */
230 HTTP_G->send.last_modified = t;
231
232 return ret;
233 }
234 /* }}} */
235
236 /* {{{ STATUS http_send_etag(char *, size_t) */
237 PHP_HTTP_API STATUS _http_send_etag_ex(const char *etag, size_t etag_len, char **sent_header TSRMLS_DC)
238 {
239 STATUS status;
240 char *etag_header;
241 size_t etag_header_len;
242
243 if (!etag_len){
244 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Attempt to send empty ETag (previous: %s)\n", HTTP_G->send.unquoted_etag);
245 return FAILURE;
246 }
247
248 etag_header_len = spprintf(&etag_header, 0, "ETag: \"%s\"", etag);
249 status = http_send_header_string_ex(etag_header, etag_header_len, 1);
250
251 /* remember */
252 STR_SET(HTTP_G->send.unquoted_etag, estrndup(etag, etag_len));
253
254 if (sent_header) {
255 *sent_header = etag_header;
256 } else {
257 efree(etag_header);
258 }
259
260 return status;
261 }
262 /* }}} */
263
264 /* {{{ STATUS http_send_content_type(char *, size_t) */
265 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, size_t ct_len TSRMLS_DC)
266 {
267 HTTP_CHECK_CONTENT_TYPE(content_type, return FAILURE);
268
269 /* remember for multiple ranges */
270 STR_FREE(HTTP_G->send.content_type);
271 HTTP_G->send.content_type = estrndup(content_type, ct_len);
272
273 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type, ct_len, 1, NULL);
274 }
275 /* }}} */
276
277 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
278 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, size_t f_len, zend_bool send_inline TSRMLS_DC)
279 {
280 STATUS status;
281 char *cd_header;
282
283 if (send_inline) {
284 cd_header = ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len);
285 sprintf(cd_header, "Content-Disposition: inline; filename=\"%s\"", filename);
286 } else {
287 cd_header = ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len);
288 sprintf(cd_header, "Content-Disposition: attachment; filename=\"%s\"", filename);
289 }
290
291 status = http_send_header_string(cd_header);
292 efree(cd_header);
293 return status;
294 }
295 /* }}} */
296
297 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
298 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)
299 {
300 void *s = NULL;
301 HashTable ranges;
302 http_range_status range_status;
303
304 if (!data_ptr) {
305 return FAILURE;
306 }
307 if (!data_size) {
308 return SUCCESS;
309 }
310
311 /* enable partial dl and resume */
312 http_send_header_string("Accept-Ranges: bytes");
313
314 zend_hash_init(&ranges, 0, NULL, ZVAL_PTR_DTOR, 0);
315 range_status = http_get_request_ranges(&ranges, data_size);
316
317 switch (range_status)
318 {
319 case RANGE_ERR:
320 {
321 zend_hash_destroy(&ranges);
322 http_send_status(416);
323 return FAILURE;
324 }
325 case RANGE_OK:
326 {
327 /* Range Request - only send ranges if entity hasn't changed */
328 if ( http_got_server_var("HTTP_IF_RANGE") &&
329 !http_match_etag("HTTP_IF_RANGE", HTTP_G->send.unquoted_etag) &&
330 !http_match_last_modified("HTTP_IF_RANGE", HTTP_G->send.last_modified)) {
331 /* fallthrough to send full entity with 200 Ok */
332 no_cache = 1;
333 } else if ( !http_match_etag_ex("HTTP_IF_MATCH", HTTP_G->send.unquoted_etag, 0) ||
334 !http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G->send.last_modified, 0) ||
335 !http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G->send.last_modified, 0)) {
336 /* 412 Precondition failed */
337 zend_hash_destroy(&ranges);
338 http_send_status(412);
339 return FAILURE;
340 } else if (zend_hash_num_elements(&ranges) == 1) {
341 /* single range */
342 zval **range, **begin, **end;
343
344 if ( SUCCESS != zend_hash_index_find(&ranges, 0, (void *) &range) ||
345 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin) ||
346 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)) {
347 /* this should never happen */
348 zend_hash_destroy(&ranges);
349 http_send_status(500);
350 return FAILURE;
351 } else {
352 char range_header_str[256];
353 size_t range_header_len;
354
355 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);
356 http_send_status_header_ex(206, range_header_str, range_header_len, 1);
357 http_send_response_start(&s, Z_LVAL_PP(end)-Z_LVAL_PP(begin)+1);
358 http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, Z_LVAL_PP(begin), Z_LVAL_PP(end) + 1);
359 http_send_response_finish(&s);
360 zend_hash_destroy(&ranges);
361 return SUCCESS;
362 }
363 } else {
364 /* multi range */
365 HashPosition pos;
366 zval **range, **begin, **end;
367 const char *content_type = HTTP_G->send.content_type;
368 char boundary_str[32], range_header_str[256];
369 size_t boundary_len, range_header_len;
370
371 boundary_len = snprintf(boundary_str, lenof(boundary_str), "%lu%0.9f", (ulong) HTTP_GET_REQUEST_TIME(), (float) php_combined_lcg(TSRMLS_C));
372 range_header_len = snprintf(range_header_str, lenof(range_header_str), "Content-Type: multipart/byteranges; boundary=%s", boundary_str);
373
374 http_send_status_header_ex(206, range_header_str, range_header_len, 1);
375 http_send_response_start(&s, 0);
376
377 if (!content_type) {
378 content_type = "application/x-octetstream";
379 }
380
381 FOREACH_HASH_VAL(pos, &ranges, range) {
382 if ( SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin) &&
383 SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)) {
384 char preface_str[512];
385 size_t preface_len;
386
387 #define HTTP_RANGE_PREFACE \
388 HTTP_CRLF "--%s" \
389 HTTP_CRLF "Content-Type: %s" \
390 HTTP_CRLF "Content-Range: bytes %ld-%ld/%zu" \
391 HTTP_CRLF HTTP_CRLF
392
393 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);
394 http_send_response_data_plain(&s, preface_str, preface_len);
395 http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, Z_LVAL_PP(begin), Z_LVAL_PP(end) + 1);
396 }
397 }
398
399 http_send_response_data_plain(&s, HTTP_CRLF "--", lenof(HTTP_CRLF "--"));
400 http_send_response_data_plain(&s, boundary_str, boundary_len);
401 http_send_response_data_plain(&s, "--", lenof("--"));
402
403 http_send_response_finish(&s);
404 zend_hash_destroy(&ranges);
405 return SUCCESS;
406 }
407 }
408 case RANGE_NO:
409 {
410 zend_hash_destroy(&ranges);
411
412 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
413 if (!no_cache && (http_interrupt_ob_etaghandler() || (HTTP_G->send.unquoted_etag != NULL))) {
414 char *etag = NULL;
415
416 if (HTTP_G->send.unquoted_etag) {
417 etag = estrdup(HTTP_G->send.unquoted_etag);
418 }
419
420 if (etag || (etag = http_etag(data_ptr, data_size, data_mode))) {
421 char *sent_header = NULL;
422
423 http_send_etag_ex(etag, strlen(etag), &sent_header);
424 if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
425 return http_exit_ex(304, sent_header, NULL, 0);
426 } else {
427 STR_FREE(sent_header);
428 /* no caching for Last-Modified if ETags really don't match */
429 no_cache = http_got_server_var("HTTP_IF_NONE_MATCH");
430 }
431 efree(etag);
432 }
433 }
434
435 /* send 304 Not Modified if last modified matches */
436 if (!no_cache && http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G->send.last_modified)) {
437 char *sent_header = NULL;
438 http_send_last_modified_ex(HTTP_G->send.last_modified, &sent_header);
439 return http_exit_ex(304, sent_header, NULL, 0);
440 }
441
442 /* send full response */
443 http_send_response_start(&s, data_size);
444 http_send_response_data_fetch(&s, data_ptr, data_size, data_mode, 0, data_size);
445 http_send_response_finish(&s);
446 return SUCCESS;
447 }
448 }
449 return FAILURE;
450 }
451 /* }}} */
452
453 /* {{{ STATUS http_send_stream(php_stream *) */
454 PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_stream, zend_bool no_cache TSRMLS_DC)
455 {
456 STATUS status;
457 php_stream_statbuf ssb;
458
459 if ((!file) || php_stream_stat(file, &ssb)) {
460 return FAILURE;
461 }
462
463 status = http_send_ex(file, ssb.sb.st_size, SEND_RSRC, no_cache);
464
465 if (close_stream) {
466 php_stream_close(file);
467 }
468
469 return status;
470 }
471 /* }}} */
472
473 /* {{{ char *http_guess_content_type(char *magic_file, long magic_mode, void *data, size_t size, http_send_mode mode) */
474 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)
475 {
476 char *ct = NULL;
477
478 #ifdef HTTP_HAVE_MAGIC
479 struct magic_set *magic;
480
481 HTTP_CHECK_OPEN_BASEDIR(magicfile, return NULL);
482
483 /* magic_load() fails if MAGIC_MIME is set because it
484 cowardly adds .mime to the file name */
485 magic = magic_open(magicmode &~ MAGIC_MIME);
486
487 if (!magic) {
488 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Invalid magic mode: %ld", magicmode);
489 } else if (-1 == magic_load(magic, magicfile)) {
490 http_error_ex(HE_WARNING, HTTP_E_RUNTIME, "Failed to load magic database '%s' (%s)", magicfile, magic_error(magic));
491 } else {
492 const char *ctype = NULL;
493
494 magic_setflags(magic, magicmode);
495
496 switch (data_mode)
497 {
498 case SEND_RSRC:
499 {
500 char *buffer;
501 size_t b_len;
502
503 b_len = php_stream_copy_to_mem(data_ptr, &buffer, 65536, 0);
504 ctype = magic_buffer(magic, buffer, b_len);
505 efree(buffer);
506 }
507 break;
508
509 case SEND_DATA:
510 ctype = magic_buffer(magic, data_ptr, data_len);
511 break;
512
513 default:
514 HTTP_CHECK_OPEN_BASEDIR(data_ptr, magic_close(magic); return NULL);
515 ctype = magic_file(magic, data_ptr);
516 break;
517 }
518
519 if (ctype) {
520 ct = estrdup(ctype);
521 } else {
522 http_error_ex(HE_WARNING, HTTP_E_RUNTIME, "Failed to guess Content-Type: %s", magic_error(magic));
523 }
524 }
525 if (magic) {
526 magic_close(magic);
527 }
528 #else
529 http_error(HE_WARNING, HTTP_E_RUNTIME, "Cannot guess Content-Type; libmagic not available");
530 #endif
531
532 return ct;
533 }
534 /* }}} */
535
536 /*
537 * Local variables:
538 * tab-width: 4
539 * c-basic-offset: 4
540 * End:
541 * vim600: sw=4 ts=4 fdm=marker
542 * vim<600: sw=4 ts=4
543 */
544