- remove hackish UPLOADDATA code
[m6w6/ext-http] / php_http_request_api.h
1 /*
2 +----------------------------------------------------------------------+
3 | PECL :: http |
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
14 */
15
16 /* $Id$ */
17
18 #ifndef PHP_HTTP_REQUEST_API_H
19 #define PHP_HTTP_REQUEST_API_H
20
21 #include "php_http_std_defs.h"
22 #include "phpstr/phpstr.h"
23
24 #ifdef PHP_WIN32
25 # include <winsock2.h>
26 #endif
27
28 #include <curl/curl.h>
29
30 typedef enum {
31 HTTP_NO_REQUEST_METHOD = 0,
32 /* HTTP/1.1 */
33 HTTP_GET = 1,
34 HTTP_HEAD = 2,
35 HTTP_POST = 3,
36 HTTP_PUT = 4,
37 HTTP_DELETE = 5,
38 HTTP_OPTIONS = 6,
39 HTTP_TRACE = 7,
40 HTTP_CONNECT = 8,
41 /* WebDAV - RFC 2518 */
42 HTTP_PROPFIND = 9,
43 HTTP_PROPPATCH = 10,
44 HTTP_MKCOL = 11,
45 HTTP_COPY = 12,
46 HTTP_MOVE = 13,
47 HTTP_LOCK = 14,
48 HTTP_UNLOCK = 15,
49 /* WebDAV Versioning - RFC 3253 */
50 HTTP_VERSION_CONTROL = 16,
51 HTTP_REPORT = 17,
52 HTTP_CHECKOUT = 18,
53 HTTP_CHECKIN = 19,
54 HTTP_UNCHECKOUT = 20,
55 HTTP_MKWORKSPACE = 21,
56 HTTP_UPDATE = 22,
57 HTTP_LABEL = 23,
58 HTTP_MERGE = 24,
59 HTTP_BASELINE_CONTROL = 25,
60 HTTP_MKACTIVITY = 26,
61 /* WebDAV Access Control - RFC 3744 */
62 HTTP_ACL = 27,
63 HTTP_MAX_REQUEST_METHOD = 28
64 } http_request_method;
65
66 #define HTTP_STD_REQUEST_METHOD(m) ((m > HTTP_NO_REQUEST_METHOD) && (m < HTTP_MAX_REQUEST_METHOD))
67 #define HTTP_CUSTOM_REQUEST_METHOD(m) (m - HTTP_MAX_REQUEST_METHOD)
68
69 #define HTTP_REQUEST_BODY_CSTRING 1
70 #define HTTP_REQUEST_BODY_CURLPOST 2
71 #define HTTP_REQUEST_BODY_UPLOADFILE 3
72 typedef struct {
73 int type;
74 void *data;
75 size_t size;
76 } http_request_body;
77
78 typedef struct {
79 CURLM *ch;
80 zend_llist handles;
81 zend_llist bodies;
82 int unfinished;
83 } http_request_pool;
84
85 #define COPY_STRING 1
86 #define COPY_SLIST 2
87 #define http_request_data_copy(type, data) _http_request_data_copy((type), (data) TSRMLS_CC)
88 extern void *_http_request_data_copy(int type, void *data TSRMLS_DC);
89 #define http_request_data_free_string _http_request_data_free_string
90 extern void _http_request_data_free_string(void *string);
91 #define http_request_data_free_slist _http_request_data_free_slist
92 extern void _http_request_data_free_slist(void *list);
93
94 #define http_request_pool_responsehandler _http_request_pool_responsehandler
95 extern void http_request_pool_responsehandler(zval **req TSRMLS_DC);
96
97 #define http_request_global_init _http_request_global_init
98 extern STATUS _http_request_global_init(void);
99
100 #define http_request_method_name(m) _http_request_method_name((m) TSRMLS_CC)
101 PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC);
102
103 #define http_request_method_exists(u, l, c) _http_request_method_exists((u), (l), (c) TSRMLS_CC)
104 PHP_HTTP_API unsigned long _http_request_method_exists(zend_bool by_name, unsigned long id, const char *name TSRMLS_DC);
105
106 #define http_request_method_register(m) _http_request_method_register((m) TSRMLS_CC)
107 PHP_HTTP_API unsigned long _http_request_method_register(const char *method TSRMLS_DC);
108
109 #define http_request_method_unregister(mn) _http_request_method_unregister((mn) TSRMLS_CC)
110 PHP_HTTP_API STATUS _http_request_method_unregister(unsigned long method TSRMLS_DC);
111
112 #define http_request_body_new() _http_request_body_new(TSRMLS_C)
113 PHP_HTTP_API http_request_body *_http_request_body_new(TSRMLS_D);
114
115 #define http_request_body_fill(b, fields, files) _http_request_body_fill((b), (fields), (files) TSRMLS_CC)
116 PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *fields, HashTable *files TSRMLS_DC);
117
118 #define http_request_body_dtor(b) _http_request_body_dtor((b) TSRMLS_CC)
119 PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC);
120
121 #define http_request_body_free(b) _http_request_body_free((b) TSRMLS_CC)
122 PHP_HTTP_API void _http_request_body_free(http_request_body *body TSRMLS_DC);
123
124 #define http_request_pool_init(p) _http_request_pool_init((p) TSRMLS_CC)
125 PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC);
126
127 #define http_request_pool_attach(p, r) _http_request_pool_attach((p), (r) TSRMLS_CC)
128 PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC);
129
130 #define http_request_pool_detach(p, r) _http_request_pool_detach((p), (r) TSRMLS_CC)
131 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC);
132
133 #define http_request_pool_detach_all(p) _http_request_pool_detach_all((p) TSRMLS_CC)
134 PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC);
135
136 #define http_request_pool_send(p) _http_request_pool_send((p) TSRMLS_CC)
137 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC);
138
139 #define http_request_pool_select _http_request_pool_select
140 PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool);
141
142 #define http_request_pool_perform _http_request_pool_perform
143 PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool);
144
145 #define http_request_pool_dtor(p) _http_request_pool_dtor((p) TSRMLS_CC)
146 PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC);
147
148 #define http_request_init(ch, meth, url, body, options, response) _http_request_init((ch), (meth), (url), (body), (options), (response) TSRMLS_CC)
149 PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, const char *url, http_request_body *body, HashTable *options, phpstr *response TSRMLS_DC);
150
151 #define http_request_exec(ch, i) _http_request_exec((ch), (i) TSRMLS_CC)
152 PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info TSRMLS_DC);
153
154 #define http_request_info(ch, i) _http_request_info((ch), (i) TSRMLS_CC)
155 PHP_HTTP_API void _http_request_info(CURL *ch, HashTable *info TSRMLS_DC);
156
157 #define http_request(meth, url, body, opt, info, resp) _http_request_ex(NULL, (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
158 #define http_request_ex(ch, meth, url, body, opt, info, resp) _http_request_ex((ch), (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
159 PHP_HTTP_API STATUS _http_request_ex(CURL *ch, http_request_method meth, const char *URL, http_request_body *body, HashTable *options, HashTable *info, phpstr *response TSRMLS_DC);
160
161 #define http_get(u, o, i, r) _http_request_ex(NULL, HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
162 #define http_get_ex(c, u, o, i, r) _http_request_ex((c), HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
163
164 #define http_head(u, o, i, r) _http_request_ex(NULL, HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
165 #define http_head_ex(c, u, o, i, r) _http_request_ex((c), HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
166
167 #define http_post(u, b, o, i, r) _http_request_ex(NULL, HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
168 #define http_post_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
169
170 #define http_put(u, b, o, i, r) _http_request_ex(NULL, HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
171 #define http_put_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
172
173 #endif
174
175 /*
176 * Local variables:
177 * tab-width: 4
178 * c-basic-offset: 4
179 * End:
180 * vim600: noet sw=4 ts=4 fdm=marker
181 * vim<600: noet sw=4 ts=4
182 */
183