export.cpp 25 KB

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