Blob


1 /*
2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3 *
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.
7 *
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.
15 */
17 #include <sys/stat.h>
18 #include <sys/limits.h>
19 #include <sys/queue.h>
21 #include <string.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <fcntl.h>
25 #include <errno.h>
26 #include <unistd.h>
27 #include <sha1.h>
28 #include <zlib.h>
29 #include <fnmatch.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"
36 #include "got_opentemp.h"
38 #include "got_lib_worktree.h"
39 #include "got_lib_path.h"
40 #include "got_lib_sha1.h"
41 #include "got_lib_fileindex.h"
42 #include "got_lib_inflate.h"
43 #include "got_lib_delta.h"
44 #include "got_lib_object.h"
46 #ifndef MIN
47 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
48 #endif
50 static const struct got_error *
51 create_meta_file(const char *path_got, const char *name, const char *content)
52 {
53 const struct got_error *err = NULL;
54 char *path;
55 int fd = -1;
57 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
58 err = got_error_from_errno();
59 path = NULL;
60 goto done;
61 }
63 fd = open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
64 GOT_DEFAULT_FILE_MODE);
65 if (fd == -1) {
66 err = got_error_from_errno();
67 goto done;
68 }
70 if (content) {
71 int len = dprintf(fd, "%s\n", content);
72 if (len != strlen(content) + 1) {
73 err = got_error_from_errno();
74 goto done;
75 }
76 }
78 done:
79 if (fd != -1 && close(fd) == -1 && err == NULL)
80 err = got_error_from_errno();
81 free(path);
82 return err;
83 }
85 static const struct got_error *
86 read_meta_file(char **content, const char *path_got, const char *name)
87 {
88 const struct got_error *err = NULL;
89 char *path;
90 int fd = -1;
91 ssize_t n;
92 struct stat sb;
94 *content = NULL;
96 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
97 err = got_error_from_errno();
98 path = NULL;
99 goto done;
102 fd = open(path, O_RDONLY | O_NOFOLLOW);
103 if (fd == -1) {
104 err = got_error_from_errno();
105 goto done;
107 if (flock(fd, LOCK_SH | LOCK_NB) == -1) {
108 err = (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
109 : got_error_from_errno());
110 goto done;
113 stat(path, &sb);
114 *content = calloc(1, sb.st_size);
115 if (*content == NULL) {
116 err = got_error_from_errno();
117 goto done;
120 n = read(fd, *content, sb.st_size);
121 if (n != sb.st_size) {
122 err = (n == -1 ? got_error_from_errno() :
123 got_error(GOT_ERR_WORKTREE_META));
124 goto done;
126 if ((*content)[sb.st_size - 1] != '\n') {
127 err = got_error(GOT_ERR_WORKTREE_META);
128 goto done;
130 (*content)[sb.st_size - 1] = '\0';
132 done:
133 if (fd != -1 && close(fd) == -1 && err == NULL)
134 err = got_error_from_errno();
135 free(path);
136 if (err) {
137 free(*content);
138 *content = NULL;
140 return err;
143 const struct got_error *
144 got_worktree_init(const char *path, struct got_reference *head_ref,
145 const char *prefix, struct got_repository *repo)
147 const struct got_error *err = NULL;
148 struct got_object_id *commit_id = NULL;
149 int obj_type;
150 char *path_got = NULL;
151 char *refstr = NULL;
152 char *repo_path = NULL;
153 char *formatstr = NULL;
154 char *absprefix = NULL;
155 char *basestr = NULL;
157 err = got_ref_resolve(&commit_id, repo, head_ref);
158 if (err)
159 return err;
160 err = got_object_get_type(&obj_type, repo, commit_id);
161 if (err)
162 return err;
163 if (obj_type != GOT_OBJ_TYPE_COMMIT)
164 return got_error(GOT_ERR_OBJ_TYPE);
166 if (!got_path_is_absolute(prefix)) {
167 if (asprintf(&absprefix, "/%s", prefix) == -1)
168 return got_error_from_errno();
171 /* Create top-level directory (may already exist). */
172 if (mkdir(path, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST) {
173 err = got_error_from_errno();
174 goto done;
177 /* Create .got directory (may already exist). */
178 if (asprintf(&path_got, "%s/%s", path, GOT_WORKTREE_GOT_DIR) == -1) {
179 err = got_error_from_errno();
180 goto done;
182 if (mkdir(path_got, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST) {
183 err = got_error_from_errno();
184 goto done;
187 /* Create an empty lock file. */
188 err = create_meta_file(path_got, GOT_WORKTREE_LOCK, NULL);
189 if (err)
190 goto done;
192 /* Create an empty file index. */
193 err = create_meta_file(path_got, GOT_WORKTREE_FILE_INDEX, NULL);
194 if (err)
195 goto done;
197 /* Write the HEAD reference. */
198 refstr = got_ref_to_str(head_ref);
199 if (refstr == NULL) {
200 err = got_error_from_errno();
201 goto done;
203 err = create_meta_file(path_got, GOT_WORKTREE_HEAD_REF, refstr);
204 if (err)
205 goto done;
207 /* Record our base commit. */
208 err = got_object_id_str(&basestr, commit_id);
209 if (err)
210 goto done;
211 err = create_meta_file(path_got, GOT_WORKTREE_BASE_COMMIT, basestr);
212 if (err)
213 goto done;
215 /* Store path to repository. */
216 repo_path = got_repo_get_path(repo);
217 if (repo_path == NULL) {
218 err = got_error_from_errno();
219 goto done;
221 err = create_meta_file(path_got, GOT_WORKTREE_REPOSITORY, repo_path);
222 if (err)
223 goto done;
225 /* Store in-repository path prefix. */
226 err = create_meta_file(path_got, GOT_WORKTREE_PATH_PREFIX,
227 absprefix ? absprefix : prefix);
228 if (err)
229 goto done;
231 /* Stamp work tree with format file. */
232 if (asprintf(&formatstr, "%d", GOT_WORKTREE_FORMAT_VERSION) == -1) {
233 err = got_error_from_errno();
234 goto done;
236 err = create_meta_file(path_got, GOT_WORKTREE_FORMAT, formatstr);
237 if (err)
238 goto done;
240 done:
241 free(commit_id);
242 free(path_got);
243 free(formatstr);
244 free(refstr);
245 free(repo_path);
246 free(absprefix);
247 free(basestr);
248 return err;
251 const struct got_error *
252 got_worktree_open(struct got_worktree **worktree, const char *path)
254 const struct got_error *err = NULL;
255 char *path_got;
256 char *formatstr = NULL;
257 char *path_lock = NULL;
258 char *base_commit_id_str = NULL;
259 char *head_ref_str = NULL;
260 int version, fd = -1;
261 const char *errstr;
262 struct got_repository *repo = NULL;
264 *worktree = NULL;
266 if (asprintf(&path_got, "%s/%s", path, GOT_WORKTREE_GOT_DIR) == -1) {
267 err = got_error_from_errno();
268 path_got = NULL;
269 goto done;
272 if (asprintf(&path_lock, "%s/%s", path_got, GOT_WORKTREE_LOCK) == -1) {
273 err = got_error_from_errno();
274 path_lock = NULL;
275 goto done;
278 fd = open(path_lock, O_RDWR | O_EXLOCK | O_NONBLOCK);
279 if (fd == -1) {
280 err = (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
281 : got_error_from_errno());
282 goto done;
285 err = read_meta_file(&formatstr, path_got, GOT_WORKTREE_FORMAT);
286 if (err)
287 goto done;
289 version = strtonum(formatstr, 1, INT_MAX, &errstr);
290 if (errstr) {
291 err = got_error(GOT_ERR_WORKTREE_META);
292 goto done;
294 if (version != GOT_WORKTREE_FORMAT_VERSION) {
295 err = got_error(GOT_ERR_WORKTREE_VERS);
296 goto done;
299 *worktree = calloc(1, sizeof(**worktree));
300 if (*worktree == NULL) {
301 err = got_error_from_errno();
302 goto done;
304 (*worktree)->lockfd = -1;
306 (*worktree)->root_path = strdup(path);
307 if ((*worktree)->root_path == NULL) {
308 err = got_error_from_errno();
309 goto done;
311 err = read_meta_file(&(*worktree)->repo_path, path_got,
312 GOT_WORKTREE_REPOSITORY);
313 if (err)
314 goto done;
316 err = read_meta_file(&(*worktree)->path_prefix, path_got,
317 GOT_WORKTREE_PATH_PREFIX);
318 if (err)
319 goto done;
321 err = read_meta_file(&base_commit_id_str, path_got,
322 GOT_WORKTREE_BASE_COMMIT);
323 if (err)
324 goto done;
326 err = got_repo_open(&repo, (*worktree)->repo_path);
327 if (err)
328 goto done;
330 err = got_object_resolve_id_str(&(*worktree)->base_commit_id, repo,
331 base_commit_id_str);
332 if (err)
333 goto done;
335 err = read_meta_file(&head_ref_str, path_got, GOT_WORKTREE_HEAD_REF);
336 if (err)
337 goto done;
339 err = got_ref_open(&(*worktree)->head_ref, repo, head_ref_str);
340 done:
341 if (repo)
342 got_repo_close(repo);
343 free(path_got);
344 free(path_lock);
345 free(head_ref_str);
346 free(base_commit_id_str);
347 if (err) {
348 if (fd != -1)
349 close(fd);
350 if (*worktree != NULL)
351 got_worktree_close(*worktree);
352 *worktree = NULL;
353 } else
354 (*worktree)->lockfd = fd;
356 return err;
359 void
360 got_worktree_close(struct got_worktree *worktree)
362 free(worktree->root_path);
363 free(worktree->repo_path);
364 free(worktree->path_prefix);
365 free(worktree->base_commit_id);
366 if (worktree->head_ref)
367 got_ref_close(worktree->head_ref);
368 if (worktree->lockfd != -1)
369 close(worktree->lockfd);
370 free(worktree);
373 char *
374 got_worktree_get_repo_path(struct got_worktree *worktree)
376 return strdup(worktree->repo_path);
379 char *
380 got_worktree_get_head_ref_name(struct got_worktree *worktree)
382 return got_ref_to_str(worktree->head_ref);
385 static const struct got_error *
386 lock_worktree(struct got_worktree *worktree, int operation)
388 if (flock(worktree->lockfd, operation | LOCK_NB) == -1)
389 return (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
390 : got_error_from_errno());
391 return NULL;
394 static const char *
395 apply_path_prefix(struct got_worktree *worktree, const char *path)
397 const char *p = path;
398 p += strlen(worktree->path_prefix);
399 if (*p == '/')
400 p++;
401 return p;
404 static const struct got_error *
405 add_file_on_disk(struct got_worktree *worktree, struct got_fileindex *fileindex,
406 const char *path, struct got_blob_object *blob, struct got_repository *repo,
407 got_worktree_checkout_cb progress_cb, void *progress_arg,
408 const char *progress_path)
410 const struct got_error *err = NULL;
411 char *ondisk_path;
412 int fd;
413 size_t len, hdrlen;
414 struct got_fileindex_entry *entry;
416 if (asprintf(&ondisk_path, "%s/%s", worktree->root_path,
417 apply_path_prefix(worktree, path)) == -1)
418 return got_error_from_errno();
420 fd = open(ondisk_path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
421 GOT_DEFAULT_FILE_MODE);
422 if (fd == -1) {
423 err = got_error_from_errno();
424 if (errno == EEXIST) {
425 struct stat sb;
426 if (lstat(ondisk_path, &sb) == -1) {
427 err = got_error_from_errno();
428 } else if (!S_ISREG(sb.st_mode)) {
429 /* TODO file is obstructed; do something */
430 err = got_error(GOT_ERR_FILE_OBSTRUCTED);
431 } else {
432 /* TODO: Merge the file! */
433 (*progress_cb)(progress_arg, 'E',
434 progress_path);
435 return NULL;
438 return err;
441 (*progress_cb)(progress_arg, 'A', progress_path);
443 hdrlen = got_object_blob_get_hdrlen(blob);
444 do {
445 const uint8_t *buf = got_object_blob_get_read_buf(blob);
446 err = got_object_blob_read_block(&len, blob);
447 if (err)
448 break;
449 if (len > 0) {
450 /* Skip blob object header first time around. */
451 ssize_t outlen = write(fd, buf + hdrlen, len - hdrlen);
452 if (outlen == -1) {
453 err = got_error_from_errno();
454 goto done;
455 } else if (outlen != len - hdrlen) {
456 err = got_error(GOT_ERR_IO);
457 goto done;
459 hdrlen = 0;
461 } while (len != 0);
463 fsync(fd);
465 entry = got_fileindex_entry_get(fileindex,
466 apply_path_prefix(worktree, path));
467 if (entry)
468 err = got_fileindex_entry_update(entry, ondisk_path,
469 blob->id.sha1, worktree->base_commit_id->sha1);
470 else {
471 err = got_fileindex_entry_alloc(&entry, ondisk_path,
472 apply_path_prefix(worktree, path), blob->id.sha1,
473 worktree->base_commit_id->sha1);
474 if (err)
475 goto done;
476 err = got_fileindex_entry_add(fileindex, entry);
478 if (err)
479 goto done;
480 done:
481 close(fd);
482 free(ondisk_path);
483 return err;
486 static const struct got_error *
487 add_dir_on_disk(struct got_worktree *worktree, const char *path)
489 const struct got_error *err = NULL;
490 char *abspath;
492 if (asprintf(&abspath, "%s/%s", worktree->root_path,
493 apply_path_prefix(worktree, path)) == -1)
494 return got_error_from_errno();
496 /* XXX queue work rather than editing disk directly? */
497 if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1) {
498 struct stat sb;
500 if (errno != EEXIST) {
501 err = got_error_from_errno();
502 goto done;
505 if (lstat(abspath, &sb) == -1) {
506 err = got_error_from_errno();
507 goto done;
510 if (!S_ISDIR(sb.st_mode)) {
511 /* TODO directory is obstructed; do something */
512 return got_error(GOT_ERR_FILE_OBSTRUCTED);
516 done:
517 free(abspath);
518 return err;
521 static const struct got_error *
522 tree_checkout(struct got_worktree *, struct got_fileindex *,
523 struct got_tree_object *, const char *, struct got_repository *,
524 got_worktree_checkout_cb progress_cb, void *progress_arg,
525 got_worktree_cancel_cb cancel_cb, void *cancel_arg);
527 static const struct got_error *
528 tree_checkout_entry(struct got_worktree *worktree,
529 struct got_fileindex *fileindex, struct got_tree_entry *te,
530 const char *parent, struct got_repository *repo,
531 got_worktree_checkout_cb progress_cb, void *progress_arg,
532 got_worktree_cancel_cb cancel_cb, void *cancel_arg)
534 const struct got_error *err = NULL;
535 struct got_object *obj = NULL;
536 struct got_blob_object *blob = NULL;
537 struct got_tree_object *tree = NULL;
538 char *path = NULL;
539 char *progress_path = NULL;
540 size_t len;
542 if (parent[0] == '/' && parent[1] == '\0')
543 parent = "";
544 if (asprintf(&path, "%s/%s", parent, te->name) == -1)
545 return got_error_from_errno();
547 /* Skip this entry if it is outside of our path prefix. */
548 len = MIN(strlen(worktree->path_prefix), strlen(path));
549 if (strncmp(path, worktree->path_prefix, len) != 0) {
550 free(path);
551 return NULL;
554 err = got_object_open(&obj, repo, te->id);
555 if (err)
556 goto done;
558 progress_path = path;
559 if (strncmp(progress_path, worktree->path_prefix, len) == 0)
560 progress_path += len;
562 switch (obj->type) {
563 case GOT_OBJ_TYPE_BLOB:
564 if (strlen(worktree->path_prefix) >= strlen(path))
565 break;
566 err = got_object_blob_open(&blob, repo, obj, 8192);
567 if (err)
568 goto done;
569 err = add_file_on_disk(worktree, fileindex, path, blob, repo,
570 progress_cb, progress_arg, progress_path);
571 break;
572 case GOT_OBJ_TYPE_TREE:
573 err = got_object_tree_open(&tree, repo, obj);
574 if (err)
575 goto done;
576 if (strlen(worktree->path_prefix) < strlen(path)) {
577 err = add_dir_on_disk(worktree, path);
578 if (err)
579 break;
581 /* XXX infinite recursion possible */
582 err = tree_checkout(worktree, fileindex, tree, path, repo,
583 progress_cb, progress_arg, cancel_cb, cancel_arg);
584 break;
585 default:
586 break;
589 done:
590 if (blob)
591 got_object_blob_close(blob);
592 if (tree)
593 got_object_tree_close(tree);
594 if (obj)
595 got_object_close(obj);
596 free(path);
597 return err;
600 static const struct got_error *
601 tree_checkout(struct got_worktree *worktree,
602 struct got_fileindex *fileindex, struct got_tree_object *tree,
603 const char *path, struct got_repository *repo,
604 got_worktree_checkout_cb progress_cb, void *progress_arg,
605 got_worktree_cancel_cb cancel_cb, void *cancel_arg)
607 const struct got_error *err = NULL;
608 const struct got_tree_entries *entries;
609 struct got_tree_entry *te;
610 size_t len;
612 /* Skip this tree if it is outside of our path prefix. */
613 len = MIN(strlen(worktree->path_prefix), strlen(path));
614 if (strncmp(path, worktree->path_prefix, len) != 0)
615 return NULL;
617 entries = got_object_tree_get_entries(tree);
618 SIMPLEQ_FOREACH(te, &entries->head, entry) {
619 if (cancel_cb) {
620 err = (*cancel_cb)(cancel_arg);
621 if (err)
622 break;
624 err = tree_checkout_entry(worktree, fileindex, te, path, repo,
625 progress_cb, progress_arg, cancel_cb, cancel_arg);
626 if (err)
627 break;
630 return err;
633 const struct got_error *
634 got_worktree_checkout_files(struct got_worktree *worktree,
635 struct got_repository *repo, got_worktree_checkout_cb progress_cb,
636 void *progress_arg, got_worktree_cancel_cb cancel_cb, void *cancel_arg)
638 const struct got_error *err = NULL, *unlockerr, *checkout_err = NULL;
639 struct got_commit_object *commit = NULL;
640 struct got_tree_object *tree = NULL;
641 char *fileindex_path = NULL, *new_fileindex_path = NULL;
642 struct got_fileindex *fileindex = NULL;
643 FILE *index = NULL, *new_index = NULL;
645 err = lock_worktree(worktree, LOCK_EX);
646 if (err)
647 return err;
649 fileindex = got_fileindex_alloc();
650 if (fileindex == NULL) {
651 err = got_error_from_errno();
652 goto done;
655 if (asprintf(&fileindex_path, "%s/%s/%s", worktree->root_path,
656 GOT_WORKTREE_GOT_DIR, GOT_WORKTREE_FILE_INDEX) == -1) {
657 err = got_error_from_errno();
658 fileindex_path = NULL;
659 goto done;
662 /*
663 * Read the file index.
664 * Checking out files is supposed to be an idempotent operation.
665 * If the on-disk file index is incomplete we will try to complete it.
666 */
667 index = fopen(fileindex_path, "rb");
668 if (index == NULL) {
669 err = got_error_from_errno();
670 goto done;
672 err = got_fileindex_read(fileindex, index);
673 fclose(index);
674 if (err)
675 goto done;
677 err = got_opentemp_named(&new_fileindex_path, &new_index,
678 fileindex_path);
679 if (err)
680 goto done;
682 err = got_object_open_as_commit(&commit, repo,
683 worktree->base_commit_id);
684 if (err)
685 goto done;
687 err = got_object_open_as_tree(&tree, repo, commit->tree_id);
688 if (err)
689 goto done;
691 checkout_err = tree_checkout(worktree, fileindex, tree, "/", repo,
692 progress_cb, progress_arg, cancel_cb, cancel_arg);
694 /* Try to sync the fileindex back to disk in any case. */
695 err = got_fileindex_write(fileindex, new_index);
696 if (err)
697 goto done;
699 if (rename(new_fileindex_path, fileindex_path) != 0) {
700 err = got_error_from_errno();
701 goto done;
704 free(new_fileindex_path);
705 new_fileindex_path = NULL;
707 done:
708 if (tree)
709 got_object_tree_close(tree);
710 if (commit)
711 got_object_commit_close(commit);
712 if (new_fileindex_path)
713 unlink(new_fileindex_path);
714 if (new_index)
715 fclose(new_index);
716 free(new_fileindex_path);
717 free(fileindex_path);
718 got_fileindex_free(fileindex);
719 if (checkout_err)
720 err = checkout_err;
721 unlockerr = lock_worktree(worktree, LOCK_SH);
722 if (unlockerr && err == NULL)
723 err = unlockerr;
724 return err;