export_plugin.cpp 138 KB

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