Merge tag 'v2.28.0-rc0' into debian-sid
[git/debian.git] / remote.c
blobbc46413e6a75788da66b5c0c6bec9aa5a52c5403
1 #include "cache.h"
2 #include "config.h"
3 #include "remote.h"
4 #include "refs.h"
5 #include "refspec.h"
6 #include "object-store.h"
7 #include "commit.h"
8 #include "diff.h"
9 #include "revision.h"
10 #include "dir.h"
11 #include "tag.h"
12 #include "string-list.h"
13 #include "mergesort.h"
14 #include "argv-array.h"
15 #include "commit-reach.h"
16 #include "advice.h"
18 enum map_direction { FROM_SRC, FROM_DST };
20 struct counted_string {
21 size_t len;
22 const char *s;
24 struct rewrite {
25 const char *base;
26 size_t baselen;
27 struct counted_string *instead_of;
28 int instead_of_nr;
29 int instead_of_alloc;
31 struct rewrites {
32 struct rewrite **rewrite;
33 int rewrite_alloc;
34 int rewrite_nr;
37 static struct remote **remotes;
38 static int remotes_alloc;
39 static int remotes_nr;
40 static struct hashmap remotes_hash;
42 static struct branch **branches;
43 static int branches_alloc;
44 static int branches_nr;
46 static struct branch *current_branch;
47 static const char *pushremote_name;
49 static struct rewrites rewrites;
50 static struct rewrites rewrites_push;
52 static int valid_remote(const struct remote *remote)
54 return (!!remote->url) || (!!remote->foreign_vcs);
57 static const char *alias_url(const char *url, struct rewrites *r)
59 int i, j;
60 struct counted_string *longest;
61 int longest_i;
63 longest = NULL;
64 longest_i = -1;
65 for (i = 0; i < r->rewrite_nr; i++) {
66 if (!r->rewrite[i])
67 continue;
68 for (j = 0; j < r->rewrite[i]->instead_of_nr; j++) {
69 if (starts_with(url, r->rewrite[i]->instead_of[j].s) &&
70 (!longest ||
71 longest->len < r->rewrite[i]->instead_of[j].len)) {
72 longest = &(r->rewrite[i]->instead_of[j]);
73 longest_i = i;
77 if (!longest)
78 return url;
80 return xstrfmt("%s%s", r->rewrite[longest_i]->base, url + longest->len);
83 static void add_url(struct remote *remote, const char *url)
85 ALLOC_GROW(remote->url, remote->url_nr + 1, remote->url_alloc);
86 remote->url[remote->url_nr++] = url;
89 static void add_pushurl(struct remote *remote, const char *pushurl)
91 ALLOC_GROW(remote->pushurl, remote->pushurl_nr + 1, remote->pushurl_alloc);
92 remote->pushurl[remote->pushurl_nr++] = pushurl;
95 static void add_pushurl_alias(struct remote *remote, const char *url)
97 const char *pushurl = alias_url(url, &rewrites_push);
98 if (pushurl != url)
99 add_pushurl(remote, pushurl);
102 static void add_url_alias(struct remote *remote, const char *url)
104 add_url(remote, alias_url(url, &rewrites));
105 add_pushurl_alias(remote, url);
108 struct remotes_hash_key {
109 const char *str;
110 int len;
113 static int remotes_hash_cmp(const void *unused_cmp_data,
114 const struct hashmap_entry *eptr,
115 const struct hashmap_entry *entry_or_key,
116 const void *keydata)
118 const struct remote *a, *b;
119 const struct remotes_hash_key *key = keydata;
121 a = container_of(eptr, const struct remote, ent);
122 b = container_of(entry_or_key, const struct remote, ent);
124 if (key)
125 return strncmp(a->name, key->str, key->len) || a->name[key->len];
126 else
127 return strcmp(a->name, b->name);
130 static inline void init_remotes_hash(void)
132 if (!remotes_hash.cmpfn)
133 hashmap_init(&remotes_hash, remotes_hash_cmp, NULL, 0);
136 static struct remote *make_remote(const char *name, int len)
138 struct remote *ret, *replaced;
139 struct remotes_hash_key lookup;
140 struct hashmap_entry lookup_entry, *e;
142 if (!len)
143 len = strlen(name);
145 init_remotes_hash();
146 lookup.str = name;
147 lookup.len = len;
148 hashmap_entry_init(&lookup_entry, memhash(name, len));
150 e = hashmap_get(&remotes_hash, &lookup_entry, &lookup);
151 if (e)
152 return container_of(e, struct remote, ent);
154 ret = xcalloc(1, sizeof(struct remote));
155 ret->prune = -1; /* unspecified */
156 ret->prune_tags = -1; /* unspecified */
157 ret->name = xstrndup(name, len);
158 refspec_init(&ret->push, REFSPEC_PUSH);
159 refspec_init(&ret->fetch, REFSPEC_FETCH);
161 ALLOC_GROW(remotes, remotes_nr + 1, remotes_alloc);
162 remotes[remotes_nr++] = ret;
164 hashmap_entry_init(&ret->ent, lookup_entry.hash);
165 replaced = hashmap_put_entry(&remotes_hash, ret, ent);
166 assert(replaced == NULL); /* no previous entry overwritten */
167 return ret;
170 static void add_merge(struct branch *branch, const char *name)
172 ALLOC_GROW(branch->merge_name, branch->merge_nr + 1,
173 branch->merge_alloc);
174 branch->merge_name[branch->merge_nr++] = name;
177 static struct branch *make_branch(const char *name, size_t len)
179 struct branch *ret;
180 int i;
182 for (i = 0; i < branches_nr; i++) {
183 if (!strncmp(name, branches[i]->name, len) &&
184 !branches[i]->name[len])
185 return branches[i];
188 ALLOC_GROW(branches, branches_nr + 1, branches_alloc);
189 ret = xcalloc(1, sizeof(struct branch));
190 branches[branches_nr++] = ret;
191 ret->name = xstrndup(name, len);
192 ret->refname = xstrfmt("refs/heads/%s", ret->name);
194 return ret;
197 static struct rewrite *make_rewrite(struct rewrites *r,
198 const char *base, size_t len)
200 struct rewrite *ret;
201 int i;
203 for (i = 0; i < r->rewrite_nr; i++) {
204 if (len == r->rewrite[i]->baselen &&
205 !strncmp(base, r->rewrite[i]->base, len))
206 return r->rewrite[i];
209 ALLOC_GROW(r->rewrite, r->rewrite_nr + 1, r->rewrite_alloc);
210 ret = xcalloc(1, sizeof(struct rewrite));
211 r->rewrite[r->rewrite_nr++] = ret;
212 ret->base = xstrndup(base, len);
213 ret->baselen = len;
214 return ret;
217 static void add_instead_of(struct rewrite *rewrite, const char *instead_of)
219 ALLOC_GROW(rewrite->instead_of, rewrite->instead_of_nr + 1, rewrite->instead_of_alloc);
220 rewrite->instead_of[rewrite->instead_of_nr].s = instead_of;
221 rewrite->instead_of[rewrite->instead_of_nr].len = strlen(instead_of);
222 rewrite->instead_of_nr++;
225 static const char *skip_spaces(const char *s)
227 while (isspace(*s))
228 s++;
229 return s;
232 static void read_remotes_file(struct remote *remote)
234 struct strbuf buf = STRBUF_INIT;
235 FILE *f = fopen_or_warn(git_path("remotes/%s", remote->name), "r");
237 if (!f)
238 return;
239 remote->configured_in_repo = 1;
240 remote->origin = REMOTE_REMOTES;
241 while (strbuf_getline(&buf, f) != EOF) {
242 const char *v;
244 strbuf_rtrim(&buf);
246 if (skip_prefix(buf.buf, "URL:", &v))
247 add_url_alias(remote, xstrdup(skip_spaces(v)));
248 else if (skip_prefix(buf.buf, "Push:", &v))
249 refspec_append(&remote->push, skip_spaces(v));
250 else if (skip_prefix(buf.buf, "Pull:", &v))
251 refspec_append(&remote->fetch, skip_spaces(v));
253 strbuf_release(&buf);
254 fclose(f);
257 static void read_branches_file(struct remote *remote)
259 char *frag;
260 struct strbuf buf = STRBUF_INIT;
261 FILE *f = fopen_or_warn(git_path("branches/%s", remote->name), "r");
263 if (!f)
264 return;
266 strbuf_getline_lf(&buf, f);
267 fclose(f);
268 strbuf_trim(&buf);
269 if (!buf.len) {
270 strbuf_release(&buf);
271 return;
274 remote->configured_in_repo = 1;
275 remote->origin = REMOTE_BRANCHES;
278 * The branches file would have URL and optionally
279 * #branch specified. The default (or specified) branch is
280 * fetched and stored in the local branch matching the
281 * remote name.
283 frag = strchr(buf.buf, '#');
284 if (frag)
285 *(frag++) = '\0';
286 else
287 frag = (char *)git_default_branch_name();
289 add_url_alias(remote, strbuf_detach(&buf, NULL));
290 strbuf_addf(&buf, "refs/heads/%s:refs/heads/%s",
291 frag, remote->name);
292 refspec_append(&remote->fetch, buf.buf);
295 * Cogito compatible push: push current HEAD to remote #branch
296 * (master if missing)
298 strbuf_reset(&buf);
299 strbuf_addf(&buf, "HEAD:refs/heads/%s", frag);
300 refspec_append(&remote->push, buf.buf);
301 remote->fetch_tags = 1; /* always auto-follow */
302 strbuf_release(&buf);
305 static int handle_config(const char *key, const char *value, void *cb)
307 const char *name;
308 size_t namelen;
309 const char *subkey;
310 struct remote *remote;
311 struct branch *branch;
312 if (parse_config_key(key, "branch", &name, &namelen, &subkey) >= 0) {
313 if (!name)
314 return 0;
315 branch = make_branch(name, namelen);
316 if (!strcmp(subkey, "remote")) {
317 return git_config_string(&branch->remote_name, key, value);
318 } else if (!strcmp(subkey, "pushremote")) {
319 return git_config_string(&branch->pushremote_name, key, value);
320 } else if (!strcmp(subkey, "merge")) {
321 if (!value)
322 return config_error_nonbool(key);
323 add_merge(branch, xstrdup(value));
325 return 0;
327 if (parse_config_key(key, "url", &name, &namelen, &subkey) >= 0) {
328 struct rewrite *rewrite;
329 if (!name)
330 return 0;
331 if (!strcmp(subkey, "insteadof")) {
332 if (!value)
333 return config_error_nonbool(key);
334 rewrite = make_rewrite(&rewrites, name, namelen);
335 add_instead_of(rewrite, xstrdup(value));
336 } else if (!strcmp(subkey, "pushinsteadof")) {
337 if (!value)
338 return config_error_nonbool(key);
339 rewrite = make_rewrite(&rewrites_push, name, namelen);
340 add_instead_of(rewrite, xstrdup(value));
344 if (parse_config_key(key, "remote", &name, &namelen, &subkey) < 0)
345 return 0;
347 /* Handle remote.* variables */
348 if (!name && !strcmp(subkey, "pushdefault"))
349 return git_config_string(&pushremote_name, key, value);
351 if (!name)
352 return 0;
353 /* Handle remote.<name>.* variables */
354 if (*name == '/') {
355 warning(_("config remote shorthand cannot begin with '/': %s"),
356 name);
357 return 0;
359 remote = make_remote(name, namelen);
360 remote->origin = REMOTE_CONFIG;
361 if (current_config_scope() == CONFIG_SCOPE_LOCAL ||
362 current_config_scope() == CONFIG_SCOPE_WORKTREE)
363 remote->configured_in_repo = 1;
364 if (!strcmp(subkey, "mirror"))
365 remote->mirror = git_config_bool(key, value);
366 else if (!strcmp(subkey, "skipdefaultupdate"))
367 remote->skip_default_update = git_config_bool(key, value);
368 else if (!strcmp(subkey, "skipfetchall"))
369 remote->skip_default_update = git_config_bool(key, value);
370 else if (!strcmp(subkey, "prune"))
371 remote->prune = git_config_bool(key, value);
372 else if (!strcmp(subkey, "prunetags"))
373 remote->prune_tags = git_config_bool(key, value);
374 else if (!strcmp(subkey, "url")) {
375 const char *v;
376 if (git_config_string(&v, key, value))
377 return -1;
378 add_url(remote, v);
379 } else if (!strcmp(subkey, "pushurl")) {
380 const char *v;
381 if (git_config_string(&v, key, value))
382 return -1;
383 add_pushurl(remote, v);
384 } else if (!strcmp(subkey, "push")) {
385 const char *v;
386 if (git_config_string(&v, key, value))
387 return -1;
388 refspec_append(&remote->push, v);
389 free((char *)v);
390 } else if (!strcmp(subkey, "fetch")) {
391 const char *v;
392 if (git_config_string(&v, key, value))
393 return -1;
394 refspec_append(&remote->fetch, v);
395 free((char *)v);
396 } else if (!strcmp(subkey, "receivepack")) {
397 const char *v;
398 if (git_config_string(&v, key, value))
399 return -1;
400 if (!remote->receivepack)
401 remote->receivepack = v;
402 else
403 error(_("more than one receivepack given, using the first"));
404 } else if (!strcmp(subkey, "uploadpack")) {
405 const char *v;
406 if (git_config_string(&v, key, value))
407 return -1;
408 if (!remote->uploadpack)
409 remote->uploadpack = v;
410 else
411 error(_("more than one uploadpack given, using the first"));
412 } else if (!strcmp(subkey, "tagopt")) {
413 if (!strcmp(value, "--no-tags"))
414 remote->fetch_tags = -1;
415 else if (!strcmp(value, "--tags"))
416 remote->fetch_tags = 2;
417 } else if (!strcmp(subkey, "proxy")) {
418 return git_config_string((const char **)&remote->http_proxy,
419 key, value);
420 } else if (!strcmp(subkey, "proxyauthmethod")) {
421 return git_config_string((const char **)&remote->http_proxy_authmethod,
422 key, value);
423 } else if (!strcmp(subkey, "vcs")) {
424 return git_config_string(&remote->foreign_vcs, key, value);
426 return 0;
429 static void alias_all_urls(void)
431 int i, j;
432 for (i = 0; i < remotes_nr; i++) {
433 int add_pushurl_aliases;
434 if (!remotes[i])
435 continue;
436 for (j = 0; j < remotes[i]->pushurl_nr; j++) {
437 remotes[i]->pushurl[j] = alias_url(remotes[i]->pushurl[j], &rewrites);
439 add_pushurl_aliases = remotes[i]->pushurl_nr == 0;
440 for (j = 0; j < remotes[i]->url_nr; j++) {
441 if (add_pushurl_aliases)
442 add_pushurl_alias(remotes[i], remotes[i]->url[j]);
443 remotes[i]->url[j] = alias_url(remotes[i]->url[j], &rewrites);
448 static void read_config(void)
450 static int loaded;
451 int flag;
453 if (loaded)
454 return;
455 loaded = 1;
457 current_branch = NULL;
458 if (startup_info->have_repository) {
459 const char *head_ref = resolve_ref_unsafe("HEAD", 0, NULL, &flag);
460 if (head_ref && (flag & REF_ISSYMREF) &&
461 skip_prefix(head_ref, "refs/heads/", &head_ref)) {
462 current_branch = make_branch(head_ref, strlen(head_ref));
465 git_config(handle_config, NULL);
466 alias_all_urls();
469 static int valid_remote_nick(const char *name)
471 if (!name[0] || is_dot_or_dotdot(name))
472 return 0;
474 /* remote nicknames cannot contain slashes */
475 while (*name)
476 if (is_dir_sep(*name++))
477 return 0;
478 return 1;
481 const char *remote_for_branch(struct branch *branch, int *explicit)
483 if (branch && branch->remote_name) {
484 if (explicit)
485 *explicit = 1;
486 return branch->remote_name;
488 if (explicit)
489 *explicit = 0;
490 return "origin";
493 const char *pushremote_for_branch(struct branch *branch, int *explicit)
495 if (branch && branch->pushremote_name) {
496 if (explicit)
497 *explicit = 1;
498 return branch->pushremote_name;
500 if (pushremote_name) {
501 if (explicit)
502 *explicit = 1;
503 return pushremote_name;
505 return remote_for_branch(branch, explicit);
508 const char *remote_ref_for_branch(struct branch *branch, int for_push)
510 if (branch) {
511 if (!for_push) {
512 if (branch->merge_nr) {
513 return branch->merge_name[0];
515 } else {
516 const char *dst, *remote_name =
517 pushremote_for_branch(branch, NULL);
518 struct remote *remote = remote_get(remote_name);
520 if (remote && remote->push.nr &&
521 (dst = apply_refspecs(&remote->push,
522 branch->refname))) {
523 return dst;
527 return NULL;
530 static struct remote *remote_get_1(const char *name,
531 const char *(*get_default)(struct branch *, int *))
533 struct remote *ret;
534 int name_given = 0;
536 read_config();
538 if (name)
539 name_given = 1;
540 else
541 name = get_default(current_branch, &name_given);
543 ret = make_remote(name, 0);
544 if (valid_remote_nick(name) && have_git_dir()) {
545 if (!valid_remote(ret))
546 read_remotes_file(ret);
547 if (!valid_remote(ret))
548 read_branches_file(ret);
550 if (name_given && !valid_remote(ret))
551 add_url_alias(ret, name);
552 if (!valid_remote(ret))
553 return NULL;
554 return ret;
557 struct remote *remote_get(const char *name)
559 return remote_get_1(name, remote_for_branch);
562 struct remote *pushremote_get(const char *name)
564 return remote_get_1(name, pushremote_for_branch);
567 int remote_is_configured(struct remote *remote, int in_repo)
569 if (!remote)
570 return 0;
571 if (in_repo)
572 return remote->configured_in_repo;
573 return !!remote->origin;
576 int for_each_remote(each_remote_fn fn, void *priv)
578 int i, result = 0;
579 read_config();
580 for (i = 0; i < remotes_nr && !result; i++) {
581 struct remote *r = remotes[i];
582 if (!r)
583 continue;
584 result = fn(r, priv);
586 return result;
589 static void handle_duplicate(struct ref *ref1, struct ref *ref2)
591 if (strcmp(ref1->name, ref2->name)) {
592 if (ref1->fetch_head_status != FETCH_HEAD_IGNORE &&
593 ref2->fetch_head_status != FETCH_HEAD_IGNORE) {
594 die(_("Cannot fetch both %s and %s to %s"),
595 ref1->name, ref2->name, ref2->peer_ref->name);
596 } else if (ref1->fetch_head_status != FETCH_HEAD_IGNORE &&
597 ref2->fetch_head_status == FETCH_HEAD_IGNORE) {
598 warning(_("%s usually tracks %s, not %s"),
599 ref2->peer_ref->name, ref2->name, ref1->name);
600 } else if (ref1->fetch_head_status == FETCH_HEAD_IGNORE &&
601 ref2->fetch_head_status == FETCH_HEAD_IGNORE) {
602 die(_("%s tracks both %s and %s"),
603 ref2->peer_ref->name, ref1->name, ref2->name);
604 } else {
606 * This last possibility doesn't occur because
607 * FETCH_HEAD_IGNORE entries always appear at
608 * the end of the list.
610 BUG("Internal error");
613 free(ref2->peer_ref);
614 free(ref2);
617 struct ref *ref_remove_duplicates(struct ref *ref_map)
619 struct string_list refs = STRING_LIST_INIT_NODUP;
620 struct ref *retval = NULL;
621 struct ref **p = &retval;
623 while (ref_map) {
624 struct ref *ref = ref_map;
626 ref_map = ref_map->next;
627 ref->next = NULL;
629 if (!ref->peer_ref) {
630 *p = ref;
631 p = &ref->next;
632 } else {
633 struct string_list_item *item =
634 string_list_insert(&refs, ref->peer_ref->name);
636 if (item->util) {
637 /* Entry already existed */
638 handle_duplicate((struct ref *)item->util, ref);
639 } else {
640 *p = ref;
641 p = &ref->next;
642 item->util = ref;
647 string_list_clear(&refs, 0);
648 return retval;
651 int remote_has_url(struct remote *remote, const char *url)
653 int i;
654 for (i = 0; i < remote->url_nr; i++) {
655 if (!strcmp(remote->url[i], url))
656 return 1;
658 return 0;
661 static int match_name_with_pattern(const char *key, const char *name,
662 const char *value, char **result)
664 const char *kstar = strchr(key, '*');
665 size_t klen;
666 size_t ksuffixlen;
667 size_t namelen;
668 int ret;
669 if (!kstar)
670 die(_("key '%s' of pattern had no '*'"), key);
671 klen = kstar - key;
672 ksuffixlen = strlen(kstar + 1);
673 namelen = strlen(name);
674 ret = !strncmp(name, key, klen) && namelen >= klen + ksuffixlen &&
675 !memcmp(name + namelen - ksuffixlen, kstar + 1, ksuffixlen);
676 if (ret && value) {
677 struct strbuf sb = STRBUF_INIT;
678 const char *vstar = strchr(value, '*');
679 if (!vstar)
680 die(_("value '%s' of pattern has no '*'"), value);
681 strbuf_add(&sb, value, vstar - value);
682 strbuf_add(&sb, name + klen, namelen - klen - ksuffixlen);
683 strbuf_addstr(&sb, vstar + 1);
684 *result = strbuf_detach(&sb, NULL);
686 return ret;
689 static void query_refspecs_multiple(struct refspec *rs,
690 struct refspec_item *query,
691 struct string_list *results)
693 int i;
694 int find_src = !query->src;
696 if (find_src && !query->dst)
697 BUG("query_refspecs_multiple: need either src or dst");
699 for (i = 0; i < rs->nr; i++) {
700 struct refspec_item *refspec = &rs->items[i];
701 const char *key = find_src ? refspec->dst : refspec->src;
702 const char *value = find_src ? refspec->src : refspec->dst;
703 const char *needle = find_src ? query->dst : query->src;
704 char **result = find_src ? &query->src : &query->dst;
706 if (!refspec->dst)
707 continue;
708 if (refspec->pattern) {
709 if (match_name_with_pattern(key, needle, value, result))
710 string_list_append_nodup(results, *result);
711 } else if (!strcmp(needle, key)) {
712 string_list_append(results, value);
717 int query_refspecs(struct refspec *rs, struct refspec_item *query)
719 int i;
720 int find_src = !query->src;
721 const char *needle = find_src ? query->dst : query->src;
722 char **result = find_src ? &query->src : &query->dst;
724 if (find_src && !query->dst)
725 BUG("query_refspecs: need either src or dst");
727 for (i = 0; i < rs->nr; i++) {
728 struct refspec_item *refspec = &rs->items[i];
729 const char *key = find_src ? refspec->dst : refspec->src;
730 const char *value = find_src ? refspec->src : refspec->dst;
732 if (!refspec->dst)
733 continue;
734 if (refspec->pattern) {
735 if (match_name_with_pattern(key, needle, value, result)) {
736 query->force = refspec->force;
737 return 0;
739 } else if (!strcmp(needle, key)) {
740 *result = xstrdup(value);
741 query->force = refspec->force;
742 return 0;
745 return -1;
748 char *apply_refspecs(struct refspec *rs, const char *name)
750 struct refspec_item query;
752 memset(&query, 0, sizeof(struct refspec_item));
753 query.src = (char *)name;
755 if (query_refspecs(rs, &query))
756 return NULL;
758 return query.dst;
761 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec)
763 return query_refspecs(&remote->fetch, refspec);
766 static struct ref *alloc_ref_with_prefix(const char *prefix, size_t prefixlen,
767 const char *name)
769 size_t len = strlen(name);
770 struct ref *ref = xcalloc(1, st_add4(sizeof(*ref), prefixlen, len, 1));
771 memcpy(ref->name, prefix, prefixlen);
772 memcpy(ref->name + prefixlen, name, len);
773 return ref;
776 struct ref *alloc_ref(const char *name)
778 return alloc_ref_with_prefix("", 0, name);
781 struct ref *copy_ref(const struct ref *ref)
783 struct ref *cpy;
784 size_t len;
785 if (!ref)
786 return NULL;
787 len = st_add3(sizeof(struct ref), strlen(ref->name), 1);
788 cpy = xmalloc(len);
789 memcpy(cpy, ref, len);
790 cpy->next = NULL;
791 cpy->symref = xstrdup_or_null(ref->symref);
792 cpy->remote_status = xstrdup_or_null(ref->remote_status);
793 cpy->peer_ref = copy_ref(ref->peer_ref);
794 return cpy;
797 struct ref *copy_ref_list(const struct ref *ref)
799 struct ref *ret = NULL;
800 struct ref **tail = &ret;
801 while (ref) {
802 *tail = copy_ref(ref);
803 ref = ref->next;
804 tail = &((*tail)->next);
806 return ret;
809 void free_one_ref(struct ref *ref)
811 if (!ref)
812 return;
813 free_one_ref(ref->peer_ref);
814 free(ref->remote_status);
815 free(ref->symref);
816 free(ref);
819 void free_refs(struct ref *ref)
821 struct ref *next;
822 while (ref) {
823 next = ref->next;
824 free_one_ref(ref);
825 ref = next;
829 int ref_compare_name(const void *va, const void *vb)
831 const struct ref *a = va, *b = vb;
832 return strcmp(a->name, b->name);
835 static void *ref_list_get_next(const void *a)
837 return ((const struct ref *)a)->next;
840 static void ref_list_set_next(void *a, void *next)
842 ((struct ref *)a)->next = next;
845 void sort_ref_list(struct ref **l, int (*cmp)(const void *, const void *))
847 *l = llist_mergesort(*l, ref_list_get_next, ref_list_set_next, cmp);
850 int count_refspec_match(const char *pattern,
851 struct ref *refs,
852 struct ref **matched_ref)
854 int patlen = strlen(pattern);
855 struct ref *matched_weak = NULL;
856 struct ref *matched = NULL;
857 int weak_match = 0;
858 int match = 0;
860 for (weak_match = match = 0; refs; refs = refs->next) {
861 char *name = refs->name;
862 int namelen = strlen(name);
864 if (!refname_match(pattern, name))
865 continue;
867 /* A match is "weak" if it is with refs outside
868 * heads or tags, and did not specify the pattern
869 * in full (e.g. "refs/remotes/origin/master") or at
870 * least from the toplevel (e.g. "remotes/origin/master");
871 * otherwise "git push $URL master" would result in
872 * ambiguity between remotes/origin/master and heads/master
873 * at the remote site.
875 if (namelen != patlen &&
876 patlen != namelen - 5 &&
877 !starts_with(name, "refs/heads/") &&
878 !starts_with(name, "refs/tags/")) {
879 /* We want to catch the case where only weak
880 * matches are found and there are multiple
881 * matches, and where more than one strong
882 * matches are found, as ambiguous. One
883 * strong match with zero or more weak matches
884 * are acceptable as a unique match.
886 matched_weak = refs;
887 weak_match++;
889 else {
890 matched = refs;
891 match++;
894 if (!matched) {
895 if (matched_ref)
896 *matched_ref = matched_weak;
897 return weak_match;
899 else {
900 if (matched_ref)
901 *matched_ref = matched;
902 return match;
906 static void tail_link_ref(struct ref *ref, struct ref ***tail)
908 **tail = ref;
909 while (ref->next)
910 ref = ref->next;
911 *tail = &ref->next;
914 static struct ref *alloc_delete_ref(void)
916 struct ref *ref = alloc_ref("(delete)");
917 oidclr(&ref->new_oid);
918 return ref;
921 static int try_explicit_object_name(const char *name,
922 struct ref **match)
924 struct object_id oid;
926 if (!*name) {
927 if (match)
928 *match = alloc_delete_ref();
929 return 0;
932 if (get_oid(name, &oid))
933 return -1;
935 if (match) {
936 *match = alloc_ref(name);
937 oidcpy(&(*match)->new_oid, &oid);
939 return 0;
942 static struct ref *make_linked_ref(const char *name, struct ref ***tail)
944 struct ref *ret = alloc_ref(name);
945 tail_link_ref(ret, tail);
946 return ret;
949 static char *guess_ref(const char *name, struct ref *peer)
951 struct strbuf buf = STRBUF_INIT;
953 const char *r = resolve_ref_unsafe(peer->name, RESOLVE_REF_READING,
954 NULL, NULL);
955 if (!r)
956 return NULL;
958 if (starts_with(r, "refs/heads/")) {
959 strbuf_addstr(&buf, "refs/heads/");
960 } else if (starts_with(r, "refs/tags/")) {
961 strbuf_addstr(&buf, "refs/tags/");
962 } else {
963 return NULL;
966 strbuf_addstr(&buf, name);
967 return strbuf_detach(&buf, NULL);
970 static int match_explicit_lhs(struct ref *src,
971 struct refspec_item *rs,
972 struct ref **match,
973 int *allocated_match)
975 switch (count_refspec_match(rs->src, src, match)) {
976 case 1:
977 if (allocated_match)
978 *allocated_match = 0;
979 return 0;
980 case 0:
981 /* The source could be in the get_sha1() format
982 * not a reference name. :refs/other is a
983 * way to delete 'other' ref at the remote end.
985 if (try_explicit_object_name(rs->src, match) < 0)
986 return error(_("src refspec %s does not match any"), rs->src);
987 if (allocated_match)
988 *allocated_match = 1;
989 return 0;
990 default:
991 return error(_("src refspec %s matches more than one"), rs->src);
995 static void show_push_unqualified_ref_name_error(const char *dst_value,
996 const char *matched_src_name)
998 struct object_id oid;
999 enum object_type type;
1002 * TRANSLATORS: "matches '%s'%" is the <dst> part of "git push
1003 * <remote> <src>:<dst>" push, and "being pushed ('%s')" is
1004 * the <src>.
1006 error(_("The destination you provided is not a full refname (i.e.,\n"
1007 "starting with \"refs/\"). We tried to guess what you meant by:\n"
1008 "\n"
1009 "- Looking for a ref that matches '%s' on the remote side.\n"
1010 "- Checking if the <src> being pushed ('%s')\n"
1011 " is a ref in \"refs/{heads,tags}/\". If so we add a corresponding\n"
1012 " refs/{heads,tags}/ prefix on the remote side.\n"
1013 "\n"
1014 "Neither worked, so we gave up. You must fully qualify the ref."),
1015 dst_value, matched_src_name);
1017 if (!advice_push_unqualified_ref_name)
1018 return;
1020 if (get_oid(matched_src_name, &oid))
1021 BUG("'%s' is not a valid object, "
1022 "match_explicit_lhs() should catch this!",
1023 matched_src_name);
1024 type = oid_object_info(the_repository, &oid, NULL);
1025 if (type == OBJ_COMMIT) {
1026 advise(_("The <src> part of the refspec is a commit object.\n"
1027 "Did you mean to create a new branch by pushing to\n"
1028 "'%s:refs/heads/%s'?"),
1029 matched_src_name, dst_value);
1030 } else if (type == OBJ_TAG) {
1031 advise(_("The <src> part of the refspec is a tag object.\n"
1032 "Did you mean to create a new tag by pushing to\n"
1033 "'%s:refs/tags/%s'?"),
1034 matched_src_name, dst_value);
1035 } else if (type == OBJ_TREE) {
1036 advise(_("The <src> part of the refspec is a tree object.\n"
1037 "Did you mean to tag a new tree by pushing to\n"
1038 "'%s:refs/tags/%s'?"),
1039 matched_src_name, dst_value);
1040 } else if (type == OBJ_BLOB) {
1041 advise(_("The <src> part of the refspec is a blob object.\n"
1042 "Did you mean to tag a new blob by pushing to\n"
1043 "'%s:refs/tags/%s'?"),
1044 matched_src_name, dst_value);
1045 } else {
1046 BUG("'%s' should be commit/tag/tree/blob, is '%d'",
1047 matched_src_name, type);
1051 static int match_explicit(struct ref *src, struct ref *dst,
1052 struct ref ***dst_tail,
1053 struct refspec_item *rs)
1055 struct ref *matched_src, *matched_dst;
1056 int allocated_src;
1058 const char *dst_value = rs->dst;
1059 char *dst_guess;
1061 if (rs->pattern || rs->matching)
1062 return 0;
1064 matched_src = matched_dst = NULL;
1065 if (match_explicit_lhs(src, rs, &matched_src, &allocated_src) < 0)
1066 return -1;
1068 if (!dst_value) {
1069 int flag;
1071 dst_value = resolve_ref_unsafe(matched_src->name,
1072 RESOLVE_REF_READING,
1073 NULL, &flag);
1074 if (!dst_value ||
1075 ((flag & REF_ISSYMREF) &&
1076 !starts_with(dst_value, "refs/heads/")))
1077 die(_("%s cannot be resolved to branch"),
1078 matched_src->name);
1081 switch (count_refspec_match(dst_value, dst, &matched_dst)) {
1082 case 1:
1083 break;
1084 case 0:
1085 if (starts_with(dst_value, "refs/")) {
1086 matched_dst = make_linked_ref(dst_value, dst_tail);
1087 } else if (is_null_oid(&matched_src->new_oid)) {
1088 error(_("unable to delete '%s': remote ref does not exist"),
1089 dst_value);
1090 } else if ((dst_guess = guess_ref(dst_value, matched_src))) {
1091 matched_dst = make_linked_ref(dst_guess, dst_tail);
1092 free(dst_guess);
1093 } else {
1094 show_push_unqualified_ref_name_error(dst_value,
1095 matched_src->name);
1097 break;
1098 default:
1099 matched_dst = NULL;
1100 error(_("dst refspec %s matches more than one"),
1101 dst_value);
1102 break;
1104 if (!matched_dst)
1105 return -1;
1106 if (matched_dst->peer_ref)
1107 return error(_("dst ref %s receives from more than one src"),
1108 matched_dst->name);
1109 else {
1110 matched_dst->peer_ref = allocated_src ?
1111 matched_src :
1112 copy_ref(matched_src);
1113 matched_dst->force = rs->force;
1115 return 0;
1118 static int match_explicit_refs(struct ref *src, struct ref *dst,
1119 struct ref ***dst_tail, struct refspec *rs)
1121 int i, errs;
1122 for (i = errs = 0; i < rs->nr; i++)
1123 errs += match_explicit(src, dst, dst_tail, &rs->items[i]);
1124 return errs;
1127 static char *get_ref_match(const struct refspec *rs, const struct ref *ref,
1128 int send_mirror, int direction,
1129 const struct refspec_item **ret_pat)
1131 const struct refspec_item *pat;
1132 char *name;
1133 int i;
1134 int matching_refs = -1;
1135 for (i = 0; i < rs->nr; i++) {
1136 const struct refspec_item *item = &rs->items[i];
1137 if (item->matching &&
1138 (matching_refs == -1 || item->force)) {
1139 matching_refs = i;
1140 continue;
1143 if (item->pattern) {
1144 const char *dst_side = item->dst ? item->dst : item->src;
1145 int match;
1146 if (direction == FROM_SRC)
1147 match = match_name_with_pattern(item->src, ref->name, dst_side, &name);
1148 else
1149 match = match_name_with_pattern(dst_side, ref->name, item->src, &name);
1150 if (match) {
1151 matching_refs = i;
1152 break;
1156 if (matching_refs == -1)
1157 return NULL;
1159 pat = &rs->items[matching_refs];
1160 if (pat->matching) {
1162 * "matching refs"; traditionally we pushed everything
1163 * including refs outside refs/heads/ hierarchy, but
1164 * that does not make much sense these days.
1166 if (!send_mirror && !starts_with(ref->name, "refs/heads/"))
1167 return NULL;
1168 name = xstrdup(ref->name);
1170 if (ret_pat)
1171 *ret_pat = pat;
1172 return name;
1175 static struct ref **tail_ref(struct ref **head)
1177 struct ref **tail = head;
1178 while (*tail)
1179 tail = &((*tail)->next);
1180 return tail;
1183 struct tips {
1184 struct commit **tip;
1185 int nr, alloc;
1188 static void add_to_tips(struct tips *tips, const struct object_id *oid)
1190 struct commit *commit;
1192 if (is_null_oid(oid))
1193 return;
1194 commit = lookup_commit_reference_gently(the_repository, oid, 1);
1195 if (!commit || (commit->object.flags & TMP_MARK))
1196 return;
1197 commit->object.flags |= TMP_MARK;
1198 ALLOC_GROW(tips->tip, tips->nr + 1, tips->alloc);
1199 tips->tip[tips->nr++] = commit;
1202 static void add_missing_tags(struct ref *src, struct ref **dst, struct ref ***dst_tail)
1204 struct string_list dst_tag = STRING_LIST_INIT_NODUP;
1205 struct string_list src_tag = STRING_LIST_INIT_NODUP;
1206 struct string_list_item *item;
1207 struct ref *ref;
1208 struct tips sent_tips;
1211 * Collect everything we know they would have at the end of
1212 * this push, and collect all tags they have.
1214 memset(&sent_tips, 0, sizeof(sent_tips));
1215 for (ref = *dst; ref; ref = ref->next) {
1216 if (ref->peer_ref &&
1217 !is_null_oid(&ref->peer_ref->new_oid))
1218 add_to_tips(&sent_tips, &ref->peer_ref->new_oid);
1219 else
1220 add_to_tips(&sent_tips, &ref->old_oid);
1221 if (starts_with(ref->name, "refs/tags/"))
1222 string_list_append(&dst_tag, ref->name);
1224 clear_commit_marks_many(sent_tips.nr, sent_tips.tip, TMP_MARK);
1226 string_list_sort(&dst_tag);
1228 /* Collect tags they do not have. */
1229 for (ref = src; ref; ref = ref->next) {
1230 if (!starts_with(ref->name, "refs/tags/"))
1231 continue; /* not a tag */
1232 if (string_list_has_string(&dst_tag, ref->name))
1233 continue; /* they already have it */
1234 if (oid_object_info(the_repository, &ref->new_oid, NULL) != OBJ_TAG)
1235 continue; /* be conservative */
1236 item = string_list_append(&src_tag, ref->name);
1237 item->util = ref;
1239 string_list_clear(&dst_tag, 0);
1242 * At this point, src_tag lists tags that are missing from
1243 * dst, and sent_tips lists the tips we are pushing or those
1244 * that we know they already have. An element in the src_tag
1245 * that is an ancestor of any of the sent_tips needs to be
1246 * sent to the other side.
1248 if (sent_tips.nr) {
1249 const int reachable_flag = 1;
1250 struct commit_list *found_commits;
1251 struct commit **src_commits;
1252 int nr_src_commits = 0, alloc_src_commits = 16;
1253 ALLOC_ARRAY(src_commits, alloc_src_commits);
1255 for_each_string_list_item(item, &src_tag) {
1256 struct ref *ref = item->util;
1257 struct commit *commit;
1259 if (is_null_oid(&ref->new_oid))
1260 continue;
1261 commit = lookup_commit_reference_gently(the_repository,
1262 &ref->new_oid,
1264 if (!commit)
1265 /* not pushing a commit, which is not an error */
1266 continue;
1268 ALLOC_GROW(src_commits, nr_src_commits + 1, alloc_src_commits);
1269 src_commits[nr_src_commits++] = commit;
1272 found_commits = get_reachable_subset(sent_tips.tip, sent_tips.nr,
1273 src_commits, nr_src_commits,
1274 reachable_flag);
1276 for_each_string_list_item(item, &src_tag) {
1277 struct ref *dst_ref;
1278 struct ref *ref = item->util;
1279 struct commit *commit;
1281 if (is_null_oid(&ref->new_oid))
1282 continue;
1283 commit = lookup_commit_reference_gently(the_repository,
1284 &ref->new_oid,
1286 if (!commit)
1287 /* not pushing a commit, which is not an error */
1288 continue;
1291 * Is this tag, which they do not have, reachable from
1292 * any of the commits we are sending?
1294 if (!(commit->object.flags & reachable_flag))
1295 continue;
1297 /* Add it in */
1298 dst_ref = make_linked_ref(ref->name, dst_tail);
1299 oidcpy(&dst_ref->new_oid, &ref->new_oid);
1300 dst_ref->peer_ref = copy_ref(ref);
1303 clear_commit_marks_many(nr_src_commits, src_commits, reachable_flag);
1304 free(src_commits);
1305 free_commit_list(found_commits);
1308 string_list_clear(&src_tag, 0);
1309 free(sent_tips.tip);
1312 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1314 for ( ; list; list = list->next)
1315 if (!strcmp(list->name, name))
1316 return (struct ref *)list;
1317 return NULL;
1320 static void prepare_ref_index(struct string_list *ref_index, struct ref *ref)
1322 for ( ; ref; ref = ref->next)
1323 string_list_append_nodup(ref_index, ref->name)->util = ref;
1325 string_list_sort(ref_index);
1329 * Given only the set of local refs, sanity-check the set of push
1330 * refspecs. We can't catch all errors that match_push_refs would,
1331 * but we can catch some errors early before even talking to the
1332 * remote side.
1334 int check_push_refs(struct ref *src, struct refspec *rs)
1336 int ret = 0;
1337 int i;
1339 for (i = 0; i < rs->nr; i++) {
1340 struct refspec_item *item = &rs->items[i];
1342 if (item->pattern || item->matching)
1343 continue;
1345 ret |= match_explicit_lhs(src, item, NULL, NULL);
1348 return ret;
1352 * Given the set of refs the local repository has, the set of refs the
1353 * remote repository has, and the refspec used for push, determine
1354 * what remote refs we will update and with what value by setting
1355 * peer_ref (which object is being pushed) and force (if the push is
1356 * forced) in elements of "dst". The function may add new elements to
1357 * dst (e.g. pushing to a new branch, done in match_explicit_refs).
1359 int match_push_refs(struct ref *src, struct ref **dst,
1360 struct refspec *rs, int flags)
1362 int send_all = flags & MATCH_REFS_ALL;
1363 int send_mirror = flags & MATCH_REFS_MIRROR;
1364 int send_prune = flags & MATCH_REFS_PRUNE;
1365 int errs;
1366 struct ref *ref, **dst_tail = tail_ref(dst);
1367 struct string_list dst_ref_index = STRING_LIST_INIT_NODUP;
1369 /* If no refspec is provided, use the default ":" */
1370 if (!rs->nr)
1371 refspec_append(rs, ":");
1373 errs = match_explicit_refs(src, *dst, &dst_tail, rs);
1375 /* pick the remainder */
1376 for (ref = src; ref; ref = ref->next) {
1377 struct string_list_item *dst_item;
1378 struct ref *dst_peer;
1379 const struct refspec_item *pat = NULL;
1380 char *dst_name;
1382 dst_name = get_ref_match(rs, ref, send_mirror, FROM_SRC, &pat);
1383 if (!dst_name)
1384 continue;
1386 if (!dst_ref_index.nr)
1387 prepare_ref_index(&dst_ref_index, *dst);
1389 dst_item = string_list_lookup(&dst_ref_index, dst_name);
1390 dst_peer = dst_item ? dst_item->util : NULL;
1391 if (dst_peer) {
1392 if (dst_peer->peer_ref)
1393 /* We're already sending something to this ref. */
1394 goto free_name;
1395 } else {
1396 if (pat->matching && !(send_all || send_mirror))
1398 * Remote doesn't have it, and we have no
1399 * explicit pattern, and we don't have
1400 * --all or --mirror.
1402 goto free_name;
1404 /* Create a new one and link it */
1405 dst_peer = make_linked_ref(dst_name, &dst_tail);
1406 oidcpy(&dst_peer->new_oid, &ref->new_oid);
1407 string_list_insert(&dst_ref_index,
1408 dst_peer->name)->util = dst_peer;
1410 dst_peer->peer_ref = copy_ref(ref);
1411 dst_peer->force = pat->force;
1412 free_name:
1413 free(dst_name);
1416 string_list_clear(&dst_ref_index, 0);
1418 if (flags & MATCH_REFS_FOLLOW_TAGS)
1419 add_missing_tags(src, dst, &dst_tail);
1421 if (send_prune) {
1422 struct string_list src_ref_index = STRING_LIST_INIT_NODUP;
1423 /* check for missing refs on the remote */
1424 for (ref = *dst; ref; ref = ref->next) {
1425 char *src_name;
1427 if (ref->peer_ref)
1428 /* We're already sending something to this ref. */
1429 continue;
1431 src_name = get_ref_match(rs, ref, send_mirror, FROM_DST, NULL);
1432 if (src_name) {
1433 if (!src_ref_index.nr)
1434 prepare_ref_index(&src_ref_index, src);
1435 if (!string_list_has_string(&src_ref_index,
1436 src_name))
1437 ref->peer_ref = alloc_delete_ref();
1438 free(src_name);
1441 string_list_clear(&src_ref_index, 0);
1444 if (errs)
1445 return -1;
1446 return 0;
1449 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
1450 int force_update)
1452 struct ref *ref;
1454 for (ref = remote_refs; ref; ref = ref->next) {
1455 int force_ref_update = ref->force || force_update;
1456 int reject_reason = 0;
1458 if (ref->peer_ref)
1459 oidcpy(&ref->new_oid, &ref->peer_ref->new_oid);
1460 else if (!send_mirror)
1461 continue;
1463 ref->deletion = is_null_oid(&ref->new_oid);
1464 if (!ref->deletion &&
1465 oideq(&ref->old_oid, &ref->new_oid)) {
1466 ref->status = REF_STATUS_UPTODATE;
1467 continue;
1471 * If the remote ref has moved and is now different
1472 * from what we expect, reject any push.
1474 * It also is an error if the user told us to check
1475 * with the remote-tracking branch to find the value
1476 * to expect, but we did not have such a tracking
1477 * branch.
1479 if (ref->expect_old_sha1) {
1480 if (!oideq(&ref->old_oid, &ref->old_oid_expect))
1481 reject_reason = REF_STATUS_REJECT_STALE;
1482 else
1483 /* If the ref isn't stale then force the update. */
1484 force_ref_update = 1;
1488 * If the update isn't already rejected then check
1489 * the usual "must fast-forward" rules.
1491 * Decide whether an individual refspec A:B can be
1492 * pushed. The push will succeed if any of the
1493 * following are true:
1495 * (1) the remote reference B does not exist
1497 * (2) the remote reference B is being removed (i.e.,
1498 * pushing :B where no source is specified)
1500 * (3) the destination is not under refs/tags/, and
1501 * if the old and new value is a commit, the new
1502 * is a descendant of the old.
1504 * (4) it is forced using the +A:B notation, or by
1505 * passing the --force argument
1508 if (!reject_reason && !ref->deletion && !is_null_oid(&ref->old_oid)) {
1509 if (starts_with(ref->name, "refs/tags/"))
1510 reject_reason = REF_STATUS_REJECT_ALREADY_EXISTS;
1511 else if (!has_object_file(&ref->old_oid))
1512 reject_reason = REF_STATUS_REJECT_FETCH_FIRST;
1513 else if (!lookup_commit_reference_gently(the_repository, &ref->old_oid, 1) ||
1514 !lookup_commit_reference_gently(the_repository, &ref->new_oid, 1))
1515 reject_reason = REF_STATUS_REJECT_NEEDS_FORCE;
1516 else if (!ref_newer(&ref->new_oid, &ref->old_oid))
1517 reject_reason = REF_STATUS_REJECT_NONFASTFORWARD;
1521 * "--force" will defeat any rejection implemented
1522 * by the rules above.
1524 if (!force_ref_update)
1525 ref->status = reject_reason;
1526 else if (reject_reason)
1527 ref->forced_update = 1;
1531 static void set_merge(struct branch *ret)
1533 struct remote *remote;
1534 char *ref;
1535 struct object_id oid;
1536 int i;
1538 if (!ret)
1539 return; /* no branch */
1540 if (ret->merge)
1541 return; /* already run */
1542 if (!ret->remote_name || !ret->merge_nr) {
1544 * no merge config; let's make sure we don't confuse callers
1545 * with a non-zero merge_nr but a NULL merge
1547 ret->merge_nr = 0;
1548 return;
1551 remote = remote_get(ret->remote_name);
1553 ret->merge = xcalloc(ret->merge_nr, sizeof(*ret->merge));
1554 for (i = 0; i < ret->merge_nr; i++) {
1555 ret->merge[i] = xcalloc(1, sizeof(**ret->merge));
1556 ret->merge[i]->src = xstrdup(ret->merge_name[i]);
1557 if (!remote_find_tracking(remote, ret->merge[i]) ||
1558 strcmp(ret->remote_name, "."))
1559 continue;
1560 if (dwim_ref(ret->merge_name[i], strlen(ret->merge_name[i]),
1561 &oid, &ref) == 1)
1562 ret->merge[i]->dst = ref;
1563 else
1564 ret->merge[i]->dst = xstrdup(ret->merge_name[i]);
1568 struct branch *branch_get(const char *name)
1570 struct branch *ret;
1572 read_config();
1573 if (!name || !*name || !strcmp(name, "HEAD"))
1574 ret = current_branch;
1575 else
1576 ret = make_branch(name, strlen(name));
1577 set_merge(ret);
1578 return ret;
1581 int branch_has_merge_config(struct branch *branch)
1583 return branch && !!branch->merge;
1586 int branch_merge_matches(struct branch *branch,
1587 int i,
1588 const char *refname)
1590 if (!branch || i < 0 || i >= branch->merge_nr)
1591 return 0;
1592 return refname_match(branch->merge[i]->src, refname);
1595 __attribute__((format (printf,2,3)))
1596 static const char *error_buf(struct strbuf *err, const char *fmt, ...)
1598 if (err) {
1599 va_list ap;
1600 va_start(ap, fmt);
1601 strbuf_vaddf(err, fmt, ap);
1602 va_end(ap);
1604 return NULL;
1607 const char *branch_get_upstream(struct branch *branch, struct strbuf *err)
1609 if (!branch)
1610 return error_buf(err, _("HEAD does not point to a branch"));
1612 if (!branch->merge || !branch->merge[0]) {
1614 * no merge config; is it because the user didn't define any,
1615 * or because it is not a real branch, and get_branch
1616 * auto-vivified it?
1618 if (!ref_exists(branch->refname))
1619 return error_buf(err, _("no such branch: '%s'"),
1620 branch->name);
1621 return error_buf(err,
1622 _("no upstream configured for branch '%s'"),
1623 branch->name);
1626 if (!branch->merge[0]->dst)
1627 return error_buf(err,
1628 _("upstream branch '%s' not stored as a remote-tracking branch"),
1629 branch->merge[0]->src);
1631 return branch->merge[0]->dst;
1634 static const char *tracking_for_push_dest(struct remote *remote,
1635 const char *refname,
1636 struct strbuf *err)
1638 char *ret;
1640 ret = apply_refspecs(&remote->fetch, refname);
1641 if (!ret)
1642 return error_buf(err,
1643 _("push destination '%s' on remote '%s' has no local tracking branch"),
1644 refname, remote->name);
1645 return ret;
1648 static const char *branch_get_push_1(struct branch *branch, struct strbuf *err)
1650 struct remote *remote;
1652 remote = remote_get(pushremote_for_branch(branch, NULL));
1653 if (!remote)
1654 return error_buf(err,
1655 _("branch '%s' has no remote for pushing"),
1656 branch->name);
1658 if (remote->push.nr) {
1659 char *dst;
1660 const char *ret;
1662 dst = apply_refspecs(&remote->push, branch->refname);
1663 if (!dst)
1664 return error_buf(err,
1665 _("push refspecs for '%s' do not include '%s'"),
1666 remote->name, branch->name);
1668 ret = tracking_for_push_dest(remote, dst, err);
1669 free(dst);
1670 return ret;
1673 if (remote->mirror)
1674 return tracking_for_push_dest(remote, branch->refname, err);
1676 switch (push_default) {
1677 case PUSH_DEFAULT_NOTHING:
1678 return error_buf(err, _("push has no destination (push.default is 'nothing')"));
1680 case PUSH_DEFAULT_MATCHING:
1681 case PUSH_DEFAULT_CURRENT:
1682 return tracking_for_push_dest(remote, branch->refname, err);
1684 case PUSH_DEFAULT_UPSTREAM:
1685 return branch_get_upstream(branch, err);
1687 case PUSH_DEFAULT_UNSPECIFIED:
1688 case PUSH_DEFAULT_SIMPLE:
1690 const char *up, *cur;
1692 up = branch_get_upstream(branch, err);
1693 if (!up)
1694 return NULL;
1695 cur = tracking_for_push_dest(remote, branch->refname, err);
1696 if (!cur)
1697 return NULL;
1698 if (strcmp(cur, up))
1699 return error_buf(err,
1700 _("cannot resolve 'simple' push to a single destination"));
1701 return cur;
1705 BUG("unhandled push situation");
1708 const char *branch_get_push(struct branch *branch, struct strbuf *err)
1710 if (!branch)
1711 return error_buf(err, _("HEAD does not point to a branch"));
1713 if (!branch->push_tracking_ref)
1714 branch->push_tracking_ref = branch_get_push_1(branch, err);
1715 return branch->push_tracking_ref;
1718 static int ignore_symref_update(const char *refname)
1720 int flag;
1722 if (!resolve_ref_unsafe(refname, 0, NULL, &flag))
1723 return 0; /* non-existing refs are OK */
1724 return (flag & REF_ISSYMREF);
1728 * Create and return a list of (struct ref) consisting of copies of
1729 * each remote_ref that matches refspec. refspec must be a pattern.
1730 * Fill in the copies' peer_ref to describe the local tracking refs to
1731 * which they map. Omit any references that would map to an existing
1732 * local symbolic ref.
1734 static struct ref *get_expanded_map(const struct ref *remote_refs,
1735 const struct refspec_item *refspec)
1737 const struct ref *ref;
1738 struct ref *ret = NULL;
1739 struct ref **tail = &ret;
1741 for (ref = remote_refs; ref; ref = ref->next) {
1742 char *expn_name = NULL;
1744 if (strchr(ref->name, '^'))
1745 continue; /* a dereference item */
1746 if (match_name_with_pattern(refspec->src, ref->name,
1747 refspec->dst, &expn_name) &&
1748 !ignore_symref_update(expn_name)) {
1749 struct ref *cpy = copy_ref(ref);
1751 cpy->peer_ref = alloc_ref(expn_name);
1752 if (refspec->force)
1753 cpy->peer_ref->force = 1;
1754 *tail = cpy;
1755 tail = &cpy->next;
1757 free(expn_name);
1760 return ret;
1763 static const struct ref *find_ref_by_name_abbrev(const struct ref *refs, const char *name)
1765 const struct ref *ref;
1766 const struct ref *best_match = NULL;
1767 int best_score = 0;
1769 for (ref = refs; ref; ref = ref->next) {
1770 int score = refname_match(name, ref->name);
1772 if (best_score < score) {
1773 best_match = ref;
1774 best_score = score;
1777 return best_match;
1780 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name)
1782 const struct ref *ref = find_ref_by_name_abbrev(remote_refs, name);
1784 if (!ref)
1785 return NULL;
1787 return copy_ref(ref);
1790 static struct ref *get_local_ref(const char *name)
1792 if (!name || name[0] == '\0')
1793 return NULL;
1795 if (starts_with(name, "refs/"))
1796 return alloc_ref(name);
1798 if (starts_with(name, "heads/") ||
1799 starts_with(name, "tags/") ||
1800 starts_with(name, "remotes/"))
1801 return alloc_ref_with_prefix("refs/", 5, name);
1803 return alloc_ref_with_prefix("refs/heads/", 11, name);
1806 int get_fetch_map(const struct ref *remote_refs,
1807 const struct refspec_item *refspec,
1808 struct ref ***tail,
1809 int missing_ok)
1811 struct ref *ref_map, **rmp;
1813 if (refspec->pattern) {
1814 ref_map = get_expanded_map(remote_refs, refspec);
1815 } else {
1816 const char *name = refspec->src[0] ? refspec->src : "HEAD";
1818 if (refspec->exact_sha1) {
1819 ref_map = alloc_ref(name);
1820 get_oid_hex(name, &ref_map->old_oid);
1821 ref_map->exact_oid = 1;
1822 } else {
1823 ref_map = get_remote_ref(remote_refs, name);
1825 if (!missing_ok && !ref_map)
1826 die(_("couldn't find remote ref %s"), name);
1827 if (ref_map) {
1828 ref_map->peer_ref = get_local_ref(refspec->dst);
1829 if (ref_map->peer_ref && refspec->force)
1830 ref_map->peer_ref->force = 1;
1834 for (rmp = &ref_map; *rmp; ) {
1835 if ((*rmp)->peer_ref) {
1836 if (!starts_with((*rmp)->peer_ref->name, "refs/") ||
1837 check_refname_format((*rmp)->peer_ref->name, 0)) {
1838 struct ref *ignore = *rmp;
1839 error(_("* Ignoring funny ref '%s' locally"),
1840 (*rmp)->peer_ref->name);
1841 *rmp = (*rmp)->next;
1842 free(ignore->peer_ref);
1843 free(ignore);
1844 continue;
1847 rmp = &((*rmp)->next);
1850 if (ref_map)
1851 tail_link_ref(ref_map, tail);
1853 return 0;
1856 int resolve_remote_symref(struct ref *ref, struct ref *list)
1858 if (!ref->symref)
1859 return 0;
1860 for (; list; list = list->next)
1861 if (!strcmp(ref->symref, list->name)) {
1862 oidcpy(&ref->old_oid, &list->old_oid);
1863 return 0;
1865 return 1;
1869 * Compute the commit ahead/behind values for the pair branch_name, base.
1871 * If abf is AHEAD_BEHIND_FULL, compute the full ahead/behind and return the
1872 * counts in *num_ours and *num_theirs. If abf is AHEAD_BEHIND_QUICK, skip
1873 * the (potentially expensive) a/b computation (*num_ours and *num_theirs are
1874 * set to zero).
1876 * Returns -1 if num_ours and num_theirs could not be filled in (e.g., ref
1877 * does not exist). Returns 0 if the commits are identical. Returns 1 if
1878 * commits are different.
1881 static int stat_branch_pair(const char *branch_name, const char *base,
1882 int *num_ours, int *num_theirs,
1883 enum ahead_behind_flags abf)
1885 struct object_id oid;
1886 struct commit *ours, *theirs;
1887 struct rev_info revs;
1888 struct argv_array argv = ARGV_ARRAY_INIT;
1890 /* Cannot stat if what we used to build on no longer exists */
1891 if (read_ref(base, &oid))
1892 return -1;
1893 theirs = lookup_commit_reference(the_repository, &oid);
1894 if (!theirs)
1895 return -1;
1897 if (read_ref(branch_name, &oid))
1898 return -1;
1899 ours = lookup_commit_reference(the_repository, &oid);
1900 if (!ours)
1901 return -1;
1903 *num_theirs = *num_ours = 0;
1905 /* are we the same? */
1906 if (theirs == ours)
1907 return 0;
1908 if (abf == AHEAD_BEHIND_QUICK)
1909 return 1;
1910 if (abf != AHEAD_BEHIND_FULL)
1911 BUG("stat_branch_pair: invalid abf '%d'", abf);
1913 /* Run "rev-list --left-right ours...theirs" internally... */
1914 argv_array_push(&argv, ""); /* ignored */
1915 argv_array_push(&argv, "--left-right");
1916 argv_array_pushf(&argv, "%s...%s",
1917 oid_to_hex(&ours->object.oid),
1918 oid_to_hex(&theirs->object.oid));
1919 argv_array_push(&argv, "--");
1921 repo_init_revisions(the_repository, &revs, NULL);
1922 setup_revisions(argv.argc, argv.argv, &revs, NULL);
1923 if (prepare_revision_walk(&revs))
1924 die(_("revision walk setup failed"));
1926 /* ... and count the commits on each side. */
1927 while (1) {
1928 struct commit *c = get_revision(&revs);
1929 if (!c)
1930 break;
1931 if (c->object.flags & SYMMETRIC_LEFT)
1932 (*num_ours)++;
1933 else
1934 (*num_theirs)++;
1937 /* clear object flags smudged by the above traversal */
1938 clear_commit_marks(ours, ALL_REV_FLAGS);
1939 clear_commit_marks(theirs, ALL_REV_FLAGS);
1941 argv_array_clear(&argv);
1942 return 1;
1946 * Lookup the tracking branch for the given branch and if present, optionally
1947 * compute the commit ahead/behind values for the pair.
1949 * If for_push is true, the tracking branch refers to the push branch,
1950 * otherwise it refers to the upstream branch.
1952 * The name of the tracking branch (or NULL if it is not defined) is
1953 * returned via *tracking_name, if it is not itself NULL.
1955 * If abf is AHEAD_BEHIND_FULL, compute the full ahead/behind and return the
1956 * counts in *num_ours and *num_theirs. If abf is AHEAD_BEHIND_QUICK, skip
1957 * the (potentially expensive) a/b computation (*num_ours and *num_theirs are
1958 * set to zero).
1960 * Returns -1 if num_ours and num_theirs could not be filled in (e.g., no
1961 * upstream defined, or ref does not exist). Returns 0 if the commits are
1962 * identical. Returns 1 if commits are different.
1964 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
1965 const char **tracking_name, int for_push,
1966 enum ahead_behind_flags abf)
1968 const char *base;
1970 /* Cannot stat unless we are marked to build on top of somebody else. */
1971 base = for_push ? branch_get_push(branch, NULL) :
1972 branch_get_upstream(branch, NULL);
1973 if (tracking_name)
1974 *tracking_name = base;
1975 if (!base)
1976 return -1;
1978 return stat_branch_pair(branch->refname, base, num_ours, num_theirs, abf);
1982 * Return true when there is anything to report, otherwise false.
1984 int format_tracking_info(struct branch *branch, struct strbuf *sb,
1985 enum ahead_behind_flags abf)
1987 int ours, theirs, sti;
1988 const char *full_base;
1989 char *base;
1990 int upstream_is_gone = 0;
1992 sti = stat_tracking_info(branch, &ours, &theirs, &full_base, 0, abf);
1993 if (sti < 0) {
1994 if (!full_base)
1995 return 0;
1996 upstream_is_gone = 1;
1999 base = shorten_unambiguous_ref(full_base, 0);
2000 if (upstream_is_gone) {
2001 strbuf_addf(sb,
2002 _("Your branch is based on '%s', but the upstream is gone.\n"),
2003 base);
2004 if (advice_status_hints)
2005 strbuf_addstr(sb,
2006 _(" (use \"git branch --unset-upstream\" to fixup)\n"));
2007 } else if (!sti) {
2008 strbuf_addf(sb,
2009 _("Your branch is up to date with '%s'.\n"),
2010 base);
2011 } else if (abf == AHEAD_BEHIND_QUICK) {
2012 strbuf_addf(sb,
2013 _("Your branch and '%s' refer to different commits.\n"),
2014 base);
2015 if (advice_status_hints)
2016 strbuf_addf(sb, _(" (use \"%s\" for details)\n"),
2017 "git status --ahead-behind");
2018 } else if (!theirs) {
2019 strbuf_addf(sb,
2020 Q_("Your branch is ahead of '%s' by %d commit.\n",
2021 "Your branch is ahead of '%s' by %d commits.\n",
2022 ours),
2023 base, ours);
2024 if (advice_status_hints)
2025 strbuf_addstr(sb,
2026 _(" (use \"git push\" to publish your local commits)\n"));
2027 } else if (!ours) {
2028 strbuf_addf(sb,
2029 Q_("Your branch is behind '%s' by %d commit, "
2030 "and can be fast-forwarded.\n",
2031 "Your branch is behind '%s' by %d commits, "
2032 "and can be fast-forwarded.\n",
2033 theirs),
2034 base, theirs);
2035 if (advice_status_hints)
2036 strbuf_addstr(sb,
2037 _(" (use \"git pull\" to update your local branch)\n"));
2038 } else {
2039 strbuf_addf(sb,
2040 Q_("Your branch and '%s' have diverged,\n"
2041 "and have %d and %d different commit each, "
2042 "respectively.\n",
2043 "Your branch and '%s' have diverged,\n"
2044 "and have %d and %d different commits each, "
2045 "respectively.\n",
2046 ours + theirs),
2047 base, ours, theirs);
2048 if (advice_status_hints)
2049 strbuf_addstr(sb,
2050 _(" (use \"git pull\" to merge the remote branch into yours)\n"));
2052 free(base);
2053 return 1;
2056 static int one_local_ref(const char *refname, const struct object_id *oid,
2057 int flag, void *cb_data)
2059 struct ref ***local_tail = cb_data;
2060 struct ref *ref;
2062 /* we already know it starts with refs/ to get here */
2063 if (check_refname_format(refname + 5, 0))
2064 return 0;
2066 ref = alloc_ref(refname);
2067 oidcpy(&ref->new_oid, oid);
2068 **local_tail = ref;
2069 *local_tail = &ref->next;
2070 return 0;
2073 struct ref *get_local_heads(void)
2075 struct ref *local_refs = NULL, **local_tail = &local_refs;
2077 for_each_ref(one_local_ref, &local_tail);
2078 return local_refs;
2081 struct ref *guess_remote_head(const struct ref *head,
2082 const struct ref *refs,
2083 int all)
2085 const struct ref *r;
2086 struct ref *list = NULL;
2087 struct ref **tail = &list;
2089 if (!head)
2090 return NULL;
2093 * Some transports support directly peeking at
2094 * where HEAD points; if that is the case, then
2095 * we don't have to guess.
2097 if (head->symref)
2098 return copy_ref(find_ref_by_name(refs, head->symref));
2100 /* If a remote branch exists with the default branch name, let's use it. */
2101 if (!all) {
2102 char *ref = xstrfmt("refs/heads/%s", git_default_branch_name());
2104 r = find_ref_by_name(refs, ref);
2105 free(ref);
2106 if (r && oideq(&r->old_oid, &head->old_oid))
2107 return copy_ref(r);
2109 /* Fall back to the hard-coded historical default */
2110 r = find_ref_by_name(refs, "refs/heads/master");
2111 if (r && oideq(&r->old_oid, &head->old_oid))
2112 return copy_ref(r);
2115 /* Look for another ref that points there */
2116 for (r = refs; r; r = r->next) {
2117 if (r != head &&
2118 starts_with(r->name, "refs/heads/") &&
2119 oideq(&r->old_oid, &head->old_oid)) {
2120 *tail = copy_ref(r);
2121 tail = &((*tail)->next);
2122 if (!all)
2123 break;
2127 return list;
2130 struct stale_heads_info {
2131 struct string_list *ref_names;
2132 struct ref **stale_refs_tail;
2133 struct refspec *rs;
2136 static int get_stale_heads_cb(const char *refname, const struct object_id *oid,
2137 int flags, void *cb_data)
2139 struct stale_heads_info *info = cb_data;
2140 struct string_list matches = STRING_LIST_INIT_DUP;
2141 struct refspec_item query;
2142 int i, stale = 1;
2143 memset(&query, 0, sizeof(struct refspec_item));
2144 query.dst = (char *)refname;
2146 query_refspecs_multiple(info->rs, &query, &matches);
2147 if (matches.nr == 0)
2148 goto clean_exit; /* No matches */
2151 * If we did find a suitable refspec and it's not a symref and
2152 * it's not in the list of refs that currently exist in that
2153 * remote, we consider it to be stale. In order to deal with
2154 * overlapping refspecs, we need to go over all of the
2155 * matching refs.
2157 if (flags & REF_ISSYMREF)
2158 goto clean_exit;
2160 for (i = 0; stale && i < matches.nr; i++)
2161 if (string_list_has_string(info->ref_names, matches.items[i].string))
2162 stale = 0;
2164 if (stale) {
2165 struct ref *ref = make_linked_ref(refname, &info->stale_refs_tail);
2166 oidcpy(&ref->new_oid, oid);
2169 clean_exit:
2170 string_list_clear(&matches, 0);
2171 return 0;
2174 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map)
2176 struct ref *ref, *stale_refs = NULL;
2177 struct string_list ref_names = STRING_LIST_INIT_NODUP;
2178 struct stale_heads_info info;
2180 info.ref_names = &ref_names;
2181 info.stale_refs_tail = &stale_refs;
2182 info.rs = rs;
2183 for (ref = fetch_map; ref; ref = ref->next)
2184 string_list_append(&ref_names, ref->name);
2185 string_list_sort(&ref_names);
2186 for_each_ref(get_stale_heads_cb, &info);
2187 string_list_clear(&ref_names, 0);
2188 return stale_refs;
2192 * Compare-and-swap
2194 static void clear_cas_option(struct push_cas_option *cas)
2196 int i;
2198 for (i = 0; i < cas->nr; i++)
2199 free(cas->entry[i].refname);
2200 free(cas->entry);
2201 memset(cas, 0, sizeof(*cas));
2204 static struct push_cas *add_cas_entry(struct push_cas_option *cas,
2205 const char *refname,
2206 size_t refnamelen)
2208 struct push_cas *entry;
2209 ALLOC_GROW(cas->entry, cas->nr + 1, cas->alloc);
2210 entry = &cas->entry[cas->nr++];
2211 memset(entry, 0, sizeof(*entry));
2212 entry->refname = xmemdupz(refname, refnamelen);
2213 return entry;
2216 static int parse_push_cas_option(struct push_cas_option *cas, const char *arg, int unset)
2218 const char *colon;
2219 struct push_cas *entry;
2221 if (unset) {
2222 /* "--no-<option>" */
2223 clear_cas_option(cas);
2224 return 0;
2227 if (!arg) {
2228 /* just "--<option>" */
2229 cas->use_tracking_for_rest = 1;
2230 return 0;
2233 /* "--<option>=refname" or "--<option>=refname:value" */
2234 colon = strchrnul(arg, ':');
2235 entry = add_cas_entry(cas, arg, colon - arg);
2236 if (!*colon)
2237 entry->use_tracking = 1;
2238 else if (!colon[1])
2239 oidclr(&entry->expect);
2240 else if (get_oid(colon + 1, &entry->expect))
2241 return error(_("cannot parse expected object name '%s'"),
2242 colon + 1);
2243 return 0;
2246 int parseopt_push_cas_option(const struct option *opt, const char *arg, int unset)
2248 return parse_push_cas_option(opt->value, arg, unset);
2251 int is_empty_cas(const struct push_cas_option *cas)
2253 return !cas->use_tracking_for_rest && !cas->nr;
2257 * Look at remote.fetch refspec and see if we have a remote
2258 * tracking branch for the refname there. Fill its current
2259 * value in sha1[].
2260 * If we cannot do so, return negative to signal an error.
2262 static int remote_tracking(struct remote *remote, const char *refname,
2263 struct object_id *oid)
2265 char *dst;
2267 dst = apply_refspecs(&remote->fetch, refname);
2268 if (!dst)
2269 return -1; /* no tracking ref for refname at remote */
2270 if (read_ref(dst, oid))
2271 return -1; /* we know what the tracking ref is but we cannot read it */
2272 return 0;
2275 static void apply_cas(struct push_cas_option *cas,
2276 struct remote *remote,
2277 struct ref *ref)
2279 int i;
2281 /* Find an explicit --<option>=<name>[:<value>] entry */
2282 for (i = 0; i < cas->nr; i++) {
2283 struct push_cas *entry = &cas->entry[i];
2284 if (!refname_match(entry->refname, ref->name))
2285 continue;
2286 ref->expect_old_sha1 = 1;
2287 if (!entry->use_tracking)
2288 oidcpy(&ref->old_oid_expect, &entry->expect);
2289 else if (remote_tracking(remote, ref->name, &ref->old_oid_expect))
2290 oidclr(&ref->old_oid_expect);
2291 return;
2294 /* Are we using "--<option>" to cover all? */
2295 if (!cas->use_tracking_for_rest)
2296 return;
2298 ref->expect_old_sha1 = 1;
2299 if (remote_tracking(remote, ref->name, &ref->old_oid_expect))
2300 oidclr(&ref->old_oid_expect);
2303 void apply_push_cas(struct push_cas_option *cas,
2304 struct remote *remote,
2305 struct ref *remote_refs)
2307 struct ref *ref;
2308 for (ref = remote_refs; ref; ref = ref->next)
2309 apply_cas(cas, remote, ref);