1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/*
* Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/* Utilities for dealing with filesystem paths. */
#define GOT_DEFAULT_PACK_MODE (S_IFREG | \
S_IRUSR | S_IRGRP | S_IROTH)
#define GOT_DEFAULT_FILE_MODE (S_IFREG | \
S_IRUSR|S_IWUSR | S_IRGRP | S_IROTH)
#define GOT_DEFAULT_DIR_MODE (S_IFDIR | \
S_IRWXU | S_IRGRP|S_IXGRP | S_IROTH|S_IXOTH)
struct dirent;
/* Determine whether a path is an absolute path. */
int got_path_is_absolute(const char *);
/*
* Canonicalize absolute paths by removing redundant path separators
* and resolving references to parent directories ("/../").
* Relative paths are copied from input to buf as-is.
*/
const struct got_error *got_canonpath(const char *, char *, size_t);
/*
* Get child part of two absolute paths. The second path must equal the first
* path up to some path component, and must be longer than the first path.
* The result is allocated with malloc(3).
*/
const struct got_error *got_path_skip_common_ancestor(char **, const char *,
const char *);
/*
* Remove leading components from path. It's an error to strip more
* component than present. The result is allocated dynamically.
*/
const struct got_error *got_path_strip(char **, const char *, int);
/* Determine whether a path points to the root directory "/" . */
int got_path_is_root_dir(const char *);
/* Determine whether a path is a path-wise child of another path. */
int got_path_is_child(const char *, const char *, size_t);
/*
* Like strcmp() but orders children in subdirectories directly after
* their parents. String lengths must also be passed in.
*/
int got_path_cmp(const char *, const char *, size_t, size_t);
struct got_pathlist_entry {
RB_ENTRY(got_pathlist_entry) entry;
const char *path;
size_t path_len;
void *data; /* data pointer provided to got_pathlist_insert() */
};
int got_pathlist_cmp(const struct got_pathlist_entry * , const struct got_pathlist_entry *);
RB_HEAD(got_pathlist_head, got_pathlist_entry);
RB_PROTOTYPE(got_pathlist_head, got_pathlist_entry, entry, got_pathlist_cmp);
/*
* Insert a path into the list of paths in a predictable order.
* The caller should already have initialized the list head. This list stores
* the pointer to the path as-is, i.e. the path is not copied internally and
* must remain available until the list is freed with got_pathlist_free().
* If the first argument is not NULL, set it to a pointer to the newly inserted
* element, or to a NULL pointer in case the path was already on the list.
*/
const struct got_error *got_pathlist_insert(struct got_pathlist_entry **,
struct got_pathlist_head *, const char *, void *);
/* Flags passed to got_pathlist_free() to control which pointers are freed. */
#define GOT_PATHLIST_FREE_NONE 0 /* pathlist entry only */
#define GOT_PATHLIST_FREE_PATH (1 << 0) /* entry and path pointer */
#define GOT_PATHLIST_FREE_DATA (1 << 1) /* entry and data pointer */
#define GOT_PATHLIST_FREE_ALL (GOT_PATHLIST_FREE_PATH|GOT_PATHLIST_FREE_DATA)
/* Free resources allocated for a path list. */
void got_pathlist_free(struct got_pathlist_head *, int);
/* Attempt to create a directory at a given path. */
const struct got_error *got_path_mkdir(const char *);
/* Determine whether a directory has no files or directories in it. */
int got_path_dir_is_empty(const char *);
/*
* dirname(3) with error handling, dynamically allocated result, and
* unmodified input.
*/
const struct got_error *got_path_dirname(char **, const char *);
/*
* Obtain the file type of a given directory entry.
*
* If the entry has some type other than DT_UNKNOWN, resolve to this type.
*
* Otherwise, attempt to resolve the type of a DT_UNKNOWN directory
* entry with lstat(2), though the result may still be DT_UNKNOWN.
* This is a fallback to accommodate filesystems which do not provide
* directory entry type information.
* DT_UNKNOWN directory entries occur on NFS mounts without "readdir plus" RPC.
*/
const struct got_error *got_path_dirent_type(int *, const char *,
struct dirent *);
/* basename(3) with dynamically allocated result and unmodified input. */
const struct got_error *got_path_basename(char **, const char *);
/* Strip trailing slashes from a path; path will be modified in-place. */
void got_path_strip_trailing_slashes(char *);
/* Look up the absolute path of a program in $PATH */
const struct got_error *got_path_find_prog(char **, const char *);
/* Create a new file at a specified path, with optional content. */
const struct got_error *got_path_create_file(const char *, const char *);
/*
* Attempt to move an existing file to a new path, creating missing parent
* directories at the destination path if necessary.
* (Cross-mount-point moves are not yet implemented.)
*/
const struct got_error *got_path_move_file(const char *, const char *);
|
