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 +----------------------------------------------------------------------+
23 #include "zend_operators.h"
27 #include "ext/standard/info.h"
28 #include "ext/standard/php_string.h"
29 #if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
30 # include "ext/session/php_session.h"
34 #include "php_http_std_defs.h"
35 #include "php_http_api.h"
36 #include "php_http_request_api.h"
37 #include "php_http_cache_api.h"
38 #include "php_http_request_method_api.h"
39 #include "php_http_request_api.h"
40 #include "php_http_date_api.h"
41 #include "php_http_headers_api.h"
42 #include "php_http_message_api.h"
43 #include "php_http_send_api.h"
44 #include "php_http_url_api.h"
46 #include "phpstr/phpstr.h"
48 ZEND_EXTERN_MODULE_GLOBALS(http
)
50 /* {{{ proto string http_date([int timestamp])
52 * This function returns a valid HTTP date regarding RFC 822/1123
53 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
56 PHP_FUNCTION(http_date
)
60 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
65 t
= (long) time(NULL
);
68 RETURN_STRING(http_date(t
), 0);
72 /* {{{ proto string http_absolute_uri(string url[, string proto[, string host[, int port]]])
74 * This function returns an absolute URI constructed from url.
75 * If the url is already abolute but a different proto was supplied,
76 * only the proto part of the URI will be updated. If url has no
77 * path specified, the path of the current REQUEST_URI will be taken.
78 * The host will be taken either from the Host HTTP header of the client
79 * the SERVER_NAME or just localhost if prior are not available.
83 * url = "page.php" => http://www.example.com/current/path/page.php
84 * url = "/page.php" => http://www.example.com/page.php
85 * url = "/page.php", proto = "https" => https://www.example.com/page.php
89 PHP_FUNCTION(http_absolute_uri
)
91 char *url
= NULL
, *proto
= NULL
, *host
= NULL
;
92 int url_len
= 0, proto_len
= 0, host_len
= 0;
95 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|ssl", &url
, &url_len
, &proto
, &proto_len
, &host
, &host_len
, &port
) != SUCCESS
) {
99 RETURN_STRING(http_absolute_uri_ex(url
, url_len
, proto
, proto_len
, host
, host_len
, port
), 0);
103 #define HTTP_DO_NEGOTIATE(type, supported, as_array) \
106 if (result = http_negotiate_ ##type(supported)) { \
108 Z_TYPE_P(return_value) = IS_ARRAY; \
109 Z_ARRVAL_P(return_value) = result; \
115 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
116 RETVAL_STRINGL(key, key_len-1, 0); \
120 zend_hash_destroy(result); \
126 array_init(return_value); \
128 FOREACH_VAL(supported, value) { \
129 convert_to_string_ex(value); \
130 add_assoc_double(return_value, Z_STRVAL_PP(value), 1.0); \
135 zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
136 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
137 RETVAL_ZVAL(*value, 1, 0); \
146 /* {{{ proto string http_negotiate_language(array supported[, bool return_quality_array = false])
148 * This function negotiates the clients preferred language based on its
149 * Accept-Language HTTP header. It returns the negotiated language or
150 * the default language (i.e. first array entry) if none match.
152 * The qualifier is recognized and languages without qualifier are rated highest.
154 * The supported parameter is expected to be an array having
155 * the supported languages as array values.
169 * include './langs/'. http_negotiate_language($langs) .'.php';
174 PHP_FUNCTION(http_negotiate_language
)
177 zend_bool as_array
= 0;
179 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|b", &supported
, &as_array
) != SUCCESS
) {
183 HTTP_DO_NEGOTIATE(language
, supported
, as_array
);
187 /* {{{ proto string http_negotiate_charset(array supported)
189 * This function negotiates the clients preferred charset based on its
190 * Accept-Charset HTTP header. It returns the negotiated charset or
191 * the default charset (i.e. first array entry) if none match.
193 * The qualifier is recognized and charset without qualifier are rated highest.
195 * The supported parameter is expected to be an array having
196 * the supported charsets as array values.
202 * 'iso-8859-1', // default
207 * $pref = http_negotiate_charset($charsets);
208 * if (!strcmp($pref, 'iso-8859-1')) {
209 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
210 * iconv_set_encoding('output_encoding', $pref);
211 * ob_start('ob_iconv_handler');
216 PHP_FUNCTION(http_negotiate_charset
)
219 zend_bool as_array
= 0;
221 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|b", &supported
, &as_array
) != SUCCESS
) {
225 HTTP_DO_NEGOTIATE(charset
, supported
, as_array
);
229 /* {{{ proto bool http_send_status(int status)
231 * Send HTTP status code.
234 PHP_FUNCTION(http_send_status
)
238 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &status
) != SUCCESS
) {
241 if (status
< 100 || status
> 510) {
242 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Invalid HTTP status code (100-510): %d", status
);
246 RETURN_SUCCESS(http_send_status(status
));
250 /* {{{ proto bool http_send_last_modified([int timestamp])
252 * This converts the given timestamp to a valid HTTP date and
253 * sends it as "Last-Modified" HTTP header. If timestamp is
254 * omitted, current time is sent.
257 PHP_FUNCTION(http_send_last_modified
)
261 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
266 t
= (long) time(NULL
);
269 RETURN_SUCCESS(http_send_last_modified(t
));
273 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
275 * Sets the content type.
278 PHP_FUNCTION(http_send_content_type
)
283 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &ct
, &ct_len
) != SUCCESS
) {
288 RETURN_SUCCESS(http_send_content_type("application/x-octetstream", lenof("application/x-octetstream")));
290 RETURN_SUCCESS(http_send_content_type(ct
, ct_len
));
294 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
296 * Set the Content Disposition. The Content-Disposition header is very useful
297 * if the data actually sent came from a file or something similar, that should
298 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
301 PHP_FUNCTION(http_send_content_disposition
)
305 zend_bool send_inline
= 0;
307 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &filename
, &f_len
, &send_inline
) != SUCCESS
) {
310 RETURN_SUCCESS(http_send_content_disposition(filename
, f_len
, send_inline
));
314 /* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
316 * Matches the given timestamp against the clients "If-Modified-Since" resp.
317 * "If-Unmodified-Since" HTTP headers.
320 PHP_FUNCTION(http_match_modified
)
323 zend_bool for_range
= 0;
325 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|lb", &t
, &for_range
) != SUCCESS
) {
329 // current time if not supplied (senseless though)
331 t
= (long) time(NULL
);
335 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t
));
337 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t
));
341 /* {{{ proto bool http_match_etag(string etag[, for_range = false])
343 * This matches the given ETag against the clients
344 * "If-Match" resp. "If-None-Match" HTTP headers.
347 PHP_FUNCTION(http_match_etag
)
351 zend_bool for_range
= 0;
353 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &etag
, &etag_len
, &for_range
) != SUCCESS
) {
358 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag
));
360 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag
));
364 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
366 * If timestamp_or_expires is greater than 0, it is handled as timestamp
367 * and will be sent as date of last modification. If it is 0 or omitted,
368 * the current time will be sent as Last-Modified date. If it's negative,
369 * it is handled as expiration time in seconds, which means that if the
370 * requested last modification date is not between the calculated timespan,
371 * the Last-Modified header is updated and the actual body will be sent.
374 PHP_FUNCTION(http_cache_last_modified
)
376 long last_modified
= 0, send_modified
= 0, t
;
379 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &last_modified
) != SUCCESS
) {
383 t
= (long) time(NULL
);
386 if (!last_modified
) {
387 /* does the client have? (att: caching "forever") */
388 if (zlm
= http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
389 last_modified
= send_modified
= http_parse_date(Z_STRVAL_P(zlm
));
390 /* send current time */
394 /* negative value is supposed to be expiration time */
395 } else if (last_modified
< 0) {
398 /* send supplied time explicitly */
400 send_modified
= last_modified
;
403 RETURN_SUCCESS(http_cache_last_modified(last_modified
, send_modified
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
407 /* {{{ proto bool http_cache_etag([string etag])
409 * This function attempts to cache the HTTP body based on an ETag,
410 * either supplied or generated through calculation of the MD5
411 * checksum of the output (uses output buffering).
413 * If clients "If-None-Match" header matches the supplied/calculated
414 * ETag, the body is considered cached on the clients side and
415 * a "304 Not Modified" status code is issued.
418 PHP_FUNCTION(http_cache_etag
)
423 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &etag
, &etag_len
) != SUCCESS
) {
427 RETURN_SUCCESS(http_cache_etag(etag
, etag_len
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
431 /* {{{ proto string ob_etaghandler(string data, int mode)
433 * For use with ob_start().
435 PHP_FUNCTION(ob_etaghandler
)
441 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
445 Z_TYPE_P(return_value
) = IS_STRING
;
446 http_ob_etaghandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
450 /* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
452 * Use with http_send() API.
458 * # http_throttle(1, 20000);
459 * # http_throttle(0.5, 10000);
460 * # http_throttle(0.1, 2000);
461 * http_send_file('document.pdf');
465 PHP_FUNCTION(http_throttle
)
470 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "dl", &interval
, &chunk_size
)) {
474 HTTP_G(send
).throttle_delay
= interval
;
475 HTTP_G(send
).buffer_size
= chunk_size
;
479 /* {{{ proto void http_redirect([string url[, array params[, bool session[, int status]]]])
481 * Redirect to a given url.
482 * The supplied url will be expanded with http_absolute_uri(), the params array will
483 * be treated with http_build_query() and the session identification will be appended
484 * if session is true.
486 * The HTTP response code will be set according to status.
487 * You can use one of the following constants for convenience:
488 * - HTTP_REDIRECT 302 Found
489 * - HTTP_REDIRECT_PERM 301 Moved Permanently
490 * - HTTP_REDIRECT_POST 303 See Other
491 * - HTTP_REDIRECT_TEMP 307 Temporary Redirect
493 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
494 * for which redirect response code to use in which situation.
496 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
497 * if the client doesn't redirect immediatly, and the request method was
500 PHP_FUNCTION(http_redirect
)
503 size_t query_len
= 0;
504 zend_bool session
= 0, free_params
= 0;
507 char *query
= NULL
, *url
= NULL
, *URI
, *LOC
, *RED
= NULL
;
509 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sa!/bl", &url
, &url_len
, ¶ms
, &session
, &status
) != SUCCESS
) {
513 /* append session info */
517 MAKE_STD_ZVAL(params
);
520 #ifdef HAVE_PHP_SESSION
521 # ifdef COMPILE_DL_SESSION
522 if (SUCCESS
== zend_get_module_started("session")) {
523 zval nm_retval
, id_retval
, func
;
526 INIT_PZVAL(&nm_retval
);
527 INIT_PZVAL(&id_retval
);
528 ZVAL_NULL(&nm_retval
);
529 ZVAL_NULL(&id_retval
);
531 ZVAL_STRINGL(&func
, "session_id", lenof("session_id"), 0);
532 call_user_function(EG(function_table
), NULL
, &func
, &id_retval
, 0, NULL TSRMLS_CC
);
533 ZVAL_STRINGL(&func
, "session_name", lenof("session_name"), 0);
534 call_user_function(EG(function_table
), NULL
, &func
, &nm_retval
, 0, NULL TSRMLS_CC
);
536 if ( Z_TYPE(nm_retval
) == IS_STRING
&& Z_STRLEN(nm_retval
) &&
537 Z_TYPE(id_retval
) == IS_STRING
&& Z_STRLEN(id_retval
)) {
538 if (add_assoc_stringl_ex(params
, Z_STRVAL(nm_retval
), Z_STRLEN(nm_retval
)+1,
539 Z_STRVAL(id_retval
), Z_STRLEN(id_retval
), 0) != SUCCESS
) {
540 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
545 if (PS(session_status
) == php_session_active
) {
546 if (add_assoc_string(params
, PS(session_name
), PS(id
), 1) != SUCCESS
) {
547 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
554 /* treat params array with http_build_query() */
556 if (SUCCESS
!= http_urlencode_hash_ex(Z_ARRVAL_P(params
), 0, NULL
, 0, &query
, &query_len
)) {
568 URI
= http_absolute_uri(url
);
571 spprintf(&LOC
, 0, "Location: %s?%s", URI
, query
);
572 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
573 spprintf(&RED
, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI
, query
, URI
, query
);
576 spprintf(&LOC
, 0, "Location: %s", URI
);
577 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
578 spprintf(&RED
, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI
, URI
);
591 RETURN_SUCCESS(http_exit_ex(status
, LOC
, RED
, 1));
595 /* {{{ proto bool http_send_data(string data)
597 * Sends raw data with support for (multiple) range requests.
600 PHP_FUNCTION(http_send_data
)
604 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &zdata
) != SUCCESS
) {
608 convert_to_string_ex(&zdata
);
609 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
613 /* {{{ proto bool http_send_file(string file)
615 * Sends a file with support for (multiple) range requests.
618 PHP_FUNCTION(http_send_file
)
623 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &file
, &flen
) != SUCCESS
) {
630 RETURN_SUCCESS(http_send_file(file
));
634 /* {{{ proto bool http_send_stream(resource stream)
636 * Sends an already opened stream with support for (multiple) range requests.
639 PHP_FUNCTION(http_send_stream
)
644 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &zstream
) != SUCCESS
) {
648 php_stream_from_zval(file
, &zstream
);
649 RETURN_SUCCESS(http_send_stream(file
));
653 /* {{{ proto string http_chunked_decode(string encoded)
655 * This function decodes a string that was HTTP-chunked encoded.
656 * Returns false on failure.
658 PHP_FUNCTION(http_chunked_decode
)
660 char *encoded
= NULL
, *decoded
= NULL
;
661 size_t decoded_len
= 0;
664 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &encoded
, &encoded_len
) != SUCCESS
) {
668 if (NULL
!= http_chunked_decode(encoded
, encoded_len
, &decoded
, &decoded_len
)) {
669 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
676 /* {{{ proto object http_parse_message(string message)
678 * Parses (a) http_message(s) into a simple recursive object structure:
682 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
687 * [httpVersion] => 1.1
688 * [responseCode] => 200
691 * [Content-Length] => 3
695 * [parentMessage] => stdClass object
698 * [httpVersion] => 1.1
699 * [responseCode] => 302
702 * [Content-Length] => 0
706 * [parentMessage] => ...
712 PHP_FUNCTION(http_parse_message
)
716 http_message
*msg
= NULL
;
718 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &message
, &message_len
)) {
723 if (msg
= http_message_parse(message
, message_len
)) {
724 object_init(return_value
);
725 http_message_tostruct_recursive(msg
, return_value
);
726 http_message_free(&msg
);
733 /* {{{ proto array http_parse_headers(string header)
736 PHP_FUNCTION(http_parse_headers
)
741 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &header
, &header_len
)) {
745 array_init(return_value
);
746 if (SUCCESS
!= http_parse_headers(header
, return_value
)) {
747 zval_dtor(return_value
);
753 /* {{{ proto array http_get_request_headers(void)
755 * Get a list of incoming HTTP headers.
757 PHP_FUNCTION(http_get_request_headers
)
761 array_init(return_value
);
762 http_get_request_headers(return_value
);
766 /* {{{ proto string http_get_request_body(void)
768 * Get the raw request body (e.g. POST or PUT data).
770 PHP_FUNCTION(http_get_request_body
)
777 if (SUCCESS
== http_get_request_body(&body
, &length
)) {
778 RETURN_STRINGL(body
, (int) length
, 0);
785 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
787 * Match an incoming HTTP header.
789 PHP_FUNCTION(http_match_request_header
)
791 char *header
, *value
;
792 int header_len
, value_len
;
793 zend_bool match_case
= 0;
795 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|b", &header
, &header_len
, &value
, &value_len
, &match_case
)) {
799 RETURN_BOOL(http_match_request_header_ex(header
, value
, match_case
));
804 #ifdef HTTP_HAVE_CURL
806 /* {{{ proto string http_get(string url[, array options[, array &info]])
808 * Performs an HTTP GET request on the supplied url.
810 * The second parameter is expected to be an associative
811 * array where the following keys will be recognized:
813 * - redirect: int, whether and how many redirects to follow
814 * - unrestrictedauth: bool, whether to continue sending credentials on
815 * redirects to a different host
816 * - proxyhost: string, proxy host in "host[:port]" format
817 * - proxyport: int, use another proxy port as specified in proxyhost
818 * - proxyauth: string, proxy credentials in "user:pass" format
819 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
820 * - httpauth: string, http credentials in "user:pass" format
821 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
822 * - compress: bool, whether to allow gzip/deflate content encoding
824 * - port: int, use another port as specified in the url
825 * - referer: string, the referer to sends
826 * - useragent: string, the user agent to send
827 * (defaults to PECL::HTTP/version (PHP/version)))
828 * - headers: array, list of custom headers as associative array
829 * like array("header" => "value")
830 * - cookies: array, list of cookies as associative array
831 * like array("cookie" => "value")
832 * - cookiestore: string, path to a file where cookies are/will be stored
833 * - resume: int, byte offset to start the download from;
834 * if the server supports ranges
835 * - maxfilesize: int, maximum file size that should be downloaded;
836 * has no effect, if the size of the requested entity is not known
837 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
838 * - timeout: int, seconds the request may take
839 * - connecttimeout: int, seconds the connect may take
840 * - onprogress: mixed, progress callback
843 * The optional third parameter will be filled with some additional information
844 * in form af an associative array, if supplied, like the following example:
848 * 'effective_url' => 'http://localhost',
849 * 'response_code' => 403,
850 * 'total_time' => 0.017,
851 * 'namelookup_time' => 0.013,
852 * 'connect_time' => 0.014,
853 * 'pretransfer_time' => 0.014,
854 * 'size_upload' => 0,
855 * 'size_download' => 202,
856 * 'speed_download' => 11882,
857 * 'speed_upload' => 0,
858 * 'header_size' => 145,
859 * 'request_size' => 62,
860 * 'ssl_verifyresult' => 0,
862 * 'content_length_download' => 202,
863 * 'content_length_upload' => 0,
864 * 'starttransfer_time' => 0.017,
865 * 'content_type' => 'text/html; charset=iso-8859-1',
866 * 'redirect_time' => 0,
867 * 'redirect_count' => 0,
868 * 'http_connectcode' => 0,
869 * 'httpauth_avail' => 0,
870 * 'proxyauth_avail' => 0,
875 PHP_FUNCTION(http_get
)
877 zval
*options
= NULL
, *info
= NULL
;
882 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
891 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
892 if (SUCCESS
== http_get(URL
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
893 RETURN_PHPSTR_VAL(&response
);
900 /* {{{ proto string http_head(string url[, array options[, array &info]])
902 * Performs an HTTP HEAD request on the suppied url.
903 * Returns the HTTP response as string.
904 * See http_get() for a full list of available options.
906 PHP_FUNCTION(http_head
)
908 zval
*options
= NULL
, *info
= NULL
;
913 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
922 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
923 if (SUCCESS
== http_head(URL
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
924 RETURN_PHPSTR_VAL(&response
);
931 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
933 * Performs an HTTP POST request, posting data.
934 * Returns the HTTP response as string.
935 * See http_get() for a full list of available options.
937 PHP_FUNCTION(http_post_data
)
939 zval
*options
= NULL
, *info
= NULL
;
940 char *URL
, *postdata
;
941 int postdata_len
, URL_len
;
943 http_request_body body
;
945 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &postdata
, &postdata_len
, &options
, &info
) != SUCCESS
) {
954 body
.type
= HTTP_REQUEST_BODY_CSTRING
;
955 body
.data
= postdata
;
956 body
.size
= postdata_len
;
958 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
959 if (SUCCESS
== http_post(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
960 RETVAL_PHPSTR_VAL(&response
);
967 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
969 * Performs an HTTP POST request, posting www-form-urlencoded array data.
970 * Returns the HTTP response as string.
971 * See http_get() for a full list of available options.
973 PHP_FUNCTION(http_post_fields
)
975 zval
*options
= NULL
, *info
= NULL
, *fields
, *files
= NULL
;
979 http_request_body body
;
981 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sa|aa/!z", &URL
, &URL_len
, &fields
, &files
, &options
, &info
) != SUCCESS
) {
985 if (SUCCESS
!= http_request_body_fill(&body
, Z_ARRVAL_P(fields
), files
? Z_ARRVAL_P(files
) : NULL
)) {
994 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
995 if (SUCCESS
== http_post(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
996 RETVAL_PHPSTR_VAL(&response
);
1000 http_request_body_dtor(&body
);
1004 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
1006 * Performs an HTTP PUT request, uploading file.
1007 * Returns the HTTP response as string.
1008 * See http_get() for a full list of available options.
1010 PHP_FUNCTION(http_put_file
)
1014 zval
*options
= NULL
, *info
= NULL
;
1017 php_stream_statbuf ssb
;
1018 http_request_body body
;
1020 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &file
, &f_len
, &options
, &info
)) {
1024 if (!(stream
= php_stream_open_wrapper(file
, "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
))) {
1027 if (php_stream_stat(stream
, &ssb
)) {
1028 php_stream_close(stream
);
1037 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1039 body
.size
= ssb
.sb
.st_size
;
1041 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1042 if (SUCCESS
== http_put(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1043 RETVAL_PHPSTR_VAL(&response
);
1047 http_request_body_dtor(&body
);
1051 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1053 * Performs an HTTP PUT request, uploading stream.
1054 * Returns the HTTP response as string.
1055 * See http_get() for a full list of available options.
1057 PHP_FUNCTION(http_put_stream
)
1059 zval
*resource
, *options
= NULL
, *info
= NULL
;
1064 php_stream_statbuf ssb
;
1065 http_request_body body
;
1067 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sr|a/!z", &URL
, &URL_len
, &resource
, &options
, &info
)) {
1071 php_stream_from_zval(stream
, &resource
);
1072 if (php_stream_stat(stream
, &ssb
)) {
1081 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1083 body
.size
= ssb
.sb
.st_size
;
1085 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1086 if (SUCCESS
== http_put(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1087 RETURN_PHPSTR_VAL(&response
);
1093 #endif /* HTTP_HAVE_CURL */
1096 /* {{{ proto long http_request_method_register(string method)
1098 * Register a custom request method.
1100 PHP_FUNCTION(http_request_method_register
)
1104 unsigned long existing
;
1106 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
1109 if (existing
= http_request_method_exists(1, 0, method
)) {
1110 RETURN_LONG((long) existing
);
1113 RETVAL_LONG((long) http_request_method_register(method
));
1117 /* {{{ proto bool http_request_method_unregister(mixed method)
1119 * Unregister a previously registered custom request method.
1121 PHP_FUNCTION(http_request_method_unregister
)
1125 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1129 switch (Z_TYPE_P(method
))
1132 convert_to_string(method
);
1134 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1135 convert_to_long(method
);
1138 if (!(mn
= http_request_method_exists(1, 0, Z_STRVAL_P(method
)))) {
1142 ZVAL_LONG(method
, (long)mn
);
1145 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method
)));
1152 /* {{{ proto long http_request_method_exists(mixed method)
1154 * Check if a request method is registered (or available by default).
1156 PHP_FUNCTION(http_request_method_exists
)
1161 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1165 switch (Z_TYPE_P(method
))
1168 convert_to_string(method
);
1170 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1171 convert_to_long(method
);
1173 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method
)));
1176 RETURN_LONG((long) http_request_method_exists(0, Z_LVAL_P(method
), NULL
));
1184 /* {{{ proto string http_request_method_name(long method)
1186 * Get the literal string representation of a standard or registered request method.
1188 PHP_FUNCTION(http_request_method_name
)
1193 if ((SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &method
)) || (method
< 0)) {
1197 RETURN_STRING(estrdup(http_request_method_name((unsigned long) method
)), 0);
1202 /* {{{ Sara Golemons http_build_query() */
1203 #ifndef ZEND_ENGINE_2
1205 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1206 Generates a form-encoded query string from an associative array or object. */
1207 PHP_FUNCTION(http_build_query
)
1210 char *prefix
= NULL
, *arg_sep
= INI_STR("arg_separator.output");
1211 int prefix_len
= 0, arg_sep_len
= strlen(arg_sep
);
1214 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z|ss", &formdata
, &prefix
, &prefix_len
, &arg_sep
, &arg_sep_len
) != SUCCESS
) {
1218 if (Z_TYPE_P(formdata
) != IS_ARRAY
&& Z_TYPE_P(formdata
) != IS_OBJECT
) {
1219 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Parameter 1 expected to be Array or Object. Incorrect value given.");
1224 arg_sep
= HTTP_URL_ARGSEP
;
1227 formstr
= phpstr_new();
1228 if (SUCCESS
!= http_urlencode_hash_implementation_ex(HASH_OF(formdata
), formstr
, arg_sep
, prefix
, prefix_len
, NULL
, 0, NULL
, 0, (Z_TYPE_P(formdata
) == IS_OBJECT
? formdata
: NULL
))) {
1229 phpstr_free(&formstr
);
1233 if (!formstr
->used
) {
1234 phpstr_free(&formstr
);
1238 RETURN_PHPSTR_PTR(formstr
);
1241 #endif /* !ZEND_ENGINE_2 */
1244 PHP_FUNCTION(http_test
)
1253 * vim600: noet sw=4 ts=4 fdm=marker
1254 * vim<600: noet sw=4 ts=4