]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
2c21044f | 2 | |
2c21044f | 3 | #include <errno.h> |
11c3a366 | 4 | #include <stdarg.h> |
2c21044f | 5 | #include <stdio.h> |
07630cea | 6 | #include <stdlib.h> |
2c21044f | 7 | |
3ffd4af2 | 8 | #include "conf-files.h" |
854a42fb | 9 | #include "def.h" |
a0956174 | 10 | #include "dirent-util.h" |
3ffd4af2 | 11 | #include "fd-util.h" |
07630cea LP |
12 | #include "hashmap.h" |
13 | #include "log.h" | |
2c21044f | 14 | #include "macro.h" |
9eb977db | 15 | #include "path-util.h" |
3e36211b | 16 | #include "set.h" |
760877e9 | 17 | #include "sort-util.h" |
b5084605 | 18 | #include "stat-util.h" |
07630cea LP |
19 | #include "string-util.h" |
20 | #include "strv.h" | |
854a42fb | 21 | #include "terminal-util.h" |
2c21044f | 22 | |
3e36211b LP |
23 | static int files_add( |
24 | Hashmap *h, | |
25 | Set *masked, | |
26 | const char *suffix, | |
27 | const char *root, | |
28 | unsigned flags, | |
29 | const char *path) { | |
30 | ||
fabe5c0e | 31 | _cleanup_closedir_ DIR *dir = NULL; |
1d13f648 | 32 | const char *dirpath; |
31d5192d | 33 | struct dirent *de; |
1d13f648 | 34 | int r; |
e02caf30 | 35 | |
3e36211b LP |
36 | assert(h); |
37 | assert((flags & CONF_FILES_FILTER_MASKED) == 0 || masked); | |
cba2ef02 | 38 | assert(path); |
cebed500 | 39 | |
1d13f648 | 40 | dirpath = prefix_roota(root, path); |
cebed500 | 41 | |
cba2ef02 | 42 | dir = opendir(dirpath); |
2c21044f KS |
43 | if (!dir) { |
44 | if (errno == ENOENT) | |
45 | return 0; | |
3e36211b LP |
46 | |
47 | return log_debug_errno(errno, "Failed to open directory '%s': %m", dirpath); | |
2c21044f KS |
48 | } |
49 | ||
31d5192d | 50 | FOREACH_DIRENT(de, dir, return -errno) { |
3e36211b LP |
51 | struct stat st; |
52 | char *p, *key; | |
53 | ||
54 | /* Does this match the suffix? */ | |
55 | if (suffix && !endswith(de->d_name, suffix)) | |
56 | continue; | |
2c21044f | 57 | |
3e36211b LP |
58 | /* Has this file already been found in an earlier directory? */ |
59 | if (hashmap_contains(h, de->d_name)) { | |
60 | log_debug("Skipping overridden file '%s/%s'.", dirpath, de->d_name); | |
2c21044f | 61 | continue; |
e34aa8ed | 62 | } |
2c21044f | 63 | |
3e36211b LP |
64 | /* Has this been masked in an earlier directory? */ |
65 | if ((flags & CONF_FILES_FILTER_MASKED) && set_contains(masked, de->d_name)) { | |
66 | log_debug("File '%s/%s' is masked by previous entry.", dirpath, de->d_name); | |
67 | continue; | |
68 | } | |
69 | ||
70 | /* Read file metadata if we shall validate the check for file masks, for node types or whether the node is marked executable. */ | |
71 | if (flags & (CONF_FILES_FILTER_MASKED|CONF_FILES_REGULAR|CONF_FILES_DIRECTORY|CONF_FILES_EXECUTABLE)) | |
72 | if (fstatat(dirfd(dir), de->d_name, &st, 0) < 0) { | |
73 | log_debug_errno(errno, "Failed to stat '%s/%s', ignoring: %m", dirpath, de->d_name); | |
74 | continue; | |
75 | } | |
76 | ||
77 | /* Is this a masking entry? */ | |
78 | if ((flags & CONF_FILES_FILTER_MASKED)) | |
79 | if (null_or_empty(&st)) { | |
be327321 ZJS |
80 | assert(masked); |
81 | ||
3e36211b | 82 | /* Mark this one as masked */ |
be327321 | 83 | r = set_put_strdup(&masked, de->d_name); |
3e36211b LP |
84 | if (r < 0) |
85 | return r; | |
86 | ||
87 | log_debug("File '%s/%s' is a mask.", dirpath, de->d_name); | |
88 | continue; | |
89 | } | |
90 | ||
91 | /* Does this node have the right type? */ | |
92 | if (flags & (CONF_FILES_REGULAR|CONF_FILES_DIRECTORY)) | |
93 | if (!((flags & CONF_FILES_DIRECTORY) && S_ISDIR(st.st_mode)) && | |
94 | !((flags & CONF_FILES_REGULAR) && S_ISREG(st.st_mode))) { | |
95 | log_debug("Ignoring '%s/%s', as it is not a of the right type.", dirpath, de->d_name); | |
96 | continue; | |
97 | } | |
b5084605 | 98 | |
3e36211b LP |
99 | /* Does this node have the executable bit set? */ |
100 | if (flags & CONF_FILES_EXECUTABLE) | |
5238e957 | 101 | /* As requested: check if the file is marked executable. Note that we don't check access(X_OK) |
b5084605 | 102 | * here, as we care about whether the file is marked executable at all, and not whether it is |
3e36211b | 103 | * executable for us, because if so, such errors are stuff we should log about. */ |
b5084605 | 104 | |
3e36211b LP |
105 | if ((st.st_mode & 0111) == 0) { /* not executable */ |
106 | log_debug("Ignoring '%s/%s', as it is not marked executable.", dirpath, de->d_name); | |
b5084605 LP |
107 | continue; |
108 | } | |
109 | ||
3e36211b LP |
110 | if (flags & CONF_FILES_BASENAME) { |
111 | p = strdup(de->d_name); | |
112 | if (!p) | |
113 | return -ENOMEM; | |
b5084605 | 114 | |
3e36211b LP |
115 | key = p; |
116 | } else { | |
657ee2d8 | 117 | p = path_join(dirpath, de->d_name); |
3e36211b LP |
118 | if (!p) |
119 | return -ENOMEM; | |
2c21044f | 120 | |
3e36211b LP |
121 | key = basename(p); |
122 | } | |
123 | ||
124 | r = hashmap_put(h, key, p); | |
125 | if (r < 0) { | |
2c21044f | 126 | free(p); |
3e36211b | 127 | return log_debug_errno(r, "Failed to add item to hashmap: %m"); |
2c21044f | 128 | } |
3e36211b LP |
129 | |
130 | assert(r > 0); | |
2c21044f KS |
131 | } |
132 | ||
e02caf30 | 133 | return 0; |
2c21044f KS |
134 | } |
135 | ||
93bab288 YW |
136 | static int base_cmp(char * const *a, char * const *b) { |
137 | return strcmp(basename(*a), basename(*b)); | |
2c21044f KS |
138 | } |
139 | ||
b5084605 | 140 | static int conf_files_list_strv_internal(char ***strv, const char *suffix, const char *root, unsigned flags, char **dirs) { |
e1d75803 | 141 | _cleanup_hashmap_free_ Hashmap *fh = NULL; |
3e36211b | 142 | _cleanup_set_free_free_ Set *masked = NULL; |
fabe5c0e | 143 | char **files, **p; |
578ac060 | 144 | int r; |
2c21044f | 145 | |
fabe5c0e | 146 | assert(strv); |
fabe5c0e LP |
147 | |
148 | /* This alters the dirs string array */ | |
7d8da2c9 | 149 | if (!path_strv_resolve_uniq(dirs, root)) |
fabe5c0e | 150 | return -ENOMEM; |
2c21044f | 151 | |
3e36211b | 152 | fh = hashmap_new(&path_hash_ops); |
fabe5c0e LP |
153 | if (!fh) |
154 | return -ENOMEM; | |
2c21044f | 155 | |
3e36211b LP |
156 | if (flags & CONF_FILES_FILTER_MASKED) { |
157 | masked = set_new(&path_hash_ops); | |
158 | if (!masked) | |
159 | return -ENOMEM; | |
160 | } | |
161 | ||
2c21044f | 162 | STRV_FOREACH(p, dirs) { |
3e36211b | 163 | r = files_add(fh, masked, suffix, root, flags, *p); |
31d5192d | 164 | if (r == -ENOMEM) |
fabe5c0e | 165 | return r; |
31d5192d LP |
166 | if (r < 0) |
167 | log_debug_errno(r, "Failed to search for files in %s, ignoring: %m", *p); | |
2c21044f KS |
168 | } |
169 | ||
170 | files = hashmap_get_strv(fh); | |
31d5192d | 171 | if (!files) |
fabe5c0e | 172 | return -ENOMEM; |
fabe5c0e | 173 | |
93bab288 | 174 | typesafe_qsort(files, hashmap_size(fh), base_cmp); |
fabe5c0e | 175 | *strv = files; |
2c21044f | 176 | |
fabe5c0e LP |
177 | return 0; |
178 | } | |
179 | ||
a6d8474f | 180 | int conf_files_insert(char ***strv, const char *root, char **dirs, const char *path) { |
d16a1c1b ZJS |
181 | /* Insert a path into strv, at the place honouring the usual sorting rules: |
182 | * - we first compare by the basename | |
183 | * - and then we compare by dirname, allowing just one file with the given | |
184 | * basename. | |
185 | * This means that we will | |
186 | * - add a new entry if basename(path) was not on the list, | |
187 | * - do nothing if an entry with higher priority was already present, | |
188 | * - do nothing if our new entry matches the existing entry, | |
189 | * - replace the existing entry if our new entry has higher priority. | |
190 | */ | |
243dd6ae | 191 | size_t i, n; |
d16a1c1b | 192 | char *t; |
d16a1c1b ZJS |
193 | int r; |
194 | ||
243dd6ae LP |
195 | n = strv_length(*strv); |
196 | for (i = 0; i < n; i++) { | |
d16a1c1b ZJS |
197 | int c; |
198 | ||
93bab288 | 199 | c = base_cmp((char* const*) *strv + i, (char* const*) &path); |
d16a1c1b | 200 | if (c == 0) { |
a6d8474f | 201 | char **dir; |
d16a1c1b | 202 | |
082bb1c5 ZJS |
203 | /* Oh, there already is an entry with a matching name (the last component). */ |
204 | ||
a6d8474f | 205 | STRV_FOREACH(dir, dirs) { |
082bb1c5 | 206 | _cleanup_free_ char *rdir = NULL; |
d16a1c1b ZJS |
207 | char *p1, *p2; |
208 | ||
c6134d3e | 209 | rdir = path_join(root, *dir); |
082bb1c5 ZJS |
210 | if (!rdir) |
211 | return -ENOMEM; | |
212 | ||
213 | p1 = path_startswith((*strv)[i], rdir); | |
d16a1c1b ZJS |
214 | if (p1) |
215 | /* Existing entry with higher priority | |
216 | * or same priority, no need to do anything. */ | |
217 | return 0; | |
218 | ||
a6d8474f | 219 | p2 = path_startswith(path, *dir); |
d16a1c1b ZJS |
220 | if (p2) { |
221 | /* Our new entry has higher priority */ | |
082bb1c5 | 222 | |
c6134d3e | 223 | t = path_join(root, path); |
d16a1c1b ZJS |
224 | if (!t) |
225 | return log_oom(); | |
226 | ||
227 | return free_and_replace((*strv)[i], t); | |
228 | } | |
229 | } | |
230 | ||
231 | } else if (c > 0) | |
232 | /* Following files have lower priority, let's go insert our | |
233 | * new entry. */ | |
234 | break; | |
235 | ||
236 | /* … we are not there yet, let's continue */ | |
237 | } | |
238 | ||
082bb1c5 | 239 | /* The new file has lower priority than all the existing entries */ |
c6134d3e | 240 | t = path_join(root, path); |
d16a1c1b | 241 | if (!t) |
a7181c67 | 242 | return -ENOMEM; |
d16a1c1b ZJS |
243 | |
244 | r = strv_insert(strv, i, t); | |
245 | if (r < 0) | |
246 | free(t); | |
d16a1c1b | 247 | |
380b82d6 | 248 | return r; |
a6d8474f ZJS |
249 | } |
250 | ||
b5084605 | 251 | int conf_files_list_strv(char ***strv, const char *suffix, const char *root, unsigned flags, const char* const* dirs) { |
fabe5c0e LP |
252 | _cleanup_strv_free_ char **copy = NULL; |
253 | ||
254 | assert(strv); | |
fabe5c0e LP |
255 | |
256 | copy = strv_copy((char**) dirs); | |
257 | if (!copy) | |
258 | return -ENOMEM; | |
259 | ||
b5084605 | 260 | return conf_files_list_strv_internal(strv, suffix, root, flags, copy); |
2c21044f KS |
261 | } |
262 | ||
36b12282 | 263 | int conf_files_list(char ***strv, const char *suffix, const char *root, unsigned flags, const char *dir) { |
8201ad81 | 264 | _cleanup_strv_free_ char **dirs = NULL; |
fabe5c0e LP |
265 | |
266 | assert(strv); | |
2c21044f | 267 | |
36b12282 | 268 | dirs = strv_new(dir); |
8201ad81 LP |
269 | if (!dirs) |
270 | return -ENOMEM; | |
fabe5c0e | 271 | |
b5084605 | 272 | return conf_files_list_strv_internal(strv, suffix, root, flags, dirs); |
fabe5c0e | 273 | } |
2c21044f | 274 | |
a6d8474f ZJS |
275 | int conf_files_list_nulstr(char ***strv, const char *suffix, const char *root, unsigned flags, const char *dirs) { |
276 | _cleanup_strv_free_ char **d = NULL; | |
fabe5c0e LP |
277 | |
278 | assert(strv); | |
fabe5c0e | 279 | |
a6d8474f ZJS |
280 | d = strv_split_nulstr(dirs); |
281 | if (!d) | |
fabe5c0e | 282 | return -ENOMEM; |
2c21044f | 283 | |
a6d8474f | 284 | return conf_files_list_strv_internal(strv, suffix, root, flags, d); |
2c21044f | 285 | } |
854a42fb | 286 | |
ceaaeb9b ZJS |
287 | int conf_files_list_with_replacement( |
288 | const char *root, | |
289 | char **config_dirs, | |
290 | const char *replacement, | |
291 | char ***files, | |
292 | char **replace_file) { | |
293 | ||
294 | _cleanup_strv_free_ char **f = NULL; | |
295 | _cleanup_free_ char *p = NULL; | |
296 | int r; | |
297 | ||
298 | assert(config_dirs); | |
299 | assert(files); | |
300 | assert(replace_file || !replacement); | |
301 | ||
302 | r = conf_files_list_strv(&f, ".conf", root, 0, (const char* const*) config_dirs); | |
303 | if (r < 0) | |
304 | return log_error_errno(r, "Failed to enumerate config files: %m"); | |
305 | ||
306 | if (replacement) { | |
307 | r = conf_files_insert(&f, root, config_dirs, replacement); | |
308 | if (r < 0) | |
309 | return log_error_errno(r, "Failed to extend config file list: %m"); | |
310 | ||
c6134d3e | 311 | p = path_join(root, replacement); |
ceaaeb9b ZJS |
312 | if (!p) |
313 | return log_oom(); | |
314 | } | |
315 | ||
316 | *files = TAKE_PTR(f); | |
317 | if (replace_file) | |
318 | *replace_file = TAKE_PTR(p); | |
319 | return 0; | |
320 | } |