2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
19 #define HTTP_WANT_CURL
22 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
24 #include "zend_interfaces.h"
26 #include "php_http_api.h"
27 #include "php_http_exception_object.h"
28 #include "php_http_message_api.h"
29 #include "php_http_message_object.h"
30 #include "php_http_request_api.h"
31 #include "php_http_request_object.h"
32 #include "php_http_request_pool_api.h"
33 #include "php_http_url_api.h"
35 ZEND_EXTERN_MODULE_GLOBALS(http
);
37 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
38 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
39 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
40 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
42 HTTP_EMPTY_ARGS(__destruct
, 0);
43 HTTP_BEGIN_ARGS(__construct
, 0, 0)
45 HTTP_ARG_VAL(method
, 0)
46 HTTP_ARG_VAL(options
, 0)
49 HTTP_EMPTY_ARGS(getOptions
, 0);
50 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
51 HTTP_ARG_VAL(options
, 0)
54 HTTP_EMPTY_ARGS(getSslOptions
, 0);
55 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
56 HTTP_ARG_VAL(ssl_options
, 0)
59 HTTP_EMPTY_ARGS(getHeaders
, 0);
60 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
61 HTTP_ARG_VAL(headers
, 0)
64 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
65 HTTP_ARG_VAL(headers
, 0)
68 HTTP_EMPTY_ARGS(getCookies
, 0);
69 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
70 HTTP_ARG_VAL(cookies
, 0)
73 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
74 HTTP_ARG_VAL(cookies
, 0)
77 HTTP_EMPTY_ARGS(getUrl
, 0);
78 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
82 HTTP_EMPTY_ARGS(getMethod
, 0);
83 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
84 HTTP_ARG_VAL(request_method
, 0)
87 HTTP_EMPTY_ARGS(getContentType
, 0);
88 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
89 HTTP_ARG_VAL(content_type
, 0)
92 HTTP_EMPTY_ARGS(getQueryData
, 0);
93 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
94 HTTP_ARG_VAL(query_data
, 0)
97 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
98 HTTP_ARG_VAL(query_data
, 0)
101 HTTP_EMPTY_ARGS(getPostFields
, 0);
102 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
103 HTTP_ARG_VAL(post_fields
, 0)
106 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
107 HTTP_ARG_VAL(post_fields
, 0)
110 HTTP_EMPTY_ARGS(getPostFiles
, 0);
111 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
112 HTTP_ARG_VAL(post_files
, 0)
115 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
116 HTTP_ARG_VAL(formname
, 0)
117 HTTP_ARG_VAL(filename
, 0)
118 HTTP_ARG_VAL(content_type
, 0)
121 HTTP_EMPTY_ARGS(getRawPostData
, 0);
122 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
123 HTTP_ARG_VAL(raw_post_data
, 0)
126 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
127 HTTP_ARG_VAL(raw_post_data
, 0)
130 HTTP_EMPTY_ARGS(getPutFile
, 0);
131 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
132 HTTP_ARG_VAL(filename
, 0)
135 HTTP_EMPTY_ARGS(getResponseData
, 0);
136 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
137 HTTP_ARG_VAL(name
, 0)
140 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
141 HTTP_ARG_VAL(name
, 0)
144 HTTP_EMPTY_ARGS(getResponseBody
, 0);
145 HTTP_EMPTY_ARGS(getResponseCode
, 0);
146 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
147 HTTP_ARG_VAL(name
, 0)
150 HTTP_EMPTY_ARGS(getResponseMessage
, 1);
151 HTTP_EMPTY_ARGS(getRequestMessage
, 1);
152 HTTP_EMPTY_ARGS(getHistory
, 1);
153 HTTP_EMPTY_ARGS(clearHistory
, 0);
154 HTTP_EMPTY_ARGS(send
, 1);
156 HTTP_BEGIN_ARGS(get
, 0, 1)
158 HTTP_ARG_VAL(options
, 0)
159 HTTP_ARG_VAL(info
, 1)
162 HTTP_BEGIN_ARGS(head
, 0, 1)
164 HTTP_ARG_VAL(options
, 0)
165 HTTP_ARG_VAL(info
, 1)
168 HTTP_BEGIN_ARGS(postData
, 0, 2)
170 HTTP_ARG_VAL(data
, 0)
171 HTTP_ARG_VAL(options
, 0)
172 HTTP_ARG_VAL(info
, 1)
175 HTTP_BEGIN_ARGS(postFields
, 0, 2)
177 HTTP_ARG_VAL(data
, 0)
178 HTTP_ARG_VAL(options
, 0)
179 HTTP_ARG_VAL(info
, 1)
182 HTTP_BEGIN_ARGS(putFile
, 0, 2)
184 HTTP_ARG_VAL(file
, 0)
185 HTTP_ARG_VAL(options
, 0)
186 HTTP_ARG_VAL(info
, 1)
189 HTTP_BEGIN_ARGS(putStream
, 0, 2)
191 HTTP_ARG_VAL(stream
, 0)
192 HTTP_ARG_VAL(options
, 0)
193 HTTP_ARG_VAL(info
, 1)
196 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
197 HTTP_ARG_VAL(method_name
, 0)
200 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
201 HTTP_ARG_VAL(method
, 0)
204 HTTP_BEGIN_ARGS(methodName
, 0, 1)
205 HTTP_ARG_VAL(method_id
, 0)
208 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
209 HTTP_ARG_VAL(method
, 0)
212 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
213 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
215 zend_class_entry
*http_request_object_ce
;
216 zend_function_entry http_request_object_fe
[] = {
217 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
218 HTTP_REQUEST_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
220 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
221 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
222 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
223 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
225 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
226 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
227 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
229 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
230 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
231 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
234 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
236 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
237 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
239 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
240 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
243 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
264 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ALIAS(get
, http_get
)
275 HTTP_REQUEST_ALIAS(head
, http_head
)
276 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
277 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
278 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
279 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
281 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
282 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
283 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
284 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
288 static zend_object_handlers http_request_object_handlers
;
290 PHP_MINIT_FUNCTION(http_request_object
)
292 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
293 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
297 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
299 return http_request_object_new_ex(ce
, curl_easy_init(), NULL
);
302 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
304 zend_object_value ov
;
305 http_request_object
*o
;
307 o
= ecalloc(1, sizeof(http_request_object
));
309 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
310 phpstr_init(&o
->history
);
316 ALLOC_HASHTABLE(OBJ_PROP(o
));
317 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
318 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
320 ov
.handle
= putObject(http_request_object
, o
);
321 ov
.handlers
= &http_request_object_handlers
;
326 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
329 zend_object_value new_ov
;
330 http_request_object
*new_obj
;
331 getObject(http_request_object
, old_obj
);
333 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
334 new_ov
= http_request_object_new_ex(old_zo
->ce
, curl_easy_duphandle(old_obj
->request
->ch
), &new_obj
);
336 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
337 phpstr_append(&new_obj
->history
, old_obj
->history
.data
, old_obj
->history
.used
);
338 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
339 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
344 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
346 zend_class_entry
*ce
= http_request_object_ce
;
348 DCL_PROP_N(PROTECTED
, options
);
349 DCL_PROP_N(PROTECTED
, responseInfo
);
350 DCL_PROP_N(PROTECTED
, responseData
);
351 DCL_PROP(PROTECTED
, long, responseCode
, 0);
352 DCL_PROP_N(PROTECTED
, responseMessage
);
353 DCL_PROP_N(PROTECTED
, postFields
);
354 DCL_PROP_N(PROTECTED
, postFiles
);
356 DCL_PROP(PROTECTED
, long, method
, HTTP_GET
);
358 DCL_PROP(PROTECTED
, string
, url
, "");
359 DCL_PROP(PROTECTED
, string
, contentType
, "");
360 DCL_PROP(PROTECTED
, string
, rawPostData
, "");
361 DCL_PROP(PROTECTED
, string
, queryData
, "");
362 DCL_PROP(PROTECTED
, string
, putFile
, "");
364 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
368 * Request Method Constants
371 DCL_CONST(long, "METH_GET", HTTP_GET
);
372 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
373 DCL_CONST(long, "METH_POST", HTTP_POST
);
374 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
375 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
376 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
377 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
378 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
379 /* WebDAV - RFC 2518 */
380 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
381 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
382 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
383 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
384 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
385 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
386 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
387 /* WebDAV Versioning - RFC 3253 */
388 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
389 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
390 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
391 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
392 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
393 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
394 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
395 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
396 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
397 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
398 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
399 /* WebDAV Access Control - RFC 3744 */
400 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
405 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
406 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
407 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
408 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
412 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
414 http_request_object
*o
= (http_request_object
*) object
;
417 zend_hash_destroy(OBJ_PROP(o
));
418 FREE_HASHTABLE(OBJ_PROP(o
));
420 http_request_free(&o
->request
);
421 phpstr_dtor(&o
->history
);
425 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
427 zval
*URL
, *URL_p
, *meth_p
;
428 STATUS status
= SUCCESS
;
430 http_request_reset(obj
->request
);
431 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, curl_easy_init(), return FAILURE
);
433 URL
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, url
), &URL_p
);
434 obj
->request
->url
= http_absolute_uri_ex(Z_STRVAL_P(URL
), Z_STRLEN_P(URL
), NULL
, 0, NULL
, 0, 0);
436 zval_ptr_dtor(&URL_p
);
439 if (!obj
->request
->url
) {
443 switch (obj
->request
->meth
= Z_LVAL_P(convert_to_type_ex(IS_LONG
, GET_PROP(obj
, method
), &meth_p
)))
451 php_stream_statbuf ssb
;
452 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(obj
, putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
454 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
455 http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
465 /* check for raw post data */
466 zval
*raw_data_p
, *raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &raw_data_p
);
468 if (Z_STRLEN_P(raw_data
)) {
469 zval
*ctype_p
, *ctype
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, contentType
), &ctype_p
);
471 if (Z_STRLEN_P(ctype
)) {
472 zval
**headers
, *opts
= GET_PROP(obj
, options
);
474 convert_to_array(opts
);
476 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) {
479 convert_to_array(*headers
);
480 /* only override if not already set */
481 if (SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) {
482 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
487 MAKE_STD_ZVAL(headers
);
489 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
490 add_assoc_zval(opts
, "headers", headers
);
495 zval_ptr_dtor(&ctype_p
);
498 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
499 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
502 zval
*fields_cpy
, *files_cpy
;
503 HashTable
*fields
= Z_ARRVAL_P(convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFields
), &fields_cpy
));
504 HashTable
*files
= Z_ARRVAL_P(convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFiles
), &files_cpy
));
506 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
511 zval_ptr_dtor(&fields_cpy
);
514 zval_ptr_dtor(&files_cpy
);
519 zval_ptr_dtor(&raw_data_p
);
526 zval_ptr_dtor(&meth_p
);
529 if (status
== SUCCESS
) {
530 zval
*qdata_p
, *qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &qdata_p
);
531 zval
*opt_p
, *options
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opt_p
);
533 if (Z_STRLEN_P(qdata
)) {
534 if (!strchr(obj
->request
->url
, '?')) {
535 strlcat(obj
->request
->url
, "?", HTTP_URI_MAXLEN
);
537 strlcat(obj
->request
->url
, "&", HTTP_URI_MAXLEN
);
539 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URI_MAXLEN
);
542 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
545 zval_ptr_dtor(&opt_p
);
548 zval_ptr_dtor(&qdata_p
);
555 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
559 phpstr_fix(&obj
->request
->conv
.request
);
560 phpstr_fix(&obj
->request
->conv
.response
);
562 msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
569 zval
*headers
, *message
,
570 *resp
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
)),
571 *info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
576 if (zval_is_true(GET_PROP(obj
, recordHistory
))) {
577 /* we need to act like a zipper, as we'll receive
578 * the requests and the responses in separate chains
581 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
582 http_message
*free_msg
= request
;
588 http_message_tostring(response
, &message
, &msglen
);
589 phpstr_append(&obj
->history
, message
, msglen
);
592 http_message_tostring(request
, &message
, &msglen
);
593 phpstr_append(&obj
->history
, message
, msglen
);
596 } while ((response
= response
->parent
) && (request
= request
->parent
));
598 http_message_free(&free_msg
);
599 phpstr_fix(&obj
->history
);
602 UPD_PROP(obj
, long, responseCode
, msg
->http
.info
.response
.code
);
604 MAKE_STD_ZVAL(headers
);
607 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
608 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
610 add_assoc_zval(resp
, "headers", headers
);
611 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
612 SET_PROP(obj
, responseData
, resp
);
614 MAKE_STD_ZVAL(message
);
615 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
616 SET_PROP(obj
, responseMessage
, message
);
617 zval_ptr_dtor(&message
);
619 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
620 SET_PROP(obj
, responseInfo
, info
);
626 #define http_request_object_set_options_subr(key, ow) \
627 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
628 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
630 zval
*opts
, **options
, *new_options
= NULL
;
631 getObject(http_request_object
, obj
);
633 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &new_options
)) {
637 opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
639 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
640 convert_to_array(*options
);
642 zend_hash_clean(Z_ARRVAL_PP(options
));
644 if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
646 array_copy(new_options
, *options
);
648 array_merge(new_options
, *options
);
651 } else if (new_options
&& zend_hash_num_elements(Z_ARRVAL_P(new_options
))) {
652 ZVAL_ADDREF(new_options
);
653 add_assoc_zval(opts
, key
, new_options
);
659 #define http_request_object_get_options_subr(key) \
660 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
661 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
666 zval
*opts_p
, *opts
, **options
;
667 getObject(http_request_object
, obj
);
669 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opts_p
);
671 array_init(return_value
);
673 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
674 convert_to_array(*options
);
675 array_copy(*options
, return_value
);
679 zval_ptr_dtor(&opts_p
);
685 /* ### USERLAND ### */
687 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
689 * Instantiate a new HttpRequest object.
691 * Accepts a string as optional parameter containing the target request url.
692 * Additianally accepts an optional int parameter specifying the request method
693 * to use and an associative array as optional third parameter which will be
694 * passed to HttpRequest::setOptions().
696 * Throws HttpException.
698 PHP_METHOD(HttpRequest
, __construct
)
703 zval
*options
= NULL
;
704 getObject(http_request_object
, obj
);
707 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
708 INIT_PARR(obj
, options
);
709 INIT_PARR(obj
, responseInfo
);
710 INIT_PARR(obj
, responseData
);
711 INIT_PARR(obj
, postFields
);
712 INIT_PARR(obj
, postFiles
);
715 UPD_STRL(obj
, url
, URL
, URL_len
);
718 UPD_PROP(obj
, long, method
, meth
);
721 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
728 /* {{{ proto void HttpRequest::__destruct()
730 * Destroys the HttpRequest object.
732 PHP_METHOD(HttpRequest
, __destruct
)
734 getObject(http_request_object
, obj
);
738 FREE_PARR(obj
, options
);
739 FREE_PARR(obj
, responseInfo
);
740 FREE_PARR(obj
, responseData
);
741 FREE_PARR(obj
, postFields
);
742 FREE_PARR(obj
, postFiles
);
746 /* {{{ proto bool HttpRequest::setOptions([array options])
748 * Set the request options to use. See http_get() for a full list of available options.
750 * Accepts an array as optional parameters, wich values will overwrite the
751 * currently set request options. If the parameter is empty or mitted,
752 * the optoions of the HttpRequest object will be reset.
754 * Returns TRUE on success, or FALSE on failure.
756 PHP_METHOD(HttpRequest
, setOptions
)
761 zval
*opts
= NULL
, *old_opts
, **opt
;
762 getObject(http_request_object
, obj
);
764 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!", &opts
)) {
768 old_opts
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, options
));
771 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
772 zend_hash_clean(Z_ARRVAL_P(old_opts
));
773 SET_PROP(obj
, options
, old_opts
);
777 /* some options need extra attention -- thus cannot use array_merge() directly */
778 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
780 if (!strcmp(key
, "headers")) {
782 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "headers", sizeof("headers"), (void **) &headers
)) {
783 convert_to_array_ex(opt
);
784 convert_to_array(*headers
);
785 array_merge(*opt
, *headers
);
788 } else if (!strcmp(key
, "cookies")) {
790 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
791 convert_to_array_ex(opt
);
792 convert_to_array(*cookies
);
793 array_merge(*opt
, *cookies
);
796 } else if (!strcmp(key
, "ssl")) {
798 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "ssl", sizeof("ssl"), (void **) &ssl
)) {
799 convert_to_array_ex(opt
);
800 convert_to_array(*ssl
);
801 array_merge(*opt
, *ssl
);
804 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
805 if (Z_TYPE_PP(opt
) != IS_STRING
) {
806 convert_to_string_ex(opt
);
808 UPD_STRL(obj
, url
, Z_STRVAL_PP(opt
), Z_STRLEN_PP(opt
));
810 } else if (!strcmp(key
, "method")) {
811 if (Z_TYPE_PP(opt
) != IS_LONG
) {
812 convert_to_long_ex(opt
);
814 UPD_PROP(obj
, long, method
, Z_LVAL_PP(opt
));
819 add_assoc_zval(old_opts
, key
, *opt
);
825 SET_PROP(obj
, options
, old_opts
);
831 /* {{{ proto array HttpRequest::getOptions()
833 * Get currently set options.
835 * Returns an associative array containing currently set options.
837 PHP_METHOD(HttpRequest
, getOptions
)
843 getObject(http_request_object
, obj
);
845 opts
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, options
), &opts_p
);
846 array_init(return_value
);
847 array_copy(opts
, return_value
);
850 zval_ptr_dtor(&opts_p
);
856 /* {{{ proto bool HttpRequest::setSslOptions([array options])
860 * Accepts an associative array as parameter containing any SSL specific options.
861 * If the parameter is empty or omitted, the SSL options will be reset.
863 * Returns TRUE on success, or FALSE on failure.
865 PHP_METHOD(HttpRequest
, setSslOptions
)
867 http_request_object_set_options_subr("ssl", 1);
871 /* {{{ proto bool HttpRequest::addSslOptions(array options)
873 * Set additional SSL options.
875 * Expects an associative array as parameter containing additional SSL specific options.
877 * Returns TRUE on success, or FALSE on failure.
879 PHP_METHOD(HttpRequest
, addSslOptions
)
881 http_request_object_set_options_subr("ssl", 0);
885 /* {{{ proto array HttpRequest::getSslOtpions()
887 * Get previously set SSL options.
889 * Returns an associative array containing any previously set SSL options.
891 PHP_METHOD(HttpRequest
, getSslOptions
)
893 http_request_object_get_options_subr("ssl");
897 /* {{{ proto bool HttpRequest::addHeaders(array headers)
899 * Add request header name/value pairs.
901 * Expects an ssociative array as parameter containing additional header
904 * Returns TRUE on success, or FALSE on failure.
906 PHP_METHOD(HttpRequest
, addHeaders
)
908 http_request_object_set_options_subr("headers", 0);
911 /* {{{ proto bool HttpRequest::setHeaders([array headers])
913 * Set request header name/value pairs.
915 * Accepts an associative array as parameter containing header name/value pairs.
916 * If the parameter is empty or omitted, all previously set headers will be unset.
918 * Returns TRUE on success, or FALSE on failure.
920 PHP_METHOD(HttpRequest
, setHeaders
)
922 http_request_object_set_options_subr("headers", 1);
926 /* {{{ proto array HttpRequest::getHeaders()
928 * Get previously set request headers.
930 * Returns an associative array containing all currently set headers.
932 PHP_METHOD(HttpRequest
, getHeaders
)
934 http_request_object_get_options_subr("headers");
938 /* {{{ proto bool HttpRequest::setCookies([array cookies])
942 * Accepts an associative array as parameter containing cookie name/value pairs.
943 * If the parameter is empty or omitted, all previously set cookies will be unset.
945 * Returns TRUE on success, or FALSE on failure.
947 PHP_METHOD(HttpRequest
, setCookies
)
949 http_request_object_set_options_subr("cookies", 1);
953 /* {{{ proto bool HttpRequest::addCookies(array cookies)
957 * Expects an associative array as parameter containing any cookie name/value
960 * Returns TRUE on success, or FALSE on failure.
962 PHP_METHOD(HttpRequest
, addCookies
)
964 http_request_object_set_options_subr("cookies", 0);
968 /* {{{ proto array HttpRequest::getCookies()
970 * Get previously set cookies.
972 * Returns an associative array containing any previously set cookies.
974 PHP_METHOD(HttpRequest
, getCookies
)
976 http_request_object_get_options_subr("cookies");
980 /* {{{ proto bool HttpRequest::setUrl(string url)
982 * Set the request URL.
984 * Expects a string as parameter specifying the request url.
986 * Returns TRUE on success, or FALSE on failure.
988 PHP_METHOD(HttpRequest
, setUrl
)
992 getObject(http_request_object
, obj
);
994 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
998 UPD_STRL(obj
, url
, URL
, URL_len
);
1003 /* {{{ proto string HttpRequest::getUrl()
1005 * Get the previously set request URL.
1007 * Returns the currently set request url as string.
1009 PHP_METHOD(HttpRequest
, getUrl
)
1014 getObject(http_request_object
, obj
);
1015 zval
*URL
= GET_PROP(obj
, url
);
1017 RETURN_ZVAL(URL
, 1, 0);
1022 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1024 * Set the request method.
1026 * Expects an int as parameter specifying the request method to use.
1027 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1029 * Returns TRUE on success, or FALSE on failure.
1031 PHP_METHOD(HttpRequest
, setMethod
)
1034 getObject(http_request_object
, obj
);
1036 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
1040 UPD_PROP(obj
, long, method
, meth
);
1045 /* {{{ proto int HttpRequest::getMethod()
1047 * Get the previously set request method.
1049 * Returns the currently set request method.
1051 PHP_METHOD(HttpRequest
, getMethod
)
1056 getObject(http_request_object
, obj
);
1057 zval
*meth
= GET_PROP(obj
, method
);
1059 RETURN_ZVAL(meth
, 1, 0);
1064 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1066 * Set the content type the post request should have.
1068 * Expects a string as parameters containing the content type of the request
1069 * (primary/secondary).
1071 * Returns TRUE on success, or FALSE if the content type does not seem to
1072 * contain a primary and a secondary part.
1074 PHP_METHOD(HttpRequest
, setContentType
)
1078 getObject(http_request_object
, obj
);
1080 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1084 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1085 UPD_STRL(obj
, contentType
, ctype
, ct_len
);
1090 /* {{{ proto string HttpRequest::getContentType()
1092 * Get the previously content type.
1094 * Returns the previously set content type as string.
1096 PHP_METHOD(HttpRequest
, getContentType
)
1101 getObject(http_request_object
, obj
);
1102 zval
*ctype
= GET_PROP(obj
, contentType
);
1104 RETURN_ZVAL(ctype
, 1, 0);
1109 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1111 * Set the URL query parameters to use, overwriting previously set query parameters.
1112 * Affects any request types.
1114 * Accepts a string or associative array parameter containing the pre-encoded
1115 * query string or to be encoded query fields. If the parameter is empty or
1116 * omitted, the query data will be unset.
1118 * Returns TRUE on success, or FALSE on failure.
1120 PHP_METHOD(HttpRequest
, setQueryData
)
1123 getObject(http_request_object
, obj
);
1125 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1129 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1130 UPD_STRL(obj
, queryData
, "", 0);
1131 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1132 char *query_data
= NULL
;
1134 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1138 UPD_PROP(obj
, string
, queryData
, query_data
);
1141 convert_to_string_ex(&qdata
);
1142 UPD_STRL(obj
, queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1148 /* {{{ proto string HttpRequest::getQueryData()
1150 * Get the current query data in form of an urlencoded query string.
1152 * Returns a string containing the urlencoded query.
1154 PHP_METHOD(HttpRequest
, getQueryData
)
1159 getObject(http_request_object
, obj
);
1160 zval
*qdata_p
, *qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &qdata_p
);
1162 RETURN_ZVAL(qdata
, 1, 0);
1165 zval_ptr_dtor(&qdata_p
);
1171 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1173 * Add parameters to the query parameter list, leaving previously set unchanged.
1174 * Affects any request type.
1176 * Expects an associative array as parameter containing the query fields to add.
1178 * Returns TRUE on success, or FALSE on failure.
1180 PHP_METHOD(HttpRequest
, addQueryData
)
1182 zval
*qdata
, *old_qdata
, *old_qdata_p
;
1183 char *query_data
= NULL
;
1184 size_t query_data_len
= 0;
1185 getObject(http_request_object
, obj
);
1187 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &qdata
)) {
1191 old_qdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, queryData
), &old_qdata_p
);
1193 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
)) {
1195 zval_ptr_dtor(&old_qdata_p
);
1200 UPD_STRL(obj
, queryData
, query_data
, query_data_len
);
1204 zval_ptr_dtor(&old_qdata_p
);
1211 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1213 * Adds POST data entries, leaving previously set unchanged, unless a
1214 * post entry with the same name already exists.
1215 * Affects only POST and custom requests.
1217 * Expects an associative array as parameter containing the post fields.
1219 * Returns TRUE on success, or FALSE on failure.
1221 PHP_METHOD(HttpRequest
, addPostFields
)
1223 zval
*post
, *post_data
;
1224 getObject(http_request_object
, obj
);
1226 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &post_data
)) {
1230 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1231 array_merge(post_data
, post
);
1237 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1239 * Set the POST data entries, overwriting previously set POST data.
1240 * Affects only POST and custom requests.
1242 * Accepts an associative array as parameter containing the post fields.
1243 * If the parameter is empty or omitted, the post data will be unset.
1245 * Returns TRUE on success, or FALSE on failure.
1247 PHP_METHOD(HttpRequest
, setPostFields
)
1249 zval
*post
, *post_data
= NULL
;
1250 getObject(http_request_object
, obj
);
1252 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!", &post_data
)) {
1256 post
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFields
));
1259 zend_hash_clean(Z_ARRVAL_P(post
));
1260 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1261 array_copy(post_data
, post
);
1263 SET_PROP(obj
, postFields
, post
);
1269 /* {{{ proto array HttpRequest::getPostFields()
1271 * Get previously set POST data.
1273 * Returns the currently set post fields as associative array.
1275 PHP_METHOD(HttpRequest
, getPostFields
)
1280 getObject(http_request_object
, obj
);
1281 zval
*post_data_p
, *post_data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFields
), &post_data_p
);
1283 array_init(return_value
);
1284 array_copy(post_data
, return_value
);
1287 zval_ptr_dtor(&post_data_p
);
1293 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1295 * Set raw post data to send, overwriting previously set raw post data. Don't
1296 * forget to specify a content type. Affects only POST and custom requests.
1297 * Only either post fields or raw post data can be used for each request.
1298 * Raw post data has higher precedence and will be used even if post fields
1301 * Accepts a string as parameter containing the *raw* post data.
1303 * Returns TRUE on success, or FALSE on failure.
1305 PHP_METHOD(HttpRequest
, setRawPostData
)
1307 char *raw_data
= NULL
;
1309 getObject(http_request_object
, obj
);
1311 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1319 UPD_STRL(obj
, rawPostData
, raw_data
, data_len
);
1324 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1326 * Add raw post data, leaving previously set raw post data unchanged.
1327 * Affects only POST and custom requests.
1329 * Expects a string as parameter containing the raw post data to concatenate.
1331 * Returns TRUE on success, or FALSE on failure.
1333 PHP_METHOD(HttpRequest
, addRawPostData
)
1335 char *raw_data
, *new_data
;
1337 getObject(http_request_object
, obj
);
1339 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1344 zval
*zdata_p
, *zdata
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &zdata_p
);
1346 new_data
= emalloc(Z_STRLEN_P(zdata
) + data_len
+ 1);
1347 new_data
[Z_STRLEN_P(zdata
) + data_len
] = '\0';
1349 if (Z_STRLEN_P(zdata
)) {
1350 memcpy(new_data
, Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
));
1353 memcpy(new_data
+ Z_STRLEN_P(zdata
), raw_data
, data_len
);
1354 UPD_STRL(obj
, rawPostData
, new_data
, Z_STRLEN_P(zdata
) + data_len
);
1357 zval_ptr_dtor(&zdata_p
);
1365 /* {{{ proto string HttpRequest::getRawPostData()
1367 * Get previously set raw post data.
1369 * Returns a string containing the currently set raw post data.
1371 PHP_METHOD(HttpRequest
, getRawPostData
)
1376 getObject(http_request_object
, obj
);
1377 zval
*raw_data_p
, *raw_data
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, rawPostData
), &raw_data_p
);
1379 RETVAL_ZVAL(raw_data
, 1, 0);
1382 zval_ptr_dtor(&raw_data_p
);
1388 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1390 * Add a file to the POST request, leaving prefiously set files unchanged.
1391 * Affects only POST and custom requests. Cannot be used with raw post data.
1393 * Expects a string parameter containing the form element name, and a string
1394 * paremeter containing the path to the file which should be uploaded.
1395 * Additionally accepts an optional string parameter which chould contain
1396 * the content type of the file.
1398 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1399 * primary and a secondary content type part.
1401 PHP_METHOD(HttpRequest
, addPostFile
)
1403 zval
*files
, *entry
;
1404 char *name
, *file
, *type
= NULL
;
1405 int name_len
, file_len
, type_len
= 0;
1406 getObject(http_request_object
, obj
);
1408 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1413 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1415 type
= "application/x-octetstream";
1416 type_len
= sizeof("application/x-octetstream") - 1;
1419 MAKE_STD_ZVAL(entry
);
1422 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1423 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1424 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1426 files
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1427 add_next_index_zval(files
, entry
);
1433 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1435 * Set files to post, overwriting previously set post files.
1436 * Affects only POST and requests. Cannot be used with raw post data.
1438 * Accepts an array containing the files to post. Each entry should be an
1439 * associative array with "name", "file" and "type" keys. If the parameter
1440 * is empty or omitted the post files will be unset.
1442 * Returns TRUE on success, or FALSE on failure.
1444 PHP_METHOD(HttpRequest
, setPostFiles
)
1446 zval
*files
, *pFiles
;
1447 getObject(http_request_object
, obj
);
1449 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &files
)) {
1453 pFiles
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, postFiles
));
1456 zend_hash_clean(Z_ARRVAL_P(pFiles
));
1457 if (files
&& zend_hash_num_elements(Z_ARRVAL_P(files
))) {
1458 array_copy(files
, pFiles
);
1460 SET_PROP(obj
, postFiles
, pFiles
);
1466 /* {{{ proto array HttpRequest::getPostFiles()
1468 * Get all previously added POST files.
1470 * Returns an array containing currently set post files.
1472 PHP_METHOD(HttpRequest
, getPostFiles
)
1477 getObject(http_request_object
, obj
);
1478 zval
*files_p
, *files
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, postFiles
), &files_p
);
1480 array_init(return_value
);
1481 array_copy(files
, return_value
);
1484 zval_ptr_dtor(&files_p
);
1490 /* {{{ proto bool HttpRequest::setPutFile([string file])
1492 * Set file to put. Affects only PUT requests.
1494 * Accepts a string as parameter referencing the path to file.
1495 * If the parameter is empty or omitted the put file will be unset.
1497 * Returns TRUE on success, or FALSE on failure.
1499 PHP_METHOD(HttpRequest
, setPutFile
)
1503 getObject(http_request_object
, obj
);
1505 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1509 UPD_STRL(obj
, putFile
, file
, file_len
);
1514 /* {{{ proto string HttpRequest::getPutFile()
1516 * Get previously set put file.
1518 * Returns a string containing the path to the currently set put file.
1520 PHP_METHOD(HttpRequest
, getPutFile
)
1525 getObject(http_request_object
, obj
);
1526 zval
*putfile_p
, *putfile
= convert_to_type_ex(IS_STRING
, GET_PROP(obj
, putFile
), &putfile_p
);
1528 RETVAL_ZVAL(putfile
, 1, 0);
1531 zval_ptr_dtor(&putfile_p
);
1537 /* {{{ proto array HttpRequest::getResponseData()
1539 * Get all response data after the request has been sent.
1541 * Returns an associative array with the key "headers" containing an associative
1542 * array holding all response headers, as well as the ley "body" containing a
1543 * string with the response body.
1545 * If redirects were allowed and several responses were received, the data
1546 * references the last received response.
1548 PHP_METHOD(HttpRequest
, getResponseData
)
1553 getObject(http_request_object
, obj
);
1554 zval
*data_p
, *data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
), &data_p
);
1556 array_init(return_value
);
1557 array_copy(data
, return_value
);
1560 zval_ptr_dtor(&data_p
);
1566 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1568 * Get response header(s) after the request has been sent.
1570 * Accepts an string as optional parameter specifying a certain header to read.
1571 * If the parameter is empty or omitted all response headers will be returned.
1573 * Returns either a string with the value of the header matching name if requested,
1574 * FALSE on failure, or an associative array containing all reponse headers.
1576 * If redirects were allowed and several responses were received, the data
1577 * references the last received response.
1579 PHP_METHOD(HttpRequest
, getResponseHeader
)
1582 zval
*data_p
, *data
, **headers
, **header
;
1583 char *header_name
= NULL
;
1585 getObject(http_request_object
, obj
);
1587 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1591 data
= convert_to_type_ex(IS_ARRAY
, GET_PROP(obj
, responseData
), &data_p
);
1592 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1593 convert_to_array(*headers
);
1594 if (!header_len
|| !header_name
) {
1595 array_init(return_value
);
1596 array_copy(*headers
, return_value
);
1597 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1598 RETVAL_ZVAL(*header
, 1, 0);
1607 zval_ptr_dtor(&data_p
);
1613 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1615 * Get response cookie(s) after the request has been sent.
1617 * Accepts a string as optional parameter specifying the name of the cookie to read.
1618 * If the parameter is empty or omitted, an associative array with all received
1619 * cookies will be returned.
1621 * Returns either an associative array with the cookie's name, value and any
1622 * additional params of the cookie matching name if requested, FALSE on failure,
1623 * or an array containing all received cookies as arrays.
1625 * If redirects were allowed and several responses were received, the data
1626 * references the last received response.
1628 PHP_METHOD(HttpRequest
, getResponseCookie
)
1631 zval
*data
, **headers
;
1632 char *cookie_name
= NULL
;
1634 getObject(http_request_object
, obj
);
1636 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1640 array_init(return_value
);
1642 data
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
));
1643 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1646 zval
**header
= NULL
;
1649 convert_to_array(*headers
);
1650 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1651 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1652 /* several cookies? */
1653 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1657 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1659 MAKE_STD_ZVAL(cookie_hash
);
1660 array_init(cookie_hash
);
1662 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1664 add_next_index_zval(return_value
, cookie_hash
);
1668 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1669 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1670 add_next_index_zval(return_value
, cookie_hash
);
1671 return; /* <<< FOUND >>> */
1673 zval_dtor(cookie_hash
);
1678 zval_dtor(cookie_hash
);
1685 MAKE_STD_ZVAL(cookie_hash
);
1686 array_init(cookie_hash
);
1687 convert_to_string_ex(header
);
1689 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1691 add_next_index_zval(return_value
, cookie_hash
);
1695 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1696 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1697 add_next_index_zval(return_value
, cookie_hash
);
1699 zval_dtor(cookie_hash
);
1704 zval_dtor(cookie_hash
);
1718 /* {{{ proto string HttpRequest::getResponseBody()
1720 * Get the response body after the request has been sent.
1722 * Returns a string containing the response body.
1724 * If redirects were allowed and several responses were received, the data
1725 * references the last received response.
1727 PHP_METHOD(HttpRequest
, getResponseBody
)
1733 getObject(http_request_object
, obj
);
1734 zval
*data
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseData
));
1736 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
)) {
1737 RETURN_ZVAL(*body
, 1, 0);
1745 /* {{{ proto int HttpRequest::getResponseCode()
1747 * Get the response code after the request has been sent.
1749 * Returns an int representing the response code.
1751 * If redirects were allowed and several responses were received, the data
1752 * references the last received response.
1754 PHP_METHOD(HttpRequest
, getResponseCode
)
1759 getObject(http_request_object
, obj
);
1760 zval
*code_p
, *code
= convert_to_type_ex(IS_LONG
, GET_PROP(obj
, responseCode
), &code_p
);
1762 RETVAL_ZVAL(code
, 1, 0);
1765 zval_ptr_dtor(&code_p
);
1771 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1773 * Get response info after the request has been sent.
1774 * See http_get() for a full list of returned info.
1776 * Accepts a string as optional parameter specifying the info to read.
1777 * If the parameter is empty or omitted, an associative array containing
1778 * all available info will be returned.
1780 * Returns either a scalar containing the value of the info matching name if
1781 * requested, FALSE on failure, or an associative array containing all
1784 * If redirects were allowed and several responses were received, the data
1785 * references the last received response.
1787 PHP_METHOD(HttpRequest
, getResponseInfo
)
1790 zval
*info
, **infop
;
1791 char *info_name
= NULL
;
1793 getObject(http_request_object
, obj
);
1795 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1799 info
= convert_to_type(IS_ARRAY
, GET_PROP(obj
, responseInfo
));
1801 if (info_len
&& info_name
) {
1802 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1803 RETURN_ZVAL(*infop
, 1, 0);
1805 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1809 array_init(return_value
);
1810 array_copy(info
, return_value
);
1816 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1818 * Get the full response as HttpMessage object after the request has been sent.
1820 * Returns an HttpMessage object of the response.
1822 * If redirects were allowed and several responses were received, the data
1823 * references the last received response. Use HttpMessage::getParentMessage()
1824 * to access the data of previously received responses whithin this request
1827 * Throws HttpException.
1829 PHP_METHOD(HttpRequest
, getResponseMessage
)
1835 getObject(http_request_object
, obj
);
1837 SET_EH_THROW_HTTP();
1838 message
= GET_PROP(obj
, responseMessage
);
1839 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1840 RETVAL_OBJECT(message
);
1849 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1851 * Get sent HTTP message.
1853 * Returns an HttpMessage object representing the sent request.
1855 * If redirects were allowed and several responses were received, the data
1856 * references the last received response. Use HttpMessage::getParentMessage()
1857 * to access the data of previously sent requests whithin this request
1860 * Note that the internal request message is immutable, that means that the
1861 * request message received through HttpRequest::getRequestMessage() will
1862 * always look the same for the same request, regardless of any changes you
1863 * may have made to the returned object.
1865 * Throws HttpMalformedHeadersException, HttpEncodingException.
1867 PHP_METHOD(HttpRequest
, getRequestMessage
)
1873 getObject(http_request_object
, obj
);
1875 SET_EH_THROW_HTTP();
1876 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1877 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1884 /* {{{ proto HttpMessage HttpRequest::getHistory()
1886 * Get all sent requests and received responses as an HttpMessage object.
1888 * If you don't want to record history at all, set the instance variable
1889 * HttpRequest::$recoedHistory to FALSE.
1891 * Returns an HttpMessage object representing the complete request/response
1894 * The object references the last received response, use HttpMessage::getParentMessage()
1895 * to access the data of previously sent requests and received responses.
1897 * Note that the internal history is immutable, that means that any changes
1898 * you make the the message list won't affect a history message list newly
1899 * created by another call to HttpRequest::getHistory().
1901 * Throws HttpMalformedHeaderException, HttpEncodingException.
1903 PHP_METHOD(HttpRequest
, getHistory
)
1909 getObject(http_request_object
, obj
);
1911 SET_EH_THROW_HTTP();
1912 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1913 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1920 /* {{{ proto void HttpRequest::clearHistory()
1922 * Clear the history.
1924 PHP_METHOD(HttpRequest
, clearHistory
)
1927 getObject(http_request_object
, obj
);
1928 phpstr_dtor(&obj
->history
);
1933 /* {{{ proto HttpMessage HttpRequest::send()
1935 * Send the HTTP request.
1937 * Returns the received response as HttpMessage object.
1939 * NOTE: While an exception may be thrown, the transfer could have succeeded
1940 * at least partially, so you might want to check the return values of various
1941 * HttpRequest::getResponse*() methods.
1943 * Throws HttpRuntimeException, HttpRequestException,
1944 * HttpMalformedHeaderException, HttpEncodingException.
1949 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1950 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1951 * $r->addQueryData(array('category' => 3));
1954 * if ($r->getResponseCode() == 200) {
1955 * file_put_contents('local.rss', $r->getResponseBody());
1957 * } catch (HttpException $ex) {
1966 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
1967 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1968 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1969 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1971 * echo $r->send()->getBody();
1972 * } catch (HttpException $ex) {
1978 PHP_METHOD(HttpRequest
, send
)
1980 getObject(http_request_object
, obj
);
1984 SET_EH_THROW_HTTP();
1987 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1994 if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
1995 http_request_exec(obj
->request
);
1996 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
1997 RETVAL_OBJECT(GET_PROP(obj
, responseMessage
));
2005 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2012 * vim600: noet sw=4 ts=4 fdm=marker
2013 * vim<600: noet sw=4 ts=4