[thirdparty/git.git] / builtin / worktree.c

#include "cache.h"
#include "config.h"
#include "builtin.h"
#include "dir.h"
#include "parse-options.h"
#include "argv-array.h"
#include "branch.h"
#include "refs.h"
#include "run-command.h"
#include "sigchain.h"
#include "refs.h"
#include "utf8.h"
#include "worktree.h"

static const char * const worktree_usage[] = {
	N_("git worktree add [<options>] <path> [<branch>]"),
	N_("git worktree list [<options>]"),
	N_("git worktree lock [<options>] <path>"),
	N_("git worktree prune [<options>]"),
	N_("git worktree unlock <path>"),
	NULL
};

struct add_opts {
	int force;
	int detach;
	int checkout;
	int keep_locked;
	const char *new_branch;
	int force_new_branch;
};

static int show_only;
static int verbose;
static timestamp_t expire;

static int prune_worktree(const char *id, struct strbuf *reason)
{
	struct stat st;
	char *path;
	int fd;
	size_t len;
	ssize_t read_result;

	if (!is_directory(git_path("worktrees/%s", id))) {
		strbuf_addf(reason, _("Removing worktrees/%s: not a valid directory"), id);
		return 1;
	}
	if (file_exists(git_path("worktrees/%s/locked", id)))
		return 0;
	if (stat(git_path("worktrees/%s/gitdir", id), &st)) {
		strbuf_addf(reason, _("Removing worktrees/%s: gitdir file does not exist"), id);
		return 1;
	}
	fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY);
	if (fd < 0) {
		strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
			    id, strerror(errno));
		return 1;
	}
	len = xsize_t(st.st_size);
	path = xmallocz(len);

	read_result = read_in_full(fd, path, len);
	if (read_result < 0) {
		strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
			    id, strerror(errno));
		close(fd);
		free(path);
		return 1;
	}
	close(fd);

	if (read_result != len) {
		strbuf_addf(reason,
			    _("Removing worktrees/%s: short read (expected %"PRIuMAX" bytes, read %"PRIuMAX")"),
			    id, (uintmax_t)len, (uintmax_t)read_result);
		free(path);
		return 1;
	}
	while (len && (path[len - 1] == '\n' || path[len - 1] == '\r'))
		len--;
	if (!len) {
		strbuf_addf(reason, _("Removing worktrees/%s: invalid gitdir file"), id);
		free(path);
		return 1;
	}
	path[len] = '\0';
	if (!file_exists(path)) {
		struct stat st_link;
		free(path);
		/*
		 * the repo is moved manually and has not been
		 * accessed since?
		 */
		if (!stat(git_path("worktrees/%s/link", id), &st_link) &&
		    st_link.st_nlink > 1)
			return 0;
		if (st.st_mtime <= expire) {
			strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id);
			return 1;
		} else {
			return 0;
		}
	}
	free(path);
	return 0;
}

static void prune_worktrees(void)
{
	struct strbuf reason = STRBUF_INIT;
	struct strbuf path = STRBUF_INIT;
	DIR *dir = opendir(git_path("worktrees"));
	struct dirent *d;
	int ret;
	if (!dir)
		return;
	while ((d = readdir(dir)) != NULL) {
		if (is_dot_or_dotdot(d->d_name))
			continue;
		strbuf_reset(&reason);
		if (!prune_worktree(d->d_name, &reason))
			continue;
		if (show_only || verbose)
			printf("%s\n", reason.buf);
		if (show_only)
			continue;
		git_path_buf(&path, "worktrees/%s", d->d_name);
		ret = remove_dir_recursively(&path, 0);
		if (ret < 0 && errno == ENOTDIR)
			ret = unlink(path.buf);
		if (ret)
			error_errno(_("failed to remove '%s'"), path.buf);
	}
	closedir(dir);
	if (!show_only)
		rmdir(git_path("worktrees"));
	strbuf_release(&reason);
	strbuf_release(&path);
}

static int prune(int ac, const char **av, const char *prefix)
{
	struct option options[] = {
		OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
		OPT__VERBOSE(&verbose, N_("report pruned working trees")),
		OPT_EXPIRY_DATE(0, "expire", &expire,
				N_("expire working trees older than <time>")),
		OPT_END()
	};

	expire = TIME_MAX;
	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	if (ac)
		usage_with_options(worktree_usage, options);
	prune_worktrees();
	return 0;
}

static char *junk_work_tree;
static char *junk_git_dir;
static int is_junk;
static pid_t junk_pid;

static void remove_junk(void)
{
	struct strbuf sb = STRBUF_INIT;
	if (!is_junk || getpid() != junk_pid)
		return;
	if (junk_git_dir) {
		strbuf_addstr(&sb, junk_git_dir);
		remove_dir_recursively(&sb, 0);
		strbuf_reset(&sb);
	}
	if (junk_work_tree) {
		strbuf_addstr(&sb, junk_work_tree);
		remove_dir_recursively(&sb, 0);
	}
	strbuf_release(&sb);
}

static void remove_junk_on_signal(int signo)
{
	remove_junk();
	sigchain_pop(signo);
	raise(signo);
}

