Only allow absolute paths in XDG environment variables

The XDG Base Directory specification does not allow using relative paths
(which broke things in Godot anyway). If a relative path is detected,
it should be ignored.
This commit is contained in:
Hugo Locurcio 2021-05-07 19:02:35 +02:00
parent aa5552278d
commit 011a99316a
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
3 changed files with 61 additions and 10 deletions

View file

@ -164,7 +164,12 @@ bool OS_LinuxBSD::_check_internal_feature_support(const String &p_feature) {
String OS_LinuxBSD::get_config_path() const { String OS_LinuxBSD::get_config_path() const {
if (has_environment("XDG_CONFIG_HOME")) { if (has_environment("XDG_CONFIG_HOME")) {
if (get_environment("XDG_CONFIG_HOME").is_abs_path()) {
return get_environment("XDG_CONFIG_HOME"); return get_environment("XDG_CONFIG_HOME");
} else {
WARN_PRINT_ONCE("`XDG_CONFIG_HOME` is a relative path. Ignoring its value and falling back to `$HOME/.config` or `.` per the XDG Base Directory specification.");
return has_environment("HOME") ? get_environment("HOME").plus_file(".config") : ".";
}
} else if (has_environment("HOME")) { } else if (has_environment("HOME")) {
return get_environment("HOME").plus_file(".config"); return get_environment("HOME").plus_file(".config");
} else { } else {
@ -174,7 +179,12 @@ String OS_LinuxBSD::get_config_path() const {
String OS_LinuxBSD::get_data_path() const { String OS_LinuxBSD::get_data_path() const {
if (has_environment("XDG_DATA_HOME")) { if (has_environment("XDG_DATA_HOME")) {
if (get_environment("XDG_DATA_HOME").is_abs_path()) {
return get_environment("XDG_DATA_HOME"); return get_environment("XDG_DATA_HOME");
} else {
WARN_PRINT_ONCE("`XDG_DATA_HOME` is a relative path. Ignoring its value and falling back to `$HOME/.local/share` or `get_config_path()` per the XDG Base Directory specification.");
return has_environment("HOME") ? get_environment("HOME").plus_file(".local/share") : get_config_path();
}
} else if (has_environment("HOME")) { } else if (has_environment("HOME")) {
return get_environment("HOME").plus_file(".local/share"); return get_environment("HOME").plus_file(".local/share");
} else { } else {
@ -184,7 +194,12 @@ String OS_LinuxBSD::get_data_path() const {
String OS_LinuxBSD::get_cache_path() const { String OS_LinuxBSD::get_cache_path() const {
if (has_environment("XDG_CACHE_HOME")) { if (has_environment("XDG_CACHE_HOME")) {
if (get_environment("XDG_CACHE_HOME").is_abs_path()) {
return get_environment("XDG_CACHE_HOME"); return get_environment("XDG_CACHE_HOME");
} else {
WARN_PRINT_ONCE("`XDG_CACHE_HOME` is a relative path. Ignoring its value and falling back to `$HOME/.cache` or `get_config_path()` per the XDG Base Directory specification.");
return has_environment("HOME") ? get_environment("HOME").plus_file(".cache") : get_config_path();
}
} else if (has_environment("HOME")) { } else if (has_environment("HOME")) {
return get_environment("HOME").plus_file(".cache"); return get_environment("HOME").plus_file(".cache");
} else { } else {

View file

@ -188,8 +188,14 @@ MainLoop *OS_OSX::get_main_loop() const {
} }
String OS_OSX::get_config_path() const { String OS_OSX::get_config_path() const {
// The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on Windows as well.
if (has_environment("XDG_CONFIG_HOME")) { if (has_environment("XDG_CONFIG_HOME")) {
if (get_environment("XDG_CONFIG_HOME").is_abs_path()) {
return get_environment("XDG_CONFIG_HOME"); return get_environment("XDG_CONFIG_HOME");
} else {
WARN_PRINT_ONCE("`XDG_CONFIG_HOME` is a relative path. Ignoring its value and falling back to `$HOME/Library/Application Support` or `.` per the XDG Base Directory specification.");
return has_environment("HOME") ? get_environment("HOME").plus_file("Library/Application Support") : ".";
}
} else if (has_environment("HOME")) { } else if (has_environment("HOME")) {
return get_environment("HOME").plus_file("Library/Application Support"); return get_environment("HOME").plus_file("Library/Application Support");
} else { } else {
@ -198,16 +204,28 @@ String OS_OSX::get_config_path() const {
} }
String OS_OSX::get_data_path() const { String OS_OSX::get_data_path() const {
// The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on Windows as well.
if (has_environment("XDG_DATA_HOME")) { if (has_environment("XDG_DATA_HOME")) {
if (get_environment("XDG_DATA_HOME").is_abs_path()) {
return get_environment("XDG_DATA_HOME"); return get_environment("XDG_DATA_HOME");
} else {
WARN_PRINT_ONCE("`XDG_DATA_HOME` is a relative path. Ignoring its value and falling back to `get_config_path()` per the XDG Base Directory specification.");
return get_config_path();
}
} else { } else {
return get_config_path(); return get_config_path();
} }
} }
String OS_OSX::get_cache_path() const { String OS_OSX::get_cache_path() const {
// The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on Windows as well.
if (has_environment("XDG_CACHE_HOME")) { if (has_environment("XDG_CACHE_HOME")) {
if (get_environment("XDG_CACHE_HOME").is_abs_path()) {
return get_environment("XDG_CACHE_HOME"); return get_environment("XDG_CACHE_HOME");
} else {
WARN_PRINT_ONCE("`XDG_CACHE_HOME` is a relative path. Ignoring its value and falling back to `$HOME/Libary/Caches` or `get_config_path()` per the XDG Base Directory specification.");
return has_environment("HOME") ? get_environment("HOME").plus_file("Library/Caches") : get_config_path();
}
} else if (has_environment("HOME")) { } else if (has_environment("HOME")) {
return get_environment("HOME").plus_file("Library/Caches"); return get_environment("HOME").plus_file("Library/Caches");
} else { } else {

View file

@ -631,8 +631,14 @@ MainLoop *OS_Windows::get_main_loop() const {
} }
String OS_Windows::get_config_path() const { String OS_Windows::get_config_path() const {
if (has_environment("XDG_CONFIG_HOME")) { // unlikely, but after all why not? // The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on Windows as well.
if (has_environment("XDG_CONFIG_HOME")) {
if (get_environment("XDG_CONFIG_HOME").is_abs_path()) {
return get_environment("XDG_CONFIG_HOME"); return get_environment("XDG_CONFIG_HOME");
} else {
WARN_PRINT_ONCE("`XDG_CONFIG_HOME` is a relative path. Ignoring its value and falling back to `%APPDATA%` or `.` per the XDG Base Directory specification.");
return has_environment("APPDATA") ? get_environment("APPDATA") : ".";
}
} else if (has_environment("APPDATA")) { } else if (has_environment("APPDATA")) {
return get_environment("APPDATA"); return get_environment("APPDATA");
} else { } else {
@ -641,16 +647,28 @@ String OS_Windows::get_config_path() const {
} }
String OS_Windows::get_data_path() const { String OS_Windows::get_data_path() const {
// The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on Windows as well.
if (has_environment("XDG_DATA_HOME")) { if (has_environment("XDG_DATA_HOME")) {
if (get_environment("XDG_DATA_HOME").is_abs_path()) {
return get_environment("XDG_DATA_HOME"); return get_environment("XDG_DATA_HOME");
} else {
WARN_PRINT_ONCE("`XDG_DATA_HOME` is a relative path. Ignoring its value and falling back to `get_config_path()` per the XDG Base Directory specification.");
return get_config_path();
}
} else { } else {
return get_config_path(); return get_config_path();
} }
} }
String OS_Windows::get_cache_path() const { String OS_Windows::get_cache_path() const {
// The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on Windows as well.
if (has_environment("XDG_CACHE_HOME")) { if (has_environment("XDG_CACHE_HOME")) {
if (get_environment("XDG_CACHE_HOME").is_abs_path()) {
return get_environment("XDG_CACHE_HOME"); return get_environment("XDG_CACHE_HOME");
} else {
WARN_PRINT_ONCE("`XDG_CACHE_HOME` is a relative path. Ignoring its value and falling back to `%TEMP%` or `get_config_path()` per the XDG Base Directory specification.");
return has_environment("TEMP") ? get_environment("TEMP") : get_config_path();
}
} else if (has_environment("TEMP")) { } else if (has_environment("TEMP")) {
return get_environment("TEMP"); return get_environment("TEMP");
} else { } else {