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 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
36 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
37 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
38 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
40 HTTP_BEGIN_ARGS(__construct
, 0, 0)
42 HTTP_ARG_VAL(method
, 0)
43 HTTP_ARG_VAL(options
, 0)
46 HTTP_EMPTY_ARGS(getOptions
, 0);
47 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
48 HTTP_ARG_VAL(options
, 0)
51 HTTP_EMPTY_ARGS(getSslOptions
, 0);
52 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
53 HTTP_ARG_VAL(ssl_options
, 0)
56 HTTP_BEGIN_ARGS(addSslOptions
, 0, 0)
57 HTTP_ARG_VAL(ssl_optins
, 0)
60 HTTP_EMPTY_ARGS(getHeaders
, 0);
61 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
62 HTTP_ARG_VAL(headers
, 0)
65 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
66 HTTP_ARG_VAL(headers
, 0)
69 HTTP_EMPTY_ARGS(getCookies
, 0);
70 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
71 HTTP_ARG_VAL(cookies
, 0)
74 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
75 HTTP_ARG_VAL(cookies
, 0)
78 HTTP_EMPTY_ARGS(getUrl
, 0);
79 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
83 HTTP_EMPTY_ARGS(getMethod
, 0);
84 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
85 HTTP_ARG_VAL(request_method
, 0)
88 HTTP_EMPTY_ARGS(getContentType
, 0);
89 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
90 HTTP_ARG_VAL(content_type
, 0)
93 HTTP_EMPTY_ARGS(getQueryData
, 0);
94 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
95 HTTP_ARG_VAL(query_data
, 0)
98 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
99 HTTP_ARG_VAL(query_data
, 0)
102 HTTP_EMPTY_ARGS(getPostFields
, 0);
103 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
104 HTTP_ARG_VAL(post_fields
, 0)
107 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
108 HTTP_ARG_VAL(post_fields
, 0)
111 HTTP_EMPTY_ARGS(getPostFiles
, 0);
112 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
113 HTTP_ARG_VAL(post_files
, 0)
116 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
117 HTTP_ARG_VAL(formname
, 0)
118 HTTP_ARG_VAL(filename
, 0)
119 HTTP_ARG_VAL(content_type
, 0)
122 HTTP_EMPTY_ARGS(getRawPostData
, 0);
123 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
124 HTTP_ARG_VAL(raw_post_data
, 0)
127 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
128 HTTP_ARG_VAL(raw_post_data
, 0)
131 HTTP_EMPTY_ARGS(getPutFile
, 0);
132 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
133 HTTP_ARG_VAL(filename
, 0)
136 HTTP_EMPTY_ARGS(getResponseData
, 0);
137 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
138 HTTP_ARG_VAL(name
, 0)
141 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
142 HTTP_ARG_VAL(name
, 0)
145 HTTP_EMPTY_ARGS(getResponseBody
, 0);
146 HTTP_EMPTY_ARGS(getResponseCode
, 0);
147 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
148 HTTP_ARG_VAL(name
, 0)
151 HTTP_EMPTY_ARGS(getResponseMessage
, 0);
152 HTTP_EMPTY_ARGS(getRawResponseMessage
, 0);
153 HTTP_EMPTY_ARGS(getRequestMessage
, 0);
154 HTTP_EMPTY_ARGS(getRawRequestMessage
, 0);
155 HTTP_EMPTY_ARGS(getHistory
, 0);
156 HTTP_EMPTY_ARGS(clearHistory
, 0);
157 HTTP_EMPTY_ARGS(send
, 0);
159 HTTP_BEGIN_ARGS(get
, 0, 1)
161 HTTP_ARG_VAL(options
, 0)
162 HTTP_ARG_VAL(info
, 1)
165 HTTP_BEGIN_ARGS(head
, 0, 1)
167 HTTP_ARG_VAL(options
, 0)
168 HTTP_ARG_VAL(info
, 1)
171 HTTP_BEGIN_ARGS(postData
, 0, 2)
173 HTTP_ARG_VAL(data
, 0)
174 HTTP_ARG_VAL(options
, 0)
175 HTTP_ARG_VAL(info
, 1)
178 HTTP_BEGIN_ARGS(postFields
, 0, 2)
180 HTTP_ARG_VAL(data
, 0)
181 HTTP_ARG_VAL(options
, 0)
182 HTTP_ARG_VAL(info
, 1)
185 HTTP_BEGIN_ARGS(putFile
, 0, 2)
187 HTTP_ARG_VAL(file
, 0)
188 HTTP_ARG_VAL(options
, 0)
189 HTTP_ARG_VAL(info
, 1)
192 HTTP_BEGIN_ARGS(putStream
, 0, 2)
194 HTTP_ARG_VAL(stream
, 0)
195 HTTP_ARG_VAL(options
, 0)
196 HTTP_ARG_VAL(info
, 1)
199 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
200 HTTP_ARG_VAL(method_name
, 0)
203 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
204 HTTP_ARG_VAL(method
, 0)
207 HTTP_BEGIN_ARGS(methodName
, 0, 1)
208 HTTP_ARG_VAL(method_id
, 0)
211 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
212 HTTP_ARG_VAL(method
, 0)
215 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
216 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
218 zend_class_entry
*http_request_object_ce
;
219 zend_function_entry http_request_object_fe
[] = {
220 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
222 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
223 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
224 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
225 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
226 HTTP_REQUEST_ME(addSslOptions
, ZEND_ACC_PUBLIC
)
228 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
229 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
230 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
232 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
234 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
236 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
237 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
239 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
240 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
243 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
245 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
249 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
253 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
257 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
262 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
264 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
276 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
277 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
279 HTTP_REQUEST_ALIAS(get
, http_get
)
280 HTTP_REQUEST_ALIAS(head
, http_head
)
281 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
282 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
283 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
284 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
286 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
287 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
288 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
289 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
293 static zend_object_handlers http_request_object_handlers
;
295 PHP_MINIT_FUNCTION(http_request_object
)
297 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
298 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
302 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
304 return http_request_object_new_ex(ce
, curl_easy_init(), NULL
);
307 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
309 zend_object_value ov
;
310 http_request_object
*o
;
312 o
= ecalloc(1, sizeof(http_request_object
));
314 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
315 phpstr_init(&o
->history
);
321 ALLOC_HASHTABLE(OBJ_PROP(o
));
322 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
323 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
325 ov
.handle
= putObject(http_request_object
, o
);
326 ov
.handlers
= &http_request_object_handlers
;
331 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
334 zend_object_value new_ov
;
335 http_request_object
*new_obj
;
336 getObject(http_request_object
, old_obj
);
338 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
339 new_ov
= http_request_object_new_ex(old_zo
->ce
, curl_easy_duphandle(old_obj
->request
->ch
), &new_obj
);
341 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
342 phpstr_append(&new_obj
->history
, old_obj
->history
.data
, old_obj
->history
.used
);
343 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
344 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
349 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
351 zend_class_entry
*ce
= http_request_object_ce
;
353 DCL_PROP_N(PRIVATE
, options
);
354 DCL_PROP_N(PRIVATE
, postFields
);
355 DCL_PROP_N(PRIVATE
, postFiles
);
356 DCL_PROP_N(PRIVATE
, responseInfo
);
357 DCL_PROP_N(PRIVATE
, responseData
);
358 DCL_PROP_N(PRIVATE
, responseMessage
);
359 DCL_PROP(PRIVATE
, long, responseCode
, 0);
360 DCL_PROP(PRIVATE
, long, method
, HTTP_GET
);
361 DCL_PROP(PRIVATE
, string
, url
, "");
362 DCL_PROP(PRIVATE
, string
, contentType
, "");
363 DCL_PROP(PRIVATE
, string
, rawPostData
, "");
364 DCL_PROP(PRIVATE
, string
, queryData
, "");
365 DCL_PROP(PRIVATE
, 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 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
409 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
410 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
411 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
415 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
417 http_request_object
*o
= (http_request_object
*) object
;
420 zend_hash_destroy(OBJ_PROP(o
));
421 FREE_HASHTABLE(OBJ_PROP(o
));
423 http_request_free(&o
->request
);
424 phpstr_dtor(&o
->history
);
428 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
430 STATUS status
= SUCCESS
;
432 http_request_reset(obj
->request
);
433 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, curl_easy_init(), return FAILURE
);
435 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(obj
, url
)));
437 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(obj
, method
)))
445 php_stream_statbuf ssb
;
446 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(obj
, putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
448 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
449 http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
459 /* check for raw post data */
460 zval
*raw_data
= GET_PROP(obj
, rawPostData
);
462 if (Z_STRLEN_P(raw_data
)) {
463 zval
*ctype
= GET_PROP(obj
, contentType
);
465 if (Z_STRLEN_P(ctype
)) {
466 zval
**headers
, *opts
= GET_PROP(obj
, options
);
468 if ((SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) && (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
471 /* only override if not already set */
472 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) && (Z_TYPE_PP(ct_header
) == IS_STRING
)) {
473 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
478 MAKE_STD_ZVAL(headers
);
480 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
481 add_assoc_zval(opts
, "headers", headers
);
485 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
486 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
489 zval
*zfields
= GET_PROP(obj
, postFields
), *zfiles
= GET_PROP(obj
, postFiles
);
493 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
494 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
496 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
504 if (status
== SUCCESS
) {
505 zval
*qdata
= GET_PROP(obj
, queryData
);
506 zval
*options
= GET_PROP(obj
, options
);
508 if (Z_STRLEN_P(qdata
)) {
509 if (!strchr(obj
->request
->url
, '?')) {
510 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
512 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
514 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
517 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
523 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
527 phpstr_fix(&obj
->request
->conv
.request
);
528 phpstr_fix(&obj
->request
->conv
.response
);
530 msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
537 zval
*headers
, *message
, *resp
, *info
;
539 if (zval_is_true(GET_PROP(obj
, recordHistory
))) {
540 /* we need to act like a zipper, as we'll receive
541 * the requests and the responses in separate chains
544 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
545 http_message
*free_msg
= request
;
551 http_message_tostring(response
, &message
, &msglen
);
552 phpstr_append(&obj
->history
, message
, msglen
);
555 http_message_tostring(request
, &message
, &msglen
);
556 phpstr_append(&obj
->history
, message
, msglen
);
559 } while ((response
= response
->parent
) && (request
= request
->parent
));
561 http_message_free(&free_msg
);
562 phpstr_fix(&obj
->history
);
565 UPD_PROP(obj
, long, responseCode
, msg
->http
.info
.response
.code
);
569 MAKE_STD_ZVAL(headers
);
571 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
572 add_assoc_zval(resp
, "headers", headers
);
573 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
574 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
575 SET_PROP(obj
, responseData
, resp
);
576 zval_ptr_dtor(&resp
);
578 MAKE_STD_ZVAL(message
);
579 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
580 SET_PROP(obj
, responseMessage
, message
);
581 zval_ptr_dtor(&message
);
585 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
586 SET_PROP(obj
, responseInfo
, info
);
587 zval_ptr_dtor(&info
);
593 #define http_request_object_set_options_subr(key, ow) \
594 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
595 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
597 zval
*old_opts
, *new_opts
, *opts
, **entry
;
598 getObject(http_request_object
, obj
);
600 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
604 MAKE_STD_ZVAL(new_opts
);
605 array_init(new_opts
);
606 old_opts
= GET_PROP(obj
, options
);
607 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
608 array_copy(old_opts
, new_opts
);
611 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void **) &entry
)) {
613 zend_hash_clean(Z_ARRVAL_PP(entry
));
615 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
617 array_copy(opts
, *entry
);
619 array_merge(opts
, *entry
);
624 add_assoc_zval(new_opts
, key
, opts
);
626 SET_PROP(obj
, options
, new_opts
);
627 zval_ptr_dtor(&new_opts
);
632 #define http_request_object_get_options_subr(key) \
633 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
634 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
639 zval
*opts
, **options
;
640 getObject(http_request_object
, obj
);
642 opts
= GET_PROP(obj
, options
);
644 array_init(return_value
);
646 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
647 convert_to_array(*options
);
648 array_copy(*options
, return_value
);
654 /* ### USERLAND ### */
656 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
658 * Instantiate a new HttpRequest object.
660 * Accepts a string as optional parameter containing the target request url.
661 * Additianally accepts an optional int parameter specifying the request method
662 * to use and an associative array as optional third parameter which will be
663 * passed to HttpRequest::setOptions().
665 * Throws HttpException.
667 PHP_METHOD(HttpRequest
, __construct
)
672 zval
*options
= NULL
;
673 getObject(http_request_object
, obj
);
676 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
678 UPD_STRL(obj
, url
, URL
, URL_len
);
681 UPD_PROP(obj
, long, method
, meth
);
684 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
691 /* {{{ proto bool HttpRequest::setOptions([array options])
693 * Set the request options to use. See http_get() for a full list of available options.
695 * Accepts an array as optional parameters, wich values will overwrite the
696 * currently set request options. If the parameter is empty or mitted,
697 * the optoions of the HttpRequest object will be reset.
699 * Returns TRUE on success, or FALSE on failure.
701 PHP_METHOD(HttpRequest
, setOptions
)
706 zval
*opts
= NULL
, *old_opts
, *new_opts
, *add_opts
, **opt
;
707 getObject(http_request_object
, obj
);
709 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
713 MAKE_STD_ZVAL(new_opts
);
714 array_init(new_opts
);
716 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
717 SET_PROP(obj
, options
, new_opts
);
721 MAKE_STD_ZVAL(add_opts
);
722 array_init(add_opts
);
723 /* some options need extra attention -- thus cannot use array_merge() directly */
724 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
726 if (!strcmp(key
, "headers")) {
727 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, *opt
);
728 } else if (!strcmp(key
, "cookies")) {
729 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addcookies", NULL
, *opt
);
730 } else if (!strcmp(key
, "ssl")) {
731 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addssloptions", NULL
, *opt
);
732 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
733 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "seturl", NULL
, *opt
);
734 } else if (!strcmp(key
, "method")) {
735 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setmethod", NULL
, *opt
);
738 add_assoc_zval(add_opts
, key
, *opt
);
745 old_opts
= GET_PROP(obj
, options
);
746 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
747 array_copy(old_opts
, new_opts
);
749 array_merge(add_opts
, new_opts
);
750 SET_PROP(obj
, options
, new_opts
);
751 zval_ptr_dtor(&new_opts
);
752 zval_ptr_dtor(&add_opts
);
758 /* {{{ proto array HttpRequest::getOptions()
760 * Get currently set options.
762 * Returns an associative array containing currently set options.
764 PHP_METHOD(HttpRequest
, getOptions
)
769 getObject(http_request_object
, obj
);
770 zval
*options
= GET_PROP(obj
, options
);
772 RETURN_ZVAL(options
, 1, 0);
777 /* {{{ proto bool HttpRequest::setSslOptions([array options])
781 * Accepts an associative array as parameter containing any SSL specific options.
782 * If the parameter is empty or omitted, the SSL options will be reset.
784 * Returns TRUE on success, or FALSE on failure.
786 PHP_METHOD(HttpRequest
, setSslOptions
)
788 http_request_object_set_options_subr("ssl", 1);
792 /* {{{ proto bool HttpRequest::addSslOptions(array options)
794 * Set additional SSL options.
796 * Expects an associative array as parameter containing additional SSL specific options.
798 * Returns TRUE on success, or FALSE on failure.
800 PHP_METHOD(HttpRequest
, addSslOptions
)
802 http_request_object_set_options_subr("ssl", 0);
806 /* {{{ proto array HttpRequest::getSslOtpions()
808 * Get previously set SSL options.
810 * Returns an associative array containing any previously set SSL options.
812 PHP_METHOD(HttpRequest
, getSslOptions
)
814 http_request_object_get_options_subr("ssl");
818 /* {{{ proto bool HttpRequest::addHeaders(array headers)
820 * Add request header name/value pairs.
822 * Expects an ssociative array as parameter containing additional header
825 * Returns TRUE on success, or FALSE on failure.
827 PHP_METHOD(HttpRequest
, addHeaders
)
829 http_request_object_set_options_subr("headers", 0);
832 /* {{{ proto bool HttpRequest::setHeaders([array headers])
834 * Set request header name/value pairs.
836 * Accepts an associative array as parameter containing header name/value pairs.
837 * If the parameter is empty or omitted, all previously set headers will be unset.
839 * Returns TRUE on success, or FALSE on failure.
841 PHP_METHOD(HttpRequest
, setHeaders
)
843 http_request_object_set_options_subr("headers", 1);
847 /* {{{ proto array HttpRequest::getHeaders()
849 * Get previously set request headers.
851 * Returns an associative array containing all currently set headers.
853 PHP_METHOD(HttpRequest
, getHeaders
)
855 http_request_object_get_options_subr("headers");
859 /* {{{ proto bool HttpRequest::setCookies([array cookies])
863 * Accepts an associative array as parameter containing cookie name/value pairs.
864 * If the parameter is empty or omitted, all previously set cookies will be unset.
866 * Returns TRUE on success, or FALSE on failure.
868 PHP_METHOD(HttpRequest
, setCookies
)
870 http_request_object_set_options_subr("cookies", 1);
874 /* {{{ proto bool HttpRequest::addCookies(array cookies)
878 * Expects an associative array as parameter containing any cookie name/value
881 * Returns TRUE on success, or FALSE on failure.
883 PHP_METHOD(HttpRequest
, addCookies
)
885 http_request_object_set_options_subr("cookies", 0);
889 /* {{{ proto array HttpRequest::getCookies()
891 * Get previously set cookies.
893 * Returns an associative array containing any previously set cookies.
895 PHP_METHOD(HttpRequest
, getCookies
)
897 http_request_object_get_options_subr("cookies");
901 /* {{{ proto bool HttpRequest::setUrl(string url)
903 * Set the request URL.
905 * Expects a string as parameter specifying the request url.
907 * Returns TRUE on success, or FALSE on failure.
909 PHP_METHOD(HttpRequest
, setUrl
)
913 getObject(http_request_object
, obj
);
915 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
919 UPD_STRL(obj
, url
, URL
, URL_len
);
924 /* {{{ proto string HttpRequest::getUrl()
926 * Get the previously set request URL.
928 * Returns the currently set request url as string.
930 PHP_METHOD(HttpRequest
, getUrl
)
935 getObject(http_request_object
, obj
);
936 zval
*url
= GET_PROP(obj
, url
);
938 RETURN_ZVAL(url
, 1, 0);
943 /* {{{ proto bool HttpRequest::setMethod(int request_method)
945 * Set the request method.
947 * Expects an int as parameter specifying the request method to use.
948 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
950 * Returns TRUE on success, or FALSE on failure.
952 PHP_METHOD(HttpRequest
, setMethod
)
955 getObject(http_request_object
, obj
);
957 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
961 UPD_PROP(obj
, long, method
, meth
);
966 /* {{{ proto int HttpRequest::getMethod()
968 * Get the previously set request method.
970 * Returns the currently set request method.
972 PHP_METHOD(HttpRequest
, getMethod
)
977 getObject(http_request_object
, obj
);
978 zval
*method
= GET_PROP(obj
, method
);
980 RETURN_ZVAL(method
, 1, 0);
985 /* {{{ proto bool HttpRequest::setContentType(string content_type)
987 * Set the content type the post request should have.
989 * Expects a string as parameters containing the content type of the request
990 * (primary/secondary).
992 * Returns TRUE on success, or FALSE if the content type does not seem to
993 * contain a primary and a secondary part.
995 PHP_METHOD(HttpRequest
, setContentType
)
999 getObject(http_request_object
, obj
);
1001 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1005 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1006 UPD_STRL(obj
, contentType
, ctype
, ct_len
);
1011 /* {{{ proto string HttpRequest::getContentType()
1013 * Get the previously content type.
1015 * Returns the previously set content type as string.
1017 PHP_METHOD(HttpRequest
, getContentType
)
1022 getObject(http_request_object
, obj
);
1023 zval
*ctype
= GET_PROP(obj
, contentType
);
1025 RETURN_ZVAL(ctype
, 1, 0);
1030 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1032 * Set the URL query parameters to use, overwriting previously set query parameters.
1033 * Affects any request types.
1035 * Accepts a string or associative array parameter containing the pre-encoded
1036 * query string or to be encoded query fields. If the parameter is empty or
1037 * omitted, the query data will be unset.
1039 * Returns TRUE on success, or FALSE on failure.
1041 PHP_METHOD(HttpRequest
, setQueryData
)
1044 getObject(http_request_object
, obj
);
1046 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1050 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1051 UPD_STRL(obj
, queryData
, "", 0);
1052 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1053 char *query_data
= NULL
;
1055 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1059 UPD_PROP(obj
, string
, queryData
, query_data
);
1064 convert_to_string_ex(&qdata
);
1065 UPD_STRL(obj
, queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1066 if (orig
!= qdata
) {
1067 zval_ptr_dtor(&qdata
);
1074 /* {{{ proto string HttpRequest::getQueryData()
1076 * Get the current query data in form of an urlencoded query string.
1078 * Returns a string containing the urlencoded query.
1080 PHP_METHOD(HttpRequest
, getQueryData
)
1085 getObject(http_request_object
, obj
);
1086 zval
*qdata
= GET_PROP(obj
, queryData
);
1088 RETURN_ZVAL(qdata
, 1, 0);
1093 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1095 * Add parameters to the query parameter list, leaving previously set unchanged.
1096 * Affects any request type.
1098 * Expects an associative array as parameter containing the query fields to add.
1100 * Returns TRUE on success, or FALSE on failure.
1102 PHP_METHOD(HttpRequest
, addQueryData
)
1104 zval
*qdata
, *old_qdata
;
1105 char *query_data
= NULL
;
1106 size_t query_data_len
= 0;
1107 getObject(http_request_object
, obj
);
1109 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1113 old_qdata
= GET_PROP(obj
, queryData
);
1115 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
)) {
1119 UPD_STRL(obj
, queryData
, query_data
, query_data_len
);
1126 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1128 * Adds POST data entries, leaving previously set unchanged, unless a
1129 * post entry with the same name already exists.
1130 * Affects only POST and custom requests.
1132 * Expects an associative array as parameter containing the post fields.
1134 * Returns TRUE on success, or FALSE on failure.
1136 PHP_METHOD(HttpRequest
, addPostFields
)
1138 zval
*post_data
, *old_post
, *new_post
;
1139 getObject(http_request_object
, obj
);
1141 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1145 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1146 MAKE_STD_ZVAL(new_post
);
1147 array_init(new_post
);
1148 old_post
= GET_PROP(obj
, postFields
);
1149 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1150 array_copy(old_post
, new_post
);
1152 array_merge(post_data
, new_post
);
1153 SET_PROP(obj
, postFields
, new_post
);
1154 zval_ptr_dtor(&new_post
);
1161 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1163 * Set the POST data entries, overwriting previously set POST data.
1164 * Affects only POST and custom requests.
1166 * Accepts an associative array as parameter containing the post fields.
1167 * If the parameter is empty or omitted, the post data will be unset.
1169 * Returns TRUE on success, or FALSE on failure.
1171 PHP_METHOD(HttpRequest
, setPostFields
)
1173 zval
*post
, *post_data
= NULL
;
1174 getObject(http_request_object
, obj
);
1176 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/!", &post_data
)) {
1180 MAKE_STD_ZVAL(post
);
1182 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1183 array_copy(post_data
, post
);
1185 SET_PROP(obj
, postFields
, post
);
1186 zval_ptr_dtor(&post
);
1192 /* {{{ proto array HttpRequest::getPostFields()
1194 * Get previously set POST data.
1196 * Returns the currently set post fields as associative array.
1198 PHP_METHOD(HttpRequest
, getPostFields
)
1203 getObject(http_request_object
, obj
);
1204 zval
*post
= GET_PROP(obj
, postFields
);
1206 RETURN_ZVAL(post
, 1, 0);
1211 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1213 * Set raw post data to send, overwriting previously set raw post data. Don't
1214 * forget to specify a content type. Affects only POST and custom requests.
1215 * Only either post fields or raw post data can be used for each request.
1216 * Raw post data has higher precedence and will be used even if post fields
1219 * Accepts a string as parameter containing the *raw* post data.
1221 * Returns TRUE on success, or FALSE on failure.
1223 PHP_METHOD(HttpRequest
, setRawPostData
)
1225 char *raw_data
= NULL
;
1227 getObject(http_request_object
, obj
);
1229 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1237 UPD_STRL(obj
, rawPostData
, raw_data
, data_len
);
1242 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1244 * Add raw post data, leaving previously set raw post data unchanged.
1245 * Affects only POST and custom requests.
1247 * Expects a string as parameter containing the raw post data to concatenate.
1249 * Returns TRUE on success, or FALSE on failure.
1251 PHP_METHOD(HttpRequest
, addRawPostData
)
1255 getObject(http_request_object
, obj
);
1257 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1262 zval
*data
= zval_copy(IS_STRING
, GET_PROP(obj
, rawPostData
));
1264 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1265 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1266 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, raw_data
, data_len
);
1267 SET_PROP(obj
, rawPostData
, data
);
1275 /* {{{ proto string HttpRequest::getRawPostData()
1277 * Get previously set raw post data.
1279 * Returns a string containing the currently set raw post data.
1281 PHP_METHOD(HttpRequest
, getRawPostData
)
1286 getObject(http_request_object
, obj
);
1287 zval
*post
= GET_PROP(obj
, rawPostData
);
1289 RETURN_ZVAL(post
, 1, 0);
1294 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1296 * Add a file to the POST request, leaving prefiously set files unchanged.
1297 * Affects only POST and custom requests. Cannot be used with raw post data.
1299 * Expects a string parameter containing the form element name, and a string
1300 * paremeter containing the path to the file which should be uploaded.
1301 * Additionally accepts an optional string parameter which chould contain
1302 * the content type of the file.
1304 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1305 * primary and a secondary content type part.
1307 PHP_METHOD(HttpRequest
, addPostFile
)
1309 zval
*entry
, *old_post
, *new_post
;
1310 char *name
, *file
, *type
= NULL
;
1311 int name_len
, file_len
, type_len
= 0;
1312 getObject(http_request_object
, obj
);
1314 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1319 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1321 type
= "application/x-octetstream";
1322 type_len
= sizeof("application/x-octetstream") - 1;
1325 MAKE_STD_ZVAL(entry
);
1328 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1329 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1330 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1332 MAKE_STD_ZVAL(new_post
);
1333 array_init(new_post
);
1334 old_post
= GET_PROP(obj
, postFiles
);
1335 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1336 array_copy(old_post
, new_post
);
1338 add_next_index_zval(new_post
, entry
);
1339 SET_PROP(obj
, postFiles
, new_post
);
1340 zval_ptr_dtor(&new_post
);
1346 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1348 * Set files to post, overwriting previously set post files.
1349 * Affects only POST and requests. Cannot be used with raw post data.
1351 * Accepts an array containing the files to post. Each entry should be an
1352 * associative array with "name", "file" and "type" keys. If the parameter
1353 * is empty or omitted the post files will be unset.
1355 * Returns TRUE on success, or FALSE on failure.
1357 PHP_METHOD(HttpRequest
, setPostFiles
)
1359 zval
*files
= NULL
, *post
;
1360 getObject(http_request_object
, obj
);
1362 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!/", &files
)) {
1366 MAKE_STD_ZVAL(post
);
1368 if (files
&& (Z_TYPE_P(files
) == IS_ARRAY
)) {
1369 array_copy(files
, post
);
1371 SET_PROP(obj
, postFiles
, post
);
1377 /* {{{ proto array HttpRequest::getPostFiles()
1379 * Get all previously added POST files.
1381 * Returns an array containing currently set post files.
1383 PHP_METHOD(HttpRequest
, getPostFiles
)
1388 getObject(http_request_object
, obj
);
1390 array_init(return_value
);
1391 array_copy(GET_PROP(obj
, postFiles
), return_value
);
1396 /* {{{ proto bool HttpRequest::setPutFile([string file])
1398 * Set file to put. Affects only PUT requests.
1400 * Accepts a string as parameter referencing the path to file.
1401 * If the parameter is empty or omitted the put file will be unset.
1403 * Returns TRUE on success, or FALSE on failure.
1405 PHP_METHOD(HttpRequest
, setPutFile
)
1409 getObject(http_request_object
, obj
);
1411 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1415 UPD_STRL(obj
, putFile
, file
, file_len
);
1420 /* {{{ proto string HttpRequest::getPutFile()
1422 * Get previously set put file.
1424 * Returns a string containing the path to the currently set put file.
1426 PHP_METHOD(HttpRequest
, getPutFile
)
1431 getObject(http_request_object
, obj
);
1432 zval
*file
= GET_PROP(obj
, putFile
);
1434 RETVAL_ZVAL(file
, 1, 0);
1439 /* {{{ proto array HttpRequest::getResponseData()
1441 * Get all response data after the request has been sent.
1443 * Returns an associative array with the key "headers" containing an associative
1444 * array holding all response headers, as well as the ley "body" containing a
1445 * string with the response body.
1447 * If redirects were allowed and several responses were received, the data
1448 * references the last received response.
1450 PHP_METHOD(HttpRequest
, getResponseData
)
1455 getObject(http_request_object
, obj
);
1457 array_init(return_value
);
1458 array_copy(GET_PROP(obj
, responseData
), return_value
);
1463 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1465 * Get response header(s) after the request has been sent.
1467 * Accepts an string as optional parameter specifying a certain header to read.
1468 * If the parameter is empty or omitted all response headers will be returned.
1470 * Returns either a string with the value of the header matching name if requested,
1471 * FALSE on failure, or an associative array containing all reponse headers.
1473 * If redirects were allowed and several responses were received, the data
1474 * references the last received response.
1476 PHP_METHOD(HttpRequest
, getResponseHeader
)
1479 zval
*data
, **headers
, **header
;
1480 char *header_name
= NULL
;
1482 getObject(http_request_object
, obj
);
1484 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1488 data
= GET_PROP(obj
, responseData
);
1489 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1490 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1491 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1492 if (!header_len
|| !header_name
) {
1493 RETVAL_ZVAL(*headers
, 1, 0);
1494 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1495 RETVAL_ZVAL(*header
, 1, 0);
1506 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1508 * Get response cookie(s) after the request has been sent.
1510 * Accepts a string as optional parameter specifying the name of the cookie to read.
1511 * If the parameter is empty or omitted, an associative array with all received
1512 * cookies will be returned.
1514 * Returns either an associative array with the cookie's name, value and any
1515 * additional params of the cookie matching name if requested, FALSE on failure,
1516 * or an array containing all received cookies as arrays.
1518 * If redirects were allowed and several responses were received, the data
1519 * references the last received response.
1521 PHP_METHOD(HttpRequest
, getResponseCookie
)
1524 zval
*data
, **headers
;
1525 char *cookie_name
= NULL
;
1527 getObject(http_request_object
, obj
);
1529 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1533 array_init(return_value
);
1535 data
= GET_PROP(obj
, responseData
);
1536 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1537 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1538 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1541 zval
**header
= NULL
;
1544 convert_to_array(*headers
);
1545 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1546 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1547 /* several cookies? */
1548 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1552 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1554 MAKE_STD_ZVAL(cookie_hash
);
1555 array_init(cookie_hash
);
1557 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1559 add_next_index_zval(return_value
, cookie_hash
);
1563 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1564 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1565 add_next_index_zval(return_value
, cookie_hash
);
1566 return; /* <<< FOUND >>> */
1568 zval_dtor(cookie_hash
);
1573 zval_dtor(cookie_hash
);
1580 MAKE_STD_ZVAL(cookie_hash
);
1581 array_init(cookie_hash
);
1582 convert_to_string_ex(header
);
1584 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1586 add_next_index_zval(return_value
, cookie_hash
);
1590 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1591 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1592 add_next_index_zval(return_value
, cookie_hash
);
1594 zval_dtor(cookie_hash
);
1599 zval_dtor(cookie_hash
);
1613 /* {{{ proto string HttpRequest::getResponseBody()
1615 * Get the response body after the request has been sent.
1617 * Returns a string containing the response body.
1619 * If redirects were allowed and several responses were received, the data
1620 * references the last received response.
1622 PHP_METHOD(HttpRequest
, getResponseBody
)
1628 getObject(http_request_object
, obj
);
1629 zval
*data
= GET_PROP(obj
, responseData
);
1631 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1632 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
))) {
1633 RETURN_ZVAL(*body
, 1, 0);
1641 /* {{{ proto int HttpRequest::getResponseCode()
1643 * Get the response code after the request has been sent.
1645 * Returns an int representing the response code.
1647 * If redirects were allowed and several responses were received, the data
1648 * references the last received response.
1650 PHP_METHOD(HttpRequest
, getResponseCode
)
1655 getObject(http_request_object
, obj
);
1656 zval
*code
= GET_PROP(obj
, responseCode
);
1658 RETVAL_ZVAL(code
, 1, 0);
1663 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1665 * Get response info after the request has been sent.
1666 * See http_get() for a full list of returned info.
1668 * Accepts a string as optional parameter specifying the info to read.
1669 * If the parameter is empty or omitted, an associative array containing
1670 * all available info will be returned.
1672 * Returns either a scalar containing the value of the info matching name if
1673 * requested, FALSE on failure, or an associative array containing all
1676 * If redirects were allowed and several responses were received, the data
1677 * references the last received response.
1679 PHP_METHOD(HttpRequest
, getResponseInfo
)
1682 zval
*info
, **infop
;
1683 char *info_name
= NULL
;
1685 getObject(http_request_object
, obj
);
1687 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1691 info
= GET_PROP(obj
, responseInfo
);
1693 if (Z_TYPE_P(info
) != IS_ARRAY
) {
1697 if (info_len
&& info_name
) {
1698 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1699 RETURN_ZVAL(*infop
, 1, 0);
1701 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1705 RETURN_ZVAL(info
, 1, 0);
1711 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1713 * Get the full response as HttpMessage object after the request has been sent.
1715 * Returns an HttpMessage object of the response.
1717 * If redirects were allowed and several responses were received, the data
1718 * references the last received response. Use HttpMessage::getParentMessage()
1719 * to access the data of previously received responses whithin this request
1722 * Throws HttpException.
1724 PHP_METHOD(HttpRequest
, getResponseMessage
)
1730 getObject(http_request_object
, obj
);
1732 SET_EH_THROW_HTTP();
1733 message
= GET_PROP(obj
, responseMessage
);
1734 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1735 RETVAL_OBJECT(message
);
1744 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1746 * Get sent HTTP message.
1748 * Returns an HttpMessage object representing the sent request.
1750 * If redirects were allowed and several responses were received, the data
1751 * references the last received response. Use HttpMessage::getParentMessage()
1752 * to access the data of previously sent requests whithin this request
1755 * Note that the internal request message is immutable, that means that the
1756 * request message received through HttpRequest::getRequestMessage() will
1757 * always look the same for the same request, regardless of any changes you
1758 * may have made to the returned object.
1760 * Throws HttpMalformedHeadersException, HttpEncodingException.
1762 PHP_METHOD(HttpRequest
, getRequestMessage
)
1768 getObject(http_request_object
, obj
);
1770 SET_EH_THROW_HTTP();
1771 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1772 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1779 /* {{{ proto string HttpRequest::getRawRequestMessage()
1781 * Get sent HTTP message.
1783 * Returns an HttpMessage in a form of a string
1786 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1791 getObject(http_request_object
, obj
);
1793 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1798 /* {{{ proto string HttpRequest::getRawResponseMessage()
1800 * Get the entire HTTP response.
1802 * Returns the complete web server response, including the headers in a form of a string.
1805 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1810 getObject(http_request_object
, obj
);
1812 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1817 /* {{{ proto HttpMessage HttpRequest::getHistory()
1819 * Get all sent requests and received responses as an HttpMessage object.
1821 * If you don't want to record history at all, set the instance variable
1822 * HttpRequest::$recoedHistory to FALSE.
1824 * Returns an HttpMessage object representing the complete request/response
1827 * The object references the last received response, use HttpMessage::getParentMessage()
1828 * to access the data of previously sent requests and received responses.
1830 * Note that the internal history is immutable, that means that any changes
1831 * you make the the message list won't affect a history message list newly
1832 * created by another call to HttpRequest::getHistory().
1834 * Throws HttpMalformedHeaderException, HttpEncodingException.
1836 PHP_METHOD(HttpRequest
, getHistory
)
1842 getObject(http_request_object
, obj
);
1844 SET_EH_THROW_HTTP();
1845 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1846 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1853 /* {{{ proto void HttpRequest::clearHistory()
1855 * Clear the history.
1857 PHP_METHOD(HttpRequest
, clearHistory
)
1860 getObject(http_request_object
, obj
);
1861 phpstr_dtor(&obj
->history
);
1866 /* {{{ proto HttpMessage HttpRequest::send()
1868 * Send the HTTP request.
1870 * Returns the received response as HttpMessage object.
1872 * NOTE: While an exception may be thrown, the transfer could have succeeded
1873 * at least partially, so you might want to check the return values of various
1874 * HttpRequest::getResponse*() methods.
1876 * Throws HttpRuntimeException, HttpRequestException,
1877 * HttpMalformedHeaderException, HttpEncodingException.
1882 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1883 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1884 * $r->addQueryData(array('category' => 3));
1887 * if ($r->getResponseCode() == 200) {
1888 * file_put_contents('local.rss', $r->getResponseBody());
1890 * } catch (HttpException $ex) {
1899 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
1900 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1901 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1902 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1904 * echo $r->send()->getBody();
1905 * } catch (HttpException $ex) {
1911 PHP_METHOD(HttpRequest
, send
)
1913 getObject(http_request_object
, obj
);
1917 SET_EH_THROW_HTTP();
1922 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1923 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
1924 http_request_exec(obj
->request
);
1925 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
1926 RETVAL_OBJECT(GET_PROP(obj
, responseMessage
));
1934 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
1941 * vim600: noet sw=4 ts=4 fdm=marker
1942 * vim<600: noet sw=4 ts=4