1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264 |
- /**************************************************************************/
- /* project_export.cpp */
- /**************************************************************************/
- /* 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. */
- /**************************************************************************/
- #include "project_export.h"
- #include "core/compressed_translation.h"
- #include "core/io/image_loader.h"
- #include "core/io/resource_loader.h"
- #include "core/io/resource_saver.h"
- #include "core/os/dir_access.h"
- #include "core/os/file_access.h"
- #include "core/os/os.h"
- #include "core/project_settings.h"
- #include "core/version_generated.gen.h"
- #include "editor_data.h"
- #include "editor_node.h"
- #include "editor_scale.h"
- #include "editor_settings.h"
- #include "scene/gui/box_container.h"
- #include "scene/gui/margin_container.h"
- #include "scene/gui/scroll_container.h"
- #include "scene/gui/tab_container.h"
- void ProjectExportDialog::_notification(int p_what) {
- switch (p_what) {
- case NOTIFICATION_ENTER_TREE:
- case NOTIFICATION_THEME_CHANGED: {
- duplicate_preset->set_icon(get_icon("Duplicate", "EditorIcons"));
- delete_preset->set_icon(get_icon("Remove", "EditorIcons"));
- } break;
- case NOTIFICATION_READY: {
- connect("confirmed", this, "_export_pck_zip");
- _update_export_all();
- } break;
- case NOTIFICATION_POPUP_HIDE: {
- EditorSettings::get_singleton()->set_project_metadata("dialog_bounds", "export", get_rect());
- } break;
- case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
- parameters->set_property_name_style(EditorPropertyNameProcessor::get_settings_style());
- } break;
- }
- }
- void ProjectExportDialog::popup_export() {
- add_preset->get_popup()->clear();
- for (int i = 0; i < EditorExport::get_singleton()->get_export_platform_count(); i++) {
- Ref<EditorExportPlatform> plat = EditorExport::get_singleton()->get_export_platform(i);
- add_preset->get_popup()->add_icon_item(plat->get_logo(), plat->get_name());
- }
- _update_presets();
- if (presets->get_current() >= 0) {
- _update_current_preset(); // triggers rescan for templates if newly installed
- }
- // Restore valid window bounds or pop up at default size.
- Rect2 saved_size = EditorSettings::get_singleton()->get_project_metadata("dialog_bounds", "export", Rect2());
- if (saved_size != Rect2()) {
- popup(saved_size);
- } else {
- popup_centered_clamped(Size2(900, 700) * EDSCALE, 0.8);
- }
- }
- void ProjectExportDialog::_add_preset(int p_platform) {
- Ref<EditorExportPreset> preset = EditorExport::get_singleton()->get_export_platform(p_platform)->create_preset();
- ERR_FAIL_COND(!preset.is_valid());
- String name = EditorExport::get_singleton()->get_export_platform(p_platform)->get_name();
- bool make_runnable = true;
- int attempt = 1;
- while (true) {
- bool valid = true;
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> p = EditorExport::get_singleton()->get_export_preset(i);
- if (p->get_platform() == preset->get_platform() && p->is_runnable()) {
- make_runnable = false;
- }
- if (p->get_name() == name) {
- valid = false;
- break;
- }
- }
- if (valid) {
- break;
- }
- attempt++;
- name = EditorExport::get_singleton()->get_export_platform(p_platform)->get_name() + " " + itos(attempt);
- }
- preset->set_name(name);
- if (make_runnable) {
- preset->set_runnable(make_runnable);
- }
- EditorExport::get_singleton()->add_export_preset(preset);
- _update_presets();
- _edit_preset(EditorExport::get_singleton()->get_export_preset_count() - 1);
- }
- void ProjectExportDialog::_force_update_current_preset_parameters() {
- // Force the parameters section to refresh its UI.
- parameters->edit(nullptr);
- _update_current_preset();
- }
- void ProjectExportDialog::_update_current_preset() {
- _edit_preset(presets->get_current());
- }
- void ProjectExportDialog::_update_presets() {
- updating = true;
- Ref<EditorExportPreset> current;
- if (presets->get_current() >= 0 && presets->get_current() < presets->get_item_count()) {
- current = get_current_preset();
- }
- int current_idx = -1;
- presets->clear();
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> preset = EditorExport::get_singleton()->get_export_preset(i);
- if (preset == current) {
- current_idx = i;
- }
- String name = preset->get_name();
- if (preset->is_runnable()) {
- name += " (" + TTR("Runnable") + ")";
- }
- preset->update_files_to_export();
- presets->add_item(name, preset->get_platform()->get_logo());
- }
- if (current_idx != -1) {
- presets->select(current_idx);
- }
- updating = false;
- }
- void ProjectExportDialog::_update_export_all() {
- bool can_export = EditorExport::get_singleton()->get_export_preset_count() > 0;
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> preset = EditorExport::get_singleton()->get_export_preset(i);
- bool needs_templates;
- String error;
- if (preset->get_export_path() == "" || !preset->get_platform()->can_export(preset, error, needs_templates)) {
- can_export = false;
- break;
- }
- }
- export_all_button->set_disabled(!can_export);
- if (can_export) {
- export_all_button->set_tooltip(TTR("Export the project for all the presets defined."));
- } else {
- export_all_button->set_tooltip(TTR("All presets must have an export path defined for Export All to work."));
- }
- }
- void ProjectExportDialog::_edit_preset(int p_index) {
- if (p_index < 0 || p_index >= presets->get_item_count()) {
- name->set_text("");
- name->set_editable(false);
- export_path->hide();
- runnable->set_disabled(true);
- parameters->edit(nullptr);
- presets->unselect_all();
- duplicate_preset->set_disabled(true);
- delete_preset->set_disabled(true);
- sections->hide();
- export_error->hide();
- export_templates_error->hide();
- return;
- }
- Ref<EditorExportPreset> current = EditorExport::get_singleton()->get_export_preset(p_index);
- ERR_FAIL_COND(current.is_null());
- updating = true;
- presets->select(p_index);
- sections->show();
- name->set_editable(true);
- export_path->show();
- duplicate_preset->set_disabled(false);
- delete_preset->set_disabled(false);
- get_ok()->set_disabled(false);
- name->set_text(current->get_name());
- List<String> extension_list = current->get_platform()->get_binary_extensions(current);
- Vector<String> extension_vector;
- for (int i = 0; i < extension_list.size(); i++) {
- extension_vector.push_back("*." + extension_list[i]);
- }
- export_path->setup(extension_vector, false, true);
- export_path->update_property();
- runnable->set_disabled(false);
- runnable->set_pressed(current->is_runnable());
- parameters->edit(current.ptr());
- export_filter->select(current->get_export_filter());
- include_filters->set_text(current->get_include_filter());
- exclude_filters->set_text(current->get_exclude_filter());
- _fill_resource_tree();
- bool needs_templates;
- String error;
- if (!current->get_platform()->can_export(current, error, needs_templates)) {
- if (error != String()) {
- Vector<String> items = error.split("\n", false);
- error = "";
- for (int i = 0; i < items.size(); i++) {
- if (i > 0) {
- error += "\n";
- }
- error += " - " + items[i];
- }
- export_error->set_text(error);
- export_error->show();
- } else {
- export_error->hide();
- }
- export_warning->hide();
- if (needs_templates) {
- export_templates_error->show();
- } else {
- export_templates_error->hide();
- }
- export_button->set_disabled(true);
- } else {
- if (error != String()) {
- Vector<String> items = error.split("\n", false);
- error = "";
- for (int i = 0; i < items.size(); i++) {
- if (i > 0) {
- error += "\n";
- }
- error += " - " + items[i];
- }
- export_warning->set_text(error);
- export_warning->show();
- } else {
- export_warning->hide();
- }
- export_error->hide();
- export_templates_error->hide();
- export_button->set_disabled(false);
- }
- custom_features->set_text(current->get_custom_features());
- _update_feature_list();
- _update_export_all();
- minimum_size_changed();
- int script_export_mode = current->get_script_export_mode();
- script_mode->select(script_export_mode);
- String key = current->get_script_encryption_key();
- if (!updating_script_key) {
- script_key->set_text(key);
- }
- if (script_export_mode == EditorExportPreset::MODE_SCRIPT_ENCRYPTED) {
- script_key->set_editable(true);
- bool key_valid = _validate_script_encryption_key(key);
- if (key_valid) {
- script_key_error->hide();
- } else {
- script_key_error->show();
- }
- } else {
- script_key->set_editable(false);
- script_key_error->hide();
- }
- updating = false;
- }
- void ProjectExportDialog::_update_feature_list() {
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- Set<String> fset;
- List<String> features;
- current->get_platform()->get_platform_features(&features);
- current->get_platform()->get_preset_features(current, &features);
- String custom = current->get_custom_features();
- Vector<String> custom_list = custom.split(",");
- for (int i = 0; i < custom_list.size(); i++) {
- String f = custom_list[i].strip_edges();
- if (f != String()) {
- features.push_back(f);
- }
- }
- for (List<String>::Element *E = features.front(); E; E = E->next()) {
- fset.insert(E->get());
- }
- custom_feature_display->clear();
- for (Set<String>::Element *E = fset.front(); E; E = E->next()) {
- String f = E->get();
- if (E->next()) {
- f += ", ";
- }
- custom_feature_display->add_text(f);
- }
- }
- void ProjectExportDialog::_custom_features_changed(const String &p_text) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- current->set_custom_features(p_text);
- _update_feature_list();
- }
- void ProjectExportDialog::_tab_changed(int) {
- _update_feature_list();
- }
- void ProjectExportDialog::_update_parameters(const String &p_edited_property) {
- _update_current_preset();
- }
- void ProjectExportDialog::_runnable_pressed() {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- if (runnable->is_pressed()) {
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> p = EditorExport::get_singleton()->get_export_preset(i);
- if (p->get_platform() == current->get_platform()) {
- p->set_runnable(current == p);
- }
- }
- } else {
- current->set_runnable(false);
- }
- _update_presets();
- }
- void ProjectExportDialog::_name_changed(const String &p_string) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- current->set_name(p_string);
- _update_presets();
- }
- void ProjectExportDialog::set_export_path(const String &p_value) {
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- current->set_export_path(p_value);
- }
- String ProjectExportDialog::get_export_path() {
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND_V(current.is_null(), String(""));
- return current->get_export_path();
- }
- Ref<EditorExportPreset> ProjectExportDialog::get_current_preset() const {
- return EditorExport::get_singleton()->get_export_preset(presets->get_current());
- }
- void ProjectExportDialog::_export_path_changed(const StringName &p_property, const Variant &p_value, const String &p_field, bool p_changing) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- current->set_export_path(p_value);
- _update_presets();
- _update_export_all();
- }
- void ProjectExportDialog::_open_key_help_link() {
- OS::get_singleton()->shell_open(vformat("%s/development/compiling/compiling_with_script_encryption_key.html", VERSION_DOCS_URL));
- }
- void ProjectExportDialog::_script_export_mode_changed(int p_mode) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- current->set_script_export_mode(p_mode);
- _update_current_preset();
- }
- void ProjectExportDialog::_script_encryption_key_changed(const String &p_key) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- current->set_script_encryption_key(p_key);
- updating_script_key = true;
- _update_current_preset();
- updating_script_key = false;
- }
- bool ProjectExportDialog::_validate_script_encryption_key(const String &p_key) {
- bool is_valid = false;
- if (!p_key.empty() && p_key.is_valid_hex_number(false) && p_key.length() == 64) {
- is_valid = true;
- }
- return is_valid;
- }
- void ProjectExportDialog::_duplicate_preset() {
- Ref<EditorExportPreset> current = get_current_preset();
- if (current.is_null()) {
- return;
- }
- Ref<EditorExportPreset> preset = current->get_platform()->create_preset();
- ERR_FAIL_COND(!preset.is_valid());
- String name = current->get_name() + " (copy)";
- bool make_runnable = true;
- while (true) {
- bool valid = true;
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> p = EditorExport::get_singleton()->get_export_preset(i);
- if (p->get_platform() == preset->get_platform() && p->is_runnable()) {
- make_runnable = false;
- }
- if (p->get_name() == name) {
- valid = false;
- break;
- }
- }
- if (valid) {
- break;
- }
- name += " (copy)";
- }
- preset->set_name(name);
- if (make_runnable) {
- preset->set_runnable(make_runnable);
- }
- preset->set_export_filter(current->get_export_filter());
- preset->set_include_filter(current->get_include_filter());
- preset->set_exclude_filter(current->get_exclude_filter());
- preset->set_custom_features(current->get_custom_features());
- for (const List<PropertyInfo>::Element *E = current->get_properties().front(); E; E = E->next()) {
- preset->set(E->get().name, current->get(E->get().name));
- }
- EditorExport::get_singleton()->add_export_preset(preset);
- _update_presets();
- _edit_preset(EditorExport::get_singleton()->get_export_preset_count() - 1);
- }
- void ProjectExportDialog::_delete_preset() {
- Ref<EditorExportPreset> current = get_current_preset();
- if (current.is_null()) {
- return;
- }
- delete_confirm->set_text(vformat(TTR("Delete preset '%s'?"), current->get_name()));
- delete_confirm->popup_centered_minsize();
- }
- void ProjectExportDialog::_delete_preset_confirm() {
- int idx = presets->get_current();
- _edit_preset(-1);
- export_button->set_disabled(true);
- get_ok()->set_disabled(true);
- EditorExport::get_singleton()->remove_export_preset(idx);
- _update_presets();
- // The Export All button might become enabled (if all other presets have an export path defined),
- // or it could be disabled (if there are no presets anymore).
- _update_export_all();
- }
- Variant ProjectExportDialog::get_drag_data_fw(const Point2 &p_point, Control *p_from) {
- if (p_from == presets) {
- int pos = presets->get_item_at_position(p_point, true);
- if (pos >= 0) {
- Dictionary d;
- d["type"] = "export_preset";
- d["preset"] = pos;
- HBoxContainer *drag = memnew(HBoxContainer);
- TextureRect *tr = memnew(TextureRect);
- tr->set_texture(presets->get_item_icon(pos));
- drag->add_child(tr);
- Label *label = memnew(Label);
- label->set_text(presets->get_item_text(pos));
- drag->add_child(label);
- set_drag_preview(drag);
- return d;
- }
- }
- return Variant();
- }
- bool ProjectExportDialog::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const {
- if (p_from == presets) {
- Dictionary d = p_data;
- if (!d.has("type") || String(d["type"]) != "export_preset") {
- return false;
- }
- if (presets->get_item_at_position(p_point, true) < 0 && !presets->is_pos_at_end_of_items(p_point)) {
- return false;
- }
- }
- return true;
- }
- void ProjectExportDialog::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) {
- if (p_from == presets) {
- Dictionary d = p_data;
- int from_pos = d["preset"];
- int to_pos = -1;
- if (presets->get_item_at_position(p_point, true) >= 0) {
- to_pos = presets->get_item_at_position(p_point, true);
- }
- if (to_pos == -1 && !presets->is_pos_at_end_of_items(p_point)) {
- return;
- }
- if (to_pos == from_pos) {
- return;
- } else if (to_pos > from_pos) {
- to_pos--;
- }
- Ref<EditorExportPreset> preset = EditorExport::get_singleton()->get_export_preset(from_pos);
- EditorExport::get_singleton()->remove_export_preset(from_pos);
- EditorExport::get_singleton()->add_export_preset(preset, to_pos);
- _update_presets();
- if (to_pos >= 0) {
- _edit_preset(to_pos);
- } else {
- _edit_preset(presets->get_item_count() - 1);
- }
- }
- }
- void ProjectExportDialog::_export_type_changed(int p_which) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- if (current.is_null()) {
- return;
- }
- current->set_export_filter(EditorExportPreset::ExportFilter(p_which));
- updating = true;
- _fill_resource_tree();
- updating = false;
- }
- void ProjectExportDialog::_filter_changed(const String &p_filter) {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- if (current.is_null()) {
- return;
- }
- current->set_include_filter(include_filters->get_text());
- current->set_exclude_filter(exclude_filters->get_text());
- }
- void ProjectExportDialog::_fill_resource_tree() {
- include_files->clear();
- include_label->hide();
- include_margin->hide();
- Ref<EditorExportPreset> current = get_current_preset();
- if (current.is_null()) {
- return;
- }
- EditorExportPreset::ExportFilter f = current->get_export_filter();
- if (f == EditorExportPreset::EXPORT_ALL_RESOURCES) {
- return;
- }
- include_label->show();
- include_margin->show();
- TreeItem *root = include_files->create_item();
- _fill_tree(EditorFileSystem::get_singleton()->get_filesystem(), root, current, f == EditorExportPreset::EXPORT_SELECTED_SCENES);
- }
- bool ProjectExportDialog::_fill_tree(EditorFileSystemDirectory *p_dir, TreeItem *p_item, Ref<EditorExportPreset> ¤t, bool p_only_scenes) {
- p_item->set_cell_mode(0, TreeItem::CELL_MODE_CHECK);
- p_item->set_icon(0, get_icon("folder", "FileDialog"));
- p_item->set_text(0, p_dir->get_name() + "/");
- p_item->set_editable(0, true);
- p_item->set_metadata(0, p_dir->get_path());
- bool used = false;
- bool checked = true;
- for (int i = 0; i < p_dir->get_subdir_count(); i++) {
- TreeItem *subdir = include_files->create_item(p_item);
- if (_fill_tree(p_dir->get_subdir(i), subdir, current, p_only_scenes)) {
- used = true;
- checked = checked && subdir->is_checked(0);
- } else {
- memdelete(subdir);
- }
- }
- for (int i = 0; i < p_dir->get_file_count(); i++) {
- String type = p_dir->get_file_type(i);
- if (p_only_scenes && type != "PackedScene") {
- continue;
- }
- TreeItem *file = include_files->create_item(p_item);
- file->set_cell_mode(0, TreeItem::CELL_MODE_CHECK);
- file->set_text(0, p_dir->get_file(i));
- String path = p_dir->get_file_path(i);
- file->set_icon(0, EditorNode::get_singleton()->get_class_icon(type));
- file->set_editable(0, true);
- file->set_checked(0, current->has_export_file(path));
- file->set_metadata(0, path);
- checked = checked && file->is_checked(0);
- used = true;
- }
- p_item->set_checked(0, checked);
- return used;
- }
- void ProjectExportDialog::_tree_changed() {
- if (updating) {
- return;
- }
- Ref<EditorExportPreset> current = get_current_preset();
- if (current.is_null()) {
- return;
- }
- TreeItem *item = include_files->get_edited();
- if (!item) {
- return;
- }
- String path = item->get_metadata(0);
- bool added = item->is_checked(0);
- if (path.ends_with("/")) {
- _check_dir_recursive(item, added);
- } else {
- if (added) {
- current->add_export_file(path);
- } else {
- current->remove_export_file(path);
- }
- }
- _refresh_parent_checks(item); // Makes parent folder checked if all files/folders are checked.
- }
- void ProjectExportDialog::_check_dir_recursive(TreeItem *p_dir, bool p_checked) {
- for (TreeItem *child = p_dir->get_children(); child; child = child->get_next()) {
- String path = child->get_metadata(0);
- child->set_checked(0, p_checked);
- if (path.ends_with("/")) {
- _check_dir_recursive(child, p_checked);
- } else {
- if (p_checked) {
- get_current_preset()->add_export_file(path);
- } else {
- get_current_preset()->remove_export_file(path);
- }
- }
- }
- }
- void ProjectExportDialog::_refresh_parent_checks(TreeItem *p_item) {
- TreeItem *parent = p_item->get_parent();
- if (!parent) {
- return;
- }
- bool checked = true;
- for (TreeItem *child = parent->get_children(); child; child = child->get_next()) {
- checked = checked && child->is_checked(0);
- if (!checked) {
- break;
- }
- }
- parent->set_checked(0, checked);
- _refresh_parent_checks(parent);
- }
- void ProjectExportDialog::_export_pck_zip() {
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- String dir = current->get_export_path().get_base_dir();
- export_pck_zip->set_current_dir(dir);
- export_pck_zip->popup_centered_ratio();
- }
- void ProjectExportDialog::_export_pck_zip_selected(const String &p_path) {
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- Ref<EditorExportPlatform> platform = current->get_platform();
- ERR_FAIL_COND(platform.is_null());
- if (p_path.ends_with(".zip")) {
- platform->export_zip(current, export_pck_zip_debug->is_pressed(), p_path);
- } else if (p_path.ends_with(".pck")) {
- platform->export_pack(current, export_pck_zip_debug->is_pressed(), p_path);
- }
- }
- void ProjectExportDialog::_open_export_template_manager() {
- EditorNode::get_singleton()->open_export_template_manager();
- hide();
- }
- void ProjectExportDialog::_validate_export_path(const String &p_path) {
- // Disable export via OK button or Enter key if LineEdit has an empty filename
- bool invalid_path = (p_path.get_file().get_basename() == "");
- // Check if state change before needlessly messing with signals
- if (invalid_path && export_project->get_ok()->is_disabled()) {
- return;
- }
- if (!invalid_path && !export_project->get_ok()->is_disabled()) {
- return;
- }
- if (invalid_path) {
- export_project->get_ok()->set_disabled(true);
- export_project->get_line_edit()->disconnect("text_entered", export_project, "_file_entered");
- } else {
- export_project->get_ok()->set_disabled(false);
- export_project->get_line_edit()->connect("text_entered", export_project, "_file_entered");
- }
- }
- void ProjectExportDialog::_export_project() {
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- Ref<EditorExportPlatform> platform = current->get_platform();
- ERR_FAIL_COND(platform.is_null());
- export_project->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
- export_project->clear_filters();
- List<String> extension_list = platform->get_binary_extensions(current);
- for (int i = 0; i < extension_list.size(); i++) {
- export_project->add_filter("*." + extension_list[i] + " ; " + platform->get_name() + " Export");
- }
- if (current->get_export_path() != "") {
- export_project->set_current_path(current->get_export_path());
- } else {
- if (extension_list.size() >= 1) {
- export_project->set_current_file(default_filename + "." + extension_list[0]);
- } else {
- export_project->set_current_file(default_filename);
- }
- }
- // Ensure that signal is connected if previous attempt left it disconnected with _validate_export_path
- if (!export_project->get_line_edit()->is_connected("text_entered", export_project, "_file_entered")) {
- export_project->get_ok()->set_disabled(false);
- export_project->get_line_edit()->connect("text_entered", export_project, "_file_entered");
- }
- export_project->set_mode(EditorFileDialog::MODE_SAVE_FILE);
- export_project->popup_centered_ratio();
- }
- void ProjectExportDialog::_export_project_to_path(const String &p_path) {
- // Save this name for use in future exports (but drop the file extension)
- default_filename = p_path.get_file().get_basename();
- EditorSettings::get_singleton()->set_project_metadata("export_options", "default_filename", default_filename);
- Ref<EditorExportPreset> current = get_current_preset();
- ERR_FAIL_COND(current.is_null());
- Ref<EditorExportPlatform> platform = current->get_platform();
- ERR_FAIL_COND(platform.is_null());
- current->set_export_path(p_path);
- platform->clear_messages();
- Error err = platform->export_project(current, export_debug->is_pressed(), p_path, 0);
- result_dialog_log->clear();
- if (err != ERR_SKIP) {
- if (platform->fill_log_messages(result_dialog_log, err)) {
- result_dialog->popup_centered_ratio(0.5);
- }
- }
- }
- void ProjectExportDialog::_export_all_dialog() {
- #ifndef ANDROID_ENABLED
- export_all_dialog->show();
- export_all_dialog->popup_centered_minsize(Size2(300, 80));
- #endif
- }
- void ProjectExportDialog::_export_all_dialog_action(const String &p_str) {
- export_all_dialog->hide();
- _export_all(p_str != "release");
- }
- void ProjectExportDialog::_export_all(bool p_debug) {
- String mode = p_debug ? TTR("Debug") : TTR("Release");
- EditorProgress ep("exportall", TTR("Exporting All") + " " + mode, EditorExport::get_singleton()->get_export_preset_count(), true);
- bool show_dialog = false;
- result_dialog_log->clear();
- for (int i = 0; i < EditorExport::get_singleton()->get_export_preset_count(); i++) {
- Ref<EditorExportPreset> preset = EditorExport::get_singleton()->get_export_preset(i);
- ERR_FAIL_COND(preset.is_null());
- Ref<EditorExportPlatform> platform = preset->get_platform();
- ERR_FAIL_COND(platform.is_null());
- ep.step(preset->get_name(), i);
- platform->clear_messages();
- Error err = platform->export_project(preset, p_debug, preset->get_export_path(), 0);
- if (err == ERR_SKIP) {
- return;
- }
- bool has_messages = platform->fill_log_messages(result_dialog_log, err);
- show_dialog = show_dialog || has_messages;
- }
- if (show_dialog) {
- result_dialog->popup_centered_ratio(0.5);
- }
- }
- void ProjectExportDialog::_bind_methods() {
- ClassDB::bind_method("_add_preset", &ProjectExportDialog::_add_preset);
- ClassDB::bind_method("_edit_preset", &ProjectExportDialog::_edit_preset);
- ClassDB::bind_method("_update_parameters", &ProjectExportDialog::_update_parameters);
- ClassDB::bind_method("_runnable_pressed", &ProjectExportDialog::_runnable_pressed);
- ClassDB::bind_method("_name_changed", &ProjectExportDialog::_name_changed);
- ClassDB::bind_method("_duplicate_preset", &ProjectExportDialog::_duplicate_preset);
- ClassDB::bind_method("_delete_preset", &ProjectExportDialog::_delete_preset);
- ClassDB::bind_method("_delete_preset_confirm", &ProjectExportDialog::_delete_preset_confirm);
- ClassDB::bind_method("get_drag_data_fw", &ProjectExportDialog::get_drag_data_fw);
- ClassDB::bind_method("can_drop_data_fw", &ProjectExportDialog::can_drop_data_fw);
- ClassDB::bind_method("drop_data_fw", &ProjectExportDialog::drop_data_fw);
- ClassDB::bind_method("_export_type_changed", &ProjectExportDialog::_export_type_changed);
- ClassDB::bind_method("_filter_changed", &ProjectExportDialog::_filter_changed);
- ClassDB::bind_method("_tree_changed", &ProjectExportDialog::_tree_changed);
- ClassDB::bind_method("_export_pck_zip", &ProjectExportDialog::_export_pck_zip);
- ClassDB::bind_method("_export_pck_zip_selected", &ProjectExportDialog::_export_pck_zip_selected);
- ClassDB::bind_method("_open_export_template_manager", &ProjectExportDialog::_open_export_template_manager);
- ClassDB::bind_method("_validate_export_path", &ProjectExportDialog::_validate_export_path);
- ClassDB::bind_method("_export_path_changed", &ProjectExportDialog::_export_path_changed);
- ClassDB::bind_method("_open_key_help_link", &ProjectExportDialog::_open_key_help_link);
- ClassDB::bind_method("_script_export_mode_changed", &ProjectExportDialog::_script_export_mode_changed);
- ClassDB::bind_method("_script_encryption_key_changed", &ProjectExportDialog::_script_encryption_key_changed);
- ClassDB::bind_method("_export_project", &ProjectExportDialog::_export_project);
- ClassDB::bind_method("_export_project_to_path", &ProjectExportDialog::_export_project_to_path);
- ClassDB::bind_method("_export_all", &ProjectExportDialog::_export_all);
- ClassDB::bind_method("_export_all_dialog", &ProjectExportDialog::_export_all_dialog);
- ClassDB::bind_method("_export_all_dialog_action", &ProjectExportDialog::_export_all_dialog_action);
- ClassDB::bind_method("_custom_features_changed", &ProjectExportDialog::_custom_features_changed);
- ClassDB::bind_method("_tab_changed", &ProjectExportDialog::_tab_changed);
- ClassDB::bind_method("set_export_path", &ProjectExportDialog::set_export_path);
- ClassDB::bind_method("get_export_path", &ProjectExportDialog::get_export_path);
- ClassDB::bind_method("get_current_preset", &ProjectExportDialog::get_current_preset);
- ClassDB::bind_method("_force_update_current_preset_parameters", &ProjectExportDialog::_force_update_current_preset_parameters);
- ADD_PROPERTY(PropertyInfo(Variant::STRING, "export_path"), "set_export_path", "get_export_path");
- }
- ProjectExportDialog::ProjectExportDialog() {
- set_title(TTR("Export"));
- set_resizable(true);
- VBoxContainer *main_vb = memnew(VBoxContainer);
- add_child(main_vb);
- HSplitContainer *hbox = memnew(HSplitContainer);
- main_vb->add_child(hbox);
- hbox->set_v_size_flags(SIZE_EXPAND_FILL);
- // Presets list.
- VBoxContainer *preset_vb = memnew(VBoxContainer);
- preset_vb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
- hbox->add_child(preset_vb);
- HBoxContainer *preset_hb = memnew(HBoxContainer);
- preset_hb->add_child(memnew(Label(TTR("Presets"))));
- preset_hb->add_spacer();
- preset_vb->add_child(preset_hb);
- add_preset = memnew(MenuButton);
- add_preset->set_text(TTR("Add..."));
- add_preset->get_popup()->connect("index_pressed", this, "_add_preset");
- preset_hb->add_child(add_preset);
- MarginContainer *mc = memnew(MarginContainer);
- preset_vb->add_child(mc);
- mc->set_v_size_flags(SIZE_EXPAND_FILL);
- presets = memnew(ItemList);
- presets->set_drag_forwarding(this);
- mc->add_child(presets);
- presets->connect("item_selected", this, "_edit_preset");
- duplicate_preset = memnew(ToolButton);
- duplicate_preset->set_tooltip(TTR("Duplicate"));
- preset_hb->add_child(duplicate_preset);
- duplicate_preset->connect("pressed", this, "_duplicate_preset");
- delete_preset = memnew(ToolButton);
- delete_preset->set_tooltip(TTR("Delete"));
- preset_hb->add_child(delete_preset);
- delete_preset->connect("pressed", this, "_delete_preset");
- // Preset settings.
- VBoxContainer *settings_vb = memnew(VBoxContainer);
- settings_vb->set_h_size_flags(Control::SIZE_EXPAND_FILL);
- hbox->add_child(settings_vb);
- name = memnew(LineEdit);
- settings_vb->add_margin_child(TTR("Name:"), name);
- name->connect("text_changed", this, "_name_changed");
- runnable = memnew(CheckButton);
- runnable->set_text(TTR("Runnable"));
- runnable->set_tooltip(TTR("If checked, the preset will be available for use in one-click deploy.\nOnly one preset per platform may be marked as runnable."));
- runnable->connect("pressed", this, "_runnable_pressed");
- settings_vb->add_child(runnable);
- export_path = memnew(EditorPropertyPath);
- settings_vb->add_child(export_path);
- export_path->set_label(TTR("Export Path"));
- export_path->set_object_and_property(this, "export_path");
- export_path->set_save_mode();
- export_path->connect("property_changed", this, "_export_path_changed");
- // Subsections.
- sections = memnew(TabContainer);
- sections->set_tab_align(TabContainer::ALIGN_LEFT);
- sections->set_use_hidden_tabs_for_min_size(true);
- settings_vb->add_child(sections);
- sections->set_v_size_flags(SIZE_EXPAND_FILL);
- // Main preset parameters.
- parameters = memnew(EditorInspector);
- sections->add_child(parameters);
- parameters->set_name(TTR("Options"));
- parameters->set_v_size_flags(SIZE_EXPAND_FILL);
- parameters->set_property_name_style(EditorPropertyNameProcessor::get_settings_style());
- parameters->connect("property_edited", this, "_update_parameters");
- EditorExport::get_singleton()->connect("export_presets_updated", this, "_force_update_current_preset_parameters");
- // Resources export parameters.
- VBoxContainer *resources_vb = memnew(VBoxContainer);
- sections->add_child(resources_vb);
- resources_vb->set_name(TTR("Resources"));
- export_filter = memnew(OptionButton);
- export_filter->add_item(TTR("Export all resources in the project"));
- export_filter->add_item(TTR("Export selected scenes (and dependencies)"));
- export_filter->add_item(TTR("Export selected resources (and dependencies)"));
- resources_vb->add_margin_child(TTR("Export Mode:"), export_filter);
- export_filter->connect("item_selected", this, "_export_type_changed");
- include_label = memnew(Label);
- include_label->set_text(TTR("Resources to export:"));
- resources_vb->add_child(include_label);
- include_margin = memnew(MarginContainer);
- include_margin->set_v_size_flags(SIZE_EXPAND_FILL);
- resources_vb->add_child(include_margin);
- include_files = memnew(Tree);
- include_margin->add_child(include_files);
- include_files->connect("item_edited", this, "_tree_changed");
- include_filters = memnew(LineEdit);
- resources_vb->add_margin_child(
- TTR("Filters to export non-resource files/folders\n(comma-separated, e.g: *.json, *.txt, docs/*)"),
- include_filters);
- include_filters->connect("text_changed", this, "_filter_changed");
- exclude_filters = memnew(LineEdit);
- resources_vb->add_margin_child(
- TTR("Filters to exclude files/folders from project\n(comma-separated, e.g: *.json, *.txt, docs/*)"),
- exclude_filters);
- exclude_filters->connect("text_changed", this, "_filter_changed");
- // Feature tags.
- VBoxContainer *feature_vb = memnew(VBoxContainer);
- feature_vb->set_name(TTR("Features"));
- custom_features = memnew(LineEdit);
- custom_features->connect("text_changed", this, "_custom_features_changed");
- feature_vb->add_margin_child(TTR("Custom (comma-separated):"), custom_features);
- custom_feature_display = memnew(RichTextLabel);
- custom_feature_display->set_v_size_flags(Control::SIZE_EXPAND_FILL);
- feature_vb->add_margin_child(TTR("Feature List:"), custom_feature_display, true);
- sections->add_child(feature_vb);
- // Script export parameters.
- updating_script_key = false;
- VBoxContainer *script_vb = memnew(VBoxContainer);
- script_vb->set_name(TTR("Script"));
- script_mode = memnew(OptionButton);
- script_vb->add_margin_child(TTR("GDScript Export Mode:"), script_mode);
- script_mode->add_item(TTR("Text"), (int)EditorExportPreset::MODE_SCRIPT_TEXT);
- script_mode->add_item(TTR("Compiled Bytecode (Faster Loading)"), (int)EditorExportPreset::MODE_SCRIPT_COMPILED);
- script_mode->add_item(TTR("Encrypted (Provide Key Below)"), (int)EditorExportPreset::MODE_SCRIPT_ENCRYPTED);
- script_mode->connect("item_selected", this, "_script_export_mode_changed");
- script_key = memnew(LineEdit);
- script_key->connect("text_changed", this, "_script_encryption_key_changed");
- script_key_error = memnew(Label);
- script_key_error->set_text(String::utf8("• ") + TTR("Invalid Encryption Key (must be 64 hexadecimal characters long)"));
- script_key_error->add_color_override("font_color", EditorNode::get_singleton()->get_gui_base()->get_color("error_color", "Editor"));
- script_vb->add_margin_child(TTR("GDScript Encryption Key (256-bits as hexadecimal):"), script_key);
- script_vb->add_child(script_key_error);
- sections->add_child(script_vb);
- Label *sec_info = memnew(Label);
- sec_info->set_text(TTR("Note: Encryption key needs to be stored in the binary,\nyou need to build the export templates from source."));
- script_vb->add_child(sec_info);
- LinkButton *sec_more_info = memnew(LinkButton);
- sec_more_info->set_text(TTR("More Info..."));
- sec_more_info->connect("pressed", this, "_open_key_help_link");
- script_vb->add_child(sec_more_info);
- sections->connect("tab_changed", this, "_tab_changed");
- // Disable by default.
- name->set_editable(false);
- export_path->hide();
- runnable->set_disabled(true);
- duplicate_preset->set_disabled(true);
- delete_preset->set_disabled(true);
- script_key_error->hide();
- sections->hide();
- parameters->edit(nullptr);
- // Deletion dialog.
- delete_confirm = memnew(ConfirmationDialog);
- add_child(delete_confirm);
- delete_confirm->get_ok()->set_text(TTR("Delete"));
- delete_confirm->connect("confirmed", this, "_delete_preset_confirm");
- // Export buttons, dialogs and errors.
- updating = false;
- get_cancel()->set_text(TTR("Close"));
- get_ok()->set_text(TTR("Export PCK/Zip..."));
- get_ok()->set_disabled(true);
- #ifdef ANDROID_ENABLED
- export_button = memnew(Button);
- export_button->hide();
- #else
- export_button = add_button(TTR("Export Project..."), !OS::get_singleton()->get_swap_ok_cancel(), "export");
- #endif
- export_button->connect("pressed", this, "_export_project");
- // Disable initially before we select a valid preset
- export_button->set_disabled(true);
- export_all_dialog = memnew(ConfirmationDialog);
- add_child(export_all_dialog);
- export_all_dialog->set_title(TTR("Export All"));
- export_all_dialog->set_text(TTR("Choose an export mode:"));
- export_all_dialog->get_ok()->hide();
- export_all_dialog->add_button(TTR("Debug"), true, "debug");
- export_all_dialog->add_button(TTR("Release"), true, "release");
- export_all_dialog->connect("custom_action", this, "_export_all_dialog_action");
- #ifdef ANDROID_ENABLED
- export_all_dialog->hide();
- export_all_button = memnew(Button);
- export_all_button->hide();
- #else
- export_all_button = add_button(TTR("Export All..."), !OS::get_singleton()->get_swap_ok_cancel(), "export");
- #endif
- export_all_button->connect("pressed", this, "_export_all_dialog");
- export_all_button->set_disabled(true);
- export_pck_zip = memnew(EditorFileDialog);
- export_pck_zip->add_filter("*.zip ; " + TTR("ZIP File"));
- export_pck_zip->add_filter("*.pck ; " + TTR("Godot Project Pack"));
- export_pck_zip->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
- export_pck_zip->set_mode(EditorFileDialog::MODE_SAVE_FILE);
- add_child(export_pck_zip);
- export_pck_zip->connect("file_selected", this, "_export_pck_zip_selected");
- export_error = memnew(Label);
- main_vb->add_child(export_error);
- export_error->hide();
- export_error->add_color_override("font_color", EditorNode::get_singleton()->get_gui_base()->get_color("error_color", "Editor"));
- export_warning = memnew(Label);
- main_vb->add_child(export_warning);
- export_warning->hide();
- export_warning->add_color_override("font_color", EditorNode::get_singleton()->get_gui_base()->get_color("warning_color", "Editor"));
- export_templates_error = memnew(HBoxContainer);
- main_vb->add_child(export_templates_error);
- export_templates_error->hide();
- Label *export_error2 = memnew(Label);
- export_templates_error->add_child(export_error2);
- export_error2->add_color_override("font_color", EditorNode::get_singleton()->get_gui_base()->get_color("error_color", "Editor"));
- export_error2->set_text(" - " + TTR("Export templates for this platform are missing:") + " ");
- result_dialog = memnew(AcceptDialog);
- result_dialog->set_title(TTR("Project Export"));
- result_dialog_log = memnew(RichTextLabel);
- result_dialog_log->set_custom_minimum_size(Size2(300, 80) * EDSCALE);
- result_dialog->add_child(result_dialog_log);
- main_vb->add_child(result_dialog);
- result_dialog->hide();
- LinkButton *download_templates = memnew(LinkButton);
- download_templates->set_text(TTR("Manage Export Templates"));
- download_templates->set_v_size_flags(SIZE_SHRINK_CENTER);
- export_templates_error->add_child(download_templates);
- download_templates->connect("pressed", this, "_open_export_template_manager");
- export_project = memnew(EditorFileDialog);
- export_project->set_access(EditorFileDialog::ACCESS_FILESYSTEM);
- add_child(export_project);
- export_project->connect("file_selected", this, "_export_project_to_path");
- export_project->get_line_edit()->connect("text_changed", this, "_validate_export_path");
- export_debug = memnew(CheckBox);
- export_debug->set_text(TTR("Export With Debug"));
- export_debug->set_pressed(true);
- export_debug->set_h_size_flags(Control::SIZE_SHRINK_CENTER);
- export_project->get_vbox()->add_child(export_debug);
- export_pck_zip_debug = memnew(CheckBox);
- export_pck_zip_debug->set_text(TTR("Export With Debug"));
- export_pck_zip_debug->set_pressed(true);
- export_pck_zip_debug->set_h_size_flags(Control::SIZE_SHRINK_CENTER);
- export_pck_zip->get_vbox()->add_child(export_pck_zip_debug);
- set_hide_on_ok(false);
- editor_icons = "EditorIcons";
- default_filename = EditorSettings::get_singleton()->get_project_metadata("export_options", "default_filename", "");
- // If no default set, use project name
- if (default_filename == "") {
- // If no project name defined, use a sane default
- default_filename = ProjectSettings::get_singleton()->get("application/config/name");
- if (default_filename == "") {
- default_filename = "UnnamedProject";
- }
- }
- }
- ProjectExportDialog::~ProjectExportDialog() {
- }
|