export_plugin.cpp 116 KB

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