export_plugin.cpp 28 KB

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