Merge pull request #40422 from amanj120/forward_port_bundle_pr_resources

Create strings.xml files in the Gradle project to handle localization

2 files changed, 60 insertions, 4 deletions

diff --git a/platform/android/export/export.cpp b/platform/android/export/export.cpp
index 71d05bd732..ed85256695 100644
--- a/platform/android/export/export.cpp
+++ b/platform/android/export/export.cpp
@@ -43,6 +43,7 @@
 #include "editor/editor_log.h"
 #include "editor/editor_node.h"
 #include "editor/editor_settings.h"
+#include "platform/android/export/gradle_export_util.h"
 #include "platform/android/logo.gen.h"
 #include "platform/android/plugin/godot_plugin_config.h"
 #include "platform/android/run_icon.gen.h"
@@ -2003,9 +2004,10 @@ public:
 
 		EditorProgress ep("export", "Exporting for Android", 105, true);
 
-		if (bool(p_preset->get("custom_template/use_custom_build"))) { //custom build
-			//re-generate build.gradle and AndroidManifest.xml
+		bool use_custom_build = bool(p_preset->get("custom_template/use_custom_build"));
 
+		if (use_custom_build) {
+			//re-generate build.gradle and AndroidManifest.xml
 			{ //test that installed build version is alright
 				FileAccessRef f = FileAccess::open("res://android/.build_version", FileAccess::READ);
 				if (!f) {
@@ -2018,6 +2020,14 @@ public:
 					return ERR_UNCONFIGURED;
 				}
 			}
+
+			// TODO: should we use "package/name" or "application/config/name"?
+			String project_name = get_project_name(p_preset->get("package/name"));
+			// instead of calling _fix_resources
+			Error err = _create_project_name_strings_files(p_preset, project_name);
+			if (err != OK) {
+				EditorNode::add_io_error("Unable to overwrite res://android/build/res/*.xml files with project name");
+			}
 			//build project if custom build is enabled
 			String sdk_path = EDITOR_GET("export/android/custom_build_sdk_path");
 
@@ -2202,7 +2212,9 @@ public:
 			}
 
 			if (file == "resources.arsc") {
-				_fix_resources(p_preset, data);
+				if (!use_custom_build) {
+					_fix_resources(p_preset, data);
+				}
 			}
 
 			for (int i = 0; i < icon_densities_count; ++i) {
diff --git a/platform/android/export/gradle_export_util.h b/platform/android/export/gradle_export_util.h
index f988047483..622860c307 100644
--- a/platform/android/export/gradle_export_util.h
+++ b/platform/android/export/gradle_export_util.h
@@ -37,6 +37,13 @@
 #include "core/os/os.h"
 #include "editor/editor_export.h"
 
+const String godot_project_name_xml_string = R"(<?xml version="1.0" encoding="utf-8"?>
+<!--WARNING: THIS FILE WILL BE OVERWRITTEN AT BUILD TIME-->
+<resources>
+	<string name="godot_project_name_string">%s</string>
+</resources>
+)";
+
 // Utility method used to create a directory.
 Error create_directory(const String &p_dir) {
 	if (!DirAccess::exists(p_dir)) {
@@ -94,8 +101,45 @@ Error store_string_at_path(const String &p_path, const String &p_data) {
 // This method will be called ONLY when custom build is enabled.
 Error rename_and_store_file_in_gradle_project(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
 	String dst_path = p_path.replace_first("res://", "res://android/build/assets/");
-	Error err = store_file_at_path(dst_path, p_data, Z_NO_COMPRESSION);
+	Error err = store_file_at_path(dst_path, p_data);
 	return err;
 }
 
+// Creates strings.xml files inside the gradle project for different locales.
+Error _create_project_name_strings_files(const Ref<EditorExportPreset> &p_preset, const String &project_name) {
+	// Stores the string into the default values directory.
+	String processed_default_xml_string = vformat(godot_project_name_xml_string, project_name.xml_escape(true));
+	store_string_at_path("res://android/build/res/values/godot_project_name_string.xml", processed_default_xml_string);
+
+	// Searches the Gradle project res/ directory to find all supported locales
+	DirAccessRef da = DirAccess::open("res://android/build/res");
+	if (!da) {
+		return ERR_CANT_OPEN;
+	}
+	da->list_dir_begin();
+	while (true) {
+		String file = da->get_next();
+		if (file == "") {
+			break;
+		}
+		if (!file.begins_with("values-")) {
+			// NOTE: This assumes all directories that start with "values-" are for localization.
+			continue;
+		}
+		String locale = file.replace("values-", "").replace("-r", "_");
+		String property_name = "application/config/name_" + locale;
+		String locale_directory = "res://android/build/res/" + file + "/godot_project_name_string.xml";
+		if (ProjectSettings::get_singleton()->has_setting(property_name)) {
+			String locale_project_name = ProjectSettings::get_singleton()->get(property_name);
+			String processed_xml_string = vformat(godot_project_name_xml_string, locale_project_name.xml_escape(true));
+			store_string_at_path(locale_directory, processed_xml_string);
+		} else {
+			// TODO: Once the legacy build system is deprecated we don't need to have xml files for this else branch
+			store_string_at_path(locale_directory, processed_default_xml_string);
+		}
+	}
+	da->list_dir_end();
+	return OK;
+}
+
 #endif //GODOT_GRADLE_EXPORT_UTIL_H