- fix property access
[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 snprintf(header, header_len, "%s: %s", name, value);
160 ret = http_send_header_string_ex(header, replace);
161 efree(header);
162 return ret;
163 }
164 /* }}} */
165
166 /* {{{ STATUS http_send_status_header(int, char *) */
167 PHP_HTTP_API STATUS _http_send_status_header_ex(int status, const char *header, zend_bool replace TSRMLS_DC)
168 {
169 STATUS ret;
170 sapi_header_line h = {(char *) header, header ? strlen(header) : 0, status};
171 if (SUCCESS != (ret = sapi_header_op(replace ? SAPI_HEADER_REPLACE : SAPI_HEADER_ADD, &h TSRMLS_CC))) {
172 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Could not send header: %s (%d)", header, status);
173 }
174 return ret;
175 }
176 /* }}} */
177
178 /* {{{ STATUS http_send_last_modified(int) */
179 PHP_HTTP_API STATUS _http_send_last_modified_ex(time_t t, char **sent_header TSRMLS_DC)
180 {
181 STATUS ret;
182 char *date = http_date(t);
183
184 if (!date) {
185 return FAILURE;
186 }
187
188 ret = http_send_header_ex("Last-Modified", lenof("Last-Modifed"), date, strlen(date), 1, sent_header);
189 efree(date);
190
191 /* remember */
192 HTTP_G(send).last_modified = t;
193
194 return ret;
195 }
196 /* }}} */
197
198 /* {{{ STATUS http_send_etag(char *, size_t) */
199 PHP_HTTP_API STATUS _http_send_etag_ex(const char *etag, size_t etag_len, char **sent_header TSRMLS_DC)
200 {
201 STATUS status;
202 char *etag_header;
203
204 if (!etag_len){
205 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Attempt to send empty ETag (previous: %s)\n", HTTP_G(send).unquoted_etag);
206 return FAILURE;
207 }
208
209 /* remember */
210 STR_FREE(HTTP_G(send).unquoted_etag);
211 HTTP_G(send).unquoted_etag = estrdup(etag);
212
213 etag_header = ecalloc(1, sizeof("ETag: \"\"") + etag_len);
214 sprintf(etag_header, "ETag: \"%s\"", etag);
215 status = http_send_header_string(etag_header);
216
217 if (sent_header) {
218 *sent_header = etag_header;
219 } else {
220 efree(etag_header);
221 }
222
223 return status;
224 }
225 /* }}} */
226
227 /* {{{ STATUS http_send_content_type(char *, size_t) */
228 PHP_HTTP_API STATUS _http_send_content_type(const char *content_type, size_t ct_len TSRMLS_DC)
229 {
230 if (!strchr(content_type, '/')) {
231 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Content-Type '%s' doesn't seem to consist of a primary and a secondary part", content_type);
232 return FAILURE;
233 }
234
235 /* remember for multiple ranges */
236 STR_FREE(HTTP_G(send).content_type);
237 HTTP_G(send).content_type = estrndup(content_type, ct_len);
238
239 return http_send_header_ex("Content-Type", lenof("Content-Type"), content_type, ct_len, 1, NULL);
240 }
241 /* }}} */
242
243 /* {{{ STATUS http_send_content_disposition(char *, size_t, zend_bool) */
244 PHP_HTTP_API STATUS _http_send_content_disposition(const char *filename, size_t f_len, zend_bool send_inline TSRMLS_DC)
245 {
246 STATUS status;
247 char *cd_header;
248
249 if (send_inline) {
250 cd_header = ecalloc(1, sizeof("Content-Disposition: inline; filename=\"\"") + f_len);
251 sprintf(cd_header, "Content-Disposition: inline; filename=\"%s\"", filename);
252 } else {
253 cd_header = ecalloc(1, sizeof("Content-Disposition: attachment; filename=\"\"") + f_len);
254 sprintf(cd_header, "Content-Disposition: attachment; filename=\"%s\"", filename);
255 }
256
257 status = http_send_header_string(cd_header);
258 efree(cd_header);
259 return status;
260 }
261 /* }}} */
262
263 /* {{{ STATUS http_send_ranges(HashTable *, void *, size_t, http_send_mode) */
264 PHP_HTTP_API STATUS _http_send_ranges(HashTable *ranges, const void *data, size_t size, http_send_mode mode TSRMLS_DC)
265 {
266 long **begin, **end;
267 zval **zrange;
268
269 /* single range */
270 if (zend_hash_num_elements(ranges) == 1) {
271 char range_header[256] = {0};
272
273 if (SUCCESS != zend_hash_index_find(ranges, 0, (void **) &zrange) ||
274 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &begin) ||
275 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &end)) {
276 http_send_status(500);
277 return FAILURE;
278 }
279
280 /* Send HTTP 206 Partial Content */
281 http_send_status(206);
282
283 /* send content range header */
284 snprintf(range_header, 255, "Content-Range: bytes %ld-%ld/%lu", **begin, **end, (ulong) size);
285 http_send_header_string(range_header);
286
287 /* send requested chunk */
288 return http_send_chunk(data, **begin, **end + 1, mode);
289 }
290
291 /* multi range */
292 else {
293 char bound[23] = {0}, preface[1024] = {0},
294 multi_header[68] = "Content-Type: multipart/byteranges; boundary=";
295
296 /* Send HTTP 206 Partial Content */
297 http_send_status(206);
298
299 /* send multipart/byteranges header */
300 snprintf(bound, 22, "--%lu%0.9f", (ulong) time(NULL), php_combined_lcg(TSRMLS_C));
301 strncat(multi_header, bound + 2, 21);
302 http_send_header_string(multi_header);
303
304 /* send each requested chunk */
305 FOREACH_HASH_VAL(ranges, zrange) {
306 if (SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 0, (void **) &begin) ||
307 SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(zrange), 1, (void **) &end)) {
308 break;
309 }
310
311 snprintf(preface, 1023,
312 HTTP_CRLF "%s"
313 HTTP_CRLF "Content-Type: %s"
314 HTTP_CRLF "Content-Range: bytes %ld-%ld/%lu"
315 HTTP_CRLF
316 HTTP_CRLF,
317
318 bound,
319 HTTP_G(send).content_type ? HTTP_G(send).content_type : "application/x-octetstream",
320 **begin,
321 **end,
322 (ulong) size
323 );
324
325 PHPWRITE(preface, strlen(preface));
326 http_send_chunk(data, **begin, **end + 1, mode);
327 }
328
329 /* write boundary once more */
330 PHPWRITE(HTTP_CRLF, lenof(HTTP_CRLF));
331 PHPWRITE(bound, strlen(bound));
332 PHPWRITE("--", lenof("--"));
333
334 return SUCCESS;
335 }
336 }
337 /* }}} */
338
339 /* {{{ STATUS http_send(void *, size_t, http_send_mode) */
340 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)
341 {
342 HashTable ranges;
343 http_range_status range_status;
344 int cache_etag = 0;
345
346 if (!data_ptr) {
347 return FAILURE;
348 }
349 if (!data_size) {
350 return SUCCESS;
351 }
352
353 /* stop on-the-fly etag generation */
354 if (cache_etag = HTTP_G(etag).started) {
355 /* interrupt ob_etaghandler */
356 HTTP_G(etag).started = 0;
357 }
358
359 /* enable partial dl and resume */
360 http_send_header_string("Accept-Ranges: bytes");
361
362 zend_hash_init(&ranges, 0, NULL, ZVAL_PTR_DTOR, 0);
363 range_status = http_get_request_ranges(&ranges, data_size);
364
365 if (range_status == RANGE_ERR) {
366 zend_hash_destroy(&ranges);
367 http_send_status(416);
368 return FAILURE;
369 }
370
371 /* Range Request - only send ranges if entity hasn't changed */
372 if ( range_status == RANGE_OK &&
373 http_match_etag_ex("HTTP_IF_MATCH", HTTP_G(send).unquoted_etag, 0) &&
374 http_match_last_modified_ex("HTTP_IF_UNMODIFIED_SINCE", HTTP_G(send).last_modified, 0) &&
375 http_match_last_modified_ex("HTTP_UNLESS_MODIFIED_SINCE", HTTP_G(send).last_modified, 0)) {
376 STATUS result = http_send_ranges(&ranges, data_ptr, data_size, data_mode);
377 zend_hash_destroy(&ranges);
378 return result;
379 }
380
381 zend_hash_destroy(&ranges);
382
383 /* send 304 Not Modified if etag matches - DON'T return on ETag generation failure */
384 if (!no_cache && cache_etag) {
385 char *etag = NULL;
386
387 if (!(etag = http_etag(data_ptr, data_size, data_mode))) {
388 http_error(HE_NOTICE, HTTP_E_RUNTIME, "Failed to generate ETag for data source");
389 } else {
390 char *sent_header = NULL;
391
392 http_send_etag_ex(etag, 32, &sent_header);
393 if (http_match_etag("HTTP_IF_NONE_MATCH", etag)) {
394 return http_exit_ex(304, sent_header, NULL, 0);
395 } else {
396 STR_FREE(sent_header);
397 }
398 efree(etag);
399 }
400 }
401
402 /* send 304 Not Modified if last modified matches */
403 if (!no_cache && http_match_last_modified("HTTP_IF_MODIFIED_SINCE", HTTP_G(send).last_modified)) {
404 char *sent_header = NULL;
405 http_send_last_modified_ex(HTTP_G(send).last_modified, &sent_header);
406 return http_exit_ex(304, sent_header, NULL, 0);
407 }
408
409 /* emit a content-length header */
410 if (!php_ob_handler_used("ob_gzhandler" TSRMLS_CC)) {
411 char *cl;
412 spprintf(&cl, 0, "Content-Length: %lu", (unsigned long) data_size);
413 http_send_header_string(cl);
414 efree(cl);
415 }
416 /* send full entity */
417 return http_send_chunk(data_ptr, 0, data_size, data_mode);
418 }
419 /* }}} */
420
421 /* {{{ STATUS http_send_stream(php_stream *) */
422 PHP_HTTP_API STATUS _http_send_stream_ex(php_stream *file, zend_bool close_stream, zend_bool no_cache TSRMLS_DC)
423 {
424 STATUS status;
425 php_stream_statbuf ssb;
426
427 if ((!file) || php_stream_stat(file, &ssb)) {
428 return FAILURE;
429 }
430
431 status = http_send_ex(file, ssb.sb.st_size, SEND_RSRC, no_cache);
432
433 if (close_stream) {
434 php_stream_close(file);
435 }
436
437 return status;
438 }
439 /* }}} */
440
441 /*
442 * Local variables:
443 * tab-width: 4
444 * c-basic-offset: 4
445 * End:
446 * vim600: sw=4 ts=4 fdm=marker
447 * vim<600: sw=4 ts=4
448 */
449