export.cpp 22 KB

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