export.cpp 108 KB

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