http_client.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922
  1. /*************************************************************************/
  2. /* http_client.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "http_client.h"
  31. #include "core/io/stream_peer_ssl.h"
  32. #include "core/version.h"
  33. const char *HTTPClient::_methods[METHOD_MAX] = {
  34. "GET",
  35. "HEAD",
  36. "POST",
  37. "PUT",
  38. "DELETE",
  39. "OPTIONS",
  40. "TRACE",
  41. "CONNECT",
  42. "PATCH"
  43. };
  44. #ifndef JAVASCRIPT_ENABLED
  45. Error HTTPClient::connect_to_host(const String &p_host, int p_port, bool p_ssl, bool p_verify_host) {
  46. close();
  47. conn_port = p_port;
  48. conn_host = p_host;
  49. ssl = p_ssl;
  50. ssl_verify_host = p_verify_host;
  51. String host_lower = conn_host.to_lower();
  52. if (host_lower.begins_with("http://")) {
  53. conn_host = conn_host.substr(7, conn_host.length() - 7);
  54. } else if (host_lower.begins_with("https://")) {
  55. ssl = true;
  56. conn_host = conn_host.substr(8, conn_host.length() - 8);
  57. }
  58. ERR_FAIL_COND_V(conn_host.length() < HOST_MIN_LEN, ERR_INVALID_PARAMETER);
  59. if (conn_port < 0) {
  60. if (ssl) {
  61. conn_port = PORT_HTTPS;
  62. } else {
  63. conn_port = PORT_HTTP;
  64. }
  65. }
  66. connection = tcp_connection;
  67. if (conn_host.is_valid_ip_address()) {
  68. // Host contains valid IP
  69. Error err = tcp_connection->connect_to_host(IP_Address(conn_host), p_port);
  70. if (err) {
  71. status = STATUS_CANT_CONNECT;
  72. return err;
  73. }
  74. status = STATUS_CONNECTING;
  75. } else {
  76. // Host contains hostname and needs to be resolved to IP
  77. resolving = IP::get_singleton()->resolve_hostname_queue_item(conn_host);
  78. status = STATUS_RESOLVING;
  79. }
  80. return OK;
  81. }
  82. void HTTPClient::set_connection(const Ref<StreamPeer> &p_connection) {
  83. ERR_FAIL_COND_MSG(p_connection.is_null(), "Connection is not a reference to a valid StreamPeer object.");
  84. if (ssl) {
  85. ERR_FAIL_NULL_MSG(Object::cast_to<StreamPeerSSL>(p_connection.ptr()),
  86. "Connection is not a reference to a valid StreamPeerSSL object.");
  87. }
  88. if (connection == p_connection) {
  89. return;
  90. }
  91. close();
  92. connection = p_connection;
  93. status = STATUS_CONNECTED;
  94. }
  95. Ref<StreamPeer> HTTPClient::get_connection() const {
  96. return connection;
  97. }
  98. static bool _check_request_url(HTTPClient::Method p_method, const String &p_url) {
  99. switch (p_method) {
  100. case HTTPClient::METHOD_CONNECT: {
  101. // Authority in host:port format, as in RFC7231
  102. int pos = p_url.find_char(':');
  103. return 0 < pos && pos < p_url.length() - 1;
  104. }
  105. case HTTPClient::METHOD_OPTIONS: {
  106. if (p_url == "*") {
  107. return true;
  108. }
  109. [[fallthrough]];
  110. }
  111. default:
  112. // Absolute path or absolute URL
  113. return p_url.begins_with("/") || p_url.begins_with("http://") || p_url.begins_with("https://");
  114. }
  115. }
  116. Error HTTPClient::request_raw(Method p_method, const String &p_url, const Vector<String> &p_headers, const Vector<uint8_t> &p_body) {
  117. ERR_FAIL_INDEX_V(p_method, METHOD_MAX, ERR_INVALID_PARAMETER);
  118. ERR_FAIL_COND_V(!_check_request_url(p_method, p_url), ERR_INVALID_PARAMETER);
  119. ERR_FAIL_COND_V(status != STATUS_CONNECTED, ERR_INVALID_PARAMETER);
  120. ERR_FAIL_COND_V(connection.is_null(), ERR_INVALID_DATA);
  121. String request = String(_methods[p_method]) + " " + p_url + " HTTP/1.1\r\n";
  122. bool add_host = true;
  123. bool add_clen = p_body.size() > 0;
  124. bool add_uagent = true;
  125. bool add_accept = true;
  126. for (int i = 0; i < p_headers.size(); i++) {
  127. request += p_headers[i] + "\r\n";
  128. if (add_host && p_headers[i].findn("Host:") == 0) {
  129. add_host = false;
  130. }
  131. if (add_clen && p_headers[i].findn("Content-Length:") == 0) {
  132. add_clen = false;
  133. }
  134. if (add_uagent && p_headers[i].findn("User-Agent:") == 0) {
  135. add_uagent = false;
  136. }
  137. if (add_accept && p_headers[i].findn("Accept:") == 0) {
  138. add_accept = false;
  139. }
  140. }
  141. if (add_host) {
  142. if ((ssl && conn_port == PORT_HTTPS) || (!ssl && conn_port == PORT_HTTP)) {
  143. // Don't append the standard ports
  144. request += "Host: " + conn_host + "\r\n";
  145. } else {
  146. request += "Host: " + conn_host + ":" + itos(conn_port) + "\r\n";
  147. }
  148. }
  149. if (add_clen) {
  150. request += "Content-Length: " + itos(p_body.size()) + "\r\n";
  151. // Should it add utf8 encoding?
  152. }
  153. if (add_uagent) {
  154. request += "User-Agent: GodotEngine/" + String(VERSION_FULL_BUILD) + " (" + OS::get_singleton()->get_name() + ")\r\n";
  155. }
  156. if (add_accept) {
  157. request += "Accept: */*\r\n";
  158. }
  159. request += "\r\n";
  160. CharString cs = request.utf8();
  161. Vector<uint8_t> data;
  162. data.resize(cs.length());
  163. {
  164. uint8_t *data_write = data.ptrw();
  165. for (int i = 0; i < cs.length(); i++) {
  166. data_write[i] = cs[i];
  167. }
  168. }
  169. data.append_array(p_body);
  170. const uint8_t *r = data.ptr();
  171. Error err = connection->put_data(&r[0], data.size());
  172. if (err) {
  173. close();
  174. status = STATUS_CONNECTION_ERROR;
  175. return err;
  176. }
  177. status = STATUS_REQUESTING;
  178. head_request = p_method == METHOD_HEAD;
  179. return OK;
  180. }
  181. Error HTTPClient::request(Method p_method, const String &p_url, const Vector<String> &p_headers, const String &p_body) {
  182. ERR_FAIL_INDEX_V(p_method, METHOD_MAX, ERR_INVALID_PARAMETER);
  183. ERR_FAIL_COND_V(!_check_request_url(p_method, p_url), ERR_INVALID_PARAMETER);
  184. ERR_FAIL_COND_V(status != STATUS_CONNECTED, ERR_INVALID_PARAMETER);
  185. ERR_FAIL_COND_V(connection.is_null(), ERR_INVALID_DATA);
  186. String request = String(_methods[p_method]) + " " + p_url + " HTTP/1.1\r\n";
  187. bool add_host = true;
  188. bool add_uagent = true;
  189. bool add_accept = true;
  190. bool add_clen = p_body.length() > 0;
  191. for (int i = 0; i < p_headers.size(); i++) {
  192. request += p_headers[i] + "\r\n";
  193. if (add_host && p_headers[i].findn("Host:") == 0) {
  194. add_host = false;
  195. }
  196. if (add_clen && p_headers[i].findn("Content-Length:") == 0) {
  197. add_clen = false;
  198. }
  199. if (add_uagent && p_headers[i].findn("User-Agent:") == 0) {
  200. add_uagent = false;
  201. }
  202. if (add_accept && p_headers[i].findn("Accept:") == 0) {
  203. add_accept = false;
  204. }
  205. }
  206. if (add_host) {
  207. if ((ssl && conn_port == PORT_HTTPS) || (!ssl && conn_port == PORT_HTTP)) {
  208. // Don't append the standard ports
  209. request += "Host: " + conn_host + "\r\n";
  210. } else {
  211. request += "Host: " + conn_host + ":" + itos(conn_port) + "\r\n";
  212. }
  213. }
  214. if (add_clen) {
  215. request += "Content-Length: " + itos(p_body.utf8().length()) + "\r\n";
  216. // Should it add utf8 encoding?
  217. }
  218. if (add_uagent) {
  219. request += "User-Agent: GodotEngine/" + String(VERSION_FULL_BUILD) + " (" + OS::get_singleton()->get_name() + ")\r\n";
  220. }
  221. if (add_accept) {
  222. request += "Accept: */*\r\n";
  223. }
  224. request += "\r\n";
  225. request += p_body;
  226. CharString cs = request.utf8();
  227. Error err = connection->put_data((const uint8_t *)cs.ptr(), cs.length());
  228. if (err) {
  229. close();
  230. status = STATUS_CONNECTION_ERROR;
  231. return err;
  232. }
  233. status = STATUS_REQUESTING;
  234. head_request = p_method == METHOD_HEAD;
  235. return OK;
  236. }
  237. bool HTTPClient::has_response() const {
  238. return response_headers.size() != 0;
  239. }
  240. bool HTTPClient::is_response_chunked() const {
  241. return chunked;
  242. }
  243. int HTTPClient::get_response_code() const {
  244. return response_num;
  245. }
  246. Error HTTPClient::get_response_headers(List<String> *r_response) {
  247. if (!response_headers.size()) {
  248. return ERR_INVALID_PARAMETER;
  249. }
  250. for (int i = 0; i < response_headers.size(); i++) {
  251. r_response->push_back(response_headers[i]);
  252. }
  253. response_headers.clear();
  254. return OK;
  255. }
  256. void HTTPClient::close() {
  257. if (tcp_connection->get_status() != StreamPeerTCP::STATUS_NONE) {
  258. tcp_connection->disconnect_from_host();
  259. }
  260. connection.unref();
  261. status = STATUS_DISCONNECTED;
  262. head_request = false;
  263. if (resolving != IP::RESOLVER_INVALID_ID) {
  264. IP::get_singleton()->erase_resolve_item(resolving);
  265. resolving = IP::RESOLVER_INVALID_ID;
  266. }
  267. response_headers.clear();
  268. response_str.clear();
  269. body_size = -1;
  270. body_left = 0;
  271. chunk_left = 0;
  272. chunk_trailer_part = false;
  273. read_until_eof = false;
  274. response_num = 0;
  275. handshaking = false;
  276. }
  277. Error HTTPClient::poll() {
  278. switch (status) {
  279. case STATUS_RESOLVING: {
  280. ERR_FAIL_COND_V(resolving == IP::RESOLVER_INVALID_ID, ERR_BUG);
  281. IP::ResolverStatus rstatus = IP::get_singleton()->get_resolve_item_status(resolving);
  282. switch (rstatus) {
  283. case IP::RESOLVER_STATUS_WAITING:
  284. return OK; // Still resolving
  285. case IP::RESOLVER_STATUS_DONE: {
  286. IP_Address host = IP::get_singleton()->get_resolve_item_address(resolving);
  287. Error err = tcp_connection->connect_to_host(host, conn_port);
  288. IP::get_singleton()->erase_resolve_item(resolving);
  289. resolving = IP::RESOLVER_INVALID_ID;
  290. if (err) {
  291. status = STATUS_CANT_CONNECT;
  292. return err;
  293. }
  294. status = STATUS_CONNECTING;
  295. } break;
  296. case IP::RESOLVER_STATUS_NONE:
  297. case IP::RESOLVER_STATUS_ERROR: {
  298. IP::get_singleton()->erase_resolve_item(resolving);
  299. resolving = IP::RESOLVER_INVALID_ID;
  300. close();
  301. status = STATUS_CANT_RESOLVE;
  302. return ERR_CANT_RESOLVE;
  303. } break;
  304. }
  305. } break;
  306. case STATUS_CONNECTING: {
  307. StreamPeerTCP::Status s = tcp_connection->get_status();
  308. switch (s) {
  309. case StreamPeerTCP::STATUS_CONNECTING: {
  310. return OK;
  311. } break;
  312. case StreamPeerTCP::STATUS_CONNECTED: {
  313. if (ssl) {
  314. Ref<StreamPeerSSL> ssl;
  315. if (!handshaking) {
  316. // Connect the StreamPeerSSL and start handshaking
  317. ssl = Ref<StreamPeerSSL>(StreamPeerSSL::create());
  318. ssl->set_blocking_handshake_enabled(false);
  319. Error err = ssl->connect_to_stream(tcp_connection, ssl_verify_host, conn_host);
  320. if (err != OK) {
  321. close();
  322. status = STATUS_SSL_HANDSHAKE_ERROR;
  323. return ERR_CANT_CONNECT;
  324. }
  325. connection = ssl;
  326. handshaking = true;
  327. } else {
  328. // We are already handshaking, which means we can use your already active SSL connection
  329. ssl = static_cast<Ref<StreamPeerSSL>>(connection);
  330. if (ssl.is_null()) {
  331. close();
  332. status = STATUS_SSL_HANDSHAKE_ERROR;
  333. return ERR_CANT_CONNECT;
  334. }
  335. ssl->poll(); // Try to finish the handshake
  336. }
  337. if (ssl->get_status() == StreamPeerSSL::STATUS_CONNECTED) {
  338. // Handshake has been successful
  339. handshaking = false;
  340. status = STATUS_CONNECTED;
  341. return OK;
  342. } else if (ssl->get_status() != StreamPeerSSL::STATUS_HANDSHAKING) {
  343. // Handshake has failed
  344. close();
  345. status = STATUS_SSL_HANDSHAKE_ERROR;
  346. return ERR_CANT_CONNECT;
  347. }
  348. // ... we will need to poll more for handshake to finish
  349. } else {
  350. status = STATUS_CONNECTED;
  351. }
  352. return OK;
  353. } break;
  354. case StreamPeerTCP::STATUS_ERROR:
  355. case StreamPeerTCP::STATUS_NONE: {
  356. close();
  357. status = STATUS_CANT_CONNECT;
  358. return ERR_CANT_CONNECT;
  359. } break;
  360. }
  361. } break;
  362. case STATUS_BODY:
  363. case STATUS_CONNECTED: {
  364. // Check if we are still connected
  365. if (ssl) {
  366. Ref<StreamPeerSSL> tmp = connection;
  367. tmp->poll();
  368. if (tmp->get_status() != StreamPeerSSL::STATUS_CONNECTED) {
  369. status = STATUS_CONNECTION_ERROR;
  370. return ERR_CONNECTION_ERROR;
  371. }
  372. } else if (tcp_connection->get_status() != StreamPeerTCP::STATUS_CONNECTED) {
  373. status = STATUS_CONNECTION_ERROR;
  374. return ERR_CONNECTION_ERROR;
  375. }
  376. // Connection established, requests can now be made
  377. return OK;
  378. } break;
  379. case STATUS_REQUESTING: {
  380. while (true) {
  381. uint8_t byte;
  382. int rec = 0;
  383. Error err = _get_http_data(&byte, 1, rec);
  384. if (err != OK) {
  385. close();
  386. status = STATUS_CONNECTION_ERROR;
  387. return ERR_CONNECTION_ERROR;
  388. }
  389. if (rec == 0) {
  390. return OK; // Still requesting, keep trying!
  391. }
  392. response_str.push_back(byte);
  393. int rs = response_str.size();
  394. if (
  395. (rs >= 2 && response_str[rs - 2] == '\n' && response_str[rs - 1] == '\n') ||
  396. (rs >= 4 && response_str[rs - 4] == '\r' && response_str[rs - 3] == '\n' && response_str[rs - 2] == '\r' && response_str[rs - 1] == '\n')) {
  397. // End of response, parse.
  398. response_str.push_back(0);
  399. String response;
  400. response.parse_utf8((const char *)response_str.ptr());
  401. Vector<String> responses = response.split("\n");
  402. body_size = -1;
  403. chunked = false;
  404. body_left = 0;
  405. chunk_left = 0;
  406. chunk_trailer_part = false;
  407. read_until_eof = false;
  408. response_str.clear();
  409. response_headers.clear();
  410. response_num = RESPONSE_OK;
  411. // Per the HTTP 1.1 spec, keep-alive is the default.
  412. // Not following that specification breaks standard implementations.
  413. // Broken web servers should be fixed.
  414. bool keep_alive = true;
  415. for (int i = 0; i < responses.size(); i++) {
  416. String header = responses[i].strip_edges();
  417. String s = header.to_lower();
  418. if (s.length() == 0) {
  419. continue;
  420. }
  421. if (s.begins_with("content-length:")) {
  422. body_size = s.substr(s.find(":") + 1, s.length()).strip_edges().to_int();
  423. body_left = body_size;
  424. } else if (s.begins_with("transfer-encoding:")) {
  425. String encoding = header.substr(header.find(":") + 1, header.length()).strip_edges();
  426. if (encoding == "chunked") {
  427. chunked = true;
  428. }
  429. } else if (s.begins_with("connection: close")) {
  430. keep_alive = false;
  431. }
  432. if (i == 0 && responses[i].begins_with("HTTP")) {
  433. String num = responses[i].get_slicec(' ', 1);
  434. response_num = num.to_int();
  435. } else {
  436. response_headers.push_back(header);
  437. }
  438. }
  439. // This is a HEAD request, we won't receive anything.
  440. if (head_request) {
  441. body_size = 0;
  442. body_left = 0;
  443. }
  444. if (body_size != -1 || chunked) {
  445. status = STATUS_BODY;
  446. } else if (!keep_alive) {
  447. read_until_eof = true;
  448. status = STATUS_BODY;
  449. } else {
  450. status = STATUS_CONNECTED;
  451. }
  452. return OK;
  453. }
  454. }
  455. } break;
  456. case STATUS_DISCONNECTED: {
  457. return ERR_UNCONFIGURED;
  458. } break;
  459. case STATUS_CONNECTION_ERROR:
  460. case STATUS_SSL_HANDSHAKE_ERROR: {
  461. return ERR_CONNECTION_ERROR;
  462. } break;
  463. case STATUS_CANT_CONNECT: {
  464. return ERR_CANT_CONNECT;
  465. } break;
  466. case STATUS_CANT_RESOLVE: {
  467. return ERR_CANT_RESOLVE;
  468. } break;
  469. }
  470. return OK;
  471. }
  472. int HTTPClient::get_response_body_length() const {
  473. return body_size;
  474. }
  475. PackedByteArray HTTPClient::read_response_body_chunk() {
  476. ERR_FAIL_COND_V(status != STATUS_BODY, PackedByteArray());
  477. PackedByteArray ret;
  478. Error err = OK;
  479. if (chunked) {
  480. while (true) {
  481. if (chunk_trailer_part) {
  482. // We need to consume the trailer part too or keep-alive will break
  483. uint8_t b;
  484. int rec = 0;
  485. err = _get_http_data(&b, 1, rec);
  486. if (rec == 0) {
  487. break;
  488. }
  489. chunk.push_back(b);
  490. int cs = chunk.size();
  491. if ((cs >= 2 && chunk[cs - 2] == '\r' && chunk[cs - 1] == '\n')) {
  492. if (cs == 2) {
  493. // Finally over
  494. chunk_trailer_part = false;
  495. status = STATUS_CONNECTED;
  496. chunk.clear();
  497. break;
  498. } else {
  499. // We do not process nor return the trailer data
  500. chunk.clear();
  501. }
  502. }
  503. } else if (chunk_left == 0) {
  504. // Reading length
  505. uint8_t b;
  506. int rec = 0;
  507. err = _get_http_data(&b, 1, rec);
  508. if (rec == 0) {
  509. break;
  510. }
  511. chunk.push_back(b);
  512. if (chunk.size() > 32) {
  513. ERR_PRINT("HTTP Invalid chunk hex len");
  514. status = STATUS_CONNECTION_ERROR;
  515. break;
  516. }
  517. if (chunk.size() > 2 && chunk[chunk.size() - 2] == '\r' && chunk[chunk.size() - 1] == '\n') {
  518. int len = 0;
  519. for (int i = 0; i < chunk.size() - 2; i++) {
  520. char c = chunk[i];
  521. int v = 0;
  522. if (c >= '0' && c <= '9') {
  523. v = c - '0';
  524. } else if (c >= 'a' && c <= 'f') {
  525. v = c - 'a' + 10;
  526. } else if (c >= 'A' && c <= 'F') {
  527. v = c - 'A' + 10;
  528. } else {
  529. ERR_PRINT("HTTP Chunk len not in hex!!");
  530. status = STATUS_CONNECTION_ERROR;
  531. break;
  532. }
  533. len <<= 4;
  534. len |= v;
  535. if (len > (1 << 24)) {
  536. ERR_PRINT("HTTP Chunk too big!! >16mb");
  537. status = STATUS_CONNECTION_ERROR;
  538. break;
  539. }
  540. }
  541. if (len == 0) {
  542. // End reached!
  543. chunk_trailer_part = true;
  544. chunk.clear();
  545. break;
  546. }
  547. chunk_left = len + 2;
  548. chunk.resize(chunk_left);
  549. }
  550. } else {
  551. int rec = 0;
  552. err = _get_http_data(&chunk.write[chunk.size() - chunk_left], chunk_left, rec);
  553. if (rec == 0) {
  554. break;
  555. }
  556. chunk_left -= rec;
  557. if (chunk_left == 0) {
  558. if (chunk[chunk.size() - 2] != '\r' || chunk[chunk.size() - 1] != '\n') {
  559. ERR_PRINT("HTTP Invalid chunk terminator (not \\r\\n)");
  560. status = STATUS_CONNECTION_ERROR;
  561. break;
  562. }
  563. ret.resize(chunk.size() - 2);
  564. uint8_t *w = ret.ptrw();
  565. copymem(w, chunk.ptr(), chunk.size() - 2);
  566. chunk.clear();
  567. }
  568. break;
  569. }
  570. }
  571. } else {
  572. int to_read = !read_until_eof ? MIN(body_left, read_chunk_size) : read_chunk_size;
  573. ret.resize(to_read);
  574. int _offset = 0;
  575. while (to_read > 0) {
  576. int rec = 0;
  577. {
  578. uint8_t *w = ret.ptrw();
  579. err = _get_http_data(w + _offset, to_read, rec);
  580. }
  581. if (rec <= 0) { // Ended up reading less
  582. ret.resize(_offset);
  583. break;
  584. } else {
  585. _offset += rec;
  586. to_read -= rec;
  587. if (!read_until_eof) {
  588. body_left -= rec;
  589. }
  590. }
  591. if (err != OK) {
  592. break;
  593. }
  594. }
  595. }
  596. if (err != OK) {
  597. close();
  598. if (err == ERR_FILE_EOF) {
  599. status = STATUS_DISCONNECTED; // Server disconnected
  600. } else {
  601. status = STATUS_CONNECTION_ERROR;
  602. }
  603. } else if (body_left == 0 && !chunked && !read_until_eof) {
  604. status = STATUS_CONNECTED;
  605. }
  606. return ret;
  607. }
  608. HTTPClient::Status HTTPClient::get_status() const {
  609. return status;
  610. }
  611. void HTTPClient::set_blocking_mode(bool p_enable) {
  612. blocking = p_enable;
  613. }
  614. bool HTTPClient::is_blocking_mode_enabled() const {
  615. return blocking;
  616. }
  617. Error HTTPClient::_get_http_data(uint8_t *p_buffer, int p_bytes, int &r_received) {
  618. if (blocking) {
  619. // We can't use StreamPeer.get_data, since when reaching EOF we will get an
  620. // error without knowing how many bytes we received.
  621. Error err = ERR_FILE_EOF;
  622. int read = 0;
  623. int left = p_bytes;
  624. r_received = 0;
  625. while (left > 0) {
  626. err = connection->get_partial_data(p_buffer + r_received, left, read);
  627. if (err == OK) {
  628. r_received += read;
  629. } else if (err == ERR_FILE_EOF) {
  630. r_received += read;
  631. return err;
  632. } else {
  633. return err;
  634. }
  635. left -= read;
  636. }
  637. return err;
  638. } else {
  639. return connection->get_partial_data(p_buffer, p_bytes, r_received);
  640. }
  641. }
  642. void HTTPClient::set_read_chunk_size(int p_size) {
  643. ERR_FAIL_COND(p_size < 256 || p_size > (1 << 24));
  644. read_chunk_size = p_size;
  645. }
  646. int HTTPClient::get_read_chunk_size() const {
  647. return read_chunk_size;
  648. }
  649. HTTPClient::HTTPClient() {
  650. tcp_connection.instance();
  651. }
  652. HTTPClient::~HTTPClient() {}
  653. #endif // #ifndef JAVASCRIPT_ENABLED
  654. String HTTPClient::query_string_from_dict(const Dictionary &p_dict) {
  655. String query = "";
  656. Array keys = p_dict.keys();
  657. for (int i = 0; i < keys.size(); ++i) {
  658. String encoded_key = String(keys[i]).uri_encode();
  659. Variant value = p_dict[keys[i]];
  660. switch (value.get_type()) {
  661. case Variant::ARRAY: {
  662. // Repeat the key with every values
  663. Array values = value;
  664. for (int j = 0; j < values.size(); ++j) {
  665. query += "&" + encoded_key + "=" + String(values[j]).uri_encode();
  666. }
  667. break;
  668. }
  669. case Variant::NIL: {
  670. // Add the key with no value
  671. query += "&" + encoded_key;
  672. break;
  673. }
  674. default: {
  675. // Add the key-value pair
  676. query += "&" + encoded_key + "=" + String(value).uri_encode();
  677. }
  678. }
  679. }
  680. query.erase(0, 1);
  681. return query;
  682. }
  683. Dictionary HTTPClient::_get_response_headers_as_dictionary() {
  684. List<String> rh;
  685. get_response_headers(&rh);
  686. Dictionary ret;
  687. for (const List<String>::Element *E = rh.front(); E; E = E->next()) {
  688. const String &s = E->get();
  689. int sp = s.find(":");
  690. if (sp == -1) {
  691. continue;
  692. }
  693. String key = s.substr(0, sp).strip_edges();
  694. String value = s.substr(sp + 1, s.length()).strip_edges();
  695. ret[key] = value;
  696. }
  697. return ret;
  698. }
  699. PackedStringArray HTTPClient::_get_response_headers() {
  700. List<String> rh;
  701. get_response_headers(&rh);
  702. PackedStringArray ret;
  703. ret.resize(rh.size());
  704. int idx = 0;
  705. for (const List<String>::Element *E = rh.front(); E; E = E->next()) {
  706. ret.set(idx++, E->get());
  707. }
  708. return ret;
  709. }
  710. void HTTPClient::_bind_methods() {
  711. ClassDB::bind_method(D_METHOD("connect_to_host", "host", "port", "use_ssl", "verify_host"), &HTTPClient::connect_to_host, DEFVAL(-1), DEFVAL(false), DEFVAL(true));
  712. ClassDB::bind_method(D_METHOD("set_connection", "connection"), &HTTPClient::set_connection);
  713. ClassDB::bind_method(D_METHOD("get_connection"), &HTTPClient::get_connection);
  714. ClassDB::bind_method(D_METHOD("request_raw", "method", "url", "headers", "body"), &HTTPClient::request_raw);
  715. ClassDB::bind_method(D_METHOD("request", "method", "url", "headers", "body"), &HTTPClient::request, DEFVAL(String()));
  716. ClassDB::bind_method(D_METHOD("close"), &HTTPClient::close);
  717. ClassDB::bind_method(D_METHOD("has_response"), &HTTPClient::has_response);
  718. ClassDB::bind_method(D_METHOD("is_response_chunked"), &HTTPClient::is_response_chunked);
  719. ClassDB::bind_method(D_METHOD("get_response_code"), &HTTPClient::get_response_code);
  720. ClassDB::bind_method(D_METHOD("get_response_headers"), &HTTPClient::_get_response_headers);
  721. ClassDB::bind_method(D_METHOD("get_response_headers_as_dictionary"), &HTTPClient::_get_response_headers_as_dictionary);
  722. ClassDB::bind_method(D_METHOD("get_response_body_length"), &HTTPClient::get_response_body_length);
  723. ClassDB::bind_method(D_METHOD("read_response_body_chunk"), &HTTPClient::read_response_body_chunk);
  724. ClassDB::bind_method(D_METHOD("set_read_chunk_size", "bytes"), &HTTPClient::set_read_chunk_size);
  725. ClassDB::bind_method(D_METHOD("get_read_chunk_size"), &HTTPClient::get_read_chunk_size);
  726. ClassDB::bind_method(D_METHOD("set_blocking_mode", "enabled"), &HTTPClient::set_blocking_mode);
  727. ClassDB::bind_method(D_METHOD("is_blocking_mode_enabled"), &HTTPClient::is_blocking_mode_enabled);
  728. ClassDB::bind_method(D_METHOD("get_status"), &HTTPClient::get_status);
  729. ClassDB::bind_method(D_METHOD("poll"), &HTTPClient::poll);
  730. ClassDB::bind_method(D_METHOD("query_string_from_dict", "fields"), &HTTPClient::query_string_from_dict);
  731. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "blocking_mode_enabled"), "set_blocking_mode", "is_blocking_mode_enabled");
  732. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "connection", PROPERTY_HINT_RESOURCE_TYPE, "StreamPeer", 0), "set_connection", "get_connection");
  733. ADD_PROPERTY(PropertyInfo(Variant::INT, "read_chunk_size", PROPERTY_HINT_RANGE, "256,16777216"), "set_read_chunk_size", "get_read_chunk_size");
  734. BIND_ENUM_CONSTANT(METHOD_GET);
  735. BIND_ENUM_CONSTANT(METHOD_HEAD);
  736. BIND_ENUM_CONSTANT(METHOD_POST);
  737. BIND_ENUM_CONSTANT(METHOD_PUT);
  738. BIND_ENUM_CONSTANT(METHOD_DELETE);
  739. BIND_ENUM_CONSTANT(METHOD_OPTIONS);
  740. BIND_ENUM_CONSTANT(METHOD_TRACE);
  741. BIND_ENUM_CONSTANT(METHOD_CONNECT);
  742. BIND_ENUM_CONSTANT(METHOD_PATCH);
  743. BIND_ENUM_CONSTANT(METHOD_MAX);
  744. BIND_ENUM_CONSTANT(STATUS_DISCONNECTED);
  745. BIND_ENUM_CONSTANT(STATUS_RESOLVING); // Resolving hostname (if hostname was passed in)
  746. BIND_ENUM_CONSTANT(STATUS_CANT_RESOLVE);
  747. BIND_ENUM_CONSTANT(STATUS_CONNECTING); // Connecting to IP
  748. BIND_ENUM_CONSTANT(STATUS_CANT_CONNECT);
  749. BIND_ENUM_CONSTANT(STATUS_CONNECTED); // Connected, now accepting requests
  750. BIND_ENUM_CONSTANT(STATUS_REQUESTING); // Request in progress
  751. BIND_ENUM_CONSTANT(STATUS_BODY); // Request resulted in body which must be read
  752. BIND_ENUM_CONSTANT(STATUS_CONNECTION_ERROR);
  753. BIND_ENUM_CONSTANT(STATUS_SSL_HANDSHAKE_ERROR);
  754. BIND_ENUM_CONSTANT(RESPONSE_CONTINUE);
  755. BIND_ENUM_CONSTANT(RESPONSE_SWITCHING_PROTOCOLS);
  756. BIND_ENUM_CONSTANT(RESPONSE_PROCESSING);
  757. // 2xx successful
  758. BIND_ENUM_CONSTANT(RESPONSE_OK);
  759. BIND_ENUM_CONSTANT(RESPONSE_CREATED);
  760. BIND_ENUM_CONSTANT(RESPONSE_ACCEPTED);
  761. BIND_ENUM_CONSTANT(RESPONSE_NON_AUTHORITATIVE_INFORMATION);
  762. BIND_ENUM_CONSTANT(RESPONSE_NO_CONTENT);
  763. BIND_ENUM_CONSTANT(RESPONSE_RESET_CONTENT);
  764. BIND_ENUM_CONSTANT(RESPONSE_PARTIAL_CONTENT);
  765. BIND_ENUM_CONSTANT(RESPONSE_MULTI_STATUS);
  766. BIND_ENUM_CONSTANT(RESPONSE_ALREADY_REPORTED);
  767. BIND_ENUM_CONSTANT(RESPONSE_IM_USED);
  768. // 3xx redirection
  769. BIND_ENUM_CONSTANT(RESPONSE_MULTIPLE_CHOICES);
  770. BIND_ENUM_CONSTANT(RESPONSE_MOVED_PERMANENTLY);
  771. BIND_ENUM_CONSTANT(RESPONSE_FOUND);
  772. BIND_ENUM_CONSTANT(RESPONSE_SEE_OTHER);
  773. BIND_ENUM_CONSTANT(RESPONSE_NOT_MODIFIED);
  774. BIND_ENUM_CONSTANT(RESPONSE_USE_PROXY);
  775. BIND_ENUM_CONSTANT(RESPONSE_SWITCH_PROXY);
  776. BIND_ENUM_CONSTANT(RESPONSE_TEMPORARY_REDIRECT);
  777. BIND_ENUM_CONSTANT(RESPONSE_PERMANENT_REDIRECT);
  778. // 4xx client error
  779. BIND_ENUM_CONSTANT(RESPONSE_BAD_REQUEST);
  780. BIND_ENUM_CONSTANT(RESPONSE_UNAUTHORIZED);
  781. BIND_ENUM_CONSTANT(RESPONSE_PAYMENT_REQUIRED);
  782. BIND_ENUM_CONSTANT(RESPONSE_FORBIDDEN);
  783. BIND_ENUM_CONSTANT(RESPONSE_NOT_FOUND);
  784. BIND_ENUM_CONSTANT(RESPONSE_METHOD_NOT_ALLOWED);
  785. BIND_ENUM_CONSTANT(RESPONSE_NOT_ACCEPTABLE);
  786. BIND_ENUM_CONSTANT(RESPONSE_PROXY_AUTHENTICATION_REQUIRED);
  787. BIND_ENUM_CONSTANT(RESPONSE_REQUEST_TIMEOUT);
  788. BIND_ENUM_CONSTANT(RESPONSE_CONFLICT);
  789. BIND_ENUM_CONSTANT(RESPONSE_GONE);
  790. BIND_ENUM_CONSTANT(RESPONSE_LENGTH_REQUIRED);
  791. BIND_ENUM_CONSTANT(RESPONSE_PRECONDITION_FAILED);
  792. BIND_ENUM_CONSTANT(RESPONSE_REQUEST_ENTITY_TOO_LARGE);
  793. BIND_ENUM_CONSTANT(RESPONSE_REQUEST_URI_TOO_LONG);
  794. BIND_ENUM_CONSTANT(RESPONSE_UNSUPPORTED_MEDIA_TYPE);
  795. BIND_ENUM_CONSTANT(RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE);
  796. BIND_ENUM_CONSTANT(RESPONSE_EXPECTATION_FAILED);
  797. BIND_ENUM_CONSTANT(RESPONSE_IM_A_TEAPOT);
  798. BIND_ENUM_CONSTANT(RESPONSE_MISDIRECTED_REQUEST);
  799. BIND_ENUM_CONSTANT(RESPONSE_UNPROCESSABLE_ENTITY);
  800. BIND_ENUM_CONSTANT(RESPONSE_LOCKED);
  801. BIND_ENUM_CONSTANT(RESPONSE_FAILED_DEPENDENCY);
  802. BIND_ENUM_CONSTANT(RESPONSE_UPGRADE_REQUIRED);
  803. BIND_ENUM_CONSTANT(RESPONSE_PRECONDITION_REQUIRED);
  804. BIND_ENUM_CONSTANT(RESPONSE_TOO_MANY_REQUESTS);
  805. BIND_ENUM_CONSTANT(RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE);
  806. BIND_ENUM_CONSTANT(RESPONSE_UNAVAILABLE_FOR_LEGAL_REASONS);
  807. // 5xx server error
  808. BIND_ENUM_CONSTANT(RESPONSE_INTERNAL_SERVER_ERROR);
  809. BIND_ENUM_CONSTANT(RESPONSE_NOT_IMPLEMENTED);
  810. BIND_ENUM_CONSTANT(RESPONSE_BAD_GATEWAY);
  811. BIND_ENUM_CONSTANT(RESPONSE_SERVICE_UNAVAILABLE);
  812. BIND_ENUM_CONSTANT(RESPONSE_GATEWAY_TIMEOUT);
  813. BIND_ENUM_CONSTANT(RESPONSE_HTTP_VERSION_NOT_SUPPORTED);
  814. BIND_ENUM_CONSTANT(RESPONSE_VARIANT_ALSO_NEGOTIATES);
  815. BIND_ENUM_CONSTANT(RESPONSE_INSUFFICIENT_STORAGE);
  816. BIND_ENUM_CONSTANT(RESPONSE_LOOP_DETECTED);
  817. BIND_ENUM_CONSTANT(RESPONSE_NOT_EXTENDED);
  818. BIND_ENUM_CONSTANT(RESPONSE_NETWORK_AUTH_REQUIRED);
  819. }