builtin/worktree.c

   1 #include "cache.h"
   2 #include "checkout.h"
   3 #include "config.h"
   4 #include "builtin.h"
   5 #include "dir.h"
   6 #include "parse-options.h"
   7 #include "strvec.h"
   8 #include "branch.h"
   9 #include "refs.h"
  10 #include "run-command.h"
  11 #include "hook.h"
  12 #include "sigchain.h"
  13 #include "submodule.h"
  14 #include "utf8.h"
  15 #include "worktree.h"
  16 #include "quote.h"
  17
  18 static const char * const worktree_usage[] = {
  19         N_("git worktree add [<options>] <path> [<commit-ish>]"),
  20         N_("git worktree list [<options>]"),
  21         N_("git worktree lock [<options>] <path>"),
  22         N_("git worktree move <worktree> <new-path>"),
  23         N_("git worktree prune [<options>]"),
  24         N_("git worktree remove [<options>] <worktree>"),
  25         N_("git worktree unlock <path>"),
  26         NULL
  27 };
  28
  29 struct add_opts {
  30         int force;
  31         int detach;
  32         int quiet;
  33         int checkout;
  34         const char *keep_locked;
  35 };
  36
  37 static int show_only;
  38 static int verbose;
  39 static int guess_remote;
  40 static timestamp_t expire;
  41
  42 static int git_worktree_config(const char *var, const char *value, void *cb)
  43 {
  44         if (!strcmp(var, "worktree.guessremote")) {
  45                 guess_remote = git_config_bool(var, value);
  46                 return 0;
  47         }
  48
  49         return git_default_config(var, value, cb);
  50 }
  51
  52 static int delete_git_dir(const char *id)
  53 {
  54         struct strbuf sb = STRBUF_INIT;
  55         int ret;
  56
  57         strbuf_addstr(&sb, git_common_path("worktrees/%s", id));
  58         ret = remove_dir_recursively(&sb, 0);
  59         if (ret < 0 && errno == ENOTDIR)
  60                 ret = unlink(sb.buf);
  61         if (ret)
  62                 error_errno(_("failed to delete '%s'"), sb.buf);
  63         strbuf_release(&sb);
  64         return ret;
  65 }
  66
  67 static void delete_worktrees_dir_if_empty(void)
  68 {
  69         rmdir(git_path("worktrees")); /* ignore failed removal */
  70 }
  71
  72 static void prune_worktree(const char *id, const char *reason)
  73 {
  74         if (show_only || verbose)
  75                 fprintf_ln(stderr, _("Removing %s/%s: %s"), "worktrees", id, reason);
  76         if (!show_only)
  77                 delete_git_dir(id);
  78 }
  79
  80 static int prune_cmp(const void *a, const void *b)
  81 {
  82         const struct string_list_item *x = a;
  83         const struct string_list_item *y = b;
  84         int c;
  85
  86         if ((c = fspathcmp(x->string, y->string)))
  87             return c;
  88         /*
  89          * paths same; prune_dupes() removes all but the first worktree entry
  90          * having the same path, so sort main worktree ('util' is NULL) above
  91          * linked worktrees ('util' not NULL) since main worktree can't be
  92          * removed
  93          */
  94         if (!x->util)
  95                 return -1;
  96         if (!y->util)
  97                 return 1;
  98         /* paths same; sort by .git/worktrees/<id> */
  99         return strcmp(x->util, y->util);
 100 }
 101
 102 static void prune_dups(struct string_list *l)
 103 {
 104         int i;
 105
 106         QSORT(l->items, l->nr, prune_cmp);
 107         for (i = 1; i < l->nr; i++) {
 108                 if (!fspathcmp(l->items[i].string, l->items[i - 1].string))
 109                         prune_worktree(l->items[i].util, "duplicate entry");
 110         }
 111 }
 112
 113 static void prune_worktrees(void)
 114 {
 115         struct strbuf reason = STRBUF_INIT;
 116         struct strbuf main_path = STRBUF_INIT;
 117         struct string_list kept = STRING_LIST_INIT_NODUP;
 118         DIR *dir = opendir(git_path("worktrees"));
 119         struct dirent *d;
 120         if (!dir)
 121                 return;
 122         while ((d = readdir_skip_dot_and_dotdot(dir)) != NULL) {
 123                 char *path;
 124                 strbuf_reset(&reason);
 125                 if (should_prune_worktree(d->d_name, &reason, &path, expire))
 126                         prune_worktree(d->d_name, reason.buf);
 127                 else if (path)
 128                         string_list_append(&kept, path)->util = xstrdup(d->d_name);
 129         }
 130         closedir(dir);
 131
 132         strbuf_add_absolute_path(&main_path, get_git_common_dir());
 133         /* massage main worktree absolute path to match 'gitdir' content */
 134         strbuf_strip_suffix(&main_path, "/.");
 135         string_list_append(&kept, strbuf_detach(&main_path, NULL));
 136         prune_dups(&kept);
 137         string_list_clear(&kept, 1);
 138
 139         if (!show_only)
 140                 delete_worktrees_dir_if_empty();
 141         strbuf_release(&reason);
 142 }
 143
 144 static int prune(int ac, const char **av, const char *prefix)
 145 {
 146         struct option options[] = {
 147                 OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
 148                 OPT__VERBOSE(&verbose, N_("report pruned working trees")),
 149                 OPT_EXPIRY_DATE(0, "expire", &expire,
 150                                 N_("expire working trees older than <time>")),
 151                 OPT_END()
 152         };
 153
 154         expire = TIME_MAX;
 155         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 156         if (ac)
 157                 usage_with_options(worktree_usage, options);
 158         prune_worktrees();
 159         return 0;
 160 }
 161
 162 static char *junk_work_tree;
 163 static char *junk_git_dir;
 164 static int is_junk;
 165 static pid_t junk_pid;
 166
 167 static void remove_junk(void)
 168 {
 169         struct strbuf sb = STRBUF_INIT;
 170         if (!is_junk || getpid() != junk_pid)
 171                 return;
 172         if (junk_git_dir) {
 173                 strbuf_addstr(&sb, junk_git_dir);
 174                 remove_dir_recursively(&sb, 0);
 175                 strbuf_reset(&sb);
 176         }
 177         if (junk_work_tree) {
 178                 strbuf_addstr(&sb, junk_work_tree);
 179                 remove_dir_recursively(&sb, 0);
 180         }
 181         strbuf_release(&sb);
 182 }
 183
 184 static void remove_junk_on_signal(int signo)
 185 {
 186         remove_junk();
 187         sigchain_pop(signo);
 188         raise(signo);
 189 }
 190
 191 static const char *worktree_basename(const char *path, int *olen)
 192 {
 193         const char *name;
 194         int len;
 195
 196         len = strlen(path);
 197         while (len && is_dir_sep(path[len - 1]))
 198                 len--;
 199
 200         for (name = path + len - 1; name > path; name--)
 201                 if (is_dir_sep(*name)) {
 202                         name++;
 203                         break;
 204                 }
 205
 206         *olen = len;
 207         return name;
 208 }
 209
 210 /* check that path is viable location for worktree */
 211 static void check_candidate_path(const char *path,
 212                                  int force,
 213                                  struct worktree **worktrees,
 214                                  const char *cmd)
 215 {
 216         struct worktree *wt;
 217         int locked;
 218
 219         if (file_exists(path) && !is_empty_dir(path))
 220                 die(_("'%s' already exists"), path);
 221
 222         wt = find_worktree_by_path(worktrees, path);
 223         if (!wt)
 224                 return;
 225
 226         locked = !!worktree_lock_reason(wt);
 227         if ((!locked && force) || (locked && force > 1)) {
 228                 if (delete_git_dir(wt->id))
 229                     die(_("unusable worktree destination '%s'"), path);
 230                 return;
 231         }
 232
 233         if (locked)
 234                 die(_("'%s' is a missing but locked worktree;\nuse '%s -f -f' to override, or 'unlock' and 'prune' or 'remove' to clear"), path, cmd);
 235         else
 236                 die(_("'%s' is a missing but already registered worktree;\nuse '%s -f' to override, or 'prune' or 'remove' to clear"), path, cmd);
 237 }
 238
 239 static int add_worktree(const char *path, const char *refname,
 240                         const struct add_opts *opts)
 241 {
 242         struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
 243         struct strbuf sb = STRBUF_INIT, realpath = STRBUF_INIT;
 244         const char *name;
 245         struct child_process cp = CHILD_PROCESS_INIT;
 246         struct strvec child_env = STRVEC_INIT;
 247         unsigned int counter = 0;
 248         int len, ret;
 249         struct strbuf symref = STRBUF_INIT;
 250         struct commit *commit = NULL;
 251         int is_branch = 0;
 252         struct strbuf sb_name = STRBUF_INIT;
 253         struct worktree **worktrees;
 254
 255         worktrees = get_worktrees();
 256         check_candidate_path(path, opts->force, worktrees, "add");
 257         free_worktrees(worktrees);
 258         worktrees = NULL;
 259
 260         /* is 'refname' a branch or commit? */
 261         if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
 262             ref_exists(symref.buf)) {
 263                 is_branch = 1;
 264                 if (!opts->force)
 265                         die_if_checked_out(symref.buf, 0);
 266         }
 267         commit = lookup_commit_reference_by_name(refname);
 268         if (!commit)
 269                 die(_("invalid reference: %s"), refname);
 270
 271         name = worktree_basename(path, &len);
 272         strbuf_add(&sb, name, path + len - name);
 273         sanitize_refname_component(sb.buf, &sb_name);
 274         if (!sb_name.len)
 275                 BUG("How come '%s' becomes empty after sanitization?", sb.buf);
 276         strbuf_reset(&sb);
 277         name = sb_name.buf;
 278         git_path_buf(&sb_repo, "worktrees/%s", name);
 279         len = sb_repo.len;
 280         if (safe_create_leading_directories_const(sb_repo.buf))
 281                 die_errno(_("could not create leading directories of '%s'"),
 282                           sb_repo.buf);
 283
 284         while (mkdir(sb_repo.buf, 0777)) {
 285                 counter++;
 286                 if ((errno != EEXIST) || !counter /* overflow */)
 287                         die_errno(_("could not create directory of '%s'"),
 288                                   sb_repo.buf);
 289                 strbuf_setlen(&sb_repo, len);
 290                 strbuf_addf(&sb_repo, "%d", counter);
 291         }
 292         name = strrchr(sb_repo.buf, '/') + 1;
 293
 294         junk_pid = getpid();
 295         atexit(remove_junk);
 296         sigchain_push_common(remove_junk_on_signal);
 297
 298         junk_git_dir = xstrdup(sb_repo.buf);
 299         is_junk = 1;
 300
 301         /*
 302          * lock the incomplete repo so prune won't delete it, unlock
 303          * after the preparation is over.
 304          */
 305         strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 306         if (opts->keep_locked)
 307                 write_file(sb.buf, "%s", opts->keep_locked);
 308         else
 309                 write_file(sb.buf, _("initializing"));
 310
 311         strbuf_addf(&sb_git, "%s/.git", path);
 312         if (safe_create_leading_directories_const(sb_git.buf))
 313                 die_errno(_("could not create leading directories of '%s'"),
 314                           sb_git.buf);
 315         junk_work_tree = xstrdup(path);
 316
 317         strbuf_reset(&sb);
 318         strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
 319         strbuf_realpath(&realpath, sb_git.buf, 1);
 320         write_file(sb.buf, "%s", realpath.buf);
 321         strbuf_realpath(&realpath, get_git_common_dir(), 1);
 322         write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
 323                    realpath.buf, name);
 324         /*
 325          * This is to keep resolve_ref() happy. We need a valid HEAD
 326          * or is_git_directory() will reject the directory. Any value which
 327          * looks like an object ID will do since it will be immediately
 328          * replaced by the symbolic-ref or update-ref invocation in the new
 329          * worktree.
 330          */
 331         strbuf_reset(&sb);
 332         strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
 333         write_file(sb.buf, "%s", oid_to_hex(null_oid()));
 334         strbuf_reset(&sb);
 335         strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
 336         write_file(sb.buf, "../..");
 337
 338         strvec_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
 339         strvec_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
 340         cp.git_cmd = 1;
 341
 342         if (!is_branch)
 343                 strvec_pushl(&cp.args, "update-ref", "HEAD",
 344                              oid_to_hex(&commit->object.oid), NULL);
 345         else {
 346                 strvec_pushl(&cp.args, "symbolic-ref", "HEAD",
 347                              symref.buf, NULL);
 348                 if (opts->quiet)
 349                         strvec_push(&cp.args, "--quiet");
 350         }
 351
 352         strvec_pushv(&cp.env_array, child_env.v);
 353         ret = run_command(&cp);
 354         if (ret)
 355                 goto done;
 356
 357         if (opts->checkout) {
 358                 struct child_process cp = CHILD_PROCESS_INIT;
 359                 cp.git_cmd = 1;
 360                 strvec_pushl(&cp.args, "reset", "--hard", "--no-recurse-submodules", NULL);
 361                 if (opts->quiet)
 362                         strvec_push(&cp.args, "--quiet");
 363                 strvec_pushv(&cp.env_array, child_env.v);
 364                 ret = run_command(&cp);
 365                 if (ret)
 366                         goto done;
 367         }
 368
 369         is_junk = 0;
 370         FREE_AND_NULL(junk_work_tree);
 371         FREE_AND_NULL(junk_git_dir);
 372
 373 done:
 374         if (ret || !opts->keep_locked) {
 375                 strbuf_reset(&sb);
 376                 strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 377                 unlink_or_warn(sb.buf);
 378         }
 379
 380         /*
 381          * Hook failure does not warrant worktree deletion, so run hook after
 382          * is_junk is cleared, but do return appropriate code when hook fails.
 383          */
 384         if (!ret && opts->checkout) {
 385                 const char *hook = find_hook("post-checkout");
 386                 if (hook) {
 387                         const char *env[] = { "GIT_DIR", "GIT_WORK_TREE", NULL };
 388                         struct child_process cp = CHILD_PROCESS_INIT;
 389                         cp.no_stdin = 1;
 390                         cp.stdout_to_stderr = 1;
 391                         cp.dir = path;
 392                         strvec_pushv(&cp.env_array, env);
 393                         cp.trace2_hook_name = "post-checkout";
 394                         strvec_pushl(&cp.args, absolute_path(hook),
 395                                      oid_to_hex(null_oid()),
 396                                      oid_to_hex(&commit->object.oid),
 397                                      "1", NULL);
 398                         ret = run_command(&cp);
 399                 }
 400         }
 401
 402         strvec_clear(&child_env);
 403         strbuf_release(&sb);
 404         strbuf_release(&symref);
 405         strbuf_release(&sb_repo);
 406         strbuf_release(&sb_git);
 407         strbuf_release(&sb_name);
 408         strbuf_release(&realpath);
 409         return ret;
 410 }
 411
 412 static void print_preparing_worktree_line(int detach,
 413                                           const char *branch,
 414                                           const char *new_branch,
 415                                           int force_new_branch)
 416 {
 417         if (force_new_branch) {
 418                 struct commit *commit = lookup_commit_reference_by_name(new_branch);
 419                 if (!commit)
 420                         fprintf_ln(stderr, _("Preparing worktree (new branch '%s')"), new_branch);
 421                 else
 422                         fprintf_ln(stderr, _("Preparing worktree (resetting branch '%s'; was at %s)"),
 423                                   new_branch,
 424                                   find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 425         } else if (new_branch) {
 426                 fprintf_ln(stderr, _("Preparing worktree (new branch '%s')"), new_branch);
 427         } else {
 428                 struct strbuf s = STRBUF_INIT;
 429                 if (!detach && !strbuf_check_branch_ref(&s, branch) &&
 430                     ref_exists(s.buf))
 431                         fprintf_ln(stderr, _("Preparing worktree (checking out '%s')"),
 432                                   branch);
 433                 else {
 434                         struct commit *commit = lookup_commit_reference_by_name(branch);
 435                         if (!commit)
 436                                 die(_("invalid reference: %s"), branch);
 437                         fprintf_ln(stderr, _("Preparing worktree (detached HEAD %s)"),
 438                                   find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 439                 }
 440                 strbuf_release(&s);
 441         }
 442 }
 443
 444 static const char *dwim_branch(const char *path, const char **new_branch)
 445 {
 446         int n;
 447         int branch_exists;
 448         const char *s = worktree_basename(path, &n);
 449         const char *branchname = xstrndup(s, n);
 450         struct strbuf ref = STRBUF_INIT;
 451
 452         UNLEAK(branchname);
 453
 454         branch_exists = !strbuf_check_branch_ref(&ref, branchname) &&
 455                         ref_exists(ref.buf);
 456         strbuf_release(&ref);
 457         if (branch_exists)
 458                 return branchname;
 459
 460         *new_branch = branchname;
 461         if (guess_remote) {
 462                 struct object_id oid;
 463                 const char *remote =
 464                         unique_tracking_name(*new_branch, &oid, NULL);
 465                 return remote;
 466         }
 467         return NULL;
 468 }
 469
 470 static int add(int ac, const char **av, const char *prefix)
 471 {
 472         struct add_opts opts;
 473         const char *new_branch_force = NULL;
 474         char *path;
 475         const char *branch;
 476         const char *new_branch = NULL;
 477         const char *opt_track = NULL;
 478         const char *lock_reason = NULL;
 479         int keep_locked = 0;
 480         struct option options[] = {
 481                 OPT__FORCE(&opts.force,
 482                            N_("checkout <branch> even if already checked out in other worktree"),
 483                            PARSE_OPT_NOCOMPLETE),
 484                 OPT_STRING('b', NULL, &new_branch, N_("branch"),
 485                            N_("create a new branch")),
 486                 OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
 487                            N_("create or reset a branch")),
 488                 OPT_BOOL('d', "detach", &opts.detach, N_("detach HEAD at named commit")),
 489                 OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
 490                 OPT_BOOL(0, "lock", &keep_locked, N_("keep the new working tree locked")),
 491                 OPT_STRING(0, "reason", &lock_reason, N_("string"),
 492                            N_("reason for locking")),
 493                 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
 494                 OPT_PASSTHRU(0, "track", &opt_track, NULL,
 495                              N_("set up tracking mode (see git-branch(1))"),
 496                              PARSE_OPT_NOARG | PARSE_OPT_OPTARG),
 497                 OPT_BOOL(0, "guess-remote", &guess_remote,
 498                          N_("try to match the new branch name with a remote-tracking branch")),
 499                 OPT_END()
 500         };
 501
 502         memset(&opts, 0, sizeof(opts));
 503         opts.checkout = 1;
 504         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 505         if (!!opts.detach + !!new_branch + !!new_branch_force > 1)
 506                 die(_("options '%s', '%s', and '%s' cannot be used together"), "-b", "-B", "--detach");
 507         if (lock_reason && !keep_locked)
 508                 die(_("the option '%s' requires '%s'"), "--reason", "--lock");
 509         if (lock_reason)
 510                 opts.keep_locked = lock_reason;
 511         else if (keep_locked)
 512                 opts.keep_locked = _("added with --lock");
 513
 514         if (ac < 1 || ac > 2)
 515                 usage_with_options(worktree_usage, options);
 516
 517         path = prefix_filename(prefix, av[0]);
 518         branch = ac < 2 ? "HEAD" : av[1];
 519
 520         if (!strcmp(branch, "-"))
 521                 branch = "@{-1}";
 522
 523         if (new_branch_force) {
 524                 struct strbuf symref = STRBUF_INIT;
 525
 526                 new_branch = new_branch_force;
 527
 528                 if (!opts.force &&
 529                     !strbuf_check_branch_ref(&symref, new_branch) &&
 530                     ref_exists(symref.buf))
 531                         die_if_checked_out(symref.buf, 0);
 532                 strbuf_release(&symref);
 533         }
 534
 535         if (ac < 2 && !new_branch && !opts.detach) {
 536                 const char *s = dwim_branch(path, &new_branch);
 537                 if (s)
 538                         branch = s;
 539         }
 540
 541         if (ac == 2 && !new_branch && !opts.detach) {
 542                 struct object_id oid;
 543                 struct commit *commit;
 544                 const char *remote;
 545
 546                 commit = lookup_commit_reference_by_name(branch);
 547                 if (!commit) {
 548                         remote = unique_tracking_name(branch, &oid, NULL);
 549                         if (remote) {
 550                                 new_branch = branch;
 551                                 branch = remote;
 552                         }
 553                 }
 554         }
 555         if (!opts.quiet)
 556                 print_preparing_worktree_line(opts.detach, branch, new_branch, !!new_branch_force);
 557
 558         if (new_branch) {
 559                 struct child_process cp = CHILD_PROCESS_INIT;
 560                 cp.git_cmd = 1;
 561                 strvec_push(&cp.args, "branch");
 562                 if (new_branch_force)
 563                         strvec_push(&cp.args, "--force");
 564                 if (opts.quiet)
 565                         strvec_push(&cp.args, "--quiet");
 566                 strvec_push(&cp.args, new_branch);
 567                 strvec_push(&cp.args, branch);
 568                 if (opt_track)
 569                         strvec_push(&cp.args, opt_track);
 570                 if (run_command(&cp))
 571                         return -1;
 572                 branch = new_branch;
 573         } else if (opt_track) {
 574                 die(_("--[no-]track can only be used if a new branch is created"));
 575         }
 576
 577         UNLEAK(path);
 578         UNLEAK(opts);
 579         return add_worktree(path, branch, &opts);
 580 }
 581
 582 static void show_worktree_porcelain(struct worktree *wt)
 583 {
 584         const char *reason;
 585
 586         printf("worktree %s\n", wt->path);
 587         if (wt->is_bare)
 588                 printf("bare\n");
 589         else {
 590                 printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
 591                 if (wt->is_detached)
 592                         printf("detached\n");
 593                 else if (wt->head_ref)
 594                         printf("branch %s\n", wt->head_ref);
 595         }
 596
 597         reason = worktree_lock_reason(wt);
 598         if (reason && *reason) {
 599                 struct strbuf sb = STRBUF_INIT;
 600                 quote_c_style(reason, &sb, NULL, 0);
 601                 printf("locked %s\n", sb.buf);
 602                 strbuf_release(&sb);
 603         } else if (reason)
 604                 printf("locked\n");
 605
 606         reason = worktree_prune_reason(wt, expire);
 607         if (reason)
 608                 printf("prunable %s\n", reason);
 609
 610         printf("\n");
 611 }
 612
 613 static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
 614 {
 615         struct strbuf sb = STRBUF_INIT;
 616         int cur_path_len = strlen(wt->path);
 617         int path_adj = cur_path_len - utf8_strwidth(wt->path);
 618         const char *reason;
 619
 620         strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
 621         if (wt->is_bare)
 622                 strbuf_addstr(&sb, "(bare)");
 623         else {
 624                 strbuf_addf(&sb, "%-*s ", abbrev_len,
 625                                 find_unique_abbrev(&wt->head_oid, DEFAULT_ABBREV));
 626                 if (wt->is_detached)
 627                         strbuf_addstr(&sb, "(detached HEAD)");
 628                 else if (wt->head_ref) {
 629                         char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
 630                         strbuf_addf(&sb, "[%s]", ref);
 631                         free(ref);
 632                 } else
 633                         strbuf_addstr(&sb, "(error)");
 634         }
 635
 636         reason = worktree_lock_reason(wt);
 637         if (verbose && reason && *reason)
 638                 strbuf_addf(&sb, "\n\tlocked: %s", reason);
 639         else if (reason)
 640                 strbuf_addstr(&sb, " locked");
 641
 642         reason = worktree_prune_reason(wt, expire);
 643         if (verbose && reason)
 644                 strbuf_addf(&sb, "\n\tprunable: %s", reason);
 645         else if (reason)
 646                 strbuf_addstr(&sb, " prunable");
 647
 648         printf("%s\n", sb.buf);
 649         strbuf_release(&sb);
 650 }
 651
 652 static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
 653 {
 654         int i;
 655
 656         for (i = 0; wt[i]; i++) {
 657                 int sha1_len;
 658                 int path_len = strlen(wt[i]->path);
 659
 660                 if (path_len > *maxlen)
 661                         *maxlen = path_len;
 662                 sha1_len = strlen(find_unique_abbrev(&wt[i]->head_oid, *abbrev));
 663                 if (sha1_len > *abbrev)
 664                         *abbrev = sha1_len;
 665         }
 666 }
 667
 668 static int pathcmp(const void *a_, const void *b_)
 669 {
 670         const struct worktree *const *a = a_;
 671         const struct worktree *const *b = b_;
 672         return fspathcmp((*a)->path, (*b)->path);
 673 }
 674
 675 static void pathsort(struct worktree **wt)
 676 {
 677         int n = 0;
 678         struct worktree **p = wt;
 679
 680         while (*p++)
 681                 n++;
 682         QSORT(wt, n, pathcmp);
 683 }
 684
 685 static int list(int ac, const char **av, const char *prefix)
 686 {
 687         int porcelain = 0;
 688
 689         struct option options[] = {
 690                 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
 691                 OPT__VERBOSE(&verbose, N_("show extended annotations and reasons, if available")),
 692                 OPT_EXPIRY_DATE(0, "expire", &expire,
 693                                 N_("add 'prunable' annotation to worktrees older than <time>")),
 694                 OPT_END()
 695         };
 696
 697         expire = TIME_MAX;
 698         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 699         if (ac)
 700                 usage_with_options(worktree_usage, options);
 701         else if (verbose && porcelain)
 702                 die(_("options '%s' and '%s' cannot be used together"), "--verbose", "--porcelain");
 703         else {
 704                 struct worktree **worktrees = get_worktrees();
 705                 int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
 706
 707                 /* sort worktrees by path but keep main worktree at top */
 708                 pathsort(worktrees + 1);
 709
 710                 if (!porcelain)
 711                         measure_widths(worktrees, &abbrev, &path_maxlen);
 712
 713                 for (i = 0; worktrees[i]; i++) {
 714                         if (porcelain)
 715                                 show_worktree_porcelain(worktrees[i]);
 716                         else
 717                                 show_worktree(worktrees[i], path_maxlen, abbrev);
 718                 }
 719                 free_worktrees(worktrees);
 720         }
 721         return 0;
 722 }
 723
 724 static int lock_worktree(int ac, const char **av, const char *prefix)
 725 {
 726         const char *reason = "", *old_reason;
 727         struct option options[] = {
 728                 OPT_STRING(0, "reason", &reason, N_("string"),
 729                            N_("reason for locking")),
 730                 OPT_END()
 731         };
 732         struct worktree **worktrees, *wt;
 733
 734         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 735         if (ac != 1)
 736                 usage_with_options(worktree_usage, options);
 737
 738         worktrees = get_worktrees();
 739         wt = find_worktree(worktrees, prefix, av[0]);
 740         if (!wt)
 741                 die(_("'%s' is not a working tree"), av[0]);
 742         if (is_main_worktree(wt))
 743                 die(_("The main working tree cannot be locked or unlocked"));
 744
 745         old_reason = worktree_lock_reason(wt);
 746         if (old_reason) {
 747                 if (*old_reason)
 748                         die(_("'%s' is already locked, reason: %s"),
 749                             av[0], old_reason);
 750                 die(_("'%s' is already locked"), av[0]);
 751         }
 752
 753         write_file(git_common_path("worktrees/%s/locked", wt->id),
 754                    "%s", reason);
 755         free_worktrees(worktrees);
 756         return 0;
 757 }
 758
 759 static int unlock_worktree(int ac, const char **av, const char *prefix)
 760 {
 761         struct option options[] = {
 762                 OPT_END()
 763         };
 764         struct worktree **worktrees, *wt;
 765         int ret;
 766
 767         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 768         if (ac != 1)
 769                 usage_with_options(worktree_usage, options);
 770
 771         worktrees = get_worktrees();
 772         wt = find_worktree(worktrees, prefix, av[0]);
 773         if (!wt)
 774                 die(_("'%s' is not a working tree"), av[0]);
 775         if (is_main_worktree(wt))
 776                 die(_("The main working tree cannot be locked or unlocked"));
 777         if (!worktree_lock_reason(wt))
 778                 die(_("'%s' is not locked"), av[0]);
 779         ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
 780         free_worktrees(worktrees);
 781         return ret;
 782 }
 783
 784 static void validate_no_submodules(const struct worktree *wt)
 785 {
 786         struct index_state istate = { NULL };
 787         struct strbuf path = STRBUF_INIT;
 788         int i, found_submodules = 0;
 789
 790         if (is_directory(worktree_git_path(wt, "modules"))) {
 791                 /*
 792                  * There could be false positives, e.g. the "modules"
 793                  * directory exists but is empty. But it's a rare case and
 794                  * this simpler check is probably good enough for now.
 795                  */
 796                 found_submodules = 1;
 797         } else if (read_index_from(&istate, worktree_git_path(wt, "index"),
 798                                    get_worktree_git_dir(wt)) > 0) {
 799                 for (i = 0; i < istate.cache_nr; i++) {
 800                         struct cache_entry *ce = istate.cache[i];
 801                         int err;
 802
 803                         if (!S_ISGITLINK(ce->ce_mode))
 804                                 continue;
 805
 806                         strbuf_reset(&path);
 807                         strbuf_addf(&path, "%s/%s", wt->path, ce->name);
 808                         if (!is_submodule_populated_gently(path.buf, &err))
 809                                 continue;
 810
 811                         found_submodules = 1;
 812                         break;
 813                 }
 814         }
 815         discard_index(&istate);
 816         strbuf_release(&path);
 817
 818         if (found_submodules)
 819                 die(_("working trees containing submodules cannot be moved or removed"));
 820 }
 821
 822 static int move_worktree(int ac, const char **av, const char *prefix)
 823 {
 824         int force = 0;
 825         struct option options[] = {
 826                 OPT__FORCE(&force,
 827                          N_("force move even if worktree is dirty or locked"),
 828                          PARSE_OPT_NOCOMPLETE),
 829                 OPT_END()
 830         };
 831         struct worktree **worktrees, *wt;
 832         struct strbuf dst = STRBUF_INIT;
 833         struct strbuf errmsg = STRBUF_INIT;
 834         const char *reason = NULL;
 835         char *path;
 836
 837         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 838         if (ac != 2)
 839                 usage_with_options(worktree_usage, options);
 840
 841         path = prefix_filename(prefix, av[1]);
 842         strbuf_addstr(&dst, path);
 843         free(path);
 844
 845         worktrees = get_worktrees();
 846         wt = find_worktree(worktrees, prefix, av[0]);
 847         if (!wt)
 848                 die(_("'%s' is not a working tree"), av[0]);
 849         if (is_main_worktree(wt))
 850                 die(_("'%s' is a main working tree"), av[0]);
 851         if (is_directory(dst.buf)) {
 852                 const char *sep = find_last_dir_sep(wt->path);
 853
 854                 if (!sep)
 855                         die(_("could not figure out destination name from '%s'"),
 856                             wt->path);
 857                 strbuf_trim_trailing_dir_sep(&dst);
 858                 strbuf_addstr(&dst, sep);
 859         }
 860         check_candidate_path(dst.buf, force, worktrees, "move");
 861
 862         validate_no_submodules(wt);
 863
 864         if (force < 2)
 865                 reason = worktree_lock_reason(wt);
 866         if (reason) {
 867                 if (*reason)
 868                         die(_("cannot move a locked working tree, lock reason: %s\nuse 'move -f -f' to override or unlock first"),
 869                             reason);
 870                 die(_("cannot move a locked working tree;\nuse 'move -f -f' to override or unlock first"));
 871         }
 872         if (validate_worktree(wt, &errmsg, 0))
 873                 die(_("validation failed, cannot move working tree: %s"),
 874                     errmsg.buf);
 875         strbuf_release(&errmsg);
 876
 877         if (rename(wt->path, dst.buf) == -1)
 878                 die_errno(_("failed to move '%s' to '%s'"), wt->path, dst.buf);
 879
 880         update_worktree_location(wt, dst.buf);
 881
 882         strbuf_release(&dst);
 883         free_worktrees(worktrees);
 884         return 0;
 885 }
 886
 887 /*
 888  * Note, "git status --porcelain" is used to determine if it's safe to
 889  * delete a whole worktree. "git status" does not ignore user
 890  * configuration, so if a normal "git status" shows "clean" for the
 891  * user, then it's ok to remove it.
 892  *
 893  * This assumption may be a bad one. We may want to ignore
 894  * (potentially bad) user settings and only delete a worktree when
 895  * it's absolutely safe to do so from _our_ point of view because we
 896  * know better.
 897  */
 898 static void check_clean_worktree(struct worktree *wt,
 899                                  const char *original_path)
 900 {
 901         struct child_process cp;
 902         char buf[1];
 903         int ret;
 904
 905         /*
 906          * Until we sort this out, all submodules are "dirty" and
 907          * will abort this function.
 908          */
 909         validate_no_submodules(wt);
 910
 911         child_process_init(&cp);
 912         strvec_pushf(&cp.env_array, "%s=%s/.git",
 913                      GIT_DIR_ENVIRONMENT, wt->path);
 914         strvec_pushf(&cp.env_array, "%s=%s",
 915                      GIT_WORK_TREE_ENVIRONMENT, wt->path);
 916         strvec_pushl(&cp.args, "status",
 917                      "--porcelain", "--ignore-submodules=none",
 918                      NULL);
 919         cp.git_cmd = 1;
 920         cp.dir = wt->path;
 921         cp.out = -1;
 922         ret = start_command(&cp);
 923         if (ret)
 924                 die_errno(_("failed to run 'git status' on '%s'"),
 925                           original_path);
 926         ret = xread(cp.out, buf, sizeof(buf));
 927         if (ret)
 928                 die(_("'%s' contains modified or untracked files, use --force to delete it"),
 929                     original_path);
 930         close(cp.out);
 931         ret = finish_command(&cp);
 932         if (ret)
 933                 die_errno(_("failed to run 'git status' on '%s', code %d"),
 934                           original_path, ret);
 935 }
 936
 937 static int delete_git_work_tree(struct worktree *wt)
 938 {
 939         struct strbuf sb = STRBUF_INIT;
 940         int ret = 0;
 941
 942         strbuf_addstr(&sb, wt->path);
 943         if (remove_dir_recursively(&sb, 0)) {
 944                 error_errno(_("failed to delete '%s'"), sb.buf);
 945                 ret = -1;
 946         }
 947         strbuf_release(&sb);
 948         return ret;
 949 }
 950
 951 static int remove_worktree(int ac, const char **av, const char *prefix)
 952 {
 953         int force = 0;
 954         struct option options[] = {
 955                 OPT__FORCE(&force,
 956                          N_("force removal even if worktree is dirty or locked"),
 957                          PARSE_OPT_NOCOMPLETE),
 958                 OPT_END()
 959         };
 960         struct worktree **worktrees, *wt;
 961         struct strbuf errmsg = STRBUF_INIT;
 962         const char *reason = NULL;
 963         int ret = 0;
 964
 965         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 966         if (ac != 1)
 967                 usage_with_options(worktree_usage, options);
 968
 969         worktrees = get_worktrees();
 970         wt = find_worktree(worktrees, prefix, av[0]);
 971         if (!wt)
 972                 die(_("'%s' is not a working tree"), av[0]);
 973         if (is_main_worktree(wt))
 974                 die(_("'%s' is a main working tree"), av[0]);
 975         if (force < 2)
 976                 reason = worktree_lock_reason(wt);
 977         if (reason) {
 978                 if (*reason)
 979                         die(_("cannot remove a locked working tree, lock reason: %s\nuse 'remove -f -f' to override or unlock first"),
 980                             reason);
 981                 die(_("cannot remove a locked working tree;\nuse 'remove -f -f' to override or unlock first"));
 982         }
 983         if (validate_worktree(wt, &errmsg, WT_VALIDATE_WORKTREE_MISSING_OK))
 984                 die(_("validation failed, cannot remove working tree: %s"),
 985                     errmsg.buf);
 986         strbuf_release(&errmsg);
 987
 988         if (file_exists(wt->path)) {
 989                 if (!force)
 990                         check_clean_worktree(wt, av[0]);
 991
 992                 ret |= delete_git_work_tree(wt);
 993         }
 994         /*
 995          * continue on even if ret is non-zero, there's no going back
 996          * from here.
 997          */
 998         ret |= delete_git_dir(wt->id);
 999         delete_worktrees_dir_if_empty();
1000
1001         free_worktrees(worktrees);
1002         return ret;
1003 }
1004
1005 static void report_repair(int iserr, const char *path, const char *msg, void *cb_data)
1006 {
1007         if (!iserr) {
1008                 fprintf_ln(stderr, _("repair: %s: %s"), msg, path);
1009         } else {
1010                 int *exit_status = (int *)cb_data;
1011                 fprintf_ln(stderr, _("error: %s: %s"), msg, path);
1012                 *exit_status = 1;
1013         }
1014 }
1015
1016 static int repair(int ac, const char **av, const char *prefix)
1017 {
1018         const char **p;
1019         const char *self[] = { ".", NULL };
1020         struct option options[] = {
1021                 OPT_END()
1022         };
1023         int rc = 0;
1024
1025         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
1026         p = ac > 0 ? av : self;
1027         for (; *p; p++)
1028                 repair_worktree_at_path(*p, report_repair, &rc);
1029         repair_worktrees(report_repair, &rc);
1030         return rc;
1031 }
1032
1033 int cmd_worktree(int ac, const char **av, const char *prefix)
1034 {
1035         struct option options[] = {
1036                 OPT_END()
1037         };
1038
1039         git_config(git_worktree_config, NULL);
1040
1041         if (ac < 2)
1042                 usage_with_options(worktree_usage, options);
1043         if (!prefix)
1044                 prefix = "";
1045         if (!strcmp(av[1], "add"))
1046                 return add(ac - 1, av + 1, prefix);
1047         if (!strcmp(av[1], "prune"))
1048                 return prune(ac - 1, av + 1, prefix);
1049         if (!strcmp(av[1], "list"))
1050                 return list(ac - 1, av + 1, prefix);
1051         if (!strcmp(av[1], "lock"))
1052                 return lock_worktree(ac - 1, av + 1, prefix);
1053         if (!strcmp(av[1], "unlock"))
1054                 return unlock_worktree(ac - 1, av + 1, prefix);
1055         if (!strcmp(av[1], "move"))
1056                 return move_worktree(ac - 1, av + 1, prefix);
1057         if (!strcmp(av[1], "remove"))
1058                 return remove_worktree(ac - 1, av + 1, prefix);
1059         if (!strcmp(av[1], "repair"))
1060                 return repair(ac - 1, av + 1, prefix);
1061         usage_with_options(worktree_usage, options);
1062 }