static const char *worktree_basename(const char *path, int *olen)
{
	const char *name;
	int len;

	len = strlen(path);
	while (len && is_dir_sep(path[len - 1]))
		len--;

	for (name = path + len - 1; name > path; name--)
		if (is_dir_sep(*name)) {
			name++;
			break;
		}

	*olen = len;
	return name;
}

static int add_worktree(const char *path, const char *refname,
			const struct add_opts *opts)
{
	struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
	struct strbuf sb = STRBUF_INIT;
	const char *name;
	struct stat st;
	struct child_process cp = CHILD_PROCESS_INIT;
	struct argv_array child_env = ARGV_ARRAY_INIT;
	int counter = 0, len, ret;
	struct strbuf symref = STRBUF_INIT;
	struct commit *commit = NULL;

	if (file_exists(path) && !is_empty_dir(path))
		die(_("'%s' already exists"), path);

	/* is 'refname' a branch or commit? */
	if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
		 ref_exists(symref.buf)) { /* it's a branch */
		if (!opts->force)
			die_if_checked_out(symref.buf, 0);
	} else { /* must be a commit */
		commit = lookup_commit_reference_by_name(refname);
		if (!commit)
			die(_("invalid reference: %s"), refname);
	}

	name = worktree_basename(path, &len);
	git_path_buf(&sb_repo, "worktrees/%.*s", (int)(path + len - name), name);
	len = sb_repo.len;
	if (safe_create_leading_directories_const(sb_repo.buf))
		die_errno(_("could not create leading directories of '%s'"),
			  sb_repo.buf);
	while (!stat(sb_repo.buf, &st)) {
		counter++;
		strbuf_setlen(&sb_repo, len);
		strbuf_addf(&sb_repo, "%d", counter);
	}
	name = strrchr(sb_repo.buf, '/') + 1;

	junk_pid = getpid();
	atexit(remove_junk);
	sigchain_push_common(remove_junk_on_signal);

	if (mkdir(sb_repo.buf, 0777))
		die_errno(_("could not create directory of '%s'"), sb_repo.buf);
	junk_git_dir = xstrdup(sb_repo.buf);
	is_junk = 1;

	/*
	 * lock the incomplete repo so prune won't delete it, unlock
	 * after the preparation is over.
	 */
	strbuf_addf(&sb, "%s/locked", sb_repo.buf);
	if (!opts->keep_locked)
		write_file(sb.buf, "initializing");
	else
		write_file(sb.buf, "added with --lock");

	strbuf_addf(&sb_git, "%s/.git", path);
	if (safe_create_leading_directories_const(sb_git.buf))
		die_errno(_("could not create leading directories of '%s'"),
			  sb_git.buf);
	junk_work_tree = xstrdup(path);

	strbuf_reset(&sb);
	strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
	write_file(sb.buf, "%s", real_path(sb_git.buf));
	write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
		   real_path(get_git_common_dir()), name);
	/*
	 * This is to keep resolve_ref() happy. We need a valid HEAD
	 * or is_git_directory() will reject the directory. Any value which
	 * looks like an object ID will do since it will be immediately
	 * replaced by the symbolic-ref or update-ref invocation in the new
	 * worktree.
	 */
	strbuf_reset(&sb);
	strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
	write_file(sb.buf, "%s", sha1_to_hex(null_sha1));
	strbuf_reset(&sb);
	strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
	write_file(sb.buf, "../..");

	fprintf_ln(stderr, _("Preparing %s (identifier %s)"), path, name);

	argv_array_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
	argv_array_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
	cp.git_cmd = 1;

	if (commit)
		argv_array_pushl(&cp.args, "update-ref", "HEAD",
				 oid_to_hex(&commit->object.oid), NULL);
	else
		argv_array_pushl(&cp.args, "symbolic-ref", "HEAD",
				 symref.buf, NULL);
	cp.env = child_env.argv;
	ret = run_command(&cp);
	if (ret)
		goto done;

	if (opts->checkout) {
		cp.argv = NULL;
		argv_array_clear(&cp.args);
		argv_array_pushl(&cp.args, "reset", "--hard", NULL);
		cp.env = child_env.argv;
		ret = run_command(&cp);
		if (ret)
			goto done;
	}

	is_junk = 0;
	FREE_AND_NULL(junk_work_tree);
	FREE_AND_NULL(junk_git_dir);

done:
	if (ret || !opts->keep_locked) {
		strbuf_reset(&sb);
		strbuf_addf(&sb, "%s/locked", sb_repo.buf);
		unlink_or_warn(sb.buf);
	}
	argv_array_clear(&child_env);
	strbuf_release(&sb);
	strbuf_release(&symref);
	strbuf_release(&sb_repo);
	strbuf_release(&sb_git);
	return ret;
}

