use userland friendly namespaces
[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_hash_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 case PHP_HTTP_CONTENT_DISPOSITION_INLINE:
396 tmp = "inline";
397 break;
398 case PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT:
399 tmp = "attachment";
400 break;
401 }
402
403 if (tmp) {
404 if (SUCCESS != zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("filename"), (void *) &zfilename)) {
405 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
406 } else {
407 zval *zfilename_copy = php_http_ztyp(IS_STRING, *zfilename);
408
409 if (!Z_STRLEN_P(zfilename_copy)) {
410 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
411 } else {
412 int new_f_len;
413 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);
414
415 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s; filename=\"%.*s\"", tmp, new_f_len, new_f_str);
416 STR_FREE(new_f_str);
417 }
418
419 zval_ptr_dtor(&zfilename_copy);
420 }
421 }
422 zval_ptr_dtor(&zdisposition_copy);
423 }
424 zval_ptr_dtor(&zoption_copy);
425 }
426
427 if (ret != SUCCESS) {
428 return ret;
429 }
430
431 if ((zoption = get_option(options, ZEND_STRL("contentEncoding") TSRMLS_CC))) {
432 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
433 zval zsupported;
434 HashTable *result = NULL;
435
436 zval_ptr_dtor(&zoption);
437 switch (Z_LVAL_P(zoption_copy)) {
438 case PHP_HTTP_CONTENT_ENCODING_GZIP:
439 INIT_PZVAL(&zsupported);
440 array_init(&zsupported);
441 add_next_index_stringl(&zsupported, ZEND_STRL("none"), 1);
442 add_next_index_stringl(&zsupported, ZEND_STRL("gzip"), 1);
443 add_next_index_stringl(&zsupported, ZEND_STRL("deflate"), 1);
444
445 if ((result = php_http_negotiate_encoding(Z_ARRVAL(zsupported) TSRMLS_CC))) {
446 char *key_str = NULL;
447 uint key_len = 0;
448
449 zend_hash_internal_pointer_reset(result);
450 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key_str, &key_len, NULL, 0, NULL)) {
451 if (!strcmp(key_str, "gzip")) {
452 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_GZIP TSRMLS_CC))) {
453 ret = FAILURE;
454 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: gzip"), 1 TSRMLS_CC))) {
455 r->content.encoding = estrndup(key_str, key_len - 1);
456 }
457 } else if (!strcmp(key_str, "deflate")) {
458 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_ZLIB TSRMLS_CC))) {
459 ret = FAILURE;
460 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: deflate"), 1 TSRMLS_CC))) {
461 r->content.encoding = estrndup(key_str, key_len - 1);
462 }
463 } else {
464 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
465 }
466
467 if (SUCCESS == ret) {
468 ret = php_http_env_set_response_header(0, ZEND_STRL("Vary: Accept-Encoding"), 0 TSRMLS_CC);
469 }
470 }
471
472 zend_hash_destroy(result);
473 FREE_HASHTABLE(result);
474 }
475
476 zval_dtor(&zsupported);
477 break;
478
479 case PHP_HTTP_CONTENT_ENCODING_NONE:
480 default:
481 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
482 break;
483 }
484 zval_ptr_dtor(&zoption_copy);
485 }
486
487 if (SUCCESS != ret) {
488 return ret;
489 }
490
491 switch (php_http_env_is_response_cached_by_etag(options, ZEND_STRL("If-None-Match") TSRMLS_CC)) {
492 case PHP_HTTP_CACHE_MISS:
493 break;
494
495 case PHP_HTTP_CACHE_NO:
496 if (PHP_HTTP_CACHE_HIT != php_http_env_is_response_cached_by_last_modified(options, ZEND_STRL("If-Modified-Since") TSRMLS_CC)) {
497 break;
498 }
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 }
669 } else if (zbody) {
670 zval_ptr_dtor(&zbody);
671 }
672
673 if (SUCCESS != php_http_env_response_send_head(r)) {
674 return FAILURE;
675 }
676
677 if (SUCCESS != php_http_env_response_send_body(r)) {
678 return FAILURE;
679 }
680 return SUCCESS;
681 }
682
683 zend_class_entry *php_http_env_response_class_entry;
684
685 #undef PHP_HTTP_BEGIN_ARGS
686 #undef PHP_HTTP_EMPTY_ARGS
687 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpEnvResponse, method, 0, req_args)
688 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpEnvResponse, method, 0)
689 #define PHP_HTTP_ENV_RESPONSE_ME(method, visibility) PHP_ME(HttpEnvResponse, method, PHP_HTTP_ARGS(HttpEnvResponse, method), visibility)
690
691 PHP_HTTP_EMPTY_ARGS(__construct);
692
693 PHP_HTTP_BEGIN_ARGS(setContentType, 1)
694 PHP_HTTP_ARG_VAL(content_type, 0)
695 PHP_HTTP_END_ARGS;
696
697 PHP_HTTP_BEGIN_ARGS(setContentEncoding, 1)
698 PHP_HTTP_ARG_VAL(content_encoding, 0)
699 PHP_HTTP_END_ARGS;
700
701 PHP_HTTP_BEGIN_ARGS(setContentDisposition, 1)
702 PHP_HTTP_ARG_VAL(content_disposition, 0)
703 PHP_HTTP_ARG_VAL(filename, 0)
704 PHP_HTTP_END_ARGS;
705
706 PHP_HTTP_BEGIN_ARGS(setCacheControl, 1)
707 PHP_HTTP_ARG_VAL(cache_control, 0)
708 PHP_HTTP_END_ARGS;
709
710 PHP_HTTP_BEGIN_ARGS(setLastModified, 1)
711 PHP_HTTP_ARG_VAL(last_modified, 0)
712 PHP_HTTP_END_ARGS;
713
714 PHP_HTTP_BEGIN_ARGS(isCachedByLastModified, 0)
715 PHP_HTTP_ARG_VAL(header_name, 0)
716 PHP_HTTP_END_ARGS;
717
718 PHP_HTTP_BEGIN_ARGS(setEtag, 1)
719 PHP_HTTP_ARG_VAL(etag, 0)
720 PHP_HTTP_END_ARGS;
721
722 PHP_HTTP_BEGIN_ARGS(isCachedByEtag, 0)
723 PHP_HTTP_ARG_VAL(header_name, 0)
724 PHP_HTTP_END_ARGS;
725
726 PHP_HTTP_BEGIN_ARGS(setThrottleRate, 1)
727 PHP_HTTP_ARG_VAL(chunk_size, 0)
728 PHP_HTTP_ARG_VAL(delay, 0)
729 PHP_HTTP_END_ARGS;
730
731 PHP_HTTP_EMPTY_ARGS(send);
732
733
734 zend_function_entry php_http_env_response_method_entry[] = {
735 PHP_HTTP_ENV_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
736 PHP_HTTP_ENV_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
737 PHP_HTTP_ENV_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
738 PHP_HTTP_ENV_RESPONSE_ME(setContentEncoding, ZEND_ACC_PUBLIC)
739 PHP_HTTP_ENV_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
740 PHP_HTTP_ENV_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
741 PHP_HTTP_ENV_RESPONSE_ME(isCachedByLastModified, ZEND_ACC_PUBLIC)
742 PHP_HTTP_ENV_RESPONSE_ME(setEtag, ZEND_ACC_PUBLIC)
743 PHP_HTTP_ENV_RESPONSE_ME(isCachedByEtag, ZEND_ACC_PUBLIC)
744 PHP_HTTP_ENV_RESPONSE_ME(setThrottleRate, ZEND_ACC_PUBLIC)
745
746 PHP_HTTP_ENV_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
747
748 EMPTY_FUNCTION_ENTRY
749 };
750
751
752 PHP_METHOD(HttpEnvResponse, __construct)
753 {
754 with_error_handling(EH_THROW, php_http_exception_class_entry) {
755 if (SUCCESS == zend_parse_parameters_none()) {
756 php_http_message_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
757
758 with_error_handling(EH_THROW, php_http_exception_class_entry) {
759 obj->message = php_http_message_init_env(obj->message, PHP_HTTP_RESPONSE TSRMLS_CC);
760 } end_error_handling();
761 }
762 } end_error_handling();
763
764 }
765
766 PHP_METHOD(HttpEnvResponse, setContentType)
767 {
768 char *ct_str = NULL;
769 int ct_len = 0;
770
771 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &ct_str, &ct_len)) {
772 set_option(getThis(), ZEND_STRL("contentType"), IS_STRING, ct_str, ct_len TSRMLS_CC);
773 }
774 }
775
776 PHP_METHOD(HttpEnvResponse, setContentDisposition)
777 {
778 long cd;
779 char *file_str = NULL;
780 int file_len = 0;
781
782 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|s!", &cd, &file_str, &file_len)) {
783 zval *arr;
784
785 MAKE_STD_ZVAL(arr);
786 array_init(arr);
787 add_assoc_long_ex(arr, ZEND_STRS("disposition"), cd);
788 if (file_len) {
789 add_assoc_stringl_ex(arr, ZEND_STRS("filename"), file_str, file_len, 1);
790 }
791 zend_update_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("contentDisposition"), arr TSRMLS_CC);
792 zval_ptr_dtor(&arr);
793 }
794 }
795
796 PHP_METHOD(HttpEnvResponse, setContentEncoding)
797 {
798 long ce;
799
800 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &ce)) {
801 set_option(getThis(), ZEND_STRL("contentEncoding"), IS_LONG, &ce, 0 TSRMLS_CC);
802 }
803 }
804
805 PHP_METHOD(HttpEnvResponse, setCacheControl)
806 {
807 char *cc_str = NULL;
808 int cc_len = 0;
809
810 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &cc_str, &cc_len)) {
811 set_option(getThis(), ZEND_STRL("cacheControl"), IS_STRING, cc_str, cc_len TSRMLS_CC);
812 }
813 }
814
815 PHP_METHOD(HttpEnvResponse, setLastModified)
816 {
817 long last_modified;
818
819 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &last_modified)) {
820 set_option(getThis(), ZEND_STRL("lastModified"), IS_LONG, &last_modified, 0 TSRMLS_CC);
821 }
822 }
823
824 PHP_METHOD(HttpEnvResponse, isCachedByLastModified)
825 {
826 char *header_name_str = NULL;
827 int header_name_len = 0;
828
829 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
830 if (!header_name_str || !header_name_len) {
831 header_name_str = "If-Modified-Since";
832 header_name_len = lenof("If-Modified-Since");
833 }
834 RETURN_LONG(php_http_env_is_response_cached_by_last_modified(getThis(), header_name_str, header_name_len TSRMLS_CC));
835 }
836 RETURN_FALSE;
837 }
838
839 PHP_METHOD(HttpEnvResponse, setEtag)
840 {
841 char *etag_str = NULL;
842 int etag_len = 0;
843
844 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &etag_str, &etag_len)) {
845 set_option(getThis(), ZEND_STRL("etag"), IS_STRING, etag_str, etag_len TSRMLS_CC);
846 }
847 }
848
849 PHP_METHOD(HttpEnvResponse, isCachedByEtag)
850 {
851 char *header_name_str = NULL;
852 int header_name_len = 0;
853
854 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
855 if (!header_name_str || !header_name_len) {
856 header_name_str = "If-None-Match";
857 header_name_len = lenof("If-None-Match");
858 }
859 RETURN_LONG(php_http_env_is_response_cached_by_etag(getThis(), header_name_str, header_name_len TSRMLS_CC));
860 }
861 RETURN_FALSE;
862 }
863
864 PHP_METHOD(HttpEnvResponse, setThrottleRate)
865 {
866 long chunk_size;
867 double delay = 1;
868
869 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|d", &chunk_size, &delay)) {
870 long chunk_size_long = (long) chunk_size;
871
872 set_option(getThis(), ZEND_STRL("throttleDelay"), IS_DOUBLE, &delay, 0 TSRMLS_CC);
873 set_option(getThis(), ZEND_STRL("throttleChunk"), IS_LONG, &chunk_size_long, 0 TSRMLS_CC);
874 RETURN_TRUE;
875 }
876 RETURN_FALSE;
877 }
878
879 PHP_METHOD(HttpEnvResponse, send)
880 {
881 RETVAL_FALSE;
882
883 if (SUCCESS == zend_parse_parameters_none()) {
884 php_http_env_response_t *r = php_http_env_response_init(NULL, getThis() TSRMLS_CC);
885
886 if (r) {
887 RETVAL_SUCCESS(php_http_env_response_send(r));
888 }
889
890 php_http_env_response_free(&r);
891 }
892 }
893
894 PHP_MINIT_FUNCTION(http_env_response)
895 {
896 PHP_HTTP_REGISTER_CLASS(http\\Env, Response, http_env_response, php_http_message_class_entry, 0);
897
898 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_NONE"), PHP_HTTP_CONTENT_DISPOSITION_NONE TSRMLS_CC);
899 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_INLINE"), PHP_HTTP_CONTENT_DISPOSITION_INLINE TSRMLS_CC);
900 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_ATTACHMENT"), PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT TSRMLS_CC);
901
902 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_NONE"), PHP_HTTP_CONTENT_ENCODING_NONE TSRMLS_CC);
903 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_GZIP"), PHP_HTTP_CONTENT_ENCODING_GZIP TSRMLS_CC);
904
905 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_NO"), PHP_HTTP_CACHE_NO TSRMLS_CC);
906 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_HIT"), PHP_HTTP_CACHE_HIT TSRMLS_CC);
907 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_MISS"), PHP_HTTP_CACHE_MISS TSRMLS_CC);
908
909 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentType"), ZEND_ACC_PROTECTED TSRMLS_CC);
910 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentDisposition"), ZEND_ACC_PROTECTED TSRMLS_CC);
911 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentEncoding"), ZEND_ACC_PROTECTED TSRMLS_CC);
912 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("cacheControl"), ZEND_ACC_PROTECTED TSRMLS_CC);
913 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("etag"), ZEND_ACC_PROTECTED TSRMLS_CC);
914 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("lastModified"), ZEND_ACC_PROTECTED TSRMLS_CC);
915 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleDelay"), ZEND_ACC_PROTECTED TSRMLS_CC);
916 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleChunk"), ZEND_ACC_PROTECTED TSRMLS_CC);
917
918 return SUCCESS;
919 }
920
921
922 /*
923 * Local variables:
924 * tab-width: 4
925 * c-basic-offset: 4
926 * End:
927 * vim600: noet sw=4 ts=4 fdm=marker
928 * vim<600: noet sw=4 ts=4
929 */