Skip to content

Support XDG Base directory specification for Linux #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WhiredPlanck wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support XDG Base directory specification for Linux #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
007cc4a
Support XDG Base directory specification for Linux
WhiredPlanck Jan 4, 2025
fa912a0
Fix compile issue caused by token to path mapping
WhiredPlanck Jan 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions libaegisub/common/path.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,23 @@ constexpr std::string_view tokens[] = {
"?script",
"?temp",
"?user",
"?video"
"?video",
"?state"
};

int find_token(std::string_view str) {
if (str.size() < 5 || str[0] != '?') return -1;
int idx;
switch (str[1] + str[4]) {
case 'a' + 'i': idx = 0; break;
case 'd' + 'a': idx = 1; break;
case 'd' + 't': idx = 2; break;
case 'l' + 'a': idx = 3; break;
case 's' + 'i': idx = 4; break;
case 't' + 'p': idx = 5; break;
case 'u' + 'r': idx = 6; break;
case 'v' + 'e': idx = 7; break;
switch (str[2] + str[4]) {
case 'u' + 'i': idx = 0; break;
case 'a' + 'a': idx = 1; break;
case 'i' + 't': idx = 2; break;
case 'o' + 'a': idx = 3; break;
case 'c' + 'i': idx = 4; break;
case 'e' + 'p': idx = 5; break;
case 's' + 'r': idx = 6; break;
case 'i' + 'e': idx = 7; break;
case 't' + 't': idx = 8; break;
default: return -1;
}
return str.starts_with(tokens[idx]) ? idx : -1;
Expand Down
2 changes: 1 addition & 1 deletion libaegisub/include/libaegisub/path.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace agi {
/// Class for handling everything path-related in Aegisub
class Path {
/// Token -> Path map
std::array<fs::path, 8> paths;
std::array<fs::path, 9> paths;

/// Platform-specific code to fill in the default paths, called in the constructor
void FillPlatformSpecificPaths();
Expand Down
33 changes: 30 additions & 3 deletions libaegisub/unix/path.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ std::string home_dir() {
throw agi::EnvironmentError("Could not get home directory. Make sure HOME is set.");
}

std::string xdg_dir(std::string_view token, agi::fs::path const& fallback) {

@filip-hejsek filip-hejsek Feb 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

token is not the right name for the parameter... (env_name would be better)

const char *env = getenv(token.data());
if (env) return env;

@filip-hejsek filip-hejsek Feb 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The environment variable must be ignored if it is empty or doesn't contain an absolute path

return fallback.string();
}

#ifdef APPIMAGE_BUILD
std::string exe_dir() {
char *exe, *dir;
Expand Down Expand Up @@ -70,12 +76,32 @@ namespace agi {
void Path::FillPlatformSpecificPaths() {
#ifndef __APPLE__
agi::fs::path home = home_dir();
SetToken("?user", home/".aegisub");
SetToken("?local", home/".aegisub");
agi::fs::path old_root = home/".aegisub";

agi::fs::path xdg_config = xdg_dir("XDG_CONFIG_HOME", home/".config");
agi::fs::path xdg_cache = xdg_dir("XDG_CACHE_HOME", home/".cache");
agi::fs::path xdg_state = xdg_dir("XDG_STATE_HOME", home/".local/state");
agi::fs::path xdg_data = xdg_dir("XDG_DATA_HOME", home/".local/share");

if (agi::fs::DirectoryExists(old_root)) {
SetToken("?user", old_root);
SetToken("?local", old_root);
SetToken("?state", old_root);
} else {
SetToken("?user", xdg_config/"aegisub");
SetToken("?local", xdg_cache/"aegisub");

@filip-hejsek filip-hejsek Feb 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling a cache dir ?local is somewhat misleading, but I guess we have to keep it for compatibility. ?cache would be a better name though.

SetToken("?state", xdg_state/"aegisub");
}

#ifdef APPIMAGE_BUILD
agi::fs::path data = exe_dir();
if (data == "") data = home/".aegisub";
if (data == "") {
if (agi::fs::DirectoryExists(old_root)) {
data = old_root;
} else {
data = xdg_data/"aegisub"
}
}
SetToken("?data", data);
SetToken("?dictionary", Decode("?data/dictionaries"));
#else
Expand All @@ -87,6 +113,7 @@ void Path::FillPlatformSpecificPaths() {
agi::fs::path app_support = agi::util::GetApplicationSupportDirectory();
SetToken("?user", app_support/"Aegisub");
SetToken("?local", app_support/"Aegisub");
SetToken("?state", app_support/"Aegisub");
SetToken("?data", agi::util::GetBundleSharedSupportDirectory());
SetToken("?dictionary", Decode("?data/dictionaries"));
#endif
Expand Down
1 change: 1 addition & 0 deletions libaegisub/windows/path_win.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ void Path::FillPlatformSpecificPaths() {

SetToken("?user", WinGetFolderPath(CSIDL_APPDATA)/"Aegisub");
SetToken("?local", WinGetFolderPath(CSIDL_LOCAL_APPDATA)/"Aegisub");
SetToken("?state", WinGetFolderPath(CSIDL_APPDATA)/"Aegisub");

std::wstring filename(MAX_PATH + 1, L'\0');
while (static_cast<DWORD>(filename.size()) == GetModuleFileNameW(nullptr, &filename[0], filename.size()))
Expand Down
2 changes: 1 addition & 1 deletion src/dialog_autosave.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ DialogAutosave::DialogAutosave(wxWindow *parent)
std::map<wxString, AutosaveFile> files_map;
Populate(files_map, OPT_GET("Path/Auto/Save")->GetString(), ".AUTOSAVE.ass", "%s");
Populate(files_map, OPT_GET("Path/Auto/Backup")->GetString(), ".ORIGINAL.ass", _("%s [ORIGINAL BACKUP]"));
Populate(files_map, "?user/recovered", ".ass", _("%s [RECOVERED]"));
Populate(files_map, "?state/recovered", ".ass", _("%s [RECOVERED]"));

for (auto& file : files_map | boost::adaptors::map_values)
files.emplace_back(std::move(file));
Expand Down
2 changes: 1 addition & 1 deletion src/dialog_shift_times.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ static wxString get_history_string(json::Object &obj) {
DialogShiftTimes::DialogShiftTimes(agi::Context *context)
: wxDialog(context->parent, -1, _("Shift Times"))
, context(context)
, history_filename(config::path->Decode("?user/shift_history.json"))
, history_filename(config::path->Decode("?state/shift_history.json"))
, timecodes_loaded_slot(context->project->AddTimecodesListener(&DialogShiftTimes::OnTimecodesLoaded, this))
, selected_set_changed_slot(context->selectionController->AddSelectionListener(&DialogShiftTimes::OnSelectedSetChanged, this))
{
Expand Down
4 changes: 2 additions & 2 deletions src/libresrc/default_config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,8 @@

"Path" : {
"Auto" : {
"Backup" : "?user/autoback",
"Save" : "?user/autosave"
"Backup" : "?state/autoback",
"Save" : "?state/autosave"
},
"Automation" : {
"Autoload" : "?user/automation/autoload/|?data/automation/autoload/",
Expand Down
5 changes: 3 additions & 2 deletions src/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ bool AegisubApp::OnInit() {
// Local config, make ?user mean ?data so all user settings are placed in install dir
config::path->SetToken("?user", config::path->Decode("?data"));
config::path->SetToken("?local", config::path->Decode("?data"));
config::path->SetToken("?state", config::path->Decode("?data"));
crash_writer::Initialize(config::path->Decode("?user"));
} catch (agi::fs::FileSystemError const&) {
// File doesn't exist or we can't read it
Expand All @@ -162,7 +163,7 @@ bool AegisubApp::OnInit() {
#endif

StartupLog("Create log writer");
auto path_log = config::path->Decode("?user/log/");
auto path_log = config::path->Decode("?state/log/");
agi::fs::CreateDirectory(path_log);
agi::log::log->Subscribe(std::make_unique<agi::log::JsonEmitter>(path_log));
CleanCache(path_log, "*.json", 10, 100);
Expand Down Expand Up @@ -373,7 +374,7 @@ void AegisubApp::UnhandledException(bool stackWalk) {
auto c = frame->context.get();
if (!c || !c->ass || !c->subsController) continue;

path = config::path->Decode("?user/recovered");
path = config::path->Decode("?state/recovered");
agi::fs::CreateDirectory(path);

auto filename = c->subsController->Filename().stem();
Expand Down