2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
19 #define HTTP_WANT_CURL
22 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
24 #include "zend_interfaces.h"
26 #include "php_http_api.h"
27 #include "php_http_exception_object.h"
28 #include "php_http_message_api.h"
29 #include "php_http_message_object.h"
30 #include "php_http_request_api.h"
31 #include "php_http_request_object.h"
32 #include "php_http_request_pool_api.h"
33 #include "php_http_url_api.h"
35 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
36 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
37 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
38 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
40 HTTP_BEGIN_ARGS(__construct
, 0, 0)
42 HTTP_ARG_VAL(method
, 0)
43 HTTP_ARG_VAL(options
, 0)
46 HTTP_EMPTY_ARGS(getOptions
, 0);
47 HTTP_BEGIN_ARGS(setOptions
, 0, 0)
48 HTTP_ARG_VAL(options
, 0)
51 HTTP_EMPTY_ARGS(getSslOptions
, 0);
52 HTTP_BEGIN_ARGS(setSslOptions
, 0, 0)
53 HTTP_ARG_VAL(ssl_options
, 0)
56 HTTP_BEGIN_ARGS(addSslOptions
, 0, 0)
57 HTTP_ARG_VAL(ssl_optins
, 0)
60 HTTP_EMPTY_ARGS(getHeaders
, 0);
61 HTTP_BEGIN_ARGS(setHeaders
, 0, 0)
62 HTTP_ARG_VAL(headers
, 0)
65 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
66 HTTP_ARG_VAL(headers
, 0)
69 HTTP_EMPTY_ARGS(getCookies
, 0);
70 HTTP_BEGIN_ARGS(setCookies
, 0, 0)
71 HTTP_ARG_VAL(cookies
, 0)
74 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
75 HTTP_ARG_VAL(cookies
, 0)
78 HTTP_EMPTY_ARGS(getUrl
, 0);
79 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
83 HTTP_EMPTY_ARGS(getMethod
, 0);
84 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
85 HTTP_ARG_VAL(request_method
, 0)
88 HTTP_EMPTY_ARGS(getContentType
, 0);
89 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
90 HTTP_ARG_VAL(content_type
, 0)
93 HTTP_EMPTY_ARGS(getQueryData
, 0);
94 HTTP_BEGIN_ARGS(setQueryData
, 0, 0)
95 HTTP_ARG_VAL(query_data
, 0)
98 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
99 HTTP_ARG_VAL(query_data
, 0)
102 HTTP_EMPTY_ARGS(getPostFields
, 0);
103 HTTP_BEGIN_ARGS(setPostFields
, 0, 0)
104 HTTP_ARG_VAL(post_fields
, 0)
107 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
108 HTTP_ARG_VAL(post_fields
, 0)
111 HTTP_EMPTY_ARGS(getPostFiles
, 0);
112 HTTP_BEGIN_ARGS(setPostFiles
, 0, 0)
113 HTTP_ARG_VAL(post_files
, 0)
116 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
117 HTTP_ARG_VAL(formname
, 0)
118 HTTP_ARG_VAL(filename
, 0)
119 HTTP_ARG_VAL(content_type
, 0)
122 HTTP_EMPTY_ARGS(getRawPostData
, 0);
123 HTTP_BEGIN_ARGS(setRawPostData
, 0, 0)
124 HTTP_ARG_VAL(raw_post_data
, 0)
127 HTTP_BEGIN_ARGS(addRawPostData
, 0, 1)
128 HTTP_ARG_VAL(raw_post_data
, 0)
131 HTTP_EMPTY_ARGS(getPutFile
, 0);
132 HTTP_BEGIN_ARGS(setPutFile
, 0, 0)
133 HTTP_ARG_VAL(filename
, 0)
136 HTTP_EMPTY_ARGS(getResponseData
, 0);
137 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
138 HTTP_ARG_VAL(name
, 0)
141 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
142 HTTP_ARG_VAL(name
, 0)
145 HTTP_EMPTY_ARGS(getResponseBody
, 0);
146 HTTP_EMPTY_ARGS(getResponseCode
, 0);
147 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
148 HTTP_ARG_VAL(name
, 0)
151 HTTP_EMPTY_ARGS(getResponseMessage
, 0);
152 HTTP_EMPTY_ARGS(getRawResponseMessage
, 0);
153 HTTP_EMPTY_ARGS(getRequestMessage
, 0);
154 HTTP_EMPTY_ARGS(getRawRequestMessage
, 0);
155 HTTP_EMPTY_ARGS(getHistory
, 0);
156 HTTP_EMPTY_ARGS(clearHistory
, 0);
157 HTTP_EMPTY_ARGS(send
, 0);
159 HTTP_BEGIN_ARGS(get
, 0, 1)
161 HTTP_ARG_VAL(options
, 0)
162 HTTP_ARG_VAL(info
, 1)
165 HTTP_BEGIN_ARGS(head
, 0, 1)
167 HTTP_ARG_VAL(options
, 0)
168 HTTP_ARG_VAL(info
, 1)
171 HTTP_BEGIN_ARGS(postData
, 0, 2)
173 HTTP_ARG_VAL(data
, 0)
174 HTTP_ARG_VAL(options
, 0)
175 HTTP_ARG_VAL(info
, 1)
178 HTTP_BEGIN_ARGS(postFields
, 0, 2)
180 HTTP_ARG_VAL(data
, 0)
181 HTTP_ARG_VAL(options
, 0)
182 HTTP_ARG_VAL(info
, 1)
185 HTTP_BEGIN_ARGS(putFile
, 0, 2)
187 HTTP_ARG_VAL(file
, 0)
188 HTTP_ARG_VAL(options
, 0)
189 HTTP_ARG_VAL(info
, 1)
192 HTTP_BEGIN_ARGS(putStream
, 0, 2)
194 HTTP_ARG_VAL(stream
, 0)
195 HTTP_ARG_VAL(options
, 0)
196 HTTP_ARG_VAL(info
, 1)
199 HTTP_BEGIN_ARGS(methodRegister
, 0, 1)
200 HTTP_ARG_VAL(method_name
, 0)
203 HTTP_BEGIN_ARGS(methodUnregister
, 0, 1)
204 HTTP_ARG_VAL(method
, 0)
207 HTTP_BEGIN_ARGS(methodName
, 0, 1)
208 HTTP_ARG_VAL(method_id
, 0)
211 HTTP_BEGIN_ARGS(methodExists
, 0, 1)
212 HTTP_ARG_VAL(method
, 0)
215 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
216 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
218 #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
);
409 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
410 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
411 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
412 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
416 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
418 http_request_object
*o
= (http_request_object
*) object
;
421 zend_hash_destroy(OBJ_PROP(o
));
422 FREE_HASHTABLE(OBJ_PROP(o
));
424 http_request_free(&o
->request
);
425 phpstr_dtor(&o
->history
);
429 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
431 STATUS status
= SUCCESS
;
433 http_request_reset(obj
->request
);
434 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, curl_easy_init(), return FAILURE
);
436 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(url
)));
438 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(method
)))
446 php_stream_statbuf ssb
;
447 php_stream
*stream
= php_stream_open_wrapper(Z_STRVAL_P(GET_PROP(putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
);
449 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
450 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
460 /* check for raw post data */
461 zval
*raw_data
= GET_PROP(rawPostData
);
463 if (Z_STRLEN_P(raw_data
)) {
464 zval
*ctype
= GET_PROP(contentType
);
466 if (Z_STRLEN_P(ctype
)) {
467 zval
**headers
, *opts
= GET_PROP(options
);
469 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
470 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) &&
471 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
474 /* only override if not already set */
475 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
)) && (Z_TYPE_PP(ct_header
) == IS_STRING
)) {
476 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
481 MAKE_STD_ZVAL(headers
);
483 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
484 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, headers
);
485 zval_ptr_dtor(&headers
);
489 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
490 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
493 zval
*zfields
= GET_PROP(postFields
), *zfiles
= GET_PROP(postFiles
);
497 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
498 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
500 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
508 if (status
== SUCCESS
) {
509 zval
*qdata
= GET_PROP(queryData
);
510 zval
*options
= GET_PROP(options
);
512 if (Z_STRLEN_P(qdata
)) {
513 if (!strchr(obj
->request
->url
, '?')) {
514 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
516 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
518 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
521 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
523 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
524 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onprogress", sizeof("onprogress"))) {
527 if ( (Z_TYPE_P(options
) != IS_ARRAY
)
528 || (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(options
), "onprogress", sizeof("onprogress"), (void **) &entry
)
529 || (!zval_is_true(*entry
)))) {
532 ZVAL_ADDREF(getThis());
533 add_next_index_zval(pcb
, getThis());
534 add_next_index_stringl(pcb
, "onprogress", lenof("onprogress"), 1);
535 http_request_set_progress_callback(obj
->request
, pcb
);
544 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
548 phpstr_fix(&obj
->request
->conv
.request
);
549 phpstr_fix(&obj
->request
->conv
.response
);
551 msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
558 zval
*headers
, *message
, *resp
, *info
;
560 if (zval_is_true(GET_PROP(recordHistory
))) {
561 /* we need to act like a zipper, as we'll receive
562 * the requests and the responses in separate chains
565 http_message
*response
= msg
, *request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
566 http_message
*free_msg
= request
;
572 http_message_tostring(response
, &message
, &msglen
);
573 phpstr_append(&obj
->history
, message
, msglen
);
576 http_message_tostring(request
, &message
, &msglen
);
577 phpstr_append(&obj
->history
, message
, msglen
);
580 } while ((response
= response
->parent
) && (request
= request
->parent
));
582 http_message_free(&free_msg
);
583 phpstr_fix(&obj
->history
);
586 UPD_PROP(long, responseCode
, msg
->http
.info
.response
.code
);
590 MAKE_STD_ZVAL(headers
);
592 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
593 add_assoc_zval(resp
, "headers", headers
);
594 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
595 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
596 SET_PROP(responseData
, resp
);
597 zval_ptr_dtor(&resp
);
599 MAKE_STD_ZVAL(message
);
600 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
601 SET_PROP(responseMessage
, message
);
602 zval_ptr_dtor(&message
);
606 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
607 SET_PROP(responseInfo
, info
);
608 zval_ptr_dtor(&info
);
614 #define http_request_object_set_options_subr(key, ow) \
615 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
616 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
618 zval
*old_opts
, *new_opts
, *opts
, **entry
;
619 getObject(http_request_object
, obj
);
621 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
625 MAKE_STD_ZVAL(new_opts
);
626 array_init(new_opts
);
627 old_opts
= GET_PROP(options
);
628 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
629 array_copy(old_opts
, new_opts
);
632 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void **) &entry
)) {
634 zend_hash_clean(Z_ARRVAL_PP(entry
));
636 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
638 array_copy(opts
, *entry
);
640 array_merge(opts
, *entry
);
645 add_assoc_zval(new_opts
, key
, opts
);
647 SET_PROP(options
, new_opts
);
648 zval_ptr_dtor(&new_opts
);
653 #define http_request_object_get_options_subr(key) \
654 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
655 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
660 zval
*opts
, **options
;
661 getObject(http_request_object
, obj
);
663 opts
= GET_PROP(options
);
665 array_init(return_value
);
667 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
668 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
))) {
669 convert_to_array(*options
);
670 array_copy(*options
, return_value
);
676 /* ### USERLAND ### */
678 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
680 * Instantiate a new HttpRequest object.
682 * Accepts a string as optional parameter containing the target request url.
683 * Additianally accepts an optional int parameter specifying the request method
684 * to use and an associative array as optional third parameter which will be
685 * passed to HttpRequest::setOptions().
687 * Throws HttpException.
689 PHP_METHOD(HttpRequest
, __construct
)
694 zval
*options
= NULL
;
695 getObject(http_request_object
, obj
);
698 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
700 UPD_STRL(url
, URL
, URL_len
);
703 UPD_PROP(long, method
, meth
);
706 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
713 /* {{{ proto bool HttpRequest::setOptions([array options])
715 * Set the request options to use. See http_get() for a full list of available options.
717 * Accepts an array as optional parameters, wich values will overwrite the
718 * currently set request options. If the parameter is empty or mitted,
719 * the optoions of the HttpRequest object will be reset.
721 * Returns TRUE on success, or FALSE on failure.
723 PHP_METHOD(HttpRequest
, setOptions
)
728 zval
*opts
= NULL
, *old_opts
, *new_opts
, *add_opts
, **opt
;
729 getObject(http_request_object
, obj
);
731 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
735 MAKE_STD_ZVAL(new_opts
);
736 array_init(new_opts
);
738 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
739 SET_PROP(options
, new_opts
);
740 zval_ptr_dtor(&new_opts
);
744 MAKE_STD_ZVAL(add_opts
);
745 array_init(add_opts
);
746 /* some options need extra attention -- thus cannot use array_merge() directly */
747 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
749 if (!strcmp(key
, "headers")) {
750 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, *opt
);
751 } else if (!strcmp(key
, "cookies")) {
752 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addcookies", NULL
, *opt
);
753 } else if (!strcmp(key
, "ssl")) {
754 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addssloptions", NULL
, *opt
);
755 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
756 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "seturl", NULL
, *opt
);
757 } else if (!strcmp(key
, "method")) {
758 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setmethod", NULL
, *opt
);
761 add_assoc_zval(add_opts
, key
, *opt
);
768 old_opts
= GET_PROP(options
);
769 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
770 array_copy(old_opts
, new_opts
);
772 array_merge(add_opts
, new_opts
);
773 SET_PROP(options
, new_opts
);
774 zval_ptr_dtor(&new_opts
);
775 zval_ptr_dtor(&add_opts
);
781 /* {{{ proto array HttpRequest::getOptions()
783 * Get currently set options.
785 * Returns an associative array containing currently set options.
787 PHP_METHOD(HttpRequest
, getOptions
)
792 RETURN_PROP(options
);
797 /* {{{ proto bool HttpRequest::setSslOptions([array options])
801 * Accepts an associative array as parameter containing any SSL specific options.
802 * If the parameter is empty or omitted, the SSL options will be reset.
804 * Returns TRUE on success, or FALSE on failure.
806 PHP_METHOD(HttpRequest
, setSslOptions
)
808 http_request_object_set_options_subr("ssl", 1);
812 /* {{{ proto bool HttpRequest::addSslOptions(array options)
814 * Set additional SSL options.
816 * Expects an associative array as parameter containing additional SSL specific options.
818 * Returns TRUE on success, or FALSE on failure.
820 PHP_METHOD(HttpRequest
, addSslOptions
)
822 http_request_object_set_options_subr("ssl", 0);
826 /* {{{ proto array HttpRequest::getSslOtpions()
828 * Get previously set SSL options.
830 * Returns an associative array containing any previously set SSL options.
832 PHP_METHOD(HttpRequest
, getSslOptions
)
834 http_request_object_get_options_subr("ssl");
838 /* {{{ proto bool HttpRequest::addHeaders(array headers)
840 * Add request header name/value pairs.
842 * Expects an ssociative array as parameter containing additional header
845 * Returns TRUE on success, or FALSE on failure.
847 PHP_METHOD(HttpRequest
, addHeaders
)
849 http_request_object_set_options_subr("headers", 0);
852 /* {{{ proto bool HttpRequest::setHeaders([array headers])
854 * Set request header name/value pairs.
856 * Accepts an associative array as parameter containing header name/value pairs.
857 * If the parameter is empty or omitted, all previously set headers will be unset.
859 * Returns TRUE on success, or FALSE on failure.
861 PHP_METHOD(HttpRequest
, setHeaders
)
863 http_request_object_set_options_subr("headers", 1);
867 /* {{{ proto array HttpRequest::getHeaders()
869 * Get previously set request headers.
871 * Returns an associative array containing all currently set headers.
873 PHP_METHOD(HttpRequest
, getHeaders
)
875 http_request_object_get_options_subr("headers");
879 /* {{{ proto bool HttpRequest::setCookies([array cookies])
883 * Accepts an associative array as parameter containing cookie name/value pairs.
884 * If the parameter is empty or omitted, all previously set cookies will be unset.
886 * Returns TRUE on success, or FALSE on failure.
888 PHP_METHOD(HttpRequest
, setCookies
)
890 http_request_object_set_options_subr("cookies", 1);
894 /* {{{ proto bool HttpRequest::addCookies(array cookies)
898 * Expects an associative array as parameter containing any cookie name/value
901 * Returns TRUE on success, or FALSE on failure.
903 PHP_METHOD(HttpRequest
, addCookies
)
905 http_request_object_set_options_subr("cookies", 0);
909 /* {{{ proto array HttpRequest::getCookies()
911 * Get previously set cookies.
913 * Returns an associative array containing any previously set cookies.
915 PHP_METHOD(HttpRequest
, getCookies
)
917 http_request_object_get_options_subr("cookies");
921 /* {{{ proto bool HttpRequest::setUrl(string url)
923 * Set the request URL.
925 * Expects a string as parameter specifying the request url.
927 * Returns TRUE on success, or FALSE on failure.
929 PHP_METHOD(HttpRequest
, setUrl
)
933 getObject(http_request_object
, obj
);
935 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
939 UPD_STRL(url
, URL
, URL_len
);
944 /* {{{ proto string HttpRequest::getUrl()
946 * Get the previously set request URL.
948 * Returns the currently set request url as string.
950 PHP_METHOD(HttpRequest
, getUrl
)
960 /* {{{ proto bool HttpRequest::setMethod(int request_method)
962 * Set the request method.
964 * Expects an int as parameter specifying the request method to use.
965 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
967 * Returns TRUE on success, or FALSE on failure.
969 PHP_METHOD(HttpRequest
, setMethod
)
972 getObject(http_request_object
, obj
);
974 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
978 UPD_PROP(long, method
, meth
);
983 /* {{{ proto int HttpRequest::getMethod()
985 * Get the previously set request method.
987 * Returns the currently set request method.
989 PHP_METHOD(HttpRequest
, getMethod
)
999 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1001 * Set the content type the post request should have.
1003 * Expects a string as parameters containing the content type of the request
1004 * (primary/secondary).
1006 * Returns TRUE on success, or FALSE if the content type does not seem to
1007 * contain a primary and a secondary part.
1009 PHP_METHOD(HttpRequest
, setContentType
)
1013 getObject(http_request_object
, obj
);
1015 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1019 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1020 UPD_STRL(contentType
, ctype
, ct_len
);
1025 /* {{{ proto string HttpRequest::getContentType()
1027 * Get the previously content type.
1029 * Returns the previously set content type as string.
1031 PHP_METHOD(HttpRequest
, getContentType
)
1036 RETURN_PROP(contentType
);
1041 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1043 * Set the URL query parameters to use, overwriting previously set query parameters.
1044 * Affects any request types.
1046 * Accepts a string or associative array parameter containing the pre-encoded
1047 * query string or to be encoded query fields. If the parameter is empty or
1048 * omitted, the query data will be unset.
1050 * Returns TRUE on success, or FALSE on failure.
1052 PHP_METHOD(HttpRequest
, setQueryData
)
1055 getObject(http_request_object
, obj
);
1057 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1061 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1062 UPD_STRL(queryData
, "", 0);
1063 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1064 char *query_data
= NULL
;
1066 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1070 UPD_PROP(string
, queryData
, query_data
);
1075 convert_to_string_ex(&qdata
);
1076 UPD_STRL(queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1077 if (orig
!= qdata
) {
1078 zval_ptr_dtor(&qdata
);
1085 /* {{{ proto string HttpRequest::getQueryData()
1087 * Get the current query data in form of an urlencoded query string.
1089 * Returns a string containing the urlencoded query.
1091 PHP_METHOD(HttpRequest
, getQueryData
)
1096 RETURN_PROP(queryData
);
1101 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1103 * Add parameters to the query parameter list, leaving previously set unchanged.
1104 * Affects any request type.
1106 * Expects an associative array as parameter containing the query fields to add.
1108 * Returns TRUE on success, or FALSE on failure.
1110 PHP_METHOD(HttpRequest
, addQueryData
)
1112 zval
*qdata
, *old_qdata
;
1113 char *query_data
= NULL
;
1114 size_t query_data_len
= 0;
1115 getObject(http_request_object
, obj
);
1117 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1121 old_qdata
= GET_PROP(queryData
);
1123 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
)) {
1127 UPD_STRL(queryData
, query_data
, query_data_len
);
1134 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1136 * Adds POST data entries, leaving previously set unchanged, unless a
1137 * post entry with the same name already exists.
1138 * Affects only POST and custom requests.
1140 * Expects an associative array as parameter containing the post fields.
1142 * Returns TRUE on success, or FALSE on failure.
1144 PHP_METHOD(HttpRequest
, addPostFields
)
1146 zval
*post_data
, *old_post
, *new_post
;
1147 getObject(http_request_object
, obj
);
1149 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1153 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1154 MAKE_STD_ZVAL(new_post
);
1155 array_init(new_post
);
1156 old_post
= GET_PROP(postFields
);
1157 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1158 array_copy(old_post
, new_post
);
1160 array_merge(post_data
, new_post
);
1161 SET_PROP(postFields
, new_post
);
1162 zval_ptr_dtor(&new_post
);
1169 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1171 * Set the POST data entries, overwriting previously set POST data.
1172 * Affects only POST and custom requests.
1174 * Accepts an associative array as parameter containing the post fields.
1175 * If the parameter is empty or omitted, the post data will be unset.
1177 * Returns TRUE on success, or FALSE on failure.
1179 PHP_METHOD(HttpRequest
, setPostFields
)
1181 zval
*post
, *post_data
= NULL
;
1182 getObject(http_request_object
, obj
);
1184 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/!", &post_data
)) {
1188 MAKE_STD_ZVAL(post
);
1190 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1191 array_copy(post_data
, post
);
1193 SET_PROP(postFields
, post
);
1194 zval_ptr_dtor(&post
);
1200 /* {{{ proto array HttpRequest::getPostFields()
1202 * Get previously set POST data.
1204 * Returns the currently set post fields as associative array.
1206 PHP_METHOD(HttpRequest
, getPostFields
)
1211 RETURN_PROP(postFields
);
1216 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1218 * Set raw post data to send, overwriting previously set raw post data. Don't
1219 * forget to specify a content type. Affects only POST and custom requests.
1220 * Only either post fields or raw post data can be used for each request.
1221 * Raw post data has higher precedence and will be used even if post fields
1224 * Accepts a string as parameter containing the *raw* post data.
1226 * Returns TRUE on success, or FALSE on failure.
1228 PHP_METHOD(HttpRequest
, setRawPostData
)
1230 char *raw_data
= NULL
;
1232 getObject(http_request_object
, obj
);
1234 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1242 UPD_STRL(rawPostData
, raw_data
, data_len
);
1247 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1249 * Add raw post data, leaving previously set raw post data unchanged.
1250 * Affects only POST and custom requests.
1252 * Expects a string as parameter containing the raw post data to concatenate.
1254 * Returns TRUE on success, or FALSE on failure.
1256 PHP_METHOD(HttpRequest
, addRawPostData
)
1260 getObject(http_request_object
, obj
);
1262 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1267 zval
*data
= zval_copy(IS_STRING
, GET_PROP(rawPostData
));
1269 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1270 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1271 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, raw_data
, data_len
);
1272 SET_PROP(rawPostData
, data
);
1280 /* {{{ proto string HttpRequest::getRawPostData()
1282 * Get previously set raw post data.
1284 * Returns a string containing the currently set raw post data.
1286 PHP_METHOD(HttpRequest
, getRawPostData
)
1291 RETURN_PROP(rawPostData
);
1296 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1298 * Add a file to the POST request, leaving prefiously set files unchanged.
1299 * Affects only POST and custom requests. Cannot be used with raw post data.
1301 * Expects a string parameter containing the form element name, and a string
1302 * paremeter containing the path to the file which should be uploaded.
1303 * Additionally accepts an optional string parameter which chould contain
1304 * the content type of the file.
1306 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1307 * primary and a secondary content type part.
1309 PHP_METHOD(HttpRequest
, addPostFile
)
1311 zval
*entry
, *old_post
, *new_post
;
1312 char *name
, *file
, *type
= NULL
;
1313 int name_len
, file_len
, type_len
= 0;
1314 getObject(http_request_object
, obj
);
1316 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1321 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1323 type
= "application/x-octetstream";
1324 type_len
= sizeof("application/x-octetstream") - 1;
1327 MAKE_STD_ZVAL(entry
);
1330 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1331 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1332 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1334 MAKE_STD_ZVAL(new_post
);
1335 array_init(new_post
);
1336 old_post
= GET_PROP(postFiles
);
1337 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1338 array_copy(old_post
, new_post
);
1340 add_next_index_zval(new_post
, entry
);
1341 SET_PROP(postFiles
, new_post
);
1342 zval_ptr_dtor(&new_post
);
1348 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1350 * Set files to post, overwriting previously set post files.
1351 * Affects only POST and requests. Cannot be used with raw post data.
1353 * Accepts an array containing the files to post. Each entry should be an
1354 * associative array with "name", "file" and "type" keys. If the parameter
1355 * is empty or omitted the post files will be unset.
1357 * Returns TRUE on success, or FALSE on failure.
1359 PHP_METHOD(HttpRequest
, setPostFiles
)
1361 zval
*files
= NULL
, *post
;
1362 getObject(http_request_object
, obj
);
1364 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!/", &files
)) {
1368 MAKE_STD_ZVAL(post
);
1370 if (files
&& (Z_TYPE_P(files
) == IS_ARRAY
)) {
1371 array_copy(files
, post
);
1373 SET_PROP(postFiles
, post
);
1374 zval_ptr_dtor(&post
);
1380 /* {{{ proto array HttpRequest::getPostFiles()
1382 * Get all previously added POST files.
1384 * Returns an array containing currently set post files.
1386 PHP_METHOD(HttpRequest
, getPostFiles
)
1391 RETURN_PROP(postFiles
);
1396 /* {{{ proto bool HttpRequest::setPutFile([string file])
1398 * Set file to put. Affects only PUT requests.
1400 * Accepts a string as parameter referencing the path to file.
1401 * If the parameter is empty or omitted the put file will be unset.
1403 * Returns TRUE on success, or FALSE on failure.
1405 PHP_METHOD(HttpRequest
, setPutFile
)
1409 getObject(http_request_object
, obj
);
1411 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1415 UPD_STRL(putFile
, file
, file_len
);
1420 /* {{{ proto string HttpRequest::getPutFile()
1422 * Get previously set put file.
1424 * Returns a string containing the path to the currently set put file.
1426 PHP_METHOD(HttpRequest
, getPutFile
)
1431 RETURN_PROP(putFile
);
1436 /* {{{ proto array HttpRequest::getResponseData()
1438 * Get all response data after the request has been sent.
1440 * Returns an associative array with the key "headers" containing an associative
1441 * array holding all response headers, as well as the ley "body" containing a
1442 * string with the response body.
1444 * If redirects were allowed and several responses were received, the data
1445 * references the last received response.
1447 PHP_METHOD(HttpRequest
, getResponseData
)
1452 RETURN_PROP(responseData
);
1457 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1459 * Get response header(s) after the request has been sent.
1461 * Accepts an string as optional parameter specifying a certain header to read.
1462 * If the parameter is empty or omitted all response headers will be returned.
1464 * Returns either a string with the value of the header matching name if requested,
1465 * FALSE on failure, or an associative array containing all reponse headers.
1467 * If redirects were allowed and several responses were received, the data
1468 * references the last received response.
1470 PHP_METHOD(HttpRequest
, getResponseHeader
)
1473 zval
*data
, **headers
, **header
;
1474 char *header_name
= NULL
;
1476 getObject(http_request_object
, obj
);
1478 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1482 data
= GET_PROP(responseData
);
1483 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1484 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1485 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1486 if (!header_len
|| !header_name
) {
1487 RETVAL_ZVAL(*headers
, 1, 0);
1488 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1489 RETVAL_ZVAL(*header
, 1, 0);
1500 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1502 * Get response cookie(s) after the request has been sent.
1504 * Accepts a string as optional parameter specifying the name of the cookie to read.
1505 * If the parameter is empty or omitted, an associative array with all received
1506 * cookies will be returned.
1508 * Returns either an associative array with the cookie's name, value and any
1509 * additional params of the cookie matching name if requested, FALSE on failure,
1510 * or an array containing all received cookies as arrays.
1512 * If redirects were allowed and several responses were received, the data
1513 * references the last received response.
1515 PHP_METHOD(HttpRequest
, getResponseCookie
)
1518 zval
*data
, **headers
;
1519 char *cookie_name
= NULL
;
1521 getObject(http_request_object
, obj
);
1523 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1527 array_init(return_value
);
1529 data
= GET_PROP(responseData
);
1530 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1531 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1532 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1535 zval
**header
= NULL
;
1538 convert_to_array(*headers
);
1539 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1540 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1541 /* several cookies? */
1542 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1546 FOREACH_HASH_VAL(pos2
, Z_ARRVAL_PP(header
), cookie
) {
1548 MAKE_STD_ZVAL(cookie_hash
);
1549 array_init(cookie_hash
);
1551 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1553 add_next_index_zval(return_value
, cookie_hash
);
1557 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1558 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1559 add_next_index_zval(return_value
, cookie_hash
);
1560 return; /* <<< FOUND >>> */
1562 zval_dtor(cookie_hash
);
1567 zval_dtor(cookie_hash
);
1574 MAKE_STD_ZVAL(cookie_hash
);
1575 array_init(cookie_hash
);
1576 convert_to_string_ex(header
);
1578 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1580 add_next_index_zval(return_value
, cookie_hash
);
1584 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1585 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1586 add_next_index_zval(return_value
, cookie_hash
);
1588 zval_dtor(cookie_hash
);
1593 zval_dtor(cookie_hash
);
1607 /* {{{ proto string HttpRequest::getResponseBody()
1609 * Get the response body after the request has been sent.
1611 * Returns a string containing the response body.
1613 * If redirects were allowed and several responses were received, the data
1614 * references the last received response.
1616 PHP_METHOD(HttpRequest
, getResponseBody
)
1622 getObject(http_request_object
, obj
);
1623 zval
*data
= GET_PROP(responseData
);
1625 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1626 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
))) {
1627 RETURN_ZVAL(*body
, 1, 0);
1635 /* {{{ proto int HttpRequest::getResponseCode()
1637 * Get the response code after the request has been sent.
1639 * Returns an int representing the response code.
1641 * If redirects were allowed and several responses were received, the data
1642 * references the last received response.
1644 PHP_METHOD(HttpRequest
, getResponseCode
)
1649 RETURN_PROP(responseCode
);
1654 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1656 * Get response info after the request has been sent.
1657 * See http_get() for a full list of returned info.
1659 * Accepts a string as optional parameter specifying the info to read.
1660 * If the parameter is empty or omitted, an associative array containing
1661 * all available info will be returned.
1663 * Returns either a scalar containing the value of the info matching name if
1664 * requested, FALSE on failure, or an associative array containing all
1667 * If redirects were allowed and several responses were received, the data
1668 * references the last received response.
1670 PHP_METHOD(HttpRequest
, getResponseInfo
)
1673 zval
*info
, **infop
;
1674 char *info_name
= NULL
;
1676 getObject(http_request_object
, obj
);
1678 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1682 info
= GET_PROP(responseInfo
);
1684 if (Z_TYPE_P(info
) != IS_ARRAY
) {
1688 if (info_len
&& info_name
) {
1689 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1690 RETURN_ZVAL(*infop
, 1, 0);
1692 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1696 RETURN_ZVAL(info
, 1, 0);
1702 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1704 * Get the full response as HttpMessage object after the request has been sent.
1706 * Returns an HttpMessage object of the response.
1708 * If redirects were allowed and several responses were received, the data
1709 * references the last received response. Use HttpMessage::getParentMessage()
1710 * to access the data of previously received responses whithin this request
1713 * Throws HttpException.
1715 PHP_METHOD(HttpRequest
, getResponseMessage
)
1721 getObject(http_request_object
, obj
);
1723 SET_EH_THROW_HTTP();
1724 message
= GET_PROP(responseMessage
);
1725 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1726 RETVAL_OBJECT(message
);
1735 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1737 * Get sent HTTP message.
1739 * Returns an HttpMessage object representing the sent request.
1741 * If redirects were allowed and several responses were received, the data
1742 * references the last received response. Use HttpMessage::getParentMessage()
1743 * to access the data of previously sent requests whithin this request
1746 * Note that the internal request message is immutable, that means that the
1747 * request message received through HttpRequest::getRequestMessage() will
1748 * always look the same for the same request, regardless of any changes you
1749 * may have made to the returned object.
1751 * Throws HttpMalformedHeadersException, HttpEncodingException.
1753 PHP_METHOD(HttpRequest
, getRequestMessage
)
1759 getObject(http_request_object
, obj
);
1761 SET_EH_THROW_HTTP();
1762 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1763 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1770 /* {{{ proto string HttpRequest::getRawRequestMessage()
1772 * Get sent HTTP message.
1774 * Returns an HttpMessage in a form of a string
1777 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1782 getObject(http_request_object
, obj
);
1784 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1789 /* {{{ proto string HttpRequest::getRawResponseMessage()
1791 * Get the entire HTTP response.
1793 * Returns the complete web server response, including the headers in a form of a string.
1796 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1801 getObject(http_request_object
, obj
);
1803 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1808 /* {{{ proto HttpMessage HttpRequest::getHistory()
1810 * Get all sent requests and received responses as an HttpMessage object.
1812 * If you don't want to record history at all, set the instance variable
1813 * HttpRequest::$recoedHistory to FALSE.
1815 * Returns an HttpMessage object representing the complete request/response
1818 * The object references the last received response, use HttpMessage::getParentMessage()
1819 * to access the data of previously sent requests and received responses.
1821 * Note that the internal history is immutable, that means that any changes
1822 * you make the the message list won't affect a history message list newly
1823 * created by another call to HttpRequest::getHistory().
1825 * Throws HttpMalformedHeaderException, HttpEncodingException.
1827 PHP_METHOD(HttpRequest
, getHistory
)
1833 getObject(http_request_object
, obj
);
1835 SET_EH_THROW_HTTP();
1836 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->history
), PHPSTR_LEN(&obj
->history
)))) {
1837 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
1844 /* {{{ proto void HttpRequest::clearHistory()
1846 * Clear the history.
1848 PHP_METHOD(HttpRequest
, clearHistory
)
1851 getObject(http_request_object
, obj
);
1852 phpstr_dtor(&obj
->history
);
1857 /* {{{ proto HttpMessage HttpRequest::send()
1859 * Send the HTTP request.
1861 * Returns the received response as HttpMessage object.
1863 * NOTE: While an exception may be thrown, the transfer could have succeeded
1864 * at least partially, so you might want to check the return values of various
1865 * HttpRequest::getResponse*() methods.
1867 * Throws HttpRuntimeException, HttpRequestException,
1868 * HttpMalformedHeaderException, HttpEncodingException.
1873 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
1874 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1875 * $r->addQueryData(array('category' => 3));
1878 * if ($r->getResponseCode() == 200) {
1879 * file_put_contents('local.rss', $r->getResponseBody());
1881 * } catch (HttpException $ex) {
1890 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
1891 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1892 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1893 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1895 * echo $r->send()->getBody();
1896 * } catch (HttpException $ex) {
1902 PHP_METHOD(HttpRequest
, send
)
1904 getObject(http_request_object
, obj
);
1908 SET_EH_THROW_HTTP();
1913 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1914 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
1915 http_request_exec(obj
->request
);
1916 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
1917 RETVAL_OBJECT(GET_PROP(responseMessage
));
1925 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
1932 * vim600: noet sw=4 ts=4 fdm=marker
1933 * vim<600: noet sw=4 ts=4