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-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
19 #define HTTP_WANT_CURL
22 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
24 #include "zend_interfaces.h"
26 #include "php_http_api.h"
27 #include "php_http_exception_object.h"
28 #include "php_http_message_api.h"
29 #include "php_http_message_object.h"
30 #include "php_http_request_api.h"
31 #include "php_http_request_object.h"
32 #include "php_http_request_pool_api.h"
33 #include "php_http_url_api.h"
35 ZEND_EXTERN_MODULE_GLOBALS(http
);
37 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
38 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
39 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
40 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
42 HTTP_EMPTY_ARGS(__destruct
, 0);
43 HTTP_BEGIN_ARGS(__construct
, 0, 0)
45 HTTP_ARG_VAL(method
, 0)
46 HTTP_ARG_VAL(options
, 0)
49 HTTP_EMPTY_ARGS(getOptions
, 0);
50 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
51 HTTP_ARG_VAL(options
, 0)
54 HTTP_EMPTY_ARGS(getSslOptions
, 0);
55 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
56 HTTP_ARG_VAL(ssl_options
, 0)
59 HTTP_EMPTY_ARGS(getHeaders
, 0);
60 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
61 HTTP_ARG_VAL(headers
, 0)
64 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
65 HTTP_ARG_VAL(headers
, 0)
68 HTTP_EMPTY_ARGS(getCookies
, 0);
69 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
70 HTTP_ARG_VAL(cookies
, 0)
73 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
74 HTTP_ARG_VAL(cookies
, 0)
77 HTTP_EMPTY_ARGS(getUrl
, 0);
78 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
82 HTTP_EMPTY_ARGS(getMethod
, 0);
83 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
84 HTTP_ARG_VAL(request_method
, 0)
87 HTTP_EMPTY_ARGS(getContentType
, 0);
88 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
89 HTTP_ARG_VAL(content_type
, 0)
92 HTTP_EMPTY_ARGS(getQueryData
, 0);
93 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
94 HTTP_ARG_VAL(query_data
, 0)
97 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
98 HTTP_ARG_VAL(query_data
, 0)
101 HTTP_EMPTY_ARGS(getPostFields
, 0);
102 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
103 HTTP_ARG_VAL(post_fields
, 0)
106 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
107 HTTP_ARG_VAL(post_fields
, 0)
110 HTTP_EMPTY_ARGS(getPostFiles
, 0);
111 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
112 HTTP_ARG_VAL(post_files
, 0)
115 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
116 HTTP_ARG_VAL(formname
, 0)
117 HTTP_ARG_VAL(filename
, 0)
118 HTTP_ARG_VAL(content_type
, 0)
121 HTTP_EMPTY_ARGS(getRawPostData
, 0);
122 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
123 HTTP_ARG_VAL(raw_post_data
, 0)
126 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
127 HTTP_ARG_VAL(raw_post_data
, 0)
130 HTTP_EMPTY_ARGS(getPutFile
, 0);
131 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
132 HTTP_ARG_VAL(filename
, 0)
135 HTTP_EMPTY_ARGS(getResponseData
, 0);
136 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
137 HTTP_ARG_VAL(name
, 0)
140 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
141 HTTP_ARG_VAL(name
, 0)
144 HTTP_EMPTY_ARGS(getResponseBody
, 0);
145 HTTP_EMPTY_ARGS(getResponseCode
, 0);
146 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
147 HTTP_ARG_VAL(name
, 0)
150 HTTP_EMPTY_ARGS(getResponseMessage
, 1);
151 HTTP_EMPTY_ARGS(getRequestMessage
, 1);
152 HTTP_EMPTY_ARGS(getHistory
, 1);
153 HTTP_EMPTY_ARGS(clearHistory
, 0);
154 HTTP_EMPTY_ARGS(send
, 1);
156 HTTP_BEGIN_ARGS(get
, 0, 1)
158 HTTP_ARG_VAL(options
, 0)
159 HTTP_ARG_VAL(info
, 1)
162 HTTP_BEGIN_ARGS(head
, 0, 1)
164 HTTP_ARG_VAL(options
, 0)
165 HTTP_ARG_VAL(info
, 1)
168 HTTP_BEGIN_ARGS(postData
, 0, 2)
170 HTTP_ARG_VAL(data
, 0)
171 HTTP_ARG_VAL(options
, 0)
172 HTTP_ARG_VAL(info
, 1)
175 HTTP_BEGIN_ARGS(postFields
, 0, 2)
177 HTTP_ARG_VAL(data
, 0)
178 HTTP_ARG_VAL(options
, 0)
179 HTTP_ARG_VAL(info
, 1)
182 HTTP_BEGIN_ARGS(putFile
, 0, 2)
184 HTTP_ARG_VAL(file
, 0)
185 HTTP_ARG_VAL(options
, 0)
186 HTTP_ARG_VAL(info
, 1)
189 HTTP_BEGIN_ARGS(putStream
, 0, 2)
191 HTTP_ARG_VAL(stream
, 0)
192 HTTP_ARG_VAL(options
, 0)
193 HTTP_ARG_VAL(info
, 1)
196 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
197 HTTP_ARG_VAL(method_name
, 0)
200 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
201 HTTP_ARG_VAL(method
, 0)
204 HTTP_BEGIN_ARGS(methodName
, 0, 1)
205 HTTP_ARG_VAL(method_id
, 0)
208 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
209 HTTP_ARG_VAL(method
, 0)
212 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
213 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
215 zend_class_entry
*http_request_object_ce
;
216 zend_function_entry http_request_object_fe
[] = {
217 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
218 HTTP_REQUEST_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
220 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
221 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
222 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
223 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
225 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
226 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
227 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
229 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
230 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
231 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
234 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
236 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
237 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
239 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
240 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
243 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
264 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ALIAS(get
, http_get
)
275 HTTP_REQUEST_ALIAS(head
, http_head
)
276 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
277 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
278 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
279 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
281 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
282 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
283 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
284 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
288 static zend_object_handlers http_request_object_handlers
;
290 PHP_MINIT_FUNCTION(http_request_object
)
292 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
293 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
297 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
299 return http_request_object_new_ex(ce
, curl_easy_init(), NULL
);
302 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
304 zend_object_value ov
;
305 http_request_object
*o
;
307 o
= ecalloc(1, sizeof(http_request_object
));
315 phpstr_init(&o
->history
);
316 phpstr_init(&o
->request
);
317 phpstr_init_ex(&o
->response
, HTTP_CURLBUF_SIZE
, 0);
319 ALLOC_HASHTABLE(OBJ_PROP(o
));
320 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
321 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
323 ov
.handle
= putObject(http_request_object
, o
);
324 ov
.handlers
= &http_request_object_handlers
;
329 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
332 zend_object_value new_ov
;
333 http_request_object
*new_obj
;
334 getObject(http_request_object
, old_obj
);
336 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
337 new_ov
= http_request_object_new_ex(old_zo
->ce
, curl_easy_duphandle(old_obj
->ch
), &new_obj
);
339 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
340 phpstr_append(&new_obj
->history
, old_obj
->history
.data
, old_obj
->history
.used
);
341 phpstr_append(&new_obj
->request
, old_obj
->request
.data
, old_obj
->request
.used
);
342 phpstr_append(&new_obj
->response
, old_obj
->response
.data
, old_obj
->response
.used
);
347 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
349 zend_class_entry
*ce
= http_request_object_ce
;
351 DCL_PROP_N(PROTECTED
, options
);
352 DCL_PROP_N(PROTECTED
, responseInfo
);
353 DCL_PROP_N(PROTECTED
, responseData
);
354 DCL_PROP_N(PROTECTED
, responseCode
);
355 DCL_PROP_N(PROTECTED
, responseMessage
);
356 DCL_PROP_N(PROTECTED
, postFields
);
357 DCL_PROP_N(PROTECTED
, postFiles
);
359 DCL_PROP(PROTECTED
, long, method
, HTTP_GET
);
361 DCL_PROP(PROTECTED
, string
, url
, "");
362 DCL_PROP(PROTECTED
, string
, contentType
, "");
363 DCL_PROP(PROTECTED
, string
, rawPostData
, "");
364 DCL_PROP(PROTECTED
, string
, queryData
, "");
365 DCL_PROP(PROTECTED
, string
, putFile
, "");
367 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
371 * Request Method Constants
374 DCL_CONST(long, "METH_GET", HTTP_GET
);
375 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
376 DCL_CONST(long, "METH_POST", HTTP_POST
);
377 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
378 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
379 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
380 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
381 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
382 /* WebDAV - RFC 2518 */
383 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
384 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
385 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
386 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
387 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
388 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
389 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
390 /* WebDAV Versioning - RFC 3253 */
391 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
392 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
393 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
394 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
395 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
396 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
397 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
398 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
399 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
400 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
401 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
402 /* WebDAV Access Control - RFC 3744 */
403 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
408 # if LIBCURL_VERSION_NUM >= 0x070a05
409 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
410 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
411 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
412 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
413 # endif /* LIBCURL_VERSION_NUM */
417 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
419 http_request_object
*o
= (http_request_object
*) object
;
422 zend_hash_destroy(OBJ_PROP(o
));
423 FREE_HASHTABLE(OBJ_PROP(o
));
426 /* avoid nasty segfaults with already cleaned up callbacks */
427 curl_easy_setopt(o
->ch
, CURLOPT_NOPROGRESS
, 1);
428 curl_easy_setopt(o
->ch
, CURLOPT_PROGRESSFUNCTION
, NULL
);
429 curl_easy_setopt(o
->ch
, CURLOPT_VERBOSE
, 0);
430 curl_easy_setopt(o
->ch
, CURLOPT_DEBUGFUNCTION
, NULL
);
431 curl_easy_cleanup(o
->ch
);
433 phpstr_dtor(&o
->response
);
434 phpstr_dtor(&o
->request
);
435 phpstr_dtor(&o
->history
);
439 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr
, http_request_body
*body TSRMLS_DC
)
441 zval
*meth
, *URL
, *meth_p
, *URL_p
;
443 STATUS status
= SUCCESS
;
448 HTTP_CHECK_CURL_INIT(obj
->ch
, curl_easy_init(), return FAILURE
);
450 URL
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, url
), &URL_p
);
451 // HTTP_URI_MAXLEN+1 long char *
452 if (!(request_uri
= http_absolute_uri_ex(Z_STRVAL_P(URL
), Z_STRLEN_P(URL
), NULL
, 0, NULL
, 0, 0))) {
454 zval_ptr_dtor(&URL_p
);
459 zval_ptr_dtor(&URL_p
);
462 meth
= convert_to_type_ex(IS_LONG
, GET_PROP(obj
, method
), &meth_p
);
463 switch (Z_LVAL_P(meth
))
473 php_stream_statbuf ssb
;
474 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(obj
, putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
476 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
477 body
->type
= HTTP_REQUEST_BODY_UPLOADFILE
;
479 body
->size
= ssb
.sb
.st_size
;
489 /* check for raw post data */
490 zval
*raw_data_p
, *raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &raw_data_p
);
492 if (Z_STRLEN_P(raw_data
)) {
493 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, contentType
), &ctype_p
);
495 if (Z_STRLEN_P(ctype
)) {
496 zval
**headers
, *opts
= GET_PROP(obj
, options
);
498 convert_to_array(opts
);
500 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) {
503 convert_to_array(*headers
);
504 /* only override if not already set */
505 if (SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) {
506 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
511 MAKE_STD_ZVAL(headers
);
513 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
514 add_assoc_zval(opts
, "headers", headers
);
519 zval_ptr_dtor(&ctype_p
);
522 body
->type
= HTTP_REQUEST_BODY_CSTRING
;
523 body
->data
= estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
));
524 body
->size
= Z_STRLEN_P(raw_data
);
526 status
= http_request_body_fill(body
, Z_ARRVAL_P(GET_PROP(obj
, postFields
)), Z_ARRVAL_P(GET_PROP(obj
, postFiles
)));
530 zval_ptr_dtor(&raw_data_p
);
537 zval_ptr_dtor(&meth_p
);
540 if (status
== SUCCESS
) {
541 zval
*qdata_p
, *qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &qdata_p
);
543 if (Z_STRLEN_P(qdata
)) {
544 if (!strchr(request_uri
, '?')) {
545 strlcat(request_uri
, "?", HTTP_URI_MAXLEN
);
547 strlcat(request_uri
, "&", HTTP_URI_MAXLEN
);
549 strlcat(request_uri
, Z_STRVAL_P(qdata
), HTTP_URI_MAXLEN
);
553 zval_ptr_dtor(&qdata_p
);
556 status
= http_request_init(obj
->ch
, Z_LVAL_P(meth
), request_uri
, body
, Z_ARRVAL_P(GET_PROP(obj
, options
)));
560 /* clean previous response */
561 phpstr_dtor(&obj
->response
);
562 /* clean previous request */
563 phpstr_dtor(&obj
->request
);
568 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
572 phpstr_fix(&obj
->request
);
573 phpstr_fix(&obj
->response
);
575 msg
= http_message_parse(PHPSTR_VAL(&obj
->response
), PHPSTR_LEN(&obj
->response
));
582 zval
*headers
, *message
,
583 *resp
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
)),
584 *info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
589 if (zval_is_true(GET_PROP(obj
, recordHistory
))) {
590 /* we need to act like a zipper, as we'll receive
591 * the requests and the responses in separate chains
594 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
), PHPSTR_LEN(&obj
->request
));
595 http_message
*free_msg
= request
;
601 http_message_tostring(response
, &message
, &msglen
);
602 phpstr_append(&obj
->history
, message
, msglen
);
605 http_message_tostring(request
, &message
, &msglen
);
606 phpstr_append(&obj
->history
, message
, msglen
);
609 } while ((response
= response
->parent
) && (request
= request
->parent
));
611 http_message_free(&free_msg
);
612 phpstr_fix(&obj
->history
);
615 UPD_PROP(obj
, long, responseCode
, msg
->http
.info
.response
.code
);
617 MAKE_STD_ZVAL(headers
)
620 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
621 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
623 add_assoc_zval(resp
, "headers", headers
);
624 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
625 SET_PROP(obj
, responseData
, resp
);
627 MAKE_STD_ZVAL(message
);
628 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
629 SET_PROP(obj
, responseMessage
, message
);
630 zval_ptr_dtor(&message
);
632 http_request_info(obj
->ch
, Z_ARRVAL_P(info
));
633 SET_PROP(obj
, responseInfo
, info
);
639 #define http_request_object_set_options_subr(key, ow) \
640 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
641 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
643 zval
*opts
, **options
, *new_options
= NULL
;
644 getObject(http_request_object
, obj
);
646 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &new_options
)) {
650 opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
652 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
653 convert_to_array(*options
);
655 zend_hash_clean(Z_ARRVAL_PP(options
));
657 if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
659 array_copy(new_options
, *options
);
661 array_merge(new_options
, *options
);
664 } else if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
665 ZVAL_ADDREF(new_options
);
666 add_assoc_zval(opts
, key
, new_options
);
672 #define http_request_object_get_options_subr(key) \
673 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
674 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
679 zval
*opts_p
, *opts
, **options
;
680 getObject(http_request_object
, obj
);
682 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opts_p
);
684 array_init(return_value
);
686 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
687 convert_to_array(*options
);
688 array_copy(*options
, return_value
);
692 zval_ptr_dtor(&opts_p
);
698 /* ### USERLAND ### */
700 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
702 * Instantiate a new HttpRequest object.
704 * Accepts a string as optional parameter containing the target request url.
705 * Additianally accepts an optional int parameter specifying the request method
706 * to use and an associative array as optional third parameter which will be
707 * passed to HttpRequest::setOptions().
709 * Throws HttpException.
711 PHP_METHOD(HttpRequest
, __construct
)
716 zval
*options
= NULL
;
717 getObject(http_request_object
, obj
);
720 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
721 INIT_PARR(obj
, options
);
722 INIT_PARR(obj
, responseInfo
);
723 INIT_PARR(obj
, responseData
);
724 INIT_PARR(obj
, postFields
);
725 INIT_PARR(obj
, postFiles
);
728 UPD_STRL(obj
, url
, URL
, URL_len
);
731 UPD_PROP(obj
, long, method
, meth
);
734 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
741 /* {{{ proto void HttpRequest::__destruct()
743 * Destroys the HttpRequest object.
745 PHP_METHOD(HttpRequest
, __destruct
)
747 getObject(http_request_object
, obj
);
751 FREE_PARR(obj
, options
);
752 FREE_PARR(obj
, responseInfo
);
753 FREE_PARR(obj
, responseData
);
754 FREE_PARR(obj
, postFields
);
755 FREE_PARR(obj
, postFiles
);
759 /* {{{ proto bool HttpRequest::setOptions([array options])
761 * Set the request options to use. See http_get() for a full list of available options.
763 * Accepts an array as optional parameters, wich values will overwrite the
764 * currently set request options. If the parameter is empty or mitted,
765 * the optoions of the HttpRequest object will be reset.
767 * Returns TRUE on success, or FALSE on failure.
769 PHP_METHOD(HttpRequest
, setOptions
)
774 zval
*opts
= NULL
, *old_opts
, **opt
;
775 getObject(http_request_object
, obj
);
777 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!", &opts
)) {
781 old_opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
784 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
785 zend_hash_clean(Z_ARRVAL_P(old_opts
));
786 SET_PROP(obj
, options
, old_opts
);
790 /* some options need extra attention -- thus cannot use array_merge() directly */
791 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
793 if (!strcmp(key
, "headers")) {
795 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "headers", sizeof("headers"), (void **) &headers
)) {
796 convert_to_array_ex(opt
);
797 convert_to_array(*headers
);
798 array_merge(*opt
, *headers
);
801 } else if (!strcmp(key
, "cookies")) {
803 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
804 convert_to_array_ex(opt
);
805 convert_to_array(*cookies
);
806 array_merge(*opt
, *cookies
);
809 } else if (!strcmp(key
, "ssl")) {
811 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "ssl", sizeof("ssl"), (void **) &ssl
)) {
812 convert_to_array_ex(opt
);
813 convert_to_array(*ssl
);
814 array_merge(*opt
, *ssl
);
817 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
818 if (Z_TYPE_PP(opt
) != IS_STRING
) {
819 convert_to_string_ex(opt
);
821 UPD_STRL(obj
, url
, Z_STRVAL_PP(opt
), Z_STRLEN_PP(opt
));
823 } else if (!strcmp(key
, "method")) {
824 if (Z_TYPE_PP(opt
) != IS_LONG
) {
825 convert_to_long_ex(opt
);
827 UPD_PROP(obj
, long, method
, Z_LVAL_PP(opt
));
832 add_assoc_zval(old_opts
, key
, *opt
);
838 SET_PROP(obj
, options
, old_opts
);
844 /* {{{ proto array HttpRequest::getOptions()
846 * Get currently set options.
848 * Returns an associative array containing currently set options.
850 PHP_METHOD(HttpRequest
, getOptions
)
856 getObject(http_request_object
, obj
);
858 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opts_p
);
859 array_init(return_value
);
860 array_copy(opts
, return_value
);
863 zval_ptr_dtor(&opts_p
);
869 /* {{{ proto bool HttpRequest::setSslOptions([array options])
873 * Accepts an associative array as parameter containing any SSL specific options.
874 * If the parameter is empty or omitted, the SSL options will be reset.
876 * Returns TRUE on success, or FALSE on failure.
878 PHP_METHOD(HttpRequest
, setSslOptions
)
880 http_request_object_set_options_subr("ssl", 1);
884 /* {{{ proto bool HttpRequest::addSslOptions(array options)
886 * Set additional SSL options.
888 * Expects an associative array as parameter containing additional SSL specific options.
890 * Returns TRUE on success, or FALSE on failure.
892 PHP_METHOD(HttpRequest
, addSslOptions
)
894 http_request_object_set_options_subr("ssl", 0);
898 /* {{{ proto array HttpRequest::getSslOtpions()
900 * Get previously set SSL options.
902 * Returns an associative array containing any previously set SSL options.
904 PHP_METHOD(HttpRequest
, getSslOptions
)
906 http_request_object_get_options_subr("ssl");
910 /* {{{ proto bool HttpRequest::addHeaders(array headers)
912 * Add request header name/value pairs.
914 * Expects an ssociative array as parameter containing additional header
917 * Returns TRUE on success, or FALSE on failure.
919 PHP_METHOD(HttpRequest
, addHeaders
)
921 http_request_object_set_options_subr("headers", 0);
924 /* {{{ proto bool HttpRequest::setHeaders([array headers])
926 * Set request header name/value pairs.
928 * Accepts an associative array as parameter containing header name/value pairs.
929 * If the parameter is empty or omitted, all previously set headers will be unset.
931 * Returns TRUE on success, or FALSE on failure.
933 PHP_METHOD(HttpRequest
, setHeaders
)
935 http_request_object_set_options_subr("headers", 1);
939 /* {{{ proto array HttpRequest::getHeaders()
941 * Get previously set request headers.
943 * Returns an associative array containing all currently set headers.
945 PHP_METHOD(HttpRequest
, getHeaders
)
947 http_request_object_get_options_subr("headers");
951 /* {{{ proto bool HttpRequest::setCookies([array cookies])
955 * Accepts an associative array as parameter containing cookie name/value pairs.
956 * If the parameter is empty or omitted, all previously set cookies will be unset.
958 * Returns TRUE on success, or FALSE on failure.
960 PHP_METHOD(HttpRequest
, setCookies
)
962 http_request_object_set_options_subr("cookies", 1);
966 /* {{{ proto bool HttpRequest::addCookies(array cookies)
970 * Expects an associative array as parameter containing any cookie name/value
973 * Returns TRUE on success, or FALSE on failure.
975 PHP_METHOD(HttpRequest
, addCookies
)
977 http_request_object_set_options_subr("cookies", 0);
981 /* {{{ proto array HttpRequest::getCookies()
983 * Get previously set cookies.
985 * Returns an associative array containing any previously set cookies.
987 PHP_METHOD(HttpRequest
, getCookies
)
989 http_request_object_get_options_subr("cookies");
993 /* {{{ proto bool HttpRequest::setUrl(string url)
995 * Set the request URL.
997 * Expects a string as parameter specifying the request url.
999 * Returns TRUE on success, or FALSE on failure.
1001 PHP_METHOD(HttpRequest
, setUrl
)
1005 getObject(http_request_object
, obj
);
1007 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
1011 UPD_STRL(obj
, url
, URL
, URL_len
);
1016 /* {{{ proto string HttpRequest::getUrl()
1018 * Get the previously set request URL.
1020 * Returns the currently set request url as string.
1022 PHP_METHOD(HttpRequest
, getUrl
)
1027 getObject(http_request_object
, obj
);
1028 zval
*URL
= GET_PROP(obj
, url
);
1030 RETURN_ZVAL(URL
, 1, 0);
1035 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1037 * Set the request method.
1039 * Expects an int as parameter specifying the request method to use.
1040 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1042 * Returns TRUE on success, or FALSE on failure.
1044 PHP_METHOD(HttpRequest
, setMethod
)
1047 getObject(http_request_object
, obj
);
1049 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
1053 UPD_PROP(obj
, long, method
, meth
);
1058 /* {{{ proto int HttpRequest::getMethod()
1060 * Get the previously set request method.
1062 * Returns the currently set request method.
1064 PHP_METHOD(HttpRequest
, getMethod
)
1069 getObject(http_request_object
, obj
);
1070 zval
*meth
= GET_PROP(obj
, method
);
1072 RETURN_ZVAL(meth
, 1, 0);
1077 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1079 * Set the content type the post request should have.
1081 * Expects a string as parameters containing the content type of the request
1082 * (primary/secondary).
1084 * Returns TRUE on success, or FALSE if the content type does not seem to
1085 * contain a primary and a secondary part.
1087 PHP_METHOD(HttpRequest
, setContentType
)
1091 getObject(http_request_object
, obj
);
1093 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1097 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1098 UPD_STRL(obj
, contentType
, ctype
, ct_len
);
1103 /* {{{ proto string HttpRequest::getContentType()
1105 * Get the previously content type.
1107 * Returns the previously set content type as string.
1109 PHP_METHOD(HttpRequest
, getContentType
)
1114 getObject(http_request_object
, obj
);
1115 zval
*ctype
= GET_PROP(obj
, contentType
);
1117 RETURN_ZVAL(ctype
, 1, 0);
1122 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1124 * Set the URL query parameters to use, overwriting previously set query parameters.
1125 * Affects any request types.
1127 * Accepts a string or associative array parameter containing the pre-encoded
1128 * query string or to be encoded query fields. If the parameter is empty or
1129 * omitted, the query data will be unset.
1131 * Returns TRUE on success, or FALSE on failure.
1133 PHP_METHOD(HttpRequest
, setQueryData
)
1136 getObject(http_request_object
, obj
);
1138 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1142 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1143 UPD_STRL(obj
, queryData
, "", 0);
1144 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1145 char *query_data
= NULL
;
1147 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1151 UPD_PROP(obj
, string
, queryData
, query_data
);
1154 convert_to_string_ex(&qdata
);
1155 UPD_STRL(obj
, queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1161 /* {{{ proto string HttpRequest::getQueryData()
1163 * Get the current query data in form of an urlencoded query string.
1165 * Returns a string containing the urlencoded query.
1167 PHP_METHOD(HttpRequest
, getQueryData
)
1172 getObject(http_request_object
, obj
);
1173 zval
*qdata_p
, *qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &qdata_p
);
1175 RETURN_ZVAL(qdata
, 1, 0);
1178 zval_ptr_dtor(&qdata_p
);
1184 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1186 * Add parameters to the query parameter list, leaving previously set unchanged.
1187 * Affects any request type.
1189 * Expects an associative array as parameter containing the query fields to add.
1191 * Returns TRUE on success, or FALSE on failure.
1193 PHP_METHOD(HttpRequest
, addQueryData
)
1195 zval
*qdata
, *old_qdata
, *old_qdata_p
;
1196 char *query_data
= NULL
;
1197 size_t query_data_len
= 0;
1198 getObject(http_request_object
, obj
);
1200 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &qdata
)) {
1204 old_qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &old_qdata_p
);
1206 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
)) {
1208 zval_ptr_dtor(&old_qdata_p
);
1213 UPD_STRL(obj
, queryData
, query_data
, query_data_len
);
1217 zval_ptr_dtor(&old_qdata_p
);
1224 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1226 * Adds POST data entries, leaving previously set unchanged, unless a
1227 * post entry with the same name already exists.
1228 * Affects only POST and custom requests.
1230 * Expects an associative array as parameter containing the post fields.
1232 * Returns TRUE on success, or FALSE on failure.
1234 PHP_METHOD(HttpRequest
, addPostFields
)
1236 zval
*post
, *post_data
;
1237 getObject(http_request_object
, obj
);
1239 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &post_data
)) {
1243 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1244 array_merge(post_data
, post
);
1250 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1252 * Set the POST data entries, overwriting previously set POST data.
1253 * Affects only POST and custom requests.
1255 * Accepts an associative array as parameter containing the post fields.
1256 * If the parameter is empty or omitted, the post data will be unset.
1258 * Returns TRUE on success, or FALSE on failure.
1260 PHP_METHOD(HttpRequest
, setPostFields
)
1262 zval
*post
, *post_data
= NULL
;
1263 getObject(http_request_object
, obj
);
1265 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!", &post_data
)) {
1269 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1272 zend_hash_clean(Z_ARRVAL_P(post
));
1273 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1274 array_copy(post_data
, post
);
1276 SET_PROP(obj
, postFields
, post
);
1282 /* {{{ proto array HttpRequest::getPostFields()
1284 * Get previously set POST data.
1286 * Returns the currently set post fields as associative array.
1288 PHP_METHOD(HttpRequest
, getPostFields
)
1293 getObject(http_request_object
, obj
);
1294 zval
*post_data_p
, *post_data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFields
), &post_data_p
);
1296 array_init(return_value
);
1297 array_copy(post_data
, return_value
);
1300 zval_ptr_dtor(&post_data_p
);
1306 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1308 * Set raw post data to send, overwriting previously set raw post data. Don't
1309 * forget to specify a content type. Affects only POST and custom requests.
1310 * Only either post fields or raw post data can be used for each request.
1311 * Raw post data has higher precedence and will be used even if post fields
1314 * Accepts a string as parameter containing the *raw* post data.
1316 * Returns TRUE on success, or FALSE on failure.
1318 PHP_METHOD(HttpRequest
, setRawPostData
)
1320 char *raw_data
= NULL
;
1322 getObject(http_request_object
, obj
);
1324 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1332 UPD_STRL(obj
, rawPostData
, raw_data
, data_len
);
1337 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1339 * Add raw post data, leaving previously set raw post data unchanged.
1340 * Affects only POST and custom requests.
1342 * Expects a string as parameter containing the raw post data to concatenate.
1344 * Returns TRUE on success, or FALSE on failure.
1346 PHP_METHOD(HttpRequest
, addRawPostData
)
1348 char *raw_data
, *new_data
;
1350 getObject(http_request_object
, obj
);
1352 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1357 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &zdata_p
);
1359 new_data
= emalloc(Z_STRLEN_P(zdata
) + data_len
+ 1);
1360 new_data
[Z_STRLEN_P(zdata
) + data_len
] = '\0';
1362 if (Z_STRLEN_P(zdata
)) {
1363 memcpy(new_data
, Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
));
1366 memcpy(new_data
+ Z_STRLEN_P(zdata
), raw_data
, data_len
);
1367 UPD_STRL(obj
, rawPostData
, new_data
, Z_STRLEN_P(zdata
) + data_len
);
1370 zval_ptr_dtor(&zdata_p
);
1378 /* {{{ proto string HttpRequest::getRawPostData()
1380 * Get previously set raw post data.
1382 * Returns a string containing the currently set raw post data.
1384 PHP_METHOD(HttpRequest
, getRawPostData
)
1389 getObject(http_request_object
, obj
);
1390 zval
*raw_data_p
, *raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &raw_data_p
);
1392 RETVAL_ZVAL(raw_data
, 1, 0);
1395 zval_ptr_dtor(&raw_data_p
);
1401 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1403 * Add a file to the POST request, leaving prefiously set files unchanged.
1404 * Affects only POST and custom requests. Cannot be used with raw post data.
1406 * Expects a string parameter containing the form element name, and a string
1407 * paremeter containing the path to the file which should be uploaded.
1408 * Additionally accepts an optional string parameter which chould contain
1409 * the content type of the file.
1411 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1412 * primary and a secondary content type part.
1414 PHP_METHOD(HttpRequest
, addPostFile
)
1416 zval
*files
, *entry
;
1417 char *name
, *file
, *type
= NULL
;
1418 int name_len
, file_len
, type_len
= 0;
1419 getObject(http_request_object
, obj
);
1421 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1426 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1428 type
= "application/x-octetstream";
1429 type_len
= sizeof("application/x-octetstream") - 1;
1432 MAKE_STD_ZVAL(entry
);
1435 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1436 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1437 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1439 files
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1440 add_next_index_zval(files
, entry
);
1446 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1448 * Set files to post, overwriting previously set post files.
1449 * Affects only POST and requests. Cannot be used with raw post data.
1451 * Accepts an array containing the files to post. Each entry should be an
1452 * associative array with "name", "file" and "type" keys. If the parameter
1453 * is empty or omitted the post files will be unset.
1455 * Returns TRUE on success, or FALSE on failure.
1457 PHP_METHOD(HttpRequest
, setPostFiles
)
1459 zval
*files
, *pFiles
;
1460 getObject(http_request_object
, obj
);
1462 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &files
)) {
1466 pFiles
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1469 zend_hash_clean(Z_ARRVAL_P(pFiles
));
1470 if (files
&& zend_hash_num_elements(Z_ARRVAL_P(files
))) {
1471 array_copy(files
, pFiles
);
1473 SET_PROP(obj
, postFiles
, pFiles
);
1479 /* {{{ proto array HttpRequest::getPostFiles()
1481 * Get all previously added POST files.
1483 * Returns an array containing currently set post files.
1485 PHP_METHOD(HttpRequest
, getPostFiles
)
1490 getObject(http_request_object
, obj
);
1491 zval
*files_p
, *files
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFiles
), &files_p
);
1493 array_init(return_value
);
1494 array_copy(files
, return_value
);
1497 zval_ptr_dtor(&files_p
);
1503 /* {{{ proto bool HttpRequest::setPutFile([string file])
1505 * Set file to put. Affects only PUT requests.
1507 * Accepts a string as parameter referencing the path to file.
1508 * If the parameter is empty or omitted the put file will be unset.
1510 * Returns TRUE on success, or FALSE on failure.
1512 PHP_METHOD(HttpRequest
, setPutFile
)
1516 getObject(http_request_object
, obj
);
1518 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1522 UPD_STRL(obj
, putFile
, file
, file_len
);
1527 /* {{{ proto string HttpRequest::getPutFile()
1529 * Get previously set put file.
1531 * Returns a string containing the path to the currently set put file.
1533 PHP_METHOD(HttpRequest
, getPutFile
)
1538 getObject(http_request_object
, obj
);
1539 zval
*putfile_p
, *putfile
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, putFile
), &putfile_p
);
1541 RETVAL_ZVAL(putfile
, 1, 0);
1544 zval_ptr_dtor(&putfile_p
);
1550 /* {{{ proto array HttpRequest::getResponseData()
1552 * Get all response data after the request has been sent.
1554 * Returns an associative array with the key "headers" containing an associative
1555 * array holding all response headers, as well as the ley "body" containing a
1556 * string with the response body.
1558 * If redirects were allowed and several responses were received, the data
1559 * references the last received response.
1561 PHP_METHOD(HttpRequest
, getResponseData
)
1566 getObject(http_request_object
, obj
);
1567 zval
*data_p
, *data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
), &data_p
);
1569 array_init(return_value
);
1570 array_copy(data
, return_value
);
1573 zval_ptr_dtor(&data_p
);
1579 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1581 * Get response header(s) after the request has been sent.
1583 * Accepts an string as optional parameter specifying a certain header to read.
1584 * If the parameter is empty or omitted all response headers will be returned.
1586 * Returns either a string with the value of the header matching name if requested,
1587 * FALSE on failure, or an associative array containing all reponse headers.
1589 * If redirects were allowed and several responses were received, the data
1590 * references the last received response.
1592 PHP_METHOD(HttpRequest
, getResponseHeader
)
1595 zval
*data_p
, *data
, **headers
, **header
;
1596 char *header_name
= NULL
;
1598 getObject(http_request_object
, obj
);
1600 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1604 data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
), &data_p
);
1605 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1606 convert_to_array(*headers
);
1607 if (!header_len
|| !header_name
) {
1608 array_init(return_value
);
1609 array_copy(*headers
, return_value
);
1610 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1611 RETVAL_ZVAL(*header
, 1, 0);
1620 zval_ptr_dtor(&data_p
);
1626 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1628 * Get response cookie(s) after the request has been sent.
1630 * Accepts a string as optional parameter specifying the name of the cookie to read.
1631 * If the parameter is empty or omitted, an associative array with all received
1632 * cookies will be returned.
1634 * Returns either an associative array with the cookie's name, value and any
1635 * additional params of the cookie matching name if requested, FALSE on failure,
1636 * or an array containing all received cookies as arrays.
1638 * If redirects were allowed and several responses were received, the data
1639 * references the last received response.
1641 PHP_METHOD(HttpRequest
, getResponseCookie
)
1644 zval
*data
, **headers
;
1645 char *cookie_name
= NULL
;
1647 getObject(http_request_object
, obj
);
1649 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1653 array_init(return_value
);
1655 data
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
));
1656 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1659 zval
**header
= NULL
;
1662 convert_to_array(*headers
);
1663 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1664 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1665 /* several cookies? */
1666 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1670 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1672 MAKE_STD_ZVAL(cookie_hash
);
1673 array_init(cookie_hash
);
1675 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1677 add_next_index_zval(return_value
, cookie_hash
);
1681 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1682 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1683 add_next_index_zval(return_value
, cookie_hash
);
1684 return; /* <<< FOUND >>> */
1686 zval_dtor(cookie_hash
);
1691 zval_dtor(cookie_hash
);
1698 MAKE_STD_ZVAL(cookie_hash
);
1699 array_init(cookie_hash
);
1700 convert_to_string_ex(header
);
1702 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1704 add_next_index_zval(return_value
, cookie_hash
);
1708 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1709 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1710 add_next_index_zval(return_value
, cookie_hash
);
1712 zval_dtor(cookie_hash
);
1717 zval_dtor(cookie_hash
);
1731 /* {{{ proto string HttpRequest::getResponseBody()
1733 * Get the response body after the request has been sent.
1735 * Returns a string containing the response body.
1737 * If redirects were allowed and several responses were received, the data
1738 * references the last received response.
1740 PHP_METHOD(HttpRequest
, getResponseBody
)
1746 getObject(http_request_object
, obj
);
1747 zval
*data
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
));
1749 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
)) {
1750 RETURN_ZVAL(*body
, 1, 0);
1758 /* {{{ proto int HttpRequest::getResponseCode()
1760 * Get the response code after the request has been sent.
1762 * Returns an int representing the response code.
1764 * If redirects were allowed and several responses were received, the data
1765 * references the last received response.
1767 PHP_METHOD(HttpRequest
, getResponseCode
)
1772 getObject(http_request_object
, obj
);
1773 zval
*code_p
, *code
= convert_to_type_ex(IS_LONG
, GET_PROP(obj
, responseCode
), &code_p
);
1775 RETVAL_ZVAL(code
, 1, 0);
1778 zval_ptr_dtor(&code_p
);
1784 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1786 * Get response info after the request has been sent.
1787 * See http_get() for a full list of returned info.
1789 * Accepts a string as optional parameter specifying the info to read.
1790 * If the parameter is empty or omitted, an associative array containing
1791 * all available info will be returned.
1793 * Returns either a scalar containing the value of the info matching name if
1794 * requested, FALSE on failure, or an associative array containing all
1797 * If redirects were allowed and several responses were received, the data
1798 * references the last received response.
1800 PHP_METHOD(HttpRequest
, getResponseInfo
)
1803 zval
*info
, **infop
;
1804 char *info_name
= NULL
;
1806 getObject(http_request_object
, obj
);
1808 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1812 info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
1814 if (info_len
&& info_name
) {
1815 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1816 RETURN_ZVAL(*infop
, 1, 0);
1818 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1822 array_init(return_value
);
1823 array_copy(info
, return_value
);
1829 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1831 * Get the full response as HttpMessage object after the request has been sent.
1833 * Returns an HttpMessage object of the response.
1835 * If redirects were allowed and several responses were received, the data
1836 * references the last received response. Use HttpMessage::getParentMessage()
1837 * to access the data of previously received responses whithin this request
1840 * Throws HttpException.
1842 PHP_METHOD(HttpRequest
, getResponseMessage
)
1848 getObject(http_request_object
, obj
);
1850 SET_EH_THROW_HTTP();
1851 message
= GET_PROP(obj
, responseMessage
);
1852 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1853 RETVAL_OBJECT(message
);
1862 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1864 * Get sent HTTP message.
1866 * Returns an HttpMessage object representing the sent request.
1868 * If redirects were allowed and several responses were received, the data
1869 * references the last received response. Use HttpMessage::getParentMessage()
1870 * to access the data of previously sent requests whithin this request
1873 * Note that the internal request message is immutable, that means that the
1874 * request message received through HttpRequest::getRequestMessage() will
1875 * always look the same for the same request, regardless of any changes you
1876 * may have made to the returned object.
1878 * Throws HttpMalformedHeadersException, HttpEncodingException.
1880 PHP_METHOD(HttpRequest
, getRequestMessage
)
1886 getObject(http_request_object
, obj
);
1888 SET_EH_THROW_HTTP();
1889 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
), PHPSTR_LEN(&obj
->request
)))) {
1890 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1897 /* {{{ proto HttpMessage HttpRequest::getHistory()
1899 * Get all sent requests and received responses as an HttpMessage object.
1901 * If you don't want to record history at all, set the instance variable
1902 * HttpRequest::$recoedHistory to FALSE.
1904 * Returns an HttpMessage object representing the complete request/response
1907 * The object references the last received response, use HttpMessage::getParentMessage()
1908 * to access the data of previously sent requests and received responses.
1910 * Note that the internal history is immutable, that means that any changes
1911 * you make the the message list won't affect a history message list newly
1912 * created by another call to HttpRequest::getHistory().
1914 * Throws HttpMalformedHeaderException, HttpEncodingException.
1916 PHP_METHOD(HttpRequest
, getHistory
)
1922 getObject(http_request_object
, obj
);
1924 SET_EH_THROW_HTTP();
1925 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1926 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1933 /* {{{ proto void HttpRequest::clearHistory()
1935 * Clear the history.
1937 PHP_METHOD(HttpRequest
, clearHistory
)
1940 getObject(http_request_object
, obj
);
1941 phpstr_dtor(&obj
->history
);
1946 /* {{{ proto HttpMessage HttpRequest::send()
1948 * Send the HTTP request.
1950 * Returns the received response as HttpMessage object.
1952 * NOTE: While an exception may be thrown, the transfer could have succeeded
1953 * at least partially, so you might want to check the return values of various
1954 * HttpRequest::getResponse*() methods.
1956 * Throws HttpRuntimeException, HttpRequestException,
1957 * HttpMalformedHeaderException, HttpEncodingException.
1962 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1963 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1964 * $r->addQueryData(array('category' => 3));
1967 * if ($r->getResponseCode() == 200) {
1968 * file_put_contents('local.rss', $r->getResponseBody());
1970 * } catch (HttpException $ex) {
1979 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
1980 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1981 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1982 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1984 * echo $r->send()->getBody();
1985 * } catch (HttpException $ex) {
1991 PHP_METHOD(HttpRequest
, send
)
1993 http_request_body body
= {0, NULL
, 0};
1994 getObject(http_request_object
, obj
);
1998 SET_EH_THROW_HTTP();
2001 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
2008 if ( (SUCCESS
== http_request_object_requesthandler(obj
, getThis(), &body
)) &&
2009 (SUCCESS
== http_request_exec(obj
->ch
, NULL
, &obj
->response
, &obj
->request
)) &&
2010 (SUCCESS
== http_request_object_responsehandler(obj
, getThis()))) {
2011 RETVAL_OBJECT(GET_PROP(obj
, responseMessage
));
2013 http_request_body_dtor(&body
);
2019 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2026 * vim600: noet sw=4 ts=4 fdm=marker
2027 * vim<600: noet sw=4 ts=4