2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #define HTTP_WANT_CURL
18 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
20 #include "zend_interfaces.h"
22 #include "php_http_api.h"
23 #include "php_http_cookie_api.h"
24 #include "php_http_exception_object.h"
25 #include "php_http_message_api.h"
26 #include "php_http_message_object.h"
27 #include "php_http_request_api.h"
28 #include "php_http_request_object.h"
29 #include "php_http_request_pool_api.h"
30 #include "php_http_url_api.h"
32 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, 0, req_args)
33 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpRequest, method, 0)
34 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
35 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
37 HTTP_BEGIN_ARGS(__construct
, 0)
39 HTTP_ARG_VAL(method
, 0)
40 HTTP_ARG_VAL(options
, 0)
43 HTTP_EMPTY_ARGS(getOptions
);
44 HTTP_BEGIN_ARGS(setOptions
, 0)
45 HTTP_ARG_VAL(options
, 0)
48 HTTP_EMPTY_ARGS(getSslOptions
);
49 HTTP_BEGIN_ARGS(setSslOptions
, 0)
50 HTTP_ARG_VAL(ssl_options
, 0)
53 HTTP_BEGIN_ARGS(addSslOptions
, 0)
54 HTTP_ARG_VAL(ssl_optins
, 0)
57 HTTP_EMPTY_ARGS(getHeaders
);
58 HTTP_BEGIN_ARGS(setHeaders
, 0)
59 HTTP_ARG_VAL(headers
, 0)
62 HTTP_BEGIN_ARGS(addHeaders
, 1)
63 HTTP_ARG_VAL(headers
, 0)
66 HTTP_EMPTY_ARGS(getCookies
);
67 HTTP_BEGIN_ARGS(setCookies
, 0)
68 HTTP_ARG_VAL(cookies
, 0)
71 HTTP_BEGIN_ARGS(addCookies
, 1)
72 HTTP_ARG_VAL(cookies
, 0)
75 HTTP_EMPTY_ARGS(getUrl
);
76 HTTP_BEGIN_ARGS(setUrl
, 1)
80 HTTP_EMPTY_ARGS(getMethod
);
81 HTTP_BEGIN_ARGS(setMethod
, 1)
82 HTTP_ARG_VAL(request_method
, 0)
85 HTTP_EMPTY_ARGS(getContentType
);
86 HTTP_BEGIN_ARGS(setContentType
, 1)
87 HTTP_ARG_VAL(content_type
, 0)
90 HTTP_EMPTY_ARGS(getQueryData
);
91 HTTP_BEGIN_ARGS(setQueryData
, 0)
92 HTTP_ARG_VAL(query_data
, 0)
95 HTTP_BEGIN_ARGS(addQueryData
, 1)
96 HTTP_ARG_VAL(query_data
, 0)
99 HTTP_EMPTY_ARGS(getPostFields
);
100 HTTP_BEGIN_ARGS(setPostFields
, 0)
101 HTTP_ARG_VAL(post_fields
, 0)
104 HTTP_BEGIN_ARGS(addPostFields
, 1)
105 HTTP_ARG_VAL(post_fields
, 0)
108 HTTP_EMPTY_ARGS(getPostFiles
);
109 HTTP_BEGIN_ARGS(setPostFiles
, 0)
110 HTTP_ARG_VAL(post_files
, 0)
113 HTTP_BEGIN_ARGS(addPostFile
, 2)
114 HTTP_ARG_VAL(formname
, 0)
115 HTTP_ARG_VAL(filename
, 0)
116 HTTP_ARG_VAL(content_type
, 0)
119 HTTP_EMPTY_ARGS(getRawPostData
);
120 HTTP_BEGIN_ARGS(setRawPostData
, 0)
121 HTTP_ARG_VAL(raw_post_data
, 0)
124 HTTP_BEGIN_ARGS(addRawPostData
, 1)
125 HTTP_ARG_VAL(raw_post_data
, 0)
128 HTTP_EMPTY_ARGS(getPutFile
);
129 HTTP_BEGIN_ARGS(setPutFile
, 0)
130 HTTP_ARG_VAL(filename
, 0)
133 HTTP_EMPTY_ARGS(getPutData
);
134 HTTP_BEGIN_ARGS(setPutData
, 0)
135 HTTP_ARG_VAL(put_data
, 0)
138 HTTP_BEGIN_ARGS(addPutData
, 1)
139 HTTP_ARG_VAL(put_data
, 0)
142 HTTP_EMPTY_ARGS(getResponseData
);
143 HTTP_BEGIN_ARGS(getResponseHeader
, 0)
144 HTTP_ARG_VAL(name
, 0)
147 HTTP_BEGIN_ARGS(getResponseCookies
, 0)
148 HTTP_ARG_VAL(flags
, 0)
149 HTTP_ARG_VAL(allowed_extras
, 0)
152 HTTP_EMPTY_ARGS(getResponseBody
);
153 HTTP_EMPTY_ARGS(getResponseCode
);
154 HTTP_EMPTY_ARGS(getResponseStatus
);
155 HTTP_BEGIN_ARGS(getResponseInfo
, 0)
156 HTTP_ARG_VAL(name
, 0)
159 HTTP_EMPTY_ARGS(getResponseMessage
);
160 HTTP_EMPTY_ARGS(getRawResponseMessage
);
161 HTTP_EMPTY_ARGS(getRequestMessage
);
162 HTTP_EMPTY_ARGS(getRawRequestMessage
);
163 HTTP_EMPTY_ARGS(getHistory
);
164 HTTP_EMPTY_ARGS(clearHistory
);
165 HTTP_EMPTY_ARGS(send
);
167 HTTP_BEGIN_ARGS(get
, 1)
169 HTTP_ARG_VAL(options
, 0)
170 HTTP_ARG_VAL(info
, 1)
173 HTTP_BEGIN_ARGS(head
, 1)
175 HTTP_ARG_VAL(options
, 0)
176 HTTP_ARG_VAL(info
, 1)
179 HTTP_BEGIN_ARGS(postData
, 2)
181 HTTP_ARG_VAL(data
, 0)
182 HTTP_ARG_VAL(options
, 0)
183 HTTP_ARG_VAL(info
, 1)
186 HTTP_BEGIN_ARGS(postFields
, 2)
188 HTTP_ARG_VAL(data
, 0)
189 HTTP_ARG_VAL(options
, 0)
190 HTTP_ARG_VAL(info
, 1)
193 HTTP_BEGIN_ARGS(putFile
, 2)
195 HTTP_ARG_VAL(file
, 0)
196 HTTP_ARG_VAL(options
, 0)
197 HTTP_ARG_VAL(info
, 1)
200 HTTP_BEGIN_ARGS(putStream
, 2)
202 HTTP_ARG_VAL(stream
, 0)
203 HTTP_ARG_VAL(options
, 0)
204 HTTP_ARG_VAL(info
, 1)
207 HTTP_BEGIN_ARGS(methodRegister
, 1)
208 HTTP_ARG_VAL(method_name
, 0)
211 HTTP_BEGIN_ARGS(methodUnregister
, 1)
212 HTTP_ARG_VAL(method
, 0)
215 HTTP_BEGIN_ARGS(methodName
, 1)
216 HTTP_ARG_VAL(method_id
, 0)
219 HTTP_BEGIN_ARGS(methodExists
, 1)
220 HTTP_ARG_VAL(method
, 0)
223 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
224 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
226 #define OBJ_PROP_CE http_request_object_ce
227 zend_class_entry
*http_request_object_ce
;
228 zend_function_entry http_request_object_fe
[] = {
229 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
231 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
232 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
233 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
234 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
235 HTTP_REQUEST_ME(addSslOptions
, ZEND_ACC_PUBLIC
)
237 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
238 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
239 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
241 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
243 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
245 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
249 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
260 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
262 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
264 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
266 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(setPutData
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getPutData
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(addPutData
, ZEND_ACC_PUBLIC
)
277 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
279 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
280 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
281 HTTP_REQUEST_ME(getResponseCookies
, ZEND_ACC_PUBLIC
)
282 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
283 HTTP_REQUEST_ME(getResponseStatus
, ZEND_ACC_PUBLIC
)
284 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
285 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
286 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
287 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
288 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
289 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
290 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
291 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
293 HTTP_REQUEST_ALIAS(get
, http_get
)
294 HTTP_REQUEST_ALIAS(head
, http_head
)
295 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
296 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
297 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
298 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
300 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
301 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
302 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
303 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
307 static zend_object_handlers http_request_object_handlers
;
309 PHP_MINIT_FUNCTION(http_request_object
)
311 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
312 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
316 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
318 return http_request_object_new_ex(ce
, NULL
, NULL
);
321 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
323 zend_object_value ov
;
324 http_request_object
*o
;
326 o
= ecalloc(1, sizeof(http_request_object
));
328 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
334 ALLOC_HASHTABLE(OBJ_PROP(o
));
335 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
336 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
338 ov
.handle
= putObject(http_request_object
, o
);
339 ov
.handlers
= &http_request_object_handlers
;
344 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
347 zend_object_value new_ov
;
348 http_request_object
*new_obj
;
349 getObject(http_request_object
, old_obj
);
351 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
352 new_ov
= http_request_object_new_ex(old_zo
->ce
, NULL
, &new_obj
);
353 if (old_obj
->request
->ch
) {
354 http_curl_init_ex(curl_easy_duphandle(old_obj
->request
->ch
), new_obj
->request
);
357 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
358 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
359 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
364 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
366 zend_class_entry
*ce
= http_request_object_ce
;
368 DCL_PROP_N(PRIVATE
, options
);
369 DCL_PROP_N(PRIVATE
, postFields
);
370 DCL_PROP_N(PRIVATE
, postFiles
);
371 DCL_PROP_N(PRIVATE
, responseInfo
);
372 DCL_PROP_N(PRIVATE
, responseData
);
373 DCL_PROP_N(PRIVATE
, responseMessage
);
374 DCL_PROP(PRIVATE
, long, responseCode
, 0);
375 DCL_PROP(PRIVATE
, string
, responseStatus
, "");
376 DCL_PROP(PRIVATE
, long, method
, HTTP_GET
);
377 DCL_PROP(PRIVATE
, string
, url
, "");
378 DCL_PROP(PRIVATE
, string
, contentType
, "");
379 DCL_PROP(PRIVATE
, string
, rawPostData
, "");
380 DCL_PROP(PRIVATE
, string
, queryData
, "");
381 DCL_PROP(PRIVATE
, string
, putFile
, "");
382 DCL_PROP(PRIVATE
, string
, putData
, "");
383 DCL_PROP_N(PRIVATE
, history
);
384 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
388 * Request Method Constants
391 DCL_CONST(long, "METH_GET", HTTP_GET
);
392 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
393 DCL_CONST(long, "METH_POST", HTTP_POST
);
394 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
395 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
396 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
397 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
398 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
399 /* WebDAV - RFC 2518 */
400 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
401 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
402 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
403 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
404 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
405 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
406 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
407 /* WebDAV Versioning - RFC 3253 */
408 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
409 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
410 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
411 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
412 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
413 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
414 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
415 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
416 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
417 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
418 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
419 /* WebDAV Access Control - RFC 3744 */
420 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
422 /* cURL HTTP protocol versions */
423 DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0
);
424 DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1
);
425 DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE
);
430 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
431 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
432 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
433 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
437 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
439 http_request_object
*o
= (http_request_object
*) object
;
442 zend_hash_destroy(OBJ_PROP(o
));
443 FREE_HASHTABLE(OBJ_PROP(o
));
445 http_request_free(&o
->request
);
449 #define http_request_object_check_request_content_type(t) _http_request_object_check_request_content_type((t) TSRMLS_CC)
450 static inline void _http_request_object_check_request_content_type(zval
*this_ptr TSRMLS_DC
)
452 zval
*ctype
= GET_PROP(contentType
);
454 if (Z_STRLEN_P(ctype
)) {
455 zval
**headers
, *opts
= GET_PROP(options
);
457 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
458 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) &&
459 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
462 /* only override if not already set */
463 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void **) &ct_header
))) {
464 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
469 MAKE_STD_ZVAL(headers
);
471 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
472 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, headers
);
473 zval_ptr_dtor(&headers
);
478 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
480 STATUS status
= SUCCESS
;
482 http_request_reset(obj
->request
);
483 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, http_curl_init(obj
->request
), return FAILURE
);
485 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(url
)));
487 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(method
)))
495 zval
*put_data
= GET_PROP(putData
);
497 http_request_object_check_request_content_type(getThis());
498 if (Z_STRLEN_P(put_data
)) {
499 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
500 estrndup(Z_STRVAL_P(put_data
), Z_STRLEN_P(put_data
)), Z_STRLEN_P(put_data
), 1);
502 php_stream_statbuf ssb
;
503 php_stream
*stream
= php_stream_open_wrapper_ex(Z_STRVAL_P(GET_PROP(putFile
)), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
, HTTP_DEFAULT_STREAM_CONTEXT
);
505 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
506 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
517 /* check for raw post data */
518 zval
*raw_data
= GET_PROP(rawPostData
);
520 if (Z_STRLEN_P(raw_data
)) {
521 http_request_object_check_request_content_type(getThis());
522 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
523 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
525 zval
*zfields
= GET_PROP(postFields
), *zfiles
= GET_PROP(postFiles
);
529 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
530 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
532 if ((fields
&& zend_hash_num_elements(fields
)) || (files
&& zend_hash_num_elements(files
))) {
533 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
542 if (status
== SUCCESS
) {
543 zval
*qdata
= GET_PROP(queryData
);
544 zval
*options
= GET_PROP(options
);
546 if (Z_STRLEN_P(qdata
)) {
547 if (!strchr(obj
->request
->url
, '?')) {
548 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
550 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
552 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
555 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
557 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
558 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onprogress", sizeof("onprogress"))) {
561 if ( (Z_TYPE_P(options
) != IS_ARRAY
)
562 || (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(options
), "onprogress", sizeof("onprogress"), (void **) &entry
)
563 || (!zval_is_true(*entry
)))) {
566 ZVAL_ADDREF(getThis());
567 add_next_index_zval(pcb
, getThis());
568 add_next_index_stringl(pcb
, "onprogress", lenof("onprogress"), 1);
569 http_request_set_progress_callback(obj
->request
, pcb
);
578 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
584 /* always fetch info */
587 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
588 SET_PROP(responseInfo
, info
);
589 zval_ptr_dtor(&info
);
591 /* parse response message */
592 phpstr_fix(&obj
->request
->conv
.request
);
593 phpstr_fix(&obj
->request
->conv
.response
);
595 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
)))) {
598 zval
*headers
, *message
, *resp
;
600 if (zval_is_true(GET_PROP(recordHistory
))) {
601 zval
*hist
, *history
= GET_PROP(history
);
602 http_message
*response
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
603 http_message
*request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
606 ZVAL_OBJVAL(hist
, http_message_object_new_ex(http_message_object_ce
, http_message_interconnect(response
, request
), NULL
), 0);
607 if (Z_TYPE_P(history
) == IS_OBJECT
) {
608 http_message_object_prepend(hist
, history
);
610 SET_PROP(history
, hist
);
611 zval_ptr_dtor(&hist
);
614 UPD_PROP(long, responseCode
, msg
->http
.info
.response
.code
);
615 UPD_PROP(string
, responseStatus
, msg
->http
.info
.response
.status
);
619 MAKE_STD_ZVAL(headers
);
621 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
622 add_assoc_zval(resp
, "headers", headers
);
623 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
624 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
625 SET_PROP(responseData
, resp
);
626 zval_ptr_dtor(&resp
);
628 MAKE_STD_ZVAL(message
);
629 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
), 0);
630 SET_PROP(responseMessage
, message
);
631 zval_ptr_dtor(&message
);
635 /* update properties with empty values*/
636 zval
*resp
= GET_PROP(responseData
), *znull
;
638 MAKE_STD_ZVAL(znull
);
640 SET_PROP(responseMessage
, znull
);
641 zval_ptr_dtor(&znull
);
643 if (Z_TYPE_P(resp
) == IS_ARRAY
) {
644 zend_hash_clean(Z_ARRVAL_P(resp
));
647 UPD_PROP(long, responseCode
, 0);
648 UPD_PROP(string
, responseStatus
, "");
650 /* append request message to history */
651 if (zval_is_true(GET_PROP(recordHistory
))) {
652 http_message
*request
;
654 if ((request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
655 zval
*hist
, *history
= GET_PROP(history
);
658 ZVAL_OBJVAL(hist
, http_message_object_new_ex(http_message_object_ce
, request
, NULL
), 0);
659 if (Z_TYPE_P(history
) == IS_OBJECT
) {
660 http_message_object_prepend(hist
, history
);
662 SET_PROP(history
, hist
);
663 zval_ptr_dtor(&hist
);
670 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onfinish", sizeof("onfinish"))) {
673 MAKE_STD_ZVAL(param
);
674 ZVAL_BOOL(param
, ret
== SUCCESS
);
675 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "onfinish", NULL
, param
);
676 zval_ptr_dtor(¶m
);
682 #define http_request_object_set_options_subr(key, ow) \
683 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow))
684 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
)
686 zval
*old_opts
, *new_opts
, *opts
= NULL
, **entry
;
688 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
692 MAKE_STD_ZVAL(new_opts
);
693 array_init(new_opts
);
694 old_opts
= GET_PROP(options
);
695 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
696 array_copy(old_opts
, new_opts
);
699 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void **) &entry
)) {
701 zend_hash_clean(Z_ARRVAL_PP(entry
));
703 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
705 array_copy(opts
, *entry
);
707 array_merge(opts
, *entry
);
712 add_assoc_zval(new_opts
, key
, opts
);
714 SET_PROP(options
, new_opts
);
715 zval_ptr_dtor(&new_opts
);
720 #define http_request_object_get_options_subr(key) \
721 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
722 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
727 zval
*opts
, **options
;
729 opts
= GET_PROP(options
);
730 array_init(return_value
);
732 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
733 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void **) &options
))) {
734 convert_to_array(*options
);
735 array_copy(*options
, return_value
);
741 /* ### USERLAND ### */
743 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
745 * Instantiate a new HttpRequest object.
747 * Accepts a string as optional parameter containing the target request url.
748 * Additionally accepts an optional int parameter specifying the request method
749 * to use and an associative array as optional third parameter which will be
750 * passed to HttpRequest::setOptions().
752 * Throws HttpException.
754 PHP_METHOD(HttpRequest
, __construct
)
759 zval
*options
= NULL
;
762 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
764 UPD_STRL(url
, URL
, URL_len
);
767 UPD_PROP(long, method
, meth
);
770 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
777 /* {{{ proto bool HttpRequest::setOptions([array options])
779 * Set the request options to use. See http_get() for a full list of available options.
781 * Accepts an array as optional parameters, which values will overwrite the
782 * currently set request options. If the parameter is empty or omitted,
783 * the options of the HttpRequest object will be reset.
785 * Returns TRUE on success, or FALSE on failure.
787 PHP_METHOD(HttpRequest
, setOptions
)
792 zval
*opts
= NULL
, *old_opts
, *new_opts
, *add_opts
, **opt
;
794 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
798 MAKE_STD_ZVAL(new_opts
);
799 array_init(new_opts
);
801 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
802 SET_PROP(options
, new_opts
);
803 zval_ptr_dtor(&new_opts
);
807 MAKE_STD_ZVAL(add_opts
);
808 array_init(add_opts
);
809 /* some options need extra attention -- thus cannot use array_merge() directly */
810 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
812 if (!strcmp(key
, "headers")) {
813 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, *opt
);
814 } else if (!strcmp(key
, "cookies")) {
815 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addcookies", NULL
, *opt
);
816 } else if (!strcmp(key
, "ssl")) {
817 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addssloptions", NULL
, *opt
);
818 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
819 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "seturl", NULL
, *opt
);
820 } else if (!strcmp(key
, "method")) {
821 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setmethod", NULL
, *opt
);
824 add_assoc_zval(add_opts
, key
, *opt
);
831 old_opts
= GET_PROP(options
);
832 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
833 array_copy(old_opts
, new_opts
);
835 array_merge(add_opts
, new_opts
);
836 SET_PROP(options
, new_opts
);
837 zval_ptr_dtor(&new_opts
);
838 zval_ptr_dtor(&add_opts
);
844 /* {{{ proto array HttpRequest::getOptions()
846 * Get currently set options.
848 * Returns an associative array containing currently set options.
850 PHP_METHOD(HttpRequest
, getOptions
)
855 RETURN_PROP(options
);
860 /* {{{ proto bool HttpRequest::setSslOptions([array options])
864 * Accepts an associative array as parameter containing any SSL specific options.
865 * If the parameter is empty or omitted, the SSL options will be reset.
867 * Returns TRUE on success, or FALSE on failure.
869 PHP_METHOD(HttpRequest
, setSslOptions
)
871 http_request_object_set_options_subr("ssl", 1);
875 /* {{{ proto bool HttpRequest::addSslOptions(array options)
877 * Set additional SSL options.
879 * Expects an associative array as parameter containing additional SSL specific options.
881 * Returns TRUE on success, or FALSE on failure.
883 PHP_METHOD(HttpRequest
, addSslOptions
)
885 http_request_object_set_options_subr("ssl", 0);
889 /* {{{ proto array HttpRequest::getSslOtpions()
891 * Get previously set SSL options.
893 * Returns an associative array containing any previously set SSL options.
895 PHP_METHOD(HttpRequest
, getSslOptions
)
897 http_request_object_get_options_subr("ssl");
901 /* {{{ proto bool HttpRequest::addHeaders(array headers)
903 * Add request header name/value pairs.
905 * Expects an associative array as parameter containing additional header
908 * Returns TRUE on success, or FALSE on failure.
910 PHP_METHOD(HttpRequest
, addHeaders
)
912 http_request_object_set_options_subr("headers", 0);
915 /* {{{ proto bool HttpRequest::setHeaders([array headers])
917 * Set request header name/value pairs.
919 * Accepts an associative array as parameter containing header name/value pairs.
920 * If the parameter is empty or omitted, all previously set headers will be unset.
922 * Returns TRUE on success, or FALSE on failure.
924 PHP_METHOD(HttpRequest
, setHeaders
)
926 http_request_object_set_options_subr("headers", 1);
930 /* {{{ proto array HttpRequest::getHeaders()
932 * Get previously set request headers.
934 * Returns an associative array containing all currently set headers.
936 PHP_METHOD(HttpRequest
, getHeaders
)
938 http_request_object_get_options_subr("headers");
942 /* {{{ proto bool HttpRequest::setCookies([array cookies])
946 * Accepts an associative array as parameter containing cookie name/value pairs.
947 * If the parameter is empty or omitted, all previously set cookies will be unset.
949 * Returns TRUE on success, or FALSE on failure.
951 PHP_METHOD(HttpRequest
, setCookies
)
953 http_request_object_set_options_subr("cookies", 1);
957 /* {{{ proto bool HttpRequest::addCookies(array cookies)
961 * Expects an associative array as parameter containing any cookie name/value
964 * Returns TRUE on success, or FALSE on failure.
966 PHP_METHOD(HttpRequest
, addCookies
)
968 http_request_object_set_options_subr("cookies", 0);
972 /* {{{ proto array HttpRequest::getCookies()
974 * Get previously set cookies.
976 * Returns an associative array containing any previously set cookies.
978 PHP_METHOD(HttpRequest
, getCookies
)
980 http_request_object_get_options_subr("cookies");
984 /* {{{ proto bool HttpRequest::setUrl(string url)
986 * Set the request URL.
988 * Expects a string as parameter specifying the request url.
990 * Returns TRUE on success, or FALSE on failure.
992 PHP_METHOD(HttpRequest
, setUrl
)
997 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
1001 UPD_STRL(url
, URL
, URL_len
);
1006 /* {{{ proto string HttpRequest::getUrl()
1008 * Get the previously set request URL.
1010 * Returns the currently set request url as string.
1012 PHP_METHOD(HttpRequest
, getUrl
)
1022 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1024 * Set the request method.
1026 * Expects an int as parameter specifying the request method to use.
1027 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1029 * Returns TRUE on success, or FALSE on failure.
1031 PHP_METHOD(HttpRequest
, setMethod
)
1035 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
1039 UPD_PROP(long, method
, meth
);
1044 /* {{{ proto int HttpRequest::getMethod()
1046 * Get the previously set request method.
1048 * Returns the currently set request method.
1050 PHP_METHOD(HttpRequest
, getMethod
)
1055 RETURN_PROP(method
);
1060 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1062 * Set the content type the post request should have.
1064 * Expects a string as parameters containing the content type of the request
1065 * (primary/secondary).
1067 * Returns TRUE on success, or FALSE if the content type does not seem to
1068 * contain a primary and a secondary part.
1070 PHP_METHOD(HttpRequest
, setContentType
)
1075 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1079 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1080 UPD_STRL(contentType
, ctype
, ct_len
);
1085 /* {{{ proto string HttpRequest::getContentType()
1087 * Get the previously content type.
1089 * Returns the previously set content type as string.
1091 PHP_METHOD(HttpRequest
, getContentType
)
1096 RETURN_PROP(contentType
);
1101 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1103 * Set the URL query parameters to use, overwriting previously set query parameters.
1104 * Affects any request types.
1106 * Accepts a string or associative array parameter containing the pre-encoded
1107 * query string or to be encoded query fields. If the parameter is empty or
1108 * omitted, the query data will be unset.
1110 * Returns TRUE on success, or FALSE on failure.
1112 PHP_METHOD(HttpRequest
, setQueryData
)
1116 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1120 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1121 UPD_STRL(queryData
, "", 0);
1122 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1123 char *query_data
= NULL
;
1125 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1129 UPD_PROP(string
, queryData
, query_data
);
1134 convert_to_string_ex(&qdata
);
1135 UPD_STRL(queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1136 if (orig
!= qdata
) {
1137 zval_ptr_dtor(&qdata
);
1144 /* {{{ proto string HttpRequest::getQueryData()
1146 * Get the current query data in form of an urlencoded query string.
1148 * Returns a string containing the urlencoded query.
1150 PHP_METHOD(HttpRequest
, getQueryData
)
1155 RETURN_PROP(queryData
);
1160 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1162 * Add parameters to the query parameter list, leaving previously set unchanged.
1163 * Affects any request type.
1165 * Expects an associative array as parameter containing the query fields to add.
1167 * Returns TRUE on success, or FALSE on failure.
1169 PHP_METHOD(HttpRequest
, addQueryData
)
1171 zval
*qdata
, *old_qdata
;
1172 char *query_data
= NULL
;
1173 size_t query_data_len
= 0;
1175 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1179 old_qdata
= GET_PROP(queryData
);
1181 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
)) {
1185 UPD_STRL(queryData
, query_data
, query_data_len
);
1192 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1194 * Adds POST data entries, leaving previously set unchanged, unless a
1195 * post entry with the same name already exists.
1196 * Affects only POST and custom requests.
1198 * Expects an associative array as parameter containing the post fields.
1200 * Returns TRUE on success, or FALSE on failure.
1202 PHP_METHOD(HttpRequest
, addPostFields
)
1204 zval
*post_data
, *old_post
, *new_post
;
1206 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1210 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1211 MAKE_STD_ZVAL(new_post
);
1212 array_init(new_post
);
1213 old_post
= GET_PROP(postFields
);
1214 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1215 array_copy(old_post
, new_post
);
1217 array_merge(post_data
, new_post
);
1218 SET_PROP(postFields
, new_post
);
1219 zval_ptr_dtor(&new_post
);
1226 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1228 * Set the POST data entries, overwriting previously set POST data.
1229 * Affects only POST and custom requests.
1231 * Accepts an associative array as parameter containing the post fields.
1232 * If the parameter is empty or omitted, the post data will be unset.
1234 * Returns TRUE on success, or FALSE on failure.
1236 PHP_METHOD(HttpRequest
, setPostFields
)
1238 zval
*post
, *post_data
= NULL
;
1240 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/!", &post_data
)) {
1244 MAKE_STD_ZVAL(post
);
1246 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1247 array_copy(post_data
, post
);
1249 SET_PROP(postFields
, post
);
1250 zval_ptr_dtor(&post
);
1256 /* {{{ proto array HttpRequest::getPostFields()
1258 * Get previously set POST data.
1260 * Returns the currently set post fields as associative array.
1262 PHP_METHOD(HttpRequest
, getPostFields
)
1267 RETURN_PROP(postFields
);
1272 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1274 * Set raw post data to send, overwriting previously set raw post data. Don't
1275 * forget to specify a content type. Affects only POST and custom requests.
1276 * Only either post fields or raw post data can be used for each request.
1277 * Raw post data has higher precedence and will be used even if post fields
1280 * Accepts a string as parameter containing the *raw* post data.
1282 * Returns TRUE on success, or FALSE on failure.
1284 PHP_METHOD(HttpRequest
, setRawPostData
)
1286 char *raw_data
= NULL
;
1289 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1297 UPD_STRL(rawPostData
, raw_data
, data_len
);
1302 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1304 * Add raw post data, leaving previously set raw post data unchanged.
1305 * Affects only POST and custom requests.
1307 * Expects a string as parameter containing the raw post data to concatenate.
1309 * Returns TRUE on success, or FALSE on failure.
1311 PHP_METHOD(HttpRequest
, addRawPostData
)
1316 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1321 zval
*data
= GET_PROP(rawPostData
);
1323 if (Z_STRLEN_P(data
)) {
1324 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1325 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1326 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, raw_data
, data_len
);
1328 UPD_STRL(putData
, raw_data
, data_len
);
1336 /* {{{ proto string HttpRequest::getRawPostData()
1338 * Get previously set raw post data.
1340 * Returns a string containing the currently set raw post data.
1342 PHP_METHOD(HttpRequest
, getRawPostData
)
1347 RETURN_PROP(rawPostData
);
1352 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1354 * Add a file to the POST request, leaving previously set files unchanged.
1355 * Affects only POST and custom requests. Cannot be used with raw post data.
1357 * Expects a string parameter containing the form element name, and a string
1358 * paremeter containing the path to the file which should be uploaded.
1359 * Additionally accepts an optional string parameter which should contain
1360 * the content type of the file.
1362 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1363 * primary and a secondary content type part.
1365 PHP_METHOD(HttpRequest
, addPostFile
)
1367 zval
*entry
, *old_post
, *new_post
;
1368 char *name
, *file
, *type
= NULL
;
1369 int name_len
, file_len
, type_len
= 0;
1371 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1376 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1378 type
= "application/x-octetstream";
1379 type_len
= sizeof("application/x-octetstream") - 1;
1382 MAKE_STD_ZVAL(entry
);
1385 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1386 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1387 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1389 MAKE_STD_ZVAL(new_post
);
1390 array_init(new_post
);
1391 old_post
= GET_PROP(postFiles
);
1392 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1393 array_copy(old_post
, new_post
);
1395 add_next_index_zval(new_post
, entry
);
1396 SET_PROP(postFiles
, new_post
);
1397 zval_ptr_dtor(&new_post
);
1403 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1405 * Set files to post, overwriting previously set post files.
1406 * Affects only POST and requests. Cannot be used with raw post data.
1408 * Accepts an array containing the files to post. Each entry should be an
1409 * associative array with "name", "file" and "type" keys. If the parameter
1410 * is empty or omitted the post files will be unset.
1412 * Returns TRUE on success, or FALSE on failure.
1414 PHP_METHOD(HttpRequest
, setPostFiles
)
1416 zval
*files
= NULL
, *post
;
1418 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!/", &files
)) {
1422 MAKE_STD_ZVAL(post
);
1424 if (files
&& (Z_TYPE_P(files
) == IS_ARRAY
)) {
1425 array_copy(files
, post
);
1427 SET_PROP(postFiles
, post
);
1428 zval_ptr_dtor(&post
);
1434 /* {{{ proto array HttpRequest::getPostFiles()
1436 * Get all previously added POST files.
1438 * Returns an array containing currently set post files.
1440 PHP_METHOD(HttpRequest
, getPostFiles
)
1445 RETURN_PROP(postFiles
);
1450 /* {{{ proto bool HttpRequest::setPutFile([string file])
1452 * Set file to put. Affects only PUT requests.
1454 * Accepts a string as parameter referencing the path to file.
1455 * If the parameter is empty or omitted the put file will be unset.
1457 * Returns TRUE on success, or FALSE on failure.
1459 PHP_METHOD(HttpRequest
, setPutFile
)
1464 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1468 UPD_STRL(putFile
, file
, file_len
);
1473 /* {{{ proto string HttpRequest::getPutFile()
1475 * Get previously set put file.
1477 * Returns a string containing the path to the currently set put file.
1479 PHP_METHOD(HttpRequest
, getPutFile
)
1484 RETURN_PROP(putFile
);
1489 /* {{{ proto bool HttpRequest::setPutData([string put_data])
1491 * Set PUT data to send, overwriting previously set PUT data.
1492 * Affects only PUT requests.
1493 * Only either PUT data or PUT file can be used for each request.
1494 * PUT data has higher precedence and will be used even if a PUT
1497 * Accepts a string as parameter containing the data to upload.
1499 * Returns TRUE on success, or FALSE on failure.
1501 PHP_METHOD(HttpRequest
, setPutData
)
1503 char *put_data
= NULL
;
1506 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &put_data
, &data_len
)) {
1514 UPD_STRL(putData
, put_data
, data_len
);
1519 /* {{{ proto bool HttpRequest::addPutData(string put_data)
1521 * Add PUT data, leaving previously set PUT data unchanged.
1522 * Affects only PUT requests.
1524 * Expects a string as parameter containing the data to concatenate.
1526 * Returns TRUE on success, or FALSE on failure.
1528 PHP_METHOD(HttpRequest
, addPutData
)
1533 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &put_data
, &data_len
)) {
1539 size_t new_data_len
;
1540 zval
*data
= GET_PROP(putData
);
1542 if (Z_STRLEN_P(data
)) {
1543 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1544 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1545 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, put_data
, data_len
);
1547 UPD_STRL(putData
, put_data
, data_len
);
1555 /* {{{ proto string HttpRequest::getPutData()
1557 * Get previously set PUT data.
1559 * Returns a string containing the currently set raw post data.
1561 PHP_METHOD(HttpRequest
, getPutData
)
1566 RETURN_PROP(putData
);
1571 /* {{{ proto array HttpRequest::getResponseData()
1573 * Get all response data after the request has been sent.
1575 * Returns an associative array with the key "headers" containing an associative
1576 * array holding all response headers, as well as the key "body" containing a
1577 * string with the response body.
1579 * If redirects were allowed and several responses were received, the data
1580 * references the last received response.
1582 PHP_METHOD(HttpRequest
, getResponseData
)
1587 RETURN_PROP(responseData
);
1592 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1594 * Get response header(s) after the request has been sent.
1596 * Accepts an string as optional parameter specifying a certain header to read.
1597 * If the parameter is empty or omitted all response headers will be returned.
1599 * Returns either a string with the value of the header matching name if requested,
1600 * FALSE on failure, or an associative array containing all response headers.
1602 * If redirects were allowed and several responses were received, the data
1603 * references the last received response.
1605 PHP_METHOD(HttpRequest
, getResponseHeader
)
1608 zval
*data
, **headers
, **header
;
1609 char *header_name
= NULL
;
1612 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1616 data
= GET_PROP(responseData
);
1617 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1618 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1619 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1620 if (!header_len
|| !header_name
) {
1621 RETVAL_ZVAL(*headers
, 1, 0);
1622 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1623 RETVAL_ZVAL(*header
, 1, 0);
1634 /* {{{ proto array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])
1636 * Get response cookie(s) after the request has been sent.
1638 * Returns an array of stdClass objects like http_parse_cookie would return.
1640 * If redirects were allowed and several responses were received, the data
1641 * references the last received response.
1643 PHP_METHOD(HttpRequest
, getResponseCookies
)
1647 zval
*allowed_extras_array
= NULL
, *data
, **headers
;
1649 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|la", &flags
, &allowed_extras_array
)) {
1653 data
= GET_PROP(responseData
);
1654 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1655 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) &&
1656 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1659 char *key
= NULL
, **allowed_extras
= NULL
;
1660 zval
**header
= NULL
, **entry
= NULL
;
1661 HashPosition pos
, pos1
, pos2
;
1663 array_init(return_value
);
1665 if (allowed_extras_array
) {
1666 allowed_extras
= ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array
)) + 1, sizeof(char *));
1667 FOREACH_VAL(pos
, allowed_extras_array
, entry
) {
1668 ZVAL_ADDREF(*entry
);
1669 convert_to_string_ex(entry
);
1670 allowed_extras
[i
++] = estrndup(Z_STRVAL_PP(entry
), Z_STRLEN_PP(entry
));
1671 zval_ptr_dtor(entry
);
1675 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1676 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1677 http_cookie_list list
;
1679 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1680 zval
**single_header
;
1682 FOREACH_VAL(pos2
, *header
, single_header
) {
1683 ZVAL_ADDREF(*single_header
);
1684 convert_to_string_ex(single_header
);
1685 if (http_parse_cookie_ex(&list
, Z_STRVAL_PP(single_header
), flags
, allowed_extras
)) {
1688 MAKE_STD_ZVAL(cookie
);
1689 object_init(cookie
);
1690 http_cookie_list_tostruct(&list
, cookie
);
1691 add_next_index_zval(return_value
, cookie
);
1692 http_cookie_list_dtor(&list
);
1694 zval_ptr_dtor(single_header
);
1697 ZVAL_ADDREF(*header
);
1698 convert_to_string_ex(header
);
1699 if (http_parse_cookie_ex(&list
, Z_STRVAL_PP(header
), flags
, allowed_extras
)) {
1702 MAKE_STD_ZVAL(cookie
);
1703 object_init(cookie
);
1704 http_cookie_list_tostruct(&list
, cookie
);
1705 add_next_index_zval(return_value
, cookie
);
1706 http_cookie_list_dtor(&list
);
1708 zval_ptr_dtor(header
);
1715 if (allowed_extras
) {
1716 for (i
= 0; allowed_extras
[i
]; ++i
) {
1717 efree(allowed_extras
[i
]);
1719 efree(allowed_extras
);
1728 /* {{{ proto string HttpRequest::getResponseBody()
1730 * Get the response body after the request has been sent.
1732 * Returns a string containing the response body.
1734 * If redirects were allowed and several responses were received, the data
1735 * references the last received response.
1737 PHP_METHOD(HttpRequest
, getResponseBody
)
1743 zval
*data
= GET_PROP(responseData
);
1745 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1746 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
))) {
1747 RETURN_ZVAL(*body
, 1, 0);
1755 /* {{{ proto int HttpRequest::getResponseCode()
1757 * Get the response code after the request has been sent.
1759 * Returns an int representing the response code.
1761 * If redirects were allowed and several responses were received, the data
1762 * references the last received response.
1764 PHP_METHOD(HttpRequest
, getResponseCode
)
1769 RETURN_PROP(responseCode
);
1774 /* {{{ proto string HttpRequest::getResponseStatus()
1776 * Get the response status (i.e. the string after the response code) after the message has been sent.
1778 * Returns a string containing the response status text.
1780 PHP_METHOD(HttpRequest
, getResponseStatus
)
1785 RETURN_PROP(responseStatus
);
1790 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1792 * Get response info after the request has been sent.
1793 * See http_get() for a full list of returned info.
1795 * Accepts a string as optional parameter specifying the info to read.
1796 * If the parameter is empty or omitted, an associative array containing
1797 * all available info will be returned.
1799 * Returns either a scalar containing the value of the info matching name if
1800 * requested, FALSE on failure, or an associative array containing all
1803 * If redirects were allowed and several responses were received, the data
1804 * references the last received response.
1806 PHP_METHOD(HttpRequest
, getResponseInfo
)
1809 zval
*info
, **infop
;
1810 char *info_name
= NULL
;
1813 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1817 info
= GET_PROP(responseInfo
);
1819 if (Z_TYPE_P(info
) != IS_ARRAY
) {
1823 if (info_len
&& info_name
) {
1824 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1825 RETURN_ZVAL(*infop
, 1, 0);
1827 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1831 RETURN_ZVAL(info
, 1, 0);
1837 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1839 * Get the full response as HttpMessage object after the request has been sent.
1841 * Returns an HttpMessage object of the response.
1843 * If redirects were allowed and several responses were received, the data
1844 * references the last received response. Use HttpMessage::getParentMessage()
1845 * to access the data of previously received responses within this request
1848 * Throws HttpException.
1850 PHP_METHOD(HttpRequest
, getResponseMessage
)
1857 SET_EH_THROW_HTTP();
1858 message
= GET_PROP(responseMessage
);
1859 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1860 RETVAL_OBJECT(message
, 1);
1869 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1871 * Get sent HTTP message.
1873 * Returns an HttpMessage object representing the sent request.
1875 * If redirects were allowed and several responses were received, the data
1876 * references the last received response. Use HttpMessage::getParentMessage()
1877 * to access the data of previously sent requests within this request
1880 * Note that the internal request message is immutable, that means that the
1881 * request message received through HttpRequest::getRequestMessage() will
1882 * always look the same for the same request, regardless of any changes you
1883 * may have made to the returned object.
1885 * Throws HttpMalformedHeadersException, HttpEncodingException.
1887 PHP_METHOD(HttpRequest
, getRequestMessage
)
1893 getObject(http_request_object
, obj
);
1895 SET_EH_THROW_HTTP();
1896 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1897 RETVAL_OBJVAL(http_message_object_new_ex(http_message_object_ce
, msg
, NULL
), 0);
1904 /* {{{ proto string HttpRequest::getRawRequestMessage()
1906 * Get sent HTTP message.
1908 * Returns an HttpMessage in a form of a string
1911 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1916 getObject(http_request_object
, obj
);
1918 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1923 /* {{{ proto string HttpRequest::getRawResponseMessage()
1925 * Get the entire HTTP response.
1927 * Returns the complete web server response, including the headers in a form of a string.
1930 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1935 getObject(http_request_object
, obj
);
1937 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1942 /* {{{ proto HttpMessage HttpRequest::getHistory()
1944 * Get all sent requests and received responses as an HttpMessage object.
1946 * If you want to record history, set the instance variable
1947 * HttpRequest::$recordHistory to TRUE.
1949 * Returns an HttpMessage object representing the complete request/response
1952 * The object references the last received response, use HttpMessage::getParentMessage()
1953 * to access the data of previously sent requests and received responses.
1955 * Throws HttpRuntimeException.
1957 PHP_METHOD(HttpRequest
, getHistory
)
1964 SET_EH_THROW_HTTP();
1965 hist
= GET_PROP(history
);
1966 if (Z_TYPE_P(hist
) == IS_OBJECT
) {
1967 RETVAL_OBJECT(hist
, 1);
1969 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "The history is empty");
1976 /* {{{ proto void HttpRequest::clearHistory()
1978 * Clear the history.
1980 PHP_METHOD(HttpRequest
, clearHistory
)
1985 MAKE_STD_ZVAL(hist
);
1987 SET_PROP(history
, hist
);
1988 zval_ptr_dtor(&hist
);
1993 /* {{{ proto HttpMessage HttpRequest::send()
1995 * Send the HTTP request.
1997 * Returns the received response as HttpMessage object.
1999 * NOTE: While an exception may be thrown, the transfer could have succeeded
2000 * at least partially, so you might want to check the return values of various
2001 * HttpRequest::getResponse*() methods.
2003 * Throws HttpRuntimeException, HttpRequestException,
2004 * HttpMalformedHeaderException, HttpEncodingException.
2009 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
2010 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
2011 * $r->addQueryData(array('category' => 3));
2014 * if ($r->getResponseCode() == 200) {
2015 * file_put_contents('local.rss', $r->getResponseBody());
2017 * } catch (HttpException $ex) {
2026 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
2027 * $r->setOptions(array('cookies' => array('lang' => 'de')));
2028 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
2029 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
2031 * echo $r->send()->getBody();
2032 * } catch (HttpException $ex) {
2038 PHP_METHOD(HttpRequest
, send
)
2040 getObject(http_request_object
, obj
);
2044 SET_EH_THROW_HTTP();
2049 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
2050 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
2051 http_request_exec(obj
->request
);
2052 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
2053 RETVAL_OBJECT(GET_PROP(responseMessage
), 1);
2061 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2068 * vim600: noet sw=4 ts=4 fdm=marker
2069 * vim<600: noet sw=4 ts=4