export_plugin.cpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634
  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 "core/io/dir_access.h"
  35. #include "editor/editor_node.h"
  36. #include "editor/editor_string_names.h"
  37. #include "editor/export/editor_export.h"
  38. #include "editor/file_system/editor_paths.h"
  39. #include "editor/themes/editor_scale.h"
  40. #include "modules/svg/image_loader_svg.h"
  41. Error EditorExportPlatformLinuxBSD::_export_debug_script(const Ref<EditorExportPreset> &p_preset, const String &p_app_name, const String &p_pkg_name, const String &p_path) {
  42. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::WRITE);
  43. if (f.is_null()) {
  44. add_message(EXPORT_MESSAGE_ERROR, TTR("Debug Script Export"), vformat(TTR("Could not open file \"%s\"."), p_path));
  45. return ERR_CANT_CREATE;
  46. }
  47. f->store_line("#!/bin/sh");
  48. f->store_line("printf '\\033c\\033]0;%s\\a' " + p_app_name);
  49. f->store_line("base_path=\"$(dirname \"$(realpath \"$0\")\")\"");
  50. f->store_line("\"$base_path/" + p_pkg_name + "\" \"$@\"");
  51. return OK;
  52. }
  53. Error EditorExportPlatformLinuxBSD::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  54. String custom_debug = p_preset->get("custom_template/debug");
  55. String custom_release = p_preset->get("custom_template/release");
  56. String arch = p_preset->get("binary_format/architecture");
  57. String template_path = p_debug ? custom_debug : custom_release;
  58. template_path = template_path.strip_edges();
  59. if (!template_path.is_empty()) {
  60. String exe_arch = _get_exe_arch(template_path);
  61. if (arch != exe_arch) {
  62. add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), vformat(TTR("Mismatching custom export template executable architecture: found \"%s\", expected \"%s\"."), exe_arch, arch));
  63. return ERR_CANT_CREATE;
  64. }
  65. }
  66. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  67. if (da->file_exists(template_path.get_base_dir().path_join("libaccesskit." + arch + ".so"))) {
  68. da->copy(template_path.get_base_dir().path_join("libaccesskit." + arch + ".so"), p_path.get_base_dir().path_join("libaccesskit." + arch + ".so"), get_chmod_flags());
  69. }
  70. bool export_as_zip = p_path.ends_with("zip");
  71. String pkg_name;
  72. if (String(get_project_setting(p_preset, "application/config/name")) != "") {
  73. pkg_name = String(get_project_setting(p_preset, "application/config/name"));
  74. } else {
  75. pkg_name = "Unnamed";
  76. }
  77. pkg_name = OS::get_singleton()->get_safe_dir_name(pkg_name);
  78. // Setup temp folder.
  79. String path = p_path;
  80. String tmp_dir_path = EditorPaths::get_singleton()->get_temp_dir().path_join(pkg_name);
  81. Ref<DirAccess> tmp_app_dir = DirAccess::create_for_path(tmp_dir_path);
  82. if (export_as_zip) {
  83. if (tmp_app_dir.is_null()) {
  84. add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), vformat(TTR("Could not create and open the directory: \"%s\""), tmp_dir_path));
  85. return ERR_CANT_CREATE;
  86. }
  87. if (DirAccess::exists(tmp_dir_path)) {
  88. if (tmp_app_dir->change_dir(tmp_dir_path) == OK) {
  89. tmp_app_dir->erase_contents_recursive();
  90. }
  91. }
  92. tmp_app_dir->make_dir_recursive(tmp_dir_path);
  93. path = tmp_dir_path.path_join(p_path.get_file().get_basename());
  94. }
  95. // Export project.
  96. Error err = EditorExportPlatformPC::export_project(p_preset, p_debug, path, p_flags);
  97. if (err != OK) {
  98. // Message is supplied by the subroutine method.
  99. return err;
  100. }
  101. // Save console wrapper.
  102. int con_scr = p_preset->get("debug/export_console_wrapper");
  103. if ((con_scr == 1 && p_debug) || (con_scr == 2)) {
  104. String scr_path = path.get_basename() + ".sh";
  105. err = _export_debug_script(p_preset, pkg_name, path.get_file(), scr_path);
  106. FileAccess::set_unix_permissions(scr_path, 0755);
  107. if (err != OK) {
  108. add_message(EXPORT_MESSAGE_ERROR, TTR("Debug Console Export"), TTR("Could not create console wrapper."));
  109. }
  110. }
  111. // ZIP project.
  112. if (export_as_zip) {
  113. if (FileAccess::exists(p_path)) {
  114. OS::get_singleton()->move_to_trash(p_path);
  115. }
  116. Ref<FileAccess> io_fa_dst;
  117. zlib_filefunc_def io_dst = zipio_create_io(&io_fa_dst);
  118. zipFile zip = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io_dst);
  119. zip_folder_recursive(zip, tmp_dir_path, "", pkg_name);
  120. zipClose(zip, nullptr);
  121. if (tmp_app_dir->change_dir(tmp_dir_path) == OK) {
  122. tmp_app_dir->erase_contents_recursive();
  123. tmp_app_dir->change_dir("..");
  124. tmp_app_dir->remove(pkg_name);
  125. }
  126. }
  127. return err;
  128. }
  129. String EditorExportPlatformLinuxBSD::get_template_file_name(const String &p_target, const String &p_arch) const {
  130. return "linux_" + p_target + "." + p_arch;
  131. }
  132. List<String> EditorExportPlatformLinuxBSD::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  133. List<String> list;
  134. list.push_back(p_preset->get("binary_format/architecture"));
  135. list.push_back("zip");
  136. return list;
  137. }
  138. bool EditorExportPlatformLinuxBSD::get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const {
  139. if (p_preset == nullptr) {
  140. return true;
  141. }
  142. bool advanced_options_enabled = p_preset->are_advanced_options_enabled();
  143. // Hide SSH options.
  144. bool ssh = p_preset->get("ssh_remote_deploy/enabled");
  145. if (!ssh && p_option != "ssh_remote_deploy/enabled" && p_option.begins_with("ssh_remote_deploy/")) {
  146. return false;
  147. }
  148. if (p_option == "dotnet/embed_build_outputs" ||
  149. p_option == "custom_template/debug" ||
  150. p_option == "custom_template/release") {
  151. return advanced_options_enabled;
  152. }
  153. return true;
  154. }
  155. void EditorExportPlatformLinuxBSD::get_export_options(List<ExportOption> *r_options) const {
  156. EditorExportPlatformPC::get_export_options(r_options);
  157. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "binary_format/architecture", PROPERTY_HINT_ENUM, "x86_64,x86_32,arm64,arm32,rv64,ppc64,loongarch64"), "x86_64"));
  158. String run_script = "#!/usr/bin/env bash\n"
  159. "export DISPLAY=:0\n"
  160. "unzip -o -q \"{temp_dir}/{archive_name}\" -d \"{temp_dir}\"\n"
  161. "\"{temp_dir}/{exe_name}\" {cmd_args}";
  162. String cleanup_script = "#!/usr/bin/env bash\n"
  163. "pkill -x -f \"{temp_dir}/{exe_name} {cmd_args}\"\n"
  164. "rm -rf \"{temp_dir}\"";
  165. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "ssh_remote_deploy/enabled"), false, true));
  166. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/host"), "user@host_ip"));
  167. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/port"), "22"));
  168. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/extra_args_ssh", PROPERTY_HINT_MULTILINE_TEXT), ""));
  169. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/extra_args_scp", PROPERTY_HINT_MULTILINE_TEXT), ""));
  170. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/run_script", PROPERTY_HINT_MULTILINE_TEXT), run_script));
  171. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/cleanup_script", PROPERTY_HINT_MULTILINE_TEXT), cleanup_script));
  172. }
  173. bool EditorExportPlatformLinuxBSD::is_elf(const String &p_path) const {
  174. Ref<FileAccess> fb = FileAccess::open(p_path, FileAccess::READ);
  175. ERR_FAIL_COND_V_MSG(fb.is_null(), false, vformat("Can't open file: \"%s\".", p_path));
  176. uint32_t magic = fb->get_32();
  177. return (magic == 0x464c457f);
  178. }
  179. bool EditorExportPlatformLinuxBSD::is_shebang(const String &p_path) const {
  180. Ref<FileAccess> fb = FileAccess::open(p_path, FileAccess::READ);
  181. ERR_FAIL_COND_V_MSG(fb.is_null(), false, vformat("Can't open file: \"%s\".", p_path));
  182. uint16_t magic = fb->get_16();
  183. return (magic == 0x2123);
  184. }
  185. bool EditorExportPlatformLinuxBSD::is_executable(const String &p_path) const {
  186. return is_elf(p_path) || is_shebang(p_path);
  187. }
  188. bool EditorExportPlatformLinuxBSD::has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const {
  189. String err;
  190. bool valid = EditorExportPlatformPC::has_valid_export_configuration(p_preset, err, r_missing_templates, p_debug);
  191. String custom_debug = p_preset->get("custom_template/debug").operator String().strip_edges();
  192. String custom_release = p_preset->get("custom_template/release").operator String().strip_edges();
  193. String arch = p_preset->get("binary_format/architecture");
  194. if (!custom_debug.is_empty() && FileAccess::exists(custom_debug)) {
  195. String exe_arch = _get_exe_arch(custom_debug);
  196. if (arch != exe_arch) {
  197. err += vformat(TTR("Mismatching custom debug export template executable architecture: found \"%s\", expected \"%s\"."), exe_arch, arch) + "\n";
  198. }
  199. }
  200. if (!custom_release.is_empty() && FileAccess::exists(custom_release)) {
  201. String exe_arch = _get_exe_arch(custom_release);
  202. if (arch != exe_arch) {
  203. err += vformat(TTR("Mismatching custom release export template executable architecture: found \"%s\", expected \"%s\"."), exe_arch, arch) + "\n";
  204. }
  205. }
  206. if (!err.is_empty()) {
  207. r_error = err;
  208. }
  209. return valid;
  210. }
  211. String EditorExportPlatformLinuxBSD::_get_exe_arch(const String &p_path) const {
  212. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ);
  213. if (f.is_null()) {
  214. return "invalid";
  215. }
  216. // Read and check ELF magic number.
  217. {
  218. uint32_t magic = f->get_32();
  219. if (magic != 0x464c457f) { // 0x7F + "ELF"
  220. return "invalid";
  221. }
  222. }
  223. // Process header.
  224. int64_t header_pos = f->get_position();
  225. f->seek(header_pos + 14);
  226. uint16_t machine = f->get_16();
  227. f->close();
  228. switch (machine) {
  229. case 0x0003:
  230. return "x86_32";
  231. case 0x003e:
  232. return "x86_64";
  233. case 0x0015:
  234. return "ppc64";
  235. case 0x0028:
  236. return "arm32";
  237. case 0x00b7:
  238. return "arm64";
  239. case 0x00f3:
  240. return "rv64";
  241. case 0x0102:
  242. return "loongarch64";
  243. default:
  244. return "unknown";
  245. }
  246. }
  247. Error EditorExportPlatformLinuxBSD::fixup_embedded_pck(const String &p_path, int64_t p_embedded_start, int64_t p_embedded_size) {
  248. // Patch the header of the "pck" section in the ELF file so that it corresponds to the embedded data.
  249. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ_WRITE);
  250. if (f.is_null()) {
  251. add_message(EXPORT_MESSAGE_ERROR, TTR("PCK Embedding"), vformat(TTR("Failed to open executable file \"%s\"."), p_path));
  252. return ERR_CANT_OPEN;
  253. }
  254. // Read and check ELF magic number.
  255. {
  256. uint32_t magic = f->get_32();
  257. if (magic != 0x464c457f) { // 0x7F + "ELF"
  258. add_message(EXPORT_MESSAGE_ERROR, TTR("PCK Embedding"), TTR("Executable file header corrupted."));
  259. return ERR_FILE_CORRUPT;
  260. }
  261. }
  262. // Read program architecture bits from class field.
  263. int bits = f->get_8() * 32;
  264. if (bits == 32 && p_embedded_size >= 0x100000000) {
  265. add_message(EXPORT_MESSAGE_ERROR, TTR("PCK Embedding"), TTR("32-bit executables cannot have embedded data >= 4 GiB."));
  266. }
  267. // Get info about the section header table.
  268. int64_t section_table_pos;
  269. int64_t section_header_size;
  270. if (bits == 32) {
  271. section_header_size = 40;
  272. f->seek(0x20);
  273. section_table_pos = f->get_32();
  274. f->seek(0x30);
  275. } else { // 64
  276. section_header_size = 64;
  277. f->seek(0x28);
  278. section_table_pos = f->get_64();
  279. f->seek(0x3c);
  280. }
  281. int num_sections = f->get_16();
  282. int string_section_idx = f->get_16();
  283. // Load the strings table.
  284. uint8_t *strings;
  285. {
  286. // Jump to the strings section header.
  287. f->seek(section_table_pos + string_section_idx * section_header_size);
  288. // Read strings data size and offset.
  289. int64_t string_data_pos;
  290. int64_t string_data_size;
  291. if (bits == 32) {
  292. f->seek(f->get_position() + 0x10);
  293. string_data_pos = f->get_32();
  294. string_data_size = f->get_32();
  295. } else { // 64
  296. f->seek(f->get_position() + 0x18);
  297. string_data_pos = f->get_64();
  298. string_data_size = f->get_64();
  299. }
  300. // Read strings data.
  301. f->seek(string_data_pos);
  302. strings = (uint8_t *)memalloc(string_data_size);
  303. if (!strings) {
  304. return ERR_OUT_OF_MEMORY;
  305. }
  306. f->get_buffer(strings, string_data_size);
  307. }
  308. // Search for the "pck" section.
  309. bool found = false;
  310. for (int i = 0; i < num_sections; ++i) {
  311. int64_t section_header_pos = section_table_pos + i * section_header_size;
  312. f->seek(section_header_pos);
  313. uint32_t name_offset = f->get_32();
  314. if (strcmp((char *)strings + name_offset, "pck") == 0) {
  315. // "pck" section found, let's patch!
  316. if (bits == 32) {
  317. f->seek(section_header_pos + 0x10);
  318. f->store_32(p_embedded_start);
  319. f->store_32(p_embedded_size);
  320. } else { // 64
  321. f->seek(section_header_pos + 0x18);
  322. f->store_64(p_embedded_start);
  323. f->store_64(p_embedded_size);
  324. }
  325. found = true;
  326. break;
  327. }
  328. }
  329. memfree(strings);
  330. if (!found) {
  331. add_message(EXPORT_MESSAGE_ERROR, TTR("PCK Embedding"), TTR("Executable \"pck\" section not found."));
  332. return ERR_FILE_CORRUPT;
  333. }
  334. return OK;
  335. }
  336. Ref<Texture2D> EditorExportPlatformLinuxBSD::get_run_icon() const {
  337. return run_icon;
  338. }
  339. bool EditorExportPlatformLinuxBSD::poll_export() {
  340. Ref<EditorExportPreset> preset;
  341. for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
  342. Ref<EditorExportPreset> ep = EditorExport::get_singleton()->get_export_preset(i);
  343. if (ep->is_runnable() && ep->get_platform() == this) {
  344. preset = ep;
  345. break;
  346. }
  347. }
  348. int prev = menu_options;
  349. menu_options = (preset.is_valid() && preset->get("ssh_remote_deploy/enabled").operator bool());
  350. if (ssh_pid != 0 || !cleanup_commands.is_empty()) {
  351. if (menu_options == 0) {
  352. cleanup();
  353. } else {
  354. menu_options += 1;
  355. }
  356. }
  357. return menu_options != prev;
  358. }
  359. Ref<Texture2D> EditorExportPlatformLinuxBSD::get_option_icon(int p_index) const {
  360. if (p_index == 1) {
  361. return stop_icon;
  362. } else {
  363. return EditorExportPlatform::get_option_icon(p_index);
  364. }
  365. }
  366. int EditorExportPlatformLinuxBSD::get_options_count() const {
  367. return menu_options;
  368. }
  369. String EditorExportPlatformLinuxBSD::get_option_label(int p_index) const {
  370. return (p_index) ? TTR("Stop and uninstall") : TTR("Run on remote Linux/BSD system");
  371. }
  372. String EditorExportPlatformLinuxBSD::get_option_tooltip(int p_index) const {
  373. return (p_index) ? TTR("Stop and uninstall running project from the remote system") : TTR("Run exported project on remote Linux/BSD system");
  374. }
  375. void EditorExportPlatformLinuxBSD::cleanup() {
  376. if (ssh_pid != 0 && OS::get_singleton()->is_process_running(ssh_pid)) {
  377. print_line("Terminating connection...");
  378. OS::get_singleton()->kill(ssh_pid);
  379. OS::get_singleton()->delay_usec(1000);
  380. }
  381. if (!cleanup_commands.is_empty()) {
  382. print_line("Stopping and deleting previous version...");
  383. for (const SSHCleanupCommand &cmd : cleanup_commands) {
  384. if (cmd.wait) {
  385. ssh_run_on_remote(cmd.host, cmd.port, cmd.ssh_args, cmd.cmd_args);
  386. } else {
  387. ssh_run_on_remote_no_wait(cmd.host, cmd.port, cmd.ssh_args, cmd.cmd_args);
  388. }
  389. }
  390. }
  391. ssh_pid = 0;
  392. cleanup_commands.clear();
  393. }
  394. Error EditorExportPlatformLinuxBSD::run(const Ref<EditorExportPreset> &p_preset, int p_device, BitField<EditorExportPlatform::DebugFlags> p_debug_flags) {
  395. cleanup();
  396. if (p_device) { // Stop command, cleanup only.
  397. return OK;
  398. }
  399. EditorProgress ep("run", TTR("Running..."), 5);
  400. const String dest = EditorPaths::get_singleton()->get_temp_dir().path_join("linuxbsd");
  401. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  402. if (!da->dir_exists(dest)) {
  403. Error err = da->make_dir_recursive(dest);
  404. if (err != OK) {
  405. EditorNode::get_singleton()->show_warning(TTR("Could not create temp directory:") + "\n" + dest);
  406. return err;
  407. }
  408. }
  409. String host = p_preset->get("ssh_remote_deploy/host").operator String();
  410. String port = p_preset->get("ssh_remote_deploy/port").operator String();
  411. if (port.is_empty()) {
  412. port = "22";
  413. }
  414. Vector<String> extra_args_ssh = p_preset->get("ssh_remote_deploy/extra_args_ssh").operator String().split(" ", false);
  415. Vector<String> extra_args_scp = p_preset->get("ssh_remote_deploy/extra_args_scp").operator String().split(" ", false);
  416. const String basepath = dest.path_join("tmp_linuxbsd_export");
  417. #define CLEANUP_AND_RETURN(m_err) \
  418. { \
  419. if (da->file_exists(basepath + ".zip")) { \
  420. da->remove(basepath + ".zip"); \
  421. } \
  422. if (da->file_exists(basepath + "_start.sh")) { \
  423. da->remove(basepath + "_start.sh"); \
  424. } \
  425. if (da->file_exists(basepath + "_clean.sh")) { \
  426. da->remove(basepath + "_clean.sh"); \
  427. } \
  428. return m_err; \
  429. } \
  430. ((void)0)
  431. if (ep.step(TTR("Exporting project..."), 1)) {
  432. return ERR_SKIP;
  433. }
  434. Error err = export_project(p_preset, true, basepath + ".zip", p_debug_flags);
  435. if (err != OK) {
  436. DirAccess::remove_file_or_error(basepath + ".zip");
  437. return err;
  438. }
  439. String cmd_args;
  440. {
  441. Vector<String> cmd_args_list = gen_export_flags(p_debug_flags);
  442. for (int i = 0; i < cmd_args_list.size(); i++) {
  443. if (i != 0) {
  444. cmd_args += " ";
  445. }
  446. cmd_args += cmd_args_list[i];
  447. }
  448. }
  449. const bool use_remote = p_debug_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG) || p_debug_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT);
  450. int dbg_port = EDITOR_GET("network/debug/remote_port");
  451. print_line("Creating temporary directory...");
  452. ep.step(TTR("Creating temporary directory..."), 2);
  453. String temp_dir;
  454. err = ssh_run_on_remote(host, port, extra_args_ssh, "mktemp -d", &temp_dir);
  455. if (err != OK || temp_dir.is_empty()) {
  456. CLEANUP_AND_RETURN(err);
  457. }
  458. print_line("Uploading archive...");
  459. ep.step(TTR("Uploading archive..."), 3);
  460. err = ssh_push_to_remote(host, port, extra_args_scp, basepath + ".zip", temp_dir);
  461. if (err != OK) {
  462. CLEANUP_AND_RETURN(err);
  463. }
  464. {
  465. String run_script = p_preset->get("ssh_remote_deploy/run_script");
  466. run_script = run_script.replace("{temp_dir}", temp_dir);
  467. run_script = run_script.replace("{archive_name}", basepath.get_file() + ".zip");
  468. run_script = run_script.replace("{exe_name}", basepath.get_file());
  469. run_script = run_script.replace("{cmd_args}", cmd_args);
  470. Ref<FileAccess> f = FileAccess::open(basepath + "_start.sh", FileAccess::WRITE);
  471. if (f.is_null()) {
  472. CLEANUP_AND_RETURN(err);
  473. }
  474. f->store_string(run_script);
  475. }
  476. {
  477. String clean_script = p_preset->get("ssh_remote_deploy/cleanup_script");
  478. clean_script = clean_script.replace("{temp_dir}", temp_dir);
  479. clean_script = clean_script.replace("{archive_name}", basepath.get_file() + ".zip");
  480. clean_script = clean_script.replace("{exe_name}", basepath.get_file());
  481. clean_script = clean_script.replace("{cmd_args}", cmd_args);
  482. Ref<FileAccess> f = FileAccess::open(basepath + "_clean.sh", FileAccess::WRITE);
  483. if (f.is_null()) {
  484. CLEANUP_AND_RETURN(err);
  485. }
  486. f->store_string(clean_script);
  487. }
  488. print_line("Uploading scripts...");
  489. ep.step(TTR("Uploading scripts..."), 4);
  490. err = ssh_push_to_remote(host, port, extra_args_scp, basepath + "_start.sh", temp_dir);
  491. if (err != OK) {
  492. CLEANUP_AND_RETURN(err);
  493. }
  494. err = ssh_run_on_remote(host, port, extra_args_ssh, vformat("chmod +x \"%s/%s\"", temp_dir, basepath.get_file() + "_start.sh"));
  495. if (err != OK || temp_dir.is_empty()) {
  496. CLEANUP_AND_RETURN(err);
  497. }
  498. err = ssh_push_to_remote(host, port, extra_args_scp, basepath + "_clean.sh", temp_dir);
  499. if (err != OK) {
  500. CLEANUP_AND_RETURN(err);
  501. }
  502. err = ssh_run_on_remote(host, port, extra_args_ssh, vformat("chmod +x \"%s/%s\"", temp_dir, basepath.get_file() + "_clean.sh"));
  503. if (err != OK || temp_dir.is_empty()) {
  504. CLEANUP_AND_RETURN(err);
  505. }
  506. print_line("Starting project...");
  507. ep.step(TTR("Starting project..."), 5);
  508. err = ssh_run_on_remote_no_wait(host, port, extra_args_ssh, vformat("\"%s/%s\"", temp_dir, basepath.get_file() + "_start.sh"), &ssh_pid, (use_remote) ? dbg_port : -1);
  509. if (err != OK) {
  510. CLEANUP_AND_RETURN(err);
  511. }
  512. cleanup_commands.clear();
  513. cleanup_commands.push_back(SSHCleanupCommand(host, port, extra_args_ssh, vformat("\"%s/%s\"", temp_dir, basepath.get_file() + "_clean.sh")));
  514. print_line("Project started.");
  515. CLEANUP_AND_RETURN(OK);
  516. #undef CLEANUP_AND_RETURN
  517. }
  518. void EditorExportPlatformLinuxBSD::initialize() {
  519. if (EditorNode::get_singleton()) {
  520. Ref<Image> img = memnew(Image);
  521. const bool upsample = !Math::is_equal_approx(Math::round(EDSCALE), EDSCALE);
  522. ImageLoaderSVG::create_image_from_string(img, _linuxbsd_logo_svg, EDSCALE, upsample, false);
  523. set_logo(ImageTexture::create_from_image(img));
  524. ImageLoaderSVG::create_image_from_string(img, _linuxbsd_run_icon_svg, EDSCALE, upsample, false);
  525. run_icon = ImageTexture::create_from_image(img);
  526. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  527. if (theme.is_valid()) {
  528. stop_icon = theme->get_icon(SNAME("Stop"), EditorStringName(EditorIcons));
  529. } else {
  530. stop_icon.instantiate();
  531. }
  532. }
  533. }