export_plugin.cpp 141 KB

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