export_plugin.cpp 114 KB

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