/*
- +----------------------------------------------------------------------+
- | 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$ */
#include "php_http_message_api.h"
#include "php_http_send_api.h"
#include "php_http_url_api.h"
+#include "php_http_encoding_api.h"
#include "phpstr/phpstr.h"
* Returns the absolute URI as string.
*
* Examples:
- * <code>
+ * <pre>
* <?php
* $uri = http_build_uri("page.php", "https", NULL, 488);
* ?>
- * </code>
+ * </pre>
*/
PHP_FUNCTION(http_build_uri)
{
}
/* }}} */
-#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; \
+ 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); \
- FREE_HASHTABLE(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; \
+ \
+ 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) { \
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); \
- } \
- } else { \
- 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(); \
+ add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
} \
} \
} \
}
-/* {{{ proto mixed http_negotiate_language(array supported[, array result])
+/* {{{ proto string http_negotiate_language(array supported[, array &result])
*
* This function negotiates the clients preferred language based on its
* Accept-Language HTTP header. The qualifier is recognized and languages
*/
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[, array result])
+/* {{{ proto string http_negotiate_charset(array supported[, array &result])
*
* This function negotiates the clients preferred charset based on its
* Accept-Charset HTTP header. The qualifier is recognized and charsets
*/
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);
}
/* }}} */
PHP_FUNCTION(http_send_content_type)
{
char *ct = "application/x-octetstream";
- int ct_len = lenof("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;
}
/* }}} */
-/* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
+/* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
*
* Matches the given unix timestamp against the clients "If-Modified-Since"
* resp. "If-Unmodified-Since" HTTP headers.
}
/* }}} */
-/* {{{ proto bool http_match_etag(string etag[, for_range = false])
+/* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
*
* Matches the given ETag against the clients "If-Match" resp.
* "If-None-Match" HTTP headers.
}
/* }}} */
-/* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
+/* {{{ proto void http_throttle(double sec[, int bytes = 40960])
*
* 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
*/
PHP_FUNCTION(http_throttle)
{
- long chunk_size = HTTP_SEND_BUFFERSIZE;
+ long chunk_size = HTTP_SENDBUF_SIZE;
double interval;
if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d|l", &interval, &chunk_size)) {
*
* Sends raw data with support for (multiple) range requests.
*
+ * Retursn TRUE on success, or FALSE on failure.
*/
PHP_FUNCTION(http_send_data)
{
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 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)
{
* - 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
if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
RETURN_PHPSTR_VAL(&response);
} else {
+ phpstr_dtor(&response);
RETURN_FALSE;
}
}
if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
RETURN_PHPSTR_VAL(&response);
} else {
+ phpstr_dtor(&response);
RETURN_FALSE;
}
}
if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
RETVAL_PHPSTR_VAL(&response);
} else {
+ phpstr_dtor(&response);
RETVAL_FALSE;
}
}
if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
RETVAL_PHPSTR_VAL(&response);
} else {
+ phpstr_dtor(&response);
RETVAL_FALSE;
}
http_request_body_dtor(&body);
if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
RETVAL_PHPSTR_VAL(&response);
} else {
+ phpstr_dtor(&response);
RETVAL_FALSE;
}
http_request_body_dtor(&body);
if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
RETURN_PHPSTR_VAL(&response);
} else {
+ phpstr_dtor(&response);
RETURN_NULL();
}
}
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;
RETURN_LONG((long) existing);
}
- RETVAL_LONG((long) http_request_method_register(method));
+ RETVAL_LONG((long) http_request_method_register(method, method_len));
}
/* }}} */
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).
*
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, 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_MHASHETAGS: whether ext/http was linked against libmhash,
+ * and ETags can be generated with the available mhash algorithms
+ * <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)
{
}