path.c 15.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * I'm tired of doing "vsnprintf()" etc just to open a
 * file, so here's a "return static buffer with printf"
 * interface for paths.
 *
 * It's obviously not thread-safe. Sue me. But it's quite
 * useful for doing things like
 *
 *   f = open(mkpath("%s/%s.git", base, name), O_RDONLY);
 *
 * which is what it's designed for.
 */
#include "cache.h"
14
#include "strbuf.h"
15
#include "string-list.h"
16

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
#ifndef get_st_mode_bits
/*
 * The replacement lstat(2) we use on Cygwin is incomplete and
 * may return wrong permission bits. Most of the time we do not care,
 * but the callsites of this wrapper do care.
 */
int get_st_mode_bits(const char *path, int *mode)
{
	struct stat st;
	if (lstat(path, &st) < 0)
		return -1;
	*mode = st.st_mode;
	return 0;
}
#endif

33 34
static char bad_path[] = "/bad-path/";

35 36 37 38 39 40 41
static char *get_pathname(void)
{
	static char pathname_array[4][PATH_MAX];
	static int index;
	return pathname_array[3 & ++index];
}

42 43 44 45 46 47 48 49 50 51 52
static char *cleanup_path(char *path)
{
	/* Clean it up */
	if (!memcmp(path, "./", 2)) {
		path += 2;
		while (*path == '/')
			path++;
	}
	return path;
}

53 54 55 56 57 58 59 60 61
char *mksnpath(char *buf, size_t n, const char *fmt, ...)
{
	va_list args;
	unsigned len;

	va_start(args, fmt);
	len = vsnprintf(buf, n, fmt, args);
	va_end(args);
	if (len >= n) {
62
		strlcpy(buf, bad_path, n);
63 64 65 66 67
		return buf;
	}
	return cleanup_path(buf);
}

68
static char *vsnpath(char *buf, size_t n, const char *fmt, va_list args)
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
{
	const char *git_dir = get_git_dir();
	size_t len;

	len = strlen(git_dir);
	if (n < len + 1)
		goto bad;
	memcpy(buf, git_dir, len);
	if (len && !is_dir_sep(git_dir[len-1]))
		buf[len++] = '/';
	len += vsnprintf(buf + len, n - len, fmt, args);
	if (len >= n)
		goto bad;
	return cleanup_path(buf);
bad:
84
	strlcpy(buf, bad_path, n);
85 86 87
	return buf;
}

88 89
char *git_snpath(char *buf, size_t n, const char *fmt, ...)
{
90
	char *ret;
91 92
	va_list args;
	va_start(args, fmt);
93
	ret = vsnpath(buf, n, fmt, args);
94
	va_end(args);
95
	return ret;
96 97 98 99
}

char *git_pathdup(const char *fmt, ...)
{
100
	char path[PATH_MAX], *ret;
101 102
	va_list args;
	va_start(args, fmt);
103
	ret = vsnpath(path, sizeof(path), fmt, args);
104
	va_end(args);
105
	return xstrdup(ret);
106 107
}

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
char *mkpathdup(const char *fmt, ...)
{
	char *path;
	struct strbuf sb = STRBUF_INIT;
	va_list args;

	va_start(args, fmt);
	strbuf_vaddf(&sb, fmt, args);
	va_end(args);
	path = xstrdup(cleanup_path(sb.buf));

	strbuf_release(&sb);
	return path;
}

123 124 125 126
char *mkpath(const char *fmt, ...)
{
	va_list args;
	unsigned len;
127
	char *pathname = get_pathname();
128 129 130 131 132 133 134 135 136 137 138

	va_start(args, fmt);
	len = vsnprintf(pathname, PATH_MAX, fmt, args);
	va_end(args);
	if (len >= PATH_MAX)
		return bad_path;
	return cleanup_path(pathname);
}

char *git_path(const char *fmt, ...)
{
139
	char *pathname = get_pathname();
140
	va_list args;
141
	char *ret;
142 143

	va_start(args, fmt);
144
	ret = vsnpath(pathname, PATH_MAX, fmt, args);
145
	va_end(args);
146
	return ret;
147
}
148

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
void home_config_paths(char **global, char **xdg, char *file)
{
	char *xdg_home = getenv("XDG_CONFIG_HOME");
	char *home = getenv("HOME");
	char *to_free = NULL;

	if (!home) {
		if (global)
			*global = NULL;
	} else {
		if (!xdg_home) {
			to_free = mkpathdup("%s/.config", home);
			xdg_home = to_free;
		}
		if (global)
			*global = mkpathdup("%s/.gitconfig", home);
	}

	if (!xdg_home)
		*xdg = NULL;
	else
		*xdg = mkpathdup("%s/git/%s", xdg_home, file);

	free(to_free);
}

