1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545 |
- /**************************************************************************/
- /* editor_export_platform.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "editor_export_platform.h"
- #include "editor_export_platform.compat.inc"
- #include "core/config/project_settings.h"
- #include "core/crypto/crypto_core.h"
- #include "core/extension/gdextension.h"
- #include "core/io/file_access_encrypted.h"
- #include "core/io/file_access_pack.h" // PACK_HEADER_MAGIC, PACK_FORMAT_VERSION
- #include "core/io/image_loader.h"
- #include "core/io/resource_uid.h"
- #include "core/io/zip_io.h"
- #include "core/math/random_pcg.h"
- #include "core/version.h"
- #include "editor/editor_node.h"
- #include "editor/editor_string_names.h"
- #include "editor/export/editor_export.h"
- #include "editor/file_system/editor_file_system.h"
- #include "editor/file_system/editor_paths.h"
- #include "editor/script/script_editor_plugin.h"
- #include "editor/settings/editor_settings.h"
- #include "editor/themes/editor_scale.h"
- #include "editor_export_plugin.h"
- #include "scene/resources/image_texture.h"
- #include "scene/resources/packed_scene.h"
- class EditorExportSaveProxy {
- HashSet<String> saved_paths;
- EditorExportPlatform::EditorExportSaveFunction save_func;
- bool tracking_saves = false;
- public:
- bool has_saved(const String &p_path) const { return saved_paths.has(p_path); }
- 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) {
- if (tracking_saves) {
- saved_paths.insert(p_path.simplify_path().trim_prefix("res://"));
- }
- 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);
- }
- EditorExportSaveProxy(EditorExportPlatform::EditorExportSaveFunction p_save_func, bool p_track_saves) :
- save_func(p_save_func), tracking_saves(p_track_saves) {}
- };
- static int _get_pad(int p_alignment, int p_n) {
- int rest = p_n % p_alignment;
- int pad = 0;
- if (rest > 0) {
- pad = p_alignment - rest;
- };
- return pad;
- }
- #define PCK_PADDING 16
- Ref<Image> EditorExportPlatform::_load_icon_or_splash_image(const String &p_path, Error *r_error) const {
- Ref<Image> image;
- if (!p_path.is_empty() && ResourceLoader::exists(p_path) && !ResourceLoader::get_resource_type(p_path).is_empty()) {
- Ref<Texture2D> texture = ResourceLoader::load(p_path, "", ResourceFormatLoader::CACHE_MODE_REUSE, r_error);
- if (texture.is_valid()) {
- image = texture->get_image();
- if (image.is_valid() && image->is_compressed()) {
- image->decompress();
- }
- }
- }
- if (image.is_null()) {
- image.instantiate();
- Error err = ImageLoader::load_image(p_path, image);
- if (r_error) {
- *r_error = err;
- }
- }
- return image;
- }
- bool EditorExportPlatform::fill_log_messages(RichTextLabel *p_log, Error p_err) {
- bool has_messages = false;
- int msg_count = get_message_count();
- p_log->add_text(TTR("Project export for platform:") + " ");
- p_log->add_image(get_logo(), 16 * EDSCALE, 16 * EDSCALE, Color(1.0, 1.0, 1.0), INLINE_ALIGNMENT_CENTER);
- p_log->add_text(" ");
- p_log->add_text(get_name());
- p_log->add_text(" - ");
- if (p_err == OK && get_worst_message_type() < EditorExportPlatform::EXPORT_MESSAGE_ERROR) {
- if (get_worst_message_type() >= EditorExportPlatform::EXPORT_MESSAGE_WARNING) {
- 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);
- p_log->add_text(" ");
- p_log->add_text(TTR("Completed with warnings."));
- has_messages = true;
- } else {
- 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);
- p_log->add_text(" ");
- p_log->add_text(TTR("Completed successfully."));
- if (msg_count > 0) {
- has_messages = true;
- }
- }
- } else {
- 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);
- p_log->add_text(" ");
- p_log->add_text(TTR("Failed."));
- has_messages = true;
- }
- p_log->add_newline();
- if (msg_count > 0) {
- p_log->push_table(2);
- p_log->set_table_column_expand(0, false);
- p_log->set_table_column_expand(1, true);
- for (int m = 0; m < msg_count; m++) {
- EditorExportPlatform::ExportMessage msg = get_message(m);
- Color color = p_log->get_theme_color(SceneStringName(font_color), SNAME("Label"));
- Ref<Texture> icon;
- switch (msg.msg_type) {
- case EditorExportPlatform::EXPORT_MESSAGE_INFO: {
- color = p_log->get_theme_color(SceneStringName(font_color), EditorStringName(Editor)) * Color(1, 1, 1, 0.6);
- } break;
- case EditorExportPlatform::EXPORT_MESSAGE_WARNING: {
- icon = p_log->get_editor_theme_icon(SNAME("Warning"));
- color = p_log->get_theme_color(SNAME("warning_color"), EditorStringName(Editor));
- } break;
- case EditorExportPlatform::EXPORT_MESSAGE_ERROR: {
- icon = p_log->get_editor_theme_icon(SNAME("Error"));
- color = p_log->get_theme_color(SNAME("error_color"), EditorStringName(Editor));
- } break;
- default:
- break;
- }
- p_log->push_cell();
- p_log->add_text("\t");
- if (icon.is_valid()) {
- p_log->add_image(icon);
- }
- p_log->pop();
- p_log->push_cell();
- p_log->push_color(color);
- p_log->add_text(vformat("[%s]: %s", msg.category, msg.text));
- p_log->pop();
- p_log->pop();
- }
- p_log->pop();
- p_log->add_newline();
- } else if (p_err != OK) {
- // We failed but don't show any user-facing messages. This is bad and should not
- // be allowed, but just in case this happens, let's give the user something at least.
- p_log->push_table(2);
- p_log->set_table_column_expand(0, false);
- p_log->set_table_column_expand(1, true);
- {
- Color color = p_log->get_theme_color(SNAME("error_color"), EditorStringName(Editor));
- Ref<Texture> icon = p_log->get_editor_theme_icon(SNAME("Error"));
- p_log->push_cell();
- p_log->add_text("\t");
- if (icon.is_valid()) {
- p_log->add_image(icon);
- }
- p_log->pop();
- p_log->push_cell();
- p_log->push_color(color);
- p_log->add_text(vformat("[%s]: %s", TTR("Unknown Error"), vformat(TTR("Export failed with error code %d."), p_err)));
- p_log->pop();
- p_log->pop();
- }
- p_log->pop();
- p_log->add_newline();
- }
- p_log->add_newline();
- return has_messages;
- }
- bool EditorExportPlatform::_check_hash(const uint8_t *p_hash, const Vector<uint8_t> &p_data) {
- if (p_hash == nullptr) {
- return false;
- }
- unsigned char hash[16];
- Error err = CryptoCore::md5(p_data.ptr(), p_data.size(), hash);
- if (err != OK) {
- return false;
- }
- for (int i = 0; i < 16; i++) {
- if (p_hash[i] != hash[i]) {
- return false;
- }
- }
- return true;
- }
- Error EditorExportPlatform::_load_patches(const Vector<String> &p_patches) {
- Error err = OK;
- if (!p_patches.is_empty()) {
- for (const String &path : p_patches) {
- err = PackedData::get_singleton()->add_pack(path, true, 0);
- if (err != OK) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Patch Creation"), vformat(TTR("Could not load patch pack with path \"%s\"."), path));
- return err;
- }
- }
- }
- return err;
- }
- void EditorExportPlatform::_unload_patches() {
- PackedData::get_singleton()->clear();
- }
- Error EditorExportPlatform::_encrypt_and_store_data(Ref<FileAccess> p_fd, const String &p_path, const Vector<uint8_t> &p_data, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed, bool &r_encrypt) {
- r_encrypt = false;
- for (int i = 0; i < p_enc_in_filters.size(); ++i) {
- if (p_path.matchn(p_enc_in_filters[i]) || p_path.trim_prefix("res://").matchn(p_enc_in_filters[i])) {
- r_encrypt = true;
- break;
- }
- }
- for (int i = 0; i < p_enc_ex_filters.size(); ++i) {
- if (p_path.matchn(p_enc_ex_filters[i]) || p_path.trim_prefix("res://").matchn(p_enc_ex_filters[i])) {
- r_encrypt = false;
- break;
- }
- }
- Ref<FileAccessEncrypted> fae;
- Ref<FileAccess> ftmp = p_fd;
- if (r_encrypt) {
- Vector<uint8_t> iv;
- if (p_seed != 0) {
- uint64_t seed = p_seed;
- const uint8_t *ptr = p_data.ptr();
- int64_t len = p_data.size();
- for (int64_t i = 0; i < len; i++) {
- seed = ((seed << 5) + seed) ^ ptr[i];
- }
- RandomPCG rng = RandomPCG(seed);
- iv.resize(16);
- for (int i = 0; i < 16; i++) {
- iv.write[i] = rng.rand() % 256;
- }
- }
- fae.instantiate();
- ERR_FAIL_COND_V(fae.is_null(), ERR_FILE_CANT_OPEN);
- Error err = fae->open_and_parse(ftmp, p_key, FileAccessEncrypted::MODE_WRITE_AES256, false, iv);
- ERR_FAIL_COND_V(err != OK, ERR_FILE_CANT_OPEN);
- ftmp = fae;
- }
- // Store file content.
- ftmp->store_buffer(p_data.ptr(), p_data.size());
- if (fae.is_valid()) {
- ftmp.unref();
- fae.unref();
- }
- return OK;
- }
- 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) {
- ERR_FAIL_COND_V_MSG(p_total < 1, ERR_PARAMETER_RANGE_ERROR, "Must select at least one file to export.");
- PackData *pd = (PackData *)p_userdata;
- String simplified_path = p_path.simplify_path();
- if (simplified_path.begins_with("uid://")) {
- simplified_path = ResourceUID::uid_to_path(simplified_path).simplify_path();
- print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, simplified_path));
- }
- Ref<FileAccess> ftmp;
- if (pd->use_sparse_pck) {
- ftmp = FileAccess::open(pd->path.get_base_dir().path_join(simplified_path.trim_prefix("res://")), FileAccess::WRITE);
- } else {
- ftmp = pd->f;
- }
- SavedData sd;
- sd.path_utf8 = simplified_path.trim_prefix("res://").utf8();
- sd.ofs = (pd->use_sparse_pck) ? 0 : pd->f->get_position();
- sd.size = p_data.size();
- Error err = _encrypt_and_store_data(ftmp, simplified_path, p_data, p_enc_in_filters, p_enc_ex_filters, p_key, p_seed, sd.encrypted);
- if (err != OK) {
- return err;
- }
- if (!pd->use_sparse_pck) {
- ERR_FAIL_COND_V(pd->f->get_position() - sd.ofs < (uint64_t)p_data.size(), ERR_FILE_CANT_WRITE);
- }
- if (!pd->use_sparse_pck) {
- int pad = _get_pad(PCK_PADDING, pd->f->get_position());
- for (int i = 0; i < pad; i++) {
- pd->f->store_8(0);
- }
- }
- // Store MD5 of original file.
- {
- unsigned char hash[16];
- CryptoCore::md5(p_data.ptr(), p_data.size(), hash);
- sd.md5.resize(16);
- for (int i = 0; i < 16; i++) {
- sd.md5.write[i] = hash[i];
- }
- }
- pd->file_ofs.push_back(sd);
- // TRANSLATORS: This is an editor progress label describing the storing of a file.
- if (pd->ep->step(vformat(TTR("Storing File: %s"), p_path), 2 + p_file * 100 / p_total, false)) {
- return ERR_SKIP;
- }
- return OK;
- }
- 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) {
- if (_check_hash(PackedData::get_singleton()->get_file_hash(p_path), p_data)) {
- return OK;
- }
- 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);
- }
- 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) {
- ERR_FAIL_COND_V_MSG(p_total < 1, ERR_PARAMETER_RANGE_ERROR, "Must select at least one file to export.");
- String path = p_path.simplify_path();
- if (path.begins_with("uid://")) {
- path = ResourceUID::uid_to_path(path).simplify_path();
- print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, path));
- }
- path = path.replace_first("res://", "");
- ZipData *zd = (ZipData *)p_userdata;
- zipFile zip = (zipFile)zd->zip;
- zipOpenNewFileInZip(zip,
- path.utf8().get_data(),
- nullptr,
- nullptr,
- 0,
- nullptr,
- 0,
- nullptr,
- Z_DEFLATED,
- Z_DEFAULT_COMPRESSION);
- zipWriteInFileInZip(zip, p_data.ptr(), p_data.size());
- zipCloseFileInZip(zip);
- zd->file_count += 1;
- if (zd->ep->step(TTR("Storing File:") + " " + p_path, 2 + p_file * 100 / p_total, false)) {
- return ERR_SKIP;
- }
- return OK;
- }
- 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) {
- if (_check_hash(PackedData::get_singleton()->get_file_hash(p_path), p_data)) {
- return OK;
- }
- 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);
- }
- Ref<ImageTexture> EditorExportPlatform::get_option_icon(int p_index) const {
- Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
- ERR_FAIL_COND_V(theme.is_null(), Ref<ImageTexture>());
- return theme->get_icon(SNAME("Play"), EditorStringName(EditorIcons));
- }
- String EditorExportPlatform::find_export_template(const String &template_file_name, String *err) const {
- String current_version = GODOT_VERSION_FULL_CONFIG;
- String template_path = EditorPaths::get_singleton()->get_export_templates_dir().path_join(current_version).path_join(template_file_name);
- if (FileAccess::exists(template_path)) {
- return template_path;
- }
- // Not found
- if (err) {
- *err += TTR("No export template found at the expected path:") + "\n" + template_path + "\n";
- }
- return String();
- }
- bool EditorExportPlatform::exists_export_template(const String &template_file_name, String *err) const {
- return find_export_template(template_file_name, err) != "";
- }
- Ref<EditorExportPreset> EditorExportPlatform::create_preset() {
- Ref<EditorExportPreset> preset;
- preset.instantiate();
- preset->platform = Ref<EditorExportPlatform>(this);
- List<ExportOption> options;
- get_export_options(&options);
- Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
- for (int i = 0; i < export_plugins.size(); i++) {
- export_plugins.write[i]->_get_export_options(Ref<EditorExportPlatform>(this), &options);
- }
- for (const ExportOption &E : options) {
- StringName option_name = E.option.name;
- preset->properties[option_name] = E.option;
- preset->values[option_name] = E.default_value;
- preset->update_visibility[option_name] = E.update_visibility;
- }
- return preset;
- }
- void EditorExportPlatform::_export_find_resources(EditorFileSystemDirectory *p_dir, HashSet<String> &p_paths) {
- for (int i = 0; i < p_dir->get_subdir_count(); i++) {
- _export_find_resources(p_dir->get_subdir(i), p_paths);
- }
- for (int i = 0; i < p_dir->get_file_count(); i++) {
- if (p_dir->get_file_type(i) == "TextFile") {
- continue;
- }
- p_paths.insert(p_dir->get_file_path(i));
- }
- }
- void EditorExportPlatform::_export_find_customized_resources(const Ref<EditorExportPreset> &p_preset, EditorFileSystemDirectory *p_dir, EditorExportPreset::FileExportMode p_mode, HashSet<String> &p_paths) {
- for (int i = 0; i < p_dir->get_subdir_count(); i++) {
- EditorFileSystemDirectory *subdir = p_dir->get_subdir(i);
- _export_find_customized_resources(p_preset, subdir, p_preset->get_file_export_mode(subdir->get_path(), p_mode), p_paths);
- }
- for (int i = 0; i < p_dir->get_file_count(); i++) {
- if (p_dir->get_file_type(i) == "TextFile") {
- continue;
- }
- String path = p_dir->get_file_path(i);
- EditorExportPreset::FileExportMode file_mode = p_preset->get_file_export_mode(path, p_mode);
- if (file_mode != EditorExportPreset::MODE_FILE_REMOVE) {
- p_paths.insert(path);
- }
- }
- }
- void EditorExportPlatform::_export_find_dependencies(const String &p_path, HashSet<String> &p_paths) {
- if (p_paths.has(p_path)) {
- return;
- }
- p_paths.insert(p_path);
- EditorFileSystemDirectory *dir;
- int file_idx;
- dir = EditorFileSystem::get_singleton()->find_file(p_path, &file_idx);
- if (!dir) {
- return;
- }
- Vector<String> deps = dir->get_file_deps(file_idx);
- for (int i = 0; i < deps.size(); i++) {
- _export_find_dependencies(deps[i], p_paths);
- }
- }
- void EditorExportPlatform::_edit_files_with_filter(Ref<DirAccess> &da, const Vector<String> &p_filters, HashSet<String> &r_list, bool exclude) {
- da->list_dir_begin();
- String cur_dir = da->get_current_dir().replace_char('\\', '/');
- if (!cur_dir.ends_with("/")) {
- cur_dir += "/";
- }
- String cur_dir_no_prefix = cur_dir.replace("res://", "");
- Vector<String> dirs;
- String f = da->get_next();
- while (!f.is_empty()) {
- if (da->current_is_dir()) {
- dirs.push_back(f);
- } else {
- String fullpath = cur_dir + f;
- // Test also against path without res:// so that filters like `file.txt` can work.
- String fullpath_no_prefix = cur_dir_no_prefix + f;
- for (int i = 0; i < p_filters.size(); ++i) {
- if (fullpath.matchn(p_filters[i]) || fullpath_no_prefix.matchn(p_filters[i])) {
- if (!exclude) {
- r_list.insert(fullpath);
- } else {
- r_list.erase(fullpath);
- }
- }
- }
- }
- f = da->get_next();
- }
- da->list_dir_end();
- for (int i = 0; i < dirs.size(); ++i) {
- const String &dir = dirs[i];
- if (dir.begins_with(".")) {
- continue;
- }
- if (EditorFileSystem::_should_skip_directory(cur_dir + dir)) {
- continue;
- }
- da->change_dir(dir);
- _edit_files_with_filter(da, p_filters, r_list, exclude);
- da->change_dir("..");
- }
- }
- void EditorExportPlatform::_edit_filter_list(HashSet<String> &r_list, const String &p_filter, bool exclude) {
- if (p_filter.is_empty()) {
- return;
- }
- Vector<String> split = p_filter.split(",");
- Vector<String> filters;
- for (int i = 0; i < split.size(); i++) {
- String f = split[i].strip_edges();
- if (f.is_empty()) {
- continue;
- }
- filters.push_back(f);
- }
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- ERR_FAIL_COND(da.is_null());
- _edit_files_with_filter(da, filters, r_list, exclude);
- }
- HashSet<String> EditorExportPlatform::get_features(const Ref<EditorExportPreset> &p_preset, bool p_debug) const {
- Ref<EditorExportPlatform> platform = p_preset->get_platform();
- List<String> feature_list;
- platform->get_platform_features(&feature_list);
- platform->get_preset_features(p_preset, &feature_list);
- HashSet<String> result;
- for (const String &E : feature_list) {
- result.insert(E);
- }
- result.insert("template");
- if (p_debug) {
- result.insert("debug");
- result.insert("template_debug");
- } else {
- result.insert("release");
- result.insert("template_release");
- }
- #ifdef REAL_T_IS_DOUBLE
- result.insert("double");
- #else
- result.insert("single");
- #endif // REAL_T_IS_DOUBLE
- if (!p_preset->get_custom_features().is_empty()) {
- Vector<String> tmp_custom_list = p_preset->get_custom_features().split(",");
- for (int i = 0; i < tmp_custom_list.size(); i++) {
- String f = tmp_custom_list[i].strip_edges();
- if (!f.is_empty()) {
- result.insert(f);
- }
- }
- }
- return result;
- }
- EditorExportPlatform::ExportNotifier::ExportNotifier(EditorExportPlatform &p_platform, const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
- HashSet<String> features = p_platform.get_features(p_preset, p_debug);
- Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
- //initial export plugin callback
- for (int i = 0; i < export_plugins.size(); i++) {
- export_plugins.write[i]->set_export_preset(p_preset);
- if (GDVIRTUAL_IS_OVERRIDDEN_PTR(export_plugins[i], _export_begin)) {
- PackedStringArray features_psa;
- for (const String &feature : features) {
- features_psa.push_back(feature);
- }
- export_plugins.write[i]->_export_begin_script(features_psa, p_debug, p_path, p_flags);
- } else {
- export_plugins.write[i]->_export_begin(features, p_debug, p_path, p_flags);
- }
- }
- }
- EditorExportPlatform::ExportNotifier::~ExportNotifier() {
- Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
- for (int i = 0; i < export_plugins.size(); i++) {
- if (GDVIRTUAL_IS_OVERRIDDEN_PTR(export_plugins[i], _export_end)) {
- export_plugins.write[i]->_export_end_script();
- } else {
- export_plugins.write[i]->_export_end();
- }
- export_plugins.write[i]->_export_end_clear();
- export_plugins.write[i]->set_export_preset(Ref<EditorExportPlugin>());
- }
- }
- bool EditorExportPlatform::_export_customize_dictionary(Dictionary &dict, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
- bool changed = false;
- for (const Variant &K : dict.get_key_list()) {
- Variant v = dict[K];
- switch (v.get_type()) {
- case Variant::OBJECT: {
- Ref<Resource> res = v;
- if (res.is_valid()) {
- for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
- Ref<Resource> new_res = plugin->_customize_resource(res, "");
- if (new_res.is_valid()) {
- changed = true;
- if (new_res != res) {
- dict[K] = new_res;
- res = new_res;
- }
- break;
- }
- }
- // If it was not replaced, go through and see if there is something to replace.
- if (res.is_valid() && !res->get_path().is_resource_file() && _export_customize_object(res.ptr(), customize_resources_plugins), true) {
- changed = true;
- }
- }
- } break;
- case Variant::DICTIONARY: {
- Dictionary d = v;
- if (_export_customize_dictionary(d, customize_resources_plugins)) {
- changed = true;
- }
- } break;
- case Variant::ARRAY: {
- Array a = v;
- if (_export_customize_array(a, customize_resources_plugins)) {
- changed = true;
- }
- } break;
- default: {
- }
- }
- }
- return changed;
- }
- bool EditorExportPlatform::_export_customize_array(Array &arr, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
- bool changed = false;
- for (int i = 0; i < arr.size(); i++) {
- Variant v = arr.get(i);
- switch (v.get_type()) {
- case Variant::OBJECT: {
- Ref<Resource> res = v;
- if (res.is_valid()) {
- for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
- Ref<Resource> new_res = plugin->_customize_resource(res, "");
- if (new_res.is_valid()) {
- changed = true;
- if (new_res != res) {
- arr.set(i, new_res);
- res = new_res;
- }
- break;
- }
- }
- // If it was not replaced, go through and see if there is something to replace.
- if (res.is_valid() && !res->get_path().is_resource_file() && _export_customize_object(res.ptr(), customize_resources_plugins), true) {
- changed = true;
- }
- }
- } break;
- case Variant::DICTIONARY: {
- Dictionary d = v;
- if (_export_customize_dictionary(d, customize_resources_plugins)) {
- changed = true;
- }
- } break;
- case Variant::ARRAY: {
- Array a = v;
- if (_export_customize_array(a, customize_resources_plugins)) {
- changed = true;
- }
- } break;
- default: {
- }
- }
- }
- return changed;
- }
- bool EditorExportPlatform::_export_customize_object(Object *p_object, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
- bool changed = false;
- List<PropertyInfo> props;
- p_object->get_property_list(&props);
- for (const PropertyInfo &E : props) {
- switch (E.type) {
- case Variant::OBJECT: {
- Ref<Resource> res = p_object->get(E.name);
- if (res.is_valid()) {
- for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
- Ref<Resource> new_res = plugin->_customize_resource(res, "");
- if (new_res.is_valid()) {
- changed = true;
- if (new_res != res) {
- p_object->set(E.name, new_res);
- res = new_res;
- }
- break;
- }
- }
- // If it was not replaced, go through and see if there is something to replace.
- if (res.is_valid() && !res->get_path().is_resource_file() && _export_customize_object(res.ptr(), customize_resources_plugins), true) {
- changed = true;
- }
- }
- } break;
- case Variant::DICTIONARY: {
- Dictionary d = p_object->get(E.name);
- if (_export_customize_dictionary(d, customize_resources_plugins)) {
- // May have been generated, so set back just in case
- p_object->set(E.name, d);
- changed = true;
- }
- } break;
- case Variant::ARRAY: {
- Array a = p_object->get(E.name);
- if (_export_customize_array(a, customize_resources_plugins)) {
- // May have been generated, so set back just in case
- p_object->set(E.name, a);
- changed = true;
- }
- } break;
- default: {
- }
- }
- }
- return changed;
- }
- bool EditorExportPlatform::_is_editable_ancestor(Node *p_root, Node *p_node) {
- while (p_node != nullptr && p_node != p_root) {
- if (p_root->is_editable_instance(p_node)) {
- return true;
- }
- p_node = p_node->get_owner();
- }
- return false;
- }
- bool EditorExportPlatform::_export_customize_scene_resources(Node *p_root, Node *p_node, LocalVector<Ref<EditorExportPlugin>> &customize_resources_plugins) {
- bool changed = false;
- if (p_root == p_node || p_node->get_owner() == p_root || _is_editable_ancestor(p_root, p_node)) {
- if (_export_customize_object(p_node, customize_resources_plugins)) {
- changed = true;
- }
- }
- for (int i = 0; i < p_node->get_child_count(); i++) {
- if (_export_customize_scene_resources(p_root, p_node->get_child(i), customize_resources_plugins)) {
- changed = true;
- }
- }
- return changed;
- }
- 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) {
- if (!p_force_save && customize_resources_plugins.is_empty() && customize_scenes_plugins.is_empty()) {
- return p_path; // do none
- }
- // Check if a cache exists
- if (export_cache.has(p_path)) {
- FileExportCache &fec = export_cache[p_path];
- if (fec.saved_path.is_empty() || FileAccess::exists(fec.saved_path)) {
- // Destination file exists (was not erased) or not needed
- uint64_t mod_time = FileAccess::get_modified_time(p_path);
- if (fec.source_modified_time == mod_time) {
- // Cached (modified time matches).
- fec.used = true;
- return fec.saved_path.is_empty() ? p_path : fec.saved_path;
- }
- String md5 = FileAccess::get_md5(p_path);
- if (FileAccess::exists(p_path + ".import")) {
- // Also consider the import file in the string
- md5 += FileAccess::get_md5(p_path + ".import");
- }
- if (fec.source_md5 == md5) {
- // Cached (md5 matches).
- fec.source_modified_time = mod_time;
- fec.used = true;
- return fec.saved_path.is_empty() ? p_path : fec.saved_path;
- }
- }
- }
- FileExportCache fec;
- fec.used = true;
- fec.source_modified_time = FileAccess::get_modified_time(p_path);
- String md5 = FileAccess::get_md5(p_path);
- if (FileAccess::exists(p_path + ".import")) {
- // Also consider the import file in the string
- md5 += FileAccess::get_md5(p_path + ".import");
- }
- fec.source_md5 = md5;
- // Check if it should convert
- String type = ResourceLoader::get_resource_type(p_path);
- bool modified = false;
- String save_path;
- if (type == "PackedScene") { // Its a scene.
- Ref<PackedScene> ps = ResourceLoader::load(p_path, "PackedScene", ResourceFormatLoader::CACHE_MODE_IGNORE);
- ERR_FAIL_COND_V(ps.is_null(), p_path);
- Node *node = ps->instantiate(PackedScene::GEN_EDIT_STATE_INSTANCE); // Make sure the child scene root gets the correct inheritance chain.
- ERR_FAIL_NULL_V(node, p_path);
- if (!customize_scenes_plugins.is_empty()) {
- for (Ref<EditorExportPlugin> &plugin : customize_scenes_plugins) {
- Node *customized = plugin->_customize_scene(node, p_path);
- if (customized != nullptr) {
- node = customized;
- modified = true;
- }
- }
- }
- if (!customize_resources_plugins.is_empty()) {
- if (_export_customize_scene_resources(node, node, customize_resources_plugins)) {
- modified = true;
- }
- }
- if (modified || p_force_save) {
- // If modified, save it again. This is also used for TSCN -> SCN conversion on export.
- 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).
- save_path = export_base_path.path_join("export-" + p_path.md5_text() + "-" + base_file);
- Ref<PackedScene> s;
- s.instantiate();
- s->pack(node);
- Error err = ResourceSaver::save(s, save_path);
- ERR_FAIL_COND_V_MSG(err != OK, p_path, "Unable to save export scene file to: " + save_path);
- }
- node->queue_free();
- } else {
- Ref<Resource> res = ResourceLoader::load(p_path, "", ResourceFormatLoader::CACHE_MODE_IGNORE);
- ERR_FAIL_COND_V(res.is_null(), p_path);
- if (!customize_resources_plugins.is_empty()) {
- for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
- Ref<Resource> new_res = plugin->_customize_resource(res, p_path);
- if (new_res.is_valid()) {
- modified = true;
- if (new_res != res) {
- res = new_res;
- }
- break;
- }
- }
- if (_export_customize_object(res.ptr(), customize_resources_plugins)) {
- modified = true;
- }
- }
- if (modified || p_force_save) {
- // If modified, save it again. This is also used for TRES -> RES conversion on export.
- String base_file = p_path.get_file().get_basename() + ".res"; // use RES for saving (binary)
- save_path = export_base_path.path_join("export-" + p_path.md5_text() + "-" + base_file);
- Error err = ResourceSaver::save(res, save_path);
- ERR_FAIL_COND_V_MSG(err != OK, p_path, "Unable to save export resource file to: " + save_path);
- }
- }
- fec.saved_path = save_path;
- export_cache[p_path] = fec;
- return save_path.is_empty() ? p_path : save_path;
- }
- String EditorExportPlatform::_get_script_encryption_key(const Ref<EditorExportPreset> &p_preset) const {
- const String from_env = OS::get_singleton()->get_environment(ENV_SCRIPT_ENCRYPTION_KEY);
- if (!from_env.is_empty()) {
- return from_env.to_lower();
- }
- return p_preset->get_script_encryption_key().to_lower();
- }
- Dictionary EditorExportPlatform::get_internal_export_files(const Ref<EditorExportPreset> &p_preset, bool p_debug) {
- Dictionary files;
- // Text server support data.
- if (TS->has_feature(TextServer::FEATURE_USE_SUPPORT_DATA) && (bool)get_project_setting(p_preset, "internationalization/locale/include_text_server_data")) {
- String ts_name = TS->get_support_data_filename();
- String ts_target = "res://" + ts_name;
- if (!ts_name.is_empty()) {
- bool export_ok = false;
- if (FileAccess::exists(ts_target)) { // Include user supplied data file.
- const PackedByteArray &ts_data = FileAccess::get_file_as_bytes(ts_target);
- if (!ts_data.is_empty()) {
- 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!"));
- files[ts_target] = ts_data;
- export_ok = true;
- }
- } else {
- String current_version = GODOT_VERSION_FULL_CONFIG;
- String template_path = EditorPaths::get_singleton()->get_export_templates_dir().path_join(current_version);
- if (p_debug && p_preset->has("custom_template/debug") && p_preset->get("custom_template/debug") != "") {
- template_path = p_preset->get("custom_template/debug").operator String().get_base_dir();
- } else if (!p_debug && p_preset->has("custom_template/release") && p_preset->get("custom_template/release") != "") {
- template_path = p_preset->get("custom_template/release").operator String().get_base_dir();
- }
- String data_file_name = template_path.path_join(ts_name);
- if (FileAccess::exists(data_file_name)) {
- const PackedByteArray &ts_data = FileAccess::get_file_as_bytes(data_file_name);
- if (!ts_data.is_empty()) {
- print_line("Using text server data from export templates.");
- files[ts_target] = ts_data;
- export_ok = true;
- }
- } else {
- const PackedByteArray &ts_data = TS->get_support_data();
- if (!ts_data.is_empty()) {
- 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!"));
- files[ts_target] = ts_data;
- export_ok = true;
- }
- }
- }
- if (!export_ok) {
- add_message(EXPORT_MESSAGE_WARNING, TTR("Export"), TTR("Missing text server data, text display in the exported project might be broken!"));
- }
- }
- }
- return files;
- }
- Vector<String> EditorExportPlatform::get_forced_export_files(const Ref<EditorExportPreset> &p_preset) {
- Vector<String> files;
- files.push_back(ProjectSettings::get_singleton()->get_global_class_list_path());
- String icon = ResourceUID::ensure_path(get_project_setting(p_preset, "application/config/icon"));
- String splash = ResourceUID::ensure_path(get_project_setting(p_preset, "application/boot_splash/image"));
- if (!icon.is_empty() && FileAccess::exists(icon)) {
- files.push_back(icon);
- }
- if (!splash.is_empty() && FileAccess::exists(splash) && icon != splash) {
- files.push_back(splash);
- }
- String resource_cache_file = ResourceUID::get_cache_file();
- if (FileAccess::exists(resource_cache_file)) {
- files.push_back(resource_cache_file);
- }
- String extension_list_config_file = GDExtension::get_extension_list_config_file();
- if (FileAccess::exists(extension_list_config_file)) {
- files.push_back(extension_list_config_file);
- }
- return files;
- }
- 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) {
- Callable cb = ((ScriptCallbackData *)p_userdata)->file_cb;
- ERR_FAIL_COND_V(!cb.is_valid(), FAILED);
- String simplified_path = p_path.simplify_path();
- if (simplified_path.begins_with("uid://")) {
- simplified_path = ResourceUID::uid_to_path(simplified_path).simplify_path();
- print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, simplified_path));
- }
- Variant path = simplified_path;
- Variant data = p_data;
- Variant file = p_file;
- Variant total = p_total;
- Variant enc_in = p_enc_in_filters;
- Variant enc_ex = p_enc_ex_filters;
- Variant enc_key = p_key;
- Variant ret;
- Callable::CallError ce;
- const Variant *args[7] = { &path, &data, &file, &total, &enc_in, &enc_ex, &enc_key };
- cb.callp(args, 7, ret, ce);
- 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)));
- return (Error)ret.operator int();
- }
- Error EditorExportPlatform::_script_add_shared_object(void *p_userdata, const SharedObject &p_so) {
- Callable cb = ((ScriptCallbackData *)p_userdata)->so_cb;
- if (!cb.is_valid()) {
- return OK; // Optional.
- }
- Variant path = p_so.path;
- Variant tags = p_so.tags;
- Variant target = p_so.target;
- Variant ret;
- Callable::CallError ce;
- const Variant *args[3] = { &path, &tags, &target };
- cb.callp(args, 3, ret, ce);
- 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)));
- return (Error)ret.operator int();
- }
- Error EditorExportPlatform::_export_project_files(const Ref<EditorExportPreset> &p_preset, bool p_debug, const Callable &p_save_func, const Callable &p_so_func) {
- ScriptCallbackData data;
- data.file_cb = p_save_func;
- data.so_cb = p_so_func;
- return export_project_files(p_preset, p_debug, _script_save_file, nullptr, &data, _script_add_shared_object);
- }
- 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) {
- //figure out paths of files that will be exported
- HashSet<String> paths;
- Vector<String> path_remaps;
- if (p_preset->get_export_filter() == EditorExportPreset::EXPORT_ALL_RESOURCES) {
- //find stuff
- _export_find_resources(EditorFileSystem::get_singleton()->get_filesystem(), paths);
- } else if (p_preset->get_export_filter() == EditorExportPreset::EXCLUDE_SELECTED_RESOURCES) {
- _export_find_resources(EditorFileSystem::get_singleton()->get_filesystem(), paths);
- Vector<String> files = p_preset->get_files_to_export();
- for (int i = 0; i < files.size(); i++) {
- paths.erase(files[i]);
- }
- } else if (p_preset->get_export_filter() == EditorExportPreset::EXPORT_CUSTOMIZED) {
- _export_find_customized_resources(p_preset, EditorFileSystem::get_singleton()->get_filesystem(), p_preset->get_file_export_mode("res://"), paths);
- } else {
- bool scenes_only = p_preset->get_export_filter() == EditorExportPreset::EXPORT_SELECTED_SCENES;
- Vector<String> files = p_preset->get_files_to_export();
- for (int i = 0; i < files.size(); i++) {
- if (scenes_only && ResourceLoader::get_resource_type(files[i]) != "PackedScene") {
- continue;
- }
- _export_find_dependencies(files[i], paths);
- }
- // Add autoload resources and their dependencies
- List<PropertyInfo> props;
- ProjectSettings::get_singleton()->get_property_list(&props);
- for (const PropertyInfo &pi : props) {
- if (!pi.name.begins_with("autoload/")) {
- continue;
- }
- String autoload_path = get_project_setting(p_preset, pi.name);
- if (autoload_path.begins_with("*")) {
- autoload_path = autoload_path.substr(1);
- }
- _export_find_dependencies(autoload_path, paths);
- }
- }
- //add native icons to non-resource include list
- _edit_filter_list(paths, String("*.icns"), false);
- _edit_filter_list(paths, String("*.ico"), false);
- _edit_filter_list(paths, p_preset->get_include_filter(), false);
- _edit_filter_list(paths, p_preset->get_exclude_filter(), true);
- // Ignore import files, since these are automatically added to the jar later with the resources
- _edit_filter_list(paths, String("*.import"), true);
- // Get encryption filters.
- bool enc_pck = p_preset->get_enc_pck();
- Vector<String> enc_in_filters;
- Vector<String> enc_ex_filters;
- Vector<uint8_t> key;
- uint64_t seed = 0;
- if (enc_pck) {
- seed = p_preset->get_seed();
- Vector<String> enc_in_split = p_preset->get_enc_in_filter().split(",");
- for (int i = 0; i < enc_in_split.size(); i++) {
- String f = enc_in_split[i].strip_edges();
- if (f.is_empty()) {
- continue;
- }
- enc_in_filters.push_back(f);
- }
- Vector<String> enc_ex_split = p_preset->get_enc_ex_filter().split(",");
- for (int i = 0; i < enc_ex_split.size(); i++) {
- String f = enc_ex_split[i].strip_edges();
- if (f.is_empty()) {
- continue;
- }
- enc_ex_filters.push_back(f);
- }
- // Get encryption key.
- String script_key = _get_script_encryption_key(p_preset);
- key.resize(32);
- if (script_key.length() == 64) {
- for (int i = 0; i < 32; i++) {
- int v = 0;
- if (i * 2 < script_key.length()) {
- char32_t ct = script_key[i * 2];
- if (is_digit(ct)) {
- ct = ct - '0';
- } else if (ct >= 'a' && ct <= 'f') {
- ct = 10 + ct - 'a';
- }
- v |= ct << 4;
- }
- if (i * 2 + 1 < script_key.length()) {
- char32_t ct = script_key[i * 2 + 1];
- if (is_digit(ct)) {
- ct = ct - '0';
- } else if (ct >= 'a' && ct <= 'f') {
- ct = 10 + ct - 'a';
- }
- v |= ct;
- }
- key.write[i] = v;
- }
- }
- }
- EditorExportSaveProxy save_proxy(p_save_func, p_remove_func != nullptr);
- Error err = OK;
- Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
- struct SortByName {
- bool operator()(const Ref<EditorExportPlugin> &left, const Ref<EditorExportPlugin> &right) const {
- return left->get_name() < right->get_name();
- }
- };
- auto add_shared_objects_and_extra_files_from_export_plugins = [&]() {
- for (int i = 0; i < export_plugins.size(); i++) {
- if (p_so_func) {
- for (int j = 0; j < export_plugins[i]->shared_objects.size(); j++) {
- err = p_so_func(p_udata, export_plugins[i]->shared_objects[j]);
- if (err != OK) {
- return err;
- }
- }
- }
- for (int j = 0; j < export_plugins[i]->extra_files.size(); j++) {
- 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);
- if (err != OK) {
- return err;
- }
- }
- export_plugins.write[i]->_clear();
- }
- return OK;
- };
- // Always sort by name, to so if for some reason they are re-arranged, it still works.
- export_plugins.sort_custom<SortByName>();
- HashSet<String> features = get_features(p_preset, p_debug);
- PackedStringArray features_psa;
- for (const String &feature : features) {
- features_psa.push_back(feature);
- }
- // Check if custom processing is needed
- uint32_t custom_resources_hash = HASH_MURMUR3_SEED;
- uint32_t custom_scene_hash = HASH_MURMUR3_SEED;
- LocalVector<Ref<EditorExportPlugin>> customize_resources_plugins;
- LocalVector<Ref<EditorExportPlugin>> customize_scenes_plugins;
- for (int i = 0; i < export_plugins.size(); i++) {
- if (export_plugins.write[i]->_begin_customize_resources(Ref<EditorExportPlatform>(this), features_psa)) {
- customize_resources_plugins.push_back(export_plugins[i]);
- custom_resources_hash = hash_murmur3_one_64(export_plugins[i]->get_name().hash64(), custom_resources_hash);
- uint64_t hash = export_plugins[i]->_get_customization_configuration_hash();
- custom_resources_hash = hash_murmur3_one_64(hash, custom_resources_hash);
- }
- if (export_plugins.write[i]->_begin_customize_scenes(Ref<EditorExportPlatform>(this), features_psa)) {
- customize_scenes_plugins.push_back(export_plugins[i]);
- custom_resources_hash = hash_murmur3_one_64(export_plugins[i]->get_name().hash64(), custom_resources_hash);
- uint64_t hash = export_plugins[i]->_get_customization_configuration_hash();
- custom_scene_hash = hash_murmur3_one_64(hash, custom_scene_hash);
- }
- }
- // Add any files that might've been defined during the initial steps of the export plugins.
- err = add_shared_objects_and_extra_files_from_export_plugins();
- if (err != OK) {
- return err;
- }
- HashMap<String, FileExportCache> export_cache;
- String export_base_path = ProjectSettings::get_singleton()->get_project_data_path().path_join("exported/") + itos(custom_resources_hash);
- bool convert_text_to_binary = get_project_setting(p_preset, "editor/export/convert_text_resources_to_binary");
- if (convert_text_to_binary || !customize_resources_plugins.is_empty() || !customize_scenes_plugins.is_empty()) {
- // See if we have something to open
- Ref<FileAccess> f = FileAccess::open(export_base_path.path_join("file_cache"), FileAccess::READ);
- if (f.is_valid()) {
- String l = f->get_line();
- while (l != String()) {
- Vector<String> fields = l.split("::");
- if (fields.size() == 4) {
- FileExportCache fec;
- const String &path = fields[0];
- fec.source_md5 = fields[1].strip_edges();
- fec.source_modified_time = fields[2].strip_edges().to_int();
- fec.saved_path = fields[3];
- fec.used = false; // Assume unused until used.
- export_cache[path] = fec;
- }
- l = f->get_line();
- }
- } else {
- // create the path
- Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
- d->change_dir(ProjectSettings::get_singleton()->get_project_data_path());
- d->make_dir_recursive("exported/" + itos(custom_resources_hash));
- }
- }
- for (int i = 0; i < export_plugins.size(); i++) {
- export_plugins.write[i]->set_export_base_path(export_base_path);
- }
- //store everything in the export medium
- int total = paths.size();
- // idx is incremented at the beginning of the paths loop to easily allow
- // for continue statements without accidentally skipping an increment.
- int idx = total > 0 ? -1 : 0;
- for (const String &E : paths) {
- idx++;
- String path = E;
- String type = ResourceLoader::get_resource_type(path);
- bool has_import_file = FileAccess::exists(path + ".import");
- Ref<ConfigFile> config;
- if (has_import_file) {
- config.instantiate();
- err = config->load(path + ".import");
- if (err != OK) {
- ERR_PRINT("Could not parse: '" + path + "', not exported.");
- continue;
- }
- String importer_type = config->get_value("remap", "importer");
- if (importer_type == "skip") {
- // Skip file.
- continue;
- }
- }
- bool do_export = true;
- for (int i = 0; i < export_plugins.size(); i++) {
- if (GDVIRTUAL_IS_OVERRIDDEN_PTR(export_plugins[i], _export_file)) {
- export_plugins.write[i]->_export_file_script(path, type, features_psa);
- } else {
- export_plugins.write[i]->_export_file(path, type, features);
- }
- if (p_so_func) {
- for (int j = 0; j < export_plugins[i]->shared_objects.size(); j++) {
- err = p_so_func(p_udata, export_plugins[i]->shared_objects[j]);
- if (err != OK) {
- return err;
- }
- }
- }
- for (int j = 0; j < export_plugins[i]->extra_files.size(); j++) {
- 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);
- if (err != OK) {
- return err;
- }
- if (export_plugins[i]->extra_files[j].remap) {
- do_export = false; // If remap, do not.
- path_remaps.push_back(path);
- path_remaps.push_back(export_plugins[i]->extra_files[j].path);
- }
- }
- if (export_plugins[i]->skipped) {
- do_export = false;
- }
- export_plugins.write[i]->_clear();
- if (!do_export) {
- break;
- }
- }
- if (!do_export) {
- continue;
- }
- if (has_import_file) {
- String importer_type = config->get_value("remap", "importer");
- if (importer_type == "keep") {
- // Just keep file as-is.
- Vector<uint8_t> array = FileAccess::get_file_as_bytes(path);
- err = save_proxy.save_file(p_udata, path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- continue;
- }
- // Before doing this, try to see if it can be customized.
- String export_path = _export_customize(path, customize_resources_plugins, customize_scenes_plugins, export_cache, export_base_path, false);
- if (export_path != path) {
- // It was actually customized.
- // Since the original file is likely not recognized, just use the import system.
- config->set_value("remap", "type", ResourceLoader::get_resource_type(export_path));
- // Erase all Paths.
- Vector<String> keys = config->get_section_keys("remap");
- for (const String &K : keys) {
- if (K.begins_with("path")) {
- config->erase_section_key("remap", K);
- }
- }
- // Set actual converted path.
- config->set_value("remap", "path", export_path);
- // Erase useless sections.
- if (config->has_section("deps")) {
- config->erase_section("deps");
- }
- if (config->has_section("params")) {
- config->erase_section("params");
- }
- String import_text = config->encode_to_text();
- CharString cs = import_text.utf8();
- Vector<uint8_t> sarr;
- sarr.resize(cs.size());
- memcpy(sarr.ptrw(), cs.ptr(), sarr.size());
- err = save_proxy.save_file(p_udata, path + ".import", sarr, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- // Now actual remapped file:
- sarr = FileAccess::get_file_as_bytes(export_path);
- err = save_proxy.save_file(p_udata, export_path, sarr, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- } else {
- // File is imported and not customized, replace by what it imports.
- Vector<String> remaps = config->get_section_keys("remap");
- HashSet<String> remap_features;
- for (const String &F : remaps) {
- String remap = F;
- String feature = remap.get_slicec('.', 1);
- if (features.has(feature)) {
- remap_features.insert(feature);
- }
- }
- if (remap_features.size() > 1) {
- resolve_platform_feature_priorities(p_preset, remap_features);
- }
- err = OK;
- for (const String &F : remaps) {
- String remap = F;
- if (remap == "path") {
- String remapped_path = config->get_value("remap", remap);
- Vector<uint8_t> array = FileAccess::get_file_as_bytes(remapped_path);
- err = save_proxy.save_file(p_udata, remapped_path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- } else if (remap.begins_with("path.")) {
- String feature = remap.get_slicec('.', 1);
- if (remap_features.has(feature)) {
- String remapped_path = config->get_value("remap", remap);
- Vector<uint8_t> array = FileAccess::get_file_as_bytes(remapped_path);
- err = save_proxy.save_file(p_udata, remapped_path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- } else {
- // Remove paths if feature not enabled.
- config->erase_section_key("remap", remap);
- }
- }
- }
- if (err != OK) {
- return err;
- }
- // Erase useless sections.
- if (config->has_section("deps")) {
- config->erase_section("deps");
- }
- if (config->has_section("params")) {
- config->erase_section("params");
- }
- String import_text = config->encode_to_text();
- CharString cs = import_text.utf8();
- Vector<uint8_t> sarr;
- sarr.resize(cs.size());
- memcpy(sarr.ptrw(), cs.ptr(), sarr.size());
- err = save_proxy.save_file(p_udata, path + ".import", sarr, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- }
- } else {
- // Just store it as it comes.
- // Customization only happens if plugins did not take care of it before.
- bool force_binary = convert_text_to_binary && (path.get_extension().to_lower() == "tres" || path.get_extension().to_lower() == "tscn");
- String export_path = _export_customize(path, customize_resources_plugins, customize_scenes_plugins, export_cache, export_base_path, force_binary);
- if (export_path != path) {
- // Add a remap entry.
- path_remaps.push_back(path);
- path_remaps.push_back(export_path);
- }
- Vector<uint8_t> array = FileAccess::get_file_as_bytes(export_path);
- err = save_proxy.save_file(p_udata, export_path, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- }
- }
- if (convert_text_to_binary || !customize_resources_plugins.is_empty() || !customize_scenes_plugins.is_empty()) {
- // End scene customization
- String fcache = export_base_path.path_join("file_cache");
- Ref<FileAccess> f = FileAccess::open(fcache, FileAccess::WRITE);
- if (f.is_valid()) {
- for (const KeyValue<String, FileExportCache> &E : export_cache) {
- if (E.value.used) { // May be old, unused
- String l = E.key + "::" + E.value.source_md5 + "::" + itos(E.value.source_modified_time) + "::" + E.value.saved_path;
- f->store_line(l);
- }
- }
- } else {
- ERR_PRINT("Error opening export file cache: " + fcache);
- }
- for (Ref<EditorExportPlugin> &plugin : customize_resources_plugins) {
- plugin->_end_customize_resources();
- }
- for (Ref<EditorExportPlugin> &plugin : customize_scenes_plugins) {
- plugin->_end_customize_scenes();
- }
- }
- // Add any files that might've been defined during the final steps of the export plugins.
- err = add_shared_objects_and_extra_files_from_export_plugins();
- if (err != OK) {
- return err;
- }
- //save config!
- Vector<String> custom_list;
- if (!p_preset->get_custom_features().is_empty()) {
- Vector<String> tmp_custom_list = p_preset->get_custom_features().split(",");
- for (int i = 0; i < tmp_custom_list.size(); i++) {
- String f = tmp_custom_list[i].strip_edges();
- if (!f.is_empty()) {
- custom_list.push_back(f);
- }
- }
- }
- for (int i = 0; i < export_plugins.size(); i++) {
- custom_list.append_array(export_plugins[i]->_get_export_features(Ref<EditorExportPlatform>(this), p_debug));
- }
- if (path_remaps.size()) {
- for (int i = 0; i < path_remaps.size(); i += 2) {
- const String &from = path_remaps[i];
- const String &to = path_remaps[i + 1];
- String remap_file = "[remap]\n\npath=\"" + to.c_escape() + "\"\n";
- CharString utf8 = remap_file.utf8();
- Vector<uint8_t> new_file;
- new_file.resize(utf8.length());
- for (int j = 0; j < utf8.length(); j++) {
- new_file.write[j] = utf8[j];
- }
- err = save_proxy.save_file(p_udata, from + ".remap", new_file, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- }
- }
- Vector<String> forced_export = get_forced_export_files(p_preset);
- for (int i = 0; i < forced_export.size(); i++) {
- Vector<uint8_t> array;
- if (GDExtension::get_extension_list_config_file() == forced_export[i]) {
- array = _filter_extension_list_config_file(forced_export[i], paths);
- if (array.is_empty()) {
- continue;
- }
- } else {
- array = FileAccess::get_file_as_bytes(forced_export[i]);
- }
- err = save_proxy.save_file(p_udata, forced_export[i], array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- }
- Dictionary int_export = get_internal_export_files(p_preset, p_debug);
- for (const KeyValue<Variant, Variant> &int_export_kv : int_export) {
- const PackedByteArray &array = int_export_kv.value;
- err = save_proxy.save_file(p_udata, int_export_kv.key, array, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- }
- String config_file = "project.binary";
- String engine_cfb = EditorPaths::get_singleton()->get_temp_dir().path_join("tmp" + config_file);
- ProjectSettings::CustomMap custom_map = get_custom_project_settings(p_preset);
- ProjectSettings::get_singleton()->save_custom(engine_cfb, custom_map, custom_list);
- Vector<uint8_t> data = FileAccess::get_file_as_bytes(engine_cfb);
- DirAccess::remove_file_or_error(engine_cfb);
- err = save_proxy.save_file(p_udata, "res://" + config_file, data, idx, total, enc_in_filters, enc_ex_filters, key, seed);
- if (err != OK) {
- return err;
- }
- if (p_remove_func) {
- HashSet<String> currently_loaded_paths = PackedData::get_singleton()->get_file_paths();
- for (const String &path : currently_loaded_paths) {
- if (!save_proxy.has_saved(path)) {
- err = p_remove_func(p_udata, path);
- if (err != OK) {
- return err;
- }
- }
- }
- }
- return OK;
- }
- Vector<uint8_t> EditorExportPlatform::_filter_extension_list_config_file(const String &p_config_path, const HashSet<String> &p_paths) {
- Ref<FileAccess> f = FileAccess::open(p_config_path, FileAccess::READ);
- if (f.is_null()) {
- ERR_FAIL_V_MSG(Vector<uint8_t>(), "Can't open file from path '" + String(p_config_path) + "'.");
- }
- Vector<uint8_t> data;
- while (!f->eof_reached()) {
- String l = f->get_line().strip_edges();
- if (p_paths.has(l)) {
- data.append_array(l.to_utf8_buffer());
- data.append('\n');
- }
- }
- return data;
- }
- Error EditorExportPlatform::_pack_add_shared_object(void *p_userdata, const SharedObject &p_so) {
- PackData *pack_data = (PackData *)p_userdata;
- if (pack_data->so_files) {
- pack_data->so_files->push_back(p_so);
- }
- return OK;
- }
- Error EditorExportPlatform::_remove_pack_file(void *p_userdata, const String &p_path) {
- PackData *pd = (PackData *)p_userdata;
- SavedData sd;
- sd.path_utf8 = p_path.utf8();
- sd.ofs = pd->f->get_position();
- sd.size = 0;
- sd.removal = true;
- // This padding will likely never be added, as we should already be aligned when removals are added.
- int pad = _get_pad(PCK_PADDING, pd->f->get_position());
- for (int i = 0; i < pad; i++) {
- pd->f->store_8(0);
- }
- sd.md5.resize_initialized(16);
- pd->file_ofs.push_back(sd);
- return OK;
- }
- Error EditorExportPlatform::_zip_add_shared_object(void *p_userdata, const SharedObject &p_so) {
- ZipData *zip_data = (ZipData *)p_userdata;
- if (zip_data->so_files) {
- zip_data->so_files->push_back(p_so);
- }
- return OK;
- }
- void EditorExportPlatform::zip_folder_recursive(zipFile &p_zip, const String &p_root_path, const String &p_folder, const String &p_pkg_name) {
- String dir = p_folder.is_empty() ? p_root_path : p_root_path.path_join(p_folder);
- Ref<DirAccess> da = DirAccess::open(dir);
- ERR_FAIL_COND(da.is_null());
- da->list_dir_begin();
- String f = da->get_next();
- while (!f.is_empty()) {
- if (f == "." || f == "..") {
- f = da->get_next();
- continue;
- }
- if (da->is_link(f)) {
- OS::DateTime dt = OS::get_singleton()->get_datetime();
- zip_fileinfo zipfi;
- zipfi.tmz_date.tm_year = dt.year;
- 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/
- zipfi.tmz_date.tm_mday = dt.day;
- zipfi.tmz_date.tm_hour = dt.hour;
- zipfi.tmz_date.tm_min = dt.minute;
- zipfi.tmz_date.tm_sec = dt.second;
- zipfi.dosDate = 0;
- // 0120000: symbolic link type
- // 0000755: permissions rwxr-xr-x
- // 0000644: permissions rw-r--r--
- uint32_t _mode = 0120644;
- zipfi.external_fa = (_mode << 16L) | !(_mode & 0200);
- zipfi.internal_fa = 0;
- zipOpenNewFileInZip4(p_zip,
- p_folder.path_join(f).utf8().get_data(),
- &zipfi,
- nullptr,
- 0,
- nullptr,
- 0,
- nullptr,
- Z_DEFLATED,
- Z_DEFAULT_COMPRESSION,
- 0,
- -MAX_WBITS,
- DEF_MEM_LEVEL,
- Z_DEFAULT_STRATEGY,
- nullptr,
- 0,
- 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions
- 1 << 11); // Bit 11 is the language encoding flag. When set, filename and comment fields must be encoded using UTF-8.
- const CharString target_utf8 = da->read_link(f).utf8();
- zipWriteInFileInZip(p_zip, target_utf8.get_data(), target_utf8.size());
- zipCloseFileInZip(p_zip);
- } else if (da->current_is_dir()) {
- zip_folder_recursive(p_zip, p_root_path, p_folder.path_join(f), p_pkg_name);
- } else {
- bool _is_executable = is_executable(dir.path_join(f));
- OS::DateTime dt = OS::get_singleton()->get_datetime();
- zip_fileinfo zipfi;
- zipfi.tmz_date.tm_year = dt.year;
- 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/
- zipfi.tmz_date.tm_mday = dt.day;
- zipfi.tmz_date.tm_hour = dt.hour;
- zipfi.tmz_date.tm_min = dt.minute;
- zipfi.tmz_date.tm_sec = dt.second;
- zipfi.dosDate = 0;
- // 0100000: regular file type
- // 0000755: permissions rwxr-xr-x
- // 0000644: permissions rw-r--r--
- uint32_t _mode = (_is_executable ? 0100755 : 0100644);
- zipfi.external_fa = (_mode << 16L) | !(_mode & 0200);
- zipfi.internal_fa = 0;
- zipOpenNewFileInZip4(p_zip,
- p_folder.path_join(f).utf8().get_data(),
- &zipfi,
- nullptr,
- 0,
- nullptr,
- 0,
- nullptr,
- Z_DEFLATED,
- Z_DEFAULT_COMPRESSION,
- 0,
- -MAX_WBITS,
- DEF_MEM_LEVEL,
- Z_DEFAULT_STRATEGY,
- nullptr,
- 0,
- 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions
- 1 << 11); // Bit 11 is the language encoding flag. When set, filename and comment fields must be encoded using UTF-8.
- Ref<FileAccess> fa = FileAccess::open(dir.path_join(f), FileAccess::READ);
- if (fa.is_null()) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("ZIP Creation"), vformat(TTR("Could not open file to read from path \"%s\"."), dir.path_join(f)));
- return;
- }
- const int bufsize = 16384;
- uint8_t buf[bufsize];
- while (true) {
- uint64_t got = fa->get_buffer(buf, bufsize);
- if (got == 0) {
- break;
- }
- zipWriteInFileInZip(p_zip, buf, got);
- }
- zipCloseFileInZip(p_zip);
- }
- f = da->get_next();
- }
- da->list_dir_end();
- }
- Dictionary EditorExportPlatform::_save_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, bool p_embed) {
- Vector<SharedObject> so_files;
- int64_t embedded_start = 0;
- int64_t embedded_size = 0;
- Error err_code = save_pack(p_preset, p_debug, p_path, &so_files, nullptr, nullptr, p_embed, &embedded_start, &embedded_size);
- Dictionary ret;
- ret["result"] = err_code;
- if (err_code == OK) {
- Array arr;
- for (const SharedObject &E : so_files) {
- Dictionary so;
- so["path"] = E.path;
- so["tags"] = E.tags;
- so["target_folder"] = E.target;
- arr.push_back(so);
- }
- ret["so_files"] = arr;
- if (p_embed) {
- ret["embedded_start"] = embedded_start;
- ret["embedded_size"] = embedded_size;
- }
- }
- return ret;
- }
- Dictionary EditorExportPlatform::_save_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
- Vector<SharedObject> so_files;
- Error err_code = save_zip(p_preset, p_debug, p_path, &so_files);
- Dictionary ret;
- ret["result"] = err_code;
- if (err_code == OK) {
- Array arr;
- for (const SharedObject &E : so_files) {
- Dictionary so;
- so["path"] = E.path;
- so["tags"] = E.tags;
- so["target_folder"] = E.target;
- arr.push_back(so);
- }
- ret["so_files"] = arr;
- }
- return ret;
- }
- Dictionary EditorExportPlatform::_save_pack_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
- Vector<SharedObject> so_files;
- Error err_code = save_pack_patch(p_preset, p_debug, p_path, &so_files);
- Dictionary ret;
- ret["result"] = err_code;
- if (err_code == OK) {
- Array arr;
- for (const SharedObject &E : so_files) {
- Dictionary so;
- so["path"] = E.path;
- so["tags"] = E.tags;
- so["target_folder"] = E.target;
- arr.push_back(so);
- }
- ret["so_files"] = arr;
- }
- return ret;
- }
- Dictionary EditorExportPlatform::_save_zip_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
- Vector<SharedObject> so_files;
- Error err_code = save_zip_patch(p_preset, p_debug, p_path, &so_files);
- Dictionary ret;
- ret["result"] = err_code;
- if (err_code == OK) {
- Array arr;
- for (const SharedObject &E : so_files) {
- Dictionary so;
- so["path"] = E.path;
- so["tags"] = E.tags;
- so["target_folder"] = E.target;
- arr.push_back(so);
- }
- ret["so_files"] = arr;
- }
- return ret;
- }
- bool EditorExportPlatform::_store_header(Ref<FileAccess> p_fd, bool p_enc, bool p_sparse, uint64_t &r_file_base_ofs, uint64_t &r_dir_base_ofs) {
- p_fd->store_32(PACK_HEADER_MAGIC);
- p_fd->store_32(PACK_FORMAT_VERSION);
- p_fd->store_32(GODOT_VERSION_MAJOR);
- p_fd->store_32(GODOT_VERSION_MINOR);
- p_fd->store_32(GODOT_VERSION_PATCH);
- uint32_t pack_flags = PACK_REL_FILEBASE;
- if (p_enc) {
- pack_flags |= PACK_DIR_ENCRYPTED;
- }
- if (p_sparse) {
- pack_flags |= PACK_SPARSE_BUNDLE;
- }
- p_fd->store_32(pack_flags); // Flags.
- r_file_base_ofs = p_fd->get_position();
- p_fd->store_64(0); // Files base offset.
- r_dir_base_ofs = p_fd->get_position();
- p_fd->store_64(0); // Directory offset.
- for (int i = 0; i < 16; i++) {
- //reserved
- p_fd->store_32(0);
- }
- return true;
- }
- bool EditorExportPlatform::_encrypt_and_store_directory(Ref<FileAccess> p_fd, PackData &p_pack_data, const Vector<uint8_t> &p_key, uint64_t p_seed, uint64_t p_file_base) {
- Ref<FileAccessEncrypted> fae;
- Ref<FileAccess> fhead = p_fd;
- fhead->store_32(p_pack_data.file_ofs.size()); //amount of files
- if (!p_key.is_empty()) {
- uint64_t seed = p_seed;
- fae.instantiate();
- if (fae.is_null()) {
- return false;
- }
- Vector<uint8_t> iv;
- if (seed != 0) {
- for (int i = 0; i < p_pack_data.file_ofs.size(); i++) {
- for (int64_t j = 0; j < p_pack_data.file_ofs[i].path_utf8.length(); j++) {
- seed = ((seed << 5) + seed) ^ p_pack_data.file_ofs[i].path_utf8.get_data()[j];
- }
- for (int64_t j = 0; j < p_pack_data.file_ofs[i].md5.size(); j++) {
- seed = ((seed << 5) + seed) ^ p_pack_data.file_ofs[i].md5[j];
- }
- seed = ((seed << 5) + seed) ^ (p_pack_data.file_ofs[i].ofs - p_file_base);
- seed = ((seed << 5) + seed) ^ p_pack_data.file_ofs[i].size;
- }
- RandomPCG rng = RandomPCG(seed);
- iv.resize(16);
- for (int i = 0; i < 16; i++) {
- iv.write[i] = rng.rand() % 256;
- }
- }
- Error err = fae->open_and_parse(fhead, p_key, FileAccessEncrypted::MODE_WRITE_AES256, false, iv);
- if (err != OK) {
- return false;
- }
- fhead = fae;
- }
- for (int i = 0; i < p_pack_data.file_ofs.size(); i++) {
- uint32_t string_len = p_pack_data.file_ofs[i].path_utf8.length();
- uint32_t pad = _get_pad(4, string_len);
- fhead->store_32(string_len + pad);
- fhead->store_buffer((const uint8_t *)p_pack_data.file_ofs[i].path_utf8.get_data(), string_len);
- for (uint32_t j = 0; j < pad; j++) {
- fhead->store_8(0);
- }
- fhead->store_64(p_pack_data.file_ofs[i].ofs - p_file_base);
- fhead->store_64(p_pack_data.file_ofs[i].size); // pay attention here, this is where file is
- fhead->store_buffer(p_pack_data.file_ofs[i].md5.ptr(), 16); //also save md5 for file
- uint32_t flags = 0;
- if (p_pack_data.file_ofs[i].encrypted) {
- flags |= PACK_FILE_ENCRYPTED;
- }
- if (p_pack_data.file_ofs[i].removal) {
- flags |= PACK_FILE_REMOVAL;
- }
- fhead->store_32(flags);
- }
- if (fae.is_valid()) {
- fhead.unref();
- fae.unref();
- }
- return true;
- }
- 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) {
- EditorProgress ep("savepack", TTR("Packing"), 102, true);
- if (p_save_func == nullptr) {
- p_save_func = _save_pack_file;
- }
- // Create the temporary export directory if it doesn't exist.
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- da->make_dir_recursive(EditorPaths::get_singleton()->get_temp_dir());
- Ref<FileAccess> f;
- int64_t embed_pos = 0;
- if (!p_embed) {
- // Regular output to separate PCK file.
- f = FileAccess::open(p_path, FileAccess::WRITE);
- if (f.is_null()) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), vformat(TTR("Can't open file for writing at path \"%s\"."), p_path));
- return ERR_CANT_CREATE;
- }
- } else {
- // Append to executable.
- f = FileAccess::open(p_path, FileAccess::READ_WRITE);
- if (f.is_null()) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), vformat(TTR("Can't open file for reading-writing at path \"%s\"."), p_path));
- return ERR_FILE_CANT_OPEN;
- }
- f->seek_end();
- embed_pos = f->get_position();
- if (r_embedded_start) {
- *r_embedded_start = embed_pos;
- }
- // Ensure embedded PCK starts at a 64-bit multiple
- int pad = f->get_position() % 8;
- for (int i = 0; i < pad; i++) {
- f->store_8(0);
- }
- }
- int64_t pck_start_pos = f->get_position();
- uint64_t file_base_ofs = 0;
- uint64_t dir_base_ofs = 0;
- _store_header(f, p_preset->get_enc_pck() && p_preset->get_enc_directory(), false, file_base_ofs, dir_base_ofs);
- // Align for first file.
- int file_padding = _get_pad(PCK_PADDING, f->get_position());
- for (int i = 0; i < file_padding; i++) {
- f->store_8(0);
- }
- uint64_t file_base = f->get_position();
- f->seek(file_base_ofs);
- f->store_64(file_base - pck_start_pos); // Update files base.
- f->seek(file_base);
- // Write files.
- PackData pd;
- pd.ep = &ep;
- pd.f = f;
- pd.so_files = p_so_files;
- pd.path = p_path;
- Error err = export_project_files(p_preset, p_debug, p_save_func, p_remove_func, &pd, _pack_add_shared_object);
- if (err != OK) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Failed to export project files."));
- return err;
- }
- if (pd.file_ofs.is_empty()) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("No files or changes to export."));
- return FAILED;
- }
- pd.file_ofs.sort(); // Do sort, so we can do binary search later (where ?).
- int dir_padding = _get_pad(PCK_PADDING, f->get_position());
- for (int i = 0; i < dir_padding; i++) {
- f->store_8(0);
- }
- // Write directory.
- uint64_t dir_offset = f->get_position();
- f->seek(dir_base_ofs);
- f->store_64(dir_offset - pck_start_pos);
- f->seek(dir_offset);
- Vector<uint8_t> key;
- if (p_preset->get_enc_pck() && p_preset->get_enc_directory()) {
- String script_key = _get_script_encryption_key(p_preset);
- key.resize(32);
- if (script_key.length() == 64) {
- for (int i = 0; i < 32; i++) {
- int v = 0;
- if (i * 2 < script_key.length()) {
- char32_t ct = script_key[i * 2];
- if (is_digit(ct)) {
- ct = ct - '0';
- } else if (ct >= 'a' && ct <= 'f') {
- ct = 10 + ct - 'a';
- }
- v |= ct << 4;
- }
- if (i * 2 + 1 < script_key.length()) {
- char32_t ct = script_key[i * 2 + 1];
- if (is_digit(ct)) {
- ct = ct - '0';
- } else if (ct >= 'a' && ct <= 'f') {
- ct = 10 + ct - 'a';
- }
- v |= ct;
- }
- key.write[i] = v;
- }
- }
- }
- if (!_encrypt_and_store_directory(f, pd, key, p_preset->get_seed(), file_base)) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Can't create encrypted file."));
- return ERR_CANT_CREATE;
- }
- if (p_embed) {
- // Ensure embedded data ends at a 64-bit multiple.
- uint64_t embed_end = f->get_position() - embed_pos + 12;
- uint64_t pad = embed_end % 8;
- for (uint64_t i = 0; i < pad; i++) {
- f->store_8(0);
- }
- uint64_t pck_size = f->get_position() - pck_start_pos;
- f->store_64(pck_size);
- f->store_32(PACK_HEADER_MAGIC);
- if (r_embedded_size) {
- *r_embedded_size = f->get_position() - embed_pos;
- }
- }
- f->close();
- return OK;
- }
- 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) {
- 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);
- }
- 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) {
- EditorProgress ep("savezip", TTR("Packing"), 102, true);
- if (p_save_func == nullptr) {
- p_save_func = _save_zip_file;
- }
- String tmppath = EditorPaths::get_singleton()->get_temp_dir().path_join("packtmp");
- Ref<FileAccess> io_fa;
- zlib_filefunc_def io = zipio_create_io(&io_fa);
- zipFile zip = zipOpen2(tmppath.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io);
- ZipData zd;
- zd.ep = &ep;
- zd.zip = zip;
- zd.so_files = p_so_files;
- Error err = export_project_files(p_preset, p_debug, p_save_func, nullptr, &zd, _zip_add_shared_object);
- if (err != OK && err != ERR_SKIP) {
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save ZIP"), TTR("Failed to export project files."));
- }
- zipClose(zip, nullptr);
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- if (zd.file_count == 0) {
- da->remove(tmppath);
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("No files or changes to export."));
- return FAILED;
- }
- err = da->rename(tmppath, p_path);
- if (err != OK) {
- da->remove(tmppath);
- add_message(EXPORT_MESSAGE_ERROR, TTR("Save ZIP"), vformat(TTR("Failed to move temporary file \"%s\" to \"%s\"."), tmppath, p_path));
- }
- return OK;
- }
- Error EditorExportPlatform::save_zip_patch(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files) {
- return save_zip(p_preset, p_debug, p_path, p_so_files, _save_zip_patch_file);
- }
- Error EditorExportPlatform::export_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
- ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
- return save_pack(p_preset, p_debug, p_path);
- }
- Error EditorExportPlatform::export_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
- ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
- return save_zip(p_preset, p_debug, p_path);
- }
- 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) {
- ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
- Error err = _load_patches(p_patches.is_empty() ? p_preset->get_patches() : p_patches);
- if (err != OK) {
- return err;
- }
- err = save_pack_patch(p_preset, p_debug, p_path);
- _unload_patches();
- return err;
- }
- 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) {
- ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
- Error err = _load_patches(p_patches.is_empty() ? p_preset->get_patches() : p_patches);
- if (err != OK) {
- return err;
- }
- err = save_zip_patch(p_preset, p_debug, p_path);
- _unload_patches();
- return err;
- }
- Vector<String> EditorExportPlatform::gen_export_flags(BitField<EditorExportPlatform::DebugFlags> p_flags) {
- Vector<String> ret;
- String host = EDITOR_GET("network/debug/remote_host");
- int remote_port = (int)EDITOR_GET("network/debug/remote_port");
- 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")) {
- host = EDITOR_GET("export/android/wifi_remote_debug_host");
- } else if (p_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST)) {
- host = "localhost";
- }
- if (p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
- int port = EDITOR_GET("filesystem/file_server/port");
- String passwd = EDITOR_GET("filesystem/file_server/password");
- ret.push_back("--remote-fs");
- ret.push_back(host + ":" + itos(port));
- if (!passwd.is_empty()) {
- ret.push_back("--remote-fs-password");
- ret.push_back(passwd);
- }
- }
- if (p_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG)) {
- ret.push_back("--remote-debug");
- ret.push_back(get_debug_protocol() + host + ":" + String::num_int64(remote_port));
- List<String> breakpoints;
- ScriptEditor::get_singleton()->get_breakpoints(&breakpoints);
- if (breakpoints.size()) {
- ret.push_back("--breakpoints");
- String bpoints;
- for (List<String>::Element *E = breakpoints.front(); E; E = E->next()) {
- bpoints += E->get().replace(" ", "%20");
- if (E->next()) {
- bpoints += ",";
- }
- }
- ret.push_back(bpoints);
- }
- }
- if (p_flags.has_flag(DEBUG_FLAG_VIEW_COLLISIONS)) {
- ret.push_back("--debug-collisions");
- }
- if (p_flags.has_flag(DEBUG_FLAG_VIEW_NAVIGATION)) {
- ret.push_back("--debug-navigation");
- }
- return ret;
- }
- bool EditorExportPlatform::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const {
- bool valid = true;
- String templates_error;
- valid = valid && has_valid_export_configuration(p_preset, templates_error, r_missing_templates, p_debug);
- if (!templates_error.is_empty()) {
- r_error += templates_error;
- }
- String export_plugins_warning;
- Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
- for (int i = 0; i < export_plugins.size(); i++) {
- Ref<EditorExportPlatform> export_platform = Ref<EditorExportPlatform>(this);
- if (!export_plugins[i]->supports_platform(export_platform)) {
- continue;
- }
- String plugin_warning = export_plugins.write[i]->_has_valid_export_configuration(export_platform, p_preset);
- if (!plugin_warning.is_empty()) {
- export_plugins_warning += plugin_warning;
- }
- }
- if (!export_plugins_warning.is_empty()) {
- r_error += export_plugins_warning;
- }
- String project_configuration_error;
- valid = valid && has_valid_project_configuration(p_preset, project_configuration_error);
- if (!project_configuration_error.is_empty()) {
- r_error += project_configuration_error;
- }
- return valid;
- }
- 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 {
- String ssh_path = EDITOR_GET("export/ssh/ssh");
- if (ssh_path.is_empty()) {
- ssh_path = "ssh";
- }
- List<String> args;
- args.push_back("-p");
- args.push_back(p_port);
- args.push_back("-q");
- args.push_back("-o");
- args.push_back("LogLevel=error");
- args.push_back("-o");
- args.push_back("BatchMode=yes");
- args.push_back("-o");
- args.push_back("StrictHostKeyChecking=no");
- for (const String &E : p_ssh_args) {
- args.push_back(E);
- }
- if (p_port_fwd > 0) {
- args.push_back("-R");
- args.push_back(vformat("%d:localhost:%d", p_port_fwd, p_port_fwd));
- }
- args.push_back(p_host);
- args.push_back(p_cmd_args);
- String out;
- int exit_code = -1;
- if (OS::get_singleton()->is_stdout_verbose()) {
- OS::get_singleton()->print("Executing: %s", ssh_path.utf8().get_data());
- for (const String &arg : args) {
- OS::get_singleton()->print(" %s", arg.utf8().get_data());
- }
- OS::get_singleton()->print("\n");
- }
- Error err = OS::get_singleton()->execute(ssh_path, args, &out, &exit_code, true);
- if (out.is_empty()) {
- print_verbose(vformat("Exit code: %d", exit_code));
- } else {
- print_verbose(vformat("Exit code: %d, Output: %s", exit_code, out.replace("\r\n", "\n")));
- }
- if (r_out) {
- *r_out = out.replace("\r\n", "\n").get_slicec('\n', 0);
- }
- if (err != OK) {
- return err;
- } else if (exit_code != 0) {
- if (!out.is_empty()) {
- print_line(out);
- }
- return FAILED;
- }
- return OK;
- }
- 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 {
- String ssh_path = EDITOR_GET("export/ssh/ssh");
- if (ssh_path.is_empty()) {
- ssh_path = "ssh";
- }
- List<String> args;
- args.push_back("-p");
- args.push_back(p_port);
- args.push_back("-q");
- args.push_back("-o");
- args.push_back("LogLevel=error");
- args.push_back("-o");
- args.push_back("BatchMode=yes");
- args.push_back("-o");
- args.push_back("StrictHostKeyChecking=no");
- for (const String &E : p_ssh_args) {
- args.push_back(E);
- }
- if (p_port_fwd > 0) {
- args.push_back("-R");
- args.push_back(vformat("%d:localhost:%d", p_port_fwd, p_port_fwd));
- }
- args.push_back(p_host);
- args.push_back(p_cmd_args);
- if (OS::get_singleton()->is_stdout_verbose()) {
- OS::get_singleton()->print("Executing: %s", ssh_path.utf8().get_data());
- for (const String &arg : args) {
- OS::get_singleton()->print(" %s", arg.utf8().get_data());
- }
- OS::get_singleton()->print("\n");
- }
- return OS::get_singleton()->create_process(ssh_path, args, r_pid);
- }
- 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 {
- String scp_path = EDITOR_GET("export/ssh/scp");
- if (scp_path.is_empty()) {
- scp_path = "scp";
- }
- List<String> args;
- args.push_back("-P");
- args.push_back(p_port);
- args.push_back("-q");
- args.push_back("-o");
- args.push_back("LogLevel=error");
- args.push_back("-o");
- args.push_back("BatchMode=yes");
- args.push_back("-o");
- args.push_back("StrictHostKeyChecking=no");
- for (const String &E : p_scp_args) {
- args.push_back(E);
- }
- args.push_back(p_src_file);
- args.push_back(vformat("%s:%s", p_host, p_dst_file));
- String out;
- int exit_code = -1;
- if (OS::get_singleton()->is_stdout_verbose()) {
- OS::get_singleton()->print("Executing: %s", scp_path.utf8().get_data());
- for (const String &arg : args) {
- OS::get_singleton()->print(" %s", arg.utf8().get_data());
- }
- OS::get_singleton()->print("\n");
- }
- Error err = OS::get_singleton()->execute(scp_path, args, &out, &exit_code, true);
- if (err != OK) {
- return err;
- } else if (exit_code != 0) {
- if (!out.is_empty()) {
- print_line(out);
- }
- return FAILED;
- }
- return OK;
- }
- Array EditorExportPlatform::get_current_presets() const {
- Array ret;
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> ep = EditorExport::get_singleton()->get_export_preset(i);
- if (ep->get_platform() == this) {
- ret.push_back(ep);
- }
- }
- return ret;
- }
- Variant EditorExportPlatform::get_project_setting(const Ref<EditorExportPreset> &p_preset, const StringName &p_name) {
- if (p_preset.is_valid()) {
- return p_preset->get_project_setting(p_name);
- } else {
- return GLOBAL_GET(p_name);
- }
- }
- void EditorExportPlatform::_bind_methods() {
- ClassDB::bind_method(D_METHOD("get_os_name"), &EditorExportPlatform::get_os_name);
- ClassDB::bind_method(D_METHOD("create_preset"), &EditorExportPlatform::create_preset);
- ClassDB::bind_method(D_METHOD("find_export_template", "template_file_name"), &EditorExportPlatform::_find_export_template);
- ClassDB::bind_method(D_METHOD("get_current_presets"), &EditorExportPlatform::get_current_presets);
- ClassDB::bind_method(D_METHOD("save_pack", "preset", "debug", "path", "embed"), &EditorExportPlatform::_save_pack, DEFVAL(false));
- ClassDB::bind_method(D_METHOD("save_zip", "preset", "debug", "path"), &EditorExportPlatform::_save_zip);
- ClassDB::bind_method(D_METHOD("save_pack_patch", "preset", "debug", "path"), &EditorExportPlatform::_save_pack_patch);
- ClassDB::bind_method(D_METHOD("save_zip_patch", "preset", "debug", "path"), &EditorExportPlatform::_save_zip_patch);
- ClassDB::bind_method(D_METHOD("gen_export_flags", "flags"), &EditorExportPlatform::gen_export_flags);
- ClassDB::bind_method(D_METHOD("export_project_files", "preset", "debug", "save_cb", "shared_cb"), &EditorExportPlatform::_export_project_files, DEFVAL(Callable()));
- ClassDB::bind_method(D_METHOD("export_project", "preset", "debug", "path", "flags"), &EditorExportPlatform::export_project, DEFVAL(0));
- ClassDB::bind_method(D_METHOD("export_pack", "preset", "debug", "path", "flags"), &EditorExportPlatform::export_pack, DEFVAL(0));
- ClassDB::bind_method(D_METHOD("export_zip", "preset", "debug", "path", "flags"), &EditorExportPlatform::export_zip, DEFVAL(0));
- ClassDB::bind_method(D_METHOD("export_pack_patch", "preset", "debug", "path", "patches", "flags"), &EditorExportPlatform::export_pack_patch, DEFVAL(PackedStringArray()), DEFVAL(0));
- ClassDB::bind_method(D_METHOD("export_zip_patch", "preset", "debug", "path", "patches", "flags"), &EditorExportPlatform::export_zip_patch, DEFVAL(PackedStringArray()), DEFVAL(0));
- ClassDB::bind_method(D_METHOD("clear_messages"), &EditorExportPlatform::clear_messages);
- ClassDB::bind_method(D_METHOD("add_message", "type", "category", "message"), &EditorExportPlatform::add_message);
- ClassDB::bind_method(D_METHOD("get_message_count"), &EditorExportPlatform::get_message_count);
- ClassDB::bind_method(D_METHOD("get_message_type", "index"), &EditorExportPlatform::_get_message_type);
- ClassDB::bind_method(D_METHOD("get_message_category", "index"), &EditorExportPlatform::_get_message_category);
- ClassDB::bind_method(D_METHOD("get_message_text", "index"), &EditorExportPlatform::_get_message_text);
- ClassDB::bind_method(D_METHOD("get_worst_message_type"), &EditorExportPlatform::get_worst_message_type);
- 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));
- 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));
- ClassDB::bind_method(D_METHOD("ssh_push_to_remote", "host", "port", "scp_args", "src_file", "dst_file"), &EditorExportPlatform::ssh_push_to_remote);
- ClassDB::bind_method(D_METHOD("get_internal_export_files", "preset", "debug"), &EditorExportPlatform::get_internal_export_files);
- ClassDB::bind_static_method("EditorExportPlatform", D_METHOD("get_forced_export_files", "preset"), &EditorExportPlatform::get_forced_export_files);
- BIND_ENUM_CONSTANT(EXPORT_MESSAGE_NONE);
- BIND_ENUM_CONSTANT(EXPORT_MESSAGE_INFO);
- BIND_ENUM_CONSTANT(EXPORT_MESSAGE_WARNING);
- BIND_ENUM_CONSTANT(EXPORT_MESSAGE_ERROR);
- BIND_BITFIELD_FLAG(DEBUG_FLAG_DUMB_CLIENT);
- BIND_BITFIELD_FLAG(DEBUG_FLAG_REMOTE_DEBUG);
- BIND_BITFIELD_FLAG(DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST);
- BIND_BITFIELD_FLAG(DEBUG_FLAG_VIEW_COLLISIONS);
- BIND_BITFIELD_FLAG(DEBUG_FLAG_VIEW_NAVIGATION);
- }
|