remodel file adding to accept paths, streams and plain data as upload files
[m6w6/ext-http] / php_http_message_body.h
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 #ifndef PHP_HTTP_MESSAGE_BODY_H
14 #define PHP_HTTP_MESSAGE_BODY_H
15
16 typedef struct php_http_message_body {
17 int stream_id;
18 php_stream_statbuf ssb;
19 char *boundary;
20 #ifdef ZTS
21 void ***ts;
22 #endif
23 } php_http_message_body_t;
24
25 typedef enum php_http_message_body_file_is {
26 PHP_HTTP_MESSAGE_BODY_FILE_IS_EMPTY,
27 PHP_HTTP_MESSAGE_BODY_FILE_IS_DATA,
28 PHP_HTTP_MESSAGE_BODY_FILE_IS_PATH,
29 PHP_HTTP_MESSAGE_BODY_FILE_IS_STREAM
30 } php_http_message_body_file_is_t;
31
32 typedef struct php_http_message_body_file {
33 php_http_message_body_file_is_t type;
34 size_t length;
35 union {
36 char *data;
37 char *path;
38 php_stream *stream;
39 } file;
40 } php_http_message_body_file_t;
41
42 PHP_HTTP_API php_http_message_body_t *php_http_message_body_init(php_http_message_body_t *body, php_stream *stream TSRMLS_DC);
43 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);
44 PHP_HTTP_API STATUS php_http_message_body_add(php_http_message_body_t *body, HashTable *fields, HashTable *files);
45 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);
46 PHP_HTTP_API STATUS php_http_message_body_add_file(php_http_message_body_t *body, const char *name, const char *ctype, const char *file, php_stream *stream);
47 PHP_HTTP_API size_t php_http_message_body_append(php_http_message_body_t *body, const char *buf, size_t len);
48 PHP_HTTP_API size_t php_http_message_body_appendf(php_http_message_body_t *body, const char *fmt, ...);
49 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);
50 PHP_HTTP_API void php_http_message_body_to_stream(php_http_message_body_t *body, php_stream *s, off_t offset, size_t forlen);
51 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);
52 PHP_HTTP_API void php_http_message_body_dtor(php_http_message_body_t *body);
53 PHP_HTTP_API void php_http_message_body_free(php_http_message_body_t **body);
54 PHP_HTTP_API const php_stream_statbuf *php_http_message_body_stat(php_http_message_body_t *body);
55 #define php_http_message_body_size(b) (php_http_message_body_stat((b))->sb.st_size)
56 #define php_http_message_body_mtime(b) (php_http_message_body_stat((b))->sb.st_mtime)
57 PHP_HTTP_API char *php_http_message_body_etag(php_http_message_body_t *body);
58 PHP_HTTP_API const char *php_http_message_body_boundary(php_http_message_body_t *body);
59
60 static inline php_stream *php_http_message_body_stream(php_http_message_body_t *body)
61 {
62 TSRMLS_FETCH_FROM_CTX(body->ts);
63 return zend_fetch_resource(NULL TSRMLS_CC, body->stream_id, "stream", NULL, 2, php_file_le_stream(), php_file_le_pstream());
64 }
65
66
67 typedef struct php_http_message_body_object {
68 zend_object zo;
69 php_http_message_body_t *body;
70 } php_http_message_body_object_t;
71
72 extern zend_class_entry *php_http_message_body_class_entry;
73 extern zend_function_entry php_http_message_body_method_entry[];
74
75 extern PHP_MINIT_FUNCTION(http_message_body);
76
77 extern zend_object_value php_http_message_body_object_new(zend_class_entry *ce TSRMLS_DC);
78 extern 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);
79 extern zend_object_value php_http_message_body_object_clone(zval *object TSRMLS_DC);
80 extern void php_http_message_body_object_free(void *object TSRMLS_DC);
81
82 PHP_METHOD(HttpMessageBody, __construct);
83 PHP_METHOD(HttpMessageBody, __toString);
84 PHP_METHOD(HttpMessageBody, toStream);
85 PHP_METHOD(HttpMessageBody, toCallback);
86 PHP_METHOD(HttpMessageBody, append);
87 PHP_METHOD(HttpMessageBody, add);
88 PHP_METHOD(HttpMessageBody, etag);
89 PHP_METHOD(HttpMessageBody, stat);
90
91 #endif
92
93 /*
94 * Local variables:
95 * tab-width: 4
96 * c-basic-offset: 4
97 * End:
98 * vim600: noet sw=4 ts=4 fdm=marker
99 * vim<600: noet sw=4 ts=4
100 */
101