export.cpp 96 KB

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