export_plugin.cpp 118 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689
  1. /**************************************************************************/
  2. /* export_plugin.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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_plugin.h"
  31. #include "logo_svg.gen.h"
  32. #include "run_icon_svg.gen.h"
  33. #include "core/io/image_loader.h"
  34. #include "core/io/plist.h"
  35. #include "core/string/translation.h"
  36. #include "drivers/png/png_driver_common.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_paths.h"
  39. #include "editor/editor_string_names.h"
  40. #include "editor/export/codesign.h"
  41. #include "editor/export/lipo.h"
  42. #include "editor/export/macho.h"
  43. #include "editor/import/resource_importer_texture_settings.h"
  44. #include "editor/themes/editor_scale.h"
  45. #include "scene/resources/image_texture.h"
  46. #include "modules/modules_enabled.gen.h" // For svg and regex.
  47. #ifdef MODULE_SVG_ENABLED
  48. #include "modules/svg/image_loader_svg.h"
  49. #endif
  50. void EditorExportPlatformMacOS::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) const {
  51. r_features->push_back(p_preset->get("binary_format/architecture"));
  52. String architecture = p_preset->get("binary_format/architecture");
  53. if (architecture == "universal" || architecture == "x86_64") {
  54. r_features->push_back("s3tc");
  55. r_features->push_back("bptc");
  56. } else if (architecture == "arm64") {
  57. r_features->push_back("etc2");
  58. r_features->push_back("astc");
  59. } else {
  60. ERR_PRINT("Invalid architecture");
  61. }
  62. }
  63. String EditorExportPlatformMacOS::get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const {
  64. if (p_preset) {
  65. int dist_type = p_preset->get("export/distribution_type");
  66. bool ad_hoc = false;
  67. int codesign_tool = p_preset->get("codesign/codesign");
  68. int notary_tool = p_preset->get("notarization/notarization");
  69. switch (codesign_tool) {
  70. case 1: { // built-in ad-hoc
  71. ad_hoc = true;
  72. } break;
  73. case 2: { // "rcodesign"
  74. ad_hoc = p_preset->get_or_env("codesign/certificate_file", ENV_MAC_CODESIGN_CERT_FILE).operator String().is_empty() || p_preset->get_or_env("codesign/certificate_password", ENV_MAC_CODESIGN_CERT_FILE).operator String().is_empty();
  75. } break;
  76. #ifdef MACOS_ENABLED
  77. case 3: { // "codesign"
  78. ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-");
  79. } break;
  80. #endif
  81. default: {
  82. };
  83. }
  84. if (p_name == "application/bundle_identifier") {
  85. String identifier = p_preset->get("application/bundle_identifier");
  86. String pn_err;
  87. if (!is_package_name_valid(identifier, &pn_err)) {
  88. return TTR("Invalid bundle identifier:") + " " + pn_err;
  89. }
  90. }
  91. if (p_name == "codesign/certificate_file" || p_name == "codesign/certificate_password" || p_name == "codesign/identity") {
  92. if (dist_type == 2) {
  93. if (ad_hoc) {
  94. return TTR("App Store distribution with ad-hoc code signing is not supported.");
  95. }
  96. } else if (notary_tool > 0 && ad_hoc) {
  97. return TTR("Notarization with an ad-hoc signature is not supported.");
  98. }
  99. }
  100. if (p_name == "codesign/apple_team_id") {
  101. String team_id = p_preset->get("codesign/apple_team_id");
  102. if (team_id.is_empty()) {
  103. if (dist_type == 2) {
  104. return TTR("Apple Team ID is required for App Store distribution.");
  105. } else if (notary_tool > 0) {
  106. return TTR("Apple Team ID is required for notarization.");
  107. }
  108. }
  109. }
  110. if (p_name == "codesign/provisioning_profile" && dist_type == 2) {
  111. String pprof = p_preset->get_or_env("codesign/provisioning_profile", ENV_MAC_CODESIGN_PROFILE);
  112. if (pprof.is_empty()) {
  113. return TTR("Provisioning profile is required for App Store distribution.");
  114. }
  115. }
  116. if (p_name == "codesign/installer_identity" && dist_type == 2) {
  117. String ident = p_preset->get("codesign/installer_identity");
  118. if (ident.is_empty()) {
  119. return TTR("Installer signing identity is required for App Store distribution.");
  120. }
  121. }
  122. if (p_name == "codesign/entitlements/app_sandbox/enabled" && dist_type == 2) {
  123. bool sandbox = p_preset->get("codesign/entitlements/app_sandbox/enabled");
  124. if (!sandbox) {
  125. return TTR("App sandbox is required for App Store distribution.");
  126. }
  127. }
  128. if (p_name == "codesign/codesign") {
  129. if (dist_type == 2) {
  130. if (codesign_tool == 2 && ClassDB::class_exists("CSharpScript")) {
  131. return TTR("'rcodesign' doesn't support signing applications with embedded dynamic libraries (GDExtension or .NET).");
  132. }
  133. if (codesign_tool == 0) {
  134. return TTR("Code signing is required for App Store distribution.");
  135. }
  136. if (codesign_tool == 1) {
  137. return TTR("App Store distribution with ad-hoc code signing is not supported.");
  138. }
  139. } else if (notary_tool > 0) {
  140. if (codesign_tool == 0) {
  141. return TTR("Code signing is required for notarization.");
  142. }
  143. if (codesign_tool == 1) {
  144. return TTR("Notarization with an ad-hoc signature is not supported.");
  145. }
  146. }
  147. }
  148. if (notary_tool == 2 || notary_tool == 3) {
  149. if (p_name == "notarization/apple_id_name" || p_name == "notarization/api_uuid") {
  150. String apple_id = p_preset->get_or_env("notarization/apple_id_name", ENV_MAC_NOTARIZATION_APPLE_ID);
  151. String api_uuid = p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID);
  152. if (apple_id.is_empty() && api_uuid.is_empty()) {
  153. return TTR("Neither Apple ID name nor App Store Connect issuer ID name not specified.");
  154. }
  155. if (!apple_id.is_empty() && !api_uuid.is_empty()) {
  156. return TTR("Both Apple ID name and App Store Connect issuer ID name are specified, only one should be set at the same time.");
  157. }
  158. }
  159. if (p_name == "notarization/apple_id_password") {
  160. String apple_id = p_preset->get_or_env("notarization/apple_id_name", ENV_MAC_NOTARIZATION_APPLE_ID);
  161. String apple_pass = p_preset->get_or_env("notarization/apple_id_password", ENV_MAC_NOTARIZATION_APPLE_PASS);
  162. if (!apple_id.is_empty() && apple_pass.is_empty()) {
  163. return TTR("Apple ID password not specified.");
  164. }
  165. }
  166. if (p_name == "notarization/api_key_id") {
  167. String api_uuid = p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID);
  168. String api_key = p_preset->get_or_env("notarization/api_key_id", ENV_MAC_NOTARIZATION_KEY_ID);
  169. if (!api_uuid.is_empty() && api_key.is_empty()) {
  170. return TTR("App Store Connect API key ID not specified.");
  171. }
  172. }
  173. } else if (notary_tool == 1) {
  174. if (p_name == "notarization/api_uuid") {
  175. String api_uuid = p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID);
  176. if (api_uuid.is_empty()) {
  177. return TTR("App Store Connect issuer ID name not specified.");
  178. }
  179. }
  180. if (p_name == "notarization/api_key_id") {
  181. String api_key = p_preset->get_or_env("notarization/api_key_id", ENV_MAC_NOTARIZATION_KEY_ID);
  182. if (api_key.is_empty()) {
  183. return TTR("App Store Connect API key ID not specified.");
  184. }
  185. }
  186. }
  187. if (codesign_tool > 0) {
  188. if (p_name == "privacy/microphone_usage_description") {
  189. String discr = p_preset->get("privacy/microphone_usage_description");
  190. bool enabled = p_preset->get("codesign/entitlements/audio_input");
  191. if (enabled && discr.is_empty()) {
  192. return TTR("Microphone access is enabled, but usage description is not specified.");
  193. }
  194. }
  195. if (p_name == "privacy/camera_usage_description") {
  196. String discr = p_preset->get("privacy/camera_usage_description");
  197. bool enabled = p_preset->get("codesign/entitlements/camera");
  198. if (enabled && discr.is_empty()) {
  199. return TTR("Camera access is enabled, but usage description is not specified.");
  200. }
  201. }
  202. if (p_name == "privacy/location_usage_description") {
  203. String discr = p_preset->get("privacy/location_usage_description");
  204. bool enabled = p_preset->get("codesign/entitlements/location");
  205. if (enabled && discr.is_empty()) {
  206. return TTR("Location information access is enabled, but usage description is not specified.");
  207. }
  208. }
  209. if (p_name == "privacy/address_book_usage_description") {
  210. String discr = p_preset->get("privacy/address_book_usage_description");
  211. bool enabled = p_preset->get("codesign/entitlements/address_book");
  212. if (enabled && discr.is_empty()) {
  213. return TTR("Address book access is enabled, but usage description is not specified.");
  214. }
  215. }
  216. if (p_name == "privacy/calendar_usage_description") {
  217. String discr = p_preset->get("privacy/calendar_usage_description");
  218. bool enabled = p_preset->get("codesign/entitlements/calendars");
  219. if (enabled && discr.is_empty()) {
  220. return TTR("Calendar access is enabled, but usage description is not specified.");
  221. }
  222. }
  223. if (p_name == "privacy/photos_library_usage_description") {
  224. String discr = p_preset->get("privacy/photos_library_usage_description");
  225. bool enabled = p_preset->get("codesign/entitlements/photos_library");
  226. if (enabled && discr.is_empty()) {
  227. return TTR("Photo library access is enabled, but usage description is not specified.");
  228. }
  229. }
  230. }
  231. }
  232. return String();
  233. }
  234. bool EditorExportPlatformMacOS::get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const {
  235. // Hide irrelevant code signing options.
  236. if (p_preset) {
  237. int codesign_tool = p_preset->get("codesign/codesign");
  238. switch (codesign_tool) {
  239. case 1: { // built-in ad-hoc
  240. if (p_option == "codesign/identity" || p_option == "codesign/certificate_file" || p_option == "codesign/certificate_password" || p_option == "codesign/custom_options" || p_option == "codesign/team_id") {
  241. return false;
  242. }
  243. } break;
  244. case 2: { // "rcodesign"
  245. if (p_option == "codesign/identity") {
  246. return false;
  247. }
  248. } break;
  249. #ifdef MACOS_ENABLED
  250. case 3: { // "codesign"
  251. if (p_option == "codesign/certificate_file" || p_option == "codesign/certificate_password") {
  252. return false;
  253. }
  254. } break;
  255. #endif
  256. default: { // disabled
  257. if (p_option == "codesign/identity" || p_option == "codesign/certificate_file" || p_option == "codesign/certificate_password" || p_option == "codesign/custom_options" || p_option.begins_with("codesign/entitlements") || p_option == "codesign/team_id") {
  258. return false;
  259. }
  260. } break;
  261. }
  262. // Distribution type.
  263. int dist_type = p_preset->get("export/distribution_type");
  264. if (dist_type != 2 && p_option == "codesign/installer_identity") {
  265. return false;
  266. }
  267. if (dist_type == 2 && p_option.begins_with("notarization/")) {
  268. return false;
  269. }
  270. if (dist_type != 2 && p_option == "codesign/provisioning_profile") {
  271. return false;
  272. }
  273. String custom_prof = p_preset->get("codesign/entitlements/custom_file");
  274. if (!custom_prof.is_empty() && p_option != "codesign/entitlements/custom_file" && p_option.begins_with("codesign/entitlements/")) {
  275. return false;
  276. }
  277. // Hide sandbox entitlements.
  278. bool sandbox = p_preset->get("codesign/entitlements/app_sandbox/enabled");
  279. if (!sandbox && p_option != "codesign/entitlements/app_sandbox/enabled" && p_option.begins_with("codesign/entitlements/app_sandbox/")) {
  280. return false;
  281. }
  282. // Hide SSH options.
  283. bool ssh = p_preset->get("ssh_remote_deploy/enabled");
  284. if (!ssh && p_option != "ssh_remote_deploy/enabled" && p_option.begins_with("ssh_remote_deploy/")) {
  285. return false;
  286. }
  287. // Hide irrelevant notarization options.
  288. int notary_tool = p_preset->get("notarization/notarization");
  289. switch (notary_tool) {
  290. case 1: { // "rcodesign"
  291. if (p_option == "notarization/apple_id_name" || p_option == "notarization/apple_id_password") {
  292. return false;
  293. }
  294. } break;
  295. case 2: { // "notarytool"
  296. // All options are visible.
  297. } break;
  298. default: { // disabled
  299. if (p_option == "notarization/apple_id_name" || p_option == "notarization/apple_id_password" || p_option == "notarization/api_uuid" || p_option == "notarization/api_key" || p_option == "notarization/api_key_id") {
  300. return false;
  301. }
  302. } break;
  303. }
  304. bool advanced_options_enabled = p_preset->are_advanced_options_enabled();
  305. if (p_option.begins_with("privacy")) {
  306. return advanced_options_enabled;
  307. }
  308. }
  309. // These entitlements are required to run managed code, and are always enabled in Mono builds.
  310. if (ClassDB::class_exists("CSharpScript")) {
  311. if (p_option == "codesign/entitlements/allow_jit_code_execution" || p_option == "codesign/entitlements/allow_unsigned_executable_memory" || p_option == "codesign/entitlements/allow_dyld_environment_variables") {
  312. return false;
  313. }
  314. }
  315. // Hide unsupported .NET embedding option.
  316. if (p_option == "dotnet/embed_build_outputs") {
  317. return false;
  318. }
  319. return true;
  320. }
  321. List<String> EditorExportPlatformMacOS::get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const {
  322. List<String> list;
  323. if (p_preset.is_valid()) {
  324. int dist_type = p_preset->get("export/distribution_type");
  325. if (dist_type == 0) {
  326. #ifdef MACOS_ENABLED
  327. list.push_back("dmg");
  328. #endif
  329. list.push_back("zip");
  330. #ifndef WINDOWS_ENABLED
  331. list.push_back("app");
  332. #endif
  333. } else if (dist_type == 1) {
  334. #ifdef MACOS_ENABLED
  335. list.push_back("dmg");
  336. #endif
  337. list.push_back("zip");
  338. #ifndef WINDOWS_ENABLED
  339. list.push_back("app");
  340. #endif
  341. } else if (dist_type == 2) {
  342. #ifdef MACOS_ENABLED
  343. list.push_back("pkg");
  344. #endif
  345. }
  346. }
  347. return list;
  348. }
  349. struct DataCollectionInfo {
  350. String prop_name;
  351. String type_name;
  352. };
  353. static const DataCollectionInfo data_collect_type_info[] = {
  354. { "name", "NSPrivacyCollectedDataTypeName" },
  355. { "email_address", "NSPrivacyCollectedDataTypeEmailAddress" },
  356. { "phone_number", "NSPrivacyCollectedDataTypePhoneNumber" },
  357. { "physical_address", "NSPrivacyCollectedDataTypePhysicalAddress" },
  358. { "other_contact_info", "NSPrivacyCollectedDataTypeOtherUserContactInfo" },
  359. { "health", "NSPrivacyCollectedDataTypeHealth" },
  360. { "fitness", "NSPrivacyCollectedDataTypeFitness" },
  361. { "payment_info", "NSPrivacyCollectedDataTypePaymentInfo" },
  362. { "credit_info", "NSPrivacyCollectedDataTypeCreditInfo" },
  363. { "other_financial_info", "NSPrivacyCollectedDataTypeOtherFinancialInfo" },
  364. { "precise_location", "NSPrivacyCollectedDataTypePreciseLocation" },
  365. { "coarse_location", "NSPrivacyCollectedDataTypeCoarseLocation" },
  366. { "sensitive_info", "NSPrivacyCollectedDataTypeSensitiveInfo" },
  367. { "contacts", "NSPrivacyCollectedDataTypeContacts" },
  368. { "emails_or_text_messages", "NSPrivacyCollectedDataTypeEmailsOrTextMessages" },
  369. { "photos_or_videos", "NSPrivacyCollectedDataTypePhotosorVideos" },
  370. { "audio_data", "NSPrivacyCollectedDataTypeAudioData" },
  371. { "gameplay_content", "NSPrivacyCollectedDataTypeGameplayContent" },
  372. { "customer_support", "NSPrivacyCollectedDataTypeCustomerSupport" },
  373. { "other_user_content", "NSPrivacyCollectedDataTypeOtherUserContent" },
  374. { "browsing_history", "NSPrivacyCollectedDataTypeBrowsingHistory" },
  375. { "search_hhistory", "NSPrivacyCollectedDataTypeSearchHistory" },
  376. { "user_id", "NSPrivacyCollectedDataTypeUserID" },
  377. { "device_id", "NSPrivacyCollectedDataTypeDeviceID" },
  378. { "purchase_history", "NSPrivacyCollectedDataTypePurchaseHistory" },
  379. { "product_interaction", "NSPrivacyCollectedDataTypeProductInteraction" },
  380. { "advertising_data", "NSPrivacyCollectedDataTypeAdvertisingData" },
  381. { "other_usage_data", "NSPrivacyCollectedDataTypeOtherUsageData" },
  382. { "crash_data", "NSPrivacyCollectedDataTypeCrashData" },
  383. { "performance_data", "NSPrivacyCollectedDataTypePerformanceData" },
  384. { "other_diagnostic_data", "NSPrivacyCollectedDataTypeOtherDiagnosticData" },
  385. { "environment_scanning", "NSPrivacyCollectedDataTypeEnvironmentScanning" },
  386. { "hands", "NSPrivacyCollectedDataTypeHands" },
  387. { "head", "NSPrivacyCollectedDataTypeHead" },
  388. { "other_data_types", "NSPrivacyCollectedDataTypeOtherDataTypes" },
  389. };
  390. static const DataCollectionInfo data_collect_purpose_info[] = {
  391. { "Analytics", "NSPrivacyCollectedDataTypePurposeAnalytics" },
  392. { "App Functionality", "NSPrivacyCollectedDataTypePurposeAppFunctionality" },
  393. { "Developer Advertising", "NSPrivacyCollectedDataTypePurposeDeveloperAdvertising" },
  394. { "Third-party Advertising", "NSPrivacyCollectedDataTypePurposeThirdPartyAdvertising" },
  395. { "Product Personalization", "NSPrivacyCollectedDataTypePurposeProductPersonalization" },
  396. { "Other", "NSPrivacyCollectedDataTypePurposeOther" },
  397. };
  398. void EditorExportPlatformMacOS::get_export_options(List<ExportOption> *r_options) const {
  399. #ifdef MACOS_ENABLED
  400. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "export/distribution_type", PROPERTY_HINT_ENUM, "Testing,Distribution,App Store"), 1, true));
  401. #else
  402. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "export/distribution_type", PROPERTY_HINT_ENUM, "Testing,Distribution"), 1, true));
  403. #endif
  404. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "binary_format/architecture", PROPERTY_HINT_ENUM, "universal,x86_64,arm64", PROPERTY_USAGE_STORAGE), "universal"));
  405. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  406. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  407. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "debug/export_console_wrapper", PROPERTY_HINT_ENUM, "No,Debug Only,Debug and Release"), 1));
  408. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/icon", PROPERTY_HINT_FILE, "*.icns,*.png,*.webp,*.svg"), ""));
  409. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/icon_interpolation", PROPERTY_HINT_ENUM, "Nearest neighbor,Bilinear,Cubic,Trilinear,Lanczos"), 4));
  410. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/bundle_identifier", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.game"), "", false, true));
  411. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/signature"), ""));
  412. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/app_category", PROPERTY_HINT_ENUM, "Business,Developer-tools,Education,Entertainment,Finance,Games,Action-games,Adventure-games,Arcade-games,Board-games,Card-games,Casino-games,Dice-games,Educational-games,Family-games,Kids-games,Music-games,Puzzle-games,Racing-games,Role-playing-games,Simulation-games,Sports-games,Strategy-games,Trivia-games,Word-games,Graphics-design,Healthcare-fitness,Lifestyle,Medical,Music,News,Photography,Productivity,Reference,Social-networking,Sports,Travel,Utilities,Video,Weather"), "Games"));
  413. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/short_version", PROPERTY_HINT_PLACEHOLDER_TEXT, "Leave empty to use project version"), ""));
  414. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/version", PROPERTY_HINT_PLACEHOLDER_TEXT, "Leave empty to use project version"), ""));
  415. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/copyright"), ""));
  416. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "application/copyright_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  417. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/min_macos_version"), "10.12"));
  418. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/export_angle", PROPERTY_HINT_ENUM, "Auto,Yes,No"), 0, true));
  419. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "display/high_res"), true));
  420. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/additional_plist_content", PROPERTY_HINT_MULTILINE_TEXT), ""));
  421. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/platform_build"), "14C18"));
  422. // TODO(sgc): Need to set appropriate version when using Metal
  423. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/sdk_version"), "13.1"));
  424. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/sdk_build"), "22C55"));
  425. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/sdk_name"), "macosx13.1"));
  426. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/xcode_version"), "1420"));
  427. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/xcode_build"), "14C18"));
  428. #ifdef MACOS_ENABLED
  429. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/codesign", PROPERTY_HINT_ENUM, "Disabled,Built-in (ad-hoc only),rcodesign,Xcode codesign"), 3, true));
  430. #else
  431. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/codesign", PROPERTY_HINT_ENUM, "Disabled,Built-in (ad-hoc only),rcodesign"), 1, true, true));
  432. #endif
  433. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/installer_identity", PROPERTY_HINT_PLACEHOLDER_TEXT, "3rd Party Mac Developer Installer: (ID)"), "", false, true));
  434. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/apple_team_id", PROPERTY_HINT_PLACEHOLDER_TEXT, "ID"), "", false, true));
  435. // "codesign" only options:
  436. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/identity", PROPERTY_HINT_PLACEHOLDER_TEXT, "Type: Name (ID)"), ""));
  437. // "rcodesign" only options:
  438. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/certificate_file", PROPERTY_HINT_GLOBAL_FILE, "*.pfx,*.p12", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  439. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/certificate_password", PROPERTY_HINT_PASSWORD, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), ""));
  440. // "codesign" and "rcodesign" only options:
  441. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/provisioning_profile", PROPERTY_HINT_GLOBAL_FILE, "*.provisionprofile", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "", false, true));
  442. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/entitlements/custom_file", PROPERTY_HINT_GLOBAL_FILE, "*.plist"), "", true));
  443. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_jit_code_execution"), false));
  444. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_unsigned_executable_memory"), false));
  445. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_dyld_environment_variables"), false));
  446. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/disable_library_validation"), false));
  447. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/audio_input"), false));
  448. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/camera"), false));
  449. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/location"), false));
  450. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/address_book"), false));
  451. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/calendars"), false));
  452. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/photos_library"), false));
  453. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/apple_events"), false));
  454. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/debugging"), false));
  455. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/enabled"), false, true, true));
  456. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/network_server"), false));
  457. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/network_client"), false));
  458. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/device_usb"), false));
  459. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/device_bluetooth"), false));
  460. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_downloads", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  461. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_pictures", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  462. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_music", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  463. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_movies", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  464. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_user_selected", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0));
  465. r_options->push_back(ExportOption(PropertyInfo(Variant::ARRAY, "codesign/entitlements/app_sandbox/helper_executables", PROPERTY_HINT_ARRAY_TYPE, itos(Variant::STRING) + "/" + itos(PROPERTY_HINT_GLOBAL_FILE) + ":"), Array()));
  466. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "codesign/custom_options"), PackedStringArray()));
  467. #ifdef MACOS_ENABLED
  468. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "notarization/notarization", PROPERTY_HINT_ENUM, "Disabled,rcodesign,Xcode notarytool"), 0, true));
  469. #else
  470. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "notarization/notarization", PROPERTY_HINT_ENUM, "Disabled,rcodesign"), 0, true));
  471. #endif
  472. // "notarytool" only options:
  473. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_id_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Apple ID email", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "", false, true));
  474. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_id_password", PROPERTY_HINT_PASSWORD, "Enable two-factor authentication and provide app-specific password", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "", false, true));
  475. // "notarytool" and "rcodesign" only options:
  476. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/api_uuid", PROPERTY_HINT_PLACEHOLDER_TEXT, "App Store Connect issuer ID UUID", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "", false, true));
  477. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/api_key", PROPERTY_HINT_GLOBAL_FILE, "*.p8", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "", false, true));
  478. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/api_key_id", PROPERTY_HINT_PLACEHOLDER_TEXT, "App Store Connect API key ID", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "", false, true));
  479. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/microphone_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the microphone"), "", false, true));
  480. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/microphone_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  481. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/camera_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the camera"), "", false, true));
  482. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/camera_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  483. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/location_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the location information"), "", false, true));
  484. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/location_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  485. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/address_book_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the address book"), "", false, true));
  486. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/address_book_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  487. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/calendar_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the calendar"), "", false, true));
  488. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/calendar_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  489. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/photos_library_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the photo library"), "", false, true));
  490. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/photos_library_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  491. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/desktop_folder_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use Desktop folder"), "", false, true));
  492. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/desktop_folder_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  493. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/documents_folder_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use Documents folder"), "", false, true));
  494. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/documents_folder_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  495. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/downloads_folder_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use Downloads folder"), "", false, true));
  496. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/downloads_folder_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  497. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/network_volumes_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use network volumes"), "", false, true));
  498. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/network_volumes_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  499. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/removable_volumes_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use removable volumes"), "", false, true));
  500. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/removable_volumes_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  501. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "privacy/tracking_enabled"), false));
  502. r_options->push_back(ExportOption(PropertyInfo(Variant::PACKED_STRING_ARRAY, "privacy/tracking_domains"), Vector<String>()));
  503. {
  504. String hint;
  505. for (uint64_t i = 0; i < sizeof(data_collect_purpose_info) / sizeof(data_collect_purpose_info[0]); ++i) {
  506. if (i != 0) {
  507. hint += ",";
  508. }
  509. hint += vformat("%s:%d", data_collect_purpose_info[i].prop_name, (1 << i));
  510. }
  511. for (uint64_t i = 0; i < sizeof(data_collect_type_info) / sizeof(data_collect_type_info[0]); ++i) {
  512. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("privacy/collected_data/%s/collected", data_collect_type_info[i].prop_name)), false));
  513. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("privacy/collected_data/%s/linked_to_user", data_collect_type_info[i].prop_name)), false));
  514. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("privacy/collected_data/%s/used_for_tracking", data_collect_type_info[i].prop_name)), false));
  515. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, vformat("privacy/collected_data/%s/collection_purposes", data_collect_type_info[i].prop_name), PROPERTY_HINT_FLAGS, hint), 0));
  516. }
  517. }
  518. String run_script = "#!/usr/bin/env bash\n"
  519. "unzip -o -q \"{temp_dir}/{archive_name}\" -d \"{temp_dir}\"\n"
  520. "open \"{temp_dir}/{exe_name}.app\" --args {cmd_args}";
  521. String cleanup_script = "#!/usr/bin/env bash\n"
  522. "kill $(pgrep -x -f \"{temp_dir}/{exe_name}.app/Contents/MacOS/{exe_name} {cmd_args}\")\n"
  523. "rm -rf \"{temp_dir}\"";
  524. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "ssh_remote_deploy/enabled"), false, true));
  525. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/host"), "user@host_ip"));
  526. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/port"), "22"));
  527. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/extra_args_ssh", PROPERTY_HINT_MULTILINE_TEXT), ""));
  528. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/extra_args_scp", PROPERTY_HINT_MULTILINE_TEXT), ""));
  529. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/run_script", PROPERTY_HINT_MULTILINE_TEXT), run_script));
  530. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "ssh_remote_deploy/cleanup_script", PROPERTY_HINT_MULTILINE_TEXT), cleanup_script));
  531. }
  532. void _rgba8_to_packbits_encode(int p_ch, int p_size, Vector<uint8_t> &p_source, Vector<uint8_t> &p_dest) {
  533. int src_len = p_size * p_size;
  534. Vector<uint8_t> result;
  535. int i = 0;
  536. const uint8_t *src = p_source.ptr();
  537. while (i < src_len) {
  538. Vector<uint8_t> seq;
  539. uint8_t count = 0;
  540. while (count <= 0x7f && i < src_len) {
  541. if (i + 2 < src_len && src[i * 4 + p_ch] == src[(i + 1) * 4 + p_ch] && src[i] == src[(i + 2) * 4 + p_ch]) {
  542. break;
  543. }
  544. seq.push_back(src[i * 4 + p_ch]);
  545. i++;
  546. count++;
  547. }
  548. if (!seq.is_empty()) {
  549. result.push_back(count - 1);
  550. result.append_array(seq);
  551. }
  552. if (i >= src_len) {
  553. break;
  554. }
  555. uint8_t rep = src[i * 4 + p_ch];
  556. count = 0;
  557. while (count <= 0x7f && i < src_len && src[i * 4 + p_ch] == rep) {
  558. i++;
  559. count++;
  560. }
  561. if (count >= 3) {
  562. result.push_back(0x80 + count - 3);
  563. result.push_back(rep);
  564. } else {
  565. result.push_back(count - 1);
  566. for (int j = 0; j < count; j++) {
  567. result.push_back(rep);
  568. }
  569. }
  570. }
  571. int ofs = p_dest.size();
  572. p_dest.resize(p_dest.size() + result.size());
  573. memcpy(&p_dest.write[ofs], result.ptr(), result.size());
  574. }
  575. void EditorExportPlatformMacOS::_make_icon(const Ref<EditorExportPreset> &p_preset, const Ref<Image> &p_icon, Vector<uint8_t> &p_data) {
  576. Vector<uint8_t> data;
  577. data.resize(8);
  578. data.write[0] = 'i';
  579. data.write[1] = 'c';
  580. data.write[2] = 'n';
  581. data.write[3] = 's';
  582. struct MacOSIconInfo {
  583. const char *name;
  584. const char *mask_name;
  585. bool is_png;
  586. int size;
  587. };
  588. static const MacOSIconInfo icon_infos[] = {
  589. { "ic10", "", true, 1024 }, //1024×1024 32-bit PNG and 512×512@2x 32-bit "retina" PNG
  590. { "ic09", "", true, 512 }, //512×512 32-bit PNG
  591. { "ic14", "", true, 512 }, //256×256@2x 32-bit "retina" PNG
  592. { "ic08", "", true, 256 }, //256×256 32-bit PNG
  593. { "ic13", "", true, 256 }, //128×128@2x 32-bit "retina" PNG
  594. { "ic07", "", true, 128 }, //128×128 32-bit PNG
  595. { "ic12", "", true, 64 }, //32×32@2× 32-bit "retina" PNG
  596. { "ic11", "", true, 32 }, //16×16@2× 32-bit "retina" PNG
  597. { "il32", "l8mk", false, 32 }, //32×32 24-bit RLE + 8-bit uncompressed mask
  598. { "is32", "s8mk", false, 16 } //16×16 24-bit RLE + 8-bit uncompressed mask
  599. };
  600. for (uint64_t i = 0; i < (sizeof(icon_infos) / sizeof(icon_infos[0])); ++i) {
  601. Ref<Image> copy = p_icon->duplicate();
  602. copy->convert(Image::FORMAT_RGBA8);
  603. copy->resize(icon_infos[i].size, icon_infos[i].size, (Image::Interpolation)(p_preset->get("application/icon_interpolation").operator int()));
  604. if (icon_infos[i].is_png) {
  605. // Encode PNG icon.
  606. Vector<uint8_t> png_buffer;
  607. Error err = PNGDriverCommon::image_to_png(copy, png_buffer);
  608. if (err == OK) {
  609. int ofs = data.size();
  610. uint64_t len = png_buffer.size();
  611. data.resize(data.size() + len + 8);
  612. memcpy(&data.write[ofs + 8], png_buffer.ptr(), len);
  613. len += 8;
  614. len = BSWAP32(len);
  615. memcpy(&data.write[ofs], icon_infos[i].name, 4);
  616. encode_uint32(len, &data.write[ofs + 4]);
  617. }
  618. } else {
  619. Vector<uint8_t> src_data = copy->get_data();
  620. // Encode 24-bit RGB RLE icon.
  621. {
  622. int ofs = data.size();
  623. data.resize(data.size() + 8);
  624. _rgba8_to_packbits_encode(0, icon_infos[i].size, src_data, data); // Encode R.
  625. _rgba8_to_packbits_encode(1, icon_infos[i].size, src_data, data); // Encode G.
  626. _rgba8_to_packbits_encode(2, icon_infos[i].size, src_data, data); // Encode B.
  627. // Note: workaround for macOS icon decoder bug corrupting last RLE encoded value.
  628. data.push_back(0x00);
  629. int len = data.size() - ofs;
  630. len = BSWAP32(len);
  631. memcpy(&data.write[ofs], icon_infos[i].name, 4);
  632. encode_uint32(len, &data.write[ofs + 4]);
  633. }
  634. // Encode 8-bit mask uncompressed icon.
  635. {
  636. int ofs = data.size();
  637. int len = copy->get_width() * copy->get_height();
  638. data.resize(data.size() + len + 8);
  639. for (int j = 0; j < len; j++) {
  640. data.write[ofs + 8 + j] = src_data.ptr()[j * 4 + 3];
  641. }
  642. len += 8;
  643. len = BSWAP32(len);
  644. memcpy(&data.write[ofs], icon_infos[i].mask_name, 4);
  645. encode_uint32(len, &data.write[ofs + 4]);
  646. }
  647. }
  648. }
  649. uint32_t total_len = data.size();
  650. total_len = BSWAP32(total_len);
  651. encode_uint32(total_len, &data.write[4]);
  652. p_data = data;
  653. }
  654. void EditorExportPlatformMacOS::_fix_privacy_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &plist) {
  655. String str;
  656. String strnew;
  657. str.parse_utf8((const char *)plist.ptr(), plist.size());
  658. Vector<String> lines = str.split("\n");
  659. for (int i = 0; i < lines.size(); i++) {
  660. if (lines[i].find("$priv_collection") != -1) {
  661. bool section_opened = false;
  662. for (uint64_t j = 0; j < sizeof(data_collect_type_info) / sizeof(data_collect_type_info[0]); ++j) {
  663. bool data_collected = p_preset->get(vformat("privacy/collected_data/%s/collected", data_collect_type_info[j].prop_name));
  664. bool linked = p_preset->get(vformat("privacy/collected_data/%s/linked_to_user", data_collect_type_info[j].prop_name));
  665. bool tracking = p_preset->get(vformat("privacy/collected_data/%s/used_for_tracking", data_collect_type_info[j].prop_name));
  666. int purposes = p_preset->get(vformat("privacy/collected_data/%s/collection_purposes", data_collect_type_info[j].prop_name));
  667. if (data_collected) {
  668. if (!section_opened) {
  669. section_opened = true;
  670. strnew += "\t<key>NSPrivacyCollectedDataTypes</key>\n";
  671. strnew += "\t<array>\n";
  672. }
  673. strnew += "\t\t<dict>\n";
  674. strnew += "\t\t\t<key>NSPrivacyCollectedDataType</key>\n";
  675. strnew += vformat("\t\t\t<string>%s</string>\n", data_collect_type_info[j].type_name);
  676. strnew += "\t\t\t\t<key>NSPrivacyCollectedDataTypeLinked</key>\n";
  677. if (linked) {
  678. strnew += "\t\t\t\t<true/>\n";
  679. } else {
  680. strnew += "\t\t\t\t<false/>\n";
  681. }
  682. strnew += "\t\t\t\t<key>NSPrivacyCollectedDataTypeTracking</key>\n";
  683. if (tracking) {
  684. strnew += "\t\t\t\t<true/>\n";
  685. } else {
  686. strnew += "\t\t\t\t<false/>\n";
  687. }
  688. if (purposes != 0) {
  689. strnew += "\t\t\t\t<key>NSPrivacyCollectedDataTypePurposes</key>\n";
  690. strnew += "\t\t\t\t<array>\n";
  691. for (uint64_t k = 0; k < sizeof(data_collect_purpose_info) / sizeof(data_collect_purpose_info[0]); ++k) {
  692. if (purposes & (1 << k)) {
  693. strnew += vformat("\t\t\t\t\t<string>%s</string>\n", data_collect_purpose_info[k].type_name);
  694. }
  695. }
  696. strnew += "\t\t\t\t</array>\n";
  697. }
  698. strnew += "\t\t\t</dict>\n";
  699. }
  700. }
  701. if (section_opened) {
  702. strnew += "\t</array>\n";
  703. }
  704. } else if (lines[i].find("$priv_tracking") != -1) {
  705. bool tracking = p_preset->get("privacy/tracking_enabled");
  706. strnew += "\t<key>NSPrivacyTracking</key>\n";
  707. if (tracking) {
  708. strnew += "\t<true/>\n";
  709. } else {
  710. strnew += "\t<false/>\n";
  711. }
  712. Vector<String> tracking_domains = p_preset->get("privacy/tracking_domains");
  713. if (!tracking_domains.is_empty()) {
  714. strnew += "\t<key>NSPrivacyTrackingDomains</key>\n";
  715. strnew += "\t<array>\n";
  716. for (const String &E : tracking_domains) {
  717. strnew += "\t\t<string>" + E + "</string>\n";
  718. }
  719. strnew += "\t</array>\n";
  720. }
  721. } else {
  722. strnew += lines[i] + "\n";
  723. }
  724. }
  725. CharString cs = strnew.utf8();
  726. plist.resize(cs.size() - 1);
  727. for (int i = 0; i < cs.size() - 1; i++) {
  728. plist.write[i] = cs[i];
  729. }
  730. }
  731. void EditorExportPlatformMacOS::_fix_plist(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &plist, const String &p_binary) {
  732. String str;
  733. String strnew;
  734. str.parse_utf8((const char *)plist.ptr(), plist.size());
  735. Vector<String> lines = str.split("\n");
  736. for (int i = 0; i < lines.size(); i++) {
  737. if (lines[i].contains("$binary")) {
  738. strnew += lines[i].replace("$binary", p_binary) + "\n";
  739. } else if (lines[i].contains("$name")) {
  740. strnew += lines[i].replace("$name", GLOBAL_GET("application/config/name")) + "\n";
  741. } else if (lines[i].contains("$bundle_identifier")) {
  742. strnew += lines[i].replace("$bundle_identifier", p_preset->get("application/bundle_identifier")) + "\n";
  743. } else if (lines[i].contains("$short_version")) {
  744. strnew += lines[i].replace("$short_version", p_preset->get_version("application/short_version")) + "\n";
  745. } else if (lines[i].contains("$version")) {
  746. strnew += lines[i].replace("$version", p_preset->get_version("application/version")) + "\n";
  747. } else if (lines[i].contains("$signature")) {
  748. strnew += lines[i].replace("$signature", p_preset->get("application/signature")) + "\n";
  749. } else if (lines[i].contains("$app_category")) {
  750. String cat = p_preset->get("application/app_category");
  751. strnew += lines[i].replace("$app_category", cat.to_lower()) + "\n";
  752. } else if (lines[i].contains("$copyright")) {
  753. strnew += lines[i].replace("$copyright", p_preset->get("application/copyright")) + "\n";
  754. } else if (lines[i].contains("$min_version")) {
  755. strnew += lines[i].replace("$min_version", p_preset->get("application/min_macos_version")) + "\n";
  756. } else if (lines[i].contains("$highres")) {
  757. strnew += lines[i].replace("$highres", p_preset->get("display/high_res") ? "\t<true/>" : "\t<false/>") + "\n";
  758. } else if (lines[i].contains("$additional_plist_content")) {
  759. strnew += lines[i].replace("$additional_plist_content", p_preset->get("application/additional_plist_content")) + "\n";
  760. } else if (lines[i].contains("$platfbuild")) {
  761. strnew += lines[i].replace("$platfbuild", p_preset->get("xcode/platform_build")) + "\n";
  762. } else if (lines[i].contains("$sdkver")) {
  763. strnew += lines[i].replace("$sdkver", p_preset->get("xcode/sdk_version")) + "\n";
  764. } else if (lines[i].contains("$sdkname")) {
  765. strnew += lines[i].replace("$sdkname", p_preset->get("xcode/sdk_name")) + "\n";
  766. } else if (lines[i].contains("$sdkbuild")) {
  767. strnew += lines[i].replace("$sdkbuild", p_preset->get("xcode/sdk_build")) + "\n";
  768. } else if (lines[i].contains("$xcodever")) {
  769. strnew += lines[i].replace("$xcodever", p_preset->get("xcode/xcode_version")) + "\n";
  770. } else if (lines[i].contains("$xcodebuild")) {
  771. strnew += lines[i].replace("$xcodebuild", p_preset->get("xcode/xcode_build")) + "\n";
  772. } else if (lines[i].contains("$usage_descriptions")) {
  773. String descriptions;
  774. if (!((String)p_preset->get("privacy/microphone_usage_description")).is_empty()) {
  775. descriptions += "\t<key>NSMicrophoneUsageDescription</key>\n";
  776. descriptions += "\t<string>" + (String)p_preset->get("privacy/microphone_usage_description") + "</string>\n";
  777. }
  778. if (!((String)p_preset->get("privacy/camera_usage_description")).is_empty()) {
  779. descriptions += "\t<key>NSCameraUsageDescription</key>\n";
  780. descriptions += "\t<string>" + (String)p_preset->get("privacy/camera_usage_description") + "</string>\n";
  781. }
  782. if (!((String)p_preset->get("privacy/location_usage_description")).is_empty()) {
  783. descriptions += "\t<key>NSLocationUsageDescription</key>\n";
  784. descriptions += "\t<string>" + (String)p_preset->get("privacy/location_usage_description") + "</string>\n";
  785. }
  786. if (!((String)p_preset->get("privacy/address_book_usage_description")).is_empty()) {
  787. descriptions += "\t<key>NSContactsUsageDescription</key>\n";
  788. descriptions += "\t<string>" + (String)p_preset->get("privacy/address_book_usage_description") + "</string>\n";
  789. }
  790. if (!((String)p_preset->get("privacy/calendar_usage_description")).is_empty()) {
  791. descriptions += "\t<key>NSCalendarsUsageDescription</key>\n";
  792. descriptions += "\t<string>" + (String)p_preset->get("privacy/calendar_usage_description") + "</string>\n";
  793. }
  794. if (!((String)p_preset->get("privacy/photos_library_usage_description")).is_empty()) {
  795. descriptions += "\t<key>NSPhotoLibraryUsageDescription</key>\n";
  796. descriptions += "\t<string>" + (String)p_preset->get("privacy/photos_library_usage_description") + "</string>\n";
  797. }
  798. if (!((String)p_preset->get("privacy/desktop_folder_usage_description")).is_empty()) {
  799. descriptions += "\t<key>NSDesktopFolderUsageDescription</key>\n";
  800. descriptions += "\t<string>" + (String)p_preset->get("privacy/desktop_folder_usage_description") + "</string>\n";
  801. }
  802. if (!((String)p_preset->get("privacy/documents_folder_usage_description")).is_empty()) {
  803. descriptions += "\t<key>NSDocumentsFolderUsageDescription</key>\n";
  804. descriptions += "\t<string>" + (String)p_preset->get("privacy/documents_folder_usage_description") + "</string>\n";
  805. }
  806. if (!((String)p_preset->get("privacy/downloads_folder_usage_description")).is_empty()) {
  807. descriptions += "\t<key>NSDownloadsFolderUsageDescription</key>\n";
  808. descriptions += "\t<string>" + (String)p_preset->get("privacy/downloads_folder_usage_description") + "</string>\n";
  809. }
  810. if (!((String)p_preset->get("privacy/network_volumes_usage_description")).is_empty()) {
  811. descriptions += "\t<key>NSNetworkVolumesUsageDescription</key>\n";
  812. descriptions += "\t<string>" + (String)p_preset->get("privacy/network_volumes_usage_description") + "</string>\n";
  813. }
  814. if (!((String)p_preset->get("privacy/removable_volumes_usage_description")).is_empty()) {
  815. descriptions += "\t<key>NSRemovableVolumesUsageDescription</key>\n";
  816. descriptions += "\t<string>" + (String)p_preset->get("privacy/removable_volumes_usage_description") + "</string>\n";
  817. }
  818. if (!descriptions.is_empty()) {
  819. strnew += lines[i].replace("$usage_descriptions", descriptions);
  820. }
  821. } else {
  822. strnew += lines[i] + "\n";
  823. }
  824. }
  825. CharString cs = strnew.utf8();
  826. plist.resize(cs.size() - 1);
  827. for (int i = 0; i < cs.size() - 1; i++) {
  828. plist.write[i] = cs[i];
  829. }
  830. }
  831. /**
  832. * If we're running the macOS version of the Godot editor we'll:
  833. * - export our application bundle to a temporary folder
  834. * - attempt to code sign it
  835. * - and then wrap it up in a DMG
  836. */
  837. Error EditorExportPlatformMacOS::_notarize(const Ref<EditorExportPreset> &p_preset, const String &p_path) {
  838. int notary_tool = p_preset->get("notarization/notarization");
  839. switch (notary_tool) {
  840. case 1: { // "rcodesign"
  841. print_verbose("using rcodesign notarization...");
  842. String rcodesign = EDITOR_GET("export/macos/rcodesign").operator String();
  843. if (rcodesign.is_empty()) {
  844. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("rcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign)."));
  845. return Error::FAILED;
  846. }
  847. List<String> args;
  848. args.push_back("notary-submit");
  849. if (p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID) == "") {
  850. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect issuer ID name not specified."));
  851. return Error::FAILED;
  852. }
  853. if (p_preset->get_or_env("notarization/api_key", ENV_MAC_NOTARIZATION_KEY) == "") {
  854. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect API key ID not specified."));
  855. return Error::FAILED;
  856. }
  857. args.push_back("--api-issuer");
  858. args.push_back(p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID));
  859. args.push_back("--api-key");
  860. args.push_back(p_preset->get_or_env("notarization/api_key_id", ENV_MAC_NOTARIZATION_KEY_ID));
  861. if (!p_preset->get_or_env("notarization/api_key", ENV_MAC_NOTARIZATION_KEY).operator String().is_empty()) {
  862. args.push_back("--api-key-path");
  863. args.push_back(p_preset->get_or_env("notarization/api_key", ENV_MAC_NOTARIZATION_KEY));
  864. }
  865. args.push_back(p_path);
  866. String str;
  867. int exitcode = 0;
  868. Error err = OS::get_singleton()->execute(rcodesign, args, &str, &exitcode, true);
  869. if (err != OK) {
  870. add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Could not start rcodesign executable."));
  871. return err;
  872. }
  873. int rq_offset = str.find("created submission ID:");
  874. if (exitcode != 0 || rq_offset == -1) {
  875. print_line("rcodesign (" + p_path + "):\n" + str);
  876. add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Notarization failed, see editor log for details."));
  877. return Error::FAILED;
  878. } else {
  879. print_verbose("rcodesign (" + p_path + "):\n" + str);
  880. int next_nl = str.find("\n", rq_offset);
  881. String request_uuid = (next_nl == -1) ? str.substr(rq_offset + 23, -1) : str.substr(rq_offset + 23, next_nl - rq_offset - 23);
  882. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), vformat(TTR("Notarization request UUID: \"%s\""), request_uuid));
  883. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("The notarization process generally takes less than an hour."));
  884. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("You can check progress manually by opening a Terminal and running the following command:"));
  885. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"rcodesign notary-log --api-issuer <api uuid> --api-key <api key> <request uuid>\"");
  886. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("Run the following command to staple the notarization ticket to the exported application (optional):"));
  887. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"rcodesign staple <app path>\"");
  888. }
  889. } break;
  890. #ifdef MACOS_ENABLED
  891. case 2: { // "notarytool"
  892. print_verbose("using notarytool notarization...");
  893. if (!FileAccess::exists("/usr/bin/xcrun") && !FileAccess::exists("/bin/xcrun")) {
  894. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Xcode command line tools are not installed."));
  895. return Error::FAILED;
  896. }
  897. List<String> args;
  898. args.push_back("notarytool");
  899. args.push_back("submit");
  900. args.push_back(p_path);
  901. if (p_preset->get_or_env("notarization/apple_id_name", ENV_MAC_NOTARIZATION_APPLE_ID) == "" && p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID) == "") {
  902. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Neither Apple ID name nor App Store Connect issuer ID name not specified."));
  903. return Error::FAILED;
  904. }
  905. if (p_preset->get_or_env("notarization/apple_id_name", ENV_MAC_NOTARIZATION_APPLE_ID) != "" && p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID) != "") {
  906. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Both Apple ID name and App Store Connect issuer ID name are specified, only one should be set at the same time."));
  907. return Error::FAILED;
  908. }
  909. if (p_preset->get_or_env("notarization/apple_id_name", ENV_MAC_NOTARIZATION_APPLE_ID) != "") {
  910. if (p_preset->get_or_env("notarization/apple_id_password", ENV_MAC_NOTARIZATION_APPLE_PASS) == "") {
  911. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Apple ID password not specified."));
  912. return Error::FAILED;
  913. }
  914. args.push_back("--apple-id");
  915. args.push_back(p_preset->get_or_env("notarization/apple_id_name", ENV_MAC_NOTARIZATION_APPLE_ID));
  916. args.push_back("--password");
  917. args.push_back(p_preset->get_or_env("notarization/apple_id_password", ENV_MAC_NOTARIZATION_APPLE_PASS));
  918. } else {
  919. if (p_preset->get_or_env("notarization/api_key_id", ENV_MAC_NOTARIZATION_KEY_ID) == "") {
  920. add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect API key ID not specified."));
  921. return Error::FAILED;
  922. }
  923. args.push_back("--issuer");
  924. args.push_back(p_preset->get_or_env("notarization/api_uuid", ENV_MAC_NOTARIZATION_UUID));
  925. if (!p_preset->get_or_env("notarization/api_key", ENV_MAC_NOTARIZATION_KEY).operator String().is_empty()) {
  926. args.push_back("--key");
  927. args.push_back(p_preset->get_or_env("notarization/api_key", ENV_MAC_NOTARIZATION_KEY));
  928. }
  929. args.push_back("--key-id");
  930. args.push_back(p_preset->get_or_env("notarization/api_key_id", ENV_MAC_NOTARIZATION_KEY_ID));
  931. }
  932. args.push_back("--no-progress");
  933. if (p_preset->get("codesign/apple_team_id")) {
  934. args.push_back("--team-id");
  935. args.push_back(p_preset->get("codesign/apple_team_id"));
  936. }
  937. String str;
  938. int exitcode = 0;
  939. Error err = OS::get_singleton()->execute("xcrun", args, &str, &exitcode, true);
  940. if (err != OK) {
  941. add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Could not start xcrun executable."));
  942. return err;
  943. }
  944. int rq_offset = str.find("id:");
  945. if (exitcode != 0 || rq_offset == -1) {
  946. print_line("notarytool (" + p_path + "):\n" + str);
  947. add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Notarization failed, see editor log for details."));
  948. return Error::FAILED;
  949. } else {
  950. print_verbose("notarytool (" + p_path + "):\n" + str);
  951. int next_nl = str.find("\n", rq_offset);
  952. String request_uuid = (next_nl == -1) ? str.substr(rq_offset + 4, -1) : str.substr(rq_offset + 4, next_nl - rq_offset - 4);
  953. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), vformat(TTR("Notarization request UUID: \"%s\""), request_uuid));
  954. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("The notarization process generally takes less than an hour."));
  955. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("You can check progress manually by opening a Terminal and running the following command:"));
  956. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun notarytool log <request uuid> --issuer <api uuid> --key-id <api key id> --key <api key path>\" or");
  957. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun notarytool log <request uuid> --apple-id <your email> --password <app-specific pwd>>\"");
  958. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("Run the following command to staple the notarization ticket to the exported application (optional):"));
  959. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun stapler staple <app path>\"");
  960. }
  961. } break;
  962. #endif
  963. default: {
  964. };
  965. }
  966. return OK;
  967. }
  968. void EditorExportPlatformMacOS::_code_sign(const Ref<EditorExportPreset> &p_preset, const String &p_path, const String &p_ent_path, bool p_warn, bool p_set_id) {
  969. int codesign_tool = p_preset->get("codesign/codesign");
  970. switch (codesign_tool) {
  971. case 1: { // built-in ad-hoc
  972. print_verbose("using built-in codesign...");
  973. #ifdef MODULE_REGEX_ENABLED
  974. String error_msg;
  975. Error err = CodeSign::codesign(false, true, p_path, p_ent_path, error_msg);
  976. if (err != OK) {
  977. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("Built-in CodeSign failed with error \"%s\"."), error_msg));
  978. return;
  979. }
  980. #else
  981. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Built-in CodeSign require regex module."));
  982. #endif
  983. } break;
  984. case 2: { // "rcodesign"
  985. print_verbose("using rcodesign codesign...");
  986. String rcodesign = EDITOR_GET("export/macos/rcodesign").operator String();
  987. if (rcodesign.is_empty()) {
  988. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Xrcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign)."));
  989. return;
  990. }
  991. List<String> args;
  992. args.push_back("sign");
  993. if (!p_ent_path.is_empty()) {
  994. args.push_back("--entitlements-xml-path");
  995. args.push_back(p_ent_path);
  996. }
  997. String certificate_file = p_preset->get_or_env("codesign/certificate_file", ENV_MAC_CODESIGN_CERT_FILE);
  998. String certificate_pass = p_preset->get_or_env("codesign/certificate_password", ENV_MAC_CODESIGN_CERT_PASS);
  999. if (!certificate_file.is_empty() && !certificate_pass.is_empty()) {
  1000. args.push_back("--p12-file");
  1001. args.push_back(certificate_file);
  1002. args.push_back("--p12-password");
  1003. args.push_back(certificate_pass);
  1004. }
  1005. args.push_back("--code-signature-flags");
  1006. args.push_back("runtime");
  1007. if (p_set_id) {
  1008. String app_id = p_preset->get("application/bundle_identifier");
  1009. args.push_back("--binary-identifier");
  1010. args.push_back(app_id);
  1011. }
  1012. args.push_back("-v"); /* provide some more feedback */
  1013. args.push_back(p_path);
  1014. String str;
  1015. int exitcode = 0;
  1016. Error err = OS::get_singleton()->execute(rcodesign, args, &str, &exitcode, true);
  1017. if (err != OK) {
  1018. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start rcodesign executable."));
  1019. return;
  1020. }
  1021. if (exitcode != 0) {
  1022. print_line("rcodesign (" + p_path + "):\n" + str);
  1023. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Code signing failed, see editor log for details."));
  1024. return;
  1025. } else {
  1026. print_verbose("rcodesign (" + p_path + "):\n" + str);
  1027. }
  1028. } break;
  1029. #ifdef MACOS_ENABLED
  1030. case 3: { // "codesign"
  1031. print_verbose("using xcode codesign...");
  1032. if (!FileAccess::exists("/usr/bin/codesign") && !FileAccess::exists("/bin/codesign")) {
  1033. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Xcode command line tools are not installed."));
  1034. return;
  1035. }
  1036. bool ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-");
  1037. List<String> args;
  1038. if (!ad_hoc) {
  1039. args.push_back("--timestamp");
  1040. args.push_back("--options");
  1041. args.push_back("runtime");
  1042. }
  1043. if (!p_ent_path.is_empty()) {
  1044. args.push_back("--entitlements");
  1045. args.push_back(p_ent_path);
  1046. }
  1047. PackedStringArray user_args = p_preset->get("codesign/custom_options");
  1048. for (int i = 0; i < user_args.size(); i++) {
  1049. String user_arg = user_args[i].strip_edges();
  1050. if (!user_arg.is_empty()) {
  1051. args.push_back(user_arg);
  1052. }
  1053. }
  1054. args.push_back("-s");
  1055. if (ad_hoc) {
  1056. args.push_back("-");
  1057. } else {
  1058. args.push_back(p_preset->get("codesign/identity"));
  1059. }
  1060. if (p_set_id) {
  1061. String app_id = p_preset->get("application/bundle_identifier");
  1062. args.push_back("-i");
  1063. args.push_back(app_id);
  1064. }
  1065. args.push_back("-v"); /* provide some more feedback */
  1066. args.push_back("-f");
  1067. args.push_back(p_path);
  1068. String str;
  1069. int exitcode = 0;
  1070. Error err = OS::get_singleton()->execute("codesign", args, &str, &exitcode, true);
  1071. if (err != OK) {
  1072. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start codesign executable, make sure Xcode command line tools are installed."));
  1073. return;
  1074. }
  1075. if (exitcode != 0) {
  1076. print_line("codesign (" + p_path + "):\n" + str);
  1077. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Code signing failed, see editor log for details."));
  1078. return;
  1079. } else {
  1080. print_verbose("codesign (" + p_path + "):\n" + str);
  1081. }
  1082. } break;
  1083. #endif
  1084. default: {
  1085. };
  1086. }
  1087. }
  1088. void EditorExportPlatformMacOS::_code_sign_directory(const Ref<EditorExportPreset> &p_preset, const String &p_path,
  1089. const String &p_ent_path, const String &p_helper_ent_path, bool p_should_error_on_non_code) {
  1090. static Vector<String> extensions_to_sign;
  1091. bool sandbox = p_preset->get("codesign/entitlements/app_sandbox/enabled");
  1092. if (extensions_to_sign.is_empty()) {
  1093. extensions_to_sign.push_back("dylib");
  1094. extensions_to_sign.push_back("framework");
  1095. extensions_to_sign.push_back("");
  1096. }
  1097. Error dir_access_error;
  1098. Ref<DirAccess> dir_access{ DirAccess::open(p_path, &dir_access_error) };
  1099. if (dir_access_error != OK) {
  1100. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("Cannot sign directory %s."), p_path));
  1101. return;
  1102. }
  1103. dir_access->list_dir_begin();
  1104. String current_file{ dir_access->get_next() };
  1105. while (!current_file.is_empty()) {
  1106. String current_file_path{ p_path.path_join(current_file) };
  1107. if (current_file == ".." || current_file == ".") {
  1108. current_file = dir_access->get_next();
  1109. continue;
  1110. }
  1111. if (extensions_to_sign.has(current_file.get_extension())) {
  1112. String ent_path;
  1113. bool set_bundle_id = false;
  1114. if (sandbox && FileAccess::exists(current_file_path)) {
  1115. int ftype = MachO::get_filetype(current_file_path);
  1116. if (ftype == 2 || ftype == 5) {
  1117. ent_path = p_helper_ent_path;
  1118. set_bundle_id = true;
  1119. }
  1120. }
  1121. _code_sign(p_preset, current_file_path, ent_path, false, set_bundle_id);
  1122. if (is_executable(current_file_path)) {
  1123. // chmod with 0755 if the file is executable.
  1124. FileAccess::set_unix_permissions(current_file_path, 0755);
  1125. }
  1126. } else if (dir_access->current_is_dir()) {
  1127. _code_sign_directory(p_preset, current_file_path, p_ent_path, p_helper_ent_path, p_should_error_on_non_code);
  1128. } else if (p_should_error_on_non_code) {
  1129. add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("Cannot sign file %s."), current_file));
  1130. }
  1131. current_file = dir_access->get_next();
  1132. }
  1133. }
  1134. Error EditorExportPlatformMacOS::_copy_and_sign_files(Ref<DirAccess> &dir_access, const String &p_src_path,
  1135. const String &p_in_app_path, bool p_sign_enabled,
  1136. const Ref<EditorExportPreset> &p_preset, const String &p_ent_path,
  1137. const String &p_helper_ent_path,
  1138. bool p_should_error_on_non_code_sign, bool p_sandbox) {
  1139. static Vector<String> extensions_to_sign;
  1140. if (extensions_to_sign.is_empty()) {
  1141. extensions_to_sign.push_back("dylib");
  1142. extensions_to_sign.push_back("framework");
  1143. extensions_to_sign.push_back("");
  1144. }
  1145. Error err{ OK };
  1146. if (dir_access->dir_exists(p_src_path)) {
  1147. #ifndef UNIX_ENABLED
  1148. add_message(EXPORT_MESSAGE_INFO, TTR("Export"), vformat(TTR("Relative symlinks are not supported, exported \"%s\" might be broken!"), p_src_path.get_file()));
  1149. #endif
  1150. print_verbose("export framework: " + p_src_path + " -> " + p_in_app_path);
  1151. bool plist_misssing = false;
  1152. Ref<PList> plist;
  1153. plist.instantiate();
  1154. plist->load_file(p_src_path.path_join("Resources").path_join("Info.plist"));
  1155. Ref<PListNode> root_node = plist->get_root();
  1156. if (root_node.is_null()) {
  1157. plist_misssing = true;
  1158. } else {
  1159. Dictionary root = root_node->get_value();
  1160. if (!root.has("CFBundleExecutable") || !root.has("CFBundleIdentifier") || !root.has("CFBundlePackageType") || !root.has("CFBundleInfoDictionaryVersion") || !root.has("CFBundleName") || !root.has("CFBundleSupportedPlatforms")) {
  1161. plist_misssing = true;
  1162. }
  1163. }
  1164. err = dir_access->make_dir_recursive(p_in_app_path);
  1165. if (err == OK) {
  1166. err = dir_access->copy_dir(p_src_path, p_in_app_path, -1, true);
  1167. }
  1168. if (err == OK && plist_misssing) {
  1169. add_message(EXPORT_MESSAGE_WARNING, TTR("Export"), vformat(TTR("\"%s\": Info.plist missing or invalid, new Info.plist generated."), p_src_path.get_file()));
  1170. // Generate Info.plist
  1171. String lib_name = p_src_path.get_basename().get_file();
  1172. String lib_id = p_preset->get("application/bundle_identifier");
  1173. String lib_clean_name = lib_name;
  1174. for (int i = 0; i < lib_clean_name.length(); i++) {
  1175. if (!is_ascii_alphanumeric_char(lib_clean_name[i]) && lib_clean_name[i] != '.' && lib_clean_name[i] != '-') {
  1176. lib_clean_name[i] = '-';
  1177. }
  1178. }
  1179. String info_plist_format = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
  1180. "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
  1181. "<plist version=\"1.0\">\n"
  1182. " <dict>\n"
  1183. " <key>CFBundleExecutable</key>\n"
  1184. " <string>$name</string>\n"
  1185. " <key>CFBundleIdentifier</key>\n"
  1186. " <string>$id.framework.$cl_name</string>\n"
  1187. " <key>CFBundleInfoDictionaryVersion</key>\n"
  1188. " <string>6.0</string>\n"
  1189. " <key>CFBundleName</key>\n"
  1190. " <string>$name</string>\n"
  1191. " <key>CFBundlePackageType</key>\n"
  1192. " <string>FMWK</string>\n"
  1193. " <key>CFBundleShortVersionString</key>\n"
  1194. " <string>1.0.0</string>\n"
  1195. " <key>CFBundleSupportedPlatforms</key>\n"
  1196. " <array>\n"
  1197. " <string>MacOSX</string>\n"
  1198. " </array>\n"
  1199. " <key>CFBundleVersion</key>\n"
  1200. " <string>1.0.0</string>\n"
  1201. " <key>LSMinimumSystemVersion</key>\n"
  1202. " <string>10.12</string>\n"
  1203. " </dict>\n"
  1204. "</plist>";
  1205. String info_plist = info_plist_format.replace("$id", lib_id).replace("$name", lib_name).replace("$cl_name", lib_clean_name);
  1206. err = dir_access->make_dir_recursive(p_in_app_path.path_join("Resources"));
  1207. Ref<FileAccess> f = FileAccess::open(p_in_app_path.path_join("Resources").path_join("Info.plist"), FileAccess::WRITE);
  1208. if (f.is_valid()) {
  1209. f->store_string(info_plist);
  1210. }
  1211. }
  1212. } else {
  1213. print_verbose("export dylib: " + p_src_path + " -> " + p_in_app_path);
  1214. err = dir_access->copy(p_src_path, p_in_app_path);
  1215. }
  1216. if (err == OK && p_sign_enabled) {
  1217. if (dir_access->dir_exists(p_src_path) && p_src_path.get_extension().is_empty()) {
  1218. // If it is a directory, find and sign all dynamic libraries.
  1219. _code_sign_directory(p_preset, p_in_app_path, p_ent_path, p_helper_ent_path, p_should_error_on_non_code_sign);
  1220. } else {
  1221. if (extensions_to_sign.has(p_in_app_path.get_extension())) {
  1222. String ent_path;
  1223. bool set_bundle_id = false;
  1224. if (p_sandbox && FileAccess::exists(p_in_app_path)) {
  1225. int ftype = MachO::get_filetype(p_in_app_path);
  1226. if (ftype == 2 || ftype == 5) {
  1227. ent_path = p_helper_ent_path;
  1228. set_bundle_id = true;
  1229. }
  1230. }
  1231. _code_sign(p_preset, p_in_app_path, ent_path, false, set_bundle_id);
  1232. }
  1233. if (dir_access->file_exists(p_in_app_path) && is_executable(p_in_app_path)) {
  1234. // chmod with 0755 if the file is executable.
  1235. FileAccess::set_unix_permissions(p_in_app_path, 0755);
  1236. }
  1237. }
  1238. }
  1239. return err;
  1240. }
  1241. Error EditorExportPlatformMacOS::_export_macos_plugins_for(Ref<EditorExportPlugin> p_editor_export_plugin,
  1242. const String &p_app_path_name, Ref<DirAccess> &dir_access,
  1243. bool p_sign_enabled, const Ref<EditorExportPreset> &p_preset,
  1244. const String &p_ent_path, const String &p_helper_ent_path, bool p_sandbox) {
  1245. Error error{ OK };
  1246. const Vector<String> &macos_plugins{ p_editor_export_plugin->get_macos_plugin_files() };
  1247. for (int i = 0; i < macos_plugins.size(); ++i) {
  1248. String src_path{ ProjectSettings::get_singleton()->globalize_path(macos_plugins[i]) };
  1249. String path_in_app{ p_app_path_name + "/Contents/PlugIns/" + src_path.get_file() };
  1250. error = _copy_and_sign_files(dir_access, src_path, path_in_app, p_sign_enabled, p_preset, p_ent_path, p_helper_ent_path, false, p_sandbox);
  1251. if (error != OK) {
  1252. break;
  1253. }
  1254. }
  1255. return error;
  1256. }
  1257. Error EditorExportPlatformMacOS::_create_pkg(const Ref<EditorExportPreset> &p_preset, const String &p_pkg_path, const String &p_app_path_name) {
  1258. List<String> args;
  1259. if (FileAccess::exists(p_pkg_path)) {
  1260. OS::get_singleton()->move_to_trash(p_pkg_path);
  1261. }
  1262. args.push_back("productbuild");
  1263. args.push_back("--component");
  1264. args.push_back(p_app_path_name);
  1265. args.push_back("/Applications");
  1266. String ident = p_preset->get("codesign/installer_identity");
  1267. if (!ident.is_empty()) {
  1268. args.push_back("--timestamp");
  1269. args.push_back("--sign");
  1270. args.push_back(ident);
  1271. }
  1272. args.push_back("--quiet");
  1273. args.push_back(p_pkg_path);
  1274. String str;
  1275. Error err = OS::get_singleton()->execute("xcrun", args, &str, nullptr, true);
  1276. if (err != OK) {
  1277. add_message(EXPORT_MESSAGE_ERROR, TTR("PKG Creation"), TTR("Could not start productbuild executable."));
  1278. return err;
  1279. }
  1280. print_verbose("productbuild returned: " + str);
  1281. if (str.contains("productbuild: error:")) {
  1282. add_message(EXPORT_MESSAGE_ERROR, TTR("PKG Creation"), TTR("`productbuild` failed."));
  1283. return FAILED;
  1284. }
  1285. return OK;
  1286. }
  1287. Error EditorExportPlatformMacOS::_create_dmg(const String &p_dmg_path, const String &p_pkg_name, const String &p_app_path_name) {
  1288. List<String> args;
  1289. if (FileAccess::exists(p_dmg_path)) {
  1290. OS::get_singleton()->move_to_trash(p_dmg_path);
  1291. }
  1292. args.push_back("create");
  1293. args.push_back(p_dmg_path);
  1294. args.push_back("-volname");
  1295. args.push_back(p_pkg_name);
  1296. args.push_back("-fs");
  1297. args.push_back("HFS+");
  1298. args.push_back("-srcfolder");
  1299. args.push_back(p_app_path_name);
  1300. String str;
  1301. Error err = OS::get_singleton()->execute("hdiutil", args, &str, nullptr, true);
  1302. if (err != OK) {
  1303. add_message(EXPORT_MESSAGE_ERROR, TTR("DMG Creation"), TTR("Could not start hdiutil executable."));
  1304. return err;
  1305. }
  1306. print_verbose("hdiutil returned: " + str);
  1307. if (str.contains("create failed")) {
  1308. if (str.contains("File exists")) {
  1309. add_message(EXPORT_MESSAGE_ERROR, TTR("DMG Creation"), TTR("`hdiutil create` failed - file exists."));
  1310. } else {
  1311. add_message(EXPORT_MESSAGE_ERROR, TTR("DMG Creation"), TTR("`hdiutil create` failed."));
  1312. }
  1313. return FAILED;
  1314. }
  1315. return OK;
  1316. }
  1317. bool EditorExportPlatformMacOS::is_shebang(const String &p_path) const {
  1318. Ref<FileAccess> fb = FileAccess::open(p_path, FileAccess::READ);
  1319. ERR_FAIL_COND_V_MSG(fb.is_null(), false, vformat("Can't open file: \"%s\".", p_path));
  1320. uint16_t magic = fb->get_16();
  1321. return (magic == 0x2123);
  1322. }
  1323. bool EditorExportPlatformMacOS::is_executable(const String &p_path) const {
  1324. return MachO::is_macho(p_path) || LipO::is_lipo(p_path) || is_shebang(p_path);
  1325. }
  1326. Error EditorExportPlatformMacOS::_export_debug_script(const Ref<EditorExportPreset> &p_preset, const String &p_app_name, const String &p_pkg_name, const String &p_path) {
  1327. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::WRITE);
  1328. if (f.is_null()) {
  1329. add_message(EXPORT_MESSAGE_ERROR, TTR("Debug Script Export"), vformat(TTR("Could not open file \"%s\"."), p_path));
  1330. return ERR_CANT_CREATE;
  1331. }
  1332. f->store_line("#!/bin/sh");
  1333. f->store_line("echo -ne '\\033c\\033]0;" + p_app_name + "\\a'");
  1334. f->store_line("");
  1335. f->store_line("function app_realpath() {");
  1336. f->store_line(" SOURCE=$1");
  1337. f->store_line(" while [ -h \"$SOURCE\" ]; do");
  1338. f->store_line(" DIR=$(dirname \"$SOURCE\")");
  1339. f->store_line(" SOURCE=$(readlink \"$SOURCE\")");
  1340. f->store_line(" [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE");
  1341. f->store_line(" done");
  1342. f->store_line(" echo \"$( cd -P \"$( dirname \"$SOURCE\" )\" >/dev/null 2>&1 && pwd )\"");
  1343. f->store_line("}");
  1344. f->store_line("");
  1345. f->store_line("BASE_PATH=\"$(app_realpath \"${BASH_SOURCE[0]}\")\"");
  1346. f->store_line("\"$BASE_PATH/" + p_pkg_name + "\" \"$@\"");
  1347. f->store_line("");
  1348. return OK;
  1349. }
  1350. Error EditorExportPlatformMacOS::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  1351. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1352. const String base_dir = p_path.get_base_dir();
  1353. if (!DirAccess::exists(base_dir)) {
  1354. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Target folder does not exist or is inaccessible: \"%s\""), base_dir));
  1355. return ERR_FILE_BAD_PATH;
  1356. }
  1357. EditorProgress ep("export", TTR("Exporting for macOS"), 3, true);
  1358. String src_pkg_name;
  1359. if (p_debug) {
  1360. src_pkg_name = p_preset->get("custom_template/debug");
  1361. } else {
  1362. src_pkg_name = p_preset->get("custom_template/release");
  1363. }
  1364. if (src_pkg_name.is_empty()) {
  1365. String err;
  1366. src_pkg_name = find_export_template("macos.zip", &err);
  1367. if (src_pkg_name.is_empty()) {
  1368. add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("Export template not found.") + "\n" + err);
  1369. return ERR_FILE_NOT_FOUND;
  1370. }
  1371. }
  1372. Ref<FileAccess> io_fa;
  1373. zlib_filefunc_def io = zipio_create_io(&io_fa);
  1374. if (ep.step(TTR("Creating app bundle"), 0)) {
  1375. return ERR_SKIP;
  1376. }
  1377. unzFile src_pkg_zip = unzOpen2(src_pkg_name.utf8().get_data(), &io);
  1378. if (!src_pkg_zip) {
  1379. add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), vformat(TTR("Could not find template app to export: \"%s\"."), src_pkg_name));
  1380. return ERR_FILE_NOT_FOUND;
  1381. }
  1382. int ret = unzGoToFirstFile(src_pkg_zip);
  1383. String architecture = p_preset->get("binary_format/architecture");
  1384. String binary_to_use = "godot_macos_" + String(p_debug ? "debug" : "release") + "." + architecture;
  1385. String pkg_name;
  1386. if (String(GLOBAL_GET("application/config/name")) != "") {
  1387. pkg_name = String(GLOBAL_GET("application/config/name"));
  1388. } else {
  1389. pkg_name = "Unnamed";
  1390. }
  1391. pkg_name = OS::get_singleton()->get_safe_dir_name(pkg_name);
  1392. String export_format;
  1393. if (p_path.ends_with("zip")) {
  1394. export_format = "zip";
  1395. } else if (p_path.ends_with("app")) {
  1396. export_format = "app";
  1397. #ifdef MACOS_ENABLED
  1398. } else if (p_path.ends_with("dmg")) {
  1399. export_format = "dmg";
  1400. } else if (p_path.ends_with("pkg")) {
  1401. export_format = "pkg";
  1402. #endif
  1403. } else {
  1404. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Invalid export format."));
  1405. return ERR_CANT_CREATE;
  1406. }
  1407. // Create our application bundle.
  1408. String tmp_app_dir_name = pkg_name + ".app";
  1409. String tmp_base_path_name;
  1410. String tmp_app_path_name;
  1411. String scr_path;
  1412. if (export_format == "app") {
  1413. tmp_base_path_name = p_path.get_base_dir();
  1414. tmp_app_path_name = p_path;
  1415. scr_path = p_path.get_basename() + ".command";
  1416. } else {
  1417. tmp_base_path_name = EditorPaths::get_singleton()->get_cache_dir().path_join(pkg_name);
  1418. tmp_app_path_name = tmp_base_path_name.path_join(tmp_app_dir_name);
  1419. scr_path = tmp_base_path_name.path_join(pkg_name + ".command");
  1420. }
  1421. print_verbose("Exporting to " + tmp_app_path_name);
  1422. Error err = OK;
  1423. Ref<DirAccess> tmp_app_dir = DirAccess::create_for_path(tmp_base_path_name);
  1424. if (tmp_app_dir.is_null()) {
  1425. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory: \"%s\"."), tmp_base_path_name));
  1426. err = ERR_CANT_CREATE;
  1427. }
  1428. if (FileAccess::exists(scr_path)) {
  1429. DirAccess::remove_file_or_error(scr_path);
  1430. }
  1431. if (DirAccess::exists(tmp_app_path_name)) {
  1432. String old_dir = tmp_app_dir->get_current_dir();
  1433. if (tmp_app_dir->change_dir(tmp_app_path_name) == OK) {
  1434. tmp_app_dir->erase_contents_recursive();
  1435. tmp_app_dir->change_dir(old_dir);
  1436. }
  1437. }
  1438. Array helpers = p_preset->get("codesign/entitlements/app_sandbox/helper_executables");
  1439. // Create our folder structure.
  1440. if (err == OK) {
  1441. print_verbose("Creating " + tmp_app_path_name + "/Contents/MacOS");
  1442. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/MacOS");
  1443. if (err != OK) {
  1444. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/MacOS"));
  1445. }
  1446. }
  1447. if (err == OK) {
  1448. print_verbose("Creating " + tmp_app_path_name + "/Contents/Frameworks");
  1449. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Frameworks");
  1450. if (err != OK) {
  1451. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/Frameworks"));
  1452. }
  1453. }
  1454. if ((err == OK) && helpers.size() > 0) {
  1455. print_line("Creating " + tmp_app_path_name + "/Contents/Helpers");
  1456. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Helpers");
  1457. if (err != OK) {
  1458. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/Helpers"));
  1459. }
  1460. }
  1461. if (err == OK) {
  1462. print_verbose("Creating " + tmp_app_path_name + "/Contents/Resources");
  1463. err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Resources");
  1464. if (err != OK) {
  1465. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/Resources"));
  1466. }
  1467. }
  1468. Dictionary appnames = GLOBAL_GET("application/config/name_localized");
  1469. Dictionary microphone_usage_descriptions = p_preset->get("privacy/microphone_usage_description_localized");
  1470. Dictionary camera_usage_descriptions = p_preset->get("privacy/camera_usage_description_localized");
  1471. Dictionary location_usage_descriptions = p_preset->get("privacy/location_usage_description_localized");
  1472. Dictionary address_book_usage_descriptions = p_preset->get("privacy/address_book_usage_description_localized");
  1473. Dictionary calendar_usage_descriptions = p_preset->get("privacy/calendar_usage_description_localized");
  1474. Dictionary photos_library_usage_descriptions = p_preset->get("privacy/photos_library_usage_description_localized");
  1475. Dictionary desktop_folder_usage_descriptions = p_preset->get("privacy/desktop_folder_usage_description_localized");
  1476. Dictionary documents_folder_usage_descriptions = p_preset->get("privacy/documents_folder_usage_description_localized");
  1477. Dictionary downloads_folder_usage_descriptions = p_preset->get("privacy/downloads_folder_usage_description_localized");
  1478. Dictionary network_volumes_usage_descriptions = p_preset->get("privacy/network_volumes_usage_description_localized");
  1479. Dictionary removable_volumes_usage_descriptions = p_preset->get("privacy/removable_volumes_usage_description_localized");
  1480. Dictionary copyrights = p_preset->get("application/copyright_localized");
  1481. Vector<String> translations = GLOBAL_GET("internationalization/locale/translations");
  1482. if (translations.size() > 0) {
  1483. {
  1484. String fname = tmp_app_path_name + "/Contents/Resources/en.lproj";
  1485. tmp_app_dir->make_dir_recursive(fname);
  1486. Ref<FileAccess> f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE);
  1487. f->store_line("/* Localized versions of Info.plist keys */");
  1488. f->store_line("");
  1489. f->store_line("CFBundleDisplayName = \"" + GLOBAL_GET("application/config/name").operator String() + "\";");
  1490. if (!((String)p_preset->get("privacy/microphone_usage_description")).is_empty()) {
  1491. f->store_line("NSMicrophoneUsageDescription = \"" + p_preset->get("privacy/microphone_usage_description").operator String() + "\";");
  1492. }
  1493. if (!((String)p_preset->get("privacy/camera_usage_description")).is_empty()) {
  1494. f->store_line("NSCameraUsageDescription = \"" + p_preset->get("privacy/camera_usage_description").operator String() + "\";");
  1495. }
  1496. if (!((String)p_preset->get("privacy/location_usage_description")).is_empty()) {
  1497. f->store_line("NSLocationUsageDescription = \"" + p_preset->get("privacy/location_usage_description").operator String() + "\";");
  1498. }
  1499. if (!((String)p_preset->get("privacy/address_book_usage_description")).is_empty()) {
  1500. f->store_line("NSContactsUsageDescription = \"" + p_preset->get("privacy/address_book_usage_description").operator String() + "\";");
  1501. }
  1502. if (!((String)p_preset->get("privacy/calendar_usage_description")).is_empty()) {
  1503. f->store_line("NSCalendarsUsageDescription = \"" + p_preset->get("privacy/calendar_usage_description").operator String() + "\";");
  1504. }
  1505. if (!((String)p_preset->get("privacy/photos_library_usage_description")).is_empty()) {
  1506. f->store_line("NSPhotoLibraryUsageDescription = \"" + p_preset->get("privacy/photos_library_usage_description").operator String() + "\";");
  1507. }
  1508. if (!((String)p_preset->get("privacy/desktop_folder_usage_description")).is_empty()) {
  1509. f->store_line("NSDesktopFolderUsageDescription = \"" + p_preset->get("privacy/desktop_folder_usage_description").operator String() + "\";");
  1510. }
  1511. if (!((String)p_preset->get("privacy/documents_folder_usage_description")).is_empty()) {
  1512. f->store_line("NSDocumentsFolderUsageDescription = \"" + p_preset->get("privacy/documents_folder_usage_description").operator String() + "\";");
  1513. }
  1514. if (!((String)p_preset->get("privacy/downloads_folder_usage_description")).is_empty()) {
  1515. f->store_line("NSDownloadsFolderUsageDescription = \"" + p_preset->get("privacy/downloads_folder_usage_description").operator String() + "\";");
  1516. }
  1517. if (!((String)p_preset->get("privacy/network_volumes_usage_description")).is_empty()) {
  1518. f->store_line("NSNetworkVolumesUsageDescription = \"" + p_preset->get("privacy/network_volumes_usage_description").operator String() + "\";");
  1519. }
  1520. if (!((String)p_preset->get("privacy/removable_volumes_usage_description")).is_empty()) {
  1521. f->store_line("NSRemovableVolumesUsageDescription = \"" + p_preset->get("privacy/removable_volumes_usage_description").operator String() + "\";");
  1522. }
  1523. f->store_line("NSHumanReadableCopyright = \"" + p_preset->get("application/copyright").operator String() + "\";");
  1524. }
  1525. HashSet<String> languages;
  1526. for (const String &E : translations) {
  1527. Ref<Translation> tr = ResourceLoader::load(E);
  1528. if (tr.is_valid() && tr->get_locale() != "en") {
  1529. languages.insert(tr->get_locale());
  1530. }
  1531. }
  1532. for (const String &lang : languages) {
  1533. String fname = tmp_app_path_name + "/Contents/Resources/" + lang + ".lproj";
  1534. tmp_app_dir->make_dir_recursive(fname);
  1535. Ref<FileAccess> f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE);
  1536. f->store_line("/* Localized versions of Info.plist keys */");
  1537. f->store_line("");
  1538. if (appnames.has(lang)) {
  1539. f->store_line("CFBundleDisplayName = \"" + appnames[lang].operator String() + "\";");
  1540. }
  1541. if (microphone_usage_descriptions.has(lang)) {
  1542. f->store_line("NSMicrophoneUsageDescription = \"" + microphone_usage_descriptions[lang].operator String() + "\";");
  1543. }
  1544. if (camera_usage_descriptions.has(lang)) {
  1545. f->store_line("NSCameraUsageDescription = \"" + camera_usage_descriptions[lang].operator String() + "\";");
  1546. }
  1547. if (location_usage_descriptions.has(lang)) {
  1548. f->store_line("NSLocationUsageDescription = \"" + location_usage_descriptions[lang].operator String() + "\";");
  1549. }
  1550. if (address_book_usage_descriptions.has(lang)) {
  1551. f->store_line("NSContactsUsageDescription = \"" + address_book_usage_descriptions[lang].operator String() + "\";");
  1552. }
  1553. if (calendar_usage_descriptions.has(lang)) {
  1554. f->store_line("NSCalendarsUsageDescription = \"" + calendar_usage_descriptions[lang].operator String() + "\";");
  1555. }
  1556. if (photos_library_usage_descriptions.has(lang)) {
  1557. f->store_line("NSPhotoLibraryUsageDescription = \"" + photos_library_usage_descriptions[lang].operator String() + "\";");
  1558. }
  1559. if (desktop_folder_usage_descriptions.has(lang)) {
  1560. f->store_line("NSDesktopFolderUsageDescription = \"" + desktop_folder_usage_descriptions[lang].operator String() + "\";");
  1561. }
  1562. if (documents_folder_usage_descriptions.has(lang)) {
  1563. f->store_line("NSDocumentsFolderUsageDescription = \"" + documents_folder_usage_descriptions[lang].operator String() + "\";");
  1564. }
  1565. if (downloads_folder_usage_descriptions.has(lang)) {
  1566. f->store_line("NSDownloadsFolderUsageDescription = \"" + downloads_folder_usage_descriptions[lang].operator String() + "\";");
  1567. }
  1568. if (network_volumes_usage_descriptions.has(lang)) {
  1569. f->store_line("NSNetworkVolumesUsageDescription = \"" + network_volumes_usage_descriptions[lang].operator String() + "\";");
  1570. }
  1571. if (removable_volumes_usage_descriptions.has(lang)) {
  1572. f->store_line("NSRemovableVolumesUsageDescription = \"" + removable_volumes_usage_descriptions[lang].operator String() + "\";");
  1573. }
  1574. if (copyrights.has(lang)) {
  1575. f->store_line("NSHumanReadableCopyright = \"" + copyrights[lang].operator String() + "\";");
  1576. }
  1577. }
  1578. }
  1579. // Now process our template.
  1580. bool found_binary = false;
  1581. int export_angle = p_preset->get("application/export_angle");
  1582. bool include_angle_libs = false;
  1583. if (export_angle == 0) {
  1584. include_angle_libs = String(GLOBAL_GET("rendering/gl_compatibility/driver.macos")) == "opengl3_angle";
  1585. } else if (export_angle == 1) {
  1586. include_angle_libs = true;
  1587. }
  1588. while (ret == UNZ_OK && err == OK) {
  1589. // Get filename.
  1590. unz_file_info info;
  1591. char fname[16384];
  1592. ret = unzGetCurrentFileInfo(src_pkg_zip, &info, fname, 16384, nullptr, 0, nullptr, 0);
  1593. if (ret != UNZ_OK) {
  1594. break;
  1595. }
  1596. String file = String::utf8(fname);
  1597. Vector<uint8_t> data;
  1598. data.resize(info.uncompressed_size);
  1599. // Read.
  1600. unzOpenCurrentFile(src_pkg_zip);
  1601. unzReadCurrentFile(src_pkg_zip, data.ptrw(), data.size());
  1602. unzCloseCurrentFile(src_pkg_zip);
  1603. // Write.
  1604. file = file.replace_first("macos_template.app/", "");
  1605. if (((info.external_fa >> 16L) & 0120000) == 0120000) {
  1606. #ifndef UNIX_ENABLED
  1607. add_message(EXPORT_MESSAGE_INFO, TTR("Export"), TTR("Relative symlinks are not supported on this OS, the exported project might be broken!"));
  1608. #endif
  1609. // Handle symlinks in the archive.
  1610. file = tmp_app_path_name.path_join(file);
  1611. if (err == OK) {
  1612. err = tmp_app_dir->make_dir_recursive(file.get_base_dir());
  1613. if (err != OK) {
  1614. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), file.get_base_dir()));
  1615. }
  1616. }
  1617. if (err == OK) {
  1618. String lnk_data = String::utf8((const char *)data.ptr(), data.size());
  1619. err = tmp_app_dir->create_link(lnk_data, file);
  1620. if (err != OK) {
  1621. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not created symlink \"%s\" -> \"%s\"."), lnk_data, file));
  1622. }
  1623. print_verbose(vformat("ADDING SYMLINK %s => %s\n", file, lnk_data));
  1624. }
  1625. ret = unzGoToNextFile(src_pkg_zip);
  1626. continue; // next
  1627. }
  1628. if (file == "Contents/Frameworks/libEGL.dylib") {
  1629. if (!include_angle_libs) {
  1630. ret = unzGoToNextFile(src_pkg_zip);
  1631. continue; // skip
  1632. }
  1633. }
  1634. if (file == "Contents/Frameworks/libGLESv2.dylib") {
  1635. if (!include_angle_libs) {
  1636. ret = unzGoToNextFile(src_pkg_zip);
  1637. continue; // skip
  1638. }
  1639. }
  1640. if (file == "Contents/Info.plist") {
  1641. _fix_plist(p_preset, data, pkg_name);
  1642. }
  1643. if (file == "Contents/Resources/PrivacyInfo.xcprivacy") {
  1644. _fix_privacy_manifest(p_preset, data);
  1645. }
  1646. if (file.begins_with("Contents/MacOS/godot_")) {
  1647. if (file != "Contents/MacOS/" + binary_to_use) {
  1648. ret = unzGoToNextFile(src_pkg_zip);
  1649. continue; // skip
  1650. }
  1651. found_binary = true;
  1652. file = "Contents/MacOS/" + pkg_name;
  1653. }
  1654. if (file == "Contents/Resources/icon.icns") {
  1655. // See if there is an icon.
  1656. String icon_path;
  1657. if (p_preset->get("application/icon") != "") {
  1658. icon_path = p_preset->get("application/icon");
  1659. } else if (GLOBAL_GET("application/config/macos_native_icon") != "") {
  1660. icon_path = GLOBAL_GET("application/config/macos_native_icon");
  1661. } else {
  1662. icon_path = GLOBAL_GET("application/config/icon");
  1663. }
  1664. if (!icon_path.is_empty()) {
  1665. if (icon_path.get_extension() == "icns") {
  1666. Ref<FileAccess> icon = FileAccess::open(icon_path, FileAccess::READ);
  1667. if (icon.is_valid()) {
  1668. data.resize(icon->get_length());
  1669. icon->get_buffer(&data.write[0], icon->get_length());
  1670. }
  1671. } else {
  1672. Ref<Image> icon;
  1673. icon.instantiate();
  1674. err = ImageLoader::load_image(icon_path, icon);
  1675. if (err == OK && !icon->is_empty()) {
  1676. _make_icon(p_preset, icon, data);
  1677. }
  1678. }
  1679. }
  1680. }
  1681. if (data.size() > 0) {
  1682. print_verbose("ADDING: " + file + " size: " + itos(data.size()));
  1683. // Write it into our application bundle.
  1684. file = tmp_app_path_name.path_join(file);
  1685. if (err == OK) {
  1686. err = tmp_app_dir->make_dir_recursive(file.get_base_dir());
  1687. if (err != OK) {
  1688. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), file.get_base_dir()));
  1689. }
  1690. }
  1691. if (err == OK) {
  1692. Ref<FileAccess> f = FileAccess::open(file, FileAccess::WRITE);
  1693. if (f.is_valid()) {
  1694. f->store_buffer(data.ptr(), data.size());
  1695. f.unref();
  1696. if (is_executable(file)) {
  1697. // chmod with 0755 if the file is executable.
  1698. FileAccess::set_unix_permissions(file, 0755);
  1699. }
  1700. } else {
  1701. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not open \"%s\"."), file));
  1702. err = ERR_CANT_CREATE;
  1703. }
  1704. }
  1705. }
  1706. ret = unzGoToNextFile(src_pkg_zip);
  1707. }
  1708. // We're done with our source zip.
  1709. unzClose(src_pkg_zip);
  1710. if (!found_binary) {
  1711. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Requested template binary \"%s\" not found. It might be missing from your template archive."), binary_to_use));
  1712. err = ERR_FILE_NOT_FOUND;
  1713. }
  1714. // Save console wrapper.
  1715. if (err == OK) {
  1716. int con_scr = p_preset->get("debug/export_console_wrapper");
  1717. if ((con_scr == 1 && p_debug) || (con_scr == 2)) {
  1718. err = _export_debug_script(p_preset, pkg_name, tmp_app_path_name.get_file() + "/Contents/MacOS/" + pkg_name, scr_path);
  1719. FileAccess::set_unix_permissions(scr_path, 0755);
  1720. if (err != OK) {
  1721. add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Could not create console wrapper."));
  1722. }
  1723. }
  1724. }
  1725. if (err == OK) {
  1726. if (ep.step(TTR("Making PKG"), 1)) {
  1727. return ERR_SKIP;
  1728. }
  1729. // See if we can code sign our new package.
  1730. bool sign_enabled = (p_preset->get("codesign/codesign").operator int() > 0);
  1731. bool ad_hoc = false;
  1732. int codesign_tool = p_preset->get("codesign/codesign");
  1733. switch (codesign_tool) {
  1734. case 1: { // built-in ad-hoc
  1735. ad_hoc = true;
  1736. } break;
  1737. case 2: { // "rcodesign"
  1738. ad_hoc = p_preset->get_or_env("codesign/certificate_file", ENV_MAC_CODESIGN_CERT_FILE).operator String().is_empty() || p_preset->get_or_env("codesign/certificate_password", ENV_MAC_CODESIGN_CERT_PASS).operator String().is_empty();
  1739. } break;
  1740. #ifdef MACOS_ENABLED
  1741. case 3: { // "codesign"
  1742. ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-");
  1743. } break;
  1744. #endif
  1745. default: {
  1746. };
  1747. }
  1748. String pack_path = tmp_app_path_name + "/Contents/Resources/" + pkg_name + ".pck";
  1749. Vector<SharedObject> shared_objects;
  1750. err = save_pack(p_preset, p_debug, pack_path, &shared_objects);
  1751. bool lib_validation = p_preset->get("codesign/entitlements/disable_library_validation");
  1752. if (!shared_objects.is_empty() && sign_enabled && ad_hoc && !lib_validation) {
  1753. add_message(EXPORT_MESSAGE_INFO, TTR("Entitlements Modified"), TTR("Ad-hoc signed applications require the 'Disable Library Validation' entitlement to load dynamic libraries."));
  1754. lib_validation = true;
  1755. }
  1756. if (!shared_objects.is_empty() && sign_enabled && codesign_tool == 2) {
  1757. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("'rcodesign' doesn't support signing applications with embedded dynamic libraries."));
  1758. }
  1759. bool sandbox = p_preset->get("codesign/entitlements/app_sandbox/enabled");
  1760. String ent_path = p_preset->get("codesign/entitlements/custom_file");
  1761. String hlp_ent_path = sandbox ? EditorPaths::get_singleton()->get_cache_dir().path_join(pkg_name + "_helper.entitlements") : ent_path;
  1762. if (sign_enabled && (ent_path.is_empty())) {
  1763. ent_path = EditorPaths::get_singleton()->get_cache_dir().path_join(pkg_name + ".entitlements");
  1764. Ref<FileAccess> ent_f = FileAccess::open(ent_path, FileAccess::WRITE);
  1765. if (ent_f.is_valid()) {
  1766. ent_f->store_line("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  1767. ent_f->store_line("<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">");
  1768. ent_f->store_line("<plist version=\"1.0\">");
  1769. ent_f->store_line("<dict>");
  1770. if (ClassDB::class_exists("CSharpScript")) {
  1771. // These entitlements are required to run managed code, and are always enabled in Mono builds.
  1772. ent_f->store_line("<key>com.apple.security.cs.allow-jit</key>");
  1773. ent_f->store_line("<true/>");
  1774. ent_f->store_line("<key>com.apple.security.cs.allow-unsigned-executable-memory</key>");
  1775. ent_f->store_line("<true/>");
  1776. ent_f->store_line("<key>com.apple.security.cs.allow-dyld-environment-variables</key>");
  1777. ent_f->store_line("<true/>");
  1778. } else {
  1779. if ((bool)p_preset->get("codesign/entitlements/allow_jit_code_execution")) {
  1780. ent_f->store_line("<key>com.apple.security.cs.allow-jit</key>");
  1781. ent_f->store_line("<true/>");
  1782. }
  1783. if ((bool)p_preset->get("codesign/entitlements/allow_unsigned_executable_memory")) {
  1784. ent_f->store_line("<key>com.apple.security.cs.allow-unsigned-executable-memory</key>");
  1785. ent_f->store_line("<true/>");
  1786. }
  1787. if ((bool)p_preset->get("codesign/entitlements/allow_dyld_environment_variables")) {
  1788. ent_f->store_line("<key>com.apple.security.cs.allow-dyld-environment-variables</key>");
  1789. ent_f->store_line("<true/>");
  1790. }
  1791. }
  1792. if (lib_validation) {
  1793. ent_f->store_line("<key>com.apple.security.cs.disable-library-validation</key>");
  1794. ent_f->store_line("<true/>");
  1795. }
  1796. if ((bool)p_preset->get("codesign/entitlements/audio_input")) {
  1797. ent_f->store_line("<key>com.apple.security.device.audio-input</key>");
  1798. ent_f->store_line("<true/>");
  1799. }
  1800. if ((bool)p_preset->get("codesign/entitlements/camera")) {
  1801. ent_f->store_line("<key>com.apple.security.device.camera</key>");
  1802. ent_f->store_line("<true/>");
  1803. }
  1804. if ((bool)p_preset->get("codesign/entitlements/location")) {
  1805. ent_f->store_line("<key>com.apple.security.personal-information.location</key>");
  1806. ent_f->store_line("<true/>");
  1807. }
  1808. if ((bool)p_preset->get("codesign/entitlements/address_book")) {
  1809. ent_f->store_line("<key>com.apple.security.personal-information.addressbook</key>");
  1810. ent_f->store_line("<true/>");
  1811. }
  1812. if ((bool)p_preset->get("codesign/entitlements/calendars")) {
  1813. ent_f->store_line("<key>com.apple.security.personal-information.calendars</key>");
  1814. ent_f->store_line("<true/>");
  1815. }
  1816. if ((bool)p_preset->get("codesign/entitlements/photos_library")) {
  1817. ent_f->store_line("<key>com.apple.security.personal-information.photos-library</key>");
  1818. ent_f->store_line("<true/>");
  1819. }
  1820. if ((bool)p_preset->get("codesign/entitlements/apple_events")) {
  1821. ent_f->store_line("<key>com.apple.security.automation.apple-events</key>");
  1822. ent_f->store_line("<true/>");
  1823. }
  1824. if ((bool)p_preset->get("codesign/entitlements/debugging")) {
  1825. ent_f->store_line("<key>com.apple.security.get-task-allow</key>");
  1826. ent_f->store_line("<true/>");
  1827. }
  1828. int dist_type = p_preset->get("export/distribution_type");
  1829. if (dist_type == 2) {
  1830. String pprof = p_preset->get_or_env("codesign/provisioning_profile", ENV_MAC_CODESIGN_PROFILE);
  1831. String teamid = p_preset->get("codesign/apple_team_id");
  1832. String bid = p_preset->get("application/bundle_identifier");
  1833. if (!pprof.is_empty() && !teamid.is_empty()) {
  1834. ent_f->store_line("<key>com.apple.developer.team-identifier</key>");
  1835. ent_f->store_line("<string>" + teamid + "</string>");
  1836. ent_f->store_line("<key>com.apple.application-identifier</key>");
  1837. ent_f->store_line("<string>" + teamid + "." + bid + "</string>");
  1838. }
  1839. }
  1840. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/enabled")) {
  1841. ent_f->store_line("<key>com.apple.security.app-sandbox</key>");
  1842. ent_f->store_line("<true/>");
  1843. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/network_server")) {
  1844. ent_f->store_line("<key>com.apple.security.network.server</key>");
  1845. ent_f->store_line("<true/>");
  1846. }
  1847. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/network_client")) {
  1848. ent_f->store_line("<key>com.apple.security.network.client</key>");
  1849. ent_f->store_line("<true/>");
  1850. }
  1851. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/device_usb")) {
  1852. ent_f->store_line("<key>com.apple.security.device.usb</key>");
  1853. ent_f->store_line("<true/>");
  1854. }
  1855. if ((bool)p_preset->get("codesign/entitlements/app_sandbox/device_bluetooth")) {
  1856. ent_f->store_line("<key>com.apple.security.device.bluetooth</key>");
  1857. ent_f->store_line("<true/>");
  1858. }
  1859. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_downloads") == 1) {
  1860. ent_f->store_line("<key>com.apple.security.files.downloads.read-only</key>");
  1861. ent_f->store_line("<true/>");
  1862. }
  1863. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_downloads") == 2) {
  1864. ent_f->store_line("<key>com.apple.security.files.downloads.read-write</key>");
  1865. ent_f->store_line("<true/>");
  1866. }
  1867. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_pictures") == 1) {
  1868. ent_f->store_line("<key>com.apple.security.files.pictures.read-only</key>");
  1869. ent_f->store_line("<true/>");
  1870. }
  1871. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_pictures") == 2) {
  1872. ent_f->store_line("<key>com.apple.security.files.pictures.read-write</key>");
  1873. ent_f->store_line("<true/>");
  1874. }
  1875. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_music") == 1) {
  1876. ent_f->store_line("<key>com.apple.security.files.music.read-only</key>");
  1877. ent_f->store_line("<true/>");
  1878. }
  1879. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_music") == 2) {
  1880. ent_f->store_line("<key>com.apple.security.files.music.read-write</key>");
  1881. ent_f->store_line("<true/>");
  1882. }
  1883. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_movies") == 1) {
  1884. ent_f->store_line("<key>com.apple.security.files.movies.read-only</key>");
  1885. ent_f->store_line("<true/>");
  1886. }
  1887. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_movies") == 2) {
  1888. ent_f->store_line("<key>com.apple.security.files.movies.read-write</key>");
  1889. ent_f->store_line("<true/>");
  1890. }
  1891. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_user_selected") == 1) {
  1892. ent_f->store_line("<key>com.apple.security.files.user-selected.read-only</key>");
  1893. ent_f->store_line("<true/>");
  1894. }
  1895. if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_user_selected") == 2) {
  1896. ent_f->store_line("<key>com.apple.security.files.user-selected.read-write</key>");
  1897. ent_f->store_line("<true/>");
  1898. }
  1899. }
  1900. ent_f->store_line("</dict>");
  1901. ent_f->store_line("</plist>");
  1902. } else {
  1903. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Could not create entitlements file."));
  1904. err = ERR_CANT_CREATE;
  1905. }
  1906. if ((err == OK) && sandbox && (helpers.size() > 0 || shared_objects.size() > 0)) {
  1907. ent_f = FileAccess::open(hlp_ent_path, FileAccess::WRITE);
  1908. if (ent_f.is_valid()) {
  1909. ent_f->store_line("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
  1910. ent_f->store_line("<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">");
  1911. ent_f->store_line("<plist version=\"1.0\">");
  1912. ent_f->store_line("<dict>");
  1913. ent_f->store_line("<key>com.apple.security.app-sandbox</key>");
  1914. ent_f->store_line("<true/>");
  1915. ent_f->store_line("<key>com.apple.security.inherit</key>");
  1916. ent_f->store_line("<true/>");
  1917. ent_f->store_line("</dict>");
  1918. ent_f->store_line("</plist>");
  1919. } else {
  1920. add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Could not create helper entitlements file."));
  1921. err = ERR_CANT_CREATE;
  1922. }
  1923. }
  1924. }
  1925. if ((err == OK) && helpers.size() > 0) {
  1926. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1927. for (int i = 0; i < helpers.size(); i++) {
  1928. String hlp_path = helpers[i];
  1929. err = da->copy(hlp_path, tmp_app_path_name + "/Contents/Helpers/" + hlp_path.get_file());
  1930. if (err == OK && sign_enabled) {
  1931. _code_sign(p_preset, tmp_app_path_name + "/Contents/Helpers/" + hlp_path.get_file(), hlp_ent_path, false, true);
  1932. }
  1933. FileAccess::set_unix_permissions(tmp_app_path_name + "/Contents/Helpers/" + hlp_path.get_file(), 0755);
  1934. }
  1935. }
  1936. if (err == OK) {
  1937. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1938. for (int i = 0; i < shared_objects.size(); i++) {
  1939. String src_path = ProjectSettings::get_singleton()->globalize_path(shared_objects[i].path);
  1940. if (shared_objects[i].target.is_empty()) {
  1941. String path_in_app = tmp_app_path_name + "/Contents/Frameworks/" + src_path.get_file();
  1942. err = _copy_and_sign_files(da, src_path, path_in_app, sign_enabled, p_preset, ent_path, hlp_ent_path, true, sandbox);
  1943. } else {
  1944. String path_in_app = tmp_app_path_name.path_join(shared_objects[i].target);
  1945. tmp_app_dir->make_dir_recursive(path_in_app);
  1946. err = _copy_and_sign_files(da, src_path, path_in_app.path_join(src_path.get_file()), sign_enabled, p_preset, ent_path, hlp_ent_path, false, sandbox);
  1947. }
  1948. if (err != OK) {
  1949. break;
  1950. }
  1951. }
  1952. Vector<Ref<EditorExportPlugin>> export_plugins{ EditorExport::get_singleton()->get_export_plugins() };
  1953. for (int i = 0; i < export_plugins.size(); ++i) {
  1954. err = _export_macos_plugins_for(export_plugins[i], tmp_app_path_name, da, sign_enabled, p_preset, ent_path, hlp_ent_path, sandbox);
  1955. if (err != OK) {
  1956. break;
  1957. }
  1958. }
  1959. }
  1960. if (err == OK && sign_enabled) {
  1961. int dist_type = p_preset->get("export/distribution_type");
  1962. if (dist_type == 2) {
  1963. String pprof = p_preset->get_or_env("codesign/provisioning_profile", ENV_MAC_CODESIGN_PROFILE).operator String();
  1964. if (!pprof.is_empty()) {
  1965. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1966. err = da->copy(pprof, tmp_app_path_name + "/Contents/embedded.provisionprofile");
  1967. }
  1968. }
  1969. if (ep.step(TTR("Code signing bundle"), 2)) {
  1970. return ERR_SKIP;
  1971. }
  1972. _code_sign(p_preset, tmp_app_path_name, ent_path, true, false);
  1973. }
  1974. String noto_path = p_path;
  1975. bool noto_enabled = (p_preset->get("notarization/notarization").operator int() > 0);
  1976. if (export_format == "dmg") {
  1977. // Create a DMG.
  1978. if (err == OK) {
  1979. if (ep.step(TTR("Making DMG"), 3)) {
  1980. return ERR_SKIP;
  1981. }
  1982. err = _create_dmg(p_path, pkg_name, tmp_base_path_name);
  1983. }
  1984. // Sign DMG.
  1985. if (err == OK && sign_enabled && !ad_hoc) {
  1986. if (ep.step(TTR("Code signing DMG"), 3)) {
  1987. return ERR_SKIP;
  1988. }
  1989. _code_sign(p_preset, p_path, ent_path, false, false);
  1990. }
  1991. } else if (export_format == "pkg") {
  1992. // Create a Installer.
  1993. if (err == OK) {
  1994. if (ep.step(TTR("Making PKG installer"), 3)) {
  1995. return ERR_SKIP;
  1996. }
  1997. err = _create_pkg(p_preset, p_path, tmp_app_path_name);
  1998. }
  1999. } else if (export_format == "zip") {
  2000. // Create ZIP.
  2001. if (err == OK) {
  2002. if (ep.step(TTR("Making ZIP"), 3)) {
  2003. return ERR_SKIP;
  2004. }
  2005. if (FileAccess::exists(p_path)) {
  2006. OS::get_singleton()->move_to_trash(p_path);
  2007. }
  2008. Ref<FileAccess> io_fa_dst;
  2009. zlib_filefunc_def io_dst = zipio_create_io(&io_fa_dst);
  2010. zipFile zip = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io_dst);
  2011. zip_folder_recursive(zip, tmp_base_path_name, "", pkg_name);
  2012. zipClose(zip, nullptr);
  2013. }
  2014. } else if (export_format == "app" && noto_enabled) {
  2015. // Create temporary ZIP.
  2016. if (err == OK) {
  2017. noto_path = EditorPaths::get_singleton()->get_cache_dir().path_join(pkg_name + ".zip");
  2018. if (ep.step(TTR("Making ZIP"), 3)) {
  2019. return ERR_SKIP;
  2020. }
  2021. if (FileAccess::exists(noto_path)) {
  2022. OS::get_singleton()->move_to_trash(noto_path);
  2023. }
  2024. Ref<FileAccess> io_fa_dst;
  2025. zlib_filefunc_def io_dst = zipio_create_io(&io_fa_dst);
  2026. zipFile zip = zipOpen2(noto_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io_dst);
  2027. zip_folder_recursive(zip, tmp_base_path_name, tmp_app_dir_name, pkg_name);
  2028. zipClose(zip, nullptr);
  2029. }
  2030. }
  2031. if (err == OK && noto_enabled) {
  2032. if (export_format == "pkg") {
  2033. add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("Notarization requires the app to be archived first, select the DMG or ZIP export format instead."));
  2034. } else {
  2035. if (ep.step(TTR("Sending archive for notarization"), 4)) {
  2036. return ERR_SKIP;
  2037. }
  2038. err = _notarize(p_preset, noto_path);
  2039. }
  2040. }
  2041. // Clean up temporary entitlements files.
  2042. if (FileAccess::exists(hlp_ent_path)) {
  2043. DirAccess::remove_file_or_error(hlp_ent_path);
  2044. }
  2045. // Clean up temporary .app dir and generated entitlements.
  2046. if ((String)(p_preset->get("codesign/entitlements/custom_file")) == "") {
  2047. tmp_app_dir->remove(ent_path);
  2048. }
  2049. if (export_format != "app") {
  2050. if (tmp_app_dir->change_dir(tmp_base_path_name) == OK) {
  2051. tmp_app_dir->erase_contents_recursive();
  2052. tmp_app_dir->change_dir("..");
  2053. tmp_app_dir->remove(pkg_name);
  2054. }
  2055. } else if (noto_path != p_path) {
  2056. if (FileAccess::exists(noto_path)) {
  2057. DirAccess::remove_file_or_error(noto_path);
  2058. }
  2059. }
  2060. }
  2061. return err;
  2062. }
  2063. bool EditorExportPlatformMacOS::has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const {
  2064. String err;
  2065. // Look for export templates (official templates first, then custom).
  2066. bool dvalid = exists_export_template("macos.zip", &err);
  2067. bool rvalid = dvalid; // Both in the same ZIP.
  2068. if (p_preset->get("custom_template/debug") != "") {
  2069. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  2070. if (!dvalid) {
  2071. err += TTR("Custom debug template not found.") + "\n";
  2072. }
  2073. }
  2074. if (p_preset->get("custom_template/release") != "") {
  2075. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  2076. if (!rvalid) {
  2077. err += TTR("Custom release template not found.") + "\n";
  2078. }
  2079. }
  2080. bool valid = dvalid || rvalid;
  2081. r_missing_templates = !valid;
  2082. // Check the texture formats, which vary depending on the target architecture.
  2083. String architecture = p_preset->get("binary_format/architecture");
  2084. if (architecture == "universal" || architecture == "x86_64") {
  2085. if (!ResourceImporterTextureSettings::should_import_s3tc_bptc()) {
  2086. err += TTR("Cannot export for universal or x86_64 if S3TC BPTC texture format is disabled. Enable it in the Project Settings (Rendering > Textures > VRAM Compression > Import S3TC BPTC).") + "\n";
  2087. valid = false;
  2088. }
  2089. }
  2090. if (architecture == "universal" || architecture == "arm64") {
  2091. if (!ResourceImporterTextureSettings::should_import_etc2_astc()) {
  2092. err += TTR("Cannot export for universal or arm64 if ETC2 ASTC texture format is disabled. Enable it in the Project Settings (Rendering > Textures > VRAM Compression > Import ETC2 ASTC).") + "\n";
  2093. valid = false;
  2094. }
  2095. }
  2096. if (architecture != "universal" && architecture != "x86_64" && architecture != "arm64") {
  2097. ERR_PRINT("Invalid architecture");
  2098. }
  2099. if (!err.is_empty()) {
  2100. r_error = err;
  2101. }
  2102. return valid;
  2103. }
  2104. bool EditorExportPlatformMacOS::has_valid_project_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error) const {
  2105. String err;
  2106. bool valid = true;
  2107. int dist_type = p_preset->get("export/distribution_type");
  2108. bool ad_hoc = false;
  2109. int codesign_tool = p_preset->get("codesign/codesign");
  2110. int notary_tool = p_preset->get("notarization/notarization");
  2111. switch (codesign_tool) {
  2112. case 1: { // built-in ad-hoc
  2113. ad_hoc = true;
  2114. } break;
  2115. case 2: { // "rcodesign"
  2116. ad_hoc = p_preset->get_or_env("codesign/certificate_file", ENV_MAC_CODESIGN_CERT_FILE).operator String().is_empty() || p_preset->get_or_env("codesign/certificate_password", ENV_MAC_CODESIGN_CERT_PASS).operator String().is_empty();
  2117. } break;
  2118. #ifdef MACOS_ENABLED
  2119. case 3: { // "codesign"
  2120. ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-");
  2121. } break;
  2122. #endif
  2123. default: {
  2124. };
  2125. }
  2126. const String &additional_plist_content = p_preset->get("application/additional_plist_content");
  2127. if (!additional_plist_content.is_empty()) {
  2128. const String &plist = vformat("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
  2129. "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">"
  2130. "<plist version=\"1.0\">"
  2131. "<dict>\n"
  2132. "%s\n"
  2133. "</dict>\n"
  2134. "</plist>\n",
  2135. additional_plist_content);
  2136. String plist_err;
  2137. Ref<PList> plist_parser;
  2138. plist_parser.instantiate();
  2139. if (!plist_parser->load_string(plist, plist_err)) {
  2140. err += TTR("Invalid additional PList content: ") + plist_err + "\n";
  2141. valid = false;
  2142. }
  2143. }
  2144. List<ExportOption> options;
  2145. get_export_options(&options);
  2146. for (const EditorExportPlatform::ExportOption &E : options) {
  2147. if (get_export_option_visibility(p_preset.ptr(), E.option.name)) {
  2148. String warn = get_export_option_warning(p_preset.ptr(), E.option.name);
  2149. if (!warn.is_empty()) {
  2150. err += warn + "\n";
  2151. if (E.required) {
  2152. valid = false;
  2153. }
  2154. }
  2155. }
  2156. }
  2157. if (dist_type != 2) {
  2158. if (notary_tool > 0) {
  2159. if (notary_tool == 2 || notary_tool == 3) {
  2160. if (!FileAccess::exists("/usr/bin/xcrun") && !FileAccess::exists("/bin/xcrun")) {
  2161. err += TTR("Notarization: Xcode command line tools are not installed.") + "\n";
  2162. valid = false;
  2163. }
  2164. } else if (notary_tool == 1) {
  2165. String rcodesign = EDITOR_GET("export/macos/rcodesign").operator String();
  2166. if (rcodesign.is_empty()) {
  2167. err += TTR("Notarization: rcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign).") + "\n";
  2168. valid = false;
  2169. }
  2170. }
  2171. } else {
  2172. err += TTR("Warning: Notarization is disabled. The exported project will be blocked by Gatekeeper if it's downloaded from an unknown source.") + "\n";
  2173. if (codesign_tool == 0) {
  2174. err += TTR("Code signing is disabled. The exported project will not run on Macs with enabled Gatekeeper and Apple Silicon powered Macs.") + "\n";
  2175. }
  2176. }
  2177. }
  2178. if (codesign_tool > 0) {
  2179. if (ad_hoc) {
  2180. err += TTR("Code signing: Using ad-hoc signature. The exported project will be blocked by Gatekeeper") + "\n";
  2181. }
  2182. if (codesign_tool == 3) {
  2183. if (!FileAccess::exists("/usr/bin/codesign") && !FileAccess::exists("/bin/codesign")) {
  2184. err += TTR("Code signing: Xcode command line tools are not installed.") + "\n";
  2185. valid = false;
  2186. }
  2187. } else if (codesign_tool == 2) {
  2188. String rcodesign = EDITOR_GET("export/macos/rcodesign").operator String();
  2189. if (rcodesign.is_empty()) {
  2190. err += TTR("Code signing: rcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign).") + "\n";
  2191. valid = false;
  2192. }
  2193. }
  2194. }
  2195. if (!err.is_empty()) {
  2196. r_error = err;
  2197. }
  2198. return valid;
  2199. }
  2200. Ref<Texture2D> EditorExportPlatformMacOS::get_run_icon() const {
  2201. return run_icon;
  2202. }
  2203. bool EditorExportPlatformMacOS::poll_export() {
  2204. Ref<EditorExportPreset> preset;
  2205. for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
  2206. Ref<EditorExportPreset> ep = EditorExport::get_singleton()->get_export_preset(i);
  2207. if (ep->is_runnable() && ep->get_platform() == this) {
  2208. preset = ep;
  2209. break;
  2210. }
  2211. }
  2212. int prev = menu_options;
  2213. menu_options = (preset.is_valid() && preset->get("ssh_remote_deploy/enabled").operator bool());
  2214. if (ssh_pid != 0 || !cleanup_commands.is_empty()) {
  2215. if (menu_options == 0) {
  2216. cleanup();
  2217. } else {
  2218. menu_options += 1;
  2219. }
  2220. }
  2221. return menu_options != prev;
  2222. }
  2223. Ref<ImageTexture> EditorExportPlatformMacOS::get_option_icon(int p_index) const {
  2224. return p_index == 1 ? stop_icon : EditorExportPlatform::get_option_icon(p_index);
  2225. }
  2226. int EditorExportPlatformMacOS::get_options_count() const {
  2227. return menu_options;
  2228. }
  2229. String EditorExportPlatformMacOS::get_option_label(int p_index) const {
  2230. return (p_index) ? TTR("Stop and uninstall") : TTR("Run on remote macOS system");
  2231. }
  2232. String EditorExportPlatformMacOS::get_option_tooltip(int p_index) const {
  2233. return (p_index) ? TTR("Stop and uninstall running project from the remote system") : TTR("Run exported project on remote macOS system");
  2234. }
  2235. void EditorExportPlatformMacOS::cleanup() {
  2236. if (ssh_pid != 0 && OS::get_singleton()->is_process_running(ssh_pid)) {
  2237. print_line("Terminating connection...");
  2238. OS::get_singleton()->kill(ssh_pid);
  2239. OS::get_singleton()->delay_usec(1000);
  2240. }
  2241. if (!cleanup_commands.is_empty()) {
  2242. print_line("Stopping and deleting previous version...");
  2243. for (const SSHCleanupCommand &cmd : cleanup_commands) {
  2244. if (cmd.wait) {
  2245. ssh_run_on_remote(cmd.host, cmd.port, cmd.ssh_args, cmd.cmd_args);
  2246. } else {
  2247. ssh_run_on_remote_no_wait(cmd.host, cmd.port, cmd.ssh_args, cmd.cmd_args);
  2248. }
  2249. }
  2250. }
  2251. ssh_pid = 0;
  2252. cleanup_commands.clear();
  2253. }
  2254. Error EditorExportPlatformMacOS::run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) {
  2255. cleanup();
  2256. if (p_device) { // Stop command, cleanup only.
  2257. return OK;
  2258. }
  2259. EditorProgress ep("run", TTR("Running..."), 5);
  2260. const String dest = EditorPaths::get_singleton()->get_cache_dir().path_join("macos");
  2261. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  2262. if (!da->dir_exists(dest)) {
  2263. Error err = da->make_dir_recursive(dest);
  2264. if (err != OK) {
  2265. EditorNode::get_singleton()->show_warning(TTR("Could not create temp directory:") + "\n" + dest);
  2266. return err;
  2267. }
  2268. }
  2269. String pkg_name;
  2270. if (String(ProjectSettings::get_singleton()->get("application/config/name")) != "") {
  2271. pkg_name = String(ProjectSettings::get_singleton()->get("application/config/name"));
  2272. } else {
  2273. pkg_name = "Unnamed";
  2274. }
  2275. pkg_name = OS::get_singleton()->get_safe_dir_name(pkg_name);
  2276. String host = p_preset->get("ssh_remote_deploy/host").operator String();
  2277. String port = p_preset->get("ssh_remote_deploy/port").operator String();
  2278. if (port.is_empty()) {
  2279. port = "22";
  2280. }
  2281. Vector<String> extra_args_ssh = p_preset->get("ssh_remote_deploy/extra_args_ssh").operator String().split(" ", false);
  2282. Vector<String> extra_args_scp = p_preset->get("ssh_remote_deploy/extra_args_scp").operator String().split(" ", false);
  2283. const String basepath = dest.path_join("tmp_macos_export");
  2284. #define CLEANUP_AND_RETURN(m_err) \
  2285. { \
  2286. if (da->file_exists(basepath + ".zip")) { \
  2287. da->remove(basepath + ".zip"); \
  2288. } \
  2289. if (da->file_exists(basepath + "_start.sh")) { \
  2290. da->remove(basepath + "_start.sh"); \
  2291. } \
  2292. if (da->file_exists(basepath + "_clean.sh")) { \
  2293. da->remove(basepath + "_clean.sh"); \
  2294. } \
  2295. return m_err; \
  2296. } \
  2297. ((void)0)
  2298. if (ep.step(TTR("Exporting project..."), 1)) {
  2299. return ERR_SKIP;
  2300. }
  2301. Error err = export_project(p_preset, true, basepath + ".zip", p_debug_flags);
  2302. if (err != OK) {
  2303. DirAccess::remove_file_or_error(basepath + ".zip");
  2304. return err;
  2305. }
  2306. String cmd_args;
  2307. {
  2308. Vector<String> cmd_args_list;
  2309. gen_debug_flags(cmd_args_list, p_debug_flags);
  2310. for (int i = 0; i < cmd_args_list.size(); i++) {
  2311. if (i != 0) {
  2312. cmd_args += " ";
  2313. }
  2314. cmd_args += cmd_args_list[i];
  2315. }
  2316. }
  2317. const bool use_remote = (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) || (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT);
  2318. int dbg_port = EditorSettings::get_singleton()->get("network/debug/remote_port");
  2319. print_line("Creating temporary directory...");
  2320. ep.step(TTR("Creating temporary directory..."), 2);
  2321. String temp_dir;
  2322. err = ssh_run_on_remote(host, port, extra_args_ssh, "mktemp -d", &temp_dir);
  2323. if (err != OK || temp_dir.is_empty()) {
  2324. CLEANUP_AND_RETURN(err);
  2325. }
  2326. print_line("Uploading archive...");
  2327. ep.step(TTR("Uploading archive..."), 3);
  2328. err = ssh_push_to_remote(host, port, extra_args_scp, basepath + ".zip", temp_dir);
  2329. if (err != OK) {
  2330. CLEANUP_AND_RETURN(err);
  2331. }
  2332. {
  2333. String run_script = p_preset->get("ssh_remote_deploy/run_script");
  2334. run_script = run_script.replace("{temp_dir}", temp_dir);
  2335. run_script = run_script.replace("{archive_name}", basepath.get_file() + ".zip");
  2336. run_script = run_script.replace("{exe_name}", pkg_name);
  2337. run_script = run_script.replace("{cmd_args}", cmd_args);
  2338. Ref<FileAccess> f = FileAccess::open(basepath + "_start.sh", FileAccess::WRITE);
  2339. if (f.is_null()) {
  2340. CLEANUP_AND_RETURN(err);
  2341. }
  2342. f->store_string(run_script);
  2343. }
  2344. {
  2345. String clean_script = p_preset->get("ssh_remote_deploy/cleanup_script");
  2346. clean_script = clean_script.replace("{temp_dir}", temp_dir);
  2347. clean_script = clean_script.replace("{archive_name}", basepath.get_file() + ".zip");
  2348. clean_script = clean_script.replace("{exe_name}", pkg_name);
  2349. clean_script = clean_script.replace("{cmd_args}", cmd_args);
  2350. Ref<FileAccess> f = FileAccess::open(basepath + "_clean.sh", FileAccess::WRITE);
  2351. if (f.is_null()) {
  2352. CLEANUP_AND_RETURN(err);
  2353. }
  2354. f->store_string(clean_script);
  2355. }
  2356. print_line("Uploading scripts...");
  2357. ep.step(TTR("Uploading scripts..."), 4);
  2358. err = ssh_push_to_remote(host, port, extra_args_scp, basepath + "_start.sh", temp_dir);
  2359. if (err != OK) {
  2360. CLEANUP_AND_RETURN(err);
  2361. }
  2362. err = ssh_run_on_remote(host, port, extra_args_ssh, vformat("chmod +x \"%s/%s\"", temp_dir, basepath.get_file() + "_start.sh"));
  2363. if (err != OK || temp_dir.is_empty()) {
  2364. CLEANUP_AND_RETURN(err);
  2365. }
  2366. err = ssh_push_to_remote(host, port, extra_args_scp, basepath + "_clean.sh", temp_dir);
  2367. if (err != OK) {
  2368. CLEANUP_AND_RETURN(err);
  2369. }
  2370. err = ssh_run_on_remote(host, port, extra_args_ssh, vformat("chmod +x \"%s/%s\"", temp_dir, basepath.get_file() + "_clean.sh"));
  2371. if (err != OK || temp_dir.is_empty()) {
  2372. CLEANUP_AND_RETURN(err);
  2373. }
  2374. print_line("Starting project...");
  2375. ep.step(TTR("Starting project..."), 5);
  2376. err = ssh_run_on_remote_no_wait(host, port, extra_args_ssh, vformat("\"%s/%s\"", temp_dir, basepath.get_file() + "_start.sh"), &ssh_pid, (use_remote) ? dbg_port : -1);
  2377. if (err != OK) {
  2378. CLEANUP_AND_RETURN(err);
  2379. }
  2380. cleanup_commands.clear();
  2381. cleanup_commands.push_back(SSHCleanupCommand(host, port, extra_args_ssh, vformat("\"%s/%s\"", temp_dir, basepath.get_file() + "_clean.sh")));
  2382. print_line("Project started.");
  2383. CLEANUP_AND_RETURN(OK);
  2384. #undef CLEANUP_AND_RETURN
  2385. }
  2386. EditorExportPlatformMacOS::EditorExportPlatformMacOS() {
  2387. if (EditorNode::get_singleton()) {
  2388. #ifdef MODULE_SVG_ENABLED
  2389. Ref<Image> img = memnew(Image);
  2390. const bool upsample = !Math::is_equal_approx(Math::round(EDSCALE), EDSCALE);
  2391. ImageLoaderSVG::create_image_from_string(img, _macos_logo_svg, EDSCALE, upsample, false);
  2392. logo = ImageTexture::create_from_image(img);
  2393. ImageLoaderSVG::create_image_from_string(img, _macos_run_icon_svg, EDSCALE, upsample, false);
  2394. run_icon = ImageTexture::create_from_image(img);
  2395. #endif
  2396. Ref<Theme> theme = EditorNode::get_singleton()->get_editor_theme();
  2397. if (theme.is_valid()) {
  2398. stop_icon = theme->get_icon(SNAME("Stop"), EditorStringName(EditorIcons));
  2399. } else {
  2400. stop_icon.instantiate();
  2401. }
  2402. }
  2403. }