export.cpp 83 KB

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