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