Skip to content

Commit a3a1cf0

Browse files
KoBeWiKoBeWi
committed
Replace UID and Surface upgrade tools with universal one
1 parent 30bb49e commit a3a1cf0

7 files changed

+169
-525
lines changed

‎editor/editor_node.cpp

Lines changed: 15 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -158,12 +158,11 @@
158158
#include "editor/plugins/visual_shader_editor_plugin.h"
159159
#include "editor/progress_dialog.h"
160160
#include "editor/project_settings_editor.h"
161+
#include "editor/project_upgrade_tool.h"
161162
#include "editor/register_exporters.h"
162163
#include "editor/scene_tree_dock.h"
163-
#include "editor/surface_upgrade_tool.h"
164164
#include "editor/themes/editor_scale.h"
165165
#include "editor/themes/editor_theme_manager.h"
166-
#include "editor/uid_upgrade_tool.h"
167166
#include "editor/window_wrapper.h"
168167

169168
#include "modules/modules_enabled.gen.h" // For gdscript, mono.
@@ -649,10 +648,7 @@ void EditorNode::_notification(int p_what) {
649648

650649
OS::get_singleton()->benchmark_begin_measure("Editor", "First Scan");
651650

652-
if (run_surface_upgrade_tool || run_uid_upgrade_tool) {
653-
EditorFileSystem::get_singleton()->connect("filesystem_changed", callable_mp(this, &EditorNode::_execute_upgrades), CONNECT_ONE_SHOT);
654-
}
655-
651+
EditorFileSystem::get_singleton()->connect("filesystem_changed", callable_mp(this, &EditorNode::_execute_upgrades), CONNECT_ONE_SHOT);
656652
EditorFileSystem::get_singleton()->scan();
657653
}
658654
} break;
@@ -735,23 +731,6 @@ void EditorNode::_notification(int p_what) {
735731

736732
// Save the project after opening to mark it as last modified, except in headless mode.
737733
if (DisplayServer::get_singleton()->window_can_draw()) {
738-
// Try to determine if this project's Godot version was less than 4.4 - if
739-
// so, we'll ask the user if they want to upgrade the project.
740-
PackedStringArray features = ProjectSettings::get_singleton()->get_setting("application/config/features");
741-
if (!features.is_empty()) {
742-
String version_str = features[0];
743-
PackedStringArray version_parts = version_str.split(".", true, 1);
744-
if (version_parts.size() >= 2) {
745-
if (version_parts[0].is_valid_int() && version_parts[1].is_valid_int()) {
746-
int major_ver = version_parts[0].to_int();
747-
int minor_ver = version_parts[1].to_int();
748-
if (major_ver < 4 || (major_ver == 4 && minor_ver < 4)) {
749-
should_prompt_uid_upgrade_tool = true;
750-
}
751-
}
752-
}
753-
}
754-
755734
ProjectSettings::get_singleton()->save();
756735
}
757736

@@ -896,16 +875,11 @@ void EditorNode::_update_update_spinner() {
896875
}
897876

898877
void EditorNode::_execute_upgrades() {
899-
if (run_surface_upgrade_tool) {
900-
run_surface_upgrade_tool = false;
878+
if (run_project_upgrade_tool) {
879+
run_project_upgrade_tool = false;
901880
// Execute another scan to reimport the modified files.
902-
SurfaceUpgradeTool::get_singleton()->connect("upgrade_finished", callable_mp(EditorFileSystem::get_singleton(), &EditorFileSystem::scan), CONNECT_ONE_SHOT);
903-
SurfaceUpgradeTool::get_singleton()->finish_upgrade();
904-
} else if (run_uid_upgrade_tool) {
905-
run_uid_upgrade_tool = false;
906-
// Execute another scan to reimport the modified files.
907-
UIDUpgradeTool::get_singleton()->connect("upgrade_finished", callable_mp(EditorFileSystem::get_singleton(), &EditorFileSystem::scan), CONNECT_ONE_SHOT);
908-
UIDUpgradeTool::get_singleton()->finish_upgrade();
881+
project_upgrade_tool->connect(project_upgrade_tool->UPGRADE_FINISHED, callable_mp(EditorFileSystem::get_singleton(), &EditorFileSystem::scan), CONNECT_ONE_SHOT);
882+
project_upgrade_tool->finish_upgrade();
909883
}
910884
}
911885

@@ -1202,20 +1176,10 @@ void EditorNode::_sources_changed(bool p_exist) {
12021176
OS::get_singleton()->benchmark_dump();
12031177
}
12041178

1205-
if (SurfaceUpgradeTool::get_singleton()->is_show_requested()) {
1206-
SurfaceUpgradeTool::get_singleton()->show_popup();
1207-
}
1208-
12091179
// Start preview thread now that it's safe.
12101180
if (!singleton->cmdline_mode) {
12111181
EditorResourcePreview::get_singleton()->start();
12121182
}
1213-
1214-
if (should_prompt_uid_upgrade_tool) {
1215-
should_prompt_uid_upgrade_tool = false;
1216-
uid_upgrade_dialog->popup_on_demand();
1217-
}
1218-
12191183
get_tree()->create_timer(1.0f)->connect("timeout", callable_mp(this, &EditorNode::_remove_lock_file));
12201184
}
12211185
}
@@ -3349,11 +3313,8 @@ void EditorNode::_tool_menu_option(int p_idx) {
33493313
case TOOLS_BUILD_PROFILE_MANAGER: {
33503314
build_profile_manager->popup_centered_clamped(Size2(700, 800) * EDSCALE, 0.8);
33513315
} break;
3352-
case TOOLS_SURFACE_UPGRADE: {
3353-
surface_upgrade_dialog->popup_on_demand();
3354-
} break;
3355-
case TOOLS_UID_UPGRADE: {
3356-
uid_upgrade_dialog->popup_on_demand();
3316+
case TOOLS_PROJECT_UPGRADE: {
3317+
project_upgrade_tool->popup_dialog();
33573318
} break;
33583319
case TOOLS_CUSTOM: {
33593320
if (tool_menu->get_item_submenu(p_idx) == "") {
@@ -6963,18 +6924,11 @@ EditorNode::EditorNode() {
69636924

69646925
_update_vsync_mode();
69656926

6966-
// Warm up the surface upgrade tool as early as possible.
6967-
surface_upgrade_tool = memnew(SurfaceUpgradeTool);
6968-
run_surface_upgrade_tool = EditorSettings::get_singleton()->get_project_metadata("surface_upgrade_tool", "run_on_restart", false);
6969-
if (run_surface_upgrade_tool) {
6970-
SurfaceUpgradeTool::get_singleton()->begin_upgrade();
6971-
}
6972-
6973-
// Same for UID upgrade tool.
6974-
uid_upgrade_tool = memnew(UIDUpgradeTool);
6975-
run_uid_upgrade_tool = EditorSettings::get_singleton()->get_project_metadata(UIDUpgradeTool::META_UID_UPGRADE_TOOL, UIDUpgradeTool::META_RUN_ON_RESTART, false);
6976-
if (run_uid_upgrade_tool) {
6977-
UIDUpgradeTool::get_singleton()->begin_upgrade();
6927+
// Warm up the project upgrade tool as early as possible.
6928+
project_upgrade_tool = memnew(ProjectUpgradeTool);
6929+
run_project_upgrade_tool = EditorSettings::get_singleton()->get_project_metadata(project_upgrade_tool->META_PROJECT_UPGRADE_TOOL, project_upgrade_tool->META_RUN_ON_RESTART, false);
6930+
if (run_project_upgrade_tool) {
6931+
project_upgrade_tool->begin_upgrade();
69786932
}
69796933

69806934
{
@@ -7518,8 +7472,7 @@ EditorNode::EditorNode() {
75187472
project_menu->add_submenu_node_item(TTR("Tools"), tool_menu);
75197473
tool_menu->add_shortcut(ED_SHORTCUT_AND_COMMAND("editor/orphan_resource_explorer", TTRC("Orphan Resource Explorer...")), TOOLS_ORPHAN_RESOURCES);
75207474
tool_menu->add_shortcut(ED_SHORTCUT_AND_COMMAND("editor/engine_compilation_configuration_editor", TTRC("Engine Compilation Configuration Editor...")), TOOLS_BUILD_PROFILE_MANAGER);
7521-
tool_menu->add_shortcut(ED_SHORTCUT_AND_COMMAND("editor/upgrade_mesh_surfaces", TTRC("Upgrade Mesh Surfaces...")), TOOLS_SURFACE_UPGRADE);
7522-
tool_menu->add_shortcut(ED_SHORTCUT_AND_COMMAND("editor/upgrade_uids", TTRC("Upgrade UIDs...")), TOOLS_UID_UPGRADE);
7475+
tool_menu->add_shortcut(ED_SHORTCUT_AND_COMMAND("editor/upgrade_project", TTRC("Upgrade Project Files...")), TOOLS_PROJECT_UPGRADE);
75237476

75247477
project_menu->add_separator();
75257478
project_menu->add_shortcut(ED_SHORTCUT("editor/reload_current_project", TTRC("Reload Current Project")), PROJECT_RELOAD_CURRENT_PROJECT);
@@ -7797,12 +7750,6 @@ EditorNode::EditorNode() {
77977750
orphan_resources = memnew(OrphanResourcesDialog);
77987751
gui_base->add_child(orphan_resources);
77997752

7800-
surface_upgrade_dialog = memnew(SurfaceUpgradeDialog);
7801-
gui_base->add_child(surface_upgrade_dialog);
7802-
7803-
uid_upgrade_dialog = memnew(UIDUpgradeDialog);
7804-
gui_base->add_child(uid_upgrade_dialog);
7805-
78067753
confirmation = memnew(ConfirmationDialog);
78077754
gui_base->add_child(confirmation);
78087755
confirmation->connect(SceneStringName(confirmed), callable_mp(this, &EditorNode::_menu_confirm_current));
@@ -8196,8 +8143,7 @@ EditorNode::~EditorNode() {
81968143
memdelete(editor_plugins_force_over);
81978144
memdelete(editor_plugins_force_input_forwarding);
81988145
memdelete(progress_hb);
8199-
memdelete(surface_upgrade_tool);
8200-
memdelete(uid_upgrade_tool);
8146+
memdelete(project_upgrade_tool);
82018147
memdelete(editor_dock_manager);
82028148

82038149
EditorSettings::destroy();

‎editor/editor_node.h

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,7 @@ class ProgressDialog;
9797
class ProjectExportDialog;
9898
class ProjectSettingsEditor;
9999
class SceneImportSettingsDialog;
100-
class SurfaceUpgradeTool;
101-
class SurfaceUpgradeDialog;
102-
class UIDUpgradeTool;
103-
class UIDUpgradeDialog;
100+
class ProjectUpgradeTool;
104101

105102
struct EditorProgress {
106103
String task;
@@ -166,8 +163,7 @@ class EditorNode : public Node {
166163

167164
TOOLS_ORPHAN_RESOURCES,
168165
TOOLS_BUILD_PROFILE_MANAGER,
169-
TOOLS_SURFACE_UPGRADE,
170-
TOOLS_UID_UPGRADE,
166+
TOOLS_PROJECT_UPGRADE,
171167
TOOLS_CUSTOM,
172168

173169
VCS_METADATA,
@@ -226,7 +222,6 @@ class EditorNode : public Node {
226222

227223
private:
228224
friend class EditorSceneTabs;
229-
friend class SurfaceUpgradeTool;
230225

231226
enum {
232227
MAX_INIT_CALLBACKS = 128,
@@ -460,16 +455,8 @@ class EditorNode : public Node {
460455

461456
HashMap<String, Ref<Texture2D>> icon_type_cache;
462457

463-
SurfaceUpgradeTool *surface_upgrade_tool = nullptr;
464-
SurfaceUpgradeDialog *surface_upgrade_dialog = nullptr;
465-
466-
bool run_surface_upgrade_tool = false;
467-
468-
UIDUpgradeTool *uid_upgrade_tool = nullptr;
469-
UIDUpgradeDialog *uid_upgrade_dialog = nullptr;
470-
471-
bool run_uid_upgrade_tool = false;
472-
bool should_prompt_uid_upgrade_tool = false;
458+
ProjectUpgradeTool *project_upgrade_tool = nullptr;
459+
bool run_project_upgrade_tool = false;
473460

474461
bool was_window_windowed_last = false;
475462

‎editor/project_upgrade_tool.cpp

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
/**************************************************************************/
2+
/* project_upgrade_tool.cpp */
3+
/**************************************************************************/
4+
/* This file is part of: */
5+
/* GODOT ENGINE */
6+
/* https://godotengine.org */
7+
/**************************************************************************/
8+
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9+
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10+
/* */
11+
/* Permission is hereby granted, free of charge, to any person obtaining */
12+
/* a copy of this software and associated documentation files (the */
13+
/* "Software"), to deal in the Software without restriction, including */
14+
/* without limitation the rights to use, copy, modify, merge, publish, */
15+
/* distribute, sublicense, and/or sell copies of the Software, and to */
16+
/* permit persons to whom the Software is furnished to do so, subject to */
17+
/* the following conditions: */
18+
/* */
19+
/* The above copyright notice and this permission notice shall be */
20+
/* included in all copies or substantial portions of the Software. */
21+
/* */
22+
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23+
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24+
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25+
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26+
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27+
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28+
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29+
/**************************************************************************/
30+
31+
#include "project_upgrade_tool.h"
32+
33+
#include "core/io/dir_access.h"
34+
#include "editor/editor_file_system.h"
35+
#include "editor/editor_node.h"
36+
#include "editor/editor_settings.h"
37+
#include "editor/gui/editor_scene_tabs.h"
38+
#include "editor/themes/editor_scale.h"
39+
#include "scene/gui/dialogs.h"
40+
41+
void ProjectUpgradeTool::_add_files(EditorFileSystemDirectory *p_dir, Vector<String> &r_reimport_paths, Vector<String> &r_resave_scenes, Vector<String> &r_resave_resources) {
42+
Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
43+
for (int i = 0; i < p_dir->get_file_count(); i++) {
44+
const String path = p_dir->get_file_path(i);
45+
const String ext = path.get_extension();
46+
if (ext == "tscn" || ext == "scn") {
47+
r_resave_scenes.append(path);
48+
} else if (ext == "tres" || ext == "res") {
49+
r_resave_resources.append(path);
50+
} else if (da->file_exists(path + ".import")) {
51+
r_reimport_paths.append(path);
52+
}
53+
}
54+
55+
for (int i = 0; i < p_dir->get_subdir_count(); i++) {
56+
_add_files(p_dir->get_subdir(i), r_reimport_paths, r_resave_scenes, r_resave_resources);
57+
}
58+
}
59+
60+
void ProjectUpgradeTool::_bind_methods() {
61+
ADD_SIGNAL(MethodInfo("upgrade_finished"));
62+
}
63+
64+
void ProjectUpgradeTool::popup_dialog() {
65+
if (!upgrade_dialog) {
66+
upgrade_dialog = memnew(ConfirmationDialog);
67+
upgrade_dialog->set_autowrap(true);
68+
upgrade_dialog->set_text(TTRC("Different engine version may have minor differences in various Resources, like additional fields or removed properties. When upgrading the project to a new version, such changes can cause diffs when saving scenes or resources, or reimporting.\n\nThis tool ensures that such changes are performed all at once. It will:\n- Regenerate UID cache\n- Load and re-save every text/binary Resource\n- Reimport every importable Resource\n\nFull upgrade will take considerable amount of time, but afterwards saving/reimporting any scene/resource should not cause unintended changes."));
69+
upgrade_dialog->get_ok_button()->set_text(TTRC("Restart & Upgrade"));
70+
upgrade_dialog->get_label()->set_custom_minimum_size(Size2(750 * EDSCALE, 0));
71+
EditorNode::get_singleton()->get_gui_base()->add_child(upgrade_dialog);
72+
upgrade_dialog->connect(SceneStringName(confirmed), callable_mp(this, &ProjectUpgradeTool::prepare_upgrade));
73+
}
74+
upgrade_dialog->popup_centered();
75+
}
76+
77+
void ProjectUpgradeTool::prepare_upgrade() {
78+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RUN_ON_RESTART, true);
79+
80+
Vector<String> reimport_paths;
81+
Vector<String> resave_scenes;
82+
Vector<String> resave_resources;
83+
_add_files(EditorFileSystem::get_singleton()->get_filesystem(), reimport_paths, resave_scenes, resave_resources);
84+
85+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_REIMPORT_PATHS, reimport_paths);
86+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RESAVE_SCENES, resave_scenes);
87+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RESAVE_RESOURCES, resave_resources);
88+
89+
// Delay to avoid deadlocks, since this dialog can be triggered by loading a scene.
90+
callable_mp(EditorNode::get_singleton(), &EditorNode::restart_editor).call_deferred(false);
91+
}
92+
93+
void ProjectUpgradeTool::begin_upgrade() {
94+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RUN_ON_RESTART, false);
95+
DirAccess::remove_absolute("res://.godot/uid_cache.bin");
96+
}
97+
98+
void ProjectUpgradeTool::finish_upgrade() {
99+
EditorNode::get_singleton()->trigger_menu_option(EditorSceneTabs::SCENE_CLOSE_ALL, true);
100+
101+
Vector<String> paths = EditorSettings::get_singleton()->get_project_metadata(META_PROJECT_UPGRADE_TOOL, META_REIMPORT_PATHS, Vector<String>());
102+
EditorFileSystem::get_singleton()->reimport_files(paths);
103+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_REIMPORT_PATHS, Variant());
104+
105+
{
106+
paths = EditorSettings::get_singleton()->get_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RESAVE_SCENES, Vector<String>());
107+
EditorProgress ep("uid_upgrade_resave", TTR("Updating Project Scenes"), paths.size());
108+
109+
int step = 0;
110+
for (const String &file_path : paths) {
111+
ep.step(TTR("Re-saving scene:") + " " + file_path, step++);
112+
EditorNode::get_singleton()->load_scene(file_path);
113+
EditorNode::get_singleton()->trigger_menu_option(EditorNode::FILE_SAVE_SCENE, true);
114+
EditorNode::get_singleton()->trigger_menu_option(EditorNode::FILE_CLOSE, true);
115+
}
116+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RESAVE_SCENES, Variant());
117+
}
118+
119+
{
120+
paths = EditorSettings::get_singleton()->get_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RESAVE_RESOURCES, Vector<String>());
121+
EditorProgress ep("uid_upgrade_resave", TTR("Updating Project Resources"), paths.size());
122+
123+
int step = 0;
124+
for (const String &file_path : paths) {
125+
ep.step(TTR("Re-saving resource:") + " " + file_path, step++);
126+
Ref<Resource> res = ResourceLoader::load(file_path, "", ResourceFormatLoader::CACHE_MODE_REPLACE);
127+
if (res.is_valid()) {
128+
ResourceSaver::save(res);
129+
}
130+
}
131+
EditorSettings::get_singleton()->set_project_metadata(META_PROJECT_UPGRADE_TOOL, META_RESAVE_RESOURCES, Variant());
132+
}
133+
134+
emit_signal(UPGRADE_FINISHED);
135+
}

0 commit comments

Comments
 (0)