- some minor strlen() and strlcat() tweaks
[m6w6/ext-http] / http_send_api.c
1 /*
2 +----------------------------------------------------------------------+
3 | PECL :: http |
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
14 */
15
16 /* $Id$ */
17
18 #ifdef HAVE_CONFIG_H
19 # include "config.h"
20 #endif
21 #include "php.h"
22
23 #include "SAPI.h"
24 #include "php_streams.h"
25 #include "ext/standard/php_lcg.h"
26
27 #include "php_http.h"
28 #include "php_http_std_defs.h"
29 #include "php_http_api.h"
30 #include "php_http_date_api.h"
31 #include "php_http_send_api.h"
32 #include "php_http_headers_api.h"
33 #include "php_http_date_api.h"
34 #include "php_http_cache_api.h"
35
36 ZEND_EXTERN_MODULE_GLOBALS(http);
37
38 #define http_flush() _http_flush(TSRMLS_C)
39 /* {{{ static inline void http_flush() */
40 static inline void _http_flush(TSRMLS_D)
41 {
42 php_end_ob_buffer(1, 1 TSRMLS_CC);
43 sapi_flush(TSRMLS_C);
44 }
45 /* }}} */
46
47 #define http_sleep() _http_sleep(TSRMLS_C)
48 /* {{{ static inline void http_sleep() */
49 static inline void _http_sleep(TSRMLS_D)
50 {
51 #define HTTP_MSEC(s) (s * 1000)
52 #define HTTP_USEC(s) (HTTP_MSEC(s) * 1000)
53 #define HTTP_NSEC(s) (HTTP_USEC(s) * 1000)
54 #define HTTP_NANOSEC (1000 * 1000 * 1000)
55 #define HTTP_DIFFSEC (0.001)
56
57 if (HTTP_G(send).throttle_delay >= HTTP_DIFFSEC) {
58 #if defined(PHP_WIN32)
59 Sleep((DWORD) HTTP_MSEC(HTTP_G(send).throttle_delay));
60 #elif defined(HAVE_USLEEP)
61 usleep(HTTP_USEC(HTTP_G(send).throttle_delay));
62 #elif defined(HAVE_NANOSLEEP)
63 struct timespec req, rem;
64
65 req.tv_sec = (time_t) HTTP_G(send).throttle_delay;
66 req.tv_nsec = HTTP_NSEC(HTTP_G(send).throttle_delay) % HTTP_NANOSEC;
67
68 while (nanosleep(&req, &rem) && (errno == EINTR) && (HTTP_NSEC(rem.tv_sec) + rem.tv_nsec) > HTTP_NSEC(HTTP_DIFFSEC))) {
69 req.tv_sec = rem.tv_sec;
70 req.tv_nsec = rem.tv_nsec;
71 }
72 #endif
73 }
74 }
75 /* }}} */
76
77 #define HTTP_CHUNK_AVAIL(len) ((len -= HTTP_G(send).buffer_size) >= 0)
78 #define HTTP_CHUNK_WRITE(data, l, dofree, dosleep) \
79 { \
80 long size = (long) l; \
81 \
82 if ((1 > size) || (size - PHPWRITE(data, size))) { \
83 if (dofree) { \
84 efree(data); \
85 } \
86 return FAILURE; \
87 } \
88 \
89 http_flush(); \
90 if (dosleep) { \
91 http_sleep(); \
92 } \
93 }
94
95 #define http_send_chunk(d, b, e, m) _http_send_chunk((d), (b), (e), (m) TSRMLS_CC)
96 /* {{{ static STATUS http_send_chunk(const void *, size_t, size_t, http_send_mode) */
97 static STATUS _http_send_chunk(const void *data, size_t begin, size_t end, http_send_mode mode TSRMLS_DC)
98 {
99 long len = end - begin;
100
101 switch (mode)
102 {
103 case SEND_RSRC:
104 {
105 char *buf;
106 php_stream *s = (php_stream *) data;
107
108 if (php_stream_seek(s, begin, SEEK_SET)) {
109 return FAILURE;
110 }
111
112 buf = emalloc(HTTP_G(send).buffer_size);
113
114 while (HTTP_CHUNK_AVAIL(len)) {
115 HTTP_CHUNK_WRITE(buf, php_stream_read(s, buf, HTTP_G(send).buffer_size), 1, 1);
116 }
117
118 /* read & write left over */
119 if (len) {
120 HTTP_CHUNK_WRITE(buf, php_stream_read(s, buf, HTTP_G(send).buffer_size + len), 1, 0);
121 }
122
123 efree(buf);
124 return SUCCESS;
125 }
126
127 case SEND_DATA:
128 {
129 char *s = (char *) data + begin;
130
131 while (HTTP_CHUNK_AVAIL(len)) {
132 HTTP_CHUNK_WRITE(s, HTTP_G(send).buffer_size, 0, 1);
133 s += HTTP_G(send).buffer_size;
134 }
135
136 /* write left over */
137 if (len) {
138 HTTP_CHUNK_WRITE(s, HTTP_G(send).buffer_size + len, 0, 0);
139 }
140
141 return SUCCESS;
142 }
143
144 default:
145 return FAILURE;
146 break;
147 }
148 }
149 /* }}} */
150
151 /* {{{ STATUS http_send_header(char *, char *, zend_bool) */
152 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)
153 {
154 STATUS ret;
155 size_t header_len = sizeof(": ") + name_len + value_len + 1;
156 char *header = emalloc(header_len + 1);
157
158 header[header_len] = '\0';
159 header_len = snprintf(header, header_len, "%s: %s", name, value);
160 ret = http_send_header_string_ex(header, header_len, replace);
161 if (sent_header) {
162 *sent_header = header;
163 } else {
164 efree(header);
165 }
166 return ret;
167 }
168 /* }}} */
169
170 /* {{{ STATUS http_send_status_header(int, char *) */
171 PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, size_t header_len, zend_bool replace TSRMLS_DC)
172 {
173 STATUS ret;
174 sapi_header_line h = {(char *) header, header_len, status};
175 if (SUCCESS != (ret = sapi_header_op(replace ? SAPI_HEADER_REPLACE : SAPI_HEADER_ADD, &h TSRMLS_CC))) {
176 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Could not send header: %s (%d)", header, status);
177 }
178 return ret;
179 }
180 /* }}} */
181
182 /* {{{ STATUS http_send_last_modified(int) */
183 PHP_HTTP_API STATUS _http_send_last_modified_ex(time_t t, char **sent_header TSRMLS_DC)
184 {
185 STATUS ret;
186 char *date = http_date(t);
187
188 if (!date) {
189 return FAILURE;
190 }
191
192 ret = http_send_header_ex("Last-Modified", lenof("Last-Modified"), date, strlen(date), 1, sent_header);
193 efree(date);
194
195 /* remember */
196 HTTP_G(send).last_modified = t;
197
198 return ret;
199 }
200 /* }}} */
201
202 /* {{{ STATUS http_send_etag(char *, size_t) */
203 PHP_HTTP_API STATUS _http_send_etag_ex(const char *etag, size_t etag_len, char **sent_header TSRMLS_DC)
204 {
205 STATUS status;
206 char *etag_header;
207
208 if (!etag_len){
209 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Attempt to send empty ETag (previous: %s)\n", HTTP_G(send).unquoted_etag);
210 return FAILURE;
211 }
212
213 /* remember */
214 STR_SET(HTTP_G(send).unquoted_etag, estrndup(etag, etag_len));
215
216 etag_len = spprintf(&etag_header, 0, "ETag: \"%s\"", etag);
217 status = http_send_header_string_ex(etag_header, etag_len, 1);
218
219 if (sent_header) {
220 *sent_header = etag_header;
221 } else {
222 efree(etag_header);
223 }
224
225 return status;
226 }
227 /* }}} */
228
229 /* {{{ STATUS http_send_content_type(char *, size_t) */
230 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, size_t ct_len TSRMLS_DC)
231 {
232 HTTP_CHECK_CONTENT_TYPE(content_type, return FAILURE);
233
234 /* remember for multiple ranges */
235 STR_FREE(HTTP_G(send).content_type);
236 HTTP_G(send).content_type = estrndup(content_type, ct_len);
237
238 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type, ct_len, 1, NULL);
239 }
240 /* }}} */
241
242 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
243 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, size_t f_len, zend_bool send_inline TSRMLS_DC)
244 {
245 STATUS status;
246 char *cd_header;
247
248 if (send_inline) {
249 cd_header = ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len);
250 sprintf(cd_header, "Content-Disposition: inline; filename=\"%s\"", filename);
251 } else {
252 cd_header = ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len);
253 sprintf(cd_header, "Content-Disposition: attachment; filename=\"%s\"", filename);
254 }
255
256 status = http_send_header_string(cd_header);
257 efree(cd_header);
258 return status;
259 }
260 /* }}} */
261
262 /* {{{ STATUS http_send_ranges(HashTable *, void *, size_t, http_send_mode) */
263 PHP_HTTP_API STATUS _http_send_ranges(HashTable *ranges, const void *data, size_t size, http_send_mode mode TSRMLS_DC)
264 {
265 zval **zbegin, **zend, **zrange;
266
267 /* single range */
268 if (zend_hash_num_elements(ranges) == 1) {
269 char range_header[256] = {0};
270
271 if (SUCCESS != zend_hash_index_find(ranges, 0, (void **) &zrange) ||
272 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &zbegin) ||
273 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &zend)) {
274 http_send_status(500);
275 return FAILURE;
276 }
277
278 /* Send HTTP 206 Partial Content */
279 http_send_status(206);
280
281 /* send content range header */
282 snprintf(range_header, 255, "Content-Range: bytes %ld-%ld/%lu", Z_LVAL_PP(zbegin), Z_LVAL_PP(zend), (ulong) size);
283 http_send_header_string(range_header);
284
285 /* send requested chunk */
286 return http_send_chunk(data, Z_LVAL_PP(zbegin), Z_LVAL_PP(zend) + 1, mode);
287 }
288
289 /* multi range */
290 else {
291 size_t preface_len;
292 char bound[23] = {0}, preface[1024] = {0},
293 multi_header[68] = "Content-Type: multipart/byteranges; boundary=";
294
295 /* Send HTTP 206 Partial Content */
296 http_send_status(206);
297
298 /* send multipart/byteranges header */
299 snprintf(bound, 22, "--%lu%0.9f", (ulong) time(NULL), php_combined_lcg(TSRMLS_C));
300 strncat(multi_header, bound + 2, 21);
301 http_send_header_string(multi_header);
302
303 /* send each requested chunk */
304 FOREACH_HASH_VAL(ranges, zrange) {
305 if (SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &zbegin) ||
306 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &zend)) {
307 break;
308 }
309
310 preface_len = snprintf(preface, 1023,
311 HTTP_CRLF "%s"
312 HTTP_CRLF "Content-Type: %s"
313 HTTP_CRLF "Content-Range: bytes %ld-%ld/%lu"
314 HTTP_CRLF
315 HTTP_CRLF,
316
317 bound,
318 HTTP_G(send).content_type ? HTTP_G(send).content_type : "application/x-octetstream",
319 Z_LVAL_PP(zbegin),
320 Z_LVAL_PP(zend),
321 (ulong) size
322 );
323
324 PHPWRITE(preface, preface_len);
325 http_send_chunk(data, Z_LVAL_PP(zbegin), Z_LVAL_PP(zend) + 1, mode);
326 }
327
328 /* write boundary once more */
329 PHPWRITE(HTTP_CRLF, lenof(HTTP_CRLF));
330 PHPWRITE(bound, strlen(bound));
331 PHPWRITE("--", lenof("--"));
332
333 return SUCCESS;
334 }
335 }
336 /* }}} */
337
338 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
339 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)
340 {
341 HashTable ranges;
342 http_range_status range_status;
343 int cache_etag = 0;
344
345 if (!data_ptr) {
346 return FAILURE;
347 }
348 if (!data_size) {
349 return SUCCESS;
350 }
351
352 /* stop on-the-fly etag generation */
353 cache_etag = http_interrupt_ob_etaghandler();
354
355 /* enable partial dl and resume */
356 http_send_header_string("Accept-Ranges: bytes");
357
358 zend_hash_init(&ranges, 0, NULL, ZVAL_PTR_DTOR, 0);
359 range_status = http_get_request_ranges(&ranges, data_size);
360
361 if (range_status == RANGE_ERR) {
362 zend_hash_destroy(&ranges);
363 http_send_status(416);
364 return FAILURE;
365 }
366
367 /* Range Request - only send ranges if entity hasn't changed */
368 if ( range_status == RANGE_OK &&
369 http_match_etag_ex("HTTP_IF_MATCH", HTTP_G(send).unquoted_etag, 0) &&
370 http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G(send).last_modified, 0) &&
371 http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G(send).last_modified, 0)) {
372 STATUS result = http_send_ranges(&ranges, data_ptr, data_size, data_mode);
373 zend_hash_destroy(&ranges);
374 return result;
375 }
376
377 zend_hash_destroy(&ranges);
378
379 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
380 if (!no_cache && cache_etag) {
381 char *etag = NULL;
382
383 if (etag = http_etag(data_ptr, data_size, data_mode)) {
384 char *sent_header = NULL;
385
386 http_send_etag_ex(etag, strlen(etag), &sent_header);
387 if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
388 return http_exit_ex(304, sent_header, NULL, 0);
389 } else {
390 STR_FREE(sent_header);
391 }
392 efree(etag);
393 }
394 }
395
396 /* send 304 Not Modified if last modified matches */
397 if (!no_cache && http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G(send).last_modified)) {
398 char *sent_header = NULL;
399 http_send_last_modified_ex(HTTP_G(send).last_modified, &sent_header);
400 return http_exit_ex(304, sent_header, NULL, 0);
401 }
402
403 /* emit a content-length header */
404 if (!php_ob_handler_used("ob_gzhandler" TSRMLS_CC)) {
405 char *cl;
406 spprintf(&cl, 0, "Content-Length: %lu", (unsigned long) data_size);
407 http_send_header_string(cl);
408 efree(cl);
409 }
410 /* send full entity */
411 return http_send_chunk(data_ptr, 0, data_size, data_mode);
412 }
413 /* }}} */
414
415 /* {{{ STATUS http_send_stream(php_stream *) */
416 PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_stream, zend_bool no_cache TSRMLS_DC)
417 {
418 STATUS status;
419 php_stream_statbuf ssb;
420
421 if ((!file) || php_stream_stat(file, &ssb)) {
422 return FAILURE;
423 }
424
425 status = http_send_ex(file, ssb.sb.st_size, SEND_RSRC, no_cache);
426
427 if (close_stream) {
428 php_stream_close(file);
429 }
430
431 return status;
432 }
433 /* }}} */
434
435 /*
436 * Local variables:
437 * tab-width: 4
438 * c-basic-offset: 4
439 * End:
440 * vim600: sw=4 ts=4 fdm=marker
441 * vim<600: sw=4 ts=4
442 */
443