/*************************************************************************/ /* export.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include "export.h" #include "codesign.h" #include "core/config/project_settings.h" #include "core/io/image_loader.h" #include "core/io/marshalls.h" #include "core/io/resource_saver.h" #include "core/io/zip_io.h" #include "core/os/dir_access.h" #include "core/os/file_access.h" #include "core/os/os.h" #include "core/version.h" #include "editor/editor_export.h" #include "editor/editor_node.h" #include "editor/editor_settings.h" #include "modules/modules_enabled.gen.h" // For regex. #include "platform/osx/logo.gen.h" #include class EditorExportPlatformOSX : public EditorExportPlatform { GDCLASS(EditorExportPlatformOSX, EditorExportPlatform); int version_code; Ref logo; void _fix_plist(const Ref &p_preset, Vector &plist, const String &p_binary); void _make_icon(const Ref &p_preset, const Ref &p_icon, Vector &p_data); Error _notarize(const Ref &p_preset, const String &p_path); Error _code_sign(const Ref &p_preset, const String &p_path, const String &p_ent_path); Error _code_sign_directory(const Ref &p_preset, const String &p_path, const String &p_ent_path, bool p_should_error_on_non_code = true); Error _copy_and_sign_files(DirAccessRef &dir_access, const String &p_src_path, const String &p_in_app_path, bool p_sign_enabled, const Ref &p_preset, const String &p_ent_path, bool p_should_error_on_non_code_sign); Error _export_osx_plugins_for(Ref p_editor_export_plugin, const String &p_app_path_name, DirAccessRef &dir_access, bool p_sign_enabled, const Ref &p_preset, const String &p_ent_path); Error _create_pkg(const Ref &p_preset, const String &p_pkg_path, const String &p_app_path_name); Error _create_dmg(const String &p_dmg_path, const String &p_pkg_name, const String &p_app_path_name); void _zip_folder_recursive(zipFile &p_zip, const String &p_root_path, const String &p_folder, const String &p_pkg_name); bool use_codesign() const { return true; } #ifdef OSX_ENABLED bool use_dmg() const { return true; } #else bool use_dmg() const { return false; } #endif bool is_package_name_valid(const String &p_package, String *r_error = nullptr) const { String pname = p_package; if (pname.length() == 0) { if (r_error) { *r_error = TTR("Identifier is missing."); } return false; } for (int i = 0; i < pname.length(); i++) { char32_t c = pname[i]; if (!((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9') || c == '-' || c == '.')) { if (r_error) { *r_error = vformat(TTR("The character '%s' is not allowed in Identifier."), String::chr(c)); } return false; } } return true; } protected: virtual void get_preset_features(const Ref &p_preset, List *r_features); virtual void get_export_options(List *r_options); virtual bool get_option_visibility(const EditorExportPreset *p_preset, const String &p_option, const RBMap &p_options) const; public: virtual String get_name() const { return "Mac OSX"; } virtual String get_os_name() const { return "OSX"; } virtual Ref get_logo() const { return logo; } virtual List get_binary_extensions(const Ref &p_preset) const { List list; if (p_preset.is_valid()) { int dist_type = p_preset->get("export/distribution_type"); if (dist_type == 0) { #ifdef OSX_ENABLED list.push_back("dmg"); #endif list.push_back("zip"); #ifndef WINDOWS_ENABLED list.push_back("app"); #endif } else if (dist_type == 1) { #ifdef OSX_ENABLED list.push_back("dmg"); #endif list.push_back("zip"); } else if (dist_type == 2) { #ifdef OSX_ENABLED list.push_back("pkg"); #endif } } return list; } virtual Error export_project(const Ref &p_preset, bool p_debug, const String &p_path, int p_flags = 0); virtual bool has_valid_export_configuration(const Ref &p_preset, String &r_error, bool &r_missing_templates) const; virtual bool has_valid_project_configuration(const Ref &p_preset, String &r_error) const; virtual void get_platform_features(List *r_features) { r_features->push_back("pc"); r_features->push_back("s3tc"); r_features->push_back("OSX"); } virtual void resolve_platform_feature_priorities(const Ref &p_preset, RBSet &p_features) { } EditorExportPlatformOSX(); ~EditorExportPlatformOSX(); }; void EditorExportPlatformOSX::get_preset_features(const Ref &p_preset, List *r_features) { if (p_preset->get("texture_format/s3tc")) { r_features->push_back("s3tc"); } if (p_preset->get("texture_format/etc")) { r_features->push_back("etc"); } if (p_preset->get("texture_format/etc2")) { r_features->push_back("etc2"); } r_features->push_back("64"); } bool EditorExportPlatformOSX::get_option_visibility(const EditorExportPreset *p_preset, const String &p_option, const RBMap &p_options) const { // Hide irrelevant code signing options. if (p_preset) { int codesign_tool = p_preset->get("codesign/codesign"); switch (codesign_tool) { case 1: { // built-in ad-hoc 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") { return false; } } break; case 2: { // "rcodesign" if (p_option == "codesign/identity") { return false; } } break; #ifdef OSX_ENABLED case 3: { // "codesign" if (p_option == "codesign/certificate_file" || p_option == "codesign/certificate_password") { return false; } } break; #endif default: { // disabled 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") { return false; } } break; } // Distribution type. int dist_type = p_preset->get("export/distribution_type"); if (dist_type != 2 && p_option == "codesign/installer_identity") { return false; } if (dist_type == 2 && p_option.begins_with("notarization/")) { return false; } if (dist_type != 2 && p_option == "codesign/provisioning_profile") { return false; } String custom_prof = p_preset->get("codesign/entitlements/custom_file"); if (custom_prof != "" && p_option != "codesign/entitlements/custom_file" && p_option.begins_with("codesign/entitlements/")) { return false; } // Hide sandbox entitlements. bool sandbox = p_preset->get("codesign/entitlements/app_sandbox/enabled"); if (!sandbox && p_option != "codesign/entitlements/app_sandbox/enabled" && p_option.begins_with("codesign/entitlements/app_sandbox/")) { return false; } // Hide irrelevant notarization options. int notary_tool = p_preset->get("notarization/notarization"); switch (notary_tool) { case 1: { // "rcodesign" if (p_option == "notarization/apple_id_name" || p_option == "notarization/apple_id_password") { return false; } } break; case 2: { // "notarytool" // All options are visible. } break; case 3: { // "altool" // All options are visible. } break; default: { // disabled 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") { return false; } } break; } } return true; } void EditorExportPlatformOSX::get_export_options(List *r_options) { #ifdef OSX_ENABLED r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "export/distribution_type", PROPERTY_HINT_ENUM, "Testing,Distribution,App Store"), 1, true)); #else r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "export/distribution_type", PROPERTY_HINT_ENUM, "Testing,Distribution"), 1, true)); #endif r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Game Name"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/icon", PROPERTY_HINT_FILE, "*.icns,*.png,*.webp,*.svg"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/icon_interpolation", PROPERTY_HINT_ENUM, "Nearest neighbor,Bilinear,Cubic,Trilinear,Lanczos"), 4)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/identifier", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.game"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/signature"), "")); 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")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/short_version"), "1.0")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/version"), "1.0")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/copyright"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/min_macos_version"), "10.12")); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "display/high_res"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/platform_build"), "14C18")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/sdk_version"), "13.1")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/sdk_build"), "22C55")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/sdk_name"), "macosx13.1")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/xcode_version"), "1420")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "xcode/xcode_build"), "14C18")); #ifdef OSX_ENABLED r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/codesign", PROPERTY_HINT_ENUM, "Disabled,Built-in (ad-hoc only),rcodesign,Xcode codesign"), 3, true)); #else r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/codesign", PROPERTY_HINT_ENUM, "Disabled,Built-in (ad-hoc only),rcodesign"), 1, true)); #endif r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/installer_identity", PROPERTY_HINT_PLACEHOLDER_TEXT, "3rd Party Mac Developer Installer: (ID)"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/apple_team_id", PROPERTY_HINT_PLACEHOLDER_TEXT, "ID"), "")); // "codesign" only options: r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/identity", PROPERTY_HINT_PLACEHOLDER_TEXT, "Type: Name (ID)"), "")); // "rcodesign" only options: r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/certificate_file", PROPERTY_HINT_GLOBAL_FILE, "*.pfx,*.p12"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/certificate_password"), "")); // "codesign" and "rcodesign" only options: r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/provisioning_profile", PROPERTY_HINT_GLOBAL_FILE, "*.provisionprofile"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "codesign/entitlements/custom_file", PROPERTY_HINT_GLOBAL_FILE, "*.plist"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_jit_code_execution"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_unsigned_executable_memory"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/allow_dyld_environment_variables"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/disable_library_validation"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/audio_input"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/camera"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/location"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/address_book"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/calendars"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/photos_library"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/apple_events"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/debugging"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/enabled"), false, true)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/network_server"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/network_client"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/device_usb"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "codesign/entitlements/app_sandbox/device_bluetooth"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_downloads", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_pictures", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_music", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_movies", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "codesign/entitlements/app_sandbox/files_user_selected", PROPERTY_HINT_ENUM, "No,Read-only,Read-write"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::POOL_STRING_ARRAY, "codesign/custom_options"), PoolStringArray())); #ifdef OSX_ENABLED r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "notarization/notarization", PROPERTY_HINT_ENUM, "Disabled,rcodesign,Xcode notarytool,Xcode altool (deprecated)"), 0, true)); #else r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "notarization/notarization", PROPERTY_HINT_ENUM, "Disabled,rcodesign"), 0, true)); #endif // "altool" and "notarytool" only options: r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_id_name", PROPERTY_HINT_PLACEHOLDER_TEXT, "Apple ID email"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/apple_id_password", PROPERTY_HINT_PLACEHOLDER_TEXT, "Enable two-factor authentication and provide app-specific password"), "")); // "altool" and "rcodesign" only options: r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/api_uuid", PROPERTY_HINT_PLACEHOLDER_TEXT, "App Store Connect issuer ID"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/api_key", PROPERTY_HINT_GLOBAL_FILE, "*.p8"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "notarization/api_key_id", PROPERTY_HINT_PLACEHOLDER_TEXT, "App Store Connect API key ID"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); 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"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/s3tc"), true)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/etc"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "texture_format/etc2"), false)); } void _rgba8_to_packbits_encode(int p_ch, int p_size, PoolVector &p_source, Vector &p_dest) { int src_len = p_size * p_size; Vector result; result.resize(src_len * 1.25); //temp vector for rle encoded data, make it 25% larger for worst case scenario int res_size = 0; uint8_t buf[128]; int buf_size = 0; int i = 0; while (i < src_len) { uint8_t cur = p_source.read()[i * 4 + p_ch]; if (i < src_len - 2) { if ((p_source.read()[(i + 1) * 4 + p_ch] == cur) && (p_source.read()[(i + 2) * 4 + p_ch] == cur)) { if (buf_size > 0) { result.write[res_size++] = (uint8_t)(buf_size - 1); memcpy(&result.write[res_size], &buf, buf_size); res_size += buf_size; buf_size = 0; } uint8_t lim = i + 130 >= src_len ? src_len - i - 1 : 130; bool hit_lim = true; for (int j = 3; j <= lim; j++) { if (p_source.read()[(i + j) * 4 + p_ch] != cur) { hit_lim = false; i = i + j - 1; result.write[res_size++] = (uint8_t)(j - 3 + 0x80); result.write[res_size++] = cur; break; } } if (hit_lim) { result.write[res_size++] = (uint8_t)(lim - 3 + 0x80); result.write[res_size++] = cur; i = i + lim; } } else { buf[buf_size++] = cur; if (buf_size == 128) { result.write[res_size++] = (uint8_t)(buf_size - 1); memcpy(&result.write[res_size], &buf, buf_size); res_size += buf_size; buf_size = 0; } } } else { buf[buf_size++] = cur; result.write[res_size++] = (uint8_t)(buf_size - 1); memcpy(&result.write[res_size], &buf, buf_size); res_size += buf_size; buf_size = 0; } i++; } int ofs = p_dest.size(); p_dest.resize(p_dest.size() + res_size); memcpy(&p_dest.write[ofs], result.ptr(), res_size); } void EditorExportPlatformOSX::_make_icon(const Ref &p_preset, const Ref &p_icon, Vector &p_data) { Ref it = memnew(ImageTexture); Vector data; data.resize(8); data.write[0] = 'i'; data.write[1] = 'c'; data.write[2] = 'n'; data.write[3] = 's'; struct MacOSIconInfo { const char *name; const char *mask_name; bool is_png; int size; }; static const MacOSIconInfo icon_infos[] = { { "ic10", "", true, 1024 }, //1024x1024 32-bit PNG and 512x512@2x 32-bit "retina" PNG { "ic09", "", true, 512 }, //512×512 32-bit PNG { "ic14", "", true, 512 }, //256x256@2x 32-bit "retina" PNG { "ic08", "", true, 256 }, //256×256 32-bit PNG { "ic13", "", true, 256 }, //128x128@2x 32-bit "retina" PNG { "ic07", "", true, 128 }, //128x128 32-bit PNG { "ic12", "", true, 64 }, //32x32@2x 32-bit "retina" PNG { "ic11", "", true, 32 }, //16x16@2x 32-bit "retina" PNG { "il32", "l8mk", false, 32 }, //32x32 24-bit RLE + 8-bit uncompressed mask { "is32", "s8mk", false, 16 } //16x16 24-bit RLE + 8-bit uncompressed mask }; for (uint64_t i = 0; i < (sizeof(icon_infos) / sizeof(icon_infos[0])); ++i) { Ref copy = p_icon; // does this make sense? doesn't this just increase the reference count instead of making a copy? Do we even need a copy? copy->convert(Image::FORMAT_RGBA8); copy->resize(icon_infos[i].size, icon_infos[i].size, (Image::Interpolation)(p_preset->get("application/icon_interpolation").operator int())); if (icon_infos[i].is_png) { // Encode PNG icon. it->create_from_image(copy); String path = EditorSettings::get_singleton()->get_cache_dir().plus_file("icon.png"); ResourceSaver::save(path, it); FileAccess *f = FileAccess::open(path, FileAccess::READ); if (!f) { // Clean up generated file. DirAccess::remove_file_or_error(path); add_message(EXPORT_MESSAGE_ERROR, TTR("Icon Creation"), vformat(TTR("Could not open icon file \"%s\"."), path)); return; } int ofs = data.size(); uint64_t len = f->get_len(); data.resize(data.size() + len + 8); f->get_buffer(&data.write[ofs + 8], len); memdelete(f); len += 8; len = BSWAP32(len); memcpy(&data.write[ofs], icon_infos[i].name, 4); encode_uint32(len, &data.write[ofs + 4]); // Clean up generated file. DirAccess::remove_file_or_error(path); } else { PoolVector src_data = copy->get_data(); //encode 24bit RGB RLE icon { int ofs = data.size(); data.resize(data.size() + 8); _rgba8_to_packbits_encode(0, icon_infos[i].size, src_data, data); // encode R _rgba8_to_packbits_encode(1, icon_infos[i].size, src_data, data); // encode G _rgba8_to_packbits_encode(2, icon_infos[i].size, src_data, data); // encode B int len = data.size() - ofs; len = BSWAP32(len); memcpy(&data.write[ofs], icon_infos[i].name, 4); encode_uint32(len, &data.write[ofs + 4]); } //encode 8bit mask uncompressed icon { int ofs = data.size(); int len = copy->get_width() * copy->get_height(); data.resize(data.size() + len + 8); for (int j = 0; j < len; j++) { data.write[ofs + 8 + j] = src_data.read()[j * 4 + 3]; } len += 8; len = BSWAP32(len); memcpy(&data.write[ofs], icon_infos[i].mask_name, 4); encode_uint32(len, &data.write[ofs + 4]); } } } uint32_t total_len = data.size(); total_len = BSWAP32(total_len); encode_uint32(total_len, &data.write[4]); p_data = data; } void EditorExportPlatformOSX::_fix_plist(const Ref &p_preset, Vector &plist, const String &p_binary) { String str; String strnew; str.parse_utf8((const char *)plist.ptr(), plist.size()); Vector lines = str.split("\n"); for (int i = 0; i < lines.size(); i++) { if (lines[i].find("$binary") != -1) { strnew += lines[i].replace("$binary", p_binary) + "\n"; } else if (lines[i].find("$name") != -1) { strnew += lines[i].replace("$name", p_binary) + "\n"; } else if (lines[i].find("$identifier") != -1) { strnew += lines[i].replace("$identifier", p_preset->get("application/identifier")) + "\n"; } else if (lines[i].find("$short_version") != -1) { strnew += lines[i].replace("$short_version", p_preset->get("application/short_version")) + "\n"; } else if (lines[i].find("$version") != -1) { strnew += lines[i].replace("$version", p_preset->get("application/version")) + "\n"; } else if (lines[i].find("$signature") != -1) { strnew += lines[i].replace("$signature", p_preset->get("application/signature")) + "\n"; } else if (lines[i].find("$app_category") != -1) { String cat = p_preset->get("application/app_category"); strnew += lines[i].replace("$app_category", cat.to_lower()) + "\n"; } else if (lines[i].find("$copyright") != -1) { strnew += lines[i].replace("$copyright", p_preset->get("application/copyright")) + "\n"; } else if (lines[i].find("$min_version") != -1) { strnew += lines[i].replace("$min_version", p_preset->get("application/min_macos_version")) + "\n"; } else if (lines[i].find("$highres") != -1) { strnew += lines[i].replace("$highres", p_preset->get("display/high_res") ? "\t" : "\t") + "\n"; } else if (lines[i].find("$platfbuild") != -1) { strnew += lines[i].replace("$platfbuild", p_preset->get("xcode/platform_build")) + "\n"; } else if (lines[i].find("$sdkver") != -1) { strnew += lines[i].replace("$sdkver", p_preset->get("xcode/sdk_version")) + "\n"; } else if (lines[i].find("$sdkname") != -1) { strnew += lines[i].replace("$sdkname", p_preset->get("xcode/sdk_name")) + "\n"; } else if (lines[i].find("$sdkbuild") != -1) { strnew += lines[i].replace("$sdkbuild", p_preset->get("xcode/sdk_build")) + "\n"; } else if (lines[i].find("$xcodever") != -1) { strnew += lines[i].replace("$xcodever", p_preset->get("xcode/xcode_version")) + "\n"; } else if (lines[i].find("$xcodebuild") != -1) { strnew += lines[i].replace("$xcodebuild", p_preset->get("xcode/xcode_build")) + "\n"; } else if (lines[i].find("$usage_descriptions") != -1) { String descriptions; if (!((String)p_preset->get("privacy/microphone_usage_description")).empty()) { descriptions += "\tNSMicrophoneUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/microphone_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/camera_usage_description")).empty()) { descriptions += "\tNSCameraUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/camera_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/location_usage_description")).empty()) { descriptions += "\tNSLocationUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/location_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/address_book_usage_description")).empty()) { descriptions += "\tNSContactsUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/address_book_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/calendar_usage_description")).empty()) { descriptions += "\tNSCalendarsUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/calendar_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/photos_library_usage_description")).empty()) { descriptions += "\tNSPhotoLibraryUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/photos_library_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/desktop_folder_usage_description")).empty()) { descriptions += "\tNSDesktopFolderUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/desktop_folder_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/documents_folder_usage_description")).empty()) { descriptions += "\tNSDocumentsFolderUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/documents_folder_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/downloads_folder_usage_description")).empty()) { descriptions += "\tNSDownloadsFolderUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/downloads_folder_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/network_volumes_usage_description")).empty()) { descriptions += "\tNSNetworkVolumesUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/network_volumes_usage_description") + "\n"; } if (!((String)p_preset->get("privacy/removable_volumes_usage_description")).empty()) { descriptions += "\tNSRemovableVolumesUsageDescription\n"; descriptions += "\t" + (String)p_preset->get("privacy/removable_volumes_usage_description") + "\n"; } if (!descriptions.empty()) { strnew += lines[i].replace("$usage_descriptions", descriptions); } } else { strnew += lines[i] + "\n"; } } CharString cs = strnew.utf8(); plist.resize(cs.size() - 1); for (int i = 0; i < cs.size() - 1; i++) { plist.write[i] = cs[i]; } } /** If we're running the OSX version of the Pandemonium editor we'll: - export our application bundle to a temporary folder - attempt to code sign it - and then wrap it up in a DMG **/ Error EditorExportPlatformOSX::_notarize(const Ref &p_preset, const String &p_path) { int notary_tool = p_preset->get("notarization/notarization"); switch (notary_tool) { case 1: { // "rcodesign" print_verbose("using rcodesign notarization..."); String rcodesign = EditorSettings::get_singleton()->get("export/macos/rcodesign").operator String(); if (rcodesign.empty()) { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("rcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign).")); return Error::FAILED; } List args; args.push_back("notary-submit"); if (p_preset->get("notarization/api_uuid") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect issuer ID name not specified.")); return Error::FAILED; } if (p_preset->get("notarization/api_key") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect API key ID not specified.")); return Error::FAILED; } args.push_back("--api-issuer"); args.push_back(p_preset->get("notarization/api_uuid")); args.push_back("--api-key"); args.push_back(p_preset->get("notarization/api_key_id")); if (p_preset->get("notarization/api_key") != "") { args.push_back("--api-key-path"); args.push_back(p_preset->get("notarization/api_key")); } args.push_back(p_path); String str; int exitcode = 0; Error err = OS::get_singleton()->execute(rcodesign, args, true, NULL, &str, &exitcode, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Could not start rcodesign executable.")); return err; } int rq_offset = str.find("created submission ID:"); if (exitcode != 0 || rq_offset == -1) { print_line("rcodesign (" + p_path + "):\n" + str); add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Notarization failed, see editor log for details.")); return Error::FAILED; } else { print_verbose("rcodesign (" + p_path + "):\n" + str); int next_nl = str.find("\n", rq_offset); String request_uuid = (next_nl == -1) ? str.substr(rq_offset + 14, -1) : str.substr(rq_offset + 14, next_nl - rq_offset - 14); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), vformat(TTR("Notarization request UUID: \"%s\""), request_uuid)); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("The notarization process generally takes less than an hour.")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("You can check progress manually by opening a Terminal and running the following command:")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"rcodesign notary-log --api-issuer --api-key \""); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("Run the following command to staple the notarization ticket to the exported application (optional):")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"rcodesign staple \""); } } break; #ifdef OSX_ENABLED case 2: { // "notarytool" print_verbose("using notarytool notarization..."); if (!FileAccess::exists("/usr/bin/xcrun") && !FileAccess::exists("/bin/xcrun")) { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Xcode command line tools are not installed.")); return Error::FAILED; } List args; args.push_back("notarytool"); args.push_back("submit"); args.push_back(p_path); if (p_preset->get("notarization/apple_id_name") == "" && p_preset->get("notarization/api_uuid") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Neither Apple ID name nor App Store Connect issuer ID name not specified.")); return Error::FAILED; } if (p_preset->get("notarization/apple_id_name") != "" && p_preset->get("notarization/api_uuid") != "") { 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.")); return Error::FAILED; } if (p_preset->get("notarization/apple_id_name") != "") { if (p_preset->get("notarization/apple_id_password") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Apple ID password not specified.")); return Error::FAILED; } args.push_back("--apple-id"); args.push_back(p_preset->get("notarization/apple_id_name")); args.push_back("--password"); args.push_back(p_preset->get("notarization/apple_id_password")); } else { if (p_preset->get("notarization/api_key_id") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect API key ID not specified.")); return Error::FAILED; } args.push_back("--issuer"); args.push_back(p_preset->get("notarization/api_uuid")); if (p_preset->get("notarization/api_key") != "") { args.push_back("--key"); args.push_back(p_preset->get("notarization/api_key")); } args.push_back("--key-id"); args.push_back(p_preset->get("notarization/api_key_id")); } args.push_back("--no-progress"); if (p_preset->get("codesign/apple_team_id")) { args.push_back("--team-id"); args.push_back(p_preset->get("codesign/apple_team_id")); } String str; int exitcode = 0; Error err = OS::get_singleton()->execute("xcrun", args, true, NULL, &str, &exitcode, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Could not start xcrun executable.")); return err; } int rq_offset = str.find("id:"); if (exitcode != 0 || rq_offset == -1) { print_line("notarytool (" + p_path + "):\n" + str); add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Notarization failed, see editor log for details.")); return Error::FAILED; } else { print_verbose("notarytool (" + p_path + "):\n" + str); int next_nl = str.find("\n", rq_offset); String request_uuid = (next_nl == -1) ? str.substr(rq_offset + 4, -1) : str.substr(rq_offset + 4, next_nl - rq_offset - 4); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), vformat(TTR("Notarization request UUID: \"%s\""), request_uuid)); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("The notarization process generally takes less than an hour.")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("You can check progress manually by opening a Terminal and running the following command:")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun notarytool log --issuer --key-id --key \" or"); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun notarytool log --apple-id --password >\""); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("Run the following command to staple the notarization ticket to the exported application (optional):")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun stapler staple \""); } } break; case 3: { // "altool" print_verbose("using altool notarization..."); if (!FileAccess::exists("/usr/bin/xcrun") && !FileAccess::exists("/bin/xcrun")) { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Xcode command line tools are not installed.")); return Error::FAILED; } List args; args.push_back("altool"); args.push_back("--notarize-app"); args.push_back("--primary-bundle-id"); args.push_back(p_preset->get("application/bundle_identifier")); if (p_preset->get("notarization/apple_id_name") == "" && p_preset->get("notarization/api_uuid") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Neither Apple ID name nor App Store Connect issuer ID name not specified.")); return Error::FAILED; } if (p_preset->get("notarization/apple_id_name") != "" && p_preset->get("notarization/api_uuid") != "") { 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.")); return Error::FAILED; } if (p_preset->get("notarization/apple_id_name") != "") { if (p_preset->get("notarization/apple_id_password") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("Apple ID password not specified.")); return Error::FAILED; } args.push_back("--username"); args.push_back(p_preset->get("notarization/apple_id_name")); args.push_back("--password"); args.push_back(p_preset->get("notarization/apple_id_password")); } else { if (p_preset->get("notarization/api_key") == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Notarization"), TTR("App Store Connect API key ID not specified.")); return Error::FAILED; } args.push_back("--apiIssuer"); args.push_back(p_preset->get("notarization/api_uuid")); args.push_back("--apiKey"); args.push_back(p_preset->get("notarization/api_key_id")); } args.push_back("--type"); args.push_back("osx"); if (p_preset->get("codesign/apple_team_id")) { args.push_back("--asc-provider"); args.push_back(p_preset->get("codesign/apple_team_id")); } args.push_back("--file"); args.push_back(p_path); String str; int exitcode = 0; Error err = OS::get_singleton()->execute("xcrun", args, true, NULL, &str, &exitcode, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Could not start xcrun executable.")); return err; } int rq_offset = str.find("RequestUUID"); if (exitcode != 0 || rq_offset == -1) { print_line("xcrun altool (" + p_path + "):\n" + str); add_message(EXPORT_MESSAGE_WARNING, TTR("Notarization"), TTR("Notarization failed, see editor log for details.")); return Error::FAILED; } else { print_verbose("xcrun altool (" + p_path + "):\n" + str); int next_nl = str.find("\n", rq_offset); String request_uuid = (next_nl == -1) ? str.substr(rq_offset + 14, -1) : str.substr(rq_offset + 14, next_nl - rq_offset - 14); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), vformat(TTR("Notarization request UUID: \"%s\""), request_uuid)); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("The notarization process generally takes less than an hour. When the process is completed, you'll receive an email.")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("You can check progress manually by opening a Terminal and running the following command:")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun altool --notarization-history 0 -u -p \""); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t" + TTR("Run the following command to staple the notarization ticket to the exported application (optional):")); add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), "\t\t\"xcrun stapler staple \""); } } break; #endif default: { }; } return OK; } Error EditorExportPlatformOSX::_code_sign(const Ref &p_preset, const String &p_path, const String &p_ent_path) { int codesign_tool = p_preset->get("codesign/codesign"); switch (codesign_tool) { case 1: { // built-in ad-hoc print_verbose("using built-in codesign..."); #ifdef MODULE_REGEX_ENABLED String error_msg; Error err = CodeSign::codesign(false, true, p_path, p_ent_path, error_msg); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("Built-in CodeSign failed with error \"%s\"."), error_msg)); return Error::FAILED; } #else add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Built-in CodeSign require regex module.")); #endif } break; case 2: { // "rcodesign" print_verbose("using rcodesign codesign..."); String rcodesign = EditorSettings::get_singleton()->get("export/macos/rcodesign").operator String(); if (rcodesign.empty()) { add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Xrcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign).")); return Error::FAILED; } List args; args.push_back("sign"); if (p_path.get_extension() != "dmg") { args.push_back("--entitlements-xml-path"); args.push_back(p_ent_path); } String certificate_file = p_preset->get("codesign/certificate_file"); String certificate_pass = p_preset->get("codesign/certificate_password"); if (!certificate_file.empty() && !certificate_file.empty()) { args.push_back("--p12-file"); args.push_back(certificate_file); args.push_back("--p12-password"); args.push_back(certificate_pass); } args.push_back("-v"); /* provide some more feedback */ args.push_back(p_path); String str; int exitcode = 0; Error err = OS::get_singleton()->execute(rcodesign, args, true, NULL, &str, &exitcode, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start rcodesign executable.")); return err; } if (exitcode != 0) { print_line("rcodesign (" + p_path + "):\n" + str); add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Code signing failed, see editor log for details.")); return Error::FAILED; } else { print_verbose("rcodesign (" + p_path + "):\n" + str); } } break; #ifdef OSX_ENABLED case 3: { // "codesign" print_verbose("using xcode codesign..."); if (!FileAccess::exists("/usr/bin/codesign") && !FileAccess::exists("/bin/codesign")) { add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Xcode command line tools are not installed.")); return Error::FAILED; } bool ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-"); List args; if (!ad_hoc) { args.push_back("--timestamp"); args.push_back("--options"); args.push_back("runtime"); } if (p_path.get_extension() != "dmg") { args.push_back("--entitlements"); args.push_back(p_ent_path); } PoolStringArray user_args = p_preset->get("codesign/custom_options"); for (int i = 0; i < user_args.size(); i++) { String user_arg = user_args[i].strip_edges(); if (!user_arg.empty()) { args.push_back(user_arg); } } args.push_back("-s"); if (ad_hoc) { args.push_back("-"); } else { args.push_back(p_preset->get("codesign/identity")); } args.push_back("-v"); /* provide some more feedback */ args.push_back("-f"); args.push_back(p_path); String str; int exitcode = 0; Error err = OS::get_singleton()->execute("codesign", args, true, NULL, &str, &exitcode, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Could not start codesign executable, make sure Xcode command line tools are installed.")); return err; } if (exitcode != 0) { print_line("codesign (" + p_path + "):\n" + str); add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), TTR("Code signing failed, see editor log for details.")); return Error::FAILED; } else { print_verbose("codesign (" + p_path + "):\n" + str); } } break; #endif default: { }; } return OK; } Error EditorExportPlatformOSX::_code_sign_directory(const Ref &p_preset, const String &p_path, const String &p_ent_path, bool p_should_error_on_non_code) { #ifdef OSX_ENABLED static Vector extensions_to_sign; if (extensions_to_sign.empty()) { extensions_to_sign.push_back("dylib"); extensions_to_sign.push_back("framework"); extensions_to_sign.push_back(""); } Error dir_access_error; DirAccessRef dir_access{ DirAccess::open(p_path, &dir_access_error) }; if (dir_access_error != OK) { return dir_access_error; } dir_access->list_dir_begin(); String current_file{ dir_access->get_next() }; while (!current_file.empty()) { String current_file_path{ p_path.plus_file(current_file) }; if (current_file == ".." || current_file == ".") { current_file = dir_access->get_next(); continue; } if (extensions_to_sign.find(current_file.get_extension()) > -1) { Error code_sign_error{ _code_sign(p_preset, current_file_path, p_ent_path) }; if (code_sign_error != OK) { return code_sign_error; } } else if (dir_access->current_is_dir()) { Error code_sign_error{ _code_sign_directory(p_preset, current_file_path, p_ent_path, p_should_error_on_non_code) }; if (code_sign_error != OK) { return code_sign_error; } } else if (p_should_error_on_non_code) { add_message(EXPORT_MESSAGE_WARNING, TTR("Code Signing"), vformat(TTR("Cannot sign file %s."), current_file)); return Error::FAILED; } current_file = dir_access->get_next(); } #endif return OK; } Error EditorExportPlatformOSX::_copy_and_sign_files(DirAccessRef &dir_access, const String &p_src_path, const String &p_in_app_path, bool p_sign_enabled, const Ref &p_preset, const String &p_ent_path, bool p_should_error_on_non_code_sign) { static Vector extensions_to_sign; if (extensions_to_sign.size() == 0) { extensions_to_sign.push_back("dylib"); extensions_to_sign.push_back("framework"); extensions_to_sign.push_back(""); } Error err{ OK }; if (dir_access->dir_exists(p_src_path)) { #ifndef UNIX_ENABLED add_message(EXPORT_MESSAGE_INFO, TTR("Export"), vformat(TTR("Relative symlinks are not supported, exported \"%s\" might be broken!"), p_src_path.get_file())); #endif print_verbose("export framework: " + p_src_path + " -> " + p_in_app_path); err = dir_access->make_dir_recursive(p_in_app_path); if (err == OK) { err = dir_access->copy_dir(p_src_path, p_in_app_path, -1, true); } } else { print_verbose("export dylib: " + p_src_path + " -> " + p_in_app_path); err = dir_access->copy(p_src_path, p_in_app_path); } if (err == OK && p_sign_enabled) { if (dir_access->dir_exists(p_src_path) && p_src_path.get_extension().empty()) { // If it is a directory, find and sign all dynamic libraries. err = _code_sign_directory(p_preset, p_in_app_path, p_ent_path, p_should_error_on_non_code_sign); } else { if (extensions_to_sign.find(p_in_app_path.get_extension()) > -1) { err = _code_sign(p_preset, p_in_app_path, p_ent_path); } } } return err; } Error EditorExportPlatformOSX::_export_osx_plugins_for(Ref p_editor_export_plugin, const String &p_app_path_name, DirAccessRef &dir_access, bool p_sign_enabled, const Ref &p_preset, const String &p_ent_path) { Error error{ OK }; const Vector &osx_plugins{ p_editor_export_plugin->get_osx_plugin_files() }; for (int i = 0; i < osx_plugins.size(); ++i) { String src_path{ ProjectSettings::get_singleton()->globalize_path(osx_plugins[i]) }; String path_in_app{ p_app_path_name + "/Contents/PlugIns/" + src_path.get_file() }; error = _copy_and_sign_files(dir_access, src_path, path_in_app, p_sign_enabled, p_preset, p_ent_path, false); if (error != OK) { break; } } return error; } Error EditorExportPlatformOSX::_create_pkg(const Ref &p_preset, const String &p_pkg_path, const String &p_app_path_name) { List args; if (FileAccess::exists(p_pkg_path)) { OS::get_singleton()->move_to_trash(p_pkg_path); } args.push_back("productbuild"); args.push_back("--component"); args.push_back(p_app_path_name); args.push_back("/Applications"); String ident = p_preset->get("codesign/installer_identity"); if (ident != "") { args.push_back("--timestamp"); args.push_back("--sign"); args.push_back(ident); } args.push_back("--quiet"); args.push_back(p_pkg_path); String str; Error err = OS::get_singleton()->execute("xcrun", args, true, nullptr, &str, nullptr, true); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("PKG Creation"), TTR("Could not start productbuild executable.")); return err; } print_verbose("productbuild returned: " + str); if (str.find("productbuild: error:") != -1) { add_message(EXPORT_MESSAGE_ERROR, TTR("PKG Creation"), TTR("`productbuild` failed.")); return FAILED; } return OK; } Error EditorExportPlatformOSX::_create_dmg(const String &p_dmg_path, const String &p_pkg_name, const String &p_app_path_name) { List args; if (FileAccess::exists(p_dmg_path)) { OS::get_singleton()->move_to_trash(p_dmg_path); } args.push_back("create"); args.push_back(p_dmg_path); args.push_back("-volname"); args.push_back(p_pkg_name); args.push_back("-fs"); args.push_back("HFS+"); args.push_back("-srcfolder"); args.push_back(p_app_path_name); String str; Error err = OS::get_singleton()->execute("hdiutil", args, true, nullptr, &str, nullptr, true); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("DMG Creation"), TTR("Could not start hdiutil executable.")); return err; } print_line("hdiutil returned: " + str); if (str.find("create failed") != -1) { if (str.find("File exists") != -1) { add_message(EXPORT_MESSAGE_ERROR, TTR("DMG Creation"), TTR("`hdiutil create` failed - file exists.")); } else { add_message(EXPORT_MESSAGE_ERROR, TTR("DMG Creation"), TTR("`hdiutil create` failed.")); } return FAILED; } return OK; } Error EditorExportPlatformOSX::export_project(const Ref &p_preset, bool p_debug, const String &p_path, int p_flags) { ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags); String src_pkg_name; EditorProgress ep("export", "Exporting for OSX", 3, true); if (p_debug) { src_pkg_name = p_preset->get("custom_template/debug"); } else { src_pkg_name = p_preset->get("custom_template/release"); } if (src_pkg_name == "") { String err; src_pkg_name = find_export_template("osx.zip", &err); if (src_pkg_name == "") { add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("Export template not found.")); return ERR_FILE_NOT_FOUND; } } if (!DirAccess::exists(p_path.get_base_dir())) { add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("The given export path doesn't exist.")); return ERR_FILE_BAD_PATH; } FileAccess *src_f = nullptr; zlib_filefunc_def io = zipio_create_io_from_file(&src_f); if (ep.step(TTR("Creating app bundle"), 0)) { return ERR_SKIP; } unzFile src_pkg_zip = unzOpen2(src_pkg_name.utf8().get_data(), &io); if (!src_pkg_zip) { add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), vformat(TTR("Could not find template app to export: \"%s\"."), src_pkg_name)); return ERR_FILE_NOT_FOUND; } int ret = unzGoToFirstFile(src_pkg_zip); String binary_to_use = "pandemonium_osx_" + String(p_debug ? "debug" : "release") + ".64"; String pkg_name; if (p_preset->get("application/name") != "") { pkg_name = p_preset->get("application/name"); // app_name } else if (String(ProjectSettings::get_singleton()->get("application/config/name")) != "") { pkg_name = String(ProjectSettings::get_singleton()->get("application/config/name")); } else { pkg_name = "Unnamed"; } pkg_name = OS::get_singleton()->get_safe_dir_name(pkg_name); String export_format; if (p_path.ends_with("zip")) { export_format = "zip"; } else if (p_path.ends_with("app")) { export_format = "app"; #ifdef OSX_ENABLED } else if (p_path.ends_with("dmg")) { export_format = "dmg"; } else if (p_path.ends_with("pkg")) { export_format = "pkg"; #endif } else { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), TTR("Invalid export format.")); return ERR_CANT_CREATE; } // Create our application bundle. String tmp_app_dir_name = pkg_name + ".app"; String tmp_app_path_name; if (export_format == "app") { tmp_app_path_name = p_path; } else { tmp_app_path_name = EditorSettings::get_singleton()->get_cache_dir().plus_file(tmp_app_dir_name); } print_verbose("Exporting to " + tmp_app_path_name); Error err = OK; DirAccessRef tmp_app_dir = DirAccess::create_for_path(tmp_app_path_name); if (!tmp_app_dir) { err = ERR_CANT_CREATE; } if (DirAccess::exists(tmp_app_dir_name)) { String old_dir = tmp_app_dir->get_current_dir(); if (tmp_app_dir->change_dir(tmp_app_path_name) == OK) { tmp_app_dir->erase_contents_recursive(); tmp_app_dir->change_dir(old_dir); } } // Create our folder structure. if (err == OK) { print_verbose("Creating " + tmp_app_path_name + "/Contents/MacOS"); err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/MacOS"); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/MacOS")); } } if (err == OK) { print_verbose("Creating " + tmp_app_path_name + "/Contents/Frameworks"); err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Frameworks"); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/Frameworks")); } } if (err == OK) { print_verbose("Creating " + tmp_app_path_name + "/Contents/Resources"); err = tmp_app_dir->make_dir_recursive(tmp_app_path_name + "/Contents/Resources"); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), tmp_app_path_name + "/Contents/Resources")); } } Vector translations = ProjectSettings::get_singleton()->get("locale/translations"); if (translations.size() > 0) { { String fname = tmp_app_path_name + "/Contents/Resources/en.lproj"; tmp_app_dir->make_dir_recursive(fname); FileAccessRef f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE); f->store_line("CFBundleDisplayName = \"" + ProjectSettings::get_singleton()->get("application/config/name").operator String() + "\";"); } RBSet languages; for (int j = 0; j < translations.size(); j++) { Ref tr = ResourceLoader::load(translations[j]); if (tr.is_valid() && tr->get_locale() != "en") { languages.insert(tr->get_locale()); } } for (const RBSet::Element *E = languages.front(); E; E = E->next()) { String fname = tmp_app_path_name + "/Contents/Resources/" + E->get() + ".lproj"; tmp_app_dir->make_dir_recursive(fname); FileAccessRef f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE); String prop = "application/config/name_" + E->get(); if (ProjectSettings::get_singleton()->has_setting(prop)) { f->store_line("CFBundleDisplayName = \"" + ProjectSettings::get_singleton()->get(prop).operator String() + "\";"); } } } // Now process our template. bool found_binary = false; Vector dylibs_found; while (ret == UNZ_OK && err == OK) { bool is_execute = false; // Get filename. unz_file_info info; char fname[16384]; ret = unzGetCurrentFileInfo(src_pkg_zip, &info, fname, 16384, nullptr, 0, nullptr, 0); if (ret != UNZ_OK) { break; } String file = String::utf8(fname); Vector data; data.resize(info.uncompressed_size); // Read. unzOpenCurrentFile(src_pkg_zip); unzReadCurrentFile(src_pkg_zip, data.ptrw(), data.size()); unzCloseCurrentFile(src_pkg_zip); // Write. file = file.replace_first("osx_template.app/", ""); if (((info.external_fa >> 16L) & 0120000) == 0120000) { #ifndef UNIX_ENABLED add_message(EXPORT_MESSAGE_INFO, TTR("Export"), TTR("Relative symlinks are not supported on this OS, the exported project might be broken!")); #endif // Handle symlinks in the archive. file = tmp_app_path_name.plus_file(file); if (err == OK) { err = tmp_app_dir->make_dir_recursive(file.get_base_dir()); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), file.get_base_dir())); } } if (err == OK) { String lnk_data = String::utf8((const char *)data.ptr(), data.size()); err = tmp_app_dir->create_link(lnk_data, file); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not created symlink \"%s\" -> \"%s\"."), lnk_data, file)); } print_verbose(vformat("ADDING SYMLINK %s => %s\n", file, lnk_data)); } ret = unzGoToNextFile(src_pkg_zip); continue; // next } if (file == "Contents/Info.plist") { _fix_plist(p_preset, data, pkg_name); } if (file.begins_with("Contents/MacOS/pandemonium_")) { if (file != "Contents/MacOS/" + binary_to_use) { ret = unzGoToNextFile(src_pkg_zip); continue; // skip } found_binary = true; is_execute = true; file = "Contents/MacOS/" + pkg_name; } if (file == "Contents/Resources/icon.icns") { // See if there is an icon. String iconpath; if (p_preset->get("application/icon") != "") { iconpath = p_preset->get("application/icon"); } else { iconpath = ProjectSettings::get_singleton()->get("application/config/icon"); } if (iconpath != "") { if (iconpath.get_extension() == "icns") { FileAccess *icon = FileAccess::open(iconpath, FileAccess::READ); if (icon) { data.resize(icon->get_len()); icon->get_buffer(&data.write[0], icon->get_len()); icon->close(); memdelete(icon); } } else { Ref icon; icon.instance(); err = ImageLoader::load_image(iconpath, icon); if (err == OK && !icon->empty()) { _make_icon(p_preset, icon, data); } } } } if (data.size() > 0) { if (file.ends_with(".dylib")) { dylibs_found.push_back(file); } print_verbose("ADDING: " + file + " size: " + itos(data.size())); // Write it into our application bundle. file = tmp_app_path_name.plus_file(file); if (err == OK) { err = tmp_app_dir->make_dir_recursive(file.get_base_dir()); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not create directory \"%s\"."), file.get_base_dir())); } } if (err == OK) { FileAccess *f = FileAccess::open(file, FileAccess::WRITE); if (f) { f->store_buffer(data.ptr(), data.size()); f->close(); if (is_execute) { // chmod with 0755 if the file is executable. FileAccess::set_unix_permissions(file, 0755); } memdelete(f); } else { add_message(EXPORT_MESSAGE_ERROR, TTR("Export"), vformat(TTR("Could not open \"%s\"."), file)); err = ERR_CANT_CREATE; } } } ret = unzGoToNextFile(src_pkg_zip); } // We're done with our source zip. unzClose(src_pkg_zip); if (!found_binary) { 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)); err = ERR_FILE_NOT_FOUND; } if (err == OK) { if (ep.step(TTR("Making PKG"), 1)) { return ERR_SKIP; } String pack_path = tmp_app_path_name + "/Contents/Resources/" + pkg_name + ".pck"; Vector shared_objects; err = save_pack(p_preset, pack_path, &shared_objects); // See if we can code sign our new package. bool sign_enabled = (p_preset->get("codesign/codesign").operator int() > 0); bool lib_validation = p_preset->get("codesign/entitlements/disable_library_validation"); String ent_path = p_preset->get("codesign/entitlements/custom_file"); if (sign_enabled && (ent_path == "")) { ent_path = EditorSettings::get_singleton()->get_cache_dir().plus_file(pkg_name + ".entitlements"); FileAccess *ent_f = FileAccess::open(ent_path, FileAccess::WRITE); if (ent_f) { ent_f->store_line(""); ent_f->store_line(""); ent_f->store_line(""); ent_f->store_line(""); if ((bool)p_preset->get("codesign/entitlements/allow_jit_code_execution")) { ent_f->store_line("com.apple.security.cs.allow-jit"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/allow_unsigned_executable_memory")) { ent_f->store_line("com.apple.security.cs.allow-unsigned-executable-memory"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/allow_dyld_environment_variables")) { ent_f->store_line("com.apple.security.cs.allow-dyld-environment-variables"); ent_f->store_line(""); } if (lib_validation) { ent_f->store_line("com.apple.security.cs.disable-library-validation"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/audio_input")) { ent_f->store_line("com.apple.security.device.audio-input"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/camera")) { ent_f->store_line("com.apple.security.device.camera"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/location")) { ent_f->store_line("com.apple.security.personal-information.location"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/address_book")) { ent_f->store_line("com.apple.security.personal-information.addressbook"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/calendars")) { ent_f->store_line("com.apple.security.personal-information.calendars"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/photos_library")) { ent_f->store_line("com.apple.security.personal-information.photos-library"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/apple_events")) { ent_f->store_line("com.apple.security.automation.apple-events"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/debugging")) { ent_f->store_line("com.apple.security.get-task-allow"); ent_f->store_line(""); } int dist_type = p_preset->get("export/distribution_type"); if (dist_type == 2) { String pprof = p_preset->get("codesign/provisioning_profile"); String teamid = p_preset->get("codesign/apple_team_id"); String bid = p_preset->get("application/bundle_identifier"); if (pprof != "" && teamid != "") { ent_f->store_line("com.apple.developer.team-identifier"); ent_f->store_line("" + teamid + ""); ent_f->store_line("com.apple.application-identifier"); ent_f->store_line("" + teamid + "." + bid + ""); } } if ((bool)p_preset->get("codesign/entitlements/app_sandbox/enabled")) { ent_f->store_line("com.apple.security.app-sandbox"); ent_f->store_line(""); if ((bool)p_preset->get("codesign/entitlements/app_sandbox/network_server")) { ent_f->store_line("com.apple.security.network.server"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/app_sandbox/network_client")) { ent_f->store_line("com.apple.security.network.client"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/app_sandbox/device_usb")) { ent_f->store_line("com.apple.security.device.usb"); ent_f->store_line(""); } if ((bool)p_preset->get("codesign/entitlements/app_sandbox/device_bluetooth")) { ent_f->store_line("com.apple.security.device.bluetooth"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_downloads") == 1) { ent_f->store_line("com.apple.security.files.downloads.read-only"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_downloads") == 2) { ent_f->store_line("com.apple.security.files.downloads.read-write"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_pictures") == 1) { ent_f->store_line("com.apple.security.files.pictures.read-only"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_pictures") == 2) { ent_f->store_line("com.apple.security.files.pictures.read-write"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_music") == 1) { ent_f->store_line("com.apple.security.files.music.read-only"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_music") == 2) { ent_f->store_line("com.apple.security.files.music.read-write"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_movies") == 1) { ent_f->store_line("com.apple.security.files.movies.read-only"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_movies") == 2) { ent_f->store_line("com.apple.security.files.movies.read-write"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_user_selected") == 1) { ent_f->store_line("com.apple.security.files.user-selected.read-only"); ent_f->store_line(""); } if ((int)p_preset->get("codesign/entitlements/app_sandbox/files_user_selected") == 2) { ent_f->store_line("com.apple.security.files.user-selected.read-write"); ent_f->store_line(""); } } ent_f->store_line(""); ent_f->store_line(""); ent_f->close(); memdelete(ent_f); } else { err = ERR_CANT_CREATE; } } bool ad_hoc = false; int codesign_tool = p_preset->get("codesign/codesign"); switch (codesign_tool) { case 1: { // built-in ad-hoc ad_hoc = true; } break; case 2: { // "rcodesign" ad_hoc = p_preset->get("codesign/certificate_file").operator String().empty() || p_preset->get("codesign/certificate_password").operator String().empty(); } break; #ifdef OSX_ENABLED case 3: { // "codesign" ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-"); } break; #endif default: { }; } if (err == OK) { if ((!dylibs_found.empty() || !shared_objects.empty()) && sign_enabled && ad_hoc && !lib_validation) { add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Ad-hoc signed applications require the 'Disable Library Validation' entitlement to load dynamic libraries.")); err = ERR_CANT_CREATE; } } if (err == OK) { DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); for (int i = 0; i < shared_objects.size(); i++) { String src_path = ProjectSettings::get_singleton()->globalize_path(shared_objects[i].path); String path_in_app{ tmp_app_path_name + "/Contents/Frameworks/" + src_path.get_file() }; err = _copy_and_sign_files(da, src_path, path_in_app, sign_enabled, p_preset, ent_path, true); if (err != OK) { break; } } Vector> export_plugins{ EditorExport::get_singleton()->get_export_plugins() }; for (int i = 0; i < export_plugins.size(); ++i) { err = _export_osx_plugins_for(export_plugins[i], tmp_app_path_name, da, sign_enabled, p_preset, ent_path); if (err != OK) { break; } } } if (sign_enabled) { for (int i = 0; i < dylibs_found.size(); i++) { if (err == OK) { err = _code_sign(p_preset, tmp_app_path_name + "/" + dylibs_found[i], ent_path); } } } if (err == OK && sign_enabled) { int dist_type = p_preset->get("export/distribution_type"); if (dist_type == 2) { String pprof = p_preset->get("codesign/provisioning_profile").operator String(); if (pprof != "") { DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); err = da->copy(pprof, tmp_app_path_name + "/Contents/embedded.provisionprofile"); } } if (ep.step(TTR("Code signing bundle"), 2)) { return ERR_SKIP; } err = _code_sign(p_preset, tmp_app_path_name, ent_path); } if (export_format == "dmg") { // Create a DMG. if (err == OK) { if (ep.step(TTR("Making DMG"), 3)) { return ERR_SKIP; } err = _create_dmg(p_path, pkg_name, tmp_app_path_name); } // Sign DMG. if (err == OK && sign_enabled && !ad_hoc) { if (ep.step(TTR("Code signing DMG"), 3)) { return ERR_SKIP; } err = _code_sign(p_preset, p_path, ent_path); } } else if (export_format == "pkg") { // Create a Installer. if (err == OK) { if (ep.step(TTR("Making PKG installer"), 3)) { return ERR_SKIP; } err = _create_pkg(p_preset, p_path, tmp_app_path_name); } } else if (export_format == "zip") { // Create ZIP. if (err == OK) { if (ep.step(TTR("Making ZIP"), 3)) { return ERR_SKIP; } if (FileAccess::exists(p_path)) { OS::get_singleton()->move_to_trash(p_path); } FileAccess *dst_f = nullptr; zlib_filefunc_def io_dst = zipio_create_io_from_file(&dst_f); zipFile zip = zipOpen2(p_path.utf8().get_data(), APPEND_STATUS_CREATE, nullptr, &io_dst); _zip_folder_recursive(zip, EditorSettings::get_singleton()->get_cache_dir(), pkg_name + ".app", pkg_name); zipClose(zip, nullptr); } } bool noto_enabled = (p_preset->get("notarization/notarization").operator int() > 0); if (err == OK && noto_enabled) { if (export_format == "app" || export_format == "pkg") { add_message(EXPORT_MESSAGE_INFO, TTR("Notarization"), TTR("Notarization requires the app to be archived first, select the DMG or ZIP export format instead.")); } else { if (ep.step(TTR("Sending archive for notarization"), 4)) { return ERR_SKIP; } err = _notarize(p_preset, p_path); } } // Clean up temporary .app dir and generated entitlements. if ((String)(p_preset->get("codesign/entitlements/custom_file")) == "") { tmp_app_dir->remove(ent_path); } if (export_format != "app") { if (tmp_app_dir->change_dir(tmp_app_path_name) == OK) { tmp_app_dir->erase_contents_recursive(); tmp_app_dir->change_dir(".."); tmp_app_dir->remove(tmp_app_dir_name); } } } return err; } void EditorExportPlatformOSX::_zip_folder_recursive(zipFile &p_zip, const String &p_root_path, const String &p_folder, const String &p_pkg_name) { String dir = p_root_path.plus_file(p_folder); DirAccess *da = DirAccess::open(dir); da->list_dir_begin(); String f = da->get_next(); while (f.empty()) { if (f == "." || f == "..") { f = da->get_next(); continue; } if (da->is_link(f)) { OS::Time time = OS::get_singleton()->get_time(); OS::Date date = OS::get_singleton()->get_date(); zip_fileinfo zipfi; zipfi.tmz_date.tm_hour = time.hour; zipfi.tmz_date.tm_mday = date.day; zipfi.tmz_date.tm_min = time.min; zipfi.tmz_date.tm_mon = date.month - 1; // Note: "tm" month range - 0..11, Pandemonium month range - 1..12, http://www.cplusplus.com/reference/ctime/tm/ zipfi.tmz_date.tm_sec = time.sec; zipfi.tmz_date.tm_year = date.year; zipfi.dosDate = 0; // 0120000: symbolic link type // 0000755: permissions rwxr-xr-x // 0000644: permissions rw-r--r-- uint32_t _mode = 0120644; zipfi.external_fa = (_mode << 16L) | !(_mode & 0200); zipfi.internal_fa = 0; zipOpenNewFileInZip4(p_zip, p_folder.plus_file(f).utf8().get_data(), &zipfi, nullptr, 0, nullptr, 0, nullptr, Z_DEFLATED, Z_DEFAULT_COMPRESSION, 0, -MAX_WBITS, DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY, nullptr, 0, 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions 0); String target = da->read_link(f); zipWriteInFileInZip(p_zip, target.utf8().get_data(), target.utf8().size()); zipCloseFileInZip(p_zip); } else if (da->current_is_dir()) { _zip_folder_recursive(p_zip, p_root_path, p_folder.plus_file(f), p_pkg_name); } else { bool is_executable = (p_folder.ends_with("MacOS") && (f == p_pkg_name)); OS::Time time = OS::get_singleton()->get_time(); OS::Date date = OS::get_singleton()->get_date(); zip_fileinfo zipfi; zipfi.tmz_date.tm_hour = time.hour; zipfi.tmz_date.tm_mday = date.day; zipfi.tmz_date.tm_min = time.min; zipfi.tmz_date.tm_mon = date.month - 1; // Note: "tm" month range - 0..11, Pandemonium month range - 1..12, http://www.cplusplus.com/reference/ctime/tm/ zipfi.tmz_date.tm_sec = time.sec; zipfi.tmz_date.tm_year = date.year; zipfi.dosDate = 0; // 0100000: regular file type // 0000755: permissions rwxr-xr-x // 0000644: permissions rw-r--r-- uint32_t _mode = (is_executable ? 0100755 : 0100644); zipfi.external_fa = (_mode << 16L) | !(_mode & 0200); zipfi.internal_fa = 0; zipOpenNewFileInZip4(p_zip, p_folder.plus_file(f).utf8().get_data(), &zipfi, nullptr, 0, nullptr, 0, nullptr, Z_DEFLATED, Z_DEFAULT_COMPRESSION, 0, -MAX_WBITS, DEF_MEM_LEVEL, Z_DEFAULT_STRATEGY, nullptr, 0, 0x0314, // "version made by", 0x03 - Unix, 0x14 - ZIP specification version 2.0, required to store Unix file permissions 0); FileAccessRef fa = FileAccess::open(dir.plus_file(f), FileAccess::READ); if (!fa) { add_message(EXPORT_MESSAGE_ERROR, TTR("ZIP Creation"), vformat(TTR("Could not open file to read from path \"%s\"."), dir.plus_file(f))); return; } const int bufsize = 16384; uint8_t buf[bufsize]; while (true) { uint64_t got = fa->get_buffer(buf, bufsize); if (got == 0) { break; } zipWriteInFileInZip(p_zip, buf, got); } zipCloseFileInZip(p_zip); } f = da->get_next(); } da->list_dir_end(); memdelete(da); } bool EditorExportPlatformOSX::has_valid_export_configuration(const Ref &p_preset, String &r_error, bool &r_missing_templates) const { String err; bool valid = false; // Look for export templates (custom templates). bool dvalid = false; bool rvalid = false; if (p_preset->get("custom_template/debug") != "") { dvalid = FileAccess::exists(p_preset->get("custom_template/debug")); if (!dvalid) { err += TTR("Custom debug template not found.") + "\n"; } } if (p_preset->get("custom_template/release") != "") { rvalid = FileAccess::exists(p_preset->get("custom_template/release")); if (!rvalid) { err += TTR("Custom release template not found.") + "\n"; } } // Look for export templates (official templates, check only is custom templates are not set). if (!dvalid || !rvalid) { dvalid = exists_export_template("osx.zip", &err); rvalid = dvalid; // Both in the same ZIP. } valid = dvalid || rvalid; r_missing_templates = !valid; if (!err.empty()) { r_error = err; } return valid; } bool EditorExportPlatformOSX::has_valid_project_configuration(const Ref &p_preset, String &r_error) const { String err; bool valid = true; String identifier = p_preset->get("application/identifier"); String pn_err; if (!is_package_name_valid(identifier, &pn_err)) { err += TTR("Invalid bundle identifier:") + " " + pn_err + "\n"; valid = false; } bool ad_hoc = false; int codesign_tool = p_preset->get("codesign/codesign"); switch (codesign_tool) { case 1: { // built-in ad-hoc ad_hoc = true; } break; case 2: { // "rcodesign" ad_hoc = p_preset->get("codesign/certificate_file").operator String().empty() || p_preset->get("codesign/certificate_password").operator String().empty(); } break; #ifdef OSX_ENABLED case 3: { // "codesign" ad_hoc = (p_preset->get("codesign/identity") == "" || p_preset->get("codesign/identity") == "-"); } break; #endif default: { }; } int notary_tool = p_preset->get("notarization/notarization"); int dist_type = p_preset->get("export/distribution_type"); if (dist_type == 2) { String pprof = p_preset->get("codesign/provisioning_profile"); if (pprof == "") { err += TTR("Provisioning profile is required for App Store distribution.") + "\n"; valid = false; } String ident = p_preset->get("codesign/installer_identity"); if (ident == "") { err += TTR("Installer signing identity is required for App Store distribution.") + "\n"; valid = false; } bool sandbox = p_preset->get("codesign/entitlements/app_sandbox/enabled"); if (!sandbox) { err += TTR("App sandbox is required for App Store distribution.") + "\n"; valid = false; } if (codesign_tool == 0) { err += TTR("Code signing is required for App Store distribution.") + "\n"; valid = false; } if (codesign_tool == 1) { err += TTR("App Store distribution with ad-hoc code signing is not supported.") + "\n"; valid = false; } } if (notary_tool > 0) { if (ad_hoc) { err += TTR("Notarization: Notarization with an ad-hoc signature is not supported.") + "\n"; valid = false; } if (codesign_tool == 0) { err += TTR("Notarization: Code signing is required for notarization.") + "\n"; valid = false; } if (notary_tool == 2 || notary_tool == 3) { if (!FileAccess::exists("/usr/bin/xcrun") && !FileAccess::exists("/bin/xcrun")) { err += TTR("Notarization: Xcode command line tools are not installed.") + "\n"; valid = false; } if (p_preset->get("notarization/apple_id_name") == "" && p_preset->get("notarization/api_uuid") == "") { err += TTR("Notarization: Neither Apple ID name nor App Store Connect issuer ID name not specified.") + "\n"; valid = false; } else if (p_preset->get("notarization/apple_id_name") != "" && p_preset->get("notarization/api_uuid") != "") { err += TTR("Notarization: Both Apple ID name and App Store Connect issuer ID name are specified, only one should be set at the same time.") + "\n"; valid = false; } else { if (p_preset->get("notarization/apple_id_name") != "") { if (p_preset->get("notarization/apple_id_password") == "") { err += TTR("Notarization: Apple ID password not specified.") + "\n"; valid = false; } } if (p_preset->get("notarization/api_uuid") != "") { if (p_preset->get("notarization/api_key") == "") { err += TTR("Notarization: App Store Connect API key ID not specified.") + "\n"; valid = false; } } } } else if (notary_tool == 1) { if (p_preset->get("notarization/api_uuid") == "") { err += TTR("Notarization: App Store Connect issuer ID name not specified.") + "\n"; valid = false; } if (p_preset->get("notarization/api_key") == "") { err += TTR("Notarization: App Store Connect API key ID not specified.") + "\n"; valid = false; } String rcodesign = EditorSettings::get_singleton()->get("export/macos/rcodesign").operator String(); if (rcodesign.empty()) { err += TTR("Notarization: rcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign).") + "\n"; valid = false; } } } else if (dist_type != 2) { err += TTR("Warning: Notarization is disabled. The exported project will be blocked by Gatekeeper if it's downloaded from an unknown source.") + "\n"; if (codesign_tool == 0) { err += TTR("Code signing is disabled. The exported project will not run on Macs with enabled Gatekeeper and Apple Silicon powered Macs.") + "\n"; } } if (codesign_tool > 0) { if (ad_hoc) { err += TTR("Code signing: Using ad-hoc signature. The exported project will be blocked by Gatekeeper") + "\n"; } if (codesign_tool == 3) { if (!FileAccess::exists("/usr/bin/codesign") && !FileAccess::exists("/bin/codesign")) { err += TTR("Code signing: Xcode command line tools are not installed.") + "\n"; valid = false; } } else if (codesign_tool == 2) { String rcodesign = EditorSettings::get_singleton()->get("export/macos/rcodesign").operator String(); if (rcodesign.empty()) { err += TTR("Code signing: rcodesign path is not set. Configure rcodesign path in the Editor Settings (Export > macOS > rcodesign).") + "\n"; valid = false; } } if ((bool)p_preset->get("codesign/entitlements/audio_input") && ((String)p_preset->get("privacy/microphone_usage_description")).empty()) { err += TTR("Privacy: Microphone access is enabled, but usage description is not specified.") + "\n"; valid = false; } if ((bool)p_preset->get("codesign/entitlements/camera") && ((String)p_preset->get("privacy/camera_usage_description")).empty()) { err += TTR("Privacy: Camera access is enabled, but usage description is not specified.") + "\n"; valid = false; } if ((bool)p_preset->get("codesign/entitlements/location") && ((String)p_preset->get("privacy/location_usage_description")).empty()) { err += TTR("Privacy: Location information access is enabled, but usage description is not specified.") + "\n"; valid = false; } if ((bool)p_preset->get("codesign/entitlements/address_book") && ((String)p_preset->get("privacy/address_book_usage_description")).empty()) { err += TTR("Privacy: Address book access is enabled, but usage description is not specified.") + "\n"; valid = false; } if ((bool)p_preset->get("codesign/entitlements/calendars") && ((String)p_preset->get("privacy/calendar_usage_description")).empty()) { err += TTR("Privacy: Calendar access is enabled, but usage description is not specified.") + "\n"; valid = false; } if ((bool)p_preset->get("codesign/entitlements/photos_library") && ((String)p_preset->get("privacy/photos_library_usage_description")).empty()) { err += TTR("Privacy: Photo library access is enabled, but usage description is not specified.") + "\n"; valid = false; } } if (!err.empty()) { r_error = err; } return valid; } EditorExportPlatformOSX::EditorExportPlatformOSX() { Ref img = memnew(Image(_osx_logo)); logo.instance(); logo->create_from_image(img); } EditorExportPlatformOSX::~EditorExportPlatformOSX() { } void register_osx_exporter() { EDITOR_DEF("export/macos/rcodesign", ""); #ifdef WINDOWS_ENABLED EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/macos/rcodesign", PROPERTY_HINT_GLOBAL_FILE, "*.exe")); #else EditorSettings::get_singleton()->add_property_hint(PropertyInfo(Variant::STRING, "export/macos/rcodesign", PROPERTY_HINT_GLOBAL_FILE)); #endif Ref platform; platform.instance(); EditorExport::get_singleton()->add_export_platform(platform); }