luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-20 01:06:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'g_get_user_cache_dir' into 'main'

Browse Source 
utils: Add XDG_STATE_HOME support

See merge request GNOME/glib!2395
This commit is contained in:
Emmanuele Bassi 2021-12-24 20:11:40 +00:00
commit 036340b25f
7 changed files with 87 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/glib/glib-sections.txt
View File

@ -2209,6 +2209,7 @@ g_get_real_name
g_get_user_cache_dir
g_get_user_data_dir
g_get_user_config_dir
g_get_user_state_dir
g_get_user_runtime_dir
GUserDirectory
g_get_user_special_dir

5
glib/gtestutils.c
View File

@ -1434,7 +1434,7 @@ test_do_isolate_dirs (GError **error)
{
gchar *subdir = NULL;
gchar *home_dir = NULL, *cache_dir = NULL, *config_dir = NULL;
gchar *data_dir = NULL, *runtime_dir = NULL;
gchar *state_dir = NULL, *data_dir = NULL, *runtime_dir = NULL;
gchar *config_dirs[3];
gchar *data_dirs[3];
@ -1471,6 +1471,7 @@ test_do_isolate_dirs (GError **error)
cache_dir = g_build_filename (subdir, "cache", NULL);
config_dir = g_build_filename (subdir, "config", NULL);
data_dir = g_build_filename (subdir, "data", NULL);
state_dir = g_build_filename (subdir, "state", NULL);
config_dirs[0] = g_build_filename (subdir, "system-config1", NULL);
config_dirs[1] = g_build_filename (subdir, "system-config2", NULL);
@ -1488,10 +1489,12 @@ test_do_isolate_dirs (GError **error)
"XDG_CONFIG_HOME", config_dir,
"XDG_DATA_DIRS", data_dirs,
"XDG_DATA_HOME", data_dir,
"XDG_STATE_HOME", state_dir,
"XDG_RUNTIME_DIR", runtime_dir,
NULL);
g_free (runtime_dir);
g_free (state_dir);
g_free (data_dir);
g_free (config_dir);
g_free (cache_dir);

1
glib/gtestutils.h
View File

@ -275,6 +275,7 @@ void g_test_init (int *argc,
* - g_get_user_config_dir()
* - g_get_system_data_dirs()
* - g_get_user_data_dir()
* - g_get_user_state_dir()
* - g_get_user_runtime_dir()
*
* The subdirectories may not be created by the test harness; as with normal

67
glib/gutils.c
View File

@ -549,6 +549,7 @@ static gchar *g_user_data_dir = NULL;
static gchar **g_system_data_dirs = NULL;
static gchar *g_user_cache_dir = NULL;
static gchar *g_user_config_dir = NULL;
static gchar *g_user_state_dir = NULL;
static gchar *g_user_runtime_dir = NULL;
static gchar **g_system_config_dirs = NULL;
static gchar **g_user_special_dirs = NULL;
@ -1770,6 +1771,8 @@ g_set_user_dirs (const gchar *first_dir_type,
set_strv_if_different (&g_system_data_dirs, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_DATA_HOME"))
set_str_if_different (&g_user_data_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_STATE_HOME"))
set_str_if_different (&g_user_state_dir, dir_type, dir_value);
else if (g_str_equal (dir_type, "XDG_RUNTIME_DIR"))
set_str_if_different (&g_user_runtime_dir, dir_type, dir_value);
else
@ -1970,6 +1973,70 @@ g_get_user_cache_dir (void)
return user_cache_dir;
}
static gchar *
g_build_user_state_dir (void)
{
gchar *state_dir = NULL;
const gchar *state_dir_env = g_getenv ("XDG_STATE_HOME");
if (state_dir_env && state_dir_env[0])
state_dir = g_strdup (state_dir_env);
#ifdef G_OS_WIN32
else
state_dir = get_special_folder (&FOLDERID_LocalAppData);
#endif
if (!state_dir || !state_dir[0])
{
gchar *home_dir = g_build_home_dir ();
state_dir = g_build_filename (home_dir, ".local/state", NULL);
g_free (home_dir);
}
return g_steal_pointer (&state_dir);
}
/**
* g_get_user_state_dir:
*
* Returns a base directory in which to store state files specific to
* particular user.
*
* On UNIX platforms this is determined using the mechanisms described
* in the
* [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec).
* In this case the directory retrieved will be `XDG_STATE_HOME`.
*
* On Windows it follows XDG Base Directory Specification if `XDG_STATE_HOME` is defined.
* If `XDG_STATE_HOME` is undefined, the folder to use for local (as opposed
* to roaming) application data is used instead. See the
* [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid).
* Note that in this case on Windows it will be the same
* as what g_get_user_data_dir() returns.
*
* The return value is cached and modifying it at runtime is not supported, as
* it’s not thread-safe to modify environment variables at runtime.
*
* Returns: (type filename) (transfer none): a string owned by GLib that
* must not be modified or freed.
*
* Since: 2.72
**/
const gchar *
g_get_user_state_dir (void)
{
const gchar *user_state_dir;
G_LOCK (g_utils_global);
if (g_user_state_dir == NULL)
g_user_state_dir = g_build_user_state_dir ();
user_state_dir = g_user_state_dir;
G_UNLOCK (g_utils_global);
return user_state_dir;
}
static gchar *
g_build_user_runtime_dir (void)
{

2
glib/gutils.h
View File

@ -197,6 +197,8 @@ GLIB_AVAILABLE_IN_ALL
const gchar * g_get_user_config_dir (void);
GLIB_AVAILABLE_IN_ALL
const gchar * g_get_user_cache_dir (void);
GLIB_AVAILABLE_IN_2_72
const gchar * g_get_user_state_dir (void);
GLIB_AVAILABLE_IN_ALL
const gchar * const * g_get_system_data_dirs (void);

9
glib/tests/utils.c
View File

@ -688,6 +688,15 @@ test_xdg_dirs (void)
g_assert_cmpstr (dir, ==, xdg);
g_free (xdg);
xdg = g_strdup (g_getenv ("XDG_STATE_HOME"));
if (!xdg)
xdg = g_build_filename (g_get_home_dir (), ".local/state", NULL);
dir = g_get_user_state_dir ();
g_assert_cmpstr (dir, ==, xdg);
g_free (xdg);
xdg = g_strdup (g_getenv ("XDG_RUNTIME_DIR"));
if (!xdg)
xdg = g_strdup (g_get_user_cache_dir ());

4
tests/testglib.c
View File

@ -877,7 +877,7 @@ static void
test_info (void)
{
const gchar *un, *rn, *hn;
const gchar *tmpdir, *homedir, *userdatadir, *uconfdir, *ucachedir;
const gchar *tmpdir, *homedir, *userdatadir, *uconfdir, *ucachedir, *ustatedir;
const gchar *uddesktop, *udddocs, *uddpubshare, *uruntimedir;
gchar **sv, *cwd, *sdatadirs, *sconfdirs, *langnames;
const gchar *charset;
@ -917,6 +917,8 @@ test_info (void)
g_assert (uconfdir != NULL);
ucachedir = g_get_user_cache_dir ();
g_assert (ucachedir != NULL);
ustatedir = g_get_user_state_dir ();
g_assert (ustatedir != NULL);
uddesktop = g_get_user_special_dir (G_USER_DIRECTORY_DESKTOP);
g_assert (uddesktop != NULL);