- better inline docs part #1

[m6w6/ext-http] / http_functions.c

/*
   +----------------------------------------------------------------------+
   | PECL :: http                                                         |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.0 of the PHP license, that  |
   | is bundled with this package in the file LICENSE, and is available   |
   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
   +----------------------------------------------------------------------+
*/

/* $Id$ */

#ifdef HAVE_CONFIG_H
#       include "config.h"
#endif
#include "php.h"

#include "zend_operators.h"

#include "SAPI.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "ext/standard/php_string.h"
#if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
#       include "ext/session/php_session.h"
#endif

#include "php_http.h"
#include "php_http_std_defs.h"
#include "php_http_api.h"
#include "php_http_request_api.h"
#include "php_http_cache_api.h"
#include "php_http_request_method_api.h"
#include "php_http_request_api.h"
#include "php_http_date_api.h"
#include "php_http_headers_api.h"
#include "php_http_message_api.h"
#include "php_http_send_api.h"
#include "php_http_url_api.h"

#include "phpstr/phpstr.h"

ZEND_EXTERN_MODULE_GLOBALS(http)

/* {{{ proto string http_date([int timestamp])
 *
 * Compose a valid HTTP date regarding RFC 822/1123
 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
 *
 * Takes an optional unix timestamp as parameter.
 *  
 * Returns the HTTP date as string.
 */
PHP_FUNCTION(http_date)
{
        long t = -1;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
                RETURN_FALSE;
        }

        if (t == -1) {
                t = (long) time(NULL);
        }

        RETURN_STRING(http_date(t), 0);
}
/* }}} */

/* {{{ proto string http_build_uri(string url[, string proto[, string host[, int port]]])
 *
 * Build a complete URI according to the supplied parameters.
 * 
 * If the url is already abolute but a different proto was supplied,
 * only the proto part of the URI will be updated.  If url has no
 * path specified, the path of the current REQUEST_URI will be taken.
 * The host will be taken either from the Host HTTP header of the client
 * the SERVER_NAME or just localhost if prior are not available.
 * If a port is pecified in either the url or as sperate parameter,
 * it will be added if it differs from te default port for HTTP(S).
 * 
 * Returns the absolute URI as string.
 * 
 * Examples:
 * <code>
 * <?php
 * $uri = http_build_uri("page.php", "https", NULL, 488);
 * ?>
 * </code>
 */
PHP_FUNCTION(http_build_uri)
{
        char *url = NULL, *proto = NULL, *host = NULL;
        int url_len = 0, proto_len = 0, host_len = 0;
        long port = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ssl", &url, &url_len, &proto, &proto_len, &host, &host_len, &port) != SUCCESS) {
                RETURN_FALSE;
        }

        RETURN_STRING(http_absolute_uri_ex(url, url_len, proto, proto_len, host, host_len, port), 0);
}
/* }}} */

#define HTTP_DO_NEGOTIATE(type, supported, as_array) \
{ \
        HashTable *result; \
        if (result = http_negotiate_ ##type(supported)) { \
                if (as_array) { \
                        Z_TYPE_P(return_value) = IS_ARRAY; \
                        Z_ARRVAL_P(return_value) = result; \
                } else { \
                        char *key; \
                        uint key_len; \
                        ulong idx; \
                         \
                        if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
                                RETVAL_STRINGL(key, key_len-1, 0); \
                        } else { \
                                RETVAL_NULL(); \
                        } \
                        zend_hash_destroy(result); \
                        FREE_HASHTABLE(result); \
                } \
        } else { \
                if (as_array) { \
                        zval **value; \
                         \
                        array_init(return_value); \
                         \
                        FOREACH_VAL(supported, value) { \
                                convert_to_string_ex(value); \
                                add_assoc_double(return_value, Z_STRVAL_PP(value), 1.0); \
                        } \
                } else { \
                        zval **value; \
                         \
                        zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
                        if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
                                RETVAL_ZVAL(*value, 1, 0); \
                        } else { \
                                RETVAL_NULL(); \
                        } \
                } \
        } \
}


/* {{{ proto mixed http_negotiate_language(array supported[, array result])
 *
 * This function negotiates the clients preferred language based on its
 * Accept-Language HTTP header.  The qualifier is recognized and languages 
 * without qualifier are rated highest.  The qualifier will be decreased by
 * 10% for partial matches (i.e. matching primary language).
 * 
 * Expects an array as parameter cotaining the supported languages as values.
 * If the optional second parameter is supplied, it will be filled with an
 * array containing the negotiation results.
 * 
 * Returns the negotiated language or the default language (i.e. first array entry) 
 * if none match.
 * 
 * Example:
 * <pre>
 * <?php
 * $langs = array(
 *              'en-US',// default
 *              'fr',
 *              'fr-FR',
 *              'de',
 *              'de-DE',
 *              'de-AT',
 *              'de-CH',
 * );
 * 
 * include './langs/'. http_negotiate_language($langs, $result) .'.php';
 * 
 * print_r($result);
 * ?>
 * </pre>
 */
