1 /*
2  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
3  * Copyright (c) 2015 Theo de Raadt <deraadt@openbsd.org>
4  * Copyright (c) 1997 Todd C. Miller <millert@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <sys/queue.h>
20 #include <sys/stat.h>
21 
22 #include <errno.h>
23 #include <fcntl.h>
24 #include <limits.h>
25 #include <libgen.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <dirent.h>
31 #include <paths.h>
32 
33 #include "got_error.h"
34 #include "got_path.h"
35 
36 #ifndef MIN
37 #define	MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
38 #endif
39 
40 int
41 got_path_is_absolute(const char *path)
42 {
43 	return path[0] == '/';
44 }
45 
46 char *
47 got_path_get_absolute(const char *relpath) 
48 {
49 	char cwd[PATH_MAX];
50 	char *abspath;
51 
52 	if (getcwd(cwd, sizeof(cwd)) == NULL)
53 		return NULL;
54 
55 	if (asprintf(&abspath, "%s/%s/", cwd, relpath) == -1)
56 		return NULL;
57 
58 	return abspath;
59 }
60 
61 /* based on canonpath() from kern_pledge.c */
62 const struct got_error *
63 got_canonpath(const char *input, char *buf, size_t bufsize)
64 {
65 	const char *p;
66 	char *q;
67 
68 	/* can't canon relative paths, don't bother */
69 	if (!got_path_is_absolute(input)) {
70 		if (strlcpy(buf, input, bufsize) >= bufsize)
71 			return got_error(GOT_ERR_NO_SPACE);
72 		return NULL;
73 	}
74 
75 	p = input;
76 	q = buf;
77 	while (*p && (q - buf < bufsize)) {
78 		if (p[0] == '/' && (p[1] == '/' || p[1] == '\0')) {
79 			p += 1;
80 
81 		} else if (p[0] == '/' && p[1] == '.' &&
82 		    (p[2] == '/' || p[2] == '\0')) {
83 			p += 2;
84 
85 		} else if (p[0] == '/' && p[1] == '.' && p[2] == '.' &&
86 		    (p[3] == '/' || p[3] == '\0')) {
87 			p += 3;
88 			if (q != buf)	/* "/../" at start of buf */
89 				while (*--q != '/')
90 					continue;
91 
92 		} else {
93 			*q++ = *p++;
94 		}
95 	}
96 	if ((*p == '\0') && (q - buf < bufsize)) {
97 		*q = 0;
98 		return NULL;
99 	} else
100 		return got_error(GOT_ERR_NO_SPACE);
101 }
102 
103 const struct got_error *
104 got_path_skip_common_ancestor(char **child, const char *parent_abspath,
105     const char *abspath)
106 {
107 	const struct got_error *err = NULL;
108 	size_t len_parent, len, bufsize;
109 
110 	*child = NULL;
111 
112 	len_parent = strlen(parent_abspath);
113 	len = strlen(abspath);
114 	if (len_parent >= len)
115 		return got_error(GOT_ERR_BAD_PATH);
116 	if (strncmp(parent_abspath, abspath, len_parent) != 0)
117 		return got_error(GOT_ERR_BAD_PATH);
118 	if (!got_path_is_root_dir(parent_abspath) && abspath[len_parent] != '/')
119 		return got_error(GOT_ERR_BAD_PATH);
120 	while (abspath[len_parent] == '/')
121 		abspath++;
122 	bufsize = len - len_parent + 1;
123 	*child = malloc(bufsize);
124 	if (*child == NULL)
125 		return got_error_from_errno("malloc");
126 	if (strlcpy(*child, abspath + len_parent, bufsize) >= bufsize) {
127 		err = got_error_from_errno("strlcpy");
128 		free(*child);
129 		*child = NULL;
130 		return err;
131 	}
132 	return NULL;
133 }
134 
135 int
136 got_path_is_root_dir(const char *path)
137 {
138 	return (path[0] == '/' && path[1] == '\0');
139 }
140 
141 int
142 got_path_is_current_dir(const char *path)
143 {
144 	return (path[0] == '.' && path[1] == '\0');
145 }
146 
147 int
148 got_path_is_child(const char *child, const char *parent, size_t parent_len)
149 {
150 	if (parent_len == 0 || got_path_is_root_dir(parent))
151 		return 1;
152 
153 	if (strncmp(parent, child, parent_len) != 0)
154 		return 0;
155 	if (child[parent_len] != '/')
156 		return 0;
157 
158 	return 1;
159 }
160 
161 int
162 got_path_cmp(const char *path1, const char *path2)
163 {
164 	size_t len1 = strlen(path1);
165 	size_t len2 = strlen(path2);
166 	size_t min_len = MIN(len1, len2);
167 	size_t i = 0;
168 
169 	/* Leading directory separators are insignificant. */
170 	while (path1[0] == '/')
171 		path1++;
172 	while (path2[0] == '/')
173 		path2++;
174 
175 	len1 = strlen(path1);
176 	len2 = strlen(path2);
177 	min_len = MIN(len1, len2);
178 
179 	/* Skip over common prefix. */
180 	while (i < min_len && path1[i] == path2[i])
181 		i++;
182 
183 	/* Are the paths exactly equal (besides path separators)? */
184 	if (len1 == len2 && i >= min_len)
185 		return 0;
186 
187 	/* Skip over redundant trailing path seperators. */
188 	while (path1[i] == '/' && path1[i + 1] == '/')
189 		path1++;
190 	while (path2[i] == '/' && path2[i + 1] == '/')
191 		path2++;
192 
193 	/* Trailing path separators are insignificant. */
194 	if (path1[i] == '/' && path1[i + 1] == '\0' && path2[i] == '\0')
195 		return 0;
196 	if (path2[i] == '/' && path2[i + 1] == '\0' && path1[i] == '\0')
197 		return 0;
198 
199 	/* Order children in subdirectories directly after their parents. */
200 	if (path1[i] == '/' && path2[i] == '\0')
201 		return 1;
202 	if (path2[i] == '/' && path1[i] == '\0')
203 		return -1;
204 	if (path1[i] == '/' && path2[i] != '\0')
205 		return -1;
206 	if (path2[i] == '/' && path1[i] != '\0')
207 		return 1;
208 
209 	/* Next character following the common prefix determines order. */
210 	return (unsigned char)path1[i] < (unsigned char)path2[i] ? -1 : 1;
211 }
212 
213 const struct got_error *
214 got_pathlist_insert(struct got_pathlist_entry **inserted,
215     struct got_pathlist_head *pathlist, const char *path, void *data)
216 {
217 	struct got_pathlist_entry *new, *pe;
218 
219 	if (inserted)
220 		*inserted = NULL;
221 
222 	new = malloc(sizeof(*new));
223 	if (new == NULL)
224 		return got_error_from_errno("malloc");
225 	new->path = path;
226 	new->data = data;
227 
228 	/*
229 	 * Many callers will provide paths in a somewhat sorted order while
230 	 * constructing a path list from inputs such as tree objects or
231 	 * dirents. Iterating backwards from the tail of the list should
232 	 * be more efficient than traversing through the entire list each
233 	 * time an element is inserted.
234 	 */
235 	pe = TAILQ_LAST(pathlist, got_pathlist_head);
236 	while (pe) {
237 		int cmp = got_path_cmp(pe->path, path);
238 		if (cmp == 0) {
239 			free(new); /* duplicate */
240 			return NULL;
241 		} else if (cmp < 0) {
242 			TAILQ_INSERT_AFTER(pathlist, pe, new, entry);
243 			if (inserted)
244 				*inserted = new;
245 			return NULL;
246 		}
247 		pe = TAILQ_PREV(pe, got_pathlist_head, entry);
248 	}
249 
250 	TAILQ_INSERT_HEAD(pathlist, new, entry);
251 	if (inserted)
252 		*inserted = new;
253 	return NULL;
254 }
255 
256 const struct got_error *
257 got_pathlist_append(struct got_pathlist_head *pathlist,
258     const char *path, void *data)
259 {
260 	struct got_pathlist_entry *new;
261 
262 	new = malloc(sizeof(*new));
263 	if (new == NULL)
264 		return got_error_from_errno("malloc");
265 	new->path = path;
266 	new->data = data;
267 	TAILQ_INSERT_TAIL(pathlist, new, entry);
268 	return NULL;
269 }
270 
271 void
272 got_pathlist_free(struct got_pathlist_head *pathlist)
273 {
274 	struct got_pathlist_entry *pe;
275 
276 	while ((pe = TAILQ_FIRST(pathlist)) != NULL) {
277 		TAILQ_REMOVE(pathlist, pe, entry);
278 		free(pe);
279 	}
280 }
281 
282 static const struct got_error *
283 make_parent_dirs(const char *abspath)
284 {
285 	const struct got_error *err = NULL;
286 	char *parent;
287 
288 	err = got_path_dirname(&parent, abspath);
289 	if (err)
290 		return err;
291 
292 	if (mkdir(parent, GOT_DEFAULT_DIR_MODE) == -1) {
293 		if (errno == ENOENT) {
294 			err = make_parent_dirs(parent);
295 			if (err)
296 				goto done;
297 			if (mkdir(parent, GOT_DEFAULT_DIR_MODE) == -1) {
298 				err = got_error_from_errno2("mkdir", parent);
299 				goto done;
300 			}
301 		} else
302 			err = got_error_from_errno2("mkdir", parent);
303 	}
304 done:
305 	free(parent);
306 	return err;
307 }
308 
309 const struct got_error *
310 got_path_mkdir(const char *abspath)
311 {
312 	const struct got_error *err = NULL;
313 
314 	if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1) {
315 		if (errno == ENOENT) {
316 			err = make_parent_dirs(abspath);
317 			if (err)
318 				goto done;
319 			if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1)
320 				err = got_error_from_errno2("mkdir", abspath);
321 		} else
322 			err = got_error_from_errno2("mkdir", abspath);
323 	}
324 
325 done:
326 	return err;
327 }
328 
329 int
330 got_path_dir_is_empty(const char *dir)
331 {
332 	DIR *d;
333 	struct dirent *dent;
334 	int empty = 1;
335 
336 	d = opendir(dir);
337 	if (d == NULL)
338 		return 1;
339 
340 	while ((dent = readdir(d)) != NULL) {
341 		if (strcmp(dent->d_name, ".") == 0 ||
342 		    strcmp(dent->d_name, "..") == 0)
343 			continue;
344 
345 		empty = 0;
346 		break;
347 	}
348 
349 	closedir(d);
350 	return empty;
351 }
352 
353 const struct got_error *
354 got_path_dirname(char **parent, const char *path)
355 {
356 	char *p;
357 
358 	p = dirname(path);
359 	if (p == NULL)
360 		return got_error_from_errno2("dirname", path);
361 
362 	if (p[0] == '.' && p[1] == '\0')
363 		return got_error(GOT_ERR_BAD_PATH);
364 
365 	*parent = strdup(p);
366 	if (*parent == NULL)
367 		return got_error_from_errno("strdup");
368 
369 	return NULL;
370 }
371 
372 const struct got_error *
373 got_path_basename(char **s, const char *path)
374 {
375 	char *base;
376 
377 	base = basename(path);
378 	if (base == NULL)
379 		return got_error_from_errno2("basename", path);
380 
381 	*s = strdup(base);
382 	if (*s == NULL)
383 		return got_error_from_errno("strdup");
384 
385 	return NULL;
386 }
387 
388 void
389 got_path_strip_trailing_slashes(char *path)
390 {
391 	int x;
392 
393 	while (path[x = strlen(path) - 1] == '/')
394 		path[x] = '\0';
395 }
396 
397 /* based on findprog() from usr.sbin/which/which.c */
398 const struct got_error *
399 got_path_find_prog(char **filename, const char *prog)
400 {
401 	char *p;
402 	int len;
403 	struct stat sbuf;
404 	char *path, *pathcpy;
405 
406 	*filename = NULL;
407 
408 	path = getenv("PATH");
409 	if (path == NULL)
410 		path = _PATH_DEFPATH;
411 
412 	/* Special case if prog contains '/' */
413 	if (strchr(prog, '/')) {
414 		if ((stat(prog, &sbuf) == 0) && S_ISREG(sbuf.st_mode) &&
415 		    access(prog, X_OK) == 0) {
416 			*filename = strdup(prog);
417 			if (*filename == NULL)
418 				return got_error_from_errno("strdup");
419 		}
420 		return NULL;
421 	}
422 
423 	if ((path = strdup(path)) == NULL)
424 		return got_error_from_errno("strdup");
425 	pathcpy = path;
426 
427 	while ((p = strsep(&pathcpy, ":")) != NULL) {
428 		if (*p == '\0')
429 			p = ".";
430 
431 		len = strlen(p);
432 		while (len > 0 && p[len-1] == '/')
433 			p[--len] = '\0';	/* strip trailing '/' */
434 
435 		if (asprintf(filename, "%s/%s", p, prog) == -1) {
436 			free(path);
437 			return got_error_from_errno("asprintf");
438 		}
439 		if ((stat(*filename, &sbuf) == 0) && S_ISREG(sbuf.st_mode) &&
440 		    access(*filename, X_OK) == 0) {
441 			free(path);
442 			return NULL;
443 		}
444 		free(*filename);
445 		*filename = NULL;
446 		continue;
447 	}
448 	free(path);
449 	return NULL;
450 }
451 
452 const struct got_error *
453 got_path_create_file(const char *path, const char *content)
454 {
455 	const struct got_error *err = NULL;
456 	int fd = -1;
457 
458 	fd = open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
459 	    GOT_DEFAULT_FILE_MODE);
460 	if (fd == -1) {
461 		err = got_error_from_errno2("open", path);
462 		goto done;
463 	}
464 
465 	if (content) {
466 		int len = dprintf(fd, "%s\n", content);
467 		if (len != strlen(content) + 1) {
468 			err = got_error_from_errno("dprintf");
469 			goto done;
470 		}
471 	}
472 
473 done:
474 	if (fd != -1 && close(fd) == -1 && err == NULL)
475 		err = got_error_from_errno("close");
476 	return err;
477 }