export.cpp 104 KB

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