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(enableCookies
);
76 #if HTTP_CURL_VERSION(7,14,1)
77 HTTP_EMPTY_ARGS(resetCookies
);
80 HTTP_EMPTY_ARGS(getUrl
);
81 HTTP_BEGIN_ARGS(setUrl
, 1)
85 HTTP_EMPTY_ARGS(getMethod
);
86 HTTP_BEGIN_ARGS(setMethod
, 1)
87 HTTP_ARG_VAL(request_method
, 0)
90 HTTP_EMPTY_ARGS(getContentType
);
91 HTTP_BEGIN_ARGS(setContentType
, 1)
92 HTTP_ARG_VAL(content_type
, 0)
95 HTTP_EMPTY_ARGS(getQueryData
);
96 HTTP_BEGIN_ARGS(setQueryData
, 0)
97 HTTP_ARG_VAL(query_data
, 0)
100 HTTP_BEGIN_ARGS(addQueryData
, 1)
101 HTTP_ARG_VAL(query_data
, 0)
104 HTTP_EMPTY_ARGS(getPostFields
);
105 HTTP_BEGIN_ARGS(setPostFields
, 0)
106 HTTP_ARG_VAL(post_fields
, 0)
109 HTTP_BEGIN_ARGS(addPostFields
, 1)
110 HTTP_ARG_VAL(post_fields
, 0)
113 HTTP_EMPTY_ARGS(getPostFiles
);
114 HTTP_BEGIN_ARGS(setPostFiles
, 0)
115 HTTP_ARG_VAL(post_files
, 0)
118 HTTP_BEGIN_ARGS(addPostFile
, 2)
119 HTTP_ARG_VAL(formname
, 0)
120 HTTP_ARG_VAL(filename
, 0)
121 HTTP_ARG_VAL(content_type
, 0)
124 HTTP_EMPTY_ARGS(getRawPostData
);
125 HTTP_BEGIN_ARGS(setRawPostData
, 0)
126 HTTP_ARG_VAL(raw_post_data
, 0)
129 HTTP_BEGIN_ARGS(addRawPostData
, 1)
130 HTTP_ARG_VAL(raw_post_data
, 0)
133 HTTP_EMPTY_ARGS(getPutFile
);
134 HTTP_BEGIN_ARGS(setPutFile
, 0)
135 HTTP_ARG_VAL(filename
, 0)
138 HTTP_EMPTY_ARGS(getPutData
);
139 HTTP_BEGIN_ARGS(setPutData
, 0)
140 HTTP_ARG_VAL(put_data
, 0)
143 HTTP_BEGIN_ARGS(addPutData
, 1)
144 HTTP_ARG_VAL(put_data
, 0)
147 HTTP_EMPTY_ARGS(getResponseData
);
148 HTTP_BEGIN_ARGS(getResponseHeader
, 0)
149 HTTP_ARG_VAL(name
, 0)
152 HTTP_BEGIN_ARGS(getResponseCookies
, 0)
153 HTTP_ARG_VAL(flags
, 0)
154 HTTP_ARG_VAL(allowed_extras
, 0)
157 HTTP_EMPTY_ARGS(getResponseBody
);
158 HTTP_EMPTY_ARGS(getResponseCode
);
159 HTTP_EMPTY_ARGS(getResponseStatus
);
160 HTTP_BEGIN_ARGS(getResponseInfo
, 0)
161 HTTP_ARG_VAL(name
, 0)
164 HTTP_EMPTY_ARGS(getResponseMessage
);
165 HTTP_EMPTY_ARGS(getRawResponseMessage
);
166 HTTP_EMPTY_ARGS(getRequestMessage
);
167 HTTP_EMPTY_ARGS(getRawRequestMessage
);
168 HTTP_EMPTY_ARGS(getHistory
);
169 HTTP_EMPTY_ARGS(clearHistory
);
170 HTTP_EMPTY_ARGS(send
);
172 HTTP_BEGIN_ARGS(get
, 1)
174 HTTP_ARG_VAL(options
, 0)
175 HTTP_ARG_VAL(info
, 1)
178 HTTP_BEGIN_ARGS(head
, 1)
180 HTTP_ARG_VAL(options
, 0)
181 HTTP_ARG_VAL(info
, 1)
184 HTTP_BEGIN_ARGS(postData
, 2)
186 HTTP_ARG_VAL(data
, 0)
187 HTTP_ARG_VAL(options
, 0)
188 HTTP_ARG_VAL(info
, 1)
191 HTTP_BEGIN_ARGS(postFields
, 2)
193 HTTP_ARG_VAL(data
, 0)
194 HTTP_ARG_VAL(options
, 0)
195 HTTP_ARG_VAL(info
, 1)
198 HTTP_BEGIN_ARGS(putData
, 2)
200 HTTP_ARG_VAL(data
, 0)
201 HTTP_ARG_VAL(options
, 0)
202 HTTP_ARG_VAL(info
, 1)
205 HTTP_BEGIN_ARGS(putFile
, 2)
207 HTTP_ARG_VAL(file
, 0)
208 HTTP_ARG_VAL(options
, 0)
209 HTTP_ARG_VAL(info
, 1)
212 HTTP_BEGIN_ARGS(putStream
, 2)
214 HTTP_ARG_VAL(stream
, 0)
215 HTTP_ARG_VAL(options
, 0)
216 HTTP_ARG_VAL(info
, 1)
219 HTTP_BEGIN_ARGS(methodRegister
, 1)
220 HTTP_ARG_VAL(method_name
, 0)
223 HTTP_BEGIN_ARGS(methodUnregister
, 1)
224 HTTP_ARG_VAL(method
, 0)
227 HTTP_BEGIN_ARGS(methodName
, 1)
228 HTTP_ARG_VAL(method_id
, 0)
231 HTTP_BEGIN_ARGS(methodExists
, 1)
232 HTTP_ARG_VAL(method
, 0)
235 HTTP_BEGIN_ARGS(encodeBody
, 2)
236 HTTP_ARG_VAL(fields
, 0)
237 HTTP_ARG_VAL(files
, 0)
240 #define OBJ_PROP_CE http_request_object_ce
241 zend_class_entry
*http_request_object_ce
;
242 zend_function_entry http_request_object_fe
[] = {
243 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
245 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
249 HTTP_REQUEST_ME(addSslOptions
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
253 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
256 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
257 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
259 HTTP_REQUEST_ME(enableCookies
, ZEND_ACC_PUBLIC
)
260 #if HTTP_CURL_VERSION(7,14,1)
261 HTTP_REQUEST_ME(resetCookies
, ZEND_ACC_PUBLIC
)
264 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
270 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
274 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
277 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
278 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
279 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
281 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
282 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
283 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
285 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
286 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
287 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
289 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
290 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
292 HTTP_REQUEST_ME(setPutData
, ZEND_ACC_PUBLIC
)
293 HTTP_REQUEST_ME(getPutData
, ZEND_ACC_PUBLIC
)
294 HTTP_REQUEST_ME(addPutData
, ZEND_ACC_PUBLIC
)
296 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
298 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
299 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
300 HTTP_REQUEST_ME(getResponseCookies
, ZEND_ACC_PUBLIC
)
301 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
302 HTTP_REQUEST_ME(getResponseStatus
, ZEND_ACC_PUBLIC
)
303 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
304 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
305 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
306 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
307 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
308 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
309 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
310 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
312 HTTP_REQUEST_ALIAS(get
, http_get
)
313 HTTP_REQUEST_ALIAS(head
, http_head
)
314 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
315 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
316 HTTP_REQUEST_ALIAS(putData
, http_put_data
)
317 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
318 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
320 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
321 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
322 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
323 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
325 HTTP_REQUEST_ALIAS(encodeBody
, http_request_body_encode
)
329 static zend_object_handlers http_request_object_handlers
;
331 PHP_MINIT_FUNCTION(http_request_object
)
333 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
334 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
336 DCL_PROP_N(PRIVATE
, options
);
337 DCL_PROP_N(PRIVATE
, postFields
);
338 DCL_PROP_N(PRIVATE
, postFiles
);
339 DCL_PROP_N(PRIVATE
, responseInfo
);
340 DCL_PROP_N(PRIVATE
, responseData
);
341 DCL_PROP_N(PRIVATE
, responseMessage
);
342 DCL_PROP(PRIVATE
, long, responseCode
, 0);
343 DCL_PROP(PRIVATE
, string
, responseStatus
, "");
344 DCL_PROP(PRIVATE
, long, method
, HTTP_GET
);
345 DCL_PROP(PRIVATE
, string
, url
, "");
346 DCL_PROP(PRIVATE
, string
, contentType
, "");
347 DCL_PROP(PRIVATE
, string
, rawPostData
, "");
348 DCL_PROP(PRIVATE
, string
, queryData
, "");
349 DCL_PROP(PRIVATE
, string
, putFile
, "");
350 DCL_PROP(PRIVATE
, string
, putData
, "");
351 DCL_PROP_N(PRIVATE
, history
);
352 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
356 * Request Method Constants
359 DCL_CONST(long, "METH_GET", HTTP_GET
);
360 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
361 DCL_CONST(long, "METH_POST", HTTP_POST
);
362 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
363 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
364 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
365 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
366 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
367 /* WebDAV - RFC 2518 */
368 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
369 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
370 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
371 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
372 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
373 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
374 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
375 /* WebDAV Versioning - RFC 3253 */
376 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
377 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
378 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
379 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
380 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
381 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
382 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
383 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
384 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
385 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
386 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
387 /* WebDAV Access Control - RFC 3744 */
388 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
391 * HTTP Protocol Version Constants
393 DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0
);
394 DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1
);
395 DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE
);
400 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
401 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
402 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
403 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
406 * Proxy Type Constants
408 # if HTTP_CURL_VERSION(7,15,2)
409 DCL_CONST(long, "PROXY_SOCKS4", CURLPROXY_SOCKS4
);
411 DCL_CONST(long, "PROXY_SOCKS5", CURLPROXY_SOCKS5
);
412 DCL_CONST(long, "PROXY_HTTP", CURLPROXY_HTTP
);
418 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
420 return http_request_object_new_ex(ce
, NULL
, NULL
);
423 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
425 zend_object_value ov
;
426 http_request_object
*o
;
428 o
= ecalloc(1, sizeof(http_request_object
));
430 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
436 ALLOC_HASHTABLE(OBJ_PROP(o
));
437 zend_hash_init(OBJ_PROP(o
), zend_hash_num_elements(&ce
->default_properties
), NULL
, ZVAL_PTR_DTOR
, 0);
438 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
440 ov
.handle
= putObject(http_request_object
, o
);
441 ov
.handlers
= &http_request_object_handlers
;
446 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
449 zend_object_value new_ov
;
450 http_request_object
*new_obj
;
451 getObject(http_request_object
, old_obj
);
453 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
454 new_ov
= http_request_object_new_ex(old_zo
->ce
, NULL
, &new_obj
);
455 if (old_obj
->request
->ch
) {
456 http_curl_init_ex(curl_easy_duphandle(old_obj
->request
->ch
), new_obj
->request
);
459 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
460 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
461 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
466 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
468 http_request_object
*o
= (http_request_object
*) object
;
471 zend_hash_destroy(OBJ_PROP(o
));
472 FREE_HASHTABLE(OBJ_PROP(o
));
474 http_request_free(&o
->request
);
478 #define http_request_object_check_request_content_type(t) _http_request_object_check_request_content_type((t) TSRMLS_CC)
479 static inline void _http_request_object_check_request_content_type(zval
*this_ptr TSRMLS_DC
)
481 zval
*ctype
= GET_PROP(contentType
);
483 if (Z_STRLEN_P(ctype
)) {
484 zval
**headers
, *opts
= GET_PROP(options
);
486 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
487 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void *) &headers
)) &&
488 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
491 /* only override if not already set */
492 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void *) &ct_header
))) {
493 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
495 /* or not a string, zero length string or a string of spaces */
496 if ((Z_TYPE_PP(ct_header
) != IS_STRING
) || !Z_STRLEN_PP(ct_header
)) {
497 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
499 int i
, only_space
= 1;
501 /* check for spaces only */
502 for (i
= 0; i
< Z_STRLEN_PP(ct_header
); ++i
) {
503 if (!isspace(Z_STRVAL_PP(ct_header
)[i
])) {
509 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
515 MAKE_STD_ZVAL(headers
);
517 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
518 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, headers
);
519 zval_ptr_dtor(&headers
);
524 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
526 STATUS status
= SUCCESS
;
528 http_request_reset(obj
->request
);
529 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, http_curl_init(obj
->request
), return FAILURE
);
531 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(url
)));
533 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(method
)))
541 zval
*put_data
= GET_PROP(putData
);
543 http_request_object_check_request_content_type(getThis());
544 if (Z_STRLEN_P(put_data
)) {
545 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
546 estrndup(Z_STRVAL_P(put_data
), Z_STRLEN_P(put_data
)), Z_STRLEN_P(put_data
), 1);
548 php_stream_statbuf ssb
;
549 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
);
551 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
552 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
563 /* check for raw post data */
564 zval
*raw_data
= GET_PROP(rawPostData
);
566 if (Z_STRLEN_P(raw_data
)) {
567 http_request_object_check_request_content_type(getThis());
568 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
569 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
571 zval
*zfields
= GET_PROP(postFields
), *zfiles
= GET_PROP(postFiles
);
575 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
576 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
578 if ((fields
&& zend_hash_num_elements(fields
)) || (files
&& zend_hash_num_elements(files
))) {
579 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
588 if (status
== SUCCESS
) {
589 zval
*qdata
= GET_PROP(queryData
);
590 zval
*options
= GET_PROP(options
);
592 if (Z_STRLEN_P(qdata
)) {
593 if (!strchr(obj
->request
->url
, '?')) {
594 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
596 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
598 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
601 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
603 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
604 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onprogress", sizeof("onprogress"))) {
607 if ( (Z_TYPE_P(options
) != IS_ARRAY
)
608 || (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(options
), "onprogress", sizeof("onprogress"), (void *) &entry
)
609 || (!zval_is_true(*entry
)))) {
612 ZVAL_ADDREF(getThis());
613 add_next_index_zval(pcb
, getThis());
614 add_next_index_stringl(pcb
, "onprogress", lenof("onprogress"), 1);
615 http_request_set_progress_callback(obj
->request
, pcb
);
624 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
630 /* always fetch info */
633 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
634 SET_PROP(responseInfo
, info
);
635 zval_ptr_dtor(&info
);
637 /* parse response message */
638 phpstr_fix(&obj
->request
->conv
.request
);
639 phpstr_fix(&obj
->request
->conv
.response
);
641 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
)))) {
644 zval
*headers
, *message
, *resp
;
646 if (zval_is_true(GET_PROP(recordHistory
))) {
647 zval
*hist
, *history
= GET_PROP(history
);
648 http_message
*response
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
649 http_message
*request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
652 ZVAL_OBJVAL(hist
, http_message_object_new_ex(http_message_object_ce
, http_message_interconnect(response
, request
), NULL
), 0);
653 if (Z_TYPE_P(history
) == IS_OBJECT
) {
654 http_message_object_prepend(hist
, history
);
656 SET_PROP(history
, hist
);
657 zval_ptr_dtor(&hist
);
660 UPD_PROP(long, responseCode
, msg
->http
.info
.response
.code
);
661 UPD_PROP(string
, responseStatus
, msg
->http
.info
.response
.status
? msg
->http
.info
.response
.status
: "");
665 MAKE_STD_ZVAL(headers
);
667 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
668 add_assoc_zval(resp
, "headers", headers
);
669 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
670 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
671 SET_PROP(responseData
, resp
);
672 zval_ptr_dtor(&resp
);
674 MAKE_STD_ZVAL(message
);
675 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
), 0);
676 SET_PROP(responseMessage
, message
);
677 zval_ptr_dtor(&message
);
681 /* update properties with empty values*/
682 zval
*resp
= GET_PROP(responseData
), *znull
;
684 MAKE_STD_ZVAL(znull
);
686 SET_PROP(responseMessage
, znull
);
687 zval_ptr_dtor(&znull
);
689 if (Z_TYPE_P(resp
) == IS_ARRAY
) {
690 zend_hash_clean(Z_ARRVAL_P(resp
));
693 UPD_PROP(long, responseCode
, 0);
694 UPD_PROP(string
, responseStatus
, "");
696 /* append request message to history */
697 if (zval_is_true(GET_PROP(recordHistory
))) {
698 http_message
*request
;
700 if ((request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
701 zval
*hist
, *history
= GET_PROP(history
);
704 ZVAL_OBJVAL(hist
, http_message_object_new_ex(http_message_object_ce
, request
, NULL
), 0);
705 if (Z_TYPE_P(history
) == IS_OBJECT
) {
706 http_message_object_prepend(hist
, history
);
708 SET_PROP(history
, hist
);
709 zval_ptr_dtor(&hist
);
716 if (!EG(exception
) && zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onfinish", sizeof("onfinish"))) {
719 MAKE_STD_ZVAL(param
);
720 ZVAL_BOOL(param
, ret
== SUCCESS
);
721 with_error_handling(EH_NORMAL
, NULL
) {
722 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "onfinish", NULL
, param
);
723 } end_error_handling();
724 zval_ptr_dtor(¶m
);
730 static int apply_pretty_key(void *pDest
, int num_args
, va_list args
, zend_hash_key
*hash_key
)
732 if (hash_key
->nKeyLength
> 1) {
733 hash_key
->h
= zend_get_hash_value(pretty_key(hash_key
->arKey
, hash_key
->nKeyLength
- 1, 1, 0), hash_key
->nKeyLength
);
735 return ZEND_HASH_APPLY_KEEP
;
738 #define http_request_object_set_options_subr(key, ow, pk) \
739 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow), (pk))
740 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
, int prettify_keys
)
742 zval
*old_opts
, *new_opts
, *opts
= NULL
, **entry
= NULL
;
744 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
748 MAKE_STD_ZVAL(new_opts
);
749 array_init(new_opts
);
750 old_opts
= GET_PROP(options
);
751 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
752 array_copy(old_opts
, new_opts
);
755 if (prettify_keys
&& opts
) {
756 zend_hash_apply_with_arguments(Z_ARRVAL_P(opts
), apply_pretty_key
, 0);
758 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void *) &entry
)) {
760 zend_hash_clean(Z_ARRVAL_PP(entry
));
762 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
764 array_copy(opts
, *entry
);
766 array_merge(opts
, *entry
);
771 add_assoc_zval(new_opts
, key
, opts
);
773 SET_PROP(options
, new_opts
);
774 zval_ptr_dtor(&new_opts
);
779 #define http_request_object_get_options_subr(key) \
780 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
781 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
785 if (return_value_used
) {
786 zval
*opts
, **options
;
788 opts
= GET_PROP(options
);
789 array_init(return_value
);
791 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
792 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void *) &options
))) {
793 convert_to_array(*options
);
794 array_copy(*options
, return_value
);
800 /* ### USERLAND ### */
802 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
804 * Instantiate a new HttpRequest object.
806 * Accepts a string as optional parameter containing the target request url.
807 * Additionally accepts an optional int parameter specifying the request method
808 * to use and an associative array as optional third parameter which will be
809 * passed to HttpRequest::setOptions().
811 * Throws HttpException.
813 PHP_METHOD(HttpRequest
, __construct
)
818 zval
*options
= NULL
;
821 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
823 UPD_STRL(url
, URL
, URL_len
);
826 UPD_PROP(long, method
, meth
);
829 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
836 /* {{{ proto bool HttpRequest::setOptions([array options])
838 * Set the request options to use. See http_get() for a full list of available options.
840 * Accepts an array as optional parameters, which values will overwrite the
841 * currently set request options. If the parameter is empty or omitted,
842 * the options of the HttpRequest object will be reset.
844 * Returns TRUE on success, or FALSE on failure.
846 PHP_METHOD(HttpRequest
, setOptions
)
851 zval
*opts
= NULL
, *old_opts
, *new_opts
, *add_opts
, **opt
;
853 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
857 MAKE_STD_ZVAL(new_opts
);
858 array_init(new_opts
);
860 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
861 SET_PROP(options
, new_opts
);
862 zval_ptr_dtor(&new_opts
);
866 MAKE_STD_ZVAL(add_opts
);
867 array_init(add_opts
);
868 /* some options need extra attention -- thus cannot use array_merge() directly */
869 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
871 if (!strcmp(key
, "headers")) {
872 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, *opt
);
873 } else if (!strcmp(key
, "cookies")) {
874 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addcookies", NULL
, *opt
);
875 } else if (!strcmp(key
, "ssl")) {
876 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addssloptions", NULL
, *opt
);
877 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
878 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "seturl", NULL
, *opt
);
879 } else if (!strcmp(key
, "method")) {
880 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setmethod", NULL
, *opt
);
881 #if HTTP_CURL_VERSION(7,14,1)
882 } else if (!strcmp(key
, "resetcookies")) {
883 getObject(http_request_object
, obj
);
884 http_request_reset_cookies(obj
->request
);
888 add_assoc_zval(add_opts
, key
, *opt
);
895 old_opts
= GET_PROP(options
);
896 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
897 array_copy(old_opts
, new_opts
);
899 array_merge(add_opts
, new_opts
);
900 SET_PROP(options
, new_opts
);
901 zval_ptr_dtor(&new_opts
);
902 zval_ptr_dtor(&add_opts
);
908 /* {{{ proto array HttpRequest::getOptions()
910 * Get currently set options.
912 * Returns an associative array containing currently set options.
914 PHP_METHOD(HttpRequest
, getOptions
)
918 if (return_value_used
) {
919 RETURN_PROP(options
);
924 /* {{{ proto bool HttpRequest::setSslOptions([array options])
928 * Accepts an associative array as parameter containing any SSL specific options.
929 * If the parameter is empty or omitted, the SSL options will be reset.
931 * Returns TRUE on success, or FALSE on failure.
933 PHP_METHOD(HttpRequest
, setSslOptions
)
935 http_request_object_set_options_subr("ssl", 1, 0);
939 /* {{{ proto bool HttpRequest::addSslOptions(array options)
941 * Set additional SSL options.
943 * Expects an associative array as parameter containing additional SSL specific options.
945 * Returns TRUE on success, or FALSE on failure.
947 PHP_METHOD(HttpRequest
, addSslOptions
)
949 http_request_object_set_options_subr("ssl", 0, 0);
953 /* {{{ proto array HttpRequest::getSslOtpions()
955 * Get previously set SSL options.
957 * Returns an associative array containing any previously set SSL options.
959 PHP_METHOD(HttpRequest
, getSslOptions
)
961 http_request_object_get_options_subr("ssl");
965 /* {{{ proto bool HttpRequest::addHeaders(array headers)
967 * Add request header name/value pairs.
969 * Expects an associative array as parameter containing additional header
972 * Returns TRUE on success, or FALSE on failure.
974 PHP_METHOD(HttpRequest
, addHeaders
)
976 http_request_object_set_options_subr("headers", 0, 1);
979 /* {{{ proto bool HttpRequest::setHeaders([array headers])
981 * Set request header name/value pairs.
983 * Accepts an associative array as parameter containing header name/value pairs.
984 * If the parameter is empty or omitted, all previously set headers will be unset.
986 * Returns TRUE on success, or FALSE on failure.
988 PHP_METHOD(HttpRequest
, setHeaders
)
990 http_request_object_set_options_subr("headers", 1, 1);
994 /* {{{ proto array HttpRequest::getHeaders()
996 * Get previously set request headers.
998 * Returns an associative array containing all currently set headers.
1000 PHP_METHOD(HttpRequest
, getHeaders
)
1002 http_request_object_get_options_subr("headers");
1006 /* {{{ proto bool HttpRequest::setCookies([array cookies])
1010 * Accepts an associative array as parameter containing cookie name/value pairs.
1011 * If the parameter is empty or omitted, all previously set cookies will be unset.
1013 * Returns TRUE on success, or FALSE on failure.
1015 PHP_METHOD(HttpRequest
, setCookies
)
1017 http_request_object_set_options_subr("cookies", 1, 0);
1021 /* {{{ proto bool HttpRequest::addCookies(array cookies)
1025 * Expects an associative array as parameter containing any cookie name/value
1028 * Returns TRUE on success, or FALSE on failure.
1030 PHP_METHOD(HttpRequest
, addCookies
)
1032 http_request_object_set_options_subr("cookies", 0, 0);
1036 /* {{{ proto array HttpRequest::getCookies()
1038 * Get previously set cookies.
1040 * Returns an associative array containing any previously set cookies.
1042 PHP_METHOD(HttpRequest
, getCookies
)
1044 http_request_object_get_options_subr("cookies");
1048 /* {{{ proto bool HttpRequest::enableCookies()
1050 * Enable automatic sending of received cookies.
1051 * Note that cuutomly set cookies will be sent anyway.
1053 PHP_METHOD(HttpRequest
, enableCookies
)
1056 getObject(http_request_object
, obj
);
1057 RETURN_SUCCESS(http_request_enable_cookies(obj
->request
));
1063 /* {{{ proto bool HttpRequest::resetCookies()
1065 * Reset all automatically received/sent cookies.
1066 * Note that customly set cookies are not affected.
1068 PHP_METHOD(HttpRequest
, resetCookies
)
1071 getObject(http_request_object
, obj
);
1072 RETURN_SUCCESS(http_request_reset_cookies(obj
->request
));
1077 /* {{{ proto bool HttpRequest::setUrl(string url)
1079 * Set the request URL.
1081 * Expects a string as parameter specifying the request url.
1083 * Returns TRUE on success, or FALSE on failure.
1085 PHP_METHOD(HttpRequest
, setUrl
)
1090 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
1094 UPD_STRL(url
, URL
, URL_len
);
1099 /* {{{ proto string HttpRequest::getUrl()
1101 * Get the previously set request URL.
1103 * Returns the currently set request url as string.
1105 PHP_METHOD(HttpRequest
, getUrl
)
1109 if (return_value_used
) {
1115 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1117 * Set the request method.
1119 * Expects an int as parameter specifying the request method to use.
1120 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1122 * Returns TRUE on success, or FALSE on failure.
1124 PHP_METHOD(HttpRequest
, setMethod
)
1128 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
1132 UPD_PROP(long, method
, meth
);
1137 /* {{{ proto int HttpRequest::getMethod()
1139 * Get the previously set request method.
1141 * Returns the currently set request method.
1143 PHP_METHOD(HttpRequest
, getMethod
)
1147 if (return_value_used
) {
1148 RETURN_PROP(method
);
1153 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1155 * Set the content type the post request should have.
1157 * Expects a string as parameters containing the content type of the request
1158 * (primary/secondary).
1160 * Returns TRUE on success, or FALSE if the content type does not seem to
1161 * contain a primary and a secondary part.
1163 PHP_METHOD(HttpRequest
, setContentType
)
1168 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1173 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1175 UPD_STRL(contentType
, ctype
, ct_len
);
1180 /* {{{ proto string HttpRequest::getContentType()
1182 * Get the previously content type.
1184 * Returns the previously set content type as string.
1186 PHP_METHOD(HttpRequest
, getContentType
)
1190 if (return_value_used
) {
1191 RETURN_PROP(contentType
);
1196 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1198 * Set the URL query parameters to use, overwriting previously set query parameters.
1199 * Affects any request types.
1201 * Accepts a string or associative array parameter containing the pre-encoded
1202 * query string or to be encoded query fields. If the parameter is empty or
1203 * omitted, the query data will be unset.
1205 * Returns TRUE on success, or FALSE on failure.
1207 PHP_METHOD(HttpRequest
, setQueryData
)
1211 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1215 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1216 UPD_STRL(queryData
, "", 0);
1217 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1218 char *query_data
= NULL
;
1220 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1224 UPD_PROP(string
, queryData
, query_data
);
1229 convert_to_string_ex(&qdata
);
1230 UPD_STRL(queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1231 if (orig
!= qdata
) {
1232 zval_ptr_dtor(&qdata
);
1239 /* {{{ proto string HttpRequest::getQueryData()
1241 * Get the current query data in form of an urlencoded query string.
1243 * Returns a string containing the urlencoded query.
1245 PHP_METHOD(HttpRequest
, getQueryData
)
1249 if (return_value_used
) {
1250 RETURN_PROP(queryData
);
1255 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1257 * Add parameters to the query parameter list, leaving previously set unchanged.
1258 * Affects any request type.
1260 * Expects an associative array as parameter containing the query fields to add.
1262 * Returns TRUE on success, or FALSE on failure.
1264 PHP_METHOD(HttpRequest
, addQueryData
)
1266 zval
*qdata
, *old_qdata
;
1267 char *query_data
= NULL
;
1268 size_t query_data_len
= 0;
1270 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1274 old_qdata
= GET_PROP(queryData
);
1276 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
)) {
1280 UPD_STRL(queryData
, query_data
, query_data_len
);
1287 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1289 * Adds POST data entries, leaving previously set unchanged, unless a
1290 * post entry with the same name already exists.
1291 * Affects only POST and custom requests.
1293 * Expects an associative array as parameter containing the post fields.
1295 * Returns TRUE on success, or FALSE on failure.
1297 PHP_METHOD(HttpRequest
, addPostFields
)
1299 zval
*post_data
, *old_post
, *new_post
;
1301 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1305 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1306 MAKE_STD_ZVAL(new_post
);
1307 array_init(new_post
);
1308 old_post
= GET_PROP(postFields
);
1309 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1310 array_copy(old_post
, new_post
);
1312 array_merge(post_data
, new_post
);
1313 SET_PROP(postFields
, new_post
);
1314 zval_ptr_dtor(&new_post
);
1321 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1323 * Set the POST data entries, overwriting previously set POST data.
1324 * Affects only POST and custom requests.
1326 * Accepts an associative array as parameter containing the post fields.
1327 * If the parameter is empty or omitted, the post data will be unset.
1329 * Returns TRUE on success, or FALSE on failure.
1331 PHP_METHOD(HttpRequest
, setPostFields
)
1333 zval
*post
, *post_data
= NULL
;
1335 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/!", &post_data
)) {
1339 MAKE_STD_ZVAL(post
);
1341 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1342 array_copy(post_data
, post
);
1344 SET_PROP(postFields
, post
);
1345 zval_ptr_dtor(&post
);
1351 /* {{{ proto array HttpRequest::getPostFields()
1353 * Get previously set POST data.
1355 * Returns the currently set post fields as associative array.
1357 PHP_METHOD(HttpRequest
, getPostFields
)
1361 if (return_value_used
) {
1362 RETURN_PROP(postFields
);
1367 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1369 * Set raw post data to send, overwriting previously set raw post data. Don't
1370 * forget to specify a content type. Affects only POST and custom requests.
1371 * Only either post fields or raw post data can be used for each request.
1372 * Raw post data has higher precedence and will be used even if post fields
1375 * Accepts a string as parameter containing the *raw* post data.
1377 * Returns TRUE on success, or FALSE on failure.
1379 PHP_METHOD(HttpRequest
, setRawPostData
)
1381 char *raw_data
= NULL
;
1384 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1392 UPD_STRL(rawPostData
, raw_data
, data_len
);
1397 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1399 * Add raw post data, leaving previously set raw post data unchanged.
1400 * Affects only POST and custom requests.
1402 * Expects a string as parameter containing the raw post data to concatenate.
1404 * Returns TRUE on success, or FALSE on failure.
1406 PHP_METHOD(HttpRequest
, addRawPostData
)
1411 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1416 zval
*data
= GET_PROP(rawPostData
);
1418 if (Z_STRLEN_P(data
)) {
1419 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1420 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1421 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, raw_data
, data_len
);
1423 UPD_STRL(putData
, raw_data
, data_len
);
1431 /* {{{ proto string HttpRequest::getRawPostData()
1433 * Get previously set raw post data.
1435 * Returns a string containing the currently set raw post data.
1437 PHP_METHOD(HttpRequest
, getRawPostData
)
1441 if (return_value_used
) {
1442 RETURN_PROP(rawPostData
);
1447 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1449 * Add a file to the POST request, leaving previously set files unchanged.
1450 * Affects only POST and custom requests. Cannot be used with raw post data.
1452 * Expects a string parameter containing the form element name, and a string
1453 * paremeter containing the path to the file which should be uploaded.
1454 * Additionally accepts an optional string parameter which should contain
1455 * the content type of the file.
1457 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1458 * primary and a secondary content type part.
1460 PHP_METHOD(HttpRequest
, addPostFile
)
1462 zval
*entry
, *old_post
, *new_post
;
1463 char *name
, *file
, *type
= NULL
;
1464 int name_len
, file_len
, type_len
= 0;
1466 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1471 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1473 type
= "application/x-octetstream";
1474 type_len
= sizeof("application/x-octetstream") - 1;
1477 MAKE_STD_ZVAL(entry
);
1480 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1481 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1482 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1484 MAKE_STD_ZVAL(new_post
);
1485 array_init(new_post
);
1486 old_post
= GET_PROP(postFiles
);
1487 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1488 array_copy(old_post
, new_post
);
1490 add_next_index_zval(new_post
, entry
);
1491 SET_PROP(postFiles
, new_post
);
1492 zval_ptr_dtor(&new_post
);
1498 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1500 * Set files to post, overwriting previously set post files.
1501 * Affects only POST and requests. Cannot be used with raw post data.
1503 * Accepts an array containing the files to post. Each entry should be an
1504 * associative array with "name", "file" and "type" keys. If the parameter
1505 * is empty or omitted the post files will be unset.
1507 * Returns TRUE on success, or FALSE on failure.
1509 PHP_METHOD(HttpRequest
, setPostFiles
)
1511 zval
*files
= NULL
, *post
;
1513 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!/", &files
)) {
1517 MAKE_STD_ZVAL(post
);
1519 if (files
&& (Z_TYPE_P(files
) == IS_ARRAY
)) {
1520 array_copy(files
, post
);
1522 SET_PROP(postFiles
, post
);
1523 zval_ptr_dtor(&post
);
1529 /* {{{ proto array HttpRequest::getPostFiles()
1531 * Get all previously added POST files.
1533 * Returns an array containing currently set post files.
1535 PHP_METHOD(HttpRequest
, getPostFiles
)
1539 if (return_value_used
) {
1540 RETURN_PROP(postFiles
);
1545 /* {{{ proto bool HttpRequest::setPutFile([string file])
1547 * Set file to put. Affects only PUT requests.
1549 * Accepts a string as parameter referencing the path to file.
1550 * If the parameter is empty or omitted the put file will be unset.
1552 * Returns TRUE on success, or FALSE on failure.
1554 PHP_METHOD(HttpRequest
, setPutFile
)
1559 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1563 UPD_STRL(putFile
, file
, file_len
);
1568 /* {{{ proto string HttpRequest::getPutFile()
1570 * Get previously set put file.
1572 * Returns a string containing the path to the currently set put file.
1574 PHP_METHOD(HttpRequest
, getPutFile
)
1578 if (return_value_used
) {
1579 RETURN_PROP(putFile
);
1584 /* {{{ proto bool HttpRequest::setPutData([string put_data])
1586 * Set PUT data to send, overwriting previously set PUT data.
1587 * Affects only PUT requests.
1588 * Only either PUT data or PUT file can be used for each request.
1589 * PUT data has higher precedence and will be used even if a PUT
1592 * Accepts a string as parameter containing the data to upload.
1594 * Returns TRUE on success, or FALSE on failure.
1596 PHP_METHOD(HttpRequest
, setPutData
)
1598 char *put_data
= NULL
;
1601 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &put_data
, &data_len
)) {
1609 UPD_STRL(putData
, put_data
, data_len
);
1614 /* {{{ proto bool HttpRequest::addPutData(string put_data)
1616 * Add PUT data, leaving previously set PUT data unchanged.
1617 * Affects only PUT requests.
1619 * Expects a string as parameter containing the data to concatenate.
1621 * Returns TRUE on success, or FALSE on failure.
1623 PHP_METHOD(HttpRequest
, addPutData
)
1628 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &put_data
, &data_len
)) {
1633 zval
*data
= GET_PROP(putData
);
1635 if (Z_STRLEN_P(data
)) {
1636 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1637 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1638 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, put_data
, data_len
);
1640 UPD_STRL(putData
, put_data
, data_len
);
1648 /* {{{ proto string HttpRequest::getPutData()
1650 * Get previously set PUT data.
1652 * Returns a string containing the currently set raw post data.
1654 PHP_METHOD(HttpRequest
, getPutData
)
1658 if (return_value_used
) {
1659 RETURN_PROP(putData
);
1664 /* {{{ proto array HttpRequest::getResponseData()
1666 * Get all response data after the request has been sent.
1668 * Returns an associative array with the key "headers" containing an associative
1669 * array holding all response headers, as well as the key "body" containing a
1670 * string with the response body.
1672 * If redirects were allowed and several responses were received, the data
1673 * references the last received response.
1675 PHP_METHOD(HttpRequest
, getResponseData
)
1679 if (return_value_used
) {
1680 RETURN_PROP(responseData
);
1685 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1687 * Get response header(s) after the request has been sent.
1689 * Accepts an string as optional parameter specifying a certain header to read.
1690 * If the parameter is empty or omitted all response headers will be returned.
1692 * Returns either a string with the value of the header matching name if requested,
1693 * FALSE on failure, or an associative array containing all response headers.
1695 * If redirects were allowed and several responses were received, the data
1696 * references the last received response.
1698 PHP_METHOD(HttpRequest
, getResponseHeader
)
1700 if (return_value_used
) {
1701 zval
*data
, **headers
, **header
;
1702 char *header_name
= NULL
;
1705 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1709 data
= GET_PROP(responseData
);
1710 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1711 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void *) &headers
)) &&
1712 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1713 if (!header_len
|| !header_name
) {
1714 RETVAL_ZVAL(*headers
, 1, 0);
1715 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void *) &header
)) {
1716 RETVAL_ZVAL(*header
, 1, 0);
1727 /* {{{ proto array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])
1729 * Get response cookie(s) after the request has been sent.
1731 * Returns an array of stdClass objects like http_parse_cookie would return.
1733 * If redirects were allowed and several responses were received, the data
1734 * references the last received response.
1736 PHP_METHOD(HttpRequest
, getResponseCookies
)
1738 if (return_value_used
) {
1740 zval
*allowed_extras_array
= NULL
, *data
, **headers
;
1742 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|la", &flags
, &allowed_extras_array
)) {
1746 data
= GET_PROP(responseData
);
1747 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1748 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void *) &headers
)) &&
1749 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1752 char *key
= NULL
, **allowed_extras
= NULL
;
1753 zval
**header
= NULL
, **entry
= NULL
;
1754 HashPosition pos
, pos1
, pos2
;
1756 array_init(return_value
);
1758 if (allowed_extras_array
) {
1759 allowed_extras
= ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array
)) + 1, sizeof(char *));
1760 FOREACH_VAL(pos
, allowed_extras_array
, entry
) {
1761 ZVAL_ADDREF(*entry
);
1762 convert_to_string_ex(entry
);
1763 allowed_extras
[i
++] = estrndup(Z_STRVAL_PP(entry
), Z_STRLEN_PP(entry
));
1764 zval_ptr_dtor(entry
);
1768 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1769 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1770 http_cookie_list list
;
1772 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1773 zval
**single_header
;
1775 FOREACH_VAL(pos2
, *header
, single_header
) {
1776 ZVAL_ADDREF(*single_header
);
1777 convert_to_string_ex(single_header
);
1778 if (http_parse_cookie_ex(&list
, Z_STRVAL_PP(single_header
), flags
, allowed_extras
)) {
1781 MAKE_STD_ZVAL(cookie
);
1782 object_init(cookie
);
1783 http_cookie_list_tostruct(&list
, cookie
);
1784 add_next_index_zval(return_value
, cookie
);
1785 http_cookie_list_dtor(&list
);
1787 zval_ptr_dtor(single_header
);
1790 ZVAL_ADDREF(*header
);
1791 convert_to_string_ex(header
);
1792 if (http_parse_cookie_ex(&list
, Z_STRVAL_PP(header
), flags
, allowed_extras
)) {
1795 MAKE_STD_ZVAL(cookie
);
1796 object_init(cookie
);
1797 http_cookie_list_tostruct(&list
, cookie
);
1798 add_next_index_zval(return_value
, cookie
);
1799 http_cookie_list_dtor(&list
);
1801 zval_ptr_dtor(header
);
1808 if (allowed_extras
) {
1809 for (i
= 0; allowed_extras
[i
]; ++i
) {
1810 efree(allowed_extras
[i
]);
1812 efree(allowed_extras
);
1821 /* {{{ proto string HttpRequest::getResponseBody()
1823 * Get the response body after the request has been sent.
1825 * Returns a string containing the response body.
1827 * If redirects were allowed and several responses were received, the data
1828 * references the last received response.
1830 PHP_METHOD(HttpRequest
, getResponseBody
)
1834 if (return_value_used
) {
1836 zval
*data
= GET_PROP(responseData
);
1838 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1839 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void *) &body
))) {
1840 RETURN_ZVAL(*body
, 1, 0);
1848 /* {{{ proto int HttpRequest::getResponseCode()
1850 * Get the response code after the request has been sent.
1852 * Returns an int representing the response code.
1854 * If redirects were allowed and several responses were received, the data
1855 * references the last received response.
1857 PHP_METHOD(HttpRequest
, getResponseCode
)
1861 if (return_value_used
) {
1862 RETURN_PROP(responseCode
);
1867 /* {{{ proto string HttpRequest::getResponseStatus()
1869 * Get the response status (i.e. the string after the response code) after the message has been sent.
1871 * Returns a string containing the response status text.
1873 PHP_METHOD(HttpRequest
, getResponseStatus
)
1877 if (return_value_used
) {
1878 RETURN_PROP(responseStatus
);
1883 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1885 * Get response info after the request has been sent.
1886 * See http_get() for a full list of returned info.
1888 * Accepts a string as optional parameter specifying the info to read.
1889 * If the parameter is empty or omitted, an associative array containing
1890 * all available info will be returned.
1892 * Returns either a scalar containing the value of the info matching name if
1893 * requested, FALSE on failure, or an associative array containing all
1896 * If redirects were allowed and several responses were received, the data
1897 * references the last received response.
1899 PHP_METHOD(HttpRequest
, getResponseInfo
)
1901 if (return_value_used
) {
1902 zval
*info
, **infop
;
1903 char *info_name
= NULL
;
1906 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1910 info
= GET_PROP(responseInfo
);
1912 if (Z_TYPE_P(info
) != IS_ARRAY
) {
1916 if (info_len
&& info_name
) {
1917 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void *) &infop
)) {
1918 RETURN_ZVAL(*infop
, 1, 0);
1920 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1924 RETURN_ZVAL(info
, 1, 0);
1930 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1932 * Get the full response as HttpMessage object after the request has been sent.
1934 * Returns an HttpMessage object of the response.
1936 * If redirects were allowed and several responses were received, the data
1937 * references the last received response. Use HttpMessage::getParentMessage()
1938 * to access the data of previously received responses within this request
1941 * Throws HttpException, HttpRuntimeException.
1943 PHP_METHOD(HttpRequest
, getResponseMessage
)
1948 SET_EH_THROW_HTTP();
1949 message
= GET_PROP(responseMessage
);
1950 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1951 RETVAL_OBJECT(message
, 1);
1953 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "HttpRequest does not contain a response message");
1960 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1962 * Get sent HTTP message.
1964 * Returns an HttpMessage object representing the sent request.
1966 * If redirects were allowed and several responses were received, the data
1967 * references the last received response. Use HttpMessage::getParentMessage()
1968 * to access the data of previously sent requests within this request
1971 * Note that the internal request message is immutable, that means that the
1972 * request message received through HttpRequest::getRequestMessage() will
1973 * always look the same for the same request, regardless of any changes you
1974 * may have made to the returned object.
1976 * Throws HttpMalformedHeadersException, HttpEncodingException.
1978 PHP_METHOD(HttpRequest
, getRequestMessage
)
1982 if (return_value_used
) {
1984 getObject(http_request_object
, obj
);
1986 SET_EH_THROW_HTTP();
1987 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1988 RETVAL_OBJVAL(http_message_object_new_ex(http_message_object_ce
, msg
, NULL
), 0);
1995 /* {{{ proto string HttpRequest::getRawRequestMessage()
1997 * Get sent HTTP message.
1999 * Returns an HttpMessage in a form of a string
2001 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
2005 if (return_value_used
) {
2006 getObject(http_request_object
, obj
);
2008 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
2013 /* {{{ proto string HttpRequest::getRawResponseMessage()
2015 * Get the entire HTTP response.
2017 * Returns the complete web server response, including the headers in a form of a string.
2019 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
2023 if (return_value_used
) {
2024 getObject(http_request_object
, obj
);
2026 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
2031 /* {{{ proto HttpMessage HttpRequest::getHistory()
2033 * Get all sent requests and received responses as an HttpMessage object.
2035 * If you want to record history, set the instance variable
2036 * HttpRequest::$recordHistory to TRUE.
2038 * Returns an HttpMessage object representing the complete request/response
2041 * The object references the last received response, use HttpMessage::getParentMessage()
2042 * to access the data of previously sent requests and received responses.
2044 * Throws HttpRuntimeException.
2046 PHP_METHOD(HttpRequest
, getHistory
)
2050 if (return_value_used
) {
2053 SET_EH_THROW_HTTP();
2054 hist
= GET_PROP(history
);
2055 if (Z_TYPE_P(hist
) == IS_OBJECT
) {
2056 RETVAL_OBJECT(hist
, 1);
2058 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "The history is empty");
2065 /* {{{ proto void HttpRequest::clearHistory()
2067 * Clear the history.
2069 PHP_METHOD(HttpRequest
, clearHistory
)
2074 MAKE_STD_ZVAL(hist
);
2076 SET_PROP(history
, hist
);
2077 zval_ptr_dtor(&hist
);
2082 /* {{{ proto HttpMessage HttpRequest::send()
2084 * Send the HTTP request.
2086 * Returns the received response as HttpMessage object.
2088 * NOTE: While an exception may be thrown, the transfer could have succeeded
2089 * at least partially, so you might want to check the return values of various
2090 * HttpRequest::getResponse*() methods.
2092 * Throws HttpRuntimeException, HttpRequestException,
2093 * HttpMalformedHeaderException, HttpEncodingException.
2098 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
2099 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
2100 * $r->addQueryData(array('category' => 3));
2103 * if ($r->getResponseCode() == 200) {
2104 * file_put_contents('local.rss', $r->getResponseBody());
2106 * } catch (HttpException $ex) {
2115 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
2116 * $r->setOptions(array('cookies' => array('lang' => 'de')));
2117 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
2118 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
2120 * echo $r->send()->getBody();
2121 * } catch (HttpException $ex) {
2127 PHP_METHOD(HttpRequest
, send
)
2129 getObject(http_request_object
, obj
);
2133 SET_EH_THROW_HTTP();
2138 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
2139 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
2140 http_request_exec(obj
->request
);
2141 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
2142 RETVAL_OBJECT(GET_PROP(responseMessage
), 1);
2150 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2157 * vim600: noet sw=4 ts=4 fdm=marker
2158 * vim<600: noet sw=4 ts=4