- update docs
[m6w6/ext-http] / http_functions.c
index cdddb81143d9ba91bb68227da1ac58674a510f2d..a3b4882b65ee40c50001c9c3a73fa94b7bdf109d 100644 (file)
@@ -61,7 +61,7 @@ PHP_FUNCTION(http_date)
 }
 /* }}} */
 
-/* {{{ proto string http_build_url(mixed url[, mixed parts[, array &new_url]])
+/* {{{ proto string http_build_url(mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]])
  *
  * Returns the new URL as string on success or FALSE on failure.
  */
@@ -69,10 +69,11 @@ PHP_FUNCTION(http_build_url)
 {
        char *url_str = NULL;
        size_t url_len = 0;
+       long flags = HTTP_URL_REPLACE;
        zval *z_old_url = NULL, *z_new_url = NULL, *z_composed_url = NULL;
        php_url *old_url = NULL, *new_url = NULL, *composed_url = NULL;
 
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/|z/z", &z_old_url, &z_new_url, &z_composed_url) != SUCCESS) {
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/|z/lz", &z_old_url, &z_new_url, &flags, &z_composed_url) != SUCCESS) {
                RETURN_FALSE;
        }
        
@@ -102,7 +103,7 @@ PHP_FUNCTION(http_build_url)
        }
        
        if (z_composed_url) {
-               http_build_url(old_url, new_url, &composed_url, &url_str, &url_len);
+               http_build_url(flags, old_url, new_url, &composed_url, &url_str, &url_len);
                
                zval_dtor(z_composed_url);
                array_init(z_composed_url);
@@ -132,7 +133,7 @@ PHP_FUNCTION(http_build_url)
                }
                php_url_free(composed_url);
        } else {
-               http_build_url(old_url, new_url, NULL, &url_str, &url_len);
+               http_build_url(flags, old_url, new_url, NULL, &url_str, &url_len);
        }
        
        if (new_url) {
@@ -144,6 +145,40 @@ PHP_FUNCTION(http_build_url)
 }
 /* }}} */
 
