X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_methods.c;h=d22ae96e912c00c050ef0cc7f3c55492e9805ab9;hp=57a7c2b579d31e53fa6ce37848f2f81d3f7d6a9c;hb=af674f03c32f0f56b7f8c67e61c7e86b3ea23be5;hpb=e7ab97894056ebc5907326ccf6b8c76071883d6b diff --git a/http_methods.c b/http_methods.c index 57a7c2b..d22ae96 100644 --- a/http_methods.c +++ b/http_methods.c @@ -15,9 +15,6 @@ /* $Id$ */ -#define _WINSOCKAPI_ -#define ZEND_INCLUDE_FULL_WINDOWS_HEADERS - #ifdef HAVE_CONFIG_H # include "config.h" #endif @@ -26,19 +23,24 @@ #include "php_http.h" #include "php_http_api.h" #include "php_http_curl_api.h" -#include "ext/standard/php_smart_str.h" +#include "php_http_std_defs.h" #ifdef ZEND_ENGINE_2 -/* {{{ HTTPi_Response */ +/* {{{ HttpResponse */ -/* {{{ proto void HTTPi_Response::__construct(bool cache, bool gzip) +/* {{{ proto void HttpResponse::__construct(bool cache, bool gzip) + * + * Instantiates a new HttpResponse object, which can be used to send + * any data/resource/file to an HTTP client with caching and multiple + * ranges/resuming support. * + * NOTE: GZIPping is not implemented yet. */ -PHP_METHOD(HTTPi_Response, __construct) +PHP_METHOD(HttpResponse, __construct) { zend_bool do_cache = 0, do_gzip = 0; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|bb", &do_cache, &do_gzip)) { // throw exception @@ -50,13 +52,20 @@ PHP_METHOD(HTTPi_Response, __construct) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setCache(bool cache) +/* {{{ proto bool HttpResponse::setCache(bool cache) * + * Whether it sould be attempted to cache the entitity. + * This will result in necessary caching headers and checks of clients + * "If-Modified-Since" and "If-None-Match" headers. If one of those headers + * matches a "304 Not Modified" status code will be issued. + * + * NOTE: If you're using sessions, be shure that you set session.cache_limiter + * to something more appropriate than "no-cache"! */ -PHP_METHOD(HTTPi_Response, setCache) +PHP_METHOD(HttpResponse, setCache) { zend_bool do_cache = 0; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) { RETURN_FALSE; @@ -67,13 +76,14 @@ PHP_METHOD(HTTPi_Response, setCache) } /* }}} */ -/* {{{ proto bool HTTPi_Response::getCache() +/* {{{ proto bool HttpResponse::getCache() * + * Get current caching setting. */ -PHP_METHOD(HTTPi_Response, getCache) +PHP_METHOD(HttpResponse, getCache) { zval *do_cache = NULL; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -82,13 +92,14 @@ PHP_METHOD(HTTPi_Response, getCache) } /* }}}*/ -/* {{{ proto bool HTTPi_Response::setGzip(bool gzip) +/* {{{ proto bool HttpResponse::setGzip(bool gzip) * + * Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET. */ -PHP_METHOD(HTTPi_Response, setGzip) +PHP_METHOD(HttpResponse, setGzip) { zend_bool do_gzip = 0; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) { RETURN_FALSE; @@ -99,13 +110,14 @@ PHP_METHOD(HTTPi_Response, setGzip) } /* }}} */ -/* {{{ proto bool HTTPi_Response::getGzip() +/* {{{ proto bool HttpResponse::getGzip() * + * Get current gzipping setting. */ -PHP_METHOD(HTTPi_Response, getGzip) +PHP_METHOD(HttpResponse, getGzip) { zval *do_gzip = NULL; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -114,15 +126,17 @@ PHP_METHOD(HTTPi_Response, getGzip) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setCacheControl(string control[, bool raw = false]) +/* {{{ proto bool HttpResponse::setCacheControl(string control[, bool raw = false]) * + * Set a custom cache-control header, usually being "private" or "public"; if + * $raw is set to true the header will be sent as-is. */ -PHP_METHOD(HTTPi_Response, setCacheControl) +PHP_METHOD(HttpResponse, setCacheControl) { char *ccontrol; int cc_len; zend_bool raw = 0; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &ccontrol, &cc_len, &raw)) { RETURN_FALSE; @@ -139,13 +153,14 @@ PHP_METHOD(HTTPi_Response, setCacheControl) } /* }}} */ -/* {{{ proto string HTTPi_Response::getCacheControl() +/* {{{ proto string HttpResponse::getCacheControl() * + * Get current Cache-Control header setting. */ -PHP_METHOD(HTTPi_Response, getCacheControl) +PHP_METHOD(HttpResponse, getCacheControl) { zval *ccontrol; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -154,14 +169,15 @@ PHP_METHOD(HTTPi_Response, getCacheControl) } /* }}} */ -/* {{{ proto bool HTTPi::setContentType(string content_type) +/* {{{ proto bool HttpResponse::setContentType(string content_type) * + * Set the content-type of the sent entity. */ -PHP_METHOD(HTTPi_Response, setContentType) +PHP_METHOD(HttpResponse, setContentType) { char *ctype; int ctype_len; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) { RETURN_FALSE; @@ -179,13 +195,14 @@ PHP_METHOD(HTTPi_Response, setContentType) } /* }}} */ -/* {{{ proto string HTTPi_Response::getContentType() +/* {{{ proto string HttpResponse::getContentType() * + * Get current Content-Type header setting. */ -PHP_METHOD(HTTPi_Response, getContentType) +PHP_METHOD(HttpResponse, getContentType) { zval *ctype; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -194,15 +211,18 @@ PHP_METHOD(HTTPi_Response, getContentType) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setContentDisposition(string filename[, bool inline = false]) +/* {{{ proto bool HttpResponse::setContentDisposition(string filename[, bool inline = false]) * + * Set the Content-Disposition of the sent entity. This setting aims to suggest + * the receiveing user agent how to handle the sent entity; usually the client + * will show the user a "Save As..." popup. */ -PHP_METHOD(HTTPi_Response, setContentDisposition) +PHP_METHOD(HttpResponse, setContentDisposition) { char *file; int file_len; zend_bool is_inline = 0; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &is_inline)) { RETURN_FALSE; @@ -214,14 +234,22 @@ PHP_METHOD(HTTPi_Response, setContentDisposition) } /* }}} */ -/* {{{ proto array HTTPi_Response::getContentDisposition() +/* {{{ proto array HttpResponse::getContentDisposition() * + * Get current Content-Disposition setting. + * Will return an associative array like: + *
+ * array(
+ *     'filename' => 'foo.bar',
+ *     'inline'   => false
+ * )
+ * 
*/ -PHP_METHOD(HTTPi_Response, getContentDisposition) +PHP_METHOD(HttpResponse, getContentDisposition) { zval *file; zval *is_inline; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (ZEND_NUM_ARGS()) { WRONG_PARAM_COUNT; @@ -236,14 +264,15 @@ PHP_METHOD(HTTPi_Response, getContentDisposition) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setETag(string etag) +/* {{{ proto bool HttpResponse::setETag(string etag) * + * Set a custom ETag. Use this only if you know what you're doing. */ -PHP_METHOD(HTTPi_Response, setETag) +PHP_METHOD(HttpResponse, setETag) { char *etag; int etag_len; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) { RETURN_FALSE; @@ -254,13 +283,14 @@ PHP_METHOD(HTTPi_Response, setETag) } /* }}} */ -/* {{{ proto string HTTPi_Response::getETag() +/* {{{ proto string HttpResponse::getETag() * + * Get the previously set custom ETag. */ -PHP_METHOD(HTTPi_Response, getETag) +PHP_METHOD(HttpResponse, getETag) { zval *etag; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -269,14 +299,14 @@ PHP_METHOD(HTTPi_Response, getETag) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setData(string data) +/* {{{ proto bool HttpResponse::setData(string data) * + * Set the data to be sent. */ -PHP_METHOD(HTTPi_Response, setData) +PHP_METHOD(HttpResponse, setData) { zval *the_data; - char *etag; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_data)) { RETURN_FALSE; @@ -290,13 +320,14 @@ PHP_METHOD(HTTPi_Response, setData) } /* }}} */ -/* {{{ proto string HTTPi_Response::getData() +/* {{{ proto string HttpResponse::getData() * + * Get the previously set data to be sent. */ -PHP_METHOD(HTTPi_Response, getData) +PHP_METHOD(HttpResponse, getData) { zval *the_data; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -305,15 +336,15 @@ PHP_METHOD(HTTPi_Response, getData) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setStream(resource stream) +/* {{{ proto bool HttpResponse::setStream(resource stream) * + * Set the resource to be sent. */ -PHP_METHOD(HTTPi_Response, setStream) +PHP_METHOD(HttpResponse, setStream) { zval *the_stream; php_stream *the_real_stream; - char *etag; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) { RETURN_FALSE; @@ -328,13 +359,14 @@ PHP_METHOD(HTTPi_Response, setStream) } /* }}} */ -/* {{{ proto resource HTTPi_Response::getStream() +/* {{{ proto resource HttpResponse::getStream() * + * Get the previously set resource to be sent. */ -PHP_METHOD(HTTPi_Response, getStream) +PHP_METHOD(HttpResponse, getStream) { zval *the_stream; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -343,13 +375,14 @@ PHP_METHOD(HTTPi_Response, getStream) } /* }}} */ -/* {{{ proto bool HTTPi_Response::setFile(string file) +/* {{{ proto bool HttpResponse::setFile(string file) * + * Set the file to be sent. */ -PHP_METHOD(HTTPi_Response, setFile) +PHP_METHOD(HttpResponse, setFile) { zval *the_file; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_file)) { RETURN_FALSE; @@ -364,13 +397,14 @@ PHP_METHOD(HTTPi_Response, setFile) } /* }}} */ -/* {{{ proto string HTTPi_Response::getFile() +/* {{{ proto string HttpResponse::getFile() * + * Get the previously set file to be sent. */ -PHP_METHOD(HTTPi_Response, getFile) +PHP_METHOD(HttpResponse, getFile) { zval *the_file; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); NO_ARGS; @@ -379,10 +413,27 @@ PHP_METHOD(HTTPi_Response, getFile) } /* }}} */ -PHP_METHOD(HTTPi_Response, send) +/* {{{ proto bool HttpResponse::send() + * + * Finally send the entity. + * + * Example: + *
+ * setFile('../hidden/contract.pdf');
+ * $r->setContentType('application/pdf');
+ * $r->send();
+ * ?>
+ * 
+ * + */ +PHP_METHOD(HttpResponse, send) { zval *do_cache, *do_gzip; - getObject(httpi_response_object, obj); + getObject(http_response_object, obj); + + NO_ARGS; do_cache = GET_PROP(obj, cache); do_gzip = GET_PROP(obj, gzip); @@ -427,7 +478,7 @@ PHP_METHOD(HTTPi_Response, send) zval *dispo_file = GET_PROP(obj, dispoFile); if (Z_STRLEN_P(dispo_file)) { zval *dispo_inline = GET_PROP(obj, dispoInline); - http_send_content_disposition(Z_STRVAL_P(dispo_file), Z_STRLEN_P(dispo_file), Z_LVAL_P(dispo_inline)); + http_send_content_disposition(Z_STRVAL_P(dispo_file), Z_STRLEN_P(dispo_file), (zend_bool) Z_LVAL_P(dispo_inline)); } } @@ -438,7 +489,8 @@ PHP_METHOD(HTTPi_Response, send) { case SEND_DATA: { - RETURN_SUCCESS(http_send_data(GET_PROP(obj, data))); + zval *zdata = GET_PROP(obj, data); + RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata))); } case SEND_RSRC: @@ -451,7 +503,8 @@ PHP_METHOD(HTTPi_Response, send) default: { - RETURN_SUCCESS(http_send_file(GET_PROP(obj, file))); + zval *zfile = GET_PROP(obj, file); + RETURN_SUCCESS(http_send_file(Z_STRVAL_P(zfile))); } } } @@ -460,18 +513,19 @@ PHP_METHOD(HTTPi_Response, send) /* }}} */ #ifdef HTTP_HAVE_CURL -/* {{{ HTTPi_Request */ +/* {{{ HttpRequest */ -/* {{{ proto void HTTPi_Request::__construct([string url[, long request_method = HTTP_GET]]) +/* {{{ proto void HttpRequest::__construct([string url[, long request_method = HTTP_GET]]) * + * Instantiate a new HttpRequest object which can be used to issue HEAD, GET + * and POST (including posting files) HTTP requests. */ -PHP_METHOD(HTTPi_Request, __construct) +PHP_METHOD(HttpRequest, __construct) { char *URL = NULL; int URL_len; long meth = -1; - zval *info, *opts, *resp; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sl", &URL, &URL_len, &meth)) { return; @@ -492,12 +546,13 @@ PHP_METHOD(HTTPi_Request, __construct) } /* }}} */ -/* {{{ proto void HTTPi_Request::__destruct() +/* {{{ proto void HttpRequest::__destruct() * + * Destroys the HttpRequest object. */ -PHP_METHOD(HTTPi_Request, __destruct) +PHP_METHOD(HttpRequest, __destruct) { - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -509,13 +564,16 @@ PHP_METHOD(HTTPi_Request, __destruct) } /* }}} */ -/* {{{ proto bool HTTPi_Request::setOptions(array options) +/* {{{ proto bool HttpRequest::setOptions(array options) * + * Set the request options to use. See http_get() for a full list of available options. */ -PHP_METHOD(HTTPi_Request, setOptions) +PHP_METHOD(HttpRequest, setOptions) { + char *key = NULL; + long idx = 0; zval *opts, *old_opts, **opt; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &opts)) { RETURN_FALSE; @@ -523,13 +581,9 @@ PHP_METHOD(HTTPi_Request, setOptions) old_opts = GET_PROP(obj, options); - /* headers and cookies need extra attention -- thus cannot use zend_hash_merge() or php_array_merge() directly */ - for ( zend_hash_internal_pointer_reset(Z_ARRVAL_P(opts)); - zend_hash_get_current_data(Z_ARRVAL_P(opts), (void **) &opt) == SUCCESS; - zend_hash_move_forward(Z_ARRVAL_P(opts))) { - char *key; - long idx; - if (HASH_KEY_IS_STRING == zend_hash_get_current_key(Z_ARRVAL_P(opts), &key, &idx, 0)) { + /* headers and cookies need extra attention -- thus cannot use array_merge() directly */ + FOREACH_KEYVAL(opts, key, idx, opt) { + if (key) { if (!strcmp(key, "headers")) { zval **headers; if (SUCCESS == zend_hash_find(Z_ARRVAL_P(old_opts), "headers", sizeof("headers"), (void **) &headers)) { @@ -545,19 +599,24 @@ PHP_METHOD(HTTPi_Request, setOptions) } zval_add_ref(opt); add_assoc_zval(old_opts, key, *opt); + + /* reset */ + key = NULL; } } + RETURN_TRUE; } /* }}} */ -/* {{{ proto array HTTPi_Request::getOptions() +/* {{{ proto array HttpRequest::getOptions() * + * Get current set options. */ -PHP_METHOD(HTTPi_Request, getOptions) +PHP_METHOD(HttpRequest, getOptions) { zval *opts; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -567,14 +626,82 @@ PHP_METHOD(HTTPi_Request, getOptions) } /* }}} */ -/* {{{ proto bool HTTPi_Request::setURL(string url) +/* {{{ proto void HttpRequest::unsetOptions() + * + * Unset all options/headers/cookies. + */ +PHP_METHOD(HttpRequest, unsetOptions) +{ + getObject(http_request_object, obj); + + NO_ARGS; + + FREE_PARR(obj, options); + INIT_PARR(obj, options); +} +/* }}} */ + +/* {{{ proto bool HttpRequest::addHeader(array header) + * + * Add (a) request header name/value pair(s). + */ +PHP_METHOD(HttpRequest, addHeader) +{ + zval *opts, **headers, *new_headers; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &new_headers)) { + RETURN_FALSE; + } + + opts = GET_PROP(obj, options); + + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "headers", sizeof("headers"), (void **) &headers)) { + array_merge(new_headers, *headers); + } else { + zval_add_ref(&new_headers); + add_assoc_zval(opts, "headers", new_headers); + } + + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto bool HttpRequest::addCookie(array cookie) * + * Add (a) cookie(s). */ -PHP_METHOD(HTTPi_Request, setURL) +PHP_METHOD(HttpRequest, addCookie) +{ + zval *opts, **cookies, *new_cookies; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &new_cookies)) { + RETURN_FALSE; + } + + opts = GET_PROP(obj, options); + + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "cookies", sizeof("cookies"), (void **) &cookies)) { + array_merge(new_cookies, *cookies); + } else { + zval_add_ref(&new_cookies); + add_assoc_zval(opts, "cookies", new_cookies); + } + + RETURN_TRUE; +} +/* }}} */ + +/* {{{ proto bool HttpRequest::setURL(string url) + * + * Set the request URL. + */ +PHP_METHOD(HttpRequest, setURL) { char *URL = NULL; int URL_len; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URL, &URL_len)) { RETURN_FALSE; @@ -585,13 +712,14 @@ PHP_METHOD(HTTPi_Request, setURL) } /* }}} */ -/* {{{ proto string HTTPi_Request::getUrl() +/* {{{ proto string HttpRequest::getUrl() * + * Get the previously set request URL. */ -PHP_METHOD(HTTPi_Request, getURL) +PHP_METHOD(HttpRequest, getURL) { zval *URL; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -600,13 +728,15 @@ PHP_METHOD(HTTPi_Request, getURL) } /* }}} */ -/* {{{ proto bool HTTPi_Request::setMethod(long request_method) +/* {{{ proto bool HttpRequest::setMethod(long request_method) * + * Set the request methods; one of the HTTP_HEAD, HTTP_GET or + * HTTP_POST constants. */ -PHP_METHOD(HTTPi_Request, setMethod) +PHP_METHOD(HttpRequest, setMethod) { long meth; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &meth)) { RETURN_FALSE; @@ -617,13 +747,14 @@ PHP_METHOD(HTTPi_Request, setMethod) } /* }}} */ -/* {{{ proto long HTTPi_Request::getMethod() +/* {{{ proto long HttpRequest::getMethod() * + * Get the previously set request method. */ -PHP_METHOD(HTTPi_Request, getMethod) +PHP_METHOD(HttpRequest, getMethod) { zval *meth; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -632,14 +763,16 @@ PHP_METHOD(HTTPi_Request, getMethod) } /* }}} */ -/* {{{ proto bool HTTPi_Request::setContentType(string content_type) +/* {{{ proto bool HttpRequest::setContentType(string content_type) * + * Set the content type the post request should have. + * Use this only if you know what you're doing. */ -PHP_METHOD(HTTPi_Request, setContentType) +PHP_METHOD(HttpRequest, setContentType) { char *ctype; int ct_len; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ct_len)) { RETURN_FALSE; @@ -657,13 +790,14 @@ PHP_METHOD(HTTPi_Request, setContentType) } /* }}} */ -/* {{{ proto string HTTPi_Request::getContentType() +/* {{{ proto string HttpRequest::getContentType() * + * Get the previously content type. */ -PHP_METHOD(HTTPi_Request, getContentType) +PHP_METHOD(HttpRequest, getContentType) { zval *ctype; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -672,33 +806,28 @@ PHP_METHOD(HTTPi_Request, getContentType) } /* }}} */ -/* {{{ proto bool HTTPi_Request::setQueryData(mixed query_data) +/* {{{ proto bool HttpRequest::setQueryData(mixed query_data) * + * Set the URL query parameters to use. + * Overwrites previously set query parameters. + * Affects any request types. */ -PHP_METHOD(HTTPi_Request, setQueryData) +PHP_METHOD(HttpRequest, setQueryData) { zval *qdata; - getObject(httpi_request_object, obj); + char *query_data = NULL; + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &qdata)) { RETURN_FALSE; } if ((Z_TYPE_P(qdata) == IS_ARRAY) || (Z_TYPE_P(qdata) == IS_OBJECT)) { - smart_str qstr = {0}; - HTTP_URL_ARGSEP_OVERRIDE; - if (SUCCESS != php_url_encode_hash_ex(HASH_OF(qdata), &qstr, NULL, 0, NULL, 0, NULL, 0, NULL TSRMLS_CC)) { - php_error_docref(NULL TSRMLS_CC, E_WARNING, "Couldn't encode query data"); - if (qstr.c) { - efree(qstr.c); - } - HTTP_URL_ARGSEP_RESTORE; + if (SUCCESS != http_urlencode_hash(HASH_OF(qdata), &query_data)) { RETURN_FALSE; } - HTTP_URL_ARGSEP_RESTORE; - smart_str_0(&qstr); - UPD_PROP(obj, string, queryData, qstr.c); - efree(qstr.c); + UPD_PROP(obj, string, queryData, query_data); + efree(query_data); RETURN_TRUE; } @@ -708,13 +837,14 @@ PHP_METHOD(HTTPi_Request, setQueryData) } /* }}} */ -/* {{{ proto string HTTPi_Request::getQueryData() +/* {{{ proto string HttpRequest::getQueryData() * + * Get the current query data in form of an urlencoded query string. */ -PHP_METHOD(HTTPi_Request, getQueryData) +PHP_METHOD(HttpRequest, getQueryData) { zval *qdata; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -723,50 +853,42 @@ PHP_METHOD(HTTPi_Request, getQueryData) } /* }}} */ -/* {{{ proto bool HTTPi_Request::addQueryData(array query_params) +/* {{{ proto bool HttpRequest::addQueryData(array query_params) * + * Add parameters to the query parameter list. + * Affects any request type. */ -PHP_METHOD(HTTPi_Request, addQueryData) +PHP_METHOD(HttpRequest, addQueryData) { zval *qdata, *old_qdata; - smart_str qstr = {0}; - char *separator; - getObject(httpi_request_object, obj); + char *query_data = NULL; + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &qdata)) { RETURN_FALSE; } old_qdata = GET_PROP(obj, queryData); - if (Z_STRLEN_P(old_qdata)) { - smart_str_appendl(&qstr, Z_STRVAL_P(old_qdata), Z_STRLEN_P(old_qdata)); - } - HTTP_URL_ARGSEP_OVERRIDE; - if (SUCCESS != php_url_encode_hash_ex(HASH_OF(qdata), &qstr, NULL, 0, NULL, 0, NULL, 0, NULL TSRMLS_CC)) { - php_error_docref(NULL TSRMLS_CC, E_WARNING, "Couldn't encode query data"); - if (qstr.c) { - efree(qstr.c); - } - HTTP_URL_ARGSEP_RESTORE; + if (SUCCESS != http_urlencode_hash_ex(HASH_OF(qdata), 1, Z_STRVAL_P(old_qdata), Z_STRLEN_P(old_qdata), &query_data, NULL)) { RETURN_FALSE; } - HTTP_URL_ARGSEP_RESTORE; - smart_str_0(&qstr); + UPD_PROP(obj, string, queryData, query_data); + efree(query_data); - UPD_PROP(obj, string, queryData, qstr.c); - efree(qstr.c); RETURN_TRUE; } /* }}} */ -/* {{{ proto void HTTPi_Request::unsetQueryData() +/* {{{ proto void HttpRequest::unsetQueryData() * + * Clean the query parameters. + * Affects any request type. */ -PHP_METHOD(HTTPi_Request, unsetQueryData) +PHP_METHOD(HttpRequest, unsetQueryData) { - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -774,13 +896,15 @@ PHP_METHOD(HTTPi_Request, unsetQueryData) } /* }}} */ -/* {{{ proto bool HTTPi_Request::addPostData(array post_data) +/* {{{ proto bool HttpRequest::addPostData(array post_data) * + * Adds POST data entries. + * Affects only POST requests. */ -PHP_METHOD(HTTPi_Request, addPostData) +PHP_METHOD(HttpRequest, addPostData) { zval *post, *post_data; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &post_data)) { RETURN_FALSE; @@ -793,13 +917,16 @@ PHP_METHOD(HTTPi_Request, addPostData) } /* }}} */ -/* {{{ proto bool HTTPi_Request::setPostData(array post_data) +/* {{{ proto bool HttpRequest::setPostData(array post_data) * + * Set the POST data entries. + * Overwrites previously set POST data. + * Affects only POST requests. */ -PHP_METHOD(HTTPi_Request, setPostData) +PHP_METHOD(HttpRequest, setPostData) { zval *post, *post_data; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &post_data)) { RETURN_FALSE; @@ -813,13 +940,14 @@ PHP_METHOD(HTTPi_Request, setPostData) } /* }}}*/ -/* {{{ proto array HTTPi_Request::getPostData() +/* {{{ proto array HttpRequest::getPostData() * + * Get previously set POST data. */ -PHP_METHOD(HTTPi_Request, getPostData) +PHP_METHOD(HttpRequest, getPostData) { zval *post_data; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -829,13 +957,15 @@ PHP_METHOD(HTTPi_Request, getPostData) } /* }}} */ -/* {{{ proto void HTTPi_Request::unsetPostData() +/* {{{ proto void HttpRequest::unsetPostData() * + * Clean POST data entires. + * Affects only POST requests. */ -PHP_METHOD(HTTPi_Request, unsetPostData) +PHP_METHOD(HttpRequest, unsetPostData) { zval *post_data; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -844,15 +974,17 @@ PHP_METHOD(HTTPi_Request, unsetPostData) } /* }}} */ -/* {{{ proto bool HTTPi_Request::addPostFile(string name, string file[, string content_type = "application/x-octetstream"]) +/* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"]) * + * Add a file to the POST request. + * Affects only POST requests. */ -PHP_METHOD(HTTPi_Request, addPostFile) +PHP_METHOD(HttpRequest, addPostFile) { zval *files, *entry; char *name, *file, *type = NULL; int name_len, file_len, type_len = 0; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &name, &name_len, &file, &file_len, &type, &type_len)) { RETURN_FALSE; @@ -882,13 +1014,14 @@ PHP_METHOD(HTTPi_Request, addPostFile) } /* }}} */ -/* {{{ proto array HTTPi_Request::getPostFiles() +/* {{{ proto array HttpRequest::getPostFiles() * + * Get all previously added POST files. */ -PHP_METHOD(HTTPi_Request, getPostFiles) +PHP_METHOD(HttpRequest, getPostFiles) { zval *files; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -899,13 +1032,15 @@ PHP_METHOD(HTTPi_Request, getPostFiles) } /* }}} */ -/* {{{ proto void HTTPi_Request::unsetPostFiles() +/* {{{ proto void HttpRequest::unsetPostFiles() * + * Unset the POST files list. + * Affects only POST requests. */ -PHP_METHOD(HTTPi_Request, unsetPostFiles) +PHP_METHOD(HttpRequest, unsetPostFiles) { zval *files; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -914,13 +1049,14 @@ PHP_METHOD(HTTPi_Request, unsetPostFiles) } /* }}} */ -/* {{{ proto array HTTPi_Request::getResponseData() +/* {{{ proto array HttpRequest::getResponseData() * + * Get all response data after the request has been sent. */ -PHP_METHOD(HTTPi_Request, getResponseData) +PHP_METHOD(HttpRequest, getResponseData) { zval *data; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -930,31 +1066,44 @@ PHP_METHOD(HTTPi_Request, getResponseData) } /* }}} */ -/* {{{ proto array HTTPi_Request::getResponseHeaders() +/* {{{ proto string HttpRequest::getResponseHeader([string name]) * + * Get response header(s) after the request has been sent. */ -PHP_METHOD(HTTPi_Request, getResponseHeaders) +PHP_METHOD(HttpRequest, getResponseHeader) { - zval *data, **headers; - getObject(httpi_request_object, obj); + zval *data, **headers, **header; + char *header_name = NULL; + int header_len = 0; + getObject(http_response_object, obj); - NO_ARGS; + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &header_name, &header_len)) { + RETURN_FALSE; + } - array_init(return_value); data = GET_PROP(obj, responseData); - if (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void **) &headers)) { + if (SUCCESS != zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void **) &headers)) { + RETURN_FALSE; + } + + if (!header_len || !header_name) { + array_init(return_value); array_copy(*headers, return_value); + } else if (SUCCESS == zend_hash_find(Z_ARRVAL_PP(headers), pretty_key(header_name, header_len, 1, 1), header_len + 1, (void **) &header)) { + RETURN_STRINGL(Z_STRVAL_PP(header), Z_STRLEN_PP(header), 1); + } else { + RETURN_FALSE; } } -/* }}} */ -/* {{{ proto string HTTPi_Request::getResponseBody() +/* {{{ proto string HttpRequest::getResponseBody() * + * Get the response body after the request has been sent. */ -PHP_METHOD(HTTPi_Request, getResponseBody) +PHP_METHOD(HttpRequest, getResponseBody) { zval *data, **body; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -962,37 +1111,101 @@ PHP_METHOD(HTTPi_Request, getResponseBody) if (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "body", sizeof("body"), (void **) &body)) { RETURN_STRINGL(Z_STRVAL_PP(body), Z_STRLEN_PP(body), 1); } else { - Z_TYPE_P(return_value) = IS_NULL; + RETURN_FALSE; } } /* }}} */ -/* {{{ proto array HTTPi_Request::getResponseInfo() +/* {{{ proto int HttpRequest::getResponseCode() * + * Get the response code after the request has been sent. */ -PHP_METHOD(HTTPi_Request, getResponseInfo) +PHP_METHOD(HttpRequest, getResponseCode) { - zval *info; - getObject(httpi_request_object, obj); + zval **code, **hdrs, *data; + getObject(http_request_object, obj); NO_ARGS; + data = GET_PROP(obj, responseData); + if ( (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void **) &hdrs)) && + (SUCCESS == zend_hash_find(Z_ARRVAL_PP(hdrs), "Status", sizeof("Status"), (void **) &code))) { + RETVAL_STRINGL(Z_STRVAL_PP(code), Z_STRLEN_PP(code), 1); + convert_to_long(return_value); + } else { + RETURN_FALSE; + } +} +/* }}} */ + +/* {{{ proto array HttpRequest::getResponseInfo([string name]) + * + * Get response info after the request has been sent. + * See http_get() for a full list of returned info. + */ +PHP_METHOD(HttpRequest, getResponseInfo) +{ + zval *info, **infop; + char *info_name = NULL; + int info_len = 0; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &info_name, &info_len)) { + RETURN_FALSE; + } + info = GET_PROP(obj, responseInfo); - array_init(return_value); - array_copy(info, return_value); + + if (info_len && info_name) { + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(info), pretty_key(info_name, info_len, 0, 0), info_len + 1, (void **) &infop)) { + RETURN_ZVAL(*infop, 1, ZVAL_PTR_DTOR); + } else { + php_error_docref(NULL TSRMLS_CC, E_NOTICE, "Could not find response info named %s", info_name); + RETURN_FALSE; + } + } else { + array_init(return_value); + array_copy(info, return_value); + } } /* }}}*/ -/* {{{ proto bool HTTPi_Request::send() +/* {{{ proto bool HttpRequest::send() + * + * Send the HTTP request. + * + * GET example: + *
+ * setOptions(array('lastmodified' => filemtime('local.rss')));
+ * $r->addQueryData(array('category' => 3));
+ * if ($r->send() && $r->getResponseCode() == 200) {
+ *     file_put_contents('local.rss', $r->getResponseBody());
+ * }
+ * ?>
+ * 
* + * POST example: + *
+ * setOptions(array('cookies' => array('lang' => 'de')));
+ * $r->addPostData(array('user' => 'mike', 'pass' => 's3c|r3t'));
+ * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
+ * if ($r->send()) {
+ *     echo $r->getResponseBody();
+ * }
+ * ?>
+ * 
*/ -PHP_METHOD(HTTPi_Request, send) +PHP_METHOD(HttpRequest, send) { STATUS status = FAILURE; zval *meth, *URL, *qdata, *opts, *info, *resp; char *response_data, *request_uri; size_t response_len; - getObject(httpi_request_object, obj); + getObject(http_request_object, obj); NO_ARGS; @@ -1008,8 +1221,8 @@ PHP_METHOD(HTTPi_Request, send) info = GET_PROP(obj, responseInfo); resp = GET_PROP(obj, responseData); - // HTTP_URI_MAXLEN+1 big char * - request_uri = http_absolute_uri(Z_STRVAL_P(URL), NULL); + // HTTP_URI_MAXLEN+1 long char * + request_uri = http_absolute_uri_ex(Z_STRVAL_P(URL), Z_STRLEN_P(URL), NULL, 0, NULL, 0, 0); if (Z_STRLEN_P(qdata) && (strlen(request_uri) < HTTP_URI_MAXLEN)) { if (!strchr(request_uri, '?')) { @@ -1032,7 +1245,7 @@ PHP_METHOD(HTTPi_Request, send) case HTTP_POST: { - zval *post_files, *post_data, **data; + zval *post_files, *post_data; post_files = GET_PROP(obj, postFiles); post_data = GET_PROP(obj, postData); @@ -1047,17 +1260,14 @@ PHP_METHOD(HTTPi_Request, send) /* * multipart post */ + char *key = NULL; + long idx; + zval **data; struct curl_httppost *http_post_data[2] = {NULL, NULL}; /* normal data */ - for ( zend_hash_internal_pointer_reset(Z_ARRVAL_P(post_data)); - zend_hash_get_current_data(Z_ARRVAL_P(post_data), (void **) &data) == SUCCESS; - zend_hash_move_forward(Z_ARRVAL_P(post_data))) { - - char *key; - long idx; - - if (HASH_KEY_IS_STRING == zend_hash_get_current_key(Z_ARRVAL_P(post_data), &key, &idx, 0)) { + FOREACH_KEYVAL(post_data, key, idx, data) { + if (key) { convert_to_string_ex(data); curl_formadd(&http_post_data[0], &http_post_data[1], CURLFORM_COPYNAME, key, @@ -1065,25 +1275,22 @@ PHP_METHOD(HTTPi_Request, send) CURLFORM_CONTENTSLENGTH, Z_STRLEN_PP(data), CURLFORM_END ); + + /* reset */ + key = NULL; } } /* file data */ - for ( zend_hash_internal_pointer_reset(Z_ARRVAL_P(post_files)); - zend_hash_get_current_data(Z_ARRVAL_P(post_files), (void **) &data) == SUCCESS; - zend_hash_move_forward(Z_ARRVAL_P(post_files))) { - + FOREACH_VAL(post_files, data) { zval **file, **type, **name; - if ( - SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "name", sizeof("name"), (void **) &name) && - SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "type", sizeof("type"), (void **) &type) && - SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "file", sizeof("file"), (void **) &file) - ) { + if ( SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "name", sizeof("name"), (void **) &name) && + SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "type", sizeof("type"), (void **) &type) && + SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "file", sizeof("file"), (void **) &file)) { curl_formadd(&http_post_data[0], &http_post_data[1], CURLFORM_COPYNAME, Z_STRVAL_PP(name), - CURLFORM_FILENAME, Z_STRVAL_PP(name), CURLFORM_FILE, Z_STRVAL_PP(file), CURLFORM_CONTENTTYPE, Z_STRVAL_PP(type), CURLFORM_END @@ -1107,22 +1314,22 @@ PHP_METHOD(HTTPi_Request, send) if (status != SUCCESS) { RETURN_FALSE; } else { - zval *zheaders, *zbody; + char *body = NULL; + size_t body_len = 0; + zval *zheaders; - MAKE_STD_ZVAL(zbody); MAKE_STD_ZVAL(zheaders) array_init(zheaders); - if (SUCCESS != http_split_response_ex(response_data, response_len, zheaders, zbody)) { + if (SUCCESS != http_split_response_ex(response_data, response_len, Z_ARRVAL_P(zheaders), &body, &body_len)) { zval_dtor(zheaders); efree(zheaders), - efree(zbody); efree(response_data); RETURN_FALSE; } add_assoc_zval(resp, "headers", zheaders); - add_assoc_zval(resp, "body", zbody); + add_assoc_stringl(resp, "body", body, body_len, 0); efree(response_data); @@ -1143,4 +1350,5 @@ PHP_METHOD(HTTPi_Request, send) * End: * vim600: noet sw=4 ts=4 fdm=marker * vim<600: noet sw=4 ts=4 - */ \ No newline at end of file + */ +