export_plugin.cpp 112 KB

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