export.cpp 25 KB

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