/**************************************************************************/ /* editor_export_platform.h */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* 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. */ /**************************************************************************/ #pragma once #include "core/os/process_id.h" #include "editor/export/editor_export_preset.h" class DirAccess; class EditorExportPlugin; class EditorFileSystemDirectory; class FileAccess; class Image; class Node; class RichTextLabel; class Texture2D; struct EditorProgress; struct SharedObject; typedef void *zipFile; const String ENV_SCRIPT_ENCRYPTION_KEY = "GODOT_SCRIPT_ENCRYPTION_KEY"; class EditorExportPlatform : public RefCounted { GDCLASS(EditorExportPlatform, RefCounted); protected: static void _bind_methods(); public: typedef Error (*EditorExportSaveFunction)(const Ref &p_preset, void *p_userdata, const String &p_path, const Vector &p_data, int p_file, int p_total, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool p_delta); typedef Error (*EditorExportRemoveFunction)(const Ref &p_preset, void *p_userdata, const String &p_path); typedef Error (*EditorExportSaveSharedObject)(const Ref &p_preset, void *p_userdata, const SharedObject &p_so); enum DebugFlags { DEBUG_FLAG_DUMB_CLIENT = 1, DEBUG_FLAG_REMOTE_DEBUG = 2, DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST = 4, DEBUG_FLAG_VIEW_COLLISIONS = 8, DEBUG_FLAG_VIEW_NAVIGATION = 16, }; enum ExportMessageType { EXPORT_MESSAGE_NONE, EXPORT_MESSAGE_INFO, EXPORT_MESSAGE_WARNING, EXPORT_MESSAGE_ERROR, }; struct ExportMessage { ExportMessageType msg_type; String category; String text; }; struct SavedData { uint64_t ofs = 0; uint64_t size = 0; bool encrypted = false; bool removal = false; bool delta = false; Vector md5; CharString path_utf8; bool operator<(const SavedData &p_data) const { return path_utf8 < p_data.path_utf8; } }; struct PackData { String path; String salt; Ref f; Vector file_ofs; EditorProgress *ep = nullptr; Vector *so_files = nullptr; bool use_sparse_pck = false; }; static bool _store_header(Ref p_fd, bool p_enc, bool p_sparse, uint64_t &r_file_base_ofs, uint64_t &r_dir_base_ofs, const String &p_salt); static bool _encrypt_and_store_directory(Ref p_fd, PackData &p_pack_data, const Vector &p_key, uint64_t p_seed, uint64_t p_file_base); static Error _encrypt_and_store_data(Ref p_fd, const String &p_path, const Vector &p_data, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool &r_encrypt); static String _get_script_encryption_key(const Ref &p_preset); static Vector _get_script_encryption_key_bytes(const Ref &p_preset); private: struct ZipData { void *zip = nullptr; EditorProgress *ep = nullptr; Vector *so_files = nullptr; int file_count = 0; }; Vector messages; Vector patch_temp_dirs; void _export_find_resources(EditorFileSystemDirectory *p_dir, HashSet &p_paths); void _export_find_customized_resources(const Ref &p_preset, EditorFileSystemDirectory *p_dir, EditorExportPreset::FileExportMode p_mode, HashSet &p_paths); void _export_find_dependencies(const String &p_path, HashSet &p_paths); static Error _save_pack_file(const Ref &p_preset, void *p_userdata, const String &p_path, const Vector &p_data, int p_file, int p_total, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool p_delta); static Error _save_pack_patch_file(const Ref &p_preset, void *p_userdata, const String &p_path, const Vector &p_data, int p_file, int p_total, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool p_delta); static Error _pack_add_shared_object(const Ref &p_preset, void *p_userdata, const SharedObject &p_so); static Error _remove_pack_file(const Ref &p_preset, void *p_userdata, const String &p_path); static Error _save_zip_file(const Ref &p_preset, void *p_userdata, const String &p_path, const Vector &p_data, int p_file, int p_total, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool p_delta); static Error _save_zip_patch_file(const Ref &p_preset, void *p_userdata, const String &p_path, const Vector &p_data, int p_file, int p_total, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool p_delta); static Error _zip_add_shared_object(const Ref &p_preset, void *p_userdata, const SharedObject &p_so); struct ScriptCallbackData { Callable file_cb; Callable so_cb; }; static Error _script_save_file(const Ref &p_preset, void *p_userdata, const String &p_path, const Vector &p_data, int p_file, int p_total, const Vector &p_enc_in_filters, const Vector &p_enc_ex_filters, const Vector &p_key, uint64_t p_seed, bool p_delta); static Error _script_add_shared_object(const Ref &p_preset, void *p_userdata, const SharedObject &p_so); void _edit_files_with_filter(Ref &da, const Vector &p_filters, HashSet &r_list, bool exclude); void _edit_filter_list(HashSet &r_list, const String &p_filter, bool exclude); struct FilteredCache { Vector extension_list; Vector global_class_list; Vector uids; }; static FilteredCache _get_filtered_cache(const HashSet &p_paths); struct FileExportCache { uint64_t source_modified_time = 0; String source_md5; String saved_path; bool used = false; }; bool _export_customize_dictionary(Dictionary &dict, LocalVector> &customize_resources_plugins); bool _export_customize_array(Array &array, LocalVector> &customize_resources_plugins); bool _export_customize_object(Object *p_object, LocalVector> &customize_resources_plugins); bool _export_customize_scene_resources(Node *p_root, Node *p_node, LocalVector> &customize_resources_plugins); bool _is_editable_ancestor(Node *p_root, Node *p_node); String _export_customize(const String &p_path, LocalVector> &customize_resources_plugins, LocalVector> &customize_scenes_plugins, HashMap &export_cache, const String &export_base_path, bool p_force_save); protected: struct ExportNotifier { bool enabled = true; ExportNotifier(EditorExportPlatform &p_platform, const Ref &p_preset, bool p_debug, const String &p_path, BitField p_flags, bool p_enabled = true); ~ExportNotifier(); }; HashSet get_features(const Ref &p_preset, bool p_debug) const; Dictionary _find_export_template(const String &p_template_file_name) const { Dictionary ret; String err; String path = find_export_template(p_template_file_name, &err); ret["result"] = (err.is_empty() && !path.is_empty()) ? OK : FAILED; ret["path"] = path; ret["error_string"] = err; return ret; } bool exists_export_template(const String &p_template_file_name, String *r_err) const; String find_export_template(const String &p_template_file_name, String *r_err = nullptr) const; Vector gen_export_flags(BitField p_flags); virtual void zip_folder_recursive(zipFile &p_zip, const String &p_root_path, const String &p_folder, const String &p_pkg_name); Error _ssh_run_on_remote(const String &p_host, const String &p_port, const Vector &p_ssh_args, const String &p_cmd_args, Array r_output = Array(), int p_port_fwd = -1) const { String pipe; Error err = ssh_run_on_remote(p_host, p_port, p_ssh_args, p_cmd_args, &pipe, p_port_fwd); r_output.push_back(pipe); return err; } ProcessID _ssh_run_on_remote_no_wait(const String &p_host, const String &p_port, const Vector &p_ssh_args, const String &p_cmd_args, int p_port_fwd = -1) const { ProcessID pid = 0; Error err = ssh_run_on_remote_no_wait(p_host, p_port, p_ssh_args, p_cmd_args, &pid, p_port_fwd); if (err != OK) { return -1; } else { return pid; } } Error ssh_run_on_remote(const String &p_host, const String &p_port, const Vector &p_ssh_args, const String &p_cmd_args, String *r_out = nullptr, int p_port_fwd = -1) const; Error ssh_run_on_remote_no_wait(const String &p_host, const String &p_port, const Vector &p_ssh_args, const String &p_cmd_args, ProcessID *r_pid = nullptr, int p_port_fwd = -1) const; Error ssh_push_to_remote(const String &p_host, const String &p_port, const Vector &p_scp_args, const String &p_src_file, const String &p_dst_file) const; Error _extract_android_assets(const String &p_bundle_path, String &r_pck_path, String &r_temp_dir); Error _load_patches(const Ref &p_preset, const Vector &p_patches); void _unload_patches(); Ref _load_icon_or_splash_image(const String &p_path, Error *r_error) const; #ifndef DISABLE_DEPRECATED Error _export_project_bind_compat_118787(const Ref &p_preset, bool p_debug, const String &p_path, BitField p_flags = 0); static Vector _get_forced_export_files_bind_compat_71542(); static void _bind_compatibility_methods(); #endif public: static String simplify_path(const String &p_path); static Variant get_project_setting(const Ref &p_preset, const StringName &p_name); virtual void get_preset_features(const Ref &p_preset, List *r_features) const = 0; struct ExportOption { PropertyInfo option; Variant default_value; bool update_visibility = false; bool required = false; ExportOption(const PropertyInfo &p_info, const Variant &p_default, bool p_update_visibility = false, bool p_required = false) : option(p_info), default_value(p_default), update_visibility(p_update_visibility), required(p_required) { } ExportOption() {} }; virtual Ref create_preset(); virtual bool is_executable(const String &p_path) const { return false; } virtual void clear_messages() { messages.clear(); } virtual void add_message(ExportMessageType p_type, const String &p_category, const String &p_message) { ExportMessage msg; msg.category = p_category; msg.text = p_message; msg.msg_type = p_type; messages.push_back(msg); switch (p_type) { case EXPORT_MESSAGE_INFO: { print_line(vformat("%s: %s", msg.category, msg.text)); } break; case EXPORT_MESSAGE_WARNING: { WARN_PRINT(vformat("%s: %s", msg.category, msg.text)); } break; case EXPORT_MESSAGE_ERROR: { ERR_PRINT(vformat("%s: %s", msg.category, msg.text)); } break; default: break; } } virtual int get_message_count() const { return messages.size(); } virtual ExportMessage get_message(int p_index) const { ERR_FAIL_INDEX_V(p_index, messages.size(), ExportMessage()); return messages[p_index]; } virtual ExportMessageType _get_message_type(int p_index) const { ERR_FAIL_INDEX_V(p_index, messages.size(), EXPORT_MESSAGE_NONE); return messages[p_index].msg_type; } virtual String _get_message_category(int p_index) const { ERR_FAIL_INDEX_V(p_index, messages.size(), String()); return messages[p_index].category; } virtual String _get_message_text(int p_index) const { ERR_FAIL_INDEX_V(p_index, messages.size(), String()); return messages[p_index].text; } virtual ExportMessageType get_worst_message_type() const { ExportMessageType worst_type = EXPORT_MESSAGE_NONE; for (int i = 0; i < messages.size(); i++) { worst_type = MAX(worst_type, messages[i].msg_type); } return worst_type; } Dictionary get_internal_export_files(const Ref &p_preset, bool p_debug); static Vector get_forced_export_files(const Ref &p_preset); virtual bool fill_log_messages(RichTextLabel *p_log, Error p_err); virtual void get_export_options(List *r_options) const = 0; virtual bool should_update_export_options() { return false; } virtual bool get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const { return true; } virtual String get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const { return String(); } virtual String get_os_name() const = 0; virtual String get_name() const = 0; virtual Ref get_logo() const = 0; Array get_current_presets() const; Error _export_project_files(const Ref &p_preset, bool p_debug, const Callable &p_save_func, const Callable &p_so_func); Error export_project_files(const Ref &p_preset, bool p_debug, EditorExportSaveFunction p_save_func, EditorExportRemoveFunction p_remove_func, void *p_udata, EditorExportSaveSharedObject p_so_func = nullptr); Dictionary _save_pack(const Ref &p_preset, bool p_debug, const String &p_path, bool p_embed = false); Dictionary _save_zip(const Ref &p_preset, bool p_debug, const String &p_path); Dictionary _save_pack_patch(const Ref &p_preset, bool p_debug, const String &p_path); Dictionary _save_zip_patch(const Ref &p_preset, bool p_debug, const String &p_path); Error save_pack(const Ref &p_preset, bool p_debug, const String &p_path, Vector *p_so_files = nullptr, EditorExportSaveFunction p_save_func = nullptr, EditorExportRemoveFunction p_remove_func = nullptr, bool p_embed = false, int64_t *r_embedded_start = nullptr, int64_t *r_embedded_size = nullptr); Error save_zip(const Ref &p_preset, bool p_debug, const String &p_path, Vector *p_so_files = nullptr, EditorExportSaveFunction p_save_func = nullptr); Error save_pack_patch(const Ref &p_preset, bool p_debug, const String &p_path, Vector *p_so_files = nullptr, bool p_embed = false, int64_t *r_embedded_start = nullptr, int64_t *r_embedded_size = nullptr); Error save_zip_patch(const Ref &p_preset, bool p_debug, const String &p_path, Vector *p_so_files = nullptr); virtual bool poll_export() { return false; } virtual int get_options_count() const { return 0; } virtual bool is_option_runnable(int p_index) const { return true; } virtual String get_options_tooltip() const { return ""; } virtual Ref get_option_icon(int p_index) const; virtual String get_option_label(int p_device) const { return ""; } virtual String get_option_tooltip(int p_device) const { return ""; } virtual String get_device_architecture(int p_device) const { return ""; } virtual void cleanup() {} virtual Error run(const Ref &p_preset, int p_device, BitField p_debug_flags) { return OK; } virtual Ref get_run_icon() const { return get_logo(); } virtual bool can_export(const Ref &p_preset, String &r_error, bool &r_missing_templates, bool p_debug = false) const; virtual bool has_valid_export_configuration(const Ref &p_preset, String &r_error, bool &r_missing_templates, bool p_debug = false) const = 0; virtual bool has_valid_project_configuration(const Ref &p_preset, String &r_error) const = 0; virtual List get_binary_extensions(const Ref &p_preset) const = 0; virtual Error export_project(const Ref &p_preset, bool p_debug, const String &p_path, BitField p_flags = 0, bool p_notify = true) = 0; virtual Error export_pack(const Ref &p_preset, bool p_debug, const String &p_path, BitField p_flags = 0); virtual Error export_zip(const Ref &p_preset, bool p_debug, const String &p_path, BitField p_flags = 0); virtual Error export_pack_patch(const Ref &p_preset, bool p_debug, const String &p_path, const Vector &p_patches = Vector(), BitField p_flags = 0); virtual Error export_zip_patch(const Ref &p_preset, bool p_debug, const String &p_path, const Vector &p_patches = Vector(), BitField p_flags = 0); virtual void get_platform_features(List *r_features) const = 0; virtual void resolve_platform_feature_priorities(const Ref &p_preset, HashSet &p_features) {} virtual String get_debug_protocol() const { return "tcp://"; } virtual HashMap get_custom_project_settings(const Ref &p_preset) const { return HashMap(); } virtual void initialize() {} }; VARIANT_ENUM_CAST(EditorExportPlatform::ExportMessageType) VARIANT_BITFIELD_CAST(EditorExportPlatform::DebugFlags);