- http_redirect(): proper check for ext/session; fix possible mem-leaks
[m6w6/ext-http] / http_functions.c
index 5dc49b5c4dc64e64bdeaa8fe787af1322108f907..1a1c8715c0d2a41a402fbc562644837ac778c67f 100644 (file)
 #ifdef HAVE_CONFIG_H
 #      include "config.h"
 #endif
-
 #include "php.h"
+
+#include "SAPI.h"
 #include "php_ini.h"
 #include "ext/standard/info.h"
-#include "ext/session/php_session.h"
 #include "ext/standard/php_string.h"
-
-#include "SAPI.h"
-
-#include "phpstr/phpstr.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"
@@ -42,6 +41,8 @@
 #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])
@@ -203,7 +204,7 @@ PHP_FUNCTION(http_send_status)
                RETURN_FALSE;
        }
        if (status < 100 || status > 510) {
-               http_error_ex(E_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status);
+               http_error_ex(HE_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status);
                RETURN_FALSE;
        }
 
@@ -411,6 +412,35 @@ PHP_FUNCTION(ob_etaghandler)
 }
 /* }}} */
 
+/* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
+ *
+ * Use with http_send() API.
+ *
+ * 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;
+       double interval;
+
+       if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "dl", &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,[ bool permanent]]]])
  *
  * Redirect to a given url.
@@ -429,9 +459,9 @@ PHP_FUNCTION(http_redirect)
 {
        int url_len;
        size_t query_len = 0;
-       zend_bool session = 0, permanent = 0;
+       zend_bool session = 0, permanent = 0, free_params = 0;
        zval *params = NULL;
-       char *query, *url, *URI,
+       char *query = NULL, *url = NULL, *URI,
                LOC[HTTP_URI_MAXLEN + sizeof("Location: ")],
                RED[HTTP_URI_MAXLEN * 2 + sizeof("Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n")];
 
@@ -440,19 +470,56 @@ PHP_FUNCTION(http_redirect)
        }
 
        /* append session info */
-       if (session && (PS(session_status) == php_session_active)) {
+       if (session) {
                if (!params) {
+                       free_params = 1;
                        MAKE_STD_ZVAL(params);
                        array_init(params);
                }
-               if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
-                       http_error(E_WARNING, HTTP_E_ENCODE, "Could not append session information");
+#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;
                }
        }
@@ -462,15 +529,24 @@ PHP_FUNCTION(http_redirect)
        if (query_len) {
                snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s?%s", URI, query);
                sprintf(RED, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
-               efree(query);
        } else {
                snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s", URI);
                sprintf(RED, "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);
+       }
 
-       if ((SUCCESS == http_send_header(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) {
-               php_body_write(RED, strlen(RED) TSRMLS_CC);
+       if ((SUCCESS == http_send_header_string(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) {
+               if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
+                       PHPWRITE(RED, strlen(RED));
+               }
                RETURN_TRUE;
        }
        RETURN_FALSE;
@@ -577,26 +653,25 @@ PHP_FUNCTION(http_chunked_decode)
  */
 PHP_FUNCTION(http_split_response)
 {
-       zval *zresponse, *zbody, *zheaders;
+       char *response, *body;
+       int response_len;
+       size_t body_len;
+       zval *zheaders;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zresponse) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &response, &response_len) != SUCCESS) {
                RETURN_FALSE;
        }
 
-       convert_to_string(zresponse);
-
-       MAKE_STD_ZVAL(zbody);
        MAKE_STD_ZVAL(zheaders);
        array_init(zheaders);
 
-       if (SUCCESS != http_split_response(zresponse, zheaders, zbody)) {
-               http_error(E_WARNING, HTTP_E_PARSE, "Could not parse HTTP response");
+       if (SUCCESS != http_split_response(response, response_len, Z_ARRVAL_P(zheaders), &body, &body_len)) {
                RETURN_FALSE;
        }
 
        array_init(return_value);
        add_index_zval(return_value, 0, zheaders);
-       add_index_zval(return_value, 1, zbody);
+       add_index_stringl(return_value, 1, body, body_len, 0);
 }
 /* }}} */
 
@@ -614,7 +689,6 @@ PHP_FUNCTION(http_parse_headers)
 
        array_init(return_value);
        if (SUCCESS != http_parse_headers(header, return_value)) {
-               http_error(E_WARNING, HTTP_E_PARSE, "Could not parse HTTP headers");
                zval_dtor(return_value);
                RETURN_FALSE;
        }
@@ -623,6 +697,7 @@ PHP_FUNCTION(http_parse_headers)
 
 /* {{{ proto array http_get_request_headers(void)
  *
+ * Get a list of incoming HTTP headers.
  */
 PHP_FUNCTION(http_get_request_headers)
 {
@@ -633,6 +708,43 @@ PHP_FUNCTION(http_get_request_headers)
 }
 /* }}} */
 
+/* {{{ proto string http_get_request_body(void)
+ *
+ * Get the raw request body (e.g. POST or PUT data).
+ */
+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.
+ */
+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
 
@@ -671,7 +783,6 @@ PHP_FUNCTION(http_get_request_headers)
  *  - timeout:          int, seconds the request may take
  *  - connecttimeout:   int, seconds the connect may take
  *  - onprogress:       mixed, progress callback
- *  - ondebug:          mixed, debug callback
  * </pre>
  *
  * The optional third parameter will be filled with some additional information
@@ -796,7 +907,6 @@ PHP_FUNCTION(http_post_data)
        } else {
                RETVAL_FALSE;
        }
-       http_request_body_dtor(&body);
 }
 /* }}} */
 
@@ -837,6 +947,202 @@ PHP_FUNCTION(http_post_fields)
 }
 /* }}} */
 
+/* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
+ *
+ * Performs an HTTP PUT request, uploading file.
+ * Returns the HTTP response as string.
+ * See http_get() for a full list of available options.
+ */
+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, uploading stream.
+ * Returns the HTTP response as string.
+ * See http_get() for a full list of available options.
+ */
+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();
+       }
+}
+/* }}} */
+
+/* {{{ proto long http_request_method_register(string method)
+ *
+ * Register a custom request method.
+ */
+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.
+ */
+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:
+#include "zend_operators.h"
+                       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).
+ */
+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(long method)
+ *
+ * Get the literal string representation of a standard or registered request method.
+ */
+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);
+       }
+}
+/* }}} */
 #endif
 /* }}} HAVE_CURL */
 
