export_plugin.cpp 158 KB

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