export.cpp 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986
  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 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. Vector<String> perms;
  580. const char **aperms = android_perms;
  581. while (*aperms) {
  582. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  583. if (enabled)
  584. perms.push_back("android.permission." + String(*aperms));
  585. aperms++;
  586. }
  587. PoolStringArray user_perms = p_preset->get("permissions/custom_permissions");
  588. for (int i = 0; i < user_perms.size(); i++) {
  589. String user_perm = user_perms[i].strip_edges();
  590. if (!user_perm.empty()) {
  591. perms.push_back(user_perm);
  592. }
  593. }
  594. if (p_give_internet) {
  595. if (perms.find("android.permission.INTERNET") == -1)
  596. perms.push_back("android.permission.INTERNET");
  597. }
  598. while (ofs < (uint32_t)p_manifest.size()) {
  599. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  600. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  601. switch (chunk) {
  602. case CHUNK_STRINGS: {
  603. int iofs = ofs + 8;
  604. string_count = decode_uint32(&p_manifest[iofs]);
  605. //styles_count = decode_uint32(&p_manifest[iofs + 4]);
  606. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  607. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  608. //styles_offset = decode_uint32(&p_manifest[iofs + 16]);
  609. /*
  610. printf("string count: %i\n",string_count);
  611. printf("flags: %i\n",string_flags);
  612. printf("sdata ofs: %i\n",string_data_offset);
  613. printf("styles ofs: %i\n",styles_offset);
  614. */
  615. uint32_t st_offset = iofs + 20;
  616. string_table.resize(string_count);
  617. uint32_t string_end = 0;
  618. string_table_begins = st_offset;
  619. for (uint32_t i = 0; i < string_count; i++) {
  620. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  621. string_at += st_offset + string_count * 4;
  622. ERR_EXPLAIN("Unimplemented, can't read utf8 string table.");
  623. ERR_FAIL_COND(string_flags & UTF8_FLAG);
  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. String value;
  655. if (attr_value != 0xFFFFFFFF)
  656. value = string_table[attr_value];
  657. else
  658. value = "Res #" + itos(attr_resid);
  659. String attrname = string_table[attr_name];
  660. String nspace;
  661. if (attr_nspace != 0xFFFFFFFF)
  662. nspace = string_table[attr_nspace];
  663. else
  664. nspace = "";
  665. //replace project information
  666. if (tname == "manifest" && attrname == "package") {
  667. string_table.write[attr_value] = get_package_name(package_name);
  668. }
  669. if (tname == "manifest" && attrname == "versionCode") {
  670. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  671. }
  672. if (tname == "manifest" && attrname == "versionName") {
  673. if (attr_value == 0xFFFFFFFF) {
  674. WARN_PRINT("Version name in a resource, should be plaintext")
  675. } else
  676. string_table.write[attr_value] = version_name;
  677. }
  678. if (tname == "activity" && attrname == "screenOrientation") {
  679. encode_uint32(orientation == 0 ? 0 : 1, &p_manifest.write[iofs + 16]);
  680. }
  681. if (tname == "supports-screens") {
  682. if (attrname == "smallScreens") {
  683. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  684. } else if (attrname == "normalScreens") {
  685. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  686. } else if (attrname == "largeScreens") {
  687. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  688. } else if (attrname == "xlargeScreens") {
  689. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  690. }
  691. }
  692. if (tname == "uses-feature" && attrname == "glEsVersion") {
  693. encode_uint32(min_gles3 ? 0x00030000 : 0x00020000, &p_manifest.write[iofs + 16]);
  694. }
  695. iofs += 20;
  696. }
  697. } break;
  698. case CHUNK_XML_END_TAG: {
  699. int iofs = ofs + 8;
  700. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  701. String tname = string_table[name];
  702. if (tname == "manifest") {
  703. // save manifest ending so we can restore it
  704. Vector<uint8_t> manifest_end;
  705. uint32_t manifest_cur_size = p_manifest.size();
  706. manifest_end.resize(p_manifest.size() - ofs);
  707. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  708. int32_t attr_name_string = string_table.find("name");
  709. ERR_EXPLAIN("Template does not have 'name' attribute");
  710. ERR_FAIL_COND(attr_name_string == -1);
  711. int32_t ns_android_string = string_table.find("android");
  712. ERR_EXPLAIN("Template does not have 'android' namespace");
  713. ERR_FAIL_COND(ns_android_string == -1);
  714. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  715. if (attr_uses_permission_string == -1) {
  716. string_table.push_back("uses-permission");
  717. attr_uses_permission_string = string_table.size() - 1;
  718. }
  719. for (int i = 0; i < perms.size(); ++i) {
  720. print_line("Adding permission " + perms[i]);
  721. manifest_cur_size += 56 + 24; // node + end node
  722. p_manifest.resize(manifest_cur_size);
  723. // Add permission to the string pool
  724. int32_t perm_string = string_table.find(perms[i]);
  725. if (perm_string == -1) {
  726. string_table.push_back(perms[i]);
  727. perm_string = string_table.size() - 1;
  728. }
  729. // start tag
  730. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  731. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  732. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  733. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  734. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  735. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  736. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  737. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  738. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  739. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  740. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  741. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  742. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  743. // attribute
  744. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  745. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  746. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  747. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  748. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  749. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  750. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  751. ofs += 56;
  752. // end tag
  753. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  754. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  755. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  756. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  757. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  758. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  759. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  760. ofs += 24;
  761. }
  762. // copy footer back in
  763. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  764. }
  765. } break;
  766. }
  767. ofs += size;
  768. }
  769. //create new andriodmanifest binary
  770. Vector<uint8_t> ret;
  771. ret.resize(string_table_begins + string_table.size() * 4);
  772. for (uint32_t i = 0; i < string_table_begins; i++) {
  773. ret.write[i] = p_manifest[i];
  774. }
  775. ofs = 0;
  776. for (int i = 0; i < string_table.size(); i++) {
  777. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  778. ofs += string_table[i].length() * 2 + 2 + 2;
  779. }
  780. ret.resize(ret.size() + ofs);
  781. string_data_offset = ret.size() - ofs;
  782. uint8_t *chars = &ret.write[string_data_offset];
  783. for (int i = 0; i < string_table.size(); i++) {
  784. String s = string_table[i];
  785. encode_uint16(s.length(), chars);
  786. chars += 2;
  787. for (int j = 0; j < s.length(); j++) {
  788. encode_uint16(s[j], chars);
  789. chars += 2;
  790. }
  791. encode_uint16(0, chars);
  792. chars += 2;
  793. }
  794. for (int i = 0; i < stable_extra.size(); i++) {
  795. ret.push_back(stable_extra[i]);
  796. }
  797. //pad
  798. while (ret.size() % 4)
  799. ret.push_back(0);
  800. uint32_t new_stable_end = ret.size();
  801. uint32_t extra = (p_manifest.size() - string_table_ends);
  802. ret.resize(new_stable_end + extra);
  803. for (uint32_t i = 0; i < extra; i++)
  804. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  805. while (ret.size() % 4)
  806. ret.push_back(0);
  807. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  808. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  809. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  810. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  811. p_manifest = ret;
  812. }
  813. static String _parse_string(const uint8_t *p_bytes, bool p_utf8) {
  814. uint32_t offset = 0;
  815. uint32_t len = decode_uint16(&p_bytes[offset]);
  816. if (p_utf8) {
  817. //don't know how to read extended utf8, this will have to be for now
  818. len >>= 8;
  819. }
  820. offset += 2;
  821. //printf("len %i, unicode: %i\n",len,int(p_utf8));
  822. if (p_utf8) {
  823. Vector<uint8_t> str8;
  824. str8.resize(len + 1);
  825. for (uint32_t i = 0; i < len; i++) {
  826. str8.write[i] = p_bytes[offset + i];
  827. }
  828. str8.write[len] = 0;
  829. String str;
  830. str.parse_utf8((const char *)str8.ptr());
  831. return str;
  832. } else {
  833. String str;
  834. for (uint32_t i = 0; i < len; i++) {
  835. CharType c = decode_uint16(&p_bytes[offset + i * 2]);
  836. if (c == 0)
  837. break;
  838. str += String::chr(c);
  839. }
  840. return str;
  841. }
  842. }
  843. void _fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest) {
  844. const int UTF8_FLAG = 0x00000100;
  845. uint32_t string_block_len = decode_uint32(&p_manifest[16]);
  846. uint32_t string_count = decode_uint32(&p_manifest[20]);
  847. uint32_t string_flags = decode_uint32(&p_manifest[28]);
  848. const uint32_t string_table_begins = 40;
  849. Vector<String> string_table;
  850. String package_name = p_preset->get("package/name");
  851. for (uint32_t i = 0; i < string_count; i++) {
  852. uint32_t offset = decode_uint32(&p_manifest[string_table_begins + i * 4]);
  853. offset += string_table_begins + string_count * 4;
  854. String str = _parse_string(&p_manifest[offset], string_flags & UTF8_FLAG);
  855. if (str.begins_with("godot-project-name")) {
  856. if (str == "godot-project-name") {
  857. //project name
  858. str = get_project_name(package_name);
  859. } else {
  860. String lang = str.substr(str.find_last("-") + 1, str.length()).replace("-", "_");
  861. String prop = "application/config/name_" + lang;
  862. if (ProjectSettings::get_singleton()->has_setting(prop)) {
  863. str = ProjectSettings::get_singleton()->get(prop);
  864. } else {
  865. str = get_project_name(package_name);
  866. }
  867. }
  868. }
  869. string_table.push_back(str);
  870. }
  871. //write a new string table, but use 16 bits
  872. Vector<uint8_t> ret;
  873. ret.resize(string_table_begins + string_table.size() * 4);
  874. for (uint32_t i = 0; i < string_table_begins; i++) {
  875. ret.write[i] = p_manifest[i];
  876. }
  877. int ofs = 0;
  878. for (int i = 0; i < string_table.size(); i++) {
  879. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  880. ofs += string_table[i].length() * 2 + 2 + 2;
  881. }
  882. ret.resize(ret.size() + ofs);
  883. uint8_t *chars = &ret.write[ret.size() - ofs];
  884. for (int i = 0; i < string_table.size(); i++) {
  885. String s = string_table[i];
  886. encode_uint16(s.length(), chars);
  887. chars += 2;
  888. for (int j = 0; j < s.length(); j++) {
  889. encode_uint16(s[j], chars);
  890. chars += 2;
  891. }
  892. encode_uint16(0, chars);
  893. chars += 2;
  894. }
  895. //pad
  896. while (ret.size() % 4)
  897. ret.push_back(0);
  898. //change flags to not use utf8
  899. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  900. //change length
  901. encode_uint32(ret.size() - 12, &ret.write[16]);
  902. //append the rest...
  903. int rest_from = 12 + string_block_len;
  904. int rest_to = ret.size();
  905. int rest_len = (p_manifest.size() - rest_from);
  906. ret.resize(ret.size() + (p_manifest.size() - rest_from));
  907. for (int i = 0; i < rest_len; i++) {
  908. ret.write[rest_to + i] = p_manifest[rest_from + i];
  909. }
  910. //finally update the size
  911. encode_uint32(ret.size(), &ret.write[4]);
  912. p_manifest = ret;
  913. //printf("end\n");
  914. }
  915. static Vector<String> get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  916. Vector<String> abis = get_abis();
  917. Vector<String> enabled_abis;
  918. for (int i = 0; i < abis.size(); ++i) {
  919. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  920. if (is_enabled) {
  921. enabled_abis.push_back(abis[i]);
  922. }
  923. }
  924. return enabled_abis;
  925. }
  926. public:
  927. typedef Error (*EditorExportSaveFunction)(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total);
  928. public:
  929. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  930. String driver = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name");
  931. if (driver == "GLES2") {
  932. r_features->push_back("etc");
  933. } else if (driver == "GLES3") {
  934. r_features->push_back("etc2");
  935. if (ProjectSettings::get_singleton()->get("rendering/quality/driver/fallback_to_gles2")) {
  936. r_features->push_back("etc");
  937. }
  938. }
  939. Vector<String> abis = get_enabled_abis(p_preset);
  940. for (int i = 0; i < abis.size(); ++i) {
  941. r_features->push_back(abis[i]);
  942. }
  943. }
  944. virtual void get_export_options(List<ExportOption> *r_options) {
  945. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/32_bits_framebuffer"), true));
  946. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "one_click_deploy/clear_previous_install"), true));
  947. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_package/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  948. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_package/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  949. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  950. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  951. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  952. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.$genname"), ""));
  953. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name"), ""));
  954. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  955. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  956. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "screen/orientation", PROPERTY_HINT_ENUM, "Landscape,Portrait"), 0));
  957. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  958. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  959. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  960. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  961. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/opengl_debug"), false));
  962. for (unsigned int i = 0; i < sizeof(launcher_icons) / sizeof(launcher_icons[0]); ++i) {
  963. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_icons[i].option_id, PROPERTY_HINT_FILE, "*.png"), ""));
  964. }
  965. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"), ""));
  966. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user"), ""));
  967. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password"), ""));
  968. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"), ""));
  969. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  970. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  971. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  972. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  973. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  974. Vector<String> abis = get_abis();
  975. for (int i = 0; i < abis.size(); ++i) {
  976. String abi = abis[i];
  977. bool is_default = (abi == "armeabi-v7a" || abi == "arm64-v8a");
  978. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  979. }
  980. r_options->push_back(ExportOption(PropertyInfo(Variant::POOL_STRING_ARRAY, "permissions/custom_permissions"), PoolStringArray()));
  981. const char **perms = android_perms;
  982. while (*perms) {
  983. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  984. perms++;
  985. }
  986. }
  987. virtual String get_name() const {
  988. return "Android";
  989. }
  990. virtual String get_os_name() const {
  991. return "Android";
  992. }
  993. virtual Ref<Texture> get_logo() const {
  994. return logo;
  995. }
  996. virtual bool poll_devices() {
  997. bool dc = devices_changed;
  998. if (dc) {
  999. // don't clear unless we're reporting true, to avoid race
  1000. devices_changed = false;
  1001. }
  1002. return dc;
  1003. }
  1004. virtual int get_device_count() const {
  1005. device_lock->lock();
  1006. int dc = devices.size();
  1007. device_lock->unlock();
  1008. return dc;
  1009. }
  1010. virtual String get_device_name(int p_device) const {
  1011. ERR_FAIL_INDEX_V(p_device, devices.size(), "");
  1012. device_lock->lock();
  1013. String s = devices[p_device].name;
  1014. device_lock->unlock();
  1015. return s;
  1016. }
  1017. virtual String get_device_info(int p_device) const {
  1018. ERR_FAIL_INDEX_V(p_device, devices.size(), "");
  1019. device_lock->lock();
  1020. String s = devices[p_device].description;
  1021. device_lock->unlock();
  1022. return s;
  1023. }
  1024. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  1025. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1026. device_lock->lock();
  1027. EditorProgress ep("run", "Running on " + devices[p_device].name, 3);
  1028. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1029. if (adb == "") {
  1030. EditorNode::add_io_error("ADB executable not configured in settings, can't run.");
  1031. device_lock->unlock();
  1032. return ERR_UNCONFIGURED;
  1033. }
  1034. //export_temp
  1035. ep.step("Exporting APK", 0);
  1036. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  1037. const bool use_reverse = devices[p_device].api_level >= 21;
  1038. if (use_reverse)
  1039. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  1040. String export_to = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport.apk");
  1041. Error err = export_project(p_preset, true, export_to, p_debug_flags);
  1042. if (err) {
  1043. device_lock->unlock();
  1044. return err;
  1045. }
  1046. List<String> args;
  1047. int rv;
  1048. bool remove_prev = p_preset->get("one_click_deploy/clear_previous_install");
  1049. String version_name = p_preset->get("version/name");
  1050. String package_name = p_preset->get("package/unique_name");
  1051. if (remove_prev) {
  1052. ep.step("Uninstalling...", 1);
  1053. print_line("Uninstalling previous version: " + devices[p_device].name);
  1054. args.push_back("-s");
  1055. args.push_back(devices[p_device].id);
  1056. args.push_back("uninstall");
  1057. args.push_back(get_package_name(package_name));
  1058. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1059. }
  1060. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1061. ep.step("Installing to device (please wait...)", 2);
  1062. args.clear();
  1063. args.push_back("-s");
  1064. args.push_back(devices[p_device].id);
  1065. args.push_back("install");
  1066. args.push_back("-r");
  1067. args.push_back(export_to);
  1068. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1069. if (err || rv != 0) {
  1070. EditorNode::add_io_error("Could not install to device.");
  1071. device_lock->unlock();
  1072. return ERR_CANT_CREATE;
  1073. }
  1074. if (use_remote) {
  1075. if (use_reverse) {
  1076. static const char *const msg = "** Device API >= 21; debugging over USB **";
  1077. EditorNode::get_singleton()->get_log()->add_message(msg);
  1078. print_line(String(msg).to_upper());
  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("--remove-all");
  1084. OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1085. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  1086. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  1087. args.clear();
  1088. args.push_back("-s");
  1089. args.push_back(devices[p_device].id);
  1090. args.push_back("reverse");
  1091. args.push_back("tcp:" + itos(dbg_port));
  1092. args.push_back("tcp:" + itos(dbg_port));
  1093. OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1094. print_line("Reverse result: " + itos(rv));
  1095. }
  1096. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1097. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  1098. args.clear();
  1099. args.push_back("-s");
  1100. args.push_back(devices[p_device].id);
  1101. args.push_back("reverse");
  1102. args.push_back("tcp:" + itos(fs_port));
  1103. args.push_back("tcp:" + itos(fs_port));
  1104. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1105. print_line("Reverse result2: " + itos(rv));
  1106. }
  1107. } else {
  1108. static const char *const msg = "** Device API < 21; debugging over Wi-Fi **";
  1109. EditorNode::get_singleton()->get_log()->add_message(msg);
  1110. print_line(String(msg).to_upper());
  1111. }
  1112. }
  1113. ep.step("Running on Device...", 3);
  1114. args.clear();
  1115. args.push_back("-s");
  1116. args.push_back(devices[p_device].id);
  1117. args.push_back("shell");
  1118. args.push_back("am");
  1119. args.push_back("start");
  1120. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  1121. args.push_back("--user");
  1122. args.push_back("0");
  1123. }
  1124. args.push_back("-a");
  1125. args.push_back("android.intent.action.MAIN");
  1126. args.push_back("-n");
  1127. args.push_back(get_package_name(package_name) + "/org.godotengine.godot.Godot");
  1128. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  1129. if (err || rv != 0) {
  1130. EditorNode::add_io_error("Could not execute on device.");
  1131. device_lock->unlock();
  1132. return ERR_CANT_CREATE;
  1133. }
  1134. device_lock->unlock();
  1135. return OK;
  1136. }
  1137. virtual Ref<Texture> get_run_icon() const {
  1138. return run_icon;
  1139. }
  1140. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1141. String err;
  1142. r_missing_templates = find_export_template("android_debug.apk") == String() || find_export_template("android_release.apk") == String();
  1143. if (p_preset->get("custom_package/debug") != "") {
  1144. if (FileAccess::exists(p_preset->get("custom_package/debug"))) {
  1145. r_missing_templates = false;
  1146. } else {
  1147. err += TTR("Custom debug template not found.") + "\n";
  1148. }
  1149. }
  1150. if (p_preset->get("custom_package/release") != "") {
  1151. if (FileAccess::exists(p_preset->get("custom_package/release"))) {
  1152. r_missing_templates = false;
  1153. } else {
  1154. err += TTR("Custom release template not found.") + "\n";
  1155. }
  1156. }
  1157. bool valid = !r_missing_templates;
  1158. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1159. if (!FileAccess::exists(adb)) {
  1160. valid = false;
  1161. err += TTR("ADB executable not configured in the Editor Settings.") + "\n";
  1162. }
  1163. String js = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1164. if (!FileAccess::exists(js)) {
  1165. valid = false;
  1166. err += TTR("OpenJDK jarsigner not configured in the Editor Settings.") + "\n";
  1167. }
  1168. String dk = p_preset->get("keystore/debug");
  1169. if (!FileAccess::exists(dk)) {
  1170. dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1171. if (!FileAccess::exists(dk)) {
  1172. valid = false;
  1173. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  1174. }
  1175. }
  1176. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1177. if (apk_expansion) {
  1178. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1179. if (apk_expansion_pkey == "") {
  1180. valid = false;
  1181. err += TTR("Invalid public key for APK expansion.") + "\n";
  1182. }
  1183. }
  1184. String pn = p_preset->get("package/unique_name");
  1185. String pn_err;
  1186. if (!is_package_name_valid(get_package_name(pn), &pn_err)) {
  1187. valid = false;
  1188. err += TTR("Invalid package name:") + " " + pn_err + "\n";
  1189. }
  1190. String etc_error = test_etc2();
  1191. if (etc_error != String()) {
  1192. valid = false;
  1193. err += etc_error;
  1194. }
  1195. r_error = err;
  1196. return valid;
  1197. }
  1198. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1199. List<String> list;
  1200. list.push_back("apk");
  1201. return list;
  1202. }
  1203. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) {
  1204. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1205. String src_apk;
  1206. EditorProgress ep("export", "Exporting for Android", 105);
  1207. if (p_debug)
  1208. src_apk = p_preset->get("custom_package/debug");
  1209. else
  1210. src_apk = p_preset->get("custom_package/release");
  1211. src_apk = src_apk.strip_edges();
  1212. if (src_apk == "") {
  1213. if (p_debug) {
  1214. src_apk = find_export_template("android_debug.apk");
  1215. } else {
  1216. src_apk = find_export_template("android_release.apk");
  1217. }
  1218. if (src_apk == "") {
  1219. EditorNode::add_io_error("Package not found: " + src_apk);
  1220. return ERR_FILE_NOT_FOUND;
  1221. }
  1222. }
  1223. if (!DirAccess::exists(p_path.get_base_dir())) {
  1224. return ERR_FILE_BAD_PATH;
  1225. }
  1226. FileAccess *src_f = NULL;
  1227. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  1228. ep.step("Creating APK", 0);
  1229. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  1230. if (!pkg) {
  1231. EditorNode::add_io_error("Could not find template APK to export:\n" + src_apk);
  1232. return ERR_FILE_NOT_FOUND;
  1233. }
  1234. int ret = unzGoToFirstFile(pkg);
  1235. zlib_filefunc_def io2 = io;
  1236. FileAccess *dst_f = NULL;
  1237. io2.opaque = &dst_f;
  1238. String unaligned_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport-unaligned.apk");
  1239. zipFile unaligned_apk = zipOpen2(unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
  1240. bool use_32_fb = p_preset->get("graphics/32_bits_framebuffer");
  1241. bool immersive = p_preset->get("screen/immersive_mode");
  1242. bool debug_opengl = p_preset->get("screen/opengl_debug");
  1243. bool _signed = p_preset->get("package/signed");
  1244. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1245. String cmdline = p_preset->get("command_line/extra_args");
  1246. int version_code = p_preset->get("version/code");
  1247. String version_name = p_preset->get("version/name");
  1248. String package_name = p_preset->get("package/unique_name");
  1249. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1250. String release_keystore = p_preset->get("keystore/release");
  1251. String release_username = p_preset->get("keystore/release_user");
  1252. String release_password = p_preset->get("keystore/release_password");
  1253. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  1254. while (ret == UNZ_OK) {
  1255. //get filename
  1256. unz_file_info info;
  1257. char fname[16384];
  1258. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, NULL, 0, NULL, 0);
  1259. bool skip = false;
  1260. String file = fname;
  1261. Vector<uint8_t> data;
  1262. data.resize(info.uncompressed_size);
  1263. //read
  1264. unzOpenCurrentFile(pkg);
  1265. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  1266. unzCloseCurrentFile(pkg);
  1267. //write
  1268. if (file == "AndroidManifest.xml") {
  1269. _fix_manifest(p_preset, data, p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG));
  1270. }
  1271. if (file == "resources.arsc") {
  1272. _fix_resources(p_preset, data);
  1273. }
  1274. if (file == "res/drawable-nodpi-v4/icon.png") {
  1275. bool found = false;
  1276. for (unsigned int i = 0; i < sizeof(launcher_icons) / sizeof(launcher_icons[0]); ++i) {
  1277. String icon_path = String(p_preset->get(launcher_icons[i].option_id)).strip_edges();
  1278. if (icon_path != "" && icon_path.ends_with(".png")) {
  1279. FileAccess *f = FileAccess::open(icon_path, FileAccess::READ);
  1280. if (f) {
  1281. data.resize(f->get_len());
  1282. f->get_buffer(data.ptrw(), data.size());
  1283. memdelete(f);
  1284. found = true;
  1285. break;
  1286. }
  1287. }
  1288. }
  1289. if (!found) {
  1290. String appicon = ProjectSettings::get_singleton()->get("application/config/icon");
  1291. if (appicon != "" && appicon.ends_with(".png")) {
  1292. FileAccess *f = FileAccess::open(appicon, FileAccess::READ);
  1293. if (f) {
  1294. data.resize(f->get_len());
  1295. f->get_buffer(data.ptrw(), data.size());
  1296. memdelete(f);
  1297. }
  1298. }
  1299. }
  1300. }
  1301. if (file.ends_with(".so")) {
  1302. bool enabled = false;
  1303. for (int i = 0; i < enabled_abis.size(); ++i) {
  1304. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  1305. enabled = true;
  1306. break;
  1307. }
  1308. }
  1309. if (!enabled) {
  1310. skip = true;
  1311. }
  1312. }
  1313. if (file.begins_with("META-INF") && _signed) {
  1314. skip = true;
  1315. }
  1316. if (!skip) {
  1317. print_line("ADDING: " + file);
  1318. // Respect decision on compression made by AAPT for the export template
  1319. const bool uncompressed = info.compression_method == 0;
  1320. zip_fileinfo zipfi = get_zip_fileinfo();
  1321. zipOpenNewFileInZip(unaligned_apk,
  1322. file.utf8().get_data(),
  1323. &zipfi,
  1324. NULL,
  1325. 0,
  1326. NULL,
  1327. 0,
  1328. NULL,
  1329. uncompressed ? 0 : Z_DEFLATED,
  1330. Z_DEFAULT_COMPRESSION);
  1331. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  1332. zipCloseFileInZip(unaligned_apk);
  1333. }
  1334. ret = unzGoToNextFile(pkg);
  1335. }
  1336. ep.step("Adding Files...", 1);
  1337. Error err = OK;
  1338. Vector<String> cl = cmdline.strip_edges().split(" ");
  1339. for (int i = 0; i < cl.size(); i++) {
  1340. if (cl[i].strip_edges().length() == 0) {
  1341. cl.remove(i);
  1342. i--;
  1343. }
  1344. }
  1345. gen_export_flags(cl, p_flags);
  1346. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1347. APKExportData ed;
  1348. ed.ep = &ep;
  1349. ed.apk = unaligned_apk;
  1350. err = export_project_files(p_preset, ignore_apk_file, &ed, save_apk_so);
  1351. } else {
  1352. //all files
  1353. if (apk_expansion) {
  1354. String apkfname = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  1355. String fullpath = p_path.get_base_dir().plus_file(apkfname);
  1356. err = save_pack(p_preset, fullpath);
  1357. if (err != OK) {
  1358. unzClose(pkg);
  1359. EditorNode::add_io_error("Could not write expansion package file: " + apkfname);
  1360. return OK;
  1361. }
  1362. cl.push_back("--use_apk_expansion");
  1363. cl.push_back("--apk_expansion_md5");
  1364. cl.push_back(FileAccess::get_md5(fullpath));
  1365. cl.push_back("--apk_expansion_key");
  1366. cl.push_back(apk_expansion_pkey.strip_edges());
  1367. } else {
  1368. APKExportData ed;
  1369. ed.ep = &ep;
  1370. ed.apk = unaligned_apk;
  1371. err = export_project_files(p_preset, save_apk_file, &ed, save_apk_so);
  1372. }
  1373. }
  1374. if (!err) {
  1375. APKExportData ed;
  1376. ed.ep = &ep;
  1377. ed.apk = unaligned_apk;
  1378. for (unsigned int i = 0; i < sizeof(launcher_icons) / sizeof(launcher_icons[0]); ++i) {
  1379. String icon_path = String(p_preset->get(launcher_icons[i].option_id)).strip_edges();
  1380. if (icon_path != "" && icon_path.ends_with(".png") && FileAccess::exists(icon_path)) {
  1381. Vector<uint8_t> data = FileAccess::get_file_as_array(icon_path);
  1382. store_in_apk(&ed, launcher_icons[i].export_path, data);
  1383. }
  1384. }
  1385. }
  1386. if (use_32_fb)
  1387. cl.push_back("--use_depth_32");
  1388. if (immersive)
  1389. cl.push_back("--use_immersive");
  1390. if (debug_opengl)
  1391. cl.push_back("--debug_opengl");
  1392. if (cl.size()) {
  1393. //add comandline
  1394. Vector<uint8_t> clf;
  1395. clf.resize(4);
  1396. encode_uint32(cl.size(), &clf.write[0]);
  1397. for (int i = 0; i < cl.size(); i++) {
  1398. print_line(itos(i) + " param: " + cl[i]);
  1399. CharString txt = cl[i].utf8();
  1400. int base = clf.size();
  1401. int length = txt.length();
  1402. if (!length)
  1403. continue;
  1404. clf.resize(base + 4 + length);
  1405. encode_uint32(length, &clf.write[base]);
  1406. copymem(&clf.write[base + 4], txt.ptr(), length);
  1407. }
  1408. zip_fileinfo zipfi = get_zip_fileinfo();
  1409. zipOpenNewFileInZip(unaligned_apk,
  1410. "assets/_cl_",
  1411. &zipfi,
  1412. NULL,
  1413. 0,
  1414. NULL,
  1415. 0,
  1416. NULL,
  1417. 0, // No compress (little size gain and potentially slower startup)
  1418. Z_DEFAULT_COMPRESSION);
  1419. zipWriteInFileInZip(unaligned_apk, clf.ptr(), clf.size());
  1420. zipCloseFileInZip(unaligned_apk);
  1421. }
  1422. zipClose(unaligned_apk, NULL);
  1423. unzClose(pkg);
  1424. if (err) {
  1425. return err;
  1426. }
  1427. if (_signed) {
  1428. String jarsigner = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1429. if (!FileAccess::exists(jarsigner)) {
  1430. EditorNode::add_io_error("'jarsigner' could not be found.\nPlease supply a path in the Editor Settings.\nThe resulting APK is unsigned.");
  1431. return OK;
  1432. }
  1433. String keystore;
  1434. String password;
  1435. String user;
  1436. if (p_debug) {
  1437. keystore = p_preset->get("keystore/debug");
  1438. password = p_preset->get("keystore/debug_password");
  1439. user = p_preset->get("keystore/debug_user");
  1440. if (keystore.empty()) {
  1441. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1442. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  1443. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  1444. }
  1445. ep.step("Signing debug APK...", 103);
  1446. } else {
  1447. keystore = release_keystore;
  1448. password = release_password;
  1449. user = release_username;
  1450. ep.step("Signing release APK...", 103);
  1451. }
  1452. if (!FileAccess::exists(keystore)) {
  1453. EditorNode::add_io_error("Could not find keystore, unable to export.");
  1454. return ERR_FILE_CANT_OPEN;
  1455. }
  1456. List<String> args;
  1457. args.push_back("-digestalg");
  1458. args.push_back("SHA-256");
  1459. args.push_back("-sigalg");
  1460. args.push_back("SHA256withRSA");
  1461. String tsa_url = EditorSettings::get_singleton()->get("export/android/timestamping_authority_url");
  1462. if (tsa_url != "") {
  1463. args.push_back("-tsa");
  1464. args.push_back(tsa_url);
  1465. }
  1466. args.push_back("-verbose");
  1467. args.push_back("-keystore");
  1468. args.push_back(keystore);
  1469. args.push_back("-storepass");
  1470. args.push_back(password);
  1471. args.push_back(unaligned_path);
  1472. args.push_back(user);
  1473. int retval;
  1474. OS::get_singleton()->execute(jarsigner, args, true, NULL, NULL, &retval);
  1475. if (retval) {
  1476. EditorNode::add_io_error("'jarsigner' returned with error #" + itos(retval));
  1477. return ERR_CANT_CREATE;
  1478. }
  1479. ep.step("Verifying APK...", 104);
  1480. args.clear();
  1481. args.push_back("-verify");
  1482. args.push_back("-keystore");
  1483. args.push_back(keystore);
  1484. args.push_back(unaligned_path);
  1485. args.push_back("-verbose");
  1486. OS::get_singleton()->execute(jarsigner, args, true, NULL, NULL, &retval);
  1487. if (retval) {
  1488. EditorNode::add_io_error("'jarsigner' verification of APK failed. Make sure to use a jarsigner from OpenJDK 8.");
  1489. return ERR_CANT_CREATE;
  1490. }
  1491. }
  1492. // Let's zip-align (must be done after signing)
  1493. static const int ZIP_ALIGNMENT = 4;
  1494. ep.step("Aligning APK...", 105);
  1495. unzFile tmp_unaligned = unzOpen2(unaligned_path.utf8().get_data(), &io);
  1496. if (!tmp_unaligned) {
  1497. EditorNode::add_io_error("Could not find temp unaligned APK.");
  1498. return ERR_FILE_NOT_FOUND;
  1499. }
  1500. ret = unzGoToFirstFile(tmp_unaligned);
  1501. io2 = io;
  1502. dst_f = NULL;
  1503. io2.opaque = &dst_f;
  1504. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
  1505. // Take files from the unaligned APK and write them out to the aligned one
  1506. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  1507. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  1508. int bias = 0;
  1509. while (ret == UNZ_OK) {
  1510. unz_file_info info;
  1511. memset(&info, 0, sizeof(info));
  1512. char fname[16384];
  1513. char extra[16384];
  1514. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, NULL, 0);
  1515. String file = fname;
  1516. Vector<uint8_t> data;
  1517. data.resize(info.compressed_size);
  1518. // read
  1519. int method, level;
  1520. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  1521. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  1522. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  1523. unzCloseCurrentFile(tmp_unaligned);
  1524. // align
  1525. int padding = 0;
  1526. if (!info.compression_method) {
  1527. // Uncompressed file => Align
  1528. long new_offset = file_offset + bias;
  1529. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  1530. }
  1531. memset(extra + info.size_file_extra, 0, padding);
  1532. // write
  1533. zip_fileinfo zipfi = get_zip_fileinfo();
  1534. zipOpenNewFileInZip2(final_apk,
  1535. file.utf8().get_data(),
  1536. &zipfi,
  1537. extra,
  1538. info.size_file_extra + padding,
  1539. NULL,
  1540. 0,
  1541. NULL,
  1542. method,
  1543. level,
  1544. 1); // raw write
  1545. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  1546. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  1547. bias += padding;
  1548. ret = unzGoToNextFile(tmp_unaligned);
  1549. }
  1550. zipClose(final_apk, NULL);
  1551. unzClose(tmp_unaligned);
  1552. if (err) {
  1553. return err;
  1554. }
  1555. return OK;
  1556. }
  1557. virtual void get_platform_features(List<String> *r_features) {
  1558. r_features->push_back("mobile");
  1559. r_features->push_back("Android");
  1560. }
  1561. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  1562. }
  1563. EditorExportPlatformAndroid() {
  1564. Ref<Image> img = memnew(Image(_android_logo));
  1565. logo.instance();
  1566. logo->create_from_image(img);
  1567. img = Ref<Image>(memnew(Image(_android_run_icon)));
  1568. run_icon.instance();
  1569. run_icon->create_from_image(img);
  1570. device_lock = Mutex::create();
  1571. devices_changed = true;
  1572. quit_request = false;
  1573. device_thread = Thread::create(_device_poll_thread, this);
  1574. }
  1575. ~EditorExportPlatformAndroid() {
  1576. quit_request = true;
  1577. Thread::wait_to_finish(device_thread);
  1578. memdelete(device_lock);
  1579. memdelete(device_thread);
  1580. }
  1581. };
  1582. void register_android_exporter() {
  1583. String exe_ext;
  1584. if (OS::get_singleton()->get_name() == "Windows") {
  1585. exe_ext = "*.exe";
  1586. }
  1587. EDITOR_DEF("export/android/adb", "");
  1588. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/adb", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  1589. EDITOR_DEF("export/android/jarsigner", "");
  1590. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/jarsigner", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  1591. EDITOR_DEF("export/android/debug_keystore", "");
  1592. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/debug_keystore", PROPERTY_HINT_GLOBAL_FILE, "*.keystore"));
  1593. EDITOR_DEF("export/android/debug_keystore_user", "androiddebugkey");
  1594. EDITOR_DEF("export/android/debug_keystore_pass", "android");
  1595. EDITOR_DEF("export/android/force_system_user", false);
  1596. EDITOR_DEF("export/android/timestamping_authority_url", "");
  1597. EDITOR_DEF("export/android/shutdown_adb_on_exit", true);
  1598. Ref<EditorExportPlatformAndroid> exporter = Ref<EditorExportPlatformAndroid>(memnew(EditorExportPlatformAndroid));
  1599. EditorExport::get_singleton()->add_export_platform(exporter);
  1600. }