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

#include "cache.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;
	const char *new_branch;
	int force_new_branch;
};

static int show_only;
static int verbose;
static unsigned long expire;

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

	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 = st.st_size;
	path = xmallocz(len);
	read_in_full(fd, path, len);
	close(fd);
	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;
		strbuf_reset(&path);
		strbuf_addstr(&path, git_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 objects")),
		OPT_EXPIRY_DATE(0, "expire", &expire,
				N_("expire objects older than <time>")),
		OPT_END()
	};

	expire = ULONG_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);
	strbuf_addstr(&sb_repo,
		      git_path("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);
	write_file(sb.buf, "initializing");

	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(junk_work_tree);
	free(junk_git_dir);
	junk_work_tree = NULL;
	junk_git_dir = NULL;

done:
	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;
	const char *path, *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_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, strlen(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;
	}

	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", sha1_to_hex(wt->head_sha1));
		if (wt->is_detached)
			printf("detached\n");
		else
			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_sha1, DEFAULT_ABBREV));
		if (!wt->is_detached)
			strbuf_addf(&sb, "[%s]", shorten_unambiguous_ref(wt->head_ref, 0));
		else
			strbuf_addstr(&sb, "(detached HEAD)");
	}
	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_sha1, *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();
		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();
	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();
	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()
	};

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