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