- make this class usable, mostly by fixing typos
[m6w6/ext-http] / http_functions.c
index b16cef17e43c59725be76cfd2add8d5ad0a2c594..04377f54ac12c34d94082d799a3916f4f3246b6e 100644 (file)
@@ -1230,6 +1230,7 @@ PHP_FUNCTION(http_match_request_header)
  *                      redirects to a different host
  *  - proxyhost:        string, proxy host in "host[:port]" format
  *  - proxyport:        int, use another proxy port as specified in proxyhost
+ *  - proxytype:        int, HTTP_PROXY_HTTP, SOCKS4 or SOCKS5
  *  - proxyauth:        string, proxy credentials in "user:pass" format
  *  - proxyauthtype:    int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
  *  - httpauth:         string, http credentials in "user:pass" format
@@ -1246,8 +1247,12 @@ PHP_FUNCTION(http_match_request_header)
  *  - encodecookies:    bool, whether to urlencode the cookies (default: true)
  *  - resetcookies:     bool, wheter to reset the cookies
  *  - cookiestore:      string, path to a file where cookies are/will be stored
+ *  - cookiesession:    bool, accept (true) or reset (false) sessioncookies
  *  - resume:           int, byte offset to start the download from;
  *                      if the server supports ranges
+ *  - range:            array, array of arrays, each containing two integers,
+ *                      specifying the ranges to download if server support is
+ *                      given; only recognized if the resume option is empty
  *  - maxfilesize:      int, maximum file size that should be downloaded;
  *                      has no effect, if the size of the requested entity is not known
  *  - lastmodified:     int, timestamp for If-(Un)Modified-Since header
@@ -1255,6 +1260,8 @@ PHP_FUNCTION(http_match_request_header)
  *  - timeout:          int, seconds the request may take
  *  - connecttimeout:   int, seconds the connect may take
  *  - onprogress:       mixed, progress callback
+ *  - interface:        string, outgoing network interface (ifname, ip or hostname)
+ *  - portrange:        array, 2 integers specifying outgoing portrange to try
  *  - ssl:              array, with the following options:
  *                      cert:        string, path to certificate
  *                      certtype:    string, type of certificate
@@ -1278,30 +1285,45 @@ PHP_FUNCTION(http_match_request_header)
  * <pre>
  * <?php
  * array (
- *     'effective_url' => 'http://localhost',
- *     'response_code' => 403,
- *     'total_time' => 0.017,
- *     'namelookup_time' => 0.013,
- *     'connect_time' => 0.014,
- *     'pretransfer_time' => 0.014,
- *     'size_upload' => 0,
- *     'size_download' => 202,
- *     'speed_download' => 11882,
- *     'speed_upload' => 0,
- *     'header_size' => 145,
- *     'request_size' => 62,
- *     'ssl_verifyresult' => 0,
- *     'filetime' => -1,
- *     'content_length_download' => 202,
- *     'content_length_upload' => 0,
- *     'starttransfer_time' => 0.017,
- *     'content_type' => 'text/html; charset=iso-8859-1',
- *     'redirect_time' => 0,
- *     'redirect_count' => 0,
- *     'http_connectcode' => 0,
- *     'httpauth_avail' => 0,
- *     'proxyauth_avail' => 0,
- * )
+ *    'effective_url' => 'http://www.example.com/',
+ *    'response_code' => 302,
+ *    'connect_code' => 0,
+ *    'filetime' => -1,
+ *    'total_time' => 0.212348,
+ *    'namelookup_time' => 0.038296,
+ *    'connect_time' => 0.104144,
+ *    'pretransfer_time' => 0.104307,
+ *    'starttransfer_time' => 0.212077,
+ *    'redirect_time' => 0,
+ *    'redirect_count' => 0,
+ *    'size_upload' => 0,
+ *    'size_download' => 218,
+ *    'speed_download' => 1026,
+ *    'speed_upload' => 0,
+ *    'header_size' => 307,
+ *    'request_size' => 103,
+ *    'ssl_verifyresult' => 0,
+ *    'ssl_engines' =>
+ *    array (
+ *      0 => 'dynamic',
+ *      1 => 'cswift',
+ *      2 => 'chil',
+ *      3 => 'atalla',
+ *      4 => 'nuron',
+ *      5 => 'ubsec',
+ *      6 => 'aep',
+ *      7 => 'sureware',
+ *      8 => '4758cca',
+ *    ),
+ *    'content_length_download' => 218,
+ *    'content_length_upload' => 0,
+ *    'content_type' => 'text/html',
+ *    'httpauth_avail' => 0,
+ *    'proxyauth_avail' => 0,
+ *    'num_connects' => 1,
+ *    'os_errno' => 0,
+ *    'error' => '',
+ *  )
  * ?>
  * </pre>
  * 
