Debian Codegraph @

src/path/path-tool.c

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <stdio.h>
4
5 #include "sd-path.h"
6
7 #include "alloc-util.h"
8 #include "build.h"
9 #include "errno-util.h"
10 #include "format-table.h"
11 #include "log.h"
12 #include "main-func.h"
13 #include "options.h"
14 #include "pager.h"
15 #include "pretty-print.h"
16 #include "sort-util.h"
17 #include "string-util.h"
18 #include "strv.h"
19
20 static const char *arg_suffix = NULL;
21 static PagerFlags arg_pager_flags = 0;
22
23 static const char* const path_table[_SD_PATH_MAX] = {
24 [SD_PATH_TEMPORARY] = "temporary",
25 [SD_PATH_TEMPORARY_LARGE] = "temporary-large",
26
27 [SD_PATH_SYSTEM_SEARCH_CONFIGURATION] = "system-search-configuration",
28
29 [SD_PATH_SYSTEM_BINARIES] = "system-binaries",
30 [SD_PATH_SYSTEM_INCLUDE] = "system-include",
31 [SD_PATH_SYSTEM_LIBRARY_PRIVATE] = "system-library-private",
32 [SD_PATH_SYSTEM_LIBRARY_ARCH] = "system-library-arch",
33 [SD_PATH_SYSTEM_SHARED] = "system-shared",
34 [SD_PATH_SYSTEM_CONFIGURATION_FACTORY] = "system-configuration-factory",
35 [SD_PATH_SYSTEM_STATE_FACTORY] = "system-state-factory",
36
37 [SD_PATH_SYSTEM_CONFIGURATION] = "system-configuration",
38 [SD_PATH_SYSTEM_RUNTIME] = "system-runtime",
39 [SD_PATH_SYSTEM_RUNTIME_LOGS] = "system-runtime-logs",
40 [SD_PATH_SYSTEM_STATE_PRIVATE] = "system-state-private",
41 [SD_PATH_SYSTEM_STATE_LOGS] = "system-state-logs",
42 [SD_PATH_SYSTEM_STATE_CACHE] = "system-state-cache",
43 [SD_PATH_SYSTEM_STATE_SPOOL] = "system-state-spool",
44
45 [SD_PATH_USER_BINARIES] = "user-binaries",
46 [SD_PATH_USER_LIBRARY_PRIVATE] = "user-library-private",
47 [SD_PATH_USER_LIBRARY_ARCH] = "user-library-arch",
48 [SD_PATH_USER_SHARED] = "user-shared",
49
50 [SD_PATH_USER_CONFIGURATION] = "user-configuration",
51 [SD_PATH_USER_RUNTIME] = "user-runtime",
52 [SD_PATH_USER_STATE_CACHE] = "user-state-cache",
53 [SD_PATH_USER_STATE_PRIVATE] = "user-state-private",
54
55 [SD_PATH_USER] = "user",
56 [SD_PATH_USER_DOCUMENTS] = "user-documents",
57 [SD_PATH_USER_MUSIC] = "user-music",
58 [SD_PATH_USER_PICTURES] = "user-pictures",
59 [SD_PATH_USER_VIDEOS] = "user-videos",
60 [SD_PATH_USER_DOWNLOAD] = "user-download",
61 [SD_PATH_USER_PUBLIC] = "user-public",
62 [SD_PATH_USER_TEMPLATES] = "user-templates",
63 [SD_PATH_USER_DESKTOP] = "user-desktop",
64 [SD_PATH_USER_PROJECTS] = "user-projects",
65
66 [SD_PATH_SEARCH_BINARIES] = "search-binaries",
67 [SD_PATH_SEARCH_BINARIES_DEFAULT] = "search-binaries-default",
68 [SD_PATH_SEARCH_LIBRARY_PRIVATE] = "search-library-private",
69 [SD_PATH_SEARCH_LIBRARY_ARCH] = "search-library-arch",
70 [SD_PATH_SEARCH_SHARED] = "search-shared",
71 [SD_PATH_SEARCH_CONFIGURATION_FACTORY] = "search-configuration-factory",
72 [SD_PATH_SEARCH_STATE_FACTORY] = "search-state-factory",
73 [SD_PATH_SEARCH_CONFIGURATION] = "search-configuration",
74
75 [SD_PATH_SYSTEMD_UTIL] = "systemd-util",
76
77 [SD_PATH_SYSTEMD_SYSTEM_UNIT] = "systemd-system-unit",
78 [SD_PATH_SYSTEMD_SYSTEM_PRESET] = "systemd-system-preset",
79 [SD_PATH_SYSTEMD_SYSTEM_CONF] = "systemd-system-conf",
80 [SD_PATH_SYSTEMD_USER_UNIT] = "systemd-user-unit",
81 [SD_PATH_SYSTEMD_USER_PRESET] = "systemd-user-preset",
82 [SD_PATH_SYSTEMD_USER_CONF] = "systemd-user-conf",
83 [SD_PATH_SYSTEMD_INITRD_PRESET] = "systemd-initrd-preset",
84
85 [SD_PATH_SYSTEMD_SEARCH_SYSTEM_UNIT] = "systemd-search-system-unit",
86 [SD_PATH_SYSTEMD_SEARCH_USER_UNIT] = "systemd-search-user-unit",
87
88 [SD_PATH_SYSTEMD_SYSTEM_GENERATOR] = "systemd-system-generator",
89 [SD_PATH_SYSTEMD_USER_GENERATOR] = "systemd-user-generator",
90 [SD_PATH_SYSTEMD_SEARCH_SYSTEM_GENERATOR] = "systemd-search-system-generator",
91 [SD_PATH_SYSTEMD_SEARCH_USER_GENERATOR] = "systemd-search-user-generator",
92
93 [SD_PATH_SYSTEMD_SLEEP] = "systemd-sleep",
94 [SD_PATH_SYSTEMD_SHUTDOWN] = "systemd-shutdown",
95
96 [SD_PATH_TMPFILES] = "tmpfiles",
97 [SD_PATH_SYSUSERS] = "sysusers",
98 [SD_PATH_SYSCTL] = "sysctl",
99 [SD_PATH_BINFMT] = "binfmt",
100 [SD_PATH_MODULES_LOAD] = "modules-load",
101 [SD_PATH_CATALOG] = "catalog",
102
103 [SD_PATH_SYSTEMD_SEARCH_NETWORK] = "systemd-search-network",
104
105 [SD_PATH_SYSTEMD_SYSTEM_ENVIRONMENT_GENERATOR] = "systemd-system-environment-generator",
106 [SD_PATH_SYSTEMD_USER_ENVIRONMENT_GENERATOR] = "systemd-user-environment-generator",
107 [SD_PATH_SYSTEMD_SEARCH_SYSTEM_ENVIRONMENT_GENERATOR] = "systemd-search-system-environment-generator",
108 [SD_PATH_SYSTEMD_SEARCH_USER_ENVIRONMENT_GENERATOR] = "systemd-search-user-environment-generator",
109
110 [SD_PATH_SYSTEM_CREDENTIAL_STORE] = "system-credential-store",
111 [SD_PATH_SYSTEM_SEARCH_CREDENTIAL_STORE] = "system-search-credential-store",
112 [SD_PATH_SYSTEM_CREDENTIAL_STORE_ENCRYPTED] = "system-credential-store-encrypted",
113 [SD_PATH_SYSTEM_SEARCH_CREDENTIAL_STORE_ENCRYPTED] = "system-search-credential-store-encrypted",
114 [SD_PATH_USER_CREDENTIAL_STORE] = "user-credential-store",
115 [SD_PATH_USER_SEARCH_CREDENTIAL_STORE] = "user-search-credential-store",
116 [SD_PATH_USER_CREDENTIAL_STORE_ENCRYPTED] = "user-credential-store-encrypted",
117 [SD_PATH_USER_SEARCH_CREDENTIAL_STORE_ENCRYPTED] = "user-search-credential-store-encrypted",
118 };
119
120 static int order_cmp(const size_t *a, const size_t *b) {
121 assert(*a < ELEMENTSOF(path_table));
122 assert(*b < ELEMENTSOF(path_table));
123 return strcmp(path_table[*a], path_table[*b]);
124 }
125
126 static int list_paths(void) {
127 int ret = 0, r;
128
129 pager_open(arg_pager_flags);
130
131 size_t order[ELEMENTSOF(path_table)];
132
133 for (size_t i = 0; i < ELEMENTSOF(order); i++)
134 order[i] = i;
135
136 typesafe_qsort(order, ELEMENTSOF(order), order_cmp);
137
138 for (size_t i = 0; i < ELEMENTSOF(order); i++) {
139 size_t j = order[i];
140 const char *t = ASSERT_PTR(path_table[j]);
141
142 _cleanup_free_ char *p = NULL;
143 r = sd_path_lookup(j, arg_suffix, &p);
144 if (r < 0) {
145 log_full_errno(r == -ENXIO ? LOG_DEBUG : LOG_ERR, r, "Failed to query %s, proceeding: %m", t);
146 if (r != -ENXIO)
147 RET_GATHER(ret, r);
148 continue;
149 }
150
151 printf("%s%s:%s %s\n", ansi_highlight(), t, ansi_normal(), p);
152 }
153
154 return ret;
155 }
156
157 static int print_path(const char *n) {
158 int r;
159
160 for (size_t i = 0; i < ELEMENTSOF(path_table); i++)
161 if (streq(path_table[i], n)) {
162 _cleanup_free_ char *p = NULL;
163
164 r = sd_path_lookup(i, arg_suffix, &p);
165 if (r < 0)
166 return log_error_errno(r, "Failed to query %s: %m", n);
167
168 printf("%s\n", p);
169 return 0;
170 }
171
172 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP),
173 "Path %s not known.", n);
174 }
175
176 static int help(void) {
177 _cleanup_free_ char *link = NULL;
178 _cleanup_(table_unrefp) Table *options = NULL;
179 int r;
180
181 r = terminal_urlify_man("systemd-path", "1", &link);
182 if (r < 0)
183 return log_oom();
184
185 r = option_parser_get_help_table(&options);
186 if (r < 0)
187 return r;
188
189 printf("%s [OPTIONS...] [NAME...]\n\n"
190 "%sShow system and user paths.%s\n\n",
191 program_invocation_short_name,
192 ansi_highlight(),
193 ansi_normal());
194
195 r = table_print_or_warn(options);
196 if (r < 0)
197 return r;
198
199 printf("\nSee the %s for details.\n", link);
200 return 0;
201 }
202
203 static int parse_argv(int argc, char *argv[], char ***ret_args) {
204 assert(argc >= 0);
205 assert(argv);
206
207 OptionParser opts = { argc, argv };
208
209 FOREACH_OPTION_OR_RETURN(c, &opts)
210 switch (c) {
211
212 OPTION_COMMON_HELP:
213 return help();
214
215 OPTION_COMMON_VERSION:
216 return version();
217
218 OPTION_LONG("suffix", "SUFFIX", "Suffix to append to paths"):
219 arg_suffix = opts.arg;
220 break;
221
222 OPTION_COMMON_NO_PAGER:
223 arg_pager_flags |= PAGER_DISABLE;
224 break;
225 }
226
227 *ret_args = option_parser_get_args(&opts);
228 return 1;
229 }
230
231 static int run(int argc, char* argv[]) {
232 int r;
233
234 log_setup();
235
236 char **args = NULL;
237 r = parse_argv(argc, argv, &args);
238 if (r <= 0)
239 return r;
240
241 if (strv_isempty(args))
242 return list_paths();
243
244 STRV_FOREACH(i, args)
245 RET_GATHER(r, print_path(*i));
246 return r;
247 }
248
249 DEFINE_MAIN_FUNCTION(run);