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