- added INI setting http.force_exit which can be used to disable script termination
[m6w6/ext-http] / http_functions.c
index ae08b4fa7350e5ba9452c7698035e651e536c7b4..3ec05777fc273bbdacb68533fa97545a2403547c 100644 (file)
@@ -1,16 +1,13 @@
 /*
-   +----------------------------------------------------------------------+
-   | 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>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2005, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
@@ -140,9 +137,10 @@ PHP_FUNCTION(http_build_uri)
                } \
                \
                if (rs_array) { \
+                       HashPosition pos; \
                        zval **value; \
                         \
-                       FOREACH_VAL(supported, value) { \
+                       FOREACH_VAL(pos, supported, value) { \
                                convert_to_string_ex(value); \
                                add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
                        } \
@@ -441,6 +439,8 @@ PHP_FUNCTION(http_cache_last_modified)
        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
                RETURN_FALSE;
        }
+       
+       HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
 
        t = (long) time(NULL);
 
@@ -488,6 +488,8 @@ PHP_FUNCTION(http_cache_etag)
        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
                RETURN_FALSE;
        }
+       
+       HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
 
        RETURN_SUCCESS(http_cache_etag(etag, etag_len, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
 }
@@ -513,7 +515,7 @@ PHP_FUNCTION(ob_etaghandler)
 }
 /* }}} */
 
-/* {{{ proto void http_throttle(double sec[, int bytes = 2097152])
+/* {{{ proto void http_throttle(double sec[, int bytes = 40960])
  *
  * 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
@@ -755,7 +757,7 @@ PHP_FUNCTION(http_chunked_decode)
                RETURN_FALSE;
        }
 
-       if (NULL != http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) {
+       if (NULL != http_encoding_dechunk(encoded, encoded_len, &decoded, &decoded_len)) {
                RETURN_STRINGL(decoded, (int) decoded_len, 0);
        } else {
                RETURN_FALSE;
@@ -956,7 +958,7 @@ PHP_FUNCTION(http_match_request_header)
  *  - 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
+ *  - referer:          string, the referer to send
  *  - useragent:        string, the user agent to send
  *                      (defaults to PECL::HTTP/version (PHP/version)))
  *  - headers:          array, list of custom headers as associative array
@@ -1028,6 +1030,7 @@ PHP_FUNCTION(http_get)
        if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETURN_PHPSTR_VAL(&response);
        } else {
+               phpstr_dtor(&response);
                RETURN_FALSE;
        }
 }
@@ -1061,6 +1064,7 @@ PHP_FUNCTION(http_head)
        if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETURN_PHPSTR_VAL(&response);
        } else {
+               phpstr_dtor(&response);
                RETURN_FALSE;
        }
 }
@@ -1100,6 +1104,7 @@ PHP_FUNCTION(http_post_data)
        if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETVAL_PHPSTR_VAL(&response);
        } else {
+               phpstr_dtor(&response);
                RETVAL_FALSE;
        }
 }
@@ -1139,6 +1144,7 @@ PHP_FUNCTION(http_post_fields)
        if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETVAL_PHPSTR_VAL(&response);
        } else {
+               phpstr_dtor(&response);
                RETVAL_FALSE;
        }
        http_request_body_dtor(&body);
@@ -1189,6 +1195,7 @@ PHP_FUNCTION(http_put_file)
        if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETVAL_PHPSTR_VAL(&response);
        } else {
+               phpstr_dtor(&response);
                RETVAL_FALSE;
        }
        http_request_body_dtor(&body);
@@ -1237,6 +1244,7 @@ PHP_FUNCTION(http_put_stream)
        if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
                RETURN_PHPSTR_VAL(&response);
        } else {
+               phpstr_dtor(&response);
                RETURN_NULL();
        }
 }
@@ -1256,7 +1264,7 @@ PHP_FUNCTION(http_request_method_register)
 {
        char *method;
        int method_len;
-       unsigned long existing;
+       ulong existing;
 
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
                RETURN_FALSE;
@@ -1293,7 +1301,7 @@ PHP_FUNCTION(http_request_method_unregister)
                        if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
                                convert_to_long(method);
                        } else {
-                               unsigned long mn;
+                               ulong mn;
                                if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
                                        RETURN_FALSE;
                                }
@@ -1361,7 +1369,7 @@ PHP_FUNCTION(http_request_method_name)
                        RETURN_FALSE;
                }
 
-               RETURN_STRING(estrdup(http_request_method_name((unsigned long) method)), 0);
+               RETURN_STRING(estrdup(http_request_method_name((ulong) method)), 0);
        }
 }
 /* }}} */
