From: Michael Wallner Date: Fri, 6 May 2005 17:39:52 +0000 (+0000) Subject: I, moron X-Git-Tag: RELEASE_0_8_0~26 X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=commitdiff_plain;h=2214902cf967c3aaf8e8493295f1ac43831ed015;ds=sidebyside I, moron --- diff --git a/http_functions.c b/http_functions.c index 5dc49b5..5369195 100644 --- a/http_functions.c +++ b/http_functions.c @@ -1,1007 +1,2014 @@ /* + +----------------------------------------------------------------------+ + | 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 | + +----------------------------------------------------------------------+ + */ + + /* $Id$ */ + + #ifdef HAVE_CONFIG_H + # include "config.h" + #endif + + #include "php.h" + #include "php_ini.h" + #include "ext/standard/info.h" + #include "ext/session/php_session.h" + #include "ext/standard/php_string.h" + + #include "SAPI.h" + + #include "phpstr/phpstr.h" + + #include "php_http.h" + #include "php_http_std_defs.h" + #include "php_http_api.h" + #include "php_http_auth_api.h" + #include "php_http_request_api.h" + #include "php_http_cache_api.h" + #include "php_http_request_api.h" + #include "php_http_date_api.h" + #include "php_http_headers_api.h" + #include "php_http_message_api.h" + #include "php_http_send_api.h" + #include "php_http_url_api.h" + + ZEND_EXTERN_MODULE_GLOBALS(http) + + /* {{{ proto string http_date([int timestamp]) + * + * This function returns a valid HTTP date regarding RFC 822/1123 + * looking like: "Wed, 22 Dec 2004 11:34:47 GMT" + * + */ + PHP_FUNCTION(http_date) + { + long t = -1; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) { + RETURN_FALSE; + } + + if (t == -1) { + t = (long) time(NULL); + } + + RETURN_STRING(http_date(t), 0); + } + /* }}} */ + + /* {{{ proto string http_absolute_uri(string url[, string proto[, string host[, int port]]]) + * + * This function returns an absolute URI constructed from url. + * 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: + *
+
  *  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_FUNCTION(http_absolute_uri) + { + char *url = NULL, *proto = NULL, *host = NULL; + int url_len = 0, proto_len = 0, host_len = 0; + long port = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ssl", &url, &url_len, &proto, &proto_len, &host, &host_len, &port) != SUCCESS) { + RETURN_FALSE; + } + + RETURN_STRING(http_absolute_uri_ex(url, url_len, proto, proto_len, host, host_len, port), 0); + } + /* }}} */ + + /* {{{ proto string http_negotiate_language(array supported[, string default = 'en-US']) + * + * This function negotiates the clients preferred language based on its + * Accept-Language HTTP header. It returns the negotiated language or + * the default language 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. + * + * Example: + *
+
  * 
+
  * 
+ * + */ + PHP_FUNCTION(http_negotiate_language) + { + zval *supported; + char *def = NULL; + int def_len = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) { + RETURN_FALSE; + } + + if (!def) { + def = "en-US"; + } + + RETURN_STRING(http_negotiate_language(supported, def), 0); + } + /* }}} */ + + /* {{{ proto string http_negotiate_charset(array supported[, string default = 'iso-8859-1']) + * + * This function negotiates the clients preferred charset based on its + * Accept-Charset HTTP header. It returns the negotiated charset or + * the default charset 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. + * + * Example: + *
+
  * 
+
  * 
+ */ + PHP_FUNCTION(http_negotiate_charset) + { + zval *supported; + char *def = NULL; + int def_len = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) { + RETURN_FALSE; + } + + if (!def) { + def = "iso-8859-1"; + } + + RETURN_STRING(http_negotiate_charset(supported, def), 0); + } + /* }}} */ + + /* {{{ proto bool http_send_status(int status) + * + * Send HTTP status code. + * + */ + PHP_FUNCTION(http_send_status) + { + int status = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &status) != SUCCESS) { + RETURN_FALSE; + } + if (status < 100 || status > 510) { + http_error_ex(E_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status); + RETURN_FALSE; + } + + RETURN_SUCCESS(http_send_status(status)); + } + /* }}} */ + + /* {{{ proto bool http_send_last_modified([int timestamp]) + * + * This converts the given timestamp to a valid HTTP date and + * sends it as "Last-Modified" HTTP header. If timestamp is + * omitted, current time is sent. + * + */ + PHP_FUNCTION(http_send_last_modified) + { + long t = -1; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) { + RETURN_FALSE; + } + + if (t == -1) { + t = (long) time(NULL); + } + + RETURN_SUCCESS(http_send_last_modified(t)); + } + /* }}} */ + + /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream']) + * + * Sets the content type. + * + */ + PHP_FUNCTION(http_send_content_type) + { + char *ct; + int ct_len = 0; + + 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]) + + +/* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false]) + * + * Set 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). + * + */ + PHP_FUNCTION(http_send_content_disposition) + { + char *filename; + int f_len; + zend_bool send_inline = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &filename, &f_len, &send_inline) != SUCCESS) { + RETURN_FALSE; + } + RETURN_SUCCESS(http_send_content_disposition(filename, f_len, send_inline)); + } + /* }}} */ + + /* {{{ proto bool http_match_modified([int timestamp[, for_range = false]]) + * + * Matches the given timestamp against the clients "If-Modified-Since" resp. + * "If-Unmodified-Since" HTTP headers. + * + */ + PHP_FUNCTION(http_match_modified) + { + long t = -1; + zend_bool for_range = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|lb", &t, &for_range) != SUCCESS) { + RETURN_FALSE; + } + + // current time if not supplied (senseless though) + if (t == -1) { + t = (long) time(NULL); + } + + if (for_range) { + RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t)); + } + RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t)); + } + /* }}} */ + + /* {{{ proto bool http_match_etag(string etag[, for_range = false]) + * + * This matches the given ETag against the clients + * "If-Match" resp. "If-None-Match" HTTP headers. + * + */ + PHP_FUNCTION(http_match_etag) + { + int etag_len; + char *etag; + zend_bool for_range = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &etag, &etag_len, &for_range) != SUCCESS) { + RETURN_FALSE; + } + + if (for_range) { + RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag)); + } + RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag)); + } + /* }}} */ + + /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]]) + * + * 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, + * it is handled as expiration time in seconds, which means that if the + * requested last modification date is not between the calculated timespan, + * the Last-Modified header is updated and the actual body will be sent. + * + */ + PHP_FUNCTION(http_cache_last_modified) + { + long last_modified = 0, send_modified = 0, t; + zval *zlm; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) { + 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")) { + last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm)); + /* send current time */ + } else { + send_modified = t; + } + /* negative value is supposed to be expiration time */ + } else if (last_modified < 0) { + last_modified += t; + send_modified = t; + /* send supplied time explicitly */ + } else { + send_modified = last_modified; + } + + RETURN_SUCCESS(http_cache_last_modified(last_modified, send_modified, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL))); + } + /* }}} */ + + /* {{{ 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). + * + * If 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. + * + */ + PHP_FUNCTION(http_cache_etag) + { + char *etag = NULL; + int etag_len = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) { + 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(). + */ + PHP_FUNCTION(ob_etaghandler) + { + char *data; + int data_len; + long mode; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) { + RETURN_FALSE; + } + + Z_TYPE_P(return_value) = IS_STRING; + http_ob_etaghandler(data, data_len, &Z_STRVAL_P(return_value), &Z_STRLEN_P(return_value), mode); + } + /* }}} */ + + /* {{{ proto void http_redirect([string url[, array params[, bool session,[ bool permanent]]]]) + * + * Redirect to a given url. + * The supplied url will be expanded with http_absolute_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. + * + * To be RFC compliant, "Redirecting to URI." will be displayed, + * if the client doesn't redirect immediatly. + */ + PHP_FUNCTION(http_redirect) + { + int url_len; + size_t query_len = 0; + zend_bool session = 0, permanent = 0; + zval *params = NULL; + char *query, *url, *URI, + LOC[HTTP_URI_MAXLEN + sizeof("Location: ")], + RED[HTTP_URI_MAXLEN * 2 + sizeof("Redirecting to %s?%s.\n")]; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bb", &url, &url_len, ¶ms, &session, &permanent) != SUCCESS) { + RETURN_FALSE; + } + + /* append session info */ + if (session && (PS(session_status) == php_session_active)) { + if (!params) { + MAKE_STD_ZVAL(params); + array_init(params); + } + if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) { + http_error(E_WARNING, HTTP_E_ENCODE, "Could not append session information"); + } + } + + /* treat params array with http_build_query() */ + if (params) { + if (SUCCESS != http_urlencode_hash_ex(Z_ARRVAL_P(params), 0, NULL, 0, &query, &query_len)) { + RETURN_FALSE; + } + } + + URI = http_absolute_uri(url); + + if (query_len) { + snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s?%s", URI, query); + sprintf(RED, "Redirecting to %s?%s.\n", URI, query, URI, query); + efree(query); + } else { + snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s", URI); + sprintf(RED, "Redirecting to %s.\n", URI, URI); + } + efree(URI); + + if ((SUCCESS == http_send_header(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) { + php_body_write(RED, strlen(RED) TSRMLS_CC); + RETURN_TRUE; + } + RETURN_FALSE; + } + /* }}} */ + + /* {{{ proto bool http_send_data(string data) + * + * Sends raw data with support for (multiple) range requests. + * + */ + PHP_FUNCTION(http_send_data) + { + zval *zdata; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) { + RETURN_FALSE; + } + + convert_to_string_ex(&zdata); + RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata))); + } + /* }}} */ + + /* {{{ proto bool http_send_file(string file) + * + * Sends a file with support for (multiple) range requests. + * + */ + PHP_FUNCTION(http_send_file) + { + char *file; + int flen = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file, &flen) != SUCCESS) { + RETURN_FALSE; + } + if (!flen) { + RETURN_FALSE; + } + + RETURN_SUCCESS(http_send_file(file)); + } + /* }}} */ + + /* {{{ proto bool http_send_stream(resource stream) + * + * Sends an already opened stream with support for (multiple) range requests. + * + */ + PHP_FUNCTION(http_send_stream) + { + zval *zstream; + php_stream *file; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) { + RETURN_FALSE; + } + + php_stream_from_zval(file, &zstream); + RETURN_SUCCESS(http_send_stream(file)); + } + /* }}} */ + + /* {{{ proto string http_chunked_decode(string encoded) + * + * This function decodes a string that was HTTP-chunked encoded. + * Returns false on failure. + */ + PHP_FUNCTION(http_chunked_decode) + { + char *encoded = NULL, *decoded = NULL; + int encoded_len = 0, decoded_len = 0; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) { + RETURN_FALSE; + } + + if (NULL != http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) { + RETURN_STRINGL(decoded, decoded_len, 0); + } else { + RETURN_FALSE; + } + } + /* }}} */ + + /* {{{ proto array http_split_response(string http_response) + * + * This function splits an HTTP response into an array with headers and the + * content body. The returned array may look simliar to the following example: + * + *
+
  *  array(
+
  *         'Response Status' => '200 Ok',
+
  *         'Content-Type' => 'text/plain',
+
  *         'Content-Language' => 'en-US'
+
  *     ),
+
  *     1 => "Hello World!"
+
  * );
