builtin/worktree.c

   1 #include "cache.h"
   2 #include "config.h"
   3 #include "builtin.h"
   4 #include "dir.h"
   5 #include "parse-options.h"
   6 #include "argv-array.h"
   7 #include "branch.h"
   8 #include "refs.h"
   9 #include "run-command.h"
  10 #include "sigchain.h"
  11 #include "refs.h"
  12 #include "utf8.h"
  13 #include "worktree.h"
  14
  15 static const char * const worktree_usage[] = {
  16         N_("git worktree add [<options>] <path> [<branch>]"),
  17         N_("git worktree list [<options>]"),
  18         N_("git worktree lock [<options>] <path>"),
  19         N_("git worktree prune [<options>]"),
  20         N_("git worktree unlock <path>"),
  21         NULL
  22 };
  23
  24 struct add_opts {
  25         int force;
  26         int detach;
  27         int checkout;
  28         int keep_locked;
  29         const char *new_branch;
  30         int force_new_branch;
  31 };
  32
  33 static int show_only;
  34 static int verbose;
  35 static timestamp_t expire;
  36
  37 static int prune_worktree(const char *id, struct strbuf *reason)
  38 {
  39         struct stat st;
  40         char *path;
  41         int fd;
  42         size_t len;
  43         ssize_t read_result;
  44
  45         if (!is_directory(git_path("worktrees/%s", id))) {
  46                 strbuf_addf(reason, _("Removing worktrees/%s: not a valid directory"), id);
  47                 return 1;
  48         }
  49         if (file_exists(git_path("worktrees/%s/locked", id)))
  50                 return 0;
  51         if (stat(git_path("worktrees/%s/gitdir", id), &st)) {
  52                 strbuf_addf(reason, _("Removing worktrees/%s: gitdir file does not exist"), id);
  53                 return 1;
  54         }
  55         fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY);
  56         if (fd < 0) {
  57                 strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
  58                             id, strerror(errno));
  59                 return 1;
  60         }
  61         len = xsize_t(st.st_size);
  62         path = xmallocz(len);
  63
  64         read_result = read_in_full(fd, path, len);
  65         if (read_result < 0) {
  66                 strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
  67                             id, strerror(errno));
  68                 close(fd);
  69                 free(path);
  70                 return 1;
  71         }
  72         close(fd);
  73
  74         if (read_result != len) {
  75                 strbuf_addf(reason,
  76                             _("Removing worktrees/%s: short read (expected %"PRIuMAX" bytes, read %"PRIuMAX")"),
  77                             id, (uintmax_t)len, (uintmax_t)read_result);
  78                 free(path);
  79                 return 1;
  80         }
  81         while (len && (path[len - 1] == '\n' || path[len - 1] == '\r'))
  82                 len--;
  83         if (!len) {
  84                 strbuf_addf(reason, _("Removing worktrees/%s: invalid gitdir file"), id);
  85                 free(path);
  86                 return 1;
  87         }
  88         path[len] = '\0';
  89         if (!file_exists(path)) {
  90                 struct stat st_link;
  91                 free(path);
  92                 /*
  93                  * the repo is moved manually and has not been
  94                  * accessed since?
  95                  */
  96                 if (!stat(git_path("worktrees/%s/link", id), &st_link) &&
  97                     st_link.st_nlink > 1)
  98                         return 0;
  99                 if (st.st_mtime <= expire) {
 100                         strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id);
 101                         return 1;
 102                 } else {
 103                         return 0;
 104                 }
 105         }
 106         free(path);
 107         return 0;
 108 }
 109
 110 static void prune_worktrees(void)
 111 {
 112         struct strbuf reason = STRBUF_INIT;
 113         struct strbuf path = STRBUF_INIT;
 114         DIR *dir = opendir(git_path("worktrees"));
 115         struct dirent *d;
 116         int ret;
 117         if (!dir)
 118                 return;
 119         while ((d = readdir(dir)) != NULL) {
 120                 if (is_dot_or_dotdot(d->d_name))
 121                         continue;
 122                 strbuf_reset(&reason);
 123                 if (!prune_worktree(d->d_name, &reason))
 124                         continue;
 125                 if (show_only || verbose)
 126                         printf("%s\n", reason.buf);
 127                 if (show_only)
 128                         continue;
 129                 git_path_buf(&path, "worktrees/%s", d->d_name);
 130                 ret = remove_dir_recursively(&path, 0);
 131                 if (ret < 0 && errno == ENOTDIR)
 132                         ret = unlink(path.buf);
 133                 if (ret)
 134                         error_errno(_("failed to remove '%s'"), path.buf);
 135         }
 136         closedir(dir);
 137         if (!show_only)
 138                 rmdir(git_path("worktrees"));
 139         strbuf_release(&reason);
 140         strbuf_release(&path);
 141 }
 142
 143 static int prune(int ac, const char **av, const char *prefix)
 144 {
 145         struct option options[] = {
 146                 OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
 147                 OPT__VERBOSE(&verbose, N_("report pruned working trees")),
 148                 OPT_EXPIRY_DATE(0, "expire", &expire,
 149                                 N_("expire working trees older than <time>")),
 150                 OPT_END()
 151         };
 152
 153         expire = TIME_MAX;
 154         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 155         if (ac)
 156                 usage_with_options(worktree_usage, options);
 157         prune_worktrees();
 158         return 0;
 159 }
 160
 161 static char *junk_work_tree;
 162 static char *junk_git_dir;
 163 static int is_junk;
 164 static pid_t junk_pid;
 165
 166 static void remove_junk(void)
 167 {
 168         struct strbuf sb = STRBUF_INIT;
 169         if (!is_junk || getpid() != junk_pid)
 170                 return;
 171         if (junk_git_dir) {
 172                 strbuf_addstr(&sb, junk_git_dir);
 173                 remove_dir_recursively(&sb, 0);
 174                 strbuf_reset(&sb);
 175         }
 176         if (junk_work_tree) {
 177                 strbuf_addstr(&sb, junk_work_tree);
 178                 remove_dir_recursively(&sb, 0);
 179         }
 180         strbuf_release(&sb);
 181 }
 182
 183 static void remove_junk_on_signal(int signo)
 184 {
 185         remove_junk();
 186         sigchain_pop(signo);
 187         raise(signo);
 188 }
 189
 190 static const char *worktree_basename(const char *path, int *olen)
 191 {
 192         const char *name;
 193         int len;
 194
 195         len = strlen(path);
 196         while (len && is_dir_sep(path[len - 1]))
 197                 len--;
 198
 199         for (name = path + len - 1; name > path; name--)
 200                 if (is_dir_sep(*name)) {
 201                         name++;
 202                         break;
 203                 }
 204
 205         *olen = len;
 206         return name;
 207 }
 208
 209 static int add_worktree(const char *path, const char *refname,
 210                         const struct add_opts *opts)
 211 {
 212         struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
 213         struct strbuf sb = STRBUF_INIT;
 214         const char *name;
 215         struct stat st;
 216         struct child_process cp = CHILD_PROCESS_INIT;
 217         struct argv_array child_env = ARGV_ARRAY_INIT;
 218         int counter = 0, len, ret;
 219         struct strbuf symref = STRBUF_INIT;
 220         struct commit *commit = NULL;
 221
 222         if (file_exists(path) && !is_empty_dir(path))
 223                 die(_("'%s' already exists"), path);
 224
 225         /* is 'refname' a branch or commit? */
 226         if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
 227                  ref_exists(symref.buf)) { /* it's a branch */
 228                 if (!opts->force)
 229                         die_if_checked_out(symref.buf, 0);
 230         } else { /* must be a commit */
 231                 commit = lookup_commit_reference_by_name(refname);
 232                 if (!commit)
 233                         die(_("invalid reference: %s"), refname);
 234         }
 235
 236         name = worktree_basename(path, &len);
 237         git_path_buf(&sb_repo, "worktrees/%.*s", (int)(path + len - name), name);
 238         len = sb_repo.len;
 239         if (safe_create_leading_directories_const(sb_repo.buf))
 240                 die_errno(_("could not create leading directories of '%s'"),
 241                           sb_repo.buf);
 242         while (!stat(sb_repo.buf, &st)) {
 243                 counter++;
 244                 strbuf_setlen(&sb_repo, len);
 245                 strbuf_addf(&sb_repo, "%d", counter);
 246         }
 247         name = strrchr(sb_repo.buf, '/') + 1;
 248
 249         junk_pid = getpid();
 250         atexit(remove_junk);
 251         sigchain_push_common(remove_junk_on_signal);
 252
 253         if (mkdir(sb_repo.buf, 0777))
 254                 die_errno(_("could not create directory of '%s'"), sb_repo.buf);
 255         junk_git_dir = xstrdup(sb_repo.buf);
 256         is_junk = 1;
 257
 258         /*
 259          * lock the incomplete repo so prune won't delete it, unlock
 260          * after the preparation is over.
 261          */
 262         strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 263         if (!opts->keep_locked)
 264                 write_file(sb.buf, "initializing");
 265         else
 266                 write_file(sb.buf, "added with --lock");
 267
 268         strbuf_addf(&sb_git, "%s/.git", path);
 269         if (safe_create_leading_directories_const(sb_git.buf))
 270                 die_errno(_("could not create leading directories of '%s'"),
 271                           sb_git.buf);
 272         junk_work_tree = xstrdup(path);
 273
 274         strbuf_reset(&sb);
 275         strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
 276         write_file(sb.buf, "%s", real_path(sb_git.buf));
 277         write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
 278                    real_path(get_git_common_dir()), name);
 279         /*
 280          * This is to keep resolve_ref() happy. We need a valid HEAD
 281          * or is_git_directory() will reject the directory. Any value which
 282          * looks like an object ID will do since it will be immediately
 283          * replaced by the symbolic-ref or update-ref invocation in the new
 284          * worktree.
 285          */
 286         strbuf_reset(&sb);
 287         strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
 288         write_file(sb.buf, "%s", sha1_to_hex(null_sha1));
 289         strbuf_reset(&sb);
 290         strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
 291         write_file(sb.buf, "../..");
 292
 293         fprintf_ln(stderr, _("Preparing %s (identifier %s)"), path, name);
 294
 295         argv_array_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
 296         argv_array_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
 297         cp.git_cmd = 1;
 298
 299         if (commit)
 300                 argv_array_pushl(&cp.args, "update-ref", "HEAD",
 301                                  oid_to_hex(&commit->object.oid), NULL);
 302         else
 303                 argv_array_pushl(&cp.args, "symbolic-ref", "HEAD",
 304                                  symref.buf, NULL);
 305         cp.env = child_env.argv;
 306         ret = run_command(&cp);
 307         if (ret)
 308                 goto done;
 309
 310         if (opts->checkout) {
 311                 cp.argv = NULL;
 312                 argv_array_clear(&cp.args);
 313                 argv_array_pushl(&cp.args, "reset", "--hard", NULL);
 314                 cp.env = child_env.argv;
 315                 ret = run_command(&cp);
 316                 if (ret)
 317                         goto done;
 318         }
 319
 320         is_junk = 0;
 321         FREE_AND_NULL(junk_work_tree);
 322         FREE_AND_NULL(junk_git_dir);
 323
 324 done:
 325         if (ret || !opts->keep_locked) {
 326                 strbuf_reset(&sb);
 327                 strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 328                 unlink_or_warn(sb.buf);
 329         }
 330         argv_array_clear(&child_env);
 331         strbuf_release(&sb);
 332         strbuf_release(&symref);
 333         strbuf_release(&sb_repo);
 334         strbuf_release(&sb_git);
 335         return ret;
 336 }
 337
 338 static int add(int ac, const char **av, const char *prefix)
 339 {
 340         struct add_opts opts;
 341         const char *new_branch_force = NULL;
 342         char *path;
 343         const char *branch;
 344         const char *opt_track = NULL;
 345         struct option options[] = {
 346                 OPT__FORCE(&opts.force, N_("checkout <branch> even if already checked out in other worktree")),
 347                 OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
 348                            N_("create a new branch")),
 349                 OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
 350                            N_("create or reset a branch")),
 351                 OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")),
 352                 OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
 353                 OPT_BOOL(0, "lock", &opts.keep_locked, N_("keep the new working tree locked")),
 354                 OPT_PASSTHRU(0, "track", &opt_track, NULL,
 355                              N_("set up tracking mode (see git-branch(1))"),
 356                              PARSE_OPT_NOARG | PARSE_OPT_OPTARG),
 357                 OPT_END()
 358         };
 359
 360         memset(&opts, 0, sizeof(opts));
 361         opts.checkout = 1;
 362         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 363         if (!!opts.detach + !!opts.new_branch + !!new_branch_force > 1)
 364                 die(_("-b, -B, and --detach are mutually exclusive"));
 365         if (ac < 1 || ac > 2)
 366                 usage_with_options(worktree_usage, options);
 367
 368         path = prefix_filename(prefix, av[0]);
 369         branch = ac < 2 ? "HEAD" : av[1];
 370
 371         if (!strcmp(branch, "-"))
 372                 branch = "@{-1}";
 373
 374         opts.force_new_branch = !!new_branch_force;
 375         if (opts.force_new_branch) {
 376                 struct strbuf symref = STRBUF_INIT;
 377
 378                 opts.new_branch = new_branch_force;
 379
 380                 if (!opts.force &&
 381                     !strbuf_check_branch_ref(&symref, opts.new_branch) &&
 382                     ref_exists(symref.buf))
 383                         die_if_checked_out(symref.buf, 0);
 384                 strbuf_release(&symref);
 385         }
 386
 387         if (ac < 2 && !opts.new_branch && !opts.detach) {
 388                 int n;
 389                 const char *s = worktree_basename(path, &n);
 390                 opts.new_branch = xstrndup(s, n);
 391         }
 392
 393         if (opts.new_branch) {
 394                 struct child_process cp = CHILD_PROCESS_INIT;
 395                 cp.git_cmd = 1;
 396                 argv_array_push(&cp.args, "branch");
 397                 if (opts.force_new_branch)
 398                         argv_array_push(&cp.args, "--force");
 399                 argv_array_push(&cp.args, opts.new_branch);
 400                 argv_array_push(&cp.args, branch);
 401                 if (opt_track)
 402                         argv_array_push(&cp.args, opt_track);
 403                 if (run_command(&cp))
 404                         return -1;
 405                 branch = opts.new_branch;
 406         } else if (opt_track) {
 407                 die(_("--[no-]track can only be used if a new branch is created"));
 408         }
 409
 410         UNLEAK(path);
 411         UNLEAK(opts);
 412         return add_worktree(path, branch, &opts);
 413 }
 414
 415 static void show_worktree_porcelain(struct worktree *wt)
 416 {
 417         printf("worktree %s\n", wt->path);
 418         if (wt->is_bare)
 419                 printf("bare\n");
 420         else {
 421                 printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
 422                 if (wt->is_detached)
 423                         printf("detached\n");
 424                 else if (wt->head_ref)
 425                         printf("branch %s\n", wt->head_ref);
 426         }
 427         printf("\n");
 428 }
 429
 430 static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
 431 {
 432         struct strbuf sb = STRBUF_INIT;
 433         int cur_path_len = strlen(wt->path);
 434         int path_adj = cur_path_len - utf8_strwidth(wt->path);
 435
 436         strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
 437         if (wt->is_bare)
 438                 strbuf_addstr(&sb, "(bare)");
 439         else {
 440                 strbuf_addf(&sb, "%-*s ", abbrev_len,
 441                                 find_unique_abbrev(wt->head_oid.hash, DEFAULT_ABBREV));
 442                 if (wt->is_detached)
 443                         strbuf_addstr(&sb, "(detached HEAD)");
 444                 else if (wt->head_ref) {
 445                         char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
 446                         strbuf_addf(&sb, "[%s]", ref);
 447                         free(ref);
 448                 } else
 449                         strbuf_addstr(&sb, "(error)");
 450         }
 451         printf("%s\n", sb.buf);
 452
 453         strbuf_release(&sb);
 454 }
 455
 456 static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
 457 {
 458         int i;
 459
 460         for (i = 0; wt[i]; i++) {
 461                 int sha1_len;
 462                 int path_len = strlen(wt[i]->path);
 463
 464                 if (path_len > *maxlen)
 465                         *maxlen = path_len;
 466                 sha1_len = strlen(find_unique_abbrev(wt[i]->head_oid.hash, *abbrev));
 467                 if (sha1_len > *abbrev)
 468                         *abbrev = sha1_len;
 469         }
 470 }
 471
 472 static int list(int ac, const char **av, const char *prefix)
 473 {
 474         int porcelain = 0;
 475
 476         struct option options[] = {
 477                 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
 478                 OPT_END()
 479         };
 480
 481         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 482         if (ac)
 483                 usage_with_options(worktree_usage, options);
 484         else {
 485                 struct worktree **worktrees = get_worktrees(GWT_SORT_LINKED);
 486                 int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
 487
 488                 if (!porcelain)
 489                         measure_widths(worktrees, &abbrev, &path_maxlen);
 490
 491                 for (i = 0; worktrees[i]; i++) {
 492                         if (porcelain)
 493                                 show_worktree_porcelain(worktrees[i]);
 494                         else
 495                                 show_worktree(worktrees[i], path_maxlen, abbrev);
 496                 }
 497                 free_worktrees(worktrees);
 498         }
 499         return 0;
 500 }
 501
 502 static int lock_worktree(int ac, const char **av, const char *prefix)
 503 {
 504         const char *reason = "", *old_reason;
 505         struct option options[] = {
 506                 OPT_STRING(0, "reason", &reason, N_("string"),
 507                            N_("reason for locking")),
 508                 OPT_END()
 509         };
 510         struct worktree **worktrees, *wt;
 511
 512         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 513         if (ac != 1)
 514                 usage_with_options(worktree_usage, options);
 515
 516         worktrees = get_worktrees(0);
 517         wt = find_worktree(worktrees, prefix, av[0]);
 518         if (!wt)
 519                 die(_("'%s' is not a working tree"), av[0]);
 520         if (is_main_worktree(wt))
 521                 die(_("The main working tree cannot be locked or unlocked"));
 522
 523         old_reason = is_worktree_locked(wt);
 524         if (old_reason) {
 525                 if (*old_reason)
 526                         die(_("'%s' is already locked, reason: %s"),
 527                             av[0], old_reason);
 528                 die(_("'%s' is already locked"), av[0]);
 529         }
 530
 531         write_file(git_common_path("worktrees/%s/locked", wt->id),
 532                    "%s", reason);
 533         free_worktrees(worktrees);
 534         return 0;
 535 }
 536
 537 static int unlock_worktree(int ac, const char **av, const char *prefix)
 538 {
 539         struct option options[] = {
 540                 OPT_END()
 541         };
 542         struct worktree **worktrees, *wt;
 543         int ret;
 544
 545         ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 546         if (ac != 1)
 547                 usage_with_options(worktree_usage, options);
 548
 549         worktrees = get_worktrees(0);
 550         wt = find_worktree(worktrees, prefix, av[0]);
 551         if (!wt)
 552                 die(_("'%s' is not a working tree"), av[0]);
 553         if (is_main_worktree(wt))
 554                 die(_("The main working tree cannot be locked or unlocked"));
 555         if (!is_worktree_locked(wt))
 556                 die(_("'%s' is not locked"), av[0]);
 557         ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
 558         free_worktrees(worktrees);
 559         return ret;
 560 }
 561
 562 int cmd_worktree(int ac, const char **av, const char *prefix)
 563 {
 564         struct option options[] = {
 565                 OPT_END()
 566         };
 567
 568         git_config(git_default_config, NULL);
 569
 570         if (ac < 2)
 571                 usage_with_options(worktree_usage, options);
 572         if (!prefix)
 573                 prefix = "";
 574         if (!strcmp(av[1], "add"))
 575                 return add(ac - 1, av + 1, prefix);
 576         if (!strcmp(av[1], "prune"))
 577                 return prune(ac - 1, av + 1, prefix);
 578         if (!strcmp(av[1], "list"))
 579                 return list(ac - 1, av + 1, prefix);
 580         if (!strcmp(av[1], "lock"))
 581                 return lock_worktree(ac - 1, av + 1, prefix);
 582         if (!strcmp(av[1], "unlock"))
 583                 return unlock_worktree(ac - 1, av + 1, prefix);
 584         usage_with_options(worktree_usage, options);
 585 }