test-lib-functions.sh: teach test_commit -C <dir>
[git/git.git] / worktree.c
CommitLineData
ac6c561b
MR
1#include "cache.h"
2#include "refs.h"
3#include "strbuf.h"
4#include "worktree.h"
750e8a60 5#include "dir.h"
8d9fdd70 6#include "wt-status.h"
ac6c561b 7
51934904
MR
8void free_worktrees(struct worktree **worktrees)
9{
10 int i = 0;
11
12 for (i = 0; worktrees[i]; i++) {
13 free(worktrees[i]->path);
69dfe3b9 14 free(worktrees[i]->id);
92718b74 15 free(worktrees[i]->head_ref);
346ef530 16 free(worktrees[i]->lock_reason);
51934904
MR
17 free(worktrees[i]);
18 }
19 free (worktrees);
20}
21
1ceb7f90
MR
22/*
23 * read 'path_to_ref' into 'ref'. Also if is_detached is not NULL,
832c0e5e 24 * set is_detached to 1 (0) if the ref is detached (is not detached).
1ceb7f90
MR
25 *
26 * $GIT_COMMON_DIR/$symref (e.g. HEAD) is practically outside $GIT_DIR so
27 * for linked worktrees, `resolve_ref_unsafe()` won't work (it uses
28 * git_path). Parse the ref ourselves.
29 *
30 * return -1 if the ref is not a proper ref, 0 otherwise (success)
31 */
32static int parse_ref(char *path_to_ref, struct strbuf *ref, int *is_detached)
33{
34 if (is_detached)
35 *is_detached = 0;
36 if (!strbuf_readlink(ref, path_to_ref, 0)) {
37 /* HEAD is symbolic link */
38 if (!starts_with(ref->buf, "refs/") ||
39 check_refname_format(ref->buf, 0))
40 return -1;
41 } else if (strbuf_read_file(ref, path_to_ref, 0) >= 0) {
42 /* textual symref or detached */
43 if (!starts_with(ref->buf, "ref:")) {
44 if (is_detached)
45 *is_detached = 1;
46 } else {
47 strbuf_remove(ref, 0, strlen("ref:"));
48 strbuf_trim(ref);
49 if (check_refname_format(ref->buf, 0))
50 return -1;
51 }
52 } else
53 return -1;
54 return 0;
55}
56
92718b74
MR
57/**
58 * Add the head_sha1 and head_ref (if not detached) to the given worktree
59 */
60static void add_head_info(struct strbuf *head_ref, struct worktree *worktree)
61{
62 if (head_ref->len) {
63 if (worktree->is_detached) {
64 get_sha1_hex(head_ref->buf, worktree->head_sha1);
65 } else {
66 resolve_ref_unsafe(head_ref->buf, 0, worktree->head_sha1, NULL);
67 worktree->head_ref = strbuf_detach(head_ref, NULL);
68 }
69 }
70}
71
51934904
MR
72/**
73 * get the main worktree
74 */
75static struct worktree *get_main_worktree(void)
1ceb7f90 76{
51934904 77 struct worktree *worktree = NULL;
1ceb7f90 78 struct strbuf path = STRBUF_INIT;
51934904 79 struct strbuf worktree_path = STRBUF_INIT;
51934904 80 struct strbuf head_ref = STRBUF_INIT;
92718b74
MR
81 int is_bare = 0;
82 int is_detached = 0;
1ceb7f90 83
fd2e7daf 84 strbuf_add_absolute_path(&worktree_path, get_git_common_dir());
92718b74
MR
85 is_bare = !strbuf_strip_suffix(&worktree_path, "/.git");
86 if (is_bare)
51934904
MR
87 strbuf_strip_suffix(&worktree_path, "/.");
88
89 strbuf_addf(&path, "%s/HEAD", get_git_common_dir());
90
f054996d 91 worktree = xcalloc(1, sizeof(*worktree));
92718b74 92 worktree->path = strbuf_detach(&worktree_path, NULL);
92718b74 93 worktree->is_bare = is_bare;
92718b74 94 worktree->is_detached = is_detached;
a234563a
NTND
95 if (!parse_ref(path.buf, &head_ref, &is_detached))
96 add_head_info(&head_ref, worktree);
92718b74 97
1ceb7f90 98 strbuf_release(&path);
51934904
MR
99 strbuf_release(&worktree_path);
100 strbuf_release(&head_ref);
101 return worktree;
1ceb7f90
MR
102}
103
51934904 104static struct worktree *get_linked_worktree(const char *id)
ac6c561b 105{
51934904 106 struct worktree *worktree = NULL;
ac6c561b 107 struct strbuf path = STRBUF_INIT;
51934904 108 struct strbuf worktree_path = STRBUF_INIT;
51934904 109 struct strbuf head_ref = STRBUF_INIT;
92718b74 110 int is_detached = 0;
ac6c561b 111
1ceb7f90
MR
112 if (!id)
113 die("Missing linked worktree name");
ac6c561b 114
69dfe3b9 115 strbuf_git_common_path(&path, "worktrees/%s/gitdir", id);
51934904
MR
116 if (strbuf_read_file(&worktree_path, path.buf, 0) <= 0)
117 /* invalid gitdir file */
ac6c561b 118 goto done;
51934904
MR
119
120 strbuf_rtrim(&worktree_path);
121 if (!strbuf_strip_suffix(&worktree_path, "/.git")) {
122 strbuf_reset(&worktree_path);
fd2e7daf 123 strbuf_add_absolute_path(&worktree_path, ".");
51934904
MR
124 strbuf_strip_suffix(&worktree_path, "/.");
125 }
126
1ceb7f90 127 strbuf_reset(&path);
51934904
MR
128 strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
129
92718b74
MR
130 if (parse_ref(path.buf, &head_ref, &is_detached) < 0)
131 goto done;
132
f054996d 133 worktree = xcalloc(1, sizeof(*worktree));
92718b74 134 worktree->path = strbuf_detach(&worktree_path, NULL);
69dfe3b9 135 worktree->id = xstrdup(id);
92718b74
MR
136 worktree->is_detached = is_detached;
137 add_head_info(&head_ref, worktree);
ac6c561b 138
ac6c561b
MR
139done:
140 strbuf_release(&path);
51934904
MR
141 strbuf_release(&worktree_path);
142 strbuf_release(&head_ref);
143 return worktree;
ac6c561b
MR
144}
145
750e8a60
NTND
146static void mark_current_worktree(struct worktree **worktrees)
147{
360af2da 148 char *git_dir = xstrdup(absolute_path(get_git_dir()));
750e8a60
NTND
149 int i;
150
750e8a60
NTND
151 for (i = 0; worktrees[i]; i++) {
152 struct worktree *wt = worktrees[i];
360af2da
NTND
153 const char *wt_git_dir = get_worktree_git_dir(wt);
154
155 if (!fspathcmp(git_dir, absolute_path(wt_git_dir))) {
156 wt->is_current = 1;
750e8a60 157 break;
360af2da 158 }
750e8a60 159 }
360af2da 160 free(git_dir);
750e8a60
NTND
161}
162
4df1d4d4
NTND
163static int compare_worktree(const void *a_, const void *b_)
164{
165 const struct worktree *const *a = a_;
166 const struct worktree *const *b = b_;
167 return fspathcmp((*a)->path, (*b)->path);
168}
169
4fff1ef7 170struct worktree **get_worktrees(unsigned flags)
ac6c561b 171{
51934904 172 struct worktree **list = NULL;
ac6c561b
MR
173 struct strbuf path = STRBUF_INIT;
174 DIR *dir;
175 struct dirent *d;
51934904
MR
176 int counter = 0, alloc = 2;
177
178 list = xmalloc(alloc * sizeof(struct worktree *));
ac6c561b 179
a234563a 180 list[counter++] = get_main_worktree();
ac6c561b
MR
181
182 strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
183 dir = opendir(path.buf);
184 strbuf_release(&path);
51934904
MR
185 if (dir) {
186 while ((d = readdir(dir)) != NULL) {
187 struct worktree *linked = NULL;
afb9e30b 188 if (is_dot_or_dotdot(d->d_name))
51934904 189 continue;
ac6c561b 190
d4cddd66
NTND
191 if ((linked = get_linked_worktree(d->d_name))) {
192 ALLOC_GROW(list, counter + 1, alloc);
193 list[counter++] = linked;
194 }
51934904
MR
195 }
196 closedir(dir);
197 }
198 ALLOC_GROW(list, counter + 1, alloc);
199 list[counter] = NULL;
750e8a60 200
4df1d4d4
NTND
201 if (flags & GWT_SORT_LINKED)
202 /*
203 * don't sort the first item (main worktree), which will
204 * always be the first
205 */
206 QSORT(list + 1, counter - 1, compare_worktree);
207
750e8a60 208 mark_current_worktree(list);
51934904
MR
209 return list;
210}
211
69dfe3b9
NTND
212const char *get_worktree_git_dir(const struct worktree *wt)
213{
214 if (!wt)
215 return get_git_dir();
216 else if (!wt->id)
217 return get_git_common_dir();
218 else
219 return git_common_path("worktrees/%s", wt->id);
220}
221
080739ba
NTND
222static struct worktree *find_worktree_by_suffix(struct worktree **list,
223 const char *suffix)
224{
225 struct worktree *found = NULL;
226 int nr_found = 0, suffixlen;
227
228 suffixlen = strlen(suffix);
229 if (!suffixlen)
230 return NULL;
231
232 for (; *list && nr_found < 2; list++) {
233 const char *path = (*list)->path;
234 int pathlen = strlen(path);
235 int start = pathlen - suffixlen;
236
237 /* suffix must start at directory boundary */
238 if ((!start || (start > 0 && is_dir_sep(path[start - 1]))) &&
239 !fspathcmp(suffix, path + start)) {
240 found = *list;
241 nr_found++;
242 }
243 }
244 return nr_found == 1 ? found : NULL;
245}
246
68353144
NTND
247struct worktree *find_worktree(struct worktree **list,
248 const char *prefix,
249 const char *arg)
250{
080739ba 251 struct worktree *wt;
68353144
NTND
252 char *path;
253
080739ba
NTND
254 if ((wt = find_worktree_by_suffix(list, arg)))
255 return wt;
256
68353144
NTND
257 arg = prefix_filename(prefix, strlen(prefix), arg);
258 path = xstrdup(real_path(arg));
259 for (; *list; list++)
260 if (!fspathcmp(path, real_path((*list)->path)))
261 break;
262 free(path);
263 return *list;
264}
265
984ad9e5
NTND
266int is_main_worktree(const struct worktree *wt)
267{
268 return !wt->id;
269}
270
346ef530
NTND
271const char *is_worktree_locked(struct worktree *wt)
272{
273 assert(!is_main_worktree(wt));
274
275 if (!wt->lock_reason_valid) {
276 struct strbuf path = STRBUF_INIT;
277
278 strbuf_addstr(&path, worktree_git_path(wt, "locked"));
279 if (file_exists(path.buf)) {
280 struct strbuf lock_reason = STRBUF_INIT;
281 if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
282 die_errno(_("failed to read '%s'"), path.buf);
283 strbuf_trim(&lock_reason);
284 wt->lock_reason = strbuf_detach(&lock_reason, NULL);
285 } else
286 wt->lock_reason = NULL;
287 wt->lock_reason_valid = 1;
288 strbuf_release(&path);
289 }
290
291 return wt->lock_reason;
292}
293
14ace5b7
NTND
294int is_worktree_being_rebased(const struct worktree *wt,
295 const char *target)
8d9fdd70
NTND
296{
297 struct wt_status_state state;
298 int found_rebase;
299
300 memset(&state, 0, sizeof(state));
301 found_rebase = wt_status_check_rebase(wt, &state) &&
302 ((state.rebase_in_progress ||
303 state.rebase_interactive_in_progress) &&
304 state.branch &&
305 starts_with(target, "refs/heads/") &&
306 !strcmp(state.branch, target + strlen("refs/heads/")));
307 free(state.branch);
308 free(state.onto);
309 return found_rebase;
310}
311
14ace5b7
NTND
312int is_worktree_being_bisected(const struct worktree *wt,
313 const char *target)
51934904 314{
04a3dfb8
NTND
315 struct wt_status_state state;
316 int found_rebase;
317
318 memset(&state, 0, sizeof(state));
319 found_rebase = wt_status_check_bisect(wt, &state) &&
320 state.branch &&
321 starts_with(target, "refs/heads/") &&
322 !strcmp(state.branch, target + strlen("refs/heads/"));
323 free(state.branch);
324 return found_rebase;
325}
326
8d9fdd70
NTND
327/*
328 * note: this function should be able to detect shared symref even if
329 * HEAD is temporarily detached (e.g. in the middle of rebase or
330 * bisect). New commands that do similar things should update this
331 * function as well.
332 */
d3b9ac07
NTND
333const struct worktree *find_shared_symref(const char *symref,
334 const char *target)
51934904 335{
d3b9ac07 336 const struct worktree *existing = NULL;
51934904
MR
337 struct strbuf path = STRBUF_INIT;
338 struct strbuf sb = STRBUF_INIT;
d3b9ac07 339 static struct worktree **worktrees;
51934904
MR
340 int i = 0;
341
d3b9ac07
NTND
342 if (worktrees)
343 free_worktrees(worktrees);
4fff1ef7 344 worktrees = get_worktrees(0);
d3b9ac07 345
51934904 346 for (i = 0; worktrees[i]; i++) {
c8717148 347 struct worktree *wt = worktrees[i];
171c646f
DK
348 if (wt->is_bare)
349 continue;
c8717148 350
8d9fdd70
NTND
351 if (wt->is_detached && !strcmp(symref, "HEAD")) {
352 if (is_worktree_being_rebased(wt, target)) {
353 existing = wt;
354 break;
355 }
04a3dfb8
NTND
356 if (is_worktree_being_bisected(wt, target)) {
357 existing = wt;
358 break;
359 }
8d9fdd70
NTND
360 }
361
51934904
MR
362 strbuf_reset(&path);
363 strbuf_reset(&sb);
69dfe3b9 364 strbuf_addf(&path, "%s/%s",
c8717148 365 get_worktree_git_dir(wt),
69dfe3b9 366 symref);
51934904
MR
367
368 if (parse_ref(path.buf, &sb, NULL)) {
ac6c561b 369 continue;
51934904
MR
370 }
371
372 if (!strcmp(sb.buf, target)) {
c8717148 373 existing = wt;
51934904
MR
374 break;
375 }
ac6c561b 376 }
51934904
MR
377
378 strbuf_release(&path);
379 strbuf_release(&sb);
ac6c561b
MR
380
381 return existing;
382}