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 #ifndef PHP_HTTP_REQUEST_H
14 #define PHP_HTTP_REQUEST_H
16 #include "php_http_message_body.h"
17 #include "php_http_message_parser.h"
19 typedef struct php_http_request_progress_state
{
31 } php_http_request_progress_state_t
;
33 #define PHP_HTTP_REQUEST_PROGRESS_CALLBACK_USER 0
34 #define PHP_HTTP_REQUEST_PROGRESS_CALLBACK_INTERN 1
35 typedef struct php_http_request_progress_callback
{
38 void (*intern
)(php_http_request_progress_state_t
* TSRMLS_DC
);
41 unsigned pass_state
:1;
42 } php_http_request_progress_callback_t
;
44 typedef struct php_http_request_progress
{
45 php_http_request_progress_state_t state
;
46 php_http_request_progress_callback_t
*callback
;
48 } php_http_request_progress_t
;
50 static inline void php_http_request_progress_dtor(php_http_request_progress_t
*progress TSRMLS_DC
)
52 if (progress
->callback
) {
53 if (progress
->callback
->type
== PHP_HTTP_REQUEST_PROGRESS_CALLBACK_USER
) {
54 zval_ptr_dtor(&progress
->callback
->func
.user
);
56 efree(progress
->callback
);
58 memset(progress
, 0, sizeof(*progress
));
61 static inline void php_http_request_progress_notify(php_http_request_progress_t
*progress TSRMLS_DC
)
63 if (progress
->callback
) {
69 with_error_handling(EH_NORMAL
, NULL
) {
70 switch (progress
->callback
->type
) {
71 case PHP_HTTP_REQUEST_PROGRESS_CALLBACK_USER
:
72 if (progress
->callback
->pass_state
) {
77 add_assoc_bool(param
, "started", progress
->state
.started
);
78 add_assoc_bool(param
, "finished", progress
->state
.finished
);
79 add_assoc_string(param
, "info", estrdup(progress
->state
.info
), 0);
80 add_assoc_double(param
, "dltotal", progress
->state
.dl
.total
);
81 add_assoc_double(param
, "dlnow", progress
->state
.dl
.now
);
82 add_assoc_double(param
, "ultotal", progress
->state
.ul
.total
);
83 add_assoc_double(param
, "ulnow", progress
->state
.ul
.now
);
86 call_user_function(EG(function_table
), NULL
, progress
->callback
->func
.user
, &retval
, 1, ¶m TSRMLS_CC
);
89 zval_ptr_dtor(¶m
);
92 call_user_function(EG(function_table
), NULL
, progress
->callback
->func
.user
, &retval
, 0, NULL TSRMLS_CC
);
96 case PHP_HTTP_REQUEST_PROGRESS_CALLBACK_INTERN
:
97 progress
->callback
->func
.intern(progress
->callback
->pass_state
? &progress
->state
: NULL TSRMLS_CC
);
102 } end_error_handling();
108 typedef enum php_http_request_setopt_opt
{
109 PHP_HTTP_REQUEST_OPT_SETTINGS
, /* HashTable* */
110 PHP_HTTP_REQUEST_OPT_PROGRESS_CALLBACK
, /* php_http_request_progress_callback_t* */
111 PHP_HTTP_REQUEST_OPT_COOKIES_ENABLE
, /* - */
112 PHP_HTTP_REQUEST_OPT_COOKIES_RESET
, /* - */
113 PHP_HTTP_REQUEST_OPT_COOKIES_RESET_SESSION
, /* - */
114 PHP_HTTP_REQUEST_OPT_COOKIES_FLUSH
, /* - */
115 } php_http_request_setopt_opt_t
;
117 typedef enum php_http_request_getopt_opt
{
118 PHP_HTTP_REQUEST_OPT_PROGRESS_INFO
, /* php_http_request_progress_t** */
119 PHP_HTTP_REQUEST_OPT_TRANSFER_INFO
, /* HashTable* */
120 } php_http_request_getopt_opt_t
;
122 typedef struct php_http_request php_http_request_t
;
124 typedef php_http_request_t
*(*php_http_request_init_func_t
)(php_http_request_t
*h
, void *arg
);
125 typedef php_http_request_t
*(*php_http_request_copy_func_t
)(php_http_request_t
*from
, php_http_request_t
*to
);
126 typedef void (*php_http_request_dtor_func_t
)(php_http_request_t
*h
);
127 typedef STATUS (*php_http_request_exec_func_t
)(php_http_request_t
*h
, const char *meth
, const char *url
, php_http_message_body_t
*body
);
128 typedef STATUS (*php_http_request_reset_func_t
)(php_http_request_t
*h
);
129 typedef STATUS (*php_http_request_setopt_func_t
)(php_http_request_t
*h
, php_http_request_setopt_opt_t opt
, void *arg
);
130 typedef STATUS (*php_http_request_getopt_func_t
)(php_http_request_t
*h
, php_http_request_getopt_opt_t opt
, void *arg
);
132 typedef struct php_http_request_ops
{
133 php_http_resource_factory_ops_t
*rsrc
;
134 php_http_request_init_func_t init
;
135 php_http_request_copy_func_t copy
;
136 php_http_request_dtor_func_t dtor
;
137 php_http_request_reset_func_t reset
;
138 php_http_request_exec_func_t exec
;
139 php_http_request_setopt_func_t setopt
;
140 php_http_request_getopt_func_t getopt
;
141 } php_http_request_ops_t
;
143 PHP_HTTP_API php_http_request_ops_t
*php_http_request_get_default_ops(TSRMLS_D
);
145 struct php_http_request
{
147 php_http_resource_factory_t
*rf
;
148 php_http_request_ops_t
*ops
;
149 php_http_message_parser_t
*parser
;
150 php_http_message_t
*message
;
151 php_http_buffer_t
*buffer
;
157 PHP_HTTP_API php_http_request_t
*php_http_request_init(php_http_request_t
*h
, php_http_request_ops_t
*ops
, php_http_resource_factory_t
*rf
, void *init_arg TSRMLS_DC
);
158 PHP_HTTP_API php_http_request_t
*php_http_request_copy(php_http_request_t
*from
, php_http_request_t
*to
);
159 PHP_HTTP_API STATUS
php_http_request_exec(php_http_request_t
*h
, const char *meth
, const char *url
, php_http_message_body_t
*body
);
160 PHP_HTTP_API STATUS
php_http_request_reset(php_http_request_t
*h
);
161 PHP_HTTP_API STATUS
php_http_request_setopt(php_http_request_t
*h
, php_http_request_setopt_opt_t opt
, void *arg
);
162 PHP_HTTP_API STATUS
php_http_request_getopt(php_http_request_t
*h
, php_http_request_getopt_opt_t opt
, void *arg
);
163 PHP_HTTP_API
void php_http_request_dtor(php_http_request_t
*h
);
164 PHP_HTTP_API
void php_http_request_free(php_http_request_t
**h
);
166 typedef struct php_http_request_object
{
168 php_http_request_t
*request
;
169 } php_http_request_object_t
;
171 extern zend_class_entry
*php_http_request_class_entry
;
172 extern zend_function_entry php_http_request_method_entry
[];
174 extern zend_object_value
php_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
);
175 extern zend_object_value
php_http_request_object_new_ex(zend_class_entry
*ce
, php_http_request_t
*r
, php_http_request_object_t
**ptr TSRMLS_DC
);
176 extern zend_object_value
php_http_request_object_clone(zval
*zobject TSRMLS_DC
);
177 extern void php_http_request_object_free(void *object TSRMLS_DC
);
179 extern STATUS
php_http_request_object_requesthandler(php_http_request_object_t
*obj
, zval
*this_ptr
, char **meth
, char **url
, php_http_message_body_t
**body TSRMLS_DC
);
180 extern STATUS
php_http_request_object_responsehandler(php_http_request_object_t
*obj
, zval
*this_ptr TSRMLS_DC
);
182 PHP_METHOD(HttpRequest
, __construct
);
183 PHP_METHOD(HttpRequest
, getObservers
);
184 PHP_METHOD(HttpRequest
, notify
);
185 PHP_METHOD(HttpRequest
, attach
);
186 PHP_METHOD(HttpRequest
, detach
);
187 PHP_METHOD(HttpRequest
, getProgress
);
188 PHP_METHOD(HttpRequest
, getTransferInfo
);
189 PHP_METHOD(HttpRequest
, setOptions
);
190 PHP_METHOD(HttpRequest
, getOptions
);
191 PHP_METHOD(HttpRequest
, addSslOptions
);
192 PHP_METHOD(HttpRequest
, setSslOptions
);
193 PHP_METHOD(HttpRequest
, getSslOptions
);
194 PHP_METHOD(HttpRequest
, addHeaders
);
195 PHP_METHOD(HttpRequest
, getHeaders
);
196 PHP_METHOD(HttpRequest
, setHeaders
);
197 PHP_METHOD(HttpRequest
, addCookies
);
198 PHP_METHOD(HttpRequest
, getCookies
);
199 PHP_METHOD(HttpRequest
, setCookies
);
200 PHP_METHOD(HttpRequest
, enableCookies
);
201 PHP_METHOD(HttpRequest
, resetCookies
);
202 PHP_METHOD(HttpRequest
, flushCookies
);
203 PHP_METHOD(HttpRequest
, setMethod
);
204 PHP_METHOD(HttpRequest
, getMethod
);
205 PHP_METHOD(HttpRequest
, setUrl
);
206 PHP_METHOD(HttpRequest
, getUrl
);
207 PHP_METHOD(HttpRequest
, setContentType
);
208 PHP_METHOD(HttpRequest
, getContentType
);
209 PHP_METHOD(HttpRequest
, setQueryData
);
210 PHP_METHOD(HttpRequest
, getQueryData
);
211 PHP_METHOD(HttpRequest
, addQueryData
);
212 PHP_METHOD(HttpRequest
, getBody
);
213 PHP_METHOD(HttpRequest
, setBody
);
214 PHP_METHOD(HttpRequest
, addBody
);
215 PHP_METHOD(HttpRequest
, send
);
216 PHP_METHOD(HttpRequest
, getResponseData
);
217 PHP_METHOD(HttpRequest
, getResponseHeader
);
218 PHP_METHOD(HttpRequest
, getResponseCookies
);
219 PHP_METHOD(HttpRequest
, getResponseCode
);
220 PHP_METHOD(HttpRequest
, getResponseStatus
);
221 PHP_METHOD(HttpRequest
, getResponseBody
);
222 PHP_METHOD(HttpRequest
, getResponseMessage
);
223 PHP_METHOD(HttpRequest
, getRawResponseMessage
);
224 PHP_METHOD(HttpRequest
, getRequestMessage
);
225 PHP_METHOD(HttpRequest
, getRawRequestMessage
);
226 PHP_METHOD(HttpRequest
, getHistory
);
227 PHP_METHOD(HttpRequest
, clearHistory
);
228 PHP_METHOD(HttpRequest
, getMessageClass
);
229 PHP_METHOD(HttpRequest
, setMessageClass
);
231 extern PHP_MINIT_FUNCTION(http_request
);
240 * vim600: noet sw=4 ts=4 fdm=marker
241 * vim<600: noet sw=4 ts=4