editor_export_platform.cpp 83 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512
  1. /**************************************************************************/
  2. /* editor_export_platform.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 "editor_export_platform.h"
  31. #include "editor_export_platform.compat.inc"
  32. #include "core/config/project_settings.h"
  33. #include "core/crypto/crypto_core.h"
  34. #include "core/extension/gdextension.h"
  35. #include "core/io/file_access_encrypted.h"
  36. #include "core/io/file_access_pack.h" // PACK_HEADER_MAGIC, PACK_FORMAT_VERSION
  37. #include "core/io/image_loader.h"
  38. #include "core/io/resource_uid.h"
  39. #include "core/io/zip_io.h"
  40. #include "core/math/random_pcg.h"
  41. #include "core/version.h"
  42. #include "editor/editor_file_system.h"
  43. #include "editor/editor_node.h"
  44. #include "editor/editor_paths.h"
  45. #include "editor/editor_settings.h"
  46. #include "editor/editor_string_names.h"
  47. #include "editor/export/editor_export.h"
  48. #include "editor/plugins/script_editor_plugin.h"
  49. #include "editor/themes/editor_scale.h"
  50. #include "editor_export_plugin.h"
  51. #include "scene/resources/image_texture.h"
  52. #include "scene/resources/packed_scene.h"
  53. class EditorExportSaveProxy {
  54. HashSet<String> saved_paths;
  55. EditorExportPlatform::EditorExportSaveFunction save_func;
  56. bool tracking_saves = false;
  57. public:
  58. bool has_saved(const String &p_path) const { return saved_paths.has(p_path); }
  59. Error save_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  60. if (tracking_saves) {
  61. saved_paths.insert(p_path.simplify_path().trim_prefix("res://"));
  62. }
  63. return save_func(p_userdata, p_path, p_data, p_file, p_total, p_enc_in_filters, p_enc_ex_filters, p_key, p_seed);
  64. }
  65. EditorExportSaveProxy(EditorExportPlatform::EditorExportSaveFunction p_save_func, bool p_track_saves) :
  66. save_func(p_save_func), tracking_saves(p_track_saves) {}
  67. };
  68. static int _get_pad(int p_alignment, int p_n) {
  69. int rest = p_n % p_alignment;
  70. int pad = 0;
  71. if (rest > 0) {
  72. pad = p_alignment - rest;
  73. };
  74. return pad;
  75. }
  76. #define PCK_PADDING 16
  77. Ref<Image> EditorExportPlatform::_load_icon_or_splash_image(const String &p_path, Error *r_error) const {
  78. Ref<Image> image;
  79. if (!p_path.is_empty() && ResourceLoader::exists(p_path) && !ResourceLoader::get_resource_type(p_path).is_empty()) {
  80. Ref<Texture2D> texture = ResourceLoader::load(p_path, "", ResourceFormatLoader::CACHE_MODE_REUSE, r_error);
  81. if (texture.is_valid()) {
  82. image = texture->get_image();
  83. if (image.is_valid() && image->is_compressed()) {
  84. image->decompress();
  85. }
  86. }
  87. }
  88. if (image.is_null()) {
  89. image.instantiate();
  90. Error err = ImageLoader::load_image(p_path, image);
  91. if (r_error) {
  92. *r_error = err;
  93. }
  94. }
  95. return image;
  96. }
  97. bool EditorExportPlatform::fill_log_messages(RichTextLabel *p_log, Error p_err) {
  98. bool has_messages = false;
  99. int msg_count = get_message_count();
  100. p_log->add_text(TTR("Project export for platform:") + " ");
  101. p_log->add_image(get_logo(), 16 * EDSCALE, 16 * EDSCALE, Color(1.0, 1.0, 1.0), INLINE_ALIGNMENT_CENTER);
  102. p_log->add_text(" ");
  103. p_log->add_text(get_name());
  104. p_log->add_text(" - ");
  105. if (p_err == OK && get_worst_message_type() < EditorExportPlatform::EXPORT_MESSAGE_ERROR) {
  106. if (get_worst_message_type() >= EditorExportPlatform::EXPORT_MESSAGE_WARNING) {
  107. p_log->add_image(p_log->get_editor_theme_icon(SNAME("StatusWarning")), 16 * EDSCALE, 16 * EDSCALE, Color(1.0, 1.0, 1.0), INLINE_ALIGNMENT_CENTER);
  108. p_log->add_text(" ");
  109. p_log->add_text(TTR("Completed with warnings."));
  110. has_messages = true;
  111. } else {
  112. p_log->add_image(p_log->get_editor_theme_icon(SNAME("StatusSuccess")), 16 * EDSCALE, 16 * EDSCALE, Color(1.0, 1.0, 1.0), INLINE_ALIGNMENT_CENTER);
  113. p_log->add_text(" ");
  114. p_log->add_text(TTR("Completed successfully."));
  115. if (msg_count > 0) {
  116. has_messages = true;
  117. }
  118. }
  119. } else {
  120. p_log->add_image(p_log->get_editor_theme_icon(SNAME("StatusError")), 16 * EDSCALE, 16 * EDSCALE, Color(1.0, 1.0, 1.0), INLINE_ALIGNMENT_CENTER);
  121. p_log->add_text(" ");
  122. p_log->add_text(TTR("Failed."));
  123. has_messages = true;
  124. }
  125. p_log->add_newline();
  126. if (msg_count > 0) {
  127. p_log->push_table(2);
  128. p_log->set_table_column_expand(0, false);
  129. p_log->set_table_column_expand(1, true);
  130. for (int m = 0; m < msg_count; m++) {
  131. EditorExportPlatform::ExportMessage msg = get_message(m);
  132. Color color = p_log->get_theme_color(SceneStringName(font_color), SNAME("Label"));
  133. Ref<Texture> icon;
  134. switch (msg.msg_type) {
  135. case EditorExportPlatform::EXPORT_MESSAGE_INFO: {
  136. color = p_log->get_theme_color(SceneStringName(font_color), EditorStringName(Editor)) * Color(1, 1, 1, 0.6);
  137. } break;
  138. case EditorExportPlatform::EXPORT_MESSAGE_WARNING: {
  139. icon = p_log->get_editor_theme_icon(SNAME("Warning"));
  140. color = p_log->get_theme_color(SNAME("warning_color"), EditorStringName(Editor));
  141. } break;
  142. case EditorExportPlatform::EXPORT_MESSAGE_ERROR: {
  143. icon = p_log->get_editor_theme_icon(SNAME("Error"));
  144. color = p_log->get_theme_color(SNAME("error_color"), EditorStringName(Editor));
  145. } break;
  146. default:
  147. break;
  148. }
  149. p_log->push_cell();
  150. p_log->add_text("\t");
  151. if (icon.is_valid()) {
  152. p_log->add_image(icon);
  153. }
  154. p_log->pop();
  155. p_log->push_cell();
  156. p_log->push_color(color);
  157. p_log->add_text(vformat("[%s]: %s", msg.category, msg.text));
  158. p_log->pop();
  159. p_log->pop();
  160. }
  161. p_log->pop();
  162. p_log->add_newline();
  163. } else if (p_err != OK) {
  164. // We failed but don't show any user-facing messages. This is bad and should not
  165. // be allowed, but just in case this happens, let's give the user something at least.
  166. p_log->push_table(2);
  167. p_log->set_table_column_expand(0, false);
  168. p_log->set_table_column_expand(1, true);
  169. {
  170. Color color = p_log->get_theme_color(SNAME("error_color"), EditorStringName(Editor));
  171. Ref<Texture> icon = p_log->get_editor_theme_icon(SNAME("Error"));
  172. p_log->push_cell();
  173. p_log->add_text("\t");
  174. if (icon.is_valid()) {
  175. p_log->add_image(icon);
  176. }
  177. p_log->pop();
  178. p_log->push_cell();
  179. p_log->push_color(color);
  180. p_log->add_text(vformat("[%s]: %s", TTR("Unknown Error"), vformat(TTR("Export failed with error code %d."), p_err)));
  181. p_log->pop();
  182. p_log->pop();
  183. }
  184. p_log->pop();
  185. p_log->add_newline();
  186. }
  187. p_log->add_newline();
  188. return has_messages;
  189. }
  190. bool EditorExportPlatform::_check_hash(const uint8_t *p_hash, const Vector<uint8_t> &p_data) {
  191. if (p_hash == nullptr) {
  192. return false;
  193. }
  194. unsigned char hash[16];
  195. Error err = CryptoCore::md5(p_data.ptr(), p_data.size(), hash);
  196. if (err != OK) {
  197. return false;
  198. }
  199. for (int i = 0; i < 16; i++) {
  200. if (p_hash[i] != hash[i]) {
  201. return false;
  202. }
  203. }
  204. return true;
  205. }
  206. Error EditorExportPlatform::_load_patches(const Vector<String> &p_patches) {
  207. Error err = OK;
  208. if (!p_patches.is_empty()) {
  209. for (const String &path : p_patches) {
  210. err = PackedData::get_singleton()->add_pack(path, true, 0);
  211. if (err != OK) {
  212. add_message(EXPORT_MESSAGE_ERROR, TTR("Patch Creation"), vformat(TTR("Could not load patch pack with path \"%s\"."), path));
  213. return err;
  214. }
  215. }
  216. }
  217. return err;
  218. }
  219. void EditorExportPlatform::_unload_patches() {
  220. PackedData::get_singleton()->clear();
  221. }
  222. Error EditorExportPlatform::_save_pack_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  223. ERR_FAIL_COND_V_MSG(p_total < 1, ERR_PARAMETER_RANGE_ERROR, "Must select at least one file to export.");
  224. PackData *pd = (PackData *)p_userdata;
  225. String simplified_path = p_path.simplify_path();
  226. if (simplified_path.begins_with("uid://")) {
  227. simplified_path = ResourceUID::uid_to_path(simplified_path).simplify_path();
  228. print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, simplified_path));
  229. }
  230. SavedData sd;
  231. sd.path_utf8 = simplified_path.trim_prefix("res://").utf8();
  232. sd.ofs = pd->f->get_position();
  233. sd.size = p_data.size();
  234. sd.encrypted = false;
  235. for (int i = 0; i < p_enc_in_filters.size(); ++i) {
  236. if (simplified_path.matchn(p_enc_in_filters[i]) || simplified_path.trim_prefix("res://").matchn(p_enc_in_filters[i])) {
  237. sd.encrypted = true;
  238. break;
  239. }
  240. }
  241. for (int i = 0; i < p_enc_ex_filters.size(); ++i) {
  242. if (simplified_path.matchn(p_enc_ex_filters[i]) || simplified_path.trim_prefix("res://").matchn(p_enc_ex_filters[i])) {
  243. sd.encrypted = false;
  244. break;
  245. }
  246. }
  247. Ref<FileAccessEncrypted> fae;
  248. Ref<FileAccess> ftmp = pd->f;
  249. if (sd.encrypted) {
  250. Vector<uint8_t> iv;
  251. if (p_seed != 0) {
  252. uint64_t seed = p_seed;
  253. const uint8_t *ptr = p_data.ptr();
  254. int64_t len = p_data.size();
  255. for (int64_t i = 0; i < len; i++) {
  256. seed = ((seed << 5) + seed) ^ ptr[i];
  257. }
  258. RandomPCG rng = RandomPCG(seed);
  259. iv.resize(16);
  260. for (int i = 0; i < 16; i++) {
  261. iv.write[i] = rng.rand() % 256;
  262. }
  263. }
  264. fae.instantiate();
  265. ERR_FAIL_COND_V(fae.is_null(), ERR_FILE_CANT_OPEN);
  266. Error err = fae->open_and_parse(ftmp, p_key, FileAccessEncrypted::MODE_WRITE_AES256, false, iv);
  267. ERR_FAIL_COND_V(err != OK, ERR_FILE_CANT_OPEN);
  268. ftmp = fae;
  269. }
  270. // Store file content.
  271. ftmp->store_buffer(p_data.ptr(), p_data.size());
  272. if (fae.is_valid()) {
  273. ftmp.unref();
  274. fae.unref();
  275. }
  276. ERR_FAIL_COND_V(pd->f->get_position() - sd.ofs < (uint64_t)p_data.size(), ERR_FILE_CANT_WRITE);
  277. int pad = _get_pad(PCK_PADDING, pd->f->get_position());
  278. for (int i = 0; i < pad; i++) {
  279. pd->f->store_8(0);
  280. }
  281. // Store MD5 of original file.
  282. {
  283. unsigned char hash[16];
  284. CryptoCore::md5(p_data.ptr(), p_data.size(), hash);
  285. sd.md5.resize(16);
  286. for (int i = 0; i < 16; i++) {
  287. sd.md5.write[i] = hash[i];
  288. }
  289. }
  290. pd->file_ofs.push_back(sd);
  291. // TRANSLATORS: This is an editor progress label describing the storing of a file.
  292. if (pd->ep->step(vformat(TTR("Storing File: %s"), p_path), 2 + p_file * 100 / p_total, false)) {
  293. return ERR_SKIP;
  294. }
  295. return OK;
  296. }
  297. Error EditorExportPlatform::_save_pack_patch_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  298. if (_check_hash(PackedData::get_singleton()->get_file_hash(p_path), p_data)) {
  299. return OK;
  300. }
  301. return _save_pack_file(p_userdata, p_path, p_data, p_file, p_total, p_enc_in_filters, p_enc_ex_filters, p_key, p_seed);
  302. }
  303. Error EditorExportPlatform::_save_zip_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  304. ERR_FAIL_COND_V_MSG(p_total < 1, ERR_PARAMETER_RANGE_ERROR, "Must select at least one file to export.");
  305. String path = p_path.simplify_path();
  306. if (path.begins_with("uid://")) {
  307. path = ResourceUID::uid_to_path(path).simplify_path();
  308. print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, path));
  309. }
  310. path = path.replace_first("res://", "");
  311. ZipData *zd = (ZipData *)p_userdata;
  312. zipFile zip = (zipFile)zd->zip;
  313. zipOpenNewFileInZip(zip,
  314. path.utf8().get_data(),
  315. nullptr,
  316. nullptr,
  317. 0,
  318. nullptr,
  319. 0,
  320. nullptr,
  321. Z_DEFLATED,
  322. Z_DEFAULT_COMPRESSION);
  323. zipWriteInFileInZip(zip, p_data.ptr(), p_data.size());
  324. zipCloseFileInZip(zip);
  325. zd->file_count += 1;
  326. if (zd->ep->step(TTR("Storing File:") + " " + p_path, 2 + p_file * 100 / p_total, false)) {
  327. return ERR_SKIP;
  328. }
  329. return OK;
  330. }
  331. Error EditorExportPlatform::_save_zip_patch_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  332. if (_check_hash(PackedData::get_singleton()->get_file_hash(p_path), p_data)) {
  333. return OK;
  334. }
  335. return _save_zip_file(p_userdata, p_path, p_data, p_file, p_total, p_enc_in_filters, p_enc_ex_filters, p_key, p_seed);
  336. }
  337. Ref<ImageTexture> EditorExportPlatform::get_option_icon(int p_index) const {
  338. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  339. ERR_FAIL_COND_V(theme.is_null(), Ref<ImageTexture>());
  340. return theme->get_icon(SNAME("Play"), EditorStringName(EditorIcons));
  341. }
  342. String EditorExportPlatform::find_export_template(const String &template_file_name, String *err) const {
  343. String current_version = GODOT_VERSION_FULL_CONFIG;
  344. String template_path = EditorPaths::get_singleton()->get_export_templates_dir().path_join(current_version).path_join(template_file_name);
  345. if (FileAccess::exists(template_path)) {
  346. return template_path;
  347. }
  348. // Not found
  349. if (err) {
  350. *err += TTR("No export template found at the expected path:") + "\n" + template_path + "\n";
  351. }
  352. return String();
  353. }
  354. bool EditorExportPlatform::exists_export_template(const String &template_file_name, String *err) const {
  355. return find_export_template(template_file_name, err) != "";
  356. }
  357. Ref<EditorExportPreset> EditorExportPlatform::create_preset() {
  358. Ref<EditorExportPreset> preset;
  359. preset.instantiate();
  360. preset->platform = Ref<EditorExportPlatform>(this);
  361. List<ExportOption> options;
  362. get_export_options(&options);
  363. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  364. for (int i = 0; i < export_plugins.size(); i++) {
  365. export_plugins.write[i]->_get_export_options(Ref<EditorExportPlatform>(this), &options);
  366. }
  367. for (const ExportOption &E : options) {
  368. StringName option_name = E.option.name;
  369. preset->properties[option_name] = E.option;
  370. preset->values[option_name] = E.default_value;
  371. preset->update_visibility[option_name] = E.update_visibility;
  372. }
  373. return preset;
  374. }
  375. void EditorExportPlatform::_export_find_resources(EditorFileSystemDirectory *p_dir, HashSet<String> &p_paths) {
  376. for (int i = 0; i < p_dir->get_subdir_count(); i++) {
  377. _export_find_resources(p_dir->get_subdir(i), p_paths);
  378. }
  379. for (int i = 0; i < p_dir->get_file_count(); i++) {
  380. if (p_dir->get_file_type(i) == "TextFile") {
  381. continue;
  382. }
  383. p_paths.insert(p_dir->get_file_path(i));
  384. }
  385. }
  386. void EditorExportPlatform::_export_find_customized_resources(const Ref<EditorExportPreset> &p_preset, EditorFileSystemDirectory *p_dir, EditorExportPreset::FileExportMode p_mode, HashSet<String> &p_paths) {
  387. for (int i = 0; i < p_dir->get_subdir_count(); i++) {
  388. EditorFileSystemDirectory *subdir = p_dir->get_subdir(i);
  389. _export_find_customized_resources(p_preset, subdir, p_preset->get_file_export_mode(subdir->get_path(), p_mode), p_paths);
  390. }
  391. for (int i = 0; i < p_dir->get_file_count(); i++) {
  392. if (p_dir->get_file_type(i) == "TextFile") {
  393. continue;
  394. }
  395. String path = p_dir->get_file_path(i);
  396. EditorExportPreset::FileExportMode file_mode = p_preset->get_file_export_mode(path, p_mode);
  397. if (file_mode != EditorExportPreset::MODE_FILE_REMOVE) {
  398. p_paths.insert(path);
  399. }
  400. }
  401. }
  402. void EditorExportPlatform::_export_find_dependencies(const String &p_path, HashSet<String> &p_paths) {
  403. if (p_paths.has(p_path)) {
  404. return;
  405. }
  406. p_paths.insert(p_path);
  407. EditorFileSystemDirectory *dir;
  408. int file_idx;
  409. dir = EditorFileSystem::get_singleton()->find_file(p_path, &file_idx);
  410. if (!dir) {
  411. return;
  412. }
  413. Vector<String> deps = dir->get_file_deps(file_idx);
  414. for (int i = 0; i < deps.size(); i++) {
  415. _export_find_dependencies(deps[i], p_paths);
  416. }
  417. }
  418. void EditorExportPlatform::_edit_files_with_filter(Ref<DirAccess> &da, const Vector<String> &p_filters, HashSet<String> &r_list, bool exclude) {
  419. da->list_dir_begin();
  420. String cur_dir = da->get_current_dir().replace_char('\\', '/');
  421. if (!cur_dir.ends_with("/")) {
  422. cur_dir += "/";
  423. }
  424. String cur_dir_no_prefix = cur_dir.replace("res://", "");
  425. Vector<String> dirs;
  426. String f = da->get_next();
  427. while (!f.is_empty()) {
  428. if (da->current_is_dir()) {
  429. dirs.push_back(f);
  430. } else {
  431. String fullpath = cur_dir + f;
  432. // Test also against path without res:// so that filters like `file.txt` can work.
  433. String fullpath_no_prefix = cur_dir_no_prefix + f;
  434. for (int i = 0; i < p_filters.size(); ++i) {
  435. if (fullpath.matchn(p_filters[i]) || fullpath_no_prefix.matchn(p_filters[i])) {
  436. if (!exclude) {
  437. r_list.insert(fullpath);
  438. } else {
  439. r_list.erase(fullpath);
  440. }
  441. }
  442. }
  443. }
  444. f = da->get_next();
  445. }
  446. da->list_dir_end();
  447. for (int i = 0; i < dirs.size(); ++i) {
  448. const String &dir = dirs[i];
  449. if (dir.begins_with(".")) {
  450. continue;
  451. }
  452. if (EditorFileSystem::_should_skip_directory(cur_dir + dir)) {
  453. continue;
  454. }
  455. da->change_dir(dir);
  456. _edit_files_with_filter(da, p_filters, r_list, exclude);
  457. da->change_dir("..");
  458. }
  459. }
  460. void EditorExportPlatform::_edit_filter_list(HashSet<String> &r_list, const String &p_filter, bool exclude) {
  461. if (p_filter.is_empty()) {
  462. return;
  463. }
  464. Vector<String> split = p_filter.split(",");
  465. Vector<String> filters;
  466. for (int i = 0; i < split.size(); i++) {
  467. String f = split[i].strip_edges();
  468. if (f.is_empty()) {
  469. continue;
  470. }
  471. filters.push_back(f);
  472. }
  473. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  474. ERR_FAIL_COND(da.is_null());
  475. _edit_files_with_filter(da, filters, r_list, exclude);
  476. }
  477. HashSet<String> EditorExportPlatform::get_features(const Ref<EditorExportPreset> &p_preset, bool p_debug) const {
  478. Ref<EditorExportPlatform> platform = p_preset->get_platform();
  479. List<String> feature_list;
  480. platform->get_platform_features(&feature_list);
  481. platform->get_preset_features(p_preset, &feature_list);
  482. HashSet<String> result;
  483. for (const String &E : feature_list) {
  484. result.insert(E);
  485. }
  486. result.insert("template");
  487. if (p_debug) {
  488. result.insert("debug");
  489. result.insert("template_debug");
  490. } else {
  491. result.insert("release");
  492. result.insert("template_release");
  493. }
  494. #ifdef REAL_T_IS_DOUBLE
  495. result.insert("double");
  496. #else
  497. result.insert("single");
  498. #endif // REAL_T_IS_DOUBLE
  499. if (!p_preset->get_custom_features().is_empty()) {
  500. Vector<String> tmp_custom_list = p_preset->get_custom_features().split(",");
  501. for (int i = 0; i < tmp_custom_list.size(); i++) {
  502. String f = tmp_custom_list[i].strip_edges();
  503. if (!f.is_empty()) {
  504. result.insert(f);
  505. }
  506. }
  507. }
  508. return result;
  509. }
  510. EditorExportPlatform::ExportNotifier::ExportNotifier(EditorExportPlatform &p_platform, const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  511. HashSet<String> features = p_platform.get_features(p_preset, p_debug);
  512. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  513. //initial export plugin callback
  514. for (int i = 0; i < export_plugins.size(); i++) {
  515. export_plugins.write[i]->set_export_preset(p_preset);
  516. if (GDVIRTUAL_IS_OVERRIDDEN_PTR(export_plugins[i], _export_begin)) {
  517. PackedStringArray features_psa;
  518. for (const String &feature : features) {
  519. features_psa.push_back(feature);
  520. }
  521. export_plugins.write[i]->_export_begin_script(features_psa, p_debug, p_path, p_flags);
  522. } else {
  523. export_plugins.write[i]->_export_begin(features, p_debug, p_path, p_flags);
  524. }
  525. }
  526. }
  527. EditorExportPlatform::ExportNotifier::~ExportNotifier() {
  528. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  529. for (int i = 0; i < export_plugins.size(); i++) {
  530. if (GDVIRTUAL_IS_OVERRIDDEN_PTR(export_plugins[i], _export_end)) {
  531. export_plugins.write[i]->_export_end_script();
  532. } else {
  533. export_plugins.write[i]->_export_end();
  534. }
  535. export_plugins.write[i]->_export_end_clear();
  536. export_plugins.write[i]->set_export_preset(Ref<EditorExportPlugin>());
  537. }
  538. }
  539. bool EditorExportPlatform::_export_customize_dictionary(Dictionary &dict, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
  540. bool changed = false;
  541. for (const Variant &K : dict.get_key_list()) {
  542. Variant v = dict[K];
  543. switch (v.get_type()) {
  544. case Variant::OBJECT: {
  545. Ref<Resource> res = v;
  546. if (res.is_valid()) {
  547. for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
  548. Ref<Resource> new_res = plugin->_customize_resource(res, "");
  549. if (new_res.is_valid()) {
  550. changed = true;
  551. if (new_res != res) {
  552. dict[K] = new_res;
  553. res = new_res;
  554. }
  555. break;
  556. }
  557. }
  558. // If it was not replaced, go through and see if there is something to replace.
  559. if (res.is_valid() && !res->get_path().is_resource_file() && _export_customize_object(res.ptr(), customize_resources_plugins), true) {
  560. changed = true;
  561. }
  562. }
  563. } break;
  564. case Variant::DICTIONARY: {
  565. Dictionary d = v;
  566. if (_export_customize_dictionary(d, customize_resources_plugins)) {
  567. changed = true;
  568. }
  569. } break;
  570. case Variant::ARRAY: {
  571. Array a = v;
  572. if (_export_customize_array(a, customize_resources_plugins)) {
  573. changed = true;
  574. }
  575. } break;
  576. default: {
  577. }
  578. }
  579. }
  580. return changed;
  581. }
  582. bool EditorExportPlatform::_export_customize_array(Array &arr, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
  583. bool changed = false;
  584. for (int i = 0; i < arr.size(); i++) {
  585. Variant v = arr.get(i);
  586. switch (v.get_type()) {
  587. case Variant::OBJECT: {
  588. Ref<Resource> res = v;
  589. if (res.is_valid()) {
  590. for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
  591. Ref<Resource> new_res = plugin->_customize_resource(res, "");
  592. if (new_res.is_valid()) {
  593. changed = true;
  594. if (new_res != res) {
  595. arr.set(i, new_res);
  596. res = new_res;
  597. }
  598. break;
  599. }
  600. }
  601. // If it was not replaced, go through and see if there is something to replace.
  602. if (res.is_valid() && !res->get_path().is_resource_file() && _export_customize_object(res.ptr(), customize_resources_plugins), true) {
  603. changed = true;
  604. }
  605. }
  606. } break;
  607. case Variant::DICTIONARY: {
  608. Dictionary d = v;
  609. if (_export_customize_dictionary(d, customize_resources_plugins)) {
  610. changed = true;
  611. }
  612. } break;
  613. case Variant::ARRAY: {
  614. Array a = v;
  615. if (_export_customize_array(a, customize_resources_plugins)) {
  616. changed = true;
  617. }
  618. } break;
  619. default: {
  620. }
  621. }
  622. }
  623. return changed;
  624. }
  625. bool EditorExportPlatform::_export_customize_object(Object *p_object, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
  626. bool changed = false;
  627. List<PropertyInfo> props;
  628. p_object->get_property_list(&props);
  629. for (const PropertyInfo &E : props) {
  630. switch (E.type) {
  631. case Variant::OBJECT: {
  632. Ref<Resource> res = p_object->get(E.name);
  633. if (res.is_valid()) {
  634. for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
  635. Ref<Resource> new_res = plugin->_customize_resource(res, "");
  636. if (new_res.is_valid()) {
  637. changed = true;
  638. if (new_res != res) {
  639. p_object->set(E.name, new_res);
  640. res = new_res;
  641. }
  642. break;
  643. }
  644. }
  645. // If it was not replaced, go through and see if there is something to replace.
  646. if (res.is_valid() && !res->get_path().is_resource_file() && _export_customize_object(res.ptr(), customize_resources_plugins), true) {
  647. changed = true;
  648. }
  649. }
  650. } break;
  651. case Variant::DICTIONARY: {
  652. Dictionary d = p_object->get(E.name);
  653. if (_export_customize_dictionary(d, customize_resources_plugins)) {
  654. // May have been generated, so set back just in case
  655. p_object->set(E.name, d);
  656. changed = true;
  657. }
  658. } break;
  659. case Variant::ARRAY: {
  660. Array a = p_object->get(E.name);
  661. if (_export_customize_array(a, customize_resources_plugins)) {
  662. // May have been generated, so set back just in case
  663. p_object->set(E.name, a);
  664. changed = true;
  665. }
  666. } break;
  667. default: {
  668. }
  669. }
  670. }
  671. return changed;
  672. }
  673. bool EditorExportPlatform::_is_editable_ancestor(Node *p_root, Node *p_node) {
  674. while (p_node != nullptr && p_node != p_root) {
  675. if (p_root->is_editable_instance(p_node)) {
  676. return true;
  677. }
  678. p_node = p_node->get_owner();
  679. }
  680. return false;
  681. }
  682. bool EditorExportPlatform::_export_customize_scene_resources(Node *p_root, Node *p_node, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
  683. bool changed = false;
  684. if (p_root == p_node || p_node->get_owner() == p_root || _is_editable_ancestor(p_root, p_node)) {
  685. if (_export_customize_object(p_node, customize_resources_plugins)) {
  686. changed = true;
  687. }
  688. }
  689. for (int i = 0; i < p_node->get_child_count(); i++) {
  690. if (_export_customize_scene_resources(p_root, p_node->get_child(i), customize_resources_plugins)) {
  691. changed = true;
  692. }
  693. }
  694. return changed;
  695. }
  696. String EditorExportPlatform::_export_customize(const String &p_path, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins, LocalVector<Ref<EditorExportPlugin>> &customize_scenes_plugins, HashMap<String, FileExportCache> &export_cache, const String &export_base_path, bool p_force_save) {
  697. if (!p_force_save && customize_resources_plugins.is_empty() && customize_scenes_plugins.is_empty()) {
  698. return p_path; // do none
  699. }
  700. // Check if a cache exists
  701. if (export_cache.has(p_path)) {
  702. FileExportCache &fec = export_cache[p_path];
  703. if (fec.saved_path.is_empty() || FileAccess::exists(fec.saved_path)) {
  704. // Destination file exists (was not erased) or not needed
  705. uint64_t mod_time = FileAccess::get_modified_time(p_path);
  706. if (fec.source_modified_time == mod_time) {
  707. // Cached (modified time matches).
  708. fec.used = true;
  709. return fec.saved_path.is_empty() ? p_path : fec.saved_path;
  710. }
  711. String md5 = FileAccess::get_md5(p_path);
  712. if (FileAccess::exists(p_path + ".import")) {
  713. // Also consider the import file in the string
  714. md5 += FileAccess::get_md5(p_path + ".import");
  715. }
  716. if (fec.source_md5 == md5) {
  717. // Cached (md5 matches).
  718. fec.source_modified_time = mod_time;
  719. fec.used = true;
  720. return fec.saved_path.is_empty() ? p_path : fec.saved_path;
  721. }
  722. }
  723. }
  724. FileExportCache fec;
  725. fec.used = true;
  726. fec.source_modified_time = FileAccess::get_modified_time(p_path);
  727. String md5 = FileAccess::get_md5(p_path);
  728. if (FileAccess::exists(p_path + ".import")) {
  729. // Also consider the import file in the string
  730. md5 += FileAccess::get_md5(p_path + ".import");
  731. }
  732. fec.source_md5 = md5;
  733. // Check if it should convert
  734. String type = ResourceLoader::get_resource_type(p_path);
  735. bool modified = false;
  736. String save_path;
  737. if (type == "PackedScene") { // Its a scene.
  738. Ref<PackedScene> ps = ResourceLoader::load(p_path, "PackedScene", ResourceFormatLoader::CACHE_MODE_IGNORE);
  739. ERR_FAIL_COND_V(ps.is_null(), p_path);
  740. Node *node = ps->instantiate(PackedScene::GEN_EDIT_STATE_INSTANCE); // Make sure the child scene root gets the correct inheritance chain.
  741. ERR_FAIL_NULL_V(node, p_path);
  742. if (!customize_scenes_plugins.is_empty()) {
  743. for (Ref<EditorExportPlugin> &plugin : customize_scenes_plugins) {
  744. Node *customized = plugin->_customize_scene(node, p_path);
  745. if (customized != nullptr) {
  746. node = customized;
  747. modified = true;
  748. }
  749. }
  750. }
  751. if (!customize_resources_plugins.is_empty()) {
  752. if (_export_customize_scene_resources(node, node, customize_resources_plugins)) {
  753. modified = true;
  754. }
  755. }
  756. if (modified || p_force_save) {
  757. // If modified, save it again. This is also used for TSCN -> SCN conversion on export.
  758. String base_file = p_path.get_file().get_basename() + ".scn"; // use SCN for saving (binary) and repack (If conversting, TSCN PackedScene representation is inefficient, so repacking is also desired).
  759. save_path = export_base_path.path_join("export-" + p_path.md5_text() + "-" + base_file);
  760. Ref<PackedScene> s;
  761. s.instantiate();
  762. s->pack(node);
  763. Error err = ResourceSaver::save(s, save_path);
  764. ERR_FAIL_COND_V_MSG(err != OK, p_path, "Unable to save export scene file to: " + save_path);
  765. }
  766. node->queue_free();
  767. } else {
  768. Ref<Resource> res = ResourceLoader::load(p_path, "", ResourceFormatLoader::CACHE_MODE_IGNORE);
  769. ERR_FAIL_COND_V(res.is_null(), p_path);
  770. if (!customize_resources_plugins.is_empty()) {
  771. for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
  772. Ref<Resource> new_res = plugin->_customize_resource(res, p_path);
  773. if (new_res.is_valid()) {
  774. modified = true;
  775. if (new_res != res) {
  776. res = new_res;
  777. }
  778. break;
  779. }
  780. }
  781. if (_export_customize_object(res.ptr(), customize_resources_plugins)) {
  782. modified = true;
  783. }
  784. }
  785. if (modified || p_force_save) {
  786. // If modified, save it again. This is also used for TRES -> RES conversion on export.
  787. String base_file = p_path.get_file().get_basename() + ".res"; // use RES for saving (binary)
  788. save_path = export_base_path.path_join("export-" + p_path.md5_text() + "-" + base_file);
  789. Error err = ResourceSaver::save(res, save_path);
  790. ERR_FAIL_COND_V_MSG(err != OK, p_path, "Unable to save export resource file to: " + save_path);
  791. }
  792. }
  793. fec.saved_path = save_path;
  794. export_cache[p_path] = fec;
  795. return save_path.is_empty() ? p_path : save_path;
  796. }
  797. String EditorExportPlatform::_get_script_encryption_key(const Ref<EditorExportPreset> &p_preset) const {
  798. const String from_env = OS::get_singleton()->get_environment(ENV_SCRIPT_ENCRYPTION_KEY);
  799. if (!from_env.is_empty()) {
  800. return from_env.to_lower();
  801. }
  802. return p_preset->get_script_encryption_key().to_lower();
  803. }
  804. Dictionary EditorExportPlatform::get_internal_export_files(const Ref<EditorExportPreset> &p_preset, bool p_debug) {
  805. Dictionary files;
  806. // Text server support data.
  807. if (TS->has_feature(TextServer::FEATURE_USE_SUPPORT_DATA) && (bool)get_project_setting(p_preset, "internationalization/locale/include_text_server_data")) {
  808. String ts_name = TS->get_support_data_filename();
  809. String ts_target = "res://" + ts_name;
  810. if (!ts_name.is_empty()) {
  811. bool export_ok = false;
  812. if (FileAccess::exists(ts_target)) { // Include user supplied data file.
  813. const PackedByteArray &ts_data = FileAccess::get_file_as_bytes(ts_target);
  814. if (!ts_data.is_empty()) {
  815. add_message(EXPORT_MESSAGE_INFO, TTR("Export"), TTR("Using user provided text server data, text display in the exported project might be broken if export template was built with different ICU version!"));
  816. files[ts_target] = ts_data;
  817. export_ok = true;
  818. }
  819. } else {
  820. String current_version = GODOT_VERSION_FULL_CONFIG;
  821. String template_path = EditorPaths::get_singleton()->get_export_templates_dir().path_join(current_version);
  822. if (p_debug && p_preset->has("custom_template/debug") && p_preset->get("custom_template/debug") != "") {
  823. template_path = p_preset->get("custom_template/debug").operator String().get_base_dir();
  824. } else if (!p_debug && p_preset->has("custom_template/release") && p_preset->get("custom_template/release") != "") {
  825. template_path = p_preset->get("custom_template/release").operator String().get_base_dir();
  826. }
  827. String data_file_name = template_path.path_join(ts_name);
  828. if (FileAccess::exists(data_file_name)) {
  829. const PackedByteArray &ts_data = FileAccess::get_file_as_bytes(data_file_name);
  830. if (!ts_data.is_empty()) {
  831. print_line("Using text server data from export templates.");
  832. files[ts_target] = ts_data;
  833. export_ok = true;
  834. }
  835. } else {
  836. const PackedByteArray &ts_data = TS->get_support_data();
  837. if (!ts_data.is_empty()) {
  838. add_message(EXPORT_MESSAGE_INFO, TTR("Export"), TTR("Using editor embedded text server data, text display in the exported project might be broken if export template was built with different ICU version!"));
  839. files[ts_target] = ts_data;
  840. export_ok = true;
  841. }
  842. }
  843. }
  844. if (!export_ok) {
  845. add_message(EXPORT_MESSAGE_WARNING, TTR("Export"), TTR("Missing text server data, text display in the exported project might be broken!"));
  846. }
  847. }
  848. }
  849. return files;
  850. }
  851. Vector<String> EditorExportPlatform::get_forced_export_files(const Ref<EditorExportPreset> &p_preset) {
  852. Vector<String> files;
  853. files.push_back(ProjectSettings::get_singleton()->get_global_class_list_path());
  854. String icon = ResourceUID::ensure_path(get_project_setting(p_preset, "application/config/icon"));
  855. String splash = ResourceUID::ensure_path(get_project_setting(p_preset, "application/boot_splash/image"));
  856. if (!icon.is_empty() && FileAccess::exists(icon)) {
  857. files.push_back(icon);
  858. }
  859. if (!splash.is_empty() && FileAccess::exists(splash) && icon != splash) {
  860. files.push_back(splash);
  861. }
  862. String resource_cache_file = ResourceUID::get_cache_file();
  863. if (FileAccess::exists(resource_cache_file)) {
  864. files.push_back(resource_cache_file);
  865. }
  866. String extension_list_config_file = GDExtension::get_extension_list_config_file();
  867. if (FileAccess::exists(extension_list_config_file)) {
  868. files.push_back(extension_list_config_file);
  869. }
  870. return files;
  871. }
  872. Error EditorExportPlatform::_script_save_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  873. Callable cb = ((ScriptCallbackData *)p_userdata)->file_cb;
  874. ERR_FAIL_COND_V(!cb.is_valid(), FAILED);
  875. String simplified_path = p_path.simplify_path();
  876. if (simplified_path.begins_with("uid://")) {
  877. simplified_path = ResourceUID::uid_to_path(simplified_path).simplify_path();
  878. print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, simplified_path));
  879. }
  880. Variant path = simplified_path;
  881. Variant data = p_data;
  882. Variant file = p_file;
  883. Variant total = p_total;
  884. Variant enc_in = p_enc_in_filters;
  885. Variant enc_ex = p_enc_ex_filters;
  886. Variant enc_key = p_key;
  887. Variant ret;
  888. Callable::CallError ce;
  889. const Variant *args[7] = { &path, &data, &file, &total, &enc_in, &enc_ex, &enc_key };
  890. cb.callp(args, 7, ret, ce);
  891. ERR_FAIL_COND_V_MSG(ce.error != Callable::CallError::CALL_OK, FAILED, vformat("Failed to execute file save callback: %s.", Variant::get_callable_error_text(cb, args, 7, ce)));
  892. return (Error)ret.operator int();
  893. }
  894. Error EditorExportPlatform::_script_add_shared_object(void *p_userdata, const SharedObject &p_so) {
  895. Callable cb = ((ScriptCallbackData *)p_userdata)->so_cb;
  896. if (!cb.is_valid()) {
  897. return OK; // Optional.
  898. }
  899. Variant path = p_so.path;
  900. Variant tags = p_so.tags;
  901. Variant target = p_so.target;
  902. Variant ret;
  903. Callable::CallError ce;
  904. const Variant *args[3] = { &path, &tags, &target };
  905. cb.callp(args, 3, ret, ce);
  906. ERR_FAIL_COND_V_MSG(ce.error != Callable::CallError::CALL_OK, FAILED, vformat("Failed to execute shared object save callback: %s.", Variant::get_callable_error_text(cb, args, 3, ce)));
  907. return (Error)ret.operator int();
  908. }
  909. Error EditorExportPlatform::_export_project_files(const Ref<EditorExportPreset> &p_preset, bool p_debug, const Callable &p_save_func, const Callable &p_so_func) {
  910. ScriptCallbackData data;
  911. data.file_cb = p_save_func;
  912. data.so_cb = p_so_func;
  913. return export_project_files(p_preset, p_debug, _script_save_file, nullptr, &data, _script_add_shared_object);
  914. }
  915. Error EditorExportPlatform::export_project_files(const Ref<EditorExportPreset> &p_preset, bool p_debug, EditorExportSaveFunction p_save_func, EditorExportRemoveFunction p_remove_func, void *p_udata, EditorExportSaveSharedObject p_so_func) {
  916. //figure out paths of files that will be exported
  917. HashSet<String> paths;
  918. Vector<String> path_remaps;
  919. if (p_preset->get_export_filter() == EditorExportPreset::EXPORT_ALL_RESOURCES) {
  920. //find stuff
  921. _export_find_resources(EditorFileSystem::get_singleton()->get_filesystem(), paths);
  922. } else if (p_preset->get_export_filter() == EditorExportPreset::EXCLUDE_SELECTED_RESOURCES) {
  923. _export_find_resources(EditorFileSystem::get_singleton()->get_filesystem(), paths);
  924. Vector<String> files = p_preset->get_files_to_export();
  925. for (int i = 0; i < files.size(); i++) {
  926. paths.erase(files[i]);
  927. }
  928. } else if (p_preset->get_export_filter() == EditorExportPreset::EXPORT_CUSTOMIZED) {
  929. _export_find_customized_resources(p_preset, EditorFileSystem::get_singleton()->get_filesystem(), p_preset->get_file_export_mode("res://"), paths);
  930. } else {
  931. bool scenes_only = p_preset->get_export_filter() == EditorExportPreset::EXPORT_SELECTED_SCENES;
  932. Vector<String> files = p_preset->get_files_to_export();
  933. for (int i = 0; i < files.size(); i++) {
  934. if (scenes_only && ResourceLoader::get_resource_type(files[i]) != "PackedScene") {
  935. continue;
  936. }
  937. _export_find_dependencies(files[i], paths);
  938. }
  939. // Add autoload resources and their dependencies
  940. List<PropertyInfo> props;
  941. ProjectSettings::get_singleton()->get_property_list(&props);
  942. for (const PropertyInfo &pi : props) {
  943. if (!pi.name.begins_with("autoload/")) {
  944. continue;
  945. }
  946. String autoload_path = get_project_setting(p_preset, pi.name);
  947. if (autoload_path.begins_with("*")) {
  948. autoload_path = autoload_path.substr(1);
  949. }
  950. _export_find_dependencies(autoload_path, paths);
  951. }
  952. }
  953. //add native icons to non-resource include list
  954. _edit_filter_list(paths, String("*.icns"), false);
  955. _edit_filter_list(paths, String("*.ico"), false);
  956. _edit_filter_list(paths, p_preset->get_include_filter(), false);
  957. _edit_filter_list(paths, p_preset->get_exclude_filter(), true);
  958. // Ignore import files, since these are automatically added to the jar later with the resources
  959. _edit_filter_list(paths, String("*.import"), true);
  960. // Get encryption filters.
  961. bool enc_pck = p_preset->get_enc_pck();
  962. Vector<String> enc_in_filters;
  963. Vector<String> enc_ex_filters;
  964. Vector<uint8_t> key;
  965. uint64_t seed = 0;
  966. if (enc_pck) {
  967. seed = p_preset->get_seed();
  968. Vector<String> enc_in_split = p_preset->get_enc_in_filter().split(",");
  969. for (int i = 0; i < enc_in_split.size(); i++) {
  970. String f = enc_in_split[i].strip_edges();
  971. if (f.is_empty()) {
  972. continue;
  973. }
  974. enc_in_filters.push_back(f);
  975. }
  976. Vector<String> enc_ex_split = p_preset->get_enc_ex_filter().split(",");
  977. for (int i = 0; i < enc_ex_split.size(); i++) {
  978. String f = enc_ex_split[i].strip_edges();
  979. if (f.is_empty()) {
  980. continue;
  981. }
  982. enc_ex_filters.push_back(f);
  983. }
  984. // Get encryption key.
  985. String script_key = _get_script_encryption_key(p_preset);
  986. key.resize(32);
  987. if (script_key.length() == 64) {
  988. for (int i = 0; i < 32; i++) {
  989. int v = 0;
  990. if (i * 2 < script_key.length()) {
  991. char32_t ct = script_key[i * 2];
  992. if (is_digit(ct)) {
  993. ct = ct - '0';
  994. } else if (ct >= 'a' && ct <= 'f') {
  995. ct = 10 + ct - 'a';
  996. }
  997. v |= ct << 4;
  998. }
  999. if (i * 2 + 1 < script_key.length()) {
  1000. char32_t ct = script_key[i * 2 + 1];
  1001. if (is_digit(ct)) {
  1002. ct = ct - '0';
  1003. } else if (ct >= 'a' && ct <= 'f') {
  1004. ct = 10 + ct - 'a';
  1005. }
  1006. v |= ct;
  1007. }
  1008. key.write[i] = v;
  1009. }
  1010. }
  1011. }
  1012. EditorExportSaveProxy save_proxy(p_save_func, p_remove_func != nullptr);
  1013. Error err = OK;
  1014. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  1015. struct SortByName {
  1016. bool operator()(const Ref<EditorExportPlugin> &left, const Ref<EditorExportPlugin> &right) const {
  1017. return left->get_name() < right->get_name();
  1018. }
  1019. };
  1020. auto add_shared_objects_and_extra_files_from_export_plugins = [&]() {
  1021. for (int i = 0; i < export_plugins.size(); i++) {
  1022. if (p_so_func) {
  1023. for (int j = 0; j < export_plugins[i]->shared_objects.size(); j++) {
  1024. err = p_so_func(p_udata, export_plugins[i]->shared_objects[j]);
  1025. if (err != OK) {
  1026. return err;
  1027. }
  1028. }
  1029. }
  1030. for (int j = 0; j < export_plugins[i]->extra_files.size(); j++) {
  1031. err = save_proxy.save_file(p_udata, export_plugins[i]->extra_files[j].path, export_plugins[i]->extra_files[j].data, 0, paths.size(), enc_in_filters, enc_ex_filters, key, seed);
  1032. if (err != OK) {
  1033. return err;
  1034. }
  1035. }
  1036. export_plugins.write[i]->_clear();
  1037. }
  1038. return OK;
  1039. };
  1040. // Always sort by name, to so if for some reason they are re-arranged, it still works.
  1041. export_plugins.sort_custom<SortByName>();
  1042. HashSet<String> features = get_features(p_preset, p_debug);
  1043. PackedStringArray features_psa;
  1044. for (const String &feature : features) {
  1045. features_psa.push_back(feature);
  1046. }
  1047. // Check if custom processing is needed
  1048. uint32_t custom_resources_hash = HASH_MURMUR3_SEED;
  1049. uint32_t custom_scene_hash = HASH_MURMUR3_SEED;
  1050. LocalVector<Ref<EditorExportPlugin>> customize_resources_plugins;
  1051. LocalVector<Ref<EditorExportPlugin>> customize_scenes_plugins;
  1052. for (int i = 0; i < export_plugins.size(); i++) {
  1053. if (export_plugins.write[i]->_begin_customize_resources(Ref<EditorExportPlatform>(this), features_psa)) {
  1054. customize_resources_plugins.push_back(export_plugins[i]);
  1055. custom_resources_hash = hash_murmur3_one_64(export_plugins[i]->get_name().hash64(), custom_resources_hash);
  1056. uint64_t hash = export_plugins[i]->_get_customization_configuration_hash();
  1057. custom_resources_hash = hash_murmur3_one_64(hash, custom_resources_hash);
  1058. }
  1059. if (export_plugins.write[i]->_begin_customize_scenes(Ref<EditorExportPlatform>(this), features_psa)) {
  1060. customize_scenes_plugins.push_back(export_plugins[i]);
  1061. custom_resources_hash = hash_murmur3_one_64(export_plugins[i]->get_name().hash64(), custom_resources_hash);
  1062. uint64_t hash = export_plugins[i]->_get_customization_configuration_hash();
  1063. custom_scene_hash = hash_murmur3_one_64(hash, custom_scene_hash);
  1064. }
  1065. }
  1066. // Add any files that might've been defined during the initial steps of the export plugins.
  1067. err = add_shared_objects_and_extra_files_from_export_plugins();
  1068. if (err != OK) {
  1069. return err;
  1070. }
  1071. HashMap<String, FileExportCache> export_cache;
  1072. String export_base_path = ProjectSettings::get_singleton()->get_project_data_path().path_join("exported/") + itos(custom_resources_hash);
  1073. bool convert_text_to_binary = get_project_setting(p_preset, "editor/export/convert_text_resources_to_binary");
  1074. if (convert_text_to_binary || !customize_resources_plugins.is_empty() || !customize_scenes_plugins.is_empty()) {
  1075. // See if we have something to open
  1076. Ref<FileAccess> f = FileAccess::open(export_base_path.path_join("file_cache"), FileAccess::READ);
  1077. if (f.is_valid()) {
  1078. String l = f->get_line();
  1079. while (l != String()) {
  1080. Vector<String> fields = l.split("::");
  1081. if (fields.size() == 4) {
  1082. FileExportCache fec;
  1083. const String &path = fields[0];
  1084. fec.source_md5 = fields[1].strip_edges();
  1085. fec.source_modified_time = fields[2].strip_edges().to_int();
  1086. fec.saved_path = fields[3];
  1087. fec.used = false; // Assume unused until used.
  1088. export_cache[path] = fec;
  1089. }
  1090. l = f->get_line();
  1091. }
  1092. } else {
  1093. // create the path
  1094. Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  1095. d->change_dir(ProjectSettings::get_singleton()->get_project_data_path());
  1096. d->make_dir_recursive("exported/" + itos(custom_resources_hash));
  1097. }
  1098. }
  1099. for (int i = 0; i < export_plugins.size(); i++) {
  1100. export_plugins.write[i]->set_export_base_path(export_base_path);
  1101. }
  1102. //store everything in the export medium
  1103. int total = paths.size();
  1104. // idx is incremented at the beginning of the paths loop to easily allow
  1105. // for continue statements without accidentally skipping an increment.
  1106. int idx = total > 0 ? -1 : 0;
  1107. for (const String &E : paths) {
  1108. idx++;
  1109. String path = E;
  1110. String type = ResourceLoader::get_resource_type(path);
  1111. bool has_import_file = FileAccess::exists(path + ".import");
  1112. Ref<ConfigFile> config;
  1113. if (has_import_file) {
  1114. config.instantiate();
  1115. err = config->load(path + ".import");
  1116. if (err != OK) {
  1117. ERR_PRINT("Could not parse: '" + path + "', not exported.");
  1118. continue;
  1119. }
  1120. String importer_type = config->get_value("remap", "importer");
  1121. if (importer_type == "skip") {
  1122. // Skip file.
  1123. continue;
  1124. }
  1125. }
  1126. bool do_export = true;
  1127. for (int i = 0; i < export_plugins.size(); i++) {
  1128. if (GDVIRTUAL_IS_OVERRIDDEN_PTR(export_plugins[i], _export_file)) {
  1129. export_plugins.write[i]->_export_file_script(path, type, features_psa);
  1130. } else {
  1131. export_plugins.write[i]->_export_file(path, type, features);
  1132. }
  1133. if (p_so_func) {
  1134. for (int j = 0; j < export_plugins[i]->shared_objects.size(); j++) {
  1135. err = p_so_func(p_udata, export_plugins[i]->shared_objects[j]);
  1136. if (err != OK) {
  1137. return err;
  1138. }
  1139. }
  1140. }
  1141. for (int j = 0; j < export_plugins[i]->extra_files.size(); j++) {
  1142. err = save_proxy.save_file(p_udata, export_plugins[i]->extra_files[j].path, export_plugins[i]->extra_files[j].data, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1143. if (err != OK) {
  1144. return err;
  1145. }
  1146. if (export_plugins[i]->extra_files[j].remap) {
  1147. do_export = false; // If remap, do not.
  1148. path_remaps.push_back(path);
  1149. path_remaps.push_back(export_plugins[i]->extra_files[j].path);
  1150. }
  1151. }
  1152. if (export_plugins[i]->skipped) {
  1153. do_export = false;
  1154. }
  1155. export_plugins.write[i]->_clear();
  1156. if (!do_export) {
  1157. break;
  1158. }
  1159. }
  1160. if (!do_export) {
  1161. continue;
  1162. }
  1163. if (has_import_file) {
  1164. String importer_type = config->get_value("remap", "importer");
  1165. if (importer_type == "keep") {
  1166. // Just keep file as-is.
  1167. Vector<uint8_t> array = FileAccess::get_file_as_bytes(path);
  1168. err = save_proxy.save_file(p_udata, path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1169. if (err != OK) {
  1170. return err;
  1171. }
  1172. continue;
  1173. }
  1174. // Before doing this, try to see if it can be customized.
  1175. String export_path = _export_customize(path, customize_resources_plugins, customize_scenes_plugins, export_cache, export_base_path, false);
  1176. if (export_path != path) {
  1177. // It was actually customized.
  1178. // Since the original file is likely not recognized, just use the import system.
  1179. config->set_value("remap", "type", ResourceLoader::get_resource_type(export_path));
  1180. // Erase all Paths.
  1181. Vector<String> keys = config->get_section_keys("remap");
  1182. for (const String &K : keys) {
  1183. if (K.begins_with("path")) {
  1184. config->erase_section_key("remap", K);
  1185. }
  1186. }
  1187. // Set actual converted path.
  1188. config->set_value("remap", "path", export_path);
  1189. // Erase useless sections.
  1190. if (config->has_section("deps")) {
  1191. config->erase_section("deps");
  1192. }
  1193. if (config->has_section("params")) {
  1194. config->erase_section("params");
  1195. }
  1196. String import_text = config->encode_to_text();
  1197. CharString cs = import_text.utf8();
  1198. Vector<uint8_t> sarr;
  1199. sarr.resize(cs.size());
  1200. memcpy(sarr.ptrw(), cs.ptr(), sarr.size());
  1201. err = save_proxy.save_file(p_udata, path + ".import", sarr, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1202. if (err != OK) {
  1203. return err;
  1204. }
  1205. // Now actual remapped file:
  1206. sarr = FileAccess::get_file_as_bytes(export_path);
  1207. err = save_proxy.save_file(p_udata, export_path, sarr, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1208. if (err != OK) {
  1209. return err;
  1210. }
  1211. } else {
  1212. // File is imported and not customized, replace by what it imports.
  1213. Vector<String> remaps = config->get_section_keys("remap");
  1214. HashSet<String> remap_features;
  1215. for (const String &F : remaps) {
  1216. String remap = F;
  1217. String feature = remap.get_slicec('.', 1);
  1218. if (features.has(feature)) {
  1219. remap_features.insert(feature);
  1220. }
  1221. }
  1222. if (remap_features.size() > 1) {
  1223. resolve_platform_feature_priorities(p_preset, remap_features);
  1224. }
  1225. err = OK;
  1226. for (const String &F : remaps) {
  1227. String remap = F;
  1228. if (remap == "path") {
  1229. String remapped_path = config->get_value("remap", remap);
  1230. Vector<uint8_t> array = FileAccess::get_file_as_bytes(remapped_path);
  1231. err = save_proxy.save_file(p_udata, remapped_path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1232. } else if (remap.begins_with("path.")) {
  1233. String feature = remap.get_slicec('.', 1);
  1234. if (remap_features.has(feature)) {
  1235. String remapped_path = config->get_value("remap", remap);
  1236. Vector<uint8_t> array = FileAccess::get_file_as_bytes(remapped_path);
  1237. err = save_proxy.save_file(p_udata, remapped_path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1238. } else {
  1239. // Remove paths if feature not enabled.
  1240. config->erase_section_key("remap", remap);
  1241. }
  1242. }
  1243. }
  1244. if (err != OK) {
  1245. return err;
  1246. }
  1247. // Erase useless sections.
  1248. if (config->has_section("deps")) {
  1249. config->erase_section("deps");
  1250. }
  1251. if (config->has_section("params")) {
  1252. config->erase_section("params");
  1253. }
  1254. String import_text = config->encode_to_text();
  1255. CharString cs = import_text.utf8();
  1256. Vector<uint8_t> sarr;
  1257. sarr.resize(cs.size());
  1258. memcpy(sarr.ptrw(), cs.ptr(), sarr.size());
  1259. err = save_proxy.save_file(p_udata, path + ".import", sarr, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1260. if (err != OK) {
  1261. return err;
  1262. }
  1263. }
  1264. } else {
  1265. // Just store it as it comes.
  1266. // Customization only happens if plugins did not take care of it before.
  1267. bool force_binary = convert_text_to_binary && (path.get_extension().to_lower() == "tres" || path.get_extension().to_lower() == "tscn");
  1268. String export_path = _export_customize(path, customize_resources_plugins, customize_scenes_plugins, export_cache, export_base_path, force_binary);
  1269. if (export_path != path) {
  1270. // Add a remap entry.
  1271. path_remaps.push_back(path);
  1272. path_remaps.push_back(export_path);
  1273. }
  1274. Vector<uint8_t> array = FileAccess::get_file_as_bytes(export_path);
  1275. err = save_proxy.save_file(p_udata, export_path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1276. if (err != OK) {
  1277. return err;
  1278. }
  1279. }
  1280. }
  1281. if (convert_text_to_binary || !customize_resources_plugins.is_empty() || !customize_scenes_plugins.is_empty()) {
  1282. // End scene customization
  1283. String fcache = export_base_path.path_join("file_cache");
  1284. Ref<FileAccess> f = FileAccess::open(fcache, FileAccess::WRITE);
  1285. if (f.is_valid()) {
  1286. for (const KeyValue<String, FileExportCache> &E : export_cache) {
  1287. if (E.value.used) { // May be old, unused
  1288. String l = E.key + "::" + E.value.source_md5 + "::" + itos(E.value.source_modified_time) + "::" + E.value.saved_path;
  1289. f->store_line(l);
  1290. }
  1291. }
  1292. } else {
  1293. ERR_PRINT("Error opening export file cache: " + fcache);
  1294. }
  1295. for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
  1296. plugin->_end_customize_resources();
  1297. }
  1298. for (Ref<EditorExportPlugin> &plugin : customize_scenes_plugins) {
  1299. plugin->_end_customize_scenes();
  1300. }
  1301. }
  1302. // Add any files that might've been defined during the final steps of the export plugins.
  1303. err = add_shared_objects_and_extra_files_from_export_plugins();
  1304. if (err != OK) {
  1305. return err;
  1306. }
  1307. //save config!
  1308. Vector<String> custom_list;
  1309. if (!p_preset->get_custom_features().is_empty()) {
  1310. Vector<String> tmp_custom_list = p_preset->get_custom_features().split(",");
  1311. for (int i = 0; i < tmp_custom_list.size(); i++) {
  1312. String f = tmp_custom_list[i].strip_edges();
  1313. if (!f.is_empty()) {
  1314. custom_list.push_back(f);
  1315. }
  1316. }
  1317. }
  1318. for (int i = 0; i < export_plugins.size(); i++) {
  1319. custom_list.append_array(export_plugins[i]->_get_export_features(Ref<EditorExportPlatform>(this), p_debug));
  1320. }
  1321. if (path_remaps.size()) {
  1322. for (int i = 0; i < path_remaps.size(); i += 2) {
  1323. const String &from = path_remaps[i];
  1324. const String &to = path_remaps[i + 1];
  1325. String remap_file = "[remap]\n\npath=\"" + to.c_escape() + "\"\n";
  1326. CharString utf8 = remap_file.utf8();
  1327. Vector<uint8_t> new_file;
  1328. new_file.resize(utf8.length());
  1329. for (int j = 0; j < utf8.length(); j++) {
  1330. new_file.write[j] = utf8[j];
  1331. }
  1332. err = save_proxy.save_file(p_udata, from + ".remap", new_file, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1333. if (err != OK) {
  1334. return err;
  1335. }
  1336. }
  1337. }
  1338. Vector<String> forced_export = get_forced_export_files(p_preset);
  1339. for (int i = 0; i < forced_export.size(); i++) {
  1340. Vector<uint8_t> array;
  1341. if (GDExtension::get_extension_list_config_file() == forced_export[i]) {
  1342. array = _filter_extension_list_config_file(forced_export[i], paths);
  1343. if (array.is_empty()) {
  1344. continue;
  1345. }
  1346. } else {
  1347. array = FileAccess::get_file_as_bytes(forced_export[i]);
  1348. }
  1349. err = save_proxy.save_file(p_udata, forced_export[i], array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1350. if (err != OK) {
  1351. return err;
  1352. }
  1353. }
  1354. Dictionary int_export = get_internal_export_files(p_preset, p_debug);
  1355. for (const KeyValue<Variant, Variant> &int_export_kv : int_export) {
  1356. const PackedByteArray &array = int_export_kv.value;
  1357. err = save_proxy.save_file(p_udata, int_export_kv.key, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1358. if (err != OK) {
  1359. return err;
  1360. }
  1361. }
  1362. String config_file = "project.binary";
  1363. String engine_cfb = EditorPaths::get_singleton()->get_temp_dir().path_join("tmp" + config_file);
  1364. ProjectSettings::CustomMap custom_map = get_custom_project_settings(p_preset);
  1365. ProjectSettings::get_singleton()->save_custom(engine_cfb, custom_map, custom_list);
  1366. Vector<uint8_t> data = FileAccess::get_file_as_bytes(engine_cfb);
  1367. DirAccess::remove_file_or_error(engine_cfb);
  1368. err = save_proxy.save_file(p_udata, "res://" + config_file, data, idx, total, enc_in_filters, enc_ex_filters, key, seed);
  1369. if (err != OK) {
  1370. return err;
  1371. }
  1372. if (p_remove_func) {
  1373. HashSet<String> currently_loaded_paths = PackedData::get_singleton()->get_file_paths();
  1374. for (const String &path : currently_loaded_paths) {
  1375. if (!save_proxy.has_saved(path)) {
  1376. err = p_remove_func(p_udata, path);
  1377. if (err != OK) {
  1378. return err;
  1379. }
  1380. }
  1381. }
  1382. }
  1383. return OK;
  1384. }
  1385. Vector<uint8_t> EditorExportPlatform::_filter_extension_list_config_file(const String &p_config_path, const HashSet<String> &p_paths) {
  1386. Ref<FileAccess> f = FileAccess::open(p_config_path, FileAccess::READ);
  1387. if (f.is_null()) {
  1388. ERR_FAIL_V_MSG(Vector<uint8_t>(), "Can't open file from path '" + String(p_config_path) + "'.");
  1389. }
  1390. Vector<uint8_t> data;
  1391. while (!f->eof_reached()) {
  1392. String l = f->get_line().strip_edges();
  1393. if (p_paths.has(l)) {
  1394. data.append_array(l.to_utf8_buffer());
  1395. data.append('\n');
  1396. }
  1397. }
  1398. return data;
  1399. }
  1400. Error EditorExportPlatform::_pack_add_shared_object(void *p_userdata, const SharedObject &p_so) {
  1401. PackData *pack_data = (PackData *)p_userdata;
  1402. if (pack_data->so_files) {
  1403. pack_data->so_files->push_back(p_so);
  1404. }
  1405. return OK;
  1406. }
  1407. Error EditorExportPlatform::_remove_pack_file(void *p_userdata, const String &p_path) {
  1408. PackData *pd = (PackData *)p_userdata;
  1409. SavedData sd;
  1410. sd.path_utf8 = p_path.utf8();
  1411. sd.ofs = pd->f->get_position();
  1412. sd.size = 0;
  1413. sd.removal = true;
  1414. // This padding will likely never be added, as we should already be aligned when removals are added.
  1415. int pad = _get_pad(PCK_PADDING, pd->f->get_position());
  1416. for (int i = 0; i < pad; i++) {
  1417. pd->f->store_8(0);
  1418. }
  1419. sd.md5.resize_initialized(16);
  1420. pd->file_ofs.push_back(sd);
  1421. return OK;
  1422. }
  1423. Error EditorExportPlatform::_zip_add_shared_object(void *p_userdata, const SharedObject &p_so) {
  1424. ZipData *zip_data = (ZipData *)p_userdata;
  1425. if (zip_data->so_files) {
  1426. zip_data->so_files->push_back(p_so);
  1427. }
  1428. return OK;
  1429. }
  1430. void EditorExportPlatform::zip_folder_recursive(zipFile &p_zip, const String &p_root_path, const String &p_folder, const String &p_pkg_name) {
  1431. String dir = p_folder.is_empty() ? p_root_path : p_root_path.path_join(p_folder);
  1432. Ref<DirAccess> da = DirAccess::open(dir);
  1433. ERR_FAIL_COND(da.is_null());
  1434. da->list_dir_begin();
  1435. String f = da->get_next();
  1436. while (!f.is_empty()) {
  1437. if (f == "." || f == "..") {
  1438. f = da->get_next();
  1439. continue;
  1440. }
  1441. if (da->is_link(f)) {
  1442. OS::DateTime dt = OS::get_singleton()->get_datetime();
  1443. zip_fileinfo zipfi;
  1444. zipfi.tmz_date.tm_year = dt.year;
  1445. zipfi.tmz_date.tm_mon = dt.month - 1; // Note: "tm" month range - 0..11, Godot month range - 1..12, https://www.cplusplus.com/reference/ctime/tm/
  1446. zipfi.tmz_date.tm_mday = dt.day;
  1447. zipfi.tmz_date.tm_hour = dt.hour;
  1448. zipfi.tmz_date.tm_min = dt.minute;
  1449. zipfi.tmz_date.tm_sec = dt.second;
  1450. zipfi.dosDate = 0;
  1451. // 0120000: symbolic link type
  1452. // 0000755: permissions rwxr-xr-x
  1453. // 0000644: permissions rw-r--r--
  1454. uint32_t _mode = 0120644;
  1455. zipfi.external_fa = (_mode << 16L) | !(_mode & 0200);
  1456. zipfi.internal_fa = 0;
  1457. zipOpenNewFileInZip4(p_zip,
  1458. p_folder.path_join(f).utf8().get_data(),
  1459. &zipfi,
  1460. nullptr,
  1461. 0,
  1462. nullptr,
  1463. 0,
  1464. nullptr,
  1465. Z_DEFLATED,
  1466. Z_DEFAULT_COMPRESSION,
  1467. 0,
  1468. -MAX_WBITS,
  1469. DEF_MEM_LEVEL,
  1470. Z_DEFAULT_STRATEGY,
  1471. nullptr,
  1472. 0,
  1473. 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions
  1474. 1 << 11); // Bit 11 is the language encoding flag. When set, filename and comment fields must be encoded using UTF-8.
  1475. const CharString target_utf8 = da->read_link(f).utf8();
  1476. zipWriteInFileInZip(p_zip, target_utf8.get_data(), target_utf8.size());
  1477. zipCloseFileInZip(p_zip);
  1478. } else if (da->current_is_dir()) {
  1479. zip_folder_recursive(p_zip, p_root_path, p_folder.path_join(f), p_pkg_name);
  1480. } else {
  1481. bool _is_executable = is_executable(dir.path_join(f));
  1482. OS::DateTime dt = OS::get_singleton()->get_datetime();
  1483. zip_fileinfo zipfi;
  1484. zipfi.tmz_date.tm_year = dt.year;
  1485. zipfi.tmz_date.tm_mon = dt.month - 1; // Note: "tm" month range - 0..11, Godot month range - 1..12, https://www.cplusplus.com/reference/ctime/tm/
  1486. zipfi.tmz_date.tm_mday = dt.day;
  1487. zipfi.tmz_date.tm_hour = dt.hour;
  1488. zipfi.tmz_date.tm_min = dt.minute;
  1489. zipfi.tmz_date.tm_sec = dt.second;
  1490. zipfi.dosDate = 0;
  1491. // 0100000: regular file type
  1492. // 0000755: permissions rwxr-xr-x
  1493. // 0000644: permissions rw-r--r--
  1494. uint32_t _mode = (_is_executable ? 0100755 : 0100644);
  1495. zipfi.external_fa = (_mode << 16L) | !(_mode & 0200);
  1496. zipfi.internal_fa = 0;
  1497. zipOpenNewFileInZip4(p_zip,
  1498. p_folder.path_join(f).utf8().get_data(),
  1499. &zipfi,
  1500. nullptr,
  1501. 0,
  1502. nullptr,
  1503. 0,
  1504. nullptr,
  1505. Z_DEFLATED,
  1506. Z_DEFAULT_COMPRESSION,
  1507. 0,
  1508. -MAX_WBITS,
  1509. DEF_MEM_LEVEL,
  1510. Z_DEFAULT_STRATEGY,
  1511. nullptr,
  1512. 0,
  1513. 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions
  1514. 1 << 11); // Bit 11 is the language encoding flag. When set, filename and comment fields must be encoded using UTF-8.
  1515. Ref<FileAccess> fa = FileAccess::open(dir.path_join(f), FileAccess::READ);
  1516. if (fa.is_null()) {
  1517. add_message(EXPORT_MESSAGE_ERROR, TTR("ZIP Creation"), vformat(TTR("Could not open file to read from path \"%s\"."), dir.path_join(f)));
  1518. return;
  1519. }
  1520. const int bufsize = 16384;
  1521. uint8_t buf[bufsize];
  1522. while (true) {
  1523. uint64_t got = fa->get_buffer(buf, bufsize);
  1524. if (got == 0) {
  1525. break;
  1526. }
  1527. zipWriteInFileInZip(p_zip, buf, got);
  1528. }
  1529. zipCloseFileInZip(p_zip);
  1530. }
  1531. f = da->get_next();
  1532. }
  1533. da->list_dir_end();
  1534. }
  1535. Dictionary EditorExportPlatform::_save_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, bool p_embed) {
  1536. Vector<SharedObject> so_files;
  1537. int64_t embedded_start = 0;
  1538. int64_t embedded_size = 0;
  1539. Error err_code = save_pack(p_preset, p_debug, p_path, &so_files, nullptr, nullptr, p_embed, &embedded_start, &embedded_size);
  1540. Dictionary ret;
  1541. ret["result"] = err_code;
  1542. if (err_code == OK) {
  1543. Array arr;
  1544. for (const SharedObject &E : so_files) {
  1545. Dictionary so;
  1546. so["path"] = E.path;
  1547. so["tags"] = E.tags;
  1548. so["target_folder"] = E.target;
  1549. arr.push_back(so);
  1550. }
  1551. ret["so_files"] = arr;
  1552. if (p_embed) {
  1553. ret["embedded_start"] = embedded_start;
  1554. ret["embedded_size"] = embedded_size;
  1555. }
  1556. }
  1557. return ret;
  1558. }
  1559. Dictionary EditorExportPlatform::_save_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  1560. Vector<SharedObject> so_files;
  1561. Error err_code = save_zip(p_preset, p_debug, p_path, &so_files);
  1562. Dictionary ret;
  1563. ret["result"] = err_code;
  1564. if (err_code == OK) {
  1565. Array arr;
  1566. for (const SharedObject &E : so_files) {
  1567. Dictionary so;
  1568. so["path"] = E.path;
  1569. so["tags"] = E.tags;
  1570. so["target_folder"] = E.target;
  1571. arr.push_back(so);
  1572. }
  1573. ret["so_files"] = arr;
  1574. }
  1575. return ret;
  1576. }
  1577. Dictionary EditorExportPlatform::_save_pack_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  1578. Vector<SharedObject> so_files;
  1579. Error err_code = save_pack_patch(p_preset, p_debug, p_path, &so_files);
  1580. Dictionary ret;
  1581. ret["result"] = err_code;
  1582. if (err_code == OK) {
  1583. Array arr;
  1584. for (const SharedObject &E : so_files) {
  1585. Dictionary so;
  1586. so["path"] = E.path;
  1587. so["tags"] = E.tags;
  1588. so["target_folder"] = E.target;
  1589. arr.push_back(so);
  1590. }
  1591. ret["so_files"] = arr;
  1592. }
  1593. return ret;
  1594. }
  1595. Dictionary EditorExportPlatform::_save_zip_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  1596. Vector<SharedObject> so_files;
  1597. Error err_code = save_zip_patch(p_preset, p_debug, p_path, &so_files);
  1598. Dictionary ret;
  1599. ret["result"] = err_code;
  1600. if (err_code == OK) {
  1601. Array arr;
  1602. for (const SharedObject &E : so_files) {
  1603. Dictionary so;
  1604. so["path"] = E.path;
  1605. so["tags"] = E.tags;
  1606. so["target_folder"] = E.target;
  1607. arr.push_back(so);
  1608. }
  1609. ret["so_files"] = arr;
  1610. }
  1611. return ret;
  1612. }
  1613. Error EditorExportPlatform::save_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files, EditorExportSaveFunction p_save_func, EditorExportRemoveFunction p_remove_func, bool p_embed, int64_t *r_embedded_start, int64_t *r_embedded_size) {
  1614. EditorProgress ep("savepack", TTR("Packing"), 102, true);
  1615. if (p_save_func == nullptr) {
  1616. p_save_func = _save_pack_file;
  1617. }
  1618. // Create the temporary export directory if it doesn't exist.
  1619. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1620. da->make_dir_recursive(EditorPaths::get_singleton()->get_temp_dir());
  1621. Ref<FileAccess> f;
  1622. int64_t embed_pos = 0;
  1623. if (!p_embed) {
  1624. // Regular output to separate PCK file.
  1625. f = FileAccess::open(p_path, FileAccess::WRITE);
  1626. if (f.is_null()) {
  1627. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), vformat(TTR("Can't open file for writing at path \"%s\"."), p_path));
  1628. return ERR_CANT_CREATE;
  1629. }
  1630. } else {
  1631. // Append to executable.
  1632. f = FileAccess::open(p_path, FileAccess::READ_WRITE);
  1633. if (f.is_null()) {
  1634. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), vformat(TTR("Can't open file for reading-writing at path \"%s\"."), p_path));
  1635. return ERR_FILE_CANT_OPEN;
  1636. }
  1637. f->seek_end();
  1638. embed_pos = f->get_position();
  1639. if (r_embedded_start) {
  1640. *r_embedded_start = embed_pos;
  1641. }
  1642. // Ensure embedded PCK starts at a 64-bit multiple
  1643. int pad = f->get_position() % 8;
  1644. for (int i = 0; i < pad; i++) {
  1645. f->store_8(0);
  1646. }
  1647. }
  1648. int64_t pck_start_pos = f->get_position();
  1649. // Write header.
  1650. f->store_32(PACK_HEADER_MAGIC);
  1651. f->store_32(PACK_FORMAT_VERSION);
  1652. f->store_32(GODOT_VERSION_MAJOR);
  1653. f->store_32(GODOT_VERSION_MINOR);
  1654. f->store_32(GODOT_VERSION_PATCH);
  1655. uint32_t pack_flags = PACK_REL_FILEBASE;
  1656. bool enc_pck = p_preset->get_enc_pck();
  1657. bool enc_directory = p_preset->get_enc_directory();
  1658. if (enc_pck && enc_directory) {
  1659. pack_flags |= PACK_DIR_ENCRYPTED;
  1660. }
  1661. f->store_32(pack_flags); // Flags.
  1662. uint64_t file_base_ofs = f->get_position();
  1663. f->store_64(0); // Files base.
  1664. uint64_t dir_base_ofs = f->get_position();
  1665. f->store_64(0); // Directory offset.
  1666. for (int i = 0; i < 16; i++) {
  1667. f->store_32(0); // Reserved.
  1668. }
  1669. // Align for first file.
  1670. int file_padding = _get_pad(PCK_PADDING, f->get_position());
  1671. for (int i = 0; i < file_padding; i++) {
  1672. f->store_8(0);
  1673. }
  1674. uint64_t file_base = f->get_position();
  1675. f->seek(file_base_ofs);
  1676. f->store_64(file_base - pck_start_pos); // Update files base.
  1677. f->seek(file_base);
  1678. // Write files.
  1679. PackData pd;
  1680. pd.ep = &ep;
  1681. pd.f = f;
  1682. pd.so_files = p_so_files;
  1683. Error err = export_project_files(p_preset, p_debug, p_save_func, p_remove_func, &pd, _pack_add_shared_object);
  1684. if (err != OK) {
  1685. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Failed to export project files."));
  1686. return err;
  1687. }
  1688. if (pd.file_ofs.is_empty()) {
  1689. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("No files or changes to export."));
  1690. return FAILED;
  1691. }
  1692. pd.file_ofs.sort(); // Do sort, so we can do binary search later (where ?).
  1693. int dir_padding = _get_pad(PCK_PADDING, f->get_position());
  1694. for (int i = 0; i < dir_padding; i++) {
  1695. f->store_8(0);
  1696. }
  1697. // Write directory.
  1698. uint64_t dir_offset = f->get_position();
  1699. f->seek(dir_base_ofs);
  1700. f->store_64(dir_offset - pck_start_pos);
  1701. f->seek(dir_offset);
  1702. f->store_32(pd.file_ofs.size());
  1703. Ref<FileAccessEncrypted> fae;
  1704. Ref<FileAccess> fhead = f;
  1705. if (enc_pck && enc_directory) {
  1706. uint64_t seed = p_preset->get_seed();
  1707. String script_key = _get_script_encryption_key(p_preset);
  1708. Vector<uint8_t> key;
  1709. key.resize(32);
  1710. if (script_key.length() == 64) {
  1711. for (int i = 0; i < 32; i++) {
  1712. int v = 0;
  1713. if (i * 2 < script_key.length()) {
  1714. char32_t ct = script_key[i * 2];
  1715. if (is_digit(ct)) {
  1716. ct = ct - '0';
  1717. } else if (ct >= 'a' && ct <= 'f') {
  1718. ct = 10 + ct - 'a';
  1719. }
  1720. v |= ct << 4;
  1721. }
  1722. if (i * 2 + 1 < script_key.length()) {
  1723. char32_t ct = script_key[i * 2 + 1];
  1724. if (is_digit(ct)) {
  1725. ct = ct - '0';
  1726. } else if (ct >= 'a' && ct <= 'f') {
  1727. ct = 10 + ct - 'a';
  1728. }
  1729. v |= ct;
  1730. }
  1731. key.write[i] = v;
  1732. }
  1733. }
  1734. fae.instantiate();
  1735. if (fae.is_null()) {
  1736. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Can't create encrypted file."));
  1737. return ERR_CANT_CREATE;
  1738. }
  1739. Vector<uint8_t> iv;
  1740. if (seed != 0) {
  1741. for (int i = 0; i < pd.file_ofs.size(); i++) {
  1742. for (int64_t j = 0; j < pd.file_ofs[i].path_utf8.length(); j++) {
  1743. seed = ((seed << 5) + seed) ^ pd.file_ofs[i].path_utf8.get_data()[j];
  1744. }
  1745. for (int64_t j = 0; j < pd.file_ofs[i].md5.size(); j++) {
  1746. seed = ((seed << 5) + seed) ^ pd.file_ofs[i].md5[j];
  1747. }
  1748. seed = ((seed << 5) + seed) ^ (pd.file_ofs[i].ofs - file_base);
  1749. seed = ((seed << 5) + seed) ^ pd.file_ofs[i].size;
  1750. }
  1751. RandomPCG rng = RandomPCG(seed);
  1752. iv.resize(16);
  1753. for (int i = 0; i < 16; i++) {
  1754. iv.write[i] = rng.rand() % 256;
  1755. }
  1756. }
  1757. err = fae->open_and_parse(f, key, FileAccessEncrypted::MODE_WRITE_AES256, false, iv);
  1758. if (err != OK) {
  1759. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Can't open encrypted file to write."));
  1760. return ERR_CANT_CREATE;
  1761. }
  1762. fhead = fae;
  1763. }
  1764. for (int i = 0; i < pd.file_ofs.size(); i++) {
  1765. uint32_t string_len = pd.file_ofs[i].path_utf8.length();
  1766. uint32_t pad = _get_pad(4, string_len);
  1767. fhead->store_32(string_len + pad);
  1768. fhead->store_buffer((const uint8_t *)pd.file_ofs[i].path_utf8.get_data(), string_len);
  1769. for (uint32_t j = 0; j < pad; j++) {
  1770. fhead->store_8(0);
  1771. }
  1772. fhead->store_64(pd.file_ofs[i].ofs - file_base);
  1773. fhead->store_64(pd.file_ofs[i].size);
  1774. fhead->store_buffer(pd.file_ofs[i].md5.ptr(), 16);
  1775. uint32_t flags = 0;
  1776. if (pd.file_ofs[i].encrypted) {
  1777. flags |= PACK_FILE_ENCRYPTED;
  1778. }
  1779. if (pd.file_ofs[i].removal) {
  1780. flags |= PACK_FILE_REMOVAL;
  1781. }
  1782. fhead->store_32(flags);
  1783. }
  1784. if (fae.is_valid()) {
  1785. fhead.unref();
  1786. fae.unref();
  1787. }
  1788. if (p_embed) {
  1789. // Ensure embedded data ends at a 64-bit multiple.
  1790. uint64_t embed_end = f->get_position() - embed_pos + 12;
  1791. uint64_t pad = embed_end % 8;
  1792. for (uint64_t i = 0; i < pad; i++) {
  1793. f->store_8(0);
  1794. }
  1795. uint64_t pck_size = f->get_position() - pck_start_pos;
  1796. f->store_64(pck_size);
  1797. f->store_32(PACK_HEADER_MAGIC);
  1798. if (r_embedded_size) {
  1799. *r_embedded_size = f->get_position() - embed_pos;
  1800. }
  1801. }
  1802. f->close();
  1803. return OK;
  1804. }
  1805. Error EditorExportPlatform::save_pack_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files, bool p_embed, int64_t *r_embedded_start, int64_t *r_embedded_size) {
  1806. return save_pack(p_preset, p_debug, p_path, p_so_files, _save_pack_patch_file, _remove_pack_file, p_embed, r_embedded_start, r_embedded_size);
  1807. }
  1808. Error EditorExportPlatform::save_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files, EditorExportSaveFunction p_save_func) {
  1809. EditorProgress ep("savezip", TTR("Packing"), 102, true);
  1810. if (p_save_func == nullptr) {
  1811. p_save_func = _save_zip_file;
  1812. }
  1813. String tmppath = EditorPaths::get_singleton()->get_temp_dir().path_join("packtmp");
  1814. Ref<FileAccess> io_fa;
  1815. zlib_filefunc_def io = zipio_create_io(&io_fa);
  1816. zipFile zip = zipOpen2(tmppath.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io);
  1817. ZipData zd;
  1818. zd.ep = &ep;
  1819. zd.zip = zip;
  1820. zd.so_files = p_so_files;
  1821. Error err = export_project_files(p_preset, p_debug, p_save_func, nullptr, &zd, _zip_add_shared_object);
  1822. if (err != OK && err != ERR_SKIP) {
  1823. add_message(EXPORT_MESSAGE_ERROR, TTR("Save ZIP"), TTR("Failed to export project files."));
  1824. }
  1825. zipClose(zip, nullptr);
  1826. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1827. if (zd.file_count == 0) {
  1828. da->remove(tmppath);
  1829. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("No files or changes to export."));
  1830. return FAILED;
  1831. }
  1832. err = da->rename(tmppath, p_path);
  1833. if (err != OK) {
  1834. da->remove(tmppath);
  1835. add_message(EXPORT_MESSAGE_ERROR, TTR("Save ZIP"), vformat(TTR("Failed to move temporary file \"%s\" to \"%s\"."), tmppath, p_path));
  1836. }
  1837. return OK;
  1838. }
  1839. Error EditorExportPlatform::save_zip_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files) {
  1840. return save_zip(p_preset, p_debug, p_path, p_so_files, _save_zip_patch_file);
  1841. }
  1842. Error EditorExportPlatform::export_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  1843. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1844. return save_pack(p_preset, p_debug, p_path);
  1845. }
  1846. Error EditorExportPlatform::export_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  1847. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1848. return save_zip(p_preset, p_debug, p_path);
  1849. }
  1850. Error EditorExportPlatform::export_pack_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, const Vector<String> &p_patches, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  1851. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1852. Error err = _load_patches(p_patches.is_empty() ? p_preset->get_patches() : p_patches);
  1853. if (err != OK) {
  1854. return err;
  1855. }
  1856. err = save_pack_patch(p_preset, p_debug, p_path);
  1857. _unload_patches();
  1858. return err;
  1859. }
  1860. Error EditorExportPlatform::export_zip_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, const Vector<String> &p_patches, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  1861. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1862. Error err = _load_patches(p_patches.is_empty() ? p_preset->get_patches() : p_patches);
  1863. if (err != OK) {
  1864. return err;
  1865. }
  1866. err = save_zip_patch(p_preset, p_debug, p_path);
  1867. _unload_patches();
  1868. return err;
  1869. }
  1870. Vector<String> EditorExportPlatform::gen_export_flags(BitField<EditorExportPlatform::DebugFlags> p_flags) {
  1871. Vector<String> ret;
  1872. String host = EDITOR_GET("network/debug/remote_host");
  1873. int remote_port = (int)EDITOR_GET("network/debug/remote_port");
  1874. if (get_name() == "Android" && EditorSettings::get_singleton()->has_setting("export/android/use_wifi_for_remote_debug") && EDITOR_GET("export/android/use_wifi_for_remote_debug")) {
  1875. host = EDITOR_GET("export/android/wifi_remote_debug_host");
  1876. } else if (p_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST)) {
  1877. host = "localhost";
  1878. }
  1879. if (p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  1880. int port = EDITOR_GET("filesystem/file_server/port");
  1881. String passwd = EDITOR_GET("filesystem/file_server/password");
  1882. ret.push_back("--remote-fs");
  1883. ret.push_back(host + ":" + itos(port));
  1884. if (!passwd.is_empty()) {
  1885. ret.push_back("--remote-fs-password");
  1886. ret.push_back(passwd);
  1887. }
  1888. }
  1889. if (p_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG)) {
  1890. ret.push_back("--remote-debug");
  1891. ret.push_back(get_debug_protocol() + host + ":" + String::num_int64(remote_port));
  1892. List<String> breakpoints;
  1893. ScriptEditor::get_singleton()->get_breakpoints(&breakpoints);
  1894. if (breakpoints.size()) {
  1895. ret.push_back("--breakpoints");
  1896. String bpoints;
  1897. for (List<String>::Element *E = breakpoints.front(); E; E = E->next()) {
  1898. bpoints += E->get().replace(" ", "%20");
  1899. if (E->next()) {
  1900. bpoints += ",";
  1901. }
  1902. }
  1903. ret.push_back(bpoints);
  1904. }
  1905. }
  1906. if (p_flags.has_flag(DEBUG_FLAG_VIEW_COLLISIONS)) {
  1907. ret.push_back("--debug-collisions");
  1908. }
  1909. if (p_flags.has_flag(DEBUG_FLAG_VIEW_NAVIGATION)) {
  1910. ret.push_back("--debug-navigation");
  1911. }
  1912. return ret;
  1913. }
  1914. bool EditorExportPlatform::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const {
  1915. bool valid = true;
  1916. String templates_error;
  1917. valid = valid && has_valid_export_configuration(p_preset, templates_error, r_missing_templates, p_debug);
  1918. if (!templates_error.is_empty()) {
  1919. r_error += templates_error;
  1920. }
  1921. String export_plugins_warning;
  1922. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  1923. for (int i = 0; i < export_plugins.size(); i++) {
  1924. Ref<EditorExportPlatform> export_platform = Ref<EditorExportPlatform>(this);
  1925. if (!export_plugins[i]->supports_platform(export_platform)) {
  1926. continue;
  1927. }
  1928. String plugin_warning = export_plugins.write[i]->_has_valid_export_configuration(export_platform, p_preset);
  1929. if (!plugin_warning.is_empty()) {
  1930. export_plugins_warning += plugin_warning;
  1931. }
  1932. }
  1933. if (!export_plugins_warning.is_empty()) {
  1934. r_error += export_plugins_warning;
  1935. }
  1936. String project_configuration_error;
  1937. valid = valid && has_valid_project_configuration(p_preset, project_configuration_error);
  1938. if (!project_configuration_error.is_empty()) {
  1939. r_error += project_configuration_error;
  1940. }
  1941. return valid;
  1942. }
  1943. Error EditorExportPlatform::ssh_run_on_remote(const String &p_host, const String &p_port, const Vector<String> &p_ssh_args, const String &p_cmd_args, String *r_out, int p_port_fwd) const {
  1944. String ssh_path = EDITOR_GET("export/ssh/ssh");
  1945. if (ssh_path.is_empty()) {
  1946. ssh_path = "ssh";
  1947. }
  1948. List<String> args;
  1949. args.push_back("-p");
  1950. args.push_back(p_port);
  1951. args.push_back("-q");
  1952. args.push_back("-o");
  1953. args.push_back("LogLevel=error");
  1954. args.push_back("-o");
  1955. args.push_back("BatchMode=yes");
  1956. args.push_back("-o");
  1957. args.push_back("StrictHostKeyChecking=no");
  1958. for (const String &E : p_ssh_args) {
  1959. args.push_back(E);
  1960. }
  1961. if (p_port_fwd > 0) {
  1962. args.push_back("-R");
  1963. args.push_back(vformat("%d:localhost:%d", p_port_fwd, p_port_fwd));
  1964. }
  1965. args.push_back(p_host);
  1966. args.push_back(p_cmd_args);
  1967. String out;
  1968. int exit_code = -1;
  1969. if (OS::get_singleton()->is_stdout_verbose()) {
  1970. OS::get_singleton()->print("Executing: %s", ssh_path.utf8().get_data());
  1971. for (const String &arg : args) {
  1972. OS::get_singleton()->print(" %s", arg.utf8().get_data());
  1973. }
  1974. OS::get_singleton()->print("\n");
  1975. }
  1976. Error err = OS::get_singleton()->execute(ssh_path, args, &out, &exit_code, true);
  1977. if (out.is_empty()) {
  1978. print_verbose(vformat("Exit code: %d", exit_code));
  1979. } else {
  1980. print_verbose(vformat("Exit code: %d, Output: %s", exit_code, out.replace("\r\n", "\n")));
  1981. }
  1982. if (r_out) {
  1983. *r_out = out.replace("\r\n", "\n").get_slicec('\n', 0);
  1984. }
  1985. if (err != OK) {
  1986. return err;
  1987. } else if (exit_code != 0) {
  1988. if (!out.is_empty()) {
  1989. print_line(out);
  1990. }
  1991. return FAILED;
  1992. }
  1993. return OK;
  1994. }
  1995. Error EditorExportPlatform::ssh_run_on_remote_no_wait(const String &p_host, const String &p_port, const Vector<String> &p_ssh_args, const String &p_cmd_args, OS::ProcessID *r_pid, int p_port_fwd) const {
  1996. String ssh_path = EDITOR_GET("export/ssh/ssh");
  1997. if (ssh_path.is_empty()) {
  1998. ssh_path = "ssh";
  1999. }
  2000. List<String> args;
  2001. args.push_back("-p");
  2002. args.push_back(p_port);
  2003. args.push_back("-q");
  2004. args.push_back("-o");
  2005. args.push_back("LogLevel=error");
  2006. args.push_back("-o");
  2007. args.push_back("BatchMode=yes");
  2008. args.push_back("-o");
  2009. args.push_back("StrictHostKeyChecking=no");
  2010. for (const String &E : p_ssh_args) {
  2011. args.push_back(E);
  2012. }
  2013. if (p_port_fwd > 0) {
  2014. args.push_back("-R");
  2015. args.push_back(vformat("%d:localhost:%d", p_port_fwd, p_port_fwd));
  2016. }
  2017. args.push_back(p_host);
  2018. args.push_back(p_cmd_args);
  2019. if (OS::get_singleton()->is_stdout_verbose()) {
  2020. OS::get_singleton()->print("Executing: %s", ssh_path.utf8().get_data());
  2021. for (const String &arg : args) {
  2022. OS::get_singleton()->print(" %s", arg.utf8().get_data());
  2023. }
  2024. OS::get_singleton()->print("\n");
  2025. }
  2026. return OS::get_singleton()->create_process(ssh_path, args, r_pid);
  2027. }
  2028. Error EditorExportPlatform::ssh_push_to_remote(const String &p_host, const String &p_port, const Vector<String> &p_scp_args, const String &p_src_file, const String &p_dst_file) const {
  2029. String scp_path = EDITOR_GET("export/ssh/scp");
  2030. if (scp_path.is_empty()) {
  2031. scp_path = "scp";
  2032. }
  2033. List<String> args;
  2034. args.push_back("-P");
  2035. args.push_back(p_port);
  2036. args.push_back("-q");
  2037. args.push_back("-o");
  2038. args.push_back("LogLevel=error");
  2039. args.push_back("-o");
  2040. args.push_back("BatchMode=yes");
  2041. args.push_back("-o");
  2042. args.push_back("StrictHostKeyChecking=no");
  2043. for (const String &E : p_scp_args) {
  2044. args.push_back(E);
  2045. }
  2046. args.push_back(p_src_file);
  2047. args.push_back(vformat("%s:%s", p_host, p_dst_file));
  2048. String out;
  2049. int exit_code = -1;
  2050. if (OS::get_singleton()->is_stdout_verbose()) {
  2051. OS::get_singleton()->print("Executing: %s", scp_path.utf8().get_data());
  2052. for (const String &arg : args) {
  2053. OS::get_singleton()->print(" %s", arg.utf8().get_data());
  2054. }
  2055. OS::get_singleton()->print("\n");
  2056. }
  2057. Error err = OS::get_singleton()->execute(scp_path, args, &out, &exit_code, true);
  2058. if (err != OK) {
  2059. return err;
  2060. } else if (exit_code != 0) {
  2061. if (!out.is_empty()) {
  2062. print_line(out);
  2063. }
  2064. return FAILED;
  2065. }
  2066. return OK;
  2067. }
  2068. Array EditorExportPlatform::get_current_presets() const {
  2069. Array ret;
  2070. for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
  2071. Ref<EditorExportPreset> ep = EditorExport::get_singleton()->get_export_preset(i);
  2072. if (ep->get_platform() == this) {
  2073. ret.push_back(ep);
  2074. }
  2075. }
  2076. return ret;
  2077. }
  2078. Variant EditorExportPlatform::get_project_setting(const Ref<EditorExportPreset> &p_preset, const StringName &p_name) {
  2079. if (p_preset.is_valid()) {
  2080. return p_preset->get_project_setting(p_name);
  2081. } else {
  2082. return GLOBAL_GET(p_name);
  2083. }
  2084. }
  2085. void EditorExportPlatform::_bind_methods() {
  2086. ClassDB::bind_method(D_METHOD("get_os_name"), &EditorExportPlatform::get_os_name);
  2087. ClassDB::bind_method(D_METHOD("create_preset"), &EditorExportPlatform::create_preset);
  2088. ClassDB::bind_method(D_METHOD("find_export_template", "template_file_name"), &EditorExportPlatform::_find_export_template);
  2089. ClassDB::bind_method(D_METHOD("get_current_presets"), &EditorExportPlatform::get_current_presets);
  2090. ClassDB::bind_method(D_METHOD("save_pack", "preset", "debug", "path", "embed"), &EditorExportPlatform::_save_pack, DEFVAL(false));
  2091. ClassDB::bind_method(D_METHOD("save_zip", "preset", "debug", "path"), &EditorExportPlatform::_save_zip);
  2092. ClassDB::bind_method(D_METHOD("save_pack_patch", "preset", "debug", "path"), &EditorExportPlatform::_save_pack_patch);
  2093. ClassDB::bind_method(D_METHOD("save_zip_patch", "preset", "debug", "path"), &EditorExportPlatform::_save_zip_patch);
  2094. ClassDB::bind_method(D_METHOD("gen_export_flags", "flags"), &EditorExportPlatform::gen_export_flags);
  2095. ClassDB::bind_method(D_METHOD("export_project_files", "preset", "debug", "save_cb", "shared_cb"), &EditorExportPlatform::_export_project_files, DEFVAL(Callable()));
  2096. ClassDB::bind_method(D_METHOD("export_project", "preset", "debug", "path", "flags"), &EditorExportPlatform::export_project, DEFVAL(0));
  2097. ClassDB::bind_method(D_METHOD("export_pack", "preset", "debug", "path", "flags"), &EditorExportPlatform::export_pack, DEFVAL(0));
  2098. ClassDB::bind_method(D_METHOD("export_zip", "preset", "debug", "path", "flags"), &EditorExportPlatform::export_zip, DEFVAL(0));
  2099. ClassDB::bind_method(D_METHOD("export_pack_patch", "preset", "debug", "path", "patches", "flags"), &EditorExportPlatform::export_pack_patch, DEFVAL(PackedStringArray()), DEFVAL(0));
  2100. ClassDB::bind_method(D_METHOD("export_zip_patch", "preset", "debug", "path", "patches", "flags"), &EditorExportPlatform::export_zip_patch, DEFVAL(PackedStringArray()), DEFVAL(0));
  2101. ClassDB::bind_method(D_METHOD("clear_messages"), &EditorExportPlatform::clear_messages);
  2102. ClassDB::bind_method(D_METHOD("add_message", "type", "category", "message"), &EditorExportPlatform::add_message);
  2103. ClassDB::bind_method(D_METHOD("get_message_count"), &EditorExportPlatform::get_message_count);
  2104. ClassDB::bind_method(D_METHOD("get_message_type", "index"), &EditorExportPlatform::_get_message_type);
  2105. ClassDB::bind_method(D_METHOD("get_message_category", "index"), &EditorExportPlatform::_get_message_category);
  2106. ClassDB::bind_method(D_METHOD("get_message_text", "index"), &EditorExportPlatform::_get_message_text);
  2107. ClassDB::bind_method(D_METHOD("get_worst_message_type"), &EditorExportPlatform::get_worst_message_type);
  2108. ClassDB::bind_method(D_METHOD("ssh_run_on_remote", "host", "port", "ssh_arg", "cmd_args", "output", "port_fwd"), &EditorExportPlatform::_ssh_run_on_remote, DEFVAL(Array()), DEFVAL(-1));
  2109. ClassDB::bind_method(D_METHOD("ssh_run_on_remote_no_wait", "host", "port", "ssh_args", "cmd_args", "port_fwd"), &EditorExportPlatform::_ssh_run_on_remote_no_wait, DEFVAL(-1));
  2110. ClassDB::bind_method(D_METHOD("ssh_push_to_remote", "host", "port", "scp_args", "src_file", "dst_file"), &EditorExportPlatform::ssh_push_to_remote);
  2111. ClassDB::bind_method(D_METHOD("get_internal_export_files", "preset", "debug"), &EditorExportPlatform::get_internal_export_files);
  2112. ClassDB::bind_static_method("EditorExportPlatform", D_METHOD("get_forced_export_files", "preset"), &EditorExportPlatform::get_forced_export_files);
  2113. BIND_ENUM_CONSTANT(EXPORT_MESSAGE_NONE);
  2114. BIND_ENUM_CONSTANT(EXPORT_MESSAGE_INFO);
  2115. BIND_ENUM_CONSTANT(EXPORT_MESSAGE_WARNING);
  2116. BIND_ENUM_CONSTANT(EXPORT_MESSAGE_ERROR);
  2117. BIND_BITFIELD_FLAG(DEBUG_FLAG_DUMB_CLIENT);
  2118. BIND_BITFIELD_FLAG(DEBUG_FLAG_REMOTE_DEBUG);
  2119. BIND_BITFIELD_FLAG(DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST);
  2120. BIND_BITFIELD_FLAG(DEBUG_FLAG_VIEW_COLLISIONS);
  2121. BIND_BITFIELD_FLAG(DEBUG_FLAG_VIEW_NAVIGATION);
  2122. }