2 +--------------------------------------------------------------------+
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 +--------------------------------------------------------------------+
13 #include "php_http_api.h"
15 #include <ext/standard/php_lcg.h>
17 #define BOUNDARY_OPEN(body) \
19 size_t size = php_http_message_body_size(body); \
21 php_stream_truncate_set_size(php_http_message_body_stream(body), size - lenof("--" PHP_HTTP_CRLF)); \
22 php_http_message_body_append(body, ZEND_STRL(PHP_HTTP_CRLF)); \
24 php_http_message_body_appendf(body, "--%s" PHP_HTTP_CRLF, php_http_message_body_boundary(body)); \
27 #define BOUNDARY_CLOSE(body) \
28 php_http_message_body_appendf(body, PHP_HTTP_CRLF "--%s--" PHP_HTTP_CRLF, php_http_message_body_boundary(body))
30 static STATUS
add_recursive_fields(php_http_message_body_t
*body
, const char *name
, zval
*value
);
31 static STATUS
add_recursive_files(php_http_message_body_t
*body
, const char *name
, zval
*value
);
33 PHP_HTTP_API php_http_message_body_t
*php_http_message_body_init(php_http_message_body_t
*body
, php_stream
*stream TSRMLS_DC
)
36 body
= emalloc(sizeof(php_http_message_body_t
));
38 memset(body
, 0, sizeof(*body
));
41 php_stream_auto_cleanup(stream
);
42 body
->stream_id
= php_stream_get_resource_id(stream
);
43 zend_list_addref(body
->stream_id
);
45 stream
= php_stream_temp_create(TEMP_STREAM_DEFAULT
, 0xffff);
46 php_stream_auto_cleanup(stream
);
47 body
->stream_id
= php_stream_get_resource_id(stream
);
49 TSRMLS_SET_CTX(body
->ts
);
54 PHP_HTTP_API php_http_message_body_t
*php_http_message_body_copy(php_http_message_body_t
*from
, php_http_message_body_t
*to
, zend_bool dup_internal_stream_and_contents
)
59 TSRMLS_FETCH_FROM_CTX(from
->ts
);
61 if (dup_internal_stream_and_contents
) {
62 to
= php_http_message_body_init(to
, NULL TSRMLS_CC
);
63 php_http_message_body_to_stream(from
, php_http_message_body_stream(to
), 0, 0);
65 to
= php_http_message_body_init(to
, php_http_message_body_stream(from
) TSRMLS_CC
);
69 to
->boundary
= estrdup(from
->boundary
);
76 PHP_HTTP_API
void php_http_message_body_dtor(php_http_message_body_t
*body
)
78 TSRMLS_FETCH_FROM_CTX(body
->ts
);
79 /* NO FIXME: shows leakinfo in DEBUG mode */
80 zend_list_delete(body
->stream_id
);
81 STR_FREE(body
->boundary
);
84 PHP_HTTP_API
void php_http_message_body_free(php_http_message_body_t
**body
)
87 php_http_message_body_dtor(*body
);
93 PHP_HTTP_API
const php_stream_statbuf
*php_http_message_body_stat(php_http_message_body_t
*body
)
95 TSRMLS_FETCH_FROM_CTX(body
->ts
);
96 php_stream_stat(php_http_message_body_stream(body
), &body
->ssb
);
100 PHP_HTTP_API
const char *php_http_message_body_boundary(php_http_message_body_t
*body
)
102 if (!body
->boundary
) {
103 union { double dbl
; int num
[2]; } data
;
104 TSRMLS_FETCH_FROM_CTX(body
->ts
);
106 data
.dbl
= php_combined_lcg(TSRMLS_C
);
107 spprintf(&body
->boundary
, 0, "%x.%x", data
.num
[0], data
.num
[1]);
109 return body
->boundary
;
112 PHP_HTTP_API
char *php_http_message_body_etag(php_http_message_body_t
*body
)
114 TSRMLS_FETCH_FROM_CTX(body
->ts
);
115 const php_stream_statbuf
*ssb
= php_http_message_body_stat(body
);
117 /* real file or temp buffer ? */
118 if (ssb
&& ssb
->sb
.st_mtime
) {
121 spprintf(&etag
, 0, "%lx-%lx-%lx", ssb
->sb
.st_ino
, ssb
->sb
.st_mtime
, ssb
->sb
.st_size
);
124 php_http_etag_t
*etag
= php_http_etag_init(PHP_HTTP_G
->env
.etag_mode TSRMLS_CC
);
126 php_http_message_body_to_callback(body
, (php_http_pass_callback_t
) php_http_etag_update
, etag
, 0, 0);
127 return php_http_etag_finish(etag
);
131 PHP_HTTP_API
void php_http_message_body_to_string(php_http_message_body_t
*body
, char **buf
, size_t *len
, off_t offset
, size_t forlen
)
133 TSRMLS_FETCH_FROM_CTX(body
->ts
);
134 php_stream
*s
= php_http_message_body_stream(body
);
136 php_stream_seek(s
, offset
, SEEK_SET
);
140 *len
= php_stream_copy_to_mem(s
, buf
, forlen
, 0);
143 PHP_HTTP_API
void php_http_message_body_to_stream(php_http_message_body_t
*body
, php_stream
*dst
, off_t offset
, size_t forlen
)
145 TSRMLS_FETCH_FROM_CTX(body
->ts
);
146 php_stream
*s
= php_http_message_body_stream(body
);
148 php_stream_seek(s
, offset
, SEEK_SET
);
152 php_stream_copy_to_stream_ex(s
, dst
, forlen
, NULL
);
155 PHP_HTTP_API
void php_http_message_body_to_callback(php_http_message_body_t
*body
, php_http_pass_callback_t cb
, void *cb_arg
, off_t offset
, size_t forlen
)
157 TSRMLS_FETCH_FROM_CTX(body
->ts
);
158 php_stream
*s
= php_http_message_body_stream(body
);
159 char *buf
= emalloc(0x1000);
161 php_stream_seek(s
, offset
, SEEK_SET
);
166 while (!php_stream_eof(s
)) {
167 size_t read
= php_stream_read(s
, buf
, MIN(forlen
, 0x1000));
170 cb(cb_arg
, buf
, read
);
173 if (read
< MIN(forlen
, sizeof(buf
))) {
177 if (forlen
&& !(forlen
-= read
)) {
184 PHP_HTTP_API
size_t php_http_message_body_append(php_http_message_body_t
*body
, const char *buf
, size_t len
)
187 TSRMLS_FETCH_FROM_CTX(body
->ts
);
189 s
= php_http_message_body_stream(body
);
190 php_stream_seek(s
, 0, SEEK_END
);
191 return php_stream_write(s
, buf
, len
);
194 PHP_HTTP_API
size_t php_http_message_body_appendf(php_http_message_body_t
*body
, const char *fmt
, ...)
201 print_len
= vspprintf(&print_str
, 0, fmt
, argv
);
204 print_len
= php_http_message_body_append(body
, print_str
, print_len
);
210 PHP_HTTP_API STATUS
php_http_message_body_add(php_http_message_body_t
*body
, HashTable
*fields
, HashTable
*files
)
215 INIT_PZVAL_ARRAY(&tmp
, fields
);
216 if (SUCCESS
!= add_recursive_fields(body
, NULL
, &tmp
)) {
221 INIT_PZVAL_ARRAY(&tmp
, files
);
222 if (SUCCESS
!= add_recursive_files(body
, NULL
, &tmp
)) {
231 PHP_HTTP_API STATUS
php_http_message_body_add_field(php_http_message_body_t
*body
, const char *name
, const char *value_str
, size_t value_len
)
234 TSRMLS_FETCH_FROM_CTX(body
->ts
);
236 safe_name
= php_addslashes(estrdup(name
), strlen(name
), NULL
, 1 TSRMLS_CC
);
239 php_http_message_body_appendf(
241 "Content-Disposition: form-data; name=\"%s\"" PHP_HTTP_CRLF
245 php_http_message_body_append(body
, value_str
, value_len
);
246 BOUNDARY_CLOSE(body
);
252 PHP_HTTP_API STATUS
php_http_message_body_add_file(php_http_message_body_t
*body
, const char *name
, const char *ctype
, const char *path
, php_stream
*in
)
254 char *safe_name
, *path_dup
= estrdup(path
);
255 TSRMLS_FETCH_FROM_CTX(body
->ts
);
257 safe_name
= php_addslashes(estrdup(name
), strlen(name
), NULL
, 1 TSRMLS_CC
);
260 php_http_message_body_appendf(
262 "Content-Disposition: attachment; name=\"%s\"; filename=\"%s\"" PHP_HTTP_CRLF
263 "Content-Transfer-Encoding: binary" PHP_HTTP_CRLF
264 "Content-Type: %s" PHP_HTTP_CRLF
266 safe_name
, basename(path_dup
), ctype
268 php_stream_copy_to_stream_ex(in
, php_http_message_body_stream(body
), PHP_STREAM_COPY_ALL
, NULL
);
269 BOUNDARY_CLOSE(body
);
277 static inline char *format_key(uint type
, char *str
, ulong num
, const char *prefix
) {
278 char *new_key
= NULL
;
280 if (prefix
&& *prefix
) {
281 if (type
== HASH_KEY_IS_STRING
) {
282 spprintf(&new_key
, 0, "%s[%s]", prefix
, str
);
284 spprintf(&new_key
, 0, "%s[%lu]", prefix
, num
);
286 } else if (type
== HASH_KEY_IS_STRING
) {
287 new_key
= estrdup(str
);
295 static STATUS
add_recursive_fields(php_http_message_body_t
*body
, const char *name
, zval
*value
)
297 if (Z_TYPE_P(value
) == IS_ARRAY
|| Z_TYPE_P(value
) == IS_OBJECT
) {
301 php_http_array_hashkey_t key
= php_http_array_hashkey_init(0);
302 TSRMLS_FETCH_FROM_CTX(body
->ts
);
305 if (!ht
->nApplyCount
) {
307 FOREACH_KEYVAL(pos
, value
, key
, val
) {
308 char *str
= format_key(key
.type
, key
.str
, key
.num
, name
);
309 if (SUCCESS
!= add_recursive_fields(body
, str
, *val
)) {
319 zval
*cpy
= php_http_ztyp(IS_STRING
, value
);
320 php_http_message_body_add_field(body
, name
, Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
327 static STATUS
add_recursive_files(php_http_message_body_t
*body
, const char *name
, zval
*value
)
329 zval
**zdata
= NULL
, **zfile
, **zname
, **ztype
;
331 TSRMLS_FETCH_FROM_CTX(body
->ts
);
333 if (Z_TYPE_P(value
) != IS_ARRAY
&& Z_TYPE_P(value
) != IS_OBJECT
) {
334 php_http_error(HE_WARNING
, PHP_HTTP_E_MESSAGE_BODY
, "Expected array or object (name, type, file) for message body file to add");
340 if ((SUCCESS
!= zend_hash_find(ht
, ZEND_STRS("name"), (void *) &zname
))
341 || (SUCCESS
!= zend_hash_find(ht
, ZEND_STRS("type"), (void *) &ztype
))
342 || (SUCCESS
!= zend_hash_find(ht
, ZEND_STRS("file"), (void *) &zfile
))
346 php_http_array_hashkey_t key
= php_http_array_hashkey_init(0);
348 if (!ht
->nApplyCount
) {
350 FOREACH_HASH_KEYVAL(pos
, ht
, key
, val
) {
351 if (Z_TYPE_PP(val
) == IS_ARRAY
|| Z_TYPE_PP(val
) == IS_OBJECT
) {
352 char *str
= format_key(key
.type
, key
.str
, key
.num
, name
);
354 if (SUCCESS
!= add_recursive_files(body
, str
, *val
)) {
367 zval
*zfc
= php_http_ztyp(IS_STRING
, *zfile
);
369 if (SUCCESS
== zend_hash_find(ht
, ZEND_STRS("data"), (void *) &zdata
)) {
370 if (Z_TYPE_PP(zdata
) == IS_RESOURCE
) {
371 php_stream_from_zval_no_verify(stream
, zdata
);
373 zval
*tmp
= php_http_ztyp(IS_STRING
, *zdata
);
375 stream
= php_stream_memory_open(TEMP_STREAM_READONLY
, Z_STRVAL_P(tmp
), Z_STRLEN_P(tmp
));
379 stream
= php_stream_open_wrapper(Z_STRVAL_P(zfc
), "r", REPORT_ERRORS
|USE_PATH
, NULL
);
386 zval
*znc
= php_http_ztyp(IS_STRING
, *zname
), *ztc
= php_http_ztyp(IS_STRING
, *ztype
);
387 char *key
= format_key(HASH_KEY_IS_STRING
, Z_STRVAL_P(znc
), 0, name
);
388 STATUS ret
= php_http_message_body_add_file(body
, key
, Z_STRVAL_P(ztc
), Z_STRVAL_P(zfc
), stream
);
394 if (!zdata
|| Z_TYPE_PP(zdata
) != IS_RESOURCE
) {
395 php_stream_close(stream
);
405 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpMessageBody, method, 0, req_args)
406 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpMessageBody, method, 0)
407 #define PHP_HTTP_MESSAGE_BODY_ME(method, visibility) PHP_ME(HttpMessageBody, method, PHP_HTTP_ARGS(HttpMessageBody, method), visibility)
409 PHP_HTTP_BEGIN_ARGS(__construct
, 0)
410 PHP_HTTP_ARG_VAL(stream
, 0)
413 PHP_HTTP_EMPTY_ARGS(__toString
);
415 PHP_HTTP_BEGIN_ARGS(toStream
, 1)
416 PHP_HTTP_ARG_VAL(stream
, 0)
419 PHP_HTTP_BEGIN_ARGS(toCallback
, 1)
420 PHP_HTTP_ARG_VAL(callback
, 0)
423 PHP_HTTP_BEGIN_ARGS(append
, 1)
424 PHP_HTTP_ARG_VAL(string
, 0)
427 PHP_HTTP_BEGIN_ARGS(add
, 0)
428 PHP_HTTP_ARG_ARR(fields
, 1, 0)
429 PHP_HTTP_ARG_ARR(files
, 1, 0)
432 PHP_HTTP_EMPTY_ARGS(etag
);
434 PHP_HTTP_BEGIN_ARGS(stat
, 0)
435 PHP_HTTP_ARG_VAL(what
, 0)
438 zend_class_entry
*php_http_message_body_class_entry
;
439 zend_function_entry php_http_message_body_method_entry
[] = {
440 PHP_HTTP_MESSAGE_BODY_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
441 PHP_HTTP_MESSAGE_BODY_ME(__toString
, ZEND_ACC_PUBLIC
)
442 PHP_MALIAS(HttpMessageBody
, toString
, __toString
, args_for_HttpMessageBody___toString
, ZEND_ACC_PUBLIC
)
443 PHP_HTTP_MESSAGE_BODY_ME(toStream
, ZEND_ACC_PUBLIC
)
444 PHP_HTTP_MESSAGE_BODY_ME(toCallback
, ZEND_ACC_PUBLIC
)
445 PHP_HTTP_MESSAGE_BODY_ME(append
, ZEND_ACC_PUBLIC
)
446 PHP_HTTP_MESSAGE_BODY_ME(add
, ZEND_ACC_PUBLIC
)
447 PHP_HTTP_MESSAGE_BODY_ME(etag
, ZEND_ACC_PUBLIC
)
448 PHP_HTTP_MESSAGE_BODY_ME(stat
, ZEND_ACC_PUBLIC
)
451 static zend_object_handlers php_http_message_body_object_handlers
;
453 PHP_MINIT_FUNCTION(http_message_body
)
455 PHP_HTTP_REGISTER_CLASS(http
\\Message
, Body
, http_message_body
, php_http_object_class_entry
, 0);
456 php_http_message_body_class_entry
->create_object
= php_http_message_body_object_new
;
457 memcpy(&php_http_message_body_object_handlers
, zend_get_std_object_handlers(), sizeof(zend_object_handlers
));
458 php_http_message_body_object_handlers
.clone_obj
= php_http_message_body_object_clone
;
463 zend_object_value
php_http_message_body_object_new(zend_class_entry
*ce TSRMLS_DC
)
465 return php_http_message_body_object_new_ex(ce
, NULL
, NULL TSRMLS_CC
);
468 zend_object_value
php_http_message_body_object_new_ex(zend_class_entry
*ce
, php_http_message_body_t
*body
, php_http_message_body_object_t
**ptr TSRMLS_DC
)
470 zend_object_value ov
;
471 php_http_message_body_object_t
*o
;
473 o
= ecalloc(1, sizeof(php_http_message_body_object_t
));
474 zend_object_std_init((zend_object
*) o
, php_http_message_body_class_entry TSRMLS_CC
);
475 object_properties_init((zend_object
*) o
, ce
);
485 ov
.handle
= zend_objects_store_put((zend_object
*) o
, NULL
, php_http_message_body_object_free
, NULL TSRMLS_CC
);
486 ov
.handlers
= &php_http_message_body_object_handlers
;
491 zend_object_value
php_http_message_body_object_clone(zval
*object TSRMLS_DC
)
493 zend_object_value new_ov
;
494 php_http_message_body_object_t
*new_obj
= NULL
;
495 php_http_message_body_object_t
*old_obj
= zend_object_store_get_object(object TSRMLS_CC
);
497 new_ov
= php_http_message_body_object_new_ex(old_obj
->zo
.ce
, php_http_message_body_copy(old_obj
->body
, NULL
, 1), &new_obj TSRMLS_CC
);
498 zend_objects_clone_members(&new_obj
->zo
, new_ov
, &old_obj
->zo
, Z_OBJ_HANDLE_P(object
) TSRMLS_CC
);
503 void php_http_message_body_object_free(void *object TSRMLS_DC
)
505 php_http_message_body_object_t
*obj
= object
;
507 php_http_message_body_free(&obj
->body
);
509 zend_object_std_dtor((zend_object
*) obj TSRMLS_CC
);
513 PHP_METHOD(HttpMessageBody
, __construct
)
515 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
516 zval
*zstream
= NULL
;
519 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
520 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|r!", &zstream
)) {
522 php_stream_from_zval(stream
, &zstream
);
526 php_http_message_body_dtor(obj
->body
);
528 obj
->body
= php_http_message_body_init(obj
->body
, stream TSRMLS_CC
);
532 obj
->body
= php_http_message_body_init(NULL
, NULL TSRMLS_CC
);
535 } end_error_handling();
538 PHP_METHOD(HttpMessageBody
, __toString
)
540 if (SUCCESS
== zend_parse_parameters_none()) {
541 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
545 php_http_message_body_to_string(obj
->body
, &str
, &len
, 0, 0);
547 RETURN_STRINGL(str
, len
, 0);
550 RETURN_EMPTY_STRING();
553 PHP_METHOD(HttpMessageBody
, toStream
)
556 long offset
= 0, forlen
= 0;
558 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r|ll", &zstream
, &offset
, &forlen
)) {
560 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
562 php_stream_from_zval(stream
, &zstream
);
563 php_http_message_body_to_stream(obj
->body
, stream
, offset
, forlen
);
572 zend_fcall_info_cache fcc
;
578 static size_t pass(void *cb_arg
, const char *str
, size_t len
)
580 struct fcd
*fcd
= cb_arg
;
582 TSRMLS_FETCH_FROM_CTX(fcd
->ts
);
584 MAKE_STD_ZVAL(zdata
);
585 ZVAL_STRINGL(zdata
, str
, len
, 1);
586 if (SUCCESS
== zend_fcall_info_argn(&fcd
->fci TSRMLS_CC
, 2, &fcd
->fcz
, &zdata
)) {
587 zend_fcall_info_call(&fcd
->fci
, &fcd
->fcc
, NULL
, NULL TSRMLS_CC
);
588 zend_fcall_info_args_clear(&fcd
->fci
, 0);
590 zval_ptr_dtor(&zdata
);
594 PHP_METHOD(HttpMessageBody
, toCallback
)
596 struct fcd fcd
= {0};
597 long offset
= 0, forlen
= 0;
599 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "f|ll", &fcd
.fci
, &fcd
.fcc
, &offset
, &forlen
)) {
600 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
604 TSRMLS_SET_CTX(fcd
.ts
);
606 php_http_message_body_to_callback(obj
->body
, pass
, &fcd
, offset
, forlen
);
607 zend_fcall_info_args_clear(&fcd
.fci
, 1);
609 zval_ptr_dtor(&fcd
.fcz
);
615 PHP_METHOD(HttpMessageBody
, append
)
620 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &str
, &len
)) {
621 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
623 RETURN_LONG(php_http_message_body_append(obj
->body
, str
, len
));
628 PHP_METHOD(HttpMessageBody
, add
)
630 HashTable
*fields
= NULL
, *files
= NULL
;
632 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|h!h!", &fields
, &files
)) {
633 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
635 RETURN_SUCCESS(php_http_message_body_add(obj
->body
, fields
, files
));
640 PHP_METHOD(HttpMessageBody
, etag
)
642 if (SUCCESS
== zend_parse_parameters_none()) {
643 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
644 char *etag
= php_http_message_body_etag(obj
->body
);
647 RETURN_STRING(etag
, 0);
653 PHP_METHOD(HttpMessageBody
, stat
)
655 char *field_str
= NULL
;
658 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &field_str
, &field_len
)) {
659 php_http_message_body_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
660 const php_stream_statbuf
*sb
= php_http_message_body_stat(obj
->body
);
663 if (field_str
&& field_len
) {
664 switch (*field_str
) {
667 RETURN_LONG(sb
->sb
.st_size
);
671 RETURN_LONG(sb
->sb
.st_atime
);
675 RETURN_LONG(sb
->sb
.st_mtime
);
679 RETURN_LONG(sb
->sb
.st_ctime
);
682 php_http_error(HE_WARNING
, PHP_HTTP_E_MESSAGE_BODY
, "unknown stat field: '%s' (should be one of [s]ize, [a]time, [m]time or [c]time)", field_str
);
686 array_init(return_value
);
687 add_assoc_long_ex(return_value
, ZEND_STRS("size"), sb
->sb
.st_size
);
688 add_assoc_long_ex(return_value
, ZEND_STRS("atime"), sb
->sb
.st_atime
);
689 add_assoc_long_ex(return_value
, ZEND_STRS("mtime"), sb
->sb
.st_mtime
);
690 add_assoc_long_ex(return_value
, ZEND_STRS("ctime"), sb
->sb
.st_ctime
);
703 * vim600: noet sw=4 ts=4 fdm=marker
704 * vim<600: noet sw=4 ts=4