| 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"
/* {{{ 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;
}
}
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; \
* 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)
{
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) {
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>
*
* 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.
* - 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
* - 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 (
/* {{{ 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.
}
/* }}} */
-/* {{{ 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
/* {{{ 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.
/* {{{ 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).
*/
*
* 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.
*
projects / m6w6 / ext-http / blobdiff