175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
char *git_path_submodule(const char *path, const char *fmt, ...)
{
	char *pathname = get_pathname();
	struct strbuf buf = STRBUF_INIT;
	const char *git_dir;
	va_list args;
	unsigned len;

	len = strlen(path);
	if (len > PATH_MAX-100)
		return bad_path;

	strbuf_addstr(&buf, path);
	if (len && path[len-1] != '/')
		strbuf_addch(&buf, '/');
	strbuf_addstr(&buf, ".git");

192
	git_dir = read_gitfile(buf.buf);
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
	if (git_dir) {
		strbuf_reset(&buf);
		strbuf_addstr(&buf, git_dir);
	}
	strbuf_addch(&buf, '/');

	if (buf.len >= PATH_MAX)
		return bad_path;
	memcpy(pathname, buf.buf, buf.len + 1);

	strbuf_release(&buf);
	len = strlen(pathname);

	va_start(args, fmt);
	len += vsnprintf(pathname + len, PATH_MAX - len, fmt, args);
	va_end(args);
	if (len >= PATH_MAX)
		return bad_path;
	return cleanup_path(pathname);
}
213

214
int validate_headref(const char *path)
215 216 217
{
	struct stat st;
	char *buf, buffer[256];
218
	unsigned char sha1[20];
219 220
	int fd;
	ssize_t len;
221 222 223 224 225 226 227

	if (lstat(path, &st) < 0)
		return -1;

	/* Make sure it is a "refs/.." symlink */
	if (S_ISLNK(st.st_mode)) {
		len = readlink(path, buffer, sizeof(buffer)-1);
228
		if (len >= 5 && !memcmp("refs/", buffer, 5))
229 230 231 232 233 234 235 236 237 238
			return 0;
		return -1;
	}

	/*
	 * Anything else, just open it and try to see if it is a symbolic ref.
	 */
	fd = open(path, O_RDONLY);
	if (fd < 0)
		return -1;
239
	len = read_in_full(fd, buffer, sizeof(buffer)-1);
240 241 242 243 244
	close(fd);

	/*
	 * Is it a symbolic ref?
	 */
245
	if (len < 4)
246
		return -1;
247 248 249 250 251
	if (!memcmp("ref:", buffer, 4)) {
		buf = buffer + 4;
		len -= 4;
		while (len && isspace(*buf))
			buf++, len--;
252
		if (len >= 5 && !memcmp("refs/", buf, 5))
253 254 255 256 257 258 259
			return 0;
	}

	/*
	 * Is this a detached HEAD?
	 */
	if (!get_sha1_hex(buffer, sha1))
260
		return 0;
261

262 263 264
	return -1;
}

265
static struct passwd *getpw_str(const char *username, size_t len)
266
{
267
	struct passwd *pw;
268 269 270 271 272 273 274
	char *username_z = xmalloc(len + 1);
	memcpy(username_z, username, len);
	username_z[len] = '\0';
	pw = getpwnam(username_z);
	free(username_z);
	return pw;
}
275

276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
/*
 * Return a string with ~ and ~user expanded via getpw*.  If buf != NULL,
 * then it is a newly allocated string. Returns NULL on getpw failure or
 * if path is NULL.
 */
