export.cpp 99 KB

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