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