1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* Copyright 2019 elementary, Inc. (https://elementary.io)
* Copyright 2011-2013 Robert Dyer
* Copyright 2011-2013 Rico Tzschichholz <ricotz@ubuntu.com>
* SPDX-License-Identifier: LGPL-3.0-or-later
*/
namespace Granite.Services {
/**
* A class for interacting with frequently-used directories, following the
* XDG Base Directory specification: [[http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html]]
*/
[Version (deprecated = true, deprecated_since = "5.5.0", replacement = "GLib.Environment")]
public class Paths : GLib.Object {
/**
* User's home folder - $HOME
*/
public static File home_folder { get; protected set; }
/**
* Path passed in to initialize method; should be Build.PKGDATADIR.
*/
public static File data_folder { get; protected set; }
/**
* $XDG_CONFIG_HOME - defaults to $HOME/.config
*/
public static File xdg_config_home_folder { get; protected set; }
/**
* $XDG_DATA_HOME - defaults to $HOME/.local/share
*/
public static File xdg_data_home_folder { get; protected set; }
/**
* $XDG_CACHE_HOME - defaults to $HOME/.cache
*/
public static File xdg_cache_home_folder { get; protected set; }
/**
* $XDG_DATA_DIRS - defaults to /usr/local/share/:/usr/share/
*/
public static List<File> xdg_data_dir_folders { get; protected owned set; }
/**
* defaults to xdg_config_home_folder/app_name
*/
public static File user_config_folder { get; protected set; }
/**
* defaults to xdg_data_home_folder/app_name
*/
public static File user_data_folder { get; protected set; }
/**
* defaults to xdg_cache_home_folder/app_name
*/
public static File user_cache_folder { get; protected set; }
/**
* Initialize all the paths using the supplied app name and path to the app's data folder.
*
* @param app_name the name of the application
* @param data_folder_path the path to the application's data folder
*/
public static void initialize (string app_name, string data_folder_path) {
// get environment-based settings
home_folder = File.new_for_path (Environment.get_home_dir ());
data_folder = File.new_for_path (data_folder_path);
// get XDG Base Directory settings
var xdg_config_home = Environment.get_variable ("XDG_CONFIG_HOME");
var xdg_data_home = Environment.get_variable ("XDG_DATA_HOME");
var xdg_cache_home = Environment.get_variable ("XDG_CACHE_HOME");
var xdg_data_dirs = Environment.get_variable ("XDG_DATA_DIRS");
// determine directories based on XDG with fallbacks
if (xdg_config_home == null || xdg_config_home.length == 0)
xdg_config_home_folder = home_folder.get_child (".config");
else
xdg_config_home_folder = File.new_for_path (xdg_config_home);
if (xdg_data_home == null || xdg_data_home.length == 0)
xdg_data_home_folder = home_folder.get_child (".local").get_child ("share");
else
xdg_data_home_folder = File.new_for_path (xdg_data_home);
if (xdg_cache_home == null || xdg_cache_home.length == 0)
xdg_cache_home_folder = home_folder.get_child (".cache");
else
xdg_cache_home_folder = File.new_for_path (xdg_cache_home);
var dirs = new List<File> ();
if (xdg_data_dirs == null || xdg_data_dirs.length == 0) {
dirs.append (File.new_for_path ("/usr/local/share"));
dirs.append (File.new_for_path ("/usr/share"));
} else {
foreach (var path in xdg_data_dirs.split (":"))
dirs.append (File.new_for_path (path));
}
xdg_data_dir_folders = (owned) dirs;
// set the XDG Base Directory specified directories to use
user_config_folder = xdg_config_home_folder.get_child (app_name);
user_data_folder = xdg_data_home_folder.get_child (app_name);
user_cache_folder = xdg_cache_home_folder.get_child (app_name);
// ensure all writable directories exist
ensure_directory_exists (user_config_folder);
ensure_directory_exists (user_data_folder);
ensure_directory_exists (user_cache_folder);
}
/**
* Ensure the directory exists, by creating it if it does not.
*
* @param dir the directory in question
*
* @return `true` is the directory exists, `false` if it does not
*/
public static bool ensure_directory_exists (File dir) {
if (!dir.query_exists ())
try {
dir.make_directory_with_parents ();
return true;
} catch {
error ("Could not access or create the directory '%s'.", dir.get_path ());
}
return false;
}
}
}
|
