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 typedef enum PathSimplifyFlags {
  80         PATH_SIMPLIFY_KEEP_TRAILING_SLASH = 1 << 0,
  81 } PathSimplifyFlags;
  82
  83 char *path_simplify_full(char *path, PathSimplifyFlags flags);
  84 static inline char* path_simplify(char *path) {
  85         return path_simplify_full(path, 0);
  86 }
  87
  88 static inline bool path_equal_ptr(const char *a, const char *b) {
  89         return !!a == !!b && (!a || path_equal(a, b));
  90 }
  91
  92 /* Note: the search terminates on the first NULL item. */
  93 #define PATH_IN_SET(p, ...) path_strv_contains(STRV_MAKE(__VA_ARGS__), p)
  94
  95 char* path_startswith_strv(const char *p, char **set);
  96 #define PATH_STARTSWITH_SET(p, ...) path_startswith_strv(p, STRV_MAKE(__VA_ARGS__))
  97
  98 int path_strv_make_absolute_cwd(char **l);
  99 char** path_strv_resolve(char **l, const char *root);
 100 char** path_strv_resolve_uniq(char **l, const char *root);
 101
 102 int find_executable_full(const char *name, const char *root, char **exec_search_path, bool use_path_envvar, char **ret_filename, int *ret_fd);
 103 static inline int find_executable(const char *name, char **ret_filename) {
 104         return find_executable_full(name, /* root= */ NULL, NULL, true, ret_filename, NULL);
 105 }
 106
 107 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
 108
 109 int fsck_exists(void);
 110 int fsck_exists_for_fstype(const char *fstype);
 111
 112 /* Iterates through the path prefixes of the specified path, going up
 113  * the tree, to root. Also returns "" (and not "/"!) for the root
 114  * directory. Excludes the specified directory itself */
 115 #define PATH_FOREACH_PREFIX(prefix, path)                               \
 116         for (char *_slash = ({                                          \
 117                                 path_simplify(strcpy(prefix, path));    \
 118                                 streq(prefix, "/") ? NULL : strrchr(prefix, '/'); \
 119                         });                                             \
 120              _slash && ((*_slash = 0), true);                           \
 121              _slash = strrchr((prefix), '/'))
 122
 123 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 124 #define PATH_FOREACH_PREFIX_MORE(prefix, path)                          \
 125         for (char *_slash = ({                                          \
 126                                 path_simplify(strcpy(prefix, path));    \
 127                                 if (streq(prefix, "/"))                 \
 128                                         prefix[0] = 0;                  \
 129                                 strrchr(prefix, 0);                     \
 130                         });                                             \
 131              _slash && ((*_slash = 0), true);                           \
 132              _slash = strrchr((prefix), '/'))
 133
 134 /* Similar to path_join(), but only works for two components, and only the first one may be NULL and returns
 135  * an alloca() buffer, or possibly a const pointer into the path parameter. */
 136 /* DEPRECATED: use path_join() instead */
 137 #define prefix_roota(root, path)                                        \
 138         ({                                                              \
 139                 const char* _path = (path), *_root = (root), *_ret;     \
 140                 char *_p, *_n;                                          \
 141                 size_t _l;                                              \
 142                 while (_path[0] == '/' && _path[1] == '/')              \
 143                         _path ++;                                       \
 144                 if (isempty(_root))                                     \
 145                         _ret = _path;                                   \
 146                 else {                                                  \
 147                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 148                         _n = newa(char, _l);                            \
 149                         _p = stpcpy(_n, _root);                         \
 150                         while (_p > _n && _p[-1] == '/')                \
 151                                 _p--;                                   \
 152                         if (_path[0] != '/')                            \
 153                                 *(_p++) = '/';                          \
 154                         strcpy(_p, _path);                              \
 155                         _ret = _n;                                      \
 156                 }                                                       \
 157                 _ret;                                                   \
 158         })
 159
 160 int path_find_first_component(const char **p, bool accept_dot_dot, const char **ret);
 161 int path_find_last_component(const char *path, bool accept_dot_dot, const char **next, const char **ret);
 162 const char *last_path_component(const char *path);
 163 int path_extract_filename(const char *path, char **ret);
 164 int path_extract_directory(const char *path, char **ret);
 165
 166 bool filename_part_is_valid(const char *p) _pure_;
 167 bool filename_is_valid(const char *p) _pure_;
 168 bool path_is_valid_full(const char *p, bool accept_dot_dot) _pure_;
 169 static inline bool path_is_valid(const char *p) {
 170         return path_is_valid_full(p, /* accept_dot_dot= */ true);
 171 }
 172 static inline bool path_is_safe(const char *p) {
 173         return path_is_valid_full(p, /* accept_dot_dot= */ false);
 174 }
 175 bool path_is_normalized(const char *p) _pure_;
 176
 177 int file_in_same_dir(const char *path, const char *filename, char **ret);
 178
 179 bool hidden_or_backup_file(const char *filename) _pure_;
 180
 181 bool is_device_path(const char *path);
 182
 183 bool valid_device_node_path(const char *path);
 184 bool valid_device_allow_pattern(const char *path);
 185
 186 bool dot_or_dot_dot(const char *path);
 187
 188 static inline const char *skip_dev_prefix(const char *p) {
 189         const char *e;
 190
 191         /* Drop any /dev prefix if there is any */
 192
 193         e = path_startswith(p, "/dev/");
 194
 195         return e ?: p;
 196 }
 197
 198 bool empty_or_root(const char *path);
 199 static inline const char *empty_to_root(const char *path) {
 200         return isempty(path) ? "/" : path;
 201 }
 202
 203 bool path_strv_contains(char **l, const char *path);
 204 bool prefixed_path_strv_contains(char **l, const char *path);
 205
 206 int path_glob_can_match(const char *pattern, const char *prefix, char **ret);