builtin/worktree.c

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