export.cpp 105 KB

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