a374b425c74932ecd09642b034015ea6e2a53a39
[m6w6/ext-http] / php_http_env_response.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-2010, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id $ */
14
15 #include "php_http.h"
16
17 #include <main/SAPI.h>
18 #include <ext/date/php_date.h>
19 #include <ext/standard/php_string.h>
20
21
22 static void set_option(zval *options, const char *name_str, size_t name_len, int type, const void *value_ptr, size_t value_len TSRMLS_DC)
23 {
24 if (Z_TYPE_P(options) == IS_OBJECT) {
25 /* stupid non-const api */
26 char *name = estrndup(name_str, name_len);
27 if (value_ptr) {
28 switch (type) {
29 case IS_DOUBLE:
30 zend_update_property_double(Z_OBJCE_P(options), options, name, name_len, *(double *)value_ptr TSRMLS_CC);
31 break;
32 case IS_LONG:
33 zend_update_property_long(Z_OBJCE_P(options), options, name, name_len, *(long *)value_ptr TSRMLS_CC);
34 break;
35 case IS_STRING:
36 zend_update_property_stringl(Z_OBJCE_P(options), options, name, name_len, value_ptr, value_len TSRMLS_CC);
37 break;
38 }
39 } else {
40 zend_update_property_null(Z_OBJCE_P(options), options, name, name_len TSRMLS_CC);
41 }
42 efree(name);
43 } else {
44 convert_to_array(options);
45 if (value_ptr) {
46 switch (type) {
47 case IS_DOUBLE:
48 add_assoc_double_ex(options, name_str, name_len + 1, *(double *)value_ptr);
49 break;
50 case IS_LONG:
51 add_assoc_long_ex(options, name_str, name_len + 1, *(long *)value_ptr);
52 break;
53 case IS_STRING: {
54 char *value = estrndup(value_ptr, value_len);
55 add_assoc_stringl_ex(options, name_str, name_len + 1, value, value_len, 0);
56 break;
57 }
58 }
59 } else {
60 add_assoc_null_ex(options, name_str, name_len + 1);
61 }
62 }
63 }
64 static zval *get_option(zval *options, const char *name_str, size_t name_len TSRMLS_DC)
65 {
66 zval *val, **valptr;
67
68 if (Z_TYPE_P(options) == IS_OBJECT) {
69 char *name = estrndup(name_str, name_len);
70 val = zend_read_property(Z_OBJCE_P(options), options, name, name_len, 0 TSRMLS_CC);
71 efree(name);
72 } else {
73 if (SUCCESS == zend_symtable_find(Z_ARRVAL_P(options), name_str, name_len + 1, (void *) &valptr)) {
74 val = *valptr;
75 } else {
76 val = NULL;
77 }
78 }
79 if (val) {
80 Z_ADDREF_P(val);
81 }
82 return val;
83 }
84
85 PHP_HTTP_API php_http_cache_status_t php_http_env_is_response_cached_by_etag(zval *options, const char *header_str, size_t header_len TSRMLS_DC)
86 {
87 int ret, free_etag = 0;
88 char *header, *etag;
89 zval *zetag, *zbody = NULL;
90
91 if ( !(header = php_http_env_get_request_header(header_str, header_len TSRMLS_CC))
92 || !(zbody = get_option(options, ZEND_STRL("body") TSRMLS_CC))
93 || !(Z_TYPE_P(zbody) == IS_OBJECT)
94 || !instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
95 ) {
96 STR_FREE(header);
97 if (zbody) {
98 zval_ptr_dtor(&zbody);
99 }
100 return PHP_HTTP_CACHE_NO;
101 }
102
103 if ((zetag = get_option(options, ZEND_STRL("etag") TSRMLS_CC))) {
104 zval *zetag_copy = php_http_ztyp(IS_STRING, zetag);
105 zval_ptr_dtor(&zetag);
106 zetag = zetag_copy;
107 }
108
109 if (zetag && Z_STRLEN_P(zetag)) {
110 etag = Z_STRVAL_P(zetag);
111 } else {
112 etag = php_http_message_body_etag(((php_http_message_body_object_t *) zend_object_store_get_object(zbody TSRMLS_CC))->body);
113 set_option(options, ZEND_STRL("etag"), IS_STRING, etag, strlen(etag) TSRMLS_CC);
114 free_etag = 1;
115 }
116
117 if (zbody) {
118 zval_ptr_dtor(&zbody);
119 }
120
121 if (zetag) {
122 zval_ptr_dtor(&zetag);
123 }
124
125 ret = php_http_match(header, etag, PHP_HTTP_MATCH_WORD);
126
127 if (free_etag) {
128 efree(etag);
129 }
130 efree(header);
131
132 return ret ? PHP_HTTP_CACHE_HIT : PHP_HTTP_CACHE_MISS;
133 }
134
135 PHP_HTTP_API php_http_cache_status_t php_http_env_is_response_cached_by_last_modified(zval *options, const char *header_str, size_t header_len TSRMLS_DC)
136 {
137 char *header;
138 time_t ums, lm = 0;
139 zval *zbody = NULL, *zlm;
140
141 if ( !(header = php_http_env_get_request_header(header_str, header_len TSRMLS_CC))
142 || !(zbody = get_option(options, ZEND_STRL("body") TSRMLS_CC))
143 || !(Z_TYPE_P(zbody) == IS_OBJECT)
144 || !instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
145 ) {
146 STR_FREE(header);
147 if (zbody) {
148 zval_ptr_dtor(&zbody);
149 }
150 return PHP_HTTP_CACHE_NO;
151 }
152
153 if ((zlm = get_option(options, ZEND_STRL("lastModified") TSRMLS_CC))) {
154 zval *zlm_copy = php_http_ztyp(IS_LONG, zlm);
155 zval_ptr_dtor(&zlm);
156 zlm = zlm_copy;
157 }
158
159 if (zlm && Z_LVAL_P(zlm) > 0) {
160 lm = Z_LVAL_P(zlm);
161 } else {
162 lm = php_http_message_body_mtime(((php_http_message_body_object_t *) zend_object_store_get_object(zbody TSRMLS_CC))->body);
163 set_option(options, ZEND_STRL("lastModified"), IS_LONG, &lm, 0 TSRMLS_CC);
164 }
165
166 if (zlm) {
167 zval_ptr_dtor(&zlm);
168 }
169
170 ums = php_parse_date(header, NULL);
171 efree(header);
172
173 if (ums > 0 && ums <= lm) {
174 return PHP_HTTP_CACHE_HIT;
175 } else {
176 return PHP_HTTP_CACHE_MISS;
177 }
178 }
179
180 static size_t output(void *context, const char *buf, size_t len TSRMLS_DC)
181 {
182 php_http_env_response_t *r = context;
183
184 PHPWRITE(buf, len);
185
186 /* we really only need to flush when throttling is enabled,
187 because we push the data as fast as possible anyway if not */
188 if (r->throttle.delay >= PHP_HTTP_DIFFSEC) {
189 if (php_output_get_level(TSRMLS_C)) {
190 php_output_flush_all(TSRMLS_C);
191 }
192 if (!(php_output_get_status(TSRMLS_C) & PHP_OUTPUT_IMPLICITFLUSH)) {
193 sapi_flush(TSRMLS_C);
194 }
195 php_http_sleep(r->throttle.delay);
196 }
197 return len;
198 }
199
200 #define php_http_env_response_send_done(r) php_http_env_response_send_data((r), NULL, 0)
201 static STATUS php_http_env_response_send_data(php_http_env_response_t *r, const char *buf, size_t len)
202 {
203 TSRMLS_FETCH_FROM_CTX(r->ts);
204 size_t chunk = r->throttle.chunk ? r->throttle.chunk : PHP_HTTP_SENDBUF_SIZE;
205
206 if (r->content.encoder) {
207 char *enc_str = NULL;
208 size_t enc_len = 0;
209
210 if (buf) {
211 if (SUCCESS != php_http_encoding_stream_update(r->content.encoder, buf, len, &enc_str, &enc_len)) {
212 return FAILURE;
213 }
214 } else {
215 if (SUCCESS != php_http_encoding_stream_finish(r->content.encoder, &enc_str, &enc_len)) {
216 return FAILURE;
217 }
218 }
219
220 if (enc_str) {
221 php_http_buffer_chunked_output(&r->buffer, enc_str, enc_len, buf ? chunk : 0, output, r TSRMLS_CC);
222 STR_FREE(enc_str);
223 }
224 } else {
225 php_http_buffer_chunked_output(&r->buffer, buf, len, buf ? chunk : 0, output, r TSRMLS_CC);
226 }
227
228 return SUCCESS;
229 }
230
231 PHP_HTTP_API php_http_env_response_t *php_http_env_response_init(php_http_env_response_t *r, zval *options TSRMLS_DC)
232 {
233 php_http_env_response_t *free_r = NULL;
234
235 if (!r) {
236 r = free_r = emalloc(sizeof(*r));
237 }
238 memset(r, 0, sizeof(*r));
239
240 r->buffer = php_http_buffer_init(NULL);
241
242 Z_ADDREF_P(options);
243 r->options = options;
244
245 TSRMLS_SET_CTX(r->ts);
246
247 return r;
248 }
249
250 PHP_HTTP_API void php_http_env_response_dtor(php_http_env_response_t *r)
251 {
252 php_http_buffer_free(&r->buffer);
253 zval_ptr_dtor(&r->options);
254 STR_FREE(r->content.type);
255 STR_FREE(r->content.encoding);
256 if (r->content.encoder) {
257 php_http_encoding_stream_free(&r->content.encoder);
258 }
259 }
260
261 PHP_HTTP_API void php_http_env_response_free(php_http_env_response_t **r)
262 {
263 if (*r) {
264 php_http_env_response_dtor(*r);
265 efree(*r);
266 *r = NULL;
267 }
268 }
269
270 static STATUS php_http_env_response_send_head(php_http_env_response_t *r)
271 {
272 STATUS ret = SUCCESS;
273 zval *zoption, *options = r->options;
274 TSRMLS_FETCH_FROM_CTX(r->ts);
275
276 if (r->done) {
277 return ret;
278 }
279
280 if ((zoption = get_option(options, ZEND_STRL("responseCode") TSRMLS_CC))) {
281 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
282
283 zval_ptr_dtor(&zoption);
284 if (Z_LVAL_P(zoption_copy) > 0) {
285 ret = php_http_env_set_response_code(Z_LVAL_P(zoption_copy) TSRMLS_CC);
286 }
287 zval_ptr_dtor(&zoption_copy);
288 }
289
290 if (ret != SUCCESS) {
291 return ret;
292 }
293
294 if ((zoption = get_option(options, ZEND_STRL("httpVersion") TSRMLS_CC))) {
295 php_http_version_t v;
296 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
297
298 zval_ptr_dtor(&zoption);
299 if (Z_STRLEN_P(zoption_copy) && php_http_version_parse(&v, Z_STRVAL_P(zoption_copy) TSRMLS_CC)) {
300 ret = php_http_env_set_response_protocol_version(&v TSRMLS_CC);
301 php_http_version_dtor(&v);
302 }
303 zval_ptr_dtor(&zoption_copy);
304 }
305
306 if (ret != SUCCESS) {
307 return ret;
308 }
309
310 if ((zoption = get_option(options, ZEND_STRL("headers") TSRMLS_CC))) {
311 if (Z_TYPE_P(zoption) == IS_ARRAY) {
312 zval **val;
313 HashPosition pos;
314 php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
315
316 FOREACH_KEYVAL(pos, zoption, key, val) {
317 if (key.type == HASH_KEY_IS_STRING) {
318 if (SUCCESS != (ret = php_http_env_set_response_header_value(0, key.str, key.len - 1, *val, 1 TSRMLS_CC))) {
319 break;
320 }
321 }
322 }
323 }
324 zval_ptr_dtor(&zoption);
325 }
326
327 if (ret != SUCCESS) {
328 return ret;
329 }
330
331 if ((zoption = get_option(options, ZEND_STRL("contentType") TSRMLS_CC))) {
332 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
333
334 zval_ptr_dtor(&zoption);
335 if (Z_STRLEN_P(zoption_copy)) {
336 PHP_HTTP_CHECK_CONTENT_TYPE(Z_STRVAL_P(zoption_copy), ret = FAILURE) else {
337 if (SUCCESS == (ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Type: %.*s", Z_STRLEN_P(zoption_copy), Z_STRVAL_P(zoption_copy)))) {
338 r->content.type = estrndup(Z_STRVAL_P(zoption_copy), Z_STRLEN_P(zoption_copy));
339 }
340 }
341 }
342 zval_ptr_dtor(&zoption_copy);
343 }
344
345 if (ret != SUCCESS) {
346 return ret;
347 }
348
349 if (r->range.status == PHP_HTTP_RANGE_OK) {
350 if (zend_hash_num_elements(&r->range.values) == 1) {
351 zval **range, **begin, **end;
352
353 if (SUCCESS != zend_hash_index_find(&r->range.values, 0, (void *) &range)
354 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin)
355 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)
356 ) {
357 /* this should never happen */
358 zend_hash_destroy(&r->range.values);
359 php_http_env_set_response_code(500 TSRMLS_CC);
360 ret = FAILURE;
361 } else {
362 ret = php_http_env_set_response_header_format(206, 1 TSRMLS_CC, "Content-Range: bytes %ld-%ld/%zu", Z_LVAL_PP(begin), Z_LVAL_PP(end), r->content.length);
363 }
364 } else {
365 php_http_boundary(r->range.boundary, sizeof(r->range.boundary) TSRMLS_CC);
366 ret = php_http_env_set_response_header_format(206, 1 TSRMLS_CC, "Content-Type: multipart/byteranges; boundary=%s", r->range.boundary);
367 }
368 } else {
369 if ((zoption = get_option(options, ZEND_STRL("cacheControl") TSRMLS_CC))) {
370 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
371
372 zval_ptr_dtor(&zoption);
373 if (Z_STRLEN_P(zoption_copy)) {
374 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Cache-Control: %.*s", Z_STRLEN_P(zoption_copy), Z_STRVAL_P(zoption_copy) TSRMLS_CC);
375 }
376 zval_ptr_dtor(&zoption_copy);
377 }
378
379 if (ret != SUCCESS) {
380 return ret;
381 }
382
383 if ((zoption = get_option(options, ZEND_STRL("contentDisposition") TSRMLS_CC))) {
384 zval *zoption_copy = php_http_ztyp(IS_ARRAY, zoption);
385 zval **zdisposition, **zfilename = NULL;
386
387 zval_ptr_dtor(&zoption);
388 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("disposition"), (void *) &zdisposition)) {
389 zval *zdisposition_copy = php_http_ztyp(IS_LONG, *zdisposition);
390 char *tmp = NULL;
391
392 switch (Z_LVAL_P(zdisposition_copy)) {
393 case PHP_HTTP_CONTENT_DISPOSITION_NONE:
394 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Disposition"), NULL, 1 TSRMLS_CC);
395 break;
396 case PHP_HTTP_CONTENT_DISPOSITION_INLINE:
397 tmp = "inline";
398 break;
399 case PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT:
400 tmp = "attachment";
401 break;
402 }
403
404 if (tmp) {
405 if (SUCCESS != zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("filename"), (void *) &zfilename)) {
406 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
407 } else {
408 zval *zfilename_copy = php_http_ztyp(IS_STRING, *zfilename);
409
410 if (!Z_STRLEN_P(zfilename_copy)) {
411 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
412 } else {
413 int new_f_len;
414 char *new_f_str = php_addslashes(estrndup(Z_STRVAL_P(zfilename_copy), Z_STRLEN_P(zfilename_copy)), Z_STRLEN_P(zfilename_copy), &new_f_len, 0 TSRMLS_CC);
415
416 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s; filename=\"%.*s\"", tmp, new_f_len, new_f_str);
417 STR_FREE(new_f_str);
418 }
419
420 zval_ptr_dtor(&zfilename_copy);
421 }
422 }
423 zval_ptr_dtor(&zdisposition_copy);
424 }
425 zval_ptr_dtor(&zoption_copy);
426 }
427
428 if (ret != SUCCESS) {
429 return ret;
430 }
431
432 if ((zoption = get_option(options, ZEND_STRL("contentEncoding") TSRMLS_CC))) {
433 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
434 zval zsupported;
435 HashTable *result = NULL;
436
437 zval_ptr_dtor(&zoption);
438 switch (Z_LVAL_P(zoption_copy)) {
439 case PHP_HTTP_CONTENT_ENCODING_GZIP:
440 INIT_PZVAL(&zsupported);
441 array_init(&zsupported);
442 add_next_index_stringl(&zsupported, ZEND_STRL("none"), 1);
443 add_next_index_stringl(&zsupported, ZEND_STRL("gzip"), 1);
444 add_next_index_stringl(&zsupported, ZEND_STRL("deflate"), 1);
445
446 if ((result = php_http_negotiate_encoding(Z_ARRVAL(zsupported) TSRMLS_CC))) {
447 char *key_str = NULL;
448 uint key_len = 0;
449
450 zend_hash_internal_pointer_reset(result);
451 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key_str, &key_len, NULL, 0, NULL)) {
452 if (!strcmp(key_str, "gzip")) {
453 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_GZIP TSRMLS_CC))) {
454 ret = FAILURE;
455 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: gzip"), 1 TSRMLS_CC))) {
456 r->content.encoding = estrndup(key_str, key_len - 1);
457 }
458 } else if (!strcmp(key_str, "deflate")) {
459 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_ZLIB TSRMLS_CC))) {
460 ret = FAILURE;
461 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: deflate"), 1 TSRMLS_CC))) {
462 r->content.encoding = estrndup(key_str, key_len - 1);
463 }
464 } else {
465 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
466 }
467
468 if (SUCCESS == ret) {
469 ret = php_http_env_set_response_header(0, ZEND_STRL("Vary: Accept-Encoding"), 0 TSRMLS_CC);
470 }
471 }
472
473 zend_hash_destroy(result);
474 FREE_HASHTABLE(result);
475 }
476
477 zval_dtor(&zsupported);
478 break;
479
480 case PHP_HTTP_CONTENT_ENCODING_NONE:
481 default:
482 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
483 break;
484 }
485 zval_ptr_dtor(&zoption_copy);
486 }
487
488 if (SUCCESS != ret) {
489 return ret;
490 }
491
492 switch (php_http_env_is_response_cached_by_etag(options, ZEND_STRL("If-None-Match") TSRMLS_CC)) {
493 case PHP_HTTP_CACHE_MISS:
494 break;
495
496 case PHP_HTTP_CACHE_NO:
497 if (PHP_HTTP_CACHE_HIT != php_http_env_is_response_cached_by_last_modified(options, ZEND_STRL("If-Modified-Since") TSRMLS_CC)) {
498 break;
499 }
500 /* fallthrough */
501
502 case PHP_HTTP_CACHE_HIT:
503 ret = php_http_env_set_response_code(304 TSRMLS_CC);
504 r->done = 1;
505 break;
506 }
507
508 if ((zoption = get_option(options, ZEND_STRL("etag") TSRMLS_CC))) {
509 ret = php_http_env_set_response_header_value(0, ZEND_STRL("ETag"), zoption, 1 TSRMLS_CC);
510 zval_ptr_dtor(&zoption);
511 }
512 if ((zoption = get_option(options, ZEND_STRL("lastModified") TSRMLS_CC))) {
513 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
514
515 zval_ptr_dtor(&zoption);
516 if (Z_LVAL_P(zoption_copy)) {
517 char *date = php_format_date(ZEND_STRL(PHP_HTTP_DATE_FORMAT), Z_LVAL_P(zoption_copy), 0 TSRMLS_CC);
518 if (date) {
519 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Last-Modified: %s", date);
520 efree(date);
521 }
522 }
523 zval_ptr_dtor(&zoption_copy);
524 }
525 }
526
527 return ret;
528 }
529
530 static STATUS php_http_env_response_send_body(php_http_env_response_t *r)
531 {
532 STATUS ret = SUCCESS;
533 zval *zbody;
534 TSRMLS_FETCH_FROM_CTX(r->ts);
535
536 if (r->done) {
537 return ret;
538 }
539
540 if ( (zbody = get_option(r->options, ZEND_STRL("body") TSRMLS_CC))
541 && (Z_TYPE_P(zbody) == IS_OBJECT)
542 && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
543 ) {
544 php_http_message_body_object_t *obj = zend_object_store_get_object(zbody TSRMLS_CC);
545
546 if (r->range.status == PHP_HTTP_RANGE_OK) {
547 if (zend_hash_num_elements(&r->range.values) == 1) {
548 /* single range */
549 zval **range, **begin, **end;
550
551 if (SUCCESS != zend_hash_index_find(&r->range.values, 0, (void *) &range)
552 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin)
553 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)
554 ) {
555 /* this should never happen */
556 zend_hash_destroy(&r->range.values);
557 php_http_env_set_response_code(500 TSRMLS_CC);
558 ret = FAILURE;
559 } else {
560 /* send chunk */
561 php_http_message_body_to_callback(obj->body, (php_http_pass_callback_t) php_http_env_response_send_data, r, Z_LVAL_PP(begin), Z_LVAL_PP(end) - Z_LVAL_PP(begin) + 1);
562 php_http_env_response_send_done(r);
563 zend_hash_destroy(&r->range.values);
564 ret = SUCCESS;
565 }
566 } else {
567 /* send multipart/byte-ranges message */
568 HashPosition pos;
569 zval **chunk;
570
571 FOREACH_HASH_VAL(pos, &r->range.values, chunk) {
572 zval **begin, **end;
573
574 if (IS_ARRAY == Z_TYPE_PP(chunk)
575 && SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(chunk), 0, (void *) &begin)
576 && IS_LONG == Z_TYPE_PP(begin)
577 && SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(chunk), 1, (void *) &end)
578 && IS_LONG == Z_TYPE_PP(end)
579 ) {
580 php_http_buffer_appendf(r->buffer,
581 PHP_HTTP_CRLF
582 "--%s" PHP_HTTP_CRLF
583 "Content-Type: %s" PHP_HTTP_CRLF
584 "Content-Range: bytes %ld-%ld/%zu" PHP_HTTP_CRLF PHP_HTTP_CRLF,
585 /* - */
586 r->range.boundary,
587 r->content.type ? r->content.type : "application/octet-stream",
588 Z_LVAL_PP(begin),
589 Z_LVAL_PP(end),
590 r->content.length
591 );
592 php_http_message_body_to_callback(obj->body, (php_http_pass_callback_t) php_http_env_response_send_data, r, Z_LVAL_PP(begin), Z_LVAL_PP(end) - Z_LVAL_PP(begin) + 1);
593 }
594 }
595 php_http_buffer_appendf(r->buffer, PHP_HTTP_CRLF "--%s--", r->range.boundary);
596 php_http_env_response_send_done(r);
597 zend_hash_destroy(&r->range.values);
598 }
599
600 } else {
601 php_http_message_body_to_callback(obj->body, (php_http_pass_callback_t) php_http_env_response_send_data, r, 0, 0);
602 php_http_env_response_send_done(r);
603 }
604 }
605 if (zbody) {
606 zval_ptr_dtor(&zbody);
607 }
608 return ret;
609 }
610
611 PHP_HTTP_API STATUS php_http_env_response_send(php_http_env_response_t *r)
612 {
613 zval *zbody;
614 TSRMLS_FETCH_FROM_CTX(r->ts);
615
616 /* check for ranges */
617 if ( (zbody = get_option(r->options, ZEND_STRL("body") TSRMLS_CC))
618 && (Z_TYPE_P(zbody) == IS_OBJECT)
619 && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
620 ) {
621 php_http_message_body_object_t *obj = zend_object_store_get_object(zbody TSRMLS_CC);
622
623 r->content.length = php_http_message_body_size(obj->body);
624 zval_ptr_dtor(&zbody);
625
626 if (SUCCESS != php_http_env_set_response_header(0, ZEND_STRL("Accept-Ranges: bytes"), 1 TSRMLS_CC)) {
627 return FAILURE;
628 } else {
629 zend_hash_init(&r->range.values, 0, NULL, ZVAL_PTR_DTOR, 0);
630 r->range.status = php_http_env_get_request_ranges(&r->range.values, r->content.length TSRMLS_CC);
631
632 switch (r->range.status) {
633 case PHP_HTTP_RANGE_NO:
634 zend_hash_destroy(&r->range.values);
635 break;
636
637 case PHP_HTTP_RANGE_ERR:
638 if (php_http_env_got_request_header(ZEND_STRL("If-Range") TSRMLS_CC)) {
639 r->range.status = PHP_HTTP_RANGE_NO;
640 zend_hash_destroy(&r->range.values);
641 } else {
642 r->done = 1;
643 zend_hash_destroy(&r->range.values);
644 if (SUCCESS != php_http_env_set_response_header_format(416, 1 TSRMLS_CC, "Content-Range: bytes */%zu", r->content.length)) {
645 return FAILURE;
646 }
647 }
648 break;
649
650 case PHP_HTTP_RANGE_OK:
651 if (PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_etag(r->options, ZEND_STRL("If-Range") TSRMLS_CC)
652 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("If-Range") TSRMLS_CC)
653 ) {
654 r->range.status = PHP_HTTP_RANGE_NO;
655 zend_hash_destroy(&r->range.values);
656 break;
657 }
658 if (PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_etag(r->options, ZEND_STRL("If-Match") TSRMLS_CC)
659 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("If-Unmodified-Since") TSRMLS_CC)
660 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("Unless-Modified-Since") TSRMLS_CC)
661 ) {
662 r->done = 1;
663 zend_hash_destroy(&r->range.values);
664 if (SUCCESS != php_http_env_set_response_code(412 TSRMLS_CC)) {
665 return FAILURE;
666 }
667 break;
668 }
669
670 break;
671 }
672 }
673 } else if (zbody) {
674 zval_ptr_dtor(&zbody);
675 }
676
677 if (SUCCESS != php_http_env_response_send_head(r)) {
678 return FAILURE;
679 }
680
681 if (SUCCESS != php_http_env_response_send_body(r)) {
682 return FAILURE;
683 }
684 return SUCCESS;
685 }
686
687 zend_class_entry *php_http_env_response_class_entry;
688
689 #undef PHP_HTTP_BEGIN_ARGS
690 #undef PHP_HTTP_EMPTY_ARGS
691 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpEnvResponse, method, 0, req_args)
692 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpEnvResponse, method, 0)
693 #define PHP_HTTP_ENV_RESPONSE_ME(method, visibility) PHP_ME(HttpEnvResponse, method, PHP_HTTP_ARGS(HttpEnvResponse, method), visibility)
694
695 PHP_HTTP_EMPTY_ARGS(__construct);
696
697 PHP_HTTP_BEGIN_ARGS(setContentType, 1)
698 PHP_HTTP_ARG_VAL(content_type, 0)
699 PHP_HTTP_END_ARGS;
700
701 PHP_HTTP_BEGIN_ARGS(setContentEncoding, 1)
702 PHP_HTTP_ARG_VAL(content_encoding, 0)
703 PHP_HTTP_END_ARGS;
704
705 PHP_HTTP_BEGIN_ARGS(setContentDisposition, 1)
706 PHP_HTTP_ARG_VAL(content_disposition, 0)
707 PHP_HTTP_ARG_VAL(filename, 0)
708 PHP_HTTP_END_ARGS;
709
710 PHP_HTTP_BEGIN_ARGS(setCacheControl, 1)
711 PHP_HTTP_ARG_VAL(cache_control, 0)
712 PHP_HTTP_END_ARGS;
713
714 PHP_HTTP_BEGIN_ARGS(setLastModified, 1)
715 PHP_HTTP_ARG_VAL(last_modified, 0)
716 PHP_HTTP_END_ARGS;
717
718 PHP_HTTP_BEGIN_ARGS(isCachedByLastModified, 0)
719 PHP_HTTP_ARG_VAL(header_name, 0)
720 PHP_HTTP_END_ARGS;
721
722 PHP_HTTP_BEGIN_ARGS(setEtag, 1)
723 PHP_HTTP_ARG_VAL(etag, 0)
724 PHP_HTTP_END_ARGS;
725
726 PHP_HTTP_BEGIN_ARGS(isCachedByEtag, 0)
727 PHP_HTTP_ARG_VAL(header_name, 0)
728 PHP_HTTP_END_ARGS;
729
730 PHP_HTTP_BEGIN_ARGS(setThrottleRate, 1)
731 PHP_HTTP_ARG_VAL(chunk_size, 0)
732 PHP_HTTP_ARG_VAL(delay, 0)
733 PHP_HTTP_END_ARGS;
734
735 PHP_HTTP_EMPTY_ARGS(send);
736
737
738 zend_function_entry php_http_env_response_method_entry[] = {
739 PHP_HTTP_ENV_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
740 PHP_HTTP_ENV_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
741 PHP_HTTP_ENV_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
742 PHP_HTTP_ENV_RESPONSE_ME(setContentEncoding, ZEND_ACC_PUBLIC)
743 PHP_HTTP_ENV_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
744 PHP_HTTP_ENV_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
745 PHP_HTTP_ENV_RESPONSE_ME(isCachedByLastModified, ZEND_ACC_PUBLIC)
746 PHP_HTTP_ENV_RESPONSE_ME(setEtag, ZEND_ACC_PUBLIC)
747 PHP_HTTP_ENV_RESPONSE_ME(isCachedByEtag, ZEND_ACC_PUBLIC)
748 PHP_HTTP_ENV_RESPONSE_ME(setThrottleRate, ZEND_ACC_PUBLIC)
749
750 PHP_HTTP_ENV_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
751
752 EMPTY_FUNCTION_ENTRY
753 };
754
755
756 PHP_METHOD(HttpEnvResponse, __construct)
757 {
758 with_error_handling(EH_THROW, php_http_exception_class_entry) {
759 if (SUCCESS == zend_parse_parameters_none()) {
760 php_http_message_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
761
762 with_error_handling(EH_THROW, php_http_exception_class_entry) {
763 obj->message = php_http_message_init_env(obj->message, PHP_HTTP_RESPONSE TSRMLS_CC);
764 } end_error_handling();
765 }
766 } end_error_handling();
767
768 }
769
770 PHP_METHOD(HttpEnvResponse, setContentType)
771 {
772 char *ct_str = NULL;
773 int ct_len = 0;
774
775 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &ct_str, &ct_len)) {
776 set_option(getThis(), ZEND_STRL("contentType"), IS_STRING, ct_str, ct_len TSRMLS_CC);
777 }
778 }
779
780 PHP_METHOD(HttpEnvResponse, setContentDisposition)
781 {
782 long cd;
783 char *file_str = NULL;
784 int file_len = 0;
785
786 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|s!", &cd, &file_str, &file_len)) {
787 zval *arr;
788
789 MAKE_STD_ZVAL(arr);
790 array_init(arr);
791 add_assoc_long_ex(arr, ZEND_STRS("disposition"), cd);
792 if (file_len) {
793 add_assoc_stringl_ex(arr, ZEND_STRS("filename"), file_str, file_len, 1);
794 }
795 zend_update_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("contentDisposition"), arr TSRMLS_CC);
796 zval_ptr_dtor(&arr);
797 }
798 }
799
800 PHP_METHOD(HttpEnvResponse, setContentEncoding)
801 {
802 long ce;
803
804 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &ce)) {
805 set_option(getThis(), ZEND_STRL("contentEncoding"), IS_LONG, &ce, 0 TSRMLS_CC);
806 }
807 }
808
809 PHP_METHOD(HttpEnvResponse, setCacheControl)
810 {
811 char *cc_str = NULL;
812 int cc_len = 0;
813
814 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &cc_str, &cc_len)) {
815 set_option(getThis(), ZEND_STRL("cacheControl"), IS_STRING, cc_str, cc_len TSRMLS_CC);
816 }
817 }
818
819 PHP_METHOD(HttpEnvResponse, setLastModified)
820 {
821 long last_modified;
822
823 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &last_modified)) {
824 set_option(getThis(), ZEND_STRL("lastModified"), IS_LONG, &last_modified, 0 TSRMLS_CC);
825 }
826 }
827
828 PHP_METHOD(HttpEnvResponse, isCachedByLastModified)
829 {
830 char *header_name_str = NULL;
831 int header_name_len = 0;
832
833 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
834 if (!header_name_str || !header_name_len) {
835 header_name_str = "If-Modified-Since";
836 header_name_len = lenof("If-Modified-Since");
837 }
838 RETURN_LONG(php_http_env_is_response_cached_by_last_modified(getThis(), header_name_str, header_name_len TSRMLS_CC));
839 }
840 RETURN_FALSE;
841 }
842
843 PHP_METHOD(HttpEnvResponse, setEtag)
844 {
845 char *etag_str = NULL;
846 int etag_len = 0;
847
848 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &etag_str, &etag_len)) {
849 set_option(getThis(), ZEND_STRL("etag"), IS_STRING, etag_str, etag_len TSRMLS_CC);
850 }
851 }
852
853 PHP_METHOD(HttpEnvResponse, isCachedByEtag)
854 {
855 char *header_name_str = NULL;
856 int header_name_len = 0;
857
858 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
859 if (!header_name_str || !header_name_len) {
860 header_name_str = "If-None-Match";
861 header_name_len = lenof("If-None-Match");
862 }
863 RETURN_LONG(php_http_env_is_response_cached_by_etag(getThis(), header_name_str, header_name_len TSRMLS_CC));
864 }
865 RETURN_FALSE;
866 }
867
868 PHP_METHOD(HttpEnvResponse, setThrottleRate)
869 {
870 long chunk_size;
871 double delay = 1;
872
873 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|d", &chunk_size, &delay)) {
874 long chunk_size_long = (long) chunk_size;
875
876 set_option(getThis(), ZEND_STRL("throttleDelay"), IS_DOUBLE, &delay, 0 TSRMLS_CC);
877 set_option(getThis(), ZEND_STRL("throttleChunk"), IS_LONG, &chunk_size_long, 0 TSRMLS_CC);
878 RETURN_TRUE;
879 }
880 RETURN_FALSE;
881 }
882
883 PHP_METHOD(HttpEnvResponse, send)
884 {
885 RETVAL_FALSE;
886
887 if (SUCCESS == zend_parse_parameters_none()) {
888 php_http_env_response_t *r = php_http_env_response_init(NULL, getThis() TSRMLS_CC);
889
890 if (r) {
891 RETVAL_SUCCESS(php_http_env_response_send(r));
892 }
893
894 php_http_env_response_free(&r);
895 }
896 }
897
898 PHP_MINIT_FUNCTION(http_env_response)
899 {
900 PHP_HTTP_REGISTER_CLASS(http\\Env, Response, http_env_response, php_http_message_class_entry, 0);
901
902 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_NONE"), PHP_HTTP_CONTENT_DISPOSITION_NONE TSRMLS_CC);
903 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_INLINE"), PHP_HTTP_CONTENT_DISPOSITION_INLINE TSRMLS_CC);
904 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_ATTACHMENT"), PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT TSRMLS_CC);
905
906 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_NONE"), PHP_HTTP_CONTENT_ENCODING_NONE TSRMLS_CC);
907 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_GZIP"), PHP_HTTP_CONTENT_ENCODING_GZIP TSRMLS_CC);
908
909 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_NO"), PHP_HTTP_CACHE_NO TSRMLS_CC);
910 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_HIT"), PHP_HTTP_CACHE_HIT TSRMLS_CC);
911 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_MISS"), PHP_HTTP_CACHE_MISS TSRMLS_CC);
912
913 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentType"), ZEND_ACC_PROTECTED TSRMLS_CC);
914 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentDisposition"), ZEND_ACC_PROTECTED TSRMLS_CC);
915 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentEncoding"), ZEND_ACC_PROTECTED TSRMLS_CC);
916 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("cacheControl"), ZEND_ACC_PROTECTED TSRMLS_CC);
917 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("etag"), ZEND_ACC_PROTECTED TSRMLS_CC);
918 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("lastModified"), ZEND_ACC_PROTECTED TSRMLS_CC);
919 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleDelay"), ZEND_ACC_PROTECTED TSRMLS_CC);
920 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleChunk"), ZEND_ACC_PROTECTED TSRMLS_CC);
921
922 return SUCCESS;
923 }
924
925
926 /*
927 * Local variables:
928 * tab-width: 4
929 * c-basic-offset: 4
930 * End:
931 * vim600: noet sw=4 ts=4 fdm=marker
932 * vim<600: noet sw=4 ts=4
933 */