PHP_FUNCTION(http_negotiate_language)
{
        zval *supported;
        zend_bool as_array = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &supported, &as_array) != SUCCESS) {
                RETURN_FALSE;
        }
        
        HTTP_DO_NEGOTIATE(language, supported, as_array);
}
/* }}} */

/* {{{ proto string http_negotiate_charset(array supported[, array result])
 *
 * This function negotiates the clients preferred charset based on its
 * Accept-Charset HTTP header.  The qualifier is recognized and charsets 
 * without qualifier are rated highest.
 * 
 * Expects an array as parameter cotaining the supported charsets as values.
 * If the optional second parameter is supplied, it will be filled with an
 * array containing the negotiation results.
 * 
 * Returns the negotiated charset or the default charset (i.e. first array entry) 
 * if none match.
 * 
 * Example:
 * <pre>
 * <?php
 * $charsets = array(
 *              'iso-8859-1', // default
 *              'iso-8859-2',
 *              'iso-8859-15',
 *              'utf-8'
 * );
 * 
 * $pref = http_negotiate_charset($charsets, $result);
 * 
 * if (strcmp($pref, 'iso-8859-1')) {
 *              iconv_set_encoding('internal_encoding', 'iso-8859-1');
 *              iconv_set_encoding('output_encoding', $pref);
 *              ob_start('ob_iconv_handler');
 * }
 * 
 * print_r($result);
 * ?>
 * </pre>
 */
PHP_FUNCTION(http_negotiate_charset)
{
        zval *supported;
        zend_bool as_array = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &supported, &as_array) != SUCCESS) {
                RETURN_FALSE;
        }

        HTTP_DO_NEGOTIATE(charset, supported, as_array);
}
/* }}} */

/* {{{ proto bool http_send_status(int status)
 *
 * Send HTTP status code.
 *
 * Expects an HTTP status code as parameter.
 * 
 * Returns TRUE on success or FALSE on failure.
 */
PHP_FUNCTION(http_send_status)
{
        int status = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &status) != SUCCESS) {
                RETURN_FALSE;
        }
        if (status < 100 || status > 510) {
                http_error_ex(HE_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status);
                RETURN_FALSE;
        }

        RETURN_SUCCESS(http_send_status(status));
}
/* }}} */

/* {{{ proto bool http_send_last_modified([int timestamp])
 *
 * Send a "Last-Modified" header with a valid HTTP date.
 * 
 * Accepts a unix timestamp, converts it to a valid HTTP date and
 * sends it as "Last-Modified" HTTP header.  If timestamp is
 * omitted, the current time will be sent.
 *
 * Returns TRUE on success or FALSE on failure.
 */
PHP_FUNCTION(http_send_last_modified)
{
        long t = -1;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
                RETURN_FALSE;
        }

        if (t == -1) {
                t = (long) time(NULL);
        }

        RETURN_SUCCESS(http_send_last_modified(t));
}
/* }}} */

/* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
 *
 * Send the Content-Type of the sent entity.  This is particularly important
 * if you use the http_send() API.
 * 
 * Accepts an optional string parameter containing the desired content type 
 * (primary/secondary).
 *
 * Returns TRUE on success or FALSE on failure.
 */
PHP_FUNCTION(http_send_content_type)
{
        char *ct = "application/x-octetstream";
        int ct_len = lenof("application/x-octetstream";

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ct, &ct_len) != SUCCESS) {
                RETURN_FALSE;
        }

        RETURN_SUCCESS(http_send_content_type(ct, ct_len));
}
/* }}} */

/* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
 *
 * Send the Content-Disposition.  The Content-Disposition header is very useful
 * if the data actually sent came from a file or something similar, that should
 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
 *
 * Expects a string parameter specifying the file name the "Save as..." dialogue
 * should display.  Optionally accepts a bool parameter, which, if set to true
 * and the user agent knows how to handle the content type, will probably not
 * cause the popup window to be shown.
 * 
 * Returns TRUE on success or FALSE on failure.
 */
PHP_FUNCTION(http_send_content_disposition)
{
        char *filename;
        int f_len;
        zend_bool send_inline = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &filename, &f_len, &send_inline) != SUCCESS) {
                RETURN_FALSE;
        }
        RETURN_SUCCESS(http_send_content_disposition(filename, f_len, send_inline));
}
/* }}} */

/* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
 *
 * Matches the given unix timestamp against the clients "If-Modified-Since" 
 * resp. "If-Unmodified-Since" HTTP headers.
 *
 * Accepts a unix timestamp which should be matched.  Optionally accepts an
 * additional bool parameter, which if set to true will check the header 
 * usually used to validate HTTP ranges.  If timestamp is omitted, the
 * current time will be used.
 * 
 * Returns TRUE if timestamp represents an earlier date than the header,
 * else FALSE.
 */
PHP_FUNCTION(http_match_modified)
{
        long t = -1;
        zend_bool for_range = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|lb", &t, &for_range) != SUCCESS) {
                RETURN_FALSE;
        }

        // current time if not supplied (senseless though)
        if (t == -1) {
                t = (long) time(NULL);
        }

        if (for_range) {
                RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t));
        }
        RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t));
}
/* }}} */

/* {{{ proto bool http_match_etag(string etag[, for_range = false])
 *
 * Matches the given ETag against the clients "If-Match" resp. 
 * "If-None-Match" HTTP headers.
 *
 * Expects a string parameter containing the ETag to compare.  Optionally
 * accepts a bool parameter, which, if set to true, will check the header
 * usually used to validate HTTP ranges.
 * 
 * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
 * else FALSE.
 */
PHP_FUNCTION(http_match_etag)
{
        int etag_len;
        char *etag;
        zend_bool for_range = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &etag, &etag_len, &for_range) != SUCCESS) {
                RETURN_FALSE;
        }

        if (for_range) {
                RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag));
        }
        RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag));
}
/* }}} */

/* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
 *
 * Attempts to cache the sent entity by its last modification date.
 * 
 * Accepts a unix timestamp as parameter which is handled as follows:
 * 
 * If timestamp_or_expires is greater than 0, it is handled as timestamp
 * and will be sent as date of last modification.  If it is 0 or omitted,
 * the current time will be sent as Last-Modified date.  If it's negative,
 * it is handled as expiration time in seconds, which means that if the
 * requested last modification date is not between the calculated timespan,
 * the Last-Modified header is updated and the actual body will be sent.
 *
 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
 * 
 * A log entry will be written to the cache log if the INI entry
 * http.cache_log is set and the cache attempt was successful.
 */
PHP_FUNCTION(http_cache_last_modified)
{
        long last_modified = 0, send_modified = 0, t;
        zval *zlm;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
                RETURN_FALSE;
        }

        t = (long) time(NULL);

        /* 0 or omitted */
        if (!last_modified) {
                /* does the client have? (att: caching "forever") */
                if (zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
                        last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm));
                /* send current time */
                } else {
                        send_modified = t;
                }
        /* negative value is supposed to be expiration time */
        } else if (last_modified < 0) {
                last_modified += t;
                send_modified  = t;
        /* send supplied time explicitly */
        } else {
                send_modified = last_modified;
        }

        RETURN_SUCCESS(http_cache_last_modified(last_modified, send_modified, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
}
/* }}} */

/* {{{ proto bool http_cache_etag([string etag])
 *
 * Attempts to cache the sent entity by its ETag, either supplied or generated 
 * by the hash algorythm specified by the INI setting "http.etag_mode".
 *
 * If the clients "If-None-Match" header matches the supplied/calculated
 * ETag, the body is considered cached on the clients side and
 * a "304 Not Modified" status code is issued.
 *
 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
 * 
 * A log entry is written to the cache log if the INI entry
 * "http.cache_log" is set and the cache attempt was successful.
 */
PHP_FUNCTION(http_cache_etag)
{
        char *etag = NULL;
        int etag_len = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
                RETURN_FALSE;
        }

        RETURN_SUCCESS(http_cache_etag(etag, etag_len, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
}
/* }}} */

/* {{{ proto string ob_etaghandler(string data, int mode)
 *
 * For use with ob_start().  Output buffer handler generating an ETag with
 * the hash algorythm specified with the INI setting "http.etag_mode".
 */
PHP_FUNCTION(ob_etaghandler)
{
        char *data;
        int data_len;
        long mode;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
                RETURN_FALSE;
        }

        Z_TYPE_P(return_value) = IS_STRING;
        http_ob_etaghandler(data, data_len, &Z_STRVAL_P(return_value), (uint *) &Z_STRLEN_P(return_value), mode);
}
/* }}} */

/* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
 *
 * Sets the throttle delay and send buffer size for use with http_send() API.
 * Provides a basic throttling mechanism, which will yield the current process
 * resp. thread until the entity has been completely sent, though.
 * 
 * Note: This doesn't really work with the FastCGI SAPI.
 *
 * Expects a double parameter specifying the seconds too sleep() after
 * each chunk sent.  Additionally accepts an optional int parameter
 * representing the chunk size in bytes.
 * 
 * Example:
 * <pre>
 * <?php
 * // ~ 20 kbyte/s
 * # http_throttle(1, 20000);
 * # http_throttle(0.5, 10000);
 * # http_throttle(0.1, 2000);
 * http_send_file('document.pdf');
 * ?>
 * </pre>
 */
PHP_FUNCTION(http_throttle)
{
        long chunk_size = HTTP_SEND_BUFFERSIZE;
        double interval;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d|l", &interval, &chunk_size)) {
                return;
        }

        HTTP_G(send).throttle_delay = interval;
        HTTP_G(send).buffer_size = chunk_size;
}
/* }}} */

/* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
 *
 * Redirect to the given url.
 *  
 * The supplied url will be expanded with http_build_uri(), the params array will
 * be treated with http_build_query() and the session identification will be appended
 * if session is true.
 *
 * The HTTP response code will be set according to status.
 * You can use one of the following constants for convenience:
 *  - HTTP_REDIRECT                     302 Found
 *  - HTTP_REDIRECT_PERM        301 Moved Permanently
 *  - HTTP_REDIRECT_POST        303 See Other
 *  - HTTP_REDIRECT_TEMP        307 Temporary Redirect
 *
 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
 * for which redirect response code to use in which situation.
 *
 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
 * if the client doesn't redirect immediatly, and the request method was
 * another one than HEAD.
 * 
 * Returns FALSE on failure, or *exits* on success.
 * 
 * A log entry will be written to the redirect log, if the INI entry
 * "http.redirect_log" is set and the redirect attempt was successful.
 */
PHP_FUNCTION(http_redirect)
{
        int url_len;
        size_t query_len = 0;
        zend_bool session = 0, free_params = 0;
        zval *params = NULL;
        long status = 302;
        char *query = NULL, *url = NULL, *URI, *LOC, *RED = NULL;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bl", &url, &url_len, &params, &session, &status) != SUCCESS) {
                RETURN_FALSE;
        }

        /* append session info */
        if (session) {
                if (!params) {
                        free_params = 1;
                        MAKE_STD_ZVAL(params);
                        array_init(params);
                }
#ifdef HAVE_PHP_SESSION
#       ifdef COMPILE_DL_SESSION
                if (SUCCESS == zend_get_module_started("session")) {
                        zval nm_retval, id_retval, func;
                        
                        INIT_PZVAL(&func);
                        INIT_PZVAL(&nm_retval);
                        INIT_PZVAL(&id_retval);
                        ZVAL_NULL(&nm_retval);
                        ZVAL_NULL(&id_retval);
                        
                        ZVAL_STRINGL(&func, "session_id", lenof("session_id"), 0);
                        call_user_function(EG(function_table), NULL, &func, &id_retval, 0, NULL TSRMLS_CC);
                        ZVAL_STRINGL(&func, "session_name", lenof("session_name"), 0);
                        call_user_function(EG(function_table), NULL, &func, &nm_retval, 0, NULL TSRMLS_CC);
                        
                        if (    Z_TYPE(nm_retval) == IS_STRING && Z_STRLEN(nm_retval) &&
                                        Z_TYPE(id_retval) == IS_STRING && Z_STRLEN(id_retval)) {
                                if (add_assoc_stringl_ex(params, Z_STRVAL(nm_retval), Z_STRLEN(nm_retval)+1, 
                                                Z_STRVAL(id_retval), Z_STRLEN(id_retval), 0) != SUCCESS) {
                                        http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
                                }
                        }
                }
#       else
                if (PS(session_status) == php_session_active) {
                        if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
                                http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
                        }
                }
#       endif
#endif
        }

        /* treat params array with http_build_query() */
        if (params) {
                if (SUCCESS != http_urlencode_hash_ex(Z_ARRVAL_P(params), 0, NULL, 0, &query, &query_len)) {
                        if (free_params) {
                                zval_dtor(params);
                                FREE_ZVAL(params);
                        }
                        if (query) {
                                efree(query);
                        }
                        RETURN_FALSE;
                }
        }

        URI = http_absolute_uri(url);

        if (query_len) {
                spprintf(&LOC, 0, "Location: %s?%s", URI, query);
                if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
                        spprintf(&RED, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
                }
        } else {
                spprintf(&LOC, 0, "Location: %s", URI);
                if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
                        spprintf(&RED, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
                }
        }
        
        efree(URI);
        if (query) {
                efree(query);
        }
        if (free_params) {
                zval_dtor(params);
                FREE_ZVAL(params);
        }

        RETURN_SUCCESS(http_exit_ex(status, LOC, RED, 1));
}
/* }}} */