+/* {{{ proto string http_build_str(array query [, string prefix[, string arg_separator]])
+ *
+ * Opponent to parse_str().
+ */
+PHP_FUNCTION(http_build_str)
+{
+       zval *formdata;
+       char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
+       int prefix_len = 0, arg_sep_len = strlen(arg_sep);
+       phpstr formstr;
+
+       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
+               RETURN_FALSE;
+       }
+
+       if (!arg_sep_len) {
+               arg_sep = HTTP_URL_ARGSEP;
+               arg_sep_len = lenof(HTTP_URL_ARGSEP);
+       }
+
+       phpstr_init(&formstr);
+       if (SUCCESS != http_urlencode_hash_recursive(HASH_OF(formdata), &formstr, arg_sep, arg_sep_len, prefix, prefix_len)) {
+               RETURN_FALSE;
+       }
+
+       if (!formstr.used) {
+               phpstr_dtor(&formstr);
+               RETURN_NULL();
+       }
+
+       RETURN_PHPSTR_VAL(&formstr);
+}
+/* }}} */
+
 #define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
 { \
        HashTable *result; \
@@ -195,7 +230,7 @@ PHP_FUNCTION(http_build_url)
  * without qualifier are rated highest.  The qualifier will be decreased by
  * 10% for partial matches (i.e. matching primary language).
  * 
- * Expects an array as parameter cotaining the supported languages as values.
+ * Expects an array as parameter containing the supported languages as values.
  * If the optional second parameter is supplied, it will be filled with an
  * array containing the negotiation results.
  * 
@@ -244,7 +279,7 @@ PHP_FUNCTION(http_negotiate_language)
  * Accept-Charset HTTP header.  The qualifier is recognized and charsets 
  * without qualifier are rated highest.
  * 
- * Expects an array as parameter cotaining the supported charsets as values.
+ * Expects an array as parameter containing the supported charsets as values.
  * If the optional second parameter is supplied, it will be filled with an
  * array containing the negotiation results.
  * 
@@ -296,7 +331,7 @@ PHP_FUNCTION(http_negotiate_charset)
  * Accept HTTP header.  The qualifier is recognized and content types 
  * without qualifier are rated highest.
  * 
- * Expects an array as parameter cotaining the supported content types as values.
+ * Expects an array as parameter containing the supported content types as values.
  * If the optional second parameter is supplied, it will be filled with an
  * array containing the negotiation results.
  * 
@@ -407,7 +442,7 @@ PHP_FUNCTION(http_send_content_type)
  * if the data actually sent came from a file or something similar, that should
  * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
  *
- * Expects a string parameter specifying the file name the "Save as..." dialogue
+ * Expects a string parameter specifying the file name the "Save as..." dialog
  * should display.  Optionally accepts a bool parameter, which, if set to true
  * and the user agent knows how to handle the content type, will probably not
  * cause the popup window to be shown.
@@ -470,7 +505,7 @@ PHP_FUNCTION(http_match_modified)
  * accepts a bool parameter, which, if set to true, will check the header
  * usually used to validate HTTP ranges.
  * 
- * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
+ * Returns TRUE if ETag matches or the header contained the asterisk ("*"),
  * else FALSE.
  */
 PHP_FUNCTION(http_match_etag)
@@ -546,7 +581,7 @@ PHP_FUNCTION(http_cache_last_modified)
 /* {{{ proto bool http_cache_etag([string etag])
  *
  * Attempts to cache the sent entity by its ETag, either supplied or generated 
- * by the hash algorythm specified by the INI setting "http.etag_mode".
+ * by the hash algorithm specified by the INI setting "http.etag_mode".
  *
  * If the clients "If-None-Match" header matches the supplied/calculated
  * ETag, the body is considered cached on the clients side and
@@ -575,7 +610,7 @@ PHP_FUNCTION(http_cache_etag)
 /* {{{ proto string ob_etaghandler(string data, int mode)
  *
  * For use with ob_start().  Output buffer handler generating an ETag with
- * the hash algorythm specified with the INI setting "http.etag_mode".
+ * the hash algorithm specified with the INI setting "http.etag_mode".
  */
 PHP_FUNCTION(ob_etaghandler)
 {
@@ -648,7 +683,7 @@ PHP_FUNCTION(http_throttle)
  * for which redirect response code to use in which situation.
  *
  * To be RFC compliant, "Redirecting to <a>URL</a>." will be displayed,
- * if the client doesn't redirect immediatly, and the request method was
+ * if the client doesn't redirect immediately, and the request method was
  * another one than HEAD.
  * 
  * Returns FALSE on failure, or *exits* on success.
@@ -759,7 +794,7 @@ PHP_FUNCTION(http_redirect)
  *
  * Sends raw data with support for (multiple) range requests.
  *
- * Retursn TRUE on success, or FALSE on failure.
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_FUNCTION(http_send_data)
 {
@@ -802,7 +837,7 @@ PHP_FUNCTION(http_send_file)
  *
  * Sends an already opened stream with support for (multiple) range requests.
  *
- * Expects a resource parameter referncing the stream to read from.
+ * Expects a resource parameter referencing the stream to read from.
  * 
  * Returns TRUE on success, or FALSE on failure.
  */
@@ -853,7 +888,7 @@ PHP_FUNCTION(http_chunked_decode)
  * Expects a string parameter containing a single HTTP message or
  * several consecutive HTTP messages.
  * 
- * Returns an hierachical object structure of the parsed messages.
+ * Returns an hierarchical object structure of the parsed messages.
  *
  * Example:
  * <pre>
@@ -1119,7 +1154,6 @@ PHP_FUNCTION(http_match_request_header)
  *  - httpauth:         string, http credentials in "user:pass" format
  *  - httpauthtype:     int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
  *  - compress:         bool, whether to allow gzip/deflate content encoding
- *                      (defaults to true)
  *  - port:             int, use another port as specified in the url
  *  - referer:          string, the referer to send
  *  - useragent:        string, the user agent to send
@@ -1134,13 +1168,30 @@ PHP_FUNCTION(http_match_request_header)
  *  - 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
+ *  - etag:             string, quoted etag for If-(None-)Match header
  *  - timeout:          int, seconds the request may take
  *  - connecttimeout:   int, seconds the connect may take
  *  - onprogress:       mixed, progress callback
+ *  - ssl:              array, with the following options:
+ *                      cert:        string, path to certificate
+ *                      certtype:    string, type of certificate
+ *                      certpasswd:  string, password for certificate
+ *                      key:         string, path to key
+ *                      keytype:     string, type of key
+ *                      keypasswd:   string, pasword for key
+ *                      engine:      string, ssl engine to use
+ *                      version:     int, ssl version to use
+ *                      verifypeer:  bool, whether to verify the peer
+ *                      verifyhost:  bool whether to verify the host
+ *                      cipher_list: string, list of allowed ciphers
+ *                      cainfo:      string
+ *                      capath:      string
+ *                      random_file: string
+ *                      egdsocket:   string
  * </pre>
  *
  * The optional third parameter will be filled with some additional information
- * in form af an associative array, if supplied, like the following example:
+ * in form of an associative array, if supplied, like the following example:
  * <pre>
  * <?php
  * array (
@@ -1243,7 +1294,7 @@ PHP_FUNCTION(http_head)
 
 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
  *
- * Performs an HTTP POST requeston the supplied url.
+ * Performs an HTTP POST request on the supplied url.
  * 
  * Expects a string as second parameter containing the pre-encoded post data.
  * See http_get() for a full list of available parameters and options.
@@ -1286,7 +1337,7 @@ PHP_FUNCTION(http_post_data)
  *
  * Performs an HTTP POST request on the supplied url.
  * 
- * Expecrs an associative array as second parameter, which will be
+ * Expects an associative array as second parameter, which will be
  * www-form-urlencoded. See http_get() for a full list of available options.
  * 
  * Returns the HTTP response(s) as string on success, or FALSE on failure.
@@ -1331,7 +1382,7 @@ PHP_FUNCTION(http_post_fields)
  *
  * Performs an HTTP PUT request on the supplied url.
  * 
- * Expects the second parameter to be a string referncing the file to upload.
+ * Expects the second parameter to be a string referencing the file 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.
@@ -1562,44 +1613,6 @@ PHP_FUNCTION(http_request_method_name)
 }
 /* }}} */
 
-/* {{{ Sara Golemons http_build_query() */
-#ifndef ZEND_ENGINE_2
-
-/* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
-   Generates a form-encoded query string from an associative array or object. */
-PHP_FUNCTION(http_build_query)
-{
-       zval *formdata;
-       char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
-       int prefix_len = 0, arg_sep_len = strlen(arg_sep);
-       phpstr *formstr;
-
-       if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
-               RETURN_FALSE;
-       }
-
-       if (!arg_sep_len) {
-               arg_sep = HTTP_URL_ARGSEP;
-               arg_sep_len = lenof(HTTP_URL_ARGSEP);
-       }
-
-       formstr = phpstr_new();
-       if (SUCCESS != http_urlencode_hash_recursive(HASH_OF(formdata), formstr, arg_sep, arg_sep_len, prefix, prefix_len)) {
-               phpstr_free(&formstr);
-               RETURN_FALSE;
-       }
-
-       if (!formstr->used) {
-               phpstr_free(&formstr);
-               RETURN_NULL();
-       }
-
-       RETURN_PHPSTR_PTR(formstr);
-}
-/* }}} */
-#endif /* !ZEND_ENGINE_2 */
-/* }}} */
-
 /* {{{ */
 #ifdef HTTP_HAVE_ZLIB
 
@@ -1633,7 +1646,7 @@ PHP_FUNCTION(http_deflate)
 
 /* {{{ proto string http_inflate(string data)
  *
- * Uncompress data compressed with either gzip, deflate AKA zlib or raw
+ * Decompress data compressed with either gzip, deflate AKA zlib or raw
  * deflate encoding.
  * 
  * Expects a string as parameter containing the compressed data.
@@ -1661,7 +1674,7 @@ PHP_FUNCTION(http_inflate)
 /* {{{ proto string ob_deflatehandler(string data, int mode)
  *
  * For use with ob_start(). The deflate output buffer handler can only be used once.
- * It conflicts with ob_gzhanlder and zlib.output_compression as well and should
+ * It conflicts with ob_gzhandler and zlib.output_compression as well and should
  * not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA
  * session.use_trans_sid).
  */
@@ -1706,7 +1719,7 @@ PHP_FUNCTION(ob_inflatehandler)
  *
  * Check for feature that require external libraries.
  * 
- * Accpepts an optional in parameter specifying which feature to probe for.
+ * Accepts an optional in parameter specifying which feature to probe for.
  * If the parameter is 0 or omitted, the return value contains a bitmask of 
  * all supported features that depend on external libraries.
  *