l10n: bg.po: Updated Bulgarian translation (5482t)
[alt-git.git] / refs.c
blobc89d558892569b6326d092eb61a7bba28ef4b3d4
1 /*
2 * The backend-independent part of the reference module.
3 */
5 #include "cache.h"
6 #include "config.h"
7 #include "hashmap.h"
8 #include "lockfile.h"
9 #include "iterator.h"
10 #include "refs.h"
11 #include "refs/refs-internal.h"
12 #include "run-command.h"
13 #include "hook.h"
14 #include "object-store.h"
15 #include "object.h"
16 #include "tag.h"
17 #include "submodule.h"
18 #include "worktree.h"
19 #include "strvec.h"
20 #include "repository.h"
21 #include "sigchain.h"
22 #include "date.h"
23 #include "commit.h"
26 * List of all available backends
28 static struct ref_storage_be *refs_backends = &refs_be_files;
30 static struct ref_storage_be *find_ref_storage_backend(const char *name)
32 struct ref_storage_be *be;
33 for (be = refs_backends; be; be = be->next)
34 if (!strcmp(be->name, name))
35 return be;
36 return NULL;
40 * How to handle various characters in refnames:
41 * 0: An acceptable character for refs
42 * 1: End-of-component
43 * 2: ., look for a preceding . to reject .. in refs
44 * 3: {, look for a preceding @ to reject @{ in refs
45 * 4: A bad character: ASCII control characters, and
46 * ":", "?", "[", "\", "^", "~", SP, or TAB
47 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
49 static unsigned char refname_disposition[256] = {
50 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
51 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
52 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
53 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
54 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
55 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
56 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
57 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
60 struct ref_namespace_info ref_namespace[] = {
61 [NAMESPACE_HEAD] = {
62 .ref = "HEAD",
63 .decoration = DECORATION_REF_HEAD,
64 .exact = 1,
66 [NAMESPACE_BRANCHES] = {
67 .ref = "refs/heads/",
68 .decoration = DECORATION_REF_LOCAL,
70 [NAMESPACE_TAGS] = {
71 .ref = "refs/tags/",
72 .decoration = DECORATION_REF_TAG,
74 [NAMESPACE_REMOTE_REFS] = {
76 * The default refspec for new remotes copies refs from
77 * refs/heads/ on the remote into refs/remotes/<remote>/.
78 * As such, "refs/remotes/" has special handling.
80 .ref = "refs/remotes/",
81 .decoration = DECORATION_REF_REMOTE,
83 [NAMESPACE_STASH] = {
85 * The single ref "refs/stash" stores the latest stash.
86 * Older stashes can be found in the reflog.
88 .ref = "refs/stash",
89 .exact = 1,
90 .decoration = DECORATION_REF_STASH,
92 [NAMESPACE_REPLACE] = {
94 * This namespace allows Git to act as if one object ID
95 * points to the content of another. Unlike the other
96 * ref namespaces, this one can be changed by the
97 * GIT_REPLACE_REF_BASE environment variable. This
98 * .namespace value will be overwritten in setup_git_env().
100 .ref = "refs/replace/",
101 .decoration = DECORATION_GRAFTED,
103 [NAMESPACE_NOTES] = {
105 * The refs/notes/commit ref points to the tip of a
106 * parallel commit history that adds metadata to commits
107 * in the normal history. This ref can be overwritten
108 * by the core.notesRef config variable or the
109 * GIT_NOTES_REFS environment variable.
111 .ref = "refs/notes/commit",
112 .exact = 1,
114 [NAMESPACE_PREFETCH] = {
116 * Prefetch refs are written by the background 'fetch'
117 * maintenance task. It allows faster foreground fetches
118 * by advertising these previously-downloaded tips without
119 * updating refs/remotes/ without user intervention.
121 .ref = "refs/prefetch/",
123 [NAMESPACE_REWRITTEN] = {
125 * Rewritten refs are used by the 'label' command in the
126 * sequencer. These are particularly useful during an
127 * interactive rebase that uses the 'merge' command.
129 .ref = "refs/rewritten/",
133 void update_ref_namespace(enum ref_namespace namespace, char *ref)
135 struct ref_namespace_info *info = &ref_namespace[namespace];
136 if (info->ref_updated)
137 free(info->ref);
138 info->ref = ref;
139 info->ref_updated = 1;
143 * Try to read one refname component from the front of refname.
144 * Return the length of the component found, or -1 if the component is
145 * not legal. It is legal if it is something reasonable to have under
146 * ".git/refs/"; We do not like it if:
148 * - it begins with ".", or
149 * - it has double dots "..", or
150 * - it has ASCII control characters, or
151 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
152 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
153 * - it ends with a "/", or
154 * - it ends with ".lock", or
155 * - it contains a "@{" portion
157 * When sanitized is not NULL, instead of rejecting the input refname
158 * as an error, try to come up with a usable replacement for the input
159 * refname in it.
161 static int check_refname_component(const char *refname, int *flags,
162 struct strbuf *sanitized)
164 const char *cp;
165 char last = '\0';
166 size_t component_start = 0; /* garbage - not a reasonable initial value */
168 if (sanitized)
169 component_start = sanitized->len;
171 for (cp = refname; ; cp++) {
172 int ch = *cp & 255;
173 unsigned char disp = refname_disposition[ch];
175 if (sanitized && disp != 1)
176 strbuf_addch(sanitized, ch);
178 switch (disp) {
179 case 1:
180 goto out;
181 case 2:
182 if (last == '.') { /* Refname contains "..". */
183 if (sanitized)
184 /* collapse ".." to single "." */
185 strbuf_setlen(sanitized, sanitized->len - 1);
186 else
187 return -1;
189 break;
190 case 3:
191 if (last == '@') { /* Refname contains "@{". */
192 if (sanitized)
193 sanitized->buf[sanitized->len-1] = '-';
194 else
195 return -1;
197 break;
198 case 4:
199 /* forbidden char */
200 if (sanitized)
201 sanitized->buf[sanitized->len-1] = '-';
202 else
203 return -1;
204 break;
205 case 5:
206 if (!(*flags & REFNAME_REFSPEC_PATTERN)) {
207 /* refspec can't be a pattern */
208 if (sanitized)
209 sanitized->buf[sanitized->len-1] = '-';
210 else
211 return -1;
215 * Unset the pattern flag so that we only accept
216 * a single asterisk for one side of refspec.
218 *flags &= ~ REFNAME_REFSPEC_PATTERN;
219 break;
221 last = ch;
223 out:
224 if (cp == refname)
225 return 0; /* Component has zero length. */
227 if (refname[0] == '.') { /* Component starts with '.'. */
228 if (sanitized)
229 sanitized->buf[component_start] = '-';
230 else
231 return -1;
233 if (cp - refname >= LOCK_SUFFIX_LEN &&
234 !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) {
235 if (!sanitized)
236 return -1;
237 /* Refname ends with ".lock". */
238 while (strbuf_strip_suffix(sanitized, LOCK_SUFFIX)) {
239 /* try again in case we have .lock.lock */
242 return cp - refname;
245 static int check_or_sanitize_refname(const char *refname, int flags,
246 struct strbuf *sanitized)
248 int component_len, component_count = 0;
250 if (!strcmp(refname, "@")) {
251 /* Refname is a single character '@'. */
252 if (sanitized)
253 strbuf_addch(sanitized, '-');
254 else
255 return -1;
258 while (1) {
259 if (sanitized && sanitized->len)
260 strbuf_complete(sanitized, '/');
262 /* We are at the start of a path component. */
263 component_len = check_refname_component(refname, &flags,
264 sanitized);
265 if (sanitized && component_len == 0)
266 ; /* OK, omit empty component */
267 else if (component_len <= 0)
268 return -1;
270 component_count++;
271 if (refname[component_len] == '\0')
272 break;
273 /* Skip to next component. */
274 refname += component_len + 1;
277 if (refname[component_len - 1] == '.') {
278 /* Refname ends with '.'. */
279 if (sanitized)
280 ; /* omit ending dot */
281 else
282 return -1;
284 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
285 return -1; /* Refname has only one component. */
286 return 0;
289 int check_refname_format(const char *refname, int flags)
291 return check_or_sanitize_refname(refname, flags, NULL);
294 void sanitize_refname_component(const char *refname, struct strbuf *out)
296 if (check_or_sanitize_refname(refname, REFNAME_ALLOW_ONELEVEL, out))
297 BUG("sanitizing refname '%s' check returned error", refname);
300 int refname_is_safe(const char *refname)
302 const char *rest;
304 if (skip_prefix(refname, "refs/", &rest)) {
305 char *buf;
306 int result;
307 size_t restlen = strlen(rest);
309 /* rest must not be empty, or start or end with "/" */
310 if (!restlen || *rest == '/' || rest[restlen - 1] == '/')
311 return 0;
314 * Does the refname try to escape refs/?
315 * For example: refs/foo/../bar is safe but refs/foo/../../bar
316 * is not.
318 buf = xmallocz(restlen);
319 result = !normalize_path_copy(buf, rest) && !strcmp(buf, rest);
320 free(buf);
321 return result;
324 do {
325 if (!isupper(*refname) && *refname != '_')
326 return 0;
327 refname++;
328 } while (*refname);
329 return 1;
333 * Return true if refname, which has the specified oid and flags, can
334 * be resolved to an object in the database. If the referred-to object
335 * does not exist, emit a warning and return false.
337 int ref_resolves_to_object(const char *refname,
338 struct repository *repo,
339 const struct object_id *oid,
340 unsigned int flags)
342 if (flags & REF_ISBROKEN)
343 return 0;
344 if (!repo_has_object_file(repo, oid)) {
345 error(_("%s does not point to a valid object!"), refname);
346 return 0;
348 return 1;
351 char *refs_resolve_refdup(struct ref_store *refs,
352 const char *refname, int resolve_flags,
353 struct object_id *oid, int *flags)
355 const char *result;
357 result = refs_resolve_ref_unsafe(refs, refname, resolve_flags,
358 oid, flags);
359 return xstrdup_or_null(result);
362 char *resolve_refdup(const char *refname, int resolve_flags,
363 struct object_id *oid, int *flags)
365 return refs_resolve_refdup(get_main_ref_store(the_repository),
366 refname, resolve_flags,
367 oid, flags);
370 /* The argument to filter_refs */
371 struct ref_filter {
372 const char *pattern;
373 const char *prefix;
374 each_ref_fn *fn;
375 void *cb_data;
378 int read_ref_full(const char *refname, int resolve_flags, struct object_id *oid, int *flags)
380 struct ref_store *refs = get_main_ref_store(the_repository);
382 if (refs_resolve_ref_unsafe(refs, refname, resolve_flags,
383 oid, flags))
384 return 0;
385 return -1;
388 int read_ref(const char *refname, struct object_id *oid)
390 return read_ref_full(refname, RESOLVE_REF_READING, oid, NULL);
393 int refs_ref_exists(struct ref_store *refs, const char *refname)
395 return !!refs_resolve_ref_unsafe(refs, refname, RESOLVE_REF_READING,
396 NULL, NULL);
399 int ref_exists(const char *refname)
401 return refs_ref_exists(get_main_ref_store(the_repository), refname);
404 static int filter_refs(const char *refname, const struct object_id *oid,
405 int flags, void *data)
407 struct ref_filter *filter = (struct ref_filter *)data;
409 if (wildmatch(filter->pattern, refname, 0))
410 return 0;
411 if (filter->prefix)
412 skip_prefix(refname, filter->prefix, &refname);
413 return filter->fn(refname, oid, flags, filter->cb_data);
416 enum peel_status peel_object(const struct object_id *name, struct object_id *oid)
418 struct object *o = lookup_unknown_object(the_repository, name);
420 if (o->type == OBJ_NONE) {
421 int type = oid_object_info(the_repository, name, NULL);
422 if (type < 0 || !object_as_type(o, type, 0))
423 return PEEL_INVALID;
426 if (o->type != OBJ_TAG)
427 return PEEL_NON_TAG;
429 o = deref_tag_noverify(o);
430 if (!o)
431 return PEEL_INVALID;
433 oidcpy(oid, &o->oid);
434 return PEEL_PEELED;
437 struct warn_if_dangling_data {
438 FILE *fp;
439 const char *refname;
440 const struct string_list *refnames;
441 const char *msg_fmt;
444 static int warn_if_dangling_symref(const char *refname,
445 const struct object_id *oid UNUSED,
446 int flags, void *cb_data)
448 struct warn_if_dangling_data *d = cb_data;
449 const char *resolves_to;
451 if (!(flags & REF_ISSYMREF))
452 return 0;
454 resolves_to = resolve_ref_unsafe(refname, 0, NULL, NULL);
455 if (!resolves_to
456 || (d->refname
457 ? strcmp(resolves_to, d->refname)
458 : !string_list_has_string(d->refnames, resolves_to))) {
459 return 0;
462 fprintf(d->fp, d->msg_fmt, refname);
463 fputc('\n', d->fp);
464 return 0;
467 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
469 struct warn_if_dangling_data data;
471 data.fp = fp;
472 data.refname = refname;
473 data.refnames = NULL;
474 data.msg_fmt = msg_fmt;
475 for_each_rawref(warn_if_dangling_symref, &data);
478 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
480 struct warn_if_dangling_data data;
482 data.fp = fp;
483 data.refname = NULL;
484 data.refnames = refnames;
485 data.msg_fmt = msg_fmt;
486 for_each_rawref(warn_if_dangling_symref, &data);
489 int refs_for_each_tag_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
491 return refs_for_each_ref_in(refs, "refs/tags/", fn, cb_data);
494 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
496 return refs_for_each_tag_ref(get_main_ref_store(the_repository), fn, cb_data);
499 int refs_for_each_branch_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
501 return refs_for_each_ref_in(refs, "refs/heads/", fn, cb_data);
504 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
506 return refs_for_each_branch_ref(get_main_ref_store(the_repository), fn, cb_data);
509 int refs_for_each_remote_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
511 return refs_for_each_ref_in(refs, "refs/remotes/", fn, cb_data);
514 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
516 return refs_for_each_remote_ref(get_main_ref_store(the_repository), fn, cb_data);
519 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
521 struct strbuf buf = STRBUF_INIT;
522 int ret = 0;
523 struct object_id oid;
524 int flag;
526 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
527 if (!read_ref_full(buf.buf, RESOLVE_REF_READING, &oid, &flag))
528 ret = fn(buf.buf, &oid, flag, cb_data);
529 strbuf_release(&buf);
531 return ret;
534 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
535 const char *pattern)
537 struct strbuf normalized_pattern = STRBUF_INIT;
539 if (*pattern == '/')
540 BUG("pattern must not start with '/'");
542 if (prefix)
543 strbuf_addstr(&normalized_pattern, prefix);
544 else if (!starts_with(pattern, "refs/") &&
545 strcmp(pattern, "HEAD"))
546 strbuf_addstr(&normalized_pattern, "refs/");
548 * NEEDSWORK: Special case other symrefs such as REBASE_HEAD,
549 * MERGE_HEAD, etc.
552 strbuf_addstr(&normalized_pattern, pattern);
553 strbuf_strip_suffix(&normalized_pattern, "/");
555 item->string = strbuf_detach(&normalized_pattern, NULL);
556 item->util = has_glob_specials(pattern) ? NULL : item->string;
557 strbuf_release(&normalized_pattern);
560 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
561 const char *prefix, void *cb_data)
563 struct strbuf real_pattern = STRBUF_INIT;
564 struct ref_filter filter;
565 int ret;
567 if (!prefix && !starts_with(pattern, "refs/"))
568 strbuf_addstr(&real_pattern, "refs/");
569 else if (prefix)
570 strbuf_addstr(&real_pattern, prefix);
571 strbuf_addstr(&real_pattern, pattern);
573 if (!has_glob_specials(pattern)) {
574 /* Append implied '/' '*' if not present. */
575 strbuf_complete(&real_pattern, '/');
576 /* No need to check for '*', there is none. */
577 strbuf_addch(&real_pattern, '*');
580 filter.pattern = real_pattern.buf;
581 filter.prefix = prefix;
582 filter.fn = fn;
583 filter.cb_data = cb_data;
584 ret = for_each_ref(filter_refs, &filter);
586 strbuf_release(&real_pattern);
587 return ret;
590 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
592 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
595 const char *prettify_refname(const char *name)
597 if (skip_prefix(name, "refs/heads/", &name) ||
598 skip_prefix(name, "refs/tags/", &name) ||
599 skip_prefix(name, "refs/remotes/", &name))
600 ; /* nothing */
601 return name;
604 static const char *ref_rev_parse_rules[] = {
605 "%.*s",
606 "refs/%.*s",
607 "refs/tags/%.*s",
608 "refs/heads/%.*s",
609 "refs/remotes/%.*s",
610 "refs/remotes/%.*s/HEAD",
611 NULL
614 #define NUM_REV_PARSE_RULES (ARRAY_SIZE(ref_rev_parse_rules) - 1)
617 * Is it possible that the caller meant full_name with abbrev_name?
618 * If so return a non-zero value to signal "yes"; the magnitude of
619 * the returned value gives the precedence used for disambiguation.
621 * If abbrev_name cannot mean full_name, return 0.
623 int refname_match(const char *abbrev_name, const char *full_name)
625 const char **p;
626 const int abbrev_name_len = strlen(abbrev_name);
627 const int num_rules = NUM_REV_PARSE_RULES;
629 for (p = ref_rev_parse_rules; *p; p++)
630 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name)))
631 return &ref_rev_parse_rules[num_rules] - p;
633 return 0;
637 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
638 * the results to 'prefixes'
640 void expand_ref_prefix(struct strvec *prefixes, const char *prefix)
642 const char **p;
643 int len = strlen(prefix);
645 for (p = ref_rev_parse_rules; *p; p++)
646 strvec_pushf(prefixes, *p, len, prefix);
649 static const char default_branch_name_advice[] = N_(
650 "Using '%s' as the name for the initial branch. This default branch name\n"
651 "is subject to change. To configure the initial branch name to use in all\n"
652 "of your new repositories, which will suppress this warning, call:\n"
653 "\n"
654 "\tgit config --global init.defaultBranch <name>\n"
655 "\n"
656 "Names commonly chosen instead of 'master' are 'main', 'trunk' and\n"
657 "'development'. The just-created branch can be renamed via this command:\n"
658 "\n"
659 "\tgit branch -m <name>\n"
662 char *repo_default_branch_name(struct repository *r, int quiet)
664 const char *config_key = "init.defaultbranch";
665 const char *config_display_key = "init.defaultBranch";
666 char *ret = NULL, *full_ref;
667 const char *env = getenv("GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME");
669 if (env && *env)
670 ret = xstrdup(env);
671 else if (repo_config_get_string(r, config_key, &ret) < 0)
672 die(_("could not retrieve `%s`"), config_display_key);
674 if (!ret) {
675 ret = xstrdup("master");
676 if (!quiet)
677 advise(_(default_branch_name_advice), ret);
680 full_ref = xstrfmt("refs/heads/%s", ret);
681 if (check_refname_format(full_ref, 0))
682 die(_("invalid branch name: %s = %s"), config_display_key, ret);
683 free(full_ref);
685 return ret;
688 const char *git_default_branch_name(int quiet)
690 static char *ret;
692 if (!ret)
693 ret = repo_default_branch_name(the_repository, quiet);
695 return ret;
699 * *string and *len will only be substituted, and *string returned (for
700 * later free()ing) if the string passed in is a magic short-hand form
701 * to name a branch.
703 static char *substitute_branch_name(struct repository *r,
704 const char **string, int *len,
705 int nonfatal_dangling_mark)
707 struct strbuf buf = STRBUF_INIT;
708 struct interpret_branch_name_options options = {
709 .nonfatal_dangling_mark = nonfatal_dangling_mark
711 int ret = repo_interpret_branch_name(r, *string, *len, &buf, &options);
713 if (ret == *len) {
714 size_t size;
715 *string = strbuf_detach(&buf, &size);
716 *len = size;
717 return (char *)*string;
720 return NULL;
723 int repo_dwim_ref(struct repository *r, const char *str, int len,
724 struct object_id *oid, char **ref, int nonfatal_dangling_mark)
726 char *last_branch = substitute_branch_name(r, &str, &len,
727 nonfatal_dangling_mark);
728 int refs_found = expand_ref(r, str, len, oid, ref);
729 free(last_branch);
730 return refs_found;
733 int expand_ref(struct repository *repo, const char *str, int len,
734 struct object_id *oid, char **ref)
736 const char **p, *r;
737 int refs_found = 0;
738 struct strbuf fullref = STRBUF_INIT;
740 *ref = NULL;
741 for (p = ref_rev_parse_rules; *p; p++) {
742 struct object_id oid_from_ref;
743 struct object_id *this_result;
744 int flag;
745 struct ref_store *refs = get_main_ref_store(repo);
747 this_result = refs_found ? &oid_from_ref : oid;
748 strbuf_reset(&fullref);
749 strbuf_addf(&fullref, *p, len, str);
750 r = refs_resolve_ref_unsafe(refs, fullref.buf,
751 RESOLVE_REF_READING,
752 this_result, &flag);
753 if (r) {
754 if (!refs_found++)
755 *ref = xstrdup(r);
756 if (!warn_ambiguous_refs)
757 break;
758 } else if ((flag & REF_ISSYMREF) && strcmp(fullref.buf, "HEAD")) {
759 warning(_("ignoring dangling symref %s"), fullref.buf);
760 } else if ((flag & REF_ISBROKEN) && strchr(fullref.buf, '/')) {
761 warning(_("ignoring broken ref %s"), fullref.buf);
764 strbuf_release(&fullref);
765 return refs_found;
768 int repo_dwim_log(struct repository *r, const char *str, int len,
769 struct object_id *oid, char **log)
771 struct ref_store *refs = get_main_ref_store(r);
772 char *last_branch = substitute_branch_name(r, &str, &len, 0);
773 const char **p;
774 int logs_found = 0;
775 struct strbuf path = STRBUF_INIT;
777 *log = NULL;
778 for (p = ref_rev_parse_rules; *p; p++) {
779 struct object_id hash;
780 const char *ref, *it;
782 strbuf_reset(&path);
783 strbuf_addf(&path, *p, len, str);
784 ref = refs_resolve_ref_unsafe(refs, path.buf,
785 RESOLVE_REF_READING,
786 oid ? &hash : NULL, NULL);
787 if (!ref)
788 continue;
789 if (refs_reflog_exists(refs, path.buf))
790 it = path.buf;
791 else if (strcmp(ref, path.buf) &&
792 refs_reflog_exists(refs, ref))
793 it = ref;
794 else
795 continue;
796 if (!logs_found++) {
797 *log = xstrdup(it);
798 if (oid)
799 oidcpy(oid, &hash);
801 if (!warn_ambiguous_refs)
802 break;
804 strbuf_release(&path);
805 free(last_branch);
806 return logs_found;
809 int dwim_log(const char *str, int len, struct object_id *oid, char **log)
811 return repo_dwim_log(the_repository, str, len, oid, log);
814 static int is_per_worktree_ref(const char *refname)
816 return starts_with(refname, "refs/worktree/") ||
817 starts_with(refname, "refs/bisect/") ||
818 starts_with(refname, "refs/rewritten/");
821 static int is_pseudoref_syntax(const char *refname)
823 const char *c;
825 for (c = refname; *c; c++) {
826 if (!isupper(*c) && *c != '-' && *c != '_')
827 return 0;
830 return 1;
833 static int is_main_pseudoref_syntax(const char *refname)
835 return skip_prefix(refname, "main-worktree/", &refname) &&
836 *refname &&
837 is_pseudoref_syntax(refname);
840 static int is_other_pseudoref_syntax(const char *refname)
842 if (!skip_prefix(refname, "worktrees/", &refname))
843 return 0;
844 refname = strchr(refname, '/');
845 if (!refname || !refname[1])
846 return 0;
847 return is_pseudoref_syntax(refname + 1);
850 enum ref_type ref_type(const char *refname)
852 if (is_per_worktree_ref(refname))
853 return REF_TYPE_PER_WORKTREE;
854 if (is_pseudoref_syntax(refname))
855 return REF_TYPE_PSEUDOREF;
856 if (is_main_pseudoref_syntax(refname))
857 return REF_TYPE_MAIN_PSEUDOREF;
858 if (is_other_pseudoref_syntax(refname))
859 return REF_TYPE_OTHER_PSEUDOREF;
860 return REF_TYPE_NORMAL;
863 long get_files_ref_lock_timeout_ms(void)
865 static int configured = 0;
867 /* The default timeout is 100 ms: */
868 static int timeout_ms = 100;
870 if (!configured) {
871 git_config_get_int("core.filesreflocktimeout", &timeout_ms);
872 configured = 1;
875 return timeout_ms;
878 int refs_delete_ref(struct ref_store *refs, const char *msg,
879 const char *refname,
880 const struct object_id *old_oid,
881 unsigned int flags)
883 struct ref_transaction *transaction;
884 struct strbuf err = STRBUF_INIT;
886 transaction = ref_store_transaction_begin(refs, &err);
887 if (!transaction ||
888 ref_transaction_delete(transaction, refname, old_oid,
889 flags, msg, &err) ||
890 ref_transaction_commit(transaction, &err)) {
891 error("%s", err.buf);
892 ref_transaction_free(transaction);
893 strbuf_release(&err);
894 return 1;
896 ref_transaction_free(transaction);
897 strbuf_release(&err);
898 return 0;
901 int delete_ref(const char *msg, const char *refname,
902 const struct object_id *old_oid, unsigned int flags)
904 return refs_delete_ref(get_main_ref_store(the_repository), msg, refname,
905 old_oid, flags);
908 static void copy_reflog_msg(struct strbuf *sb, const char *msg)
910 char c;
911 int wasspace = 1;
913 while ((c = *msg++)) {
914 if (wasspace && isspace(c))
915 continue;
916 wasspace = isspace(c);
917 if (wasspace)
918 c = ' ';
919 strbuf_addch(sb, c);
921 strbuf_rtrim(sb);
924 static char *normalize_reflog_message(const char *msg)
926 struct strbuf sb = STRBUF_INIT;
928 if (msg && *msg)
929 copy_reflog_msg(&sb, msg);
930 return strbuf_detach(&sb, NULL);
933 int should_autocreate_reflog(const char *refname)
935 switch (log_all_ref_updates) {
936 case LOG_REFS_ALWAYS:
937 return 1;
938 case LOG_REFS_NORMAL:
939 return starts_with(refname, "refs/heads/") ||
940 starts_with(refname, "refs/remotes/") ||
941 starts_with(refname, "refs/notes/") ||
942 !strcmp(refname, "HEAD");
943 default:
944 return 0;
948 int is_branch(const char *refname)
950 return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
953 struct read_ref_at_cb {
954 const char *refname;
955 timestamp_t at_time;
956 int cnt;
957 int reccnt;
958 struct object_id *oid;
959 int found_it;
961 struct object_id ooid;
962 struct object_id noid;
963 int tz;
964 timestamp_t date;
965 char **msg;
966 timestamp_t *cutoff_time;
967 int *cutoff_tz;
968 int *cutoff_cnt;
971 static void set_read_ref_cutoffs(struct read_ref_at_cb *cb,
972 timestamp_t timestamp, int tz, const char *message)
974 if (cb->msg)
975 *cb->msg = xstrdup(message);
976 if (cb->cutoff_time)
977 *cb->cutoff_time = timestamp;
978 if (cb->cutoff_tz)
979 *cb->cutoff_tz = tz;
980 if (cb->cutoff_cnt)
981 *cb->cutoff_cnt = cb->reccnt;
984 static int read_ref_at_ent(struct object_id *ooid, struct object_id *noid,
985 const char *email UNUSED,
986 timestamp_t timestamp, int tz,
987 const char *message, void *cb_data)
989 struct read_ref_at_cb *cb = cb_data;
990 int reached_count;
992 cb->tz = tz;
993 cb->date = timestamp;
996 * It is not possible for cb->cnt == 0 on the first iteration because
997 * that special case is handled in read_ref_at().
999 if (cb->cnt > 0)
1000 cb->cnt--;
1001 reached_count = cb->cnt == 0 && !is_null_oid(ooid);
1002 if (timestamp <= cb->at_time || reached_count) {
1003 set_read_ref_cutoffs(cb, timestamp, tz, message);
1005 * we have not yet updated cb->[n|o]oid so they still
1006 * hold the values for the previous record.
1008 if (!is_null_oid(&cb->ooid) && !oideq(&cb->ooid, noid))
1009 warning(_("log for ref %s has gap after %s"),
1010 cb->refname, show_date(cb->date, cb->tz, DATE_MODE(RFC2822)));
1011 if (reached_count)
1012 oidcpy(cb->oid, ooid);
1013 else if (!is_null_oid(&cb->ooid) || cb->date == cb->at_time)
1014 oidcpy(cb->oid, noid);
1015 else if (!oideq(noid, cb->oid))
1016 warning(_("log for ref %s unexpectedly ended on %s"),
1017 cb->refname, show_date(cb->date, cb->tz,
1018 DATE_MODE(RFC2822)));
1019 cb->found_it = 1;
1021 cb->reccnt++;
1022 oidcpy(&cb->ooid, ooid);
1023 oidcpy(&cb->noid, noid);
1024 return cb->found_it;
1027 static int read_ref_at_ent_newest(struct object_id *ooid UNUSED,
1028 struct object_id *noid,
1029 const char *email UNUSED,
1030 timestamp_t timestamp, int tz,
1031 const char *message, void *cb_data)
1033 struct read_ref_at_cb *cb = cb_data;
1035 set_read_ref_cutoffs(cb, timestamp, tz, message);
1036 oidcpy(cb->oid, noid);
1037 /* We just want the first entry */
1038 return 1;
1041 static int read_ref_at_ent_oldest(struct object_id *ooid, struct object_id *noid,
1042 const char *email UNUSED,
1043 timestamp_t timestamp, int tz,
1044 const char *message, void *cb_data)
1046 struct read_ref_at_cb *cb = cb_data;
1048 set_read_ref_cutoffs(cb, timestamp, tz, message);
1049 oidcpy(cb->oid, ooid);
1050 if (is_null_oid(cb->oid))
1051 oidcpy(cb->oid, noid);
1052 /* We just want the first entry */
1053 return 1;
1056 int read_ref_at(struct ref_store *refs, const char *refname,
1057 unsigned int flags, timestamp_t at_time, int cnt,
1058 struct object_id *oid, char **msg,
1059 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1061 struct read_ref_at_cb cb;
1063 memset(&cb, 0, sizeof(cb));
1064 cb.refname = refname;
1065 cb.at_time = at_time;
1066 cb.cnt = cnt;
1067 cb.msg = msg;
1068 cb.cutoff_time = cutoff_time;
1069 cb.cutoff_tz = cutoff_tz;
1070 cb.cutoff_cnt = cutoff_cnt;
1071 cb.oid = oid;
1073 if (cb.cnt == 0) {
1074 refs_for_each_reflog_ent_reverse(refs, refname, read_ref_at_ent_newest, &cb);
1075 return 0;
1078 refs_for_each_reflog_ent_reverse(refs, refname, read_ref_at_ent, &cb);
1080 if (!cb.reccnt) {
1081 if (flags & GET_OID_QUIETLY)
1082 exit(128);
1083 else
1084 die(_("log for %s is empty"), refname);
1086 if (cb.found_it)
1087 return 0;
1089 refs_for_each_reflog_ent(refs, refname, read_ref_at_ent_oldest, &cb);
1091 return 1;
1094 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
1095 struct strbuf *err)
1097 struct ref_transaction *tr;
1098 assert(err);
1100 CALLOC_ARRAY(tr, 1);
1101 tr->ref_store = refs;
1102 return tr;
1105 struct ref_transaction *ref_transaction_begin(struct strbuf *err)
1107 return ref_store_transaction_begin(get_main_ref_store(the_repository), err);
1110 void ref_transaction_free(struct ref_transaction *transaction)
1112 size_t i;
1114 if (!transaction)
1115 return;
1117 switch (transaction->state) {
1118 case REF_TRANSACTION_OPEN:
1119 case REF_TRANSACTION_CLOSED:
1120 /* OK */
1121 break;
1122 case REF_TRANSACTION_PREPARED:
1123 BUG("free called on a prepared reference transaction");
1124 break;
1125 default:
1126 BUG("unexpected reference transaction state");
1127 break;
1130 for (i = 0; i < transaction->nr; i++) {
1131 free(transaction->updates[i]->msg);
1132 free(transaction->updates[i]);
1134 free(transaction->updates);
1135 free(transaction);
1138 struct ref_update *ref_transaction_add_update(
1139 struct ref_transaction *transaction,
1140 const char *refname, unsigned int flags,
1141 const struct object_id *new_oid,
1142 const struct object_id *old_oid,
1143 const char *msg)
1145 struct ref_update *update;
1147 if (transaction->state != REF_TRANSACTION_OPEN)
1148 BUG("update called for transaction that is not open");
1150 FLEX_ALLOC_STR(update, refname, refname);
1151 ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
1152 transaction->updates[transaction->nr++] = update;
1154 update->flags = flags;
1156 if (flags & REF_HAVE_NEW)
1157 oidcpy(&update->new_oid, new_oid);
1158 if (flags & REF_HAVE_OLD)
1159 oidcpy(&update->old_oid, old_oid);
1160 update->msg = normalize_reflog_message(msg);
1161 return update;
1164 int ref_transaction_update(struct ref_transaction *transaction,
1165 const char *refname,
1166 const struct object_id *new_oid,
1167 const struct object_id *old_oid,
1168 unsigned int flags, const char *msg,
1169 struct strbuf *err)
1171 assert(err);
1173 if (!(flags & REF_SKIP_REFNAME_VERIFICATION) &&
1174 ((new_oid && !is_null_oid(new_oid)) ?
1175 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL) :
1176 !refname_is_safe(refname))) {
1177 strbuf_addf(err, _("refusing to update ref with bad name '%s'"),
1178 refname);
1179 return -1;
1182 if (flags & ~REF_TRANSACTION_UPDATE_ALLOWED_FLAGS)
1183 BUG("illegal flags 0x%x passed to ref_transaction_update()", flags);
1186 * Clear flags outside the allowed set; this should be a noop because
1187 * of the BUG() check above, but it works around a -Wnonnull warning
1188 * with some versions of "gcc -O3".
1190 flags &= REF_TRANSACTION_UPDATE_ALLOWED_FLAGS;
1192 flags |= (new_oid ? REF_HAVE_NEW : 0) | (old_oid ? REF_HAVE_OLD : 0);
1194 ref_transaction_add_update(transaction, refname, flags,
1195 new_oid, old_oid, msg);
1196 return 0;
1199 int ref_transaction_create(struct ref_transaction *transaction,
1200 const char *refname,
1201 const struct object_id *new_oid,
1202 unsigned int flags, const char *msg,
1203 struct strbuf *err)
1205 if (!new_oid || is_null_oid(new_oid)) {
1206 strbuf_addf(err, "'%s' has a null OID", refname);
1207 return 1;
1209 return ref_transaction_update(transaction, refname, new_oid,
1210 null_oid(), flags, msg, err);
1213 int ref_transaction_delete(struct ref_transaction *transaction,
1214 const char *refname,
1215 const struct object_id *old_oid,
1216 unsigned int flags, const char *msg,
1217 struct strbuf *err)
1219 if (old_oid && is_null_oid(old_oid))
1220 BUG("delete called with old_oid set to zeros");
1221 return ref_transaction_update(transaction, refname,
1222 null_oid(), old_oid,
1223 flags, msg, err);
1226 int ref_transaction_verify(struct ref_transaction *transaction,
1227 const char *refname,
1228 const struct object_id *old_oid,
1229 unsigned int flags,
1230 struct strbuf *err)
1232 if (!old_oid)
1233 BUG("verify called with old_oid set to NULL");
1234 return ref_transaction_update(transaction, refname,
1235 NULL, old_oid,
1236 flags, NULL, err);
1239 int refs_update_ref(struct ref_store *refs, const char *msg,
1240 const char *refname, const struct object_id *new_oid,
1241 const struct object_id *old_oid, unsigned int flags,
1242 enum action_on_err onerr)
1244 struct ref_transaction *t = NULL;
1245 struct strbuf err = STRBUF_INIT;
1246 int ret = 0;
1248 t = ref_store_transaction_begin(refs, &err);
1249 if (!t ||
1250 ref_transaction_update(t, refname, new_oid, old_oid, flags, msg,
1251 &err) ||
1252 ref_transaction_commit(t, &err)) {
1253 ret = 1;
1254 ref_transaction_free(t);
1256 if (ret) {
1257 const char *str = _("update_ref failed for ref '%s': %s");
1259 switch (onerr) {
1260 case UPDATE_REFS_MSG_ON_ERR:
1261 error(str, refname, err.buf);
1262 break;
1263 case UPDATE_REFS_DIE_ON_ERR:
1264 die(str, refname, err.buf);
1265 break;
1266 case UPDATE_REFS_QUIET_ON_ERR:
1267 break;
1269 strbuf_release(&err);
1270 return 1;
1272 strbuf_release(&err);
1273 if (t)
1274 ref_transaction_free(t);
1275 return 0;
1278 int update_ref(const char *msg, const char *refname,
1279 const struct object_id *new_oid,
1280 const struct object_id *old_oid,
1281 unsigned int flags, enum action_on_err onerr)
1283 return refs_update_ref(get_main_ref_store(the_repository), msg, refname, new_oid,
1284 old_oid, flags, onerr);
1287 char *refs_shorten_unambiguous_ref(struct ref_store *refs,
1288 const char *refname, int strict)
1290 int i;
1291 static char **scanf_fmts;
1292 static int nr_rules;
1293 char *short_name;
1294 struct strbuf resolved_buf = STRBUF_INIT;
1296 if (!nr_rules) {
1298 * Pre-generate scanf formats from ref_rev_parse_rules[].
1299 * Generate a format suitable for scanf from a
1300 * ref_rev_parse_rules rule by interpolating "%s" at the
1301 * location of the "%.*s".
1303 size_t total_len = 0;
1304 size_t offset = 0;
1306 /* the rule list is NULL terminated, count them first */
1307 for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
1308 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1309 total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
1311 scanf_fmts = xmalloc(st_add(st_mult(sizeof(char *), nr_rules), total_len));
1313 offset = 0;
1314 for (i = 0; i < nr_rules; i++) {
1315 assert(offset < total_len);
1316 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
1317 offset += xsnprintf(scanf_fmts[i], total_len - offset,
1318 ref_rev_parse_rules[i], 2, "%s") + 1;
1322 /* bail out if there are no rules */
1323 if (!nr_rules)
1324 return xstrdup(refname);
1326 /* buffer for scanf result, at most refname must fit */
1327 short_name = xstrdup(refname);
1329 /* skip first rule, it will always match */
1330 for (i = nr_rules - 1; i > 0 ; --i) {
1331 int j;
1332 int rules_to_fail = i;
1333 int short_name_len;
1335 if (1 != sscanf(refname, scanf_fmts[i], short_name))
1336 continue;
1338 short_name_len = strlen(short_name);
1341 * in strict mode, all (except the matched one) rules
1342 * must fail to resolve to a valid non-ambiguous ref
1344 if (strict)
1345 rules_to_fail = nr_rules;
1348 * check if the short name resolves to a valid ref,
1349 * but use only rules prior to the matched one
1351 for (j = 0; j < rules_to_fail; j++) {
1352 const char *rule = ref_rev_parse_rules[j];
1354 /* skip matched rule */
1355 if (i == j)
1356 continue;
1359 * the short name is ambiguous, if it resolves
1360 * (with this previous rule) to a valid ref
1361 * read_ref() returns 0 on success
1363 strbuf_reset(&resolved_buf);
1364 strbuf_addf(&resolved_buf, rule,
1365 short_name_len, short_name);
1366 if (refs_ref_exists(refs, resolved_buf.buf))
1367 break;
1371 * short name is non-ambiguous if all previous rules
1372 * haven't resolved to a valid ref
1374 if (j == rules_to_fail) {
1375 strbuf_release(&resolved_buf);
1376 return short_name;
1380 strbuf_release(&resolved_buf);
1381 free(short_name);
1382 return xstrdup(refname);
1385 char *shorten_unambiguous_ref(const char *refname, int strict)
1387 return refs_shorten_unambiguous_ref(get_main_ref_store(the_repository),
1388 refname, strict);
1391 static struct string_list *hide_refs;
1393 int parse_hide_refs_config(const char *var, const char *value, const char *section)
1395 const char *key;
1396 if (!strcmp("transfer.hiderefs", var) ||
1397 (!parse_config_key(var, section, NULL, NULL, &key) &&
1398 !strcmp(key, "hiderefs"))) {
1399 char *ref;
1400 int len;
1402 if (!value)
1403 return config_error_nonbool(var);
1404 ref = xstrdup(value);
1405 len = strlen(ref);
1406 while (len && ref[len - 1] == '/')
1407 ref[--len] = '\0';
1408 if (!hide_refs) {
1409 CALLOC_ARRAY(hide_refs, 1);
1410 hide_refs->strdup_strings = 1;
1412 string_list_append(hide_refs, ref);
1414 return 0;
1417 int ref_is_hidden(const char *refname, const char *refname_full)
1419 int i;
1421 if (!hide_refs)
1422 return 0;
1423 for (i = hide_refs->nr - 1; i >= 0; i--) {
1424 const char *match = hide_refs->items[i].string;
1425 const char *subject;
1426 int neg = 0;
1427 const char *p;
1429 if (*match == '!') {
1430 neg = 1;
1431 match++;
1434 if (*match == '^') {
1435 subject = refname_full;
1436 match++;
1437 } else {
1438 subject = refname;
1441 /* refname can be NULL when namespaces are used. */
1442 if (subject &&
1443 skip_prefix(subject, match, &p) &&
1444 (!*p || *p == '/'))
1445 return !neg;
1447 return 0;
1450 const char *find_descendant_ref(const char *dirname,
1451 const struct string_list *extras,
1452 const struct string_list *skip)
1454 int pos;
1456 if (!extras)
1457 return NULL;
1460 * Look at the place where dirname would be inserted into
1461 * extras. If there is an entry at that position that starts
1462 * with dirname (remember, dirname includes the trailing
1463 * slash) and is not in skip, then we have a conflict.
1465 for (pos = string_list_find_insert_index(extras, dirname, 0);
1466 pos < extras->nr; pos++) {
1467 const char *extra_refname = extras->items[pos].string;
1469 if (!starts_with(extra_refname, dirname))
1470 break;
1472 if (!skip || !string_list_has_string(skip, extra_refname))
1473 return extra_refname;
1475 return NULL;
1478 int refs_head_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1480 struct object_id oid;
1481 int flag;
1483 if (refs_resolve_ref_unsafe(refs, "HEAD", RESOLVE_REF_READING,
1484 &oid, &flag))
1485 return fn("HEAD", &oid, flag, cb_data);
1487 return 0;
1490 int head_ref(each_ref_fn fn, void *cb_data)
1492 return refs_head_ref(get_main_ref_store(the_repository), fn, cb_data);
1495 struct ref_iterator *refs_ref_iterator_begin(
1496 struct ref_store *refs,
1497 const char *prefix, int trim,
1498 enum do_for_each_ref_flags flags)
1500 struct ref_iterator *iter;
1502 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
1503 static int ref_paranoia = -1;
1505 if (ref_paranoia < 0)
1506 ref_paranoia = git_env_bool("GIT_REF_PARANOIA", 1);
1507 if (ref_paranoia) {
1508 flags |= DO_FOR_EACH_INCLUDE_BROKEN;
1509 flags |= DO_FOR_EACH_OMIT_DANGLING_SYMREFS;
1513 iter = refs->be->iterator_begin(refs, prefix, flags);
1516 * `iterator_begin()` already takes care of prefix, but we
1517 * might need to do some trimming:
1519 if (trim)
1520 iter = prefix_ref_iterator_begin(iter, "", trim);
1522 /* Sanity check for subclasses: */
1523 if (!iter->ordered)
1524 BUG("reference iterator is not ordered");
1526 return iter;
1530 * Call fn for each reference in the specified submodule for which the
1531 * refname begins with prefix. If trim is non-zero, then trim that
1532 * many characters off the beginning of each refname before passing
1533 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1534 * include broken references in the iteration. If fn ever returns a
1535 * non-zero value, stop the iteration and return that value;
1536 * otherwise, return 0.
1538 static int do_for_each_repo_ref(struct repository *r, const char *prefix,
1539 each_repo_ref_fn fn, int trim, int flags,
1540 void *cb_data)
1542 struct ref_iterator *iter;
1543 struct ref_store *refs = get_main_ref_store(r);
1545 if (!refs)
1546 return 0;
1548 iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1550 return do_for_each_repo_ref_iterator(r, iter, fn, cb_data);
1553 struct do_for_each_ref_help {
1554 each_ref_fn *fn;
1555 void *cb_data;
1558 static int do_for_each_ref_helper(struct repository *r,
1559 const char *refname,
1560 const struct object_id *oid,
1561 int flags,
1562 void *cb_data)
1564 struct do_for_each_ref_help *hp = cb_data;
1566 return hp->fn(refname, oid, flags, hp->cb_data);
1569 static int do_for_each_ref(struct ref_store *refs, const char *prefix,
1570 each_ref_fn fn, int trim,
1571 enum do_for_each_ref_flags flags, void *cb_data)
1573 struct ref_iterator *iter;
1574 struct do_for_each_ref_help hp = { fn, cb_data };
1576 if (!refs)
1577 return 0;
1579 iter = refs_ref_iterator_begin(refs, prefix, trim, flags);
1581 return do_for_each_repo_ref_iterator(the_repository, iter,
1582 do_for_each_ref_helper, &hp);
1585 int refs_for_each_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1587 return do_for_each_ref(refs, "", fn, 0, 0, cb_data);
1590 int for_each_ref(each_ref_fn fn, void *cb_data)
1592 return refs_for_each_ref(get_main_ref_store(the_repository), fn, cb_data);
1595 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
1596 each_ref_fn fn, void *cb_data)
1598 return do_for_each_ref(refs, prefix, fn, strlen(prefix), 0, cb_data);
1601 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1603 return refs_for_each_ref_in(get_main_ref_store(the_repository), prefix, fn, cb_data);
1606 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1608 return do_for_each_ref(get_main_ref_store(the_repository),
1609 prefix, fn, 0, 0, cb_data);
1612 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
1613 each_ref_fn fn, void *cb_data)
1615 return do_for_each_ref(refs, prefix, fn, 0, 0, cb_data);
1618 int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data)
1620 const char *git_replace_ref_base = ref_namespace[NAMESPACE_REPLACE].ref;
1621 return do_for_each_repo_ref(r, git_replace_ref_base, fn,
1622 strlen(git_replace_ref_base),
1623 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1626 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1628 struct strbuf buf = STRBUF_INIT;
1629 int ret;
1630 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1631 ret = do_for_each_ref(get_main_ref_store(the_repository),
1632 buf.buf, fn, 0, 0, cb_data);
1633 strbuf_release(&buf);
1634 return ret;
1637 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data)
1639 return do_for_each_ref(refs, "", fn, 0,
1640 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1643 int for_each_rawref(each_ref_fn fn, void *cb_data)
1645 return refs_for_each_rawref(get_main_ref_store(the_repository), fn, cb_data);
1648 static int qsort_strcmp(const void *va, const void *vb)
1650 const char *a = *(const char **)va;
1651 const char *b = *(const char **)vb;
1653 return strcmp(a, b);
1656 static void find_longest_prefixes_1(struct string_list *out,
1657 struct strbuf *prefix,
1658 const char **patterns, size_t nr)
1660 size_t i;
1662 for (i = 0; i < nr; i++) {
1663 char c = patterns[i][prefix->len];
1664 if (!c || is_glob_special(c)) {
1665 string_list_append(out, prefix->buf);
1666 return;
1670 i = 0;
1671 while (i < nr) {
1672 size_t end;
1675 * Set "end" to the index of the element _after_ the last one
1676 * in our group.
1678 for (end = i + 1; end < nr; end++) {
1679 if (patterns[i][prefix->len] != patterns[end][prefix->len])
1680 break;
1683 strbuf_addch(prefix, patterns[i][prefix->len]);
1684 find_longest_prefixes_1(out, prefix, patterns + i, end - i);
1685 strbuf_setlen(prefix, prefix->len - 1);
1687 i = end;
1691 static void find_longest_prefixes(struct string_list *out,
1692 const char **patterns)
1694 struct strvec sorted = STRVEC_INIT;
1695 struct strbuf prefix = STRBUF_INIT;
1697 strvec_pushv(&sorted, patterns);
1698 QSORT(sorted.v, sorted.nr, qsort_strcmp);
1700 find_longest_prefixes_1(out, &prefix, sorted.v, sorted.nr);
1702 strvec_clear(&sorted);
1703 strbuf_release(&prefix);
1706 int for_each_fullref_in_prefixes(const char *namespace,
1707 const char **patterns,
1708 each_ref_fn fn, void *cb_data)
1710 struct string_list prefixes = STRING_LIST_INIT_DUP;
1711 struct string_list_item *prefix;
1712 struct strbuf buf = STRBUF_INIT;
1713 int ret = 0, namespace_len;
1715 find_longest_prefixes(&prefixes, patterns);
1717 if (namespace)
1718 strbuf_addstr(&buf, namespace);
1719 namespace_len = buf.len;
1721 for_each_string_list_item(prefix, &prefixes) {
1722 strbuf_addstr(&buf, prefix->string);
1723 ret = for_each_fullref_in(buf.buf, fn, cb_data);
1724 if (ret)
1725 break;
1726 strbuf_setlen(&buf, namespace_len);
1729 string_list_clear(&prefixes, 0);
1730 strbuf_release(&buf);
1731 return ret;
1734 static int refs_read_special_head(struct ref_store *ref_store,
1735 const char *refname, struct object_id *oid,
1736 struct strbuf *referent, unsigned int *type,
1737 int *failure_errno)
1739 struct strbuf full_path = STRBUF_INIT;
1740 struct strbuf content = STRBUF_INIT;
1741 int result = -1;
1742 strbuf_addf(&full_path, "%s/%s", ref_store->gitdir, refname);
1744 if (strbuf_read_file(&content, full_path.buf, 0) < 0)
1745 goto done;
1747 result = parse_loose_ref_contents(content.buf, oid, referent, type,
1748 failure_errno);
1750 done:
1751 strbuf_release(&full_path);
1752 strbuf_release(&content);
1753 return result;
1756 int refs_read_raw_ref(struct ref_store *ref_store, const char *refname,
1757 struct object_id *oid, struct strbuf *referent,
1758 unsigned int *type, int *failure_errno)
1760 assert(failure_errno);
1761 if (!strcmp(refname, "FETCH_HEAD") || !strcmp(refname, "MERGE_HEAD")) {
1762 return refs_read_special_head(ref_store, refname, oid, referent,
1763 type, failure_errno);
1766 return ref_store->be->read_raw_ref(ref_store, refname, oid, referent,
1767 type, failure_errno);
1770 int refs_read_symbolic_ref(struct ref_store *ref_store, const char *refname,
1771 struct strbuf *referent)
1773 return ref_store->be->read_symbolic_ref(ref_store, refname, referent);
1776 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
1777 const char *refname,
1778 int resolve_flags,
1779 struct object_id *oid,
1780 int *flags)
1782 static struct strbuf sb_refname = STRBUF_INIT;
1783 struct object_id unused_oid;
1784 int unused_flags;
1785 int symref_count;
1787 if (!oid)
1788 oid = &unused_oid;
1789 if (!flags)
1790 flags = &unused_flags;
1792 *flags = 0;
1794 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1795 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1796 !refname_is_safe(refname))
1797 return NULL;
1800 * dwim_ref() uses REF_ISBROKEN to distinguish between
1801 * missing refs and refs that were present but invalid,
1802 * to complain about the latter to stderr.
1804 * We don't know whether the ref exists, so don't set
1805 * REF_ISBROKEN yet.
1807 *flags |= REF_BAD_NAME;
1810 for (symref_count = 0; symref_count < SYMREF_MAXDEPTH; symref_count++) {
1811 unsigned int read_flags = 0;
1812 int failure_errno;
1814 if (refs_read_raw_ref(refs, refname, oid, &sb_refname,
1815 &read_flags, &failure_errno)) {
1816 *flags |= read_flags;
1818 /* In reading mode, refs must eventually resolve */
1819 if (resolve_flags & RESOLVE_REF_READING)
1820 return NULL;
1823 * Otherwise a missing ref is OK. But the files backend
1824 * may show errors besides ENOENT if there are
1825 * similarly-named refs.
1827 if (failure_errno != ENOENT &&
1828 failure_errno != EISDIR &&
1829 failure_errno != ENOTDIR)
1830 return NULL;
1832 oidclr(oid);
1833 if (*flags & REF_BAD_NAME)
1834 *flags |= REF_ISBROKEN;
1835 return refname;
1838 *flags |= read_flags;
1840 if (!(read_flags & REF_ISSYMREF)) {
1841 if (*flags & REF_BAD_NAME) {
1842 oidclr(oid);
1843 *flags |= REF_ISBROKEN;
1845 return refname;
1848 refname = sb_refname.buf;
1849 if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
1850 oidclr(oid);
1851 return refname;
1853 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1854 if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
1855 !refname_is_safe(refname))
1856 return NULL;
1858 *flags |= REF_ISBROKEN | REF_BAD_NAME;
1862 return NULL;
1865 /* backend functions */
1866 int refs_init_db(struct strbuf *err)
1868 struct ref_store *refs = get_main_ref_store(the_repository);
1870 return refs->be->init_db(refs, err);
1873 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
1874 struct object_id *oid, int *flags)
1876 return refs_resolve_ref_unsafe(get_main_ref_store(the_repository), refname,
1877 resolve_flags, oid, flags);
1880 int resolve_gitlink_ref(const char *submodule, const char *refname,
1881 struct object_id *oid)
1883 struct ref_store *refs;
1884 int flags;
1886 refs = get_submodule_ref_store(submodule);
1888 if (!refs)
1889 return -1;
1891 if (!refs_resolve_ref_unsafe(refs, refname, 0, oid, &flags) ||
1892 is_null_oid(oid))
1893 return -1;
1894 return 0;
1897 struct ref_store_hash_entry
1899 struct hashmap_entry ent;
1901 struct ref_store *refs;
1903 /* NUL-terminated identifier of the ref store: */
1904 char name[FLEX_ARRAY];
1907 static int ref_store_hash_cmp(const void *cmp_data UNUSED,
1908 const struct hashmap_entry *eptr,
1909 const struct hashmap_entry *entry_or_key,
1910 const void *keydata)
1912 const struct ref_store_hash_entry *e1, *e2;
1913 const char *name;
1915 e1 = container_of(eptr, const struct ref_store_hash_entry, ent);
1916 e2 = container_of(entry_or_key, const struct ref_store_hash_entry, ent);
1917 name = keydata ? keydata : e2->name;
1919 return strcmp(e1->name, name);
1922 static struct ref_store_hash_entry *alloc_ref_store_hash_entry(
1923 const char *name, struct ref_store *refs)
1925 struct ref_store_hash_entry *entry;
1927 FLEX_ALLOC_STR(entry, name, name);
1928 hashmap_entry_init(&entry->ent, strhash(name));
1929 entry->refs = refs;
1930 return entry;
1933 /* A hashmap of ref_stores, stored by submodule name: */
1934 static struct hashmap submodule_ref_stores;
1936 /* A hashmap of ref_stores, stored by worktree id: */
1937 static struct hashmap worktree_ref_stores;
1940 * Look up a ref store by name. If that ref_store hasn't been
1941 * registered yet, return NULL.
1943 static struct ref_store *lookup_ref_store_map(struct hashmap *map,
1944 const char *name)
1946 struct ref_store_hash_entry *entry;
1947 unsigned int hash;
1949 if (!map->tablesize)
1950 /* It's initialized on demand in register_ref_store(). */
1951 return NULL;
1953 hash = strhash(name);
1954 entry = hashmap_get_entry_from_hash(map, hash, name,
1955 struct ref_store_hash_entry, ent);
1956 return entry ? entry->refs : NULL;
1960 * Create, record, and return a ref_store instance for the specified
1961 * gitdir.
1963 static struct ref_store *ref_store_init(struct repository *repo,
1964 const char *gitdir,
1965 unsigned int flags)
1967 const char *be_name = "files";
1968 struct ref_storage_be *be = find_ref_storage_backend(be_name);
1969 struct ref_store *refs;
1971 if (!be)
1972 BUG("reference backend %s is unknown", be_name);
1974 refs = be->init(repo, gitdir, flags);
1975 return refs;
1978 struct ref_store *get_main_ref_store(struct repository *r)
1980 if (r->refs_private)
1981 return r->refs_private;
1983 if (!r->gitdir)
1984 BUG("attempting to get main_ref_store outside of repository");
1986 r->refs_private = ref_store_init(r, r->gitdir, REF_STORE_ALL_CAPS);
1987 r->refs_private = maybe_debug_wrap_ref_store(r->gitdir, r->refs_private);
1988 return r->refs_private;
1992 * Associate a ref store with a name. It is a fatal error to call this
1993 * function twice for the same name.
1995 static void register_ref_store_map(struct hashmap *map,
1996 const char *type,
1997 struct ref_store *refs,
1998 const char *name)
2000 struct ref_store_hash_entry *entry;
2002 if (!map->tablesize)
2003 hashmap_init(map, ref_store_hash_cmp, NULL, 0);
2005 entry = alloc_ref_store_hash_entry(name, refs);
2006 if (hashmap_put(map, &entry->ent))
2007 BUG("%s ref_store '%s' initialized twice", type, name);
2010 struct ref_store *get_submodule_ref_store(const char *submodule)
2012 struct strbuf submodule_sb = STRBUF_INIT;
2013 struct ref_store *refs;
2014 char *to_free = NULL;
2015 size_t len;
2016 struct repository *subrepo;
2018 if (!submodule)
2019 return NULL;
2021 len = strlen(submodule);
2022 while (len && is_dir_sep(submodule[len - 1]))
2023 len--;
2024 if (!len)
2025 return NULL;
2027 if (submodule[len])
2028 /* We need to strip off one or more trailing slashes */
2029 submodule = to_free = xmemdupz(submodule, len);
2031 refs = lookup_ref_store_map(&submodule_ref_stores, submodule);
2032 if (refs)
2033 goto done;
2035 strbuf_addstr(&submodule_sb, submodule);
2036 if (!is_nonbare_repository_dir(&submodule_sb))
2037 goto done;
2039 if (submodule_to_gitdir(&submodule_sb, submodule))
2040 goto done;
2042 subrepo = xmalloc(sizeof(*subrepo));
2044 * NEEDSWORK: Make get_submodule_ref_store() work with arbitrary
2045 * superprojects other than the_repository. This probably should be
2046 * done by making it take a struct repository * parameter instead of a
2047 * submodule path.
2049 if (repo_submodule_init(subrepo, the_repository, submodule,
2050 null_oid())) {
2051 free(subrepo);
2052 goto done;
2054 refs = ref_store_init(subrepo, submodule_sb.buf,
2055 REF_STORE_READ | REF_STORE_ODB);
2056 register_ref_store_map(&submodule_ref_stores, "submodule",
2057 refs, submodule);
2059 done:
2060 strbuf_release(&submodule_sb);
2061 free(to_free);
2063 return refs;
2066 struct ref_store *get_worktree_ref_store(const struct worktree *wt)
2068 struct ref_store *refs;
2069 const char *id;
2071 if (wt->is_current)
2072 return get_main_ref_store(the_repository);
2074 id = wt->id ? wt->id : "/";
2075 refs = lookup_ref_store_map(&worktree_ref_stores, id);
2076 if (refs)
2077 return refs;
2079 if (wt->id)
2080 refs = ref_store_init(the_repository,
2081 git_common_path("worktrees/%s", wt->id),
2082 REF_STORE_ALL_CAPS);
2083 else
2084 refs = ref_store_init(the_repository,
2085 get_git_common_dir(),
2086 REF_STORE_ALL_CAPS);
2088 if (refs)
2089 register_ref_store_map(&worktree_ref_stores, "worktree",
2090 refs, id);
2091 return refs;
2094 void base_ref_store_init(struct ref_store *refs, struct repository *repo,
2095 const char *path, const struct ref_storage_be *be)
2097 refs->be = be;
2098 refs->repo = repo;
2099 refs->gitdir = xstrdup(path);
2102 /* backend functions */
2103 int refs_pack_refs(struct ref_store *refs, unsigned int flags)
2105 return refs->be->pack_refs(refs, flags);
2108 int peel_iterated_oid(const struct object_id *base, struct object_id *peeled)
2110 if (current_ref_iter &&
2111 (current_ref_iter->oid == base ||
2112 oideq(current_ref_iter->oid, base)))
2113 return ref_iterator_peel(current_ref_iter, peeled);
2115 return peel_object(base, peeled) ? -1 : 0;
2118 int refs_create_symref(struct ref_store *refs,
2119 const char *ref_target,
2120 const char *refs_heads_master,
2121 const char *logmsg)
2123 char *msg;
2124 int retval;
2126 msg = normalize_reflog_message(logmsg);
2127 retval = refs->be->create_symref(refs, ref_target, refs_heads_master,
2128 msg);
2129 free(msg);
2130 return retval;
2133 int create_symref(const char *ref_target, const char *refs_heads_master,
2134 const char *logmsg)
2136 return refs_create_symref(get_main_ref_store(the_repository), ref_target,
2137 refs_heads_master, logmsg);
2140 int ref_update_reject_duplicates(struct string_list *refnames,
2141 struct strbuf *err)
2143 size_t i, n = refnames->nr;
2145 assert(err);
2147 for (i = 1; i < n; i++) {
2148 int cmp = strcmp(refnames->items[i - 1].string,
2149 refnames->items[i].string);
2151 if (!cmp) {
2152 strbuf_addf(err,
2153 _("multiple updates for ref '%s' not allowed"),
2154 refnames->items[i].string);
2155 return 1;
2156 } else if (cmp > 0) {
2157 BUG("ref_update_reject_duplicates() received unsorted list");
2160 return 0;
2163 static int run_transaction_hook(struct ref_transaction *transaction,
2164 const char *state)
2166 struct child_process proc = CHILD_PROCESS_INIT;
2167 struct strbuf buf = STRBUF_INIT;
2168 const char *hook;
2169 int ret = 0, i;
2171 hook = find_hook("reference-transaction");
2172 if (!hook)
2173 return ret;
2175 strvec_pushl(&proc.args, hook, state, NULL);
2176 proc.in = -1;
2177 proc.stdout_to_stderr = 1;
2178 proc.trace2_hook_name = "reference-transaction";
2180 ret = start_command(&proc);
2181 if (ret)
2182 return ret;
2184 sigchain_push(SIGPIPE, SIG_IGN);
2186 for (i = 0; i < transaction->nr; i++) {
2187 struct ref_update *update = transaction->updates[i];
2189 strbuf_reset(&buf);
2190 strbuf_addf(&buf, "%s %s %s\n",
2191 oid_to_hex(&update->old_oid),
2192 oid_to_hex(&update->new_oid),
2193 update->refname);
2195 if (write_in_full(proc.in, buf.buf, buf.len) < 0) {
2196 if (errno != EPIPE) {
2197 /* Don't leak errno outside this API */
2198 errno = 0;
2199 ret = -1;
2201 break;
2205 close(proc.in);
2206 sigchain_pop(SIGPIPE);
2207 strbuf_release(&buf);
2209 ret |= finish_command(&proc);
2210 return ret;
2213 int ref_transaction_prepare(struct ref_transaction *transaction,
2214 struct strbuf *err)
2216 struct ref_store *refs = transaction->ref_store;
2217 int ret;
2219 switch (transaction->state) {
2220 case REF_TRANSACTION_OPEN:
2221 /* Good. */
2222 break;
2223 case REF_TRANSACTION_PREPARED:
2224 BUG("prepare called twice on reference transaction");
2225 break;
2226 case REF_TRANSACTION_CLOSED:
2227 BUG("prepare called on a closed reference transaction");
2228 break;
2229 default:
2230 BUG("unexpected reference transaction state");
2231 break;
2234 if (refs->repo->objects->odb->disable_ref_updates) {
2235 strbuf_addstr(err,
2236 _("ref updates forbidden inside quarantine environment"));
2237 return -1;
2240 ret = refs->be->transaction_prepare(refs, transaction, err);
2241 if (ret)
2242 return ret;
2244 ret = run_transaction_hook(transaction, "prepared");
2245 if (ret) {
2246 ref_transaction_abort(transaction, err);
2247 die(_("ref updates aborted by hook"));
2250 return 0;
2253 int ref_transaction_abort(struct ref_transaction *transaction,
2254 struct strbuf *err)
2256 struct ref_store *refs = transaction->ref_store;
2257 int ret = 0;
2259 switch (transaction->state) {
2260 case REF_TRANSACTION_OPEN:
2261 /* No need to abort explicitly. */
2262 break;
2263 case REF_TRANSACTION_PREPARED:
2264 ret = refs->be->transaction_abort(refs, transaction, err);
2265 break;
2266 case REF_TRANSACTION_CLOSED:
2267 BUG("abort called on a closed reference transaction");
2268 break;
2269 default:
2270 BUG("unexpected reference transaction state");
2271 break;
2274 run_transaction_hook(transaction, "aborted");
2276 ref_transaction_free(transaction);
2277 return ret;
2280 int ref_transaction_commit(struct ref_transaction *transaction,
2281 struct strbuf *err)
2283 struct ref_store *refs = transaction->ref_store;
2284 int ret;
2286 switch (transaction->state) {
2287 case REF_TRANSACTION_OPEN:
2288 /* Need to prepare first. */
2289 ret = ref_transaction_prepare(transaction, err);
2290 if (ret)
2291 return ret;
2292 break;
2293 case REF_TRANSACTION_PREPARED:
2294 /* Fall through to finish. */
2295 break;
2296 case REF_TRANSACTION_CLOSED:
2297 BUG("commit called on a closed reference transaction");
2298 break;
2299 default:
2300 BUG("unexpected reference transaction state");
2301 break;
2304 ret = refs->be->transaction_finish(refs, transaction, err);
2305 if (!ret)
2306 run_transaction_hook(transaction, "committed");
2307 return ret;
2310 int refs_verify_refname_available(struct ref_store *refs,
2311 const char *refname,
2312 const struct string_list *extras,
2313 const struct string_list *skip,
2314 struct strbuf *err)
2316 const char *slash;
2317 const char *extra_refname;
2318 struct strbuf dirname = STRBUF_INIT;
2319 struct strbuf referent = STRBUF_INIT;
2320 struct object_id oid;
2321 unsigned int type;
2322 struct ref_iterator *iter;
2323 int ok;
2324 int ret = -1;
2327 * For the sake of comments in this function, suppose that
2328 * refname is "refs/foo/bar".
2331 assert(err);
2333 strbuf_grow(&dirname, strlen(refname) + 1);
2334 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
2336 * Just saying "Is a directory" when we e.g. can't
2337 * lock some multi-level ref isn't very informative,
2338 * the user won't be told *what* is a directory, so
2339 * let's not use strerror() below.
2341 int ignore_errno;
2342 /* Expand dirname to the new prefix, not including the trailing slash: */
2343 strbuf_add(&dirname, refname + dirname.len, slash - refname - dirname.len);
2346 * We are still at a leading dir of the refname (e.g.,
2347 * "refs/foo"; if there is a reference with that name,
2348 * it is a conflict, *unless* it is in skip.
2350 if (skip && string_list_has_string(skip, dirname.buf))
2351 continue;
2353 if (!refs_read_raw_ref(refs, dirname.buf, &oid, &referent,
2354 &type, &ignore_errno)) {
2355 strbuf_addf(err, _("'%s' exists; cannot create '%s'"),
2356 dirname.buf, refname);
2357 goto cleanup;
2360 if (extras && string_list_has_string(extras, dirname.buf)) {
2361 strbuf_addf(err, _("cannot process '%s' and '%s' at the same time"),
2362 refname, dirname.buf);
2363 goto cleanup;
2368 * We are at the leaf of our refname (e.g., "refs/foo/bar").
2369 * There is no point in searching for a reference with that
2370 * name, because a refname isn't considered to conflict with
2371 * itself. But we still need to check for references whose
2372 * names are in the "refs/foo/bar/" namespace, because they
2373 * *do* conflict.
2375 strbuf_addstr(&dirname, refname + dirname.len);
2376 strbuf_addch(&dirname, '/');
2378 iter = refs_ref_iterator_begin(refs, dirname.buf, 0,
2379 DO_FOR_EACH_INCLUDE_BROKEN);
2380 while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
2381 if (skip &&
2382 string_list_has_string(skip, iter->refname))
2383 continue;
2385 strbuf_addf(err, _("'%s' exists; cannot create '%s'"),
2386 iter->refname, refname);
2387 ref_iterator_abort(iter);
2388 goto cleanup;
2391 if (ok != ITER_DONE)
2392 BUG("error while iterating over references");
2394 extra_refname = find_descendant_ref(dirname.buf, extras, skip);
2395 if (extra_refname)
2396 strbuf_addf(err, _("cannot process '%s' and '%s' at the same time"),
2397 refname, extra_refname);
2398 else
2399 ret = 0;
2401 cleanup:
2402 strbuf_release(&referent);
2403 strbuf_release(&dirname);
2404 return ret;
2407 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data)
2409 struct ref_iterator *iter;
2410 struct do_for_each_ref_help hp = { fn, cb_data };
2412 iter = refs->be->reflog_iterator_begin(refs);
2414 return do_for_each_repo_ref_iterator(the_repository, iter,
2415 do_for_each_ref_helper, &hp);
2418 int for_each_reflog(each_ref_fn fn, void *cb_data)
2420 return refs_for_each_reflog(get_main_ref_store(the_repository), fn, cb_data);
2423 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
2424 const char *refname,
2425 each_reflog_ent_fn fn,
2426 void *cb_data)
2428 return refs->be->for_each_reflog_ent_reverse(refs, refname,
2429 fn, cb_data);
2432 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn,
2433 void *cb_data)
2435 return refs_for_each_reflog_ent_reverse(get_main_ref_store(the_repository),
2436 refname, fn, cb_data);
2439 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
2440 each_reflog_ent_fn fn, void *cb_data)
2442 return refs->be->for_each_reflog_ent(refs, refname, fn, cb_data);
2445 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn,
2446 void *cb_data)
2448 return refs_for_each_reflog_ent(get_main_ref_store(the_repository), refname,
2449 fn, cb_data);
2452 int refs_reflog_exists(struct ref_store *refs, const char *refname)
2454 return refs->be->reflog_exists(refs, refname);
2457 int reflog_exists(const char *refname)
2459 return refs_reflog_exists(get_main_ref_store(the_repository), refname);
2462 int refs_create_reflog(struct ref_store *refs, const char *refname,
2463 struct strbuf *err)
2465 return refs->be->create_reflog(refs, refname, err);
2468 int safe_create_reflog(const char *refname, struct strbuf *err)
2470 return refs_create_reflog(get_main_ref_store(the_repository), refname,
2471 err);
2474 int refs_delete_reflog(struct ref_store *refs, const char *refname)
2476 return refs->be->delete_reflog(refs, refname);
2479 int delete_reflog(const char *refname)
2481 return refs_delete_reflog(get_main_ref_store(the_repository), refname);
2484 int refs_reflog_expire(struct ref_store *refs,
2485 const char *refname,
2486 unsigned int flags,
2487 reflog_expiry_prepare_fn prepare_fn,
2488 reflog_expiry_should_prune_fn should_prune_fn,
2489 reflog_expiry_cleanup_fn cleanup_fn,
2490 void *policy_cb_data)
2492 return refs->be->reflog_expire(refs, refname, flags,
2493 prepare_fn, should_prune_fn,
2494 cleanup_fn, policy_cb_data);
2497 int reflog_expire(const char *refname,
2498 unsigned int flags,
2499 reflog_expiry_prepare_fn prepare_fn,
2500 reflog_expiry_should_prune_fn should_prune_fn,
2501 reflog_expiry_cleanup_fn cleanup_fn,
2502 void *policy_cb_data)
2504 return refs_reflog_expire(get_main_ref_store(the_repository),
2505 refname, flags,
2506 prepare_fn, should_prune_fn,
2507 cleanup_fn, policy_cb_data);
2510 int initial_ref_transaction_commit(struct ref_transaction *transaction,
2511 struct strbuf *err)
2513 struct ref_store *refs = transaction->ref_store;
2515 return refs->be->initial_transaction_commit(refs, transaction, err);
2518 void ref_transaction_for_each_queued_update(struct ref_transaction *transaction,
2519 ref_transaction_for_each_queued_update_fn cb,
2520 void *cb_data)
2522 int i;
2524 for (i = 0; i < transaction->nr; i++) {
2525 struct ref_update *update = transaction->updates[i];
2527 cb(update->refname,
2528 (update->flags & REF_HAVE_OLD) ? &update->old_oid : NULL,
2529 (update->flags & REF_HAVE_NEW) ? &update->new_oid : NULL,
2530 cb_data);
2534 int refs_delete_refs(struct ref_store *refs, const char *logmsg,
2535 struct string_list *refnames, unsigned int flags)
2537 char *msg;
2538 int retval;
2540 msg = normalize_reflog_message(logmsg);
2541 retval = refs->be->delete_refs(refs, msg, refnames, flags);
2542 free(msg);
2543 return retval;
2546 int delete_refs(const char *msg, struct string_list *refnames,
2547 unsigned int flags)
2549 return refs_delete_refs(get_main_ref_store(the_repository), msg, refnames, flags);
2552 int refs_rename_ref(struct ref_store *refs, const char *oldref,
2553 const char *newref, const char *logmsg)
2555 char *msg;
2556 int retval;
2558 msg = normalize_reflog_message(logmsg);
2559 retval = refs->be->rename_ref(refs, oldref, newref, msg);
2560 free(msg);
2561 return retval;
2564 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
2566 return refs_rename_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);
2569 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
2570 const char *newref, const char *logmsg)
2572 char *msg;
2573 int retval;
2575 msg = normalize_reflog_message(logmsg);
2576 retval = refs->be->copy_ref(refs, oldref, newref, msg);
2577 free(msg);
2578 return retval;
2581 int copy_existing_ref(const char *oldref, const char *newref, const char *logmsg)
2583 return refs_copy_existing_ref(get_main_ref_store(the_repository), oldref, newref, logmsg);