]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
76877b46 | 2 | #pragma once |
9eb977db | 3 | |
11c3a366 | 4 | #include <alloca.h> |
44a6b1b6 | 5 | #include <stdbool.h> |
11c3a366 | 6 | #include <stddef.h> |
9eb977db | 7 | |
44a6b1b6 | 8 | #include "macro.h" |
a6f72863 | 9 | #include "string-util.h" |
f5a9bd21 | 10 | #include "strv.h" |
8e184852 | 11 | #include "time-util.h" |
44a6b1b6 | 12 | |
0c300adf LP |
13 | #define PATH_SPLIT_SBIN_BIN(x) x "sbin:" x "bin" |
14 | #define PATH_SPLIT_SBIN_BIN_NULSTR(x) x "sbin\0" x "bin\0" | |
15 | ||
16 | #define PATH_NORMAL_SBIN_BIN(x) x "bin" | |
17 | #define PATH_NORMAL_SBIN_BIN_NULSTR(x) x "bin\0" | |
18 | ||
671f0f8d | 19 | #if HAVE_SPLIT_BIN |
0c300adf LP |
20 | # define PATH_SBIN_BIN(x) PATH_SPLIT_SBIN_BIN(x) |
21 | # define PATH_SBIN_BIN_NULSTR(x) PATH_SPLIT_SBIN_BIN_NULSTR(x) | |
671f0f8d | 22 | #else |
0c300adf LP |
23 | # define PATH_SBIN_BIN(x) PATH_NORMAL_SBIN_BIN(x) |
24 | # define PATH_SBIN_BIN_NULSTR(x) PATH_NORMAL_SBIN_BIN_NULSTR(x) | |
671f0f8d ZJS |
25 | #endif |
26 | ||
27 | #define DEFAULT_PATH_NORMAL PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/") | |
2259e8fb | 28 | #define DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/usr/local/") PATH_SBIN_BIN_NULSTR("/usr/") |
671f0f8d | 29 | #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":" PATH_SBIN_BIN("/") |
2259e8fb | 30 | #define DEFAULT_PATH_SPLIT_USR_NULSTR DEFAULT_PATH_NORMAL_NULSTR PATH_SBIN_BIN_NULSTR("/") |
0c300adf | 31 | #define DEFAULT_PATH_COMPAT PATH_SPLIT_SBIN_BIN("/usr/local/") ":" PATH_SPLIT_SBIN_BIN("/usr/") ":" PATH_SPLIT_SBIN_BIN("/") |
e10a55fd | 32 | |
349cc4a5 | 33 | #if HAVE_SPLIT_USR |
e10a55fd | 34 | # define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR |
2259e8fb | 35 | # define DEFAULT_PATH_NULSTR DEFAULT_PATH_SPLIT_USR_NULSTR |
c9d954b2 | 36 | #else |
e10a55fd | 37 | # define DEFAULT_PATH DEFAULT_PATH_NORMAL |
2259e8fb | 38 | # define DEFAULT_PATH_NULSTR DEFAULT_PATH_NORMAL_NULSTR |
c9d954b2 ZJS |
39 | #endif |
40 | ||
3602ca6f ZJS |
41 | #ifndef DEFAULT_USER_PATH |
42 | # define DEFAULT_USER_PATH DEFAULT_PATH | |
43 | #endif | |
44 | ||
cd4ff5aa | 45 | static inline bool is_path(const char *p) { |
70980a39 LP |
46 | if (!p) /* A NULL pointer is definitely not a path */ |
47 | return false; | |
48 | ||
cd4ff5aa ZJS |
49 | return strchr(p, '/'); |
50 | } | |
51 | ||
52 | static inline bool path_is_absolute(const char *p) { | |
70980a39 LP |
53 | if (!p) /* A NULL pointer is definitely not an absolute path */ |
54 | return false; | |
55 | ||
cd4ff5aa ZJS |
56 | return p[0] == '/'; |
57 | } | |
58 | ||
0f474365 | 59 | int path_split_and_make_absolute(const char *p, char ***ret); |
44a6b1b6 | 60 | char* path_make_absolute(const char *p, const char *prefix); |
a2556d25 | 61 | int safe_getcwd(char **ret); |
0f474365 | 62 | int path_make_absolute_cwd(const char *p, char **ret); |
fe69c41e | 63 | int path_make_relative(const char *from, const char *to, char **ret); |
d4f60bdc | 64 | int path_make_relative_parent(const char *from_child, const char *to, char **ret); |
63f11e35 YW |
65 | char *path_startswith_full(const char *path, const char *prefix, bool accept_dot_dot) _pure_; |
66 | static inline char* path_startswith(const char *path, const char *prefix) { | |
67 | return path_startswith_full(path, prefix, true); | |
68 | } | |
2230852b | 69 | int path_compare(const char *a, const char *b) _pure_; |
1a27c323 LP |
70 | |
71 | static inline bool path_equal(const char *a, const char *b) { | |
72 | return path_compare(a, b) == 0; | |
73 | } | |
74 | ||
e3f791a2 | 75 | bool path_equal_or_files_same(const char *a, const char *b, int flags); |
727e63e3 LB |
76 | /* Compares only the last portion of the input paths, ie: the filenames */ |
77 | bool path_equal_filename(const char *a, const char *b); | |
7ae27680 LP |
78 | |
79 | char* path_extend_internal(char **x, ...); | |
80 | #define path_extend(x, ...) path_extend_internal(x, __VA_ARGS__, POINTER_MAX) | |
81 | #define path_join(...) path_extend_internal(NULL, __VA_ARGS__, POINTER_MAX) | |
cd8194a3 | 82 | |
4ff361cc | 83 | char* path_simplify(char *path); |
44a6b1b6 | 84 | |
24737c29 ZJS |
85 | static inline bool path_equal_ptr(const char *a, const char *b) { |
86 | return !!a == !!b && (!a || path_equal(a, b)); | |
87 | } | |
88 | ||
3ae5990c | 89 | /* Note: the search terminates on the first NULL item. */ |
3593fa60 | 90 | #define PATH_IN_SET(p, ...) path_strv_contains(STRV_MAKE(__VA_ARGS__), p) |
3ae5990c | 91 | |
cc4d7d81 ZJS |
92 | char* path_startswith_strv(const char *p, char **set); |
93 | #define PATH_STARTSWITH_SET(p, ...) path_startswith_strv(p, STRV_MAKE(__VA_ARGS__)) | |
ad2706db | 94 | |
0f474365 | 95 | int path_strv_make_absolute_cwd(char **l); |
e1873695 LP |
96 | char** path_strv_resolve(char **l, const char *root); |
97 | char** path_strv_resolve_uniq(char **l, const char *root); | |
9eb977db | 98 | |
8c35c10d | 99 | int find_executable_full(const char *name, const char *root, char **exec_search_path, bool use_path_envvar, char **ret_filename, int *ret_fd); |
5ca9139a | 100 | static inline int find_executable(const char *name, char **ret_filename) { |
8c35c10d | 101 | return find_executable_full(name, /* root= */ NULL, NULL, true, ret_filename, NULL); |
92673045 | 102 | } |
fecffe5d | 103 | |
2ad8416d | 104 | bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update); |
8e184852 | 105 | |
eb66db55 MG |
106 | int fsck_exists(const char *fstype); |
107 | ||
e203f7c3 LP |
108 | /* Iterates through the path prefixes of the specified path, going up |
109 | * the tree, to root. Also returns "" (and not "/"!) for the root | |
110 | * directory. Excludes the specified directory itself */ | |
f8703ed7 ZJS |
111 | #define PATH_FOREACH_PREFIX(prefix, path) \ |
112 | for (char *_slash = ({ \ | |
4ff361cc | 113 | path_simplify(strcpy(prefix, path)); \ |
f8703ed7 ZJS |
114 | streq(prefix, "/") ? NULL : strrchr(prefix, '/'); \ |
115 | }); \ | |
116 | _slash && ((*_slash = 0), true); \ | |
117 | _slash = strrchr((prefix), '/')) | |
e203f7c3 LP |
118 | |
119 | /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */ | |
f8703ed7 ZJS |
120 | #define PATH_FOREACH_PREFIX_MORE(prefix, path) \ |
121 | for (char *_slash = ({ \ | |
4ff361cc | 122 | path_simplify(strcpy(prefix, path)); \ |
f8703ed7 ZJS |
123 | if (streq(prefix, "/")) \ |
124 | prefix[0] = 0; \ | |
125 | strrchr(prefix, 0); \ | |
126 | }); \ | |
127 | _slash && ((*_slash = 0), true); \ | |
128 | _slash = strrchr((prefix), '/')) | |
1d13f648 | 129 | |
c6134d3e | 130 | /* Similar to path_join(), but only works for two components, and only the first one may be NULL and returns |
95bbf19e | 131 | * an alloca() buffer, or possibly a const pointer into the path parameter. */ |
1d13f648 LP |
132 | #define prefix_roota(root, path) \ |
133 | ({ \ | |
134 | const char* _path = (path), *_root = (root), *_ret; \ | |
135 | char *_p, *_n; \ | |
136 | size_t _l; \ | |
137 | while (_path[0] == '/' && _path[1] == '/') \ | |
138 | _path ++; \ | |
95bbf19e | 139 | if (isempty(_root)) \ |
1d13f648 LP |
140 | _ret = _path; \ |
141 | else { \ | |
142 | _l = strlen(_root) + 1 + strlen(_path) + 1; \ | |
6e9417f5 | 143 | _n = newa(char, _l); \ |
1d13f648 LP |
144 | _p = stpcpy(_n, _root); \ |
145 | while (_p > _n && _p[-1] == '/') \ | |
146 | _p--; \ | |
147 | if (_path[0] != '/') \ | |
148 | *(_p++) = '/'; \ | |
149 | strcpy(_p, _path); \ | |
150 | _ret = _n; \ | |
151 | } \ | |
152 | _ret; \ | |
153 | }) | |
0f03c2a4 | 154 | |
0ee54dd4 | 155 | int path_find_first_component(const char **p, bool accept_dot_dot, const char **ret); |
484cd43c | 156 | int path_find_last_component(const char *path, bool accept_dot_dot, const char **next, const char **ret); |
b12d25a8 | 157 | const char *last_path_component(const char *path); |
01950464 YW |
158 | int path_extract_filename(const char *path, char **ret); |
159 | int path_extract_directory(const char *path, char **ret); | |
bb15fafe LP |
160 | |
161 | bool filename_is_valid(const char *p) _pure_; | |
32df2e14 YW |
162 | bool path_is_valid_full(const char *p, bool accept_dot_dot) _pure_; |
163 | static inline bool path_is_valid(const char *p) { | |
39e419a2 | 164 | return path_is_valid_full(p, /* accept_dot_dot= */ true); |
32df2e14 YW |
165 | } |
166 | static inline bool path_is_safe(const char *p) { | |
39e419a2 | 167 | return path_is_valid_full(p, /* accept_dot_dot= */ false); |
32df2e14 | 168 | } |
99be45a4 | 169 | bool path_is_normalized(const char *p) _pure_; |
a0956174 LP |
170 | |
171 | char *file_in_same_dir(const char *path, const char *filename); | |
172 | ||
55cdd057 | 173 | bool hidden_or_backup_file(const char *filename) _pure_; |
a0956174 LP |
174 | |
175 | bool is_device_path(const char *path); | |
57e84e75 LP |
176 | |
177 | bool valid_device_node_path(const char *path); | |
178 | bool valid_device_allow_pattern(const char *path); | |
5a46d55f | 179 | |
49bfc877 | 180 | bool dot_or_dot_dot(const char *path); |
a119ec7c LP |
181 | |
182 | static inline const char *skip_dev_prefix(const char *p) { | |
183 | const char *e; | |
184 | ||
185 | /* Drop any /dev prefix if there is any */ | |
186 | ||
187 | e = path_startswith(p, "/dev/"); | |
188 | ||
189 | return e ?: p; | |
190 | } | |
57ea45e1 | 191 | |
15bac3e8 | 192 | bool empty_or_root(const char *path); |
945403e6 YW |
193 | static inline const char *empty_to_root(const char *path) { |
194 | return isempty(path) ? "/" : path; | |
195 | } | |
3841fee8 LP |
196 | |
197 | bool path_strv_contains(char **l, const char *path); | |
de46b2be | 198 | bool prefixed_path_strv_contains(char **l, const char *path); |
3b703fe2 YW |
199 | |
200 | int path_glob_can_match(const char *pattern, const char *prefix, char **ret); |