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                 printf_ln(_("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         cp.env = child_env.v;
 353         ret = run_command(&cp);
 354         if (ret)
 355                 goto done;
 356
 357         if (opts->checkout) {
 358                 cp.argv = NULL;
 359                 strvec_clear(&cp.args);
 360                 strvec_pushl(&cp.args, "reset", "--hard", "--no-recurse-submodules", NULL);
 361                 if (opts->quiet)
 362                         strvec_push(&cp.args, "--quiet");
 363                 cp.env = 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                         cp.git_cmd = 0;
 389                         cp.no_stdin = 1;
 390                         cp.stdout_to_stderr = 1;
 391                         cp.dir = path;
 392                         cp.env = env;
 393                         cp.argv = NULL;
 394                         cp.trace2_hook_name = "post-checkout";
 395                         strvec_pushl(&cp.args, absolute_path(hook),
 396                                      oid_to_hex(null_oid()),
 397                                      oid_to_hex(&commit->object.oid),
 398                                      "1", NULL);
 399                         ret = run_command(&cp);
 400                 }
 401         }
 402
 403         strvec_clear(&child_env);
 404         strbuf_release(&sb);
 405         strbuf_release(&symref);
 406         strbuf_release(&sb_repo);
 407         strbuf_release(&sb_git);
 408         strbuf_release(&sb_name);
 409         strbuf_release(&realpath);
 410         return ret;
 411 }
 412
 413 static void print_preparing_worktree_line(int detach,
 414                                           const char *branch,
 415                                           const char *new_branch,
 416                                           int force_new_branch)
 417 {
 418         if (force_new_branch) {
 419                 struct commit *commit = lookup_commit_reference_by_name(new_branch);
 420                 if (!commit)
 421                         printf_ln(_("Preparing worktree (new branch '%s')"), new_branch);
 422                 else
 423                         printf_ln(_("Preparing worktree (resetting branch '%s'; was at %s)"),
 424                                   new_branch,
 425                                   find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 426         } else if (new_branch) {
 427                 printf_ln(_("Preparing worktree (new branch '%s')"), new_branch);
 428         } else {
 429                 struct strbuf s = STRBUF_INIT;
 430                 if (!detach && !strbuf_check_branch_ref(&s, branch) &&
 431                     ref_exists(s.buf))
 432                         printf_ln(_("Preparing worktree (checking out '%s')"),
 433                                   branch);
 434                 else {
 435                         struct commit *commit = lookup_commit_reference_by_name(branch);
 436                         if (!commit)
 437                                 die(_("invalid reference: %s"), branch);
 438                         printf_ln(_("Preparing worktree (detached HEAD %s)"),
 439                                   find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 440                 }
 441                 strbuf_release(&s);
 442         }
 443 }
 444
 445 static const char *dwim_branch(const char *path, const char **new_branch)
 446 {
 447         int n;
 448         int branch_exists;
 449         const char *s = worktree_basename(path, &n);
 450         const char *branchname = xstrndup(s, n);
 451         struct strbuf ref = STRBUF_INIT;
 452
 453         UNLEAK(branchname);
 454
 455         branch_exists = !strbuf_check_branch_ref(&ref, branchname) &&
 456                         ref_exists(ref.buf);
 457         strbuf_release(&ref);
 458         if (branch_exists)
 459                 return branchname;
 460
 461         *new_branch = branchname;
 462         if (guess_remote) {
 463                 struct object_id oid;
 464                 const char *remote =
 465                         unique_tracking_name(*new_branch, &oid, NULL);
 466                 return remote;
 467         }
 468         return NULL;
 469 }
 470
 471 static int add(int ac, const char **av, const char *prefix)
 472 {
 473         struct add_opts opts;
 474         const char *new_branch_force = NULL;
 475         char *path;
 476         const char *branch;
 477         const char *new_branch = NULL;
 478         const char *opt_track = NULL;
 479         const char *lock_reason = NULL;
 480         int keep_locked = 0;
 481         struct option options[] = {
 482                 OPT__FORCE(&opts.force,
 483                            N_("checkout <branch> even if already checked out in other worktree"),
 484                            PARSE_OPT_NOCOMPLETE),
 485                 OPT_STRING('b', NULL, &new_branch, N_("branch"),
 486                            N_("create a new branch")),
 487                 OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
 488                            N_("create or reset a branch")),
 489                 OPT_BOOL('d', "detach", &opts.detach, N_("detach HEAD at named commit")),
 490                 OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
 491                 OPT_BOOL(0, "lock", &keep_locked, N_("keep the new working tree locked")),
 492                 OPT_STRING(0, "reason", &lock_reason, N_("string"),
 493                            N_("reason for locking")),
 494                 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
 495                 OPT_PASSTHRU(0, "track", &opt_track, NULL,
 496                              N_("set up tracking mode (see git-branch(1))"),
 497                              PARSE_OPT_NOARG | PARSE_OPT_OPTARG),
 498                 OPT_BOOL(0, "guess-remote", &guess_remote,
 499                          N_("try to match the new branch name with a remote-tracking branch")),
 500                 OPT_END()
 501         };
 502
 503         memset(&opts, 0, sizeof(opts));
 504         opts.checkout = 1;
 505         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 506         if (!!opts.detach + !!new_branch + !!new_branch_force > 1)
 507                 die(_("-b, -B, and --detach are mutually exclusive"));
 508         if (lock_reason && !keep_locked)
 509                 die(_("--reason requires --lock"));
 510         if (lock_reason)
 511                 opts.keep_locked = lock_reason;
 512         else if (keep_locked)
 513                 opts.keep_locked = _("added with --lock");
 514
 515         if (ac < 1 || ac > 2)
 516                 usage_with_options(worktree_usage, options);
 517
 518         path = prefix_filename(prefix, av[0]);
 519         branch = ac < 2 ? "HEAD" : av[1];
 520
 521         if (!strcmp(branch, "-"))
 522                 branch = "@{-1}";
 523
 524         if (new_branch_force) {
 525                 struct strbuf symref = STRBUF_INIT;
 526
 527                 new_branch = new_branch_force;
 528
 529                 if (!opts.force &&
 530                     !strbuf_check_branch_ref(&symref, new_branch) &&
 531                     ref_exists(symref.buf))
 532                         die_if_checked_out(symref.buf, 0);
 533                 strbuf_release(&symref);
 534         }
 535
 536         if (ac < 2 && !new_branch && !opts.detach) {
 537                 const char *s = dwim_branch(path, &new_branch);
 538                 if (s)
 539                         branch = s;
 540         }
 541
 542         if (ac == 2 && !new_branch && !opts.detach) {
 543                 struct object_id oid;
 544                 struct commit *commit;
 545                 const char *remote;
 546
 547                 commit = lookup_commit_reference_by_name(branch);
 548                 if (!commit) {
 549                         remote = unique_tracking_name(branch, &oid, NULL);
 550                         if (remote) {
 551                                 new_branch = branch;
 552                                 branch = remote;
 553                         }
 554                 }
 555         }
 556         if (!opts.quiet)
 557                 print_preparing_worktree_line(opts.detach, branch, new_branch, !!new_branch_force);
 558
 559         if (new_branch) {
 560                 struct child_process cp = CHILD_PROCESS_INIT;
 561                 cp.git_cmd = 1;
 562                 strvec_push(&cp.args, "branch");
 563                 if (new_branch_force)
 564                         strvec_push(&cp.args, "--force");
 565                 if (opts.quiet)
 566                         strvec_push(&cp.args, "--quiet");
 567                 strvec_push(&cp.args, new_branch);
 568                 strvec_push(&cp.args, branch);
 569                 if (opt_track)
 570                         strvec_push(&cp.args, opt_track);
 571                 if (run_command(&cp))
 572                         return -1;
 573                 branch = new_branch;
 574         } else if (opt_track) {
 575                 die(_("--[no-]track can only be used if a new branch is created"));
 576         }
 577
 578         UNLEAK(path);
 579         UNLEAK(opts);
 580         return add_worktree(path, branch, &opts);
 581 }
 582
 583 static void show_worktree_porcelain(struct worktree *wt)
 584 {
 585         const char *reason;
 586
 587         printf("worktree %s\n", wt->path);
 588         if (wt->is_bare)
 589                 printf("bare\n");
 590         else {
 591                 printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
 592                 if (wt->is_detached)
 593                         printf("detached\n");
 594                 else if (wt->head_ref)
 595                         printf("branch %s\n", wt->head_ref);
 596         }
 597
 598         reason = worktree_lock_reason(wt);
 599         if (reason && *reason) {
 600                 struct strbuf sb = STRBUF_INIT;
 601                 quote_c_style(reason, &sb, NULL, 0);
 602                 printf("locked %s\n", sb.buf);
 603                 strbuf_release(&sb);
 604         } else if (reason)
 605                 printf("locked\n");
 606
 607         reason = worktree_prune_reason(wt, expire);
 608         if (reason)
 609                 printf("prunable %s\n", reason);
 610
 611         printf("\n");
 612 }
 613
 614 static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
 615 {
 616         struct strbuf sb = STRBUF_INIT;
 617         int cur_path_len = strlen(wt->path);
 618         int path_adj = cur_path_len - utf8_strwidth(wt->path);
 619         const char *reason;
 620
 621         strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
 622         if (wt->is_bare)
 623                 strbuf_addstr(&sb, "(bare)");
 624         else {
 625                 strbuf_addf(&sb, "%-*s ", abbrev_len,
 626                                 find_unique_abbrev(&wt->head_oid, DEFAULT_ABBREV));
 627                 if (wt->is_detached)
 628                         strbuf_addstr(&sb, "(detached HEAD)");
 629                 else if (wt->head_ref) {
 630                         char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
 631                         strbuf_addf(&sb, "[%s]", ref);
 632                         free(ref);
 633                 } else
 634                         strbuf_addstr(&sb, "(error)");
 635         }
 636
 637         reason = worktree_lock_reason(wt);
 638         if (verbose && reason && *reason)
 639                 strbuf_addf(&sb, "\n\tlocked: %s", reason);
 640         else if (reason)
 641                 strbuf_addstr(&sb, " locked");
 642
 643         reason = worktree_prune_reason(wt, expire);
 644         if (verbose && reason)
 645                 strbuf_addf(&sb, "\n\tprunable: %s", reason);
 646         else if (reason)
 647                 strbuf_addstr(&sb, " prunable");
 648
 649         printf("%s\n", sb.buf);
 650         strbuf_release(&sb);
 651 }
 652
 653 static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
 654 {
 655         int i;
 656
 657         for (i = 0; wt[i]; i++) {
 658                 int sha1_len;
 659                 int path_len = strlen(wt[i]->path);
 660
 661                 if (path_len > *maxlen)
 662                         *maxlen = path_len;
 663                 sha1_len = strlen(find_unique_abbrev(&wt[i]->head_oid, *abbrev));
 664                 if (sha1_len > *abbrev)
 665                         *abbrev = sha1_len;
 666         }
 667 }
 668
 669 static int pathcmp(const void *a_, const void *b_)
 670 {
 671         const struct worktree *const *a = a_;
 672         const struct worktree *const *b = b_;
 673         return fspathcmp((*a)->path, (*b)->path);
 674 }
 675
 676 static void pathsort(struct worktree **wt)
 677 {
 678         int n = 0;
 679         struct worktree **p = wt;
 680
 681         while (*p++)
 682                 n++;
 683         QSORT(wt, n, pathcmp);
 684 }
 685
 686 static int list(int ac, const char **av, const char *prefix)
 687 {
 688         int porcelain = 0;
 689
 690         struct option options[] = {
 691                 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
 692                 OPT__VERBOSE(&verbose, N_("show extended annotations and reasons, if available")),
 693                 OPT_EXPIRY_DATE(0, "expire", &expire,
 694                                 N_("add 'prunable' annotation to worktrees older than <time>")),
 695                 OPT_END()
 696         };
 697
 698         expire = TIME_MAX;
 699         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 700         if (ac)
 701                 usage_with_options(worktree_usage, options);
 702         else if (verbose && porcelain)
 703                 die(_("--verbose and --porcelain are mutually exclusive"));
 704         else {
 705                 struct worktree **worktrees = get_worktrees();
 706                 int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
 707
 708                 /* sort worktrees by path but keep main worktree at top */
 709                 pathsort(worktrees + 1);
 710
 711                 if (!porcelain)
 712                         measure_widths(worktrees, &abbrev, &path_maxlen);
 713
 714                 for (i = 0; worktrees[i]; i++) {
 715                         if (porcelain)
 716                                 show_worktree_porcelain(worktrees[i]);
 717                         else
 718                                 show_worktree(worktrees[i], path_maxlen, abbrev);
 719                 }
 720                 free_worktrees(worktrees);
 721         }
 722         return 0;
 723 }
 724
 725 static int lock_worktree(int ac, const char **av, const char *prefix)
 726 {
 727         const char *reason = "", *old_reason;
 728         struct option options[] = {
 729                 OPT_STRING(0, "reason", &reason, N_("string"),
 730                            N_("reason for locking")),
 731                 OPT_END()
 732         };
 733         struct worktree **worktrees, *wt;
 734
 735         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 736         if (ac != 1)
 737                 usage_with_options(worktree_usage, options);
 738
 739         worktrees = get_worktrees();
 740         wt = find_worktree(worktrees, prefix, av[0]);
 741         if (!wt)
 742                 die(_("'%s' is not a working tree"), av[0]);
 743         if (is_main_worktree(wt))
 744                 die(_("The main working tree cannot be locked or unlocked"));
 745
 746         old_reason = worktree_lock_reason(wt);
 747         if (old_reason) {
 748                 if (*old_reason)
 749                         die(_("'%s' is already locked, reason: %s"),
 750                             av[0], old_reason);
 751                 die(_("'%s' is already locked"), av[0]);
 752         }
 753
 754         write_file(git_common_path("worktrees/%s/locked", wt->id),
 755                    "%s", reason);
 756         free_worktrees(worktrees);
 757         return 0;
 758 }
 759
 760 static int unlock_worktree(int ac, const char **av, const char *prefix)
 761 {
 762         struct option options[] = {
 763                 OPT_END()
 764         };
 765         struct worktree **worktrees, *wt;
 766         int ret;
 767
 768         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 769         if (ac != 1)
 770                 usage_with_options(worktree_usage, options);
 771
 772         worktrees = get_worktrees();
 773         wt = find_worktree(worktrees, prefix, av[0]);
 774         if (!wt)
 775                 die(_("'%s' is not a working tree"), av[0]);
 776         if (is_main_worktree(wt))
 777                 die(_("The main working tree cannot be locked or unlocked"));
 778         if (!worktree_lock_reason(wt))
 779                 die(_("'%s' is not locked"), av[0]);
 780         ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
 781         free_worktrees(worktrees);
 782         return ret;
 783 }
 784
 785 static void validate_no_submodules(const struct worktree *wt)
 786 {
 787         struct index_state istate = { NULL };
 788         struct strbuf path = STRBUF_INIT;
 789         int i, found_submodules = 0;
 790
 791         if (is_directory(worktree_git_path(wt, "modules"))) {
 792                 /*
 793                  * There could be false positives, e.g. the "modules"
 794                  * directory exists but is empty. But it's a rare case and
 795                  * this simpler check is probably good enough for now.
 796                  */
 797                 found_submodules = 1;
 798         } else if (read_index_from(&istate, worktree_git_path(wt, "index"),
 799                                    get_worktree_git_dir(wt)) > 0) {
 800                 for (i = 0; i < istate.cache_nr; i++) {
 801                         struct cache_entry *ce = istate.cache[i];
 802                         int err;
 803
 804                         if (!S_ISGITLINK(ce->ce_mode))
 805                                 continue;
 806
 807                         strbuf_reset(&path);
 808                         strbuf_addf(&path, "%s/%s", wt->path, ce->name);
 809                         if (!is_submodule_populated_gently(path.buf, &err))
 810                                 continue;
 811
 812                         found_submodules = 1;
 813                         break;
 814                 }
 815         }
 816         discard_index(&istate);
 817         strbuf_release(&path);
 818
 819         if (found_submodules)
 820                 die(_("working trees containing submodules cannot be moved or removed"));
 821 }
 822
 823 static int move_worktree(int ac, const char **av, const char *prefix)
 824 {
 825         int force = 0;
 826         struct option options[] = {
 827                 OPT__FORCE(&force,
 828                          N_("force move even if worktree is dirty or locked"),
 829                          PARSE_OPT_NOCOMPLETE),
 830                 OPT_END()
 831         };
 832         struct worktree **worktrees, *wt;
 833         struct strbuf dst = STRBUF_INIT;
 834         struct strbuf errmsg = STRBUF_INIT;
 835         const char *reason = NULL;
 836         char *path;
 837
 838         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 839         if (ac != 2)
 840                 usage_with_options(worktree_usage, options);
 841
 842         path = prefix_filename(prefix, av[1]);
 843         strbuf_addstr(&dst, path);
 844         free(path);
 845
 846         worktrees = get_worktrees();
 847         wt = find_worktree(worktrees, prefix, av[0]);
 848         if (!wt)
 849                 die(_("'%s' is not a working tree"), av[0]);
 850         if (is_main_worktree(wt))
 851                 die(_("'%s' is a main working tree"), av[0]);
 852         if (is_directory(dst.buf)) {
 853                 const char *sep = find_last_dir_sep(wt->path);
 854
 855                 if (!sep)
 856                         die(_("could not figure out destination name from '%s'"),
 857                             wt->path);
 858                 strbuf_trim_trailing_dir_sep(&dst);
 859                 strbuf_addstr(&dst, sep);
 860         }
 861         check_candidate_path(dst.buf, force, worktrees, "move");
 862
 863         validate_no_submodules(wt);
 864
 865         if (force < 2)
 866                 reason = worktree_lock_reason(wt);
 867         if (reason) {
 868                 if (*reason)
 869                         die(_("cannot move a locked working tree, lock reason: %s\nuse 'move -f -f' to override or unlock first"),
 870                             reason);
 871                 die(_("cannot move a locked working tree;\nuse 'move -f -f' to override or unlock first"));
 872         }
 873         if (validate_worktree(wt, &errmsg, 0))
 874                 die(_("validation failed, cannot move working tree: %s"),
 875                     errmsg.buf);
 876         strbuf_release(&errmsg);
 877
 878         if (rename(wt->path, dst.buf) == -1)
 879                 die_errno(_("failed to move '%s' to '%s'"), wt->path, dst.buf);
 880
 881         update_worktree_location(wt, dst.buf);
 882
 883         strbuf_release(&dst);
 884         free_worktrees(worktrees);
 885         return 0;
 886 }
 887
 888 /*
 889  * Note, "git status --porcelain" is used to determine if it's safe to
 890  * delete a whole worktree. "git status" does not ignore user
 891  * configuration, so if a normal "git status" shows "clean" for the
 892  * user, then it's ok to remove it.
 893  *
 894  * This assumption may be a bad one. We may want to ignore
 895  * (potentially bad) user settings and only delete a worktree when
 896  * it's absolutely safe to do so from _our_ point of view because we
 897  * know better.
 898  */
 899 static void check_clean_worktree(struct worktree *wt,
 900                                  const char *original_path)
 901 {
 902         struct child_process cp;
 903         char buf[1];
 904         int ret;
 905
 906         /*
 907          * Until we sort this out, all submodules are "dirty" and
 908          * will abort this function.
 909          */
 910         validate_no_submodules(wt);
 911
 912         child_process_init(&cp);
 913         strvec_pushf(&cp.env_array, "%s=%s/.git",
 914                      GIT_DIR_ENVIRONMENT, wt->path);
 915         strvec_pushf(&cp.env_array, "%s=%s",
 916                      GIT_WORK_TREE_ENVIRONMENT, wt->path);
 917         strvec_pushl(&cp.args, "status",
 918                      "--porcelain", "--ignore-submodules=none",
 919                      NULL);
 920         cp.git_cmd = 1;
 921         cp.dir = wt->path;
 922         cp.out = -1;
 923         ret = start_command(&cp);
 924         if (ret)
 925                 die_errno(_("failed to run 'git status' on '%s'"),
 926                           original_path);
 927         ret = xread(cp.out, buf, sizeof(buf));
 928         if (ret)
 929                 die(_("'%s' contains modified or untracked files, use --force to delete it"),
 930                     original_path);
 931         close(cp.out);
 932         ret = finish_command(&cp);
 933         if (ret)
 934                 die_errno(_("failed to run 'git status' on '%s', code %d"),
 935                           original_path, ret);
 936 }
 937
 938 static int delete_git_work_tree(struct worktree *wt)
 939 {
 940         struct strbuf sb = STRBUF_INIT;
 941         int ret = 0;
 942
 943         strbuf_addstr(&sb, wt->path);
 944         if (remove_dir_recursively(&sb, 0)) {
 945                 error_errno(_("failed to delete '%s'"), sb.buf);
 946                 ret = -1;
 947         }
 948         strbuf_release(&sb);
 949         return ret;
 950 }
 951
 952 static int remove_worktree(int ac, const char **av, const char *prefix)
 953 {
 954         int force = 0;
 955         struct option options[] = {
 956                 OPT__FORCE(&force,
 957                          N_("force removal even if worktree is dirty or locked"),
 958                          PARSE_OPT_NOCOMPLETE),
 959                 OPT_END()
 960         };
 961         struct worktree **worktrees, *wt;
 962         struct strbuf errmsg = STRBUF_INIT;
 963         const char *reason = NULL;
 964         int ret = 0;
 965
 966         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 967         if (ac != 1)
 968                 usage_with_options(worktree_usage, options);
 969
 970         worktrees = get_worktrees();
 971         wt = find_worktree(worktrees, prefix, av[0]);
 972         if (!wt)
 973                 die(_("'%s' is not a working tree"), av[0]);
 974         if (is_main_worktree(wt))
 975                 die(_("'%s' is a main working tree"), av[0]);
 976         if (force < 2)
 977                 reason = worktree_lock_reason(wt);
 978         if (reason) {
 979                 if (*reason)
 980                         die(_("cannot remove a locked working tree, lock reason: %s\nuse 'remove -f -f' to override or unlock first"),
 981                             reason);
 982                 die(_("cannot remove a locked working tree;\nuse 'remove -f -f' to override or unlock first"));
 983         }
 984         if (validate_worktree(wt, &errmsg, WT_VALIDATE_WORKTREE_MISSING_OK))
 985                 die(_("validation failed, cannot remove working tree: %s"),
 986                     errmsg.buf);
 987         strbuf_release(&errmsg);
 988
 989         if (file_exists(wt->path)) {
 990                 if (!force)
 991                         check_clean_worktree(wt, av[0]);
 992
 993                 ret |= delete_git_work_tree(wt);
 994         }
 995         /*
 996          * continue on even if ret is non-zero, there's no going back
 997          * from here.
 998          */
 999         ret |= delete_git_dir(wt->id);
1000         delete_worktrees_dir_if_empty();
1001
1002         free_worktrees(worktrees);
1003         return ret;
1004 }
1005
1006 static void report_repair(int iserr, const char *path, const char *msg, void *cb_data)
1007 {
1008         if (!iserr) {
1009                 printf_ln(_("repair: %s: %s"), msg, path);
1010         } else {
1011                 int *exit_status = (int *)cb_data;
1012                 fprintf_ln(stderr, _("error: %s: %s"), msg, path);
1013                 *exit_status = 1;
1014         }
1015 }
1016
1017 static int repair(int ac, const char **av, const char *prefix)
1018 {
1019         const char **p;
1020         const char *self[] = { ".", NULL };
1021         struct option options[] = {
1022                 OPT_END()
1023         };
1024         int rc = 0;
1025
1026         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
1027         p = ac > 0 ? av : self;
1028         for (; *p; p++)
1029                 repair_worktree_at_path(*p, report_repair, &rc);
1030         repair_worktrees(report_repair, &rc);
1031         return rc;
1032 }
1033
1034 int cmd_worktree(int ac, const char **av, const char *prefix)
1035 {
1036         struct option options[] = {
1037                 OPT_END()
1038         };
1039
1040         git_config(git_worktree_config, NULL);
1041
1042         if (ac < 2)
1043                 usage_with_options(worktree_usage, options);
1044         if (!prefix)
1045                 prefix = "";
1046         if (!strcmp(av[1], "add"))
1047                 return add(ac - 1, av + 1, prefix);
1048         if (!strcmp(av[1], "prune"))
1049                 return prune(ac - 1, av + 1, prefix);
1050         if (!strcmp(av[1], "list"))
1051                 return list(ac - 1, av + 1, prefix);
1052         if (!strcmp(av[1], "lock"))
1053                 return lock_worktree(ac - 1, av + 1, prefix);
1054         if (!strcmp(av[1], "unlock"))
1055                 return unlock_worktree(ac - 1, av + 1, prefix);
1056         if (!strcmp(av[1], "move"))
1057                 return move_worktree(ac - 1, av + 1, prefix);
1058         if (!strcmp(av[1], "remove"))
1059                 return remove_worktree(ac - 1, av + 1, prefix);
1060         if (!strcmp(av[1], "repair"))
1061                 return repair(ac - 1, av + 1, prefix);
1062         usage_with_options(worktree_usage, options);
1063 }