The sixth batch
[git/debian.git] / worktree.c
blobe8f6f6ae6f46ec4580fea61bfb1f2a4046ee3587
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"
9 void free_worktrees(struct worktree **worktrees)
11 int i = 0;
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]->prune_reason);
19 free(worktrees[i]);
21 free (worktrees);
24 /**
25 * Update head_oid, head_ref and is_detached of the given worktree
27 static void add_head_info(struct worktree *wt)
29 int flags;
30 const char *target;
32 target = refs_resolve_ref_unsafe(get_worktree_ref_store(wt),
33 "HEAD",
35 &wt->head_oid, &flags);
36 if (!target)
37 return;
39 if (flags & REF_ISSYMREF)
40 wt->head_ref = xstrdup(target);
41 else
42 wt->is_detached = 1;
45 /**
46 * get the main worktree
48 static struct worktree *get_main_worktree(void)
50 struct worktree *worktree = NULL;
51 struct strbuf worktree_path = STRBUF_INIT;
53 strbuf_add_real_path(&worktree_path, get_git_common_dir());
54 strbuf_strip_suffix(&worktree_path, "/.git");
56 CALLOC_ARRAY(worktree, 1);
57 worktree->path = strbuf_detach(&worktree_path, NULL);
59 * NEEDSWORK: If this function is called from a secondary worktree and
60 * config.worktree is present, is_bare_repository_cfg will reflect the
61 * contents of config.worktree, not the contents of the main worktree.
62 * This means that worktree->is_bare may be set to 0 even if the main
63 * worktree is configured to be bare.
65 worktree->is_bare = (is_bare_repository_cfg == 1) ||
66 is_bare_repository();
67 add_head_info(worktree);
68 return worktree;
71 static struct worktree *get_linked_worktree(const char *id)
73 struct worktree *worktree = NULL;
74 struct strbuf path = STRBUF_INIT;
75 struct strbuf worktree_path = STRBUF_INIT;
77 if (!id)
78 die("Missing linked worktree name");
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 strbuf_rtrim(&worktree_path);
85 strbuf_strip_suffix(&worktree_path, "/.git");
87 CALLOC_ARRAY(worktree, 1);
88 worktree->path = strbuf_detach(&worktree_path, NULL);
89 worktree->id = xstrdup(id);
90 add_head_info(worktree);
92 done:
93 strbuf_release(&path);
94 strbuf_release(&worktree_path);
95 return worktree;
98 static void mark_current_worktree(struct worktree **worktrees)
100 char *git_dir = absolute_pathdup(get_git_dir());
101 int i;
103 for (i = 0; worktrees[i]; i++) {
104 struct worktree *wt = worktrees[i];
105 const char *wt_git_dir = get_worktree_git_dir(wt);
107 if (!fspathcmp(git_dir, absolute_path(wt_git_dir))) {
108 wt->is_current = 1;
109 break;
112 free(git_dir);
115 struct worktree **get_worktrees(void)
117 struct worktree **list = NULL;
118 struct strbuf path = STRBUF_INIT;
119 DIR *dir;
120 struct dirent *d;
121 int counter = 0, alloc = 2;
123 ALLOC_ARRAY(list, alloc);
125 list[counter++] = get_main_worktree();
127 strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
128 dir = opendir(path.buf);
129 strbuf_release(&path);
130 if (dir) {
131 while ((d = readdir_skip_dot_and_dotdot(dir)) != NULL) {
132 struct worktree *linked = NULL;
134 if ((linked = get_linked_worktree(d->d_name))) {
135 ALLOC_GROW(list, counter + 1, alloc);
136 list[counter++] = linked;
139 closedir(dir);
141 ALLOC_GROW(list, counter + 1, alloc);
142 list[counter] = NULL;
144 mark_current_worktree(list);
145 return list;
148 const char *get_worktree_git_dir(const struct worktree *wt)
150 if (!wt)
151 return get_git_dir();
152 else if (!wt->id)
153 return get_git_common_dir();
154 else
155 return git_common_path("worktrees/%s", wt->id);
158 static struct worktree *find_worktree_by_suffix(struct worktree **list,
159 const char *suffix)
161 struct worktree *found = NULL;
162 int nr_found = 0, suffixlen;
164 suffixlen = strlen(suffix);
165 if (!suffixlen)
166 return NULL;
168 for (; *list && nr_found < 2; list++) {
169 const char *path = (*list)->path;
170 int pathlen = strlen(path);
171 int start = pathlen - suffixlen;
173 /* suffix must start at directory boundary */
174 if ((!start || (start > 0 && is_dir_sep(path[start - 1]))) &&
175 !fspathcmp(suffix, path + start)) {
176 found = *list;
177 nr_found++;
180 return nr_found == 1 ? found : NULL;
183 struct worktree *find_worktree(struct worktree **list,
184 const char *prefix,
185 const char *arg)
187 struct worktree *wt;
188 char *to_free = NULL;
190 if ((wt = find_worktree_by_suffix(list, arg)))
191 return wt;
193 if (prefix)
194 arg = to_free = prefix_filename(prefix, arg);
195 wt = find_worktree_by_path(list, arg);
196 free(to_free);
197 return wt;
200 struct worktree *find_worktree_by_path(struct worktree **list, const char *p)
202 struct strbuf wt_path = STRBUF_INIT;
203 char *path = real_pathdup(p, 0);
205 if (!path)
206 return NULL;
207 for (; *list; list++) {
208 if (!strbuf_realpath(&wt_path, (*list)->path, 0))
209 continue;
211 if (!fspathcmp(path, wt_path.buf))
212 break;
214 free(path);
215 strbuf_release(&wt_path);
216 return *list;
219 int is_main_worktree(const struct worktree *wt)
221 return !wt->id;
224 const char *worktree_lock_reason(struct worktree *wt)
226 if (is_main_worktree(wt))
227 return NULL;
229 if (!wt->lock_reason_valid) {
230 struct strbuf path = STRBUF_INIT;
232 strbuf_addstr(&path, worktree_git_path(wt, "locked"));
233 if (file_exists(path.buf)) {
234 struct strbuf lock_reason = STRBUF_INIT;
235 if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
236 die_errno(_("failed to read '%s'"), path.buf);
237 strbuf_trim(&lock_reason);
238 wt->lock_reason = strbuf_detach(&lock_reason, NULL);
239 } else
240 wt->lock_reason = NULL;
241 wt->lock_reason_valid = 1;
242 strbuf_release(&path);
245 return wt->lock_reason;
248 const char *worktree_prune_reason(struct worktree *wt, timestamp_t expire)
250 struct strbuf reason = STRBUF_INIT;
251 char *path = NULL;
253 if (is_main_worktree(wt))
254 return NULL;
255 if (wt->prune_reason_valid)
256 return wt->prune_reason;
258 if (should_prune_worktree(wt->id, &reason, &path, expire))
259 wt->prune_reason = strbuf_detach(&reason, NULL);
260 wt->prune_reason_valid = 1;
262 strbuf_release(&reason);
263 free(path);
264 return wt->prune_reason;
267 /* convenient wrapper to deal with NULL strbuf */
268 __attribute__((format (printf, 2, 3)))
269 static void strbuf_addf_gently(struct strbuf *buf, const char *fmt, ...)
271 va_list params;
273 if (!buf)
274 return;
276 va_start(params, fmt);
277 strbuf_vaddf(buf, fmt, params);
278 va_end(params);
281 int validate_worktree(const struct worktree *wt, struct strbuf *errmsg,
282 unsigned flags)
284 struct strbuf wt_path = STRBUF_INIT;
285 struct strbuf realpath = STRBUF_INIT;
286 char *path = NULL;
287 int err, ret = -1;
289 strbuf_addf(&wt_path, "%s/.git", wt->path);
291 if (is_main_worktree(wt)) {
292 if (is_directory(wt_path.buf)) {
293 ret = 0;
294 goto done;
297 * Main worktree using .git file to point to the
298 * repository would make it impossible to know where
299 * the actual worktree is if this function is executed
300 * from another worktree. No .git file support for now.
302 strbuf_addf_gently(errmsg,
303 _("'%s' at main working tree is not the repository directory"),
304 wt_path.buf);
305 goto done;
309 * Make sure "gitdir" file points to a real .git file and that
310 * file points back here.
312 if (!is_absolute_path(wt->path)) {
313 strbuf_addf_gently(errmsg,
314 _("'%s' file does not contain absolute path to the working tree location"),
315 git_common_path("worktrees/%s/gitdir", wt->id));
316 goto done;
319 if (flags & WT_VALIDATE_WORKTREE_MISSING_OK &&
320 !file_exists(wt->path)) {
321 ret = 0;
322 goto done;
325 if (!file_exists(wt_path.buf)) {
326 strbuf_addf_gently(errmsg, _("'%s' does not exist"), wt_path.buf);
327 goto done;
330 path = xstrdup_or_null(read_gitfile_gently(wt_path.buf, &err));
331 if (!path) {
332 strbuf_addf_gently(errmsg, _("'%s' is not a .git file, error code %d"),
333 wt_path.buf, err);
334 goto done;
337 strbuf_realpath(&realpath, git_common_path("worktrees/%s", wt->id), 1);
338 ret = fspathcmp(path, realpath.buf);
340 if (ret)
341 strbuf_addf_gently(errmsg, _("'%s' does not point back to '%s'"),
342 wt->path, git_common_path("worktrees/%s", wt->id));
343 done:
344 free(path);
345 strbuf_release(&wt_path);
346 strbuf_release(&realpath);
347 return ret;
350 void update_worktree_location(struct worktree *wt, const char *path_)
352 struct strbuf path = STRBUF_INIT;
354 if (is_main_worktree(wt))
355 BUG("can't relocate main worktree");
357 strbuf_realpath(&path, path_, 1);
358 if (fspathcmp(wt->path, path.buf)) {
359 write_file(git_common_path("worktrees/%s/gitdir", wt->id),
360 "%s/.git", path.buf);
361 free(wt->path);
362 wt->path = strbuf_detach(&path, NULL);
364 strbuf_release(&path);
367 int is_worktree_being_rebased(const struct worktree *wt,
368 const char *target)
370 struct wt_status_state state;
371 int found_rebase;
373 memset(&state, 0, sizeof(state));
374 found_rebase = wt_status_check_rebase(wt, &state) &&
375 (state.rebase_in_progress ||
376 state.rebase_interactive_in_progress) &&
377 state.branch &&
378 skip_prefix(target, "refs/heads/", &target) &&
379 !strcmp(state.branch, target);
380 wt_status_state_free_buffers(&state);
381 return found_rebase;
384 int is_worktree_being_bisected(const struct worktree *wt,
385 const char *target)
387 struct wt_status_state state;
388 int found_bisect;
390 memset(&state, 0, sizeof(state));
391 found_bisect = wt_status_check_bisect(wt, &state) &&
392 state.branch &&
393 skip_prefix(target, "refs/heads/", &target) &&
394 !strcmp(state.branch, target);
395 wt_status_state_free_buffers(&state);
396 return found_bisect;
400 * note: this function should be able to detect shared symref even if
401 * HEAD is temporarily detached (e.g. in the middle of rebase or
402 * bisect). New commands that do similar things should update this
403 * function as well.
405 const struct worktree *find_shared_symref(struct worktree **worktrees,
406 const char *symref,
407 const char *target)
409 const struct worktree *existing = NULL;
410 int i = 0;
412 for (i = 0; worktrees[i]; i++) {
413 struct worktree *wt = worktrees[i];
414 const char *symref_target;
415 struct ref_store *refs;
416 int flags;
418 if (wt->is_bare)
419 continue;
421 if (wt->is_detached && !strcmp(symref, "HEAD")) {
422 if (is_worktree_being_rebased(wt, target)) {
423 existing = wt;
424 break;
426 if (is_worktree_being_bisected(wt, target)) {
427 existing = wt;
428 break;
432 refs = get_worktree_ref_store(wt);
433 symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
434 NULL, &flags);
435 if ((flags & REF_ISSYMREF) &&
436 symref_target && !strcmp(symref_target, target)) {
437 existing = wt;
438 break;
442 return existing;
445 int submodule_uses_worktrees(const char *path)
447 char *submodule_gitdir;
448 struct strbuf sb = STRBUF_INIT, err = STRBUF_INIT;
449 DIR *dir;
450 struct dirent *d;
451 int ret = 0;
452 struct repository_format format = REPOSITORY_FORMAT_INIT;
454 submodule_gitdir = git_pathdup_submodule(path, "%s", "");
455 if (!submodule_gitdir)
456 return 0;
458 /* The env would be set for the superproject. */
459 get_common_dir_noenv(&sb, submodule_gitdir);
460 free(submodule_gitdir);
462 strbuf_addstr(&sb, "/config");
463 read_repository_format(&format, sb.buf);
464 if (verify_repository_format(&format, &err)) {
465 strbuf_release(&err);
466 strbuf_release(&sb);
467 clear_repository_format(&format);
468 return 1;
470 clear_repository_format(&format);
471 strbuf_release(&err);
473 /* Replace config by worktrees. */
474 strbuf_setlen(&sb, sb.len - strlen("config"));
475 strbuf_addstr(&sb, "worktrees");
477 /* See if there is any file inside the worktrees directory. */
478 dir = opendir(sb.buf);
479 strbuf_release(&sb);
481 if (!dir)
482 return 0;
484 d = readdir_skip_dot_and_dotdot(dir);
485 if (d != NULL)
486 ret = 1;
487 closedir(dir);
488 return ret;
491 int parse_worktree_ref(const char *worktree_ref, const char **name,
492 int *name_length, const char **ref)
494 if (skip_prefix(worktree_ref, "main-worktree/", &worktree_ref)) {
495 if (!*worktree_ref)
496 return -1;
497 if (name)
498 *name = NULL;
499 if (name_length)
500 *name_length = 0;
501 if (ref)
502 *ref = worktree_ref;
503 return 0;
505 if (skip_prefix(worktree_ref, "worktrees/", &worktree_ref)) {
506 const char *slash = strchr(worktree_ref, '/');
508 if (!slash || slash == worktree_ref || !slash[1])
509 return -1;
510 if (name)
511 *name = worktree_ref;
512 if (name_length)
513 *name_length = slash - worktree_ref;
514 if (ref)
515 *ref = slash + 1;
516 return 0;
518 return -1;
521 void strbuf_worktree_ref(const struct worktree *wt,
522 struct strbuf *sb,
523 const char *refname)
525 switch (ref_type(refname)) {
526 case REF_TYPE_PSEUDOREF:
527 case REF_TYPE_PER_WORKTREE:
528 if (wt && !wt->is_current) {
529 if (is_main_worktree(wt))
530 strbuf_addstr(sb, "main-worktree/");
531 else
532 strbuf_addf(sb, "worktrees/%s/", wt->id);
534 break;
536 case REF_TYPE_MAIN_PSEUDOREF:
537 case REF_TYPE_OTHER_PSEUDOREF:
538 break;
540 case REF_TYPE_NORMAL:
542 * For shared refs, don't prefix worktrees/ or
543 * main-worktree/. It's not necessary and
544 * files-backend.c can't handle it anyway.
546 break;
548 strbuf_addstr(sb, refname);
551 int other_head_refs(each_ref_fn fn, void *cb_data)
553 struct worktree **worktrees, **p;
554 struct strbuf refname = STRBUF_INIT;
555 int ret = 0;
557 worktrees = get_worktrees();
558 for (p = worktrees; *p; p++) {
559 struct worktree *wt = *p;
560 struct object_id oid;
561 int flag;
563 if (wt->is_current)
564 continue;
566 strbuf_reset(&refname);
567 strbuf_worktree_ref(wt, &refname, "HEAD");
568 if (refs_resolve_ref_unsafe(get_main_ref_store(the_repository),
569 refname.buf,
570 RESOLVE_REF_READING,
571 &oid, &flag))
572 ret = fn(refname.buf, &oid, flag, cb_data);
573 if (ret)
574 break;
576 free_worktrees(worktrees);
577 strbuf_release(&refname);
578 return ret;
582 * Repair worktree's /path/to/worktree/.git file if missing, corrupt, or not
583 * pointing at <repo>/worktrees/<id>.
585 static void repair_gitfile(struct worktree *wt,
586 worktree_repair_fn fn, void *cb_data)
588 struct strbuf dotgit = STRBUF_INIT;
589 struct strbuf repo = STRBUF_INIT;
590 char *backlink;
591 const char *repair = NULL;
592 int err;
594 /* missing worktree can't be repaired */
595 if (!file_exists(wt->path))
596 return;
598 if (!is_directory(wt->path)) {
599 fn(1, wt->path, _("not a directory"), cb_data);
600 return;
603 strbuf_realpath(&repo, git_common_path("worktrees/%s", wt->id), 1);
604 strbuf_addf(&dotgit, "%s/.git", wt->path);
605 backlink = xstrdup_or_null(read_gitfile_gently(dotgit.buf, &err));
607 if (err == READ_GITFILE_ERR_NOT_A_FILE)
608 fn(1, wt->path, _(".git is not a file"), cb_data);
609 else if (err)
610 repair = _(".git file broken");
611 else if (fspathcmp(backlink, repo.buf))
612 repair = _(".git file incorrect");
614 if (repair) {
615 fn(0, wt->path, repair, cb_data);
616 write_file(dotgit.buf, "gitdir: %s", repo.buf);
619 free(backlink);
620 strbuf_release(&repo);
621 strbuf_release(&dotgit);
624 static void repair_noop(int iserr, const char *path, const char *msg,
625 void *cb_data)
627 /* nothing */
630 void repair_worktrees(worktree_repair_fn fn, void *cb_data)
632 struct worktree **worktrees = get_worktrees();
633 struct worktree **wt = worktrees + 1; /* +1 skips main worktree */
635 if (!fn)
636 fn = repair_noop;
637 for (; *wt; wt++)
638 repair_gitfile(*wt, fn, cb_data);
639 free_worktrees(worktrees);
642 static int is_main_worktree_path(const char *path)
644 struct strbuf target = STRBUF_INIT;
645 struct strbuf maindir = STRBUF_INIT;
646 int cmp;
648 strbuf_add_real_path(&target, path);
649 strbuf_strip_suffix(&target, "/.git");
650 strbuf_add_real_path(&maindir, get_git_common_dir());
651 strbuf_strip_suffix(&maindir, "/.git");
652 cmp = fspathcmp(maindir.buf, target.buf);
654 strbuf_release(&maindir);
655 strbuf_release(&target);
656 return !cmp;
660 * If both the main worktree and linked worktree have been moved, then the
661 * gitfile /path/to/worktree/.git won't point into the repository, thus we
662 * won't know which <repo>/worktrees/<id>/gitdir to repair. However, we may
663 * be able to infer the gitdir by manually reading /path/to/worktree/.git,
664 * extracting the <id>, and checking if <repo>/worktrees/<id> exists.
666 static char *infer_backlink(const char *gitfile)
668 struct strbuf actual = STRBUF_INIT;
669 struct strbuf inferred = STRBUF_INIT;
670 const char *id;
672 if (strbuf_read_file(&actual, gitfile, 0) < 0)
673 goto error;
674 if (!starts_with(actual.buf, "gitdir:"))
675 goto error;
676 if (!(id = find_last_dir_sep(actual.buf)))
677 goto error;
678 strbuf_trim(&actual);
679 id++; /* advance past '/' to point at <id> */
680 if (!*id)
681 goto error;
682 strbuf_git_common_path(&inferred, the_repository, "worktrees/%s", id);
683 if (!is_directory(inferred.buf))
684 goto error;
686 strbuf_release(&actual);
687 return strbuf_detach(&inferred, NULL);
689 error:
690 strbuf_release(&actual);
691 strbuf_release(&inferred);
692 return NULL;
696 * Repair <repo>/worktrees/<id>/gitdir if missing, corrupt, or not pointing at
697 * the worktree's path.
699 void repair_worktree_at_path(const char *path,
700 worktree_repair_fn fn, void *cb_data)
702 struct strbuf dotgit = STRBUF_INIT;
703 struct strbuf realdotgit = STRBUF_INIT;
704 struct strbuf gitdir = STRBUF_INIT;
705 struct strbuf olddotgit = STRBUF_INIT;
706 char *backlink = NULL;
707 const char *repair = NULL;
708 int err;
710 if (!fn)
711 fn = repair_noop;
713 if (is_main_worktree_path(path))
714 goto done;
716 strbuf_addf(&dotgit, "%s/.git", path);
717 if (!strbuf_realpath(&realdotgit, dotgit.buf, 0)) {
718 fn(1, path, _("not a valid path"), cb_data);
719 goto done;
722 backlink = xstrdup_or_null(read_gitfile_gently(realdotgit.buf, &err));
723 if (err == READ_GITFILE_ERR_NOT_A_FILE) {
724 fn(1, realdotgit.buf, _("unable to locate repository; .git is not a file"), cb_data);
725 goto done;
726 } else if (err == READ_GITFILE_ERR_NOT_A_REPO) {
727 if (!(backlink = infer_backlink(realdotgit.buf))) {
728 fn(1, realdotgit.buf, _("unable to locate repository; .git file does not reference a repository"), cb_data);
729 goto done;
731 } else if (err) {
732 fn(1, realdotgit.buf, _("unable to locate repository; .git file broken"), cb_data);
733 goto done;
736 strbuf_addf(&gitdir, "%s/gitdir", backlink);
737 if (strbuf_read_file(&olddotgit, gitdir.buf, 0) < 0)
738 repair = _("gitdir unreadable");
739 else {
740 strbuf_rtrim(&olddotgit);
741 if (fspathcmp(olddotgit.buf, realdotgit.buf))
742 repair = _("gitdir incorrect");
745 if (repair) {
746 fn(0, gitdir.buf, repair, cb_data);
747 write_file(gitdir.buf, "%s", realdotgit.buf);
749 done:
750 free(backlink);
751 strbuf_release(&olddotgit);
752 strbuf_release(&gitdir);
753 strbuf_release(&realdotgit);
754 strbuf_release(&dotgit);
757 int should_prune_worktree(const char *id, struct strbuf *reason, char **wtpath, timestamp_t expire)
759 struct stat st;
760 char *path;
761 int fd;
762 size_t len;
763 ssize_t read_result;
765 *wtpath = NULL;
766 if (!is_directory(git_path("worktrees/%s", id))) {
767 strbuf_addstr(reason, _("not a valid directory"));
768 return 1;
770 if (file_exists(git_path("worktrees/%s/locked", id)))
771 return 0;
772 if (stat(git_path("worktrees/%s/gitdir", id), &st)) {
773 strbuf_addstr(reason, _("gitdir file does not exist"));
774 return 1;
776 fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY);
777 if (fd < 0) {
778 strbuf_addf(reason, _("unable to read gitdir file (%s)"),
779 strerror(errno));
780 return 1;
782 len = xsize_t(st.st_size);
783 path = xmallocz(len);
785 read_result = read_in_full(fd, path, len);
786 if (read_result < 0) {
787 strbuf_addf(reason, _("unable to read gitdir file (%s)"),
788 strerror(errno));
789 close(fd);
790 free(path);
791 return 1;
793 close(fd);
795 if (read_result != len) {
796 strbuf_addf(reason,
797 _("short read (expected %"PRIuMAX" bytes, read %"PRIuMAX")"),
798 (uintmax_t)len, (uintmax_t)read_result);
799 free(path);
800 return 1;
802 while (len && (path[len - 1] == '\n' || path[len - 1] == '\r'))
803 len--;
804 if (!len) {
805 strbuf_addstr(reason, _("invalid gitdir file"));
806 free(path);
807 return 1;
809 path[len] = '\0';
810 if (!file_exists(path)) {
811 if (stat(git_path("worktrees/%s/index", id), &st) ||
812 st.st_mtime <= expire) {
813 strbuf_addstr(reason, _("gitdir file points to non-existent location"));
814 free(path);
815 return 1;
816 } else {
817 *wtpath = path;
818 return 0;
821 *wtpath = path;
822 return 0;