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