export_plugin.cpp 123 KB

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