@@ -1484,7 +1506,7 @@ PHP_FUNCTION(http_put_file)
                RETURN_FALSE;
        }
 
-       if (!(stream = php_stream_open_wrapper(file, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL))) {
+       if (!(stream = php_stream_open_wrapper_ex(file, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL, HTTP_DEFAULT_STREAM_CONTEXT))) {
                RETURN_FALSE;
        }
        if (php_stream_stat(stream, &ssb)) {
@@ -1499,12 +1521,8 @@ PHP_FUNCTION(http_put_file)
 
        RETVAL_FALSE;
 
-       body.type = HTTP_REQUEST_BODY_UPLOADFILE;
-       body.data = stream;
-       body.size = ssb.sb.st_size;
-
        http_request_init_ex(&request, NULL, HTTP_PUT, URL);
-       request.body = &body;
+       request.body = http_request_body_init_ex(&body, HTTP_REQUEST_BODY_UPLOADFILE, stream, ssb.sb.st_size, 1);
        if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
                http_request_exec(&request);
                if (info) {
@@ -1512,8 +1530,6 @@ PHP_FUNCTION(http_put_file)
                }
                RETVAL_RESPONSE_OR_BODY(request);
        }
-       http_request_body_dtor(&body);
-       request.body = NULL;
        http_request_dtor(&request);
 }
 /* }}} */
@@ -1526,7 +1542,7 @@ PHP_FUNCTION(http_put_file)
  * opened stream, from which the data to upload should be read.
  * See http_get() for a full list of available options.
  * 
- * Returns the HTTP response(s) as string on success. or FALSE on failure.
+ * Returns the HTTP response(s) as string on success, or FALSE on failure.
  */
 PHP_FUNCTION(http_put_stream)
 {
@@ -1554,12 +1570,49 @@ PHP_FUNCTION(http_put_stream)
 
        RETVAL_FALSE;
 
-       body.type = HTTP_REQUEST_BODY_UPLOADFILE;
-       body.data = stream;
-       body.size = ssb.sb.st_size;
+       http_request_init_ex(&request, NULL, HTTP_PUT, URL);
+       request.body = http_request_body_init_ex(&body, HTTP_REQUEST_BODY_UPLOADFILE, stream, ssb.sb.st_size, 0);
+       if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
+               http_request_exec(&request);
+               if (info) {
+                       http_request_info(&request, Z_ARRVAL_P(info));
+               }
+               RETVAL_RESPONSE_OR_BODY(request);
+       }
+       http_request_dtor(&request);
+}
+/* }}} */
 
-       http_request_init_ex(&request, NULL, HTTP_POST, URL);
-       request.body = &body;
+/* {{{ proto string http_put_data(string url, string data[, array options[, array &info]])
+ *
+ * Performs an HTTP PUT request on the supplied url.
+ * 
+ * Expects the second parameter to be a string containing the data to upload.
+ * See http_get() for a full list of available options.
+ * 
+ * Returns the HTTP response(s) as string on success, or FALSE on failure.
+ */
+PHP_FUNCTION(http_put_data)
+{
+       char *URL, *data;
+       int URL_len, data_len;
+       zval *options = NULL, *info = NULL;
+       http_request_body body;
+       http_request request;
+       
+       if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &data, &data_len, &options, &info)) {
+               RETURN_FALSE;
+       }
+       
+       if (info) {
+               zval_dtor(info);
+               array_init(info);
+       }
+       
+       RETVAL_FALSE;
+       
+       http_request_init_ex(&request, NULL, HTTP_PUT, URL);
+       request.body = http_request_body_init_ex(&body, HTTP_REQUEST_BODY_CSTRING, data, data_len, 0);
        if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
                http_request_exec(&request);
                if (info) {
@@ -1567,7 +1620,6 @@ PHP_FUNCTION(http_put_stream)
                }
                RETVAL_RESPONSE_OR_BODY(request);
        }
-       request.body = NULL;
        http_request_dtor(&request);
 }
 /* }}} */