export.cpp 103 KB

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