export_plugin.cpp 117 KB

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