* rename http_parse_header to http_parse_headers
[m6w6/ext-http] / http.c
diff --git a/http.c b/http.c
index 41e463e0ec03f9928ae8df6af6841ae982f92362..6efc142e9745cf43fd8ff9be481736e480d1626c 100644 (file)
--- a/http.c
+++ b/http.c
 
 /* $Id$ */
 
+#define ZEND_INCLUDE_FULL_WINDOWS_HEADERS
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "php.h"
-#include "main/snprintf.h"
+#include "snprintf.h"
 #include "ext/standard/info.h"
-#include "ext/standard/datetime.h"
 #include "ext/session/php_session.h"
 #include "ext/standard/php_string.h"
 #include "ext/standard/php_smart_str.h"
 #include "php_http.h"
 #include "php_http_api.h"
 
-#if defined(HAVE_CURL) && HAVE_CURL
+#ifdef ZEND_ENGINE_2
+#include "ext/standard/php_http.h"
+#endif
+
+#ifdef HTTP_HAVE_CURL
+
+#ifdef PHP_WIN32
+#include <winsock2.h>
+#include <sys/types.h>
+#endif
+
 #include <curl/curl.h>
 #endif
 
@@ -53,7 +64,6 @@ function_entry http_functions[] = {
        PHP_FE(http_match_etag, NULL)
        PHP_FE(http_cache_last_modified, NULL)
        PHP_FE(http_cache_etag, NULL)
-       PHP_FE(http_accept_ranges, NULL)
        PHP_FE(http_content_type, NULL)
        PHP_FE(http_content_disposition, NULL)
        PHP_FE(http_send_data, NULL)
@@ -61,7 +71,8 @@ function_entry http_functions[] = {
        PHP_FE(http_send_stream, NULL)
        PHP_FE(http_chunked_decode, NULL)
        PHP_FE(http_split_response, NULL)
-#if defined(HAVE_CURL) && HAVE_CURL
+       PHP_FE(http_parse_headers, NULL)
+#ifdef HTTP_HAVE_CURL
        PHP_FE(http_get, NULL)
        PHP_FE(http_head, NULL)
        PHP_FE(http_post_data, NULL)
@@ -69,6 +80,9 @@ function_entry http_functions[] = {
 #endif
        PHP_FE(http_auth_basic, NULL)
        PHP_FE(http_auth_basic_cb, NULL)
+#ifndef ZEND_ENGINE_2
+       PHP_FE(http_build_query, NULL)
+#endif
        {NULL, NULL, NULL}
 };
 /* }}} */
@@ -93,6 +107,7 @@ zend_module_entry http_module_entry = {
 /* }}} */
 
 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
+#define HASH_ORNULL(z) ((z) ? Z_ARRVAL_P(z) : NULL)
 
 /* {{{ proto string http_date([int timestamp])
  *
@@ -242,10 +257,6 @@ PHP_FUNCTION(http_negotiate_charset)
 /* {{{ proto bool http_send_status(int status)
  *
  * Send HTTP status code.
- * This function sends the desired HTTP status code along with its corresponding
- * status message, e.g. calling http_send_status(304) will issue a
- * "Status: 304 Not Modified" with CGI-SAPIs and "HTTP/1.1 304 Not Modified"
- * when PHP is run as web server module.
  *
  */
 PHP_FUNCTION(http_send_status)
@@ -268,7 +279,7 @@ PHP_FUNCTION(http_send_status)
  *
  * This converts the given timestamp to a valid HTTP date and
  * sends it as "Last-Modified" HTTP header.  If timestamp is
- * omitted, current time is taken.
+ * omitted, current time is sent.
  *
  */
 PHP_FUNCTION(http_send_last_modified)
@@ -289,7 +300,7 @@ PHP_FUNCTION(http_send_last_modified)
 
 /* {{{ proto bool http_match_modified([int timestamp])
  *
- * Matches the given timestamp against the clients "If-Modified-Since" and
+ * Matches the given timestamp against the clients "If-Modified-Since" resp.
  * "If-Unmodified-Since" HTTP headers.
  *
  */
@@ -313,7 +324,7 @@ PHP_FUNCTION(http_match_modified)
 /* {{{ proto bool http_match_etag(string etag)
  *
  * This matches the given ETag against the clients
- * "If-Match" and "If-None-Match" HTTP headers.
+ * "If-Match" resp. "If-None-Match" HTTP headers.
  *
  */
 PHP_FUNCTION(http_match_etag)
@@ -334,7 +345,7 @@ PHP_FUNCTION(http_match_etag)
  * If timestamp_or_exires 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 tim in seconds, which means that if the
+ * 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.
  *
@@ -352,12 +363,12 @@ PHP_FUNCTION(http_cache_last_modified)
 
        /* 0 or omitted */
        if (!last_modified) {
-               /* does the client have? */
+               /* 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));
-               /* use current time */
+               /* send current time */
                } else {
-                       last_modified = send_modified = t;
+                       send_modified = t;
                }
        /* negative value is supposed to be expiration time */
        } else if (last_modified < 0) {
@@ -402,8 +413,7 @@ PHP_FUNCTION(http_cache_etag)
                RETURN_FALSE;
        }
 
-       /* send remaining data to nirvana */
-       http_send_header("Connection: close");
+       php_end_ob_buffers(0 TSRMLS_CC);
        http_send_header("Cache-Control: private, must-revalidate, max-age=0");
 
        /* if no etag is given and we didn't already
@@ -439,6 +449,8 @@ PHP_FUNCTION(http_cache_etag)
  * ("301 Moved Permanently") or a temporary ("302 Found") redirection
  * status code.
  *
+ * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
+ * if the client doesn't redirect immediatly.
  */
 PHP_FUNCTION(http_redirect)
 {
@@ -446,9 +458,9 @@ PHP_FUNCTION(http_redirect)
        zend_bool session = 0, permanent = 0;
        zval *params = NULL;
        smart_str qstr = {0};
-       char *url, *URI, LOC[HTTP_URI_MAXLEN + 9];
+       char *url, *URI, LOC[HTTP_URI_MAXLEN + 9], RED[HTTP_URI_MAXLEN * 2 + 34];
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!bb", &url, &url_len, &params, &session, &permanent) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bb", &url, &url_len, &params, &session, &permanent) != SUCCESS) {
                RETURN_FALSE;
        }
 
@@ -478,13 +490,19 @@ PHP_FUNCTION(http_redirect)
        URI = http_absolute_uri(url, NULL);
        if (qstr.c) {
                snprintf(LOC, HTTP_URI_MAXLEN + strlen("Location: "), "Location: %s?%s", URI, qstr.c);
+               sprintf(RED, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, qstr.c, URI, qstr.c);
                efree(qstr.c);
        } else {
                snprintf(LOC, HTTP_URI_MAXLEN + strlen("Location: "), "Location: %s", URI);
+               sprintf(RED, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
        }
        efree(URI);
 
-       RETVAL_BOOL((SUCCESS == http_send_header(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302))));
+       if ((SUCCESS == http_send_header(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) {
+               php_body_write(RED, strlen(RED) TSRMLS_CC);
+               RETURN_TRUE;
+       }
+       RETURN_FALSE;
 }
 /* }}} */
 
@@ -502,7 +520,7 @@ PHP_FUNCTION(http_send_data)
        }
 
        convert_to_string_ex(&zdata);
-
+       http_send_header("Accept-Ranges: bytes");
        RETURN_SUCCESS(http_send_data(zdata));
 }
 /* }}} */
