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_BIN(x) x "sbin:" x "bin"
  15 #define PATH_SPLIT_BIN_NULSTR(x) x "sbin\0" x "bin\0"
  16
  17 #define PATH_MERGED_BIN(x) x "bin"
  18 #define PATH_MERGED_BIN_NULSTR(x) x "bin\0"
  19
  20 #define DEFAULT_PATH_WITH_SBIN PATH_SPLIT_BIN("/usr/local/") ":" PATH_SPLIT_BIN("/usr/")
  21 #define DEFAULT_PATH_WITHOUT_SBIN PATH_MERGED_BIN("/usr/local/") ":" PATH_MERGED_BIN("/usr/")
  22
  23 #define DEFAULT_PATH_COMPAT PATH_SPLIT_BIN("/usr/local/") ":" PATH_SPLIT_BIN("/usr/") ":" PATH_SPLIT_BIN("/")
  24
  25 const char* default_PATH(void);
  26
  27 static inline const char* default_user_PATH(void) {
  28 #ifdef DEFAULT_USER_PATH
  29         return DEFAULT_USER_PATH;
  30 #else
  31         return default_PATH();
  32 #endif
  33 }
  34
  35 static inline bool is_path(const char *p) {
  36         if (!p) /* A NULL pointer is definitely not a path */
  37                 return false;
  38
  39         return strchr(p, '/');
  40 }
  41
  42 static inline bool path_is_absolute(const char *p) {
  43         if (!p) /* A NULL pointer is definitely not an absolute path */
  44                 return false;
  45
  46         return p[0] == '/';
  47 }
  48
  49 int path_split_and_make_absolute(const char *p, char ***ret);
  50 char* path_make_absolute(const char *p, const char *prefix);
  51 int safe_getcwd(char **ret);
  52 int path_make_absolute_cwd(const char *p, char **ret);
  53 int path_make_relative(const char *from, const char *to, char **ret);
  54 int path_make_relative_parent(const char *from_child, const char *to, char **ret);
  55 char* path_startswith_full(const char *path, const char *prefix, bool accept_dot_dot) _pure_;
  56 static inline char* path_startswith(const char *path, const char *prefix) {
  57         return path_startswith_full(path, prefix, true);
  58 }
  59
  60 int path_compare(const char *a, const char *b) _pure_;
  61 static inline bool path_equal(const char *a, const char *b) {
  62         return path_compare(a, b) == 0;
  63 }
  64
  65 int path_compare_filename(const char *a, const char *b);
  66 static inline bool path_equal_filename(const char *a, const char *b) {
  67         return path_compare_filename(a, b) == 0;
  68 }
  69
  70 int path_equal_or_inode_same_full(const char *a, const char *b, int flags);
  71 static inline bool path_equal_or_inode_same(const char *a, const char *b, int flags) {
  72         return path_equal_or_inode_same_full(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 /* Note: the search terminates on the first NULL item. */
 109 #define PATH_IN_SET(p, ...) path_strv_contains(STRV_MAKE(__VA_ARGS__), p)
 110
 111 char* path_startswith_strv(const char *p, char **set);
 112 #define PATH_STARTSWITH_SET(p, ...) path_startswith_strv(p, STRV_MAKE(__VA_ARGS__))
 113
 114 int path_strv_make_absolute_cwd(char **l);
 115 char** path_strv_resolve(char **l, const char *root);
 116 char** path_strv_resolve_uniq(char **l, const char *root);
 117
 118 int find_executable_full(const char *name, const char *root, char **exec_search_path, bool use_path_envvar, char **ret_filename, int *ret_fd);
 119 static inline int find_executable(const char *name, char **ret_filename) {
 120         return find_executable_full(name, /* root= */ NULL, NULL, true, ret_filename, NULL);
 121 }
 122
 123 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
 124
 125 int fsck_exists(void);
 126 int fsck_exists_for_fstype(const char *fstype);
 127
 128 /* Iterates through the path prefixes of the specified path, going up
 129  * the tree, to root. Also returns "" (and not "/"!) for the root
 130  * directory. Excludes the specified directory itself */
 131 #define PATH_FOREACH_PREFIX(prefix, path)                               \
 132         for (char *_slash = ({                                          \
 133                                 path_simplify(strcpy(prefix, path));    \
 134                                 streq(prefix, "/") ? NULL : strrchr(prefix, '/'); \
 135                         });                                             \
 136              _slash && ((*_slash = 0), true);                           \
 137              _slash = strrchr((prefix), '/'))
 138
 139 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 140 #define PATH_FOREACH_PREFIX_MORE(prefix, path)                          \
 141         for (char *_slash = ({                                          \
 142                                 path_simplify(strcpy(prefix, path));    \
 143                                 if (streq(prefix, "/"))                 \
 144                                         prefix[0] = 0;                  \
 145                                 strrchr(prefix, 0);                     \
 146                         });                                             \
 147              _slash && ((*_slash = 0), true);                           \
 148              _slash = strrchr((prefix), '/'))
 149
 150 /* Similar to path_join(), but only works for two components, and only the first one may be NULL and returns
 151  * an alloca() buffer, or possibly a const pointer into the path parameter. */
 152 /* DEPRECATED: use path_join() instead */
 153 #define prefix_roota(root, path)                                        \
 154         ({                                                              \
 155                 const char* _path = (path), *_root = (root), *_ret;     \
 156                 char *_p, *_n;                                          \
 157                 size_t _l;                                              \
 158                 while (_path[0] == '/' && _path[1] == '/')              \
 159                         _path++;                                        \
 160                 if (isempty(_root))                                     \
 161                         _ret = _path;                                   \
 162                 else {                                                  \
 163                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 164                         _n = newa(char, _l);                            \
 165                         _p = stpcpy(_n, _root);                         \
 166                         while (_p > _n && _p[-1] == '/')                \
 167                                 _p--;                                   \
 168                         if (_path[0] != '/')                            \
 169                                 *(_p++) = '/';                          \
 170                         strcpy(_p, _path);                              \
 171                         _ret = _n;                                      \
 172                 }                                                       \
 173                 _ret;                                                   \
 174         })
 175
 176 int path_find_first_component(const char **p, bool accept_dot_dot, const char **ret);
 177 int path_find_last_component(const char *path, bool accept_dot_dot, const char **next, const char **ret);
 178 const char* last_path_component(const char *path);
 179 int path_extract_filename(const char *path, char **ret);
 180 int path_extract_directory(const char *path, char **ret);
 181
 182 bool filename_part_is_valid(const char *p) _pure_;
 183 bool filename_is_valid(const char *p) _pure_;
 184 bool path_is_valid_full(const char *p, bool accept_dot_dot) _pure_;
 185 static inline bool path_is_valid(const char *p) {
 186         return path_is_valid_full(p, /* accept_dot_dot= */ true);
 187 }
 188 static inline bool path_is_safe(const char *p) {
 189         return path_is_valid_full(p, /* accept_dot_dot= */ false);
 190 }
 191 bool path_is_normalized(const char *p) _pure_;
 192
 193 int file_in_same_dir(const char *path, const char *filename, char **ret);
 194
 195 bool hidden_or_backup_file(const char *filename) _pure_;
 196
 197 bool is_device_path(const char *path);
 198
 199 bool valid_device_node_path(const char *path);
 200 bool valid_device_allow_pattern(const char *path);
 201
 202 bool dot_or_dot_dot(const char *path);
 203
 204 bool path_implies_directory(const char *path);
 205
 206 static inline const char *skip_dev_prefix(const char *p) {
 207         const char *e;
 208
 209         /* Drop any /dev prefix if there is any */
 210
 211         e = path_startswith(p, "/dev/");
 212
 213         return e ?: p;
 214 }
 215
 216 bool empty_or_root(const char *path);
 217 static inline const char* empty_to_root(const char *path) {
 218         return isempty(path) ? "/" : path;
 219 }
 220
 221 bool path_strv_contains(char **l, const char *path);
 222 bool prefixed_path_strv_contains(char **l, const char *path);
 223
 224 int path_glob_can_match(const char *pattern, const char *prefix, char **ret);