export_plugin.cpp 118 KB

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