LIV2/amiberry
1
0
Fork 0
mirror of https://github.com/LIV2/amiberry.git synced 2025-12-06 06:32:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

enhancement: use XDG_*_HOME in a more standard way (#1458)

Browse Source 
These variables are defined in the XDG Base Directory specification
(https://specifications.freedesktop.org/basedir-spec/latest/).

Previously, amiberry only used the XDG directories if XDG_DATA_HOME or
XDG_CONFIG_HOME were defined. However, these variables are usually only
set if the user wants to use a non-standard directory (e.g. in the
Flatpak environment).

After this commit, amiberry now computes the standard default values for
these variables based on HOME if they aren't defined, and checks for the
existence of:

- XDG_DATA_HOME/amiberry - used as Amiberry's home directory
- XDG_DATA_HOME/amiberry/data - used as Amiberry's data directory
- XDG_CONFIG_HOME/amiberry - used as Amiberry's config directory
- XDG_DATA_HOME/amiberry/conf - used as Amiberry's config directory

If they don't exist, then ~/Amiberry will be created and used as before.

The effect of this is that if a user wants to avoid having ~/Amiberry in
their home directory, they can just rename ~/Amiberry to
~/.local/state/amiberry, and it'll use that path instead. They can
optionally move Amiberry/conf to ~/.config/amiberry as well.
This commit is contained in:
Adam Sampson 2024-10-06 10:24:23 +01:00 committed by GitHub
parent 07184fe386
commit 9931c27d6c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 57 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
flatpak/com.blitterstudio.amiberry.yml
View File

@ -105,4 +105,4 @@ modules:
- type: script
dest-filename: amiberry.sh
commands:
- "if [ ! -e \"$XDG_DATA_HOME/data\" ]; then cp -R /app/data/* $XDG_DATA_HOME; fi; exec /app/bin/amiberry"
- "if [ ! -e \"$XDG_DATA_HOME/amiberry/data\" ]; then mkdir -p \"$XDG_DATA_HOME/amiberry\"; cp -R /app/data/* \"$XDG_DATA_HOME/amiberry\"; fi; exec /app/bin/amiberry"

79
src/osdep/amiberry.cpp
View File

@ -4171,6 +4171,38 @@ bool directory_exists(std::string directory, const std::string& sub_dir)
return my_existsdir(directory.c_str());
}
// Get the value of one of the XDG_*_HOME variables, as per the spec:
// https://specifications.freedesktop.org/basedir-spec/latest/
static std::string get_xdg_home(const char *var, const std::string& suffix)
{
// If the variable is set explicitly, return its value
const auto env_value = getenv(var);
if (env_value != nullptr)
{
return { env_value };
}
// If HOME is set, construct the default value relative to it
const auto home_dir = getenv("HOME");
if (home_dir != nullptr)
{
return std::string(home_dir) + suffix;
}
// Return "" so directory_exists will fail
return { "" };
}
static std::string get_xdg_data_home()
{
return get_xdg_home("XDG_DATA_HOME", "/.local/share");
}
static std::string get_xdg_config_home()
{
return get_xdg_home("XDG_CONFIG_HOME", "/.config");
}
std::string get_data_directory()
{
#ifdef __MACH__
@ -4193,7 +4225,7 @@ std::string get_data_directory()
return directory + "/Resources/data/";
#else
const auto env_data_dir = getenv("AMIBERRY_DATA_DIR");
const auto xdg_data_home = getenv("XDG_DATA_HOME");
const auto xdg_data_home = get_xdg_data_home();
if (env_data_dir != nullptr && directory_exists(env_data_dir, "/data"))
{
@ -4208,10 +4240,10 @@ std::string get_data_directory()
write_log("Using data directory from " AMIBERRY_DATADIR "\n");
return AMIBERRY_DATADIR;
}
if (xdg_data_home != nullptr && directory_exists(xdg_data_home, "/amiberry/data"))
if (directory_exists(xdg_data_home, "/amiberry/data"))
{
// If the XDG_DATA_HOME is set, use it
std::string xdg_data_home_amiberry = std::string(xdg_data_home) + "/amiberry/data";
// If XDG_DATA_HOME/amiberry/data exists, use it
const std::string xdg_data_home_amiberry = xdg_data_home + "/amiberry";
write_log("Using data directory from XDG_DATA_HOME: %s\n", xdg_data_home_amiberry.c_str());
return { xdg_data_home_amiberry };
}
@ -4237,7 +4269,7 @@ std::string get_home_directory()
return result.append("/Amiberry");
#else
const auto env_home_dir = getenv("AMIBERRY_HOME_DIR");
const auto xdg_data_home = getenv("XDG_DATA_HOME");
const auto xdg_data_home = get_xdg_data_home();
const auto user_home_dir = getenv("HOME");
if (env_home_dir != nullptr && my_existsdir(env_home_dir))
@ -4246,15 +4278,10 @@ std::string get_home_directory()
write_log("Using home directory from AMIBERRY_HOME_DIR: %s\n", env_home_dir);
return { env_home_dir };
}
if (xdg_data_home != nullptr)
if (directory_exists(xdg_data_home, "/amiberry"))
{
if (!directory_exists(xdg_data_home, "/amiberry"))
{
// If $XDG_DATA_HOME exists, but not the Amiberry subdirectory, create it
my_mkdir((std::string(xdg_data_home) + "/amiberry").c_str());
}
// If the XDG_DATA_HOME is set, use it
std::string xdg_data_home_amiberry = std::string(xdg_data_home) + "/amiberry";
// If XDG_DATA_HOME/amiberry exists, use it
const std::string xdg_data_home_amiberry = xdg_data_home + "/amiberry";
write_log("Using home directory from XDG_DATA_HOME: %s\n", xdg_data_home_amiberry.c_str());
return { xdg_data_home_amiberry };
}
@ -4295,7 +4322,8 @@ std::string get_config_directory()
return result.append("/Amiberry/Configurations");
#else
const auto env_conf_dir = getenv("AMIBERRY_CONFIG_DIR");
const auto xdg_config_home = getenv("XDG_CONFIG_HOME");
const auto xdg_config_home = get_xdg_config_home();
const auto xdg_data_home = get_xdg_data_home();
const auto user_home_dir = getenv("HOME");
if (env_conf_dir != nullptr && my_existsdir(env_conf_dir))
@ -4304,16 +4332,21 @@ std::string get_config_directory()
write_log("Using config directory from AMIBERRY_CONFIG_DIR: %s\n", env_conf_dir);
return { env_conf_dir };
}
if (xdg_config_home != nullptr)
if (directory_exists(xdg_config_home, "/amiberry"))
{
// If the XDG_CONFIG_HOME is set, use it
if (!directory_exists(xdg_config_home, "/amiberry"))
{
// If the XDG_CONFIG_HOME exists, but not the amiberry subdirectory, create it
my_mkdir((std::string(xdg_config_home) + "/amiberry").c_str());
}
write_log("Using config directory from XDG_CONFIG_HOME: %s\n", xdg_config_home);
return { std::string(xdg_config_home) + "/amiberry" };
// If XDG_CONFIG_HOME/amiberry exists, use it
const std::string xdg_config_home_amiberry = xdg_config_home + "/amiberry";
write_log("Using config directory from XDG_CONFIG_HOME: %s\n", xdg_config_home_amiberry.c_str());
return { xdg_config_home_amiberry };
}
if (directory_exists(xdg_data_home, "/amiberry/conf"))
{
// If XDG_DATA_HOME/amiberry/conf exists, use it
// This lets users just rename ~/Amiberry to XDG_DATA_HOME/amiberry,
// if they don't want it in their home directory
const std::string xdg_data_home_amiberry_conf = xdg_data_home + "/amiberry/conf";
write_log("Using config directory from XDG_DATA_HOME: %s\n", xdg_data_home_amiberry_conf.c_str());
return { xdg_data_home_amiberry_conf };
}
if (user_home_dir != nullptr)
{