2
0

export.cpp 106 KB

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