export.cpp 80 KB

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