2 * The backend-independent part of the reference module.
11 #include "refs/refs-internal.h"
14 #include "submodule.h"
18 * List of all available backends
20 static struct ref_storage_be
*refs_backends
= &refs_be_files
;
22 static struct ref_storage_be
*find_ref_storage_backend(const char *name
)
24 struct ref_storage_be
*be
;
25 for (be
= refs_backends
; be
; be
= be
->next
)
26 if (!strcmp(be
->name
, name
))
31 int ref_storage_backend_exists(const char *name
)
33 return find_ref_storage_backend(name
) != NULL
;
37 * How to handle various characters in refnames:
38 * 0: An acceptable character for refs
40 * 2: ., look for a preceding . to reject .. in refs
41 * 3: {, look for a preceding @ to reject @{ in refs
42 * 4: A bad character: ASCII control characters, and
43 * ":", "?", "[", "\", "^", "~", SP, or TAB
44 * 5: *, reject unless REFNAME_REFSPEC_PATTERN is set
46 static unsigned char refname_disposition
[256] = {
47 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
48 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
49 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 2, 1,
50 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
51 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
52 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
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, 3, 0, 0, 4, 4
58 * Try to read one refname component from the front of refname.
59 * Return the length of the component found, or -1 if the component is
60 * not legal. It is legal if it is something reasonable to have under
61 * ".git/refs/"; We do not like it if:
63 * - any path component of it begins with ".", or
64 * - it has double dots "..", or
65 * - it has ASCII control characters, or
66 * - it has ":", "?", "[", "\", "^", "~", SP, or TAB anywhere, or
67 * - it has "*" anywhere unless REFNAME_REFSPEC_PATTERN is set, or
68 * - it ends with a "/", or
69 * - it ends with ".lock", or
70 * - it contains a "@{" portion
72 static int check_refname_component(const char *refname
, int *flags
)
77 for (cp
= refname
; ; cp
++) {
79 unsigned char disp
= refname_disposition
[ch
];
85 return -1; /* Refname contains "..". */
89 return -1; /* Refname contains "@{". */
94 if (!(*flags
& REFNAME_REFSPEC_PATTERN
))
95 return -1; /* refspec can't be a pattern */
98 * Unset the pattern flag so that we only accept
99 * a single asterisk for one side of refspec.
101 *flags
&= ~ REFNAME_REFSPEC_PATTERN
;
108 return 0; /* Component has zero length. */
109 if (refname
[0] == '.')
110 return -1; /* Component starts with '.'. */
111 if (cp
- refname
>= LOCK_SUFFIX_LEN
&&
112 !memcmp(cp
- LOCK_SUFFIX_LEN
, LOCK_SUFFIX
, LOCK_SUFFIX_LEN
))
113 return -1; /* Refname ends with ".lock". */
117 int check_refname_format(const char *refname
, int flags
)
119 int component_len
, component_count
= 0;
121 if (!strcmp(refname
, "@"))
122 /* Refname is a single character '@'. */
126 /* We are at the start of a path component. */
127 component_len
= check_refname_component(refname
, &flags
);
128 if (component_len
<= 0)
132 if (refname
[component_len
] == '\0')
134 /* Skip to next component. */
135 refname
+= component_len
+ 1;
138 if (refname
[component_len
- 1] == '.')
139 return -1; /* Refname ends with '.'. */
140 if (!(flags
& REFNAME_ALLOW_ONELEVEL
) && component_count
< 2)
141 return -1; /* Refname has only one component. */
145 int refname_is_safe(const char *refname
)
149 if (skip_prefix(refname
, "refs/", &rest
)) {
152 size_t restlen
= strlen(rest
);
154 /* rest must not be empty, or start or end with "/" */
155 if (!restlen
|| *rest
== '/' || rest
[restlen
- 1] == '/')
159 * Does the refname try to escape refs/?
160 * For example: refs/foo/../bar is safe but refs/foo/../../bar
163 buf
= xmallocz(restlen
);
164 result
= !normalize_path_copy(buf
, rest
) && !strcmp(buf
, rest
);
170 if (!isupper(*refname
) && *refname
!= '_')
178 * Return true if refname, which has the specified oid and flags, can
179 * be resolved to an object in the database. If the referred-to object
180 * does not exist, emit a warning and return false.
182 int ref_resolves_to_object(const char *refname
,
183 const struct object_id
*oid
,
186 if (flags
& REF_ISBROKEN
)
188 if (!has_sha1_file(oid
->hash
)) {
189 error("%s does not point to a valid object!", refname
);
195 char *refs_resolve_refdup(struct ref_store
*refs
,
196 const char *refname
, int resolve_flags
,
197 unsigned char *sha1
, int *flags
)
201 result
= refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
,
203 return xstrdup_or_null(result
);
206 char *resolve_refdup(const char *refname
, int resolve_flags
,
207 unsigned char *sha1
, int *flags
)
209 return refs_resolve_refdup(get_main_ref_store(),
210 refname
, resolve_flags
,
214 /* The argument to filter_refs */
221 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
222 int resolve_flags
, unsigned char *sha1
, int *flags
)
224 if (refs_resolve_ref_unsafe(refs
, refname
, resolve_flags
, sha1
, flags
))
229 int read_ref_full(const char *refname
, int resolve_flags
, unsigned char *sha1
, int *flags
)
231 return refs_read_ref_full(get_main_ref_store(), refname
,
232 resolve_flags
, sha1
, flags
);
235 int read_ref(const char *refname
, unsigned char *sha1
)
237 return read_ref_full(refname
, RESOLVE_REF_READING
, sha1
, NULL
);
240 int ref_exists(const char *refname
)
242 return !!resolve_ref_unsafe(refname
, RESOLVE_REF_READING
, NULL
, NULL
);
245 static int filter_refs(const char *refname
, const struct object_id
*oid
,
246 int flags
, void *data
)
248 struct ref_filter
*filter
= (struct ref_filter
*)data
;
250 if (wildmatch(filter
->pattern
, refname
, 0))
252 return filter
->fn(refname
, oid
, flags
, filter
->cb_data
);
255 enum peel_status
peel_object(const unsigned char *name
, unsigned char *sha1
)
257 struct object
*o
= lookup_unknown_object(name
);
259 if (o
->type
== OBJ_NONE
) {
260 int type
= sha1_object_info(name
, NULL
);
261 if (type
< 0 || !object_as_type(o
, type
, 0))
265 if (o
->type
!= OBJ_TAG
)
268 o
= deref_tag_noverify(o
);
272 hashcpy(sha1
, o
->oid
.hash
);
276 struct warn_if_dangling_data
{
279 const struct string_list
*refnames
;
283 static int warn_if_dangling_symref(const char *refname
, const struct object_id
*oid
,
284 int flags
, void *cb_data
)
286 struct warn_if_dangling_data
*d
= cb_data
;
287 const char *resolves_to
;
289 if (!(flags
& REF_ISSYMREF
))
292 resolves_to
= resolve_ref_unsafe(refname
, 0, NULL
, NULL
);
295 ? strcmp(resolves_to
, d
->refname
)
296 : !string_list_has_string(d
->refnames
, resolves_to
))) {
300 fprintf(d
->fp
, d
->msg_fmt
, refname
);
305 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
)
307 struct warn_if_dangling_data data
;
310 data
.refname
= refname
;
311 data
.refnames
= NULL
;
312 data
.msg_fmt
= msg_fmt
;
313 for_each_rawref(warn_if_dangling_symref
, &data
);
316 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
, const struct string_list
*refnames
)
318 struct warn_if_dangling_data data
;
322 data
.refnames
= refnames
;
323 data
.msg_fmt
= msg_fmt
;
324 for_each_rawref(warn_if_dangling_symref
, &data
);
327 int refs_for_each_tag_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
329 return refs_for_each_ref_in(refs
, "refs/tags/", fn
, cb_data
);
332 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
)
334 return refs_for_each_tag_ref(get_main_ref_store(), fn
, cb_data
);
337 int refs_for_each_branch_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
339 return refs_for_each_ref_in(refs
, "refs/heads/", fn
, cb_data
);
342 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
)
344 return refs_for_each_branch_ref(get_main_ref_store(), fn
, cb_data
);
347 int refs_for_each_remote_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
349 return refs_for_each_ref_in(refs
, "refs/remotes/", fn
, cb_data
);
352 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
)
354 return refs_for_each_remote_ref(get_main_ref_store(), fn
, cb_data
);
357 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
)
359 struct strbuf buf
= STRBUF_INIT
;
361 struct object_id oid
;
364 strbuf_addf(&buf
, "%sHEAD", get_git_namespace());
365 if (!read_ref_full(buf
.buf
, RESOLVE_REF_READING
, oid
.hash
, &flag
))
366 ret
= fn(buf
.buf
, &oid
, flag
, cb_data
);
367 strbuf_release(&buf
);
372 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
373 const char *prefix
, void *cb_data
)
375 struct strbuf real_pattern
= STRBUF_INIT
;
376 struct ref_filter filter
;
379 if (!prefix
&& !starts_with(pattern
, "refs/"))
380 strbuf_addstr(&real_pattern
, "refs/");
382 strbuf_addstr(&real_pattern
, prefix
);
383 strbuf_addstr(&real_pattern
, pattern
);
385 if (!has_glob_specials(pattern
)) {
386 /* Append implied '/' '*' if not present. */
387 strbuf_complete(&real_pattern
, '/');
388 /* No need to check for '*', there is none. */
389 strbuf_addch(&real_pattern
, '*');
392 filter
.pattern
= real_pattern
.buf
;
394 filter
.cb_data
= cb_data
;
395 ret
= for_each_ref(filter_refs
, &filter
);
397 strbuf_release(&real_pattern
);
401 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
)
403 return for_each_glob_ref_in(fn
, pattern
, NULL
, cb_data
);
406 const char *prettify_refname(const char *name
)
408 if (skip_prefix(name
, "refs/heads/", &name
) ||
409 skip_prefix(name
, "refs/tags/", &name
) ||
410 skip_prefix(name
, "refs/remotes/", &name
))
415 static const char *ref_rev_parse_rules
[] = {
421 "refs/remotes/%.*s/HEAD",
425 int refname_match(const char *abbrev_name
, const char *full_name
)
428 const int abbrev_name_len
= strlen(abbrev_name
);
430 for (p
= ref_rev_parse_rules
; *p
; p
++) {
431 if (!strcmp(full_name
, mkpath(*p
, abbrev_name_len
, abbrev_name
))) {
440 * *string and *len will only be substituted, and *string returned (for
441 * later free()ing) if the string passed in is a magic short-hand form
444 static char *substitute_branch_name(const char **string
, int *len
)
446 struct strbuf buf
= STRBUF_INIT
;
447 int ret
= interpret_branch_name(*string
, *len
, &buf
, 0);
451 *string
= strbuf_detach(&buf
, &size
);
453 return (char *)*string
;
459 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
461 char *last_branch
= substitute_branch_name(&str
, &len
);
462 int refs_found
= expand_ref(str
, len
, sha1
, ref
);
467 int expand_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
)
471 struct strbuf fullref
= STRBUF_INIT
;
474 for (p
= ref_rev_parse_rules
; *p
; p
++) {
475 unsigned char sha1_from_ref
[20];
476 unsigned char *this_result
;
479 this_result
= refs_found
? sha1_from_ref
: sha1
;
480 strbuf_reset(&fullref
);
481 strbuf_addf(&fullref
, *p
, len
, str
);
482 r
= resolve_ref_unsafe(fullref
.buf
, RESOLVE_REF_READING
,
487 if (!warn_ambiguous_refs
)
489 } else if ((flag
& REF_ISSYMREF
) && strcmp(fullref
.buf
, "HEAD")) {
490 warning("ignoring dangling symref %s.", fullref
.buf
);
491 } else if ((flag
& REF_ISBROKEN
) && strchr(fullref
.buf
, '/')) {
492 warning("ignoring broken ref %s.", fullref
.buf
);
495 strbuf_release(&fullref
);
499 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **log
)
501 char *last_branch
= substitute_branch_name(&str
, &len
);
504 struct strbuf path
= STRBUF_INIT
;
507 for (p
= ref_rev_parse_rules
; *p
; p
++) {
508 unsigned char hash
[20];
509 const char *ref
, *it
;
512 strbuf_addf(&path
, *p
, len
, str
);
513 ref
= resolve_ref_unsafe(path
.buf
, RESOLVE_REF_READING
,
517 if (reflog_exists(path
.buf
))
519 else if (strcmp(ref
, path
.buf
) && reflog_exists(ref
))
527 if (!warn_ambiguous_refs
)
530 strbuf_release(&path
);
535 static int is_per_worktree_ref(const char *refname
)
537 return !strcmp(refname
, "HEAD") ||
538 starts_with(refname
, "refs/bisect/");
541 static int is_pseudoref_syntax(const char *refname
)
545 for (c
= refname
; *c
; c
++) {
546 if (!isupper(*c
) && *c
!= '-' && *c
!= '_')
553 enum ref_type
ref_type(const char *refname
)
555 if (is_per_worktree_ref(refname
))
556 return REF_TYPE_PER_WORKTREE
;
557 if (is_pseudoref_syntax(refname
))
558 return REF_TYPE_PSEUDOREF
;
559 return REF_TYPE_NORMAL
;
562 long get_files_ref_lock_timeout_ms(void)
564 static int configured
= 0;
566 /* The default timeout is 100 ms: */
567 static int timeout_ms
= 100;
570 git_config_get_int("core.filesreflocktimeout", &timeout_ms
);
577 static int write_pseudoref(const char *pseudoref
, const unsigned char *sha1
,
578 const unsigned char *old_sha1
, struct strbuf
*err
)
580 const char *filename
;
582 static struct lock_file lock
;
583 struct strbuf buf
= STRBUF_INIT
;
586 strbuf_addf(&buf
, "%s\n", sha1_to_hex(sha1
));
588 filename
= git_path("%s", pseudoref
);
589 fd
= hold_lock_file_for_update_timeout(&lock
, filename
,
591 get_files_ref_lock_timeout_ms());
593 strbuf_addf(err
, "could not open '%s' for writing: %s",
594 filename
, strerror(errno
));
599 unsigned char actual_old_sha1
[20];
601 if (read_ref(pseudoref
, actual_old_sha1
))
602 die("could not read ref '%s'", pseudoref
);
603 if (hashcmp(actual_old_sha1
, old_sha1
)) {
604 strbuf_addf(err
, "unexpected sha1 when writing '%s'", pseudoref
);
605 rollback_lock_file(&lock
);
610 if (write_in_full(fd
, buf
.buf
, buf
.len
) != buf
.len
) {
611 strbuf_addf(err
, "could not write to '%s'", filename
);
612 rollback_lock_file(&lock
);
616 commit_lock_file(&lock
);
619 strbuf_release(&buf
);
623 static int delete_pseudoref(const char *pseudoref
, const unsigned char *old_sha1
)
625 static struct lock_file lock
;
626 const char *filename
;
628 filename
= git_path("%s", pseudoref
);
630 if (old_sha1
&& !is_null_sha1(old_sha1
)) {
632 unsigned char actual_old_sha1
[20];
634 fd
= hold_lock_file_for_update_timeout(
635 &lock
, filename
, LOCK_DIE_ON_ERROR
,
636 get_files_ref_lock_timeout_ms());
638 die_errno(_("Could not open '%s' for writing"), filename
);
639 if (read_ref(pseudoref
, actual_old_sha1
))
640 die("could not read ref '%s'", pseudoref
);
641 if (hashcmp(actual_old_sha1
, old_sha1
)) {
642 warning("Unexpected sha1 when deleting %s", pseudoref
);
643 rollback_lock_file(&lock
);
648 rollback_lock_file(&lock
);
656 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
658 const unsigned char *old_sha1
,
661 struct ref_transaction
*transaction
;
662 struct strbuf err
= STRBUF_INIT
;
664 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
665 assert(refs
== get_main_ref_store());
666 return delete_pseudoref(refname
, old_sha1
);
669 transaction
= ref_store_transaction_begin(refs
, &err
);
671 ref_transaction_delete(transaction
, refname
, old_sha1
,
673 ref_transaction_commit(transaction
, &err
)) {
674 error("%s", err
.buf
);
675 ref_transaction_free(transaction
);
676 strbuf_release(&err
);
679 ref_transaction_free(transaction
);
680 strbuf_release(&err
);
684 int delete_ref(const char *msg
, const char *refname
,
685 const unsigned char *old_sha1
, unsigned int flags
)
687 return refs_delete_ref(get_main_ref_store(), msg
, refname
,
691 int copy_reflog_msg(char *buf
, const char *msg
)
698 while ((c
= *msg
++)) {
699 if (wasspace
&& isspace(c
))
701 wasspace
= isspace(c
);
706 while (buf
< cp
&& isspace(cp
[-1]))
712 int should_autocreate_reflog(const char *refname
)
714 switch (log_all_ref_updates
) {
715 case LOG_REFS_ALWAYS
:
717 case LOG_REFS_NORMAL
:
718 return starts_with(refname
, "refs/heads/") ||
719 starts_with(refname
, "refs/remotes/") ||
720 starts_with(refname
, "refs/notes/") ||
721 !strcmp(refname
, "HEAD");
727 int is_branch(const char *refname
)
729 return !strcmp(refname
, "HEAD") || starts_with(refname
, "refs/heads/");
732 struct read_ref_at_cb
{
740 unsigned char osha1
[20];
741 unsigned char nsha1
[20];
745 timestamp_t
*cutoff_time
;
750 static int read_ref_at_ent(struct object_id
*ooid
, struct object_id
*noid
,
751 const char *email
, timestamp_t timestamp
, int tz
,
752 const char *message
, void *cb_data
)
754 struct read_ref_at_cb
*cb
= cb_data
;
758 cb
->date
= timestamp
;
760 if (timestamp
<= cb
->at_time
|| cb
->cnt
== 0) {
762 *cb
->msg
= xstrdup(message
);
764 *cb
->cutoff_time
= timestamp
;
768 *cb
->cutoff_cnt
= cb
->reccnt
- 1;
770 * we have not yet updated cb->[n|o]sha1 so they still
771 * hold the values for the previous record.
773 if (!is_null_sha1(cb
->osha1
)) {
774 hashcpy(cb
->sha1
, noid
->hash
);
775 if (hashcmp(cb
->osha1
, noid
->hash
))
776 warning("Log for ref %s has gap after %s.",
777 cb
->refname
, show_date(cb
->date
, cb
->tz
, DATE_MODE(RFC2822
)));
779 else if (cb
->date
== cb
->at_time
)
780 hashcpy(cb
->sha1
, noid
->hash
);
781 else if (hashcmp(noid
->hash
, cb
->sha1
))
782 warning("Log for ref %s unexpectedly ended on %s.",
783 cb
->refname
, show_date(cb
->date
, cb
->tz
,
784 DATE_MODE(RFC2822
)));
785 hashcpy(cb
->osha1
, ooid
->hash
);
786 hashcpy(cb
->nsha1
, noid
->hash
);
790 hashcpy(cb
->osha1
, ooid
->hash
);
791 hashcpy(cb
->nsha1
, noid
->hash
);
797 static int read_ref_at_ent_oldest(struct object_id
*ooid
, struct object_id
*noid
,
798 const char *email
, timestamp_t timestamp
,
799 int tz
, const char *message
, void *cb_data
)
801 struct read_ref_at_cb
*cb
= cb_data
;
804 *cb
->msg
= xstrdup(message
);
806 *cb
->cutoff_time
= timestamp
;
810 *cb
->cutoff_cnt
= cb
->reccnt
;
811 hashcpy(cb
->sha1
, ooid
->hash
);
812 if (is_null_sha1(cb
->sha1
))
813 hashcpy(cb
->sha1
, noid
->hash
);
814 /* We just want the first entry */
818 int read_ref_at(const char *refname
, unsigned int flags
, timestamp_t at_time
, int cnt
,
819 unsigned char *sha1
, char **msg
,
820 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
)
822 struct read_ref_at_cb cb
;
824 memset(&cb
, 0, sizeof(cb
));
825 cb
.refname
= refname
;
826 cb
.at_time
= at_time
;
829 cb
.cutoff_time
= cutoff_time
;
830 cb
.cutoff_tz
= cutoff_tz
;
831 cb
.cutoff_cnt
= cutoff_cnt
;
834 for_each_reflog_ent_reverse(refname
, read_ref_at_ent
, &cb
);
837 if (flags
& GET_OID_QUIETLY
)
840 die("Log for %s is empty.", refname
);
845 for_each_reflog_ent(refname
, read_ref_at_ent_oldest
, &cb
);
850 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
853 struct ref_transaction
*tr
;
856 tr
= xcalloc(1, sizeof(struct ref_transaction
));
857 tr
->ref_store
= refs
;
861 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
)
863 return ref_store_transaction_begin(get_main_ref_store(), err
);
866 void ref_transaction_free(struct ref_transaction
*transaction
)
873 switch (transaction
->state
) {
874 case REF_TRANSACTION_OPEN
:
875 case REF_TRANSACTION_CLOSED
:
878 case REF_TRANSACTION_PREPARED
:
879 die("BUG: free called on a prepared reference transaction");
882 die("BUG: unexpected reference transaction state");
886 for (i
= 0; i
< transaction
->nr
; i
++) {
887 free(transaction
->updates
[i
]->msg
);
888 free(transaction
->updates
[i
]);
890 free(transaction
->updates
);
894 struct ref_update
*ref_transaction_add_update(
895 struct ref_transaction
*transaction
,
896 const char *refname
, unsigned int flags
,
897 const unsigned char *new_sha1
,
898 const unsigned char *old_sha1
,
901 struct ref_update
*update
;
903 if (transaction
->state
!= REF_TRANSACTION_OPEN
)
904 die("BUG: update called for transaction that is not open");
906 if ((flags
& REF_ISPRUNING
) && !(flags
& REF_NODEREF
))
907 die("BUG: REF_ISPRUNING set without REF_NODEREF");
909 FLEX_ALLOC_STR(update
, refname
, refname
);
910 ALLOC_GROW(transaction
->updates
, transaction
->nr
+ 1, transaction
->alloc
);
911 transaction
->updates
[transaction
->nr
++] = update
;
913 update
->flags
= flags
;
915 if (flags
& REF_HAVE_NEW
)
916 hashcpy(update
->new_oid
.hash
, new_sha1
);
917 if (flags
& REF_HAVE_OLD
)
918 hashcpy(update
->old_oid
.hash
, old_sha1
);
919 update
->msg
= xstrdup_or_null(msg
);
923 int ref_transaction_update(struct ref_transaction
*transaction
,
925 const unsigned char *new_sha1
,
926 const unsigned char *old_sha1
,
927 unsigned int flags
, const char *msg
,
932 if ((new_sha1
&& !is_null_sha1(new_sha1
)) ?
933 check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
) :
934 !refname_is_safe(refname
)) {
935 strbuf_addf(err
, "refusing to update ref with bad name '%s'",
940 flags
|= (new_sha1
? REF_HAVE_NEW
: 0) | (old_sha1
? REF_HAVE_OLD
: 0);
942 ref_transaction_add_update(transaction
, refname
, flags
,
943 new_sha1
, old_sha1
, msg
);
947 int ref_transaction_create(struct ref_transaction
*transaction
,
949 const unsigned char *new_sha1
,
950 unsigned int flags
, const char *msg
,
953 if (!new_sha1
|| is_null_sha1(new_sha1
))
954 die("BUG: create called without valid new_sha1");
955 return ref_transaction_update(transaction
, refname
, new_sha1
,
956 null_sha1
, flags
, msg
, err
);
959 int ref_transaction_delete(struct ref_transaction
*transaction
,
961 const unsigned char *old_sha1
,
962 unsigned int flags
, const char *msg
,
965 if (old_sha1
&& is_null_sha1(old_sha1
))
966 die("BUG: delete called with old_sha1 set to zeros");
967 return ref_transaction_update(transaction
, refname
,
972 int ref_transaction_verify(struct ref_transaction
*transaction
,
974 const unsigned char *old_sha1
,
979 die("BUG: verify called with old_sha1 set to NULL");
980 return ref_transaction_update(transaction
, refname
,
985 int update_ref_oid(const char *msg
, const char *refname
,
986 const struct object_id
*new_oid
, const struct object_id
*old_oid
,
987 unsigned int flags
, enum action_on_err onerr
)
989 return update_ref(msg
, refname
, new_oid
? new_oid
->hash
: NULL
,
990 old_oid
? old_oid
->hash
: NULL
, flags
, onerr
);
993 int refs_update_ref(struct ref_store
*refs
, const char *msg
,
994 const char *refname
, const unsigned char *new_sha1
,
995 const unsigned char *old_sha1
, unsigned int flags
,
996 enum action_on_err onerr
)
998 struct ref_transaction
*t
= NULL
;
999 struct strbuf err
= STRBUF_INIT
;
1002 if (ref_type(refname
) == REF_TYPE_PSEUDOREF
) {
1003 assert(refs
== get_main_ref_store());
1004 ret
= write_pseudoref(refname
, new_sha1
, old_sha1
, &err
);
1006 t
= ref_store_transaction_begin(refs
, &err
);
1008 ref_transaction_update(t
, refname
, new_sha1
, old_sha1
,
1009 flags
, msg
, &err
) ||
1010 ref_transaction_commit(t
, &err
)) {
1012 ref_transaction_free(t
);
1016 const char *str
= "update_ref failed for ref '%s': %s";
1019 case UPDATE_REFS_MSG_ON_ERR
:
1020 error(str
, refname
, err
.buf
);
1022 case UPDATE_REFS_DIE_ON_ERR
:
1023 die(str
, refname
, err
.buf
);
1025 case UPDATE_REFS_QUIET_ON_ERR
:
1028 strbuf_release(&err
);
1031 strbuf_release(&err
);
1033 ref_transaction_free(t
);
1037 int update_ref(const char *msg
, const char *refname
,
1038 const unsigned char *new_sha1
,
1039 const unsigned char *old_sha1
,
1040 unsigned int flags
, enum action_on_err onerr
)
1042 return refs_update_ref(get_main_ref_store(), msg
, refname
, new_sha1
,
1043 old_sha1
, flags
, onerr
);
1046 char *shorten_unambiguous_ref(const char *refname
, int strict
)
1049 static char **scanf_fmts
;
1050 static int nr_rules
;
1052 struct strbuf resolved_buf
= STRBUF_INIT
;
1056 * Pre-generate scanf formats from ref_rev_parse_rules[].
1057 * Generate a format suitable for scanf from a
1058 * ref_rev_parse_rules rule by interpolating "%s" at the
1059 * location of the "%.*s".
1061 size_t total_len
= 0;
1064 /* the rule list is NULL terminated, count them first */
1065 for (nr_rules
= 0; ref_rev_parse_rules
[nr_rules
]; nr_rules
++)
1066 /* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
1067 total_len
+= strlen(ref_rev_parse_rules
[nr_rules
]) - 2 + 1;
1069 scanf_fmts
= xmalloc(st_add(st_mult(sizeof(char *), nr_rules
), total_len
));
1072 for (i
= 0; i
< nr_rules
; i
++) {
1073 assert(offset
< total_len
);
1074 scanf_fmts
[i
] = (char *)&scanf_fmts
[nr_rules
] + offset
;
1075 offset
+= snprintf(scanf_fmts
[i
], total_len
- offset
,
1076 ref_rev_parse_rules
[i
], 2, "%s") + 1;
1080 /* bail out if there are no rules */
1082 return xstrdup(refname
);
1084 /* buffer for scanf result, at most refname must fit */
1085 short_name
= xstrdup(refname
);
1087 /* skip first rule, it will always match */
1088 for (i
= nr_rules
- 1; i
> 0 ; --i
) {
1090 int rules_to_fail
= i
;
1093 if (1 != sscanf(refname
, scanf_fmts
[i
], short_name
))
1096 short_name_len
= strlen(short_name
);
1099 * in strict mode, all (except the matched one) rules
1100 * must fail to resolve to a valid non-ambiguous ref
1103 rules_to_fail
= nr_rules
;
1106 * check if the short name resolves to a valid ref,
1107 * but use only rules prior to the matched one
1109 for (j
= 0; j
< rules_to_fail
; j
++) {
1110 const char *rule
= ref_rev_parse_rules
[j
];
1112 /* skip matched rule */
1117 * the short name is ambiguous, if it resolves
1118 * (with this previous rule) to a valid ref
1119 * read_ref() returns 0 on success
1121 strbuf_reset(&resolved_buf
);
1122 strbuf_addf(&resolved_buf
, rule
,
1123 short_name_len
, short_name
);
1124 if (ref_exists(resolved_buf
.buf
))
1129 * short name is non-ambiguous if all previous rules
1130 * haven't resolved to a valid ref
1132 if (j
== rules_to_fail
) {
1133 strbuf_release(&resolved_buf
);
1138 strbuf_release(&resolved_buf
);
1140 return xstrdup(refname
);
1143 static struct string_list
*hide_refs
;
1145 int parse_hide_refs_config(const char *var
, const char *value
, const char *section
)
1148 if (!strcmp("transfer.hiderefs", var
) ||
1149 (!parse_config_key(var
, section
, NULL
, NULL
, &key
) &&
1150 !strcmp(key
, "hiderefs"))) {
1155 return config_error_nonbool(var
);
1156 ref
= xstrdup(value
);
1158 while (len
&& ref
[len
- 1] == '/')
1161 hide_refs
= xcalloc(1, sizeof(*hide_refs
));
1162 hide_refs
->strdup_strings
= 1;
1164 string_list_append(hide_refs
, ref
);
1169 int ref_is_hidden(const char *refname
, const char *refname_full
)
1175 for (i
= hide_refs
->nr
- 1; i
>= 0; i
--) {
1176 const char *match
= hide_refs
->items
[i
].string
;
1177 const char *subject
;
1181 if (*match
== '!') {
1186 if (*match
== '^') {
1187 subject
= refname_full
;
1193 /* refname can be NULL when namespaces are used. */
1195 skip_prefix(subject
, match
, &p
) &&
1202 const char *find_descendant_ref(const char *dirname
,
1203 const struct string_list
*extras
,
1204 const struct string_list
*skip
)
1212 * Look at the place where dirname would be inserted into
1213 * extras. If there is an entry at that position that starts
1214 * with dirname (remember, dirname includes the trailing
1215 * slash) and is not in skip, then we have a conflict.
1217 for (pos
= string_list_find_insert_index(extras
, dirname
, 0);
1218 pos
< extras
->nr
; pos
++) {
1219 const char *extra_refname
= extras
->items
[pos
].string
;
1221 if (!starts_with(extra_refname
, dirname
))
1224 if (!skip
|| !string_list_has_string(skip
, extra_refname
))
1225 return extra_refname
;
1230 int refs_rename_ref_available(struct ref_store
*refs
,
1231 const char *old_refname
,
1232 const char *new_refname
)
1234 struct string_list skip
= STRING_LIST_INIT_NODUP
;
1235 struct strbuf err
= STRBUF_INIT
;
1238 string_list_insert(&skip
, old_refname
);
1239 ok
= !refs_verify_refname_available(refs
, new_refname
,
1242 error("%s", err
.buf
);
1244 string_list_clear(&skip
, 0);
1245 strbuf_release(&err
);
1249 int refs_head_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1251 struct object_id oid
;
1254 if (!refs_read_ref_full(refs
, "HEAD", RESOLVE_REF_READING
,
1256 return fn("HEAD", &oid
, flag
, cb_data
);
1261 int head_ref(each_ref_fn fn
, void *cb_data
)
1263 return refs_head_ref(get_main_ref_store(), fn
, cb_data
);
1266 struct ref_iterator
*refs_ref_iterator_begin(
1267 struct ref_store
*refs
,
1268 const char *prefix
, int trim
, int flags
)
1270 struct ref_iterator
*iter
;
1272 if (ref_paranoia
< 0)
1273 ref_paranoia
= git_env_bool("GIT_REF_PARANOIA", 0);
1275 flags
|= DO_FOR_EACH_INCLUDE_BROKEN
;
1277 iter
= refs
->be
->iterator_begin(refs
, prefix
, flags
);
1280 * `iterator_begin()` already takes care of prefix, but we
1281 * might need to do some trimming:
1284 iter
= prefix_ref_iterator_begin(iter
, "", trim
);
1290 * Call fn for each reference in the specified submodule for which the
1291 * refname begins with prefix. If trim is non-zero, then trim that
1292 * many characters off the beginning of each refname before passing
1293 * the refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to
1294 * include broken references in the iteration. If fn ever returns a
1295 * non-zero value, stop the iteration and return that value;
1296 * otherwise, return 0.
1298 static int do_for_each_ref(struct ref_store
*refs
, const char *prefix
,
1299 each_ref_fn fn
, int trim
, int flags
, void *cb_data
)
1301 struct ref_iterator
*iter
;
1306 iter
= refs_ref_iterator_begin(refs
, prefix
, trim
, flags
);
1308 return do_for_each_ref_iterator(iter
, fn
, cb_data
);
1311 int refs_for_each_ref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1313 return do_for_each_ref(refs
, "", fn
, 0, 0, cb_data
);
1316 int for_each_ref(each_ref_fn fn
, void *cb_data
)
1318 return refs_for_each_ref(get_main_ref_store(), fn
, cb_data
);
1321 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
1322 each_ref_fn fn
, void *cb_data
)
1324 return do_for_each_ref(refs
, prefix
, fn
, strlen(prefix
), 0, cb_data
);
1327 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
)
1329 return refs_for_each_ref_in(get_main_ref_store(), prefix
, fn
, cb_data
);
1332 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
, unsigned int broken
)
1334 unsigned int flag
= 0;
1337 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1338 return do_for_each_ref(get_main_ref_store(),
1339 prefix
, fn
, 0, flag
, cb_data
);
1342 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
1343 each_ref_fn fn
, void *cb_data
,
1344 unsigned int broken
)
1346 unsigned int flag
= 0;
1349 flag
= DO_FOR_EACH_INCLUDE_BROKEN
;
1350 return do_for_each_ref(refs
, prefix
, fn
, 0, flag
, cb_data
);
1353 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
)
1355 return do_for_each_ref(get_main_ref_store(),
1356 git_replace_ref_base
, fn
,
1357 strlen(git_replace_ref_base
),
1361 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
)
1363 struct strbuf buf
= STRBUF_INIT
;
1365 strbuf_addf(&buf
, "%srefs/", get_git_namespace());
1366 ret
= do_for_each_ref(get_main_ref_store(),
1367 buf
.buf
, fn
, 0, 0, cb_data
);
1368 strbuf_release(&buf
);
1372 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1374 return do_for_each_ref(refs
, "", fn
, 0,
1375 DO_FOR_EACH_INCLUDE_BROKEN
, cb_data
);
1378 int for_each_rawref(each_ref_fn fn
, void *cb_data
)
1380 return refs_for_each_rawref(get_main_ref_store(), fn
, cb_data
);
1383 int refs_read_raw_ref(struct ref_store
*ref_store
,
1384 const char *refname
, unsigned char *sha1
,
1385 struct strbuf
*referent
, unsigned int *type
)
1387 return ref_store
->be
->read_raw_ref(ref_store
, refname
, sha1
, referent
, type
);
1390 /* This function needs to return a meaningful errno on failure */
1391 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
1392 const char *refname
,
1394 unsigned char *sha1
, int *flags
)
1396 static struct strbuf sb_refname
= STRBUF_INIT
;
1397 struct object_id unused_oid
;
1402 sha1
= unused_oid
.hash
;
1404 flags
= &unused_flags
;
1408 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1409 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1410 !refname_is_safe(refname
)) {
1416 * dwim_ref() uses REF_ISBROKEN to distinguish between
1417 * missing refs and refs that were present but invalid,
1418 * to complain about the latter to stderr.
1420 * We don't know whether the ref exists, so don't set
1423 *flags
|= REF_BAD_NAME
;
1426 for (symref_count
= 0; symref_count
< SYMREF_MAXDEPTH
; symref_count
++) {
1427 unsigned int read_flags
= 0;
1429 if (refs_read_raw_ref(refs
, refname
,
1430 sha1
, &sb_refname
, &read_flags
)) {
1431 *flags
|= read_flags
;
1432 if (errno
!= ENOENT
|| (resolve_flags
& RESOLVE_REF_READING
))
1435 if (*flags
& REF_BAD_NAME
)
1436 *flags
|= REF_ISBROKEN
;
1440 *flags
|= read_flags
;
1442 if (!(read_flags
& REF_ISSYMREF
)) {
1443 if (*flags
& REF_BAD_NAME
) {
1445 *flags
|= REF_ISBROKEN
;
1450 refname
= sb_refname
.buf
;
1451 if (resolve_flags
& RESOLVE_REF_NO_RECURSE
) {
1455 if (check_refname_format(refname
, REFNAME_ALLOW_ONELEVEL
)) {
1456 if (!(resolve_flags
& RESOLVE_REF_ALLOW_BAD_NAME
) ||
1457 !refname_is_safe(refname
)) {
1462 *flags
|= REF_ISBROKEN
| REF_BAD_NAME
;
1470 /* backend functions */
1471 int refs_init_db(struct strbuf
*err
)
1473 struct ref_store
*refs
= get_main_ref_store();
1475 return refs
->be
->init_db(refs
, err
);
1478 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
1479 unsigned char *sha1
, int *flags
)
1481 return refs_resolve_ref_unsafe(get_main_ref_store(), refname
,
1482 resolve_flags
, sha1
, flags
);
1485 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
1486 unsigned char *sha1
)
1488 struct ref_store
*refs
;
1491 refs
= get_submodule_ref_store(submodule
);
1496 if (!refs_resolve_ref_unsafe(refs
, refname
, 0, sha1
, &flags
) ||
1502 struct ref_store_hash_entry
1504 struct hashmap_entry ent
; /* must be the first member! */
1506 struct ref_store
*refs
;
1508 /* NUL-terminated identifier of the ref store: */
1509 char name
[FLEX_ARRAY
];
1512 static int ref_store_hash_cmp(const void *unused_cmp_data
,
1513 const void *entry
, const void *entry_or_key
,
1514 const void *keydata
)
1516 const struct ref_store_hash_entry
*e1
= entry
, *e2
= entry_or_key
;
1517 const char *name
= keydata
? keydata
: e2
->name
;
1519 return strcmp(e1
->name
, name
);
1522 static struct ref_store_hash_entry
*alloc_ref_store_hash_entry(
1523 const char *name
, struct ref_store
*refs
)
1525 struct ref_store_hash_entry
*entry
;
1527 FLEX_ALLOC_STR(entry
, name
, name
);
1528 hashmap_entry_init(entry
, strhash(name
));
1533 /* A pointer to the ref_store for the main repository: */
1534 static struct ref_store
*main_ref_store
;
1536 /* A hashmap of ref_stores, stored by submodule name: */
1537 static struct hashmap submodule_ref_stores
;
1539 /* A hashmap of ref_stores, stored by worktree id: */
1540 static struct hashmap worktree_ref_stores
;
1543 * Look up a ref store by name. If that ref_store hasn't been
1544 * registered yet, return NULL.
1546 static struct ref_store
*lookup_ref_store_map(struct hashmap
*map
,
1549 struct ref_store_hash_entry
*entry
;
1551 if (!map
->tablesize
)
1552 /* It's initialized on demand in register_ref_store(). */
1555 entry
= hashmap_get_from_hash(map
, strhash(name
), name
);
1556 return entry
? entry
->refs
: NULL
;
1560 * Create, record, and return a ref_store instance for the specified
1563 static struct ref_store
*ref_store_init(const char *gitdir
,
1566 const char *be_name
= "files";
1567 struct ref_storage_be
*be
= find_ref_storage_backend(be_name
);
1568 struct ref_store
*refs
;
1571 die("BUG: reference backend %s is unknown", be_name
);
1573 refs
= be
->init(gitdir
, flags
);
1577 struct ref_store
*get_main_ref_store(void)
1580 return main_ref_store
;
1582 main_ref_store
= ref_store_init(get_git_dir(), REF_STORE_ALL_CAPS
);
1583 return main_ref_store
;
1587 * Associate a ref store with a name. It is a fatal error to call this
1588 * function twice for the same name.
1590 static void register_ref_store_map(struct hashmap
*map
,
1592 struct ref_store
*refs
,
1595 if (!map
->tablesize
)
1596 hashmap_init(map
, ref_store_hash_cmp
, NULL
, 0);
1598 if (hashmap_put(map
, alloc_ref_store_hash_entry(name
, refs
)))
1599 die("BUG: %s ref_store '%s' initialized twice", type
, name
);
1602 struct ref_store
*get_submodule_ref_store(const char *submodule
)
1604 struct strbuf submodule_sb
= STRBUF_INIT
;
1605 struct ref_store
*refs
;
1606 char *to_free
= NULL
;
1612 len
= strlen(submodule
);
1613 while (len
&& is_dir_sep(submodule
[len
- 1]))
1619 /* We need to strip off one or more trailing slashes */
1620 submodule
= to_free
= xmemdupz(submodule
, len
);
1622 refs
= lookup_ref_store_map(&submodule_ref_stores
, submodule
);
1626 strbuf_addstr(&submodule_sb
, submodule
);
1627 if (!is_nonbare_repository_dir(&submodule_sb
))
1630 if (submodule_to_gitdir(&submodule_sb
, submodule
))
1633 /* assume that add_submodule_odb() has been called */
1634 refs
= ref_store_init(submodule_sb
.buf
,
1635 REF_STORE_READ
| REF_STORE_ODB
);
1636 register_ref_store_map(&submodule_ref_stores
, "submodule",
1640 strbuf_release(&submodule_sb
);
1646 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
)
1648 struct ref_store
*refs
;
1652 return get_main_ref_store();
1654 id
= wt
->id
? wt
->id
: "/";
1655 refs
= lookup_ref_store_map(&worktree_ref_stores
, id
);
1660 refs
= ref_store_init(git_common_path("worktrees/%s", wt
->id
),
1661 REF_STORE_ALL_CAPS
);
1663 refs
= ref_store_init(get_git_common_dir(),
1664 REF_STORE_ALL_CAPS
);
1667 register_ref_store_map(&worktree_ref_stores
, "worktree",
1672 void base_ref_store_init(struct ref_store
*refs
,
1673 const struct ref_storage_be
*be
)
1678 /* backend functions */
1679 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
)
1681 return refs
->be
->pack_refs(refs
, flags
);
1684 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
1685 unsigned char *sha1
)
1687 return refs
->be
->peel_ref(refs
, refname
, sha1
);
1690 int peel_ref(const char *refname
, unsigned char *sha1
)
1692 return refs_peel_ref(get_main_ref_store(), refname
, sha1
);
1695 int refs_create_symref(struct ref_store
*refs
,
1696 const char *ref_target
,
1697 const char *refs_heads_master
,
1700 return refs
->be
->create_symref(refs
, ref_target
,
1705 int create_symref(const char *ref_target
, const char *refs_heads_master
,
1708 return refs_create_symref(get_main_ref_store(), ref_target
,
1709 refs_heads_master
, logmsg
);
1712 int ref_update_reject_duplicates(struct string_list
*refnames
,
1715 size_t i
, n
= refnames
->nr
;
1719 for (i
= 1; i
< n
; i
++) {
1720 int cmp
= strcmp(refnames
->items
[i
- 1].string
,
1721 refnames
->items
[i
].string
);
1725 "multiple updates for ref '%s' not allowed.",
1726 refnames
->items
[i
].string
);
1728 } else if (cmp
> 0) {
1729 die("BUG: ref_update_reject_duplicates() received unsorted list");
1735 int ref_transaction_prepare(struct ref_transaction
*transaction
,
1738 struct ref_store
*refs
= transaction
->ref_store
;
1740 switch (transaction
->state
) {
1741 case REF_TRANSACTION_OPEN
:
1744 case REF_TRANSACTION_PREPARED
:
1745 die("BUG: prepare called twice on reference transaction");
1747 case REF_TRANSACTION_CLOSED
:
1748 die("BUG: prepare called on a closed reference transaction");
1751 die("BUG: unexpected reference transaction state");
1755 if (getenv(GIT_QUARANTINE_ENVIRONMENT
)) {
1757 _("ref updates forbidden inside quarantine environment"));
1761 return refs
->be
->transaction_prepare(refs
, transaction
, err
);
1764 int ref_transaction_abort(struct ref_transaction
*transaction
,
1767 struct ref_store
*refs
= transaction
->ref_store
;
1770 switch (transaction
->state
) {
1771 case REF_TRANSACTION_OPEN
:
1772 /* No need to abort explicitly. */
1774 case REF_TRANSACTION_PREPARED
:
1775 ret
= refs
->be
->transaction_abort(refs
, transaction
, err
);
1777 case REF_TRANSACTION_CLOSED
:
1778 die("BUG: abort called on a closed reference transaction");
1781 die("BUG: unexpected reference transaction state");
1785 ref_transaction_free(transaction
);
1789 int ref_transaction_commit(struct ref_transaction
*transaction
,
1792 struct ref_store
*refs
= transaction
->ref_store
;
1795 switch (transaction
->state
) {
1796 case REF_TRANSACTION_OPEN
:
1797 /* Need to prepare first. */
1798 ret
= ref_transaction_prepare(transaction
, err
);
1802 case REF_TRANSACTION_PREPARED
:
1803 /* Fall through to finish. */
1805 case REF_TRANSACTION_CLOSED
:
1806 die("BUG: commit called on a closed reference transaction");
1809 die("BUG: unexpected reference transaction state");
1813 return refs
->be
->transaction_finish(refs
, transaction
, err
);
1816 int refs_verify_refname_available(struct ref_store
*refs
,
1817 const char *refname
,
1818 const struct string_list
*extras
,
1819 const struct string_list
*skip
,
1823 const char *extra_refname
;
1824 struct strbuf dirname
= STRBUF_INIT
;
1825 struct strbuf referent
= STRBUF_INIT
;
1826 struct object_id oid
;
1828 struct ref_iterator
*iter
;
1833 * For the sake of comments in this function, suppose that
1834 * refname is "refs/foo/bar".
1839 strbuf_grow(&dirname
, strlen(refname
) + 1);
1840 for (slash
= strchr(refname
, '/'); slash
; slash
= strchr(slash
+ 1, '/')) {
1841 /* Expand dirname to the new prefix, not including the trailing slash: */
1842 strbuf_add(&dirname
, refname
+ dirname
.len
, slash
- refname
- dirname
.len
);
1845 * We are still at a leading dir of the refname (e.g.,
1846 * "refs/foo"; if there is a reference with that name,
1847 * it is a conflict, *unless* it is in skip.
1849 if (skip
&& string_list_has_string(skip
, dirname
.buf
))
1852 if (!refs_read_raw_ref(refs
, dirname
.buf
, oid
.hash
, &referent
, &type
)) {
1853 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1854 dirname
.buf
, refname
);
1858 if (extras
&& string_list_has_string(extras
, dirname
.buf
)) {
1859 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1860 refname
, dirname
.buf
);
1866 * We are at the leaf of our refname (e.g., "refs/foo/bar").
1867 * There is no point in searching for a reference with that
1868 * name, because a refname isn't considered to conflict with
1869 * itself. But we still need to check for references whose
1870 * names are in the "refs/foo/bar/" namespace, because they
1873 strbuf_addstr(&dirname
, refname
+ dirname
.len
);
1874 strbuf_addch(&dirname
, '/');
1876 iter
= refs_ref_iterator_begin(refs
, dirname
.buf
, 0,
1877 DO_FOR_EACH_INCLUDE_BROKEN
);
1878 while ((ok
= ref_iterator_advance(iter
)) == ITER_OK
) {
1880 string_list_has_string(skip
, iter
->refname
))
1883 strbuf_addf(err
, "'%s' exists; cannot create '%s'",
1884 iter
->refname
, refname
);
1885 ref_iterator_abort(iter
);
1889 if (ok
!= ITER_DONE
)
1890 die("BUG: error while iterating over references");
1892 extra_refname
= find_descendant_ref(dirname
.buf
, extras
, skip
);
1894 strbuf_addf(err
, "cannot process '%s' and '%s' at the same time",
1895 refname
, extra_refname
);
1900 strbuf_release(&referent
);
1901 strbuf_release(&dirname
);
1905 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
)
1907 struct ref_iterator
*iter
;
1909 iter
= refs
->be
->reflog_iterator_begin(refs
);
1911 return do_for_each_ref_iterator(iter
, fn
, cb_data
);
1914 int for_each_reflog(each_ref_fn fn
, void *cb_data
)
1916 return refs_for_each_reflog(get_main_ref_store(), fn
, cb_data
);
1919 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
1920 const char *refname
,
1921 each_reflog_ent_fn fn
,
1924 return refs
->be
->for_each_reflog_ent_reverse(refs
, refname
,
1928 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
,
1931 return refs_for_each_reflog_ent_reverse(get_main_ref_store(),
1932 refname
, fn
, cb_data
);
1935 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
1936 each_reflog_ent_fn fn
, void *cb_data
)
1938 return refs
->be
->for_each_reflog_ent(refs
, refname
, fn
, cb_data
);
1941 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
,
1944 return refs_for_each_reflog_ent(get_main_ref_store(), refname
,
1948 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
)
1950 return refs
->be
->reflog_exists(refs
, refname
);
1953 int reflog_exists(const char *refname
)
1955 return refs_reflog_exists(get_main_ref_store(), refname
);
1958 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
1959 int force_create
, struct strbuf
*err
)
1961 return refs
->be
->create_reflog(refs
, refname
, force_create
, err
);
1964 int safe_create_reflog(const char *refname
, int force_create
,
1967 return refs_create_reflog(get_main_ref_store(), refname
,
1971 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
)
1973 return refs
->be
->delete_reflog(refs
, refname
);
1976 int delete_reflog(const char *refname
)
1978 return refs_delete_reflog(get_main_ref_store(), refname
);
1981 int refs_reflog_expire(struct ref_store
*refs
,
1982 const char *refname
, const unsigned char *sha1
,
1984 reflog_expiry_prepare_fn prepare_fn
,
1985 reflog_expiry_should_prune_fn should_prune_fn
,
1986 reflog_expiry_cleanup_fn cleanup_fn
,
1987 void *policy_cb_data
)
1989 return refs
->be
->reflog_expire(refs
, refname
, sha1
, flags
,
1990 prepare_fn
, should_prune_fn
,
1991 cleanup_fn
, policy_cb_data
);
1994 int reflog_expire(const char *refname
, const unsigned char *sha1
,
1996 reflog_expiry_prepare_fn prepare_fn
,
1997 reflog_expiry_should_prune_fn should_prune_fn
,
1998 reflog_expiry_cleanup_fn cleanup_fn
,
1999 void *policy_cb_data
)
2001 return refs_reflog_expire(get_main_ref_store(),
2002 refname
, sha1
, flags
,
2003 prepare_fn
, should_prune_fn
,
2004 cleanup_fn
, policy_cb_data
);
2007 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
2010 struct ref_store
*refs
= transaction
->ref_store
;
2012 return refs
->be
->initial_transaction_commit(refs
, transaction
, err
);
2015 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
2016 struct string_list
*refnames
, unsigned int flags
)
2018 return refs
->be
->delete_refs(refs
, msg
, refnames
, flags
);
2021 int delete_refs(const char *msg
, struct string_list
*refnames
,
2024 return refs_delete_refs(get_main_ref_store(), msg
, refnames
, flags
);
2027 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
2028 const char *newref
, const char *logmsg
)
2030 return refs
->be
->rename_ref(refs
, oldref
, newref
, logmsg
);
2033 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
)
2035 return refs_rename_ref(get_main_ref_store(), oldref
, newref
, logmsg
);