export.cpp 79 KB

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