2
0

export.cpp 25 KB

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