src/basic/path-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <alloca.h>
   5 #include <stdbool.h>
   6 #include <stddef.h>
   7
   8 #include "macro.h"
   9 #include "stat-util.h"
  10 #include "string-util.h"
  11 #include "strv.h"
  12 #include "time-util.h"
  13
  14 #define PATH_SPLIT_SBIN_BIN(x) x "sbin:" x "bin"
  15 #define PATH_SPLIT_SBIN_BIN_NULSTR(x) x "sbin\0" x "bin\0"
  16
  17 #define PATH_NORMAL_SBIN_BIN(x) x "bin"
  18 #define PATH_NORMAL_SBIN_BIN_NULSTR(x) x "bin\0"
  19
  20 #if HAVE_SPLIT_BIN
  21 #  define PATH_SBIN_BIN(x) PATH_SPLIT_SBIN_BIN(x)
  22 #  define PATH_SBIN_BIN_NULSTR(x) PATH_SPLIT_SBIN_BIN_NULSTR(x)
  23 #else
  24 #  define PATH_SBIN_BIN(x) PATH_NORMAL_SBIN_BIN(x)
  25 #  define PATH_SBIN_BIN_NULSTR(x) PATH_NORMAL_SBIN_BIN_NULSTR(x)
  26 #endif
  27
  28 #define DEFAULT_PATH PATH_SBIN_BIN("/usr/local/") ":" PATH_SBIN_BIN("/usr/")
  29 #define DEFAULT_PATH_NULSTR PATH_SBIN_BIN_NULSTR("/usr/local/") PATH_SBIN_BIN_NULSTR("/usr/")
  30 #define DEFAULT_PATH_COMPAT PATH_SPLIT_SBIN_BIN("/usr/local/") ":" PATH_SPLIT_SBIN_BIN("/usr/") ":" PATH_SPLIT_SBIN_BIN("/")
  31
  32 #ifndef DEFAULT_USER_PATH
  33 #  define DEFAULT_USER_PATH DEFAULT_PATH
  34 #endif
  35
  36 static inline bool is_path(const char *p) {
  37         if (!p) /* A NULL pointer is definitely not a path */
  38                 return false;
  39
  40         return strchr(p, '/');
  41 }
  42
  43 static inline bool path_is_absolute(const char *p) {
  44         if (!p) /* A NULL pointer is definitely not an absolute path */
  45                 return false;
  46
  47         return p[0] == '/';
  48 }
  49
  50 int path_split_and_make_absolute(const char *p, char ***ret);
  51 char* path_make_absolute(const char *p, const char *prefix);
  52 int safe_getcwd(char **ret);
  53 int path_make_absolute_cwd(const char *p, char **ret);
  54 int path_make_relative(const char *from, const char *to, char **ret);
  55 int path_make_relative_parent(const char *from_child, const char *to, char **ret);
  56 char* path_startswith_full(const char *path, const char *prefix, bool accept_dot_dot) _pure_;
  57 static inline char* path_startswith(const char *path, const char *prefix) {
  58         return path_startswith_full(path, prefix, true);
  59 }
  60
  61 int path_compare(const char *a, const char *b) _pure_;
  62 static inline bool path_equal(const char *a, const char *b) {
  63         return path_compare(a, b) == 0;
  64 }
  65
  66 int path_compare_filename(const char *a, const char *b);
  67 static inline bool path_equal_filename(const char *a, const char *b) {
  68         return path_compare_filename(a, b) == 0;
  69 }
  70
  71 static inline bool path_equal_or_inode_same(const char *a, const char *b, int flags) {
  72         return path_equal(a, b) || inode_same(a, b, flags) > 0;
  73 }
  74
  75 char* path_extend_internal(char **x, ...);
  76 #define path_extend(x, ...) path_extend_internal(x, __VA_ARGS__, POINTER_MAX)
  77 #define path_join(...) path_extend_internal(NULL, __VA_ARGS__, POINTER_MAX)
  78
  79 static inline char* skip_leading_slash(const char *p) {
  80         return skip_leading_chars(p, "/");
  81 }
  82
  83 typedef enum PathSimplifyFlags {
  84         PATH_SIMPLIFY_KEEP_TRAILING_SLASH = 1 << 0,
  85 } PathSimplifyFlags;
  86
  87 char* path_simplify_full(char *path, PathSimplifyFlags flags);
  88 static inline char* path_simplify(char *path) {
  89         return path_simplify_full(path, 0);
  90 }
  91
  92 static inline int path_simplify_alloc(const char *path, char **ret) {
  93         assert(ret);
  94
  95         if (!path) {
  96                 *ret = NULL;
  97                 return 0;
  98         }
  99
 100         char *t = strdup(path);
 101         if (!t)
 102                 return -ENOMEM;
 103
 104         *ret = path_simplify(t);
 105         return 0;
 106 }
 107
 108 static inline bool path_equal_ptr(const char *a, const char *b) {
 109         return !!a == !!b && (!a || path_equal(a, b));
 110 }
 111
 112 /* Note: the search terminates on the first NULL item. */
 113 #define PATH_IN_SET(p, ...) path_strv_contains(STRV_MAKE(__VA_ARGS__), p)
 114
 115 char* path_startswith_strv(const char *p, char **set);
 116 #define PATH_STARTSWITH_SET(p, ...) path_startswith_strv(p, STRV_MAKE(__VA_ARGS__))
 117
 118 int path_strv_make_absolute_cwd(char **l);
 119 char** path_strv_resolve(char **l, const char *root);
 120 char** path_strv_resolve_uniq(char **l, const char *root);
 121
 122 int find_executable_full(const char *name, const char *root, char **exec_search_path, bool use_path_envvar, char **ret_filename, int *ret_fd);
 123 static inline int find_executable(const char *name, char **ret_filename) {
 124         return find_executable_full(name, /* root= */ NULL, NULL, true, ret_filename, NULL);
 125 }
 126
 127 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
 128
 129 int fsck_exists(void);
 130 int fsck_exists_for_fstype(const char *fstype);
 131
 132 /* Iterates through the path prefixes of the specified path, going up
 133  * the tree, to root. Also returns "" (and not "/"!) for the root
 134  * directory. Excludes the specified directory itself */
 135 #define PATH_FOREACH_PREFIX(prefix, path)                               \
 136         for (char *_slash = ({                                          \
 137                                 path_simplify(strcpy(prefix, path));    \
 138                                 streq(prefix, "/") ? NULL : strrchr(prefix, '/'); \
 139                         });                                             \
 140              _slash && ((*_slash = 0), true);                           \
 141              _slash = strrchr((prefix), '/'))
 142
 143 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 144 #define PATH_FOREACH_PREFIX_MORE(prefix, path)                          \
 145         for (char *_slash = ({                                          \
 146                                 path_simplify(strcpy(prefix, path));    \
 147                                 if (streq(prefix, "/"))                 \
 148                                         prefix[0] = 0;                  \
 149                                 strrchr(prefix, 0);                     \
 150                         });                                             \
 151              _slash && ((*_slash = 0), true);                           \
 152              _slash = strrchr((prefix), '/'))
 153
 154 /* Similar to path_join(), but only works for two components, and only the first one may be NULL and returns
 155  * an alloca() buffer, or possibly a const pointer into the path parameter. */
 156 /* DEPRECATED: use path_join() instead */
 157 #define prefix_roota(root, path)                                        \
 158         ({                                                              \
 159                 const char* _path = (path), *_root = (root), *_ret;     \
 160                 char *_p, *_n;                                          \
 161                 size_t _l;                                              \
 162                 while (_path[0] == '/' && _path[1] == '/')              \
 163                         _path++;                                        \
 164                 if (isempty(_root))                                     \
 165                         _ret = _path;                                   \
 166                 else {                                                  \
 167                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 168                         _n = newa(char, _l);                            \
 169                         _p = stpcpy(_n, _root);                         \
 170                         while (_p > _n && _p[-1] == '/')                \
 171                                 _p--;                                   \
 172                         if (_path[0] != '/')                            \
 173                                 *(_p++) = '/';                          \
 174                         strcpy(_p, _path);                              \
 175                         _ret = _n;                                      \
 176                 }                                                       \
 177                 _ret;                                                   \
 178         })
 179
 180 int path_find_first_component(const char **p, bool accept_dot_dot, const char **ret);
 181 int path_find_last_component(const char *path, bool accept_dot_dot, const char **next, const char **ret);
 182 const char* last_path_component(const char *path);
 183 int path_extract_filename(const char *path, char **ret);
 184 int path_extract_directory(const char *path, char **ret);
 185
 186 bool filename_part_is_valid(const char *p) _pure_;
 187 bool filename_is_valid(const char *p) _pure_;
 188 bool path_is_valid_full(const char *p, bool accept_dot_dot) _pure_;
 189 static inline bool path_is_valid(const char *p) {
 190         return path_is_valid_full(p, /* accept_dot_dot= */ true);
 191 }
 192 static inline bool path_is_safe(const char *p) {
 193         return path_is_valid_full(p, /* accept_dot_dot= */ false);
 194 }
 195 bool path_is_normalized(const char *p) _pure_;
 196
 197 int file_in_same_dir(const char *path, const char *filename, char **ret);
 198
 199 bool hidden_or_backup_file(const char *filename) _pure_;
 200
 201 bool is_device_path(const char *path);
 202
 203 bool valid_device_node_path(const char *path);
 204 bool valid_device_allow_pattern(const char *path);
 205
 206 bool dot_or_dot_dot(const char *path);
 207
 208 bool path_implies_directory(const char *path);
 209
 210 static inline const char *skip_dev_prefix(const char *p) {
 211         const char *e;
 212
 213         /* Drop any /dev prefix if there is any */
 214
 215         e = path_startswith(p, "/dev/");
 216
 217         return e ?: p;
 218 }
 219
 220 bool empty_or_root(const char *path);
 221 static inline const char* empty_to_root(const char *path) {
 222         return isempty(path) ? "/" : path;
 223 }
 224
 225 bool path_strv_contains(char **l, const char *path);
 226 bool prefixed_path_strv_contains(char **l, const char *path);
 227
 228 int path_glob_can_match(const char *pattern, const char *prefix, char **ret);