diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2024-06-24 20:09:44 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2024-06-26 17:42:47 +0200 |
| commit | 492787b134cf32b6ad058cb9cb8fd4c85207d1ff (patch) | |
| tree | 5d6b3e36ee48d94c03777483e87319498ede8236 | |
| parent | 93fc9b885798a850e82976c24919cc39d9d4e34b (diff) | |
| download | redot-engine-492787b134cf32b6ad058cb9cb8fd4c85207d1ff.tar.gz | |
Prevent folder names with trailing periods from being used automatically
Folder names ending with one or more `.` characters are not allowed
on Windows, so this would break writing logs, shader cache and other
project-specific files. Trailing periods are now stripped in this case.
On non-Windows platforms, this change still applies in the interest
of portability.
| -rw-r--r-- | core/os/os.cpp | 5 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 1 |
2 files changed, 5 insertions, 1 deletions
diff --git a/core/os/os.cpp b/core/os/os.cpp index 40d8601af3..642de11a9f 100644 --- a/core/os/os.cpp +++ b/core/os/os.cpp @@ -247,7 +247,10 @@ String OS::get_safe_dir_name(const String &p_dir_name, bool p_allow_paths) const for (int i = 0; i < invalid_chars.size(); i++) { safe_dir_name = safe_dir_name.replace(invalid_chars[i], "-"); } - return safe_dir_name; + + // Trim trailing periods from the returned value as it's not valid for folder names on Windows. + // This check is still applied on non-Windows platforms so the returned value is consistent across platforms. + return safe_dir_name.rstrip("."); } // Path to data, config, cache, etc. OS-specific folders diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 405e8340f3..8085b20730 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -271,6 +271,7 @@ <member name="application/config/custom_user_dir_name" type="String" setter="" getter="" default=""""> This user directory is used for storing persistent data ([code]user://[/code] filesystem). If a custom directory name is defined, this name will be appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect. + [b]Note:[/b] If [member application/config/custom_user_dir_name] contains trailing periods, they will be stripped as folder names ending with a period are not allowed on Windows. </member> <member name="application/config/description" type="String" setter="" getter="" default=""""> The project's description, displayed as a tooltip in the Project Manager when hovering the project. |