/* {{{ proto bool http_send_data(string data)
 *
 * Sends raw data with support for (multiple) range requests.
 *
 */
PHP_FUNCTION(http_send_data)
{
        zval *zdata;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) {
                RETURN_FALSE;
        }

        convert_to_string_ex(&zdata);
        RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
}
/* }}} */

/* {{{ proto bool http_send_file(string file)
 *
 * Sends a file with support for (multiple) range requests.
 *
 * Expects a string parameter referencing the file to send.
 * 
 * Returns TRUE on success, or FALSE on failure.
 */
PHP_FUNCTION(http_send_file)
{
        char *file;
        int flen = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file, &flen) != SUCCESS) {
                RETURN_FALSE;
        }
        if (!flen) {
                RETURN_FALSE;
        }

        RETURN_SUCCESS(http_send_file(file));
}
/* }}} */

/* {{{ proto bool http_send_stream(resource stream)
 *
 * Sends an already opened stream with support for (multiple) range requests.
 *
 * Expects a resource parameter referncing the stream to read from.
 * 
 * Returns TRUE on success, or FALSE on failure.
 */
PHP_FUNCTION(http_send_stream)
{
        zval *zstream;
        php_stream *file;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) {
                RETURN_FALSE;
        }

        php_stream_from_zval(file, &zstream);
        RETURN_SUCCESS(http_send_stream(file));
}
/* }}} */

/* {{{ proto string http_chunked_decode(string encoded)
 *
 * Decodes a string that was HTTP-chunked encoded.
 * 
 * Expects a chunked encoded string as parameter.
 * 
 * Returns the decoded string on success or FALSE on failure.
 */
PHP_FUNCTION(http_chunked_decode)
{
        char *encoded = NULL, *decoded = NULL;
        size_t decoded_len = 0;
        int encoded_len = 0;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) {
                RETURN_FALSE;
        }

        if (NULL != http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) {
                RETURN_STRINGL(decoded, (int) decoded_len, 0);
        } else {
                RETURN_FALSE;
        }
}
/* }}} */

/* {{{ proto object http_parse_message(string message)
 *
 * Parses (a) http_message(s) into a simple recursive object structure.
 * 
 * Expects a string parameter containing a single HTTP message or
 * several consecutive HTTP messages.
 * 
 * Returns an hierachical object structure of the parsed messages.
 *
 * Example:
 * <pre>
 * <?php
 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
 * 
 * stdClass object
 * (
 *     [type] => 2
 *     [httpVersion] => 1.1
 *     [responseCode] => 200
 *     [headers] => Array 
 *         (
 *             [Content-Length] => 3
 *             [Server] => Apache
 *         )
 *     [body]  => Hi!
 *     [parentMessage] => stdClass object
 *     (
 *         [type] => 2
 *         [httpVersion] => 1.1
 *         [responseCode] => 302
 *         [headers] => Array 
 *             (
 *                 [Content-Length] => 0
 *                 [Location] => ...
 *             )
 *         [body]  => 
 *         [parentMessage] => ...
 *     )
 * )
 * ?>
 * </pre>
 */
PHP_FUNCTION(http_parse_message)
{
        char *message;
        int message_len;
        http_message *msg = NULL;
        
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &message, &message_len)) {
                RETURN_NULL();
        }
        
        if (msg = http_message_parse(message, message_len)) {
                object_init(return_value);
                http_message_tostruct_recursive(msg, return_value);
                http_message_free(&msg);
        } else {
                RETURN_NULL();
        }
}
/* }}} */

/* {{{ proto array http_parse_headers(string header)
 *
 * Parses HTTP headers into an associative array.
 * 
 * Expects a string parameter containing HTTP headers.
 * 
 * Returns an array on success, or FALSE on failure.
 * 
 * Example:
 * <pre>
 * <?php
 * $headers = "content-type: text/html; charset=UTF-8\r\n".
 *            "Server: Funky/1.0\r\n".
 *            "Set-Cookie: foo=bar\r\n".
 *            "Set-Cookie: baz=quux\r\n".
 *            "Folded: works\r\n\ttoo\r\n";
 * print_r(http_parse_headers($headers));
 * 
 * Array
 * (
 *     [Content-Type] => text/html; chatset=UTF-8
 *     [Server] => Funky/1.0
 *     [Set-Cookie] => Array
 *         (
 *             [0] => foo=bar
 *             [1] => baz=quux
 *         )
 *     [Folded] => works
 *         too 
 * ?>
 * </pre>
 */
PHP_FUNCTION(http_parse_headers)
{
        char *header;
        int header_len;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
                RETURN_FALSE;
        }

        array_init(return_value);
        if (SUCCESS != http_parse_headers(header, return_value)) {
                zval_dtor(return_value);
                RETURN_FALSE;
        }
}
/* }}}*/

