Andrew's git - gitweb.git/blob

7021d025851a48ad8e05406394240091e0a78e41
   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 "refs.h"
  13#include "utf8.h"
  14#include "worktree.h"
  15
  16static const char * const worktree_usage[] = {
  17        N_("git worktree add [<options>] <path> [<branch>]"),
  18        N_("git worktree list [<options>]"),
  19        N_("git worktree lock [<options>] <path>"),
  20        N_("git worktree prune [<options>]"),
  21        N_("git worktree unlock <path>"),
  22        NULL
  23};
  24
  25struct add_opts {
  26        int force;
  27        int detach;
  28        int checkout;
  29        int keep_locked;
  30        const char *new_branch;
  31        int force_new_branch;
  32};
  33
  34static int show_only;
  35static int verbose;
  36static timestamp_t expire;
  37
  38static int prune_worktree(const char *id, struct strbuf *reason)
  39{
  40        struct stat st;
  41        char *path;
  42        int fd;
  43        size_t len;
  44        ssize_t read_result;
  45
  46        if (!is_directory(git_path("worktrees/%s", id))) {
  47                strbuf_addf(reason, _("Removing worktrees/%s: not a valid directory"), id);
  48                return 1;
  49        }
  50        if (file_exists(git_path("worktrees/%s/locked", id)))
  51                return 0;
  52        if (stat(git_path("worktrees/%s/gitdir", id), &st)) {
  53                strbuf_addf(reason, _("Removing worktrees/%s: gitdir file does not exist"), id);
  54                return 1;
  55        }
  56        fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY);
  57        if (fd < 0) {
  58                strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
  59                            id, strerror(errno));
  60                return 1;
  61        }
  62        len = xsize_t(st.st_size);
  63        path = xmallocz(len);
  64
  65        read_result = read_in_full(fd, path, len);
  66        if (read_result < 0) {
  67                strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
  68                            id, strerror(errno));
  69                close(fd);
  70                free(path);
  71                return 1;
  72        }
  73        close(fd);
  74
  75        if (read_result != len) {
  76                strbuf_addf(reason,
  77                            _("Removing worktrees/%s: short read (expected %"PRIuMAX" bytes, read %"PRIuMAX")"),
  78                            id, (uintmax_t)len, (uintmax_t)read_result);
  79                free(path);
  80                return 1;
  81        }
  82        while (len && (path[len - 1] == '\n' || path[len - 1] == '\r'))
  83                len--;
  84        if (!len) {
  85                strbuf_addf(reason, _("Removing worktrees/%s: invalid gitdir file"), id);
  86                free(path);
  87                return 1;
  88        }
  89        path[len] = '\0';
  90        if (!file_exists(path)) {
  91                struct stat st_link;
  92                free(path);
  93                /*
  94                 * the repo is moved manually and has not been
  95                 * accessed since?
  96                 */
  97                if (!stat(git_path("worktrees/%s/link", id), &st_link) &&
  98                    st_link.st_nlink > 1)
  99                        return 0;
 100                if (st.st_mtime <= expire) {
 101                        strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id);
 102                        return 1;
 103                } else {
 104                        return 0;
 105                }
 106        }
 107        free(path);
 108        return 0;
 109}
 110
 111static void prune_worktrees(void)
 112{
 113        struct strbuf reason = STRBUF_INIT;
 114        struct strbuf path = STRBUF_INIT;
 115        DIR *dir = opendir(git_path("worktrees"));
 116        struct dirent *d;
 117        int ret;
 118        if (!dir)
 119                return;
 120        while ((d = readdir(dir)) != NULL) {
 121                if (is_dot_or_dotdot(d->d_name))
 122                        continue;
 123                strbuf_reset(&reason);
 124                if (!prune_worktree(d->d_name, &reason))
 125                        continue;
 126                if (show_only || verbose)
 127                        printf("%s\n", reason.buf);
 128                if (show_only)
 129                        continue;
 130                git_path_buf(&path, "worktrees/%s", d->d_name);
 131                ret = remove_dir_recursively(&path, 0);
 132                if (ret < 0 && errno == ENOTDIR)
 133                        ret = unlink(path.buf);
 134                if (ret)
 135                        error_errno(_("failed to remove '%s'"), path.buf);
 136        }
 137        closedir(dir);
 138        if (!show_only)
 139                rmdir(git_path("worktrees"));
 140        strbuf_release(&reason);
 141        strbuf_release(&path);
 142}
 143
 144static int prune(int ac, const char **av, const char *prefix)
 145{
 146        struct option options[] = {
 147                OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
 148                OPT__VERBOSE(&verbose, N_("report pruned working trees")),
 149                OPT_EXPIRY_DATE(0, "expire", &expire,
 150                                N_("expire working trees older than <time>")),
 151                OPT_END()
 152        };
 153
 154        expire = TIME_MAX;
 155        ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 156        if (ac)
 157                usage_with_options(worktree_usage, options);
 158        prune_worktrees();
 159        return 0;
 160}
 161
 162static char *junk_work_tree;
 163static char *junk_git_dir;
 164static int is_junk;
 165static pid_t junk_pid;
 166
 167static void remove_junk(void)
 168{
 169        struct strbuf sb = STRBUF_INIT;
 170        if (!is_junk || getpid() != junk_pid)
 171                return;
 172        if (junk_git_dir) {
 173                strbuf_addstr(&sb, junk_git_dir);
 174                remove_dir_recursively(&sb, 0);
 175                strbuf_reset(&sb);
 176        }
 177        if (junk_work_tree) {
 178                strbuf_addstr(&sb, junk_work_tree);
 179                remove_dir_recursively(&sb, 0);
 180        }
 181        strbuf_release(&sb);
 182}
 183
 184static void remove_junk_on_signal(int signo)
 185{
 186        remove_junk();
 187        sigchain_pop(signo);
 188        raise(signo);
 189}
 190
 191static const char *worktree_basename(const char *path, int *olen)
 192{
 193        const char *name;
 194        int len;
 195
 196        len = strlen(path);
 197        while (len && is_dir_sep(path[len - 1]))
 198                len--;
 199
 200        for (name = path + len - 1; name > path; name--)
 201                if (is_dir_sep(*name)) {
 202                        name++;
 203                        break;
 204                }
 205
 206        *olen = len;
 207        return name;
 208}
 209
 210static int add_worktree(const char *path, const char *refname,
 211                        const struct add_opts *opts)
 212{
 213        struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
 214        struct strbuf sb = STRBUF_INIT;
 215        const char *name;
 216        struct stat st;
 217        struct child_process cp = CHILD_PROCESS_INIT;
 218        struct argv_array child_env = ARGV_ARRAY_INIT;
 219        int counter = 0, len, ret;
 220        struct strbuf symref = STRBUF_INIT;
 221        struct commit *commit = NULL;
 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)) { /* it's a branch */
 229                if (!opts->force)
 230                        die_if_checked_out(symref.buf, 0);
 231        } else { /* must be a commit */
 232                commit = lookup_commit_reference_by_name(refname);
 233                if (!commit)
 234                        die(_("invalid reference: %s"), refname);
 235        }
 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 (commit)
 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        argv_array_clear(&child_env);
 332        strbuf_release(&sb);
 333        strbuf_release(&symref);
 334        strbuf_release(&sb_repo);
 335        strbuf_release(&sb_git);
 336        return ret;
 337}
 338
 339static int add(int ac, const char **av, const char *prefix)
 340{
 341        struct add_opts opts;
 342        const char *new_branch_force = NULL;
 343        char *path;
 344        const char *branch;
 345        const char *opt_track = NULL;
 346        struct option options[] = {
 347                OPT__FORCE(&opts.force, N_("checkout <branch> even if already checked out in other worktree")),
 348                OPT_STRING('b', NULL, &opts.new_branch, N_("branch"),
 349                           N_("create a new branch")),
 350                OPT_STRING('B', NULL, &new_branch_force, N_("branch"),
 351                           N_("create or reset a branch")),
 352                OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")),
 353                OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")),
 354                OPT_BOOL(0, "lock", &opts.keep_locked, N_("keep the new working tree locked")),
 355                OPT_PASSTHRU(0, "track", &opt_track, NULL,
 356                             N_("set up tracking mode (see git-branch(1))"),
 357                             PARSE_OPT_NOARG | PARSE_OPT_OPTARG),
 358                OPT_END()
 359        };
 360
 361        memset(&opts, 0, sizeof(opts));
 362        opts.checkout = 1;
 363        ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
 364        if (!!opts.detach + !!opts.new_branch + !!new_branch_force > 1)
 365                die(_("-b, -B, and --detach are mutually exclusive"));
 366        if (ac < 1 || ac > 2)
 367                usage_with_options(worktree_usage, options);
 368
 369        path = prefix_filename(prefix, av[0]);
 370        branch = ac < 2 ? "HEAD" : av[1];
 371
 372        if (!strcmp(branch, "-"))
 373                branch = "@{-1}";
 374
 375        opts.force_new_branch = !!new_branch_force;
 376        if (opts.force_new_branch) {
 377                struct strbuf symref = STRBUF_INIT;
 378
 379                opts.new_branch = new_branch_force;
 380
 381                if (!opts.force &&
 382                    !strbuf_check_branch_ref(&symref, opts.new_branch) &&
 383                    ref_exists(symref.buf))
 384                        die_if_checked_out(symref.buf, 0);
 385                strbuf_release(&symref);
 386        }
 387
 388        if (ac < 2 && !opts.new_branch && !opts.detach) {
 389                int n;
 390                const char *s = worktree_basename(path, &n);
 391                opts.new_branch = xstrndup(s, n);
 392        }
 393
 394        if (ac == 2 && !opts.new_branch && !opts.detach) {
 395                struct object_id oid;
 396                struct commit *commit;
 397                const char *remote;
 398
 399                commit = lookup_commit_reference_by_name(branch);
 400                if (!commit) {
 401                        remote = unique_tracking_name(branch, &oid);
 402                        if (remote) {
 403                                opts.new_branch = branch;
 404                                branch = remote;
 405                        }
 406                }
 407        }
 408
 409        if (opts.new_branch) {
 410                struct child_process cp = CHILD_PROCESS_INIT;
 411                cp.git_cmd = 1;
 412                argv_array_push(&cp.args, "branch");
 413                if (opts.force_new_branch)
 414                        argv_array_push(&cp.args, "--force");
 415                argv_array_push(&cp.args, opts.new_branch);
 416                argv_array_push(&cp.args, branch);
 417                if (opt_track)
 418                        argv_array_push(&cp.args, opt_track);
 419                if (run_command(&cp))
 420                        return -1;
 421                branch = opts.new_branch;
 422        } else if (opt_track) {
 423                die(_("--[no-]track can only be used if a new branch is created"));
 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}