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
, 0);
151 HTTP_EMPTY_ARGS(getRawResponseMessage
, 0);
152 HTTP_EMPTY_ARGS(getRequestMessage
, 0);
153 HTTP_EMPTY_ARGS(getRawRequestMessage
, 0);
154 HTTP_EMPTY_ARGS(getHistory
, 0);
155 HTTP_EMPTY_ARGS(clearHistory
, 0);
156 HTTP_EMPTY_ARGS(send
, 0);
158 HTTP_BEGIN_ARGS(get
, 0, 1)
160 HTTP_ARG_VAL(options
, 0)
161 HTTP_ARG_VAL(info
, 1)
164 HTTP_BEGIN_ARGS(head
, 0, 1)
166 HTTP_ARG_VAL(options
, 0)
167 HTTP_ARG_VAL(info
, 1)
170 HTTP_BEGIN_ARGS(postData
, 0, 2)
172 HTTP_ARG_VAL(data
, 0)
173 HTTP_ARG_VAL(options
, 0)
174 HTTP_ARG_VAL(info
, 1)
177 HTTP_BEGIN_ARGS(postFields
, 0, 2)
179 HTTP_ARG_VAL(data
, 0)
180 HTTP_ARG_VAL(options
, 0)
181 HTTP_ARG_VAL(info
, 1)
184 HTTP_BEGIN_ARGS(putFile
, 0, 2)
186 HTTP_ARG_VAL(file
, 0)
187 HTTP_ARG_VAL(options
, 0)
188 HTTP_ARG_VAL(info
, 1)
191 HTTP_BEGIN_ARGS(putStream
, 0, 2)
193 HTTP_ARG_VAL(stream
, 0)
194 HTTP_ARG_VAL(options
, 0)
195 HTTP_ARG_VAL(info
, 1)
198 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
199 HTTP_ARG_VAL(method_name
, 0)
202 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
203 HTTP_ARG_VAL(method
, 0)
206 HTTP_BEGIN_ARGS(methodName
, 0, 1)
207 HTTP_ARG_VAL(method_id
, 0)
210 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
211 HTTP_ARG_VAL(method
, 0)
214 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
215 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
217 zend_class_entry
*http_request_object_ce
;
218 zend_function_entry http_request_object_fe
[] = {
219 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
220 HTTP_REQUEST_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
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
)
227 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
228 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
229 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
231 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
232 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
235 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
236 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
238 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
239 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
241 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
245 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
249 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
253 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
257 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
260 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
276 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
278 HTTP_REQUEST_ALIAS(get
, http_get
)
279 HTTP_REQUEST_ALIAS(head
, http_head
)
280 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
281 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
282 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
283 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
285 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
286 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
287 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
288 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
292 static zend_object_handlers http_request_object_handlers
;
294 PHP_MINIT_FUNCTION(http_request_object
)
296 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
297 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
301 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
303 return http_request_object_new_ex(ce
, curl_easy_init(), NULL
);
306 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
308 zend_object_value ov
;
309 http_request_object
*o
;
311 o
= ecalloc(1, sizeof(http_request_object
));
313 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
314 phpstr_init(&o
->history
);
320 ALLOC_HASHTABLE(OBJ_PROP(o
));
321 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
322 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
324 ov
.handle
= putObject(http_request_object
, o
);
325 ov
.handlers
= &http_request_object_handlers
;
330 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
333 zend_object_value new_ov
;
334 http_request_object
*new_obj
;
335 getObject(http_request_object
, old_obj
);
337 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
338 new_ov
= http_request_object_new_ex(old_zo
->ce
, curl_easy_duphandle(old_obj
->request
->ch
), &new_obj
);
340 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
341 phpstr_append(&new_obj
->history
, old_obj
->history
.data
, old_obj
->history
.used
);
342 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
343 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
348 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
350 zend_class_entry
*ce
= http_request_object_ce
;
352 DCL_PROP_N(PROTECTED
, options
);
353 DCL_PROP_N(PROTECTED
, responseInfo
);
354 DCL_PROP_N(PROTECTED
, responseData
);
355 DCL_PROP(PROTECTED
, long, responseCode
, 0);
356 DCL_PROP_N(PROTECTED
, responseMessage
);
357 DCL_PROP_N(PROTECTED
, postFields
);
358 DCL_PROP_N(PROTECTED
, postFiles
);
360 DCL_PROP(PROTECTED
, long, method
, HTTP_GET
);
362 DCL_PROP(PROTECTED
, string
, url
, "");
363 DCL_PROP(PROTECTED
, string
, contentType
, "");
364 DCL_PROP(PROTECTED
, string
, rawPostData
, "");
365 DCL_PROP(PROTECTED
, string
, queryData
, "");
366 DCL_PROP(PROTECTED
, string
, putFile
, "");
368 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
372 * Request Method Constants
375 DCL_CONST(long, "METH_GET", HTTP_GET
);
376 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
377 DCL_CONST(long, "METH_POST", HTTP_POST
);
378 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
379 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
380 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
381 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
382 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
383 /* WebDAV - RFC 2518 */
384 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
385 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
386 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
387 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
388 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
389 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
390 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
391 /* WebDAV Versioning - RFC 3253 */
392 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
393 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
394 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
395 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
396 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
397 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
398 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
399 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
400 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
401 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
402 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
403 /* WebDAV Access Control - RFC 3744 */
404 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
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
);
416 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
418 http_request_object
*o
= (http_request_object
*) object
;
421 zend_hash_destroy(OBJ_PROP(o
));
422 FREE_HASHTABLE(OBJ_PROP(o
));
424 http_request_free(&o
->request
);
425 phpstr_dtor(&o
->history
);
429 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
431 zval
*URL
, *URL_p
, *meth_p
;
432 STATUS status
= SUCCESS
;
434 http_request_reset(obj
->request
);
435 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, curl_easy_init(), return FAILURE
);
437 URL
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, url
), &URL_p
);
438 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(URL
));
439 if (URL_p
) zval_ptr_dtor(&URL_p
);
441 switch (obj
->request
->meth
= Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_PROP(obj
, method
), &meth_p
)))
449 php_stream_statbuf ssb
;
450 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(obj
, putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
452 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
453 http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
463 /* check for raw post data */
464 zval
*raw_data_p
, *raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &raw_data_p
);
466 if (Z_STRLEN_P(raw_data
)) {
467 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, contentType
), &ctype_p
);
469 if (Z_STRLEN_P(ctype
)) {
470 zval
**headers
, *opts
= GET_PROP(obj
, options
);
472 convert_to_array(opts
);
474 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) {
477 convert_to_array(*headers
);
478 /* only override if not already set */
479 if (SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) {
480 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
485 MAKE_STD_ZVAL(headers
);
487 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
488 add_assoc_zval(opts
, "headers", headers
);
493 zval_ptr_dtor(&ctype_p
);
496 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
497 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
500 zval
*fields_cpy
, *files_cpy
;
501 HashTable
*fields
= Z_ARRVAL_P(convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFields
), &fields_cpy
));
502 HashTable
*files
= Z_ARRVAL_P(convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFiles
), &files_cpy
));
504 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
509 zval_ptr_dtor(&fields_cpy
);
512 zval_ptr_dtor(&files_cpy
);
517 zval_ptr_dtor(&raw_data_p
);
524 zval_ptr_dtor(&meth_p
);
527 if (status
== SUCCESS
) {
528 zval
*qdata_p
, *qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &qdata_p
);
529 zval
*opt_p
, *options
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opt_p
);
531 if (Z_STRLEN_P(qdata
)) {
532 if (!strchr(obj
->request
->url
, '?')) {
533 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
535 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
537 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
540 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
543 zval_ptr_dtor(&opt_p
);
546 zval_ptr_dtor(&qdata_p
);
553 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
557 phpstr_fix(&obj
->request
->conv
.request
);
558 phpstr_fix(&obj
->request
->conv
.response
);
560 msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
567 zval
*headers
, *message
,
568 *resp
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
)),
569 *info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
574 if (zval_is_true(GET_PROP(obj
, recordHistory
))) {
575 /* we need to act like a zipper, as we'll receive
576 * the requests and the responses in separate chains
579 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
580 http_message
*free_msg
= request
;
586 http_message_tostring(response
, &message
, &msglen
);
587 phpstr_append(&obj
->history
, message
, msglen
);
590 http_message_tostring(request
, &message
, &msglen
);
591 phpstr_append(&obj
->history
, message
, msglen
);
594 } while ((response
= response
->parent
) && (request
= request
->parent
));
596 http_message_free(&free_msg
);
597 phpstr_fix(&obj
->history
);
600 UPD_PROP(obj
, long, responseCode
, msg
->http
.info
.response
.code
);
602 MAKE_STD_ZVAL(headers
);
605 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
606 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
608 add_assoc_zval(resp
, "headers", headers
);
609 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
610 SET_PROP(obj
, responseData
, resp
);
612 MAKE_STD_ZVAL(message
);
613 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
614 SET_PROP(obj
, responseMessage
, message
);
615 zval_ptr_dtor(&message
);
617 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
618 SET_PROP(obj
, responseInfo
, info
);
624 #define http_request_object_set_options_subr(key, ow) \
625 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
626 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
628 zval
*opts
, **options
, *new_options
= NULL
;
629 getObject(http_request_object
, obj
);
631 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &new_options
)) {
635 opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
637 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
638 convert_to_array(*options
);
640 zend_hash_clean(Z_ARRVAL_PP(options
));
642 if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
644 array_copy(new_options
, *options
);
646 array_merge(new_options
, *options
);
649 } else if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
650 ZVAL_ADDREF(new_options
);
651 add_assoc_zval(opts
, key
, new_options
);
657 #define http_request_object_get_options_subr(key) \
658 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
659 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
664 zval
*opts_p
, *opts
, **options
;
665 getObject(http_request_object
, obj
);
667 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opts_p
);
669 array_init(return_value
);
671 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
672 convert_to_array(*options
);
673 array_copy(*options
, return_value
);
677 zval_ptr_dtor(&opts_p
);
683 /* ### USERLAND ### */
685 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
687 * Instantiate a new HttpRequest object.
689 * Accepts a string as optional parameter containing the target request url.
690 * Additianally accepts an optional int parameter specifying the request method
691 * to use and an associative array as optional third parameter which will be
692 * passed to HttpRequest::setOptions().
694 * Throws HttpException.
696 PHP_METHOD(HttpRequest
, __construct
)
701 zval
*options
= NULL
;
702 getObject(http_request_object
, obj
);
705 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
706 INIT_PARR(obj
, options
);
707 INIT_PARR(obj
, responseInfo
);
708 INIT_PARR(obj
, responseData
);
709 INIT_PARR(obj
, postFields
);
710 INIT_PARR(obj
, postFiles
);
713 UPD_STRL(obj
, url
, URL
, URL_len
);
716 UPD_PROP(obj
, long, method
, meth
);
719 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
726 /* {{{ proto void HttpRequest::__destruct()
728 * Destroys the HttpRequest object.
730 PHP_METHOD(HttpRequest
, __destruct
)
732 getObject(http_request_object
, obj
);
736 FREE_PARR(obj
, options
);
737 FREE_PARR(obj
, responseInfo
);
738 FREE_PARR(obj
, responseData
);
739 FREE_PARR(obj
, postFields
);
740 FREE_PARR(obj
, postFiles
);
744 /* {{{ proto bool HttpRequest::setOptions([array options])
746 * Set the request options to use. See http_get() for a full list of available options.
748 * Accepts an array as optional parameters, wich values will overwrite the
749 * currently set request options. If the parameter is empty or mitted,
750 * the optoions of the HttpRequest object will be reset.
752 * Returns TRUE on success, or FALSE on failure.
754 PHP_METHOD(HttpRequest
, setOptions
)
759 zval
*opts
= NULL
, *old_opts
, **opt
;
760 getObject(http_request_object
, obj
);
762 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!", &opts
)) {
766 old_opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
769 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
770 zend_hash_clean(Z_ARRVAL_P(old_opts
));
771 SET_PROP(obj
, options
, old_opts
);
775 /* some options need extra attention -- thus cannot use array_merge() directly */
776 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
778 if (!strcmp(key
, "headers")) {
780 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "headers", sizeof("headers"), (void **) &headers
)) {
781 convert_to_array_ex(opt
);
782 convert_to_array(*headers
);
783 array_merge(*opt
, *headers
);
786 } else if (!strcmp(key
, "cookies")) {
788 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
789 convert_to_array_ex(opt
);
790 convert_to_array(*cookies
);
791 array_merge(*opt
, *cookies
);
794 } else if (!strcmp(key
, "ssl")) {
796 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "ssl", sizeof("ssl"), (void **) &ssl
)) {
797 convert_to_array_ex(opt
);
798 convert_to_array(*ssl
);
799 array_merge(*opt
, *ssl
);
802 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
803 if (Z_TYPE_PP(opt
) != IS_STRING
) {
804 convert_to_string_ex(opt
);
806 UPD_STRL(obj
, url
, Z_STRVAL_PP(opt
), Z_STRLEN_PP(opt
));
808 } else if (!strcmp(key
, "method")) {
809 if (Z_TYPE_PP(opt
) != IS_LONG
) {
810 convert_to_long_ex(opt
);
812 UPD_PROP(obj
, long, method
, Z_LVAL_PP(opt
));
817 add_assoc_zval(old_opts
, key
, *opt
);
823 SET_PROP(obj
, options
, old_opts
);
829 /* {{{ proto array HttpRequest::getOptions()
831 * Get currently set options.
833 * Returns an associative array containing currently set options.
835 PHP_METHOD(HttpRequest
, getOptions
)
841 getObject(http_request_object
, obj
);
843 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opts_p
);
844 array_init(return_value
);
845 array_copy(opts
, return_value
);
848 zval_ptr_dtor(&opts_p
);
854 /* {{{ proto bool HttpRequest::setSslOptions([array options])
858 * Accepts an associative array as parameter containing any SSL specific options.
859 * If the parameter is empty or omitted, the SSL options will be reset.
861 * Returns TRUE on success, or FALSE on failure.
863 PHP_METHOD(HttpRequest
, setSslOptions
)
865 http_request_object_set_options_subr("ssl", 1);
869 /* {{{ proto bool HttpRequest::addSslOptions(array options)
871 * Set additional SSL options.
873 * Expects an associative array as parameter containing additional SSL specific options.
875 * Returns TRUE on success, or FALSE on failure.
877 PHP_METHOD(HttpRequest
, addSslOptions
)
879 http_request_object_set_options_subr("ssl", 0);
883 /* {{{ proto array HttpRequest::getSslOtpions()
885 * Get previously set SSL options.
887 * Returns an associative array containing any previously set SSL options.
889 PHP_METHOD(HttpRequest
, getSslOptions
)
891 http_request_object_get_options_subr("ssl");
895 /* {{{ proto bool HttpRequest::addHeaders(array headers)
897 * Add request header name/value pairs.
899 * Expects an ssociative array as parameter containing additional header
902 * Returns TRUE on success, or FALSE on failure.
904 PHP_METHOD(HttpRequest
, addHeaders
)
906 http_request_object_set_options_subr("headers", 0);
909 /* {{{ proto bool HttpRequest::setHeaders([array headers])
911 * Set request header name/value pairs.
913 * Accepts an associative array as parameter containing header name/value pairs.
914 * If the parameter is empty or omitted, all previously set headers will be unset.
916 * Returns TRUE on success, or FALSE on failure.
918 PHP_METHOD(HttpRequest
, setHeaders
)
920 http_request_object_set_options_subr("headers", 1);
924 /* {{{ proto array HttpRequest::getHeaders()
926 * Get previously set request headers.
928 * Returns an associative array containing all currently set headers.
930 PHP_METHOD(HttpRequest
, getHeaders
)
932 http_request_object_get_options_subr("headers");
936 /* {{{ proto bool HttpRequest::setCookies([array cookies])
940 * Accepts an associative array as parameter containing cookie name/value pairs.
941 * If the parameter is empty or omitted, all previously set cookies will be unset.
943 * Returns TRUE on success, or FALSE on failure.
945 PHP_METHOD(HttpRequest
, setCookies
)
947 http_request_object_set_options_subr("cookies", 1);
951 /* {{{ proto bool HttpRequest::addCookies(array cookies)
955 * Expects an associative array as parameter containing any cookie name/value
958 * Returns TRUE on success, or FALSE on failure.
960 PHP_METHOD(HttpRequest
, addCookies
)
962 http_request_object_set_options_subr("cookies", 0);
966 /* {{{ proto array HttpRequest::getCookies()
968 * Get previously set cookies.
970 * Returns an associative array containing any previously set cookies.
972 PHP_METHOD(HttpRequest
, getCookies
)
974 http_request_object_get_options_subr("cookies");
978 /* {{{ proto bool HttpRequest::setUrl(string url)
980 * Set the request URL.
982 * Expects a string as parameter specifying the request url.
984 * Returns TRUE on success, or FALSE on failure.
986 PHP_METHOD(HttpRequest
, setUrl
)
990 getObject(http_request_object
, obj
);
992 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
996 UPD_STRL(obj
, url
, URL
, URL_len
);
1001 /* {{{ proto string HttpRequest::getUrl()
1003 * Get the previously set request URL.
1005 * Returns the currently set request url as string.
1007 PHP_METHOD(HttpRequest
, getUrl
)
1012 getObject(http_request_object
, obj
);
1013 zval
*URL
= GET_PROP(obj
, url
);
1015 RETURN_ZVAL(URL
, 1, 0);
1020 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1022 * Set the request method.
1024 * Expects an int as parameter specifying the request method to use.
1025 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1027 * Returns TRUE on success, or FALSE on failure.
1029 PHP_METHOD(HttpRequest
, setMethod
)
1032 getObject(http_request_object
, obj
);
1034 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
1038 UPD_PROP(obj
, long, method
, meth
);
1043 /* {{{ proto int HttpRequest::getMethod()
1045 * Get the previously set request method.
1047 * Returns the currently set request method.
1049 PHP_METHOD(HttpRequest
, getMethod
)
1054 getObject(http_request_object
, obj
);
1055 zval
*meth
= GET_PROP(obj
, method
);
1057 RETURN_ZVAL(meth
, 1, 0);
1062 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1064 * Set the content type the post request should have.
1066 * Expects a string as parameters containing the content type of the request
1067 * (primary/secondary).
1069 * Returns TRUE on success, or FALSE if the content type does not seem to
1070 * contain a primary and a secondary part.
1072 PHP_METHOD(HttpRequest
, setContentType
)
1076 getObject(http_request_object
, obj
);
1078 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1082 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1083 UPD_STRL(obj
, contentType
, ctype
, ct_len
);
1088 /* {{{ proto string HttpRequest::getContentType()
1090 * Get the previously content type.
1092 * Returns the previously set content type as string.
1094 PHP_METHOD(HttpRequest
, getContentType
)
1099 getObject(http_request_object
, obj
);
1100 zval
*ctype
= GET_PROP(obj
, contentType
);
1102 RETURN_ZVAL(ctype
, 1, 0);
1107 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1109 * Set the URL query parameters to use, overwriting previously set query parameters.
1110 * Affects any request types.
1112 * Accepts a string or associative array parameter containing the pre-encoded
1113 * query string or to be encoded query fields. If the parameter is empty or
1114 * omitted, the query data will be unset.
1116 * Returns TRUE on success, or FALSE on failure.
1118 PHP_METHOD(HttpRequest
, setQueryData
)
1121 getObject(http_request_object
, obj
);
1123 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1127 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1128 UPD_STRL(obj
, queryData
, "", 0);
1129 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1130 char *query_data
= NULL
;
1132 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1136 UPD_PROP(obj
, string
, queryData
, query_data
);
1139 convert_to_string_ex(&qdata
);
1140 UPD_STRL(obj
, queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1146 /* {{{ proto string HttpRequest::getQueryData()
1148 * Get the current query data in form of an urlencoded query string.
1150 * Returns a string containing the urlencoded query.
1152 PHP_METHOD(HttpRequest
, getQueryData
)
1157 getObject(http_request_object
, obj
);
1158 zval
*qdata_p
, *qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &qdata_p
);
1160 RETURN_ZVAL(qdata
, 1, 0);
1163 zval_ptr_dtor(&qdata_p
);
1169 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1171 * Add parameters to the query parameter list, leaving previously set unchanged.
1172 * Affects any request type.
1174 * Expects an associative array as parameter containing the query fields to add.
1176 * Returns TRUE on success, or FALSE on failure.
1178 PHP_METHOD(HttpRequest
, addQueryData
)
1180 zval
*qdata
, *old_qdata
, *old_qdata_p
;
1181 char *query_data
= NULL
;
1182 size_t query_data_len
= 0;
1183 getObject(http_request_object
, obj
);
1185 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &qdata
)) {
1189 old_qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &old_qdata_p
);
1191 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
)) {
1193 zval_ptr_dtor(&old_qdata_p
);
1198 UPD_STRL(obj
, queryData
, query_data
, query_data_len
);
1202 zval_ptr_dtor(&old_qdata_p
);
1209 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1211 * Adds POST data entries, leaving previously set unchanged, unless a
1212 * post entry with the same name already exists.
1213 * Affects only POST and custom requests.
1215 * Expects an associative array as parameter containing the post fields.
1217 * Returns TRUE on success, or FALSE on failure.
1219 PHP_METHOD(HttpRequest
, addPostFields
)
1221 zval
*post
, *post_data
;
1222 getObject(http_request_object
, obj
);
1224 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &post_data
)) {
1228 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1229 array_merge(post_data
, post
);
1235 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1237 * Set the POST data entries, overwriting previously set POST data.
1238 * Affects only POST and custom requests.
1240 * Accepts an associative array as parameter containing the post fields.
1241 * If the parameter is empty or omitted, the post data will be unset.
1243 * Returns TRUE on success, or FALSE on failure.
1245 PHP_METHOD(HttpRequest
, setPostFields
)
1247 zval
*post
, *post_data
= NULL
;
1248 getObject(http_request_object
, obj
);
1250 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!", &post_data
)) {
1254 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1257 zend_hash_clean(Z_ARRVAL_P(post
));
1258 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1259 array_copy(post_data
, post
);
1261 SET_PROP(obj
, postFields
, post
);
1267 /* {{{ proto array HttpRequest::getPostFields()
1269 * Get previously set POST data.
1271 * Returns the currently set post fields as associative array.
1273 PHP_METHOD(HttpRequest
, getPostFields
)
1278 getObject(http_request_object
, obj
);
1279 zval
*post_data_p
, *post_data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFields
), &post_data_p
);
1281 array_init(return_value
);
1282 array_copy(post_data
, return_value
);
1285 zval_ptr_dtor(&post_data_p
);
1291 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1293 * Set raw post data to send, overwriting previously set raw post data. Don't
1294 * forget to specify a content type. Affects only POST and custom requests.
1295 * Only either post fields or raw post data can be used for each request.
1296 * Raw post data has higher precedence and will be used even if post fields
1299 * Accepts a string as parameter containing the *raw* post data.
1301 * Returns TRUE on success, or FALSE on failure.
1303 PHP_METHOD(HttpRequest
, setRawPostData
)
1305 char *raw_data
= NULL
;
1307 getObject(http_request_object
, obj
);
1309 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1317 UPD_STRL(obj
, rawPostData
, raw_data
, data_len
);
1322 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1324 * Add raw post data, leaving previously set raw post data unchanged.
1325 * Affects only POST and custom requests.
1327 * Expects a string as parameter containing the raw post data to concatenate.
1329 * Returns TRUE on success, or FALSE on failure.
1331 PHP_METHOD(HttpRequest
, addRawPostData
)
1333 char *raw_data
, *new_data
;
1335 getObject(http_request_object
, obj
);
1337 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1342 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &zdata_p
);
1344 new_data
= emalloc(Z_STRLEN_P(zdata
) + data_len
+ 1);
1345 new_data
[Z_STRLEN_P(zdata
) + data_len
] = '\0';
1347 if (Z_STRLEN_P(zdata
)) {
1348 memcpy(new_data
, Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
));
1351 memcpy(new_data
+ Z_STRLEN_P(zdata
), raw_data
, data_len
);
1352 UPD_STRL(obj
, rawPostData
, new_data
, Z_STRLEN_P(zdata
) + data_len
);
1355 zval_ptr_dtor(&zdata_p
);
1363 /* {{{ proto string HttpRequest::getRawPostData()
1365 * Get previously set raw post data.
1367 * Returns a string containing the currently set raw post data.
1369 PHP_METHOD(HttpRequest
, getRawPostData
)
1374 getObject(http_request_object
, obj
);
1375 zval
*raw_data_p
, *raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &raw_data_p
);
1377 RETVAL_ZVAL(raw_data
, 1, 0);
1380 zval_ptr_dtor(&raw_data_p
);
1386 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1388 * Add a file to the POST request, leaving prefiously set files unchanged.
1389 * Affects only POST and custom requests. Cannot be used with raw post data.
1391 * Expects a string parameter containing the form element name, and a string
1392 * paremeter containing the path to the file which should be uploaded.
1393 * Additionally accepts an optional string parameter which chould contain
1394 * the content type of the file.
1396 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1397 * primary and a secondary content type part.
1399 PHP_METHOD(HttpRequest
, addPostFile
)
1401 zval
*files
, *entry
;
1402 char *name
, *file
, *type
= NULL
;
1403 int name_len
, file_len
, type_len
= 0;
1404 getObject(http_request_object
, obj
);
1406 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1411 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1413 type
= "application/x-octetstream";
1414 type_len
= sizeof("application/x-octetstream") - 1;
1417 MAKE_STD_ZVAL(entry
);
1420 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1421 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1422 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1424 files
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1425 add_next_index_zval(files
, entry
);
1431 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1433 * Set files to post, overwriting previously set post files.
1434 * Affects only POST and requests. Cannot be used with raw post data.
1436 * Accepts an array containing the files to post. Each entry should be an
1437 * associative array with "name", "file" and "type" keys. If the parameter
1438 * is empty or omitted the post files will be unset.
1440 * Returns TRUE on success, or FALSE on failure.
1442 PHP_METHOD(HttpRequest
, setPostFiles
)
1444 zval
*files
, *pFiles
;
1445 getObject(http_request_object
, obj
);
1447 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &files
)) {
1451 pFiles
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1454 zend_hash_clean(Z_ARRVAL_P(pFiles
));
1455 if (files
&& zend_hash_num_elements(Z_ARRVAL_P(files
))) {
1456 array_copy(files
, pFiles
);
1458 SET_PROP(obj
, postFiles
, pFiles
);
1464 /* {{{ proto array HttpRequest::getPostFiles()
1466 * Get all previously added POST files.
1468 * Returns an array containing currently set post files.
1470 PHP_METHOD(HttpRequest
, getPostFiles
)
1475 getObject(http_request_object
, obj
);
1476 zval
*files_p
, *files
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFiles
), &files_p
);
1478 array_init(return_value
);
1479 array_copy(files
, return_value
);
1482 zval_ptr_dtor(&files_p
);
1488 /* {{{ proto bool HttpRequest::setPutFile([string file])
1490 * Set file to put. Affects only PUT requests.
1492 * Accepts a string as parameter referencing the path to file.
1493 * If the parameter is empty or omitted the put file will be unset.
1495 * Returns TRUE on success, or FALSE on failure.
1497 PHP_METHOD(HttpRequest
, setPutFile
)
1501 getObject(http_request_object
, obj
);
1503 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1507 UPD_STRL(obj
, putFile
, file
, file_len
);
1512 /* {{{ proto string HttpRequest::getPutFile()
1514 * Get previously set put file.
1516 * Returns a string containing the path to the currently set put file.
1518 PHP_METHOD(HttpRequest
, getPutFile
)
1523 getObject(http_request_object
, obj
);
1524 zval
*putfile_p
, *putfile
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, putFile
), &putfile_p
);
1526 RETVAL_ZVAL(putfile
, 1, 0);
1529 zval_ptr_dtor(&putfile_p
);
1535 /* {{{ proto array HttpRequest::getResponseData()
1537 * Get all response data after the request has been sent.
1539 * Returns an associative array with the key "headers" containing an associative
1540 * array holding all response headers, as well as the ley "body" containing a
1541 * string with the response body.
1543 * If redirects were allowed and several responses were received, the data
1544 * references the last received response.
1546 PHP_METHOD(HttpRequest
, getResponseData
)
1551 getObject(http_request_object
, obj
);
1552 zval
*data_p
, *data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
), &data_p
);
1554 array_init(return_value
);
1555 array_copy(data
, return_value
);
1558 zval_ptr_dtor(&data_p
);
1564 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1566 * Get response header(s) after the request has been sent.
1568 * Accepts an string as optional parameter specifying a certain header to read.
1569 * If the parameter is empty or omitted all response headers will be returned.
1571 * Returns either a string with the value of the header matching name if requested,
1572 * FALSE on failure, or an associative array containing all reponse headers.
1574 * If redirects were allowed and several responses were received, the data
1575 * references the last received response.
1577 PHP_METHOD(HttpRequest
, getResponseHeader
)
1580 zval
*data_p
, *data
, **headers
, **header
;
1581 char *header_name
= NULL
;
1583 getObject(http_request_object
, obj
);
1585 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1589 data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
), &data_p
);
1590 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1591 convert_to_array(*headers
);
1592 if (!header_len
|| !header_name
) {
1593 array_init(return_value
);
1594 array_copy(*headers
, return_value
);
1595 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1596 RETVAL_ZVAL(*header
, 1, 0);
1605 zval_ptr_dtor(&data_p
);
1611 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1613 * Get response cookie(s) after the request has been sent.
1615 * Accepts a string as optional parameter specifying the name of the cookie to read.
1616 * If the parameter is empty or omitted, an associative array with all received
1617 * cookies will be returned.
1619 * Returns either an associative array with the cookie's name, value and any
1620 * additional params of the cookie matching name if requested, FALSE on failure,
1621 * or an array containing all received cookies as arrays.
1623 * If redirects were allowed and several responses were received, the data
1624 * references the last received response.
1626 PHP_METHOD(HttpRequest
, getResponseCookie
)
1629 zval
*data
, **headers
;
1630 char *cookie_name
= NULL
;
1632 getObject(http_request_object
, obj
);
1634 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1638 array_init(return_value
);
1640 data
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
));
1641 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1644 zval
**header
= NULL
;
1647 convert_to_array(*headers
);
1648 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1649 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1650 /* several cookies? */
1651 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1655 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1657 MAKE_STD_ZVAL(cookie_hash
);
1658 array_init(cookie_hash
);
1660 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1662 add_next_index_zval(return_value
, cookie_hash
);
1666 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1667 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1668 add_next_index_zval(return_value
, cookie_hash
);
1669 return; /* <<< FOUND >>> */
1671 zval_dtor(cookie_hash
);
1676 zval_dtor(cookie_hash
);
1683 MAKE_STD_ZVAL(cookie_hash
);
1684 array_init(cookie_hash
);
1685 convert_to_string_ex(header
);
1687 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1689 add_next_index_zval(return_value
, cookie_hash
);
1693 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1694 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1695 add_next_index_zval(return_value
, cookie_hash
);
1697 zval_dtor(cookie_hash
);
1702 zval_dtor(cookie_hash
);
1716 /* {{{ proto string HttpRequest::getResponseBody()
1718 * Get the response body after the request has been sent.
1720 * Returns a string containing the response body.
1722 * If redirects were allowed and several responses were received, the data
1723 * references the last received response.
1725 PHP_METHOD(HttpRequest
, getResponseBody
)
1731 getObject(http_request_object
, obj
);
1732 zval
*data
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
));
1734 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
)) {
1735 RETURN_ZVAL(*body
, 1, 0);
1743 /* {{{ proto int HttpRequest::getResponseCode()
1745 * Get the response code after the request has been sent.
1747 * Returns an int representing the response code.
1749 * If redirects were allowed and several responses were received, the data
1750 * references the last received response.
1752 PHP_METHOD(HttpRequest
, getResponseCode
)
1757 getObject(http_request_object
, obj
);
1758 zval
*code_p
, *code
= convert_to_type_ex(IS_LONG
, GET_PROP(obj
, responseCode
), &code_p
);
1760 RETVAL_ZVAL(code
, 1, 0);
1763 zval_ptr_dtor(&code_p
);
1769 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1771 * Get response info after the request has been sent.
1772 * See http_get() for a full list of returned info.
1774 * Accepts a string as optional parameter specifying the info to read.
1775 * If the parameter is empty or omitted, an associative array containing
1776 * all available info will be returned.
1778 * Returns either a scalar containing the value of the info matching name if
1779 * requested, FALSE on failure, or an associative array containing all
1782 * If redirects were allowed and several responses were received, the data
1783 * references the last received response.
1785 PHP_METHOD(HttpRequest
, getResponseInfo
)
1788 zval
*info
, **infop
;
1789 char *info_name
= NULL
;
1791 getObject(http_request_object
, obj
);
1793 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1797 info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
1799 if (info_len
&& info_name
) {
1800 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1801 RETURN_ZVAL(*infop
, 1, 0);
1803 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1807 array_init(return_value
);
1808 array_copy(info
, return_value
);
1814 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1816 * Get the full response as HttpMessage object after the request has been sent.
1818 * Returns an HttpMessage object of the response.
1820 * If redirects were allowed and several responses were received, the data
1821 * references the last received response. Use HttpMessage::getParentMessage()
1822 * to access the data of previously received responses whithin this request
1825 * Throws HttpException.
1827 PHP_METHOD(HttpRequest
, getResponseMessage
)
1833 getObject(http_request_object
, obj
);
1835 SET_EH_THROW_HTTP();
1836 message
= GET_PROP(obj
, responseMessage
);
1837 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1838 RETVAL_OBJECT(message
);
1847 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1849 * Get sent HTTP message.
1851 * Returns an HttpMessage object representing the sent request.
1853 * If redirects were allowed and several responses were received, the data
1854 * references the last received response. Use HttpMessage::getParentMessage()
1855 * to access the data of previously sent requests whithin this request
1858 * Note that the internal request message is immutable, that means that the
1859 * request message received through HttpRequest::getRequestMessage() will
1860 * always look the same for the same request, regardless of any changes you
1861 * may have made to the returned object.
1863 * Throws HttpMalformedHeadersException, HttpEncodingException.
1865 PHP_METHOD(HttpRequest
, getRequestMessage
)
1871 getObject(http_request_object
, obj
);
1873 SET_EH_THROW_HTTP();
1874 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1875 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1882 /* {{{ proto string HttpRequest::getRawRequestMessage()
1884 * Get sent HTTP message.
1886 * Returns an HttpMessage in a form of a string
1889 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1894 getObject(http_request_object
, obj
);
1896 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1901 /* {{{ proto string HttpRequest::getRawResponseMessage()
1903 * Get the entire HTTP response.
1905 * Returns the complete web server response, including the headers in a form of a string.
1908 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1913 getObject(http_request_object
, obj
);
1915 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1920 /* {{{ proto HttpMessage HttpRequest::getHistory()
1922 * Get all sent requests and received responses as an HttpMessage object.
1924 * If you don't want to record history at all, set the instance variable
1925 * HttpRequest::$recoedHistory to FALSE.
1927 * Returns an HttpMessage object representing the complete request/response
1930 * The object references the last received response, use HttpMessage::getParentMessage()
1931 * to access the data of previously sent requests and received responses.
1933 * Note that the internal history is immutable, that means that any changes
1934 * you make the the message list won't affect a history message list newly
1935 * created by another call to HttpRequest::getHistory().
1937 * Throws HttpMalformedHeaderException, HttpEncodingException.
1939 PHP_METHOD(HttpRequest
, getHistory
)
1945 getObject(http_request_object
, obj
);
1947 SET_EH_THROW_HTTP();
1948 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1949 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1956 /* {{{ proto void HttpRequest::clearHistory()
1958 * Clear the history.
1960 PHP_METHOD(HttpRequest
, clearHistory
)
1963 getObject(http_request_object
, obj
);
1964 phpstr_dtor(&obj
->history
);
1969 /* {{{ proto HttpMessage HttpRequest::send()
1971 * Send the HTTP request.
1973 * Returns the received response as HttpMessage object.
1975 * NOTE: While an exception may be thrown, the transfer could have succeeded
1976 * at least partially, so you might want to check the return values of various
1977 * HttpRequest::getResponse*() methods.
1979 * Throws HttpRuntimeException, HttpRequestException,
1980 * HttpMalformedHeaderException, HttpEncodingException.
1985 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1986 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1987 * $r->addQueryData(array('category' => 3));
1990 * if ($r->getResponseCode() == 200) {
1991 * file_put_contents('local.rss', $r->getResponseBody());
1993 * } catch (HttpException $ex) {
2002 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
2003 * $r->setOptions(array('cookies' => array('lang' => 'de')));
2004 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
2005 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
2007 * echo $r->send()->getBody();
2008 * } catch (HttpException $ex) {
2014 PHP_METHOD(HttpRequest
, send
)
2016 getObject(http_request_object
, obj
);
2020 SET_EH_THROW_HTTP();
2023 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
2030 if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
2031 http_request_exec(obj
->request
);
2032 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
2033 RETVAL_OBJECT(GET_PROP(obj
, responseMessage
));
2041 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2048 * vim600: noet sw=4 ts=4 fdm=marker
2049 * vim<600: noet sw=4 ts=4