export_plugin.cpp 110 KB

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