/* {{{ proto array http_get_request_headers(void)
 *
 * Get a list of incoming HTTP headers.
 */
PHP_FUNCTION(http_get_request_headers)
{
        NO_ARGS;

        array_init(return_value);
        http_get_request_headers(return_value);
}
/* }}} */

/* {{{ proto string http_get_request_body(void)
 *
 * Get the raw request body (e.g. POST or PUT data).
 * 
 * Returns NULL when using the CLI SAPI.
 */
PHP_FUNCTION(http_get_request_body)
{
        char *body;
        size_t length;

        NO_ARGS;

        if (SUCCESS == http_get_request_body(&body, &length)) {
                RETURN_STRINGL(body, (int) length, 0);
        } else {
                RETURN_NULL();
        }
}
/* }}} */

/* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
 *
 * Match an incoming HTTP header.
 * 
 * Expects two string parameters representing the header name (case-insensitive)
 * and the header value that should be compared.  The case sensitivity of the
 * header value depends on the additional optional bool parameter accepted.
 * 
 * Returns TRUE if header value matches, else FALSE.
 */
PHP_FUNCTION(http_match_request_header)
{
        char *header, *value;
        int header_len, value_len;
        zend_bool match_case = 0;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|b", &header, &header_len, &value, &value_len, &match_case)) {
                RETURN_FALSE;
        }

        RETURN_BOOL(http_match_request_header_ex(header, value, match_case));
}
/* }}} */

/* {{{ HAVE_CURL */
#ifdef HTTP_HAVE_CURL

/* {{{ proto string http_get(string url[, array options[, array &info]])
 *
 * Performs an HTTP GET request on the supplied url.
 *
 * The second parameter, if set, is expected to be an associative
 * array where the following keys will be recognized:
 * <pre>
 *  - redirect:         int, whether and how many redirects to follow
 *  - unrestrictedauth: bool, whether to continue sending credentials on
 *                      redirects to a different host
 *  - proxyhost:        string, proxy host in "host[:port]" format
 *  - proxyport:        int, use another proxy port as specified in proxyhost
 *  - proxyauth:        string, proxy credentials in "user:pass" format
 *  - proxyauthtype:    int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
 *  - httpauth:         string, http credentials in "user:pass" format
 *  - httpauthtype:     int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
 *  - compress:         bool, whether to allow gzip/deflate content encoding
 *                      (defaults to true)
 *  - port:             int, use another port as specified in the url
 *  - referer:          string, the referer to sends
 *  - useragent:        string, the user agent to send
 *                      (defaults to PECL::HTTP/version (PHP/version)))
 *  - headers:          array, list of custom headers as associative array
 *                      like array("header" => "value")
 *  - cookies:          array, list of cookies as associative array
 *                      like array("cookie" => "value")
 *  - cookiestore:      string, path to a file where cookies are/will be stored
 *  - resume:           int, byte offset to start the download from;
 *                      if the server supports ranges
 *  - maxfilesize:      int, maximum file size that should be downloaded;
 *                      has no effect, if the size of the requested entity is not known
 *  - lastmodified:     int, timestamp for If-(Un)Modified-Since header
 *  - timeout:          int, seconds the request may take
 *  - connecttimeout:   int, seconds the connect may take
 *  - onprogress:       mixed, progress callback
 * </pre>
 *
 * The optional third parameter will be filled with some additional information
 * in form af an associative array, if supplied, like the following example:
 * <pre>
 * <?php
 * array (
 *     'effective_url' => 'http://localhost',
 *     'response_code' => 403,
 *     'total_time' => 0.017,
 *     'namelookup_time' => 0.013,
 *     'connect_time' => 0.014,
 *     'pretransfer_time' => 0.014,
 *     'size_upload' => 0,
 *     'size_download' => 202,
 *     'speed_download' => 11882,
 *     'speed_upload' => 0,
 *     'header_size' => 145,
 *     'request_size' => 62,
 *     'ssl_verifyresult' => 0,
 *     'filetime' => -1,
 *     'content_length_download' => 202,
 *     'content_length_upload' => 0,
 *     'starttransfer_time' => 0.017,
 *     'content_type' => 'text/html; charset=iso-8859-1',
 *     'redirect_time' => 0,
 *     'redirect_count' => 0,
 *     'http_connectcode' => 0,
 *     'httpauth_avail' => 0,
 *     'proxyauth_avail' => 0,
 * )
 * ?>
 * </pre>
 * 
 * Returns the HTTP response(s) as string on success, or FALSE on failure.
 */
