export_plugin.cpp 113 KB

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