static int add(int ac, const char **av, const char *prefix)
{
	struct add_opts opts;
	const char *new_branch_force = NULL;
	char *path;
	const char *branch;
	struct option options[] = {
		OPT__FORCE(&opts.force, N_("checkout <branch> even if already checked out in other worktree")),
		OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
			   N_("create a new branch")),
		OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
			   N_("create or reset a branch")),
		OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")),
		OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
		OPT_BOOL(0, "lock", &opts.keep_locked, N_("keep the new working tree locked")),
		OPT_END()
	};

	memset(&opts, 0, sizeof(opts));
	opts.checkout = 1;
	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	if (!!opts.detach + !!opts.new_branch + !!new_branch_force > 1)
		die(_("-b, -B, and --detach are mutually exclusive"));
	if (ac < 1 || ac > 2)
		usage_with_options(worktree_usage, options);

	path = prefix_filename(prefix, av[0]);
	branch = ac < 2 ? "HEAD" : av[1];

	if (!strcmp(branch, "-"))
		branch = "@{-1}";

	opts.force_new_branch = !!new_branch_force;
	if (opts.force_new_branch) {
		struct strbuf symref = STRBUF_INIT;

		opts.new_branch = new_branch_force;

		if (!opts.force &&
		    !strbuf_check_branch_ref(&symref, opts.new_branch) &&
		    ref_exists(symref.buf))
			die_if_checked_out(symref.buf, 0);
		strbuf_release(&symref);
	}

	if (ac < 2 && !opts.new_branch && !opts.detach) {
		int n;
		const char *s = worktree_basename(path, &n);
		opts.new_branch = xstrndup(s, n);
	}

	if (opts.new_branch) {
		struct child_process cp = CHILD_PROCESS_INIT;
		cp.git_cmd = 1;
		argv_array_push(&cp.args, "branch");
		if (opts.force_new_branch)
			argv_array_push(&cp.args, "--force");
		argv_array_push(&cp.args, opts.new_branch);
		argv_array_push(&cp.args, branch);
		if (run_command(&cp))
			return -1;
		branch = opts.new_branch;
	}

	UNLEAK(path);
	UNLEAK(opts);
	return add_worktree(path, branch, &opts);
}

static void show_worktree_porcelain(struct worktree *wt)
{
	printf("worktree %s\n", wt->path);
	if (wt->is_bare)
		printf("bare\n");
	else {
		printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
		if (wt->is_detached)
			printf("detached\n");
		else if (wt->head_ref)
			printf("branch %s\n", wt->head_ref);
	}
	printf("\n");
}

static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
{
	struct strbuf sb = STRBUF_INIT;
	int cur_path_len = strlen(wt->path);
	int path_adj = cur_path_len - utf8_strwidth(wt->path);

	strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
	if (wt->is_bare)
		strbuf_addstr(&sb, "(bare)");
	else {
		strbuf_addf(&sb, "%-*s ", abbrev_len,
				find_unique_abbrev(wt->head_oid.hash, DEFAULT_ABBREV));
		if (wt->is_detached)
			strbuf_addstr(&sb, "(detached HEAD)");
		else if (wt->head_ref) {
			char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
			strbuf_addf(&sb, "[%s]", ref);
			free(ref);
		} else
			strbuf_addstr(&sb, "(error)");
	}
	printf("%s\n", sb.buf);

	strbuf_release(&sb);
}

static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
{
	int i;

	for (i = 0; wt[i]; i++) {
		int sha1_len;
		int path_len = strlen(wt[i]->path);

		if (path_len > *maxlen)
			*maxlen = path_len;
		sha1_len = strlen(find_unique_abbrev(wt[i]->head_oid.hash, *abbrev));
		if (sha1_len > *abbrev)
			*abbrev = sha1_len;
	}
}

static int list(int ac, const char **av, const char *prefix)
{
	int porcelain = 0;

	struct option options[] = {
		OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
		OPT_END()
	};

	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	if (ac)
		usage_with_options(worktree_usage, options);
	else {
		struct worktree **worktrees = get_worktrees(GWT_SORT_LINKED);
		int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;

		if (!porcelain)
			measure_widths(worktrees, &abbrev, &path_maxlen);

		for (i = 0; worktrees[i]; i++) {
			if (porcelain)
				show_worktree_porcelain(worktrees[i]);
			else
				show_worktree(worktrees[i], path_maxlen, abbrev);
		}
		free_worktrees(worktrees);
	}
	return 0;
}

static int lock_worktree(int ac, const char **av, const char *prefix)
{
	const char *reason = "", *old_reason;
	struct option options[] = {
		OPT_STRING(0, "reason", &reason, N_("string"),
			   N_("reason for locking")),
		OPT_END()
	};
	struct worktree **worktrees, *wt;

	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	if (ac != 1)
		usage_with_options(worktree_usage, options);

	worktrees = get_worktrees(0);
	wt = find_worktree(worktrees, prefix, av[0]);
	if (!wt)
		die(_("'%s' is not a working tree"), av[0]);
	if (is_main_worktree(wt))
		die(_("The main working tree cannot be locked or unlocked"));

	old_reason = is_worktree_locked(wt);
	if (old_reason) {
		if (*old_reason)
			die(_("'%s' is already locked, reason: %s"),
			    av[0], old_reason);
		die(_("'%s' is already locked"), av[0]);
	}

	write_file(git_common_path("worktrees/%s/locked", wt->id),
		   "%s", reason);
	free_worktrees(worktrees);
	return 0;
}

