export_plugin.cpp 154 KB

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