Andrew's git / gitweb.git / worktree.c
?
worktree.con commit remote: handle broken symrefs (752848d)
   1#include "cache.h"
   2#include "repository.h"
   3#include "refs.h"
   4#include "strbuf.h"
   5#include "worktree.h"
   6#include "dir.h"
   7#include "wt-status.h"
   8
   9void free_worktrees(struct worktree **worktrees)
  10{
  11        int i = 0;
  12
  13        for (i = 0; worktrees[i]; i++) {
  14                free(worktrees[i]->path);
  15                free(worktrees[i]->id);
  16                free(worktrees[i]->head_ref);
  17                free(worktrees[i]->lock_reason);
  18                free(worktrees[i]);
  19        }
  20        free (worktrees);
  21}
  22
  23/**
  24 * Update head_sha1, head_ref and is_detached of the given worktree
  25 */
  26static void add_head_info(struct worktree *wt)
  27{
  28        int flags;
  29        const char *target;
  30
  31        target = refs_resolve_ref_unsafe(get_worktree_ref_store(wt),
  32                                         "HEAD",
  33                                         0,
  34                                         wt->head_sha1, &flags);
  35        if (!target)
  36                return;
  37
  38        if (flags & REF_ISSYMREF)
  39                wt->head_ref = xstrdup(target);
  40        else
  41                wt->is_detached = 1;
  42}
  43
  44/**
  45 * get the main worktree
  46 */
  47static struct worktree *get_main_worktree(void)
  48{
  49        struct worktree *worktree = NULL;
  50        struct strbuf path = STRBUF_INIT;
  51        struct strbuf worktree_path = STRBUF_INIT;
  52        int is_bare = 0;
  53
  54        strbuf_add_absolute_path(&worktree_path, get_git_common_dir());
  55        is_bare = !strbuf_strip_suffix(&worktree_path, "/.git");
  56        if (is_bare)
  57                strbuf_strip_suffix(&worktree_path, "/.");
  58
  59        strbuf_addf(&path, "%s/HEAD", get_git_common_dir());
  60
  61        worktree = xcalloc(1, sizeof(*worktree));
  62        worktree->path = strbuf_detach(&worktree_path, NULL);
  63        worktree->is_bare = is_bare;
  64        add_head_info(worktree);
  65
  66        strbuf_release(&path);
  67        strbuf_release(&worktree_path);
  68        return worktree;
  69}
  70
  71static struct worktree *get_linked_worktree(const char *id)
  72{
  73        struct worktree *worktree = NULL;
  74        struct strbuf path = STRBUF_INIT;
  75        struct strbuf worktree_path = STRBUF_INIT;
  76
  77        if (!id)
  78                die("Missing linked worktree name");
  79
  80        strbuf_git_common_path(&path, the_repository, "worktrees/%s/gitdir", id);
  81        if (strbuf_read_file(&worktree_path, path.buf, 0) <= 0)
  82                /* invalid gitdir file */
  83                goto done;
  84
  85        strbuf_rtrim(&worktree_path);
  86        if (!strbuf_strip_suffix(&worktree_path, "/.git")) {
  87                strbuf_reset(&worktree_path);
  88                strbuf_add_absolute_path(&worktree_path, ".");
  89                strbuf_strip_suffix(&worktree_path, "/.");
  90        }
  91
  92        strbuf_reset(&path);
  93        strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
  94
  95        worktree = xcalloc(1, sizeof(*worktree));
  96        worktree->path = strbuf_detach(&worktree_path, NULL);
  97        worktree->id = xstrdup(id);
  98        add_head_info(worktree);
  99
 100done:
 101        strbuf_release(&path);
 102        strbuf_release(&worktree_path);
 103        return worktree;
 104}
 105
 106static void mark_current_worktree(struct worktree **worktrees)
 107{
 108        char *git_dir = absolute_pathdup(get_git_dir());
 109        int i;
 110
 111        for (i = 0; worktrees[i]; i++) {
 112                struct worktree *wt = worktrees[i];
 113                const char *wt_git_dir = get_worktree_git_dir(wt);
 114
 115                if (!fspathcmp(git_dir, absolute_path(wt_git_dir))) {
 116                        wt->is_current = 1;
 117                        break;
 118                }
 119        }
 120        free(git_dir);
 121}
 122
 123static int compare_worktree(const void *a_, const void *b_)
 124{
 125        const struct worktree *const *a = a_;
 126        const struct worktree *const *b = b_;
 127        return fspathcmp((*a)->path, (*b)->path);
 128}
 129
 130struct worktree **get_worktrees(unsigned flags)
 131{
 132        struct worktree **list = NULL;
 133        struct strbuf path = STRBUF_INIT;
 134        DIR *dir;
 135        struct dirent *d;
 136        int counter = 0, alloc = 2;
 137
 138        ALLOC_ARRAY(list, alloc);
 139
 140        list[counter++] = get_main_worktree();
 141
 142        strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
 143        dir = opendir(path.buf);
 144        strbuf_release(&path);
 145        if (dir) {
 146                while ((d = readdir(dir)) != NULL) {
 147                        struct worktree *linked = NULL;
 148                        if (is_dot_or_dotdot(d->d_name))
 149                                continue;
 150
 151                        if ((linked = get_linked_worktree(d->d_name))) {
 152                                ALLOC_GROW(list, counter + 1, alloc);
 153                                list[counter++] = linked;
 154                        }
 155                }
 156                closedir(dir);
 157        }
 158        ALLOC_GROW(list, counter + 1, alloc);
 159        list[counter] = NULL;
 160
 161        if (flags & GWT_SORT_LINKED)
 162                /*
 163                 * don't sort the first item (main worktree), which will
 164                 * always be the first
 165                 */
 166                QSORT(list + 1, counter - 1, compare_worktree);
 167
 168        mark_current_worktree(list);
 169        return list;
 170}
 171
 172const char *get_worktree_git_dir(const struct worktree *wt)
 173{
 174        if (!wt)
 175                return get_git_dir();
 176        else if (!wt->id)
 177                return get_git_common_dir();
 178        else
 179                return git_common_path("worktrees/%s", wt->id);
 180}
 181
 182static struct worktree *find_worktree_by_suffix(struct worktree **list,
 183                                                const char *suffix)
 184{
 185        struct worktree *found = NULL;
 186        int nr_found = 0, suffixlen;
 187
 188        suffixlen = strlen(suffix);
 189        if (!suffixlen)
 190                return NULL;
 191
 192        for (; *list && nr_found < 2; list++) {
 193                const char      *path    = (*list)->path;
 194                int              pathlen = strlen(path);
 195                int              start   = pathlen - suffixlen;
 196
 197                /* suffix must start at directory boundary */
 198                if ((!start || (start > 0 && is_dir_sep(path[start - 1]))) &&
 199                    !fspathcmp(suffix, path + start)) {
 200                        found = *list;
 201                        nr_found++;
 202                }
 203        }
 204        return nr_found == 1 ? found : NULL;
 205}
 206
 207struct worktree *find_worktree(struct worktree **list,
 208                               const char *prefix,
 209                               const char *arg)
 210{
 211        struct worktree *wt;
 212        char *path;
 213        char *to_free = NULL;
 214
 215        if ((wt = find_worktree_by_suffix(list, arg)))
 216                return wt;
 217
 218        if (prefix)
 219                arg = to_free = prefix_filename(prefix, arg);
 220        path = real_pathdup(arg, 1);
 221        for (; *list; list++)
 222                if (!fspathcmp(path, real_path((*list)->path)))
 223                        break;
 224        free(path);
 225        free(to_free);
 226        return *list;
 227}
 228
 229int is_main_worktree(const struct worktree *wt)
 230{
 231        return !wt->id;
 232}
 233
 234const char *is_worktree_locked(struct worktree *wt)
 235{
 236        assert(!is_main_worktree(wt));
 237
 238        if (!wt->lock_reason_valid) {
 239                struct strbuf path = STRBUF_INIT;
 240
 241                strbuf_addstr(&path, worktree_git_path(wt, "locked"));
 242                if (file_exists(path.buf)) {
 243                        struct strbuf lock_reason = STRBUF_INIT;
 244                        if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
 245                                die_errno(_("failed to read '%s'"), path.buf);
 246                        strbuf_trim(&lock_reason);
 247                        wt->lock_reason = strbuf_detach(&lock_reason, NULL);
 248                } else
 249                        wt->lock_reason = NULL;
 250                wt->lock_reason_valid = 1;
 251                strbuf_release(&path);
 252        }
 253
 254        return wt->lock_reason;
 255}
 256
 257int is_worktree_being_rebased(const struct worktree *wt,
 258                              const char *target)
 259{
 260        struct wt_status_state state;
 261        int found_rebase;
 262
 263        memset(&state, 0, sizeof(state));
 264        found_rebase = wt_status_check_rebase(wt, &state) &&
 265                ((state.rebase_in_progress ||
 266                  state.rebase_interactive_in_progress) &&
 267                 state.branch &&
 268                 starts_with(target, "refs/heads/") &&
 269                 !strcmp(state.branch, target + strlen("refs/heads/")));
 270        free(state.branch);
 271        free(state.onto);
 272        return found_rebase;
 273}
 274
 275int is_worktree_being_bisected(const struct worktree *wt,
 276                               const char *target)
 277{
 278        struct wt_status_state state;
 279        int found_rebase;
 280
 281        memset(&state, 0, sizeof(state));
 282        found_rebase = wt_status_check_bisect(wt, &state) &&
 283                state.branch &&
 284                starts_with(target, "refs/heads/") &&
 285                !strcmp(state.branch, target + strlen("refs/heads/"));
 286        free(state.branch);
 287        return found_rebase;
 288}
 289
 290/*
 291 * note: this function should be able to detect shared symref even if
 292 * HEAD is temporarily detached (e.g. in the middle of rebase or
 293 * bisect). New commands that do similar things should update this
 294 * function as well.
 295 */
 296const struct worktree *find_shared_symref(const char *symref,
 297                                          const char *target)
 298{
 299        const struct worktree *existing = NULL;
 300        static struct worktree **worktrees;
 301        int i = 0;
 302
 303        if (worktrees)
 304                free_worktrees(worktrees);
 305        worktrees = get_worktrees(0);
 306
 307        for (i = 0; worktrees[i]; i++) {
 308                struct worktree *wt = worktrees[i];
 309                const char *symref_target;
 310                struct ref_store *refs;
 311                int flags;
 312
 313                if (wt->is_bare)
 314                        continue;
 315
 316                if (wt->is_detached && !strcmp(symref, "HEAD")) {
 317                        if (is_worktree_being_rebased(wt, target)) {
 318                                existing = wt;
 319                                break;
 320                        }
 321                        if (is_worktree_being_bisected(wt, target)) {
 322                                existing = wt;
 323                                break;
 324                        }
 325                }
 326
 327                refs = get_worktree_ref_store(wt);
 328                symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
 329                                                        NULL, &flags);
 330                if ((flags & REF_ISSYMREF) && !strcmp(symref_target, target)) {
 331                        existing = wt;
 332                        break;
 333                }
 334        }
 335
 336        return existing;
 337}
 338
 339int submodule_uses_worktrees(const char *path)
 340{
 341        char *submodule_gitdir;
 342        struct strbuf sb = STRBUF_INIT;
 343        DIR *dir;
 344        struct dirent *d;
 345        int ret = 0;
 346        struct repository_format format;
 347
 348        submodule_gitdir = git_pathdup_submodule(path, "%s", "");
 349        if (!submodule_gitdir)
 350                return 0;
 351
 352        /* The env would be set for the superproject. */
 353        get_common_dir_noenv(&sb, submodule_gitdir);
 354        free(submodule_gitdir);
 355
 356        /*
 357         * The check below is only known to be good for repository format
 358         * version 0 at the time of writing this code.
 359         */
 360        strbuf_addstr(&sb, "/config");
 361        read_repository_format(&format, sb.buf);
 362        if (format.version != 0) {
 363                strbuf_release(&sb);
 364                return 1;
 365        }
 366
 367        /* Replace config by worktrees. */
 368        strbuf_setlen(&sb, sb.len - strlen("config"));
 369        strbuf_addstr(&sb, "worktrees");
 370
 371        /* See if there is any file inside the worktrees directory. */
 372        dir = opendir(sb.buf);
 373        strbuf_release(&sb);
 374
 375        if (!dir)
 376                return 0;
 377
 378        while ((d = readdir(dir)) != NULL) {
 379                if (is_dot_or_dotdot(d->d_name))
 380                        continue;
 381
 382                ret = 1;
 383                break;
 384        }
 385        closedir(dir);
 386        return ret;
 387}
 388
 389int other_head_refs(each_ref_fn fn, void *cb_data)
 390{
 391        struct worktree **worktrees, **p;
 392        int ret = 0;
 393
 394        worktrees = get_worktrees(0);
 395        for (p = worktrees; *p; p++) {
 396                struct worktree *wt = *p;
 397                struct ref_store *refs;
 398
 399                if (wt->is_current)
 400                        continue;
 401
 402                refs = get_worktree_ref_store(wt);
 403                ret = refs_head_ref(refs, fn, cb_data);
 404                if (ret)
 405                        break;
 406        }
 407        free_worktrees(worktrees);
 408        return ret;
 409}