static int unlock_worktree(int ac, const char **av, const char *prefix)
{
	struct option options[] = {
		OPT_END()
	};
	struct worktree **worktrees, *wt;
	int ret;

	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	if (ac != 1)
		usage_with_options(worktree_usage, options);

	worktrees = get_worktrees(0);
	wt = find_worktree(worktrees, prefix, av[0]);
	if (!wt)
		die(_("'%s' is not a working tree"), av[0]);
	if (is_main_worktree(wt))
		die(_("The main working tree cannot be locked or unlocked"));
	if (!is_worktree_locked(wt))
		die(_("'%s' is not locked"), av[0]);
	ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
	free_worktrees(worktrees);
	return ret;
}

int cmd_worktree(int ac, const char **av, const char *prefix)
{
	struct option options[] = {
		OPT_END()
	};

	git_config(git_default_config, NULL);

	if (ac < 2)
		usage_with_options(worktree_usage, options);
	if (!prefix)
		prefix = "";
	if (!strcmp(av[1], "add"))
		return add(ac - 1, av + 1, prefix);
	if (!strcmp(av[1], "prune"))
		return prune(ac - 1, av + 1, prefix);
	if (!strcmp(av[1], "list"))
		return list(ac - 1, av + 1, prefix);
	if (!strcmp(av[1], "lock"))
		return lock_worktree(ac - 1, av + 1, prefix);
	if (!strcmp(av[1], "unlock"))
		return unlock_worktree(ac - 1, av + 1, prefix);
	usage_with_options(worktree_usage, options);
}
Commit	Line	Data
df0b6cfb	1	#include "cache.h"
b2141fc1	2	#include "config.h"
df0b6cfb NTND	3	#include "builtin.h"
	4	#include "dir.h"
	5	#include "parse-options.h"
fc56361f	6	#include "argv-array.h"
f7c9dac1 ES	7	#include "branch.h"
f7c9dac1 ES	8	#include "refs.h"
fc56361f	9	#include "run-command.h"
b979d950	10	#include "sigchain.h"
799767cc	11	#include "refs.h"
bb9c03b8 MR	12	#include "utf8.h"
bb9c03b8 MR	13	#include "worktree.h"
df0b6cfb NTND	14
df0b6cfb NTND	15	static const char * const worktree_usage[] = {
ae9f2745	16	N_("git worktree add [<options>] <path> [<branch>]"),
bb9c03b8	17	N_("git worktree list [<options>]"),
58142c09	18	N_("git worktree lock [<options>] <path>"),
7b722d90	19	N_("git worktree prune [<options>]"),
6d308627	20	N_("git worktree unlock <path>"),
df0b6cfb NTND	21	NULL
	22	};
	23
5dd6e234 ES	24	struct add_opts {
	25	int force;
	26	int detach;
ef2a0ac9	27	int checkout;
507e6e9e	28	int keep_locked;
5dd6e234 ES	29	const char *new_branch;
	30	int force_new_branch;
	31	};
	32
df0b6cfb NTND	33	static int show_only;
df0b6cfb NTND	34	static int verbose;
dddbad72	35	static timestamp_t expire;
df0b6cfb NTND	36
	37	static int prune_worktree(const char id, struct strbuf reason)
	38	{
	39	struct stat st;
	40	char *path;
228740b6 JK	41	int fd;
228740b6 JK	42	size_t len;
8a1a8d2a	43	ssize_t read_result;
df0b6cfb NTND	44
	45	if (!is_directory(git_path("worktrees/%s", id))) {
	46	strbuf_addf(reason, _("Removing worktrees/%s: not a valid directory"), id);
	47	return 1;
	48	}
	49	if (file_exists(git_path("worktrees/%s/locked", id)))
	50	return 0;
	51	if (stat(git_path("worktrees/%s/gitdir", id), &st)) {
	52	strbuf_addf(reason, _("Removing worktrees/%s: gitdir file does not exist"), id);
	53	return 1;
	54	}
	55	fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY);
	56	if (fd < 0) {
	57	strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
	58	id, strerror(errno));
	59	return 1;
	60	}
228740b6	61	len = xsize_t(st.st_size);
3733e694	62	path = xmallocz(len);
8a1a8d2a JK	63
	64	read_result = read_in_full(fd, path, len);
	65	if (read_result < 0) {
	66	strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
	67	id, strerror(errno));
	68	close(fd);
	69	free(path);
	70	return 1;
	71	}
df0b6cfb	72	close(fd);
8a1a8d2a JK	73
	74	if (read_result != len) {
	75	strbuf_addf(reason,
	76	_("Removing worktrees/%s: short read (expected %"PRIuMAX" bytes, read %"PRIuMAX")"),
	77	id, (uintmax_t)len, (uintmax_t)read_result);
	78	free(path);
	79	return 1;
	80	}
