src/basic/path-util.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010-2012 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <stdbool.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 /// UNNEEDED by elogind
  40 #if 0
  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 /// UNNEEDED by elogind
  45 #if 0
  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 /// UNNEEDED by elogind
  50 #if 0
  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);
  58 /// UNNEEDED by elogind
  59 #if 0
  60 char* path_join(const char *root, const char *path, const char *rest);
  61
  62 int path_strv_make_absolute_cwd(char **l);
  63 #endif // 0
  64 char** path_strv_resolve(char **l, const char *prefix);
  65 char** path_strv_resolve_uniq(char **l, const char *prefix);
  66
  67 /// UNNEEDED by elogind
  68 #if 0
  69 int find_binary(const char *name, char **filename);
  70
  71 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  72
  73 int fsck_exists(const char *fstype);
  74 int mkfs_exists(const char *fstype);
  75 #endif // 0
  76
  77 /* Iterates through the path prefixes of the specified path, going up
  78  * the tree, to root. Also returns "" (and not "/"!) for the root
  79  * directory. Excludes the specified directory itself */
  80 #define PATH_FOREACH_PREFIX(prefix, path) \
  81         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
  82
  83 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
  84 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
  85         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), '/'))
  86
  87 char *prefix_root(const char *root, const char *path);
  88
  89 /* Similar to prefix_root(), but returns an alloca() buffer, or
  90  * possibly a const pointer into the path parameter */
  91 #define prefix_roota(root, path)                                        \
  92         ({                                                              \
  93                 const char* _path = (path), *_root = (root), *_ret;     \
  94                 char *_p, *_n;                                          \
  95                 size_t _l;                                              \
  96                 while (_path[0] == '/' && _path[1] == '/')              \
  97                         _path ++;                                       \
  98                 if (isempty(_root) || path_equal(_root, "/"))           \
  99                         _ret = _path;                                   \
 100                 else {                                                  \
 101                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
 102                         _n = alloca(_l);                                \
 103                         _p = stpcpy(_n, _root);                         \
 104                         while (_p > _n && _p[-1] == '/')                \
 105                                 _p--;                                   \
 106                         if (_path[0] != '/')                            \
 107                                 *(_p++) = '/';                          \
 108                         strcpy(_p, _path);                              \
 109                         _ret = _n;                                      \
 110                 }                                                       \
 111                 _ret;                                                   \
 112         })
 113
 114 /// UNNEEDED by elogind
 115 #if 0
 116 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 117 #endif // 0
 118
 119 char* dirname_malloc(const char *path);
 120
 121 bool filename_is_valid(const char *p) _pure_;
 122 bool path_is_safe(const char *p) _pure_;
 123
 124 char *file_in_same_dir(const char *path, const char *filename);
 125
 126 bool hidden_file_allow_backup(const char *filename);
 127 bool hidden_file(const char *filename) _pure_;
 128
 129 /// UNNEEDED by elogind
 130 #if 0
 131 bool is_device_path(const char *path);
 132 #endif // 0