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(putData
, 2)
195 HTTP_ARG_VAL(data
, 0)
196 HTTP_ARG_VAL(options
, 0)
197 HTTP_ARG_VAL(info
, 1)
200 HTTP_BEGIN_ARGS(putFile
, 2)
202 HTTP_ARG_VAL(file
, 0)
203 HTTP_ARG_VAL(options
, 0)
204 HTTP_ARG_VAL(info
, 1)
207 HTTP_BEGIN_ARGS(putStream
, 2)
209 HTTP_ARG_VAL(stream
, 0)
210 HTTP_ARG_VAL(options
, 0)
211 HTTP_ARG_VAL(info
, 1)
214 HTTP_BEGIN_ARGS(methodRegister
, 1)
215 HTTP_ARG_VAL(method_name
, 0)
218 HTTP_BEGIN_ARGS(methodUnregister
, 1)
219 HTTP_ARG_VAL(method
, 0)
222 HTTP_BEGIN_ARGS(methodName
, 1)
223 HTTP_ARG_VAL(method_id
, 0)
226 HTTP_BEGIN_ARGS(methodExists
, 1)
227 HTTP_ARG_VAL(method
, 0)
230 HTTP_BEGIN_ARGS(encodeBody
, 2)
231 HTTP_ARG_VAL(fields
, 0)
232 HTTP_ARG_VAL(files
, 0)
235 #define OBJ_PROP_CE http_request_object_ce
236 zend_class_entry
*http_request_object_ce
;
237 zend_function_entry http_request_object_fe
[] = {
238 HTTP_REQUEST_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
240 HTTP_REQUEST_ME(setOptions
, ZEND_ACC_PUBLIC
)
241 HTTP_REQUEST_ME(getOptions
, ZEND_ACC_PUBLIC
)
242 HTTP_REQUEST_ME(setSslOptions
, ZEND_ACC_PUBLIC
)
243 HTTP_REQUEST_ME(getSslOptions
, ZEND_ACC_PUBLIC
)
244 HTTP_REQUEST_ME(addSslOptions
, ZEND_ACC_PUBLIC
)
246 HTTP_REQUEST_ME(addHeaders
, ZEND_ACC_PUBLIC
)
247 HTTP_REQUEST_ME(getHeaders
, ZEND_ACC_PUBLIC
)
248 HTTP_REQUEST_ME(setHeaders
, ZEND_ACC_PUBLIC
)
250 HTTP_REQUEST_ME(addCookies
, ZEND_ACC_PUBLIC
)
251 HTTP_REQUEST_ME(getCookies
, ZEND_ACC_PUBLIC
)
252 HTTP_REQUEST_ME(setCookies
, ZEND_ACC_PUBLIC
)
254 HTTP_REQUEST_ME(setMethod
, ZEND_ACC_PUBLIC
)
255 HTTP_REQUEST_ME(getMethod
, ZEND_ACC_PUBLIC
)
257 HTTP_REQUEST_ME(setUrl
, ZEND_ACC_PUBLIC
)
258 HTTP_REQUEST_ME(getUrl
, ZEND_ACC_PUBLIC
)
260 HTTP_REQUEST_ME(setContentType
, ZEND_ACC_PUBLIC
)
261 HTTP_REQUEST_ME(getContentType
, ZEND_ACC_PUBLIC
)
263 HTTP_REQUEST_ME(setQueryData
, ZEND_ACC_PUBLIC
)
264 HTTP_REQUEST_ME(getQueryData
, ZEND_ACC_PUBLIC
)
265 HTTP_REQUEST_ME(addQueryData
, ZEND_ACC_PUBLIC
)
267 HTTP_REQUEST_ME(setPostFields
, ZEND_ACC_PUBLIC
)
268 HTTP_REQUEST_ME(getPostFields
, ZEND_ACC_PUBLIC
)
269 HTTP_REQUEST_ME(addPostFields
, ZEND_ACC_PUBLIC
)
271 HTTP_REQUEST_ME(setRawPostData
, ZEND_ACC_PUBLIC
)
272 HTTP_REQUEST_ME(getRawPostData
, ZEND_ACC_PUBLIC
)
273 HTTP_REQUEST_ME(addRawPostData
, ZEND_ACC_PUBLIC
)
275 HTTP_REQUEST_ME(setPostFiles
, ZEND_ACC_PUBLIC
)
276 HTTP_REQUEST_ME(addPostFile
, ZEND_ACC_PUBLIC
)
277 HTTP_REQUEST_ME(getPostFiles
, ZEND_ACC_PUBLIC
)
279 HTTP_REQUEST_ME(setPutFile
, ZEND_ACC_PUBLIC
)
280 HTTP_REQUEST_ME(getPutFile
, ZEND_ACC_PUBLIC
)
282 HTTP_REQUEST_ME(setPutData
, ZEND_ACC_PUBLIC
)
283 HTTP_REQUEST_ME(getPutData
, ZEND_ACC_PUBLIC
)
284 HTTP_REQUEST_ME(addPutData
, ZEND_ACC_PUBLIC
)
286 HTTP_REQUEST_ME(send
, ZEND_ACC_PUBLIC
)
288 HTTP_REQUEST_ME(getResponseData
, ZEND_ACC_PUBLIC
)
289 HTTP_REQUEST_ME(getResponseHeader
, ZEND_ACC_PUBLIC
)
290 HTTP_REQUEST_ME(getResponseCookies
, ZEND_ACC_PUBLIC
)
291 HTTP_REQUEST_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
292 HTTP_REQUEST_ME(getResponseStatus
, ZEND_ACC_PUBLIC
)
293 HTTP_REQUEST_ME(getResponseBody
, ZEND_ACC_PUBLIC
)
294 HTTP_REQUEST_ME(getResponseInfo
, ZEND_ACC_PUBLIC
)
295 HTTP_REQUEST_ME(getResponseMessage
, ZEND_ACC_PUBLIC
)
296 HTTP_REQUEST_ME(getRawResponseMessage
, ZEND_ACC_PUBLIC
)
297 HTTP_REQUEST_ME(getRequestMessage
, ZEND_ACC_PUBLIC
)
298 HTTP_REQUEST_ME(getRawRequestMessage
, ZEND_ACC_PUBLIC
)
299 HTTP_REQUEST_ME(getHistory
, ZEND_ACC_PUBLIC
)
300 HTTP_REQUEST_ME(clearHistory
, ZEND_ACC_PUBLIC
)
302 HTTP_REQUEST_ALIAS(get
, http_get
)
303 HTTP_REQUEST_ALIAS(head
, http_head
)
304 HTTP_REQUEST_ALIAS(postData
, http_post_data
)
305 HTTP_REQUEST_ALIAS(postFields
, http_post_fields
)
306 HTTP_REQUEST_ALIAS(putData
, http_put_data
)
307 HTTP_REQUEST_ALIAS(putFile
, http_put_file
)
308 HTTP_REQUEST_ALIAS(putStream
, http_put_stream
)
310 HTTP_REQUEST_ALIAS(methodRegister
, http_request_method_register
)
311 HTTP_REQUEST_ALIAS(methodUnregister
, http_request_method_unregister
)
312 HTTP_REQUEST_ALIAS(methodName
, http_request_method_name
)
313 HTTP_REQUEST_ALIAS(methodExists
, http_request_method_exists
)
315 HTTP_REQUEST_ALIAS(encodeBody
, http_request_body_encode
)
319 static zend_object_handlers http_request_object_handlers
;
321 PHP_MINIT_FUNCTION(http_request_object
)
323 HTTP_REGISTER_CLASS_EX(HttpRequest
, http_request_object
, NULL
, 0);
324 http_request_object_handlers
.clone_obj
= _http_request_object_clone_obj
;
326 DCL_PROP_N(PRIVATE
, options
);
327 DCL_PROP_N(PRIVATE
, postFields
);
328 DCL_PROP_N(PRIVATE
, postFiles
);
329 DCL_PROP_N(PRIVATE
, responseInfo
);
330 DCL_PROP_N(PRIVATE
, responseData
);
331 DCL_PROP_N(PRIVATE
, responseMessage
);
332 DCL_PROP(PRIVATE
, long, responseCode
, 0);
333 DCL_PROP(PRIVATE
, string
, responseStatus
, "");
334 DCL_PROP(PRIVATE
, long, method
, HTTP_GET
);
335 DCL_PROP(PRIVATE
, string
, url
, "");
336 DCL_PROP(PRIVATE
, string
, contentType
, "");
337 DCL_PROP(PRIVATE
, string
, rawPostData
, "");
338 DCL_PROP(PRIVATE
, string
, queryData
, "");
339 DCL_PROP(PRIVATE
, string
, putFile
, "");
340 DCL_PROP(PRIVATE
, string
, putData
, "");
341 DCL_PROP_N(PRIVATE
, history
);
342 DCL_PROP(PUBLIC
, bool, recordHistory
, 0);
346 * Request Method Constants
349 DCL_CONST(long, "METH_GET", HTTP_GET
);
350 DCL_CONST(long, "METH_HEAD", HTTP_HEAD
);
351 DCL_CONST(long, "METH_POST", HTTP_POST
);
352 DCL_CONST(long, "METH_PUT", HTTP_PUT
);
353 DCL_CONST(long, "METH_DELETE", HTTP_DELETE
);
354 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS
);
355 DCL_CONST(long, "METH_TRACE", HTTP_TRACE
);
356 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT
);
357 /* WebDAV - RFC 2518 */
358 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND
);
359 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH
);
360 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL
);
361 DCL_CONST(long, "METH_COPY", HTTP_COPY
);
362 DCL_CONST(long, "METH_MOVE", HTTP_MOVE
);
363 DCL_CONST(long, "METH_LOCK", HTTP_LOCK
);
364 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK
);
365 /* WebDAV Versioning - RFC 3253 */
366 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL
);
367 DCL_CONST(long, "METH_REPORT", HTTP_REPORT
);
368 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT
);
369 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN
);
370 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT
);
371 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE
);
372 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE
);
373 DCL_CONST(long, "METH_LABEL", HTTP_LABEL
);
374 DCL_CONST(long, "METH_MERGE", HTTP_MERGE
);
375 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL
);
376 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY
);
377 /* WebDAV Access Control - RFC 3744 */
378 DCL_CONST(long, "METH_ACL", HTTP_ACL
);
381 * HTTP Protocol Version Constants
383 DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0
);
384 DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1
);
385 DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE
);
390 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC
);
391 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST
);
392 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM
);
393 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY
);
396 * Proxy Type Constants
398 # if HTTP_CURL_VERSION(7,15,2)
399 DCL_CONST(long, "PROXY_SOCKS4", CURLPROXY_SOCKS4
);
401 DCL_CONST(long, "PROXY_SOCKS5", CURLPROXY_SOCKS5
);
402 DCL_CONST(long, "PROXY_HTTP", CURLPROXY_HTTP
);
408 zend_object_value
_http_request_object_new(zend_class_entry
*ce TSRMLS_DC
)
410 return http_request_object_new_ex(ce
, NULL
, NULL
);
413 zend_object_value
_http_request_object_new_ex(zend_class_entry
*ce
, CURL
*ch
, http_request_object
**ptr TSRMLS_DC
)
415 zend_object_value ov
;
416 http_request_object
*o
;
418 o
= ecalloc(1, sizeof(http_request_object
));
420 o
->request
= http_request_init_ex(NULL
, ch
, 0, NULL
);
426 ALLOC_HASHTABLE(OBJ_PROP(o
));
427 zend_hash_init(OBJ_PROP(o
), zend_hash_num_elements(&ce
->default_properties
), NULL
, ZVAL_PTR_DTOR
, 0);
428 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
430 ov
.handle
= putObject(http_request_object
, o
);
431 ov
.handlers
= &http_request_object_handlers
;
436 zend_object_value
_http_request_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
439 zend_object_value new_ov
;
440 http_request_object
*new_obj
;
441 getObject(http_request_object
, old_obj
);
443 old_zo
= zend_objects_get_address(this_ptr TSRMLS_CC
);
444 new_ov
= http_request_object_new_ex(old_zo
->ce
, NULL
, &new_obj
);
445 if (old_obj
->request
->ch
) {
446 http_curl_init_ex(curl_easy_duphandle(old_obj
->request
->ch
), new_obj
->request
);
449 zend_objects_clone_members(&new_obj
->zo
, new_ov
, old_zo
, Z_OBJ_HANDLE_P(this_ptr
) TSRMLS_CC
);
450 phpstr_append(&new_obj
->request
->conv
.request
, old_obj
->request
->conv
.request
.data
, old_obj
->request
->conv
.request
.used
);
451 phpstr_append(&new_obj
->request
->conv
.response
, old_obj
->request
->conv
.response
.data
, old_obj
->request
->conv
.response
.used
);
456 void _http_request_object_free(zend_object
*object TSRMLS_DC
)
458 http_request_object
*o
= (http_request_object
*) object
;
461 zend_hash_destroy(OBJ_PROP(o
));
462 FREE_HASHTABLE(OBJ_PROP(o
));
464 http_request_free(&o
->request
);
468 #define http_request_object_check_request_content_type(t) _http_request_object_check_request_content_type((t) TSRMLS_CC)
469 static inline void _http_request_object_check_request_content_type(zval
*this_ptr TSRMLS_DC
)
471 zval
*ctype
= GET_PROP(contentType
);
473 if (Z_STRLEN_P(ctype
)) {
474 zval
**headers
, *opts
= GET_PROP(options
);
476 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
477 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), "headers", sizeof("headers"), (void *) &headers
)) &&
478 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
481 /* only override if not already set */
482 if ((SUCCESS
!= zend_hash_find(Z_ARRVAL_PP(headers
), "Content-Type", sizeof("Content-Type"), (void *) &ct_header
))) {
483 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
485 /* or not a string, zero length string or a string of spaces */
486 if ((Z_TYPE_PP(ct_header
) != IS_STRING
) || !Z_STRLEN_PP(ct_header
)) {
487 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
489 int i
, only_space
= 1;
491 /* check for spaces only */
492 for (i
= 0; i
< Z_STRLEN_PP(ct_header
); ++i
) {
493 if (!isspace(Z_STRVAL_PP(ct_header
)[i
])) {
499 add_assoc_stringl(*headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
505 MAKE_STD_ZVAL(headers
);
507 add_assoc_stringl(headers
, "Content-Type", Z_STRVAL_P(ctype
), Z_STRLEN_P(ctype
), 1);
508 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, headers
);
509 zval_ptr_dtor(&headers
);
514 STATUS
_http_request_object_requesthandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
516 STATUS status
= SUCCESS
;
518 http_request_reset(obj
->request
);
519 HTTP_CHECK_CURL_INIT(obj
->request
->ch
, http_curl_init(obj
->request
), return FAILURE
);
521 obj
->request
->url
= http_absolute_url(Z_STRVAL_P(GET_PROP(url
)));
523 switch (obj
->request
->meth
= Z_LVAL_P(GET_PROP(method
)))
531 zval
*put_data
= GET_PROP(putData
);
533 http_request_object_check_request_content_type(getThis());
534 if (Z_STRLEN_P(put_data
)) {
535 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
536 estrndup(Z_STRVAL_P(put_data
), Z_STRLEN_P(put_data
)), Z_STRLEN_P(put_data
), 1);
538 php_stream_statbuf ssb
;
539 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
);
541 if (stream
&& !php_stream_stat(stream
, &ssb
)) {
542 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
553 /* check for raw post data */
554 zval
*raw_data
= GET_PROP(rawPostData
);
556 if (Z_STRLEN_P(raw_data
)) {
557 http_request_object_check_request_content_type(getThis());
558 obj
->request
->body
= http_request_body_init_ex(obj
->request
->body
, HTTP_REQUEST_BODY_CSTRING
,
559 estrndup(Z_STRVAL_P(raw_data
), Z_STRLEN_P(raw_data
)), Z_STRLEN_P(raw_data
), 1);
561 zval
*zfields
= GET_PROP(postFields
), *zfiles
= GET_PROP(postFiles
);
565 fields
= (Z_TYPE_P(zfields
) == IS_ARRAY
) ? Z_ARRVAL_P(zfields
) : NULL
;
566 files
= (Z_TYPE_P(zfiles
) == IS_ARRAY
) ? Z_ARRVAL_P(zfiles
) : NULL
;
568 if ((fields
&& zend_hash_num_elements(fields
)) || (files
&& zend_hash_num_elements(files
))) {
569 if (!(obj
->request
->body
= http_request_body_fill(obj
->request
->body
, fields
, files
))) {
578 if (status
== SUCCESS
) {
579 zval
*qdata
= GET_PROP(queryData
);
580 zval
*options
= GET_PROP(options
);
582 if (Z_STRLEN_P(qdata
)) {
583 if (!strchr(obj
->request
->url
, '?')) {
584 strlcat(obj
->request
->url
, "?", HTTP_URL_MAXLEN
);
586 strlcat(obj
->request
->url
, "&", HTTP_URL_MAXLEN
);
588 strlcat(obj
->request
->url
, Z_STRVAL_P(qdata
), HTTP_URL_MAXLEN
);
591 http_request_prepare(obj
->request
, Z_ARRVAL_P(options
));
593 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
594 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onprogress", sizeof("onprogress"))) {
597 if ( (Z_TYPE_P(options
) != IS_ARRAY
)
598 || (SUCCESS
!= zend_hash_find(Z_ARRVAL_P(options
), "onprogress", sizeof("onprogress"), (void *) &entry
)
599 || (!zval_is_true(*entry
)))) {
602 ZVAL_ADDREF(getThis());
603 add_next_index_zval(pcb
, getThis());
604 add_next_index_stringl(pcb
, "onprogress", lenof("onprogress"), 1);
605 http_request_set_progress_callback(obj
->request
, pcb
);
614 STATUS
_http_request_object_responsehandler(http_request_object
*obj
, zval
*this_ptr TSRMLS_DC
)
620 /* always fetch info */
623 http_request_info(obj
->request
, Z_ARRVAL_P(info
));
624 SET_PROP(responseInfo
, info
);
625 zval_ptr_dtor(&info
);
627 /* parse response message */
628 phpstr_fix(&obj
->request
->conv
.request
);
629 phpstr_fix(&obj
->request
->conv
.response
);
631 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
)))) {
634 zval
*headers
, *message
, *resp
;
636 if (zval_is_true(GET_PROP(recordHistory
))) {
637 zval
*hist
, *history
= GET_PROP(history
);
638 http_message
*response
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.response
), PHPSTR_LEN(&obj
->request
->conv
.response
));
639 http_message
*request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
));
642 ZVAL_OBJVAL(hist
, http_message_object_new_ex(http_message_object_ce
, http_message_interconnect(response
, request
), NULL
), 0);
643 if (Z_TYPE_P(history
) == IS_OBJECT
) {
644 http_message_object_prepend(hist
, history
);
646 SET_PROP(history
, hist
);
647 zval_ptr_dtor(&hist
);
650 UPD_PROP(long, responseCode
, msg
->http
.info
.response
.code
);
651 UPD_PROP(string
, responseStatus
, msg
->http
.info
.response
.status
? msg
->http
.info
.response
.status
: "");
655 MAKE_STD_ZVAL(headers
);
657 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
658 add_assoc_zval(resp
, "headers", headers
);
659 phpstr_data(PHPSTR(msg
), &body
, &body_len
);
660 add_assoc_stringl(resp
, "body", body
, body_len
, 0);
661 SET_PROP(responseData
, resp
);
662 zval_ptr_dtor(&resp
);
664 MAKE_STD_ZVAL(message
);
665 ZVAL_OBJVAL(message
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
), 0);
666 SET_PROP(responseMessage
, message
);
667 zval_ptr_dtor(&message
);
671 /* update properties with empty values*/
672 zval
*resp
= GET_PROP(responseData
), *znull
;
674 MAKE_STD_ZVAL(znull
);
676 SET_PROP(responseMessage
, znull
);
677 zval_ptr_dtor(&znull
);
679 if (Z_TYPE_P(resp
) == IS_ARRAY
) {
680 zend_hash_clean(Z_ARRVAL_P(resp
));
683 UPD_PROP(long, responseCode
, 0);
684 UPD_PROP(string
, responseStatus
, "");
686 /* append request message to history */
687 if (zval_is_true(GET_PROP(recordHistory
))) {
688 http_message
*request
;
690 if ((request
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
691 zval
*hist
, *history
= GET_PROP(history
);
694 ZVAL_OBJVAL(hist
, http_message_object_new_ex(http_message_object_ce
, request
, NULL
), 0);
695 if (Z_TYPE_P(history
) == IS_OBJECT
) {
696 http_message_object_prepend(hist
, history
);
698 SET_PROP(history
, hist
);
699 zval_ptr_dtor(&hist
);
706 if (!EG(exception
) && zend_hash_exists(&Z_OBJCE_P(getThis())->function_table
, "onfinish", sizeof("onfinish"))) {
709 MAKE_STD_ZVAL(param
);
710 ZVAL_BOOL(param
, ret
== SUCCESS
);
711 with_error_handling(EH_NORMAL
, NULL
) {
712 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "onfinish", NULL
, param
);
713 } end_error_handling();
714 zval_ptr_dtor(¶m
);
720 static int apply_pretty_key(void *pDest
, int num_args
, va_list args
, zend_hash_key
*hash_key
)
722 if (hash_key
->nKeyLength
> 1) {
723 hash_key
->h
= zend_get_hash_value(pretty_key(hash_key
->arKey
, hash_key
->nKeyLength
- 1, 1, 0), hash_key
->nKeyLength
);
725 return ZEND_HASH_APPLY_KEEP
;
728 #define http_request_object_set_options_subr(key, ow, pk) \
729 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow), (pk))
730 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
, int overwrite
, int prettify_keys
)
732 zval
*old_opts
, *new_opts
, *opts
= NULL
, **entry
= NULL
;
734 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a/!", &opts
)) {
738 MAKE_STD_ZVAL(new_opts
);
739 array_init(new_opts
);
740 old_opts
= GET_PROP(options
);
741 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
742 array_copy(old_opts
, new_opts
);
745 if (prettify_keys
&& opts
) {
746 zend_hash_apply_with_arguments(Z_ARRVAL_P(opts
), apply_pretty_key
, 0);
748 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(new_opts
), key
, len
, (void *) &entry
)) {
750 zend_hash_clean(Z_ARRVAL_PP(entry
));
752 if (opts
&& zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
754 array_copy(opts
, *entry
);
756 array_merge(opts
, *entry
);
761 add_assoc_zval(new_opts
, key
, opts
);
763 SET_PROP(options
, new_opts
);
764 zval_ptr_dtor(&new_opts
);
769 #define http_request_object_get_options_subr(key) \
770 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
771 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS
, char *key
, size_t len
)
775 if (return_value_used
) {
776 zval
*opts
, **options
;
778 opts
= GET_PROP(options
);
779 array_init(return_value
);
781 if ( (Z_TYPE_P(opts
) == IS_ARRAY
) &&
782 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(opts
), key
, len
, (void *) &options
))) {
783 convert_to_array(*options
);
784 array_copy(*options
, return_value
);
790 /* ### USERLAND ### */
792 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
794 * Instantiate a new HttpRequest object.
796 * Accepts a string as optional parameter containing the target request url.
797 * Additionally accepts an optional int parameter specifying the request method
798 * to use and an associative array as optional third parameter which will be
799 * passed to HttpRequest::setOptions().
801 * Throws HttpException.
803 PHP_METHOD(HttpRequest
, __construct
)
808 zval
*options
= NULL
;
811 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sla", &URL
, &URL_len
, &meth
, &options
)) {
813 UPD_STRL(url
, URL
, URL_len
);
816 UPD_PROP(long, method
, meth
);
819 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setoptions", NULL
, options
);
826 /* {{{ proto bool HttpRequest::setOptions([array options])
828 * Set the request options to use. See http_get() for a full list of available options.
830 * Accepts an array as optional parameters, which values will overwrite the
831 * currently set request options. If the parameter is empty or omitted,
832 * the options of the HttpRequest object will be reset.
834 * Returns TRUE on success, or FALSE on failure.
836 PHP_METHOD(HttpRequest
, setOptions
)
841 zval
*opts
= NULL
, *old_opts
, *new_opts
, *add_opts
, **opt
;
843 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|a!/", &opts
)) {
847 MAKE_STD_ZVAL(new_opts
);
848 array_init(new_opts
);
850 if (!opts
|| !zend_hash_num_elements(Z_ARRVAL_P(opts
))) {
851 SET_PROP(options
, new_opts
);
852 zval_ptr_dtor(&new_opts
);
856 MAKE_STD_ZVAL(add_opts
);
857 array_init(add_opts
);
858 /* some options need extra attention -- thus cannot use array_merge() directly */
859 FOREACH_KEYVAL(pos
, opts
, key
, idx
, opt
) {
861 if (!strcmp(key
, "headers")) {
862 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addheaders", NULL
, *opt
);
863 } else if (!strcmp(key
, "cookies")) {
864 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addcookies", NULL
, *opt
);
865 } else if (!strcmp(key
, "ssl")) {
866 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "addssloptions", NULL
, *opt
);
867 } else if ((!strcasecmp(key
, "url")) || (!strcasecmp(key
, "uri"))) {
868 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "seturl", NULL
, *opt
);
869 } else if (!strcmp(key
, "method")) {
870 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL
, "setmethod", NULL
, *opt
);
873 add_assoc_zval(add_opts
, key
, *opt
);
880 old_opts
= GET_PROP(options
);
881 if (Z_TYPE_P(old_opts
) == IS_ARRAY
) {
882 array_copy(old_opts
, new_opts
);
884 array_merge(add_opts
, new_opts
);
885 SET_PROP(options
, new_opts
);
886 zval_ptr_dtor(&new_opts
);
887 zval_ptr_dtor(&add_opts
);
893 /* {{{ proto array HttpRequest::getOptions()
895 * Get currently set options.
897 * Returns an associative array containing currently set options.
899 PHP_METHOD(HttpRequest
, getOptions
)
903 if (return_value_used
) {
904 RETURN_PROP(options
);
909 /* {{{ proto bool HttpRequest::setSslOptions([array options])
913 * Accepts an associative array as parameter containing any SSL specific options.
914 * If the parameter is empty or omitted, the SSL options will be reset.
916 * Returns TRUE on success, or FALSE on failure.
918 PHP_METHOD(HttpRequest
, setSslOptions
)
920 http_request_object_set_options_subr("ssl", 1, 0);
924 /* {{{ proto bool HttpRequest::addSslOptions(array options)
926 * Set additional SSL options.
928 * Expects an associative array as parameter containing additional SSL specific options.
930 * Returns TRUE on success, or FALSE on failure.
932 PHP_METHOD(HttpRequest
, addSslOptions
)
934 http_request_object_set_options_subr("ssl", 0, 0);
938 /* {{{ proto array HttpRequest::getSslOtpions()
940 * Get previously set SSL options.
942 * Returns an associative array containing any previously set SSL options.
944 PHP_METHOD(HttpRequest
, getSslOptions
)
946 http_request_object_get_options_subr("ssl");
950 /* {{{ proto bool HttpRequest::addHeaders(array headers)
952 * Add request header name/value pairs.
954 * Expects an associative array as parameter containing additional header
957 * Returns TRUE on success, or FALSE on failure.
959 PHP_METHOD(HttpRequest
, addHeaders
)
961 http_request_object_set_options_subr("headers", 0, 1);
964 /* {{{ proto bool HttpRequest::setHeaders([array headers])
966 * Set request header name/value pairs.
968 * Accepts an associative array as parameter containing header name/value pairs.
969 * If the parameter is empty or omitted, all previously set headers will be unset.
971 * Returns TRUE on success, or FALSE on failure.
973 PHP_METHOD(HttpRequest
, setHeaders
)
975 http_request_object_set_options_subr("headers", 1, 1);
979 /* {{{ proto array HttpRequest::getHeaders()
981 * Get previously set request headers.
983 * Returns an associative array containing all currently set headers.
985 PHP_METHOD(HttpRequest
, getHeaders
)
987 http_request_object_get_options_subr("headers");
991 /* {{{ proto bool HttpRequest::setCookies([array cookies])
995 * Accepts an associative array as parameter containing cookie name/value pairs.
996 * If the parameter is empty or omitted, all previously set cookies will be unset.
998 * Returns TRUE on success, or FALSE on failure.
1000 PHP_METHOD(HttpRequest
, setCookies
)
1002 http_request_object_set_options_subr("cookies", 1, 0);
1006 /* {{{ proto bool HttpRequest::addCookies(array cookies)
1010 * Expects an associative array as parameter containing any cookie name/value
1013 * Returns TRUE on success, or FALSE on failure.
1015 PHP_METHOD(HttpRequest
, addCookies
)
1017 http_request_object_set_options_subr("cookies", 0, 0);
1021 /* {{{ proto array HttpRequest::getCookies()
1023 * Get previously set cookies.
1025 * Returns an associative array containing any previously set cookies.
1027 PHP_METHOD(HttpRequest
, getCookies
)
1029 http_request_object_get_options_subr("cookies");
1033 /* {{{ proto bool HttpRequest::setUrl(string url)
1035 * Set the request URL.
1037 * Expects a string as parameter specifying the request url.
1039 * Returns TRUE on success, or FALSE on failure.
1041 PHP_METHOD(HttpRequest
, setUrl
)
1046 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URL
, &URL_len
)) {
1050 UPD_STRL(url
, URL
, URL_len
);
1055 /* {{{ proto string HttpRequest::getUrl()
1057 * Get the previously set request URL.
1059 * Returns the currently set request url as string.
1061 PHP_METHOD(HttpRequest
, getUrl
)
1065 if (return_value_used
) {
1071 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1073 * Set the request method.
1075 * Expects an int as parameter specifying the request method to use.
1076 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1078 * Returns TRUE on success, or FALSE on failure.
1080 PHP_METHOD(HttpRequest
, setMethod
)
1084 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &meth
)) {
1088 UPD_PROP(long, method
, meth
);
1093 /* {{{ proto int HttpRequest::getMethod()
1095 * Get the previously set request method.
1097 * Returns the currently set request method.
1099 PHP_METHOD(HttpRequest
, getMethod
)
1103 if (return_value_used
) {
1104 RETURN_PROP(method
);
1109 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1111 * Set the content type the post request should have.
1113 * Expects a string as parameters containing the content type of the request
1114 * (primary/secondary).
1116 * Returns TRUE on success, or FALSE if the content type does not seem to
1117 * contain a primary and a secondary part.
1119 PHP_METHOD(HttpRequest
, setContentType
)
1124 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &ctype
, &ct_len
)) {
1129 HTTP_CHECK_CONTENT_TYPE(ctype
, RETURN_FALSE
);
1131 UPD_STRL(contentType
, ctype
, ct_len
);
1136 /* {{{ proto string HttpRequest::getContentType()
1138 * Get the previously content type.
1140 * Returns the previously set content type as string.
1142 PHP_METHOD(HttpRequest
, getContentType
)
1146 if (return_value_used
) {
1147 RETURN_PROP(contentType
);
1152 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1154 * Set the URL query parameters to use, overwriting previously set query parameters.
1155 * Affects any request types.
1157 * Accepts a string or associative array parameter containing the pre-encoded
1158 * query string or to be encoded query fields. If the parameter is empty or
1159 * omitted, the query data will be unset.
1161 * Returns TRUE on success, or FALSE on failure.
1163 PHP_METHOD(HttpRequest
, setQueryData
)
1167 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z!", &qdata
)) {
1171 if ((!qdata
) || Z_TYPE_P(qdata
) == IS_NULL
) {
1172 UPD_STRL(queryData
, "", 0);
1173 } else if ((Z_TYPE_P(qdata
) == IS_ARRAY
) || (Z_TYPE_P(qdata
) == IS_OBJECT
)) {
1174 char *query_data
= NULL
;
1176 if (SUCCESS
!= http_urlencode_hash(HASH_OF(qdata
), &query_data
)) {
1180 UPD_PROP(string
, queryData
, query_data
);
1185 convert_to_string_ex(&qdata
);
1186 UPD_STRL(queryData
, Z_STRVAL_P(qdata
), Z_STRLEN_P(qdata
));
1187 if (orig
!= qdata
) {
1188 zval_ptr_dtor(&qdata
);
1195 /* {{{ proto string HttpRequest::getQueryData()
1197 * Get the current query data in form of an urlencoded query string.
1199 * Returns a string containing the urlencoded query.
1201 PHP_METHOD(HttpRequest
, getQueryData
)
1205 if (return_value_used
) {
1206 RETURN_PROP(queryData
);
1211 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1213 * Add parameters to the query parameter list, leaving previously set unchanged.
1214 * Affects any request type.
1216 * Expects an associative array as parameter containing the query fields to add.
1218 * Returns TRUE on success, or FALSE on failure.
1220 PHP_METHOD(HttpRequest
, addQueryData
)
1222 zval
*qdata
, *old_qdata
;
1223 char *query_data
= NULL
;
1224 size_t query_data_len
= 0;
1226 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &qdata
)) {
1230 old_qdata
= GET_PROP(queryData
);
1232 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
)) {
1236 UPD_STRL(queryData
, query_data
, query_data_len
);
1243 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1245 * Adds POST data entries, leaving previously set unchanged, unless a
1246 * post entry with the same name already exists.
1247 * Affects only POST and custom requests.
1249 * Expects an associative array as parameter containing the post fields.
1251 * Returns TRUE on success, or FALSE on failure.
1253 PHP_METHOD(HttpRequest
, addPostFields
)
1255 zval
*post_data
, *old_post
, *new_post
;
1257 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &post_data
)) {
1261 if (zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1262 MAKE_STD_ZVAL(new_post
);
1263 array_init(new_post
);
1264 old_post
= GET_PROP(postFields
);
1265 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1266 array_copy(old_post
, new_post
);
1268 array_merge(post_data
, new_post
);
1269 SET_PROP(postFields
, new_post
);
1270 zval_ptr_dtor(&new_post
);
1277 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1279 * Set the POST data entries, overwriting previously set POST data.
1280 * Affects only POST and custom requests.
1282 * Accepts an associative array as parameter containing the post fields.
1283 * If the parameter is empty or omitted, the post data will be unset.
1285 * Returns TRUE on success, or FALSE on failure.
1287 PHP_METHOD(HttpRequest
, setPostFields
)
1289 zval
*post
, *post_data
= NULL
;
1291 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/!", &post_data
)) {
1295 MAKE_STD_ZVAL(post
);
1297 if (post_data
&& zend_hash_num_elements(Z_ARRVAL_P(post_data
))) {
1298 array_copy(post_data
, post
);
1300 SET_PROP(postFields
, post
);
1301 zval_ptr_dtor(&post
);
1307 /* {{{ proto array HttpRequest::getPostFields()
1309 * Get previously set POST data.
1311 * Returns the currently set post fields as associative array.
1313 PHP_METHOD(HttpRequest
, getPostFields
)
1317 if (return_value_used
) {
1318 RETURN_PROP(postFields
);
1323 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1325 * Set raw post data to send, overwriting previously set raw post data. Don't
1326 * forget to specify a content type. Affects only POST and custom requests.
1327 * Only either post fields or raw post data can be used for each request.
1328 * Raw post data has higher precedence and will be used even if post fields
1331 * Accepts a string as parameter containing the *raw* post data.
1333 * Returns TRUE on success, or FALSE on failure.
1335 PHP_METHOD(HttpRequest
, setRawPostData
)
1337 char *raw_data
= NULL
;
1340 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &raw_data
, &data_len
)) {
1348 UPD_STRL(rawPostData
, raw_data
, data_len
);
1353 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1355 * Add raw post data, leaving previously set raw post data unchanged.
1356 * Affects only POST and custom requests.
1358 * Expects a string as parameter containing the raw post data to concatenate.
1360 * Returns TRUE on success, or FALSE on failure.
1362 PHP_METHOD(HttpRequest
, addRawPostData
)
1367 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &raw_data
, &data_len
)) {
1372 zval
*data
= GET_PROP(rawPostData
);
1374 if (Z_STRLEN_P(data
)) {
1375 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1376 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1377 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, raw_data
, data_len
);
1379 UPD_STRL(putData
, raw_data
, data_len
);
1387 /* {{{ proto string HttpRequest::getRawPostData()
1389 * Get previously set raw post data.
1391 * Returns a string containing the currently set raw post data.
1393 PHP_METHOD(HttpRequest
, getRawPostData
)
1397 if (return_value_used
) {
1398 RETURN_PROP(rawPostData
);
1403 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1405 * Add a file to the POST request, leaving previously set files unchanged.
1406 * Affects only POST and custom requests. Cannot be used with raw post data.
1408 * Expects a string parameter containing the form element name, and a string
1409 * paremeter containing the path to the file which should be uploaded.
1410 * Additionally accepts an optional string parameter which should contain
1411 * the content type of the file.
1413 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1414 * primary and a secondary content type part.
1416 PHP_METHOD(HttpRequest
, addPostFile
)
1418 zval
*entry
, *old_post
, *new_post
;
1419 char *name
, *file
, *type
= NULL
;
1420 int name_len
, file_len
, type_len
= 0;
1422 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|s", &name
, &name_len
, &file
, &file_len
, &type
, &type_len
)) {
1427 HTTP_CHECK_CONTENT_TYPE(type
, RETURN_FALSE
);
1429 type
= "application/x-octetstream";
1430 type_len
= sizeof("application/x-octetstream") - 1;
1433 MAKE_STD_ZVAL(entry
);
1436 add_assoc_stringl(entry
, "name", name
, name_len
, 1);
1437 add_assoc_stringl(entry
, "type", type
, type_len
, 1);
1438 add_assoc_stringl(entry
, "file", file
, file_len
, 1);
1440 MAKE_STD_ZVAL(new_post
);
1441 array_init(new_post
);
1442 old_post
= GET_PROP(postFiles
);
1443 if (Z_TYPE_P(old_post
) == IS_ARRAY
) {
1444 array_copy(old_post
, new_post
);
1446 add_next_index_zval(new_post
, entry
);
1447 SET_PROP(postFiles
, new_post
);
1448 zval_ptr_dtor(&new_post
);
1454 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1456 * Set files to post, overwriting previously set post files.
1457 * Affects only POST and requests. Cannot be used with raw post data.
1459 * Accepts an array containing the files to post. Each entry should be an
1460 * associative array with "name", "file" and "type" keys. If the parameter
1461 * is empty or omitted the post files will be unset.
1463 * Returns TRUE on success, or FALSE on failure.
1465 PHP_METHOD(HttpRequest
, setPostFiles
)
1467 zval
*files
= NULL
, *post
;
1469 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!/", &files
)) {
1473 MAKE_STD_ZVAL(post
);
1475 if (files
&& (Z_TYPE_P(files
) == IS_ARRAY
)) {
1476 array_copy(files
, post
);
1478 SET_PROP(postFiles
, post
);
1479 zval_ptr_dtor(&post
);
1485 /* {{{ proto array HttpRequest::getPostFiles()
1487 * Get all previously added POST files.
1489 * Returns an array containing currently set post files.
1491 PHP_METHOD(HttpRequest
, getPostFiles
)
1495 if (return_value_used
) {
1496 RETURN_PROP(postFiles
);
1501 /* {{{ proto bool HttpRequest::setPutFile([string file])
1503 * Set file to put. Affects only PUT requests.
1505 * Accepts a string as parameter referencing the path to file.
1506 * If the parameter is empty or omitted the put file will be unset.
1508 * Returns TRUE on success, or FALSE on failure.
1510 PHP_METHOD(HttpRequest
, setPutFile
)
1515 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &file
, &file_len
)) {
1519 UPD_STRL(putFile
, file
, file_len
);
1524 /* {{{ proto string HttpRequest::getPutFile()
1526 * Get previously set put file.
1528 * Returns a string containing the path to the currently set put file.
1530 PHP_METHOD(HttpRequest
, getPutFile
)
1534 if (return_value_used
) {
1535 RETURN_PROP(putFile
);
1540 /* {{{ proto bool HttpRequest::setPutData([string put_data])
1542 * Set PUT data to send, overwriting previously set PUT data.
1543 * Affects only PUT requests.
1544 * Only either PUT data or PUT file can be used for each request.
1545 * PUT data has higher precedence and will be used even if a PUT
1548 * Accepts a string as parameter containing the data to upload.
1550 * Returns TRUE on success, or FALSE on failure.
1552 PHP_METHOD(HttpRequest
, setPutData
)
1554 char *put_data
= NULL
;
1557 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &put_data
, &data_len
)) {
1565 UPD_STRL(putData
, put_data
, data_len
);
1570 /* {{{ proto bool HttpRequest::addPutData(string put_data)
1572 * Add PUT data, leaving previously set PUT data unchanged.
1573 * Affects only PUT requests.
1575 * Expects a string as parameter containing the data to concatenate.
1577 * Returns TRUE on success, or FALSE on failure.
1579 PHP_METHOD(HttpRequest
, addPutData
)
1584 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &put_data
, &data_len
)) {
1589 zval
*data
= GET_PROP(putData
);
1591 if (Z_STRLEN_P(data
)) {
1592 Z_STRVAL_P(data
) = erealloc(Z_STRVAL_P(data
), (Z_STRLEN_P(data
) += data_len
) + 1);
1593 Z_STRVAL_P(data
)[Z_STRLEN_P(data
)] = '\0';
1594 memcpy(Z_STRVAL_P(data
) + Z_STRLEN_P(data
) - data_len
, put_data
, data_len
);
1596 UPD_STRL(putData
, put_data
, data_len
);
1604 /* {{{ proto string HttpRequest::getPutData()
1606 * Get previously set PUT data.
1608 * Returns a string containing the currently set raw post data.
1610 PHP_METHOD(HttpRequest
, getPutData
)
1614 if (return_value_used
) {
1615 RETURN_PROP(putData
);
1620 /* {{{ proto array HttpRequest::getResponseData()
1622 * Get all response data after the request has been sent.
1624 * Returns an associative array with the key "headers" containing an associative
1625 * array holding all response headers, as well as the key "body" containing a
1626 * string with the response body.
1628 * If redirects were allowed and several responses were received, the data
1629 * references the last received response.
1631 PHP_METHOD(HttpRequest
, getResponseData
)
1635 if (return_value_used
) {
1636 RETURN_PROP(responseData
);
1641 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1643 * Get response header(s) after the request has been sent.
1645 * Accepts an string as optional parameter specifying a certain header to read.
1646 * If the parameter is empty or omitted all response headers will be returned.
1648 * Returns either a string with the value of the header matching name if requested,
1649 * FALSE on failure, or an associative array containing all response headers.
1651 * If redirects were allowed and several responses were received, the data
1652 * references the last received response.
1654 PHP_METHOD(HttpRequest
, getResponseHeader
)
1656 if (return_value_used
) {
1657 zval
*data
, **headers
, **header
;
1658 char *header_name
= NULL
;
1661 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &header_name
, &header_len
)) {
1665 data
= GET_PROP(responseData
);
1666 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1667 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void *) &headers
)) &&
1668 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1669 if (!header_len
|| !header_name
) {
1670 RETVAL_ZVAL(*headers
, 1, 0);
1671 } else if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(headers
), pretty_key(header_name
, header_len
, 1, 1), header_len
+ 1, (void *) &header
)) {
1672 RETVAL_ZVAL(*header
, 1, 0);
1683 /* {{{ proto array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])
1685 * Get response cookie(s) after the request has been sent.
1687 * Returns an array of stdClass objects like http_parse_cookie would return.
1689 * If redirects were allowed and several responses were received, the data
1690 * references the last received response.
1692 PHP_METHOD(HttpRequest
, getResponseCookies
)
1694 if (return_value_used
) {
1696 zval
*allowed_extras_array
= NULL
, *data
, **headers
;
1698 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|la", &flags
, &allowed_extras_array
)) {
1702 data
= GET_PROP(responseData
);
1703 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1704 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "headers", sizeof("headers"), (void *) &headers
)) &&
1705 (Z_TYPE_PP(headers
) == IS_ARRAY
)) {
1708 char *key
= NULL
, **allowed_extras
= NULL
;
1709 zval
**header
= NULL
, **entry
= NULL
;
1710 HashPosition pos
, pos1
, pos2
;
1712 array_init(return_value
);
1714 if (allowed_extras_array
) {
1715 allowed_extras
= ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array
)) + 1, sizeof(char *));
1716 FOREACH_VAL(pos
, allowed_extras_array
, entry
) {
1717 ZVAL_ADDREF(*entry
);
1718 convert_to_string_ex(entry
);
1719 allowed_extras
[i
++] = estrndup(Z_STRVAL_PP(entry
), Z_STRLEN_PP(entry
));
1720 zval_ptr_dtor(entry
);
1724 FOREACH_HASH_KEYVAL(pos1
, Z_ARRVAL_PP(headers
), key
, idx
, header
) {
1725 if (key
&& !strcasecmp(key
, "Set-Cookie")) {
1726 http_cookie_list list
;
1728 if (Z_TYPE_PP(header
) == IS_ARRAY
) {
1729 zval
**single_header
;
1731 FOREACH_VAL(pos2
, *header
, single_header
) {
1732 ZVAL_ADDREF(*single_header
);
1733 convert_to_string_ex(single_header
);
1734 if (http_parse_cookie_ex(&list
, Z_STRVAL_PP(single_header
), flags
, allowed_extras
)) {
1737 MAKE_STD_ZVAL(cookie
);
1738 object_init(cookie
);
1739 http_cookie_list_tostruct(&list
, cookie
);
1740 add_next_index_zval(return_value
, cookie
);
1741 http_cookie_list_dtor(&list
);
1743 zval_ptr_dtor(single_header
);
1746 ZVAL_ADDREF(*header
);
1747 convert_to_string_ex(header
);
1748 if (http_parse_cookie_ex(&list
, Z_STRVAL_PP(header
), flags
, allowed_extras
)) {
1751 MAKE_STD_ZVAL(cookie
);
1752 object_init(cookie
);
1753 http_cookie_list_tostruct(&list
, cookie
);
1754 add_next_index_zval(return_value
, cookie
);
1755 http_cookie_list_dtor(&list
);
1757 zval_ptr_dtor(header
);
1764 if (allowed_extras
) {
1765 for (i
= 0; allowed_extras
[i
]; ++i
) {
1766 efree(allowed_extras
[i
]);
1768 efree(allowed_extras
);
1777 /* {{{ proto string HttpRequest::getResponseBody()
1779 * Get the response body after the request has been sent.
1781 * Returns a string containing the response body.
1783 * If redirects were allowed and several responses were received, the data
1784 * references the last received response.
1786 PHP_METHOD(HttpRequest
, getResponseBody
)
1790 if (return_value_used
) {
1792 zval
*data
= GET_PROP(responseData
);
1794 if ( (Z_TYPE_P(data
) == IS_ARRAY
) &&
1795 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(data
), "body", sizeof("body"), (void *) &body
))) {
1796 RETURN_ZVAL(*body
, 1, 0);
1804 /* {{{ proto int HttpRequest::getResponseCode()
1806 * Get the response code after the request has been sent.
1808 * Returns an int representing the response code.
1810 * If redirects were allowed and several responses were received, the data
1811 * references the last received response.
1813 PHP_METHOD(HttpRequest
, getResponseCode
)
1817 if (return_value_used
) {
1818 RETURN_PROP(responseCode
);
1823 /* {{{ proto string HttpRequest::getResponseStatus()
1825 * Get the response status (i.e. the string after the response code) after the message has been sent.
1827 * Returns a string containing the response status text.
1829 PHP_METHOD(HttpRequest
, getResponseStatus
)
1833 if (return_value_used
) {
1834 RETURN_PROP(responseStatus
);
1839 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1841 * Get response info after the request has been sent.
1842 * See http_get() for a full list of returned info.
1844 * Accepts a string as optional parameter specifying the info to read.
1845 * If the parameter is empty or omitted, an associative array containing
1846 * all available info will be returned.
1848 * Returns either a scalar containing the value of the info matching name if
1849 * requested, FALSE on failure, or an associative array containing all
1852 * If redirects were allowed and several responses were received, the data
1853 * references the last received response.
1855 PHP_METHOD(HttpRequest
, getResponseInfo
)
1857 if (return_value_used
) {
1858 zval
*info
, **infop
;
1859 char *info_name
= NULL
;
1862 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &info_name
, &info_len
)) {
1866 info
= GET_PROP(responseInfo
);
1868 if (Z_TYPE_P(info
) != IS_ARRAY
) {
1872 if (info_len
&& info_name
) {
1873 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(info
), pretty_key(info_name
, info_len
, 0, 0), info_len
+ 1, (void *) &infop
)) {
1874 RETURN_ZVAL(*infop
, 1, 0);
1876 http_error_ex(HE_NOTICE
, HTTP_E_INVALID_PARAM
, "Could not find response info named %s", info_name
);
1880 RETURN_ZVAL(info
, 1, 0);
1886 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1888 * Get the full response as HttpMessage object after the request has been sent.
1890 * Returns an HttpMessage object of the response.
1892 * If redirects were allowed and several responses were received, the data
1893 * references the last received response. Use HttpMessage::getParentMessage()
1894 * to access the data of previously received responses within this request
1897 * Throws HttpException, HttpRuntimeException.
1899 PHP_METHOD(HttpRequest
, getResponseMessage
)
1904 SET_EH_THROW_HTTP();
1905 message
= GET_PROP(responseMessage
);
1906 if (Z_TYPE_P(message
) == IS_OBJECT
) {
1907 RETVAL_OBJECT(message
, 1);
1909 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "HttpRequest does not contain a response message");
1916 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1918 * Get sent HTTP message.
1920 * Returns an HttpMessage object representing the sent request.
1922 * If redirects were allowed and several responses were received, the data
1923 * references the last received response. Use HttpMessage::getParentMessage()
1924 * to access the data of previously sent requests within this request
1927 * Note that the internal request message is immutable, that means that the
1928 * request message received through HttpRequest::getRequestMessage() will
1929 * always look the same for the same request, regardless of any changes you
1930 * may have made to the returned object.
1932 * Throws HttpMalformedHeadersException, HttpEncodingException.
1934 PHP_METHOD(HttpRequest
, getRequestMessage
)
1938 if (return_value_used
) {
1940 getObject(http_request_object
, obj
);
1942 SET_EH_THROW_HTTP();
1943 if ((msg
= http_message_parse(PHPSTR_VAL(&obj
->request
->conv
.request
), PHPSTR_LEN(&obj
->request
->conv
.request
)))) {
1944 RETVAL_OBJVAL(http_message_object_new_ex(http_message_object_ce
, msg
, NULL
), 0);
1951 /* {{{ proto string HttpRequest::getRawRequestMessage()
1953 * Get sent HTTP message.
1955 * Returns an HttpMessage in a form of a string
1957 PHP_METHOD(HttpRequest
, getRawRequestMessage
)
1961 if (return_value_used
) {
1962 getObject(http_request_object
, obj
);
1964 RETURN_PHPSTR_DUP(&obj
->request
->conv
.request
);
1969 /* {{{ proto string HttpRequest::getRawResponseMessage()
1971 * Get the entire HTTP response.
1973 * Returns the complete web server response, including the headers in a form of a string.
1975 PHP_METHOD(HttpRequest
, getRawResponseMessage
)
1979 if (return_value_used
) {
1980 getObject(http_request_object
, obj
);
1982 RETURN_PHPSTR_DUP(&obj
->request
->conv
.response
);
1987 /* {{{ proto HttpMessage HttpRequest::getHistory()
1989 * Get all sent requests and received responses as an HttpMessage object.
1991 * If you want to record history, set the instance variable
1992 * HttpRequest::$recordHistory to TRUE.
1994 * Returns an HttpMessage object representing the complete request/response
1997 * The object references the last received response, use HttpMessage::getParentMessage()
1998 * to access the data of previously sent requests and received responses.
2000 * Throws HttpRuntimeException.
2002 PHP_METHOD(HttpRequest
, getHistory
)
2006 if (return_value_used
) {
2009 SET_EH_THROW_HTTP();
2010 hist
= GET_PROP(history
);
2011 if (Z_TYPE_P(hist
) == IS_OBJECT
) {
2012 RETVAL_OBJECT(hist
, 1);
2014 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "The history is empty");
2021 /* {{{ proto void HttpRequest::clearHistory()
2023 * Clear the history.
2025 PHP_METHOD(HttpRequest
, clearHistory
)
2030 MAKE_STD_ZVAL(hist
);
2032 SET_PROP(history
, hist
);
2033 zval_ptr_dtor(&hist
);
2038 /* {{{ proto HttpMessage HttpRequest::send()
2040 * Send the HTTP request.
2042 * Returns the received response as HttpMessage object.
2044 * NOTE: While an exception may be thrown, the transfer could have succeeded
2045 * at least partially, so you might want to check the return values of various
2046 * HttpRequest::getResponse*() methods.
2048 * Throws HttpRuntimeException, HttpRequestException,
2049 * HttpMalformedHeaderException, HttpEncodingException.
2054 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
2055 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
2056 * $r->addQueryData(array('category' => 3));
2059 * if ($r->getResponseCode() == 200) {
2060 * file_put_contents('local.rss', $r->getResponseBody());
2062 * } catch (HttpException $ex) {
2071 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
2072 * $r->setOptions(array('cookies' => array('lang' => 'de')));
2073 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
2074 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
2076 * echo $r->send()->getBody();
2077 * } catch (HttpException $ex) {
2083 PHP_METHOD(HttpRequest
, send
)
2085 getObject(http_request_object
, obj
);
2089 SET_EH_THROW_HTTP();
2094 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
2095 } else if (SUCCESS
== http_request_object_requesthandler(obj
, getThis())) {
2096 http_request_exec(obj
->request
);
2097 if (SUCCESS
== http_request_object_responsehandler(obj
, getThis())) {
2098 RETVAL_OBJECT(GET_PROP(responseMessage
), 1);
2106 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2113 * vim600: noet sw=4 ts=4 fdm=marker
2114 * vim<600: noet sw=4 ts=4