export_plugin.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. /**************************************************************************/
  2. /* export_plugin.h */
  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. #pragma once
  31. #include "core/config/project_settings.h"
  32. #include "core/io/dir_access.h"
  33. #include "core/io/file_access.h"
  34. #include "core/io/image.h"
  35. #include "core/io/marshalls.h"
  36. #include "core/io/resource_saver.h"
  37. #include "core/os/os.h"
  38. #include "editor/editor_settings.h"
  39. #include "editor/export/editor_export.h"
  40. #include <sys/stat.h>
  41. // Optional environment variables for defining confidential information. If any
  42. // of these is set, they will override the values set in the credentials file.
  43. const String ENV_MAC_CODESIGN_CERT_FILE = "GODOT_MACOS_CODESIGN_CERTIFICATE_FILE";
  44. const String ENV_MAC_CODESIGN_CERT_PASS = "GODOT_MACOS_CODESIGN_CERTIFICATE_PASSWORD";
  45. const String ENV_MAC_CODESIGN_PROFILE = "GODOT_MACOS_CODESIGN_PROVISIONING_PROFILE";
  46. const String ENV_MAC_NOTARIZATION_UUID = "GODOT_MACOS_NOTARIZATION_API_UUID";
  47. const String ENV_MAC_NOTARIZATION_KEY = "GODOT_MACOS_NOTARIZATION_API_KEY";
  48. const String ENV_MAC_NOTARIZATION_KEY_ID = "GODOT_MACOS_NOTARIZATION_API_KEY_ID";
  49. const String ENV_MAC_NOTARIZATION_APPLE_ID = "GODOT_MACOS_NOTARIZATION_APPLE_ID_NAME";
  50. const String ENV_MAC_NOTARIZATION_APPLE_PASS = "GODOT_MACOS_NOTARIZATION_APPLE_ID_PASSWORD";
  51. class EditorExportPlatformMacOS : public EditorExportPlatform {
  52. GDCLASS(EditorExportPlatformMacOS, EditorExportPlatform);
  53. int version_code = 0;
  54. Ref<ImageTexture> logo;
  55. struct SSHCleanupCommand {
  56. String host;
  57. String port;
  58. Vector<String> ssh_args;
  59. String cmd_args;
  60. bool wait = false;
  61. SSHCleanupCommand() {}
  62. SSHCleanupCommand(const String &p_host, const String &p_port, const Vector<String> &p_ssh_arg, const String &p_cmd_args, bool p_wait = false) {
  63. host = p_host;
  64. port = p_port;
  65. ssh_args = p_ssh_arg;
  66. cmd_args = p_cmd_args;
  67. wait = p_wait;
  68. }
  69. };
  70. Ref<ImageTexture> run_icon;
  71. Ref<ImageTexture> stop_icon;
  72. Vector<SSHCleanupCommand> cleanup_commands;
  73. OS::ProcessID ssh_pid = 0;
  74. int menu_options = 0;
  75. void _fix_privacy_manifest(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &plist);
  76. void _fix_plist(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &plist, const String &p_binary);
  77. void _make_icon(const Ref<EditorExportPreset> &p_preset, const Ref<Image> &p_icon, Vector<uint8_t> &p_data);
  78. Error _notarize(const Ref<EditorExportPreset> &p_preset, const String &p_path);
  79. void _code_sign(const Ref<EditorExportPreset> &p_preset, const String &p_path, const String &p_ent_path, bool p_warn = true, bool p_set_id = false);
  80. void _code_sign_directory(const Ref<EditorExportPreset> &p_preset, const String &p_path, const String &p_ent_path, const String &p_helper_ent_path, bool p_should_error_on_non_code = true);
  81. Error _copy_and_sign_files(Ref<DirAccess> &dir_access, const String &p_src_path, const String &p_in_app_path,
  82. bool p_sign_enabled, const Ref<EditorExportPreset> &p_preset, const String &p_ent_path, const String &p_helper_ent_path,
  83. bool p_should_error_on_non_code_sign, bool p_sandbox);
  84. Error _export_macos_plugins_for(Ref<EditorExportPlugin> p_editor_export_plugin, const String &p_app_path_name,
  85. Ref<DirAccess> &dir_access, bool p_sign_enabled, const Ref<EditorExportPreset> &p_preset,
  86. const String &p_ent_path, const String &p_helper_ent_path, bool p_sandbox);
  87. Error _create_dmg(const String &p_dmg_path, const String &p_pkg_name, const String &p_app_path_name);
  88. Error _create_pkg(const Ref<EditorExportPreset> &p_preset, const String &p_pkg_path, const String &p_app_path_name);
  89. Error _export_debug_script(const Ref<EditorExportPreset> &p_preset, const String &p_app_name, const String &p_pkg_name, const String &p_path);
  90. bool use_codesign() const { return true; }
  91. bool is_package_name_valid(const String &p_package, String *r_error = nullptr) const {
  92. String pname = p_package;
  93. if (pname.length() == 0) {
  94. if (r_error) {
  95. *r_error = TTR("Identifier is missing.");
  96. }
  97. return false;
  98. }
  99. for (int i = 0; i < pname.length(); i++) {
  100. char32_t c = pname[i];
  101. if (!(is_ascii_alphanumeric_char(c) || c == '-' || c == '.')) {
  102. if (r_error) {
  103. *r_error = vformat(TTR("The character '%s' is not allowed in Identifier."), String::chr(c));
  104. }
  105. return false;
  106. }
  107. }
  108. return true;
  109. }
  110. bool is_shebang(const String &p_path) const;
  111. protected:
  112. virtual void get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) const override;
  113. virtual void get_export_options(List<ExportOption> *r_options) const override;
  114. virtual bool get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const override;
  115. virtual String get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const override;
  116. public:
  117. virtual String get_name() const override {
  118. return "macOS";
  119. }
  120. virtual String get_os_name() const override {
  121. return "macOS";
  122. }
  123. virtual Ref<Texture2D> get_logo() const override {
  124. return logo;
  125. }
  126. virtual bool is_executable(const String &p_path) const override;
  127. virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const override;
  128. virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, BitField<EditorExportPlatform::DebugFlags> p_flags = 0) override;
  129. virtual bool has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug = false) const override;
  130. virtual bool has_valid_project_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error) const override;
  131. virtual void get_platform_features(List<String> *r_features) const override {
  132. r_features->push_back("pc");
  133. r_features->push_back("s3tc");
  134. r_features->push_back("macos");
  135. }
  136. virtual void resolve_platform_feature_priorities(const Ref<EditorExportPreset> &p_preset, HashSet<String> &p_features) override {
  137. }
  138. virtual Ref<Texture2D> get_run_icon() const override;
  139. virtual bool poll_export() override;
  140. virtual Ref<ImageTexture> get_option_icon(int p_index) const override;
  141. virtual int get_options_count() const override;
  142. virtual String get_option_label(int p_index) const override;
  143. virtual String get_option_tooltip(int p_index) const override;
  144. virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, BitField<EditorExportPlatform::DebugFlags> p_debug_flags) override;
  145. virtual void cleanup() override;
  146. EditorExportPlatformMacOS();
  147. };