export.cpp 107 KB

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