- allow requests for compressed content even if neither curl nor ext/http
[m6w6/ext-http] / http_request_api.c
index 9cfa1bdaf65c8ae4872b0b280a5859eec40a8c80..38eadf45f24343b653faa7aae58e5d748fbc59be 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$ */
 #ifdef HAVE_CONFIG_H
 #      include "config.h"
 #endif
-#include "php.h"
+
+#define HTTP_WANT_CURL
+#include "php_http.h"
 
 #ifdef HTTP_HAVE_CURL
 
-#include "php_http.h"
-#include "php_http_std_defs.h"
 #include "php_http_api.h"
 #include "php_http_request_api.h"
 #include "php_http_request_method_api.h"
 #include "php_http_url_api.h"
+
 #ifdef ZEND_ENGINE_2
 #      include "php_http_request_object.h"
 #endif
 
-#include "phpstr/phpstr.h"
-
-#ifdef PHP_WIN32
-#      include <winsock2.h>
-#endif
-
-#include <curl/curl.h>
-
-/*
- * cruft for thread safe SSL crypto locks
- */
+/* {{{ cruft for thread safe SSL crypto locks */
 #if defined(ZTS) && defined(HTTP_HAVE_SSL)
 #      ifdef PHP_WIN32
 #              define HTTP_NEED_SSL_TSL
@@ -79,6 +67,7 @@
 #              endif /* HTTP_HAVE_OPENSSL || HTTP_HAVE_GNUTLS */
 #      endif /* PHP_WIN32 */
 #endif /* ZTS && HTTP_HAVE_SSL */
+/* }}} */
 
 ZEND_EXTERN_MODULE_GLOBALS(http);
 
@@ -281,12 +270,15 @@ PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *
                char *key = NULL;
                ulong idx;
                zval **data;
+               HashPosition pos;
                struct curl_httppost *http_post_data[2] = {NULL, NULL};
 
                /* normal data */
