src/basic/path-util.h

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