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_SAPI
16 #define HTTP_WANT_CURL
17 #define HTTP_WANT_ZLIB
21 #include "ext/standard/php_string.h"
22 #include "zend_operators.h"
24 #ifdef HTTP_HAVE_SESSION
25 # include "ext/session/php_session.h"
28 #include "php_http_api.h"
29 #include "php_http_cache_api.h"
30 #include "php_http_cookie_api.h"
31 #include "php_http_date_api.h"
32 #include "php_http_encoding_api.h"
33 #include "php_http_headers_api.h"
34 #include "php_http_message_api.h"
35 #include "php_http_request_api.h"
36 #include "php_http_request_method_api.h"
37 #include "php_http_persistent_handle_api.h"
38 #include "php_http_send_api.h"
39 #include "php_http_url_api.h"
41 /* {{{ proto string http_date([int timestamp])
42 Compose a valid HTTP date regarding RFC 1123 looking like: "Wed, 22 Dec 2004 11:34:47 GMT" */
43 PHP_FUNCTION(http_date
)
47 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
52 t
= HTTP_G
->request
.time
;
55 RETURN_STRING(http_date(t
), 0);
59 /* {{{ proto string http_build_url([mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]]])
61 PHP_FUNCTION(http_build_url
)
65 long flags
= HTTP_URL_REPLACE
;
66 zval
*z_old_url
= NULL
, *z_new_url
= NULL
, *z_composed_url
= NULL
;
67 php_url
*old_url
= NULL
, *new_url
= NULL
, *composed_url
= NULL
;
69 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|z!/z!/lz", &z_old_url
, &z_new_url
, &flags
, &z_composed_url
) != SUCCESS
) {
74 if (Z_TYPE_P(z_new_url
) == IS_ARRAY
|| Z_TYPE_P(z_new_url
) == IS_OBJECT
) {
75 new_url
= http_url_from_struct(NULL
, HASH_OF(z_new_url
));
77 convert_to_string(z_new_url
);
78 if (!(new_url
= php_url_parse_ex(Z_STRVAL_P(z_new_url
), Z_STRLEN_P(z_new_url
)))) {
79 http_error_ex(HE_WARNING
, HTTP_E_URL
, "Could not parse URL (%s)", Z_STRVAL_P(z_new_url
));
86 if (Z_TYPE_P(z_old_url
) == IS_ARRAY
|| Z_TYPE_P(z_old_url
) == IS_OBJECT
) {
87 old_url
= http_url_from_struct(NULL
, HASH_OF(z_old_url
));
89 convert_to_string(z_old_url
);
90 if (!(old_url
= php_url_parse_ex(Z_STRVAL_P(z_old_url
), Z_STRLEN_P(z_old_url
)))) {
92 php_url_free(new_url
);
94 http_error_ex(HE_WARNING
, HTTP_E_URL
, "Could not parse URL (%s)", Z_STRVAL_P(z_old_url
));
100 if (z_composed_url
) {
101 http_build_url(flags
, old_url
, new_url
, &composed_url
, &url_str
, &url_len
);
102 http_url_tostruct(composed_url
, z_composed_url
);
103 php_url_free(composed_url
);
105 http_build_url(flags
, old_url
, new_url
, NULL
, &url_str
, &url_len
);
109 php_url_free(new_url
);
112 php_url_free(old_url
);
115 RETURN_STRINGL(url_str
, url_len
, 0);
119 /* {{{ proto string http_build_str(array query [, string prefix[, string arg_separator]])
120 Opponent to parse_str(). */
121 PHP_FUNCTION(http_build_str
)
124 char *prefix
= NULL
, *arg_sep
= INI_STR("arg_separator.output");
125 int prefix_len
= 0, arg_sep_len
= strlen(arg_sep
);
128 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|ss", &formdata
, &prefix
, &prefix_len
, &arg_sep
, &arg_sep_len
) != SUCCESS
) {
133 arg_sep
= HTTP_URL_ARGSEP
;
134 arg_sep_len
= lenof(HTTP_URL_ARGSEP
);
137 phpstr_init(&formstr
);
138 if (SUCCESS
!= http_urlencode_hash_recursive(HASH_OF(formdata
), &formstr
, arg_sep
, arg_sep_len
, prefix
, prefix_len
)) {
143 phpstr_dtor(&formstr
);
147 RETURN_PHPSTR_VAL(&formstr
);
151 #define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
154 if ((result = http_negotiate_ ##type(supported))) { \
159 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
160 RETVAL_STRINGL(key, key_len-1, 0); \
166 zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
169 zend_hash_destroy(result); \
170 FREE_HASHTABLE(result); \
175 zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
176 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void *) &value)) { \
177 RETVAL_ZVAL(*value, 1, 0); \
186 FOREACH_VAL(pos, supported, value) { \
187 convert_to_string_ex(value); \
188 add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
194 /* {{{ proto string http_negotiate_language(array supported[, array &result])
195 Negotiate the clients preferred language. */
196 PHP_FUNCTION(http_negotiate_language
)
198 zval
*supported
, *rs_array
= NULL
;
200 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
206 array_init(rs_array
);
209 HTTP_DO_NEGOTIATE(language
, supported
, rs_array
);
213 /* {{{ proto string http_negotiate_charset(array supported[, array &result])
214 Negotiate the clients preferred charset. */
215 PHP_FUNCTION(http_negotiate_charset
)
217 zval
*supported
, *rs_array
= NULL
;
219 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
225 array_init(rs_array
);
228 HTTP_DO_NEGOTIATE(charset
, supported
, rs_array
);
232 /* {{{ proto string http_negotiate_ctype(array supported[, array &result])
233 Negotiate the clients preferred content type. */
234 PHP_FUNCTION(http_negotiate_content_type
)
236 zval
*supported
, *rs_array
= NULL
;
238 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
)) {
244 array_init(rs_array
);
247 HTTP_DO_NEGOTIATE(content_type
, supported
, rs_array
);
251 /* {{{ proto bool http_send_status(int status)
252 Send HTTP status code. */
253 PHP_FUNCTION(http_send_status
)
257 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &status
) != SUCCESS
) {
260 if (status
< 100 || status
> 510) {
261 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Invalid HTTP status code (100-510): %d", status
);
265 RETURN_SUCCESS(http_send_status(status
));
269 /* {{{ proto bool http_send_last_modified([int timestamp])
270 Send a "Last-Modified" header with a valid HTTP date. */
271 PHP_FUNCTION(http_send_last_modified
)
275 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
280 t
= HTTP_G
->request
.time
;
283 RETURN_SUCCESS(http_send_last_modified(t
));
287 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
288 Send the Content-Type of the sent entity. This is particularly important if you use the http_send() API. */
289 PHP_FUNCTION(http_send_content_type
)
291 char *ct
= "application/x-octetstream";
292 int ct_len
= lenof("application/x-octetstream");
294 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &ct
, &ct_len
) != SUCCESS
) {
298 RETURN_SUCCESS(http_send_content_type(ct
, ct_len
));
302 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
303 Send the Content-Disposition. */
304 PHP_FUNCTION(http_send_content_disposition
)
308 zend_bool send_inline
= 0;
310 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &filename
, &f_len
, &send_inline
) != SUCCESS
) {
313 RETURN_SUCCESS(http_send_content_disposition(filename
, f_len
, send_inline
));
317 /* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
318 Matches the given unix timestamp against the clients "If-Modified-Since" resp. "If-Unmodified-Since" HTTP headers. */
319 PHP_FUNCTION(http_match_modified
)
322 zend_bool for_range
= 0;
324 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|lb", &t
, &for_range
) != SUCCESS
) {
328 // current time if not supplied (senseless though)
330 t
= HTTP_G
->request
.time
;
334 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t
));
336 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t
));
340 /* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
341 Matches the given ETag against the clients "If-Match" resp. "If-None-Match" HTTP headers. */
342 PHP_FUNCTION(http_match_etag
)
346 zend_bool for_range
= 0;
348 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &etag
, &etag_len
, &for_range
) != SUCCESS
) {
353 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag
));
355 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag
));
359 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
360 Attempts to cache the sent entity by its last modification date. */
361 PHP_FUNCTION(http_cache_last_modified
)
363 long last_modified
= 0, send_modified
= 0, t
;
366 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &last_modified
) != SUCCESS
) {
370 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
372 t
= HTTP_G
->request
.time
;
375 if (!last_modified
) {
376 /* does the client have? (att: caching "forever") */
377 if ((zlm
= http_get_server_var("HTTP_IF_MODIFIED_SINCE", 1))) {
378 last_modified
= send_modified
= http_parse_date(Z_STRVAL_P(zlm
));
379 /* send current time */
383 /* negative value is supposed to be expiration time */
384 } else if (last_modified
< 0) {
387 /* send supplied time explicitly */
389 send_modified
= last_modified
;
392 RETURN_SUCCESS(http_cache_last_modified(last_modified
, send_modified
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
396 /* {{{ proto bool http_cache_etag([string etag])
397 Attempts to cache the sent entity by its ETag, either supplied or generated by the hash algorithm specified by the INI setting "http.etag.mode". */
398 PHP_FUNCTION(http_cache_etag
)
403 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &etag
, &etag_len
) != SUCCESS
) {
407 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
409 RETURN_SUCCESS(http_cache_etag(etag
, etag_len
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
413 /* {{{ proto string ob_etaghandler(string data, int mode)
414 For use with ob_start(). Output buffer handler generating an ETag with the hash algorithm specified with the INI setting "http.etag.mode". */
415 PHP_FUNCTION(ob_etaghandler
)
421 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
425 Z_TYPE_P(return_value
) = IS_STRING
;
426 http_ob_etaghandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
430 /* {{{ proto void http_throttle(double sec[, int bytes = 40960])
431 Sets the throttle delay and send buffer size for use with http_send() API. */
432 PHP_FUNCTION(http_throttle
)
434 long chunk_size
= HTTP_SENDBUF_SIZE
;
437 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d|l", &interval
, &chunk_size
)) {
441 HTTP_G
->send
.throttle_delay
= interval
;
442 HTTP_G
->send
.buffer_size
= chunk_size
;
446 /* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
447 Redirect to the given url. */
448 PHP_FUNCTION(http_redirect
)
451 size_t query_len
= 0;
452 zend_bool session
= 0, free_params
= 0;
454 long status
= HTTP_REDIRECT
;
455 char *query
= NULL
, *url
= NULL
, *URI
, *LOC
, *RED
= NULL
;
457 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sa!/bl", &url
, &url_len
, ¶ms
, &session
, &status
) != SUCCESS
) {
461 #ifdef HTTP_HAVE_SESSION
462 /* append session info */
466 MAKE_STD_ZVAL(params
);
469 if (PS(session_status
) == php_session_active
) {
470 if (add_assoc_string(params
, PS(session_name
), PS(id
), 1) != SUCCESS
) {
471 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
477 /* treat params array with http_build_query() */
479 if (SUCCESS
!= http_urlencode_hash_ex(Z_ARRVAL_P(params
), 0, NULL
, 0, &query
, &query_len
)) {
491 URI
= http_absolute_url(url
);
494 spprintf(&LOC
, 0, "Location: %s?%s", URI
, query
);
496 spprintf(&RED
, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI
, query
, URI
, query
);
499 spprintf(&LOC
, 0, "Location: %s", URI
);
501 spprintf(&RED
, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI
, URI
);
516 RETVAL_SUCCESS(http_send_status_header(status
, LOC
));
520 case HTTP_REDIRECT_PERM
:
521 case HTTP_REDIRECT_FOUND
:
522 case HTTP_REDIRECT_POST
:
523 case HTTP_REDIRECT_PROXY
:
524 case HTTP_REDIRECT_TEMP
:
529 http_error_ex(HE_NOTICE
, HTTP_E_RUNTIME
, "Unsupported redirection status code: %ld", status
);
531 if ( SG(request_info
).request_method
&&
532 strcasecmp(SG(request_info
).request_method
, "HEAD") &&
533 strcasecmp(SG(request_info
).request_method
, "GET")) {
534 status
= HTTP_REDIRECT_POST
;
536 status
= HTTP_REDIRECT_FOUND
;
541 RETURN_SUCCESS(http_exit_ex(status
, LOC
, RED
, 1));
545 /* {{{ proto bool http_send_data(string data)
546 Sends raw data with support for (multiple) range requests. */
547 PHP_FUNCTION(http_send_data
)
552 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data_buf
, &data_len
) != SUCCESS
) {
556 RETURN_SUCCESS(http_send_data(data_buf
, data_len
));
560 /* {{{ proto bool http_send_file(string file)
561 Sends a file with support for (multiple) range requests. */
562 PHP_FUNCTION(http_send_file
)
567 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &file
, &flen
) != SUCCESS
) {
574 RETURN_SUCCESS(http_send_file(file
));
578 /* {{{ proto bool http_send_stream(resource stream)
579 Sends an already opened stream with support for (multiple) range requests. */
580 PHP_FUNCTION(http_send_stream
)
585 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &zstream
) != SUCCESS
) {
589 php_stream_from_zval(file
, &zstream
);
590 RETURN_SUCCESS(http_send_stream(file
));
594 /* {{{ proto string http_chunked_decode(string encoded)
595 Decodes a string that was HTTP-chunked encoded. */
596 PHP_FUNCTION(http_chunked_decode
)
598 char *encoded
= NULL
, *decoded
= NULL
;
599 size_t decoded_len
= 0;
602 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &encoded
, &encoded_len
) != SUCCESS
) {
606 if (NULL
!= http_encoding_dechunk(encoded
, encoded_len
, &decoded
, &decoded_len
)) {
607 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
614 /* {{{ proto object http_parse_message(string message)
615 Parses (a) http_message(s) into a simple recursive object structure. */
616 PHP_FUNCTION(http_parse_message
)
620 http_message
*msg
= NULL
;
622 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &message
, &message_len
)) {
626 if ((msg
= http_message_parse(message
, message_len
))) {
627 object_init(return_value
);
628 http_message_tostruct_recursive(msg
, return_value
);
629 http_message_free(&msg
);
636 /* {{{ proto array http_parse_headers(string header)
637 Parses HTTP headers into an associative array. */
638 PHP_FUNCTION(http_parse_headers
)
643 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &header
, &header_len
)) {
647 array_init(return_value
);
648 if (SUCCESS
!= http_parse_headers(header
, return_value
)) {
649 zval_dtor(return_value
);
650 http_error(HE_WARNING
, HTTP_E_MALFORMED_HEADERS
, "Failed to parse headers");
656 /* {{{ proto object http_parse_cookie(string cookie[, int flags[, array allowed_extras]])
657 Parses HTTP cookies like sent in a response into a struct. */
658 PHP_FUNCTION(http_parse_cookie
)
660 char *cookie
, **allowed_extras
= NULL
;
661 int i
= 0, cookie_len
;
663 zval
*allowed_extras_array
= NULL
, **entry
= NULL
;
665 http_cookie_list list
;
667 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|la!", &cookie
, &cookie_len
, &flags
, &allowed_extras_array
)) {
671 if (allowed_extras_array
) {
672 allowed_extras
= ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array
)) + 1, sizeof(char *));
673 FOREACH_VAL(pos
, allowed_extras_array
, entry
) {
675 convert_to_string_ex(entry
);
676 allowed_extras
[i
++] = estrndup(Z_STRVAL_PP(entry
), Z_STRLEN_PP(entry
));
677 zval_ptr_dtor(entry
);
681 if (http_parse_cookie_ex(&list
, cookie
, flags
, allowed_extras
)) {
682 object_init(return_value
);
683 http_cookie_list_tostruct(&list
, return_value
);
684 http_cookie_list_dtor(&list
);
689 if (allowed_extras
) {
690 for (i
= 0; allowed_extras
[i
]; ++i
) {
691 efree(allowed_extras
[i
]);
693 efree(allowed_extras
);
698 /* {{{ proto string http_build_cookie(array cookie)
699 Build a cookie string from an array/object like returned by http_parse_cookie(). */
700 PHP_FUNCTION(http_build_cookie
)
705 http_cookie_list list
;
707 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a", &strct
)) {
711 http_cookie_list_fromstruct(&list
, strct
);
712 http_cookie_list_tostring(&list
, &str
, &len
);
713 http_cookie_list_dtor(&list
);
715 RETURN_STRINGL(str
, len
, 0);
719 /* {{{ proto object http_parse_params(string param[, int flags = HTTP_PARAMS_DEFAULT])
720 Parse parameter list. */
721 PHP_FUNCTION(http_parse_params
)
726 long flags
= HTTP_PARAMS_DEFAULT
;
728 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", ¶m
, ¶m_len
, &flags
)) {
732 params
= ecalloc(1, sizeof(zval
));
734 if (SUCCESS
!= http_parse_params(param
, flags
, Z_ARRVAL_P(params
))) {
739 object_init(return_value
);
740 add_property_zval(return_value
, "params", params
);
744 /* {{{ proto array http_get_request_headers(void)
745 Get a list of incoming HTTP headers. */
746 PHP_FUNCTION(http_get_request_headers
)
750 array_init(return_value
);
751 http_get_request_headers(Z_ARRVAL_P(return_value
));
755 /* {{{ proto string http_get_request_body(void)
756 Get the raw request body (e.g. POST or PUT data). */
757 PHP_FUNCTION(http_get_request_body
)
764 if (SUCCESS
== http_get_request_body(&body
, &length
)) {
765 RETURN_STRINGL(body
, (int) length
, 0);
772 /* {{{ proto resource http_get_request_body_stream(void)
773 Create a stream to read the raw request body (e.g. POST or PUT data). This function can only be used once if the request method was another than POST. */
774 PHP_FUNCTION(http_get_request_body_stream
)
780 if ((s
= http_get_request_body_stream())) {
781 php_stream_to_zval(s
, return_value
);
783 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Failed to create request body stream");
789 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
790 Match an incoming HTTP header. */
791 PHP_FUNCTION(http_match_request_header
)
793 char *header
, *value
;
794 int header_len
, value_len
;
795 zend_bool match_case
= 0;
797 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|b", &header
, &header_len
, &value
, &value_len
, &match_case
)) {
801 RETURN_BOOL(http_match_request_header_ex(header
, value
, match_case
));
806 #ifdef HTTP_HAVE_CURL
807 #ifdef HTTP_HAVE_PERSISTENT_HANDLES
809 /* {{{ proto object http_persistent_handles_count() */
810 PHP_FUNCTION(http_persistent_handles_count
)
818 if ((n
= http_persistent_handle_statall(&names
, &counts
))) {
819 object_init(return_value
);
820 for (i
= 0; i
< n
; ++i
) {
821 add_property_long(return_value
, names
[i
], counts
[i
]);
830 /* {{{ proto void http_persistent_handles_clean([string name]) */
831 PHP_FUNCTION(http_persistent_handles_clean
)
833 char *name_str
= NULL
;
836 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &name_str
, &name_len
)) {
837 http_persistent_handle_cleanup_ex(name_str
, name_len
);
842 #endif /* HTTP_HAVE_PERSISTENT_HANDLES */
844 #define RETVAL_RESPONSE_OR_BODY(request) \
848 /* check if only the body should be returned */ \
849 if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void *) &bodyonly)) && zval_is_true(*bodyonly)) { \
850 http_message *msg = http_message_parse(PHPSTR_VAL(&request.conv.response), PHPSTR_LEN(&request.conv.response)); \
853 RETVAL_STRINGL(PHPSTR_VAL(&msg->body), PHPSTR_LEN(&msg->body), 1); \
854 http_message_free(&msg); \
857 RETVAL_STRINGL(request.conv.response.data, request.conv.response.used, 1); \
861 /* {{{ proto string http_get(string url[, array options[, array &info]])
862 Performs an HTTP GET request on the supplied url. */
863 PHP_FUNCTION(http_get
)
865 zval
*options
= NULL
, *info
= NULL
;
868 http_request request
;
870 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
881 http_request_init_ex(&request
, NULL
, HTTP_GET
, URL
);
882 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
883 http_request_exec(&request
);
885 http_request_info(&request
, Z_ARRVAL_P(info
));
887 RETVAL_RESPONSE_OR_BODY(request
);
889 http_request_dtor(&request
);
893 /* {{{ proto string http_head(string url[, array options[, array &info]])
894 Performs an HTTP HEAD request on the supplied url. */
895 PHP_FUNCTION(http_head
)
897 zval
*options
= NULL
, *info
= NULL
;
900 http_request request
;
902 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
913 http_request_init_ex(&request
, NULL
, HTTP_HEAD
, URL
);
914 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
915 http_request_exec(&request
);
917 http_request_info(&request
, Z_ARRVAL_P(info
));
919 RETVAL_RESPONSE_OR_BODY(request
);
921 http_request_dtor(&request
);
925 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
926 Performs an HTTP POST request on the supplied url. */
927 PHP_FUNCTION(http_post_data
)
929 zval
*options
= NULL
, *info
= NULL
;
930 char *URL
, *postdata
;
931 int postdata_len
, URL_len
;
932 http_request_body body
;
933 http_request request
;
935 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &postdata
, &postdata_len
, &options
, &info
) != SUCCESS
) {
946 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
947 request
.body
= http_request_body_init_ex(&body
, HTTP_REQUEST_BODY_CSTRING
, postdata
, postdata_len
, 0);
948 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
949 http_request_exec(&request
);
951 http_request_info(&request
, Z_ARRVAL_P(info
));
953 RETVAL_RESPONSE_OR_BODY(request
);
955 http_request_dtor(&request
);
959 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
960 Performs an HTTP POST request on the supplied url. */
961 PHP_FUNCTION(http_post_fields
)
963 zval
*options
= NULL
, *info
= NULL
, *fields
= NULL
, *files
= NULL
;
966 http_request_body body
;
967 http_request request
;
969 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sa!|a!a/!z", &URL
, &URL_len
, &fields
, &files
, &options
, &info
) != SUCCESS
) {
973 if (!http_request_body_fill(&body
, fields
? Z_ARRVAL_P(fields
) : NULL
, files
? Z_ARRVAL_P(files
) : NULL
)) {
984 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
985 request
.body
= &body
;
986 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
987 http_request_exec(&request
);
989 http_request_info(&request
, Z_ARRVAL_P(info
));
991 RETVAL_RESPONSE_OR_BODY(request
);
993 http_request_dtor(&request
);
997 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
998 Performs an HTTP PUT request on the supplied url. */
999 PHP_FUNCTION(http_put_file
)
1003 zval
*options
= NULL
, *info
= NULL
;
1005 php_stream_statbuf ssb
;
1006 http_request_body body
;
1007 http_request request
;
1009 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &file
, &f_len
, &options
, &info
)) {
1013 if (!(stream
= php_stream_open_wrapper_ex(file
, "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
, HTTP_DEFAULT_STREAM_CONTEXT
))) {
1016 if (php_stream_stat(stream
, &ssb
)) {
1017 php_stream_close(stream
);
1028 http_request_init_ex(&request
, NULL
, HTTP_PUT
, URL
);
1029 request
.body
= http_request_body_init_ex(&body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 1);
1030 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1031 http_request_exec(&request
);
1033 http_request_info(&request
, Z_ARRVAL_P(info
));
1035 RETVAL_RESPONSE_OR_BODY(request
);
1037 http_request_dtor(&request
);
1041 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1042 Performs an HTTP PUT request on the supplied url. */
1043 PHP_FUNCTION(http_put_stream
)
1045 zval
*resource
, *options
= NULL
, *info
= NULL
;
1049 php_stream_statbuf ssb
;
1050 http_request_body body
;
1051 http_request request
;
1053 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sr|a/!z", &URL
, &URL_len
, &resource
, &options
, &info
)) {
1057 php_stream_from_zval(stream
, &resource
);
1058 if (php_stream_stat(stream
, &ssb
)) {
1069 http_request_init_ex(&request
, NULL
, HTTP_PUT
, URL
);
1070 request
.body
= http_request_body_init_ex(&body
, HTTP_REQUEST_BODY_UPLOADFILE
, stream
, ssb
.sb
.st_size
, 0);
1071 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1072 http_request_exec(&request
);
1074 http_request_info(&request
, Z_ARRVAL_P(info
));
1076 RETVAL_RESPONSE_OR_BODY(request
);
1078 http_request_dtor(&request
);
1082 /* {{{ proto string http_put_data(string url, string data[, array options[, array &info]])
1083 Performs an HTTP PUT request on the supplied url. */
1084 PHP_FUNCTION(http_put_data
)
1087 int URL_len
, data_len
;
1088 zval
*options
= NULL
, *info
= NULL
;
1089 http_request_body body
;
1090 http_request request
;
1092 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &data
, &data_len
, &options
, &info
)) {
1103 http_request_init_ex(&request
, NULL
, HTTP_PUT
, URL
);
1104 request
.body
= http_request_body_init_ex(&body
, HTTP_REQUEST_BODY_CSTRING
, data
, data_len
, 0);
1105 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1106 http_request_exec(&request
);
1108 http_request_info(&request
, Z_ARRVAL_P(info
));
1110 RETVAL_RESPONSE_OR_BODY(request
);
1112 http_request_dtor(&request
);
1116 /* {{{ proto string http_request(int method, string url[, string body[, array options[, array &info]]])
1117 Performs a custom HTTP request on the supplied url. */
1118 PHP_FUNCTION(http_request
)
1121 char *URL
, *data
= NULL
;
1122 int URL_len
, data_len
= 0;
1123 zval
*options
= NULL
, *info
= NULL
;
1124 http_request_body body
;
1125 http_request request
;
1127 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ls|sa/!z", &meth
, &URL
, &URL_len
, &data
, &data_len
, &options
, &info
)) {
1138 http_request_init_ex(&request
, NULL
, meth
, URL
);
1139 request
.body
= http_request_body_init_ex(&body
, HTTP_REQUEST_BODY_CSTRING
, data
, data_len
, 0);
1140 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1141 http_request_exec(&request
);
1143 http_request_info(&request
, Z_ARRVAL_P(info
));
1145 RETVAL_RESPONSE_OR_BODY(request
);
1147 http_request_dtor(&request
);
1151 /* {{{ proto string http_request_body_encode(array fields, array files)
1152 Generate x-www-form-urlencoded resp. form-data encoded request body. */
1153 PHP_FUNCTION(http_request_body_encode
)
1155 zval
*fields
= NULL
, *files
= NULL
;
1156 HashTable
*fields_ht
, *files_ht
;
1157 http_request_body body
;
1161 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a!a!", &fields
, &files
)) {
1165 fields_ht
= (fields
&& Z_TYPE_P(fields
) == IS_ARRAY
) ? Z_ARRVAL_P(fields
) : NULL
;
1166 files_ht
= (files
&& Z_TYPE_P(files
) == IS_ARRAY
) ? Z_ARRVAL_P(files
) : NULL
;
1167 if (http_request_body_fill(&body
, fields_ht
, files_ht
) && (SUCCESS
== http_request_body_encode(&body
, &buf
, &len
))) {
1168 RETVAL_STRINGL(buf
, len
, 0);
1170 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not encode request body");
1173 http_request_body_dtor(&body
);
1175 #endif /* HTTP_HAVE_CURL */
1178 /* {{{ proto int http_request_method_register(string method)
1179 Register a custom request method. */
1180 PHP_FUNCTION(http_request_method_register
)
1186 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
1189 if ((existing
= http_request_method_exists(1, 0, method
))) {
1190 RETURN_LONG((long) existing
);
1193 RETVAL_LONG((long) http_request_method_register(method
, method_len
));
1197 /* {{{ proto bool http_request_method_unregister(mixed method)
1198 Unregister a previously registered custom request method. */
1199 PHP_FUNCTION(http_request_method_unregister
)
1203 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1207 switch (Z_TYPE_P(method
)) {
1209 convert_to_string(method
);
1211 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1212 convert_to_long(method
);
1215 if (!(mn
= http_request_method_exists(1, 0, Z_STRVAL_P(method
)))) {
1219 ZVAL_LONG(method
, (long)mn
);
1222 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method
)));
1229 /* {{{ proto int http_request_method_exists(mixed method)
1230 Check if a request method is registered (or available by default). */
1231 PHP_FUNCTION(http_request_method_exists
)
1233 if (return_value_used
) {
1236 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1240 switch (Z_TYPE_P(method
)) {
1242 convert_to_string(method
);
1244 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1245 convert_to_long(method
);
1247 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method
)));
1250 RETURN_LONG((long) http_request_method_exists(0, (int) Z_LVAL_P(method
), NULL
));
1258 /* {{{ proto string http_request_method_name(int method)
1259 Get the literal string representation of a standard or registered request method. */
1260 PHP_FUNCTION(http_request_method_name
)
1262 if (return_value_used
) {
1265 if ((SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &method
)) || (method
< 0)) {
1269 RETURN_STRING(estrdup(http_request_method_name((int) method
)), 0);
1275 #ifdef HTTP_HAVE_ZLIB
1277 /* {{{ proto string http_deflate(string data[, int flags = 0])
1278 Compress data with gzip, zlib AKA deflate or raw deflate encoding. */
1279 PHP_FUNCTION(http_deflate
)
1287 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &flags
)) {
1291 if (SUCCESS
== http_encoding_deflate(flags
, data
, data_len
, &encoded
, &encoded_len
)) {
1292 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1298 /* {{{ proto string http_inflate(string data)
1299 Decompress data compressed with either gzip, deflate AKA zlib or raw deflate encoding. */
1300 PHP_FUNCTION(http_inflate
)
1307 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1311 if (SUCCESS
== http_encoding_inflate(data
, data_len
, &decoded
, &decoded_len
)) {
1312 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1318 /* {{{ proto string ob_deflatehandler(string data, int mode)
1319 For use with ob_start(). The deflate output buffer handler can only be used once. */
1320 PHP_FUNCTION(ob_deflatehandler
)
1326 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
1330 http_ob_deflatehandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
1331 Z_TYPE_P(return_value
) = Z_STRVAL_P(return_value
) ? IS_STRING
: IS_NULL
;
1335 /* {{{ proto string ob_inflatehandler(string data, int mode)
1336 For use with ob_start(). Same restrictions as with ob_deflatehandler apply. */
1337 PHP_FUNCTION(ob_inflatehandler
)
1343 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
1347 http_ob_inflatehandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
1348 Z_TYPE_P(return_value
) = Z_STRVAL_P(return_value
) ? IS_STRING
: IS_NULL
;
1352 #endif /* HTTP_HAVE_ZLIB */
1355 /* {{{ proto int http_support([int feature = 0])
1356 Check for feature that require external libraries. */
1357 PHP_FUNCTION(http_support
)
1363 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &feature
)) {
1364 RETVAL_LONG(http_support(feature
));
1374 * vim600: noet sw=4 ts=4 fdm=marker
1375 * vim<600: noet sw=4 ts=4