2 * Copyright (c) 2018, 2019 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.
17 #include <sys/types.h>
18 #include <sys/queue.h>
29 #include "got_error.h"
30 #include "got_object.h"
31 #include "got_repository.h"
32 #include "got_reference.h"
34 #include "got_lib_sha1.h"
35 #include "got_lib_path.h"
36 #include "got_lib_delta.h"
37 #include "got_lib_inflate.h"
38 #include "got_lib_object.h"
41 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
44 #define GOT_REF_HEADS "heads"
45 #define GOT_REF_TAGS "tags"
46 #define GOT_REF_REMOTES "remotes"
48 /* A symbolic reference. */
54 /* A non-symbolic reference (there is no better designation). */
57 u_int8_t sha1[SHA1_DIGEST_LENGTH];
60 /* A reference which points to an arbitrary object. */
61 struct got_reference {
63 #define GOT_REF_IS_SYMBOLIC 0x01
67 struct got_symref symref;
71 static const struct got_error *
72 parse_symref(struct got_reference **ref, const char *name, const char *line)
74 struct got_symref *symref;
79 return got_error(GOT_ERR_BAD_REF_DATA);
81 symref_name = strdup(name);
82 if (symref_name == NULL)
83 return got_error_from_errno();
84 symref_ref = strdup(line);
85 if (symref_ref == NULL) {
86 const struct got_error *err = got_error_from_errno();
91 *ref = calloc(1, sizeof(**ref));
93 return got_error_from_errno();
94 (*ref)->flags |= GOT_REF_IS_SYMBOLIC;
95 symref = &((*ref)->ref.symref);
96 symref->name = symref_name;
97 symref->ref = symref_ref;
101 static const struct got_error *
102 parse_ref_line(struct got_reference **ref, const char *name, const char *line)
104 uint8_t digest[SHA1_DIGEST_LENGTH];
107 if (strncmp(line, "ref: ", 5) == 0) {
109 return parse_symref(ref, name, line);
112 ref_name = strdup(name);
113 if (ref_name == NULL)
114 return got_error_from_errno();
116 if (!got_parse_sha1_digest(digest, line))
117 return got_error(GOT_ERR_BAD_REF_DATA);
119 *ref = calloc(1, sizeof(**ref));
121 return got_error_from_errno();
122 (*ref)->ref.ref.name = ref_name;
123 memcpy(&(*ref)->ref.ref.sha1, digest, SHA1_DIGEST_LENGTH);
127 static const struct got_error *
128 parse_ref_file(struct got_reference **ref, const char *name,
131 const struct got_error *err = NULL;
132 FILE *f = fopen(abspath, "rb");
135 const char delim[3] = {'\0', '\0', '\0'};
140 line = fparseln(f, &len, NULL, delim, 0);
142 err = got_error(GOT_ERR_BAD_REF_DATA);
146 err = parse_ref_line(ref, name, line);
149 if (fclose(f) != 0 && err == NULL)
150 err = got_error_from_errno();
155 is_well_known_ref(const char *refname)
157 return (strcmp(refname, GOT_REF_HEAD) == 0 ||
158 strcmp(refname, GOT_REF_ORIG_HEAD) == 0 ||
159 strcmp(refname, GOT_REF_MERGE_HEAD) == 0 ||
160 strcmp(refname, GOT_REF_FETCH_HEAD) == 0);
164 get_refs_dir_path(struct got_repository *repo, const char *refname)
166 if (is_well_known_ref(refname) || strncmp(refname, "refs/", 5) == 0)
167 return strdup(got_repo_get_path_git_dir(repo));
169 return got_repo_get_path_refs(repo);
172 static const struct got_error *
173 parse_packed_ref_line(struct got_reference **ref, const char *abs_refname,
176 uint8_t digest[SHA1_DIGEST_LENGTH];
181 if (line[0] == '#' || line[0] == '^')
184 if (!got_parse_sha1_digest(digest, line))
185 return got_error(GOT_ERR_BAD_REF_DATA);
188 if (strcmp(line + SHA1_DIGEST_STRING_LENGTH, abs_refname) != 0)
191 name = strdup(abs_refname);
193 return got_error_from_errno();
195 name = strdup(line + SHA1_DIGEST_STRING_LENGTH);
197 *ref = calloc(1, sizeof(**ref));
199 return got_error_from_errno();
200 (*ref)->ref.ref.name = name;;
201 memcpy(&(*ref)->ref.ref.sha1, digest, SHA1_DIGEST_LENGTH);
205 static const struct got_error *
206 open_packed_ref(struct got_reference **ref, FILE *f, const char **subdirs,
207 int nsubdirs, const char *refname)
209 const struct got_error *err = NULL;
213 const char delim[3] = {'\0', '\0', '\0'};
214 int i, ref_is_absolute = (strncmp(refname, "refs/", 5) == 0);
219 abs_refname = (char *)refname;
221 line = fparseln(f, &len, NULL, delim, 0);
224 for (i = 0; i < nsubdirs; i++) {
225 if (!ref_is_absolute &&
226 asprintf(&abs_refname, "refs/%s/%s", subdirs[i],
228 return got_error_from_errno();
229 err = parse_packed_ref_line(ref, abs_refname, line);
230 if (!ref_is_absolute)
232 if (err || *ref != NULL)
238 } while (*ref == NULL);
243 static const struct got_error *
244 open_ref(struct got_reference **ref, const char *path_refs, const char *subdir,
247 const struct got_error *err = NULL;
249 char *normpath = NULL;
250 char *absname = NULL;
251 int ref_is_absolute = (strncmp(name, "refs/", 5) == 0);
252 int ref_is_well_known = is_well_known_ref(name);
256 if (ref_is_absolute || ref_is_well_known) {
257 if (asprintf(&path, "%s/%s", path_refs, name) == -1)
258 return got_error_from_errno();
259 absname = (char *)name;
261 if (asprintf(&path, "%s/%s/%s", path_refs, subdir, name) == -1)
262 return got_error_from_errno();
264 if (asprintf(&absname, "refs/%s/%s", subdir, name) == -1) {
265 err = got_error_from_errno();
270 normpath = got_path_normalize(path);
271 if (normpath == NULL) {
272 err = got_error_from_errno();
276 err = parse_ref_file(ref, absname, normpath);
278 if (!ref_is_absolute && !ref_is_well_known)
285 const struct got_error *
286 got_ref_open(struct got_reference **ref, struct got_repository *repo,
289 const struct got_error *err = NULL;
290 char *path_refs = NULL;
291 const char *subdirs[] = {
292 GOT_REF_HEADS, GOT_REF_TAGS, GOT_REF_REMOTES
294 int i, well_known = is_well_known_ref(refname);
298 path_refs = get_refs_dir_path(repo, refname);
299 if (path_refs == NULL) {
300 err = got_error_from_errno();
305 char *packed_refs_path;
308 /* Search on-disk refs before packed refs! */
309 for (i = 0; i < nitems(subdirs); i++) {
310 err = open_ref(ref, path_refs, subdirs[i], refname);
315 packed_refs_path = got_repo_get_path_packed_refs(repo);
316 if (packed_refs_path == NULL) {
317 err = got_error_from_errno();
321 f = fopen(packed_refs_path, "rb");
322 free(packed_refs_path);
324 err = open_packed_ref(ref, f, subdirs, nitems(subdirs),
326 if (fclose(f) != 0 && err == NULL)
327 err = got_error_from_errno();
333 err = open_ref(ref, path_refs, "", refname);
338 err = got_error_not_ref(refname);
344 got_ref_close(struct got_reference *ref)
346 if (ref->flags & GOT_REF_IS_SYMBOLIC)
347 free(ref->ref.symref.name);
349 free(ref->ref.ref.name);
353 struct got_reference *
354 got_ref_dup(struct got_reference *ref)
356 struct got_reference *ret;
358 ret = calloc(1, sizeof(*ret));
362 ret->flags = ref->flags;
363 if (ref->flags & GOT_REF_IS_SYMBOLIC) {
364 ret->ref.symref.name = strdup(ref->ref.symref.name);
365 if (ret->ref.symref.name == NULL) {
369 ret->ref.symref.ref = strdup(ref->ref.symref.ref);
370 if (ret->ref.symref.ref == NULL) {
371 free(ret->ref.symref.name);
376 ref->ref.ref.name = strdup(ref->ref.ref.name);
377 if (ref->ref.ref.name == NULL) {
381 memcpy(ret->ref.ref.sha1, ref->ref.ref.sha1,
388 static const struct got_error *
389 resolve_symbolic_ref(struct got_reference **resolved,
390 struct got_repository *repo, struct got_reference *ref)
392 struct got_reference *nextref;
393 const struct got_error *err;
395 err = got_ref_open(&nextref, repo, ref->ref.symref.ref);
399 if (nextref->flags & GOT_REF_IS_SYMBOLIC)
400 err = resolve_symbolic_ref(resolved, repo, nextref);
402 *resolved = got_ref_dup(nextref);
404 got_ref_close(nextref);
408 const struct got_error *
409 got_ref_resolve(struct got_object_id **id, struct got_repository *repo,
410 struct got_reference *ref)
412 const struct got_error *err;
414 if (ref->flags & GOT_REF_IS_SYMBOLIC) {
415 struct got_reference *resolved = NULL;
416 err = resolve_symbolic_ref(&resolved, repo, ref);
418 err = got_ref_resolve(id, repo, resolved);
423 *id = calloc(1, sizeof(**id));
425 return got_error_from_errno();
426 memcpy((*id)->sha1, ref->ref.ref.sha1, SHA1_DIGEST_LENGTH);
431 got_ref_to_str(struct got_reference *ref)
435 if (ref->flags & GOT_REF_IS_SYMBOLIC)
436 return strdup(ref->ref.symref.ref);
438 str = malloc(SHA1_DIGEST_STRING_LENGTH);
442 if (got_sha1_digest_to_str(ref->ref.ref.sha1, str,
443 SHA1_DIGEST_STRING_LENGTH) == NULL) {
452 got_ref_get_name(struct got_reference *ref)
454 if (ref->flags & GOT_REF_IS_SYMBOLIC)
455 return ref->ref.symref.name;
457 return ref->ref.ref.name;
460 static const struct got_error *
461 insert_ref(struct got_reflist_head *refs, struct got_reference *ref,
462 struct got_repository *repo)
464 const struct got_error *err;
465 struct got_object_id *id;
466 struct got_reflist_entry *new, *re, *prev;
469 err = got_ref_resolve(&id, repo, ref);
473 new = malloc(sizeof(*re));
476 return got_error_from_errno();
482 * We must de-duplicate entries on insert because packed-refs may
483 * contain redundant entries. On-disk refs take precedence.
484 * This code assumes that on-disk revs are read before packed-refs.
485 * We're iterating the list anyway, so insert elements sorted by name.
487 re = SIMPLEQ_FIRST(refs);
489 cmp = got_path_cmp(got_ref_get_name(re->ref),
490 got_ref_get_name(ref));
492 free(ref); /* duplicate */
494 } else if (cmp > 0) {
496 SIMPLEQ_INSERT_AFTER(refs, prev, new, entry);
498 SIMPLEQ_INSERT_HEAD(refs, new, entry);
502 re = SIMPLEQ_NEXT(re, entry);
506 SIMPLEQ_INSERT_TAIL(refs, new, entry);
510 static const struct got_error *
511 gather_on_disk_refs(struct got_reflist_head *refs, const char *path_refs,
512 const char *subdir, struct got_repository *repo)
514 const struct got_error *err = NULL;
518 if (asprintf(&path_subdir, "%s/%s", path_refs, subdir) == -1)
519 return got_error_from_errno();
521 d = opendir(path_subdir);
527 struct got_reference *ref;
534 if (strcmp(dent->d_name, ".") == 0 ||
535 strcmp(dent->d_name, "..") == 0)
538 switch (dent->d_type) {
540 err = open_ref(&ref, path_refs, subdir, dent->d_name);
544 err = insert_ref(refs, ref, repo);
550 if (asprintf(&child, "%s%s%s", subdir,
551 subdir[0] == '\0' ? "" : "/", dent->d_name) == -1) {
552 err = got_error_from_errno();
555 err = gather_on_disk_refs(refs, path_refs, child, repo);
569 const struct got_error *
570 got_ref_list(struct got_reflist_head *refs, struct got_repository *repo)
572 const struct got_error *err;
573 char *packed_refs_path, *path_refs = NULL;
575 struct got_reference *ref;
577 /* HEAD ref should always exist. */
578 path_refs = get_refs_dir_path(repo, GOT_REF_HEAD);
579 if (path_refs == NULL) {
580 err = got_error_from_errno();
583 err = open_ref(&ref, path_refs, "", GOT_REF_HEAD);
586 err = insert_ref(refs, ref, repo);
590 /* Gather on-disk refs before parsing packed-refs. */
592 path_refs = get_refs_dir_path(repo, "");
593 if (path_refs == NULL) {
594 err = got_error_from_errno();
597 err = gather_on_disk_refs(refs, path_refs, "", repo);
602 * The packed-refs file may contain redundant entries, in which
603 * case on-disk refs take precedence.
605 packed_refs_path = got_repo_get_path_packed_refs(repo);
606 if (packed_refs_path == NULL) {
607 err = got_error_from_errno();
611 f = fopen(packed_refs_path, "r");
612 free(packed_refs_path);
616 const char delim[3] = {'\0', '\0', '\0'};
618 line = fparseln(f, &len, NULL, delim, 0);
621 err = parse_packed_ref_line(&ref, NULL, line);
625 err = insert_ref(refs, ref, repo);
633 if (f && fclose(f) != 0 && err == NULL)
634 err = got_error_from_errno();