char *expand_user_path(const char *path)
{
	struct strbuf user_path = STRBUF_INIT;
	const char *first_slash = strchrnul(path, '/');
	const char *to_copy = path;

	if (path == NULL)
		goto return_null;
	if (path[0] == '~') {
		const char *username = path + 1;
		size_t username_len = first_slash - username;
292 293
		if (username_len == 0) {
			const char *home = getenv("HOME");
294 295
			if (!home)
				goto return_null;
296 297 298 299 300 301
			strbuf_add(&user_path, home, strlen(home));
		} else {
			struct passwd *pw = getpw_str(username, username_len);
			if (!pw)
				goto return_null;
			strbuf_add(&user_path, pw->pw_dir, strlen(pw->pw_dir));
302
		}
303
		to_copy = first_slash;
304
	}
305 306 307 308 309
	strbuf_add(&user_path, to_copy, strlen(to_copy));
	return strbuf_detach(&user_path, NULL);
return_null:
	strbuf_release(&user_path);
	return NULL;
310 311
}

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
/*
 * First, one directory to try is determined by the following algorithm.
 *
 * (0) If "strict" is given, the path is used as given and no DWIM is
 *     done. Otherwise:
 * (1) "~/path" to mean path under the running user's home directory;
 * (2) "~user/path" to mean path under named user's home directory;
 * (3) "relative/path" to mean cwd relative directory; or
 * (4) "/absolute/path" to mean absolute directory.
 *
 * Unless "strict" is given, we try access() for existence of "%s.git/.git",
 * "%s/.git", "%s.git", "%s" in this order.  The first one that exists is
 * what we try.
 *
 * Second, we try chdir() to that.  Upon failure, we return NULL.
 *
 * Then, we try if the current directory is a valid git repository.
 * Upon failure, we return NULL.
 *
 * If all goes well, we return the directory we used to chdir() (but
 * before ~user is expanded), avoiding getcwd() resolving symbolic
 * links.  User relative paths are also returned as they are given,
 * except DWIM suffixing.
 */
336
const char *enter_repo(const char *path, int strict)
337
{
338 339 340 341
	static char used_path[PATH_MAX];
	static char validated_path[PATH_MAX];

	if (!path)
342 343
		return NULL;

344 345
	if (!strict) {
		static const char *suffix[] = {
346
			"/.git", "", ".git/.git", ".git", NULL,
347
		};
348
		const char *gitfile;
349 350
		int len = strlen(path);
		int i;
351
		while ((1 < len) && (path[len-1] == '/'))
352
			len--;
353

354
		if (PATH_MAX <= len)
355
			return NULL;
356 357 358 359 360
		strncpy(used_path, path, len); used_path[len] = 0 ;
		strcpy(validated_path, used_path);

		if (used_path[0] == '~') {
			char *newpath = expand_user_path(used_path);
361 362
			if (!newpath || (PATH_MAX - 10 < strlen(newpath))) {
				free(newpath);
363
				return NULL;
364 365 366 367 368 369 370 371
			}
			/*
			 * Copy back into the static buffer. A pity
			 * since newpath was not bounded, but other
			 * branches of the if are limited by PATH_MAX
			 * anyway.
			 */
			strcpy(used_path, newpath); free(newpath);
372 373 374
		}
		else if (PATH_MAX - 10 < len)
			return NULL;
375
		len = strlen(used_path);
376
		for (i = 0; suffix[i]; i++) {
377
			struct stat st;
378
			strcpy(used_path + len, suffix[i]);
379 380 381
			if (!stat(used_path, &st) &&
			    (S_ISREG(st.st_mode) ||
			    (S_ISDIR(st.st_mode) && is_git_directory(used_path)))) {
382 383 384 385
				strcat(validated_path, suffix[i]);
				break;
			}
		}
386 387 388 389 390 391
		if (!suffix[i])
			return NULL;
		gitfile = read_gitfile(used_path) ;
		if (gitfile)
			strcpy(used_path, gitfile);
		if (chdir(used_path))
392
			return NULL;
393
		path = validated_path;
394
	}
395 396
	else if (chdir(path))
		return NULL;
397

398
	if (access("objects", X_OK) == 0 && access("refs", X_OK) == 0 &&
399
	    validate_headref("HEAD") == 0) {
René Scharfe's avatar
René Scharfe committed
400
		set_git_dir(".");
401
		check_repository_format();
402
		return path;
403 404 405 406
	}

	return NULL;
}
407

