Refactor editor paths validation in EditorPaths and EditorSettings

- EditorSettings: Ensure that `create()` makes a valid singleton. Fixes #49179, fixes #49450. - EditorPaths: Cleanup code, properly set `paths_valid`. - EditorPaths: Move more paths validation (check, mkdir) from EditorSettings for a better separation of concerns. - EditorPaths: Move EditorFileSystem creation of `.godot/imported` next to other paths.
godotengine · Jun 14, 2021 · 1074017 · 1074017
1 parent 16027e7
commit 1074017
Show file tree

Hide file tree

Showing 8 changed files with 134 additions and 156 deletions.
diff --git a/editor/editor_file_system.cpp b/editor/editor_file_system.cpp
@@ -1934,19 +1934,6 @@ void EditorFileSystem::_reimport_thread(uint32_t p_index, ImportThreadData *p_im
 }
 
 void EditorFileSystem::reimport_files(const Vector<String> &p_files) {
-	{
-		// Ensure that ProjectSettings::IMPORTED_FILES_PATH exists.
-		DirAccess *da = DirAccess::open("res://");
-		if (da->change_dir(ProjectSettings::IMPORTED_FILES_PATH) != OK) {
-			Error err = da->make_dir_recursive(ProjectSettings::IMPORTED_FILES_PATH);
-			if (err || da->change_dir(ProjectSettings::IMPORTED_FILES_PATH) != OK) {
-				memdelete(da);
-				ERR_FAIL_MSG("Failed to create '" + ProjectSettings::IMPORTED_FILES_PATH + "' folder.");
-			}
-		}
-		memdelete(da);
-	}
-
 	importing = true;
 	EditorProgress pr("reimport", TTR("(Re)Importing Assets"), p_files.size());
 
@@ -2177,13 +2164,9 @@ EditorFileSystem::EditorFileSystem() {
 	scanning_changes = false;
 	scanning_changes_done = false;
 
-	DirAccess *da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
-	if (da->change_dir(ProjectSettings::IMPORTED_FILES_PATH) != OK) {
-		da->make_dir(ProjectSettings::IMPORTED_FILES_PATH);
-	}
 	// This should probably also work on Unix and use the string it returns for FAT32 or exFAT
+	DirAccessRef da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
 	using_fat32_or_exfat = (da->get_filesystem_type() == "FAT32" || da->get_filesystem_type() == "exFAT");
-	memdelete(da);
 
 	scan_total = 0;
 	update_script_classes_queued.clear();

diff --git a/editor/editor_node.cpp b/editor/editor_node.cpp
@@ -3728,10 +3728,6 @@ bool EditorNode::is_scene_in_use(const String &p_path) {
 	return false;
 }
 
-void EditorNode::register_editor_paths(bool p_for_project_manager) {
-	EditorPaths::create(p_for_project_manager);
-}
-
 void EditorNode::register_editor_types() {
 	ResourceLoader::set_timestamp_on_load(true);
 	ResourceSaver::set_timestamp_on_save(true);

diff --git a/editor/editor_node.h b/editor/editor_node.h
@@ -798,7 +798,6 @@ class EditorNode : public Node {
 
 	Error export_preset(const String &p_preset, const String &p_path, bool p_debug, bool p_pack_only);
 
-	static void register_editor_paths(bool p_for_project_manager);
 	static void register_editor_types();
 	static void unregister_editor_types();
 

diff --git a/editor/editor_paths.cpp b/editor/editor_paths.cpp
@@ -29,8 +29,12 @@
 /*************************************************************************/
 
 #include "editor_paths.h"
+
+#include "core/config/engine.h"
+#include "core/config/project_settings.h"
 #include "core/io/dir_access.h"
 #include "core/os/os.h"
+#include "main/main.h" // For `is_project_manager`.
 
 EditorPaths *EditorPaths::singleton = nullptr;
 
@@ -41,23 +45,32 @@ bool EditorPaths::are_paths_valid() const {
 String EditorPaths::get_data_dir() const {
 	return data_dir;
 }
+
 String EditorPaths::get_config_dir() const {
 	return config_dir;
 }
+
 String EditorPaths::get_cache_dir() const {
 	return cache_dir;
 }
+
+String EditorPaths::get_project_data_dir() const {
+	return project_data_dir;
+}
+
 bool EditorPaths::is_self_contained() const {
 	return self_contained;
 }
+
 String EditorPaths::get_self_contained_file() const {
 	return self_contained_file;
 }
 
-void EditorPaths::create(bool p_for_project_manager) {
+void EditorPaths::create() {
 	ERR_FAIL_COND(singleton != nullptr);
-	memnew(EditorPaths(p_for_project_manager));
+	memnew(EditorPaths());
 }
+
 void EditorPaths::free() {
 	ERR_FAIL_COND(singleton == nullptr);
 	memdelete(singleton);
@@ -71,9 +84,10 @@ void EditorPaths::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_self_contained_file"), &EditorPaths::get_self_contained_file);
 }
 
-EditorPaths::EditorPaths(bool p_for_project_mamanger) {
+EditorPaths::EditorPaths() {
 	singleton = this;
 
+	// Self-contained mode if a `._sc_` or `_sc_` file is present in executable dir.
 	String exe_path = OS::get_singleton()->get_executable_path().get_base_dir();
 	{
 		DirAccessRef d = DirAccess::create_for_path(exe_path);
@@ -100,13 +114,13 @@ EditorPaths::EditorPaths(bool p_for_project_mamanger) {
 		cache_path = exe_path;
 		cache_dir = data_dir.plus_file("cache");
 	} else {
-		// Typically XDG_DATA_HOME or %APPDATA%
+		// Typically XDG_DATA_HOME or %APPDATA%.
 		data_path = OS::get_singleton()->get_data_path();
 		data_dir = data_path.plus_file(OS::get_singleton()->get_godot_dir_name());
-		// Can be different from data_path e.g. on Linux or macOS
+		// Can be different from data_path e.g. on Linux or macOS.
 		config_path = OS::get_singleton()->get_config_path();
 		config_dir = config_path.plus_file(OS::get_singleton()->get_godot_dir_name());
-		// Can be different from above paths, otherwise a subfolder of data_dir
+		// Can be different from above paths, otherwise a subfolder of data_dir.
 		cache_path = OS::get_singleton()->get_cache_path();
 		if (cache_path == data_path) {
 			cache_dir = data_dir.plus_file("cache");
@@ -116,37 +130,85 @@ EditorPaths::EditorPaths(bool p_for_project_mamanger) {
 	}
 
 	paths_valid = (data_path != "" && config_path != "" && cache_path != "");
+	ERR_FAIL_COND_MSG(!paths_valid, "Editor data, config, or cache paths are invalid.");
+
+	// Validate or create each dir and its relevant subdirectories.
 
-	if (paths_valid) {
-		DirAccessRef dir = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
+	DirAccessRef dir = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
+
+	// Data dir.
+	{
 		if (dir->change_dir(data_dir) != OK) {
 			dir->make_dir_recursive(data_dir);
 			if (dir->change_dir(data_dir) != OK) {
-				ERR_PRINT("Cannot create data directory!");
+				ERR_PRINT("Could not create editor data directory: " + data_dir);
 				paths_valid = false;
 			}
 		}
 
-		// Validate/create cache dir
+		if (!dir->dir_exists("templates")) {
+			dir->make_dir("templates");
+		}
+	}
 
-		if (dir->change_dir(EditorPaths::get_singleton()->get_cache_dir()) != OK) {
+	// Config dir.
+	{
+		if (dir->change_dir(config_dir) != OK) {
+			dir->make_dir_recursive(config_dir);
+			if (dir->change_dir(config_dir) != OK) {
+				ERR_PRINT("Could not create editor config directory: " + config_dir);
+				paths_valid = false;
+			}
+		}
+
+		if (!dir->dir_exists("text_editor_themes")) {
+			dir->make_dir("text_editor_themes");
+		}
+		if (!dir->dir_exists("script_templates")) {
+			dir->make_dir("script_templates");
+		}
+		if (!dir->dir_exists("feature_profiles")) {
+			dir->make_dir("feature_profiles");
+		}
+	}
+
+	// Cache dir.
+	{
+		if (dir->change_dir(cache_dir) != OK) {
 			dir->make_dir_recursive(cache_dir);
 			if (dir->change_dir(cache_dir) != OK) {
-				ERR_PRINT("Cannot create cache directory!");
+				ERR_PRINT("Could not create editor cache directory: " + cache_dir);
+				paths_valid = false;
 			}
 		}
+	}
 
-		if (p_for_project_mamanger) {
-			Engine::get_singleton()->set_shader_cache_path(get_data_dir());
-		} else {
-			DirAccessRef dir2 = DirAccess::open("res://");
-			if (dir2->change_dir(".godot") != OK) { //ensure the .godot subdir exists
-				if (dir2->make_dir(".godot") != OK) {
-					ERR_PRINT("Cannot create res://.godot directory!");
-				}
+	// Validate or create project-specific editor data dir (`res://.godot`),
+	// including shader cache subdir.
+
+	if (Main::is_project_manager()) {
+		// Nothing to create, use shared editor data dir for shader cache.
+		Engine::get_singleton()->set_shader_cache_path(data_dir);
+	} else {
+		DirAccessRef dir_res = DirAccess::create(DirAccess::ACCESS_RESOURCES);
+		if (dir_res->change_dir(project_data_dir) != OK) {
+			dir_res->make_dir_recursive(project_data_dir);
+			if (dir_res->change_dir(project_data_dir) != OK) {
+				ERR_PRINT("Could not create project data directory (" + project_data_dir + ") in: " + dir_res->get_current_dir());
+				paths_valid = false;
 			}
+		}
+		Engine::get_singleton()->set_shader_cache_path(project_data_dir);
 
-			Engine::get_singleton()->set_shader_cache_path("res://.godot");
+		// Editor metadata dir.
+		if (!dir_res->dir_exists("editor")) {
+			dir_res->make_dir("editor");
+		}
+		// Imported assets dir.
+		if (!dir_res->dir_exists(ProjectSettings::IMPORTED_FILES_PATH)) {
+			dir_res->make_dir(ProjectSettings::IMPORTED_FILES_PATH);
 		}
 	}
+
+	print_line("paths valid: " + itos((int)paths_valid));
 }
diff --git a/editor/editor_paths.h b/editor/editor_paths.h
@@ -28,20 +28,22 @@
 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
 /*************************************************************************/
 
-#ifndef EDITORPATHS_H
-#define EDITORPATHS_H
+#ifndef EDITOR_PATHS_H
+#define EDITOR_PATHS_H
 
-#include "core/config/engine.h"
+#include "core/object/class_db.h"
+#include "core/string/ustring.h"
 
 class EditorPaths : public Object {
 	GDCLASS(EditorPaths, Object)
 
-	bool paths_valid = false;
-	String data_dir; //editor data dir
-	String config_dir; //editor config dir
-	String cache_dir; //editor cache dir
-	bool self_contained = false; //true if running self contained
-	String self_contained_file; //self contained file with configuration
+	bool paths_valid = false; // If any of the paths can't be created, this is false.
+	String data_dir; // Editor data (templates, shader cache, etc.).
+	String config_dir; // Editor config (settings, profiles, themes, etc.).
+	String cache_dir; // Editor cache (thumbnails, tmp generated files).
+	String project_data_dir = "res://.godot"; // Project-specific data (metadata, shader cache, etc.).
+	bool self_contained = false; // Self-contained means everything goes to `editor_data` dir.
+	String self_contained_file; // Self-contained file with configuration.
 
 	static EditorPaths *singleton;
 
@@ -54,17 +56,19 @@ class EditorPaths : public Object {
 	String get_data_dir() const;
 	String get_config_dir() const;
 	String get_cache_dir() const;
+	String get_project_data_dir() const;
+
 	bool is_self_contained() const;
 	String get_self_contained_file() const;
 
 	static EditorPaths *get_singleton() {
 		return singleton;
 	}
 
-	static void create(bool p_for_project_manager);
+	static void create();
 	static void free();
 
-	EditorPaths(bool p_for_project_mamanger = false);
+	EditorPaths();
 };
 
-#endif // EDITORPATHS_H
+#endif // EDITOR_PATHS_H