2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
19 #define HTTP_WANT_CURL
22 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
24 #include "zend_interfaces.h"
26 #include "php_http_api.h"
27 #include "php_http_exception_object.h"
28 #include "php_http_message_api.h"
29 #include "php_http_message_object.h"
30 #include "php_http_request_api.h"
31 #include "php_http_request_object.h"
32 #include "php_http_request_pool_api.h"
33 #include "php_http_url_api.h"
35 ZEND_EXTERN_MODULE_GLOBALS(http
);
37 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
38 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
39 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
40 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
42 HTTP_EMPTY_ARGS(__destruct
, 0);
43 HTTP_BEGIN_ARGS(__construct
, 0, 0)
45 HTTP_ARG_VAL(method
, 0)
46 HTTP_ARG_VAL(options
, 0)
49 HTTP_EMPTY_ARGS(getOptions
, 0);
50 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
51 HTTP_ARG_VAL(options
, 0)
54 HTTP_EMPTY_ARGS(getSslOptions
, 0);
55 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
56 HTTP_ARG_VAL(ssl_options
, 0)
59 HTTP_EMPTY_ARGS(getHeaders
, 0);
60 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
61 HTTP_ARG_VAL(headers
, 0)
64 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
65 HTTP_ARG_VAL(headers
, 0)
68 HTTP_EMPTY_ARGS(getCookies
, 0);
69 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
70 HTTP_ARG_VAL(cookies
, 0)
73 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
74 HTTP_ARG_VAL(cookies
, 0)
77 HTTP_EMPTY_ARGS(getUrl
, 0);
78 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
82 HTTP_EMPTY_ARGS(getMethod
, 0);
83 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
84 HTTP_ARG_VAL(request_method
, 0)
87 HTTP_EMPTY_ARGS(getContentType
, 0);
88 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
89 HTTP_ARG_VAL(content_type
, 0)
92 HTTP_EMPTY_ARGS(getQueryData
, 0);
93 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
94 HTTP_ARG_VAL(query_data
, 0)
97 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
98 HTTP_ARG_VAL(query_data
, 0)
101 HTTP_EMPTY_ARGS(getPostFields
, 0);
102 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
103 HTTP_ARG_VAL(post_fields
, 0)
106 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
107 HTTP_ARG_VAL(post_fields
, 0)
110 HTTP_EMPTY_ARGS(getPostFiles
, 0);
111 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
112 HTTP_ARG_VAL(post_files
, 0)
115 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
116 HTTP_ARG_VAL(formname
, 0)
117 HTTP_ARG_VAL(filename
, 0)
118 HTTP_ARG_VAL(content_type
, 0)
121 HTTP_EMPTY_ARGS(getRawPostData
, 0);
122 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
123 HTTP_ARG_VAL(raw_post_data
, 0)
126 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
127 HTTP_ARG_VAL(raw_post_data
, 0)
130 HTTP_EMPTY_ARGS(getPutFile
, 0);
131 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
132 HTTP_ARG_VAL(filename
, 0)
135 HTTP_EMPTY_ARGS(getResponseData
, 0);
136 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
137 HTTP_ARG_VAL(name
, 0)
140 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
141 HTTP_ARG_VAL(name
, 0)
144 HTTP_EMPTY_ARGS(getResponseBody
, 0);
145 HTTP_EMPTY_ARGS(getResponseCode
, 0);
146 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
147 HTTP_ARG_VAL(name
, 0)
150 HTTP_EMPTY_ARGS(getResponseMessage
, 0);
151 HTTP_EMPTY_ARGS(getRawResponseMessage
, 0);
152 HTTP_EMPTY_ARGS(getRequestMessage
, 0);
153 HTTP_EMPTY_ARGS(getRawRequestMessage
, 0);
154 HTTP_EMPTY_ARGS(getHistory
, 0);
155 HTTP_EMPTY_ARGS(clearHistory
, 0);
156 HTTP_EMPTY_ARGS(send
, 0);
158 HTTP_BEGIN_ARGS(get
, 0, 1)
160 HTTP_ARG_VAL(options
, 0)
161 HTTP_ARG_VAL(info
, 1)
164 HTTP_BEGIN_ARGS(head
, 0, 1)
166 HTTP_ARG_VAL(options
, 0)
167 HTTP_ARG_VAL(info
, 1)
170 HTTP_BEGIN_ARGS(postData
, 0, 2)
172 HTTP_ARG_VAL(data
, 0)
173 HTTP_ARG_VAL(options
, 0)
174 HTTP_ARG_VAL(info
, 1)
177 HTTP_BEGIN_ARGS(postFields
, 0, 2)
179 HTTP_ARG_VAL(data
, 0)
180 HTTP_ARG_VAL(options
, 0)
181 HTTP_ARG_VAL(info
, 1)
184 HTTP_BEGIN_ARGS(putFile
, 0, 2)
186 HTTP_ARG_VAL(file
, 0)
187 HTTP_ARG_VAL(options
, 0)
188 HTTP_ARG_VAL(info
, 1)
191 HTTP_BEGIN_ARGS(putStream
, 0, 2)
193 HTTP_ARG_VAL(stream
, 0)
194 HTTP_ARG_VAL(options
, 0)
195 HTTP_ARG_VAL(info
, 1)
198 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
199 HTTP_ARG_VAL(method_name
, 0)
202 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
203 HTTP_ARG_VAL(method
, 0)
206 HTTP_BEGIN_ARGS(methodName
, 0, 1)
207 HTTP_ARG_VAL(method_id
, 0)
210 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
211 HTTP_ARG_VAL(method
, 0)
214 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
215 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
217 zend_class_entry
*http_request_object_ce
;
218 zend_function_entry http_request_object_fe
[] = {
219 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
220 HTTP_REQUEST_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
222 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
223 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
224 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
225 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
227 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
228 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
229 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
231 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
232 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
235 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
236 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
238 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
239 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
241 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
245 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
249 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
253 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
257 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
260 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
276 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
278 HTTP_REQUEST_ALIAS(get
, http_get
)
279 HTTP_REQUEST_ALIAS(head
, http_head
)
280 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
281 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
282 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
283 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
285 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
286 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
287 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
288 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
292 static zend_object_handlers http_request_object_handlers
;
294 PHP_MINIT_FUNCTION(http_request_object
)
296 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
297 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
301 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
303 return http_request_object_new_ex(ce
, curl_easy_init(), NULL
);
306 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
308 zend_object_value ov
;
309 http_request_object
*o
;
311 o
= ecalloc(1, sizeof(http_request_object
));
313 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
314 phpstr_init(&o
->history
);
320 ALLOC_HASHTABLE(OBJ_PROP(o
));
321 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
322 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
324 ov
.handle
= putObject(http_request_object
, o
);
325 ov
.handlers
= &http_request_object_handlers
;
330 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
333 zend_object_value new_ov
;
334 http_request_object
*new_obj
;
335 getObject(http_request_object
, old_obj
);
337 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
338 new_ov
= http_request_object_new_ex(old_zo
->ce
, curl_easy_duphandle(old_obj
->request
->ch
), &new_obj
);
340 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
341 phpstr_append(&new_obj
->history
, old_obj
->history
.data
, old_obj
->history
.used
);
342 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
343 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
348 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
350 zend_class_entry
*ce
= http_request_object_ce
;
352 DCL_PROP_N(PRIVATE
, options
);
353 DCL_PROP_N(PRIVATE
, postFields
);
354 DCL_PROP_N(PRIVATE
, postFiles
);
355 DCL_PROP_N(PRIVATE
, responseInfo
);
356 DCL_PROP_N(PRIVATE
, responseData
);
357 DCL_PROP_N(PRIVATE
, responseMessage
);
358 DCL_PROP(PRIVATE
, long, responseCode
, 0);
359 DCL_PROP(PRIVATE
, long, method
, HTTP_GET
);
360 DCL_PROP(PRIVATE
, string
, url
, "");
361 DCL_PROP(PRIVATE
, string
, contentType
, "");
362 DCL_PROP(PRIVATE
, string
, rawPostData
, "");
363 DCL_PROP(PRIVATE
, string
, queryData
, "");
364 DCL_PROP(PRIVATE
, string
, putFile
, "");
366 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
370 * Request Method Constants
373 DCL_CONST(long, "METH_GET", HTTP_GET
);
374 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
375 DCL_CONST(long, "METH_POST", HTTP_POST
);
376 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
377 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
378 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
379 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
380 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
381 /* WebDAV - RFC 2518 */
382 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
383 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
384 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
385 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
386 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
387 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
388 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
389 /* WebDAV Versioning - RFC 3253 */
390 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
391 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
392 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
393 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
394 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
395 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
396 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
397 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
398 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
399 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
400 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
401 /* WebDAV Access Control - RFC 3744 */
402 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
407 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
408 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
409 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
410 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
414 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
416 http_request_object
*o
= (http_request_object
*) object
;
419 zend_hash_destroy(OBJ_PROP(o
));
420 FREE_HASHTABLE(OBJ_PROP(o
));
422 http_request_free(&o
->request
);
423 phpstr_dtor(&o
->history
);
427 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
429 STATUS status
= SUCCESS
;
431 http_request_reset(obj
->request
);
432 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, curl_easy_init(), return FAILURE
);
434 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(obj
, url
)));
436 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(obj
, method
)))
444 php_stream_statbuf ssb
;
445 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(obj
, putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
447 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
448 http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
458 /* check for raw post data */
459 zval
*raw_data
= GET_PROP(obj
, rawPostData
);
461 if (Z_STRLEN_P(raw_data
)) {
462 zval
*ctype
= GET_PROP(obj
, contentType
);
464 if (Z_STRLEN_P(ctype
)) {
465 zval
**headers
, *opts
= GET_PROP(obj
, options
);
467 if ((SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) && (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
470 /* only override if not already set */
471 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) && (Z_TYPE_PP(ct_header
) == IS_STRING
)) {
472 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
477 MAKE_STD_ZVAL(headers
);
479 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
480 add_assoc_zval(opts
, "headers", headers
);
484 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
485 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
488 zval
*zfields
= GET_PROP(obj
, postFields
), *zfiles
= GET_PROP(obj
, postFiles
);
492 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
493 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
495 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
503 if (status
== SUCCESS
) {
504 zval
*qdata
= GET_PROP(obj
, queryData
);
505 zval
*options
= GET_PROP(obj
, options
);
507 if (Z_STRLEN_P(qdata
)) {
508 if (!strchr(obj
->request
->url
, '?')) {
509 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
511 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
513 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
516 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
522 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
526 phpstr_fix(&obj
->request
->conv
.request
);
527 phpstr_fix(&obj
->request
->conv
.response
);
529 msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
536 zval
*headers
, *message
, *resp
, *info
;
538 if (zval_is_true(GET_PROP(obj
, recordHistory
))) {
539 /* we need to act like a zipper, as we'll receive
540 * the requests and the responses in separate chains
543 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
544 http_message
*free_msg
= request
;
550 http_message_tostring(response
, &message
, &msglen
);
551 phpstr_append(&obj
->history
, message
, msglen
);
554 http_message_tostring(request
, &message
, &msglen
);
555 phpstr_append(&obj
->history
, message
, msglen
);
558 } while ((response
= response
->parent
) && (request
= request
->parent
));
560 http_message_free(&free_msg
);
561 phpstr_fix(&obj
->history
);
564 UPD_PROP(obj
, long, responseCode
, msg
->http
.info
.response
.code
);
568 MAKE_STD_ZVAL(headers
);
570 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
571 add_assoc_zval(resp
, "headers", headers
);
572 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
573 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
574 SET_PROP(obj
, responseData
, resp
);
575 zval_ptr_dtor(&resp
);
577 MAKE_STD_ZVAL(message
);
578 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
579 SET_PROP(obj
, responseMessage
, message
);
580 zval_ptr_dtor(&message
);
584 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
585 SET_PROP(obj
, responseInfo
, info
);
586 zval_ptr_dtor(&info
);
592 #define http_request_object_set_options_subr(key, ow) \
593 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
594 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
596 zval
*old_opts
, *new_opts
, *opts
, **entry
;
597 getObject(http_request_object
, obj
);
599 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
603 MAKE_STD_ZVAL(new_opts
);
604 array_init(new_opts
);
605 old_opts
= GET_PROP(obj
, options
);
606 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
607 array_copy(old_opts
, new_opts
);
610 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void **) &entry
)) {
612 zend_hash_clean(Z_ARRVAL_PP(entry
));
614 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
616 array_copy(opts
, *entry
);
618 array_merge(opts
, *entry
);
623 add_assoc_zval(new_opts
, key
, opts
);
625 SET_PROP(obj
, options
, new_opts
);
626 zval_ptr_dtor(&new_opts
);
631 #define http_request_object_get_options_subr(key) \
632 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
633 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
638 zval
*opts
, **options
;
639 getObject(http_request_object
, obj
);
641 opts
= GET_PROP(obj
, options
);
643 array_init(return_value
);
645 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
)) {
646 convert_to_array(*options
);
647 array_copy(*options
, return_value
);
653 /* ### USERLAND ### */
655 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
657 * Instantiate a new HttpRequest object.
659 * Accepts a string as optional parameter containing the target request url.
660 * Additianally accepts an optional int parameter specifying the request method
661 * to use and an associative array as optional third parameter which will be
662 * passed to HttpRequest::setOptions().
664 * Throws HttpException.
666 PHP_METHOD(HttpRequest
, __construct
)
671 zval
*options
= NULL
;
672 getObject(http_request_object
, obj
);
675 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
677 UPD_STRL(obj
, url
, URL
, URL_len
);
680 UPD_PROP(obj
, long, method
, meth
);
683 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
690 /* {{{ proto void HttpRequest::__destruct()
692 * Destroys the HttpRequest object.
694 PHP_METHOD(HttpRequest
, __destruct
)
696 getObject(http_request_object
, obj
);
702 /* {{{ proto bool HttpRequest::setOptions([array options])
704 * Set the request options to use. See http_get() for a full list of available options.
706 * Accepts an array as optional parameters, wich values will overwrite the
707 * currently set request options. If the parameter is empty or mitted,
708 * the optoions of the HttpRequest object will be reset.
710 * Returns TRUE on success, or FALSE on failure.
712 PHP_METHOD(HttpRequest
, setOptions
)
717 zval
*opts
= NULL
, *old_opts
, *new_opts
, **opt
;
718 getObject(http_request_object
, obj
);
720 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
724 MAKE_STD_ZVAL(new_opts
);
725 array_init(new_opts
);
727 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
728 SET_PROP(obj
, options
, new_opts
);
732 old_opts
= GET_PROP(obj
, options
);
733 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
734 array_copy(old_opts
, new_opts
);
737 /* some options need extra attention -- thus cannot use array_merge() directly */
738 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
740 if (!strcmp(key
, "headers")) {
742 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), "headers", sizeof("headers"), (void **) &headers
)) {
743 convert_to_array_ex(opt
);
744 convert_to_array(*headers
);
745 array_merge(*opt
, *headers
);
748 } else if (!strcmp(key
, "cookies")) {
750 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
751 convert_to_array_ex(opt
);
752 convert_to_array(*cookies
);
753 array_merge(*opt
, *cookies
);
756 } else if (!strcmp(key
, "ssl")) {
758 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), "ssl", sizeof("ssl"), (void **) &ssl
)) {
759 convert_to_array_ex(opt
);
760 convert_to_array(*ssl
);
761 array_merge(*opt
, *ssl
);
764 } else if ((Z_TYPE_PP(opt
) == IS_STRING
) && ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri")))) {
765 UPD_STRL(obj
, url
, Z_STRVAL_PP(opt
), Z_STRLEN_PP(opt
));
767 } else if (!strcmp(key
, "method")) {
768 if (Z_TYPE_PP(opt
) != IS_LONG
) {
769 convert_to_long_ex(opt
);
771 UPD_PROP(obj
, long, method
, Z_LVAL_PP(opt
));
776 add_assoc_zval(new_opts
, key
, *opt
);
782 SET_PROP(obj
, options
, new_opts
);
783 zval_ptr_dtor(&new_opts
);
789 /* {{{ proto array HttpRequest::getOptions()
791 * Get currently set options.
793 * Returns an associative array containing currently set options.
795 PHP_METHOD(HttpRequest
, getOptions
)
800 getObject(http_request_object
, obj
);
801 zval
*options
= GET_PROP(obj
, options
);
803 RETURN_ZVAL(options
, 1, 0);
808 /* {{{ proto bool HttpRequest::setSslOptions([array options])
812 * Accepts an associative array as parameter containing any SSL specific options.
813 * If the parameter is empty or omitted, the SSL options will be reset.
815 * Returns TRUE on success, or FALSE on failure.
817 PHP_METHOD(HttpRequest
, setSslOptions
)
819 http_request_object_set_options_subr("ssl", 1);
823 /* {{{ proto bool HttpRequest::addSslOptions(array options)
825 * Set additional SSL options.
827 * Expects an associative array as parameter containing additional SSL specific options.
829 * Returns TRUE on success, or FALSE on failure.
831 PHP_METHOD(HttpRequest
, addSslOptions
)
833 http_request_object_set_options_subr("ssl", 0);
837 /* {{{ proto array HttpRequest::getSslOtpions()
839 * Get previously set SSL options.
841 * Returns an associative array containing any previously set SSL options.
843 PHP_METHOD(HttpRequest
, getSslOptions
)
845 http_request_object_get_options_subr("ssl");
849 /* {{{ proto bool HttpRequest::addHeaders(array headers)
851 * Add request header name/value pairs.
853 * Expects an ssociative array as parameter containing additional header
856 * Returns TRUE on success, or FALSE on failure.
858 PHP_METHOD(HttpRequest
, addHeaders
)
860 http_request_object_set_options_subr("headers", 0);
863 /* {{{ proto bool HttpRequest::setHeaders([array headers])
865 * Set request header name/value pairs.
867 * Accepts an associative array as parameter containing header name/value pairs.
868 * If the parameter is empty or omitted, all previously set headers will be unset.
870 * Returns TRUE on success, or FALSE on failure.
872 PHP_METHOD(HttpRequest
, setHeaders
)
874 http_request_object_set_options_subr("headers", 1);
878 /* {{{ proto array HttpRequest::getHeaders()
880 * Get previously set request headers.
882 * Returns an associative array containing all currently set headers.
884 PHP_METHOD(HttpRequest
, getHeaders
)
886 http_request_object_get_options_subr("headers");
890 /* {{{ proto bool HttpRequest::setCookies([array cookies])
894 * Accepts an associative array as parameter containing cookie name/value pairs.
895 * If the parameter is empty or omitted, all previously set cookies will be unset.
897 * Returns TRUE on success, or FALSE on failure.
899 PHP_METHOD(HttpRequest
, setCookies
)
901 http_request_object_set_options_subr("cookies", 1);
905 /* {{{ proto bool HttpRequest::addCookies(array cookies)
909 * Expects an associative array as parameter containing any cookie name/value
912 * Returns TRUE on success, or FALSE on failure.
914 PHP_METHOD(HttpRequest
, addCookies
)
916 http_request_object_set_options_subr("cookies", 0);
920 /* {{{ proto array HttpRequest::getCookies()
922 * Get previously set cookies.
924 * Returns an associative array containing any previously set cookies.
926 PHP_METHOD(HttpRequest
, getCookies
)
928 http_request_object_get_options_subr("cookies");
932 /* {{{ proto bool HttpRequest::setUrl(string url)
934 * Set the request URL.
936 * Expects a string as parameter specifying the request url.
938 * Returns TRUE on success, or FALSE on failure.
940 PHP_METHOD(HttpRequest
, setUrl
)
944 getObject(http_request_object
, obj
);
946 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
950 UPD_STRL(obj
, url
, URL
, URL_len
);
955 /* {{{ proto string HttpRequest::getUrl()
957 * Get the previously set request URL.
959 * Returns the currently set request url as string.
961 PHP_METHOD(HttpRequest
, getUrl
)
966 getObject(http_request_object
, obj
);
967 zval
*url
= GET_PROP(obj
, url
);
969 RETURN_ZVAL(url
, 1, 0);
974 /* {{{ proto bool HttpRequest::setMethod(int request_method)
976 * Set the request method.
978 * Expects an int as parameter specifying the request method to use.
979 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
981 * Returns TRUE on success, or FALSE on failure.
983 PHP_METHOD(HttpRequest
, setMethod
)
986 getObject(http_request_object
, obj
);
988 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
992 UPD_PROP(obj
, long, method
, meth
);
997 /* {{{ proto int HttpRequest::getMethod()
999 * Get the previously set request method.
1001 * Returns the currently set request method.
1003 PHP_METHOD(HttpRequest
, getMethod
)
1008 getObject(http_request_object
, obj
);
1009 zval
*method
= GET_PROP(obj
, method
);
1011 RETURN_ZVAL(method
, 1, 0);
1016 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1018 * Set the content type the post request should have.
1020 * Expects a string as parameters containing the content type of the request
1021 * (primary/secondary).
1023 * Returns TRUE on success, or FALSE if the content type does not seem to
1024 * contain a primary and a secondary part.
1026 PHP_METHOD(HttpRequest
, setContentType
)
1030 getObject(http_request_object
, obj
);
1032 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1036 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1037 UPD_STRL(obj
, contentType
, ctype
, ct_len
);
1042 /* {{{ proto string HttpRequest::getContentType()
1044 * Get the previously content type.
1046 * Returns the previously set content type as string.
1048 PHP_METHOD(HttpRequest
, getContentType
)
1053 getObject(http_request_object
, obj
);
1054 zval
*ctype
= GET_PROP(obj
, contentType
);
1056 RETURN_ZVAL(ctype
, 1, 0);
1061 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1063 * Set the URL query parameters to use, overwriting previously set query parameters.
1064 * Affects any request types.
1066 * Accepts a string or associative array parameter containing the pre-encoded
1067 * query string or to be encoded query fields. If the parameter is empty or
1068 * omitted, the query data will be unset.
1070 * Returns TRUE on success, or FALSE on failure.
1072 PHP_METHOD(HttpRequest
, setQueryData
)
1075 getObject(http_request_object
, obj
);
1077 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1081 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1082 UPD_STRL(obj
, queryData
, "", 0);
1083 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1084 char *query_data
= NULL
;
1086 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1090 UPD_PROP(obj
, string
, queryData
, query_data
);
1095 convert_to_string_ex(&qdata
);
1096 UPD_STRL(obj
, queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1097 if (orig
!= qdata
) {
1098 zval_ptr_dtor(&qdata
);
1105 /* {{{ proto string HttpRequest::getQueryData()
1107 * Get the current query data in form of an urlencoded query string.
1109 * Returns a string containing the urlencoded query.
1111 PHP_METHOD(HttpRequest
, getQueryData
)
1116 getObject(http_request_object
, obj
);
1117 zval
*qdata
= GET_PROP(obj
, queryData
);
1119 RETURN_ZVAL(qdata
, 1, 0);
1124 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1126 * Add parameters to the query parameter list, leaving previously set unchanged.
1127 * Affects any request type.
1129 * Expects an associative array as parameter containing the query fields to add.
1131 * Returns TRUE on success, or FALSE on failure.
1133 PHP_METHOD(HttpRequest
, addQueryData
)
1135 zval
*qdata
, *old_qdata
;
1136 char *query_data
= NULL
;
1137 size_t query_data_len
= 0;
1138 getObject(http_request_object
, obj
);
1140 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1144 old_qdata
= GET_PROP(obj
, queryData
);
1146 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
)) {
1150 UPD_STRL(obj
, queryData
, query_data
, query_data_len
);
1157 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1159 * Adds POST data entries, leaving previously set unchanged, unless a
1160 * post entry with the same name already exists.
1161 * Affects only POST and custom requests.
1163 * Expects an associative array as parameter containing the post fields.
1165 * Returns TRUE on success, or FALSE on failure.
1167 PHP_METHOD(HttpRequest
, addPostFields
)
1169 zval
*post_data
, *old_post
, *new_post
;
1170 getObject(http_request_object
, obj
);
1172 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1176 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1177 MAKE_STD_ZVAL(new_post
);
1178 array_init(new_post
);
1179 old_post
= GET_PROP(obj
, postFields
);
1180 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1181 array_copy(old_post
, new_post
);
1183 array_merge(post_data
, new_post
);
1184 SET_PROP(obj
, postFields
, new_post
);
1185 zval_ptr_dtor(&new_post
);
1192 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1194 * Set the POST data entries, overwriting previously set POST data.
1195 * Affects only POST and custom requests.
1197 * Accepts an associative array as parameter containing the post fields.
1198 * If the parameter is empty or omitted, the post data will be unset.
1200 * Returns TRUE on success, or FALSE on failure.
1202 PHP_METHOD(HttpRequest
, setPostFields
)
1204 zval
*post
, *post_data
= NULL
;
1205 getObject(http_request_object
, obj
);
1207 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!", &post_data
)) {
1211 MAKE_STD_ZVAL(post
);
1213 if (post_data
&& (Z_TYPE_P(post_data
) == IS_ARRAY
)) {
1214 array_copy(post_data
, post
);
1216 SET_PROP(obj
, postFields
, post
);
1217 zval_ptr_dtor(&post
);
1223 /* {{{ proto array HttpRequest::getPostFields()
1225 * Get previously set POST data.
1227 * Returns the currently set post fields as associative array.
1229 PHP_METHOD(HttpRequest
, getPostFields
)
1234 getObject(http_request_object
, obj
);
1235 zval
*post
= GET_PROP(obj
, postFields
);
1237 RETURN_ZVAL(post
, 1, 0);
1242 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1244 * Set raw post data to send, overwriting previously set raw post data. Don't
1245 * forget to specify a content type. Affects only POST and custom requests.
1246 * Only either post fields or raw post data can be used for each request.
1247 * Raw post data has higher precedence and will be used even if post fields
1250 * Accepts a string as parameter containing the *raw* post data.
1252 * Returns TRUE on success, or FALSE on failure.
1254 PHP_METHOD(HttpRequest
, setRawPostData
)
1256 char *raw_data
= NULL
;
1258 getObject(http_request_object
, obj
);
1260 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1268 UPD_STRL(obj
, rawPostData
, raw_data
, data_len
);
1273 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1275 * Add raw post data, leaving previously set raw post data unchanged.
1276 * Affects only POST and custom requests.
1278 * Expects a string as parameter containing the raw post data to concatenate.
1280 * Returns TRUE on success, or FALSE on failure.
1282 PHP_METHOD(HttpRequest
, addRawPostData
)
1286 getObject(http_request_object
, obj
);
1288 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1293 zval
*zdata
= GET_PROP(obj
, rawPostData
);
1295 SEPARATE_ZVAL(&zdata
);
1296 Z_STRVAL_P(zdata
) = erealloc(Z_STRVAL_P(zdata
), (Z_STRLEN_P(zdata
) += data_len
) + 1);
1297 Z_STRVAL_P(zdata
)[Z_STRLEN_P(zdata
)] = '\0';
1298 memcpy(Z_STRVAL_P(zdata
) + Z_STRLEN_P(zdata
) - data_len
, raw_data
, data_len
);
1299 SET_PROP(obj
, rawPostData
, zdata
);
1306 /* {{{ proto string HttpRequest::getRawPostData()
1308 * Get previously set raw post data.
1310 * Returns a string containing the currently set raw post data.
1312 PHP_METHOD(HttpRequest
, getRawPostData
)
1317 getObject(http_request_object
, obj
);
1318 zval
*post
= GET_PROP(obj
, rawPostData
);
1320 RETURN_ZVAL(post
, 1, 0);
1325 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1327 * Add a file to the POST request, leaving prefiously set files unchanged.
1328 * Affects only POST and custom requests. Cannot be used with raw post data.
1330 * Expects a string parameter containing the form element name, and a string
1331 * paremeter containing the path to the file which should be uploaded.
1332 * Additionally accepts an optional string parameter which chould contain
1333 * the content type of the file.
1335 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1336 * primary and a secondary content type part.
1338 PHP_METHOD(HttpRequest
, addPostFile
)
1340 zval
*entry
, *old_post
, *new_post
;
1341 char *name
, *file
, *type
= NULL
;
1342 int name_len
, file_len
, type_len
= 0;
1343 getObject(http_request_object
, obj
);
1345 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1350 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1352 type
= "application/x-octetstream";
1353 type_len
= sizeof("application/x-octetstream") - 1;
1356 MAKE_STD_ZVAL(entry
);
1359 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1360 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1361 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1363 MAKE_STD_ZVAL(new_post
);
1364 array_init(new_post
);
1365 old_post
= GET_PROP(obj
, postFiles
);
1366 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1367 array_copy(old_post
, new_post
);
1369 add_next_index_zval(new_post
, entry
);
1370 SET_PROP(obj
, postFiles
, new_post
);
1376 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1378 * Set files to post, overwriting previously set post files.
1379 * Affects only POST and requests. Cannot be used with raw post data.
1381 * Accepts an array containing the files to post. Each entry should be an
1382 * associative array with "name", "file" and "type" keys. If the parameter
1383 * is empty or omitted the post files will be unset.
1385 * Returns TRUE on success, or FALSE on failure.
1387 PHP_METHOD(HttpRequest
, setPostFiles
)
1390 getObject(http_request_object
, obj
);
1392 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &files
)) {
1396 post
= GET_PROP(obj
, postFiles
);
1397 if (Z_TYPE_P(post
) == IS_NULL
) {
1398 MAKE_STD_ZVAL(post
);
1401 SEPARATE_ZVAL(&post
);
1404 zend_hash_clean(Z_ARRVAL_P(post
));
1405 if (files
&& zend_hash_num_elements(Z_ARRVAL_P(files
))) {
1406 array_copy(files
, post
);
1408 SET_PROP(obj
, postFiles
, post
);
1414 /* {{{ proto array HttpRequest::getPostFiles()
1416 * Get all previously added POST files.
1418 * Returns an array containing currently set post files.
1420 PHP_METHOD(HttpRequest
, getPostFiles
)
1425 getObject(http_request_object
, obj
);
1427 array_init(return_value
);
1428 array_copy(GET_PROP(obj
, postFiles
), return_value
);
1433 /* {{{ proto bool HttpRequest::setPutFile([string file])
1435 * Set file to put. Affects only PUT requests.
1437 * Accepts a string as parameter referencing the path to file.
1438 * If the parameter is empty or omitted the put file will be unset.
1440 * Returns TRUE on success, or FALSE on failure.
1442 PHP_METHOD(HttpRequest
, setPutFile
)
1446 getObject(http_request_object
, obj
);
1448 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1452 UPD_STRL(obj
, putFile
, file
, file_len
);
1457 /* {{{ proto string HttpRequest::getPutFile()
1459 * Get previously set put file.
1461 * Returns a string containing the path to the currently set put file.
1463 PHP_METHOD(HttpRequest
, getPutFile
)
1468 getObject(http_request_object
, obj
);
1469 zval
*file
= GET_PROP(obj
, putFile
);
1471 RETVAL_ZVAL(file
, 1, 0);
1476 /* {{{ proto array HttpRequest::getResponseData()
1478 * Get all response data after the request has been sent.
1480 * Returns an associative array with the key "headers" containing an associative
1481 * array holding all response headers, as well as the ley "body" containing a
1482 * string with the response body.
1484 * If redirects were allowed and several responses were received, the data
1485 * references the last received response.
1487 PHP_METHOD(HttpRequest
, getResponseData
)
1492 getObject(http_request_object
, obj
);
1494 array_init(return_value
);
1495 array_copy(GET_PROP(obj
, responseData
), return_value
);
1500 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1502 * Get response header(s) after the request has been sent.
1504 * Accepts an string as optional parameter specifying a certain header to read.
1505 * If the parameter is empty or omitted all response headers will be returned.
1507 * Returns either a string with the value of the header matching name if requested,
1508 * FALSE on failure, or an associative array containing all reponse headers.
1510 * If redirects were allowed and several responses were received, the data
1511 * references the last received response.
1513 PHP_METHOD(HttpRequest
, getResponseHeader
)
1516 zval
*data
, **headers
, **header
;
1517 char *header_name
= NULL
;
1519 getObject(http_request_object
, obj
);
1521 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1525 data
= GET_PROP(obj
, responseData
);
1526 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1527 convert_to_array(*headers
);
1528 if (!header_len
|| !header_name
) {
1529 RETVAL_ZVAL(*headers
, 1, 0);
1530 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1531 RETVAL_ZVAL(*header
, 1, 0);
1542 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1544 * Get response cookie(s) after the request has been sent.
1546 * Accepts a string as optional parameter specifying the name of the cookie to read.
1547 * If the parameter is empty or omitted, an associative array with all received
1548 * cookies will be returned.
1550 * Returns either an associative array with the cookie's name, value and any
1551 * additional params of the cookie matching name if requested, FALSE on failure,
1552 * or an array containing all received cookies as arrays.
1554 * If redirects were allowed and several responses were received, the data
1555 * references the last received response.
1557 PHP_METHOD(HttpRequest
, getResponseCookie
)
1560 zval
*data
, **headers
;
1561 char *cookie_name
= NULL
;
1563 getObject(http_request_object
, obj
);
1565 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1569 array_init(return_value
);
1571 data
= GET_PROP(obj
, responseData
);
1572 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1575 zval
**header
= NULL
;
1578 convert_to_array(*headers
);
1579 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1580 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1581 /* several cookies? */
1582 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1586 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1588 MAKE_STD_ZVAL(cookie_hash
);
1589 array_init(cookie_hash
);
1591 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1593 add_next_index_zval(return_value
, cookie_hash
);
1597 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1598 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1599 add_next_index_zval(return_value
, cookie_hash
);
1600 return; /* <<< FOUND >>> */
1602 zval_dtor(cookie_hash
);
1607 zval_dtor(cookie_hash
);
1614 MAKE_STD_ZVAL(cookie_hash
);
1615 array_init(cookie_hash
);
1616 convert_to_string_ex(header
);
1618 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1620 add_next_index_zval(return_value
, cookie_hash
);
1624 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1625 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1626 add_next_index_zval(return_value
, cookie_hash
);
1628 zval_dtor(cookie_hash
);
1633 zval_dtor(cookie_hash
);
1647 /* {{{ proto string HttpRequest::getResponseBody()
1649 * Get the response body after the request has been sent.
1651 * Returns a string containing the response body.
1653 * If redirects were allowed and several responses were received, the data
1654 * references the last received response.
1656 PHP_METHOD(HttpRequest
, getResponseBody
)
1662 getObject(http_request_object
, obj
);
1663 zval
*data
= GET_PROP(obj
, responseData
);
1665 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
)) {
1666 RETURN_ZVAL(*body
, 1, 0);
1674 /* {{{ proto int HttpRequest::getResponseCode()
1676 * Get the response code after the request has been sent.
1678 * Returns an int representing the response code.
1680 * If redirects were allowed and several responses were received, the data
1681 * references the last received response.
1683 PHP_METHOD(HttpRequest
, getResponseCode
)
1688 getObject(http_request_object
, obj
);
1689 zval
*code
= GET_PROP(obj
, responseCode
);
1691 RETVAL_ZVAL(code
, 1, 0);
1696 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1698 * Get response info after the request has been sent.
1699 * See http_get() for a full list of returned info.
1701 * Accepts a string as optional parameter specifying the info to read.
1702 * If the parameter is empty or omitted, an associative array containing
1703 * all available info will be returned.
1705 * Returns either a scalar containing the value of the info matching name if
1706 * requested, FALSE on failure, or an associative array containing all
1709 * If redirects were allowed and several responses were received, the data
1710 * references the last received response.
1712 PHP_METHOD(HttpRequest
, getResponseInfo
)
1715 zval
*info
, **infop
;
1716 char *info_name
= NULL
;
1718 getObject(http_request_object
, obj
);
1720 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1724 info
= GET_PROP(obj
, responseInfo
);
1726 if (info_len
&& info_name
) {
1727 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1728 RETURN_ZVAL(*infop
, 1, 0);
1730 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1734 RETURN_ZVAL(info
, 1, 0);
1740 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1742 * Get the full response as HttpMessage object after the request has been sent.
1744 * Returns an HttpMessage object of the response.
1746 * If redirects were allowed and several responses were received, the data
1747 * references the last received response. Use HttpMessage::getParentMessage()
1748 * to access the data of previously received responses whithin this request
1751 * Throws HttpException.
1753 PHP_METHOD(HttpRequest
, getResponseMessage
)
1759 getObject(http_request_object
, obj
);
1761 SET_EH_THROW_HTTP();
1762 message
= GET_PROP(obj
, responseMessage
);
1763 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1764 RETVAL_OBJECT(message
);
1773 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1775 * Get sent HTTP message.
1777 * Returns an HttpMessage object representing the sent request.
1779 * If redirects were allowed and several responses were received, the data
1780 * references the last received response. Use HttpMessage::getParentMessage()
1781 * to access the data of previously sent requests whithin this request
1784 * Note that the internal request message is immutable, that means that the
1785 * request message received through HttpRequest::getRequestMessage() will
1786 * always look the same for the same request, regardless of any changes you
1787 * may have made to the returned object.
1789 * Throws HttpMalformedHeadersException, HttpEncodingException.
1791 PHP_METHOD(HttpRequest
, getRequestMessage
)
1797 getObject(http_request_object
, obj
);
1799 SET_EH_THROW_HTTP();
1800 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1801 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1808 /* {{{ proto string HttpRequest::getRawRequestMessage()
1810 * Get sent HTTP message.
1812 * Returns an HttpMessage in a form of a string
1815 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1820 getObject(http_request_object
, obj
);
1822 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1827 /* {{{ proto string HttpRequest::getRawResponseMessage()
1829 * Get the entire HTTP response.
1831 * Returns the complete web server response, including the headers in a form of a string.
1834 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1839 getObject(http_request_object
, obj
);
1841 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1846 /* {{{ proto HttpMessage HttpRequest::getHistory()
1848 * Get all sent requests and received responses as an HttpMessage object.
1850 * If you don't want to record history at all, set the instance variable
1851 * HttpRequest::$recoedHistory to FALSE.
1853 * Returns an HttpMessage object representing the complete request/response
1856 * The object references the last received response, use HttpMessage::getParentMessage()
1857 * to access the data of previously sent requests and received responses.
1859 * Note that the internal history is immutable, that means that any changes
1860 * you make the the message list won't affect a history message list newly
1861 * created by another call to HttpRequest::getHistory().
1863 * Throws HttpMalformedHeaderException, HttpEncodingException.
1865 PHP_METHOD(HttpRequest
, getHistory
)
1871 getObject(http_request_object
, obj
);
1873 SET_EH_THROW_HTTP();
1874 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1875 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1882 /* {{{ proto void HttpRequest::clearHistory()
1884 * Clear the history.
1886 PHP_METHOD(HttpRequest
, clearHistory
)
1889 getObject(http_request_object
, obj
);
1890 phpstr_dtor(&obj
->history
);
1895 /* {{{ proto HttpMessage HttpRequest::send()
1897 * Send the HTTP request.
1899 * Returns the received response as HttpMessage object.
1901 * NOTE: While an exception may be thrown, the transfer could have succeeded
1902 * at least partially, so you might want to check the return values of various
1903 * HttpRequest::getResponse*() methods.
1905 * Throws HttpRuntimeException, HttpRequestException,
1906 * HttpMalformedHeaderException, HttpEncodingException.
1911 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1912 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1913 * $r->addQueryData(array('category' => 3));
1916 * if ($r->getResponseCode() == 200) {
1917 * file_put_contents('local.rss', $r->getResponseBody());
1919 * } catch (HttpException $ex) {
1928 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
1929 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1930 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1931 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1933 * echo $r->send()->getBody();
1934 * } catch (HttpException $ex) {
1940 PHP_METHOD(HttpRequest
, send
)
1942 getObject(http_request_object
, obj
);
1946 SET_EH_THROW_HTTP();
1951 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1952 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
1953 http_request_exec(obj
->request
);
1954 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
1955 RETVAL_OBJECT(GET_PROP(obj
, responseMessage
));
1963 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
1970 * vim600: noet sw=4 ts=4 fdm=marker
1971 * vim<600: noet sw=4 ts=4