2 +----------------------------------------------------------------------+
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
24 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
26 #include "php_http_std_defs.h"
27 #include "php_http_request_object.h"
28 #include "php_http_request_api.h"
29 #include "php_http_request_pool_api.h"
30 #include "php_http_api.h"
31 #include "php_http_url_api.h"
32 #include "php_http_message_api.h"
33 #include "php_http_message_object.h"
34 #include "php_http_exception_object.h"
37 # include <winsock2.h>
39 #include <curl/curl.h>
41 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, ret_ref, req_args)
42 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
43 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
45 HTTP_EMPTY_ARGS(__destruct
, 0);
46 HTTP_BEGIN_ARGS(__construct
, 0, 0)
48 HTTP_ARG_VAL(method
, 0)
51 HTTP_EMPTY_ARGS(getOptions
, 0);
52 HTTP_EMPTY_ARGS(unsetOptions
, 0);
53 HTTP_BEGIN_ARGS(setOptions
, 0, 1)
54 HTTP_ARG_VAL(options
, 0)
57 HTTP_EMPTY_ARGS(getSslOptions
, 0);
58 HTTP_EMPTY_ARGS(unsetSslOptions
, 0);
59 HTTP_BEGIN_ARGS(setSslOptions
, 0, 1)
60 HTTP_ARG_VAL(ssl_options
, 0)
63 HTTP_EMPTY_ARGS(getHeaders
, 0);
64 HTTP_EMPTY_ARGS(unsetHeaders
, 0);
65 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
66 HTTP_ARG_VAL(headers
, 0)
69 HTTP_EMPTY_ARGS(getCookies
, 0);
70 HTTP_EMPTY_ARGS(unsetCookies
, 0);
71 HTTP_BEGIN_ARGS(addCookies
, 0, 1)
72 HTTP_ARG_VAL(cookies
, 0)
75 HTTP_EMPTY_ARGS(getUrl
, 0);
76 HTTP_BEGIN_ARGS(setUrl
, 0, 1)
80 HTTP_EMPTY_ARGS(getMethod
, 0);
81 HTTP_BEGIN_ARGS(setMethod
, 0, 1)
82 HTTP_ARG_VAL(request_method
, 0)
85 HTTP_EMPTY_ARGS(getContentType
, 0);
86 HTTP_BEGIN_ARGS(setContentType
, 0, 1)
87 HTTP_ARG_VAL(content_type
, 0)
90 HTTP_EMPTY_ARGS(getQueryData
, 0);
91 HTTP_EMPTY_ARGS(unsetQueryData
, 0);
92 HTTP_BEGIN_ARGS(setQueryData
, 0, 1)
93 HTTP_ARG_VAL(query_data
, 0)
96 HTTP_BEGIN_ARGS(addQueryData
, 0, 1)
97 HTTP_ARG_VAL(query_data
, 0)
100 HTTP_EMPTY_ARGS(getPostFields
, 0);
101 HTTP_EMPTY_ARGS(unsetPostFields
, 0);
102 HTTP_BEGIN_ARGS(setPostFields
, 0, 1)
103 HTTP_ARG_VAL(post_fields
, 0)
106 HTTP_BEGIN_ARGS(addPostFields
, 0, 1)
107 HTTP_ARG_VAL(post_fields
, 0)
110 HTTP_EMPTY_ARGS(getPostFiles
, 0);
111 HTTP_EMPTY_ARGS(unsetPostFiles
, 0);
112 HTTP_BEGIN_ARGS(setPostFiles
, 0, 1)
113 HTTP_ARG_VAL(post_files
, 0)
116 HTTP_BEGIN_ARGS(addPostFile
, 0, 2)
117 HTTP_ARG_VAL(formname
, 0)
118 HTTP_ARG_VAL(filename
, 0)
119 HTTP_ARG_VAL(content_type
, 0)
122 HTTP_EMPTY_ARGS(getPutFile
, 0);
123 HTTP_EMPTY_ARGS(unsetPutFile
, 0);
124 HTTP_BEGIN_ARGS(setPutFile
, 0, 1)
125 HTTP_ARG_VAL(filename
, 0)
128 HTTP_EMPTY_ARGS(getResponseData
, 0);
129 HTTP_BEGIN_ARGS(getResponseHeader
, 0, 0)
130 HTTP_ARG_VAL(name
, 0)
133 HTTP_BEGIN_ARGS(getResponseCookie
, 0, 0)
134 HTTP_ARG_VAL(name
, 0)
137 HTTP_EMPTY_ARGS(getResponseBody
, 0);
138 HTTP_EMPTY_ARGS(getResponseCode
, 0);
139 HTTP_BEGIN_ARGS(getResponseInfo
, 0, 0)
140 HTTP_ARG_VAL(name
, 0)
143 HTTP_EMPTY_ARGS(getResponseMessage
, 1);
144 HTTP_EMPTY_ARGS(send
, 0);
146 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
147 static inline void _http_request_object_declare_default_properties(TSRMLS_D
);
149 zend_class_entry
*http_request_object_ce
;
150 zend_function_entry http_request_object_fe
[] = {
151 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
152 HTTP_REQUEST_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
154 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
155 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
156 HTTP_REQUEST_ME(unsetOptions
, ZEND_ACC_PUBLIC
)
157 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
158 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
159 HTTP_REQUEST_ME(unsetSslOptions
, ZEND_ACC_PUBLIC
)
161 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
162 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
163 HTTP_REQUEST_ME(unsetHeaders
, ZEND_ACC_PUBLIC
)
164 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
165 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
166 HTTP_REQUEST_ME(unsetCookies
, ZEND_ACC_PUBLIC
)
168 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
169 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
171 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
172 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
174 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
175 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
177 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
178 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
179 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
180 HTTP_REQUEST_ME(unsetQueryData
, ZEND_ACC_PUBLIC
)
182 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
183 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
184 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
185 HTTP_REQUEST_ME(unsetPostFields
, ZEND_ACC_PUBLIC
)
187 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
188 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
189 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
190 HTTP_REQUEST_ME(unsetPostFiles
, ZEND_ACC_PUBLIC
)
192 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
193 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
194 HTTP_REQUEST_ME(unsetPutFile
, ZEND_ACC_PUBLIC
)
196 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
198 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
199 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
200 HTTP_REQUEST_ME(getResponseCookie
, ZEND_ACC_PUBLIC
)
201 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
202 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
203 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
204 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
208 static zend_object_handlers http_request_object_handlers
;
210 void _http_request_object_init(INIT_FUNC_ARGS
)
212 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
215 HTTP_LONG_CONSTANT("HTTP_GET", HTTP_GET
);
216 HTTP_LONG_CONSTANT("HTTP_HEAD", HTTP_HEAD
);
217 HTTP_LONG_CONSTANT("HTTP_POST", HTTP_POST
);
218 HTTP_LONG_CONSTANT("HTTP_PUT", HTTP_PUT
);
219 HTTP_LONG_CONSTANT("HTTP_DELETE", HTTP_DELETE
);
220 HTTP_LONG_CONSTANT("HTTP_OPTIONS", HTTP_OPTIONS
);
221 HTTP_LONG_CONSTANT("HTTP_TRACE", HTTP_TRACE
);
222 HTTP_LONG_CONSTANT("HTTP_CONNECT", HTTP_CONNECT
);
223 /* WebDAV - RFC 2518 */
224 HTTP_LONG_CONSTANT("HTTP_PROPFIND", HTTP_PROPFIND
);
225 HTTP_LONG_CONSTANT("HTTP_PROPPATCH", HTTP_PROPPATCH
);
226 HTTP_LONG_CONSTANT("HTTP_MKCOL", HTTP_MKCOL
);
227 HTTP_LONG_CONSTANT("HTTP_COPY", HTTP_COPY
);
228 HTTP_LONG_CONSTANT("HTTP_MOVE", HTTP_MOVE
);
229 HTTP_LONG_CONSTANT("HTTP_LOCK", HTTP_LOCK
);
230 HTTP_LONG_CONSTANT("HTTP_UNLOCK", HTTP_UNLOCK
);
231 /* WebDAV Versioning - RFC 3253 */
232 HTTP_LONG_CONSTANT("HTTP_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
233 HTTP_LONG_CONSTANT("HTTP_REPORT", HTTP_REPORT
);
234 HTTP_LONG_CONSTANT("HTTP_CHECKOUT", HTTP_CHECKOUT
);
235 HTTP_LONG_CONSTANT("HTTP_CHECKIN", HTTP_CHECKIN
);
236 HTTP_LONG_CONSTANT("HTTP_UNCHECKOUT", HTTP_UNCHECKOUT
);
237 HTTP_LONG_CONSTANT("HTTP_MKWORKSPACE", HTTP_MKWORKSPACE
);
238 HTTP_LONG_CONSTANT("HTTP_UPDATE", HTTP_UPDATE
);
239 HTTP_LONG_CONSTANT("HTTP_LABEL", HTTP_LABEL
);
240 HTTP_LONG_CONSTANT("HTTP_MERGE", HTTP_MERGE
);
241 HTTP_LONG_CONSTANT("HTTP_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
242 HTTP_LONG_CONSTANT("HTTP_MKACTIVITY", HTTP_MKACTIVITY
);
243 /* WebDAV Access Control - RFC 3744 */
244 HTTP_LONG_CONSTANT("HTTP_ACL", HTTP_ACL
);
247 # if LIBCURL_VERSION_NUM >= 0x070a05
248 HTTP_LONG_CONSTANT("HTTP_AUTH_BASIC", CURLAUTH_BASIC
);
249 HTTP_LONG_CONSTANT("HTTP_AUTH_DIGEST", CURLAUTH_DIGEST
);
250 HTTP_LONG_CONSTANT("HTTP_AUTH_NTLM", CURLAUTH_NTLM
);
251 # endif /* LIBCURL_VERSION_NUM */
254 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
256 zend_object_value ov
;
257 http_request_object
*o
;
259 o
= ecalloc(1, sizeof(http_request_object
));
261 o
->ch
= curl_easy_init();
264 phpstr_init_ex(&o
->response
, HTTP_CURLBUF_SIZE
, 0);
266 ALLOC_HASHTABLE(OBJ_PROP(o
));
267 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
268 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
270 ov
.handle
= zend_objects_store_put(o
, (zend_objects_store_dtor_t
) zend_objects_destroy_object
, http_request_object_free
, NULL TSRMLS_CC
);
271 ov
.handlers
= &http_request_object_handlers
;
276 static inline void _http_request_object_declare_default_properties(TSRMLS_D
)
278 zend_class_entry
*ce
= http_request_object_ce
;
280 DCL_PROP_N(PROTECTED
, options
);
281 DCL_PROP_N(PROTECTED
, responseInfo
);
282 DCL_PROP_N(PROTECTED
, responseData
);
283 DCL_PROP_N(PROTECTED
, responseCode
);
284 DCL_PROP_N(PROTECTED
, responseMessage
);
285 DCL_PROP_N(PROTECTED
, postFields
);
286 DCL_PROP_N(PROTECTED
, postFiles
);
288 DCL_PROP(PROTECTED
, long, method
, HTTP_GET
);
290 DCL_PROP(PROTECTED
, string
, url
, "");
291 DCL_PROP(PROTECTED
, string
, contentType
, "");
292 DCL_PROP(PROTECTED
, string
, queryData
, "");
293 DCL_PROP(PROTECTED
, string
, putFile
, "");
296 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
298 http_request_object
*o
= (http_request_object
*) object
;
301 zend_hash_destroy(OBJ_PROP(o
));
302 FREE_HASHTABLE(OBJ_PROP(o
));
305 curl_easy_cleanup(o
->ch
);
307 phpstr_dtor(&o
->response
);
311 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr
, http_request_body
*body TSRMLS_DC
)
313 zval
*meth
, *URL
, *qdata
, *opts
;
320 if ((!obj
->ch
) && (!(obj
->ch
= curl_easy_init()))) {
321 http_error(E_WARNING
, HTTP_E_CURL
, "Could not initilaize curl");
325 meth
= GET_PROP(obj
, method
);
326 URL
= GET_PROP(obj
, url
);
327 qdata
= GET_PROP(obj
, queryData
);
328 opts
= GET_PROP(obj
, options
);
330 // HTTP_URI_MAXLEN+1 long char *
331 if (!(request_uri
= http_absolute_uri_ex(Z_STRVAL_P(URL
), Z_STRLEN_P(URL
), NULL
, 0, NULL
, 0, 0))) {
335 if (Z_STRLEN_P(qdata
) && (strlen(request_uri
) < HTTP_URI_MAXLEN
)) {
336 if (!strchr(request_uri
, '?')) {
337 strcat(request_uri
, "?");
339 strcat(request_uri
, "&");
341 strncat(request_uri
, Z_STRVAL_P(qdata
), HTTP_URI_MAXLEN
- strlen(request_uri
));
344 switch (Z_LVAL_P(meth
))
349 status
= http_request_init(obj
->ch
, Z_LVAL_P(meth
), request_uri
, NULL
, Z_ARRVAL_P(opts
), &obj
->response
);
355 php_stream_statbuf ssb
;
356 zval
*file
= GET_PROP(obj
, putFile
);
358 if ( (stream
= php_stream_open_wrapper(Z_STRVAL_P(file
), "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
)) &&
359 !php_stream_stat(stream
, &ssb
)) {
360 body
->type
= HTTP_REQUEST_BODY_UPLOADFILE
;
362 body
->size
= ssb
.sb
.st_size
;
364 status
= http_request_init(obj
->ch
, HTTP_PUT
, request_uri
, body
, Z_ARRVAL_P(opts
), &obj
->response
);
373 zval
*fields
= GET_PROP(obj
, postFields
), *files
= GET_PROP(obj
, postFiles
);
375 if (SUCCESS
== (status
= http_request_body_fill(body
, Z_ARRVAL_P(fields
), Z_ARRVAL_P(files
)))) {
376 status
= http_request_init(obj
->ch
, HTTP_POST
, request_uri
, body
, Z_ARRVAL_P(opts
), &obj
->response
);
383 zval
*post
= GET_PROP(obj
, postData
);
385 body
->type
= HTTP_REQUEST_BODY_CSTRING
;
386 body
->data
= Z_STRVAL_P(post
);
387 body
->size
= Z_STRLEN_P(post
);
389 status
= http_request_init(obj
->ch
, Z_LVAL_P(meth
), request_uri
, body
, Z_ARRVAL_P(opts
), &obj
->response
);
394 /* clean previous response */
395 phpstr_dtor(&obj
->response
);
401 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
405 phpstr_fix(&obj
->response
);
407 if (msg
= http_message_parse(PHPSTR_VAL(&obj
->response
), PHPSTR_LEN(&obj
->response
))) {
410 zval
*headers
, *message
, *resp
= GET_PROP(obj
, responseData
), *info
= GET_PROP(obj
, responseInfo
);
412 UPD_PROP(obj
, long, responseCode
, msg
->info
.response
.code
);
414 MAKE_STD_ZVAL(headers
)
417 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
418 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
420 add_assoc_zval(resp
, "headers", headers
);
421 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
423 MAKE_STD_ZVAL(message
);
424 message
->type
= IS_OBJECT
;
426 message
->value
.obj
= http_message_object_from_msg(msg
);
427 SET_PROP(obj
, responseMessage
, message
);
428 zval_ptr_dtor(&message
);
430 http_request_info(obj
->ch
, Z_ARRVAL_P(info
));
431 SET_PROP(obj
, responseInfo
, info
);
438 /* ### USERLAND ### */
440 /* {{{ proto void HttpRequest::__construct([string url[, long request_method = HTTP_GET]])
442 * Instantiate a new HttpRequest object which can be used to issue HEAD, GET
443 * and POST (including posting files) HTTP requests.
445 PHP_METHOD(HttpRequest
, __construct
)
450 getObject(http_request_object
, obj
);
453 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sl", &URL
, &URL_len
, &meth
)) {
454 INIT_PARR(obj
, options
);
455 INIT_PARR(obj
, responseInfo
);
456 INIT_PARR(obj
, responseData
);
457 INIT_PARR(obj
, postFields
);
458 INIT_PARR(obj
, postFiles
);
461 UPD_PROP(obj
, string
, url
, URL
);
464 UPD_PROP(obj
, long, method
, meth
);
471 /* {{{ proto void HttpRequest::__destruct()
473 * Destroys the HttpRequest object.
475 PHP_METHOD(HttpRequest
, __destruct
)
477 getObject(http_request_object
, obj
);
481 FREE_PARR(obj
, options
);
482 FREE_PARR(obj
, responseInfo
);
483 FREE_PARR(obj
, responseData
);
484 FREE_PARR(obj
, postFields
);
485 FREE_PARR(obj
, postFiles
);
489 /* {{{ proto bool HttpRequest::setOptions(array options)
491 * Set the request options to use. See http_get() for a full list of available options.
493 PHP_METHOD(HttpRequest
, setOptions
)
497 zval
*opts
, *old_opts
, **opt
;
498 getObject(http_request_object
, obj
);
500 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &opts
)) {
504 old_opts
= GET_PROP(obj
, options
);
506 /* headers and cookies need extra attention -- thus cannot use array_merge() directly */
507 FOREACH_KEYVAL(opts
, key
, idx
, opt
) {
509 if (!strcmp(key
, "headers")) {
511 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "headers", sizeof("headers"), (void **) &headers
)) {
512 array_merge(*opt
, *headers
);
515 } else if (!strcmp(key
, "cookies")) {
517 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
518 array_merge(*opt
, *cookies
);
523 add_assoc_zval(old_opts
, key
, *opt
);
534 /* {{{ proto array HttpRequest::getOptions()
536 * Get current set options.
538 PHP_METHOD(HttpRequest
, getOptions
)
544 getObject(http_request_object
, obj
);
546 opts
= GET_PROP(obj
, options
);
547 array_init(return_value
);
548 array_copy(opts
, return_value
);
553 /* {{{ proto void HttpRequest::unsetOptions()
555 * Unset all options/headers/cookies.
557 PHP_METHOD(HttpRequest
, unsetOptions
)
559 getObject(http_request_object
, obj
);
563 FREE_PARR(obj
, options
);
564 INIT_PARR(obj
, options
);
568 /* {{{ proto bool HttpRequest::setSslOptions(array options)
570 * Set additional SSL options.
572 PHP_METHOD(HttpRequest
, setSslOptions
)
574 zval
*opts
, *old_opts
, **ssl_options
;
575 getObject(http_request_object
, obj
);
577 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &opts
)) {
581 old_opts
= GET_PROP(obj
, options
);
583 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(old_opts
), "ssl", sizeof("ssl"), (void **) &ssl_options
)) {
584 array_merge(opts
, *ssl_options
);
587 add_assoc_zval(old_opts
, "ssl", opts
);
594 /* {{{ proto array HttpRequest::getSslOtpions()
596 * Get previously set SSL options.
598 PHP_METHOD(HttpRequest
, getSslOptions
)
603 zval
*opts
, **ssl_options
;
604 getObject(http_request_object
, obj
);
606 opts
= GET_PROP(obj
, options
);
608 array_init(return_value
);
610 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "ssl", sizeof("ssl"), (void **) &ssl_options
)) {
611 array_copy(*ssl_options
, return_value
);
617 /* {{{ proto void HttpRequest::unsetSslOptions()
619 * Unset previously set SSL options.
621 PHP_METHOD(HttpRequest
, unsetSslOptions
)
624 getObject(http_request_object
, obj
);
628 opts
= GET_PROP(obj
, options
);
629 zend_hash_del(Z_ARRVAL_P(opts
), "ssl", sizeof("ssl"));
633 /* {{{ proto bool HttpRequest::addHeaders(array headers)
635 * Add request header name/value pairs.
637 PHP_METHOD(HttpRequest
, addHeaders
)
639 zval
*opts
, **headers
, *new_headers
;
640 getObject(http_request_object
, obj
);
642 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &new_headers
)) {
646 opts
= GET_PROP(obj
, options
);
648 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) {
649 array_merge(new_headers
, *headers
);
651 zval_add_ref(&new_headers
);
652 add_assoc_zval(opts
, "headers", new_headers
);
659 /* {{{ proto array HttpRequest::getHeaders()
661 * Get previously set request headers.
663 PHP_METHOD(HttpRequest
, getHeaders
)
668 zval
*opts
, **headers
;
669 getObject(http_request_object
, obj
);
671 opts
= GET_PROP(obj
, options
);
673 array_init(return_value
);
675 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void **) &headers
)) {
676 array_copy(*headers
, return_value
);
682 /* {{{ proto void HttpRequest::unsetHeaders()
684 * Unset previously set request headers.
686 PHP_METHOD(HttpRequest
, unsetHeaders
)
689 getObject(http_request_object
, obj
);
693 opts
= GET_PROP(obj
, options
);
694 zend_hash_del(Z_ARRVAL_P(opts
), "headers", sizeof("headers"));
698 /* {{{ proto bool HttpRequest::addCookies(array cookies)
702 PHP_METHOD(HttpRequest
, addCookies
)
704 zval
*opts
, **cookies
, *new_cookies
;
705 getObject(http_request_object
, obj
);
707 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &new_cookies
)) {
711 opts
= GET_PROP(obj
, options
);
713 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
714 array_merge(new_cookies
, *cookies
);
716 zval_add_ref(&new_cookies
);
717 add_assoc_zval(opts
, "cookies", new_cookies
);
724 /* {{{ proto array HttpRequest::getCookies()
726 * Get previously set cookies.
728 PHP_METHOD(HttpRequest
, getCookies
)
733 zval
*opts
, **cookies
;
734 getObject(http_request_object
, obj
);
736 opts
= GET_PROP(obj
, options
);
738 array_init(return_value
);
740 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "cookies", sizeof("cookies"), (void **) &cookies
)) {
741 array_copy(*cookies
, return_value
);
747 /* {{{ proto void HttpRequest::unsetCookies()
750 PHP_METHOD(HttpRequest
, unsetCookies
)
753 getObject(http_request_object
, obj
);
757 opts
= GET_PROP(obj
, options
);
758 zend_hash_del(Z_ARRVAL_P(opts
), "cookies", sizeof("cookies"));
762 /* {{{ proto bool HttpRequest::setUrl(string url)
764 * Set the request URL.
766 PHP_METHOD(HttpRequest
, setUrl
)
770 getObject(http_request_object
, obj
);
772 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
776 UPD_PROP(obj
, string
, url
, URL
);
781 /* {{{ proto string HttpRequest::getUrl()
783 * Get the previously set request URL.
785 PHP_METHOD(HttpRequest
, getUrl
)
791 getObject(http_request_object
, obj
);
793 URL
= GET_PROP(obj
, url
);
794 RETURN_STRINGL(Z_STRVAL_P(URL
), Z_STRLEN_P(URL
), 1);
799 /* {{{ proto bool HttpRequest::setMethod(long request_method)
801 * Set the request methods; one of the <tt>HTTP_HEAD</tt>, <tt>HTTP_GET</tt> or
802 * <tt>HTTP_POST</tt> constants.
804 PHP_METHOD(HttpRequest
, setMethod
)
807 getObject(http_request_object
, obj
);
809 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
813 UPD_PROP(obj
, long, method
, meth
);
818 /* {{{ proto long HttpRequest::getMethod()
820 * Get the previously set request method.
822 PHP_METHOD(HttpRequest
, getMethod
)
828 getObject(http_request_object
, obj
);
830 meth
= GET_PROP(obj
, method
);
831 RETURN_LONG(Z_LVAL_P(meth
));
836 /* {{{ proto bool HttpRequest::setContentType(string content_type)
838 * Set the content type the post request should have.
839 * Use this only if you know what you're doing.
841 PHP_METHOD(HttpRequest
, setContentType
)
845 getObject(http_request_object
, obj
);
847 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
851 if (!strchr(ctype
, '/')) {
852 http_error_ex(E_WARNING
, HTTP_E_PARAM
, "Content-Type '%s' doesn't seem to contain a primary and a secondary part", ctype
);
856 UPD_PROP(obj
, string
, contentType
, ctype
);
861 /* {{{ proto string HttpRequest::getContentType()
863 * Get the previously content type.
865 PHP_METHOD(HttpRequest
, getContentType
)
871 getObject(http_request_object
, obj
);
873 ctype
= GET_PROP(obj
, contentType
);
874 RETURN_STRINGL(Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
879 /* {{{ proto bool HttpRequest::setQueryData(mixed query_data)
881 * Set the URL query parameters to use.
882 * Overwrites previously set query parameters.
883 * Affects any request types.
885 PHP_METHOD(HttpRequest
, setQueryData
)
888 char *query_data
= NULL
;
889 getObject(http_request_object
, obj
);
891 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &qdata
)) {
895 if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
896 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
899 UPD_PROP(obj
, string
, queryData
, query_data
);
904 convert_to_string(qdata
);
905 UPD_PROP(obj
, string
, queryData
, Z_STRVAL_P(qdata
));
910 /* {{{ proto string HttpRequest::getQueryData()
912 * Get the current query data in form of an urlencoded query string.
914 PHP_METHOD(HttpRequest
, getQueryData
)
920 getObject(http_request_object
, obj
);
922 qdata
= GET_PROP(obj
, queryData
);
923 RETURN_STRINGL(Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
), 1);
928 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
930 * Add parameters to the query parameter list.
931 * Affects any request type.
933 PHP_METHOD(HttpRequest
, addQueryData
)
935 zval
*qdata
, *old_qdata
;
936 char *query_data
= NULL
;
937 getObject(http_request_object
, obj
);
939 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &qdata
)) {
943 old_qdata
= GET_PROP(obj
, queryData
);
945 if (SUCCESS
!= http_urlencode_hash_ex(HASH_OF(qdata
), 1, Z_STRVAL_P(old_qdata
), Z_STRLEN_P(old_qdata
), &query_data
, NULL
)) {
949 UPD_PROP(obj
, string
, queryData
, query_data
);
956 /* {{{ proto void HttpRequest::unsetQueryData()
958 * Clean the query parameters.
959 * Affects any request type.
961 PHP_METHOD(HttpRequest
, unsetQueryData
)
963 getObject(http_request_object
, obj
);
967 UPD_PROP(obj
, string
, queryData
, "");
971 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
973 * Adds POST data entries.
974 * Affects only POST requests.
976 PHP_METHOD(HttpRequest
, addPostFields
)
978 zval
*post
, *post_data
;
979 getObject(http_request_object
, obj
);
981 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &post_data
)) {
985 post
= GET_PROP(obj
, postFields
);
986 array_merge(post_data
, post
);
992 /* {{{ proto bool HttpRequest::setPostFields(array post_data)
994 * Set the POST data entries.
995 * Overwrites previously set POST data.
996 * Affects only POST requests.
998 PHP_METHOD(HttpRequest
, setPostFields
)
1000 zval
*post
, *post_data
;
1001 getObject(http_request_object
, obj
);
1003 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &post_data
)) {
1007 post
= GET_PROP(obj
, postFields
);
1008 zend_hash_clean(Z_ARRVAL_P(post
));
1009 array_copy(post_data
, post
);
1015 /* {{{ proto array HttpRequest::getPostFields()
1017 * Get previously set POST data.
1019 PHP_METHOD(HttpRequest
, getPostFields
)
1025 getObject(http_request_object
, obj
);
1027 post_data
= GET_PROP(obj
, postFields
);
1028 array_init(return_value
);
1029 array_copy(post_data
, return_value
);
1034 /* {{{ proto void HttpRequest::unsetPostFields()
1036 * Clean POST data entires.
1037 * Affects only POST requests.
1039 PHP_METHOD(HttpRequest
, unsetPostFields
)
1042 getObject(http_request_object
, obj
);
1046 post_data
= GET_PROP(obj
, postFields
);
1047 zend_hash_clean(Z_ARRVAL_P(post_data
));
1051 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1053 * Add a file to the POST request.
1054 * Affects only POST requests.
1056 PHP_METHOD(HttpRequest
, addPostFile
)
1058 zval
*files
, *entry
;
1059 char *name
, *file
, *type
= NULL
;
1060 int name_len
, file_len
, type_len
= 0;
1061 getObject(http_request_object
, obj
);
1063 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1068 if (!strchr(type
, '/')) {
1069 http_error_ex(E_WARNING
, HTTP_E_PARAM
, "Content-Type '%s' doesn't seem to contain a primary and a secondary part", type
);
1073 type
= "application/x-octetstream";
1074 type_len
= sizeof("application/x-octetstream") - 1;
1077 MAKE_STD_ZVAL(entry
);
1080 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1081 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1082 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1084 files
= GET_PROP(obj
, postFiles
);
1085 add_next_index_zval(files
, entry
);
1091 /* {{{ proto bool HttpRequest::setPostFiles(array post_files)
1093 * Set files to post.
1094 * Overwrites previously set post files.
1095 * Affects only POST requests.
1097 PHP_METHOD(HttpRequest
, setPostFiles
)
1099 zval
*files
, *pFiles
;
1100 getObject(http_request_object
, obj
);
1102 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &files
)) {
1106 pFiles
= GET_PROP(obj
, postFiles
);
1107 zend_hash_clean(Z_ARRVAL_P(pFiles
));
1108 array_copy(files
, pFiles
);
1114 /* {{{ proto array HttpRequest::getPostFiles()
1116 * Get all previously added POST files.
1118 PHP_METHOD(HttpRequest
, getPostFiles
)
1124 getObject(http_request_object
, obj
);
1126 files
= GET_PROP(obj
, postFiles
);
1128 array_init(return_value
);
1129 array_copy(files
, return_value
);
1134 /* {{{ proto void HttpRequest::unsetPostFiles()
1136 * Unset the POST files list.
1137 * Affects only POST requests.
1139 PHP_METHOD(HttpRequest
, unsetPostFiles
)
1142 getObject(http_request_object
, obj
);
1146 files
= GET_PROP(obj
, postFiles
);
1147 zend_hash_clean(Z_ARRVAL_P(files
));
1151 /* {{{ proto bool HttpRequest::SetPutFile(string file)
1154 * Affects only PUT requests.
1156 PHP_METHOD(HttpRequest
, setPutFile
)
1160 getObject(http_request_object
, obj
);
1162 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &file
, &file_len
)) {
1166 UPD_PROP(obj
, string
, putFile
, file
);
1171 /* {{{ proto string HttpRequest::getPutFile()
1173 * Get previously set put file.
1175 PHP_METHOD(HttpRequest
, getPutFile
)
1181 getObject(http_request_object
, obj
);
1183 putfile
= GET_PROP(obj
, putFile
);
1184 RETVAL_STRINGL(Z_STRVAL_P(putfile
), Z_STRLEN_P(putfile
), 1);
1189 /* {{{ proto void HttpRequest::unsetPutFile()
1191 * Unset file to put.
1192 * Affects only PUT requests.
1194 PHP_METHOD(HttpRequest
, unsetPutFile
)
1196 getObject(http_request_object
, obj
);
1200 UPD_PROP(obj
, string
, putFile
, "");
1204 /* {{{ proto array HttpRequest::getResponseData()
1206 * Get all response data after the request has been sent.
1208 PHP_METHOD(HttpRequest
, getResponseData
)
1214 getObject(http_request_object
, obj
);
1216 data
= GET_PROP(obj
, responseData
);
1217 array_init(return_value
);
1218 array_copy(data
, return_value
);
1223 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1225 * Get response header(s) after the request has been sent.
1227 PHP_METHOD(HttpRequest
, getResponseHeader
)
1230 zval
*data
, **headers
, **header
;
1231 char *header_name
= NULL
;
1233 getObject(http_request_object
, obj
);
1235 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1239 data
= GET_PROP(obj
, responseData
);
1240 if (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1244 if (!header_len
|| !header_name
) {
1245 array_init(return_value
);
1246 array_copy(*headers
, return_value
);
1247 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void **) &header
)) {
1248 RETURN_STRINGL(Z_STRVAL_PP(header
), Z_STRLEN_PP(header
), 1);
1256 /* {{{ proto array HttpRequest::getResponseCookie([string name])
1258 * Get response cookie(s) after the request has been sent.
1260 PHP_METHOD(HttpRequest
, getResponseCookie
)
1263 zval
*data
, **headers
;
1264 char *cookie_name
= NULL
;
1266 getObject(http_request_object
, obj
);
1268 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &cookie_name
, &cookie_len
)) {
1272 array_init(return_value
);
1274 data
= GET_PROP(obj
, responseData
);
1275 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void **) &headers
)) {
1278 zval
**header
= NULL
;
1280 FOREACH_HASH_KEYVAL(Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1281 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1282 /* several cookies? */
1283 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1286 FOREACH_HASH_VAL(Z_ARRVAL_PP(header
), cookie
) {
1288 MAKE_STD_ZVAL(cookie_hash
);
1289 array_init(cookie_hash
);
1291 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(cookie
), Z_ARRVAL_P(cookie_hash
))) {
1293 add_next_index_zval(return_value
, cookie_hash
);
1297 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1298 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1299 add_next_index_zval(return_value
, cookie_hash
);
1300 return; /* <<< FOUND >>> */
1302 zval_dtor(cookie_hash
);
1307 zval_dtor(cookie_hash
);
1313 MAKE_STD_ZVAL(cookie_hash
);
1314 array_init(cookie_hash
);
1316 if (SUCCESS
== http_parse_cookie(Z_STRVAL_PP(header
), Z_ARRVAL_P(cookie_hash
))) {
1318 add_next_index_zval(return_value
, cookie_hash
);
1322 if ( (SUCCESS
== zend_hash_find(Z_ARRVAL_P(cookie_hash
), "name", sizeof("name"), (void **) &name
)) &&
1323 (!strcmp(Z_STRVAL_PP(name
), cookie_name
))) {
1324 add_next_index_zval(return_value
, cookie_hash
);
1326 zval_dtor(cookie_hash
);
1331 zval_dtor(cookie_hash
);
1345 /* {{{ proto string HttpRequest::getResponseBody()
1347 * Get the response body after the request has been sent.
1349 PHP_METHOD(HttpRequest
, getResponseBody
)
1355 getObject(http_request_object
, obj
);
1357 data
= GET_PROP(obj
, responseData
);
1358 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void **) &body
)) {
1359 RETURN_STRINGL(Z_STRVAL_PP(body
), Z_STRLEN_PP(body
), 1);
1367 /* {{{ proto int HttpRequest::getResponseCode()
1369 * Get the response code after the request has been sent.
1371 PHP_METHOD(HttpRequest
, getResponseCode
)
1377 getObject(http_request_object
, obj
);
1379 code
= GET_PROP(obj
, responseCode
);
1380 RETURN_LONG(Z_LVAL_P(code
));
1385 /* {{{ proto array HttpRequest::getResponseInfo([string name])
1387 * Get response info after the request has been sent.
1388 * See http_get() for a full list of returned info.
1390 PHP_METHOD(HttpRequest
, getResponseInfo
)
1393 zval
*info
, **infop
;
1394 char *info_name
= NULL
;
1396 getObject(http_request_object
, obj
);
1398 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1402 info
= GET_PROP(obj
, responseInfo
);
1404 if (info_len
&& info_name
) {
1405 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void **) &infop
)) {
1406 RETURN_ZVAL(*infop
, 1, ZVAL_PTR_DTOR
);
1408 http_error_ex(E_NOTICE
, HTTP_E_PARAM
, "Could not find response info named %s", info_name
);
1412 array_init(return_value
);
1413 array_copy(info
, return_value
);
1419 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1421 * Get the full response as HttpMessage object.
1423 PHP_METHOD(HttpRequest
, getResponseMessage
)
1429 getObject(http_request_object
, obj
);
1431 message
= GET_PROP(obj
, responseMessage
);
1432 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1433 RETVAL_OBJECT(message
);
1441 /* {{{ proto bool HttpRequest::send()
1443 * Send the HTTP request.
1448 * $r = new HttpRequest('http://example.com/feed.rss', HTTP_GET);
1449 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
1450 * $r->addQueryData(array('category' => 3));
1453 * if ($r->getResponseCode() == 200) {
1454 * file_put_contents('local.rss', $r->getResponseBody());
1456 * } catch (HttpException $ex) {
1465 * $r = new HttpRequest('http://example.com/form.php', HTTP_POST);
1466 * $r->setOptions(array('cookies' => array('lang' => 'de')));
1467 * $r->addpostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
1468 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
1470 * echo $r->getResponseBody();
1475 PHP_METHOD(HttpRequest
, send
)
1477 STATUS status
= FAILURE
;
1478 http_request_body body
= {0};
1479 getObject(http_request_object
, obj
);
1483 SET_EH_THROW_HTTP();
1486 http_error(E_WARNING
, HTTP_E_CURL
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
1491 if (SUCCESS
== (status
= http_request_object_requesthandler(obj
, getThis(), &body
))) {
1492 status
= http_request_exec(obj
->ch
, NULL
);
1494 http_request_body_dtor(&body
);
1496 /* final data handling */
1497 if (SUCCESS
== status
) {
1498 status
= http_request_object_responsehandler(obj
, getThis());
1502 RETURN_SUCCESS(status
);
1506 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
1513 * vim600: noet sw=4 ts=4 fdm=marker
1514 * vim<600: noet sw=4 ts=4