projects / m6w6 / ext-http / blob
? search:
summary | shortlog | log | commit | commitdiff | tree | github
history | raw | HEAD
fix wrong assumption in php_http_env_is_response_cached_by_*
[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_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_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_output_get_level(TSRMLS_C)) {
186 php_output_flush_all(TSRMLS_C);
187 }
188 if (!(php_output_get_status(TSRMLS_C) & PHP_OUTPUT_IMPLICITFLUSH)) {
189 sapi_flush(TSRMLS_C);
190 }
191 php_http_sleep(r->throttle.delay);
192 }
193 return len;
194 }
195
196 #define php_http_env_response_send_done(r) php_http_env_response_send_data((r), NULL, 0)
197 static STATUS php_http_env_response_send_data(php_http_env_response_t *r, const char *buf, size_t len)
198 {
199 TSRMLS_FETCH_FROM_CTX(r->ts);
200 size_t chunk = r->throttle.chunk ? r->throttle.chunk : PHP_HTTP_SENDBUF_SIZE;
201
202 if (r->content.encoder) {
203 char *enc_str = NULL;
204 size_t enc_len = 0;
205
206 if (buf) {
207 if (SUCCESS != php_http_encoding_stream_update(r->content.encoder, buf, len, &enc_str, &enc_len)) {
208 return FAILURE;
209 }
210 } else {
211 if (SUCCESS != php_http_encoding_stream_finish(r->content.encoder, &enc_str, &enc_len)) {
212 return FAILURE;
213 }
214 }
215
216 if (enc_str) {
217 php_http_buffer_chunked_output(&r->buffer, enc_str, enc_len, buf ? chunk : 0, output, r TSRMLS_CC);
218 STR_FREE(enc_str);
219 }
220 } else {
221 php_http_buffer_chunked_output(&r->buffer, buf, len, buf ? chunk : 0, output, r TSRMLS_CC);
222 }
223
224 return SUCCESS;
225 }
226
227 PHP_HTTP_API php_http_env_response_t *php_http_env_response_init(php_http_env_response_t *r, zval *options TSRMLS_DC)
228 {
229 php_http_env_response_t *free_r = NULL;
230
231 if (!r) {
232 r = free_r = emalloc(sizeof(*r));
233 }
234 memset(r, 0, sizeof(*r));
235
236 r->buffer = php_http_buffer_init(NULL);
237
238 Z_ADDREF_P(options);
239 r->options = options;
240
241 TSRMLS_SET_CTX(r->ts);
242
243 return r;
244 }
245
246 PHP_HTTP_API void php_http_env_response_dtor(php_http_env_response_t *r)
247 {
248 php_http_buffer_free(&r->buffer);
249 zval_ptr_dtor(&r->options);
250 STR_FREE(r->content.type);
251 STR_FREE(r->content.encoding);
252 if (r->content.encoder) {
253 php_http_encoding_stream_free(&r->content.encoder);
254 }
255 }
256
257 PHP_HTTP_API void php_http_env_response_free(php_http_env_response_t **r)
258 {
259 if (*r) {
260 php_http_env_response_dtor(*r);
261 efree(*r);
262 *r = NULL;
263 }
264 }
265
266 static STATUS php_http_env_response_send_head(php_http_env_response_t *r)
267 {
268 STATUS ret = SUCCESS;
269 zval *zoption, *options = r->options;
270 TSRMLS_FETCH_FROM_CTX(r->ts);
271
272 if (r->done) {
273 return ret;
274 }
275
276 if ((zoption = get_option(options, ZEND_STRL("responseCode") TSRMLS_CC))) {
277 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
278
279 zval_ptr_dtor(&zoption);
280 if (Z_LVAL_P(zoption_copy) > 0) {
281 ret = php_http_env_set_response_code(Z_LVAL_P(zoption_copy) TSRMLS_CC);
282 }
283 zval_ptr_dtor(&zoption_copy);
284 }
285
286 if (ret != SUCCESS) {
287 return ret;
288 }
289
290 if ((zoption = get_option(options, ZEND_STRL("httpVersion") TSRMLS_CC))) {
291 php_http_version_t v;
292 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
293
294 zval_ptr_dtor(&zoption);
295 if (Z_STRLEN_P(zoption_copy) && php_http_version_parse(&v, Z_STRVAL_P(zoption_copy) TSRMLS_CC)) {
296 ret = php_http_env_set_response_protocol_version(&v TSRMLS_CC);
297 php_http_version_dtor(&v);
298 }
299 zval_ptr_dtor(&zoption_copy);
300 }
301
302 if (ret != SUCCESS) {
303 return ret;
304 }
305
306 if ((zoption = get_option(options, ZEND_STRL("headers") TSRMLS_CC))) {
307 if (Z_TYPE_P(zoption) == IS_ARRAY) {
308 zval **val;
309 HashPosition pos;
310 php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
311
312 FOREACH_KEYVAL(pos, zoption, key, val) {
313 if (key.type == HASH_KEY_IS_STRING) {
314 if (SUCCESS != (ret = php_http_env_set_response_header_value(0, key.str, key.len - 1, *val, 1 TSRMLS_CC))) {
315 break;
316 }
317 }
318 }
319 }
320 zval_ptr_dtor(&zoption);
321 }
322
323 if (ret != SUCCESS) {
324 return ret;
325 }
326
327 if ((zoption = get_option(options, ZEND_STRL("contentType") TSRMLS_CC))) {
328 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
329
330 zval_ptr_dtor(&zoption);
331 if (Z_STRLEN_P(zoption_copy)) {
332 PHP_HTTP_CHECK_CONTENT_TYPE(Z_STRVAL_P(zoption_copy), ret = FAILURE) else {
333 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)))) {
334 r->content.type = estrndup(Z_STRVAL_P(zoption_copy), Z_STRLEN_P(zoption_copy));
335 }
336 }
337 }
338 zval_ptr_dtor(&zoption_copy);
339 }
340
341 if (ret != SUCCESS) {
342 return ret;
343 }
344
345 if (r->range.status == PHP_HTTP_RANGE_OK) {
346 if (zend_hash_num_elements(&r->range.values) == 1) {
347 zval **range, **begin, **end;
348
349 if (SUCCESS != zend_hash_index_find(&r->range.values, 0, (void *) &range)
350 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin)
351 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)
352 ) {
353 /* this should never happen */
354 zend_hash_destroy(&r->range.values);
355 php_http_env_set_response_code(500 TSRMLS_CC);
356 ret = FAILURE;
357 } else {
358 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);
359 }
360 } else {
361 php_http_boundary(r->range.boundary, sizeof(r->range.boundary) TSRMLS_CC);
362 ret = php_http_env_set_response_header_format(206, 1 TSRMLS_CC, "Content-Type: multipart/byteranges; boundary=%s", r->range.boundary);
363 }
364 } else {
365 if ((zoption = get_option(options, ZEND_STRL("cacheControl") TSRMLS_CC))) {
366 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
367
368 zval_ptr_dtor(&zoption);
369 if (Z_STRLEN_P(zoption_copy)) {
370 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);
371 }
372 zval_ptr_dtor(&zoption_copy);
373 }
374
375 if (ret != SUCCESS) {
376 return ret;
377 }
378
379 if ((zoption = get_option(options, ZEND_STRL("contentDisposition") TSRMLS_CC))) {
380 zval *zoption_copy = php_http_ztyp(IS_ARRAY, zoption);
381 zval **zdisposition, **zfilename = NULL;
382
383 zval_ptr_dtor(&zoption);
384 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("disposition"), (void *) &zdisposition)) {
385 zval *zdisposition_copy = php_http_ztyp(IS_LONG, *zdisposition);
386 char *tmp = NULL;
387
388 switch (Z_LVAL_P(zdisposition_copy)) {
389 case PHP_HTTP_CONTENT_DISPOSITION_NONE:
390 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Disposition"), NULL, 1 TSRMLS_CC);
391 break;
392 case PHP_HTTP_CONTENT_DISPOSITION_INLINE:
393 tmp = "inline";
394 break;
395 case PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT:
396 tmp = "attachment";
397 break;
398 }
399
400 if (tmp) {
401 if (SUCCESS != zend_hash_find(Z_ARRVAL_P(zoption_copy), ZEND_STRS("filename"), (void *) &zfilename)) {
402 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
403 } else {
404 zval *zfilename_copy = php_http_ztyp(IS_STRING, *zfilename);
405
406 if (!Z_STRLEN_P(zfilename_copy)) {
407 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s", tmp);
408 } else {
409 int new_f_len;
410 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, 1 TSRMLS_CC);
411
412 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Content-Disposition: %s; filename=\"%.*s\"", tmp, new_f_len, new_f_str);
413 STR_FREE(new_f_str);
414 }
415
416 zval_ptr_dtor(&zfilename_copy);
417 }
418 }
419 zval_ptr_dtor(&zdisposition_copy);
420 }
421 zval_ptr_dtor(&zoption_copy);
422 }
423
424 if (ret != SUCCESS) {
425 return ret;
426 }
427
428 if ((zoption = get_option(options, ZEND_STRL("contentEncoding") TSRMLS_CC))) {
429 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
430 zval zsupported;
431 HashTable *result = NULL;
432
433 zval_ptr_dtor(&zoption);
434 switch (Z_LVAL_P(zoption_copy)) {
435 case PHP_HTTP_CONTENT_ENCODING_GZIP:
436 INIT_PZVAL(&zsupported);
437 array_init(&zsupported);
438 add_next_index_stringl(&zsupported, ZEND_STRL("none"), 1);
439 add_next_index_stringl(&zsupported, ZEND_STRL("gzip"), 1);
440 add_next_index_stringl(&zsupported, ZEND_STRL("deflate"), 1);
441
442 if ((result = php_http_negotiate_encoding(Z_ARRVAL(zsupported) TSRMLS_CC))) {
443 char *key_str = NULL;
444 uint key_len = 0;
445
446 zend_hash_internal_pointer_reset(result);
447 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key_str, &key_len, NULL, 0, NULL)) {
448 if (!strcmp(key_str, "gzip")) {
449 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_GZIP TSRMLS_CC))) {
450 ret = FAILURE;
451 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: gzip"), 1 TSRMLS_CC))) {
452 r->content.encoding = estrndup(key_str, key_len - 1);
453 }
454 } else if (!strcmp(key_str, "deflate")) {
455 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_ZLIB TSRMLS_CC))) {
456 ret = FAILURE;
457 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: deflate"), 1 TSRMLS_CC))) {
458 r->content.encoding = estrndup(key_str, key_len - 1);
459 }
460 } else {
461 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
462 }
463
464 if (SUCCESS == ret) {
465 ret = php_http_env_set_response_header(0, ZEND_STRL("Vary: Accept-Encoding"), 0 TSRMLS_CC);
466 }
467 }
468
469 zend_hash_destroy(result);
470 FREE_HASHTABLE(result);
471 }
472
473 zval_dtor(&zsupported);
474 break;
475
476 case PHP_HTTP_CONTENT_ENCODING_NONE:
477 default:
478 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
479 break;
480 }
481 zval_ptr_dtor(&zoption_copy);
482 }
483
484 if (SUCCESS != ret) {
485 return ret;
486 }
487
488 if (php_http_env_get_response_code(TSRMLS_C) < 400 && !php_http_env_got_request_header(ZEND_STRL("Authorization") TSRMLS_CC)
489 && ( !SG(request_info).request_method
490 || !strcasecmp(SG(request_info).request_method, "GET")
491 || !strcasecmp(SG(request_info).request_method, "HEAD")
492 )
493 ) {
494 switch (php_http_env_is_response_cached_by_etag(options, ZEND_STRL("If-None-Match") TSRMLS_CC)) {
495 case PHP_HTTP_CACHE_MISS:
496 break;
497
498 case PHP_HTTP_CACHE_NO:
499 if (PHP_HTTP_CACHE_HIT != php_http_env_is_response_cached_by_last_modified(options, ZEND_STRL("If-Modified-Since") TSRMLS_CC)) {
500 break;
501 }
502 /* no break */
503
504 case PHP_HTTP_CACHE_HIT:
505 ret = php_http_env_set_response_code(304 TSRMLS_CC);
506 r->done = 1;
507 break;
508 }
509
510 if ((zoption = get_option(options, ZEND_STRL("etag") TSRMLS_CC))) {
511 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
512
513 zval_ptr_dtor(&zoption);
514 if (*Z_STRVAL_P(zoption_copy) != '"' && strncmp(Z_STRVAL_P(zoption_copy), "W/\"", 3)) {
515 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "ETag: \"%s\"", Z_STRVAL_P(zoption_copy));
516 } else {
517 ret = php_http_env_set_response_header_value(0, ZEND_STRL("ETag"), zoption_copy, 1 TSRMLS_CC);
518 }
519 zval_ptr_dtor(&zoption_copy);
520 }
521 if ((zoption = get_option(options, ZEND_STRL("lastModified") TSRMLS_CC))) {
522 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
523
524 zval_ptr_dtor(&zoption);
525 if (Z_LVAL_P(zoption_copy)) {
526 char *date = php_format_date(ZEND_STRL(PHP_HTTP_DATE_FORMAT), Z_LVAL_P(zoption_copy), 0 TSRMLS_CC);
527 if (date) {
528 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Last-Modified: %s", date);
529 efree(date);
530 }
531 }
532 zval_ptr_dtor(&zoption_copy);
533 }
534 }
535 }
536
537 return ret;
538 }
539
540 static STATUS php_http_env_response_send_body(php_http_env_response_t *r)
541 {
542 STATUS ret = SUCCESS;
543 zval *zbody;
544 TSRMLS_FETCH_FROM_CTX(r->ts);
545
546 if (r->done) {
547 return ret;
548 }
549
550 if ( (zbody = get_option(r->options, ZEND_STRL("body") TSRMLS_CC))
551 && (Z_TYPE_P(zbody) == IS_OBJECT)
552 && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
553 ) {
554 php_http_message_body_object_t *obj = zend_object_store_get_object(zbody TSRMLS_CC);
555
556 if (r->range.status == PHP_HTTP_RANGE_OK) {
557 if (zend_hash_num_elements(&r->range.values) == 1) {
558 /* single range */
559 zval **range, **begin, **end;
560
561 if (SUCCESS != zend_hash_index_find(&r->range.values, 0, (void *) &range)
562 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin)
563 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)
564 ) {
565 /* this should never happen */
566 zend_hash_destroy(&r->range.values);
567 php_http_env_set_response_code(500 TSRMLS_CC);
568 ret = FAILURE;
569 } else {
570 /* send chunk */
571 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);
572 php_http_env_response_send_done(r);
573 zend_hash_destroy(&r->range.values);
574 ret = SUCCESS;
575 }
576 } else {
577 /* send multipart/byte-ranges message */
578 HashPosition pos;
579 zval **chunk;
580
581 FOREACH_HASH_VAL(pos, &r->range.values, chunk) {
582 zval **begin, **end;
583
584 if (IS_ARRAY == Z_TYPE_PP(chunk)
585 && SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(chunk), 0, (void *) &begin)
586 && IS_LONG == Z_TYPE_PP(begin)
587 && SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(chunk), 1, (void *) &end)
588 && IS_LONG == Z_TYPE_PP(end)
589 ) {
590 php_http_buffer_appendf(r->buffer,
591 PHP_HTTP_CRLF
592 "--%s" PHP_HTTP_CRLF
593 "Content-Type: %s" PHP_HTTP_CRLF
594 "Content-Range: bytes %ld-%ld/%zu" PHP_HTTP_CRLF PHP_HTTP_CRLF,
595 /* - */
596 r->range.boundary,
597 r->content.type ? r->content.type : "application/octet-stream",
598 Z_LVAL_PP(begin),
599 Z_LVAL_PP(end),
600 r->content.length
601 );
602 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);
603 }
604 }
605 php_http_buffer_appendf(r->buffer, PHP_HTTP_CRLF "--%s--", r->range.boundary);
606 php_http_env_response_send_done(r);
607 zend_hash_destroy(&r->range.values);
608 }
609
610 } else {
611 php_http_message_body_to_callback(obj->body, (php_http_pass_callback_t) php_http_env_response_send_data, r, 0, 0);
612 php_http_env_response_send_done(r);
613 }
614 }
615 if (zbody) {
616 zval_ptr_dtor(&zbody);
617 }
618 return ret;
619 }
620
621 PHP_HTTP_API STATUS php_http_env_response_send(php_http_env_response_t *r)
622 {
623 zval *zbody;
624 TSRMLS_FETCH_FROM_CTX(r->ts);
625
626 /* check for ranges */
627 if ( (zbody = get_option(r->options, ZEND_STRL("body") TSRMLS_CC))
628 && (Z_TYPE_P(zbody) == IS_OBJECT)
629 && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_class_entry TSRMLS_CC)
630 ) {
631 php_http_message_body_object_t *obj = zend_object_store_get_object(zbody TSRMLS_CC);
632
633 r->content.length = php_http_message_body_size(obj->body);
634 zval_ptr_dtor(&zbody);
635
636 if (SUCCESS != php_http_env_set_response_header(0, ZEND_STRL("Accept-Ranges: bytes"), 1 TSRMLS_CC)) {
637 return FAILURE;
638 } else {
639 zend_hash_init(&r->range.values, 0, NULL, ZVAL_PTR_DTOR, 0);
640 r->range.status = php_http_env_get_request_ranges(&r->range.values, r->content.length TSRMLS_CC);
641
642 switch (r->range.status) {
643 case PHP_HTTP_RANGE_NO:
644 zend_hash_destroy(&r->range.values);
645 break;
646
647 case PHP_HTTP_RANGE_ERR:
648 if (php_http_env_got_request_header(ZEND_STRL("If-Range") TSRMLS_CC)) {
649 r->range.status = PHP_HTTP_RANGE_NO;
650 zend_hash_destroy(&r->range.values);
651 } else {
652 r->done = 1;
653 zend_hash_destroy(&r->range.values);
654 if (SUCCESS != php_http_env_set_response_header_format(416, 1 TSRMLS_CC, "Content-Range: bytes */%zu", r->content.length)) {
655 return FAILURE;
656 }
657 }
658 break;
659
660 case PHP_HTTP_RANGE_OK:
661 if (PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_etag(r->options, ZEND_STRL("If-Range") TSRMLS_CC)
662 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("If-Range") TSRMLS_CC)
663 ) {
664 r->range.status = PHP_HTTP_RANGE_NO;
665 zend_hash_destroy(&r->range.values);
666 break;
667 }
668 if (PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_etag(r->options, ZEND_STRL("If-Match") TSRMLS_CC)
669 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("If-Unmodified-Since") TSRMLS_CC)
670 || PHP_HTTP_CACHE_MISS == php_http_env_is_response_cached_by_last_modified(r->options, ZEND_STRL("Unless-Modified-Since") TSRMLS_CC)
671 ) {
672 r->done = 1;
673 zend_hash_destroy(&r->range.values);
674 if (SUCCESS != php_http_env_set_response_code(412 TSRMLS_CC)) {
675 return FAILURE;
676 }
677 break;
678 }
679
680 break;
681 }
682 }
683 } else if (zbody) {
684 zval_ptr_dtor(&zbody);
685 }
686
687 if (SUCCESS != php_http_env_response_send_head(r)) {
688 return FAILURE;
689 }
690
691 if (SUCCESS != php_http_env_response_send_body(r)) {
692 return FAILURE;
693 }
694 return SUCCESS;
695 }
696
697 zend_class_entry *php_http_env_response_class_entry;
698
699 #undef PHP_HTTP_BEGIN_ARGS
700 #undef PHP_HTTP_EMPTY_ARGS
701 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpEnvResponse, method, 0, req_args)
702 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpEnvResponse, method, 0)
703 #define PHP_HTTP_ENV_RESPONSE_ME(method, visibility) PHP_ME(HttpEnvResponse, method, PHP_HTTP_ARGS(HttpEnvResponse, method), visibility)
704
705 PHP_HTTP_EMPTY_ARGS(__construct);
706
707 PHP_HTTP_BEGIN_ARGS(setContentType, 1)
708 PHP_HTTP_ARG_VAL(content_type, 0)
709 PHP_HTTP_END_ARGS;
710
711 PHP_HTTP_BEGIN_ARGS(setContentEncoding, 1)
712 PHP_HTTP_ARG_VAL(content_encoding, 0)
713 PHP_HTTP_END_ARGS;
714
715 PHP_HTTP_BEGIN_ARGS(setContentDisposition, 1)
716 PHP_HTTP_ARG_VAL(content_disposition, 0)
717 PHP_HTTP_ARG_VAL(filename, 0)
718 PHP_HTTP_END_ARGS;
719
720 PHP_HTTP_BEGIN_ARGS(setCacheControl, 1)
721 PHP_HTTP_ARG_VAL(cache_control, 0)
722 PHP_HTTP_END_ARGS;
723
724 PHP_HTTP_BEGIN_ARGS(setLastModified, 1)
725 PHP_HTTP_ARG_VAL(last_modified, 0)
726 PHP_HTTP_END_ARGS;
727
728 PHP_HTTP_BEGIN_ARGS(isCachedByLastModified, 0)
729 PHP_HTTP_ARG_VAL(header_name, 0)
730 PHP_HTTP_END_ARGS;
731
732 PHP_HTTP_BEGIN_ARGS(setEtag, 1)
733 PHP_HTTP_ARG_VAL(etag, 0)
734 PHP_HTTP_END_ARGS;
735
736 PHP_HTTP_BEGIN_ARGS(isCachedByEtag, 0)
737 PHP_HTTP_ARG_VAL(header_name, 0)
738 PHP_HTTP_END_ARGS;
739
740 PHP_HTTP_BEGIN_ARGS(setThrottleRate, 1)
741 PHP_HTTP_ARG_VAL(chunk_size, 0)
742 PHP_HTTP_ARG_VAL(delay, 0)
743 PHP_HTTP_END_ARGS;
744
745 PHP_HTTP_EMPTY_ARGS(send);
746
747
748 zend_function_entry php_http_env_response_method_entry[] = {
749 PHP_HTTP_ENV_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
750 PHP_HTTP_ENV_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
751 PHP_HTTP_ENV_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
752 PHP_HTTP_ENV_RESPONSE_ME(setContentEncoding, ZEND_ACC_PUBLIC)
753 PHP_HTTP_ENV_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
754 PHP_HTTP_ENV_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
755 PHP_HTTP_ENV_RESPONSE_ME(isCachedByLastModified, ZEND_ACC_PUBLIC)
756 PHP_HTTP_ENV_RESPONSE_ME(setEtag, ZEND_ACC_PUBLIC)
757 PHP_HTTP_ENV_RESPONSE_ME(isCachedByEtag, ZEND_ACC_PUBLIC)
758 PHP_HTTP_ENV_RESPONSE_ME(setThrottleRate, ZEND_ACC_PUBLIC)
759
760 PHP_HTTP_ENV_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
761
762 EMPTY_FUNCTION_ENTRY
763 };
764
765
766 PHP_METHOD(HttpEnvResponse, __construct)
767 {
768 with_error_handling(EH_THROW, php_http_exception_class_entry) {
769 if (SUCCESS == zend_parse_parameters_none()) {
770 php_http_message_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
771
772 with_error_handling(EH_THROW, php_http_exception_class_entry) {
773 obj->message = php_http_message_init_env(obj->message, PHP_HTTP_RESPONSE TSRMLS_CC);
774 } end_error_handling();
775 }
776 } end_error_handling();
777
778 }
779
780 PHP_METHOD(HttpEnvResponse, setContentType)
781 {
782 char *ct_str = NULL;
783 int ct_len = 0;
784
785 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &ct_str, &ct_len)) {
786 set_option(getThis(), ZEND_STRL("contentType"), IS_STRING, ct_str, ct_len TSRMLS_CC);
787 }
788 }
789
790 PHP_METHOD(HttpEnvResponse, setContentDisposition)
791 {
792 long cd;
793 char *file_str = NULL;
794 int file_len = 0;
795
796 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|s!", &cd, &file_str, &file_len)) {
797 zval *arr;
798
799 MAKE_STD_ZVAL(arr);
800 array_init(arr);
801 add_assoc_long_ex(arr, ZEND_STRS("disposition"), cd);
802 if (file_len) {
803 add_assoc_stringl_ex(arr, ZEND_STRS("filename"), file_str, file_len, 1);
804 }
805 zend_update_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("contentDisposition"), arr TSRMLS_CC);
806 zval_ptr_dtor(&arr);
807 }
808 }
809
810 PHP_METHOD(HttpEnvResponse, setContentEncoding)
811 {
812 long ce;
813
814 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &ce)) {
815 set_option(getThis(), ZEND_STRL("contentEncoding"), IS_LONG, &ce, 0 TSRMLS_CC);
816 }
817 }
818
819 PHP_METHOD(HttpEnvResponse, setCacheControl)
820 {
821 char *cc_str = NULL;
822 int cc_len = 0;
823
824 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &cc_str, &cc_len)) {
825 set_option(getThis(), ZEND_STRL("cacheControl"), IS_STRING, cc_str, cc_len TSRMLS_CC);
826 }
827 }
828
829 PHP_METHOD(HttpEnvResponse, setLastModified)
830 {
831 long last_modified;
832
833 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &last_modified)) {
834 set_option(getThis(), ZEND_STRL("lastModified"), IS_LONG, &last_modified, 0 TSRMLS_CC);
835 }
836 }
837
838 PHP_METHOD(HttpEnvResponse, isCachedByLastModified)
839 {
840 char *header_name_str = NULL;
841 int header_name_len = 0;
842
843 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
844 if (!header_name_str || !header_name_len) {
845 header_name_str = "If-Modified-Since";
846 header_name_len = lenof("If-Modified-Since");
847 }
848 RETURN_LONG(php_http_env_is_response_cached_by_last_modified(getThis(), header_name_str, header_name_len TSRMLS_CC));
849 }
850 RETURN_FALSE;
851 }
852
853 PHP_METHOD(HttpEnvResponse, setEtag)
854 {
855 char *etag_str = NULL;
856 int etag_len = 0;
857
858 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &etag_str, &etag_len)) {
859 set_option(getThis(), ZEND_STRL("etag"), IS_STRING, etag_str, etag_len TSRMLS_CC);
860 }
861 }
862
863 PHP_METHOD(HttpEnvResponse, isCachedByEtag)
864 {
865 char *header_name_str = NULL;
866 int header_name_len = 0;
867
868 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
869 if (!header_name_str || !header_name_len) {
870 header_name_str = "If-None-Match";
871 header_name_len = lenof("If-None-Match");
872 }
873 RETURN_LONG(php_http_env_is_response_cached_by_etag(getThis(), header_name_str, header_name_len TSRMLS_CC));
874 }
875 RETURN_FALSE;
876 }
877
878 PHP_METHOD(HttpEnvResponse, setThrottleRate)
879 {
880 long chunk_size;
881 double delay = 1;
882
883 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|d", &chunk_size, &delay)) {
884 long chunk_size_long = (long) chunk_size;
885
886 set_option(getThis(), ZEND_STRL("throttleDelay"), IS_DOUBLE, &delay, 0 TSRMLS_CC);
887 set_option(getThis(), ZEND_STRL("throttleChunk"), IS_LONG, &chunk_size_long, 0 TSRMLS_CC);
888 RETURN_TRUE;
889 }
890 RETURN_FALSE;
891 }
892
893 PHP_METHOD(HttpEnvResponse, send)
894 {
895 RETVAL_FALSE;
896
897 if (SUCCESS == zend_parse_parameters_none()) {
898 php_http_env_response_t *r = php_http_env_response_init(NULL, getThis() TSRMLS_CC);
899
900 if (r) {
901 RETVAL_SUCCESS(php_http_env_response_send(r));
902 }
903
904 php_http_env_response_free(&r);
905 }
906 }
907
908 PHP_MINIT_FUNCTION(http_env_response)
909 {
910 PHP_HTTP_REGISTER_CLASS(http\\Env, Response, http_env_response, php_http_message_class_entry, 0);
911
912 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_NONE"), PHP_HTTP_CONTENT_DISPOSITION_NONE TSRMLS_CC);
913 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_INLINE"), PHP_HTTP_CONTENT_DISPOSITION_INLINE TSRMLS_CC);
914 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_DISPOSITION_ATTACHMENT"), PHP_HTTP_CONTENT_DISPOSITION_ATTACHMENT TSRMLS_CC);
915
916 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_NONE"), PHP_HTTP_CONTENT_ENCODING_NONE TSRMLS_CC);
917 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_GZIP"), PHP_HTTP_CONTENT_ENCODING_GZIP TSRMLS_CC);
918
919 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_NO"), PHP_HTTP_CACHE_NO TSRMLS_CC);
920 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_HIT"), PHP_HTTP_CACHE_HIT TSRMLS_CC);
921 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_MISS"), PHP_HTTP_CACHE_MISS TSRMLS_CC);
922
923 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentType"), ZEND_ACC_PROTECTED TSRMLS_CC);
924 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentDisposition"), ZEND_ACC_PROTECTED TSRMLS_CC);
925 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentEncoding"), ZEND_ACC_PROTECTED TSRMLS_CC);
926 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("cacheControl"), ZEND_ACC_PROTECTED TSRMLS_CC);
927 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("etag"), ZEND_ACC_PROTECTED TSRMLS_CC);
928 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("lastModified"), ZEND_ACC_PROTECTED TSRMLS_CC);
929 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleDelay"), ZEND_ACC_PROTECTED TSRMLS_CC);
930 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleChunk"), ZEND_ACC_PROTECTED TSRMLS_CC);
931
932 return SUCCESS;
933 }
934
935
936 /*
937 * Local variables:
938 * tab-width: 4
939 * c-basic-offset: 4
940 * End:
941 * vim600: noet sw=4 ts=4 fdm=marker
942 * vim<600: noet sw=4 ts=4
943 */
Extended HTTP Support