export_plugin.cpp 114 KB

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