export.cpp 115 KB

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