gradle_export_util.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297
  1. /*************************************************************************/
  2. /* gradle_export_util.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef GODOT_GRADLE_EXPORT_UTIL_H
  31. #define GODOT_GRADLE_EXPORT_UTIL_H
  32. #include "core/io/zip_io.h"
  33. #include "core/os/dir_access.h"
  34. #include "core/os/file_access.h"
  35. #include "core/os/os.h"
  36. #include "editor/editor_export.h"
  37. const String godot_project_name_xml_string = R"(<?xml version="1.0" encoding="utf-8"?>
  38. <!--WARNING: THIS FILE WILL BE OVERWRITTEN AT BUILD TIME-->
  39. <resources>
  40. <string name="godot_project_name_string">%s</string>
  41. </resources>
  42. )";
  43. OS::ScreenOrientation _get_screen_orientation() {
  44. String orientation_settings = ProjectSettings::get_singleton()->get("display/window/handheld/orientation");
  45. OS::ScreenOrientation screen_orientation;
  46. if (orientation_settings == "portrait")
  47. screen_orientation = OS::SCREEN_PORTRAIT;
  48. else if (orientation_settings == "reverse_landscape")
  49. screen_orientation = OS::SCREEN_REVERSE_LANDSCAPE;
  50. else if (orientation_settings == "reverse_portrait")
  51. screen_orientation = OS::SCREEN_REVERSE_PORTRAIT;
  52. else if (orientation_settings == "sensor_landscape")
  53. screen_orientation = OS::SCREEN_SENSOR_LANDSCAPE;
  54. else if (orientation_settings == "sensor_portrait")
  55. screen_orientation = OS::SCREEN_SENSOR_PORTRAIT;
  56. else if (orientation_settings == "sensor")
  57. screen_orientation = OS::SCREEN_SENSOR;
  58. else
  59. screen_orientation = OS::SCREEN_LANDSCAPE;
  60. return screen_orientation;
  61. }
  62. int _get_android_orientation_value(OS::ScreenOrientation screen_orientation) {
  63. switch (screen_orientation) {
  64. case OS::SCREEN_PORTRAIT: return 1;
  65. case OS::SCREEN_REVERSE_LANDSCAPE: return 8;
  66. case OS::SCREEN_REVERSE_PORTRAIT: return 9;
  67. case OS::SCREEN_SENSOR_LANDSCAPE: return 11;
  68. case OS::SCREEN_SENSOR_PORTRAIT: return 12;
  69. case OS::SCREEN_SENSOR: return 13;
  70. case OS::SCREEN_LANDSCAPE:
  71. default:
  72. return 0;
  73. }
  74. }
  75. String _get_android_orientation_label(OS::ScreenOrientation screen_orientation) {
  76. switch (screen_orientation) {
  77. case OS::SCREEN_PORTRAIT: return "portrait";
  78. case OS::SCREEN_REVERSE_LANDSCAPE: return "reverseLandscape";
  79. case OS::SCREEN_REVERSE_PORTRAIT: return "reversePortrait";
  80. case OS::SCREEN_SENSOR_LANDSCAPE: return "userLandscape";
  81. case OS::SCREEN_SENSOR_PORTRAIT: return "userPortrait";
  82. case OS::SCREEN_SENSOR: return "fullUser";
  83. case OS::SCREEN_LANDSCAPE:
  84. default:
  85. return "landscape";
  86. }
  87. }
  88. // Utility method used to create a directory.
  89. Error create_directory(const String &p_dir) {
  90. if (!DirAccess::exists(p_dir)) {
  91. DirAccess *filesystem_da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  92. ERR_FAIL_COND_V_MSG(!filesystem_da, ERR_CANT_CREATE, "Cannot create directory '" + p_dir + "'.");
  93. Error err = filesystem_da->make_dir_recursive(p_dir);
  94. ERR_FAIL_COND_V_MSG(err, ERR_CANT_CREATE, "Cannot create directory '" + p_dir + "'.");
  95. memdelete(filesystem_da);
  96. }
  97. return OK;
  98. }
  99. // Implementation of EditorExportSaveSharedObject.
  100. // This method will only be called as an input to export_project_files.
  101. // This method lets the .so files for all ABIs to be copied
  102. // into the gradle project from the .AAR file
  103. Error ignore_so_file(void *p_userdata, const SharedObject &p_so) {
  104. return OK;
  105. }
  106. // Writes p_data into a file at p_path, creating directories if necessary.
  107. // Note: this will overwrite the file at p_path if it already exists.
  108. Error store_file_at_path(const String &p_path, const Vector<uint8_t> &p_data) {
  109. String dir = p_path.get_base_dir();
  110. Error err = create_directory(dir);
  111. if (err != OK) {
  112. return err;
  113. }
  114. FileAccess *fa = FileAccess::open(p_path, FileAccess::WRITE);
  115. ERR_FAIL_COND_V_MSG(!fa, ERR_CANT_CREATE, "Cannot create file '" + p_path + "'.");
  116. fa->store_buffer(p_data.ptr(), p_data.size());
  117. memdelete(fa);
  118. return OK;
  119. }
  120. // Writes string p_data into a file at p_path, creating directories if necessary.
  121. // Note: this will overwrite the file at p_path if it already exists.
  122. Error store_string_at_path(const String &p_path, const String &p_data) {
  123. String dir = p_path.get_base_dir();
  124. Error err = create_directory(dir);
  125. if (err != OK) {
  126. if (OS::get_singleton()->is_stdout_verbose()) {
  127. print_error("Unable to write data into " + p_path);
  128. }
  129. return err;
  130. }
  131. FileAccess *fa = FileAccess::open(p_path, FileAccess::WRITE);
  132. ERR_FAIL_COND_V_MSG(!fa, ERR_CANT_CREATE, "Cannot create file '" + p_path + "'.");
  133. fa->store_string(p_data);
  134. memdelete(fa);
  135. return OK;
  136. }
  137. // Implementation of EditorExportSaveFunction.
  138. // This method will only be called as an input to export_project_files.
  139. // It is used by the export_project_files method to save all the asset files into the gradle project.
  140. // It's functionality mirrors that of the method save_apk_file.
  141. // This method will be called ONLY when custom build is enabled.
  142. 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) {
  143. String dst_path = p_path.replace_first("res://", "res://android/build/assets/");
  144. print_verbose("Saving project files from " + p_path + " into " + dst_path);
  145. Error err = store_file_at_path(dst_path, p_data);
  146. return err;
  147. }
  148. // Creates strings.xml files inside the gradle project for different locales.
  149. Error _create_project_name_strings_files(const Ref<EditorExportPreset> &p_preset, const String &project_name) {
  150. print_verbose("Creating strings resources for supported locales for project " + project_name);
  151. // Stores the string into the default values directory.
  152. String processed_default_xml_string = vformat(godot_project_name_xml_string, project_name.xml_escape(true));
  153. store_string_at_path("res://android/build/res/values/godot_project_name_string.xml", processed_default_xml_string);
  154. // Searches the Gradle project res/ directory to find all supported locales
  155. DirAccessRef da = DirAccess::open("res://android/build/res");
  156. if (!da) {
  157. if (OS::get_singleton()->is_stdout_verbose()) {
  158. print_error("Unable to open Android resources directory.");
  159. }
  160. return ERR_CANT_OPEN;
  161. }
  162. da->list_dir_begin();
  163. while (true) {
  164. String file = da->get_next();
  165. if (file == "") {
  166. break;
  167. }
  168. if (!file.begins_with("values-")) {
  169. // NOTE: This assumes all directories that start with "values-" are for localization.
  170. continue;
  171. }
  172. String locale = file.replace("values-", "").replace("-r", "_");
  173. String property_name = "application/config/name_" + locale;
  174. String locale_directory = "res://android/build/res/" + file + "/godot_project_name_string.xml";
  175. if (ProjectSettings::get_singleton()->has_setting(property_name)) {
  176. String locale_project_name = ProjectSettings::get_singleton()->get(property_name);
  177. String processed_xml_string = vformat(godot_project_name_xml_string, locale_project_name.xml_escape(true));
  178. print_verbose("Storing project name for locale " + locale + " under " + locale_directory);
  179. store_string_at_path(locale_directory, processed_xml_string);
  180. } else {
  181. // TODO: Once the legacy build system is deprecated we don't need to have xml files for this else branch
  182. store_string_at_path(locale_directory, processed_default_xml_string);
  183. }
  184. }
  185. da->list_dir_end();
  186. return OK;
  187. }
  188. String bool_to_string(bool v) {
  189. return v ? "true" : "false";
  190. }
  191. String _get_gles_tag() {
  192. bool min_gles3 = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name") == "GLES3" &&
  193. !ProjectSettings::get_singleton()->get("rendering/quality/driver/fallback_to_gles2");
  194. return min_gles3 ? " <uses-feature android:glEsVersion=\"0x00030000\" android:required=\"true\" />\n" : "";
  195. }
  196. String _get_screen_sizes_tag(const Ref<EditorExportPreset> &p_preset) {
  197. String manifest_screen_sizes = " <supports-screens \n tools:node=\"replace\"";
  198. String sizes[] = { "small", "normal", "large", "xlarge" };
  199. size_t num_sizes = sizeof(sizes) / sizeof(sizes[0]);
  200. for (size_t i = 0; i < num_sizes; i++) {
  201. String feature_name = vformat("screen/support_%s", sizes[i]);
  202. String feature_support = bool_to_string(p_preset->get(feature_name));
  203. String xml_entry = vformat("\n android:%sScreens=\"%s\"", sizes[i], feature_support);
  204. manifest_screen_sizes += xml_entry;
  205. }
  206. manifest_screen_sizes += " />\n";
  207. return manifest_screen_sizes;
  208. }
  209. String _get_xr_features_tag(const Ref<EditorExportPreset> &p_preset) {
  210. String manifest_xr_features;
  211. bool uses_xr = (int)(p_preset->get("xr_features/xr_mode")) == 1;
  212. if (uses_xr) {
  213. int dof_index = p_preset->get("xr_features/degrees_of_freedom"); // 0: none, 1: 3dof and 6dof, 2: 6dof
  214. if (dof_index == 1) {
  215. manifest_xr_features += " <uses-feature tools:node=\"replace\" android:name=\"android.hardware.vr.headtracking\" android:required=\"false\" android:version=\"1\" />\n";
  216. } else if (dof_index == 2) {
  217. manifest_xr_features += " <uses-feature tools:node=\"replace\" android:name=\"android.hardware.vr.headtracking\" android:required=\"true\" android:version=\"1\" />\n";
  218. }
  219. int hand_tracking_index = p_preset->get("xr_features/hand_tracking"); // 0: none, 1: optional, 2: required
  220. if (hand_tracking_index == 1) {
  221. manifest_xr_features += " <uses-feature tools:node=\"replace\" android:name=\"oculus.software.handtracking\" android:required=\"false\" />\n";
  222. } else if (hand_tracking_index == 2) {
  223. manifest_xr_features += " <uses-feature tools:node=\"replace\" android:name=\"oculus.software.handtracking\" android:required=\"true\" />\n";
  224. }
  225. }
  226. return manifest_xr_features;
  227. }
  228. String _get_instrumentation_tag(const Ref<EditorExportPreset> &p_preset) {
  229. String package_name = p_preset->get("package/unique_name");
  230. String manifest_instrumentation_text = vformat(
  231. " <instrumentation\n"
  232. " tools:node=\"replace\"\n"
  233. " android:name=\".GodotInstrumentation\"\n"
  234. " android:icon=\"@mipmap/icon\"\n"
  235. " android:label=\"@string/godot_project_name_string\"\n"
  236. " android:targetPackage=\"%s\" />\n",
  237. package_name);
  238. return manifest_instrumentation_text;
  239. }
  240. String _get_activity_tag(const Ref<EditorExportPreset> &p_preset) {
  241. bool uses_xr = (int)(p_preset->get("xr_features/xr_mode")) == 1;
  242. String orientation = _get_android_orientation_label(_get_screen_orientation());
  243. String manifest_activity_text = vformat(
  244. " <activity android:name=\"com.godot.game.GodotApp\" "
  245. "tools:replace=\"android:screenOrientation\" "
  246. "android:screenOrientation=\"%s\">\n",
  247. orientation);
  248. if (uses_xr) {
  249. String focus_awareness = bool_to_string(p_preset->get("xr_features/focus_awareness"));
  250. manifest_activity_text += vformat(" <meta-data tools:node=\"replace\" android:name=\"com.oculus.vr.focusaware\" android:value=\"%s\" />\n", focus_awareness);
  251. } else {
  252. manifest_activity_text += " <meta-data tools:node=\"remove\" android:name=\"com.oculus.vr.focusaware\" />\n";
  253. }
  254. manifest_activity_text += " </activity>\n";
  255. return manifest_activity_text;
  256. }
  257. String _get_application_tag(const Ref<EditorExportPreset> &p_preset, bool p_has_storage_permission) {
  258. bool uses_xr = (int)(p_preset->get("xr_features/xr_mode")) == 1;
  259. String manifest_application_text = vformat(
  260. " <application android:label=\"@string/godot_project_name_string\"\n"
  261. " android:allowBackup=\"false\" tools:ignore=\"GoogleAppIndexingWarning\"\n"
  262. " tools:replace=\"android:requestLegacyExternalStorage\" "
  263. " android:requestLegacyExternalStorage=\"%s\"\n"
  264. " android:icon=\"@mipmap/icon\">\n\n"
  265. " <meta-data tools:node=\"remove\" android:name=\"xr_mode_metadata_name\" />\n",
  266. bool_to_string(p_has_storage_permission));
  267. if (uses_xr) {
  268. manifest_application_text += " <meta-data tools:node=\"replace\" android:name=\"com.samsung.android.vr.application.mode\" android:value=\"vr_only\" />\n";
  269. }
  270. manifest_application_text += _get_activity_tag(p_preset);
  271. manifest_application_text += " </application>\n";
  272. return manifest_application_text;
  273. }
  274. #endif //GODOT_GRADLE_EXPORT_UTIL_H