revision.c: better error reporting on ref from different worktrees
[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);
4c5fa9e6
ES
220 path = real_pathdup(arg, 0);
221 if (!path) {
222 free(to_free);
223 return NULL;
224 }
68353144
NTND
225 for (; *list; list++)
226 if (!fspathcmp(path, real_path((*list)->path)))
227 break;
228 free(path);
e4da43b1 229 free(to_free);
68353144
NTND
230 return *list;
231}
232
984ad9e5
NTND
233int is_main_worktree(const struct worktree *wt)
234{
235 return !wt->id;
236}
237
346ef530
NTND
238const char *is_worktree_locked(struct worktree *wt)
239{
240 assert(!is_main_worktree(wt));
241
242 if (!wt->lock_reason_valid) {
243 struct strbuf path = STRBUF_INIT;
244
245 strbuf_addstr(&path, worktree_git_path(wt, "locked"));
246 if (file_exists(path.buf)) {
247 struct strbuf lock_reason = STRBUF_INIT;
248 if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
249 die_errno(_("failed to read '%s'"), path.buf);
250 strbuf_trim(&lock_reason);
251 wt->lock_reason = strbuf_detach(&lock_reason, NULL);
252 } else
253 wt->lock_reason = NULL;
254 wt->lock_reason_valid = 1;
255 strbuf_release(&path);
256 }
257
258 return wt->lock_reason;
259}
260
4ddddc1f
NTND
261/* convenient wrapper to deal with NULL strbuf */
262static void strbuf_addf_gently(struct strbuf *buf, const char *fmt, ...)
263{
264 va_list params;
265
266 if (!buf)
267 return;
268
269 va_start(params, fmt);
270 strbuf_vaddf(buf, fmt, params);
271 va_end(params);
272}
273
ee6763af
NTND
274int validate_worktree(const struct worktree *wt, struct strbuf *errmsg,
275 unsigned flags)
4ddddc1f
NTND
276{
277 struct strbuf wt_path = STRBUF_INIT;
278 char *path = NULL;
279 int err, ret = -1;
280
281 strbuf_addf(&wt_path, "%s/.git", wt->path);
282
283 if (is_main_worktree(wt)) {
284 if (is_directory(wt_path.buf)) {
285 ret = 0;
286 goto done;
287 }
288 /*
289 * Main worktree using .git file to point to the
290 * repository would make it impossible to know where
291 * the actual worktree is if this function is executed
292 * from another worktree. No .git file support for now.
293 */
294 strbuf_addf_gently(errmsg,
295 _("'%s' at main working tree is not the repository directory"),
296 wt_path.buf);
297 goto done;
298 }
299
300 /*
301 * Make sure "gitdir" file points to a real .git file and that
302 * file points back here.
303 */
304 if (!is_absolute_path(wt->path)) {
305 strbuf_addf_gently(errmsg,
306 _("'%s' file does not contain absolute path to the working tree location"),
307 git_common_path("worktrees/%s/gitdir", wt->id));
308 goto done;
309 }
310
ee6763af
NTND
311 if (flags & WT_VALIDATE_WORKTREE_MISSING_OK &&
312 !file_exists(wt->path)) {
313 ret = 0;
314 goto done;
315 }
316
4ddddc1f
NTND
317 if (!file_exists(wt_path.buf)) {
318 strbuf_addf_gently(errmsg, _("'%s' does not exist"), wt_path.buf);
319 goto done;
320 }
321
322 path = xstrdup_or_null(read_gitfile_gently(wt_path.buf, &err));
323 if (!path) {
324 strbuf_addf_gently(errmsg, _("'%s' is not a .git file, error code %d"),
325 wt_path.buf, err);
326 goto done;
327 }
328
329 ret = fspathcmp(path, real_path(git_common_path("worktrees/%s", wt->id)));
330
331 if (ret)
332 strbuf_addf_gently(errmsg, _("'%s' does not point back to '%s'"),
333 wt->path, git_common_path("worktrees/%s", wt->id));
334done:
335 free(path);
336 strbuf_release(&wt_path);
337 return ret;
338}
339
9c620fc7
NTND
340void update_worktree_location(struct worktree *wt, const char *path_)
341{
342 struct strbuf path = STRBUF_INIT;
343
344 if (is_main_worktree(wt))
033abf97 345 BUG("can't relocate main worktree");
9c620fc7
NTND
346
347 strbuf_realpath(&path, path_, 1);
348 if (fspathcmp(wt->path, path.buf)) {
349 write_file(git_common_path("worktrees/%s/gitdir", wt->id),
350 "%s/.git", path.buf);
351 free(wt->path);
352 wt->path = strbuf_detach(&path, NULL);
353 }
354 strbuf_release(&path);
355}
356
14ace5b7
NTND
357int is_worktree_being_rebased(const struct worktree *wt,
358 const char *target)
8d9fdd70
NTND
359{
360 struct wt_status_state state;
361 int found_rebase;
362
363 memset(&state, 0, sizeof(state));
364 found_rebase = wt_status_check_rebase(wt, &state) &&
365 ((state.rebase_in_progress ||
366 state.rebase_interactive_in_progress) &&
367 state.branch &&
368 starts_with(target, "refs/heads/") &&
369 !strcmp(state.branch, target + strlen("refs/heads/")));
370 free(state.branch);
371 free(state.onto);
372 return found_rebase;
373}
374
14ace5b7
NTND
375int is_worktree_being_bisected(const struct worktree *wt,
376 const char *target)
51934904 377{
04a3dfb8
NTND
378 struct wt_status_state state;
379 int found_rebase;
380
381 memset(&state, 0, sizeof(state));
382 found_rebase = wt_status_check_bisect(wt, &state) &&
383 state.branch &&
384 starts_with(target, "refs/heads/") &&
385 !strcmp(state.branch, target + strlen("refs/heads/"));
386 free(state.branch);
387 return found_rebase;
388}
389
8d9fdd70
NTND
390/*
391 * note: this function should be able to detect shared symref even if
392 * HEAD is temporarily detached (e.g. in the middle of rebase or
393 * bisect). New commands that do similar things should update this
394 * function as well.
395 */
d3b9ac07
NTND
396const struct worktree *find_shared_symref(const char *symref,
397 const char *target)
51934904 398{
d3b9ac07 399 const struct worktree *existing = NULL;
d3b9ac07 400 static struct worktree **worktrees;
51934904
MR
401 int i = 0;
402
d3b9ac07
NTND
403 if (worktrees)
404 free_worktrees(worktrees);
4fff1ef7 405 worktrees = get_worktrees(0);
d3b9ac07 406
51934904 407 for (i = 0; worktrees[i]; i++) {
c8717148 408 struct worktree *wt = worktrees[i];
fa099d23 409 const char *symref_target;
fa099d23
NTND
410 struct ref_store *refs;
411 int flags;
412
171c646f
DK
413 if (wt->is_bare)
414 continue;
c8717148 415
8d9fdd70
NTND
416 if (wt->is_detached && !strcmp(symref, "HEAD")) {
417 if (is_worktree_being_rebased(wt, target)) {
418 existing = wt;
419 break;
420 }
04a3dfb8
NTND
421 if (is_worktree_being_bisected(wt, target)) {
422 existing = wt;
423 break;
424 }
8d9fdd70
NTND
425 }
426
fa099d23
NTND
427 refs = get_worktree_ref_store(wt);
428 symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
e691b027 429 NULL, &flags);
dbd2b55c
JK
430 if ((flags & REF_ISSYMREF) &&
431 symref_target && !strcmp(symref_target, target)) {
c8717148 432 existing = wt;
51934904
MR
433 break;
434 }
ac6c561b 435 }
51934904 436
ac6c561b
MR
437 return existing;
438}
1a248cf2
SB
439
440int submodule_uses_worktrees(const char *path)
441{
442 char *submodule_gitdir;
443 struct strbuf sb = STRBUF_INIT;
444 DIR *dir;
445 struct dirent *d;
7c4be458 446 int ret = 0;
1a248cf2
SB
447 struct repository_format format;
448
449 submodule_gitdir = git_pathdup_submodule(path, "%s", "");
450 if (!submodule_gitdir)
451 return 0;
452
453 /* The env would be set for the superproject. */
454 get_common_dir_noenv(&sb, submodule_gitdir);
d32de66a 455 free(submodule_gitdir);
1a248cf2
SB
456
457 /*
458 * The check below is only known to be good for repository format
459 * version 0 at the time of writing this code.
460 */
461 strbuf_addstr(&sb, "/config");
462 read_repository_format(&format, sb.buf);
463 if (format.version != 0) {
464 strbuf_release(&sb);
465 return 1;
466 }
467
468 /* Replace config by worktrees. */
469 strbuf_setlen(&sb, sb.len - strlen("config"));
470 strbuf_addstr(&sb, "worktrees");
471
472 /* See if there is any file inside the worktrees directory. */
473 dir = opendir(sb.buf);
474 strbuf_release(&sb);
1a248cf2
SB
475
476 if (!dir)
477 return 0;
478
479 while ((d = readdir(dir)) != NULL) {
480 if (is_dot_or_dotdot(d->d_name))
481 continue;
482
483 ret = 1;
484 break;
485 }
486 closedir(dir);
487 return ret;
488}
d0c39a49 489
3a3b9d8c
NTND
490int parse_worktree_ref(const char *worktree_ref, const char **name,
491 int *name_length, const char **ref)
492{
493 if (skip_prefix(worktree_ref, "main-worktree/", &worktree_ref)) {
494 if (!*worktree_ref)
495 return -1;
496 if (name)
497 *name = NULL;
498 if (name_length)
499 *name_length = 0;
500 if (ref)
501 *ref = worktree_ref;
502 return 0;
503 }
504 if (skip_prefix(worktree_ref, "worktrees/", &worktree_ref)) {
505 const char *slash = strchr(worktree_ref, '/');
506
507 if (!slash || slash == worktree_ref || !slash[1])
508 return -1;
509 if (name)
510 *name = worktree_ref;
511 if (name_length)
512 *name_length = slash - worktree_ref;
513 if (ref)
514 *ref = slash + 1;
515 return 0;
516 }
517 return -1;
518}
519
ab3e1f78
NTND
520void strbuf_worktree_ref(const struct worktree *wt,
521 struct strbuf *sb,
522 const char *refname)
523{
524 switch (ref_type(refname)) {
525 case REF_TYPE_PSEUDOREF:
526 case REF_TYPE_PER_WORKTREE:
527 if (wt && !wt->is_current) {
528 if (is_main_worktree(wt))
529 strbuf_addstr(sb, "main-worktree/");
530 else
531 strbuf_addf(sb, "worktrees/%s/", wt->id);
532 }
533 break;
534
535 case REF_TYPE_MAIN_PSEUDOREF:
536 case REF_TYPE_OTHER_PSEUDOREF:
537 break;
538
539 case REF_TYPE_NORMAL:
540 /*
541 * For shared refs, don't prefix worktrees/ or
542 * main-worktree/. It's not necessary and
543 * files-backend.c can't handle it anyway.
544 */
545 break;
546 }
547 strbuf_addstr(sb, refname);
548}
549
550const char *worktree_ref(const struct worktree *wt, const char *refname)
551{
552 static struct strbuf sb = STRBUF_INIT;
553
554 strbuf_reset(&sb);
555 strbuf_worktree_ref(wt, &sb, refname);
556 return sb.buf;
557}
558
d0c39a49
NTND
559int other_head_refs(each_ref_fn fn, void *cb_data)
560{
561 struct worktree **worktrees, **p;
562 int ret = 0;
563
564 worktrees = get_worktrees(0);
565 for (p = worktrees; *p; p++) {
566 struct worktree *wt = *p;
ab3e1f78
NTND
567 struct object_id oid;
568 int flag;
d0c39a49
NTND
569
570 if (wt->is_current)
571 continue;
572
ab3e1f78
NTND
573 if (!refs_read_ref_full(get_main_ref_store(the_repository),
574 worktree_ref(wt, "HEAD"),
575 RESOLVE_REF_READING,
576 &oid, &flag))
577 ret = fn(worktree_ref(wt, "HEAD"), &oid, flag, cb_data);
d0c39a49
NTND
578 if (ret)
579 break;
580 }
581 free_worktrees(worktrees);
582 return ret;
583}