export.cpp 87 KB

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