builtin/worktree.c

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