@@ -521,7 +539,7 @@ PHP_FUNCTION(http_send_file)
        }
 
        convert_to_string_ex(&zfile);
-
+       http_send_header("Accept-Ranges: bytes");
        RETURN_SUCCESS(http_send_file(zfile));
 }
 /* }}} */
@@ -541,36 +559,11 @@ PHP_FUNCTION(http_send_stream)
        }
 
        php_stream_from_zval(file, &zstream);
-
+       http_send_header("Accept-Ranges: bytes");
        RETURN_SUCCESS(http_send_stream(file));
 }
 /* }}} */
 
-/* {{{ proto bool http_accept_ranges(void)
- *
- * Issues a "Accept-Ranges: bytes" header.
- *
- * Example:
- * <pre>
- * <?php
- * http_content_type('application/x-zip');
- * http_content_disposition('latest.zip');
- * http_accept_ranges();
- * http_cache_etag();
- * http_send_file('../some/download.zip');
- * ?>
- * </pre>
- *
- */
-PHP_FUNCTION(http_accept_ranges)
-{
-       if (ZEND_NUM_ARGS()) {
-               WRONG_PARAM_COUNT;
-       }
-       RETURN_SUCCESS(http_send_header("Accept-Ranges: bytes"));
-}
-/* }}} */
-
 /* {{{ proto bool http_content_type([string content_type = 'application/x-octetstream'])
  *
  * Sets the content type.
@@ -685,7 +678,10 @@ PHP_FUNCTION(http_split_response)
        MAKE_STD_ZVAL(zheaders);
        array_init(zheaders);
 
-       http_split_response(zresponse, zheaders, zbody);
+       if (SUCCESS != http_split_response(zresponse, zheaders, zbody)) {
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not parse HTTP response");
+               RETURN_FALSE;
+       }
 
        array_init(return_value);
        add_index_zval(return_value, 0, zheaders);
@@ -693,19 +689,42 @@ PHP_FUNCTION(http_split_response)
 }
 /* }}} */
 