408
int set_shared_perm(const char *path, int mode)
409
{
410
	int tweak, shared, orig_mode;
411

412 413 414
	if (!shared_repository) {
		if (mode)
			return chmod(path, mode & ~S_IFMT);
415
		return 0;
416 417
	}
	if (!mode) {
418
		if (get_st_mode_bits(path, &mode) < 0)
419 420 421 422
			return -1;
		orig_mode = mode;
	} else
		orig_mode = 0;
423 424 425 426 427 428 429 430 431 432 433 434 435 436
	if (shared_repository < 0)
		shared = -shared_repository;
	else
		shared = shared_repository;
	tweak = shared;

	if (!(mode & S_IWUSR))
		tweak &= ~0222;
	if (mode & S_IXUSR)
		/* Copy read bits to execute bits */
		tweak |= (tweak & 0444) >> 2;
	if (shared_repository < 0)
		mode = (mode & ~0777) | tweak;
	else
437
		mode |= tweak;
438 439 440

	if (S_ISDIR(mode)) {
		/* Copy read bits to execute bits */
441 442
		mode |= (shared & 0444) >> 2;
		mode |= FORCE_DIR_SET_GID;
443 444
	}

445
	if (((shared_repository < 0
446 447 448
	      ? (orig_mode & (FORCE_DIR_SET_GID | 0777))
	      : (orig_mode & mode)) != mode) &&
	    chmod(path, (mode & ~S_IFMT)) < 0)
449 450 451
		return -2;
	return 0;
}
452

453
const char *relative_path(const char *abs, const char *base)
454 455
{
	static char buf[PATH_MAX + 1];
456 457 458
	int i = 0, j = 0;

	if (!base || !base[0])
459
		return abs;
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
	while (base[i]) {
		if (is_dir_sep(base[i])) {
			if (!is_dir_sep(abs[j]))
				return abs;
			while (is_dir_sep(base[i]))
				i++;
			while (is_dir_sep(abs[j]))
				j++;
			continue;
		} else if (abs[j] != base[i]) {
			return abs;
		}
		i++;
		j++;
	}
	if (
	    /* "/foo" is a prefix of "/foo" */
	    abs[j] &&
	    /* "/foo" is not a prefix of "/foobar" */
	    !is_dir_sep(base[i-1]) && !is_dir_sep(abs[j])
	   )
481
		return abs;
482 483 484 485 486 487
	while (is_dir_sep(abs[j]))
		j++;
	if (!abs[j])
		strcpy(buf, ".");
	else
		strcpy(buf, abs + j);
488 489
	return buf;
}
490 491

/*
492
 * It is okay if dst == src, but they should not overlap otherwise.
493
 *
494 495 496
 * Performs the following normalizations on src, storing the result in dst:
 * - Ensures that components are separated by '/' (Windows only)
 * - Squashes sequences of '/'.
497 498
 * - Removes "." components.
 * - Removes ".." components, and the components the precede them.
499 500
 * Returns failure (non-zero) if a ".." component appears as first path
 * component anytime during the normalization. Otherwise, returns success (0).
501 502 503 504
 *
 * Note that this function is purely textual.  It does not follow symlinks,
 * verify the existence of the path, or make any system calls.
 */
505
int normalize_path_copy(char *dst, const char *src)
506
{
507
	char *dst0;
508

509 510 511
	if (has_dos_drive_prefix(src)) {
		*dst++ = *src++;
		*dst++ = *src++;
512
	}
513
	dst0 = dst;
514

515
	if (is_dir_sep(*src)) {
516
		*dst++ = '/';
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
		while (is_dir_sep(*src))
			src++;
	}

	for (;;) {
		char c = *src;

		/*
		 * A path component that begins with . could be
		 * special:
		 * (1) "." and ends   -- ignore and terminate.
		 * (2) "./"           -- ignore them, eat slash and continue.
		 * (3) ".." and ends  -- strip one and terminate.
		 * (4) "../"          -- strip one, eat slash and continue.
		 */
		if (c == '.') {
			if (!src[1]) {
				/* (1) */
				src++;
			} else if (is_dir_sep(src[1])) {
				/* (2) */
				src += 2;
				while (is_dir_sep(*src))
					src++;
				continue;
			} else if (src[1] == '.') {
				if (!src[2]) {
					/* (3) */
					src += 2;
					goto up_one;
				} else if (is_dir_sep(src[2])) {
					/* (4) */
					src += 3;
					while (is_dir_sep(*src))
						src++;
					goto up_one;
				}
			}
		}
556

557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
		/* copy up to the next '/', and eat all '/' */
		while ((c = *src++) != '\0' && !is_dir_sep(c))
			*dst++ = c;
		if (is_dir_sep(c)) {
			*dst++ = '/';
			while (is_dir_sep(c))
				c = *src++;
			src--;
		} else if (!c)
			break;
		continue;

	up_one:
		/*
		 * dst0..dst is prefix portion, and dst[-1] is '/';
		 * go up one level.
		 */
574 575
		dst--;	/* go to trailing '/' */
		if (dst <= dst0)
576
			return -1;
577 578 579
		/* Windows: dst[-1] cannot be backslash anymore */
		while (dst0 < dst && dst[-1] != '/')
			dst--;
580
	}
581
	*dst = '\0';
582
	return 0;
583
}
584 585 586

