export.cpp 116 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333
  1. /*************************************************************************/
  2. /* export.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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/safe_refcount.h"
  39. #include "core/version.h"
  40. #include "drivers/png/png_driver_common.h"
  41. #include "editor/editor_export.h"
  42. #include "editor/editor_log.h"
  43. #include "editor/editor_node.h"
  44. #include "editor/editor_settings.h"
  45. #include "main/splash.gen.h"
  46. #include "platform/android/export/gradle_export_util.h"
  47. #include "platform/android/logo.gen.h"
  48. #include "platform/android/plugin/godot_plugin_config.h"
  49. #include "platform/android/run_icon.gen.h"
  50. #include <string.h>
  51. static const char *android_perms[] = {
  52. "ACCESS_CHECKIN_PROPERTIES",
  53. "ACCESS_COARSE_LOCATION",
  54. "ACCESS_FINE_LOCATION",
  55. "ACCESS_LOCATION_EXTRA_COMMANDS",
  56. "ACCESS_MOCK_LOCATION",
  57. "ACCESS_NETWORK_STATE",
  58. "ACCESS_SURFACE_FLINGER",
  59. "ACCESS_WIFI_STATE",
  60. "ACCOUNT_MANAGER",
  61. "ADD_VOICEMAIL",
  62. "AUTHENTICATE_ACCOUNTS",
  63. "BATTERY_STATS",
  64. "BIND_ACCESSIBILITY_SERVICE",
  65. "BIND_APPWIDGET",
  66. "BIND_DEVICE_ADMIN",
  67. "BIND_INPUT_METHOD",
  68. "BIND_NFC_SERVICE",
  69. "BIND_NOTIFICATION_LISTENER_SERVICE",
  70. "BIND_PRINT_SERVICE",
  71. "BIND_REMOTEVIEWS",
  72. "BIND_TEXT_SERVICE",
  73. "BIND_VPN_SERVICE",
  74. "BIND_WALLPAPER",
  75. "BLUETOOTH",
  76. "BLUETOOTH_ADMIN",
  77. "BLUETOOTH_PRIVILEGED",
  78. "BRICK",
  79. "BROADCAST_PACKAGE_REMOVED",
  80. "BROADCAST_SMS",
  81. "BROADCAST_STICKY",
  82. "BROADCAST_WAP_PUSH",
  83. "CALL_PHONE",
  84. "CALL_PRIVILEGED",
  85. "CAMERA",
  86. "CAPTURE_AUDIO_OUTPUT",
  87. "CAPTURE_SECURE_VIDEO_OUTPUT",
  88. "CAPTURE_VIDEO_OUTPUT",
  89. "CHANGE_COMPONENT_ENABLED_STATE",
  90. "CHANGE_CONFIGURATION",
  91. "CHANGE_NETWORK_STATE",
  92. "CHANGE_WIFI_MULTICAST_STATE",
  93. "CHANGE_WIFI_STATE",
  94. "CLEAR_APP_CACHE",
  95. "CLEAR_APP_USER_DATA",
  96. "CONTROL_LOCATION_UPDATES",
  97. "DELETE_CACHE_FILES",
  98. "DELETE_PACKAGES",
  99. "DEVICE_POWER",
  100. "DIAGNOSTIC",
  101. "DISABLE_KEYGUARD",
  102. "DUMP",
  103. "EXPAND_STATUS_BAR",
  104. "FACTORY_TEST",
  105. "FLASHLIGHT",
  106. "FORCE_BACK",
  107. "GET_ACCOUNTS",
  108. "GET_PACKAGE_SIZE",
  109. "GET_TASKS",
  110. "GET_TOP_ACTIVITY_INFO",
  111. "GLOBAL_SEARCH",
  112. "HARDWARE_TEST",
  113. "INJECT_EVENTS",
  114. "INSTALL_LOCATION_PROVIDER",
  115. "INSTALL_PACKAGES",
  116. "INSTALL_SHORTCUT",
  117. "INTERNAL_SYSTEM_WINDOW",
  118. "INTERNET",
  119. "KILL_BACKGROUND_PROCESSES",
  120. "LOCATION_HARDWARE",
  121. "MANAGE_ACCOUNTS",
  122. "MANAGE_APP_TOKENS",
  123. "MANAGE_DOCUMENTS",
  124. "MASTER_CLEAR",
  125. "MEDIA_CONTENT_CONTROL",
  126. "MODIFY_AUDIO_SETTINGS",
  127. "MODIFY_PHONE_STATE",
  128. "MOUNT_FORMAT_FILESYSTEMS",
  129. "MOUNT_UNMOUNT_FILESYSTEMS",
  130. "NFC",
  131. "PERSISTENT_ACTIVITY",
  132. "PROCESS_OUTGOING_CALLS",
  133. "READ_CALENDAR",
  134. "READ_CALL_LOG",
  135. "READ_CONTACTS",
  136. "READ_EXTERNAL_STORAGE",
  137. "READ_FRAME_BUFFER",
  138. "READ_HISTORY_BOOKMARKS",
  139. "READ_INPUT_STATE",
  140. "READ_LOGS",
  141. "READ_PHONE_STATE",
  142. "READ_PROFILE",
  143. "READ_SMS",
  144. "READ_SOCIAL_STREAM",
  145. "READ_SYNC_SETTINGS",
  146. "READ_SYNC_STATS",
  147. "READ_USER_DICTIONARY",
  148. "REBOOT",
  149. "RECEIVE_BOOT_COMPLETED",
  150. "RECEIVE_MMS",
  151. "RECEIVE_SMS",
  152. "RECEIVE_WAP_PUSH",
  153. "RECORD_AUDIO",
  154. "REORDER_TASKS",
  155. "RESTART_PACKAGES",
  156. "SEND_RESPOND_VIA_MESSAGE",
  157. "SEND_SMS",
  158. "SET_ACTIVITY_WATCHER",
  159. "SET_ALARM",
  160. "SET_ALWAYS_FINISH",
  161. "SET_ANIMATION_SCALE",
  162. "SET_DEBUG_APP",
  163. "SET_ORIENTATION",
  164. "SET_POINTER_SPEED",
  165. "SET_PREFERRED_APPLICATIONS",
  166. "SET_PROCESS_LIMIT",
  167. "SET_TIME",
  168. "SET_TIME_ZONE",
  169. "SET_WALLPAPER",
  170. "SET_WALLPAPER_HINTS",
  171. "SIGNAL_PERSISTENT_PROCESSES",
  172. "STATUS_BAR",
  173. "SUBSCRIBED_FEEDS_READ",
  174. "SUBSCRIBED_FEEDS_WRITE",
  175. "SYSTEM_ALERT_WINDOW",
  176. "TRANSMIT_IR",
  177. "UNINSTALL_SHORTCUT",
  178. "UPDATE_DEVICE_STATS",
  179. "USE_CREDENTIALS",
  180. "USE_SIP",
  181. "VIBRATE",
  182. "WAKE_LOCK",
  183. "WRITE_APN_SETTINGS",
  184. "WRITE_CALENDAR",
  185. "WRITE_CALL_LOG",
  186. "WRITE_CONTACTS",
  187. "WRITE_EXTERNAL_STORAGE",
  188. "WRITE_GSERVICES",
  189. "WRITE_HISTORY_BOOKMARKS",
  190. "WRITE_PROFILE",
  191. "WRITE_SECURE_SETTINGS",
  192. "WRITE_SETTINGS",
  193. "WRITE_SMS",
  194. "WRITE_SOCIAL_STREAM",
  195. "WRITE_SYNC_SETTINGS",
  196. "WRITE_USER_DICTIONARY",
  197. nullptr
  198. };
  199. static const char *SPLASH_IMAGE_EXPORT_PATH = "res/drawable-nodpi/splash.png";
  200. static const char *LEGACY_BUILD_SPLASH_IMAGE_EXPORT_PATH = "res/drawable-nodpi-v4/splash.png";
  201. static const char *SPLASH_BG_COLOR_PATH = "res/drawable-nodpi/splash_bg_color.png";
  202. static const char *LEGACY_BUILD_SPLASH_BG_COLOR_PATH = "res/drawable-nodpi-v4/splash_bg_color.png";
  203. static const char *SPLASH_CONFIG_PATH = "res://android/build/res/drawable/splash_drawable.xml";
  204. const String SPLASH_CONFIG_XML_CONTENT = R"SPLASH(<?xml version="1.0" encoding="utf-8"?>
  205. <layer-list xmlns:android="http://schemas.android.com/apk/res/android">
  206. <item android:drawable="@drawable/splash_bg_color" />
  207. <item>
  208. <bitmap
  209. android:gravity="center"
  210. android:filter="%s"
  211. android:src="@drawable/splash" />
  212. </item>
  213. </layer-list>
  214. )SPLASH";
  215. struct LauncherIcon {
  216. const char *export_path;
  217. int dimensions;
  218. };
  219. static const int icon_densities_count = 6;
  220. static const char *launcher_icon_option = "launcher_icons/main_192x192";
  221. static const char *launcher_adaptive_icon_foreground_option = "launcher_icons/adaptive_foreground_432x432";
  222. static const char *launcher_adaptive_icon_background_option = "launcher_icons/adaptive_background_432x432";
  223. static const LauncherIcon launcher_icons[icon_densities_count] = {
  224. { "res/mipmap-xxxhdpi-v4/icon.png", 192 },
  225. { "res/mipmap-xxhdpi-v4/icon.png", 144 },
  226. { "res/mipmap-xhdpi-v4/icon.png", 96 },
  227. { "res/mipmap-hdpi-v4/icon.png", 72 },
  228. { "res/mipmap-mdpi-v4/icon.png", 48 },
  229. { "res/mipmap/icon.png", 192 }
  230. };
  231. static const LauncherIcon launcher_adaptive_icon_foregrounds[icon_densities_count] = {
  232. { "res/mipmap-xxxhdpi-v4/icon_foreground.png", 432 },
  233. { "res/mipmap-xxhdpi-v4/icon_foreground.png", 324 },
  234. { "res/mipmap-xhdpi-v4/icon_foreground.png", 216 },
  235. { "res/mipmap-hdpi-v4/icon_foreground.png", 162 },
  236. { "res/mipmap-mdpi-v4/icon_foreground.png", 108 },
  237. { "res/mipmap/icon_foreground.png", 432 }
  238. };
  239. static const LauncherIcon launcher_adaptive_icon_backgrounds[icon_densities_count] = {
  240. { "res/mipmap-xxxhdpi-v4/icon_background.png", 432 },
  241. { "res/mipmap-xxhdpi-v4/icon_background.png", 324 },
  242. { "res/mipmap-xhdpi-v4/icon_background.png", 216 },
  243. { "res/mipmap-hdpi-v4/icon_background.png", 162 },
  244. { "res/mipmap-mdpi-v4/icon_background.png", 108 },
  245. { "res/mipmap/icon_background.png", 432 }
  246. };
  247. static const int EXPORT_FORMAT_APK = 0;
  248. static const int EXPORT_FORMAT_AAB = 1;
  249. class EditorExportPlatformAndroid : public EditorExportPlatform {
  250. GDCLASS(EditorExportPlatformAndroid, EditorExportPlatform);
  251. Ref<ImageTexture> logo;
  252. Ref<ImageTexture> run_icon;
  253. struct Device {
  254. String id;
  255. String name;
  256. String description;
  257. int api_level;
  258. };
  259. struct APKExportData {
  260. zipFile apk;
  261. EditorProgress *ep;
  262. };
  263. Vector<PluginConfigAndroid> plugins;
  264. String last_plugin_names;
  265. uint64_t last_custom_build_time = 0;
  266. SafeFlag plugins_changed;
  267. Mutex plugins_lock;
  268. Vector<Device> devices;
  269. SafeFlag devices_changed;
  270. Mutex device_lock;
  271. Thread check_for_changes_thread;
  272. SafeFlag quit_request;
  273. static void _check_for_changes_poll_thread(void *ud) {
  274. EditorExportPlatformAndroid *ea = (EditorExportPlatformAndroid *)ud;
  275. while (!ea->quit_request.is_set()) {
  276. // Check for plugins updates
  277. {
  278. // Nothing to do if we already know the plugins have changed.
  279. if (!ea->plugins_changed.is_set()) {
  280. Vector<PluginConfigAndroid> loaded_plugins = get_plugins();
  281. ea->plugins_lock.lock();
  282. if (ea->plugins.size() != loaded_plugins.size()) {
  283. ea->plugins_changed.set();
  284. } else {
  285. for (int i = 0; i < ea->plugins.size(); i++) {
  286. if (ea->plugins[i].name != loaded_plugins[i].name) {
  287. ea->plugins_changed.set();
  288. break;
  289. }
  290. }
  291. }
  292. if (ea->plugins_changed.is_set()) {
  293. ea->plugins = loaded_plugins;
  294. }
  295. ea->plugins_lock.unlock();
  296. }
  297. }
  298. // Check for devices updates
  299. String adb = get_adb_path();
  300. if (FileAccess::exists(adb)) {
  301. String devices;
  302. List<String> args;
  303. args.push_back("devices");
  304. int ec;
  305. OS::get_singleton()->execute(adb, args, true, nullptr, &devices, &ec);
  306. Vector<String> ds = devices.split("\n");
  307. Vector<String> ldevices;
  308. for (int i = 1; i < ds.size(); i++) {
  309. String d = ds[i];
  310. int dpos = d.find("device");
  311. if (dpos == -1) {
  312. continue;
  313. }
  314. d = d.substr(0, dpos).strip_edges();
  315. ldevices.push_back(d);
  316. }
  317. ea->device_lock.lock();
  318. bool different = false;
  319. if (ea->devices.size() != ldevices.size()) {
  320. different = true;
  321. } else {
  322. for (int i = 0; i < ea->devices.size(); i++) {
  323. if (ea->devices[i].id != ldevices[i]) {
  324. different = true;
  325. break;
  326. }
  327. }
  328. }
  329. if (different) {
  330. Vector<Device> ndevices;
  331. for (int i = 0; i < ldevices.size(); i++) {
  332. Device d;
  333. d.id = ldevices[i];
  334. for (int j = 0; j < ea->devices.size(); j++) {
  335. if (ea->devices[j].id == ldevices[i]) {
  336. d.description = ea->devices[j].description;
  337. d.name = ea->devices[j].name;
  338. d.api_level = ea->devices[j].api_level;
  339. }
  340. }
  341. if (d.description == "") {
  342. //in the oven, request!
  343. args.clear();
  344. args.push_back("-s");
  345. args.push_back(d.id);
  346. args.push_back("shell");
  347. args.push_back("getprop");
  348. int ec2;
  349. String dp;
  350. OS::get_singleton()->execute(adb, args, true, nullptr, &dp, &ec2);
  351. Vector<String> props = dp.split("\n");
  352. String vendor;
  353. String device;
  354. d.description = "Device ID: " + d.id + "\n";
  355. d.api_level = 0;
  356. for (int j = 0; j < props.size(); j++) {
  357. // got information by `shell cat /system/build.prop` before and its format is "property=value"
  358. // it's now changed to use `shell getporp` because of permission issue with Android 8.0 and above
  359. // its format is "[property]: [value]" so changed it as like build.prop
  360. String p = props[j];
  361. p = p.replace("]: ", "=");
  362. p = p.replace("[", "");
  363. p = p.replace("]", "");
  364. if (p.begins_with("ro.product.model=")) {
  365. device = p.get_slice("=", 1).strip_edges();
  366. } else if (p.begins_with("ro.product.brand=")) {
  367. vendor = p.get_slice("=", 1).strip_edges().capitalize();
  368. } else if (p.begins_with("ro.build.display.id=")) {
  369. d.description += "Build: " + p.get_slice("=", 1).strip_edges() + "\n";
  370. } else if (p.begins_with("ro.build.version.release=")) {
  371. d.description += "Release: " + p.get_slice("=", 1).strip_edges() + "\n";
  372. } else if (p.begins_with("ro.build.version.sdk=")) {
  373. d.api_level = p.get_slice("=", 1).to_int();
  374. } else if (p.begins_with("ro.product.cpu.abi=")) {
  375. d.description += "CPU: " + p.get_slice("=", 1).strip_edges() + "\n";
  376. } else if (p.begins_with("ro.product.manufacturer=")) {
  377. d.description += "Manufacturer: " + p.get_slice("=", 1).strip_edges() + "\n";
  378. } else if (p.begins_with("ro.board.platform=")) {
  379. d.description += "Chipset: " + p.get_slice("=", 1).strip_edges() + "\n";
  380. } else if (p.begins_with("ro.opengles.version=")) {
  381. uint32_t opengl = p.get_slice("=", 1).to_int();
  382. d.description += "OpenGL: " + itos(opengl >> 16) + "." + itos((opengl >> 8) & 0xFF) + "." + itos((opengl)&0xFF) + "\n";
  383. }
  384. }
  385. d.name = vendor + " " + device;
  386. if (device == String()) {
  387. continue;
  388. }
  389. }
  390. ndevices.push_back(d);
  391. }
  392. ea->devices = ndevices;
  393. ea->devices_changed.set();
  394. }
  395. ea->device_lock.unlock();
  396. }
  397. uint64_t sleep = OS::get_singleton()->get_power_state() == OS::POWERSTATE_ON_BATTERY ? 1000 : 100;
  398. uint64_t wait = 3000000;
  399. uint64_t time = OS::get_singleton()->get_ticks_usec();
  400. while (OS::get_singleton()->get_ticks_usec() - time < wait) {
  401. OS::get_singleton()->delay_usec(1000 * sleep);
  402. if (ea->quit_request.is_set()) {
  403. break;
  404. }
  405. }
  406. }
  407. if (EditorSettings::get_singleton()->get("export/android/shutdown_adb_on_exit")) {
  408. String adb = get_adb_path();
  409. if (!FileAccess::exists(adb)) {
  410. return; //adb not configured
  411. }
  412. List<String> args;
  413. args.push_back("kill-server");
  414. OS::get_singleton()->execute(adb, args, true);
  415. };
  416. }
  417. String get_project_name(const String &p_name) const {
  418. String aname;
  419. if (p_name != "") {
  420. aname = p_name;
  421. } else {
  422. aname = ProjectSettings::get_singleton()->get("application/config/name");
  423. }
  424. if (aname == "") {
  425. aname = VERSION_NAME;
  426. }
  427. return aname;
  428. }
  429. String get_package_name(const String &p_package) const {
  430. String pname = p_package;
  431. String basename = ProjectSettings::get_singleton()->get("application/config/name");
  432. basename = basename.to_lower();
  433. String name;
  434. bool first = true;
  435. for (int i = 0; i < basename.length(); i++) {
  436. CharType c = basename[i];
  437. if (c >= '0' && c <= '9' && first) {
  438. continue;
  439. }
  440. if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9')) {
  441. name += String::chr(c);
  442. first = false;
  443. }
  444. }
  445. if (name == "") {
  446. name = "noname";
  447. }
  448. pname = pname.replace("$genname", name);
  449. return pname;
  450. }
  451. bool is_package_name_valid(const String &p_package, String *r_error = nullptr) const {
  452. String pname = p_package;
  453. if (pname.length() == 0) {
  454. if (r_error) {
  455. *r_error = TTR("Package name is missing.");
  456. }
  457. return false;
  458. }
  459. int segments = 0;
  460. bool first = true;
  461. for (int i = 0; i < pname.length(); i++) {
  462. CharType c = pname[i];
  463. if (first && c == '.') {
  464. if (r_error) {
  465. *r_error = TTR("Package segments must be of non-zero length.");
  466. }
  467. return false;
  468. }
  469. if (c == '.') {
  470. segments++;
  471. first = true;
  472. continue;
  473. }
  474. if (!((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '_')) {
  475. if (r_error) {
  476. *r_error = vformat(TTR("The character '%s' is not allowed in Android application package names."), String::chr(c));
  477. }
  478. return false;
  479. }
  480. if (first && (c >= '0' && c <= '9')) {
  481. if (r_error) {
  482. *r_error = TTR("A digit cannot be the first character in a package segment.");
  483. }
  484. return false;
  485. }
  486. if (first && c == '_') {
  487. if (r_error) {
  488. *r_error = vformat(TTR("The character '%s' cannot be the first character in a package segment."), String::chr(c));
  489. }
  490. return false;
  491. }
  492. first = false;
  493. }
  494. if (segments == 0) {
  495. if (r_error) {
  496. *r_error = TTR("The package must have at least one '.' separator.");
  497. }
  498. return false;
  499. }
  500. if (first) {
  501. if (r_error) {
  502. *r_error = TTR("Package segments must be of non-zero length.");
  503. }
  504. return false;
  505. }
  506. return true;
  507. }
  508. static bool _should_compress_asset(const String &p_path, const Vector<uint8_t> &p_data) {
  509. /*
  510. * By not compressing files with little or not benefit in doing so,
  511. * a performance gain is expected attime. Moreover, if the APK is
  512. * zip-aligned, assets stored as they are can be efficiently read by
  513. * Android by memory-mapping them.
  514. */
  515. // -- Unconditional uncompress to mimic AAPT plus some other
  516. static const char *unconditional_compress_ext[] = {
  517. // From https://github.com/android/platform_frameworks_base/blob/master/tools/aapt/Package.cpp
  518. // These formats are already compressed, or don't compress well:
  519. ".jpg", ".jpeg", ".png", ".gif",
  520. ".wav", ".mp2", ".mp3", ".ogg", ".aac",
  521. ".mpg", ".mpeg", ".mid", ".midi", ".smf", ".jet",
  522. ".rtttl", ".imy", ".xmf", ".mp4", ".m4a",
  523. ".m4v", ".3gp", ".3gpp", ".3g2", ".3gpp2",
  524. ".amr", ".awb", ".wma", ".wmv",
  525. // Godot-specific:
  526. ".webp", // Same reasoning as .png
  527. ".cfb", // Don't let small config files slow-down startup
  528. ".scn", // Binary scenes are usually already compressed
  529. ".stex", // Streamable textures are usually already compressed
  530. // Trailer for easier processing
  531. nullptr
  532. };
  533. for (const char **ext = unconditional_compress_ext; *ext; ++ext) {
  534. if (p_path.to_lower().ends_with(String(*ext))) {
  535. return false;
  536. }
  537. }
  538. // -- Compressed resource?
  539. if (p_data.size() >= 4 && p_data[0] == 'R' && p_data[1] == 'S' && p_data[2] == 'C' && p_data[3] == 'C') {
  540. // Already compressed
  541. return false;
  542. }
  543. // --- TODO: Decide on texture resources according to their image compression setting
  544. return true;
  545. }
  546. static zip_fileinfo get_zip_fileinfo() {
  547. OS::Time time = OS::get_singleton()->get_time();
  548. OS::Date date = OS::get_singleton()->get_date();
  549. zip_fileinfo zipfi;
  550. zipfi.tmz_date.tm_hour = time.hour;
  551. zipfi.tmz_date.tm_mday = date.day;
  552. zipfi.tmz_date.tm_min = time.min;
  553. zipfi.tmz_date.tm_mon = date.month - 1; // tm_mon is zero indexed
  554. zipfi.tmz_date.tm_sec = time.sec;
  555. zipfi.tmz_date.tm_year = date.year;
  556. zipfi.dosDate = 0;
  557. zipfi.external_fa = 0;
  558. zipfi.internal_fa = 0;
  559. return zipfi;
  560. }
  561. static Vector<String> get_abis() {
  562. Vector<String> abis;
  563. abis.push_back("armeabi-v7a");
  564. abis.push_back("arm64-v8a");
  565. abis.push_back("x86");
  566. abis.push_back("x86_64");
  567. return abis;
  568. }
  569. /// List the gdap files in the directory specified by the p_path parameter.
  570. static Vector<String> list_gdap_files(const String &p_path) {
  571. Vector<String> dir_files;
  572. DirAccessRef da = DirAccess::open(p_path);
  573. if (da) {
  574. da->list_dir_begin();
  575. while (true) {
  576. String file = da->get_next();
  577. if (file == "") {
  578. break;
  579. }
  580. if (da->current_is_dir() || da->current_is_hidden()) {
  581. continue;
  582. }
  583. if (file.ends_with(PluginConfigAndroid::PLUGIN_CONFIG_EXT)) {
  584. dir_files.push_back(file);
  585. }
  586. }
  587. da->list_dir_end();
  588. }
  589. return dir_files;
  590. }
  591. static Vector<PluginConfigAndroid> get_plugins() {
  592. Vector<PluginConfigAndroid> loaded_plugins;
  593. String plugins_dir = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/plugins");
  594. // Add the prebuilt plugins
  595. loaded_plugins.append_array(get_prebuilt_plugins(plugins_dir));
  596. if (DirAccess::exists(plugins_dir)) {
  597. Vector<String> plugins_filenames = list_gdap_files(plugins_dir);
  598. if (!plugins_filenames.empty()) {
  599. Ref<ConfigFile> config_file = memnew(ConfigFile);
  600. for (int i = 0; i < plugins_filenames.size(); i++) {
  601. PluginConfigAndroid config = load_plugin_config(config_file, plugins_dir.plus_file(plugins_filenames[i]));
  602. if (config.valid_config) {
  603. loaded_plugins.push_back(config);
  604. } else {
  605. print_error("Invalid plugin config file " + plugins_filenames[i]);
  606. }
  607. }
  608. }
  609. }
  610. return loaded_plugins;
  611. }
  612. static Vector<PluginConfigAndroid> get_enabled_plugins(const Ref<EditorExportPreset> &p_presets) {
  613. Vector<PluginConfigAndroid> enabled_plugins;
  614. Vector<PluginConfigAndroid> all_plugins = get_plugins();
  615. for (int i = 0; i < all_plugins.size(); i++) {
  616. PluginConfigAndroid plugin = all_plugins[i];
  617. bool enabled = p_presets->get("plugins/" + plugin.name);
  618. if (enabled) {
  619. enabled_plugins.push_back(plugin);
  620. }
  621. }
  622. return enabled_plugins;
  623. }
  624. static Error store_in_apk(APKExportData *ed, const String &p_path, const Vector<uint8_t> &p_data, int compression_method = Z_DEFLATED) {
  625. zip_fileinfo zipfi = get_zip_fileinfo();
  626. zipOpenNewFileInZip(ed->apk,
  627. p_path.utf8().get_data(),
  628. &zipfi,
  629. nullptr,
  630. 0,
  631. nullptr,
  632. 0,
  633. nullptr,
  634. compression_method,
  635. Z_DEFAULT_COMPRESSION);
  636. zipWriteInFileInZip(ed->apk, p_data.ptr(), p_data.size());
  637. zipCloseFileInZip(ed->apk);
  638. return OK;
  639. }
  640. static Error save_apk_so(void *p_userdata, const SharedObject &p_so) {
  641. if (!p_so.path.get_file().begins_with("lib")) {
  642. String err = "Android .so file names must start with \"lib\", but got: " + p_so.path;
  643. ERR_PRINTS(err);
  644. return FAILED;
  645. }
  646. APKExportData *ed = (APKExportData *)p_userdata;
  647. Vector<String> abis = get_abis();
  648. bool exported = false;
  649. for (int i = 0; i < p_so.tags.size(); ++i) {
  650. // shared objects can be fat (compatible with multiple ABIs)
  651. int abi_index = abis.find(p_so.tags[i]);
  652. if (abi_index != -1) {
  653. exported = true;
  654. String abi = abis[abi_index];
  655. String dst_path = String("lib").plus_file(abi).plus_file(p_so.path.get_file());
  656. Vector<uint8_t> array = FileAccess::get_file_as_array(p_so.path);
  657. Error store_err = store_in_apk(ed, dst_path, array);
  658. ERR_FAIL_COND_V_MSG(store_err, store_err, "Cannot store in apk file '" + dst_path + "'.");
  659. }
  660. }
  661. if (!exported) {
  662. String abis_string = String(" ").join(abis);
  663. String err = "Cannot determine ABI for library \"" + p_so.path + "\". One of the supported ABIs must be used as a tag: " + abis_string;
  664. ERR_PRINTS(err);
  665. return FAILED;
  666. }
  667. return OK;
  668. }
  669. static Error save_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  670. APKExportData *ed = (APKExportData *)p_userdata;
  671. String dst_path = p_path.replace_first("res://", "assets/");
  672. store_in_apk(ed, dst_path, p_data, _should_compress_asset(p_path, p_data) ? Z_DEFLATED : 0);
  673. return OK;
  674. }
  675. static Error ignore_apk_file(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total) {
  676. return OK;
  677. }
  678. bool _has_storage_permission(const Vector<String> &p_permissions) {
  679. return p_permissions.find("android.permission.READ_EXTERNAL_STORAGE") != -1 || p_permissions.find("android.permission.WRITE_EXTERNAL_STORAGE") != -1;
  680. }
  681. void _get_permissions(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, Vector<String> &r_permissions) {
  682. const char **aperms = android_perms;
  683. while (*aperms) {
  684. bool enabled = p_preset->get("permissions/" + String(*aperms).to_lower());
  685. if (enabled) {
  686. r_permissions.push_back("android.permission." + String(*aperms));
  687. }
  688. aperms++;
  689. }
  690. PoolStringArray user_perms = p_preset->get("permissions/custom_permissions");
  691. for (int i = 0; i < user_perms.size(); i++) {
  692. String user_perm = user_perms[i].strip_edges();
  693. if (!user_perm.empty()) {
  694. r_permissions.push_back(user_perm);
  695. }
  696. }
  697. if (p_give_internet) {
  698. if (r_permissions.find("android.permission.INTERNET") == -1) {
  699. r_permissions.push_back("android.permission.INTERNET");
  700. }
  701. }
  702. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  703. if (xr_mode_index == 1 /* XRMode.OVR */) {
  704. int hand_tracking_index = p_preset->get("xr_features/hand_tracking"); // 0: none, 1: optional, 2: required
  705. if (hand_tracking_index > 0) {
  706. if (r_permissions.find("com.oculus.permission.HAND_TRACKING") == -1) {
  707. r_permissions.push_back("com.oculus.permission.HAND_TRACKING");
  708. }
  709. }
  710. }
  711. }
  712. void _write_tmp_manifest(const Ref<EditorExportPreset> &p_preset, bool p_give_internet, bool p_debug) {
  713. print_verbose("Building temporary manifest..");
  714. String manifest_text =
  715. "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
  716. "<manifest xmlns:android=\"http://schemas.android.com/apk/res/android\"\n"
  717. " xmlns:tools=\"http://schemas.android.com/tools\">\n";
  718. manifest_text += _get_screen_sizes_tag(p_preset);
  719. manifest_text += _get_gles_tag();
  720. Vector<String> perms;
  721. _get_permissions(p_preset, p_give_internet, perms);
  722. for (int i = 0; i < perms.size(); i++) {
  723. manifest_text += vformat(" <uses-permission android:name=\"%s\" />\n", perms.get(i));
  724. }
  725. manifest_text += _get_xr_features_tag(p_preset);
  726. manifest_text += _get_instrumentation_tag(p_preset);
  727. manifest_text += _get_application_tag(p_preset, _has_storage_permission(perms));
  728. manifest_text += "</manifest>\n";
  729. String manifest_path = vformat("res://android/build/src/%s/AndroidManifest.xml", (p_debug ? "debug" : "release"));
  730. print_verbose("Storing manifest into " + manifest_path + ": " + "\n" + manifest_text);
  731. store_string_at_path(manifest_path, manifest_text);
  732. }
  733. void _fix_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_manifest, bool p_give_internet) {
  734. // Leaving the unused types commented because looking these constants up
  735. // again later would be annoying
  736. // const int CHUNK_AXML_FILE = 0x00080003;
  737. // const int CHUNK_RESOURCEIDS = 0x00080180;
  738. const int CHUNK_STRINGS = 0x001C0001;
  739. // const int CHUNK_XML_END_NAMESPACE = 0x00100101;
  740. const int CHUNK_XML_END_TAG = 0x00100103;
  741. // const int CHUNK_XML_START_NAMESPACE = 0x00100100;
  742. const int CHUNK_XML_START_TAG = 0x00100102;
  743. // const int CHUNK_XML_TEXT = 0x00100104;
  744. const int UTF8_FLAG = 0x00000100;
  745. Vector<String> string_table;
  746. uint32_t ofs = 8;
  747. uint32_t string_count = 0;
  748. //uint32_t styles_count = 0;
  749. uint32_t string_flags = 0;
  750. uint32_t string_data_offset = 0;
  751. //uint32_t styles_offset = 0;
  752. uint32_t string_table_begins = 0;
  753. uint32_t string_table_ends = 0;
  754. Vector<uint8_t> stable_extra;
  755. String version_name = p_preset->get("version/name");
  756. int version_code = p_preset->get("version/code");
  757. String package_name = p_preset->get("package/unique_name");
  758. const int screen_orientation = _get_android_orientation_value(_get_screen_orientation());
  759. bool min_gles3 = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name") == "GLES3" &&
  760. !ProjectSettings::get_singleton()->get("rendering/quality/driver/fallback_to_gles2");
  761. bool screen_support_small = p_preset->get("screen/support_small");
  762. bool screen_support_normal = p_preset->get("screen/support_normal");
  763. bool screen_support_large = p_preset->get("screen/support_large");
  764. bool screen_support_xlarge = p_preset->get("screen/support_xlarge");
  765. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  766. bool focus_awareness = p_preset->get("xr_features/focus_awareness");
  767. bool backup_allowed = p_preset->get("user_data_backup/allow");
  768. Vector<String> perms;
  769. // Write permissions into the perms variable.
  770. _get_permissions(p_preset, p_give_internet, perms);
  771. bool has_storage_permission = _has_storage_permission(perms);
  772. while (ofs < (uint32_t)p_manifest.size()) {
  773. uint32_t chunk = decode_uint32(&p_manifest[ofs]);
  774. uint32_t size = decode_uint32(&p_manifest[ofs + 4]);
  775. switch (chunk) {
  776. case CHUNK_STRINGS: {
  777. int iofs = ofs + 8;
  778. string_count = decode_uint32(&p_manifest[iofs]);
  779. //styles_count = decode_uint32(&p_manifest[iofs + 4]);
  780. string_flags = decode_uint32(&p_manifest[iofs + 8]);
  781. string_data_offset = decode_uint32(&p_manifest[iofs + 12]);
  782. //styles_offset = decode_uint32(&p_manifest[iofs + 16]);
  783. /*
  784. printf("string count: %i\n",string_count);
  785. printf("flags: %i\n",string_flags);
  786. printf("sdata ofs: %i\n",string_data_offset);
  787. printf("styles ofs: %i\n",styles_offset);
  788. */
  789. uint32_t st_offset = iofs + 20;
  790. string_table.resize(string_count);
  791. uint32_t string_end = 0;
  792. string_table_begins = st_offset;
  793. for (uint32_t i = 0; i < string_count; i++) {
  794. uint32_t string_at = decode_uint32(&p_manifest[st_offset + i * 4]);
  795. string_at += st_offset + string_count * 4;
  796. ERR_FAIL_COND_MSG(string_flags & UTF8_FLAG, "Unimplemented, can't read UTF-8 string table.");
  797. if (string_flags & UTF8_FLAG) {
  798. } else {
  799. uint32_t len = decode_uint16(&p_manifest[string_at]);
  800. Vector<CharType> ucstring;
  801. ucstring.resize(len + 1);
  802. for (uint32_t j = 0; j < len; j++) {
  803. uint16_t c = decode_uint16(&p_manifest[string_at + 2 + 2 * j]);
  804. ucstring.write[j] = c;
  805. }
  806. string_end = MAX(string_at + 2 + 2 * len, string_end);
  807. ucstring.write[len] = 0;
  808. string_table.write[i] = ucstring.ptr();
  809. }
  810. }
  811. for (uint32_t i = string_end; i < (ofs + size); i++) {
  812. stable_extra.push_back(p_manifest[i]);
  813. }
  814. string_table_ends = ofs + size;
  815. } break;
  816. case CHUNK_XML_START_TAG: {
  817. int iofs = ofs + 8;
  818. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  819. String tname = string_table[name];
  820. uint32_t attrcount = decode_uint32(&p_manifest[iofs + 20]);
  821. iofs += 28;
  822. bool is_focus_aware_metadata = false;
  823. for (uint32_t i = 0; i < attrcount; i++) {
  824. uint32_t attr_nspace = decode_uint32(&p_manifest[iofs]);
  825. uint32_t attr_name = decode_uint32(&p_manifest[iofs + 4]);
  826. uint32_t attr_value = decode_uint32(&p_manifest[iofs + 8]);
  827. uint32_t attr_resid = decode_uint32(&p_manifest[iofs + 16]);
  828. const String value = (attr_value != 0xFFFFFFFF) ? string_table[attr_value] : "Res #" + itos(attr_resid);
  829. String attrname = string_table[attr_name];
  830. const String nspace = (attr_nspace != 0xFFFFFFFF) ? string_table[attr_nspace] : "";
  831. //replace project information
  832. if (tname == "manifest" && attrname == "package") {
  833. string_table.write[attr_value] = get_package_name(package_name);
  834. }
  835. if (tname == "manifest" && attrname == "versionCode") {
  836. encode_uint32(version_code, &p_manifest.write[iofs + 16]);
  837. }
  838. if (tname == "manifest" && attrname == "versionName") {
  839. if (attr_value == 0xFFFFFFFF) {
  840. WARN_PRINT("Version name in a resource, should be plain text");
  841. } else {
  842. string_table.write[attr_value] = version_name;
  843. }
  844. }
  845. if (tname == "application" && attrname == "requestLegacyExternalStorage") {
  846. encode_uint32(has_storage_permission ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  847. }
  848. if (tname == "application" && attrname == "allowBackup") {
  849. encode_uint32(backup_allowed, &p_manifest.write[iofs + 16]);
  850. }
  851. if (tname == "instrumentation" && attrname == "targetPackage") {
  852. string_table.write[attr_value] = get_package_name(package_name);
  853. }
  854. if (tname == "activity" && attrname == "screenOrientation") {
  855. encode_uint32(screen_orientation, &p_manifest.write[iofs + 16]);
  856. }
  857. if (tname == "supports-screens") {
  858. if (attrname == "smallScreens") {
  859. encode_uint32(screen_support_small ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  860. } else if (attrname == "normalScreens") {
  861. encode_uint32(screen_support_normal ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  862. } else if (attrname == "largeScreens") {
  863. encode_uint32(screen_support_large ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  864. } else if (attrname == "xlargeScreens") {
  865. encode_uint32(screen_support_xlarge ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  866. }
  867. }
  868. if (tname == "uses-feature" && attrname == "glEsVersion") {
  869. encode_uint32(min_gles3 ? 0x00030000 : 0x00020000, &p_manifest.write[iofs + 16]);
  870. }
  871. // FIXME: `attr_value != 0xFFFFFFFF` below added as a stopgap measure for GH-32553,
  872. // but the issue should be debugged further and properly addressed.
  873. if (tname == "meta-data" && attrname == "name" && value == "xr_mode_metadata_name") {
  874. // Update the meta-data 'android:name' attribute based on the selected XR mode.
  875. if (xr_mode_index == 1 /* XRMode.OVR */) {
  876. string_table.write[attr_value] = "com.samsung.android.vr.application.mode";
  877. }
  878. }
  879. if (tname == "meta-data" && attrname == "value" && value == "xr_mode_metadata_value") {
  880. // Update the meta-data 'android:value' attribute based on the selected XR mode.
  881. if (xr_mode_index == 1 /* XRMode.OVR */) {
  882. string_table.write[attr_value] = "vr_only";
  883. }
  884. }
  885. if (tname == "meta-data" && attrname == "value" && is_focus_aware_metadata) {
  886. // Update the focus awareness meta-data value
  887. encode_uint32(xr_mode_index == /* XRMode.OVR */ 1 && focus_awareness ? 0xFFFFFFFF : 0, &p_manifest.write[iofs + 16]);
  888. }
  889. is_focus_aware_metadata = tname == "meta-data" && attrname == "name" && value == "com.oculus.vr.focusaware";
  890. iofs += 20;
  891. }
  892. } break;
  893. case CHUNK_XML_END_TAG: {
  894. int iofs = ofs + 8;
  895. uint32_t name = decode_uint32(&p_manifest[iofs + 12]);
  896. String tname = string_table[name];
  897. if (tname == "uses-feature") {
  898. Vector<String> feature_names;
  899. Vector<bool> feature_required_list;
  900. Vector<int> feature_versions;
  901. if (xr_mode_index == 1 /* XRMode.OVR */) {
  902. // Check for degrees of freedom
  903. int dof_index = p_preset->get("xr_features/degrees_of_freedom"); // 0: none, 1: 3dof and 6dof, 2: 6dof
  904. if (dof_index > 0) {
  905. feature_names.push_back("android.hardware.vr.headtracking");
  906. feature_required_list.push_back(dof_index == 2);
  907. feature_versions.push_back(1);
  908. }
  909. // Check for hand tracking
  910. int hand_tracking_index = p_preset->get("xr_features/hand_tracking"); // 0: none, 1: optional, 2: required
  911. if (hand_tracking_index > 0) {
  912. feature_names.push_back("oculus.software.handtracking");
  913. feature_required_list.push_back(hand_tracking_index == 2);
  914. feature_versions.push_back(-1); // no version attribute should be added.
  915. }
  916. }
  917. if (feature_names.size() > 0) {
  918. ofs += 24; // skip over end tag
  919. // save manifest ending so we can restore it
  920. Vector<uint8_t> manifest_end;
  921. uint32_t manifest_cur_size = p_manifest.size();
  922. manifest_end.resize(p_manifest.size() - ofs);
  923. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  924. int32_t attr_name_string = string_table.find("name");
  925. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  926. int32_t ns_android_string = string_table.find("http://schemas.android.com/apk/res/android");
  927. if (ns_android_string == -1) {
  928. string_table.push_back("http://schemas.android.com/apk/res/android");
  929. ns_android_string = string_table.size() - 1;
  930. }
  931. int32_t attr_uses_feature_string = string_table.find("uses-feature");
  932. if (attr_uses_feature_string == -1) {
  933. string_table.push_back("uses-feature");
  934. attr_uses_feature_string = string_table.size() - 1;
  935. }
  936. int32_t attr_required_string = string_table.find("required");
  937. if (attr_required_string == -1) {
  938. string_table.push_back("required");
  939. attr_required_string = string_table.size() - 1;
  940. }
  941. for (int i = 0; i < feature_names.size(); i++) {
  942. String feature_name = feature_names[i];
  943. bool feature_required = feature_required_list[i];
  944. int feature_version = feature_versions[i];
  945. bool has_version_attribute = feature_version != -1;
  946. print_line("Adding feature " + feature_name);
  947. int32_t feature_string = string_table.find(feature_name);
  948. if (feature_string == -1) {
  949. string_table.push_back(feature_name);
  950. feature_string = string_table.size() - 1;
  951. }
  952. String required_value_string = feature_required ? "true" : "false";
  953. int32_t required_value = string_table.find(required_value_string);
  954. if (required_value == -1) {
  955. string_table.push_back(required_value_string);
  956. required_value = string_table.size() - 1;
  957. }
  958. int32_t attr_version_string = -1;
  959. int32_t version_value = -1;
  960. int tag_size;
  961. int attr_count;
  962. if (has_version_attribute) {
  963. attr_version_string = string_table.find("version");
  964. if (attr_version_string == -1) {
  965. string_table.push_back("version");
  966. attr_version_string = string_table.size() - 1;
  967. }
  968. version_value = string_table.find(itos(feature_version));
  969. if (version_value == -1) {
  970. string_table.push_back(itos(feature_version));
  971. version_value = string_table.size() - 1;
  972. }
  973. tag_size = 96; // node and three attrs + end node
  974. attr_count = 3;
  975. } else {
  976. tag_size = 76; // node and two attrs + end node
  977. attr_count = 2;
  978. }
  979. manifest_cur_size += tag_size + 24;
  980. p_manifest.resize(manifest_cur_size);
  981. // start tag
  982. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  983. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  984. encode_uint32(tag_size, &p_manifest.write[ofs + 4]); // size
  985. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  986. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  987. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  988. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  989. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  990. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  991. encode_uint16(attr_count, &p_manifest.write[ofs + 28]); // num_attrs
  992. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  993. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  994. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  995. // android:name attribute
  996. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  997. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  998. encode_uint32(feature_string, &p_manifest.write[ofs + 44]); // raw_value
  999. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1000. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1001. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1002. encode_uint32(feature_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1003. // android:required attribute
  1004. encode_uint32(ns_android_string, &p_manifest.write[ofs + 56]); // ns
  1005. encode_uint32(attr_required_string, &p_manifest.write[ofs + 60]); // 'name'
  1006. encode_uint32(required_value, &p_manifest.write[ofs + 64]); // raw_value
  1007. encode_uint16(8, &p_manifest.write[ofs + 68]); // typedvalue_size
  1008. p_manifest.write[ofs + 70] = 0; // typedvalue_always0
  1009. p_manifest.write[ofs + 71] = 0x03; // typedvalue_type (string)
  1010. encode_uint32(required_value, &p_manifest.write[ofs + 72]); // typedvalue reference
  1011. ofs += 76;
  1012. if (has_version_attribute) {
  1013. // android:version attribute
  1014. encode_uint32(ns_android_string, &p_manifest.write[ofs]); // ns
  1015. encode_uint32(attr_version_string, &p_manifest.write[ofs + 4]); // 'name'
  1016. encode_uint32(version_value, &p_manifest.write[ofs + 8]); // raw_value
  1017. encode_uint16(8, &p_manifest.write[ofs + 12]); // typedvalue_size
  1018. p_manifest.write[ofs + 14] = 0; // typedvalue_always0
  1019. p_manifest.write[ofs + 15] = 0x03; // typedvalue_type (string)
  1020. encode_uint32(version_value, &p_manifest.write[ofs + 16]); // typedvalue reference
  1021. ofs += 20;
  1022. }
  1023. // end tag
  1024. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1025. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1026. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1027. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1028. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1029. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1030. encode_uint32(attr_uses_feature_string, &p_manifest.write[ofs + 20]); // name
  1031. ofs += 24;
  1032. }
  1033. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1034. ofs -= 24; // go back over back end
  1035. }
  1036. }
  1037. if (tname == "manifest") {
  1038. // save manifest ending so we can restore it
  1039. Vector<uint8_t> manifest_end;
  1040. uint32_t manifest_cur_size = p_manifest.size();
  1041. manifest_end.resize(p_manifest.size() - ofs);
  1042. memcpy(manifest_end.ptrw(), &p_manifest[ofs], manifest_end.size());
  1043. int32_t attr_name_string = string_table.find("name");
  1044. ERR_FAIL_COND_MSG(attr_name_string == -1, "Template does not have 'name' attribute.");
  1045. int32_t ns_android_string = string_table.find("android");
  1046. ERR_FAIL_COND_MSG(ns_android_string == -1, "Template does not have 'android' namespace.");
  1047. int32_t attr_uses_permission_string = string_table.find("uses-permission");
  1048. if (attr_uses_permission_string == -1) {
  1049. string_table.push_back("uses-permission");
  1050. attr_uses_permission_string = string_table.size() - 1;
  1051. }
  1052. for (int i = 0; i < perms.size(); ++i) {
  1053. print_line("Adding permission " + perms[i]);
  1054. manifest_cur_size += 56 + 24; // node + end node
  1055. p_manifest.resize(manifest_cur_size);
  1056. // Add permission to the string pool
  1057. int32_t perm_string = string_table.find(perms[i]);
  1058. if (perm_string == -1) {
  1059. string_table.push_back(perms[i]);
  1060. perm_string = string_table.size() - 1;
  1061. }
  1062. // start tag
  1063. encode_uint16(0x102, &p_manifest.write[ofs]); // type
  1064. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1065. encode_uint32(56, &p_manifest.write[ofs + 4]); // size
  1066. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1067. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1068. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1069. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1070. encode_uint16(20, &p_manifest.write[ofs + 24]); // attr_start
  1071. encode_uint16(20, &p_manifest.write[ofs + 26]); // attr_size
  1072. encode_uint16(1, &p_manifest.write[ofs + 28]); // num_attrs
  1073. encode_uint16(0, &p_manifest.write[ofs + 30]); // id_index
  1074. encode_uint16(0, &p_manifest.write[ofs + 32]); // class_index
  1075. encode_uint16(0, &p_manifest.write[ofs + 34]); // style_index
  1076. // attribute
  1077. encode_uint32(ns_android_string, &p_manifest.write[ofs + 36]); // ns
  1078. encode_uint32(attr_name_string, &p_manifest.write[ofs + 40]); // 'name'
  1079. encode_uint32(perm_string, &p_manifest.write[ofs + 44]); // raw_value
  1080. encode_uint16(8, &p_manifest.write[ofs + 48]); // typedvalue_size
  1081. p_manifest.write[ofs + 50] = 0; // typedvalue_always0
  1082. p_manifest.write[ofs + 51] = 0x03; // typedvalue_type (string)
  1083. encode_uint32(perm_string, &p_manifest.write[ofs + 52]); // typedvalue reference
  1084. ofs += 56;
  1085. // end tag
  1086. encode_uint16(0x103, &p_manifest.write[ofs]); // type
  1087. encode_uint16(16, &p_manifest.write[ofs + 2]); // headersize
  1088. encode_uint32(24, &p_manifest.write[ofs + 4]); // size
  1089. encode_uint32(0, &p_manifest.write[ofs + 8]); // lineno
  1090. encode_uint32(-1, &p_manifest.write[ofs + 12]); // comment
  1091. encode_uint32(-1, &p_manifest.write[ofs + 16]); // ns
  1092. encode_uint32(attr_uses_permission_string, &p_manifest.write[ofs + 20]); // name
  1093. ofs += 24;
  1094. }
  1095. // copy footer back in
  1096. memcpy(&p_manifest.write[ofs], manifest_end.ptr(), manifest_end.size());
  1097. }
  1098. } break;
  1099. }
  1100. ofs += size;
  1101. }
  1102. //create new andriodmanifest binary
  1103. Vector<uint8_t> ret;
  1104. ret.resize(string_table_begins + string_table.size() * 4);
  1105. for (uint32_t i = 0; i < string_table_begins; i++) {
  1106. ret.write[i] = p_manifest[i];
  1107. }
  1108. ofs = 0;
  1109. for (int i = 0; i < string_table.size(); i++) {
  1110. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1111. ofs += string_table[i].length() * 2 + 2 + 2;
  1112. }
  1113. ret.resize(ret.size() + ofs);
  1114. string_data_offset = ret.size() - ofs;
  1115. uint8_t *chars = &ret.write[string_data_offset];
  1116. for (int i = 0; i < string_table.size(); i++) {
  1117. String s = string_table[i];
  1118. encode_uint16(s.length(), chars);
  1119. chars += 2;
  1120. for (int j = 0; j < s.length(); j++) {
  1121. encode_uint16(s[j], chars);
  1122. chars += 2;
  1123. }
  1124. encode_uint16(0, chars);
  1125. chars += 2;
  1126. }
  1127. for (int i = 0; i < stable_extra.size(); i++) {
  1128. ret.push_back(stable_extra[i]);
  1129. }
  1130. //pad
  1131. while (ret.size() % 4) {
  1132. ret.push_back(0);
  1133. }
  1134. uint32_t new_stable_end = ret.size();
  1135. uint32_t extra = (p_manifest.size() - string_table_ends);
  1136. ret.resize(new_stable_end + extra);
  1137. for (uint32_t i = 0; i < extra; i++) {
  1138. ret.write[new_stable_end + i] = p_manifest[string_table_ends + i];
  1139. }
  1140. while (ret.size() % 4) {
  1141. ret.push_back(0);
  1142. }
  1143. encode_uint32(ret.size(), &ret.write[4]); //update new file size
  1144. encode_uint32(new_stable_end - 8, &ret.write[12]); //update new string table size
  1145. encode_uint32(string_table.size(), &ret.write[16]); //update new number of strings
  1146. encode_uint32(string_data_offset - 8, &ret.write[28]); //update new string data offset
  1147. p_manifest = ret;
  1148. }
  1149. static String _parse_string(const uint8_t *p_bytes, bool p_utf8) {
  1150. uint32_t offset = 0;
  1151. uint32_t len = 0;
  1152. if (p_utf8) {
  1153. uint8_t byte = p_bytes[offset];
  1154. if (byte & 0x80) {
  1155. offset += 2;
  1156. } else {
  1157. offset += 1;
  1158. }
  1159. byte = p_bytes[offset];
  1160. offset++;
  1161. if (byte & 0x80) {
  1162. len = byte & 0x7F;
  1163. len = (len << 8) + p_bytes[offset];
  1164. offset++;
  1165. } else {
  1166. len = byte;
  1167. }
  1168. } else {
  1169. len = decode_uint16(&p_bytes[offset]);
  1170. offset += 2;
  1171. if (len & 0x8000) {
  1172. len &= 0x7FFF;
  1173. len = (len << 16) + decode_uint16(&p_bytes[offset]);
  1174. offset += 2;
  1175. }
  1176. }
  1177. if (p_utf8) {
  1178. Vector<uint8_t> str8;
  1179. str8.resize(len + 1);
  1180. for (uint32_t i = 0; i < len; i++) {
  1181. str8.write[i] = p_bytes[offset + i];
  1182. }
  1183. str8.write[len] = 0;
  1184. String str;
  1185. str.parse_utf8((const char *)str8.ptr());
  1186. return str;
  1187. } else {
  1188. String str;
  1189. for (uint32_t i = 0; i < len; i++) {
  1190. CharType c = decode_uint16(&p_bytes[offset + i * 2]);
  1191. if (c == 0) {
  1192. break;
  1193. }
  1194. str += String::chr(c);
  1195. }
  1196. return str;
  1197. }
  1198. }
  1199. void _fix_resources(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &r_manifest) {
  1200. const int UTF8_FLAG = 0x00000100;
  1201. uint32_t string_block_len = decode_uint32(&r_manifest[16]);
  1202. uint32_t string_count = decode_uint32(&r_manifest[20]);
  1203. uint32_t string_flags = decode_uint32(&r_manifest[28]);
  1204. const uint32_t string_table_begins = 40;
  1205. Vector<String> string_table;
  1206. String package_name = p_preset->get("package/name");
  1207. for (uint32_t i = 0; i < string_count; i++) {
  1208. uint32_t offset = decode_uint32(&r_manifest[string_table_begins + i * 4]);
  1209. offset += string_table_begins + string_count * 4;
  1210. String str = _parse_string(&r_manifest[offset], string_flags & UTF8_FLAG);
  1211. if (str.begins_with("godot-project-name")) {
  1212. if (str == "godot-project-name") {
  1213. //project name
  1214. str = get_project_name(package_name);
  1215. } else {
  1216. String lang = str.substr(str.find_last("-") + 1, str.length()).replace("-", "_");
  1217. String prop = "application/config/name_" + lang;
  1218. if (ProjectSettings::get_singleton()->has_setting(prop)) {
  1219. str = ProjectSettings::get_singleton()->get(prop);
  1220. } else {
  1221. str = get_project_name(package_name);
  1222. }
  1223. }
  1224. }
  1225. string_table.push_back(str);
  1226. }
  1227. //write a new string table, but use 16 bits
  1228. Vector<uint8_t> ret;
  1229. ret.resize(string_table_begins + string_table.size() * 4);
  1230. for (uint32_t i = 0; i < string_table_begins; i++) {
  1231. ret.write[i] = r_manifest[i];
  1232. }
  1233. int ofs = 0;
  1234. for (int i = 0; i < string_table.size(); i++) {
  1235. encode_uint32(ofs, &ret.write[string_table_begins + i * 4]);
  1236. ofs += string_table[i].length() * 2 + 2 + 2;
  1237. }
  1238. ret.resize(ret.size() + ofs);
  1239. uint8_t *chars = &ret.write[ret.size() - ofs];
  1240. for (int i = 0; i < string_table.size(); i++) {
  1241. String s = string_table[i];
  1242. encode_uint16(s.length(), chars);
  1243. chars += 2;
  1244. for (int j = 0; j < s.length(); j++) {
  1245. encode_uint16(s[j], chars);
  1246. chars += 2;
  1247. }
  1248. encode_uint16(0, chars);
  1249. chars += 2;
  1250. }
  1251. //pad
  1252. while (ret.size() % 4) {
  1253. ret.push_back(0);
  1254. }
  1255. //change flags to not use utf8
  1256. encode_uint32(string_flags & ~0x100, &ret.write[28]);
  1257. //change length
  1258. encode_uint32(ret.size() - 12, &ret.write[16]);
  1259. //append the rest...
  1260. int rest_from = 12 + string_block_len;
  1261. int rest_to = ret.size();
  1262. int rest_len = (r_manifest.size() - rest_from);
  1263. ret.resize(ret.size() + (r_manifest.size() - rest_from));
  1264. for (int i = 0; i < rest_len; i++) {
  1265. ret.write[rest_to + i] = r_manifest[rest_from + i];
  1266. }
  1267. //finally update the size
  1268. encode_uint32(ret.size(), &ret.write[4]);
  1269. r_manifest = ret;
  1270. //printf("end\n");
  1271. }
  1272. void _load_image_data(const Ref<Image> &p_splash_image, Vector<uint8_t> &p_data) {
  1273. PoolVector<uint8_t> png_buffer;
  1274. Error err = PNGDriverCommon::image_to_png(p_splash_image, png_buffer);
  1275. if (err == OK) {
  1276. p_data.resize(png_buffer.size());
  1277. memcpy(p_data.ptrw(), png_buffer.read().ptr(), p_data.size());
  1278. } else {
  1279. String err_str = String("Failed to convert splash image to png.");
  1280. WARN_PRINT(err_str.utf8().get_data());
  1281. }
  1282. }
  1283. void _process_launcher_icons(const String &p_file_name, const Ref<Image> &p_source_image, int dimension, Vector<uint8_t> &p_data) {
  1284. Ref<Image> working_image = p_source_image;
  1285. if (p_source_image->get_width() != dimension || p_source_image->get_height() != dimension) {
  1286. working_image = p_source_image->duplicate();
  1287. working_image->resize(dimension, dimension, Image::Interpolation::INTERPOLATE_LANCZOS);
  1288. }
  1289. PoolVector<uint8_t> png_buffer;
  1290. Error err = PNGDriverCommon::image_to_png(working_image, png_buffer);
  1291. if (err == OK) {
  1292. p_data.resize(png_buffer.size());
  1293. memcpy(p_data.ptrw(), png_buffer.read().ptr(), p_data.size());
  1294. } else {
  1295. String err_str = String("Failed to convert resized icon (") + p_file_name + ") to png.";
  1296. WARN_PRINT(err_str.utf8().get_data());
  1297. }
  1298. }
  1299. String load_splash_refs(Ref<Image> &splash_image, Ref<Image> &splash_bg_color_image) {
  1300. bool scale_splash = ProjectSettings::get_singleton()->get("application/boot_splash/fullsize");
  1301. bool apply_filter = ProjectSettings::get_singleton()->get("application/boot_splash/use_filter");
  1302. String project_splash_path = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  1303. if (!project_splash_path.empty()) {
  1304. splash_image.instance();
  1305. print_verbose("Loading splash image: " + project_splash_path);
  1306. const Error err = ImageLoader::load_image(project_splash_path, splash_image);
  1307. if (err) {
  1308. if (OS::get_singleton()->is_stdout_verbose()) {
  1309. print_error("- unable to load splash image from " + project_splash_path + " (" + itos(err) + ")");
  1310. }
  1311. splash_image.unref();
  1312. }
  1313. }
  1314. if (splash_image.is_null()) {
  1315. // Use the default
  1316. print_verbose("Using default splash image.");
  1317. splash_image = Ref<Image>(memnew(Image(boot_splash_png)));
  1318. }
  1319. if (scale_splash) {
  1320. Size2 screen_size = Size2(ProjectSettings::get_singleton()->get("display/window/size/width"), ProjectSettings::get_singleton()->get("display/window/size/height"));
  1321. int width, height;
  1322. if (screen_size.width > screen_size.height) {
  1323. // scale horizontally
  1324. height = screen_size.height;
  1325. width = splash_image->get_width() * screen_size.height / splash_image->get_height();
  1326. } else {
  1327. // scale vertically
  1328. width = screen_size.width;
  1329. height = splash_image->get_height() * screen_size.width / splash_image->get_width();
  1330. }
  1331. splash_image->resize(width, height);
  1332. }
  1333. // Setup the splash bg color
  1334. bool bg_color_valid;
  1335. Color bg_color = ProjectSettings::get_singleton()->get("application/boot_splash/bg_color", &bg_color_valid);
  1336. if (!bg_color_valid) {
  1337. bg_color = boot_splash_bg_color;
  1338. }
  1339. print_verbose("Creating splash background color image.");
  1340. splash_bg_color_image.instance();
  1341. splash_bg_color_image->create(splash_image->get_width(), splash_image->get_height(), false, splash_image->get_format());
  1342. splash_bg_color_image->fill(bg_color);
  1343. String processed_splash_config_xml = vformat(SPLASH_CONFIG_XML_CONTENT, bool_to_string(apply_filter));
  1344. return processed_splash_config_xml;
  1345. }
  1346. void load_icon_refs(const Ref<EditorExportPreset> &p_preset, Ref<Image> &icon, Ref<Image> &foreground, Ref<Image> &background) {
  1347. String project_icon_path = ProjectSettings::get_singleton()->get("application/config/icon");
  1348. icon.instance();
  1349. foreground.instance();
  1350. background.instance();
  1351. // Regular icon: user selection -> project icon -> default.
  1352. String path = static_cast<String>(p_preset->get(launcher_icon_option)).strip_edges();
  1353. print_verbose("Loading regular icon from " + path);
  1354. if (path.empty() || ImageLoader::load_image(path, icon) != OK) {
  1355. print_verbose("- falling back to project icon: " + project_icon_path);
  1356. ImageLoader::load_image(project_icon_path, icon);
  1357. }
  1358. // Adaptive foreground: user selection -> regular icon (user selection -> project icon -> default).
  1359. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_foreground_option)).strip_edges();
  1360. print_verbose("Loading adaptive foreground icon from " + path);
  1361. if (path.empty() || ImageLoader::load_image(path, foreground) != OK) {
  1362. print_verbose("- falling back to using the regular icon");
  1363. foreground = icon;
  1364. }
  1365. // Adaptive background: user selection -> default.
  1366. path = static_cast<String>(p_preset->get(launcher_adaptive_icon_background_option)).strip_edges();
  1367. if (!path.empty()) {
  1368. print_verbose("Loading adaptive background icon from " + path);
  1369. ImageLoader::load_image(path, background);
  1370. }
  1371. }
  1372. void store_image(const LauncherIcon launcher_icon, const Vector<uint8_t> &data) {
  1373. store_image(launcher_icon.export_path, data);
  1374. }
  1375. void store_image(const String &export_path, const Vector<uint8_t> &data) {
  1376. String img_path = export_path.insert(0, "res://android/build/");
  1377. store_file_at_path(img_path, data);
  1378. }
  1379. void _copy_icons_to_gradle_project(const Ref<EditorExportPreset> &p_preset,
  1380. const String &processed_splash_config_xml,
  1381. const Ref<Image> &splash_image,
  1382. const Ref<Image> &splash_bg_color_image,
  1383. const Ref<Image> &main_image,
  1384. const Ref<Image> &foreground,
  1385. const Ref<Image> &background) {
  1386. // Store the splash configuration
  1387. if (!processed_splash_config_xml.empty()) {
  1388. print_verbose("Storing processed splash configuration: " + String("\n") + processed_splash_config_xml);
  1389. store_string_at_path(SPLASH_CONFIG_PATH, processed_splash_config_xml);
  1390. }
  1391. // Store the splash image
  1392. if (splash_image.is_valid() && !splash_image->empty()) {
  1393. print_verbose("Storing splash image in " + String(SPLASH_IMAGE_EXPORT_PATH));
  1394. Vector<uint8_t> data;
  1395. _load_image_data(splash_image, data);
  1396. store_image(SPLASH_IMAGE_EXPORT_PATH, data);
  1397. }
  1398. // Store the splash bg color image
  1399. if (splash_bg_color_image.is_valid() && !splash_bg_color_image->empty()) {
  1400. print_verbose("Storing splash background image in " + String(SPLASH_BG_COLOR_PATH));
  1401. Vector<uint8_t> data;
  1402. _load_image_data(splash_bg_color_image, data);
  1403. store_image(SPLASH_BG_COLOR_PATH, data);
  1404. }
  1405. // Prepare images to be resized for the icons. If some image ends up being uninitialized,
  1406. // the default image from the export template will be used.
  1407. for (int i = 0; i < icon_densities_count; ++i) {
  1408. if (main_image.is_valid() && !main_image->empty()) {
  1409. print_verbose("Processing launcher icon for dimension " + itos(launcher_icons[i].dimensions) + " into " + launcher_icons[i].export_path);
  1410. Vector<uint8_t> data;
  1411. _process_launcher_icons(launcher_icons[i].export_path, main_image, launcher_icons[i].dimensions, data);
  1412. store_image(launcher_icons[i], data);
  1413. }
  1414. if (foreground.is_valid() && !foreground->empty()) {
  1415. print_verbose("Processing launcher adaptive icon foreground for dimension " + itos(launcher_adaptive_icon_foregrounds[i].dimensions) + " into " + launcher_adaptive_icon_foregrounds[i].export_path);
  1416. Vector<uint8_t> data;
  1417. _process_launcher_icons(launcher_adaptive_icon_foregrounds[i].export_path, foreground,
  1418. launcher_adaptive_icon_foregrounds[i].dimensions, data);
  1419. store_image(launcher_adaptive_icon_foregrounds[i], data);
  1420. }
  1421. if (background.is_valid() && !background->empty()) {
  1422. print_verbose("Processing launcher adaptive icon background for dimension " + itos(launcher_adaptive_icon_backgrounds[i].dimensions) + " into " + launcher_adaptive_icon_backgrounds[i].export_path);
  1423. Vector<uint8_t> data;
  1424. _process_launcher_icons(launcher_adaptive_icon_backgrounds[i].export_path, background,
  1425. launcher_adaptive_icon_backgrounds[i].dimensions, data);
  1426. store_image(launcher_adaptive_icon_backgrounds[i], data);
  1427. }
  1428. }
  1429. }
  1430. static Vector<String> get_enabled_abis(const Ref<EditorExportPreset> &p_preset) {
  1431. Vector<String> abis = get_abis();
  1432. Vector<String> enabled_abis;
  1433. for (int i = 0; i < abis.size(); ++i) {
  1434. bool is_enabled = p_preset->get("architectures/" + abis[i]);
  1435. if (is_enabled) {
  1436. enabled_abis.push_back(abis[i]);
  1437. }
  1438. }
  1439. return enabled_abis;
  1440. }
  1441. public:
  1442. typedef Error (*EditorExportSaveFunction)(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total);
  1443. public:
  1444. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) {
  1445. String driver = ProjectSettings::get_singleton()->get("rendering/quality/driver/driver_name");
  1446. if (driver == "GLES2") {
  1447. r_features->push_back("etc");
  1448. } else if (driver == "GLES3") {
  1449. r_features->push_back("etc2");
  1450. if (ProjectSettings::get_singleton()->get("rendering/quality/driver/fallback_to_gles2")) {
  1451. r_features->push_back("etc");
  1452. }
  1453. }
  1454. Vector<String> abis = get_enabled_abis(p_preset);
  1455. for (int i = 0; i < abis.size(); ++i) {
  1456. r_features->push_back(abis[i]);
  1457. }
  1458. }
  1459. virtual void get_export_options(List<ExportOption> *r_options) {
  1460. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1461. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.apk"), ""));
  1462. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "custom_template/use_custom_build"), false));
  1463. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "custom_template/export_format", PROPERTY_HINT_ENUM, "Export APK,Export AAB"), EXPORT_FORMAT_APK));
  1464. Vector<PluginConfigAndroid> plugins_configs = get_plugins();
  1465. for (int i = 0; i < plugins_configs.size(); i++) {
  1466. print_verbose("Found Android plugin " + plugins_configs[i].name);
  1467. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "plugins/" + plugins_configs[i].name), false));
  1468. }
  1469. plugins_changed.clear();
  1470. Vector<String> abis = get_abis();
  1471. for (int i = 0; i < abis.size(); ++i) {
  1472. String abi = abis[i];
  1473. bool is_default = (abi == "armeabi-v7a" || abi == "arm64-v8a");
  1474. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "architectures/" + abi), is_default));
  1475. }
  1476. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"), ""));
  1477. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_user"), ""));
  1478. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/debug_password"), ""));
  1479. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"), ""));
  1480. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_user"), ""));
  1481. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "keystore/release_password"), ""));
  1482. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "one_click_deploy/clear_previous_install"), false));
  1483. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "version/code", PROPERTY_HINT_RANGE, "1,4096,1,or_greater"), 1));
  1484. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "version/name"), "1.0"));
  1485. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/unique_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "ext.domain.name"), "org.godotengine.$genname"));
  1486. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "package/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name [default if blank]"), ""));
  1487. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "package/signed"), true));
  1488. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_icon_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1489. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_foreground_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1490. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, launcher_adaptive_icon_background_option, PROPERTY_HINT_FILE, "*.png"), ""));
  1491. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/32_bits_framebuffer"), true));
  1492. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "graphics/opengl_debug"), false));
  1493. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/xr_mode", PROPERTY_HINT_ENUM, "Regular,Oculus Mobile VR"), 0));
  1494. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/degrees_of_freedom", PROPERTY_HINT_ENUM, "None,3DOF and 6DOF,6DOF"), 0));
  1495. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "xr_features/hand_tracking", PROPERTY_HINT_ENUM, "None,Optional,Required"), 0));
  1496. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "xr_features/focus_awareness"), false));
  1497. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/immersive_mode"), true));
  1498. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_small"), true));
  1499. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_normal"), true));
  1500. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_large"), true));
  1501. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "screen/support_xlarge"), true));
  1502. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data_backup/allow"), false));
  1503. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "command_line/extra_args"), ""));
  1504. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "apk_expansion/enable"), false));
  1505. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/SALT"), ""));
  1506. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "apk_expansion/public_key", PROPERTY_HINT_MULTILINE_TEXT), ""));
  1507. r_options->push_back(ExportOption(PropertyInfo(Variant::POOL_STRING_ARRAY, "permissions/custom_permissions"), PoolStringArray()));
  1508. const char **perms = android_perms;
  1509. while (*perms) {
  1510. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "permissions/" + String(*perms).to_lower()), false));
  1511. perms++;
  1512. }
  1513. }
  1514. virtual String get_name() const {
  1515. return "Android";
  1516. }
  1517. virtual String get_os_name() const {
  1518. return "Android";
  1519. }
  1520. virtual Ref<Texture> get_logo() const {
  1521. return logo;
  1522. }
  1523. virtual bool should_update_export_options() {
  1524. bool export_options_changed = plugins_changed.is_set();
  1525. if (export_options_changed) {
  1526. // don't clear unless we're reporting true, to avoid race
  1527. plugins_changed.clear();
  1528. }
  1529. return export_options_changed;
  1530. }
  1531. virtual bool poll_export() {
  1532. bool dc = devices_changed.is_set();
  1533. if (dc) {
  1534. // don't clear unless we're reporting true, to avoid race
  1535. devices_changed.clear();
  1536. }
  1537. return dc;
  1538. }
  1539. virtual int get_options_count() const {
  1540. device_lock.lock();
  1541. int dc = devices.size();
  1542. device_lock.unlock();
  1543. return dc;
  1544. }
  1545. virtual String get_options_tooltip() const {
  1546. return TTR("Select device from the list");
  1547. }
  1548. virtual String get_option_label(int p_index) const {
  1549. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1550. device_lock.lock();
  1551. String s = devices[p_index].name;
  1552. device_lock.unlock();
  1553. return s;
  1554. }
  1555. virtual String get_option_tooltip(int p_index) const {
  1556. ERR_FAIL_INDEX_V(p_index, devices.size(), "");
  1557. device_lock.lock();
  1558. String s = devices[p_index].description;
  1559. if (devices.size() == 1) {
  1560. // Tooltip will be:
  1561. // Name
  1562. // Description
  1563. s = devices[p_index].name + "\n\n" + s;
  1564. }
  1565. device_lock.unlock();
  1566. return s;
  1567. }
  1568. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  1569. ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER);
  1570. String can_export_error;
  1571. bool can_export_missing_templates;
  1572. if (!can_export(p_preset, can_export_error, can_export_missing_templates)) {
  1573. EditorNode::add_io_error(can_export_error);
  1574. return ERR_UNCONFIGURED;
  1575. }
  1576. device_lock.lock();
  1577. EditorProgress ep("run", "Running on " + devices[p_device].name, 3);
  1578. String adb = get_adb_path();
  1579. // Export_temp APK.
  1580. if (ep.step("Exporting APK...", 0)) {
  1581. device_lock.unlock();
  1582. return ERR_SKIP;
  1583. }
  1584. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  1585. const bool use_reverse = devices[p_device].api_level >= 21;
  1586. if (use_reverse) {
  1587. p_debug_flags |= DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST;
  1588. }
  1589. String tmp_export_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  1590. #define CLEANUP_AND_RETURN(m_err) \
  1591. { \
  1592. DirAccess::remove_file_or_error(tmp_export_path); \
  1593. device_lock.unlock(); \
  1594. return m_err; \
  1595. }
  1596. // Export to temporary APK before sending to device.
  1597. Error err = export_project_helper(p_preset, true, tmp_export_path, EXPORT_FORMAT_APK, true, p_debug_flags);
  1598. if (err != OK) {
  1599. CLEANUP_AND_RETURN(err);
  1600. }
  1601. List<String> args;
  1602. int rv;
  1603. String output;
  1604. bool remove_prev = p_preset->get("one_click_deploy/clear_previous_install");
  1605. String version_name = p_preset->get("version/name");
  1606. String package_name = p_preset->get("package/unique_name");
  1607. if (remove_prev) {
  1608. if (ep.step("Uninstalling...", 1)) {
  1609. CLEANUP_AND_RETURN(ERR_SKIP);
  1610. }
  1611. print_line("Uninstalling previous version: " + devices[p_device].name);
  1612. args.push_back("-s");
  1613. args.push_back(devices[p_device].id);
  1614. args.push_back("uninstall");
  1615. args.push_back(get_package_name(package_name));
  1616. output.clear();
  1617. err = OS::get_singleton()->execute(adb, args, true, nullptr, &output, &rv, true);
  1618. print_verbose(output);
  1619. }
  1620. print_line("Installing to device (please wait...): " + devices[p_device].name);
  1621. if (ep.step("Installing to device, please wait...", 2)) {
  1622. CLEANUP_AND_RETURN(ERR_SKIP);
  1623. }
  1624. args.clear();
  1625. args.push_back("-s");
  1626. args.push_back(devices[p_device].id);
  1627. args.push_back("install");
  1628. args.push_back("-r");
  1629. args.push_back(tmp_export_path);
  1630. output.clear();
  1631. err = OS::get_singleton()->execute(adb, args, true, nullptr, &output, &rv, true);
  1632. print_verbose(output);
  1633. if (err || rv != 0) {
  1634. EditorNode::add_io_error("Could not install to device.");
  1635. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1636. }
  1637. if (use_remote) {
  1638. if (use_reverse) {
  1639. static const char *const msg = "--- Device API >= 21; debugging over USB ---";
  1640. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1641. print_line(String(msg).to_upper());
  1642. args.clear();
  1643. args.push_back("-s");
  1644. args.push_back(devices[p_device].id);
  1645. args.push_back("reverse");
  1646. args.push_back("--remove-all");
  1647. output.clear();
  1648. OS::get_singleton()->execute(adb, args, true, nullptr, &output, &rv, true);
  1649. print_verbose(output);
  1650. if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) {
  1651. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  1652. args.clear();
  1653. args.push_back("-s");
  1654. args.push_back(devices[p_device].id);
  1655. args.push_back("reverse");
  1656. args.push_back("tcp:" + itos(dbg_port));
  1657. args.push_back("tcp:" + itos(dbg_port));
  1658. output.clear();
  1659. OS::get_singleton()->execute(adb, args, true, nullptr, &output, &rv, true);
  1660. print_verbose(output);
  1661. print_line("Reverse result: " + itos(rv));
  1662. }
  1663. if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) {
  1664. int fs_port = EditorSettings::get_singleton()->get("filesystem/file_server/port");
  1665. args.clear();
  1666. args.push_back("-s");
  1667. args.push_back(devices[p_device].id);
  1668. args.push_back("reverse");
  1669. args.push_back("tcp:" + itos(fs_port));
  1670. args.push_back("tcp:" + itos(fs_port));
  1671. output.clear();
  1672. err = OS::get_singleton()->execute(adb, args, true, nullptr, &output, &rv, true);
  1673. print_verbose(output);
  1674. print_line("Reverse result2: " + itos(rv));
  1675. }
  1676. } else {
  1677. static const char *const msg = "--- Device API < 21; debugging over Wi-Fi ---";
  1678. EditorNode::get_singleton()->get_log()->add_message(msg, EditorLog::MSG_TYPE_EDITOR);
  1679. print_line(String(msg).to_upper());
  1680. }
  1681. }
  1682. if (ep.step("Running on device...", 3)) {
  1683. CLEANUP_AND_RETURN(ERR_SKIP);
  1684. }
  1685. args.clear();
  1686. args.push_back("-s");
  1687. args.push_back(devices[p_device].id);
  1688. args.push_back("shell");
  1689. args.push_back("am");
  1690. args.push_back("start");
  1691. if ((bool)EditorSettings::get_singleton()->get("export/android/force_system_user") && devices[p_device].api_level >= 17) { // Multi-user introduced in Android 17
  1692. args.push_back("--user");
  1693. args.push_back("0");
  1694. }
  1695. args.push_back("-a");
  1696. args.push_back("android.intent.action.MAIN");
  1697. args.push_back("-n");
  1698. args.push_back(get_package_name(package_name) + "/com.godot.game.GodotApp");
  1699. output.clear();
  1700. err = OS::get_singleton()->execute(adb, args, true, nullptr, &output, &rv, true);
  1701. print_verbose(output);
  1702. if (err || rv != 0) {
  1703. EditorNode::add_io_error("Could not execute on device.");
  1704. CLEANUP_AND_RETURN(ERR_CANT_CREATE);
  1705. }
  1706. CLEANUP_AND_RETURN(OK);
  1707. #undef CLEANUP_AND_RETURN
  1708. }
  1709. virtual Ref<Texture> get_run_icon() const {
  1710. return run_icon;
  1711. }
  1712. static String get_adb_path() {
  1713. String exe_ext = "";
  1714. if (OS::get_singleton()->get_name() == "Windows") {
  1715. exe_ext = ".exe";
  1716. }
  1717. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1718. return sdk_path.plus_file("platform-tools/adb" + exe_ext);
  1719. }
  1720. static String get_apksigner_path() {
  1721. String exe_ext = "";
  1722. if (OS::get_singleton()->get_name() == "Windows") {
  1723. exe_ext = ".bat";
  1724. }
  1725. String apksigner_command_name = "apksigner" + exe_ext;
  1726. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1727. String apksigner_path = "";
  1728. Error errn;
  1729. String build_tools_dir = sdk_path.plus_file("build-tools");
  1730. DirAccessRef da = DirAccess::open(build_tools_dir, &errn);
  1731. if (errn != OK) {
  1732. print_error("Unable to open Android 'build-tools' directory.");
  1733. return apksigner_path;
  1734. }
  1735. // There are additional versions directories we need to go through.
  1736. da->list_dir_begin();
  1737. String sub_dir = da->get_next();
  1738. while (!sub_dir.empty()) {
  1739. if (!sub_dir.begins_with(".") && da->current_is_dir()) {
  1740. // Check if the tool is here.
  1741. String tool_path = build_tools_dir.plus_file(sub_dir).plus_file(apksigner_command_name);
  1742. if (FileAccess::exists(tool_path)) {
  1743. apksigner_path = tool_path;
  1744. break;
  1745. }
  1746. }
  1747. sub_dir = da->get_next();
  1748. }
  1749. da->list_dir_end();
  1750. if (apksigner_path.empty()) {
  1751. EditorNode::get_singleton()->show_warning(TTR("Unable to find the 'apksigner' tool."));
  1752. }
  1753. return apksigner_path;
  1754. }
  1755. virtual bool can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1756. String err;
  1757. bool valid = false;
  1758. // Look for export templates (first official, and if defined custom templates).
  1759. if (!bool(p_preset->get("custom_template/use_custom_build"))) {
  1760. String template_err;
  1761. bool dvalid = false;
  1762. bool rvalid = false;
  1763. bool has_export_templates = false;
  1764. if (p_preset->get("custom_template/debug") != "") {
  1765. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1766. if (!dvalid) {
  1767. template_err += TTR("Custom debug template not found.") + "\n";
  1768. }
  1769. } else {
  1770. has_export_templates |= exists_export_template("android_debug.apk", &template_err);
  1771. }
  1772. if (p_preset->get("custom_template/release") != "") {
  1773. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1774. if (!rvalid) {
  1775. template_err += TTR("Custom release template not found.") + "\n";
  1776. }
  1777. } else {
  1778. has_export_templates |= exists_export_template("android_release.apk", &template_err);
  1779. }
  1780. r_missing_templates = !has_export_templates;
  1781. valid = dvalid || rvalid || has_export_templates;
  1782. if (!valid) {
  1783. err += template_err;
  1784. }
  1785. } else {
  1786. r_missing_templates = !exists_export_template("android_source.zip", &err);
  1787. bool installed_android_build_template = FileAccess::exists("res://android/build/build.gradle");
  1788. if (!installed_android_build_template) {
  1789. err += TTR("Android build template not installed in the project. Install it from the Project menu.") + "\n";
  1790. }
  1791. valid = installed_android_build_template && !r_missing_templates;
  1792. }
  1793. // Validate the rest of the configuration.
  1794. String dk = p_preset->get("keystore/debug");
  1795. if (!FileAccess::exists(dk)) {
  1796. dk = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  1797. if (!FileAccess::exists(dk)) {
  1798. valid = false;
  1799. err += TTR("Debug keystore not configured in the Editor Settings nor in the preset.") + "\n";
  1800. }
  1801. }
  1802. String rk = p_preset->get("keystore/release");
  1803. if (!rk.empty() && !FileAccess::exists(rk)) {
  1804. valid = false;
  1805. err += TTR("Release keystore incorrectly configured in the export preset.") + "\n";
  1806. }
  1807. String sdk_path = EditorSettings::get_singleton()->get("export/android/android_sdk_path");
  1808. if (sdk_path == "") {
  1809. err += TTR("A valid Android SDK path is required in Editor Settings.") + "\n";
  1810. valid = false;
  1811. } else {
  1812. Error errn;
  1813. // Check for the platform-tools directory.
  1814. DirAccessRef da = DirAccess::open(sdk_path.plus_file("platform-tools"), &errn);
  1815. if (errn != OK) {
  1816. err += TTR("Invalid Android SDK path in Editor Settings.");
  1817. err += TTR("Missing 'platform-tools' directory!");
  1818. err += "\n";
  1819. valid = false;
  1820. }
  1821. // Validate that adb is available
  1822. String adb_path = get_adb_path();
  1823. if (!FileAccess::exists(adb_path)) {
  1824. err += TTR("Unable to find Android SDK platform-tools' adb command.");
  1825. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  1826. err += "\n";
  1827. valid = false;
  1828. }
  1829. // Check for the build-tools directory.
  1830. DirAccessRef build_tools_da = DirAccess::open(sdk_path.plus_file("build-tools"), &errn);
  1831. if (errn != OK) {
  1832. err += TTR("Invalid Android SDK path in Editor Settings.");
  1833. err += TTR("Missing 'build-tools' directory!");
  1834. err += "\n";
  1835. valid = false;
  1836. }
  1837. // Validate that apksigner is available
  1838. String apksigner_path = get_apksigner_path();
  1839. if (!FileAccess::exists(apksigner_path)) {
  1840. err += TTR("Unable to find Android SDK build-tools' apksigner command.");
  1841. err += TTR("Please check in the Android SDK directory specified in Editor Settings.");
  1842. err += "\n";
  1843. valid = false;
  1844. }
  1845. }
  1846. bool apk_expansion = p_preset->get("apk_expansion/enable");
  1847. if (apk_expansion) {
  1848. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  1849. if (apk_expansion_pkey == "") {
  1850. valid = false;
  1851. err += TTR("Invalid public key for APK expansion.") + "\n";
  1852. }
  1853. }
  1854. String pn = p_preset->get("package/unique_name");
  1855. String pn_err;
  1856. if (!is_package_name_valid(get_package_name(pn), &pn_err)) {
  1857. valid = false;
  1858. err += TTR("Invalid package name:") + " " + pn_err + "\n";
  1859. }
  1860. String etc_error = test_etc2();
  1861. if (etc_error != String()) {
  1862. valid = false;
  1863. err += etc_error;
  1864. }
  1865. // The GodotPaymentV3 module was converted to the external GodotGooglePlayBilling plugin in Godot 3.2.2,
  1866. // this check helps users to notice the change to ensure that they change their settings.
  1867. String modules = ProjectSettings::get_singleton()->get("android/modules");
  1868. if (modules.find("org/godotengine/godot/GodotPaymentV3") != -1) {
  1869. bool godot_google_play_billing_enabled = p_preset->get("plugins/GodotGooglePlayBilling");
  1870. if (!godot_google_play_billing_enabled) {
  1871. valid = false;
  1872. err += TTR("Invalid \"GodotPaymentV3\" module included in the \"android/modules\" project setting (changed in Godot 3.2.2).\n"
  1873. "Replace it with the first-party \"GodotGooglePlayBilling\" plugin.\n"
  1874. "Note that the singleton was also renamed from \"GodotPayments\" to \"GodotGooglePlayBilling\".");
  1875. err += "\n";
  1876. }
  1877. }
  1878. // Ensure that `Use Custom Build` is enabled if a plugin is selected.
  1879. String enabled_plugins_names = get_plugins_names(get_enabled_plugins(p_preset));
  1880. bool custom_build_enabled = p_preset->get("custom_template/use_custom_build");
  1881. if (!enabled_plugins_names.empty() && !custom_build_enabled) {
  1882. valid = false;
  1883. err += TTR("\"Use Custom Build\" must be enabled to use the plugins.");
  1884. err += "\n";
  1885. }
  1886. // Validate the Xr features are properly populated
  1887. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  1888. int degrees_of_freedom = p_preset->get("xr_features/degrees_of_freedom");
  1889. int hand_tracking = p_preset->get("xr_features/hand_tracking");
  1890. bool focus_awareness = p_preset->get("xr_features/focus_awareness");
  1891. if (xr_mode_index != /* XRMode.OVR*/ 1) {
  1892. if (degrees_of_freedom > 0) {
  1893. valid = false;
  1894. err += TTR("\"Degrees Of Freedom\" is only valid when \"Xr Mode\" is \"Oculus Mobile VR\".");
  1895. err += "\n";
  1896. }
  1897. if (hand_tracking > 0) {
  1898. valid = false;
  1899. err += TTR("\"Hand Tracking\" is only valid when \"Xr Mode\" is \"Oculus Mobile VR\".");
  1900. err += "\n";
  1901. }
  1902. if (focus_awareness) {
  1903. valid = false;
  1904. err += TTR("\"Focus Awareness\" is only valid when \"Xr Mode\" is \"Oculus Mobile VR\".");
  1905. err += "\n";
  1906. }
  1907. }
  1908. if (int(p_preset->get("custom_template/export_format")) == EXPORT_FORMAT_AAB &&
  1909. !bool(p_preset->get("custom_template/use_custom_build"))) {
  1910. valid = false;
  1911. err += TTR("\"Export AAB\" is only valid when \"Use Custom Build\" is enabled.");
  1912. err += "\n";
  1913. }
  1914. r_error = err;
  1915. return valid;
  1916. }
  1917. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  1918. List<String> list;
  1919. list.push_back("apk");
  1920. list.push_back("aab");
  1921. return list;
  1922. }
  1923. void _update_custom_build_project() {
  1924. print_verbose("Updating custom build project..");
  1925. DirAccessRef da = DirAccess::open("res://android");
  1926. ERR_FAIL_COND_MSG(!da, "Cannot open directory 'res://android'.");
  1927. Map<String, List<String>> directory_paths;
  1928. Map<String, List<String>> manifest_sections;
  1929. Map<String, List<String>> gradle_sections;
  1930. da->list_dir_begin();
  1931. String d = da->get_next();
  1932. while (d != String()) {
  1933. if (!d.begins_with(".") && d != "build" && da->current_is_dir()) { //a dir and not the build dir
  1934. //add directories found
  1935. DirAccessRef ds = DirAccess::open(String("res://android").plus_file(d));
  1936. if (ds) {
  1937. ds->list_dir_begin();
  1938. String sd = ds->get_next();
  1939. while (sd != String()) {
  1940. if (!sd.begins_with(".") && ds->current_is_dir()) {
  1941. String key = sd.to_upper();
  1942. if (!directory_paths.has(key)) {
  1943. directory_paths[key] = List<String>();
  1944. }
  1945. String path = ProjectSettings::get_singleton()->get_resource_path().plus_file("android").plus_file(d).plus_file(sd);
  1946. directory_paths[key].push_back(path);
  1947. print_line("Add: " + sd + ":" + path);
  1948. }
  1949. sd = ds->get_next();
  1950. }
  1951. ds->list_dir_end();
  1952. }
  1953. //parse manifest
  1954. {
  1955. FileAccessRef f = FileAccess::open(String("res://android").plus_file(d).plus_file("AndroidManifest.conf"), FileAccess::READ);
  1956. if (f) {
  1957. String section;
  1958. while (!f->eof_reached()) {
  1959. String l = f->get_line();
  1960. String k = l.strip_edges();
  1961. if (k.begins_with("[")) {
  1962. section = k.substr(1, k.length() - 2).strip_edges().to_upper();
  1963. print_line("Section: " + section);
  1964. } else if (k != String()) {
  1965. if (!manifest_sections.has(section)) {
  1966. manifest_sections[section] = List<String>();
  1967. }
  1968. manifest_sections[section].push_back(l);
  1969. }
  1970. }
  1971. f->close();
  1972. }
  1973. }
  1974. //parse gradle
  1975. {
  1976. FileAccessRef f = FileAccess::open(String("res://android").plus_file(d).plus_file("gradle.conf"), FileAccess::READ);
  1977. if (f) {
  1978. String section;
  1979. while (!f->eof_reached()) {
  1980. String l = f->get_line().strip_edges();
  1981. String k = l.strip_edges();
  1982. if (k.begins_with("[")) {
  1983. section = k.substr(1, k.length() - 2).strip_edges().to_upper();
  1984. print_line("Section: " + section);
  1985. } else if (k != String()) {
  1986. if (!gradle_sections.has(section)) {
  1987. gradle_sections[section] = List<String>();
  1988. }
  1989. gradle_sections[section].push_back(l);
  1990. }
  1991. }
  1992. }
  1993. }
  1994. }
  1995. d = da->get_next();
  1996. }
  1997. da->list_dir_end();
  1998. { //fix gradle build
  1999. String new_file;
  2000. {
  2001. FileAccessRef f = FileAccess::open("res://android/build/build.gradle", FileAccess::READ);
  2002. if (f) {
  2003. while (!f->eof_reached()) {
  2004. String l = f->get_line();
  2005. bool append_line = false;
  2006. if (l.begins_with("//CHUNK_")) {
  2007. String text = l.replace_first("//CHUNK_", "");
  2008. int begin_pos = text.find("_BEGIN");
  2009. if (begin_pos != -1) {
  2010. text = text.substr(0, begin_pos);
  2011. text = text.to_upper(); //just in case
  2012. String end_marker = "//CHUNK_" + text + "_END";
  2013. uint64_t pos = f->get_position();
  2014. bool found = false;
  2015. while (!f->eof_reached()) {
  2016. l = f->get_line();
  2017. if (l.begins_with(end_marker)) {
  2018. found = true;
  2019. break;
  2020. }
  2021. }
  2022. new_file += "//CHUNK_" + text + "_BEGIN\n";
  2023. if (!found) {
  2024. ERR_PRINTS("No end marker found in build.gradle for chunk: " + text);
  2025. f->seek(pos);
  2026. } else {
  2027. //add chunk lines
  2028. if (gradle_sections.has(text)) {
  2029. for (List<String>::Element *E = gradle_sections[text].front(); E; E = E->next()) {
  2030. new_file += E->get() + "\n";
  2031. }
  2032. }
  2033. if (f->eof_reached()) {
  2034. new_file += end_marker;
  2035. } else {
  2036. new_file += end_marker + "\n";
  2037. }
  2038. }
  2039. } else {
  2040. append_line = true;
  2041. }
  2042. } else if (l.begins_with("//DIR_")) {
  2043. String text = l.replace_first("//DIR_", "");
  2044. int begin_pos = text.find("_BEGIN");
  2045. if (begin_pos != -1) {
  2046. text = text.substr(0, begin_pos);
  2047. text = text.to_upper(); //just in case
  2048. String end_marker = "//DIR_" + text + "_END";
  2049. uint64_t pos = f->get_position();
  2050. bool found = false;
  2051. while (!f->eof_reached()) {
  2052. l = f->get_line();
  2053. if (l.begins_with(end_marker)) {
  2054. found = true;
  2055. break;
  2056. }
  2057. }
  2058. new_file += "//DIR_" + text + "_BEGIN\n";
  2059. if (!found) {
  2060. ERR_PRINTS("No end marker found in build.gradle for dir: " + text);
  2061. f->seek(pos);
  2062. } else {
  2063. //add chunk lines
  2064. if (directory_paths.has(text)) {
  2065. for (List<String>::Element *E = directory_paths[text].front(); E; E = E->next()) {
  2066. new_file += ",'" + E->get().replace("'", "\'") + "'";
  2067. new_file += "\n";
  2068. }
  2069. }
  2070. if (f->eof_reached()) {
  2071. new_file += end_marker;
  2072. } else {
  2073. new_file += end_marker + "\n";
  2074. }
  2075. }
  2076. } else {
  2077. append_line = true;
  2078. }
  2079. } else {
  2080. append_line = true;
  2081. }
  2082. if (append_line) {
  2083. if (f->eof_reached()) {
  2084. new_file += l;
  2085. } else {
  2086. new_file += l + "\n";
  2087. }
  2088. }
  2089. }
  2090. }
  2091. }
  2092. FileAccessRef f = FileAccess::open("res://android/build/build.gradle", FileAccess::WRITE);
  2093. f->store_string(new_file);
  2094. f->close();
  2095. }
  2096. { //fix manifest
  2097. String new_file;
  2098. {
  2099. FileAccessRef f = FileAccess::open("res://android/build/AndroidManifest.xml", FileAccess::READ);
  2100. if (f) {
  2101. while (!f->eof_reached()) {
  2102. String l = f->get_line();
  2103. bool append_line = false;
  2104. if (l.begins_with("<!--CHUNK_")) {
  2105. String text = l.replace_first("<!--CHUNK_", "");
  2106. int begin_pos = text.find("_BEGIN-->");
  2107. if (begin_pos != -1) {
  2108. text = text.substr(0, begin_pos);
  2109. text = text.to_upper(); //just in case
  2110. String end_marker = "<!--CHUNK_" + text + "_END-->";
  2111. uint64_t pos = f->get_position();
  2112. bool found = false;
  2113. while (!f->eof_reached()) {
  2114. l = f->get_line();
  2115. if (l.begins_with(end_marker)) {
  2116. found = true;
  2117. break;
  2118. }
  2119. }
  2120. new_file += "<!--CHUNK_" + text + "_BEGIN-->\n";
  2121. if (!found) {
  2122. ERR_PRINTS("No end marker found in AndroidManifest.xml for chunk: " + text);
  2123. f->seek(pos);
  2124. } else {
  2125. //add chunk lines
  2126. if (manifest_sections.has(text)) {
  2127. for (List<String>::Element *E = manifest_sections[text].front(); E; E = E->next()) {
  2128. new_file += E->get() + "\n";
  2129. }
  2130. }
  2131. if (f->eof_reached()) {
  2132. new_file += end_marker;
  2133. } else {
  2134. new_file += end_marker + "\n";
  2135. }
  2136. }
  2137. } else {
  2138. append_line = true;
  2139. }
  2140. } else if (l.strip_edges().begins_with("<application")) {
  2141. String last_tag = "android:icon=\"@mipmap/icon\"";
  2142. int last_tag_pos = l.find(last_tag);
  2143. if (last_tag_pos == -1) {
  2144. ERR_PRINTS("Not adding application attributes as the expected tag was not found in '<application': " + last_tag);
  2145. append_line = true;
  2146. } else {
  2147. String base = l.substr(0, last_tag_pos + last_tag.length());
  2148. if (manifest_sections.has("application_attribs")) {
  2149. for (List<String>::Element *E = manifest_sections["application_attribs"].front(); E; E = E->next()) {
  2150. String to_add = E->get().strip_edges();
  2151. base += " " + to_add + " ";
  2152. }
  2153. }
  2154. base += ">\n";
  2155. new_file += base;
  2156. }
  2157. } else {
  2158. append_line = true;
  2159. }
  2160. if (append_line) {
  2161. new_file += l;
  2162. if (!f->eof_reached()) {
  2163. new_file += "\n";
  2164. }
  2165. }
  2166. }
  2167. }
  2168. }
  2169. FileAccessRef f = FileAccess::open("res://android/build/AndroidManifest.xml", FileAccess::WRITE);
  2170. f->store_string(new_file);
  2171. f->close();
  2172. }
  2173. }
  2174. inline bool is_clean_build_required(Vector<PluginConfigAndroid> enabled_plugins) {
  2175. String plugin_names = get_plugins_names(enabled_plugins);
  2176. bool first_build = last_custom_build_time == 0;
  2177. bool have_plugins_changed = false;
  2178. if (!first_build) {
  2179. have_plugins_changed = plugin_names != last_plugin_names;
  2180. if (!have_plugins_changed) {
  2181. for (int i = 0; i < enabled_plugins.size(); i++) {
  2182. if (enabled_plugins.get(i).last_updated > last_custom_build_time) {
  2183. have_plugins_changed = true;
  2184. break;
  2185. }
  2186. }
  2187. }
  2188. }
  2189. last_custom_build_time = OS::get_singleton()->get_unix_time();
  2190. last_plugin_names = plugin_names;
  2191. return have_plugins_changed || first_build;
  2192. }
  2193. String get_apk_expansion_fullpath(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  2194. int version_code = p_preset->get("version/code");
  2195. String package_name = p_preset->get("package/unique_name");
  2196. String apk_file_name = "main." + itos(version_code) + "." + get_package_name(package_name) + ".obb";
  2197. String fullpath = p_path.get_base_dir().plus_file(apk_file_name);
  2198. return fullpath;
  2199. }
  2200. Error save_apk_expansion_file(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  2201. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  2202. Error err = save_pack(p_preset, fullpath);
  2203. return err;
  2204. }
  2205. void get_command_line_flags(const Ref<EditorExportPreset> &p_preset, const String &p_path, int p_flags, Vector<uint8_t> &r_command_line_flags) {
  2206. String cmdline = p_preset->get("command_line/extra_args");
  2207. Vector<String> command_line_strings = cmdline.strip_edges().split(" ");
  2208. for (int i = 0; i < command_line_strings.size(); i++) {
  2209. if (command_line_strings[i].strip_edges().length() == 0) {
  2210. command_line_strings.remove(i);
  2211. i--;
  2212. }
  2213. }
  2214. gen_export_flags(command_line_strings, p_flags);
  2215. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2216. if (apk_expansion) {
  2217. String fullpath = get_apk_expansion_fullpath(p_preset, p_path);
  2218. String apk_expansion_public_key = p_preset->get("apk_expansion/public_key");
  2219. command_line_strings.push_back("--use_apk_expansion");
  2220. command_line_strings.push_back("--apk_expansion_md5");
  2221. command_line_strings.push_back(FileAccess::get_md5(fullpath));
  2222. command_line_strings.push_back("--apk_expansion_key");
  2223. command_line_strings.push_back(apk_expansion_public_key.strip_edges());
  2224. }
  2225. int xr_mode_index = p_preset->get("xr_features/xr_mode");
  2226. if (xr_mode_index == 1) {
  2227. command_line_strings.push_back("--xr_mode_ovr");
  2228. } else { // XRMode.REGULAR is the default.
  2229. command_line_strings.push_back("--xr_mode_regular");
  2230. }
  2231. bool use_32_bit_framebuffer = p_preset->get("graphics/32_bits_framebuffer");
  2232. if (use_32_bit_framebuffer) {
  2233. command_line_strings.push_back("--use_depth_32");
  2234. }
  2235. bool immersive = p_preset->get("screen/immersive_mode");
  2236. if (immersive) {
  2237. command_line_strings.push_back("--use_immersive");
  2238. }
  2239. bool debug_opengl = p_preset->get("graphics/opengl_debug");
  2240. if (debug_opengl) {
  2241. command_line_strings.push_back("--debug_opengl");
  2242. }
  2243. if (command_line_strings.size()) {
  2244. r_command_line_flags.resize(4);
  2245. encode_uint32(command_line_strings.size(), &r_command_line_flags.write[0]);
  2246. for (int i = 0; i < command_line_strings.size(); i++) {
  2247. print_line(itos(i) + " param: " + command_line_strings[i]);
  2248. CharString command_line_argument = command_line_strings[i].utf8();
  2249. int base = r_command_line_flags.size();
  2250. int length = command_line_argument.length();
  2251. if (length == 0) {
  2252. continue;
  2253. }
  2254. r_command_line_flags.resize(base + 4 + length);
  2255. encode_uint32(length, &r_command_line_flags.write[base]);
  2256. memcpy(&r_command_line_flags.write[base + 4], command_line_argument.ptr(), length);
  2257. }
  2258. }
  2259. }
  2260. Error sign_apk(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &export_path, EditorProgress &ep) {
  2261. int export_format = int(p_preset->get("custom_template/export_format"));
  2262. String export_label = export_format == EXPORT_FORMAT_AAB ? "AAB" : "APK";
  2263. String release_keystore = p_preset->get("keystore/release");
  2264. String release_username = p_preset->get("keystore/release_user");
  2265. String release_password = p_preset->get("keystore/release_password");
  2266. String apksigner = get_apksigner_path();
  2267. print_verbose("Starting signing of the " + export_label + " binary using " + apksigner);
  2268. if (!FileAccess::exists(apksigner)) {
  2269. EditorNode::add_io_error("'apksigner' could not be found.\nPlease check the command is available in the Android SDK build-tools directory.\nThe resulting " + export_label + " is unsigned.");
  2270. return OK;
  2271. }
  2272. String keystore;
  2273. String password;
  2274. String user;
  2275. if (p_debug) {
  2276. keystore = p_preset->get("keystore/debug");
  2277. password = p_preset->get("keystore/debug_password");
  2278. user = p_preset->get("keystore/debug_user");
  2279. if (keystore.empty()) {
  2280. keystore = EditorSettings::get_singleton()->get("export/android/debug_keystore");
  2281. password = EditorSettings::get_singleton()->get("export/android/debug_keystore_pass");
  2282. user = EditorSettings::get_singleton()->get("export/android/debug_keystore_user");
  2283. }
  2284. if (ep.step("Signing debug " + export_label + "...", 104)) {
  2285. return ERR_SKIP;
  2286. }
  2287. } else {
  2288. keystore = release_keystore;
  2289. password = release_password;
  2290. user = release_username;
  2291. if (ep.step("Signing release " + export_label + "...", 104)) {
  2292. return ERR_SKIP;
  2293. }
  2294. }
  2295. if (!FileAccess::exists(keystore)) {
  2296. EditorNode::add_io_error("Could not find keystore, unable to export.");
  2297. return ERR_FILE_CANT_OPEN;
  2298. }
  2299. String output;
  2300. List<String> args;
  2301. args.push_back("sign");
  2302. args.push_back("--verbose");
  2303. args.push_back("--ks");
  2304. args.push_back(keystore);
  2305. args.push_back("--ks-pass");
  2306. args.push_back("pass:" + password);
  2307. args.push_back("--ks-key-alias");
  2308. args.push_back(user);
  2309. args.push_back(export_path);
  2310. if (p_debug) {
  2311. // We only print verbose logs for debug builds to avoid leaking release keystore credentials.
  2312. print_verbose("Signing debug binary using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2313. }
  2314. int retval;
  2315. output.clear();
  2316. OS::get_singleton()->execute(apksigner, args, true, nullptr, &output, &retval, true);
  2317. print_verbose(output);
  2318. if (retval) {
  2319. EditorNode::add_io_error("'apksigner' returned with error #" + itos(retval));
  2320. return ERR_CANT_CREATE;
  2321. }
  2322. if (ep.step("Verifying " + export_label + "...", 105)) {
  2323. return ERR_SKIP;
  2324. }
  2325. args.clear();
  2326. args.push_back("verify");
  2327. args.push_back("--verbose");
  2328. args.push_back(export_path);
  2329. if (p_debug) {
  2330. print_verbose("Verifying signed build using: " + String("\n") + apksigner + " " + join_list(args, String(" ")));
  2331. }
  2332. output.clear();
  2333. OS::get_singleton()->execute(apksigner, args, true, nullptr, &output, &retval, true);
  2334. print_verbose(output);
  2335. if (retval) {
  2336. EditorNode::add_io_error("'apksigner' verification of " + export_label + " failed.");
  2337. return ERR_CANT_CREATE;
  2338. }
  2339. print_verbose("Successfully completed signing build.");
  2340. return OK;
  2341. }
  2342. void _clear_assets_directory() {
  2343. DirAccessRef da_res = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  2344. if (da_res->dir_exists("res://android/build/assets")) {
  2345. print_verbose("Clearing assets directory..");
  2346. DirAccessRef da_assets = DirAccess::open("res://android/build/assets");
  2347. da_assets->erase_contents_recursive();
  2348. da_res->remove("res://android/build/assets");
  2349. }
  2350. }
  2351. String join_list(List<String> parts, const String &separator) const {
  2352. String ret;
  2353. for (int i = 0; i < parts.size(); ++i) {
  2354. if (i > 0) {
  2355. ret += separator;
  2356. }
  2357. ret += parts[i];
  2358. }
  2359. return ret;
  2360. }
  2361. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) {
  2362. int export_format = int(p_preset->get("custom_template/export_format"));
  2363. bool should_sign = p_preset->get("package/signed");
  2364. return export_project_helper(p_preset, p_debug, p_path, export_format, should_sign, p_flags);
  2365. }
  2366. Error export_project_helper(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int export_format, bool should_sign, int p_flags) {
  2367. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  2368. String src_apk;
  2369. Error err;
  2370. EditorProgress ep("export", "Exporting for Android", 105, true);
  2371. bool use_custom_build = bool(p_preset->get("custom_template/use_custom_build"));
  2372. bool p_give_internet = p_flags & (DEBUG_FLAG_DUMB_CLIENT | DEBUG_FLAG_REMOTE_DEBUG);
  2373. bool apk_expansion = p_preset->get("apk_expansion/enable");
  2374. Vector<String> enabled_abis = get_enabled_abis(p_preset);
  2375. print_verbose("Exporting for Android...");
  2376. print_verbose("- debug build: " + bool_to_string(p_debug));
  2377. print_verbose("- export path: " + p_path);
  2378. print_verbose("- export format: " + itos(export_format));
  2379. print_verbose("- sign build: " + bool_to_string(should_sign));
  2380. print_verbose("- custom build enabled: " + bool_to_string(use_custom_build));
  2381. print_verbose("- apk expansion enabled: " + bool_to_string(apk_expansion));
  2382. print_verbose("- enabled abis: " + String(",").join(enabled_abis));
  2383. print_verbose("- export filter: " + itos(p_preset->get_export_filter()));
  2384. print_verbose("- include filter: " + p_preset->get_include_filter());
  2385. print_verbose("- exclude filter: " + p_preset->get_exclude_filter());
  2386. Ref<Image> splash_image;
  2387. Ref<Image> splash_bg_color_image;
  2388. String processed_splash_config_xml = load_splash_refs(splash_image, splash_bg_color_image);
  2389. Ref<Image> main_image;
  2390. Ref<Image> foreground;
  2391. Ref<Image> background;
  2392. load_icon_refs(p_preset, main_image, foreground, background);
  2393. Vector<uint8_t> command_line_flags;
  2394. // Write command line flags into the command_line_flags variable.
  2395. get_command_line_flags(p_preset, p_path, p_flags, command_line_flags);
  2396. if (export_format == EXPORT_FORMAT_AAB) {
  2397. if (!p_path.ends_with(".aab")) {
  2398. EditorNode::get_singleton()->show_warning(TTR("Invalid filename! Android App Bundle requires the *.aab extension."));
  2399. return ERR_UNCONFIGURED;
  2400. }
  2401. if (apk_expansion) {
  2402. EditorNode::get_singleton()->show_warning(TTR("APK Expansion not compatible with Android App Bundle."));
  2403. return ERR_UNCONFIGURED;
  2404. }
  2405. }
  2406. if (export_format == EXPORT_FORMAT_APK && !p_path.ends_with(".apk")) {
  2407. EditorNode::get_singleton()->show_warning(
  2408. TTR("Invalid filename! Android APK requires the *.apk extension."));
  2409. return ERR_UNCONFIGURED;
  2410. }
  2411. if (export_format > EXPORT_FORMAT_AAB || export_format < EXPORT_FORMAT_APK) {
  2412. EditorNode::add_io_error("Unsupported export format!\n");
  2413. return ERR_UNCONFIGURED; //TODO: is this the right error?
  2414. }
  2415. if (use_custom_build) {
  2416. print_verbose("Starting custom build..");
  2417. //test that installed build version is alright
  2418. {
  2419. print_verbose("Checking build version..");
  2420. FileAccessRef f = FileAccess::open("res://android/.build_version", FileAccess::READ);
  2421. if (!f) {
  2422. 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."));
  2423. return ERR_UNCONFIGURED;
  2424. }
  2425. String version = f->get_line().strip_edges();
  2426. print_verbose("- build version: " + version);
  2427. f->close();
  2428. if (version != VERSION_FULL_CONFIG) {
  2429. 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));
  2430. return ERR_UNCONFIGURED;
  2431. }
  2432. }
  2433. String sdk_path = EDITOR_GET("export/android/android_sdk_path");
  2434. ERR_FAIL_COND_V_MSG(sdk_path.empty(), ERR_UNCONFIGURED, "Android SDK path must be configured in Editor Settings at 'export/android/android_sdk_path'.");
  2435. print_verbose("Android sdk path: " + sdk_path);
  2436. // TODO: should we use "package/name" or "application/config/name"?
  2437. String project_name = get_project_name(p_preset->get("package/name"));
  2438. err = _create_project_name_strings_files(p_preset, project_name); //project name localization.
  2439. if (err != OK) {
  2440. EditorNode::add_io_error("Unable to overwrite res://android/build/res/*.xml files with project name");
  2441. }
  2442. // Copies the project icon files into the appropriate Gradle project directory.
  2443. _copy_icons_to_gradle_project(p_preset, processed_splash_config_xml, splash_image, splash_bg_color_image, main_image, foreground, background);
  2444. // Write an AndroidManifest.xml file into the Gradle project directory.
  2445. _write_tmp_manifest(p_preset, p_give_internet, p_debug);
  2446. _update_custom_build_project();
  2447. //stores all the project files inside the Gradle project directory. Also includes all ABIs
  2448. _clear_assets_directory();
  2449. if (!apk_expansion) {
  2450. print_verbose("Exporting project files..");
  2451. err = export_project_files(p_preset, rename_and_store_file_in_gradle_project, nullptr, ignore_so_file);
  2452. if (err != OK) {
  2453. EditorNode::add_io_error("Could not export project files to gradle project\n");
  2454. return err;
  2455. }
  2456. } else {
  2457. print_verbose("Saving apk expansion file..");
  2458. err = save_apk_expansion_file(p_preset, p_path);
  2459. if (err != OK) {
  2460. EditorNode::add_io_error("Could not write expansion package file!");
  2461. return err;
  2462. }
  2463. }
  2464. print_verbose("Storing command line flags..");
  2465. store_file_at_path("res://android/build/assets/_cl_", command_line_flags);
  2466. print_verbose("Updating ANDROID_HOME environment to " + sdk_path);
  2467. OS::get_singleton()->set_environment("ANDROID_HOME", sdk_path); //set and overwrite if required
  2468. String build_command;
  2469. #ifdef WINDOWS_ENABLED
  2470. build_command = "gradlew.bat";
  2471. #else
  2472. build_command = "gradlew";
  2473. #endif
  2474. String build_path = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/build");
  2475. build_command = build_path.plus_file(build_command);
  2476. String package_name = get_package_name(p_preset->get("package/unique_name"));
  2477. String version_code = itos(p_preset->get("version/code"));
  2478. String version_name = p_preset->get("version/name");
  2479. String enabled_abi_string = String("|").join(enabled_abis);
  2480. String sign_flag = should_sign ? "true" : "false";
  2481. String zipalign_flag = "true";
  2482. Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
  2483. String local_plugins_binaries = get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_LOCAL, enabled_plugins);
  2484. String remote_plugins_binaries = get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_REMOTE, enabled_plugins);
  2485. String custom_maven_repos = get_plugins_custom_maven_repos(enabled_plugins);
  2486. bool clean_build_required = is_clean_build_required(enabled_plugins);
  2487. List<String> cmdline;
  2488. if (clean_build_required) {
  2489. cmdline.push_back("clean");
  2490. }
  2491. String build_type = p_debug ? "Debug" : "Release";
  2492. if (export_format == EXPORT_FORMAT_AAB) {
  2493. String bundle_build_command = vformat("bundle%s", build_type);
  2494. cmdline.push_back(bundle_build_command);
  2495. } else if (export_format == EXPORT_FORMAT_APK) {
  2496. String apk_build_command = vformat("assemble%s", build_type);
  2497. cmdline.push_back(apk_build_command);
  2498. }
  2499. cmdline.push_back("-p"); // argument to specify the start directory.
  2500. cmdline.push_back(build_path); // start directory.
  2501. cmdline.push_back("-Pexport_package_name=" + package_name); // argument to specify the package name.
  2502. cmdline.push_back("-Pexport_version_code=" + version_code); // argument to specify the version code.
  2503. cmdline.push_back("-Pexport_version_name=" + version_name); // argument to specify the version name.
  2504. cmdline.push_back("-Pexport_enabled_abis=" + enabled_abi_string); // argument to specify enabled ABIs.
  2505. cmdline.push_back("-Pplugins_local_binaries=" + local_plugins_binaries); // argument to specify the list of plugins local dependencies.
  2506. cmdline.push_back("-Pplugins_remote_binaries=" + remote_plugins_binaries); // argument to specify the list of plugins remote dependencies.
  2507. cmdline.push_back("-Pplugins_maven_repos=" + custom_maven_repos); // argument to specify the list of custom maven repos for the plugins dependencies.
  2508. cmdline.push_back("-Pperform_zipalign=" + zipalign_flag); // argument to specify whether the build should be zipaligned.
  2509. cmdline.push_back("-Pperform_signing=" + sign_flag); // argument to specify whether the build should be signed.
  2510. cmdline.push_back("-Pgodot_editor_version=" + String(VERSION_FULL_CONFIG));
  2511. // NOTE: The release keystore is not included in the verbose logging
  2512. // to avoid accidentally leaking sensitive information when sharing verbose logs for troubleshooting.
  2513. // Any non-sensitive additions to the command line arguments must be done above this section.
  2514. // Sensitive additions must be done below the logging statement.
  2515. print_verbose("Build Android project using gradle command: " + String("\n") + build_command + " " + join_list(cmdline, String(" ")));
  2516. if (should_sign && !p_debug) {
  2517. // Pass the release keystore info as well
  2518. String release_keystore = p_preset->get("keystore/release");
  2519. String release_username = p_preset->get("keystore/release_user");
  2520. String release_password = p_preset->get("keystore/release_password");
  2521. if (!FileAccess::exists(release_keystore)) {
  2522. EditorNode::add_io_error("Could not find keystore, unable to export.");
  2523. return ERR_FILE_CANT_OPEN;
  2524. }
  2525. cmdline.push_back("-Prelease_keystore_file=" + release_keystore); // argument to specify the release keystore file.
  2526. cmdline.push_back("-Prelease_keystore_alias=" + release_username); // argument to specify the release keystore alias.
  2527. cmdline.push_back("-Prelease_keystore_password=" + release_password); // argument to specity the release keystore password.
  2528. }
  2529. int result = EditorNode::get_singleton()->execute_and_show_output(TTR("Building Android Project (gradle)"), build_command, cmdline);
  2530. if (result != 0) {
  2531. 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."));
  2532. return ERR_CANT_CREATE;
  2533. }
  2534. List<String> copy_args;
  2535. String copy_command;
  2536. if (export_format == EXPORT_FORMAT_AAB) {
  2537. copy_command = vformat("copyAndRename%sAab", build_type);
  2538. } else if (export_format == EXPORT_FORMAT_APK) {
  2539. copy_command = vformat("copyAndRename%sApk", build_type);
  2540. }
  2541. copy_args.push_back(copy_command);
  2542. copy_args.push_back("-p"); // argument to specify the start directory.
  2543. copy_args.push_back(build_path); // start directory.
  2544. String export_filename = p_path.get_file();
  2545. String export_path = p_path.get_base_dir();
  2546. if (export_path.is_rel_path()) {
  2547. export_path = OS::get_singleton()->get_resource_dir().plus_file(export_path);
  2548. }
  2549. export_path = ProjectSettings::get_singleton()->globalize_path(export_path).simplify_path();
  2550. copy_args.push_back("-Pexport_path=file:" + export_path);
  2551. copy_args.push_back("-Pexport_filename=" + export_filename);
  2552. print_verbose("Copying Android binary using gradle command: " + String("\n") + build_command + " " + join_list(copy_args, String(" ")));
  2553. int copy_result = EditorNode::get_singleton()->execute_and_show_output(TTR("Moving output"), build_command, copy_args);
  2554. if (copy_result != 0) {
  2555. EditorNode::get_singleton()->show_warning(TTR("Unable to copy and rename export file, check gradle project directory for outputs."));
  2556. return ERR_CANT_CREATE;
  2557. }
  2558. print_verbose("Successfully completed Android custom build.");
  2559. return OK;
  2560. }
  2561. // This is the start of the Legacy build system
  2562. print_verbose("Starting legacy build system..");
  2563. if (p_debug) {
  2564. src_apk = p_preset->get("custom_template/debug");
  2565. } else {
  2566. src_apk = p_preset->get("custom_template/release");
  2567. }
  2568. src_apk = src_apk.strip_edges();
  2569. if (src_apk == "") {
  2570. if (p_debug) {
  2571. src_apk = find_export_template("android_debug.apk");
  2572. } else {
  2573. src_apk = find_export_template("android_release.apk");
  2574. }
  2575. if (src_apk == "") {
  2576. EditorNode::add_io_error("Package not found: " + src_apk);
  2577. return ERR_FILE_NOT_FOUND;
  2578. }
  2579. }
  2580. if (!DirAccess::exists(p_path.get_base_dir())) {
  2581. return ERR_FILE_BAD_PATH;
  2582. }
  2583. FileAccess *src_f = nullptr;
  2584. zlib_filefunc_def io = zipio_create_io_from_file(&src_f);
  2585. if (ep.step("Creating APK...", 0)) {
  2586. return ERR_SKIP;
  2587. }
  2588. unzFile pkg = unzOpen2(src_apk.utf8().get_data(), &io);
  2589. if (!pkg) {
  2590. EditorNode::add_io_error("Could not find template APK to export:\n" + src_apk);
  2591. return ERR_FILE_NOT_FOUND;
  2592. }
  2593. int ret = unzGoToFirstFile(pkg);
  2594. zlib_filefunc_def io2 = io;
  2595. FileAccess *dst_f = nullptr;
  2596. io2.opaque = &dst_f;
  2597. String tmp_unaligned_path = EditorSettings::get_singleton()->get_cache_dir().plus_file("tmpexport-unaligned." + uitos(OS::get_singleton()->get_unix_time()) + ".apk");
  2598. #define CLEANUP_AND_RETURN(m_err) \
  2599. { \
  2600. DirAccess::remove_file_or_error(tmp_unaligned_path); \
  2601. return m_err; \
  2602. }
  2603. zipFile unaligned_apk = zipOpen2(tmp_unaligned_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2604. String cmdline = p_preset->get("command_line/extra_args");
  2605. String version_name = p_preset->get("version/name");
  2606. String package_name = p_preset->get("package/unique_name");
  2607. String apk_expansion_pkey = p_preset->get("apk_expansion/public_key");
  2608. Vector<String> invalid_abis(enabled_abis);
  2609. while (ret == UNZ_OK) {
  2610. //get filename
  2611. unz_file_info info;
  2612. char fname[16384];
  2613. ret = unzGetCurrentFileInfo(pkg, &info, fname, 16384, nullptr, 0, nullptr, 0);
  2614. bool skip = false;
  2615. String file = fname;
  2616. Vector<uint8_t> data;
  2617. data.resize(info.uncompressed_size);
  2618. //read
  2619. unzOpenCurrentFile(pkg);
  2620. unzReadCurrentFile(pkg, data.ptrw(), data.size());
  2621. unzCloseCurrentFile(pkg);
  2622. //write
  2623. if (file == "AndroidManifest.xml") {
  2624. _fix_manifest(p_preset, data, p_give_internet);
  2625. }
  2626. if (file == "resources.arsc") {
  2627. _fix_resources(p_preset, data);
  2628. }
  2629. // Process the splash image
  2630. if ((file == SPLASH_IMAGE_EXPORT_PATH || file == LEGACY_BUILD_SPLASH_IMAGE_EXPORT_PATH) && splash_image.is_valid() && !splash_image->empty()) {
  2631. _load_image_data(splash_image, data);
  2632. }
  2633. // Process the splash bg color image
  2634. if ((file == SPLASH_BG_COLOR_PATH || file == LEGACY_BUILD_SPLASH_BG_COLOR_PATH) && splash_bg_color_image.is_valid() && !splash_bg_color_image->empty()) {
  2635. _load_image_data(splash_bg_color_image, data);
  2636. }
  2637. for (int i = 0; i < icon_densities_count; ++i) {
  2638. if (main_image.is_valid() && !main_image->empty()) {
  2639. if (file == launcher_icons[i].export_path) {
  2640. _process_launcher_icons(file, main_image, launcher_icons[i].dimensions, data);
  2641. }
  2642. }
  2643. if (foreground.is_valid() && !foreground->empty()) {
  2644. if (file == launcher_adaptive_icon_foregrounds[i].export_path) {
  2645. _process_launcher_icons(file, foreground, launcher_adaptive_icon_foregrounds[i].dimensions, data);
  2646. }
  2647. }
  2648. if (background.is_valid() && !background->empty()) {
  2649. if (file == launcher_adaptive_icon_backgrounds[i].export_path) {
  2650. _process_launcher_icons(file, background, launcher_adaptive_icon_backgrounds[i].dimensions, data);
  2651. }
  2652. }
  2653. }
  2654. if (file.ends_with(".so")) {
  2655. bool enabled = false;
  2656. for (int i = 0; i < enabled_abis.size(); ++i) {
  2657. if (file.begins_with("lib/" + enabled_abis[i] + "/")) {
  2658. invalid_abis.erase(enabled_abis[i]);
  2659. enabled = true;
  2660. break;
  2661. }
  2662. }
  2663. if (!enabled) {
  2664. skip = true;
  2665. }
  2666. }
  2667. if (file.begins_with("META-INF") && should_sign) {
  2668. skip = true;
  2669. }
  2670. if (!skip) {
  2671. print_line("ADDING: " + file);
  2672. // Respect decision on compression made by AAPT for the export template
  2673. const bool uncompressed = info.compression_method == 0;
  2674. zip_fileinfo zipfi = get_zip_fileinfo();
  2675. zipOpenNewFileInZip(unaligned_apk,
  2676. file.utf8().get_data(),
  2677. &zipfi,
  2678. nullptr,
  2679. 0,
  2680. nullptr,
  2681. 0,
  2682. nullptr,
  2683. uncompressed ? 0 : Z_DEFLATED,
  2684. Z_DEFAULT_COMPRESSION);
  2685. zipWriteInFileInZip(unaligned_apk, data.ptr(), data.size());
  2686. zipCloseFileInZip(unaligned_apk);
  2687. }
  2688. ret = unzGoToNextFile(pkg);
  2689. }
  2690. if (!invalid_abis.empty()) {
  2691. String unsupported_arch = String(", ").join(invalid_abis);
  2692. EditorNode::add_io_error("Missing libraries in the export template for the selected architectures: " + unsupported_arch + ".\n" +
  2693. "Please build a template with all required libraries, or uncheck the missing architectures in the export preset.");
  2694. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2695. }
  2696. if (ep.step("Adding files...", 1)) {
  2697. CLEANUP_AND_RETURN(ERR_SKIP);
  2698. }
  2699. err = OK;
  2700. if (p_flags & DEBUG_FLAG_DUMB_CLIENT) {
  2701. APKExportData ed;
  2702. ed.ep = &ep;
  2703. ed.apk = unaligned_apk;
  2704. err = export_project_files(p_preset, ignore_apk_file, &ed, save_apk_so);
  2705. } else {
  2706. if (apk_expansion) {
  2707. err = save_apk_expansion_file(p_preset, p_path);
  2708. if (err != OK) {
  2709. EditorNode::add_io_error("Could not write expansion package file!");
  2710. return err;
  2711. }
  2712. } else {
  2713. APKExportData ed;
  2714. ed.ep = &ep;
  2715. ed.apk = unaligned_apk;
  2716. err = export_project_files(p_preset, save_apk_file, &ed, save_apk_so);
  2717. }
  2718. }
  2719. if (err != OK) {
  2720. unzClose(pkg);
  2721. EditorNode::add_io_error("Could not export project files");
  2722. CLEANUP_AND_RETURN(ERR_SKIP);
  2723. }
  2724. zip_fileinfo zipfi = get_zip_fileinfo();
  2725. zipOpenNewFileInZip(unaligned_apk,
  2726. "assets/_cl_",
  2727. &zipfi,
  2728. nullptr,
  2729. 0,
  2730. nullptr,
  2731. 0,
  2732. nullptr,
  2733. 0, // No compress (little size gain and potentially slower startup)
  2734. Z_DEFAULT_COMPRESSION);
  2735. zipWriteInFileInZip(unaligned_apk, command_line_flags.ptr(), command_line_flags.size());
  2736. zipCloseFileInZip(unaligned_apk);
  2737. zipClose(unaligned_apk, nullptr);
  2738. unzClose(pkg);
  2739. if (err != OK) {
  2740. CLEANUP_AND_RETURN(err);
  2741. }
  2742. // Let's zip-align (must be done before signing)
  2743. static const int ZIP_ALIGNMENT = 4;
  2744. // If we're not signing the apk, then the next step should be the last.
  2745. const int next_step = should_sign ? 103 : 105;
  2746. if (ep.step("Aligning APK...", next_step)) {
  2747. CLEANUP_AND_RETURN(ERR_SKIP);
  2748. }
  2749. unzFile tmp_unaligned = unzOpen2(tmp_unaligned_path.utf8().get_data(), &io);
  2750. if (!tmp_unaligned) {
  2751. EditorNode::add_io_error("Could not unzip temporary unaligned APK.");
  2752. CLEANUP_AND_RETURN(ERR_FILE_NOT_FOUND);
  2753. }
  2754. ret = unzGoToFirstFile(tmp_unaligned);
  2755. io2 = io;
  2756. dst_f = nullptr;
  2757. io2.opaque = &dst_f;
  2758. zipFile final_apk = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io2);
  2759. // Take files from the unaligned APK and write them out to the aligned one
  2760. // in raw mode, i.e. not uncompressing and recompressing, aligning them as needed,
  2761. // following what is done in https://github.com/android/platform_build/blob/master/tools/zipalign/ZipAlign.cpp
  2762. int bias = 0;
  2763. while (ret == UNZ_OK) {
  2764. unz_file_info info;
  2765. memset(&info, 0, sizeof(info));
  2766. char fname[16384];
  2767. char extra[16384];
  2768. ret = unzGetCurrentFileInfo(tmp_unaligned, &info, fname, 16384, extra, 16384 - ZIP_ALIGNMENT, nullptr, 0);
  2769. String file = fname;
  2770. Vector<uint8_t> data;
  2771. data.resize(info.compressed_size);
  2772. // read
  2773. int method, level;
  2774. unzOpenCurrentFile2(tmp_unaligned, &method, &level, 1); // raw read
  2775. long file_offset = unzGetCurrentFileZStreamPos64(tmp_unaligned);
  2776. unzReadCurrentFile(tmp_unaligned, data.ptrw(), data.size());
  2777. unzCloseCurrentFile(tmp_unaligned);
  2778. // align
  2779. int padding = 0;
  2780. if (!info.compression_method) {
  2781. // Uncompressed file => Align
  2782. long new_offset = file_offset + bias;
  2783. padding = (ZIP_ALIGNMENT - (new_offset % ZIP_ALIGNMENT)) % ZIP_ALIGNMENT;
  2784. }
  2785. memset(extra + info.size_file_extra, 0, padding);
  2786. zip_fileinfo fileinfo = get_zip_fileinfo();
  2787. zipOpenNewFileInZip2(final_apk,
  2788. file.utf8().get_data(),
  2789. &fileinfo,
  2790. extra,
  2791. info.size_file_extra + padding,
  2792. nullptr,
  2793. 0,
  2794. nullptr,
  2795. method,
  2796. level,
  2797. 1); // raw write
  2798. zipWriteInFileInZip(final_apk, data.ptr(), data.size());
  2799. zipCloseFileInZipRaw(final_apk, info.uncompressed_size, info.crc);
  2800. bias += padding;
  2801. ret = unzGoToNextFile(tmp_unaligned);
  2802. }
  2803. zipClose(final_apk, nullptr);
  2804. unzClose(tmp_unaligned);
  2805. if (should_sign) {
  2806. // Signing must be done last as any additional modifications to the
  2807. // file will invalidate the signature.
  2808. err = sign_apk(p_preset, p_debug, p_path, ep);
  2809. if (err != OK) {
  2810. CLEANUP_AND_RETURN(err);
  2811. }
  2812. }
  2813. CLEANUP_AND_RETURN(OK);
  2814. }
  2815. virtual void get_platform_features(List<String> *r_features) {
  2816. r_features->push_back("mobile");
  2817. r_features->push_back("Android");
  2818. }
  2819. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, Set<String> &p_features) {
  2820. }
  2821. EditorExportPlatformAndroid() {
  2822. Ref<Image> img = memnew(Image(_android_logo));
  2823. logo.instance();
  2824. logo->create_from_image(img);
  2825. img = Ref<Image>(memnew(Image(_android_run_icon)));
  2826. run_icon.instance();
  2827. run_icon->create_from_image(img);
  2828. devices_changed.set();
  2829. plugins_changed.set();
  2830. check_for_changes_thread.start(_check_for_changes_poll_thread, this);
  2831. }
  2832. ~EditorExportPlatformAndroid() {
  2833. quit_request.set();
  2834. check_for_changes_thread.wait_to_finish();
  2835. }
  2836. };
  2837. void register_android_exporter() {
  2838. String exe_ext;
  2839. if (OS::get_singleton()->get_name() == "Windows") {
  2840. exe_ext = "*.exe";
  2841. }
  2842. EDITOR_DEF("export/android/android_sdk_path", "");
  2843. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/android_sdk_path", PROPERTY_HINT_GLOBAL_DIR));
  2844. EDITOR_DEF("export/android/debug_keystore", "");
  2845. EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/android/debug_keystore", PROPERTY_HINT_GLOBAL_FILE, "*.keystore,*.jks"));
  2846. EDITOR_DEF("export/android/debug_keystore_user", "androiddebugkey");
  2847. EDITOR_DEF("export/android/debug_keystore_pass", "android");
  2848. EDITOR_DEF("export/android/force_system_user", false);
  2849. EDITOR_DEF("export/android/shutdown_adb_on_exit", true);
  2850. Ref<EditorExportPlatformAndroid> exporter = Ref<EditorExportPlatformAndroid>(memnew(EditorExportPlatformAndroid));
  2851. EditorExport::get_singleton()->add_export_platform(exporter);
  2852. }