export.cpp 88 KB

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