export.cpp 84 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526
  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/logo.gen.h"
  45. #include "platform/android/plugin/godot_plugin_config.h"
  46. #include "platform/android/run_icon.gen.h"
  47. #include <string.h>
  48. static const char *android_perms[] = {
  49. "ACCESS_CHECKIN_PROPERTIES",
  50. "ACCESS_COARSE_LOCATION",
  51. "ACCESS_FINE_LOCATION",
  52. "ACCESS_LOCATION_EXTRA_COMMANDS",
  53. "ACCESS_MOCK_LOCATION",
  54. "ACCESS_NETWORK_STATE",
  55. "ACCESS_SURFACE_FLINGER",
  56. "ACCESS_WIFI_STATE",
  57. "ACCOUNT_MANAGER",
  58. "ADD_VOICEMAIL",
  59. "AUTHENTICATE_ACCOUNTS",
  60. "BATTERY_STATS",
  61. "BIND_ACCESSIBILITY_SERVICE",
  62. "BIND_APPWIDGET",
  63. "BIND_DEVICE_ADMIN",
  64. "BIND_INPUT_METHOD",
  65. "BIND_NFC_SERVICE",
  66. "BIND_NOTIFICATION_LISTENER_SERVICE",
  67. "BIND_PRINT_SERVICE",
  68. "BIND_REMOTEVIEWS",
  69. "BIND_TEXT_SERVICE",
  70. "BIND_VPN_SERVICE",
  71. "BIND_WALLPAPER",
  72. "BLUETOOTH",
  73. "BLUETOOTH_ADMIN",
  74. "BLUETOOTH_PRIVILEGED",
  75. "BRICK",
  76. "BROADCAST_PACKAGE_REMOVED",
  77. "BROADCAST_SMS",
  78. "BROADCAST_STICKY",
  79. "BROADCAST_WAP_PUSH",
  80. "CALL_PHONE",
  81. "CALL_PRIVILEGED",
  82. "CAMERA",
  83. "CAPTURE_AUDIO_OUTPUT",
  84. "CAPTURE_SECURE_VIDEO_OUTPUT",
  85. "CAPTURE_VIDEO_OUTPUT",
  86. "CHANGE_COMPONENT_ENABLED_STATE",
  87. "CHANGE_CONFIGURATION",
  88. "CHANGE_NETWORK_STATE",
  89. "CHANGE_WIFI_MULTICAST_STATE",
  90. "CHANGE_WIFI_STATE",
  91. "CLEAR_APP_CACHE",
  92. "CLEAR_APP_USER_DATA",
  93. "CONTROL_LOCATION_UPDATES",
  94. "DELETE_CACHE_FILES",
  95. "DELETE_PACKAGES",
  96. "DEVICE_POWER",
  97. "DIAGNOSTIC",
  98. "DISABLE_KEYGUARD",
  99. "DUMP",
  100. "EXPAND_STATUS_BAR",
  101. "FACTORY_TEST",
  102. "FLASHLIGHT",
  103. "FORCE_BACK",
  104. "GET_ACCOUNTS",
  105. "GET_PACKAGE_SIZE",
  106. "GET_TASKS",
  107. "GET_TOP_ACTIVITY_INFO",
  108. "GLOBAL_SEARCH",
  109. "HARDWARE_TEST",
  110. "INJECT_EVENTS",
  111. "INSTALL_LOCATION_PROVIDER",
  112. "INSTALL_PACKAGES",
  113. "INSTALL_SHORTCUT",
  114. "INTERNAL_SYSTEM_WINDOW",
  115. "INTERNET",
  116. "KILL_BACKGROUND_PROCESSES",
  117. "LOCATION_HARDWARE",
  118. "MANAGE_ACCOUNTS",
  119. "MANAGE_APP_TOKENS",
  120. "MANAGE_DOCUMENTS",
  121. "MASTER_CLEAR",
  122. "MEDIA_CONTENT_CONTROL",
  123. "MODIFY_AUDIO_SETTINGS",
  124. "MODIFY_PHONE_STATE",
  125. "MOUNT_FORMAT_FILESYSTEMS",
  126. "MOUNT_UNMOUNT_FILESYSTEMS",
  127. "NFC",
  128. "PERSISTENT_ACTIVITY",
  129. "PROCESS_OUTGOING_CALLS",
  130. "READ_CALENDAR",
  131. "READ_CALL_LOG",
  132. "READ_CONTACTS",
  133. "READ_EXTERNAL_STORAGE",
  134. "READ_FRAME_BUFFER",
  135. "READ_HISTORY_BOOKMARKS",
  136. "READ_INPUT_STATE",
  137. "READ_LOGS",
  138. "READ_PHONE_STATE",
  139. "READ_PROFILE",
  140. "READ_SMS",
  141. "READ_SOCIAL_STREAM",
  142. "READ_SYNC_SETTINGS",
  143. "READ_SYNC_STATS",
  144. "READ_USER_DICTIONARY",
  145. "REBOOT",
  146. "RECEIVE_BOOT_COMPLETED",
  147. "RECEIVE_MMS",
  148. "RECEIVE_SMS",
  149. "RECEIVE_WAP_PUSH",
  150. "RECORD_AUDIO",
  151. "REORDER_TASKS",
  152. "RESTART_PACKAGES",
  153. "SEND_RESPOND_VIA_MESSAGE",
  154. "SEND_SMS",
  155. "SET_ACTIVITY_WATCHER",
  156. "SET_ALARM",
  157. "SET_ALWAYS_FINISH",
  158. "SET_ANIMATION_SCALE",
  159. "SET_DEBUG_APP",
  160. "SET_ORIENTATION",
  161. "SET_POINTER_SPEED",
  162. "SET_PREFERRED_APPLICATIONS",
  163. "SET_PROCESS_LIMIT",
  164. "SET_TIME",
  165. "SET_TIME_ZONE",
  166. "SET_WALLPAPER",
  167. "SET_WALLPAPER_HINTS",
  168. "SIGNAL_PERSISTENT_PROCESSES",
  169. "STATUS_BAR",
  170. "SUBSCRIBED_FEEDS_READ",
  171. "SUBSCRIBED_FEEDS_WRITE",
  172. "SYSTEM_ALERT_WINDOW",
  173. "TRANSMIT_IR",
  174. "UNINSTALL_SHORTCUT",
  175. "UPDATE_DEVICE_STATS",
  176. "USE_CREDENTIALS",
  177. "USE_SIP",
  178. "VIBRATE",
  179. "WAKE_LOCK",
  180. "WRITE_APN_SETTINGS",
  181. "WRITE_CALENDAR",
  182. "WRITE_CALL_LOG",
  183. "WRITE_CONTACTS",
  184. "WRITE_EXTERNAL_STORAGE",
  185. "WRITE_GSERVICES",
  186. "WRITE_HISTORY_BOOKMARKS",
  187. "WRITE_PROFILE",
  188. "WRITE_SECURE_SETTINGS",
  189. "WRITE_SETTINGS",
  190. "WRITE_SMS",
  191. "WRITE_SOCIAL_STREAM",
  192. "WRITE_SYNC_SETTINGS",
  193. "WRITE_USER_DICTIONARY",
  194. nullptr
  195. };
  196. struct LauncherIcon {
  197. const char *export_path;
  198. int dimensions;
  199. };
  200. static const int icon_densities_count = 6;
  201. static const char *launcher_icon_option = "launcher_icons/main_192x192";
  202. static const char *launcher_adaptive_icon_foreground_option = "launcher_icons/adaptive_foreground_432x432";
  203. static const char *launcher_adaptive_icon_background_option = "launcher_icons/adaptive_background_432x432";
  204. static const LauncherIcon launcher_icons[icon_densities_count] = {
  205. { "res/mipmap-xxxhdpi-v4/icon.png", 192 },
  206. { "res/mipmap-xxhdpi-v4/icon.png", 144 },
  207. { "res/mipmap-xhdpi-v4/icon.png", 96 },
  208. { "res/mipmap-hdpi-v4/icon.png", 72 },
  209. { "res/mipmap-mdpi-v4/icon.png", 48 },
  210. { "res/mipmap/icon.png", 192 }
  211. };
  212. static const LauncherIcon launcher_adaptive_icon_foregrounds[icon_densities_count] = {
  213. { "res/mipmap-xxxhdpi-v4/icon_foreground.png", 432 },
  214. { "res/mipmap-xxhdpi-v4/icon_foreground.png", 324 },
  215. { "res/mipmap-xhdpi-v4/icon_foreground.png", 216 },
  216. { "res/mipmap-hdpi-v4/icon_foreground.png", 162 },
  217. { "res/mipmap-mdpi-v4/icon_foreground.png", 108 },
  218. { "res/mipmap/icon_foreground.png", 432 }
  219. };
  220. static const LauncherIcon launcher_adaptive_icon_backgrounds[icon_densities_count] = {
  221. { "res/mipmap-xxxhdpi-v4/icon_background.png", 432 },
  222. { "res/mipmap-xxhdpi-v4/icon_background.png", 324 },
  223. { "res/mipmap-xhdpi-v4/icon_background.png", 216 },
  224. { "res/mipmap-hdpi-v4/icon_background.png", 162 },
  225. { "res/mipmap-mdpi-v4/icon_background.png", 108 },
  226. { "res/mipmap/icon_background.png", 432 }
  227. };
  228. class EditorExportPlatformAndroid : public EditorExportPlatform {
  229. GDCLASS(EditorExportPlatformAndroid, EditorExportPlatform);
  230. Ref<ImageTexture> logo;
  231. Ref<ImageTexture> run_icon;
  232. struct Device {
  233. String id;
  234. String name;
  235. String description;
  236. int api_level;
  237. };
  238. struct APKExportData {
  239. zipFile apk;
  240. EditorProgress *ep;
  241. };
  242. Vector<PluginConfig> plugins;
  243. String last_plugin_names;
  244. uint64_t last_custom_build_time = 0;
  245. volatile bool plugins_changed;
  246. Mutex plugins_lock;
  247. Vector<Device> devices;
  248. volatile bool devices_changed;
  249. Mutex device_lock;
  250. Thread *check_for_changes_thread;
  251. volatile bool quit_request;
  252. static void _check_for_changes_poll_thread(void *ud) {
  253. EditorExportPlatformAndroid *ea = (EditorExportPlatformAndroid *)ud;
  254. while (!ea->quit_request) {
  255. // Check for plugins updates
  256. {
  257. // Nothing to do if we already know the plugins have changed.
  258. if (!ea->plugins_changed) {
  259. Vector<PluginConfig> loaded_plugins = get_plugins();
  260. MutexLock lock(ea->plugins_lock);
  261. if (ea->plugins.size() != loaded_plugins.size()) {
  262. ea->plugins_changed = true;
  263. } else {
  264. for (int i = 0; i < ea->plugins.size(); i++) {
  265. if (ea->plugins[i].name != loaded_plugins[i].name) {
  266. ea->plugins_changed = true;
  267. break;
  268. }
  269. }
  270. }
  271. if (ea->plugins_changed) {
  272. ea->plugins = loaded_plugins;
  273. }
  274. }
  275. }
  276. // Check for devices updates
  277. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  278. if (FileAccess::exists(adb)) {
  279. String devices;
  280. List<String> args;
  281. args.push_back("devices");
  282. int ec;
  283. OS::get_singleton()->execute(adb, args, true, nullptr, &devices, &ec);
  284. Vector<String> ds = devices.split("\n");
  285. Vector<String> ldevices;
  286. for (int i = 1; i < ds.size(); i++) {
  287. String d = ds[i];
  288. int dpos = d.find("device");
  289. if (dpos == -1) {
  290. continue;
  291. }
  292. d = d.substr(0, dpos).strip_edges();
  293. ldevices.push_back(d);
  294. }
  295. MutexLock lock(ea->device_lock);
  296. bool different = false;
  297. if (ea->devices.size() != ldevices.size()) {
  298. different = true;
  299. } else {
  300. for (int i = 0; i < ea->devices.size(); i++) {
  301. if (ea->devices[i].id != ldevices[i]) {
  302. different = true;
  303. break;
  304. }
  305. }
  306. }
  307. if (different) {
  308. Vector<Device> ndevices;
  309. for (int i = 0; i < ldevices.size(); i++) {
  310. Device d;
  311. d.id = ldevices[i];
  312. for (int j = 0; j < ea->devices.size(); j++) {
  313. if (ea->devices[j].id == ldevices[i]) {
  314. d.description = ea->devices[j].description;
  315. d.name = ea->devices[j].name;
  316. d.api_level = ea->devices[j].api_level;
  317. }
  318. }
  319. if (d.description == "") {
  320. //in the oven, request!
  321. args.clear();
  322. args.push_back("-s");
  323. args.push_back(d.id);
  324. args.push_back("shell");
  325. args.push_back("getprop");
  326. int ec2;
  327. String dp;
  328. OS::get_singleton()->execute(adb, args, true, nullptr, &dp, &ec2);
  329. Vector<String> props = dp.split("\n");
  330. String vendor;
  331. String device;
  332. d.description = "Device ID: " + d.id + "\n";
  333. d.api_level = 0;
  334. for (int j = 0; j < props.size(); j++) {
  335. // got information by `shell cat /system/build.prop` before and its format is "property=value"
  336. // it's now changed to use `shell getporp` because of permission issue with Android 8.0 and above
  337. // its format is "[property]: [value]" so changed it as like build.prop
  338. String p = props[j];
  339. p = p.replace("]: ", "=");
  340. p = p.replace("[", "");
  341. p = p.replace("]", "");
  342. if (p.begins_with("ro.product.model=")) {
  343. device = p.get_slice("=", 1).strip_edges();
  344. } else if (p.begins_with("ro.product.brand=")) {
  345. vendor = p.get_slice("=", 1).strip_edges().capitalize();
  346. } else if (p.begins_with("ro.build.display.id=")) {
  347. d.description += "Build: " + p.get_slice("=", 1).strip_edges() + "\n";
  348. } else if (p.begins_with("ro.build.version.release=")) {
  349. d.description += "Release: " + p.get_slice("=", 1).strip_edges() + "\n";
  350. } else if (p.begins_with("ro.build.version.sdk=")) {
  351. d.api_level = p.get_slice("=", 1).to_int();
  352. } else if (p.begins_with("ro.product.cpu.abi=")) {
  353. d.description += "CPU: " + p.get_slice("=", 1).strip_edges() + "\n";
  354. } else if (p.begins_with("ro.product.manufacturer=")) {
  355. d.description += "Manufacturer: " + p.get_slice("=", 1).strip_edges() + "\n";
  356. } else if (p.begins_with("ro.board.platform=")) {
  357. d.description += "Chipset: " + p.get_slice("=", 1).strip_edges() + "\n";
  358. } else if (p.begins_with("ro.opengles.version=")) {
  359. uint32_t opengl = p.get_slice("=", 1).to_int();
  360. d.description += "OpenGL: " + itos(opengl >> 16) + "." + itos((opengl >> 8) & 0xFF) + "." + itos((opengl)&0xFF) + "\n";
  361. }
  362. }
  363. d.name = vendor + " " + device;
  364. if (device == String()) {
  365. continue;
  366. }
  367. }
  368. ndevices.push_back(d);
  369. }
  370. ea->devices = ndevices;
  371. ea->devices_changed = true;
  372. }
  373. }
  374. uint64_t sleep = 200;
  375. uint64_t wait = 3000000;
  376. uint64_t time = OS::get_singleton()->get_ticks_usec();
  377. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  378. OS::get_singleton()->delay_usec(1000 * sleep);
  379. if (ea->quit_request) {
  380. break;
  381. }
  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. }
  425. pname = pname.replace("$genname", name);
  426. return pname;
  427. }
  428. bool is_package_name_valid(const String &p_package, String *r_error = nullptr) const {
  429. String pname = p_package;
  430. if (pname.length() == 0) {
  431. if (r_error) {
  432. *r_error = TTR("Package name is missing.");
  433. }
  434. return false;
  435. }
  436. int segments = 0;
  437. bool first = true;
  438. for (int i = 0; i < pname.length(); i++) {
  439. CharType c = pname[i];
  440. if (first && c == '.') {
  441. if (r_error) {
  442. *r_error = TTR("Package segments must be of non-zero length.");
  443. }
  444. return false;
  445. }
  446. if (c == '.') {
  447. segments++;
  448. first = true;
  449. continue;
  450. }
  451. if (!((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_')) {
  452. if (r_error) {
  453. *r_error = vformat(TTR("The character '%s' is not allowed in Android application package names."), String::chr(c));
  454. }
  455. return false;
  456. }
  457. if (first && (c >= '0' && c <= '9')) {
  458. if (r_error) {
  459. *r_error = TTR("A digit cannot be the first character in a package segment.");
  460. }
  461. return false;
  462. }
  463. if (first && c == '_') {
  464. if (r_error) {
  465. *r_error = vformat(TTR("The character '%s' cannot be the first character in a package segment."), String::chr(c));
  466. }
  467. return false;
  468. }
  469. first = false;
  470. }
  471. if (segments == 0) {
  472. if (r_error) {
  473. *r_error = TTR("The package must have at least one '.' separator.");
  474. }
  475. return false;
  476. }
  477. if (first) {
  478. if (r_error) {
  479. *r_error = TTR("Package segments must be of non-zero length.");
  480. }
  481. return false;
  482. }
  483. return true;
  484. }
  485. static bool _should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  486. /*
  487. * By not compressing files with little or not benefit in doing so,
  488. * a performance gain is expected attime. Moreover, if the APK is
  489. * zip-aligned, assets stored as they are can be efficiently read by
  490. * Android by memory-mapping them.
  491. */
  492. // -- Unconditional uncompress to mimic AAPT plus some other
  493. static const char *unconditional_compress_ext[] = {
  494. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  495. // These formats are already compressed, or don't compress well:
  496. ".jpg", ".jpeg", ".png", ".gif",
  497. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  498. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  499. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  500. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  501. ".amr", ".awb", ".wma", ".wmv",
  502. // Godot-specific:
  503. ".webp", // Same reasoning as .png
  504. ".cfb", // Don't let small config files slow-down startup
  505. ".scn", // Binary scenes are usually already compressed
  506. ".stex", // Streamable textures are usually already compressed
  507. // Trailer for easier processing
  508. nullptr
  509. };
  510. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  511. if (p_path.to_lower().ends_with(String(*ext))) {
  512. return false;
  513. }
  514. }
  515. // -- Compressed resource?
  516. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  517. // Already compressed
  518. return false;
  519. }
  520. // --- TODO: Decide on texture resources according to their image compression setting
  521. return true;
  522. }
  523. static zip_fileinfo get_zip_fileinfo() {
  524. OS::Time time = OS::get_singleton()->get_time();
  525. OS::Date date = OS::get_singleton()->get_date();
  526. zip_fileinfo zipfi;
  527. zipfi.tmz_date.tm_hour = time.hour;
  528. zipfi.tmz_date.tm_mday = date.day;
  529. zipfi.tmz_date.tm_min = time.min;
  530. zipfi.tmz_date.tm_mon = date.month;
  531. zipfi.tmz_date.tm_sec = time.sec;
  532. zipfi.tmz_date.tm_year = date.year;
  533. zipfi.dosDate = 0;
  534. zipfi.external_fa = 0;
  535. zipfi.internal_fa = 0;
  536. return zipfi;
  537. }
  538. static Vector<String> get_abis() {
  539. Vector<String> abis;
  540. abis.push_back("armeabi-v7a");
  541. abis.push_back("arm64-v8a");
  542. abis.push_back("x86");
  543. abis.push_back("x86_64");
  544. return abis;
  545. }
  546. /// List the gdap files in the directory specified by the p_path parameter.
  547. static Vector<String> list_gdap_files(const String &p_path) {
  548. Vector<String> dir_files;
  549. DirAccessRef da = DirAccess::open(p_path);
  550. if (da) {
  551. da->list_dir_begin();
  552. while (true) {
  553. String file = da->get_next();
  554. if (file == "") {
  555. break;
  556. }
  557. if (da->current_is_dir() || da->current_is_hidden()) {
  558. continue;
  559. }
  560. if (file.ends_with(PLUGIN_CONFIG_EXT)) {
  561. dir_files.push_back(file);
  562. }
  563. }
  564. da->list_dir_end();
  565. }
  566. return dir_files;
  567. }
  568. static Vector<PluginConfig> get_plugins() {
  569. Vector<PluginConfig> loaded_plugins;
  570. String plugins_dir = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/plugins");
  571. // Add the prebuilt plugins
  572. loaded_plugins.append_array(get_prebuilt_plugins(plugins_dir));
  573. if (DirAccess::exists(plugins_dir)) {
  574. Vector<String> plugins_filenames = list_gdap_files(plugins_dir);
  575. if (!plugins_filenames.empty()) {
  576. Ref<ConfigFile> config_file = memnew(ConfigFile);
  577. for (int i = 0; i < plugins_filenames.size(); i++) {
  578. PluginConfig config = load_plugin_config(config_file, plugins_dir.plus_file(plugins_filenames[i]));
  579. if (config.valid_config) {
  580. loaded_plugins.push_back(config);
  581. } else {
  582. print_error("Invalid plugin config file " + plugins_filenames[i]);
  583. }
  584. }
  585. }
  586. }
  587. return loaded_plugins;
  588. }
  589. static Vector<PluginConfig> get_enabled_plugins(const Ref<EditorExportPreset> &p_presets) {
  590. Vector<PluginConfig> enabled_plugins;
  591. Vector<PluginConfig> all_plugins = get_plugins();
  592. for (int i = 0; i < all_plugins.size(); i++) {
  593. PluginConfig plugin = all_plugins[i];
  594. bool enabled = p_presets->get("plugins/" + plugin.name);
  595. if (enabled) {
  596. enabled_plugins.push_back(plugin);
  597. }
  598. }
  599. return enabled_plugins;
  600. }
  601. static Error store_in_apk(APKExportData *ed, const String &p_path, const Vector<uint8_t> &p_data, int compression_method = Z_DEFLATED) {
  602. zip_fileinfo zipfi = get_zip_fileinfo();
  603. zipOpenNewFileInZip(ed->apk,
  604. p_path.utf8().get_data(),
  605. &zipfi,
  606. nullptr,
  607. 0,
  608. nullptr,
  609. 0,
  610. nullptr,
  611. compression_method,
  612. Z_DEFAULT_COMPRESSION);
  613. zipWriteInFileInZip(ed->apk, p_data.ptr(), p_data.size());
  614. zipCloseFileInZip(ed->apk);
  615. return OK;
  616. }
  617. static Error save_apk_so(void *p_userdata, const SharedObject &p_so) {
  618. if (!p_so.path.get_file().begins_with("lib")) {
  619. String err = "Android .so file names must start with \"lib\", but got: " + p_so.path;
  620. ERR_PRINT(err);
  621. return FAILED;
  622. }
  623. APKExportData *ed = (APKExportData *)p_userdata;
  624. Vector<String> abis = get_abis();
  625. bool exported = false;
  626. for (int i = 0; i < p_so.tags.size(); ++i) {
  627. // shared objects can be fat (compatible with multiple ABIs)
  628. int abi_index = abis.find(p_so.tags[i]);
  629. if (abi_index != -1) {
  630. exported = true;
  631. String abi = abis[abi_index];
  632. String dst_path = String("lib").plus_file(abi).plus_file(p_so.path.get_file());
  633. Vector<uint8_t> array = FileAccess::get_file_as_array(p_so.path);
  634. Error store_err = store_in_apk(ed, dst_path, array);
  635. ERR_FAIL_COND_V_MSG(store_err, store_err, "Cannot store in apk file '" + dst_path + "'.");
  636. }
  637. }
  638. if (!exported) {
  639. String abis_string = String(" ").join(abis);
  640. String err = "Cannot determine ABI for library \"" + p_so.path + "\". One of the supported ABIs must be used as a tag: " + abis_string;
  641. ERR_PRINT(err);
  642. return FAILED;
  643. }
  644. return OK;
  645. }
  646. static Error save_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  647. APKExportData *ed = (APKExportData *)p_userdata;
  648. String dst_path = p_path.replace_first("res://", "assets/");
  649. store_in_apk(ed, dst_path, p_data, _should_compress_asset(p_path, p_data) ? Z_DEFLATED : 0);
  650. return OK;
  651. }
  652. static Error ignore_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  653. return OK;
  654. }
  655. void _fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  656. // Leaving the unused types commented because looking these constants up
  657. // again later would be annoying
  658. // const int CHUNK_AXML_FILE = 0x00080003;
  659. // const int CHUNK_RESOURCEIDS = 0x00080180;
  660. const int CHUNK_STRINGS = 0x001C0001;
  661. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  662. const int CHUNK_XML_END_TAG = 0x00100103;
  663. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  664. const int CHUNK_XML_START_TAG = 0x00100102;
  665. // const int CHUNK_XML_TEXT = 0x00100104;
  666. const int UTF8_FLAG = 0x00000100;
  667. Vector<String> string_table;
  668. uint32_t ofs = 8;
  669. uint32_t string_count = 0;
  670. //uint32_t styles_count = 0;
  671. uint32_t string_flags = 0;
  672. uint32_t string_data_offset = 0;
  673. //uint32_t styles_offset = 0;
  674. uint32_t string_table_begins = 0;
  675. uint32_t string_table_ends = 0;
  676. Vector<uint8_t> stable_extra;
  677. String version_name = p_preset->get("version/name");
  678. int version_code = p_preset->get("version/code");
  679. String package_name = p_preset->get("package/unique_name");
  680. int orientation = p_preset->get("screen/orientation");
  681. bool screen_support_small = p_preset->get("screen/support_small");
  682. bool screen_support_normal = p_preset->get("screen/support_normal");
  683. bool screen_support_large = p_preset->get("screen/support_large");
  684. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  685. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  686. bool focus_awareness = p_preset->get("xr_features/focus_awareness");
  687. String plugins_names = get_plugins_names(get_enabled_plugins(p_preset));
  688. Vector<String> perms;
  689. const char **aperms = android_perms;
  690. while (*aperms) {
  691. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  692. if (enabled) {
  693. perms.push_back("android.permission." + String(*aperms));
  694. }
  695. aperms++;
  696. }
  697. PackedStringArray user_perms = p_preset->get("permissions/custom_permissions");
  698. for (int i = 0; i < user_perms.size(); i++) {
  699. String user_perm = user_perms[i].strip_edges();
  700. if (!user_perm.empty()) {
  701. perms.push_back(user_perm);
  702. }
  703. }
  704. if (p_give_internet) {
  705. if (perms.find("android.permission.INTERNET") == -1) {
  706. perms.push_back("android.permission.INTERNET");
  707. }
  708. }
  709. while (ofs < (uint32_t)p_manifest.size()) {
  710. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  711. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  712. switch (chunk) {
  713. case CHUNK_STRINGS: {
  714. int iofs = ofs + 8;
  715. string_count = decode_uint32(&p_manifest[iofs]);
  716. //styles_count = decode_uint32(&p_manifest[iofs + 4]);
  717. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  718. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  719. //styles_offset = decode_uint32(&p_manifest[iofs + 16]);
  720. /*
  721. printf("string count: %i\n",string_count);
  722. printf("flags: %i\n",string_flags);
  723. printf("sdata ofs: %i\n",string_data_offset);
  724. printf("styles ofs: %i\n",styles_offset);
  725. */
  726. uint32_t st_offset = iofs + 20;
  727. string_table.resize(string_count);
  728. uint32_t string_end = 0;
  729. string_table_begins = st_offset;
  730. for (uint32_t i = 0; i < string_count; i++) {
  731. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  732. string_at += st_offset + string_count * 4;
  733. ERR_FAIL_COND_MSG(string_flags & UTF8_FLAG, "Unimplemented, can't read UTF-8 string table.");
  734. if (string_flags & UTF8_FLAG) {
  735. } else {
  736. uint32_t len = decode_uint16(&p_manifest[string_at]);
  737. Vector<CharType> ucstring;
  738. ucstring.resize(len + 1);
  739. for (uint32_t j = 0; j < len; j++) {
  740. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  741. ucstring.write[j] = c;
  742. }
  743. string_end = MAX(string_at + 2 + 2 * len, string_end);
  744. ucstring.write[len] = 0;
  745. string_table.write[i] = ucstring.ptr();
  746. }
  747. }
  748. for (uint32_t i = string_end; i < (ofs + size); i++) {
  749. stable_extra.push_back(p_manifest[i]);
  750. }
  751. string_table_ends = ofs + size;
  752. } break;
  753. case CHUNK_XML_START_TAG: {
  754. int iofs = ofs + 8;
  755. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  756. String tname = string_table[name];
  757. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  758. iofs += 28;
  759. bool is_focus_aware_metadata = false;
  760. for (uint32_t i = 0; i < attrcount; i++) {
  761. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  762. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  763. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  764. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  765. const String value = (attr_value != 0xFFFFFFFF) ? string_table[attr_value] : "Res #" + itos(attr_resid);
  766. String attrname = string_table[attr_name];
  767. const String nspace = (attr_nspace != 0xFFFFFFFF) ? string_table[attr_nspace] : "";
  768. //replace project information
  769. if (tname == "manifest" && attrname == "package") {
  770. string_table.write[attr_value] = get_package_name(package_name);
  771. }
  772. if (tname == "manifest" && attrname == "versionCode") {
  773. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  774. }
  775. if (tname == "manifest" && attrname == "versionName") {
  776. if (attr_value == 0xFFFFFFFF) {
  777. WARN_PRINT("Version name in a resource, should be plain text");
  778. } else {
  779. string_table.write[attr_value] = version_name;
  780. }
  781. }
  782. if (tname == "instrumentation" && attrname == "targetPackage") {
  783. string_table.write[attr_value] = get_package_name(package_name);
  784. }
  785. if (tname == "activity" && attrname == "screenOrientation") {
  786. encode_uint32(orientation == 0 ? 0 : 1, &p_manifest.write[iofs + 16]);
  787. }
  788. if (tname == "supports-screens") {
  789. if (attrname == "smallScreens") {
  790. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  791. } else if (attrname == "normalScreens") {
  792. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  793. } else if (attrname == "largeScreens") {
  794. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  795. } else if (attrname == "xlargeScreens") {
  796. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  797. }
  798. }
  799. // FIXME: `attr_value != 0xFFFFFFFF` below added as a stopgap measure for GH-32553,
  800. // but the issue should be debugged further and properly addressed.
  801. if (tname == "meta-data" && attrname == "name" && value == "xr_mode_metadata_name") {
  802. // Update the meta-data 'android:name' attribute based on the selected XR mode.
  803. if (xr_mode_index == 1 /* XRMode.OVR */) {
  804. string_table.write[attr_value] = "com.samsung.android.vr.application.mode";
  805. }
  806. }
  807. if (tname == "meta-data" && attrname == "value" && value == "xr_mode_metadata_value") {
  808. // Update the meta-data 'android:value' attribute based on the selected XR mode.
  809. if (xr_mode_index == 1 /* XRMode.OVR */) {
  810. string_table.write[attr_value] = "vr_only";
  811. }
  812. }
  813. if (tname == "meta-data" && attrname == "value" && is_focus_aware_metadata) {
  814. // Update the focus awareness meta-data value
  815. encode_uint32(xr_mode_index == /* XRMode.OVR */ 1 && focus_awareness ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  816. }
  817. if (tname == "meta-data" && attrname == "value" && value == "plugins_value" && !plugins_names.empty()) {
  818. // Update the meta-data 'android:value' attribute with the list of enabled plugins.
  819. string_table.write[attr_value] = plugins_names;
  820. }
  821. is_focus_aware_metadata = tname == "meta-data" && attrname == "name" && value == "com.oculus.vr.focusaware";
  822. iofs += 20;
  823. }
  824. } break;
  825. case CHUNK_XML_END_TAG: {
  826. int iofs = ofs + 8;
  827. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  828. String tname = string_table[name];
  829. if (tname == "uses-feature") {
  830. Vector<String> feature_names;
  831. Vector<bool> feature_required_list;
  832. Vector<int> feature_versions;
  833. if (xr_mode_index == 1 /* XRMode.OVR */) {
  834. // Check for degrees of freedom
  835. int dof_index = p_preset->get("xr_features/degrees_of_freedom"); // 0: none, 1: 3dof and 6dof, 2: 6dof
  836. if (dof_index > 0) {
  837. feature_names.push_back("android.hardware.vr.headtracking");
  838. feature_required_list.push_back(dof_index == 2);
  839. feature_versions.push_back(1);
  840. }
  841. // Check for hand tracking
  842. int hand_tracking_index = p_preset->get("xr_features/hand_tracking"); // 0: none, 1: optional, 2: required
  843. if (hand_tracking_index > 0) {
  844. feature_names.push_back("oculus.software.handtracking");
  845. feature_required_list.push_back(hand_tracking_index == 2);
  846. feature_versions.push_back(-1); // no version attribute should be added.
  847. if (perms.find("com.oculus.permission.HAND_TRACKING") == -1) {
  848. perms.push_back("com.oculus.permission.HAND_TRACKING");
  849. }
  850. }
  851. }
  852. if (feature_names.size() > 0) {
  853. ofs += 24; // skip over end tag
  854. // save manifest ending so we can restore it
  855. Vector<uint8_t> manifest_end;
  856. uint32_t manifest_cur_size = p_manifest.size();
  857. manifest_end.resize(p_manifest.size() - ofs);
  858. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  859. int32_t attr_name_string = string_table.find("name");
  860. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  861. int32_t ns_android_string = string_table.find("http://schemas.android.com/apk/res/android");
  862. if (ns_android_string == -1) {
  863. string_table.push_back("http://schemas.android.com/apk/res/android");
  864. ns_android_string = string_table.size() - 1;
  865. }
  866. int32_t attr_uses_feature_string = string_table.find("uses-feature");
  867. if (attr_uses_feature_string == -1) {
  868. string_table.push_back("uses-feature");
  869. attr_uses_feature_string = string_table.size() - 1;
  870. }
  871. int32_t attr_required_string = string_table.find("required");
  872. if (attr_required_string == -1) {
  873. string_table.push_back("required");
  874. attr_required_string = string_table.size() - 1;
  875. }
  876. for (int i = 0; i < feature_names.size(); i++) {
  877. String feature_name = feature_names[i];
  878. bool feature_required = feature_required_list[i];
  879. int feature_version = feature_versions[i];
  880. bool has_version_attribute = feature_version != -1;
  881. print_line("Adding feature " + feature_name);
  882. int32_t feature_string = string_table.find(feature_name);
  883. if (feature_string == -1) {
  884. string_table.push_back(feature_name);
  885. feature_string = string_table.size() - 1;
  886. }
  887. String required_value_string = feature_required ? "true" : "false";
  888. int32_t required_value = string_table.find(required_value_string);
  889. if (required_value == -1) {
  890. string_table.push_back(required_value_string);
  891. required_value = string_table.size() - 1;
  892. }
  893. int32_t attr_version_string = -1;
  894. int32_t version_value = -1;
  895. int tag_size;
  896. int attr_count;
  897. if (has_version_attribute) {
  898. attr_version_string = string_table.find("version");
  899. if (attr_version_string == -1) {
  900. string_table.push_back("version");
  901. attr_version_string = string_table.size() - 1;
  902. }
  903. version_value = string_table.find(itos(feature_version));
  904. if (version_value == -1) {
  905. string_table.push_back(itos(feature_version));
  906. version_value = string_table.size() - 1;
  907. }
  908. tag_size = 96; // node and three attrs + end node
  909. attr_count = 3;
  910. } else {
  911. tag_size = 76; // node and two attrs + end node
  912. attr_count = 2;
  913. }
  914. manifest_cur_size += tag_size + 24;
  915. p_manifest.resize(manifest_cur_size);
  916. // start tag
  917. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  918. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  919. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  920. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  921. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  922. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  923. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  924. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  925. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  926. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  927. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  928. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  929. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  930. // android:name attribute
  931. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  932. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  933. encode_uint32(feature_string, &p_manifest.write[ofs + 44]); // raw_value
  934. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  935. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  936. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  937. encode_uint32(feature_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  938. // android:required attribute
  939. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  940. encode_uint32(attr_required_string, &p_manifest.write[ofs + 60]); // 'name'
  941. encode_uint32(required_value, &p_manifest.write[ofs + 64]); // raw_value
  942. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  943. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  944. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  945. encode_uint32(required_value, &p_manifest.write[ofs + 72]); // typedvalue reference
  946. ofs += 76;
  947. if (has_version_attribute) {
  948. // android:version attribute
  949. encode_uint32(ns_android_string, &p_manifest.write[ofs]); // ns
  950. encode_uint32(attr_version_string, &p_manifest.write[ofs + 4]); // 'name'
  951. encode_uint32(version_value, &p_manifest.write[ofs + 8]); // raw_value
  952. encode_uint16(8, &p_manifest.write[ofs + 12]); // typedvalue_size
  953. p_manifest.write[ofs + 14] = 0; // typedvalue_always0
  954. p_manifest.write[ofs + 15] = 0x03; // typedvalue_type (string)
  955. encode_uint32(version_value, &p_manifest.write[ofs + 16]); // typedvalue reference
  956. ofs += 20;
  957. }
  958. // end tag
  959. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  960. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  961. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  962. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  963. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  964. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  965. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  966. ofs += 24;
  967. }
  968. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  969. ofs -= 24; // go back over back end
  970. }
  971. }
  972. if (tname == "manifest") {
  973. // save manifest ending so we can restore it
  974. Vector<uint8_t> manifest_end;
  975. uint32_t manifest_cur_size = p_manifest.size();
  976. manifest_end.resize(p_manifest.size() - ofs);
  977. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  978. int32_t attr_name_string = string_table.find("name");
  979. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  980. int32_t ns_android_string = string_table.find("android");
  981. ERR_FAIL_COND_MSG(ns_android_string == -1, "Template does not have 'android' namespace.");
  982. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  983. if (attr_uses_permission_string == -1) {
  984. string_table.push_back("uses-permission");
  985. attr_uses_permission_string = string_table.size() - 1;
  986. }
  987. for (int i = 0; i < perms.size(); ++i) {
  988. print_line("Adding permission " + perms[i]);
  989. manifest_cur_size += 56 + 24; // node + end node
  990. p_manifest.resize(manifest_cur_size);
  991. // Add permission to the string pool
  992. int32_t perm_string = string_table.find(perms[i]);
  993. if (perm_string == -1) {
  994. string_table.push_back(perms[i]);
  995. perm_string = string_table.size() - 1;
  996. }
  997. // start tag
  998. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  999. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1000. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  1001. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1002. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1003. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1004. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1005. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1006. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1007. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  1008. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1009. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1010. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1011. // attribute
  1012. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1013. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1014. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  1015. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1016. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1017. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1018. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1019. ofs += 56;
  1020. // end tag
  1021. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1022. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1023. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1024. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1025. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1026. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1027. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1028. ofs += 24;
  1029. }
  1030. // copy footer back in
  1031. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1032. }
  1033. } break;
  1034. }
  1035. ofs += size;
  1036. }
  1037. //create new andriodmanifest binary
  1038. Vector<uint8_t> ret;
  1039. ret.resize(string_table_begins + string_table.size() * 4);
  1040. for (uint32_t i = 0; i < string_table_begins; i++) {
  1041. ret.write[i] = p_manifest[i];
  1042. }
  1043. ofs = 0;
  1044. for (int i = 0; i < string_table.size(); i++) {
  1045. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1046. ofs += string_table[i].length() * 2 + 2 + 2;
  1047. }
  1048. ret.resize(ret.size() + ofs);
  1049. string_data_offset = ret.size() - ofs;
  1050. uint8_t *chars = &ret.write[string_data_offset];
  1051. for (int i = 0; i < string_table.size(); i++) {
  1052. String s = string_table[i];
  1053. encode_uint16(s.length(), chars);
  1054. chars += 2;
  1055. for (int j = 0; j < s.length(); j++) {
  1056. encode_uint16(s[j], chars);
  1057. chars += 2;
  1058. }
  1059. encode_uint16(0, chars);
  1060. chars += 2;
  1061. }
  1062. for (int i = 0; i < stable_extra.size(); i++) {
  1063. ret.push_back(stable_extra[i]);
  1064. }
  1065. //pad
  1066. while (ret.size() % 4) {
  1067. ret.push_back(0);
  1068. }
  1069. uint32_t new_stable_end = ret.size();
  1070. uint32_t extra = (p_manifest.size() - string_table_ends);
  1071. ret.resize(new_stable_end + extra);
  1072. for (uint32_t i = 0; i < extra; i++) {
  1073. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  1074. }
  1075. while (ret.size() % 4) {
  1076. ret.push_back(0);
  1077. }
  1078. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  1079. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  1080. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  1081. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  1082. p_manifest = ret;
  1083. }
  1084. static String _parse_string(const uint8_t *p_bytes, bool p_utf8) {
  1085. uint32_t offset = 0;
  1086. uint32_t len = 0;
  1087. if (p_utf8) {
  1088. uint8_t byte = p_bytes[offset];
  1089. if (byte & 0x80) {
  1090. offset += 2;
  1091. } else {
  1092. offset += 1;
  1093. }
  1094. byte = p_bytes[offset];
  1095. offset++;
  1096. if (byte & 0x80) {
  1097. len = byte & 0x7F;
  1098. len = (len << 8) + p_bytes[offset];
  1099. offset++;
  1100. } else {
  1101. len = byte;
  1102. }
  1103. } else {
  1104. len = decode_uint16(&p_bytes[offset]);
  1105. offset += 2;
  1106. if (len & 0x8000) {
  1107. len &= 0x7FFF;
  1108. len = (len << 16) + decode_uint16(&p_bytes[offset]);
  1109. offset += 2;
  1110. }
  1111. }
  1112. if (p_utf8) {
  1113. Vector<uint8_t> str8;
  1114. str8.resize(len + 1);
  1115. for (uint32_t i = 0; i < len; i++) {
  1116. str8.write[i] = p_bytes[offset + i];
  1117. }
  1118. str8.write[len] = 0;
  1119. String str;
  1120. str.parse_utf8((const char *)str8.ptr());
  1121. return str;
  1122. } else {
  1123. String str;
  1124. for (uint32_t i = 0; i < len; i++) {
  1125. CharType c = decode_uint16(&p_bytes[offset + i * 2]);
  1126. if (c == 0) {
  1127. break;
  1128. }
  1129. str += String::chr(c);
  1130. }
  1131. return str;
  1132. }
  1133. }
  1134. void _fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest) {
  1135. const int UTF8_FLAG = 0x00000100;
  1136. uint32_t string_block_len = decode_uint32(&p_manifest[16]);
  1137. uint32_t string_count = decode_uint32(&p_manifest[20]);
  1138. uint32_t string_flags = decode_uint32(&p_manifest[28]);
  1139. const uint32_t string_table_begins = 40;
  1140. Vector<String> string_table;
  1141. String package_name = p_preset->get("package/name");
  1142. for (uint32_t i = 0; i < string_count; i++) {
  1143. uint32_t offset = decode_uint32(&p_manifest[string_table_begins + i * 4]);
  1144. offset += string_table_begins + string_count * 4;
  1145. String str = _parse_string(&p_manifest[offset], string_flags & UTF8_FLAG);
  1146. if (str.begins_with("godot-project-name")) {
  1147. if (str == "godot-project-name") {
  1148. //project name
  1149. str = get_project_name(package_name);
  1150. } else {
  1151. String lang = str.substr(str.rfind("-") + 1, str.length()).replace("-", "_");
  1152. String prop = "application/config/name_" + lang;
  1153. if (ProjectSettings::get_singleton()->has_setting(prop)) {
  1154. str = ProjectSettings::get_singleton()->get(prop);
  1155. } else {
  1156. str = get_project_name(package_name);
  1157. }
  1158. }
  1159. }
  1160. string_table.push_back(str);
  1161. }
  1162. //write a new string table, but use 16 bits
  1163. Vector<uint8_t> ret;
  1164. ret.resize(string_table_begins + string_table.size() * 4);
  1165. for (uint32_t i = 0; i < string_table_begins; i++) {
  1166. ret.write[i] = p_manifest[i];
  1167. }
  1168. int ofs = 0;
  1169. for (int i = 0; i < string_table.size(); i++) {
  1170. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1171. ofs += string_table[i].length() * 2 + 2 + 2;
  1172. }
  1173. ret.resize(ret.size() + ofs);
  1174. uint8_t *chars = &ret.write[ret.size() - ofs];
  1175. for (int i = 0; i < string_table.size(); i++) {
  1176. String s = string_table[i];
  1177. encode_uint16(s.length(), chars);
  1178. chars += 2;
  1179. for (int j = 0; j < s.length(); j++) {
  1180. encode_uint16(s[j], chars);
  1181. chars += 2;
  1182. }
  1183. encode_uint16(0, chars);
  1184. chars += 2;
  1185. }
  1186. //pad
  1187. while (ret.size() % 4) {
  1188. ret.push_back(0);
  1189. }
  1190. //change flags to not use utf8
  1191. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  1192. //change length
  1193. encode_uint32(ret.size() - 12, &ret.write[16]);
  1194. //append the rest...
  1195. int rest_from = 12 + string_block_len;
  1196. int rest_to = ret.size();
  1197. int rest_len = (p_manifest.size() - rest_from);
  1198. ret.resize(ret.size() + (p_manifest.size() - rest_from));
  1199. for (int i = 0; i < rest_len; i++) {
  1200. ret.write[rest_to + i] = p_manifest[rest_from + i];
  1201. }
  1202. //finally update the size
  1203. encode_uint32(ret.size(), &ret.write[4]);
  1204. p_manifest = ret;
  1205. //printf("end\n");
  1206. }
  1207. void _process_launcher_icons(const String &p_processing_file_name, const Ref<Image> &p_source_image, const LauncherIcon p_icon, Vector<uint8_t> &p_data) {
  1208. if (p_processing_file_name == p_icon.export_path) {
  1209. Ref<Image> working_image = p_source_image;
  1210. if (p_source_image->get_width() != p_icon.dimensions || p_source_image->get_height() != p_icon.dimensions) {
  1211. working_image = p_source_image->duplicate();
  1212. working_image->resize(p_icon.dimensions, p_icon.dimensions, Image::Interpolation::INTERPOLATE_LANCZOS);
  1213. }
  1214. Vector<uint8_t> png_buffer;
  1215. Error err = PNGDriverCommon::image_to_png(working_image, png_buffer);
  1216. if (err == OK) {
  1217. p_data.resize(png_buffer.size());
  1218. memcpy(p_data.ptrw(), png_buffer.ptr(), p_data.size());
  1219. } else {
  1220. String err_str = String("Failed to convert resized icon (") + p_processing_file_name + ") to png.";
  1221. WARN_PRINT(err_str.utf8().get_data());
  1222. }
  1223. }
  1224. }
  1225. static Vector<String> get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  1226. Vector<String> abis = get_abis();
  1227. Vector<String> enabled_abis;
  1228. for (int i = 0; i < abis.size(); ++i) {
  1229. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  1230. if (is_enabled) {
  1231. enabled_abis.push_back(abis[i]);
  1232. }
  1233. }
  1234. return enabled_abis;
  1235. }
  1236. public:
  1237. typedef Error (*EditorExportSaveFunction)(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total);
  1238. public:
  1239. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  1240. String driver = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name");
  1241. if (driver == "GLES2") {
  1242. r_features->push_back("etc");
  1243. }
  1244. // FIXME: Review what texture formats are used for Vulkan.
  1245. if (driver == "Vulkan") {
  1246. r_features->push_back("etc2");
  1247. }
  1248. Vector<String> abis = get_enabled_abis(p_preset);
  1249. for (int i = 0; i < abis.size(); ++i) {
  1250. r_features->push_back(abis[i]);
  1251. }
  1252. }
  1253. virtual void get_export_options(List<ExportOption> *r_options) {
  1254. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/32_bits_framebuffer"), true));
  1255. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/xr_mode", PROPERTY_HINT_ENUM, "Regular,Oculus Mobile VR"), 0));
  1256. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/degrees_of_freedom", PROPERTY_HINT_ENUM, "None,3DOF and 6DOF,6DOF"), 0));
  1257. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/hand_tracking", PROPERTY_HINT_ENUM, "None,Optional,Required"), 0));
  1258. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "xr_features/focus_awareness"), false));
  1259. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "one_click_deploy/clear_previous_install"), false));
  1260. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1261. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1262. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "custom_template/use_custom_build"), false));
  1263. Vector<PluginConfig> plugins_configs = get_plugins();
  1264. for (int i = 0; i < plugins_configs.size(); i++) {
  1265. print_verbose("Found Android plugin " + plugins_configs[i].name);
  1266. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "plugins/" + plugins_configs[i].name), false));
  1267. }
  1268. plugins_changed = false;
  1269. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  1270. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  1271. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  1272. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "ext.domain.name"), "org.godotengine.$genname"));
  1273. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name [default if blank]"), ""));
  1274. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  1275. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  1276. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "screen/orientation", PROPERTY_HINT_ENUM, "Landscape,Portrait"), 0));
  1277. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  1278. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  1279. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  1280. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  1281. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/opengl_debug"), false));
  1282. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_icon_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1283. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_foreground_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1284. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_background_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1285. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"), ""));
  1286. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user"), ""));
  1287. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password"), ""));
  1288. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"), ""));
  1289. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  1290. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  1291. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  1292. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  1293. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  1294. Vector<String> abis = get_abis();
  1295. for (int i = 0; i < abis.size(); ++i) {
  1296. String abi = abis[i];
  1297. bool is_default = (abi == "armeabi-v7a" || abi == "arm64-v8a");
  1298. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  1299. }
  1300. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "permissions/custom_permissions"), PackedStringArray()));
  1301. const char **perms = android_perms;
  1302. while (*perms) {
  1303. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  1304. perms++;
  1305. }
  1306. }
  1307. virtual String get_name() const {
  1308. return "Android";
  1309. }
  1310. virtual String get_os_name() const {
  1311. return "Android";
  1312. }
  1313. virtual Ref<Texture2D> get_logo() const {
  1314. return logo;
  1315. }
  1316. virtual bool should_update_export_options() {
  1317. bool export_options_changed = plugins_changed;
  1318. if (export_options_changed) {
  1319. // don't clear unless we're reporting true, to avoid race
  1320. plugins_changed = false;
  1321. }
  1322. return export_options_changed;
  1323. }
  1324. virtual bool poll_export() {
  1325. bool dc = devices_changed;
  1326. if (dc) {
  1327. // don't clear unless we're reporting true, to avoid race
  1328. devices_changed = false;
  1329. }
  1330. return dc;
  1331. }
  1332. virtual int get_options_count() const {
  1333. MutexLock lock(device_lock);
  1334. return devices.size();
  1335. }
  1336. virtual String get_options_tooltip() const {
  1337. return TTR("Select device from the list");
  1338. }
  1339. virtual String get_option_label(int p_index) const {
  1340. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1341. MutexLock lock(device_lock);
  1342. return devices[p_index].name;
  1343. }
  1344. virtual String get_option_tooltip(int p_index) const {
  1345. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1346. MutexLock lock(device_lock);
  1347. String s = devices[p_index].description;
  1348. if (devices.size() == 1) {
  1349. // Tooltip will be:
  1350. // Name
  1351. // Description
  1352. s = devices[p_index].name + "\n\n" + s;
  1353. }
  1354. return s;
  1355. }
  1356. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  1357. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1358. String can_export_error;
  1359. bool can_export_missing_templates;
  1360. if (!can_export(p_preset, can_export_error, can_export_missing_templates)) {
  1361. EditorNode::add_io_error(can_export_error);
  1362. return ERR_UNCONFIGURED;
  1363. }
  1364. MutexLock lock(device_lock);
  1365. EditorProgress ep("run", "Running on " + devices[p_device].name, 3);
  1366. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1367. // Export_temp APK.
  1368. if (ep.step("Exporting APK...", 0)) {
  1369. return ERR_SKIP;
  1370. }
  1371. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  1372. const bool use_reverse = devices[p_device].api_level >= 21;
  1373. if (use_reverse) {
  1374. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  1375. }
  1376. String tmp_export_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport.apk");
  1377. #define CLEANUP_AND_RETURN(m_err) \
  1378. { \
  1379. DirAccess::remove_file_or_error(tmp_export_path); \
  1380. return m_err; \
  1381. }
  1382. // Export to temporary APK before sending to device.
  1383. Error err = export_project(p_preset, true, tmp_export_path, p_debug_flags);
  1384. if (err != OK) {
  1385. CLEANUP_AND_RETURN(err);
  1386. }
  1387. List<String> args;
  1388. int rv;
  1389. bool remove_prev = p_preset->get("one_click_deploy/clear_previous_install");
  1390. String version_name = p_preset->get("version/name");
  1391. String package_name = p_preset->get("package/unique_name");
  1392. if (remove_prev) {
  1393. if (ep.step("Uninstalling...", 1)) {
  1394. CLEANUP_AND_RETURN(ERR_SKIP);
  1395. }
  1396. print_line("Uninstalling previous version: " + devices[p_device].name);
  1397. args.push_back("-s");
  1398. args.push_back(devices[p_device].id);
  1399. args.push_back("uninstall");
  1400. args.push_back(get_package_name(package_name));
  1401. err = OS::get_singleton()->execute(adb, args, true, nullptr, nullptr, &rv);
  1402. }
  1403. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1404. if (ep.step("Installing to device, please wait...", 2)) {
  1405. CLEANUP_AND_RETURN(ERR_SKIP);
  1406. }
  1407. args.clear();
  1408. args.push_back("-s");
  1409. args.push_back(devices[p_device].id);
  1410. args.push_back("install");
  1411. args.push_back("-r");
  1412. args.push_back(tmp_export_path);
  1413. err = OS::get_singleton()->execute(adb, args, true, nullptr, nullptr, &rv);
  1414. if (err || rv != 0) {
  1415. EditorNode::add_io_error("Could not install to device.");
  1416. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1417. }
  1418. if (use_remote) {
  1419. if (use_reverse) {
  1420. static const char *const msg = "--- Device API >= 21; debugging over USB ---";
  1421. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1422. print_line(String(msg).to_upper());
  1423. args.clear();
  1424. args.push_back("-s");
  1425. args.push_back(devices[p_device].id);
  1426. args.push_back("reverse");
  1427. args.push_back("--remove-all");
  1428. OS::get_singleton()->execute(adb, args, true, nullptr, nullptr, &rv);
  1429. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  1430. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  1431. args.clear();
  1432. args.push_back("-s");
  1433. args.push_back(devices[p_device].id);
  1434. args.push_back("reverse");
  1435. args.push_back("tcp:" + itos(dbg_port));
  1436. args.push_back("tcp:" + itos(dbg_port));
  1437. OS::get_singleton()->execute(adb, args, true, nullptr, nullptr, &rv);
  1438. print_line("Reverse result: " + itos(rv));
  1439. }
  1440. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1441. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  1442. args.clear();
  1443. args.push_back("-s");
  1444. args.push_back(devices[p_device].id);
  1445. args.push_back("reverse");
  1446. args.push_back("tcp:" + itos(fs_port));
  1447. args.push_back("tcp:" + itos(fs_port));
  1448. err = OS::get_singleton()->execute(adb, args, true, nullptr, nullptr, &rv);
  1449. print_line("Reverse result2: " + itos(rv));
  1450. }
  1451. } else {
  1452. static const char *const msg = "--- Device API < 21; debugging over Wi-Fi ---";
  1453. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1454. print_line(String(msg).to_upper());
  1455. }
  1456. }
  1457. if (ep.step("Running on device...", 3)) {
  1458. CLEANUP_AND_RETURN(ERR_SKIP);
  1459. }
  1460. args.clear();
  1461. args.push_back("-s");
  1462. args.push_back(devices[p_device].id);
  1463. args.push_back("shell");
  1464. args.push_back("am");
  1465. args.push_back("start");
  1466. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  1467. args.push_back("--user");
  1468. args.push_back("0");
  1469. }
  1470. args.push_back("-a");
  1471. args.push_back("android.intent.action.MAIN");
  1472. args.push_back("-n");
  1473. args.push_back(get_package_name(package_name) + "/com.godot.game.GodotApp");
  1474. err = OS::get_singleton()->execute(adb, args, true, nullptr, nullptr, &rv);
  1475. if (err || rv != 0) {
  1476. EditorNode::add_io_error("Could not execute on device.");
  1477. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1478. }
  1479. CLEANUP_AND_RETURN(OK);
  1480. #undef CLEANUP_AND_RETURN
  1481. }
  1482. virtual Ref<Texture2D> get_run_icon() const {
  1483. return run_icon;
  1484. }
  1485. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1486. String err;
  1487. bool valid = false;
  1488. // Look for export templates (first official, and if defined custom templates).
  1489. if (!bool(p_preset->get("custom_template/use_custom_build"))) {
  1490. String template_err;
  1491. bool dvalid = false;
  1492. bool rvalid = false;
  1493. if (p_preset->get("custom_template/debug") != "") {
  1494. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1495. if (!dvalid) {
  1496. template_err += TTR("Custom debug template not found.") + "\n";
  1497. }
  1498. } else {
  1499. dvalid = exists_export_template("android_debug.apk", &template_err);
  1500. }
  1501. if (p_preset->get("custom_template/release") != "") {
  1502. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1503. if (!rvalid) {
  1504. template_err += TTR("Custom release template not found.") + "\n";
  1505. }
  1506. } else {
  1507. rvalid = exists_export_template("android_release.apk", &template_err);
  1508. }
  1509. valid = dvalid || rvalid;
  1510. if (!valid) {
  1511. err += template_err;
  1512. }
  1513. } else {
  1514. valid = exists_export_template("android_source.zip", &err);
  1515. }
  1516. r_missing_templates = !valid;
  1517. // Validate the rest of the configuration.
  1518. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1519. if (!FileAccess::exists(adb)) {
  1520. valid = false;
  1521. err += TTR("ADB executable not configured in the Editor Settings.") + "\n";
  1522. }
  1523. String js = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1524. if (!FileAccess::exists(js)) {
  1525. valid = false;
  1526. err += TTR("OpenJDK jarsigner not configured in the Editor Settings.") + "\n";
  1527. }
  1528. String dk = p_preset->get("keystore/debug");
  1529. if (!FileAccess::exists(dk)) {
  1530. dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1531. if (!FileAccess::exists(dk)) {
  1532. valid = false;
  1533. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  1534. }
  1535. }
  1536. String rk = p_preset->get("keystore/release");
  1537. if (!rk.empty() && !FileAccess::exists(rk)) {
  1538. valid = false;
  1539. err += TTR("Release keystore incorrectly configured in the export preset.") + "\n";
  1540. }
  1541. if (bool(p_preset->get("custom_template/use_custom_build"))) {
  1542. String sdk_path = EditorSettings::get_singleton()->get("export/android/custom_build_sdk_path");
  1543. if (sdk_path == "") {
  1544. err += TTR("Custom build requires a valid Android SDK path in Editor Settings.") + "\n";
  1545. valid = false;
  1546. } else {
  1547. Error errn;
  1548. DirAccessRef da = DirAccess::open(sdk_path.plus_file("platform-tools"), &errn);
  1549. if (errn != OK) {
  1550. err += TTR("Invalid Android SDK path for custom build in Editor Settings.") + "\n";
  1551. valid = false;
  1552. }
  1553. }
  1554. if (!FileAccess::exists("res://android/build/build.gradle")) {
  1555. err += TTR("Android build template not installed in the project. Install it from the Project menu.") + "\n";
  1556. valid = false;
  1557. }
  1558. }
  1559. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1560. if (apk_expansion) {
  1561. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1562. if (apk_expansion_pkey == "") {
  1563. valid = false;
  1564. err += TTR("Invalid public key for APK expansion.") + "\n";
  1565. }
  1566. }
  1567. String pn = p_preset->get("package/unique_name");
  1568. String pn_err;
  1569. if (!is_package_name_valid(get_package_name(pn), &pn_err)) {
  1570. valid = false;
  1571. err += TTR("Invalid package name:") + " " + pn_err + "\n";
  1572. }
  1573. String etc_error = test_etc2();
  1574. if (etc_error != String()) {
  1575. valid = false;
  1576. err += etc_error;
  1577. }
  1578. // Ensure that `Use Custom Build` is enabled if a plugin is selected.
  1579. String enabled_plugins_names = get_plugins_names(get_enabled_plugins(p_preset));
  1580. bool custom_build_enabled = p_preset->get("custom_template/use_custom_build");
  1581. if (!enabled_plugins_names.empty() && !custom_build_enabled) {
  1582. valid = false;
  1583. err += TTR("\"Use Custom Build\" must be enabled to use the plugins.");
  1584. err += "\n";
  1585. }
  1586. // Validate the Xr features are properly populated
  1587. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1588. int degrees_of_freedom = p_preset->get("xr_features/degrees_of_freedom");
  1589. int hand_tracking = p_preset->get("xr_features/hand_tracking");
  1590. bool focus_awareness = p_preset->get("xr_features/focus_awareness");
  1591. if (xr_mode_index != /* XRMode.OVR*/ 1) {
  1592. if (degrees_of_freedom > 0) {
  1593. valid = false;
  1594. err += TTR("\"Degrees Of Freedom\" is only valid when \"Xr Mode\" is \"Oculus Mobile VR\".");
  1595. err += "\n";
  1596. }
  1597. if (hand_tracking > 0) {
  1598. valid = false;
  1599. err += TTR("\"Hand Tracking\" is only valid when \"Xr Mode\" is \"Oculus Mobile VR\".");
  1600. err += "\n";
  1601. }
  1602. if (focus_awareness) {
  1603. valid = false;
  1604. err += TTR("\"Focus Awareness\" is only valid when \"Xr Mode\" is \"Oculus Mobile VR\".");
  1605. err += "\n";
  1606. }
  1607. }
  1608. r_error = err;
  1609. return valid;
  1610. }
  1611. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1612. List<String> list;
  1613. list.push_back("apk");
  1614. return list;
  1615. }
  1616. inline bool is_clean_build_required(Vector<PluginConfig> enabled_plugins) {
  1617. String plugin_names = get_plugins_names(enabled_plugins);
  1618. bool first_build = last_custom_build_time == 0;
  1619. bool have_plugins_changed = false;
  1620. if (!first_build) {
  1621. have_plugins_changed = plugin_names != last_plugin_names;
  1622. if (!have_plugins_changed) {
  1623. for (int i = 0; i < enabled_plugins.size(); i++) {
  1624. if (enabled_plugins.get(i).last_updated > last_custom_build_time) {
  1625. have_plugins_changed = true;
  1626. break;
  1627. }
  1628. }
  1629. }
  1630. }
  1631. last_custom_build_time = OS::get_singleton()->get_unix_time();
  1632. last_plugin_names = plugin_names;
  1633. return have_plugins_changed || first_build;
  1634. }
  1635. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) {
  1636. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1637. String src_apk;
  1638. EditorProgress ep("export", "Exporting for Android", 105, true);
  1639. if (bool(p_preset->get("custom_template/use_custom_build"))) { //custom build
  1640. //re-generate build.gradle and AndroidManifest.xml
  1641. { //test that installed build version is alright
  1642. FileAccessRef f = FileAccess::open("res://android/.build_version", FileAccess::READ);
  1643. if (!f) {
  1644. 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."));
  1645. return ERR_UNCONFIGURED;
  1646. }
  1647. String version = f->get_line().strip_edges();
  1648. if (version != VERSION_FULL_CONFIG) {
  1649. 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));
  1650. return ERR_UNCONFIGURED;
  1651. }
  1652. }
  1653. //build project if custom build is enabled
  1654. String sdk_path = EDITOR_GET("export/android/custom_build_sdk_path");
  1655. 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'.");
  1656. OS::get_singleton()->set_environment("ANDROID_HOME", sdk_path); //set and overwrite if required
  1657. String build_command;
  1658. #ifdef WINDOWS_ENABLED
  1659. build_command = "gradlew.bat";
  1660. #else
  1661. build_command = "gradlew";
  1662. #endif
  1663. String build_path = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/build");
  1664. build_command = build_path.plus_file(build_command);
  1665. String package_name = get_package_name(p_preset->get("package/unique_name"));
  1666. Vector<PluginConfig> enabled_plugins = get_enabled_plugins(p_preset);
  1667. String local_plugins_binaries = get_plugins_binaries(BINARY_TYPE_LOCAL, enabled_plugins);
  1668. String remote_plugins_binaries = get_plugins_binaries(BINARY_TYPE_REMOTE, enabled_plugins);
  1669. String custom_maven_repos = get_plugins_custom_maven_repos(enabled_plugins);
  1670. bool clean_build_required = is_clean_build_required(enabled_plugins);
  1671. List<String> cmdline;
  1672. if (clean_build_required) {
  1673. cmdline.push_back("clean");
  1674. }
  1675. cmdline.push_back("build");
  1676. cmdline.push_back("-Pexport_package_name=" + package_name); // argument to specify the package name.
  1677. cmdline.push_back("-Pplugins_local_binaries=" + local_plugins_binaries); // argument to specify the list of plugins local dependencies.
  1678. cmdline.push_back("-Pplugins_remote_binaries=" + remote_plugins_binaries); // argument to specify the list of plugins remote dependencies.
  1679. cmdline.push_back("-Pplugins_maven_repos=" + custom_maven_repos); // argument to specify the list of custom maven repos for the plugins dependencies.
  1680. cmdline.push_back("-p"); // argument to specify the start directory.
  1681. cmdline.push_back(build_path); // start directory.
  1682. /*{ used for debug
  1683. int ec;
  1684. String pipe;
  1685. OS::get_singleton()->execute(build_command, cmdline, true, nullptr, nullptr, &ec);
  1686. print_line("exit code: " + itos(ec));
  1687. }
  1688. */
  1689. int result = EditorNode::get_singleton()->execute_and_show_output(TTR("Building Android Project (gradle)"), build_command, cmdline);
  1690. if (result != 0) {
  1691. 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."));
  1692. return ERR_CANT_CREATE;
  1693. }
  1694. if (p_debug) {
  1695. src_apk = build_path.plus_file("build/outputs/apk/debug/android_debug.apk");
  1696. } else {
  1697. src_apk = build_path.plus_file("build/outputs/apk/release/android_release.apk");
  1698. }
  1699. if (!FileAccess::exists(src_apk)) {
  1700. EditorNode::get_singleton()->show_warning(TTR("No build apk generated at: ") + "\n" + src_apk);
  1701. return ERR_CANT_CREATE;
  1702. }
  1703. } else {
  1704. if (p_debug) {
  1705. src_apk = p_preset->get("custom_template/debug");
  1706. } else {
  1707. src_apk = p_preset->get("custom_template/release");
  1708. }
  1709. src_apk = src_apk.strip_edges();
  1710. if (src_apk == "") {
  1711. if (p_debug) {
  1712. src_apk = find_export_template("android_debug.apk");
  1713. } else {
  1714. src_apk = find_export_template("android_release.apk");
  1715. }
  1716. if (src_apk == "") {
  1717. EditorNode::add_io_error("Package not found: " + src_apk);
  1718. return ERR_FILE_NOT_FOUND;
  1719. }
  1720. }
  1721. }
  1722. if (!DirAccess::exists(p_path.get_base_dir())) {
  1723. return ERR_FILE_BAD_PATH;
  1724. }
  1725. FileAccess *src_f = nullptr;
  1726. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  1727. if (ep.step("Creating APK...", 0)) {
  1728. return ERR_SKIP;
  1729. }
  1730. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  1731. if (!pkg) {
  1732. EditorNode::add_io_error("Could not find template APK to export:\n" + src_apk);
  1733. return ERR_FILE_NOT_FOUND;
  1734. }
  1735. int ret = unzGoToFirstFile(pkg);
  1736. zlib_filefunc_def io2 = io;
  1737. FileAccess *dst_f = nullptr;
  1738. io2.opaque = &dst_f;
  1739. String tmp_unaligned_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport-unaligned.apk");
  1740. #define CLEANUP_AND_RETURN(m_err) \
  1741. { \
  1742. DirAccess::remove_file_or_error(tmp_unaligned_path); \
  1743. return m_err; \
  1744. }
  1745. zipFile unaligned_apk = zipOpen2(tmp_unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  1746. bool use_32_fb = p_preset->get("graphics/32_bits_framebuffer");
  1747. bool immersive = p_preset->get("screen/immersive_mode");
  1748. bool debug_opengl = p_preset->get("screen/opengl_debug");
  1749. bool _signed = p_preset->get("package/signed");
  1750. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1751. String cmdline = p_preset->get("command_line/extra_args");
  1752. int version_code = p_preset->get("version/code");
  1753. String version_name = p_preset->get("version/name");
  1754. String package_name = p_preset->get("package/unique_name");
  1755. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1756. String release_keystore = p_preset->get("keystore/release");
  1757. String release_username = p_preset->get("keystore/release_user");
  1758. String release_password = p_preset->get("keystore/release_password");
  1759. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  1760. String project_icon_path = ProjectSettings::get_singleton()->get("application/config/icon");
  1761. // 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.
  1762. Ref<Image> launcher_icon_image;
  1763. Ref<Image> launcher_adaptive_icon_foreground_image;
  1764. Ref<Image> launcher_adaptive_icon_background_image;
  1765. launcher_icon_image.instance();
  1766. launcher_adaptive_icon_foreground_image.instance();
  1767. launcher_adaptive_icon_background_image.instance();
  1768. // Regular icon: user selection -> project icon -> default.
  1769. String path = static_cast<String>(p_preset->get(launcher_icon_option)).strip_edges();
  1770. if (path.empty() || ImageLoader::load_image(path, launcher_icon_image) != OK) {
  1771. ImageLoader::load_image(project_icon_path, launcher_icon_image);
  1772. }
  1773. // Adaptive foreground: user selection -> regular icon (user selection -> project icon -> default).
  1774. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_foreground_option)).strip_edges();
  1775. if (path.empty() || ImageLoader::load_image(path, launcher_adaptive_icon_foreground_image) != OK) {
  1776. launcher_adaptive_icon_foreground_image = launcher_icon_image;
  1777. }
  1778. // Adaptive background: user selection -> default.
  1779. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_background_option)).strip_edges();
  1780. if (!path.empty()) {
  1781. ImageLoader::load_image(path, launcher_adaptive_icon_background_image);
  1782. }
  1783. Vector<String> invalid_abis(enabled_abis);
  1784. while (ret == UNZ_OK) {
  1785. //get filename
  1786. unz_file_info info;
  1787. char fname[16384];
  1788. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  1789. bool skip = false;
  1790. String file = fname;
  1791. Vector<uint8_t> data;
  1792. data.resize(info.uncompressed_size);
  1793. //read
  1794. unzOpenCurrentFile(pkg);
  1795. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  1796. unzCloseCurrentFile(pkg);
  1797. //write
  1798. if (file == "AndroidManifest.xml") {
  1799. _fix_manifest(p_preset, data, p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG));
  1800. }
  1801. if (file == "resources.arsc") {
  1802. _fix_resources(p_preset, data);
  1803. }
  1804. for (int i = 0; i < icon_densities_count; ++i) {
  1805. if (launcher_icon_image.is_valid() && !launcher_icon_image->empty()) {
  1806. _process_launcher_icons(file, launcher_icon_image, launcher_icons[i], data);
  1807. }
  1808. if (launcher_adaptive_icon_foreground_image.is_valid() && !launcher_adaptive_icon_foreground_image->empty()) {
  1809. _process_launcher_icons(file, launcher_adaptive_icon_foreground_image, launcher_adaptive_icon_foregrounds[i], data);
  1810. }
  1811. if (launcher_adaptive_icon_background_image.is_valid() && !launcher_adaptive_icon_background_image->empty()) {
  1812. _process_launcher_icons(file, launcher_adaptive_icon_background_image, launcher_adaptive_icon_backgrounds[i], data);
  1813. }
  1814. }
  1815. if (file.ends_with(".so")) {
  1816. bool enabled = false;
  1817. for (int i = 0; i < enabled_abis.size(); ++i) {
  1818. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  1819. invalid_abis.erase(enabled_abis[i]);
  1820. enabled = true;
  1821. break;
  1822. }
  1823. }
  1824. if (!enabled) {
  1825. skip = true;
  1826. }
  1827. }
  1828. if (file.begins_with("META-INF") && _signed) {
  1829. skip = true;
  1830. }
  1831. if (!skip) {
  1832. print_line("ADDING: " + file);
  1833. // Respect decision on compression made by AAPT for the export template
  1834. const bool uncompressed = info.compression_method == 0;
  1835. zip_fileinfo zipfi = get_zip_fileinfo();
  1836. zipOpenNewFileInZip(unaligned_apk,
  1837. file.utf8().get_data(),
  1838. &zipfi,
  1839. nullptr,
  1840. 0,
  1841. nullptr,
  1842. 0,
  1843. nullptr,
  1844. uncompressed ? 0 : Z_DEFLATED,
  1845. Z_DEFAULT_COMPRESSION);
  1846. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  1847. zipCloseFileInZip(unaligned_apk);
  1848. }
  1849. ret = unzGoToNextFile(pkg);
  1850. }
  1851. if (!invalid_abis.empty()) {
  1852. String unsupported_arch = String(", ").join(invalid_abis);
  1853. EditorNode::add_io_error("Missing libraries in the export template for the selected architectures: " + unsupported_arch + ".\n" +
  1854. "Please build a template with all required libraries, or uncheck the missing architectures in the export preset.");
  1855. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  1856. }
  1857. if (ep.step("Adding files...", 1)) {
  1858. CLEANUP_AND_RETURN(ERR_SKIP);
  1859. }
  1860. Error err = OK;
  1861. Vector<String> cl = cmdline.strip_edges().split(" ");
  1862. for (int i = 0; i < cl.size(); i++) {
  1863. if (cl[i].strip_edges().length() == 0) {
  1864. cl.remove(i);
  1865. i--;
  1866. }
  1867. }
  1868. gen_export_flags(cl, p_flags);
  1869. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1870. APKExportData ed;
  1871. ed.ep = &ep;
  1872. ed.apk = unaligned_apk;
  1873. err = export_project_files(p_preset, ignore_apk_file, &ed, save_apk_so);
  1874. } else {
  1875. //all files
  1876. if (apk_expansion) {
  1877. String apkfname = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  1878. String fullpath = p_path.get_base_dir().plus_file(apkfname);
  1879. err = save_pack(p_preset, fullpath);
  1880. if (err != OK) {
  1881. unzClose(pkg);
  1882. EditorNode::add_io_error("Could not write expansion package file: " + apkfname);
  1883. CLEANUP_AND_RETURN(ERR_SKIP);
  1884. }
  1885. cl.push_back("--use_apk_expansion");
  1886. cl.push_back("--apk_expansion_md5");
  1887. cl.push_back(FileAccess::get_md5(fullpath));
  1888. cl.push_back("--apk_expansion_key");
  1889. cl.push_back(apk_expansion_pkey.strip_edges());
  1890. } else {
  1891. APKExportData ed;
  1892. ed.ep = &ep;
  1893. ed.apk = unaligned_apk;
  1894. err = export_project_files(p_preset, save_apk_file, &ed, save_apk_so);
  1895. }
  1896. }
  1897. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1898. if (xr_mode_index == 1 /* XRMode.OVR */) {
  1899. cl.push_back("--xr_mode_ovr");
  1900. } else {
  1901. // XRMode.REGULAR is the default.
  1902. cl.push_back("--xr_mode_regular");
  1903. }
  1904. if (use_32_fb) {
  1905. cl.push_back("--use_depth_32");
  1906. }
  1907. if (immersive) {
  1908. cl.push_back("--use_immersive");
  1909. }
  1910. if (debug_opengl) {
  1911. cl.push_back("--debug_opengl");
  1912. }
  1913. if (cl.size()) {
  1914. //add comandline
  1915. Vector<uint8_t> clf;
  1916. clf.resize(4);
  1917. encode_uint32(cl.size(), &clf.write[0]);
  1918. for (int i = 0; i < cl.size(); i++) {
  1919. print_line(itos(i) + " param: " + cl[i]);
  1920. CharString txt = cl[i].utf8();
  1921. int base = clf.size();
  1922. int length = txt.length();
  1923. if (!length) {
  1924. continue;
  1925. }
  1926. clf.resize(base + 4 + length);
  1927. encode_uint32(length, &clf.write[base]);
  1928. copymem(&clf.write[base + 4], txt.ptr(), length);
  1929. }
  1930. zip_fileinfo zipfi = get_zip_fileinfo();
  1931. zipOpenNewFileInZip(unaligned_apk,
  1932. "assets/_cl_",
  1933. &zipfi,
  1934. nullptr,
  1935. 0,
  1936. nullptr,
  1937. 0,
  1938. nullptr,
  1939. 0, // No compress (little size gain and potentially slower startup)
  1940. Z_DEFAULT_COMPRESSION);
  1941. zipWriteInFileInZip(unaligned_apk, clf.ptr(), clf.size());
  1942. zipCloseFileInZip(unaligned_apk);
  1943. }
  1944. zipClose(unaligned_apk, nullptr);
  1945. unzClose(pkg);
  1946. if (err != OK) {
  1947. CLEANUP_AND_RETURN(err);
  1948. }
  1949. if (_signed) {
  1950. String jarsigner = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1951. if (!FileAccess::exists(jarsigner)) {
  1952. EditorNode::add_io_error("'jarsigner' could not be found.\nPlease supply a path in the Editor Settings.\nThe resulting APK is unsigned.");
  1953. CLEANUP_AND_RETURN(OK);
  1954. }
  1955. String keystore;
  1956. String password;
  1957. String user;
  1958. if (p_debug) {
  1959. keystore = p_preset->get("keystore/debug");
  1960. password = p_preset->get("keystore/debug_password");
  1961. user = p_preset->get("keystore/debug_user");
  1962. if (keystore.empty()) {
  1963. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1964. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  1965. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  1966. }
  1967. if (ep.step("Signing debug APK...", 103)) {
  1968. CLEANUP_AND_RETURN(ERR_SKIP);
  1969. }
  1970. } else {
  1971. keystore = release_keystore;
  1972. password = release_password;
  1973. user = release_username;
  1974. if (ep.step("Signing release APK...", 103)) {
  1975. CLEANUP_AND_RETURN(ERR_SKIP);
  1976. }
  1977. }
  1978. if (!FileAccess::exists(keystore)) {
  1979. EditorNode::add_io_error("Could not find keystore, unable to export.");
  1980. CLEANUP_AND_RETURN(ERR_FILE_CANT_OPEN);
  1981. }
  1982. List<String> args;
  1983. args.push_back("-digestalg");
  1984. args.push_back("SHA-256");
  1985. args.push_back("-sigalg");
  1986. args.push_back("SHA256withRSA");
  1987. String tsa_url = EditorSettings::get_singleton()->get("export/android/timestamping_authority_url");
  1988. if (tsa_url != "") {
  1989. args.push_back("-tsa");
  1990. args.push_back(tsa_url);
  1991. }
  1992. args.push_back("-verbose");
  1993. args.push_back("-keystore");
  1994. args.push_back(keystore);
  1995. args.push_back("-storepass");
  1996. args.push_back(password);
  1997. args.push_back(tmp_unaligned_path);
  1998. args.push_back(user);
  1999. int retval;
  2000. OS::get_singleton()->execute(jarsigner, args, true, nullptr, nullptr, &retval);
  2001. if (retval) {
  2002. EditorNode::add_io_error("'jarsigner' returned with error #" + itos(retval));
  2003. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  2004. }
  2005. if (ep.step("Verifying APK...", 104)) {
  2006. CLEANUP_AND_RETURN(ERR_SKIP);
  2007. }
  2008. args.clear();
  2009. args.push_back("-verify");
  2010. args.push_back("-keystore");
  2011. args.push_back(keystore);
  2012. args.push_back(tmp_unaligned_path);
  2013. args.push_back("-verbose");
  2014. OS::get_singleton()->execute(jarsigner, args, true, nullptr, nullptr, &retval);
  2015. if (retval) {
  2016. EditorNode::add_io_error("'jarsigner' verification of APK failed. Make sure to use a jarsigner from OpenJDK 8.");
  2017. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  2018. }
  2019. }
  2020. // Let's zip-align (must be done after signing)
  2021. static const int ZIP_ALIGNMENT = 4;
  2022. if (ep.step("Aligning APK...", 105)) {
  2023. CLEANUP_AND_RETURN(ERR_SKIP);
  2024. }
  2025. unzFile tmp_unaligned = unzOpen2(tmp_unaligned_path.utf8().get_data(), &io);
  2026. if (!tmp_unaligned) {
  2027. EditorNode::add_io_error("Could not unzip temporary unaligned APK.");
  2028. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2029. }
  2030. ret = unzGoToFirstFile(tmp_unaligned);
  2031. io2 = io;
  2032. dst_f = nullptr;
  2033. io2.opaque = &dst_f;
  2034. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2035. // Take files from the unaligned APK and write them out to the aligned one
  2036. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  2037. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  2038. int bias = 0;
  2039. while (ret == UNZ_OK) {
  2040. unz_file_info info;
  2041. memset(&info, 0, sizeof(info));
  2042. char fname[16384];
  2043. char extra[16384];
  2044. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, nullptr, 0);
  2045. String file = fname;
  2046. Vector<uint8_t> data;
  2047. data.resize(info.compressed_size);
  2048. // read
  2049. int method, level;
  2050. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  2051. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  2052. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  2053. unzCloseCurrentFile(tmp_unaligned);
  2054. // align
  2055. int padding = 0;
  2056. if (!info.compression_method) {
  2057. // Uncompressed file => Align
  2058. long new_offset = file_offset + bias;
  2059. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  2060. }
  2061. memset(extra + info.size_file_extra, 0, padding);
  2062. // write
  2063. zip_fileinfo zipfi = get_zip_fileinfo();
  2064. zipOpenNewFileInZip2(final_apk,
  2065. file.utf8().get_data(),
  2066. &zipfi,
  2067. extra,
  2068. info.size_file_extra + padding,
  2069. nullptr,
  2070. 0,
  2071. nullptr,
  2072. method,
  2073. level,
  2074. 1); // raw write
  2075. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  2076. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  2077. bias += padding;
  2078. ret = unzGoToNextFile(tmp_unaligned);
  2079. }
  2080. zipClose(final_apk, nullptr);
  2081. unzClose(tmp_unaligned);
  2082. CLEANUP_AND_RETURN(OK);
  2083. }
  2084. virtual void get_platform_features(List<String> *r_features) {
  2085. r_features->push_back("mobile");
  2086. r_features->push_back("Android");
  2087. }
  2088. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  2089. }
  2090. EditorExportPlatformAndroid() {
  2091. Ref<Image> img = memnew(Image(_android_logo));
  2092. logo.instance();
  2093. logo->create_from_image(img);
  2094. img = Ref<Image>(memnew(Image(_android_run_icon)));
  2095. run_icon.instance();
  2096. run_icon->create_from_image(img);
  2097. devices_changed = true;
  2098. plugins_changed = true;
  2099. quit_request = false;
  2100. check_for_changes_thread = Thread::create(_check_for_changes_poll_thread, this);
  2101. }
  2102. ~EditorExportPlatformAndroid() {
  2103. quit_request = true;
  2104. Thread::wait_to_finish(check_for_changes_thread);
  2105. memdelete(check_for_changes_thread);
  2106. }
  2107. };
  2108. void register_android_exporter() {
  2109. String exe_ext;
  2110. if (OS::get_singleton()->get_name() == "Windows") {
  2111. exe_ext = "*.exe";
  2112. }
  2113. EDITOR_DEF("export/android/adb", "");
  2114. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/adb", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  2115. EDITOR_DEF("export/android/jarsigner", "");
  2116. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/jarsigner", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  2117. EDITOR_DEF("export/android/debug_keystore", "");
  2118. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/debug_keystore", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"));
  2119. EDITOR_DEF("export/android/debug_keystore_user", "androiddebugkey");
  2120. EDITOR_DEF("export/android/debug_keystore_pass", "android");
  2121. EDITOR_DEF("export/android/force_system_user", false);
  2122. EDITOR_DEF("export/android/custom_build_sdk_path", "");
  2123. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/custom_build_sdk_path", PROPERTY_HINT_GLOBAL_DIR));
  2124. EDITOR_DEF("export/android/timestamping_authority_url", "");
  2125. EDITOR_DEF("export/android/shutdown_adb_on_exit", true);
  2126. Ref<EditorExportPlatformAndroid> exporter = Ref<EditorExportPlatformAndroid>(memnew(EditorExportPlatformAndroid));
  2127. EditorExport::get_singleton()->add_export_platform(exporter);
  2128. }