export_plugin.cpp 145 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859
  1. /**************************************************************************/
  2. /* export_plugin.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "export_plugin.h"
  31. #include "gradle_export_util.h"
  32. #include "logo_svg.gen.h"
  33. #include "run_icon_svg.gen.h"
  34. #include "core/config/project_settings.h"
  35. #include "core/io/dir_access.h"
  36. #include "core/io/file_access.h"
  37. #include "core/io/image_loader.h"
  38. #include "core/io/json.h"
  39. #include "core/io/marshalls.h"
  40. #include "core/version.h"
  41. #include "drivers/png/png_driver_common.h"
  42. #include "editor/editor_log.h"
  43. #include "editor/editor_node.h"
  44. #include "editor/editor_paths.h"
  45. #include "editor/editor_settings.h"
  46. #include "editor/export/export_template_manager.h"
  47. #include "editor/import/resource_importer_texture_settings.h"
  48. #include "editor/themes/editor_scale.h"
  49. #include "main/splash.gen.h"
  50. #include "scene/resources/image_texture.h"
  51. #include "modules/modules_enabled.gen.h" // For mono.
  52. #include "modules/svg/image_loader_svg.h"
  53. #ifdef ANDROID_ENABLED
  54. #include "../os_android.h"
  55. #endif
  56. #include <string.h>
  57. static const char *ANDROID_PERMS[] = {
  58. "ACCESS_CHECKIN_PROPERTIES",
  59. "ACCESS_COARSE_LOCATION",
  60. "ACCESS_FINE_LOCATION",
  61. "ACCESS_LOCATION_EXTRA_COMMANDS",
  62. "ACCESS_MEDIA_LOCATION",
  63. "ACCESS_MOCK_LOCATION",
  64. "ACCESS_NETWORK_STATE",
  65. "ACCESS_SURFACE_FLINGER",
  66. "ACCESS_WIFI_STATE",
  67. "ACCOUNT_MANAGER",
  68. "ADD_VOICEMAIL",
  69. "AUTHENTICATE_ACCOUNTS",
  70. "BATTERY_STATS",
  71. "BIND_ACCESSIBILITY_SERVICE",
  72. "BIND_APPWIDGET",
  73. "BIND_DEVICE_ADMIN",
  74. "BIND_INPUT_METHOD",
  75. "BIND_NFC_SERVICE",
  76. "BIND_NOTIFICATION_LISTENER_SERVICE",
  77. "BIND_PRINT_SERVICE",
  78. "BIND_REMOTEVIEWS",
  79. "BIND_TEXT_SERVICE",
  80. "BIND_VPN_SERVICE",
  81. "BIND_WALLPAPER",
  82. "BLUETOOTH",
  83. "BLUETOOTH_ADMIN",
  84. "BLUETOOTH_PRIVILEGED",
  85. "BRICK",
  86. "BROADCAST_PACKAGE_REMOVED",
  87. "BROADCAST_SMS",
  88. "BROADCAST_STICKY",
  89. "BROADCAST_WAP_PUSH",
  90. "CALL_PHONE",
  91. "CALL_PRIVILEGED",
  92. "CAMERA",
  93. "CAPTURE_AUDIO_OUTPUT",
  94. "CAPTURE_SECURE_VIDEO_OUTPUT",
  95. "CAPTURE_VIDEO_OUTPUT",
  96. "CHANGE_COMPONENT_ENABLED_STATE",
  97. "CHANGE_CONFIGURATION",
  98. "CHANGE_NETWORK_STATE",
  99. "CHANGE_WIFI_MULTICAST_STATE",
  100. "CHANGE_WIFI_STATE",
  101. "CLEAR_APP_CACHE",
  102. "CLEAR_APP_USER_DATA",
  103. "CONTROL_LOCATION_UPDATES",
  104. "DELETE_CACHE_FILES",
  105. "DELETE_PACKAGES",
  106. "DEVICE_POWER",
  107. "DIAGNOSTIC",
  108. "DISABLE_KEYGUARD",
  109. "DUMP",
  110. "EXPAND_STATUS_BAR",
  111. "FACTORY_TEST",
  112. "FLASHLIGHT",
  113. "FORCE_BACK",
  114. "GET_ACCOUNTS",
  115. "GET_PACKAGE_SIZE",
  116. "GET_TASKS",
  117. "GET_TOP_ACTIVITY_INFO",
  118. "GLOBAL_SEARCH",
  119. "HARDWARE_TEST",
  120. "INJECT_EVENTS",
  121. "INSTALL_LOCATION_PROVIDER",
  122. "INSTALL_PACKAGES",
  123. "INSTALL_SHORTCUT",
  124. "INTERNAL_SYSTEM_WINDOW",
  125. "INTERNET",
  126. "KILL_BACKGROUND_PROCESSES",
  127. "LOCATION_HARDWARE",
  128. "MANAGE_ACCOUNTS",
  129. "MANAGE_APP_TOKENS",
  130. "MANAGE_DOCUMENTS",
  131. "MANAGE_EXTERNAL_STORAGE",
  132. "MASTER_CLEAR",
  133. "MEDIA_CONTENT_CONTROL",
  134. "MODIFY_AUDIO_SETTINGS",
  135. "MODIFY_PHONE_STATE",
  136. "MOUNT_FORMAT_FILESYSTEMS",
  137. "MOUNT_UNMOUNT_FILESYSTEMS",
  138. "NFC",
  139. "PERSISTENT_ACTIVITY",
  140. "POST_NOTIFICATIONS",
  141. "PROCESS_OUTGOING_CALLS",
  142. "READ_CALENDAR",
  143. "READ_CALL_LOG",
  144. "READ_CONTACTS",
  145. "READ_EXTERNAL_STORAGE",
  146. "READ_FRAME_BUFFER",
  147. "READ_HISTORY_BOOKMARKS",
  148. "READ_INPUT_STATE",
  149. "READ_LOGS",
  150. "READ_MEDIA_AUDIO",
  151. "READ_MEDIA_IMAGES",
  152. "READ_MEDIA_VIDEO",
  153. "READ_MEDIA_VISUAL_USER_SELECTED",
  154. "READ_PHONE_STATE",
  155. "READ_PROFILE",
  156. "READ_SMS",
  157. "READ_SOCIAL_STREAM",
  158. "READ_SYNC_SETTINGS",
  159. "READ_SYNC_STATS",
  160. "READ_USER_DICTIONARY",
  161. "REBOOT",
  162. "RECEIVE_BOOT_COMPLETED",
  163. "RECEIVE_MMS",
  164. "RECEIVE_SMS",
  165. "RECEIVE_WAP_PUSH",
  166. "RECORD_AUDIO",
  167. "REORDER_TASKS",
  168. "RESTART_PACKAGES",
  169. "SEND_RESPOND_VIA_MESSAGE",
  170. "SEND_SMS",
  171. "SET_ACTIVITY_WATCHER",
  172. "SET_ALARM",
  173. "SET_ALWAYS_FINISH",
  174. "SET_ANIMATION_SCALE",
  175. "SET_DEBUG_APP",
  176. "SET_ORIENTATION",
  177. "SET_POINTER_SPEED",
  178. "SET_PREFERRED_APPLICATIONS",
  179. "SET_PROCESS_LIMIT",
  180. "SET_TIME",
  181. "SET_TIME_ZONE",
  182. "SET_WALLPAPER",
  183. "SET_WALLPAPER_HINTS",
  184. "SIGNAL_PERSISTENT_PROCESSES",
  185. "STATUS_BAR",
  186. "SUBSCRIBED_FEEDS_READ",
  187. "SUBSCRIBED_FEEDS_WRITE",
  188. "SYSTEM_ALERT_WINDOW",
  189. "TRANSMIT_IR",
  190. "UNINSTALL_SHORTCUT",
  191. "UPDATE_DEVICE_STATS",
  192. "USE_CREDENTIALS",
  193. "USE_SIP",
  194. "VIBRATE",
  195. "WAKE_LOCK",
  196. "WRITE_APN_SETTINGS",
  197. "WRITE_CALENDAR",
  198. "WRITE_CALL_LOG",
  199. "WRITE_CONTACTS",
  200. "WRITE_EXTERNAL_STORAGE",
  201. "WRITE_GSERVICES",
  202. "WRITE_HISTORY_BOOKMARKS",
  203. "WRITE_PROFILE",
  204. "WRITE_SECURE_SETTINGS",
  205. "WRITE_SETTINGS",
  206. "WRITE_SMS",
  207. "WRITE_SOCIAL_STREAM",
  208. "WRITE_SYNC_SETTINGS",
  209. "WRITE_USER_DICTIONARY",
  210. nullptr
  211. };
  212. static const char *MISMATCHED_VERSIONS_MESSAGE = "Android build version mismatch:\n| Template installed: %s\n| Requested version: %s\nPlease reinstall Android build template from 'Project' menu.";
  213. static const char *GDEXTENSION_LIBS_PATH = "libs/gdextensionlibs.json";
  214. // This template string must be in sync with the content of 'platform/android/java/lib/res/mipmap-anydpi-v26/icon.xml'.
  215. static const String ICON_XML_TEMPLATE =
  216. "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
  217. "<adaptive-icon xmlns:android=\"http://schemas.android.com/apk/res/android\">\n"
  218. " <background android:drawable=\"@mipmap/icon_background\"/>\n"
  219. " <foreground android:drawable=\"@mipmap/icon_foreground\"/>\n"
  220. "%s" // Placeholder for the optional monochrome tag.
  221. "</adaptive-icon>";
  222. static const String ICON_XML_PATH = "res/mipmap-anydpi-v26/icon.xml";
  223. static const String THEMED_ICON_XML_PATH = "res/mipmap-anydpi-v26/themed_icon.xml";
  224. static const int ICON_DENSITIES_COUNT = 6;
  225. static const char *LAUNCHER_ICON_OPTION = PNAME("launcher_icons/main_192x192");
  226. static const char *LAUNCHER_ADAPTIVE_ICON_FOREGROUND_OPTION = PNAME("launcher_icons/adaptive_foreground_432x432");
  227. static const char *LAUNCHER_ADAPTIVE_ICON_BACKGROUND_OPTION = PNAME("launcher_icons/adaptive_background_432x432");
  228. static const char *LAUNCHER_ADAPTIVE_ICON_MONOCHROME_OPTION = PNAME("launcher_icons/adaptive_monochrome_432x432");
  229. static const LauncherIcon LAUNCHER_ICONS[ICON_DENSITIES_COUNT] = {
  230. { "res/mipmap-xxxhdpi-v4/icon.png", 192 },
  231. { "res/mipmap-xxhdpi-v4/icon.png", 144 },
  232. { "res/mipmap-xhdpi-v4/icon.png", 96 },
  233. { "res/mipmap-hdpi-v4/icon.png", 72 },
  234. { "res/mipmap-mdpi-v4/icon.png", 48 },
  235. { "res/mipmap/icon.png", 192 }
  236. };
  237. static const LauncherIcon LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[ICON_DENSITIES_COUNT] = {
  238. { "res/mipmap-xxxhdpi-v4/icon_foreground.png", 432 },
  239. { "res/mipmap-xxhdpi-v4/icon_foreground.png", 324 },
  240. { "res/mipmap-xhdpi-v4/icon_foreground.png", 216 },
  241. { "res/mipmap-hdpi-v4/icon_foreground.png", 162 },
  242. { "res/mipmap-mdpi-v4/icon_foreground.png", 108 },
  243. { "res/mipmap/icon_foreground.png", 432 }
  244. };
  245. static const LauncherIcon LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[ICON_DENSITIES_COUNT] = {
  246. { "res/mipmap-xxxhdpi-v4/icon_background.png", 432 },
  247. { "res/mipmap-xxhdpi-v4/icon_background.png", 324 },
  248. { "res/mipmap-xhdpi-v4/icon_background.png", 216 },
  249. { "res/mipmap-hdpi-v4/icon_background.png", 162 },
  250. { "res/mipmap-mdpi-v4/icon_background.png", 108 },
  251. { "res/mipmap/icon_background.png", 432 }
  252. };
  253. static const LauncherIcon LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[ICON_DENSITIES_COUNT] = {
  254. { "res/mipmap-xxxhdpi-v4/icon_monochrome.png", 432 },
  255. { "res/mipmap-xxhdpi-v4/icon_monochrome.png", 324 },
  256. { "res/mipmap-xhdpi-v4/icon_monochrome.png", 216 },
  257. { "res/mipmap-hdpi-v4/icon_monochrome.png", 162 },
  258. { "res/mipmap-mdpi-v4/icon_monochrome.png", 108 },
  259. { "res/mipmap/icon_monochrome.png", 432 }
  260. };
  261. static const int EXPORT_FORMAT_APK = 0;
  262. static const int EXPORT_FORMAT_AAB = 1;
  263. static const char *APK_ASSETS_DIRECTORY = "assets";
  264. static const char *AAB_ASSETS_DIRECTORY = "assetPacks/installTime/src/main/assets";
  265. static const int OPENGL_MIN_SDK_VERSION = 21; // Should match the value in 'platform/android/java/app/config.gradle#minSdk'
  266. static const int VULKAN_MIN_SDK_VERSION = 24;
  267. static const int DEFAULT_TARGET_SDK_VERSION = 34; // Should match the value in 'platform/android/java/app/config.gradle#targetSdk'
  268. #ifndef ANDROID_ENABLED
  269. void EditorExportPlatformAndroid::_check_for_changes_poll_thread(void *ud) {
  270. EditorExportPlatformAndroid *ea = static_cast<EditorExportPlatformAndroid *>(ud);
  271. while (!ea->quit_request.is_set()) {
  272. #ifndef DISABLE_DEPRECATED
  273. // Check for android plugins updates
  274. {
  275. // Nothing to do if we already know the plugins have changed.
  276. if (!ea->android_plugins_changed.is_set()) {
  277. Vector<PluginConfigAndroid> loaded_plugins = get_plugins();
  278. MutexLock lock(ea->android_plugins_lock);
  279. if (ea->android_plugins.size() != loaded_plugins.size()) {
  280. ea->android_plugins_changed.set();
  281. } else {
  282. for (int i = 0; i < ea->android_plugins.size(); i++) {
  283. if (ea->android_plugins[i].name != loaded_plugins[i].name) {
  284. ea->android_plugins_changed.set();
  285. break;
  286. }
  287. }
  288. }
  289. if (ea->android_plugins_changed.is_set()) {
  290. ea->android_plugins = loaded_plugins;
  291. }
  292. }
  293. }
  294. #endif // DISABLE_DEPRECATED
  295. // Check for devices updates
  296. String adb = get_adb_path();
  297. // adb.exe was locking the editor_doc_cache file on startup. Adding a check for is_editor_ready provides just enough time
  298. // to regenerate the doc cache.
  299. if (ea->has_runnable_preset.is_set() && FileAccess::exists(adb) && EditorNode::get_singleton()->is_editor_ready()) {
  300. String devices;
  301. List<String> args;
  302. args.push_back("devices");
  303. int ec;
  304. OS::get_singleton()->execute(adb, args, &devices, &ec);
  305. Vector<String> ds = devices.split("\n");
  306. Vector<String> ldevices;
  307. for (int i = 1; i < ds.size(); i++) {
  308. String d = ds[i];
  309. int dpos = d.find("device");
  310. if (dpos == -1) {
  311. continue;
  312. }
  313. d = d.substr(0, dpos).strip_edges();
  314. ldevices.push_back(d);
  315. }
  316. MutexLock lock(ea->device_lock);
  317. bool different = false;
  318. if (ea->devices.size() != ldevices.size()) {
  319. different = true;
  320. } else {
  321. for (int i = 0; i < ea->devices.size(); i++) {
  322. if (ea->devices[i].id != ldevices[i]) {
  323. different = true;
  324. break;
  325. }
  326. }
  327. }
  328. if (different) {
  329. Vector<Device> ndevices;
  330. for (int i = 0; i < ldevices.size(); i++) {
  331. Device d;
  332. d.id = ldevices[i];
  333. for (int j = 0; j < ea->devices.size(); j++) {
  334. if (ea->devices[j].id == ldevices[i]) {
  335. d.description = ea->devices[j].description;
  336. d.name = ea->devices[j].name;
  337. d.api_level = ea->devices[j].api_level;
  338. }
  339. }
  340. if (d.description.is_empty()) {
  341. //in the oven, request!
  342. args.clear();
  343. args.push_back("-s");
  344. args.push_back(d.id);
  345. args.push_back("shell");
  346. args.push_back("getprop");
  347. int ec2;
  348. String dp;
  349. OS::get_singleton()->execute(adb, args, &dp, &ec2);
  350. Vector<String> props = dp.split("\n");
  351. String vendor;
  352. String device;
  353. d.description = "Device ID: " + d.id + "\n";
  354. d.api_level = 0;
  355. for (int j = 0; j < props.size(); j++) {
  356. // got information by `shell cat /system/build.prop` before and its format is "property=value"
  357. // it's now changed to use `shell getporp` because of permission issue with Android 8.0 and above
  358. // its format is "[property]: [value]" so changed it as like build.prop
  359. String p = props[j];
  360. p = p.replace("]: ", "=");
  361. p = p.replace("[", "");
  362. p = p.replace("]", "");
  363. if (p.begins_with("ro.product.model=")) {
  364. device = p.get_slice("=", 1).strip_edges();
  365. } else if (p.begins_with("ro.product.brand=")) {
  366. vendor = p.get_slice("=", 1).strip_edges().capitalize();
  367. } else if (p.begins_with("ro.build.display.id=")) {
  368. d.description += "Build: " + p.get_slice("=", 1).strip_edges() + "\n";
  369. } else if (p.begins_with("ro.build.version.release=")) {
  370. d.description += "Release: " + p.get_slice("=", 1).strip_edges() + "\n";
  371. } else if (p.begins_with("ro.build.version.sdk=")) {
  372. d.api_level = p.get_slice("=", 1).to_int();
  373. } else if (p.begins_with("ro.product.cpu.abi=")) {
  374. d.architecture = p.get_slice("=", 1).strip_edges();
  375. d.description += "CPU: " + d.architecture + "\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.is_empty()) {
  387. continue;
  388. }
  389. }
  390. ndevices.push_back(d);
  391. }
  392. ea->devices = ndevices;
  393. ea->devices_changed.set();
  394. }
  395. }
  396. uint64_t sleep = 200;
  397. uint64_t wait = 3000000;
  398. uint64_t time = OS::get_singleton()->get_ticks_usec();
  399. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  400. OS::get_singleton()->delay_usec(1000 * sleep);
  401. if (ea->quit_request.is_set()) {
  402. break;
  403. }
  404. }
  405. }
  406. if (ea->has_runnable_preset.is_set() && EDITOR_GET("export/android/shutdown_adb_on_exit")) {
  407. String adb = get_adb_path();
  408. if (!FileAccess::exists(adb)) {
  409. return; //adb not configured
  410. }
  411. List<String> args;
  412. args.push_back("kill-server");
  413. OS::get_singleton()->execute(adb, args);
  414. }
  415. }
  416. void EditorExportPlatformAndroid::_update_preset_status() {
  417. const int preset_count = EditorExport::get_singleton()->get_export_preset_count();
  418. bool has_runnable = false;
  419. for (int i = 0; i < preset_count; i++) {
  420. const Ref<EditorExportPreset> &preset = EditorExport::get_singleton()->get_export_preset(i);
  421. if (preset->get_platform() == this && preset->is_runnable()) {
  422. has_runnable = true;
  423. break;
  424. }
  425. }
  426. if (has_runnable) {
  427. has_runnable_preset.set();
  428. } else {
  429. has_runnable_preset.clear();
  430. }
  431. devices_changed.set();
  432. }
  433. #endif
  434. String EditorExportPlatformAndroid::get_project_name(const String &p_name) const {
  435. String aname;
  436. if (!p_name.is_empty()) {
  437. aname = p_name;
  438. } else {
  439. aname = GLOBAL_GET("application/config/name");
  440. }
  441. if (aname.is_empty()) {
  442. aname = VERSION_NAME;
  443. }
  444. return aname;
  445. }
  446. String EditorExportPlatformAndroid::get_package_name(const String &p_package) const {
  447. String pname = p_package;
  448. String name = get_valid_basename();
  449. pname = pname.replace("$genname", name);
  450. return pname;
  451. }
  452. // Returns the project name without invalid characters
  453. // or the "noname" string if all characters are invalid.
  454. String EditorExportPlatformAndroid::get_valid_basename() const {
  455. String basename = GLOBAL_GET("application/config/name");
  456. basename = basename.to_lower();
  457. String name;
  458. bool first = true;
  459. for (int i = 0; i < basename.length(); i++) {
  460. char32_t c = basename[i];
  461. if (is_digit(c) && first) {
  462. continue;
  463. }
  464. if (is_ascii_identifier_char(c)) {
  465. name += String::chr(c);
  466. first = false;
  467. }
  468. }
  469. if (name.is_empty()) {
  470. name = "noname";
  471. }
  472. return name;
  473. }
  474. String EditorExportPlatformAndroid::get_assets_directory(const Ref<EditorExportPreset> &p_preset, int p_export_format) const {
  475. String gradle_build_directory = ExportTemplateManager::get_android_build_directory(p_preset);
  476. return gradle_build_directory.path_join(p_export_format == EXPORT_FORMAT_AAB ? AAB_ASSETS_DIRECTORY : APK_ASSETS_DIRECTORY);
  477. }
  478. bool EditorExportPlatformAndroid::is_package_name_valid(const String &p_package, String *r_error) const {
  479. String pname = get_package_name(p_package);
  480. if (pname.length() == 0) {
  481. if (r_error) {
  482. *r_error = TTR("Package name is missing.");
  483. }
  484. return false;
  485. }
  486. int segments = 0;
  487. bool first = true;
  488. for (int i = 0; i < pname.length(); i++) {
  489. char32_t c = pname[i];
  490. if (first && c == '.') {
  491. if (r_error) {
  492. *r_error = TTR("Package segments must be of non-zero length.");
  493. }
  494. return false;
  495. }
  496. if (c == '.') {
  497. segments++;
  498. first = true;
  499. continue;
  500. }
  501. if (!is_ascii_identifier_char(c)) {
  502. if (r_error) {
  503. *r_error = vformat(TTR("The character '%s' is not allowed in Android application package names."), String::chr(c));
  504. }
  505. return false;
  506. }
  507. if (first && is_digit(c)) {
  508. if (r_error) {
  509. *r_error = TTR("A digit cannot be the first character in a package segment.");
  510. }
  511. return false;
  512. }
  513. if (first && is_underscore(c)) {
  514. if (r_error) {
  515. *r_error = vformat(TTR("The character '%s' cannot be the first character in a package segment."), String::chr(c));
  516. }
  517. return false;
  518. }
  519. first = false;
  520. }
  521. if (segments == 0) {
  522. if (r_error) {
  523. *r_error = TTR("The package must have at least one '.' separator.");
  524. }
  525. return false;
  526. }
  527. if (first) {
  528. if (r_error) {
  529. *r_error = TTR("Package segments must be of non-zero length.");
  530. }
  531. return false;
  532. }
  533. return true;
  534. }
  535. bool EditorExportPlatformAndroid::is_project_name_valid() const {
  536. // Get the original project name and convert to lowercase.
  537. String basename = GLOBAL_GET("application/config/name");
  538. basename = basename.to_lower();
  539. // Check if there are invalid characters.
  540. if (basename != get_valid_basename()) {
  541. return false;
  542. }
  543. return true;
  544. }
  545. bool EditorExportPlatformAndroid::_should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  546. /*
  547. * By not compressing files with little or no benefit in doing so,
  548. * a performance gain is expected at runtime. Moreover, if the APK is
  549. * zip-aligned, assets stored as they are can be efficiently read by
  550. * Android by memory-mapping them.
  551. */
  552. // -- Unconditional uncompress to mimic AAPT plus some other
  553. static const char *unconditional_compress_ext[] = {
  554. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  555. // These formats are already compressed, or don't compress well:
  556. ".jpg", ".jpeg", ".png", ".gif",
  557. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  558. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  559. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  560. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  561. ".amr", ".awb", ".wma", ".wmv",
  562. // Godot-specific:
  563. ".webp", // Same reasoning as .png
  564. ".cfb", // Don't let small config files slow-down startup
  565. ".scn", // Binary scenes are usually already compressed
  566. ".ctex", // Streamable textures are usually already compressed
  567. // Trailer for easier processing
  568. nullptr
  569. };
  570. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  571. if (p_path.to_lower().ends_with(String(*ext))) {
  572. return false;
  573. }
  574. }
  575. // -- Compressed resource?
  576. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  577. // Already compressed
  578. return false;
  579. }
  580. // --- TODO: Decide on texture resources according to their image compression setting
  581. return true;
  582. }
  583. zip_fileinfo EditorExportPlatformAndroid::get_zip_fileinfo() {
  584. OS::DateTime dt = OS::get_singleton()->get_datetime();
  585. zip_fileinfo zipfi;
  586. zipfi.tmz_date.tm_year = dt.year;
  587. zipfi.tmz_date.tm_mon = dt.month - 1; // tm_mon is zero indexed
  588. zipfi.tmz_date.tm_mday = dt.day;
  589. zipfi.tmz_date.tm_hour = dt.hour;
  590. zipfi.tmz_date.tm_min = dt.minute;
  591. zipfi.tmz_date.tm_sec = dt.second;
  592. zipfi.dosDate = 0;
  593. zipfi.external_fa = 0;
  594. zipfi.internal_fa = 0;
  595. return zipfi;
  596. }
  597. Vector<EditorExportPlatformAndroid::ABI> EditorExportPlatformAndroid::get_abis() {
  598. // Should have the same order and size as get_archs.
  599. Vector<ABI> abis;
  600. abis.push_back(ABI("armeabi-v7a", "arm32"));
  601. abis.push_back(ABI("arm64-v8a", "arm64"));
  602. abis.push_back(ABI("x86", "x86_32"));
  603. abis.push_back(ABI("x86_64", "x86_64"));
  604. return abis;
  605. }
  606. #ifndef DISABLE_DEPRECATED
  607. /// List the gdap files in the directory specified by the p_path parameter.
  608. Vector<String> EditorExportPlatformAndroid::list_gdap_files(const String &p_path) {
  609. Vector<String> dir_files;
  610. Ref<DirAccess> da = DirAccess::open(p_path);
  611. if (da.is_valid()) {
  612. da->list_dir_begin();
  613. while (true) {
  614. String file = da->get_next();
  615. if (file.is_empty()) {
  616. break;
  617. }
  618. if (da->current_is_dir() || da->current_is_hidden()) {
  619. continue;
  620. }
  621. if (file.ends_with(PluginConfigAndroid::PLUGIN_CONFIG_EXT)) {
  622. dir_files.push_back(file);
  623. }
  624. }
  625. da->list_dir_end();
  626. }
  627. return dir_files;
  628. }
  629. Vector<PluginConfigAndroid> EditorExportPlatformAndroid::get_plugins() {
  630. Vector<PluginConfigAndroid> loaded_plugins;
  631. String plugins_dir = ProjectSettings::get_singleton()->get_resource_path().path_join("android/plugins");
  632. // Add the prebuilt plugins
  633. loaded_plugins.append_array(PluginConfigAndroid::get_prebuilt_plugins(plugins_dir));
  634. if (DirAccess::exists(plugins_dir)) {
  635. Vector<String> plugins_filenames = list_gdap_files(plugins_dir);
  636. if (!plugins_filenames.is_empty()) {
  637. Ref<ConfigFile> config_file = memnew(ConfigFile);
  638. for (int i = 0; i < plugins_filenames.size(); i++) {
  639. PluginConfigAndroid config = PluginConfigAndroid::load_plugin_config(config_file, plugins_dir.path_join(plugins_filenames[i]));
  640. if (config.valid_config) {
  641. loaded_plugins.push_back(config);
  642. } else {
  643. print_error("Invalid plugin config file " + plugins_filenames[i]);
  644. }
  645. }
  646. }
  647. }
  648. return loaded_plugins;
  649. }
  650. Vector<PluginConfigAndroid> EditorExportPlatformAndroid::get_enabled_plugins(const Ref<EditorExportPreset> &p_presets) {
  651. Vector<PluginConfigAndroid> enabled_plugins;
  652. Vector<PluginConfigAndroid> all_plugins = get_plugins();
  653. for (int i = 0; i < all_plugins.size(); i++) {
  654. PluginConfigAndroid plugin = all_plugins[i];
  655. bool enabled = p_presets->get("plugins/" + plugin.name);
  656. if (enabled) {
  657. enabled_plugins.push_back(plugin);
  658. }
  659. }
  660. return enabled_plugins;
  661. }
  662. #endif // DISABLE_DEPRECATED
  663. Error EditorExportPlatformAndroid::store_in_apk(APKExportData *ed, const String &p_path, const Vector<uint8_t> &p_data, int compression_method) {
  664. zip_fileinfo zipfi = get_zip_fileinfo();
  665. zipOpenNewFileInZip(ed->apk,
  666. p_path.utf8().get_data(),
  667. &zipfi,
  668. nullptr,
  669. 0,
  670. nullptr,
  671. 0,
  672. nullptr,
  673. compression_method,
  674. Z_DEFAULT_COMPRESSION);
  675. zipWriteInFileInZip(ed->apk, p_data.ptr(), p_data.size());
  676. zipCloseFileInZip(ed->apk);
  677. return OK;
  678. }
  679. Error EditorExportPlatformAndroid::save_apk_so(void *p_userdata, const SharedObject &p_so) {
  680. if (!p_so.path.get_file().begins_with("lib")) {
  681. String err = "Android .so file names must start with \"lib\", but got: " + p_so.path;
  682. ERR_PRINT(err);
  683. return FAILED;
  684. }
  685. APKExportData *ed = static_cast<APKExportData *>(p_userdata);
  686. Vector<ABI> abis = get_abis();
  687. bool exported = false;
  688. for (int i = 0; i < p_so.tags.size(); ++i) {
  689. // shared objects can be fat (compatible with multiple ABIs)
  690. int abi_index = -1;
  691. for (int j = 0; j < abis.size(); ++j) {
  692. if (abis[j].abi == p_so.tags[i] || abis[j].arch == p_so.tags[i]) {
  693. abi_index = j;
  694. break;
  695. }
  696. }
  697. if (abi_index != -1) {
  698. exported = true;
  699. String abi = abis[abi_index].abi;
  700. String dst_path = String("lib").path_join(abi).path_join(p_so.path.get_file());
  701. Vector<uint8_t> array = FileAccess::get_file_as_bytes(p_so.path);
  702. Error store_err = store_in_apk(ed, dst_path, array);
  703. ERR_FAIL_COND_V_MSG(store_err, store_err, "Cannot store in apk file '" + dst_path + "'.");
  704. }
  705. }
  706. if (!exported) {
  707. ERR_PRINT("Cannot determine architecture for library \"" + p_so.path + "\". One of the supported architectures must be used as a tag: " + join_abis(abis, " ", true));
  708. return FAILED;
  709. }
  710. return OK;
  711. }
  712. Error EditorExportPlatformAndroid::save_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  713. APKExportData *ed = static_cast<APKExportData *>(p_userdata);
  714. const String path = ResourceUID::ensure_path(p_path);
  715. const String dst_path = path.replace_first("res://", "assets/");
  716. store_in_apk(ed, dst_path, p_data, _should_compress_asset(path, p_data) ? Z_DEFLATED : 0);
  717. return OK;
  718. }
  719. Error EditorExportPlatformAndroid::ignore_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key, uint64_t p_seed) {
  720. return OK;
  721. }
  722. Error EditorExportPlatformAndroid::copy_gradle_so(void *p_userdata, const SharedObject &p_so) {
  723. ERR_FAIL_COND_V_MSG(!p_so.path.get_file().begins_with("lib"), FAILED,
  724. "Android .so file names must start with \"lib\", but got: " + p_so.path);
  725. Vector<ABI> abis = get_abis();
  726. CustomExportData *export_data = static_cast<CustomExportData *>(p_userdata);
  727. bool exported = false;
  728. for (int i = 0; i < p_so.tags.size(); ++i) {
  729. int abi_index = -1;
  730. for (int j = 0; j < abis.size(); ++j) {
  731. if (abis[j].abi == p_so.tags[i] || abis[j].arch == p_so.tags[i]) {
  732. abi_index = j;
  733. break;
  734. }
  735. }
  736. if (abi_index != -1) {
  737. exported = true;
  738. String type = export_data->debug ? "debug" : "release";
  739. String abi = abis[abi_index].abi;
  740. String filename = p_so.path.get_file();
  741. String dst_path = export_data->libs_directory.path_join(type).path_join(abi).path_join(filename);
  742. Vector<uint8_t> data = FileAccess::get_file_as_bytes(p_so.path);
  743. print_verbose("Copying .so file from " + p_so.path + " to " + dst_path);
  744. Error err = store_file_at_path(dst_path, data);
  745. ERR_FAIL_COND_V_MSG(err, err, "Failed to copy .so file from " + p_so.path + " to " + dst_path);
  746. export_data->libs.push_back(dst_path);
  747. }
  748. }
  749. ERR_FAIL_COND_V_MSG(!exported, FAILED,
  750. "Cannot determine architecture for library \"" + p_so.path + "\". One of the supported architectures must be used as a tag:" + join_abis(abis, " ", true));
  751. return OK;
  752. }
  753. bool EditorExportPlatformAndroid::_has_read_write_storage_permission(const Vector<String> &p_permissions) {
  754. return p_permissions.has("android.permission.READ_EXTERNAL_STORAGE") || p_permissions.has("android.permission.WRITE_EXTERNAL_STORAGE");
  755. }
  756. bool EditorExportPlatformAndroid::_has_manage_external_storage_permission(const Vector<String> &p_permissions) {
  757. return p_permissions.has("android.permission.MANAGE_EXTERNAL_STORAGE");
  758. }
  759. bool EditorExportPlatformAndroid::_uses_vulkan() {
  760. String current_renderer = GLOBAL_GET("rendering/renderer/rendering_method.mobile");
  761. bool uses_vulkan = (current_renderer == "forward_plus" || current_renderer == "mobile") && GLOBAL_GET("rendering/rendering_device/driver.android") == "vulkan";
  762. return uses_vulkan;
  763. }
  764. void EditorExportPlatformAndroid::_notification(int p_what) {
  765. #ifndef ANDROID_ENABLED
  766. switch (p_what) {
  767. case NOTIFICATION_POSTINITIALIZE: {
  768. if (EditorExport::get_singleton()) {
  769. EditorExport::get_singleton()->connect_presets_runnable_updated(callable_mp(this, &EditorExportPlatformAndroid::_update_preset_status));
  770. }
  771. } break;
  772. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  773. if (EditorSettings::get_singleton()->check_changed_settings_in_group("export/android")) {
  774. _create_editor_debug_keystore_if_needed();
  775. }
  776. } break;
  777. }
  778. #endif
  779. }
  780. void EditorExportPlatformAndroid::_create_editor_debug_keystore_if_needed() {
  781. // Check if we have a valid keytool path.
  782. String keytool_path = get_keytool_path();
  783. if (!FileAccess::exists(keytool_path)) {
  784. return;
  785. }
  786. // Check if the current editor debug keystore exists.
  787. String editor_debug_keystore = EDITOR_GET("export/android/debug_keystore");
  788. if (FileAccess::exists(editor_debug_keystore)) {
  789. return;
  790. }
  791. // Generate the debug keystore.
  792. String keystore_path = EditorPaths::get_singleton()->get_debug_keystore_path();
  793. String keystores_dir = keystore_path.get_base_dir();
  794. if (!DirAccess::exists(keystores_dir)) {
  795. Ref<DirAccess> dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  796. Error err = dir_access->make_dir_recursive(keystores_dir);
  797. if (err != OK) {
  798. WARN_PRINT(TTR("Error creating keystores directory:") + "\n" + keystores_dir);
  799. return;
  800. }
  801. }
  802. if (!FileAccess::exists(keystore_path)) {
  803. String output;
  804. List<String> args;
  805. args.push_back("-genkey");
  806. args.push_back("-keystore");
  807. args.push_back(keystore_path);
  808. args.push_back("-storepass");
  809. args.push_back("android");
  810. args.push_back("-alias");
  811. args.push_back(DEFAULT_ANDROID_KEYSTORE_DEBUG_USER);
  812. args.push_back("-keypass");
  813. args.push_back(DEFAULT_ANDROID_KEYSTORE_DEBUG_PASSWORD);
  814. args.push_back("-keyalg");
  815. args.push_back("RSA");
  816. args.push_back("-keysize");
  817. args.push_back("2048");
  818. args.push_back("-validity");
  819. args.push_back("10000");
  820. args.push_back("-dname");
  821. args.push_back("cn=Godot, ou=Godot Engine, o=Stichting Godot, c=NL");
  822. Error error = OS::get_singleton()->execute(keytool_path, args, &output, nullptr, true);
  823. print_verbose(output);
  824. if (error != OK) {
  825. WARN_PRINT("Error: Unable to create debug keystore");
  826. return;
  827. }
  828. }
  829. // Update the editor settings.
  830. EditorSettings::get_singleton()->set("export/android/debug_keystore", keystore_path);
  831. EditorSettings::get_singleton()->set("export/android/debug_keystore_user", DEFAULT_ANDROID_KEYSTORE_DEBUG_USER);
  832. EditorSettings::get_singleton()->set("export/android/debug_keystore_pass", DEFAULT_ANDROID_KEYSTORE_DEBUG_PASSWORD);
  833. print_verbose("Updated editor debug keystore to " + keystore_path);
  834. }
  835. void EditorExportPlatformAndroid::_get_permissions(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, Vector<String> &r_permissions) {
  836. const char **aperms = ANDROID_PERMS;
  837. while (*aperms) {
  838. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  839. if (enabled) {
  840. r_permissions.push_back("android.permission." + String(*aperms));
  841. }
  842. aperms++;
  843. }
  844. PackedStringArray user_perms = p_preset->get("permissions/custom_permissions");
  845. for (int i = 0; i < user_perms.size(); i++) {
  846. String user_perm = user_perms[i].strip_edges();
  847. if (!user_perm.is_empty()) {
  848. r_permissions.push_back(user_perm);
  849. }
  850. }
  851. if (p_give_internet) {
  852. if (!r_permissions.has("android.permission.INTERNET")) {
  853. r_permissions.push_back("android.permission.INTERNET");
  854. }
  855. }
  856. }
  857. void EditorExportPlatformAndroid::_write_tmp_manifest(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, bool p_debug) {
  858. print_verbose("Building temporary manifest...");
  859. String manifest_text =
  860. "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
  861. "<manifest xmlns:android=\"http://schemas.android.com/apk/res/android\"\n"
  862. " xmlns:tools=\"http://schemas.android.com/tools\">\n";
  863. manifest_text += _get_screen_sizes_tag(p_preset);
  864. manifest_text += _get_gles_tag();
  865. Vector<String> perms;
  866. _get_permissions(p_preset, p_give_internet, perms);
  867. for (int i = 0; i < perms.size(); i++) {
  868. String permission = perms.get(i);
  869. if (permission == "android.permission.WRITE_EXTERNAL_STORAGE" || (permission == "android.permission.READ_EXTERNAL_STORAGE" && _has_manage_external_storage_permission(perms))) {
  870. manifest_text += vformat(" <uses-permission android:name=\"%s\" android:maxSdkVersion=\"29\" />\n", permission);
  871. } else {
  872. manifest_text += vformat(" <uses-permission android:name=\"%s\" />\n", permission);
  873. }
  874. }
  875. if (_uses_vulkan()) {
  876. manifest_text += " <uses-feature tools:node=\"replace\" android:name=\"android.hardware.vulkan.level\" android:required=\"false\" android:version=\"1\" />\n";
  877. manifest_text += " <uses-feature tools:node=\"replace\" android:name=\"android.hardware.vulkan.version\" android:required=\"true\" android:version=\"0x400003\" />\n";
  878. }
  879. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  880. for (int i = 0; i < export_plugins.size(); i++) {
  881. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  882. const String contents = export_plugins[i]->get_android_manifest_element_contents(Ref<EditorExportPlatform>(this), p_debug);
  883. if (!contents.is_empty()) {
  884. manifest_text += contents;
  885. manifest_text += "\n";
  886. }
  887. }
  888. }
  889. manifest_text += _get_application_tag(Ref<EditorExportPlatform>(this), p_preset, _has_read_write_storage_permission(perms), p_debug);
  890. manifest_text += "</manifest>\n";
  891. String manifest_path = ExportTemplateManager::get_android_build_directory(p_preset).path_join(vformat("src/%s/AndroidManifest.xml", (p_debug ? "debug" : "release")));
  892. print_verbose("Storing manifest into " + manifest_path + ": " + "\n" + manifest_text);
  893. store_string_at_path(manifest_path, manifest_text);
  894. }
  895. void EditorExportPlatformAndroid::_fix_themes_xml(const Ref<EditorExportPreset> &p_preset) {
  896. const String themes_xml_path = ExportTemplateManager::get_android_build_directory(p_preset).path_join("res/values/themes.xml");
  897. bool enable_swipe_to_dismiss = p_preset->get("wear_os/swipe_to_dismiss");
  898. if (!FileAccess::exists(themes_xml_path)) {
  899. print_error("res/values/themes.xml does not exist.");
  900. return;
  901. }
  902. String xml_content;
  903. Ref<FileAccess> file = FileAccess::open(themes_xml_path, FileAccess::READ);
  904. PackedStringArray lines = file->get_as_text().split("\n");
  905. file->close();
  906. // Check if the themes.xml already contains <item name="android:windowSwipeToDismiss"> element.
  907. // If found, update its value based on `enable_swipe_to_dismiss`.
  908. bool found = false;
  909. bool modified = false;
  910. for (int i = 0; i < lines.size(); i++) {
  911. String line = lines[i];
  912. if (line.contains("<item name") && line.contains("\"android:windowSwipeToDismiss\">")) {
  913. lines.set(i, vformat(" <item name=\"android:windowSwipeToDismiss\">%s</item>", bool_to_string(enable_swipe_to_dismiss)));
  914. found = true;
  915. modified = true;
  916. break;
  917. }
  918. }
  919. // If <item name="android:windowSwipeToDismiss"> is not found and `enable_swipe_to_dismiss` is false:
  920. // Add a new <item> element before the closing </style> tag.
  921. if (!found && !enable_swipe_to_dismiss) {
  922. for (int i = 0; i < lines.size(); i++) {
  923. if (lines[i].contains("</style>")) {
  924. lines.insert(i, " <item name=\"android:windowSwipeToDismiss\">false</item>");
  925. modified = true;
  926. break;
  927. }
  928. }
  929. }
  930. // Reconstruct the XML content from the modified lines.
  931. if (modified) {
  932. xml_content = String("\n").join(lines);
  933. store_string_at_path(themes_xml_path, xml_content);
  934. print_verbose("Successfully modified " + themes_xml_path + ": " + "\n" + xml_content);
  935. } else {
  936. print_verbose("No changes needed for " + themes_xml_path);
  937. }
  938. }
  939. void EditorExportPlatformAndroid::_fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  940. // Leaving the unused types commented because looking these constants up
  941. // again later would be annoying
  942. // const int CHUNK_AXML_FILE = 0x00080003;
  943. // const int CHUNK_RESOURCEIDS = 0x00080180;
  944. const int CHUNK_STRINGS = 0x001C0001;
  945. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  946. const int CHUNK_XML_END_TAG = 0x00100103;
  947. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  948. const int CHUNK_XML_START_TAG = 0x00100102;
  949. // const int CHUNK_XML_TEXT = 0x00100104;
  950. const int UTF8_FLAG = 0x00000100;
  951. Vector<String> string_table;
  952. uint32_t ofs = 8;
  953. uint32_t string_count = 0;
  954. uint32_t string_flags = 0;
  955. uint32_t string_data_offset = 0;
  956. uint32_t string_table_begins = 0;
  957. uint32_t string_table_ends = 0;
  958. Vector<uint8_t> stable_extra;
  959. String version_name = p_preset->get_version("version/name");
  960. int version_code = p_preset->get("version/code");
  961. String package_name = p_preset->get("package/unique_name");
  962. const int screen_orientation =
  963. _get_android_orientation_value(DisplayServer::ScreenOrientation(int(GLOBAL_GET("display/window/handheld/orientation"))));
  964. bool screen_support_small = p_preset->get("screen/support_small");
  965. bool screen_support_normal = p_preset->get("screen/support_normal");
  966. bool screen_support_large = p_preset->get("screen/support_large");
  967. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  968. bool backup_allowed = p_preset->get("user_data_backup/allow");
  969. int app_category = p_preset->get("package/app_category");
  970. bool retain_data_on_uninstall = p_preset->get("package/retain_data_on_uninstall");
  971. bool exclude_from_recents = p_preset->get("package/exclude_from_recents");
  972. bool is_resizeable = bool(GLOBAL_GET("display/window/size/resizable"));
  973. Vector<String> perms;
  974. // Write permissions into the perms variable.
  975. _get_permissions(p_preset, p_give_internet, perms);
  976. bool has_read_write_storage_permission = _has_read_write_storage_permission(perms);
  977. while (ofs < (uint32_t)p_manifest.size()) {
  978. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  979. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  980. switch (chunk) {
  981. case CHUNK_STRINGS: {
  982. int iofs = ofs + 8;
  983. string_count = decode_uint32(&p_manifest[iofs]);
  984. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  985. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  986. uint32_t st_offset = iofs + 20;
  987. string_table.resize(string_count);
  988. uint32_t string_end = 0;
  989. string_table_begins = st_offset;
  990. for (uint32_t i = 0; i < string_count; i++) {
  991. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  992. string_at += st_offset + string_count * 4;
  993. ERR_FAIL_COND_MSG(string_flags & UTF8_FLAG, "Unimplemented, can't read UTF-8 string table.");
  994. if (string_flags & UTF8_FLAG) {
  995. } else {
  996. uint32_t len = decode_uint16(&p_manifest[string_at]);
  997. Vector<char32_t> ucstring;
  998. ucstring.resize(len + 1);
  999. for (uint32_t j = 0; j < len; j++) {
  1000. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  1001. ucstring.write[j] = c;
  1002. }
  1003. string_end = MAX(string_at + 2 + 2 * len, string_end);
  1004. ucstring.write[len] = 0;
  1005. string_table.write[i] = ucstring.ptr();
  1006. }
  1007. }
  1008. for (uint32_t i = string_end; i < (ofs + size); i++) {
  1009. stable_extra.push_back(p_manifest[i]);
  1010. }
  1011. string_table_ends = ofs + size;
  1012. } break;
  1013. case CHUNK_XML_START_TAG: {
  1014. int iofs = ofs + 8;
  1015. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  1016. String tname = string_table[name];
  1017. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  1018. iofs += 28;
  1019. for (uint32_t i = 0; i < attrcount; i++) {
  1020. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  1021. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  1022. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  1023. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  1024. const String value = (attr_value != 0xFFFFFFFF) ? string_table[attr_value] : "Res #" + itos(attr_resid);
  1025. String attrname = string_table[attr_name];
  1026. const String nspace = (attr_nspace != 0xFFFFFFFF) ? string_table[attr_nspace] : "";
  1027. //replace project information
  1028. if (tname == "manifest" && attrname == "package") {
  1029. string_table.write[attr_value] = get_package_name(package_name);
  1030. }
  1031. if (tname == "manifest" && attrname == "versionCode") {
  1032. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  1033. }
  1034. if (tname == "manifest" && attrname == "versionName") {
  1035. if (attr_value == 0xFFFFFFFF) {
  1036. WARN_PRINT("Version name in a resource, should be plain text");
  1037. } else {
  1038. string_table.write[attr_value] = version_name;
  1039. }
  1040. }
  1041. if (tname == "application" && attrname == "requestLegacyExternalStorage") {
  1042. encode_uint32(has_read_write_storage_permission ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1043. }
  1044. if (tname == "application" && attrname == "allowBackup") {
  1045. encode_uint32(backup_allowed, &p_manifest.write[iofs + 16]);
  1046. }
  1047. if (tname == "application" && attrname == "appCategory") {
  1048. encode_uint32(_get_app_category_value(app_category), &p_manifest.write[iofs + 16]);
  1049. }
  1050. if (tname == "application" && attrname == "isGame") {
  1051. encode_uint32(app_category == APP_CATEGORY_GAME, &p_manifest.write[iofs + 16]);
  1052. }
  1053. if (tname == "application" && attrname == "hasFragileUserData") {
  1054. encode_uint32(retain_data_on_uninstall, &p_manifest.write[iofs + 16]);
  1055. }
  1056. if (tname == "activity" && attrname == "screenOrientation") {
  1057. encode_uint32(screen_orientation, &p_manifest.write[iofs + 16]);
  1058. }
  1059. if (tname == "activity" && attrname == "excludeFromRecents") {
  1060. encode_uint32(exclude_from_recents, &p_manifest.write[iofs + 16]);
  1061. }
  1062. if (tname == "activity" && attrname == "resizeableActivity") {
  1063. encode_uint32(is_resizeable, &p_manifest.write[iofs + 16]);
  1064. }
  1065. if (tname == "provider" && attrname == "authorities") {
  1066. string_table.write[attr_value] = get_package_name(package_name) + String(".fileprovider");
  1067. }
  1068. if (tname == "supports-screens") {
  1069. if (attrname == "smallScreens") {
  1070. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1071. } else if (attrname == "normalScreens") {
  1072. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1073. } else if (attrname == "largeScreens") {
  1074. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1075. } else if (attrname == "xlargeScreens") {
  1076. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1077. }
  1078. }
  1079. iofs += 20;
  1080. }
  1081. } break;
  1082. case CHUNK_XML_END_TAG: {
  1083. int iofs = ofs + 8;
  1084. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  1085. String tname = string_table[name];
  1086. if (tname == "uses-feature") {
  1087. Vector<String> feature_names;
  1088. Vector<bool> feature_required_list;
  1089. Vector<int> feature_versions;
  1090. if (_uses_vulkan()) {
  1091. // Require vulkan hardware level 1 support
  1092. feature_names.push_back("android.hardware.vulkan.level");
  1093. feature_required_list.push_back(false);
  1094. feature_versions.push_back(1);
  1095. // Require vulkan version 1.0
  1096. feature_names.push_back("android.hardware.vulkan.version");
  1097. feature_required_list.push_back(true);
  1098. feature_versions.push_back(0x400003); // Encoded value for api version 1.0
  1099. }
  1100. if (feature_names.size() > 0) {
  1101. ofs += 24; // skip over end tag
  1102. // save manifest ending so we can restore it
  1103. Vector<uint8_t> manifest_end;
  1104. uint32_t manifest_cur_size = p_manifest.size();
  1105. manifest_end.resize(p_manifest.size() - ofs);
  1106. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  1107. int32_t attr_name_string = string_table.find("name");
  1108. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  1109. int32_t ns_android_string = string_table.find("http://schemas.android.com/apk/res/android");
  1110. if (ns_android_string == -1) {
  1111. string_table.push_back("http://schemas.android.com/apk/res/android");
  1112. ns_android_string = string_table.size() - 1;
  1113. }
  1114. int32_t attr_uses_feature_string = string_table.find("uses-feature");
  1115. if (attr_uses_feature_string == -1) {
  1116. string_table.push_back("uses-feature");
  1117. attr_uses_feature_string = string_table.size() - 1;
  1118. }
  1119. int32_t attr_required_string = string_table.find("required");
  1120. if (attr_required_string == -1) {
  1121. string_table.push_back("required");
  1122. attr_required_string = string_table.size() - 1;
  1123. }
  1124. for (int i = 0; i < feature_names.size(); i++) {
  1125. const String &feature_name = feature_names[i];
  1126. bool feature_required = feature_required_list[i];
  1127. int feature_version = feature_versions[i];
  1128. bool has_version_attribute = feature_version != -1;
  1129. print_line("Adding feature " + feature_name);
  1130. int32_t feature_string = string_table.find(feature_name);
  1131. if (feature_string == -1) {
  1132. string_table.push_back(feature_name);
  1133. feature_string = string_table.size() - 1;
  1134. }
  1135. String required_value_string = feature_required ? "true" : "false";
  1136. int32_t required_value = string_table.find(required_value_string);
  1137. if (required_value == -1) {
  1138. string_table.push_back(required_value_string);
  1139. required_value = string_table.size() - 1;
  1140. }
  1141. int32_t attr_version_string = -1;
  1142. int32_t version_value = -1;
  1143. int tag_size;
  1144. int attr_count;
  1145. if (has_version_attribute) {
  1146. attr_version_string = string_table.find("version");
  1147. if (attr_version_string == -1) {
  1148. string_table.push_back("version");
  1149. attr_version_string = string_table.size() - 1;
  1150. }
  1151. version_value = string_table.find(itos(feature_version));
  1152. if (version_value == -1) {
  1153. string_table.push_back(itos(feature_version));
  1154. version_value = string_table.size() - 1;
  1155. }
  1156. tag_size = 96; // node and three attrs + end node
  1157. attr_count = 3;
  1158. } else {
  1159. tag_size = 76; // node and two attrs + end node
  1160. attr_count = 2;
  1161. }
  1162. manifest_cur_size += tag_size + 24;
  1163. p_manifest.resize(manifest_cur_size);
  1164. // start tag
  1165. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1166. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1167. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  1168. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1169. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1170. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1171. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1172. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1173. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1174. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  1175. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1176. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1177. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1178. // android:name attribute
  1179. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1180. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1181. encode_uint32(feature_string, &p_manifest.write[ofs + 44]); // raw_value
  1182. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1183. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1184. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1185. encode_uint32(feature_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1186. // android:required attribute
  1187. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  1188. encode_uint32(attr_required_string, &p_manifest.write[ofs + 60]); // 'name'
  1189. encode_uint32(required_value, &p_manifest.write[ofs + 64]); // raw_value
  1190. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  1191. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  1192. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  1193. encode_uint32(required_value, &p_manifest.write[ofs + 72]); // typedvalue reference
  1194. ofs += 76;
  1195. if (has_version_attribute) {
  1196. // android:version attribute
  1197. encode_uint32(ns_android_string, &p_manifest.write[ofs]); // ns
  1198. encode_uint32(attr_version_string, &p_manifest.write[ofs + 4]); // 'name'
  1199. encode_uint32(version_value, &p_manifest.write[ofs + 8]); // raw_value
  1200. encode_uint16(8, &p_manifest.write[ofs + 12]); // typedvalue_size
  1201. p_manifest.write[ofs + 14] = 0; // typedvalue_always0
  1202. p_manifest.write[ofs + 15] = 0x03; // typedvalue_type (string)
  1203. encode_uint32(version_value, &p_manifest.write[ofs + 16]); // typedvalue reference
  1204. ofs += 20;
  1205. }
  1206. // end tag
  1207. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1208. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1209. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1210. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1211. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1212. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1213. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1214. ofs += 24;
  1215. }
  1216. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1217. ofs -= 24; // go back over back end
  1218. }
  1219. }
  1220. if (tname == "manifest") {
  1221. // save manifest ending so we can restore it
  1222. Vector<uint8_t> manifest_end;
  1223. uint32_t manifest_cur_size = p_manifest.size();
  1224. manifest_end.resize(p_manifest.size() - ofs);
  1225. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  1226. int32_t attr_name_string = string_table.find("name");
  1227. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  1228. int32_t ns_android_string = string_table.find("android");
  1229. ERR_FAIL_COND_MSG(ns_android_string == -1, "Template does not have 'android' namespace.");
  1230. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  1231. if (attr_uses_permission_string == -1) {
  1232. string_table.push_back("uses-permission");
  1233. attr_uses_permission_string = string_table.size() - 1;
  1234. }
  1235. for (int i = 0; i < perms.size(); ++i) {
  1236. print_line("Adding permission " + perms[i]);
  1237. manifest_cur_size += 56 + 24; // node + end node
  1238. p_manifest.resize(manifest_cur_size);
  1239. // Add permission to the string pool
  1240. int32_t perm_string = string_table.find(perms[i]);
  1241. if (perm_string == -1) {
  1242. string_table.push_back(perms[i]);
  1243. perm_string = string_table.size() - 1;
  1244. }
  1245. // start tag
  1246. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1247. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1248. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  1249. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1250. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1251. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1252. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1253. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1254. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1255. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  1256. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1257. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1258. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1259. // attribute
  1260. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1261. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1262. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  1263. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1264. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1265. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1266. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1267. ofs += 56;
  1268. // end tag
  1269. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1270. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1271. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1272. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1273. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1274. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1275. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1276. ofs += 24;
  1277. }
  1278. // copy footer back in
  1279. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1280. }
  1281. } break;
  1282. }
  1283. ofs += size;
  1284. }
  1285. //create new andriodmanifest binary
  1286. Vector<uint8_t> ret;
  1287. ret.resize(string_table_begins + string_table.size() * 4);
  1288. for (uint32_t i = 0; i < string_table_begins; i++) {
  1289. ret.write[i] = p_manifest[i];
  1290. }
  1291. ofs = 0;
  1292. for (int i = 0; i < string_table.size(); i++) {
  1293. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1294. ofs += string_table[i].length() * 2 + 2 + 2;
  1295. }
  1296. ret.resize(ret.size() + ofs);
  1297. string_data_offset = ret.size() - ofs;
  1298. uint8_t *chars = &ret.write[string_data_offset];
  1299. for (int i = 0; i < string_table.size(); i++) {
  1300. String s = string_table[i];
  1301. encode_uint16(s.length(), chars);
  1302. chars += 2;
  1303. for (int j = 0; j < s.length(); j++) {
  1304. encode_uint16(s[j], chars);
  1305. chars += 2;
  1306. }
  1307. encode_uint16(0, chars);
  1308. chars += 2;
  1309. }
  1310. for (int i = 0; i < stable_extra.size(); i++) {
  1311. ret.push_back(stable_extra[i]);
  1312. }
  1313. //pad
  1314. while (ret.size() % 4) {
  1315. ret.push_back(0);
  1316. }
  1317. uint32_t new_stable_end = ret.size();
  1318. uint32_t extra = (p_manifest.size() - string_table_ends);
  1319. ret.resize(new_stable_end + extra);
  1320. for (uint32_t i = 0; i < extra; i++) {
  1321. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  1322. }
  1323. while (ret.size() % 4) {
  1324. ret.push_back(0);
  1325. }
  1326. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  1327. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  1328. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  1329. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  1330. p_manifest = ret;
  1331. }
  1332. String EditorExportPlatformAndroid::_get_keystore_path(const Ref<EditorExportPreset> &p_preset, bool p_debug) {
  1333. String keystore_preference = p_debug ? "keystore/debug" : "keystore/release";
  1334. String keystore_env_variable = p_debug ? ENV_ANDROID_KEYSTORE_DEBUG_PATH : ENV_ANDROID_KEYSTORE_RELEASE_PATH;
  1335. String keystore_path = p_preset->get_or_env(keystore_preference, keystore_env_variable);
  1336. return ProjectSettings::get_singleton()->globalize_path(keystore_path).simplify_path();
  1337. }
  1338. String EditorExportPlatformAndroid::_parse_string(const uint8_t *p_bytes, bool p_utf8) {
  1339. uint32_t offset = 0;
  1340. uint32_t len = 0;
  1341. if (p_utf8) {
  1342. uint8_t byte = p_bytes[offset];
  1343. if (byte & 0x80) {
  1344. offset += 2;
  1345. } else {
  1346. offset += 1;
  1347. }
  1348. byte = p_bytes[offset];
  1349. offset++;
  1350. if (byte & 0x80) {
  1351. len = byte & 0x7F;
  1352. len = (len << 8) + p_bytes[offset];
  1353. offset++;
  1354. } else {
  1355. len = byte;
  1356. }
  1357. } else {
  1358. len = decode_uint16(&p_bytes[offset]);
  1359. offset += 2;
  1360. if (len & 0x8000) {
  1361. len &= 0x7FFF;
  1362. len = (len << 16) + decode_uint16(&p_bytes[offset]);
  1363. offset += 2;
  1364. }
  1365. }
  1366. if (p_utf8) {
  1367. Vector<uint8_t> str8;
  1368. str8.resize(len + 1);
  1369. for (uint32_t i = 0; i < len; i++) {
  1370. str8.write[i] = p_bytes[offset + i];
  1371. }
  1372. str8.write[len] = 0;
  1373. String str;
  1374. str.parse_utf8((const char *)str8.ptr(), len);
  1375. return str;
  1376. } else {
  1377. String str;
  1378. for (uint32_t i = 0; i < len; i++) {
  1379. char32_t c = decode_uint16(&p_bytes[offset + i * 2]);
  1380. if (c == 0) {
  1381. break;
  1382. }
  1383. str += String::chr(c);
  1384. }
  1385. return str;
  1386. }
  1387. }
  1388. void EditorExportPlatformAndroid::_fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &r_manifest) {
  1389. const int UTF8_FLAG = 0x00000100;
  1390. uint32_t string_block_len = decode_uint32(&r_manifest[16]);
  1391. uint32_t string_count = decode_uint32(&r_manifest[20]);
  1392. uint32_t string_flags = decode_uint32(&r_manifest[28]);
  1393. const uint32_t string_table_begins = 40;
  1394. Vector<String> string_table;
  1395. String package_name = p_preset->get("package/name");
  1396. Dictionary appnames = GLOBAL_GET("application/config/name_localized");
  1397. for (uint32_t i = 0; i < string_count; i++) {
  1398. uint32_t offset = decode_uint32(&r_manifest[string_table_begins + i * 4]);
  1399. offset += string_table_begins + string_count * 4;
  1400. String str = _parse_string(&r_manifest[offset], string_flags & UTF8_FLAG);
  1401. if (str.begins_with("godot-project-name")) {
  1402. if (str == "godot-project-name") {
  1403. //project name
  1404. str = get_project_name(package_name);
  1405. } else {
  1406. String lang = str.substr(str.rfind_char('-') + 1, str.length()).replace("-", "_");
  1407. if (appnames.has(lang)) {
  1408. str = appnames[lang];
  1409. } else {
  1410. str = get_project_name(package_name);
  1411. }
  1412. }
  1413. }
  1414. string_table.push_back(str);
  1415. }
  1416. //write a new string table, but use 16 bits
  1417. Vector<uint8_t> ret;
  1418. ret.resize(string_table_begins + string_table.size() * 4);
  1419. for (uint32_t i = 0; i < string_table_begins; i++) {
  1420. ret.write[i] = r_manifest[i];
  1421. }
  1422. int ofs = 0;
  1423. for (int i = 0; i < string_table.size(); i++) {
  1424. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1425. ofs += string_table[i].length() * 2 + 2 + 2;
  1426. }
  1427. ret.resize(ret.size() + ofs);
  1428. uint8_t *chars = &ret.write[ret.size() - ofs];
  1429. for (int i = 0; i < string_table.size(); i++) {
  1430. String s = string_table[i];
  1431. encode_uint16(s.length(), chars);
  1432. chars += 2;
  1433. for (int j = 0; j < s.length(); j++) {
  1434. encode_uint16(s[j], chars);
  1435. chars += 2;
  1436. }
  1437. encode_uint16(0, chars);
  1438. chars += 2;
  1439. }
  1440. //pad
  1441. while (ret.size() % 4) {
  1442. ret.push_back(0);
  1443. }
  1444. //change flags to not use utf8
  1445. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  1446. //change length
  1447. encode_uint32(ret.size() - 12, &ret.write[16]);
  1448. //append the rest...
  1449. int rest_from = 12 + string_block_len;
  1450. int rest_to = ret.size();
  1451. int rest_len = (r_manifest.size() - rest_from);
  1452. ret.resize(ret.size() + (r_manifest.size() - rest_from));
  1453. for (int i = 0; i < rest_len; i++) {
  1454. ret.write[rest_to + i] = r_manifest[rest_from + i];
  1455. }
  1456. //finally update the size
  1457. encode_uint32(ret.size(), &ret.write[4]);
  1458. r_manifest = ret;
  1459. //printf("end\n");
  1460. }
  1461. void EditorExportPlatformAndroid::_load_image_data(const Ref<Image> &p_splash_image, Vector<uint8_t> &p_data) {
  1462. Vector<uint8_t> png_buffer;
  1463. Error err = PNGDriverCommon::image_to_png(p_splash_image, png_buffer);
  1464. if (err == OK) {
  1465. p_data.resize(png_buffer.size());
  1466. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1467. } else {
  1468. String err_str = String("Failed to convert splash image to png.");
  1469. WARN_PRINT(err_str.utf8().get_data());
  1470. }
  1471. }
  1472. void EditorExportPlatformAndroid::_process_launcher_icons(const String &p_file_name, const Ref<Image> &p_source_image, int dimension, Vector<uint8_t> &p_data) {
  1473. Ref<Image> working_image = p_source_image;
  1474. if (p_source_image->get_width() != dimension || p_source_image->get_height() != dimension) {
  1475. working_image = p_source_image->duplicate();
  1476. working_image->resize(dimension, dimension, Image::Interpolation::INTERPOLATE_LANCZOS);
  1477. }
  1478. Vector<uint8_t> png_buffer;
  1479. Error err = PNGDriverCommon::image_to_png(working_image, png_buffer);
  1480. if (err == OK) {
  1481. p_data.resize(png_buffer.size());
  1482. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1483. } else {
  1484. String err_str = String("Failed to convert resized icon (") + p_file_name + ") to png.";
  1485. WARN_PRINT(err_str.utf8().get_data());
  1486. }
  1487. }
  1488. void EditorExportPlatformAndroid::load_icon_refs(const Ref<EditorExportPreset> &p_preset, Ref<Image> &icon, Ref<Image> &foreground, Ref<Image> &background, Ref<Image> &monochrome) {
  1489. String project_icon_path = GLOBAL_GET("application/config/icon");
  1490. icon.instantiate();
  1491. foreground.instantiate();
  1492. background.instantiate();
  1493. monochrome.instantiate();
  1494. // Regular icon: user selection -> project icon -> default.
  1495. String path = static_cast<String>(p_preset->get(LAUNCHER_ICON_OPTION)).strip_edges();
  1496. print_verbose("Loading regular icon from " + path);
  1497. if (path.is_empty() || ImageLoader::load_image(path, icon) != OK) {
  1498. print_verbose("- falling back to project icon: " + project_icon_path);
  1499. if (!project_icon_path.is_empty()) {
  1500. ImageLoader::load_image(project_icon_path, icon);
  1501. } else {
  1502. ERR_PRINT("No project icon specified. Please specify one in the Project Settings under Application -> Config -> Icon");
  1503. }
  1504. }
  1505. // Adaptive foreground: user selection -> regular icon (user selection -> project icon -> default).
  1506. path = static_cast<String>(p_preset->get(LAUNCHER_ADAPTIVE_ICON_FOREGROUND_OPTION)).strip_edges();
  1507. print_verbose("Loading adaptive foreground icon from " + path);
  1508. if (path.is_empty() || ImageLoader::load_image(path, foreground) != OK) {
  1509. print_verbose("- falling back to using the regular icon");
  1510. foreground = icon;
  1511. }
  1512. // Adaptive background: user selection -> default.
  1513. path = static_cast<String>(p_preset->get(LAUNCHER_ADAPTIVE_ICON_BACKGROUND_OPTION)).strip_edges();
  1514. if (!path.is_empty()) {
  1515. print_verbose("Loading adaptive background icon from " + path);
  1516. ImageLoader::load_image(path, background);
  1517. }
  1518. // Adaptive monochrome: user selection -> default.
  1519. path = static_cast<String>(p_preset->get(LAUNCHER_ADAPTIVE_ICON_MONOCHROME_OPTION)).strip_edges();
  1520. if (!path.is_empty()) {
  1521. print_verbose("Loading adaptive monochrome icon from " + path);
  1522. ImageLoader::load_image(path, monochrome);
  1523. }
  1524. }
  1525. void EditorExportPlatformAndroid::_copy_icons_to_gradle_project(const Ref<EditorExportPreset> &p_preset,
  1526. const Ref<Image> &p_main_image,
  1527. const Ref<Image> &p_foreground,
  1528. const Ref<Image> &p_background,
  1529. const Ref<Image> &p_monochrome) {
  1530. String gradle_build_dir = ExportTemplateManager::get_android_build_directory(p_preset);
  1531. String monochrome_tag = "";
  1532. // Prepare images to be resized for the icons. If some image ends up being uninitialized,
  1533. // the default image from the export template will be used.
  1534. for (int i = 0; i < ICON_DENSITIES_COUNT; ++i) {
  1535. if (p_main_image.is_valid() && !p_main_image->is_empty()) {
  1536. print_verbose("Processing launcher icon for dimension " + itos(LAUNCHER_ICONS[i].dimensions) + " into " + LAUNCHER_ICONS[i].export_path);
  1537. Vector<uint8_t> data;
  1538. _process_launcher_icons(LAUNCHER_ICONS[i].export_path, p_main_image, LAUNCHER_ICONS[i].dimensions, data);
  1539. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ICONS[i].export_path), data);
  1540. }
  1541. if (p_foreground.is_valid() && !p_foreground->is_empty()) {
  1542. print_verbose("Processing launcher adaptive icon p_foreground for dimension " + itos(LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].dimensions) + " into " + LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path);
  1543. Vector<uint8_t> data;
  1544. _process_launcher_icons(LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path, p_foreground,
  1545. LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].dimensions, data);
  1546. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path), data);
  1547. }
  1548. if (p_background.is_valid() && !p_background->is_empty()) {
  1549. print_verbose("Processing launcher adaptive icon p_background for dimension " + itos(LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].dimensions) + " into " + LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path);
  1550. Vector<uint8_t> data;
  1551. _process_launcher_icons(LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path, p_background,
  1552. LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].dimensions, data);
  1553. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path), data);
  1554. }
  1555. if (p_monochrome.is_valid() && !p_monochrome->is_empty()) {
  1556. print_verbose("Processing launcher adaptive icon p_monochrome for dimension " + itos(LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].dimensions) + " into " + LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path);
  1557. Vector<uint8_t> data;
  1558. _process_launcher_icons(LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path, p_monochrome,
  1559. LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].dimensions, data);
  1560. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path), data);
  1561. monochrome_tag = " <monochrome android:drawable=\"@mipmap/icon_monochrome\"/>\n";
  1562. }
  1563. }
  1564. // Finalize the icon.xml by formatting the template with the optional monochrome tag.
  1565. store_string_at_path(gradle_build_dir.path_join(ICON_XML_PATH), vformat(ICON_XML_TEMPLATE, monochrome_tag));
  1566. }
  1567. Vector<EditorExportPlatformAndroid::ABI> EditorExportPlatformAndroid::get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  1568. Vector<ABI> abis = get_abis();
  1569. Vector<ABI> enabled_abis;
  1570. for (int i = 0; i < abis.size(); ++i) {
  1571. bool is_enabled = p_preset->get("architectures/" + abis[i].abi);
  1572. if (is_enabled) {
  1573. enabled_abis.push_back(abis[i]);
  1574. }
  1575. }
  1576. return enabled_abis;
  1577. }
  1578. void EditorExportPlatformAndroid::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) const {
  1579. r_features->push_back("etc2");
  1580. r_features->push_back("astc");
  1581. Vector<ABI> abis = get_enabled_abis(p_preset);
  1582. for (int i = 0; i < abis.size(); ++i) {
  1583. r_features->push_back(abis[i].arch);
  1584. }
  1585. }
  1586. String EditorExportPlatformAndroid::get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const {
  1587. if (p_preset) {
  1588. if (p_name == ("apk_expansion/public_key")) {
  1589. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1590. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1591. if (apk_expansion && apk_expansion_pkey.is_empty()) {
  1592. return TTR("Invalid public key for APK expansion.");
  1593. }
  1594. } else if (p_name == "package/unique_name") {
  1595. String pn = p_preset->get("package/unique_name");
  1596. String pn_err;
  1597. if (!is_package_name_valid(pn, &pn_err)) {
  1598. return TTR("Invalid package name:") + " " + pn_err;
  1599. }
  1600. } else if (p_name == "wear_os/swipe_to_dismiss") {
  1601. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1602. if (!bool(p_preset->get("wear_os/swipe_to_dismiss")) && !gradle_build_enabled) {
  1603. return TTR("\"Use Gradle Build\" must be enabled to disable \"Swipe to dismiss\".");
  1604. }
  1605. } else if (p_name == "gradle_build/use_gradle_build") {
  1606. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1607. String enabled_plugins_names = _get_plugins_names(Ref<EditorExportPreset>(p_preset));
  1608. if (!enabled_plugins_names.is_empty() && !gradle_build_enabled) {
  1609. return TTR("\"Use Gradle Build\" must be enabled to use the plugins.");
  1610. }
  1611. } else if (p_name == "xr_features/xr_mode") {
  1612. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1613. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1614. if (xr_mode_index == XR_MODE_OPENXR && !gradle_build_enabled) {
  1615. return TTR("OpenXR requires \"Use Gradle Build\" to be enabled");
  1616. }
  1617. } else if (p_name == "gradle_build/compress_native_libraries") {
  1618. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1619. if (bool(p_preset->get("gradle_build/compress_native_libraries")) && !gradle_build_enabled) {
  1620. return TTR("\"Compress Native Libraries\" is only valid when \"Use Gradle Build\" is enabled.");
  1621. }
  1622. } else if (p_name == "gradle_build/export_format") {
  1623. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1624. if (int(p_preset->get("gradle_build/export_format")) == EXPORT_FORMAT_AAB && !gradle_build_enabled) {
  1625. return TTR("\"Export AAB\" is only valid when \"Use Gradle Build\" is enabled.");
  1626. }
  1627. } else if (p_name == "gradle_build/min_sdk") {
  1628. String min_sdk_str = p_preset->get("gradle_build/min_sdk");
  1629. int min_sdk_int = VULKAN_MIN_SDK_VERSION;
  1630. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1631. if (!min_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  1632. if (!gradle_build_enabled) {
  1633. return TTR("\"Min SDK\" can only be overridden when \"Use Gradle Build\" is enabled.");
  1634. }
  1635. if (!min_sdk_str.is_valid_int()) {
  1636. return vformat(TTR("\"Min SDK\" should be a valid integer, but got \"%s\" which is invalid."), min_sdk_str);
  1637. } else {
  1638. min_sdk_int = min_sdk_str.to_int();
  1639. if (min_sdk_int < OPENGL_MIN_SDK_VERSION) {
  1640. return vformat(TTR("\"Min SDK\" cannot be lower than %d, which is the version needed by the Godot library."), OPENGL_MIN_SDK_VERSION);
  1641. }
  1642. }
  1643. }
  1644. } else if (p_name == "gradle_build/target_sdk") {
  1645. String target_sdk_str = p_preset->get("gradle_build/target_sdk");
  1646. int target_sdk_int = DEFAULT_TARGET_SDK_VERSION;
  1647. String min_sdk_str = p_preset->get("gradle_build/min_sdk");
  1648. int min_sdk_int = VULKAN_MIN_SDK_VERSION;
  1649. if (min_sdk_str.is_valid_int()) {
  1650. min_sdk_int = min_sdk_str.to_int();
  1651. }
  1652. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1653. if (!target_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  1654. if (!gradle_build_enabled) {
  1655. return TTR("\"Target SDK\" can only be overridden when \"Use Gradle Build\" is enabled.");
  1656. }
  1657. if (!target_sdk_str.is_valid_int()) {
  1658. return vformat(TTR("\"Target SDK\" should be a valid integer, but got \"%s\" which is invalid."), target_sdk_str);
  1659. } else {
  1660. target_sdk_int = target_sdk_str.to_int();
  1661. if (target_sdk_int < min_sdk_int) {
  1662. return TTR("\"Target SDK\" version must be greater or equal to \"Min SDK\" version.");
  1663. }
  1664. }
  1665. }
  1666. }
  1667. }
  1668. return String();
  1669. }
  1670. void EditorExportPlatformAndroid::get_export_options(List<ExportOption> *r_options) const {
  1671. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1672. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1673. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "gradle_build/use_gradle_build"), false, true, true));
  1674. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/gradle_build_directory", PROPERTY_HINT_PLACEHOLDER_TEXT, "res://android"), "", false, false));
  1675. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/android_source_template", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  1676. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "gradle_build/compress_native_libraries"), false, false, true));
  1677. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "gradle_build/export_format", PROPERTY_HINT_ENUM, "Export APK,Export AAB"), EXPORT_FORMAT_APK, false, true));
  1678. // Using String instead of int to default to an empty string (no override) with placeholder for instructions (see GH-62465).
  1679. // This implies doing validation that the string is a proper int.
  1680. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/min_sdk", PROPERTY_HINT_PLACEHOLDER_TEXT, vformat("%d (default)", VULKAN_MIN_SDK_VERSION)), "", false, true));
  1681. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/target_sdk", PROPERTY_HINT_PLACEHOLDER_TEXT, vformat("%d (default)", DEFAULT_TARGET_SDK_VERSION)), "", false, true));
  1682. #ifndef DISABLE_DEPRECATED
  1683. Vector<PluginConfigAndroid> plugins_configs = get_plugins();
  1684. for (int i = 0; i < plugins_configs.size(); i++) {
  1685. print_verbose("Found Android plugin " + plugins_configs[i].name);
  1686. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("plugins"), plugins_configs[i].name)), false));
  1687. }
  1688. android_plugins_changed.clear();
  1689. #endif // DISABLE_DEPRECATED
  1690. // Android supports multiple architectures in an app bundle, so
  1691. // we expose each option as a checkbox in the export dialog.
  1692. const Vector<ABI> abis = get_abis();
  1693. for (int i = 0; i < abis.size(); ++i) {
  1694. const String abi = abis[i].abi;
  1695. // All Android devices supporting Vulkan run 64-bit Android,
  1696. // so there is usually no point in exporting for 32-bit Android.
  1697. const bool is_default = abi == "arm64-v8a";
  1698. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("architectures"), abi)), is_default));
  1699. }
  1700. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1701. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1702. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password", PROPERTY_HINT_PASSWORD, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1703. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1704. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1705. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password", PROPERTY_HINT_PASSWORD, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1706. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  1707. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Leave empty to use project version"), ""));
  1708. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "ext.domain.name"), "com.example.$genname", false, true));
  1709. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name [default if blank]"), ""));
  1710. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  1711. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "package/app_category", PROPERTY_HINT_ENUM, "Accessibility,Audio,Game,Image,Maps,News,Productivity,Social,Video,Undefined"), APP_CATEGORY_GAME));
  1712. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/retain_data_on_uninstall"), false));
  1713. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/exclude_from_recents"), false));
  1714. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/show_in_android_tv"), false));
  1715. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/show_in_app_library"), true));
  1716. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/show_as_launcher_app"), false));
  1717. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ICON_OPTION, PROPERTY_HINT_FILE, "*.png"), ""));
  1718. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ADAPTIVE_ICON_FOREGROUND_OPTION, PROPERTY_HINT_FILE, "*.png"), ""));
  1719. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ADAPTIVE_ICON_BACKGROUND_OPTION, PROPERTY_HINT_FILE, "*.png"), ""));
  1720. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ADAPTIVE_ICON_MONOCHROME_OPTION, PROPERTY_HINT_FILE, "*.png"), ""));
  1721. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/opengl_debug"), false));
  1722. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/xr_mode", PROPERTY_HINT_ENUM, "Regular,OpenXR"), XR_MODE_REGULAR, false, true));
  1723. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "wear_os/swipe_to_dismiss"), true));
  1724. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  1725. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  1726. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  1727. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  1728. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  1729. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data_backup/allow"), false));
  1730. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  1731. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false, false, true));
  1732. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  1733. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), "", false, true));
  1734. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "permissions/custom_permissions"), PackedStringArray()));
  1735. const char **perms = ANDROID_PERMS;
  1736. while (*perms) {
  1737. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("permissions"), String(*perms).to_lower())), false));
  1738. perms++;
  1739. }
  1740. }
  1741. bool EditorExportPlatformAndroid::get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const {
  1742. if (p_preset == nullptr) {
  1743. return true;
  1744. }
  1745. bool advanced_options_enabled = p_preset->are_advanced_options_enabled();
  1746. if (p_option == "graphics/opengl_debug" ||
  1747. p_option == "command_line/extra_args" ||
  1748. p_option == "permissions/custom_permissions" ||
  1749. p_option == "gradle_build/compress_native_libraries" ||
  1750. p_option == "package/retain_data_on_uninstall" ||
  1751. p_option == "package/exclude_from_recents" ||
  1752. p_option == "package/show_in_app_library" ||
  1753. p_option == "package/show_as_launcher_app" ||
  1754. p_option == "wear_os/swipe_to_dismiss" ||
  1755. p_option == "apk_expansion/enable" ||
  1756. p_option == "apk_expansion/SALT" ||
  1757. p_option == "apk_expansion/public_key") {
  1758. return advanced_options_enabled;
  1759. }
  1760. if (p_option == "gradle_build/gradle_build_directory" || p_option == "gradle_build/android_source_template") {
  1761. return advanced_options_enabled && bool(p_preset->get("gradle_build/use_gradle_build"));
  1762. }
  1763. if (p_option == "custom_template/debug" || p_option == "custom_template/release") {
  1764. // The APK templates are ignored if Gradle build is enabled.
  1765. return advanced_options_enabled && !bool(p_preset->get("gradle_build/use_gradle_build"));
  1766. }
  1767. // Hide .NET embedding option (always enabled).
  1768. if (p_option == "dotnet/embed_build_outputs") {
  1769. return false;
  1770. }
  1771. return true;
  1772. }
  1773. String EditorExportPlatformAndroid::get_name() const {
  1774. return "Android";
  1775. }
  1776. String EditorExportPlatformAndroid::get_os_name() const {
  1777. return "Android";
  1778. }
  1779. Ref<Texture2D> EditorExportPlatformAndroid::get_logo() const {
  1780. return logo;
  1781. }
  1782. bool EditorExportPlatformAndroid::should_update_export_options() {
  1783. #ifndef DISABLE_DEPRECATED
  1784. if (android_plugins_changed.is_set()) {
  1785. // don't clear unless we're reporting true, to avoid race
  1786. android_plugins_changed.clear();
  1787. return true;
  1788. }
  1789. #endif // DISABLE_DEPRECATED
  1790. return false;
  1791. }
  1792. bool EditorExportPlatformAndroid::poll_export() {
  1793. bool dc = devices_changed.is_set();
  1794. if (dc) {
  1795. // don't clear unless we're reporting true, to avoid race
  1796. devices_changed.clear();
  1797. }
  1798. return dc;
  1799. }
  1800. int EditorExportPlatformAndroid::get_options_count() const {
  1801. MutexLock lock(device_lock);
  1802. return devices.size();
  1803. }
  1804. String EditorExportPlatformAndroid::get_options_tooltip() const {
  1805. return TTR("Select device from the list");
  1806. }
  1807. String EditorExportPlatformAndroid::get_option_label(int p_index) const {
  1808. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1809. MutexLock lock(device_lock);
  1810. return devices[p_index].name;
  1811. }
  1812. String EditorExportPlatformAndroid::get_option_tooltip(int p_index) const {
  1813. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1814. MutexLock lock(device_lock);
  1815. String s = devices[p_index].description;
  1816. if (devices.size() == 1) {
  1817. // Tooltip will be:
  1818. // Name
  1819. // Description
  1820. s = devices[p_index].name + "\n\n" + s;
  1821. }
  1822. return s;
  1823. }
  1824. String EditorExportPlatformAndroid::get_device_architecture(int p_index) const {
  1825. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1826. MutexLock lock(device_lock);
  1827. return devices[p_index].architecture;
  1828. }
  1829. Error EditorExportPlatformAndroid::run(const Ref<EditorExportPreset> &p_preset, int p_device, BitField<EditorExportPlatform::DebugFlags> p_debug_flags) {
  1830. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1831. String can_export_error;
  1832. bool can_export_missing_templates;
  1833. if (!can_export(p_preset, can_export_error, can_export_missing_templates)) {
  1834. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), can_export_error);
  1835. return ERR_UNCONFIGURED;
  1836. }
  1837. MutexLock lock(device_lock);
  1838. EditorProgress ep("run", vformat(TTR("Running on %s"), devices[p_device].name), 3);
  1839. String adb = get_adb_path();
  1840. // Export_temp APK.
  1841. if (ep.step(TTR("Exporting APK..."), 0)) {
  1842. return ERR_SKIP;
  1843. }
  1844. const bool use_wifi_for_remote_debug = EDITOR_GET("export/android/use_wifi_for_remote_debug");
  1845. const bool use_remote = p_debug_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG) || p_debug_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT);
  1846. const bool use_reverse = devices[p_device].api_level >= 21 && !use_wifi_for_remote_debug;
  1847. if (use_reverse) {
  1848. p_debug_flags.set_flag(DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST);
  1849. }
  1850. String tmp_export_path = EditorPaths::get_singleton()->get_temp_dir().path_join("tmpexport." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  1851. #define CLEANUP_AND_RETURN(m_err) \
  1852. { \
  1853. DirAccess::remove_file_or_error(tmp_export_path); \
  1854. if (FileAccess::exists(tmp_export_path + ".idsig")) { \
  1855. DirAccess::remove_file_or_error(tmp_export_path + ".idsig"); \
  1856. } \
  1857. return m_err; \
  1858. } \
  1859. ((void)0)
  1860. // Export to temporary APK before sending to device.
  1861. Error err = export_project_helper(p_preset, true, tmp_export_path, EXPORT_FORMAT_APK, true, p_debug_flags);
  1862. if (err != OK) {
  1863. CLEANUP_AND_RETURN(err);
  1864. }
  1865. List<String> args;
  1866. int rv;
  1867. String output;
  1868. bool remove_prev = EDITOR_GET("export/android/one_click_deploy_clear_previous_install");
  1869. String version_name = p_preset->get_version("version/name");
  1870. String package_name = p_preset->get("package/unique_name");
  1871. if (remove_prev) {
  1872. if (ep.step(TTR("Uninstalling..."), 1)) {
  1873. CLEANUP_AND_RETURN(ERR_SKIP);
  1874. }
  1875. print_line("Uninstalling previous version: " + devices[p_device].name);
  1876. args.push_back("-s");
  1877. args.push_back(devices[p_device].id);
  1878. args.push_back("uninstall");
  1879. if ((bool)EDITOR_GET("export/android/force_system_user") && devices[p_device].api_level >= 17) {
  1880. args.push_back("--user");
  1881. args.push_back("0");
  1882. }
  1883. args.push_back(get_package_name(package_name));
  1884. output.clear();
  1885. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1886. print_verbose(output);
  1887. }
  1888. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1889. if (ep.step(TTR("Installing to device, please wait..."), 2)) {
  1890. CLEANUP_AND_RETURN(ERR_SKIP);
  1891. }
  1892. args.clear();
  1893. args.push_back("-s");
  1894. args.push_back(devices[p_device].id);
  1895. args.push_back("install");
  1896. if ((bool)EDITOR_GET("export/android/force_system_user") && devices[p_device].api_level >= 17) {
  1897. args.push_back("--user");
  1898. args.push_back("0");
  1899. }
  1900. args.push_back("-r");
  1901. args.push_back(tmp_export_path);
  1902. output.clear();
  1903. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1904. print_verbose(output);
  1905. if (err || rv != 0) {
  1906. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), vformat(TTR("Could not install to device: %s"), output));
  1907. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1908. }
  1909. if (use_remote) {
  1910. if (use_reverse) {
  1911. static const char *const msg = "--- Device API >= 21; debugging over USB ---";
  1912. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1913. print_line(String(msg).to_upper());
  1914. args.clear();
  1915. args.push_back("-s");
  1916. args.push_back(devices[p_device].id);
  1917. args.push_back("reverse");
  1918. args.push_back("--remove-all");
  1919. output.clear();
  1920. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1921. print_verbose(output);
  1922. if (p_debug_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG)) {
  1923. int dbg_port = EDITOR_GET("network/debug/remote_port");
  1924. args.clear();
  1925. args.push_back("-s");
  1926. args.push_back(devices[p_device].id);
  1927. args.push_back("reverse");
  1928. args.push_back("tcp:" + itos(dbg_port));
  1929. args.push_back("tcp:" + itos(dbg_port));
  1930. output.clear();
  1931. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1932. print_verbose(output);
  1933. print_line("Reverse result: " + itos(rv));
  1934. }
  1935. if (p_debug_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  1936. int fs_port = EDITOR_GET("filesystem/file_server/port");
  1937. args.clear();
  1938. args.push_back("-s");
  1939. args.push_back(devices[p_device].id);
  1940. args.push_back("reverse");
  1941. args.push_back("tcp:" + itos(fs_port));
  1942. args.push_back("tcp:" + itos(fs_port));
  1943. output.clear();
  1944. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1945. print_verbose(output);
  1946. print_line("Reverse result2: " + itos(rv));
  1947. }
  1948. } else {
  1949. static const char *const api_version_msg = "--- Device API < 21; debugging over Wi-Fi ---";
  1950. static const char *const manual_override_msg = "--- Wi-Fi remote debug enabled in project settings; debugging over Wi-Fi ---";
  1951. const char *const msg = use_wifi_for_remote_debug ? manual_override_msg : api_version_msg;
  1952. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1953. print_line(String(msg).to_upper());
  1954. }
  1955. }
  1956. if (ep.step(TTR("Running on device..."), 3)) {
  1957. CLEANUP_AND_RETURN(ERR_SKIP);
  1958. }
  1959. args.clear();
  1960. args.push_back("-s");
  1961. args.push_back(devices[p_device].id);
  1962. args.push_back("shell");
  1963. args.push_back("am");
  1964. args.push_back("start");
  1965. if ((bool)EDITOR_GET("export/android/force_system_user") && devices[p_device].api_level >= 17) {
  1966. args.push_back("--user");
  1967. args.push_back("0");
  1968. }
  1969. args.push_back("-a");
  1970. args.push_back("android.intent.action.MAIN");
  1971. args.push_back("-n");
  1972. args.push_back(get_package_name(package_name) + "/com.godot.game.GodotApp");
  1973. output.clear();
  1974. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1975. print_verbose(output);
  1976. if (err || rv != 0) {
  1977. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Could not execute on device."));
  1978. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1979. }
  1980. CLEANUP_AND_RETURN(OK);
  1981. #undef CLEANUP_AND_RETURN
  1982. }
  1983. Ref<Texture2D> EditorExportPlatformAndroid::get_run_icon() const {
  1984. return run_icon;
  1985. }
  1986. String EditorExportPlatformAndroid::get_java_path() {
  1987. String exe_ext;
  1988. if (OS::get_singleton()->get_name() == "Windows") {
  1989. exe_ext = ".exe";
  1990. }
  1991. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  1992. return java_sdk_path.path_join("bin/java" + exe_ext);
  1993. }
  1994. String EditorExportPlatformAndroid::get_keytool_path() {
  1995. String exe_ext;
  1996. if (OS::get_singleton()->get_name() == "Windows") {
  1997. exe_ext = ".exe";
  1998. }
  1999. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2000. return java_sdk_path.path_join("bin/keytool" + exe_ext);
  2001. }
  2002. String EditorExportPlatformAndroid::get_adb_path() {
  2003. String exe_ext;
  2004. if (OS::get_singleton()->get_name() == "Windows") {
  2005. exe_ext = ".exe";
  2006. }
  2007. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2008. return sdk_path.path_join("platform-tools/adb" + exe_ext);
  2009. }
  2010. String EditorExportPlatformAndroid::get_apksigner_path(int p_target_sdk, bool p_check_executes) {
  2011. if (p_target_sdk == -1) {
  2012. p_target_sdk = DEFAULT_TARGET_SDK_VERSION;
  2013. }
  2014. String exe_ext;
  2015. if (OS::get_singleton()->get_name() == "Windows") {
  2016. exe_ext = ".bat";
  2017. }
  2018. String apksigner_command_name = "apksigner" + exe_ext;
  2019. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2020. String apksigner_path;
  2021. Error errn;
  2022. String build_tools_dir = sdk_path.path_join("build-tools");
  2023. Ref<DirAccess> da = DirAccess::open(build_tools_dir, &errn);
  2024. if (errn != OK) {
  2025. print_error("Unable to open Android 'build-tools' directory.");
  2026. return apksigner_path;
  2027. }
  2028. // There are additional versions directories we need to go through.
  2029. Vector<String> dir_list = da->get_directories();
  2030. // We need to use the version of build_tools that matches the Target SDK
  2031. // If somehow we can't find that, we see if a version between 28 and the default target SDK exists.
  2032. // We need to avoid versions <= 27 because they fail on Java versions >9
  2033. // If we can't find that, we just use the first valid version.
  2034. Vector<String> ideal_versions;
  2035. Vector<String> other_versions;
  2036. Vector<String> versions;
  2037. bool found_target_sdk = false;
  2038. // We only allow for versions <= 27 if specifically set
  2039. int min_version = p_target_sdk <= 27 ? p_target_sdk : 28;
  2040. for (String sub_dir : dir_list) {
  2041. if (!sub_dir.begins_with(".")) {
  2042. Vector<String> ver_numbers = sub_dir.split(".");
  2043. // Dir not a version number, will use as last resort
  2044. if (!ver_numbers.size() || !ver_numbers[0].is_valid_int()) {
  2045. other_versions.push_back(sub_dir);
  2046. continue;
  2047. }
  2048. int ver_number = ver_numbers[0].to_int();
  2049. if (ver_number == p_target_sdk) {
  2050. found_target_sdk = true;
  2051. //ensure this is in front of the ones we check
  2052. versions.push_back(sub_dir);
  2053. } else {
  2054. if (ver_number >= min_version && ver_number <= DEFAULT_TARGET_SDK_VERSION) {
  2055. ideal_versions.push_back(sub_dir);
  2056. } else {
  2057. other_versions.push_back(sub_dir);
  2058. }
  2059. }
  2060. }
  2061. }
  2062. // we will check ideal versions first, then other versions.
  2063. versions.append_array(ideal_versions);
  2064. versions.append_array(other_versions);
  2065. if (!versions.size()) {
  2066. print_error("Unable to find the 'apksigner' tool.");
  2067. return apksigner_path;
  2068. }
  2069. int i;
  2070. bool failed = false;
  2071. String version_to_use;
  2072. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2073. if (!java_sdk_path.is_empty()) {
  2074. OS::get_singleton()->set_environment("JAVA_HOME", java_sdk_path);
  2075. }
  2076. List<String> args;
  2077. args.push_back("--version");
  2078. String output;
  2079. int retval;
  2080. Error err;
  2081. for (i = 0; i < versions.size(); i++) {
  2082. // Check if the tool is here.
  2083. apksigner_path = build_tools_dir.path_join(versions[i]).path_join(apksigner_command_name);
  2084. if (FileAccess::exists(apksigner_path)) {
  2085. version_to_use = versions[i];
  2086. // If we aren't exporting, just break here.
  2087. if (!p_check_executes) {
  2088. break;
  2089. }
  2090. // we only check to see if it executes on export because it is slow to load
  2091. err = OS::get_singleton()->execute(apksigner_path, args, &output, &retval, false);
  2092. if (err || retval) {
  2093. failed = true;
  2094. } else {
  2095. break;
  2096. }
  2097. }
  2098. }
  2099. if (i == versions.size()) {
  2100. if (failed) {
  2101. print_error("All located 'apksigner' tools in " + build_tools_dir + " failed to execute");
  2102. return "<FAILED>";
  2103. } else {
  2104. print_error("Unable to find the 'apksigner' tool.");
  2105. return "";
  2106. }
  2107. }
  2108. if (!found_target_sdk) {
  2109. print_line("Could not find version of build tools that matches Target SDK, using " + version_to_use);
  2110. } else if (failed && found_target_sdk) {
  2111. print_line("Version of build tools that matches Target SDK failed to execute, using " + version_to_use);
  2112. }
  2113. return apksigner_path;
  2114. }
  2115. static bool has_valid_keystore_credentials(String &r_error_str, const String &p_keystore, const String &p_username, const String &p_password, const String &p_type) {
  2116. String output;
  2117. List<String> args;
  2118. args.push_back("-list");
  2119. args.push_back("-keystore");
  2120. args.push_back(p_keystore);
  2121. args.push_back("-storepass");
  2122. args.push_back(p_password);
  2123. args.push_back("-alias");
  2124. args.push_back(p_username);
  2125. String keytool_path = EditorExportPlatformAndroid::get_keytool_path();
  2126. Error error = OS::get_singleton()->execute(keytool_path, args, &output, nullptr, true);
  2127. String keytool_error = "keytool error:";
  2128. bool valid = output.substr(0, keytool_error.length()) != keytool_error;
  2129. if (error != OK) {
  2130. r_error_str = TTR("Error: There was a problem validating the keystore username and password");
  2131. return false;
  2132. }
  2133. if (!valid) {
  2134. r_error_str = TTR(p_type + " Username and/or Password is invalid for the given " + p_type + " Keystore");
  2135. return false;
  2136. }
  2137. r_error_str = "";
  2138. return true;
  2139. }
  2140. bool EditorExportPlatformAndroid::has_valid_username_and_password(const Ref<EditorExportPreset> &p_preset, String &r_error) {
  2141. String dk = _get_keystore_path(p_preset, true);
  2142. String dk_user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2143. String dk_password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2144. String rk = _get_keystore_path(p_preset, false);
  2145. String rk_user = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2146. String rk_password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2147. bool valid = true;
  2148. if (!dk.is_empty() && !dk_user.is_empty() && !dk_password.is_empty()) {
  2149. String err = "";
  2150. valid = has_valid_keystore_credentials(err, dk, dk_user, dk_password, "Debug");
  2151. r_error += err;
  2152. }
  2153. if (!rk.is_empty() && !rk_user.is_empty() && !rk_password.is_empty()) {
  2154. String err = "";
  2155. valid = has_valid_keystore_credentials(err, rk, rk_user, rk_password, "Release");
  2156. r_error += err;
  2157. }
  2158. return valid;
  2159. }
  2160. bool EditorExportPlatformAndroid::has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const {
  2161. String err;
  2162. bool valid = false;
  2163. const bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  2164. #ifdef MODULE_MONO_ENABLED
  2165. // Android export is still a work in progress, keep a message as a warning.
  2166. err += TTR("Exporting to Android when using C#/.NET is experimental.") + "\n";
  2167. #endif
  2168. // Look for export templates (first official, and if defined custom templates).
  2169. if (!gradle_build_enabled) {
  2170. String template_err;
  2171. bool dvalid = false;
  2172. bool rvalid = false;
  2173. bool has_export_templates = false;
  2174. if (p_preset->get("custom_template/debug") != "") {
  2175. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  2176. if (!dvalid) {
  2177. template_err += TTR("Custom debug template not found.") + "\n";
  2178. }
  2179. } else {
  2180. has_export_templates |= exists_export_template("android_debug.apk", &template_err);
  2181. }
  2182. if (p_preset->get("custom_template/release") != "") {
  2183. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  2184. if (!rvalid) {
  2185. template_err += TTR("Custom release template not found.") + "\n";
  2186. }
  2187. } else {
  2188. has_export_templates |= exists_export_template("android_release.apk", &template_err);
  2189. }
  2190. r_missing_templates = !has_export_templates;
  2191. valid = dvalid || rvalid || has_export_templates;
  2192. if (!valid) {
  2193. err += template_err;
  2194. }
  2195. } else {
  2196. #ifdef ANDROID_ENABLED
  2197. err += TTR("Gradle build is not supported for the Android editor.") + "\n";
  2198. valid = false;
  2199. #else
  2200. // Validate the custom gradle android source template.
  2201. bool android_source_template_valid = false;
  2202. const String android_source_template = p_preset->get("gradle_build/android_source_template");
  2203. if (!android_source_template.is_empty()) {
  2204. android_source_template_valid = FileAccess::exists(android_source_template);
  2205. if (!android_source_template_valid) {
  2206. err += TTR("Custom Android source template not found.") + "\n";
  2207. }
  2208. }
  2209. // Validate the installed build template.
  2210. bool installed_android_build_template = FileAccess::exists(ExportTemplateManager::get_android_build_directory(p_preset).path_join("build.gradle"));
  2211. if (!installed_android_build_template) {
  2212. if (!android_source_template_valid) {
  2213. r_missing_templates = !exists_export_template("android_source.zip", &err);
  2214. }
  2215. err += TTR("Android build template not installed in the project. Install it from the Project menu.") + "\n";
  2216. } else {
  2217. r_missing_templates = false;
  2218. }
  2219. valid = installed_android_build_template && !r_missing_templates;
  2220. #endif
  2221. }
  2222. // Validate the rest of the export configuration.
  2223. String dk = _get_keystore_path(p_preset, true);
  2224. String dk_user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2225. String dk_password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2226. if ((dk.is_empty() || dk_user.is_empty() || dk_password.is_empty()) && (!dk.is_empty() || !dk_user.is_empty() || !dk_password.is_empty())) {
  2227. valid = false;
  2228. err += TTR("Either Debug Keystore, Debug User AND Debug Password settings must be configured OR none of them.") + "\n";
  2229. }
  2230. // Use OR to make the export UI able to show this error.
  2231. if ((p_debug || !dk.is_empty()) && !FileAccess::exists(dk)) {
  2232. dk = EDITOR_GET("export/android/debug_keystore");
  2233. if (!FileAccess::exists(dk)) {
  2234. valid = false;
  2235. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  2236. }
  2237. }
  2238. String rk = _get_keystore_path(p_preset, false);
  2239. String rk_user = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2240. String rk_password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2241. if ((rk.is_empty() || rk_user.is_empty() || rk_password.is_empty()) && (!rk.is_empty() || !rk_user.is_empty() || !rk_password.is_empty())) {
  2242. valid = false;
  2243. err += TTR("Either Release Keystore, Release User AND Release Password settings must be configured OR none of them.") + "\n";
  2244. }
  2245. if (!p_debug && !rk.is_empty() && !FileAccess::exists(rk)) {
  2246. valid = false;
  2247. err += TTR("Release keystore incorrectly configured in the export preset.") + "\n";
  2248. }
  2249. #ifndef ANDROID_ENABLED
  2250. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2251. if (java_sdk_path.is_empty()) {
  2252. err += TTR("A valid Java SDK path is required in Editor Settings.") + "\n";
  2253. valid = false;
  2254. } else {
  2255. // Validate the given path by checking that `java` is present under the `bin` directory.
  2256. Error errn;
  2257. // Check for the bin directory.
  2258. Ref<DirAccess> da = DirAccess::open(java_sdk_path.path_join("bin"), &errn);
  2259. if (errn != OK) {
  2260. err += TTR("Invalid Java SDK path in Editor Settings.") + " ";
  2261. err += TTR("Missing 'bin' directory!");
  2262. err += "\n";
  2263. valid = false;
  2264. } else {
  2265. // Check for the `java` command.
  2266. String java_path = get_java_path();
  2267. if (!FileAccess::exists(java_path)) {
  2268. err += TTR("Unable to find 'java' command using the Java SDK path.") + " ";
  2269. err += TTR("Please check the Java SDK directory specified in Editor Settings.");
  2270. err += "\n";
  2271. valid = false;
  2272. }
  2273. }
  2274. }
  2275. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2276. if (sdk_path.is_empty()) {
  2277. err += TTR("A valid Android SDK path is required in Editor Settings.") + "\n";
  2278. valid = false;
  2279. } else {
  2280. Error errn;
  2281. // Check for the platform-tools directory.
  2282. Ref<DirAccess> da = DirAccess::open(sdk_path.path_join("platform-tools"), &errn);
  2283. if (errn != OK) {
  2284. err += TTR("Invalid Android SDK path in Editor Settings.") + " ";
  2285. err += TTR("Missing 'platform-tools' directory!");
  2286. err += "\n";
  2287. valid = false;
  2288. }
  2289. // Validate that adb is available.
  2290. String adb_path = get_adb_path();
  2291. if (!FileAccess::exists(adb_path)) {
  2292. err += TTR("Unable to find Android SDK platform-tools' adb command.") + " ";
  2293. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  2294. err += "\n";
  2295. valid = false;
  2296. }
  2297. // Check for the build-tools directory.
  2298. Ref<DirAccess> build_tools_da = DirAccess::open(sdk_path.path_join("build-tools"), &errn);
  2299. if (errn != OK) {
  2300. err += TTR("Invalid Android SDK path in Editor Settings.") + " ";
  2301. err += TTR("Missing 'build-tools' directory!");
  2302. err += "\n";
  2303. valid = false;
  2304. }
  2305. String target_sdk_version = p_preset->get("gradle_build/target_sdk");
  2306. if (!target_sdk_version.is_valid_int()) {
  2307. target_sdk_version = itos(DEFAULT_TARGET_SDK_VERSION);
  2308. }
  2309. // Validate that apksigner is available.
  2310. String apksigner_path = get_apksigner_path(target_sdk_version.to_int());
  2311. if (!FileAccess::exists(apksigner_path)) {
  2312. err += TTR("Unable to find Android SDK build-tools' apksigner command.") + " ";
  2313. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  2314. err += "\n";
  2315. valid = false;
  2316. }
  2317. }
  2318. #endif
  2319. if (!err.is_empty()) {
  2320. r_error = err;
  2321. }
  2322. return valid;
  2323. }
  2324. bool EditorExportPlatformAndroid::has_valid_project_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error) const {
  2325. String err;
  2326. bool valid = true;
  2327. List<ExportOption> options;
  2328. get_export_options(&options);
  2329. for (const EditorExportPlatform::ExportOption &E : options) {
  2330. if (get_export_option_visibility(p_preset.ptr(), E.option.name)) {
  2331. String warn = get_export_option_warning(p_preset.ptr(), E.option.name);
  2332. if (!warn.is_empty()) {
  2333. err += warn + "\n";
  2334. if (E.required) {
  2335. valid = false;
  2336. }
  2337. }
  2338. }
  2339. }
  2340. if (!ResourceImporterTextureSettings::should_import_etc2_astc()) {
  2341. valid = false;
  2342. }
  2343. if (p_preset->get("gradle_build/use_gradle_build")) {
  2344. String build_version_path = ExportTemplateManager::get_android_build_directory(p_preset).get_base_dir().path_join(".build_version");
  2345. Ref<FileAccess> f = FileAccess::open(build_version_path, FileAccess::READ);
  2346. if (f.is_valid()) {
  2347. String current_version = ExportTemplateManager::get_android_template_identifier(p_preset);
  2348. String installed_version = f->get_line().strip_edges();
  2349. if (current_version != installed_version) {
  2350. err += vformat(TTR(MISMATCHED_VERSIONS_MESSAGE), installed_version, current_version);
  2351. err += "\n";
  2352. }
  2353. }
  2354. }
  2355. String min_sdk_str = p_preset->get("gradle_build/min_sdk");
  2356. int min_sdk_int = VULKAN_MIN_SDK_VERSION;
  2357. if (!min_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  2358. if (min_sdk_str.is_valid_int()) {
  2359. min_sdk_int = min_sdk_str.to_int();
  2360. }
  2361. }
  2362. String target_sdk_str = p_preset->get("gradle_build/target_sdk");
  2363. int target_sdk_int = DEFAULT_TARGET_SDK_VERSION;
  2364. if (!target_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  2365. if (target_sdk_str.is_valid_int()) {
  2366. target_sdk_int = target_sdk_str.to_int();
  2367. if (target_sdk_int > DEFAULT_TARGET_SDK_VERSION) {
  2368. // Warning only, so don't override `valid`.
  2369. err += vformat(TTR("\"Target SDK\" %d is higher than the default version %d. This may work, but wasn't tested and may be unstable."), target_sdk_int, DEFAULT_TARGET_SDK_VERSION);
  2370. err += "\n";
  2371. }
  2372. }
  2373. }
  2374. String current_renderer = GLOBAL_GET("rendering/renderer/rendering_method.mobile");
  2375. if (current_renderer == "forward_plus") {
  2376. // Warning only, so don't override `valid`.
  2377. err += vformat(TTR("The \"%s\" renderer is designed for Desktop devices, and is not suitable for Android devices."), current_renderer);
  2378. err += "\n";
  2379. }
  2380. if (_uses_vulkan() && min_sdk_int < VULKAN_MIN_SDK_VERSION) {
  2381. // Warning only, so don't override `valid`.
  2382. err += vformat(TTR("\"Min SDK\" should be greater or equal to %d for the \"%s\" renderer."), VULKAN_MIN_SDK_VERSION, current_renderer);
  2383. err += "\n";
  2384. }
  2385. String package_name = p_preset->get("package/unique_name");
  2386. if (package_name.contains("$genname") && !is_project_name_valid()) {
  2387. // Warning only, so don't override `valid`.
  2388. err += vformat(TTR("The project name does not meet the requirement for the package name format and will be updated to \"%s\". Please explicitly specify the package name if needed."), get_valid_basename());
  2389. err += "\n";
  2390. }
  2391. r_error = err;
  2392. return valid;
  2393. }
  2394. List<String> EditorExportPlatformAndroid::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  2395. List<String> list;
  2396. list.push_back("apk");
  2397. list.push_back("aab");
  2398. return list;
  2399. }
  2400. String EditorExportPlatformAndroid::get_apk_expansion_fullpath(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  2401. int version_code = p_preset->get("version/code");
  2402. String package_name = p_preset->get("package/unique_name");
  2403. String apk_file_name = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  2404. String fullpath = p_path.get_base_dir().path_join(apk_file_name);
  2405. return fullpath;
  2406. }
  2407. Error EditorExportPlatformAndroid::save_apk_expansion_file(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  2408. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  2409. Error err = save_pack(p_preset, p_debug, fullpath);
  2410. return err;
  2411. }
  2412. void EditorExportPlatformAndroid::get_command_line_flags(const Ref<EditorExportPreset> &p_preset, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags, Vector<uint8_t> &r_command_line_flags) {
  2413. String cmdline = p_preset->get("command_line/extra_args");
  2414. Vector<String> command_line_strings = cmdline.strip_edges().split(" ");
  2415. for (int i = 0; i < command_line_strings.size(); i++) {
  2416. if (command_line_strings[i].strip_edges().length() == 0) {
  2417. command_line_strings.remove_at(i);
  2418. i--;
  2419. }
  2420. }
  2421. command_line_strings.append_array(gen_export_flags(p_flags));
  2422. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2423. if (apk_expansion) {
  2424. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  2425. String apk_expansion_public_key = p_preset->get("apk_expansion/public_key");
  2426. command_line_strings.push_back("--use_apk_expansion");
  2427. command_line_strings.push_back("--apk_expansion_md5");
  2428. command_line_strings.push_back(FileAccess::get_md5(fullpath));
  2429. command_line_strings.push_back("--apk_expansion_key");
  2430. command_line_strings.push_back(apk_expansion_public_key.strip_edges());
  2431. }
  2432. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  2433. if (xr_mode_index == XR_MODE_OPENXR) {
  2434. command_line_strings.push_back("--xr_mode_openxr");
  2435. } else { // XRMode.REGULAR is the default.
  2436. command_line_strings.push_back("--xr_mode_regular");
  2437. }
  2438. bool immersive = p_preset->get("screen/immersive_mode");
  2439. if (immersive) {
  2440. command_line_strings.push_back("--fullscreen");
  2441. }
  2442. bool debug_opengl = p_preset->get("graphics/opengl_debug");
  2443. if (debug_opengl) {
  2444. command_line_strings.push_back("--debug_opengl");
  2445. }
  2446. if (command_line_strings.size()) {
  2447. r_command_line_flags.resize(4);
  2448. encode_uint32(command_line_strings.size(), &r_command_line_flags.write[0]);
  2449. for (int i = 0; i < command_line_strings.size(); i++) {
  2450. print_line(itos(i) + " param: " + command_line_strings[i]);
  2451. CharString command_line_argument = command_line_strings[i].utf8();
  2452. int base = r_command_line_flags.size();
  2453. int length = command_line_argument.length();
  2454. if (length == 0) {
  2455. continue;
  2456. }
  2457. r_command_line_flags.resize(base + 4 + length);
  2458. encode_uint32(length, &r_command_line_flags.write[base]);
  2459. memcpy(&r_command_line_flags.write[base + 4], command_line_argument.ptr(), length);
  2460. }
  2461. }
  2462. }
  2463. Error EditorExportPlatformAndroid::sign_apk(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &export_path, EditorProgress &ep) {
  2464. int export_format = int(p_preset->get("gradle_build/export_format"));
  2465. if (export_format == EXPORT_FORMAT_AAB) {
  2466. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("AAB signing is not supported"));
  2467. return FAILED;
  2468. }
  2469. String keystore;
  2470. String password;
  2471. String user;
  2472. if (p_debug) {
  2473. keystore = _get_keystore_path(p_preset, true);
  2474. password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2475. user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2476. if (keystore.is_empty()) {
  2477. keystore = EDITOR_GET("export/android/debug_keystore");
  2478. password = EDITOR_GET("export/android/debug_keystore_pass");
  2479. user = EDITOR_GET("export/android/debug_keystore_user");
  2480. }
  2481. if (ep.step(TTR("Signing debug APK..."), 104)) {
  2482. return ERR_SKIP;
  2483. }
  2484. } else {
  2485. keystore = _get_keystore_path(p_preset, false);
  2486. password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2487. user = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2488. if (ep.step(TTR("Signing release APK..."), 104)) {
  2489. return ERR_SKIP;
  2490. }
  2491. }
  2492. if (!FileAccess::exists(keystore)) {
  2493. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not find keystore, unable to export."));
  2494. return ERR_FILE_CANT_OPEN;
  2495. }
  2496. String apk_path = export_path;
  2497. if (apk_path.is_relative_path()) {
  2498. apk_path = OS::get_singleton()->get_resource_dir().path_join(apk_path);
  2499. }
  2500. apk_path = ProjectSettings::get_singleton()->globalize_path(apk_path).simplify_path();
  2501. Error err;
  2502. #ifdef ANDROID_ENABLED
  2503. err = OS_Android::get_singleton()->sign_apk(apk_path, apk_path, keystore, user, password);
  2504. if (err != OK) {
  2505. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Unable to sign apk."));
  2506. return err;
  2507. }
  2508. #else
  2509. String target_sdk_version = p_preset->get("gradle_build/target_sdk");
  2510. if (!target_sdk_version.is_valid_int()) {
  2511. target_sdk_version = itos(DEFAULT_TARGET_SDK_VERSION);
  2512. }
  2513. String apksigner = get_apksigner_path(target_sdk_version.to_int(), true);
  2514. print_verbose("Starting signing of the APK binary using " + apksigner);
  2515. if (apksigner == "<FAILED>") {
  2516. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("All 'apksigner' tools located in Android SDK 'build-tools' directory failed to execute. Please check that you have the correct version installed for your target sdk version. The resulting APK is unsigned."));
  2517. return OK;
  2518. }
  2519. if (!FileAccess::exists(apksigner)) {
  2520. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("'apksigner' could not be found. Please check that the command is available in the Android SDK build-tools directory. The resulting APK is unsigned."));
  2521. return OK;
  2522. }
  2523. String output;
  2524. List<String> args;
  2525. args.push_back("sign");
  2526. args.push_back("--verbose");
  2527. args.push_back("--ks");
  2528. args.push_back(keystore);
  2529. args.push_back("--ks-pass");
  2530. args.push_back("pass:" + password);
  2531. args.push_back("--ks-key-alias");
  2532. args.push_back(user);
  2533. args.push_back(apk_path);
  2534. if (OS::get_singleton()->is_stdout_verbose() && p_debug) {
  2535. // We only print verbose logs with credentials for debug builds to avoid leaking release keystore credentials.
  2536. print_verbose("Signing debug binary using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2537. } else {
  2538. List<String> redacted_args = List<String>(args);
  2539. redacted_args.find(keystore)->set("<REDACTED>");
  2540. redacted_args.find("pass:" + password)->set("pass:<REDACTED>");
  2541. redacted_args.find(user)->set("<REDACTED>");
  2542. print_line("Signing binary using: " + String("\n") + apksigner + " " + join_list(redacted_args, String(" ")));
  2543. }
  2544. int retval;
  2545. err = OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2546. if (err != OK) {
  2547. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start apksigner executable."));
  2548. return err;
  2549. }
  2550. // By design, apksigner does not output credentials in its output unless --verbose is used
  2551. print_line(output);
  2552. if (retval) {
  2553. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("'apksigner' returned with error #%d"), retval));
  2554. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("output: \n%s"), output));
  2555. return ERR_CANT_CREATE;
  2556. }
  2557. #endif
  2558. if (ep.step(TTR("Verifying APK..."), 105)) {
  2559. return ERR_SKIP;
  2560. }
  2561. #ifdef ANDROID_ENABLED
  2562. err = OS_Android::get_singleton()->verify_apk(apk_path);
  2563. if (err != OK) {
  2564. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Unable to verify signed apk."));
  2565. return err;
  2566. }
  2567. #else
  2568. args.clear();
  2569. args.push_back("verify");
  2570. args.push_back("--verbose");
  2571. args.push_back(apk_path);
  2572. if (p_debug) {
  2573. print_verbose("Verifying signed build using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2574. }
  2575. output.clear();
  2576. err = OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2577. if (err != OK) {
  2578. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start apksigner executable."));
  2579. return err;
  2580. }
  2581. print_verbose(output);
  2582. if (retval) {
  2583. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("'apksigner' verification of APK failed."));
  2584. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("output: \n%s"), output));
  2585. return ERR_CANT_CREATE;
  2586. }
  2587. #endif
  2588. print_verbose("Successfully completed signing build.");
  2589. #ifdef ANDROID_ENABLED
  2590. bool prompt_apk_install = EDITOR_GET("export/android/install_exported_apk");
  2591. if (prompt_apk_install) {
  2592. OS_Android::get_singleton()->shell_open(apk_path);
  2593. }
  2594. #endif
  2595. return OK;
  2596. }
  2597. void EditorExportPlatformAndroid::_clear_assets_directory(const Ref<EditorExportPreset> &p_preset) {
  2598. Ref<DirAccess> da_res = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2599. String gradle_build_directory = ExportTemplateManager::get_android_build_directory(p_preset);
  2600. // Clear the APK assets directory
  2601. String apk_assets_directory = gradle_build_directory.path_join(APK_ASSETS_DIRECTORY);
  2602. if (da_res->dir_exists(apk_assets_directory)) {
  2603. print_verbose("Clearing APK assets directory...");
  2604. Ref<DirAccess> da_assets = DirAccess::open(apk_assets_directory);
  2605. ERR_FAIL_COND(da_assets.is_null());
  2606. da_assets->erase_contents_recursive();
  2607. da_res->remove(apk_assets_directory);
  2608. }
  2609. // Clear the AAB assets directory
  2610. String aab_assets_directory = gradle_build_directory.path_join(AAB_ASSETS_DIRECTORY);
  2611. if (da_res->dir_exists(aab_assets_directory)) {
  2612. print_verbose("Clearing AAB assets directory...");
  2613. Ref<DirAccess> da_assets = DirAccess::open(aab_assets_directory);
  2614. ERR_FAIL_COND(da_assets.is_null());
  2615. da_assets->erase_contents_recursive();
  2616. da_res->remove(aab_assets_directory);
  2617. }
  2618. }
  2619. void EditorExportPlatformAndroid::_remove_copied_libs(String p_gdextension_libs_path) {
  2620. print_verbose("Removing previously installed libraries...");
  2621. Error error;
  2622. String libs_json = FileAccess::get_file_as_string(p_gdextension_libs_path, &error);
  2623. if (error || libs_json.is_empty()) {
  2624. print_verbose("No previously installed libraries found");
  2625. return;
  2626. }
  2627. JSON json;
  2628. error = json.parse(libs_json);
  2629. ERR_FAIL_COND_MSG(error, "Error parsing \"" + libs_json + "\" on line " + itos(json.get_error_line()) + ": " + json.get_error_message());
  2630. Vector<String> libs = json.get_data();
  2631. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2632. for (int i = 0; i < libs.size(); i++) {
  2633. print_verbose("Removing previously installed library " + libs[i]);
  2634. da->remove(libs[i]);
  2635. }
  2636. da->remove(p_gdextension_libs_path);
  2637. }
  2638. String EditorExportPlatformAndroid::join_list(const List<String> &p_parts, const String &p_separator) {
  2639. String ret;
  2640. for (List<String>::ConstIterator itr = p_parts.begin(); itr != p_parts.end(); ++itr) {
  2641. if (itr != p_parts.begin()) {
  2642. ret += p_separator;
  2643. }
  2644. ret += *itr;
  2645. }
  2646. return ret;
  2647. }
  2648. String EditorExportPlatformAndroid::join_abis(const Vector<EditorExportPlatformAndroid::ABI> &p_parts, const String &p_separator, bool p_use_arch) {
  2649. String ret;
  2650. for (int i = 0; i < p_parts.size(); ++i) {
  2651. if (i > 0) {
  2652. ret += p_separator;
  2653. }
  2654. ret += (p_use_arch) ? p_parts[i].arch : p_parts[i].abi;
  2655. }
  2656. return ret;
  2657. }
  2658. String EditorExportPlatformAndroid::_get_plugins_names(const Ref<EditorExportPreset> &p_preset) const {
  2659. Vector<String> names;
  2660. #ifndef DISABLE_DEPRECATED
  2661. PluginConfigAndroid::get_plugins_names(get_enabled_plugins(p_preset), names);
  2662. #endif // DISABLE_DEPRECATED
  2663. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  2664. for (int i = 0; i < export_plugins.size(); i++) {
  2665. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  2666. names.push_back(export_plugins[i]->get_name());
  2667. }
  2668. }
  2669. String plugins_names = String("|").join(names);
  2670. return plugins_names;
  2671. }
  2672. String EditorExportPlatformAndroid::_resolve_export_plugin_android_library_path(const String &p_android_library_path) const {
  2673. String absolute_path;
  2674. if (!p_android_library_path.is_empty()) {
  2675. if (p_android_library_path.is_absolute_path()) {
  2676. absolute_path = ProjectSettings::get_singleton()->globalize_path(p_android_library_path);
  2677. } else {
  2678. const String export_plugin_absolute_path = String("res://addons/").path_join(p_android_library_path);
  2679. absolute_path = ProjectSettings::get_singleton()->globalize_path(export_plugin_absolute_path);
  2680. }
  2681. }
  2682. return absolute_path;
  2683. }
  2684. bool EditorExportPlatformAndroid::_is_clean_build_required(const Ref<EditorExportPreset> &p_preset) {
  2685. bool first_build = last_gradle_build_time == 0;
  2686. bool have_plugins_changed = false;
  2687. String gradle_build_dir = ExportTemplateManager::get_android_build_directory(p_preset);
  2688. bool has_build_dir_changed = last_gradle_build_dir != gradle_build_dir;
  2689. String plugin_names = _get_plugins_names(p_preset);
  2690. if (!first_build) {
  2691. have_plugins_changed = plugin_names != last_plugin_names;
  2692. #ifndef DISABLE_DEPRECATED
  2693. if (!have_plugins_changed) {
  2694. Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
  2695. for (int i = 0; i < enabled_plugins.size(); i++) {
  2696. if (enabled_plugins.get(i).last_updated > last_gradle_build_time) {
  2697. have_plugins_changed = true;
  2698. break;
  2699. }
  2700. }
  2701. }
  2702. #endif // DISABLE_DEPRECATED
  2703. }
  2704. last_gradle_build_time = OS::get_singleton()->get_unix_time();
  2705. last_gradle_build_dir = gradle_build_dir;
  2706. last_plugin_names = plugin_names;
  2707. return have_plugins_changed || has_build_dir_changed || first_build;
  2708. }
  2709. Error EditorExportPlatformAndroid::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  2710. int export_format = int(p_preset->get("gradle_build/export_format"));
  2711. bool should_sign = p_preset->get("package/signed");
  2712. return export_project_helper(p_preset, p_debug, p_path, export_format, should_sign, p_flags);
  2713. }
  2714. Error EditorExportPlatformAndroid::export_project_helper(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int export_format, bool should_sign, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  2715. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  2716. const String base_dir = p_path.get_base_dir();
  2717. if (!DirAccess::exists(base_dir)) {
  2718. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Target folder does not exist or is inaccessible: \"%s\""), base_dir));
  2719. return ERR_FILE_BAD_PATH;
  2720. }
  2721. String src_apk;
  2722. Error err;
  2723. EditorProgress ep("export", TTR("Exporting for Android"), 105, true);
  2724. bool use_gradle_build = bool(p_preset->get("gradle_build/use_gradle_build"));
  2725. String gradle_build_directory = use_gradle_build ? ExportTemplateManager::get_android_build_directory(p_preset) : "";
  2726. bool p_give_internet = p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT) || p_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG);
  2727. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2728. Vector<ABI> enabled_abis = get_enabled_abis(p_preset);
  2729. print_verbose("Exporting for Android...");
  2730. print_verbose("- debug build: " + bool_to_string(p_debug));
  2731. print_verbose("- export path: " + p_path);
  2732. print_verbose("- export format: " + itos(export_format));
  2733. print_verbose("- sign build: " + bool_to_string(should_sign));
  2734. print_verbose("- gradle build enabled: " + bool_to_string(use_gradle_build));
  2735. print_verbose("- apk expansion enabled: " + bool_to_string(apk_expansion));
  2736. print_verbose("- enabled abis: " + join_abis(enabled_abis, ",", false));
  2737. print_verbose("- export filter: " + itos(p_preset->get_export_filter()));
  2738. print_verbose("- include filter: " + p_preset->get_include_filter());
  2739. print_verbose("- exclude filter: " + p_preset->get_exclude_filter());
  2740. Ref<Image> main_image;
  2741. Ref<Image> foreground;
  2742. Ref<Image> background;
  2743. Ref<Image> monochrome;
  2744. load_icon_refs(p_preset, main_image, foreground, background, monochrome);
  2745. Vector<uint8_t> command_line_flags;
  2746. // Write command line flags into the command_line_flags variable.
  2747. get_command_line_flags(p_preset, p_path, p_flags, command_line_flags);
  2748. if (export_format == EXPORT_FORMAT_AAB) {
  2749. if (!p_path.ends_with(".aab")) {
  2750. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Invalid filename! Android App Bundle requires the *.aab extension."));
  2751. return ERR_UNCONFIGURED;
  2752. }
  2753. if (apk_expansion) {
  2754. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("APK Expansion not compatible with Android App Bundle."));
  2755. return ERR_UNCONFIGURED;
  2756. }
  2757. }
  2758. if (export_format == EXPORT_FORMAT_APK && !p_path.ends_with(".apk")) {
  2759. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Invalid filename! Android APK requires the *.apk extension."));
  2760. return ERR_UNCONFIGURED;
  2761. }
  2762. if (export_format > EXPORT_FORMAT_AAB || export_format < EXPORT_FORMAT_APK) {
  2763. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Unsupported export format!"));
  2764. return ERR_UNCONFIGURED;
  2765. }
  2766. String err_string;
  2767. if (!has_valid_username_and_password(p_preset, err_string)) {
  2768. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR(err_string));
  2769. return ERR_UNCONFIGURED;
  2770. }
  2771. if (use_gradle_build) {
  2772. print_verbose("Starting gradle build...");
  2773. //test that installed build version is alright
  2774. {
  2775. print_verbose("Checking build version...");
  2776. String gradle_base_directory = gradle_build_directory.get_base_dir();
  2777. Ref<FileAccess> f = FileAccess::open(gradle_base_directory.path_join(".build_version"), FileAccess::READ);
  2778. if (f.is_null()) {
  2779. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Trying to build from a gradle built template, but no version info for it exists. Please reinstall from the 'Project' menu."));
  2780. return ERR_UNCONFIGURED;
  2781. }
  2782. String current_version = ExportTemplateManager::get_android_template_identifier(p_preset);
  2783. String installed_version = f->get_line().strip_edges();
  2784. print_verbose("- build version: " + installed_version);
  2785. if (installed_version != current_version) {
  2786. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR(MISMATCHED_VERSIONS_MESSAGE), installed_version, current_version));
  2787. return ERR_UNCONFIGURED;
  2788. }
  2789. }
  2790. const String assets_directory = get_assets_directory(p_preset, export_format);
  2791. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2792. if (java_sdk_path.is_empty()) {
  2793. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Java SDK path must be configured in Editor Settings at 'export/android/java_sdk_path'."));
  2794. return ERR_UNCONFIGURED;
  2795. }
  2796. print_verbose("Java sdk path: " + java_sdk_path);
  2797. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2798. if (sdk_path.is_empty()) {
  2799. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Android SDK path must be configured in Editor Settings at 'export/android/android_sdk_path'."));
  2800. return ERR_UNCONFIGURED;
  2801. }
  2802. print_verbose("Android sdk path: " + sdk_path);
  2803. // TODO: should we use "package/name" or "application/config/name"?
  2804. String project_name = get_project_name(p_preset->get("package/name"));
  2805. err = _create_project_name_strings_files(p_preset, project_name, gradle_build_directory); //project name localization.
  2806. if (err != OK) {
  2807. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Unable to overwrite res/*.xml files with project name."));
  2808. }
  2809. // Copies the project icon files into the appropriate Gradle project directory.
  2810. _copy_icons_to_gradle_project(p_preset, main_image, foreground, background, monochrome);
  2811. // Write an AndroidManifest.xml file into the Gradle project directory.
  2812. _write_tmp_manifest(p_preset, p_give_internet, p_debug);
  2813. // Modify res/values/themes.xml file.
  2814. _fix_themes_xml(p_preset);
  2815. //stores all the project files inside the Gradle project directory. Also includes all ABIs
  2816. _clear_assets_directory(p_preset);
  2817. String gdextension_libs_path = gradle_build_directory.path_join(GDEXTENSION_LIBS_PATH);
  2818. _remove_copied_libs(gdextension_libs_path);
  2819. if (!apk_expansion) {
  2820. print_verbose("Exporting project files...");
  2821. CustomExportData user_data;
  2822. user_data.assets_directory = assets_directory;
  2823. user_data.libs_directory = gradle_build_directory.path_join("libs");
  2824. user_data.debug = p_debug;
  2825. if (p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  2826. err = export_project_files(p_preset, p_debug, ignore_apk_file, nullptr, &user_data, copy_gradle_so);
  2827. } else {
  2828. err = export_project_files(p_preset, p_debug, rename_and_store_file_in_gradle_project, nullptr, &user_data, copy_gradle_so);
  2829. }
  2830. if (err != OK) {
  2831. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not export project files to gradle project."));
  2832. return err;
  2833. }
  2834. if (user_data.libs.size() > 0) {
  2835. Ref<FileAccess> fa = FileAccess::open(gdextension_libs_path, FileAccess::WRITE);
  2836. fa->store_string(JSON::stringify(user_data.libs, "\t"));
  2837. }
  2838. } else {
  2839. print_verbose("Saving apk expansion file...");
  2840. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  2841. if (err != OK) {
  2842. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not write expansion package file!"));
  2843. return err;
  2844. }
  2845. }
  2846. print_verbose("Storing command line flags...");
  2847. store_file_at_path(assets_directory + "/_cl_", command_line_flags);
  2848. print_verbose("Updating JAVA_HOME environment to " + java_sdk_path);
  2849. OS::get_singleton()->set_environment("JAVA_HOME", java_sdk_path);
  2850. print_verbose("Updating ANDROID_HOME environment to " + sdk_path);
  2851. OS::get_singleton()->set_environment("ANDROID_HOME", sdk_path);
  2852. String build_command;
  2853. #ifdef WINDOWS_ENABLED
  2854. build_command = "gradlew.bat";
  2855. #else
  2856. build_command = "gradlew";
  2857. #endif
  2858. String build_path = ProjectSettings::get_singleton()->globalize_path(gradle_build_directory);
  2859. build_command = build_path.path_join(build_command);
  2860. String package_name = get_package_name(p_preset->get("package/unique_name"));
  2861. String version_code = itos(p_preset->get("version/code"));
  2862. String version_name = p_preset->get_version("version/name");
  2863. String min_sdk_version = p_preset->get("gradle_build/min_sdk");
  2864. if (!min_sdk_version.is_valid_int()) {
  2865. min_sdk_version = itos(VULKAN_MIN_SDK_VERSION);
  2866. }
  2867. String target_sdk_version = p_preset->get("gradle_build/target_sdk");
  2868. if (!target_sdk_version.is_valid_int()) {
  2869. target_sdk_version = itos(DEFAULT_TARGET_SDK_VERSION);
  2870. }
  2871. String enabled_abi_string = join_abis(enabled_abis, "|", false);
  2872. String sign_flag = should_sign ? "true" : "false";
  2873. String zipalign_flag = "true";
  2874. String compress_native_libraries_flag = bool(p_preset->get("gradle_build/compress_native_libraries")) ? "true" : "false";
  2875. Vector<String> android_libraries;
  2876. Vector<String> android_dependencies;
  2877. Vector<String> android_dependencies_maven_repos;
  2878. #ifndef DISABLE_DEPRECATED
  2879. Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
  2880. PluginConfigAndroid::get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_LOCAL, enabled_plugins, android_libraries);
  2881. PluginConfigAndroid::get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_REMOTE, enabled_plugins, android_dependencies);
  2882. PluginConfigAndroid::get_plugins_custom_maven_repos(enabled_plugins, android_dependencies_maven_repos);
  2883. #endif // DISABLE_DEPRECATED
  2884. bool has_dotnet_project = false;
  2885. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  2886. for (int i = 0; i < export_plugins.size(); i++) {
  2887. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  2888. PackedStringArray export_plugin_android_libraries = export_plugins[i]->get_android_libraries(Ref<EditorExportPlatform>(this), p_debug);
  2889. for (int k = 0; k < export_plugin_android_libraries.size(); k++) {
  2890. const String resolved_android_library_path = _resolve_export_plugin_android_library_path(export_plugin_android_libraries[k]);
  2891. if (!resolved_android_library_path.is_empty()) {
  2892. android_libraries.push_back(resolved_android_library_path);
  2893. }
  2894. }
  2895. PackedStringArray export_plugin_android_dependencies = export_plugins[i]->get_android_dependencies(Ref<EditorExportPlatform>(this), p_debug);
  2896. android_dependencies.append_array(export_plugin_android_dependencies);
  2897. PackedStringArray export_plugin_android_dependencies_maven_repos = export_plugins[i]->get_android_dependencies_maven_repos(Ref<EditorExportPlatform>(this), p_debug);
  2898. android_dependencies_maven_repos.append_array(export_plugin_android_dependencies_maven_repos);
  2899. }
  2900. PackedStringArray features = export_plugins[i]->get_export_features(Ref<EditorExportPlatform>(this), p_debug);
  2901. if (features.has("dotnet")) {
  2902. has_dotnet_project = true;
  2903. }
  2904. }
  2905. bool clean_build_required = _is_clean_build_required(p_preset);
  2906. String combined_android_libraries = String("|").join(android_libraries);
  2907. String combined_android_dependencies = String("|").join(android_dependencies);
  2908. String combined_android_dependencies_maven_repos = String("|").join(android_dependencies_maven_repos);
  2909. List<String> cmdline;
  2910. cmdline.push_back("validateJavaVersion");
  2911. if (clean_build_required) {
  2912. cmdline.push_back("clean");
  2913. }
  2914. String edition = has_dotnet_project ? "Mono" : "Standard";
  2915. String build_type = p_debug ? "Debug" : "Release";
  2916. if (export_format == EXPORT_FORMAT_AAB) {
  2917. String bundle_build_command = vformat("bundle%s", build_type);
  2918. cmdline.push_back(bundle_build_command);
  2919. } else if (export_format == EXPORT_FORMAT_APK) {
  2920. String apk_build_command = vformat("assemble%s%s", edition, build_type);
  2921. cmdline.push_back(apk_build_command);
  2922. }
  2923. String addons_directory = ProjectSettings::get_singleton()->globalize_path("res://addons");
  2924. cmdline.push_back("-p"); // argument to specify the start directory.
  2925. cmdline.push_back(build_path); // start directory.
  2926. cmdline.push_back("-Paddons_directory=" + addons_directory); // path to the addon directory as it may contain jar or aar dependencies
  2927. cmdline.push_back("-Pexport_package_name=" + package_name); // argument to specify the package name.
  2928. cmdline.push_back("-Pexport_version_code=" + version_code); // argument to specify the version code.
  2929. cmdline.push_back("-Pexport_version_name=" + version_name); // argument to specify the version name.
  2930. cmdline.push_back("-Pexport_version_min_sdk=" + min_sdk_version); // argument to specify the min sdk.
  2931. cmdline.push_back("-Pexport_version_target_sdk=" + target_sdk_version); // argument to specify the target sdk.
  2932. cmdline.push_back("-Pexport_enabled_abis=" + enabled_abi_string); // argument to specify enabled ABIs.
  2933. cmdline.push_back("-Pplugins_local_binaries=" + combined_android_libraries); // argument to specify the list of android libraries provided by plugins.
  2934. cmdline.push_back("-Pplugins_remote_binaries=" + combined_android_dependencies); // argument to specify the list of android dependencies provided by plugins.
  2935. cmdline.push_back("-Pplugins_maven_repos=" + combined_android_dependencies_maven_repos); // argument to specify the list of maven repos for android dependencies provided by plugins.
  2936. cmdline.push_back("-Pperform_zipalign=" + zipalign_flag); // argument to specify whether the build should be zipaligned.
  2937. cmdline.push_back("-Pperform_signing=" + sign_flag); // argument to specify whether the build should be signed.
  2938. cmdline.push_back("-Pcompress_native_libraries=" + compress_native_libraries_flag); // argument to specify whether the build should compress native libraries.
  2939. cmdline.push_back("-Pgodot_editor_version=" + String(VERSION_FULL_CONFIG));
  2940. // NOTE: The release keystore is not included in the verbose logging
  2941. // to avoid accidentally leaking sensitive information when sharing verbose logs for troubleshooting.
  2942. // Any non-sensitive additions to the command line arguments must be done above this section.
  2943. // Sensitive additions must be done below the logging statement.
  2944. print_verbose("Build Android project using gradle command: " + String("\n") + build_command + " " + join_list(cmdline, String(" ")));
  2945. if (should_sign) {
  2946. if (p_debug) {
  2947. String debug_keystore = _get_keystore_path(p_preset, true);
  2948. String debug_password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2949. String debug_user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2950. if (debug_keystore.is_empty()) {
  2951. debug_keystore = EDITOR_GET("export/android/debug_keystore");
  2952. debug_password = EDITOR_GET("export/android/debug_keystore_pass");
  2953. debug_user = EDITOR_GET("export/android/debug_keystore_user");
  2954. }
  2955. if (debug_keystore.is_relative_path()) {
  2956. debug_keystore = OS::get_singleton()->get_resource_dir().path_join(debug_keystore).simplify_path();
  2957. }
  2958. if (!FileAccess::exists(debug_keystore)) {
  2959. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Could not find keystore, unable to export."));
  2960. return ERR_FILE_CANT_OPEN;
  2961. }
  2962. cmdline.push_back("-Pdebug_keystore_file=" + debug_keystore); // argument to specify the debug keystore file.
  2963. cmdline.push_back("-Pdebug_keystore_alias=" + debug_user); // argument to specify the debug keystore alias.
  2964. cmdline.push_back("-Pdebug_keystore_password=" + debug_password); // argument to specify the debug keystore password.
  2965. } else {
  2966. // Pass the release keystore info as well
  2967. String release_keystore = _get_keystore_path(p_preset, false);
  2968. String release_username = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2969. String release_password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2970. if (release_keystore.is_relative_path()) {
  2971. release_keystore = OS::get_singleton()->get_resource_dir().path_join(release_keystore).simplify_path();
  2972. }
  2973. if (!FileAccess::exists(release_keystore)) {
  2974. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Could not find keystore, unable to export."));
  2975. return ERR_FILE_CANT_OPEN;
  2976. }
  2977. cmdline.push_back("-Prelease_keystore_file=" + release_keystore); // argument to specify the release keystore file.
  2978. cmdline.push_back("-Prelease_keystore_alias=" + release_username); // argument to specify the release keystore alias.
  2979. cmdline.push_back("-Prelease_keystore_password=" + release_password); // argument to specify the release keystore password.
  2980. }
  2981. }
  2982. String build_project_output;
  2983. int result = EditorNode::get_singleton()->execute_and_show_output(TTR("Building Android Project (gradle)"), build_command, cmdline, true, false, &build_project_output);
  2984. if (result != 0) {
  2985. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Building of Android project failed, check output for the error:") + "\n\n" + build_project_output);
  2986. return ERR_CANT_CREATE;
  2987. } else {
  2988. print_verbose(build_project_output);
  2989. }
  2990. List<String> copy_args;
  2991. String copy_command = "copyAndRenameBinary";
  2992. copy_args.push_back(copy_command);
  2993. copy_args.push_back("-p"); // argument to specify the start directory.
  2994. copy_args.push_back(build_path); // start directory.
  2995. copy_args.push_back("-Pexport_edition=" + edition.to_lower());
  2996. copy_args.push_back("-Pexport_build_type=" + build_type.to_lower());
  2997. String export_format_arg = export_format == EXPORT_FORMAT_AAB ? "aab" : "apk";
  2998. copy_args.push_back("-Pexport_format=" + export_format_arg);
  2999. String export_filename = p_path.get_file();
  3000. String export_path = p_path.get_base_dir();
  3001. if (export_path.is_relative_path()) {
  3002. export_path = OS::get_singleton()->get_resource_dir().path_join(export_path);
  3003. }
  3004. export_path = ProjectSettings::get_singleton()->globalize_path(export_path).simplify_path();
  3005. copy_args.push_back("-Pexport_path=file:" + export_path);
  3006. copy_args.push_back("-Pexport_filename=" + export_filename);
  3007. print_verbose("Copying Android binary using gradle command: " + String("\n") + build_command + " " + join_list(copy_args, String(" ")));
  3008. String copy_binary_output;
  3009. int copy_result = EditorNode::get_singleton()->execute_and_show_output(TTR("Moving output"), build_command, copy_args, true, false, &copy_binary_output);
  3010. if (copy_result != 0) {
  3011. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Unable to copy and rename export file:") + "\n\n" + copy_binary_output);
  3012. return ERR_CANT_CREATE;
  3013. } else {
  3014. print_verbose(copy_binary_output);
  3015. }
  3016. print_verbose("Successfully completed Android gradle build.");
  3017. return OK;
  3018. }
  3019. // This is the start of the Legacy build system
  3020. print_verbose("Starting legacy build system...");
  3021. if (p_debug) {
  3022. src_apk = p_preset->get("custom_template/debug");
  3023. } else {
  3024. src_apk = p_preset->get("custom_template/release");
  3025. }
  3026. src_apk = src_apk.strip_edges();
  3027. if (src_apk.is_empty()) {
  3028. if (p_debug) {
  3029. src_apk = find_export_template("android_debug.apk");
  3030. } else {
  3031. src_apk = find_export_template("android_release.apk");
  3032. }
  3033. if (src_apk.is_empty()) {
  3034. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("%s export template not found: \"%s\"."), (p_debug ? "Debug" : "Release"), src_apk));
  3035. return ERR_FILE_NOT_FOUND;
  3036. }
  3037. }
  3038. Ref<FileAccess> io_fa;
  3039. zlib_filefunc_def io = zipio_create_io(&io_fa);
  3040. if (ep.step(TTR("Creating APK..."), 0)) {
  3041. return ERR_SKIP;
  3042. }
  3043. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  3044. if (!pkg) {
  3045. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not find template APK to export: \"%s\"."), src_apk));
  3046. return ERR_FILE_NOT_FOUND;
  3047. }
  3048. int ret = unzGoToFirstFile(pkg);
  3049. Ref<FileAccess> io2_fa;
  3050. zlib_filefunc_def io2 = zipio_create_io(&io2_fa);
  3051. String tmp_unaligned_path = EditorPaths::get_singleton()->get_temp_dir().path_join("tmpexport-unaligned." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  3052. #define CLEANUP_AND_RETURN(m_err) \
  3053. { \
  3054. DirAccess::remove_file_or_error(tmp_unaligned_path); \
  3055. return m_err; \
  3056. } \
  3057. ((void)0)
  3058. zipFile unaligned_apk = zipOpen2(tmp_unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  3059. String cmdline = p_preset->get("command_line/extra_args");
  3060. String version_name = p_preset->get_version("version/name");
  3061. String package_name = p_preset->get("package/unique_name");
  3062. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  3063. Vector<ABI> invalid_abis(enabled_abis);
  3064. //To temporarily store icon xml data.
  3065. Vector<uint8_t> themed_icon_xml_data;
  3066. int icon_xml_compression_method = -1;
  3067. while (ret == UNZ_OK) {
  3068. //get filename
  3069. unz_file_info info;
  3070. char fname[16384];
  3071. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  3072. if (ret != UNZ_OK) {
  3073. break;
  3074. }
  3075. bool skip = false;
  3076. String file = String::utf8(fname);
  3077. Vector<uint8_t> data;
  3078. data.resize(info.uncompressed_size);
  3079. //read
  3080. unzOpenCurrentFile(pkg);
  3081. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  3082. unzCloseCurrentFile(pkg);
  3083. //write
  3084. if (file == "AndroidManifest.xml") {
  3085. _fix_manifest(p_preset, data, p_give_internet);
  3086. }
  3087. if (file == "resources.arsc") {
  3088. _fix_resources(p_preset, data);
  3089. }
  3090. if (file == THEMED_ICON_XML_PATH) {
  3091. // Store themed_icon.xml data.
  3092. themed_icon_xml_data = data;
  3093. skip = true;
  3094. }
  3095. if (file == ICON_XML_PATH) {
  3096. if (monochrome.is_valid() && !monochrome->is_empty()) {
  3097. // Defer processing of icon.xml until after themed_icon.xml is read.
  3098. icon_xml_compression_method = info.compression_method;
  3099. skip = true;
  3100. }
  3101. }
  3102. if (file.ends_with(".png") && file.contains("mipmap")) {
  3103. for (int i = 0; i < ICON_DENSITIES_COUNT; ++i) {
  3104. if (main_image.is_valid() && !main_image->is_empty()) {
  3105. if (file == LAUNCHER_ICONS[i].export_path) {
  3106. _process_launcher_icons(file, main_image, LAUNCHER_ICONS[i].dimensions, data);
  3107. }
  3108. }
  3109. if (foreground.is_valid() && !foreground->is_empty()) {
  3110. if (file == LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path) {
  3111. _process_launcher_icons(file, foreground, LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].dimensions, data);
  3112. }
  3113. }
  3114. if (background.is_valid() && !background->is_empty()) {
  3115. if (file == LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path) {
  3116. _process_launcher_icons(file, background, LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].dimensions, data);
  3117. }
  3118. }
  3119. if (monochrome.is_valid() && !monochrome->is_empty()) {
  3120. if (file == LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path) {
  3121. _process_launcher_icons(file, monochrome, LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].dimensions, data);
  3122. }
  3123. }
  3124. }
  3125. }
  3126. if (file.ends_with(".so")) {
  3127. bool enabled = false;
  3128. for (int i = 0; i < enabled_abis.size(); ++i) {
  3129. if (file.begins_with("lib/" + enabled_abis[i].abi + "/")) {
  3130. invalid_abis.erase(enabled_abis[i]);
  3131. enabled = true;
  3132. break;
  3133. }
  3134. }
  3135. if (!enabled) {
  3136. skip = true;
  3137. }
  3138. }
  3139. if (file.begins_with("META-INF") && should_sign) {
  3140. skip = true;
  3141. }
  3142. if (!skip) {
  3143. print_line("ADDING: " + file);
  3144. // Respect decision on compression made by AAPT for the export template
  3145. const bool uncompressed = info.compression_method == 0;
  3146. zip_fileinfo zipfi = get_zip_fileinfo();
  3147. zipOpenNewFileInZip(unaligned_apk,
  3148. file.utf8().get_data(),
  3149. &zipfi,
  3150. nullptr,
  3151. 0,
  3152. nullptr,
  3153. 0,
  3154. nullptr,
  3155. uncompressed ? 0 : Z_DEFLATED,
  3156. Z_DEFAULT_COMPRESSION);
  3157. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  3158. zipCloseFileInZip(unaligned_apk);
  3159. }
  3160. ret = unzGoToNextFile(pkg);
  3161. }
  3162. // Process deferred icon.xml and replace it's data with themed_icon.xml.
  3163. if (monochrome.is_valid() && !monochrome->is_empty()) {
  3164. print_line("ADDING: " + ICON_XML_PATH + " (replacing with themed_icon.xml data)");
  3165. const bool uncompressed = icon_xml_compression_method == 0;
  3166. zip_fileinfo zipfi = get_zip_fileinfo();
  3167. zipOpenNewFileInZip(unaligned_apk,
  3168. ICON_XML_PATH.utf8().get_data(),
  3169. &zipfi,
  3170. nullptr,
  3171. 0,
  3172. nullptr,
  3173. 0,
  3174. nullptr,
  3175. uncompressed ? 0 : Z_DEFLATED,
  3176. Z_DEFAULT_COMPRESSION);
  3177. zipWriteInFileInZip(unaligned_apk, themed_icon_xml_data.ptr(), themed_icon_xml_data.size());
  3178. zipCloseFileInZip(unaligned_apk);
  3179. }
  3180. if (!invalid_abis.is_empty()) {
  3181. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Missing libraries in the export template for the selected architectures: %s. Please build a template with all required libraries, or uncheck the missing architectures in the export preset."), join_abis(invalid_abis, ", ", false)));
  3182. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  3183. }
  3184. if (ep.step(TTR("Adding files..."), 1)) {
  3185. CLEANUP_AND_RETURN(ERR_SKIP);
  3186. }
  3187. err = OK;
  3188. if (p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  3189. APKExportData ed;
  3190. ed.ep = &ep;
  3191. ed.apk = unaligned_apk;
  3192. err = export_project_files(p_preset, p_debug, ignore_apk_file, nullptr, &ed, save_apk_so);
  3193. } else {
  3194. if (apk_expansion) {
  3195. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  3196. if (err != OK) {
  3197. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not write expansion package file!"));
  3198. return err;
  3199. }
  3200. } else {
  3201. APKExportData ed;
  3202. ed.ep = &ep;
  3203. ed.apk = unaligned_apk;
  3204. err = export_project_files(p_preset, p_debug, save_apk_file, nullptr, &ed, save_apk_so);
  3205. }
  3206. }
  3207. if (err != OK) {
  3208. unzClose(pkg);
  3209. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not export project files.")));
  3210. CLEANUP_AND_RETURN(ERR_SKIP);
  3211. }
  3212. zip_fileinfo zipfi = get_zip_fileinfo();
  3213. zipOpenNewFileInZip(unaligned_apk,
  3214. "assets/_cl_",
  3215. &zipfi,
  3216. nullptr,
  3217. 0,
  3218. nullptr,
  3219. 0,
  3220. nullptr,
  3221. 0, // No compress (little size gain and potentially slower startup)
  3222. Z_DEFAULT_COMPRESSION);
  3223. zipWriteInFileInZip(unaligned_apk, command_line_flags.ptr(), command_line_flags.size());
  3224. zipCloseFileInZip(unaligned_apk);
  3225. zipClose(unaligned_apk, nullptr);
  3226. unzClose(pkg);
  3227. // Let's zip-align (must be done before signing)
  3228. static const int ZIP_ALIGNMENT = 4;
  3229. // If we're not signing the apk, then the next step should be the last.
  3230. const int next_step = should_sign ? 103 : 105;
  3231. if (ep.step(TTR("Aligning APK..."), next_step)) {
  3232. CLEANUP_AND_RETURN(ERR_SKIP);
  3233. }
  3234. unzFile tmp_unaligned = unzOpen2(tmp_unaligned_path.utf8().get_data(), &io);
  3235. if (!tmp_unaligned) {
  3236. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not unzip temporary unaligned APK.")));
  3237. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  3238. }
  3239. ret = unzGoToFirstFile(tmp_unaligned);
  3240. io2 = zipio_create_io(&io2_fa);
  3241. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  3242. // Take files from the unaligned APK and write them out to the aligned one
  3243. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  3244. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  3245. int bias = 0;
  3246. while (ret == UNZ_OK) {
  3247. unz_file_info info;
  3248. memset(&info, 0, sizeof(info));
  3249. char fname[16384];
  3250. char extra[16384];
  3251. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, nullptr, 0);
  3252. if (ret != UNZ_OK) {
  3253. break;
  3254. }
  3255. String file = String::utf8(fname);
  3256. Vector<uint8_t> data;
  3257. data.resize(info.compressed_size);
  3258. // read
  3259. int method, level;
  3260. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  3261. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  3262. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  3263. unzCloseCurrentFile(tmp_unaligned);
  3264. // align
  3265. int padding = 0;
  3266. if (!info.compression_method) {
  3267. // Uncompressed file => Align
  3268. long new_offset = file_offset + bias;
  3269. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  3270. }
  3271. memset(extra + info.size_file_extra, 0, padding);
  3272. zip_fileinfo fileinfo = get_zip_fileinfo();
  3273. zipOpenNewFileInZip2(final_apk,
  3274. file.utf8().get_data(),
  3275. &fileinfo,
  3276. extra,
  3277. info.size_file_extra + padding,
  3278. nullptr,
  3279. 0,
  3280. nullptr,
  3281. method,
  3282. level,
  3283. 1); // raw write
  3284. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  3285. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  3286. bias += padding;
  3287. ret = unzGoToNextFile(tmp_unaligned);
  3288. }
  3289. zipClose(final_apk, nullptr);
  3290. unzClose(tmp_unaligned);
  3291. if (should_sign) {
  3292. // Signing must be done last as any additional modifications to the
  3293. // file will invalidate the signature.
  3294. err = sign_apk(p_preset, p_debug, p_path, ep);
  3295. if (err != OK) {
  3296. // Message is supplied by the subroutine method.
  3297. CLEANUP_AND_RETURN(err);
  3298. }
  3299. }
  3300. CLEANUP_AND_RETURN(OK);
  3301. }
  3302. void EditorExportPlatformAndroid::get_platform_features(List<String> *r_features) const {
  3303. r_features->push_back("mobile");
  3304. r_features->push_back("android");
  3305. }
  3306. void EditorExportPlatformAndroid::resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, HashSet<String> &p_features) {
  3307. }
  3308. EditorExportPlatformAndroid::EditorExportPlatformAndroid() {
  3309. if (EditorNode::get_singleton()) {
  3310. Ref<Image> img = memnew(Image);
  3311. const bool upsample = !Math::is_equal_approx(Math::round(EDSCALE), EDSCALE);
  3312. ImageLoaderSVG::create_image_from_string(img, _android_logo_svg, EDSCALE, upsample, false);
  3313. logo = ImageTexture::create_from_image(img);
  3314. ImageLoaderSVG::create_image_from_string(img, _android_run_icon_svg, EDSCALE, upsample, false);
  3315. run_icon = ImageTexture::create_from_image(img);
  3316. devices_changed.set();
  3317. #ifndef DISABLE_DEPRECATED
  3318. android_plugins_changed.set();
  3319. #endif // DISABLE_DEPRECATED
  3320. #ifndef ANDROID_ENABLED
  3321. _create_editor_debug_keystore_if_needed();
  3322. _update_preset_status();
  3323. check_for_changes_thread.start(_check_for_changes_poll_thread, this);
  3324. #endif
  3325. }
  3326. }
  3327. EditorExportPlatformAndroid::~EditorExportPlatformAndroid() {
  3328. #ifndef ANDROID_ENABLED
  3329. quit_request.set();
  3330. if (check_for_changes_thread.is_started()) {
  3331. check_for_changes_thread.wait_to_finish();
  3332. }
  3333. #endif
  3334. }