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 void copy_filtered_worktree_config(const char *worktree_git_dir)
 240 {
 241         char *from_file = git_pathdup("config.worktree");
 242         char *to_file = xstrfmt("%s/config.worktree", worktree_git_dir);
 243
 244         if (file_exists(from_file)) {
 245                 struct config_set cs = { { 0 } };
 246                 const char *core_worktree;
 247                 int bare;
 248
 249                 if (safe_create_leading_directories(to_file) ||
 250                         copy_file(to_file, from_file, 0666)) {
 251                         error(_("failed to copy worktree config from '%s' to '%s'"),
 252                                 from_file, to_file);
 253                         goto worktree_copy_cleanup;
 254                 }
 255
 256                 git_configset_init(&cs);
 257                 git_configset_add_file(&cs, from_file);
 258
 259                 if (!git_configset_get_bool(&cs, "core.bare", &bare) &&
 260                         bare &&
 261                         git_config_set_multivar_in_file_gently(
 262                                 to_file, "core.bare", NULL, "true", 0))
 263                         error(_("failed to unset '%s' in '%s'"),
 264                                 "core.bare", to_file);
 265                 if (!git_configset_get_value(&cs, "core.worktree", &core_worktree) &&
 266                         git_config_set_in_file_gently(to_file,
 267                                                         "core.worktree", NULL))
 268                         error(_("failed to unset '%s' in '%s'"),
 269                                 "core.worktree", to_file);
 270
 271                 git_configset_clear(&cs);
 272         }
 273
 274 worktree_copy_cleanup:
 275         free(from_file);
 276         free(to_file);
 277 }
 278
 279 static int add_worktree(const char *path, const char *refname,
 280                         const struct add_opts *opts)
 281 {
 282         struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
 283         struct strbuf sb = STRBUF_INIT, realpath = STRBUF_INIT;
 284         const char *name;
 285         struct child_process cp = CHILD_PROCESS_INIT;
 286         struct strvec child_env = STRVEC_INIT;
 287         unsigned int counter = 0;
 288         int len, ret;
 289         struct strbuf symref = STRBUF_INIT;
 290         struct commit *commit = NULL;
 291         int is_branch = 0;
 292         struct strbuf sb_name = STRBUF_INIT;
 293         struct worktree **worktrees;
 294
 295         worktrees = get_worktrees();
 296         check_candidate_path(path, opts->force, worktrees, "add");
 297         free_worktrees(worktrees);
 298         worktrees = NULL;
 299
 300         /* is 'refname' a branch or commit? */
 301         if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
 302             ref_exists(symref.buf)) {
 303                 is_branch = 1;
 304                 if (!opts->force)
 305                         die_if_checked_out(symref.buf, 0);
 306         }
 307         commit = lookup_commit_reference_by_name(refname);
 308         if (!commit)
 309                 die(_("invalid reference: %s"), refname);
 310
 311         name = worktree_basename(path, &len);
 312         strbuf_add(&sb, name, path + len - name);
 313         sanitize_refname_component(sb.buf, &sb_name);
 314         if (!sb_name.len)
 315                 BUG("How come '%s' becomes empty after sanitization?", sb.buf);
 316         strbuf_reset(&sb);
 317         name = sb_name.buf;
 318         git_path_buf(&sb_repo, "worktrees/%s", name);
 319         len = sb_repo.len;
 320         if (safe_create_leading_directories_const(sb_repo.buf))
 321                 die_errno(_("could not create leading directories of '%s'"),
 322                           sb_repo.buf);
 323
 324         while (mkdir(sb_repo.buf, 0777)) {
 325                 counter++;
 326                 if ((errno != EEXIST) || !counter /* overflow */)
 327                         die_errno(_("could not create directory of '%s'"),
 328                                   sb_repo.buf);
 329                 strbuf_setlen(&sb_repo, len);
 330                 strbuf_addf(&sb_repo, "%d", counter);
 331         }
 332         name = strrchr(sb_repo.buf, '/') + 1;
 333
 334         junk_pid = getpid();
 335         atexit(remove_junk);
 336         sigchain_push_common(remove_junk_on_signal);
 337
 338         junk_git_dir = xstrdup(sb_repo.buf);
 339         is_junk = 1;
 340
 341         /*
 342          * lock the incomplete repo so prune won't delete it, unlock
 343          * after the preparation is over.
 344          */
 345         strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 346         if (opts->keep_locked)
 347                 write_file(sb.buf, "%s", opts->keep_locked);
 348         else
 349                 write_file(sb.buf, _("initializing"));
 350
 351         strbuf_addf(&sb_git, "%s/.git", path);
 352         if (safe_create_leading_directories_const(sb_git.buf))
 353                 die_errno(_("could not create leading directories of '%s'"),
 354                           sb_git.buf);
 355         junk_work_tree = xstrdup(path);
 356
 357         strbuf_reset(&sb);
 358         strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
 359         strbuf_realpath(&realpath, sb_git.buf, 1);
 360         write_file(sb.buf, "%s", realpath.buf);
 361         strbuf_realpath(&realpath, get_git_common_dir(), 1);
 362         write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
 363                    realpath.buf, name);
 364         /*
 365          * This is to keep resolve_ref() happy. We need a valid HEAD
 366          * or is_git_directory() will reject the directory. Any value which
 367          * looks like an object ID will do since it will be immediately
 368          * replaced by the symbolic-ref or update-ref invocation in the new
 369          * worktree.
 370          */
 371         strbuf_reset(&sb);
 372         strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
 373         write_file(sb.buf, "%s", oid_to_hex(null_oid()));
 374         strbuf_reset(&sb);
 375         strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
 376         write_file(sb.buf, "../..");
 377
 378         /*
 379          * If the current worktree has sparse-checkout enabled, then copy
 380          * the sparse-checkout patterns from the current worktree.
 381          */
 382         if (core_apply_sparse_checkout) {
 383                 char *from_file = git_pathdup("info/sparse-checkout");
 384                 char *to_file = xstrfmt("%s/info/sparse-checkout",
 385                                         sb_repo.buf);
 386
 387                 if (file_exists(from_file)) {
 388                         if (safe_create_leading_directories(to_file) ||
 389                             copy_file(to_file, from_file, 0666))
 390                                 error(_("failed to copy '%s' to '%s'; sparse-checkout may not work correctly"),
 391                                       from_file, to_file);
 392                 }
 393
 394                 free(from_file);
 395                 free(to_file);
 396         }
 397
 398         /*
 399          * If we are using worktree config, then copy all current config
 400          * values from the current worktree into the new one, that way the
 401          * new worktree behaves the same as this one.
 402          */
 403         if (repository_format_worktree_config)
 404                 copy_filtered_worktree_config(sb_repo.buf);
 405
 406         strvec_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
 407         strvec_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
 408         cp.git_cmd = 1;
 409
 410         if (!is_branch)
 411                 strvec_pushl(&cp.args, "update-ref", "HEAD",
 412                              oid_to_hex(&commit->object.oid), NULL);
 413         else {
 414                 strvec_pushl(&cp.args, "symbolic-ref", "HEAD",
 415                              symref.buf, NULL);
 416                 if (opts->quiet)
 417                         strvec_push(&cp.args, "--quiet");
 418         }
 419
 420         strvec_pushv(&cp.env_array, child_env.v);
 421         ret = run_command(&cp);
 422         if (ret)
 423                 goto done;
 424
 425         if (opts->checkout) {
 426                 struct child_process cp = CHILD_PROCESS_INIT;
 427                 cp.git_cmd = 1;
 428                 strvec_pushl(&cp.args, "reset", "--hard", "--no-recurse-submodules", NULL);
 429                 if (opts->quiet)
 430                         strvec_push(&cp.args, "--quiet");
 431                 strvec_pushv(&cp.env_array, child_env.v);
 432                 ret = run_command(&cp);
 433                 if (ret)
 434                         goto done;
 435         }
 436
 437         is_junk = 0;
 438         FREE_AND_NULL(junk_work_tree);
 439         FREE_AND_NULL(junk_git_dir);
 440
 441 done:
 442         if (ret || !opts->keep_locked) {
 443                 strbuf_reset(&sb);
 444                 strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 445                 unlink_or_warn(sb.buf);
 446         }
 447
 448         /*
 449          * Hook failure does not warrant worktree deletion, so run hook after
 450          * is_junk is cleared, but do return appropriate code when hook fails.
 451          */
 452         if (!ret && opts->checkout) {
 453                 const char *hook = find_hook("post-checkout");
 454                 if (hook) {
 455                         const char *env[] = { "GIT_DIR", "GIT_WORK_TREE", NULL };
 456                         struct child_process cp = CHILD_PROCESS_INIT;
 457                         cp.no_stdin = 1;
 458                         cp.stdout_to_stderr = 1;
 459                         cp.dir = path;
 460                         strvec_pushv(&cp.env_array, env);
 461                         cp.trace2_hook_name = "post-checkout";
 462                         strvec_pushl(&cp.args, absolute_path(hook),
 463                                      oid_to_hex(null_oid()),
 464                                      oid_to_hex(&commit->object.oid),
 465                                      "1", NULL);
 466                         ret = run_command(&cp);
 467                 }
 468         }
 469
 470         strvec_clear(&child_env);
 471         strbuf_release(&sb);
 472         strbuf_release(&symref);
 473         strbuf_release(&sb_repo);
 474         strbuf_release(&sb_git);
 475         strbuf_release(&sb_name);
 476         strbuf_release(&realpath);
 477         return ret;
 478 }
 479
 480 static void print_preparing_worktree_line(int detach,
 481                                           const char *branch,
 482                                           const char *new_branch,
 483                                           int force_new_branch)
 484 {
 485         if (force_new_branch) {
 486                 struct commit *commit = lookup_commit_reference_by_name(new_branch);
 487                 if (!commit)
 488                         fprintf_ln(stderr, _("Preparing worktree (new branch '%s')"), new_branch);
 489                 else
 490                         fprintf_ln(stderr, _("Preparing worktree (resetting branch '%s'; was at %s)"),
 491                                   new_branch,
 492                                   find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 493         } else if (new_branch) {
 494                 fprintf_ln(stderr, _("Preparing worktree (new branch '%s')"), new_branch);
 495         } else {
 496                 struct strbuf s = STRBUF_INIT;
 497                 if (!detach && !strbuf_check_branch_ref(&s, branch) &&
 498                     ref_exists(s.buf))
 499                         fprintf_ln(stderr, _("Preparing worktree (checking out '%s')"),
 500                                   branch);
 501                 else {
 502                         struct commit *commit = lookup_commit_reference_by_name(branch);
 503                         if (!commit)
 504                                 die(_("invalid reference: %s"), branch);
 505                         fprintf_ln(stderr, _("Preparing worktree (detached HEAD %s)"),
 506                                   find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV));
 507                 }
 508                 strbuf_release(&s);
 509         }
 510 }
 511
 512 static const char *dwim_branch(const char *path, const char **new_branch)
 513 {
 514         int n;
 515         int branch_exists;
 516         const char *s = worktree_basename(path, &n);
 517         const char *branchname = xstrndup(s, n);
 518         struct strbuf ref = STRBUF_INIT;
 519
 520         UNLEAK(branchname);
 521
 522         branch_exists = !strbuf_check_branch_ref(&ref, branchname) &&
 523                         ref_exists(ref.buf);
 524         strbuf_release(&ref);
 525         if (branch_exists)
 526                 return branchname;
 527
 528         *new_branch = branchname;
 529         if (guess_remote) {
 530                 struct object_id oid;
 531                 const char *remote =
 532                         unique_tracking_name(*new_branch, &oid, NULL);
 533                 return remote;
 534         }
 535         return NULL;
 536 }
 537
 538 static int add(int ac, const char **av, const char *prefix)
 539 {
 540         struct add_opts opts;
 541         const char *new_branch_force = NULL;
 542         char *path;
 543         const char *branch;
 544         const char *new_branch = NULL;
 545         const char *opt_track = NULL;
 546         const char *lock_reason = NULL;
 547         int keep_locked = 0;
 548         struct option options[] = {
 549                 OPT__FORCE(&opts.force,
 550                            N_("checkout <branch> even if already checked out in other worktree"),
 551                            PARSE_OPT_NOCOMPLETE),
 552                 OPT_STRING('b', NULL, &new_branch, N_("branch"),
 553                            N_("create a new branch")),
 554                 OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
 555                            N_("create or reset a branch")),
 556                 OPT_BOOL('d', "detach", &opts.detach, N_("detach HEAD at named commit")),
 557                 OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
 558                 OPT_BOOL(0, "lock", &keep_locked, N_("keep the new working tree locked")),
 559                 OPT_STRING(0, "reason", &lock_reason, N_("string"),
 560                            N_("reason for locking")),
 561                 OPT__QUIET(&opts.quiet, N_("suppress progress reporting")),
 562                 OPT_PASSTHRU(0, "track", &opt_track, NULL,
 563                              N_("set up tracking mode (see git-branch(1))"),
 564                              PARSE_OPT_NOARG | PARSE_OPT_OPTARG),
 565                 OPT_BOOL(0, "guess-remote", &guess_remote,
 566                          N_("try to match the new branch name with a remote-tracking branch")),
 567                 OPT_END()
 568         };
 569
 570         memset(&opts, 0, sizeof(opts));
 571         opts.checkout = 1;
 572         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 573         if (!!opts.detach + !!new_branch + !!new_branch_force > 1)
 574                 die(_("options '%s', '%s', and '%s' cannot be used together"), "-b", "-B", "--detach");
 575         if (lock_reason && !keep_locked)
 576                 die(_("the option '%s' requires '%s'"), "--reason", "--lock");
 577         if (lock_reason)
 578                 opts.keep_locked = lock_reason;
 579         else if (keep_locked)
 580                 opts.keep_locked = _("added with --lock");
 581
 582         if (ac < 1 || ac > 2)
 583                 usage_with_options(worktree_usage, options);
 584
 585         path = prefix_filename(prefix, av[0]);
 586         branch = ac < 2 ? "HEAD" : av[1];
 587
 588         if (!strcmp(branch, "-"))
 589                 branch = "@{-1}";
 590
 591         if (new_branch_force) {
 592                 struct strbuf symref = STRBUF_INIT;
 593
 594                 new_branch = new_branch_force;
 595
 596                 if (!opts.force &&
 597                     !strbuf_check_branch_ref(&symref, new_branch) &&
 598                     ref_exists(symref.buf))
 599                         die_if_checked_out(symref.buf, 0);
 600                 strbuf_release(&symref);
 601         }
 602
 603         if (ac < 2 && !new_branch && !opts.detach) {
 604                 const char *s = dwim_branch(path, &new_branch);
 605                 if (s)
 606                         branch = s;
 607         }
 608
 609         if (ac == 2 && !new_branch && !opts.detach) {
 610                 struct object_id oid;
 611                 struct commit *commit;
 612                 const char *remote;
 613
 614                 commit = lookup_commit_reference_by_name(branch);
 615                 if (!commit) {
 616                         remote = unique_tracking_name(branch, &oid, NULL);
 617                         if (remote) {
 618                                 new_branch = branch;
 619                                 branch = remote;
 620                         }
 621                 }
 622         }
 623         if (!opts.quiet)
 624                 print_preparing_worktree_line(opts.detach, branch, new_branch, !!new_branch_force);
 625
 626         if (new_branch) {
 627                 struct child_process cp = CHILD_PROCESS_INIT;
 628                 cp.git_cmd = 1;
 629                 strvec_push(&cp.args, "branch");
 630                 if (new_branch_force)
 631                         strvec_push(&cp.args, "--force");
 632                 if (opts.quiet)
 633                         strvec_push(&cp.args, "--quiet");
 634                 strvec_push(&cp.args, new_branch);
 635                 strvec_push(&cp.args, branch);
 636                 if (opt_track)
 637                         strvec_push(&cp.args, opt_track);
 638                 if (run_command(&cp))
 639                         return -1;
 640                 branch = new_branch;
 641         } else if (opt_track) {
 642                 die(_("--[no-]track can only be used if a new branch is created"));
 643         }
 644
 645         UNLEAK(path);
 646         UNLEAK(opts);
 647         return add_worktree(path, branch, &opts);
 648 }
 649
 650 static void show_worktree_porcelain(struct worktree *wt)
 651 {
 652         const char *reason;
 653
 654         printf("worktree %s\n", wt->path);
 655         if (wt->is_bare)
 656                 printf("bare\n");
 657         else {
 658                 printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
 659                 if (wt->is_detached)
 660                         printf("detached\n");
 661                 else if (wt->head_ref)
 662                         printf("branch %s\n", wt->head_ref);
 663         }
 664
 665         reason = worktree_lock_reason(wt);
 666         if (reason && *reason) {
 667                 struct strbuf sb = STRBUF_INIT;
 668                 quote_c_style(reason, &sb, NULL, 0);
 669                 printf("locked %s\n", sb.buf);
 670                 strbuf_release(&sb);
 671         } else if (reason)
 672                 printf("locked\n");
 673
 674         reason = worktree_prune_reason(wt, expire);
 675         if (reason)
 676                 printf("prunable %s\n", reason);
 677
 678         printf("\n");
 679 }
 680
 681 static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
 682 {
 683         struct strbuf sb = STRBUF_INIT;
 684         int cur_path_len = strlen(wt->path);
 685         int path_adj = cur_path_len - utf8_strwidth(wt->path);
 686         const char *reason;
 687
 688         strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
 689         if (wt->is_bare)
 690                 strbuf_addstr(&sb, "(bare)");
 691         else {
 692                 strbuf_addf(&sb, "%-*s ", abbrev_len,
 693                                 find_unique_abbrev(&wt->head_oid, DEFAULT_ABBREV));
 694                 if (wt->is_detached)
 695                         strbuf_addstr(&sb, "(detached HEAD)");
 696                 else if (wt->head_ref) {
 697                         char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
 698                         strbuf_addf(&sb, "[%s]", ref);
 699                         free(ref);
 700                 } else
 701                         strbuf_addstr(&sb, "(error)");
 702         }
 703
 704         reason = worktree_lock_reason(wt);
 705         if (verbose && reason && *reason)
 706                 strbuf_addf(&sb, "\n\tlocked: %s", reason);
 707         else if (reason)
 708                 strbuf_addstr(&sb, " locked");
 709
 710         reason = worktree_prune_reason(wt, expire);
 711         if (verbose && reason)
 712                 strbuf_addf(&sb, "\n\tprunable: %s", reason);
 713         else if (reason)
 714                 strbuf_addstr(&sb, " prunable");
 715
 716         printf("%s\n", sb.buf);
 717         strbuf_release(&sb);
 718 }
 719
 720 static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
 721 {
 722         int i;
 723
 724         for (i = 0; wt[i]; i++) {
 725                 int sha1_len;
 726                 int path_len = strlen(wt[i]->path);
 727
 728                 if (path_len > *maxlen)
 729                         *maxlen = path_len;
 730                 sha1_len = strlen(find_unique_abbrev(&wt[i]->head_oid, *abbrev));
 731                 if (sha1_len > *abbrev)
 732                         *abbrev = sha1_len;
 733         }
 734 }
 735
 736 static int pathcmp(const void *a_, const void *b_)
 737 {
 738         const struct worktree *const *a = a_;
 739         const struct worktree *const *b = b_;
 740         return fspathcmp((*a)->path, (*b)->path);
 741 }
 742
 743 static void pathsort(struct worktree **wt)
 744 {
 745         int n = 0;
 746         struct worktree **p = wt;
 747
 748         while (*p++)
 749                 n++;
 750         QSORT(wt, n, pathcmp);
 751 }
 752
 753 static int list(int ac, const char **av, const char *prefix)
 754 {
 755         int porcelain = 0;
 756
 757         struct option options[] = {
 758                 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
 759                 OPT__VERBOSE(&verbose, N_("show extended annotations and reasons, if available")),
 760                 OPT_EXPIRY_DATE(0, "expire", &expire,
 761                                 N_("add 'prunable' annotation to worktrees older than <time>")),
 762                 OPT_END()
 763         };
 764
 765         expire = TIME_MAX;
 766         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 767         if (ac)
 768                 usage_with_options(worktree_usage, options);
 769         else if (verbose && porcelain)
 770                 die(_("options '%s' and '%s' cannot be used together"), "--verbose", "--porcelain");
 771         else {
 772                 struct worktree **worktrees = get_worktrees();
 773                 int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
 774
 775                 /* sort worktrees by path but keep main worktree at top */
 776                 pathsort(worktrees + 1);
 777
 778                 if (!porcelain)
 779                         measure_widths(worktrees, &abbrev, &path_maxlen);
 780
 781                 for (i = 0; worktrees[i]; i++) {
 782                         if (porcelain)
 783                                 show_worktree_porcelain(worktrees[i]);
 784                         else
 785                                 show_worktree(worktrees[i], path_maxlen, abbrev);
 786                 }
 787                 free_worktrees(worktrees);
 788         }
 789         return 0;
 790 }
 791
 792 static int lock_worktree(int ac, const char **av, const char *prefix)
 793 {
 794         const char *reason = "", *old_reason;
 795         struct option options[] = {
 796                 OPT_STRING(0, "reason", &reason, N_("string"),
 797                            N_("reason for locking")),
 798                 OPT_END()
 799         };
 800         struct worktree **worktrees, *wt;
 801
 802         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 803         if (ac != 1)
 804                 usage_with_options(worktree_usage, options);
 805
 806         worktrees = get_worktrees();
 807         wt = find_worktree(worktrees, prefix, av[0]);
 808         if (!wt)
 809                 die(_("'%s' is not a working tree"), av[0]);
 810         if (is_main_worktree(wt))
 811                 die(_("The main working tree cannot be locked or unlocked"));
 812
 813         old_reason = worktree_lock_reason(wt);
 814         if (old_reason) {
 815                 if (*old_reason)
 816                         die(_("'%s' is already locked, reason: %s"),
 817                             av[0], old_reason);
 818                 die(_("'%s' is already locked"), av[0]);
 819         }
 820
 821         write_file(git_common_path("worktrees/%s/locked", wt->id),
 822                    "%s", reason);
 823         free_worktrees(worktrees);
 824         return 0;
 825 }
 826
 827 static int unlock_worktree(int ac, const char **av, const char *prefix)
 828 {
 829         struct option options[] = {
 830                 OPT_END()
 831         };
 832         struct worktree **worktrees, *wt;
 833         int ret;
 834
 835         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 836         if (ac != 1)
 837                 usage_with_options(worktree_usage, options);
 838
 839         worktrees = get_worktrees();
 840         wt = find_worktree(worktrees, prefix, av[0]);
 841         if (!wt)
 842                 die(_("'%s' is not a working tree"), av[0]);
 843         if (is_main_worktree(wt))
 844                 die(_("The main working tree cannot be locked or unlocked"));
 845         if (!worktree_lock_reason(wt))
 846                 die(_("'%s' is not locked"), av[0]);
 847         ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
 848         free_worktrees(worktrees);
 849         return ret;
 850 }
 851
 852 static void validate_no_submodules(const struct worktree *wt)
 853 {
 854         struct index_state istate = { NULL };
 855         struct strbuf path = STRBUF_INIT;
 856         int i, found_submodules = 0;
 857
 858         if (is_directory(worktree_git_path(wt, "modules"))) {
 859                 /*
 860                  * There could be false positives, e.g. the "modules"
 861                  * directory exists but is empty. But it's a rare case and
 862                  * this simpler check is probably good enough for now.
 863                  */
 864                 found_submodules = 1;
 865         } else if (read_index_from(&istate, worktree_git_path(wt, "index"),
 866                                    get_worktree_git_dir(wt)) > 0) {
 867                 for (i = 0; i < istate.cache_nr; i++) {
 868                         struct cache_entry *ce = istate.cache[i];
 869                         int err;
 870
 871                         if (!S_ISGITLINK(ce->ce_mode))
 872                                 continue;
 873
 874                         strbuf_reset(&path);
 875                         strbuf_addf(&path, "%s/%s", wt->path, ce->name);
 876                         if (!is_submodule_populated_gently(path.buf, &err))
 877                                 continue;
 878
 879                         found_submodules = 1;
 880                         break;
 881                 }
 882         }
 883         discard_index(&istate);
 884         strbuf_release(&path);
 885
 886         if (found_submodules)
 887                 die(_("working trees containing submodules cannot be moved or removed"));
 888 }
 889
 890 static int move_worktree(int ac, const char **av, const char *prefix)
 891 {
 892         int force = 0;
 893         struct option options[] = {
 894                 OPT__FORCE(&force,
 895                          N_("force move even if worktree is dirty or locked"),
 896                          PARSE_OPT_NOCOMPLETE),
 897                 OPT_END()
 898         };
 899         struct worktree **worktrees, *wt;
 900         struct strbuf dst = STRBUF_INIT;
 901         struct strbuf errmsg = STRBUF_INIT;
 902         const char *reason = NULL;
 903         char *path;
 904
 905         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 906         if (ac != 2)
 907                 usage_with_options(worktree_usage, options);
 908
 909         path = prefix_filename(prefix, av[1]);
 910         strbuf_addstr(&dst, path);
 911         free(path);
 912
 913         worktrees = get_worktrees();
 914         wt = find_worktree(worktrees, prefix, av[0]);
 915         if (!wt)
 916                 die(_("'%s' is not a working tree"), av[0]);
 917         if (is_main_worktree(wt))
 918                 die(_("'%s' is a main working tree"), av[0]);
 919         if (is_directory(dst.buf)) {
 920                 const char *sep = find_last_dir_sep(wt->path);
 921
 922                 if (!sep)
 923                         die(_("could not figure out destination name from '%s'"),
 924                             wt->path);
 925                 strbuf_trim_trailing_dir_sep(&dst);
 926                 strbuf_addstr(&dst, sep);
 927         }
 928         check_candidate_path(dst.buf, force, worktrees, "move");
 929
 930         validate_no_submodules(wt);
 931
 932         if (force < 2)
 933                 reason = worktree_lock_reason(wt);
 934         if (reason) {
 935                 if (*reason)
 936                         die(_("cannot move a locked working tree, lock reason: %s\nuse 'move -f -f' to override or unlock first"),
 937                             reason);
 938                 die(_("cannot move a locked working tree;\nuse 'move -f -f' to override or unlock first"));
 939         }
 940         if (validate_worktree(wt, &errmsg, 0))
 941                 die(_("validation failed, cannot move working tree: %s"),
 942                     errmsg.buf);
 943         strbuf_release(&errmsg);
 944
 945         if (rename(wt->path, dst.buf) == -1)
 946                 die_errno(_("failed to move '%s' to '%s'"), wt->path, dst.buf);
 947
 948         update_worktree_location(wt, dst.buf);
 949
 950         strbuf_release(&dst);
 951         free_worktrees(worktrees);
 952         return 0;
 953 }
 954
 955 /*
 956  * Note, "git status --porcelain" is used to determine if it's safe to
 957  * delete a whole worktree. "git status" does not ignore user
 958  * configuration, so if a normal "git status" shows "clean" for the
 959  * user, then it's ok to remove it.
 960  *
 961  * This assumption may be a bad one. We may want to ignore
 962  * (potentially bad) user settings and only delete a worktree when
 963  * it's absolutely safe to do so from _our_ point of view because we
 964  * know better.
 965  */
 966 static void check_clean_worktree(struct worktree *wt,
 967                                  const char *original_path)
 968 {
 969         struct child_process cp;
 970         char buf[1];
 971         int ret;
 972
 973         /*
 974          * Until we sort this out, all submodules are "dirty" and
 975          * will abort this function.
 976          */
 977         validate_no_submodules(wt);
 978
 979         child_process_init(&cp);
 980         strvec_pushf(&cp.env_array, "%s=%s/.git",
 981                      GIT_DIR_ENVIRONMENT, wt->path);
 982         strvec_pushf(&cp.env_array, "%s=%s",
 983                      GIT_WORK_TREE_ENVIRONMENT, wt->path);
 984         strvec_pushl(&cp.args, "status",
 985                      "--porcelain", "--ignore-submodules=none",
 986                      NULL);
 987         cp.git_cmd = 1;
 988         cp.dir = wt->path;
 989         cp.out = -1;
 990         ret = start_command(&cp);
 991         if (ret)
 992                 die_errno(_("failed to run 'git status' on '%s'"),
 993                           original_path);
 994         ret = xread(cp.out, buf, sizeof(buf));
 995         if (ret)
 996                 die(_("'%s' contains modified or untracked files, use --force to delete it"),
 997                     original_path);
 998         close(cp.out);
 999         ret = finish_command(&cp);
1000         if (ret)
1001                 die_errno(_("failed to run 'git status' on '%s', code %d"),
1002                           original_path, ret);
1003 }
1004
1005 static int delete_git_work_tree(struct worktree *wt)
1006 {
1007         struct strbuf sb = STRBUF_INIT;
1008         int ret = 0;
1009
1010         strbuf_addstr(&sb, wt->path);
1011         if (remove_dir_recursively(&sb, 0)) {
1012                 error_errno(_("failed to delete '%s'"), sb.buf);
1013                 ret = -1;
1014         }
1015         strbuf_release(&sb);
1016         return ret;
1017 }
1018
1019 static int remove_worktree(int ac, const char **av, const char *prefix)
1020 {
1021         int force = 0;
1022         struct option options[] = {
1023                 OPT__FORCE(&force,
1024                          N_("force removal even if worktree is dirty or locked"),
1025                          PARSE_OPT_NOCOMPLETE),
1026                 OPT_END()
1027         };
1028         struct worktree **worktrees, *wt;
1029         struct strbuf errmsg = STRBUF_INIT;
1030         const char *reason = NULL;
1031         int ret = 0;
1032
1033         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
1034         if (ac != 1)
1035                 usage_with_options(worktree_usage, options);
1036
1037         worktrees = get_worktrees();
1038         wt = find_worktree(worktrees, prefix, av[0]);
1039         if (!wt)
1040                 die(_("'%s' is not a working tree"), av[0]);
1041         if (is_main_worktree(wt))
1042                 die(_("'%s' is a main working tree"), av[0]);
1043         if (force < 2)
1044                 reason = worktree_lock_reason(wt);
1045         if (reason) {
1046                 if (*reason)
1047                         die(_("cannot remove a locked working tree, lock reason: %s\nuse 'remove -f -f' to override or unlock first"),
1048                             reason);
1049                 die(_("cannot remove a locked working tree;\nuse 'remove -f -f' to override or unlock first"));
1050         }
1051         if (validate_worktree(wt, &errmsg, WT_VALIDATE_WORKTREE_MISSING_OK))
1052                 die(_("validation failed, cannot remove working tree: %s"),
1053                     errmsg.buf);
1054         strbuf_release(&errmsg);
1055
1056         if (file_exists(wt->path)) {
1057                 if (!force)
1058                         check_clean_worktree(wt, av[0]);
1059
1060                 ret |= delete_git_work_tree(wt);
1061         }
1062         /*
1063          * continue on even if ret is non-zero, there's no going back
1064          * from here.
1065          */
1066         ret |= delete_git_dir(wt->id);
1067         delete_worktrees_dir_if_empty();
1068
1069         free_worktrees(worktrees);
1070         return ret;
1071 }
1072
1073 static void report_repair(int iserr, const char *path, const char *msg, void *cb_data)
1074 {
1075         if (!iserr) {
1076                 fprintf_ln(stderr, _("repair: %s: %s"), msg, path);
1077         } else {
1078                 int *exit_status = (int *)cb_data;
1079                 fprintf_ln(stderr, _("error: %s: %s"), msg, path);
1080                 *exit_status = 1;
1081         }
1082 }
1083
1084 static int repair(int ac, const char **av, const char *prefix)
1085 {
1086         const char **p;
1087         const char *self[] = { ".", NULL };
1088         struct option options[] = {
1089                 OPT_END()
1090         };
1091         int rc = 0;
1092
1093         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
1094         p = ac > 0 ? av : self;
1095         for (; *p; p++)
1096                 repair_worktree_at_path(*p, report_repair, &rc);
1097         repair_worktrees(report_repair, &rc);
1098         return rc;
1099 }
1100
1101 int cmd_worktree(int ac, const char **av, const char *prefix)
1102 {
1103         struct option options[] = {
1104                 OPT_END()
1105         };
1106
1107         git_config(git_worktree_config, NULL);
1108
1109         if (ac < 2)
1110                 usage_with_options(worktree_usage, options);
1111         if (!prefix)
1112                 prefix = "";
1113         if (!strcmp(av[1], "add"))
1114                 return add(ac - 1, av + 1, prefix);
1115         if (!strcmp(av[1], "prune"))
1116                 return prune(ac - 1, av + 1, prefix);
1117         if (!strcmp(av[1], "list"))
1118                 return list(ac - 1, av + 1, prefix);
1119         if (!strcmp(av[1], "lock"))
1120                 return lock_worktree(ac - 1, av + 1, prefix);
1121         if (!strcmp(av[1], "unlock"))
1122                 return unlock_worktree(ac - 1, av + 1, prefix);
1123         if (!strcmp(av[1], "move"))
1124                 return move_worktree(ac - 1, av + 1, prefix);
1125         if (!strcmp(av[1], "remove"))
1126                 return remove_worktree(ac - 1, av + 1, prefix);
1127         if (!strcmp(av[1], "repair"))
1128                 return repair(ac - 1, av + 1, prefix);
1129         usage_with_options(worktree_usage, options);
1130 }