export_plugin.cpp 106 KB

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