PHP_FUNCTION(http_get)
{
        zval *options = NULL, *info = NULL;
        char *URL;
        int URL_len;
        phpstr response;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }

        if (info) {
                zval_dtor(info);
                array_init(info);
        }

        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
        if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETURN_PHPSTR_VAL(&response);
        } else {
                RETURN_FALSE;
        }
}
/* }}} */

/* {{{ proto string http_head(string url[, array options[, array &info]])
 *
 * Performs an HTTP HEAD request on the supplied url.
 * 
 * See http_get() for a full list of available parameters and options.
 * 
 * Returns the HTTP response as string on success, or FALSE on failure.
 */
PHP_FUNCTION(http_head)
{
        zval *options = NULL, *info = NULL;
        char *URL;
        int URL_len;
        phpstr response;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }

        if (info) {
                zval_dtor(info);
                array_init(info);
        }

        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
        if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETURN_PHPSTR_VAL(&response);
        } else {
                RETURN_FALSE;
        }
}
/* }}} */

/* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
 *
 * Performs an HTTP POST requeston the supplied url.
 * 
 * Expects a string as second parameter containing the pre-encoded post data.
 * See http_get() for a full list of available parameters and options.
 *  
 * Returns the HTTP response(s) as string on success, or FALSE on failure.
 */
PHP_FUNCTION(http_post_data)
{
        zval *options = NULL, *info = NULL;
        char *URL, *postdata;
        int postdata_len, URL_len;
        phpstr response;
        http_request_body body;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }

        if (info) {
                zval_dtor(info);
                array_init(info);
        }

        body.type = HTTP_REQUEST_BODY_CSTRING;
        body.data = postdata;
        body.size = postdata_len;

        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
        if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETVAL_PHPSTR_VAL(&response);
        } else {
                RETVAL_FALSE;
        }
}
/* }}} */

/* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
 *
 * Performs an HTTP POST request on the supplied url.
 * 
 * Expecrs an associative array as second parameter, which will be
 * www-form-urlencoded. See http_get() for a full list of available options.
 * 
 * Returns the HTTP response(s) as string on success, or FALSE on failure.
 */
PHP_FUNCTION(http_post_fields)
{
        zval *options = NULL, *info = NULL, *fields, *files = NULL;
        char *URL;
        int URL_len;
        phpstr response;
        http_request_body body;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|aa/!z", &URL, &URL_len, &fields, &files, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }

        if (SUCCESS != http_request_body_fill(&body, Z_ARRVAL_P(fields), files ? Z_ARRVAL_P(files) : NULL)) {
                RETURN_FALSE;
        }

        if (info) {
                zval_dtor(info);
                array_init(info);
        }

        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
        if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETVAL_PHPSTR_VAL(&response);
        } else {
                RETVAL_FALSE;
        }
        http_request_body_dtor(&body);
}
/* }}} */

/* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
 *
 * Performs an HTTP PUT request on the supplied url.
 * 
 * Expects the second parameter to be a string referncing the file to upload.
 * See http_get() for a full list of available options.
 * 
 * Returns the HTTP response(s) as string on success, or FALSE on failure.
 */
PHP_FUNCTION(http_put_file)
{
        char *URL, *file;
        int URL_len, f_len;
        zval *options = NULL, *info = NULL;
        phpstr response;
        php_stream *stream;
        php_stream_statbuf ssb;
        http_request_body body;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &file, &f_len, &options, &info)) {
                RETURN_FALSE;
        }

        if (!(stream = php_stream_open_wrapper(file, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL))) {
                RETURN_FALSE;
        }
        if (php_stream_stat(stream, &ssb)) {
                php_stream_close(stream);
                RETURN_FALSE;
        }

        if (info) {
                zval_dtor(info);
                array_init(info);
        }

        body.type = HTTP_REQUEST_BODY_UPLOADFILE;
        body.data = stream;
        body.size = ssb.sb.st_size;

        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
        if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETVAL_PHPSTR_VAL(&response);
        } else {
                RETVAL_FALSE;
        }
        http_request_body_dtor(&body);
}
/* }}} */

/* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
 *
 * Performs an HTTP PUT request on the supplied url.
 * 
 * Expects the second parameter to be a resource referencing an already 
 * opened stream, from which the data to upload should be read.
 * See http_get() for a full list of available options.
 * 
 * Returns the HTTP response(s) as string on success. or FALSE on failure.
 */