df0b6cfb NTND	81	while (len && (path[len - 1] == '\n' \|\| path[len - 1] == '\r'))
	82	len--;
	83	if (!len) {
	84	strbuf_addf(reason, _("Removing worktrees/%s: invalid gitdir file"), id);
	85	free(path);
	86	return 1;
	87	}
	88	path[len] = '\0';
	89	if (!file_exists(path)) {
	90	struct stat st_link;
	91	free(path);
	92	/*
	93	* the repo is moved manually and has not been
	94	* accessed since?
	95	*/
	96	if (!stat(git_path("worktrees/%s/link", id), &st_link) &&
	97	st_link.st_nlink > 1)
	98	return 0;
	99	if (st.st_mtime <= expire) {
	100	strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id);
	101	return 1;
	102	} else {
	103	return 0;
	104	}
	105	}
	106	free(path);
	107	return 0;
	108	}
	109
	110	static void prune_worktrees(void)
	111	{
	112	struct strbuf reason = STRBUF_INIT;
	113	struct strbuf path = STRBUF_INIT;
	114	DIR *dir = opendir(git_path("worktrees"));
	115	struct dirent *d;
	116	int ret;
	117	if (!dir)
	118	return;
	119	while ((d = readdir(dir)) != NULL) {
afb9e30b	120	if (is_dot_or_dotdot(d->d_name))
df0b6cfb NTND	121	continue;
	122	strbuf_reset(&reason);
	123	if (!prune_worktree(d->d_name, &reason))
	124	continue;
	125	if (show_only \|\| verbose)
	126	printf("%s\n", reason.buf);
	127	if (show_only)
	128	continue;
8c2ca3a6	129	git_path_buf(&path, "worktrees/%s", d->d_name);
df0b6cfb NTND	130	ret = remove_dir_recursively(&path, 0);
	131	if (ret < 0 && errno == ENOTDIR)
	132	ret = unlink(path.buf);
	133	if (ret)
8d19e930	134	error_errno(_("failed to remove '%s'"), path.buf);
df0b6cfb NTND	135	}
	136	closedir(dir);
	137	if (!show_only)
	138	rmdir(git_path("worktrees"));
	139	strbuf_release(&reason);
	140	strbuf_release(&path);
	141	}
	142
	143	static int prune(int ac, const char *av, const char prefix)
	144	{
	145	struct option options[] = {
	146	OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
2488dcab	147	OPT__VERBOSE(&verbose, N_("report pruned working trees")),
df0b6cfb	148	OPT_EXPIRY_DATE(0, "expire", &expire,
2488dcab	149	N_("expire working trees older than <time>")),
df0b6cfb NTND	150	OPT_END()
	151	};
	152
dddbad72	153	expire = TIME_MAX;
df0b6cfb NTND	154	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	155	if (ac)
	156	usage_with_options(worktree_usage, options);
	157	prune_worktrees();
	158	return 0;
	159	}
	160
b979d950 ES	161	static char *junk_work_tree;
	162	static char *junk_git_dir;
	163	static int is_junk;
	164	static pid_t junk_pid;
	165
	166	static void remove_junk(void)
	167	{
	168	struct strbuf sb = STRBUF_INIT;
	169	if (!is_junk \|\| getpid() != junk_pid)
	170	return;
	171	if (junk_git_dir) {
	172	strbuf_addstr(&sb, junk_git_dir);
	173	remove_dir_recursively(&sb, 0);
	174	strbuf_reset(&sb);
	175	}
	176	if (junk_work_tree) {
	177	strbuf_addstr(&sb, junk_work_tree);
	178	remove_dir_recursively(&sb, 0);
	179	}
	180	strbuf_release(&sb);
	181	}
	182
	183	static void remove_junk_on_signal(int signo)
	184	{
	185	remove_junk();
	186	sigchain_pop(signo);
	187	raise(signo);
	188	}
	189
f5682b2a ES	190	static const char worktree_basename(const char path, int *olen)
	191	{
	192	const char *name;
	193	int len;
	194
	195	len = strlen(path);
	196	while (len && is_dir_sep(path[len - 1]))
	197	len--;
	198
	199	for (name = path + len - 1; name > path; name--)
	200	if (is_dir_sep(*name)) {
	201	name++;
	202	break;
	203	}
	204
	205	*olen = len;
	206	return name;
	207	}
	208
80a0548f	209	static int add_worktree(const char path, const char refname,
5dd6e234	210	const struct add_opts *opts)
b979d950 ES	211	{
	212	struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
	213	struct strbuf sb = STRBUF_INIT;
	214	const char *name;
	215	struct stat st;
542aa25d	216	struct child_process cp = CHILD_PROCESS_INIT;
ae2a3827	217	struct argv_array child_env = ARGV_ARRAY_INIT;
b979d950	218	int counter = 0, len, ret;
f7c9dac1 ES	219	struct strbuf symref = STRBUF_INIT;
f7c9dac1 ES	220	struct commit *commit = NULL;
b979d950 ES	221
	222	if (file_exists(path) && !is_empty_dir(path))
	223	die(_("'%s' already exists"), path);
	224
f7c9dac1	225	/* is 'refname' a branch or commit? */
0ebf4a2a	226	if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
f7c9dac1 ES	227	ref_exists(symref.buf)) { /* it's a branch */
f7c9dac1 ES	228	if (!opts->force)
8d9fdd70	229	die_if_checked_out(symref.buf, 0);
f7c9dac1 ES	230	} else { /* must be a commit */
	231	commit = lookup_commit_reference_by_name(refname);
	232	if (!commit)
	233	die(_("invalid reference: %s"), refname);
	234	}
	235
