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