export_plugin.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680
  1. /*************************************************************************/
  2. /* export_plugin.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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 "export_plugin.h"
  31. #include "core/config/project_settings.h"
  32. #include "editor/editor_node.h"
  33. Error EditorExportPlatformJavaScript::_extract_template(const String &p_template, const String &p_dir, const String &p_name, bool pwa) {
  34. FileAccess *src_f = nullptr;
  35. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  36. unzFile pkg = unzOpen2(p_template.utf8().get_data(), &io);
  37. if (!pkg) {
  38. EditorNode::get_singleton()->show_warning(TTR("Could not open template for export:") + "\n" + p_template);
  39. return ERR_FILE_NOT_FOUND;
  40. }
  41. if (unzGoToFirstFile(pkg) != UNZ_OK) {
  42. EditorNode::get_singleton()->show_warning(TTR("Invalid export template:") + "\n" + p_template);
  43. unzClose(pkg);
  44. return ERR_FILE_CORRUPT;
  45. }
  46. do {
  47. //get filename
  48. unz_file_info info;
  49. char fname[16384];
  50. unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  51. String file = String::utf8(fname);
  52. // Skip service worker and offline page if not exporting pwa.
  53. if (!pwa && (file == "godot.service.worker.js" || file == "godot.offline.html")) {
  54. continue;
  55. }
  56. Vector<uint8_t> data;
  57. data.resize(info.uncompressed_size);
  58. //read
  59. unzOpenCurrentFile(pkg);
  60. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  61. unzCloseCurrentFile(pkg);
  62. //write
  63. String dst = p_dir.plus_file(file.replace("godot", p_name));
  64. FileAccess *f = FileAccess::open(dst, FileAccess::WRITE);
  65. if (!f) {
  66. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + dst);
  67. unzClose(pkg);
  68. return ERR_FILE_CANT_WRITE;
  69. }
  70. f->store_buffer(data.ptr(), data.size());
  71. memdelete(f);
  72. } while (unzGoToNextFile(pkg) == UNZ_OK);
  73. unzClose(pkg);
  74. return OK;
  75. }
  76. Error EditorExportPlatformJavaScript::_write_or_error(const uint8_t *p_content, int p_size, String p_path) {
  77. FileAccess *f = FileAccess::open(p_path, FileAccess::WRITE);
  78. if (!f) {
  79. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + p_path);
  80. return ERR_FILE_CANT_WRITE;
  81. }
  82. f->store_buffer(p_content, p_size);
  83. memdelete(f);
  84. return OK;
  85. }
  86. void EditorExportPlatformJavaScript::_replace_strings(Map<String, String> p_replaces, Vector<uint8_t> &r_template) {
  87. String str_template = String::utf8(reinterpret_cast<const char *>(r_template.ptr()), r_template.size());
  88. String out;
  89. Vector<String> lines = str_template.split("\n");
  90. for (int i = 0; i < lines.size(); i++) {
  91. String current_line = lines[i];
  92. for (const KeyValue<String, String> &E : p_replaces) {
  93. current_line = current_line.replace(E.key, E.value);
  94. }
  95. out += current_line + "\n";
  96. }
  97. CharString cs = out.utf8();
  98. r_template.resize(cs.length());
  99. for (int i = 0; i < cs.length(); i++) {
  100. r_template.write[i] = cs[i];
  101. }
  102. }
  103. 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) {
  104. // Engine.js config
  105. Dictionary config;
  106. Array libs;
  107. for (int i = 0; i < p_shared_objects.size(); i++) {
  108. libs.push_back(p_shared_objects[i].path.get_file());
  109. }
  110. Vector<String> flags;
  111. gen_export_flags(flags, p_flags & (~DEBUG_FLAG_DUMB_CLIENT));
  112. Array args;
  113. for (int i = 0; i < flags.size(); i++) {
  114. args.push_back(flags[i]);
  115. }
  116. config["canvasResizePolicy"] = p_preset->get("html/canvas_resize_policy");
  117. config["experimentalVK"] = p_preset->get("html/experimental_virtual_keyboard");
  118. config["focusCanvas"] = p_preset->get("html/focus_canvas_on_start");
  119. config["gdnativeLibs"] = libs;
  120. config["executable"] = p_name;
  121. config["args"] = args;
  122. config["fileSizes"] = p_file_sizes;
  123. String head_include;
  124. if (p_preset->get("html/export_icon")) {
  125. head_include += "<link id='-gd-engine-icon' rel='icon' type='image/png' href='" + p_name + ".icon.png' />\n";
  126. head_include += "<link rel='apple-touch-icon' href='" + p_name + ".apple-touch-icon.png'/>\n";
  127. }
  128. if (p_preset->get("progressive_web_app/enabled")) {
  129. head_include += "<link rel='manifest' href='" + p_name + ".manifest.json'>\n";
  130. config["serviceWorker"] = p_name + ".service.worker.js";
  131. }
  132. // Replaces HTML string
  133. const String str_config = Variant(config).to_json_string();
  134. const String custom_head_include = p_preset->get("html/head_include");
  135. Map<String, String> replaces;
  136. replaces["$GODOT_URL"] = p_name + ".js";
  137. replaces["$GODOT_PROJECT_NAME"] = ProjectSettings::get_singleton()->get_setting("application/config/name");
  138. replaces["$GODOT_HEAD_INCLUDE"] = head_include + custom_head_include;
  139. replaces["$GODOT_CONFIG"] = str_config;
  140. _replace_strings(replaces, p_html);
  141. }
  142. Error EditorExportPlatformJavaScript::_add_manifest_icon(const String &p_path, const String &p_icon, int p_size, Array &r_arr) {
  143. const String name = p_path.get_file().get_basename();
  144. const String icon_name = vformat("%s.%dx%d.png", name, p_size, p_size);
  145. const String icon_dest = p_path.get_base_dir().plus_file(icon_name);
  146. Ref<Image> icon;
  147. if (!p_icon.is_empty()) {
  148. icon.instantiate();
  149. const Error err = ImageLoader::load_image(p_icon, icon);
  150. if (err != OK) {
  151. EditorNode::get_singleton()->show_warning(TTR("Could not read file:") + "\n" + p_icon);
  152. return err;
  153. }
  154. if (icon->get_width() != p_size || icon->get_height() != p_size) {
  155. icon->resize(p_size, p_size);
  156. }
  157. } else {
  158. icon = _get_project_icon();
  159. icon->resize(p_size, p_size);
  160. }
  161. const Error err = icon->save_png(icon_dest);
  162. if (err != OK) {
  163. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + icon_dest);
  164. return err;
  165. }
  166. Dictionary icon_dict;
  167. icon_dict["sizes"] = vformat("%dx%d", p_size, p_size);
  168. icon_dict["type"] = "image/png";
  169. icon_dict["src"] = icon_name;
  170. r_arr.push_back(icon_dict);
  171. return err;
  172. }
  173. Error EditorExportPlatformJavaScript::_build_pwa(const Ref<EditorExportPreset> &p_preset, const String p_path, const Vector<SharedObject> &p_shared_objects) {
  174. String proj_name = ProjectSettings::get_singleton()->get_setting("application/config/name");
  175. if (proj_name.is_empty()) {
  176. proj_name = "Godot Game";
  177. }
  178. // Service worker
  179. const String dir = p_path.get_base_dir();
  180. const String name = p_path.get_file().get_basename();
  181. const ExportMode mode = (ExportMode)(int)p_preset->get("variant/export_type");
  182. Map<String, String> replaces;
  183. replaces["@GODOT_VERSION@"] = String::num_int64(OS::get_singleton()->get_unix_time()) + "|" + String::num_int64(OS::get_singleton()->get_ticks_usec());
  184. replaces["@GODOT_NAME@"] = proj_name.substr(0, 16);
  185. replaces["@GODOT_OFFLINE_PAGE@"] = name + ".offline.html";
  186. // Files cached during worker install.
  187. Array cache_files;
  188. cache_files.push_back(name + ".html");
  189. cache_files.push_back(name + ".js");
  190. cache_files.push_back(name + ".offline.html");
  191. if (p_preset->get("html/export_icon")) {
  192. cache_files.push_back(name + ".icon.png");
  193. cache_files.push_back(name + ".apple-touch-icon.png");
  194. }
  195. if (mode == EXPORT_MODE_THREADS) {
  196. cache_files.push_back(name + ".worker.js");
  197. cache_files.push_back(name + ".audio.worklet.js");
  198. }
  199. replaces["@GODOT_CACHE@"] = Variant(cache_files).to_json_string();
  200. // Heavy files that are cached on demand.
  201. Array opt_cache_files;
  202. opt_cache_files.push_back(name + ".wasm");
  203. opt_cache_files.push_back(name + ".pck");
  204. if (mode == EXPORT_MODE_GDNATIVE) {
  205. opt_cache_files.push_back(name + ".side.wasm");
  206. for (int i = 0; i < p_shared_objects.size(); i++) {
  207. opt_cache_files.push_back(p_shared_objects[i].path.get_file());
  208. }
  209. }
  210. replaces["@GODOT_OPT_CACHE@"] = Variant(opt_cache_files).to_json_string();
  211. const String sw_path = dir.plus_file(name + ".service.worker.js");
  212. Vector<uint8_t> sw;
  213. {
  214. FileAccess *f = FileAccess::open(sw_path, FileAccess::READ);
  215. if (!f) {
  216. EditorNode::get_singleton()->show_warning(TTR("Could not read file:") + "\n" + sw_path);
  217. return ERR_FILE_CANT_READ;
  218. }
  219. sw.resize(f->get_length());
  220. f->get_buffer(sw.ptrw(), sw.size());
  221. memdelete(f);
  222. f = nullptr;
  223. }
  224. _replace_strings(replaces, sw);
  225. Error err = _write_or_error(sw.ptr(), sw.size(), dir.plus_file(name + ".service.worker.js"));
  226. if (err != OK) {
  227. return err;
  228. }
  229. // Custom offline page
  230. const String offline_page = p_preset->get("progressive_web_app/offline_page");
  231. if (!offline_page.is_empty()) {
  232. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  233. const String offline_dest = dir.plus_file(name + ".offline.html");
  234. err = da->copy(ProjectSettings::get_singleton()->globalize_path(offline_page), offline_dest);
  235. if (err != OK) {
  236. EditorNode::get_singleton()->show_warning(TTR("Could not read file:") + "\n" + offline_dest);
  237. return err;
  238. }
  239. }
  240. // Manifest
  241. const char *modes[4] = { "fullscreen", "standalone", "minimal-ui", "browser" };
  242. const char *orientations[3] = { "any", "landscape", "portrait" };
  243. const int display = CLAMP(int(p_preset->get("progressive_web_app/display")), 0, 4);
  244. const int orientation = CLAMP(int(p_preset->get("progressive_web_app/orientation")), 0, 3);
  245. Dictionary manifest;
  246. manifest["name"] = proj_name;
  247. manifest["start_url"] = "./" + name + ".html";
  248. manifest["display"] = String::utf8(modes[display]);
  249. manifest["orientation"] = String::utf8(orientations[orientation]);
  250. manifest["background_color"] = "#" + p_preset->get("progressive_web_app/background_color").operator Color().to_html(false);
  251. Array icons_arr;
  252. const String icon144_path = p_preset->get("progressive_web_app/icon_144x144");
  253. err = _add_manifest_icon(p_path, icon144_path, 144, icons_arr);
  254. if (err != OK) {
  255. return err;
  256. }
  257. const String icon180_path = p_preset->get("progressive_web_app/icon_180x180");
  258. err = _add_manifest_icon(p_path, icon180_path, 180, icons_arr);
  259. if (err != OK) {
  260. return err;
  261. }
  262. const String icon512_path = p_preset->get("progressive_web_app/icon_512x512");
  263. err = _add_manifest_icon(p_path, icon512_path, 512, icons_arr);
  264. if (err != OK) {
  265. return err;
  266. }
  267. manifest["icons"] = icons_arr;
  268. CharString cs = Variant(manifest).to_json_string().utf8();
  269. err = _write_or_error((const uint8_t *)cs.get_data(), cs.length(), dir.plus_file(name + ".manifest.json"));
  270. if (err != OK) {
  271. return err;
  272. }
  273. return OK;
  274. }
  275. void EditorExportPlatformJavaScript::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  276. if (p_preset->get("vram_texture_compression/for_desktop")) {
  277. r_features->push_back("s3tc");
  278. }
  279. if (p_preset->get("vram_texture_compression/for_mobile")) {
  280. String driver = ProjectSettings::get_singleton()->get("rendering/driver/driver_name");
  281. if (driver == "opengl3") {
  282. r_features->push_back("etc");
  283. } else if (driver == "vulkan") {
  284. // FIXME: Review if this is correct.
  285. r_features->push_back("etc2");
  286. }
  287. }
  288. ExportMode mode = (ExportMode)(int)p_preset->get("variant/export_type");
  289. if (mode == EXPORT_MODE_THREADS) {
  290. r_features->push_back("threads");
  291. } else if (mode == EXPORT_MODE_GDNATIVE) {
  292. r_features->push_back("wasm32");
  293. }
  294. }
  295. void EditorExportPlatformJavaScript::get_export_options(List<ExportOption> *r_options) {
  296. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  297. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  298. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "variant/export_type", PROPERTY_HINT_ENUM, "Regular,Threads,GDNative"), 0)); // Export type.
  299. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "vram_texture_compression/for_desktop"), true)); // S3TC
  300. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "vram_texture_compression/for_mobile"), false)); // ETC or ETC2, depending on renderer
  301. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "html/export_icon"), true));
  302. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "html/custom_html_shell", PROPERTY_HINT_FILE, "*.html"), ""));
  303. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "html/head_include", PROPERTY_HINT_MULTILINE_TEXT), ""));
  304. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "html/canvas_resize_policy", PROPERTY_HINT_ENUM, "None,Project,Adaptive"), 2));
  305. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "html/focus_canvas_on_start"), true));
  306. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "html/experimental_virtual_keyboard"), false));
  307. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "progressive_web_app/enabled"), false));
  308. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "progressive_web_app/offline_page", PROPERTY_HINT_FILE, "*.html"), ""));
  309. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "progressive_web_app/display", PROPERTY_HINT_ENUM, "Fullscreen,Standalone,Minimal UI,Browser"), 1));
  310. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "progressive_web_app/orientation", PROPERTY_HINT_ENUM, "Any,Landscape,Portrait"), 0));
  311. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "progressive_web_app/icon_144x144", PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  312. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "progressive_web_app/icon_180x180", PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  313. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "progressive_web_app/icon_512x512", PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  314. r_options->push_back(ExportOption(PropertyInfo(Variant::COLOR, "progressive_web_app/background_color", PROPERTY_HINT_COLOR_NO_ALPHA), Color()));
  315. }
  316. String EditorExportPlatformJavaScript::get_name() const {
  317. return "HTML5";
  318. }
  319. String EditorExportPlatformJavaScript::get_os_name() const {
  320. return "HTML5";
  321. }
  322. Ref<Texture2D> EditorExportPlatformJavaScript::get_logo() const {
  323. return logo;
  324. }
  325. bool EditorExportPlatformJavaScript::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  326. String err;
  327. bool valid = false;
  328. ExportMode mode = (ExportMode)(int)p_preset->get("variant/export_type");
  329. // Look for export templates (first official, and if defined custom templates).
  330. bool dvalid = exists_export_template(_get_template_name(mode, true), &err);
  331. bool rvalid = exists_export_template(_get_template_name(mode, false), &err);
  332. if (p_preset->get("custom_template/debug") != "") {
  333. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  334. if (!dvalid) {
  335. err += TTR("Custom debug template not found.") + "\n";
  336. }
  337. }
  338. if (p_preset->get("custom_template/release") != "") {
  339. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  340. if (!rvalid) {
  341. err += TTR("Custom release template not found.") + "\n";
  342. }
  343. }
  344. valid = dvalid || rvalid;
  345. r_missing_templates = !valid;
  346. // Validate the rest of the configuration.
  347. if (p_preset->get("vram_texture_compression/for_mobile")) {
  348. String etc_error = test_etc2();
  349. if (!etc_error.is_empty()) {
  350. valid = false;
  351. err += etc_error;
  352. }
  353. }
  354. if (!err.is_empty()) {
  355. r_error = err;
  356. }
  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. const String custom_debug = p_preset->get("custom_template/debug");
  367. const String custom_release = p_preset->get("custom_template/release");
  368. const String custom_html = p_preset->get("html/custom_html_shell");
  369. const bool export_icon = p_preset->get("html/export_icon");
  370. const bool pwa = p_preset->get("progressive_web_app/enabled");
  371. const String base_dir = p_path.get_base_dir();
  372. const String base_path = p_path.get_basename();
  373. const String base_name = p_path.get_file().get_basename();
  374. // Find the correct template
  375. String template_path = p_debug ? custom_debug : custom_release;
  376. template_path = template_path.strip_edges();
  377. if (template_path.is_empty()) {
  378. ExportMode mode = (ExportMode)(int)p_preset->get("variant/export_type");
  379. template_path = find_export_template(_get_template_name(mode, p_debug));
  380. }
  381. if (!DirAccess::exists(base_dir)) {
  382. return ERR_FILE_BAD_PATH;
  383. }
  384. if (!template_path.is_empty() && !FileAccess::exists(template_path)) {
  385. EditorNode::get_singleton()->show_warning(TTR("Template file not found:") + "\n" + template_path);
  386. return ERR_FILE_NOT_FOUND;
  387. }
  388. // Export pck and shared objects
  389. Vector<SharedObject> shared_objects;
  390. String pck_path = base_path + ".pck";
  391. Error error = save_pack(p_preset, pck_path, &shared_objects);
  392. if (error != OK) {
  393. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + pck_path);
  394. return error;
  395. }
  396. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  397. for (int i = 0; i < shared_objects.size(); i++) {
  398. String dst = base_dir.plus_file(shared_objects[i].path.get_file());
  399. error = da->copy(shared_objects[i].path, dst);
  400. if (error != OK) {
  401. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + shared_objects[i].path.get_file());
  402. memdelete(da);
  403. return error;
  404. }
  405. }
  406. memdelete(da);
  407. da = nullptr;
  408. // Extract templates.
  409. error = _extract_template(template_path, base_dir, base_name, pwa);
  410. if (error) {
  411. return error;
  412. }
  413. // Parse generated file sizes (pck and wasm, to help show a meaningful loading bar).
  414. Dictionary file_sizes;
  415. FileAccess *f = nullptr;
  416. f = FileAccess::open(pck_path, FileAccess::READ);
  417. if (f) {
  418. file_sizes[pck_path.get_file()] = (uint64_t)f->get_length();
  419. memdelete(f);
  420. f = nullptr;
  421. }
  422. f = FileAccess::open(base_path + ".wasm", FileAccess::READ);
  423. if (f) {
  424. file_sizes[base_name + ".wasm"] = (uint64_t)f->get_length();
  425. memdelete(f);
  426. f = nullptr;
  427. }
  428. // Read the HTML shell file (custom or from template).
  429. const String html_path = custom_html.is_empty() ? base_path + ".html" : custom_html;
  430. Vector<uint8_t> html;
  431. f = FileAccess::open(html_path, FileAccess::READ);
  432. if (!f) {
  433. EditorNode::get_singleton()->show_warning(TTR("Could not read HTML shell:") + "\n" + html_path);
  434. return ERR_FILE_CANT_READ;
  435. }
  436. html.resize(f->get_length());
  437. f->get_buffer(html.ptrw(), html.size());
  438. memdelete(f);
  439. f = nullptr;
  440. // Generate HTML file with replaced strings.
  441. _fix_html(html, p_preset, base_name, p_debug, p_flags, shared_objects, file_sizes);
  442. Error err = _write_or_error(html.ptr(), html.size(), p_path);
  443. if (err != OK) {
  444. return err;
  445. }
  446. html.resize(0);
  447. // Export splash (why?)
  448. Ref<Image> splash = _get_project_splash();
  449. const String splash_png_path = base_path + ".png";
  450. if (splash->save_png(splash_png_path) != OK) {
  451. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + splash_png_path);
  452. return ERR_FILE_CANT_WRITE;
  453. }
  454. // Save a favicon that can be accessed without waiting for the project to finish loading.
  455. // This way, the favicon can be displayed immediately when loading the page.
  456. if (export_icon) {
  457. Ref<Image> favicon = _get_project_icon();
  458. const String favicon_png_path = base_path + ".icon.png";
  459. if (favicon->save_png(favicon_png_path) != OK) {
  460. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + favicon_png_path);
  461. return ERR_FILE_CANT_WRITE;
  462. }
  463. favicon->resize(180, 180);
  464. const String apple_icon_png_path = base_path + ".apple-touch-icon.png";
  465. if (favicon->save_png(apple_icon_png_path) != OK) {
  466. EditorNode::get_singleton()->show_warning(TTR("Could not write file:") + "\n" + apple_icon_png_path);
  467. return ERR_FILE_CANT_WRITE;
  468. }
  469. }
  470. // Generate the PWA worker and manifest
  471. if (pwa) {
  472. err = _build_pwa(p_preset, p_path, shared_objects);
  473. if (err != OK) {
  474. return err;
  475. }
  476. }
  477. return OK;
  478. }
  479. bool EditorExportPlatformJavaScript::poll_export() {
  480. Ref<EditorExportPreset> preset;
  481. for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
  482. Ref<EditorExportPreset> ep = EditorExport::get_singleton()->get_export_preset(i);
  483. if (ep->is_runnable() && ep->get_platform() == this) {
  484. preset = ep;
  485. break;
  486. }
  487. }
  488. int prev = menu_options;
  489. menu_options = preset.is_valid();
  490. if (server->is_listening()) {
  491. if (menu_options == 0) {
  492. MutexLock lock(server_lock);
  493. server->stop();
  494. } else {
  495. menu_options += 1;
  496. }
  497. }
  498. return menu_options != prev;
  499. }
  500. Ref<ImageTexture> EditorExportPlatformJavaScript::get_option_icon(int p_index) const {
  501. return p_index == 1 ? stop_icon : EditorExportPlatform::get_option_icon(p_index);
  502. }
  503. int EditorExportPlatformJavaScript::get_options_count() const {
  504. return menu_options;
  505. }
  506. Error EditorExportPlatformJavaScript::run(const Ref<EditorExportPreset> &p_preset, int p_option, int p_debug_flags) {
  507. if (p_option == 1) {
  508. MutexLock lock(server_lock);
  509. server->stop();
  510. return OK;
  511. }
  512. const String dest = EditorPaths::get_singleton()->get_cache_dir().plus_file("web");
  513. DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  514. if (!da->dir_exists(dest)) {
  515. Error err = da->make_dir_recursive(dest);
  516. if (err != OK) {
  517. EditorNode::get_singleton()->show_warning(TTR("Could not create HTTP server directory:") + "\n" + dest);
  518. return err;
  519. }
  520. }
  521. const String basepath = dest.plus_file("tmp_js_export");
  522. Error err = export_project(p_preset, true, basepath + ".html", p_debug_flags);
  523. if (err != OK) {
  524. // Export generates several files, clean them up on failure.
  525. DirAccess::remove_file_or_error(basepath + ".html");
  526. DirAccess::remove_file_or_error(basepath + ".offline.html");
  527. DirAccess::remove_file_or_error(basepath + ".js");
  528. DirAccess::remove_file_or_error(basepath + ".worker.js");
  529. DirAccess::remove_file_or_error(basepath + ".audio.worklet.js");
  530. DirAccess::remove_file_or_error(basepath + ".service.worker.js");
  531. DirAccess::remove_file_or_error(basepath + ".pck");
  532. DirAccess::remove_file_or_error(basepath + ".png");
  533. DirAccess::remove_file_or_error(basepath + ".side.wasm");
  534. DirAccess::remove_file_or_error(basepath + ".wasm");
  535. DirAccess::remove_file_or_error(basepath + ".icon.png");
  536. DirAccess::remove_file_or_error(basepath + ".apple-touch-icon.png");
  537. return err;
  538. }
  539. const uint16_t bind_port = EDITOR_GET("export/web/http_port");
  540. // Resolve host if needed.
  541. const String bind_host = EDITOR_GET("export/web/http_host");
  542. IPAddress bind_ip;
  543. if (bind_host.is_valid_ip_address()) {
  544. bind_ip = bind_host;
  545. } else {
  546. bind_ip = IP::get_singleton()->resolve_hostname(bind_host);
  547. }
  548. 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'.");
  549. const bool use_ssl = EDITOR_GET("export/web/use_ssl");
  550. const String ssl_key = EDITOR_GET("export/web/ssl_key");
  551. const String ssl_cert = EDITOR_GET("export/web/ssl_certificate");
  552. // Restart server.
  553. {
  554. MutexLock lock(server_lock);
  555. server->stop();
  556. err = server->listen(bind_port, bind_ip, use_ssl, ssl_key, ssl_cert);
  557. }
  558. if (err != OK) {
  559. EditorNode::get_singleton()->show_warning(TTR("Error starting HTTP server:") + "\n" + itos(err));
  560. return err;
  561. }
  562. OS::get_singleton()->shell_open(String((use_ssl ? "https://" : "http://") + bind_host + ":" + itos(bind_port) + "/tmp_js_export.html"));
  563. // FIXME: Find out how to clean up export files after running the successfully
  564. // exported game. Might not be trivial.
  565. return OK;
  566. }
  567. Ref<Texture2D> EditorExportPlatformJavaScript::get_run_icon() const {
  568. return run_icon;
  569. }
  570. void EditorExportPlatformJavaScript::_server_thread_poll(void *data) {
  571. EditorExportPlatformJavaScript *ej = (EditorExportPlatformJavaScript *)data;
  572. while (!ej->server_quit) {
  573. OS::get_singleton()->delay_usec(6900);
  574. {
  575. MutexLock lock(ej->server_lock);
  576. ej->server->poll();
  577. }
  578. }
  579. }
  580. EditorExportPlatformJavaScript::EditorExportPlatformJavaScript() {
  581. server.instantiate();
  582. server_thread.start(_server_thread_poll, this);
  583. Ref<Image> img = memnew(Image(_javascript_logo));
  584. logo.instantiate();
  585. logo->create_from_image(img);
  586. img = Ref<Image>(memnew(Image(_javascript_run_icon)));
  587. run_icon.instantiate();
  588. run_icon->create_from_image(img);
  589. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  590. if (theme.is_valid()) {
  591. stop_icon = theme->get_icon(SNAME("Stop"), SNAME("EditorIcons"));
  592. } else {
  593. stop_icon.instantiate();
  594. }
  595. }
  596. EditorExportPlatformJavaScript::~EditorExportPlatformJavaScript() {
  597. server->stop();
  598. server_quit = true;
  599. server_thread.wait_to_finish();
  600. }