@@ -865,18 +1171,18 @@ PHP_FUNCTION(http_auth_basic)
                realm = "Restricted";
        }
 
-       if (SUCCESS != http_auth_credentials(&suser, &spass)) {
-               http_auth_header("Basic", realm);
+       if (SUCCESS != http_auth_basic_credentials(&suser, &spass)) {
+               http_auth_basic_header(realm);
                RETURN_FALSE;
        }
 
        if (strcasecmp(suser, user)) {
-               http_auth_header("Basic", realm);
+               http_auth_basic_header(realm);
                RETURN_FALSE;
        }
 
        if (strcmp(spass, pass)) {
-               http_auth_header("Basic", realm);
+               http_auth_basic_header(realm);
                RETURN_FALSE;
        }
 
@@ -918,8 +1224,8 @@ PHP_FUNCTION(http_auth_basic_cb)
                realm = "Restricted";
        }
 
-       if (SUCCESS != http_auth_credentials(&user, &pass)) {
-               http_auth_header("Basic", realm);
+       if (SUCCESS != http_auth_basic_credentials(&user, &pass)) {
+               http_auth_basic_header(realm);
                RETURN_FALSE;
        }
        {
@@ -942,7 +1248,7 @@ PHP_FUNCTION(http_auth_basic_cb)
                efree(zparams[1]);
 
                if (!result) {
-                       http_auth_header("Basic", realm);
+                       http_auth_basic_header(realm);
                }
 
                RETURN_BOOL(result);
@@ -967,7 +1273,7 @@ PHP_FUNCTION(http_build_query)
        }
 
        if (Z_TYPE_P(formdata) != IS_ARRAY && Z_TYPE_P(formdata) != IS_OBJECT) {
-               http_error(E_WARNING, HTTP_E_PARAM, "Parameter 1 expected to be Array or Object.  Incorrect value given.");
+               http_error(HE_WARNING, HTTP_E_INVALID_PARAM, "Parameter 1 expected to be Array or Object.  Incorrect value given.");
                RETURN_FALSE;
        }
 
@@ -994,7 +1300,6 @@ PHP_FUNCTION(http_build_query)
 
 PHP_FUNCTION(http_test)
 {
-       RETURN_NULL();
 }
 
 /*
@@ -1005,3 +1310,4 @@ PHP_FUNCTION(http_test)
  * vim600: noet sw=4 ts=4 fdm=marker
  * vim<600: noet sw=4 ts=4
  */
+