- initialize default compression level
[m6w6/ext-http] / http_functions.c
index c7cc2b645e254886b108efb38cb539d052a235f0..88aefb47ae33ec54521a645c3f08d27c467a65ab 100644 (file)
@@ -42,6 +42,7 @@
 #include "php_http_message_api.h"
 #include "php_http_send_api.h"
 #include "php_http_url_api.h"
+#include "php_http_encoding_api.h"
 
 #include "phpstr/phpstr.h"
 
@@ -87,11 +88,11 @@ PHP_FUNCTION(http_date)
  * Returns the absolute URI as string.
  * 
  * Examples:
- * <code>
+ * <pre>
  * <?php
  * $uri = http_build_uri("page.php", "https", NULL, 488);
  * ?>
- * </code>
+ * </pre>
  */
 PHP_FUNCTION(http_build_uri)
 {
@@ -107,51 +108,50 @@ PHP_FUNCTION(http_build_uri)
 }
 /* }}} */
 
-#define HTTP_DO_NEGOTIATE(type, supported, as_array) \
+#define HTTP_DO_NEGOTIATE(type, supported, rs_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; \
+               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 { \
-                       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); \
+                       RETVAL_NULL(); \
                } \
+               \
+               if (rs_array) { \
+                       zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
+               } \
+               \
+               zend_hash_destroy(result); \
+               FREE_HASHTABLE(result); \
+               \
        } else { \
-               if (as_array) { \
+               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(); \
+               } \
+               \
+               if (rs_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(); \
+                               add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
                        } \
                } \
        } \
 }
 
 
-/* {{{ proto mixed http_negotiate_language(array supported[, array result])
+/* {{{ proto string 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 
@@ -186,18 +186,22 @@ PHP_FUNCTION(http_build_uri)
  */
 PHP_FUNCTION(http_negotiate_language)
 {
-       zval *supported;
-       zend_bool as_array = 0;
+       zval *supported, *rs_array = NULL;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &supported, &as_array) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array) != SUCCESS) {
                RETURN_FALSE;
        }
        
-       HTTP_DO_NEGOTIATE(language, supported, as_array);
+       if (rs_array) {
+               zval_dtor(rs_array);
+               array_init(rs_array);
+       }
+       
+       HTTP_DO_NEGOTIATE(language, supported, rs_array);
 }
 /* }}} */
 
-/* {{{ proto string http_negotiate_charset(array supported[, array result])
+/* {{{ 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 
@@ -234,14 +238,18 @@ PHP_FUNCTION(http_negotiate_language)
  */
 PHP_FUNCTION(http_negotiate_charset)
 {
-       zval *supported;
-       zend_bool as_array = 0;
+       zval *supported, *rs_array = NULL;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &supported, &as_array) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array) != SUCCESS) {
                RETURN_FALSE;
        }
+       
+       if (rs_array) {
+               zval_dtor(rs_array);
+               array_init(rs_array);
+       }
 
-       HTTP_DO_NEGOTIATE(charset, supported, as_array);
+       HTTP_DO_NEGOTIATE(charset, supported, rs_array);
 }
 /* }}} */
 
@@ -308,7 +316,7 @@ PHP_FUNCTION(http_send_last_modified)
 PHP_FUNCTION(http_send_content_type)
 {
        char *ct = "application/x-octetstream";
-       int ct_len = lenof("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;
@@ -344,7 +352,7 @@ PHP_FUNCTION(http_send_content_disposition)
 }
 /* }}} */
 
-/* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
+/* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
  *
  * Matches the given unix timestamp against the clients "If-Modified-Since" 
  * resp. "If-Unmodified-Since" HTTP headers.
@@ -378,7 +386,7 @@ PHP_FUNCTION(http_match_modified)
 }
 /* }}} */
 
-/* {{{ proto bool http_match_etag(string etag[, for_range = false])
+/* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
  *
  * Matches the given ETag against the clients "If-Match" resp. 
  * "If-None-Match" HTTP headers.
@@ -505,7 +513,7 @@ PHP_FUNCTION(ob_etaghandler)
 }
 /* }}} */
 
-/* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
+/* {{{ proto void http_throttle(double sec[, int 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
@@ -530,7 +538,7 @@ PHP_FUNCTION(ob_etaghandler)
  */
 PHP_FUNCTION(http_throttle)
 {
-       long chunk_size = HTTP_SEND_BUFFERSIZE;
+       long chunk_size = HTTP_SENDBUF_SIZE;
        double interval;
 
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d|l", &interval, &chunk_size)) {
@@ -668,6 +676,7 @@ PHP_FUNCTION(http_redirect)
  *
  * Sends raw data with support for (multiple) range requests.
  *
+ * Retursn TRUE on success, or FALSE on failure.
  */
 PHP_FUNCTION(http_send_data)
 {
@@ -746,7 +755,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;
@@ -868,6 +877,8 @@ PHP_FUNCTION(http_parse_headers)
 /* {{{ proto array http_get_request_headers(void)
  *
  * Get a list of incoming HTTP headers.
+ * 
+ * Returns an associative array of incoming request headers.
  */
 PHP_FUNCTION(http_get_request_headers)
 {
@@ -1244,7 +1255,7 @@ PHP_FUNCTION(http_put_stream)
 PHP_FUNCTION(http_request_method_register)
 {
        char *method;
-       int *method_len;
+       int method_len;
        unsigned long existing;
 
        if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
@@ -1254,7 +1265,7 @@ PHP_FUNCTION(http_request_method_register)
                RETURN_LONG((long) existing);
        }
 
-       RETVAL_LONG((long) http_request_method_register(method));
+       RETVAL_LONG((long) http_request_method_register(method, method_len));
 }
 /* }}} */
 
@@ -1297,7 +1308,7 @@ PHP_FUNCTION(http_request_method_unregister)
 }
 /* }}} */
 
-/* {{{ proto long http_request_method_exists(mixed method)
+/* {{{ proto int http_request_method_exists(mixed method)
  *
  * Check if a request method is registered (or available by default).
  * 
@@ -1397,6 +1408,188 @@ 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 */
+/* }}} */
+
 PHP_FUNCTION(http_test)
 {
 }