projects / m6w6 / ext-http / blob
? search:
summary | shortlog | log | commit | commitdiff | tree | github
history | raw | HEAD
separate php_http_env_response and implement content encoding
[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_CC)
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 TSRMLS_CC);
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 TSRMLS_FETCH_FROM_CTX(r->ts);
184
185 PHPWRITE(buf, len);
186
187 /* we really only need to flush when throttling is enabled,
188 because we push the data as fast as possible anyway if not */
189 if (r->throttle.delay >= PHP_HTTP_DIFFSEC) {
190 if (php_output_get_level(TSRMLS_C)) {
191 php_output_flush_all(TSRMLS_C);
192 }
193 if (!(php_output_get_status(TSRMLS_C) & PHP_OUTPUT_IMPLICITFLUSH)) {
194 sapi_flush(TSRMLS_C);
195 }
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 TSRMLS_FETCH_FROM_CTX(r->ts);
205 size_t chunk = r->throttle.chunk ? r->throttle.chunk : PHP_HTTP_SENDBUF_SIZE;
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));
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 zval **zdisposition, **zfilename = NULL;
387
388 zval_ptr_dtor(&zoption);
389 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("disposition"), (void *) &zdisposition)) {
390 zval *zdisposition_copy = php_http_ztyp(IS_LONG, *zdisposition);
391 char *tmp = NULL;
392
393 switch (Z_LVAL_P(zdisposition_copy)) {
394 case PHP_HTTP_CONTENT_DISPOSITION_NONE:
395 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Disposition"), NULL, 1 TSRMLS_CC);
396 case PHP_HTTP_CONTENT_DISPOSITION_INLINE:
397 tmp = "inline";
398 break;
399 case PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT:
400 tmp = "attachment";
401 break;
402 }
403
404 if (tmp) {
405 if (SUCCESS != zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("filename"), (void *) &zfilename)) {
406 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
407 } else {
408 zval *zfilename_copy = php_http_ztyp(IS_STRING, *zfilename);
409
410 if (!Z_STRLEN_P(zfilename_copy)) {
411 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
412 } else {
413 int new_f_len;
414 char *new_f_str = php_addslashes(estrndup(Z_STRVAL_P(zfilename_copy), Z_STRLEN_P(zfilename_copy)), Z_STRLEN_P(zfilename_copy), &new_f_len, 0 TSRMLS_CC);
415
416 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s; filename=\"%.*s\"", tmp, new_f_len, new_f_str);
417 STR_FREE(new_f_str);
418 }
419
420 zval_ptr_dtor(&zfilename_copy);
421 }
422 }
423 zval_ptr_dtor(&zdisposition_copy);
424 }
425 zval_ptr_dtor(&zoption_copy);
426 }
427
428 if (ret != SUCCESS) {
429 return ret;
430 }
431
432 if ((zoption = get_option(options, ZEND_STRL("contentEncoding") TSRMLS_CC))) {
433 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
434 zval zsupported;
435 HashTable *result = NULL;
436
437 zval_ptr_dtor(&zoption);
438 switch (Z_LVAL_P(zoption_copy)) {
439 case PHP_HTTP_CONTENT_ENCODING_GZIP:
440 INIT_PZVAL(&zsupported);
441 array_init(&zsupported);
442 add_next_index_stringl(&zsupported, ZEND_STRL("none"), 1);
443 add_next_index_stringl(&zsupported, ZEND_STRL("gzip"), 1);
444 add_next_index_stringl(&zsupported, ZEND_STRL("deflate"), 1);
445
446 if ((result = php_http_negotiate_encoding(Z_ARRVAL(zsupported) TSRMLS_CC))) {
447 char *key_str = NULL;
448 uint key_len = 0;
449
450 zend_hash_internal_pointer_reset(result);
451 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key_str, &key_len, NULL, 0, NULL)) {
452 if (!strcmp(key_str, "gzip")) {
453 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_GZIP))) {
454 ret = FAILURE;
455 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: gzip"), 1 TSRMLS_CC))) {
456 r->content.encoding = estrndup(key_str, key_len - 1);
457 }
458 } else if (!strcmp(key_str, "deflate")) {
459 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_ZLIB))) {
460 ret = FAILURE;
461 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: deflate"), 1 TSRMLS_CC))) {
462 r->content.encoding = estrndup(key_str, key_len - 1);
463 }
464 } else {
465 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
466 }
467
468 if (SUCCESS == ret) {
469 ret = php_http_env_set_response_header(0, ZEND_STRL("Vary: Accept-Encoding"), 0 TSRMLS_CC);
470 }
471 }
472
473 zend_hash_destroy(result);
474 FREE_HASHTABLE(result);
475 }
476
477 zval_dtor(&zsupported);
478 break;
479
480 case PHP_HTTP_CONTENT_ENCODING_NONE:
481 default:
482 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
483 break;
484 }
485 zval_ptr_dtor(&zoption_copy);
486 }
487
488 if (SUCCESS != ret) {
489 return ret;
490 }
491
492 switch (php_http_env_is_response_cached_by_etag(options, ZEND_STRL("If-None-Match"))) {
493 case PHP_HTTP_CACHE_MISS:
494 break;
495
496 case PHP_HTTP_CACHE_NO:
497 if (PHP_HTTP_CACHE_HIT != php_http_env_is_response_cached_by_last_modified(options, ZEND_STRL("If-Modified-Since"))) {
498 break;
499 }
500
501 case PHP_HTTP_CACHE_HIT:
502 ret = php_http_env_set_response_code(304 TSRMLS_CC);
503 r->done = 1;
504 break;
505 }
506
507 if ((zoption = get_option(options, ZEND_STRL("etag") TSRMLS_CC))) {
508 ret = php_http_env_set_response_header_value(0, ZEND_STRL("ETag"), zoption, 1 TSRMLS_CC);
509 zval_ptr_dtor(&zoption);
510 }
511 if ((zoption = get_option(options, ZEND_STRL("lastModified") TSRMLS_CC))) {
512 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
513
514 zval_ptr_dtor(&zoption);
515 if (Z_LVAL_P(zoption_copy)) {
516 char *date = php_format_date(ZEND_STRL(PHP_HTTP_DATE_FORMAT), Z_LVAL_P(zoption_copy), 0 TSRMLS_CC);
517 if (date) {
518 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Last-Modified: %s", date);
519 efree(date);
520 }
521 }
522 zval_ptr_dtor(&zoption_copy);
523 }
524 }
525
526 return ret;
527 }
528
529 static STATUS php_http_env_response_send_body(php_http_env_response_t *r)
530 {
531 STATUS ret = SUCCESS;
532 zval *zbody;
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
613 /* check for ranges */
614 if ( (zbody = get_option(r->options, ZEND_STRL("body") TSRMLS_CC))
615 && (Z_TYPE_P(zbody) == IS_OBJECT)
616 && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
617 ) {
618 php_http_message_body_object_t *obj = zend_object_store_get_object(zbody TSRMLS_CC);
619
620 r->content.length = php_http_message_body_size(obj->body);
621 zval_ptr_dtor(&zbody);
622
623 if (SUCCESS != php_http_env_set_response_header(0, ZEND_STRL("Accept-Ranges: bytes"), 1 TSRMLS_CC)) {
624 return FAILURE;
625 } else {
626 zend_hash_init(&r->range.values, 0, NULL, ZVAL_PTR_DTOR, 0);
627 r->range.status = php_http_env_get_request_ranges(&r->range.values, r->content.length TSRMLS_CC);
628
629 switch (r->range.status) {
630 case PHP_HTTP_RANGE_NO:
631 zend_hash_destroy(&r->range.values);
632 break;
633
634 case PHP_HTTP_RANGE_ERR:
635 if (php_http_env_got_request_header(ZEND_STRL("If-Range") TSRMLS_CC)) {
636 r->range.status = PHP_HTTP_RANGE_NO;
637 zend_hash_destroy(&r->range.values);
638 } else {
639 r->done = 1;
640 zend_hash_destroy(&r->range.values);
641 if (SUCCESS != php_http_env_set_response_header_format(416, 1 TSRMLS_CC, "Content-Range: bytes */%zu", r->content.length)) {
642 return FAILURE;
643 }
644 }
645 break;
646
647 case PHP_HTTP_RANGE_OK:
648 if (PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_etag(r->options, ZEND_STRL("If-Range") TSRMLS_CC)
649 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("If-Range") TSRMLS_CC)
650 ) {
651 r->range.status = PHP_HTTP_RANGE_NO;
652 zend_hash_destroy(&r->range.values);
653 break;
654 }
655 if (PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_etag(r->options, ZEND_STRL("If-Match") TSRMLS_CC)
656 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("If-Unmodified-Since") TSRMLS_CC)
657 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("Unless-Modified-Since") TSRMLS_CC)
658 ) {
659 r->done = 1;
660 zend_hash_destroy(&r->range.values);
661 if (SUCCESS != php_http_env_set_response_code(412 TSRMLS_CC)) {
662 return FAILURE;
663 }
664 break;
665 }
666 }
667 }
668 } else if (zbody) {
669 zval_ptr_dtor(&zbody);
670 }
671
672 if (SUCCESS != php_http_env_response_send_head(r)) {
673 return FAILURE;
674 }
675
676 if (SUCCESS != php_http_env_response_send_body(r)) {
677 return FAILURE;
678 }
679 return SUCCESS;
680 }
681
682 zend_class_entry *php_http_env_response_class_entry;
683
684 #undef PHP_HTTP_BEGIN_ARGS
685 #undef PHP_HTTP_EMPTY_ARGS
686 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpEnvResponse, method, 0, req_args)
687 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpEnvResponse, method, 0)
688 #define PHP_HTTP_ENV_RESPONSE_ME(method, visibility) PHP_ME(HttpEnvResponse, method, PHP_HTTP_ARGS(HttpEnvResponse, method), visibility)
689
690 PHP_HTTP_EMPTY_ARGS(__construct);
691
692 PHP_HTTP_BEGIN_ARGS(setContentType, 1)
693 PHP_HTTP_ARG_VAL(content_type, 0)
694 PHP_HTTP_END_ARGS;
695
696 PHP_HTTP_BEGIN_ARGS(setContentEncoding, 1)
697 PHP_HTTP_ARG_VAL(content_encoding, 0)
698 PHP_HTTP_END_ARGS;
699
700 PHP_HTTP_BEGIN_ARGS(setContentDisposition, 1)
701 PHP_HTTP_ARG_VAL(content_disposition, 0)
702 PHP_HTTP_ARG_VAL(filename, 0)
703 PHP_HTTP_END_ARGS;
704
705 PHP_HTTP_BEGIN_ARGS(setCacheControl, 1)
706 PHP_HTTP_ARG_VAL(cache_control, 0)
707 PHP_HTTP_END_ARGS;
708
709 PHP_HTTP_BEGIN_ARGS(setLastModified, 1)
710 PHP_HTTP_ARG_VAL(last_modified, 0)
711 PHP_HTTP_END_ARGS;
712
713 PHP_HTTP_BEGIN_ARGS(isCachedByLastModified, 0)
714 PHP_HTTP_ARG_VAL(header_name, 0)
715 PHP_HTTP_END_ARGS;
716
717 PHP_HTTP_BEGIN_ARGS(setEtag, 1)
718 PHP_HTTP_ARG_VAL(etag, 0)
719 PHP_HTTP_END_ARGS;
720
721 PHP_HTTP_BEGIN_ARGS(isCachedByEtag, 0)
722 PHP_HTTP_ARG_VAL(header_name, 0)
723 PHP_HTTP_END_ARGS;
724
725 PHP_HTTP_BEGIN_ARGS(setThrottleRate, 1)
726 PHP_HTTP_ARG_VAL(chunk_size, 0)
727 PHP_HTTP_ARG_VAL(delay, 0)
728 PHP_HTTP_END_ARGS;
729
730 PHP_HTTP_EMPTY_ARGS(send);
731
732
733 zend_function_entry php_http_env_response_method_entry[] = {
734 PHP_HTTP_ENV_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
735 PHP_HTTP_ENV_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
736 PHP_HTTP_ENV_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
737 PHP_HTTP_ENV_RESPONSE_ME(setContentEncoding, ZEND_ACC_PUBLIC)
738 PHP_HTTP_ENV_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
739 PHP_HTTP_ENV_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
740 PHP_HTTP_ENV_RESPONSE_ME(isCachedByLastModified, ZEND_ACC_PUBLIC)
741 PHP_HTTP_ENV_RESPONSE_ME(setEtag, ZEND_ACC_PUBLIC)
742 PHP_HTTP_ENV_RESPONSE_ME(isCachedByEtag, ZEND_ACC_PUBLIC)
743 PHP_HTTP_ENV_RESPONSE_ME(setThrottleRate, ZEND_ACC_PUBLIC)
744
745 PHP_HTTP_ENV_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
746
747 EMPTY_FUNCTION_ENTRY
748 };
749
750
751 PHP_METHOD(HttpEnvResponse, __construct)
752 {
753 with_error_handling(EH_THROW, php_http_exception_class_entry) {
754 if (SUCCESS == zend_parse_parameters_none()) {
755 php_http_message_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
756
757 with_error_handling(EH_THROW, php_http_exception_class_entry) {
758 obj->message = php_http_message_init_env(obj->message, PHP_HTTP_RESPONSE TSRMLS_CC);
759 } end_error_handling();
760 }
761 } end_error_handling();
762
763 }
764
765 PHP_METHOD(HttpEnvResponse, setContentType)
766 {
767 char *ct_str = NULL;
768 int ct_len = 0;
769
770 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &ct_str, &ct_len)) {
771 set_option(getThis(), ZEND_STRL("contentType"), IS_STRING, ct_str, ct_len TSRMLS_CC);
772 }
773 }
774
775 PHP_METHOD(HttpEnvResponse, setContentDisposition)
776 {
777 long cd;
778 char *file_str = NULL;
779 int file_len = 0;
780
781 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|s!", &cd, &file_str, &file_len)) {
782 zval *arr;
783
784 MAKE_STD_ZVAL(arr);
785 array_init(arr);
786 add_assoc_long_ex(arr, ZEND_STRS("disposition"), cd);
787 if (file_len) {
788 add_assoc_stringl_ex(arr, ZEND_STRS("filename"), file_str, file_len, 1);
789 }
790 zend_update_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("contentDisposition"), arr);
791 zval_ptr_dtor(&arr);
792 }
793 }
794
795 PHP_METHOD(HttpEnvResponse, setContentEncoding)
796 {
797 long ce;
798
799 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &ce)) {
800 set_option(getThis(), ZEND_STRL("contentEncoding"), IS_LONG, &ce, 0 TSRMLS_CC);
801 }
802 }
803
804 PHP_METHOD(HttpEnvResponse, setCacheControl)
805 {
806 char *cc_str = NULL;
807 int cc_len = 0;
808
809 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &cc_str, &cc_len)) {
810 set_option(getThis(), ZEND_STRL("cacheControl"), IS_STRING, cc_str, cc_len TSRMLS_CC);
811 }
812 }
813
814 PHP_METHOD(HttpEnvResponse, setLastModified)
815 {
816 long last_modified;
817
818 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &last_modified)) {
819 set_option(getThis(), ZEND_STRL("lastModified"), IS_LONG, &last_modified, 0 TSRMLS_CC);
820 }
821 }
822
823 PHP_METHOD(HttpEnvResponse, isCachedByLastModified)
824 {
825 char *header_name_str = NULL;
826 int header_name_len = 0;
827
828 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
829 if (!header_name_str || !header_name_len) {
830 header_name_str = "If-Modified-Since";
831 header_name_len = lenof("If-Modified-Since");
832 }
833 RETURN_LONG(php_http_env_is_response_cached_by_last_modified(getThis(), header_name_str, header_name_len TSRMLS_CC));
834 }
835 RETURN_FALSE;
836 }
837
838 PHP_METHOD(HttpEnvResponse, setEtag)
839 {
840 char *etag_str = NULL;
841 int etag_len = 0;
842
843 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &etag_str, &etag_len)) {
844 set_option(getThis(), ZEND_STRL("etag"), IS_STRING, etag_str, etag_len TSRMLS_CC);
845 }
846 }
847
848 PHP_METHOD(HttpEnvResponse, isCachedByEtag)
849 {
850 char *header_name_str = NULL;
851 int header_name_len = 0;
852
853 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &header_name_str, &header_name_len)) {
854 if (!header_name_str || !header_name_len) {
855 header_name_str = "If-None-Match";
856 header_name_len = lenof("If-None-Match");
857 }
858 RETURN_LONG(php_http_env_is_response_cached_by_etag(getThis(), header_name_str, header_name_len TSRMLS_CC));
859 }
860 RETURN_FALSE;
861 }
862
863 PHP_METHOD(HttpEnvResponse, setThrottleRate)
864 {
865 long chunk_size;
866 double delay = 1;
867
868 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|d", &chunk_size, &delay)) {
869 long chunk_size_long = (long) chunk_size;
870
871 set_option(getThis(), ZEND_STRL("throttleDelay"), IS_DOUBLE, &delay, 0 TSRMLS_CC);
872 set_option(getThis(), ZEND_STRL("throttleChunk"), IS_LONG, &chunk_size_long, 0 TSRMLS_CC);
873 RETURN_TRUE;
874 }
875 RETURN_FALSE;
876 }
877
878 PHP_METHOD(HttpEnvResponse, send)
879 {
880 RETVAL_FALSE;
881
882 if (SUCCESS == zend_parse_parameters_none()) {
883 php_http_env_response_t *r = php_http_env_response_init(NULL, getThis() TSRMLS_CC);
884
885 if (r) {
886 RETVAL_SUCCESS(php_http_env_response_send(r));
887 }
888
889 php_http_env_response_free(&r);
890 }
891 }
892
893 PHP_MINIT_FUNCTION(http_env_response)
894 {
895 PHP_HTTP_REGISTER_CLASS(http\\env, Response, http_env_response, php_http_message_class_entry, 0);
896
897 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_NONE"), PHP_HTTP_CONTENT_DISPOSITION_NONE TSRMLS_CC);
898 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_INLINE"), PHP_HTTP_CONTENT_DISPOSITION_INLINE TSRMLS_CC);
899 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_ATTACHMENT"), PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT TSRMLS_CC);
900
901 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_NONE"), PHP_HTTP_CONTENT_ENCODING_NONE TSRMLS_CC);
902 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_GZIP"), PHP_HTTP_CONTENT_ENCODING_GZIP TSRMLS_CC);
903
904 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_NO"), PHP_HTTP_CACHE_NO TSRMLS_CC);
905 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_HIT"), PHP_HTTP_CACHE_HIT TSRMLS_CC);
906 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_MISS"), PHP_HTTP_CACHE_MISS TSRMLS_CC);
907
908 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentType"), ZEND_ACC_PROTECTED TSRMLS_CC);
909 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentDisposition"), ZEND_ACC_PROTECTED TSRMLS_CC);
910 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentEncoding"), ZEND_ACC_PROTECTED TSRMLS_CC);
911 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("cacheControl"), ZEND_ACC_PROTECTED TSRMLS_CC);
912 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("etag"), ZEND_ACC_PROTECTED TSRMLS_CC);
913 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("lastModified"), ZEND_ACC_PROTECTED TSRMLS_CC);
914 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleDelay"), ZEND_ACC_PROTECTED TSRMLS_CC);
915 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleChunk"), ZEND_ACC_PROTECTED TSRMLS_CC);
916
917 return SUCCESS;
918 }
919
920
921 /*
922 * Local variables:
923 * tab-width: 4
924 * c-basic-offset: 4
925 * End:
926 * vim600: noet sw=4 ts=4 fdm=marker
927 * vim<600: noet sw=4 ts=4
928 */
Extended HTTP Support