X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_functions.c;h=aeb41da2482de0316695c67b340968ec4b0a52f3;hp=f03398c4100ebfd242bbe48f34ec0d97c3455dba;hb=669d2e6a8bdc642b6b52693f4593f199ddd7e8d2;hpb=98e0618077ab00672dd0e6e134d4722e033d827e
diff --git a/http_functions.c b/http_functions.c
index f03398c..aeb41da 100644
--- a/http_functions.c
+++ b/http_functions.c
@@ -27,6 +27,7 @@
#include "php_http_api.h"
#include "php_http_cache_api.h"
+#include "php_http_cookie_api.h"
#include "php_http_date_api.h"
#include "php_http_encoding_api.h"
#include "php_http_headers_api.h"
@@ -38,7 +39,7 @@
/* {{{ proto string http_date([int timestamp])
*
- * Compose a valid HTTP date regarding RFC 822/1123
+ * Compose a valid HTTP date regarding RFC 1123
* looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
*
* Accepts an optional unix timestamp as parameter.
@@ -63,6 +64,44 @@ PHP_FUNCTION(http_date)
/* {{{ proto string http_build_url(mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]])
*
+ * Build an URL.
+ *
+ * Expexts (part(s) of) an URL as first parameter in form of a string or assoziative array
+ * like parse_url() returns. Accepts an optional second parameter in the same way as the
+ * first argument. Accepts an optional third integer parameter, which is a bitmask of
+ * binary or'ed HTTP_URL_* constants. The optional fourth parameter will be filled
+ * with the results as associative array like parse_url() would return.
+ *
+ * The parts of the second URL will be merged into the first according to the flags argument.
+ * The following flags are recognized:
+ *
+ * - HTTP_URL_REPLACE: (default) set parts of the second url will replace the parts in the first
+ * - HTTP_URL_JOIN_PATH: the path of the second url will be merged into the one of the first
+ * - HTTP_URL_JOIN_QUERY: the two querystrings will be merged naivly; no replacements are done
+ * - HTTP_URL_STRIP_USER: the user part will not appear in the result
+ * - HTTP_URL_STRIP_PASS: the password part will not appear in the result
+ * - HTTP_URL_STRIP_AUTH: neither the user nor the password part will appear in the result
+ * - HTTP_URL_STRIP_PORT: no explicit port will be set in the result
+ * - HTTP_URL_STRIP_PATH: the path part will not appear in the result
+ * - HTTP_URL_STRIP_QUERY: no query string will be present in the result
+ * - HTTP_URL_STRIP_FRAGMENT: no fragment will be present in the result
+ *
+ *
+ * Example:
+ *
+ * "ftp",
+ * "host" => "ftp.example.com",
+ * "path" => "files/current/",
+ * "query" => "a=c"
+ * ),
+ * HTTP_URL_STRIP_AUTH | HTTP_URL_JOIN_PATH | HTTP_URL_JOIN_QUERY | HTTP_URL_STRIP_FRAGMENT
+ * );
+ * ?>
+ *
* Returns the new URL as string on success or FALSE on failure.
*/
PHP_FUNCTION(http_build_url)
@@ -148,6 +187,13 @@ PHP_FUNCTION(http_build_url)
/* {{{ proto string http_build_str(array query [, string prefix[, string arg_separator]])
*
* Opponent to parse_str().
+ *
+ * Expects an array as first argument which represents the parts of the query string to build.
+ * Accepts a string as optional second parameter containing a top-level prefix to use.
+ * The optional third parameter should specify an argument separator to use (by default the
+ * INI setting arg_separator.output will be used, or "&" if neither is set).
+ *
+ * Returns the built query as string on success or FALSE on failure.
*/
PHP_FUNCTION(http_build_str)
{
@@ -204,7 +250,7 @@ PHP_FUNCTION(http_build_str)
zval **value; \
\
zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
- if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
+ if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void *) &value)) { \
RETVAL_ZVAL(*value, 1, 0); \
} else { \
RETVAL_NULL(); \
@@ -230,7 +276,7 @@ PHP_FUNCTION(http_build_str)
* 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.
*
@@ -279,7 +325,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.
*
@@ -331,7 +377,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.
*
@@ -442,7 +488,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.
@@ -505,7 +551,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)
@@ -581,7 +627,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
@@ -610,7 +656,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)
{
@@ -657,8 +703,8 @@ PHP_FUNCTION(http_throttle)
return;
}
- HTTP_G(send).throttle_delay = interval;
- HTTP_G(send).buffer_size = chunk_size;
+ HTTP_G->send.throttle_delay = interval;
+ HTTP_G->send.buffer_size = chunk_size;
}
/* }}} */
@@ -683,7 +729,7 @@ PHP_FUNCTION(http_throttle)
* for which redirect response code to use in which situation.
*
* To be RFC compliant, "Redirecting to URL." 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.
@@ -794,7 +840,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)
{
@@ -837,7 +883,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.
*/
@@ -888,7 +934,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:
*
@@ -993,41 +1039,76 @@ PHP_FUNCTION(http_parse_headers)
}
/* }}}*/
-/* {{{ proto object http_parse_cookie(string cookie)
+/* {{{ proto object http_parse_cookie(string cookie[, int flags[, array allowed_extras]])
*
* Parses HTTP cookies like sent in a response into a struct.
*
* Expects a string as parameter containing the value of a Set-Cookie response header.
*
- * Returns an stdClass object with the cookie params as properties on success or FALSE on failure.
+ * Returns an stdClass olike shown in the example on success or FALSE on failure.
*
* Example:
*
* foo
- * [value] => bar
+ * [cookies] => Array
+ * (
+ * [foo] => bar
+ * [bar] => baz
+ * )
+ *
+ * [extras] => Array
+ * (
+ * [comment] =>
+ * )
+ *
+ * [flags] => 16
+ * [expires] => 0
* [path] => /
+ * [domain] => example.com
* )
* ?>
*
*/
PHP_FUNCTION(http_parse_cookie)
{
- char *cookie;
- int cookie_len;
+ char *cookie, **allowed_extras = NULL;
+ int i = 0, cookie_len;
+ long flags = 0;
+ zval *allowed_extras_array = NULL, **entry = NULL;
+ HashPosition pos;
+ http_cookie_list list;
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &cookie, &cookie_len)) {
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|la", &cookie, &cookie_len, &flags, &allowed_extras_array)) {
RETURN_FALSE;
}
- object_init(return_value);
- if (SUCCESS != http_parse_cookie(cookie, HASH_OF(return_value))) {
- zval_dtor(return_value);
- RETURN_FALSE;
+ if (allowed_extras_array) {
+ allowed_extras = ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array)) + 1, sizeof(char *));
+ FOREACH_VAL(pos, allowed_extras_array, entry) {
+ ZVAL_ADDREF(*entry);
+ convert_to_string_ex(entry);
+ allowed_extras[i] = estrndup(Z_STRVAL_PP(entry), Z_STRLEN_PP(entry));
+ zval_ptr_dtor(entry);
+ }
+ }
+
+ if (http_parse_cookie_ex(&list, cookie, flags, allowed_extras)) {
+ object_init(return_value);
+ http_cookie_list_tostruct(&list, return_value);
+ http_cookie_list_dtor(&list);
+ } else {
+ RETVAL_FALSE;
+ }
+
+ if (allowed_extras) {
+ for (i = 0; allowed_extras[i]; ++i) {
+ efree(allowed_extras[i]);
+ }
+ efree(allowed_extras);
}
}
@@ -1125,7 +1206,7 @@ PHP_FUNCTION(http_match_request_header)
zval **bodyonly; \
\
/* check if only the body should be returned */ \
- if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void **) &bodyonly)) && zval_is_true(*bodyonly)) { \
+ if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void *) &bodyonly)) && zval_is_true(*bodyonly)) { \
http_message *msg = http_message_parse(PHPSTR_VAL(&request.conv.response), PHPSTR_LEN(&request.conv.response)); \
\
if (msg) { \
@@ -1149,12 +1230,12 @@ 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
* - 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
@@ -1163,46 +1244,86 @@ PHP_FUNCTION(http_match_request_header)
* like array("header" => "value")
* - cookies: array, list of cookies as associative array
* like array("cookie" => "value")
+ * - 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
+ * - 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
+ * - 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
+ * 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
*
*
* 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:
*
* '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' => '',
+ * )
* ?>
*
*
@@ -1278,7 +1399,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.
@@ -1321,7 +1442,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.
@@ -1366,7 +1487,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.
@@ -1385,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)) {
@@ -1400,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) {
@@ -1413,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);
}
/* }}} */
@@ -1427,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)
{
@@ -1455,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) {
@@ -1468,7 +1620,6 @@ PHP_FUNCTION(http_put_stream)
}
RETVAL_RESPONSE_OR_BODY(request);
}
- request.body = NULL;
http_request_dtor(&request);
}
/* }}} */
@@ -1630,7 +1781,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.
@@ -1658,7 +1809,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).
*/
@@ -1703,7 +1854,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.
*