worktree: move subcommand
[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 move [<options>] <oldpath> <newpath>"),
19         N_("git worktree prune [<options>]"),
20         N_("git worktree unlock <path>"),
21         NULL
22 };
23
24 struct add_opts {
25         int force;
26         int detach;
27         int checkout;
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                 strbuf_reset(&path);
111                 strbuf_addstr(&path, git_path("worktrees/%s", d->d_name));
112                 ret = remove_dir_recursively(&path, 0);
113                 if (ret < 0 && errno == ENOTDIR)
114                         ret = unlink(path.buf);
115                 if (ret)
116                         error_errno(_("failed to remove '%s'"), path.buf);
117         }
118         closedir(dir);
119         if (!show_only)
120                 rmdir(git_path("worktrees"));
121         strbuf_release(&reason);
122         strbuf_release(&path);
123 }
124
125 static int prune(int ac, const char **av, const char *prefix)
126 {
127         struct option options[] = {
128                 OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
129                 OPT__VERBOSE(&verbose, N_("report pruned working trees")),
130                 OPT_EXPIRY_DATE(0, "expire", &expire,
131                                 N_("expire working trees older than <time>")),
132                 OPT_END()
133         };
134
135         expire = ULONG_MAX;
136         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
137         if (ac)
138                 usage_with_options(worktree_usage, options);
139         prune_worktrees();
140         return 0;
141 }
142
143 static char *junk_work_tree;
144 static char *junk_git_dir;
145 static int is_junk;
146 static pid_t junk_pid;
147
148 static void remove_junk(void)
149 {
150         struct strbuf sb = STRBUF_INIT;
151         if (!is_junk || getpid() != junk_pid)
152                 return;
153         if (junk_git_dir) {
154                 strbuf_addstr(&sb, junk_git_dir);
155                 remove_dir_recursively(&sb, 0);
156                 strbuf_reset(&sb);
157         }
158         if (junk_work_tree) {
159                 strbuf_addstr(&sb, junk_work_tree);
160                 remove_dir_recursively(&sb, 0);
161         }
162         strbuf_release(&sb);
163 }
164
165 static void remove_junk_on_signal(int signo)
166 {
167         remove_junk();
168         sigchain_pop(signo);
169         raise(signo);
170 }
171
172 static const char *worktree_basename(const char *path, int *olen)
173 {
174         const char *name;
175         int len;
176
177         len = strlen(path);
178         while (len && is_dir_sep(path[len - 1]))
179                 len--;
180
181         for (name = path + len - 1; name > path; name--)
182                 if (is_dir_sep(*name)) {
183                         name++;
184                         break;
185                 }
186
187         *olen = len;
188         return name;
189 }
190
191 static int add_worktree(const char *path, const char *refname,
192                         const struct add_opts *opts)
193 {
194         struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
195         struct strbuf sb = STRBUF_INIT;
196         const char *name;
197         struct stat st;
198         struct child_process cp = CHILD_PROCESS_INIT;
199         struct argv_array child_env = ARGV_ARRAY_INIT;
200         int counter = 0, len, ret;
201         struct strbuf symref = STRBUF_INIT;
202         struct commit *commit = NULL;
203
204         if (file_exists(path) && !is_empty_dir(path))
205                 die(_("'%s' already exists"), path);
206
207         /* is 'refname' a branch or commit? */
208         if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
209                  ref_exists(symref.buf)) { /* it's a branch */
210                 if (!opts->force)
211                         die_if_checked_out(symref.buf, 0);
212         } else { /* must be a commit */
213                 commit = lookup_commit_reference_by_name(refname);
214                 if (!commit)
215                         die(_("invalid reference: %s"), refname);
216         }
217
218         name = worktree_basename(path, &len);
219         strbuf_addstr(&sb_repo,
220                       git_path("worktrees/%.*s", (int)(path + len - name), name));
221         len = sb_repo.len;
222         if (safe_create_leading_directories_const(sb_repo.buf))
223                 die_errno(_("could not create leading directories of '%s'"),
224                           sb_repo.buf);
225         while (!stat(sb_repo.buf, &st)) {
226                 counter++;
227                 strbuf_setlen(&sb_repo, len);
228                 strbuf_addf(&sb_repo, "%d", counter);
229         }
230         name = strrchr(sb_repo.buf, '/') + 1;
231
232         junk_pid = getpid();
233         atexit(remove_junk);
234         sigchain_push_common(remove_junk_on_signal);
235
236         if (mkdir(sb_repo.buf, 0777))
237                 die_errno(_("could not create directory of '%s'"), sb_repo.buf);
238         junk_git_dir = xstrdup(sb_repo.buf);
239         is_junk = 1;
240
241         /*
242          * lock the incomplete repo so prune won't delete it, unlock
243          * after the preparation is over.
244          */
245         strbuf_addf(&sb, "%s/locked", sb_repo.buf);
246         write_file(sb.buf, "initializing");
247
248         strbuf_addf(&sb_git, "%s/.git", path);
249         if (safe_create_leading_directories_const(sb_git.buf))
250                 die_errno(_("could not create leading directories of '%s'"),
251                           sb_git.buf);
252         junk_work_tree = xstrdup(path);
253
254         strbuf_reset(&sb);
255         strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
256         write_file(sb.buf, "%s", real_path(sb_git.buf));
257         write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
258                    real_path(get_git_common_dir()), name);
259         /*
260          * This is to keep resolve_ref() happy. We need a valid HEAD
261          * or is_git_directory() will reject the directory. Any value which
262          * looks like an object ID will do since it will be immediately
263          * replaced by the symbolic-ref or update-ref invocation in the new
264          * worktree.
265          */
266         strbuf_reset(&sb);
267         strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
268         write_file(sb.buf, "%s", sha1_to_hex(null_sha1));
269         strbuf_reset(&sb);
270         strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
271         write_file(sb.buf, "../..");
272
273         fprintf_ln(stderr, _("Preparing %s (identifier %s)"), path, name);
274
275         argv_array_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
276         argv_array_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
277         cp.git_cmd = 1;
278
279         if (commit)
280                 argv_array_pushl(&cp.args, "update-ref", "HEAD",
281                                  oid_to_hex(&commit->object.oid), NULL);
282         else
283                 argv_array_pushl(&cp.args, "symbolic-ref", "HEAD",
284                                  symref.buf, NULL);
285         cp.env = child_env.argv;
286         ret = run_command(&cp);
287         if (ret)
288                 goto done;
289
290         if (opts->checkout) {
291                 cp.argv = NULL;
292                 argv_array_clear(&cp.args);
293                 argv_array_pushl(&cp.args, "reset", "--hard", NULL);
294                 cp.env = child_env.argv;
295                 ret = run_command(&cp);
296                 if (ret)
297                         goto done;
298         }
299
300         is_junk = 0;
301         free(junk_work_tree);
302         free(junk_git_dir);
303         junk_work_tree = NULL;
304         junk_git_dir = NULL;
305
306 done:
307         strbuf_reset(&sb);
308         strbuf_addf(&sb, "%s/locked", sb_repo.buf);
309         unlink_or_warn(sb.buf);
310         argv_array_clear(&child_env);
311         strbuf_release(&sb);
312         strbuf_release(&symref);
313         strbuf_release(&sb_repo);
314         strbuf_release(&sb_git);
315         return ret;
316 }
317
318 static int add(int ac, const char **av, const char *prefix)
319 {
320         struct add_opts opts;
321         const char *new_branch_force = NULL;
322         char *path;
323         const char *branch;
324         struct option options[] = {
325                 OPT__FORCE(&opts.force, N_("checkout <branch> even if already checked out in other worktree")),
326                 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
327                            N_("create a new branch")),
328                 OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
329                            N_("create or reset a branch")),
330                 OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")),
331                 OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
332                 OPT_END()
333         };
334
335         memset(&opts, 0, sizeof(opts));
336         opts.checkout = 1;
337         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
338         if (!!opts.detach + !!opts.new_branch + !!new_branch_force > 1)
339                 die(_("-b, -B, and --detach are mutually exclusive"));
340         if (ac < 1 || ac > 2)
341                 usage_with_options(worktree_usage, options);
342
343         path = prefix_filename(prefix, av[0]);
344         branch = ac < 2 ? "HEAD" : av[1];
345
346         if (!strcmp(branch, "-"))
347                 branch = "@{-1}";
348
349         opts.force_new_branch = !!new_branch_force;
350         if (opts.force_new_branch) {
351                 struct strbuf symref = STRBUF_INIT;
352
353                 opts.new_branch = new_branch_force;
354
355                 if (!opts.force &&
356                     !strbuf_check_branch_ref(&symref, opts.new_branch) &&
357                     ref_exists(symref.buf))
358                         die_if_checked_out(symref.buf, 0);
359                 strbuf_release(&symref);
360         }
361
362         if (ac < 2 && !opts.new_branch && !opts.detach) {
363                 int n;
364                 const char *s = worktree_basename(path, &n);
365                 opts.new_branch = xstrndup(s, n);
366         }
367
368         if (opts.new_branch) {
369                 struct child_process cp = CHILD_PROCESS_INIT;
370                 cp.git_cmd = 1;
371                 argv_array_push(&cp.args, "branch");
372                 if (opts.force_new_branch)
373                         argv_array_push(&cp.args, "--force");
374                 argv_array_push(&cp.args, opts.new_branch);
375                 argv_array_push(&cp.args, branch);
376                 if (run_command(&cp))
377                         return -1;
378                 branch = opts.new_branch;
379         }
380
381         return add_worktree(path, branch, &opts);
382 }
383
384 static void show_worktree_porcelain(struct worktree *wt)
385 {
386         printf("worktree %s\n", wt->path);
387         if (wt->is_bare)
388                 printf("bare\n");
389         else {
390                 printf("HEAD %s\n", sha1_to_hex(wt->head_sha1));
391                 if (wt->is_detached)
392                         printf("detached\n");
393                 else if (wt->head_ref)
394                         printf("branch %s\n", wt->head_ref);
395         }
396         printf("\n");
397 }
398
399 static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
400 {
401         struct strbuf sb = STRBUF_INIT;
402         int cur_path_len = strlen(wt->path);
403         int path_adj = cur_path_len - utf8_strwidth(wt->path);
404
405         strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
406         if (wt->is_bare)
407                 strbuf_addstr(&sb, "(bare)");
408         else {
409                 strbuf_addf(&sb, "%-*s ", abbrev_len,
410                                 find_unique_abbrev(wt->head_sha1, DEFAULT_ABBREV));
411                 if (wt->is_detached)
412                         strbuf_addstr(&sb, "(detached HEAD)");
413                 else if (wt->head_ref)
414                         strbuf_addf(&sb, "[%s]", shorten_unambiguous_ref(wt->head_ref, 0));
415                 else
416                         strbuf_addstr(&sb, "(error)");
417         }
418         printf("%s\n", sb.buf);
419
420         strbuf_release(&sb);
421 }
422
423 static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
424 {
425         int i;
426
427         for (i = 0; wt[i]; i++) {
428                 int sha1_len;
429                 int path_len = strlen(wt[i]->path);
430
431                 if (path_len > *maxlen)
432                         *maxlen = path_len;
433                 sha1_len = strlen(find_unique_abbrev(wt[i]->head_sha1, *abbrev));
434                 if (sha1_len > *abbrev)
435                         *abbrev = sha1_len;
436         }
437 }
438
439 static int list(int ac, const char **av, const char *prefix)
440 {
441         int porcelain = 0;
442
443         struct option options[] = {
444                 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
445                 OPT_END()
446         };
447
448         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
449         if (ac)
450                 usage_with_options(worktree_usage, options);
451         else {
452                 struct worktree **worktrees = get_worktrees(GWT_SORT_LINKED);
453                 int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
454
455                 if (!porcelain)
456                         measure_widths(worktrees, &abbrev, &path_maxlen);
457
458                 for (i = 0; worktrees[i]; i++) {
459                         if (porcelain)
460                                 show_worktree_porcelain(worktrees[i]);
461                         else
462                                 show_worktree(worktrees[i], path_maxlen, abbrev);
463                 }
464                 free_worktrees(worktrees);
465         }
466         return 0;
467 }
468
469 static int lock_worktree(int ac, const char **av, const char *prefix)
470 {
471         const char *reason = "", *old_reason;
472         struct option options[] = {
473                 OPT_STRING(0, "reason", &reason, N_("string"),
474                            N_("reason for locking")),
475                 OPT_END()
476         };
477         struct worktree **worktrees, *wt;
478
479         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
480         if (ac != 1)
481                 usage_with_options(worktree_usage, options);
482
483         worktrees = get_worktrees(0);
484         wt = find_worktree(worktrees, prefix, av[0]);
485         if (!wt)
486                 die(_("'%s' is not a working tree"), av[0]);
487         if (is_main_worktree(wt))
488                 die(_("The main working tree cannot be locked or unlocked"));
489
490         old_reason = is_worktree_locked(wt);
491         if (old_reason) {
492                 if (*old_reason)
493                         die(_("'%s' is already locked, reason: %s"),
494                             av[0], old_reason);
495                 die(_("'%s' is already locked"), av[0]);
496         }
497
498         write_file(git_common_path("worktrees/%s/locked", wt->id),
499                    "%s", reason);
500         free_worktrees(worktrees);
501         return 0;
502 }
503
504 static int unlock_worktree(int ac, const char **av, const char *prefix)
505 {
506         struct option options[] = {
507                 OPT_END()
508         };
509         struct worktree **worktrees, *wt;
510         int ret;
511
512         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
513         if (ac != 1)
514                 usage_with_options(worktree_usage, options);
515
516         worktrees = get_worktrees(0);
517         wt = find_worktree(worktrees, prefix, av[0]);
518         if (!wt)
519                 die(_("'%s' is not a working tree"), av[0]);
520         if (is_main_worktree(wt))
521                 die(_("The main working tree cannot be locked or unlocked"));
522         if (!is_worktree_locked(wt))
523                 die(_("'%s' is not locked"), av[0]);
524         ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
525         free_worktrees(worktrees);
526         return ret;
527 }
528
529 static int move_worktree(int ac, const char **av, const char *prefix)
530 {
531         const char *lock_reason;
532         struct option options[] = {
533                 OPT__DRY_RUN(&show_only, N_("do not move, show only")),
534                 OPT_END()
535         };
536         struct worktree **worktrees, *wt;
537         char *path = NULL;
538         const char *name;
539         struct strbuf sb_path = STRBUF_INIT;
540         int len, ret = 0, ret2 = 0;
541
542         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
543         if (ac != 2)
544                 usage_with_options(worktree_usage, options);
545
546         worktrees = get_worktrees(0);
547
548         wt = find_worktree(worktrees, prefix, av[1]);
549         if (wt)
550                 die(_("worktree '%s' exists already"), av[1]);
551
552         path = prefix_filename(prefix, av[1]);
553         if (file_exists(path))
554                 die(_("'%s' already exists"), path);
555
556         name = worktree_basename(path, &len);
557         strbuf_add_real_path(&sb_path, path);
558
559         wt = find_worktree(worktrees, prefix, av[0]);
560         if (!wt)
561                 die(_("'%s' is not a working tree"), av[0]);
562         /* Moving the main worktree could potentially be doable by changing all
563          * references from the associated worktrees too, but we don't support
564          * it presently */
565         if (is_main_worktree(wt))
566                 die(_("The main working tree cannot be moved"));
567
568         lock_reason = is_worktree_locked(wt);
569         if (lock_reason) {
570                 if (*lock_reason)
571                         die(_("'%s' is locked, reason: %s"), av[0], lock_reason);
572                 die(_("'%s' is locked"), av[0]);
573         }
574
575         if (show_only) {
576                 printf("would lock %s\n", wt->id);
577         } else {
578                 struct strbuf sb_lock = STRBUF_INIT;
579                 strbuf_git_common_path(&sb_lock, "worktrees/%s/locked", wt->id);
580                 write_file(sb_lock.buf, "moving\nfrom %s\nto %s", wt->path, sb_path.buf);
581                 strbuf_reset(&sb_lock);
582         }
583
584         if (show_only) {
585                 printf("would move %s to %s\n", wt->path, sb_path.buf);
586         } else {
587                 ret = rename(wt->path, sb_path.buf);
588                 if (ret)
589                         ret = errno;
590         }
591
592         if (show_only) {
593                 printf("would move worktrees/%s to worktrees/%s\n", wt->id, name);
594         } else {
595                 if (!ret) {
596                         struct strbuf wtold = STRBUF_INIT, wtnew = STRBUF_INIT;
597                         strbuf_git_common_path(&wtold, "worktrees/%s", wt->id);
598                         strbuf_git_common_path(&wtnew, "worktrees/%s", name);
599                         ret = rename(wtold.buf, wtnew.buf);
600                         if (ret)
601                                 ret = errno;
602                         else {
603                                 free(wt->id);
604                                 wt->id = xstrdup(name);
605                         }
606                         strbuf_reset(&wtold);
607                         strbuf_reset(&wtnew);
608                 }
609         }
610
611         if (show_only) {
612                 printf("would fixup gitdir for %s", wt->id);
613         } else {
614                 if (!ret) {
615                         struct strbuf sb_gitdir = STRBUF_INIT,
616                                 sb_git = STRBUF_INIT,
617                                 sb_real_git = STRBUF_INIT;
618                         strbuf_git_common_path(&sb_gitdir, "worktrees/%s/gitdir", wt->id);
619                         strbuf_addf(&sb_git, "%s/.git", sb_path.buf);
620                         strbuf_add_real_path(&sb_real_git, sb_gitdir.buf);
621                         strbuf_remove(&sb_real_git, sb_real_git.len - 7, 7);
622
623                         write_file(sb_gitdir.buf, "%s", sb_git.buf);
624                         write_file(sb_git.buf, "gitdir: %s", sb_real_git.buf);
625
626                         strbuf_reset(&sb_real_git);
627                         strbuf_reset(&sb_git);
628                         strbuf_reset(&sb_gitdir);
629                 }
630         }
631
632         if (show_only) {
633                 printf("would unlock %s\n", wt->id);
634         } else {
635                 struct strbuf sb_lock = STRBUF_INIT;
636                 strbuf_git_common_path(&sb_lock, "worktrees/%s/locked", wt->id);
637                 ret2 = unlink_or_warn(sb_lock.buf);
638                 strbuf_reset(&sb_lock);
639         }
640
641         free_worktrees(worktrees);
642         free(path);
643
644         /* return the errno from the failed rename, if any, else the one from the
645          * unlock */
646         return ret ? ret : ret2;
647 }
648
649
650 int cmd_worktree(int ac, const char **av, const char *prefix)
651 {
652         struct option options[] = {
653                 OPT_END()
654         };
655
656         git_config(git_default_config, NULL);
657
658         if (ac < 2)
659                 usage_with_options(worktree_usage, options);
660         if (!prefix)
661                 prefix = "";
662         if (!strcmp(av[1], "add"))
663                 return add(ac - 1, av + 1, prefix);
664         if (!strcmp(av[1], "prune"))
665                 return prune(ac - 1, av + 1, prefix);
666         if (!strcmp(av[1], "list"))
667                 return list(ac - 1, av + 1, prefix);
668         if (!strcmp(av[1], "lock"))
669                 return lock_worktree(ac - 1, av + 1, prefix);
670         if (!strcmp(av[1], "move"))
671                 return move_worktree(ac - 1, av + 1, prefix);
672         if (!strcmp(av[1], "unlock"))
673                 return unlock_worktree(ac - 1, av + 1, prefix);
674         usage_with_options(worktree_usage, options);
675 }