export_plugin.cpp 118 KB

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