2
0

export_plugin.cpp 111 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 = "launcher_icons/main_192x192";
  204. static const char *launcher_adaptive_icon_foreground_option = "launcher_icons/adaptive_foreground_432x432";
  205. static const char *launcher_adaptive_icon_background_option = "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 = 30; // 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 not benefit in doing so,
  476. * a performance gain is expected attime. 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_instrumentation_tag(p_preset);
  723. manifest_text += _get_application_tag(p_preset, _has_storage_permission(perms));
  724. manifest_text += "</manifest>\n";
  725. String manifest_path = vformat("res://android/build/src/%s/AndroidManifest.xml", (p_debug ? "debug" : "release"));
  726. print_verbose("Storing manifest into " + manifest_path + ": " + "\n" + manifest_text);
  727. store_string_at_path(manifest_path, manifest_text);
  728. }
  729. void EditorExportPlatformAndroid::_fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  730. // Leaving the unused types commented because looking these constants up
  731. // again later would be annoying
  732. // const int CHUNK_AXML_FILE = 0x00080003;
  733. // const int CHUNK_RESOURCEIDS = 0x00080180;
  734. const int CHUNK_STRINGS = 0x001C0001;
  735. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  736. const int CHUNK_XML_END_TAG = 0x00100103;
  737. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  738. const int CHUNK_XML_START_TAG = 0x00100102;
  739. // const int CHUNK_XML_TEXT = 0x00100104;
  740. const int UTF8_FLAG = 0x00000100;
  741. Vector<String> string_table;
  742. uint32_t ofs = 8;
  743. uint32_t string_count = 0;
  744. //uint32_t styles_count = 0;
  745. uint32_t string_flags = 0;
  746. uint32_t string_data_offset = 0;
  747. //uint32_t styles_offset = 0;
  748. uint32_t string_table_begins = 0;
  749. uint32_t string_table_ends = 0;
  750. Vector<uint8_t> stable_extra;
  751. String version_name = p_preset->get("version/name");
  752. int version_code = p_preset->get("version/code");
  753. String package_name = p_preset->get("package/unique_name");
  754. const int screen_orientation =
  755. _get_android_orientation_value(DisplayServer::ScreenOrientation(int(GLOBAL_GET("display/window/handheld/orientation"))));
  756. bool screen_support_small = p_preset->get("screen/support_small");
  757. bool screen_support_normal = p_preset->get("screen/support_normal");
  758. bool screen_support_large = p_preset->get("screen/support_large");
  759. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  760. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  761. int hand_tracking_index = p_preset->get("xr_features/hand_tracking");
  762. int hand_tracking_frequency_index = p_preset->get("xr_features/hand_tracking_frequency");
  763. bool backup_allowed = p_preset->get("user_data_backup/allow");
  764. bool classify_as_game = p_preset->get("package/classify_as_game");
  765. bool retain_data_on_uninstall = p_preset->get("package/retain_data_on_uninstall");
  766. bool exclude_from_recents = p_preset->get("package/exclude_from_recents");
  767. bool is_resizeable = bool(GLOBAL_GET("display/window/size/resizable"));
  768. Vector<String> perms;
  769. // Write permissions into the perms variable.
  770. _get_permissions(p_preset, p_give_internet, perms);
  771. bool has_storage_permission = _has_storage_permission(perms);
  772. while (ofs < (uint32_t)p_manifest.size()) {
  773. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  774. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  775. switch (chunk) {
  776. case CHUNK_STRINGS: {
  777. int iofs = ofs + 8;
  778. string_count = decode_uint32(&p_manifest[iofs]);
  779. // iofs + 4 is `styles_count`.
  780. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  781. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  782. // iofs + 16 is `styles_offset`.
  783. uint32_t st_offset = iofs + 20;
  784. string_table.resize(string_count);
  785. uint32_t string_end = 0;
  786. string_table_begins = st_offset;
  787. for (uint32_t i = 0; i < string_count; i++) {
  788. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  789. string_at += st_offset + string_count * 4;
  790. ERR_FAIL_COND_MSG(string_flags & UTF8_FLAG, "Unimplemented, can't read UTF-8 string table.");
  791. if (string_flags & UTF8_FLAG) {
  792. } else {
  793. uint32_t len = decode_uint16(&p_manifest[string_at]);
  794. Vector<char32_t> ucstring;
  795. ucstring.resize(len + 1);
  796. for (uint32_t j = 0; j < len; j++) {
  797. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  798. ucstring.write[j] = c;
  799. }
  800. string_end = MAX(string_at + 2 + 2 * len, string_end);
  801. ucstring.write[len] = 0;
  802. string_table.write[i] = ucstring.ptr();
  803. }
  804. }
  805. for (uint32_t i = string_end; i < (ofs + size); i++) {
  806. stable_extra.push_back(p_manifest[i]);
  807. }
  808. string_table_ends = ofs + size;
  809. } break;
  810. case CHUNK_XML_START_TAG: {
  811. int iofs = ofs + 8;
  812. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  813. String tname = string_table[name];
  814. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  815. iofs += 28;
  816. for (uint32_t i = 0; i < attrcount; i++) {
  817. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  818. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  819. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  820. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  821. const String value = (attr_value != 0xFFFFFFFF) ? string_table[attr_value] : "Res #" + itos(attr_resid);
  822. String attrname = string_table[attr_name];
  823. const String nspace = (attr_nspace != 0xFFFFFFFF) ? string_table[attr_nspace] : "";
  824. //replace project information
  825. if (tname == "manifest" && attrname == "package") {
  826. string_table.write[attr_value] = get_package_name(package_name);
  827. }
  828. if (tname == "manifest" && attrname == "versionCode") {
  829. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  830. }
  831. if (tname == "manifest" && attrname == "versionName") {
  832. if (attr_value == 0xFFFFFFFF) {
  833. WARN_PRINT("Version name in a resource, should be plain text");
  834. } else {
  835. string_table.write[attr_value] = version_name;
  836. }
  837. }
  838. if (tname == "application" && attrname == "requestLegacyExternalStorage") {
  839. encode_uint32(has_storage_permission ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  840. }
  841. if (tname == "application" && attrname == "allowBackup") {
  842. encode_uint32(backup_allowed, &p_manifest.write[iofs + 16]);
  843. }
  844. if (tname == "application" && attrname == "isGame") {
  845. encode_uint32(classify_as_game, &p_manifest.write[iofs + 16]);
  846. }
  847. if (tname == "application" && attrname == "hasFragileUserData") {
  848. encode_uint32(retain_data_on_uninstall, &p_manifest.write[iofs + 16]);
  849. }
  850. if (tname == "instrumentation" && attrname == "targetPackage") {
  851. string_table.write[attr_value] = get_package_name(package_name);
  852. }
  853. if (tname == "activity" && attrname == "screenOrientation") {
  854. encode_uint32(screen_orientation, &p_manifest.write[iofs + 16]);
  855. }
  856. if (tname == "activity" && attrname == "excludeFromRecents") {
  857. encode_uint32(exclude_from_recents, &p_manifest.write[iofs + 16]);
  858. }
  859. if (tname == "activity" && attrname == "resizeableActivity") {
  860. encode_uint32(is_resizeable, &p_manifest.write[iofs + 16]);
  861. }
  862. if (tname == "supports-screens") {
  863. if (attrname == "smallScreens") {
  864. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  865. } else if (attrname == "normalScreens") {
  866. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  867. } else if (attrname == "largeScreens") {
  868. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  869. } else if (attrname == "xlargeScreens") {
  870. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  871. }
  872. }
  873. // Hand tracking related configurations
  874. if (xr_mode_index == XR_MODE_OPENXR && hand_tracking_index > XR_HAND_TRACKING_NONE) {
  875. if (tname == "meta-data" && attrname == "name" && value == "xr_hand_tracking_metadata_name") {
  876. string_table.write[attr_value] = "com.oculus.handtracking.frequency";
  877. }
  878. if (tname == "meta-data" && attrname == "value" && value == "xr_hand_tracking_metadata_value") {
  879. string_table.write[attr_value] = (hand_tracking_frequency_index == XR_HAND_TRACKING_FREQUENCY_LOW ? "LOW" : "HIGH");
  880. }
  881. if (tname == "meta-data" && attrname == "name" && value == "xr_hand_tracking_version_name") {
  882. string_table.write[attr_value] = "com.oculus.handtracking.version";
  883. }
  884. if (tname == "meta-data" && attrname == "name" && value == "xr_hand_tracking_version_value") {
  885. string_table.write[attr_value] = "V2.0";
  886. }
  887. }
  888. iofs += 20;
  889. }
  890. } break;
  891. case CHUNK_XML_END_TAG: {
  892. int iofs = ofs + 8;
  893. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  894. String tname = string_table[name];
  895. if (tname == "uses-feature") {
  896. Vector<String> feature_names;
  897. Vector<bool> feature_required_list;
  898. Vector<int> feature_versions;
  899. if (xr_mode_index == XR_MODE_OPENXR) {
  900. // Set degrees of freedom
  901. feature_names.push_back("android.hardware.vr.headtracking");
  902. feature_required_list.push_back(true);
  903. feature_versions.push_back(1);
  904. // Check for hand tracking
  905. if (hand_tracking_index > XR_HAND_TRACKING_NONE) {
  906. feature_names.push_back("oculus.software.handtracking");
  907. feature_required_list.push_back(hand_tracking_index == XR_HAND_TRACKING_REQUIRED);
  908. feature_versions.push_back(-1); // no version attribute should be added.
  909. }
  910. // Check for passthrough
  911. int passthrough_mode = p_preset->get("xr_features/passthrough");
  912. if (passthrough_mode > XR_PASSTHROUGH_NONE) {
  913. feature_names.push_back("com.oculus.feature.PASSTHROUGH");
  914. feature_required_list.push_back(passthrough_mode == XR_PASSTHROUGH_REQUIRED);
  915. feature_versions.push_back(-1);
  916. }
  917. }
  918. if (feature_names.size() > 0) {
  919. ofs += 24; // skip over end tag
  920. // save manifest ending so we can restore it
  921. Vector<uint8_t> manifest_end;
  922. uint32_t manifest_cur_size = p_manifest.size();
  923. manifest_end.resize(p_manifest.size() - ofs);
  924. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  925. int32_t attr_name_string = string_table.find("name");
  926. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  927. int32_t ns_android_string = string_table.find("http://schemas.android.com/apk/res/android");
  928. if (ns_android_string == -1) {
  929. string_table.push_back("http://schemas.android.com/apk/res/android");
  930. ns_android_string = string_table.size() - 1;
  931. }
  932. int32_t attr_uses_feature_string = string_table.find("uses-feature");
  933. if (attr_uses_feature_string == -1) {
  934. string_table.push_back("uses-feature");
  935. attr_uses_feature_string = string_table.size() - 1;
  936. }
  937. int32_t attr_required_string = string_table.find("required");
  938. if (attr_required_string == -1) {
  939. string_table.push_back("required");
  940. attr_required_string = string_table.size() - 1;
  941. }
  942. for (int i = 0; i < feature_names.size(); i++) {
  943. String feature_name = feature_names[i];
  944. bool feature_required = feature_required_list[i];
  945. int feature_version = feature_versions[i];
  946. bool has_version_attribute = feature_version != -1;
  947. print_line("Adding feature " + feature_name);
  948. int32_t feature_string = string_table.find(feature_name);
  949. if (feature_string == -1) {
  950. string_table.push_back(feature_name);
  951. feature_string = string_table.size() - 1;
  952. }
  953. String required_value_string = feature_required ? "true" : "false";
  954. int32_t required_value = string_table.find(required_value_string);
  955. if (required_value == -1) {
  956. string_table.push_back(required_value_string);
  957. required_value = string_table.size() - 1;
  958. }
  959. int32_t attr_version_string = -1;
  960. int32_t version_value = -1;
  961. int tag_size;
  962. int attr_count;
  963. if (has_version_attribute) {
  964. attr_version_string = string_table.find("version");
  965. if (attr_version_string == -1) {
  966. string_table.push_back("version");
  967. attr_version_string = string_table.size() - 1;
  968. }
  969. version_value = string_table.find(itos(feature_version));
  970. if (version_value == -1) {
  971. string_table.push_back(itos(feature_version));
  972. version_value = string_table.size() - 1;
  973. }
  974. tag_size = 96; // node and three attrs + end node
  975. attr_count = 3;
  976. } else {
  977. tag_size = 76; // node and two attrs + end node
  978. attr_count = 2;
  979. }
  980. manifest_cur_size += tag_size + 24;
  981. p_manifest.resize(manifest_cur_size);
  982. // start tag
  983. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  984. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  985. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  986. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  987. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  988. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  989. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  990. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  991. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  992. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  993. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  994. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  995. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  996. // android:name attribute
  997. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  998. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  999. encode_uint32(feature_string, &p_manifest.write[ofs + 44]); // raw_value
  1000. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1001. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1002. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1003. encode_uint32(feature_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1004. // android:required attribute
  1005. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  1006. encode_uint32(attr_required_string, &p_manifest.write[ofs + 60]); // 'name'
  1007. encode_uint32(required_value, &p_manifest.write[ofs + 64]); // raw_value
  1008. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  1009. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  1010. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  1011. encode_uint32(required_value, &p_manifest.write[ofs + 72]); // typedvalue reference
  1012. ofs += 76;
  1013. if (has_version_attribute) {
  1014. // android:version attribute
  1015. encode_uint32(ns_android_string, &p_manifest.write[ofs]); // ns
  1016. encode_uint32(attr_version_string, &p_manifest.write[ofs + 4]); // 'name'
  1017. encode_uint32(version_value, &p_manifest.write[ofs + 8]); // raw_value
  1018. encode_uint16(8, &p_manifest.write[ofs + 12]); // typedvalue_size
  1019. p_manifest.write[ofs + 14] = 0; // typedvalue_always0
  1020. p_manifest.write[ofs + 15] = 0x03; // typedvalue_type (string)
  1021. encode_uint32(version_value, &p_manifest.write[ofs + 16]); // typedvalue reference
  1022. ofs += 20;
  1023. }
  1024. // end tag
  1025. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1026. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1027. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1028. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1029. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1030. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1031. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1032. ofs += 24;
  1033. }
  1034. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1035. ofs -= 24; // go back over back end
  1036. }
  1037. }
  1038. if (tname == "manifest") {
  1039. // save manifest ending so we can restore it
  1040. Vector<uint8_t> manifest_end;
  1041. uint32_t manifest_cur_size = p_manifest.size();
  1042. manifest_end.resize(p_manifest.size() - ofs);
  1043. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  1044. int32_t attr_name_string = string_table.find("name");
  1045. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  1046. int32_t ns_android_string = string_table.find("android");
  1047. ERR_FAIL_COND_MSG(ns_android_string == -1, "Template does not have 'android' namespace.");
  1048. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  1049. if (attr_uses_permission_string == -1) {
  1050. string_table.push_back("uses-permission");
  1051. attr_uses_permission_string = string_table.size() - 1;
  1052. }
  1053. for (int i = 0; i < perms.size(); ++i) {
  1054. print_line("Adding permission " + perms[i]);
  1055. manifest_cur_size += 56 + 24; // node + end node
  1056. p_manifest.resize(manifest_cur_size);
  1057. // Add permission to the string pool
  1058. int32_t perm_string = string_table.find(perms[i]);
  1059. if (perm_string == -1) {
  1060. string_table.push_back(perms[i]);
  1061. perm_string = string_table.size() - 1;
  1062. }
  1063. // start tag
  1064. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1065. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1066. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  1067. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1068. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1069. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1070. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1071. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1072. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1073. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  1074. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1075. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1076. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1077. // attribute
  1078. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1079. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1080. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  1081. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1082. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1083. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1084. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1085. ofs += 56;
  1086. // end tag
  1087. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1088. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1089. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1090. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1091. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1092. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1093. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1094. ofs += 24;
  1095. }
  1096. // copy footer back in
  1097. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1098. }
  1099. } break;
  1100. }
  1101. ofs += size;
  1102. }
  1103. //create new andriodmanifest binary
  1104. Vector<uint8_t> ret;
  1105. ret.resize(string_table_begins + string_table.size() * 4);
  1106. for (uint32_t i = 0; i < string_table_begins; i++) {
  1107. ret.write[i] = p_manifest[i];
  1108. }
  1109. ofs = 0;
  1110. for (int i = 0; i < string_table.size(); i++) {
  1111. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1112. ofs += string_table[i].length() * 2 + 2 + 2;
  1113. }
  1114. ret.resize(ret.size() + ofs);
  1115. string_data_offset = ret.size() - ofs;
  1116. uint8_t *chars = &ret.write[string_data_offset];
  1117. for (int i = 0; i < string_table.size(); i++) {
  1118. String s = string_table[i];
  1119. encode_uint16(s.length(), chars);
  1120. chars += 2;
  1121. for (int j = 0; j < s.length(); j++) {
  1122. encode_uint16(s[j], chars);
  1123. chars += 2;
  1124. }
  1125. encode_uint16(0, chars);
  1126. chars += 2;
  1127. }
  1128. for (int i = 0; i < stable_extra.size(); i++) {
  1129. ret.push_back(stable_extra[i]);
  1130. }
  1131. //pad
  1132. while (ret.size() % 4) {
  1133. ret.push_back(0);
  1134. }
  1135. uint32_t new_stable_end = ret.size();
  1136. uint32_t extra = (p_manifest.size() - string_table_ends);
  1137. ret.resize(new_stable_end + extra);
  1138. for (uint32_t i = 0; i < extra; i++) {
  1139. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  1140. }
  1141. while (ret.size() % 4) {
  1142. ret.push_back(0);
  1143. }
  1144. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  1145. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  1146. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  1147. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  1148. p_manifest = ret;
  1149. }
  1150. String EditorExportPlatformAndroid::_parse_string(const uint8_t *p_bytes, bool p_utf8) {
  1151. uint32_t offset = 0;
  1152. uint32_t len = 0;
  1153. if (p_utf8) {
  1154. uint8_t byte = p_bytes[offset];
  1155. if (byte & 0x80) {
  1156. offset += 2;
  1157. } else {
  1158. offset += 1;
  1159. }
  1160. byte = p_bytes[offset];
  1161. offset++;
  1162. if (byte & 0x80) {
  1163. len = byte & 0x7F;
  1164. len = (len << 8) + p_bytes[offset];
  1165. offset++;
  1166. } else {
  1167. len = byte;
  1168. }
  1169. } else {
  1170. len = decode_uint16(&p_bytes[offset]);
  1171. offset += 2;
  1172. if (len & 0x8000) {
  1173. len &= 0x7FFF;
  1174. len = (len << 16) + decode_uint16(&p_bytes[offset]);
  1175. offset += 2;
  1176. }
  1177. }
  1178. if (p_utf8) {
  1179. Vector<uint8_t> str8;
  1180. str8.resize(len + 1);
  1181. for (uint32_t i = 0; i < len; i++) {
  1182. str8.write[i] = p_bytes[offset + i];
  1183. }
  1184. str8.write[len] = 0;
  1185. String str;
  1186. str.parse_utf8((const char *)str8.ptr());
  1187. return str;
  1188. } else {
  1189. String str;
  1190. for (uint32_t i = 0; i < len; i++) {
  1191. char32_t c = decode_uint16(&p_bytes[offset + i * 2]);
  1192. if (c == 0) {
  1193. break;
  1194. }
  1195. str += String::chr(c);
  1196. }
  1197. return str;
  1198. }
  1199. }
  1200. void EditorExportPlatformAndroid::_fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &r_manifest) {
  1201. const int UTF8_FLAG = 0x00000100;
  1202. uint32_t string_block_len = decode_uint32(&r_manifest[16]);
  1203. uint32_t string_count = decode_uint32(&r_manifest[20]);
  1204. uint32_t string_flags = decode_uint32(&r_manifest[28]);
  1205. const uint32_t string_table_begins = 40;
  1206. Vector<String> string_table;
  1207. String package_name = p_preset->get("package/name");
  1208. Dictionary appnames = ProjectSettings::get_singleton()->get("application/config/name_localized");
  1209. for (uint32_t i = 0; i < string_count; i++) {
  1210. uint32_t offset = decode_uint32(&r_manifest[string_table_begins + i * 4]);
  1211. offset += string_table_begins + string_count * 4;
  1212. String str = _parse_string(&r_manifest[offset], string_flags & UTF8_FLAG);
  1213. if (str.begins_with("godot-project-name")) {
  1214. if (str == "godot-project-name") {
  1215. //project name
  1216. str = get_project_name(package_name);
  1217. } else {
  1218. String lang = str.substr(str.rfind("-") + 1, str.length()).replace("-", "_");
  1219. if (appnames.has(lang)) {
  1220. str = appnames[lang];
  1221. } else {
  1222. str = get_project_name(package_name);
  1223. }
  1224. }
  1225. }
  1226. string_table.push_back(str);
  1227. }
  1228. //write a new string table, but use 16 bits
  1229. Vector<uint8_t> ret;
  1230. ret.resize(string_table_begins + string_table.size() * 4);
  1231. for (uint32_t i = 0; i < string_table_begins; i++) {
  1232. ret.write[i] = r_manifest[i];
  1233. }
  1234. int ofs = 0;
  1235. for (int i = 0; i < string_table.size(); i++) {
  1236. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1237. ofs += string_table[i].length() * 2 + 2 + 2;
  1238. }
  1239. ret.resize(ret.size() + ofs);
  1240. uint8_t *chars = &ret.write[ret.size() - ofs];
  1241. for (int i = 0; i < string_table.size(); i++) {
  1242. String s = string_table[i];
  1243. encode_uint16(s.length(), chars);
  1244. chars += 2;
  1245. for (int j = 0; j < s.length(); j++) {
  1246. encode_uint16(s[j], chars);
  1247. chars += 2;
  1248. }
  1249. encode_uint16(0, chars);
  1250. chars += 2;
  1251. }
  1252. //pad
  1253. while (ret.size() % 4) {
  1254. ret.push_back(0);
  1255. }
  1256. //change flags to not use utf8
  1257. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  1258. //change length
  1259. encode_uint32(ret.size() - 12, &ret.write[16]);
  1260. //append the rest...
  1261. int rest_from = 12 + string_block_len;
  1262. int rest_to = ret.size();
  1263. int rest_len = (r_manifest.size() - rest_from);
  1264. ret.resize(ret.size() + (r_manifest.size() - rest_from));
  1265. for (int i = 0; i < rest_len; i++) {
  1266. ret.write[rest_to + i] = r_manifest[rest_from + i];
  1267. }
  1268. //finally update the size
  1269. encode_uint32(ret.size(), &ret.write[4]);
  1270. r_manifest = ret;
  1271. //printf("end\n");
  1272. }
  1273. void EditorExportPlatformAndroid::_load_image_data(const Ref<Image> &p_splash_image, Vector<uint8_t> &p_data) {
  1274. Vector<uint8_t> png_buffer;
  1275. Error err = PNGDriverCommon::image_to_png(p_splash_image, png_buffer);
  1276. if (err == OK) {
  1277. p_data.resize(png_buffer.size());
  1278. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1279. } else {
  1280. String err_str = String("Failed to convert splash image to png.");
  1281. WARN_PRINT(err_str.utf8().get_data());
  1282. }
  1283. }
  1284. void EditorExportPlatformAndroid::_process_launcher_icons(const String &p_file_name, const Ref<Image> &p_source_image, int dimension, Vector<uint8_t> &p_data) {
  1285. Ref<Image> working_image = p_source_image;
  1286. if (p_source_image->get_width() != dimension || p_source_image->get_height() != dimension) {
  1287. working_image = p_source_image->duplicate();
  1288. working_image->resize(dimension, dimension, Image::Interpolation::INTERPOLATE_LANCZOS);
  1289. }
  1290. Vector<uint8_t> png_buffer;
  1291. Error err = PNGDriverCommon::image_to_png(working_image, png_buffer);
  1292. if (err == OK) {
  1293. p_data.resize(png_buffer.size());
  1294. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1295. } else {
  1296. String err_str = String("Failed to convert resized icon (") + p_file_name + ") to png.";
  1297. WARN_PRINT(err_str.utf8().get_data());
  1298. }
  1299. }
  1300. String EditorExportPlatformAndroid::load_splash_refs(Ref<Image> &splash_image, Ref<Image> &splash_bg_color_image) {
  1301. bool scale_splash = ProjectSettings::get_singleton()->get("application/boot_splash/fullsize");
  1302. bool apply_filter = ProjectSettings::get_singleton()->get("application/boot_splash/use_filter");
  1303. String project_splash_path = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  1304. if (!project_splash_path.is_empty()) {
  1305. splash_image.instantiate();
  1306. print_verbose("Loading splash image: " + project_splash_path);
  1307. const Error err = ImageLoader::load_image(project_splash_path, splash_image);
  1308. if (err) {
  1309. if (OS::get_singleton()->is_stdout_verbose()) {
  1310. print_error("- unable to load splash image from " + project_splash_path + " (" + itos(err) + ")");
  1311. }
  1312. splash_image.unref();
  1313. }
  1314. }
  1315. if (splash_image.is_null()) {
  1316. // Use the default
  1317. print_verbose("Using default splash image.");
  1318. splash_image = Ref<Image>(memnew(Image(boot_splash_png)));
  1319. }
  1320. if (scale_splash) {
  1321. Size2 screen_size = Size2(ProjectSettings::get_singleton()->get("display/window/size/viewport_width"), ProjectSettings::get_singleton()->get("display/window/size/viewport_height"));
  1322. int width, height;
  1323. if (screen_size.width > screen_size.height) {
  1324. // scale horizontally
  1325. height = screen_size.height;
  1326. width = splash_image->get_width() * screen_size.height / splash_image->get_height();
  1327. } else {
  1328. // scale vertically
  1329. width = screen_size.width;
  1330. height = splash_image->get_height() * screen_size.width / splash_image->get_width();
  1331. }
  1332. splash_image->resize(width, height);
  1333. }
  1334. // Setup the splash bg color
  1335. bool bg_color_valid;
  1336. Color bg_color = ProjectSettings::get_singleton()->get("application/boot_splash/bg_color", &bg_color_valid);
  1337. if (!bg_color_valid) {
  1338. bg_color = boot_splash_bg_color;
  1339. }
  1340. print_verbose("Creating splash background color image.");
  1341. splash_bg_color_image.instantiate();
  1342. splash_bg_color_image->create(splash_image->get_width(), splash_image->get_height(), false, splash_image->get_format());
  1343. splash_bg_color_image->fill(bg_color);
  1344. String processed_splash_config_xml = vformat(SPLASH_CONFIG_XML_CONTENT, bool_to_string(apply_filter));
  1345. return processed_splash_config_xml;
  1346. }
  1347. void EditorExportPlatformAndroid::load_icon_refs(const Ref<EditorExportPreset> &p_preset, Ref<Image> &icon, Ref<Image> &foreground, Ref<Image> &background) {
  1348. String project_icon_path = ProjectSettings::get_singleton()->get("application/config/icon");
  1349. icon.instantiate();
  1350. foreground.instantiate();
  1351. background.instantiate();
  1352. // Regular icon: user selection -> project icon -> default.
  1353. String path = static_cast<String>(p_preset->get(launcher_icon_option)).strip_edges();
  1354. print_verbose("Loading regular icon from " + path);
  1355. if (path.is_empty() || ImageLoader::load_image(path, icon) != OK) {
  1356. print_verbose("- falling back to project icon: " + project_icon_path);
  1357. ImageLoader::load_image(project_icon_path, icon);
  1358. }
  1359. // Adaptive foreground: user selection -> regular icon (user selection -> project icon -> default).
  1360. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_foreground_option)).strip_edges();
  1361. print_verbose("Loading adaptive foreground icon from " + path);
  1362. if (path.is_empty() || ImageLoader::load_image(path, foreground) != OK) {
  1363. print_verbose("- falling back to using the regular icon");
  1364. foreground = icon;
  1365. }
  1366. // Adaptive background: user selection -> default.
  1367. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_background_option)).strip_edges();
  1368. if (!path.is_empty()) {
  1369. print_verbose("Loading adaptive background icon from " + path);
  1370. ImageLoader::load_image(path, background);
  1371. }
  1372. }
  1373. void EditorExportPlatformAndroid::store_image(const LauncherIcon launcher_icon, const Vector<uint8_t> &data) {
  1374. store_image(launcher_icon.export_path, data);
  1375. }
  1376. void EditorExportPlatformAndroid::store_image(const String &export_path, const Vector<uint8_t> &data) {
  1377. String img_path = export_path.insert(0, "res://android/build/");
  1378. store_file_at_path(img_path, data);
  1379. }
  1380. void EditorExportPlatformAndroid::_copy_icons_to_gradle_project(const Ref<EditorExportPreset> &p_preset,
  1381. const String &processed_splash_config_xml,
  1382. const Ref<Image> &splash_image,
  1383. const Ref<Image> &splash_bg_color_image,
  1384. const Ref<Image> &main_image,
  1385. const Ref<Image> &foreground,
  1386. const Ref<Image> &background) {
  1387. // Store the splash configuration
  1388. if (!processed_splash_config_xml.is_empty()) {
  1389. print_verbose("Storing processed splash configuration: " + String("\n") + processed_splash_config_xml);
  1390. store_string_at_path(SPLASH_CONFIG_PATH, processed_splash_config_xml);
  1391. }
  1392. // Store the splash image
  1393. if (splash_image.is_valid() && !splash_image->is_empty()) {
  1394. print_verbose("Storing splash image in " + String(SPLASH_IMAGE_EXPORT_PATH));
  1395. Vector<uint8_t> data;
  1396. _load_image_data(splash_image, data);
  1397. store_image(SPLASH_IMAGE_EXPORT_PATH, data);
  1398. }
  1399. // Store the splash bg color image
  1400. if (splash_bg_color_image.is_valid() && !splash_bg_color_image->is_empty()) {
  1401. print_verbose("Storing splash background image in " + String(SPLASH_BG_COLOR_PATH));
  1402. Vector<uint8_t> data;
  1403. _load_image_data(splash_bg_color_image, data);
  1404. store_image(SPLASH_BG_COLOR_PATH, data);
  1405. }
  1406. // Prepare images to be resized for the icons. If some image ends up being uninitialized,
  1407. // the default image from the export template will be used.
  1408. for (int i = 0; i < icon_densities_count; ++i) {
  1409. if (main_image.is_valid() && !main_image->is_empty()) {
  1410. print_verbose("Processing launcher icon for dimension " + itos(launcher_icons[i].dimensions) + " into " + launcher_icons[i].export_path);
  1411. Vector<uint8_t> data;
  1412. _process_launcher_icons(launcher_icons[i].export_path, main_image, launcher_icons[i].dimensions, data);
  1413. store_image(launcher_icons[i], data);
  1414. }
  1415. if (foreground.is_valid() && !foreground->is_empty()) {
  1416. print_verbose("Processing launcher adaptive icon foreground for dimension " + itos(launcher_adaptive_icon_foregrounds[i].dimensions) + " into " + launcher_adaptive_icon_foregrounds[i].export_path);
  1417. Vector<uint8_t> data;
  1418. _process_launcher_icons(launcher_adaptive_icon_foregrounds[i].export_path, foreground,
  1419. launcher_adaptive_icon_foregrounds[i].dimensions, data);
  1420. store_image(launcher_adaptive_icon_foregrounds[i], data);
  1421. }
  1422. if (background.is_valid() && !background->is_empty()) {
  1423. print_verbose("Processing launcher adaptive icon background for dimension " + itos(launcher_adaptive_icon_backgrounds[i].dimensions) + " into " + launcher_adaptive_icon_backgrounds[i].export_path);
  1424. Vector<uint8_t> data;
  1425. _process_launcher_icons(launcher_adaptive_icon_backgrounds[i].export_path, background,
  1426. launcher_adaptive_icon_backgrounds[i].dimensions, data);
  1427. store_image(launcher_adaptive_icon_backgrounds[i], data);
  1428. }
  1429. }
  1430. }
  1431. Vector<String> EditorExportPlatformAndroid::get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  1432. Vector<String> abis = get_abis();
  1433. Vector<String> enabled_abis;
  1434. for (int i = 0; i < abis.size(); ++i) {
  1435. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  1436. if (is_enabled) {
  1437. enabled_abis.push_back(abis[i]);
  1438. }
  1439. }
  1440. return enabled_abis;
  1441. }
  1442. void EditorExportPlatformAndroid::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  1443. String driver = ProjectSettings::get_singleton()->get("rendering/driver/driver_name");
  1444. if (driver == "opengl3") {
  1445. r_features->push_back("etc");
  1446. }
  1447. // FIXME: Review what texture formats are used for Vulkan.
  1448. if (driver == "vulkan") {
  1449. r_features->push_back("etc2");
  1450. }
  1451. Vector<String> abis = get_enabled_abis(p_preset);
  1452. for (int i = 0; i < abis.size(); ++i) {
  1453. r_features->push_back(abis[i]);
  1454. }
  1455. }
  1456. void EditorExportPlatformAndroid::get_export_options(List<ExportOption> *r_options) {
  1457. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1458. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1459. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "custom_template/use_custom_build"), false));
  1460. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "custom_template/export_format", PROPERTY_HINT_ENUM, "Export APK,Export AAB"), EXPORT_FORMAT_APK));
  1461. Vector<PluginConfigAndroid> plugins_configs = get_plugins();
  1462. for (int i = 0; i < plugins_configs.size(); i++) {
  1463. print_verbose("Found Android plugin " + plugins_configs[i].name);
  1464. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "plugins/" + plugins_configs[i].name), false));
  1465. }
  1466. plugins_changed.clear();
  1467. const Vector<String> abis = get_abis();
  1468. for (int i = 0; i < abis.size(); ++i) {
  1469. const String abi = abis[i];
  1470. // All Android devices supporting Vulkan run 64-bit Android,
  1471. // so there is usually no point in exporting for 32-bit Android.
  1472. const bool is_default = abi == "arm64-v8a";
  1473. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  1474. }
  1475. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"), ""));
  1476. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user"), ""));
  1477. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password"), ""));
  1478. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"), ""));
  1479. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  1480. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  1481. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  1482. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  1483. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/min_sdk", PROPERTY_HINT_RANGE, SDK_VERSION_RANGE), DEFAULT_MIN_SDK_VERSION));
  1484. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/target_sdk", PROPERTY_HINT_RANGE, SDK_VERSION_RANGE), DEFAULT_TARGET_SDK_VERSION));
  1485. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "ext.domain.name"), "org.godotengine.$genname"));
  1486. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name [default if blank]"), ""));
  1487. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  1488. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/classify_as_game"), true));
  1489. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/retain_data_on_uninstall"), false));
  1490. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/exclude_from_recents"), false));
  1491. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_icon_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1492. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_foreground_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1493. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_background_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1494. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/opengl_debug"), false));
  1495. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/xr_mode", PROPERTY_HINT_ENUM, "Regular,OpenXR"), XR_MODE_REGULAR));
  1496. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/hand_tracking", PROPERTY_HINT_ENUM, "None,Optional,Required"), XR_HAND_TRACKING_NONE));
  1497. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/hand_tracking_frequency", PROPERTY_HINT_ENUM, "Low,High"), XR_HAND_TRACKING_FREQUENCY_LOW));
  1498. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/passthrough", PROPERTY_HINT_ENUM, "None,Optional,Required"), XR_PASSTHROUGH_NONE));
  1499. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  1500. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  1501. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  1502. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  1503. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  1504. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data_backup/allow"), false));
  1505. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  1506. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  1507. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  1508. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  1509. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "permissions/custom_permissions"), PackedStringArray()));
  1510. const char **perms = android_perms;
  1511. while (*perms) {
  1512. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  1513. perms++;
  1514. }
  1515. }
  1516. String EditorExportPlatformAndroid::get_name() const {
  1517. return "Android";
  1518. }
  1519. String EditorExportPlatformAndroid::get_os_name() const {
  1520. return "Android";
  1521. }
  1522. Ref<Texture2D> EditorExportPlatformAndroid::get_logo() const {
  1523. return logo;
  1524. }
  1525. bool EditorExportPlatformAndroid::should_update_export_options() {
  1526. bool export_options_changed = plugins_changed.is_set();
  1527. if (export_options_changed) {
  1528. // don't clear unless we're reporting true, to avoid race
  1529. plugins_changed.clear();
  1530. }
  1531. return export_options_changed;
  1532. }
  1533. bool EditorExportPlatformAndroid::poll_export() {
  1534. bool dc = devices_changed.is_set();
  1535. if (dc) {
  1536. // don't clear unless we're reporting true, to avoid race
  1537. devices_changed.clear();
  1538. }
  1539. return dc;
  1540. }
  1541. int EditorExportPlatformAndroid::get_options_count() const {
  1542. MutexLock lock(device_lock);
  1543. return devices.size();
  1544. }
  1545. String EditorExportPlatformAndroid::get_options_tooltip() const {
  1546. return TTR("Select device from the list");
  1547. }
  1548. String EditorExportPlatformAndroid::get_option_label(int p_index) const {
  1549. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1550. MutexLock lock(device_lock);
  1551. return devices[p_index].name;
  1552. }
  1553. String EditorExportPlatformAndroid::get_option_tooltip(int p_index) const {
  1554. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1555. MutexLock lock(device_lock);
  1556. String s = devices[p_index].description;
  1557. if (devices.size() == 1) {
  1558. // Tooltip will be:
  1559. // Name
  1560. // Description
  1561. s = devices[p_index].name + "\n\n" + s;
  1562. }
  1563. return s;
  1564. }
  1565. Error EditorExportPlatformAndroid::run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  1566. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1567. String can_export_error;
  1568. bool can_export_missing_templates;
  1569. if (!can_export(p_preset, can_export_error, can_export_missing_templates)) {
  1570. EditorNode::add_io_error(can_export_error);
  1571. return ERR_UNCONFIGURED;
  1572. }
  1573. MutexLock lock(device_lock);
  1574. EditorProgress ep("run", vformat(TTR("Running on %s"), devices[p_device].name), 3);
  1575. String adb = get_adb_path();
  1576. // Export_temp APK.
  1577. if (ep.step(TTR("Exporting APK..."), 0)) {
  1578. return ERR_SKIP;
  1579. }
  1580. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  1581. const bool use_reverse = devices[p_device].api_level >= 21;
  1582. if (use_reverse) {
  1583. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  1584. }
  1585. String tmp_export_path = EditorPaths::get_singleton()->get_cache_dir().plus_file("tmpexport." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  1586. #define CLEANUP_AND_RETURN(m_err) \
  1587. { \
  1588. DirAccess::remove_file_or_error(tmp_export_path); \
  1589. return m_err; \
  1590. }
  1591. // Export to temporary APK before sending to device.
  1592. Error err = export_project_helper(p_preset, true, tmp_export_path, EXPORT_FORMAT_APK, true, p_debug_flags);
  1593. if (err != OK) {
  1594. CLEANUP_AND_RETURN(err);
  1595. }
  1596. List<String> args;
  1597. int rv;
  1598. String output;
  1599. bool remove_prev = EDITOR_GET("export/android/one_click_deploy_clear_previous_install");
  1600. String version_name = p_preset->get("version/name");
  1601. String package_name = p_preset->get("package/unique_name");
  1602. if (remove_prev) {
  1603. if (ep.step(TTR("Uninstalling..."), 1)) {
  1604. CLEANUP_AND_RETURN(ERR_SKIP);
  1605. }
  1606. print_line("Uninstalling previous version: " + devices[p_device].name);
  1607. args.push_back("-s");
  1608. args.push_back(devices[p_device].id);
  1609. args.push_back("uninstall");
  1610. args.push_back(get_package_name(package_name));
  1611. output.clear();
  1612. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1613. print_verbose(output);
  1614. }
  1615. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1616. if (ep.step(TTR("Installing to device, please wait..."), 2)) {
  1617. CLEANUP_AND_RETURN(ERR_SKIP);
  1618. }
  1619. args.clear();
  1620. args.push_back("-s");
  1621. args.push_back(devices[p_device].id);
  1622. args.push_back("install");
  1623. args.push_back("-r");
  1624. args.push_back(tmp_export_path);
  1625. output.clear();
  1626. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1627. print_verbose(output);
  1628. if (err || rv != 0) {
  1629. EditorNode::add_io_error(vformat(TTR("Could not install to device: %s"), output));
  1630. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1631. }
  1632. if (use_remote) {
  1633. if (use_reverse) {
  1634. static const char *const msg = "--- Device API >= 21; debugging over USB ---";
  1635. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1636. print_line(String(msg).to_upper());
  1637. args.clear();
  1638. args.push_back("-s");
  1639. args.push_back(devices[p_device].id);
  1640. args.push_back("reverse");
  1641. args.push_back("--remove-all");
  1642. output.clear();
  1643. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1644. print_verbose(output);
  1645. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  1646. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  1647. args.clear();
  1648. args.push_back("-s");
  1649. args.push_back(devices[p_device].id);
  1650. args.push_back("reverse");
  1651. args.push_back("tcp:" + itos(dbg_port));
  1652. args.push_back("tcp:" + itos(dbg_port));
  1653. output.clear();
  1654. OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1655. print_verbose(output);
  1656. print_line("Reverse result: " + itos(rv));
  1657. }
  1658. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1659. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  1660. args.clear();
  1661. args.push_back("-s");
  1662. args.push_back(devices[p_device].id);
  1663. args.push_back("reverse");
  1664. args.push_back("tcp:" + itos(fs_port));
  1665. args.push_back("tcp:" + itos(fs_port));
  1666. output.clear();
  1667. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1668. print_verbose(output);
  1669. print_line("Reverse result2: " + itos(rv));
  1670. }
  1671. } else {
  1672. static const char *const msg = "--- Device API < 21; debugging over Wi-Fi ---";
  1673. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1674. print_line(String(msg).to_upper());
  1675. }
  1676. }
  1677. if (ep.step(TTR("Running on device..."), 3)) {
  1678. CLEANUP_AND_RETURN(ERR_SKIP);
  1679. }
  1680. args.clear();
  1681. args.push_back("-s");
  1682. args.push_back(devices[p_device].id);
  1683. args.push_back("shell");
  1684. args.push_back("am");
  1685. args.push_back("start");
  1686. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  1687. args.push_back("--user");
  1688. args.push_back("0");
  1689. }
  1690. args.push_back("-a");
  1691. args.push_back("android.intent.action.MAIN");
  1692. args.push_back("-n");
  1693. args.push_back(get_package_name(package_name) + "/com.godot.game.GodotApp");
  1694. output.clear();
  1695. err = OS::get_singleton()->execute(adb, args, &output, &rv, true);
  1696. print_verbose(output);
  1697. if (err || rv != 0) {
  1698. EditorNode::add_io_error(TTR("Could not execute on device."));
  1699. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1700. }
  1701. CLEANUP_AND_RETURN(OK);
  1702. #undef CLEANUP_AND_RETURN
  1703. }
  1704. Ref<Texture2D> EditorExportPlatformAndroid::get_run_icon() const {
  1705. return run_icon;
  1706. }
  1707. String EditorExportPlatformAndroid::get_adb_path() {
  1708. String exe_ext = "";
  1709. if (OS::get_singleton()->get_name() == "Windows") {
  1710. exe_ext = ".exe";
  1711. }
  1712. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1713. return sdk_path.plus_file("platform-tools/adb" + exe_ext);
  1714. }
  1715. String EditorExportPlatformAndroid::get_apksigner_path() {
  1716. String exe_ext = "";
  1717. if (OS::get_singleton()->get_name() == "Windows") {
  1718. exe_ext = ".bat";
  1719. }
  1720. String apksigner_command_name = "apksigner" + exe_ext;
  1721. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1722. String apksigner_path = "";
  1723. Error errn;
  1724. String build_tools_dir = sdk_path.plus_file("build-tools");
  1725. Ref<DirAccess> da = DirAccess::open(build_tools_dir, &errn);
  1726. if (errn != OK) {
  1727. print_error("Unable to open Android 'build-tools' directory.");
  1728. return apksigner_path;
  1729. }
  1730. // There are additional versions directories we need to go through.
  1731. da->list_dir_begin();
  1732. String sub_dir = da->get_next();
  1733. while (!sub_dir.is_empty()) {
  1734. if (!sub_dir.begins_with(".") && da->current_is_dir()) {
  1735. // Check if the tool is here.
  1736. String tool_path = build_tools_dir.plus_file(sub_dir).plus_file(apksigner_command_name);
  1737. if (FileAccess::exists(tool_path)) {
  1738. apksigner_path = tool_path;
  1739. break;
  1740. }
  1741. }
  1742. sub_dir = da->get_next();
  1743. }
  1744. da->list_dir_end();
  1745. if (apksigner_path.is_empty()) {
  1746. EditorNode::get_singleton()->show_warning(TTR("Unable to find the 'apksigner' tool."));
  1747. }
  1748. return apksigner_path;
  1749. }
  1750. bool EditorExportPlatformAndroid::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1751. String err;
  1752. bool valid = false;
  1753. const bool custom_build_enabled = p_preset->get("custom_template/use_custom_build");
  1754. // Look for export templates (first official, and if defined custom templates).
  1755. if (!custom_build_enabled) {
  1756. String template_err;
  1757. bool dvalid = false;
  1758. bool rvalid = false;
  1759. bool has_export_templates = false;
  1760. if (p_preset->get("custom_template/debug") != "") {
  1761. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1762. if (!dvalid) {
  1763. template_err += TTR("Custom debug template not found.") + "\n";
  1764. }
  1765. } else {
  1766. has_export_templates |= exists_export_template("android_debug.apk", &template_err);
  1767. }
  1768. if (p_preset->get("custom_template/release") != "") {
  1769. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1770. if (!rvalid) {
  1771. template_err += TTR("Custom release template not found.") + "\n";
  1772. }
  1773. } else {
  1774. has_export_templates |= exists_export_template("android_release.apk", &template_err);
  1775. }
  1776. r_missing_templates = !has_export_templates;
  1777. valid = dvalid || rvalid || has_export_templates;
  1778. if (!valid) {
  1779. err += template_err;
  1780. }
  1781. } else {
  1782. bool installed_android_build_template = FileAccess::exists("res://android/build/build.gradle");
  1783. if (!installed_android_build_template) {
  1784. r_missing_templates = !exists_export_template("android_source.zip", &err);
  1785. err += TTR("Android build template not installed in the project. Install it from the Project menu.") + "\n";
  1786. } else {
  1787. r_missing_templates = false;
  1788. }
  1789. valid = installed_android_build_template && !r_missing_templates;
  1790. }
  1791. // Validate the rest of the configuration.
  1792. String dk = p_preset->get("keystore/debug");
  1793. String dk_user = p_preset->get("keystore/debug_user");
  1794. String dk_password = p_preset->get("keystore/debug_password");
  1795. if ((dk.is_empty() || dk_user.is_empty() || dk_password.is_empty()) && (!dk.is_empty() || !dk_user.is_empty() || !dk_password.is_empty())) {
  1796. valid = false;
  1797. err += TTR("Either Debug Keystore, Debug User AND Debug Password settings must be configured OR none of them.") + "\n";
  1798. }
  1799. if (!FileAccess::exists(dk)) {
  1800. dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1801. if (!FileAccess::exists(dk)) {
  1802. valid = false;
  1803. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  1804. }
  1805. }
  1806. String rk = p_preset->get("keystore/release");
  1807. String rk_user = p_preset->get("keystore/release_user");
  1808. String rk_password = p_preset->get("keystore/release_password");
  1809. if ((rk.is_empty() || rk_user.is_empty() || rk_password.is_empty()) && (!rk.is_empty() || !rk_user.is_empty() || !rk_password.is_empty())) {
  1810. valid = false;
  1811. err += TTR("Either Release Keystore, Release User AND Release Password settings must be configured OR none of them.") + "\n";
  1812. }
  1813. if (!rk.is_empty() && !FileAccess::exists(rk)) {
  1814. valid = false;
  1815. err += TTR("Release keystore incorrectly configured in the export preset.") + "\n";
  1816. }
  1817. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1818. if (sdk_path.is_empty()) {
  1819. err += TTR("A valid Android SDK path is required in Editor Settings.") + "\n";
  1820. valid = false;
  1821. } else {
  1822. Error errn;
  1823. // Check for the platform-tools directory.
  1824. Ref<DirAccess> da = DirAccess::open(sdk_path.plus_file("platform-tools"), &errn);
  1825. if (errn != OK) {
  1826. err += TTR("Invalid Android SDK path in Editor Settings.");
  1827. err += TTR("Missing 'platform-tools' directory!");
  1828. err += "\n";
  1829. valid = false;
  1830. }
  1831. // Validate that adb is available
  1832. String adb_path = get_adb_path();
  1833. if (!FileAccess::exists(adb_path)) {
  1834. err += TTR("Unable to find Android SDK platform-tools' adb command.");
  1835. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  1836. err += "\n";
  1837. valid = false;
  1838. }
  1839. // Check for the build-tools directory.
  1840. Ref<DirAccess> build_tools_da = DirAccess::open(sdk_path.plus_file("build-tools"), &errn);
  1841. if (errn != OK) {
  1842. err += TTR("Invalid Android SDK path in Editor Settings.");
  1843. err += TTR("Missing 'build-tools' directory!");
  1844. err += "\n";
  1845. valid = false;
  1846. }
  1847. // Validate that apksigner is available
  1848. String apksigner_path = get_apksigner_path();
  1849. if (!FileAccess::exists(apksigner_path)) {
  1850. err += TTR("Unable to find Android SDK build-tools' apksigner command.");
  1851. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  1852. err += "\n";
  1853. valid = false;
  1854. }
  1855. }
  1856. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1857. if (apk_expansion) {
  1858. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1859. if (apk_expansion_pkey.is_empty()) {
  1860. valid = false;
  1861. err += TTR("Invalid public key for APK expansion.") + "\n";
  1862. }
  1863. }
  1864. String pn = p_preset->get("package/unique_name");
  1865. String pn_err;
  1866. if (!is_package_name_valid(get_package_name(pn), &pn_err)) {
  1867. valid = false;
  1868. err += TTR("Invalid package name:") + " " + pn_err + "\n";
  1869. }
  1870. String etc_error = test_etc2();
  1871. if (!etc_error.is_empty()) {
  1872. valid = false;
  1873. err += etc_error;
  1874. }
  1875. // Ensure that `Use Custom Build` is enabled if a plugin is selected.
  1876. String enabled_plugins_names = PluginConfigAndroid::get_plugins_names(get_enabled_plugins(p_preset));
  1877. if (!enabled_plugins_names.is_empty() && !custom_build_enabled) {
  1878. valid = false;
  1879. err += TTR("\"Use Custom Build\" must be enabled to use the plugins.");
  1880. err += "\n";
  1881. }
  1882. // Validate the Xr features are properly populated
  1883. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1884. int hand_tracking = p_preset->get("xr_features/hand_tracking");
  1885. int passthrough_mode = p_preset->get("xr_features/passthrough");
  1886. if (xr_mode_index != XR_MODE_OPENXR) {
  1887. if (hand_tracking > XR_HAND_TRACKING_NONE) {
  1888. valid = false;
  1889. err += TTR("\"Hand Tracking\" is only valid when \"Xr Mode\" is \"OpenXR\".");
  1890. err += "\n";
  1891. }
  1892. if (passthrough_mode > XR_PASSTHROUGH_NONE) {
  1893. valid = false;
  1894. err += TTR("\"Passthrough\" is only valid when \"Xr Mode\" is \"OpenXR\".");
  1895. err += "\n";
  1896. }
  1897. }
  1898. if (int(p_preset->get("custom_template/export_format")) == EXPORT_FORMAT_AAB &&
  1899. !custom_build_enabled) {
  1900. valid = false;
  1901. err += TTR("\"Export AAB\" is only valid when \"Use Custom Build\" is enabled.");
  1902. err += "\n";
  1903. }
  1904. // Check the min sdk version
  1905. int min_sdk_version = p_preset->get("version/min_sdk");
  1906. if (min_sdk_version != DEFAULT_MIN_SDK_VERSION && !custom_build_enabled) {
  1907. valid = false;
  1908. err += TTR("Changing the \"Min Sdk\" is only valid when \"Use Custom Build\" is enabled.");
  1909. err += "\n";
  1910. }
  1911. // Check the target sdk version
  1912. int target_sdk_version = p_preset->get("version/target_sdk");
  1913. if (target_sdk_version != DEFAULT_TARGET_SDK_VERSION && !custom_build_enabled) {
  1914. valid = false;
  1915. err += TTR("Changing the \"Target Sdk\" is only valid when \"Use Custom Build\" is enabled.");
  1916. err += "\n";
  1917. }
  1918. if (target_sdk_version < min_sdk_version) {
  1919. valid = false;
  1920. err += TTR("\"Target Sdk\" version must be greater or equal to \"Min Sdk\" version.");
  1921. err += "\n";
  1922. }
  1923. r_error = err;
  1924. return valid;
  1925. }
  1926. List<String> EditorExportPlatformAndroid::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1927. List<String> list;
  1928. list.push_back("apk");
  1929. list.push_back("aab");
  1930. return list;
  1931. }
  1932. String EditorExportPlatformAndroid::get_apk_expansion_fullpath(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  1933. int version_code = p_preset->get("version/code");
  1934. String package_name = p_preset->get("package/unique_name");
  1935. String apk_file_name = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  1936. String fullpath = p_path.get_base_dir().plus_file(apk_file_name);
  1937. return fullpath;
  1938. }
  1939. Error EditorExportPlatformAndroid::save_apk_expansion_file(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) {
  1940. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  1941. Error err = save_pack(p_preset, p_debug, fullpath);
  1942. return err;
  1943. }
  1944. 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) {
  1945. String cmdline = p_preset->get("command_line/extra_args");
  1946. Vector<String> command_line_strings = cmdline.strip_edges().split(" ");
  1947. for (int i = 0; i < command_line_strings.size(); i++) {
  1948. if (command_line_strings[i].strip_edges().length() == 0) {
  1949. command_line_strings.remove_at(i);
  1950. i--;
  1951. }
  1952. }
  1953. gen_export_flags(command_line_strings, p_flags);
  1954. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1955. if (apk_expansion) {
  1956. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  1957. String apk_expansion_public_key = p_preset->get("apk_expansion/public_key");
  1958. command_line_strings.push_back("--use_apk_expansion");
  1959. command_line_strings.push_back("--apk_expansion_md5");
  1960. command_line_strings.push_back(FileAccess::get_md5(fullpath));
  1961. command_line_strings.push_back("--apk_expansion_key");
  1962. command_line_strings.push_back(apk_expansion_public_key.strip_edges());
  1963. }
  1964. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1965. if (xr_mode_index == XR_MODE_OPENXR) {
  1966. command_line_strings.push_back("--xr_mode_openxr");
  1967. } else { // XRMode.REGULAR is the default.
  1968. command_line_strings.push_back("--xr_mode_regular");
  1969. }
  1970. bool immersive = p_preset->get("screen/immersive_mode");
  1971. if (immersive) {
  1972. command_line_strings.push_back("--use_immersive");
  1973. }
  1974. bool debug_opengl = p_preset->get("graphics/opengl_debug");
  1975. if (debug_opengl) {
  1976. command_line_strings.push_back("--debug_opengl");
  1977. }
  1978. if (command_line_strings.size()) {
  1979. r_command_line_flags.resize(4);
  1980. encode_uint32(command_line_strings.size(), &r_command_line_flags.write[0]);
  1981. for (int i = 0; i < command_line_strings.size(); i++) {
  1982. print_line(itos(i) + " param: " + command_line_strings[i]);
  1983. CharString command_line_argument = command_line_strings[i].utf8();
  1984. int base = r_command_line_flags.size();
  1985. int length = command_line_argument.length();
  1986. if (length == 0) {
  1987. continue;
  1988. }
  1989. r_command_line_flags.resize(base + 4 + length);
  1990. encode_uint32(length, &r_command_line_flags.write[base]);
  1991. memcpy(&r_command_line_flags.write[base + 4], command_line_argument.ptr(), length);
  1992. }
  1993. }
  1994. }
  1995. Error EditorExportPlatformAndroid::sign_apk(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &export_path, EditorProgress &ep) {
  1996. int export_format = int(p_preset->get("custom_template/export_format"));
  1997. String export_label = export_format == EXPORT_FORMAT_AAB ? "AAB" : "APK";
  1998. String release_keystore = p_preset->get("keystore/release");
  1999. String release_username = p_preset->get("keystore/release_user");
  2000. String release_password = p_preset->get("keystore/release_password");
  2001. String apksigner = get_apksigner_path();
  2002. print_verbose("Starting signing of the " + export_label + " binary using " + apksigner);
  2003. if (!FileAccess::exists(apksigner)) {
  2004. EditorNode::add_io_error(vformat(TTR("'apksigner' could not be found.\nPlease check the command is available in the Android SDK build-tools directory.\nThe resulting %s is unsigned."), export_label));
  2005. return OK;
  2006. }
  2007. String keystore;
  2008. String password;
  2009. String user;
  2010. if (p_debug) {
  2011. keystore = p_preset->get("keystore/debug");
  2012. password = p_preset->get("keystore/debug_password");
  2013. user = p_preset->get("keystore/debug_user");
  2014. if (keystore.is_empty()) {
  2015. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  2016. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  2017. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  2018. }
  2019. if (ep.step(vformat(TTR("Signing debug %s..."), export_label), 104)) {
  2020. return ERR_SKIP;
  2021. }
  2022. } else {
  2023. keystore = release_keystore;
  2024. password = release_password;
  2025. user = release_username;
  2026. if (ep.step(vformat(TTR("Signing release %s..."), export_label), 104)) {
  2027. return ERR_SKIP;
  2028. }
  2029. }
  2030. if (!FileAccess::exists(keystore)) {
  2031. EditorNode::add_io_error(TTR("Could not find keystore, unable to export."));
  2032. return ERR_FILE_CANT_OPEN;
  2033. }
  2034. String output;
  2035. List<String> args;
  2036. args.push_back("sign");
  2037. args.push_back("--verbose");
  2038. args.push_back("--ks");
  2039. args.push_back(keystore);
  2040. args.push_back("--ks-pass");
  2041. args.push_back("pass:" + password);
  2042. args.push_back("--ks-key-alias");
  2043. args.push_back(user);
  2044. args.push_back(export_path);
  2045. if (p_debug) {
  2046. // We only print verbose logs for debug builds to avoid leaking release keystore credentials.
  2047. print_verbose("Signing debug binary using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2048. }
  2049. int retval;
  2050. output.clear();
  2051. OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2052. print_verbose(output);
  2053. if (retval) {
  2054. EditorNode::add_io_error(vformat(TTR("'apksigner' returned with error #%d"), retval));
  2055. return ERR_CANT_CREATE;
  2056. }
  2057. if (ep.step(vformat(TTR("Verifying %s..."), export_label), 105)) {
  2058. return ERR_SKIP;
  2059. }
  2060. args.clear();
  2061. args.push_back("verify");
  2062. args.push_back("--verbose");
  2063. args.push_back(export_path);
  2064. if (p_debug) {
  2065. print_verbose("Verifying signed build using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2066. }
  2067. output.clear();
  2068. OS::get_singleton()->execute(apksigner, args, &output, &retval, true);
  2069. print_verbose(output);
  2070. if (retval) {
  2071. EditorNode::add_io_error(vformat(TTR("'apksigner' verification of %s failed."), export_label));
  2072. return ERR_CANT_CREATE;
  2073. }
  2074. print_verbose("Successfully completed signing build.");
  2075. return OK;
  2076. }
  2077. void EditorExportPlatformAndroid::_clear_assets_directory() {
  2078. Ref<DirAccess> da_res = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2079. // Clear the APK assets directory
  2080. if (da_res->dir_exists(APK_ASSETS_DIRECTORY)) {
  2081. print_verbose("Clearing APK assets directory..");
  2082. Ref<DirAccess> da_assets = DirAccess::open(APK_ASSETS_DIRECTORY);
  2083. da_assets->erase_contents_recursive();
  2084. da_res->remove(APK_ASSETS_DIRECTORY);
  2085. }
  2086. // Clear the AAB assets directory
  2087. if (da_res->dir_exists(AAB_ASSETS_DIRECTORY)) {
  2088. print_verbose("Clearing AAB assets directory..");
  2089. Ref<DirAccess> da_assets = DirAccess::open(AAB_ASSETS_DIRECTORY);
  2090. da_assets->erase_contents_recursive();
  2091. da_res->remove(AAB_ASSETS_DIRECTORY);
  2092. }
  2093. }
  2094. void EditorExportPlatformAndroid::_remove_copied_libs() {
  2095. print_verbose("Removing previously installed libraries...");
  2096. Error error;
  2097. String libs_json = FileAccess::get_file_as_string(GDNATIVE_LIBS_PATH, &error);
  2098. if (error || libs_json.is_empty()) {
  2099. print_verbose("No previously installed libraries found");
  2100. return;
  2101. }
  2102. JSON json;
  2103. error = json.parse(libs_json);
  2104. ERR_FAIL_COND_MSG(error, "Error parsing \"" + libs_json + "\" on line " + itos(json.get_error_line()) + ": " + json.get_error_message());
  2105. Vector<String> libs = json.get_data();
  2106. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2107. for (int i = 0; i < libs.size(); i++) {
  2108. print_verbose("Removing previously installed library " + libs[i]);
  2109. da->remove(libs[i]);
  2110. }
  2111. da->remove(GDNATIVE_LIBS_PATH);
  2112. }
  2113. String EditorExportPlatformAndroid::join_list(List<String> parts, const String &separator) const {
  2114. String ret;
  2115. for (int i = 0; i < parts.size(); ++i) {
  2116. if (i > 0) {
  2117. ret += separator;
  2118. }
  2119. ret += parts[i];
  2120. }
  2121. return ret;
  2122. }
  2123. Error EditorExportPlatformAndroid::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  2124. int export_format = int(p_preset->get("custom_template/export_format"));
  2125. bool should_sign = p_preset->get("package/signed");
  2126. return export_project_helper(p_preset, p_debug, p_path, export_format, should_sign, p_flags);
  2127. }
  2128. 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) {
  2129. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  2130. String src_apk;
  2131. Error err;
  2132. EditorProgress ep("export", TTR("Exporting for Android"), 105, true);
  2133. bool use_custom_build = bool(p_preset->get("custom_template/use_custom_build"));
  2134. bool p_give_internet = p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG);
  2135. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2136. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  2137. print_verbose("Exporting for Android...");
  2138. print_verbose("- debug build: " + bool_to_string(p_debug));
  2139. print_verbose("- export path: " + p_path);
  2140. print_verbose("- export format: " + itos(export_format));
  2141. print_verbose("- sign build: " + bool_to_string(should_sign));
  2142. print_verbose("- custom build enabled: " + bool_to_string(use_custom_build));
  2143. print_verbose("- apk expansion enabled: " + bool_to_string(apk_expansion));
  2144. print_verbose("- enabled abis: " + String(",").join(enabled_abis));
  2145. print_verbose("- export filter: " + itos(p_preset->get_export_filter()));
  2146. print_verbose("- include filter: " + p_preset->get_include_filter());
  2147. print_verbose("- exclude filter: " + p_preset->get_exclude_filter());
  2148. Ref<Image> splash_image;
  2149. Ref<Image> splash_bg_color_image;
  2150. String processed_splash_config_xml = load_splash_refs(splash_image, splash_bg_color_image);
  2151. Ref<Image> main_image;
  2152. Ref<Image> foreground;
  2153. Ref<Image> background;
  2154. load_icon_refs(p_preset, main_image, foreground, background);
  2155. Vector<uint8_t> command_line_flags;
  2156. // Write command line flags into the command_line_flags variable.
  2157. get_command_line_flags(p_preset, p_path, p_flags, command_line_flags);
  2158. if (export_format == EXPORT_FORMAT_AAB) {
  2159. if (!p_path.ends_with(".aab")) {
  2160. EditorNode::get_singleton()->show_warning(TTR("Invalid filename! Android App Bundle requires the *.aab extension."));
  2161. return ERR_UNCONFIGURED;
  2162. }
  2163. if (apk_expansion) {
  2164. EditorNode::get_singleton()->show_warning(TTR("APK Expansion not compatible with Android App Bundle."));
  2165. return ERR_UNCONFIGURED;
  2166. }
  2167. }
  2168. if (export_format == EXPORT_FORMAT_APK && !p_path.ends_with(".apk")) {
  2169. EditorNode::get_singleton()->show_warning(
  2170. 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. EditorNode::add_io_error(TTR("Unsupported export format!\n"));
  2175. return ERR_UNCONFIGURED; //TODO: is this the right error?
  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. EditorNode::get_singleton()->show_warning(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. EditorNode::get_singleton()->show_warning(vformat(TTR("Android build version mismatch:\n Template installed: %s\n Godot Version: %s\nPlease 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. EditorNode::add_io_error(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. EditorNode::add_io_error(TTR("Could not export project files to gradle project\n"));
  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. EditorNode::add_io_error(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. EditorNode::add_io_error(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. EditorNode::add_io_error(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. EditorNode::get_singleton()->show_warning(TTR("Building of Android project failed, check output for the error.\nAlternatively 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. EditorNode::get_singleton()->show_warning(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. EditorNode::add_io_error(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. EditorNode::add_io_error(vformat(TTR("Could not find template APK to export:\n%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. zipFile unaligned_apk = zipOpen2(tmp_unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2401. String cmdline = p_preset->get("command_line/extra_args");
  2402. String version_name = p_preset->get("version/name");
  2403. String package_name = p_preset->get("package/unique_name");
  2404. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  2405. Vector<String> invalid_abis(enabled_abis);
  2406. while (ret == UNZ_OK) {
  2407. //get filename
  2408. unz_file_info info;
  2409. char fname[16384];
  2410. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  2411. if (ret != UNZ_OK) {
  2412. break;
  2413. }
  2414. bool skip = false;
  2415. String file = String::utf8(fname);
  2416. Vector<uint8_t> data;
  2417. data.resize(info.uncompressed_size);
  2418. //read
  2419. unzOpenCurrentFile(pkg);
  2420. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  2421. unzCloseCurrentFile(pkg);
  2422. //write
  2423. if (file == "AndroidManifest.xml") {
  2424. _fix_manifest(p_preset, data, p_give_internet);
  2425. }
  2426. if (file == "resources.arsc") {
  2427. _fix_resources(p_preset, data);
  2428. }
  2429. // Process the splash image
  2430. if ((file == SPLASH_IMAGE_EXPORT_PATH || file == LEGACY_BUILD_SPLASH_IMAGE_EXPORT_PATH) && splash_image.is_valid() && !splash_image->is_empty()) {
  2431. _load_image_data(splash_image, data);
  2432. }
  2433. // Process the splash bg color image
  2434. 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()) {
  2435. _load_image_data(splash_bg_color_image, data);
  2436. }
  2437. for (int i = 0; i < icon_densities_count; ++i) {
  2438. if (main_image.is_valid() && !main_image->is_empty()) {
  2439. if (file == launcher_icons[i].export_path) {
  2440. _process_launcher_icons(file, main_image, launcher_icons[i].dimensions, data);
  2441. }
  2442. }
  2443. if (foreground.is_valid() && !foreground->is_empty()) {
  2444. if (file == launcher_adaptive_icon_foregrounds[i].export_path) {
  2445. _process_launcher_icons(file, foreground, launcher_adaptive_icon_foregrounds[i].dimensions, data);
  2446. }
  2447. }
  2448. if (background.is_valid() && !background->is_empty()) {
  2449. if (file == launcher_adaptive_icon_backgrounds[i].export_path) {
  2450. _process_launcher_icons(file, background, launcher_adaptive_icon_backgrounds[i].dimensions, data);
  2451. }
  2452. }
  2453. }
  2454. if (file.ends_with(".so")) {
  2455. bool enabled = false;
  2456. for (int i = 0; i < enabled_abis.size(); ++i) {
  2457. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  2458. invalid_abis.erase(enabled_abis[i]);
  2459. enabled = true;
  2460. break;
  2461. }
  2462. }
  2463. if (!enabled) {
  2464. skip = true;
  2465. }
  2466. }
  2467. if (file.begins_with("META-INF") && should_sign) {
  2468. skip = true;
  2469. }
  2470. if (!skip) {
  2471. print_line("ADDING: " + file);
  2472. // Respect decision on compression made by AAPT for the export template
  2473. const bool uncompressed = info.compression_method == 0;
  2474. zip_fileinfo zipfi = get_zip_fileinfo();
  2475. zipOpenNewFileInZip(unaligned_apk,
  2476. file.utf8().get_data(),
  2477. &zipfi,
  2478. nullptr,
  2479. 0,
  2480. nullptr,
  2481. 0,
  2482. nullptr,
  2483. uncompressed ? 0 : Z_DEFLATED,
  2484. Z_DEFAULT_COMPRESSION);
  2485. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  2486. zipCloseFileInZip(unaligned_apk);
  2487. }
  2488. ret = unzGoToNextFile(pkg);
  2489. }
  2490. if (!invalid_abis.is_empty()) {
  2491. String unsupported_arch = String(", ").join(invalid_abis);
  2492. EditorNode::add_io_error(vformat(TTR("Missing libraries in the export template for the selected architectures: %s.\nPlease build a template with all required libraries, or uncheck the missing architectures in the export preset."), unsupported_arch));
  2493. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2494. }
  2495. if (ep.step(TTR("Adding files..."), 1)) {
  2496. CLEANUP_AND_RETURN(ERR_SKIP);
  2497. }
  2498. err = OK;
  2499. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  2500. APKExportData ed;
  2501. ed.ep = &ep;
  2502. ed.apk = unaligned_apk;
  2503. err = export_project_files(p_preset, p_debug, ignore_apk_file, &ed, save_apk_so);
  2504. } else {
  2505. if (apk_expansion) {
  2506. err = save_apk_expansion_file(p_preset, p_debug, p_path);
  2507. if (err != OK) {
  2508. EditorNode::add_io_error(TTR("Could not write expansion package file!"));
  2509. return err;
  2510. }
  2511. } else {
  2512. APKExportData ed;
  2513. ed.ep = &ep;
  2514. ed.apk = unaligned_apk;
  2515. err = export_project_files(p_preset, p_debug, save_apk_file, &ed, save_apk_so);
  2516. }
  2517. }
  2518. if (err != OK) {
  2519. unzClose(pkg);
  2520. EditorNode::add_io_error(TTR("Could not export project files"));
  2521. CLEANUP_AND_RETURN(ERR_SKIP);
  2522. }
  2523. zip_fileinfo zipfi = get_zip_fileinfo();
  2524. zipOpenNewFileInZip(unaligned_apk,
  2525. "assets/_cl_",
  2526. &zipfi,
  2527. nullptr,
  2528. 0,
  2529. nullptr,
  2530. 0,
  2531. nullptr,
  2532. 0, // No compress (little size gain and potentially slower startup)
  2533. Z_DEFAULT_COMPRESSION);
  2534. zipWriteInFileInZip(unaligned_apk, command_line_flags.ptr(), command_line_flags.size());
  2535. zipCloseFileInZip(unaligned_apk);
  2536. zipClose(unaligned_apk, nullptr);
  2537. unzClose(pkg);
  2538. if (err != OK) {
  2539. CLEANUP_AND_RETURN(err);
  2540. }
  2541. // Let's zip-align (must be done before signing)
  2542. static const int ZIP_ALIGNMENT = 4;
  2543. // If we're not signing the apk, then the next step should be the last.
  2544. const int next_step = should_sign ? 103 : 105;
  2545. if (ep.step(TTR("Aligning APK..."), next_step)) {
  2546. CLEANUP_AND_RETURN(ERR_SKIP);
  2547. }
  2548. unzFile tmp_unaligned = unzOpen2(tmp_unaligned_path.utf8().get_data(), &io);
  2549. if (!tmp_unaligned) {
  2550. EditorNode::add_io_error(TTR("Could not unzip temporary unaligned APK."));
  2551. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2552. }
  2553. ret = unzGoToFirstFile(tmp_unaligned);
  2554. io2 = zipio_create_io(&io2_fa);
  2555. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2556. // Take files from the unaligned APK and write them out to the aligned one
  2557. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  2558. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  2559. int bias = 0;
  2560. while (ret == UNZ_OK) {
  2561. unz_file_info info;
  2562. memset(&info, 0, sizeof(info));
  2563. char fname[16384];
  2564. char extra[16384];
  2565. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, nullptr, 0);
  2566. if (ret != UNZ_OK) {
  2567. break;
  2568. }
  2569. String file = String::utf8(fname);
  2570. Vector<uint8_t> data;
  2571. data.resize(info.compressed_size);
  2572. // read
  2573. int method, level;
  2574. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  2575. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  2576. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  2577. unzCloseCurrentFile(tmp_unaligned);
  2578. // align
  2579. int padding = 0;
  2580. if (!info.compression_method) {
  2581. // Uncompressed file => Align
  2582. long new_offset = file_offset + bias;
  2583. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  2584. }
  2585. memset(extra + info.size_file_extra, 0, padding);
  2586. zip_fileinfo fileinfo = get_zip_fileinfo();
  2587. zipOpenNewFileInZip2(final_apk,
  2588. file.utf8().get_data(),
  2589. &fileinfo,
  2590. extra,
  2591. info.size_file_extra + padding,
  2592. nullptr,
  2593. 0,
  2594. nullptr,
  2595. method,
  2596. level,
  2597. 1); // raw write
  2598. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  2599. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  2600. bias += padding;
  2601. ret = unzGoToNextFile(tmp_unaligned);
  2602. }
  2603. zipClose(final_apk, nullptr);
  2604. unzClose(tmp_unaligned);
  2605. if (should_sign) {
  2606. // Signing must be done last as any additional modifications to the
  2607. // file will invalidate the signature.
  2608. err = sign_apk(p_preset, p_debug, p_path, ep);
  2609. if (err != OK) {
  2610. CLEANUP_AND_RETURN(err);
  2611. }
  2612. }
  2613. CLEANUP_AND_RETURN(OK);
  2614. }
  2615. void EditorExportPlatformAndroid::get_platform_features(List<String> *r_features) {
  2616. r_features->push_back("mobile");
  2617. r_features->push_back("android");
  2618. }
  2619. void EditorExportPlatformAndroid::resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  2620. }
  2621. EditorExportPlatformAndroid::EditorExportPlatformAndroid() {
  2622. Ref<Image> img = memnew(Image(_android_logo));
  2623. logo.instantiate();
  2624. logo->create_from_image(img);
  2625. img = Ref<Image>(memnew(Image(_android_run_icon)));
  2626. run_icon.instantiate();
  2627. run_icon->create_from_image(img);
  2628. devices_changed.set();
  2629. plugins_changed.set();
  2630. check_for_changes_thread.start(_check_for_changes_poll_thread, this);
  2631. }
  2632. EditorExportPlatformAndroid::~EditorExportPlatformAndroid() {
  2633. quit_request.set();
  2634. check_for_changes_thread.wait_to_finish();
  2635. }