/*
 * path = Canonical absolute path
587 588
 * prefixes = string_list containing normalized, absolute paths without
 * trailing slashes (except for the root directory, which is denoted by "/").
589
 *
590
 * Determines, for each path in prefixes, whether the "prefix"
591 592
 * is an ancestor directory of path.  Returns the length of the longest
 * ancestor directory, excluding any trailing slashes, or -1 if no prefix
593 594
 * is an ancestor.  (Note that this means 0 is returned if prefixes is
 * ["/"].) "/foo" is not considered an ancestor of "/foobar".  Directories
595 596
 * are not considered to be their own ancestors.  path must be in a
 * canonical form: empty components, or "." or ".." components are not
597
 * allowed.
598
 */
599
int longest_ancestor_length(const char *path, struct string_list *prefixes)
600
{
601
	int i, max_len = -1;
602

603
	if (!strcmp(path, "/"))
604 605
		return -1;

606 607
	for (i = 0; i < prefixes->nr; i++) {
		const char *ceil = prefixes->items[i].string;
608 609
		int len = strlen(ceil);

610 611 612 613 614 615
		if (len == 1 && ceil[0] == '/')
			len = 0; /* root matches anything, with length 0 */
		else if (!strncmp(path, ceil, len) && path[len] == '/')
			; /* match of length len */
		else
			continue; /* no match */
616

617
		if (len > max_len)
618 619 620 621 622
			max_len = len;
	}

	return max_len;
}
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658

/* strip arbitrary amount of directory separators at end of path */
static inline int chomp_trailing_dir_sep(const char *path, int len)
{
	while (len && is_dir_sep(path[len - 1]))
		len--;
	return len;
}

/*
 * If path ends with suffix (complete path components), returns the
 * part before suffix (sans trailing directory separators).
 * Otherwise returns NULL.
 */
char *strip_path_suffix(const char *path, const char *suffix)
{
	int path_len = strlen(path), suffix_len = strlen(suffix);

	while (suffix_len) {
		if (!path_len)
			return NULL;

		if (is_dir_sep(path[path_len - 1])) {
			if (!is_dir_sep(suffix[suffix_len - 1]))
				return NULL;
			path_len = chomp_trailing_dir_sep(path, path_len);
			suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
		}
		else if (path[--path_len] != suffix[--suffix_len])
			return NULL;
	}

	if (path_len && !is_dir_sep(path[path_len - 1]))
		return NULL;
	return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
}
659 660 661 662 663 664 665 666

int daemon_avoid_alias(const char *p)
{
	int sl, ndot;

	/*
	 * This resurrects the belts and suspenders paranoia check by HPA
	 * done in <[email protected]> thread, now enter_repo()
667
	 * does not do getcwd() based path canonicalization.
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
	 *
	 * sl becomes true immediately after seeing '/' and continues to
	 * be true as long as dots continue after that without intervening
	 * non-dot character.
	 */
	if (!p || (*p != '/' && *p != '~'))
		return -1;
	sl = 1; ndot = 0;
	p++;

	while (1) {
		char ch = *p++;
		if (sl) {
			if (ch == '.')
				ndot++;
			else if (ch == '/') {
				if (ndot < 3)
					/* reject //, /./ and /../ */
					return -1;
				ndot = 0;
			}
			else if (ch == 0) {
				if (0 < ndot && ndot < 3)
					/* reject /.$ and /..$ */
					return -1;
				return 0;
			}
			else
				sl = ndot = 0;
		}
		else if (ch == 0)
			return 0;
		else if (ch == '/') {
			sl = 1;
			ndot = 0;
		}
	}
}
706 707 708 709 710 711 712

int offset_1st_component(const char *path)
{
	if (has_dos_drive_prefix(path))
		return 2 + is_dir_sep(path[2]);
	return is_dir_sep(path[0]);
}