Andrew's git - gitweb.git/blob - 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
  15static 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
  24struct 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
  33static int show_only;
  34static int verbose;
  35static timestamp_t expire;
  36
  37static 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
 110static 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
 143static 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
 161static char *junk_work_tree;
 162static char *junk_git_dir;
 163static int is_junk;
 164static pid_t junk_pid;
 165
 166static 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
 183static void remove_junk_on_signal(int signo)
 184{
 185        remove_junk();
 186        sigchain_pop(signo);
 187        raise(signo);
 188}
 189
 190static 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
 209static 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        int is_branch = 0;
 222
 223        if (file_exists(path) && !is_empty_dir(path))
 224                die(_("'%s' already exists"), path);
 225
 226        /* is 'refname' a branch or commit? */
 227        if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) &&
 228            ref_exists(symref.buf)) {
 229                is_branch = 1;
 230                if (!opts->force)
 231                        die_if_checked_out(symref.buf, 0);
 232        }
 233        commit = lookup_commit_reference_by_name(refname);
 234        if (!commit)
 235                die(_("invalid reference: %s"), refname);
 236
 237        name = worktree_basename(path, &len);
 238        git_path_buf(&sb_repo, "worktrees/%.*s", (int)(path + len - name), name);
 239        len = sb_repo.len;
 240        if (safe_create_leading_directories_const(sb_repo.buf))
 241                die_errno(_("could not create leading directories of '%s'"),
 242                          sb_repo.buf);
 243        while (!stat(sb_repo.buf, &st)) {
 244                counter++;
 245                strbuf_setlen(&sb_repo, len);
 246                strbuf_addf(&sb_repo, "%d", counter);
 247        }
 248        name = strrchr(sb_repo.buf, '/') + 1;
 249
 250        junk_pid = getpid();
 251        atexit(remove_junk);
 252        sigchain_push_common(remove_junk_on_signal);
 253
 254        if (mkdir(sb_repo.buf, 0777))
 255                die_errno(_("could not create directory of '%s'"), sb_repo.buf);
 256        junk_git_dir = xstrdup(sb_repo.buf);
 257        is_junk = 1;
 258
 259        /*
 260         * lock the incomplete repo so prune won't delete it, unlock
 261         * after the preparation is over.
 262         */
 263        strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 264        if (!opts->keep_locked)
 265                write_file(sb.buf, "initializing");
 266        else
 267                write_file(sb.buf, "added with --lock");
 268
 269        strbuf_addf(&sb_git, "%s/.git", path);
 270        if (safe_create_leading_directories_const(sb_git.buf))
 271                die_errno(_("could not create leading directories of '%s'"),
 272                          sb_git.buf);
 273        junk_work_tree = xstrdup(path);
 274
 275        strbuf_reset(&sb);
 276        strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
 277        write_file(sb.buf, "%s", real_path(sb_git.buf));
 278        write_file(sb_git.buf, "gitdir: %s/worktrees/%s",
 279                   real_path(get_git_common_dir()), name);
 280        /*
 281         * This is to keep resolve_ref() happy. We need a valid HEAD
 282         * or is_git_directory() will reject the directory. Any value which
 283         * looks like an object ID will do since it will be immediately
 284         * replaced by the symbolic-ref or update-ref invocation in the new
 285         * worktree.
 286         */
 287        strbuf_reset(&sb);
 288        strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
 289        write_file(sb.buf, "%s", sha1_to_hex(null_sha1));
 290        strbuf_reset(&sb);
 291        strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
 292        write_file(sb.buf, "../..");
 293
 294        fprintf_ln(stderr, _("Preparing %s (identifier %s)"), path, name);
 295
 296        argv_array_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf);
 297        argv_array_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
 298        cp.git_cmd = 1;
 299
 300        if (!is_branch)
 301                argv_array_pushl(&cp.args, "update-ref", "HEAD",
 302                                 oid_to_hex(&commit->object.oid), NULL);
 303        else
 304                argv_array_pushl(&cp.args, "symbolic-ref", "HEAD",
 305                                 symref.buf, NULL);
 306        cp.env = child_env.argv;
 307        ret = run_command(&cp);
 308        if (ret)
 309                goto done;
 310
 311        if (opts->checkout) {
 312                cp.argv = NULL;
 313                argv_array_clear(&cp.args);
 314                argv_array_pushl(&cp.args, "reset", "--hard", NULL);
 315                cp.env = child_env.argv;
 316                ret = run_command(&cp);
 317                if (ret)
 318                        goto done;
 319        }
 320
 321        is_junk = 0;
 322        FREE_AND_NULL(junk_work_tree);
 323        FREE_AND_NULL(junk_git_dir);
 324
 325done:
 326        if (ret || !opts->keep_locked) {
 327                strbuf_reset(&sb);
 328                strbuf_addf(&sb, "%s/locked", sb_repo.buf);
 329                unlink_or_warn(sb.buf);
 330        }
 331
 332        /*
 333         * Hook failure does not warrant worktree deletion, so run hook after
 334         * is_junk is cleared, but do return appropriate code when hook fails.
 335         */
 336        if (!ret && opts->checkout) {
 337                const char *hook = find_hook("post-checkout");
 338                if (hook) {
 339                        const char *env[] = { "GIT_DIR", "GIT_WORK_TREE", NULL };
 340                        cp.git_cmd = 0;
 341                        cp.no_stdin = 1;
 342                        cp.stdout_to_stderr = 1;
 343                        cp.dir = path;
 344                        cp.env = env;
 345                        cp.argv = NULL;
 346                        argv_array_pushl(&cp.args, absolute_path(hook),
 347                                         oid_to_hex(&null_oid),
 348                                         oid_to_hex(&commit->object.oid),
 349                                         "1", NULL);
 350                        ret = run_command(&cp);
 351                }
 352        }
 353
 354        argv_array_clear(&child_env);
 355        strbuf_release(&sb);
 356        strbuf_release(&symref);
 357        strbuf_release(&sb_repo);
 358        strbuf_release(&sb_git);
 359        return ret;
 360}
 361
 362static int add(int ac, const char **av, const char *prefix)
 363{
 364        struct add_opts opts;
 365        const char *new_branch_force = NULL;
 366        char *path;
 367        const char *branch;
 368        struct option options[] = {
 369                OPT__FORCE(&opts.force, N_("checkout <branch> even if already checked out in other worktree")),
 370                OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
 371                           N_("create a new branch")),
 372                OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
 373                           N_("create or reset a branch")),
 374                OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")),
 375                OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
 376                OPT_BOOL(0, "lock", &opts.keep_locked, N_("keep the new working tree locked")),
 377                OPT_END()
 378        };
 379
 380        memset(&opts, 0, sizeof(opts));
 381        opts.checkout = 1;
 382        ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 383        if (!!opts.detach + !!opts.new_branch + !!new_branch_force > 1)
 384                die(_("-b, -B, and --detach are mutually exclusive"));
 385        if (ac < 1 || ac > 2)
 386                usage_with_options(worktree_usage, options);
 387
 388        path = prefix_filename(prefix, av[0]);
 389        branch = ac < 2 ? "HEAD" : av[1];
 390
 391        if (!strcmp(branch, "-"))
 392                branch = "@{-1}";
 393
 394        opts.force_new_branch = !!new_branch_force;
 395        if (opts.force_new_branch) {
 396                struct strbuf symref = STRBUF_INIT;
 397
 398                opts.new_branch = new_branch_force;
 399
 400                if (!opts.force &&
 401                    !strbuf_check_branch_ref(&symref, opts.new_branch) &&
 402                    ref_exists(symref.buf))
 403                        die_if_checked_out(symref.buf, 0);
 404                strbuf_release(&symref);
 405        }
 406
 407        if (ac < 2 && !opts.new_branch && !opts.detach) {
 408                int n;
 409                const char *s = worktree_basename(path, &n);
 410                opts.new_branch = xstrndup(s, n);
 411        }
 412
 413        if (opts.new_branch) {
 414                struct child_process cp = CHILD_PROCESS_INIT;
 415                cp.git_cmd = 1;
 416                argv_array_push(&cp.args, "branch");
 417                if (opts.force_new_branch)
 418                        argv_array_push(&cp.args, "--force");
 419                argv_array_push(&cp.args, opts.new_branch);
 420                argv_array_push(&cp.args, branch);
 421                if (run_command(&cp))
 422                        return -1;
 423                branch = opts.new_branch;
 424        }
 425
 426        UNLEAK(path);
 427        UNLEAK(opts);
 428        return add_worktree(path, branch, &opts);
 429}
 430
 431static void show_worktree_porcelain(struct worktree *wt)
 432{
 433        printf("worktree %s\n", wt->path);
 434        if (wt->is_bare)
 435                printf("bare\n");
 436        else {
 437                printf("HEAD %s\n", oid_to_hex(&wt->head_oid));
 438                if (wt->is_detached)
 439                        printf("detached\n");
 440                else if (wt->head_ref)
 441                        printf("branch %s\n", wt->head_ref);
 442        }
 443        printf("\n");
 444}
 445
 446static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len)
 447{
 448        struct strbuf sb = STRBUF_INIT;
 449        int cur_path_len = strlen(wt->path);
 450        int path_adj = cur_path_len - utf8_strwidth(wt->path);
 451
 452        strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path);
 453        if (wt->is_bare)
 454                strbuf_addstr(&sb, "(bare)");
 455        else {
 456                strbuf_addf(&sb, "%-*s ", abbrev_len,
 457                                find_unique_abbrev(wt->head_oid.hash, DEFAULT_ABBREV));
 458                if (wt->is_detached)
 459                        strbuf_addstr(&sb, "(detached HEAD)");
 460                else if (wt->head_ref) {
 461                        char *ref = shorten_unambiguous_ref(wt->head_ref, 0);
 462                        strbuf_addf(&sb, "[%s]", ref);
 463                        free(ref);
 464                } else
 465                        strbuf_addstr(&sb, "(error)");
 466        }
 467        printf("%s\n", sb.buf);
 468
 469        strbuf_release(&sb);
 470}
 471
 472static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen)
 473{
 474        int i;
 475
 476        for (i = 0; wt[i]; i++) {
 477                int sha1_len;
 478                int path_len = strlen(wt[i]->path);
 479
 480                if (path_len > *maxlen)
 481                        *maxlen = path_len;
 482                sha1_len = strlen(find_unique_abbrev(wt[i]->head_oid.hash, *abbrev));
 483                if (sha1_len > *abbrev)
 484                        *abbrev = sha1_len;
 485        }
 486}
 487
 488static int list(int ac, const char **av, const char *prefix)
 489{
 490        int porcelain = 0;
 491
 492        struct option options[] = {
 493                OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
 494                OPT_END()
 495        };
 496
 497        ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 498        if (ac)
 499                usage_with_options(worktree_usage, options);
 500        else {
 501                struct worktree **worktrees = get_worktrees(GWT_SORT_LINKED);
 502                int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i;
 503
 504                if (!porcelain)
 505                        measure_widths(worktrees, &abbrev, &path_maxlen);
 506
 507                for (i = 0; worktrees[i]; i++) {
 508                        if (porcelain)
 509                                show_worktree_porcelain(worktrees[i]);
 510                        else
 511                                show_worktree(worktrees[i], path_maxlen, abbrev);
 512                }
 513                free_worktrees(worktrees);
 514        }
 515        return 0;
 516}
 517
 518static int lock_worktree(int ac, const char **av, const char *prefix)
 519{
 520        const char *reason = "", *old_reason;
 521        struct option options[] = {
 522                OPT_STRING(0, "reason", &reason, N_("string"),
 523                           N_("reason for locking")),
 524                OPT_END()
 525        };
 526        struct worktree **worktrees, *wt;
 527
 528        ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 529        if (ac != 1)
 530                usage_with_options(worktree_usage, options);
 531
 532        worktrees = get_worktrees(0);
 533        wt = find_worktree(worktrees, prefix, av[0]);
 534        if (!wt)
 535                die(_("'%s' is not a working tree"), av[0]);
 536        if (is_main_worktree(wt))
 537                die(_("The main working tree cannot be locked or unlocked"));
 538
 539        old_reason = is_worktree_locked(wt);
 540        if (old_reason) {
 541                if (*old_reason)
 542                        die(_("'%s' is already locked, reason: %s"),
 543                            av[0], old_reason);
 544                die(_("'%s' is already locked"), av[0]);
 545        }
 546
 547        write_file(git_common_path("worktrees/%s/locked", wt->id),
 548                   "%s", reason);
 549        free_worktrees(worktrees);
 550        return 0;
 551}
 552
 553static int unlock_worktree(int ac, const char **av, const char *prefix)
 554{
 555        struct option options[] = {
 556                OPT_END()
 557        };
 558        struct worktree **worktrees, *wt;
 559        int ret;
 560
 561        ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 562        if (ac != 1)
 563                usage_with_options(worktree_usage, options);
 564
 565        worktrees = get_worktrees(0);
 566        wt = find_worktree(worktrees, prefix, av[0]);
 567        if (!wt)
 568                die(_("'%s' is not a working tree"), av[0]);
 569        if (is_main_worktree(wt))
 570                die(_("The main working tree cannot be locked or unlocked"));
 571        if (!is_worktree_locked(wt))
 572                die(_("'%s' is not locked"), av[0]);
 573        ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id));
 574        free_worktrees(worktrees);
 575        return ret;
 576}
 577
 578int cmd_worktree(int ac, const char **av, const char *prefix)
 579{
 580        struct option options[] = {
 581                OPT_END()
 582        };
 583
 584        git_config(git_default_config, NULL);
 585
 586        if (ac < 2)
 587                usage_with_options(worktree_usage, options);
 588        if (!prefix)
 589                prefix = "";
 590        if (!strcmp(av[1], "add"))
 591                return add(ac - 1, av + 1, prefix);
 592        if (!strcmp(av[1], "prune"))
 593                return prune(ac - 1, av + 1, prefix);
 594        if (!strcmp(av[1], "list"))
 595                return list(ac - 1, av + 1, prefix);
 596        if (!strcmp(av[1], "lock"))
 597                return lock_worktree(ac - 1, av + 1, prefix);
 598        if (!strcmp(av[1], "unlock"))
 599                return unlock_worktree(ac - 1, av + 1, prefix);
 600        usage_with_options(worktree_usage, options);
 601}