export_plugin.cpp 104 KB

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