export.cpp 87 KB

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