export_plugin.cpp 111 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082
  1. /*************************************************************************/
  2. /* export_plugin.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 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. #include "export_plugin.h"
  31. #include "gradle_export_util.h"
  32. #include "core/config/project_settings.h"
  33. #include "core/io/dir_access.h"
  34. #include "core/io/file_access.h"
  35. #include "core/io/image_loader.h"
  36. #include "core/io/json.h"
  37. #include "core/io/marshalls.h"
  38. #include "core/version.h"
  39. #include "drivers/png/png_driver_common.h"
  40. #include "editor/editor_log.h"
  41. #include "editor/editor_node.h"
  42. #include "editor/editor_paths.h"
  43. #include "editor/editor_settings.h"
  44. #include "main/splash.gen.h"
  45. #include "platform/android/logo.gen.h"
  46. #include "platform/android/run_icon.gen.h"
  47. #include <string.h>
  48. static const char *android_perms[] = {
  49. "ACCESS_CHECKIN_PROPERTIES",
  50. "ACCESS_COARSE_LOCATION",
  51. "ACCESS_FINE_LOCATION",
  52. "ACCESS_LOCATION_EXTRA_COMMANDS",
  53. "ACCESS_MOCK_LOCATION",
  54. "ACCESS_NETWORK_STATE",
  55. "ACCESS_SURFACE_FLINGER",
  56. "ACCESS_WIFI_STATE",
  57. "ACCOUNT_MANAGER",
  58. "ADD_VOICEMAIL",
  59. "AUTHENTICATE_ACCOUNTS",
  60. "BATTERY_STATS",
  61. "BIND_ACCESSIBILITY_SERVICE",
  62. "BIND_APPWIDGET",
  63. "BIND_DEVICE_ADMIN",
  64. "BIND_INPUT_METHOD",
  65. "BIND_NFC_SERVICE",
  66. "BIND_NOTIFICATION_LISTENER_SERVICE",
  67. "BIND_PRINT_SERVICE",
  68. "BIND_REMOTEVIEWS",
  69. "BIND_TEXT_SERVICE",
  70. "BIND_VPN_SERVICE",
  71. "BIND_WALLPAPER",
  72. "BLUETOOTH",
  73. "BLUETOOTH_ADMIN",
  74. "BLUETOOTH_PRIVILEGED",
  75. "BRICK",
  76. "BROADCAST_PACKAGE_REMOVED",
  77. "BROADCAST_SMS",
  78. "BROADCAST_STICKY",
  79. "BROADCAST_WAP_PUSH",
  80. "CALL_PHONE",
  81. "CALL_PRIVILEGED",
  82. "CAMERA",
  83. "CAPTURE_AUDIO_OUTPUT",
  84. "CAPTURE_SECURE_VIDEO_OUTPUT",
  85. "CAPTURE_VIDEO_OUTPUT",
  86. "CHANGE_COMPONENT_ENABLED_STATE",
  87. "CHANGE_CONFIGURATION",
  88. "CHANGE_NETWORK_STATE",
  89. "CHANGE_WIFI_MULTICAST_STATE",
  90. "CHANGE_WIFI_STATE",
  91. "CLEAR_APP_CACHE",
  92. "CLEAR_APP_USER_DATA",
  93. "CONTROL_LOCATION_UPDATES",
  94. "DELETE_CACHE_FILES",
  95. "DELETE_PACKAGES",
  96. "DEVICE_POWER",
  97. "DIAGNOSTIC",
  98. "DISABLE_KEYGUARD",
  99. "DUMP",
  100. "EXPAND_STATUS_BAR",
  101. "FACTORY_TEST",
  102. "FLASHLIGHT",
  103. "FORCE_BACK",
  104. "GET_ACCOUNTS",
  105. "GET_PACKAGE_SIZE",
  106. "GET_TASKS",
  107. "GET_TOP_ACTIVITY_INFO",
  108. "GLOBAL_SEARCH",
  109. "HARDWARE_TEST",
  110. "INJECT_EVENTS",
  111. "INSTALL_LOCATION_PROVIDER",
  112. "INSTALL_PACKAGES",
  113. "INSTALL_SHORTCUT",
  114. "INTERNAL_SYSTEM_WINDOW",
  115. "INTERNET",
  116. "KILL_BACKGROUND_PROCESSES",
  117. "LOCATION_HARDWARE",
  118. "MANAGE_ACCOUNTS",
  119. "MANAGE_APP_TOKENS",
  120. "MANAGE_DOCUMENTS",
  121. "MASTER_CLEAR",
  122. "MEDIA_CONTENT_CONTROL",
  123. "MODIFY_AUDIO_SETTINGS",
  124. "MODIFY_PHONE_STATE",
  125. "MOUNT_FORMAT_FILESYSTEMS",
  126. "MOUNT_UNMOUNT_FILESYSTEMS",
  127. "NFC",
  128. "PERSISTENT_ACTIVITY",
  129. "PROCESS_OUTGOING_CALLS",
  130. "READ_CALENDAR",
  131. "READ_CALL_LOG",
  132. "READ_CONTACTS",
  133. "READ_EXTERNAL_STORAGE",
  134. "READ_FRAME_BUFFER",
  135. "READ_HISTORY_BOOKMARKS",
  136. "READ_INPUT_STATE",
  137. "READ_LOGS",
  138. "READ_PHONE_STATE",
  139. "READ_PROFILE",
  140. "READ_SMS",
  141. "READ_SOCIAL_STREAM",
  142. "READ_SYNC_SETTINGS",
  143. "READ_SYNC_STATS",
  144. "READ_USER_DICTIONARY",
  145. "REBOOT",
  146. "RECEIVE_BOOT_COMPLETED",
  147. "RECEIVE_MMS",
  148. "RECEIVE_SMS",
  149. "RECEIVE_WAP_PUSH",
  150. "RECORD_AUDIO",
  151. "REORDER_TASKS",
  152. "RESTART_PACKAGES",
  153. "SEND_RESPOND_VIA_MESSAGE",
  154. "SEND_SMS",
  155. "SET_ACTIVITY_WATCHER",
  156. "SET_ALARM",
  157. "SET_ALWAYS_FINISH",
  158. "SET_ANIMATION_SCALE",
  159. "SET_DEBUG_APP",
  160. "SET_ORIENTATION",
  161. "SET_POINTER_SPEED",
  162. "SET_PREFERRED_APPLICATIONS",
  163. "SET_PROCESS_LIMIT",
  164. "SET_TIME",
  165. "SET_TIME_ZONE",
  166. "SET_WALLPAPER",
  167. "SET_WALLPAPER_HINTS",
  168. "SIGNAL_PERSISTENT_PROCESSES",
  169. "STATUS_BAR",
  170. "SUBSCRIBED_FEEDS_READ",
  171. "SUBSCRIBED_FEEDS_WRITE",
  172. "SYSTEM_ALERT_WINDOW",
  173. "TRANSMIT_IR",
  174. "UNINSTALL_SHORTCUT",
  175. "UPDATE_DEVICE_STATS",
  176. "USE_CREDENTIALS",
  177. "USE_SIP",
  178. "VIBRATE",
  179. "WAKE_LOCK",
  180. "WRITE_APN_SETTINGS",
  181. "WRITE_CALENDAR",
  182. "WRITE_CALL_LOG",
  183. "WRITE_CONTACTS",
  184. "WRITE_EXTERNAL_STORAGE",
  185. "WRITE_GSERVICES",
  186. "WRITE_HISTORY_BOOKMARKS",
  187. "WRITE_PROFILE",
  188. "WRITE_SECURE_SETTINGS",
  189. "WRITE_SETTINGS",
  190. "WRITE_SMS",
  191. "WRITE_SOCIAL_STREAM",
  192. "WRITE_SYNC_SETTINGS",
  193. "WRITE_USER_DICTIONARY",
  194. nullptr
  195. };
  196. static const char *SPLASH_IMAGE_EXPORT_PATH = "res/drawable-nodpi/splash.png";
  197. static const char *LEGACY_BUILD_SPLASH_IMAGE_EXPORT_PATH = "res/drawable-nodpi-v4/splash.png";
  198. static const char *SPLASH_BG_COLOR_PATH = "res/drawable-nodpi/splash_bg_color.png";
  199. static const char *LEGACY_BUILD_SPLASH_BG_COLOR_PATH = "res/drawable-nodpi-v4/splash_bg_color.png";
  200. static const char *SPLASH_CONFIG_PATH = "res://android/build/res/drawable/splash_drawable.xml";
  201. static const char *GDNATIVE_LIBS_PATH = "res://android/build/libs/gdnativelibs.json";
  202. static const int icon_densities_count = 6;
  203. static const char *launcher_icon_option = "launcher_icons/main_192x192";
  204. static const char *launcher_adaptive_icon_foreground_option = "launcher_icons/adaptive_foreground_432x432";
  205. static const char *launcher_adaptive_icon_background_option = "launcher_icons/adaptive_background_432x432";
  206. static const LauncherIcon launcher_icons[icon_densities_count] = {
  207. { "res/mipmap-xxxhdpi-v4/icon.png", 192 },
  208. { "res/mipmap-xxhdpi-v4/icon.png", 144 },
  209. { "res/mipmap-xhdpi-v4/icon.png", 96 },
  210. { "res/mipmap-hdpi-v4/icon.png", 72 },
  211. { "res/mipmap-mdpi-v4/icon.png", 48 },
  212. { "res/mipmap/icon.png", 192 }
  213. };
  214. static const LauncherIcon launcher_adaptive_icon_foregrounds[icon_densities_count] = {
  215. { "res/mipmap-xxxhdpi-v4/icon_foreground.png", 432 },
  216. { "res/mipmap-xxhdpi-v4/icon_foreground.png", 324 },
  217. { "res/mipmap-xhdpi-v4/icon_foreground.png", 216 },
  218. { "res/mipmap-hdpi-v4/icon_foreground.png", 162 },
  219. { "res/mipmap-mdpi-v4/icon_foreground.png", 108 },
  220. { "res/mipmap/icon_foreground.png", 432 }
  221. };
  222. static const LauncherIcon launcher_adaptive_icon_backgrounds[icon_densities_count] = {
  223. { "res/mipmap-xxxhdpi-v4/icon_background.png", 432 },
  224. { "res/mipmap-xxhdpi-v4/icon_background.png", 324 },
  225. { "res/mipmap-xhdpi-v4/icon_background.png", 216 },
  226. { "res/mipmap-hdpi-v4/icon_background.png", 162 },
  227. { "res/mipmap-mdpi-v4/icon_background.png", 108 },
  228. { "res/mipmap/icon_background.png", 432 }
  229. };
  230. static const int EXPORT_FORMAT_APK = 0;
  231. static const int EXPORT_FORMAT_AAB = 1;
  232. static const char *APK_ASSETS_DIRECTORY = "res://android/build/assets";
  233. static const char *AAB_ASSETS_DIRECTORY = "res://android/build/assetPacks/installTime/src/main/assets";
  234. static const int DEFAULT_MIN_SDK_VERSION = 19; // Should match the value in 'platform/android/java/app/config.gradle#minSdk'
  235. static const int DEFAULT_TARGET_SDK_VERSION = 30; // Should match the value in 'platform/android/java/app/config.gradle#targetSdk'
  236. const String SDK_VERSION_RANGE = vformat("%s,%s,1", DEFAULT_MIN_SDK_VERSION, DEFAULT_TARGET_SDK_VERSION);
  237. void EditorExportPlatformAndroid::_check_for_changes_poll_thread(void *ud) {
  238. EditorExportPlatformAndroid *ea = (EditorExportPlatformAndroid *)ud;
  239. while (!ea->quit_request.is_set()) {
  240. // Check for plugins updates
  241. {
  242. // Nothing to do if we already know the plugins have changed.
  243. if (!ea->plugins_changed.is_set()) {
  244. Vector<PluginConfigAndroid> loaded_plugins = get_plugins();
  245. MutexLock lock(ea->plugins_lock);
  246. if (ea->plugins.size() != loaded_plugins.size()) {
  247. ea->plugins_changed.set();
  248. } else {
  249. for (int i = 0; i < ea->plugins.size(); i++) {
  250. if (ea->plugins[i].name != loaded_plugins[i].name) {
  251. ea->plugins_changed.set();
  252. break;
  253. }
  254. }
  255. }
  256. if (ea->plugins_changed.is_set()) {
  257. ea->plugins = loaded_plugins;
  258. }
  259. }
  260. }
  261. // Check for devices updates
  262. String adb = get_adb_path();
  263. if (FileAccess::exists(adb)) {
  264. String devices;
  265. List<String> args;
  266. args.push_back("devices");
  267. int ec;
  268. OS::get_singleton()->execute(adb, args, &devices, &ec);
  269. Vector<String> ds = devices.split("\n");
  270. Vector<String> ldevices;
  271. for (int i = 1; i < ds.size(); i++) {
  272. String d = ds[i];
  273. int dpos = d.find("device");
  274. if (dpos == -1) {
  275. continue;
  276. }
  277. d = d.substr(0, dpos).strip_edges();
  278. ldevices.push_back(d);
  279. }
  280. MutexLock lock(ea->device_lock);
  281. bool different = false;
  282. if (ea->devices.size() != ldevices.size()) {
  283. different = true;
  284. } else {
  285. for (int i = 0; i < ea->devices.size(); i++) {
  286. if (ea->devices[i].id != ldevices[i]) {
  287. different = true;
  288. break;
  289. }
  290. }
  291. }
  292. if (different) {
  293. Vector<Device> ndevices;
  294. for (int i = 0; i < ldevices.size(); i++) {
  295. Device d;
  296. d.id = ldevices[i];
  297. for (int j = 0; j < ea->devices.size(); j++) {
  298. if (ea->devices[j].id == ldevices[i]) {
  299. d.description = ea->devices[j].description;
  300. d.name = ea->devices[j].name;
  301. d.api_level = ea->devices[j].api_level;
  302. }
  303. }
  304. if (d.description.is_empty()) {
  305. //in the oven, request!
  306. args.clear();
  307. args.push_back("-s");
  308. args.push_back(d.id);
  309. args.push_back("shell");
  310. args.push_back("getprop");
  311. int ec2;
  312. String dp;
  313. OS::get_singleton()->execute(adb, args, &dp, &ec2);
  314. Vector<String> props = dp.split("\n");
  315. String vendor;
  316. String device;
  317. d.description = "Device ID: " + d.id + "\n";
  318. d.api_level = 0;
  319. for (int j = 0; j < props.size(); j++) {
  320. // got information by `shell cat /system/build.prop` before and its format is "property=value"
  321. // it's now changed to use `shell getporp` because of permission issue with Android 8.0 and above
  322. // its format is "[property]: [value]" so changed it as like build.prop
  323. String p = props[j];
  324. p = p.replace("]: ", "=");
  325. p = p.replace("[", "");
  326. p = p.replace("]", "");
  327. if (p.begins_with("ro.product.model=")) {
  328. device = p.get_slice("=", 1).strip_edges();
  329. } else if (p.begins_with("ro.product.brand=")) {
  330. vendor = p.get_slice("=", 1).strip_edges().capitalize();
  331. } else if (p.begins_with("ro.build.display.id=")) {
  332. d.description += "Build: " + p.get_slice("=", 1).strip_edges() + "\n";
  333. } else if (p.begins_with("ro.build.version.release=")) {
  334. d.description += "Release: " + p.get_slice("=", 1).strip_edges() + "\n";
  335. } else if (p.begins_with("ro.build.version.sdk=")) {
  336. d.api_level = p.get_slice("=", 1).to_int();
  337. } else if (p.begins_with("ro.product.cpu.abi=")) {
  338. d.description += "CPU: " + p.get_slice("=", 1).strip_edges() + "\n";
  339. } else if (p.begins_with("ro.product.manufacturer=")) {
  340. d.description += "Manufacturer: " + p.get_slice("=", 1).strip_edges() + "\n";
  341. } else if (p.begins_with("ro.board.platform=")) {
  342. d.description += "Chipset: " + p.get_slice("=", 1).strip_edges() + "\n";
  343. } else if (p.begins_with("ro.opengles.version=")) {
  344. uint32_t opengl = p.get_slice("=", 1).to_int();
  345. d.description += "OpenGL: " + itos(opengl >> 16) + "." + itos((opengl >> 8) & 0xFF) + "." + itos((opengl)&0xFF) + "\n";
  346. }
  347. }
  348. d.name = vendor + " " + device;
  349. if (device.is_empty()) {
  350. continue;
  351. }
  352. }
  353. ndevices.push_back(d);
  354. }
  355. ea->devices = ndevices;
  356. ea->devices_changed.set();
  357. }
  358. }
  359. uint64_t sleep = 200;
  360. uint64_t wait = 3000000;
  361. uint64_t time = OS::get_singleton()->get_ticks_usec();
  362. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  363. OS::get_singleton()->delay_usec(1000 * sleep);
  364. if (ea->quit_request.is_set()) {
  365. break;
  366. }
  367. }
  368. }
  369. if (EditorSettings::get_singleton()->get("export/android/shutdown_adb_on_exit")) {
  370. String adb = get_adb_path();
  371. if (!FileAccess::exists(adb)) {
  372. return; //adb not configured
  373. }
  374. List<String> args;
  375. args.push_back("kill-server");
  376. OS::get_singleton()->execute(adb, args);
  377. };
  378. }
  379. String EditorExportPlatformAndroid::get_project_name(const String &p_name) const {
  380. String aname;
  381. if (!p_name.is_empty()) {
  382. aname = p_name;
  383. } else {
  384. aname = ProjectSettings::get_singleton()->get("application/config/name");
  385. }
  386. if (aname.is_empty()) {
  387. aname = VERSION_NAME;
  388. }
  389. return aname;
  390. }
  391. String EditorExportPlatformAndroid::get_package_name(const String &p_package) const {
  392. String pname = p_package;
  393. String basename = ProjectSettings::get_singleton()->get("application/config/name");
  394. basename = basename.to_lower();
  395. String name;
  396. bool first = true;
  397. for (int i = 0; i < basename.length(); i++) {
  398. char32_t c = basename[i];
  399. if (is_digit(c) && first) {
  400. continue;
  401. }
  402. if (is_ascii_alphanumeric_char(c)) {
  403. name += String::chr(c);
  404. first = false;
  405. }
  406. }
  407. if (name.is_empty()) {
  408. name = "noname";
  409. }
  410. pname = pname.replace("$genname", name);
  411. return pname;
  412. }
  413. String EditorExportPlatformAndroid::get_assets_directory(const Ref<EditorExportPreset> &p_preset, int p_export_format) const {
  414. return p_export_format == EXPORT_FORMAT_AAB ? AAB_ASSETS_DIRECTORY : APK_ASSETS_DIRECTORY;
  415. }
  416. bool EditorExportPlatformAndroid::is_package_name_valid(const String &p_package, String *r_error) const {
  417. String pname = p_package;
  418. if (pname.length() == 0) {
  419. if (r_error) {
  420. *r_error = TTR("Package name is missing.");
  421. }
  422. return false;
  423. }
  424. int segments = 0;
  425. bool first = true;
  426. for (int i = 0; i < pname.length(); i++) {
  427. char32_t c = pname[i];
  428. if (first && c == '.') {
  429. if (r_error) {
  430. *r_error = TTR("Package segments must be of non-zero length.");
  431. }
  432. return false;
  433. }
  434. if (c == '.') {
  435. segments++;
  436. first = true;
  437. continue;
  438. }
  439. if (!is_ascii_identifier_char(c)) {
  440. if (r_error) {
  441. *r_error = vformat(TTR("The character '%s' is not allowed in Android application package names."), String::chr(c));
  442. }
  443. return false;
  444. }
  445. if (first && is_digit(c)) {
  446. if (r_error) {
  447. *r_error = TTR("A digit cannot be the first character in a package segment.");
  448. }
  449. return false;
  450. }
  451. if (first && is_underscore(c)) {
  452. if (r_error) {
  453. *r_error = vformat(TTR("The character '%s' cannot be the first character in a package segment."), String::chr(c));
  454. }
  455. return false;
  456. }
  457. first = false;
  458. }
  459. if (segments == 0) {
  460. if (r_error) {
  461. *r_error = TTR("The package must have at least one '.' separator.");
  462. }
  463. return false;
  464. }
  465. if (first) {
  466. if (r_error) {
  467. *r_error = TTR("Package segments must be of non-zero length.");
  468. }
  469. return false;
  470. }
  471. return true;
  472. }
  473. bool EditorExportPlatformAndroid::_should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  474. /*
  475. * By not compressing files with little or not benefit in doing so,
  476. * a performance gain is expected attime. Moreover, if the APK is
  477. * zip-aligned, assets stored as they are can be efficiently read by
  478. * Android by memory-mapping them.
  479. */
  480. // -- Unconditional uncompress to mimic AAPT plus some other
  481. static const char *unconditional_compress_ext[] = {
  482. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  483. // These formats are already compressed, or don't compress well:
  484. ".jpg", ".jpeg", ".png", ".gif",
  485. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  486. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  487. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  488. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  489. ".amr", ".awb", ".wma", ".wmv",
  490. // Godot-specific:
  491. ".webp", // Same reasoning as .png
  492. ".cfb", // Don't let small config files slow-down startup
  493. ".scn", // Binary scenes are usually already compressed
  494. ".ctex", // Streamable textures are usually already compressed
  495. // Trailer for easier processing
  496. nullptr
  497. };
  498. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  499. if (p_path.to_lower().ends_with(String(*ext))) {
  500. return false;
  501. }
  502. }
  503. // -- Compressed resource?
  504. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  505. // Already compressed
  506. return false;
  507. }
  508. // --- TODO: Decide on texture resources according to their image compression setting
  509. return true;
  510. }
  511. zip_fileinfo EditorExportPlatformAndroid::get_zip_fileinfo() {
  512. OS::Time time = OS::get_singleton()->get_time();
  513. OS::Date date = OS::get_singleton()->get_date();
  514. zip_fileinfo zipfi;
  515. zipfi.tmz_date.tm_hour = time.hour;
  516. zipfi.tmz_date.tm_mday = date.day;
  517. zipfi.tmz_date.tm_min = time.minute;
  518. zipfi.tmz_date.tm_mon = date.month - 1; // tm_mon is zero indexed
  519. zipfi.tmz_date.tm_sec = time.second;
  520. zipfi.tmz_date.tm_year = date.year;
  521. zipfi.dosDate = 0;
  522. zipfi.external_fa = 0;
  523. zipfi.internal_fa = 0;
  524. return zipfi;
  525. }
  526. Vector<String> EditorExportPlatformAndroid::get_abis() {
  527. Vector<String> abis;
  528. abis.push_back("armeabi-v7a");
  529. abis.push_back("arm64-v8a");
  530. abis.push_back("x86");
  531. abis.push_back("x86_64");
  532. return abis;
  533. }
  534. /// List the gdap files in the directory specified by the p_path parameter.
  535. Vector<String> EditorExportPlatformAndroid::list_gdap_files(const String &p_path) {
  536. Vector<String> dir_files;
  537. DirAccessRef da = DirAccess::open(p_path);
  538. if (da) {
  539. da->list_dir_begin();
  540. while (true) {
  541. String file = da->get_next();
  542. if (file.is_empty()) {
  543. break;
  544. }
  545. if (da->current_is_dir() || da->current_is_hidden()) {
  546. continue;
  547. }
  548. if (file.ends_with(PluginConfigAndroid::PLUGIN_CONFIG_EXT)) {
  549. dir_files.push_back(file);
  550. }
  551. }
  552. da->list_dir_end();
  553. }
  554. return dir_files;
  555. }
  556. Vector<PluginConfigAndroid> EditorExportPlatformAndroid::get_plugins() {
  557. Vector<PluginConfigAndroid> loaded_plugins;
  558. String plugins_dir = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/plugins");
  559. // Add the prebuilt plugins
  560. loaded_plugins.append_array(PluginConfigAndroid::get_prebuilt_plugins(plugins_dir));
  561. if (DirAccess::exists(plugins_dir)) {
  562. Vector<String> plugins_filenames = list_gdap_files(plugins_dir);
  563. if (!plugins_filenames.is_empty()) {
  564. Ref<ConfigFile> config_file = memnew(ConfigFile);
  565. for (int i = 0; i < plugins_filenames.size(); i++) {
  566. PluginConfigAndroid config = PluginConfigAndroid::load_plugin_config(config_file, plugins_dir.plus_file(plugins_filenames[i]));
  567. if (config.valid_config) {
  568. loaded_plugins.push_back(config);
  569. } else {
  570. print_error("Invalid plugin config file " + plugins_filenames[i]);
  571. }
  572. }
  573. }
  574. }
  575. return loaded_plugins;
  576. }
  577. Vector<PluginConfigAndroid> EditorExportPlatformAndroid::get_enabled_plugins(const Ref<EditorExportPreset> &p_presets) {
  578. Vector<PluginConfigAndroid> enabled_plugins;
  579. Vector<PluginConfigAndroid> all_plugins = get_plugins();
  580. for (int i = 0; i < all_plugins.size(); i++) {
  581. PluginConfigAndroid plugin = all_plugins[i];
  582. bool enabled = p_presets->get("plugins/" + plugin.name);
  583. if (enabled) {
  584. enabled_plugins.push_back(plugin);
  585. }
  586. }
  587. return enabled_plugins;
  588. }
  589. Error EditorExportPlatformAndroid::store_in_apk(APKExportData *ed, const String &p_path, const Vector<uint8_t> &p_data, int compression_method) {
  590. zip_fileinfo zipfi = get_zip_fileinfo();
  591. zipOpenNewFileInZip(ed->apk,
  592. p_path.utf8().get_data(),
  593. &zipfi,
  594. nullptr,
  595. 0,
  596. nullptr,
  597. 0,
  598. nullptr,
  599. compression_method,
  600. Z_DEFAULT_COMPRESSION);
  601. zipWriteInFileInZip(ed->apk, p_data.ptr(), p_data.size());
  602. zipCloseFileInZip(ed->apk);
  603. return OK;
  604. }
  605. Error EditorExportPlatformAndroid::save_apk_so(void *p_userdata, const SharedObject &p_so) {
  606. if (!p_so.path.get_file().begins_with("lib")) {
  607. String err = "Android .so file names must start with \"lib\", but got: " + p_so.path;
  608. ERR_PRINT(err);
  609. return FAILED;
  610. }
  611. APKExportData *ed = (APKExportData *)p_userdata;
  612. Vector<String> abis = get_abis();
  613. bool exported = false;
  614. for (int i = 0; i < p_so.tags.size(); ++i) {
  615. // shared objects can be fat (compatible with multiple ABIs)
  616. int abi_index = abis.find(p_so.tags[i]);
  617. if (abi_index != -1) {
  618. exported = true;
  619. String abi = abis[abi_index];
  620. String dst_path = String("lib").plus_file(abi).plus_file(p_so.path.get_file());
  621. Vector<uint8_t> array = FileAccess::get_file_as_array(p_so.path);
  622. Error store_err = store_in_apk(ed, dst_path, array);
  623. ERR_FAIL_COND_V_MSG(store_err, store_err, "Cannot store in apk file '" + dst_path + "'.");
  624. }
  625. }
  626. if (!exported) {
  627. String abis_string = String(" ").join(abis);
  628. String err = "Cannot determine ABI for library \"" + p_so.path + "\". One of the supported ABIs must be used as a tag: " + abis_string;
  629. ERR_PRINT(err);
  630. return FAILED;
  631. }
  632. return OK;
  633. }
  634. Error EditorExportPlatformAndroid::save_apk_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) {
  635. APKExportData *ed = (APKExportData *)p_userdata;
  636. String dst_path = p_path.replace_first("res://", "assets/");
  637. store_in_apk(ed, dst_path, p_data, _should_compress_asset(p_path, p_data) ? Z_DEFLATED : 0);
  638. return OK;
  639. }
  640. Error EditorExportPlatformAndroid::ignore_apk_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) {
  641. return OK;
  642. }
  643. Error EditorExportPlatformAndroid::copy_gradle_so(void *p_userdata, const SharedObject &p_so) {
  644. ERR_FAIL_COND_V_MSG(!p_so.path.get_file().begins_with("lib"), FAILED,
  645. "Android .so file names must start with \"lib\", but got: " + p_so.path);
  646. Vector<String> abis = get_abis();
  647. CustomExportData *export_data = (CustomExportData *)p_userdata;
  648. bool exported = false;
  649. for (int i = 0; i < p_so.tags.size(); ++i) {
  650. int abi_index = abis.find(p_so.tags[i]);
  651. if (abi_index != -1) {
  652. exported = true;
  653. String base = "res://android/build/libs";
  654. String type = export_data->debug ? "debug" : "release";
  655. String abi = abis[abi_index];
  656. String filename = p_so.path.get_file();
  657. String dst_path = base.plus_file(type).plus_file(abi).plus_file(filename);
  658. Vector<uint8_t> data = FileAccess::get_file_as_array(p_so.path);
  659. print_verbose("Copying .so file from " + p_so.path + " to " + dst_path);
  660. Error err = store_file_at_path(dst_path, data);
  661. ERR_FAIL_COND_V_MSG(err, err, "Failed to copy .so file from " + p_so.path + " to " + dst_path);
  662. export_data->libs.push_back(dst_path);
  663. }
  664. }
  665. ERR_FAIL_COND_V_MSG(!exported, FAILED,
  666. "Cannot determine ABI for library \"" + p_so.path + "\". One of the supported ABIs must be used as a tag: " + String(" ").join(abis));
  667. return OK;
  668. }
  669. bool EditorExportPlatformAndroid::_has_storage_permission(const Vector<String> &p_permissions) {
  670. return p_permissions.find("android.permission.READ_EXTERNAL_STORAGE") != -1 || p_permissions.find("android.permission.WRITE_EXTERNAL_STORAGE") != -1;
  671. }
  672. void EditorExportPlatformAndroid::_get_permissions(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, Vector<String> &r_permissions) {
  673. const char **aperms = android_perms;
  674. while (*aperms) {
  675. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  676. if (enabled) {
  677. r_permissions.push_back("android.permission." + String(*aperms));
  678. }
  679. aperms++;
  680. }
  681. PackedStringArray user_perms = p_preset->get("permissions/custom_permissions");
  682. for (int i = 0; i < user_perms.size(); i++) {
  683. String user_perm = user_perms[i].strip_edges();
  684. if (!user_perm.is_empty()) {
  685. r_permissions.push_back(user_perm);
  686. }
  687. }
  688. if (p_give_internet) {
  689. if (r_permissions.find("android.permission.INTERNET") == -1) {
  690. r_permissions.push_back("android.permission.INTERNET");
  691. }
  692. }
  693. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  694. if (xr_mode_index == XR_MODE_OPENXR) {
  695. int hand_tracking_index = p_preset->get("xr_features/hand_tracking"); // 0: none, 1: optional, 2: required
  696. if (hand_tracking_index > XR_HAND_TRACKING_NONE) {
  697. if (r_permissions.find("com.oculus.permission.HAND_TRACKING") == -1) {
  698. r_permissions.push_back("com.oculus.permission.HAND_TRACKING");
  699. }
  700. }
  701. }
  702. }
  703. void EditorExportPlatformAndroid::_write_tmp_manifest(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, bool p_debug) {
  704. print_verbose("Building temporary manifest..");
  705. String manifest_text =
  706. "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
  707. "<manifest xmlns:android=\"http://schemas.android.com/apk/res/android\"\n"
  708. " xmlns:tools=\"http://schemas.android.com/tools\">\n";
  709. manifest_text += _get_screen_sizes_tag(p_preset);
  710. manifest_text += _get_gles_tag();
  711. Vector<String> perms;
  712. _get_permissions(p_preset, p_give_internet, perms);
  713. for (int i = 0; i < perms.size(); i++) {
  714. String permission = perms.get(i);
  715. if (permission == "android.permission.WRITE_EXTERNAL_STORAGE" || permission == "android.permission.READ_EXTERNAL_STORAGE") {
  716. manifest_text += vformat(" <uses-permission android:name=\"%s\" android:maxSdkVersion=\"29\" />\n", permission);
  717. } else {
  718. manifest_text += vformat(" <uses-permission android:name=\"%s\" />\n", permission);
  719. }
  720. }
  721. manifest_text += _get_xr_features_tag(p_preset);
  722. manifest_text += _get_instrumentation_tag(p_preset);
  723. manifest_text += _get_application_tag(p_preset, _has_storage_permission(perms));
  724. manifest_text += "</manifest>\n";
  725. String manifest_path = vformat("res://android/build/src/%s/AndroidManifest.xml", (p_debug ? "debug" : "release"));
  726. print_verbose("Storing manifest into " + manifest_path + ": " + "\n" + manifest_text);
  727. store_string_at_path(manifest_path, manifest_text);
  728. }
  729. void EditorExportPlatformAndroid::_fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  730. // Leaving the unused types commented because looking these constants up
  731. // again later would be annoying
  732. // const int CHUNK_AXML_FILE = 0x00080003;
  733. // const int CHUNK_RESOURCEIDS = 0x00080180;
  734. const int CHUNK_STRINGS = 0x001C0001;
  735. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  736. const int CHUNK_XML_END_TAG = 0x00100103;
  737. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  738. const int CHUNK_XML_START_TAG = 0x00100102;
  739. // const int CHUNK_XML_TEXT = 0x00100104;
  740. const int UTF8_FLAG = 0x00000100;
  741. Vector<String> string_table;
  742. uint32_t ofs = 8;
  743. uint32_t string_count = 0;
  744. //uint32_t styles_count = 0;
  745. uint32_t string_flags = 0;
  746. uint32_t string_data_offset = 0;
  747. //uint32_t styles_offset = 0;
  748. uint32_t string_table_begins = 0;
  749. uint32_t string_table_ends = 0;
  750. Vector<uint8_t> stable_extra;
  751. String version_name = p_preset->get("version/name");
  752. int version_code = p_preset->get("version/code");
  753. String package_name = p_preset->get("package/unique_name");
  754. const int screen_orientation =
  755. _get_android_orientation_value(DisplayServer::ScreenOrientation(int(GLOBAL_GET("display/window/handheld/orientation"))));
  756. bool screen_support_small = p_preset->get("screen/support_small");
  757. bool screen_support_normal = p_preset->get("screen/support_normal");
  758. bool screen_support_large = p_preset->get("screen/support_large");
  759. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  760. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  761. int hand_tracking_index = p_preset->get("xr_features/hand_tracking");
  762. int hand_tracking_frequency_index = p_preset->get("xr_features/hand_tracking_frequency");
  763. bool backup_allowed = p_preset->get("user_data_backup/allow");
  764. bool classify_as_game = p_preset->get("package/classify_as_game");
  765. bool retain_data_on_uninstall = p_preset->get("package/retain_data_on_uninstall");
  766. bool exclude_from_recents = p_preset->get("package/exclude_from_recents");
  767. bool is_resizeable = bool(GLOBAL_GET("display/window/size/resizable"));
  768. Vector<String> perms;
  769. // Write permissions into the perms variable.
  770. _get_permissions(p_preset, p_give_internet, perms);
  771. bool has_storage_permission = _has_storage_permission(perms);
  772. while (ofs < (uint32_t)p_manifest.size()) {
  773. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  774. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  775. switch (chunk) {
  776. case CHUNK_STRINGS: {
  777. int iofs = ofs + 8;
  778. string_count = decode_uint32(&p_manifest[iofs]);
  779. // iofs + 4 is `styles_count`.
  780. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  781. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  782. // iofs + 16 is `styles_offset`.
  783. uint32_t st_offset = iofs + 20;
  784. string_table.resize(string_count);
  785. uint32_t string_end = 0;
  786. string_table_begins = st_offset;
  787. for (uint32_t i = 0; i < string_count; i++) {
  788. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  789. string_at += st_offset + string_count * 4;
  790. ERR_FAIL_COND_MSG(string_flags & UTF8_FLAG, "Unimplemented, can't read UTF-8 string table.");
  791. if (string_flags & UTF8_FLAG) {
  792. } else {
  793. uint32_t len = decode_uint16(&p_manifest[string_at]);
  794. Vector<char32_t> ucstring;
  795. ucstring.resize(len + 1);
  796. for (uint32_t j = 0; j < len; j++) {
  797. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  798. ucstring.write[j] = c;
  799. }
  800. string_end = MAX(string_at + 2 + 2 * len, string_end);
  801. ucstring.write[len] = 0;
  802. string_table.write[i] = ucstring.ptr();
  803. }
  804. }
  805. for (uint32_t i = string_end; i < (ofs + size); i++) {
  806. stable_extra.push_back(p_manifest[i]);
  807. }
  808. string_table_ends = ofs + size;
  809. } break;
  810. case CHUNK_XML_START_TAG: {
  811. int iofs = ofs + 8;
  812. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  813. String tname = string_table[name];
  814. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  815. iofs += 28;
  816. for (uint32_t i = 0; i < attrcount; i++) {
  817. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  818. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  819. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  820. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  821. const String value = (attr_value != 0xFFFFFFFF) ? string_table[attr_value] : "Res #" + itos(attr_resid);
  822. String attrname = string_table[attr_name];
  823. const String nspace = (attr_nspace != 0xFFFFFFFF) ? string_table[attr_nspace] : "";
  824. //replace project information
  825. if (tname == "manifest" && attrname == "package") {
  826. string_table.write[attr_value] = get_package_name(package_name);
  827. }
  828. if (tname == "manifest" && attrname == "versionCode") {
  829. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  830. }
  831. if (tname == "manifest" && attrname == "versionName") {
  832. if (attr_value == 0xFFFFFFFF) {
  833. WARN_PRINT("Version name in a resource, should be plain text");
  834. } else {
  835. string_table.write[attr_value] = version_name;
  836. }
  837. }
  838. if (tname == "application" && attrname == "requestLegacyExternalStorage") {
  839. encode_uint32(has_storage_permission ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  840. }
  841. if (tname == "application" && attrname == "allowBackup") {
  842. encode_uint32(backup_allowed, &p_manifest.write[iofs + 16]);
  843. }
  844. if (tname == "application" && attrname == "isGame") {
  845. encode_uint32(classify_as_game, &p_manifest.write[iofs + 16]);
  846. }
  847. if (tname == "application" && attrname == "hasFragileUserData") {
  848. encode_uint32(retain_data_on_uninstall, &p_manifest.write[iofs + 16]);
  849. }
  850. if (tname == "instrumentation" && attrname == "targetPackage") {
  851. string_table.write[attr_value] = get_package_name(package_name);
  852. }
  853. if (tname == "activity" && attrname == "screenOrientation") {
  854. encode_uint32(screen_orientation, &p_manifest.write[iofs + 16]);
  855. }
  856. if (tname == "activity" && attrname == "excludeFromRecents") {
  857. encode_uint32(exclude_from_recents, &p_manifest.write[iofs + 16]);
  858. }
  859. if (tname == "activity" && attrname == "resizeableActivity") {
  860. encode_uint32(is_resizeable, &p_manifest.write[iofs + 16]);
  861. }
  862. if (tname == "supports-screens") {
  863. if (attrname == "smallScreens") {
  864. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  865. } else if (attrname == "normalScreens") {
  866. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  867. } else if (attrname == "largeScreens") {
  868. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  869. } else if (attrname == "xlargeScreens") {
  870. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  871. }
  872. }
  873. if (tname == "meta-data" && attrname == "name" && value == "xr_hand_tracking_metadata_name") {
  874. if (xr_mode_index == XR_MODE_OPENXR && hand_tracking_index > XR_HAND_TRACKING_NONE) {
  875. string_table.write[attr_value] = "com.oculus.handtracking.frequency";
  876. }
  877. }
  878. if (tname == "meta-data" && attrname == "value" && value == "xr_hand_tracking_metadata_value") {
  879. if (xr_mode_index == XR_MODE_OPENXR && hand_tracking_index > XR_HAND_TRACKING_NONE) {
  880. string_table.write[attr_value] = (hand_tracking_frequency_index == XR_HAND_TRACKING_FREQUENCY_LOW ? "LOW" : "HIGH");
  881. }
  882. }
  883. iofs += 20;
  884. }
  885. } break;
  886. case CHUNK_XML_END_TAG: {
  887. int iofs = ofs + 8;
  888. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  889. String tname = string_table[name];
  890. if (tname == "uses-feature") {
  891. Vector<String> feature_names;
  892. Vector<bool> feature_required_list;
  893. Vector<int> feature_versions;
  894. if (xr_mode_index == XR_MODE_OPENXR) {
  895. // Set degrees of freedom
  896. feature_names.push_back("android.hardware.vr.headtracking");
  897. feature_required_list.push_back(true);
  898. feature_versions.push_back(1);
  899. // Check for hand tracking
  900. if (hand_tracking_index > XR_HAND_TRACKING_NONE) {
  901. feature_names.push_back("oculus.software.handtracking");
  902. feature_required_list.push_back(hand_tracking_index == XR_HAND_TRACKING_REQUIRED);
  903. feature_versions.push_back(-1); // no version attribute should be added.
  904. }
  905. // Check for passthrough
  906. int passthrough_mode = p_preset->get("xr_features/passthrough");
  907. if (passthrough_mode > XR_PASSTHROUGH_NONE) {
  908. feature_names.push_back("com.oculus.feature.PASSTHROUGH");
  909. feature_required_list.push_back(passthrough_mode == XR_PASSTHROUGH_REQUIRED);
  910. feature_versions.push_back(-1);
  911. }
  912. }
  913. if (feature_names.size() > 0) {
  914. ofs += 24; // skip over end tag
  915. // save manifest ending so we can restore it
  916. Vector<uint8_t> manifest_end;
  917. uint32_t manifest_cur_size = p_manifest.size();
  918. manifest_end.resize(p_manifest.size() - ofs);
  919. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  920. int32_t attr_name_string = string_table.find("name");
  921. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  922. int32_t ns_android_string = string_table.find("http://schemas.android.com/apk/res/android");
  923. if (ns_android_string == -1) {
  924. string_table.push_back("http://schemas.android.com/apk/res/android");
  925. ns_android_string = string_table.size() - 1;
  926. }
  927. int32_t attr_uses_feature_string = string_table.find("uses-feature");
  928. if (attr_uses_feature_string == -1) {
  929. string_table.push_back("uses-feature");
  930. attr_uses_feature_string = string_table.size() - 1;
  931. }
  932. int32_t attr_required_string = string_table.find("required");
  933. if (attr_required_string == -1) {
  934. string_table.push_back("required");
  935. attr_required_string = string_table.size() - 1;
  936. }
  937. for (int i = 0; i < feature_names.size(); i++) {
  938. String feature_name = feature_names[i];
  939. bool feature_required = feature_required_list[i];
  940. int feature_version = feature_versions[i];
  941. bool has_version_attribute = feature_version != -1;
  942. print_line("Adding feature " + feature_name);
  943. int32_t feature_string = string_table.find(feature_name);
  944. if (feature_string == -1) {
  945. string_table.push_back(feature_name);
  946. feature_string = string_table.size() - 1;
  947. }
  948. String required_value_string = feature_required ? "true" : "false";
  949. int32_t required_value = string_table.find(required_value_string);
  950. if (required_value == -1) {
  951. string_table.push_back(required_value_string);
  952. required_value = string_table.size() - 1;
  953. }
  954. int32_t attr_version_string = -1;
  955. int32_t version_value = -1;
  956. int tag_size;
  957. int attr_count;
  958. if (has_version_attribute) {
  959. attr_version_string = string_table.find("version");
  960. if (attr_version_string == -1) {
  961. string_table.push_back("version");
  962. attr_version_string = string_table.size() - 1;
  963. }
  964. version_value = string_table.find(itos(feature_version));
  965. if (version_value == -1) {
  966. string_table.push_back(itos(feature_version));
  967. version_value = string_table.size() - 1;
  968. }
  969. tag_size = 96; // node and three attrs + end node
  970. attr_count = 3;
  971. } else {
  972. tag_size = 76; // node and two attrs + end node
  973. attr_count = 2;
  974. }
  975. manifest_cur_size += tag_size + 24;
  976. p_manifest.resize(manifest_cur_size);
  977. // start tag
  978. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  979. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  980. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  981. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  982. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  983. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  984. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  985. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  986. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  987. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  988. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  989. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  990. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  991. // android:name attribute
  992. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  993. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  994. encode_uint32(feature_string, &p_manifest.write[ofs + 44]); // raw_value
  995. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  996. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  997. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  998. encode_uint32(feature_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  999. // android:required attribute
  1000. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  1001. encode_uint32(attr_required_string, &p_manifest.write[ofs + 60]); // 'name'
  1002. encode_uint32(required_value, &p_manifest.write[ofs + 64]); // raw_value
  1003. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  1004. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  1005. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  1006. encode_uint32(required_value, &p_manifest.write[ofs + 72]); // typedvalue reference
  1007. ofs += 76;
  1008. if (has_version_attribute) {
  1009. // android:version attribute
  1010. encode_uint32(ns_android_string, &p_manifest.write[ofs]); // ns
  1011. encode_uint32(attr_version_string, &p_manifest.write[ofs + 4]); // 'name'
  1012. encode_uint32(version_value, &p_manifest.write[ofs + 8]); // raw_value
  1013. encode_uint16(8, &p_manifest.write[ofs + 12]); // typedvalue_size
  1014. p_manifest.write[ofs + 14] = 0; // typedvalue_always0
  1015. p_manifest.write[ofs + 15] = 0x03; // typedvalue_type (string)
  1016. encode_uint32(version_value, &p_manifest.write[ofs + 16]); // typedvalue reference
  1017. ofs += 20;
  1018. }
  1019. // end tag
  1020. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1021. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1022. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1023. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1024. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1025. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1026. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1027. ofs += 24;
  1028. }
  1029. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1030. ofs -= 24; // go back over back end
  1031. }
  1032. }
  1033. if (tname == "manifest") {
  1034. // save manifest ending so we can restore it
  1035. Vector<uint8_t> manifest_end;
  1036. uint32_t manifest_cur_size = p_manifest.size();
  1037. manifest_end.resize(p_manifest.size() - ofs);
  1038. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  1039. int32_t attr_name_string = string_table.find("name");
  1040. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  1041. int32_t ns_android_string = string_table.find("android");
  1042. ERR_FAIL_COND_MSG(ns_android_string == -1, "Template does not have 'android' namespace.");
  1043. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  1044. if (attr_uses_permission_string == -1) {
  1045. string_table.push_back("uses-permission");
  1046. attr_uses_permission_string = string_table.size() - 1;
  1047. }
  1048. for (int i = 0; i < perms.size(); ++i) {
  1049. print_line("Adding permission " + perms[i]);
  1050. manifest_cur_size += 56 + 24; // node + end node
  1051. p_manifest.resize(manifest_cur_size);
  1052. // Add permission to the string pool
  1053. int32_t perm_string = string_table.find(perms[i]);
  1054. if (perm_string == -1) {
  1055. string_table.push_back(perms[i]);
  1056. perm_string = string_table.size() - 1;
  1057. }
  1058. // start tag
  1059. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1060. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1061. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  1062. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1063. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1064. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1065. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1066. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1067. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1068. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  1069. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1070. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1071. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1072. // attribute
  1073. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1074. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1075. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  1076. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1077. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1078. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1079. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1080. ofs += 56;
  1081. // end tag
  1082. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1083. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1084. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1085. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1086. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1087. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1088. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1089. ofs += 24;
  1090. }
  1091. // copy footer back in
  1092. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1093. }
  1094. } break;
  1095. }
  1096. ofs += size;
  1097. }
  1098. //create new andriodmanifest binary
  1099. Vector<uint8_t> ret;
  1100. ret.resize(string_table_begins + string_table.size() * 4);
  1101. for (uint32_t i = 0; i < string_table_begins; i++) {
  1102. ret.write[i] = p_manifest[i];
  1103. }
  1104. ofs = 0;
  1105. for (int i = 0; i < string_table.size(); i++) {
  1106. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1107. ofs += string_table[i].length() * 2 + 2 + 2;
  1108. }
  1109. ret.resize(ret.size() + ofs);
  1110. string_data_offset = ret.size() - ofs;
  1111. uint8_t *chars = &ret.write[string_data_offset];
  1112. for (int i = 0; i < string_table.size(); i++) {
  1113. String s = string_table[i];
  1114. encode_uint16(s.length(), chars);
  1115. chars += 2;
  1116. for (int j = 0; j < s.length(); j++) {
  1117. encode_uint16(s[j], chars);
  1118. chars += 2;
  1119. }
  1120. encode_uint16(0, chars);
  1121. chars += 2;
  1122. }
  1123. for (int i = 0; i < stable_extra.size(); i++) {
  1124. ret.push_back(stable_extra[i]);
  1125. }
  1126. //pad
  1127. while (ret.size() % 4) {
  1128. ret.push_back(0);
  1129. }
  1130. uint32_t new_stable_end = ret.size();
  1131. uint32_t extra = (p_manifest.size() - string_table_ends);
  1132. ret.resize(new_stable_end + extra);
  1133. for (uint32_t i = 0; i < extra; i++) {
  1134. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  1135. }
  1136. while (ret.size() % 4) {
  1137. ret.push_back(0);
  1138. }
  1139. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  1140. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  1141. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  1142. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  1143. p_manifest = ret;
  1144. }
  1145. String EditorExportPlatformAndroid::_parse_string(const uint8_t *p_bytes, bool p_utf8) {
  1146. uint32_t offset = 0;
  1147. uint32_t len = 0;
  1148. if (p_utf8) {
  1149. uint8_t byte = p_bytes[offset];
  1150. if (byte & 0x80) {
  1151. offset += 2;
  1152. } else {
  1153. offset += 1;
  1154. }
  1155. byte = p_bytes[offset];
  1156. offset++;
  1157. if (byte & 0x80) {
  1158. len = byte & 0x7F;
  1159. len = (len << 8) + p_bytes[offset];
  1160. offset++;
  1161. } else {
  1162. len = byte;
  1163. }
  1164. } else {
  1165. len = decode_uint16(&p_bytes[offset]);
  1166. offset += 2;
  1167. if (len & 0x8000) {
  1168. len &= 0x7FFF;
  1169. len = (len << 16) + decode_uint16(&p_bytes[offset]);
  1170. offset += 2;
  1171. }
  1172. }
  1173. if (p_utf8) {
  1174. Vector<uint8_t> str8;
  1175. str8.resize(len + 1);
  1176. for (uint32_t i = 0; i < len; i++) {
  1177. str8.write[i] = p_bytes[offset + i];
  1178. }
  1179. str8.write[len] = 0;
  1180. String str;
  1181. str.parse_utf8((const char *)str8.ptr());
  1182. return str;
  1183. } else {
  1184. String str;
  1185. for (uint32_t i = 0; i < len; i++) {
  1186. char32_t c = decode_uint16(&p_bytes[offset + i * 2]);
  1187. if (c == 0) {
  1188. break;
  1189. }
  1190. str += String::chr(c);
  1191. }
  1192. return str;
  1193. }
  1194. }
  1195. void EditorExportPlatformAndroid::_fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &r_manifest) {
  1196. const int UTF8_FLAG = 0x00000100;
  1197. uint32_t string_block_len = decode_uint32(&r_manifest[16]);
  1198. uint32_t string_count = decode_uint32(&r_manifest[20]);
  1199. uint32_t string_flags = decode_uint32(&r_manifest[28]);
  1200. const uint32_t string_table_begins = 40;
  1201. Vector<String> string_table;
  1202. String package_name = p_preset->get("package/name");
  1203. Dictionary appnames = ProjectSettings::get_singleton()->get("application/config/name_localized");
  1204. for (uint32_t i = 0; i < string_count; i++) {
  1205. uint32_t offset = decode_uint32(&r_manifest[string_table_begins + i * 4]);
  1206. offset += string_table_begins + string_count * 4;
  1207. String str = _parse_string(&r_manifest[offset], string_flags & UTF8_FLAG);
  1208. if (str.begins_with("godot-project-name")) {
  1209. if (str == "godot-project-name") {
  1210. //project name
  1211. str = get_project_name(package_name);
  1212. } else {
  1213. String lang = str.substr(str.rfind("-") + 1, str.length()).replace("-", "_");
  1214. if (appnames.has(lang)) {
  1215. str = appnames[lang];
  1216. } else {
  1217. str = get_project_name(package_name);
  1218. }
  1219. }
  1220. }
  1221. string_table.push_back(str);
  1222. }
  1223. //write a new string table, but use 16 bits
  1224. Vector<uint8_t> ret;
  1225. ret.resize(string_table_begins + string_table.size() * 4);
  1226. for (uint32_t i = 0; i < string_table_begins; i++) {
  1227. ret.write[i] = r_manifest[i];
  1228. }
  1229. int ofs = 0;
  1230. for (int i = 0; i < string_table.size(); i++) {
  1231. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1232. ofs += string_table[i].length() * 2 + 2 + 2;
  1233. }
  1234. ret.resize(ret.size() + ofs);
  1235. uint8_t *chars = &ret.write[ret.size() - ofs];
  1236. for (int i = 0; i < string_table.size(); i++) {
  1237. String s = string_table[i];
  1238. encode_uint16(s.length(), chars);
  1239. chars += 2;
  1240. for (int j = 0; j < s.length(); j++) {
  1241. encode_uint16(s[j], chars);
  1242. chars += 2;
  1243. }
  1244. encode_uint16(0, chars);
  1245. chars += 2;
  1246. }
  1247. //pad
  1248. while (ret.size() % 4) {
  1249. ret.push_back(0);
  1250. }
  1251. //change flags to not use utf8
  1252. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  1253. //change length
  1254. encode_uint32(ret.size() - 12, &ret.write[16]);
  1255. //append the rest...
  1256. int rest_from = 12 + string_block_len;
  1257. int rest_to = ret.size();
  1258. int rest_len = (r_manifest.size() - rest_from);
  1259. ret.resize(ret.size() + (r_manifest.size() - rest_from));
  1260. for (int i = 0; i < rest_len; i++) {
  1261. ret.write[rest_to + i] = r_manifest[rest_from + i];
  1262. }
  1263. //finally update the size
  1264. encode_uint32(ret.size(), &ret.write[4]);
  1265. r_manifest = ret;
  1266. //printf("end\n");
  1267. }
  1268. void EditorExportPlatformAndroid::_load_image_data(const Ref<Image> &p_splash_image, Vector<uint8_t> &p_data) {
  1269. Vector<uint8_t> png_buffer;
  1270. Error err = PNGDriverCommon::image_to_png(p_splash_image, png_buffer);
  1271. if (err == OK) {
  1272. p_data.resize(png_buffer.size());
  1273. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1274. } else {
  1275. String err_str = String("Failed to convert splash image to png.");
  1276. WARN_PRINT(err_str.utf8().get_data());
  1277. }
  1278. }
  1279. void EditorExportPlatformAndroid::_process_launcher_icons(const String &p_file_name, const Ref<Image> &p_source_image, int dimension, Vector<uint8_t> &p_data) {
  1280. Ref<Image> working_image = p_source_image;
  1281. if (p_source_image->get_width() != dimension || p_source_image->get_height() != dimension) {
  1282. working_image = p_source_image->duplicate();
  1283. working_image->resize(dimension, dimension, Image::Interpolation::INTERPOLATE_LANCZOS);
  1284. }
  1285. Vector<uint8_t> png_buffer;
  1286. Error err = PNGDriverCommon::image_to_png(working_image, png_buffer);
  1287. if (err == OK) {
  1288. p_data.resize(png_buffer.size());
  1289. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1290. } else {
  1291. String err_str = String("Failed to convert resized icon (") + p_file_name + ") to png.";
  1292. WARN_PRINT(err_str.utf8().get_data());
  1293. }
  1294. }
  1295. String EditorExportPlatformAndroid::load_splash_refs(Ref<Image> &splash_image, Ref<Image> &splash_bg_color_image) {
  1296. bool scale_splash = ProjectSettings::get_singleton()->get("application/boot_splash/fullsize");
  1297. bool apply_filter = ProjectSettings::get_singleton()->get("application/boot_splash/use_filter");
  1298. String project_splash_path = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  1299. if (!project_splash_path.is_empty()) {
  1300. splash_image.instantiate();
  1301. print_verbose("Loading splash image: " + project_splash_path);
  1302. const Error err = ImageLoader::load_image(project_splash_path, splash_image);
  1303. if (err) {
  1304. if (OS::get_singleton()->is_stdout_verbose()) {
  1305. print_error("- unable to load splash image from " + project_splash_path + " (" + itos(err) + ")");
  1306. }
  1307. splash_image.unref();
  1308. }
  1309. }
  1310. if (splash_image.is_null()) {
  1311. // Use the default
  1312. print_verbose("Using default splash image.");
  1313. splash_image = Ref<Image>(memnew(Image(boot_splash_png)));
  1314. }
  1315. if (scale_splash) {
  1316. Size2 screen_size = Size2(ProjectSettings::get_singleton()->get("display/window/size/viewport_width"), ProjectSettings::get_singleton()->get("display/window/size/viewport_height"));
  1317. int width, height;
  1318. if (screen_size.width > screen_size.height) {
  1319. // scale horizontally
  1320. height = screen_size.height;
  1321. width = splash_image->get_width() * screen_size.height / splash_image->get_height();
  1322. } else {
  1323. // scale vertically
  1324. width = screen_size.width;
  1325. height = splash_image->get_height() * screen_size.width / splash_image->get_width();
  1326. }
  1327. splash_image->resize(width, height);
  1328. }
  1329. // Setup the splash bg color
  1330. bool bg_color_valid;
  1331. Color bg_color = ProjectSettings::get_singleton()->get("application/boot_splash/bg_color", &bg_color_valid);
  1332. if (!bg_color_valid) {
  1333. bg_color = boot_splash_bg_color;
  1334. }
  1335. print_verbose("Creating splash background color image.");
  1336. splash_bg_color_image.instantiate();
  1337. splash_bg_color_image->create(splash_image->get_width(), splash_image->get_height(), false, splash_image->get_format());
  1338. splash_bg_color_image->fill(bg_color);
  1339. String processed_splash_config_xml = vformat(SPLASH_CONFIG_XML_CONTENT, bool_to_string(apply_filter));
  1340. return processed_splash_config_xml;
  1341. }
  1342. void EditorExportPlatformAndroid::load_icon_refs(const Ref<EditorExportPreset> &p_preset, Ref<Image> &icon, Ref<Image> &foreground, Ref<Image> &background) {
  1343. String project_icon_path = ProjectSettings::get_singleton()->get("application/config/icon");
  1344. icon.instantiate();
  1345. foreground.instantiate();
  1346. background.instantiate();
  1347. // Regular icon: user selection -> project icon -> default.
  1348. String path = static_cast<String>(p_preset->get(launcher_icon_option)).strip_edges();
  1349. print_verbose("Loading regular icon from " + path);
  1350. if (path.is_empty() || ImageLoader::load_image(path, icon) != OK) {
  1351. print_verbose("- falling back to project icon: " + project_icon_path);
  1352. ImageLoader::load_image(project_icon_path, icon);
  1353. }
  1354. // Adaptive foreground: user selection -> regular icon (user selection -> project icon -> default).
  1355. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_foreground_option)).strip_edges();
  1356. print_verbose("Loading adaptive foreground icon from " + path);
  1357. if (path.is_empty() || ImageLoader::load_image(path, foreground) != OK) {
  1358. print_verbose("- falling back to using the regular icon");
  1359. foreground = icon;
  1360. }
  1361. // Adaptive background: user selection -> default.
  1362. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_background_option)).strip_edges();
  1363. if (!path.is_empty()) {
  1364. print_verbose("Loading adaptive background icon from " + path);
  1365. ImageLoader::load_image(path, background);
  1366. }
  1367. }
  1368. void EditorExportPlatformAndroid::store_image(const LauncherIcon launcher_icon, const Vector<uint8_t> &data) {
  1369. store_image(launcher_icon.export_path, data);
  1370. }
  1371. void EditorExportPlatformAndroid::store_image(const String &export_path, const Vector<uint8_t> &data) {
  1372. String img_path = export_path.insert(0, "res://android/build/");
  1373. store_file_at_path(img_path, data);
  1374. }
  1375. void EditorExportPlatformAndroid::_copy_icons_to_gradle_project(const Ref<EditorExportPreset> &p_preset,
  1376. const String &processed_splash_config_xml,
  1377. const Ref<Image> &splash_image,
  1378. const Ref<Image> &splash_bg_color_image,
  1379. const Ref<Image> &main_image,
  1380. const Ref<Image> &foreground,
  1381. const Ref<Image> &background) {
  1382. // Store the splash configuration
  1383. if (!processed_splash_config_xml.is_empty()) {
  1384. print_verbose("Storing processed splash configuration: " + String("\n") + processed_splash_config_xml);
  1385. store_string_at_path(SPLASH_CONFIG_PATH, processed_splash_config_xml);
  1386. }
  1387. // Store the splash image
  1388. if (splash_image.is_valid() && !splash_image->is_empty()) {
  1389. print_verbose("Storing splash image in " + String(SPLASH_IMAGE_EXPORT_PATH));
  1390. Vector<uint8_t> data;
  1391. _load_image_data(splash_image, data);
  1392. store_image(SPLASH_IMAGE_EXPORT_PATH, data);
  1393. }
  1394. // Store the splash bg color image
  1395. if (splash_bg_color_image.is_valid() && !splash_bg_color_image->is_empty()) {
  1396. print_verbose("Storing splash background image in " + String(SPLASH_BG_COLOR_PATH));
  1397. Vector<uint8_t> data;
  1398. _load_image_data(splash_bg_color_image, data);
  1399. store_image(SPLASH_BG_COLOR_PATH, data);
  1400. }
  1401. // Prepare images to be resized for the icons. If some image ends up being uninitialized,
  1402. // the default image from the export template will be used.
  1403. for (int i = 0; i < icon_densities_count; ++i) {
  1404. if (main_image.is_valid() && !main_image->is_empty()) {
  1405. print_verbose("Processing launcher icon for dimension " + itos(launcher_icons[i].dimensions) + " into " + launcher_icons[i].export_path);
  1406. Vector<uint8_t> data;
  1407. _process_launcher_icons(launcher_icons[i].export_path, main_image, launcher_icons[i].dimensions, data);
  1408. store_image(launcher_icons[i], data);
  1409. }
  1410. if (foreground.is_valid() && !foreground->is_empty()) {
  1411. print_verbose("Processing launcher adaptive icon foreground for dimension " + itos(launcher_adaptive_icon_foregrounds[i].dimensions) + " into " + launcher_adaptive_icon_foregrounds[i].export_path);
  1412. Vector<uint8_t> data;
  1413. _process_launcher_icons(launcher_adaptive_icon_foregrounds[i].export_path, foreground,
  1414. launcher_adaptive_icon_foregrounds[i].dimensions, data);
  1415. store_image(launcher_adaptive_icon_foregrounds[i], data);
  1416. }
  1417. if (background.is_valid() && !background->is_empty()) {
  1418. print_verbose("Processing launcher adaptive icon background for dimension " + itos(launcher_adaptive_icon_backgrounds[i].dimensions) + " into " + launcher_adaptive_icon_backgrounds[i].export_path);
  1419. Vector<uint8_t> data;
  1420. _process_launcher_icons(launcher_adaptive_icon_backgrounds[i].export_path, background,
  1421. launcher_adaptive_icon_backgrounds[i].dimensions, data);
  1422. store_image(launcher_adaptive_icon_backgrounds[i], data);
  1423. }
  1424. }
  1425. }
  1426. Vector<String> EditorExportPlatformAndroid::get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  1427. Vector<String> abis = get_abis();
  1428. Vector<String> enabled_abis;
  1429. for (int i = 0; i < abis.size(); ++i) {
  1430. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  1431. if (is_enabled) {
  1432. enabled_abis.push_back(abis[i]);
  1433. }
  1434. }
  1435. return enabled_abis;
  1436. }
  1437. void EditorExportPlatformAndroid::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  1438. String driver = ProjectSettings::get_singleton()->get("rendering/driver/driver_name");
  1439. if (driver == "opengl3") {
  1440. r_features->push_back("etc");
  1441. }
  1442. // FIXME: Review what texture formats are used for Vulkan.
  1443. if (driver == "vulkan") {
  1444. r_features->push_back("etc2");
  1445. }
  1446. Vector<String> abis = get_enabled_abis(p_preset);
  1447. for (int i = 0; i < abis.size(); ++i) {
  1448. r_features->push_back(abis[i]);
  1449. }
  1450. }
  1451. void EditorExportPlatformAndroid::get_export_options(List<ExportOption> *r_options) {
  1452. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1453. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1454. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "custom_template/use_custom_build"), false));
  1455. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "custom_template/export_format", PROPERTY_HINT_ENUM, "Export APK,Export AAB"), EXPORT_FORMAT_APK));
  1456. Vector<PluginConfigAndroid> plugins_configs = get_plugins();
  1457. for (int i = 0; i < plugins_configs.size(); i++) {
  1458. print_verbose("Found Android plugin " + plugins_configs[i].name);
  1459. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "plugins/" + plugins_configs[i].name), false));
  1460. }
  1461. plugins_changed.clear();
  1462. const Vector<String> abis = get_abis();
  1463. for (int i = 0; i < abis.size(); ++i) {
  1464. const String abi = abis[i];
  1465. // All Android devices supporting Vulkan run 64-bit Android,
  1466. // so there is usually no point in exporting for 32-bit Android.
  1467. const bool is_default = abi == "arm64-v8a";
  1468. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  1469. }
  1470. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"), ""));
  1471. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user"), ""));
  1472. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password"), ""));
  1473. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"), ""));
  1474. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  1475. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  1476. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  1477. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  1478. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/min_sdk", PROPERTY_HINT_RANGE, SDK_VERSION_RANGE), DEFAULT_MIN_SDK_VERSION));
  1479. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/target_sdk", PROPERTY_HINT_RANGE, SDK_VERSION_RANGE), DEFAULT_TARGET_SDK_VERSION));
  1480. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "ext.domain.name"), "org.godotengine.$genname"));
  1481. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name [default if blank]"), ""));
  1482. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  1483. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/classify_as_game"), true));
  1484. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/retain_data_on_uninstall"), false));
  1485. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/exclude_from_recents"), false));
  1486. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_icon_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1487. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_foreground_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1488. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_background_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1489. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/opengl_debug"), false));
  1490. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/xr_mode", PROPERTY_HINT_ENUM, "Regular,OpenXR"), XR_MODE_REGULAR));
  1491. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/hand_tracking", PROPERTY_HINT_ENUM, "None,Optional,Required"), XR_HAND_TRACKING_NONE));
  1492. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/hand_tracking_frequency", PROPERTY_HINT_ENUM, "Low,High"), XR_HAND_TRACKING_FREQUENCY_LOW));
  1493. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/passthrough", PROPERTY_HINT_ENUM, "None,Optional,Required"), XR_PASSTHROUGH_NONE));
  1494. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  1495. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  1496. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  1497. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  1498. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  1499. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data_backup/allow"), false));
  1500. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  1501. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  1502. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  1503. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  1504. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "permissions/custom_permissions"), PackedStringArray()));
  1505. const char **perms = android_perms;
  1506. while (*perms) {
  1507. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  1508. perms++;
  1509. }
  1510. }
  1511. String EditorExportPlatformAndroid::get_name() const {
  1512. return "Android";
  1513. }
  1514. String EditorExportPlatformAndroid::get_os_name() const {
  1515. return "Android";
  1516. }
  1517. Ref<Texture2D> EditorExportPlatformAndroid::get_logo() const {
  1518. return logo;
  1519. }
  1520. bool EditorExportPlatformAndroid::should_update_export_options() {
  1521. bool export_options_changed = plugins_changed.is_set();
  1522. if (export_options_changed) {
  1523. // don't clear unless we're reporting true, to avoid race
  1524. plugins_changed.clear();
  1525. }
  1526. return export_options_changed;
  1527. }
  1528. bool EditorExportPlatformAndroid::poll_export() {
  1529. bool dc = devices_changed.is_set();
  1530. if (dc) {
  1531. // don't clear unless we're reporting true, to avoid race
  1532. devices_changed.clear();
  1533. }
  1534. return dc;
  1535. }
  1536. int EditorExportPlatformAndroid::get_options_count() const {
  1537. MutexLock lock(device_lock);
  1538. return devices.size();
  1539. }
  1540. String EditorExportPlatformAndroid::get_options_tooltip() const {
  1541. return TTR("Select device from the list");
  1542. }
  1543. String EditorExportPlatformAndroid::get_option_label(int p_index) const {
  1544. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1545. MutexLock lock(device_lock);
  1546. return devices[p_index].name;
  1547. }
  1548. String EditorExportPlatformAndroid::get_option_tooltip(int p_index) const {
  1549. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1550. MutexLock lock(device_lock);
  1551. String s = devices[p_index].description;
  1552. if (devices.size() == 1) {
  1553. // Tooltip will be:
  1554. // Name
  1555. // Description
  1556. s = devices[p_index].name + "\n\n" + s;
  1557. }
  1558. return s;
  1559. }
  1560. Error EditorExportPlatformAndroid::run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  1561. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1562. String can_export_error;
  1563. bool can_export_missing_templates;
  1564. if (!can_export(p_preset, can_export_error, can_export_missing_templates)) {
  1565. EditorNode::add_io_error(can_export_error);
  1566. return ERR_UNCONFIGURED;
  1567. }
  1568. MutexLock lock(device_lock);
  1569. EditorProgress ep("run", vformat(TTR("Running on %s"), devices[p_device].name), 3);
  1570. String adb = get_adb_path();
  1571. // Export_temp APK.
  1572. if (ep.step(TTR("Exporting APK..."), 0)) {
  1573. return ERR_SKIP;
  1574. }
  1575. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  1576. const bool use_reverse = devices[p_device].api_level >= 21;
  1577. if (use_reverse) {
  1578. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  1579. }
  1580. String tmp_export_path = EditorPaths::get_singleton()->get_cache_dir().plus_file("tmpexport." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  1581. #define CLEANUP_AND_RETURN(m_err) \
  1582. { \
  1583. DirAccess::remove_file_or_error(tmp_export_path); \
  1584. return m_err; \
  1585. }
  1586. // Export to temporary APK before sending to device.
  1587. Error err = export_project_helper(p_preset, true, tmp_export_path, EXPORT_FORMAT_APK, true, p_debug_flags);
  1588. if (err != OK) {
  1589. CLEANUP_AND_RETURN(err);
  1590. }
  1591. List<String> args;
  1592. int rv;
  1593. String output;
  1594. bool remove_prev = EDITOR_GET("export/android/one_click_deploy_clear_previous_install");
  1595. String version_name = p_preset->get("version/name");
  1596. String package_name = p_preset->get("package/unique_name");
  1597. if (remove_prev) {
  1598. if (ep.step(TTR("Uninstalling..."), 1)) {
  1599. CLEANUP_AND_RETURN(ERR_SKIP);
  1600. }
  1601. print_line("Uninstalling previous version: " + devices[p_device].name);
  1602. args.push_back("-s");
  1603. args.push_back(devices[p_device].id);
  1604. args.push_back("uninstall");
  1605. args.push_back(get_package_name(package_name));
  1606. output.clear();
  1607. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1608. print_verbose(output);
  1609. }
  1610. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1611. if (ep.step(TTR("Installing to device, please wait..."), 2)) {
  1612. CLEANUP_AND_RETURN(ERR_SKIP);
  1613. }
  1614. args.clear();
  1615. args.push_back("-s");
  1616. args.push_back(devices[p_device].id);
  1617. args.push_back("install");
  1618. args.push_back("-r");
  1619. args.push_back(tmp_export_path);
  1620. output.clear();
  1621. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1622. print_verbose(output);
  1623. if (err || rv != 0) {
  1624. EditorNode::add_io_error(vformat(TTR("Could not install to device: %s"), output));
  1625. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1626. }
  1627. if (use_remote) {
  1628. if (use_reverse) {
  1629. static const char *const msg = "--- Device API >= 21; debugging over USB ---";
  1630. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1631. print_line(String(msg).to_upper());
  1632. args.clear();
  1633. args.push_back("-s");
  1634. args.push_back(devices[p_device].id);
  1635. args.push_back("reverse");
  1636. args.push_back("--remove-all");
  1637. output.clear();
  1638. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1639. print_verbose(output);
  1640. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  1641. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  1642. args.clear();
  1643. args.push_back("-s");
  1644. args.push_back(devices[p_device].id);
  1645. args.push_back("reverse");
  1646. args.push_back("tcp:" + itos(dbg_port));
  1647. args.push_back("tcp:" + itos(dbg_port));
  1648. output.clear();
  1649. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1650. print_verbose(output);
  1651. print_line("Reverse result: " + itos(rv));
  1652. }
  1653. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1654. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  1655. args.clear();
  1656. args.push_back("-s");
  1657. args.push_back(devices[p_device].id);
  1658. args.push_back("reverse");
  1659. args.push_back("tcp:" + itos(fs_port));
  1660. args.push_back("tcp:" + itos(fs_port));
  1661. output.clear();
  1662. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1663. print_verbose(output);
  1664. print_line("Reverse result2: " + itos(rv));
  1665. }
  1666. } else {
  1667. static const char *const msg = "--- Device API < 21; debugging over Wi-Fi ---";
  1668. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1669. print_line(String(msg).to_upper());
  1670. }
  1671. }
  1672. if (ep.step(TTR("Running on device..."), 3)) {
  1673. CLEANUP_AND_RETURN(ERR_SKIP);
  1674. }
  1675. args.clear();
  1676. args.push_back("-s");
  1677. args.push_back(devices[p_device].id);
  1678. args.push_back("shell");
  1679. args.push_back("am");
  1680. args.push_back("start");
  1681. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  1682. args.push_back("--user");
  1683. args.push_back("0");
  1684. }
  1685. args.push_back("-a");
  1686. args.push_back("android.intent.action.MAIN");
  1687. args.push_back("-n");
  1688. args.push_back(get_package_name(package_name) + "/com.godot.game.GodotApp");
  1689. output.clear();
  1690. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1691. print_verbose(output);
  1692. if (err || rv != 0) {
  1693. EditorNode::add_io_error(TTR("Could not execute on device."));
  1694. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1695. }
  1696. CLEANUP_AND_RETURN(OK);
  1697. #undef CLEANUP_AND_RETURN
  1698. }
  1699. Ref<Texture2D> EditorExportPlatformAndroid::get_run_icon() const {
  1700. return run_icon;
  1701. }
  1702. String EditorExportPlatformAndroid::get_adb_path() {
  1703. String exe_ext = "";
  1704. if (OS::get_singleton()->get_name() == "Windows") {
  1705. exe_ext = ".exe";
  1706. }
  1707. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1708. return sdk_path.plus_file("platform-tools/adb" + exe_ext);
  1709. }
  1710. String EditorExportPlatformAndroid::get_apksigner_path() {
  1711. String exe_ext = "";
  1712. if (OS::get_singleton()->get_name() == "Windows") {
  1713. exe_ext = ".bat";
  1714. }
  1715. String apksigner_command_name = "apksigner" + exe_ext;
  1716. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1717. String apksigner_path = "";
  1718. Error errn;
  1719. String build_tools_dir = sdk_path.plus_file("build-tools");
  1720. DirAccessRef da = DirAccess::open(build_tools_dir, &errn);
  1721. if (errn != OK) {
  1722. print_error("Unable to open Android 'build-tools' directory.");
  1723. return apksigner_path;
  1724. }
  1725. // There are additional versions directories we need to go through.
  1726. da->list_dir_begin();
  1727. String sub_dir = da->get_next();
  1728. while (!sub_dir.is_empty()) {
  1729. if (!sub_dir.begins_with(".") && da->current_is_dir()) {
  1730. // Check if the tool is here.
  1731. String tool_path = build_tools_dir.plus_file(sub_dir).plus_file(apksigner_command_name);
  1732. if (FileAccess::exists(tool_path)) {
  1733. apksigner_path = tool_path;
  1734. break;
  1735. }
  1736. }
  1737. sub_dir = da->get_next();
  1738. }
  1739. da->list_dir_end();
  1740. if (apksigner_path.is_empty()) {
  1741. EditorNode::get_singleton()->show_warning(TTR("Unable to find the 'apksigner' tool."));
  1742. }
  1743. return apksigner_path;
  1744. }
  1745. bool EditorExportPlatformAndroid::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1746. String err;
  1747. bool valid = false;
  1748. const bool custom_build_enabled = p_preset->get("custom_template/use_custom_build");
  1749. // Look for export templates (first official, and if defined custom templates).
  1750. if (!custom_build_enabled) {
  1751. String template_err;
  1752. bool dvalid = false;
  1753. bool rvalid = false;
  1754. bool has_export_templates = false;
  1755. if (p_preset->get("custom_template/debug") != "") {
  1756. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1757. if (!dvalid) {
  1758. template_err += TTR("Custom debug template not found.") + "\n";
  1759. }
  1760. } else {
  1761. has_export_templates |= exists_export_template("android_debug.apk", &template_err);
  1762. }
  1763. if (p_preset->get("custom_template/release") != "") {
  1764. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1765. if (!rvalid) {
  1766. template_err += TTR("Custom release template not found.") + "\n";
  1767. }
  1768. } else {
  1769. has_export_templates |= exists_export_template("android_release.apk", &template_err);
  1770. }
  1771. r_missing_templates = !has_export_templates;
  1772. valid = dvalid || rvalid || has_export_templates;
  1773. if (!valid) {
  1774. err += template_err;
  1775. }
  1776. } else {
  1777. bool installed_android_build_template = FileAccess::exists("res://android/build/build.gradle");
  1778. if (!installed_android_build_template) {
  1779. r_missing_templates = !exists_export_template("android_source.zip", &err);
  1780. err += TTR("Android build template not installed in the project. Install it from the Project menu.") + "\n";
  1781. } else {
  1782. r_missing_templates = false;
  1783. }
  1784. valid = installed_android_build_template && !r_missing_templates;
  1785. }
  1786. // Validate the rest of the configuration.
  1787. String dk = p_preset->get("keystore/debug");
  1788. String dk_user = p_preset->get("keystore/debug_user");
  1789. String dk_password = p_preset->get("keystore/debug_password");
  1790. if ((dk.is_empty() || dk_user.is_empty() || dk_password.is_empty()) && (!dk.is_empty() || !dk_user.is_empty() || !dk_password.is_empty())) {
  1791. valid = false;
  1792. err += TTR("Either Debug Keystore, Debug User AND Debug Password settings must be configured OR none of them.") + "\n";
  1793. }
  1794. if (!FileAccess::exists(dk)) {
  1795. dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1796. if (!FileAccess::exists(dk)) {
  1797. valid = false;
  1798. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  1799. }
  1800. }
  1801. String rk = p_preset->get("keystore/release");
  1802. String rk_user = p_preset->get("keystore/release_user");
  1803. String rk_password = p_preset->get("keystore/release_password");
  1804. if ((rk.is_empty() || rk_user.is_empty() || rk_password.is_empty()) && (!rk.is_empty() || !rk_user.is_empty() || !rk_password.is_empty())) {
  1805. valid = false;
  1806. err += TTR("Either Release Keystore, Release User AND Release Password settings must be configured OR none of them.") + "\n";
  1807. }
  1808. if (!rk.is_empty() && !FileAccess::exists(rk)) {
  1809. valid = false;
  1810. err += TTR("Release keystore incorrectly configured in the export preset.") + "\n";
  1811. }
  1812. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1813. if (sdk_path.is_empty()) {
  1814. err += TTR("A valid Android SDK path is required in Editor Settings.") + "\n";
  1815. valid = false;
  1816. } else {
  1817. Error errn;
  1818. // Check for the platform-tools directory.
  1819. DirAccessRef da = DirAccess::open(sdk_path.plus_file("platform-tools"), &errn);
  1820. if (errn != OK) {
  1821. err += TTR("Invalid Android SDK path in Editor Settings.");
  1822. err += TTR("Missing 'platform-tools' directory!");
  1823. err += "\n";
  1824. valid = false;
  1825. }
  1826. // Validate that adb is available
  1827. String adb_path = get_adb_path();
  1828. if (!FileAccess::exists(adb_path)) {
  1829. err += TTR("Unable to find Android SDK platform-tools' adb command.");
  1830. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  1831. err += "\n";
  1832. valid = false;
  1833. }
  1834. // Check for the build-tools directory.
  1835. DirAccessRef build_tools_da = DirAccess::open(sdk_path.plus_file("build-tools"), &errn);
  1836. if (errn != OK) {
  1837. err += TTR("Invalid Android SDK path in Editor Settings.");
  1838. err += TTR("Missing 'build-tools' directory!");
  1839. err += "\n";
  1840. valid = false;
  1841. }
  1842. // Validate that apksigner is available
  1843. String apksigner_path = get_apksigner_path();
  1844. if (!FileAccess::exists(apksigner_path)) {
  1845. err += TTR("Unable to find Android SDK build-tools' apksigner command.");
  1846. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  1847. err += "\n";
  1848. valid = false;
  1849. }
  1850. }
  1851. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1852. if (apk_expansion) {
  1853. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1854. if (apk_expansion_pkey.is_empty()) {
  1855. valid = false;
  1856. err += TTR("Invalid public key for APK expansion.") + "\n";
  1857. }
  1858. }
  1859. String pn = p_preset->get("package/unique_name");
  1860. String pn_err;
  1861. if (!is_package_name_valid(get_package_name(pn), &pn_err)) {
  1862. valid = false;
  1863. err += TTR("Invalid package name:") + " " + pn_err + "\n";
  1864. }
  1865. String etc_error = test_etc2();
  1866. if (!etc_error.is_empty()) {
  1867. valid = false;
  1868. err += etc_error;
  1869. }
  1870. // Ensure that `Use Custom Build` is enabled if a plugin is selected.
  1871. String enabled_plugins_names = PluginConfigAndroid::get_plugins_names(get_enabled_plugins(p_preset));
  1872. if (!enabled_plugins_names.is_empty() && !custom_build_enabled) {
  1873. valid = false;
  1874. err += TTR("\"Use Custom Build\" must be enabled to use the plugins.");
  1875. err += "\n";
  1876. }
  1877. // Validate the Xr features are properly populated
  1878. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1879. int hand_tracking = p_preset->get("xr_features/hand_tracking");
  1880. int passthrough_mode = p_preset->get("xr_features/passthrough");
  1881. if (xr_mode_index != XR_MODE_OPENXR) {
  1882. if (hand_tracking > XR_HAND_TRACKING_NONE) {
  1883. valid = false;
  1884. err += TTR("\"Hand Tracking\" is only valid when \"Xr Mode\" is \"OpenXR\".");
  1885. err += "\n";
  1886. }
  1887. if (passthrough_mode > XR_PASSTHROUGH_NONE) {
  1888. valid = false;
  1889. err += TTR("\"Passthrough\" is only valid when \"Xr Mode\" is \"OpenXR\".");
  1890. err += "\n";
  1891. }
  1892. }
  1893. if (int(p_preset->get("custom_template/export_format")) == EXPORT_FORMAT_AAB &&
  1894. !custom_build_enabled) {
  1895. valid = false;
  1896. err += TTR("\"Export AAB\" is only valid when \"Use Custom Build\" is enabled.");
  1897. err += "\n";
  1898. }
  1899. // Check the min sdk version
  1900. int min_sdk_version = p_preset->get("version/min_sdk");
  1901. if (min_sdk_version != DEFAULT_MIN_SDK_VERSION && !custom_build_enabled) {
  1902. valid = false;
  1903. err += TTR("Changing the \"Min Sdk\" is only valid when \"Use Custom Build\" is enabled.");
  1904. err += "\n";
  1905. }
  1906. // Check the target sdk version
  1907. int target_sdk_version = p_preset->get("version/target_sdk");
  1908. if (target_sdk_version != DEFAULT_TARGET_SDK_VERSION && !custom_build_enabled) {
  1909. valid = false;
  1910. err += TTR("Changing the \"Target Sdk\" is only valid when \"Use Custom Build\" is enabled.");
  1911. err += "\n";
  1912. }
  1913. if (target_sdk_version < min_sdk_version) {
  1914. valid = false;
  1915. err += TTR("\"Target Sdk\" version must be greater or equal to \"Min Sdk\" version.");
  1916. err += "\n";
  1917. }
  1918. r_error = err;
  1919. return valid;
  1920. }
  1921. List<String> EditorExportPlatformAndroid::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1922. List<String> list;
  1923. list.push_back("apk");
  1924. list.push_back("aab");
  1925. return list;
  1926. }
  1927. String EditorExportPlatformAndroid::get_apk_expansion_fullpath(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  1928. int version_code = p_preset->get("version/code");
  1929. String package_name = p_preset->get("package/unique_name");
  1930. String apk_file_name = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  1931. String fullpath = p_path.get_base_dir().plus_file(apk_file_name);
  1932. return fullpath;
  1933. }
  1934. Error EditorExportPlatformAndroid::save_apk_expansion_file(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  1935. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  1936. Error err = save_pack(p_preset, p_debug, fullpath);
  1937. return err;
  1938. }
  1939. void EditorExportPlatformAndroid::get_command_line_flags(const Ref<EditorExportPreset> &p_preset, const String &p_path, int p_flags, Vector<uint8_t> &r_command_line_flags) {
  1940. String cmdline = p_preset->get("command_line/extra_args");
  1941. Vector<String> command_line_strings = cmdline.strip_edges().split(" ");
  1942. for (int i = 0; i < command_line_strings.size(); i++) {
  1943. if (command_line_strings[i].strip_edges().length() == 0) {
  1944. command_line_strings.remove_at(i);
  1945. i--;
  1946. }
  1947. }
  1948. gen_export_flags(command_line_strings, p_flags);
  1949. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1950. if (apk_expansion) {
  1951. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  1952. String apk_expansion_public_key = p_preset->get("apk_expansion/public_key");
  1953. command_line_strings.push_back("--use_apk_expansion");
  1954. command_line_strings.push_back("--apk_expansion_md5");
  1955. command_line_strings.push_back(FileAccess::get_md5(fullpath));
  1956. command_line_strings.push_back("--apk_expansion_key");
  1957. command_line_strings.push_back(apk_expansion_public_key.strip_edges());
  1958. }
  1959. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1960. if (xr_mode_index == XR_MODE_OPENXR) {
  1961. command_line_strings.push_back("--xr_mode_openxr");
  1962. } else { // XRMode.REGULAR is the default.
  1963. command_line_strings.push_back("--xr_mode_regular");
  1964. }
  1965. bool immersive = p_preset->get("screen/immersive_mode");
  1966. if (immersive) {
  1967. command_line_strings.push_back("--use_immersive");
  1968. }
  1969. bool debug_opengl = p_preset->get("graphics/opengl_debug");
  1970. if (debug_opengl) {
  1971. command_line_strings.push_back("--debug_opengl");
  1972. }
  1973. if (command_line_strings.size()) {
  1974. r_command_line_flags.resize(4);
  1975. encode_uint32(command_line_strings.size(), &r_command_line_flags.write[0]);
  1976. for (int i = 0; i < command_line_strings.size(); i++) {
  1977. print_line(itos(i) + " param: " + command_line_strings[i]);
  1978. CharString command_line_argument = command_line_strings[i].utf8();
  1979. int base = r_command_line_flags.size();
  1980. int length = command_line_argument.length();
  1981. if (length == 0) {
  1982. continue;
  1983. }
  1984. r_command_line_flags.resize(base + 4 + length);
  1985. encode_uint32(length, &r_command_line_flags.write[base]);
  1986. memcpy(&r_command_line_flags.write[base + 4], command_line_argument.ptr(), length);
  1987. }
  1988. }
  1989. }
  1990. Error EditorExportPlatformAndroid::sign_apk(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &export_path, EditorProgress &ep) {
  1991. int export_format = int(p_preset->get("custom_template/export_format"));
  1992. String export_label = export_format == EXPORT_FORMAT_AAB ? "AAB" : "APK";
  1993. String release_keystore = p_preset->get("keystore/release");
  1994. String release_username = p_preset->get("keystore/release_user");
  1995. String release_password = p_preset->get("keystore/release_password");
  1996. String apksigner = get_apksigner_path();
  1997. print_verbose("Starting signing of the " + export_label + " binary using " + apksigner);
  1998. if (!FileAccess::exists(apksigner)) {
  1999. EditorNode::add_io_error(vformat(TTR("'apksigner' could not be found.\nPlease check the command is available in the Android SDK build-tools directory.\nThe resulting %s is unsigned."), export_label));
  2000. return OK;
  2001. }
  2002. String keystore;
  2003. String password;
  2004. String user;
  2005. if (p_debug) {
  2006. keystore = p_preset->get("keystore/debug");
  2007. password = p_preset->get("keystore/debug_password");
  2008. user = p_preset->get("keystore/debug_user");
  2009. if (keystore.is_empty()) {
  2010. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  2011. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  2012. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  2013. }
  2014. if (ep.step(vformat(TTR("Signing debug %s..."), export_label), 104)) {
  2015. return ERR_SKIP;
  2016. }
  2017. } else {
  2018. keystore = release_keystore;
  2019. password = release_password;
  2020. user = release_username;
  2021. if (ep.step(vformat(TTR("Signing release %s..."), export_label), 104)) {
  2022. return ERR_SKIP;
  2023. }
  2024. }
  2025. if (!FileAccess::exists(keystore)) {
  2026. EditorNode::add_io_error(TTR("Could not find keystore, unable to export."));
  2027. return ERR_FILE_CANT_OPEN;
  2028. }
  2029. String output;
  2030. List<String> args;
  2031. args.push_back("sign");
  2032. args.push_back("--verbose");
  2033. args.push_back("--ks");
  2034. args.push_back(keystore);
  2035. args.push_back("--ks-pass");
  2036. args.push_back("pass:" + password);
  2037. args.push_back("--ks-key-alias");
  2038. args.push_back(user);
  2039. args.push_back(export_path);
  2040. if (p_debug) {
  2041. // We only print verbose logs for debug builds to avoid leaking release keystore credentials.
  2042. print_verbose("Signing debug binary using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2043. }
  2044. int retval;
  2045. output.clear();
  2046. OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2047. print_verbose(output);
  2048. if (retval) {
  2049. EditorNode::add_io_error(vformat(TTR("'apksigner' returned with error #%d"), retval));
  2050. return ERR_CANT_CREATE;
  2051. }
  2052. if (ep.step(vformat(TTR("Verifying %s..."), export_label), 105)) {
  2053. return ERR_SKIP;
  2054. }
  2055. args.clear();
  2056. args.push_back("verify");
  2057. args.push_back("--verbose");
  2058. args.push_back(export_path);
  2059. if (p_debug) {
  2060. print_verbose("Verifying signed build using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2061. }
  2062. output.clear();
  2063. OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2064. print_verbose(output);
  2065. if (retval) {
  2066. EditorNode::add_io_error(vformat(TTR("'apksigner' verification of %s failed."), export_label));
  2067. return ERR_CANT_CREATE;
  2068. }
  2069. print_verbose("Successfully completed signing build.");
  2070. return OK;
  2071. }
  2072. void EditorExportPlatformAndroid::_clear_assets_directory() {
  2073. DirAccessRef da_res = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2074. // Clear the APK assets directory
  2075. if (da_res->dir_exists(APK_ASSETS_DIRECTORY)) {
  2076. print_verbose("Clearing APK assets directory..");
  2077. DirAccessRef da_assets = DirAccess::open(APK_ASSETS_DIRECTORY);
  2078. da_assets->erase_contents_recursive();
  2079. da_res->remove(APK_ASSETS_DIRECTORY);
  2080. }
  2081. // Clear the AAB assets directory
  2082. if (da_res->dir_exists(AAB_ASSETS_DIRECTORY)) {
  2083. print_verbose("Clearing AAB assets directory..");
  2084. DirAccessRef da_assets = DirAccess::open(AAB_ASSETS_DIRECTORY);
  2085. da_assets->erase_contents_recursive();
  2086. da_res->remove(AAB_ASSETS_DIRECTORY);
  2087. }
  2088. }
  2089. void EditorExportPlatformAndroid::_remove_copied_libs() {
  2090. print_verbose("Removing previously installed libraries...");
  2091. Error error;
  2092. String libs_json = FileAccess::get_file_as_string(GDNATIVE_LIBS_PATH, &error);
  2093. if (error || libs_json.is_empty()) {
  2094. print_verbose("No previously installed libraries found");
  2095. return;
  2096. }
  2097. JSON json;
  2098. error = json.parse(libs_json);
  2099. ERR_FAIL_COND_MSG(error, "Error parsing \"" + libs_json + "\" on line " + itos(json.get_error_line()) + ": " + json.get_error_message());
  2100. Vector<String> libs = json.get_data();
  2101. DirAccessRef da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2102. for (int i = 0; i < libs.size(); i++) {
  2103. print_verbose("Removing previously installed library " + libs[i]);
  2104. da->remove(libs[i]);
  2105. }
  2106. da->remove(GDNATIVE_LIBS_PATH);
  2107. }
  2108. String EditorExportPlatformAndroid::join_list(List<String> parts, const String &separator) const {
  2109. String ret;
  2110. for (int i = 0; i < parts.size(); ++i) {
  2111. if (i > 0) {
  2112. ret += separator;
  2113. }
  2114. ret += parts[i];
  2115. }
  2116. return ret;
  2117. }
  2118. Error EditorExportPlatformAndroid::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  2119. int export_format = int(p_preset->get("custom_template/export_format"));
  2120. bool should_sign = p_preset->get("package/signed");
  2121. return export_project_helper(p_preset, p_debug, p_path, export_format, should_sign, p_flags);
  2122. }
  2123. Error EditorExportPlatformAndroid::export_project_helper(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int export_format, bool should_sign, int p_flags) {
  2124. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  2125. String src_apk;
  2126. Error err;
  2127. EditorProgress ep("export", TTR("Exporting for Android"), 105, true);
  2128. bool use_custom_build = bool(p_preset->get("custom_template/use_custom_build"));
  2129. bool p_give_internet = p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG);
  2130. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2131. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  2132. print_verbose("Exporting for Android...");
  2133. print_verbose("- debug build: " + bool_to_string(p_debug));
  2134. print_verbose("- export path: " + p_path);
  2135. print_verbose("- export format: " + itos(export_format));
  2136. print_verbose("- sign build: " + bool_to_string(should_sign));
  2137. print_verbose("- custom build enabled: " + bool_to_string(use_custom_build));
  2138. print_verbose("- apk expansion enabled: " + bool_to_string(apk_expansion));
  2139. print_verbose("- enabled abis: " + String(",").join(enabled_abis));
  2140. print_verbose("- export filter: " + itos(p_preset->get_export_filter()));
  2141. print_verbose("- include filter: " + p_preset->get_include_filter());
  2142. print_verbose("- exclude filter: " + p_preset->get_exclude_filter());
  2143. Ref<Image> splash_image;
  2144. Ref<Image> splash_bg_color_image;
  2145. String processed_splash_config_xml = load_splash_refs(splash_image, splash_bg_color_image);
  2146. Ref<Image> main_image;
  2147. Ref<Image> foreground;
  2148. Ref<Image> background;
  2149. load_icon_refs(p_preset, main_image, foreground, background);
  2150. Vector<uint8_t> command_line_flags;
  2151. // Write command line flags into the command_line_flags variable.
  2152. get_command_line_flags(p_preset, p_path, p_flags, command_line_flags);
  2153. if (export_format == EXPORT_FORMAT_AAB) {
  2154. if (!p_path.ends_with(".aab")) {
  2155. EditorNode::get_singleton()->show_warning(TTR("Invalid filename! Android App Bundle requires the *.aab extension."));
  2156. return ERR_UNCONFIGURED;
  2157. }
  2158. if (apk_expansion) {
  2159. EditorNode::get_singleton()->show_warning(TTR("APK Expansion not compatible with Android App Bundle."));
  2160. return ERR_UNCONFIGURED;
  2161. }
  2162. }
  2163. if (export_format == EXPORT_FORMAT_APK && !p_path.ends_with(".apk")) {
  2164. EditorNode::get_singleton()->show_warning(
  2165. TTR("Invalid filename! Android APK requires the *.apk extension."));
  2166. return ERR_UNCONFIGURED;
  2167. }
  2168. if (export_format > EXPORT_FORMAT_AAB || export_format < EXPORT_FORMAT_APK) {
  2169. EditorNode::add_io_error(TTR("Unsupported export format!\n"));
  2170. return ERR_UNCONFIGURED; //TODO: is this the right error?
  2171. }
  2172. if (use_custom_build) {
  2173. print_verbose("Starting custom build..");
  2174. //test that installed build version is alright
  2175. {
  2176. print_verbose("Checking build version..");
  2177. FileAccessRef f = FileAccess::open("res://android/.build_version", FileAccess::READ);
  2178. if (!f) {
  2179. EditorNode::get_singleton()->show_warning(TTR("Trying to build from a custom built template, but no version info for it exists. Please reinstall from the 'Project' menu."));
  2180. return ERR_UNCONFIGURED;
  2181. }
  2182. String version = f->get_line().strip_edges();
  2183. print_verbose("- build version: " + version);
  2184. f->close();
  2185. if (version != VERSION_FULL_CONFIG) {
  2186. EditorNode::get_singleton()->show_warning(vformat(TTR("Android build version mismatch:\n Template installed: %s\n Godot Version: %s\nPlease reinstall Android build template from 'Project' menu."), version, VERSION_FULL_CONFIG));
  2187. return ERR_UNCONFIGURED;
  2188. }
  2189. }
  2190. const String assets_directory = get_assets_directory(p_preset, export_format);
  2191. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2192. ERR_FAIL_COND_V_MSG(sdk_path.is_empty(), ERR_UNCONFIGURED, "Android SDK path must be configured in Editor Settings at 'export/android/android_sdk_path'.");
  2193. print_verbose("Android sdk path: " + sdk_path);
  2194. // TODO: should we use "package/name" or "application/config/name"?
  2195. String project_name = get_project_name(p_preset->get("package/name"));
  2196. err = _create_project_name_strings_files(p_preset, project_name); //project name localization.
  2197. if (err != OK) {
  2198. EditorNode::add_io_error(TTR("Unable to overwrite res://android/build/res/*.xml files with project name"));
  2199. }
  2200. // Copies the project icon files into the appropriate Gradle project directory.
  2201. _copy_icons_to_gradle_project(p_preset, processed_splash_config_xml, splash_image, splash_bg_color_image, main_image, foreground, background);
  2202. // Write an AndroidManifest.xml file into the Gradle project directory.
  2203. _write_tmp_manifest(p_preset, p_give_internet, p_debug);
  2204. //stores all the project files inside the Gradle project directory. Also includes all ABIs
  2205. _clear_assets_directory();
  2206. _remove_copied_libs();
  2207. if (!apk_expansion) {
  2208. print_verbose("Exporting project files..");
  2209. CustomExportData user_data;
  2210. user_data.assets_directory = assets_directory;
  2211. user_data.debug = p_debug;
  2212. err = export_project_files(p_preset, p_debug, rename_and_store_file_in_gradle_project, &user_data, copy_gradle_so);
  2213. if (err != OK) {
  2214. EditorNode::add_io_error(TTR("Could not export project files to gradle project\n"));
  2215. return err;
  2216. }
  2217. if (user_data.libs.size() > 0) {
  2218. FileAccessRef fa = FileAccess::open(GDNATIVE_LIBS_PATH, FileAccess::WRITE);
  2219. JSON json;
  2220. fa->store_string(json.stringify(user_data.libs, "\t"));
  2221. fa->close();
  2222. }
  2223. } else {
  2224. print_verbose("Saving apk expansion file..");
  2225. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  2226. if (err != OK) {
  2227. EditorNode::add_io_error(TTR("Could not write expansion package file!"));
  2228. return err;
  2229. }
  2230. }
  2231. print_verbose("Storing command line flags..");
  2232. store_file_at_path(assets_directory + "/_cl_", command_line_flags);
  2233. print_verbose("Updating ANDROID_HOME environment to " + sdk_path);
  2234. OS::get_singleton()->set_environment("ANDROID_HOME", sdk_path); //set and overwrite if required
  2235. String build_command;
  2236. #ifdef WINDOWS_ENABLED
  2237. build_command = "gradlew.bat";
  2238. #else
  2239. build_command = "gradlew";
  2240. #endif
  2241. String build_path = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/build");
  2242. build_command = build_path.plus_file(build_command);
  2243. String package_name = get_package_name(p_preset->get("package/unique_name"));
  2244. String version_code = itos(p_preset->get("version/code"));
  2245. String version_name = p_preset->get("version/name");
  2246. String min_sdk_version = itos(p_preset->get("version/min_sdk"));
  2247. String target_sdk_version = itos(p_preset->get("version/target_sdk"));
  2248. String enabled_abi_string = String("|").join(enabled_abis);
  2249. String sign_flag = should_sign ? "true" : "false";
  2250. String zipalign_flag = "true";
  2251. Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
  2252. String local_plugins_binaries = PluginConfigAndroid::get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_LOCAL, enabled_plugins);
  2253. String remote_plugins_binaries = PluginConfigAndroid::get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_REMOTE, enabled_plugins);
  2254. String custom_maven_repos = PluginConfigAndroid::get_plugins_custom_maven_repos(enabled_plugins);
  2255. bool clean_build_required = is_clean_build_required(enabled_plugins);
  2256. List<String> cmdline;
  2257. if (clean_build_required) {
  2258. cmdline.push_back("clean");
  2259. }
  2260. String build_type = p_debug ? "Debug" : "Release";
  2261. if (export_format == EXPORT_FORMAT_AAB) {
  2262. String bundle_build_command = vformat("bundle%s", build_type);
  2263. cmdline.push_back(bundle_build_command);
  2264. } else if (export_format == EXPORT_FORMAT_APK) {
  2265. String apk_build_command = vformat("assemble%s", build_type);
  2266. cmdline.push_back(apk_build_command);
  2267. }
  2268. cmdline.push_back("-p"); // argument to specify the start directory.
  2269. cmdline.push_back(build_path); // start directory.
  2270. cmdline.push_back("-Pexport_package_name=" + package_name); // argument to specify the package name.
  2271. cmdline.push_back("-Pexport_version_code=" + version_code); // argument to specify the version code.
  2272. cmdline.push_back("-Pexport_version_name=" + version_name); // argument to specify the version name.
  2273. cmdline.push_back("-Pexport_version_min_sdk=" + min_sdk_version); // argument to specify the min sdk.
  2274. cmdline.push_back("-Pexport_version_target_sdk=" + target_sdk_version); // argument to specify the target sdk.
  2275. cmdline.push_back("-Pexport_enabled_abis=" + enabled_abi_string); // argument to specify enabled ABIs.
  2276. cmdline.push_back("-Pplugins_local_binaries=" + local_plugins_binaries); // argument to specify the list of plugins local dependencies.
  2277. cmdline.push_back("-Pplugins_remote_binaries=" + remote_plugins_binaries); // argument to specify the list of plugins remote dependencies.
  2278. cmdline.push_back("-Pplugins_maven_repos=" + custom_maven_repos); // argument to specify the list of custom maven repos for the plugins dependencies.
  2279. cmdline.push_back("-Pperform_zipalign=" + zipalign_flag); // argument to specify whether the build should be zipaligned.
  2280. cmdline.push_back("-Pperform_signing=" + sign_flag); // argument to specify whether the build should be signed.
  2281. cmdline.push_back("-Pgodot_editor_version=" + String(VERSION_FULL_CONFIG));
  2282. // NOTE: The release keystore is not included in the verbose logging
  2283. // to avoid accidentally leaking sensitive information when sharing verbose logs for troubleshooting.
  2284. // Any non-sensitive additions to the command line arguments must be done above this section.
  2285. // Sensitive additions must be done below the logging statement.
  2286. print_verbose("Build Android project using gradle command: " + String("\n") + build_command + " " + join_list(cmdline, String(" ")));
  2287. if (should_sign) {
  2288. if (p_debug) {
  2289. String debug_keystore = p_preset->get("keystore/debug");
  2290. String debug_password = p_preset->get("keystore/debug_password");
  2291. String debug_user = p_preset->get("keystore/debug_user");
  2292. if (debug_keystore.is_empty()) {
  2293. debug_keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  2294. debug_password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  2295. debug_user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  2296. }
  2297. if (debug_keystore.is_relative_path()) {
  2298. debug_keystore = OS::get_singleton()->get_resource_dir().plus_file(debug_keystore).simplify_path();
  2299. }
  2300. if (!FileAccess::exists(debug_keystore)) {
  2301. EditorNode::add_io_error(TTR("Could not find keystore, unable to export."));
  2302. return ERR_FILE_CANT_OPEN;
  2303. }
  2304. cmdline.push_back("-Pdebug_keystore_file=" + debug_keystore); // argument to specify the debug keystore file.
  2305. cmdline.push_back("-Pdebug_keystore_alias=" + debug_user); // argument to specify the debug keystore alias.
  2306. cmdline.push_back("-Pdebug_keystore_password=" + debug_password); // argument to specify the debug keystore password.
  2307. } else {
  2308. // Pass the release keystore info as well
  2309. String release_keystore = p_preset->get("keystore/release");
  2310. String release_username = p_preset->get("keystore/release_user");
  2311. String release_password = p_preset->get("keystore/release_password");
  2312. if (release_keystore.is_relative_path()) {
  2313. release_keystore = OS::get_singleton()->get_resource_dir().plus_file(release_keystore).simplify_path();
  2314. }
  2315. if (!FileAccess::exists(release_keystore)) {
  2316. EditorNode::add_io_error(TTR("Could not find keystore, unable to export."));
  2317. return ERR_FILE_CANT_OPEN;
  2318. }
  2319. cmdline.push_back("-Prelease_keystore_file=" + release_keystore); // argument to specify the release keystore file.
  2320. cmdline.push_back("-Prelease_keystore_alias=" + release_username); // argument to specify the release keystore alias.
  2321. cmdline.push_back("-Prelease_keystore_password=" + release_password); // argument to specify the release keystore password.
  2322. }
  2323. }
  2324. int result = EditorNode::get_singleton()->execute_and_show_output(TTR("Building Android Project (gradle)"), build_command, cmdline);
  2325. if (result != 0) {
  2326. EditorNode::get_singleton()->show_warning(TTR("Building of Android project failed, check output for the error.\nAlternatively visit docs.godotengine.org for Android build documentation."));
  2327. return ERR_CANT_CREATE;
  2328. }
  2329. List<String> copy_args;
  2330. String copy_command;
  2331. if (export_format == EXPORT_FORMAT_AAB) {
  2332. copy_command = vformat("copyAndRename%sAab", build_type);
  2333. } else if (export_format == EXPORT_FORMAT_APK) {
  2334. copy_command = vformat("copyAndRename%sApk", build_type);
  2335. }
  2336. copy_args.push_back(copy_command);
  2337. copy_args.push_back("-p"); // argument to specify the start directory.
  2338. copy_args.push_back(build_path); // start directory.
  2339. String export_filename = p_path.get_file();
  2340. String export_path = p_path.get_base_dir();
  2341. if (export_path.is_relative_path()) {
  2342. export_path = OS::get_singleton()->get_resource_dir().plus_file(export_path);
  2343. }
  2344. export_path = ProjectSettings::get_singleton()->globalize_path(export_path).simplify_path();
  2345. copy_args.push_back("-Pexport_path=file:" + export_path);
  2346. copy_args.push_back("-Pexport_filename=" + export_filename);
  2347. print_verbose("Copying Android binary using gradle command: " + String("\n") + build_command + " " + join_list(copy_args, String(" ")));
  2348. int copy_result = EditorNode::get_singleton()->execute_and_show_output(TTR("Moving output"), build_command, copy_args);
  2349. if (copy_result != 0) {
  2350. EditorNode::get_singleton()->show_warning(TTR("Unable to copy and rename export file, check gradle project directory for outputs."));
  2351. return ERR_CANT_CREATE;
  2352. }
  2353. print_verbose("Successfully completed Android custom build.");
  2354. return OK;
  2355. }
  2356. // This is the start of the Legacy build system
  2357. print_verbose("Starting legacy build system..");
  2358. if (p_debug) {
  2359. src_apk = p_preset->get("custom_template/debug");
  2360. } else {
  2361. src_apk = p_preset->get("custom_template/release");
  2362. }
  2363. src_apk = src_apk.strip_edges();
  2364. if (src_apk.is_empty()) {
  2365. if (p_debug) {
  2366. src_apk = find_export_template("android_debug.apk");
  2367. } else {
  2368. src_apk = find_export_template("android_release.apk");
  2369. }
  2370. if (src_apk.is_empty()) {
  2371. EditorNode::add_io_error(vformat(TTR("Package not found: %s"), src_apk));
  2372. return ERR_FILE_NOT_FOUND;
  2373. }
  2374. }
  2375. if (!DirAccess::exists(p_path.get_base_dir())) {
  2376. return ERR_FILE_BAD_PATH;
  2377. }
  2378. FileAccess *src_f = nullptr;
  2379. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  2380. if (ep.step(TTR("Creating APK..."), 0)) {
  2381. return ERR_SKIP;
  2382. }
  2383. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  2384. if (!pkg) {
  2385. EditorNode::add_io_error(vformat(TTR("Could not find template APK to export:\n%s"), src_apk));
  2386. return ERR_FILE_NOT_FOUND;
  2387. }
  2388. int ret = unzGoToFirstFile(pkg);
  2389. zlib_filefunc_def io2 = io;
  2390. FileAccess *dst_f = nullptr;
  2391. io2.opaque = &dst_f;
  2392. String tmp_unaligned_path = EditorPaths::get_singleton()->get_cache_dir().plus_file("tmpexport-unaligned." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  2393. #define CLEANUP_AND_RETURN(m_err) \
  2394. { \
  2395. DirAccess::remove_file_or_error(tmp_unaligned_path); \
  2396. return m_err; \
  2397. }
  2398. zipFile unaligned_apk = zipOpen2(tmp_unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2399. String cmdline = p_preset->get("command_line/extra_args");
  2400. String version_name = p_preset->get("version/name");
  2401. String package_name = p_preset->get("package/unique_name");
  2402. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  2403. Vector<String> invalid_abis(enabled_abis);
  2404. while (ret == UNZ_OK) {
  2405. //get filename
  2406. unz_file_info info;
  2407. char fname[16384];
  2408. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  2409. bool skip = false;
  2410. String file = String::utf8(fname);
  2411. Vector<uint8_t> data;
  2412. data.resize(info.uncompressed_size);
  2413. //read
  2414. unzOpenCurrentFile(pkg);
  2415. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  2416. unzCloseCurrentFile(pkg);
  2417. //write
  2418. if (file == "AndroidManifest.xml") {
  2419. _fix_manifest(p_preset, data, p_give_internet);
  2420. }
  2421. if (file == "resources.arsc") {
  2422. _fix_resources(p_preset, data);
  2423. }
  2424. // Process the splash image
  2425. if ((file == SPLASH_IMAGE_EXPORT_PATH || file == LEGACY_BUILD_SPLASH_IMAGE_EXPORT_PATH) && splash_image.is_valid() && !splash_image->is_empty()) {
  2426. _load_image_data(splash_image, data);
  2427. }
  2428. // Process the splash bg color image
  2429. if ((file == SPLASH_BG_COLOR_PATH || file == LEGACY_BUILD_SPLASH_BG_COLOR_PATH) && splash_bg_color_image.is_valid() && !splash_bg_color_image->is_empty()) {
  2430. _load_image_data(splash_bg_color_image, data);
  2431. }
  2432. for (int i = 0; i < icon_densities_count; ++i) {
  2433. if (main_image.is_valid() && !main_image->is_empty()) {
  2434. if (file == launcher_icons[i].export_path) {
  2435. _process_launcher_icons(file, main_image, launcher_icons[i].dimensions, data);
  2436. }
  2437. }
  2438. if (foreground.is_valid() && !foreground->is_empty()) {
  2439. if (file == launcher_adaptive_icon_foregrounds[i].export_path) {
  2440. _process_launcher_icons(file, foreground, launcher_adaptive_icon_foregrounds[i].dimensions, data);
  2441. }
  2442. }
  2443. if (background.is_valid() && !background->is_empty()) {
  2444. if (file == launcher_adaptive_icon_backgrounds[i].export_path) {
  2445. _process_launcher_icons(file, background, launcher_adaptive_icon_backgrounds[i].dimensions, data);
  2446. }
  2447. }
  2448. }
  2449. if (file.ends_with(".so")) {
  2450. bool enabled = false;
  2451. for (int i = 0; i < enabled_abis.size(); ++i) {
  2452. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  2453. invalid_abis.erase(enabled_abis[i]);
  2454. enabled = true;
  2455. break;
  2456. }
  2457. }
  2458. if (!enabled) {
  2459. skip = true;
  2460. }
  2461. }
  2462. if (file.begins_with("META-INF") && should_sign) {
  2463. skip = true;
  2464. }
  2465. if (!skip) {
  2466. print_line("ADDING: " + file);
  2467. // Respect decision on compression made by AAPT for the export template
  2468. const bool uncompressed = info.compression_method == 0;
  2469. zip_fileinfo zipfi = get_zip_fileinfo();
  2470. zipOpenNewFileInZip(unaligned_apk,
  2471. file.utf8().get_data(),
  2472. &zipfi,
  2473. nullptr,
  2474. 0,
  2475. nullptr,
  2476. 0,
  2477. nullptr,
  2478. uncompressed ? 0 : Z_DEFLATED,
  2479. Z_DEFAULT_COMPRESSION);
  2480. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  2481. zipCloseFileInZip(unaligned_apk);
  2482. }
  2483. ret = unzGoToNextFile(pkg);
  2484. }
  2485. if (!invalid_abis.is_empty()) {
  2486. String unsupported_arch = String(", ").join(invalid_abis);
  2487. EditorNode::add_io_error(vformat(TTR("Missing libraries in the export template for the selected architectures: %s.\nPlease build a template with all required libraries, or uncheck the missing architectures in the export preset."), unsupported_arch));
  2488. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2489. }
  2490. if (ep.step(TTR("Adding files..."), 1)) {
  2491. CLEANUP_AND_RETURN(ERR_SKIP);
  2492. }
  2493. err = OK;
  2494. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  2495. APKExportData ed;
  2496. ed.ep = &ep;
  2497. ed.apk = unaligned_apk;
  2498. err = export_project_files(p_preset, p_debug, ignore_apk_file, &ed, save_apk_so);
  2499. } else {
  2500. if (apk_expansion) {
  2501. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  2502. if (err != OK) {
  2503. EditorNode::add_io_error(TTR("Could not write expansion package file!"));
  2504. return err;
  2505. }
  2506. } else {
  2507. APKExportData ed;
  2508. ed.ep = &ep;
  2509. ed.apk = unaligned_apk;
  2510. err = export_project_files(p_preset, p_debug, save_apk_file, &ed, save_apk_so);
  2511. }
  2512. }
  2513. if (err != OK) {
  2514. unzClose(pkg);
  2515. EditorNode::add_io_error(TTR("Could not export project files"));
  2516. CLEANUP_AND_RETURN(ERR_SKIP);
  2517. }
  2518. zip_fileinfo zipfi = get_zip_fileinfo();
  2519. zipOpenNewFileInZip(unaligned_apk,
  2520. "assets/_cl_",
  2521. &zipfi,
  2522. nullptr,
  2523. 0,
  2524. nullptr,
  2525. 0,
  2526. nullptr,
  2527. 0, // No compress (little size gain and potentially slower startup)
  2528. Z_DEFAULT_COMPRESSION);
  2529. zipWriteInFileInZip(unaligned_apk, command_line_flags.ptr(), command_line_flags.size());
  2530. zipCloseFileInZip(unaligned_apk);
  2531. zipClose(unaligned_apk, nullptr);
  2532. unzClose(pkg);
  2533. if (err != OK) {
  2534. CLEANUP_AND_RETURN(err);
  2535. }
  2536. // Let's zip-align (must be done before signing)
  2537. static const int ZIP_ALIGNMENT = 4;
  2538. // If we're not signing the apk, then the next step should be the last.
  2539. const int next_step = should_sign ? 103 : 105;
  2540. if (ep.step(TTR("Aligning APK..."), next_step)) {
  2541. CLEANUP_AND_RETURN(ERR_SKIP);
  2542. }
  2543. unzFile tmp_unaligned = unzOpen2(tmp_unaligned_path.utf8().get_data(), &io);
  2544. if (!tmp_unaligned) {
  2545. EditorNode::add_io_error(TTR("Could not unzip temporary unaligned APK."));
  2546. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2547. }
  2548. ret = unzGoToFirstFile(tmp_unaligned);
  2549. io2 = io;
  2550. dst_f = nullptr;
  2551. io2.opaque = &dst_f;
  2552. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2553. // Take files from the unaligned APK and write them out to the aligned one
  2554. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  2555. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  2556. int bias = 0;
  2557. while (ret == UNZ_OK) {
  2558. unz_file_info info;
  2559. memset(&info, 0, sizeof(info));
  2560. char fname[16384];
  2561. char extra[16384];
  2562. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, nullptr, 0);
  2563. String file = String::utf8(fname);
  2564. Vector<uint8_t> data;
  2565. data.resize(info.compressed_size);
  2566. // read
  2567. int method, level;
  2568. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  2569. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  2570. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  2571. unzCloseCurrentFile(tmp_unaligned);
  2572. // align
  2573. int padding = 0;
  2574. if (!info.compression_method) {
  2575. // Uncompressed file => Align
  2576. long new_offset = file_offset + bias;
  2577. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  2578. }
  2579. memset(extra + info.size_file_extra, 0, padding);
  2580. zip_fileinfo fileinfo = get_zip_fileinfo();
  2581. zipOpenNewFileInZip2(final_apk,
  2582. file.utf8().get_data(),
  2583. &fileinfo,
  2584. extra,
  2585. info.size_file_extra + padding,
  2586. nullptr,
  2587. 0,
  2588. nullptr,
  2589. method,
  2590. level,
  2591. 1); // raw write
  2592. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  2593. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  2594. bias += padding;
  2595. ret = unzGoToNextFile(tmp_unaligned);
  2596. }
  2597. zipClose(final_apk, nullptr);
  2598. unzClose(tmp_unaligned);
  2599. if (should_sign) {
  2600. // Signing must be done last as any additional modifications to the
  2601. // file will invalidate the signature.
  2602. err = sign_apk(p_preset, p_debug, p_path, ep);
  2603. if (err != OK) {
  2604. CLEANUP_AND_RETURN(err);
  2605. }
  2606. }
  2607. CLEANUP_AND_RETURN(OK);
  2608. }
  2609. void EditorExportPlatformAndroid::get_platform_features(List<String> *r_features) {
  2610. r_features->push_back("mobile");
  2611. r_features->push_back("android");
  2612. }
  2613. void EditorExportPlatformAndroid::resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  2614. }
  2615. EditorExportPlatformAndroid::EditorExportPlatformAndroid() {
  2616. Ref<Image> img = memnew(Image(_android_logo));
  2617. logo.instantiate();
  2618. logo->create_from_image(img);
  2619. img = Ref<Image>(memnew(Image(_android_run_icon)));
  2620. run_icon.instantiate();
  2621. run_icon->create_from_image(img);
  2622. devices_changed.set();
  2623. plugins_changed.set();
  2624. check_for_changes_thread.start(_check_for_changes_poll_thread, this);
  2625. }
  2626. EditorExportPlatformAndroid::~EditorExportPlatformAndroid() {
  2627. quit_request.set();
  2628. check_for_changes_thread.wait_to_finish();
  2629. }