2 +----------------------------------------------------------------------+
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 +----------------------------------------------------------------------+
24 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
26 #include "zend_interfaces.h"
28 #include "php_http_std_defs.h"
29 #include "php_http_request_object.h"
30 #include "php_http_request_api.h"
31 #include "php_http_request_pool_api.h"
33 #include "php_http_api.h"
34 #include "php_http_url_api.h"
35 #include "php_http_message_api.h"
36 #include "php_http_message_object.h"
37 #include "php_http_exception_object.h"
42 # include <winsock2.h>
44 #include <curl/curl.h>
46 ZEND_EXTERN_MODULE_GLOBALS(http
);
48 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
49 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
50 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
51 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
53 HTTP_EMPTY_ARGS(__destruct
, 0);
54 HTTP_BEGIN_ARGS(__construct
, 0, 0)
56 HTTP_ARG_VAL(method
, 0)
57 HTTP_ARG_VAL(options
, 0)
60 HTTP_EMPTY_ARGS(getOptions
, 0);
61 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
62 HTTP_ARG_VAL(options
, 0)
65 HTTP_EMPTY_ARGS(getSslOptions
, 0);
66 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
67 HTTP_ARG_VAL(ssl_options
, 0)
70 HTTP_EMPTY_ARGS(getHeaders
, 0);
71 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
72 HTTP_ARG_VAL(headers
, 0)
75 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
76 HTTP_ARG_VAL(headers
, 0)
79 HTTP_EMPTY_ARGS(getCookies
, 0);
80 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
81 HTTP_ARG_VAL(cookies
, 0)
84 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
85 HTTP_ARG_VAL(cookies
, 0)
88 HTTP_EMPTY_ARGS(getUrl
, 0);
89 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
93 HTTP_EMPTY_ARGS(getMethod
, 0);
94 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
95 HTTP_ARG_VAL(request_method
, 0)
98 HTTP_EMPTY_ARGS(getContentType
, 0);
99 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
100 HTTP_ARG_VAL(content_type
, 0)
103 HTTP_EMPTY_ARGS(getQueryData
, 0);
104 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
105 HTTP_ARG_VAL(query_data
, 0)
108 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
109 HTTP_ARG_VAL(query_data
, 0)
112 HTTP_EMPTY_ARGS(getPostFields
, 0);
113 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
114 HTTP_ARG_VAL(post_fields
, 0)
117 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
118 HTTP_ARG_VAL(post_fields
, 0)
121 HTTP_EMPTY_ARGS(getPostFiles
, 0);
122 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
123 HTTP_ARG_VAL(post_files
, 0)
126 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
127 HTTP_ARG_VAL(formname
, 0)
128 HTTP_ARG_VAL(filename
, 0)
129 HTTP_ARG_VAL(content_type
, 0)
132 HTTP_EMPTY_ARGS(getRawPostData
, 0);
133 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
134 HTTP_ARG_VAL(raw_post_data
, 0)
137 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
138 HTTP_ARG_VAL(raw_post_data
, 0)
141 HTTP_EMPTY_ARGS(getPutFile
, 0);
142 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
143 HTTP_ARG_VAL(filename
, 0)
146 HTTP_EMPTY_ARGS(getResponseData
, 0);
147 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
148 HTTP_ARG_VAL(name
, 0)
151 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
152 HTTP_ARG_VAL(name
, 0)
155 HTTP_EMPTY_ARGS(getResponseBody
, 0);
156 HTTP_EMPTY_ARGS(getResponseCode
, 0);
157 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
158 HTTP_ARG_VAL(name
, 0)
161 HTTP_EMPTY_ARGS(getResponseMessage
, 1);
162 HTTP_EMPTY_ARGS(getRequestMessage
, 1);
163 HTTP_EMPTY_ARGS(getHistory
, 1);
164 HTTP_EMPTY_ARGS(clearHistory
, 0);
165 HTTP_EMPTY_ARGS(send
, 1);
167 HTTP_BEGIN_ARGS(get
, 0, 1)
169 HTTP_ARG_VAL(options
, 0)
170 HTTP_ARG_VAL(info
, 1)
173 HTTP_BEGIN_ARGS(head
, 0, 1)
175 HTTP_ARG_VAL(options
, 0)
176 HTTP_ARG_VAL(info
, 1)
179 HTTP_BEGIN_ARGS(postData
, 0, 2)
181 HTTP_ARG_VAL(data
, 0)
182 HTTP_ARG_VAL(options
, 0)
183 HTTP_ARG_VAL(info
, 1)
186 HTTP_BEGIN_ARGS(postFields
, 0, 2)
188 HTTP_ARG_VAL(data
, 0)
189 HTTP_ARG_VAL(options
, 0)
190 HTTP_ARG_VAL(info
, 1)
193 HTTP_BEGIN_ARGS(putFile
, 0, 2)
195 HTTP_ARG_VAL(file
, 0)
196 HTTP_ARG_VAL(options
, 0)
197 HTTP_ARG_VAL(info
, 1)
200 HTTP_BEGIN_ARGS(putStream
, 0, 2)
202 HTTP_ARG_VAL(stream
, 0)
203 HTTP_ARG_VAL(options
, 0)
204 HTTP_ARG_VAL(info
, 1)
207 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
208 HTTP_ARG_VAL(method_name
, 0)
211 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
212 HTTP_ARG_VAL(method
, 0)
215 HTTP_BEGIN_ARGS(methodName
, 0, 1)
216 HTTP_ARG_VAL(method_id
, 0)
219 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
220 HTTP_ARG_VAL(method
, 0)
223 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
224 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
226 zend_class_entry
*http_request_object_ce
;
227 zend_function_entry http_request_object_fe
[] = {
228 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
229 HTTP_REQUEST_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
231 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
232 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
234 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
236 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
237 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
238 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
240 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
241 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
245 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
253 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
257 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
262 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
276 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
277 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
278 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
279 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
280 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
281 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
282 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
283 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
285 HTTP_REQUEST_ALIAS(get
, http_get
)
286 HTTP_REQUEST_ALIAS(head
, http_head
)
287 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
288 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
289 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
290 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
292 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
293 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
294 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
295 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
299 static zend_object_handlers http_request_object_handlers
;
301 PHP_MINIT_FUNCTION(http_request_object
)
303 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
307 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
309 zend_object_value ov
;
310 http_request_object
*o
;
312 o
= ecalloc(1, sizeof(http_request_object
));
314 o
->ch
= curl_easy_init();
316 phpstr_init(&o
->history
);
317 phpstr_init(&o
->request
);
318 phpstr_init_ex(&o
->response
, HTTP_CURLBUF_SIZE
, 0);
320 ALLOC_HASHTABLE(OBJ_PROP(o
));
321 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
322 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
324 ov
.handle
= putObject(http_request_object
, o
);
325 ov
.handlers
= &http_request_object_handlers
;
330 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
332 zend_class_entry
*ce
= http_request_object_ce
;
334 DCL_PROP_N(PROTECTED
, options
);
335 DCL_PROP_N(PROTECTED
, responseInfo
);
336 DCL_PROP_N(PROTECTED
, responseData
);
337 DCL_PROP_N(PROTECTED
, responseCode
);
338 DCL_PROP_N(PROTECTED
, responseMessage
);
339 DCL_PROP_N(PROTECTED
, postFields
);
340 DCL_PROP_N(PROTECTED
, postFiles
);
342 DCL_PROP(PROTECTED
, long, method
, HTTP_GET
);
344 DCL_PROP(PROTECTED
, string
, url
, "");
345 DCL_PROP(PROTECTED
, string
, contentType
, "");
346 DCL_PROP(PROTECTED
, string
, rawPostData
, "");
347 DCL_PROP(PROTECTED
, string
, queryData
, "");
348 DCL_PROP(PROTECTED
, string
, putFile
, "");
350 DCL_PROP(PUBLIC
, bool, recordHistory
, 1);
354 * Request Method Constants
357 DCL_CONST(long, "METH_GET", HTTP_GET
);
358 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
359 DCL_CONST(long, "METH_POST", HTTP_POST
);
360 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
361 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
362 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
363 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
364 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
365 /* WebDAV - RFC 2518 */
366 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
367 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
368 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
369 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
370 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
371 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
372 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
373 /* WebDAV Versioning - RFC 3253 */
374 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
375 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
376 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
377 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
378 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
379 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
380 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
381 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
382 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
383 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
384 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
385 /* WebDAV Access Control - RFC 3744 */
386 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
391 # if LIBCURL_VERSION_NUM >= 0x070a05
392 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
393 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
394 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
395 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
396 # endif /* LIBCURL_VERSION_NUM */
400 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
402 http_request_object
*o
= (http_request_object
*) object
;
405 zend_hash_destroy(OBJ_PROP(o
));
406 FREE_HASHTABLE(OBJ_PROP(o
));
409 /* avoid nasty segfaults with already cleaned up callbacks */
410 curl_easy_setopt(o
->ch
, CURLOPT_NOPROGRESS
, 1);
411 curl_easy_setopt(o
->ch
, CURLOPT_PROGRESSFUNCTION
, NULL
);
412 curl_easy_setopt(o
->ch
, CURLOPT_VERBOSE
, 0);
413 curl_easy_setopt(o
->ch
, CURLOPT_DEBUGFUNCTION
, NULL
);
414 curl_easy_cleanup(o
->ch
);
416 phpstr_dtor(&o
->response
);
417 phpstr_dtor(&o
->request
);
418 phpstr_dtor(&o
->history
);
422 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr
, http_request_body
*body TSRMLS_DC
)
426 STATUS status
= SUCCESS
;
431 HTTP_CHECK_CURL_INIT(obj
->ch
, curl_easy_init(), return FAILURE
);
433 URL
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, url
));
434 // HTTP_URI_MAXLEN+1 long char *
435 if (!(request_uri
= http_absolute_uri_ex(Z_STRVAL_P(URL
), Z_STRLEN_P(URL
), NULL
, 0, NULL
, 0, 0))) {
439 meth
= convert_to_type_ex(IS_LONG
, GET_PROP(obj
, method
));
440 switch (Z_LVAL_P(meth
))
450 php_stream_statbuf ssb
;
451 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(obj
, putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
453 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
454 body
->type
= HTTP_REQUEST_BODY_UPLOADFILE
;
456 body
->size
= ssb
.sb
.st_size
;
466 /* check for raw post data */
467 zval
*raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
));
469 if (Z_STRLEN_P(raw_data
)) {
470 zval
*ctype
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, contentType
));
472 if (Z_STRLEN_P(ctype
)) {
473 zval
**headers
, *opts
= GET_PROP(obj
, options
);
475 convert_to_array(opts
);
477 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) {
480 convert_to_array(*headers
);
481 /* only override if not already set */
482 if (SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) {
483 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
488 MAKE_STD_ZVAL(headers
);
490 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
491 add_assoc_zval(opts
, "headers", headers
);
495 body
->type
= HTTP_REQUEST_BODY_CSTRING
;
496 body
->data
= estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
));
497 body
->size
= Z_STRLEN_P(raw_data
);
499 status
= http_request_body_fill(body
, Z_ARRVAL_P(GET_PROP(obj
, postFields
)), Z_ARRVAL_P(GET_PROP(obj
, postFiles
)));
505 if (status
== SUCCESS
) {
506 zval
*qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
));
508 if (Z_STRLEN_P(qdata
)) {
509 if (!strchr(request_uri
, '?')) {
510 strlcat(request_uri
, "?", HTTP_URI_MAXLEN
);
512 strlcat(request_uri
, "&", HTTP_URI_MAXLEN
);
514 strlcat(request_uri
, Z_STRVAL_P(qdata
), HTTP_URI_MAXLEN
);
517 status
= http_request_init(obj
->ch
, Z_LVAL_P(meth
), request_uri
, body
, Z_ARRVAL_P(GET_PROP(obj
, options
)));
521 /* clean previous response */
522 phpstr_dtor(&obj
->response
);
523 /* clean previous request */
524 phpstr_dtor(&obj
->request
);
529 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
533 phpstr_fix(&obj
->request
);
534 phpstr_fix(&obj
->response
);
536 msg
= http_message_parse(PHPSTR_VAL(&obj
->response
), PHPSTR_LEN(&obj
->response
));
543 zval
*headers
, *message
,
544 *resp
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
)),
545 *info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
547 if (zval_is_true(GET_PROP(obj
, recordHistory
))) {
548 /* we need to act like a zipper, as we'll receive
549 * the requests and the responses in separate chains
552 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
), PHPSTR_LEN(&obj
->request
));
553 http_message
*free_msg
= request
;
559 http_message_tostring(response
, &message
, &msglen
);
560 phpstr_append(&obj
->history
, message
, msglen
);
563 http_message_tostring(request
, &message
, &msglen
);
564 phpstr_append(&obj
->history
, message
, msglen
);
567 } while ((response
= response
->parent
) && (request
= request
->parent
));
569 http_message_free(&free_msg
);
570 phpstr_fix(&obj
->history
);
573 UPD_PROP(obj
, long, responseCode
, msg
->http
.info
.response
.code
);
575 MAKE_STD_ZVAL(headers
)
578 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
579 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
581 add_assoc_zval(resp
, "headers", headers
);
582 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
584 MAKE_STD_ZVAL(message
);
585 ZVAL_OBJVAL(message
, http_message_object_from_msg(msg
));
586 SET_PROP(obj
, responseMessage
, message
);
587 zval_ptr_dtor(&message
);
589 http_request_info(obj
->ch
, Z_ARRVAL_P(info
));
590 SET_PROP(obj
, responseInfo
, info
);
596 #define http_request_object_set_options_subr(key, ow) \
597 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
598 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
600 zval
*opts
, **options
, *new_options
= NULL
;
601 getObject(http_request_object
, obj
);
603 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &new_options
)) {
607 opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
609 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
610 convert_to_array(*options
);
612 zend_hash_clean(Z_ARRVAL_PP(options
));
614 if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
616 array_copy(new_options
, *options
);
618 array_merge(new_options
, *options
);
621 } else if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
622 zval_add_ref(&new_options
);
623 add_assoc_zval(opts
, key
, new_options
);
629 #define http_request_object_get_options_subr(key) \
630 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
631 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
636 zval
*opts
, **options
;
637 getObject(http_request_object
, obj
);
639 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
));
641 array_init(return_value
);
643 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
644 convert_to_array(*options
);
645 array_copy(*options
, return_value
);
651 /* ### USERLAND ### */
653 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
655 * Instantiate a new HttpRequest object.
657 * Accepts a string as optional parameter containing the target request url.
658 * Additianally accepts an optional int parameter specifying the request method
659 * to use and an associative array as optional third parameter which will be
660 * passed to HttpRequest::setOptions().
662 * Throws HttpException.
664 PHP_METHOD(HttpRequest
, __construct
)
669 zval
*options
= NULL
;
670 getObject(http_request_object
, obj
);
673 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
674 INIT_PARR(obj
, options
);
675 INIT_PARR(obj
, responseInfo
);
676 INIT_PARR(obj
, responseData
);
677 INIT_PARR(obj
, postFields
);
678 INIT_PARR(obj
, postFiles
);
681 UPD_STRL(obj
, url
, URL
, URL_len
);
684 UPD_PROP(obj
, long, method
, meth
);
687 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
694 /* {{{ proto void HttpRequest::__destruct()
696 * Destroys the HttpRequest object.
698 PHP_METHOD(HttpRequest
, __destruct
)
700 getObject(http_request_object
, obj
);
704 FREE_PARR(obj
, options
);
705 FREE_PARR(obj
, responseInfo
);
706 FREE_PARR(obj
, responseData
);
707 FREE_PARR(obj
, postFields
);
708 FREE_PARR(obj
, postFiles
);
712 /* {{{ proto bool HttpRequest::setOptions([array options])
714 * Set the request options to use. See http_get() for a full list of available options.
716 * Accepts an array as optional parameters, wich values will overwrite the
717 * currently set request options. If the parameter is empty or mitted,
718 * the optoions of the HttpRequest object will be reset.
720 * Returns TRUE on success, or FALSE on failure.
722 PHP_METHOD(HttpRequest
, setOptions
)
726 zval
*opts
= NULL
, *old_opts
, **opt
;
727 getObject(http_request_object
, obj
);
729 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
733 old_opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
735 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
736 zend_hash_clean(Z_ARRVAL_P(old_opts
));
740 /* some options need extra attention -- thus cannot use array_merge() directly */
741 FOREACH_KEYVAL(opts
, key
, idx
, opt
) {
743 if (!strcmp(key
, "headers")) {
745 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "headers", sizeof("headers"), (void **) &headers
)) {
746 convert_to_array(*opt
);
747 convert_to_array(*headers
);
748 array_merge(*opt
, *headers
);
751 } else if (!strcmp(key
, "cookies")) {
753 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
754 convert_to_array(*opt
);
755 convert_to_array(*cookies
);
756 array_merge(*opt
, *cookies
);
759 } else if (!strcmp(key
, "ssl")) {
761 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "ssl", sizeof("ssl"), (void **) &ssl
)) {
762 convert_to_array(*opt
);
763 convert_to_array(*ssl
);
764 array_merge(*opt
, *ssl
);
767 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
768 if (Z_TYPE_PP(opt
) != IS_STRING
) {
769 convert_to_string_ex(opt
);
771 UPD_STRL(obj
, url
, Z_STRVAL_PP(opt
), Z_STRLEN_PP(opt
));
773 } else if (!strcmp(key
, "method")) {
774 if (Z_TYPE_PP(opt
) != IS_LONG
) {
775 convert_to_long_ex(opt
);
777 UPD_PROP(obj
, long, method
, Z_LVAL_PP(opt
));
782 add_assoc_zval(old_opts
, key
, *opt
);
793 /* {{{ proto array HttpRequest::getOptions()
795 * Get currently set options.
797 * Returns an associative array containing currently set options.
799 PHP_METHOD(HttpRequest
, getOptions
)
805 getObject(http_request_object
, obj
);
807 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
));
808 array_init(return_value
);
809 array_copy(opts
, return_value
);
814 /* {{{ proto bool HttpRequest::setSslOptions([array options])
818 * Accepts an associative array as parameter containing any SSL specific options.
819 * If the parameter is empty or omitted, the SSL options will be reset.
821 * Returns TRUE on success, or FALSE on failure.
823 PHP_METHOD(HttpRequest
, setSslOptions
)
825 http_request_object_set_options_subr("ssl", 1);
829 /* {{{ proto bool HttpRequest::addSslOptions(array options)
831 * Set additional SSL options.
833 * Expects an associative array as parameter containing additional SSL specific options.
835 * Returns TRUE on success, or FALSE on failure.
837 PHP_METHOD(HttpRequest
, addSslOptions
)
839 http_request_object_set_options_subr("ssl", 0);
843 /* {{{ proto array HttpRequest::getSslOtpions()
845 * Get previously set SSL options.
847 * Returns an associative array containing any previously set SSL options.
849 PHP_METHOD(HttpRequest
, getSslOptions
)
851 http_request_object_get_options_subr("ssl");
855 /* {{{ proto bool HttpRequest::addHeaders(array headers)
857 * Add request header name/value pairs.
859 * Expects an ssociative array as parameter containing additional header
862 * Returns TRUE on success, or FALSE on failure.
864 PHP_METHOD(HttpRequest
, addHeaders
)
866 http_request_object_set_options_subr("headers", 0);
869 /* {{{ proto bool HttpRequest::setHeaders([array headers])
871 * Set request header name/value pairs.
873 * Accepts an associative array as parameter containing header name/value pairs.
874 * If the parameter is empty or omitted, all previously set headers will be unset.
876 * Returns TRUE on success, or FALSE on failure.
878 PHP_METHOD(HttpRequest
, setHeaders
)
880 http_request_object_set_options_subr("headers", 1);
884 /* {{{ proto array HttpRequest::getHeaders()
886 * Get previously set request headers.
888 * Returns an associative array containing all currently set headers.
890 PHP_METHOD(HttpRequest
, getHeaders
)
892 http_request_object_get_options_subr("headers");
896 /* {{{ proto bool HttpRequest::setCookies([array cookies])
900 * Accepts an associative array as parameter containing cookie name/value pairs.
901 * If the parameter is empty or omitted, all previously set cookies will be unset.
903 * Returns TRUE on success, or FALSE on failure.
905 PHP_METHOD(HttpRequest
, setCookies
)
907 http_request_object_set_options_subr("cookies", 1);
911 /* {{{ proto bool HttpRequest::addCookies(array cookies)
915 * Expects an associative array as parameter containing any cookie name/value
918 * Returns TRUE on success, or FALSE on failure.
920 PHP_METHOD(HttpRequest
, addCookies
)
922 http_request_object_set_options_subr("cookies", 0);
926 /* {{{ proto array HttpRequest::getCookies()
928 * Get previously set cookies.
930 * Returns an associative array containing any previously set cookies.
932 PHP_METHOD(HttpRequest
, getCookies
)
934 http_request_object_get_options_subr("cookies");
938 /* {{{ proto bool HttpRequest::setUrl(string url)
940 * Set the request URL.
942 * Expects a string as parameter specifying the request url.
944 * Returns TRUE on success, or FALSE on failure.
946 PHP_METHOD(HttpRequest
, setUrl
)
950 getObject(http_request_object
, obj
);
952 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
956 UPD_STRL(obj
, url
, URL
, URL_len
);
961 /* {{{ proto string HttpRequest::getUrl()
963 * Get the previously set request URL.
965 * Returns the currently set request url as string.
967 PHP_METHOD(HttpRequest
, getUrl
)
972 getObject(http_request_object
, obj
);
973 zval
*URL
= GET_PROP(obj
, url
);
975 RETURN_ZVAL(URL
, 1, 0);
980 /* {{{ proto bool HttpRequest::setMethod(int request_method)
982 * Set the request method.
984 * Expects an int as parameter specifying the request method to use.
985 * In PHP 5.1+ HttpRequest::METH, otherwise the HTTP_METH constants can be used.
987 * Returns TRUE on success, or FALSE on failure.
989 PHP_METHOD(HttpRequest
, setMethod
)
992 getObject(http_request_object
, obj
);
994 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
998 UPD_PROP(obj
, long, method
, meth
);
1003 /* {{{ proto int HttpRequest::getMethod()
1005 * Get the previously set request method.
1007 * Returns the currently set request method.
1009 PHP_METHOD(HttpRequest
, getMethod
)
1014 getObject(http_request_object
, obj
);
1015 zval
*meth
= GET_PROP(obj
, method
);
1017 RETURN_ZVAL(meth
, 1, 0);
1022 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1024 * Set the content type the post request should have.
1026 * Expects a string as parameters containing the content type of the request
1027 * (primary/secondary).
1029 * Returns TRUE on success, or FALSE if the content type does not seem to
1030 * contain a primary and a secondary part.
1032 PHP_METHOD(HttpRequest
, setContentType
)
1036 getObject(http_request_object
, obj
);
1038 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1042 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1043 UPD_STRL(obj
, contentType
, ctype
, ct_len
);
1048 /* {{{ proto string HttpRequest::getContentType()
1050 * Get the previously content type.
1052 * Returns the previously set content type as string.
1054 PHP_METHOD(HttpRequest
, getContentType
)
1059 getObject(http_request_object
, obj
);
1060 zval
*ctype
= GET_PROP(obj
, contentType
);
1062 RETURN_ZVAL(ctype
, 1, 0);
1067 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1069 * Set the URL query parameters to use, overwriting previously set query parameters.
1070 * Affects any request types.
1072 * Accepts a string or associative array parameter containing the pre-encoded
1073 * query string or to be encoded query fields. If the parameter is empty or
1074 * omitted, the query data will be unset.
1076 * Returns TRUE on success, or FALSE on failure.
1078 PHP_METHOD(HttpRequest
, setQueryData
)
1081 getObject(http_request_object
, obj
);
1083 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1087 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1088 UPD_STRL(obj
, queryData
, "", 0);
1089 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1090 char *query_data
= NULL
;
1092 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1096 UPD_PROP(obj
, string
, queryData
, query_data
);
1099 convert_to_string_ex(&qdata
);
1100 UPD_STRL(obj
, queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1106 /* {{{ proto string HttpRequest::getQueryData()
1108 * Get the current query data in form of an urlencoded query string.
1110 * Returns a string containing the urlencoded query.
1112 PHP_METHOD(HttpRequest
, getQueryData
)
1117 getObject(http_request_object
, obj
);
1118 zval
*qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
));
1120 RETURN_ZVAL(qdata
, 1, 0);
1125 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1127 * Add parameters to the query parameter list, leaving previously set unchanged.
1128 * Affects any request type.
1130 * Expects an associative array as parameter containing the query fields to add.
1132 * Returns TRUE on success, or FALSE on failure.
1134 PHP_METHOD(HttpRequest
, addQueryData
)
1136 zval
*qdata
, *old_qdata
;
1137 char *query_data
= NULL
;
1138 size_t query_data_len
= 0;
1139 getObject(http_request_object
, obj
);
1141 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &qdata
)) {
1145 old_qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
));
1147 if (SUCCESS
!= http_urlencode_hash_ex(HASH_OF(qdata
), 1, Z_STRVAL_P(old_qdata
), Z_STRLEN_P(old_qdata
), &query_data
, &query_data_len
)) {
1151 UPD_STRL(obj
, queryData
, query_data
, query_data_len
);
1158 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1160 * Adds POST data entries, leaving previously set unchanged, unless a
1161 * post entry with the same name already exists.
1162 * Affects only POST and custom requests.
1164 * Expects an associative array as parameter containing the post fields.
1166 * Returns TRUE on success, or FALSE on failure.
1168 PHP_METHOD(HttpRequest
, addPostFields
)
1170 zval
*post
, *post_data
;
1171 getObject(http_request_object
, obj
);
1173 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &post_data
)) {
1177 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1178 array_merge(post_data
, post
);
1184 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1186 * Set the POST data entries, overwriting previously set POST data.
1187 * Affects only POST and custom requests.
1189 * Accepts an associative array as parameter containing the post fields.
1190 * If the parameter is empty or omitted, the post data will be unset.
1192 * Returns TRUE on success, or FALSE on failure.
1194 PHP_METHOD(HttpRequest
, setPostFields
)
1196 zval
*post
, *post_data
= NULL
;
1197 getObject(http_request_object
, obj
);
1199 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!", &post_data
)) {
1203 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1204 zend_hash_clean(Z_ARRVAL_P(post
));
1206 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1207 array_copy(post_data
, post
);
1214 /* {{{ proto array HttpRequest::getPostFields()
1216 * Get previously set POST data.
1218 * Returns the currently set post fields as associative array.
1220 PHP_METHOD(HttpRequest
, getPostFields
)
1225 getObject(http_request_object
, obj
);
1226 zval
*post_data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFields
));
1228 array_init(return_value
);
1229 array_copy(post_data
, return_value
);
1234 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1236 * Set raw post data to send, overwriting previously set raw post data. Don't
1237 * forget to specify a content type. Affects only POST and custom requests.
1238 * Only either post fields or raw post data can be used for each request.
1239 * Raw post data has higher precedence and will be used even if post fields
1242 * Accepts a string as parameter containing the *raw* post data.
1244 * Returns TRUE on success, or FALSE on failure.
1246 PHP_METHOD(HttpRequest
, setRawPostData
)
1248 char *raw_data
= NULL
;
1250 getObject(http_request_object
, obj
);
1252 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1260 UPD_STRL(obj
, rawPostData
, raw_data
, data_len
);
1265 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1267 * Add raw post data, leaving previously set raw post data unchanged.
1268 * Affects only POST and custom requests.
1270 * Expects a string as parameter containing the raw post data to concatenate.
1272 * Returns TRUE on success, or FALSE on failure.
1274 PHP_METHOD(HttpRequest
, addRawPostData
)
1276 char *raw_data
, *new_data
;
1278 getObject(http_request_object
, obj
);
1280 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1285 zval
*zdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
));
1287 new_data
= emalloc(Z_STRLEN_P(zdata
) + data_len
+ 1);
1288 new_data
[Z_STRLEN_P(zdata
) + data_len
] = '\0';
1290 if (Z_STRLEN_P(zdata
)) {
1291 memcpy(new_data
, Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
));
1294 memcpy(new_data
+ Z_STRLEN_P(zdata
), raw_data
, data_len
);
1295 UPD_STRL(obj
, rawPostData
, new_data
, Z_STRLEN_P(zdata
) + data_len
);
1302 /* {{{ proto string HttpRequest::getRawPostData()
1304 * Get previously set raw post data.
1306 * Returns a string containing the currently set raw post data.
1308 PHP_METHOD(HttpRequest
, getRawPostData
)
1313 getObject(http_request_object
, obj
);
1314 zval
*raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
));
1316 RETURN_ZVAL(raw_data
, 1, 0);
1321 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1323 * Add a file to the POST request, leaving prefiously set files unchanged.
1324 * Affects only POST and custom requests. Cannot be used with raw post data.
1326 * Expects a string parameter containing the form element name, and a string
1327 * paremeter containing the path to the file which should be uploaded.
1328 * Additionally accepts an optional string parameter which chould contain
1329 * the content type of the file.
1331 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1332 * primary and a secondary content type part.
1334 PHP_METHOD(HttpRequest
, addPostFile
)
1336 zval
*files
, *entry
;
1337 char *name
, *file
, *type
= NULL
;
1338 int name_len
, file_len
, type_len
= 0;
1339 getObject(http_request_object
, obj
);
1341 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1346 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1348 type
= "application/x-octetstream";
1349 type_len
= sizeof("application/x-octetstream") - 1;
1352 MAKE_STD_ZVAL(entry
);
1355 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1356 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1357 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1359 files
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1360 add_next_index_zval(files
, entry
);
1366 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1368 * Set files to post, overwriting previously set post files.
1369 * Affects only POST and requests. Cannot be used with raw post data.
1371 * Accepts an array containing the files to post. Each entry should be an
1372 * associative array with "name", "file" and "type" keys. If the parameter
1373 * is empty or omitted the post files will be unset.
1375 * Returns TRUE on success, or FALSE on failure.
1377 PHP_METHOD(HttpRequest
, setPostFiles
)
1379 zval
*files
, *pFiles
;
1380 getObject(http_request_object
, obj
);
1382 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &files
)) {
1386 pFiles
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1387 zend_hash_clean(Z_ARRVAL_P(pFiles
));
1389 if (files
&& zend_hash_num_elements(Z_ARRVAL_P(files
))) {
1390 array_copy(files
, pFiles
);
1397 /* {{{ proto array HttpRequest::getPostFiles()
1399 * Get all previously added POST files.
1401 * Returns an array containing currently set post files.
1403 PHP_METHOD(HttpRequest
, getPostFiles
)
1408 getObject(http_request_object
, obj
);
1409 zval
*files
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1411 array_init(return_value
);
1412 array_copy(files
, return_value
);
1417 /* {{{ proto bool HttpRequest::setPutFile([string file])
1419 * Set file to put. Affects only PUT requests.
1421 * Accepts a string as parameter referencing the path to file.
1422 * If the parameter is empty or omitted the put file will be unset.
1424 * Returns TRUE on success, or FALSE on failure.
1426 PHP_METHOD(HttpRequest
, setPutFile
)
1430 getObject(http_request_object
, obj
);
1432 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1436 UPD_STRL(obj
, putFile
, file
, file_len
);
1441 /* {{{ proto string HttpRequest::getPutFile()
1443 * Get previously set put file.
1445 * Returns a string containing the path to the currently set put file.
1447 PHP_METHOD(HttpRequest
, getPutFile
)
1452 getObject(http_request_object
, obj
);
1453 zval
*putfile
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, putFile
));
1455 RETURN_ZVAL(putfile
, 1, 0);
1460 /* {{{ proto array HttpRequest::getResponseData()
1462 * Get all response data after the request has been sent.
1464 * Returns an associative array with the key "headers" containing an associative
1465 * array holding all response headers, as well as the ley "body" containing a
1466 * string with the response body.
1468 * If redirects were allowed and several responses were received, the data
1469 * references the last received response.
1471 PHP_METHOD(HttpRequest
, getResponseData
)
1476 getObject(http_request_object
, obj
);
1477 zval
*data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
));
1479 array_init(return_value
);
1480 array_copy(data
, return_value
);
1485 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1487 * Get response header(s) after the request has been sent.
1489 * Accepts an string as optional parameter specifying a certain header to read.
1490 * If the parameter is empty or omitted all response headers will be returned.
1492 * Returns either a string with the value of the header matching name if requested,
1493 * FALSE on failure, or an associative array containing all reponse headers.
1495 * If redirects were allowed and several responses were received, the data
1496 * references the last received response.
1498 PHP_METHOD(HttpRequest
, getResponseHeader
)
1501 zval
*data
, **headers
, **header
;
1502 char *header_name
= NULL
;
1504 getObject(http_request_object
, obj
);
1506 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1510 data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
));
1511 if (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1514 convert_to_array_ex(headers
);
1515 if (!header_len
|| !header_name
) {
1516 array_init(return_value
);
1517 array_copy(*headers
, return_value
);
1518 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1519 RETURN_ZVAL(*header
, 1, 0);
1527 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1529 * Get response cookie(s) after the request has been sent.
1531 * Accepts a string as optional parameter specifying the name of the cookie to read.
1532 * If the parameter is empty or omitted, an associative array with all received
1533 * cookies will be returned.
1535 * Returns either an associative array with the cookie's name, value and any
1536 * additional params of the cookie matching name if requested, FALSE on failure,
1537 * or an array containing all received cookies as arrays.
1539 * If redirects were allowed and several responses were received, the data
1540 * references the last received response.
1542 PHP_METHOD(HttpRequest
, getResponseCookie
)
1545 zval
*data
, **headers
;
1546 char *cookie_name
= NULL
;
1548 getObject(http_request_object
, obj
);
1550 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1554 array_init(return_value
);
1556 data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
));
1557 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1560 zval
**header
= NULL
;
1562 convert_to_array_ex(headers
);
1563 FOREACH_HASH_KEYVAL(Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1564 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1565 /* several cookies? */
1566 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1569 FOREACH_HASH_VAL(Z_ARRVAL_PP(header
), cookie
) {
1571 MAKE_STD_ZVAL(cookie_hash
);
1572 array_init(cookie_hash
);
1574 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1576 add_next_index_zval(return_value
, cookie_hash
);
1580 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1581 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1582 add_next_index_zval(return_value
, cookie_hash
);
1583 return; /* <<< FOUND >>> */
1585 zval_dtor(cookie_hash
);
1590 zval_dtor(cookie_hash
);
1597 MAKE_STD_ZVAL(cookie_hash
);
1598 array_init(cookie_hash
);
1599 convert_to_string_ex(header
);
1601 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1603 add_next_index_zval(return_value
, cookie_hash
);
1607 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1608 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1609 add_next_index_zval(return_value
, cookie_hash
);
1611 zval_dtor(cookie_hash
);
1616 zval_dtor(cookie_hash
);
1630 /* {{{ proto string HttpRequest::getResponseBody()
1632 * Get the response body after the request has been sent.
1634 * Returns a string containing the response body.
1636 * If redirects were allowed and several responses were received, the data
1637 * references the last received response.
1639 PHP_METHOD(HttpRequest
, getResponseBody
)
1645 getObject(http_request_object
, obj
);
1646 zval
*data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
));
1648 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
)) {
1649 convert_to_string_ex(body
);
1650 RETURN_ZVAL(*body
, 1, 0);
1658 /* {{{ proto int HttpRequest::getResponseCode()
1660 * Get the response code after the request has been sent.
1662 * Returns an int representing the response code.
1664 * If redirects were allowed and several responses were received, the data
1665 * references the last received response.
1667 PHP_METHOD(HttpRequest
, getResponseCode
)
1672 getObject(http_request_object
, obj
);
1673 zval
*code
= convert_to_type_ex(IS_LONG
, GET_PROP(obj
, responseCode
));
1675 RETURN_ZVAL(code
, 1, 0);
1680 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1682 * Get response info after the request has been sent.
1683 * See http_get() for a full list of returned info.
1685 * Accepts a string as optional parameter specifying the info to read.
1686 * If the parameter is empty or omitted, an associative array containing
1687 * all available info will be returned.
1689 * Returns either a scalar containing the value of the info matching name if
1690 * requested, FALSE on failure, or an associative array containing all
1693 * If redirects were allowed and several responses were received, the data
1694 * references the last received response.
1696 PHP_METHOD(HttpRequest
, getResponseInfo
)
1699 zval
*info
, **infop
;
1700 char *info_name
= NULL
;
1702 getObject(http_request_object
, obj
);
1704 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1708 info
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
1710 if (info_len
&& info_name
) {
1711 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1712 RETURN_ZVAL(*infop
, 1, 0);
1714 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1718 array_init(return_value
);
1719 array_copy(info
, return_value
);
1725 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1727 * Get the full response as HttpMessage object after the request has been sent.
1729 * Returns an HttpMessage object of the response.
1731 * If redirects were allowed and several responses were received, the data
1732 * references the last received response. Use HttpMessage::getParentMessage()
1733 * to access the data of previously received responses whithin this request
1736 * Throws HttpException.
1738 PHP_METHOD(HttpRequest
, getResponseMessage
)
1744 getObject(http_request_object
, obj
);
1746 SET_EH_THROW_HTTP();
1747 message
= GET_PROP(obj
, responseMessage
);
1748 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1749 RETVAL_OBJECT(message
);
1758 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1760 * Get sent HTTP message.
1762 * Returns an HttpMessage object representing the sent request.
1764 * If redirects were allowed and several responses were received, the data
1765 * references the last received response. Use HttpMessage::getParentMessage()
1766 * to access the data of previously sent requests whithin this request
1769 PHP_METHOD(HttpRequest
, getRequestMessage
)
1775 getObject(http_request_object
, obj
);
1777 SET_EH_THROW_HTTP();
1778 if (msg
= http_message_parse(PHPSTR_VAL(&obj
->request
), PHPSTR_LEN(&obj
->request
))) {
1779 RETVAL_OBJVAL(http_message_object_from_msg(msg
));
1786 /* {{{ proto HttpMessage HttpRequest::getHistory()
1788 * Get all sent requests and received responses as an HttpMessage object.
1790 * If you don't want to record history at all, set the instance variable
1791 * HttpRequest::$recoedHistory to FALSE.
1793 * Returns an HttpMessage object representing the complete request/response
1796 * The object references the last received response, use HttpMessage::getParentMessage()
1797 * to access the data of previously sent requests and received responses.
1799 * Throws HttpMalformedHeaderException.
1801 PHP_METHOD(HttpRequest
, getHistory
)
1807 getObject(http_request_object
, obj
);
1809 SET_EH_THROW_HTTP();
1810 if (msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
))) {
1811 RETVAL_OBJVAL(http_message_object_from_msg(msg
));
1818 /* {{{ proto void HttpRequest::clearHistory()
1820 * Clear the history.
1822 PHP_METHOD(HttpRequest
, clearHistory
)
1825 getObject(http_request_object
, obj
);
1826 phpstr_dtor(&obj
->history
);
1831 /* {{{ proto HttpMessage HttpRequest::send()
1833 * Send the HTTP request.
1835 * Returns the received response as HttpMessage object.
1837 * Throws HttpRuntimeException, HttpRequestException,
1838 * HttpMalformedHeaderException, HttpEncodingException.
1843 * $r = new HttpRequest('http://example.com/feed.rss', HTTP_GET);
1844 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1845 * $r->addQueryData(array('category' => 3));
1848 * if ($r->getResponseCode() == 200) {
1849 * file_put_contents('local.rss', $r->getResponseBody());
1851 * } catch (HttpException $ex) {
1860 * $r = new HttpRequest('http://example.com/form.php', HTTP_POST);
1861 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1862 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1863 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1865 * echo $r->send()->getBody();
1866 * } catch (HttpException $ex) {
1872 PHP_METHOD(HttpRequest
, send
)
1874 http_request_body body
= {0, NULL
, 0};
1875 getObject(http_request_object
, obj
);
1879 SET_EH_THROW_HTTP();
1882 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1889 if ( (SUCCESS
== http_request_object_requesthandler(obj
, getThis(), &body
)) &&
1890 (SUCCESS
== http_request_exec(obj
->ch
, NULL
, &obj
->response
, &obj
->request
)) &&
1891 (SUCCESS
== http_request_object_responsehandler(obj
, getThis()))) {
1892 RETVAL_OBJECT(GET_PROP(obj
, responseMessage
));
1894 http_request_body_dtor(&body
);
1900 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
1907 * vim600: noet sw=4 ts=4 fdm=marker
1908 * vim<600: noet sw=4 ts=4