-               FOREACH_HASH_KEYVAL(fields, key, idx, data) {
+               FOREACH_HASH_KEYVAL(pos, fields, key, idx, data) {
                        CURLcode err;
                        if (key) {
+                               zval *orig = *data;
+                               
                                convert_to_string_ex(data);
                                err = curl_formadd(&http_post_data[0], &http_post_data[1],
                                        CURLFORM_COPYNAME,                      key,
@@ -294,6 +286,11 @@ PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *
                                        CURLFORM_CONTENTSLENGTH,        (long) Z_STRLEN_PP(data),
                                        CURLFORM_END
                                );
+                               
+                               if (orig != *data) {
+                                       zval_ptr_dtor(data);
+                               }
+                               
                                if (CURLE_OK != err) {
                                        http_error_ex(HE_WARNING, HTTP_E_ENCODING, "Could not encode post fields: %s", curl_easy_strerror(err));
                                        curl_formfree(http_post_data[0]);
@@ -306,12 +303,14 @@ PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *
                }
 
                /* file data */
-               FOREACH_HASH_VAL(files, data) {
+               FOREACH_HASH_VAL(pos, files, data) {
                        zval **file, **type, **name;
                        
-                       if (    SUCCESS != zend_hash_find(Z_ARRVAL_PP(data), "name", sizeof("name"), (void **) &name) ||
-                                       SUCCESS != zend_hash_find(Z_ARRVAL_PP(data), "type", sizeof("type"), (void **) &type) ||
-                                       SUCCESS != zend_hash_find(Z_ARRVAL_PP(data), "file", sizeof("file"), (void **) &file)) {
+                       if (Z_TYPE_PP(data) != IS_ARRAY) {
+                               http_error(HE_NOTICE, HTTP_E_INVALID_PARAM, "Unrecognized type of post file array entry");
+                       } else if (     SUCCESS != zend_hash_find(Z_ARRVAL_PP(data), "name", sizeof("name"), (void **) &name) ||
+                                               SUCCESS != zend_hash_find(Z_ARRVAL_PP(data), "type", sizeof("type"), (void **) &type) ||
+                                               SUCCESS != zend_hash_find(Z_ARRVAL_PP(data), "file", sizeof("file"), (void **) &file)) {
                                http_error(HE_NOTICE, HTTP_E_INVALID_PARAM, "Post file array entry misses either 'name', 'type' or 'file' entry");
                        } else {
                                CURLcode err = curl_formadd(&http_post_data[0], &http_post_data[1],
@@ -375,11 +374,12 @@ PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC)
 /* }}} */
 
 /* {{{ void http_request_body_free(http_request_body *) */
-PHP_HTTP_API void _http_request_body_free(http_request_body *body TSRMLS_DC)
+PHP_HTTP_API void _http_request_body_free(http_request_body **body TSRMLS_DC)
 {
-       if (body) {
-               http_request_body_dtor(body);
-               efree(body);
+       if (*body) {
+               http_request_body_dtor(*body);
+               efree(*body);
+               *body = NULL;
        }
 }
 /* }}} */
@@ -420,89 +420,90 @@ PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char
 #endif
 
        /* progress callback */
-       if (zoption = http_curl_getopt(options, "onprogress", 0)) {
+       if ((zoption = http_curl_getopt(options, "onprogress", 0))) {
                HTTP_CURL_OPT(NOPROGRESS, 0);
                HTTP_CURL_OPT(PROGRESSFUNCTION, http_curl_progress_callback);
                HTTP_CURL_OPT(PROGRESSDATA,  http_request_callback_data(zoption));
        }
 
        /* proxy */
-       if (zoption = http_curl_getopt(options, "proxyhost", IS_STRING)) {
+       if ((zoption = http_curl_getopt(options, "proxyhost", IS_STRING))) {
                HTTP_CURL_OPT(PROXY, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
                /* port */
-               if (zoption = http_curl_getopt(options, "proxyport", IS_LONG)) {
+               if ((zoption = http_curl_getopt(options, "proxyport", IS_LONG))) {
                        HTTP_CURL_OPT(PROXYPORT, Z_LVAL_P(zoption));
                }
                /* user:pass */
-               if (zoption = http_curl_getopt(options, "proxyauth", IS_STRING)) {
+               if ((zoption = http_curl_getopt(options, "proxyauth", IS_STRING))) {
                        HTTP_CURL_OPT(PROXYUSERPWD, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
                }
 #if LIBCURL_VERSION_NUM >= 0x070a07
                /* auth method */
-               if (zoption = http_curl_getopt(options, "proxyauthtype", IS_LONG)) {
+               if ((zoption = http_curl_getopt(options, "proxyauthtype", IS_LONG))) {
                        HTTP_CURL_OPT(PROXYAUTH, Z_LVAL_P(zoption));
                }
 #endif
        }
 
        /* outgoing interface */
-       if (zoption = http_curl_getopt(options, "interface", IS_STRING)) {
+       if ((zoption = http_curl_getopt(options, "interface", IS_STRING))) {
                HTTP_CURL_OPT(INTERFACE, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
        }
 
        /* another port */
-       if (zoption = http_curl_getopt(options, "port", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "port", IS_LONG))) {
                HTTP_CURL_OPT(PORT, Z_LVAL_P(zoption));
        }
 
        /* auth */
-       if (zoption = http_curl_getopt(options, "httpauth", IS_STRING)) {
+       if ((zoption = http_curl_getopt(options, "httpauth", IS_STRING))) {
                HTTP_CURL_OPT(USERPWD, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
        }
 #if LIBCURL_VERSION_NUM >= 0x070a06
-       if (zoption = http_curl_getopt(options, "httpauthtype", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "httpauthtype", IS_LONG))) {
                HTTP_CURL_OPT(HTTPAUTH, Z_LVAL_P(zoption));
        }
 #endif
 
        /* compress, empty string enables all supported if libcurl was build with zlib support */
        if ((zoption = http_curl_getopt(options, "compress", IS_BOOL)) && Z_LVAL_P(zoption)) {
-#if defined(HTTP_HAVE_ZLIB) || defined(HAVE_ZLIB)
-               HTTP_CURL_OPT(ENCODING, "gzip;q=1.0, deflate;q=0.5, *;q=0");
-#else
+#ifdef HTTP_HAVE_CURL_ZLIB
                HTTP_CURL_OPT(ENCODING, "");
+#else
+               HTTP_CURL_OPT(ENCODING, "gzip;q=1.0, deflate;q=0.5, *;q=0.1");
 #endif
        }
 
        /* redirects, defaults to 0 */
-       if (zoption = http_curl_getopt(options, "redirect", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "redirect", IS_LONG))) {
                HTTP_CURL_OPT(FOLLOWLOCATION, Z_LVAL_P(zoption) ? 1 : 0);
                HTTP_CURL_OPT(MAXREDIRS, Z_LVAL_P(zoption));
-               if (zoption = http_curl_getopt(options, "unrestrictedauth", IS_BOOL)) {
+               if ((zoption = http_curl_getopt(options, "unrestrictedauth", IS_BOOL))) {
                        HTTP_CURL_OPT(UNRESTRICTED_AUTH, Z_LVAL_P(zoption));
                }
        }
 
        /* referer */
-       if (zoption = http_curl_getopt(options, "referer", IS_STRING)) {
+       if ((zoption = http_curl_getopt(options, "referer", IS_STRING))) {
                HTTP_CURL_OPT(REFERER, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
        }
 
        /* useragent, default "PECL::HTTP/version (PHP/version)" */
-       if (zoption = http_curl_getopt(options, "useragent", IS_STRING)) {
+       if ((zoption = http_curl_getopt(options, "useragent", IS_STRING))) {
                HTTP_CURL_OPT(USERAGENT, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
        }
 
        /* additional headers, array('name' => 'value') */
-       if (zoption = http_curl_getopt(options, "headers", IS_ARRAY)) {
+       if ((zoption = http_curl_getopt(options, "headers", IS_ARRAY))) {
                char *header_key;
                ulong header_idx;
+               HashPosition pos;
                struct curl_slist *headers = NULL;
 
-               FOREACH_KEY(zoption, header_key, header_idx) {
+               FOREACH_KEY(pos, zoption, header_key, header_idx) {
                        if (header_key) {
                                zval **header_val;
-                               if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(zoption), (void **) &header_val)) {
+                               if (SUCCESS == zend_hash_get_current_data_ex(Z_ARRVAL_P(zoption), (void **) &header_val, &pos)) {
                                        char header[1024] = {0};
                                        snprintf(header, 1023, "%s: %s", header_key, Z_STRVAL_PP(header_val));
                                        headers = curl_slist_append(headers, http_request_data_copy(COPY_STRING, header));
@@ -519,15 +520,16 @@ PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char
        }
 
        /* cookies, array('name' => 'value') */
-       if (zoption = http_curl_getopt(options, "cookies", IS_ARRAY)) {
+       if ((zoption = http_curl_getopt(options, "cookies", IS_ARRAY))) {
                char *cookie_key = NULL;
                ulong cookie_idx = 0;
+               HashPosition pos;
                phpstr *qstr = phpstr_new();
 
-               FOREACH_KEY(zoption, cookie_key, cookie_idx) {
+               FOREACH_KEY(pos, zoption, cookie_key, cookie_idx) {
                        if (cookie_key) {
                                zval **cookie_val;
-                               if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(zoption), (void **) &cookie_val)) {
+                               if (SUCCESS == zend_hash_get_current_data_ex(Z_ARRVAL_P(zoption), (void **) &cookie_val, &pos)) {
                                        phpstr_appendf(qstr, "%s=%s; ", cookie_key, Z_STRVAL_PP(cookie_val));
                                }
 
@@ -544,7 +546,7 @@ PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char
        }
 
        /* session cookies */
-       if (zoption = http_curl_getopt(options, "cookiesession", IS_BOOL)) {
+       if ((zoption = http_curl_getopt(options, "cookiesession", IS_BOOL))) {
                if (Z_LVAL_P(zoption)) {
                        /* accept cookies for this session */
                        HTTP_CURL_OPT(COOKIEFILE, "");
@@ -567,12 +569,12 @@ PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char
        }
 
        /* maxfilesize */
-       if (zoption = http_curl_getopt(options, "maxfilesize", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "maxfilesize", IS_LONG))) {
                HTTP_CURL_OPT(MAXFILESIZE, Z_LVAL_P(zoption));
        }
 
        /* lastmodified */
-       if (zoption = http_curl_getopt(options, "lastmodified", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "lastmodified", IS_LONG))) {
                if (Z_LVAL_P(zoption)) {
                        if (Z_LVAL_P(zoption) > 0) {
                                HTTP_CURL_OPT(TIMEVALUE, Z_LVAL_P(zoption));
@@ -586,22 +588,23 @@ PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char
        }
 
        /* timeout, defaults to 0 */
-       if (zoption = http_curl_getopt(options, "timeout", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "timeout", IS_LONG))) {
                HTTP_CURL_OPT(TIMEOUT, Z_LVAL_P(zoption));
        }
 
        /* connecttimeout, defaults to 3 */
-       if (zoption = http_curl_getopt(options, "connecttimeout", IS_LONG)) {
+       if ((zoption = http_curl_getopt(options, "connecttimeout", IS_LONG))) {
                HTTP_CURL_OPT(CONNECTTIMEOUT, Z_LVAL_P(zoption));
        }
 
        /* ssl */
-       if (zoption = http_curl_getopt(options, "ssl", IS_ARRAY)) {
+       if ((zoption = http_curl_getopt(options, "ssl", IS_ARRAY))) {
                ulong idx;
                char *key = NULL;
                zval **param;
+               HashPosition pos;
 
-               FOREACH_KEYVAL(zoption, key, idx, param) {
+               FOREACH_KEYVAL(pos, zoption, key, idx, param) {
                        if (key) {
                                HTTP_CURL_OPT_SSL_STRING(CERT);
 #if LIBCURL_VERSION_NUM >= 0x070903
@@ -620,7 +623,6 @@ PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char
                                HTTP_CURL_OPT_SSL_LONG_(VERIFYHOST);
                                HTTP_CURL_OPT_SSL_STRING_(CIPHER_LIST);
 
-
                                HTTP_CURL_OPT_STRING(CAINFO);
 #if LIBCURL_VERSION_NUM >= 0x070908
                                HTTP_CURL_OPT_STRING(CAPATH);
@@ -713,15 +715,14 @@ PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info, phpstr *respon
 
        /* perform request */
        if (CURLE_OK != (result = curl_easy_perform(ch))) {
-               http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not perform request: %s", curl_easy_strerror(result));
-               return FAILURE;
-       } else {
-               /* get curl info */
-               if (info) {
-                       http_request_info(ch, info);
-               }
-               return SUCCESS;
+               http_error(HE_WARNING, HTTP_E_REQUEST, curl_easy_strerror(result));
        }
+       /* get curl info */
+       if (info) {
+               http_request_info(ch, info);
+       }
+       /* always succeeds */
+       return SUCCESS;
 }
 /* }}} */
 
@@ -838,10 +839,6 @@ static int http_curl_raw_callback(CURL *ch, curl_infotype type, char *data, size
 {
        HTTP_REQUEST_CALLBACK_DATA(ctx, http_request_conv *, conv);
 
-#if 0
-       fprintf(stderr, "DEBUG: %s\n", data);
-#endif
-
        switch (type)
        {
                case CURLINFO_DATA_IN:
@@ -862,6 +859,26 @@ static int http_curl_raw_callback(CURL *ch, curl_infotype type, char *data, size
                                phpstr_append(conv->request, data, length);
                        }
                break;
+               default:
+#if 0
+                       fprintf(stderr, "## ", type);
+                       if (!type) {
+                               fprintf(stderr, "%s", data);
+                       } else {
+                               ulong i;
+                               for (i = 1; i <= length; ++i) {
+                                       fprintf(stderr, "%02X ", data[i-1] & 0xFF);
+                                       if (!(i % 20)) {
+                                               fprintf(stderr, "\n## ");
+                                       }
+                               }
+                               fprintf(stderr, "\n");
+                       }
+                       if (data[length-1] != 0xa) {
+                               fprintf(stderr, "\n");
+                       }
+#endif
+               break;
        }
 
        if (type) {
@@ -899,31 +916,31 @@ static inline zval *_http_curl_getopt_ex(HashTable *options, char *key, size_t k
 /* }}} */
 
 #ifdef HTTP_NEED_OPENSSL_TSL
-
-static MUTEX_T *http_ssl_mutex = NULL;
+/* {{{ */
+static MUTEX_T *http_openssl_tsl = NULL;
 
 static void http_ssl_lock(int mode, int n, const char * file, int line)
 {
        if (mode & CRYPTO_LOCK) {
-               tsrm_mutex_lock(http_ssl_mutex[n]);
+               tsrm_mutex_lock(http_openssl_tsl[n]);
        } else {
-               tsrm_mutex_unlock(http_ssl_mutex[n]);
+               tsrm_mutex_unlock(http_openssl_tsl[n]);
        }
 }
 
-static unsigned long http_ssl_id(void)
+static ulong http_ssl_id(void)
 {
-       return (unsigned long) tsrm_thread_id();
+       return (ulong) tsrm_thread_id();
 }
 
 static inline void http_ssl_init(void)
 {
        int i, c = CRYPTO_num_locks();
        
-       http_ssl_mutex = malloc(c * sizeof(MUTEX_T));
+       http_openssl_tsl = malloc(c * sizeof(MUTEX_T));
        
        for (i = 0; i < c; ++i) {
-               http_ssl_mutex[i] = tsrm_mutex_alloc();
+               http_openssl_tsl[i] = tsrm_mutex_alloc();
        }
        
        CRYPTO_set_id_callback(http_ssl_id);
@@ -932,27 +949,28 @@ static inline void http_ssl_init(void)
 
 static inline void http_ssl_cleanup(void)
 {
-       if (http_ssl_mutex) {
+       if (http_openssl_tsl) {
                int i, c = CRYPTO_num_locks();
                
                CRYPTO_set_id_callback(NULL);
                CRYPTO_set_locking_callback(NULL);
                
                for (i = 0; i < c; ++i) {
-                       tsrm_mutex_free(http_ssl_mutex[i]);
+                       tsrm_mutex_free(http_openssl_tsl[i]);
                }
                
-               free(http_ssl_mutex);
-               http_ssl_mutex = NULL;
+               free(http_openssl_tsl);
+               http_openssl_tsl = NULL;
        }
 }
 #endif /* HTTP_NEED_OPENSSL_TSL */
+/* }}} */
 
 #ifdef HTTP_NEED_GNUTLS_TSL
-
+/* {{{ */
 static int http_ssl_mutex_create(void **m)
 {
-       if (*((MUTEX_T **) m) = tsrm_mutex_alloc()) {
+       if (*((MUTEX_T *) m) = tsrm_mutex_alloc()) {
                return SUCCESS;
        } else {
                return FAILURE;
@@ -961,21 +979,21 @@ static int http_ssl_mutex_create(void **m)
 
 static int http_ssl_mutex_destroy(void **m)
 {
-       tsrm_mutex_free(*((MUTEX_T **) m));
+       tsrm_mutex_free(*((MUTEX_T *) m));
        return SUCCESS;
 }
 
 static int http_ssl_mutex_lock(void **m)
 {
-       return tsrm_mutex_lock(*((MUTEX_T **) m));
+       return tsrm_mutex_lock(*((MUTEX_T *) m));
 }
 
 static int http_ssl_mutex_unlock(void **m)
 {
-       return tsrm_mutex_unlock(*((MUTEX_T **) m));
+       return tsrm_mutex_unlock(*((MUTEX_T *) m));
 }
 
-static struct gcry_thread_cbs http_ssl_callbacks = {
+static struct gcry_thread_cbs http_gnutls_tsl = {
        GCRY_THREAD_OPTIONS_USER,
        NULL,
        http_ssl_mutex_create,
@@ -986,16 +1004,17 @@ static struct gcry_thread_cbs http_ssl_callbacks = {
 
 static inline void http_ssl_init(void)
 {
-       gcry_control(GCRYCTL_SET_THREAD_CBS, &http_ssl_callbacks);
+       gcry_control(GCRYCTL_SET_THREAD_CBS, &http_gnutls_tsl);
 }
 
 static inline void http_ssl_cleanup(void)
 {
        return;
 }
-
 #endif /* HTTP_NEED_GNUTLS_TSL */
+/* }}} */
 
+/* {{{ http_curl_defaults(CURL *) */
 static inline void _http_curl_defaults(CURL *ch)
 {
        HTTP_CURL_OPT(URL, NULL);
@@ -1016,7 +1035,7 @@ static inline void _http_curl_defaults(CURL *ch)
        HTTP_CURL_OPT(FOLLOWLOCATION, 0);
        HTTP_CURL_OPT(UNRESTRICTED_AUTH, 0);
        HTTP_CURL_OPT(REFERER, NULL);
-       HTTP_CURL_OPT(USERAGENT, "PECL::HTTP/" HTTP_PEXT_VERSION " (PHP/" PHP_VERSION ")");
+       HTTP_CURL_OPT(USERAGENT, "PECL::HTTP/" PHP_EXT_HTTP_VERSION " (PHP/" PHP_VERSION ")");
        HTTP_CURL_OPT(HTTPHEADER, NULL);
        HTTP_CURL_OPT(COOKIE, NULL);
        HTTP_CURL_OPT(COOKIEFILE, NULL);
@@ -1052,6 +1071,7 @@ static inline void _http_curl_defaults(CURL *ch)
        HTTP_CURL_OPT(READDATA, NULL);
        HTTP_CURL_OPT(INFILESIZE, 0);
 }
+/* }}} */
 
 #endif /* HTTP_HAVE_CURL */