+
  * ?>
+
  * 
+ */ + PHP_FUNCTION(http_split_response) + { + zval *zresponse, *zbody, *zheaders; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zresponse) != SUCCESS) { + RETURN_FALSE; + } + + convert_to_string(zresponse); + + MAKE_STD_ZVAL(zbody); + MAKE_STD_ZVAL(zheaders); + array_init(zheaders); + + if (SUCCESS != http_split_response(zresponse, zheaders, zbody)) { + http_error(E_WARNING, HTTP_E_PARSE, "Could not parse HTTP response"); + RETURN_FALSE; + } + + array_init(return_value); + add_index_zval(return_value, 0, zheaders); + add_index_zval(return_value, 1, zbody); + } + /* }}} */ + + /* {{{ proto array http_parse_headers(string header) + * + */ + PHP_FUNCTION(http_parse_headers) + { + char *header; + int header_len; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) { + RETURN_FALSE; + } + + array_init(return_value); + if (SUCCESS != http_parse_headers(header, return_value)) { + http_error(E_WARNING, HTTP_E_PARSE, "Could not parse HTTP headers"); + zval_dtor(return_value); + RETURN_FALSE; + } + } + /* }}}*/ + + /* {{{ proto array http_get_request_headers(void) + * + */ + PHP_FUNCTION(http_get_request_headers) + { + NO_ARGS; + + array_init(return_value); + http_get_request_headers(return_value); + } + /* }}} */ + + /* {{{ HAVE_CURL */ + #ifdef HTTP_HAVE_CURL + + /* {{{ 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 + * array where the following keys will be recognized: + *
+
  *  - redirect:         int, whether and how many redirects to follow
+
  *  - unrestrictedauth: bool, whether to continue sending credentials on
+
  *                      redirects to a different host
+
  *  - proxyhost:        string, proxy host in "host[:port]" format
+
  *  - proxyport:        int, use another proxy port as specified in proxyhost
+
  *  - proxyauth:        string, proxy credentials in "user:pass" format
+
  *  - proxyauthtype:    int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
+
  *  - httpauth:         string, http credentials in "user:pass" format
+
  *  - httpauthtype:     int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
+
  *  - compress:         bool, whether to allow gzip/deflate content encoding
+
  *                      (defaults to true)
+
  *  - port:             int, use another port as specified in the url
+
  *  - referer:          string, the referer to sends
+
  *  - useragent:        string, the user agent to send
+
  *                      (defaults to PECL::HTTP/version (PHP/version)))
+
  *  - headers:          array, list of custom headers as associative array
+
  *                      like array("header" => "value")
+
  *  - cookies:          array, list of cookies as associative array
+
  *                      like array("cookie" => "value")
+
  *  - cookiestore:      string, path to a file where cookies are/will be stored
+
  *  - resume:           int, byte offset to start the download from;
+
  *                      if the server supports ranges
+
  *  - maxfilesize:      int, maximum file size that should be downloaded;
+
  *                      has no effect, if the size of the requested entity is not known
+
  *  - lastmodified:     int, timestamp for If-(Un)Modified-Since header
+
  *  - timeout:          int, seconds the request may take
+
  *  - connecttimeout:   int, seconds the connect may take
+
  *  - onprogress:       mixed, progress callback
+
  *  - ondebug:          mixed, debug callback
+
  * 
+ * + * The optional third parameter will be filled with some additional information + * in form af an associative array, if supplied, like the following example: + *
+
  *  'http://localhost',
+
  *     'response_code' => 403,
+
  *     'total_time' => 0.017,
+
  *     'namelookup_time' => 0.013,
+
  *     'connect_time' => 0.014,
+
  *     'pretransfer_time' => 0.014,
+
  *     'size_upload' => 0,
+
  *     'size_download' => 202,
+
  *     'speed_download' => 11882,
+
  *     'speed_upload' => 0,
+
  *     'header_size' => 145,
+
  *     'request_size' => 62,
+
  *     'ssl_verifyresult' => 0,
+
  *     'filetime' => -1,
+
  *     'content_length_download' => 202,
+
  *     'content_length_upload' => 0,
+
  *     'starttransfer_time' => 0.017,
+
  *     'content_type' => 'text/html; charset=iso-8859-1',
+
  *     'redirect_time' => 0,
+
  *     'redirect_count' => 0,
+
  *     'private' => '',
+
  *     'http_connectcode' => 0,
+
  *     'httpauth_avail' => 0,
+
  *     'proxyauth_avail' => 0,
+
  * )
+
  * ?>
+
  * 
+ */ + PHP_FUNCTION(http_get) + { + zval *options = NULL, *info = NULL; + char *URL; + int URL_len; + phpstr response; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) { + RETURN_FALSE; + } + + if (info) { + zval_dtor(info); + array_init(info); + } + + 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; + } + } + /* }}} */ + + /* {{{ 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. + */ + PHP_FUNCTION(http_head) + { + zval *options = NULL, *info = NULL; + char *URL; + int URL_len; + phpstr response; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) { + RETURN_FALSE; + } + + if (info) { + zval_dtor(info); + array_init(info); + } + + 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; + } + } + /* }}} */ + + /* {{{ proto string http_post_data(string url, string data[, array options[, &info]]) + * + * Performs an HTTP POST request, posting data. + * Returns the HTTP response as string. + * See http_get() for a full list of available options. + */ + PHP_FUNCTION(http_post_data) + { + zval *options = NULL, *info = NULL; + char *URL, *postdata; + int postdata_len, URL_len; + phpstr response; + http_request_body body; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) { + RETURN_FALSE; + } + + if (info) { + zval_dtor(info); + array_init(info); + } + + body.type = HTTP_REQUEST_BODY_CSTRING; + body.data = postdata; + body.size = postdata_len; + + 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); + } + /* }}} */ + + /* {{{ 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. + */ + PHP_FUNCTION(http_post_fields) + { + zval *options = NULL, *info = NULL, *fields, *files = NULL; + char *URL; + int URL_len; + phpstr response; + http_request_body body; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|aa/!z", &URL, &URL_len, &fields, &files, &options, &info) != SUCCESS) { + RETURN_FALSE; + } + + if (SUCCESS != http_request_body_fill(&body, Z_ARRVAL_P(fields), files ? Z_ARRVAL_P(files) : NULL)) { + RETURN_FALSE; + } + + if (info) { + zval_dtor(info); + array_init(info); + } + + 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); + } + /* }}} */ + + #endif + /* }}} HAVE_CURL */ + + + /* {{{ proto bool http_auth_basic(string user, string pass[, string realm = "Restricted"]) + * + * Example: + *
+
  * Authorization failed!');
+
  * }
+
  * ?>
+
  * 
+ */ + PHP_FUNCTION(http_auth_basic) + { + char *realm = NULL, *user, *pass, *suser, *spass; + int r_len, u_len, p_len; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &user, &u_len, &pass, &p_len, &realm, &r_len) != SUCCESS) { + RETURN_FALSE; + } + + if (!realm) { + realm = "Restricted"; + } + + if (SUCCESS != http_auth_credentials(&suser, &spass)) { + http_auth_header("Basic", realm); + RETURN_FALSE; + } + + if (strcasecmp(suser, user)) { + http_auth_header("Basic", realm); + RETURN_FALSE; + } + + if (strcmp(spass, pass)) { + http_auth_header("Basic", realm); + RETURN_FALSE; + } + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto bool http_auth_basic_cb(mixed callback[, string realm = "Restricted"]) + * + * Example: + *
+
  * quoteSmart($user);
+
  *     if (strlen($realpass = $db->getOne($query)) {
+
  *         return $pass === $realpass;
+
  *     }
+
  *     return false;
+
  * }