f5682b2a	236	name = worktree_basename(path, &len);
8c2ca3a6	237	git_path_buf(&sb_repo, "worktrees/%.*s", (int)(path + len - name), name);
b979d950 ES	238	len = sb_repo.len;
	239	if (safe_create_leading_directories_const(sb_repo.buf))
	240	die_errno(_("could not create leading directories of '%s'"),
	241	sb_repo.buf);
	242	while (!stat(sb_repo.buf, &st)) {
	243	counter++;
	244	strbuf_setlen(&sb_repo, len);
	245	strbuf_addf(&sb_repo, "%d", counter);
	246	}
	247	name = strrchr(sb_repo.buf, '/') + 1;
	248
	249	junk_pid = getpid();
	250	atexit(remove_junk);
	251	sigchain_push_common(remove_junk_on_signal);
	252
	253	if (mkdir(sb_repo.buf, 0777))
	254	die_errno(_("could not create directory of '%s'"), sb_repo.buf);
	255	junk_git_dir = xstrdup(sb_repo.buf);
	256	is_junk = 1;
	257
	258	/*
	259	* lock the incomplete repo so prune won't delete it, unlock
	260	* after the preparation is over.
	261	*/
	262	strbuf_addf(&sb, "%s/locked", sb_repo.buf);
507e6e9e NTND	263	if (!opts->keep_locked)
	264	write_file(sb.buf, "initializing");
	265	else
	266	write_file(sb.buf, "added with --lock");
b979d950 ES	267
	268	strbuf_addf(&sb_git, "%s/.git", path);
	269	if (safe_create_leading_directories_const(sb_git.buf))
	270	die_errno(_("could not create leading directories of '%s'"),
	271	sb_git.buf);
	272	junk_work_tree = xstrdup(path);
	273
	274	strbuf_reset(&sb);
	275	strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
1f76a10b JH	276	write_file(sb.buf, "%s", real_path(sb_git.buf));
1f76a10b JH	277	write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
b979d950 ES	278	real_path(get_git_common_dir()), name);
	279	/*
	280	* This is to keep resolve_ref() happy. We need a valid HEAD
ed197a6a ES	281	* or is_git_directory() will reject the directory. Any value which
	282	* looks like an object ID will do since it will be immediately
	283	* replaced by the symbolic-ref or update-ref invocation in the new
	284	* worktree.
b979d950	285	*/
b979d950 ES	286	strbuf_reset(&sb);
b979d950 ES	287	strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
dabd35f4	288	write_file(sb.buf, "%s", sha1_to_hex(null_sha1));
b979d950 ES	289	strbuf_reset(&sb);
b979d950 ES	290	strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
1f76a10b	291	write_file(sb.buf, "../..");
b979d950	292
cd2f4713	293	fprintf_ln(stderr, _("Preparing %s (identifier %s)"), path, name);
b979d950	294
ae2a3827 ES	295	argv_array_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
ae2a3827 ES	296	argv_array_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
b979d950	297	cp.git_cmd = 1;
7f44e3d1 ES	298
	299	if (commit)
	300	argv_array_pushl(&cp.args, "update-ref", "HEAD",
f2fd0760	301	oid_to_hex(&commit->object.oid), NULL);
7f44e3d1 ES	302	else
	303	argv_array_pushl(&cp.args, "symbolic-ref", "HEAD",
	304	symref.buf, NULL);
	305	cp.env = child_env.argv;
	306	ret = run_command(&cp);
	307	if (ret)
	308	goto done;
	309
ef2a0ac9 RZ	310	if (opts->checkout) {
	311	cp.argv = NULL;
	312	argv_array_clear(&cp.args);
	313	argv_array_pushl(&cp.args, "reset", "--hard", NULL);
	314	cp.env = child_env.argv;
	315	ret = run_command(&cp);
	316	if (ret)
	317	goto done;
b979d950	318	}
ef2a0ac9 RZ	319
ef2a0ac9 RZ	320	is_junk = 0;
88ce3ef6 ÆAB	321	FREE_AND_NULL(junk_work_tree);
88ce3ef6 ÆAB	322	FREE_AND_NULL(junk_git_dir);
ef2a0ac9	323
7f44e3d1	324	done:
507e6e9e NTND	325	if (ret \|\| !opts->keep_locked) {
	326	strbuf_reset(&sb);
	327	strbuf_addf(&sb, "%s/locked", sb_repo.buf);
	328	unlink_or_warn(sb.buf);
	329	}
ae2a3827	330	argv_array_clear(&child_env);
b979d950	331	strbuf_release(&sb);
f7c9dac1	332	strbuf_release(&symref);
b979d950 ES	333	strbuf_release(&sb_repo);
	334	strbuf_release(&sb_git);
	335	return ret;
	336	}
	337
