Merge branch 'rs/commit-reach-leakfix'
[git] / worktree.c
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
9 void 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  */
26 static 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_oid, &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  */
47 static struct worktree *get_main_worktree(void)
48 {
49         struct worktree *worktree = NULL;
50         struct strbuf worktree_path = STRBUF_INIT;
51
52         strbuf_add_absolute_path(&worktree_path, get_git_common_dir());
53         strbuf_strip_suffix(&worktree_path, "/.");
54         if (!strbuf_strip_suffix(&worktree_path, "/.git"))
55                 strbuf_strip_suffix(&worktree_path, "/.");
56
57         worktree = xcalloc(1, sizeof(*worktree));
58         worktree->path = strbuf_detach(&worktree_path, NULL);
59         /*
60          * NEEDSWORK: If this function is called from a secondary worktree and
61          * config.worktree is present, is_bare_repository_cfg will reflect the
62          * contents of config.worktree, not the contents of the main worktree.
63          * This means that worktree->is_bare may be set to 0 even if the main
64          * worktree is configured to be bare.
65          */
66         worktree->is_bare = (is_bare_repository_cfg == 1) ||
67                 is_bare_repository();
68         add_head_info(worktree);
69
70         strbuf_release(&worktree_path);
71         return worktree;
72 }
73
74 static struct worktree *get_linked_worktree(const char *id)
75 {
76         struct worktree *worktree = NULL;
77         struct strbuf path = STRBUF_INIT;
78         struct strbuf worktree_path = STRBUF_INIT;
79
80         if (!id)
81                 die("Missing linked worktree name");
82
83         strbuf_git_common_path(&path, the_repository, "worktrees/%s/gitdir", id);
84         if (strbuf_read_file(&worktree_path, path.buf, 0) <= 0)
85                 /* invalid gitdir file */
86                 goto done;
87
88         strbuf_rtrim(&worktree_path);
89         if (!strbuf_strip_suffix(&worktree_path, "/.git")) {
90                 strbuf_reset(&worktree_path);
91                 strbuf_add_absolute_path(&worktree_path, ".");
92                 strbuf_strip_suffix(&worktree_path, "/.");
93         }
94
95         strbuf_reset(&path);
96         strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
97
98         worktree = xcalloc(1, sizeof(*worktree));
99         worktree->path = strbuf_detach(&worktree_path, NULL);
100         worktree->id = xstrdup(id);
101         add_head_info(worktree);
102
103 done:
104         strbuf_release(&path);
105         strbuf_release(&worktree_path);
106         return worktree;
107 }
108
109 static void mark_current_worktree(struct worktree **worktrees)
110 {
111         char *git_dir = absolute_pathdup(get_git_dir());
112         int i;
113
114         for (i = 0; worktrees[i]; i++) {
115                 struct worktree *wt = worktrees[i];
116                 const char *wt_git_dir = get_worktree_git_dir(wt);
117
118                 if (!fspathcmp(git_dir, absolute_path(wt_git_dir))) {
119                         wt->is_current = 1;
120                         break;
121                 }
122         }
123         free(git_dir);
124 }
125
126 static int compare_worktree(const void *a_, const void *b_)
127 {
128         const struct worktree *const *a = a_;
129         const struct worktree *const *b = b_;
130         return fspathcmp((*a)->path, (*b)->path);
131 }
132
133 struct worktree **get_worktrees(unsigned flags)
134 {
135         struct worktree **list = NULL;
136         struct strbuf path = STRBUF_INIT;
137         DIR *dir;
138         struct dirent *d;
139         int counter = 0, alloc = 2;
140
141         ALLOC_ARRAY(list, alloc);
142
143         list[counter++] = get_main_worktree();
144
145         strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
146         dir = opendir(path.buf);
147         strbuf_release(&path);
148         if (dir) {
149                 while ((d = readdir(dir)) != NULL) {
150                         struct worktree *linked = NULL;
151                         if (is_dot_or_dotdot(d->d_name))
152                                 continue;
153
154                         if ((linked = get_linked_worktree(d->d_name))) {
155                                 ALLOC_GROW(list, counter + 1, alloc);
156                                 list[counter++] = linked;
157                         }
158                 }
159                 closedir(dir);
160         }
161         ALLOC_GROW(list, counter + 1, alloc);
162         list[counter] = NULL;
163
164         if (flags & GWT_SORT_LINKED)
165                 /*
166                  * don't sort the first item (main worktree), which will
167                  * always be the first
168                  */
169                 QSORT(list + 1, counter - 1, compare_worktree);
170
171         mark_current_worktree(list);
172         return list;
173 }
174
175 const char *get_worktree_git_dir(const struct worktree *wt)
176 {
177         if (!wt)
178                 return get_git_dir();
179         else if (!wt->id)
180                 return get_git_common_dir();
181         else
182                 return git_common_path("worktrees/%s", wt->id);
183 }
184
185 static struct worktree *find_worktree_by_suffix(struct worktree **list,
186                                                 const char *suffix)
187 {
188         struct worktree *found = NULL;
189         int nr_found = 0, suffixlen;
190
191         suffixlen = strlen(suffix);
192         if (!suffixlen)
193                 return NULL;
194
195         for (; *list && nr_found < 2; list++) {
196                 const char      *path    = (*list)->path;
197                 int              pathlen = strlen(path);
198                 int              start   = pathlen - suffixlen;
199
200                 /* suffix must start at directory boundary */
201                 if ((!start || (start > 0 && is_dir_sep(path[start - 1]))) &&
202                     !fspathcmp(suffix, path + start)) {
203                         found = *list;
204                         nr_found++;
205                 }
206         }
207         return nr_found == 1 ? found : NULL;
208 }
209
210 struct worktree *find_worktree(struct worktree **list,
211                                const char *prefix,
212                                const char *arg)
213 {
214         struct worktree *wt;
215         char *to_free = NULL;
216
217         if ((wt = find_worktree_by_suffix(list, arg)))
218                 return wt;
219
220         if (prefix)
221                 arg = to_free = prefix_filename(prefix, arg);
222         wt = find_worktree_by_path(list, arg);
223         free(to_free);
224         return wt;
225 }
226
227 struct worktree *find_worktree_by_path(struct worktree **list, const char *p)
228 {
229         struct strbuf wt_path = STRBUF_INIT;
230         char *path = real_pathdup(p, 0);
231
232         if (!path)
233                 return NULL;
234         for (; *list; list++) {
235                 if (!strbuf_realpath(&wt_path, (*list)->path, 0))
236                         continue;
237
238                 if (!fspathcmp(path, wt_path.buf))
239                         break;
240         }
241         free(path);
242         strbuf_release(&wt_path);
243         return *list;
244 }
245
246 int is_main_worktree(const struct worktree *wt)
247 {
248         return !wt->id;
249 }
250
251 const char *worktree_lock_reason(struct worktree *wt)
252 {
253         assert(!is_main_worktree(wt));
254
255         if (!wt->lock_reason_valid) {
256                 struct strbuf path = STRBUF_INIT;
257
258                 strbuf_addstr(&path, worktree_git_path(wt, "locked"));
259                 if (file_exists(path.buf)) {
260                         struct strbuf lock_reason = STRBUF_INIT;
261                         if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
262                                 die_errno(_("failed to read '%s'"), path.buf);
263                         strbuf_trim(&lock_reason);
264                         wt->lock_reason = strbuf_detach(&lock_reason, NULL);
265                 } else
266                         wt->lock_reason = NULL;
267                 wt->lock_reason_valid = 1;
268                 strbuf_release(&path);
269         }
270
271         return wt->lock_reason;
272 }
273
274 /* convenient wrapper to deal with NULL strbuf */
275 static void strbuf_addf_gently(struct strbuf *buf, const char *fmt, ...)
276 {
277         va_list params;
278
279         if (!buf)
280                 return;
281
282         va_start(params, fmt);
283         strbuf_vaddf(buf, fmt, params);
284         va_end(params);
285 }
286
287 int validate_worktree(const struct worktree *wt, struct strbuf *errmsg,
288                       unsigned flags)
289 {
290         struct strbuf wt_path = STRBUF_INIT;
291         struct strbuf realpath = STRBUF_INIT;
292         char *path = NULL;
293         int err, ret = -1;
294
295         strbuf_addf(&wt_path, "%s/.git", wt->path);
296
297         if (is_main_worktree(wt)) {
298                 if (is_directory(wt_path.buf)) {
299                         ret = 0;
300                         goto done;
301                 }
302                 /*
303                  * Main worktree using .git file to point to the
304                  * repository would make it impossible to know where
305                  * the actual worktree is if this function is executed
306                  * from another worktree. No .git file support for now.
307                  */
308                 strbuf_addf_gently(errmsg,
309                                    _("'%s' at main working tree is not the repository directory"),
310                                    wt_path.buf);
311                 goto done;
312         }
313
314         /*
315          * Make sure "gitdir" file points to a real .git file and that
316          * file points back here.
317          */
318         if (!is_absolute_path(wt->path)) {
319                 strbuf_addf_gently(errmsg,
320                                    _("'%s' file does not contain absolute path to the working tree location"),
321                                    git_common_path("worktrees/%s/gitdir", wt->id));
322                 goto done;
323         }
324
325         if (flags & WT_VALIDATE_WORKTREE_MISSING_OK &&
326             !file_exists(wt->path)) {
327                 ret = 0;
328                 goto done;
329         }
330
331         if (!file_exists(wt_path.buf)) {
332                 strbuf_addf_gently(errmsg, _("'%s' does not exist"), wt_path.buf);
333                 goto done;
334         }
335
336         path = xstrdup_or_null(read_gitfile_gently(wt_path.buf, &err));
337         if (!path) {
338                 strbuf_addf_gently(errmsg, _("'%s' is not a .git file, error code %d"),
339                                    wt_path.buf, err);
340                 goto done;
341         }
342
343         strbuf_realpath(&realpath, git_common_path("worktrees/%s", wt->id), 1);
344         ret = fspathcmp(path, realpath.buf);
345
346         if (ret)
347                 strbuf_addf_gently(errmsg, _("'%s' does not point back to '%s'"),
348                                    wt->path, git_common_path("worktrees/%s", wt->id));
349 done:
350         free(path);
351         strbuf_release(&wt_path);
352         strbuf_release(&realpath);
353         return ret;
354 }
355
356 void update_worktree_location(struct worktree *wt, const char *path_)
357 {
358         struct strbuf path = STRBUF_INIT;
359
360         if (is_main_worktree(wt))
361                 BUG("can't relocate main worktree");
362
363         strbuf_realpath(&path, path_, 1);
364         if (fspathcmp(wt->path, path.buf)) {
365                 write_file(git_common_path("worktrees/%s/gitdir", wt->id),
366                            "%s/.git", path.buf);
367                 free(wt->path);
368                 wt->path = strbuf_detach(&path, NULL);
369         }
370         strbuf_release(&path);
371 }
372
373 int is_worktree_being_rebased(const struct worktree *wt,
374                               const char *target)
375 {
376         struct wt_status_state state;
377         int found_rebase;
378
379         memset(&state, 0, sizeof(state));
380         found_rebase = wt_status_check_rebase(wt, &state) &&
381                 ((state.rebase_in_progress ||
382                   state.rebase_interactive_in_progress) &&
383                  state.branch &&
384                  starts_with(target, "refs/heads/") &&
385                  !strcmp(state.branch, target + strlen("refs/heads/")));
386         free(state.branch);
387         free(state.onto);
388         return found_rebase;
389 }
390
391 int is_worktree_being_bisected(const struct worktree *wt,
392                                const char *target)
393 {
394         struct wt_status_state state;
395         int found_rebase;
396
397         memset(&state, 0, sizeof(state));
398         found_rebase = wt_status_check_bisect(wt, &state) &&
399                 state.branch &&
400                 starts_with(target, "refs/heads/") &&
401                 !strcmp(state.branch, target + strlen("refs/heads/"));
402         free(state.branch);
403         return found_rebase;
404 }
405
406 /*
407  * note: this function should be able to detect shared symref even if
408  * HEAD is temporarily detached (e.g. in the middle of rebase or
409  * bisect). New commands that do similar things should update this
410  * function as well.
411  */
412 const struct worktree *find_shared_symref(const char *symref,
413                                           const char *target)
414 {
415         const struct worktree *existing = NULL;
416         static struct worktree **worktrees;
417         int i = 0;
418
419         if (worktrees)
420                 free_worktrees(worktrees);
421         worktrees = get_worktrees(0);
422
423         for (i = 0; worktrees[i]; i++) {
424                 struct worktree *wt = worktrees[i];
425                 const char *symref_target;
426                 struct ref_store *refs;
427                 int flags;
428
429                 if (wt->is_bare)
430                         continue;
431
432                 if (wt->is_detached && !strcmp(symref, "HEAD")) {
433                         if (is_worktree_being_rebased(wt, target)) {
434                                 existing = wt;
435                                 break;
436                         }
437                         if (is_worktree_being_bisected(wt, target)) {
438                                 existing = wt;
439                                 break;
440                         }
441                 }
442
443                 refs = get_worktree_ref_store(wt);
444                 symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
445                                                         NULL, &flags);
446                 if ((flags & REF_ISSYMREF) &&
447                     symref_target && !strcmp(symref_target, target)) {
448                         existing = wt;
449                         break;
450                 }
451         }
452
453         return existing;
454 }
455
456 int submodule_uses_worktrees(const char *path)
457 {
458         char *submodule_gitdir;
459         struct strbuf sb = STRBUF_INIT, err = STRBUF_INIT;
460         DIR *dir;
461         struct dirent *d;
462         int ret = 0;
463         struct repository_format format = REPOSITORY_FORMAT_INIT;
464
465         submodule_gitdir = git_pathdup_submodule(path, "%s", "");
466         if (!submodule_gitdir)
467                 return 0;
468
469         /* The env would be set for the superproject. */
470         get_common_dir_noenv(&sb, submodule_gitdir);
471         free(submodule_gitdir);
472
473         strbuf_addstr(&sb, "/config");
474         read_repository_format(&format, sb.buf);
475         if (verify_repository_format(&format, &err)) {
476                 strbuf_release(&err);
477                 strbuf_release(&sb);
478                 clear_repository_format(&format);
479                 return 1;
480         }
481         clear_repository_format(&format);
482         strbuf_release(&err);
483
484         /* Replace config by worktrees. */
485         strbuf_setlen(&sb, sb.len - strlen("config"));
486         strbuf_addstr(&sb, "worktrees");
487
488         /* See if there is any file inside the worktrees directory. */
489         dir = opendir(sb.buf);
490         strbuf_release(&sb);
491
492         if (!dir)
493                 return 0;
494
495         while ((d = readdir(dir)) != NULL) {
496                 if (is_dot_or_dotdot(d->d_name))
497                         continue;
498
499                 ret = 1;
500                 break;
501         }
502         closedir(dir);
503         return ret;
504 }
505
506 int parse_worktree_ref(const char *worktree_ref, const char **name,
507                        int *name_length, const char **ref)
508 {
509         if (skip_prefix(worktree_ref, "main-worktree/", &worktree_ref)) {
510                 if (!*worktree_ref)
511                         return -1;
512                 if (name)
513                         *name = NULL;
514                 if (name_length)
515                         *name_length = 0;
516                 if (ref)
517                         *ref = worktree_ref;
518                 return 0;
519         }
520         if (skip_prefix(worktree_ref, "worktrees/", &worktree_ref)) {
521                 const char *slash = strchr(worktree_ref, '/');
522
523                 if (!slash || slash == worktree_ref || !slash[1])
524                         return -1;
525                 if (name)
526                         *name = worktree_ref;
527                 if (name_length)
528                         *name_length = slash - worktree_ref;
529                 if (ref)
530                         *ref = slash + 1;
531                 return 0;
532         }
533         return -1;
534 }
535
536 void strbuf_worktree_ref(const struct worktree *wt,
537                          struct strbuf *sb,
538                          const char *refname)
539 {
540         switch (ref_type(refname)) {
541         case REF_TYPE_PSEUDOREF:
542         case REF_TYPE_PER_WORKTREE:
543                 if (wt && !wt->is_current) {
544                         if (is_main_worktree(wt))
545                                 strbuf_addstr(sb, "main-worktree/");
546                         else
547                                 strbuf_addf(sb, "worktrees/%s/", wt->id);
548                 }
549                 break;
550
551         case REF_TYPE_MAIN_PSEUDOREF:
552         case REF_TYPE_OTHER_PSEUDOREF:
553                 break;
554
555         case REF_TYPE_NORMAL:
556                 /*
557                  * For shared refs, don't prefix worktrees/ or
558                  * main-worktree/. It's not necessary and
559                  * files-backend.c can't handle it anyway.
560                  */
561                 break;
562         }
563         strbuf_addstr(sb, refname);
564 }
565
566 const char *worktree_ref(const struct worktree *wt, const char *refname)
567 {
568         static struct strbuf sb = STRBUF_INIT;
569
570         strbuf_reset(&sb);
571         strbuf_worktree_ref(wt, &sb, refname);
572         return sb.buf;
573 }
574
575 int other_head_refs(each_ref_fn fn, void *cb_data)
576 {
577         struct worktree **worktrees, **p;
578         int ret = 0;
579
580         worktrees = get_worktrees(0);
581         for (p = worktrees; *p; p++) {
582                 struct worktree *wt = *p;
583                 struct object_id oid;
584                 int flag;
585
586                 if (wt->is_current)
587                         continue;
588
589                 if (!refs_read_ref_full(get_main_ref_store(the_repository),
590                                         worktree_ref(wt, "HEAD"),
591                                         RESOLVE_REF_READING,
592                                         &oid, &flag))
593                         ret = fn(worktree_ref(wt, "HEAD"), &oid, flag, cb_data);
594                 if (ret)
595                         break;
596         }
597         free_worktrees(worktrees);
598         return ret;
599 }