worktree.c: add validate_worktree()
[git/git.git] / worktree.c
CommitLineData
ac6c561b 1#include "cache.h"
b337172c 2#include "repository.h"
ac6c561b
MR
3#include "refs.h"
4#include "strbuf.h"
5#include "worktree.h"
750e8a60 6#include "dir.h"
8d9fdd70 7#include "wt-status.h"
ac6c561b 8
51934904
MR
9void free_worktrees(struct worktree **worktrees)
10{
11 int i = 0;
12
13 for (i = 0; worktrees[i]; i++) {
14 free(worktrees[i]->path);
69dfe3b9 15 free(worktrees[i]->id);
92718b74 16 free(worktrees[i]->head_ref);
346ef530 17 free(worktrees[i]->lock_reason);
51934904
MR
18 free(worktrees[i]);
19 }
20 free (worktrees);
21}
22
92718b74 23/**
fa099d23 24 * Update head_sha1, head_ref and is_detached of the given worktree
92718b74 25 */
fa099d23 26static void add_head_info(struct worktree *wt)
92718b74 27{
fa099d23
NTND
28 int flags;
29 const char *target;
30
31 target = refs_resolve_ref_unsafe(get_worktree_ref_store(wt),
32 "HEAD",
31824d18 33 0,
49e61479 34 &wt->head_oid, &flags);
fa099d23
NTND
35 if (!target)
36 return;
37
38 if (flags & REF_ISSYMREF)
39 wt->head_ref = xstrdup(target);
40 else
41 wt->is_detached = 1;
92718b74
MR
42}
43
51934904
MR
44/**
45 * get the main worktree
46 */
47static struct worktree *get_main_worktree(void)
1ceb7f90 48{
51934904 49 struct worktree *worktree = NULL;
1ceb7f90 50 struct strbuf path = STRBUF_INIT;
51934904 51 struct strbuf worktree_path = STRBUF_INIT;
92718b74 52 int is_bare = 0;
1ceb7f90 53
fd2e7daf 54 strbuf_add_absolute_path(&worktree_path, get_git_common_dir());
92718b74
MR
55 is_bare = !strbuf_strip_suffix(&worktree_path, "/.git");
56 if (is_bare)
51934904
MR
57 strbuf_strip_suffix(&worktree_path, "/.");
58
59 strbuf_addf(&path, "%s/HEAD", get_git_common_dir());
60
f054996d 61 worktree = xcalloc(1, sizeof(*worktree));
92718b74 62 worktree->path = strbuf_detach(&worktree_path, NULL);
92718b74 63 worktree->is_bare = is_bare;
fa099d23 64 add_head_info(worktree);
92718b74 65
1ceb7f90 66 strbuf_release(&path);
51934904 67 strbuf_release(&worktree_path);
51934904 68 return worktree;
1ceb7f90
MR
69}
70
51934904 71static struct worktree *get_linked_worktree(const char *id)
ac6c561b 72{
51934904 73 struct worktree *worktree = NULL;
ac6c561b 74 struct strbuf path = STRBUF_INIT;
51934904 75 struct strbuf worktree_path = STRBUF_INIT;
ac6c561b 76
1ceb7f90
MR
77 if (!id)
78 die("Missing linked worktree name");
ac6c561b 79
b337172c 80 strbuf_git_common_path(&path, the_repository, "worktrees/%s/gitdir", id);
51934904
MR
81 if (strbuf_read_file(&worktree_path, path.buf, 0) <= 0)
82 /* invalid gitdir file */
ac6c561b 83 goto done;
51934904
MR
84
85 strbuf_rtrim(&worktree_path);
86 if (!strbuf_strip_suffix(&worktree_path, "/.git")) {
87 strbuf_reset(&worktree_path);
fd2e7daf 88 strbuf_add_absolute_path(&worktree_path, ".");
51934904
MR
89 strbuf_strip_suffix(&worktree_path, "/.");
90 }
91
1ceb7f90 92 strbuf_reset(&path);
51934904
MR
93 strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
94
f054996d 95 worktree = xcalloc(1, sizeof(*worktree));
92718b74 96 worktree->path = strbuf_detach(&worktree_path, NULL);
69dfe3b9 97 worktree->id = xstrdup(id);
fa099d23 98 add_head_info(worktree);
ac6c561b 99
ac6c561b
MR
100done:
101 strbuf_release(&path);
51934904 102 strbuf_release(&worktree_path);
51934904 103 return worktree;
ac6c561b
MR
104}
105
750e8a60
NTND
106static void mark_current_worktree(struct worktree **worktrees)
107{
0aaad415 108 char *git_dir = absolute_pathdup(get_git_dir());
750e8a60
NTND
109 int i;
110
750e8a60
NTND
111 for (i = 0; worktrees[i]; i++) {
112 struct worktree *wt = worktrees[i];
360af2da
NTND
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;
750e8a60 117 break;
360af2da 118 }
750e8a60 119 }
360af2da 120 free(git_dir);
750e8a60
NTND
121}
122
4df1d4d4
NTND
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
4fff1ef7 130struct worktree **get_worktrees(unsigned flags)
ac6c561b 131{
51934904 132 struct worktree **list = NULL;
ac6c561b
MR
133 struct strbuf path = STRBUF_INIT;
134 DIR *dir;
135 struct dirent *d;
51934904
MR
136 int counter = 0, alloc = 2;
137
3f64699f 138 ALLOC_ARRAY(list, alloc);
ac6c561b 139
a234563a 140 list[counter++] = get_main_worktree();
ac6c561b
MR
141
142 strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
143 dir = opendir(path.buf);
144 strbuf_release(&path);
51934904
MR
145 if (dir) {
146 while ((d = readdir(dir)) != NULL) {
147 struct worktree *linked = NULL;
afb9e30b 148 if (is_dot_or_dotdot(d->d_name))
51934904 149 continue;
ac6c561b 150
d4cddd66
NTND
151 if ((linked = get_linked_worktree(d->d_name))) {
152 ALLOC_GROW(list, counter + 1, alloc);
153 list[counter++] = linked;
154 }
51934904
MR
155 }
156 closedir(dir);
157 }
158 ALLOC_GROW(list, counter + 1, alloc);
159 list[counter] = NULL;
750e8a60 160
4df1d4d4
NTND
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
750e8a60 168 mark_current_worktree(list);
51934904
MR
169 return list;
170}
171
69dfe3b9
NTND
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
080739ba
NTND
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
68353144
NTND
207struct worktree *find_worktree(struct worktree **list,
208 const char *prefix,
209 const char *arg)
210{
080739ba 211 struct worktree *wt;
68353144 212 char *path;
e4da43b1 213 char *to_free = NULL;
68353144 214
080739ba
NTND
215 if ((wt = find_worktree_by_suffix(list, arg)))
216 return wt;
217
e4da43b1
JK
218 if (prefix)
219 arg = to_free = prefix_filename(prefix, arg);
ce83eadd 220 path = real_pathdup(arg, 1);
68353144
NTND
221 for (; *list; list++)
222 if (!fspathcmp(path, real_path((*list)->path)))
223 break;
224 free(path);
e4da43b1 225 free(to_free);
68353144
NTND
226 return *list;
227}
228
984ad9e5
NTND
229int is_main_worktree(const struct worktree *wt)
230{
231 return !wt->id;
232}
233
346ef530
NTND
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
4ddddc1f
NTND
257/* convenient wrapper to deal with NULL strbuf */
258static void strbuf_addf_gently(struct strbuf *buf, const char *fmt, ...)
259{
260 va_list params;
261
262 if (!buf)
263 return;
264
265 va_start(params, fmt);
266 strbuf_vaddf(buf, fmt, params);
267 va_end(params);
268}
269
270int validate_worktree(const struct worktree *wt, struct strbuf *errmsg)
271{
272 struct strbuf wt_path = STRBUF_INIT;
273 char *path = NULL;
274 int err, ret = -1;
275
276 strbuf_addf(&wt_path, "%s/.git", wt->path);
277
278 if (is_main_worktree(wt)) {
279 if (is_directory(wt_path.buf)) {
280 ret = 0;
281 goto done;
282 }
283 /*
284 * Main worktree using .git file to point to the
285 * repository would make it impossible to know where
286 * the actual worktree is if this function is executed
287 * from another worktree. No .git file support for now.
288 */
289 strbuf_addf_gently(errmsg,
290 _("'%s' at main working tree is not the repository directory"),
291 wt_path.buf);
292 goto done;
293 }
294
295 /*
296 * Make sure "gitdir" file points to a real .git file and that
297 * file points back here.
298 */
299 if (!is_absolute_path(wt->path)) {
300 strbuf_addf_gently(errmsg,
301 _("'%s' file does not contain absolute path to the working tree location"),
302 git_common_path("worktrees/%s/gitdir", wt->id));
303 goto done;
304 }
305
306 if (!file_exists(wt_path.buf)) {
307 strbuf_addf_gently(errmsg, _("'%s' does not exist"), wt_path.buf);
308 goto done;
309 }
310
311 path = xstrdup_or_null(read_gitfile_gently(wt_path.buf, &err));
312 if (!path) {
313 strbuf_addf_gently(errmsg, _("'%s' is not a .git file, error code %d"),
314 wt_path.buf, err);
315 goto done;
316 }
317
318 ret = fspathcmp(path, real_path(git_common_path("worktrees/%s", wt->id)));
319
320 if (ret)
321 strbuf_addf_gently(errmsg, _("'%s' does not point back to '%s'"),
322 wt->path, git_common_path("worktrees/%s", wt->id));
323done:
324 free(path);
325 strbuf_release(&wt_path);
326 return ret;
327}
328
14ace5b7
NTND
329int is_worktree_being_rebased(const struct worktree *wt,
330 const char *target)
8d9fdd70
NTND
331{
332 struct wt_status_state state;
333 int found_rebase;
334
335 memset(&state, 0, sizeof(state));
336 found_rebase = wt_status_check_rebase(wt, &state) &&
337 ((state.rebase_in_progress ||
338 state.rebase_interactive_in_progress) &&
339 state.branch &&
340 starts_with(target, "refs/heads/") &&
341 !strcmp(state.branch, target + strlen("refs/heads/")));
342 free(state.branch);
343 free(state.onto);
344 return found_rebase;
345}
346
14ace5b7
NTND
347int is_worktree_being_bisected(const struct worktree *wt,
348 const char *target)
51934904 349{
04a3dfb8
NTND
350 struct wt_status_state state;
351 int found_rebase;
352
353 memset(&state, 0, sizeof(state));
354 found_rebase = wt_status_check_bisect(wt, &state) &&
355 state.branch &&
356 starts_with(target, "refs/heads/") &&
357 !strcmp(state.branch, target + strlen("refs/heads/"));
358 free(state.branch);
359 return found_rebase;
360}
361
8d9fdd70
NTND
362/*
363 * note: this function should be able to detect shared symref even if
364 * HEAD is temporarily detached (e.g. in the middle of rebase or
365 * bisect). New commands that do similar things should update this
366 * function as well.
367 */
d3b9ac07
NTND
368const struct worktree *find_shared_symref(const char *symref,
369 const char *target)
51934904 370{
d3b9ac07 371 const struct worktree *existing = NULL;
d3b9ac07 372 static struct worktree **worktrees;
51934904
MR
373 int i = 0;
374
d3b9ac07
NTND
375 if (worktrees)
376 free_worktrees(worktrees);
4fff1ef7 377 worktrees = get_worktrees(0);
d3b9ac07 378
51934904 379 for (i = 0; worktrees[i]; i++) {
c8717148 380 struct worktree *wt = worktrees[i];
fa099d23 381 const char *symref_target;
fa099d23
NTND
382 struct ref_store *refs;
383 int flags;
384
171c646f
DK
385 if (wt->is_bare)
386 continue;
c8717148 387
8d9fdd70
NTND
388 if (wt->is_detached && !strcmp(symref, "HEAD")) {
389 if (is_worktree_being_rebased(wt, target)) {
390 existing = wt;
391 break;
392 }
04a3dfb8
NTND
393 if (is_worktree_being_bisected(wt, target)) {
394 existing = wt;
395 break;
396 }
8d9fdd70
NTND
397 }
398
fa099d23
NTND
399 refs = get_worktree_ref_store(wt);
400 symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
e691b027 401 NULL, &flags);
dbd2b55c
JK
402 if ((flags & REF_ISSYMREF) &&
403 symref_target && !strcmp(symref_target, target)) {
c8717148 404 existing = wt;
51934904
MR
405 break;
406 }
ac6c561b 407 }
51934904 408
ac6c561b
MR
409 return existing;
410}
1a248cf2
SB
411
412int submodule_uses_worktrees(const char *path)
413{
414 char *submodule_gitdir;
415 struct strbuf sb = STRBUF_INIT;
416 DIR *dir;
417 struct dirent *d;
7c4be458 418 int ret = 0;
1a248cf2
SB
419 struct repository_format format;
420
421 submodule_gitdir = git_pathdup_submodule(path, "%s", "");
422 if (!submodule_gitdir)
423 return 0;
424
425 /* The env would be set for the superproject. */
426 get_common_dir_noenv(&sb, submodule_gitdir);
d32de66a 427 free(submodule_gitdir);
1a248cf2
SB
428
429 /*
430 * The check below is only known to be good for repository format
431 * version 0 at the time of writing this code.
432 */
433 strbuf_addstr(&sb, "/config");
434 read_repository_format(&format, sb.buf);
435 if (format.version != 0) {
436 strbuf_release(&sb);
437 return 1;
438 }
439
440 /* Replace config by worktrees. */
441 strbuf_setlen(&sb, sb.len - strlen("config"));
442 strbuf_addstr(&sb, "worktrees");
443
444 /* See if there is any file inside the worktrees directory. */
445 dir = opendir(sb.buf);
446 strbuf_release(&sb);
1a248cf2
SB
447
448 if (!dir)
449 return 0;
450
451 while ((d = readdir(dir)) != NULL) {
452 if (is_dot_or_dotdot(d->d_name))
453 continue;
454
455 ret = 1;
456 break;
457 }
458 closedir(dir);
459 return ret;
460}
d0c39a49
NTND
461
462int other_head_refs(each_ref_fn fn, void *cb_data)
463{
464 struct worktree **worktrees, **p;
465 int ret = 0;
466
467 worktrees = get_worktrees(0);
468 for (p = worktrees; *p; p++) {
469 struct worktree *wt = *p;
470 struct ref_store *refs;
471
472 if (wt->is_current)
473 continue;
474
475 refs = get_worktree_ref_store(wt);
476 ret = refs_head_ref(refs, fn, cb_data);
477 if (ret)
478 break;
479 }
480 free_worktrees(worktrees);
481 return ret;
482}