| modification, are permitted provided that the conditions mentioned |
| in the accompanying LICENSE file are met. |
+--------------------------------------------------------------------+
- | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
+ | Copyright (c) 2004-2006, Michael Wallner <mike@php.net> |
+--------------------------------------------------------------------+
*/
/* $Id$ */
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
+#define HTTP_WANT_SAPI
#define HTTP_WANT_CURL
#define HTTP_WANT_ZLIB
#include "php_http.h"
-#include "SAPI.h"
#include "php_ini.h"
-#include "ext/standard/info.h"
#include "ext/standard/php_string.h"
#include "zend_operators.h"
-#if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
+#ifdef HAVE_PHP_SESSION
# include "ext/session/php_session.h"
#endif
#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"
#include "php_http_send_api.h"
#include "php_http_url_api.h"
-ZEND_EXTERN_MODULE_GLOBALS(http)
-
/* {{{ 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"
*
- * Takes an optional unix timestamp as parameter.
- *
+ * Accepts an optional unix timestamp as parameter.
+ *
* Returns the HTTP date as string.
*/
PHP_FUNCTION(http_date)
}
if (t == -1) {
- t = (long) time(NULL);
+ t = (long) HTTP_GET_REQUEST_TIME();
}
RETURN_STRING(http_date(t), 0);
}
/* }}} */
-/* {{{ 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]]])
+ *
+ * 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:
+ * <pre>
+ * - 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
+ * </pre>
+ *
+ * Example:
+ * <pre>
+ * <?php
+ * // ftp://ftp.example.com/pub/files/current/?a=b&a=c
+ * echo http_build_url("http://user@www.example.com/pub/index.php?a=b#files",
+ * array(
+ * "scheme" => "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
+ * );
+ * ?>
+ * </pre>
* Returns the new URL as string on success or FALSE on failure.
*/
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;
}
} else {
convert_to_string(z_new_url);
if (!(new_url = php_url_parse_ex(Z_STRVAL_P(z_new_url), Z_STRLEN_P(z_new_url)))) {
+ http_error_ex(HE_WARNING, HTTP_E_URL, "Could not parse URL (%s)", Z_STRVAL_P(z_new_url));
RETURN_FALSE;
}
}
if (new_url) {
php_url_free(new_url);
}
+ http_error_ex(HE_WARNING, HTTP_E_URL, "Could not parse URL (%s)", Z_STRVAL_P(z_old_url));
RETURN_FALSE;
}
}
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);
}
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) {
}
/* }}} */
+/* {{{ 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)
+{
+ 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; \
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(); \
* 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.
*
* 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.
*
* 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.
*
}
if (t == -1) {
- t = (long) time(NULL);
+ t = (long) HTTP_GET_REQUEST_TIME();
}
RETURN_SUCCESS(http_send_last_modified(t));
* 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.
// current time if not supplied (senseless though)
if (t == -1) {
- t = (long) time(NULL);
+ t = (long) HTTP_GET_REQUEST_TIME();
}
if (for_range) {
* 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)
HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
- t = (long) time(NULL);
+ t = (long) HTTP_GET_REQUEST_TIME();
/* 0 or omitted */
if (!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
/* {{{ 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)
{
* Provides a basic throttling mechanism, which will yield the current process
* resp. thread until the entity has been completely sent, though.
*
- * Note: This doesn't really work with the FastCGI SAPI.
- *
* Expects a double parameter specifying the seconds too sleep() after
* each chunk sent. Additionally accepts an optional int parameter
* representing the chunk size in bytes.
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;
}
/* }}} */
*
* Redirect to the given url.
*
- * The supplied url will be expanded with http_build_uri(), the params array will
+ * The supplied url will be expanded with http_build_url(), the params array will
* be treated with http_build_query() and the session identification will be appended
* if session is true.
*
* The HTTP response code will be set according to status.
* You can use one of the following constants for convenience:
- * - HTTP_REDIRECT 302 Found
+ * - HTTP_REDIRECT 302 Found for GET/HEAD, else 303 See Other
* - HTTP_REDIRECT_PERM 301 Moved Permanently
+ * - HTTP_REDIRECT_FOUND 302 Found
* - HTTP_REDIRECT_POST 303 See Other
+ * - HTTP_REDIRECT_PROXY 305 Use Proxy
* - HTTP_REDIRECT_TEMP 307 Temporary Redirect
*
* Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
* for which redirect response code to use in which situation.
*
- * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
- * if the client doesn't redirect immediatly, and the request method was
+ * To be RFC compliant, "Redirecting to <a>URL</a>." will be displayed,
+ * if the client doesn't redirect immediately, and the request method was
* another one than HEAD.
*
* Returns FALSE on failure, or *exits* on success.
size_t query_len = 0;
zend_bool session = 0, free_params = 0;
zval *params = NULL;
- long status = 302;
+ long status = HTTP_REDIRECT;
char *query = NULL, *url = NULL, *URI, *LOC, *RED = NULL;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bl", &url, &url_len, ¶ms, &session, &status) != SUCCESS) {
RETURN_FALSE;
}
+#ifdef HAVE_PHP_SESSION
/* append session info */
if (session) {
if (!params) {
MAKE_STD_ZVAL(params);
array_init(params);
}
-#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
}
+#endif
/* treat params array with http_build_query() */
if (params) {
if (query_len) {
spprintf(&LOC, 0, "Location: %s?%s", URI, query);
- if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
+ if (status != 300) {
spprintf(&RED, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
}
} else {
spprintf(&LOC, 0, "Location: %s", URI);
- if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
+ if (status != 300) {
spprintf(&RED, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
}
}
zval_dtor(params);
FREE_ZVAL(params);
}
-
+
+ switch (status)
+ {
+ case 300:
+ RETVAL_SUCCESS(http_send_status_header(status, LOC));
+ efree(LOC);
+ return;
+ break;
+
+ case HTTP_REDIRECT_PERM:
+ case HTTP_REDIRECT_FOUND:
+ case HTTP_REDIRECT_POST:
+ case HTTP_REDIRECT_PROXY:
+ case HTTP_REDIRECT_TEMP:
+ break;
+
+ case 306:
+ default:
+ http_error_ex(HE_NOTICE, HTTP_E_RUNTIME, "Unsupported redirection status code: %ld", status);
+ case HTTP_REDIRECT:
+ if ( SG(request_info).request_method &&
+ strcasecmp(SG(request_info).request_method, "HEAD") &&
+ strcasecmp(SG(request_info).request_method, "GET")) {
+ status = HTTP_REDIRECT_POST;
+ } else {
+ status = HTTP_REDIRECT_FOUND;
+ }
+ break;
+ }
+
RETURN_SUCCESS(http_exit_ex(status, LOC, RED, 1));
}
/* }}} */
*
* 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)
{
*
* 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.
*/
* 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>
array_init(return_value);
if (SUCCESS != http_parse_headers(header, return_value)) {
zval_dtor(return_value);
+ http_error(HE_WARNING, HTTP_E_MALFORMED_HEADERS, "Failed to parse headers");
RETURN_FALSE;
}
}
/* }}}*/
-/* {{{ 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:
* <pre>
* <?php
- * print_r(http_parse_cookie("foo=bar; path=/"));
+ * print_r(http_parse_cookie("foo=bar; bar=baz; path=/; domain=example.com; comment=; secure", 0, array("comment")));
*
* stdClass Object
* (
- * [name] => foo
- * [value] => bar
+ * [cookies] => Array
+ * (
+ * [foo] => bar
+ * [bar] => baz
+ * )
+ *
+ * [extras] => Array
+ * (
+ * [comment] =>
+ * )
+ *
+ * [flags] => 16
+ * [expires] => 0
* [path] => /
+ * [domain] => example.com
* )
* ?>
* </pre>
*/
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);
}
}
*
* Get the raw request body (e.g. POST or PUT data).
*
- * Returns NULL when using the CLI SAPI.
+ * This function can not be used after http_get_request_body_stream()
+ * if the request method was another than POST.
+ *
+ * Returns the raw request body as string on success or NULL on failure.
*/
PHP_FUNCTION(http_get_request_body)
{
}
/* }}} */
+/* {{{ proto resource http_get_request_body_stream(void)
+ *
+ * Create a stream to read the raw request body (e.g. POST or PUT data).
+ *
+ * This function can only be used once if the request method was another than POST.
+ *
+ * Returns the raw request body as stream on success or NULL on failure.
+ */
+PHP_FUNCTION(http_get_request_body_stream)
+{
+ php_stream *s;
+
+ NO_ARGS;
+
+ if ((s = http_get_request_body_stream())) {
+ php_stream_to_zval(s, return_value);
+ } else {
+ http_error(HE_WARNING, HTTP_E_RUNTIME, "Failed to create request body stream");
+ RETURN_NULL();
+ }
+}
+/* }}} */
+
/* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
*
* Match an incoming HTTP 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) { \
* 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
* 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
* </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 (
- * '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>
*
/* {{{ 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.
*
* 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.
*
* 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.
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)) {
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) {
}
RETVAL_RESPONSE_OR_BODY(request);
}
- http_request_body_dtor(&body);
- request.body = NULL;
http_request_dtor(&request);
}
/* }}} */
* 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)
{
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) {
+ http_request_info(&request, Z_ARRVAL_P(info));
+ }
+ RETVAL_RESPONSE_OR_BODY(request);
+ }
+ http_request_dtor(&request);
+}
+/* }}} */
+
+/* {{{ proto string http_request(int method, string url[, string body[, array options[, array &info]]])
+ *
+ * Performs a custom HTTP request on the supplied url.
+ *
+ * Expects the first parameter to be an integer specifying the request method to use.
+ * Accepts an optional third string parameter containing the raw request body.
+ * 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_request)
+{
+ long meth;
+ char *URL, *data = NULL;
+ int URL_len, data_len = 0;
+ zval *options = NULL, *info = NULL;
+ http_request_body body;
+ http_request request;
+
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ls|sa/!z", &meth, &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, meth, 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) {
}
RETVAL_RESPONSE_OR_BODY(request);
}
- request.body = NULL;
http_request_dtor(&request);
}
/* }}} */
if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
convert_to_long(method);
} else {
- ulong mn;
+ int mn;
if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
RETURN_FALSE;
}
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));
+ RETURN_LONG((long) http_request_method_exists(0, (int) Z_LVAL_P(method), NULL));
default:
RETURN_FALSE;
}
RETURN_FALSE;
}
- RETURN_STRING(estrdup(http_request_method_name((ulong) method)), 0);
- }
-}
-/* }}} */
-
-/* {{{ 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);
+ RETURN_STRING(estrdup(http_request_method_name((int) method)), 0);
}
-
- 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
-/* {{{ proto string http_gzencode(string data[, int level = -1[, int mtime = 0]])
+/* {{{ proto string http_deflate(string data[, int flags = 0])
*
- * Compress data with the HTTP compatible GZIP encoding.
+ * Compress data with gzip, zlib AKA deflate or raw deflate encoding.
*
- * Expects the first parameter to be a string which contains the data that
- * should be encoded. Additionally accepts an optional in paramter specifying
- * the compression level, where -1 is default, 0 is no compression and 9 is
- * best compression ratio.
+ * Expects the first parameter to be a string containing the data that should
+ * be encoded.
*
* Returns the encoded string on success, or NULL on failure.
*/
-PHP_FUNCTION(http_gzencode)
+PHP_FUNCTION(http_deflate)
{
char *data;
int data_len;
- long level = -1, mtime = 0;
-
+ long flags = 0;
+
RETVAL_NULL();
- if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ll", &data, &data_len, &level, &mtime)) {
- HTTP_CHECK_GZIP_LEVEL(level, return);
- {
- char *encoded;
- size_t encoded_len;
-
- if (SUCCESS == http_encoding_gzencode(level, mtime, data, data_len, &encoded, &encoded_len)) {
- RETURN_STRINGL(encoded, (int) encoded_len, 0);
- }
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &flags)) {
+ char *encoded;
+ size_t encoded_len;
+
+ if (SUCCESS == http_encoding_deflate(flags, data, data_len, &encoded, &encoded_len)) {
+ RETURN_STRINGL(encoded, (int) encoded_len, 0);
}
}
}
/* }}} */
-/* {{{ proto string http_gzdecode(string data)
+/* {{{ proto string http_inflate(string data)
*
- * Uncompress data compressed with the HTTP compatible GZIP encoding.
+ * Decompress data compressed with either gzip, deflate AKA zlib or raw
+ * deflate encoding.
*
* Expects a string as parameter containing the compressed data.
*
* Returns the decoded string on success, or NULL on failure.
*/
-PHP_FUNCTION(http_gzdecode)
+PHP_FUNCTION(http_inflate)
{
char *data;
int data_len;
char *decoded;
size_t decoded_len;
- if (SUCCESS == http_encoding_gzdecode(data, data_len, &decoded, &decoded_len)) {
+ if (SUCCESS == http_encoding_inflate(data, data_len, &decoded, &decoded_len)) {
RETURN_STRINGL(decoded, (int) decoded_len, 0);
}
}
}
/* }}} */
-/* {{{ proto string http_deflate(string data[, int level = -1[, bool zlib_header = false]])
+/* {{{ proto string ob_deflatehandler(string data, int mode)
*
- * Compress data with the HTTP compatible DEFLATE encoding.
- *
- * Expects the first parameter to be a string containing the data that should
- * be encoded. Additionally accepts an optional int parameter specifying the
- * compression level, where -1 is default, 0 is no compression and 9 is best
- * compression ratio.
- *
- * Returns the encoded string on success, or NULL on failure.
+ * For use with ob_start(). The deflate output buffer handler can only be used once.
+ * 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).
*/
-PHP_FUNCTION(http_deflate)
+PHP_FUNCTION(ob_deflatehandler)
{
char *data;
int data_len;
- long level = -1;
- zend_bool zhdr = 0;
-
- RETVAL_NULL();
-
- if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|lb", &data, &data_len, &level, &zhdr)) {
- HTTP_CHECK_GZIP_LEVEL(level, return);
- {
- char *encoded;
- size_t encoded_len;
-
- if (SUCCESS == http_encoding_deflate(level, zhdr, data, data_len, &encoded, &encoded_len)) {
- RETURN_STRINGL(encoded, (int) encoded_len, 0);
- }
- }
+ long mode;
+
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
+ RETURN_FALSE;
}
+
+ http_ob_deflatehandler(data, data_len, &Z_STRVAL_P(return_value), (uint *) &Z_STRLEN_P(return_value), mode);
+ Z_TYPE_P(return_value) = Z_STRVAL_P(return_value) ? IS_STRING : IS_NULL;
}
/* }}} */
-/* {{{ proto string http_inflate(string data)
+/* {{{ proto string ob_inflatehandler(string data, int mode)
*
- * Uncompress data compressed with the HTTP compatible DEFLATE encoding.
- *
- * Expects a string as parameter containing the compressed data.
- *
- * Returns the decoded string on success, or NULL on failure.
+ * For use with ob_start(). Same restrictions as with ob_deflatehandler apply.
*/
-PHP_FUNCTION(http_inflate)
+PHP_FUNCTION(ob_inflatehandler)
{
char *data;
int data_len;
+ long mode;
- RETVAL_NULL();
-
- if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len)) {
- char *decoded;
- size_t decoded_len;
-
- if (SUCCESS == http_encoding_inflate(data, data_len, &decoded, &decoded_len)) {
- RETURN_STRINGL(decoded, (int) decoded_len, 0);
- }
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
+ RETURN_FALSE;
}
+
+ http_ob_inflatehandler(data, data_len, &Z_STRVAL_P(return_value), (uint *) &Z_STRLEN_P(return_value), mode);
+ Z_TYPE_P(return_value) = Z_STRVAL_P(return_value) ? IS_STRING : IS_NULL;
}
/* }}} */
*
* 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.
*