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