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