+
  * if (!http_auth_basic_cb('auth_cb')) {
+
  *     die('

Authorization failed

'); + * } + * ?> + *
+ */ + PHP_FUNCTION(http_auth_basic_cb) + { + zval *cb; + char *realm = NULL, *user, *pass; + int r_len; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|s", &cb, &realm, &r_len) != SUCCESS) { + RETURN_FALSE; + } + + if (!realm) { + realm = "Restricted"; + } + + if (SUCCESS != http_auth_credentials(&user, &pass)) { + http_auth_header("Basic", realm); + RETURN_FALSE; + } + { + zval *zparams[2] = {NULL, NULL}, retval; + int result = 0; + + MAKE_STD_ZVAL(zparams[0]); + MAKE_STD_ZVAL(zparams[1]); + ZVAL_STRING(zparams[0], user, 0); + ZVAL_STRING(zparams[1], pass, 0); + + if (SUCCESS == call_user_function(EG(function_table), NULL, cb, + &retval, 2, zparams TSRMLS_CC)) { + result = Z_LVAL(retval); + } + + efree(user); + efree(pass); + efree(zparams[0]); + efree(zparams[1]); + + if (!result) { + http_auth_header("Basic", realm); + } + + RETURN_BOOL(result); + } + } + /* }}}*/ + + /* {{{ Sara Golemons http_build_query() */ + #ifndef ZEND_ENGINE_2 + + /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]]) + Generates a form-encoded query string from an associative array or object. */ + PHP_FUNCTION(http_build_query) + { + zval *formdata; + char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output"); + int prefix_len = 0, arg_sep_len = strlen(arg_sep); + phpstr *formstr; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "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(E_WARNING, HTTP_E_PARAM, "Parameter 1 expected to be Array or Object. Incorrect value given."); + RETURN_FALSE; + } + + if (!arg_sep_len) { + arg_sep = 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))) { + phpstr_free(formstr); + RETURN_FALSE; + } + + if (!formstr->used) { + phpstr_free(formstr); + RETURN_NULL(); + } + + RETURN_PHPSTR_PTR(formstr); + } + /* }}} */ + #endif /* !ZEND_ENGINE_2 */ + /* }}} */ + + PHP_FUNCTION(http_test) + { + RETURN_NULL(); + } + + /* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * End: + * vim600: noet sw=4 ts=4 fdm=marker + * vim<600: noet sw=4 ts=4 + */ + diff --git a/http_message_api.c b/http_message_api.c index a0f5e59..76de8a4 100644 --- a/http_message_api.c +++ b/http_message_api.c @@ -1,452 +1,904 @@ /* + +----------------------------------------------------------------------+ + | 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 | + +----------------------------------------------------------------------+ + */ + + /* $Id$ */ + + #ifdef HAVE_CONFIG_H + # include "config.h" + #endif + + #include "php.h" + #include "php_http.h" + #include "php_http_std_defs.h" + #include "php_http_api.h" + #include "php_http_message_api.h" + #include "php_http_headers_api.h" + #include "php_http_send_api.h" + #include "php_http_request_api.h" + #include "php_http_url_api.h" + + #include "phpstr/phpstr.h" + + #define http_message_headers_cb _http_message_headers_cb + static void _http_message_headers_cb(const char *http_line, HashTable **headers, void **message TSRMLS_DC) + { + size_t line_length; + char *crlf = NULL; + http_message *new, *old = (http_message *) *message; + + if (crlf = strstr(http_line, HTTP_CRLF)) { + line_length = crlf - http_line; + } else { + line_length = strlen(http_line); + } + + if (old->type || zend_hash_num_elements(&old->hdrs) || PHPSTR_LEN(old)) { + new = http_message_new(); + + new->parent = old; + *message = new; + *headers = &new->hdrs; + } else { + new = old; + } + + while (isspace(http_line[line_length-1])) --line_length; + + // response + if (!strncmp(http_line, "HTTP/1.", lenof("HTTP/1."))) { + new->type = HTTP_MSG_RESPONSE; + new->info.response.http_version = atof(http_line + lenof("HTTP/")); + new->info.response.code = atoi(http_line + lenof("HTTP/1.1 ")); + } else + // request + if (!strncmp(http_line + line_length - lenof("HTTP/1.1"), "HTTP/1.", lenof("HTTP/1."))) { + const char *method_sep_uri = strchr(http_line, ' '); + new->type = HTTP_MSG_REQUEST; + new->info.request.http_version = atof(http_line + line_length - lenof("1.1")); + new->info.request.method = estrndup(http_line, method_sep_uri - http_line); + new->info.request.URI = estrndup(method_sep_uri + 1, http_line + line_length - method_sep_uri - 1 - lenof(" HTTP/1.1")); + } + } + + #define http_message_init_type _http_message_init_type + static inline void _http_message_init_type(http_message *message, http_message_type type) + { + switch (message->type = type) + { + case HTTP_MSG_RESPONSE: + message->info.response.http_version = .0; + message->info.response.code = 0; + break; + + case HTTP_MSG_REQUEST: + message->info.request.http_version = .0; + message->info.request.method = NULL; + message->info.request.URI = NULL; + break; + + case HTTP_MSG_NONE: + default: + break; + } + } + + #define http_message_header(m, h) _http_message_header_ex((m), (h), sizeof(h)) + #define http_message_header_ex _http_message_header_ex + static inline zval *_http_message_header_ex(http_message *msg, char *key_str, size_t key_len) + { + zval **header; + if (SUCCESS == zend_hash_find(&msg->hdrs, key_str, key_len, (void **) &header)) { + return *header; + } + return NULL; + } + + PHP_HTTP_API http_message *_http_message_init_ex(http_message *message, http_message_type type) + { + if (!message) { + message = ecalloc(1, sizeof(http_message)); + } + + http_message_init_type(message, type); + message->parent = NULL; + phpstr_init(&message->body); + zend_hash_init(&message->hdrs, 0, NULL, ZVAL_PTR_DTOR, 0); + + return message; + } + + + PHP_HTTP_API void _http_message_set_type(http_message *message, http_message_type type) + { + /* just act if different */ + if (type != message->type) { + + /* free request info */ + if (message->type == HTTP_MSG_REQUEST) { + if (message->info.request.method) { + efree(message->info.request.method); + } + if (message->info.request.URI) { + efree(message->info.request.URI); + } + } + + /* init */ + http_message_init_type(message, type); + } + } + + PHP_HTTP_API http_message *_http_message_parse_ex(http_message *msg, const char *message, size_t message_length TSRMLS_DC) + { + char *body = NULL; + zend_bool free_msg = msg ? 0 : 1; + + if (message_length < HTTP_MSG_MIN_SIZE) { + return NULL; + } + + if (!message) { + return NULL; + } + + msg = http_message_init(msg); + + if (SUCCESS != http_parse_headers_cb(message, &msg->hdrs, 1, http_message_headers_cb, (void **) &msg)) { + if (free_msg) { + http_message_free(msg); + } + return NULL; + } + + /* header parsing stops at CRLF CRLF */ + if (body = strstr(message, HTTP_CRLF HTTP_CRLF)) { + zval *c; + const char *continue_at = NULL; + + body += lenof(HTTP_CRLF HTTP_CRLF); + + /* message has content-length header */ + if (c = http_message_header(msg, "Content-Length")) { + long len = atol(Z_STRVAL_P(c)); + phpstr_from_string_ex(PHPSTR(msg), body, len); + continue_at = body + len; + } else + + /* message has chunked transfer encoding */ + if (c = http_message_header(msg, "Transfer-Encoding")) { + if (!strcasecmp("chunked", Z_STRVAL_P(c))) { + char *decoded; + size_t decoded_len; + + /* decode and replace Transfer-Encoding with Content-Length header */ + if (continue_at = http_chunked_decode(body, message + message_length - body, &decoded, &decoded_len)) { + phpstr_from_string_ex(PHPSTR(msg), decoded, decoded_len); + efree(decoded); + { + zval *len; + char *tmp; + + spprintf(&tmp, 0, "%lu", decoded_len); + MAKE_STD_ZVAL(len); + ZVAL_STRING(len, tmp, 0); + + zend_hash_del(&msg->hdrs, "Transfer-Encoding", sizeof("Transfer-Encoding")); + zend_hash_add(&msg->hdrs, "Content-Length", sizeof("Content-Length"), (void *) &len, sizeof(zval *), NULL); + } + } + } + } else + + /* message has content-range header */ + if (c = http_message_header(msg, "Content-Range")) { + ulong start = 0, end = 0; + + sscanf(Z_STRVAL_P(c), "bytes=%lu-%lu", &start, &end); + if (end > start) { + phpstr_from_string_ex(PHPSTR(msg), body, (size_t) (end - start)); + continue_at = body + (end - start); + } + } else + + /* no headers that indicate content length */ + if (1) { + phpstr_from_string_ex(PHPSTR(msg), body, message + message_length - body); + } + + /* check for following messages */ + if (continue_at) { + while (isspace(*continue_at)) ++continue_at; + if (continue_at < (message + message_length)) { + http_message *next = NULL, *most = NULL; + + /* set current message to parent of most parent following messages and return deepest */ + if (most = next = http_message_parse(continue_at, message + message_length - continue_at)) { + while (most->parent) most = most->parent; + most->parent = msg; + msg = next; + } + } + } + } + + return msg; + } + + PHP_HTTP_API void _http_message_tostring(http_message *msg, char **string, size_t *length) + { + phpstr str; + char *key, *data; + ulong idx; + zval **header; + + phpstr_init_ex(&str, 4096, 0); + + switch (msg->type) + { + case HTTP_MSG_REQUEST: + phpstr_appendf(&str, "%s %s HTTP/%1.1f" HTTP_CRLF, + msg->info.request.method, + msg->info.request.URI, + msg->info.request.http_version); + break; + + case HTTP_MSG_RESPONSE: + phpstr_appendf(&str, "HTTP/%1.1f %d" HTTP_CRLF, + msg->info.response.http_version, + msg->info.response.code); + break; + + case HTTP_MSG_NONE: + default: + break; + } + + FOREACH_HASH_KEYVAL(&msg->hdrs, key, idx, header) { + if (key) { + zval **single_header; + + switch (Z_TYPE_PP(header)) + { + case IS_STRING: + phpstr_appendf(&str, "%s: %s" HTTP_CRLF, key, Z_STRVAL_PP(header)); + break; + + case IS_ARRAY: + FOREACH_VAL(*header, single_header) { + phpstr_appendf(&str, "%s: %s" HTTP_CRLF, key, Z_STRVAL_PP(single_header)); + } + break; + } + + key = NULL; + } + } + + if (PHPSTR_LEN(msg)) { + phpstr_appends(&str, HTTP_CRLF); + phpstr_append(&str, PHPSTR_VAL(msg), PHPSTR_LEN(msg)); + phpstr_appends(&str, HTTP_CRLF); + } + + data = phpstr_data(&str, string, length); + if (!string) { + efree(data); + } + + phpstr_dtor(&str); + } + + PHP_HTTP_API void _http_message_serialize(http_message *message, char **string, size_t *length) + { + char *buf; + size_t len; + phpstr str; + + phpstr_init(&str); + + do { + http_message_tostring(message, &buf, &len); + phpstr_prepend(&str, buf, len); + efree(buf); + } while (message = message->parent); + + buf = phpstr_data(&str, string, length); + if (!string) { + efree(buf); + } + + phpstr_dtor(&str); + } + + PHP_HTTP_API STATUS _http_message_send(http_message *message TSRMLS_DC) + { + STATUS rs = FAILURE; + + switch (message->type) + { + case HTTP_MSG_RESPONSE: + { + char *key; + ulong idx; + zval **val; + + FOREACH_HASH_KEYVAL(&message->hdrs, key, idx, val) { + if (key) { + char *header; + spprintf(&header, 0, "%s: %s", key, Z_STRVAL_PP(val)); + http_send_header(header); + efree(header); + key = NULL; + } + } + rs = SUCCESS == http_send_status(message->info.response.code) && + SUCCESS == http_send_data(PHPSTR_VAL(message), PHPSTR_LEN(message)) ? + SUCCESS : FAILURE; + } + break; + + case HTTP_MSG_REQUEST: + { + #ifdef HTTP_HAVE_CURL + char *uri = NULL; + zval **zhost, options, headers; + + array_init(&options); + array_init(&headers); + zend_hash_copy(Z_ARRVAL(headers), &message->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); + add_assoc_zval(&options, "headers", &headers); + + /* check host header */ + if (SUCCESS == zend_hash_find(&message->hdrs, "Host", sizeof("Host"), (void **) &zhost)) { + char *colon = NULL, *host = NULL; + size_t host_len = 0; + int port = 0; + + /* check for port */ + if (colon = strchr(Z_STRVAL_PP(zhost), ':')) { + port = atoi(colon + 1); + host = estrndup(Z_STRVAL_PP(zhost), host_len = (Z_STRVAL_PP(zhost) - colon - 1)); + } else { + host = estrndup(Z_STRVAL_PP(zhost), host_len = Z_STRLEN_PP(zhost)); + } + uri = http_absolute_uri_ex( + message->info.request.URI, strlen(message->info.request.URI), + NULL, 0, host, host_len, port); + efree(host); + } else { + uri = http_absolute_uri(message->info.request.URI); + } + + if (!strcasecmp("POST", message->info.request.method)) { + http_request_body body = {HTTP_REQUEST_BODY_CSTRING, PHPSTR_VAL(message), PHPSTR_LEN(message)}; + rs = http_post(uri, &body, Z_ARRVAL(options), NULL, NULL); + } else + if (!strcasecmp("GET", message->info.request.method)) { + rs = http_get(uri, Z_ARRVAL(options), NULL, NULL); + } else + if (!strcasecmp("HEAD", message->info.request.method)) { + rs = http_head(uri, Z_ARRVAL(options), NULL, NULL); + } else { + http_error_ex(E_WARNING, HTTP_E_MSG, + "Cannot send HttpMessage. Request method %s not supported", + message->info.request.method); + } + + efree(uri); + #else + http_error(E_WARNING, HTTP_E_MSG, "HTTP requests not supported - ext/http was not linked against libcurl."); + #endif + } + break; + + case HTTP_MSG_NONE: + default: + http_error(E_WARNING, HTTP_E_MSG, "HttpMessage is neither of type HTTP_MSG_REQUEST nor HTTP_MSG_RESPONSE"); + break; + } + + return rs; + } + + PHP_HTTP_API void _http_message_dtor(http_message *message) + { + if (message) { + zend_hash_destroy(&message->hdrs); + phpstr_dtor(PHPSTR(message)); + if (HTTP_MSG_TYPE(REQUEST, message)) { + if (message->info.request.method) { + efree(message->info.request.method); + message->info.request.method = NULL; + } + if (message->info.request.URI) { + efree(message->info.request.URI); + message->info.request.URI = NULL; + } + } + } + } + + PHP_HTTP_API void _http_message_free(http_message *message) + { + if (message) { + if (message->parent) { + http_message_free(message->parent); + message->parent = NULL; + } + http_message_dtor(message); + efree(message); + } + } + + /* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * End: + * vim600: noet sw=4 ts=4 fdm=marker + * vim<600: noet sw=4 ts=4 + */ + diff --git a/http_methods.c b/http_methods.c index eaf3642..715d904 100644 --- a/http_methods.c +++ b/http_methods.c @@ -1,1992 +1,3984 @@ /* + +----------------------------------------------------------------------+ + | 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 | + +----------------------------------------------------------------------+ + */ + + /* $Id$ */ + + #ifdef HAVE_CONFIG_H + # include "config.h" + #endif + + #include "php.h" + #include "php_http.h" + #include "php_http_std_defs.h" + #include "php_http_api.h" + #include "php_http_cache_api.h" + #include "php_http_request_api.h" + #include "php_http_date_api.h" + #include "php_http_headers_api.h" + #include "php_http_message_api.h" + #include "php_http_send_api.h" + #include "php_http_url_api.h" + + #include "php_http_message_object.h" + #include "php_http_response_object.h" + #include "php_http_request_object.h" + #include "php_http_exception_object.h" + + #ifdef ZEND_ENGINE_2 + + /* {{{ HttpResponse */ + + /* {{{ 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(HttpResponse, __construct) + { + zend_bool do_cache = 0, do_gzip = 0; + getObject(http_response_object, obj); + + SET_EH_THROW_HTTP(); + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|bb", &do_cache, &do_gzip)) { + UPD_PROP(obj, long, cache, do_cache); + UPD_PROP(obj, long, gzip, do_gzip); + } + SET_EH_NORMAL(); + } + /* }}} */ + + /* {{{ 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(HttpResponse, setCache) + { + zend_bool do_cache = 0; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_cache)) { + RETURN_FALSE; + } + + UPD_PROP(obj, long, cache, do_cache); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto bool HttpResponse::getCache() + * + * Get current caching setting. + */ + PHP_METHOD(HttpResponse, getCache) + { + zval *do_cache = NULL; + getObject(http_response_object, obj); + + NO_ARGS; + + do_cache = GET_PROP(obj, cache); + RETURN_BOOL(Z_LVAL_P(do_cache)); + } + /* }}}*/ + + /* {{{ proto bool HttpResponse::setGzip(bool gzip) + * + * Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET. + */ + PHP_METHOD(HttpResponse, setGzip) + { + zend_bool do_gzip = 0; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "b", &do_gzip)) { + RETURN_FALSE; + } + + UPD_PROP(obj, long, gzip, do_gzip); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto bool HttpResponse::getGzip() + * + * Get current gzipping setting. + */ + PHP_METHOD(HttpResponse, getGzip) + { + zval *do_gzip = NULL; + getObject(http_response_object, obj); + + NO_ARGS; + + do_gzip = GET_PROP(obj, gzip); + RETURN_BOOL(Z_LVAL_P(do_gzip)); + } + /* }}} */ + + /* {{{ 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(HttpResponse, setCacheControl) + { + char *ccontrol; + int cc_len; + zend_bool raw = 0; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &ccontrol, &cc_len, &raw)) { + RETURN_FALSE; + } + + if ((!raw) && (strcmp(ccontrol, "public") && strcmp(ccontrol, "private") && strcmp(ccontrol, "no-cache"))) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Cache-Control '%s' doesn't match public, private or no-cache", ccontrol); + RETURN_FALSE; + } + + UPD_PROP(obj, long, raw_cache_header, raw); + UPD_PROP(obj, string, cacheControl, ccontrol); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpResponse::getCacheControl() + * + * Get current Cache-Control header setting. + */ + PHP_METHOD(HttpResponse, getCacheControl) + { + zval *ccontrol; + getObject(http_response_object, obj); + + NO_ARGS; + + ccontrol = GET_PROP(obj, cacheControl); + RETURN_STRINGL(Z_STRVAL_P(ccontrol), Z_STRLEN_P(ccontrol), 1); + } + /* }}} */ + + /* {{{ proto bool HttpResponse::setContentType(string content_type) + * + * Set the content-type of the sent entity. + */ + PHP_METHOD(HttpResponse, setContentType) + { + char *ctype; + int ctype_len; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ctype_len)) { + RETURN_FALSE; + } + + if (!strchr(ctype, '/')) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Content type '%s' doesn't seem to contain a primary and a secondary part", ctype); + RETURN_FALSE; + } + + UPD_PROP(obj, string, contentType, ctype); + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpResponse::getContentType() + * + * Get current Content-Type header setting. + */ + PHP_METHOD(HttpResponse, getContentType) + { + zval *ctype; + getObject(http_response_object, obj); + + NO_ARGS; + + ctype = GET_PROP(obj, contentType); + RETURN_STRINGL(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1); + } + /* }}} */ + + /* {{{ 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(HttpResponse, setContentDisposition) + { + char *file; + int file_len; + zend_bool is_inline = 0; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &file, &file_len, &is_inline)) { + RETURN_FALSE; + } + + UPD_PROP(obj, string, dispoFile, file); + UPD_PROP(obj, long, dispoInline, is_inline); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto array HttpResponse::getContentDisposition() + * + * Get current Content-Disposition setting. + * Will return an associative array like: + *
+
  * array(
+
  *     'filename' => 'foo.bar',
+
  *     'inline'   => false
+
  * )