fc56361f ES	338	static int add(int ac, const char *av, const char prefix)
fc56361f ES	339	{
5dd6e234 ES	340	struct add_opts opts;
5dd6e234 ES	341	const char *new_branch_force = NULL;
e4da43b1 JK	342	char *path;
e4da43b1 JK	343	const char *branch;
fc56361f	344	struct option options[] = {
5dd6e234 ES	345	OPT__FORCE(&opts.force, N_("checkout <branch> even if already checked out in other worktree")),
5dd6e234 ES	346	OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
cbdf60fa ES	347	N_("create a new branch")),
	348	OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
	349	N_("create or reset a branch")),
5dd6e234	350	OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")),
ef2a0ac9	351	OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
507e6e9e	352	OPT_BOOL(0, "lock", &opts.keep_locked, N_("keep the new working tree locked")),
fc56361f ES	353	OPT_END()
	354	};
	355
5dd6e234	356	memset(&opts, 0, sizeof(opts));
ef2a0ac9	357	opts.checkout = 1;
fc56361f	358	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
ab0b2c53 ES	359	if (!!opts.detach + !!opts.new_branch + !!new_branch_force > 1)
ab0b2c53 ES	360	die(_("-b, -B, and --detach are mutually exclusive"));
0f4af3b9 ES	361	if (ac < 1 \|\| ac > 2)
0f4af3b9 ES	362	usage_with_options(worktree_usage, options);
fc56361f	363
116fb64e	364	path = prefix_filename(prefix, av[0]);
0f4af3b9	365	branch = ac < 2 ? "HEAD" : av[1];
fc56361f	366
1a450e2f JDG	367	if (!strcmp(branch, "-"))
	368	branch = "@{-1}";
	369
5dd6e234	370	opts.force_new_branch = !!new_branch_force;
beb6f24b NTND	371	if (opts.force_new_branch) {
	372	struct strbuf symref = STRBUF_INIT;
	373
5dd6e234	374	opts.new_branch = new_branch_force;
eef005dc	375
beb6f24b NTND	376	if (!opts.force &&
	377	!strbuf_check_branch_ref(&symref, opts.new_branch) &&
	378	ref_exists(symref.buf))
8d9fdd70	379	die_if_checked_out(symref.buf, 0);
beb6f24b NTND	380	strbuf_release(&symref);
	381	}
	382
5c942570	383	if (ac < 2 && !opts.new_branch && !opts.detach) {
1eb07d82 ES	384	int n;
1eb07d82 ES	385	const char *s = worktree_basename(path, &n);
5dd6e234	386	opts.new_branch = xstrndup(s, n);
1eb07d82 ES	387	}
1eb07d82 ES	388
c2842439	389	if (opts.new_branch) {
542aa25d	390	struct child_process cp = CHILD_PROCESS_INIT;
c2842439 ES	391	cp.git_cmd = 1;
	392	argv_array_push(&cp.args, "branch");
	393	if (opts.force_new_branch)
	394	argv_array_push(&cp.args, "--force");
	395	argv_array_push(&cp.args, opts.new_branch);
	396	argv_array_push(&cp.args, branch);
	397	if (run_command(&cp))
	398	return -1;
	399	branch = opts.new_branch;
1eb07d82 ES	400	}
1eb07d82 ES	401
0e5bba53 JK	402	UNLEAK(path);
0e5bba53 JK	403	UNLEAK(opts);
80a0548f	404	return add_worktree(path, branch, &opts);
fc56361f ES	405	}
fc56361f ES	406
bb9c03b8 MR	407	static void show_worktree_porcelain(struct worktree *wt)
	408	{
	409	printf("worktree %s\n", wt->path);
	410	if (wt->is_bare)
	411	printf("bare\n");
	412	else {
0f05154c	413	printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
bb9c03b8 MR	414	if (wt->is_detached)
bb9c03b8 MR	415	printf("detached\n");
a234563a	416	else if (wt->head_ref)
bb9c03b8 MR	417	printf("branch %s\n", wt->head_ref);
	418	}
	419	printf("\n");
	420	}
	421
	422	static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
	423	{
	424	struct strbuf sb = STRBUF_INIT;
	425	int cur_path_len = strlen(wt->path);
	426	int path_adj = cur_path_len - utf8_strwidth(wt->path);
	427
	428	strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
	429	if (wt->is_bare)
	430	strbuf_addstr(&sb, "(bare)");
	431	else {
	432	strbuf_addf(&sb, "%-*s ", abbrev_len,
0f05154c	433	find_unique_abbrev(wt->head_oid.hash, DEFAULT_ABBREV));
96f09e2a	434	if (wt->is_detached)
bb9c03b8	435	strbuf_addstr(&sb, "(detached HEAD)");
2e11f58f JS	436	else if (wt->head_ref) {
	437	char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
	438	strbuf_addf(&sb, "[%s]", ref);
	439	free(ref);
	440	} else
a234563a	441	strbuf_addstr(&sb, "(error)");
bb9c03b8 MR	442	}
	443	printf("%s\n", sb.buf);
	444
	445	strbuf_release(&sb);
	446	}
	447
	448	static void measure_widths(struct worktree *wt, int abbrev, int *maxlen)
	449	{
	450	int i;
	451
	452	for (i = 0; wt[i]; i++) {
	453	int sha1_len;
	454	int path_len = strlen(wt[i]->path);
	455
	456	if (path_len > *maxlen)
	457	*maxlen = path_len;
0f05154c	458	sha1_len = strlen(find_unique_abbrev(wt[i]->head_oid.hash, *abbrev));
bb9c03b8 MR	459	if (sha1_len > *abbrev)
	460	*abbrev = sha1_len;
	461	}
	462	}
	463
	464	static int list(int ac, const char *av, const char prefix)
	465	{
	466	int porcelain = 0;
	467
	468	struct option options[] = {
	469	OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
	470	OPT_END()
	471	};
	472
	473	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	474	if (ac)
	475	usage_with_options(worktree_usage, options);
	476	else {
4df1d4d4	477	struct worktree **worktrees = get_worktrees(GWT_SORT_LINKED);
bb9c03b8 MR	478	int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
	479
	480	if (!porcelain)
	481	measure_widths(worktrees, &abbrev, &path_maxlen);
	482
	483	for (i = 0; worktrees[i]; i++) {
	484	if (porcelain)
	485	show_worktree_porcelain(worktrees[i]);
	486	else
	487	show_worktree(worktrees[i], path_maxlen, abbrev);
	488	}
	489	free_worktrees(worktrees);
	490	}
	491	return 0;
	492	}
	493
