export_plugin.cpp 166 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351
  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 "logo_svg.gen.h"
  32. #include "run_icon_svg.gen.h"
  33. #include "core/io/dir_access.h"
  34. #include "core/io/file_access.h"
  35. #include "core/io/image_loader.h"
  36. #include "core/io/json.h"
  37. #include "core/io/marshalls.h"
  38. #include "core/version.h"
  39. #include "editor/editor_log.h"
  40. #include "editor/editor_node.h"
  41. #include "editor/editor_string_names.h"
  42. #include "editor/export/export_template_manager.h"
  43. #include "editor/file_system/editor_paths.h"
  44. #include "editor/import/resource_importer_texture_settings.h"
  45. #include "editor/settings/editor_settings.h"
  46. #include "editor/themes/editor_scale.h"
  47. #include "main/splash.gen.h"
  48. #include "scene/resources/image_texture.h"
  49. #include "modules/modules_enabled.gen.h" // For mono.
  50. #include "modules/svg/image_loader_svg.h"
  51. #ifdef MODULE_MONO_ENABLED
  52. #include "modules/mono/utils/path_utils.h"
  53. #endif
  54. #ifdef ANDROID_ENABLED
  55. #include "../os_android.h"
  56. #endif
  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/src/main/java/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.webp", 192 },
  231. { "res/mipmap-xxhdpi-v4/icon.webp", 144 },
  232. { "res/mipmap-xhdpi-v4/icon.webp", 96 },
  233. { "res/mipmap-hdpi-v4/icon.webp", 72 },
  234. { "res/mipmap-mdpi-v4/icon.webp", 48 },
  235. { "res/mipmap/icon.webp", 192 }
  236. };
  237. static const LauncherIcon LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[ICON_DENSITIES_COUNT] = {
  238. { "res/mipmap-xxxhdpi-v4/icon_foreground.webp", 432 },
  239. { "res/mipmap-xxhdpi-v4/icon_foreground.webp", 324 },
  240. { "res/mipmap-xhdpi-v4/icon_foreground.webp", 216 },
  241. { "res/mipmap-hdpi-v4/icon_foreground.webp", 162 },
  242. { "res/mipmap-mdpi-v4/icon_foreground.webp", 108 },
  243. { "res/mipmap/icon_foreground.webp", 432 }
  244. };
  245. static const LauncherIcon LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[ICON_DENSITIES_COUNT] = {
  246. { "res/mipmap-xxxhdpi-v4/icon_background.webp", 432 },
  247. { "res/mipmap-xxhdpi-v4/icon_background.webp", 324 },
  248. { "res/mipmap-xhdpi-v4/icon_background.webp", 216 },
  249. { "res/mipmap-hdpi-v4/icon_background.webp", 162 },
  250. { "res/mipmap-mdpi-v4/icon_background.webp", 108 },
  251. { "res/mipmap/icon_background.webp", 432 }
  252. };
  253. static const LauncherIcon LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[ICON_DENSITIES_COUNT] = {
  254. { "res/mipmap-xxxhdpi-v4/icon_monochrome.webp", 432 },
  255. { "res/mipmap-xxhdpi-v4/icon_monochrome.webp", 324 },
  256. { "res/mipmap-xhdpi-v4/icon_monochrome.webp", 216 },
  257. { "res/mipmap-hdpi-v4/icon_monochrome.webp", 162 },
  258. { "res/mipmap-mdpi-v4/icon_monochrome.webp", 108 },
  259. { "res/mipmap/icon_monochrome.webp", 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 = "src/main/assets";
  264. static const char *AAB_ASSETS_DIRECTORY = "assetPackInstallTime/src/main/assets";
  265. static const int DEFAULT_MIN_SDK_VERSION = 24; // Should match the value in 'platform/android/java/app/config.gradle#minSdk'
  266. static const int DEFAULT_TARGET_SDK_VERSION = 35; // Should match the value in 'platform/android/java/app/config.gradle#targetSdk'
  267. #ifndef ANDROID_ENABLED
  268. void EditorExportPlatformAndroid::_check_for_changes_poll_thread(void *ud) {
  269. EditorExportPlatformAndroid *ea = static_cast<EditorExportPlatformAndroid *>(ud);
  270. while (!ea->quit_request.is_set()) {
  271. #ifndef DISABLE_DEPRECATED
  272. // Check for android plugins updates
  273. {
  274. // Nothing to do if we already know the plugins have changed.
  275. if (!ea->android_plugins_changed.is_set()) {
  276. Vector<PluginConfigAndroid> loaded_plugins = get_plugins();
  277. MutexLock lock(ea->android_plugins_lock);
  278. if (ea->android_plugins.size() != loaded_plugins.size()) {
  279. ea->android_plugins_changed.set();
  280. } else {
  281. for (int i = 0; i < ea->android_plugins.size(); i++) {
  282. if (ea->android_plugins[i].name != loaded_plugins[i].name) {
  283. ea->android_plugins_changed.set();
  284. break;
  285. }
  286. }
  287. }
  288. if (ea->android_plugins_changed.is_set()) {
  289. ea->android_plugins = loaded_plugins;
  290. }
  291. }
  292. }
  293. #endif // DISABLE_DEPRECATED
  294. // Check for devices updates
  295. String adb = get_adb_path();
  296. // adb.exe was locking the editor_doc_cache file on startup. Adding a check for is_editor_ready provides just enough time
  297. // to regenerate the doc cache.
  298. if (ea->has_runnable_preset.is_set() && FileAccess::exists(adb) && EditorNode::get_singleton()->is_editor_ready()) {
  299. String devices;
  300. List<String> args;
  301. args.push_back("devices");
  302. int ec;
  303. OS::get_singleton()->execute(adb, args, &devices, &ec);
  304. Vector<String> ds = devices.split("\n");
  305. Vector<String> ldevices;
  306. for (int i = 1; i < ds.size(); i++) {
  307. String d = ds[i];
  308. int dpos = d.find("device");
  309. if (dpos == -1) {
  310. continue;
  311. }
  312. d = d.substr(0, dpos).strip_edges();
  313. ldevices.push_back(d);
  314. }
  315. MutexLock lock(ea->device_lock);
  316. bool different = false;
  317. if (ea->devices.size() != ldevices.size()) {
  318. different = true;
  319. } else {
  320. for (int i = 0; i < ea->devices.size(); i++) {
  321. if (ea->devices[i].id != ldevices[i]) {
  322. different = true;
  323. break;
  324. }
  325. }
  326. }
  327. if (different) {
  328. Vector<Device> ndevices;
  329. for (int i = 0; i < ldevices.size(); i++) {
  330. Device d;
  331. d.id = ldevices[i];
  332. for (int j = 0; j < ea->devices.size(); j++) {
  333. if (ea->devices[j].id == ldevices[i]) {
  334. d.description = ea->devices[j].description;
  335. d.name = ea->devices[j].name;
  336. d.api_level = ea->devices[j].api_level;
  337. }
  338. }
  339. if (d.description.is_empty()) {
  340. //in the oven, request!
  341. args.clear();
  342. args.push_back("-s");
  343. args.push_back(d.id);
  344. args.push_back("shell");
  345. args.push_back("getprop");
  346. int ec2;
  347. String dp;
  348. OS::get_singleton()->execute(adb, args, &dp, &ec2);
  349. Vector<String> props = dp.split("\n");
  350. String vendor;
  351. String device;
  352. d.description = "Device ID: " + d.id + "\n";
  353. d.api_level = 0;
  354. for (int j = 0; j < props.size(); j++) {
  355. // got information by `shell cat /system/build.prop` before and its format is "property=value"
  356. // it's now changed to use `shell getporp` because of permission issue with Android 8.0 and above
  357. // its format is "[property]: [value]" so changed it as like build.prop
  358. String p = props[j];
  359. p = p.replace("]: ", "=");
  360. p = p.remove_chars("[]");
  361. if (p.begins_with("ro.product.model=")) {
  362. device = p.get_slicec('=', 1).strip_edges();
  363. } else if (p.begins_with("ro.product.brand=")) {
  364. vendor = p.get_slicec('=', 1).strip_edges().capitalize();
  365. } else if (p.begins_with("ro.build.display.id=")) {
  366. d.description += "Build: " + p.get_slicec('=', 1).strip_edges() + "\n";
  367. } else if (p.begins_with("ro.build.version.release=")) {
  368. d.description += "Release: " + p.get_slicec('=', 1).strip_edges() + "\n";
  369. } else if (p.begins_with("ro.build.version.sdk=")) {
  370. d.api_level = p.get_slicec('=', 1).to_int();
  371. } else if (p.begins_with("ro.product.cpu.abi=")) {
  372. d.architecture = p.get_slicec('=', 1).strip_edges();
  373. d.description += "CPU: " + d.architecture + "\n";
  374. } else if (p.begins_with("ro.product.manufacturer=")) {
  375. d.description += "Manufacturer: " + p.get_slicec('=', 1).strip_edges() + "\n";
  376. } else if (p.begins_with("ro.board.platform=")) {
  377. d.description += "Chipset: " + p.get_slicec('=', 1).strip_edges() + "\n";
  378. } else if (p.begins_with("ro.opengles.version=")) {
  379. uint32_t opengl = p.get_slicec('=', 1).to_int();
  380. d.description += "OpenGL: " + itos(opengl >> 16) + "." + itos((opengl >> 8) & 0xFF) + "." + itos((opengl) & 0xFF) + "\n";
  381. }
  382. }
  383. d.name = vendor + " " + device;
  384. if (device.is_empty()) {
  385. continue;
  386. }
  387. }
  388. ndevices.push_back(d);
  389. }
  390. ea->devices = ndevices;
  391. ea->devices_changed.set();
  392. }
  393. }
  394. uint64_t sleep = 200;
  395. uint64_t wait = 3000000;
  396. uint64_t time = OS::get_singleton()->get_ticks_usec();
  397. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  398. OS::get_singleton()->delay_usec(1000 * sleep);
  399. if (ea->quit_request.is_set()) {
  400. break;
  401. }
  402. }
  403. }
  404. if (ea->has_runnable_preset.is_set() && EDITOR_GET("export/android/shutdown_adb_on_exit")) {
  405. String adb = get_adb_path();
  406. if (!FileAccess::exists(adb)) {
  407. return; //adb not configured
  408. }
  409. List<String> args;
  410. args.push_back("kill-server");
  411. OS::get_singleton()->execute(adb, args);
  412. }
  413. }
  414. void EditorExportPlatformAndroid::_update_preset_status() {
  415. const int preset_count = EditorExport::get_singleton()->get_export_preset_count();
  416. bool has_runnable = false;
  417. for (int i = 0; i < preset_count; i++) {
  418. const Ref<EditorExportPreset> &preset = EditorExport::get_singleton()->get_export_preset(i);
  419. if (preset->get_platform() == this && preset->is_runnable()) {
  420. has_runnable = true;
  421. break;
  422. }
  423. }
  424. if (has_runnable) {
  425. has_runnable_preset.set();
  426. } else {
  427. has_runnable_preset.clear();
  428. }
  429. devices_changed.set();
  430. }
  431. #endif
  432. String EditorExportPlatformAndroid::get_project_name(const Ref<EditorExportPreset> &p_preset, const String &p_name) const {
  433. String aname;
  434. if (!p_name.is_empty()) {
  435. aname = p_name;
  436. } else {
  437. aname = get_project_setting(p_preset, "application/config/name");
  438. }
  439. if (aname.is_empty()) {
  440. aname = GODOT_VERSION_NAME;
  441. }
  442. return aname;
  443. }
  444. String EditorExportPlatformAndroid::get_package_name(const Ref<EditorExportPreset> &p_preset, const String &p_package) const {
  445. String pname = p_package;
  446. String name = get_valid_basename(p_preset);
  447. pname = pname.replace("$genname", name);
  448. return pname;
  449. }
  450. // Returns the project name without invalid characters
  451. // or the "noname" string if all characters are invalid.
  452. String EditorExportPlatformAndroid::get_valid_basename(const Ref<EditorExportPreset> &p_preset) const {
  453. String basename = get_project_setting(p_preset, "application/config/name");
  454. basename = basename.to_lower();
  455. String name;
  456. bool first = true;
  457. for (int i = 0; i < basename.length(); i++) {
  458. char32_t c = basename[i];
  459. if (is_digit(c) && first) {
  460. continue;
  461. }
  462. if (is_ascii_identifier_char(c)) {
  463. name += String::chr(c);
  464. first = false;
  465. }
  466. }
  467. if (name.is_empty()) {
  468. name = "noname";
  469. }
  470. return name;
  471. }
  472. String EditorExportPlatformAndroid::get_assets_directory(const Ref<EditorExportPreset> &p_preset, int p_export_format) const {
  473. String gradle_build_directory = ExportTemplateManager::get_android_build_directory(p_preset);
  474. return gradle_build_directory.path_join(p_export_format == EXPORT_FORMAT_AAB ? AAB_ASSETS_DIRECTORY : APK_ASSETS_DIRECTORY);
  475. }
  476. bool EditorExportPlatformAndroid::is_package_name_valid(const Ref<EditorExportPreset> &p_preset, const String &p_package, String *r_error) const {
  477. String pname = get_package_name(p_preset, p_package);
  478. if (pname.length() == 0) {
  479. if (r_error) {
  480. *r_error = TTR("Package name is missing.");
  481. }
  482. return false;
  483. }
  484. int segments = 0;
  485. bool first = true;
  486. for (int i = 0; i < pname.length(); i++) {
  487. char32_t c = pname[i];
  488. if (first && c == '.') {
  489. if (r_error) {
  490. *r_error = TTR("Package segments must be of non-zero length.");
  491. }
  492. return false;
  493. }
  494. if (c == '.') {
  495. segments++;
  496. first = true;
  497. continue;
  498. }
  499. if (!is_ascii_identifier_char(c)) {
  500. if (r_error) {
  501. *r_error = vformat(TTR("The character '%s' is not allowed in Android application package names."), String::chr(c));
  502. }
  503. return false;
  504. }
  505. if (first && is_digit(c)) {
  506. if (r_error) {
  507. *r_error = TTR("A digit cannot be the first character in a package segment.");
  508. }
  509. return false;
  510. }
  511. if (first && is_underscore(c)) {
  512. if (r_error) {
  513. *r_error = vformat(TTR("The character '%s' cannot be the first character in a package segment."), String::chr(c));
  514. }
  515. return false;
  516. }
  517. first = false;
  518. }
  519. if (segments == 0) {
  520. if (r_error) {
  521. *r_error = TTR("The package must have at least one '.' separator.");
  522. }
  523. return false;
  524. }
  525. if (first) {
  526. if (r_error) {
  527. *r_error = TTR("Package segments must be of non-zero length.");
  528. }
  529. return false;
  530. }
  531. return true;
  532. }
  533. bool EditorExportPlatformAndroid::is_project_name_valid(const Ref<EditorExportPreset> &p_preset) const {
  534. // Get the original project name and convert to lowercase.
  535. String basename = get_project_setting(p_preset, "application/config/name");
  536. basename = basename.to_lower();
  537. // Check if there are invalid characters.
  538. if (basename != get_valid_basename(p_preset)) {
  539. return false;
  540. }
  541. return true;
  542. }
  543. bool EditorExportPlatformAndroid::_should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  544. /*
  545. * By not compressing files with little or no benefit in doing so,
  546. * a performance gain is expected at runtime. Moreover, if the APK is
  547. * zip-aligned, assets stored as they are can be efficiently read by
  548. * Android by memory-mapping them.
  549. */
  550. // -- Unconditional uncompress to mimic AAPT plus some other
  551. static const char *unconditional_compress_ext[] = {
  552. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  553. // These formats are already compressed, or don't compress well:
  554. ".jpg", ".jpeg", ".png", ".gif",
  555. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  556. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  557. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  558. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  559. ".amr", ".awb", ".wma", ".wmv",
  560. // Godot-specific:
  561. ".webp", // Same reasoning as .png
  562. ".cfb", // Don't let small config files slow-down startup
  563. ".scn", // Binary scenes are usually already compressed
  564. ".ctex", // Streamable textures are usually already compressed
  565. ".pck", // Pack.
  566. // Trailer for easier processing
  567. nullptr
  568. };
  569. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  570. if (p_path.to_lower().ends_with(String(*ext))) {
  571. return false;
  572. }
  573. }
  574. // -- Compressed resource?
  575. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  576. // Already compressed
  577. return false;
  578. }
  579. // --- TODO: Decide on texture resources according to their image compression setting
  580. return true;
  581. }
  582. zip_fileinfo EditorExportPlatformAndroid::get_zip_fileinfo() {
  583. OS::DateTime dt = OS::get_singleton()->get_datetime();
  584. zip_fileinfo zipfi;
  585. zipfi.tmz_date.tm_year = dt.year;
  586. zipfi.tmz_date.tm_mon = dt.month - 1; // tm_mon is zero indexed
  587. zipfi.tmz_date.tm_mday = dt.day;
  588. zipfi.tmz_date.tm_hour = dt.hour;
  589. zipfi.tmz_date.tm_min = dt.minute;
  590. zipfi.tmz_date.tm_sec = dt.second;
  591. zipfi.dosDate = 0;
  592. zipfi.external_fa = 0;
  593. zipfi.internal_fa = 0;
  594. return zipfi;
  595. }
  596. Vector<EditorExportPlatformAndroid::ABI> EditorExportPlatformAndroid::get_abis() {
  597. // Should have the same order and size as get_archs.
  598. Vector<ABI> abis;
  599. abis.push_back(ABI("armeabi-v7a", "arm32"));
  600. abis.push_back(ABI("arm64-v8a", "arm64"));
  601. abis.push_back(ABI("x86", "x86_32"));
  602. abis.push_back(ABI("x86_64", "x86_64"));
  603. return abis;
  604. }
  605. #ifndef DISABLE_DEPRECATED
  606. /// List the gdap files in the directory specified by the p_path parameter.
  607. Vector<String> EditorExportPlatformAndroid::list_gdap_files(const String &p_path) {
  608. Vector<String> dir_files;
  609. Ref<DirAccess> da = DirAccess::open(p_path);
  610. if (da.is_valid()) {
  611. da->list_dir_begin();
  612. while (true) {
  613. String file = da->get_next();
  614. if (file.is_empty()) {
  615. break;
  616. }
  617. if (da->current_is_dir() || da->current_is_hidden()) {
  618. continue;
  619. }
  620. if (file.ends_with(PluginConfigAndroid::PLUGIN_CONFIG_EXT)) {
  621. dir_files.push_back(file);
  622. }
  623. }
  624. da->list_dir_end();
  625. }
  626. return dir_files;
  627. }
  628. Vector<PluginConfigAndroid> EditorExportPlatformAndroid::get_plugins() {
  629. Vector<PluginConfigAndroid> loaded_plugins;
  630. String plugins_dir = ProjectSettings::get_singleton()->get_resource_path().path_join("android/plugins");
  631. // Add the prebuilt plugins
  632. loaded_plugins.append_array(PluginConfigAndroid::get_prebuilt_plugins(plugins_dir));
  633. if (DirAccess::exists(plugins_dir)) {
  634. Vector<String> plugins_filenames = list_gdap_files(plugins_dir);
  635. if (!plugins_filenames.is_empty()) {
  636. Ref<ConfigFile> config_file;
  637. config_file.instantiate();
  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, Z_NO_COMPRESSION);
  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. String simplified_path = p_path.simplify_path();
  715. if (simplified_path.begins_with("uid://")) {
  716. simplified_path = ResourceUID::uid_to_path(simplified_path).simplify_path();
  717. print_verbose(vformat(R"(UID referenced exported file name "%s" was replaced with "%s".)", p_path, simplified_path));
  718. }
  719. Vector<uint8_t> enc_data;
  720. EditorExportPlatform::SavedData sd;
  721. Error err = _store_temp_file(simplified_path, p_data, p_enc_in_filters, p_enc_ex_filters, p_key, p_seed, enc_data, sd);
  722. if (err != OK) {
  723. return err;
  724. }
  725. const String dst_path = String("assets/") + simplified_path.trim_prefix("res://");
  726. print_verbose("Saving project files from " + simplified_path + " into " + dst_path);
  727. store_in_apk(ed, dst_path, enc_data, _should_compress_asset(simplified_path, enc_data) ? Z_DEFLATED : 0);
  728. ed->pd.file_ofs.push_back(sd);
  729. return OK;
  730. }
  731. 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) {
  732. return OK;
  733. }
  734. Error EditorExportPlatformAndroid::copy_gradle_so(void *p_userdata, const SharedObject &p_so) {
  735. ERR_FAIL_COND_V_MSG(!p_so.path.get_file().begins_with("lib"), FAILED,
  736. "Android .so file names must start with \"lib\", but got: " + p_so.path);
  737. Vector<ABI> abis = get_abis();
  738. CustomExportData *export_data = static_cast<CustomExportData *>(p_userdata);
  739. bool exported = false;
  740. for (int i = 0; i < p_so.tags.size(); ++i) {
  741. int abi_index = -1;
  742. for (int j = 0; j < abis.size(); ++j) {
  743. if (abis[j].abi == p_so.tags[i] || abis[j].arch == p_so.tags[i]) {
  744. abi_index = j;
  745. break;
  746. }
  747. }
  748. if (abi_index != -1) {
  749. exported = true;
  750. String type = export_data->debug ? "debug" : "release";
  751. String abi = abis[abi_index].abi;
  752. String filename = p_so.path.get_file();
  753. String dst_path = export_data->libs_directory.path_join(type).path_join(abi).path_join(filename);
  754. Vector<uint8_t> data = FileAccess::get_file_as_bytes(p_so.path);
  755. print_verbose("Copying .so file from " + p_so.path + " to " + dst_path);
  756. Error err = store_file_at_path(dst_path, data);
  757. ERR_FAIL_COND_V_MSG(err, err, "Failed to copy .so file from " + p_so.path + " to " + dst_path);
  758. export_data->libs.push_back(dst_path);
  759. }
  760. }
  761. ERR_FAIL_COND_V_MSG(!exported, FAILED,
  762. "Cannot determine architecture for library \"" + p_so.path + "\". One of the supported architectures must be used as a tag:" + join_abis(abis, " ", true));
  763. return OK;
  764. }
  765. bool EditorExportPlatformAndroid::_has_read_write_storage_permission(const Vector<String> &p_permissions) {
  766. return p_permissions.has("android.permission.READ_EXTERNAL_STORAGE") || p_permissions.has("android.permission.WRITE_EXTERNAL_STORAGE");
  767. }
  768. bool EditorExportPlatformAndroid::_has_manage_external_storage_permission(const Vector<String> &p_permissions) {
  769. return p_permissions.has("android.permission.MANAGE_EXTERNAL_STORAGE");
  770. }
  771. bool EditorExportPlatformAndroid::_uses_vulkan(const Ref<EditorExportPreset> &p_preset) const {
  772. String rendering_method = get_project_setting(p_preset, "rendering/renderer/rendering_method.mobile");
  773. String rendering_driver = get_project_setting(p_preset, "rendering/rendering_device/driver.android");
  774. return (rendering_method == "forward_plus" || rendering_method == "mobile") && rendering_driver == "vulkan";
  775. }
  776. void EditorExportPlatformAndroid::_notification(int p_what) {
  777. #ifndef ANDROID_ENABLED
  778. switch (p_what) {
  779. case NOTIFICATION_POSTINITIALIZE: {
  780. if (EditorExport::get_singleton()) {
  781. EditorExport::get_singleton()->connect_presets_runnable_updated(callable_mp(this, &EditorExportPlatformAndroid::_update_preset_status));
  782. }
  783. } break;
  784. case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
  785. if (EditorSettings::get_singleton()->check_changed_settings_in_group("export/android")) {
  786. _create_editor_debug_keystore_if_needed();
  787. }
  788. } break;
  789. }
  790. #endif
  791. }
  792. void EditorExportPlatformAndroid::_create_editor_debug_keystore_if_needed() {
  793. // Check if we have a valid keytool path.
  794. String keytool_path = get_keytool_path();
  795. if (!FileAccess::exists(keytool_path)) {
  796. return;
  797. }
  798. // Check if the current editor debug keystore exists.
  799. String editor_debug_keystore = EDITOR_GET("export/android/debug_keystore");
  800. if (FileAccess::exists(editor_debug_keystore)) {
  801. return;
  802. }
  803. // Generate the debug keystore.
  804. String keystore_path = EditorPaths::get_singleton()->get_debug_keystore_path();
  805. String keystores_dir = keystore_path.get_base_dir();
  806. if (!DirAccess::exists(keystores_dir)) {
  807. Ref<DirAccess> dir_access = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  808. Error err = dir_access->make_dir_recursive(keystores_dir);
  809. if (err != OK) {
  810. WARN_PRINT(TTR("Error creating keystores directory:") + "\n" + keystores_dir);
  811. return;
  812. }
  813. }
  814. if (!FileAccess::exists(keystore_path)) {
  815. String output;
  816. List<String> args;
  817. args.push_back("-genkey");
  818. args.push_back("-keystore");
  819. args.push_back(keystore_path);
  820. args.push_back("-storepass");
  821. args.push_back("android");
  822. args.push_back("-alias");
  823. args.push_back(DEFAULT_ANDROID_KEYSTORE_DEBUG_USER);
  824. args.push_back("-keypass");
  825. args.push_back(DEFAULT_ANDROID_KEYSTORE_DEBUG_PASSWORD);
  826. args.push_back("-keyalg");
  827. args.push_back("RSA");
  828. args.push_back("-keysize");
  829. args.push_back("2048");
  830. args.push_back("-validity");
  831. args.push_back("10000");
  832. args.push_back("-dname");
  833. args.push_back("cn=Godot, ou=Godot Engine, o=Stichting Godot, c=NL");
  834. Error error = OS::get_singleton()->execute(keytool_path, args, &output, nullptr, true);
  835. print_verbose(output);
  836. if (error != OK) {
  837. WARN_PRINT("Error: Unable to create debug keystore");
  838. return;
  839. }
  840. }
  841. // Update the editor settings.
  842. EditorSettings::get_singleton()->set("export/android/debug_keystore", keystore_path);
  843. EditorSettings::get_singleton()->set("export/android/debug_keystore_user", DEFAULT_ANDROID_KEYSTORE_DEBUG_USER);
  844. EditorSettings::get_singleton()->set("export/android/debug_keystore_pass", DEFAULT_ANDROID_KEYSTORE_DEBUG_PASSWORD);
  845. print_verbose("Updated editor debug keystore to " + keystore_path);
  846. }
  847. void EditorExportPlatformAndroid::_get_manifest_info(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, Vector<String> &r_permissions, Vector<FeatureInfo> &r_features, Vector<MetadataInfo> &r_metadata) {
  848. const char **aperms = ANDROID_PERMS;
  849. while (*aperms) {
  850. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  851. if (enabled) {
  852. r_permissions.push_back("android.permission." + String(*aperms));
  853. }
  854. aperms++;
  855. }
  856. PackedStringArray user_perms = p_preset->get("permissions/custom_permissions");
  857. for (int i = 0; i < user_perms.size(); i++) {
  858. String user_perm = user_perms[i].strip_edges();
  859. if (!user_perm.is_empty()) {
  860. r_permissions.push_back(user_perm);
  861. }
  862. }
  863. if (p_give_internet) {
  864. if (!r_permissions.has("android.permission.INTERNET")) {
  865. r_permissions.push_back("android.permission.INTERNET");
  866. }
  867. }
  868. if (_uses_vulkan(p_preset)) {
  869. // Require vulkan hardware level 1 support
  870. FeatureInfo vulkan_level = {
  871. "android.hardware.vulkan.level", // name
  872. false, // required
  873. "1" // version
  874. };
  875. r_features.append(vulkan_level);
  876. // Require vulkan version 1.0
  877. FeatureInfo vulkan_version = {
  878. "android.hardware.vulkan.version", // name
  879. true, // required
  880. "0x400003" // version - Encoded value for api version 1.0
  881. };
  882. r_features.append(vulkan_version);
  883. }
  884. MetadataInfo rendering_method_metadata = {
  885. "org.godotengine.rendering.method",
  886. p_preset->get_project_setting("rendering/renderer/rendering_method.mobile")
  887. };
  888. r_metadata.append(rendering_method_metadata);
  889. MetadataInfo editor_version_metadata = {
  890. "org.godotengine.editor.version",
  891. String(GODOT_VERSION_FULL_CONFIG)
  892. };
  893. r_metadata.append(editor_version_metadata);
  894. }
  895. void EditorExportPlatformAndroid::_write_tmp_manifest(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, bool p_debug) {
  896. print_verbose("Building temporary manifest...");
  897. String manifest_text =
  898. "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
  899. "<manifest xmlns:android=\"http://schemas.android.com/apk/res/android\"\n"
  900. " xmlns:tools=\"http://schemas.android.com/tools\">\n";
  901. manifest_text += _get_screen_sizes_tag(p_preset);
  902. manifest_text += _get_gles_tag();
  903. Vector<String> perms;
  904. Vector<FeatureInfo> features;
  905. Vector<MetadataInfo> manifest_metadata;
  906. _get_manifest_info(p_preset, p_give_internet, perms, features, manifest_metadata);
  907. for (int i = 0; i < perms.size(); i++) {
  908. String permission = perms.get(i);
  909. if (permission == "android.permission.WRITE_EXTERNAL_STORAGE" || (permission == "android.permission.READ_EXTERNAL_STORAGE" && _has_manage_external_storage_permission(perms))) {
  910. manifest_text += vformat(" <uses-permission android:name=\"%s\" android:maxSdkVersion=\"29\" />\n", permission);
  911. } else {
  912. manifest_text += vformat(" <uses-permission android:name=\"%s\" />\n", permission);
  913. }
  914. }
  915. for (int i = 0; i < features.size(); i++) {
  916. manifest_text += vformat(" <uses-feature tools:node=\"replace\" android:name=\"%s\" android:required=\"%s\" android:version=\"%s\" />\n", features[i].name, features[i].required, features[i].version);
  917. }
  918. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  919. for (int i = 0; i < export_plugins.size(); i++) {
  920. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  921. const String contents = export_plugins[i]->get_android_manifest_element_contents(Ref<EditorExportPlatform>(this), p_debug);
  922. if (!contents.is_empty()) {
  923. manifest_text += contents;
  924. manifest_text += "\n";
  925. }
  926. }
  927. }
  928. manifest_text += _get_application_tag(Ref<EditorExportPlatform>(this), p_preset, _has_read_write_storage_permission(perms), p_debug, manifest_metadata);
  929. manifest_text += "</manifest>\n";
  930. String manifest_path = ExportTemplateManager::get_android_build_directory(p_preset).path_join(vformat("src/%s/AndroidManifest.xml", (p_debug ? "debug" : "release")));
  931. print_verbose("Storing manifest into " + manifest_path + ": " + "\n" + manifest_text);
  932. store_string_at_path(manifest_path, manifest_text);
  933. }
  934. bool EditorExportPlatformAndroid::_is_transparency_allowed(const Ref<EditorExportPreset> &p_preset) const {
  935. return (bool)get_project_setting(p_preset, "display/window/per_pixel_transparency/allowed");
  936. }
  937. void EditorExportPlatformAndroid::_fix_themes_xml(const Ref<EditorExportPreset> &p_preset) {
  938. const String themes_xml_path = ExportTemplateManager::get_android_build_directory(p_preset).path_join("res/values/themes.xml");
  939. if (!FileAccess::exists(themes_xml_path)) {
  940. print_error("res/values/themes.xml does not exist.");
  941. return;
  942. }
  943. bool transparency_allowed = _is_transparency_allowed(p_preset);
  944. // Default/Reserved theme attributes.
  945. Dictionary main_theme_attributes;
  946. main_theme_attributes["android:windowSwipeToDismiss"] = bool_to_string(p_preset->get("gesture/swipe_to_dismiss"));
  947. main_theme_attributes["android:windowIsTranslucent"] = bool_to_string(transparency_allowed);
  948. if (transparency_allowed) {
  949. main_theme_attributes["android:windowBackground"] = "@android:color/transparent";
  950. } else {
  951. main_theme_attributes["android:windowBackground"] = "#" + p_preset->get("screen/background_color").operator Color().to_html(false);
  952. }
  953. Dictionary splash_theme_attributes;
  954. splash_theme_attributes["android:windowSplashScreenBackground"] = "@mipmap/icon_background";
  955. splash_theme_attributes["windowSplashScreenAnimatedIcon"] = "@mipmap/icon_foreground";
  956. splash_theme_attributes["postSplashScreenTheme"] = "@style/GodotAppMainTheme";
  957. splash_theme_attributes["android:windowIsTranslucent"] = bool_to_string(transparency_allowed);
  958. PackedStringArray reserved_splash_keys;
  959. reserved_splash_keys.append("postSplashScreenTheme");
  960. reserved_splash_keys.append("android:windowIsTranslucent");
  961. Dictionary custom_theme_attributes = p_preset->get("gradle_build/custom_theme_attributes");
  962. // Does not override default/reserved theme attributes; skips any duplicates from custom_theme_attributes.
  963. for (const Variant &k : custom_theme_attributes.keys()) {
  964. String key = k;
  965. String value = custom_theme_attributes[k];
  966. if (key.begins_with("[splash]")) {
  967. String splash_key = key.trim_prefix("[splash]");
  968. if (reserved_splash_keys.has(splash_key)) {
  969. WARN_PRINT(vformat("Skipped custom_theme_attribute '%s'; this is a reserved attribute configured via other export options or project settings.", splash_key));
  970. } else {
  971. splash_theme_attributes[splash_key] = value;
  972. }
  973. } else {
  974. if (main_theme_attributes.has(key)) {
  975. WARN_PRINT(vformat("Skipped custom_theme_attribute '%s'; this is a reserved attribute configured via other export options or project settings.", key));
  976. } else {
  977. main_theme_attributes[key] = value;
  978. }
  979. }
  980. }
  981. Ref<FileAccess> file = FileAccess::open(themes_xml_path, FileAccess::READ);
  982. PackedStringArray lines = file->get_as_text().split("\n");
  983. file->close();
  984. PackedStringArray new_lines;
  985. bool inside_main_theme = false;
  986. bool inside_splash_theme = false;
  987. for (int i = 0; i < lines.size(); i++) {
  988. String line = lines[i];
  989. if (line.contains("<style name=\"GodotAppMainTheme\"")) {
  990. inside_main_theme = true;
  991. new_lines.append(line);
  992. continue;
  993. }
  994. if (line.contains("<style name=\"GodotAppSplashTheme\"")) {
  995. inside_splash_theme = true;
  996. new_lines.append(line);
  997. continue;
  998. }
  999. // Inject GodotAppMainTheme attributes.
  1000. if (inside_main_theme && line.contains("</style>")) {
  1001. for (const Variant &attribute : main_theme_attributes.keys()) {
  1002. String value = main_theme_attributes[attribute];
  1003. String item_line = vformat(" <item name=\"%s\">%s</item>", attribute, value);
  1004. new_lines.append(item_line);
  1005. }
  1006. new_lines.append(line); // Add </style> in the end.
  1007. inside_main_theme = false;
  1008. continue;
  1009. }
  1010. // Inject GodotAppSplashTheme attributes.
  1011. if (inside_splash_theme && line.contains("</style>")) {
  1012. for (const Variant &attribute : splash_theme_attributes.keys()) {
  1013. String value = splash_theme_attributes[attribute];
  1014. String item_line = vformat(" <item name=\"%s\">%s</item>", attribute, value);
  1015. new_lines.append(item_line);
  1016. }
  1017. new_lines.append(line); // Add </style> in the end.
  1018. inside_splash_theme = false;
  1019. continue;
  1020. }
  1021. // Add all other lines unchanged.
  1022. if (!inside_main_theme && !inside_splash_theme) {
  1023. new_lines.append(line);
  1024. }
  1025. }
  1026. // Reconstruct the XML content from the modified lines.
  1027. String xml_content = String("\n").join(new_lines);
  1028. store_string_at_path(themes_xml_path, xml_content);
  1029. print_verbose("Successfully modified " + themes_xml_path + ": " + "\n" + xml_content);
  1030. }
  1031. void EditorExportPlatformAndroid::_fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  1032. // Leaving the unused types commented because looking these constants up
  1033. // again later would be annoying
  1034. // const int CHUNK_AXML_FILE = 0x00080003;
  1035. // const int CHUNK_RESOURCEIDS = 0x00080180;
  1036. const int CHUNK_STRINGS = 0x001C0001;
  1037. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  1038. const int CHUNK_XML_END_TAG = 0x00100103;
  1039. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  1040. const int CHUNK_XML_START_TAG = 0x00100102;
  1041. // const int CHUNK_XML_TEXT = 0x00100104;
  1042. const int UTF8_FLAG = 0x00000100;
  1043. Vector<String> string_table;
  1044. uint32_t ofs = 8;
  1045. uint32_t string_count = 0;
  1046. uint32_t string_flags = 0;
  1047. uint32_t string_data_offset = 0;
  1048. uint32_t string_table_begins = 0;
  1049. uint32_t string_table_ends = 0;
  1050. Vector<uint8_t> stable_extra;
  1051. String version_name = p_preset->get_version("version/name");
  1052. int version_code = p_preset->get("version/code");
  1053. String package_name = p_preset->get("package/unique_name");
  1054. const int screen_orientation =
  1055. _get_android_orientation_value(DisplayServer::ScreenOrientation(int(get_project_setting(p_preset, "display/window/handheld/orientation"))));
  1056. bool screen_support_small = p_preset->get("screen/support_small");
  1057. bool screen_support_normal = p_preset->get("screen/support_normal");
  1058. bool screen_support_large = p_preset->get("screen/support_large");
  1059. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  1060. bool backup_allowed = p_preset->get("user_data_backup/allow");
  1061. int app_category = p_preset->get("package/app_category");
  1062. bool retain_data_on_uninstall = p_preset->get("package/retain_data_on_uninstall");
  1063. bool exclude_from_recents = p_preset->get("package/exclude_from_recents");
  1064. bool is_resizeable = bool(get_project_setting(p_preset, "display/window/size/resizable"));
  1065. Vector<String> perms;
  1066. Vector<FeatureInfo> features;
  1067. Vector<MetadataInfo> manifest_metadata;
  1068. _get_manifest_info(p_preset, p_give_internet, perms, features, manifest_metadata);
  1069. bool has_read_write_storage_permission = _has_read_write_storage_permission(perms);
  1070. while (ofs < (uint32_t)p_manifest.size()) {
  1071. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  1072. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  1073. switch (chunk) {
  1074. case CHUNK_STRINGS: {
  1075. int iofs = ofs + 8;
  1076. string_count = decode_uint32(&p_manifest[iofs]);
  1077. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  1078. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  1079. uint32_t st_offset = iofs + 20;
  1080. string_table.resize(string_count);
  1081. uint32_t string_end = 0;
  1082. string_table_begins = st_offset;
  1083. for (uint32_t i = 0; i < string_count; i++) {
  1084. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  1085. string_at += st_offset + string_count * 4;
  1086. ERR_FAIL_COND_MSG(string_flags & UTF8_FLAG, "Unimplemented, can't read UTF-8 string table.");
  1087. if (string_flags & UTF8_FLAG) {
  1088. } else {
  1089. uint32_t len = decode_uint16(&p_manifest[string_at]);
  1090. Vector<char32_t> ucstring;
  1091. ucstring.resize(len + 1);
  1092. for (uint32_t j = 0; j < len; j++) {
  1093. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  1094. ucstring.write[j] = c;
  1095. }
  1096. string_end = MAX(string_at + 2 + 2 * len, string_end);
  1097. ucstring.write[len] = 0;
  1098. string_table.write[i] = ucstring.ptr();
  1099. }
  1100. }
  1101. for (uint32_t i = string_end; i < (ofs + size); i++) {
  1102. stable_extra.push_back(p_manifest[i]);
  1103. }
  1104. string_table_ends = ofs + size;
  1105. } break;
  1106. case CHUNK_XML_START_TAG: {
  1107. int iofs = ofs + 8;
  1108. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  1109. String tname = string_table[name];
  1110. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  1111. iofs += 28;
  1112. for (uint32_t i = 0; i < attrcount; i++) {
  1113. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  1114. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  1115. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  1116. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  1117. const String value = (attr_value != 0xFFFFFFFF) ? string_table[attr_value] : "Res #" + itos(attr_resid);
  1118. String attrname = string_table[attr_name];
  1119. const String nspace = (attr_nspace != 0xFFFFFFFF) ? string_table[attr_nspace] : "";
  1120. //replace project information
  1121. if (tname == "manifest" && attrname == "package") {
  1122. string_table.write[attr_value] = get_package_name(p_preset, package_name);
  1123. }
  1124. if (tname == "manifest" && attrname == "versionCode") {
  1125. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  1126. }
  1127. if (tname == "manifest" && attrname == "versionName") {
  1128. if (attr_value == 0xFFFFFFFF) {
  1129. WARN_PRINT("Version name in a resource, should be plain text");
  1130. } else {
  1131. string_table.write[attr_value] = version_name;
  1132. }
  1133. }
  1134. if (tname == "application" && attrname == "requestLegacyExternalStorage") {
  1135. encode_uint32(has_read_write_storage_permission ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1136. }
  1137. if (tname == "application" && attrname == "allowBackup") {
  1138. encode_uint32(backup_allowed, &p_manifest.write[iofs + 16]);
  1139. }
  1140. if (tname == "application" && attrname == "appCategory") {
  1141. encode_uint32(_get_app_category_value(app_category), &p_manifest.write[iofs + 16]);
  1142. }
  1143. if (tname == "application" && attrname == "isGame") {
  1144. encode_uint32(app_category == APP_CATEGORY_GAME, &p_manifest.write[iofs + 16]);
  1145. }
  1146. if (tname == "application" && attrname == "hasFragileUserData") {
  1147. encode_uint32(retain_data_on_uninstall, &p_manifest.write[iofs + 16]);
  1148. }
  1149. if (tname == "activity" && attrname == "screenOrientation") {
  1150. encode_uint32(screen_orientation, &p_manifest.write[iofs + 16]);
  1151. }
  1152. if (tname == "activity" && attrname == "excludeFromRecents") {
  1153. encode_uint32(exclude_from_recents, &p_manifest.write[iofs + 16]);
  1154. }
  1155. if (tname == "activity" && attrname == "resizeableActivity") {
  1156. encode_uint32(is_resizeable, &p_manifest.write[iofs + 16]);
  1157. }
  1158. if (tname == "provider" && attrname == "authorities") {
  1159. string_table.write[attr_value] = get_package_name(p_preset, package_name) + String(".fileprovider");
  1160. }
  1161. if (tname == "supports-screens") {
  1162. if (attrname == "smallScreens") {
  1163. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1164. } else if (attrname == "normalScreens") {
  1165. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1166. } else if (attrname == "largeScreens") {
  1167. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1168. } else if (attrname == "xlargeScreens") {
  1169. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  1170. }
  1171. }
  1172. iofs += 20;
  1173. }
  1174. } break;
  1175. case CHUNK_XML_END_TAG: {
  1176. int iofs = ofs + 8;
  1177. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  1178. String tname = string_table[name];
  1179. if (tname == "manifest" || tname == "application") {
  1180. // save manifest ending so we can restore it
  1181. Vector<uint8_t> manifest_end;
  1182. uint32_t manifest_cur_size = p_manifest.size();
  1183. manifest_end.resize(p_manifest.size() - ofs);
  1184. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  1185. int32_t attr_name_string = string_table.find("name");
  1186. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  1187. int32_t ns_android_string = string_table.find("http://schemas.android.com/apk/res/android");
  1188. if (ns_android_string == -1) {
  1189. string_table.push_back("http://schemas.android.com/apk/res/android");
  1190. ns_android_string = string_table.size() - 1;
  1191. }
  1192. if (tname == "manifest") {
  1193. // Updating manifest features
  1194. int32_t attr_uses_feature_string = string_table.find("uses-feature");
  1195. if (attr_uses_feature_string == -1) {
  1196. string_table.push_back("uses-feature");
  1197. attr_uses_feature_string = string_table.size() - 1;
  1198. }
  1199. int32_t attr_required_string = string_table.find("required");
  1200. if (attr_required_string == -1) {
  1201. string_table.push_back("required");
  1202. attr_required_string = string_table.size() - 1;
  1203. }
  1204. for (int i = 0; i < features.size(); i++) {
  1205. const String &feature_name = features[i].name;
  1206. bool feature_required = features[i].required;
  1207. String feature_version = features[i].version;
  1208. bool has_version_attribute = !feature_version.is_empty();
  1209. print_line("Adding feature " + feature_name);
  1210. int32_t feature_string = string_table.find(feature_name);
  1211. if (feature_string == -1) {
  1212. string_table.push_back(feature_name);
  1213. feature_string = string_table.size() - 1;
  1214. }
  1215. String required_value_string = feature_required ? "true" : "false";
  1216. int32_t required_value = string_table.find(required_value_string);
  1217. if (required_value == -1) {
  1218. string_table.push_back(required_value_string);
  1219. required_value = string_table.size() - 1;
  1220. }
  1221. int32_t attr_version_string = -1;
  1222. int32_t version_value = -1;
  1223. int tag_size;
  1224. int attr_count;
  1225. if (has_version_attribute) {
  1226. attr_version_string = string_table.find("version");
  1227. if (attr_version_string == -1) {
  1228. string_table.push_back("version");
  1229. attr_version_string = string_table.size() - 1;
  1230. }
  1231. version_value = string_table.find(feature_version);
  1232. if (version_value == -1) {
  1233. string_table.push_back(feature_version);
  1234. version_value = string_table.size() - 1;
  1235. }
  1236. tag_size = 96; // node and three attrs + end node
  1237. attr_count = 3;
  1238. } else {
  1239. tag_size = 76; // node and two attrs + end node
  1240. attr_count = 2;
  1241. }
  1242. manifest_cur_size += tag_size + 24;
  1243. p_manifest.resize(manifest_cur_size);
  1244. // start tag
  1245. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1246. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1247. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  1248. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1249. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1250. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1251. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1252. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1253. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1254. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  1255. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1256. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1257. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1258. // android:name attribute
  1259. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1260. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1261. encode_uint32(feature_string, &p_manifest.write[ofs + 44]); // raw_value
  1262. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1263. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1264. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1265. encode_uint32(feature_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1266. // android:required attribute
  1267. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  1268. encode_uint32(attr_required_string, &p_manifest.write[ofs + 60]); // 'name'
  1269. encode_uint32(required_value, &p_manifest.write[ofs + 64]); // raw_value
  1270. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  1271. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  1272. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  1273. encode_uint32(required_value, &p_manifest.write[ofs + 72]); // typedvalue reference
  1274. ofs += 76;
  1275. if (has_version_attribute) {
  1276. // android:version attribute
  1277. encode_uint32(ns_android_string, &p_manifest.write[ofs]); // ns
  1278. encode_uint32(attr_version_string, &p_manifest.write[ofs + 4]); // 'name'
  1279. encode_uint32(version_value, &p_manifest.write[ofs + 8]); // raw_value
  1280. encode_uint16(8, &p_manifest.write[ofs + 12]); // typedvalue_size
  1281. p_manifest.write[ofs + 14] = 0; // typedvalue_always0
  1282. p_manifest.write[ofs + 15] = 0x03; // typedvalue_type (string)
  1283. encode_uint32(version_value, &p_manifest.write[ofs + 16]); // typedvalue reference
  1284. ofs += 20;
  1285. }
  1286. // end tag
  1287. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1288. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1289. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1290. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1291. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1292. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1293. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1294. ofs += 24;
  1295. }
  1296. // Updating manifest permissions
  1297. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  1298. if (attr_uses_permission_string == -1) {
  1299. string_table.push_back("uses-permission");
  1300. attr_uses_permission_string = string_table.size() - 1;
  1301. }
  1302. for (int i = 0; i < perms.size(); ++i) {
  1303. print_line("Adding permission " + perms[i]);
  1304. manifest_cur_size += 56 + 24; // node + end node
  1305. p_manifest.resize(manifest_cur_size);
  1306. // Add permission to the string pool
  1307. int32_t perm_string = string_table.find(perms[i]);
  1308. if (perm_string == -1) {
  1309. string_table.push_back(perms[i]);
  1310. perm_string = string_table.size() - 1;
  1311. }
  1312. // start tag
  1313. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1314. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1315. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  1316. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1317. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1318. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1319. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1320. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1321. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1322. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  1323. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1324. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1325. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1326. // attribute
  1327. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1328. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1329. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  1330. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1331. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1332. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1333. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1334. ofs += 56;
  1335. // end tag
  1336. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1337. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1338. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1339. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1340. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1341. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1342. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1343. ofs += 24;
  1344. }
  1345. }
  1346. if (tname == "application") {
  1347. // Updating application meta-data
  1348. int32_t attr_meta_data_string = string_table.find("meta-data");
  1349. if (attr_meta_data_string == -1) {
  1350. string_table.push_back("meta-data");
  1351. attr_meta_data_string = string_table.size() - 1;
  1352. }
  1353. int32_t attr_value_string = string_table.find("value");
  1354. if (attr_value_string == -1) {
  1355. string_table.push_back("value");
  1356. attr_value_string = string_table.size() - 1;
  1357. }
  1358. for (int i = 0; i < manifest_metadata.size(); i++) {
  1359. String meta_data_name = manifest_metadata[i].name;
  1360. String meta_data_value = manifest_metadata[i].value;
  1361. print_line("Adding application metadata " + meta_data_name);
  1362. int32_t meta_data_name_string = string_table.find(meta_data_name);
  1363. if (meta_data_name_string == -1) {
  1364. string_table.push_back(meta_data_name);
  1365. meta_data_name_string = string_table.size() - 1;
  1366. }
  1367. int32_t meta_data_value_string = string_table.find(meta_data_value);
  1368. if (meta_data_value_string == -1) {
  1369. string_table.push_back(meta_data_value);
  1370. meta_data_value_string = string_table.size() - 1;
  1371. }
  1372. int tag_size = 76; // node and two attrs + end node
  1373. int attr_count = 2;
  1374. manifest_cur_size += tag_size + 24;
  1375. p_manifest.resize(manifest_cur_size);
  1376. // start tag
  1377. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1378. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1379. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  1380. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1381. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1382. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1383. encode_uint32(attr_meta_data_string, &p_manifest.write[ofs + 20]); // name
  1384. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1385. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1386. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  1387. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1388. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1389. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1390. // android:name attribute
  1391. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1392. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1393. encode_uint32(meta_data_name_string, &p_manifest.write[ofs + 44]); // raw_value
  1394. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1395. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1396. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1397. encode_uint32(meta_data_name_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1398. // android:value attribute
  1399. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  1400. encode_uint32(attr_value_string, &p_manifest.write[ofs + 60]); // 'value'
  1401. encode_uint32(meta_data_value_string, &p_manifest.write[ofs + 64]); // raw_value
  1402. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  1403. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  1404. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  1405. encode_uint32(meta_data_value_string, &p_manifest.write[ofs + 72]); // typedvalue reference
  1406. ofs += 76;
  1407. // end tag
  1408. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1409. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1410. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1411. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1412. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1413. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1414. encode_uint32(attr_meta_data_string, &p_manifest.write[ofs + 20]); // name
  1415. ofs += 24;
  1416. }
  1417. }
  1418. // copy footer back in
  1419. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1420. }
  1421. } break;
  1422. }
  1423. ofs += size;
  1424. }
  1425. // Create new android manifest binary.
  1426. Vector<uint8_t> ret;
  1427. ret.resize(string_table_begins + string_table.size() * 4);
  1428. for (uint32_t i = 0; i < string_table_begins; i++) {
  1429. ret.write[i] = p_manifest[i];
  1430. }
  1431. ofs = 0;
  1432. for (int i = 0; i < string_table.size(); i++) {
  1433. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1434. ofs += string_table[i].length() * 2 + 2 + 2;
  1435. }
  1436. ret.resize(ret.size() + ofs);
  1437. string_data_offset = ret.size() - ofs;
  1438. uint8_t *chars = &ret.write[string_data_offset];
  1439. for (int i = 0; i < string_table.size(); i++) {
  1440. String s = string_table[i];
  1441. encode_uint16(s.length(), chars);
  1442. chars += 2;
  1443. for (int j = 0; j < s.length(); j++) {
  1444. encode_uint16(s[j], chars);
  1445. chars += 2;
  1446. }
  1447. encode_uint16(0, chars);
  1448. chars += 2;
  1449. }
  1450. for (int i = 0; i < stable_extra.size(); i++) {
  1451. ret.push_back(stable_extra[i]);
  1452. }
  1453. //pad
  1454. while (ret.size() % 4) {
  1455. ret.push_back(0);
  1456. }
  1457. uint32_t new_stable_end = ret.size();
  1458. uint32_t extra = (p_manifest.size() - string_table_ends);
  1459. ret.resize(new_stable_end + extra);
  1460. for (uint32_t i = 0; i < extra; i++) {
  1461. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  1462. }
  1463. while (ret.size() % 4) {
  1464. ret.push_back(0);
  1465. }
  1466. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  1467. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  1468. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  1469. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  1470. p_manifest = ret;
  1471. }
  1472. String EditorExportPlatformAndroid::_get_keystore_path(const Ref<EditorExportPreset> &p_preset, bool p_debug) {
  1473. String keystore_preference = p_debug ? "keystore/debug" : "keystore/release";
  1474. String keystore_env_variable = p_debug ? ENV_ANDROID_KEYSTORE_DEBUG_PATH : ENV_ANDROID_KEYSTORE_RELEASE_PATH;
  1475. String keystore_path = p_preset->get_or_env(keystore_preference, keystore_env_variable);
  1476. return ProjectSettings::get_singleton()->globalize_path(keystore_path).simplify_path();
  1477. }
  1478. String EditorExportPlatformAndroid::_parse_string(const uint8_t *p_bytes, bool p_utf8) {
  1479. uint32_t offset = 0;
  1480. uint32_t len = 0;
  1481. if (p_utf8) {
  1482. uint8_t byte = p_bytes[offset];
  1483. if (byte & 0x80) {
  1484. offset += 2;
  1485. } else {
  1486. offset += 1;
  1487. }
  1488. byte = p_bytes[offset];
  1489. offset++;
  1490. if (byte & 0x80) {
  1491. len = byte & 0x7F;
  1492. len = (len << 8) + p_bytes[offset];
  1493. offset++;
  1494. } else {
  1495. len = byte;
  1496. }
  1497. } else {
  1498. len = decode_uint16(&p_bytes[offset]);
  1499. offset += 2;
  1500. if (len & 0x8000) {
  1501. len &= 0x7FFF;
  1502. len = (len << 16) + decode_uint16(&p_bytes[offset]);
  1503. offset += 2;
  1504. }
  1505. }
  1506. if (p_utf8) {
  1507. Vector<uint8_t> str8;
  1508. str8.resize(len + 1);
  1509. for (uint32_t i = 0; i < len; i++) {
  1510. str8.write[i] = p_bytes[offset + i];
  1511. }
  1512. str8.write[len] = 0;
  1513. return String::utf8((const char *)str8.ptr(), len);
  1514. } else {
  1515. String str;
  1516. for (uint32_t i = 0; i < len; i++) {
  1517. char32_t c = decode_uint16(&p_bytes[offset + i * 2]);
  1518. if (c == 0) {
  1519. break;
  1520. }
  1521. str += String::chr(c);
  1522. }
  1523. return str;
  1524. }
  1525. }
  1526. void EditorExportPlatformAndroid::_fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &r_manifest) {
  1527. const int UTF8_FLAG = 0x00000100;
  1528. uint32_t string_block_len = decode_uint32(&r_manifest[16]);
  1529. uint32_t string_count = decode_uint32(&r_manifest[20]);
  1530. uint32_t string_flags = decode_uint32(&r_manifest[28]);
  1531. const uint32_t string_table_begins = 40;
  1532. Vector<String> string_table;
  1533. String package_name = p_preset->get("package/name");
  1534. Dictionary appnames = get_project_setting(p_preset, "application/config/name_localized");
  1535. for (uint32_t i = 0; i < string_count; i++) {
  1536. uint32_t offset = decode_uint32(&r_manifest[string_table_begins + i * 4]);
  1537. offset += string_table_begins + string_count * 4;
  1538. String str = _parse_string(&r_manifest[offset], string_flags & UTF8_FLAG);
  1539. if (str.begins_with("godot-project-name")) {
  1540. if (str == "godot-project-name") {
  1541. //project name
  1542. str = get_project_name(p_preset, package_name);
  1543. } else {
  1544. String lang = str.substr(str.rfind_char('-') + 1).replace_char('-', '_');
  1545. if (appnames.has(lang)) {
  1546. str = appnames[lang];
  1547. } else {
  1548. str = get_project_name(p_preset, package_name);
  1549. }
  1550. }
  1551. }
  1552. string_table.push_back(str);
  1553. }
  1554. //write a new string table, but use 16 bits
  1555. Vector<uint8_t> ret;
  1556. ret.resize(string_table_begins + string_table.size() * 4);
  1557. for (uint32_t i = 0; i < string_table_begins; i++) {
  1558. ret.write[i] = r_manifest[i];
  1559. }
  1560. int ofs = 0;
  1561. for (int i = 0; i < string_table.size(); i++) {
  1562. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1563. ofs += string_table[i].length() * 2 + 2 + 2;
  1564. }
  1565. ret.resize(ret.size() + ofs);
  1566. uint8_t *chars = &ret.write[ret.size() - ofs];
  1567. for (int i = 0; i < string_table.size(); i++) {
  1568. String s = string_table[i];
  1569. encode_uint16(s.length(), chars);
  1570. chars += 2;
  1571. for (int j = 0; j < s.length(); j++) {
  1572. encode_uint16(s[j], chars);
  1573. chars += 2;
  1574. }
  1575. encode_uint16(0, chars);
  1576. chars += 2;
  1577. }
  1578. //pad
  1579. while (ret.size() % 4) {
  1580. ret.push_back(0);
  1581. }
  1582. //change flags to not use utf8
  1583. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  1584. //change length
  1585. encode_uint32(ret.size() - 12, &ret.write[16]);
  1586. //append the rest...
  1587. int rest_from = 12 + string_block_len;
  1588. int rest_to = ret.size();
  1589. int rest_len = (r_manifest.size() - rest_from);
  1590. ret.resize(ret.size() + (r_manifest.size() - rest_from));
  1591. for (int i = 0; i < rest_len; i++) {
  1592. ret.write[rest_to + i] = r_manifest[rest_from + i];
  1593. }
  1594. //finally update the size
  1595. encode_uint32(ret.size(), &ret.write[4]);
  1596. r_manifest = ret;
  1597. //printf("end\n");
  1598. }
  1599. void EditorExportPlatformAndroid::_process_launcher_icons(const String &p_file_name, const Ref<Image> &p_source_image, int dimension, Vector<uint8_t> &p_data) {
  1600. Ref<Image> working_image = p_source_image;
  1601. if (p_source_image->get_width() != dimension || p_source_image->get_height() != dimension) {
  1602. working_image = p_source_image->duplicate();
  1603. working_image->resize(dimension, dimension, Image::Interpolation::INTERPOLATE_LANCZOS);
  1604. }
  1605. Vector<uint8_t> buffer = working_image->save_webp_to_buffer();
  1606. p_data.resize(buffer.size());
  1607. memcpy(p_data.ptrw(), buffer.ptr(), p_data.size());
  1608. }
  1609. void EditorExportPlatformAndroid::load_icon_refs(const Ref<EditorExportPreset> &p_preset, Ref<Image> &icon, Ref<Image> &foreground, Ref<Image> &background, Ref<Image> &monochrome) {
  1610. String project_icon_path = get_project_setting(p_preset, "application/config/icon");
  1611. Error err = OK;
  1612. // Regular icon: user selection -> project icon -> default.
  1613. String path = static_cast<String>(p_preset->get(LAUNCHER_ICON_OPTION)).strip_edges();
  1614. print_verbose("Loading regular icon from " + path);
  1615. if (!path.is_empty()) {
  1616. icon = _load_icon_or_splash_image(path, &err);
  1617. }
  1618. if (path.is_empty() || err != OK || icon.is_null() || icon->is_empty()) {
  1619. print_verbose("- falling back to project icon: " + project_icon_path);
  1620. if (!project_icon_path.is_empty()) {
  1621. icon = _load_icon_or_splash_image(project_icon_path, &err);
  1622. } else {
  1623. ERR_PRINT("No project icon specified. Please specify one in the Project Settings under Application -> Config -> Icon");
  1624. }
  1625. }
  1626. // Adaptive foreground: user selection -> regular icon (user selection -> project icon -> default).
  1627. path = static_cast<String>(p_preset->get(LAUNCHER_ADAPTIVE_ICON_FOREGROUND_OPTION)).strip_edges();
  1628. print_verbose("Loading adaptive foreground icon from " + path);
  1629. if (!path.is_empty()) {
  1630. foreground = _load_icon_or_splash_image(path, &err);
  1631. }
  1632. if (path.is_empty() || err != OK || foreground.is_null() || foreground->is_empty()) {
  1633. print_verbose("- falling back to using the regular icon");
  1634. foreground = icon;
  1635. }
  1636. // Adaptive background: user selection -> default.
  1637. path = static_cast<String>(p_preset->get(LAUNCHER_ADAPTIVE_ICON_BACKGROUND_OPTION)).strip_edges();
  1638. if (!path.is_empty()) {
  1639. print_verbose("Loading adaptive background icon from " + path);
  1640. background = _load_icon_or_splash_image(path, &err);
  1641. }
  1642. // Adaptive monochrome: user selection -> default.
  1643. path = static_cast<String>(p_preset->get(LAUNCHER_ADAPTIVE_ICON_MONOCHROME_OPTION)).strip_edges();
  1644. if (!path.is_empty()) {
  1645. print_verbose("Loading adaptive monochrome icon from " + path);
  1646. monochrome = _load_icon_or_splash_image(path, &err);
  1647. }
  1648. }
  1649. void EditorExportPlatformAndroid::_copy_icons_to_gradle_project(const Ref<EditorExportPreset> &p_preset,
  1650. const Ref<Image> &p_main_image,
  1651. const Ref<Image> &p_foreground,
  1652. const Ref<Image> &p_background,
  1653. const Ref<Image> &p_monochrome) {
  1654. String gradle_build_dir = ExportTemplateManager::get_android_build_directory(p_preset);
  1655. String monochrome_tag = "";
  1656. // Prepare images to be resized for the icons. If some image ends up being uninitialized,
  1657. // the default image from the export template will be used.
  1658. for (int i = 0; i < ICON_DENSITIES_COUNT; ++i) {
  1659. if (p_main_image.is_valid() && !p_main_image->is_empty()) {
  1660. print_verbose("Processing launcher icon for dimension " + itos(LAUNCHER_ICONS[i].dimensions) + " into " + LAUNCHER_ICONS[i].export_path);
  1661. Vector<uint8_t> data;
  1662. _process_launcher_icons(LAUNCHER_ICONS[i].export_path, p_main_image, LAUNCHER_ICONS[i].dimensions, data);
  1663. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ICONS[i].export_path), data);
  1664. }
  1665. if (p_foreground.is_valid() && !p_foreground->is_empty()) {
  1666. 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);
  1667. Vector<uint8_t> data;
  1668. _process_launcher_icons(LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path, p_foreground,
  1669. LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].dimensions, data);
  1670. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path), data);
  1671. }
  1672. if (p_background.is_valid() && !p_background->is_empty()) {
  1673. 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);
  1674. Vector<uint8_t> data;
  1675. _process_launcher_icons(LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path, p_background,
  1676. LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].dimensions, data);
  1677. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path), data);
  1678. }
  1679. if (p_monochrome.is_valid() && !p_monochrome->is_empty()) {
  1680. 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);
  1681. Vector<uint8_t> data;
  1682. _process_launcher_icons(LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path, p_monochrome,
  1683. LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].dimensions, data);
  1684. store_file_at_path(gradle_build_dir.path_join(LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path), data);
  1685. monochrome_tag = " <monochrome android:drawable=\"@mipmap/icon_monochrome\"/>\n";
  1686. }
  1687. }
  1688. // Finalize the icon.xml by formatting the template with the optional monochrome tag.
  1689. store_string_at_path(gradle_build_dir.path_join(ICON_XML_PATH), vformat(ICON_XML_TEMPLATE, monochrome_tag));
  1690. }
  1691. Vector<EditorExportPlatformAndroid::ABI> EditorExportPlatformAndroid::get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  1692. Vector<ABI> abis = get_abis();
  1693. Vector<ABI> enabled_abis;
  1694. for (int i = 0; i < abis.size(); ++i) {
  1695. bool is_enabled = p_preset->get("architectures/" + abis[i].abi);
  1696. if (is_enabled) {
  1697. enabled_abis.push_back(abis[i]);
  1698. }
  1699. }
  1700. return enabled_abis;
  1701. }
  1702. void EditorExportPlatformAndroid::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) const {
  1703. r_features->push_back("etc2");
  1704. r_features->push_back("astc");
  1705. if (p_preset->get("shader_baker/enabled")) {
  1706. r_features->push_back("shader_baker");
  1707. }
  1708. Vector<ABI> abis = get_enabled_abis(p_preset);
  1709. for (int i = 0; i < abis.size(); ++i) {
  1710. r_features->push_back(abis[i].arch);
  1711. }
  1712. }
  1713. String EditorExportPlatformAndroid::get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const {
  1714. if (p_preset) {
  1715. if (p_name == ("apk_expansion/public_key")) {
  1716. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1717. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1718. if (apk_expansion && apk_expansion_pkey.is_empty()) {
  1719. return TTR("Invalid public key for APK expansion.");
  1720. }
  1721. } else if (p_name == "package/unique_name") {
  1722. String pn = p_preset->get("package/unique_name");
  1723. String pn_err;
  1724. if (!is_package_name_valid(Ref<EditorExportPreset>(p_preset), pn, &pn_err)) {
  1725. return TTR("Invalid package name:") + " " + pn_err;
  1726. }
  1727. } else if (p_name == "gesture/swipe_to_dismiss") {
  1728. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1729. if (bool(p_preset->get("gesture/swipe_to_dismiss")) && !gradle_build_enabled) {
  1730. return TTR("\"Use Gradle Build\" is required to enable \"Swipe to dismiss\".");
  1731. }
  1732. } else if (p_name == "gradle_build/use_gradle_build") {
  1733. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1734. String enabled_deprecated_plugins_names = _get_deprecated_plugins_names(Ref<EditorExportPreset>(p_preset));
  1735. if (!enabled_deprecated_plugins_names.is_empty() && !gradle_build_enabled) {
  1736. return TTR("\"Use Gradle Build\" must be enabled to use the plugins.");
  1737. }
  1738. } else if (p_name == "gradle_build/compress_native_libraries") {
  1739. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1740. if (bool(p_preset->get("gradle_build/compress_native_libraries")) && !gradle_build_enabled) {
  1741. return TTR("\"Compress Native Libraries\" is only valid when \"Use Gradle Build\" is enabled.");
  1742. }
  1743. } else if (p_name == "gradle_build/export_format") {
  1744. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1745. if (int(p_preset->get("gradle_build/export_format")) == EXPORT_FORMAT_AAB && !gradle_build_enabled) {
  1746. return TTR("\"Export AAB\" is only valid when \"Use Gradle Build\" is enabled.");
  1747. }
  1748. } else if (p_name == "gradle_build/min_sdk") {
  1749. String min_sdk_str = p_preset->get("gradle_build/min_sdk");
  1750. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1751. if (!min_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  1752. if (!gradle_build_enabled) {
  1753. return TTR("\"Min SDK\" can only be overridden when \"Use Gradle Build\" is enabled.");
  1754. }
  1755. if (!min_sdk_str.is_valid_int()) {
  1756. return vformat(TTR("\"Min SDK\" should be a valid integer, but got \"%s\" which is invalid."), min_sdk_str);
  1757. } else {
  1758. int min_sdk_int = min_sdk_str.to_int();
  1759. if (min_sdk_int < DEFAULT_MIN_SDK_VERSION) {
  1760. return vformat(TTR("\"Min SDK\" cannot be lower than %d, which is the version needed by the Godot library."), DEFAULT_MIN_SDK_VERSION);
  1761. }
  1762. }
  1763. }
  1764. } else if (p_name == "gradle_build/target_sdk") {
  1765. String target_sdk_str = p_preset->get("gradle_build/target_sdk");
  1766. int target_sdk_int = DEFAULT_TARGET_SDK_VERSION;
  1767. String min_sdk_str = p_preset->get("gradle_build/min_sdk");
  1768. int min_sdk_int = DEFAULT_MIN_SDK_VERSION;
  1769. if (min_sdk_str.is_valid_int()) {
  1770. min_sdk_int = min_sdk_str.to_int();
  1771. }
  1772. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1773. if (!target_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  1774. if (!gradle_build_enabled) {
  1775. return TTR("\"Target SDK\" can only be overridden when \"Use Gradle Build\" is enabled.");
  1776. }
  1777. if (!target_sdk_str.is_valid_int()) {
  1778. return vformat(TTR("\"Target SDK\" should be a valid integer, but got \"%s\" which is invalid."), target_sdk_str);
  1779. } else {
  1780. target_sdk_int = target_sdk_str.to_int();
  1781. if (target_sdk_int < min_sdk_int) {
  1782. return TTR("\"Target SDK\" version must be greater or equal to \"Min SDK\" version.");
  1783. }
  1784. }
  1785. }
  1786. } else if (p_name == "gradle_build/custom_theme_attributes") {
  1787. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1788. if (bool(p_preset->get("gradle_build/custom_theme_attributes")) && !gradle_build_enabled) {
  1789. return TTR("\"Use Gradle Build\" is required to add custom theme attributes.");
  1790. }
  1791. } else if (p_name == "package/show_in_android_tv") {
  1792. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1793. if (bool(p_preset->get("package/show_in_android_tv")) && !gradle_build_enabled) {
  1794. return TTR("\"Use Gradle Build\" must be enabled to enable \"Show In Android Tv\".");
  1795. }
  1796. } else if (p_name == "package/show_as_launcher_app") {
  1797. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1798. if (bool(p_preset->get("package/show_as_launcher_app")) && !gradle_build_enabled) {
  1799. return TTR("\"Use Gradle Build\" must be enabled to enable \"Show As Launcher App\".");
  1800. }
  1801. } else if (p_name == "package/show_in_app_library") {
  1802. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  1803. if (!bool(p_preset->get("package/show_in_app_library")) && !gradle_build_enabled) {
  1804. return TTR("\"Use Gradle Build\" must be enabled to disable \"Show In App Library\".");
  1805. }
  1806. } else if (p_name == "shader_baker/enabled" && bool(p_preset->get("shader_baker/enabled"))) {
  1807. String export_renderer = GLOBAL_GET("rendering/renderer/rendering_method.mobile");
  1808. if (OS::get_singleton()->get_current_rendering_method() == "gl_compatibility") {
  1809. return TTR("\"Shader Baker\" is not supported when using the Compatibility renderer.");
  1810. } else if (OS::get_singleton()->get_current_rendering_method() != export_renderer) {
  1811. return vformat(TTR("The editor is currently using a different renderer than what the target platform will use. \"Shader Baker\" won't be able to include core shaders. Switch to the \"%s\" renderer temporarily to fix this."), export_renderer);
  1812. }
  1813. }
  1814. }
  1815. return String();
  1816. }
  1817. void EditorExportPlatformAndroid::get_export_options(List<ExportOption> *r_options) const {
  1818. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1819. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1820. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "gradle_build/use_gradle_build"), false, true, true));
  1821. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/gradle_build_directory", PROPERTY_HINT_PLACEHOLDER_TEXT, "res://android"), "", false, false));
  1822. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/android_source_template", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  1823. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "gradle_build/compress_native_libraries"), false, false, true));
  1824. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "gradle_build/export_format", PROPERTY_HINT_ENUM, "Export APK,Export AAB"), EXPORT_FORMAT_APK, false, true));
  1825. // Using String instead of int to default to an empty string (no override) with placeholder for instructions (see GH-62465).
  1826. // This implies doing validation that the string is a proper int.
  1827. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "gradle_build/min_sdk", PROPERTY_HINT_PLACEHOLDER_TEXT, vformat("%d (default)", DEFAULT_MIN_SDK_VERSION)), "", false, true));
  1828. 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));
  1829. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "gradle_build/custom_theme_attributes", PROPERTY_HINT_DICTIONARY_TYPE, "String;String"), Dictionary()));
  1830. #ifndef DISABLE_DEPRECATED
  1831. Vector<PluginConfigAndroid> plugins_configs = get_plugins();
  1832. for (int i = 0; i < plugins_configs.size(); i++) {
  1833. print_verbose("Found Android plugin " + plugins_configs[i].name);
  1834. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("plugins"), plugins_configs[i].name)), false));
  1835. }
  1836. android_plugins_changed.clear();
  1837. #endif // DISABLE_DEPRECATED
  1838. // Android supports multiple architectures in an app bundle, so
  1839. // we expose each option as a checkbox in the export dialog.
  1840. const Vector<ABI> abis = get_abis();
  1841. for (int i = 0; i < abis.size(); ++i) {
  1842. const String abi = abis[i].abi;
  1843. // All Android devices supporting Vulkan run 64-bit Android,
  1844. // so there is usually no point in exporting for 32-bit Android.
  1845. const bool is_default = abi == "arm64-v8a";
  1846. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("architectures"), abi)), is_default));
  1847. }
  1848. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1849. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1850. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password", PROPERTY_HINT_PASSWORD, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1851. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1852. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1853. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password", PROPERTY_HINT_PASSWORD, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  1854. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  1855. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Leave empty to use project version"), ""));
  1856. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "ext.domain.name"), "com.example.$genname", false, true));
  1857. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name [default if blank]"), ""));
  1858. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  1859. 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));
  1860. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/retain_data_on_uninstall"), false));
  1861. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/exclude_from_recents"), false));
  1862. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/show_in_android_tv"), false));
  1863. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/show_in_app_library"), true));
  1864. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/show_as_launcher_app"), false));
  1865. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ICON_OPTION, PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  1866. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ADAPTIVE_ICON_FOREGROUND_OPTION, PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  1867. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ADAPTIVE_ICON_BACKGROUND_OPTION, PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  1868. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, LAUNCHER_ADAPTIVE_ICON_MONOCHROME_OPTION, PROPERTY_HINT_FILE, "*.png,*.webp,*.svg"), ""));
  1869. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/opengl_debug"), false));
  1870. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "shader_baker/enabled"), false));
  1871. #ifndef XR_DISABLED
  1872. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/xr_mode", PROPERTY_HINT_ENUM, "Regular,OpenXR"), XR_MODE_REGULAR, false, true));
  1873. #endif // XR_DISABLED
  1874. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "gesture/swipe_to_dismiss"), false));
  1875. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  1876. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/edge_to_edge"), false));
  1877. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  1878. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  1879. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  1880. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  1881. r_options->push_back(ExportOption(PropertyInfo(Variant::COLOR, "screen/background_color", PROPERTY_HINT_COLOR_NO_ALPHA), Color()));
  1882. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data_backup/allow"), false));
  1883. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  1884. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false, false, true));
  1885. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  1886. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), "", false, true));
  1887. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "permissions/custom_permissions"), PackedStringArray()));
  1888. const char **perms = ANDROID_PERMS;
  1889. while (*perms) {
  1890. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("permissions"), String(*perms).to_lower())), false));
  1891. perms++;
  1892. }
  1893. }
  1894. bool EditorExportPlatformAndroid::get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const {
  1895. if (p_preset == nullptr) {
  1896. return true;
  1897. }
  1898. bool advanced_options_enabled = p_preset->are_advanced_options_enabled();
  1899. if (p_option == "graphics/opengl_debug" ||
  1900. p_option == "gradle_build/custom_theme_attributes" ||
  1901. p_option == "command_line/extra_args" ||
  1902. p_option == "permissions/custom_permissions" ||
  1903. p_option == "keystore/debug" ||
  1904. p_option == "keystore/debug_user" ||
  1905. p_option == "keystore/debug_password" ||
  1906. p_option == "package/retain_data_on_uninstall" ||
  1907. p_option == "package/exclude_from_recents" ||
  1908. p_option == "package/show_in_app_library" ||
  1909. p_option == "package/show_as_launcher_app" ||
  1910. p_option == "gesture/swipe_to_dismiss" ||
  1911. p_option == "apk_expansion/enable" ||
  1912. p_option == "apk_expansion/SALT" ||
  1913. p_option == "apk_expansion/public_key") {
  1914. return advanced_options_enabled;
  1915. }
  1916. if (p_option == "gradle_build/gradle_build_directory" || p_option == "gradle_build/android_source_template") {
  1917. return advanced_options_enabled && bool(p_preset->get("gradle_build/use_gradle_build"));
  1918. }
  1919. if (p_option == "custom_template/debug" || p_option == "custom_template/release") {
  1920. // The APK templates are ignored if Gradle build is enabled.
  1921. return advanced_options_enabled && !bool(p_preset->get("gradle_build/use_gradle_build"));
  1922. }
  1923. // Hide .NET embedding option (always enabled).
  1924. if (p_option == "dotnet/embed_build_outputs") {
  1925. return false;
  1926. }
  1927. if (p_option == "dotnet/android_use_linux_bionic") {
  1928. return advanced_options_enabled;
  1929. }
  1930. return true;
  1931. }
  1932. String EditorExportPlatformAndroid::get_name() const {
  1933. return "Android";
  1934. }
  1935. String EditorExportPlatformAndroid::get_os_name() const {
  1936. return "Android";
  1937. }
  1938. Ref<Texture2D> EditorExportPlatformAndroid::get_logo() const {
  1939. return logo;
  1940. }
  1941. bool EditorExportPlatformAndroid::should_update_export_options() {
  1942. #ifndef DISABLE_DEPRECATED
  1943. if (android_plugins_changed.is_set()) {
  1944. // don't clear unless we're reporting true, to avoid race
  1945. android_plugins_changed.clear();
  1946. return true;
  1947. }
  1948. #endif // DISABLE_DEPRECATED
  1949. return false;
  1950. }
  1951. bool EditorExportPlatformAndroid::poll_export() {
  1952. bool dc = devices_changed.is_set();
  1953. if (dc) {
  1954. // don't clear unless we're reporting true, to avoid race
  1955. devices_changed.clear();
  1956. }
  1957. return dc;
  1958. }
  1959. int EditorExportPlatformAndroid::get_options_count() const {
  1960. MutexLock lock(device_lock);
  1961. return devices.size() + 1;
  1962. }
  1963. Ref<Texture2D> EditorExportPlatformAndroid::get_option_icon(int p_index) const {
  1964. if (p_index == 0) {
  1965. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  1966. ERR_FAIL_COND_V(theme.is_null(), Ref<ImageTexture>());
  1967. return theme->get_icon(use_scrcpy ? SNAME("GuiChecked") : SNAME("GuiUnchecked"), EditorStringName(EditorIcons));
  1968. }
  1969. return EditorExportPlatform::get_option_icon(p_index - 1);
  1970. }
  1971. String EditorExportPlatformAndroid::get_options_tooltip() const {
  1972. return TTR("Select device from the list");
  1973. }
  1974. String EditorExportPlatformAndroid::get_option_label(int p_index) const {
  1975. ERR_FAIL_INDEX_V(p_index, devices.size() + 1, "");
  1976. if (p_index == 0) {
  1977. return TTR("Mirror Android devices");
  1978. }
  1979. MutexLock lock(device_lock);
  1980. return devices[p_index - 1].name;
  1981. }
  1982. String EditorExportPlatformAndroid::get_option_tooltip(int p_index) const {
  1983. ERR_FAIL_INDEX_V(p_index, devices.size() + 1, "");
  1984. if (p_index == 0) {
  1985. return TTR("If enabled, \"scrcpy\" is used to start the project and automatically stream device display (or virtual display) content.");
  1986. }
  1987. MutexLock lock(device_lock);
  1988. String s = devices[p_index - 1].description;
  1989. if (devices.size() == 1) {
  1990. // Tooltip will be:
  1991. // Name
  1992. // Description
  1993. s = devices[p_index - 1].name + "\n\n" + s;
  1994. }
  1995. return s;
  1996. }
  1997. String EditorExportPlatformAndroid::get_device_architecture(int p_index) const {
  1998. ERR_FAIL_INDEX_V(p_index, devices.size() + 1, "");
  1999. if (p_index == 0) {
  2000. return String();
  2001. }
  2002. MutexLock lock(device_lock);
  2003. return devices[p_index - 1].architecture;
  2004. }
  2005. Error EditorExportPlatformAndroid::run(const Ref<EditorExportPreset> &p_preset, int p_device, BitField<EditorExportPlatform::DebugFlags> p_debug_flags) {
  2006. ERR_FAIL_INDEX_V(p_device, devices.size() + 1, ERR_INVALID_PARAMETER);
  2007. if (p_device == 0) {
  2008. use_scrcpy = !use_scrcpy;
  2009. EditorSettings::get_singleton()->set_project_metadata("android", "use_scrcpy", use_scrcpy);
  2010. devices_changed.set();
  2011. return ERR_SKIP;
  2012. }
  2013. String can_export_error;
  2014. bool can_export_missing_templates;
  2015. if (!can_export(p_preset, can_export_error, can_export_missing_templates)) {
  2016. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), can_export_error);
  2017. return ERR_UNCONFIGURED;
  2018. }
  2019. MutexLock lock(device_lock);
  2020. EditorProgress ep("run", vformat(TTR("Running on %s"), devices[p_device - 1].name), 3);
  2021. String adb = get_adb_path();
  2022. // Export_temp APK.
  2023. if (ep.step(TTR("Exporting APK..."), 0)) {
  2024. return ERR_SKIP;
  2025. }
  2026. const bool use_wifi_for_remote_debug = EDITOR_GET("export/android/use_wifi_for_remote_debug");
  2027. const bool use_remote = p_debug_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG) || p_debug_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT);
  2028. const bool use_reverse = devices[p_device - 1].api_level >= 21 && !use_wifi_for_remote_debug;
  2029. if (use_reverse) {
  2030. p_debug_flags.set_flag(DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST);
  2031. }
  2032. String tmp_export_path = EditorPaths::get_singleton()->get_temp_dir().path_join("tmpexport." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  2033. #define CLEANUP_AND_RETURN(m_err) \
  2034. { \
  2035. DirAccess::remove_file_or_error(tmp_export_path); \
  2036. if (FileAccess::exists(tmp_export_path + ".idsig")) { \
  2037. DirAccess::remove_file_or_error(tmp_export_path + ".idsig"); \
  2038. } \
  2039. return m_err; \
  2040. } \
  2041. ((void)0)
  2042. // Export to temporary APK before sending to device.
  2043. Error err = export_project_helper(p_preset, true, tmp_export_path, EXPORT_FORMAT_APK, true, p_debug_flags);
  2044. if (err != OK) {
  2045. CLEANUP_AND_RETURN(err);
  2046. }
  2047. List<String> args;
  2048. int rv;
  2049. String output;
  2050. bool remove_prev = EDITOR_GET("export/android/one_click_deploy_clear_previous_install");
  2051. String version_name = p_preset->get_version("version/name");
  2052. String package_name = p_preset->get("package/unique_name");
  2053. if (remove_prev) {
  2054. if (ep.step(TTR("Uninstalling..."), 1)) {
  2055. CLEANUP_AND_RETURN(ERR_SKIP);
  2056. }
  2057. print_line("Uninstalling previous version: " + devices[p_device - 1].name);
  2058. args.push_back("-s");
  2059. args.push_back(devices[p_device - 1].id);
  2060. args.push_back("uninstall");
  2061. if ((bool)EDITOR_GET("export/android/force_system_user") && devices[p_device - 1].api_level >= 17) {
  2062. args.push_back("--user");
  2063. args.push_back("0");
  2064. }
  2065. args.push_back(get_package_name(p_preset, package_name));
  2066. output.clear();
  2067. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2068. print_verbose(output);
  2069. }
  2070. print_line("Installing to device (please wait...): " + devices[p_device - 1].name);
  2071. if (ep.step(TTR("Installing to device, please wait..."), 2)) {
  2072. CLEANUP_AND_RETURN(ERR_SKIP);
  2073. }
  2074. args.clear();
  2075. args.push_back("-s");
  2076. args.push_back(devices[p_device - 1].id);
  2077. args.push_back("install");
  2078. if ((bool)EDITOR_GET("export/android/force_system_user") && devices[p_device - 1].api_level >= 17) {
  2079. args.push_back("--user");
  2080. args.push_back("0");
  2081. }
  2082. args.push_back("-r");
  2083. args.push_back(tmp_export_path);
  2084. output.clear();
  2085. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2086. print_verbose(output);
  2087. if (err || rv != 0) {
  2088. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), vformat(TTR("Could not install to device: %s"), output));
  2089. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  2090. }
  2091. if (use_remote) {
  2092. if (use_reverse) {
  2093. static const char *const msg = "--- Device API >= 21; debugging over USB ---";
  2094. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  2095. print_line(String(msg).to_upper());
  2096. args.clear();
  2097. args.push_back("-s");
  2098. args.push_back(devices[p_device - 1].id);
  2099. args.push_back("reverse");
  2100. args.push_back("--remove-all");
  2101. output.clear();
  2102. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2103. print_verbose(output);
  2104. if (p_debug_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG)) {
  2105. int dbg_port = EDITOR_GET("network/debug/remote_port");
  2106. args.clear();
  2107. args.push_back("-s");
  2108. args.push_back(devices[p_device - 1].id);
  2109. args.push_back("reverse");
  2110. args.push_back("tcp:" + itos(dbg_port));
  2111. args.push_back("tcp:" + itos(dbg_port));
  2112. output.clear();
  2113. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2114. print_verbose(output);
  2115. print_line("Reverse result: " + itos(rv));
  2116. }
  2117. if (p_debug_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  2118. int fs_port = EDITOR_GET("filesystem/file_server/port");
  2119. args.clear();
  2120. args.push_back("-s");
  2121. args.push_back(devices[p_device - 1].id);
  2122. args.push_back("reverse");
  2123. args.push_back("tcp:" + itos(fs_port));
  2124. args.push_back("tcp:" + itos(fs_port));
  2125. output.clear();
  2126. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2127. print_verbose(output);
  2128. print_line("Reverse result2: " + itos(rv));
  2129. }
  2130. } else {
  2131. static const char *const api_version_msg = "--- Device API < 21; debugging over Wi-Fi ---";
  2132. static const char *const manual_override_msg = "--- Wi-Fi remote debug enabled in project settings; debugging over Wi-Fi ---";
  2133. const char *const msg = use_wifi_for_remote_debug ? manual_override_msg : api_version_msg;
  2134. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  2135. print_line(String(msg).to_upper());
  2136. }
  2137. }
  2138. if (ep.step(TTR("Running on device..."), 3)) {
  2139. CLEANUP_AND_RETURN(ERR_SKIP);
  2140. }
  2141. String scrcpy = "scrcpy";
  2142. if (!EDITOR_GET("export/android/scrcpy/path").operator String().is_empty()) {
  2143. scrcpy = EDITOR_GET("export/android/scrcpy/path").operator String();
  2144. }
  2145. args.clear();
  2146. if (use_scrcpy) {
  2147. args.push_back("-s");
  2148. args.push_back(devices[p_device - 1].id);
  2149. if (EDITOR_GET("export/android/scrcpy/virtual_display").operator bool()) {
  2150. args.push_back("--new-display=" + EDITOR_GET("export/android/scrcpy/screen_size").operator String());
  2151. if (EDITOR_GET("export/android/scrcpy/local_ime").operator bool()) {
  2152. args.push_back("--display-ime-policy=local");
  2153. }
  2154. if (EDITOR_GET("export/android/scrcpy/no_decorations").operator bool()) {
  2155. args.push_back("--no-vd-system-decorations");
  2156. }
  2157. }
  2158. args.push_back("--start-app=+" + get_package_name(p_preset, package_name));
  2159. Dictionary data = OS::get_singleton()->execute_with_pipe(scrcpy, args, false);
  2160. if (!data.has("pid") || data["pid"].operator int() <= 0) {
  2161. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Could not start scrcpy executable. Configure scrcpy path in the Editor Settings (Export > Android > scrcpy > Path)."));
  2162. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  2163. }
  2164. bool connected = false;
  2165. uint64_t wait = 3000000;
  2166. uint64_t time = OS::get_singleton()->get_ticks_usec();
  2167. output.clear();
  2168. String err_output;
  2169. Ref<FileAccess> fa_out = data["stdio"];
  2170. Ref<FileAccess> fa_err = data["stderr"];
  2171. while (fa_out->is_open() && fa_err->is_open() && OS::get_singleton()->get_ticks_usec() - time < wait) {
  2172. PackedByteArray buf;
  2173. buf.resize(fa_out->get_length());
  2174. uint64_t size = fa_out->get_buffer(buf.ptrw(), buf.size());
  2175. output.append_utf8((const char *)buf.ptr(), size);
  2176. buf.resize(fa_err->get_length());
  2177. size = fa_err->get_buffer(buf.ptrw(), buf.size());
  2178. err_output.append_utf8((const char *)buf.ptr(), size);
  2179. if (output.contains("[server] INFO: Device:")) {
  2180. connected = true;
  2181. break;
  2182. }
  2183. }
  2184. print_verbose(output);
  2185. print_verbose(err_output);
  2186. if (!connected) {
  2187. OS::get_singleton()->kill(data["pid"].operator int());
  2188. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Could not execute on device, scrcpy failed with the following error:\n" + err_output));
  2189. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  2190. }
  2191. } else {
  2192. args.push_back("-s");
  2193. args.push_back(devices[p_device - 1].id);
  2194. args.push_back("shell");
  2195. args.push_back("am");
  2196. args.push_back("start");
  2197. if ((bool)EDITOR_GET("export/android/force_system_user") && devices[p_device - 1].api_level >= 17) {
  2198. args.push_back("--user");
  2199. args.push_back("0");
  2200. }
  2201. args.push_back("-a");
  2202. args.push_back("android.intent.action.MAIN");
  2203. // Going with implicit launch first based on the LAUNCHER category and the app's package.
  2204. args.push_back("-c");
  2205. args.push_back("android.intent.category.LAUNCHER");
  2206. args.push_back(get_package_name(p_preset, package_name));
  2207. output.clear();
  2208. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2209. print_verbose(output);
  2210. if (err || rv != 0 || output.contains("Error: Activity not started")) {
  2211. // The implicit launch failed, let's try an explicit launch by specifying the component name before giving up.
  2212. const String component_name = get_package_name(p_preset, package_name) + "/com.godot.game.GodotApp";
  2213. print_line("Implicit launch failed... Trying explicit launch using", component_name);
  2214. args.erase(get_package_name(p_preset, package_name));
  2215. args.push_back("-n");
  2216. args.push_back(component_name);
  2217. output.clear();
  2218. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  2219. print_verbose(output);
  2220. if (err || rv != 0 || output.begins_with("Error: Activity not started")) {
  2221. add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Could not execute on device."));
  2222. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  2223. }
  2224. }
  2225. }
  2226. CLEANUP_AND_RETURN(OK);
  2227. #undef CLEANUP_AND_RETURN
  2228. }
  2229. Ref<Texture2D> EditorExportPlatformAndroid::get_run_icon() const {
  2230. return run_icon;
  2231. }
  2232. String EditorExportPlatformAndroid::get_java_path() {
  2233. String exe_ext;
  2234. if (OS::get_singleton()->get_name() == "Windows") {
  2235. exe_ext = ".exe";
  2236. }
  2237. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2238. return java_sdk_path.path_join("bin/java" + exe_ext);
  2239. }
  2240. String EditorExportPlatformAndroid::get_keytool_path() {
  2241. String exe_ext;
  2242. if (OS::get_singleton()->get_name() == "Windows") {
  2243. exe_ext = ".exe";
  2244. }
  2245. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2246. return java_sdk_path.path_join("bin/keytool" + exe_ext);
  2247. }
  2248. String EditorExportPlatformAndroid::get_adb_path() {
  2249. String exe_ext;
  2250. if (OS::get_singleton()->get_name() == "Windows") {
  2251. exe_ext = ".exe";
  2252. }
  2253. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2254. return sdk_path.path_join("platform-tools/adb" + exe_ext);
  2255. }
  2256. String EditorExportPlatformAndroid::get_apksigner_path(int p_target_sdk, bool p_check_executes) {
  2257. if (p_target_sdk == -1) {
  2258. p_target_sdk = DEFAULT_TARGET_SDK_VERSION;
  2259. }
  2260. String exe_ext;
  2261. if (OS::get_singleton()->get_name() == "Windows") {
  2262. exe_ext = ".bat";
  2263. }
  2264. String apksigner_command_name = "apksigner" + exe_ext;
  2265. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2266. String apksigner_path;
  2267. Error errn;
  2268. String build_tools_dir = sdk_path.path_join("build-tools");
  2269. Ref<DirAccess> da = DirAccess::open(build_tools_dir, &errn);
  2270. if (errn != OK) {
  2271. print_error("Unable to open Android 'build-tools' directory.");
  2272. return apksigner_path;
  2273. }
  2274. // There are additional versions directories we need to go through.
  2275. Vector<String> dir_list = da->get_directories();
  2276. // We need to use the version of build_tools that matches the Target SDK
  2277. // If somehow we can't find that, we see if a version between 28 and the default target SDK exists.
  2278. // We need to avoid versions <= 27 because they fail on Java versions >9
  2279. // If we can't find that, we just use the first valid version.
  2280. Vector<String> ideal_versions;
  2281. Vector<String> other_versions;
  2282. Vector<String> versions;
  2283. bool found_target_sdk = false;
  2284. // We only allow for versions <= 27 if specifically set
  2285. int min_version = p_target_sdk <= 27 ? p_target_sdk : 28;
  2286. for (String sub_dir : dir_list) {
  2287. if (!sub_dir.begins_with(".")) {
  2288. Vector<String> ver_numbers = sub_dir.split(".");
  2289. // Dir not a version number, will use as last resort
  2290. if (!ver_numbers.size() || !ver_numbers[0].is_valid_int()) {
  2291. other_versions.push_back(sub_dir);
  2292. continue;
  2293. }
  2294. int ver_number = ver_numbers[0].to_int();
  2295. if (ver_number == p_target_sdk) {
  2296. found_target_sdk = true;
  2297. //ensure this is in front of the ones we check
  2298. versions.push_back(sub_dir);
  2299. } else {
  2300. if (ver_number >= min_version && ver_number <= DEFAULT_TARGET_SDK_VERSION) {
  2301. ideal_versions.push_back(sub_dir);
  2302. } else {
  2303. other_versions.push_back(sub_dir);
  2304. }
  2305. }
  2306. }
  2307. }
  2308. // we will check ideal versions first, then other versions.
  2309. versions.append_array(ideal_versions);
  2310. versions.append_array(other_versions);
  2311. if (!versions.size()) {
  2312. print_error("Unable to find the 'apksigner' tool.");
  2313. return apksigner_path;
  2314. }
  2315. int i;
  2316. bool failed = false;
  2317. String version_to_use;
  2318. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2319. if (!java_sdk_path.is_empty()) {
  2320. OS::get_singleton()->set_environment("JAVA_HOME", java_sdk_path);
  2321. #ifdef UNIX_ENABLED
  2322. String env_path = OS::get_singleton()->get_environment("PATH");
  2323. if (!env_path.contains(java_sdk_path)) {
  2324. OS::get_singleton()->set_environment("PATH", java_sdk_path + "/bin:" + env_path);
  2325. }
  2326. #endif
  2327. }
  2328. List<String> args;
  2329. args.push_back("--version");
  2330. String output;
  2331. int retval;
  2332. Error err;
  2333. for (i = 0; i < versions.size(); i++) {
  2334. // Check if the tool is here.
  2335. apksigner_path = build_tools_dir.path_join(versions[i]).path_join(apksigner_command_name);
  2336. if (FileAccess::exists(apksigner_path)) {
  2337. version_to_use = versions[i];
  2338. // If we aren't exporting, just break here.
  2339. if (!p_check_executes) {
  2340. break;
  2341. }
  2342. // we only check to see if it executes on export because it is slow to load
  2343. err = OS::get_singleton()->execute(apksigner_path, args, &output, &retval, false);
  2344. if (err || retval) {
  2345. failed = true;
  2346. } else {
  2347. break;
  2348. }
  2349. }
  2350. }
  2351. if (i == versions.size()) {
  2352. if (failed) {
  2353. print_error("All located 'apksigner' tools in " + build_tools_dir + " failed to execute");
  2354. return "<FAILED>";
  2355. } else {
  2356. print_error("Unable to find the 'apksigner' tool.");
  2357. return "";
  2358. }
  2359. }
  2360. if (!found_target_sdk) {
  2361. print_line("Could not find version of build tools that matches Target SDK, using " + version_to_use);
  2362. } else if (failed && found_target_sdk) {
  2363. print_line("Version of build tools that matches Target SDK failed to execute, using " + version_to_use);
  2364. }
  2365. return apksigner_path;
  2366. }
  2367. 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) {
  2368. String output;
  2369. List<String> args;
  2370. args.push_back("-list");
  2371. args.push_back("-keystore");
  2372. args.push_back(p_keystore);
  2373. args.push_back("-storepass");
  2374. args.push_back(p_password);
  2375. args.push_back("-alias");
  2376. args.push_back(p_username);
  2377. String keytool_path = EditorExportPlatformAndroid::get_keytool_path();
  2378. Error error = OS::get_singleton()->execute(keytool_path, args, &output, nullptr, true);
  2379. String keytool_error = "keytool error:";
  2380. bool valid = output.substr(0, keytool_error.length()) != keytool_error;
  2381. if (error != OK) {
  2382. r_error_str = TTR("Error: There was a problem validating the keystore username and password");
  2383. return false;
  2384. }
  2385. if (!valid) {
  2386. r_error_str = TTR(p_type + " Username and/or Password is invalid for the given " + p_type + " Keystore");
  2387. return false;
  2388. }
  2389. r_error_str = "";
  2390. return true;
  2391. }
  2392. bool EditorExportPlatformAndroid::has_valid_username_and_password(const Ref<EditorExportPreset> &p_preset, String &r_error) {
  2393. String dk = _get_keystore_path(p_preset, true);
  2394. String dk_user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2395. String dk_password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2396. String rk = _get_keystore_path(p_preset, false);
  2397. String rk_user = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2398. String rk_password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2399. bool valid = true;
  2400. if (!dk.is_empty() && !dk_user.is_empty() && !dk_password.is_empty()) {
  2401. String err = "";
  2402. valid = has_valid_keystore_credentials(err, dk, dk_user, dk_password, "Debug");
  2403. r_error += err;
  2404. }
  2405. if (!rk.is_empty() && !rk_user.is_empty() && !rk_password.is_empty()) {
  2406. String err = "";
  2407. valid = has_valid_keystore_credentials(err, rk, rk_user, rk_password, "Release");
  2408. r_error += err;
  2409. }
  2410. return valid;
  2411. }
  2412. #ifdef MODULE_MONO_ENABLED
  2413. static uint64_t _last_validate_tfm_time = 0;
  2414. static String _last_validate_tfm = "";
  2415. bool _validate_dotnet_tfm(const String &required_tfm, String &r_error) {
  2416. String assembly_name = Path::get_csharp_project_name();
  2417. String project_path = ProjectSettings::get_singleton()->globalize_path("res://" + assembly_name + ".csproj");
  2418. if (!FileAccess::exists(project_path)) {
  2419. return true;
  2420. }
  2421. uint64_t modified_time = FileAccess::get_modified_time(project_path);
  2422. String tfm;
  2423. if (modified_time == _last_validate_tfm_time) {
  2424. tfm = _last_validate_tfm;
  2425. } else {
  2426. String pipe;
  2427. List<String> args;
  2428. args.push_back("build");
  2429. args.push_back(project_path);
  2430. args.push_back("/p:GodotTargetPlatform=android");
  2431. args.push_back("--getProperty:TargetFramework");
  2432. int exitcode;
  2433. Error err = OS::get_singleton()->execute("dotnet", args, &pipe, &exitcode, true);
  2434. if (err != OK || exitcode != 0) {
  2435. if (err != OK) {
  2436. WARN_PRINT("Failed to execute dotnet command. Error " + String(error_names[err]));
  2437. } else if (exitcode != 0) {
  2438. print_line(pipe);
  2439. WARN_PRINT("dotnet command exited with code " + itos(exitcode) + ". See output above for more details.");
  2440. }
  2441. r_error += vformat(TTR("Unable to determine the C# project's TFM, it may be incompatible. The export template only supports '%s'. Make sure the project targets '%s' or consider using gradle builds instead."), required_tfm, required_tfm) + "\n";
  2442. return true;
  2443. } else {
  2444. tfm = pipe.strip_edges();
  2445. _last_validate_tfm_time = modified_time;
  2446. _last_validate_tfm = tfm;
  2447. }
  2448. }
  2449. if (tfm != required_tfm) {
  2450. r_error += vformat(TTR("C# project targets '%s' but the export template only supports '%s'. Consider using gradle builds instead."), tfm, required_tfm) + "\n";
  2451. return false;
  2452. }
  2453. return true;
  2454. }
  2455. #endif
  2456. bool EditorExportPlatformAndroid::has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const {
  2457. String err;
  2458. bool valid = false;
  2459. const bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  2460. #ifdef MODULE_MONO_ENABLED
  2461. // Android export is still a work in progress, keep a message as a warning.
  2462. err += TTR("Exporting to Android when using C#/.NET is experimental.") + "\n";
  2463. if (!gradle_build_enabled) {
  2464. // For template exports we only support .NET 9 because the template
  2465. // includes .jar dependencies that may only be compatible with .NET 9.
  2466. if (!_validate_dotnet_tfm("net9.0", err)) {
  2467. r_error = err;
  2468. return false;
  2469. }
  2470. }
  2471. #endif
  2472. // Look for export templates (first official, and if defined custom templates).
  2473. if (!gradle_build_enabled) {
  2474. String template_err;
  2475. bool dvalid = false;
  2476. bool rvalid = false;
  2477. bool has_export_templates = false;
  2478. if (p_preset->get("custom_template/debug") != "") {
  2479. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  2480. if (!dvalid) {
  2481. template_err += TTR("Custom debug template not found.") + "\n";
  2482. }
  2483. has_export_templates |= dvalid;
  2484. } else {
  2485. has_export_templates |= exists_export_template("android_debug.apk", &template_err);
  2486. }
  2487. if (p_preset->get("custom_template/release") != "") {
  2488. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  2489. if (!rvalid) {
  2490. template_err += TTR("Custom release template not found.") + "\n";
  2491. }
  2492. has_export_templates |= rvalid;
  2493. } else {
  2494. has_export_templates |= exists_export_template("android_release.apk", &template_err);
  2495. }
  2496. r_missing_templates = !has_export_templates;
  2497. valid = dvalid || rvalid || has_export_templates;
  2498. if (!valid) {
  2499. err += template_err;
  2500. }
  2501. } else {
  2502. #ifdef ANDROID_ENABLED
  2503. err += TTR("Gradle build is not supported for the Android editor.") + "\n";
  2504. valid = false;
  2505. #else
  2506. // Validate the custom gradle android source template.
  2507. bool android_source_template_valid = false;
  2508. const String android_source_template = p_preset->get("gradle_build/android_source_template");
  2509. if (!android_source_template.is_empty()) {
  2510. android_source_template_valid = FileAccess::exists(android_source_template);
  2511. if (!android_source_template_valid) {
  2512. err += TTR("Custom Android source template not found.") + "\n";
  2513. }
  2514. }
  2515. // Validate the installed build template.
  2516. bool installed_android_build_template = FileAccess::exists(ExportTemplateManager::get_android_build_directory(p_preset).path_join("build.gradle"));
  2517. if (!installed_android_build_template) {
  2518. if (!android_source_template_valid) {
  2519. r_missing_templates = !exists_export_template("android_source.zip", &err);
  2520. }
  2521. err += TTR("Android build template not installed in the project. Install it from the Project menu.") + "\n";
  2522. } else {
  2523. r_missing_templates = false;
  2524. }
  2525. valid = installed_android_build_template && !r_missing_templates;
  2526. #endif
  2527. }
  2528. // Validate the rest of the export configuration.
  2529. if (p_debug) {
  2530. String dk = _get_keystore_path(p_preset, true);
  2531. String dk_user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2532. String dk_password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2533. if ((dk.is_empty() || dk_user.is_empty() || dk_password.is_empty()) && (!dk.is_empty() || !dk_user.is_empty() || !dk_password.is_empty())) {
  2534. valid = false;
  2535. err += TTR("Either Debug Keystore, Debug User AND Debug Password settings must be configured OR none of them.") + "\n";
  2536. }
  2537. // Use OR to make the export UI able to show this error.
  2538. if (!dk.is_empty() && !FileAccess::exists(dk)) {
  2539. dk = EDITOR_GET("export/android/debug_keystore");
  2540. if (!FileAccess::exists(dk)) {
  2541. valid = false;
  2542. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  2543. }
  2544. }
  2545. } else {
  2546. String rk = _get_keystore_path(p_preset, false);
  2547. String rk_user = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2548. String rk_password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2549. if ((rk.is_empty() || rk_user.is_empty() || rk_password.is_empty()) && (!rk.is_empty() || !rk_user.is_empty() || !rk_password.is_empty())) {
  2550. valid = false;
  2551. err += TTR("Either Release Keystore, Release User AND Release Password settings must be configured OR none of them.") + "\n";
  2552. }
  2553. if (!rk.is_empty() && !FileAccess::exists(rk)) {
  2554. valid = false;
  2555. err += TTR("Release keystore incorrectly configured in the export preset.") + "\n";
  2556. }
  2557. }
  2558. #ifndef ANDROID_ENABLED
  2559. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  2560. if (java_sdk_path.is_empty()) {
  2561. err += TTR("A valid Java SDK path is required in Editor Settings.") + "\n";
  2562. valid = false;
  2563. } else {
  2564. // Validate the given path by checking that `java` is present under the `bin` directory.
  2565. Error errn;
  2566. // Check for the bin directory.
  2567. Ref<DirAccess> da = DirAccess::open(java_sdk_path.path_join("bin"), &errn);
  2568. if (errn != OK) {
  2569. err += TTR("Invalid Java SDK path in Editor Settings.") + " ";
  2570. err += TTR("Missing 'bin' directory!");
  2571. err += "\n";
  2572. valid = false;
  2573. } else {
  2574. // Check for the `java` command.
  2575. String java_path = get_java_path();
  2576. if (!FileAccess::exists(java_path)) {
  2577. err += TTR("Unable to find 'java' command using the Java SDK path.") + " ";
  2578. err += TTR("Please check the Java SDK directory specified in Editor Settings.");
  2579. err += "\n";
  2580. valid = false;
  2581. }
  2582. }
  2583. }
  2584. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2585. if (sdk_path.is_empty()) {
  2586. err += TTR("A valid Android SDK path is required in Editor Settings.") + "\n";
  2587. valid = false;
  2588. } else {
  2589. Error errn;
  2590. // Check for the platform-tools directory.
  2591. Ref<DirAccess> da = DirAccess::open(sdk_path.path_join("platform-tools"), &errn);
  2592. if (errn != OK) {
  2593. err += TTR("Invalid Android SDK path in Editor Settings.") + " ";
  2594. err += TTR("Missing 'platform-tools' directory!");
  2595. err += "\n";
  2596. valid = false;
  2597. }
  2598. // Validate that adb is available.
  2599. String adb_path = get_adb_path();
  2600. if (!FileAccess::exists(adb_path)) {
  2601. err += TTR("Unable to find Android SDK platform-tools' adb command.") + " ";
  2602. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  2603. err += "\n";
  2604. valid = false;
  2605. }
  2606. // Check for the build-tools directory.
  2607. Ref<DirAccess> build_tools_da = DirAccess::open(sdk_path.path_join("build-tools"), &errn);
  2608. if (errn != OK) {
  2609. err += TTR("Invalid Android SDK path in Editor Settings.") + " ";
  2610. err += TTR("Missing 'build-tools' directory!");
  2611. err += "\n";
  2612. valid = false;
  2613. }
  2614. String target_sdk_version = p_preset->get("gradle_build/target_sdk");
  2615. if (!target_sdk_version.is_valid_int()) {
  2616. target_sdk_version = itos(DEFAULT_TARGET_SDK_VERSION);
  2617. }
  2618. // Validate that apksigner is available.
  2619. String apksigner_path = get_apksigner_path(target_sdk_version.to_int());
  2620. if (!FileAccess::exists(apksigner_path)) {
  2621. err += TTR("Unable to find Android SDK build-tools' apksigner command.") + " ";
  2622. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  2623. err += "\n";
  2624. valid = false;
  2625. }
  2626. }
  2627. #endif
  2628. if (!err.is_empty()) {
  2629. r_error = err;
  2630. }
  2631. return valid;
  2632. }
  2633. bool EditorExportPlatformAndroid::has_valid_project_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error) const {
  2634. String err;
  2635. bool valid = true;
  2636. List<ExportOption> options;
  2637. get_export_options(&options);
  2638. for (const EditorExportPlatform::ExportOption &E : options) {
  2639. if (get_export_option_visibility(p_preset.ptr(), E.option.name)) {
  2640. String warn = get_export_option_warning(p_preset.ptr(), E.option.name);
  2641. if (!warn.is_empty()) {
  2642. err += warn + "\n";
  2643. if (E.required) {
  2644. valid = false;
  2645. }
  2646. }
  2647. }
  2648. }
  2649. if (!ResourceImporterTextureSettings::should_import_etc2_astc()) {
  2650. valid = false;
  2651. }
  2652. bool gradle_build_enabled = p_preset->get("gradle_build/use_gradle_build");
  2653. if (gradle_build_enabled) {
  2654. String build_version_path = ExportTemplateManager::get_android_build_directory(p_preset).get_base_dir().path_join(".build_version");
  2655. Ref<FileAccess> f = FileAccess::open(build_version_path, FileAccess::READ);
  2656. if (f.is_valid()) {
  2657. String current_version = ExportTemplateManager::get_android_template_identifier(p_preset);
  2658. String installed_version = f->get_line().strip_edges();
  2659. if (current_version != installed_version) {
  2660. err += vformat(TTR(MISMATCHED_VERSIONS_MESSAGE), installed_version, current_version);
  2661. err += "\n";
  2662. }
  2663. }
  2664. } else {
  2665. if (_is_transparency_allowed(p_preset)) {
  2666. // Warning only, so don't override `valid`.
  2667. err += vformat(TTR("\"Use Gradle Build\" is required for transparent background on Android"));
  2668. err += "\n";
  2669. }
  2670. }
  2671. String target_sdk_str = p_preset->get("gradle_build/target_sdk");
  2672. int target_sdk_int = DEFAULT_TARGET_SDK_VERSION;
  2673. if (!target_sdk_str.is_empty()) { // Empty means no override, nothing to do.
  2674. if (target_sdk_str.is_valid_int()) {
  2675. target_sdk_int = target_sdk_str.to_int();
  2676. if (target_sdk_int > DEFAULT_TARGET_SDK_VERSION) {
  2677. // Warning only, so don't override `valid`.
  2678. 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);
  2679. err += "\n";
  2680. }
  2681. }
  2682. }
  2683. String current_renderer = get_project_setting(p_preset, "rendering/renderer/rendering_method.mobile");
  2684. if (current_renderer == "forward_plus") {
  2685. // Warning only, so don't override `valid`.
  2686. err += vformat(TTR("The \"%s\" renderer is designed for Desktop devices, and is not suitable for Android devices."), current_renderer);
  2687. err += "\n";
  2688. }
  2689. String package_name = p_preset->get("package/unique_name");
  2690. if (package_name.contains("$genname") && !is_project_name_valid(p_preset)) {
  2691. // Warning only, so don't override `valid`.
  2692. 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(p_preset));
  2693. err += "\n";
  2694. }
  2695. r_error = err;
  2696. return valid;
  2697. }
  2698. List<String> EditorExportPlatformAndroid::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  2699. List<String> list;
  2700. list.push_back("apk");
  2701. list.push_back("aab");
  2702. return list;
  2703. }
  2704. String EditorExportPlatformAndroid::get_apk_expansion_fullpath(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  2705. int version_code = p_preset->get("version/code");
  2706. String package_name = p_preset->get("package/unique_name");
  2707. String apk_file_name = "main." + itos(version_code) + "." + get_package_name(p_preset, package_name) + ".obb";
  2708. String fullpath = p_path.get_base_dir().path_join(apk_file_name);
  2709. return fullpath;
  2710. }
  2711. Error EditorExportPlatformAndroid::save_apk_expansion_file(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  2712. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  2713. Error err = save_pack(p_preset, p_debug, fullpath);
  2714. return err;
  2715. }
  2716. 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) {
  2717. String cmdline = p_preset->get("command_line/extra_args");
  2718. Vector<String> command_line_strings = cmdline.strip_edges().split(" ");
  2719. for (int i = 0; i < command_line_strings.size(); i++) {
  2720. if (command_line_strings[i].strip_edges().length() == 0) {
  2721. command_line_strings.remove_at(i);
  2722. i--;
  2723. }
  2724. }
  2725. command_line_strings.append_array(gen_export_flags(p_flags));
  2726. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2727. if (apk_expansion) {
  2728. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  2729. String apk_expansion_public_key = p_preset->get("apk_expansion/public_key");
  2730. command_line_strings.push_back("--use_apk_expansion");
  2731. command_line_strings.push_back("--apk_expansion_md5");
  2732. command_line_strings.push_back(FileAccess::get_md5(fullpath));
  2733. command_line_strings.push_back("--apk_expansion_key");
  2734. command_line_strings.push_back(apk_expansion_public_key.strip_edges());
  2735. }
  2736. #ifndef XR_DISABLED
  2737. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  2738. if (xr_mode_index == XR_MODE_OPENXR) {
  2739. command_line_strings.push_back("--xr_mode_openxr");
  2740. } else { // XRMode.REGULAR is the default.
  2741. command_line_strings.push_back("--xr_mode_regular");
  2742. // Also override the 'xr/openxr/enabled' project setting.
  2743. // This is useful for multi-platforms projects supporting both XR and non-XR devices. The project would need
  2744. // to enable openxr for development, and would create multiple XR and non-XR export presets.
  2745. // These command line args ensure that the non-XR export presets will have openxr disabled.
  2746. command_line_strings.push_back("--xr-mode");
  2747. command_line_strings.push_back("off");
  2748. }
  2749. #endif // XR_DISABLED
  2750. bool immersive = p_preset->get("screen/immersive_mode");
  2751. if (immersive) {
  2752. command_line_strings.push_back("--fullscreen");
  2753. }
  2754. bool edge_to_edge = p_preset->get("screen/edge_to_edge");
  2755. if (edge_to_edge) {
  2756. command_line_strings.push_back("--edge_to_edge");
  2757. }
  2758. String background_color = "#" + p_preset->get("screen/background_color").operator Color().to_html(false);
  2759. // For Gradle build, _fix_themes_xml() sets background to transparent if _is_transparency_allowed().
  2760. // Overriding to transparent here too as it's used as fallback for system bar appearance.
  2761. if (_is_transparency_allowed(p_preset) && p_preset->get("gradle_build/use_gradle_build")) {
  2762. background_color = "#00000000";
  2763. }
  2764. command_line_strings.push_back("--background_color");
  2765. command_line_strings.push_back(background_color);
  2766. bool debug_opengl = p_preset->get("graphics/opengl_debug");
  2767. if (debug_opengl) {
  2768. command_line_strings.push_back("--debug_opengl");
  2769. }
  2770. if (command_line_strings.size()) {
  2771. r_command_line_flags.resize(4);
  2772. encode_uint32(command_line_strings.size(), &r_command_line_flags.write[0]);
  2773. for (int i = 0; i < command_line_strings.size(); i++) {
  2774. print_line(itos(i) + " param: " + command_line_strings[i]);
  2775. CharString command_line_argument = command_line_strings[i].utf8();
  2776. int base = r_command_line_flags.size();
  2777. int length = command_line_argument.length();
  2778. if (length == 0) {
  2779. continue;
  2780. }
  2781. r_command_line_flags.resize(base + 4 + length);
  2782. encode_uint32(length, &r_command_line_flags.write[base]);
  2783. memcpy(&r_command_line_flags.write[base + 4], command_line_argument.ptr(), length);
  2784. }
  2785. }
  2786. }
  2787. Error EditorExportPlatformAndroid::sign_apk(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &export_path, EditorProgress &ep) {
  2788. int export_format = int(p_preset->get("gradle_build/export_format"));
  2789. if (export_format == EXPORT_FORMAT_AAB) {
  2790. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("AAB signing is not supported"));
  2791. return FAILED;
  2792. }
  2793. String keystore;
  2794. String password;
  2795. String user;
  2796. if (p_debug) {
  2797. keystore = _get_keystore_path(p_preset, true);
  2798. password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  2799. user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  2800. if (keystore.is_empty()) {
  2801. keystore = EDITOR_GET("export/android/debug_keystore");
  2802. password = EDITOR_GET("export/android/debug_keystore_pass");
  2803. user = EDITOR_GET("export/android/debug_keystore_user");
  2804. }
  2805. if (ep.step(TTR("Signing debug APK..."), 104)) {
  2806. return ERR_SKIP;
  2807. }
  2808. } else {
  2809. keystore = _get_keystore_path(p_preset, false);
  2810. password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  2811. user = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  2812. if (ep.step(TTR("Signing release APK..."), 104)) {
  2813. return ERR_SKIP;
  2814. }
  2815. }
  2816. if (!FileAccess::exists(keystore)) {
  2817. if (p_debug) {
  2818. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not find debug keystore, unable to export."));
  2819. } else {
  2820. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not find release keystore, unable to export."));
  2821. }
  2822. return ERR_FILE_CANT_OPEN;
  2823. }
  2824. String apk_path = export_path;
  2825. if (apk_path.is_relative_path()) {
  2826. apk_path = OS::get_singleton()->get_resource_dir().path_join(apk_path);
  2827. }
  2828. apk_path = ProjectSettings::get_singleton()->globalize_path(apk_path).simplify_path();
  2829. Error err;
  2830. #ifdef ANDROID_ENABLED
  2831. err = OS_Android::get_singleton()->sign_apk(apk_path, apk_path, keystore, user, password);
  2832. if (err != OK) {
  2833. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Unable to sign apk."));
  2834. return err;
  2835. }
  2836. #else
  2837. String target_sdk_version = p_preset->get("gradle_build/target_sdk");
  2838. if (!target_sdk_version.is_valid_int()) {
  2839. target_sdk_version = itos(DEFAULT_TARGET_SDK_VERSION);
  2840. }
  2841. String apksigner = get_apksigner_path(target_sdk_version.to_int(), true);
  2842. print_verbose("Starting signing of the APK binary using " + apksigner);
  2843. if (apksigner == "<FAILED>") {
  2844. 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."));
  2845. return OK;
  2846. }
  2847. if (!FileAccess::exists(apksigner)) {
  2848. 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."));
  2849. return OK;
  2850. }
  2851. String output;
  2852. List<String> args;
  2853. args.push_back("sign");
  2854. args.push_back("--verbose");
  2855. args.push_back("--ks");
  2856. args.push_back(keystore);
  2857. args.push_back("--ks-pass");
  2858. args.push_back("pass:" + password);
  2859. args.push_back("--ks-key-alias");
  2860. args.push_back(user);
  2861. args.push_back(apk_path);
  2862. if (OS::get_singleton()->is_stdout_verbose() && p_debug) {
  2863. // We only print verbose logs with credentials for debug builds to avoid leaking release keystore credentials.
  2864. print_verbose("Signing debug binary using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2865. } else {
  2866. List<String> redacted_args = List<String>(args);
  2867. redacted_args.find(keystore)->set("<REDACTED>");
  2868. redacted_args.find("pass:" + password)->set("pass:<REDACTED>");
  2869. redacted_args.find(user)->set("<REDACTED>");
  2870. print_line("Signing binary using: " + String("\n") + apksigner + " " + join_list(redacted_args, String(" ")));
  2871. }
  2872. int retval;
  2873. err = OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2874. if (err != OK) {
  2875. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start apksigner executable."));
  2876. return err;
  2877. }
  2878. // By design, apksigner does not output credentials in its output unless --verbose is used
  2879. print_line(output);
  2880. if (retval) {
  2881. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("'apksigner' returned with error #%d"), retval));
  2882. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("output: \n%s"), output));
  2883. return ERR_CANT_CREATE;
  2884. }
  2885. #endif
  2886. if (ep.step(TTR("Verifying APK..."), 105)) {
  2887. return ERR_SKIP;
  2888. }
  2889. #ifdef ANDROID_ENABLED
  2890. err = OS_Android::get_singleton()->verify_apk(apk_path);
  2891. if (err != OK) {
  2892. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Unable to verify signed apk."));
  2893. return err;
  2894. }
  2895. #else
  2896. args.clear();
  2897. args.push_back("verify");
  2898. args.push_back("--verbose");
  2899. args.push_back(apk_path);
  2900. if (p_debug) {
  2901. print_verbose("Verifying signed build using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2902. }
  2903. output.clear();
  2904. err = OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2905. if (err != OK) {
  2906. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start apksigner executable."));
  2907. return err;
  2908. }
  2909. print_verbose(output);
  2910. if (retval) {
  2911. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("'apksigner' verification of APK failed."));
  2912. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("output: \n%s"), output));
  2913. return ERR_CANT_CREATE;
  2914. }
  2915. #endif
  2916. print_verbose("Successfully completed signing build.");
  2917. #ifdef ANDROID_ENABLED
  2918. bool prompt_apk_install = EDITOR_GET("export/android/install_exported_apk");
  2919. if (prompt_apk_install) {
  2920. OS_Android::get_singleton()->shell_open(apk_path);
  2921. }
  2922. #endif
  2923. return OK;
  2924. }
  2925. void EditorExportPlatformAndroid::_clear_assets_directory(const Ref<EditorExportPreset> &p_preset) {
  2926. Ref<DirAccess> da_res = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2927. String gradle_build_directory = ExportTemplateManager::get_android_build_directory(p_preset);
  2928. // Clear the APK assets directory
  2929. String apk_assets_directory = gradle_build_directory.path_join(APK_ASSETS_DIRECTORY);
  2930. if (da_res->dir_exists(apk_assets_directory)) {
  2931. print_verbose("Clearing APK assets directory...");
  2932. Ref<DirAccess> da_assets = DirAccess::open(apk_assets_directory);
  2933. ERR_FAIL_COND(da_assets.is_null());
  2934. da_assets->erase_contents_recursive();
  2935. da_res->remove(apk_assets_directory);
  2936. }
  2937. // Clear the AAB assets directory
  2938. String aab_assets_directory = gradle_build_directory.path_join(AAB_ASSETS_DIRECTORY);
  2939. if (da_res->dir_exists(aab_assets_directory)) {
  2940. print_verbose("Clearing AAB assets directory...");
  2941. Ref<DirAccess> da_assets = DirAccess::open(aab_assets_directory);
  2942. ERR_FAIL_COND(da_assets.is_null());
  2943. da_assets->erase_contents_recursive();
  2944. da_res->remove(aab_assets_directory);
  2945. }
  2946. }
  2947. void EditorExportPlatformAndroid::_remove_copied_libs(String p_gdextension_libs_path) {
  2948. print_verbose("Removing previously installed libraries...");
  2949. Error error;
  2950. String libs_json = FileAccess::get_file_as_string(p_gdextension_libs_path, &error);
  2951. if (error || libs_json.is_empty()) {
  2952. print_verbose("No previously installed libraries found");
  2953. return;
  2954. }
  2955. JSON json;
  2956. error = json.parse(libs_json);
  2957. ERR_FAIL_COND_MSG(error, "Error parsing \"" + libs_json + "\" on line " + itos(json.get_error_line()) + ": " + json.get_error_message());
  2958. Vector<String> libs = json.get_data();
  2959. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2960. for (int i = 0; i < libs.size(); i++) {
  2961. print_verbose("Removing previously installed library " + libs[i]);
  2962. da->remove(libs[i]);
  2963. }
  2964. da->remove(p_gdextension_libs_path);
  2965. }
  2966. String EditorExportPlatformAndroid::join_list(const List<String> &p_parts, const String &p_separator) {
  2967. String ret;
  2968. for (List<String>::ConstIterator itr = p_parts.begin(); itr != p_parts.end(); ++itr) {
  2969. if (itr != p_parts.begin()) {
  2970. ret += p_separator;
  2971. }
  2972. ret += *itr;
  2973. }
  2974. return ret;
  2975. }
  2976. String EditorExportPlatformAndroid::join_abis(const Vector<EditorExportPlatformAndroid::ABI> &p_parts, const String &p_separator, bool p_use_arch) {
  2977. String ret;
  2978. for (int i = 0; i < p_parts.size(); ++i) {
  2979. if (i > 0) {
  2980. ret += p_separator;
  2981. }
  2982. ret += (p_use_arch) ? p_parts[i].arch : p_parts[i].abi;
  2983. }
  2984. return ret;
  2985. }
  2986. String EditorExportPlatformAndroid::_get_deprecated_plugins_names(const Ref<EditorExportPreset> &p_preset) const {
  2987. Vector<String> names;
  2988. #ifndef DISABLE_DEPRECATED
  2989. PluginConfigAndroid::get_plugins_names(get_enabled_plugins(p_preset), names);
  2990. #endif // DISABLE_DEPRECATED
  2991. String plugins_names = String("|").join(names);
  2992. return plugins_names;
  2993. }
  2994. String EditorExportPlatformAndroid::_get_plugins_names(const Ref<EditorExportPreset> &p_preset) const {
  2995. Vector<String> names;
  2996. #ifndef DISABLE_DEPRECATED
  2997. PluginConfigAndroid::get_plugins_names(get_enabled_plugins(p_preset), names);
  2998. #endif // DISABLE_DEPRECATED
  2999. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  3000. for (int i = 0; i < export_plugins.size(); i++) {
  3001. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  3002. names.push_back(export_plugins[i]->get_name());
  3003. }
  3004. }
  3005. String plugins_names = String("|").join(names);
  3006. return plugins_names;
  3007. }
  3008. String EditorExportPlatformAndroid::_resolve_export_plugin_android_library_path(const String &p_android_library_path) const {
  3009. String absolute_path;
  3010. if (!p_android_library_path.is_empty()) {
  3011. if (p_android_library_path.is_absolute_path()) {
  3012. absolute_path = ProjectSettings::get_singleton()->globalize_path(p_android_library_path);
  3013. } else {
  3014. const String export_plugin_absolute_path = String("res://addons/").path_join(p_android_library_path);
  3015. absolute_path = ProjectSettings::get_singleton()->globalize_path(export_plugin_absolute_path);
  3016. }
  3017. }
  3018. return absolute_path;
  3019. }
  3020. bool EditorExportPlatformAndroid::_is_clean_build_required(const Ref<EditorExportPreset> &p_preset) {
  3021. bool first_build = last_gradle_build_time == 0;
  3022. bool have_plugins_changed = false;
  3023. String gradle_build_dir = ExportTemplateManager::get_android_build_directory(p_preset);
  3024. bool has_build_dir_changed = last_gradle_build_dir != gradle_build_dir;
  3025. String plugin_names = _get_plugins_names(p_preset);
  3026. if (!first_build) {
  3027. have_plugins_changed = plugin_names != last_plugin_names;
  3028. #ifndef DISABLE_DEPRECATED
  3029. if (!have_plugins_changed) {
  3030. Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
  3031. for (int i = 0; i < enabled_plugins.size(); i++) {
  3032. if (enabled_plugins.get(i).last_updated > last_gradle_build_time) {
  3033. have_plugins_changed = true;
  3034. break;
  3035. }
  3036. }
  3037. }
  3038. #endif // DISABLE_DEPRECATED
  3039. }
  3040. last_gradle_build_time = OS::get_singleton()->get_unix_time();
  3041. last_gradle_build_dir = gradle_build_dir;
  3042. last_plugin_names = plugin_names;
  3043. return have_plugins_changed || has_build_dir_changed || first_build;
  3044. }
  3045. Error EditorExportPlatformAndroid::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags) {
  3046. int export_format = int(p_preset->get("gradle_build/export_format"));
  3047. bool should_sign = p_preset->get("package/signed");
  3048. return export_project_helper(p_preset, p_debug, p_path, export_format, should_sign, p_flags);
  3049. }
  3050. Error EditorExportPlatformAndroid::_generate_sparse_pck_metadata(const Ref<EditorExportPreset> &p_preset, PackData &p_pack_data, Vector<uint8_t> &r_data) {
  3051. Error err;
  3052. Ref<FileAccess> ftmp = FileAccess::create_temp(FileAccess::WRITE_READ, "export_index", "tmp", false, &err);
  3053. if (err != OK) {
  3054. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Could not create temporary file!"));
  3055. return err;
  3056. }
  3057. int64_t pck_start_pos = ftmp->get_position();
  3058. uint64_t file_base_ofs = 0;
  3059. uint64_t dir_base_ofs = 0;
  3060. EditorExportPlatform::_store_header(ftmp, p_preset->get_enc_pck() && p_preset->get_enc_directory(), true, file_base_ofs, dir_base_ofs);
  3061. // Write directory.
  3062. uint64_t dir_offset = ftmp->get_position();
  3063. ftmp->seek(dir_base_ofs);
  3064. ftmp->store_64(dir_offset - pck_start_pos);
  3065. ftmp->seek(dir_offset);
  3066. Vector<uint8_t> key;
  3067. if (p_preset->get_enc_pck() && p_preset->get_enc_directory()) {
  3068. String script_key = _get_script_encryption_key(p_preset);
  3069. key.resize(32);
  3070. if (script_key.length() == 64) {
  3071. for (int i = 0; i < 32; i++) {
  3072. int v = 0;
  3073. if (i * 2 < script_key.length()) {
  3074. char32_t ct = script_key[i * 2];
  3075. if (is_digit(ct)) {
  3076. ct = ct - '0';
  3077. } else if (ct >= 'a' && ct <= 'f') {
  3078. ct = 10 + ct - 'a';
  3079. }
  3080. v |= ct << 4;
  3081. }
  3082. if (i * 2 + 1 < script_key.length()) {
  3083. char32_t ct = script_key[i * 2 + 1];
  3084. if (is_digit(ct)) {
  3085. ct = ct - '0';
  3086. } else if (ct >= 'a' && ct <= 'f') {
  3087. ct = 10 + ct - 'a';
  3088. }
  3089. v |= ct;
  3090. }
  3091. key.write[i] = v;
  3092. }
  3093. }
  3094. }
  3095. if (!EditorExportPlatform::_encrypt_and_store_directory(ftmp, p_pack_data, key, p_preset->get_seed(), 0)) {
  3096. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Can't create encrypted file."));
  3097. return ERR_CANT_CREATE;
  3098. }
  3099. r_data.resize(ftmp->get_length());
  3100. ftmp->seek(0);
  3101. ftmp->get_buffer(r_data.ptrw(), r_data.size());
  3102. ftmp.unref();
  3103. return OK;
  3104. }
  3105. 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) {
  3106. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  3107. const String base_dir = p_path.get_base_dir();
  3108. if (!DirAccess::exists(base_dir)) {
  3109. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Target folder does not exist or is inaccessible: \"%s\""), base_dir));
  3110. return ERR_FILE_BAD_PATH;
  3111. }
  3112. String src_apk;
  3113. Error err;
  3114. EditorProgress ep("export", TTR("Exporting for Android"), 105, true);
  3115. bool use_gradle_build = bool(p_preset->get("gradle_build/use_gradle_build"));
  3116. String gradle_build_directory = use_gradle_build ? ExportTemplateManager::get_android_build_directory(p_preset) : "";
  3117. bool p_give_internet = p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT) || p_flags.has_flag(DEBUG_FLAG_REMOTE_DEBUG);
  3118. bool apk_expansion = p_preset->get("apk_expansion/enable");
  3119. Vector<ABI> enabled_abis = get_enabled_abis(p_preset);
  3120. print_verbose("Exporting for Android...");
  3121. print_verbose("- debug build: " + bool_to_string(p_debug));
  3122. print_verbose("- export path: " + p_path);
  3123. print_verbose("- export format: " + itos(export_format));
  3124. print_verbose("- sign build: " + bool_to_string(should_sign));
  3125. print_verbose("- gradle build enabled: " + bool_to_string(use_gradle_build));
  3126. print_verbose("- apk expansion enabled: " + bool_to_string(apk_expansion));
  3127. print_verbose("- enabled abis: " + join_abis(enabled_abis, ",", false));
  3128. print_verbose("- export filter: " + itos(p_preset->get_export_filter()));
  3129. print_verbose("- include filter: " + p_preset->get_include_filter());
  3130. print_verbose("- exclude filter: " + p_preset->get_exclude_filter());
  3131. Ref<Image> main_image;
  3132. Ref<Image> foreground;
  3133. Ref<Image> background;
  3134. Ref<Image> monochrome;
  3135. load_icon_refs(p_preset, main_image, foreground, background, monochrome);
  3136. Vector<uint8_t> command_line_flags;
  3137. // Write command line flags into the command_line_flags variable.
  3138. get_command_line_flags(p_preset, p_path, p_flags, command_line_flags);
  3139. if (export_format == EXPORT_FORMAT_AAB) {
  3140. if (!p_path.ends_with(".aab")) {
  3141. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Invalid filename! Android App Bundle requires the *.aab extension."));
  3142. return ERR_UNCONFIGURED;
  3143. }
  3144. if (apk_expansion) {
  3145. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("APK Expansion not compatible with Android App Bundle."));
  3146. return ERR_UNCONFIGURED;
  3147. }
  3148. }
  3149. if (export_format == EXPORT_FORMAT_APK && !p_path.ends_with(".apk")) {
  3150. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Invalid filename! Android APK requires the *.apk extension."));
  3151. return ERR_UNCONFIGURED;
  3152. }
  3153. if (export_format > EXPORT_FORMAT_AAB || export_format < EXPORT_FORMAT_APK) {
  3154. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Unsupported export format!"));
  3155. return ERR_UNCONFIGURED;
  3156. }
  3157. String err_string;
  3158. if (!has_valid_username_and_password(p_preset, err_string)) {
  3159. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR(err_string));
  3160. return ERR_UNCONFIGURED;
  3161. }
  3162. if (use_gradle_build) {
  3163. print_verbose("Starting gradle build...");
  3164. //test that installed build version is alright
  3165. {
  3166. print_verbose("Checking build version...");
  3167. String gradle_base_directory = gradle_build_directory.get_base_dir();
  3168. Ref<FileAccess> f = FileAccess::open(gradle_base_directory.path_join(".build_version"), FileAccess::READ);
  3169. if (f.is_null()) {
  3170. 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."));
  3171. return ERR_UNCONFIGURED;
  3172. }
  3173. String current_version = ExportTemplateManager::get_android_template_identifier(p_preset);
  3174. String installed_version = f->get_line().strip_edges();
  3175. print_verbose("- build version: " + installed_version);
  3176. if (installed_version != current_version) {
  3177. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR(MISMATCHED_VERSIONS_MESSAGE), installed_version, current_version));
  3178. return ERR_UNCONFIGURED;
  3179. }
  3180. }
  3181. const String assets_directory = get_assets_directory(p_preset, export_format);
  3182. String java_sdk_path = EDITOR_GET("export/android/java_sdk_path");
  3183. if (java_sdk_path.is_empty()) {
  3184. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Java SDK path must be configured in Editor Settings at 'export/android/java_sdk_path'."));
  3185. return ERR_UNCONFIGURED;
  3186. }
  3187. print_verbose("Java sdk path: " + java_sdk_path);
  3188. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  3189. if (sdk_path.is_empty()) {
  3190. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Android SDK path must be configured in Editor Settings at 'export/android/android_sdk_path'."));
  3191. return ERR_UNCONFIGURED;
  3192. }
  3193. print_verbose("Android sdk path: " + sdk_path);
  3194. // TODO: should we use "package/name" or "application/config/name"?
  3195. String project_name = get_project_name(p_preset, p_preset->get("package/name"));
  3196. err = _create_project_name_strings_files(p_preset, project_name, gradle_build_directory, get_project_setting(p_preset, "application/config/name_localized")); //project name localization.
  3197. if (err != OK) {
  3198. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Unable to overwrite res/*.xml files with project name."));
  3199. }
  3200. // Copies the project icon files into the appropriate Gradle project directory.
  3201. _copy_icons_to_gradle_project(p_preset, main_image, foreground, background, monochrome);
  3202. // Write an AndroidManifest.xml file into the Gradle project directory.
  3203. _write_tmp_manifest(p_preset, p_give_internet, p_debug);
  3204. // Modify res/values/themes.xml file.
  3205. _fix_themes_xml(p_preset);
  3206. //stores all the project files inside the Gradle project directory. Also includes all ABIs
  3207. _clear_assets_directory(p_preset);
  3208. String gdextension_libs_path = gradle_build_directory.path_join(GDEXTENSION_LIBS_PATH);
  3209. _remove_copied_libs(gdextension_libs_path);
  3210. if (!apk_expansion) {
  3211. print_verbose("Exporting project files...");
  3212. CustomExportData user_data;
  3213. user_data.assets_directory = assets_directory;
  3214. user_data.libs_directory = gradle_build_directory.path_join("libs");
  3215. user_data.debug = p_debug;
  3216. if (p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  3217. err = export_project_files(p_preset, p_debug, ignore_apk_file, nullptr, &user_data, copy_gradle_so);
  3218. } else {
  3219. user_data.pd.path = "assets.sparsepck";
  3220. user_data.pd.use_sparse_pck = true;
  3221. err = export_project_files(p_preset, p_debug, rename_and_store_file_in_gradle_project, nullptr, &user_data, copy_gradle_so);
  3222. Vector<uint8_t> enc_data;
  3223. err = _generate_sparse_pck_metadata(p_preset, user_data.pd, enc_data);
  3224. if (err != OK) {
  3225. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Could not generate sparse pck metadata!"));
  3226. return err;
  3227. }
  3228. err = store_file_at_path(user_data.assets_directory + "/assets.sparsepck", enc_data);
  3229. if (err != OK) {
  3230. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Could not write PCK directory!"));
  3231. return err;
  3232. }
  3233. }
  3234. if (err != OK) {
  3235. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not export project files to gradle project."));
  3236. return err;
  3237. }
  3238. if (user_data.libs.size() > 0) {
  3239. Ref<FileAccess> fa = FileAccess::open(gdextension_libs_path, FileAccess::WRITE);
  3240. fa->store_string(JSON::stringify(user_data.libs, "\t"));
  3241. }
  3242. } else {
  3243. print_verbose("Saving apk expansion file...");
  3244. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  3245. if (err != OK) {
  3246. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not write expansion package file!"));
  3247. return err;
  3248. }
  3249. }
  3250. print_verbose("Storing command line flags...");
  3251. store_file_at_path(assets_directory + "/_cl_", command_line_flags);
  3252. print_verbose("Updating JAVA_HOME environment to " + java_sdk_path);
  3253. OS::get_singleton()->set_environment("JAVA_HOME", java_sdk_path);
  3254. print_verbose("Updating ANDROID_HOME environment to " + sdk_path);
  3255. OS::get_singleton()->set_environment("ANDROID_HOME", sdk_path);
  3256. String build_command;
  3257. #ifdef WINDOWS_ENABLED
  3258. build_command = "gradlew.bat";
  3259. #else
  3260. build_command = "gradlew";
  3261. #endif
  3262. String build_path = ProjectSettings::get_singleton()->globalize_path(gradle_build_directory);
  3263. build_command = build_path.path_join(build_command);
  3264. String package_name = get_package_name(p_preset, p_preset->get("package/unique_name"));
  3265. String version_code = itos(p_preset->get("version/code"));
  3266. String version_name = p_preset->get_version("version/name");
  3267. String min_sdk_version = p_preset->get("gradle_build/min_sdk");
  3268. if (!min_sdk_version.is_valid_int()) {
  3269. min_sdk_version = itos(DEFAULT_MIN_SDK_VERSION);
  3270. }
  3271. String target_sdk_version = p_preset->get("gradle_build/target_sdk");
  3272. if (!target_sdk_version.is_valid_int()) {
  3273. target_sdk_version = itos(DEFAULT_TARGET_SDK_VERSION);
  3274. }
  3275. String enabled_abi_string = join_abis(enabled_abis, "|", false);
  3276. String sign_flag = bool_to_string(should_sign);
  3277. String zipalign_flag = "true";
  3278. String compress_native_libraries_flag = bool_to_string(p_preset->get("gradle_build/compress_native_libraries"));
  3279. Vector<String> android_libraries;
  3280. Vector<String> android_dependencies;
  3281. Vector<String> android_dependencies_maven_repos;
  3282. #ifndef DISABLE_DEPRECATED
  3283. Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
  3284. PluginConfigAndroid::get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_LOCAL, enabled_plugins, android_libraries);
  3285. PluginConfigAndroid::get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_REMOTE, enabled_plugins, android_dependencies);
  3286. PluginConfigAndroid::get_plugins_custom_maven_repos(enabled_plugins, android_dependencies_maven_repos);
  3287. #endif // DISABLE_DEPRECATED
  3288. bool has_dotnet_project = false;
  3289. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  3290. for (int i = 0; i < export_plugins.size(); i++) {
  3291. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  3292. PackedStringArray export_plugin_android_libraries = export_plugins[i]->get_android_libraries(Ref<EditorExportPlatform>(this), p_debug);
  3293. for (int k = 0; k < export_plugin_android_libraries.size(); k++) {
  3294. const String resolved_android_library_path = _resolve_export_plugin_android_library_path(export_plugin_android_libraries[k]);
  3295. if (!resolved_android_library_path.is_empty()) {
  3296. android_libraries.push_back(resolved_android_library_path);
  3297. }
  3298. }
  3299. PackedStringArray export_plugin_android_dependencies = export_plugins[i]->get_android_dependencies(Ref<EditorExportPlatform>(this), p_debug);
  3300. android_dependencies.append_array(export_plugin_android_dependencies);
  3301. PackedStringArray export_plugin_android_dependencies_maven_repos = export_plugins[i]->get_android_dependencies_maven_repos(Ref<EditorExportPlatform>(this), p_debug);
  3302. android_dependencies_maven_repos.append_array(export_plugin_android_dependencies_maven_repos);
  3303. }
  3304. PackedStringArray features = export_plugins[i]->get_export_features(Ref<EditorExportPlatform>(this), p_debug);
  3305. if (features.has("dotnet")) {
  3306. has_dotnet_project = true;
  3307. }
  3308. }
  3309. bool clean_build_required = _is_clean_build_required(p_preset);
  3310. String combined_android_libraries = String("|").join(android_libraries);
  3311. String combined_android_dependencies = String("|").join(android_dependencies);
  3312. String combined_android_dependencies_maven_repos = String("|").join(android_dependencies_maven_repos);
  3313. List<String> cmdline;
  3314. cmdline.push_back("validateJavaVersion");
  3315. if (clean_build_required) {
  3316. cmdline.push_back("clean");
  3317. }
  3318. String edition = has_dotnet_project ? "Mono" : "Standard";
  3319. String build_type = p_debug ? "Debug" : "Release";
  3320. if (export_format == EXPORT_FORMAT_AAB) {
  3321. String bundle_build_command = vformat("bundle%s%s", edition, build_type);
  3322. cmdline.push_back(bundle_build_command);
  3323. } else if (export_format == EXPORT_FORMAT_APK) {
  3324. String apk_build_command = vformat("assemble%s%s", edition, build_type);
  3325. cmdline.push_back(apk_build_command);
  3326. }
  3327. String addons_directory = ProjectSettings::get_singleton()->globalize_path("res://addons");
  3328. cmdline.push_back("-p"); // argument to specify the start directory.
  3329. cmdline.push_back(build_path); // start directory.
  3330. cmdline.push_back("-Paddons_directory=" + addons_directory); // path to the addon directory as it may contain jar or aar dependencies
  3331. cmdline.push_back("-Pexport_package_name=" + package_name); // argument to specify the package name.
  3332. cmdline.push_back("-Pexport_version_code=" + version_code); // argument to specify the version code.
  3333. cmdline.push_back("-Pexport_version_name=" + version_name); // argument to specify the version name.
  3334. cmdline.push_back("-Pexport_version_min_sdk=" + min_sdk_version); // argument to specify the min sdk.
  3335. cmdline.push_back("-Pexport_version_target_sdk=" + target_sdk_version); // argument to specify the target sdk.
  3336. cmdline.push_back("-Pexport_enabled_abis=" + enabled_abi_string); // argument to specify enabled ABIs.
  3337. cmdline.push_back("-Pplugins_local_binaries=" + combined_android_libraries); // argument to specify the list of android libraries provided by plugins.
  3338. cmdline.push_back("-Pplugins_remote_binaries=" + combined_android_dependencies); // argument to specify the list of android dependencies provided by plugins.
  3339. 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.
  3340. cmdline.push_back("-Pperform_zipalign=" + zipalign_flag); // argument to specify whether the build should be zipaligned.
  3341. cmdline.push_back("-Pperform_signing=" + sign_flag); // argument to specify whether the build should be signed.
  3342. cmdline.push_back("-Pcompress_native_libraries=" + compress_native_libraries_flag); // argument to specify whether the build should compress native libraries.
  3343. // NOTE: The release keystore is not included in the verbose logging
  3344. // to avoid accidentally leaking sensitive information when sharing verbose logs for troubleshooting.
  3345. // Any non-sensitive additions to the command line arguments must be done above this section.
  3346. // Sensitive additions must be done below the logging statement.
  3347. print_verbose("Build Android project using gradle command: " + String("\n") + build_command + " " + join_list(cmdline, String(" ")));
  3348. if (should_sign) {
  3349. if (p_debug) {
  3350. String debug_keystore = _get_keystore_path(p_preset, true);
  3351. String debug_password = p_preset->get_or_env("keystore/debug_password", ENV_ANDROID_KEYSTORE_DEBUG_PASS);
  3352. String debug_user = p_preset->get_or_env("keystore/debug_user", ENV_ANDROID_KEYSTORE_DEBUG_USER);
  3353. if (debug_keystore.is_empty()) {
  3354. debug_keystore = EDITOR_GET("export/android/debug_keystore");
  3355. debug_password = EDITOR_GET("export/android/debug_keystore_pass");
  3356. debug_user = EDITOR_GET("export/android/debug_keystore_user");
  3357. }
  3358. if (debug_keystore.is_relative_path()) {
  3359. debug_keystore = OS::get_singleton()->get_resource_dir().path_join(debug_keystore).simplify_path();
  3360. }
  3361. if (!FileAccess::exists(debug_keystore)) {
  3362. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Could not find debug keystore, unable to export."));
  3363. return ERR_FILE_CANT_OPEN;
  3364. }
  3365. cmdline.push_back("-Pdebug_keystore_file=" + debug_keystore); // argument to specify the debug keystore file.
  3366. cmdline.push_back("-Pdebug_keystore_alias=" + debug_user); // argument to specify the debug keystore alias.
  3367. cmdline.push_back("-Pdebug_keystore_password=" + debug_password); // argument to specify the debug keystore password.
  3368. } else {
  3369. // Pass the release keystore info as well
  3370. String release_keystore = _get_keystore_path(p_preset, false);
  3371. String release_username = p_preset->get_or_env("keystore/release_user", ENV_ANDROID_KEYSTORE_RELEASE_USER);
  3372. String release_password = p_preset->get_or_env("keystore/release_password", ENV_ANDROID_KEYSTORE_RELEASE_PASS);
  3373. if (release_keystore.is_relative_path()) {
  3374. release_keystore = OS::get_singleton()->get_resource_dir().path_join(release_keystore).simplify_path();
  3375. }
  3376. if (!FileAccess::exists(release_keystore)) {
  3377. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Could not find release keystore, unable to export."));
  3378. return ERR_FILE_CANT_OPEN;
  3379. }
  3380. cmdline.push_back("-Prelease_keystore_file=" + release_keystore); // argument to specify the release keystore file.
  3381. cmdline.push_back("-Prelease_keystore_alias=" + release_username); // argument to specify the release keystore alias.
  3382. cmdline.push_back("-Prelease_keystore_password=" + release_password); // argument to specify the release keystore password.
  3383. }
  3384. }
  3385. String build_project_output;
  3386. int result = EditorNode::get_singleton()->execute_and_show_output(TTR("Building Android Project (gradle)"), build_command, cmdline, true, false, &build_project_output);
  3387. if (result != 0) {
  3388. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Building of Android project failed, check output for the error:") + "\n\n" + build_project_output);
  3389. return ERR_CANT_CREATE;
  3390. } else {
  3391. print_verbose(build_project_output);
  3392. }
  3393. List<String> copy_args;
  3394. String copy_command = "copyAndRenameBinary";
  3395. copy_args.push_back(copy_command);
  3396. copy_args.push_back("-p"); // argument to specify the start directory.
  3397. copy_args.push_back(build_path); // start directory.
  3398. copy_args.push_back("-Pexport_edition=" + edition.to_lower());
  3399. copy_args.push_back("-Pexport_build_type=" + build_type.to_lower());
  3400. String export_format_arg = export_format == EXPORT_FORMAT_AAB ? "aab" : "apk";
  3401. copy_args.push_back("-Pexport_format=" + export_format_arg);
  3402. String export_filename = p_path.get_file();
  3403. String export_path = p_path.get_base_dir();
  3404. if (export_path.is_relative_path()) {
  3405. export_path = OS::get_singleton()->get_resource_dir().path_join(export_path);
  3406. }
  3407. export_path = ProjectSettings::get_singleton()->globalize_path(export_path).simplify_path();
  3408. copy_args.push_back("-Pexport_path=file:" + export_path);
  3409. copy_args.push_back("-Pexport_filename=" + export_filename);
  3410. print_verbose("Copying Android binary using gradle command: " + String("\n") + build_command + " " + join_list(copy_args, String(" ")));
  3411. String copy_binary_output;
  3412. int copy_result = EditorNode::get_singleton()->execute_and_show_output(TTR("Moving output"), build_command, copy_args, true, false, &copy_binary_output);
  3413. if (copy_result != 0) {
  3414. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Unable to copy and rename export file:") + "\n\n" + copy_binary_output);
  3415. return ERR_CANT_CREATE;
  3416. } else {
  3417. print_verbose(copy_binary_output);
  3418. }
  3419. print_verbose("Successfully completed Android gradle build.");
  3420. return OK;
  3421. }
  3422. // This is the start of the Legacy build system
  3423. print_verbose("Starting legacy build system...");
  3424. if (p_debug) {
  3425. src_apk = p_preset->get("custom_template/debug");
  3426. } else {
  3427. src_apk = p_preset->get("custom_template/release");
  3428. }
  3429. src_apk = src_apk.strip_edges();
  3430. if (src_apk.is_empty()) {
  3431. if (p_debug) {
  3432. src_apk = find_export_template("android_debug.apk");
  3433. } else {
  3434. src_apk = find_export_template("android_release.apk");
  3435. }
  3436. if (src_apk.is_empty()) {
  3437. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(p_debug ? TTR("Debug export template not found: \"%s\".") : TTR("Release export template not found: \"%s\"."), src_apk));
  3438. return ERR_FILE_NOT_FOUND;
  3439. }
  3440. }
  3441. Ref<FileAccess> io_fa;
  3442. zlib_filefunc_def io = zipio_create_io(&io_fa);
  3443. if (ep.step(TTR("Creating APK..."), 0)) {
  3444. return ERR_SKIP;
  3445. }
  3446. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  3447. if (!pkg) {
  3448. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not find template APK to export: \"%s\"."), src_apk));
  3449. return ERR_FILE_NOT_FOUND;
  3450. }
  3451. int ret = unzGoToFirstFile(pkg);
  3452. Ref<FileAccess> io2_fa;
  3453. zlib_filefunc_def io2 = zipio_create_io(&io2_fa);
  3454. String tmp_unaligned_path = EditorPaths::get_singleton()->get_temp_dir().path_join("tmpexport-unaligned." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  3455. #define CLEANUP_AND_RETURN(m_err) \
  3456. { \
  3457. DirAccess::remove_file_or_error(tmp_unaligned_path); \
  3458. return m_err; \
  3459. } \
  3460. ((void)0)
  3461. zipFile unaligned_apk = zipOpen2(tmp_unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  3462. String cmdline = p_preset->get("command_line/extra_args");
  3463. String version_name = p_preset->get_version("version/name");
  3464. String package_name = p_preset->get("package/unique_name");
  3465. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  3466. Vector<ABI> invalid_abis(enabled_abis);
  3467. //To temporarily store icon xml data.
  3468. Vector<uint8_t> themed_icon_xml_data;
  3469. int icon_xml_compression_method = -1;
  3470. while (ret == UNZ_OK) {
  3471. //get filename
  3472. unz_file_info info;
  3473. char fname[16384];
  3474. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  3475. if (ret != UNZ_OK) {
  3476. break;
  3477. }
  3478. bool skip = false;
  3479. String file = String::utf8(fname);
  3480. Vector<uint8_t> data;
  3481. data.resize(info.uncompressed_size);
  3482. //read
  3483. unzOpenCurrentFile(pkg);
  3484. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  3485. unzCloseCurrentFile(pkg);
  3486. //write
  3487. if (file == "AndroidManifest.xml") {
  3488. _fix_manifest(p_preset, data, p_give_internet);
  3489. // Allow editor export plugins to update the prebuilt manifest as needed.
  3490. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  3491. for (int i = 0; i < export_plugins.size(); i++) {
  3492. if (export_plugins[i]->supports_platform(Ref<EditorExportPlatform>(this))) {
  3493. PackedByteArray export_plugin_data = export_plugins[i]->update_android_prebuilt_manifest(Ref<EditorExportPlatform>(this), data);
  3494. if (!export_plugin_data.is_empty()) {
  3495. data = export_plugin_data;
  3496. }
  3497. }
  3498. }
  3499. }
  3500. if (file == "resources.arsc") {
  3501. _fix_resources(p_preset, data);
  3502. }
  3503. if (file == THEMED_ICON_XML_PATH) {
  3504. // Store themed_icon.xml data.
  3505. themed_icon_xml_data = data;
  3506. skip = true;
  3507. }
  3508. if (file == ICON_XML_PATH) {
  3509. if (monochrome.is_valid() && !monochrome->is_empty()) {
  3510. // Defer processing of icon.xml until after themed_icon.xml is read.
  3511. icon_xml_compression_method = info.compression_method;
  3512. skip = true;
  3513. }
  3514. }
  3515. if ((file.ends_with(".webp") || file.ends_with(".png")) && file.contains("mipmap")) {
  3516. for (int i = 0; i < ICON_DENSITIES_COUNT; ++i) {
  3517. if (main_image.is_valid() && !main_image->is_empty()) {
  3518. if (file == LAUNCHER_ICONS[i].export_path) {
  3519. _process_launcher_icons(file, main_image, LAUNCHER_ICONS[i].dimensions, data);
  3520. }
  3521. }
  3522. if (foreground.is_valid() && !foreground->is_empty()) {
  3523. if (file == LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].export_path) {
  3524. _process_launcher_icons(file, foreground, LAUNCHER_ADAPTIVE_ICON_FOREGROUNDS[i].dimensions, data);
  3525. }
  3526. }
  3527. if (background.is_valid() && !background->is_empty()) {
  3528. if (file == LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].export_path) {
  3529. _process_launcher_icons(file, background, LAUNCHER_ADAPTIVE_ICON_BACKGROUNDS[i].dimensions, data);
  3530. }
  3531. }
  3532. if (monochrome.is_valid() && !monochrome->is_empty()) {
  3533. if (file == LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].export_path) {
  3534. _process_launcher_icons(file, monochrome, LAUNCHER_ADAPTIVE_ICON_MONOCHROMES[i].dimensions, data);
  3535. }
  3536. }
  3537. }
  3538. }
  3539. if (file.ends_with(".so")) {
  3540. bool enabled = false;
  3541. for (int i = 0; i < enabled_abis.size(); ++i) {
  3542. if (file.begins_with("lib/" + enabled_abis[i].abi + "/")) {
  3543. invalid_abis.erase(enabled_abis[i]);
  3544. enabled = true;
  3545. break;
  3546. }
  3547. }
  3548. if (!enabled) {
  3549. skip = true;
  3550. }
  3551. }
  3552. if (file.begins_with("META-INF") && should_sign) {
  3553. skip = true;
  3554. }
  3555. if (!skip) {
  3556. print_line("ADDING: " + file);
  3557. // Respect decision on compression made by AAPT for the export template
  3558. const bool uncompressed = info.compression_method == 0;
  3559. zip_fileinfo zipfi = get_zip_fileinfo();
  3560. zipOpenNewFileInZip(unaligned_apk,
  3561. file.utf8().get_data(),
  3562. &zipfi,
  3563. nullptr,
  3564. 0,
  3565. nullptr,
  3566. 0,
  3567. nullptr,
  3568. uncompressed ? 0 : Z_DEFLATED,
  3569. Z_DEFAULT_COMPRESSION);
  3570. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  3571. zipCloseFileInZip(unaligned_apk);
  3572. }
  3573. ret = unzGoToNextFile(pkg);
  3574. }
  3575. // Process deferred icon.xml and replace it's data with themed_icon.xml.
  3576. if (monochrome.is_valid() && !monochrome->is_empty()) {
  3577. print_line("ADDING: " + ICON_XML_PATH + " (replacing with themed_icon.xml data)");
  3578. const bool uncompressed = icon_xml_compression_method == 0;
  3579. zip_fileinfo zipfi = get_zip_fileinfo();
  3580. zipOpenNewFileInZip(unaligned_apk,
  3581. ICON_XML_PATH.utf8().get_data(),
  3582. &zipfi,
  3583. nullptr,
  3584. 0,
  3585. nullptr,
  3586. 0,
  3587. nullptr,
  3588. uncompressed ? 0 : Z_DEFLATED,
  3589. Z_DEFAULT_COMPRESSION);
  3590. zipWriteInFileInZip(unaligned_apk, themed_icon_xml_data.ptr(), themed_icon_xml_data.size());
  3591. zipCloseFileInZip(unaligned_apk);
  3592. }
  3593. if (!invalid_abis.is_empty()) {
  3594. 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)));
  3595. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  3596. }
  3597. if (ep.step(TTR("Adding files..."), 1)) {
  3598. CLEANUP_AND_RETURN(ERR_SKIP);
  3599. }
  3600. err = OK;
  3601. if (p_flags.has_flag(DEBUG_FLAG_DUMB_CLIENT)) {
  3602. APKExportData ed;
  3603. ed.ep = &ep;
  3604. ed.apk = unaligned_apk;
  3605. err = export_project_files(p_preset, p_debug, ignore_apk_file, nullptr, &ed, save_apk_so);
  3606. } else {
  3607. if (apk_expansion) {
  3608. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  3609. if (err != OK) {
  3610. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not write expansion package file!"));
  3611. return err;
  3612. }
  3613. } else {
  3614. APKExportData ed;
  3615. ed.ep = &ep;
  3616. ed.apk = unaligned_apk;
  3617. ed.pd.path = "assets.sparsepck";
  3618. ed.pd.use_sparse_pck = true;
  3619. err = export_project_files(p_preset, p_debug, save_apk_file, nullptr, &ed, save_apk_so);
  3620. Vector<uint8_t> enc_data;
  3621. err = _generate_sparse_pck_metadata(p_preset, ed.pd, enc_data);
  3622. if (err != OK) {
  3623. add_message(EXPORT_MESSAGE_ERROR, TTR("Save PCK"), TTR("Could not generate sparse pck metadata!"));
  3624. return err;
  3625. }
  3626. store_in_apk(&ed, "assets/assets.sparsepck", enc_data, 0);
  3627. }
  3628. }
  3629. if (err != OK) {
  3630. unzClose(pkg);
  3631. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not export project files.")));
  3632. CLEANUP_AND_RETURN(ERR_SKIP);
  3633. }
  3634. zip_fileinfo zipfi = get_zip_fileinfo();
  3635. zipOpenNewFileInZip(unaligned_apk,
  3636. "assets/_cl_",
  3637. &zipfi,
  3638. nullptr,
  3639. 0,
  3640. nullptr,
  3641. 0,
  3642. nullptr,
  3643. 0, // No compress (little size gain and potentially slower startup)
  3644. Z_DEFAULT_COMPRESSION);
  3645. zipWriteInFileInZip(unaligned_apk, command_line_flags.ptr(), command_line_flags.size());
  3646. zipCloseFileInZip(unaligned_apk);
  3647. zipClose(unaligned_apk, nullptr);
  3648. unzClose(pkg);
  3649. // Let's zip-align (must be done before signing)
  3650. static const int PAGE_SIZE_KB = 16 * 1024;
  3651. static const int ZIP_ALIGNMENT = 4;
  3652. // If we're not signing the apk, then the next step should be the last.
  3653. const int next_step = should_sign ? 103 : 105;
  3654. if (ep.step(TTR("Aligning APK..."), next_step)) {
  3655. CLEANUP_AND_RETURN(ERR_SKIP);
  3656. }
  3657. unzFile tmp_unaligned = unzOpen2(tmp_unaligned_path.utf8().get_data(), &io);
  3658. if (!tmp_unaligned) {
  3659. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not unzip temporary unaligned APK.")));
  3660. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  3661. }
  3662. ret = unzGoToFirstFile(tmp_unaligned);
  3663. io2 = zipio_create_io(&io2_fa);
  3664. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  3665. // Take files from the unaligned APK and write them out to the aligned one
  3666. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  3667. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  3668. int bias = 0;
  3669. while (ret == UNZ_OK) {
  3670. unz_file_info info;
  3671. memset(&info, 0, sizeof(info));
  3672. char fname[16384];
  3673. char extra[16384];
  3674. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, nullptr, 0);
  3675. if (ret != UNZ_OK) {
  3676. break;
  3677. }
  3678. String file = String::utf8(fname);
  3679. Vector<uint8_t> data;
  3680. data.resize(info.compressed_size);
  3681. // read
  3682. int method, level;
  3683. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  3684. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  3685. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  3686. unzCloseCurrentFile(tmp_unaligned);
  3687. // align
  3688. int padding = 0;
  3689. if (!info.compression_method) {
  3690. // Uncompressed file => Align
  3691. long new_offset = file_offset + bias;
  3692. const char *ext = strrchr(fname, '.');
  3693. if (ext && strcmp(ext, ".so") == 0) {
  3694. padding = (PAGE_SIZE_KB - (new_offset % PAGE_SIZE_KB)) % PAGE_SIZE_KB;
  3695. } else {
  3696. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  3697. }
  3698. }
  3699. memset(extra + info.size_file_extra, 0, padding);
  3700. zip_fileinfo fileinfo = get_zip_fileinfo();
  3701. zipOpenNewFileInZip2(final_apk,
  3702. file.utf8().get_data(),
  3703. &fileinfo,
  3704. extra,
  3705. info.size_file_extra + padding,
  3706. nullptr,
  3707. 0,
  3708. nullptr,
  3709. method,
  3710. level,
  3711. 1); // raw write
  3712. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  3713. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  3714. bias += padding;
  3715. ret = unzGoToNextFile(tmp_unaligned);
  3716. }
  3717. zipClose(final_apk, nullptr);
  3718. unzClose(tmp_unaligned);
  3719. if (should_sign) {
  3720. // Signing must be done last as any additional modifications to the
  3721. // file will invalidate the signature.
  3722. err = sign_apk(p_preset, p_debug, p_path, ep);
  3723. if (err != OK) {
  3724. // Message is supplied by the subroutine method.
  3725. CLEANUP_AND_RETURN(err);
  3726. }
  3727. }
  3728. CLEANUP_AND_RETURN(OK);
  3729. }
  3730. void EditorExportPlatformAndroid::get_platform_features(List<String> *r_features) const {
  3731. r_features->push_back("mobile");
  3732. r_features->push_back("android");
  3733. }
  3734. void EditorExportPlatformAndroid::resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, HashSet<String> &p_features) {
  3735. }
  3736. void EditorExportPlatformAndroid::initialize() {
  3737. if (EditorNode::get_singleton()) {
  3738. Ref<Image> img = memnew(Image);
  3739. const bool upsample = !Math::is_equal_approx(Math::round(EDSCALE), EDSCALE);
  3740. ImageLoaderSVG::create_image_from_string(img, _android_logo_svg, EDSCALE, upsample, false);
  3741. logo = ImageTexture::create_from_image(img);
  3742. ImageLoaderSVG::create_image_from_string(img, _android_run_icon_svg, EDSCALE, upsample, false);
  3743. run_icon = ImageTexture::create_from_image(img);
  3744. devices_changed.set();
  3745. #ifndef DISABLE_DEPRECATED
  3746. android_plugins_changed.set();
  3747. #endif // DISABLE_DEPRECATED
  3748. #ifndef ANDROID_ENABLED
  3749. _create_editor_debug_keystore_if_needed();
  3750. _update_preset_status();
  3751. check_for_changes_thread.start(_check_for_changes_poll_thread, this);
  3752. #endif
  3753. use_scrcpy = EditorSettings::get_singleton()->get_project_metadata("android", "use_scrcpy", false);
  3754. }
  3755. }
  3756. EditorExportPlatformAndroid::~EditorExportPlatformAndroid() {
  3757. #ifndef ANDROID_ENABLED
  3758. quit_request.set();
  3759. if (check_for_changes_thread.is_started()) {
  3760. check_for_changes_thread.wait_to_finish();
  3761. }
  3762. #endif
  3763. }