2 * The backend-independent part of the reference module.
11 #include "refs/refs-internal.h"
14 #include "submodule.h"
16 #include "argv-array.h"
17 #include "repository.h"
20 * List of all available backends
22 static struct ref_storage_be *refs_backends = &refs_be_files;
24 static struct ref_storage_be *find_ref_storage_backend(const char *name)
26 struct ref_storage_be *be;
27 for (be = refs_backends; be; be = be->next)
28 if (!strcmp(be->name, name))
33 int ref_storage_backend_exists(const char *name)
35 return find_ref_storage_backend(name) != NULL;
39 * How to handle various characters in refnames:
40 * 0: An acceptable character for refs
42 * 2: ., look for a preceding . to reject .. in refs
43 * 3: {, look for a preceding @ to reject @{ in refs
44 * 4: A bad character: ASCII control characters, and
45 * ":", "?", "[", "\", "^", "~", SP, or TAB
46 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
48 static unsigned char refname_disposition[256] = {
49 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
50 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
51 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
52 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
55 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
56 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
60 * Try to read one refname component from the front of refname.
61 * Return the length of the component found, or -1 if the component is
62 * not legal. It is legal if it is something reasonable to have under
63 * ".git/refs/"; We do not like it if:
65 * - any path component of it begins with ".", or
66 * - it has double dots "..", or
67 * - it has ASCII control characters, or
68 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
69 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
70 * - it ends with a "/", or
71 * - it ends with ".lock", or
72 * - it contains a "@{" portion
74 static int check_refname_component(const char *refname, int *flags)
79 for (cp = refname; ; cp++) {
81 unsigned char disp = refname_disposition[ch];
87 return -1; /* Refname contains "..". */
91 return -1; /* Refname contains "@{". */
96 if (!(*flags & REFNAME_REFSPEC_PATTERN))
97 return -1; /* refspec can't be a pattern */
100 * Unset the pattern flag so that we only accept
101 * a single asterisk for one side of refspec.
103 *flags &= ~ REFNAME_REFSPEC_PATTERN;
110 return 0; /* Component has zero length. */
111 if (refname[0] == '.')
112 return -1; /* Component starts with '.'. */
113 if (cp - refname >= LOCK_SUFFIX_LEN &&
114 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
115 return -1; /* Refname ends with ".lock". */
119 int check_refname_format(const char *refname, int flags)
121 int component_len, component_count = 0;
123 if (!strcmp(refname, "@"))
124 /* Refname is a single character '@'. */
128 /* We are at the start of a path component. */
129 component_len = check_refname_component(refname, &flags);
130 if (component_len <= 0)
134 if (refname[component_len] == '\0')
136 /* Skip to next component. */
137 refname += component_len + 1;
140 if (refname[component_len - 1] == '.')
141 return -1; /* Refname ends with '.'. */
142 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
143 return -1; /* Refname has only one component. */
147 int refname_is_safe(const char *refname)
151 if (skip_prefix(refname, "refs/", &rest)) {
154 size_t restlen = strlen(rest);
156 /* rest must not be empty, or start or end with "/" */
157 if (!restlen || *rest == '/' || rest[restlen - 1] == '/')
161 * Does the refname try to escape refs/?
162 * For example: refs/foo/../bar is safe but refs/foo/../../bar
165 buf = xmallocz(restlen);
166 result = !normalize_path_copy(buf, rest) && !strcmp(buf, rest);
172 if (!isupper(*refname) && *refname != '_')
180 * Return true if refname, which has the specified oid and flags, can
181 * be resolved to an object in the database. If the referred-to object
182 * does not exist, emit a warning and return false.
184 int ref_resolves_to_object(const char *refname,
185 const struct object_id *oid,
188 if (flags & REF_ISBROKEN)
190 if (!has_sha1_file(oid->hash)) {
191 error("%s does not point to a valid object!", refname);
197 char *refs_resolve_refdup(struct ref_store *refs,
198 const char *refname, int resolve_flags,
199 struct object_id *oid, int *flags)
203 result = refs_resolve_ref_unsafe(refs, refname, resolve_flags,
205 return xstrdup_or_null(result);
208 char *resolve_refdup(const char *refname, int resolve_flags,
209 struct object_id *oid, int *flags)
211 return refs_resolve_refdup(get_main_ref_store(the_repository),
212 refname, resolve_flags,
216 /* The argument to filter_refs */
223 int refs_read_ref_full(struct ref_store *refs, const char *refname,
224 int resolve_flags, struct object_id *oid, int *flags)
226 if (refs_resolve_ref_unsafe(refs, refname, resolve_flags, oid, flags))
231 int read_ref_full(const char *refname, int resolve_flags, struct object_id *oid, int *flags)
233 return refs_read_ref_full(get_main_ref_store(the_repository), refname,
234 resolve_flags, oid, flags);
237 int read_ref(const char *refname, struct object_id *oid)
239 return read_ref_full(refname, RESOLVE_REF_READING, oid, NULL);
242 int ref_exists(const char *refname)
244 return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, NULL, NULL);
247 static int match_ref_pattern(const char *refname,
248 const struct string_list_item *item)
251 if (item->util == NULL) {
252 if (!wildmatch(item->string, refname, 0))
256 if (skip_prefix(refname, item->string, &rest) &&
257 (!*rest || *rest == '/'))
263 int ref_filter_match(const char *refname,
264 const struct string_list *include_patterns,
265 const struct string_list *exclude_patterns)
267 struct string_list_item *item;
269 if (exclude_patterns && exclude_patterns->nr) {
270 for_each_string_list_item(item, exclude_patterns) {
271 if (match_ref_pattern(refname, item))
276 if (include_patterns && include_patterns->nr) {
278 for_each_string_list_item(item, include_patterns) {
279 if (match_ref_pattern(refname, item)) {
291 static int filter_refs(const char *refname, const struct object_id *oid,
292 int flags, void *data)
294 struct ref_filter *filter = (struct ref_filter *)data;
296 if (wildmatch(filter->pattern, refname, 0))
298 return filter->fn(refname, oid, flags, filter->cb_data);
301 enum peel_status peel_object(const struct object_id *name, struct object_id *oid)
303 struct object *o = lookup_unknown_object(name->hash);
305 if (o->type == OBJ_NONE) {
306 int type = oid_object_info(the_repository, name, NULL);
307 if (type < 0 || !object_as_type(o, type, 0))
311 if (o->type != OBJ_TAG)
314 o = deref_tag_noverify(o);
318 oidcpy(oid, &o->oid);
322 struct warn_if_dangling_data {
325 const struct string_list *refnames;
329 static int warn_if_dangling_symref(const char *refname, const struct object_id *oid,
330 int flags, void *cb_data)
332 struct warn_if_dangling_data *d = cb_data;
333 const char *resolves_to;
335 if (!(flags & REF_ISSYMREF))
338 resolves_to = resolve_ref_unsafe(refname, 0, NULL, NULL);
341 ? strcmp(resolves_to, d->refname)
342 : !string_list_has_string(d->refnames, resolves_to))) {
346 fprintf(d->fp, d->msg_fmt, refname);
351 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
353 struct warn_if_dangling_data data;
356 data.refname = refname;
357 data.refnames = NULL;
358 data.msg_fmt = msg_fmt;
359 for_each_rawref(warn_if_dangling_symref, &data);
362 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
364 struct warn_if_dangling_data data;
368 data.refnames = refnames;
369 data.msg_fmt = msg_fmt;
370 for_each_rawref(warn_if_dangling_symref, &data);
373 int refs_for_each_tag_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
375 return refs_for_each_ref_in(refs, "refs/tags/", fn, cb_data);
378 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
380 return refs_for_each_tag_ref(get_main_ref_store(the_repository), fn, cb_data);
383 int refs_for_each_branch_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
385 return refs_for_each_ref_in(refs, "refs/heads/", fn, cb_data);
388 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
390 return refs_for_each_branch_ref(get_main_ref_store(the_repository), fn, cb_data);
393 int refs_for_each_remote_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
395 return refs_for_each_ref_in(refs, "refs/remotes/", fn, cb_data);
398 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
400 return refs_for_each_remote_ref(get_main_ref_store(the_repository), fn, cb_data);
403 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
405 struct strbuf buf = STRBUF_INIT;
407 struct object_id oid;
410 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
411 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, &oid, &flag))
412 ret = fn(buf.buf, &oid, flag, cb_data);
413 strbuf_release(&buf);
418 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
421 struct strbuf normalized_pattern = STRBUF_INIT;
424 BUG("pattern must not start with '/'");
427 strbuf_addstr(&normalized_pattern, prefix);
429 else if (!starts_with(pattern, "refs/"))
430 strbuf_addstr(&normalized_pattern, "refs/");
431 strbuf_addstr(&normalized_pattern, pattern);
432 strbuf_strip_suffix(&normalized_pattern, "/");
434 item->string = strbuf_detach(&normalized_pattern, NULL);
435 item->util = has_glob_specials(pattern) ? NULL : item->string;
436 strbuf_release(&normalized_pattern);
439 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
440 const char *prefix, void *cb_data)
442 struct strbuf real_pattern = STRBUF_INIT;
443 struct ref_filter filter;
446 if (!prefix && !starts_with(pattern, "refs/"))
447 strbuf_addstr(&real_pattern, "refs/");
449 strbuf_addstr(&real_pattern, prefix);
450 strbuf_addstr(&real_pattern, pattern);
452 if (!has_glob_specials(pattern)) {
453 /* Append implied '/' '*' if not present. */
454 strbuf_complete(&real_pattern, '/');
455 /* No need to check for '*', there is none. */
456 strbuf_addch(&real_pattern, '*');
459 filter.pattern = real_pattern.buf;
461 filter.cb_data = cb_data;
462 ret = for_each_ref(filter_refs, &filter);
464 strbuf_release(&real_pattern);
468 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
470 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
473 const char *prettify_refname(const char *name)
475 if (skip_prefix(name, "refs/heads/", &name) ||
476 skip_prefix(name, "refs/tags/", &name) ||
477 skip_prefix(name, "refs/remotes/", &name))
482 static const char *ref_rev_parse_rules[] = {
488 "refs/remotes/%.*s/HEAD",
492 int refname_match(const char *abbrev_name, const char *full_name)
495 const int abbrev_name_len = strlen(abbrev_name);
497 for (p = ref_rev_parse_rules; *p; p++) {
498 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
507 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
508 * the results to 'prefixes'
510 void expand_ref_prefix(struct argv_array *prefixes, const char *prefix)
513 int len = strlen(prefix);
515 for (p = ref_rev_parse_rules; *p; p++)
516 argv_array_pushf(prefixes, *p, len, prefix);
520 * *string and *len will only be substituted, and *string returned (for
521 * later free()ing) if the string passed in is a magic short-hand form
524 static char *substitute_branch_name(const char **string, int *len)
526 struct strbuf buf = STRBUF_INIT;
527 int ret = interpret_branch_name(*string, *len, &buf, 0);
531 *string = strbuf_detach(&buf, &size);
533 return (char *)*string;
539 int dwim_ref(const char *str, int len, struct object_id *oid, char **ref)
541 char *last_branch = substitute_branch_name(&str, &len);
542 int refs_found = expand_ref(str, len, oid, ref);
547 int expand_ref(const char *str, int len, struct object_id *oid, char **ref)
551 struct strbuf fullref = STRBUF_INIT;
554 for (p = ref_rev_parse_rules; *p; p++) {
555 struct object_id oid_from_ref;
556 struct object_id *this_result;
559 this_result = refs_found ? &oid_from_ref : oid;
560 strbuf_reset(&fullref);
561 strbuf_addf(&fullref, *p, len, str);
562 r = resolve_ref_unsafe(fullref.buf, RESOLVE_REF_READING,
567 if (!warn_ambiguous_refs)
569 } else if ((flag & REF_ISSYMREF) && strcmp(fullref.buf, "HEAD")) {
570 warning("ignoring dangling symref %s.", fullref.buf);
571 } else if ((flag & REF_ISBROKEN) && strchr(fullref.buf, '/')) {
572 warning("ignoring broken ref %s.", fullref.buf);
575 strbuf_release(&fullref);
579 int dwim_log(const char *str, int len, struct object_id *oid, char **log)
581 char *last_branch = substitute_branch_name(&str, &len);
584 struct strbuf path = STRBUF_INIT;
587 for (p = ref_rev_parse_rules; *p; p++) {
588 struct object_id hash;
589 const char *ref, *it;
592 strbuf_addf(&path, *p, len, str);
593 ref = resolve_ref_unsafe(path.buf, RESOLVE_REF_READING,
597 if (reflog_exists(path.buf))
599 else if (strcmp(ref, path.buf) && reflog_exists(ref))
607 if (!warn_ambiguous_refs)
610 strbuf_release(&path);
615 static int is_per_worktree_ref(const char *refname)
617 return !strcmp(refname, "HEAD") ||
618 starts_with(refname, "refs/bisect/") ||
619 starts_with(refname, "refs/rewritten/");
622 static int is_pseudoref_syntax(const char *refname)
626 for (c = refname; *c; c++) {
627 if (!isupper(*c) && *c != '-' && *c != '_')
634 enum ref_type ref_type(const char *refname)
636 if (is_per_worktree_ref(refname))
637 return REF_TYPE_PER_WORKTREE;
638 if (is_pseudoref_syntax(refname))
639 return REF_TYPE_PSEUDOREF;
640 return REF_TYPE_NORMAL;
643 long get_files_ref_lock_timeout_ms(void)
645 static int configured = 0;
647 /* The default timeout is 100 ms: */
648 static int timeout_ms = 100;
651 git_config_get_int("core.filesreflocktimeout", &timeout_ms);
658 static int write_pseudoref(const char *pseudoref, const struct object_id *oid,
659 const struct object_id *old_oid, struct strbuf *err)
661 const char *filename;
663 struct lock_file lock = LOCK_INIT;
664 struct strbuf buf = STRBUF_INIT;
670 strbuf_addf(&buf, "%s\n", oid_to_hex(oid));
672 filename = git_path("%s", pseudoref);
673 fd = hold_lock_file_for_update_timeout(&lock, filename, 0,
674 get_files_ref_lock_timeout_ms());
676 strbuf_addf(err, "could not open '%s' for writing: %s",
677 filename, strerror(errno));
682 struct object_id actual_old_oid;
684 if (read_ref(pseudoref, &actual_old_oid)) {
685 if (!is_null_oid(old_oid)) {
686 strbuf_addf(err, "could not read ref '%s'",
688 rollback_lock_file(&lock);
691 } else if (is_null_oid(old_oid)) {
692 strbuf_addf(err, "ref '%s' already exists",
694 rollback_lock_file(&lock);
696 } else if (oidcmp(&actual_old_oid, old_oid)) {
697 strbuf_addf(err, "unexpected object ID when writing '%s'",
699 rollback_lock_file(&lock);
704 if (write_in_full(fd, buf.buf, buf.len) < 0) {
705 strbuf_addf(err, "could not write to '%s'", filename);
706 rollback_lock_file(&lock);
710 commit_lock_file(&lock);
713 strbuf_release(&buf);
717 static int delete_pseudoref(const char *pseudoref, const struct object_id *old_oid)
719 const char *filename;
721 filename = git_path("%s", pseudoref);
723 if (old_oid && !is_null_oid(old_oid)) {
724 struct lock_file lock = LOCK_INIT;
726 struct object_id actual_old_oid;
728 fd = hold_lock_file_for_update_timeout(
730 get_files_ref_lock_timeout_ms());
732 error_errno(_("could not open '%s' for writing"),
736 if (read_ref(pseudoref, &actual_old_oid))
737 die("could not read ref '%s'", pseudoref);
738 if (oidcmp(&actual_old_oid, old_oid)) {
739 error("unexpected object ID when deleting '%s'",
741 rollback_lock_file(&lock);
746 rollback_lock_file(&lock);
754 int refs_delete_ref(struct ref_store *refs, const char *msg,
756 const struct object_id *old_oid,
759 struct ref_transaction *transaction;
760 struct strbuf err = STRBUF_INIT;
762 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
763 assert(refs == get_main_ref_store(the_repository));
764 return delete_pseudoref(refname, old_oid);
767 transaction = ref_store_transaction_begin(refs, &err);
769 ref_transaction_delete(transaction, refname, old_oid,
771 ref_transaction_commit(transaction, &err)) {
772 error("%s", err.buf);
773 ref_transaction_free(transaction);
774 strbuf_release(&err);
777 ref_transaction_free(transaction);
778 strbuf_release(&err);
782 int delete_ref(const char *msg, const char *refname,
783 const struct object_id *old_oid, unsigned int flags)
785 return refs_delete_ref(get_main_ref_store(the_repository), msg, refname,
789 void copy_reflog_msg(struct strbuf *sb, const char *msg)
794 strbuf_addch(sb, '\t');
795 while ((c = *msg++)) {
796 if (wasspace && isspace(c))
798 wasspace = isspace(c);
806 int should_autocreate_reflog(const char *refname)
808 switch (log_all_ref_updates) {
809 case LOG_REFS_ALWAYS:
811 case LOG_REFS_NORMAL:
812 return starts_with(refname, "refs/heads/") ||
813 starts_with(refname, "refs/remotes/") ||
814 starts_with(refname, "refs/notes/") ||
815 !strcmp(refname, "HEAD");
821 int is_branch(const char *refname)
823 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
826 struct read_ref_at_cb {
831 struct object_id *oid;
834 struct object_id ooid;
835 struct object_id noid;
839 timestamp_t *cutoff_time;
844 static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
845 const char *email, timestamp_t timestamp, int tz,
846 const char *message, void *cb_data)
848 struct read_ref_at_cb *cb = cb_data;
852 cb->date = timestamp;
854 if (timestamp <= cb->at_time || cb->cnt == 0) {
856 *cb->msg = xstrdup(message);
858 *cb->cutoff_time = timestamp;
862 *cb->cutoff_cnt = cb->reccnt - 1;
864 * we have not yet updated cb->[n|o]oid so they still
865 * hold the values for the previous record.
867 if (!is_null_oid(&cb->ooid)) {
868 oidcpy(cb->oid, noid);
869 if (oidcmp(&cb->ooid, noid))
870 warning("Log for ref %s has gap after %s.",
871 cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
873 else if (cb->date == cb->at_time)
874 oidcpy(cb->oid, noid);
875 else if (oidcmp(noid, cb->oid))
876 warning("Log for ref %s unexpectedly ended on %s.",
877 cb->refname, show_date(cb->date, cb->tz,
878 DATE_MODE(RFC2822)));
879 oidcpy(&cb->ooid, ooid);
880 oidcpy(&cb->noid, noid);
884 oidcpy(&cb->ooid, ooid);
885 oidcpy(&cb->noid, noid);
891 static int read_ref_at_ent_oldest(struct object_id *ooid, struct object_id *noid,
892 const char *email, timestamp_t timestamp,
893 int tz, const char *message, void *cb_data)
895 struct read_ref_at_cb *cb = cb_data;
898 *cb->msg = xstrdup(message);
900 *cb->cutoff_time = timestamp;
904 *cb->cutoff_cnt = cb->reccnt;
905 oidcpy(cb->oid, ooid);
906 if (is_null_oid(cb->oid))
907 oidcpy(cb->oid, noid);
908 /* We just want the first entry */
912 int read_ref_at(const char *refname, unsigned int flags, timestamp_t at_time, int cnt,
913 struct object_id *oid, char **msg,
914 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
916 struct read_ref_at_cb cb;
918 memset(&cb, 0, sizeof(cb));
919 cb.refname = refname;
920 cb.at_time = at_time;
923 cb.cutoff_time = cutoff_time;
924 cb.cutoff_tz = cutoff_tz;
925 cb.cutoff_cnt = cutoff_cnt;
928 for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);
931 if (flags & GET_OID_QUIETLY)
934 die("Log for %s is empty.", refname);
939 for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
944 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
947 struct ref_transaction *tr;
950 tr = xcalloc(1, sizeof(struct ref_transaction));
951 tr->ref_store = refs;
955 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
957 return ref_store_transaction_begin(get_main_ref_store(the_repository), err);
960 void ref_transaction_free(struct ref_transaction *transaction)
967 switch (transaction->state) {
968 case REF_TRANSACTION_OPEN:
969 case REF_TRANSACTION_CLOSED:
972 case REF_TRANSACTION_PREPARED:
973 BUG("free called on a prepared reference transaction");
976 BUG("unexpected reference transaction state");
980 for (i = 0; i < transaction->nr; i++) {
981 free(transaction->updates[i]->msg);
982 free(transaction->updates[i]);
984 free(transaction->updates);
988 struct ref_update *ref_transaction_add_update(
989 struct ref_transaction *transaction,
990 const char *refname, unsigned int flags,
991 const struct object_id *new_oid,
992 const struct object_id *old_oid,
995 struct ref_update *update;
997 if (transaction->state != REF_TRANSACTION_OPEN)
998 BUG("update called for transaction that is not open");
1000 FLEX_ALLOC_STR(update, refname, refname);
1001 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
1002 transaction->updates[transaction->nr++] = update;
1004 update->flags = flags;
1006 if (flags & REF_HAVE_NEW)
1007 oidcpy(&update->new_oid, new_oid);
1008 if (flags & REF_HAVE_OLD)
1009 oidcpy(&update->old_oid, old_oid);
1010 update->msg = xstrdup_or_null(msg);
1014 int ref_transaction_update(struct ref_transaction *transaction,
1015 const char *refname,
1016 const struct object_id *new_oid,
1017 const struct object_id *old_oid,
1018 unsigned int flags, const char *msg,
1023 if ((new_oid && !is_null_oid(new_oid)) ?
1024 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL) :
1025 !refname_is_safe(refname)) {
1026 strbuf_addf(err, "refusing to update ref with bad name '%s'",
1031 if (flags & ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS)
1032 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags);
1034 flags |= (new_oid ? REF_HAVE_NEW : 0) | (old_oid ? REF_HAVE_OLD : 0);
1036 ref_transaction_add_update(transaction, refname, flags,
1037 new_oid, old_oid, msg);
1041 int ref_transaction_create(struct ref_transaction *transaction,
1042 const char *refname,
1043 const struct object_id *new_oid,
1044 unsigned int flags, const char *msg,
1047 if (!new_oid || is_null_oid(new_oid))
1048 BUG("create called without valid new_oid");
1049 return ref_transaction_update(transaction, refname, new_oid,
1050 &null_oid, flags, msg, err);
1053 int ref_transaction_delete(struct ref_transaction *transaction,
1054 const char *refname,
1055 const struct object_id *old_oid,
1056 unsigned int flags, const char *msg,
1059 if (old_oid && is_null_oid(old_oid))
1060 BUG("delete called with old_oid set to zeros");
1061 return ref_transaction_update(transaction, refname,
1066 int ref_transaction_verify(struct ref_transaction *transaction,
1067 const char *refname,
1068 const struct object_id *old_oid,
1073 BUG("verify called with old_oid set to NULL");
1074 return ref_transaction_update(transaction, refname,
1079 int refs_update_ref(struct ref_store *refs, const char *msg,
1080 const char *refname, const struct object_id *new_oid,
1081 const struct object_id *old_oid, unsigned int flags,
1082 enum action_on_err onerr)
1084 struct ref_transaction *t = NULL;
1085 struct strbuf err = STRBUF_INIT;
1088 if (ref_type(refname) == REF_TYPE_PSEUDOREF) {
1089 assert(refs == get_main_ref_store(the_repository));
1090 ret = write_pseudoref(refname, new_oid, old_oid, &err);
1092 t = ref_store_transaction_begin(refs, &err);
1094 ref_transaction_update(t, refname, new_oid, old_oid,
1095 flags, msg, &err) ||
1096 ref_transaction_commit(t, &err)) {
1098 ref_transaction_free(t);
1102 const char *str = "update_ref failed for ref '%s': %s";
1105 case UPDATE_REFS_MSG_ON_ERR:
1106 error(str, refname, err.buf);
1108 case UPDATE_REFS_DIE_ON_ERR:
1109 die(str, refname, err.buf);
1111 case UPDATE_REFS_QUIET_ON_ERR:
1114 strbuf_release(&err);
1117 strbuf_release(&err);
1119 ref_transaction_free(t);
1123 int update_ref(const char *msg, const char *refname,
1124 const struct object_id *new_oid,
1125 const struct object_id *old_oid,
1126 unsigned int flags, enum action_on_err onerr)
1128 return refs_update_ref(get_main_ref_store(the_repository), msg, refname, new_oid,
1129 old_oid, flags, onerr);
1132 char *shorten_unambiguous_ref(const char *refname, int strict)
1135 static char **scanf_fmts;
1136 static int nr_rules;
1138 struct strbuf resolved_buf = STRBUF_INIT;
1142 * Pre-generate scanf formats from ref_rev_parse_rules[].
1143 * Generate a format suitable for scanf from a
1144 * ref_rev_parse_rules rule by interpolating "%s" at the
1145 * location of the "%.*s".
1147 size_t total_len = 0;
1150 /* the rule list is NULL terminated, count them first */
1151 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
1152 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1153 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
1155 scanf_fmts = xmalloc(st_add(st_mult(sizeof(char *), nr_rules), total_len));
1158 for (i = 0; i < nr_rules; i++) {
1159 assert(offset < total_len);
1160 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
1161 offset += xsnprintf(scanf_fmts[i], total_len - offset,
1162 ref_rev_parse_rules[i], 2, "%s") + 1;
1166 /* bail out if there are no rules */
1168 return xstrdup(refname);
1170 /* buffer for scanf result, at most refname must fit */
1171 short_name = xstrdup(refname);
1173 /* skip first rule, it will always match */
1174 for (i = nr_rules - 1; i > 0 ; --i) {
1176 int rules_to_fail = i;
1179 if (1 != sscanf(refname, scanf_fmts[i], short_name))
1182 short_name_len = strlen(short_name);
1185 * in strict mode, all (except the matched one) rules
1186 * must fail to resolve to a valid non-ambiguous ref
1189 rules_to_fail = nr_rules;
1192 * check if the short name resolves to a valid ref,
1193 * but use only rules prior to the matched one
1195 for (j = 0; j < rules_to_fail; j++) {
1196 const char *rule = ref_rev_parse_rules[j];
1198 /* skip matched rule */
1203 * the short name is ambiguous, if it resolves
1204 * (with this previous rule) to a valid ref
1205 * read_ref() returns 0 on success
1207 strbuf_reset(&resolved_buf);
1208 strbuf_addf(&resolved_buf, rule,
1209 short_name_len, short_name);
1210 if (ref_exists(resolved_buf.buf))
1215 * short name is non-ambiguous if all previous rules
1216 * haven't resolved to a valid ref
1218 if (j == rules_to_fail) {
1219 strbuf_release(&resolved_buf);
1224 strbuf_release(&resolved_buf);
1226 return xstrdup(refname);
1229 static struct string_list *hide_refs;
1231 int parse_hide_refs_config(const char *var, const char *value, const char *section)
1234 if (!strcmp("transfer.hiderefs", var) ||
1235 (!parse_config_key(var, section, NULL, NULL, &key) &&
1236 !strcmp(key, "hiderefs"))) {
1241 return config_error_nonbool(var);
1242 ref = xstrdup(value);
1244 while (len && ref[len - 1] == '/')
1247 hide_refs = xcalloc(1, sizeof(*hide_refs));
1248 hide_refs->strdup_strings = 1;
1250 string_list_append(hide_refs, ref);
1255 int ref_is_hidden(const char *refname, const char *refname_full)
1261 for (i = hide_refs->nr - 1; i >= 0; i--) {
1262 const char *match = hide_refs->items[i].string;
1263 const char *subject;
1267 if (*match == '!') {
1272 if (*match == '^') {
1273 subject = refname_full;
1279 /* refname can be NULL when namespaces are used. */
1281 skip_prefix(subject, match, &p) &&
1288 const char *find_descendant_ref(const char *dirname,
1289 const struct string_list *extras,
1290 const struct string_list *skip)
1298 * Look at the place where dirname would be inserted into
1299 * extras. If there is an entry at that position that starts
1300 * with dirname (remember, dirname includes the trailing
1301 * slash) and is not in skip, then we have a conflict.
1303 for (pos = string_list_find_insert_index(extras, dirname, 0);
1304 pos < extras->nr; pos++) {
1305 const char *extra_refname = extras->items[pos].string;
1307 if (!starts_with(extra_refname, dirname))
1310 if (!skip || !string_list_has_string(skip, extra_refname))
1311 return extra_refname;
1316 int refs_rename_ref_available(struct ref_store *refs,
1317 const char *old_refname,
1318 const char *new_refname)
1320 struct string_list skip = STRING_LIST_INIT_NODUP;
1321 struct strbuf err = STRBUF_INIT;
1324 string_list_insert(&skip, old_refname);
1325 ok = !refs_verify_refname_available(refs, new_refname,
1328 error("%s", err.buf);
1330 string_list_clear(&skip, 0);
1331 strbuf_release(&err);
1335 int refs_head_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1337 struct object_id oid;
1340 if (!refs_read_ref_full(refs, "HEAD", RESOLVE_REF_READING,
1342 return fn("HEAD", &oid, flag, cb_data);
1347 int head_ref(each_ref_fn fn, void *cb_data)
1349 return refs_head_ref(get_main_ref_store(the_repository), fn, cb_data);
1352 struct ref_iterator *refs_ref_iterator_begin(
1353 struct ref_store *refs,
1354 const char *prefix, int trim, int flags)
1356 struct ref_iterator *iter;
1358 if (ref_paranoia < 0)
1359 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 0);
1361 flags |= DO_FOR_EACH_INCLUDE_BROKEN;
1363 iter = refs->be->iterator_begin(refs, prefix, flags);
1366 * `iterator_begin()` already takes care of prefix, but we
1367 * might need to do some trimming:
1370 iter = prefix_ref_iterator_begin(iter, "", trim);
1372 /* Sanity check for subclasses: */
1374 BUG("reference iterator is not ordered");
1380 * Call fn for each reference in the specified submodule for which the
1381 * refname begins with prefix. If trim is non-zero, then trim that
1382 * many characters off the beginning of each refname before passing
1383 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1384 * include broken references in the iteration. If fn ever returns a
1385 * non-zero value, stop the iteration and return that value;
1386 * otherwise, return 0.
1388 static int do_for_each_ref(struct ref_store *refs, const char *prefix,
1389 each_ref_fn fn, int trim, int flags, void *cb_data)
1391 struct ref_iterator *iter;
1396 iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1398 return do_for_each_ref_iterator(iter, fn, cb_data);
1401 int refs_for_each_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1403 return do_for_each_ref(refs, "", fn, 0, 0, cb_data);
1406 int for_each_ref(each_ref_fn fn, void *cb_data)
1408 return refs_for_each_ref(get_main_ref_store(the_repository), fn, cb_data);
1411 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
1412 each_ref_fn fn, void *cb_data)
1414 return do_for_each_ref(refs, prefix, fn, strlen(prefix), 0, cb_data);
1417 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1419 return refs_for_each_ref_in(get_main_ref_store(the_repository), prefix, fn, cb_data);
1422 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data, unsigned int broken)
1424 unsigned int flag = 0;
1427 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1428 return do_for_each_ref(get_main_ref_store(the_repository),
1429 prefix, fn, 0, flag, cb_data);
1432 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
1433 each_ref_fn fn, void *cb_data,
1434 unsigned int broken)
1436 unsigned int flag = 0;
1439 flag = DO_FOR_EACH_INCLUDE_BROKEN;
1440 return do_for_each_ref(refs, prefix, fn, 0, flag, cb_data);
1443 int for_each_replace_ref(struct repository *r, each_ref_fn fn, void *cb_data)
1445 return do_for_each_ref(get_main_ref_store(r),
1446 git_replace_ref_base, fn,
1447 strlen(git_replace_ref_base),
1448 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1451 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1453 struct strbuf buf = STRBUF_INIT;
1455 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1456 ret = do_for_each_ref(get_main_ref_store(the_repository),
1457 buf.buf, fn, 0, 0, cb_data);
1458 strbuf_release(&buf);
1462 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1464 return do_for_each_ref(refs, "", fn, 0,
1465 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1468 int for_each_rawref(each_ref_fn fn, void *cb_data)
1470 return refs_for_each_rawref(get_main_ref_store(the_repository), fn, cb_data);
1473 int refs_read_raw_ref(struct ref_store *ref_store,
1474 const char *refname, struct object_id *oid,
1475 struct strbuf *referent, unsigned int *type)
1477 return ref_store->be->read_raw_ref(ref_store, refname, oid, referent, type);
1480 /* This function needs to return a meaningful errno on failure */
1481 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
1482 const char *refname,
1484 struct object_id *oid, int *flags)
1486 static struct strbuf sb_refname = STRBUF_INIT;
1487 struct object_id unused_oid;
1494 flags = &unused_flags;
1498 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1499 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1500 !refname_is_safe(refname)) {
1506 * dwim_ref() uses REF_ISBROKEN to distinguish between
1507 * missing refs and refs that were present but invalid,
1508 * to complain about the latter to stderr.
1510 * We don't know whether the ref exists, so don't set
1513 *flags |= REF_BAD_NAME;
1516 for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
1517 unsigned int read_flags = 0;
1519 if (refs_read_raw_ref(refs, refname,
1520 oid, &sb_refname, &read_flags)) {
1521 *flags |= read_flags;
1523 /* In reading mode, refs must eventually resolve */
1524 if (resolve_flags & RESOLVE_REF_READING)
1528 * Otherwise a missing ref is OK. But the files backend
1529 * may show errors besides ENOENT if there are
1530 * similarly-named refs.
1532 if (errno != ENOENT &&
1538 if (*flags & REF_BAD_NAME)
1539 *flags |= REF_ISBROKEN;
1543 *flags |= read_flags;
1545 if (!(read_flags & REF_ISSYMREF)) {
1546 if (*flags & REF_BAD_NAME) {
1548 *flags |= REF_ISBROKEN;
1553 refname = sb_refname.buf;
1554 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1558 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1559 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1560 !refname_is_safe(refname)) {
1565 *flags |= REF_ISBROKEN | REF_BAD_NAME;
1573 /* backend functions */
1574 int refs_init_db(struct strbuf *err)
1576 struct ref_store *refs = get_main_ref_store(the_repository);
1578 return refs->be->init_db(refs, err);
1581 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1582 struct object_id *oid, int *flags)
1584 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository), refname,
1585 resolve_flags, oid, flags);
1588 int resolve_gitlink_ref(const char *submodule, const char *refname,
1589 struct object_id *oid)
1591 struct ref_store *refs;
1594 refs = get_submodule_ref_store(submodule);
1599 if (!refs_resolve_ref_unsafe(refs, refname, 0, oid, &flags) ||
1605 struct ref_store_hash_entry
1607 struct hashmap_entry ent; /* must be the first member! */
1609 struct ref_store *refs;
1611 /* NUL-terminated identifier of the ref store: */
1612 char name[FLEX_ARRAY];
1615 static int ref_store_hash_cmp(const void *unused_cmp_data,
1616 const void *entry, const void *entry_or_key,
1617 const void *keydata)
1619 const struct ref_store_hash_entry *e1 = entry, *e2 = entry_or_key;
1620 const char *name = keydata ? keydata : e2->name;
1622 return strcmp(e1->name, name);
1625 static struct ref_store_hash_entry *alloc_ref_store_hash_entry(
1626 const char *name, struct ref_store *refs)
1628 struct ref_store_hash_entry *entry;
1630 FLEX_ALLOC_STR(entry, name, name);
1631 hashmap_entry_init(entry, strhash(name));
1636 /* A hashmap of ref_stores, stored by submodule name: */
1637 static struct hashmap submodule_ref_stores;
1639 /* A hashmap of ref_stores, stored by worktree id: */
1640 static struct hashmap worktree_ref_stores;
1643 * Look up a ref store by name. If that ref_store hasn't been
1644 * registered yet, return NULL.
1646 static struct ref_store *lookup_ref_store_map(struct hashmap *map,
1649 struct ref_store_hash_entry *entry;
1651 if (!map->tablesize)
1652 /* It's initialized on demand in register_ref_store(). */
1655 entry = hashmap_get_from_hash(map, strhash(name), name);
1656 return entry ? entry->refs : NULL;
1660 * Create, record, and return a ref_store instance for the specified
1663 static struct ref_store *ref_store_init(const char *gitdir,
1666 const char *be_name = "files";
1667 struct ref_storage_be *be = find_ref_storage_backend(be_name);
1668 struct ref_store *refs;
1671 BUG("reference backend %s is unknown", be_name);
1673 refs = be->init(gitdir, flags);
1677 struct ref_store *get_main_ref_store(struct repository *r)
1683 BUG("attempting to get main_ref_store outside of repository");
1685 r->refs = ref_store_init(r->gitdir, REF_STORE_ALL_CAPS);
1690 * Associate a ref store with a name. It is a fatal error to call this
1691 * function twice for the same name.
1693 static void register_ref_store_map(struct hashmap *map,
1695 struct ref_store *refs,
1698 if (!map->tablesize)
1699 hashmap_init(map, ref_store_hash_cmp, NULL, 0);
1701 if (hashmap_put(map, alloc_ref_store_hash_entry(name, refs)))
1702 BUG("%s ref_store '%s' initialized twice", type, name);
1705 struct ref_store *get_submodule_ref_store(const char *submodule)
1707 struct strbuf submodule_sb = STRBUF_INIT;
1708 struct ref_store *refs;
1709 char *to_free = NULL;
1715 len = strlen(submodule);
1716 while (len && is_dir_sep(submodule[len - 1]))
1722 /* We need to strip off one or more trailing slashes */
1723 submodule = to_free = xmemdupz(submodule, len);
1725 refs = lookup_ref_store_map(&submodule_ref_stores, submodule);
1729 strbuf_addstr(&submodule_sb, submodule);
1730 if (!is_nonbare_repository_dir(&submodule_sb))
1733 if (submodule_to_gitdir(&submodule_sb, submodule))
1736 /* assume that add_submodule_odb() has been called */
1737 refs = ref_store_init(submodule_sb.buf,
1738 REF_STORE_READ | REF_STORE_ODB);
1739 register_ref_store_map(&submodule_ref_stores, "submodule",
1743 strbuf_release(&submodule_sb);
1749 struct ref_store *get_worktree_ref_store(const struct worktree *wt)
1751 struct ref_store *refs;
1755 return get_main_ref_store(the_repository);
1757 id = wt->id ? wt->id : "/";
1758 refs = lookup_ref_store_map(&worktree_ref_stores, id);
1763 refs = ref_store_init(git_common_path("worktrees/%s", wt->id),
1764 REF_STORE_ALL_CAPS);
1766 refs = ref_store_init(get_git_common_dir(),
1767 REF_STORE_ALL_CAPS);
1770 register_ref_store_map(&worktree_ref_stores, "worktree",
1775 void base_ref_store_init(struct ref_store *refs,
1776 const struct ref_storage_be *be)
1781 /* backend functions */
1782 int refs_pack_refs(struct ref_store *refs, unsigned int flags)
1784 return refs->be->pack_refs(refs, flags);
1787 int refs_peel_ref(struct ref_store *refs, const char *refname,
1788 struct object_id *oid)
1791 struct object_id base;
1793 if (current_ref_iter && current_ref_iter->refname == refname) {
1794 struct object_id peeled;
1796 if (ref_iterator_peel(current_ref_iter, &peeled))
1798 oidcpy(oid, &peeled);
1802 if (refs_read_ref_full(refs, refname,
1803 RESOLVE_REF_READING, &base, &flag))
1806 return peel_object(&base, oid);
1809 int peel_ref(const char *refname, struct object_id *oid)
1811 return refs_peel_ref(get_main_ref_store(the_repository), refname, oid);
1814 int refs_create_symref(struct ref_store *refs,
1815 const char *ref_target,
1816 const char *refs_heads_master,
1819 return refs->be->create_symref(refs, ref_target,
1824 int create_symref(const char *ref_target, const char *refs_heads_master,
1827 return refs_create_symref(get_main_ref_store(the_repository), ref_target,
1828 refs_heads_master, logmsg);
1831 int ref_update_reject_duplicates(struct string_list *refnames,
1834 size_t i, n = refnames->nr;
1838 for (i = 1; i < n; i++) {
1839 int cmp = strcmp(refnames->items[i - 1].string,
1840 refnames->items[i].string);
1844 "multiple updates for ref '%s' not allowed.",
1845 refnames->items[i].string);
1847 } else if (cmp > 0) {
1848 BUG("ref_update_reject_duplicates() received unsorted list");
1854 int ref_transaction_prepare(struct ref_transaction *transaction,
1857 struct ref_store *refs = transaction->ref_store;
1859 switch (transaction->state) {
1860 case REF_TRANSACTION_OPEN:
1863 case REF_TRANSACTION_PREPARED:
1864 BUG("prepare called twice on reference transaction");
1866 case REF_TRANSACTION_CLOSED:
1867 BUG("prepare called on a closed reference transaction");
1870 BUG("unexpected reference transaction state");
1874 if (getenv(GIT_QUARANTINE_ENVIRONMENT)) {
1876 _("ref updates forbidden inside quarantine environment"));
1880 return refs->be->transaction_prepare(refs, transaction, err);
1883 int ref_transaction_abort(struct ref_transaction *transaction,
1886 struct ref_store *refs = transaction->ref_store;
1889 switch (transaction->state) {
1890 case REF_TRANSACTION_OPEN:
1891 /* No need to abort explicitly. */
1893 case REF_TRANSACTION_PREPARED:
1894 ret = refs->be->transaction_abort(refs, transaction, err);
1896 case REF_TRANSACTION_CLOSED:
1897 BUG("abort called on a closed reference transaction");
1900 BUG("unexpected reference transaction state");
1904 ref_transaction_free(transaction);
1908 int ref_transaction_commit(struct ref_transaction *transaction,
1911 struct ref_store *refs = transaction->ref_store;
1914 switch (transaction->state) {
1915 case REF_TRANSACTION_OPEN:
1916 /* Need to prepare first. */
1917 ret = ref_transaction_prepare(transaction, err);
1921 case REF_TRANSACTION_PREPARED:
1922 /* Fall through to finish. */
1924 case REF_TRANSACTION_CLOSED:
1925 BUG("commit called on a closed reference transaction");
1928 BUG("unexpected reference transaction state");
1932 return refs->be->transaction_finish(refs, transaction, err);
1935 int refs_verify_refname_available(struct ref_store *refs,
1936 const char *refname,
1937 const struct string_list *extras,
1938 const struct string_list *skip,
1942 const char *extra_refname;
1943 struct strbuf dirname = STRBUF_INIT;
1944 struct strbuf referent = STRBUF_INIT;
1945 struct object_id oid;
1947 struct ref_iterator *iter;
1952 * For the sake of comments in this function, suppose that
1953 * refname is "refs/foo/bar".
1958 strbuf_grow(&dirname, strlen(refname) + 1);
1959 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
1960 /* Expand dirname to the new prefix, not including the trailing slash: */
1961 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);
1964 * We are still at a leading dir of the refname (e.g.,
1965 * "refs/foo"; if there is a reference with that name,
1966 * it is a conflict, *unless* it is in skip.
1968 if (skip && string_list_has_string(skip, dirname.buf))
1971 if (!refs_read_raw_ref(refs, dirname.buf, &oid, &referent, &type)) {
1972 strbuf_addf(err, "'%s' exists; cannot create '%s'",
1973 dirname.buf, refname);
1977 if (extras && string_list_has_string(extras, dirname.buf)) {
1978 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
1979 refname, dirname.buf);
1985 * We are at the leaf of our refname (e.g., "refs/foo/bar").
1986 * There is no point in searching for a reference with that
1987 * name, because a refname isn't considered to conflict with
1988 * itself. But we still need to check for references whose
1989 * names are in the "refs/foo/bar/" namespace, because they
1992 strbuf_addstr(&dirname, refname + dirname.len);
1993 strbuf_addch(&dirname, '/');
1995 iter = refs_ref_iterator_begin(refs, dirname.buf, 0,
1996 DO_FOR_EACH_INCLUDE_BROKEN);
1997 while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
1999 string_list_has_string(skip, iter->refname))
2002 strbuf_addf(err, "'%s' exists; cannot create '%s'",
2003 iter->refname, refname);
2004 ref_iterator_abort(iter);
2008 if (ok != ITER_DONE)
2009 BUG("error while iterating over references");
2011 extra_refname = find_descendant_ref(dirname.buf, extras, skip);
2013 strbuf_addf(err, "cannot process '%s' and '%s' at the same time",
2014 refname, extra_refname);
2019 strbuf_release(&referent);
2020 strbuf_release(&dirname);
2024 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data)
2026 struct ref_iterator *iter;
2028 iter = refs->be->reflog_iterator_begin(refs);
2030 return do_for_each_ref_iterator(iter, fn, cb_data);
2033 int for_each_reflog(each_ref_fn fn, void *cb_data)
2035 return refs_for_each_reflog(get_main_ref_store(the_repository), fn, cb_data);
2038 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
2039 const char *refname,
2040 each_reflog_ent_fn fn,
2043 return refs->be->for_each_reflog_ent_reverse(refs, refname,
2047 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn,
2050 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository),
2051 refname, fn, cb_data);
2054 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
2055 each_reflog_ent_fn fn, void *cb_data)
2057 return refs->be->for_each_reflog_ent(refs, refname, fn, cb_data);
2060 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn,
2063 return refs_for_each_reflog_ent(get_main_ref_store(the_repository), refname,
2067 int refs_reflog_exists(struct ref_store *refs, const char *refname)
2069 return refs->be->reflog_exists(refs, refname);
2072 int reflog_exists(const char *refname)
2074 return refs_reflog_exists(get_main_ref_store(the_repository), refname);
2077 int refs_create_reflog(struct ref_store *refs, const char *refname,
2078 int force_create, struct strbuf *err)
2080 return refs->be->create_reflog(refs, refname, force_create, err);
2083 int safe_create_reflog(const char *refname, int force_create,
2086 return refs_create_reflog(get_main_ref_store(the_repository), refname,
2090 int refs_delete_reflog(struct ref_store *refs, const char *refname)
2092 return refs->be->delete_reflog(refs, refname);
2095 int delete_reflog(const char *refname)
2097 return refs_delete_reflog(get_main_ref_store(the_repository), refname);
2100 int refs_reflog_expire(struct ref_store *refs,
2101 const char *refname, const struct object_id *oid,
2103 reflog_expiry_prepare_fn prepare_fn,
2104 reflog_expiry_should_prune_fn should_prune_fn,
2105 reflog_expiry_cleanup_fn cleanup_fn,
2106 void *policy_cb_data)
2108 return refs->be->reflog_expire(refs, refname, oid, flags,
2109 prepare_fn, should_prune_fn,
2110 cleanup_fn, policy_cb_data);
2113 int reflog_expire(const char *refname, const struct object_id *oid,
2115 reflog_expiry_prepare_fn prepare_fn,
2116 reflog_expiry_should_prune_fn should_prune_fn,
2117 reflog_expiry_cleanup_fn cleanup_fn,
2118 void *policy_cb_data)
2120 return refs_reflog_expire(get_main_ref_store(the_repository),
2121 refname, oid, flags,
2122 prepare_fn, should_prune_fn,
2123 cleanup_fn, policy_cb_data);
2126 int initial_ref_transaction_commit(struct ref_transaction *transaction,
2129 struct ref_store *refs = transaction->ref_store;
2131 return refs->be->initial_transaction_commit(refs, transaction, err);
2134 int refs_delete_refs(struct ref_store *refs, const char *msg,
2135 struct string_list *refnames, unsigned int flags)
2137 return refs->be->delete_refs(refs, msg, refnames, flags);
2140 int delete_refs(const char *msg, struct string_list *refnames,
2143 return refs_delete_refs(get_main_ref_store(the_repository), msg, refnames, flags);
2146 int refs_rename_ref(struct ref_store *refs, const char *oldref,
2147 const char *newref, const char *logmsg)
2149 return refs->be->rename_ref(refs, oldref, newref, logmsg);
2152 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
2154 return refs_rename_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);
2157 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
2158 const char *newref, const char *logmsg)
2160 return refs->be->copy_ref(refs, oldref, newref, logmsg);
2163 int copy_existing_ref(const char *oldref, const char *newref, const char *logmsg)
2165 return refs_copy_existing_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);