2016-06-18 12:46:12 +00:00
/*************************************************************************/
/* http_request.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
2016-06-18 12:46:12 +00:00
/*************************************************************************/
2021-01-01 19:13:46 +00:00
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
2016-06-18 12:46:12 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2018-01-04 23:50:27 +00:00
2016-03-04 14:09:45 +00:00
# ifndef HTTPREQUEST_H
# define HTTPREQUEST_H
2018-09-11 16:13:45 +00:00
# include "core/io/http_client.h"
# include "core/os/file_access.h"
# include "core/os/thread.h"
2021-01-31 12:34:42 +00:00
# include "core/safe_refcount.h"
2017-03-05 15:44:50 +00:00
# include "node.h"
2019-07-04 13:17:52 +00:00
# include "scene/main/timer.h"
2016-03-04 14:09:45 +00:00
class HTTPRequest : public Node {
2017-03-05 15:44:50 +00:00
GDCLASS ( HTTPRequest , Node ) ;
2016-03-04 14:09:45 +00:00
2017-03-05 15:44:50 +00:00
public :
2016-03-04 14:09:45 +00:00
enum Result {
RESULT_SUCCESS ,
RESULT_CHUNKED_BODY_SIZE_MISMATCH ,
RESULT_CANT_CONNECT ,
RESULT_CANT_RESOLVE ,
RESULT_CONNECTION_ERROR ,
RESULT_SSL_HANDSHAKE_ERROR ,
RESULT_NO_RESPONSE ,
RESULT_BODY_SIZE_LIMIT_EXCEEDED ,
RESULT_REQUEST_FAILED ,
2016-03-12 13:44:12 +00:00
RESULT_DOWNLOAD_FILE_CANT_OPEN ,
RESULT_DOWNLOAD_FILE_WRITE_ERROR ,
2019-07-04 13:17:52 +00:00
RESULT_REDIRECT_LIMIT_REACHED ,
RESULT_TIMEOUT
2016-03-04 14:09:45 +00:00
} ;
private :
bool requesting ;
String request_string ;
String url ;
int port ;
Vector < String > headers ;
bool validate_ssl ;
bool use_ssl ;
2016-08-31 20:59:09 +00:00
HTTPClient : : Method method ;
String request_data ;
2016-03-04 14:09:45 +00:00
bool request_sent ;
Ref < HTTPClient > client ;
2017-01-11 03:52:51 +00:00
PoolByteArray body ;
2021-01-31 12:34:42 +00:00
SafeFlag use_threads ;
2016-03-04 14:09:45 +00:00
bool got_response ;
int response_code ;
2017-01-07 21:25:37 +00:00
PoolVector < String > response_headers ;
2016-03-04 14:09:45 +00:00
2016-03-12 13:44:12 +00:00
String download_to_file ;
FileAccess * file ;
2016-03-04 14:09:45 +00:00
2016-03-12 13:44:12 +00:00
int body_len ;
2021-01-31 12:34:42 +00:00
SafeNumeric < int > downloaded ;
2016-03-04 14:09:45 +00:00
int body_size_limit ;
int redirections ;
bool _update_connection ( ) ;
int max_redirects ;
2019-07-04 13:17:52 +00:00
int timeout ;
2017-03-05 15:44:50 +00:00
void _redirect_request ( const String & p_new_url ) ;
2016-07-24 19:09:43 +00:00
2016-03-12 13:44:12 +00:00
bool _handle_response ( bool * ret_value ) ;
2017-03-05 15:44:50 +00:00
Error _parse_url ( const String & p_url ) ;
2016-03-04 14:09:45 +00:00
Error _request ( ) ;
2021-01-31 12:34:42 +00:00
SafeFlag thread_done ;
SafeFlag thread_request_quit ;
2016-07-24 19:09:43 +00:00
2021-01-27 19:10:10 +00:00
Thread thread ;
2016-07-24 19:09:43 +00:00
2017-03-05 15:44:50 +00:00
void _request_done ( int p_status , int p_code , const PoolStringArray & headers , const PoolByteArray & p_data ) ;
2016-07-24 19:09:43 +00:00
static void _thread_func ( void * p_userdata ) ;
2016-03-12 13:44:12 +00:00
2016-03-04 14:09:45 +00:00
protected :
void _notification ( int p_what ) ;
static void _bind_methods ( ) ;
2017-03-05 15:44:50 +00:00
public :
Error request ( const String & p_url , const Vector < String > & p_custom_headers = Vector < String > ( ) , 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
2016-03-04 14:09:45 +00:00
void cancel_request ( ) ;
HTTPClient : : Status get_http_client_status ( ) const ;
void set_use_threads ( bool p_use ) ;
bool is_using_threads ( ) const ;
2017-03-05 15:44:50 +00:00
void set_download_file ( const String & p_file ) ;
2016-03-12 13:44:12 +00:00
String get_download_file ( ) const ;
2019-11-24 12:20:24 +00:00
void set_download_chunk_size ( int p_chunk_size ) ;
int get_download_chunk_size ( ) const ;
2016-03-04 14:09:45 +00:00
void set_body_size_limit ( int p_bytes ) ;
int get_body_size_limit ( ) const ;
void set_max_redirects ( int p_max ) ;
int get_max_redirects ( ) const ;
2019-07-04 13:17:52 +00:00
Timer * timer ;
void set_timeout ( int p_timeout ) ;
int get_timeout ( ) ;
void _timeout ( ) ;
2016-03-12 13:44:12 +00:00
int get_downloaded_bytes ( ) const ;
int get_body_size ( ) const ;
2016-03-04 14:09:45 +00:00
HTTPRequest ( ) ;
2016-03-12 13:44:12 +00:00
~ HTTPRequest ( ) ;
2016-03-04 14:09:45 +00:00
} ;
2017-08-20 15:45:01 +00:00
VARIANT_ENUM_CAST ( HTTPRequest : : Result ) ;
2016-03-04 14:09:45 +00:00
# endif // HTTPREQUEST_H