export.cpp 59 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978
  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/file_access.h"
  34. #include "core/os/os.h"
  35. #include "core/project_settings.h"
  36. #include "core/version.h"
  37. #include "editor/editor_export.h"
  38. #include "editor/editor_node.h"
  39. #include "editor/editor_settings.h"
  40. #include "platform/android/logo.gen.h"
  41. #include "platform/android/run_icon.gen.h"
  42. #include <string.h>
  43. static const char *android_perms[] = {
  44. "ACCESS_CHECKIN_PROPERTIES",
  45. "ACCESS_COARSE_LOCATION",
  46. "ACCESS_FINE_LOCATION",
  47. "ACCESS_LOCATION_EXTRA_COMMANDS",
  48. "ACCESS_MOCK_LOCATION",
  49. "ACCESS_NETWORK_STATE",
  50. "ACCESS_SURFACE_FLINGER",
  51. "ACCESS_WIFI_STATE",
  52. "ACCOUNT_MANAGER",
  53. "ADD_VOICEMAIL",
  54. "AUTHENTICATE_ACCOUNTS",
  55. "BATTERY_STATS",
  56. "BIND_ACCESSIBILITY_SERVICE",
  57. "BIND_APPWIDGET",
  58. "BIND_DEVICE_ADMIN",
  59. "BIND_INPUT_METHOD",
  60. "BIND_NFC_SERVICE",
  61. "BIND_NOTIFICATION_LISTENER_SERVICE",
  62. "BIND_PRINT_SERVICE",
  63. "BIND_REMOTEVIEWS",
  64. "BIND_TEXT_SERVICE",
  65. "BIND_VPN_SERVICE",
  66. "BIND_WALLPAPER",
  67. "BLUETOOTH",
  68. "BLUETOOTH_ADMIN",
  69. "BLUETOOTH_PRIVILEGED",
  70. "BRICK",
  71. "BROADCAST_PACKAGE_REMOVED",
  72. "BROADCAST_SMS",
  73. "BROADCAST_STICKY",
  74. "BROADCAST_WAP_PUSH",
  75. "CALL_PHONE",
  76. "CALL_PRIVILEGED",
  77. "CAMERA",
  78. "CAPTURE_AUDIO_OUTPUT",
  79. "CAPTURE_SECURE_VIDEO_OUTPUT",
  80. "CAPTURE_VIDEO_OUTPUT",
  81. "CHANGE_COMPONENT_ENABLED_STATE",
  82. "CHANGE_CONFIGURATION",
  83. "CHANGE_NETWORK_STATE",
  84. "CHANGE_WIFI_MULTICAST_STATE",
  85. "CHANGE_WIFI_STATE",
  86. "CLEAR_APP_CACHE",
  87. "CLEAR_APP_USER_DATA",
  88. "CONTROL_LOCATION_UPDATES",
  89. "DELETE_CACHE_FILES",
  90. "DELETE_PACKAGES",
  91. "DEVICE_POWER",
  92. "DIAGNOSTIC",
  93. "DISABLE_KEYGUARD",
  94. "DUMP",
  95. "EXPAND_STATUS_BAR",
  96. "FACTORY_TEST",
  97. "FLASHLIGHT",
  98. "FORCE_BACK",
  99. "GET_ACCOUNTS",
  100. "GET_PACKAGE_SIZE",
  101. "GET_TASKS",
  102. "GET_TOP_ACTIVITY_INFO",
  103. "GLOBAL_SEARCH",
  104. "HARDWARE_TEST",
  105. "INJECT_EVENTS",
  106. "INSTALL_LOCATION_PROVIDER",
  107. "INSTALL_PACKAGES",
  108. "INSTALL_SHORTCUT",
  109. "INTERNAL_SYSTEM_WINDOW",
  110. "INTERNET",
  111. "KILL_BACKGROUND_PROCESSES",
  112. "LOCATION_HARDWARE",
  113. "MANAGE_ACCOUNTS",
  114. "MANAGE_APP_TOKENS",
  115. "MANAGE_DOCUMENTS",
  116. "MASTER_CLEAR",
  117. "MEDIA_CONTENT_CONTROL",
  118. "MODIFY_AUDIO_SETTINGS",
  119. "MODIFY_PHONE_STATE",
  120. "MOUNT_FORMAT_FILESYSTEMS",
  121. "MOUNT_UNMOUNT_FILESYSTEMS",
  122. "NFC",
  123. "PERSISTENT_ACTIVITY",
  124. "PROCESS_OUTGOING_CALLS",
  125. "READ_CALENDAR",
  126. "READ_CALL_LOG",
  127. "READ_CONTACTS",
  128. "READ_EXTERNAL_STORAGE",
  129. "READ_FRAME_BUFFER",
  130. "READ_HISTORY_BOOKMARKS",
  131. "READ_INPUT_STATE",
  132. "READ_LOGS",
  133. "READ_PHONE_STATE",
  134. "READ_PROFILE",
  135. "READ_SMS",
  136. "READ_SOCIAL_STREAM",
  137. "READ_SYNC_SETTINGS",
  138. "READ_SYNC_STATS",
  139. "READ_USER_DICTIONARY",
  140. "REBOOT",
  141. "RECEIVE_BOOT_COMPLETED",
  142. "RECEIVE_MMS",
  143. "RECEIVE_SMS",
  144. "RECEIVE_WAP_PUSH",
  145. "RECORD_AUDIO",
  146. "REORDER_TASKS",
  147. "RESTART_PACKAGES",
  148. "SEND_RESPOND_VIA_MESSAGE",
  149. "SEND_SMS",
  150. "SET_ACTIVITY_WATCHER",
  151. "SET_ALARM",
  152. "SET_ALWAYS_FINISH",
  153. "SET_ANIMATION_SCALE",
  154. "SET_DEBUG_APP",
  155. "SET_ORIENTATION",
  156. "SET_POINTER_SPEED",
  157. "SET_PREFERRED_APPLICATIONS",
  158. "SET_PROCESS_LIMIT",
  159. "SET_TIME",
  160. "SET_TIME_ZONE",
  161. "SET_WALLPAPER",
  162. "SET_WALLPAPER_HINTS",
  163. "SIGNAL_PERSISTENT_PROCESSES",
  164. "STATUS_BAR",
  165. "SUBSCRIBED_FEEDS_READ",
  166. "SUBSCRIBED_FEEDS_WRITE",
  167. "SYSTEM_ALERT_WINDOW",
  168. "TRANSMIT_IR",
  169. "UNINSTALL_SHORTCUT",
  170. "UPDATE_DEVICE_STATS",
  171. "USE_CREDENTIALS",
  172. "USE_SIP",
  173. "VIBRATE",
  174. "WAKE_LOCK",
  175. "WRITE_APN_SETTINGS",
  176. "WRITE_CALENDAR",
  177. "WRITE_CALL_LOG",
  178. "WRITE_CONTACTS",
  179. "WRITE_EXTERNAL_STORAGE",
  180. "WRITE_GSERVICES",
  181. "WRITE_HISTORY_BOOKMARKS",
  182. "WRITE_PROFILE",
  183. "WRITE_SECURE_SETTINGS",
  184. "WRITE_SETTINGS",
  185. "WRITE_SMS",
  186. "WRITE_SOCIAL_STREAM",
  187. "WRITE_SYNC_SETTINGS",
  188. "WRITE_USER_DICTIONARY",
  189. NULL
  190. };
  191. struct LauncherIcon {
  192. const char *option_id;
  193. const char *export_path;
  194. };
  195. static const LauncherIcon launcher_icons[] = {
  196. { "launcher_icons/xxxhdpi_192x192", "res/drawable-xxxhdpi-v4/icon.png" },
  197. { "launcher_icons/xxhdpi_144x144", "res/drawable-xxhdpi-v4/icon.png" },
  198. { "launcher_icons/xhdpi_96x96", "res/drawable-xhdpi-v4/icon.png" },
  199. { "launcher_icons/hdpi_72x72", "res/drawable-hdpi-v4/icon.png" },
  200. { "launcher_icons/mdpi_48x48", "res/drawable-mdpi-v4/icon.png" }
  201. };
  202. class EditorExportPlatformAndroid : public EditorExportPlatform {
  203. GDCLASS(EditorExportPlatformAndroid, EditorExportPlatform)
  204. Ref<ImageTexture> logo;
  205. Ref<ImageTexture> run_icon;
  206. struct Device {
  207. String id;
  208. String name;
  209. String description;
  210. int api_level;
  211. };
  212. struct APKExportData {
  213. zipFile apk;
  214. EditorProgress *ep;
  215. };
  216. Vector<Device> devices;
  217. volatile bool devices_changed;
  218. Mutex *device_lock;
  219. Thread *device_thread;
  220. volatile bool quit_request;
  221. static void _device_poll_thread(void *ud) {
  222. EditorExportPlatformAndroid *ea = (EditorExportPlatformAndroid *)ud;
  223. while (!ea->quit_request) {
  224. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  225. if (FileAccess::exists(adb)) {
  226. String devices;
  227. List<String> args;
  228. args.push_back("devices");
  229. int ec;
  230. OS::get_singleton()->execute(adb, args, true, NULL, &devices, &ec);
  231. Vector<String> ds = devices.split("\n");
  232. Vector<String> ldevices;
  233. for (int i = 1; i < ds.size(); i++) {
  234. String d = ds[i];
  235. int dpos = d.find("device");
  236. if (dpos == -1)
  237. continue;
  238. d = d.substr(0, dpos).strip_edges();
  239. ldevices.push_back(d);
  240. }
  241. ea->device_lock->lock();
  242. bool different = false;
  243. if (ea->devices.size() != ldevices.size()) {
  244. different = true;
  245. } else {
  246. for (int i = 0; i < ea->devices.size(); i++) {
  247. if (ea->devices[i].id != ldevices[i]) {
  248. different = true;
  249. break;
  250. }
  251. }
  252. }
  253. if (different) {
  254. Vector<Device> ndevices;
  255. for (int i = 0; i < ldevices.size(); i++) {
  256. Device d;
  257. d.id = ldevices[i];
  258. for (int j = 0; j < ea->devices.size(); j++) {
  259. if (ea->devices[j].id == ldevices[i]) {
  260. d.description = ea->devices[j].description;
  261. d.name = ea->devices[j].name;
  262. d.api_level = ea->devices[j].api_level;
  263. }
  264. }
  265. if (d.description == "") {
  266. //in the oven, request!
  267. args.clear();
  268. args.push_back("-s");
  269. args.push_back(d.id);
  270. args.push_back("shell");
  271. args.push_back("getprop");
  272. int ec2;
  273. String dp;
  274. OS::get_singleton()->execute(adb, args, true, NULL, &dp, &ec2);
  275. Vector<String> props = dp.split("\n");
  276. String vendor;
  277. String device;
  278. d.description + "Device ID: " + d.id + "\n";
  279. d.api_level = 0;
  280. for (int j = 0; j < props.size(); j++) {
  281. // got information by `shell cat /system/build.prop` before and its format is "property=value"
  282. // it's now changed to use `shell getporp` because of permission issue with Android 8.0 and above
  283. // its format is "[property]: [value]" so changed it as like build.prop
  284. String p = props[j];
  285. p = p.replace("]: ", "=");
  286. p = p.replace("[", "");
  287. p = p.replace("]", "");
  288. if (p.begins_with("ro.product.model=")) {
  289. device = p.get_slice("=", 1).strip_edges();
  290. } else if (p.begins_with("ro.product.brand=")) {
  291. vendor = p.get_slice("=", 1).strip_edges().capitalize();
  292. } else if (p.begins_with("ro.build.display.id=")) {
  293. d.description += "Build: " + p.get_slice("=", 1).strip_edges() + "\n";
  294. } else if (p.begins_with("ro.build.version.release=")) {
  295. d.description += "Release: " + p.get_slice("=", 1).strip_edges() + "\n";
  296. } else if (p.begins_with("ro.build.version.sdk=")) {
  297. d.api_level = p.get_slice("=", 1).to_int();
  298. } else if (p.begins_with("ro.product.cpu.abi=")) {
  299. d.description += "CPU: " + p.get_slice("=", 1).strip_edges() + "\n";
  300. } else if (p.begins_with("ro.product.manufacturer=")) {
  301. d.description += "Manufacturer: " + p.get_slice("=", 1).strip_edges() + "\n";
  302. } else if (p.begins_with("ro.board.platform=")) {
  303. d.description += "Chipset: " + p.get_slice("=", 1).strip_edges() + "\n";
  304. } else if (p.begins_with("ro.opengles.version=")) {
  305. uint32_t opengl = p.get_slice("=", 1).to_int();
  306. d.description += "OpenGL: " + itos(opengl >> 16) + "." + itos((opengl >> 8) & 0xFF) + "." + itos((opengl)&0xFF) + "\n";
  307. }
  308. }
  309. d.name = vendor + " " + device;
  310. if (device == String()) continue;
  311. }
  312. ndevices.push_back(d);
  313. }
  314. ea->devices = ndevices;
  315. ea->devices_changed = true;
  316. }
  317. ea->device_lock->unlock();
  318. }
  319. uint64_t sleep = OS::get_singleton()->get_power_state() == OS::POWERSTATE_ON_BATTERY ? 1000 : 100;
  320. uint64_t wait = 3000000;
  321. uint64_t time = OS::get_singleton()->get_ticks_usec();
  322. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  323. OS::get_singleton()->delay_usec(1000 * sleep);
  324. if (ea->quit_request)
  325. break;
  326. }
  327. }
  328. if (EditorSettings::get_singleton()->get("export/android/shutdown_adb_on_exit")) {
  329. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  330. if (!FileAccess::exists(adb)) {
  331. return; //adb not configured
  332. }
  333. List<String> args;
  334. args.push_back("kill-server");
  335. OS::get_singleton()->execute(adb, args, true);
  336. };
  337. }
  338. String get_project_name(const String &p_name) const {
  339. String aname;
  340. if (p_name != "") {
  341. aname = p_name;
  342. } else {
  343. aname = ProjectSettings::get_singleton()->get("application/config/name");
  344. }
  345. if (aname == "") {
  346. aname = VERSION_NAME;
  347. }
  348. return aname;
  349. }
  350. String get_package_name(const String &p_package) const {
  351. String pname = p_package;
  352. String basename = ProjectSettings::get_singleton()->get("application/config/name");
  353. basename = basename.to_lower();
  354. String name;
  355. bool first = true;
  356. for (int i = 0; i < basename.length(); i++) {
  357. CharType c = basename[i];
  358. if (c >= '0' && c <= '9' && first) {
  359. continue;
  360. }
  361. if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9')) {
  362. name += String::chr(c);
  363. first = false;
  364. }
  365. }
  366. if (name == "")
  367. name = "noname";
  368. pname = pname.replace("$genname", name);
  369. return pname;
  370. }
  371. bool is_package_name_valid(const String &p_package, String *r_error = NULL) const {
  372. String pname = p_package;
  373. if (pname.length() == 0) {
  374. if (r_error) {
  375. *r_error = TTR("Package name is missing.");
  376. }
  377. return false;
  378. }
  379. int segments = 0;
  380. bool first = true;
  381. for (int i = 0; i < pname.length(); i++) {
  382. CharType c = pname[i];
  383. if (first && c == '.') {
  384. if (r_error) {
  385. *r_error = TTR("Package segments must be of non-zero length.");
  386. }
  387. return false;
  388. }
  389. if (c == '.') {
  390. segments++;
  391. first = true;
  392. continue;
  393. }
  394. if (!((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_')) {
  395. if (r_error) {
  396. *r_error = vformat(TTR("The character '%s' is not allowed in Android application package names."), String::chr(c));
  397. }
  398. return false;
  399. }
  400. if (first && (c >= '0' && c <= '9')) {
  401. if (r_error) {
  402. *r_error = TTR("A digit cannot be the first character in a package segment.");
  403. }
  404. return false;
  405. }
  406. if (first && c == '_') {
  407. if (r_error) {
  408. *r_error = vformat(TTR("The character '%s' cannot be the first character in a package segment."), String::chr(c));
  409. }
  410. return false;
  411. }
  412. first = false;
  413. }
  414. if (segments == 0) {
  415. if (r_error) {
  416. *r_error = TTR("The package must have at least one '.' separator.");
  417. }
  418. return false;
  419. }
  420. if (first) {
  421. if (r_error) {
  422. *r_error = TTR("Package segments must be of non-zero length.");
  423. }
  424. return false;
  425. }
  426. return true;
  427. }
  428. static bool _should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  429. /*
  430. * By not compressing files with little or not benefit in doing so,
  431. * a performance gain is expected attime. Moreover, if the APK is
  432. * zip-aligned, assets stored as they are can be efficiently read by
  433. * Android by memory-mapping them.
  434. */
  435. // -- Unconditional uncompress to mimic AAPT plus some other
  436. static const char *unconditional_compress_ext[] = {
  437. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  438. // These formats are already compressed, or don't compress well:
  439. ".jpg", ".jpeg", ".png", ".gif",
  440. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  441. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  442. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  443. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  444. ".amr", ".awb", ".wma", ".wmv",
  445. // Godot-specific:
  446. ".webp", // Same reasoning as .png
  447. ".cfb", // Don't let small config files slow-down startup
  448. ".scn", // Binary scenes are usually already compressed
  449. ".stex", // Streamable textures are usually already compressed
  450. // Trailer for easier processing
  451. NULL
  452. };
  453. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  454. if (p_path.to_lower().ends_with(String(*ext))) {
  455. return false;
  456. }
  457. }
  458. // -- Compressed resource?
  459. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  460. // Already compressed
  461. return false;
  462. }
  463. // --- TODO: Decide on texture resources according to their image compression setting
  464. return true;
  465. }
  466. static zip_fileinfo get_zip_fileinfo() {
  467. OS::Time time = OS::get_singleton()->get_time();
  468. OS::Date date = OS::get_singleton()->get_date();
  469. zip_fileinfo zipfi;
  470. zipfi.tmz_date.tm_hour = time.hour;
  471. zipfi.tmz_date.tm_mday = date.day;
  472. zipfi.tmz_date.tm_min = time.min;
  473. zipfi.tmz_date.tm_mon = date.month;
  474. zipfi.tmz_date.tm_sec = time.sec;
  475. zipfi.tmz_date.tm_year = date.year;
  476. zipfi.dosDate = 0;
  477. zipfi.external_fa = 0;
  478. zipfi.internal_fa = 0;
  479. return zipfi;
  480. }
  481. static Vector<String> get_abis() {
  482. Vector<String> abis;
  483. // We can still build armv6 in theory, but it doesn't make much
  484. // sense for games, so disabling for now.
  485. //abis.push_back("armeabi");
  486. abis.push_back("armeabi-v7a");
  487. abis.push_back("arm64-v8a");
  488. abis.push_back("x86");
  489. abis.push_back("x86_64");
  490. return abis;
  491. }
  492. static Error store_in_apk(APKExportData *ed, const String &p_path, const Vector<uint8_t> &p_data, int compression_method = Z_DEFLATED) {
  493. zip_fileinfo zipfi = get_zip_fileinfo();
  494. zipOpenNewFileInZip(ed->apk,
  495. p_path.utf8().get_data(),
  496. &zipfi,
  497. NULL,
  498. 0,
  499. NULL,
  500. 0,
  501. NULL,
  502. compression_method,
  503. Z_DEFAULT_COMPRESSION);
  504. zipWriteInFileInZip(ed->apk, p_data.ptr(), p_data.size());
  505. zipCloseFileInZip(ed->apk);
  506. return OK;
  507. }
  508. static Error save_apk_so(void *p_userdata, const SharedObject &p_so) {
  509. if (!p_so.path.get_file().begins_with("lib")) {
  510. String err = "Android .so file names must start with \"lib\", but got: " + p_so.path;
  511. ERR_PRINTS(err);
  512. return FAILED;
  513. }
  514. APKExportData *ed = (APKExportData *)p_userdata;
  515. Vector<String> abis = get_abis();
  516. bool exported = false;
  517. for (int i = 0; i < p_so.tags.size(); ++i) {
  518. // shared objects can be fat (compatible with multiple ABIs)
  519. int abi_index = abis.find(p_so.tags[i]);
  520. if (abi_index != -1) {
  521. exported = true;
  522. String abi = abis[abi_index];
  523. String dst_path = "lib/" + abi + "/" + p_so.path.get_file();
  524. Vector<uint8_t> array = FileAccess::get_file_as_array(p_so.path);
  525. Error store_err = store_in_apk(ed, dst_path, array);
  526. ERR_FAIL_COND_V(store_err, store_err);
  527. }
  528. }
  529. if (!exported) {
  530. String abis_string = String(" ").join(abis);
  531. String err = "Cannot determine ABI for library \"" + p_so.path + "\". One of the supported ABIs must be used as a tag: " + abis_string;
  532. ERR_PRINTS(err);
  533. return FAILED;
  534. }
  535. return OK;
  536. }
  537. static Error save_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  538. APKExportData *ed = (APKExportData *)p_userdata;
  539. String dst_path = p_path.replace_first("res://", "assets/");
  540. store_in_apk(ed, dst_path, p_data, _should_compress_asset(p_path, p_data) ? Z_DEFLATED : 0);
  541. ed->ep->step("File: " + p_path, 3 + p_file * 100 / p_total);
  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 screen_support_small = p_preset->get("screen/support_small");
  574. bool screen_support_normal = p_preset->get("screen/support_normal");
  575. bool screen_support_large = p_preset->get("screen/support_large");
  576. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  577. Vector<String> perms;
  578. const char **aperms = android_perms;
  579. while (*aperms) {
  580. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  581. if (enabled)
  582. perms.push_back("android.permission." + String(*aperms));
  583. aperms++;
  584. }
  585. PoolStringArray user_perms = p_preset->get("permissions/custom_permissions");
  586. for (int i = 0; i < user_perms.size(); i++) {
  587. String user_perm = user_perms[i].strip_edges();
  588. if (!user_perm.empty()) {
  589. perms.push_back(user_perm);
  590. }
  591. }
  592. if (p_give_internet) {
  593. if (perms.find("android.permission.INTERNET") == -1)
  594. perms.push_back("android.permission.INTERNET");
  595. }
  596. while (ofs < (uint32_t)p_manifest.size()) {
  597. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  598. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  599. switch (chunk) {
  600. case CHUNK_STRINGS: {
  601. int iofs = ofs + 8;
  602. string_count = decode_uint32(&p_manifest[iofs]);
  603. //styles_count = decode_uint32(&p_manifest[iofs + 4]);
  604. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  605. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  606. //styles_offset = decode_uint32(&p_manifest[iofs + 16]);
  607. /*
  608. printf("string count: %i\n",string_count);
  609. printf("flags: %i\n",string_flags);
  610. printf("sdata ofs: %i\n",string_data_offset);
  611. printf("styles ofs: %i\n",styles_offset);
  612. */
  613. uint32_t st_offset = iofs + 20;
  614. string_table.resize(string_count);
  615. uint32_t string_end = 0;
  616. string_table_begins = st_offset;
  617. for (uint32_t i = 0; i < string_count; i++) {
  618. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  619. string_at += st_offset + string_count * 4;
  620. ERR_EXPLAIN("Unimplemented, can't read utf8 string table.");
  621. ERR_FAIL_COND(string_flags & UTF8_FLAG);
  622. if (string_flags & UTF8_FLAG) {
  623. } else {
  624. uint32_t len = decode_uint16(&p_manifest[string_at]);
  625. Vector<CharType> ucstring;
  626. ucstring.resize(len + 1);
  627. for (uint32_t j = 0; j < len; j++) {
  628. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  629. ucstring.write[j] = c;
  630. }
  631. string_end = MAX(string_at + 2 + 2 * len, string_end);
  632. ucstring.write[len] = 0;
  633. string_table.write[i] = ucstring.ptr();
  634. }
  635. }
  636. for (uint32_t i = string_end; i < (ofs + size); i++) {
  637. stable_extra.push_back(p_manifest[i]);
  638. }
  639. string_table_ends = ofs + size;
  640. } break;
  641. case CHUNK_XML_START_TAG: {
  642. int iofs = ofs + 8;
  643. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  644. String tname = string_table[name];
  645. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  646. iofs += 28;
  647. for (uint32_t i = 0; i < attrcount; i++) {
  648. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  649. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  650. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  651. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  652. String value;
  653. if (attr_value != 0xFFFFFFFF)
  654. value = string_table[attr_value];
  655. else
  656. value = "Res #" + itos(attr_resid);
  657. String attrname = string_table[attr_name];
  658. String nspace;
  659. if (attr_nspace != 0xFFFFFFFF)
  660. nspace = string_table[attr_nspace];
  661. else
  662. nspace = "";
  663. //replace project information
  664. if (tname == "manifest" && attrname == "package") {
  665. string_table.write[attr_value] = get_package_name(package_name);
  666. }
  667. if (tname == "manifest" && attrname == "versionCode") {
  668. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  669. }
  670. if (tname == "manifest" && attrname == "versionName") {
  671. if (attr_value == 0xFFFFFFFF) {
  672. WARN_PRINT("Version name in a resource, should be plaintext")
  673. } else
  674. string_table.write[attr_value] = version_name;
  675. }
  676. if (tname == "activity" && attrname == "screenOrientation") {
  677. encode_uint32(orientation == 0 ? 0 : 1, &p_manifest.write[iofs + 16]);
  678. }
  679. if (tname == "supports-screens") {
  680. if (attrname == "smallScreens") {
  681. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  682. } else if (attrname == "normalScreens") {
  683. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  684. } else if (attrname == "largeScreens") {
  685. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  686. } else if (attrname == "xlargeScreens") {
  687. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  688. }
  689. }
  690. iofs += 20;
  691. }
  692. } break;
  693. case CHUNK_XML_END_TAG: {
  694. int iofs = ofs + 8;
  695. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  696. String tname = string_table[name];
  697. if (tname == "manifest") {
  698. // save manifest ending so we can restore it
  699. Vector<uint8_t> manifest_end;
  700. uint32_t manifest_cur_size = p_manifest.size();
  701. manifest_end.resize(p_manifest.size() - ofs);
  702. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  703. int32_t attr_name_string = string_table.find("name");
  704. ERR_EXPLAIN("Template does not have 'name' attribute");
  705. ERR_FAIL_COND(attr_name_string == -1);
  706. int32_t ns_android_string = string_table.find("android");
  707. ERR_EXPLAIN("Template does not have 'android' namespace");
  708. ERR_FAIL_COND(ns_android_string == -1);
  709. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  710. if (attr_uses_permission_string == -1) {
  711. string_table.push_back("uses-permission");
  712. attr_uses_permission_string = string_table.size() - 1;
  713. }
  714. for (int i = 0; i < perms.size(); ++i) {
  715. print_line("Adding permission " + perms[i]);
  716. manifest_cur_size += 56 + 24; // node + end node
  717. p_manifest.resize(manifest_cur_size);
  718. // Add permission to the string pool
  719. int32_t perm_string = string_table.find(perms[i]);
  720. if (perm_string == -1) {
  721. string_table.push_back(perms[i]);
  722. perm_string = string_table.size() - 1;
  723. }
  724. // start tag
  725. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  726. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  727. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  728. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  729. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  730. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  731. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  732. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  733. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  734. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  735. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  736. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  737. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  738. // attribute
  739. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  740. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  741. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  742. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  743. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  744. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  745. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  746. ofs += 56;
  747. // end tag
  748. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  749. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  750. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  751. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  752. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  753. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  754. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  755. ofs += 24;
  756. }
  757. // copy footer back in
  758. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  759. }
  760. } break;
  761. }
  762. ofs += size;
  763. }
  764. //create new andriodmanifest binary
  765. Vector<uint8_t> ret;
  766. ret.resize(string_table_begins + string_table.size() * 4);
  767. for (uint32_t i = 0; i < string_table_begins; i++) {
  768. ret.write[i] = p_manifest[i];
  769. }
  770. ofs = 0;
  771. for (int i = 0; i < string_table.size(); i++) {
  772. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  773. ofs += string_table[i].length() * 2 + 2 + 2;
  774. }
  775. ret.resize(ret.size() + ofs);
  776. string_data_offset = ret.size() - ofs;
  777. uint8_t *chars = &ret.write[string_data_offset];
  778. for (int i = 0; i < string_table.size(); i++) {
  779. String s = string_table[i];
  780. encode_uint16(s.length(), chars);
  781. chars += 2;
  782. for (int j = 0; j < s.length(); j++) {
  783. encode_uint16(s[j], chars);
  784. chars += 2;
  785. }
  786. encode_uint16(0, chars);
  787. chars += 2;
  788. }
  789. for (int i = 0; i < stable_extra.size(); i++) {
  790. ret.push_back(stable_extra[i]);
  791. }
  792. //pad
  793. while (ret.size() % 4)
  794. ret.push_back(0);
  795. uint32_t new_stable_end = ret.size();
  796. uint32_t extra = (p_manifest.size() - string_table_ends);
  797. ret.resize(new_stable_end + extra);
  798. for (uint32_t i = 0; i < extra; i++)
  799. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  800. while (ret.size() % 4)
  801. ret.push_back(0);
  802. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  803. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  804. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  805. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  806. p_manifest = ret;
  807. }
  808. static String _parse_string(const uint8_t *p_bytes, bool p_utf8) {
  809. uint32_t offset = 0;
  810. uint32_t len = decode_uint16(&p_bytes[offset]);
  811. if (p_utf8) {
  812. //don't know how to read extended utf8, this will have to be for now
  813. len >>= 8;
  814. }
  815. offset += 2;
  816. //printf("len %i, unicode: %i\n",len,int(p_utf8));
  817. if (p_utf8) {
  818. Vector<uint8_t> str8;
  819. str8.resize(len + 1);
  820. for (uint32_t i = 0; i < len; i++) {
  821. str8.write[i] = p_bytes[offset + i];
  822. }
  823. str8.write[len] = 0;
  824. String str;
  825. str.parse_utf8((const char *)str8.ptr());
  826. return str;
  827. } else {
  828. String str;
  829. for (uint32_t i = 0; i < len; i++) {
  830. CharType c = decode_uint16(&p_bytes[offset + i * 2]);
  831. if (c == 0)
  832. break;
  833. str += String::chr(c);
  834. }
  835. return str;
  836. }
  837. }
  838. void _fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest) {
  839. const int UTF8_FLAG = 0x00000100;
  840. uint32_t string_block_len = decode_uint32(&p_manifest[16]);
  841. uint32_t string_count = decode_uint32(&p_manifest[20]);
  842. uint32_t string_flags = decode_uint32(&p_manifest[28]);
  843. const uint32_t string_table_begins = 40;
  844. Vector<String> string_table;
  845. String package_name = p_preset->get("package/name");
  846. for (uint32_t i = 0; i < string_count; i++) {
  847. uint32_t offset = decode_uint32(&p_manifest[string_table_begins + i * 4]);
  848. offset += string_table_begins + string_count * 4;
  849. String str = _parse_string(&p_manifest[offset], string_flags & UTF8_FLAG);
  850. if (str.begins_with("godot-project-name")) {
  851. if (str == "godot-project-name") {
  852. //project name
  853. str = get_project_name(package_name);
  854. } else {
  855. String lang = str.substr(str.find_last("-") + 1, str.length()).replace("-", "_");
  856. String prop = "application/config/name_" + lang;
  857. if (ProjectSettings::get_singleton()->has_setting(prop)) {
  858. str = ProjectSettings::get_singleton()->get(prop);
  859. } else {
  860. str = get_project_name(package_name);
  861. }
  862. }
  863. }
  864. string_table.push_back(str);
  865. }
  866. //write a new string table, but use 16 bits
  867. Vector<uint8_t> ret;
  868. ret.resize(string_table_begins + string_table.size() * 4);
  869. for (uint32_t i = 0; i < string_table_begins; i++) {
  870. ret.write[i] = p_manifest[i];
  871. }
  872. int ofs = 0;
  873. for (int i = 0; i < string_table.size(); i++) {
  874. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  875. ofs += string_table[i].length() * 2 + 2 + 2;
  876. }
  877. ret.resize(ret.size() + ofs);
  878. uint8_t *chars = &ret.write[ret.size() - ofs];
  879. for (int i = 0; i < string_table.size(); i++) {
  880. String s = string_table[i];
  881. encode_uint16(s.length(), chars);
  882. chars += 2;
  883. for (int j = 0; j < s.length(); j++) {
  884. encode_uint16(s[j], chars);
  885. chars += 2;
  886. }
  887. encode_uint16(0, chars);
  888. chars += 2;
  889. }
  890. //pad
  891. while (ret.size() % 4)
  892. ret.push_back(0);
  893. //change flags to not use utf8
  894. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  895. //change length
  896. encode_uint32(ret.size() - 12, &ret.write[16]);
  897. //append the rest...
  898. int rest_from = 12 + string_block_len;
  899. int rest_to = ret.size();
  900. int rest_len = (p_manifest.size() - rest_from);
  901. ret.resize(ret.size() + (p_manifest.size() - rest_from));
  902. for (int i = 0; i < rest_len; i++) {
  903. ret.write[rest_to + i] = p_manifest[rest_from + i];
  904. }
  905. //finally update the size
  906. encode_uint32(ret.size(), &ret.write[4]);
  907. p_manifest = ret;
  908. //printf("end\n");
  909. }
  910. static Vector<String> get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  911. Vector<String> abis = get_abis();
  912. Vector<String> enabled_abis;
  913. for (int i = 0; i < abis.size(); ++i) {
  914. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  915. if (is_enabled) {
  916. enabled_abis.push_back(abis[i]);
  917. }
  918. }
  919. return enabled_abis;
  920. }
  921. public:
  922. typedef Error (*EditorExportSaveFunction)(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total);
  923. public:
  924. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  925. String driver = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name");
  926. if (driver == "GLES2") {
  927. r_features->push_back("etc");
  928. } else if (driver == "GLES3") {
  929. r_features->push_back("etc2");
  930. }
  931. Vector<String> abis = get_enabled_abis(p_preset);
  932. for (int i = 0; i < abis.size(); ++i) {
  933. r_features->push_back(abis[i]);
  934. }
  935. }
  936. virtual void get_export_options(List<ExportOption> *r_options) {
  937. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/32_bits_framebuffer"), true));
  938. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "one_click_deploy/clear_previous_install"), true));
  939. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_package/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  940. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_package/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  941. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  942. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  943. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  944. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.$genname"), ""));
  945. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name"), ""));
  946. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  947. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  948. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "screen/orientation", PROPERTY_HINT_ENUM, "Landscape,Portrait"), 0));
  949. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  950. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  951. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  952. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  953. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/opengl_debug"), false));
  954. for (unsigned int i = 0; i < sizeof(launcher_icons) / sizeof(launcher_icons[0]); ++i) {
  955. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_icons[i].option_id, PROPERTY_HINT_FILE, "*.png"), ""));
  956. }
  957. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"), ""));
  958. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user"), ""));
  959. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password"), ""));
  960. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"), ""));
  961. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  962. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  963. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  964. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  965. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  966. Vector<String> abis = get_abis();
  967. for (int i = 0; i < abis.size(); ++i) {
  968. String abi = abis[i];
  969. bool is_default = (abi == "armeabi-v7a" || abi == "arm64-v8a");
  970. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  971. }
  972. r_options->push_back(ExportOption(PropertyInfo(Variant::POOL_STRING_ARRAY, "permissions/custom_permissions"), PoolStringArray()));
  973. const char **perms = android_perms;
  974. while (*perms) {
  975. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  976. perms++;
  977. }
  978. }
  979. virtual String get_name() const {
  980. return "Android";
  981. }
  982. virtual String get_os_name() const {
  983. return "Android";
  984. }
  985. virtual Ref<Texture> get_logo() const {
  986. return logo;
  987. }
  988. virtual bool poll_devices() {
  989. bool dc = devices_changed;
  990. if (dc) {
  991. // don't clear unless we're reporting true, to avoid race
  992. devices_changed = false;
  993. }
  994. return dc;
  995. }
  996. virtual int get_device_count() const {
  997. device_lock->lock();
  998. int dc = devices.size();
  999. device_lock->unlock();
  1000. return dc;
  1001. }
  1002. virtual String get_device_name(int p_device) const {
  1003. ERR_FAIL_INDEX_V(p_device, devices.size(), "");
  1004. device_lock->lock();
  1005. String s = devices[p_device].name;
  1006. device_lock->unlock();
  1007. return s;
  1008. }
  1009. virtual String get_device_info(int p_device) const {
  1010. ERR_FAIL_INDEX_V(p_device, devices.size(), "");
  1011. device_lock->lock();
  1012. String s = devices[p_device].description;
  1013. device_lock->unlock();
  1014. return s;
  1015. }
  1016. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  1017. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1018. device_lock->lock();
  1019. EditorProgress ep("run", "Running on " + devices[p_device].name, 3);
  1020. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1021. if (adb == "") {
  1022. EditorNode::add_io_error("ADB executable not configured in settings, can't run.");
  1023. device_lock->unlock();
  1024. return ERR_UNCONFIGURED;
  1025. }
  1026. //export_temp
  1027. ep.step("Exporting APK", 0);
  1028. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  1029. const bool use_reverse = devices[p_device].api_level >= 21;
  1030. if (use_reverse)
  1031. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  1032. String export_to = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport.apk");
  1033. Error err = export_project(p_preset, true, export_to, p_debug_flags);
  1034. if (err) {
  1035. device_lock->unlock();
  1036. return err;
  1037. }
  1038. List<String> args;
  1039. int rv;
  1040. bool remove_prev = p_preset->get("one_click_deploy/clear_previous_install");
  1041. String version_name = p_preset->get("version/name");
  1042. String package_name = p_preset->get("package/unique_name");
  1043. if (remove_prev) {
  1044. ep.step("Uninstalling...", 1);
  1045. print_line("Uninstalling previous version: " + devices[p_device].name);
  1046. args.push_back("-s");
  1047. args.push_back(devices[p_device].id);
  1048. args.push_back("uninstall");
  1049. args.push_back(get_package_name(package_name));
  1050. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1051. }
  1052. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1053. ep.step("Installing to device (please wait...)", 2);
  1054. args.clear();
  1055. args.push_back("-s");
  1056. args.push_back(devices[p_device].id);
  1057. args.push_back("install");
  1058. args.push_back("-r");
  1059. args.push_back(export_to);
  1060. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1061. if (err || rv != 0) {
  1062. EditorNode::add_io_error("Could not install to device.");
  1063. device_lock->unlock();
  1064. return ERR_CANT_CREATE;
  1065. }
  1066. if (use_remote) {
  1067. if (use_reverse) {
  1068. static const char *const msg = "** Device API >= 21; debugging over USB **";
  1069. EditorNode::get_singleton()->get_log()->add_message(msg);
  1070. print_line(String(msg).to_upper());
  1071. args.clear();
  1072. args.push_back("-s");
  1073. args.push_back(devices[p_device].id);
  1074. args.push_back("reverse");
  1075. args.push_back("--remove-all");
  1076. OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1077. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  1078. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  1079. args.clear();
  1080. args.push_back("-s");
  1081. args.push_back(devices[p_device].id);
  1082. args.push_back("reverse");
  1083. args.push_back("tcp:" + itos(dbg_port));
  1084. args.push_back("tcp:" + itos(dbg_port));
  1085. OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1086. print_line("Reverse result: " + itos(rv));
  1087. }
  1088. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1089. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  1090. args.clear();
  1091. args.push_back("-s");
  1092. args.push_back(devices[p_device].id);
  1093. args.push_back("reverse");
  1094. args.push_back("tcp:" + itos(fs_port));
  1095. args.push_back("tcp:" + itos(fs_port));
  1096. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1097. print_line("Reverse result2: " + itos(rv));
  1098. }
  1099. } else {
  1100. static const char *const msg = "** Device API < 21; debugging over Wi-Fi **";
  1101. EditorNode::get_singleton()->get_log()->add_message(msg);
  1102. print_line(String(msg).to_upper());
  1103. }
  1104. }
  1105. ep.step("Running on Device...", 3);
  1106. args.clear();
  1107. args.push_back("-s");
  1108. args.push_back(devices[p_device].id);
  1109. args.push_back("shell");
  1110. args.push_back("am");
  1111. args.push_back("start");
  1112. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  1113. args.push_back("--user");
  1114. args.push_back("0");
  1115. }
  1116. args.push_back("-a");
  1117. args.push_back("android.intent.action.MAIN");
  1118. args.push_back("-n");
  1119. args.push_back(get_package_name(package_name) + "/org.godotengine.godot.Godot");
  1120. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1121. if (err || rv != 0) {
  1122. EditorNode::add_io_error("Could not execute on device.");
  1123. device_lock->unlock();
  1124. return ERR_CANT_CREATE;
  1125. }
  1126. device_lock->unlock();
  1127. return OK;
  1128. }
  1129. virtual Ref<Texture> get_run_icon() const {
  1130. return run_icon;
  1131. }
  1132. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1133. String err;
  1134. r_missing_templates = find_export_template("android_debug.apk") == String() || find_export_template("android_release.apk") == String();
  1135. if (p_preset->get("custom_package/debug") != "") {
  1136. if (FileAccess::exists(p_preset->get("custom_package/debug"))) {
  1137. r_missing_templates = false;
  1138. } else {
  1139. err += TTR("Custom debug template not found.") + "\n";
  1140. }
  1141. }
  1142. if (p_preset->get("custom_package/release") != "") {
  1143. if (FileAccess::exists(p_preset->get("custom_package/release"))) {
  1144. r_missing_templates = false;
  1145. } else {
  1146. err += TTR("Custom release template not found.") + "\n";
  1147. }
  1148. }
  1149. bool valid = !r_missing_templates;
  1150. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1151. if (!FileAccess::exists(adb)) {
  1152. valid = false;
  1153. err += TTR("ADB executable not configured in the Editor Settings.") + "\n";
  1154. }
  1155. String js = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1156. if (!FileAccess::exists(js)) {
  1157. valid = false;
  1158. err += TTR("OpenJDK jarsigner not configured in the Editor Settings.") + "\n";
  1159. }
  1160. String dk = p_preset->get("keystore/debug");
  1161. if (!FileAccess::exists(dk)) {
  1162. dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1163. if (!FileAccess::exists(dk)) {
  1164. valid = false;
  1165. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  1166. }
  1167. }
  1168. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1169. if (apk_expansion) {
  1170. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1171. if (apk_expansion_pkey == "") {
  1172. valid = false;
  1173. err += TTR("Invalid public key for APK expansion.") + "\n";
  1174. }
  1175. }
  1176. String pn = p_preset->get("package/unique_name");
  1177. String pn_err;
  1178. if (!is_package_name_valid(get_package_name(pn), &pn_err)) {
  1179. valid = false;
  1180. err += TTR("Invalid package name:") + " " + pn_err + "\n";
  1181. }
  1182. String etc_error = test_etc2();
  1183. if (etc_error != String()) {
  1184. valid = false;
  1185. err += etc_error;
  1186. }
  1187. r_error = err;
  1188. return valid;
  1189. }
  1190. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1191. List<String> list;
  1192. list.push_back("apk");
  1193. return list;
  1194. }
  1195. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) {
  1196. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1197. String src_apk;
  1198. EditorProgress ep("export", "Exporting for Android", 105);
  1199. if (p_debug)
  1200. src_apk = p_preset->get("custom_package/debug");
  1201. else
  1202. src_apk = p_preset->get("custom_package/release");
  1203. src_apk = src_apk.strip_edges();
  1204. if (src_apk == "") {
  1205. if (p_debug) {
  1206. src_apk = find_export_template("android_debug.apk");
  1207. } else {
  1208. src_apk = find_export_template("android_release.apk");
  1209. }
  1210. if (src_apk == "") {
  1211. EditorNode::add_io_error("Package not found: " + src_apk);
  1212. return ERR_FILE_NOT_FOUND;
  1213. }
  1214. }
  1215. if (!FileAccess::exists(p_path.get_base_dir())) {
  1216. return ERR_FILE_BAD_PATH;
  1217. }
  1218. FileAccess *src_f = NULL;
  1219. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  1220. ep.step("Creating APK", 0);
  1221. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  1222. if (!pkg) {
  1223. EditorNode::add_io_error("Could not find template APK to export:\n" + src_apk);
  1224. return ERR_FILE_NOT_FOUND;
  1225. }
  1226. ERR_FAIL_COND_V(!pkg, ERR_CANT_OPEN);
  1227. int ret = unzGoToFirstFile(pkg);
  1228. zlib_filefunc_def io2 = io;
  1229. FileAccess *dst_f = NULL;
  1230. io2.opaque = &dst_f;
  1231. String unaligned_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport-unaligned.apk");
  1232. zipFile unaligned_apk = zipOpen2(unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
  1233. bool use_32_fb = p_preset->get("graphics/32_bits_framebuffer");
  1234. bool immersive = p_preset->get("screen/immersive_mode");
  1235. bool debug_opengl = p_preset->get("screen/opengl_debug");
  1236. bool _signed = p_preset->get("package/signed");
  1237. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1238. String cmdline = p_preset->get("command_line/extra_args");
  1239. int version_code = p_preset->get("version/code");
  1240. String version_name = p_preset->get("version/name");
  1241. String package_name = p_preset->get("package/unique_name");
  1242. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1243. String release_keystore = p_preset->get("keystore/release");
  1244. String release_username = p_preset->get("keystore/release_user");
  1245. String release_password = p_preset->get("keystore/release_password");
  1246. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  1247. while (ret == UNZ_OK) {
  1248. //get filename
  1249. unz_file_info info;
  1250. char fname[16384];
  1251. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, NULL, 0, NULL, 0);
  1252. bool skip = false;
  1253. String file = fname;
  1254. Vector<uint8_t> data;
  1255. data.resize(info.uncompressed_size);
  1256. //read
  1257. unzOpenCurrentFile(pkg);
  1258. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  1259. unzCloseCurrentFile(pkg);
  1260. //write
  1261. if (file == "AndroidManifest.xml") {
  1262. _fix_manifest(p_preset, data, p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG));
  1263. }
  1264. if (file == "resources.arsc") {
  1265. _fix_resources(p_preset, data);
  1266. }
  1267. if (file == "res/drawable-nodpi-v4/icon.png") {
  1268. bool found = false;
  1269. for (unsigned int i = 0; i < sizeof(launcher_icons) / sizeof(launcher_icons[0]); ++i) {
  1270. String icon_path = String(p_preset->get(launcher_icons[i].option_id)).strip_edges();
  1271. if (icon_path != "" && icon_path.ends_with(".png")) {
  1272. FileAccess *f = FileAccess::open(icon_path, FileAccess::READ);
  1273. if (f) {
  1274. data.resize(f->get_len());
  1275. f->get_buffer(data.ptrw(), data.size());
  1276. memdelete(f);
  1277. found = true;
  1278. break;
  1279. }
  1280. }
  1281. }
  1282. if (!found) {
  1283. String appicon = ProjectSettings::get_singleton()->get("application/config/icon");
  1284. if (appicon != "" && appicon.ends_with(".png")) {
  1285. FileAccess *f = FileAccess::open(appicon, FileAccess::READ);
  1286. if (f) {
  1287. data.resize(f->get_len());
  1288. f->get_buffer(data.ptrw(), data.size());
  1289. memdelete(f);
  1290. }
  1291. }
  1292. }
  1293. }
  1294. if (file.ends_with(".so")) {
  1295. bool enabled = false;
  1296. for (int i = 0; i < enabled_abis.size(); ++i) {
  1297. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  1298. enabled = true;
  1299. break;
  1300. }
  1301. }
  1302. if (!enabled) {
  1303. skip = true;
  1304. }
  1305. }
  1306. if (file.begins_with("META-INF") && _signed) {
  1307. skip = true;
  1308. }
  1309. if (!skip) {
  1310. print_line("ADDING: " + file);
  1311. // Respect decision on compression made by AAPT for the export template
  1312. const bool uncompressed = info.compression_method == 0;
  1313. zip_fileinfo zipfi = get_zip_fileinfo();
  1314. zipOpenNewFileInZip(unaligned_apk,
  1315. file.utf8().get_data(),
  1316. &zipfi,
  1317. NULL,
  1318. 0,
  1319. NULL,
  1320. 0,
  1321. NULL,
  1322. uncompressed ? 0 : Z_DEFLATED,
  1323. Z_DEFAULT_COMPRESSION);
  1324. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  1325. zipCloseFileInZip(unaligned_apk);
  1326. }
  1327. ret = unzGoToNextFile(pkg);
  1328. }
  1329. ep.step("Adding Files...", 1);
  1330. Error err = OK;
  1331. Vector<String> cl = cmdline.strip_edges().split(" ");
  1332. for (int i = 0; i < cl.size(); i++) {
  1333. if (cl[i].strip_edges().length() == 0) {
  1334. cl.remove(i);
  1335. i--;
  1336. }
  1337. }
  1338. gen_export_flags(cl, p_flags);
  1339. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1340. APKExportData ed;
  1341. ed.ep = &ep;
  1342. ed.apk = unaligned_apk;
  1343. err = export_project_files(p_preset, ignore_apk_file, &ed, save_apk_so);
  1344. } else {
  1345. //all files
  1346. if (apk_expansion) {
  1347. String apkfname = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  1348. String fullpath = p_path.get_base_dir().plus_file(apkfname);
  1349. err = save_pack(p_preset, fullpath);
  1350. if (err != OK) {
  1351. unzClose(pkg);
  1352. EditorNode::add_io_error("Could not write expansion package file: " + apkfname);
  1353. return OK;
  1354. }
  1355. cl.push_back("--use_apk_expansion");
  1356. cl.push_back("--apk_expansion_md5");
  1357. cl.push_back(FileAccess::get_md5(fullpath));
  1358. cl.push_back("--apk_expansion_key");
  1359. cl.push_back(apk_expansion_pkey.strip_edges());
  1360. } else {
  1361. APKExportData ed;
  1362. ed.ep = &ep;
  1363. ed.apk = unaligned_apk;
  1364. err = export_project_files(p_preset, save_apk_file, &ed, save_apk_so);
  1365. }
  1366. }
  1367. if (!err) {
  1368. APKExportData ed;
  1369. ed.ep = &ep;
  1370. ed.apk = unaligned_apk;
  1371. for (unsigned int i = 0; i < sizeof(launcher_icons) / sizeof(launcher_icons[0]); ++i) {
  1372. String icon_path = String(p_preset->get(launcher_icons[i].option_id)).strip_edges();
  1373. if (icon_path != "" && icon_path.ends_with(".png") && FileAccess::exists(icon_path)) {
  1374. Vector<uint8_t> data = FileAccess::get_file_as_array(icon_path);
  1375. store_in_apk(&ed, launcher_icons[i].export_path, data);
  1376. }
  1377. }
  1378. }
  1379. if (use_32_fb)
  1380. cl.push_back("--use_depth_32");
  1381. if (immersive)
  1382. cl.push_back("--use_immersive");
  1383. if (debug_opengl)
  1384. cl.push_back("--debug_opengl");
  1385. if (cl.size()) {
  1386. //add comandline
  1387. Vector<uint8_t> clf;
  1388. clf.resize(4);
  1389. encode_uint32(cl.size(), &clf.write[0]);
  1390. for (int i = 0; i < cl.size(); i++) {
  1391. print_line(itos(i) + " param: " + cl[i]);
  1392. CharString txt = cl[i].utf8();
  1393. int base = clf.size();
  1394. int length = txt.length();
  1395. if (!length)
  1396. continue;
  1397. clf.resize(base + 4 + length);
  1398. encode_uint32(length, &clf.write[base]);
  1399. copymem(&clf.write[base + 4], txt.ptr(), length);
  1400. }
  1401. zip_fileinfo zipfi = get_zip_fileinfo();
  1402. zipOpenNewFileInZip(unaligned_apk,
  1403. "assets/_cl_",
  1404. &zipfi,
  1405. NULL,
  1406. 0,
  1407. NULL,
  1408. 0,
  1409. NULL,
  1410. 0, // No compress (little size gain and potentially slower startup)
  1411. Z_DEFAULT_COMPRESSION);
  1412. zipWriteInFileInZip(unaligned_apk, clf.ptr(), clf.size());
  1413. zipCloseFileInZip(unaligned_apk);
  1414. }
  1415. zipClose(unaligned_apk, NULL);
  1416. unzClose(pkg);
  1417. if (err) {
  1418. return err;
  1419. }
  1420. if (_signed) {
  1421. String jarsigner = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1422. if (!FileAccess::exists(jarsigner)) {
  1423. EditorNode::add_io_error("'jarsigner' could not be found.\nPlease supply a path in the Editor Settings.\nThe resulting APK is unsigned.");
  1424. return OK;
  1425. }
  1426. String keystore;
  1427. String password;
  1428. String user;
  1429. if (p_debug) {
  1430. keystore = p_preset->get("keystore/debug");
  1431. password = p_preset->get("keystore/debug_password");
  1432. user = p_preset->get("keystore/debug_user");
  1433. if (keystore.empty()) {
  1434. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1435. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  1436. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  1437. }
  1438. ep.step("Signing debug APK...", 103);
  1439. } else {
  1440. keystore = release_keystore;
  1441. password = release_password;
  1442. user = release_username;
  1443. ep.step("Signing release APK...", 103);
  1444. }
  1445. if (!FileAccess::exists(keystore)) {
  1446. EditorNode::add_io_error("Could not find keystore, unable to export.");
  1447. return ERR_FILE_CANT_OPEN;
  1448. }
  1449. List<String> args;
  1450. args.push_back("-digestalg");
  1451. args.push_back("SHA-256");
  1452. args.push_back("-sigalg");
  1453. args.push_back("SHA256withRSA");
  1454. String tsa_url = EditorSettings::get_singleton()->get("export/android/timestamping_authority_url");
  1455. if (tsa_url != "") {
  1456. args.push_back("-tsa");
  1457. args.push_back(tsa_url);
  1458. }
  1459. args.push_back("-verbose");
  1460. args.push_back("-keystore");
  1461. args.push_back(keystore);
  1462. args.push_back("-storepass");
  1463. args.push_back(password);
  1464. args.push_back(unaligned_path);
  1465. args.push_back(user);
  1466. int retval;
  1467. OS::get_singleton()->execute(jarsigner, args, true, NULL, NULL, &retval);
  1468. if (retval) {
  1469. EditorNode::add_io_error("'jarsigner' returned with error #" + itos(retval));
  1470. return ERR_CANT_CREATE;
  1471. }
  1472. ep.step("Verifying APK...", 104);
  1473. args.clear();
  1474. args.push_back("-verify");
  1475. args.push_back("-keystore");
  1476. args.push_back(keystore);
  1477. args.push_back(unaligned_path);
  1478. args.push_back("-verbose");
  1479. OS::get_singleton()->execute(jarsigner, args, true, NULL, NULL, &retval);
  1480. if (retval) {
  1481. EditorNode::add_io_error("'jarsigner' verification of APK failed. Make sure to use a jarsigner from OpenJDK 8.");
  1482. return ERR_CANT_CREATE;
  1483. }
  1484. }
  1485. // Let's zip-align (must be done after signing)
  1486. static const int ZIP_ALIGNMENT = 4;
  1487. ep.step("Aligning APK...", 105);
  1488. unzFile tmp_unaligned = unzOpen2(unaligned_path.utf8().get_data(), &io);
  1489. if (!tmp_unaligned) {
  1490. EditorNode::add_io_error("Could not find temp unaligned APK.");
  1491. return ERR_FILE_NOT_FOUND;
  1492. }
  1493. ERR_FAIL_COND_V(!tmp_unaligned, ERR_CANT_OPEN);
  1494. ret = unzGoToFirstFile(tmp_unaligned);
  1495. io2 = io;
  1496. dst_f = NULL;
  1497. io2.opaque = &dst_f;
  1498. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
  1499. // Take files from the unaligned APK and write them out to the aligned one
  1500. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  1501. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  1502. int bias = 0;
  1503. while (ret == UNZ_OK) {
  1504. unz_file_info info;
  1505. memset(&info, 0, sizeof(info));
  1506. char fname[16384];
  1507. char extra[16384];
  1508. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, NULL, 0);
  1509. String file = fname;
  1510. Vector<uint8_t> data;
  1511. data.resize(info.compressed_size);
  1512. // read
  1513. int method, level;
  1514. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  1515. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  1516. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  1517. unzCloseCurrentFile(tmp_unaligned);
  1518. // align
  1519. int padding = 0;
  1520. if (!info.compression_method) {
  1521. // Uncompressed file => Align
  1522. long new_offset = file_offset + bias;
  1523. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  1524. }
  1525. memset(extra + info.size_file_extra, 0, padding);
  1526. // write
  1527. zip_fileinfo zipfi = get_zip_fileinfo();
  1528. zipOpenNewFileInZip2(final_apk,
  1529. file.utf8().get_data(),
  1530. &zipfi,
  1531. extra,
  1532. info.size_file_extra + padding,
  1533. NULL,
  1534. 0,
  1535. NULL,
  1536. method,
  1537. level,
  1538. 1); // raw write
  1539. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  1540. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  1541. bias += padding;
  1542. ret = unzGoToNextFile(tmp_unaligned);
  1543. }
  1544. zipClose(final_apk, NULL);
  1545. unzClose(tmp_unaligned);
  1546. if (err) {
  1547. return err;
  1548. }
  1549. return OK;
  1550. }
  1551. virtual void get_platform_features(List<String> *r_features) {
  1552. r_features->push_back("mobile");
  1553. r_features->push_back("Android");
  1554. }
  1555. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  1556. }
  1557. EditorExportPlatformAndroid() {
  1558. Ref<Image> img = memnew(Image(_android_logo));
  1559. logo.instance();
  1560. logo->create_from_image(img);
  1561. img = Ref<Image>(memnew(Image(_android_run_icon)));
  1562. run_icon.instance();
  1563. run_icon->create_from_image(img);
  1564. device_lock = Mutex::create();
  1565. devices_changed = true;
  1566. quit_request = false;
  1567. device_thread = Thread::create(_device_poll_thread, this);
  1568. }
  1569. ~EditorExportPlatformAndroid() {
  1570. quit_request = true;
  1571. Thread::wait_to_finish(device_thread);
  1572. memdelete(device_lock);
  1573. memdelete(device_thread);
  1574. }
  1575. };
  1576. void register_android_exporter() {
  1577. String exe_ext;
  1578. if (OS::get_singleton()->get_name() == "Windows") {
  1579. exe_ext = "*.exe";
  1580. }
  1581. EDITOR_DEF("export/android/adb", "");
  1582. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/adb", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  1583. EDITOR_DEF("export/android/jarsigner", "");
  1584. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/jarsigner", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  1585. EDITOR_DEF("export/android/debug_keystore", "");
  1586. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/debug_keystore", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"));
  1587. EDITOR_DEF("export/android/debug_keystore_user", "androiddebugkey");
  1588. EDITOR_DEF("export/android/debug_keystore_pass", "android");
  1589. EDITOR_DEF("export/android/force_system_user", false);
  1590. EDITOR_DEF("export/android/timestamping_authority_url", "");
  1591. EDITOR_DEF("export/android/shutdown_adb_on_exit", true);
  1592. Ref<EditorExportPlatformAndroid> exporter = Ref<EditorExportPlatformAndroid>(memnew(EditorExportPlatformAndroid));
  1593. EditorExport::get_singleton()->add_export_platform(exporter);
  1594. }