From 6c4bb3fc4a8af7ffd819d86db59008a702d08067 Mon Sep 17 00:00:00 2001 From: Fabio Alessandrelli Date: Wed, 13 Oct 2021 15:24:31 +0200 Subject: [PATCH] Revert HTTPRequest gzip compression support. Partial revert of commit c1135cf0063016ce9abacc23d987becaaef5aa9a. --- doc/classes/HTTPRequest.xml | 24 +++------- scene/main/http_request.cpp | 96 +------------------------------------ scene/main/http_request.h | 9 ---- 3 files changed, 8 insertions(+), 121 deletions(-) diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index ba0289f439f..89852a087d5 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -65,10 +65,6 @@ add_child(texture_rect) texture_rect.texture = texture [/codeblock] - [b]Gzipped response bodies[/b] - HttpRequest will automatically handle decompression of response bodies. - A "Accept-Encoding" header will be automatically added to each of your requests, unless one is already specified. - Any response with a "Content-Encoding: gzip" header will automatically be decompressed and delivered to you as a uncompressed bytes. https://docs.godotengine.org/en/3.4/tutorials/networking/http_request_class.html @@ -127,14 +123,8 @@ - - If [code]true[/code], this header will be added to each request: [code]Accept-Encoding: gzip, deflate[/code] telling servers that it's okay to compress response bodies. - Any Reponse body declaring a [code]Content-Encoding[/code] of either [code]gzip[/code] or [code]deflate[/code] will then be automatically decompressed, and the uncompressed bytes will be delivered via [code]request_completed[/code]. - If the user has specified their own [code]Accept-Encoding[/code] header, then no header will be added regaurdless of [code]accept_gzip[/code]. - If [code]false[/code] no header will be added, and no decompression will be performed on response bodies. The raw bytes of the response body will be returned via [code]request_completed[/code]. - - Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body. + Maximum allowed size for response bodies. The size of the buffer used and maximum bytes to read per iteration. See [member HTTPClient.read_chunk_size]. @@ -184,24 +174,22 @@ Request does not have a response (yet). - - Request exceeded its maximum size limit, see [member body_size_limit]. - + Request failed (currently unused). - + HTTPRequest couldn't open the download file. - + HTTPRequest couldn't write to the download file. - + Request reached its maximum redirect limit, see [member max_redirects]. - + diff --git a/scene/main/http_request.cpp b/scene/main/http_request.cpp index 7ba4ea1ffef..7002b10fd46 100644 --- a/scene/main/http_request.cpp +++ b/scene/main/http_request.cpp @@ -29,8 +29,6 @@ /*************************************************************************/ #include "http_request.h" -#include "core/io/compression.h" -#include "core/ustring.h" void HTTPRequest::_redirect_request(const String &p_new_url) { } @@ -67,37 +65,6 @@ Error HTTPRequest::_parse_url(const String &p_url) { return OK; } -bool HTTPRequest::has_header(const Vector &p_headers, const String &p_header_name) { - bool exists = false; - - String lower_case_header_name = p_header_name.to_lower(); - for (int i = 0; i < p_headers.size() && !exists; i++) { - String sanitized = p_headers[i].strip_edges().to_lower(); - if (sanitized.begins_with(lower_case_header_name)) { - exists = true; - } - } - - return exists; -} - -String HTTPRequest::get_header_value(const PoolStringArray &p_headers, const String &p_header_name) { - String value = ""; - - String lowwer_case_header_name = p_header_name.to_lower(); - for (int i = 0; i < p_headers.size(); i++) { - if (p_headers[i].find(":", 0) >= 0) { - Vector parts = p_headers[i].split(":", false, 1); - if (parts[0].strip_edges().to_lower() == lowwer_case_header_name) { - value = parts[1].strip_edges(); - break; - } - } - } - - return value; -} - Error HTTPRequest::request(const String &p_url, const Vector &p_custom_headers, bool p_ssl_validate_domain, HTTPClient::Method p_method, const String &p_request_data) { // Copy the string into a raw buffer PoolVector raw_data; @@ -130,13 +97,6 @@ Error HTTPRequest::request_raw(const String &p_url, const Vector &p_cust headers = p_custom_headers; - if (accept_gzip) { - // If the user has specified a different Accept-Encoding, don't overwrite it - if (!has_header(headers, "Accept-Encoding")) { - headers.push_back("Accept-Encoding: gzip, deflate"); - } - } - request_data = p_request_data_raw; requesting = true; @@ -423,45 +383,7 @@ bool HTTPRequest::_update_connection() { void HTTPRequest::_request_done(int p_status, int p_code, const PoolStringArray &p_headers, const PoolByteArray &p_data) { cancel_request(); - - // Determine if the request body is compressed - bool is_compressed; - String content_encoding = get_header_value(p_headers, "Content-Encoding").to_lower(); - Compression::Mode mode; - if (content_encoding == "gzip") { - mode = Compression::Mode::MODE_GZIP; - is_compressed = true; - } else if (content_encoding == "deflate") { - mode = Compression::Mode::MODE_DEFLATE; - is_compressed = true; - } else { - is_compressed = false; - } - - const PoolByteArray *data = NULL; - - if (accept_gzip && is_compressed && p_data.size() > 0) { - // Decompress request body - PoolByteArray *decompressed = memnew(PoolByteArray); - int result = Compression::decompress_dynamic(decompressed, body_size_limit, p_data.read().ptr(), p_data.size(), mode); - if (result == OK) { - data = decompressed; - } else if (result == -5) { - WARN_PRINT("Decompressed size of HTTP response body exceeded body_size_limit"); - p_status = RESULT_BODY_SIZE_LIMIT_EXCEEDED; - // Just return the raw data if we failed to decompress it - data = &p_data; - } else { - WARN_PRINT("Failed to decompress HTTP response body"); - p_status = RESULT_BODY_DECOMPRESS_FAILED; - // Just return the raw data if we failed to decompress it - data = &p_data; - } - } else { - data = &p_data; - } - - emit_signal("request_completed", p_status, p_code, p_headers, *data); + emit_signal("request_completed", p_status, p_code, headers, p_data); } void HTTPRequest::_notification(int p_what) { @@ -483,14 +405,6 @@ void HTTPRequest::_notification(int p_what) { } } -void HTTPRequest::set_accept_gzip(bool p_gzip) { - accept_gzip = p_gzip; -} - -bool HTTPRequest::is_accepting_gzip() const { - return accept_gzip; -} - void HTTPRequest::set_use_threads(bool p_use) { ERR_FAIL_COND(get_http_client_status() != HTTPClient::STATUS_DISCONNECTED); use_threads.set_to(p_use); @@ -564,8 +478,8 @@ void HTTPRequest::_timeout() { } void HTTPRequest::_bind_methods() { - ClassDB::bind_method(D_METHOD("request", "url", "custom_headers", "ssl_validate_domain", "method", "request_data"), &HTTPRequest::request, DEFVAL(PoolStringArray()), DEFVAL(true), DEFVAL(HTTPClient::METHOD_GET), DEFVAL(String())); ClassDB::bind_method(D_METHOD("request_raw", "url", "custom_headers", "ssl_validate_domain", "method", "request_data_raw"), &HTTPRequest::request_raw, DEFVAL(PoolStringArray()), DEFVAL(true), DEFVAL(HTTPClient::METHOD_GET), DEFVAL(PoolVector())); + ClassDB::bind_method(D_METHOD("request", "url", "custom_headers", "ssl_validate_domain", "method", "request_data"), &HTTPRequest::request, DEFVAL(PoolStringArray()), DEFVAL(true), DEFVAL(HTTPClient::METHOD_GET), DEFVAL(String())); ClassDB::bind_method(D_METHOD("cancel_request"), &HTTPRequest::cancel_request); ClassDB::bind_method(D_METHOD("get_http_client_status"), &HTTPRequest::get_http_client_status); @@ -573,9 +487,6 @@ void HTTPRequest::_bind_methods() { ClassDB::bind_method(D_METHOD("set_use_threads", "enable"), &HTTPRequest::set_use_threads); ClassDB::bind_method(D_METHOD("is_using_threads"), &HTTPRequest::is_using_threads); - ClassDB::bind_method(D_METHOD("set_accept_gzip", "enable"), &HTTPRequest::set_accept_gzip); - ClassDB::bind_method(D_METHOD("is_accepting_gzip"), &HTTPRequest::is_accepting_gzip); - ClassDB::bind_method(D_METHOD("set_body_size_limit", "bytes"), &HTTPRequest::set_body_size_limit); ClassDB::bind_method(D_METHOD("get_body_size_limit"), &HTTPRequest::get_body_size_limit); @@ -602,7 +513,6 @@ void HTTPRequest::_bind_methods() { ADD_PROPERTY(PropertyInfo(Variant::STRING, "download_file", PROPERTY_HINT_FILE), "set_download_file", "get_download_file"); ADD_PROPERTY(PropertyInfo(Variant::INT, "download_chunk_size", PROPERTY_HINT_RANGE, "256,16777216"), "set_download_chunk_size", "get_download_chunk_size"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "use_threads"), "set_use_threads", "is_using_threads"); - ADD_PROPERTY(PropertyInfo(Variant::BOOL, "accept_gzip"), "set_accept_gzip", "is_accepting_gzip"); ADD_PROPERTY(PropertyInfo(Variant::INT, "body_size_limit", PROPERTY_HINT_RANGE, "-1,2000000000"), "set_body_size_limit", "get_body_size_limit"); ADD_PROPERTY(PropertyInfo(Variant::INT, "max_redirects", PROPERTY_HINT_RANGE, "-1,64"), "set_max_redirects", "get_max_redirects"); ADD_PROPERTY(PropertyInfo(Variant::INT, "timeout", PROPERTY_HINT_RANGE, "0,86400"), "set_timeout", "get_timeout"); @@ -617,7 +527,6 @@ void HTTPRequest::_bind_methods() { BIND_ENUM_CONSTANT(RESULT_CONNECTION_ERROR); BIND_ENUM_CONSTANT(RESULT_SSL_HANDSHAKE_ERROR); BIND_ENUM_CONSTANT(RESULT_NO_RESPONSE); - BIND_ENUM_CONSTANT(RESULT_BODY_DECOMPRESS_FAILED); BIND_ENUM_CONSTANT(RESULT_BODY_SIZE_LIMIT_EXCEEDED); BIND_ENUM_CONSTANT(RESULT_REQUEST_FAILED); BIND_ENUM_CONSTANT(RESULT_DOWNLOAD_FILE_CANT_OPEN); @@ -634,7 +543,6 @@ HTTPRequest::HTTPRequest() { got_response = false; validate_ssl = false; use_ssl = false; - accept_gzip = true; response_code = 0; request_sent = false; requesting = false; diff --git a/scene/main/http_request.h b/scene/main/http_request.h index 3be0a5b6cf5..d7edae3071b 100644 --- a/scene/main/http_request.h +++ b/scene/main/http_request.h @@ -51,7 +51,6 @@ public: RESULT_SSL_HANDSHAKE_ERROR, RESULT_NO_RESPONSE, RESULT_BODY_SIZE_LIMIT_EXCEEDED, - RESULT_BODY_DECOMPRESS_FAILED, RESULT_REQUEST_FAILED, RESULT_DOWNLOAD_FILE_CANT_OPEN, RESULT_DOWNLOAD_FILE_WRITE_ERROR, @@ -77,7 +76,6 @@ private: PoolByteArray body; SafeFlag use_threads; - bool accept_gzip; bool got_response; int response_code; PoolVector response_headers; @@ -105,9 +103,6 @@ private: Error _parse_url(const String &p_url); Error _request(); - bool has_header(const Vector &p_headers, const String &p_header_name); - String get_header_value(const PoolStringArray &p_headers, const String &header_name); - SafeFlag thread_done; SafeFlag thread_request_quit; @@ -124,15 +119,11 @@ public: Error request(const String &p_url, const Vector &p_custom_headers = Vector(), bool p_ssl_validate_domain = true, HTTPClient::Method p_method = HTTPClient::METHOD_GET, const String &p_request_data = ""); //connects to a full url and perform request Error request_raw(const String &p_url, const Vector &p_custom_headers = Vector(), bool p_ssl_validate_domain = true, HTTPClient::Method p_method = HTTPClient::METHOD_GET, const PoolVector &p_request_data_raw = PoolVector()); //connects to a full url and perform request void cancel_request(); - HTTPClient::Status get_http_client_status() const; void set_use_threads(bool p_use); bool is_using_threads() const; - void set_accept_gzip(bool p_gzip); - bool is_accepting_gzip() const; - void set_download_file(const String &p_file); String get_download_file() const;