- update docs
[m6w6/ext-http] / http_functions.c
index 9bf3399d72570ba6b6eb3a4abf1caf0eeb0ff9fd..94088c224a097e34199760ca2fbf2842b872be8e 100644 (file)
@@ -33,9 +33,9 @@
 #include "php_http_std_defs.h"
 #include "php_http_api.h"
 #include "php_http_auth_api.h"
-#include "php_http_curl_api.h"
+#include "php_http_request_api.h"
 #include "php_http_cache_api.h"
-#include "php_http_curl_api.h"
+#include "php_http_request_api.h"
 #include "php_http_date_api.h"
 #include "php_http_headers_api.h"
 #include "php_http_message_api.h"
@@ -411,6 +411,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.
@@ -670,6 +699,8 @@ PHP_FUNCTION(http_get_request_headers)
  *  - lastmodified:     int, timestamp for If-(Un)Modified-Since header
  *  - 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
@@ -773,6 +804,7 @@ PHP_FUNCTION(http_post_data)
        char *URL, *postdata;
        int postdata_len, URL_len;
        phpstr response;
+       http_request_body body;
 
        if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
                RETURN_FALSE;
@@ -783,29 +815,120 @@ PHP_FUNCTION(http_post_data)
                array_init(info);
        }
 
+       body.type = HTTP_REQUEST_BODY_CSTRING;
+       body.data = postdata;
+       body.size = postdata_len;
+
        phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
-       if (SUCCESS == http_post_data(URL, postdata, (size_t) postdata_len, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
-               RETURN_PHPSTR_VAL(response);
+       if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
+               RETVAL_PHPSTR_VAL(response);
        } else {
-               RETURN_FALSE;
+               RETVAL_FALSE;
        }
+       http_request_body_dtor(&body);
 }
 /* }}} */
 
-/* {{{ proto string http_post_array(string url, array data[, array options[, array &info]])
+/* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
  *
  * Performs an HTTP POST request, posting www-form-urlencoded array data.
  * Returns the HTTP response as string.
  * See http_get() for a full list of available options.
  */
-PHP_FUNCTION(http_post_array)
+PHP_FUNCTION(http_post_fields)
+{
+       zval *options = NULL, *info = NULL, *fields, *files = NULL;
+       char *URL;
+       int URL_len;
+       phpstr response;
+       http_request_body body;
+
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|aa/!z", &URL, &URL_len, &fields, &files, &options, &info) != SUCCESS) {
+               RETURN_FALSE;
+       }
+
+       if (SUCCESS != http_request_body_fill(&body, Z_ARRVAL_P(fields), files ? Z_ARRVAL_P(files) : NULL)) {
+               RETURN_FALSE;
+       }
+
+       if (info) {
+               zval_dtor(info);
+               array_init(info);
+       }
+
+       phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
+       if (SUCCESS == http_post(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_file(string url, string file[, array options[, array &info]])
+ *
+ */
+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]])
+ *
+ */
+PHP_FUNCTION(http_put_stream)
 {
-       zval *options = NULL, *info = NULL, *postdata;
+       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;
+       }
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|a/!z", &URL, &URL_len, &postdata, &options, &info) != SUCCESS) {
+       php_stream_from_zval(stream, &resource);
+       if (php_stream_stat(stream, &ssb)) {
                RETURN_FALSE;
        }
 
@@ -814,15 +937,125 @@ PHP_FUNCTION(http_post_array)
                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_post_array(URL, Z_ARRVAL_P(postdata), options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
+       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 bool http_request()
+ */
+/* }}} */
+
+/* {{{ proto long http_request_method_register(string 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)
+ *
+ */
+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)
+ *
+ */
+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)
+ *
+ */
+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 */
 
@@ -991,4 +1224,3 @@ PHP_FUNCTION(http_test)
  * vim600: noet sw=4 ts=4 fdm=marker
  * vim<600: noet sw=4 ts=4
  */
-