+/* {{{ proto array http_parse_headers(string header) */
+PHP_FUNCTION(http_parse_headers)
+{
+       char *header, *rnrn;
+       int header_len;
+
+       if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
+               RETURN_FALSE;
+       }
+
+       array_init(return_value);
+
+       if (rnrn = strstr(header, HTTP_CRLF HTTP_CRLF)) {
+               header_len = rnrn - header + 2;
+       }
+       if (SUCCESS != http_parse_headers(header, header_len, return_value)) {
+               php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not parse HTTP header");
+               zval_dtor(return_value);
+               RETURN_FALSE;
+       }
+}
+/* }}}*/
+
 /* {{{ HAVE_CURL */
-#if defined(HAVE_CURL) && HAVE_CURL
+#ifdef HTTP_HAVE_CURL
 
-/* {{{ proto string http_get(string url[, array options])
+/* {{{ proto string http_get(string url[, array options[, array &info]])
  *
  * Performs an HTTP GET request on the supplied url.
  *
  * The second parameter is expected to be an associative
  * array where the following keys will be recognized:
  * <pre>
- *  - redirect:        int, whether and how many redirects to follow
+ *  - redirect:         int, whether and how many redirects to follow
  *  - unrestrictedauth: bool, whether to continue sending credentials on
- *                         redirects to a different host
+ *                      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
@@ -713,26 +732,39 @@ PHP_FUNCTION(http_split_response)
  *  - 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
- *  - headers:          array, list of custom headers in "header: value" format
- *  - cookies:          array, list of cookies in "name=value" format
+ *                      (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
  * </pre>
+ *
+ * The optional third parameter will be filled with some additional information
+ * in form af an associative array, if supplied (don't forget to initialize it
+ * with NULL or array()).
  */
 PHP_FUNCTION(http_get)
 {
        char *URL, *data = NULL;
        size_t data_len = 0;
        int URL_len;
-       zval *options = NULL;
+       zval *options = NULL, *info = NULL;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a", &URL, &URL_len, &options) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }
 
-       if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, &data, &data_len)) {
+       if (info) {
+               zval_dtor(info);
+               array_init(info);
+       }
+
+       if (SUCCESS == http_get(URL, HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
                RETURN_STRINGL(data, data_len, 0);
        } else {
                RETURN_FALSE;
@@ -740,7 +772,7 @@ PHP_FUNCTION(http_get)
 }
 /* }}} */
 
-/* {{{ proto string http_head(string url[, array options])
+/* {{{ proto string http_head(string url[, array options[, array &info]])
  *
  * Performs an HTTP HEAD request on the suppied url.
  * Returns the HTTP response as string.
@@ -751,13 +783,18 @@ PHP_FUNCTION(http_head)
        char *URL, *data = NULL;
        size_t data_len = 0;
        int URL_len;
-       zval *options = NULL;
+       zval *options = NULL, *info = NULL;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a", &URL, &URL_len, &options) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }
 
-       if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, &data, &data_len)) {
+       if (info) {
+               zval_dtor(info);
+               array_init(info);
+       }
+
+       if (SUCCESS == http_head(URL, HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
                RETURN_STRINGL(data, data_len, 0);
        } else {
                RETURN_FALSE;
@@ -765,7 +802,7 @@ PHP_FUNCTION(http_head)
 }
 /* }}} */
 
-/* {{{ proto string http_post_data(string url, string data[, array options])
+/* {{{ proto string http_post_data(string url, string data[, array options[, &info]])
  *
  * Performs an HTTP POST request, posting data.
  * Returns the HTTP response as string.
@@ -776,13 +813,18 @@ PHP_FUNCTION(http_post_data)
        char *URL, *postdata, *data = NULL;
        size_t data_len = 0;
        int postdata_len, URL_len;
-       zval *options = NULL;
+       zval *options = NULL, *info = NULL;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a", &URL, &URL_len, &postdata, &postdata_len, &options) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }
 
-       if (SUCCESS == http_post_data(URL, postdata, (size_t) postdata_len, options ? Z_ARRVAL_P(options) : NULL, &data, &data_len)) {
+       if (info) {
+               zval_dtor(info);
+               array_init(info);
+       }
+
+       if (SUCCESS == http_post_data(URL, postdata, (size_t) postdata_len, HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
                RETURN_STRINGL(data, data_len, 0);
        } else {
                RETURN_FALSE;
@@ -790,7 +832,7 @@ PHP_FUNCTION(http_post_data)
 }
 /* }}} */
 
-/* {{{ proto string http_post_data(string url, array data[, array options])
+/* {{{ proto string http_post_array(string url, array data[, array options[, array &info]])
  *
  * Performs an HTTP POST request, posting www-form-urlencoded array data.
  * Returns the HTTP response as string.
@@ -801,13 +843,18 @@ PHP_FUNCTION(http_post_array)
        char *URL, *data = NULL;
        size_t data_len = 0;
        int URL_len;
-       zval *options = NULL, *postdata;
+       zval *options = NULL, *info = NULL, *postdata;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|a", &URL, &URL_len, &postdata, &options) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|a/!z", &URL, &URL_len, &postdata, &options, &info) != SUCCESS) {
                RETURN_FALSE;
        }
 
-       if (SUCCESS == http_post_array(URL, Z_ARRVAL_P(postdata), options ? Z_ARRVAL_P(options) : NULL, &data, &data_len)) {
+       if (info) {
+               zval_dtor(info);
+               array_init(info);
+       }
+
+       if (SUCCESS == http_post_array(URL, Z_ARRVAL_P(postdata), HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
                RETURN_STRINGL(data, data_len, 0);
        } else {
                RETURN_FALSE;
@@ -935,7 +982,9 @@ static void php_http_init_globals(zend_http_globals *http_globals)
 {
        http_globals->etag_started = 0;
        http_globals->ctype = NULL;
-#if defined(HAVE_CURL) && HAVE_CURL
+       http_globals->etag  = NULL;
+       http_globals->lmod  = 0;
+#ifdef HTTP_HAVE_CURL
        http_globals->curlbuf.body.data = NULL;
        http_globals->curlbuf.body.used = 0;
        http_globals->curlbuf.body.free = 0;
@@ -950,7 +999,7 @@ static void php_http_init_globals(zend_http_globals *http_globals)
 PHP_MINIT_FUNCTION(http)
 {
        ZEND_INIT_MODULE_GLOBALS(http, php_http_init_globals, NULL);
-#if defined(HAVE_CURL) && HAVE_CURL
+#ifdef HTTP_HAVE_CURL
        REGISTER_LONG_CONSTANT("HTTP_AUTH_BASIC", CURLAUTH_BASIC, CONST_CS | CONST_PERSISTENT);
        REGISTER_LONG_CONSTANT("HTTP_AUTH_DIGEST", CURLAUTH_DIGEST, CONST_CS | CONST_PERSISTENT);
        REGISTER_LONG_CONSTANT("HTTP_AUTH_NTLM", CURLAUTH_NTLM, CONST_CS | CONST_PERSISTENT);
@@ -965,7 +1014,10 @@ PHP_RSHUTDOWN_FUNCTION(http)
        if (HTTP_G(ctype)) {
                efree(HTTP_G(ctype));
        }
-#if defined(HAVE_CURL) && HAVE_CURL
+       if (HTTP_G(etag)) {
+               efree(HTTP_G(etag));
+       }
+#ifdef HTTP_HAVE_CURL
        if (HTTP_G(curlbuf).body.data) {
                efree(HTTP_G(curlbuf).body.data);
        }
@@ -984,7 +1036,7 @@ PHP_MINFO_FUNCTION(http)
        php_info_print_table_header(2, "Extended HTTP support", "enabled");
        php_info_print_table_row(2, "Version:", PHP_EXT_HTTP_VERSION);
        php_info_print_table_row(2, "cURL convenience functions:",
-#if defined(HAVE_CURL) && HAVE_CURL
+#ifdef HTTP_HAVE_CURL
                        "enabled"
 #else
                        "disabled"
@@ -1002,3 +1054,4 @@ PHP_MINFO_FUNCTION(http)
  * vim600: noet sw=4 ts=4 fdm=marker
  * vim<600: noet sw=4 ts=4
  */
+