PHP_FUNCTION(http_put_stream)
{
        zval *resource, *options = NULL, *info = NULL;
        char *URL;
        int URL_len;
        phpstr response;
        php_stream *stream;
        php_stream_statbuf ssb;
        http_request_body body;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sr|a/!z", &URL, &URL_len, &resource, &options, &info)) {
                RETURN_FALSE;
        }

        php_stream_from_zval(stream, &resource);
        if (php_stream_stat(stream, &ssb)) {
                RETURN_FALSE;
        }

        if (info) {
                zval_dtor(info);
                array_init(info);
        }

        body.type = HTTP_REQUEST_BODY_UPLOADFILE;
        body.data = stream;
        body.size = ssb.sb.st_size;

        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
        if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETURN_PHPSTR_VAL(&response);
        } else {
                RETURN_NULL();
        }
}
/* }}} */
#endif /* HTTP_HAVE_CURL */
/* }}} HAVE_CURL */

/* {{{ proto int http_request_method_register(string method)
 *
 * Register a custom request method.
 * 
 * Expects a string parameter containing the request method name to register.
 * 
 * Returns the ID of the request method on success, or FALSE on failure.
 */
PHP_FUNCTION(http_request_method_register)
{
        char *method;
        int *method_len;
        unsigned long existing;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
                RETURN_FALSE;
        }
        if (existing = http_request_method_exists(1, 0, method)) {
                RETURN_LONG((long) existing);
        }

        RETVAL_LONG((long) http_request_method_register(method));
}
/* }}} */

/* {{{ proto bool http_request_method_unregister(mixed method)
 *
 * Unregister a previously registered custom request method.
 * 
 * Expects either the request method name or ID.
 * 
 * Returns TRUE on success, or FALSE on failure.
 */
PHP_FUNCTION(http_request_method_unregister)
{
        zval *method;

        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
                RETURN_FALSE;
        }

        switch (Z_TYPE_P(method))
        {
                case IS_OBJECT:
                        convert_to_string(method);
                case IS_STRING:
                        if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
                                convert_to_long(method);
                        } else {
                                unsigned long mn;
                                if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
                                        RETURN_FALSE;
                                }
                                zval_dtor(method);
                                ZVAL_LONG(method, (long)mn);
                        }
                case IS_LONG:
                        RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method)));
                default:
                        RETURN_FALSE;
        }
}
/* }}} */

/* {{{ proto long http_request_method_exists(mixed method)
 *
 * Check if a request method is registered (or available by default).
 * 
 * Expects either the request method name or ID as parameter.
 * 
 * Returns TRUE if the request method is known, else FALSE.
 */
PHP_FUNCTION(http_request_method_exists)
{
        IF_RETVAL_USED {
                zval *method;

                if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
                        RETURN_FALSE;
                }

                switch (Z_TYPE_P(method))
                {
                        case IS_OBJECT:
                                convert_to_string(method);
                        case IS_STRING:
                                if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
                                        convert_to_long(method);
                                } else {
                                        RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method)));
                                }
                        case IS_LONG:
                                RETURN_LONG((long) http_request_method_exists(0, Z_LVAL_P(method), NULL));
                        default:
                                RETURN_FALSE;
                }
        }
}
/* }}} */

/* {{{ proto string http_request_method_name(int method)
 *
 * Get the literal string representation of a standard or registered request method.
 * 
 * Expects the request method ID as parameter.
 * 
 * Returns the request method name as string on success, or FALSE on failure.
 */
PHP_FUNCTION(http_request_method_name)
{
        IF_RETVAL_USED {
                long method;

                if ((SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &method)) || (method < 0)) {
                        RETURN_FALSE;
                }

                RETURN_STRING(estrdup(http_request_method_name((unsigned long) method)), 0);
        }
}
/* }}} */

/* {{{ Sara Golemons http_build_query() */
#ifndef ZEND_ENGINE_2

/* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
   Generates a form-encoded query string from an associative array or object. */
PHP_FUNCTION(http_build_query)
{
        zval *formdata;
        char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
        int prefix_len = 0, arg_sep_len = strlen(arg_sep);
        phpstr *formstr;

        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
                RETURN_FALSE;
        }

        if (Z_TYPE_P(formdata) != IS_ARRAY && Z_TYPE_P(formdata) != IS_OBJECT) {
                http_error(HE_WARNING, HTTP_E_INVALID_PARAM, "Parameter 1 expected to be Array or Object.  Incorrect value given.");
                RETURN_FALSE;
        }

        if (!arg_sep_len) {
                arg_sep = HTTP_URL_ARGSEP;
        }

        formstr = phpstr_new();
        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))) {
                phpstr_free(&formstr);
                RETURN_FALSE;
        }

        if (!formstr->used) {
                phpstr_free(&formstr);
                RETURN_NULL();
        }

        RETURN_PHPSTR_PTR(formstr);
}
/* }}} */
#endif /* !ZEND_ENGINE_2 */
/* }}} */

PHP_FUNCTION(http_test)
{
}

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */