/*************************************************************************/ /* http_request.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* http://www.godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */ /* */ /* 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. */ /*************************************************************************/ #include "http_request.h" void HTTPRequest::set_ip_type(IP::Type p_type) { client->set_ip_type(p_type); } void HTTPRequest::_redirect_request(const String& p_new_url) { } Error HTTPRequest::_request() { //print_line("Requesting:\n\tURL: "+url+"\n\tString: "+request_string+"\n\tPort: "+itos(port)+"\n\tSSL: "+itos(use_ssl)+"\n\tValidate SSL: "+itos(validate_ssl)); return client->connect(url,port,use_ssl,validate_ssl); } Error HTTPRequest::_parse_url(const String& p_url) { url=p_url; use_ssl=false; request_string=""; port=80; request_sent=false; got_response=false; body_len=-1; body.resize(0); downloaded=0; redirections=0; //print_line("1 url: "+url); if (url.begins_with("http://")) { url=url.substr(7,url.length()-7); //print_line("no SSL"); } else if (url.begins_with("https://")) { url=url.substr(8,url.length()-8); use_ssl=true; port=443; //print_line("yes SSL"); } else { ERR_EXPLAIN("Malformed URL"); ERR_FAIL_V(ERR_INVALID_PARAMETER); } //print_line("2 url: "+url); int slash_pos = url.find("/"); if (slash_pos!=-1) { request_string=url.substr(slash_pos,url.length()); url=url.substr(0,slash_pos); //print_line("request string: "+request_string); } else { request_string="/"; //print_line("no request"); } //print_line("3 url: "+url); int colon_pos = url.find(":"); if (colon_pos!=-1) { port=url.substr(colon_pos+1,url.length()).to_int(); url=url.substr(0,colon_pos); ERR_FAIL_COND_V(port<1 || port > 65535,ERR_INVALID_PARAMETER); } //print_line("4 url: "+url); return OK; } 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) { ERR_FAIL_COND_V(!is_inside_tree(),ERR_UNCONFIGURED); if ( requesting ) { ERR_EXPLAIN("HTTPRequest is processing a request. Wait for completion or cancel it before attempting a new one."); ERR_FAIL_V(ERR_BUSY); } method=p_method; Error err = _parse_url(p_url); if (err) return err; validate_ssl=p_ssl_validate_domain; bool has_user_agent=false; bool has_accept=false; headers=p_custom_headers; request_data = p_request_data; for(int i=0;iget_name()+")"); } if (!has_accept) { headers.push_back("Accept: */*"); } requesting=true; if (use_threads) { thread_done=false; thread_request_quit=false; client->set_blocking_mode(true); thread=Thread::create(_thread_func,this); } else { client->set_blocking_mode(false); err = _request(); if (err!=OK) { call_deferred("_request_done",RESULT_CANT_CONNECT,0,StringArray(),ByteArray()); return ERR_CANT_CONNECT; } set_process(true); } return OK; } void HTTPRequest::_thread_func(void *p_userdata) { HTTPRequest *hr = (HTTPRequest*)p_userdata; Error err = hr->_request(); if (err!=OK) { hr->call_deferred("_request_done",RESULT_CANT_CONNECT,0,StringArray(),ByteArray()); } else { while(!hr->thread_request_quit) { bool exit = hr->_update_connection(); if (exit) break; OS::get_singleton()->delay_usec(1); } } hr->thread_done=true; } void HTTPRequest::cancel_request() { if (!requesting) return; if (!use_threads) { set_process(false); } else { thread_request_quit=true; Thread::wait_to_finish(thread); memdelete(thread); thread=NULL; } if (file) { memdelete(file); file=NULL; } client->close(); body.resize(0); //downloaded=0; got_response=false; response_code=-1; //body_len=-1; request_sent=false; requesting=false; } bool HTTPRequest::_handle_response(bool *ret_value) { if (!client->has_response()) { call_deferred("_request_done",RESULT_NO_RESPONSE,0,StringArray(),ByteArray()); *ret_value=true; return true; } got_response=true; response_code=client->get_response_code(); List rheaders; client->get_response_headers(&rheaders); response_headers.resize(0); downloaded=0; for (List::Element *E=rheaders.front();E;E=E->next()) { //print_line("HEADER: "+E->get()); response_headers.push_back(E->get()); } if (response_code==301 || response_code==302) { //redirect if (max_redirects>=0 && redirections>=max_redirects) { call_deferred("_request_done",RESULT_REDIRECT_LIMIT_REACHED,response_code,response_headers,ByteArray()); *ret_value=true; return true; } String new_request; for (List::Element *E=rheaders.front();E;E=E->next()) { if (E->get().findn("Location: ")!=-1) { new_request=E->get().substr(9,E->get().length()).strip_edges(); } } //print_line("NEW LOCATION: "+new_request); if (new_request!="") { //process redirect client->close(); int new_redirs=redirections+1; //because _request() will clear it Error err; if (new_request.begins_with("http")) { //new url, request all again err=_parse_url(new_request); } else { request_string=new_request; } err = _request(); //print_line("new connection: "+itos(err)); if (err==OK) { request_sent=false; got_response=false; body_len=-1; body.resize(0); downloaded=0; redirections=new_redirs; *ret_value=false; return true; } } } return false; } bool HTTPRequest::_update_connection() { switch( client->get_status() ) { case HTTPClient::STATUS_DISCONNECTED: { call_deferred("_request_done",RESULT_CANT_CONNECT,0,StringArray(),ByteArray()); return true; //end it, since it's doing something } break; case HTTPClient::STATUS_RESOLVING: { client->poll(); //must wait return false; } break; case HTTPClient::STATUS_CANT_RESOLVE: { call_deferred("_request_done",RESULT_CANT_RESOLVE,0,StringArray(),ByteArray()); return true; } break; case HTTPClient::STATUS_CONNECTING: { client->poll(); //must wait return false; } break; //connecting to ip case HTTPClient::STATUS_CANT_CONNECT: { call_deferred("_request_done",RESULT_CANT_CONNECT,0,StringArray(),ByteArray()); return true; } break; case HTTPClient::STATUS_CONNECTED: { if (request_sent) { if (!got_response) { //no body bool ret_value; if (_handle_response(&ret_value)) return ret_value; call_deferred("_request_done",RESULT_SUCCESS,response_code,response_headers,ByteArray()); return true; } if (got_response && body_len<0) { //chunked transfer is done call_deferred("_request_done",RESULT_SUCCESS,response_code,response_headers,body); return true; } call_deferred("_request_done",RESULT_CHUNKED_BODY_SIZE_MISMATCH,response_code,response_headers,ByteArray()); return true; //request migh have been done } else { //did not request yet, do request Error err = client->request(method,request_string,headers,request_data); if (err!=OK) { call_deferred("_request_done",RESULT_CONNECTION_ERROR,0,StringArray(),ByteArray()); return true; } request_sent=true; return false; } } break; //connected: { } break requests only accepted here case HTTPClient::STATUS_REQUESTING: { //must wait, it's requesting client->poll(); return false; } break; // request in progress case HTTPClient::STATUS_BODY: { if (!got_response) { bool ret_value; if (_handle_response(&ret_value)) return ret_value; if (!client->is_response_chunked() && client->get_response_body_length()==0) { call_deferred("_request_done",RESULT_SUCCESS,response_code,response_headers,ByteArray()); return true; } if (client->is_response_chunked()) { body_len=-1; //no body len because chunked, change your webserver configuration if you want body len } else { body_len=client->get_response_body_length(); if (body_size_limit>=0 && body_len>body_size_limit) { call_deferred("_request_done",RESULT_BODY_SIZE_LIMIT_EXCEEDED,response_code,response_headers,ByteArray()); return true; } } if (download_to_file!=String()) { file=FileAccess::open(download_to_file,FileAccess::WRITE); if (!file) { call_deferred("_request_done",RESULT_DOWNLOAD_FILE_CANT_OPEN,response_code,response_headers,ByteArray()); return true; } } } //print_line("BODY: "+itos(body.size())); client->poll(); ByteArray chunk = client->read_response_body_chunk(); downloaded+=chunk.size(); if (file) { ByteArray::Read r=chunk.read(); file->store_buffer(r.ptr(),chunk.size()); if (file->get_error()!=OK) { call_deferred("_request_done",RESULT_DOWNLOAD_FILE_WRITE_ERROR,response_code,response_headers,ByteArray()); return true; } } else { body.append_array(chunk); } if (body_size_limit>=0 && downloaded>body_size_limit) { call_deferred("_request_done",RESULT_BODY_SIZE_LIMIT_EXCEEDED,response_code,response_headers,ByteArray()); return true; } if (body_len>=0) { if (downloaded==body_len) { call_deferred("_request_done",RESULT_SUCCESS,response_code,response_headers,body); return true; } /*if (body.size()>=body_len) { call_deferred("_request_done",RESULT_BODY_SIZE_MISMATCH,response_code,response_headers,ByteArray()); return true; }*/ } return false; } break; // request resulted in body: { } break which must be read case HTTPClient::STATUS_CONNECTION_ERROR: { call_deferred("_request_done",RESULT_CONNECTION_ERROR,0,StringArray(),ByteArray()); return true; } break; case HTTPClient::STATUS_SSL_HANDSHAKE_ERROR: { call_deferred("_request_done",RESULT_SSL_HANDSHAKE_ERROR,0,StringArray(),ByteArray()); return true; } break; } ERR_FAIL_V(false); } void HTTPRequest::_request_done(int p_status, int p_code, const StringArray& headers, const ByteArray& p_data) { cancel_request(); emit_signal("request_completed",p_status,p_code,headers,p_data); } void HTTPRequest::_notification(int p_what) { if (p_what==NOTIFICATION_PROCESS) { if (use_threads) return; bool done = _update_connection(); if (done) { set_process(false); //cancel_request(); called from _request done now } } if (p_what==NOTIFICATION_EXIT_TREE) { if (requesting) { cancel_request(); } } } void HTTPRequest::set_use_threads(bool p_use) { ERR_FAIL_COND( status!=HTTPClient::STATUS_DISCONNECTED ); use_threads=p_use; } bool HTTPRequest::is_using_threads() const { return use_threads; } void HTTPRequest::set_body_size_limit(int p_bytes) { ERR_FAIL_COND( status!=HTTPClient::STATUS_DISCONNECTED ); body_size_limit=p_bytes; } int HTTPRequest::get_body_size_limit() const { return body_size_limit; } void HTTPRequest::set_download_file(const String& p_file) { ERR_FAIL_COND( status!=HTTPClient::STATUS_DISCONNECTED ); download_to_file=p_file; } String HTTPRequest::get_download_file() const { return download_to_file; } HTTPClient::Status HTTPRequest::get_http_client_status() const { return client->get_status(); } void HTTPRequest::set_max_redirects(int p_max) { max_redirects=p_max; } int HTTPRequest::get_max_redirects() const{ return max_redirects; } int HTTPRequest::get_downloaded_bytes() const { return downloaded; } int HTTPRequest::get_body_size() const{ return body_len; } void HTTPRequest::_bind_methods() { ClassDB::bind_method(_MD("set_ip_type","ip_type"),&HTTPRequest::set_ip_type); ClassDB::bind_method(_MD("request","url","custom_headers","ssl_validate_domain","method","request_data"),&HTTPRequest::request,DEFVAL(StringArray()),DEFVAL(true),DEFVAL(HTTPClient::METHOD_GET),DEFVAL(String())); ClassDB::bind_method(_MD("cancel_request"),&HTTPRequest::cancel_request); ClassDB::bind_method(_MD("get_http_client_status"),&HTTPRequest::get_http_client_status); ClassDB::bind_method(_MD("set_use_threads","enable"),&HTTPRequest::set_use_threads); ClassDB::bind_method(_MD("is_using_threads"),&HTTPRequest::is_using_threads); ClassDB::bind_method(_MD("set_body_size_limit","bytes"),&HTTPRequest::set_body_size_limit); ClassDB::bind_method(_MD("get_body_size_limit"),&HTTPRequest::get_body_size_limit); ClassDB::bind_method(_MD("set_max_redirects","amount"),&HTTPRequest::set_max_redirects); ClassDB::bind_method(_MD("get_max_redirects"),&HTTPRequest::get_max_redirects); ClassDB::bind_method(_MD("set_download_file","path"),&HTTPRequest::set_download_file); ClassDB::bind_method(_MD("get_download_file"),&HTTPRequest::get_download_file); ClassDB::bind_method(_MD("get_downloaded_bytes"),&HTTPRequest::get_downloaded_bytes); ClassDB::bind_method(_MD("get_body_size"),&HTTPRequest::get_body_size); ClassDB::bind_method(_MD("_redirect_request"),&HTTPRequest::_redirect_request); ClassDB::bind_method(_MD("_request_done"),&HTTPRequest::_request_done); ADD_PROPERTY(PropertyInfo(Variant::BOOL,"use_threads"),_SCS("set_use_threads"),_SCS("is_using_threads")); ADD_PROPERTY(PropertyInfo(Variant::INT,"body_size_limit",PROPERTY_HINT_RANGE,"-1,2000000000"),_SCS("set_body_size_limit"),_SCS("get_body_size_limit")); ADD_PROPERTY(PropertyInfo(Variant::INT,"max_redirects",PROPERTY_HINT_RANGE,"-1,1024"),_SCS("set_max_redirects"),_SCS("get_max_redirects")); ADD_SIGNAL(MethodInfo("request_completed",PropertyInfo(Variant::INT,"result"),PropertyInfo(Variant::INT,"response_code"),PropertyInfo(Variant::STRING_ARRAY,"headers"),PropertyInfo(Variant::RAW_ARRAY,"body"))); BIND_CONSTANT( RESULT_SUCCESS ); //BIND_CONSTANT( RESULT_NO_BODY ); BIND_CONSTANT( RESULT_CHUNKED_BODY_SIZE_MISMATCH ); BIND_CONSTANT( RESULT_CANT_CONNECT ); BIND_CONSTANT( RESULT_CANT_RESOLVE ); BIND_CONSTANT( RESULT_CONNECTION_ERROR ); BIND_CONSTANT( RESULT_SSL_HANDSHAKE_ERROR ); BIND_CONSTANT( RESULT_NO_RESPONSE ); BIND_CONSTANT( RESULT_BODY_SIZE_LIMIT_EXCEEDED ); BIND_CONSTANT( RESULT_REQUEST_FAILED ); BIND_CONSTANT( RESULT_DOWNLOAD_FILE_CANT_OPEN ); BIND_CONSTANT( RESULT_DOWNLOAD_FILE_WRITE_ERROR ); BIND_CONSTANT( RESULT_REDIRECT_LIMIT_REACHED ); } HTTPRequest::HTTPRequest() { thread=NULL; port=80; redirections=0; max_redirects=8; body_len=-1; got_response=false; validate_ssl=false; use_ssl=false; response_code=0; request_sent=false; requesting=false; client.instance(); use_threads=false; thread_done=false; body_size_limit=-1; file=NULL; status=HTTPClient::STATUS_DISCONNECTED; } HTTPRequest::~HTTPRequest() { if (file) memdelete(file); }