]> git.proxmox.com Git - libgit2.git/blob - src/refs.c
Merge pull request #1115 from ben/struct-versions
[libgit2.git] / src / refs.c
1 /*
2 * Copyright (C) 2009-2012 the libgit2 contributors
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
8 #include "refs.h"
9 #include "hash.h"
10 #include "repository.h"
11 #include "fileops.h"
12 #include "pack.h"
13 #include "reflog.h"
14
15 #include <git2/tag.h>
16 #include <git2/object.h>
17 #include <git2/oid.h>
18 #include <git2/branch.h>
19
20 GIT__USE_STRMAP;
21
22 #define DEFAULT_NESTING_LEVEL 5
23 #define MAX_NESTING_LEVEL 10
24
25 enum {
26 GIT_PACKREF_HAS_PEEL = 1,
27 GIT_PACKREF_WAS_LOOSE = 2
28 };
29
30 struct packref {
31 git_oid oid;
32 git_oid peel;
33 char flags;
34 char name[GIT_FLEX_ARRAY];
35 };
36
37 static int reference_read(
38 git_buf *file_content,
39 time_t *mtime,
40 const char *repo_path,
41 const char *ref_name,
42 int *updated);
43
44 /* loose refs */
45 static int loose_parse_symbolic(git_reference *ref, git_buf *file_content);
46 static int loose_parse_oid(git_oid *ref, git_buf *file_content);
47 static int loose_lookup(git_reference *ref);
48 static int loose_lookup_to_packfile(struct packref **ref_out,
49 git_repository *repo, const char *name);
50 static int loose_write(git_reference *ref);
51
52 /* packed refs */
53 static int packed_parse_peel(struct packref *tag_ref,
54 const char **buffer_out, const char *buffer_end);
55 static int packed_parse_oid(struct packref **ref_out,
56 const char **buffer_out, const char *buffer_end);
57 static int packed_load(git_repository *repo);
58 static int packed_loadloose(git_repository *repository);
59 static int packed_write_ref(struct packref *ref, git_filebuf *file);
60 static int packed_find_peel(git_repository *repo, struct packref *ref);
61 static int packed_remove_loose(git_repository *repo, git_vector *packing_list);
62 static int packed_sort(const void *a, const void *b);
63 static int packed_lookup(git_reference *ref);
64 static int packed_write(git_repository *repo);
65
66 /* internal helpers */
67 static int reference_path_available(git_repository *repo,
68 const char *ref, const char *old_ref);
69 static int reference_delete(git_reference *ref);
70 static int reference_lookup(git_reference *ref);
71
72 void git_reference_free(git_reference *reference)
73 {
74 if (reference == NULL)
75 return;
76
77 git__free(reference->name);
78 reference->name = NULL;
79
80 if (reference->flags & GIT_REF_SYMBOLIC) {
81 git__free(reference->target.symbolic);
82 reference->target.symbolic = NULL;
83 }
84
85 git__free(reference);
86 }
87
88 static int reference_alloc(
89 git_reference **ref_out,
90 git_repository *repo,
91 const char *name)
92 {
93 git_reference *reference = NULL;
94
95 assert(ref_out && repo && name);
96
97 reference = git__malloc(sizeof(git_reference));
98 GITERR_CHECK_ALLOC(reference);
99
100 memset(reference, 0x0, sizeof(git_reference));
101 reference->owner = repo;
102
103 reference->name = git__strdup(name);
104 GITERR_CHECK_ALLOC(reference->name);
105
106 *ref_out = reference;
107 return 0;
108 }
109
110 static int reference_read(
111 git_buf *file_content,
112 time_t *mtime,
113 const char *repo_path,
114 const char *ref_name,
115 int *updated)
116 {
117 git_buf path = GIT_BUF_INIT;
118 int result;
119
120 assert(file_content && repo_path && ref_name);
121
122 /* Determine the full path of the file */
123 if (git_buf_joinpath(&path, repo_path, ref_name) < 0)
124 return -1;
125
126 result = git_futils_readbuffer_updated(
127 file_content, path.ptr, mtime, NULL, updated);
128 git_buf_free(&path);
129
130 return result;
131 }
132
133 static int loose_parse_symbolic(git_reference *ref, git_buf *file_content)
134 {
135 const unsigned int header_len = (unsigned int)strlen(GIT_SYMREF);
136 const char *refname_start;
137
138 refname_start = (const char *)file_content->ptr;
139
140 if (git_buf_len(file_content) < header_len + 1) {
141 giterr_set(GITERR_REFERENCE, "Corrupted loose reference file");
142 return -1;
143 }
144
145 /*
146 * Assume we have already checked for the header
147 * before calling this function
148 */
149 refname_start += header_len;
150
151 ref->target.symbolic = git__strdup(refname_start);
152 GITERR_CHECK_ALLOC(ref->target.symbolic);
153
154 return 0;
155 }
156
157 static int loose_parse_oid(git_oid *oid, git_buf *file_content)
158 {
159 size_t len;
160 const char *str;
161
162 len = git_buf_len(file_content);
163 if (len < GIT_OID_HEXSZ)
164 goto corrupted;
165
166 /* str is guranteed to be zero-terminated */
167 str = git_buf_cstr(file_content);
168
169 /* If the file is longer than 40 chars, the 41st must be a space */
170 if (git_oid_fromstr(oid, git_buf_cstr(file_content)) < 0)
171 goto corrupted;
172
173 /* If the file is longer than 40 chars, the 41st must be a space */
174 str += GIT_OID_HEXSZ;
175 if (*str == '\0' || git__isspace(*str))
176 return 0;
177
178 corrupted:
179 giterr_set(GITERR_REFERENCE, "Corrupted loose reference file");
180 return -1;
181 }
182
183 static git_ref_t loose_guess_rtype(const git_buf *full_path)
184 {
185 git_buf ref_file = GIT_BUF_INIT;
186 git_ref_t type;
187
188 type = GIT_REF_INVALID;
189
190 if (git_futils_readbuffer(&ref_file, full_path->ptr) == 0) {
191 if (git__prefixcmp((const char *)(ref_file.ptr), GIT_SYMREF) == 0)
192 type = GIT_REF_SYMBOLIC;
193 else
194 type = GIT_REF_OID;
195 }
196
197 git_buf_free(&ref_file);
198 return type;
199 }
200
201 static int loose_lookup(git_reference *ref)
202 {
203 int result, updated;
204 git_buf ref_file = GIT_BUF_INIT;
205
206 result = reference_read(&ref_file, &ref->mtime,
207 ref->owner->path_repository, ref->name, &updated);
208
209 if (result < 0)
210 return result;
211
212 if (!updated)
213 return 0;
214
215 if (ref->flags & GIT_REF_SYMBOLIC) {
216 git__free(ref->target.symbolic);
217 ref->target.symbolic = NULL;
218 }
219
220 ref->flags = 0;
221
222 if (git__prefixcmp((const char *)(ref_file.ptr), GIT_SYMREF) == 0) {
223 ref->flags |= GIT_REF_SYMBOLIC;
224 git_buf_rtrim(&ref_file);
225 result = loose_parse_symbolic(ref, &ref_file);
226 } else {
227 ref->flags |= GIT_REF_OID;
228 result = loose_parse_oid(&ref->target.oid, &ref_file);
229 }
230
231 git_buf_free(&ref_file);
232 return result;
233 }
234
235 static int loose_lookup_to_packfile(
236 struct packref **ref_out,
237 git_repository *repo,
238 const char *name)
239 {
240 git_buf ref_file = GIT_BUF_INIT;
241 struct packref *ref = NULL;
242 size_t name_len;
243
244 *ref_out = NULL;
245
246 if (reference_read(&ref_file, NULL, repo->path_repository, name, NULL) < 0)
247 return -1;
248
249 git_buf_rtrim(&ref_file);
250
251 name_len = strlen(name);
252 ref = git__malloc(sizeof(struct packref) + name_len + 1);
253 GITERR_CHECK_ALLOC(ref);
254
255 memcpy(ref->name, name, name_len);
256 ref->name[name_len] = 0;
257
258 if (loose_parse_oid(&ref->oid, &ref_file) < 0) {
259 git_buf_free(&ref_file);
260 git__free(ref);
261 return -1;
262 }
263
264 ref->flags = GIT_PACKREF_WAS_LOOSE;
265
266 *ref_out = ref;
267 git_buf_free(&ref_file);
268 return 0;
269 }
270
271 static int loose_write(git_reference *ref)
272 {
273 git_filebuf file = GIT_FILEBUF_INIT;
274 git_buf ref_path = GIT_BUF_INIT;
275 struct stat st;
276
277 /* Remove a possibly existing empty directory hierarchy
278 * which name would collide with the reference name
279 */
280 if (git_futils_rmdir_r(ref->name, ref->owner->path_repository,
281 GIT_RMDIR_SKIP_NONEMPTY) < 0)
282 return -1;
283
284 if (git_buf_joinpath(&ref_path, ref->owner->path_repository, ref->name) < 0)
285 return -1;
286
287 if (git_filebuf_open(&file, ref_path.ptr, GIT_FILEBUF_FORCE) < 0) {
288 git_buf_free(&ref_path);
289 return -1;
290 }
291
292 git_buf_free(&ref_path);
293
294 if (ref->flags & GIT_REF_OID) {
295 char oid[GIT_OID_HEXSZ + 1];
296
297 git_oid_fmt(oid, &ref->target.oid);
298 oid[GIT_OID_HEXSZ] = '\0';
299
300 git_filebuf_printf(&file, "%s\n", oid);
301
302 } else if (ref->flags & GIT_REF_SYMBOLIC) {
303 git_filebuf_printf(&file, GIT_SYMREF "%s\n", ref->target.symbolic);
304 } else {
305 assert(0); /* don't let this happen */
306 }
307
308 if (p_stat(ref_path.ptr, &st) == 0)
309 ref->mtime = st.st_mtime;
310
311 return git_filebuf_commit(&file, GIT_REFS_FILE_MODE);
312 }
313
314 static int packed_parse_peel(
315 struct packref *tag_ref,
316 const char **buffer_out,
317 const char *buffer_end)
318 {
319 const char *buffer = *buffer_out + 1;
320
321 assert(buffer[-1] == '^');
322
323 /* Ensure it's not the first entry of the file */
324 if (tag_ref == NULL)
325 goto corrupt;
326
327 /* Ensure reference is a tag */
328 if (git__prefixcmp(tag_ref->name, GIT_REFS_TAGS_DIR) != 0)
329 goto corrupt;
330
331 if (buffer + GIT_OID_HEXSZ >= buffer_end)
332 goto corrupt;
333
334 /* Is this a valid object id? */
335 if (git_oid_fromstr(&tag_ref->peel, buffer) < 0)
336 goto corrupt;
337
338 buffer = buffer + GIT_OID_HEXSZ;
339 if (*buffer == '\r')
340 buffer++;
341
342 if (*buffer != '\n')
343 goto corrupt;
344
345 *buffer_out = buffer + 1;
346 return 0;
347
348 corrupt:
349 giterr_set(GITERR_REFERENCE, "The packed references file is corrupted");
350 return -1;
351 }
352
353 static int packed_parse_oid(
354 struct packref **ref_out,
355 const char **buffer_out,
356 const char *buffer_end)
357 {
358 struct packref *ref = NULL;
359
360 const char *buffer = *buffer_out;
361 const char *refname_begin, *refname_end;
362
363 size_t refname_len;
364 git_oid id;
365
366 refname_begin = (buffer + GIT_OID_HEXSZ + 1);
367 if (refname_begin >= buffer_end || refname_begin[-1] != ' ')
368 goto corrupt;
369
370 /* Is this a valid object id? */
371 if (git_oid_fromstr(&id, buffer) < 0)
372 goto corrupt;
373
374 refname_end = memchr(refname_begin, '\n', buffer_end - refname_begin);
375 if (refname_end == NULL)
376 goto corrupt;
377
378 if (refname_end[-1] == '\r')
379 refname_end--;
380
381 refname_len = refname_end - refname_begin;
382
383 ref = git__malloc(sizeof(struct packref) + refname_len + 1);
384 GITERR_CHECK_ALLOC(ref);
385
386 memcpy(ref->name, refname_begin, refname_len);
387 ref->name[refname_len] = 0;
388
389 git_oid_cpy(&ref->oid, &id);
390
391 ref->flags = 0;
392
393 *ref_out = ref;
394 *buffer_out = refname_end + 1;
395
396 return 0;
397
398 corrupt:
399 git__free(ref);
400 giterr_set(GITERR_REFERENCE, "The packed references file is corrupted");
401 return -1;
402 }
403
404 static int packed_load(git_repository *repo)
405 {
406 int result, updated;
407 git_buf packfile = GIT_BUF_INIT;
408 const char *buffer_start, *buffer_end;
409 git_refcache *ref_cache = &repo->references;
410
411 /* First we make sure we have allocated the hash table */
412 if (ref_cache->packfile == NULL) {
413 ref_cache->packfile = git_strmap_alloc();
414 GITERR_CHECK_ALLOC(ref_cache->packfile);
415 }
416
417 result = reference_read(&packfile, &ref_cache->packfile_time,
418 repo->path_repository, GIT_PACKEDREFS_FILE, &updated);
419
420 /*
421 * If we couldn't find the file, we need to clear the table and
422 * return. On any other error, we return that error. If everything
423 * went fine and the file wasn't updated, then there's nothing new
424 * for us here, so just return. Anything else means we need to
425 * refresh the packed refs.
426 */
427 if (result == GIT_ENOTFOUND) {
428 git_strmap_clear(ref_cache->packfile);
429 return 0;
430 }
431
432 if (result < 0)
433 return -1;
434
435 if (!updated)
436 return 0;
437
438 /*
439 * At this point, we want to refresh the packed refs. We already
440 * have the contents in our buffer.
441 */
442 git_strmap_clear(ref_cache->packfile);
443
444 buffer_start = (const char *)packfile.ptr;
445 buffer_end = (const char *)(buffer_start) + packfile.size;
446
447 while (buffer_start < buffer_end && buffer_start[0] == '#') {
448 buffer_start = strchr(buffer_start, '\n');
449 if (buffer_start == NULL)
450 goto parse_failed;
451
452 buffer_start++;
453 }
454
455 while (buffer_start < buffer_end) {
456 int err;
457 struct packref *ref = NULL;
458
459 if (packed_parse_oid(&ref, &buffer_start, buffer_end) < 0)
460 goto parse_failed;
461
462 if (buffer_start[0] == '^') {
463 if (packed_parse_peel(ref, &buffer_start, buffer_end) < 0)
464 goto parse_failed;
465 }
466
467 git_strmap_insert(ref_cache->packfile, ref->name, ref, err);
468 if (err < 0)
469 goto parse_failed;
470 }
471
472 git_buf_free(&packfile);
473 return 0;
474
475 parse_failed:
476 git_strmap_free(ref_cache->packfile);
477 ref_cache->packfile = NULL;
478 git_buf_free(&packfile);
479 return -1;
480 }
481
482
483 struct dirent_list_data {
484 git_repository *repo;
485 size_t repo_path_len;
486 unsigned int list_flags;
487
488 int (*callback)(const char *, void *);
489 void *callback_payload;
490 int callback_error;
491 };
492
493 static int _dirent_loose_listall(void *_data, git_buf *full_path)
494 {
495 struct dirent_list_data *data = (struct dirent_list_data *)_data;
496 const char *file_path = full_path->ptr + data->repo_path_len;
497
498 if (git_path_isdir(full_path->ptr) == true)
499 return git_path_direach(full_path, _dirent_loose_listall, _data);
500
501 /* do not add twice a reference that exists already in the packfile */
502 if ((data->list_flags & GIT_REF_PACKED) != 0 &&
503 git_strmap_exists(data->repo->references.packfile, file_path))
504 return 0;
505
506 if (data->list_flags != GIT_REF_LISTALL) {
507 if ((data->list_flags & loose_guess_rtype(full_path)) == 0)
508 return 0; /* we are filtering out this reference */
509 }
510
511 /* Locked references aren't returned */
512 if (!git__suffixcmp(file_path, GIT_FILELOCK_EXTENSION))
513 return 0;
514
515 if (data->callback(file_path, data->callback_payload))
516 data->callback_error = GIT_EUSER;
517
518 return data->callback_error;
519 }
520
521 static int _dirent_loose_load(void *data, git_buf *full_path)
522 {
523 git_repository *repository = (git_repository *)data;
524 void *old_ref = NULL;
525 struct packref *ref;
526 const char *file_path;
527 int err;
528
529 if (git_path_isdir(full_path->ptr) == true)
530 return git_path_direach(full_path, _dirent_loose_load, repository);
531
532 file_path = full_path->ptr + strlen(repository->path_repository);
533
534 if (loose_lookup_to_packfile(&ref, repository, file_path) < 0)
535 return -1;
536
537 git_strmap_insert2(
538 repository->references.packfile, ref->name, ref, old_ref, err);
539 if (err < 0) {
540 git__free(ref);
541 return -1;
542 }
543
544 git__free(old_ref);
545 return 0;
546 }
547
548 /*
549 * Load all the loose references from the repository
550 * into the in-memory Packfile, and build a vector with
551 * all the references so it can be written back to
552 * disk.
553 */
554 static int packed_loadloose(git_repository *repository)
555 {
556 git_buf refs_path = GIT_BUF_INIT;
557 int result;
558
559 /* the packfile must have been previously loaded! */
560 assert(repository->references.packfile);
561
562 if (git_buf_joinpath(&refs_path, repository->path_repository, GIT_REFS_DIR) < 0)
563 return -1;
564
565 /*
566 * Load all the loose files from disk into the Packfile table.
567 * This will overwrite any old packed entries with their
568 * updated loose versions
569 */
570 result = git_path_direach(&refs_path, _dirent_loose_load, repository);
571 git_buf_free(&refs_path);
572
573 return result;
574 }
575
576 /*
577 * Write a single reference into a packfile
578 */
579 static int packed_write_ref(struct packref *ref, git_filebuf *file)
580 {
581 char oid[GIT_OID_HEXSZ + 1];
582
583 git_oid_fmt(oid, &ref->oid);
584 oid[GIT_OID_HEXSZ] = 0;
585
586 /*
587 * For references that peel to an object in the repo, we must
588 * write the resulting peel on a separate line, e.g.
589 *
590 * 6fa8a902cc1d18527e1355773c86721945475d37 refs/tags/libgit2-0.4
591 * ^2ec0cb7959b0bf965d54f95453f5b4b34e8d3100
592 *
593 * This obviously only applies to tags.
594 * The required peels have already been loaded into `ref->peel_target`.
595 */
596 if (ref->flags & GIT_PACKREF_HAS_PEEL) {
597 char peel[GIT_OID_HEXSZ + 1];
598 git_oid_fmt(peel, &ref->peel);
599 peel[GIT_OID_HEXSZ] = 0;
600
601 if (git_filebuf_printf(file, "%s %s\n^%s\n", oid, ref->name, peel) < 0)
602 return -1;
603 } else {
604 if (git_filebuf_printf(file, "%s %s\n", oid, ref->name) < 0)
605 return -1;
606 }
607
608 return 0;
609 }
610
611 /*
612 * Find out what object this reference resolves to.
613 *
614 * For references that point to a 'big' tag (e.g. an
615 * actual tag object on the repository), we need to
616 * cache on the packfile the OID of the object to
617 * which that 'big tag' is pointing to.
618 */
619 static int packed_find_peel(git_repository *repo, struct packref *ref)
620 {
621 git_object *object;
622
623 if (ref->flags & GIT_PACKREF_HAS_PEEL)
624 return 0;
625
626 /*
627 * Only applies to tags, i.e. references
628 * in the /refs/tags folder
629 */
630 if (git__prefixcmp(ref->name, GIT_REFS_TAGS_DIR) != 0)
631 return 0;
632
633 /*
634 * Find the tagged object in the repository
635 */
636 if (git_object_lookup(&object, repo, &ref->oid, GIT_OBJ_ANY) < 0)
637 return -1;
638
639 /*
640 * If the tagged object is a Tag object, we need to resolve it;
641 * if the ref is actually a 'weak' ref, we don't need to resolve
642 * anything.
643 */
644 if (git_object_type(object) == GIT_OBJ_TAG) {
645 git_tag *tag = (git_tag *)object;
646
647 /*
648 * Find the object pointed at by this tag
649 */
650 git_oid_cpy(&ref->peel, git_tag_target_id(tag));
651 ref->flags |= GIT_PACKREF_HAS_PEEL;
652
653 /*
654 * The reference has now cached the resolved OID, and is
655 * marked at such. When written to the packfile, it'll be
656 * accompanied by this resolved oid
657 */
658 }
659
660 git_object_free(object);
661 return 0;
662 }
663
664 /*
665 * Remove all loose references
666 *
667 * Once we have successfully written a packfile,
668 * all the loose references that were packed must be
669 * removed from disk.
670 *
671 * This is a dangerous method; make sure the packfile
672 * is well-written, because we are destructing references
673 * here otherwise.
674 */
675 static int packed_remove_loose(git_repository *repo, git_vector *packing_list)
676 {
677 unsigned int i;
678 git_buf full_path = GIT_BUF_INIT;
679 int failed = 0;
680
681 for (i = 0; i < packing_list->length; ++i) {
682 struct packref *ref = git_vector_get(packing_list, i);
683
684 if ((ref->flags & GIT_PACKREF_WAS_LOOSE) == 0)
685 continue;
686
687 if (git_buf_joinpath(&full_path, repo->path_repository, ref->name) < 0)
688 return -1; /* critical; do not try to recover on oom */
689
690 if (git_path_exists(full_path.ptr) == true && p_unlink(full_path.ptr) < 0) {
691 if (failed)
692 continue;
693
694 giterr_set(GITERR_REFERENCE,
695 "Failed to remove loose reference '%s' after packing: %s",
696 full_path.ptr, strerror(errno));
697
698 failed = 1;
699 }
700
701 /*
702 * if we fail to remove a single file, this is *not* good,
703 * but we should keep going and remove as many as possible.
704 * After we've removed as many files as possible, we return
705 * the error code anyway.
706 */
707 }
708
709 git_buf_free(&full_path);
710 return failed ? -1 : 0;
711 }
712
713 static int packed_sort(const void *a, const void *b)
714 {
715 const struct packref *ref_a = (const struct packref *)a;
716 const struct packref *ref_b = (const struct packref *)b;
717
718 return strcmp(ref_a->name, ref_b->name);
719 }
720
721 /*
722 * Write all the contents in the in-memory packfile to disk.
723 */
724 static int packed_write(git_repository *repo)
725 {
726 git_filebuf pack_file = GIT_FILEBUF_INIT;
727 unsigned int i;
728 git_buf pack_file_path = GIT_BUF_INIT;
729 git_vector packing_list;
730 unsigned int total_refs;
731
732 assert(repo && repo->references.packfile);
733
734 total_refs =
735 (unsigned int)git_strmap_num_entries(repo->references.packfile);
736
737 if (git_vector_init(&packing_list, total_refs, packed_sort) < 0)
738 return -1;
739
740 /* Load all the packfile into a vector */
741 {
742 struct packref *reference;
743
744 /* cannot fail: vector already has the right size */
745 git_strmap_foreach_value(repo->references.packfile, reference, {
746 git_vector_insert(&packing_list, reference);
747 });
748 }
749
750 /* sort the vector so the entries appear sorted on the packfile */
751 git_vector_sort(&packing_list);
752
753 /* Now we can open the file! */
754 if (git_buf_joinpath(&pack_file_path, repo->path_repository, GIT_PACKEDREFS_FILE) < 0)
755 goto cleanup_memory;
756
757 if (git_filebuf_open(&pack_file, pack_file_path.ptr, 0) < 0)
758 goto cleanup_packfile;
759
760 /* Packfiles have a header... apparently
761 * This is in fact not required, but we might as well print it
762 * just for kicks */
763 if (git_filebuf_printf(&pack_file, "%s\n", GIT_PACKEDREFS_HEADER) < 0)
764 goto cleanup_packfile;
765
766 for (i = 0; i < packing_list.length; ++i) {
767 struct packref *ref = (struct packref *)git_vector_get(&packing_list, i);
768
769 if (packed_find_peel(repo, ref) < 0)
770 goto cleanup_packfile;
771
772 if (packed_write_ref(ref, &pack_file) < 0)
773 goto cleanup_packfile;
774 }
775
776 /* if we've written all the references properly, we can commit
777 * the packfile to make the changes effective */
778 if (git_filebuf_commit(&pack_file, GIT_PACKEDREFS_FILE_MODE) < 0)
779 goto cleanup_memory;
780
781 /* when and only when the packfile has been properly written,
782 * we can go ahead and remove the loose refs */
783 if (packed_remove_loose(repo, &packing_list) < 0)
784 goto cleanup_memory;
785
786 {
787 struct stat st;
788 if (p_stat(pack_file_path.ptr, &st) == 0)
789 repo->references.packfile_time = st.st_mtime;
790 }
791
792 git_vector_free(&packing_list);
793 git_buf_free(&pack_file_path);
794
795 /* we're good now */
796 return 0;
797
798 cleanup_packfile:
799 git_filebuf_cleanup(&pack_file);
800
801 cleanup_memory:
802 git_vector_free(&packing_list);
803 git_buf_free(&pack_file_path);
804
805 return -1;
806 }
807
808 struct reference_available_t {
809 const char *new_ref;
810 const char *old_ref;
811 int available;
812 };
813
814 static int _reference_available_cb(const char *ref, void *data)
815 {
816 struct reference_available_t *d;
817
818 assert(ref && data);
819 d = (struct reference_available_t *)data;
820
821 if (!d->old_ref || strcmp(d->old_ref, ref)) {
822 size_t reflen = strlen(ref);
823 size_t newlen = strlen(d->new_ref);
824 size_t cmplen = reflen < newlen ? reflen : newlen;
825 const char *lead = reflen < newlen ? d->new_ref : ref;
826
827 if (!strncmp(d->new_ref, ref, cmplen) && lead[cmplen] == '/') {
828 d->available = 0;
829 return -1;
830 }
831 }
832
833 return 0;
834 }
835
836 static int reference_path_available(
837 git_repository *repo,
838 const char *ref,
839 const char* old_ref)
840 {
841 int error;
842 struct reference_available_t data;
843
844 data.new_ref = ref;
845 data.old_ref = old_ref;
846 data.available = 1;
847
848 error = git_reference_foreach(
849 repo, GIT_REF_LISTALL, _reference_available_cb, (void *)&data);
850 if (error < 0)
851 return error;
852
853 if (!data.available) {
854 giterr_set(GITERR_REFERENCE,
855 "The path to reference '%s' collides with an existing one", ref);
856 return -1;
857 }
858
859 return 0;
860 }
861
862 static int reference_exists(int *exists, git_repository *repo, const char *ref_name)
863 {
864 git_buf ref_path = GIT_BUF_INIT;
865
866 if (packed_load(repo) < 0)
867 return -1;
868
869 if (git_buf_joinpath(&ref_path, repo->path_repository, ref_name) < 0)
870 return -1;
871
872 if (git_path_isfile(ref_path.ptr) == true ||
873 git_strmap_exists(repo->references.packfile, ref_path.ptr))
874 {
875 *exists = 1;
876 } else {
877 *exists = 0;
878 }
879
880 git_buf_free(&ref_path);
881 return 0;
882 }
883
884 /*
885 * Check if a reference could be written to disk, based on:
886 *
887 * - Whether a reference with the same name already exists,
888 * and we are allowing or disallowing overwrites
889 *
890 * - Whether the name of the reference would collide with
891 * an existing path
892 */
893 static int reference_can_write(
894 git_repository *repo,
895 const char *refname,
896 const char *previous_name,
897 int force)
898 {
899 /* see if the reference shares a path with an existing reference;
900 * if a path is shared, we cannot create the reference, even when forcing */
901 if (reference_path_available(repo, refname, previous_name) < 0)
902 return -1;
903
904 /* check if the reference actually exists, but only if we are not forcing
905 * the rename. If we are forcing, it's OK to overwrite */
906 if (!force) {
907 int exists;
908
909 if (reference_exists(&exists, repo, refname) < 0)
910 return -1;
911
912 /* We cannot proceed if the reference already exists and we're not forcing
913 * the rename; the existing one would be overwritten */
914 if (exists) {
915 giterr_set(GITERR_REFERENCE,
916 "A reference with that name (%s) already exists", refname);
917 return GIT_EEXISTS;
918 }
919 }
920
921 /* FIXME: if the reference exists and we are forcing, do we really need to
922 * remove the reference first?
923 *
924 * Two cases:
925 *
926 * - the reference already exists and is loose: not a problem, the file
927 * gets overwritten on disk
928 *
929 * - the reference already exists and is packed: we write a new one as
930 * loose, which by all means renders the packed one useless
931 */
932
933 return 0;
934 }
935
936
937 static int packed_lookup(git_reference *ref)
938 {
939 struct packref *pack_ref = NULL;
940 git_strmap *packfile_refs;
941 khiter_t pos;
942
943 if (packed_load(ref->owner) < 0)
944 return -1;
945
946 /* maybe the packfile hasn't changed at all, so we don't
947 * have to re-lookup the reference */
948 if ((ref->flags & GIT_REF_PACKED) &&
949 ref->mtime == ref->owner->references.packfile_time)
950 return 0;
951
952 if (ref->flags & GIT_REF_SYMBOLIC) {
953 git__free(ref->target.symbolic);
954 ref->target.symbolic = NULL;
955 }
956
957 /* Look up on the packfile */
958 packfile_refs = ref->owner->references.packfile;
959 pos = git_strmap_lookup_index(packfile_refs, ref->name);
960 if (!git_strmap_valid_index(packfile_refs, pos)) {
961 giterr_set(GITERR_REFERENCE, "Reference '%s' not found", ref->name);
962 return GIT_ENOTFOUND;
963 }
964
965 pack_ref = git_strmap_value_at(packfile_refs, pos);
966
967 ref->flags = GIT_REF_OID | GIT_REF_PACKED;
968 ref->mtime = ref->owner->references.packfile_time;
969 git_oid_cpy(&ref->target.oid, &pack_ref->oid);
970
971 return 0;
972 }
973
974 static int reference_lookup(git_reference *ref)
975 {
976 int result;
977
978 result = loose_lookup(ref);
979 if (result == 0)
980 return 0;
981
982 /* only try to lookup this reference on the packfile if it
983 * wasn't found on the loose refs; not if there was a critical error */
984 if (result == GIT_ENOTFOUND) {
985 giterr_clear();
986 result = packed_lookup(ref);
987 if (result == 0)
988 return 0;
989 }
990
991 /* unexpected error; free the reference */
992 git_reference_free(ref);
993 return result;
994 }
995
996 /*
997 * Delete a reference.
998 * This is an internal method; the reference is removed
999 * from disk or the packfile, but the pointer is not freed
1000 */
1001 static int reference_delete(git_reference *ref)
1002 {
1003 int result;
1004
1005 assert(ref);
1006
1007 /* If the reference is packed, this is an expensive operation.
1008 * We need to reload the packfile, remove the reference from the
1009 * packing list, and repack */
1010 if (ref->flags & GIT_REF_PACKED) {
1011 git_strmap *packfile_refs;
1012 struct packref *packref;
1013 khiter_t pos;
1014
1015 /* load the existing packfile */
1016 if (packed_load(ref->owner) < 0)
1017 return -1;
1018
1019 packfile_refs = ref->owner->references.packfile;
1020 pos = git_strmap_lookup_index(packfile_refs, ref->name);
1021 if (!git_strmap_valid_index(packfile_refs, pos)) {
1022 giterr_set(GITERR_REFERENCE,
1023 "Reference %s stopped existing in the packfile", ref->name);
1024 return -1;
1025 }
1026
1027 packref = git_strmap_value_at(packfile_refs, pos);
1028 git_strmap_delete_at(packfile_refs, pos);
1029
1030 git__free(packref);
1031 if (packed_write(ref->owner) < 0)
1032 return -1;
1033
1034 /* If the reference is loose, we can just remove the reference
1035 * from the filesystem */
1036 } else {
1037 git_reference *ref_in_pack;
1038 git_buf full_path = GIT_BUF_INIT;
1039
1040 if (git_buf_joinpath(&full_path, ref->owner->path_repository, ref->name) < 0)
1041 return -1;
1042
1043 result = p_unlink(full_path.ptr);
1044 git_buf_free(&full_path); /* done with path at this point */
1045
1046 if (result < 0) {
1047 giterr_set(GITERR_OS, "Failed to unlink '%s'", full_path.ptr);
1048 return -1;
1049 }
1050
1051 /* When deleting a loose reference, we have to ensure that an older
1052 * packed version of it doesn't exist */
1053 if (git_reference_lookup(&ref_in_pack, ref->owner, ref->name) == 0) {
1054 assert((ref_in_pack->flags & GIT_REF_PACKED) != 0);
1055 return git_reference_delete(ref_in_pack);
1056 }
1057
1058 giterr_clear();
1059 }
1060
1061 return 0;
1062 }
1063
1064 int git_reference_delete(git_reference *ref)
1065 {
1066 int result = reference_delete(ref);
1067 git_reference_free(ref);
1068 return result;
1069 }
1070
1071 int git_reference_lookup(git_reference **ref_out,
1072 git_repository *repo, const char *name)
1073 {
1074 return git_reference_lookup_resolved(ref_out, repo, name, 0);
1075 }
1076
1077 int git_reference_name_to_id(
1078 git_oid *out, git_repository *repo, const char *name)
1079 {
1080 int error;
1081 git_reference *ref;
1082
1083 if ((error = git_reference_lookup_resolved(&ref, repo, name, -1)) < 0)
1084 return error;
1085
1086 git_oid_cpy(out, git_reference_target(ref));
1087 git_reference_free(ref);
1088 return 0;
1089 }
1090
1091 int git_reference_lookup_resolved(
1092 git_reference **ref_out,
1093 git_repository *repo,
1094 const char *name,
1095 int max_nesting)
1096 {
1097 git_reference *scan;
1098 int result, nesting;
1099
1100 assert(ref_out && repo && name);
1101
1102 *ref_out = NULL;
1103
1104 if (max_nesting > MAX_NESTING_LEVEL)
1105 max_nesting = MAX_NESTING_LEVEL;
1106 else if (max_nesting < 0)
1107 max_nesting = DEFAULT_NESTING_LEVEL;
1108
1109 scan = git__calloc(1, sizeof(git_reference));
1110 GITERR_CHECK_ALLOC(scan);
1111
1112 scan->name = git__calloc(GIT_REFNAME_MAX + 1, sizeof(char));
1113 GITERR_CHECK_ALLOC(scan->name);
1114
1115 if ((result = git_reference__normalize_name_lax(
1116 scan->name,
1117 GIT_REFNAME_MAX,
1118 name)) < 0) {
1119 git_reference_free(scan);
1120 return result;
1121 }
1122
1123 scan->target.symbolic = git__strdup(scan->name);
1124 GITERR_CHECK_ALLOC(scan->target.symbolic);
1125
1126 scan->owner = repo;
1127 scan->flags = GIT_REF_SYMBOLIC;
1128
1129 for (nesting = max_nesting;
1130 nesting >= 0 && (scan->flags & GIT_REF_SYMBOLIC) != 0;
1131 nesting--)
1132 {
1133 if (nesting != max_nesting)
1134 strncpy(scan->name, scan->target.symbolic, GIT_REFNAME_MAX);
1135
1136 scan->mtime = 0;
1137
1138 if ((result = reference_lookup(scan)) < 0)
1139 return result; /* lookup git_reference_free on scan already */
1140 }
1141
1142 if ((scan->flags & GIT_REF_OID) == 0 && max_nesting != 0) {
1143 giterr_set(GITERR_REFERENCE,
1144 "Cannot resolve reference (>%u levels deep)", max_nesting);
1145 git_reference_free(scan);
1146 return -1;
1147 }
1148
1149 *ref_out = scan;
1150 return 0;
1151 }
1152
1153 /**
1154 * Getters
1155 */
1156 git_ref_t git_reference_type(const git_reference *ref)
1157 {
1158 assert(ref);
1159
1160 if (ref->flags & GIT_REF_OID)
1161 return GIT_REF_OID;
1162
1163 if (ref->flags & GIT_REF_SYMBOLIC)
1164 return GIT_REF_SYMBOLIC;
1165
1166 return GIT_REF_INVALID;
1167 }
1168
1169 int git_reference_is_packed(git_reference *ref)
1170 {
1171 assert(ref);
1172 return !!(ref->flags & GIT_REF_PACKED);
1173 }
1174
1175 const char *git_reference_name(const git_reference *ref)
1176 {
1177 assert(ref);
1178 return ref->name;
1179 }
1180
1181 git_repository *git_reference_owner(const git_reference *ref)
1182 {
1183 assert(ref);
1184 return ref->owner;
1185 }
1186
1187 const git_oid *git_reference_target(const git_reference *ref)
1188 {
1189 assert(ref);
1190
1191 if ((ref->flags & GIT_REF_OID) == 0)
1192 return NULL;
1193
1194 return &ref->target.oid;
1195 }
1196
1197 const char *git_reference_symbolic_target(const git_reference *ref)
1198 {
1199 assert(ref);
1200
1201 if ((ref->flags & GIT_REF_SYMBOLIC) == 0)
1202 return NULL;
1203
1204 return ref->target.symbolic;
1205 }
1206
1207 int git_reference_symbolic_create(
1208 git_reference **ref_out,
1209 git_repository *repo,
1210 const char *name,
1211 const char *target,
1212 int force)
1213 {
1214 char normalized[GIT_REFNAME_MAX];
1215 git_reference *ref = NULL;
1216 int error;
1217
1218 if ((error = git_reference__normalize_name_lax(
1219 normalized,
1220 sizeof(normalized),
1221 name)) < 0)
1222 return error;
1223
1224 if ((error = reference_can_write(repo, normalized, NULL, force)) < 0)
1225 return error;
1226
1227 if (reference_alloc(&ref, repo, normalized) < 0)
1228 return -1;
1229
1230 ref->flags |= GIT_REF_SYMBOLIC;
1231
1232 /* set the target; this will normalize the name automatically
1233 * and write the reference on disk */
1234 if (git_reference_symbolic_set_target(ref, target) < 0) {
1235 git_reference_free(ref);
1236 return -1;
1237 }
1238 if (ref_out == NULL) {
1239 git_reference_free(ref);
1240 } else {
1241 *ref_out = ref;
1242 }
1243
1244 return 0;
1245 }
1246
1247 int git_reference_create(
1248 git_reference **ref_out,
1249 git_repository *repo,
1250 const char *name,
1251 const git_oid *id,
1252 int force)
1253 {
1254 int error;
1255 git_reference *ref = NULL;
1256 char normalized[GIT_REFNAME_MAX];
1257
1258 if ((error = git_reference__normalize_name_lax(
1259 normalized,
1260 sizeof(normalized),
1261 name)) < 0)
1262 return error;
1263
1264 if ((error = reference_can_write(repo, normalized, NULL, force)) < 0)
1265 return error;
1266
1267 if (reference_alloc(&ref, repo, name) < 0)
1268 return -1;
1269
1270 ref->flags |= GIT_REF_OID;
1271
1272 /* set the oid; this will write the reference on disk */
1273 if (git_reference_set_target(ref, id) < 0) {
1274 git_reference_free(ref);
1275 return -1;
1276 }
1277
1278 if (ref_out == NULL) {
1279 git_reference_free(ref);
1280 } else {
1281 *ref_out = ref;
1282 }
1283
1284 return 0;
1285 }
1286 /*
1287 * Change the OID target of a reference.
1288 *
1289 * For both loose and packed references, just change
1290 * the oid in memory and (over)write the file in disk.
1291 *
1292 * We do not repack packed references because of performance
1293 * reasons.
1294 */
1295 int git_reference_set_target(git_reference *ref, const git_oid *id)
1296 {
1297 git_odb *odb = NULL;
1298
1299 if ((ref->flags & GIT_REF_OID) == 0) {
1300 giterr_set(GITERR_REFERENCE, "Cannot set OID on symbolic reference");
1301 return -1;
1302 }
1303
1304 assert(ref->owner);
1305
1306 if (git_repository_odb__weakptr(&odb, ref->owner) < 0)
1307 return -1;
1308
1309 /* Don't let the user create references to OIDs that
1310 * don't exist in the ODB */
1311 if (!git_odb_exists(odb, id)) {
1312 giterr_set(GITERR_REFERENCE,
1313 "Target OID for the reference doesn't exist on the repository");
1314 return -1;
1315 }
1316
1317 /* Update the OID value on `ref` */
1318 git_oid_cpy(&ref->target.oid, id);
1319
1320 /* Write back to disk */
1321 return loose_write(ref);
1322 }
1323
1324 /*
1325 * Change the target of a symbolic reference.
1326 *
1327 * This is easy because symrefs cannot be inside
1328 * a pack. We just change the target in memory
1329 * and overwrite the file on disk.
1330 */
1331 int git_reference_symbolic_set_target(git_reference *ref, const char *target)
1332 {
1333 int error;
1334 char normalized[GIT_REFNAME_MAX];
1335
1336 if ((ref->flags & GIT_REF_SYMBOLIC) == 0) {
1337 giterr_set(GITERR_REFERENCE,
1338 "Cannot set symbolic target on a direct reference");
1339 return -1;
1340 }
1341
1342 if ((error = git_reference__normalize_name_lax(
1343 normalized,
1344 sizeof(normalized),
1345 target)) < 0)
1346 return error;
1347
1348 git__free(ref->target.symbolic);
1349 ref->target.symbolic = git__strdup(normalized);
1350 GITERR_CHECK_ALLOC(ref->target.symbolic);
1351
1352 return loose_write(ref);
1353 }
1354
1355 int git_reference_rename(git_reference *ref, const char *new_name, int force)
1356 {
1357 int result;
1358 unsigned int normalization_flags;
1359 git_buf aux_path = GIT_BUF_INIT;
1360 char normalized[GIT_REFNAME_MAX];
1361 bool should_head_be_updated = false;
1362
1363 normalization_flags = ref->flags & GIT_REF_SYMBOLIC ?
1364 GIT_REF_FORMAT_ALLOW_ONELEVEL
1365 : GIT_REF_FORMAT_NORMAL;
1366
1367 if ((result = git_reference_normalize_name(
1368 normalized,
1369 sizeof(normalized),
1370 new_name,
1371 normalization_flags)) < 0)
1372 return result;
1373
1374 if ((result = reference_can_write(ref->owner, normalized, ref->name, force)) < 0)
1375 return result;
1376
1377 /* Initialize path now so we won't get an allocation failure once
1378 * we actually start removing things. */
1379 if (git_buf_joinpath(&aux_path, ref->owner->path_repository, new_name) < 0)
1380 return -1;
1381
1382 /*
1383 * Check if we have to update HEAD.
1384 */
1385 if ((should_head_be_updated = git_branch_is_head(ref)) < 0)
1386 goto cleanup;
1387
1388 /*
1389 * Now delete the old ref and remove an possibly existing directory
1390 * named `new_name`. Note that using the internal `reference_delete`
1391 * method deletes the ref from disk but doesn't free the pointer, so
1392 * we can still access the ref's attributes for creating the new one
1393 */
1394 if (reference_delete(ref) < 0)
1395 goto cleanup;
1396
1397 /*
1398 * Finally we can create the new reference.
1399 */
1400 if (ref->flags & GIT_REF_SYMBOLIC) {
1401 result = git_reference_symbolic_create(
1402 NULL, ref->owner, new_name, ref->target.symbolic, force);
1403 } else {
1404 result = git_reference_create(
1405 NULL, ref->owner, new_name, &ref->target.oid, force);
1406 }
1407
1408 if (result < 0)
1409 goto rollback;
1410
1411 /*
1412 * Update HEAD it was poiting to the reference being renamed.
1413 */
1414 if (should_head_be_updated &&
1415 git_repository_set_head(ref->owner, new_name) < 0) {
1416 giterr_set(GITERR_REFERENCE,
1417 "Failed to update HEAD after renaming reference");
1418 goto cleanup;
1419 }
1420
1421 /*
1422 * Rename the reflog file, if it exists.
1423 */
1424 if ((git_reference_has_log(ref)) && (git_reflog_rename(ref, new_name) < 0))
1425 goto cleanup;
1426
1427 /*
1428 * Change the name of the reference given by the user.
1429 */
1430 git__free(ref->name);
1431 ref->name = git__strdup(new_name);
1432
1433 /* The reference is no longer packed */
1434 ref->flags &= ~GIT_REF_PACKED;
1435
1436 git_buf_free(&aux_path);
1437 return 0;
1438
1439 cleanup:
1440 git_buf_free(&aux_path);
1441 return -1;
1442
1443 rollback:
1444 /*
1445 * Try to create the old reference again, ignore failures
1446 */
1447 if (ref->flags & GIT_REF_SYMBOLIC)
1448 git_reference_symbolic_create(
1449 NULL, ref->owner, ref->name, ref->target.symbolic, 0);
1450 else
1451 git_reference_create(
1452 NULL, ref->owner, ref->name, &ref->target.oid, 0);
1453
1454 /* The reference is no longer packed */
1455 ref->flags &= ~GIT_REF_PACKED;
1456
1457 git_buf_free(&aux_path);
1458 return -1;
1459 }
1460
1461 int git_reference_resolve(git_reference **ref_out, const git_reference *ref)
1462 {
1463 if (ref->flags & GIT_REF_OID)
1464 return git_reference_lookup(ref_out, ref->owner, ref->name);
1465 else
1466 return git_reference_lookup_resolved(ref_out, ref->owner, ref->target.symbolic, -1);
1467 }
1468
1469 int git_reference_packall(git_repository *repo)
1470 {
1471 if (packed_load(repo) < 0 || /* load the existing packfile */
1472 packed_loadloose(repo) < 0 || /* add all the loose refs */
1473 packed_write(repo) < 0) /* write back to disk */
1474 return -1;
1475
1476 return 0;
1477 }
1478
1479 int git_reference_foreach(
1480 git_repository *repo,
1481 unsigned int list_flags,
1482 git_reference_foreach_cb callback,
1483 void *payload)
1484 {
1485 int result;
1486 struct dirent_list_data data;
1487 git_buf refs_path = GIT_BUF_INIT;
1488
1489 /* list all the packed references first */
1490 if (list_flags & GIT_REF_PACKED) {
1491 const char *ref_name;
1492 void *ref;
1493 GIT_UNUSED(ref);
1494
1495 if (packed_load(repo) < 0)
1496 return -1;
1497
1498 git_strmap_foreach(repo->references.packfile, ref_name, ref, {
1499 if (callback(ref_name, payload))
1500 return GIT_EUSER;
1501 });
1502 }
1503
1504 /* now list the loose references, trying not to
1505 * duplicate the ref names already in the packed-refs file */
1506
1507 data.repo_path_len = strlen(repo->path_repository);
1508 data.list_flags = list_flags;
1509 data.repo = repo;
1510 data.callback = callback;
1511 data.callback_payload = payload;
1512 data.callback_error = 0;
1513
1514 if (git_buf_joinpath(&refs_path, repo->path_repository, GIT_REFS_DIR) < 0)
1515 return -1;
1516
1517 result = git_path_direach(&refs_path, _dirent_loose_listall, &data);
1518
1519 git_buf_free(&refs_path);
1520
1521 return data.callback_error ? GIT_EUSER : result;
1522 }
1523
1524 static int cb__reflist_add(const char *ref, void *data)
1525 {
1526 return git_vector_insert((git_vector *)data, git__strdup(ref));
1527 }
1528
1529 int git_reference_list(
1530 git_strarray *array,
1531 git_repository *repo,
1532 unsigned int list_flags)
1533 {
1534 git_vector ref_list;
1535
1536 assert(array && repo);
1537
1538 array->strings = NULL;
1539 array->count = 0;
1540
1541 if (git_vector_init(&ref_list, 8, NULL) < 0)
1542 return -1;
1543
1544 if (git_reference_foreach(
1545 repo, list_flags, &cb__reflist_add, (void *)&ref_list) < 0) {
1546 git_vector_free(&ref_list);
1547 return -1;
1548 }
1549
1550 array->strings = (char **)ref_list.contents;
1551 array->count = ref_list.length;
1552 return 0;
1553 }
1554
1555 int git_reference_reload(git_reference *ref)
1556 {
1557 return reference_lookup(ref);
1558 }
1559
1560 void git_repository__refcache_free(git_refcache *refs)
1561 {
1562 assert(refs);
1563
1564 if (refs->packfile) {
1565 struct packref *reference;
1566
1567 git_strmap_foreach_value(refs->packfile, reference, {
1568 git__free(reference);
1569 });
1570
1571 git_strmap_free(refs->packfile);
1572 }
1573 }
1574
1575 static int is_valid_ref_char(char ch)
1576 {
1577 if ((unsigned) ch <= ' ')
1578 return 0;
1579
1580 switch (ch) {
1581 case '~':
1582 case '^':
1583 case ':':
1584 case '\\':
1585 case '?':
1586 case '[':
1587 case '*':
1588 return 0;
1589 default:
1590 return 1;
1591 }
1592 }
1593
1594 static int ensure_segment_validity(const char *name)
1595 {
1596 const char *current = name;
1597 char prev = '\0';
1598
1599 if (*current == '.')
1600 return -1; /* Refname starts with "." */
1601
1602 for (current = name; ; current++) {
1603 if (*current == '\0' || *current == '/')
1604 break;
1605
1606 if (!is_valid_ref_char(*current))
1607 return -1; /* Illegal character in refname */
1608
1609 if (prev == '.' && *current == '.')
1610 return -1; /* Refname contains ".." */
1611
1612 if (prev == '@' && *current == '{')
1613 return -1; /* Refname contains "@{" */
1614
1615 prev = *current;
1616 }
1617
1618 return (int)(current - name);
1619 }
1620
1621 static bool is_all_caps_and_underscore(const char *name, size_t len)
1622 {
1623 size_t i;
1624 char c;
1625
1626 assert(name && len > 0);
1627
1628 for (i = 0; i < len; i++)
1629 {
1630 c = name[i];
1631 if ((c < 'A' || c > 'Z') && c != '_')
1632 return false;
1633 }
1634
1635 if (*name == '_' || name[len - 1] == '_')
1636 return false;
1637
1638 return true;
1639 }
1640
1641 int git_reference__normalize_name(
1642 git_buf *buf,
1643 const char *name,
1644 unsigned int flags)
1645 {
1646 // Inspired from https://github.com/git/git/blob/f06d47e7e0d9db709ee204ed13a8a7486149f494/refs.c#L36-100
1647
1648 char *current;
1649 int segment_len, segments_count = 0, error = GIT_EINVALIDSPEC;
1650 unsigned int process_flags;
1651 bool normalize = (buf != NULL);
1652 assert(name);
1653
1654 process_flags = flags;
1655 current = (char *)name;
1656
1657 if (normalize)
1658 git_buf_clear(buf);
1659
1660 while (true) {
1661 segment_len = ensure_segment_validity(current);
1662 if (segment_len < 0) {
1663 if ((process_flags & GIT_REF_FORMAT_REFSPEC_PATTERN) &&
1664 current[0] == '*' &&
1665 (current[1] == '\0' || current[1] == '/')) {
1666 /* Accept one wildcard as a full refname component. */
1667 process_flags &= ~GIT_REF_FORMAT_REFSPEC_PATTERN;
1668 segment_len = 1;
1669 } else
1670 goto cleanup;
1671 }
1672
1673 if (segment_len > 0) {
1674 if (normalize) {
1675 size_t cur_len = git_buf_len(buf);
1676
1677 git_buf_joinpath(buf, git_buf_cstr(buf), current);
1678 git_buf_truncate(buf,
1679 cur_len + segment_len + (segments_count ? 1 : 0));
1680
1681 if (git_buf_oom(buf)) {
1682 error = -1;
1683 goto cleanup;
1684 }
1685 }
1686
1687 segments_count++;
1688 }
1689
1690 if (current[segment_len] == '\0')
1691 break;
1692
1693 current += segment_len + 1;
1694 }
1695
1696 /* A refname can not be empty */
1697 if (segment_len == 0 && segments_count == 0)
1698 goto cleanup;
1699
1700 /* A refname can not end with "." */
1701 if (current[segment_len - 1] == '.')
1702 goto cleanup;
1703
1704 /* A refname can not end with "/" */
1705 if (current[segment_len - 1] == '/')
1706 goto cleanup;
1707
1708 /* A refname can not end with ".lock" */
1709 if (!git__suffixcmp(name, GIT_FILELOCK_EXTENSION))
1710 goto cleanup;
1711
1712 if ((segments_count == 1 ) && !(flags & GIT_REF_FORMAT_ALLOW_ONELEVEL))
1713 goto cleanup;
1714
1715 if ((segments_count == 1 ) &&
1716 !(is_all_caps_and_underscore(name, (size_t)segment_len) ||
1717 ((flags & GIT_REF_FORMAT_REFSPEC_PATTERN) && !strcmp("*", name))))
1718 goto cleanup;
1719
1720 if ((segments_count > 1)
1721 && (is_all_caps_and_underscore(name, strchr(name, '/') - name)))
1722 goto cleanup;
1723
1724 error = 0;
1725
1726 cleanup:
1727 if (error == GIT_EINVALIDSPEC)
1728 giterr_set(
1729 GITERR_REFERENCE,
1730 "The given reference name '%s' is not valid", name);
1731
1732 return error;
1733 }
1734
1735 int git_reference_normalize_name(
1736 char *buffer_out,
1737 size_t buffer_size,
1738 const char *name,
1739 unsigned int flags)
1740 {
1741 git_buf buf = GIT_BUF_INIT;
1742 int error;
1743
1744 if ((error = git_reference__normalize_name(&buf, name, flags)) < 0)
1745 goto cleanup;
1746
1747 if (git_buf_len(&buf) > buffer_size - 1) {
1748 giterr_set(
1749 GITERR_REFERENCE,
1750 "The provided buffer is too short to hold the normalization of '%s'", name);
1751 error = GIT_EBUFS;
1752 goto cleanup;
1753 }
1754
1755 git_buf_copy_cstr(buffer_out, buffer_size, &buf);
1756
1757 error = 0;
1758
1759 cleanup:
1760 git_buf_free(&buf);
1761 return error;
1762 }
1763
1764 int git_reference__normalize_name_lax(
1765 char *buffer_out,
1766 size_t out_size,
1767 const char *name)
1768 {
1769 return git_reference_normalize_name(
1770 buffer_out,
1771 out_size,
1772 name,
1773 GIT_REF_FORMAT_ALLOW_ONELEVEL);
1774 }
1775 #define GIT_REF_TYPEMASK (GIT_REF_OID | GIT_REF_SYMBOLIC)
1776
1777 int git_reference_cmp(git_reference *ref1, git_reference *ref2)
1778 {
1779 assert(ref1 && ref2);
1780
1781 /* let's put symbolic refs before OIDs */
1782 if ((ref1->flags & GIT_REF_TYPEMASK) != (ref2->flags & GIT_REF_TYPEMASK))
1783 return (ref1->flags & GIT_REF_SYMBOLIC) ? -1 : 1;
1784
1785 if (ref1->flags & GIT_REF_SYMBOLIC)
1786 return strcmp(ref1->target.symbolic, ref2->target.symbolic);
1787
1788 return git_oid_cmp(&ref1->target.oid, &ref2->target.oid);
1789 }
1790
1791 /* Update the reference named `ref_name` so it points to `oid` */
1792 int git_reference__update(git_repository *repo, const git_oid *oid, const char *ref_name)
1793 {
1794 git_reference *ref;
1795 int res;
1796
1797 res = git_reference_lookup(&ref, repo, ref_name);
1798
1799 /* If we haven't found the reference at all, we assume we need to create
1800 * a new reference and that's it */
1801 if (res == GIT_ENOTFOUND) {
1802 giterr_clear();
1803 return git_reference_create(NULL, repo, ref_name, oid, 1);
1804 }
1805
1806 if (res < 0)
1807 return -1;
1808
1809 /* If we have found a reference, but it's symbolic, we need to update
1810 * the direct reference it points to */
1811 if (git_reference_type(ref) == GIT_REF_SYMBOLIC) {
1812 git_reference *aux;
1813 const char *sym_target;
1814
1815 /* The target pointed at by this reference */
1816 sym_target = git_reference_symbolic_target(ref);
1817
1818 /* resolve the reference to the target it points to */
1819 res = git_reference_resolve(&aux, ref);
1820
1821 /*
1822 * if the symbolic reference pointed to an inexisting ref,
1823 * this is means we're creating a new branch, for example.
1824 * We need to create a new direct reference with that name
1825 */
1826 if (res == GIT_ENOTFOUND) {
1827 giterr_clear();
1828 res = git_reference_create(NULL, repo, sym_target, oid, 1);
1829 git_reference_free(ref);
1830 return res;
1831 }
1832
1833 /* free the original symbolic reference now; not before because
1834 * we're using the `sym_target` pointer */
1835 git_reference_free(ref);
1836
1837 if (res < 0)
1838 return -1;
1839
1840 /* store the newly found direct reference in its place */
1841 ref = aux;
1842 }
1843
1844 /* ref is made to point to `oid`: ref is either the original reference,
1845 * or the target of the symbolic reference we've looked up */
1846 res = git_reference_set_target(ref, oid);
1847 git_reference_free(ref);
1848 return res;
1849 }
1850
1851 struct glob_cb_data {
1852 const char *glob;
1853 int (*callback)(const char *, void *);
1854 void *payload;
1855 };
1856
1857 static int fromglob_cb(const char *reference_name, void *payload)
1858 {
1859 struct glob_cb_data *data = (struct glob_cb_data *)payload;
1860
1861 if (!p_fnmatch(data->glob, reference_name, 0))
1862 return data->callback(reference_name, data->payload);
1863
1864 return 0;
1865 }
1866
1867 int git_reference_foreach_glob(
1868 git_repository *repo,
1869 const char *glob,
1870 unsigned int list_flags,
1871 int (*callback)(
1872 const char *reference_name,
1873 void *payload),
1874 void *payload)
1875 {
1876 struct glob_cb_data data;
1877
1878 assert(repo && glob && callback);
1879
1880 data.glob = glob;
1881 data.callback = callback;
1882 data.payload = payload;
1883
1884 return git_reference_foreach(
1885 repo, list_flags, fromglob_cb, &data);
1886 }
1887
1888 int git_reference_has_log(
1889 git_reference *ref)
1890 {
1891 git_buf path = GIT_BUF_INIT;
1892 int result;
1893
1894 assert(ref);
1895
1896 if (git_buf_join_n(&path, '/', 3, ref->owner->path_repository, GIT_REFLOG_DIR, ref->name) < 0)
1897 return -1;
1898
1899 result = git_path_isfile(git_buf_cstr(&path));
1900 git_buf_free(&path);
1901
1902 return result;
1903 }
1904
1905 int git_reference_is_branch(git_reference *ref)
1906 {
1907 assert(ref);
1908 return git__prefixcmp(ref->name, GIT_REFS_HEADS_DIR) == 0;
1909 }
1910
1911 int git_reference_is_remote(git_reference *ref)
1912 {
1913 assert(ref);
1914 return git__prefixcmp(ref->name, GIT_REFS_REMOTES_DIR) == 0;
1915 }
1916
1917 static int peel_error(int error, git_reference *ref, const char* msg)
1918 {
1919 giterr_set(
1920 GITERR_INVALID,
1921 "The reference '%s' cannot be peeled - %s", git_reference_name(ref), msg);
1922 return error;
1923 }
1924
1925 static int reference_target(git_object **object, git_reference *ref)
1926 {
1927 const git_oid *oid;
1928
1929 oid = git_reference_target(ref);
1930
1931 return git_object_lookup(object, git_reference_owner(ref), oid, GIT_OBJ_ANY);
1932 }
1933
1934 int git_reference_peel(
1935 git_object **peeled,
1936 git_reference *ref,
1937 git_otype target_type)
1938 {
1939 git_reference *resolved = NULL;
1940 git_object *target = NULL;
1941 int error;
1942
1943 assert(ref);
1944
1945 if ((error = git_reference_resolve(&resolved, ref)) < 0)
1946 return peel_error(error, ref, "Cannot resolve reference");
1947
1948 if ((error = reference_target(&target, resolved)) < 0) {
1949 peel_error(error, ref, "Cannot retrieve reference target");
1950 goto cleanup;
1951 }
1952
1953 if (target_type == GIT_OBJ_ANY && git_object_type(target) != GIT_OBJ_TAG)
1954 error = git_object__dup(peeled, target);
1955 else
1956 error = git_object_peel(peeled, target, target_type);
1957
1958 cleanup:
1959 git_object_free(target);
1960 git_reference_free(resolved);
1961 return error;
1962 }
1963
1964 int git_reference__is_valid_name(
1965 const char *refname,
1966 unsigned int flags)
1967 {
1968 int error;
1969
1970 error = git_reference__normalize_name(NULL, refname, flags) == 0;
1971 giterr_clear();
1972
1973 return error;
1974 }
1975
1976 int git_reference_is_valid_name(
1977 const char *refname)
1978 {
1979 return git_reference__is_valid_name(
1980 refname,
1981 GIT_REF_FORMAT_ALLOW_ONELEVEL);
1982 }