export_plugin.cpp 123 KB

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