submodule--helper: add push-check subcommand
[git/git-svn.git] / refs.c
blob0272e332cc9951497dddcd8b5c57a30e80552b4f
1 /*
2 * The backend-independent part of the reference module.
3 */
5 #include "cache.h"
6 #include "hashmap.h"
7 #include "lockfile.h"
8 #include "refs.h"
9 #include "refs/refs-internal.h"
10 #include "object.h"
11 #include "tag.h"
14 * List of all available backends
16 static struct ref_storage_be *refs_backends = &refs_be_files;
18 static struct ref_storage_be *find_ref_storage_backend(const char *name)
20 struct ref_storage_be *be;
21 for (be = refs_backends; be; be = be->next)
22 if (!strcmp(be->name, name))
23 return be;
24 return NULL;
27 int ref_storage_backend_exists(const char *name)
29 return find_ref_storage_backend(name) != NULL;
33 * How to handle various characters in refnames:
34 * 0: An acceptable character for refs
35 * 1: End-of-component
36 * 2: ., look for a preceding . to reject .. in refs
37 * 3: {, look for a preceding @ to reject @{ in refs
38 * 4: A bad character: ASCII control characters, and
39 * ":", "?", "[", "\", "^", "~", SP, or TAB
40 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
42 static unsigned char refname_disposition[256] = {
43 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
44 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
45 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
46 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
47 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
48 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
49 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
50 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
54 * Try to read one refname component from the front of refname.
55 * Return the length of the component found, or -1 if the component is
56 * not legal. It is legal if it is something reasonable to have under
57 * ".git/refs/"; We do not like it if:
59 * - any path component of it begins with ".", or
60 * - it has double dots "..", or
61 * - it has ASCII control characters, or
62 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
63 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
64 * - it ends with a "/", or
65 * - it ends with ".lock", or
66 * - it contains a "@{" portion
68 static int check_refname_component(const char *refname, int *flags)
70 const char *cp;
71 char last = '\0';
73 for (cp = refname; ; cp++) {
74 int ch = *cp & 255;
75 unsigned char disp = refname_disposition[ch];
76 switch (disp) {
77 case 1:
78 goto out;
79 case 2:
80 if (last == '.')
81 return -1; /* Refname contains "..". */
82 break;
83 case 3:
84 if (last == '@')
85 return -1; /* Refname contains "@{". */
86 break;
87 case 4:
88 return -1;
89 case 5:
90 if (!(*flags & REFNAME_REFSPEC_PATTERN))
91 return -1; /* refspec can't be a pattern */
94 * Unset the pattern flag so that we only accept
95 * a single asterisk for one side of refspec.
97 *flags &= ~ REFNAME_REFSPEC_PATTERN;
98 break;
100 last = ch;
102 out:
103 if (cp == refname)
104 return 0; /* Component has zero length. */
105 if (refname[0] == '.')
106 return -1; /* Component starts with '.'. */
107 if (cp - refname >= LOCK_SUFFIX_LEN &&
108 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
109 return -1; /* Refname ends with ".lock". */
110 return cp - refname;
113 int check_refname_format(const char *refname, int flags)
115 int component_len, component_count = 0;
117 if (!strcmp(refname, "@"))
118 /* Refname is a single character '@'. */
119 return -1;
121 while (1) {
122 /* We are at the start of a path component. */
123 component_len = check_refname_component(refname, &flags);
124 if (component_len <= 0)
125 return -1;
127 component_count++;
128 if (refname[component_len] == '\0')
129 break;
130 /* Skip to next component. */
131 refname += component_len + 1;
134 if (refname[component_len - 1] == '.')
135 return -1; /* Refname ends with '.'. */
136 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
137 return -1; /* Refname has only one component. */
138 return 0;
141 int refname_is_safe(const char *refname)
143 const char *rest;
145 if (skip_prefix(refname, "refs/", &rest)) {
146 char *buf;
147 int result;
148 size_t restlen = strlen(rest);
150 /* rest must not be empty, or start or end with "/" */
151 if (!restlen || *rest == '/' || rest[restlen - 1] == '/')
152 return 0;
155 * Does the refname try to escape refs/?
156 * For example: refs/foo/../bar is safe but refs/foo/../../bar
157 * is not.
159 buf = xmallocz(restlen);
160 result = !normalize_path_copy(buf, rest) && !strcmp(buf, rest);
161 free(buf);
162 return result;
165 do {
166 if (!isupper(*refname) && *refname != '_')
167 return 0;
168 refname++;
169 } while (*refname);
170 return 1;
173 char *resolve_refdup(const char *refname, int resolve_flags,
174 unsigned char *sha1, int *flags)
176 return xstrdup_or_null(resolve_ref_unsafe(refname, resolve_flags,
177 sha1, flags));
180 /* The argument to filter_refs */
181 struct ref_filter {
182 const char *pattern;
183 each_ref_fn *fn;
184 void *cb_data;
187 int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
189 if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
190 return 0;
191 return -1;
194 int read_ref(const char *refname, unsigned char *sha1)
196 return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
199 int ref_exists(const char *refname)
201 unsigned char sha1[20];
202 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
205 static int filter_refs(const char *refname, const struct object_id *oid,
206 int flags, void *data)
208 struct ref_filter *filter = (struct ref_filter *)data;
210 if (wildmatch(filter->pattern, refname, 0, NULL))
211 return 0;
212 return filter->fn(refname, oid, flags, filter->cb_data);
215 enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
217 struct object *o = lookup_unknown_object(name);
219 if (o->type == OBJ_NONE) {
220 int type = sha1_object_info(name, NULL);
221 if (type < 0 || !object_as_type(o, type, 0))
222 return PEEL_INVALID;
225 if (o->type != OBJ_TAG)
226 return PEEL_NON_TAG;
228 o = deref_tag_noverify(o);
229 if (!o)
230 return PEEL_INVALID;
232 hashcpy(sha1, o->oid.hash);
233 return PEEL_PEELED;
236 struct warn_if_dangling_data {
237 FILE *fp;
238 const char *refname;
239 const struct string_list *refnames;
240 const char *msg_fmt;
243 static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
244 int flags, void *cb_data)
246 struct warn_if_dangling_data *d = cb_data;
247 const char *resolves_to;
248 struct object_id junk;
250 if (!(flags & REF_ISSYMREF))
251 return 0;
253 resolves_to = resolve_ref_unsafe(refname, 0, junk.hash, NULL);
254 if (!resolves_to
255 || (d->refname
256 ? strcmp(resolves_to, d->refname)
257 : !string_list_has_string(d->refnames, resolves_to))) {
258 return 0;
261 fprintf(d->fp, d->msg_fmt, refname);
262 fputc('\n', d->fp);
263 return 0;
266 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
268 struct warn_if_dangling_data data;
270 data.fp = fp;
271 data.refname = refname;
272 data.refnames = NULL;
273 data.msg_fmt = msg_fmt;
274 for_each_rawref(warn_if_dangling_symref, &data);
277 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
279 struct warn_if_dangling_data data;
281 data.fp = fp;
282 data.refname = NULL;
283 data.refnames = refnames;
284 data.msg_fmt = msg_fmt;
285 for_each_rawref(warn_if_dangling_symref, &data);
288 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
290 return for_each_ref_in("refs/tags/", fn, cb_data);
293 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
295 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
298 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
300 return for_each_ref_in("refs/heads/", fn, cb_data);
303 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
305 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
308 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
310 return for_each_ref_in("refs/remotes/", fn, cb_data);
313 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
315 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
318 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
320 struct strbuf buf = STRBUF_INIT;
321 int ret = 0;
322 struct object_id oid;
323 int flag;
325 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
326 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, oid.hash, &flag))
327 ret = fn(buf.buf, &oid, flag, cb_data);
328 strbuf_release(&buf);
330 return ret;
333 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
334 const char *prefix, void *cb_data)
336 struct strbuf real_pattern = STRBUF_INIT;
337 struct ref_filter filter;
338 int ret;
340 if (!prefix && !starts_with(pattern, "refs/"))
341 strbuf_addstr(&real_pattern, "refs/");
342 else if (prefix)
343 strbuf_addstr(&real_pattern, prefix);
344 strbuf_addstr(&real_pattern, pattern);
346 if (!has_glob_specials(pattern)) {
347 /* Append implied '/' '*' if not present. */
348 strbuf_complete(&real_pattern, '/');
349 /* No need to check for '*', there is none. */
350 strbuf_addch(&real_pattern, '*');
353 filter.pattern = real_pattern.buf;
354 filter.fn = fn;
355 filter.cb_data = cb_data;
356 ret = for_each_ref(filter_refs, &filter);
358 strbuf_release(&real_pattern);
359 return ret;
362 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
364 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
367 const char *prettify_refname(const char *name)
369 if (skip_prefix(name, "refs/heads/", &name) ||
370 skip_prefix(name, "refs/tags/", &name) ||
371 skip_prefix(name, "refs/remotes/", &name))
372 ; /* nothing */
373 return name;
376 static const char *ref_rev_parse_rules[] = {
377 "%.*s",
378 "refs/%.*s",
379 "refs/tags/%.*s",
380 "refs/heads/%.*s",
381 "refs/remotes/%.*s",
382 "refs/remotes/%.*s/HEAD",
383 NULL
386 int refname_match(const char *abbrev_name, const char *full_name)
388 const char **p;
389 const int abbrev_name_len = strlen(abbrev_name);
391 for (p = ref_rev_parse_rules; *p; p++) {
392 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
393 return 1;
397 return 0;
401 * *string and *len will only be substituted, and *string returned (for
402 * later free()ing) if the string passed in is a magic short-hand form
403 * to name a branch.
405 static char *substitute_branch_name(const char **string, int *len)
407 struct strbuf buf = STRBUF_INIT;
408 int ret = interpret_branch_name(*string, *len, &buf, 0);
410 if (ret == *len) {
411 size_t size;
412 *string = strbuf_detach(&buf, &size);
413 *len = size;
414 return (char *)*string;
417 return NULL;
420 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
422 char *last_branch = substitute_branch_name(&str, &len);
423 int refs_found = expand_ref(str, len, sha1, ref);
424 free(last_branch);
425 return refs_found;
428 int expand_ref(const char *str, int len, unsigned char *sha1, char **ref)
430 const char **p, *r;
431 int refs_found = 0;
433 *ref = NULL;
434 for (p = ref_rev_parse_rules; *p; p++) {
435 char fullref[PATH_MAX];
436 unsigned char sha1_from_ref[20];
437 unsigned char *this_result;
438 int flag;
440 this_result = refs_found ? sha1_from_ref : sha1;
441 mksnpath(fullref, sizeof(fullref), *p, len, str);
442 r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
443 this_result, &flag);
444 if (r) {
445 if (!refs_found++)
446 *ref = xstrdup(r);
447 if (!warn_ambiguous_refs)
448 break;
449 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
450 warning("ignoring dangling symref %s.", fullref);
451 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
452 warning("ignoring broken ref %s.", fullref);
455 return refs_found;
458 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
460 char *last_branch = substitute_branch_name(&str, &len);
461 const char **p;
462 int logs_found = 0;
464 *log = NULL;
465 for (p = ref_rev_parse_rules; *p; p++) {
466 unsigned char hash[20];
467 char path[PATH_MAX];
468 const char *ref, *it;
470 mksnpath(path, sizeof(path), *p, len, str);
471 ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
472 hash, NULL);
473 if (!ref)
474 continue;
475 if (reflog_exists(path))
476 it = path;
477 else if (strcmp(ref, path) && reflog_exists(ref))
478 it = ref;
479 else
480 continue;
481 if (!logs_found++) {
482 *log = xstrdup(it);
483 hashcpy(sha1, hash);
485 if (!warn_ambiguous_refs)
486 break;
488 free(last_branch);
489 return logs_found;
492 static int is_per_worktree_ref(const char *refname)
494 return !strcmp(refname, "HEAD") ||
495 starts_with(refname, "refs/bisect/");
498 static int is_pseudoref_syntax(const char *refname)
500 const char *c;
502 for (c = refname; *c; c++) {
503 if (!isupper(*c) && *c != '-' && *c != '_')
504 return 0;
507 return 1;
510 enum ref_type ref_type(const char *refname)
512 if (is_per_worktree_ref(refname))
513 return REF_TYPE_PER_WORKTREE;
514 if (is_pseudoref_syntax(refname))
515 return REF_TYPE_PSEUDOREF;
516 return REF_TYPE_NORMAL;
519 static int write_pseudoref(const char *pseudoref, const unsigned char *sha1,
520 const unsigned char *old_sha1, struct strbuf *err)
522 const char *filename;
523 int fd;
524 static struct lock_file lock;
525 struct strbuf buf = STRBUF_INIT;
526 int ret = -1;
528 strbuf_addf(&buf, "%s\n", sha1_to_hex(sha1));
530 filename = git_path("%s", pseudoref);
531 fd = hold_lock_file_for_update(&lock, filename, LOCK_DIE_ON_ERROR);
532 if (fd < 0) {
533 strbuf_addf(err, "could not open '%s' for writing: %s",
534 filename, strerror(errno));
535 return -1;
538 if (old_sha1) {
539 unsigned char actual_old_sha1[20];
541 if (read_ref(pseudoref, actual_old_sha1))
542 die("could not read ref '%s'", pseudoref);
543 if (hashcmp(actual_old_sha1, old_sha1)) {
544 strbuf_addf(err, "unexpected sha1 when writing '%s'", pseudoref);
545 rollback_lock_file(&lock);
546 goto done;
550 if (write_in_full(fd, buf.buf, buf.len) != buf.len) {
551 strbuf_addf(err, "could not write to '%s'", filename);
552 rollback_lock_file(&lock);
553 goto done;
556 commit_lock_file(&lock);
557 ret = 0;
558 done:
559 strbuf_release(&buf);
560 return ret;
563 static int delete_pseudoref(const char *pseudoref, const unsigned char *old_sha1)
565 static struct lock_file lock;
566 const char *filename;
568 filename = git_path("%s", pseudoref);
570 if (old_sha1 && !is_null_sha1(old_sha1)) {
571 int fd;
572 unsigned char actual_old_sha1[20];
574 fd = hold_lock_file_for_update(&lock, filename,
575 LOCK_DIE_ON_ERROR);
576 if (fd < 0)
577 die_errno(_("Could not open '%s' for writing"), filename);
578 if (read_ref(pseudoref, actual_old_sha1))
579 die("could not read ref '%s'", pseudoref);
580 if (hashcmp(actual_old_sha1, old_sha1)) {
581 warning("Unexpected sha1 when deleting %s", pseudoref);
582 rollback_lock_file(&lock);
583 return -1;
586 unlink(filename);
587 rollback_lock_file(&lock);
588 } else {
589 unlink(filename);
592 return 0;
595 int delete_ref(const char *msg, const char *refname,
596 const unsigned char *old_sha1, unsigned int flags)
598 struct ref_transaction *transaction;
599 struct strbuf err = STRBUF_INIT;
601 if (ref_type(refname) == REF_TYPE_PSEUDOREF)
602 return delete_pseudoref(refname, old_sha1);
604 transaction = ref_transaction_begin(&err);
605 if (!transaction ||
606 ref_transaction_delete(transaction, refname, old_sha1,
607 flags, msg, &err) ||
608 ref_transaction_commit(transaction, &err)) {
609 error("%s", err.buf);
610 ref_transaction_free(transaction);
611 strbuf_release(&err);
612 return 1;
614 ref_transaction_free(transaction);
615 strbuf_release(&err);
616 return 0;
619 int copy_reflog_msg(char *buf, const char *msg)
621 char *cp = buf;
622 char c;
623 int wasspace = 1;
625 *cp++ = '\t';
626 while ((c = *msg++)) {
627 if (wasspace && isspace(c))
628 continue;
629 wasspace = isspace(c);
630 if (wasspace)
631 c = ' ';
632 *cp++ = c;
634 while (buf < cp && isspace(cp[-1]))
635 cp--;
636 *cp++ = '\n';
637 return cp - buf;
640 int should_autocreate_reflog(const char *refname)
642 switch (log_all_ref_updates) {
643 case LOG_REFS_ALWAYS:
644 return 1;
645 case LOG_REFS_NORMAL:
646 return starts_with(refname, "refs/heads/") ||
647 starts_with(refname, "refs/remotes/") ||
648 starts_with(refname, "refs/notes/") ||
649 !strcmp(refname, "HEAD");
650 default:
651 return 0;
655 int is_branch(const char *refname)
657 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
660 struct read_ref_at_cb {
661 const char *refname;
662 unsigned long at_time;
663 int cnt;
664 int reccnt;
665 unsigned char *sha1;
666 int found_it;
668 unsigned char osha1[20];
669 unsigned char nsha1[20];
670 int tz;
671 unsigned long date;
672 char **msg;
673 unsigned long *cutoff_time;
674 int *cutoff_tz;
675 int *cutoff_cnt;
678 static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
679 const char *email, unsigned long timestamp, int tz,
680 const char *message, void *cb_data)
682 struct read_ref_at_cb *cb = cb_data;
684 cb->reccnt++;
685 cb->tz = tz;
686 cb->date = timestamp;
688 if (timestamp <= cb->at_time || cb->cnt == 0) {
689 if (cb->msg)
690 *cb->msg = xstrdup(message);
691 if (cb->cutoff_time)
692 *cb->cutoff_time = timestamp;
693 if (cb->cutoff_tz)
694 *cb->cutoff_tz = tz;
695 if (cb->cutoff_cnt)
696 *cb->cutoff_cnt = cb->reccnt - 1;
698 * we have not yet updated cb->[n|o]sha1 so they still
699 * hold the values for the previous record.
701 if (!is_null_sha1(cb->osha1)) {
702 hashcpy(cb->sha1, noid->hash);
703 if (hashcmp(cb->osha1, noid->hash))
704 warning("Log for ref %s has gap after %s.",
705 cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
707 else if (cb->date == cb->at_time)
708 hashcpy(cb->sha1, noid->hash);
709 else if (hashcmp(noid->hash, cb->sha1))
710 warning("Log for ref %s unexpectedly ended on %s.",
711 cb->refname, show_date(cb->date, cb->tz,
712 DATE_MODE(RFC2822)));
713 hashcpy(cb->osha1, ooid->hash);
714 hashcpy(cb->nsha1, noid->hash);
715 cb->found_it = 1;
716 return 1;
718 hashcpy(cb->osha1, ooid->hash);
719 hashcpy(cb->nsha1, noid->hash);
720 if (cb->cnt > 0)
721 cb->cnt--;
722 return 0;
725 static int read_ref_at_ent_oldest(struct object_id *ooid, struct object_id *noid,
726 const char *email, unsigned long timestamp,
727 int tz, const char *message, void *cb_data)
729 struct read_ref_at_cb *cb = cb_data;
731 if (cb->msg)
732 *cb->msg = xstrdup(message);
733 if (cb->cutoff_time)
734 *cb->cutoff_time = timestamp;
735 if (cb->cutoff_tz)
736 *cb->cutoff_tz = tz;
737 if (cb->cutoff_cnt)
738 *cb->cutoff_cnt = cb->reccnt;
739 hashcpy(cb->sha1, ooid->hash);
740 if (is_null_sha1(cb->sha1))
741 hashcpy(cb->sha1, noid->hash);
742 /* We just want the first entry */
743 return 1;
746 int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
747 unsigned char *sha1, char **msg,
748 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
750 struct read_ref_at_cb cb;
752 memset(&cb, 0, sizeof(cb));
753 cb.refname = refname;
754 cb.at_time = at_time;
755 cb.cnt = cnt;
756 cb.msg = msg;
757 cb.cutoff_time = cutoff_time;
758 cb.cutoff_tz = cutoff_tz;
759 cb.cutoff_cnt = cutoff_cnt;
760 cb.sha1 = sha1;
762 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
764 if (!cb.reccnt) {
765 if (flags & GET_SHA1_QUIETLY)
766 exit(128);
767 else
768 die("Log for %s is empty.", refname);
770 if (cb.found_it)
771 return 0;
773 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
775 return 1;
778 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
780 assert(err);
782 return xcalloc(1, sizeof(struct ref_transaction));
785 void ref_transaction_free(struct ref_transaction *transaction)
787 int i;
789 if (!transaction)
790 return;
792 for (i = 0; i < transaction->nr; i++) {
793 free(transaction->updates[i]->msg);
794 free(transaction->updates[i]);
796 free(transaction->updates);
797 free(transaction);
800 struct ref_update *ref_transaction_add_update(
801 struct ref_transaction *transaction,
802 const char *refname, unsigned int flags,
803 const unsigned char *new_sha1,
804 const unsigned char *old_sha1,
805 const char *msg)
807 struct ref_update *update;
809 if (transaction->state != REF_TRANSACTION_OPEN)
810 die("BUG: update called for transaction that is not open");
812 if ((flags & REF_ISPRUNING) && !(flags & REF_NODEREF))
813 die("BUG: REF_ISPRUNING set without REF_NODEREF");
815 FLEX_ALLOC_STR(update, refname, refname);
816 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
817 transaction->updates[transaction->nr++] = update;
819 update->flags = flags;
821 if (flags & REF_HAVE_NEW)
822 hashcpy(update->new_sha1, new_sha1);
823 if (flags & REF_HAVE_OLD)
824 hashcpy(update->old_sha1, old_sha1);
825 update->msg = xstrdup_or_null(msg);
826 return update;
829 int ref_transaction_update(struct ref_transaction *transaction,
830 const char *refname,
831 const unsigned char *new_sha1,
832 const unsigned char *old_sha1,
833 unsigned int flags, const char *msg,
834 struct strbuf *err)
836 assert(err);
838 if ((new_sha1 && !is_null_sha1(new_sha1)) ?
839 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL) :
840 !refname_is_safe(refname)) {
841 strbuf_addf(err, "refusing to update ref with bad name '%s'",
842 refname);
843 return -1;
846 flags |= (new_sha1 ? REF_HAVE_NEW : 0) | (old_sha1 ? REF_HAVE_OLD : 0);
848 ref_transaction_add_update(transaction, refname, flags,
849 new_sha1, old_sha1, msg);
850 return 0;
853 int ref_transaction_create(struct ref_transaction *transaction,
854 const char *refname,
855 const unsigned char *new_sha1,
856 unsigned int flags, const char *msg,
857 struct strbuf *err)
859 if (!new_sha1 || is_null_sha1(new_sha1))
860 die("BUG: create called without valid new_sha1");
861 return ref_transaction_update(transaction, refname, new_sha1,
862 null_sha1, flags, msg, err);
865 int ref_transaction_delete(struct ref_transaction *transaction,
866 const char *refname,
867 const unsigned char *old_sha1,
868 unsigned int flags, const char *msg,
869 struct strbuf *err)
871 if (old_sha1 && is_null_sha1(old_sha1))
872 die("BUG: delete called with old_sha1 set to zeros");
873 return ref_transaction_update(transaction, refname,
874 null_sha1, old_sha1,
875 flags, msg, err);
878 int ref_transaction_verify(struct ref_transaction *transaction,
879 const char *refname,
880 const unsigned char *old_sha1,
881 unsigned int flags,
882 struct strbuf *err)
884 if (!old_sha1)
885 die("BUG: verify called with old_sha1 set to NULL");
886 return ref_transaction_update(transaction, refname,
887 NULL, old_sha1,
888 flags, NULL, err);
891 int update_ref_oid(const char *msg, const char *refname,
892 const struct object_id *new_oid, const struct object_id *old_oid,
893 unsigned int flags, enum action_on_err onerr)
895 return update_ref(msg, refname, new_oid ? new_oid->hash : NULL,
896 old_oid ? old_oid->hash : NULL, flags, onerr);
899 int update_ref(const char *msg, const char *refname,
900 const unsigned char *new_sha1, const unsigned char *old_sha1,
901 unsigned int flags, enum action_on_err onerr)
903 struct ref_transaction *t = NULL;
904 struct strbuf err = STRBUF_INIT;
905 int ret = 0;
907 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
908 ret = write_pseudoref(refname, new_sha1, old_sha1, &err);
909 } else {
910 t = ref_transaction_begin(&err);
911 if (!t ||
912 ref_transaction_update(t, refname, new_sha1, old_sha1,
913 flags, msg, &err) ||
914 ref_transaction_commit(t, &err)) {
915 ret = 1;
916 ref_transaction_free(t);
919 if (ret) {
920 const char *str = "update_ref failed for ref '%s': %s";
922 switch (onerr) {
923 case UPDATE_REFS_MSG_ON_ERR:
924 error(str, refname, err.buf);
925 break;
926 case UPDATE_REFS_DIE_ON_ERR:
927 die(str, refname, err.buf);
928 break;
929 case UPDATE_REFS_QUIET_ON_ERR:
930 break;
932 strbuf_release(&err);
933 return 1;
935 strbuf_release(&err);
936 if (t)
937 ref_transaction_free(t);
938 return 0;
941 char *shorten_unambiguous_ref(const char *refname, int strict)
943 int i;
944 static char **scanf_fmts;
945 static int nr_rules;
946 char *short_name;
948 if (!nr_rules) {
950 * Pre-generate scanf formats from ref_rev_parse_rules[].
951 * Generate a format suitable for scanf from a
952 * ref_rev_parse_rules rule by interpolating "%s" at the
953 * location of the "%.*s".
955 size_t total_len = 0;
956 size_t offset = 0;
958 /* the rule list is NULL terminated, count them first */
959 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
960 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
961 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
963 scanf_fmts = xmalloc(st_add(st_mult(sizeof(char *), nr_rules), total_len));
965 offset = 0;
966 for (i = 0; i < nr_rules; i++) {
967 assert(offset < total_len);
968 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
969 offset += snprintf(scanf_fmts[i], total_len - offset,
970 ref_rev_parse_rules[i], 2, "%s") + 1;
974 /* bail out if there are no rules */
975 if (!nr_rules)
976 return xstrdup(refname);
978 /* buffer for scanf result, at most refname must fit */
979 short_name = xstrdup(refname);
981 /* skip first rule, it will always match */
982 for (i = nr_rules - 1; i > 0 ; --i) {
983 int j;
984 int rules_to_fail = i;
985 int short_name_len;
987 if (1 != sscanf(refname, scanf_fmts[i], short_name))
988 continue;
990 short_name_len = strlen(short_name);
993 * in strict mode, all (except the matched one) rules
994 * must fail to resolve to a valid non-ambiguous ref
996 if (strict)
997 rules_to_fail = nr_rules;
1000 * check if the short name resolves to a valid ref,
1001 * but use only rules prior to the matched one
1003 for (j = 0; j < rules_to_fail; j++) {
1004 const char *rule = ref_rev_parse_rules[j];
1005 char refname[PATH_MAX];
1007 /* skip matched rule */
1008 if (i == j)
1009 continue;
1012 * the short name is ambiguous, if it resolves
1013 * (with this previous rule) to a valid ref
1014 * read_ref() returns 0 on success
1016 mksnpath(refname, sizeof(refname),
1017 rule, short_name_len, short_name);
1018 if (ref_exists(refname))
1019 break;
1023 * short name is non-ambiguous if all previous rules
1024 * haven't resolved to a valid ref
1026 if (j == rules_to_fail)
1027 return short_name;
1030 free(short_name);
1031 return xstrdup(refname);
1034 static struct string_list *hide_refs;
1036 int parse_hide_refs_config(const char *var, const char *value, const char *section)
1038 const char *key;
1039 if (!strcmp("transfer.hiderefs", var) ||
1040 (!parse_config_key(var, section, NULL, NULL, &key) &&
1041 !strcmp(key, "hiderefs"))) {
1042 char *ref;
1043 int len;
1045 if (!value)
1046 return config_error_nonbool(var);
1047 ref = xstrdup(value);
1048 len = strlen(ref);
1049 while (len && ref[len - 1] == '/')
1050 ref[--len] = '\0';
1051 if (!hide_refs) {
1052 hide_refs = xcalloc(1, sizeof(*hide_refs));
1053 hide_refs->strdup_strings = 1;
1055 string_list_append(hide_refs, ref);
1057 return 0;
1060 int ref_is_hidden(const char *refname, const char *refname_full)
1062 int i;
1064 if (!hide_refs)
1065 return 0;
1066 for (i = hide_refs->nr - 1; i >= 0; i--) {
1067 const char *match = hide_refs->items[i].string;
1068 const char *subject;
1069 int neg = 0;
1070 int len;
1072 if (*match == '!') {
1073 neg = 1;
1074 match++;
1077 if (*match == '^') {
1078 subject = refname_full;
1079 match++;
1080 } else {
1081 subject = refname;
1084 /* refname can be NULL when namespaces are used. */
1085 if (!subject || !starts_with(subject, match))
1086 continue;
1087 len = strlen(match);
1088 if (!subject[len] || subject[len] == '/')
1089 return !neg;
1091 return 0;
1094 const char *find_descendant_ref(const char *dirname,
1095 const struct string_list *extras,
1096 const struct string_list *skip)
1098 int pos;
1100 if (!extras)
1101 return NULL;
1104 * Look at the place where dirname would be inserted into
1105 * extras. If there is an entry at that position that starts
1106 * with dirname (remember, dirname includes the trailing
1107 * slash) and is not in skip, then we have a conflict.
1109 for (pos = string_list_find_insert_index(extras, dirname, 0);
1110 pos < extras->nr; pos++) {
1111 const char *extra_refname = extras->items[pos].string;
1113 if (!starts_with(extra_refname, dirname))
1114 break;
1116 if (!skip || !string_list_has_string(skip, extra_refname))
1117 return extra_refname;
1119 return NULL;
1122 int rename_ref_available(const char *old_refname, const char *new_refname)
1124 struct string_list skip = STRING_LIST_INIT_NODUP;
1125 struct strbuf err = STRBUF_INIT;
1126 int ok;
1128 string_list_insert(&skip, old_refname);
1129 ok = !verify_refname_available(new_refname, NULL, &skip, &err);
1130 if (!ok)
1131 error("%s", err.buf);
1133 string_list_clear(&skip, 0);
1134 strbuf_release(&err);
1135 return ok;
1138 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1140 struct object_id oid;
1141 int flag;
1143 if (submodule) {
1144 if (resolve_gitlink_ref(submodule, "HEAD", oid.hash) == 0)
1145 return fn("HEAD", &oid, 0, cb_data);
1147 return 0;
1150 if (!read_ref_full("HEAD", RESOLVE_REF_READING, oid.hash, &flag))
1151 return fn("HEAD", &oid, flag, cb_data);
1153 return 0;
1156 int head_ref(each_ref_fn fn, void *cb_data)
1158 return head_ref_submodule(NULL, fn, cb_data);
1162 * Call fn for each reference in the specified submodule for which the
1163 * refname begins with prefix. If trim is non-zero, then trim that
1164 * many characters off the beginning of each refname before passing
1165 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1166 * include broken references in the iteration. If fn ever returns a
1167 * non-zero value, stop the iteration and return that value;
1168 * otherwise, return 0.
1170 static int do_for_each_ref(const char *submodule, const char *prefix,
1171 each_ref_fn fn, int trim, int flags, void *cb_data)
1173 struct ref_store *refs = get_ref_store(submodule);
1174 struct ref_iterator *iter;
1176 if (!refs)
1177 return 0;
1179 iter = refs->be->iterator_begin(refs, prefix, flags);
1180 iter = prefix_ref_iterator_begin(iter, prefix, trim);
1182 return do_for_each_ref_iterator(iter, fn, cb_data);
1185 int for_each_ref(each_ref_fn fn, void *cb_data)
1187 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1190 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1192 return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1195 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1197 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1200 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken)
1202 unsigned int flag = 0;
1204 if (broken)
1205 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1206 return do_for_each_ref(NULL, prefix, fn, 0, flag, cb_data);
1209 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1210 each_ref_fn fn, void *cb_data)
1212 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1215 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1217 return do_for_each_ref(NULL, git_replace_ref_base, fn,
1218 strlen(git_replace_ref_base), 0, cb_data);
1221 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1223 struct strbuf buf = STRBUF_INIT;
1224 int ret;
1225 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1226 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
1227 strbuf_release(&buf);
1228 return ret;
1231 int for_each_rawref(each_ref_fn fn, void *cb_data)
1233 return do_for_each_ref(NULL, "", fn, 0,
1234 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1237 /* This function needs to return a meaningful errno on failure */
1238 const char *resolve_ref_recursively(struct ref_store *refs,
1239 const char *refname,
1240 int resolve_flags,
1241 unsigned char *sha1, int *flags)
1243 static struct strbuf sb_refname = STRBUF_INIT;
1244 int unused_flags;
1245 int symref_count;
1247 if (!flags)
1248 flags = &unused_flags;
1250 *flags = 0;
1252 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1253 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1254 !refname_is_safe(refname)) {
1255 errno = EINVAL;
1256 return NULL;
1260 * dwim_ref() uses REF_ISBROKEN to distinguish between
1261 * missing refs and refs that were present but invalid,
1262 * to complain about the latter to stderr.
1264 * We don't know whether the ref exists, so don't set
1265 * REF_ISBROKEN yet.
1267 *flags |= REF_BAD_NAME;
1270 for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
1271 unsigned int read_flags = 0;
1273 if (refs->be->read_raw_ref(refs, refname,
1274 sha1, &sb_refname, &read_flags)) {
1275 *flags |= read_flags;
1276 if (errno != ENOENT || (resolve_flags & RESOLVE_REF_READING))
1277 return NULL;
1278 hashclr(sha1);
1279 if (*flags & REF_BAD_NAME)
1280 *flags |= REF_ISBROKEN;
1281 return refname;
1284 *flags |= read_flags;
1286 if (!(read_flags & REF_ISSYMREF)) {
1287 if (*flags & REF_BAD_NAME) {
1288 hashclr(sha1);
1289 *flags |= REF_ISBROKEN;
1291 return refname;
1294 refname = sb_refname.buf;
1295 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1296 hashclr(sha1);
1297 return refname;
1299 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1300 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1301 !refname_is_safe(refname)) {
1302 errno = EINVAL;
1303 return NULL;
1306 *flags |= REF_ISBROKEN | REF_BAD_NAME;
1310 errno = ELOOP;
1311 return NULL;
1314 /* backend functions */
1315 int refs_init_db(struct strbuf *err)
1317 struct ref_store *refs = get_ref_store(NULL);
1319 return refs->be->init_db(refs, err);
1322 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1323 unsigned char *sha1, int *flags)
1325 return resolve_ref_recursively(get_ref_store(NULL), refname,
1326 resolve_flags, sha1, flags);
1329 int resolve_gitlink_ref(const char *submodule, const char *refname,
1330 unsigned char *sha1)
1332 size_t len = strlen(submodule);
1333 struct ref_store *refs;
1334 int flags;
1336 while (len && submodule[len - 1] == '/')
1337 len--;
1339 if (!len)
1340 return -1;
1342 if (submodule[len]) {
1343 /* We need to strip off one or more trailing slashes */
1344 char *stripped = xmemdupz(submodule, len);
1346 refs = get_ref_store(stripped);
1347 free(stripped);
1348 } else {
1349 refs = get_ref_store(submodule);
1352 if (!refs)
1353 return -1;
1355 if (!resolve_ref_recursively(refs, refname, 0, sha1, &flags) ||
1356 is_null_sha1(sha1))
1357 return -1;
1358 return 0;
1361 struct submodule_hash_entry
1363 struct hashmap_entry ent; /* must be the first member! */
1365 struct ref_store *refs;
1367 /* NUL-terminated name of submodule: */
1368 char submodule[FLEX_ARRAY];
1371 static int submodule_hash_cmp(const void *entry, const void *entry_or_key,
1372 const void *keydata)
1374 const struct submodule_hash_entry *e1 = entry, *e2 = entry_or_key;
1375 const char *submodule = keydata ? keydata : e2->submodule;
1377 return strcmp(e1->submodule, submodule);
1380 static struct submodule_hash_entry *alloc_submodule_hash_entry(
1381 const char *submodule, struct ref_store *refs)
1383 struct submodule_hash_entry *entry;
1385 FLEX_ALLOC_STR(entry, submodule, submodule);
1386 hashmap_entry_init(entry, strhash(submodule));
1387 entry->refs = refs;
1388 return entry;
1391 /* A pointer to the ref_store for the main repository: */
1392 static struct ref_store *main_ref_store;
1394 /* A hashmap of ref_stores, stored by submodule name: */
1395 static struct hashmap submodule_ref_stores;
1398 * Return the ref_store instance for the specified submodule (or the
1399 * main repository if submodule is NULL). If that ref_store hasn't
1400 * been initialized yet, return NULL.
1402 static struct ref_store *lookup_ref_store(const char *submodule)
1404 struct submodule_hash_entry *entry;
1406 if (!submodule)
1407 return main_ref_store;
1409 if (!submodule_ref_stores.tablesize)
1410 /* It's initialized on demand in register_ref_store(). */
1411 return NULL;
1413 entry = hashmap_get_from_hash(&submodule_ref_stores,
1414 strhash(submodule), submodule);
1415 return entry ? entry->refs : NULL;
1419 * Register the specified ref_store to be the one that should be used
1420 * for submodule (or the main repository if submodule is NULL). It is
1421 * a fatal error to call this function twice for the same submodule.
1423 static void register_ref_store(struct ref_store *refs, const char *submodule)
1425 if (!submodule) {
1426 if (main_ref_store)
1427 die("BUG: main_ref_store initialized twice");
1429 main_ref_store = refs;
1430 } else {
1431 if (!submodule_ref_stores.tablesize)
1432 hashmap_init(&submodule_ref_stores, submodule_hash_cmp, 0);
1434 if (hashmap_put(&submodule_ref_stores,
1435 alloc_submodule_hash_entry(submodule, refs)))
1436 die("BUG: ref_store for submodule '%s' initialized twice",
1437 submodule);
1442 * Create, record, and return a ref_store instance for the specified
1443 * submodule (or the main repository if submodule is NULL).
1445 static struct ref_store *ref_store_init(const char *submodule)
1447 const char *be_name = "files";
1448 struct ref_storage_be *be = find_ref_storage_backend(be_name);
1449 struct ref_store *refs;
1451 if (!be)
1452 die("BUG: reference backend %s is unknown", be_name);
1454 refs = be->init(submodule);
1455 register_ref_store(refs, submodule);
1456 return refs;
1459 struct ref_store *get_ref_store(const char *submodule)
1461 struct ref_store *refs;
1463 if (!submodule || !*submodule) {
1464 refs = lookup_ref_store(NULL);
1466 if (!refs)
1467 refs = ref_store_init(NULL);
1468 } else {
1469 refs = lookup_ref_store(submodule);
1471 if (!refs) {
1472 struct strbuf submodule_sb = STRBUF_INIT;
1474 strbuf_addstr(&submodule_sb, submodule);
1475 if (is_nonbare_repository_dir(&submodule_sb))
1476 refs = ref_store_init(submodule);
1477 strbuf_release(&submodule_sb);
1481 return refs;
1484 void base_ref_store_init(struct ref_store *refs,
1485 const struct ref_storage_be *be)
1487 refs->be = be;
1490 /* backend functions */
1491 int pack_refs(unsigned int flags)
1493 struct ref_store *refs = get_ref_store(NULL);
1495 return refs->be->pack_refs(refs, flags);
1498 int peel_ref(const char *refname, unsigned char *sha1)
1500 struct ref_store *refs = get_ref_store(NULL);
1502 return refs->be->peel_ref(refs, refname, sha1);
1505 int create_symref(const char *ref_target, const char *refs_heads_master,
1506 const char *logmsg)
1508 struct ref_store *refs = get_ref_store(NULL);
1510 return refs->be->create_symref(refs, ref_target, refs_heads_master,
1511 logmsg);
1514 int ref_transaction_commit(struct ref_transaction *transaction,
1515 struct strbuf *err)
1517 struct ref_store *refs = get_ref_store(NULL);
1519 return refs->be->transaction_commit(refs, transaction, err);
1522 int verify_refname_available(const char *refname,
1523 const struct string_list *extra,
1524 const struct string_list *skip,
1525 struct strbuf *err)
1527 struct ref_store *refs = get_ref_store(NULL);
1529 return refs->be->verify_refname_available(refs, refname, extra, skip, err);
1532 int for_each_reflog(each_ref_fn fn, void *cb_data)
1534 struct ref_store *refs = get_ref_store(NULL);
1535 struct ref_iterator *iter;
1537 iter = refs->be->reflog_iterator_begin(refs);
1539 return do_for_each_ref_iterator(iter, fn, cb_data);
1542 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn,
1543 void *cb_data)
1545 struct ref_store *refs = get_ref_store(NULL);
1547 return refs->be->for_each_reflog_ent_reverse(refs, refname,
1548 fn, cb_data);
1551 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn,
1552 void *cb_data)
1554 struct ref_store *refs = get_ref_store(NULL);
1556 return refs->be->for_each_reflog_ent(refs, refname, fn, cb_data);
1559 int reflog_exists(const char *refname)
1561 struct ref_store *refs = get_ref_store(NULL);
1563 return refs->be->reflog_exists(refs, refname);
1566 int safe_create_reflog(const char *refname, int force_create,
1567 struct strbuf *err)
1569 struct ref_store *refs = get_ref_store(NULL);
1571 return refs->be->create_reflog(refs, refname, force_create, err);
1574 int delete_reflog(const char *refname)
1576 struct ref_store *refs = get_ref_store(NULL);
1578 return refs->be->delete_reflog(refs, refname);
1581 int reflog_expire(const char *refname, const unsigned char *sha1,
1582 unsigned int flags,
1583 reflog_expiry_prepare_fn prepare_fn,
1584 reflog_expiry_should_prune_fn should_prune_fn,
1585 reflog_expiry_cleanup_fn cleanup_fn,
1586 void *policy_cb_data)
1588 struct ref_store *refs = get_ref_store(NULL);
1590 return refs->be->reflog_expire(refs, refname, sha1, flags,
1591 prepare_fn, should_prune_fn,
1592 cleanup_fn, policy_cb_data);
1595 int initial_ref_transaction_commit(struct ref_transaction *transaction,
1596 struct strbuf *err)
1598 struct ref_store *refs = get_ref_store(NULL);
1600 return refs->be->initial_transaction_commit(refs, transaction, err);
1603 int delete_refs(struct string_list *refnames, unsigned int flags)
1605 struct ref_store *refs = get_ref_store(NULL);
1607 return refs->be->delete_refs(refs, refnames, flags);
1610 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1612 struct ref_store *refs = get_ref_store(NULL);
1614 return refs->be->rename_ref(refs, oldref, newref, logmsg);