export_plugin.cpp 124 KB

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