export_plugin.cpp 107 KB

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