Skip to content

Commit

Permalink
Re-introduce pack trimming from godotengine#82084
Browse files Browse the repository at this point in the history 
This reverts commit a057158.
  • Loading branch information
@ogapo
ogapo committed Jun 23, 2024
1 parent 04bf7d4 commit 5e63e6b
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 37 deletions.
2 changes: 1 addition & 1 deletion editor/debugger/editor_file_server.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ void EditorFileServer::poll() {
// Scan files to send.
_scan_files_changed(EditorFileSystem::get_singleton()->get_filesystem(), tags, files_to_send, cached_files);
// Add forced export files
Vector<String> forced_export = EditorExportPlatform::get_forced_export_files();
Vector<String> forced_export = EditorExportPlatform::get_main_pack_forced_export_files();
for (int i = 0; i < forced_export.size(); i++) {
_add_custom_file(forced_export[i], files_to_send, cached_files);
}
Expand Down
71 changes: 46 additions & 25 deletions editor/export/editor_export_platform.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -878,23 +878,19 @@ String EditorExportPlatform::_get_script_encryption_key(const Ref<EditorExportPr
return p_preset->get_script_encryption_key().to_lower();
}

Vector<String> EditorExportPlatform::get_forced_export_files() {
Vector<String> files;

files.push_back(ProjectSettings::get_singleton()->get_global_class_list_path());
Vector<String> EditorExportPlatform::get_main_pack_forced_export_files() {
// First, get files required by any PCK.
Vector<String> files = get_forced_export_files();

String icon = GLOBAL_GET("application/config/icon");
String splash = GLOBAL_GET("application/boot_splash/image");
if (!icon.is_empty() && FileAccess::exists(icon)) {
files.push_back(icon);
}
if (!splash.is_empty() && FileAccess::exists(splash) && icon != splash) {

String splash = GLOBAL_GET("application/boot_splash/image");
if (!splash.is_empty() && icon != splash && FileAccess::exists(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)) {
Expand Down Expand Up @@ -927,7 +923,19 @@ Vector<String> EditorExportPlatform::get_forced_export_files() {
return files;
}

Error EditorExportPlatform::export_project_files(const Ref<EditorExportPreset> &p_preset, bool p_debug, EditorExportSaveFunction p_func, void *p_udata, EditorExportSaveSharedObject p_so_func) {
Vector<String> EditorExportPlatform::get_forced_export_files() {
Vector<String> files;
files.push_back(ProjectSettings::get_singleton()->get_global_class_list_path());

String resource_cache_file = ResourceUID::get_cache_file();
if (FileAccess::exists(resource_cache_file)) {
files.push_back(resource_cache_file);
}

return files;
}

Error EditorExportPlatform::export_project_files(bool p_main_pack, const Ref<EditorExportPreset> &p_preset, bool p_debug, EditorExportSaveFunction p_func, void *p_udata, EditorExportSaveSharedObject p_so_func) {
//figure out paths of files that will be exported
HashSet<String> paths;
Vector<String> path_remaps;
Expand Down Expand Up @@ -974,9 +982,11 @@ Error EditorExportPlatform::export_project_files(const Ref<EditorExportPreset> &
}
}

//add native icons to non-resource include list
_edit_filter_list(paths, String("*.icns"), false);
_edit_filter_list(paths, String("*.ico"), false);
if (p_main_pack) {
// 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);
Expand Down Expand Up @@ -1412,7 +1422,12 @@ Error EditorExportPlatform::export_project_files(const Ref<EditorExportPreset> &
}
}

Vector<String> forced_export = get_forced_export_files();
Vector<String> forced_export;
if (p_main_pack) {
forced_export = get_main_pack_forced_export_files();
} else {
forced_export = get_forced_export_files();
}
for (int i = 0; i < forced_export.size(); i++) {
Vector<uint8_t> array = FileAccess::get_file_as_bytes(forced_export[i]);
err = p_func(p_udata, forced_export[i], array, idx, total, enc_in_filters, enc_ex_filters, key);
Expand All @@ -1421,13 +1436,19 @@ Error EditorExportPlatform::export_project_files(const Ref<EditorExportPreset> &
}
}

String config_file = "project.binary";
String engine_cfb = EditorPaths::get_singleton()->get_cache_dir().path_join("tmp" + config_file);
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);
if (p_main_pack) {
String config_file = "project.binary";
String engine_cfb = EditorPaths::get_singleton()->get_cache_dir().path_join("tmp" + config_file);
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 = p_func(p_udata, "res://" + config_file, data, idx, total, enc_in_filters, enc_ex_filters, key);
if (err != OK) {
return err;
}
}

return p_func(p_udata, "res://" + config_file, data, idx, total, enc_in_filters, enc_ex_filters, key);
return OK;
}

Error EditorExportPlatform::_add_shared_object(void *p_userdata, const SharedObject &p_so) {
Expand Down Expand Up @@ -1556,7 +1577,7 @@ void EditorExportPlatform::zip_folder_recursive(zipFile &p_zip, const String &p_
da->list_dir_end();
}

Error EditorExportPlatform::save_pack(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) {
Error EditorExportPlatform::save_pack(bool p_main_pack, 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) {
EditorProgress ep("savepack", TTR("Packing"), 102, true);

// Create the temporary export directory if it doesn't exist.
Expand All @@ -1575,7 +1596,7 @@ Error EditorExportPlatform::save_pack(const Ref<EditorExportPreset> &p_preset, b
pd.f = ftmp;
pd.so_files = p_so_files;

Error err = export_project_files(p_preset, p_debug, _save_pack_file, &pd, _add_shared_object);
Error err = export_project_files(p_main_pack, p_preset, p_debug, _save_pack_file, &pd, _add_shared_object);

// Close temp file.
pd.f.unref();
Expand Down Expand Up @@ -1793,7 +1814,7 @@ Error EditorExportPlatform::save_zip(const Ref<EditorExportPreset> &p_preset, bo
zd.ep = &ep;
zd.zip = zip;

Error err = export_project_files(p_preset, p_debug, _save_zip_file, &zd);
Error err = export_project_files(false, p_preset, p_debug, _save_zip_file, &zd);
if (err != OK && err != ERR_SKIP) {
add_message(EXPORT_MESSAGE_ERROR, TTR("Save ZIP"), TTR("Failed to export project files."));
}
Expand All @@ -1805,7 +1826,7 @@ Error EditorExportPlatform::save_zip(const Ref<EditorExportPreset> &p_preset, bo

Error EditorExportPlatform::export_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
return save_pack(p_preset, p_debug, p_path);
return save_pack(false, p_preset, p_debug, p_path);
}

Error EditorExportPlatform::export_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
Expand Down
5 changes: 3 additions & 2 deletions editor/export/editor_export_platform.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ class EditorExportPlatform : public RefCounted {
return worst_type;
}

static Vector<String> get_main_pack_forced_export_files();
static Vector<String> get_forced_export_files();

virtual bool fill_log_messages(RichTextLabel *p_log, Error p_err);
Expand All @@ -216,9 +217,9 @@ class EditorExportPlatform : public RefCounted {
virtual String get_name() const = 0;
virtual Ref<Texture2D> get_logo() const = 0;

Error export_project_files(const Ref<EditorExportPreset> &p_preset, bool p_debug, EditorExportSaveFunction p_func, void *p_udata, EditorExportSaveSharedObject p_so_func = nullptr);
Error export_project_files(bool p_main_pack, const Ref<EditorExportPreset> &p_preset, bool p_debug, EditorExportSaveFunction p_func, void *p_udata, EditorExportSaveSharedObject p_so_func = nullptr);

Error save_pack(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files = nullptr, bool p_embed = false, int64_t *r_embedded_start = nullptr, int64_t *r_embedded_size = nullptr);
Error save_pack(bool p_main_pack, const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, Vector<SharedObject> *p_so_files = nullptr, bool p_embed = false, int64_t *r_embedded_start = nullptr, int64_t *r_embedded_size = nullptr);
Error save_zip(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path);

virtual bool poll_export() { return false; }
Expand Down
2 changes: 1 addition & 1 deletion editor/export/editor_export_platform_pc.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Error EditorExportPlatformPC::export_project_data(const Ref<EditorExportPreset>

int64_t embedded_pos;
int64_t embedded_size;
Error err = save_pack(p_preset, p_debug, pck_path, &so_files, p_preset->get("binary_format/embed_pck"), &embedded_pos, &embedded_size);
Error err = save_pack(true, p_preset, p_debug, pck_path, &so_files, p_preset->get("binary_format/embed_pck"), &embedded_pos, &embedded_size);
if (err == OK && p_preset->get("binary_format/embed_pck")) {
if (embedded_size >= 0x100000000 && String(p_preset->get("binary_format/architecture")).contains("32")) {
add_message(EXPORT_MESSAGE_ERROR, TTR("PCK Embedding"), TTR("On 32-bit exports the embedded PCK cannot be bigger than 4 GiB."));
Expand Down
10 changes: 5 additions & 5 deletions platform/android/export/export_plugin.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2650,7 +2650,7 @@ String EditorExportPlatformAndroid::get_apk_expansion_fullpath(const Ref<EditorE

Error EditorExportPlatformAndroid::save_apk_expansion_file(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
Error err = save_pack(p_preset, p_debug, fullpath);
Error err = save_pack(false, p_preset, p_debug, fullpath);
return err;
}

Expand Down Expand Up @@ -3090,9 +3090,9 @@ Error EditorExportPlatformAndroid::export_project_helper(const Ref<EditorExportP
user_data.libs_directory = gradle_build_directory.path_join("libs");
user_data.debug = p_debug;
if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
err = export_project_files(p_preset, p_debug, ignore_apk_file, &user_data, copy_gradle_so);
err = export_project_files(true, p_preset, p_debug, ignore_apk_file, &user_data, copy_gradle_so);
} else {
err = export_project_files(p_preset, p_debug, rename_and_store_file_in_gradle_project, &user_data, copy_gradle_so);
err = export_project_files(true, p_preset, p_debug, rename_and_store_file_in_gradle_project, &user_data, copy_gradle_so);
}
if (err != OK) {
add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not export project files to gradle project."));
Expand Down Expand Up @@ -3467,7 +3467,7 @@ Error EditorExportPlatformAndroid::export_project_helper(const Ref<EditorExportP
APKExportData ed;
ed.ep = &ep;
ed.apk = unaligned_apk;
err = export_project_files(p_preset, p_debug, ignore_apk_file, &ed, save_apk_so);
err = export_project_files(true, p_preset, p_debug, ignore_apk_file, &ed, save_apk_so);
} else {
if (apk_expansion) {
err = save_apk_expansion_file(p_preset, p_debug, p_path);
Expand All @@ -3479,7 +3479,7 @@ Error EditorExportPlatformAndroid::export_project_helper(const Ref<EditorExportP
APKExportData ed;
ed.ep = &ep;
ed.apk = unaligned_apk;
err = export_project_files(p_preset, p_debug, save_apk_file, &ed, save_apk_so);
err = export_project_files(true, p_preset, p_debug, save_apk_file, &ed, save_apk_so);
}
}

Expand Down
2 changes: 1 addition & 1 deletion platform/ios/export/export_plugin.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2142,7 +2142,7 @@ Error EditorExportPlatformIOS::_export_project_helper(const Ref<EditorExportPres
}
String pack_path = binary_dir + ".pck";
Vector<SharedObject> libraries;
Error err = save_pack(p_preset, p_debug, pack_path, &libraries);
Error err = save_pack(true, p_preset, p_debug, pack_path, &libraries);
if (err) {
// Message is supplied by the subroutine method.
return err;
Expand Down
2 changes: 1 addition & 1 deletion platform/macos/export/export_plugin.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1964,7 +1964,7 @@ Error EditorExportPlatformMacOS::export_project(const Ref<EditorExportPreset> &p

String pack_path = tmp_app_path_name + "/Contents/Resources/" + pkg_name + ".pck";
Vector<SharedObject> shared_objects;
err = save_pack(p_preset, p_debug, pack_path, &shared_objects);
err = save_pack(true, p_preset, p_debug, pack_path, &shared_objects);

bool lib_validation = p_preset->get("codesign/entitlements/disable_library_validation");
if (!shared_objects.is_empty() && sign_enabled && ad_hoc && !lib_validation) {
Expand Down
2 changes: 1 addition & 1 deletion platform/web/export/export_plugin.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ Error EditorExportPlatformWeb::export_project(const Ref<EditorExportPreset> &p_p
// Export pck and shared objects
Vector<SharedObject> shared_objects;
String pck_path = base_path + ".pck";
Error error = save_pack(p_preset, p_debug, pck_path, &shared_objects);
Error error = save_pack(true, p_preset, p_debug, pck_path, &shared_objects);
if (error != OK) {
add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not write file: \"%s\"."), pck_path));
return error;
Expand Down

0 comments on commit 5e63e6b

Please sign in to comment.