export.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664
  1. /*************************************************************************/
  2. /* export.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2020 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 "core/io/json.h"
  31. #include "core/io/tcp_server.h"
  32. #include "core/io/zip_io.h"
  33. #include "editor/editor_export.h"
  34. #include "editor/editor_node.h"
  35. #include "main/splash.gen.h"
  36. #include "platform/javascript/logo.gen.h"
  37. #include "platform/javascript/run_icon.gen.h"
  38. #define EXPORT_TEMPLATE_WEBASSEMBLY_RELEASE "webassembly_release.zip"
  39. #define EXPORT_TEMPLATE_WEBASSEMBLY_DEBUG "webassembly_debug.zip"
  40. class EditorHTTPServer : public Reference {
  41. private:
  42. Ref<TCP_Server> server;
  43. Ref<StreamPeerTCP> connection;
  44. uint64_t time;
  45. uint8_t req_buf[4096];
  46. int req_pos;
  47. void _clear_client() {
  48. connection = Ref<StreamPeerTCP>();
  49. memset(req_buf, 0, sizeof(req_buf));
  50. time = 0;
  51. req_pos = 0;
  52. }
  53. public:
  54. EditorHTTPServer() {
  55. server.instance();
  56. stop();
  57. }
  58. void stop() {
  59. server->stop();
  60. _clear_client();
  61. }
  62. Error listen(int p_port, IP_Address p_address) {
  63. return server->listen(p_port, p_address);
  64. }
  65. bool is_listening() const {
  66. return server->is_listening();
  67. }
  68. void _send_response() {
  69. Vector<String> psa = String((char *)req_buf).split("\r\n");
  70. int len = psa.size();
  71. ERR_FAIL_COND_MSG(len < 4, "Not enough response headers, got: " + itos(len) + ", expected >= 4.");
  72. Vector<String> req = psa[0].split(" ", false);
  73. ERR_FAIL_COND_MSG(req.size() < 2, "Invalid protocol or status code.");
  74. // Wrong protocol
  75. ERR_FAIL_COND_MSG(req[0] != "GET" || req[2] != "HTTP/1.1", "Invalid method or HTTP version.");
  76. String filepath = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmp_js_export");
  77. const String basereq = "/tmp_js_export";
  78. String ctype = "";
  79. if (req[1] == basereq + ".html") {
  80. filepath += ".html";
  81. ctype = "text/html";
  82. } else if (req[1] == basereq + ".js") {
  83. filepath += ".js";
  84. ctype = "application/javascript";
  85. } else if (req[1] == basereq + ".audio.worklet.js") {
  86. filepath += ".audio.worklet.js";
  87. ctype = "application/javascript";
  88. } else if (req[1] == basereq + ".worker.js") {
  89. filepath += ".worker.js";
  90. ctype = "application/javascript";
  91. } else if (req[1] == basereq + ".pck") {
  92. filepath += ".pck";
  93. ctype = "application/octet-stream";
  94. } else if (req[1] == basereq + ".png" || req[1] == "/favicon.png") {
  95. // Also allow serving the generated favicon for a smoother loading experience.
  96. if (req[1] == "/favicon.png") {
  97. filepath = EditorSettings::get_singleton()->get_cache_dir().plus_file("favicon.png");
  98. } else {
  99. filepath += ".png";
  100. }
  101. ctype = "image/png";
  102. } else if (req[1] == basereq + ".wasm") {
  103. filepath += ".wasm";
  104. ctype = "application/wasm";
  105. } else {
  106. String s = "HTTP/1.1 404 Not Found\r\n";
  107. s += "Connection: Close\r\n";
  108. s += "\r\n";
  109. CharString cs = s.utf8();
  110. connection->put_data((const uint8_t *)cs.get_data(), cs.size() - 1);
  111. return;
  112. }
  113. FileAccess *f = FileAccess::open(filepath, FileAccess::READ);
  114. ERR_FAIL_COND(!f);
  115. String s = "HTTP/1.1 200 OK\r\n";
  116. s += "Connection: Close\r\n";
  117. s += "Content-Type: " + ctype + "\r\n";
  118. s += "Access-Control-Allow-Origin: *\r\n";
  119. s += "Cross-Origin-Opener-Policy: same-origin\r\n";
  120. s += "Cross-Origin-Embedder-Policy: require-corp\r\n";
  121. s += "\r\n";
  122. CharString cs = s.utf8();
  123. Error err = connection->put_data((const uint8_t *)cs.get_data(), cs.size() - 1);
  124. if (err != OK) {
  125. memdelete(f);
  126. ERR_FAIL();
  127. }
  128. while (true) {
  129. uint8_t bytes[4096];
  130. int read = f->get_buffer(bytes, 4096);
  131. if (read < 1) {
  132. break;
  133. }
  134. err = connection->put_data(bytes, read);
  135. if (err != OK) {
  136. memdelete(f);
  137. ERR_FAIL();
  138. }
  139. }
  140. memdelete(f);
  141. }
  142. void poll() {
  143. if (!server->is_listening()) {
  144. return;
  145. }
  146. if (connection.is_null()) {
  147. if (!server->is_connection_available()) {
  148. return;
  149. }
  150. connection = server->take_connection();
  151. time = OS::get_singleton()->get_ticks_usec();
  152. }
  153. if (OS::get_singleton()->get_ticks_usec() - time > 1000000) {
  154. _clear_client();
  155. return;
  156. }
  157. if (connection->get_status() != StreamPeerTCP::STATUS_CONNECTED) {
  158. return;
  159. }
  160. while (true) {
  161. char *r = (char *)req_buf;
  162. int l = req_pos - 1;
  163. if (l > 3 && r[l] == '\n' && r[l - 1] == '\r' && r[l - 2] == '\n' && r[l - 3] == '\r') {
  164. _send_response();
  165. _clear_client();
  166. return;
  167. }
  168. int read = 0;
  169. ERR_FAIL_COND(req_pos >= 4096);
  170. Error err = connection->get_partial_data(&req_buf[req_pos], 1, read);
  171. if (err != OK) {
  172. // Got an error
  173. _clear_client();
  174. return;
  175. } else if (read != 1) {
  176. // Busy, wait next poll
  177. return;
  178. }
  179. req_pos += read;
  180. }
  181. }
  182. };
  183. class EditorExportPlatformJavaScript : public EditorExportPlatform {
  184. GDCLASS(EditorExportPlatformJavaScript, EditorExportPlatform);
  185. Ref<ImageTexture> logo;
  186. Ref<ImageTexture> run_icon;
  187. Ref<ImageTexture> stop_icon;
  188. int menu_options;
  189. void _fix_html(Vector<uint8_t> &p_html, const Ref<EditorExportPreset> &p_preset, const String &p_name, bool p_debug, int p_flags);
  190. private:
  191. Ref<EditorHTTPServer> server;
  192. bool server_quit;
  193. Mutex server_lock;
  194. Thread *server_thread;
  195. static void _server_thread_poll(void *data);
  196. public:
  197. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) override;
  198. virtual void get_export_options(List<ExportOption> *r_options) override;
  199. virtual String get_name() const override;
  200. virtual String get_os_name() const override;
  201. virtual Ref<Texture2D> get_logo() const override;
  202. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const override;
  203. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const override;
  204. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) override;
  205. virtual bool poll_export() override;
  206. virtual int get_options_count() const override;
  207. virtual String get_option_label(int p_index) const override { return p_index ? TTR("Stop HTTP Server") : TTR("Run in Browser"); }
  208. virtual String get_option_tooltip(int p_index) const override { return p_index ? TTR("Stop HTTP Server") : TTR("Run exported HTML in the system's default browser."); }
  209. virtual Ref<ImageTexture> get_option_icon(int p_index) const override;
  210. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_option, int p_debug_flags) override;
  211. virtual Ref<Texture2D> get_run_icon() const override;
  212. virtual void get_platform_features(List<String> *r_features) override {
  213. r_features->push_back("web");
  214. r_features->push_back(get_os_name());
  215. }
  216. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) override {
  217. }
  218. String get_debug_protocol() const override { return "ws://"; }
  219. EditorExportPlatformJavaScript();
  220. ~EditorExportPlatformJavaScript();
  221. };
  222. void EditorExportPlatformJavaScript::_fix_html(Vector<uint8_t> &p_html, const Ref<EditorExportPreset> &p_preset, const String &p_name, bool p_debug, int p_flags) {
  223. String str_template = String::utf8(reinterpret_cast<const char *>(p_html.ptr()), p_html.size());
  224. String str_export;
  225. Vector<String> lines = str_template.split("\n");
  226. Vector<String> flags;
  227. String flags_json;
  228. gen_export_flags(flags, p_flags);
  229. flags_json = JSON::print(flags);
  230. for (int i = 0; i < lines.size(); i++) {
  231. String current_line = lines[i];
  232. current_line = current_line.replace("$GODOT_BASENAME", p_name);
  233. current_line = current_line.replace("$GODOT_PROJECT_NAME", ProjectSettings::get_singleton()->get_setting("application/config/name"));
  234. current_line = current_line.replace("$GODOT_HEAD_INCLUDE", p_preset->get("html/head_include"));
  235. current_line = current_line.replace("$GODOT_FULL_WINDOW", p_preset->get("html/full_window_size") ? "true" : "false");
  236. current_line = current_line.replace("$GODOT_DEBUG_ENABLED", p_debug ? "true" : "false");
  237. current_line = current_line.replace("$GODOT_ARGS", flags_json);
  238. str_export += current_line + "\n";
  239. }
  240. CharString cs = str_export.utf8();
  241. p_html.resize(cs.length());
  242. for (int i = 0; i < cs.length(); i++) {
  243. p_html.write[i] = cs[i];
  244. }
  245. }
  246. void EditorExportPlatformJavaScript::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  247. if (p_preset->get("vram_texture_compression/for_desktop")) {
  248. r_features->push_back("s3tc");
  249. }
  250. if (p_preset->get("vram_texture_compression/for_mobile")) {
  251. String driver = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name");
  252. if (driver == "GLES2") {
  253. r_features->push_back("etc");
  254. } else if (driver == "Vulkan") {
  255. // FIXME: Review if this is correct.
  256. r_features->push_back("etc2");
  257. }
  258. }
  259. }
  260. void EditorExportPlatformJavaScript::get_export_options(List<ExportOption> *r_options) {
  261. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  262. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  263. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "vram_texture_compression/for_desktop"), true)); // S3TC
  264. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "vram_texture_compression/for_mobile"), false)); // ETC or ETC2, depending on renderer
  265. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "html/custom_html_shell", PROPERTY_HINT_FILE, "*.html"), ""));
  266. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "html/head_include", PROPERTY_HINT_MULTILINE_TEXT), ""));
  267. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "html/full_window_size"), true));
  268. }
  269. String EditorExportPlatformJavaScript::get_name() const {
  270. return "HTML5";
  271. }
  272. String EditorExportPlatformJavaScript::get_os_name() const {
  273. return "HTML5";
  274. }
  275. Ref<Texture2D> EditorExportPlatformJavaScript::get_logo() const {
  276. return logo;
  277. }
  278. bool EditorExportPlatformJavaScript::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  279. String err;
  280. bool valid = false;
  281. // Look for export templates (first official, and if defined custom templates).
  282. bool dvalid = exists_export_template(EXPORT_TEMPLATE_WEBASSEMBLY_DEBUG, &err);
  283. bool rvalid = exists_export_template(EXPORT_TEMPLATE_WEBASSEMBLY_RELEASE, &err);
  284. if (p_preset->get("custom_template/debug") != "") {
  285. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  286. if (!dvalid) {
  287. err += TTR("Custom debug template not found.") + "\n";
  288. }
  289. }
  290. if (p_preset->get("custom_template/release") != "") {
  291. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  292. if (!rvalid) {
  293. err += TTR("Custom release template not found.") + "\n";
  294. }
  295. }
  296. valid = dvalid || rvalid;
  297. r_missing_templates = !valid;
  298. // Validate the rest of the configuration.
  299. if (p_preset->get("vram_texture_compression/for_mobile")) {
  300. String etc_error = test_etc2();
  301. if (etc_error != String()) {
  302. valid = false;
  303. err += etc_error;
  304. }
  305. }
  306. if (!err.empty()) {
  307. r_error = err;
  308. }
  309. return valid;
  310. }
  311. List<String> EditorExportPlatformJavaScript::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  312. List<String> list;
  313. list.push_back("html");
  314. return list;
  315. }
  316. Error EditorExportPlatformJavaScript::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  317. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  318. String custom_debug = p_preset->get("custom_template/debug");
  319. String custom_release = p_preset->get("custom_template/release");
  320. String custom_html = p_preset->get("html/custom_html_shell");
  321. String template_path = p_debug ? custom_debug : custom_release;
  322. template_path = template_path.strip_edges();
  323. if (template_path == String()) {
  324. if (p_debug) {
  325. template_path = find_export_template(EXPORT_TEMPLATE_WEBASSEMBLY_DEBUG);
  326. } else {
  327. template_path = find_export_template(EXPORT_TEMPLATE_WEBASSEMBLY_RELEASE);
  328. }
  329. }
  330. if (!DirAccess::exists(p_path.get_base_dir())) {
  331. return ERR_FILE_BAD_PATH;
  332. }
  333. if (template_path != String() && !FileAccess::exists(template_path)) {
  334. EditorNode::get_singleton()->show_warning(TTR("Template file not found:") + "\n" + template_path);
  335. return ERR_FILE_NOT_FOUND;
  336. }
  337. String pck_path = p_path.get_basename() + ".pck";
  338. Error error = save_pack(p_preset, pck_path);
  339. if (error != OK) {
  340. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + pck_path);
  341. return error;
  342. }
  343. FileAccess *src_f = nullptr;
  344. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  345. unzFile pkg = unzOpen2(template_path.utf8().get_data(), &io);
  346. if (!pkg) {
  347. EditorNode::get_singleton()->show_warning(TTR("Could not open template for export:") + "\n" + template_path);
  348. return ERR_FILE_NOT_FOUND;
  349. }
  350. if (unzGoToFirstFile(pkg) != UNZ_OK) {
  351. EditorNode::get_singleton()->show_warning(TTR("Invalid export template:") + "\n" + template_path);
  352. unzClose(pkg);
  353. return ERR_FILE_CORRUPT;
  354. }
  355. do {
  356. //get filename
  357. unz_file_info info;
  358. char fname[16384];
  359. unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  360. String file = fname;
  361. Vector<uint8_t> data;
  362. data.resize(info.uncompressed_size);
  363. //read
  364. unzOpenCurrentFile(pkg);
  365. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  366. unzCloseCurrentFile(pkg);
  367. //write
  368. if (file == "godot.html") {
  369. if (!custom_html.empty()) {
  370. continue;
  371. }
  372. _fix_html(data, p_preset, p_path.get_file().get_basename(), p_debug, p_flags);
  373. file = p_path.get_file();
  374. } else if (file == "godot.js") {
  375. file = p_path.get_file().get_basename() + ".js";
  376. } else if (file == "godot.worker.js") {
  377. file = p_path.get_file().get_basename() + ".worker.js";
  378. } else if (file == "godot.audio.worklet.js") {
  379. file = p_path.get_file().get_basename() + ".audio.worklet.js";
  380. } else if (file == "godot.wasm") {
  381. file = p_path.get_file().get_basename() + ".wasm";
  382. }
  383. String dst = p_path.get_base_dir().plus_file(file);
  384. FileAccess *f = FileAccess::open(dst, FileAccess::WRITE);
  385. if (!f) {
  386. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + dst);
  387. unzClose(pkg);
  388. return ERR_FILE_CANT_WRITE;
  389. }
  390. f->store_buffer(data.ptr(), data.size());
  391. memdelete(f);
  392. } while (unzGoToNextFile(pkg) == UNZ_OK);
  393. unzClose(pkg);
  394. if (!custom_html.empty()) {
  395. FileAccess *f = FileAccess::open(custom_html, FileAccess::READ);
  396. if (!f) {
  397. EditorNode::get_singleton()->show_warning(TTR("Could not read custom HTML shell:") + "\n" + custom_html);
  398. return ERR_FILE_CANT_READ;
  399. }
  400. Vector<uint8_t> buf;
  401. buf.resize(f->get_len());
  402. f->get_buffer(buf.ptrw(), buf.size());
  403. memdelete(f);
  404. _fix_html(buf, p_preset, p_path.get_file().get_basename(), p_debug, p_flags);
  405. f = FileAccess::open(p_path, FileAccess::WRITE);
  406. if (!f) {
  407. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + p_path);
  408. return ERR_FILE_CANT_WRITE;
  409. }
  410. f->store_buffer(buf.ptr(), buf.size());
  411. memdelete(f);
  412. }
  413. Ref<Image> splash;
  414. const String splash_path = String(GLOBAL_GET("application/boot_splash/image")).strip_edges();
  415. if (!splash_path.empty()) {
  416. splash.instance();
  417. const Error err = splash->load(splash_path);
  418. if (err) {
  419. EditorNode::get_singleton()->show_warning(TTR("Could not read boot splash image file:") + "\n" + splash_path + "\n" + TTR("Using default boot splash image."));
  420. splash.unref();
  421. }
  422. }
  423. if (splash.is_null()) {
  424. splash = Ref<Image>(memnew(Image(boot_splash_png)));
  425. }
  426. const String splash_png_path = p_path.get_base_dir().plus_file(p_path.get_file().get_basename() + ".png");
  427. if (splash->save_png(splash_png_path) != OK) {
  428. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + splash_png_path);
  429. return ERR_FILE_CANT_WRITE;
  430. }
  431. // Save a favicon that can be accessed without waiting for the project to finish loading.
  432. // This way, the favicon can be displayed immediately when loading the page.
  433. Ref<Image> favicon;
  434. const String favicon_path = String(GLOBAL_GET("application/config/icon")).strip_edges();
  435. if (!favicon_path.empty()) {
  436. favicon.instance();
  437. const Error err = favicon->load(favicon_path);
  438. if (err) {
  439. favicon.unref();
  440. }
  441. }
  442. if (favicon.is_valid()) {
  443. const String favicon_png_path = p_path.get_base_dir().plus_file("favicon.png");
  444. if (favicon->save_png(favicon_png_path) != OK) {
  445. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + favicon_png_path);
  446. return ERR_FILE_CANT_WRITE;
  447. }
  448. }
  449. return OK;
  450. }
  451. bool EditorExportPlatformJavaScript::poll_export() {
  452. Ref<EditorExportPreset> preset;
  453. for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
  454. Ref<EditorExportPreset> ep = EditorExport::get_singleton()->get_export_preset(i);
  455. if (ep->is_runnable() && ep->get_platform() == this) {
  456. preset = ep;
  457. break;
  458. }
  459. }
  460. int prev = menu_options;
  461. menu_options = preset.is_valid();
  462. if (server->is_listening()) {
  463. if (menu_options == 0) {
  464. MutexLock lock(server_lock);
  465. server->stop();
  466. } else {
  467. menu_options += 1;
  468. }
  469. }
  470. return menu_options != prev;
  471. }
  472. Ref<ImageTexture> EditorExportPlatformJavaScript::get_option_icon(int p_index) const {
  473. return p_index == 1 ? stop_icon : EditorExportPlatform::get_option_icon(p_index);
  474. }
  475. int EditorExportPlatformJavaScript::get_options_count() const {
  476. return menu_options;
  477. }
  478. Error EditorExportPlatformJavaScript::run(const Ref<EditorExportPreset> &p_preset, int p_option, int p_debug_flags) {
  479. if (p_option == 1) {
  480. MutexLock lock(server_lock);
  481. server->stop();
  482. return OK;
  483. }
  484. const String basepath = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmp_js_export");
  485. Error err = export_project(p_preset, true, basepath + ".html", p_debug_flags);
  486. if (err != OK) {
  487. // Export generates several files, clean them up on failure.
  488. DirAccess::remove_file_or_error(basepath + ".html");
  489. DirAccess::remove_file_or_error(basepath + ".js");
  490. DirAccess::remove_file_or_error(basepath + ".worker.js");
  491. DirAccess::remove_file_or_error(basepath + ".audio.worklet.js");
  492. DirAccess::remove_file_or_error(basepath + ".pck");
  493. DirAccess::remove_file_or_error(basepath + ".png");
  494. DirAccess::remove_file_or_error(basepath + ".wasm");
  495. DirAccess::remove_file_or_error(EditorSettings::get_singleton()->get_cache_dir().plus_file("favicon.png"));
  496. return err;
  497. }
  498. const uint16_t bind_port = EDITOR_GET("export/web/http_port");
  499. // Resolve host if needed.
  500. const String bind_host = EDITOR_GET("export/web/http_host");
  501. IP_Address bind_ip;
  502. if (bind_host.is_valid_ip_address()) {
  503. bind_ip = bind_host;
  504. } else {
  505. bind_ip = IP::get_singleton()->resolve_hostname(bind_host);
  506. }
  507. ERR_FAIL_COND_V_MSG(!bind_ip.is_valid(), ERR_INVALID_PARAMETER, "Invalid editor setting 'export/web/http_host': '" + bind_host + "'. Try using '127.0.0.1'.");
  508. // Restart server.
  509. {
  510. MutexLock lock(server_lock);
  511. server->stop();
  512. err = server->listen(bind_port, bind_ip);
  513. }
  514. ERR_FAIL_COND_V_MSG(err != OK, err, "Unable to start HTTP server.");
  515. OS::get_singleton()->shell_open(String("http://" + bind_host + ":" + itos(bind_port) + "/tmp_js_export.html"));
  516. // FIXME: Find out how to clean up export files after running the successfully
  517. // exported game. Might not be trivial.
  518. return OK;
  519. }
  520. Ref<Texture2D> EditorExportPlatformJavaScript::get_run_icon() const {
  521. return run_icon;
  522. }
  523. void EditorExportPlatformJavaScript::_server_thread_poll(void *data) {
  524. EditorExportPlatformJavaScript *ej = (EditorExportPlatformJavaScript *)data;
  525. while (!ej->server_quit) {
  526. OS::get_singleton()->delay_usec(1000);
  527. {
  528. MutexLock lock(ej->server_lock);
  529. ej->server->poll();
  530. }
  531. }
  532. }
  533. EditorExportPlatformJavaScript::EditorExportPlatformJavaScript() {
  534. server.instance();
  535. server_quit = false;
  536. server_thread = Thread::create(_server_thread_poll, this);
  537. Ref<Image> img = memnew(Image(_javascript_logo));
  538. logo.instance();
  539. logo->create_from_image(img);
  540. img = Ref<Image>(memnew(Image(_javascript_run_icon)));
  541. run_icon.instance();
  542. run_icon->create_from_image(img);
  543. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  544. if (theme.is_valid()) {
  545. stop_icon = theme->get_icon("Stop", "EditorIcons");
  546. } else {
  547. stop_icon.instance();
  548. }
  549. menu_options = 0;
  550. }
  551. EditorExportPlatformJavaScript::~EditorExportPlatformJavaScript() {
  552. server->stop();
  553. server_quit = true;
  554. Thread::wait_to_finish(server_thread);
  555. memdelete(server_thread);
  556. }
  557. void register_javascript_exporter() {
  558. EDITOR_DEF("export/web/http_host", "localhost");
  559. EDITOR_DEF("export/web/http_port", 8060);
  560. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::INT, "export/web/http_port", PROPERTY_HINT_RANGE, "1,65535,1"));
  561. Ref<EditorExportPlatformJavaScript> platform;
  562. platform.instance();
  563. EditorExport::get_singleton()->add_export_platform(platform);
  564. }