58142c09 NTND	494	static int lock_worktree(int ac, const char *av, const char prefix)
	495	{
	496	const char reason = "", old_reason;
	497	struct option options[] = {
	498	OPT_STRING(0, "reason", &reason, N_("string"),
	499	N_("reason for locking")),
	500	OPT_END()
	501	};
	502	struct worktree *worktrees, wt;
	503
	504	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	505	if (ac != 1)
	506	usage_with_options(worktree_usage, options);
	507
4fff1ef7	508	worktrees = get_worktrees(0);
58142c09 NTND	509	wt = find_worktree(worktrees, prefix, av[0]);
	510	if (!wt)
	511	die(_("'%s' is not a working tree"), av[0]);
	512	if (is_main_worktree(wt))
	513	die(_("The main working tree cannot be locked or unlocked"));
	514
	515	old_reason = is_worktree_locked(wt);
	516	if (old_reason) {
	517	if (*old_reason)
	518	die(_("'%s' is already locked, reason: %s"),
	519	av[0], old_reason);
	520	die(_("'%s' is already locked"), av[0]);
	521	}
	522
	523	write_file(git_common_path("worktrees/%s/locked", wt->id),
	524	"%s", reason);
	525	free_worktrees(worktrees);
	526	return 0;
	527	}
	528
6d308627 NTND	529	static int unlock_worktree(int ac, const char *av, const char prefix)
	530	{
	531	struct option options[] = {
	532	OPT_END()
	533	};
	534	struct worktree *worktrees, wt;
	535	int ret;
	536
	537	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
	538	if (ac != 1)
	539	usage_with_options(worktree_usage, options);
	540
4fff1ef7	541	worktrees = get_worktrees(0);
6d308627 NTND	542	wt = find_worktree(worktrees, prefix, av[0]);
	543	if (!wt)
	544	die(_("'%s' is not a working tree"), av[0]);
	545	if (is_main_worktree(wt))
	546	die(_("The main working tree cannot be locked or unlocked"));
	547	if (!is_worktree_locked(wt))
	548	die(_("'%s' is not locked"), av[0]);
	549	ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
	550	free_worktrees(worktrees);
	551	return ret;
	552	}
	553
df0b6cfb NTND	554	int cmd_worktree(int ac, const char *av, const char prefix)
	555	{
	556	struct option options[] = {
	557	OPT_END()
	558	};
	559
d49028e6 JH	560	git_config(git_default_config, NULL);
d49028e6 JH	561
df0b6cfb NTND	562	if (ac < 2)
df0b6cfb NTND	563	usage_with_options(worktree_usage, options);
0409e0b6 NTND	564	if (!prefix)
0409e0b6 NTND	565	prefix = "";
fc56361f ES	566	if (!strcmp(av[1], "add"))
fc56361f ES	567	return add(ac - 1, av + 1, prefix);
df0b6cfb NTND	568	if (!strcmp(av[1], "prune"))
df0b6cfb NTND	569	return prune(ac - 1, av + 1, prefix);
bb9c03b8 MR	570	if (!strcmp(av[1], "list"))
bb9c03b8 MR	571	return list(ac - 1, av + 1, prefix);
58142c09 NTND	572	if (!strcmp(av[1], "lock"))
58142c09 NTND	573	return lock_worktree(ac - 1, av + 1, prefix);
6d308627 NTND	574	if (!strcmp(av[1], "unlock"))
6d308627 NTND	575	return unlock_worktree(ac - 1, av + 1, prefix);
df0b6cfb NTND	576	usage_with_options(worktree_usage, options);
df0b6cfb NTND	577	}