export_plugin.cpp 126 KB

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