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 "time-util.h"
  28
  29 #define DEFAULT_PATH_NORMAL "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin"
  30 #define DEFAULT_PATH_SPLIT_USR DEFAULT_PATH_NORMAL ":/sbin:/bin"
  31
  32 #ifdef HAVE_SPLIT_USR
  33 #  define DEFAULT_PATH DEFAULT_PATH_SPLIT_USR
  34 #else
  35 #  define DEFAULT_PATH DEFAULT_PATH_NORMAL
  36 #endif
  37
  38 bool is_path(const char *p) _pure_;
  39 #if 0 /// UNNEEDED by elogind
  40 int path_split_and_make_absolute(const char *p, char ***ret);
  41 #endif // 0
  42 bool path_is_absolute(const char *p) _pure_;
  43 #if 0 /// UNNEEDED by elogind
  44 char* path_make_absolute(const char *p, const char *prefix);
  45 #endif // 0
  46 int path_make_absolute_cwd(const char *p, char **ret);
  47 #if 0 /// UNNEEDED by elogind
  48 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  49 #endif // 0
  50 char* path_kill_slashes(char *path);
  51 char* path_startswith(const char *path, const char *prefix) _pure_;
  52 int path_compare(const char *a, const char *b) _pure_;
  53 bool path_equal(const char *a, const char *b) _pure_;
  54 bool path_equal_or_files_same(const char *a, const char *b);
  55 #if 0 /// UNNEEDED by elogind
  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 #endif // 0
  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 int path_strv_make_absolute_cwd(char **l);
  78 #endif // 0
  79 char** path_strv_resolve(char **l, const char *prefix);
  80 char** path_strv_resolve_uniq(char **l, const char *prefix);
  81
  82 #if 0 /// UNNEEDED by elogind
  83 int find_binary(const char *name, char **filename);
  84
  85 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  86
  87 int fsck_exists(const char *fstype);
  88 int mkfs_exists(const char *fstype);
  89 #endif // 0
  90
  91 /* Iterates through the path prefixes of the specified path, going up
  92  * the tree, to root. Also returns "" (and not "/"!) for the root
  93  * directory. Excludes the specified directory itself */
  94 #define PATH_FOREACH_PREFIX(prefix, path) \
  95         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
  96
  97 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
  98 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
  99         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), '/'))
 100
 101 char *prefix_root(const char *root, const char *path);
 102
 103 /* Similar to prefix_root(), but returns an alloca() buffer, or
 104  * possibly a const pointer into the path parameter */
 105 #define prefix_roota(root, path)                                        \
 106         ({                                                              \
 107                 const char* _path = (path), *_root = (root), *_ret;     \
 108                 char *_p, *_n;                                          \
 109                 size_t _l;                                              \
 110                 while (_path[0] == '/' && _path[1] == '/')              \
 111                         _path ++;                                       \
 112                 if (isempty(_root) || path_equal(_root, "/"))           \
 113                         _ret = _path;                                   \
 114                 else {                                                  \
 115                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 116                         _n = alloca(_l);                                \
 117                         _p = stpcpy(_n, _root);                         \
 118                         while (_p > _n && _p[-1] == '/')                \
 119                                 _p--;                                   \
 120                         if (_path[0] != '/')                            \
 121                                 *(_p++) = '/';                          \
 122                         strcpy(_p, _path);                              \
 123                         _ret = _n;                                      \
 124                 }                                                       \
 125                 _ret;                                                   \
 126         })
 127
 128 #if 0 /// UNNEEDED by elogind
 129 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 130 #endif // 0
 131
 132 char* dirname_malloc(const char *path);
 133
 134 bool filename_is_valid(const char *p) _pure_;
 135 bool path_is_safe(const char *p) _pure_;
 136
 137 char *file_in_same_dir(const char *path, const char *filename);
 138
 139 bool hidden_or_backup_file(const char *filename) _pure_;
 140
 141 #if 0 /// UNNEEDED by elogind
 142 bool is_device_path(const char *path);
 143 #endif // 0