export.cpp 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776
  1. /*************************************************************************/
  2. /* export.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2017 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 "editor/editor_export.h"
  32. #include "editor/editor_node.h"
  33. #include "editor/editor_settings.h"
  34. #include "io/marshalls.h"
  35. #include "io/zip_io.h"
  36. #include "os/file_access.h"
  37. #include "os/os.h"
  38. #include "platform/android/logo.gen.h"
  39. #include "platform/android/run_icon.gen.h"
  40. #include "project_settings.h"
  41. #include "version.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. class EditorExportAndroid : public EditorExportPlatform {
  192. GDCLASS(EditorExportAndroid, EditorExportPlatform)
  193. Ref<ImageTexture> logo;
  194. Ref<ImageTexture> run_icon;
  195. struct Device {
  196. String id;
  197. String name;
  198. String description;
  199. int api_level;
  200. };
  201. struct APKExportData {
  202. zipFile apk;
  203. EditorProgress *ep;
  204. };
  205. Vector<Device> devices;
  206. bool devices_changed;
  207. Mutex *device_lock;
  208. Thread *device_thread;
  209. volatile bool quit_request;
  210. static void _device_poll_thread(void *ud) {
  211. EditorExportAndroid *ea = (EditorExportAndroid *)ud;
  212. while (!ea->quit_request) {
  213. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  214. if (FileAccess::exists(adb)) {
  215. String devices;
  216. List<String> args;
  217. args.push_back("devices");
  218. int ec;
  219. OS::get_singleton()->execute(adb, args, true, NULL, &devices, &ec);
  220. Vector<String> ds = devices.split("\n");
  221. Vector<String> ldevices;
  222. for (int i = 1; i < ds.size(); i++) {
  223. String d = ds[i];
  224. int dpos = d.find("device");
  225. if (dpos == -1)
  226. continue;
  227. d = d.substr(0, dpos).strip_edges();
  228. //print_line("found devuce: "+d);
  229. ldevices.push_back(d);
  230. }
  231. ea->device_lock->lock();
  232. bool different = false;
  233. if (ea->devices.size() != ldevices.size()) {
  234. different = true;
  235. } else {
  236. for (int i = 0; i < ea->devices.size(); i++) {
  237. if (ea->devices[i].id != ldevices[i]) {
  238. different = true;
  239. break;
  240. }
  241. }
  242. }
  243. if (different) {
  244. Vector<Device> ndevices;
  245. for (int i = 0; i < ldevices.size(); i++) {
  246. Device d;
  247. d.id = ldevices[i];
  248. for (int j = 0; j < ea->devices.size(); j++) {
  249. if (ea->devices[j].id == ldevices[i]) {
  250. d.description = ea->devices[j].description;
  251. d.name = ea->devices[j].name;
  252. d.api_level = ea->devices[j].api_level;
  253. }
  254. }
  255. if (d.description == "") {
  256. //in the oven, request!
  257. args.clear();
  258. args.push_back("-s");
  259. args.push_back(d.id);
  260. args.push_back("shell");
  261. args.push_back("cat");
  262. args.push_back("/system/build.prop");
  263. int ec;
  264. String dp;
  265. OS::get_singleton()->execute(adb, args, true, NULL, &dp, &ec);
  266. Vector<String> props = dp.split("\n");
  267. String vendor;
  268. String device;
  269. d.description + "Device ID: " + d.id + "\n";
  270. d.api_level = 0;
  271. for (int j = 0; j < props.size(); j++) {
  272. String p = props[j];
  273. if (p.begins_with("ro.product.model=")) {
  274. device = p.get_slice("=", 1).strip_edges();
  275. } else if (p.begins_with("ro.product.brand=")) {
  276. vendor = p.get_slice("=", 1).strip_edges().capitalize();
  277. } else if (p.begins_with("ro.build.display.id=")) {
  278. d.description += "Build: " + p.get_slice("=", 1).strip_edges() + "\n";
  279. } else if (p.begins_with("ro.build.version.release=")) {
  280. d.description += "Release: " + p.get_slice("=", 1).strip_edges() + "\n";
  281. } else if (p.begins_with("ro.build.version.sdk=")) {
  282. d.api_level = p.get_slice("=", 1).to_int();
  283. } else if (p.begins_with("ro.product.cpu.abi=")) {
  284. d.description += "CPU: " + p.get_slice("=", 1).strip_edges() + "\n";
  285. } else if (p.begins_with("ro.product.manufacturer=")) {
  286. d.description += "Manufacturer: " + p.get_slice("=", 1).strip_edges() + "\n";
  287. } else if (p.begins_with("ro.board.platform=")) {
  288. d.description += "Chipset: " + p.get_slice("=", 1).strip_edges() + "\n";
  289. } else if (p.begins_with("ro.opengles.version=")) {
  290. uint32_t opengl = p.get_slice("=", 1).to_int();
  291. d.description += "OpenGL: " + itos(opengl >> 16) + "." + itos((opengl >> 8) & 0xFF) + "." + itos((opengl)&0xFF) + "\n";
  292. }
  293. }
  294. d.name = vendor + " " + device;
  295. //print_line("name: "+d.name);
  296. //print_line("description: "+d.description);
  297. }
  298. ndevices.push_back(d);
  299. }
  300. ea->devices = ndevices;
  301. ea->devices_changed = true;
  302. }
  303. ea->device_lock->unlock();
  304. }
  305. uint64_t wait = 3000000;
  306. uint64_t time = OS::get_singleton()->get_ticks_usec();
  307. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  308. OS::get_singleton()->delay_usec(1000);
  309. if (ea->quit_request)
  310. break;
  311. }
  312. }
  313. if (EditorSettings::get_singleton()->get("export/android/shutdown_adb_on_exit")) {
  314. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  315. if (!FileAccess::exists(adb)) {
  316. return; //adb not configured
  317. }
  318. List<String> args;
  319. args.push_back("kill-server");
  320. OS::get_singleton()->execute(adb, args, true);
  321. };
  322. }
  323. String get_project_name(const String &p_name) const {
  324. String aname;
  325. if (p_name != "") {
  326. aname = p_name;
  327. } else {
  328. aname = ProjectSettings::get_singleton()->get("application/config/name");
  329. }
  330. if (aname == "") {
  331. aname = VERSION_NAME;
  332. }
  333. return aname;
  334. }
  335. String get_package_name(const String &p_package) {
  336. String pname = p_package;
  337. String basename = ProjectSettings::get_singleton()->get("application/config/name");
  338. basename = basename.to_lower();
  339. String name;
  340. bool first = true;
  341. for (int i = 0; i < basename.length(); i++) {
  342. CharType c = basename[i];
  343. if (c >= '0' && c <= '9' && first) {
  344. continue;
  345. }
  346. if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9')) {
  347. name += String::chr(c);
  348. first = false;
  349. }
  350. }
  351. if (name == "")
  352. name = "noname";
  353. pname = pname.replace("$genname", name);
  354. return pname;
  355. }
  356. static bool _should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  357. /*
  358. * By not compressing files with little or not benefit in doing so,
  359. * a performance gain is expected attime. Moreover, if the APK is
  360. * zip-aligned, assets stored as they are can be efficiently read by
  361. * Android by memory-mapping them.
  362. */
  363. // -- Unconditional uncompress to mimic AAPT plus some other
  364. static const char *unconditional_compress_ext[] = {
  365. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  366. // These formats are already compressed, or don't compress well:
  367. ".jpg", ".jpeg", ".png", ".gif",
  368. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  369. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  370. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  371. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  372. ".amr", ".awb", ".wma", ".wmv",
  373. // Godot-specific:
  374. ".webp", // Same reasoning as .png
  375. ".cfb", // Don't let small config files slow-down startup
  376. ".scn", // Binary scenes are usually already compressed
  377. ".stex", // Streamable textures are usually already compressed
  378. // Trailer for easier processing
  379. NULL
  380. };
  381. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  382. if (p_path.to_lower().ends_with(String(*ext))) {
  383. return false;
  384. }
  385. }
  386. // -- Compressed resource?
  387. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  388. // Already compressed
  389. return false;
  390. }
  391. // --- TODO: Decide on texture resources according to their image compression setting
  392. return true;
  393. }
  394. static zip_fileinfo get_zip_fileinfo() {
  395. OS::Time time = OS::get_singleton()->get_time();
  396. OS::Date date = OS::get_singleton()->get_date();
  397. zip_fileinfo zipfi;
  398. zipfi.tmz_date.tm_hour = time.hour;
  399. zipfi.tmz_date.tm_mday = date.day;
  400. zipfi.tmz_date.tm_min = time.min;
  401. zipfi.tmz_date.tm_mon = date.month;
  402. zipfi.tmz_date.tm_sec = time.sec;
  403. zipfi.tmz_date.tm_year = date.year;
  404. zipfi.dosDate = 0;
  405. zipfi.external_fa = 0;
  406. zipfi.internal_fa = 0;
  407. return zipfi;
  408. }
  409. static Vector<String> get_abis() {
  410. // mips and armv6 are dead (especially for games), so not including them
  411. Vector<String> abis;
  412. abis.push_back("armeabi-v7a");
  413. abis.push_back("arm64-v8a");
  414. abis.push_back("x86");
  415. abis.push_back("x86_64");
  416. return abis;
  417. }
  418. static Error store_in_apk(APKExportData *ed, const String &p_path, const Vector<uint8_t> &p_data, int compression_method = Z_DEFLATED) {
  419. zip_fileinfo zipfi = get_zip_fileinfo();
  420. zipOpenNewFileInZip(ed->apk,
  421. p_path.utf8().get_data(),
  422. &zipfi,
  423. NULL,
  424. 0,
  425. NULL,
  426. 0,
  427. NULL,
  428. compression_method,
  429. Z_DEFAULT_COMPRESSION);
  430. zipWriteInFileInZip(ed->apk, p_data.ptr(), p_data.size());
  431. zipCloseFileInZip(ed->apk);
  432. return OK;
  433. }
  434. static Error save_apk_so(void *p_userdata, const SharedObject &p_so) {
  435. if (!p_so.path.get_file().begins_with("lib")) {
  436. String err = "Android .so file names must start with \"lib\", but got: " + p_so.path;
  437. ERR_PRINT(err.utf8().get_data());
  438. return FAILED;
  439. }
  440. APKExportData *ed = (APKExportData *)p_userdata;
  441. Vector<String> abis = get_abis();
  442. bool exported = false;
  443. for (int i = 0; i < p_so.tags.size(); ++i) {
  444. // shared objects can be fat (compatible with multiple ABIs)
  445. int start_pos = 0;
  446. int abi_index = abis.find(p_so.tags[i]);
  447. if (abi_index != -1) {
  448. exported = true;
  449. start_pos = abi_index + 1;
  450. String abi = abis[abi_index];
  451. String dst_path = "lib/" + abi + "/" + p_so.path.get_file();
  452. Vector<uint8_t> array = FileAccess::get_file_as_array(p_so.path);
  453. Error store_err = store_in_apk(ed, dst_path, array);
  454. ERR_FAIL_COND_V(store_err, store_err);
  455. }
  456. }
  457. if (!exported) {
  458. String abis_string = String(" ").join(abis);
  459. String err = "Cannot determine ABI for library \"" + p_so.path + "\". One of the supported ABIs must be used as a tag: " + abis_string;
  460. ERR_PRINT(err.utf8().get_data());
  461. return FAILED;
  462. }
  463. return OK;
  464. }
  465. static Error save_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  466. APKExportData *ed = (APKExportData *)p_userdata;
  467. String dst_path = p_path.replace_first("res://", "assets/");
  468. store_in_apk(ed, dst_path, p_data, _should_compress_asset(p_path, p_data) ? Z_DEFLATED : 0);
  469. ed->ep->step("File: " + p_path, 3 + p_file * 100 / p_total);
  470. return OK;
  471. }
  472. void _fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  473. // Leaving the unused types commented because looking these constants up
  474. // again later would be annoying
  475. // const int CHUNK_AXML_FILE = 0x00080003;
  476. // const int CHUNK_RESOURCEIDS = 0x00080180;
  477. const int CHUNK_STRINGS = 0x001C0001;
  478. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  479. // const int CHUNK_XML_END_TAG = 0x00100103;
  480. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  481. const int CHUNK_XML_START_TAG = 0x00100102;
  482. // const int CHUNK_XML_TEXT = 0x00100104;
  483. const int UTF8_FLAG = 0x00000100;
  484. Vector<String> string_table;
  485. uint32_t ofs = 8;
  486. uint32_t string_count = 0;
  487. uint32_t styles_count = 0;
  488. uint32_t string_flags = 0;
  489. uint32_t string_data_offset = 0;
  490. uint32_t styles_offset = 0;
  491. uint32_t string_table_begins = 0;
  492. uint32_t string_table_ends = 0;
  493. Vector<uint8_t> stable_extra;
  494. String version_name = p_preset->get("version/name");
  495. int version_code = p_preset->get("version/code");
  496. String package_name = p_preset->get("package/unique_name");
  497. int orientation = p_preset->get("screen/orientation");
  498. bool screen_support_small = p_preset->get("screen/support_small");
  499. bool screen_support_normal = p_preset->get("screen/support_normal");
  500. bool screen_support_large = p_preset->get("screen/support_large");
  501. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  502. String user_perms[MAX_USER_PERMISSIONS];
  503. for (int i = 0; i < MAX_USER_PERMISSIONS; i++) {
  504. user_perms[i] = p_preset->get("user_permissions/" + itos(i));
  505. }
  506. Set<String> perms;
  507. const char **aperms = android_perms;
  508. while (*aperms) {
  509. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  510. if (enabled)
  511. perms.insert(String(*aperms));
  512. aperms++;
  513. }
  514. while (ofs < (uint32_t)p_manifest.size()) {
  515. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  516. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  517. switch (chunk) {
  518. case CHUNK_STRINGS: {
  519. int iofs = ofs + 8;
  520. string_count = decode_uint32(&p_manifest[iofs]);
  521. styles_count = decode_uint32(&p_manifest[iofs + 4]);
  522. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  523. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  524. styles_offset = decode_uint32(&p_manifest[iofs + 16]);
  525. /*
  526. printf("string count: %i\n",string_count);
  527. printf("flags: %i\n",string_flags);
  528. printf("sdata ofs: %i\n",string_data_offset);
  529. printf("styles ofs: %i\n",styles_offset);
  530. */
  531. uint32_t st_offset = iofs + 20;
  532. string_table.resize(string_count);
  533. uint32_t string_end = 0;
  534. string_table_begins = st_offset;
  535. for (uint32_t i = 0; i < string_count; i++) {
  536. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  537. string_at += st_offset + string_count * 4;
  538. ERR_EXPLAIN("Unimplemented, can't read utf8 string table.");
  539. ERR_FAIL_COND(string_flags & UTF8_FLAG);
  540. if (string_flags & UTF8_FLAG) {
  541. } else {
  542. uint32_t len = decode_uint16(&p_manifest[string_at]);
  543. Vector<CharType> ucstring;
  544. ucstring.resize(len + 1);
  545. for (uint32_t j = 0; j < len; j++) {
  546. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  547. ucstring[j] = c;
  548. }
  549. string_end = MAX(string_at + 2 + 2 * len, string_end);
  550. ucstring[len] = 0;
  551. string_table[i] = ucstring.ptr();
  552. }
  553. //print_line("String "+itos(i)+": "+string_table[i]);
  554. }
  555. for (uint32_t i = string_end; i < (ofs + size); i++) {
  556. stable_extra.push_back(p_manifest[i]);
  557. }
  558. //printf("stable extra: %i\n",int(stable_extra.size()));
  559. string_table_ends = ofs + size;
  560. //print_line("STABLE SIZE: "+itos(size)+" ACTUAL: "+itos(string_table_ends));
  561. } break;
  562. case CHUNK_XML_START_TAG: {
  563. int iofs = ofs + 8;
  564. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  565. String tname = string_table[name];
  566. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  567. iofs += 28;
  568. for (uint32_t i = 0; i < attrcount; i++) {
  569. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  570. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  571. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  572. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  573. String value;
  574. if (attr_value != 0xFFFFFFFF)
  575. value = string_table[attr_value];
  576. else
  577. value = "Res #" + itos(attr_resid);
  578. String attrname = string_table[attr_name];
  579. String nspace;
  580. if (attr_nspace != 0xFFFFFFFF)
  581. nspace = string_table[attr_nspace];
  582. else
  583. nspace = "";
  584. //replace project information
  585. if (tname == "manifest" && attrname == "package") {
  586. print_line("FOUND package");
  587. string_table[attr_value] = get_package_name(package_name);
  588. }
  589. if (tname == "manifest" && /*nspace=="android" &&*/ attrname == "versionCode") {
  590. print_line("FOUND versionCode");
  591. encode_uint32(version_code, &p_manifest[iofs + 16]);
  592. }
  593. if (tname == "manifest" && /*nspace=="android" &&*/ attrname == "versionName") {
  594. print_line("FOUND versionName");
  595. if (attr_value == 0xFFFFFFFF) {
  596. WARN_PRINT("Version name in a resource, should be plaintext")
  597. } else
  598. string_table[attr_value] = version_name;
  599. }
  600. if (tname == "activity" && /*nspace=="android" &&*/ attrname == "screenOrientation") {
  601. encode_uint32(orientation == 0 ? 0 : 1, &p_manifest[iofs + 16]);
  602. }
  603. if (tname == "uses-feature" && /*nspace=="android" &&*/ attrname == "glEsVersion") {
  604. print_line("version number: " + itos(decode_uint32(&p_manifest[iofs + 16])));
  605. }
  606. if (tname == "uses-permission" && /*nspace=="android" &&*/ attrname == "name") {
  607. if (value.begins_with("godot.custom")) {
  608. int which = value.get_slice(".", 2).to_int();
  609. if (which >= 0 && which < MAX_USER_PERMISSIONS && user_perms[which].strip_edges() != "") {
  610. string_table[attr_value] = user_perms[which].strip_edges();
  611. }
  612. } else if (value.begins_with("godot.")) {
  613. String perm = value.get_slice(".", 1);
  614. if (perms.has(perm) || (p_give_internet && perm == "INTERNET")) {
  615. print_line("PERM: " + perm);
  616. string_table[attr_value] = "android.permission." + perm;
  617. }
  618. }
  619. }
  620. if (tname == "supports-screens") {
  621. if (attrname == "smallScreens") {
  622. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest[iofs + 16]);
  623. } else if (attrname == "normalScreens") {
  624. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest[iofs + 16]);
  625. } else if (attrname == "largeScreens") {
  626. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest[iofs + 16]);
  627. } else if (attrname == "xlargeScreens") {
  628. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest[iofs + 16]);
  629. }
  630. }
  631. iofs += 20;
  632. }
  633. } break;
  634. }
  635. ofs += size;
  636. }
  637. //create new andriodmanifest binary
  638. Vector<uint8_t> ret;
  639. ret.resize(string_table_begins + string_table.size() * 4);
  640. for (uint32_t i = 0; i < string_table_begins; i++) {
  641. ret[i] = p_manifest[i];
  642. }
  643. ofs = 0;
  644. for (int i = 0; i < string_table.size(); i++) {
  645. encode_uint32(ofs, &ret[string_table_begins + i * 4]);
  646. ofs += string_table[i].length() * 2 + 2 + 2;
  647. //print_line("ofs: "+itos(i)+": "+itos(ofs));
  648. }
  649. ret.resize(ret.size() + ofs);
  650. uint8_t *chars = &ret[ret.size() - ofs];
  651. for (int i = 0; i < string_table.size(); i++) {
  652. String s = string_table[i];
  653. //print_line("savint string :"+s);
  654. encode_uint16(s.length(), chars);
  655. chars += 2;
  656. for (int j = 0; j < s.length(); j++) { //include zero?
  657. encode_uint16(s[j], chars);
  658. chars += 2;
  659. }
  660. encode_uint16(0, chars);
  661. chars += 2;
  662. }
  663. for (int i = 0; i < stable_extra.size(); i++) {
  664. ret.push_back(stable_extra[i]);
  665. }
  666. while (ret.size() % 4)
  667. ret.push_back(0);
  668. uint32_t new_stable_end = ret.size();
  669. uint32_t extra = (p_manifest.size() - string_table_ends);
  670. ret.resize(new_stable_end + extra);
  671. for (uint32_t i = 0; i < extra; i++)
  672. ret[new_stable_end + i] = p_manifest[string_table_ends + i];
  673. while (ret.size() % 4)
  674. ret.push_back(0);
  675. encode_uint32(ret.size(), &ret[4]); //update new file size
  676. encode_uint32(new_stable_end - 8, &ret[12]); //update new string table size
  677. //print_line("file size: "+itos(ret.size()));
  678. p_manifest = ret;
  679. }
  680. static String _parse_string(const uint8_t *p_bytes, bool p_utf8) {
  681. uint32_t offset = 0;
  682. uint32_t len = decode_uint16(&p_bytes[offset]);
  683. if (p_utf8) {
  684. //don't know how to read extended utf8, this will have to be for now
  685. len >>= 8;
  686. }
  687. offset += 2;
  688. //printf("len %i, unicode: %i\n",len,int(p_utf8));
  689. if (p_utf8) {
  690. Vector<uint8_t> str8;
  691. str8.resize(len + 1);
  692. for (uint32_t i = 0; i < len; i++) {
  693. str8[i] = p_bytes[offset + i];
  694. }
  695. str8[len] = 0;
  696. String str;
  697. str.parse_utf8((const char *)str8.ptr());
  698. return str;
  699. } else {
  700. String str;
  701. for (uint32_t i = 0; i < len; i++) {
  702. CharType c = decode_uint16(&p_bytes[offset + i * 2]);
  703. if (c == 0)
  704. break;
  705. str += String::chr(c);
  706. }
  707. return str;
  708. }
  709. }
  710. void _fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest) {
  711. const int UTF8_FLAG = 0x00000100;
  712. print_line("*******************GORRRGLE***********************");
  713. uint32_t string_block_len = decode_uint32(&p_manifest[16]);
  714. uint32_t string_count = decode_uint32(&p_manifest[20]);
  715. uint32_t string_flags = decode_uint32(&p_manifest[28]);
  716. const uint32_t string_table_begins = 40;
  717. Vector<String> string_table;
  718. String package_name = p_preset->get("package/name");
  719. for (uint32_t i = 0; i < string_count; i++) {
  720. uint32_t offset = decode_uint32(&p_manifest[string_table_begins + i * 4]);
  721. offset += string_table_begins + string_count * 4;
  722. String str = _parse_string(&p_manifest[offset], string_flags & UTF8_FLAG);
  723. if (str.begins_with("godot-project-name")) {
  724. if (str == "godot-project-name") {
  725. //project name
  726. str = get_project_name(package_name);
  727. } else {
  728. String lang = str.substr(str.find_last("-") + 1, str.length()).replace("-", "_");
  729. String prop = "application/config/name_" + lang;
  730. if (ProjectSettings::get_singleton()->has_setting(prop)) {
  731. str = ProjectSettings::get_singleton()->get(prop);
  732. } else {
  733. str = get_project_name(package_name);
  734. }
  735. }
  736. }
  737. string_table.push_back(str);
  738. }
  739. //write a new string table, but use 16 bits
  740. Vector<uint8_t> ret;
  741. ret.resize(string_table_begins + string_table.size() * 4);
  742. for (uint32_t i = 0; i < string_table_begins; i++) {
  743. ret[i] = p_manifest[i];
  744. }
  745. int ofs = 0;
  746. for (int i = 0; i < string_table.size(); i++) {
  747. encode_uint32(ofs, &ret[string_table_begins + i * 4]);
  748. ofs += string_table[i].length() * 2 + 2 + 2;
  749. }
  750. ret.resize(ret.size() + ofs);
  751. uint8_t *chars = &ret[ret.size() - ofs];
  752. for (int i = 0; i < string_table.size(); i++) {
  753. String s = string_table[i];
  754. encode_uint16(s.length(), chars);
  755. chars += 2;
  756. for (int j = 0; j < s.length(); j++) {
  757. encode_uint16(s[j], chars);
  758. chars += 2;
  759. }
  760. encode_uint16(0, chars);
  761. chars += 2;
  762. }
  763. //pad
  764. while (ret.size() % 4)
  765. ret.push_back(0);
  766. //change flags to not use utf8
  767. encode_uint32(string_flags & ~0x100, &ret[28]);
  768. //change length
  769. encode_uint32(ret.size() - 12, &ret[16]);
  770. //append the rest...
  771. int rest_from = 12 + string_block_len;
  772. int rest_to = ret.size();
  773. int rest_len = (p_manifest.size() - rest_from);
  774. ret.resize(ret.size() + (p_manifest.size() - rest_from));
  775. for (int i = 0; i < rest_len; i++) {
  776. ret[rest_to + i] = p_manifest[rest_from + i];
  777. }
  778. //finally update the size
  779. encode_uint32(ret.size(), &ret[4]);
  780. p_manifest = ret;
  781. //printf("end\n");
  782. }
  783. static Vector<String> get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  784. Vector<String> abis = get_abis();
  785. Vector<String> enabled_abis;
  786. for (int i = 0; i < abis.size(); ++i) {
  787. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  788. if (is_enabled) {
  789. enabled_abis.push_back(abis[i]);
  790. }
  791. }
  792. return enabled_abis;
  793. }
  794. public:
  795. enum {
  796. MAX_USER_PERMISSIONS = 20
  797. };
  798. typedef Error (*EditorExportSaveFunction)(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total);
  799. public:
  800. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  801. // Reenable when a GLES 2.0 backend is readded
  802. /*int api = p_preset->get("graphics/api");
  803. if (api == 0)
  804. r_features->push_back("etc");
  805. else*/
  806. r_features->push_back("etc2");
  807. Vector<String> abis = get_enabled_abis(p_preset);
  808. for (int i = 0; i < abis.size(); ++i) {
  809. r_features->push_back(abis[i]);
  810. }
  811. }
  812. virtual void get_export_options(List<ExportOption> *r_options) {
  813. /*r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "graphics/api", PROPERTY_HINT_ENUM, "OpenGL ES 2.0,OpenGL ES 3.0"), 1));*/
  814. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/32_bits_framebuffer"), true));
  815. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "one_click_deploy/clear_previous_install"), true));
  816. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_package/debug", PROPERTY_HINT_GLOBAL_FILE, "apk"), ""));
  817. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_package/release", PROPERTY_HINT_GLOBAL_FILE, "apk"), ""));
  818. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  819. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,65535,1"), 1));
  820. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  821. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name"), "org.godotengine.$genname"));
  822. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name"), ""));
  823. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/icon", PROPERTY_HINT_FILE, "png"), ""));
  824. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  825. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  826. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "screen/orientation", PROPERTY_HINT_ENUM, "Landscape,Portrait"), 0));
  827. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  828. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  829. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  830. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  831. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "keystore"), ""));
  832. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  833. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  834. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  835. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  836. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  837. Vector<String> abis = get_abis();
  838. for (int i = 0; i < abis.size(); ++i) {
  839. String abi = abis[i];
  840. bool is_default = (abi == "armeabi-v7a");
  841. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  842. }
  843. const char **perms = android_perms;
  844. while (*perms) {
  845. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  846. perms++;
  847. }
  848. for (int i = 0; i < MAX_USER_PERMISSIONS; i++) {
  849. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "user_permissions/" + itos(i)), false));
  850. }
  851. //r_options->push_back( PropertyInfo( Variant::INT, "resources/pack_mode", PROPERTY_HINT_ENUM,"Copy,Single Exec.,Pack (.pck),Bundles (Optical)"));
  852. }
  853. virtual String get_name() const {
  854. return "Android";
  855. }
  856. virtual String get_os_name() const {
  857. return "Android";
  858. }
  859. virtual Ref<Texture> get_logo() const {
  860. return logo;
  861. }
  862. virtual bool poll_devices() {
  863. bool dc = devices_changed;
  864. devices_changed = false;
  865. return dc;
  866. }
  867. virtual int get_device_count() const {
  868. device_lock->lock();
  869. int dc = devices.size();
  870. device_lock->unlock();
  871. return dc;
  872. }
  873. virtual String get_device_name(int p_device) const {
  874. ERR_FAIL_INDEX_V(p_device, devices.size(), "");
  875. device_lock->lock();
  876. String s = devices[p_device].name;
  877. device_lock->unlock();
  878. return s;
  879. }
  880. virtual String get_device_info(int p_device) const {
  881. ERR_FAIL_INDEX_V(p_device, devices.size(), "");
  882. device_lock->lock();
  883. String s = devices[p_device].description;
  884. device_lock->unlock();
  885. return s;
  886. }
  887. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  888. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  889. device_lock->lock();
  890. EditorProgress ep("run", "Running on " + devices[p_device].name, 3);
  891. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  892. if (adb == "") {
  893. EditorNode::add_io_error("ADB executable not configured in settings, can't run.");
  894. device_lock->unlock();
  895. return ERR_UNCONFIGURED;
  896. }
  897. //export_temp
  898. ep.step("Exporting APK", 0);
  899. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  900. const bool use_reverse = devices[p_device].api_level >= 21;
  901. if (use_reverse)
  902. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  903. String export_to = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport.apk");
  904. Error err = export_project(p_preset, true, export_to, p_debug_flags);
  905. if (err) {
  906. device_lock->unlock();
  907. return err;
  908. }
  909. List<String> args;
  910. int rv;
  911. bool remove_prev = p_preset->get("one_click_deploy/clear_previous_install");
  912. String version_name = p_preset->get("version/name");
  913. String package_name = p_preset->get("package/unique_name");
  914. if (remove_prev) {
  915. ep.step("Uninstalling..", 1);
  916. print_line("Uninstalling previous version: " + devices[p_device].name);
  917. args.push_back("-s");
  918. args.push_back(devices[p_device].id);
  919. args.push_back("uninstall");
  920. args.push_back(get_package_name(package_name));
  921. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  922. }
  923. print_line("Installing into device (please wait..): " + devices[p_device].name);
  924. ep.step("Installing to Device (please wait..)..", 2);
  925. args.clear();
  926. args.push_back("-s");
  927. args.push_back(devices[p_device].id);
  928. args.push_back("install");
  929. args.push_back("-r");
  930. args.push_back(export_to);
  931. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  932. if (err || rv != 0) {
  933. EditorNode::add_io_error("Could not install to device.");
  934. device_lock->unlock();
  935. return ERR_CANT_CREATE;
  936. }
  937. if (use_remote) {
  938. if (use_reverse) {
  939. static const char *const msg = "** Device API >= 21; debugging over USB **";
  940. EditorNode::get_singleton()->get_log()->add_message(msg);
  941. print_line(String(msg).to_upper());
  942. args.clear();
  943. args.push_back("-s");
  944. args.push_back(devices[p_device].id);
  945. args.push_back("reverse");
  946. args.push_back("--remove-all");
  947. OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  948. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  949. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  950. args.clear();
  951. args.push_back("-s");
  952. args.push_back(devices[p_device].id);
  953. args.push_back("reverse");
  954. args.push_back("tcp:" + itos(dbg_port));
  955. args.push_back("tcp:" + itos(dbg_port));
  956. OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  957. print_line("Reverse result: " + itos(rv));
  958. }
  959. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  960. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  961. args.clear();
  962. args.push_back("-s");
  963. args.push_back(devices[p_device].id);
  964. args.push_back("reverse");
  965. args.push_back("tcp:" + itos(fs_port));
  966. args.push_back("tcp:" + itos(fs_port));
  967. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  968. print_line("Reverse result2: " + itos(rv));
  969. }
  970. } else {
  971. static const char *const msg = "** Device API < 21; debugging over Wi-Fi **";
  972. EditorNode::get_singleton()->get_log()->add_message(msg);
  973. print_line(String(msg).to_upper());
  974. }
  975. }
  976. ep.step("Running on Device..", 3);
  977. args.clear();
  978. args.push_back("-s");
  979. args.push_back(devices[p_device].id);
  980. args.push_back("shell");
  981. args.push_back("am");
  982. args.push_back("start");
  983. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  984. args.push_back("--user");
  985. args.push_back("0");
  986. }
  987. args.push_back("-a");
  988. args.push_back("android.intent.action.MAIN");
  989. args.push_back("-n");
  990. args.push_back(get_package_name(package_name) + "/org.godotengine.godot.Godot");
  991. err = OS::get_singleton()->execute(adb, args, true, NULL, NULL, &rv);
  992. if (err || rv != 0) {
  993. EditorNode::add_io_error("Could not execute on device.");
  994. device_lock->unlock();
  995. return ERR_CANT_CREATE;
  996. }
  997. device_lock->unlock();
  998. return OK;
  999. }
  1000. virtual Ref<Texture> get_run_icon() const {
  1001. return run_icon;
  1002. }
  1003. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1004. r_missing_templates = find_export_template("android_debug.apk") == String() || find_export_template("android_release.apk") == String();
  1005. bool valid = !r_missing_templates;
  1006. String adb = EditorSettings::get_singleton()->get("export/android/adb");
  1007. String err;
  1008. if (!FileAccess::exists(adb)) {
  1009. valid = false;
  1010. err += "ADB executable not configured in editor settings.\n";
  1011. }
  1012. String js = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1013. if (!FileAccess::exists(js)) {
  1014. valid = false;
  1015. err += "OpenJDK 6 jarsigner not configured in editor settings.\n";
  1016. }
  1017. String dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1018. if (!FileAccess::exists(dk)) {
  1019. valid = false;
  1020. err += "Debug Keystore not configured in editor settings.\n";
  1021. }
  1022. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1023. if (apk_expansion) {
  1024. /*
  1025. if (apk_expansion_salt=="") {
  1026. valid=false;
  1027. err+="Invalid SALT for apk expansion.\n";
  1028. }
  1029. */
  1030. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1031. if (apk_expansion_pkey == "") {
  1032. valid = false;
  1033. err += "Invalid public key for apk expansion.\n";
  1034. }
  1035. }
  1036. r_error = err;
  1037. return valid;
  1038. }
  1039. virtual String get_binary_extension() const {
  1040. return "apk";
  1041. }
  1042. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) {
  1043. String src_apk;
  1044. EditorProgress ep("export", "Exporting for Android", 105);
  1045. if (p_debug)
  1046. src_apk = p_preset->get("custom_package/debug");
  1047. else
  1048. src_apk = p_preset->get("custom_package/release");
  1049. src_apk = src_apk.strip_edges();
  1050. if (src_apk == "") {
  1051. if (p_debug) {
  1052. src_apk = find_export_template("android_debug.apk");
  1053. } else {
  1054. src_apk = find_export_template("android_release.apk");
  1055. }
  1056. if (src_apk == "") {
  1057. EditorNode::add_io_error("Package not found: " + src_apk);
  1058. return ERR_FILE_NOT_FOUND;
  1059. }
  1060. }
  1061. FileAccess *src_f = NULL;
  1062. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  1063. ep.step("Creating APK", 0);
  1064. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  1065. if (!pkg) {
  1066. EditorNode::add_io_error("Could not find template APK to export:\n" + src_apk);
  1067. return ERR_FILE_NOT_FOUND;
  1068. }
  1069. ERR_FAIL_COND_V(!pkg, ERR_CANT_OPEN);
  1070. int ret = unzGoToFirstFile(pkg);
  1071. zlib_filefunc_def io2 = io;
  1072. FileAccess *dst_f = NULL;
  1073. io2.opaque = &dst_f;
  1074. String unaligned_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport-unaligned.apk");
  1075. zipFile unaligned_apk = zipOpen2(unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
  1076. bool use_32_fb = p_preset->get("graphics/32_bits_framebuffer");
  1077. bool immersive = p_preset->get("screen/immersive_mode");
  1078. bool _signed = p_preset->get("package/signed");
  1079. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1080. String cmdline = p_preset->get("command_line/extra_args");
  1081. int version_code = p_preset->get("version/code");
  1082. String version_name = p_preset->get("version/name");
  1083. String package_name = p_preset->get("package/unique_name");
  1084. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1085. String release_keystore = p_preset->get("keystore/release");
  1086. String release_username = p_preset->get("keystore/release_user");
  1087. String release_password = p_preset->get("keystore/release_password");
  1088. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  1089. while (ret == UNZ_OK) {
  1090. //get filename
  1091. unz_file_info info;
  1092. char fname[16384];
  1093. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, NULL, 0, NULL, 0);
  1094. bool skip = false;
  1095. String file = fname;
  1096. Vector<uint8_t> data;
  1097. data.resize(info.uncompressed_size);
  1098. //read
  1099. unzOpenCurrentFile(pkg);
  1100. unzReadCurrentFile(pkg, data.ptr(), data.size());
  1101. unzCloseCurrentFile(pkg);
  1102. //write
  1103. if (file == "AndroidManifest.xml") {
  1104. _fix_manifest(p_preset, data, p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG));
  1105. }
  1106. if (file == "resources.arsc") {
  1107. _fix_resources(p_preset, data);
  1108. }
  1109. if (file == "res/drawable/icon.png") {
  1110. String icon = p_preset->get("package/icon");
  1111. icon = icon.strip_edges();
  1112. bool found = false;
  1113. if (icon != "" && icon.ends_with(".png")) {
  1114. FileAccess *f = FileAccess::open(icon, FileAccess::READ);
  1115. if (f) {
  1116. data.resize(f->get_len());
  1117. f->get_buffer(data.ptr(), data.size());
  1118. memdelete(f);
  1119. found = true;
  1120. }
  1121. }
  1122. if (!found) {
  1123. String appicon = ProjectSettings::get_singleton()->get("application/config/icon");
  1124. if (appicon != "" && appicon.ends_with(".png")) {
  1125. FileAccess *f = FileAccess::open(appicon, FileAccess::READ);
  1126. if (f) {
  1127. data.resize(f->get_len());
  1128. f->get_buffer(data.ptr(), data.size());
  1129. memdelete(f);
  1130. }
  1131. }
  1132. }
  1133. }
  1134. if (file.ends_with(".so")) {
  1135. bool enabled = false;
  1136. for (int i = 0; i < enabled_abis.size(); ++i) {
  1137. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  1138. enabled = true;
  1139. break;
  1140. }
  1141. }
  1142. if (!enabled) {
  1143. skip = true;
  1144. }
  1145. }
  1146. if (file.begins_with("META-INF") && _signed) {
  1147. skip = true;
  1148. }
  1149. if (!skip) {
  1150. print_line("ADDING: " + file);
  1151. // Respect decision on compression made by AAPT for the export template
  1152. const bool uncompressed = info.compression_method == 0;
  1153. zip_fileinfo zipfi = get_zip_fileinfo();
  1154. zipOpenNewFileInZip(unaligned_apk,
  1155. file.utf8().get_data(),
  1156. &zipfi,
  1157. NULL,
  1158. 0,
  1159. NULL,
  1160. 0,
  1161. NULL,
  1162. uncompressed ? 0 : Z_DEFLATED,
  1163. Z_DEFAULT_COMPRESSION);
  1164. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  1165. zipCloseFileInZip(unaligned_apk);
  1166. }
  1167. ret = unzGoToNextFile(pkg);
  1168. }
  1169. ep.step("Adding Files..", 1);
  1170. Error err = OK;
  1171. Vector<String> cl = cmdline.strip_edges().split(" ");
  1172. for (int i = 0; i < cl.size(); i++) {
  1173. if (cl[i].strip_edges().length() == 0) {
  1174. cl.remove(i);
  1175. i--;
  1176. }
  1177. }
  1178. gen_export_flags(cl, p_flags);
  1179. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1180. /*String host = EditorSettings::get_singleton()->get("filesystem/file_server/host");
  1181. int port = EditorSettings::get_singleton()->get("filesystem/file_server/post");
  1182. String passwd = EditorSettings::get_singleton()->get("filesystem/file_server/password");
  1183. cl.push_back("--remote-fs");
  1184. cl.push_back(host+":"+itos(port));
  1185. if (passwd!="") {
  1186. cl.push_back("--remote-fs-password");
  1187. cl.push_back(passwd);
  1188. }*/
  1189. } else {
  1190. //all files
  1191. if (apk_expansion) {
  1192. String apkfname = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  1193. String fullpath = p_path.get_base_dir().plus_file(apkfname);
  1194. err = save_pack(p_preset, fullpath);
  1195. if (err != OK) {
  1196. EditorNode::add_io_error("Could not write expansion package file: " + apkfname);
  1197. return OK;
  1198. }
  1199. cl.push_back("--use_apk_expansion");
  1200. cl.push_back("--apk_expansion_md5");
  1201. cl.push_back(FileAccess::get_md5(fullpath));
  1202. cl.push_back("--apk_expansion_key");
  1203. cl.push_back(apk_expansion_pkey.strip_edges());
  1204. } else {
  1205. APKExportData ed;
  1206. ed.ep = &ep;
  1207. ed.apk = unaligned_apk;
  1208. err = export_project_files(p_preset, save_apk_file, &ed, save_apk_so);
  1209. }
  1210. }
  1211. if (use_32_fb)
  1212. cl.push_back("--use_depth_32");
  1213. if (immersive)
  1214. cl.push_back("--use_immersive");
  1215. if (cl.size()) {
  1216. //add comandline
  1217. Vector<uint8_t> clf;
  1218. clf.resize(4);
  1219. encode_uint32(cl.size(), &clf[0]);
  1220. for (int i = 0; i < cl.size(); i++) {
  1221. CharString txt = cl[i].utf8();
  1222. int base = clf.size();
  1223. clf.resize(base + 4 + txt.length());
  1224. encode_uint32(txt.length(), &clf[base]);
  1225. copymem(&clf[base + 4], txt.ptr(), txt.length());
  1226. print_line(itos(i) + " param: " + cl[i]);
  1227. }
  1228. zip_fileinfo zipfi = get_zip_fileinfo();
  1229. zipOpenNewFileInZip(unaligned_apk,
  1230. "assets/_cl_",
  1231. &zipfi,
  1232. NULL,
  1233. 0,
  1234. NULL,
  1235. 0,
  1236. NULL,
  1237. 0, // No compress (little size gain and potentially slower startup)
  1238. Z_DEFAULT_COMPRESSION);
  1239. zipWriteInFileInZip(unaligned_apk, clf.ptr(), clf.size());
  1240. zipCloseFileInZip(unaligned_apk);
  1241. }
  1242. zipClose(unaligned_apk, NULL);
  1243. unzClose(pkg);
  1244. if (err) {
  1245. return err;
  1246. }
  1247. if (_signed) {
  1248. String jarsigner = EditorSettings::get_singleton()->get("export/android/jarsigner");
  1249. if (!FileAccess::exists(jarsigner)) {
  1250. EditorNode::add_io_error("'jarsigner' could not be found.\nPlease supply a path in the editor settings.\nResulting apk is unsigned.");
  1251. return OK;
  1252. }
  1253. String keystore;
  1254. String password;
  1255. String user;
  1256. if (p_debug) {
  1257. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1258. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  1259. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  1260. ep.step("Signing Debug APK..", 103);
  1261. } else {
  1262. keystore = release_keystore;
  1263. password = release_password;
  1264. user = release_username;
  1265. ep.step("Signing Release APK..", 103);
  1266. }
  1267. if (!FileAccess::exists(keystore)) {
  1268. EditorNode::add_io_error("Could not find keystore, unable to export.");
  1269. return ERR_FILE_CANT_OPEN;
  1270. }
  1271. List<String> args;
  1272. args.push_back("-digestalg");
  1273. args.push_back("SHA1");
  1274. args.push_back("-sigalg");
  1275. args.push_back("MD5withRSA");
  1276. String tsa_url = EditorSettings::get_singleton()->get("export/android/timestamping_authority_url");
  1277. if (tsa_url != "") {
  1278. args.push_back("-tsa");
  1279. args.push_back(tsa_url);
  1280. }
  1281. args.push_back("-verbose");
  1282. args.push_back("-keystore");
  1283. args.push_back(keystore);
  1284. args.push_back("-storepass");
  1285. args.push_back(password);
  1286. args.push_back(unaligned_path);
  1287. args.push_back(user);
  1288. int retval;
  1289. OS::get_singleton()->execute(jarsigner, args, true, NULL, NULL, &retval);
  1290. if (retval) {
  1291. EditorNode::add_io_error("'jarsigner' returned with error #" + itos(retval));
  1292. return ERR_CANT_CREATE;
  1293. }
  1294. ep.step("Verifying APK..", 104);
  1295. args.clear();
  1296. args.push_back("-verify");
  1297. args.push_back("-keystore");
  1298. args.push_back(keystore);
  1299. args.push_back(unaligned_path);
  1300. args.push_back("-verbose");
  1301. OS::get_singleton()->execute(jarsigner, args, true, NULL, NULL, &retval);
  1302. if (retval) {
  1303. EditorNode::add_io_error("'jarsigner' verification of APK failed. Make sure to use jarsigner from Java 6.");
  1304. return ERR_CANT_CREATE;
  1305. }
  1306. }
  1307. // Let's zip-align (must be done after signing)
  1308. static const int ZIP_ALIGNMENT = 4;
  1309. ep.step("Aligning APK..", 105);
  1310. unzFile tmp_unaligned = unzOpen2(unaligned_path.utf8().get_data(), &io);
  1311. if (!tmp_unaligned) {
  1312. EditorNode::add_io_error("Could not find temp unaligned APK.");
  1313. return ERR_FILE_NOT_FOUND;
  1314. }
  1315. ERR_FAIL_COND_V(!tmp_unaligned, ERR_CANT_OPEN);
  1316. ret = unzGoToFirstFile(tmp_unaligned);
  1317. io2 = io;
  1318. dst_f = NULL;
  1319. io2.opaque = &dst_f;
  1320. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, NULL, &io2);
  1321. // Take files from the unaligned APK and write them out to the aligned one
  1322. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  1323. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  1324. int bias = 0;
  1325. while (ret == UNZ_OK) {
  1326. unz_file_info info;
  1327. memset(&info, 0, sizeof(info));
  1328. char fname[16384];
  1329. char extra[16384];
  1330. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, NULL, 0);
  1331. String file = fname;
  1332. Vector<uint8_t> data;
  1333. data.resize(info.compressed_size);
  1334. // read
  1335. int method, level;
  1336. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  1337. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  1338. unzReadCurrentFile(tmp_unaligned, data.ptr(), data.size());
  1339. unzCloseCurrentFile(tmp_unaligned);
  1340. // align
  1341. int padding = 0;
  1342. if (!info.compression_method) {
  1343. // Uncompressed file => Align
  1344. long new_offset = file_offset + bias;
  1345. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  1346. }
  1347. memset(extra + info.size_file_extra, 0, padding);
  1348. // write
  1349. zip_fileinfo zipfi = get_zip_fileinfo();
  1350. zipOpenNewFileInZip2(final_apk,
  1351. file.utf8().get_data(),
  1352. &zipfi,
  1353. extra,
  1354. info.size_file_extra + padding,
  1355. NULL,
  1356. 0,
  1357. NULL,
  1358. method,
  1359. level,
  1360. 1); // raw write
  1361. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  1362. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  1363. bias += padding;
  1364. ret = unzGoToNextFile(tmp_unaligned);
  1365. }
  1366. zipClose(final_apk, NULL);
  1367. unzClose(tmp_unaligned);
  1368. if (err) {
  1369. return err;
  1370. }
  1371. return OK;
  1372. }
  1373. virtual void get_platform_features(List<String> *r_features) {
  1374. r_features->push_back("mobile");
  1375. r_features->push_back("Android");
  1376. }
  1377. EditorExportAndroid() {
  1378. Ref<Image> img = memnew(Image(_android_logo));
  1379. logo.instance();
  1380. logo->create_from_image(img);
  1381. img = Ref<Image>(memnew(Image(_android_run_icon)));
  1382. run_icon.instance();
  1383. run_icon->create_from_image(img);
  1384. device_lock = Mutex::create();
  1385. device_thread = Thread::create(_device_poll_thread, this);
  1386. devices_changed = true;
  1387. quit_request = false;
  1388. }
  1389. ~EditorExportAndroid() {
  1390. quit_request = true;
  1391. Thread::wait_to_finish(device_thread);
  1392. memdelete(device_lock);
  1393. memdelete(device_thread);
  1394. }
  1395. };
  1396. void register_android_exporter() {
  1397. String exe_ext;
  1398. if (OS::get_singleton()->get_name() == "Windows") {
  1399. exe_ext = "*.exe";
  1400. }
  1401. EDITOR_DEF("export/android/adb", "");
  1402. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/adb", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  1403. EDITOR_DEF("export/android/jarsigner", "");
  1404. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/jarsigner", PROPERTY_HINT_GLOBAL_FILE, exe_ext));
  1405. EDITOR_DEF("export/android/debug_keystore", "");
  1406. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/debug_keystore", PROPERTY_HINT_GLOBAL_FILE, "keystore"));
  1407. EDITOR_DEF("export/android/debug_keystore_user", "androiddebugkey");
  1408. EDITOR_DEF("export/android/debug_keystore_pass", "android");
  1409. EDITOR_DEF("export/android/force_system_user", false);
  1410. EDITOR_DEF("export/android/timestamping_authority_url", "");
  1411. EDITOR_DEF("export/android/shutdown_adb_on_exit", true);
  1412. Ref<EditorExportAndroid> exporter = Ref<EditorExportAndroid>(memnew(EditorExportAndroid));
  1413. EditorExport::get_singleton()->add_export_platform(exporter);
  1414. }