export.cpp 81 KB

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