2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include <sys/limits.h>
19 #include <sys/queue.h>
31 #include "got_error.h"
32 #include "got_repository.h"
33 #include "got_reference.h"
34 #include "got_object.h"
35 #include "got_worktree.h"
37 #include "got_lib_worktree.h"
38 #include "got_lib_path.h"
39 #include "got_lib_sha1.h"
40 #include "got_lib_fileindex.h"
41 #include "got_lib_zbuf.h"
42 #include "got_lib_delta.h"
43 #include "got_lib_object.h"
46 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
49 static const struct got_error *
50 create_meta_file(const char *path_got, const char *name, const char *content)
52 const struct got_error *err = NULL;
58 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
59 err = got_error_from_errno();
64 fd = open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
65 GOT_DEFAULT_FILE_MODE);
67 err = got_error_from_errno();
71 /* The file should be empty. */
72 n = read(fd, buf, sizeof(buf));
74 err = (n == -1 ? got_error_from_errno() :
75 got_error(GOT_ERR_WORKTREE_EXISTS));
80 int len = dprintf(fd, "%s\n", content);
81 if (len != strlen(content) + 1) {
82 err = got_error_from_errno();
88 if (fd != -1 && close(fd) == -1 && err == NULL)
89 err = got_error_from_errno();
94 static const struct got_error *
95 read_meta_file(char **content, const char *path_got, const char *name)
97 const struct got_error *err = NULL;
105 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
106 err = got_error_from_errno();
111 fd = open(path, O_RDONLY | O_NOFOLLOW);
113 err = got_error_from_errno();
116 if (flock(fd, LOCK_SH | LOCK_NB) == -1) {
117 err = (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
118 : got_error_from_errno());
123 *content = calloc(1, sb.st_size);
124 if (*content == NULL) {
125 err = got_error_from_errno();
129 n = read(fd, *content, sb.st_size);
130 if (n != sb.st_size) {
131 err = (n == -1 ? got_error_from_errno() :
132 got_error(GOT_ERR_WORKTREE_META));
135 if ((*content)[sb.st_size - 1] != '\n') {
136 err = got_error(GOT_ERR_WORKTREE_META);
139 (*content)[sb.st_size - 1] = '\0';
142 if (fd != -1 && close(fd) == -1 && err == NULL)
143 err = got_error_from_errno();
152 const struct got_error *
153 got_worktree_init(const char *path, struct got_reference *head_ref,
154 const char *prefix, struct got_repository *repo)
156 const struct got_error *err = NULL;
157 char *path_got = NULL;
159 char *repo_path = NULL;
160 char *formatstr = NULL;
161 char *absprefix = NULL;
163 if (!got_path_is_absolute(prefix)) {
164 if (asprintf(&absprefix, "/%s", prefix) == -1)
165 return got_error_from_errno();
168 /* Create top-level directory (may already exist). */
169 if (mkdir(path, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST) {
170 err = got_error_from_errno();
174 /* Create .got directory (may already exist). */
175 if (asprintf(&path_got, "%s/%s", path, GOT_WORKTREE_GOT_DIR) == -1) {
176 err = got_error_from_errno();
179 if (mkdir(path_got, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST) {
180 err = got_error_from_errno();
184 /* Create an empty lock file. */
185 err = create_meta_file(path_got, GOT_WORKTREE_LOCK, NULL);
189 /* Create an empty file index. */
190 err = create_meta_file(path_got, GOT_WORKTREE_FILE_INDEX, NULL);
194 /* Write the HEAD reference. */
195 refstr = got_ref_to_str(head_ref);
196 if (refstr == NULL) {
197 err = got_error_from_errno();
200 err = create_meta_file(path_got, GOT_WORKTREE_HEAD, refstr);
204 /* Store path to repository. */
205 repo_path = got_repo_get_path(repo);
206 if (repo_path == NULL) {
207 err = got_error_from_errno();
210 err = create_meta_file(path_got, GOT_WORKTREE_REPOSITORY, repo_path);
214 /* Store in-repository path prefix. */
215 err = create_meta_file(path_got, GOT_WORKTREE_PATH_PREFIX,
216 absprefix ? absprefix : prefix);
220 /* Stamp work tree with format file. */
221 if (asprintf(&formatstr, "%d", GOT_WORKTREE_FORMAT_VERSION) == -1) {
222 err = got_error_from_errno();
225 err = create_meta_file(path_got, GOT_WORKTREE_FORMAT, formatstr);
238 const struct got_error *
239 got_worktree_open(struct got_worktree **worktree, const char *path)
241 const struct got_error *err = NULL;
243 char *formatstr = NULL;
244 char *path_lock = NULL;
245 int version, fd = -1;
250 if (asprintf(&path_got, "%s/%s", path, GOT_WORKTREE_GOT_DIR) == -1) {
251 err = got_error_from_errno();
256 if (asprintf(&path_lock, "%s/%s", path_got, GOT_WORKTREE_LOCK) == -1) {
257 err = got_error_from_errno();
262 fd = open(path_lock, O_RDWR | O_EXLOCK | O_NONBLOCK);
264 err = (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
265 : got_error_from_errno());
269 err = read_meta_file(&formatstr, path_got, GOT_WORKTREE_FORMAT);
273 version = strtonum(formatstr, 1, INT_MAX, &errstr);
275 err = got_error(GOT_ERR_WORKTREE_META);
278 if (version != GOT_WORKTREE_FORMAT_VERSION) {
279 err = got_error(GOT_ERR_WORKTREE_VERS);
283 *worktree = calloc(1, sizeof(**worktree));
284 if (*worktree == NULL) {
285 err = got_error_from_errno();
288 (*worktree)->lockfd = -1;
290 (*worktree)->root_path = strdup(path);
291 if ((*worktree)->root_path == NULL) {
292 err = got_error_from_errno();
295 err = read_meta_file(&(*worktree)->repo_path, path_got,
296 GOT_WORKTREE_REPOSITORY);
299 err = read_meta_file(&(*worktree)->path_prefix, path_got,
300 GOT_WORKTREE_PATH_PREFIX);
304 err = read_meta_file(&(*worktree)->head_ref, path_got,
315 if (*worktree != NULL)
316 got_worktree_close(*worktree);
319 (*worktree)->lockfd = fd;
325 got_worktree_close(struct got_worktree *worktree)
327 free(worktree->root_path);
328 free(worktree->repo_path);
329 free(worktree->path_prefix);
330 free(worktree->base_commit);
331 free(worktree->head_ref);
332 if (worktree->lockfd != -1)
333 close(worktree->lockfd);
338 got_worktree_get_repo_path(struct got_worktree *worktree)
340 return strdup(worktree->repo_path);
344 got_worktree_get_head_ref_name(struct got_worktree *worktree)
346 return strdup(worktree->head_ref);
349 static const struct got_error *
350 lock_worktree(struct got_worktree *worktree, int operation)
352 if (flock(worktree->lockfd, operation | LOCK_NB) == -1)
353 return (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
354 : got_error_from_errno());
359 apply_path_prefix(struct got_worktree *worktree, const char *path)
361 const char *p = path;
362 p += strlen(worktree->path_prefix);
368 static const struct got_error *
369 add_file_on_disk(struct got_worktree *worktree, struct got_fileindex *fileindex,
370 const char *path, struct got_blob_object *blob, struct got_repository *repo)
372 const struct got_error *err = NULL;
376 struct got_fileindex_entry *entry;
378 if (asprintf(&ondisk_path, "%s/%s", worktree->root_path,
379 apply_path_prefix(worktree, path)) == -1)
380 return got_error_from_errno();
382 fd = open(ondisk_path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
383 GOT_DEFAULT_FILE_MODE);
385 err = got_error_from_errno();
386 if (errno == EEXIST) {
388 if (lstat(ondisk_path, &sb) == -1) {
389 err = got_error_from_errno();
390 } else if (!S_ISREG(sb.st_mode)) {
391 /* TODO file is obstructed; do something */
392 err = got_error(GOT_ERR_FILE_OBSTRUCTED);
398 hdrlen = got_object_blob_get_hdrlen(blob);
400 const uint8_t *buf = got_object_blob_get_read_buf(blob);
401 err = got_object_blob_read_block(&len, blob);
405 /* Skip blob object header first time around. */
406 ssize_t outlen = write(fd, buf + hdrlen, len - hdrlen);
409 err = got_error_from_errno();
411 } else if (outlen != len) {
412 err = got_error(GOT_ERR_IO);
420 err = got_fileindex_entry_open(&entry, ondisk_path,
421 apply_path_prefix(worktree, path), blob->id.sha1);
425 err = got_fileindex_entry_add(fileindex, entry);
434 static const struct got_error *
435 add_dir_on_disk(struct got_worktree *worktree, const char *path)
437 const struct got_error *err = NULL;
440 if (asprintf(&abspath, "%s/%s", worktree->root_path,
441 apply_path_prefix(worktree, path)) == -1)
442 return got_error_from_errno();
444 /* XXX queue work rather than editing disk directly? */
445 if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1) {
448 if (errno != EEXIST) {
449 err = got_error_from_errno();
453 if (lstat(abspath, &sb) == -1) {
454 err = got_error_from_errno();
458 if (!S_ISDIR(sb.st_mode)) {
459 /* TODO directory is obstructed; do something */
460 return got_error(GOT_ERR_FILE_OBSTRUCTED);
469 static const struct got_error *
470 tree_checkout(struct got_worktree *, struct got_fileindex *,
471 struct got_tree_object *, const char *, struct got_repository *,
472 got_worktree_checkout_cb progress_cb, void *progress_arg);
474 static const struct got_error *
475 tree_checkout_entry(struct got_worktree *worktree,
476 struct got_fileindex *fileindex, struct got_tree_entry *te,
477 const char *parent, struct got_repository *repo,
478 got_worktree_checkout_cb progress_cb, void *progress_arg)
480 const struct got_error *err = NULL;
481 struct got_object *obj = NULL;
482 struct got_blob_object *blob = NULL;
483 struct got_tree_object *tree = NULL;
485 char *progress_path = NULL;
488 if (parent[0] == '/' && parent[1] == '\0')
490 if (asprintf(&path, "%s/%s", parent, te->name) == -1)
491 return got_error_from_errno();
493 /* Skip this entry if it is outside of our path prefix. */
494 len = MIN(strlen(worktree->path_prefix), strlen(path));
495 if (strncmp(path, worktree->path_prefix, len) != 0) {
500 err = got_object_open(&obj, repo, te->id);
504 progress_path = path;
505 if (strncmp(progress_path, worktree->path_prefix, len) == 0)
506 progress_path += len;
507 (*progress_cb)(progress_arg, progress_path);
509 switch (got_object_get_type(obj)) {
510 case GOT_OBJ_TYPE_BLOB:
511 if (strlen(worktree->path_prefix) >= strlen(path))
513 err = got_object_blob_open(&blob, repo, obj, 8192);
516 err = add_file_on_disk(worktree, fileindex, path, blob, repo);
518 case GOT_OBJ_TYPE_TREE:
519 err = got_object_tree_open(&tree, repo, obj);
522 if (strlen(worktree->path_prefix) < strlen(path)) {
523 err = add_dir_on_disk(worktree, path);
527 err = tree_checkout(worktree, fileindex, tree, path, repo,
528 progress_cb, progress_arg);
536 got_object_blob_close(blob);
538 got_object_tree_close(tree);
540 got_object_close(obj);
545 static const struct got_error *
546 tree_checkout(struct got_worktree *worktree,
547 struct got_fileindex *fileindex, struct got_tree_object *tree,
548 const char *path, struct got_repository *repo,
549 got_worktree_checkout_cb progress_cb, void *progress_arg)
551 const struct got_error *err = NULL;
552 struct got_tree_entry *te;
555 /* Skip this tree if it is outside of our path prefix. */
556 len = MIN(strlen(worktree->path_prefix), strlen(path));
557 if (strncmp(path, worktree->path_prefix, len) != 0)
560 SIMPLEQ_FOREACH(te, &tree->entries, entry) {
561 err = tree_checkout_entry(worktree, fileindex, te, path, repo,
562 progress_cb, progress_arg);
570 const struct got_error *
571 got_worktree_checkout_files(struct got_worktree *worktree,
572 struct got_reference *head_ref, struct got_repository *repo,
573 got_worktree_checkout_cb progress_cb, void *progress_arg)
575 const struct got_error *err = NULL, *unlockerr;
576 struct got_object_id *commit_id = NULL;
577 struct got_object *obj = NULL;
578 struct got_commit_object *commit = NULL;
579 struct got_tree_object *tree = NULL;
580 char *fileindex_path = NULL, *new_fileindex_path = NULL;
581 struct got_fileindex *fileindex = NULL;
584 err = lock_worktree(worktree, LOCK_EX);
588 fileindex = got_fileindex_open();
589 if (fileindex == NULL) {
590 err = got_error_from_errno();
594 if (asprintf(&fileindex_path, "%s/%s/%s", worktree->root_path,
595 GOT_WORKTREE_GOT_DIR, GOT_WORKTREE_FILE_INDEX) == -1) {
596 err = got_error_from_errno();
597 fileindex_path = NULL;
601 err = got_opentemp_named(&new_fileindex_path, &findex, fileindex_path);
605 err = got_ref_resolve(&commit_id, repo, head_ref);
609 err = got_object_open(&obj, repo, commit_id);
613 if (got_object_get_type(obj) != GOT_OBJ_TYPE_COMMIT) {
614 err = got_error(GOT_ERR_OBJ_TYPE);
618 err = got_object_commit_open(&commit, repo, obj);
622 got_object_close(obj);
623 err = got_object_open(&obj, repo, commit->tree_id);
627 if (got_object_get_type(obj) != GOT_OBJ_TYPE_TREE) {
628 err = got_error(GOT_ERR_OBJ_TYPE);
632 err = got_object_tree_open(&tree, repo, obj);
636 err = tree_checkout(worktree, fileindex, tree, "/", repo,
637 progress_cb, progress_arg);
641 err = got_fileindex_write(fileindex, findex);
645 if (rename(new_fileindex_path, fileindex_path) != 0) {
646 err = got_error_from_errno();
650 free(new_fileindex_path);
651 new_fileindex_path = NULL;
655 got_object_commit_close(commit);
657 got_object_close(obj);
659 if (new_fileindex_path)
660 unlink(new_fileindex_path);
663 free(new_fileindex_path);
664 free(fileindex_path);
665 got_fileindex_close(fileindex);
666 unlockerr = lock_worktree(worktree, LOCK_SH);
667 if (unlockerr && err == NULL)