2
0

export_plugin.cpp 123 KB

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