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 path_make_absolute_cwd(const char *p, char **ret);
  49 #if 0 /// UNNEEDED by elogind
  50 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  51 #endif // 0
  52 char* path_kill_slashes(char *path);
  53 char* path_startswith(const char *path, const char *prefix) _pure_;
  54 int path_compare(const char *a, const char *b) _pure_;
  55 bool path_equal(const char *a, const char *b) _pure_;
  56 bool path_equal_or_files_same(const char *a, const char *b, int flags);
  57 char* path_join(const char *root, const char *path, const char *rest);
  58
  59 static inline bool path_equal_ptr(const char *a, const char *b) {
  60         return !!a == !!b && (!a || path_equal(a, b));
  61 }
  62
  63 /* Note: the search terminates on the first NULL item. */
  64 #define PATH_IN_SET(p, ...)                                     \
  65         ({                                                      \
  66                 char **s;                                       \
  67                 bool _found = false;                            \
  68                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  69                         if (path_equal(p, *s)) {                \
  70                                _found = true;                   \
  71                                break;                           \
  72                         }                                       \
  73                 _found;                                         \
  74         })
  75
  76 #if 0 /// UNNEEDED by elogind
  77 #define PATH_STARTSWITH_SET(p, ...)                             \
  78         ({                                                      \
  79                 char **s;                                       \
  80                 bool _found = false;                            \
  81                 STRV_FOREACH(s, STRV_MAKE(__VA_ARGS__))         \
  82                         if (path_startswith(p, *s)) {           \
  83                                _found = true;                   \
  84                                break;                           \
  85                         }                                       \
  86                 _found;                                         \
  87         })
  88
  89 int path_strv_make_absolute_cwd(char **l);
  90 #endif // 0
  91 char** path_strv_resolve(char **l, const char *root);
  92 char** path_strv_resolve_uniq(char **l, const char *root);
  93
  94 int find_binary(const char *name, char **filename);
  95
  96 #if 0 /// UNNEEDED by elogind
  97 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  98
  99 int fsck_exists(const char *fstype);
 100 int mkfs_exists(const char *fstype);
 101 #endif // 0
 102
 103 /* Iterates through the path prefixes of the specified path, going up
 104  * the tree, to root. Also returns "" (and not "/"!) for the root
 105  * directory. Excludes the specified directory itself */
 106 #define PATH_FOREACH_PREFIX(prefix, path) \
 107         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
 108
 109 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
 110 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
 111         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), '/'))
 112
 113 char *prefix_root(const char *root, const char *path);
 114
 115 /* Similar to prefix_root(), but returns an alloca() buffer, or
 116  * possibly a const pointer into the path parameter */
 117 #define prefix_roota(root, path)                                        \
 118         ({                                                              \
 119                 const char* _path = (path), *_root = (root), *_ret;     \
 120                 char *_p, *_n;                                          \
 121                 size_t _l;                                              \
 122                 while (_path[0] == '/' && _path[1] == '/')              \
 123                         _path ++;                                       \
 124                 if (isempty(_root) || path_equal(_root, "/"))           \
 125                         _ret = _path;                                   \
 126                 else {                                                  \
 127                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 128                         _n = alloca(_l);                                \
 129                         _p = stpcpy(_n, _root);                         \
 130                         while (_p > _n && _p[-1] == '/')                \
 131                                 _p--;                                   \
 132                         if (_path[0] != '/')                            \
 133                                 *(_p++) = '/';                          \
 134                         strcpy(_p, _path);                              \
 135                         _ret = _n;                                      \
 136                 }                                                       \
 137                 _ret;                                                   \
 138         })
 139
 140 #if 0 /// UNNEEDED by elogind
 141 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 142 #endif // 0
 143
 144 char* dirname_malloc(const char *path);
 145 const char *last_path_component(const char *path);
 146
 147 bool filename_is_valid(const char *p) _pure_;
 148 bool path_is_normalized(const char *p) _pure_;
 149
 150 char *file_in_same_dir(const char *path, const char *filename);
 151
 152 bool hidden_or_backup_file(const char *filename) _pure_;
 153
 154 #if 0 /// UNNEEDED by elogind
 155 bool is_device_path(const char *path);
 156 bool is_deviceallow_pattern(const char *path);
 157
 158 int systemd_installation_has_version(const char *root, unsigned minimal_version);
 159 #endif // 0
 160
 161 bool dot_or_dot_dot(const char *path);
 162
 163 static inline const char *skip_dev_prefix(const char *p) {
 164         const char *e;
 165
 166         /* Drop any /dev prefix if there is any */
 167
 168         e = path_startswith(p, "/dev/");
 169
 170         return e ?: p;
 171 }