export.cpp 108 KB

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