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 <alloca.h>
  25 #include <stdbool.h>
  26 #include <stddef.h>
  27
  28 #include "macro.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 #ifdef 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 int path_split_and_make_absolute(const char *p, char ***ret);
  42 bool path_is_absolute(const char *p) _pure_;
  43 char* path_make_absolute(const char *p, const char *prefix);
  44 int path_make_absolute_cwd(const char *p, char **ret);
  45 int path_make_relative(const char *from_dir, const char *to_path, char **_r);
  46 char* path_kill_slashes(char *path);
  47 char* path_startswith(const char *path, const char *prefix) _pure_;
  48 int path_compare(const char *a, const char *b) _pure_;
  49 bool path_equal(const char *a, const char *b) _pure_;
  50 bool path_equal_or_files_same(const char *a, const char *b);
  51 char* path_join(const char *root, const char *path, const char *rest);
  52
  53 int path_strv_make_absolute_cwd(char **l);
  54 char** path_strv_resolve(char **l, const char *prefix);
  55 char** path_strv_resolve_uniq(char **l, const char *prefix);
  56
  57 int find_binary(const char *name, char **filename);
  58
  59 bool paths_check_timestamp(const char* const* paths, usec_t *paths_ts_usec, bool update);
  60
  61 int fsck_exists(const char *fstype);
  62 int mkfs_exists(const char *fstype);
  63
  64 /* Iterates through the path prefixes of the specified path, going up
  65  * the tree, to root. Also returns "" (and not "/"!) for the root
  66  * directory. Excludes the specified directory itself */
  67 #define PATH_FOREACH_PREFIX(prefix, path) \
  68         for (char *_slash = ({ path_kill_slashes(strcpy(prefix, path)); streq(prefix, "/") ? NULL : strrchr(prefix, '/'); }); _slash && ((*_slash = 0), true); _slash = strrchr((prefix), '/'))
  69
  70 /* Same as PATH_FOREACH_PREFIX but also includes the specified path itself */
  71 #define PATH_FOREACH_PREFIX_MORE(prefix, path) \
  72         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), '/'))
  73
  74 char *prefix_root(const char *root, const char *path);
  75
  76 /* Similar to prefix_root(), but returns an alloca() buffer, or
  77  * possibly a const pointer into the path parameter */
  78 #define prefix_roota(root, path)                                        \
  79         ({                                                              \
  80                 const char* _path = (path), *_root = (root), *_ret;     \
  81                 char *_p, *_n;                                          \
  82                 size_t _l;                                              \
  83                 while (_path[0] == '/' && _path[1] == '/')              \
  84                         _path ++;                                       \
  85                 if (isempty(_root) || path_equal(_root, "/"))           \
  86                         _ret = _path;                                   \
  87                 else {                                                  \
  88                         _l = strlen(_root) + 1 + strlen(_path) + 1;     \
  89                         _n = alloca(_l);                                \
  90                         _p = stpcpy(_n, _root);                         \
  91                         while (_p > _n && _p[-1] == '/')                \
  92                                 _p--;                                   \
  93                         if (_path[0] != '/')                            \
  94                                 *(_p++) = '/';                          \
  95                         strcpy(_p, _path);                              \
  96                         _ret = _n;                                      \
  97                 }                                                       \
  98                 _ret;                                                   \
  99         })
 100
 101 int parse_path_argument_and_warn(const char *path, bool suppress_root, char **arg);
 102
 103 char* dirname_malloc(const char *path);
 104
 105 bool filename_is_valid(const char *p) _pure_;
 106 bool path_is_safe(const char *p) _pure_;
 107
 108 char *file_in_same_dir(const char *path, const char *filename);
 109
 110 bool hidden_file_allow_backup(const char *filename);
 111 bool hidden_file(const char *filename) _pure_;
 112
 113 bool is_device_path(const char *path);