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-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
20 #include "zend_operators.h"
24 #include "ext/standard/info.h"
25 #include "ext/standard/php_string.h"
26 #if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
27 # include "ext/session/php_session.h"
31 #include "php_http_std_defs.h"
32 #include "php_http_api.h"
33 #include "php_http_request_api.h"
34 #include "php_http_cache_api.h"
35 #include "php_http_request_method_api.h"
36 #include "php_http_request_api.h"
37 #include "php_http_date_api.h"
38 #include "php_http_headers_api.h"
39 #include "php_http_message_api.h"
40 #include "php_http_send_api.h"
41 #include "php_http_url_api.h"
42 #include "php_http_encoding_api.h"
44 #include "phpstr/phpstr.h"
46 ZEND_EXTERN_MODULE_GLOBALS(http
)
48 /* {{{ proto string http_date([int timestamp])
50 * Compose a valid HTTP date regarding RFC 822/1123
51 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
53 * Takes an optional unix timestamp as parameter.
55 * Returns the HTTP date as string.
57 PHP_FUNCTION(http_date
)
61 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
66 t
= (long) time(NULL
);
69 RETURN_STRING(http_date(t
), 0);
73 /* {{{ proto string http_build_uri(string url[, string proto[, string host[, int port]]])
75 * Build a complete URI according to the supplied parameters.
77 * If the url is already abolute but a different proto was supplied,
78 * only the proto part of the URI will be updated. If url has no
79 * path specified, the path of the current REQUEST_URI will be taken.
80 * The host will be taken either from the Host HTTP header of the client
81 * the SERVER_NAME or just localhost if prior are not available.
82 * If a port is pecified in either the url or as sperate parameter,
83 * it will be added if it differs from te default port for HTTP(S).
85 * Returns the absolute URI as string.
90 * $uri = http_build_uri("page.php", "https", NULL, 488);
94 PHP_FUNCTION(http_build_uri
)
96 char *url
= NULL
, *proto
= NULL
, *host
= NULL
;
97 int url_len
= 0, proto_len
= 0, host_len
= 0;
100 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|ssl", &url
, &url_len
, &proto
, &proto_len
, &host
, &host_len
, &port
) != SUCCESS
) {
104 RETURN_STRING(http_absolute_uri_ex(url
, url_len
, proto
, proto_len
, host
, host_len
, port
), 0);
108 #define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
111 if (result = http_negotiate_ ##type(supported)) { \
116 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
117 RETVAL_STRINGL(key, key_len-1, 0); \
123 zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
126 zend_hash_destroy(result); \
127 FREE_HASHTABLE(result); \
132 zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
133 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
134 RETVAL_ZVAL(*value, 1, 0); \
143 FOREACH_VAL(pos, supported, value) { \
144 convert_to_string_ex(value); \
145 add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
152 /* {{{ proto string http_negotiate_language(array supported[, array &result])
154 * This function negotiates the clients preferred language based on its
155 * Accept-Language HTTP header. The qualifier is recognized and languages
156 * without qualifier are rated highest. The qualifier will be decreased by
157 * 10% for partial matches (i.e. matching primary language).
159 * Expects an array as parameter cotaining the supported languages as values.
160 * If the optional second parameter is supplied, it will be filled with an
161 * array containing the negotiation results.
163 * Returns the negotiated language or the default language (i.e. first array entry)
179 * include './langs/'. http_negotiate_language($langs, $result) .'.php';
185 PHP_FUNCTION(http_negotiate_language
)
187 zval
*supported
, *rs_array
= NULL
;
189 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
195 array_init(rs_array
);
198 HTTP_DO_NEGOTIATE(language
, supported
, rs_array
);
202 /* {{{ proto string http_negotiate_charset(array supported[, array &result])
204 * This function negotiates the clients preferred charset based on its
205 * Accept-Charset HTTP header. The qualifier is recognized and charsets
206 * without qualifier are rated highest.
208 * Expects an array as parameter cotaining the supported charsets as values.
209 * If the optional second parameter is supplied, it will be filled with an
210 * array containing the negotiation results.
212 * Returns the negotiated charset or the default charset (i.e. first array entry)
219 * 'iso-8859-1', // default
225 * $pref = http_negotiate_charset($charsets, $result);
227 * if (strcmp($pref, 'iso-8859-1')) {
228 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
229 * iconv_set_encoding('output_encoding', $pref);
230 * ob_start('ob_iconv_handler');
237 PHP_FUNCTION(http_negotiate_charset
)
239 zval
*supported
, *rs_array
= NULL
;
241 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
247 array_init(rs_array
);
250 HTTP_DO_NEGOTIATE(charset
, supported
, rs_array
);
254 /* {{{ proto bool http_send_status(int status)
256 * Send HTTP status code.
258 * Expects an HTTP status code as parameter.
260 * Returns TRUE on success or FALSE on failure.
262 PHP_FUNCTION(http_send_status
)
266 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &status
) != SUCCESS
) {
269 if (status
< 100 || status
> 510) {
270 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Invalid HTTP status code (100-510): %d", status
);
274 RETURN_SUCCESS(http_send_status(status
));
278 /* {{{ proto bool http_send_last_modified([int timestamp])
280 * Send a "Last-Modified" header with a valid HTTP date.
282 * Accepts a unix timestamp, converts it to a valid HTTP date and
283 * sends it as "Last-Modified" HTTP header. If timestamp is
284 * omitted, the current time will be sent.
286 * Returns TRUE on success or FALSE on failure.
288 PHP_FUNCTION(http_send_last_modified
)
292 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
297 t
= (long) time(NULL
);
300 RETURN_SUCCESS(http_send_last_modified(t
));
304 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
306 * Send the Content-Type of the sent entity. This is particularly important
307 * if you use the http_send() API.
309 * Accepts an optional string parameter containing the desired content type
310 * (primary/secondary).
312 * Returns TRUE on success or FALSE on failure.
314 PHP_FUNCTION(http_send_content_type
)
316 char *ct
= "application/x-octetstream";
317 int ct_len
= lenof("application/x-octetstream");
319 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &ct
, &ct_len
) != SUCCESS
) {
323 RETURN_SUCCESS(http_send_content_type(ct
, ct_len
));
327 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
329 * Send the Content-Disposition. The Content-Disposition header is very useful
330 * if the data actually sent came from a file or something similar, that should
331 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
333 * Expects a string parameter specifying the file name the "Save as..." dialogue
334 * should display. Optionally accepts a bool parameter, which, if set to true
335 * and the user agent knows how to handle the content type, will probably not
336 * cause the popup window to be shown.
338 * Returns TRUE on success or FALSE on failure.
340 PHP_FUNCTION(http_send_content_disposition
)
344 zend_bool send_inline
= 0;
346 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &filename
, &f_len
, &send_inline
) != SUCCESS
) {
349 RETURN_SUCCESS(http_send_content_disposition(filename
, f_len
, send_inline
));
353 /* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
355 * Matches the given unix timestamp against the clients "If-Modified-Since"
356 * resp. "If-Unmodified-Since" HTTP headers.
358 * Accepts a unix timestamp which should be matched. Optionally accepts an
359 * additional bool parameter, which if set to true will check the header
360 * usually used to validate HTTP ranges. If timestamp is omitted, the
361 * current time will be used.
363 * Returns TRUE if timestamp represents an earlier date than the header,
366 PHP_FUNCTION(http_match_modified
)
369 zend_bool for_range
= 0;
371 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|lb", &t
, &for_range
) != SUCCESS
) {
375 // current time if not supplied (senseless though)
377 t
= (long) time(NULL
);
381 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t
));
383 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t
));
387 /* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
389 * Matches the given ETag against the clients "If-Match" resp.
390 * "If-None-Match" HTTP headers.
392 * Expects a string parameter containing the ETag to compare. Optionally
393 * accepts a bool parameter, which, if set to true, will check the header
394 * usually used to validate HTTP ranges.
396 * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
399 PHP_FUNCTION(http_match_etag
)
403 zend_bool for_range
= 0;
405 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &etag
, &etag_len
, &for_range
) != SUCCESS
) {
410 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag
));
412 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag
));
416 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
418 * Attempts to cache the sent entity by its last modification date.
420 * Accepts a unix timestamp as parameter which is handled as follows:
422 * If timestamp_or_expires is greater than 0, it is handled as timestamp
423 * and will be sent as date of last modification. If it is 0 or omitted,
424 * the current time will be sent as Last-Modified date. If it's negative,
425 * it is handled as expiration time in seconds, which means that if the
426 * requested last modification date is not between the calculated timespan,
427 * the Last-Modified header is updated and the actual body will be sent.
429 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
431 * A log entry will be written to the cache log if the INI entry
432 * http.cache_log is set and the cache attempt was successful.
434 PHP_FUNCTION(http_cache_last_modified
)
436 long last_modified
= 0, send_modified
= 0, t
;
439 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &last_modified
) != SUCCESS
) {
443 t
= (long) time(NULL
);
446 if (!last_modified
) {
447 /* does the client have? (att: caching "forever") */
448 if (zlm
= http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
449 last_modified
= send_modified
= http_parse_date(Z_STRVAL_P(zlm
));
450 /* send current time */
454 /* negative value is supposed to be expiration time */
455 } else if (last_modified
< 0) {
458 /* send supplied time explicitly */
460 send_modified
= last_modified
;
463 RETURN_SUCCESS(http_cache_last_modified(last_modified
, send_modified
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
467 /* {{{ proto bool http_cache_etag([string etag])
469 * Attempts to cache the sent entity by its ETag, either supplied or generated
470 * by the hash algorythm specified by the INI setting "http.etag_mode".
472 * If the clients "If-None-Match" header matches the supplied/calculated
473 * ETag, the body is considered cached on the clients side and
474 * a "304 Not Modified" status code is issued.
476 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
478 * A log entry is written to the cache log if the INI entry
479 * "http.cache_log" is set and the cache attempt was successful.
481 PHP_FUNCTION(http_cache_etag
)
486 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &etag
, &etag_len
) != SUCCESS
) {
490 RETURN_SUCCESS(http_cache_etag(etag
, etag_len
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
494 /* {{{ proto string ob_etaghandler(string data, int mode)
496 * For use with ob_start(). Output buffer handler generating an ETag with
497 * the hash algorythm specified with the INI setting "http.etag_mode".
499 PHP_FUNCTION(ob_etaghandler
)
505 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
509 Z_TYPE_P(return_value
) = IS_STRING
;
510 http_ob_etaghandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
514 /* {{{ proto void http_throttle(double sec[, int bytes = 40960])
516 * Sets the throttle delay and send buffer size for use with http_send() API.
517 * Provides a basic throttling mechanism, which will yield the current process
518 * resp. thread until the entity has been completely sent, though.
520 * Note: This doesn't really work with the FastCGI SAPI.
522 * Expects a double parameter specifying the seconds too sleep() after
523 * each chunk sent. Additionally accepts an optional int parameter
524 * representing the chunk size in bytes.
530 * # http_throttle(1, 20000);
531 * # http_throttle(0.5, 10000);
532 * # http_throttle(0.1, 2000);
533 * http_send_file('document.pdf');
537 PHP_FUNCTION(http_throttle
)
539 long chunk_size
= HTTP_SENDBUF_SIZE
;
542 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d|l", &interval
, &chunk_size
)) {
546 HTTP_G(send
).throttle_delay
= interval
;
547 HTTP_G(send
).buffer_size
= chunk_size
;
551 /* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
553 * Redirect to the given url.
555 * The supplied url will be expanded with http_build_uri(), the params array will
556 * be treated with http_build_query() and the session identification will be appended
557 * if session is true.
559 * The HTTP response code will be set according to status.
560 * You can use one of the following constants for convenience:
561 * - HTTP_REDIRECT 302 Found
562 * - HTTP_REDIRECT_PERM 301 Moved Permanently
563 * - HTTP_REDIRECT_POST 303 See Other
564 * - HTTP_REDIRECT_TEMP 307 Temporary Redirect
566 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
567 * for which redirect response code to use in which situation.
569 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
570 * if the client doesn't redirect immediatly, and the request method was
571 * another one than HEAD.
573 * Returns FALSE on failure, or *exits* on success.
575 * A log entry will be written to the redirect log, if the INI entry
576 * "http.redirect_log" is set and the redirect attempt was successful.
578 PHP_FUNCTION(http_redirect
)
581 size_t query_len
= 0;
582 zend_bool session
= 0, free_params
= 0;
585 char *query
= NULL
, *url
= NULL
, *URI
, *LOC
, *RED
= NULL
;
587 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sa!/bl", &url
, &url_len
, ¶ms
, &session
, &status
) != SUCCESS
) {
591 /* append session info */
595 MAKE_STD_ZVAL(params
);
598 #ifdef HAVE_PHP_SESSION
599 # ifdef COMPILE_DL_SESSION
600 if (SUCCESS
== zend_get_module_started("session")) {
601 zval nm_retval
, id_retval
, func
;
604 INIT_PZVAL(&nm_retval
);
605 INIT_PZVAL(&id_retval
);
606 ZVAL_NULL(&nm_retval
);
607 ZVAL_NULL(&id_retval
);
609 ZVAL_STRINGL(&func
, "session_id", lenof("session_id"), 0);
610 call_user_function(EG(function_table
), NULL
, &func
, &id_retval
, 0, NULL TSRMLS_CC
);
611 ZVAL_STRINGL(&func
, "session_name", lenof("session_name"), 0);
612 call_user_function(EG(function_table
), NULL
, &func
, &nm_retval
, 0, NULL TSRMLS_CC
);
614 if ( Z_TYPE(nm_retval
) == IS_STRING
&& Z_STRLEN(nm_retval
) &&
615 Z_TYPE(id_retval
) == IS_STRING
&& Z_STRLEN(id_retval
)) {
616 if (add_assoc_stringl_ex(params
, Z_STRVAL(nm_retval
), Z_STRLEN(nm_retval
)+1,
617 Z_STRVAL(id_retval
), Z_STRLEN(id_retval
), 0) != SUCCESS
) {
618 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
623 if (PS(session_status
) == php_session_active
) {
624 if (add_assoc_string(params
, PS(session_name
), PS(id
), 1) != SUCCESS
) {
625 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
632 /* treat params array with http_build_query() */
634 if (SUCCESS
!= http_urlencode_hash_ex(Z_ARRVAL_P(params
), 0, NULL
, 0, &query
, &query_len
)) {
646 URI
= http_absolute_uri(url
);
649 spprintf(&LOC
, 0, "Location: %s?%s", URI
, query
);
650 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
651 spprintf(&RED
, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI
, query
, URI
, query
);
654 spprintf(&LOC
, 0, "Location: %s", URI
);
655 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
656 spprintf(&RED
, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI
, URI
);
669 RETURN_SUCCESS(http_exit_ex(status
, LOC
, RED
, 1));
673 /* {{{ proto bool http_send_data(string data)
675 * Sends raw data with support for (multiple) range requests.
677 * Retursn TRUE on success, or FALSE on failure.
679 PHP_FUNCTION(http_send_data
)
683 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &zdata
) != SUCCESS
) {
687 convert_to_string_ex(&zdata
);
688 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
692 /* {{{ proto bool http_send_file(string file)
694 * Sends a file with support for (multiple) range requests.
696 * Expects a string parameter referencing the file to send.
698 * Returns TRUE on success, or FALSE on failure.
700 PHP_FUNCTION(http_send_file
)
705 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &file
, &flen
) != SUCCESS
) {
712 RETURN_SUCCESS(http_send_file(file
));
716 /* {{{ proto bool http_send_stream(resource stream)
718 * Sends an already opened stream with support for (multiple) range requests.
720 * Expects a resource parameter referncing the stream to read from.
722 * Returns TRUE on success, or FALSE on failure.
724 PHP_FUNCTION(http_send_stream
)
729 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &zstream
) != SUCCESS
) {
733 php_stream_from_zval(file
, &zstream
);
734 RETURN_SUCCESS(http_send_stream(file
));
738 /* {{{ proto string http_chunked_decode(string encoded)
740 * Decodes a string that was HTTP-chunked encoded.
742 * Expects a chunked encoded string as parameter.
744 * Returns the decoded string on success or FALSE on failure.
746 PHP_FUNCTION(http_chunked_decode
)
748 char *encoded
= NULL
, *decoded
= NULL
;
749 size_t decoded_len
= 0;
752 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &encoded
, &encoded_len
) != SUCCESS
) {
756 if (NULL
!= http_encoding_dechunk(encoded
, encoded_len
, &decoded
, &decoded_len
)) {
757 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
764 /* {{{ proto object http_parse_message(string message)
766 * Parses (a) http_message(s) into a simple recursive object structure.
768 * Expects a string parameter containing a single HTTP message or
769 * several consecutive HTTP messages.
771 * Returns an hierachical object structure of the parsed messages.
776 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
781 * [httpVersion] => 1.1
782 * [responseCode] => 200
785 * [Content-Length] => 3
789 * [parentMessage] => stdClass object
792 * [httpVersion] => 1.1
793 * [responseCode] => 302
796 * [Content-Length] => 0
800 * [parentMessage] => ...
806 PHP_FUNCTION(http_parse_message
)
810 http_message
*msg
= NULL
;
812 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &message
, &message_len
)) {
816 if (msg
= http_message_parse(message
, message_len
)) {
817 object_init(return_value
);
818 http_message_tostruct_recursive(msg
, return_value
);
819 http_message_free(&msg
);
826 /* {{{ proto array http_parse_headers(string header)
828 * Parses HTTP headers into an associative array.
830 * Expects a string parameter containing HTTP headers.
832 * Returns an array on success, or FALSE on failure.
837 * $headers = "content-type: text/html; charset=UTF-8\r\n".
838 * "Server: Funky/1.0\r\n".
839 * "Set-Cookie: foo=bar\r\n".
840 * "Set-Cookie: baz=quux\r\n".
841 * "Folded: works\r\n\ttoo\r\n";
842 * print_r(http_parse_headers($headers));
846 * [Content-Type] => text/html; chatset=UTF-8
847 * [Server] => Funky/1.0
848 * [Set-Cookie] => Array
858 PHP_FUNCTION(http_parse_headers
)
863 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &header
, &header_len
)) {
867 array_init(return_value
);
868 if (SUCCESS
!= http_parse_headers(header
, return_value
)) {
869 zval_dtor(return_value
);
875 /* {{{ proto array http_get_request_headers(void)
877 * Get a list of incoming HTTP headers.
879 * Returns an associative array of incoming request headers.
881 PHP_FUNCTION(http_get_request_headers
)
885 array_init(return_value
);
886 http_get_request_headers(return_value
);
890 /* {{{ proto string http_get_request_body(void)
892 * Get the raw request body (e.g. POST or PUT data).
894 * Returns NULL when using the CLI SAPI.
896 PHP_FUNCTION(http_get_request_body
)
903 if (SUCCESS
== http_get_request_body(&body
, &length
)) {
904 RETURN_STRINGL(body
, (int) length
, 0);
911 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
913 * Match an incoming HTTP header.
915 * Expects two string parameters representing the header name (case-insensitive)
916 * and the header value that should be compared. The case sensitivity of the
917 * header value depends on the additional optional bool parameter accepted.
919 * Returns TRUE if header value matches, else FALSE.
921 PHP_FUNCTION(http_match_request_header
)
923 char *header
, *value
;
924 int header_len
, value_len
;
925 zend_bool match_case
= 0;
927 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|b", &header
, &header_len
, &value
, &value_len
, &match_case
)) {
931 RETURN_BOOL(http_match_request_header_ex(header
, value
, match_case
));
936 #ifdef HTTP_HAVE_CURL
938 /* {{{ proto string http_get(string url[, array options[, array &info]])
940 * Performs an HTTP GET request on the supplied url.
942 * The second parameter, if set, is expected to be an associative
943 * array where the following keys will be recognized:
945 * - redirect: int, whether and how many redirects to follow
946 * - unrestrictedauth: bool, whether to continue sending credentials on
947 * redirects to a different host
948 * - proxyhost: string, proxy host in "host[:port]" format
949 * - proxyport: int, use another proxy port as specified in proxyhost
950 * - proxyauth: string, proxy credentials in "user:pass" format
951 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
952 * - httpauth: string, http credentials in "user:pass" format
953 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
954 * - compress: bool, whether to allow gzip/deflate content encoding
956 * - port: int, use another port as specified in the url
957 * - referer: string, the referer to send
958 * - useragent: string, the user agent to send
959 * (defaults to PECL::HTTP/version (PHP/version)))
960 * - headers: array, list of custom headers as associative array
961 * like array("header" => "value")
962 * - cookies: array, list of cookies as associative array
963 * like array("cookie" => "value")
964 * - cookiestore: string, path to a file where cookies are/will be stored
965 * - resume: int, byte offset to start the download from;
966 * if the server supports ranges
967 * - maxfilesize: int, maximum file size that should be downloaded;
968 * has no effect, if the size of the requested entity is not known
969 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
970 * - timeout: int, seconds the request may take
971 * - connecttimeout: int, seconds the connect may take
972 * - onprogress: mixed, progress callback
975 * The optional third parameter will be filled with some additional information
976 * in form af an associative array, if supplied, like the following example:
980 * 'effective_url' => 'http://localhost',
981 * 'response_code' => 403,
982 * 'total_time' => 0.017,
983 * 'namelookup_time' => 0.013,
984 * 'connect_time' => 0.014,
985 * 'pretransfer_time' => 0.014,
986 * 'size_upload' => 0,
987 * 'size_download' => 202,
988 * 'speed_download' => 11882,
989 * 'speed_upload' => 0,
990 * 'header_size' => 145,
991 * 'request_size' => 62,
992 * 'ssl_verifyresult' => 0,
994 * 'content_length_download' => 202,
995 * 'content_length_upload' => 0,
996 * 'starttransfer_time' => 0.017,
997 * 'content_type' => 'text/html; charset=iso-8859-1',
998 * 'redirect_time' => 0,
999 * 'redirect_count' => 0,
1000 * 'http_connectcode' => 0,
1001 * 'httpauth_avail' => 0,
1002 * 'proxyauth_avail' => 0,
1007 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1009 PHP_FUNCTION(http_get
)
1011 zval
*options
= NULL
, *info
= NULL
;
1016 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
1025 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1026 if (SUCCESS
== http_get(URL
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1027 RETURN_PHPSTR_VAL(&response
);
1029 phpstr_dtor(&response
);
1035 /* {{{ proto string http_head(string url[, array options[, array &info]])
1037 * Performs an HTTP HEAD request on the supplied url.
1039 * See http_get() for a full list of available parameters and options.
1041 * Returns the HTTP response as string on success, or FALSE on failure.
1043 PHP_FUNCTION(http_head
)
1045 zval
*options
= NULL
, *info
= NULL
;
1050 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
1059 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1060 if (SUCCESS
== http_head(URL
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1061 RETURN_PHPSTR_VAL(&response
);
1063 phpstr_dtor(&response
);
1069 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
1071 * Performs an HTTP POST requeston the supplied url.
1073 * Expects a string as second parameter containing the pre-encoded post data.
1074 * See http_get() for a full list of available parameters and options.
1076 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1078 PHP_FUNCTION(http_post_data
)
1080 zval
*options
= NULL
, *info
= NULL
;
1081 char *URL
, *postdata
;
1082 int postdata_len
, URL_len
;
1084 http_request_body body
;
1086 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &postdata
, &postdata_len
, &options
, &info
) != SUCCESS
) {
1095 body
.type
= HTTP_REQUEST_BODY_CSTRING
;
1096 body
.data
= postdata
;
1097 body
.size
= postdata_len
;
1099 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1100 if (SUCCESS
== http_post(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1101 RETVAL_PHPSTR_VAL(&response
);
1103 phpstr_dtor(&response
);
1109 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
1111 * Performs an HTTP POST request on the supplied url.
1113 * Expecrs an associative array as second parameter, which will be
1114 * www-form-urlencoded. See http_get() for a full list of available options.
1116 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1118 PHP_FUNCTION(http_post_fields
)
1120 zval
*options
= NULL
, *info
= NULL
, *fields
, *files
= NULL
;
1124 http_request_body body
;
1126 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sa|aa/!z", &URL
, &URL_len
, &fields
, &files
, &options
, &info
) != SUCCESS
) {
1130 if (SUCCESS
!= http_request_body_fill(&body
, Z_ARRVAL_P(fields
), files
? Z_ARRVAL_P(files
) : NULL
)) {
1139 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1140 if (SUCCESS
== http_post(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1141 RETVAL_PHPSTR_VAL(&response
);
1143 phpstr_dtor(&response
);
1146 http_request_body_dtor(&body
);
1150 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
1152 * Performs an HTTP PUT request on the supplied url.
1154 * Expects the second parameter to be a string referncing the file to upload.
1155 * See http_get() for a full list of available options.
1157 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1159 PHP_FUNCTION(http_put_file
)
1163 zval
*options
= NULL
, *info
= NULL
;
1166 php_stream_statbuf ssb
;
1167 http_request_body body
;
1169 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &file
, &f_len
, &options
, &info
)) {
1173 if (!(stream
= php_stream_open_wrapper(file
, "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
))) {
1176 if (php_stream_stat(stream
, &ssb
)) {
1177 php_stream_close(stream
);
1186 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1188 body
.size
= ssb
.sb
.st_size
;
1190 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1191 if (SUCCESS
== http_put(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1192 RETVAL_PHPSTR_VAL(&response
);
1194 phpstr_dtor(&response
);
1197 http_request_body_dtor(&body
);
1201 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1203 * Performs an HTTP PUT request on the supplied url.
1205 * Expects the second parameter to be a resource referencing an already
1206 * opened stream, from which the data to upload should be read.
1207 * See http_get() for a full list of available options.
1209 * Returns the HTTP response(s) as string on success. or FALSE on failure.
1211 PHP_FUNCTION(http_put_stream
)
1213 zval
*resource
, *options
= NULL
, *info
= NULL
;
1218 php_stream_statbuf ssb
;
1219 http_request_body body
;
1221 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sr|a/!z", &URL
, &URL_len
, &resource
, &options
, &info
)) {
1225 php_stream_from_zval(stream
, &resource
);
1226 if (php_stream_stat(stream
, &ssb
)) {
1235 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1237 body
.size
= ssb
.sb
.st_size
;
1239 phpstr_init_ex(&response
, HTTP_CURLBUF_SIZE
, 0);
1240 if (SUCCESS
== http_put(URL
, &body
, options
? Z_ARRVAL_P(options
) : NULL
, info
? Z_ARRVAL_P(info
) : NULL
, &response
)) {
1241 RETURN_PHPSTR_VAL(&response
);
1243 phpstr_dtor(&response
);
1248 #endif /* HTTP_HAVE_CURL */
1251 /* {{{ proto int http_request_method_register(string method)
1253 * Register a custom request method.
1255 * Expects a string parameter containing the request method name to register.
1257 * Returns the ID of the request method on success, or FALSE on failure.
1259 PHP_FUNCTION(http_request_method_register
)
1265 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
1268 if (existing
= http_request_method_exists(1, 0, method
)) {
1269 RETURN_LONG((long) existing
);
1272 RETVAL_LONG((long) http_request_method_register(method
, method_len
));
1276 /* {{{ proto bool http_request_method_unregister(mixed method)
1278 * Unregister a previously registered custom request method.
1280 * Expects either the request method name or ID.
1282 * Returns TRUE on success, or FALSE on failure.
1284 PHP_FUNCTION(http_request_method_unregister
)
1288 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1292 switch (Z_TYPE_P(method
))
1295 convert_to_string(method
);
1297 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1298 convert_to_long(method
);
1301 if (!(mn
= http_request_method_exists(1, 0, Z_STRVAL_P(method
)))) {
1305 ZVAL_LONG(method
, (long)mn
);
1308 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method
)));
1315 /* {{{ proto int http_request_method_exists(mixed method)
1317 * Check if a request method is registered (or available by default).
1319 * Expects either the request method name or ID as parameter.
1321 * Returns TRUE if the request method is known, else FALSE.
1323 PHP_FUNCTION(http_request_method_exists
)
1328 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1332 switch (Z_TYPE_P(method
))
1335 convert_to_string(method
);
1337 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1338 convert_to_long(method
);
1340 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method
)));
1343 RETURN_LONG((long) http_request_method_exists(0, Z_LVAL_P(method
), NULL
));
1351 /* {{{ proto string http_request_method_name(int method)
1353 * Get the literal string representation of a standard or registered request method.
1355 * Expects the request method ID as parameter.
1357 * Returns the request method name as string on success, or FALSE on failure.
1359 PHP_FUNCTION(http_request_method_name
)
1364 if ((SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &method
)) || (method
< 0)) {
1368 RETURN_STRING(estrdup(http_request_method_name((ulong
) method
)), 0);
1373 /* {{{ Sara Golemons http_build_query() */
1374 #ifndef ZEND_ENGINE_2
1376 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1377 Generates a form-encoded query string from an associative array or object. */
1378 PHP_FUNCTION(http_build_query
)
1381 char *prefix
= NULL
, *arg_sep
= INI_STR("arg_separator.output");
1382 int prefix_len
= 0, arg_sep_len
= strlen(arg_sep
);
1385 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|ss", &formdata
, &prefix
, &prefix_len
, &arg_sep
, &arg_sep_len
) != SUCCESS
) {
1390 arg_sep
= HTTP_URL_ARGSEP
;
1391 arg_sep_len
= lenof(HTTP_URL_ARGSEP
);
1394 formstr
= phpstr_new();
1395 if (SUCCESS
!= http_urlencode_hash_recursive(HASH_OF(formdata
), formstr
, arg_sep
, arg_sep_len
, prefix
, prefix_len
)) {
1396 phpstr_free(&formstr
);
1400 if (!formstr
->used
) {
1401 phpstr_free(&formstr
);
1405 RETURN_PHPSTR_PTR(formstr
);
1408 #endif /* !ZEND_ENGINE_2 */
1412 #ifdef HTTP_HAVE_ZLIB
1414 /* {{{ proto string http_gzencode(string data[, int level = -1])
1416 * Compress data with the HTTP compatible GZIP encoding.
1418 * Expects the first parameter to be a string which contains the data that
1419 * should be encoded. Additionally accepts an optional in paramter specifying
1420 * the compression level, where -1 is default, 0 is no compression and 9 is
1421 * best compression ratio.
1423 * Returns the encoded string on success, or NULL on failure.
1425 PHP_FUNCTION(http_gzencode
)
1433 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &level
)) {
1434 HTTP_CHECK_GZIP_LEVEL(level
, return);
1439 if (SUCCESS
== http_encoding_gzencode(level
, data
, data_len
, &encoded
, &encoded_len
)) {
1440 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1447 /* {{{ proto string http_gzdecode(string data)
1449 * Uncompress data compressed with the HTTP compatible GZIP encoding.
1451 * Expects a string as parameter containing the compressed data.
1453 * Returns the decoded string on success, or NULL on failure.
1455 PHP_FUNCTION(http_gzdecode
)
1462 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1466 if (SUCCESS
== http_encoding_gzdecode(data
, data_len
, &decoded
, &decoded_len
)) {
1467 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1473 /* {{{ proto string http_deflate(string data[, int level = -1])
1475 * Compress data with the HTTP compatible DEFLATE encoding.
1477 * Expects the first parameter to be a string containing the data that should
1478 * be encoded. Additionally accepts an optional int parameter specifying the
1479 * compression level, where -1 is default, 0 is no compression and 9 is best
1480 * compression ratio.
1482 * Returns the encoded string on success, or NULL on failure.
1484 PHP_FUNCTION(http_deflate
)
1492 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &level
)) {
1493 HTTP_CHECK_GZIP_LEVEL(level
, return);
1498 if (SUCCESS
== http_encoding_deflate(level
, data
, data_len
, &encoded
, &encoded_len
)) {
1499 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1506 /* {{{ proto string http_inflate(string data)
1508 * Uncompress data compressed with the HTTP compatible DEFLATE encoding.
1510 * Expects a string as parameter containing the compressed data.
1512 * Returns the decoded string on success, or NULL on failure.
1514 PHP_FUNCTION(http_inflate
)
1521 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1525 if (SUCCESS
== http_encoding_inflate(data
, data_len
, &decoded
, &decoded_len
)) {
1526 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1532 /* {{{ proto string http_compress(string data[, int level = -1])
1534 * Compress data with the HTTP compatible COMPRESS encoding.
1536 * Expects the first parameter to be a string containing the data which should
1537 * be encoded. Additionally accepts an optional int parameter specifying the
1538 * compression level, where -1 is default, 0 is no compression and 9 is best
1539 * compression ratio.
1541 * Returns the encoded string on success, or NULL on failure.
1543 PHP_FUNCTION(http_compress
)
1551 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &level
)) {
1552 HTTP_CHECK_GZIP_LEVEL(level
, return);
1557 if (SUCCESS
== http_encoding_compress(level
, data
, data_len
, &encoded
, &encoded_len
)) {
1558 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1565 /* {{{ proto string http_uncompress(string data)
1567 * Uncompress data compressed with the HTTP compatible COMPRESS encoding.
1569 * Expects a string as parameter containing the compressed data.
1571 * Returns the decoded string on success, or NULL on failure.
1573 PHP_FUNCTION(http_uncompress
)
1580 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1584 if (SUCCESS
== http_encoding_uncompress(data
, data_len
, &decoded
, &decoded_len
)) {
1585 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1590 #endif /* HTTP_HAVE_ZLIB */
1593 /* {{{ proto int http_support([int feature = 0])
1595 * Check for feature that require external libraries.
1597 * Accpepts an optional in parameter specifying which feature to probe for.
1598 * If the parameter is 0 or omitted, the return value contains a bitmask of
1599 * all supported features that depend on external libraries.
1601 * Available features to probe for are:
1603 * <li> HTTP_SUPPORT: always set
1604 * <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
1605 * and HTTP requests can be issued
1606 * <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
1607 * and SSL requests can be issued
1608 * <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
1609 * and compressed HTTP responses can be decoded
1610 * <li> HTTP_SUPPORT_MHASHETAGS: whether ext/http was linked against libmhash,
1611 * and ETags can be generated with the available mhash algorithms
1612 * <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
1613 * and the HttpResponse::guessContentType() method is usable
1616 * Returns int, whether requested feature is supported, or a bitmask with
1617 * all supported features.
1619 PHP_FUNCTION(http_support
)
1625 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &feature
)) {
1626 RETVAL_LONG(http_support(feature
));
1631 PHP_FUNCTION(http_test
)
1640 * vim600: noet sw=4 ts=4 fdm=marker
1641 * vim<600: noet sw=4 ts=4