src/basic/path-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010-2012 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <alloca.h>
  24 #include <stdbool.h>
  25 #include <stddef.h>
  26
  27 #include "macro.h"
  28 #include "string-util.h"
  29 #include "time-util.h"
  30
  31 #define DEFAULT_PATH_NORMAL "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
  32 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":/sbin:/bin"
  33
  34 #if HAVE_SPLIT_USR
  35 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  36 #else
  37 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  38 #endif
  39
  40 bool is_path(const char *p) _pure_;
  41 #if 0 /// UNNEEDED by elogind
  42 int path_split_and_make_absolute(const char *p, char ***ret);
  43 #endif // 0
  44 bool path_is_absolute(const char *p) _pure_;
  45 #if 0 /// UNNEEDED by elogind
  46 char* path_make_absolute(const char *p, const char *prefix);
  47 #endif // 0
  48 int safe_getcwd(char **ret);
  49 int path_make_absolute_cwd(const char *p, char **ret);
  50 #if 0 /// UNNEEDED by elogind
  51 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  52 #endif // 0
  53 char* path_kill_slashes(char *path);
  54 char* path_startswith(const char *path, const char *prefix) _pure_;
  55 int path_compare(const char *a, const char *b) _pure_;
  56 bool path_equal(const char *a, const char *b) _pure_;
  57 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  58 char* path_join(const char *root, const char *path, const char *rest);
  59
  60 static inline bool path_equal_ptr(const char *a, const char *b) {
  61         return !!a == !!b && (!a || path_equal(a, b));
  62 }
  63
  64 /* Note: the search terminates on the first NULL item. */
  65 #define PATH_IN_SET(p, ...)                                     \
  66         ({                                                      \
  67                 char **s;                                       \
  68                 bool _found = false;                            \
  69                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  70                         if (path_equal(p, *s)) {                \
  71                                _found = true;                   \
  72                                break;                           \
  73                         }                                       \
  74                 _found;                                         \
  75         })
  76
  77 #if 0 /// UNNEEDED by elogind
  78 #define PATH_STARTSWITH_SET(p, ...)                             \
  79         ({                                                      \
  80                 char **s;                                       \
  81                 bool _found = false;                            \
  82                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  83                         if (path_startswith(p, *s)) {           \
  84                                _found = true;                   \
  85                                break;                           \
  86                         }                                       \
  87                 _found;                                         \
  88         })
  89
  90 int path_strv_make_absolute_cwd(char **l);
  91 #endif // 0
  92 char** path_strv_resolve(char **l, const char *root);
  93 char** path_strv_resolve_uniq(char **l, const char *root);
  94
  95 int find_binary(const char *name, char **filename);
  96
  97 #if 0 /// UNNEEDED by elogind
  98 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  99
 100 int fsck_exists(const char *fstype);
 101 int mkfs_exists(const char *fstype);
 102 #endif // 0
 103
 104 /* Iterates through the path prefixes of the specified path, going up
 105  * the tree, to root. Also returns "" (and not "/"!) for the root
 106  * directory. Excludes the specified directory itself */
 107 #define PATH_FOREACH_PREFIX(prefix, path) \
 108         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 109
 110 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 111 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
 112         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); if (streq(prefix, "/")) prefix[0] = 0; strrchr(prefix, 0); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 113
 114 char *prefix_root(const char *root, const char *path);
 115
 116 /* Similar to prefix_root(), but returns an alloca() buffer, or
 117  * possibly a const pointer into the path parameter */
 118 #define prefix_roota(root, path)                                        \
 119         ({                                                              \
 120                 const char* _path = (path), *_root = (root), *_ret;     \
 121                 char *_p, *_n;                                          \
 122                 size_t _l;                                              \
 123                 while (_path[0] == '/' && _path[1] == '/')              \
 124                         _path ++;                                       \
 125                 if (isempty(_root) || path_equal(_root, "/"))           \
 126                         _ret = _path;                                   \
 127                 else {                                                  \
 128                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 129                         _n = alloca(_l);                                \
 130                         _p = stpcpy(_n, _root);                         \
 131                         while (_p > _n && _p[-1] == '/')                \
 132                                 _p--;                                   \
 133                         if (_path[0] != '/')                            \
 134                                 *(_p++) = '/';                          \
 135                         strcpy(_p, _path);                              \
 136                         _ret = _n;                                      \
 137                 }                                                       \
 138                 _ret;                                                   \
 139         })
 140
 141 #if 0 /// UNNEEDED by elogind
 142 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 143 #endif // 0
 144
 145 char* dirname_malloc(const char *path);
 146 const char *last_path_component(const char *path);
 147
 148 bool filename_is_valid(const char *p) _pure_;
 149 bool path_is_normalized(const char *p) _pure_;
 150
 151 char *file_in_same_dir(const char *path, const char *filename);
 152
 153 bool hidden_or_backup_file(const char *filename) _pure_;
 154
 155 #if 0 /// UNNEEDED by elogind
 156 bool is_device_path(const char *path);
 157 bool is_deviceallow_pattern(const char *path);
 158
 159 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 160 #endif // 0
 161
 162 bool dot_or_dot_dot(const char *path);
 163
 164 static inline const char *skip_dev_prefix(const char *p) {
 165         const char *e;
 166
 167         /* Drop any /dev prefix if there is any */
 168
 169         e = path_startswith(p, "/dev/");
 170
 171         return e ?: p;
 172 }