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_CLIENT_H
14 #define PHP_HTTP_CLIENT_H
16 #include "php_http_message_body.h"
17 #include "php_http_message_parser.h"
19 typedef struct php_http_client_progress_state
{
31 } php_http_client_progress_state_t
;
33 #define PHP_HTTP_CLIENT_PROGRESS_CALLBACK_USER 0
34 #define PHP_HTTP_CLIENT_PROGRESS_CALLBACK_INTERN 1
35 typedef struct php_http_client_progress_callback
{
38 void (*intern
)(php_http_client_progress_state_t
* TSRMLS_DC
);
41 unsigned pass_state
:1;
42 } php_http_client_progress_callback_t
;
44 typedef struct php_http_client_progress
{
45 php_http_client_progress_state_t state
;
46 php_http_client_progress_callback_t
*callback
;
48 } php_http_client_progress_t
;
50 static inline void php_http_client_progress_dtor(php_http_client_progress_t
*progress TSRMLS_DC
)
52 if (progress
->callback
) {
53 if (progress
->callback
->type
== PHP_HTTP_CLIENT_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_client_progress_notify(php_http_client_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_CLIENT_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_CLIENT_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_client_setopt_opt
{
109 PHP_HTTP_CLIENT_OPT_SETTINGS
, /* HashTable* */
110 PHP_HTTP_CLIENT_OPT_PROGRESS_CALLBACK
, /* php_http_client_progress_callback_t* */
111 PHP_HTTP_CLIENT_OPT_COOKIES_ENABLE
, /* - */
112 PHP_HTTP_CLIENT_OPT_COOKIES_RESET
, /* - */
113 PHP_HTTP_CLIENT_OPT_COOKIES_RESET_SESSION
, /* - */
114 PHP_HTTP_CLIENT_OPT_COOKIES_FLUSH
, /* - */
115 } php_http_client_setopt_opt_t
;
117 typedef enum php_http_client_getopt_opt
{
118 PHP_HTTP_CLIENT_OPT_PROGRESS_INFO
, /* php_http_client_progress_t** */
119 PHP_HTTP_CLIENT_OPT_TRANSFER_INFO
, /* HashTable* */
120 } php_http_client_getopt_opt_t
;
122 typedef struct php_http_client
*(*php_http_client_init_func_t
)(struct php_http_client
*h
, void *arg
);
123 typedef struct php_http_client
*(*php_http_client_copy_func_t
)(struct php_http_client
*from
, struct php_http_client
*to
);
124 typedef void (*php_http_client_dtor_func_t
)(struct php_http_client
*h
);
125 typedef STATUS (*php_http_client_exec_func_t
)(struct php_http_client
*h
, php_http_message_t
*msg
);
126 typedef STATUS (*php_http_client_reset_func_t
)(struct php_http_client
*h
);
127 typedef STATUS (*php_http_client_setopt_func_t
)(struct php_http_client
*h
, php_http_client_setopt_opt_t opt
, void *arg
);
128 typedef STATUS (*php_http_client_getopt_func_t
)(struct php_http_client
*h
, php_http_client_getopt_opt_t opt
, void *arg
);
130 typedef struct php_http_client_ops
{
131 php_http_resource_factory_ops_t
*rsrc
;
132 php_http_client_init_func_t init
;
133 php_http_client_copy_func_t copy
;
134 php_http_client_dtor_func_t dtor
;
135 php_http_client_reset_func_t reset
;
136 php_http_client_exec_func_t exec
;
137 php_http_client_setopt_func_t setopt
;
138 php_http_client_getopt_func_t getopt
;
139 php_http_new_t create_object
;
140 zend_class_entry
*(*class_entry
)(void);
141 } php_http_client_ops_t
;
143 typedef struct php_http_client
{
145 php_http_resource_factory_t
*rf
;
146 php_http_client_ops_t
*ops
;
147 php_http_message_parser_t
*parser
;
148 php_http_message_t
*message
;
149 php_http_buffer_t
*buffer
;
155 PHP_HTTP_API php_http_client_t
*php_http_client_init(php_http_client_t
*h
, php_http_client_ops_t
*ops
, php_http_resource_factory_t
*rf
, void *init_arg TSRMLS_DC
);
156 PHP_HTTP_API php_http_client_t
*php_http_client_copy(php_http_client_t
*from
, php_http_client_t
*to
);
157 PHP_HTTP_API STATUS
php_http_client_exec(php_http_client_t
*h
, php_http_message_t
*msg
);
158 PHP_HTTP_API STATUS
php_http_client_reset(php_http_client_t
*h
);
159 PHP_HTTP_API STATUS
php_http_client_setopt(php_http_client_t
*h
, php_http_client_setopt_opt_t opt
, void *arg
);
160 PHP_HTTP_API STATUS
php_http_client_getopt(php_http_client_t
*h
, php_http_client_getopt_opt_t opt
, void *arg
);
161 PHP_HTTP_API
void php_http_client_dtor(php_http_client_t
*h
);
162 PHP_HTTP_API
void php_http_client_free(php_http_client_t
**h
);
164 typedef struct php_http_client_object
{
166 php_http_client_t
*client
;
167 } php_http_client_object_t
;
169 zend_object_value
php_http_client_object_new(zend_class_entry
*ce TSRMLS_DC
);
170 zend_object_value
php_http_client_object_new_ex(zend_class_entry
*ce
, php_http_client_t
*r
, php_http_client_object_t
**ptr TSRMLS_DC
);
171 zend_object_value
php_http_client_object_clone(zval
*zobject TSRMLS_DC
);
172 void php_http_client_object_free(void *object TSRMLS_DC
);
174 zend_class_entry
*php_http_client_get_class_entry(void);
175 zend_object_handlers
*php_http_client_get_object_handlers(void);
177 STATUS
php_http_client_object_handle_request(zval
*zclient
, zval
**zreq TSRMLS_DC
);
178 STATUS
php_http_client_object_handle_response(zval
*zclient TSRMLS_DC
);
180 STATUS
php_http_client_object_requesthandler(php_http_client_object_t
*obj
, zval
*this_ptr
, char **meth
, char **url
, php_http_message_body_t
**body TSRMLS_DC
);
181 STATUS
php_http_client_object_responsehandler(php_http_client_object_t
*obj
, zval
*this_ptr TSRMLS_DC
);
183 PHP_METHOD(HttpClient
, __construct
);
184 PHP_METHOD(HttpClient
, getObservers
);
185 PHP_METHOD(HttpClient
, notify
);
186 PHP_METHOD(HttpClient
, attach
);
187 PHP_METHOD(HttpClient
, detach
);
188 PHP_METHOD(HttpClient
, getProgress
);
189 PHP_METHOD(HttpClient
, getTransferInfo
);
190 PHP_METHOD(HttpClient
, setOptions
);
191 PHP_METHOD(HttpClient
, getOptions
);
192 PHP_METHOD(HttpClient
, addSslOptions
);
193 PHP_METHOD(HttpClient
, setSslOptions
);
194 PHP_METHOD(HttpClient
, getSslOptions
);
195 PHP_METHOD(HttpClient
, addCookies
);
196 PHP_METHOD(HttpClient
, getCookies
);
197 PHP_METHOD(HttpClient
, setCookies
);
198 PHP_METHOD(HttpClient
, enableCookies
);
199 PHP_METHOD(HttpClient
, resetCookies
);
200 PHP_METHOD(HttpClient
, flushCookies
);
201 PHP_METHOD(HttpClient
, setRequest
);
202 PHP_METHOD(HttpClient
, getRequest
);
203 PHP_METHOD(HttpClient
, send
);
204 PHP_METHOD(HttpClient
, getResponseMessage
);
205 PHP_METHOD(HttpClient
, getRequestMessage
);
206 PHP_METHOD(HttpClient
, getHistory
);
207 PHP_METHOD(HttpClient
, clearHistory
);
208 PHP_METHOD(HttpClient
, getResponseMessageClass
);
209 PHP_METHOD(HttpClient
, setResponseMessageClass
);
211 PHP_MINIT_FUNCTION(http_client
);
220 * vim600: noet sw=4 ts=4 fdm=marker
221 * vim<600: noet sw=4 ts=4