projects / m6w6 / ext-http / blob
? search:
summary | shortlog | log | commit | commitdiff | tree | github
history | raw | HEAD
fix caching by last modified
[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 zval_ptr_dtor(&zoption);
396 }
397
398 if (ret != SUCCESS) {
399 return ret;
400 }
401
402 if ((zoption = get_option(options, ZEND_STRL("contentEncoding") TSRMLS_CC))) {
403 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
404 zval zsupported;
405 HashTable *result = NULL;
406
407 zval_ptr_dtor(&zoption);
408 switch (Z_LVAL_P(zoption_copy)) {
409 case PHP_HTTP_CONTENT_ENCODING_GZIP:
410 INIT_PZVAL(&zsupported);
411 array_init(&zsupported);
412 add_next_index_stringl(&zsupported, ZEND_STRL("none"), 1);
413 add_next_index_stringl(&zsupported, ZEND_STRL("gzip"), 1);
414 add_next_index_stringl(&zsupported, ZEND_STRL("deflate"), 1);
415
416 if ((result = php_http_negotiate_encoding(Z_ARRVAL(zsupported) TSRMLS_CC))) {
417 char *key_str = NULL;
418 uint key_len = 0;
419
420 zend_hash_internal_pointer_reset(result);
421 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key_str, &key_len, NULL, 0, NULL)) {
422 if (!strcmp(key_str, "gzip")) {
423 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_GZIP TSRMLS_CC))) {
424 ret = FAILURE;
425 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: gzip"), 1 TSRMLS_CC))) {
426 r->content.encoding = estrndup(key_str, key_len - 1);
427 }
428 } else if (!strcmp(key_str, "deflate")) {
429 if (!(r->content.encoder = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_deflate_ops(), PHP_HTTP_DEFLATE_TYPE_ZLIB TSRMLS_CC))) {
430 ret = FAILURE;
431 } else if (SUCCESS == (ret = php_http_env_set_response_header(0, ZEND_STRL("Content-Encoding: deflate"), 1 TSRMLS_CC))) {
432 r->content.encoding = estrndup(key_str, key_len - 1);
433 }
434 } else {
435 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
436 }
437
438 if (SUCCESS == ret) {
439 ret = php_http_env_set_response_header(0, ZEND_STRL("Vary: Accept-Encoding"), 0 TSRMLS_CC);
440 }
441 }
442
443 zend_hash_destroy(result);
444 FREE_HASHTABLE(result);
445 }
446
447 zval_dtor(&zsupported);
448 break;
449
450 case PHP_HTTP_CONTENT_ENCODING_NONE:
451 default:
452 ret = php_http_env_set_response_header_value(0, ZEND_STRL("Content-Encoding"), NULL, 0 TSRMLS_CC);
453 break;
454 }
455 zval_ptr_dtor(&zoption_copy);
456 }
457
458 if (SUCCESS != ret) {
459 return ret;
460 }
461
462 if (php_http_env_get_response_code(TSRMLS_C) < 400 && !php_http_env_got_request_header(ZEND_STRL("Authorization") TSRMLS_CC)
463 && ( !SG(request_info).request_method
464 || !strcasecmp(SG(request_info).request_method, "GET")
465 || !strcasecmp(SG(request_info).request_method, "HEAD")
466 )
467 ) {
468 switch (php_http_env_is_response_cached_by_etag(options, ZEND_STRL("If-None-Match") TSRMLS_CC)) {
469 case PHP_HTTP_CACHE_MISS:
470 break;
471
472 case PHP_HTTP_CACHE_NO:
473 if (PHP_HTTP_CACHE_HIT != php_http_env_is_response_cached_by_last_modified(options, ZEND_STRL("If-Modified-Since") TSRMLS_CC)) {
474 break;
475 }
476 /* no break */
477
478 case PHP_HTTP_CACHE_HIT:
479 ret = php_http_env_set_response_code(304 TSRMLS_CC);
480 r->done = 1;
481 break;
482 }
483
484 if ((zoption = get_option(options, ZEND_STRL("etag") TSRMLS_CC))) {
485 zval *zoption_copy = php_http_ztyp(IS_STRING, zoption);
486
487 zval_ptr_dtor(&zoption);
488 if (*Z_STRVAL_P(zoption_copy) != '"' && strncmp(Z_STRVAL_P(zoption_copy), "W/\"", 3)) {
489 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "ETag: \"%s\"", Z_STRVAL_P(zoption_copy));
490 } else {
491 ret = php_http_env_set_response_header_value(0, ZEND_STRL("ETag"), zoption_copy, 1 TSRMLS_CC);
492 }
493 zval_ptr_dtor(&zoption_copy);
494 }
495 if ((zoption = get_option(options, ZEND_STRL("lastModified") TSRMLS_CC))) {
496 zval *zoption_copy = php_http_ztyp(IS_LONG, zoption);
497
498 zval_ptr_dtor(&zoption);
499 if (Z_LVAL_P(zoption_copy)) {
500 char *date = php_format_date(ZEND_STRL(PHP_HTTP_DATE_FORMAT), Z_LVAL_P(zoption_copy), 0 TSRMLS_CC);
501 if (date) {
502 ret = php_http_env_set_response_header_format(0, 1 TSRMLS_CC, "Last-Modified: %s", date);
503 efree(date);
504 }
505 }
506 zval_ptr_dtor(&zoption_copy);
507 }
508 }
509 }
510
511 return ret;
512 }
513
514 static STATUS php_http_env_response_send_body(php_http_env_response_t *r)
515 {
516 STATUS ret = SUCCESS;
517 zval *zbody, *zoption;
518 TSRMLS_FETCH_FROM_CTX(r->ts);
519
520 if (r->done) {
521 return ret;
522 }
523
524 if ( (zbody = get_option(r->options, ZEND_STRL("body") TSRMLS_CC))
525 && (Z_TYPE_P(zbody) == IS_OBJECT)
526 && instanceof_function(Z_OBJCE_P(zbody), php_http_message_body_get_class_entry() TSRMLS_CC)
527 ) {
528 php_http_message_body_object_t *obj = zend_object_store_get_object(zbody TSRMLS_CC);
529
530 if ((zoption = get_option(r->options, ZEND_STRL("throttleDelay") TSRMLS_CC))) {
531 if (Z_TYPE_P(zoption) == IS_DOUBLE) {
532 r->throttle.delay = Z_DVAL_P(zoption);
533 }
534 zval_ptr_dtor(&zoption);
535 }
536 if ((zoption = get_option(r->options, ZEND_STRL("throttleChunk") TSRMLS_CC))) {
537 if (Z_TYPE_P(zoption) == IS_LONG) {
538 r->throttle.chunk = Z_LVAL_P(zoption);
539 }
540 zval_ptr_dtor(&zoption);
541 }
542
543 if (r->range.status == PHP_HTTP_RANGE_OK) {
544 if (zend_hash_num_elements(&r->range.values) == 1) {
545 /* single range */
546 zval **range, **begin, **end;
547
548 if (SUCCESS != zend_hash_index_find(&r->range.values, 0, (void *) &range)
549 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 0, (void *) &begin)
550 || SUCCESS != zend_hash_index_find(Z_ARRVAL_PP(range), 1, (void *) &end)
551 ) {
552 /* this should never happen */
553 zend_hash_destroy(&r->range.values);
554 php_http_env_set_response_code(500 TSRMLS_CC);
555 ret = FAILURE;
556 } else {
557 /* send chunk */
558 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);
559 php_http_env_response_send_done(r);
560 zend_hash_destroy(&r->range.values);
561 ret = SUCCESS;
562 }
563 } else {
564 /* send multipart/byte-ranges message */
565 HashPosition pos;
566 zval **chunk;
567
568 FOREACH_HASH_VAL(pos, &r->range.values, chunk) {
569 zval **begin, **end;
570
571 if (IS_ARRAY == Z_TYPE_PP(chunk)
572 && SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(chunk), 0, (void *) &begin)
573 && IS_LONG == Z_TYPE_PP(begin)
574 && SUCCESS == zend_hash_index_find(Z_ARRVAL_PP(chunk), 1, (void *) &end)
575 && IS_LONG == Z_TYPE_PP(end)
576 ) {
577 php_http_buffer_appendf(r->buffer,
578 PHP_HTTP_CRLF
579 "--%s" PHP_HTTP_CRLF
580 "Content-Type: %s" PHP_HTTP_CRLF
581 "Content-Range: bytes %ld-%ld/%zu" PHP_HTTP_CRLF PHP_HTTP_CRLF,
582 /* - */
583 r->range.boundary,
584 r->content.type ? r->content.type : "application/octet-stream",
585 Z_LVAL_PP(begin),
586 Z_LVAL_PP(end),
587 r->content.length
588 );
589 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);
590 }
591 }
592 php_http_buffer_appendf(r->buffer, PHP_HTTP_CRLF "--%s--", r->range.boundary);
593 php_http_env_response_send_done(r);
594 zend_hash_destroy(&r->range.values);
595 }
596
597 } else {
598 php_http_message_body_to_callback(obj->body, (php_http_pass_callback_t) php_http_env_response_send_data, r, 0, 0);
599 php_http_env_response_send_done(r);
600 }
601 }
602 if (zbody) {
603 zval_ptr_dtor(&zbody);
604 }
605 return ret;
606 }
607
608 PHP_HTTP_API STATUS php_http_env_response_send(php_http_env_response_t *r)
609 {
610 zval *zbody;
611 TSRMLS_FETCH_FROM_CTX(r->ts);
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_get_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 break;
668 }
669 }
670 } else if (zbody) {
671 zval_ptr_dtor(&zbody);
672 }
673
674 if (SUCCESS != php_http_env_response_send_head(r)) {
675 return FAILURE;
676 }
677
678 if (SUCCESS != php_http_env_response_send_body(r)) {
679 return FAILURE;
680 }
681 return SUCCESS;
682 }
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(__invoke, 1)
693 PHP_HTTP_ARG_VAL(ob_string, 0)
694 PHP_HTTP_ARG_VAL(ob_flags, 0)
695 PHP_HTTP_END_ARGS;
696
697 PHP_HTTP_BEGIN_ARGS(setContentType, 1)
698 PHP_HTTP_ARG_VAL(content_type, 0)
699 PHP_HTTP_END_ARGS;
700
701 PHP_HTTP_BEGIN_ARGS(setContentEncoding, 1)
702 PHP_HTTP_ARG_VAL(content_encoding, 0)
703 PHP_HTTP_END_ARGS;
704
705 PHP_HTTP_BEGIN_ARGS(setContentDisposition, 1)
706 PHP_HTTP_ARG_ARR(disposition_params, 1, 0)
707 PHP_HTTP_END_ARGS;
708
709 PHP_HTTP_BEGIN_ARGS(setCacheControl, 1)
710 PHP_HTTP_ARG_VAL(cache_control, 0)
711 PHP_HTTP_END_ARGS;
712
713 PHP_HTTP_BEGIN_ARGS(setLastModified, 1)
714 PHP_HTTP_ARG_VAL(last_modified, 0)
715 PHP_HTTP_END_ARGS;
716
717 PHP_HTTP_BEGIN_ARGS(isCachedByLastModified, 0)
718 PHP_HTTP_ARG_VAL(header_name, 0)
719 PHP_HTTP_END_ARGS;
720
721 PHP_HTTP_BEGIN_ARGS(setEtag, 1)
722 PHP_HTTP_ARG_VAL(etag, 0)
723 PHP_HTTP_END_ARGS;
724
725 PHP_HTTP_BEGIN_ARGS(isCachedByEtag, 0)
726 PHP_HTTP_ARG_VAL(header_name, 0)
727 PHP_HTTP_END_ARGS;
728
729 PHP_HTTP_BEGIN_ARGS(setThrottleRate, 1)
730 PHP_HTTP_ARG_VAL(chunk_size, 0)
731 PHP_HTTP_ARG_VAL(delay, 0)
732 PHP_HTTP_END_ARGS;
733
734 PHP_HTTP_EMPTY_ARGS(send);
735
736 static zend_class_entry *php_http_env_response_class_entry;
737
738 zend_class_entry *php_http_env_response_get_class_entry(void)
739 {
740 return php_http_env_response_class_entry;
741 }
742
743 static zend_function_entry php_http_env_response_method_entry[] = {
744 PHP_HTTP_ENV_RESPONSE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
745 PHP_HTTP_ENV_RESPONSE_ME(__invoke, ZEND_ACC_PUBLIC)
746 PHP_HTTP_ENV_RESPONSE_ME(setContentType, ZEND_ACC_PUBLIC)
747 PHP_HTTP_ENV_RESPONSE_ME(setContentDisposition, ZEND_ACC_PUBLIC)
748 PHP_HTTP_ENV_RESPONSE_ME(setContentEncoding, ZEND_ACC_PUBLIC)
749 PHP_HTTP_ENV_RESPONSE_ME(setCacheControl, ZEND_ACC_PUBLIC)
750 PHP_HTTP_ENV_RESPONSE_ME(setLastModified, ZEND_ACC_PUBLIC)
751 PHP_HTTP_ENV_RESPONSE_ME(isCachedByLastModified, ZEND_ACC_PUBLIC)
752 PHP_HTTP_ENV_RESPONSE_ME(setEtag, ZEND_ACC_PUBLIC)
753 PHP_HTTP_ENV_RESPONSE_ME(isCachedByEtag, ZEND_ACC_PUBLIC)
754 PHP_HTTP_ENV_RESPONSE_ME(setThrottleRate, ZEND_ACC_PUBLIC)
755
756 PHP_HTTP_ENV_RESPONSE_ME(send, ZEND_ACC_PUBLIC)
757
758 EMPTY_FUNCTION_ENTRY
759 };
760
761
762 PHP_METHOD(HttpEnvResponse, __construct)
763 {
764 with_error_handling(EH_THROW, php_http_exception_get_class_entry()) {
765 if (SUCCESS == zend_parse_parameters_none()) {
766 php_http_message_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
767
768 with_error_handling(EH_THROW, php_http_exception_get_class_entry()) {
769 obj->message = php_http_message_init_env(obj->message, PHP_HTTP_RESPONSE TSRMLS_CC);
770 } end_error_handling();
771 }
772 } end_error_handling();
773
774 }
775
776 PHP_METHOD(HttpEnvResponse, __invoke)
777 {
778 char *ob_str;
779 int ob_len;
780 long ob_flags = 0;
781
782 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &ob_str, &ob_len, &ob_flags)) {
783 php_http_message_object_t *obj = zend_object_store_get_object(getThis() TSRMLS_CC);
784
785 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)) {
786 php_http_message_body_append(&obj->message->body, ob_str, ob_len);
787 RETURN_TRUE;
788 }
789 RETURN_FALSE;
790 }
791 }
792
793 PHP_METHOD(HttpEnvResponse, setContentType)
794 {
795 char *ct_str = NULL;
796 int ct_len = 0;
797
798 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &ct_str, &ct_len)) {
799 set_option(getThis(), ZEND_STRL("contentType"), IS_STRING, ct_str, ct_len TSRMLS_CC);
800 }
801 }
802
803 PHP_METHOD(HttpEnvResponse, setContentDisposition)
804 {
805 zval *zdisposition;
806
807 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &zdisposition)) {
808 zend_update_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("contentDisposition"), zdisposition TSRMLS_CC);
809 }
810 }
811
812 PHP_METHOD(HttpEnvResponse, setContentEncoding)
813 {
814 long ce;
815
816 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &ce)) {
817 set_option(getThis(), ZEND_STRL("contentEncoding"), IS_LONG, &ce, 0 TSRMLS_CC);
818 }
819 }
820
821 PHP_METHOD(HttpEnvResponse, setCacheControl)
822 {
823 char *cc_str = NULL;
824 int cc_len = 0;
825
826 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &cc_str, &cc_len)) {
827 set_option(getThis(), ZEND_STRL("cacheControl"), IS_STRING, cc_str, cc_len TSRMLS_CC);
828 }
829 }
830
831 PHP_METHOD(HttpEnvResponse, setLastModified)
832 {
833 long last_modified;
834
835 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &last_modified)) {
836 set_option(getThis(), ZEND_STRL("lastModified"), IS_LONG, &last_modified, 0 TSRMLS_CC);
837 }
838 }
839
840 PHP_METHOD(HttpEnvResponse, isCachedByLastModified)
841 {
842 char *header_name_str = NULL;
843 int header_name_len = 0;
844
845 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
846 if (!header_name_str || !header_name_len) {
847 header_name_str = "If-Modified-Since";
848 header_name_len = lenof("If-Modified-Since");
849 }
850 RETURN_LONG(php_http_env_is_response_cached_by_last_modified(getThis(), header_name_str, header_name_len TSRMLS_CC));
851 }
852 RETURN_FALSE;
853 }
854
855 PHP_METHOD(HttpEnvResponse, setEtag)
856 {
857 char *etag_str = NULL;
858 int etag_len = 0;
859
860 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s!", &etag_str, &etag_len)) {
861 set_option(getThis(), ZEND_STRL("etag"), IS_STRING, etag_str, etag_len TSRMLS_CC);
862 }
863 }
864
865 PHP_METHOD(HttpEnvResponse, isCachedByEtag)
866 {
867 char *header_name_str = NULL;
868 int header_name_len = 0;
869
870 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!", &header_name_str, &header_name_len)) {
871 if (!header_name_str || !header_name_len) {
872 header_name_str = "If-None-Match";
873 header_name_len = lenof("If-None-Match");
874 }
875 RETURN_LONG(php_http_env_is_response_cached_by_etag(getThis(), header_name_str, header_name_len TSRMLS_CC));
876 }
877 RETURN_FALSE;
878 }
879
880 PHP_METHOD(HttpEnvResponse, setThrottleRate)
881 {
882 long chunk_size;
883 double delay = 1;
884
885 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l|d", &chunk_size, &delay)) {
886 set_option(getThis(), ZEND_STRL("throttleDelay"), IS_DOUBLE, &delay, 0 TSRMLS_CC);
887 set_option(getThis(), ZEND_STRL("throttleChunk"), IS_LONG, &chunk_size, 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_get_class_entry(), 0);
911
912 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_NONE"), PHP_HTTP_CONTENT_ENCODING_NONE TSRMLS_CC);
913 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CONTENT_ENCODING_GZIP"), PHP_HTTP_CONTENT_ENCODING_GZIP TSRMLS_CC);
914
915 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_NO"), PHP_HTTP_CACHE_NO TSRMLS_CC);
916 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_HIT"), PHP_HTTP_CACHE_HIT TSRMLS_CC);
917 zend_declare_class_constant_long(php_http_env_response_class_entry, ZEND_STRL("CACHE_MISS"), PHP_HTTP_CACHE_MISS TSRMLS_CC);
918
919 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentType"), ZEND_ACC_PROTECTED TSRMLS_CC);
920 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentDisposition"), ZEND_ACC_PROTECTED TSRMLS_CC);
921 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("contentEncoding"), ZEND_ACC_PROTECTED TSRMLS_CC);
922 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("cacheControl"), ZEND_ACC_PROTECTED TSRMLS_CC);
923 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("etag"), ZEND_ACC_PROTECTED TSRMLS_CC);
924 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("lastModified"), ZEND_ACC_PROTECTED TSRMLS_CC);
925 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleDelay"), ZEND_ACC_PROTECTED TSRMLS_CC);
926 zend_declare_property_null(php_http_env_response_class_entry, ZEND_STRL("throttleChunk"), ZEND_ACC_PROTECTED TSRMLS_CC);
927
928 return SUCCESS;
929 }
930
931
932 /*
933 * Local variables:
934 * tab-width: 4
935 * c-basic-offset: 4
936 * End:
937 * vim600: noet sw=4 ts=4 fdm=marker
938 * vim<600: noet sw=4 ts=4
939 */
Extended HTTP Support