+
  * 
+ */ + PHP_METHOD(HttpResponse, getContentDisposition) + { + zval *file; + zval *is_inline; + getObject(http_response_object, obj); + + if (ZEND_NUM_ARGS()) { + WRONG_PARAM_COUNT; + } + + file = GET_PROP(obj, dispoFile); + is_inline = GET_PROP(obj, dispoInline); + + array_init(return_value); + add_assoc_stringl(return_value, "filename", Z_STRVAL_P(file), Z_STRLEN_P(file), 1); + add_assoc_bool(return_value, "inline", Z_LVAL_P(is_inline)); + } + /* }}} */ + + /* {{{ proto bool HttpResponse::setETag(string etag) + * + * Set a custom ETag. Use this only if you know what you're doing. + */ + PHP_METHOD(HttpResponse, setETag) + { + char *etag; + int etag_len; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len)) { + RETURN_FALSE; + } + + UPD_PROP(obj, string, eTag, etag); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpResponse::getETag() + * + * Get the previously set custom ETag. + */ + PHP_METHOD(HttpResponse, getETag) + { + zval *etag; + getObject(http_response_object, obj); + + NO_ARGS; + + etag = GET_PROP(obj, eTag); + RETURN_STRINGL(Z_STRVAL_P(etag), Z_STRLEN_P(etag), 1); + } + /* }}} */ + + /* {{{ proto bool HttpResponse::setData(string data) + * + * Set the data to be sent. + */ + PHP_METHOD(HttpResponse, setData) + { + zval *the_data; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &the_data)) { + RETURN_FALSE; + } + + convert_to_string_ex(&the_data); + SET_PROP(obj, data, the_data); + UPD_PROP(obj, long, lastModified, http_last_modified(the_data, SEND_DATA)); + UPD_PROP(obj, long, send_mode, SEND_DATA); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpResponse::getData() + * + * Get the previously set data to be sent. + */ + PHP_METHOD(HttpResponse, getData) + { + zval *the_data; + getObject(http_response_object, obj); + + NO_ARGS; + + the_data = GET_PROP(obj, data); + RETURN_STRINGL(Z_STRVAL_P(the_data), Z_STRLEN_P(the_data), 1); + } + /* }}} */ + + /* {{{ proto bool HttpResponse::setStream(resource stream) + * + * Set the resource to be sent. + */ + PHP_METHOD(HttpResponse, setStream) + { + zval *the_stream; + php_stream *the_real_stream; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &the_stream)) { + RETURN_FALSE; + } + + php_stream_from_zval(the_real_stream, &the_stream); + + SET_PROP(obj, stream, the_stream); + UPD_PROP(obj, long, lastModified, http_last_modified(the_real_stream, SEND_RSRC)); + UPD_PROP(obj, long, send_mode, SEND_RSRC); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto resource HttpResponse::getStream() + * + * Get the previously set resource to be sent. + */ + PHP_METHOD(HttpResponse, getStream) + { + zval *the_stream; + getObject(http_response_object, obj); + + NO_ARGS; + + the_stream = GET_PROP(obj, stream); + RETURN_RESOURCE(Z_LVAL_P(the_stream)); + } + /* }}} */ + + /* {{{ proto bool HttpResponse::setFile(string file) + * + * Set the file to be sent. + */ + PHP_METHOD(HttpResponse, setFile) + { + zval *the_file; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &the_file)) { + RETURN_FALSE; + } + + convert_to_string_ex(&the_file); + + UPD_PROP(obj, string, file, Z_STRVAL_P(the_file)); + UPD_PROP(obj, long, lastModified, http_last_modified(the_file, -1)); + UPD_PROP(obj, long, send_mode, -1); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpResponse::getFile() + * + * Get the previously set file to be sent. + */ + PHP_METHOD(HttpResponse, getFile) + { + zval *the_file; + getObject(http_response_object, obj); + + NO_ARGS; + + the_file = GET_PROP(obj, file); + RETURN_STRINGL(Z_STRVAL_P(the_file), Z_STRLEN_P(the_file), 1); + } + /* }}} */ + + /* {{{ 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(http_response_object, obj); + + NO_ARGS; + + do_cache = GET_PROP(obj, cache); + do_gzip = GET_PROP(obj, gzip); + + /* gzip */ + if (Z_LVAL_P(do_gzip)) { + php_start_ob_buffer_named("ob_gzhandler", 0, 1 TSRMLS_CC); + } + + /* caching */ + if (Z_LVAL_P(do_cache)) { + zval *cctrl, *etag, *lmod, *ccraw; + + etag = GET_PROP(obj, eTag); + lmod = GET_PROP(obj, lastModified); + cctrl = GET_PROP(obj, cacheControl); + ccraw = GET_PROP(obj, raw_cache_header); + + if (Z_LVAL_P(ccraw)) { + http_cache_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag), Z_STRVAL_P(cctrl), Z_STRLEN_P(cctrl)); + http_cache_last_modified(Z_LVAL_P(lmod), Z_LVAL_P(lmod) ? Z_LVAL_P(lmod) : time(NULL), Z_STRVAL_P(cctrl), Z_STRLEN_P(cctrl)); + } else { + char cc_header[42] = {0}; + sprintf(cc_header, "%s, must-revalidate, max-age=0", Z_STRVAL_P(cctrl)); + http_cache_etag(Z_STRVAL_P(etag), Z_STRLEN_P(etag), cc_header, strlen(cc_header)); + http_cache_last_modified(Z_LVAL_P(lmod), Z_LVAL_P(lmod) ? Z_LVAL_P(lmod) : time(NULL), cc_header, strlen(cc_header)); + } + } + + /* content type */ + { + zval *ctype = GET_PROP(obj, contentType); + if (Z_STRLEN_P(ctype)) { + http_send_content_type(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype)); + } else { + http_send_content_type("application/x-octetstream", sizeof("application/x-octetstream") - 1); + } + } + + /* content disposition */ + { + 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), (zend_bool) Z_LVAL_P(dispo_inline)); + } + } + + /* send */ + { + zval *send_mode = GET_PROP(obj, send_mode); + switch (Z_LVAL_P(send_mode)) + { + case SEND_DATA: + { + zval *zdata = GET_PROP(obj, data); + RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata))); + } + + case SEND_RSRC: + { + php_stream *the_real_stream; + zval *the_stream = GET_PROP(obj, stream); + php_stream_from_zval(the_real_stream, &the_stream); + RETURN_SUCCESS(http_send_stream(the_real_stream)); + } + + default: + { + zval *zfile = GET_PROP(obj, file); + RETURN_SUCCESS(http_send_file(Z_STRVAL_P(zfile))); + } + } + } + } + /* }}} */ + /* }}} */ + + /* {{{ HttpMessage */ + + /* {{{ proto static HttpMessage HttpMessage::fromString(string raw_message) + * + * Create an HttpMessage object from a string. + */ + PHP_METHOD(HttpMessage, fromString) + { + char *string = NULL; + int length = 0; + http_message *msg = NULL; + http_message_object obj; + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &string, &length)) { + RETURN_NULL(); + } + + if (!(msg = http_message_parse(string, length))) { + RETURN_NULL(); + } + + Z_TYPE_P(return_value) = IS_OBJECT; + return_value->value.obj = http_message_object_from_msg(msg); + } + /* }}} */ + + /* {{{ proto void HttpMessage::__construct([string message]) + * + * Instantiate a new HttpMessage object. + */ + PHP_METHOD(HttpMessage, __construct) + { + char *message = NULL; + int length = 0; + getObject(http_message_object, obj); + + SET_EH_THROW_HTTP(); + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &message, &length) && message && length) { + if (obj->message = http_message_parse(message, length)) { + if (obj->message->parent) { + obj->parent = http_message_object_from_msg(obj->message->parent); + } + } + } else if (!obj->message) { + obj->message = http_message_new(); + } + SET_EH_NORMAL(); + } + /* }}} */ + + /* {{{ proto string HttpMessage::getBody() + * + * Get the body of the parsed Message. + */ + PHP_METHOD(HttpMessage, getBody) + { + zval *body; + getObject(http_message_object, obj); + + NO_ARGS; + + RETURN_PHPSTR(&obj->message->body, PHPSTR_FREE_NOT, 1); + } + /* }}} */ + + /* {{{ proto array HttpMessage::getHeaders() + * + * Get Message Headers. + */ + PHP_METHOD(HttpMessage, getHeaders) + { + zval headers; + getObject(http_message_object, obj); + + NO_ARGS; + + Z_ARRVAL(headers) = &obj->message->hdrs; + array_init(return_value); + array_copy(&headers, return_value); + } + /* }}} */ + + /* {{{ proto void HttpMessage::setHeaders(array headers) + * + * Sets new headers. + */ + PHP_METHOD(HttpMessage, setHeaders) + { + zval *new_headers, old_headers; + getObject(http_message_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &new_headers)) { + return; + } + + zend_hash_clean(&obj->message->hdrs); + Z_ARRVAL(old_headers) = &obj->message->hdrs; + array_copy(new_headers, &old_headers); + } + /* }}} */ + + /* {{{ proto void HttpMessage::addHeaders(array headers[, bool append = false]) + * + * Add headers. If append is true, headers with the same name will be separated, else overwritten. + */ + PHP_METHOD(HttpMessage, addHeaders) + { + zval old_headers, *new_headers; + zend_bool append = 0; + getObject(http_message_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|b", &new_headers, &append)) { + return; + } + + Z_ARRVAL(old_headers) = &obj->message->hdrs; + if (append) { + array_append(new_headers, &old_headers); + } else { + array_merge(new_headers, &old_headers); + } + } + /* }}} */ + + /* {{{ proto long HttpMessage::getType() + * + * Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE) + */ + PHP_METHOD(HttpMessage, getType) + { + getObject(http_message_object, obj); + + NO_ARGS; + + RETURN_LONG(obj->message->type); + } + /* }}} */ + + /* {{{ proto void HttpMessage::setType(long type) + * + * Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE) + */ + PHP_METHOD(HttpMessage, setType) + { + long type; + getObject(http_message_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &type)) { + return; + } + http_message_set_type(obj->message, type); + } + /* }}} */ + + /* {{{ proto long HttpMessage::getResponseCode() + * + * Get the Response Code of the Message. + */ + PHP_METHOD(HttpMessage, getResponseCode) + { + getObject(http_message_object, obj); + + NO_ARGS; + + if (!HTTP_MSG_TYPE(RESPONSE, obj->message)) { + http_error(E_NOTICE, HTTP_E_MSG, "HttpMessage is not of type HTTP_MSG_RESPONSE"); + RETURN_NULL(); + } + + RETURN_LONG(obj->message->info.response.code); + } + /* }}} */ + + /* {{{ proto bool HttpMessage::setResponseCode(long code) + * + * Set the response code of an HTTP Response Message. + * Returns false if the Message is not of type HTTP_MSG_RESPONSE, + * or if the response code is out of range (100-510). + */ + PHP_METHOD(HttpMessage, setResponseCode) + { + long code; + getObject(http_message_object, obj); + + if (obj->message->type != HTTP_MSG_RESPONSE) { + http_error(E_WARNING, HTTP_E_MSG, "HttpMessage is not of type HTTP_MSG_RESPONSE"); + RETURN_FALSE; + } + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &code)) { + RETURN_FALSE; + } + if (code < 100 || code > 510) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Invalid response code (100-510): %ld", code); + RETURN_FALSE; + } + + obj->message->info.response.code = code; + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpMessage::getRequestMethod() + * + * Get the Request Method of the Message. + * Returns false if the Message is not of type HTTP_MSG_REQUEST. + */ + PHP_METHOD(HttpMessage, getRequestMethod) + { + getObject(http_message_object, obj); + + NO_ARGS; + + if (obj->message->type != HTTP_MSG_REQUEST) { + http_error(E_NOTICE, HTTP_E_MSG, "HttpMessage is not of type HTTP_MSG_REQUEST"); + RETURN_NULL(); + } + + RETURN_STRING(obj->message->info.request.method, 1); + } + /* }}} */ + + /* {{{ proto bool HttpMessage::setRequestMethod(string method) + * + * Set the Request Method of the HTTP Message. + * Returns false if the Message is not of type HTTP_MSG_REQUEST. + */ + PHP_METHOD(HttpMessage, setRequestMethod) + { + char *method; + int method_len; + getObject(http_message_object, obj); + + if (obj->message->type != HTTP_MSG_REQUEST) { + http_error(E_WARNING, HTTP_E_MSG, "HttpMessage is not of type HTTP_MSG_REQUEST"); + RETURN_FALSE; + } + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) { + RETURN_FALSE; + } + if (method_len < 1) { + http_error(E_WARNING, HTTP_E_PARAM, "Cannot set HttpMessage::requestMethod to an empty string"); + RETURN_FALSE; + } + if (SUCCESS != http_check_method(method)) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Unkown request method: %s", method); + RETURN_FALSE; + } + + if (obj->message->info.request.method) { + efree(obj->message->info.request.method); + } + obj->message->info.request.method = estrndup(method, method_len); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpMessage::getRequestUri() + * + * Get the Request URI of the Message. + */ + PHP_METHOD(HttpMessage, getRequestUri) + { + zval *uri; + getObject(http_message_object, obj); + + NO_ARGS; + + if (obj->message->type != HTTP_MSG_REQUEST) { + http_error(E_WARNING, HTTP_E_MSG, "HttpMessage is not of type HTTP_MSG_REQUEST"); + RETURN_NULL(); + } + + RETURN_STRING(obj->message->info.request.URI, 1); + } + /* }}} */ + + /* {{{ proto bool HttpMessage::setRequestUri(string URI) + * + * Set the Request URI of the HTTP Message. + * Returns false if the Message is not of type HTTP_MSG_REQUEST, + * or if paramtere URI was empty. + */ + PHP_METHOD(HttpMessage, setRequestUri) + { + char *URI; + int URIlen; + getObject(http_message_object, obj); + + if (obj->message->type != HTTP_MSG_REQUEST) { + http_error(E_WARNING, HTTP_E_MSG, "HttpMessage is not of type HTTP_MSG_REQUEST"); + RETURN_FALSE; + } + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URI, &URIlen)) { + RETURN_FALSE; + } + if (URIlen < 1) { + http_error(E_WARNING, HTTP_E_PARAM, "Cannot set HttpMessage::requestUri to an empty string"); + RETURN_FALSE; + } + + if (obj->message->info.request.URI) { + efree(obj->message->info.request.URI); + } + obj->message->info.request.URI = estrndup(URI, URIlen); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpMessage::getHttpVersion() + * + * Get the HTTP Protocol Version of the Message. + */ + PHP_METHOD(HttpMessage, getHttpVersion) + { + char ver[4] = {0}; + float version; + getObject(http_message_object, obj); + + NO_ARGS; + + switch (obj->message->type) + { + case HTTP_MSG_RESPONSE: + version = obj->message->info.response.http_version; + break; + + case HTTP_MSG_REQUEST: + version = obj->message->info.request.http_version; + break; + + case HTTP_MSG_NONE: + default: + RETURN_NULL(); + } + sprintf(ver, "%1.1f", version); + RETURN_STRINGL(ver, 3, 1); + } + /* }}} */ + + /* {{{ proto bool HttpMessage::setHttpVersion(string version) + * + * Set the HTTP Protocol version of the Message. + * Returns false if version is invalid (1.0 and 1.1). + */ + PHP_METHOD(HttpMessage, setHttpVersion) + { + char v[4]; + zval *zv, *version; + getObject(http_message_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &zv)) { + return; + } + + if (obj->message->type == HTTP_MSG_NONE) { + http_error(E_WARNING, HTTP_E_MSG, "Message is neither of type HTTP_MSG_RESPONSE nor HTTP_MSG_REQUEST"); + RETURN_FALSE; + } + + convert_to_double_ex(&zv); + sprintf(v, "%1.1f", Z_DVAL_P(zv)); + if (strcmp(v, "1.0") && strcmp(v, "1.1")) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Invalid HTTP protocol version (1.0 or 1.1): %s", v); + RETURN_FALSE; + } + + if (obj->message->type == HTTP_MSG_RESPONSE) { + obj->message->info.response.http_version = (float) Z_DVAL_P(zv); + } else { + obj->message->info.request.http_version = (float) Z_DVAL_P(zv); + } + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto HttpMessage HttpMessage::getParentMessage() + * + * Get parent Message. + */ + PHP_METHOD(HttpMessage, getParentMessage) + { + getObject(http_message_object, obj); + + NO_ARGS; + + if (obj->message->parent) { + RETVAL_OBJVAL(obj->parent); + } else { + RETVAL_NULL(); + } + } + /* }}} */ + + /* {{{ proto bool HttpMessage::send() + * + * Send the Message according to its type as Response or Request. + */ + PHP_METHOD(HttpMessage, send) + { + getObject(http_message_object, obj); + + NO_ARGS; + + RETURN_SUCCESS(http_message_send(obj->message)); + } + /* }}} */ + + /* {{{ proto string HttpMessage::toString([bool include_parent = true]) + * + * Get the string representation of the Message. + */ + PHP_METHOD(HttpMessage, toString) + { + char *string; + size_t length; + zend_bool include_parent = 1; + getObject(http_message_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &include_parent)) { + RETURN_FALSE; + } + + if (include_parent) { + http_message_serialize(obj->message, &string, &length); + } else { + http_message_tostring(obj->message, &string, &length); + } + RETURN_STRINGL(string, length, 0); + } + /* }}} */ + + /* }}} */ + + #ifdef HTTP_HAVE_CURL + /* {{{ HttpRequest */ + + /* {{{ 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(HttpRequest, __construct) + { + char *URL = NULL; + int URL_len; + long meth = -1; + getObject(http_request_object, obj); + + SET_EH_THROW_HTTP(); + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sl", &URL, &URL_len, &meth)) { + INIT_PARR(obj, options); + INIT_PARR(obj, responseInfo); + INIT_PARR(obj, responseData); + INIT_PARR(obj, postData); + INIT_PARR(obj, postFiles); + + if (URL) { + UPD_PROP(obj, string, url, URL); + } + if (meth > -1) { + UPD_PROP(obj, long, method, meth); + } + } + SET_EH_NORMAL(); + } + /* }}} */ + + /* {{{ proto void HttpRequest::__destruct() + * + * Destroys the HttpRequest object. + */ + PHP_METHOD(HttpRequest, __destruct) + { + getObject(http_request_object, obj); + + NO_ARGS; + + FREE_PARR(obj, options); + FREE_PARR(obj, responseInfo); + FREE_PARR(obj, responseData); + FREE_PARR(obj, postData); + FREE_PARR(obj, postFiles); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::setOptions(array options) + * + * Set the request options to use. See http_get() for a full list of available options. + */ + PHP_METHOD(HttpRequest, setOptions) + { + char *key = NULL; + long idx = 0; + zval *opts, *old_opts, **opt; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &opts)) { + RETURN_FALSE; + } - old_opts = GET_PROP(obj, options); + + + old_opts = GET_PROP(obj, options); + + /* 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)) { + array_merge(*opt, *headers); + continue; + } + } else if (!strcmp(key, "cookies")) { + zval **cookies; + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(old_opts), "cookies", sizeof("cookies"), (void **) &cookies)) { + array_merge(*opt, *cookies); + continue; + } + } + zval_add_ref(opt); + add_assoc_zval(old_opts, key, *opt); + + /* reset */ + key = NULL; + } + } + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto array HttpRequest::getOptions() + * + * Get current set options. + */ + PHP_METHOD(HttpRequest, getOptions) + { + zval *opts; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + array_init(return_value); + array_copy(opts, return_value); + } + /* }}} */ + + /* {{{ 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::setSslOptions(array options) + * + * Set additional SSL options. + */ + PHP_METHOD(HttpRequest, setSslOptions) + { + zval *opts, *old_opts, **ssl_options; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &opts)) { + RETURN_FALSE; + } + + old_opts = GET_PROP(obj, options); + + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(old_opts), "ssl", sizeof("ssl"), (void **) &ssl_options)) { + array_merge(opts, *ssl_options); + } else { + zval_add_ref(&opts); + add_assoc_zval(old_opts, "ssl", opts); + } + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto array HttpRequest::getSslOtpions() + * + * Get previously set SSL options. + */ + PHP_METHOD(HttpRequest, getSslOptions) + { + zval *opts, **ssl_options; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + + array_init(return_value); + + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "ssl", sizeof("ssl"), (void **) &ssl_options)) { + array_copy(*ssl_options, return_value); + } + } + /* }}} */ + + /* {{{ proto void HttpRequest::unsetSslOptions() + * + * Unset previously set SSL options. + */ + PHP_METHOD(HttpRequest, unsetSslOptions) + { + zval *opts; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + zend_hash_del(Z_ARRVAL_P(opts), "ssl", sizeof("ssl")); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::addHeaders(array headers) + * + * Add request header name/value pairs. + */ + PHP_METHOD(HttpRequest, addHeaders) + { + 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 array HttpRequest::getHeaders() + * + * Get previously set request headers. + */ + PHP_METHOD(HttpRequest, getHeaders) + { + zval *opts, **headers; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + + array_init(return_value); + + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "headers", sizeof("headers"), (void **) &headers)) { + array_copy(*headers, return_value); + } + } + /* }}} */ + + /* {{{ proto void HttpRequest::unsetHeaders() + * + * Unset previously set request headers. + */ + PHP_METHOD(HttpRequest, unsetHeaders) + { + zval *opts; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + zend_hash_del(Z_ARRVAL_P(opts), "headers", sizeof("headers")); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::addCookies(array cookies) + * + * Add cookies. + */ + PHP_METHOD(HttpRequest, addCookies) + { + 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 array HttpRequest::getCookies() + * + * Get previously set cookies. + */ + PHP_METHOD(HttpRequest, getCookies) + { + zval *opts, **cookies; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + + array_init(return_value); + + if (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "cookies", sizeof("cookies"), (void **) &cookies)) { + array_copy(*cookies, return_value); + } + } + /* }}} */ + + /* {{{ proto void HttpRequest::unsetCookies() + * + */ + PHP_METHOD(HttpRequest, unsetCookies) + { + zval *opts; + getObject(http_request_object, obj); + + NO_ARGS; + + opts = GET_PROP(obj, options); + zend_hash_del(Z_ARRVAL_P(opts), "cookies", sizeof("cookies")); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::setURL(string url) + * + * Set the request URL. + */ + PHP_METHOD(HttpRequest, setURL) + { + char *URL = NULL; + int URL_len; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URL, &URL_len)) { + RETURN_FALSE; + } + + UPD_PROP(obj, string, url, URL); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpRequest::getUrl() + * + * Get the previously set request URL. + */ + PHP_METHOD(HttpRequest, getURL) + { + zval *URL; + getObject(http_request_object, obj); + + NO_ARGS; + + URL = GET_PROP(obj, url); + RETURN_STRINGL(Z_STRVAL_P(URL), Z_STRLEN_P(URL), 1); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::setMethod(long request_method) + * + * Set the request methods; one of the HTTP_HEAD, HTTP_GET or + * HTTP_POST constants. + */ + PHP_METHOD(HttpRequest, setMethod) + { + long meth; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &meth)) { + RETURN_FALSE; + } + + UPD_PROP(obj, long, method, meth); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto long HttpRequest::getMethod() + * + * Get the previously set request method. + */ + PHP_METHOD(HttpRequest, getMethod) + { + zval *meth; + getObject(http_request_object, obj); + + NO_ARGS; + + meth = GET_PROP(obj, method); + RETURN_LONG(Z_LVAL_P(meth)); + } + /* }}} */ + + /* {{{ 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(HttpRequest, setContentType) + { + char *ctype; + int ct_len; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ct_len)) { + RETURN_FALSE; + } + + if (!strchr(ctype, '/')) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Content-Type '%s' doesn't seem to contain a primary and a secondary part", ctype); + RETURN_FALSE; + } + + UPD_PROP(obj, string, contentType, ctype); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpRequest::getContentType() + * + * Get the previously content type. + */ + PHP_METHOD(HttpRequest, getContentType) + { + zval *ctype; + getObject(http_request_object, obj); + + NO_ARGS; + + ctype = GET_PROP(obj, contentType); + RETURN_STRINGL(Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1); + } + /* }}} */ + + /* {{{ 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(HttpRequest, setQueryData) + { + zval *qdata; + 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)) { + if (SUCCESS != http_urlencode_hash(HASH_OF(qdata), &query_data)) { + RETURN_FALSE; + } + UPD_PROP(obj, string, queryData, query_data); + efree(query_data); + RETURN_TRUE; + } + + convert_to_string(qdata); + UPD_PROP(obj, string, queryData, Z_STRVAL_P(qdata)); + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto string HttpRequest::getQueryData() + * + * Get the current query data in form of an urlencoded query string. + */ + PHP_METHOD(HttpRequest, getQueryData) + { + zval *qdata; + getObject(http_request_object, obj); + + NO_ARGS; + + qdata = GET_PROP(obj, queryData); + RETURN_STRINGL(Z_STRVAL_P(qdata), Z_STRLEN_P(qdata), 1); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::addQueryData(array query_params) + * + * Add parameters to the query parameter list. + * Affects any request type. + */ + PHP_METHOD(HttpRequest, addQueryData) + { + zval *qdata, *old_qdata; + 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 (SUCCESS != http_urlencode_hash_ex(HASH_OF(qdata), 1, Z_STRVAL_P(old_qdata), Z_STRLEN_P(old_qdata), &query_data, NULL)) { + RETURN_FALSE; + } + + UPD_PROP(obj, string, queryData, query_data); + efree(query_data); + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto void HttpRequest::unsetQueryData() + * + * Clean the query parameters. + * Affects any request type. + */ + PHP_METHOD(HttpRequest, unsetQueryData) + { + getObject(http_request_object, obj); + + NO_ARGS; + + UPD_PROP(obj, string, queryData, ""); + } + /* }}} */ + + /* {{{ proto bool HttpRequest::addPostData(array post_data) + * + * Adds POST data entries. + * Affects only POST requests. + */ + PHP_METHOD(HttpRequest, addPostData) + { + zval *post, *post_data; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &post_data)) { + RETURN_FALSE; + } + + post = GET_PROP(obj, postData); + array_merge(post_data, post); + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto bool HttpRequest::setPostData(array post_data) + * + * Set the POST data entries. + * Overwrites previously set POST data. + * Affects only POST requests. + */ + PHP_METHOD(HttpRequest, setPostData) + { + zval *post, *post_data; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &post_data)) { + RETURN_FALSE; + } + + post = GET_PROP(obj, postData); + zend_hash_clean(Z_ARRVAL_P(post)); + array_copy(post_data, post); + + RETURN_TRUE; + } + /* }}}*/ + + /* {{{ proto array HttpRequest::getPostData() + * + * Get previously set POST data. + */ + PHP_METHOD(HttpRequest, getPostData) + { + zval *post_data; + getObject(http_request_object, obj); + + NO_ARGS; + + post_data = GET_PROP(obj, postData); + array_init(return_value); + array_copy(post_data, return_value); + } + /* }}} */ + + /* {{{ proto void HttpRequest::unsetPostData() + * + * Clean POST data entires. + * Affects only POST requests. + */ + PHP_METHOD(HttpRequest, unsetPostData) + { + zval *post_data; + getObject(http_request_object, obj); + + NO_ARGS; + + post_data = GET_PROP(obj, postData); + zend_hash_clean(Z_ARRVAL_P(post_data)); + } + /* }}} */ + + /* {{{ 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(HttpRequest, addPostFile) + { + zval *files, *entry; + char *name, *file, *type = NULL; + int name_len, file_len, type_len = 0; + 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; + } + + if (type_len) { + if (!strchr(type, '/')) { + http_error_ex(E_WARNING, HTTP_E_PARAM, "Content-Type '%s' doesn't seem to contain a primary and a secondary part", type); + RETURN_FALSE; + } + } else { + type = "application/x-octetstream"; + type_len = sizeof("application/x-octetstream") - 1; + } + + MAKE_STD_ZVAL(entry); + array_init(entry); + + add_assoc_stringl(entry, "name", name, name_len, 1); + add_assoc_stringl(entry, "type", type, type_len, 1); + add_assoc_stringl(entry, "file", file, file_len, 1); + + files = GET_PROP(obj, postFiles); + add_next_index_zval(files, entry); + + RETURN_TRUE; + } + /* }}} */ + + /* {{{ proto array HttpRequest::getPostFiles() + * + * Get all previously added POST files. + */ + PHP_METHOD(HttpRequest, getPostFiles) + { + zval *files; + getObject(http_request_object, obj); + + NO_ARGS; + + files = GET_PROP(obj, postFiles); + + array_init(return_value); + array_copy(files, return_value); + } + /* }}} */ + + /* {{{ proto void HttpRequest::unsetPostFiles() + * + * Unset the POST files list. + * Affects only POST requests. + */ + PHP_METHOD(HttpRequest, unsetPostFiles) + { + zval *files; + getObject(http_request_object, obj); + + NO_ARGS; + + files = GET_PROP(obj, postFiles); + zend_hash_clean(Z_ARRVAL_P(files)); + } + /* }}} */ + + /* {{{ proto array HttpRequest::getResponseData() + * + * Get all response data after the request has been sent. + */ + PHP_METHOD(HttpRequest, getResponseData) + { + zval *data; + getObject(http_request_object, obj); + + NO_ARGS; + + data = GET_PROP(obj, responseData); + array_init(return_value); + array_copy(data, return_value); + } + /* }}} */ + + /* {{{ proto mixed HttpRequest::getResponseHeader([string name]) + * + * Get response header(s) after the request has been sent. + */ + PHP_METHOD(HttpRequest, getResponseHeader) + { + zval *data, **headers, **header; + char *header_name = NULL; + int header_len = 0; + getObject(http_response_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &header_name, &header_len)) { + RETURN_FALSE; + } + + data = GET_PROP(obj, responseData); + 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 array HttpRequest::getResponseCookie([string name]) + * + * Get response cookie(s) after the request has been sent. + */ + PHP_METHOD(HttpRequest, getResponseCookie) + { + zval *data, **headers; + char *cookie_name = NULL; + int cookie_len = 0; + getObject(http_request_object, obj); + + if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &cookie_name, &cookie_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)) { + ulong idx = 0; + char *key = NULL; + zval **header = NULL; + + FOREACH_HASH_KEYVAL(Z_ARRVAL_PP(headers), key, idx, header) { + if (key && !strcasecmp(key, "Set-Cookie")) { + /* several cookies? */ + if (Z_TYPE_PP(header) == IS_ARRAY) { + zval **cookie; + + FOREACH_HASH_VAL(Z_ARRVAL_PP(header), cookie) { + zval *cookie_hash; + MAKE_STD_ZVAL(cookie_hash); + array_init(cookie_hash); + + if (SUCCESS == http_parse_cookie(Z_STRVAL_PP(cookie), Z_ARRVAL_P(cookie_hash))) { + if (!cookie_len) { + add_next_index_zval(return_value, cookie_hash); + } else { + zval **name; + + if ( (SUCCESS == zend_hash_find(Z_ARRVAL_P(cookie_hash), "name", sizeof("name"), (void **) &name)) && + (!strcmp(Z_STRVAL_PP(name), cookie_name))) { + add_next_index_zval(return_value, cookie_hash); + return; /* <<< FOUND >>> */ + } else { + zval_dtor(cookie_hash); + efree(cookie_hash); + } + } + } else { + zval_dtor(cookie_hash); + efree(cookie_hash); + } + } + } else { + zval *cookie_hash; + MAKE_STD_ZVAL(cookie_hash); + array_init(cookie_hash); + + if (SUCCESS == http_parse_cookie(Z_STRVAL_PP(header), Z_ARRVAL_P(cookie_hash))) { + if (!cookie_len) { + add_next_index_zval(return_value, cookie_hash); + } else { + zval **name; + + if ( (SUCCESS == zend_hash_find(Z_ARRVAL_P(cookie_hash), "name", sizeof("name"), (void **) &name)) && + (!strcmp(Z_STRVAL_PP(name), cookie_name))) { + add_next_index_zval(return_value, cookie_hash); + } else { + zval_dtor(cookie_hash); + efree(cookie_hash); + } + } + } else { + zval_dtor(cookie_hash); + efree(cookie_hash); + } + } + break; + } + /* reset key */ + key = NULL; + } + } + } + /* }}} */ + + /* {{{ proto string HttpRequest::getResponseBody() + * + * Get the response body after the request has been sent. + */ + PHP_METHOD(HttpRequest, getResponseBody) + { + zval *data, **body; + getObject(http_request_object, obj); + + NO_ARGS; + + data = GET_PROP(obj, responseData); + 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 { + RETURN_FALSE; + } + } + /* }}} */ + + /* {{{ proto int HttpRequest::getResponseCode() + * + * Get the response code after the request has been sent. + */ + PHP_METHOD(HttpRequest, getResponseCode) + { + zval *code; + getObject(http_request_object, obj); + + NO_ARGS; + + code = GET_PROP(obj, responseCode); + RETURN_LONG(Z_LVAL_P(code)); + } + /* }}} */ + + /* {{{ 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); + + 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 { + http_error_ex(E_NOTICE, HTTP_E_PARAM, "Could not find response info named %s", info_name); + RETURN_FALSE; + } + } else { + array_init(return_value); + array_copy(info, return_value); + } + } + /* }}}*/ + + /* {{{ proto HttpMessage HttpRequest::getResponseMessage() + * + * Get the full response as HttpMessage object. + */ + PHP_METHOD(HttpRequest, getResponseMessage) + { + zval *message; + getObject(http_request_object, obj); + + NO_ARGS; + + message = GET_PROP(obj, responseMessage); + Z_TYPE_P(return_value) = IS_OBJECT; + return_value->is_ref = 1; + return_value->value.obj = message->value.obj; + zval_add_ref(&return_value); + } + + /* {{{ proto bool HttpRequest::send() + * + * Send the HTTP request. + * + * GET example: + *
+
  * setOptions(array('lastmodified' => filemtime('local.rss')));
+
  * $r->addQueryData(array('category' => 3));
+
  * try {
+
  *     $r->send();
+
  *     if ($r->getResponseCode() == 200) {
+
  *         file_put_contents('local.rss', $r->getResponseBody());
+
  *    }
+
  * } catch (HttpException $ex) {
+
  *     echo $ex;
+
  * }
+
  * ?>
+
  * 
+ * + * 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(HttpRequest, send) + { + STATUS status = FAILURE; + zval *meth, *URL, *qdata, *opts, *info, *resp; + char *request_uri; + getObject(http_request_object, obj); + + NO_ARGS; + + SET_EH_THROW_HTTP(); + + if ((!obj->ch) && (!(obj->ch = curl_easy_init()))) { + http_error(E_WARNING, HTTP_E_CURL, "Could not initilaize curl"); + RETURN_FALSE; + } + + meth = GET_PROP(obj, method); + URL = GET_PROP(obj, url); + qdata = GET_PROP(obj, queryData); + opts = GET_PROP(obj, options); + info = GET_PROP(obj, responseInfo); + resp = GET_PROP(obj, responseData); + + // 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, '?')) { + strcat(request_uri, "?"); + } else { + strcat(request_uri, "&"); + } + strncat(request_uri, Z_STRVAL_P(qdata), HTTP_URI_MAXLEN - strlen(request_uri)); + } + + switch (Z_LVAL_P(meth)) + { + case HTTP_GET: + case HTTP_HEAD: + status = http_request_ex(obj->ch, Z_LVAL_P(meth), request_uri, NULL, Z_ARRVAL_P(opts), Z_ARRVAL_P(info), &obj->response); + break; + + case HTTP_PUT: + break; + + case HTTP_POST: + default: + { + http_request_body body; + zval *fields = GET_PROP(obj, postData), *files = GET_PROP(obj, postFiles); + + if (SUCCESS == (status = http_request_body_fill(&body, Z_ARRVAL_P(fields), Z_ARRVAL_P(files)))) { + status = http_request_ex(obj->ch, Z_LVAL_P(meth), request_uri, &body, Z_ARRVAL_P(opts), Z_ARRVAL_P(info), &obj->response); + http_request_body_dtor(&body); + } + } + break; + } + + efree(request_uri); + + /* final data handling */ + if (status == SUCCESS) { + http_message *msg; + + if (msg = http_message_parse(PHPSTR_VAL(&obj->response), PHPSTR_LEN(&obj->response))) { + zval *headers, *message; + char *body; + size_t body_len; + + UPD_PROP(obj, long, responseCode, msg->info.response.code); + + MAKE_STD_ZVAL(headers) + array_init(headers); + + zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); + phpstr_data(PHPSTR(msg), &body, &body_len); + + add_assoc_zval(resp, "headers", headers); + add_assoc_stringl(resp, "body", body, body_len, 0); + + message = GET_PROP(obj, responseMessage); + zval_dtor(message); + Z_TYPE_P(message) = IS_OBJECT; + message->value.obj = http_message_object_from_msg(msg); + SET_PROP(obj, responseMessage, message); + } else { + status = FAILURE; + } + } + + SET_EH_NORMAL(); + RETURN_SUCCESS(status); + } + /* }}} */ + /* }}} */ + #endif /* HTTP_HAVE_CURL */ + + #endif /* ZEND_ENGINE_2 */ + + /* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * End: + * vim600: noet sw=4 ts=4 fdm=marker + * vim<600: noet sw=4 ts=4 + */ + diff --git a/http_request_object.c b/http_request_object.c index 2cfe21a..c9bbbde 100644 --- a/http_request_object.c +++ b/http_request_object.c @@ -1,209 +1,418 @@ /* + +----------------------------------------------------------------------+ + | 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 | + +----------------------------------------------------------------------+ + */ + + /* $Id$ */ + + + #ifdef HAVE_CONFIG_H + # include "config.h" + #endif + + #ifdef HTTP_HAVE_CURL + # ifdef PHP_WIN32 + # include + # endif + # include + #endif + + #include "php.h" + + #include "php_http_std_defs.h" + #include "php_http_request_object.h" + #include "php_http_request_api.h" + + #ifdef ZEND_ENGINE_2 + #ifdef HTTP_HAVE_CURL + + #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C) + static inline void _http_request_object_declare_default_properties(TSRMLS_D); + + zend_class_entry *http_request_object_ce; + zend_function_entry http_request_object_fe[] = { + PHP_ME(HttpRequest, __construct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR) + PHP_ME(HttpRequest, __destruct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR) + + PHP_ME(HttpRequest, setOptions, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getOptions, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetOptions, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, setSslOptions, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getSslOptions, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetSslOptions, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, addHeaders, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getHeaders, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetHeaders, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, addCookies, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getCookies, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetCookies, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, setMethod, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getMethod, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, setURL, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getURL, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, setContentType, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getContentType, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, setQueryData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getQueryData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, addQueryData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetQueryData, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, setPostData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getPostData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, addPostData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetPostData, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, addPostFile, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getPostFiles, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, unsetPostFiles, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, send, NULL, ZEND_ACC_PUBLIC) + + PHP_ME(HttpRequest, getResponseData, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getResponseHeader, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getResponseCookie, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getResponseCode, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getResponseBody, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getResponseInfo, NULL, ZEND_ACC_PUBLIC) + PHP_ME(HttpRequest, getResponseMessage, NULL, ZEND_ACC_PUBLIC) + + {NULL, NULL, NULL} + }; + static zend_object_handlers http_request_object_handlers; + + void _http_request_object_init(INIT_FUNC_ARGS) + { + HTTP_REGISTER_CLASS_EX(HttpRequest, http_request_object, NULL, 0); + + /* HTTP/1.1 */ + HTTP_LONG_CONSTANT("HTTP_GET", HTTP_GET); + HTTP_LONG_CONSTANT("HTTP_HEAD", HTTP_HEAD); + HTTP_LONG_CONSTANT("HTTP_POST", HTTP_POST); + HTTP_LONG_CONSTANT("HTTP_PUT", HTTP_PUT); + HTTP_LONG_CONSTANT("HTTP_DELETE", HTTP_DELETE); + HTTP_LONG_CONSTANT("HTTP_OPTIONS", HTTP_OPTIONS); + HTTP_LONG_CONSTANT("HTTP_TRACE", HTTP_TRACE); + HTTP_LONG_CONSTANT("HTTP_CONNECT", HTTP_CONNECT); + /* WebDAV - RFC 2518 */ + HTTP_LONG_CONSTANT("HTTP_PROPFIND", HTTP_PROPFIND); + HTTP_LONG_CONSTANT("HTTP_PROPPATCH", HTTP_PROPPATCH); + HTTP_LONG_CONSTANT("HTTP_MKCOL", HTTP_MKCOL); + HTTP_LONG_CONSTANT("HTTP_COPY", HTTP_COPY); + HTTP_LONG_CONSTANT("HTTP_MOVE", HTTP_MOVE); + HTTP_LONG_CONSTANT("HTTP_LOCK", HTTP_LOCK); + HTTP_LONG_CONSTANT("HTTP_UNLOCK", HTTP_UNLOCK); + /* WebDAV Versioning - RFC 3253 */ + HTTP_LONG_CONSTANT("HTTP_VERSION_CONTROL", HTTP_VERSION_CONTROL); + HTTP_LONG_CONSTANT("HTTP_REPORT", HTTP_REPORT); + HTTP_LONG_CONSTANT("HTTP_CHECKOUT", HTTP_CHECKOUT); + HTTP_LONG_CONSTANT("HTTP_CHECKIN", HTTP_CHECKIN); + HTTP_LONG_CONSTANT("HTTP_UNCHECKOUT", HTTP_UNCHECKOUT); + HTTP_LONG_CONSTANT("HTTP_MKWORKSPACE", HTTP_MKWORKSPACE); + HTTP_LONG_CONSTANT("HTTP_UPDATE", HTTP_UPDATE); + HTTP_LONG_CONSTANT("HTTP_LABEL", HTTP_LABEL); + HTTP_LONG_CONSTANT("HTTP_MERGE", HTTP_MERGE); + HTTP_LONG_CONSTANT("HTTP_BASELINE_CONTROL", HTTP_BASELINE_CONTROL); + HTTP_LONG_CONSTANT("HTTP_MKACTIVITY", HTTP_MKACTIVITY); + /* WebDAV Access Control - RFC 3744 */ + HTTP_LONG_CONSTANT("HTTP_ACL", HTTP_ACL); + + + # if LIBCURL_VERSION_NUM >= 0x070a05 + HTTP_LONG_CONSTANT("HTTP_AUTH_BASIC", CURLAUTH_BASIC); + HTTP_LONG_CONSTANT("HTTP_AUTH_DIGEST", CURLAUTH_DIGEST); + HTTP_LONG_CONSTANT("HTTP_AUTH_NTLM", CURLAUTH_NTLM); + # endif /* LIBCURL_VERSION_NUM */ + } + + zend_object_value _http_request_object_new(zend_class_entry *ce TSRMLS_DC) + { + zend_object_value ov; + http_request_object *o; + + o = ecalloc(1, sizeof(http_request_object)); + o->zo.ce = ce; + o->ch = curl_easy_init(); + + phpstr_init_ex(&o->response, HTTP_CURLBUF_SIZE, 0); + + ALLOC_HASHTABLE(OBJ_PROP(o)); + zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0); + zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); + + ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_request_object_free, NULL TSRMLS_CC); + ov.handlers = &http_request_object_handlers; + + return ov; + } + + static inline void _http_request_object_declare_default_properties(TSRMLS_D) + { + zend_class_entry *ce = http_request_object_ce; + + DCL_PROP_N(PROTECTED, options); + DCL_PROP_N(PROTECTED, responseInfo); + DCL_PROP_N(PROTECTED, responseData); + DCL_PROP_N(PROTECTED, responseCode); + DCL_PROP_N(PROTECTED, responseMessage); + DCL_PROP_N(PROTECTED, postData); + DCL_PROP_N(PROTECTED, postFiles); + + DCL_PROP(PROTECTED, long, method, HTTP_GET); + + DCL_PROP(PROTECTED, string, url, ""); + DCL_PROP(PROTECTED, string, contentType, ""); + DCL_PROP(PROTECTED, string, queryData, ""); + DCL_PROP(PROTECTED, string, postData, ""); + } + + void _http_request_object_free(zend_object *object TSRMLS_DC) + { + http_request_object *o = (http_request_object *) object; + + if (OBJ_PROP(o)) { + zend_hash_destroy(OBJ_PROP(o)); + FREE_HASHTABLE(OBJ_PROP(o)); + } + if (o->ch) { + curl_easy_cleanup(o->ch); + } + phpstr_dtor(&o->response); + efree(o); + } + + #endif /* HTTP_HAVE_CURL */ + #endif /* ZEND_ENGINE_2 */ + + /* + * Local variables: + * tab-width: 4 + * c-basic-offset: 4 + * End: + * vim600: noet sw=4 ts=4 fdm=marker + * vim<600: noet sw=4 ts=4 + */ + +