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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
19 #define HTTP_WANT_CURL
22 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
24 #include "zend_interfaces.h"
26 #include "php_http_api.h"
27 #include "php_http_exception_object.h"
28 #include "php_http_message_api.h"
29 #include "php_http_message_object.h"
30 #include "php_http_request_api.h"
31 #include "php_http_request_object.h"
32 #include "php_http_request_pool_api.h"
33 #include "php_http_url_api.h"
35 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
36 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
37 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
38 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
40 HTTP_BEGIN_ARGS(__construct
, 0, 0)
42 HTTP_ARG_VAL(method
, 0)
43 HTTP_ARG_VAL(options
, 0)
46 HTTP_EMPTY_ARGS(getOptions
, 0);
47 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
48 HTTP_ARG_VAL(options
, 0)
51 HTTP_EMPTY_ARGS(getSslOptions
, 0);
52 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
53 HTTP_ARG_VAL(ssl_options
, 0)
56 HTTP_BEGIN_ARGS(addSslOptions
, 0, 0)
57 HTTP_ARG_VAL(ssl_optins
, 0)
60 HTTP_EMPTY_ARGS(getHeaders
, 0);
61 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
62 HTTP_ARG_VAL(headers
, 0)
65 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
66 HTTP_ARG_VAL(headers
, 0)
69 HTTP_EMPTY_ARGS(getCookies
, 0);
70 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
71 HTTP_ARG_VAL(cookies
, 0)
74 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
75 HTTP_ARG_VAL(cookies
, 0)
78 HTTP_EMPTY_ARGS(getUrl
, 0);
79 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
83 HTTP_EMPTY_ARGS(getMethod
, 0);
84 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
85 HTTP_ARG_VAL(request_method
, 0)
88 HTTP_EMPTY_ARGS(getContentType
, 0);
89 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
90 HTTP_ARG_VAL(content_type
, 0)
93 HTTP_EMPTY_ARGS(getQueryData
, 0);
94 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
95 HTTP_ARG_VAL(query_data
, 0)
98 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
99 HTTP_ARG_VAL(query_data
, 0)
102 HTTP_EMPTY_ARGS(getPostFields
, 0);
103 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
104 HTTP_ARG_VAL(post_fields
, 0)
107 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
108 HTTP_ARG_VAL(post_fields
, 0)
111 HTTP_EMPTY_ARGS(getPostFiles
, 0);
112 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
113 HTTP_ARG_VAL(post_files
, 0)
116 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
117 HTTP_ARG_VAL(formname
, 0)
118 HTTP_ARG_VAL(filename
, 0)
119 HTTP_ARG_VAL(content_type
, 0)
122 HTTP_EMPTY_ARGS(getRawPostData
, 0);
123 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
124 HTTP_ARG_VAL(raw_post_data
, 0)
127 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
128 HTTP_ARG_VAL(raw_post_data
, 0)
131 HTTP_EMPTY_ARGS(getPutFile
, 0);
132 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
133 HTTP_ARG_VAL(filename
, 0)
136 HTTP_EMPTY_ARGS(getResponseData
, 0);
137 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
138 HTTP_ARG_VAL(name
, 0)
141 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
142 HTTP_ARG_VAL(name
, 0)
145 HTTP_EMPTY_ARGS(getResponseBody
, 0);
146 HTTP_EMPTY_ARGS(getResponseCode
, 0);
147 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
148 HTTP_ARG_VAL(name
, 0)
151 HTTP_EMPTY_ARGS(getResponseMessage
, 0);
152 HTTP_EMPTY_ARGS(getRawResponseMessage
, 0);
153 HTTP_EMPTY_ARGS(getRequestMessage
, 0);
154 HTTP_EMPTY_ARGS(getRawRequestMessage
, 0);
155 HTTP_EMPTY_ARGS(getHistory
, 0);
156 HTTP_EMPTY_ARGS(clearHistory
, 0);
157 HTTP_EMPTY_ARGS(send
, 0);
159 HTTP_BEGIN_ARGS(get
, 0, 1)
161 HTTP_ARG_VAL(options
, 0)
162 HTTP_ARG_VAL(info
, 1)
165 HTTP_BEGIN_ARGS(head
, 0, 1)
167 HTTP_ARG_VAL(options
, 0)
168 HTTP_ARG_VAL(info
, 1)
171 HTTP_BEGIN_ARGS(postData
, 0, 2)
173 HTTP_ARG_VAL(data
, 0)
174 HTTP_ARG_VAL(options
, 0)
175 HTTP_ARG_VAL(info
, 1)
178 HTTP_BEGIN_ARGS(postFields
, 0, 2)
180 HTTP_ARG_VAL(data
, 0)
181 HTTP_ARG_VAL(options
, 0)
182 HTTP_ARG_VAL(info
, 1)
185 HTTP_BEGIN_ARGS(putFile
, 0, 2)
187 HTTP_ARG_VAL(file
, 0)
188 HTTP_ARG_VAL(options
, 0)
189 HTTP_ARG_VAL(info
, 1)
192 HTTP_BEGIN_ARGS(putStream
, 0, 2)
194 HTTP_ARG_VAL(stream
, 0)
195 HTTP_ARG_VAL(options
, 0)
196 HTTP_ARG_VAL(info
, 1)
199 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
200 HTTP_ARG_VAL(method_name
, 0)
203 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
204 HTTP_ARG_VAL(method
, 0)
207 HTTP_BEGIN_ARGS(methodName
, 0, 1)
208 HTTP_ARG_VAL(method_id
, 0)
211 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
212 HTTP_ARG_VAL(method
, 0)
215 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
216 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
218 #define OBJ_PROP_CE http_request_object_ce
219 zend_class_entry
*http_request_object_ce
;
220 zend_function_entry http_request_object_fe
[] = {
221 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
223 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
224 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
225 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
226 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
227 HTTP_REQUEST_ME(addSslOptions
, ZEND_ACC_PUBLIC
)
229 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
230 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
231 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
234 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
235 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
237 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
238 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
240 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
241 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
243 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
260 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
262 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
276 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
277 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
278 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
280 HTTP_REQUEST_ALIAS(get
, http_get
)
281 HTTP_REQUEST_ALIAS(head
, http_head
)
282 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
283 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
284 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
285 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
287 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
288 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
289 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
290 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
294 static zend_object_handlers http_request_object_handlers
;
296 PHP_MINIT_FUNCTION(http_request_object
)
298 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
299 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
303 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
305 return http_request_object_new_ex(ce
, curl_easy_init(), NULL
);
308 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
310 zend_object_value ov
;
311 http_request_object
*o
;
313 o
= ecalloc(1, sizeof(http_request_object
));
315 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
316 phpstr_init(&o
->history
);
322 ALLOC_HASHTABLE(OBJ_PROP(o
));
323 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
324 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
326 ov
.handle
= putObject(http_request_object
, o
);
327 ov
.handlers
= &http_request_object_handlers
;
332 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
335 zend_object_value new_ov
;
336 http_request_object
*new_obj
;
337 getObject(http_request_object
, old_obj
);
339 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
340 new_ov
= http_request_object_new_ex(old_zo
->ce
, curl_easy_duphandle(old_obj
->request
->ch
), &new_obj
);
342 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
343 phpstr_append(&new_obj
->history
, old_obj
->history
.data
, old_obj
->history
.used
);
344 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
345 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
350 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
352 zend_class_entry
*ce
= http_request_object_ce
;
354 DCL_PROP_N(PRIVATE
, options
);
355 DCL_PROP_N(PRIVATE
, postFields
);
356 DCL_PROP_N(PRIVATE
, postFiles
);
357 DCL_PROP_N(PRIVATE
, responseInfo
);
358 DCL_PROP_N(PRIVATE
, responseData
);
359 DCL_PROP_N(PRIVATE
, responseMessage
);
360 DCL_PROP(PRIVATE
, long, responseCode
, 0);
361 DCL_PROP(PRIVATE
, long, method
, HTTP_GET
);
362 DCL_PROP(PRIVATE
, string
, url
, "");
363 DCL_PROP(PRIVATE
, string
, contentType
, "");
364 DCL_PROP(PRIVATE
, string
, rawPostData
, "");
365 DCL_PROP(PRIVATE
, string
, queryData
, "");
366 DCL_PROP(PRIVATE
, 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
);
406 /* cURL HTTP protocol versions */
407 DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0
);
408 DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1
);
409 DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE
);
414 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
415 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
416 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
417 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
421 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
423 http_request_object
*o
= (http_request_object
*) object
;
426 zend_hash_destroy(OBJ_PROP(o
));
427 FREE_HASHTABLE(OBJ_PROP(o
));
429 http_request_free(&o
->request
);
430 phpstr_dtor(&o
->history
);
434 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
436 STATUS status
= SUCCESS
;
438 http_request_reset(obj
->request
);
439 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, curl_easy_init(), return FAILURE
);
441 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(url
)));
443 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(method
)))
451 php_stream_statbuf ssb
;
452 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
454 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
455 obj
->request
->body
= 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
= GET_PROP(rawPostData
);
468 if (Z_STRLEN_P(raw_data
)) {
469 zval
*ctype
= GET_PROP(contentType
);
471 if (Z_STRLEN_P(ctype
)) {
472 zval
**headers
, *opts
= GET_PROP(options
);
474 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
475 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) &&
476 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
479 /* only override if not already set */
480 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) && (Z_TYPE_PP(ct_header
) == IS_STRING
)) {
481 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
486 MAKE_STD_ZVAL(headers
);
488 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
489 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, headers
);
490 zval_ptr_dtor(&headers
);
494 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
495 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
498 zval
*zfields
= GET_PROP(postFields
), *zfiles
= GET_PROP(postFiles
);
502 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
503 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
505 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
513 if (status
== SUCCESS
) {
514 zval
*qdata
= GET_PROP(queryData
);
515 zval
*options
= GET_PROP(options
);
517 if (Z_STRLEN_P(qdata
)) {
518 if (!strchr(obj
->request
->url
, '?')) {
519 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
521 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
523 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
526 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
528 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
529 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onprogress", sizeof("onprogress"))) {
532 if ( (Z_TYPE_P(options
) != IS_ARRAY
)
533 || (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(options
), "onprogress", sizeof("onprogress"), (void **) &entry
)
534 || (!zval_is_true(*entry
)))) {
537 ZVAL_ADDREF(getThis());
538 add_next_index_zval(pcb
, getThis());
539 add_next_index_stringl(pcb
, "onprogress", lenof("onprogress"), 1);
540 http_request_set_progress_callback(obj
->request
, pcb
);
549 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
553 phpstr_fix(&obj
->request
->conv
.request
);
554 phpstr_fix(&obj
->request
->conv
.response
);
556 msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
563 zval
*headers
, *message
, *resp
, *info
;
565 if (zval_is_true(GET_PROP(recordHistory
))) {
566 /* we need to act like a zipper, as we'll receive
567 * the requests and the responses in separate chains
570 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
571 http_message
*free_msg
= request
;
577 http_message_tostring(response
, &message
, &msglen
);
578 phpstr_append(&obj
->history
, message
, msglen
);
581 http_message_tostring(request
, &message
, &msglen
);
582 phpstr_append(&obj
->history
, message
, msglen
);
585 } while ((response
= response
->parent
) && (request
= request
->parent
));
587 http_message_free(&free_msg
);
588 phpstr_fix(&obj
->history
);
591 UPD_PROP(long, responseCode
, msg
->http
.info
.response
.code
);
595 MAKE_STD_ZVAL(headers
);
597 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
598 add_assoc_zval(resp
, "headers", headers
);
599 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
600 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
601 SET_PROP(responseData
, resp
);
602 zval_ptr_dtor(&resp
);
604 MAKE_STD_ZVAL(message
);
605 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
606 SET_PROP(responseMessage
, message
);
607 zval_ptr_dtor(&message
);
611 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
612 SET_PROP(responseInfo
, info
);
613 zval_ptr_dtor(&info
);
615 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onfinish", sizeof("onfinish"))) {
616 zend_call_method_with_0_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "onfinish", NULL
);
623 #define http_request_object_set_options_subr(key, ow) \
624 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
625 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
627 zval
*old_opts
, *new_opts
, *opts
, **entry
;
628 getObject(http_request_object
, obj
);
630 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
634 MAKE_STD_ZVAL(new_opts
);
635 array_init(new_opts
);
636 old_opts
= GET_PROP(options
);
637 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
638 array_copy(old_opts
, new_opts
);
641 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void **) &entry
)) {
643 zend_hash_clean(Z_ARRVAL_PP(entry
));
645 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
647 array_copy(opts
, *entry
);
649 array_merge(opts
, *entry
);
654 add_assoc_zval(new_opts
, key
, opts
);
656 SET_PROP(options
, new_opts
);
657 zval_ptr_dtor(&new_opts
);
662 #define http_request_object_get_options_subr(key) \
663 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
664 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
669 zval
*opts
, **options
;
670 getObject(http_request_object
, obj
);
672 opts
= GET_PROP(options
);
674 array_init(return_value
);
676 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
677 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
))) {
678 convert_to_array(*options
);
679 array_copy(*options
, return_value
);
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
)) {
709 UPD_STRL(url
, URL
, URL_len
);
712 UPD_PROP(long, method
, meth
);
715 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
722 /* {{{ proto bool HttpRequest::setOptions([array options])
724 * Set the request options to use. See http_get() for a full list of available options.
726 * Accepts an array as optional parameters, wich values will overwrite the
727 * currently set request options. If the parameter is empty or mitted,
728 * the optoions of the HttpRequest object will be reset.
730 * Returns TRUE on success, or FALSE on failure.
732 PHP_METHOD(HttpRequest
, setOptions
)
737 zval
*opts
= NULL
, *old_opts
, *new_opts
, *add_opts
, **opt
;
738 getObject(http_request_object
, obj
);
740 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
744 MAKE_STD_ZVAL(new_opts
);
745 array_init(new_opts
);
747 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
748 SET_PROP(options
, new_opts
);
749 zval_ptr_dtor(&new_opts
);
753 MAKE_STD_ZVAL(add_opts
);
754 array_init(add_opts
);
755 /* some options need extra attention -- thus cannot use array_merge() directly */
756 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
758 if (!strcmp(key
, "headers")) {
759 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, *opt
);
760 } else if (!strcmp(key
, "cookies")) {
761 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addcookies", NULL
, *opt
);
762 } else if (!strcmp(key
, "ssl")) {
763 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addssloptions", NULL
, *opt
);
764 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
765 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "seturl", NULL
, *opt
);
766 } else if (!strcmp(key
, "method")) {
767 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setmethod", NULL
, *opt
);
770 add_assoc_zval(add_opts
, key
, *opt
);
777 old_opts
= GET_PROP(options
);
778 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
779 array_copy(old_opts
, new_opts
);
781 array_merge(add_opts
, new_opts
);
782 SET_PROP(options
, new_opts
);
783 zval_ptr_dtor(&new_opts
);
784 zval_ptr_dtor(&add_opts
);
790 /* {{{ proto array HttpRequest::getOptions()
792 * Get currently set options.
794 * Returns an associative array containing currently set options.
796 PHP_METHOD(HttpRequest
, getOptions
)
801 RETURN_PROP(options
);
806 /* {{{ proto bool HttpRequest::setSslOptions([array options])
810 * Accepts an associative array as parameter containing any SSL specific options.
811 * If the parameter is empty or omitted, the SSL options will be reset.
813 * Returns TRUE on success, or FALSE on failure.
815 PHP_METHOD(HttpRequest
, setSslOptions
)
817 http_request_object_set_options_subr("ssl", 1);
821 /* {{{ proto bool HttpRequest::addSslOptions(array options)
823 * Set additional SSL options.
825 * Expects an associative array as parameter containing additional SSL specific options.
827 * Returns TRUE on success, or FALSE on failure.
829 PHP_METHOD(HttpRequest
, addSslOptions
)
831 http_request_object_set_options_subr("ssl", 0);
835 /* {{{ proto array HttpRequest::getSslOtpions()
837 * Get previously set SSL options.
839 * Returns an associative array containing any previously set SSL options.
841 PHP_METHOD(HttpRequest
, getSslOptions
)
843 http_request_object_get_options_subr("ssl");
847 /* {{{ proto bool HttpRequest::addHeaders(array headers)
849 * Add request header name/value pairs.
851 * Expects an ssociative array as parameter containing additional header
854 * Returns TRUE on success, or FALSE on failure.
856 PHP_METHOD(HttpRequest
, addHeaders
)
858 http_request_object_set_options_subr("headers", 0);
861 /* {{{ proto bool HttpRequest::setHeaders([array headers])
863 * Set request header name/value pairs.
865 * Accepts an associative array as parameter containing header name/value pairs.
866 * If the parameter is empty or omitted, all previously set headers will be unset.
868 * Returns TRUE on success, or FALSE on failure.
870 PHP_METHOD(HttpRequest
, setHeaders
)
872 http_request_object_set_options_subr("headers", 1);
876 /* {{{ proto array HttpRequest::getHeaders()
878 * Get previously set request headers.
880 * Returns an associative array containing all currently set headers.
882 PHP_METHOD(HttpRequest
, getHeaders
)
884 http_request_object_get_options_subr("headers");
888 /* {{{ proto bool HttpRequest::setCookies([array cookies])
892 * Accepts an associative array as parameter containing cookie name/value pairs.
893 * If the parameter is empty or omitted, all previously set cookies will be unset.
895 * Returns TRUE on success, or FALSE on failure.
897 PHP_METHOD(HttpRequest
, setCookies
)
899 http_request_object_set_options_subr("cookies", 1);
903 /* {{{ proto bool HttpRequest::addCookies(array cookies)
907 * Expects an associative array as parameter containing any cookie name/value
910 * Returns TRUE on success, or FALSE on failure.
912 PHP_METHOD(HttpRequest
, addCookies
)
914 http_request_object_set_options_subr("cookies", 0);
918 /* {{{ proto array HttpRequest::getCookies()
920 * Get previously set cookies.
922 * Returns an associative array containing any previously set cookies.
924 PHP_METHOD(HttpRequest
, getCookies
)
926 http_request_object_get_options_subr("cookies");
930 /* {{{ proto bool HttpRequest::setUrl(string url)
932 * Set the request URL.
934 * Expects a string as parameter specifying the request url.
936 * Returns TRUE on success, or FALSE on failure.
938 PHP_METHOD(HttpRequest
, setUrl
)
942 getObject(http_request_object
, obj
);
944 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
948 UPD_STRL(url
, URL
, URL_len
);
953 /* {{{ proto string HttpRequest::getUrl()
955 * Get the previously set request URL.
957 * Returns the currently set request url as string.
959 PHP_METHOD(HttpRequest
, getUrl
)
969 /* {{{ proto bool HttpRequest::setMethod(int request_method)
971 * Set the request method.
973 * Expects an int as parameter specifying the request method to use.
974 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
976 * Returns TRUE on success, or FALSE on failure.
978 PHP_METHOD(HttpRequest
, setMethod
)
981 getObject(http_request_object
, obj
);
983 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
987 UPD_PROP(long, method
, meth
);
992 /* {{{ proto int HttpRequest::getMethod()
994 * Get the previously set request method.
996 * Returns the currently set request method.
998 PHP_METHOD(HttpRequest
, getMethod
)
1003 RETURN_PROP(method
);
1008 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1010 * Set the content type the post request should have.
1012 * Expects a string as parameters containing the content type of the request
1013 * (primary/secondary).
1015 * Returns TRUE on success, or FALSE if the content type does not seem to
1016 * contain a primary and a secondary part.
1018 PHP_METHOD(HttpRequest
, setContentType
)
1022 getObject(http_request_object
, obj
);
1024 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1028 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1029 UPD_STRL(contentType
, ctype
, ct_len
);
1034 /* {{{ proto string HttpRequest::getContentType()
1036 * Get the previously content type.
1038 * Returns the previously set content type as string.
1040 PHP_METHOD(HttpRequest
, getContentType
)
1045 RETURN_PROP(contentType
);
1050 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1052 * Set the URL query parameters to use, overwriting previously set query parameters.
1053 * Affects any request types.
1055 * Accepts a string or associative array parameter containing the pre-encoded
1056 * query string or to be encoded query fields. If the parameter is empty or
1057 * omitted, the query data will be unset.
1059 * Returns TRUE on success, or FALSE on failure.
1061 PHP_METHOD(HttpRequest
, setQueryData
)
1064 getObject(http_request_object
, obj
);
1066 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1070 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1071 UPD_STRL(queryData
, "", 0);
1072 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1073 char *query_data
= NULL
;
1075 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1079 UPD_PROP(string
, queryData
, query_data
);
1084 convert_to_string_ex(&qdata
);
1085 UPD_STRL(queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1086 if (orig
!= qdata
) {
1087 zval_ptr_dtor(&qdata
);
1094 /* {{{ proto string HttpRequest::getQueryData()
1096 * Get the current query data in form of an urlencoded query string.
1098 * Returns a string containing the urlencoded query.
1100 PHP_METHOD(HttpRequest
, getQueryData
)
1105 RETURN_PROP(queryData
);
1110 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1112 * Add parameters to the query parameter list, leaving previously set unchanged.
1113 * Affects any request type.
1115 * Expects an associative array as parameter containing the query fields to add.
1117 * Returns TRUE on success, or FALSE on failure.
1119 PHP_METHOD(HttpRequest
, addQueryData
)
1121 zval
*qdata
, *old_qdata
;
1122 char *query_data
= NULL
;
1123 size_t query_data_len
= 0;
1124 getObject(http_request_object
, obj
);
1126 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1130 old_qdata
= GET_PROP(queryData
);
1132 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
)) {
1136 UPD_STRL(queryData
, query_data
, query_data_len
);
1143 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1145 * Adds POST data entries, leaving previously set unchanged, unless a
1146 * post entry with the same name already exists.
1147 * Affects only POST and custom requests.
1149 * Expects an associative array as parameter containing the post fields.
1151 * Returns TRUE on success, or FALSE on failure.
1153 PHP_METHOD(HttpRequest
, addPostFields
)
1155 zval
*post_data
, *old_post
, *new_post
;
1156 getObject(http_request_object
, obj
);
1158 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1162 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1163 MAKE_STD_ZVAL(new_post
);
1164 array_init(new_post
);
1165 old_post
= GET_PROP(postFields
);
1166 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1167 array_copy(old_post
, new_post
);
1169 array_merge(post_data
, new_post
);
1170 SET_PROP(postFields
, new_post
);
1171 zval_ptr_dtor(&new_post
);
1178 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1180 * Set the POST data entries, overwriting previously set POST data.
1181 * Affects only POST and custom requests.
1183 * Accepts an associative array as parameter containing the post fields.
1184 * If the parameter is empty or omitted, the post data will be unset.
1186 * Returns TRUE on success, or FALSE on failure.
1188 PHP_METHOD(HttpRequest
, setPostFields
)
1190 zval
*post
, *post_data
= NULL
;
1191 getObject(http_request_object
, obj
);
1193 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/!", &post_data
)) {
1197 MAKE_STD_ZVAL(post
);
1199 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1200 array_copy(post_data
, post
);
1202 SET_PROP(postFields
, post
);
1203 zval_ptr_dtor(&post
);
1209 /* {{{ proto array HttpRequest::getPostFields()
1211 * Get previously set POST data.
1213 * Returns the currently set post fields as associative array.
1215 PHP_METHOD(HttpRequest
, getPostFields
)
1220 RETURN_PROP(postFields
);
1225 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1227 * Set raw post data to send, overwriting previously set raw post data. Don't
1228 * forget to specify a content type. Affects only POST and custom requests.
1229 * Only either post fields or raw post data can be used for each request.
1230 * Raw post data has higher precedence and will be used even if post fields
1233 * Accepts a string as parameter containing the *raw* post data.
1235 * Returns TRUE on success, or FALSE on failure.
1237 PHP_METHOD(HttpRequest
, setRawPostData
)
1239 char *raw_data
= NULL
;
1241 getObject(http_request_object
, obj
);
1243 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1251 UPD_STRL(rawPostData
, raw_data
, data_len
);
1256 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1258 * Add raw post data, leaving previously set raw post data unchanged.
1259 * Affects only POST and custom requests.
1261 * Expects a string as parameter containing the raw post data to concatenate.
1263 * Returns TRUE on success, or FALSE on failure.
1265 PHP_METHOD(HttpRequest
, addRawPostData
)
1269 getObject(http_request_object
, obj
);
1271 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1276 zval
*data
= zval_copy(IS_STRING
, GET_PROP(rawPostData
));
1278 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1279 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1280 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, raw_data
, data_len
);
1281 SET_PROP(rawPostData
, data
);
1289 /* {{{ proto string HttpRequest::getRawPostData()
1291 * Get previously set raw post data.
1293 * Returns a string containing the currently set raw post data.
1295 PHP_METHOD(HttpRequest
, getRawPostData
)
1300 RETURN_PROP(rawPostData
);
1305 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1307 * Add a file to the POST request, leaving prefiously set files unchanged.
1308 * Affects only POST and custom requests. Cannot be used with raw post data.
1310 * Expects a string parameter containing the form element name, and a string
1311 * paremeter containing the path to the file which should be uploaded.
1312 * Additionally accepts an optional string parameter which chould contain
1313 * the content type of the file.
1315 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1316 * primary and a secondary content type part.
1318 PHP_METHOD(HttpRequest
, addPostFile
)
1320 zval
*entry
, *old_post
, *new_post
;
1321 char *name
, *file
, *type
= NULL
;
1322 int name_len
, file_len
, type_len
= 0;
1323 getObject(http_request_object
, obj
);
1325 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1330 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1332 type
= "application/x-octetstream";
1333 type_len
= sizeof("application/x-octetstream") - 1;
1336 MAKE_STD_ZVAL(entry
);
1339 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1340 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1341 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1343 MAKE_STD_ZVAL(new_post
);
1344 array_init(new_post
);
1345 old_post
= GET_PROP(postFiles
);
1346 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1347 array_copy(old_post
, new_post
);
1349 add_next_index_zval(new_post
, entry
);
1350 SET_PROP(postFiles
, new_post
);
1351 zval_ptr_dtor(&new_post
);
1357 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1359 * Set files to post, overwriting previously set post files.
1360 * Affects only POST and requests. Cannot be used with raw post data.
1362 * Accepts an array containing the files to post. Each entry should be an
1363 * associative array with "name", "file" and "type" keys. If the parameter
1364 * is empty or omitted the post files will be unset.
1366 * Returns TRUE on success, or FALSE on failure.
1368 PHP_METHOD(HttpRequest
, setPostFiles
)
1370 zval
*files
= NULL
, *post
;
1371 getObject(http_request_object
, obj
);
1373 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!/", &files
)) {
1377 MAKE_STD_ZVAL(post
);
1379 if (files
&& (Z_TYPE_P(files
) == IS_ARRAY
)) {
1380 array_copy(files
, post
);
1382 SET_PROP(postFiles
, post
);
1383 zval_ptr_dtor(&post
);
1389 /* {{{ proto array HttpRequest::getPostFiles()
1391 * Get all previously added POST files.
1393 * Returns an array containing currently set post files.
1395 PHP_METHOD(HttpRequest
, getPostFiles
)
1400 RETURN_PROP(postFiles
);
1405 /* {{{ proto bool HttpRequest::setPutFile([string file])
1407 * Set file to put. Affects only PUT requests.
1409 * Accepts a string as parameter referencing the path to file.
1410 * If the parameter is empty or omitted the put file will be unset.
1412 * Returns TRUE on success, or FALSE on failure.
1414 PHP_METHOD(HttpRequest
, setPutFile
)
1418 getObject(http_request_object
, obj
);
1420 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1424 UPD_STRL(putFile
, file
, file_len
);
1429 /* {{{ proto string HttpRequest::getPutFile()
1431 * Get previously set put file.
1433 * Returns a string containing the path to the currently set put file.
1435 PHP_METHOD(HttpRequest
, getPutFile
)
1440 RETURN_PROP(putFile
);
1445 /* {{{ proto array HttpRequest::getResponseData()
1447 * Get all response data after the request has been sent.
1449 * Returns an associative array with the key "headers" containing an associative
1450 * array holding all response headers, as well as the ley "body" containing a
1451 * string with the response body.
1453 * If redirects were allowed and several responses were received, the data
1454 * references the last received response.
1456 PHP_METHOD(HttpRequest
, getResponseData
)
1461 RETURN_PROP(responseData
);
1466 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1468 * Get response header(s) after the request has been sent.
1470 * Accepts an string as optional parameter specifying a certain header to read.
1471 * If the parameter is empty or omitted all response headers will be returned.
1473 * Returns either a string with the value of the header matching name if requested,
1474 * FALSE on failure, or an associative array containing all reponse headers.
1476 * If redirects were allowed and several responses were received, the data
1477 * references the last received response.
1479 PHP_METHOD(HttpRequest
, getResponseHeader
)
1482 zval
*data
, **headers
, **header
;
1483 char *header_name
= NULL
;
1485 getObject(http_request_object
, obj
);
1487 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1491 data
= GET_PROP(responseData
);
1492 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1493 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1494 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1495 if (!header_len
|| !header_name
) {
1496 RETVAL_ZVAL(*headers
, 1, 0);
1497 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1498 RETVAL_ZVAL(*header
, 1, 0);
1509 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1511 * Get response cookie(s) after the request has been sent.
1513 * Accepts a string as optional parameter specifying the name of the cookie to read.
1514 * If the parameter is empty or omitted, an associative array with all received
1515 * cookies will be returned.
1517 * Returns either an associative array with the cookie's name, value and any
1518 * additional params of the cookie matching name if requested, FALSE on failure,
1519 * or an array containing all received cookies as arrays.
1521 * If redirects were allowed and several responses were received, the data
1522 * references the last received response.
1524 PHP_METHOD(HttpRequest
, getResponseCookie
)
1527 zval
*data
, **headers
;
1528 char *cookie_name
= NULL
;
1530 getObject(http_request_object
, obj
);
1532 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1536 array_init(return_value
);
1538 data
= GET_PROP(responseData
);
1539 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1540 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1541 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1544 zval
**header
= NULL
;
1547 convert_to_array(*headers
);
1548 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1549 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1550 /* several cookies? */
1551 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1555 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1557 MAKE_STD_ZVAL(cookie_hash
);
1558 array_init(cookie_hash
);
1560 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1562 add_next_index_zval(return_value
, cookie_hash
);
1566 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1567 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1568 add_next_index_zval(return_value
, cookie_hash
);
1569 return; /* <<< FOUND >>> */
1571 zval_dtor(cookie_hash
);
1576 zval_dtor(cookie_hash
);
1583 MAKE_STD_ZVAL(cookie_hash
);
1584 array_init(cookie_hash
);
1585 convert_to_string_ex(header
);
1587 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1589 add_next_index_zval(return_value
, cookie_hash
);
1593 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1594 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1595 add_next_index_zval(return_value
, cookie_hash
);
1597 zval_dtor(cookie_hash
);
1602 zval_dtor(cookie_hash
);
1616 /* {{{ proto string HttpRequest::getResponseBody()
1618 * Get the response body after the request has been sent.
1620 * Returns a string containing the response body.
1622 * If redirects were allowed and several responses were received, the data
1623 * references the last received response.
1625 PHP_METHOD(HttpRequest
, getResponseBody
)
1631 getObject(http_request_object
, obj
);
1632 zval
*data
= GET_PROP(responseData
);
1634 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1635 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
))) {
1636 RETURN_ZVAL(*body
, 1, 0);
1644 /* {{{ proto int HttpRequest::getResponseCode()
1646 * Get the response code after the request has been sent.
1648 * Returns an int representing the response code.
1650 * If redirects were allowed and several responses were received, the data
1651 * references the last received response.
1653 PHP_METHOD(HttpRequest
, getResponseCode
)
1658 RETURN_PROP(responseCode
);
1663 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1665 * Get response info after the request has been sent.
1666 * See http_get() for a full list of returned info.
1668 * Accepts a string as optional parameter specifying the info to read.
1669 * If the parameter is empty or omitted, an associative array containing
1670 * all available info will be returned.
1672 * Returns either a scalar containing the value of the info matching name if
1673 * requested, FALSE on failure, or an associative array containing all
1676 * If redirects were allowed and several responses were received, the data
1677 * references the last received response.
1679 PHP_METHOD(HttpRequest
, getResponseInfo
)
1682 zval
*info
, **infop
;
1683 char *info_name
= NULL
;
1685 getObject(http_request_object
, obj
);
1687 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1691 info
= GET_PROP(responseInfo
);
1693 if (Z_TYPE_P(info
) != IS_ARRAY
) {
1697 if (info_len
&& info_name
) {
1698 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1699 RETURN_ZVAL(*infop
, 1, 0);
1701 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1705 RETURN_ZVAL(info
, 1, 0);
1711 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1713 * Get the full response as HttpMessage object after the request has been sent.
1715 * Returns an HttpMessage object of the response.
1717 * If redirects were allowed and several responses were received, the data
1718 * references the last received response. Use HttpMessage::getParentMessage()
1719 * to access the data of previously received responses whithin this request
1722 * Throws HttpException.
1724 PHP_METHOD(HttpRequest
, getResponseMessage
)
1730 getObject(http_request_object
, obj
);
1732 SET_EH_THROW_HTTP();
1733 message
= GET_PROP(responseMessage
);
1734 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1735 RETVAL_OBJECT(message
);
1744 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1746 * Get sent HTTP message.
1748 * Returns an HttpMessage object representing the sent request.
1750 * If redirects were allowed and several responses were received, the data
1751 * references the last received response. Use HttpMessage::getParentMessage()
1752 * to access the data of previously sent requests whithin this request
1755 * Note that the internal request message is immutable, that means that the
1756 * request message received through HttpRequest::getRequestMessage() will
1757 * always look the same for the same request, regardless of any changes you
1758 * may have made to the returned object.
1760 * Throws HttpMalformedHeadersException, HttpEncodingException.
1762 PHP_METHOD(HttpRequest
, getRequestMessage
)
1768 getObject(http_request_object
, obj
);
1770 SET_EH_THROW_HTTP();
1771 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1772 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1779 /* {{{ proto string HttpRequest::getRawRequestMessage()
1781 * Get sent HTTP message.
1783 * Returns an HttpMessage in a form of a string
1786 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1791 getObject(http_request_object
, obj
);
1793 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1798 /* {{{ proto string HttpRequest::getRawResponseMessage()
1800 * Get the entire HTTP response.
1802 * Returns the complete web server response, including the headers in a form of a string.
1805 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1810 getObject(http_request_object
, obj
);
1812 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1817 /* {{{ proto HttpMessage HttpRequest::getHistory()
1819 * Get all sent requests and received responses as an HttpMessage object.
1821 * If you don't want to record history at all, set the instance variable
1822 * HttpRequest::$recoedHistory to FALSE.
1824 * Returns an HttpMessage object representing the complete request/response
1827 * The object references the last received response, use HttpMessage::getParentMessage()
1828 * to access the data of previously sent requests and received responses.
1830 * Note that the internal history is immutable, that means that any changes
1831 * you make the the message list won't affect a history message list newly
1832 * created by another call to HttpRequest::getHistory().
1834 * Throws HttpMalformedHeaderException, HttpEncodingException.
1836 PHP_METHOD(HttpRequest
, getHistory
)
1842 getObject(http_request_object
, obj
);
1844 SET_EH_THROW_HTTP();
1845 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1846 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1853 /* {{{ proto void HttpRequest::clearHistory()
1855 * Clear the history.
1857 PHP_METHOD(HttpRequest
, clearHistory
)
1860 getObject(http_request_object
, obj
);
1861 phpstr_dtor(&obj
->history
);
1866 /* {{{ proto HttpMessage HttpRequest::send()
1868 * Send the HTTP request.
1870 * Returns the received response as HttpMessage object.
1872 * NOTE: While an exception may be thrown, the transfer could have succeeded
1873 * at least partially, so you might want to check the return values of various
1874 * HttpRequest::getResponse*() methods.
1876 * Throws HttpRuntimeException, HttpRequestException,
1877 * HttpMalformedHeaderException, HttpEncodingException.
1882 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1883 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1884 * $r->addQueryData(array('category' => 3));
1887 * if ($r->getResponseCode() == 200) {
1888 * file_put_contents('local.rss', $r->getResponseBody());
1890 * } catch (HttpException $ex) {
1899 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
1900 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1901 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1902 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1904 * echo $r->send()->getBody();
1905 * } catch (HttpException $ex) {
1911 PHP_METHOD(HttpRequest
, send
)
1913 getObject(http_request_object
, obj
);
1917 SET_EH_THROW_HTTP();
1922 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1923 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
1924 http_request_exec(obj
->request
);
1925 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
1926 RETVAL_OBJECT(GET_PROP(responseMessage
));
1934 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
1941 * vim600: noet sw=4 ts=4 fdm=marker
1942 * vim<600: noet sw=4 ts=4