Add XDG_STATE_HOME and HOST_XDG_STATE_HOME env variables

This gives new support for the new XDG_STATE_HOME addition to XDG_BASE_DIRS
which allows applications to use this without breaking because they would
assume $HOME/.local/state which may be unavailable to the flatpak

This adds it as .local/state as to make --persist=.local/state the same behaviour
as in new flatpak. This in turn means that the transition should be seamless between
old and new flatpak.

This also has the benefit of working if the application doesn't follow XDG spec thanks
to --persist=.local/state.

This fixes https://github.com/flatpak/flatpak/issues/4477

[smcv: Don't call nonexistent g_get_user_state_dir(); fix a reference
to XDG_STATE_DIR]
This commit is contained in:
Lionir
2021-10-11 17:51:59 -04:00
committed by Alexander Larsson
parent 17fbe516c4
commit 0fda062c96
5 changed files with 21 additions and 0 deletions

View File

@@ -1842,13 +1842,16 @@ flatpak_run_apply_env_appid (FlatpakBwrap *bwrap,
g_autoptr(GFile) app_dir_data = NULL;
g_autoptr(GFile) app_dir_config = NULL;
g_autoptr(GFile) app_dir_cache = NULL;
g_autoptr(GFile) app_dir_state = NULL;
app_dir_data = g_file_get_child (app_dir, "data");
app_dir_config = g_file_get_child (app_dir, "config");
app_dir_cache = g_file_get_child (app_dir, "cache");
app_dir_state = g_file_get_child (app_dir, ".local/state");
flatpak_bwrap_set_env (bwrap, "XDG_DATA_HOME", flatpak_file_get_path_cached (app_dir_data), TRUE);
flatpak_bwrap_set_env (bwrap, "XDG_CONFIG_HOME", flatpak_file_get_path_cached (app_dir_config), TRUE);
flatpak_bwrap_set_env (bwrap, "XDG_CACHE_HOME", flatpak_file_get_path_cached (app_dir_cache), TRUE);
flatpak_bwrap_set_env (bwrap, "XDG_STATE_HOME", flatpak_file_get_path_cached (app_dir_state), TRUE);
if (g_getenv ("XDG_DATA_HOME"))
flatpak_bwrap_set_env (bwrap, "HOST_XDG_DATA_HOME", g_getenv ("XDG_DATA_HOME"), TRUE);
@@ -1856,6 +1859,8 @@ flatpak_run_apply_env_appid (FlatpakBwrap *bwrap,
flatpak_bwrap_set_env (bwrap, "HOST_XDG_CONFIG_HOME", g_getenv ("XDG_CONFIG_HOME"), TRUE);
if (g_getenv ("XDG_CACHE_HOME"))
flatpak_bwrap_set_env (bwrap, "HOST_XDG_CACHE_HOME", g_getenv ("XDG_CACHE_HOME"), TRUE);
if (g_getenv ("XDG_STATE_HOME"))
flatpak_bwrap_set_env (bwrap, "HOST_XDG_STATE_HOME", g_getenv ("XDG_STATE_HOME"), TRUE);
}
void

View File

@@ -98,6 +98,7 @@
<member>XDG_DATA_HOME</member>
<member>XDG_CONFIG_HOME</member>
<member>XDG_CACHE_HOME</member>
<member>XDG_STATE_HOME</member>
</simplelist>
<para>
The host values of these variables are made available inside the sandbox via these
@@ -107,6 +108,7 @@
<member>HOST_XDG_DATA_HOME</member>
<member>HOST_XDG_CONFIG_HOME</member>
<member>HOST_XDG_CACHE_HOME</member>
<member>HOST_XDG_STATE_HOME</member>
</simplelist>
<para>
Flatpak sets the environment variable <envar>FLATPAK_ID</envar> to the application

View File

@@ -100,6 +100,7 @@ export HOME=${TEST_DATA_DIR}/home
export XDG_CACHE_HOME=${TEST_DATA_DIR}/home/cache
export XDG_CONFIG_HOME=${TEST_DATA_DIR}/home/config
export XDG_DATA_HOME=${TEST_DATA_DIR}/home/share
export XDG_STATE_HOME=${TEST_DATA_DIR}/home/state
export XDG_RUNTIME_DIR=${TEST_DATA_DIR}/runtime
export XDG_DESKTOP_PORTAL_DIR=${test_builddir}/share/xdg-desktop-portal/portals

View File

@@ -44,6 +44,7 @@ isolated_test_dir_global_setup (void)
g_autofree char *cachedir = NULL;
g_autofree char *configdir = NULL;
g_autofree char *datadir = NULL;
g_autofree char *statedir = NULL;
g_autofree char *homedir = NULL;
g_autofree char *runtimedir = NULL;
@@ -72,6 +73,11 @@ isolated_test_dir_global_setup (void)
g_setenv ("XDG_DATA_HOME", datadir, TRUE);
g_test_message ("setting XDG_DATA_HOME=%s", datadir);
statedir = g_strconcat (isolated_test_dir, "/home/state", NULL);
g_assert_no_errno (g_mkdir_with_parents (statedir, S_IRWXU | S_IRWXG | S_IRWXO));
g_setenv ("XDG_STATE_HOME", statedir, TRUE);
g_test_message ("setting XDG_STATE_HOME=%s", statedir);
runtimedir = g_strconcat (isolated_test_dir, "/runtime", NULL);
g_assert_no_errno (g_mkdir_with_parents (runtimedir, S_IRWXU));
g_setenv ("XDG_RUNTIME_DIR", runtimedir, TRUE);
@@ -82,6 +88,7 @@ isolated_test_dir_global_setup (void)
g_assert_cmpstr (g_get_user_cache_dir (), ==, cachedir);
g_assert_cmpstr (g_get_user_config_dir (), ==, configdir);
g_assert_cmpstr (g_get_user_data_dir (), ==, datadir);
g_assert_cmpstr (g_getenv ("XDG_STATE_HOME"), ==, statedir);
g_assert_cmpstr (g_get_user_runtime_dir (), ==, runtimedir);
}

View File

@@ -2705,6 +2705,7 @@ global_setup (void)
g_autofree char *cachedir = NULL;
g_autofree char *configdir = NULL;
g_autofree char *datadir = NULL;
g_autofree char *statedir = NULL;
g_autofree char *homedir = NULL;
g_autofree char *services_dir = NULL;
@@ -2733,6 +2734,11 @@ global_setup (void)
g_setenv ("XDG_DATA_HOME", datadir, TRUE);
g_test_message ("setting XDG_DATA_HOME=%s", datadir);
statedir = g_strconcat (testdir, "/home/state", NULL);
g_mkdir_with_parents (statedir, S_IRWXU | S_IRWXG | S_IRWXO);
g_setenv ("XDG_STATE_HOME", statedir, TRUE);
g_test_message ("setting XDG_STATE_HOME=%s", statedir);
flatpak_runtimedir = g_strconcat (testdir, "/runtime", NULL);
g_mkdir_with_parents (flatpak_runtimedir, S_IRWXU | S_IRWXG | S_IRWXO);
g_setenv ("XDG_RUNTIME_DIR", flatpak_runtimedir, TRUE);