/*
- +----------------------------------------------------------------------+
- | PECL :: http |
- +----------------------------------------------------------------------+
- | This source file is subject to version 3.0 of the PHP license, that |
- | is bundled with this package in the file LICENSE, and is available |
- | through the world-wide-web at http://www.php.net/license/3_0.txt. |
- | If you did not receive a copy of the PHP license and are unable to |
- | obtain it through the world-wide-web, please send a note to |
- | license@php.net so we can mail you a copy immediately. |
- +----------------------------------------------------------------------+
- | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
- +----------------------------------------------------------------------+
+ +--------------------------------------------------------------------+
+ | PECL :: http |
+ +--------------------------------------------------------------------+
+ | Redistribution and use in source and binary forms, with or without |
+ | modification, are permitted provided that the conditions mentioned |
+ | in the accompanying LICENSE file are met. |
+ +--------------------------------------------------------------------+
+ | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
+ +--------------------------------------------------------------------+
*/
/* $Id$ */
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
-#include "php.h"
-#include "zend_operators.h"
+#define HTTP_WANT_CURL
+#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)
# include "ext/session/php_session.h"
#endif
-#include "php_http.h"
-#include "php_http_std_defs.h"
#include "php_http_api.h"
-#include "php_http_request_api.h"
#include "php_http_cache_api.h"
-#include "php_http_request_method_api.h"
-#include "php_http_request_api.h"
#include "php_http_date_api.h"
+#include "php_http_encoding_api.h"
#include "php_http_headers_api.h"
#include "php_http_message_api.h"
+#include "php_http_request_api.h"
+#include "php_http_request_method_api.h"
#include "php_http_send_api.h"
#include "php_http_url_api.h"
-#include "phpstr/phpstr.h"
-
ZEND_EXTERN_MODULE_GLOBALS(http)
/* {{{ proto string http_date([int timestamp])
*
- * This function returns a valid HTTP date regarding RFC 822/1123
+ * Compose a valid HTTP date regarding RFC 822/1123
* looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
*
+ * Takes an optional unix timestamp as parameter.
+ *
+ * Returns the HTTP date as string.
*/
PHP_FUNCTION(http_date)
{
}
/* }}} */
-/* {{{ proto string http_absolute_uri(string url[, string proto[, string host[, int port]]])
+/* {{{ proto string http_build_uri(string url[, string proto[, string host[, int port]]])
*
- * This function returns an absolute URI constructed from url.
+ * Build a complete URI according to the supplied parameters.
+ *
* If the url is already abolute but a different proto was supplied,
* only the proto part of the URI will be updated. If url has no
* path specified, the path of the current REQUEST_URI will be taken.
* The host will be taken either from the Host HTTP header of the client
* the SERVER_NAME or just localhost if prior are not available.
- *
- * Some examples:
+ * If a port is pecified in either the url or as sperate parameter,
+ * it will be added if it differs from te default port for HTTP(S).
+ *
+ * Returns the absolute URI as string.
+ *
+ * Examples:
* <pre>
- * url = "page.php" => http://www.example.com/current/path/page.php
- * url = "/page.php" => http://www.example.com/page.php
- * url = "/page.php", proto = "https" => https://www.example.com/page.php
+ * <?php
+ * $uri = http_build_uri("page.php", "https", NULL, 488);
+ * ?>
* </pre>
- *
*/
-PHP_FUNCTION(http_absolute_uri)
+PHP_FUNCTION(http_build_uri)
{
char *url = NULL, *proto = NULL, *host = NULL;
int url_len = 0, proto_len = 0, host_len = 0;
}
/* }}} */
-#define HTTP_DO_NEGOTIATE(type, supported, as_array) \
+#define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
{ \
HashTable *result; \
- if (result = http_negotiate_ ##type(supported)) { \
- if (as_array) { \
- Z_TYPE_P(return_value) = IS_ARRAY; \
- Z_ARRVAL_P(return_value) = result; \
+ if ((result = http_negotiate_ ##type(supported))) { \
+ char *key; \
+ uint key_len; \
+ ulong idx; \
+ \
+ if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
+ RETVAL_STRINGL(key, key_len-1, 0); \
} else { \
- char *key; \
- uint key_len; \
- ulong idx; \
- \
- if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
- RETVAL_STRINGL(key, key_len-1, 0); \
- } else { \
- RETVAL_NULL(); \
- } \
- zend_hash_destroy(result); \
+ RETVAL_NULL(); \
+ } \
+ \
+ if (rs_array) { \
+ zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
} \
+ \
+ zend_hash_destroy(result); \
+ FREE_HASHTABLE(result); \
+ \
} else { \
- if (as_array) { \
- zval **value; \
- \
- array_init(return_value); \
- \
- FOREACH_VAL(supported, value) { \
- convert_to_string_ex(value); \
- add_assoc_double(return_value, Z_STRVAL_PP(value), 1.0); \
- } \
+ zval **value; \
+ \
+ zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
+ if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
+ RETVAL_ZVAL(*value, 1, 0); \
} else { \
+ RETVAL_NULL(); \
+ } \
+ \
+ if (rs_array) { \
+ HashPosition pos; \
zval **value; \
\
- zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
- if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
- RETVAL_ZVAL(*value, 1, 0); \
- } else { \
- RETVAL_NULL(); \
+ FOREACH_VAL(pos, supported, value) { \
+ convert_to_string_ex(value); \
+ add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
} \
} \
} \
}
-/* {{{ proto string http_negotiate_language(array supported[, bool return_quality_array = false])
+/* {{{ proto string http_negotiate_language(array supported[, array &result])
*
* This function negotiates the clients preferred language based on its
- * Accept-Language HTTP header. It returns the negotiated language or
- * the default language (i.e. first array entry) if none match.
- *
- * The qualifier is recognized and languages without qualifier are rated highest.
- *
- * The supported parameter is expected to be an array having
- * the supported languages as array values.
- *
+ * Accept-Language HTTP header. The qualifier is recognized and languages
+ * 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.
+ * If the optional second parameter is supplied, it will be filled with an
+ * array containing the negotiation results.
+ *
+ * Returns the negotiated language or the default language (i.e. first array entry)
+ * if none match.
+ *
* Example:
* <pre>
* <?php
* 'de-AT',
* 'de-CH',
* );
- * include './langs/'. http_negotiate_language($langs) .'.php';
+ *
+ * include './langs/'. http_negotiate_language($langs, $result) .'.php';
+ *
+ * print_r($result);
* ?>
* </pre>
- *
*/
PHP_FUNCTION(http_negotiate_language)
{
- zval *supported;
- zend_bool as_array = 0;
+ zval *supported, *rs_array = NULL;
- if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &supported, &as_array) != SUCCESS) {
+ if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array) != SUCCESS) {
RETURN_FALSE;
}
- HTTP_DO_NEGOTIATE(language, supported, as_array);
+ if (rs_array) {
+ zval_dtor(rs_array);
+ array_init(rs_array);
+ }
+
+ HTTP_DO_NEGOTIATE(language, supported, rs_array);
}
/* }}} */
-/* {{{ proto string http_negotiate_charset(array supported)
+/* {{{ proto string http_negotiate_charset(array supported[, array &result])
*
* This function negotiates the clients preferred charset based on its
- * Accept-Charset HTTP header. It returns the negotiated charset or
- * the default charset (i.e. first array entry) if none match.
- *
- * The qualifier is recognized and charset without qualifier are rated highest.
- *
- * The supported parameter is expected to be an array having
- * the supported charsets as array values.
- *
+ * 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.
+ * If the optional second parameter is supplied, it will be filled with an
+ * array containing the negotiation results.
+ *
+ * Returns the negotiated charset or the default charset (i.e. first array entry)
+ * if none match.
+ *
* Example:
* <pre>
* <?php
* 'iso-8859-15',
* 'utf-8'
* );
- * $pref = http_negotiate_charset($charsets);
- * if (!strcmp($pref, 'iso-8859-1')) {
+ *
+ * $pref = http_negotiate_charset($charsets, $result);
+ *
+ * if (strcmp($pref, 'iso-8859-1')) {
* iconv_set_encoding('internal_encoding', 'iso-8859-1');
* iconv_set_encoding('output_encoding', $pref);
* ob_start('ob_iconv_handler');
* }
+ *
+ * print_r($result);
* ?>
* </pre>
*/
PHP_FUNCTION(http_negotiate_charset)
{
- zval *supported;
- zend_bool as_array = 0;
+ zval *supported, *rs_array = NULL;
- if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &supported, &as_array) != SUCCESS) {
+ if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array) != SUCCESS) {
RETURN_FALSE;
}
+
+ if (rs_array) {
+ zval_dtor(rs_array);
+ array_init(rs_array);
+ }
- HTTP_DO_NEGOTIATE(charset, supported, as_array);
+ HTTP_DO_NEGOTIATE(charset, supported, rs_array);
+}
+/* }}} */
+
+/* {{{ proto string http_negotiate_ctype(array supported[, array &result])
+ *
+ * This function negotiates the clients preferred content type based on its
+ * 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.
+ * If the optional second parameter is supplied, it will be filled with an
+ * array containing the negotiation results.
+ *
+ * Returns the negotiated content type or the default content type
+ * (i.e. first array entry) if none match.
+ *
+ * Example:
+ * <pre>
+ * <?php
+ * $ctypes = array('application/xhtml+xml', 'text/html');
+ * http_send_content_type(http_negotiate_content_type($ctypes));
+ * ?>
+ * </pre>
+ */
+PHP_FUNCTION(http_negotiate_content_type)
+{
+ zval *supported, *rs_array = NULL;
+
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array)) {
+ RETURN_FALSE;
+ }
+
+ if (rs_array) {
+ zval_dtor(rs_array);
+ array_init(rs_array);
+ }
+
+ HTTP_DO_NEGOTIATE(content_type, supported, rs_array);
}
/* }}} */
*
* Send HTTP status code.
*
+ * Expects an HTTP status code as parameter.
+ *
+ * Returns TRUE on success or FALSE on failure.
*/
PHP_FUNCTION(http_send_status)
{
/* {{{ proto bool http_send_last_modified([int timestamp])
*
- * This converts the given timestamp to a valid HTTP date and
+ * Send a "Last-Modified" header with a valid HTTP date.
+ *
+ * Accepts a unix timestamp, converts it to a valid HTTP date and
* sends it as "Last-Modified" HTTP header. If timestamp is
- * omitted, current time is sent.
+ * omitted, the current time will be sent.
*
+ * Returns TRUE on success or FALSE on failure.
*/
PHP_FUNCTION(http_send_last_modified)
{
/* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
*
- * Sets the content type.
+ * Send the Content-Type of the sent entity. This is particularly important
+ * if you use the http_send() API.
+ *
+ * Accepts an optional string parameter containing the desired content type
+ * (primary/secondary).
*
+ * Returns TRUE on success or FALSE on failure.
*/
PHP_FUNCTION(http_send_content_type)
{
- char *ct;
- int ct_len = 0;
+ char *ct = "application/x-octetstream";
+ int ct_len = lenof("application/x-octetstream");
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ct, &ct_len) != SUCCESS) {
RETURN_FALSE;
}
- if (!ct_len) {
- RETURN_SUCCESS(http_send_content_type("application/x-octetstream", lenof("application/x-octetstream")));
- }
RETURN_SUCCESS(http_send_content_type(ct, ct_len));
}
/* }}} */
/* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
*
- * Set the Content Disposition. The Content-Disposition header is very useful
+ * Send the Content-Disposition. The Content-Disposition header is very useful
* 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
+ * 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.
+ *
+ * Returns TRUE on success or FALSE on failure.
*/
PHP_FUNCTION(http_send_content_disposition)
{
}
/* }}} */
-/* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
+/* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
*
- * Matches the given timestamp against the clients "If-Modified-Since" resp.
- * "If-Unmodified-Since" HTTP headers.
+ * Matches the given unix timestamp against the clients "If-Modified-Since"
+ * resp. "If-Unmodified-Since" HTTP headers.
*
+ * Accepts a unix timestamp which should be matched. Optionally accepts an
+ * additional bool parameter, which if set to true will check the header
+ * usually used to validate HTTP ranges. If timestamp is omitted, the
+ * current time will be used.
+ *
+ * Returns TRUE if timestamp represents an earlier date than the header,
+ * else FALSE.
*/
PHP_FUNCTION(http_match_modified)
{
}
/* }}} */
-/* {{{ proto bool http_match_etag(string etag[, for_range = false])
+/* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
*
- * This matches the given ETag against the clients
- * "If-Match" resp. "If-None-Match" HTTP headers.
+ * Matches the given ETag against the clients "If-Match" resp.
+ * "If-None-Match" HTTP headers.
*
+ * Expects a string parameter containing the ETag to compare. Optionally
+ * 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 ("*"),
+ * else FALSE.
*/
PHP_FUNCTION(http_match_etag)
{
/* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
*
+ * Attempts to cache the sent entity by its last modification date.
+ *
+ * Accepts a unix timestamp as parameter which is handled as follows:
+ *
* If timestamp_or_expires is greater than 0, it is handled as timestamp
* and will be sent as date of last modification. If it is 0 or omitted,
* the current time will be sent as Last-Modified date. If it's negative,
* requested last modification date is not between the calculated timespan,
* the Last-Modified header is updated and the actual body will be sent.
*
+ * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
+ *
+ * A log entry will be written to the cache log if the INI entry
+ * http.cache_log is set and the cache attempt was successful.
*/
PHP_FUNCTION(http_cache_last_modified)
{
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
RETURN_FALSE;
}
+
+ HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
t = (long) time(NULL);
/* 0 or omitted */
if (!last_modified) {
/* does the client have? (att: caching "forever") */
- if (zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
+ if ((zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE"))) {
last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm));
/* send current time */
} else {
/* {{{ proto bool http_cache_etag([string etag])
*
- * This function attempts to cache the HTTP body based on an ETag,
- * either supplied or generated through calculation of the MD5
- * checksum of the output (uses output buffering).
+ * 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".
*
- * If clients "If-None-Match" header matches the supplied/calculated
+ * If the clients "If-None-Match" header matches the supplied/calculated
* ETag, the body is considered cached on the clients side and
* a "304 Not Modified" status code is issued.
*
+ * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
+ *
+ * A log entry is written to the cache log if the INI entry
+ * "http.cache_log" is set and the cache attempt was successful.
*/
PHP_FUNCTION(http_cache_etag)
{
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
RETURN_FALSE;
}
+
+ HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
RETURN_SUCCESS(http_cache_etag(etag, etag_len, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
}
/* {{{ proto string ob_etaghandler(string data, int mode)
*
- * For use with ob_start().
+ * For use with ob_start(). Output buffer handler generating an ETag with
+ * the hash algorythm specified with the INI setting "http.etag_mode".
*/
PHP_FUNCTION(ob_etaghandler)
{
}
/* }}} */
-/* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
+/* {{{ proto void http_throttle(double sec[, int bytes = 40960])
*
- * Use with http_send() API.
+ * Sets the throttle delay and send buffer size for use with http_send() API.
+ * 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.
+ *
* Example:
* <pre>
* <?php
*/
PHP_FUNCTION(http_throttle)
{
- long chunk_size;
+ long chunk_size = HTTP_SENDBUF_SIZE;
double interval;
- if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "dl", &interval, &chunk_size)) {
+ if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d|l", &interval, &chunk_size)) {
return;
}
}
/* }}} */
-/* {{{ proto void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])
+/* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
*
- * Redirect to a given url.
- * The supplied url will be expanded with http_absolute_uri(), the params array will
+ * Redirect to the given url.
+ *
+ * The supplied url will be expanded with http_build_uri(), the params array will
* be treated with http_build_query() and the session identification will be appended
* if session is true.
*
- * Depending on permanent the redirection will be issued with a permanent
- * ("301 Moved Permanently") or a temporary ("302 Found") redirection
- * status code.
+ * 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_PERM 301 Moved Permanently
+ * - HTTP_REDIRECT_POST 303 See Other
+ * - 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.
+ * if the client doesn't redirect immediatly, and the request method was
+ * another one than HEAD.
+ *
+ * Returns FALSE on failure, or *exits* on success.
+ *
+ * A log entry will be written to the redirect log, if the INI entry
+ * "http.redirect_log" is set and the redirect attempt was successful.
*/
PHP_FUNCTION(http_redirect)
{
int url_len;
size_t query_len = 0;
- zend_bool session = 0, permanent = 0, free_params = 0;
+ zend_bool session = 0, free_params = 0;
zval *params = NULL;
+ long status = 302;
char *query = NULL, *url = NULL, *URI, *LOC, *RED = NULL;
- if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bb", &url, &url_len, ¶ms, &session, &permanent) != SUCCESS) {
+ if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bl", &url, &url_len, ¶ms, &session, &status) != SUCCESS) {
RETURN_FALSE;
}
FREE_ZVAL(params);
}
- RETURN_SUCCESS(http_exit_ex(permanent ? 301 : 302, LOC, RED, 1));
+ 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.
*/
PHP_FUNCTION(http_send_data)
{
*
* Sends a file with support for (multiple) range requests.
*
+ * Expects a string parameter referencing the file to send.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
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.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_FUNCTION(http_send_stream)
{
/* {{{ proto string http_chunked_decode(string encoded)
*
- * This function decodes a string that was HTTP-chunked encoded.
- * Returns false on failure.
+ * Decodes a string that was HTTP-chunked encoded.
+ *
+ * Expects a chunked encoded string as parameter.
+ *
+ * Returns the decoded string on success or FALSE on failure.
*/
PHP_FUNCTION(http_chunked_decode)
{
RETURN_FALSE;
}
- if (NULL != http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) {
+ if (NULL != http_encoding_dechunk(encoded, encoded_len, &decoded, &decoded_len)) {
RETURN_STRINGL(decoded, (int) decoded_len, 0);
} else {
RETURN_FALSE;
/* {{{ proto object http_parse_message(string message)
*
- * Parses (a) http_message(s) into a simple recursive object structure:
+ * Parses (a) http_message(s) into a simple recursive object structure.
+ *
+ * Expects a string parameter containing a single HTTP message or
+ * several consecutive HTTP messages.
*
+ * Returns an hierachical object structure of the parsed messages.
+ *
+ * Example:
* <pre>
* <?php
* print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
RETURN_NULL();
}
-
- if (msg = http_message_parse(message, message_len)) {
+ if ((msg = http_message_parse(message, message_len))) {
object_init(return_value);
http_message_tostruct_recursive(msg, return_value);
http_message_free(&msg);
/* {{{ proto array http_parse_headers(string header)
*
+ * Parses HTTP headers into an associative array.
+ *
+ * Expects a string parameter containing HTTP headers.
+ *
+ * Returns an array on success, or FALSE on failure.
+ *
+ * Example:
+ * <pre>
+ * <?php
+ * $headers = "content-type: text/html; charset=UTF-8\r\n".
+ * "Server: Funky/1.0\r\n".
+ * "Set-Cookie: foo=bar\r\n".
+ * "Set-Cookie: baz=quux\r\n".
+ * "Folded: works\r\n\ttoo\r\n";
+ * print_r(http_parse_headers($headers));
+ *
+ * Array
+ * (
+ * [Content-Type] => text/html; chatset=UTF-8
+ * [Server] => Funky/1.0
+ * [Set-Cookie] => Array
+ * (
+ * [0] => foo=bar
+ * [1] => baz=quux
+ * )
+ * [Folded] => works
+ * too
+ * ?>
+ * </pre>
*/
PHP_FUNCTION(http_parse_headers)
{
/* {{{ proto array http_get_request_headers(void)
*
* Get a list of incoming HTTP headers.
+ *
+ * Returns an associative array of incoming request headers.
*/
PHP_FUNCTION(http_get_request_headers)
{
/* {{{ proto string http_get_request_body(void)
*
* Get the raw request body (e.g. POST or PUT data).
+ *
+ * Returns NULL when using the CLI SAPI.
*/
PHP_FUNCTION(http_get_request_body)
{
/* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
*
* Match an incoming HTTP header.
+ *
+ * Expects two string parameters representing the header name (case-insensitive)
+ * and the header value that should be compared. The case sensitivity of the
+ * header value depends on the additional optional bool parameter accepted.
+ *
+ * Returns TRUE if header value matches, else FALSE.
*/
PHP_FUNCTION(http_match_request_header)
{
/* {{{ HAVE_CURL */
#ifdef HTTP_HAVE_CURL
+#define RETURN_RESPONSE_OR_BODY(response) \
+ { \
+ 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)) { \
+ http_message *msg = http_message_parse(PHPSTR_VAL(&response), PHPSTR_LEN(&response)); \
+ \
+ if (msg) { \
+ RETVAL_STRINGL(PHPSTR_VAL(&msg->body), PHPSTR_LEN(&msg->body), 1); \
+ http_message_free(&msg); \
+ return; \
+ } \
+ } else { \
+ RETURN_PHPSTR_VAL(&response); \
+ } \
+ }
+
/* {{{ proto string http_get(string url[, array options[, array &info]])
*
* Performs an HTTP GET request on the supplied url.
*
- * The second parameter is expected to be an associative
+ * The second parameter, if set, is expected to be an associative
* array where the following keys will be recognized:
* <pre>
* - redirect: int, whether and how many redirects to follow
* - 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 sends
+ * - referer: string, the referer to send
* - useragent: string, the user agent to send
* (defaults to PECL::HTTP/version (PHP/version)))
* - headers: array, list of custom headers as associative array
* )
* ?>
* </pre>
+ *
+ * Returns the HTTP response(s) as string on success, or FALSE on failure.
*/
PHP_FUNCTION(http_get)
{
phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
- RETURN_PHPSTR_VAL(&response);
- } else {
- RETURN_FALSE;
+ RETURN_RESPONSE_OR_BODY(response);
}
+ phpstr_dtor(&response);
+ RETURN_FALSE;
}
/* }}} */
/* {{{ proto string http_head(string url[, array options[, array &info]])
*
- * Performs an HTTP HEAD request on the suppied url.
- * Returns the HTTP response as string.
- * See http_get() for a full list of available options.
+ * Performs an HTTP HEAD request on the supplied url.
+ *
+ * See http_get() for a full list of available parameters and options.
+ *
+ * Returns the HTTP response as string on success, or FALSE on failure.
*/
PHP_FUNCTION(http_head)
{
phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
- RETURN_PHPSTR_VAL(&response);
- } else {
- RETURN_FALSE;
+ RETURN_RESPONSE_OR_BODY(response);
}
+ phpstr_dtor(&response);
+ RETURN_FALSE;
}
/* }}} */
/* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
*
- * Performs an HTTP POST request, posting data.
- * Returns the HTTP response as string.
- * See http_get() for a full list of available options.
+ * Performs an HTTP POST requeston 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.
+ *
+ * Returns the HTTP response(s) as string on success, or FALSE on failure.
*/
PHP_FUNCTION(http_post_data)
{
phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
- RETVAL_PHPSTR_VAL(&response);
- } else {
- RETVAL_FALSE;
+ RETURN_RESPONSE_OR_BODY(response);
}
+ phpstr_dtor(&response);
+ RETVAL_FALSE;
}
/* }}} */
/* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
*
- * Performs an HTTP POST request, posting www-form-urlencoded array data.
- * Returns the HTTP response as string.
- * See http_get() for a full list of available options.
+ * Performs an HTTP POST request on the supplied url.
+ *
+ * Expecrs 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.
*/
PHP_FUNCTION(http_post_fields)
{
phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
- RETVAL_PHPSTR_VAL(&response);
- } else {
- RETVAL_FALSE;
+ http_request_body_dtor(&body);
+ RETURN_RESPONSE_OR_BODY(response);
}
http_request_body_dtor(&body);
+ phpstr_dtor(&response);
+ RETURN_FALSE;
}
/* }}} */
/* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
*
- * Performs an HTTP PUT request, uploading file.
- * Returns the HTTP response as string.
+ * Performs an HTTP PUT request on the supplied url.
+ *
+ * Expects the second parameter to be a string referncing 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.
*/
PHP_FUNCTION(http_put_file)
{
phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
- RETVAL_PHPSTR_VAL(&response);
- } else {
- RETVAL_FALSE;
+ http_request_body_dtor(&body);
+ RETURN_RESPONSE_OR_BODY(response);
}
http_request_body_dtor(&body);
+ phpstr_dtor(&response);
+ RETURN_FALSE;
}
/* }}} */
/* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
*
- * Performs an HTTP PUT request, uploading stream.
- * Returns the HTTP response as string.
+ * Performs an HTTP PUT request on the supplied url.
+ *
+ * Expects the second parameter to be a resource referencing an already
+ * 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.
*/
PHP_FUNCTION(http_put_stream)
{
phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
- RETURN_PHPSTR_VAL(&response);
- } else {
- RETURN_NULL();
+ RETURN_RESPONSE_OR_BODY(response);
}
+ phpstr_dtor(&response);
+ RETURN_FALSE;
}
/* }}} */
#endif /* HTTP_HAVE_CURL */
/* }}} HAVE_CURL */
-/* {{{ proto long http_request_method_register(string method)
+/* {{{ proto int http_request_method_register(string method)
*
* Register a custom request method.
+ *
+ * Expects a string parameter containing the request method name to register.
+ *
+ * Returns the ID of the request method on success, or FALSE on failure.
*/
PHP_FUNCTION(http_request_method_register)
{
char *method;
- int *method_len;
- unsigned long existing;
+ int method_len;
+ ulong existing;
if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
RETURN_FALSE;
}
- if (existing = http_request_method_exists(1, 0, method)) {
+ if ((existing = http_request_method_exists(1, 0, method))) {
RETURN_LONG((long) existing);
}
- RETVAL_LONG((long) http_request_method_register(method));
+ RETVAL_LONG((long) http_request_method_register(method, method_len));
}
/* }}} */
/* {{{ proto bool http_request_method_unregister(mixed method)
*
* Unregister a previously registered custom request method.
+ *
+ * Expects either the request method name or ID.
+ *
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_FUNCTION(http_request_method_unregister)
{
if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
convert_to_long(method);
} else {
- unsigned long mn;
+ ulong mn;
if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
RETURN_FALSE;
}
}
/* }}} */
-/* {{{ proto long http_request_method_exists(mixed method)
+/* {{{ proto int http_request_method_exists(mixed method)
*
* Check if a request method is registered (or available by default).
+ *
+ * Expects either the request method name or ID as parameter.
+ *
+ * Returns TRUE if the request method is known, else FALSE.
*/
PHP_FUNCTION(http_request_method_exists)
{
}
/* }}} */
-/* {{{ proto string http_request_method_name(long method)
+/* {{{ proto string http_request_method_name(int method)
*
* Get the literal string representation of a standard or registered request method.
+ *
+ * Expects the request method ID as parameter.
+ *
+ * Returns the request method name as string on success, or FALSE on failure.
*/
PHP_FUNCTION(http_request_method_name)
{
RETURN_FALSE;
}
- RETURN_STRING(estrdup(http_request_method_name((unsigned long) method)), 0);
+ RETURN_STRING(estrdup(http_request_method_name((ulong) method)), 0);
}
}
/* }}} */
int prefix_len = 0, arg_sep_len = strlen(arg_sep);
phpstr *formstr;
- if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
- RETURN_FALSE;
- }
-
- if (Z_TYPE_P(formdata) != IS_ARRAY && Z_TYPE_P(formdata) != IS_OBJECT) {
- http_error(HE_WARNING, HTTP_E_INVALID_PARAM, "Parameter 1 expected to be Array or Object. Incorrect value given.");
+ 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_implementation_ex(HASH_OF(formdata), formstr, arg_sep, prefix, prefix_len, NULL, 0, NULL, 0, (Z_TYPE_P(formdata) == IS_OBJECT ? formdata : NULL))) {
+ if (SUCCESS != http_urlencode_hash_recursive(HASH_OF(formdata), formstr, arg_sep, arg_sep_len, prefix, prefix_len)) {
phpstr_free(&formstr);
RETURN_FALSE;
}
#endif /* !ZEND_ENGINE_2 */
/* }}} */
+/* {{{ */
+#ifdef HTTP_HAVE_ZLIB
+
+/* {{{ proto string http_gzencode(string data[, int level = -1])
+ *
+ * Compress data with the HTTP compatible GZIP 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.
+ *
+ * Returns the encoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_gzencode)
+{
+ char *data;
+ int data_len;
+ long level = -1;
+
+ RETVAL_NULL();
+
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &level)) {
+ HTTP_CHECK_GZIP_LEVEL(level, return);
+ {
+ char *encoded;
+ size_t encoded_len;
+
+ if (SUCCESS == http_encoding_gzencode(level, data, data_len, &encoded, &encoded_len)) {
+ RETURN_STRINGL(encoded, (int) encoded_len, 0);
+ }
+ }
+ }
+}
+/* }}} */
+
+/* {{{ proto string http_gzdecode(string data)
+ *
+ * Uncompress data compressed with the HTTP compatible GZIP encoding.
+ *
+ * Expects a string as parameter containing the compressed data.
+ *
+ * Returns the decoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_gzdecode)
+{
+ char *data;
+ int data_len;
+
+ 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_gzdecode(data, data_len, &decoded, &decoded_len)) {
+ RETURN_STRINGL(decoded, (int) decoded_len, 0);
+ }
+ }
+}
+/* }}} */
+
+/* {{{ proto string http_deflate(string data[, int level = -1])
+ *
+ * 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.
+ */
+PHP_FUNCTION(http_deflate)
+{
+ char *data;
+ int data_len;
+ long level = -1;
+
+ RETVAL_NULL();
+
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &level)) {
+ HTTP_CHECK_GZIP_LEVEL(level, return);
+ {
+ char *encoded;
+ size_t encoded_len;
+
+ if (SUCCESS == http_encoding_deflate(level, data, data_len, &encoded, &encoded_len)) {
+ RETURN_STRINGL(encoded, (int) encoded_len, 0);
+ }
+ }
+ }
+}
+/* }}} */
+
+/* {{{ proto string http_inflate(string data)
+ *
+ * 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.
+ */
+PHP_FUNCTION(http_inflate)
+{
+ char *data;
+ int data_len;
+
+ 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);
+ }
+ }
+}
+/* }}} */
+
+/* {{{ proto string http_compress(string data[, int level = -1])
+ *
+ * Compress data with the HTTP compatible COMPRESS encoding.
+ *
+ * Expects the first parameter to be a string containing the data which 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.
+ */
+PHP_FUNCTION(http_compress)
+{
+ char *data;
+ int data_len;
+ long level = -1;
+
+ RETVAL_NULL();
+
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &level)) {
+ HTTP_CHECK_GZIP_LEVEL(level, return);
+ {
+ char *encoded;
+ size_t encoded_len;
+
+ if (SUCCESS == http_encoding_compress(level, data, data_len, &encoded, &encoded_len)) {
+ RETURN_STRINGL(encoded, (int) encoded_len, 0);
+ }
+ }
+ }
+}
+/* }}} */
+
+/* {{{ proto string http_uncompress(string data)
+ *
+ * Uncompress data compressed with the HTTP compatible COMPRESS encoding.
+ *
+ * Expects a string as parameter containing the compressed data.
+ *
+ * Returns the decoded string on success, or NULL on failure.
+ */
+PHP_FUNCTION(http_uncompress)
+{
+ char *data;
+ int data_len;
+
+ 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_uncompress(data, data_len, &decoded, &decoded_len)) {
+ RETURN_STRINGL(decoded, (int) decoded_len, 0);
+ }
+ }
+}
+/* }}} */
+#endif /* HTTP_HAVE_ZLIB */
+/* }}} */
+
+/* {{{ proto int http_support([int feature = 0])
+ *
+ * Check for feature that require external libraries.
+ *
+ * Accpepts 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.
+ *
+ * Available features to probe for are:
+ * <ul>
+ * <li> HTTP_SUPPORT: always set
+ * <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
+ * and HTTP requests can be issued
+ * <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
+ * and SSL requests can be issued
+ * <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
+ * and compressed HTTP responses can be decoded
+ * <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
+ * and the HttpResponse::guessContentType() method is usable
+ * </ul>
+ *
+ * Returns int, whether requested feature is supported, or a bitmask with
+ * all supported features.
+ */
+PHP_FUNCTION(http_support)
+{
+ long feature = 0;
+
+ RETVAL_LONG(0L);
+
+ if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &feature)) {
+ RETVAL_LONG(http_support(feature));
+ }
+}
+/* }}} */
+
PHP_FUNCTION(http_test)
{
}
projects / m6w6 / ext-http / blobdiff