export_plugin.cpp 108 KB

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