]> git.proxmox.com Git - libgit2.git/blame - src/worktree.c
Merge pull request #4191 from pks-t/pks/wt-ref-renames
[libgit2.git] / src / worktree.c
CommitLineData
45f2b7a4
PS
1/*
2 * Copyright (C) the libgit2 contributors. All rights reserved.
3 *
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
6 */
7
dea7488e
PS
8#include "common.h"
9
10#include "git2/branch.h"
11#include "git2/commit.h"
45f2b7a4
PS
12#include "git2/worktree.h"
13
45f2b7a4 14#include "repository.h"
d3bc09e8 15#include "worktree.h"
45f2b7a4 16
3e9c5d8a 17static bool is_worktree_dir(const char *dir)
45f2b7a4 18{
3e9c5d8a
PS
19 git_buf buf = GIT_BUF_INIT;
20 int error;
21
22 if (git_buf_sets(&buf, dir) < 0)
23 return -1;
24
25 error = git_path_contains_file(&buf, "commondir")
26 && git_path_contains_file(&buf, "gitdir")
27 && git_path_contains_file(&buf, "HEAD");
28
29 git_buf_free(&buf);
30 return error;
45f2b7a4
PS
31}
32
33int git_worktree_list(git_strarray *wts, git_repository *repo)
34{
35 git_vector worktrees = GIT_VECTOR_INIT;
36 git_buf path = GIT_BUF_INIT;
37 char *worktree;
38 unsigned i, len;
39 int error;
40
41 assert(wts && repo);
42
43 wts->count = 0;
44 wts->strings = NULL;
45
46 if ((error = git_buf_printf(&path, "%s/worktrees/", repo->commondir)) < 0)
47 goto exit;
48 if (!git_path_exists(path.ptr) || git_path_is_empty_dir(path.ptr))
49 goto exit;
50 if ((error = git_path_dirload(&worktrees, path.ptr, path.size, 0x0)) < 0)
51 goto exit;
52
53 len = path.size;
54
55 git_vector_foreach(&worktrees, i, worktree) {
56 git_buf_truncate(&path, len);
57 git_buf_puts(&path, worktree);
58
3e9c5d8a 59 if (!is_worktree_dir(path.ptr)) {
45f2b7a4
PS
60 git_vector_remove(&worktrees, i);
61 git__free(worktree);
62 }
63 }
64
65 wts->strings = (char **)git_vector_detach(&wts->count, NULL, &worktrees);
66
67exit:
68 git_buf_free(&path);
69
70 return error;
71}
d3bc09e8 72
39abd3ad 73char *git_worktree__read_link(const char *base, const char *file)
d3bc09e8
PS
74{
75 git_buf path = GIT_BUF_INIT, buf = GIT_BUF_INIT;
76
77 assert(base && file);
78
79 if (git_buf_joinpath(&path, base, file) < 0)
80 goto err;
81 if (git_futils_readbuffer(&buf, path.ptr) < 0)
82 goto err;
83 git_buf_free(&path);
84
85 git_buf_rtrim(&buf);
86
87 if (!git_path_is_relative(buf.ptr))
88 return git_buf_detach(&buf);
89
90 if (git_buf_sets(&path, base) < 0)
91 goto err;
92 if (git_path_apply_relative(&path, buf.ptr) < 0)
93 goto err;
94 git_buf_free(&buf);
95
96 return git_buf_detach(&path);
97
98err:
99 git_buf_free(&buf);
100 git_buf_free(&path);
101
102 return NULL;
103}
104
dea7488e
PS
105static int write_wtfile(const char *base, const char *file, const git_buf *buf)
106{
107 git_buf path = GIT_BUF_INIT;
108 int err;
109
110 assert(base && file && buf);
111
112 if ((err = git_buf_joinpath(&path, base, file)) < 0)
113 goto out;
114
115 if ((err = git_futils_writebuffer(buf, path.ptr, O_CREAT|O_EXCL|O_WRONLY, 0644)) < 0)
116 goto out;
117
118out:
119 git_buf_free(&path);
120
121 return err;
122}
123
dfc98706 124static int open_worktree_dir(git_worktree **out, const char *parent, const char *dir, const char *name)
d3bc09e8 125{
dfc98706 126 git_buf gitdir = GIT_BUF_INIT;
d3bc09e8 127 git_worktree *wt = NULL;
dfc98706 128 int error = 0;
d3bc09e8 129
dfc98706 130 if (!is_worktree_dir(dir)) {
d3bc09e8
PS
131 error = -1;
132 goto out;
133 }
134
dfc98706 135 if ((wt = git__calloc(1, sizeof(struct git_repository))) == NULL) {
d3bc09e8
PS
136 error = -1;
137 goto out;
138 }
139
140 if ((wt->name = git__strdup(name)) == NULL
dfc98706
PS
141 || (wt->commondir_path = git_worktree__read_link(dir, "commondir")) == NULL
142 || (wt->gitlink_path = git_worktree__read_link(dir, "gitdir")) == NULL
143 || (wt->parent_path = git__strdup(parent)) == NULL) {
d3bc09e8
PS
144 error = -1;
145 goto out;
146 }
dfc98706
PS
147
148 if ((error = git_path_prettify_dir(&gitdir, dir, NULL)) < 0)
149 goto out;
150 wt->gitdir_path = git_buf_detach(&gitdir);
151
2a503485 152 wt->locked = !!git_worktree_is_locked(NULL, wt);
d3bc09e8 153
dfc98706
PS
154 *out = wt;
155
156out:
157 if (error)
158 git_worktree_free(wt);
159 git_buf_free(&gitdir);
160
161 return error;
162}
163
164int git_worktree_lookup(git_worktree **out, git_repository *repo, const char *name)
165{
166 git_buf path = GIT_BUF_INIT;
167 git_worktree *wt = NULL;
168 int error;
169
170 assert(repo && name);
171
172 *out = NULL;
173
174 if ((error = git_buf_printf(&path, "%s/worktrees/%s", repo->commondir, name)) < 0)
175 goto out;
176
20a368e2 177 if ((error = (open_worktree_dir(out, git_repository_workdir(repo), path.ptr, name))) < 0)
dfc98706 178 goto out;
d3bc09e8
PS
179
180out:
181 git_buf_free(&path);
182
183 if (error)
184 git_worktree_free(wt);
185
186 return error;
187}
188
3017ba94
PS
189int git_worktree_open_from_repository(git_worktree **out, git_repository *repo)
190{
191 git_buf parent = GIT_BUF_INIT;
192 const char *gitdir, *commondir;
193 char *name = NULL;
194 int error = 0;
195
196 if (!git_repository_is_worktree(repo)) {
197 giterr_set(GITERR_WORKTREE, "cannot open worktree of a non-worktree repo");
198 error = -1;
199 goto out;
200 }
201
202 gitdir = git_repository_path(repo);
203 commondir = git_repository_commondir(repo);
204
20a368e2 205 if ((error = git_path_prettify_dir(&parent, "..", commondir)) < 0)
3017ba94
PS
206 goto out;
207
208 /* The name is defined by the last component in '.git/worktree/%s' */
209 name = git_path_basename(gitdir);
210
211 if ((error = open_worktree_dir(out, parent.ptr, gitdir, name)) < 0)
212 goto out;
213
214out:
fbdf2a79 215 free(name);
3017ba94
PS
216 git_buf_free(&parent);
217
218 return error;
219}
220
d3bc09e8
PS
221void git_worktree_free(git_worktree *wt)
222{
223 if (!wt)
224 return;
225
226 git__free(wt->commondir_path);
227 git__free(wt->gitlink_path);
228 git__free(wt->gitdir_path);
229 git__free(wt->parent_path);
230 git__free(wt->name);
231 git__free(wt);
232}
372dc9ff
PS
233
234int git_worktree_validate(const git_worktree *wt)
235{
236 git_buf buf = GIT_BUF_INIT;
237 int err = 0;
238
239 assert(wt);
240
241 git_buf_puts(&buf, wt->gitdir_path);
3e9c5d8a 242 if (!is_worktree_dir(buf.ptr)) {
372dc9ff
PS
243 giterr_set(GITERR_WORKTREE,
244 "Worktree gitdir ('%s') is not valid",
245 wt->gitlink_path);
246 err = -1;
247 goto out;
248 }
249
250 if (!git_path_exists(wt->parent_path)) {
251 giterr_set(GITERR_WORKTREE,
252 "Worktree parent directory ('%s') does not exist ",
253 wt->parent_path);
254 err = -2;
255 goto out;
256 }
257
258 if (!git_path_exists(wt->commondir_path)) {
259 giterr_set(GITERR_WORKTREE,
260 "Worktree common directory ('%s') does not exist ",
261 wt->commondir_path);
262 err = -3;
263 goto out;
264 }
265
266out:
267 git_buf_free(&buf);
268
269 return err;
270}
dea7488e
PS
271
272int git_worktree_add(git_worktree **out, git_repository *repo, const char *name, const char *worktree)
273{
8f154be3 274 git_buf gitdir = GIT_BUF_INIT, wddir = GIT_BUF_INIT, buf = GIT_BUF_INIT;
dea7488e
PS
275 git_reference *ref = NULL, *head = NULL;
276 git_commit *commit = NULL;
277 git_repository *wt = NULL;
278 git_checkout_options coopts = GIT_CHECKOUT_OPTIONS_INIT;
279 int err;
280
281 assert(out && repo && name && worktree);
282
283 *out = NULL;
284
7cf7a407
PS
285 /* Create gitdir directory ".git/worktrees/<name>" */
286 if ((err = git_buf_joinpath(&gitdir, repo->commondir, "worktrees")) < 0)
dea7488e 287 goto out;
7cf7a407
PS
288 if (!git_path_exists(gitdir.ptr))
289 if ((err = git_futils_mkdir(gitdir.ptr, 0755, GIT_MKDIR_EXCL)) < 0)
dea7488e 290 goto out;
7cf7a407 291 if ((err = git_buf_joinpath(&gitdir, gitdir.ptr, name)) < 0)
dea7488e 292 goto out;
7cf7a407 293 if ((err = git_futils_mkdir(gitdir.ptr, 0755, GIT_MKDIR_EXCL)) < 0)
dea7488e 294 goto out;
8f154be3
PS
295 if ((err = git_path_prettify_dir(&gitdir, gitdir.ptr, NULL)) < 0)
296 goto out;
dea7488e
PS
297
298 /* Create worktree work dir */
299 if ((err = git_futils_mkdir(worktree, 0755, GIT_MKDIR_EXCL)) < 0)
300 goto out;
8f154be3
PS
301 if ((err = git_path_prettify_dir(&wddir, worktree, NULL)) < 0)
302 goto out;
dea7488e
PS
303
304 /* Create worktree .git file */
7cf7a407 305 if ((err = git_buf_printf(&buf, "gitdir: %s\n", gitdir.ptr)) < 0)
dea7488e 306 goto out;
8f154be3 307 if ((err = write_wtfile(wddir.ptr, ".git", &buf)) < 0)
dea7488e
PS
308 goto out;
309
7cf7a407 310 /* Create gitdir files */
8f154be3 311 if ((err = git_path_prettify_dir(&buf, repo->commondir, NULL) < 0)
dea7488e 312 || (err = git_buf_putc(&buf, '\n')) < 0
7cf7a407 313 || (err = write_wtfile(gitdir.ptr, "commondir", &buf)) < 0)
dea7488e 314 goto out;
8f154be3 315 if ((err = git_buf_joinpath(&buf, wddir.ptr, ".git")) < 0
dea7488e 316 || (err = git_buf_putc(&buf, '\n')) < 0
7cf7a407 317 || (err = write_wtfile(gitdir.ptr, "gitdir", &buf)) < 0)
dea7488e
PS
318 goto out;
319
320 /* Create new branch */
321 if ((err = git_repository_head(&head, repo)) < 0)
322 goto out;
323 if ((err = git_commit_lookup(&commit, repo, &head->target.oid)) < 0)
324 goto out;
325 if ((err = git_branch_create(&ref, repo, name, commit, false)) < 0)
326 goto out;
327
328 /* Set worktree's HEAD */
7cf7a407 329 if ((err = git_repository_create_head(gitdir.ptr, git_reference_name(ref))) < 0)
dea7488e 330 goto out;
8f154be3 331 if ((err = git_repository_open(&wt, wddir.ptr)) < 0)
dea7488e
PS
332 goto out;
333
334 /* Checkout worktree's HEAD */
335 coopts.checkout_strategy = GIT_CHECKOUT_FORCE;
336 if ((err = git_checkout_head(wt, &coopts)) < 0)
337 goto out;
338
339 /* Load result */
340 if ((err = git_worktree_lookup(out, repo, name)) < 0)
341 goto out;
342
343out:
7cf7a407 344 git_buf_free(&gitdir);
8f154be3 345 git_buf_free(&wddir);
dea7488e
PS
346 git_buf_free(&buf);
347 git_reference_free(ref);
348 git_reference_free(head);
349 git_commit_free(commit);
350 git_repository_free(wt);
351
352 return err;
353}
2a503485
PS
354
355int git_worktree_lock(git_worktree *wt, char *creason)
356{
357 git_buf buf = GIT_BUF_INIT, path = GIT_BUF_INIT;
358 int err;
359
360 assert(wt);
361
362 if ((err = git_worktree_is_locked(NULL, wt)) < 0)
363 goto out;
364
365 if ((err = git_buf_joinpath(&path, wt->gitdir_path, "locked")) < 0)
366 goto out;
367
368 if (creason)
369 git_buf_attach_notowned(&buf, creason, strlen(creason));
370
371 if ((err = git_futils_writebuffer(&buf, path.ptr, O_CREAT|O_EXCL|O_WRONLY, 0644)) < 0)
372 goto out;
373
374 wt->locked = 1;
375
376out:
377 git_buf_free(&path);
378
379 return err;
380}
381
382int git_worktree_unlock(git_worktree *wt)
383{
384 git_buf path = GIT_BUF_INIT;
385
386 assert(wt);
387
388 if (!git_worktree_is_locked(NULL, wt))
389 return 0;
390
391 if (git_buf_joinpath(&path, wt->gitdir_path, "locked") < 0)
392 return -1;
393
394 if (p_unlink(path.ptr) != 0) {
395 git_buf_free(&path);
396 return -1;
397 }
398
399 wt->locked = 0;
400
401 git_buf_free(&path);
402
403 return 0;
404}
405
406int git_worktree_is_locked(git_buf *reason, const git_worktree *wt)
407{
408 git_buf path = GIT_BUF_INIT;
409 int ret;
410
411 assert(wt);
412
413 if (reason)
414 git_buf_clear(reason);
415
416 if ((ret = git_buf_joinpath(&path, wt->gitdir_path, "locked")) < 0)
417 goto out;
418 if ((ret = git_path_exists(path.ptr)) && reason)
419 git_futils_readbuffer(reason, path.ptr);
420
421out:
422 git_buf_free(&path);
423
424 return ret;
425}
f0cfc341 426
1ba242c9 427int git_worktree_is_prunable(git_worktree *wt, unsigned flags)
f0cfc341 428{
1ba242c9 429 git_buf reason = GIT_BUF_INIT;
f0cfc341
PS
430
431 if ((flags & GIT_WORKTREE_PRUNE_LOCKED) == 0 &&
432 git_worktree_is_locked(&reason, wt))
433 {
434 if (!reason.size)
435 git_buf_attach_notowned(&reason, "no reason given", 15);
436 giterr_set(GITERR_WORKTREE, "Not pruning locked working tree: '%s'", reason.ptr);
1ba242c9 437 git_buf_free(&reason);
f0cfc341 438
1ba242c9 439 return 0;
f0cfc341
PS
440 }
441
442 if ((flags & GIT_WORKTREE_PRUNE_VALID) == 0 &&
443 git_worktree_validate(wt) == 0)
444 {
445 giterr_set(GITERR_WORKTREE, "Not pruning valid working tree");
1ba242c9
PS
446 return 0;
447 }
448
449 return 1;
450}
451
452int git_worktree_prune(git_worktree *wt, unsigned flags)
453{
454 git_buf path = GIT_BUF_INIT;
455 char *wtpath;
456 int err;
457
458 if (!git_worktree_is_prunable(wt, flags)) {
f0cfc341
PS
459 err = -1;
460 goto out;
461 }
462
463 /* Delete gitdir in parent repository */
20a368e2 464 if ((err = git_buf_printf(&path, "%s/worktrees/%s", wt->commondir_path, wt->name)) < 0)
f0cfc341
PS
465 goto out;
466 if (!git_path_exists(path.ptr))
467 {
468 giterr_set(GITERR_WORKTREE, "Worktree gitdir '%s' does not exist", path.ptr);
469 err = -1;
470 goto out;
471 }
472 if ((err = git_futils_rmdir_r(path.ptr, NULL, GIT_RMDIR_REMOVE_FILES)) < 0)
473 goto out;
474
475 /* Skip deletion of the actual working tree if it does
476 * not exist or deletion was not requested */
477 if ((flags & GIT_WORKTREE_PRUNE_WORKING_TREE) == 0 ||
478 !git_path_exists(wt->gitlink_path))
479 {
480 goto out;
481 }
482
483 if ((wtpath = git_path_dirname(wt->gitlink_path)) == NULL)
484 goto out;
485 git_buf_attach(&path, wtpath, 0);
486 if (!git_path_exists(path.ptr))
487 {
488 giterr_set(GITERR_WORKTREE, "Working tree '%s' does not exist", path.ptr);
489 err = -1;
490 goto out;
491 }
492 if ((err = git_futils_rmdir_r(path.ptr, NULL, GIT_RMDIR_REMOVE_FILES)) < 0)
493 goto out;
494
495out:
f0cfc341
PS
496 git_buf_free(&path);
497
498 return err;
499}