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