export.cpp 79 KB

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