@@ -1378,21 +1386,17 @@ PHP_FUNCTION(http_build_query)
        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.");
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
                RETURN_FALSE;
        }
 
        if (!arg_sep_len) {
                arg_sep = HTTP_URL_ARGSEP;
+               arg_sep_len = lenof(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))) {
+       if (SUCCESS != http_urlencode_hash_recursive(HASH_OF(formdata), formstr, arg_sep, arg_sep_len, prefix, prefix_len)) {
                phpstr_free(&formstr);
                RETURN_FALSE;
        }
@@ -1408,6 +1412,226 @@ PHP_FUNCTION(http_build_query)
 #endif /* !ZEND_ENGINE_2 */
 /* }}} */
 
+/* {{{ */
+#ifdef HTTP_HAVE_ZLIB
+
+/* {{{ proto string http_gzencode(string data[, int level = -1])
+ *
+ * Compress data with the HTTP compatible GZIP encoding.
+ * 
+ * Expects the first parameter to be a string which contains the data that
+ * should be encoded.  Additionally accepts an optional in paramter specifying
+ * the compression level, where -1 is default, 0 is no compression and 9 is
+ * best compression ratio.
+ * 
+ * Returns the encoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_gzencode)
+{
+       char *data;
+       int data_len;
+       long level = -1;
+
+       RETVAL_NULL();
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &level)) {
+               HTTP_CHECK_GZIP_LEVEL(level, return);
+               {
+                       char *encoded;
+                       size_t encoded_len;
+                       
+                       if (SUCCESS == http_encoding_gzencode(level, data, data_len, &encoded, &encoded_len)) {
+                               RETURN_STRINGL(encoded, (int) encoded_len, 0);
+                       }
+               }
+       }
+}
+/* }}} */
+
+/* {{{ proto string http_gzdecode(string data)
+ *
+ * Uncompress data compressed with the HTTP compatible GZIP encoding.
+ * 
+ * Expects a string as parameter containing the compressed data.
+ * 
+ * Returns the decoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_gzdecode)
+{
+       char *data;
+       int data_len;
+       
+       RETVAL_NULL();
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len)) {
+               char *decoded;
+               size_t decoded_len;
+               
+               if (SUCCESS == http_encoding_gzdecode(data, data_len, &decoded, &decoded_len)) {
+                       RETURN_STRINGL(decoded, (int) decoded_len, 0);
+               }
+       }
+}
+/* }}} */
+
+/* {{{  proto string http_deflate(string data[, int level = -1])
+ *
+ * Compress data with the HTTP compatible DEFLATE encoding.
+ * 
+ * Expects the first parameter to be a string containing the data that should
+ * be encoded.  Additionally accepts an optional int parameter specifying the
+ * compression level, where -1 is default, 0 is no compression and 9 is best
+ * compression ratio.
+ * 
+ * Returns the encoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_deflate)
+{
+       char *data;
+       int data_len;
+       long level = -1;
+       
+       RETVAL_NULL();
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &level)) {
+               HTTP_CHECK_GZIP_LEVEL(level, return);
+               {
+                       char *encoded;
+                       size_t encoded_len;
+                       
+                       if (SUCCESS == http_encoding_deflate(level, data, data_len, &encoded, &encoded_len)) {
+                               RETURN_STRINGL(encoded, (int) encoded_len, 0);
+                       }
+               }
+       }
+}
+/* }}} */
+
+/* {{{ proto string http_inflate(string data)
+ *
+ * Uncompress data compressed with the HTTP compatible DEFLATE encoding.
+ * 
+ * Expects a string as parameter containing the compressed data.
+ * 
+ * Returns the decoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_inflate)
+{
+       char *data;
+       int data_len;
+       
+       RETVAL_NULL();
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len)) {
+               char *decoded;
+               size_t decoded_len;
+               
+               if (SUCCESS == http_encoding_inflate(data, data_len, &decoded, &decoded_len)) {
+                       RETURN_STRINGL(decoded, (int) decoded_len, 0);
+               }
+       }
+}
+/* }}} */
+
+/* {{{ proto string http_compress(string data[, int level = -1])
+ *
+ * Compress data with the HTTP compatible COMPRESS encoding.
+ * 
+ * Expects the first parameter to be a string containing the data which should
+ * be encoded.  Additionally accepts an optional int parameter specifying the
+ * compression level, where -1 is default, 0 is no compression and 9 is best
+ * compression ratio.
+ * 
+ * Returns the encoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_compress)
+{
+       char *data;
+       int data_len;
+       long level = -1;
+       
+       RETVAL_NULL();
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &level)) {
+               HTTP_CHECK_GZIP_LEVEL(level, return);
+               {
+                       char *encoded;
+                       size_t encoded_len;
+                       
+                       if (SUCCESS == http_encoding_compress(level, data, data_len, &encoded, &encoded_len)) {
+                               RETURN_STRINGL(encoded, (int) encoded_len, 0);
+                       }
+               }
+       }
+}
+/* }}} */
+
+/* {{{ proto string http_uncompress(string data)
+ *
+ * Uncompress data compressed with the HTTP compatible COMPRESS encoding.
+ * 
+ * Expects a string as parameter containing the compressed data.
+ * 
+ * Returns the decoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_uncompress)
+{
+       char *data;
+       int data_len;
+       
+       RETVAL_NULL();
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len)) {
+               char *decoded;
+               size_t decoded_len;
+               
+               if (SUCCESS == http_encoding_uncompress(data, data_len, &decoded, &decoded_len)) {
+                       RETURN_STRINGL(decoded, (int) decoded_len, 0);
+               }
+       }
+}
+/* }}} */
+#endif /* HTTP_HAVE_ZLIB */
+/* }}} */
+
+/* {{{ proto int http_support([int feature = 0])
+ *
+ * Check for feature that require external libraries.
+ * 
+ * Accpepts an optional in parameter specifying which feature to probe for.
+ * If the parameter is 0 or omitted, the return value contains a bitmask of 
+ * all supported features that depend on external libraries.
+ * 
+ * Available features to probe for are:
+ * <ul> 
+ *  <li> HTTP_SUPPORT: always set
+ *  <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
+ *       and HTTP requests can be issued
+ *  <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
+ *       and SSL requests can be issued 
+ *  <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
+ *       and compressed HTTP responses can be decoded
+ *  <li> HTTP_SUPPORT_MHASHETAGS: whether ext/http was linked against libmhash,
+ *       and ETags can be generated with the available mhash algorithms
+ *  <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
+ *       and the HttpResponse::guessContentType() method is usable
+ * </ul>
+ * 
+ * Returns int, whether requested feature is supported, or a bitmask with
+ * all supported features.
+ */
+PHP_FUNCTION(http_support)
+{
+       long feature = 0;
+       
+       RETVAL_LONG(0L);
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &feature)) {
+               RETVAL_LONG(http_support(feature));
+       }
+}
+/* }}} */
+
 PHP_FUNCTION(http_test)
 {
 }