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