The sixth batch
[git.git] / builtin / fetch.c
blob25740c13df1bf8d569e341fe717ff322af25207c
1 /*
2 * "git fetch"
3 */
4 #include "cache.h"
5 #include "config.h"
6 #include "repository.h"
7 #include "refs.h"
8 #include "refspec.h"
9 #include "object-store.h"
10 #include "oidset.h"
11 #include "commit.h"
12 #include "builtin.h"
13 #include "string-list.h"
14 #include "remote.h"
15 #include "transport.h"
16 #include "run-command.h"
17 #include "parse-options.h"
18 #include "sigchain.h"
19 #include "submodule-config.h"
20 #include "submodule.h"
21 #include "connected.h"
22 #include "strvec.h"
23 #include "utf8.h"
24 #include "packfile.h"
25 #include "list-objects-filter-options.h"
26 #include "commit-reach.h"
27 #include "branch.h"
28 #include "promisor-remote.h"
29 #include "commit-graph.h"
30 #include "shallow.h"
32 #define FORCED_UPDATES_DELAY_WARNING_IN_MS (10 * 1000)
34 static const char * const builtin_fetch_usage[] = {
35 N_("git fetch [<options>] [<repository> [<refspec>...]]"),
36 N_("git fetch [<options>] <group>"),
37 N_("git fetch --multiple [<options>] [(<repository> | <group>)...]"),
38 N_("git fetch --all [<options>]"),
39 NULL
42 enum {
43 TAGS_UNSET = 0,
44 TAGS_DEFAULT = 1,
45 TAGS_SET = 2
48 static int fetch_prune_config = -1; /* unspecified */
49 static int fetch_show_forced_updates = 1;
50 static uint64_t forced_updates_ms = 0;
51 static int prefetch = 0;
52 static int prune = -1; /* unspecified */
53 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
55 static int fetch_prune_tags_config = -1; /* unspecified */
56 static int prune_tags = -1; /* unspecified */
57 #define PRUNE_TAGS_BY_DEFAULT 0 /* do we prune tags by default? */
59 static int all, append, dry_run, force, keep, multiple, update_head_ok;
60 static int write_fetch_head = 1;
61 static int verbosity, deepen_relative, set_upstream;
62 static int progress = -1;
63 static int enable_auto_gc = 1;
64 static int tags = TAGS_DEFAULT, unshallow, update_shallow, deepen;
65 static int max_jobs = -1, submodule_fetch_jobs_config = -1;
66 static int fetch_parallel_config = 1;
67 static int atomic_fetch;
68 static enum transport_family family;
69 static const char *depth;
70 static const char *deepen_since;
71 static const char *upload_pack;
72 static struct string_list deepen_not = STRING_LIST_INIT_NODUP;
73 static struct strbuf default_rla = STRBUF_INIT;
74 static struct transport *gtransport;
75 static struct transport *gsecondary;
76 static const char *submodule_prefix = "";
77 static int recurse_submodules = RECURSE_SUBMODULES_DEFAULT;
78 static int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
79 static int shown_url = 0;
80 static struct refspec refmap = REFSPEC_INIT_FETCH;
81 static struct list_objects_filter_options filter_options;
82 static struct string_list server_options = STRING_LIST_INIT_DUP;
83 static struct string_list negotiation_tip = STRING_LIST_INIT_NODUP;
84 static int fetch_write_commit_graph = -1;
85 static int stdin_refspecs = 0;
86 static int negotiate_only;
88 static int git_fetch_config(const char *k, const char *v, void *cb)
90 if (!strcmp(k, "fetch.prune")) {
91 fetch_prune_config = git_config_bool(k, v);
92 return 0;
95 if (!strcmp(k, "fetch.prunetags")) {
96 fetch_prune_tags_config = git_config_bool(k, v);
97 return 0;
100 if (!strcmp(k, "fetch.showforcedupdates")) {
101 fetch_show_forced_updates = git_config_bool(k, v);
102 return 0;
105 if (!strcmp(k, "submodule.recurse")) {
106 int r = git_config_bool(k, v) ?
107 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
108 recurse_submodules = r;
111 if (!strcmp(k, "submodule.fetchjobs")) {
112 submodule_fetch_jobs_config = parse_submodule_fetchjobs(k, v);
113 return 0;
114 } else if (!strcmp(k, "fetch.recursesubmodules")) {
115 recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
116 return 0;
119 if (!strcmp(k, "fetch.parallel")) {
120 fetch_parallel_config = git_config_int(k, v);
121 if (fetch_parallel_config < 0)
122 die(_("fetch.parallel cannot be negative"));
123 return 0;
126 return git_default_config(k, v, cb);
129 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
131 BUG_ON_OPT_NEG(unset);
134 * "git fetch --refmap='' origin foo"
135 * can be used to tell the command not to store anywhere
137 refspec_append(&refmap, arg);
139 return 0;
142 static struct option builtin_fetch_options[] = {
143 OPT__VERBOSITY(&verbosity),
144 OPT_BOOL(0, "all", &all,
145 N_("fetch from all remotes")),
146 OPT_BOOL(0, "set-upstream", &set_upstream,
147 N_("set upstream for git pull/fetch")),
148 OPT_BOOL('a', "append", &append,
149 N_("append to .git/FETCH_HEAD instead of overwriting")),
150 OPT_BOOL(0, "atomic", &atomic_fetch,
151 N_("use atomic transaction to update references")),
152 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
153 N_("path to upload pack on remote end")),
154 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
155 OPT_BOOL('m', "multiple", &multiple,
156 N_("fetch from multiple remotes")),
157 OPT_SET_INT('t', "tags", &tags,
158 N_("fetch all tags and associated objects"), TAGS_SET),
159 OPT_SET_INT('n', NULL, &tags,
160 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
161 OPT_INTEGER('j', "jobs", &max_jobs,
162 N_("number of submodules fetched in parallel")),
163 OPT_BOOL(0, "prefetch", &prefetch,
164 N_("modify the refspec to place all refs within refs/prefetch/")),
165 OPT_BOOL('p', "prune", &prune,
166 N_("prune remote-tracking branches no longer on remote")),
167 OPT_BOOL('P', "prune-tags", &prune_tags,
168 N_("prune local tags no longer on remote and clobber changed tags")),
169 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules, N_("on-demand"),
170 N_("control recursive fetching of submodules"),
171 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
172 OPT_BOOL(0, "dry-run", &dry_run,
173 N_("dry run")),
174 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
175 N_("write fetched references to the FETCH_HEAD file")),
176 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
177 OPT_BOOL('u', "update-head-ok", &update_head_ok,
178 N_("allow updating of HEAD ref")),
179 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
180 OPT_STRING(0, "depth", &depth, N_("depth"),
181 N_("deepen history of shallow clone")),
182 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
183 N_("deepen history of shallow repository based on time")),
184 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
185 N_("deepen history of shallow clone, excluding rev")),
186 OPT_INTEGER(0, "deepen", &deepen_relative,
187 N_("deepen history of shallow clone")),
188 OPT_SET_INT_F(0, "unshallow", &unshallow,
189 N_("convert to a complete repository"),
190 1, PARSE_OPT_NONEG),
191 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
192 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
193 OPT_CALLBACK_F(0, "recurse-submodules-default",
194 &recurse_submodules_default, N_("on-demand"),
195 N_("default for recursive fetching of submodules "
196 "(lower priority than config files)"),
197 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
198 OPT_BOOL(0, "update-shallow", &update_shallow,
199 N_("accept refs that update .git/shallow")),
200 OPT_CALLBACK_F(0, "refmap", NULL, N_("refmap"),
201 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
202 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
203 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
204 TRANSPORT_FAMILY_IPV4),
205 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
206 TRANSPORT_FAMILY_IPV6),
207 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
208 N_("report that we have only objects reachable from this object")),
209 OPT_BOOL(0, "negotiate-only", &negotiate_only,
210 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
211 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
212 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
213 N_("run 'maintenance --auto' after fetching")),
214 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
215 N_("run 'maintenance --auto' after fetching")),
216 OPT_BOOL(0, "show-forced-updates", &fetch_show_forced_updates,
217 N_("check for forced-updates on all updated branches")),
218 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
219 N_("write the commit-graph after fetching")),
220 OPT_BOOL(0, "stdin", &stdin_refspecs,
221 N_("accept refspecs from stdin")),
222 OPT_END()
225 static void unlock_pack(void)
227 if (gtransport)
228 transport_unlock_pack(gtransport);
229 if (gsecondary)
230 transport_unlock_pack(gsecondary);
233 static void unlock_pack_on_signal(int signo)
235 unlock_pack();
236 sigchain_pop(signo);
237 raise(signo);
240 static void add_merge_config(struct ref **head,
241 const struct ref *remote_refs,
242 struct branch *branch,
243 struct ref ***tail)
245 int i;
247 for (i = 0; i < branch->merge_nr; i++) {
248 struct ref *rm, **old_tail = *tail;
249 struct refspec_item refspec;
251 for (rm = *head; rm; rm = rm->next) {
252 if (branch_merge_matches(branch, i, rm->name)) {
253 rm->fetch_head_status = FETCH_HEAD_MERGE;
254 break;
257 if (rm)
258 continue;
261 * Not fetched to a remote-tracking branch? We need to fetch
262 * it anyway to allow this branch's "branch.$name.merge"
263 * to be honored by 'git pull', but we do not have to
264 * fail if branch.$name.merge is misconfigured to point
265 * at a nonexisting branch. If we were indeed called by
266 * 'git pull', it will notice the misconfiguration because
267 * there is no entry in the resulting FETCH_HEAD marked
268 * for merging.
270 memset(&refspec, 0, sizeof(refspec));
271 refspec.src = branch->merge[i]->src;
272 get_fetch_map(remote_refs, &refspec, tail, 1);
273 for (rm = *old_tail; rm; rm = rm->next)
274 rm->fetch_head_status = FETCH_HEAD_MERGE;
278 static void create_fetch_oidset(struct ref **head, struct oidset *out)
280 struct ref *rm = *head;
281 while (rm) {
282 oidset_insert(out, &rm->old_oid);
283 rm = rm->next;
287 struct refname_hash_entry {
288 struct hashmap_entry ent;
289 struct object_id oid;
290 int ignore;
291 char refname[FLEX_ARRAY];
294 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data,
295 const struct hashmap_entry *eptr,
296 const struct hashmap_entry *entry_or_key,
297 const void *keydata)
299 const struct refname_hash_entry *e1, *e2;
301 e1 = container_of(eptr, const struct refname_hash_entry, ent);
302 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
303 return strcmp(e1->refname, keydata ? keydata : e2->refname);
306 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
307 const char *refname,
308 const struct object_id *oid)
310 struct refname_hash_entry *ent;
311 size_t len = strlen(refname);
313 FLEX_ALLOC_MEM(ent, refname, refname, len);
314 hashmap_entry_init(&ent->ent, strhash(refname));
315 oidcpy(&ent->oid, oid);
316 hashmap_add(map, &ent->ent);
317 return ent;
320 static int add_one_refname(const char *refname,
321 const struct object_id *oid,
322 int flag, void *cbdata)
324 struct hashmap *refname_map = cbdata;
326 (void) refname_hash_add(refname_map, refname, oid);
327 return 0;
330 static void refname_hash_init(struct hashmap *map)
332 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
335 static int refname_hash_exists(struct hashmap *map, const char *refname)
337 return !!hashmap_get_from_hash(map, strhash(refname), refname);
340 static void clear_item(struct refname_hash_entry *item)
342 item->ignore = 1;
345 static void find_non_local_tags(const struct ref *refs,
346 struct ref **head,
347 struct ref ***tail)
349 struct hashmap existing_refs;
350 struct hashmap remote_refs;
351 struct oidset fetch_oids = OIDSET_INIT;
352 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
353 struct string_list_item *remote_ref_item;
354 const struct ref *ref;
355 struct refname_hash_entry *item = NULL;
356 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
358 refname_hash_init(&existing_refs);
359 refname_hash_init(&remote_refs);
360 create_fetch_oidset(head, &fetch_oids);
362 for_each_ref(add_one_refname, &existing_refs);
363 for (ref = refs; ref; ref = ref->next) {
364 if (!starts_with(ref->name, "refs/tags/"))
365 continue;
368 * The peeled ref always follows the matching base
369 * ref, so if we see a peeled ref that we don't want
370 * to fetch then we can mark the ref entry in the list
371 * as one to ignore by setting util to NULL.
373 if (ends_with(ref->name, "^{}")) {
374 if (item &&
375 !has_object_file_with_flags(&ref->old_oid, quick_flags) &&
376 !oidset_contains(&fetch_oids, &ref->old_oid) &&
377 !has_object_file_with_flags(&item->oid, quick_flags) &&
378 !oidset_contains(&fetch_oids, &item->oid))
379 clear_item(item);
380 item = NULL;
381 continue;
385 * If item is non-NULL here, then we previously saw a
386 * ref not followed by a peeled reference, so we need
387 * to check if it is a lightweight tag that we want to
388 * fetch.
390 if (item &&
391 !has_object_file_with_flags(&item->oid, quick_flags) &&
392 !oidset_contains(&fetch_oids, &item->oid))
393 clear_item(item);
395 item = NULL;
397 /* skip duplicates and refs that we already have */
398 if (refname_hash_exists(&remote_refs, ref->name) ||
399 refname_hash_exists(&existing_refs, ref->name))
400 continue;
402 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
403 string_list_insert(&remote_refs_list, ref->name);
405 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
408 * We may have a final lightweight tag that needs to be
409 * checked to see if it needs fetching.
411 if (item &&
412 !has_object_file_with_flags(&item->oid, quick_flags) &&
413 !oidset_contains(&fetch_oids, &item->oid))
414 clear_item(item);
417 * For all the tags in the remote_refs_list,
418 * add them to the list of refs to be fetched
420 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
421 const char *refname = remote_ref_item->string;
422 struct ref *rm;
423 unsigned int hash = strhash(refname);
425 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
426 struct refname_hash_entry, ent);
427 if (!item)
428 BUG("unseen remote ref?");
430 /* Unless we have already decided to ignore this item... */
431 if (item->ignore)
432 continue;
434 rm = alloc_ref(item->refname);
435 rm->peer_ref = alloc_ref(item->refname);
436 oidcpy(&rm->old_oid, &item->oid);
437 **tail = rm;
438 *tail = &rm->next;
440 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
441 string_list_clear(&remote_refs_list, 0);
442 oidset_clear(&fetch_oids);
445 static void filter_prefetch_refspec(struct refspec *rs)
447 int i;
449 if (!prefetch)
450 return;
452 for (i = 0; i < rs->nr; i++) {
453 struct strbuf new_dst = STRBUF_INIT;
454 char *old_dst;
455 const char *sub = NULL;
457 if (rs->items[i].negative)
458 continue;
459 if (!rs->items[i].dst ||
460 (rs->items[i].src &&
461 !strncmp(rs->items[i].src, "refs/tags/", 10))) {
462 int j;
464 free(rs->items[i].src);
465 free(rs->items[i].dst);
467 for (j = i + 1; j < rs->nr; j++) {
468 rs->items[j - 1] = rs->items[j];
469 rs->raw[j - 1] = rs->raw[j];
471 rs->nr--;
472 i--;
473 continue;
476 old_dst = rs->items[i].dst;
477 strbuf_addstr(&new_dst, "refs/prefetch/");
480 * If old_dst starts with "refs/", then place
481 * sub after that prefix. Otherwise, start at
482 * the beginning of the string.
484 if (!skip_prefix(old_dst, "refs/", &sub))
485 sub = old_dst;
486 strbuf_addstr(&new_dst, sub);
488 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
489 rs->items[i].force = 1;
491 free(old_dst);
495 static struct ref *get_ref_map(struct remote *remote,
496 const struct ref *remote_refs,
497 struct refspec *rs,
498 int tags, int *autotags)
500 int i;
501 struct ref *rm;
502 struct ref *ref_map = NULL;
503 struct ref **tail = &ref_map;
505 /* opportunistically-updated references: */
506 struct ref *orefs = NULL, **oref_tail = &orefs;
508 struct hashmap existing_refs;
509 int existing_refs_populated = 0;
511 filter_prefetch_refspec(rs);
512 if (remote)
513 filter_prefetch_refspec(&remote->fetch);
515 if (rs->nr) {
516 struct refspec *fetch_refspec;
518 for (i = 0; i < rs->nr; i++) {
519 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
520 if (rs->items[i].dst && rs->items[i].dst[0])
521 *autotags = 1;
523 /* Merge everything on the command line (but not --tags) */
524 for (rm = ref_map; rm; rm = rm->next)
525 rm->fetch_head_status = FETCH_HEAD_MERGE;
528 * For any refs that we happen to be fetching via
529 * command-line arguments, the destination ref might
530 * have been missing or have been different than the
531 * remote-tracking ref that would be derived from the
532 * configured refspec. In these cases, we want to
533 * take the opportunity to update their configured
534 * remote-tracking reference. However, we do not want
535 * to mention these entries in FETCH_HEAD at all, as
536 * they would simply be duplicates of existing
537 * entries, so we set them FETCH_HEAD_IGNORE below.
539 * We compute these entries now, based only on the
540 * refspecs specified on the command line. But we add
541 * them to the list following the refspecs resulting
542 * from the tags option so that one of the latter,
543 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
544 * by ref_remove_duplicates() in favor of one of these
545 * opportunistic entries with FETCH_HEAD_IGNORE.
547 if (refmap.nr)
548 fetch_refspec = &refmap;
549 else
550 fetch_refspec = &remote->fetch;
552 for (i = 0; i < fetch_refspec->nr; i++)
553 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
554 } else if (refmap.nr) {
555 die("--refmap option is only meaningful with command-line refspec(s).");
556 } else {
557 /* Use the defaults */
558 struct branch *branch = branch_get(NULL);
559 int has_merge = branch_has_merge_config(branch);
560 if (remote &&
561 (remote->fetch.nr ||
562 /* Note: has_merge implies non-NULL branch->remote_name */
563 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
564 for (i = 0; i < remote->fetch.nr; i++) {
565 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
566 if (remote->fetch.items[i].dst &&
567 remote->fetch.items[i].dst[0])
568 *autotags = 1;
569 if (!i && !has_merge && ref_map &&
570 !remote->fetch.items[0].pattern)
571 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
574 * if the remote we're fetching from is the same
575 * as given in branch.<name>.remote, we add the
576 * ref given in branch.<name>.merge, too.
578 * Note: has_merge implies non-NULL branch->remote_name
580 if (has_merge &&
581 !strcmp(branch->remote_name, remote->name))
582 add_merge_config(&ref_map, remote_refs, branch, &tail);
583 } else if (!prefetch) {
584 ref_map = get_remote_ref(remote_refs, "HEAD");
585 if (!ref_map)
586 die(_("Couldn't find remote ref HEAD"));
587 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
588 tail = &ref_map->next;
592 if (tags == TAGS_SET)
593 /* also fetch all tags */
594 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
595 else if (tags == TAGS_DEFAULT && *autotags)
596 find_non_local_tags(remote_refs, &ref_map, &tail);
598 /* Now append any refs to be updated opportunistically: */
599 *tail = orefs;
600 for (rm = orefs; rm; rm = rm->next) {
601 rm->fetch_head_status = FETCH_HEAD_IGNORE;
602 tail = &rm->next;
606 * apply negative refspecs first, before we remove duplicates. This is
607 * necessary as negative refspecs might remove an otherwise conflicting
608 * duplicate.
610 if (rs->nr)
611 ref_map = apply_negative_refspecs(ref_map, rs);
612 else
613 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
615 ref_map = ref_remove_duplicates(ref_map);
617 for (rm = ref_map; rm; rm = rm->next) {
618 if (rm->peer_ref) {
619 const char *refname = rm->peer_ref->name;
620 struct refname_hash_entry *peer_item;
621 unsigned int hash = strhash(refname);
623 if (!existing_refs_populated) {
624 refname_hash_init(&existing_refs);
625 for_each_ref(add_one_refname, &existing_refs);
626 existing_refs_populated = 1;
629 peer_item = hashmap_get_entry_from_hash(&existing_refs,
630 hash, refname,
631 struct refname_hash_entry, ent);
632 if (peer_item) {
633 struct object_id *old_oid = &peer_item->oid;
634 oidcpy(&rm->peer_ref->old_oid, old_oid);
638 if (existing_refs_populated)
639 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
641 return ref_map;
644 #define STORE_REF_ERROR_OTHER 1
645 #define STORE_REF_ERROR_DF_CONFLICT 2
647 static int s_update_ref(const char *action,
648 struct ref *ref,
649 struct ref_transaction *transaction,
650 int check_old)
652 char *msg;
653 char *rla = getenv("GIT_REFLOG_ACTION");
654 struct ref_transaction *our_transaction = NULL;
655 struct strbuf err = STRBUF_INIT;
656 int ret;
658 if (dry_run)
659 return 0;
660 if (!rla)
661 rla = default_rla.buf;
662 msg = xstrfmt("%s: %s", rla, action);
665 * If no transaction was passed to us, we manage the transaction
666 * ourselves. Otherwise, we trust the caller to handle the transaction
667 * lifecycle.
669 if (!transaction) {
670 transaction = our_transaction = ref_transaction_begin(&err);
671 if (!transaction) {
672 ret = STORE_REF_ERROR_OTHER;
673 goto out;
677 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
678 check_old ? &ref->old_oid : NULL,
679 0, msg, &err);
680 if (ret) {
681 ret = STORE_REF_ERROR_OTHER;
682 goto out;
685 if (our_transaction) {
686 switch (ref_transaction_commit(our_transaction, &err)) {
687 case 0:
688 break;
689 case TRANSACTION_NAME_CONFLICT:
690 ret = STORE_REF_ERROR_DF_CONFLICT;
691 goto out;
692 default:
693 ret = STORE_REF_ERROR_OTHER;
694 goto out;
698 out:
699 ref_transaction_free(our_transaction);
700 if (ret)
701 error("%s", err.buf);
702 strbuf_release(&err);
703 free(msg);
704 return ret;
707 static int refcol_width = 10;
708 static int compact_format;
710 static void adjust_refcol_width(const struct ref *ref)
712 int max, rlen, llen, len;
714 /* uptodate lines are only shown on high verbosity level */
715 if (!verbosity && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
716 return;
718 max = term_columns();
719 rlen = utf8_strwidth(prettify_refname(ref->name));
721 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
724 * rough estimation to see if the output line is too long and
725 * should not be counted (we can't do precise calculation
726 * anyway because we don't know if the error explanation part
727 * will be printed in update_local_ref)
729 if (compact_format) {
730 llen = 0;
731 max = max * 2 / 3;
733 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
734 if (len >= max)
735 return;
738 * Not precise calculation for compact mode because '*' can
739 * appear on the left hand side of '->' and shrink the column
740 * back.
742 if (refcol_width < rlen)
743 refcol_width = rlen;
746 static void prepare_format_display(struct ref *ref_map)
748 struct ref *rm;
749 const char *format = "full";
751 git_config_get_string_tmp("fetch.output", &format);
752 if (!strcasecmp(format, "full"))
753 compact_format = 0;
754 else if (!strcasecmp(format, "compact"))
755 compact_format = 1;
756 else
757 die(_("configuration fetch.output contains invalid value %s"),
758 format);
760 for (rm = ref_map; rm; rm = rm->next) {
761 if (rm->status == REF_STATUS_REJECT_SHALLOW ||
762 !rm->peer_ref ||
763 !strcmp(rm->name, "HEAD"))
764 continue;
766 adjust_refcol_width(rm);
770 static void print_remote_to_local(struct strbuf *display,
771 const char *remote, const char *local)
773 strbuf_addf(display, "%-*s -> %s", refcol_width, remote, local);
776 static int find_and_replace(struct strbuf *haystack,
777 const char *needle,
778 const char *placeholder)
780 const char *p = NULL;
781 int plen, nlen;
783 nlen = strlen(needle);
784 if (ends_with(haystack->buf, needle))
785 p = haystack->buf + haystack->len - nlen;
786 else
787 p = strstr(haystack->buf, needle);
788 if (!p)
789 return 0;
791 if (p > haystack->buf && p[-1] != '/')
792 return 0;
794 plen = strlen(p);
795 if (plen > nlen && p[nlen] != '/')
796 return 0;
798 strbuf_splice(haystack, p - haystack->buf, nlen,
799 placeholder, strlen(placeholder));
800 return 1;
803 static void print_compact(struct strbuf *display,
804 const char *remote, const char *local)
806 struct strbuf r = STRBUF_INIT;
807 struct strbuf l = STRBUF_INIT;
809 if (!strcmp(remote, local)) {
810 strbuf_addf(display, "%-*s -> *", refcol_width, remote);
811 return;
814 strbuf_addstr(&r, remote);
815 strbuf_addstr(&l, local);
817 if (!find_and_replace(&r, local, "*"))
818 find_and_replace(&l, remote, "*");
819 print_remote_to_local(display, r.buf, l.buf);
821 strbuf_release(&r);
822 strbuf_release(&l);
825 static void format_display(struct strbuf *display, char code,
826 const char *summary, const char *error,
827 const char *remote, const char *local,
828 int summary_width)
830 int width = (summary_width + strlen(summary) - gettext_width(summary));
832 strbuf_addf(display, "%c %-*s ", code, width, summary);
833 if (!compact_format)
834 print_remote_to_local(display, remote, local);
835 else
836 print_compact(display, remote, local);
837 if (error)
838 strbuf_addf(display, " (%s)", error);
841 static int update_local_ref(struct ref *ref,
842 struct ref_transaction *transaction,
843 const char *remote,
844 const struct ref *remote_ref,
845 struct strbuf *display,
846 int summary_width)
848 struct commit *current = NULL, *updated;
849 enum object_type type;
850 struct branch *current_branch = branch_get(NULL);
851 const char *pretty_ref = prettify_refname(ref->name);
852 int fast_forward = 0;
854 type = oid_object_info(the_repository, &ref->new_oid, NULL);
855 if (type < 0)
856 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
858 if (oideq(&ref->old_oid, &ref->new_oid)) {
859 if (verbosity > 0)
860 format_display(display, '=', _("[up to date]"), NULL,
861 remote, pretty_ref, summary_width);
862 return 0;
865 if (current_branch &&
866 !strcmp(ref->name, current_branch->name) &&
867 !(update_head_ok || is_bare_repository()) &&
868 !is_null_oid(&ref->old_oid)) {
870 * If this is the head, and it's not okay to update
871 * the head, and the old value of the head isn't empty...
873 format_display(display, '!', _("[rejected]"),
874 _("can't fetch in current branch"),
875 remote, pretty_ref, summary_width);
876 return 1;
879 if (!is_null_oid(&ref->old_oid) &&
880 starts_with(ref->name, "refs/tags/")) {
881 if (force || ref->force) {
882 int r;
883 r = s_update_ref("updating tag", ref, transaction, 0);
884 format_display(display, r ? '!' : 't', _("[tag update]"),
885 r ? _("unable to update local ref") : NULL,
886 remote, pretty_ref, summary_width);
887 return r;
888 } else {
889 format_display(display, '!', _("[rejected]"), _("would clobber existing tag"),
890 remote, pretty_ref, summary_width);
891 return 1;
895 current = lookup_commit_reference_gently(the_repository,
896 &ref->old_oid, 1);
897 updated = lookup_commit_reference_gently(the_repository,
898 &ref->new_oid, 1);
899 if (!current || !updated) {
900 const char *msg;
901 const char *what;
902 int r;
904 * Nicely describe the new ref we're fetching.
905 * Base this on the remote's ref name, as it's
906 * more likely to follow a standard layout.
908 const char *name = remote_ref ? remote_ref->name : "";
909 if (starts_with(name, "refs/tags/")) {
910 msg = "storing tag";
911 what = _("[new tag]");
912 } else if (starts_with(name, "refs/heads/")) {
913 msg = "storing head";
914 what = _("[new branch]");
915 } else {
916 msg = "storing ref";
917 what = _("[new ref]");
920 r = s_update_ref(msg, ref, transaction, 0);
921 format_display(display, r ? '!' : '*', what,
922 r ? _("unable to update local ref") : NULL,
923 remote, pretty_ref, summary_width);
924 return r;
927 if (fetch_show_forced_updates) {
928 uint64_t t_before = getnanotime();
929 fast_forward = in_merge_bases(current, updated);
930 forced_updates_ms += (getnanotime() - t_before) / 1000000;
931 } else {
932 fast_forward = 1;
935 if (fast_forward) {
936 struct strbuf quickref = STRBUF_INIT;
937 int r;
939 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
940 strbuf_addstr(&quickref, "..");
941 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
942 r = s_update_ref("fast-forward", ref, transaction, 1);
943 format_display(display, r ? '!' : ' ', quickref.buf,
944 r ? _("unable to update local ref") : NULL,
945 remote, pretty_ref, summary_width);
946 strbuf_release(&quickref);
947 return r;
948 } else if (force || ref->force) {
949 struct strbuf quickref = STRBUF_INIT;
950 int r;
951 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
952 strbuf_addstr(&quickref, "...");
953 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
954 r = s_update_ref("forced-update", ref, transaction, 1);
955 format_display(display, r ? '!' : '+', quickref.buf,
956 r ? _("unable to update local ref") : _("forced update"),
957 remote, pretty_ref, summary_width);
958 strbuf_release(&quickref);
959 return r;
960 } else {
961 format_display(display, '!', _("[rejected]"), _("non-fast-forward"),
962 remote, pretty_ref, summary_width);
963 return 1;
967 static int iterate_ref_map(void *cb_data, struct object_id *oid)
969 struct ref **rm = cb_data;
970 struct ref *ref = *rm;
972 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
973 ref = ref->next;
974 if (!ref)
975 return -1; /* end of the list */
976 *rm = ref->next;
977 oidcpy(oid, &ref->old_oid);
978 return 0;
981 struct fetch_head {
982 FILE *fp;
983 struct strbuf buf;
986 static int open_fetch_head(struct fetch_head *fetch_head)
988 const char *filename = git_path_fetch_head(the_repository);
990 if (write_fetch_head) {
991 fetch_head->fp = fopen(filename, "a");
992 if (!fetch_head->fp)
993 return error_errno(_("cannot open %s"), filename);
994 strbuf_init(&fetch_head->buf, 0);
995 } else {
996 fetch_head->fp = NULL;
999 return 0;
1002 static void append_fetch_head(struct fetch_head *fetch_head,
1003 const struct object_id *old_oid,
1004 enum fetch_head_status fetch_head_status,
1005 const char *note,
1006 const char *url, size_t url_len)
1008 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1009 const char *merge_status_marker;
1010 size_t i;
1012 if (!fetch_head->fp)
1013 return;
1015 switch (fetch_head_status) {
1016 case FETCH_HEAD_NOT_FOR_MERGE:
1017 merge_status_marker = "not-for-merge";
1018 break;
1019 case FETCH_HEAD_MERGE:
1020 merge_status_marker = "";
1021 break;
1022 default:
1023 /* do not write anything to FETCH_HEAD */
1024 return;
1027 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1028 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1029 for (i = 0; i < url_len; ++i)
1030 if ('\n' == url[i])
1031 strbuf_addstr(&fetch_head->buf, "\\n");
1032 else
1033 strbuf_addch(&fetch_head->buf, url[i]);
1034 strbuf_addch(&fetch_head->buf, '\n');
1037 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1038 * any of the reference updates fails. We thus have to write all
1039 * updates to a buffer first and only commit it as soon as all
1040 * references have been successfully updated.
1042 if (!atomic_fetch) {
1043 strbuf_write(&fetch_head->buf, fetch_head->fp);
1044 strbuf_reset(&fetch_head->buf);
1048 static void commit_fetch_head(struct fetch_head *fetch_head)
1050 if (!fetch_head->fp || !atomic_fetch)
1051 return;
1052 strbuf_write(&fetch_head->buf, fetch_head->fp);
1055 static void close_fetch_head(struct fetch_head *fetch_head)
1057 if (!fetch_head->fp)
1058 return;
1060 fclose(fetch_head->fp);
1061 strbuf_release(&fetch_head->buf);
1064 static const char warn_show_forced_updates[] =
1065 N_("Fetch normally indicates which branches had a forced update,\n"
1066 "but that check has been disabled. To re-enable, use '--show-forced-updates'\n"
1067 "flag or run 'git config fetch.showForcedUpdates true'.");
1068 static const char warn_time_show_forced_updates[] =
1069 N_("It took %.2f seconds to check forced updates. You can use\n"
1070 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1071 " to avoid this check.\n");
1073 static int store_updated_refs(const char *raw_url, const char *remote_name,
1074 int connectivity_checked, struct ref *ref_map)
1076 struct fetch_head fetch_head;
1077 struct commit *commit;
1078 int url_len, i, rc = 0;
1079 struct strbuf note = STRBUF_INIT, err = STRBUF_INIT;
1080 struct ref_transaction *transaction = NULL;
1081 const char *what, *kind;
1082 struct ref *rm;
1083 char *url;
1084 int want_status;
1085 int summary_width = transport_summary_width(ref_map);
1087 rc = open_fetch_head(&fetch_head);
1088 if (rc)
1089 return -1;
1091 if (raw_url)
1092 url = transport_anonymize_url(raw_url);
1093 else
1094 url = xstrdup("foreign");
1096 if (!connectivity_checked) {
1097 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1099 rm = ref_map;
1100 if (check_connected(iterate_ref_map, &rm, &opt)) {
1101 rc = error(_("%s did not send all necessary objects\n"), url);
1102 goto abort;
1106 if (atomic_fetch) {
1107 transaction = ref_transaction_begin(&err);
1108 if (!transaction) {
1109 error("%s", err.buf);
1110 goto abort;
1114 prepare_format_display(ref_map);
1117 * We do a pass for each fetch_head_status type in their enum order, so
1118 * merged entries are written before not-for-merge. That lets readers
1119 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1121 for (want_status = FETCH_HEAD_MERGE;
1122 want_status <= FETCH_HEAD_IGNORE;
1123 want_status++) {
1124 for (rm = ref_map; rm; rm = rm->next) {
1125 struct ref *ref = NULL;
1127 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1128 if (want_status == FETCH_HEAD_MERGE)
1129 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1130 rm->peer_ref ? rm->peer_ref->name : rm->name);
1131 continue;
1134 commit = lookup_commit_reference_gently(the_repository,
1135 &rm->old_oid,
1137 if (!commit)
1138 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1140 if (rm->fetch_head_status != want_status)
1141 continue;
1143 if (rm->peer_ref) {
1144 ref = alloc_ref(rm->peer_ref->name);
1145 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1146 oidcpy(&ref->new_oid, &rm->old_oid);
1147 ref->force = rm->peer_ref->force;
1150 if (recurse_submodules != RECURSE_SUBMODULES_OFF &&
1151 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1152 check_for_new_submodule_commits(&rm->old_oid);
1155 if (!strcmp(rm->name, "HEAD")) {
1156 kind = "";
1157 what = "";
1159 else if (skip_prefix(rm->name, "refs/heads/", &what))
1160 kind = "branch";
1161 else if (skip_prefix(rm->name, "refs/tags/", &what))
1162 kind = "tag";
1163 else if (skip_prefix(rm->name, "refs/remotes/", &what))
1164 kind = "remote-tracking branch";
1165 else {
1166 kind = "";
1167 what = rm->name;
1170 url_len = strlen(url);
1171 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1173 url_len = i + 1;
1174 if (4 < i && !strncmp(".git", url + i - 3, 4))
1175 url_len = i - 3;
1177 strbuf_reset(&note);
1178 if (*what) {
1179 if (*kind)
1180 strbuf_addf(&note, "%s ", kind);
1181 strbuf_addf(&note, "'%s' of ", what);
1184 append_fetch_head(&fetch_head, &rm->old_oid,
1185 rm->fetch_head_status,
1186 note.buf, url, url_len);
1188 strbuf_reset(&note);
1189 if (ref) {
1190 rc |= update_local_ref(ref, transaction, what,
1191 rm, &note, summary_width);
1192 free(ref);
1193 } else if (write_fetch_head || dry_run) {
1195 * Display fetches written to FETCH_HEAD (or
1196 * would be written to FETCH_HEAD, if --dry-run
1197 * is set).
1199 format_display(&note, '*',
1200 *kind ? kind : "branch", NULL,
1201 *what ? what : "HEAD",
1202 "FETCH_HEAD", summary_width);
1204 if (note.len) {
1205 if (verbosity >= 0 && !shown_url) {
1206 fprintf(stderr, _("From %.*s\n"),
1207 url_len, url);
1208 shown_url = 1;
1210 if (verbosity >= 0)
1211 fprintf(stderr, " %s\n", note.buf);
1216 if (!rc && transaction) {
1217 rc = ref_transaction_commit(transaction, &err);
1218 if (rc) {
1219 error("%s", err.buf);
1220 goto abort;
1224 if (!rc)
1225 commit_fetch_head(&fetch_head);
1227 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1228 error(_("some local refs could not be updated; try running\n"
1229 " 'git remote prune %s' to remove any old, conflicting "
1230 "branches"), remote_name);
1232 if (advice_fetch_show_forced_updates) {
1233 if (!fetch_show_forced_updates) {
1234 warning(_(warn_show_forced_updates));
1235 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1236 warning(_(warn_time_show_forced_updates),
1237 forced_updates_ms / 1000.0);
1241 abort:
1242 strbuf_release(&note);
1243 strbuf_release(&err);
1244 ref_transaction_free(transaction);
1245 free(url);
1246 close_fetch_head(&fetch_head);
1247 return rc;
1251 * We would want to bypass the object transfer altogether if
1252 * everything we are going to fetch already exists and is connected
1253 * locally.
1255 static int check_exist_and_connected(struct ref *ref_map)
1257 struct ref *rm = ref_map;
1258 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1259 struct ref *r;
1262 * If we are deepening a shallow clone we already have these
1263 * objects reachable. Running rev-list here will return with
1264 * a good (0) exit status and we'll bypass the fetch that we
1265 * really need to perform. Claiming failure now will ensure
1266 * we perform the network exchange to deepen our history.
1268 if (deepen)
1269 return -1;
1272 * check_connected() allows objects to merely be promised, but
1273 * we need all direct targets to exist.
1275 for (r = rm; r; r = r->next) {
1276 if (!has_object_file_with_flags(&r->old_oid,
1277 OBJECT_INFO_SKIP_FETCH_OBJECT))
1278 return -1;
1281 opt.quiet = 1;
1282 return check_connected(iterate_ref_map, &rm, &opt);
1285 static int fetch_refs(struct transport *transport, struct ref *ref_map)
1287 int ret = check_exist_and_connected(ref_map);
1288 if (ret) {
1289 trace2_region_enter("fetch", "fetch_refs", the_repository);
1290 ret = transport_fetch_refs(transport, ref_map);
1291 trace2_region_leave("fetch", "fetch_refs", the_repository);
1293 if (!ret)
1295 * Keep the new pack's ".keep" file around to allow the caller
1296 * time to update refs to reference the new objects.
1298 return 0;
1299 transport_unlock_pack(transport);
1300 return ret;
1303 /* Update local refs based on the ref values fetched from a remote */
1304 static int consume_refs(struct transport *transport, struct ref *ref_map)
1306 int connectivity_checked = transport->smart_options
1307 ? transport->smart_options->connectivity_checked : 0;
1308 int ret;
1309 trace2_region_enter("fetch", "consume_refs", the_repository);
1310 ret = store_updated_refs(transport->url,
1311 transport->remote->name,
1312 connectivity_checked,
1313 ref_map);
1314 transport_unlock_pack(transport);
1315 trace2_region_leave("fetch", "consume_refs", the_repository);
1316 return ret;
1319 static int prune_refs(struct refspec *rs, struct ref *ref_map,
1320 const char *raw_url)
1322 int url_len, i, result = 0;
1323 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1324 char *url;
1325 int summary_width = transport_summary_width(stale_refs);
1326 const char *dangling_msg = dry_run
1327 ? _(" (%s will become dangling)")
1328 : _(" (%s has become dangling)");
1330 if (raw_url)
1331 url = transport_anonymize_url(raw_url);
1332 else
1333 url = xstrdup("foreign");
1335 url_len = strlen(url);
1336 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1339 url_len = i + 1;
1340 if (4 < i && !strncmp(".git", url + i - 3, 4))
1341 url_len = i - 3;
1343 if (!dry_run) {
1344 struct string_list refnames = STRING_LIST_INIT_NODUP;
1346 for (ref = stale_refs; ref; ref = ref->next)
1347 string_list_append(&refnames, ref->name);
1349 result = delete_refs("fetch: prune", &refnames, 0);
1350 string_list_clear(&refnames, 0);
1353 if (verbosity >= 0) {
1354 for (ref = stale_refs; ref; ref = ref->next) {
1355 struct strbuf sb = STRBUF_INIT;
1356 if (!shown_url) {
1357 fprintf(stderr, _("From %.*s\n"), url_len, url);
1358 shown_url = 1;
1360 format_display(&sb, '-', _("[deleted]"), NULL,
1361 _("(none)"), prettify_refname(ref->name),
1362 summary_width);
1363 fprintf(stderr, " %s\n",sb.buf);
1364 strbuf_release(&sb);
1365 warn_dangling_symref(stderr, dangling_msg, ref->name);
1369 free(url);
1370 free_refs(stale_refs);
1371 return result;
1374 static void check_not_current_branch(struct ref *ref_map)
1376 struct branch *current_branch = branch_get(NULL);
1378 if (is_bare_repository() || !current_branch)
1379 return;
1381 for (; ref_map; ref_map = ref_map->next)
1382 if (ref_map->peer_ref && !strcmp(current_branch->refname,
1383 ref_map->peer_ref->name))
1384 die(_("Refusing to fetch into current branch %s "
1385 "of non-bare repository"), current_branch->refname);
1388 static int truncate_fetch_head(void)
1390 const char *filename = git_path_fetch_head(the_repository);
1391 FILE *fp = fopen_for_writing(filename);
1393 if (!fp)
1394 return error_errno(_("cannot open %s"), filename);
1395 fclose(fp);
1396 return 0;
1399 static void set_option(struct transport *transport, const char *name, const char *value)
1401 int r = transport_set_option(transport, name, value);
1402 if (r < 0)
1403 die(_("Option \"%s\" value \"%s\" is not valid for %s"),
1404 name, value, transport->url);
1405 if (r > 0)
1406 warning(_("Option \"%s\" is ignored for %s\n"),
1407 name, transport->url);
1411 static int add_oid(const char *refname, const struct object_id *oid, int flags,
1412 void *cb_data)
1414 struct oid_array *oids = cb_data;
1416 oid_array_append(oids, oid);
1417 return 0;
1420 static void add_negotiation_tips(struct git_transport_options *smart_options)
1422 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1423 int i;
1425 for (i = 0; i < negotiation_tip.nr; i++) {
1426 const char *s = negotiation_tip.items[i].string;
1427 int old_nr;
1428 if (!has_glob_specials(s)) {
1429 struct object_id oid;
1430 if (get_oid(s, &oid))
1431 die("%s is not a valid object", s);
1432 oid_array_append(oids, &oid);
1433 continue;
1435 old_nr = oids->nr;
1436 for_each_glob_ref(add_oid, s, oids);
1437 if (old_nr == oids->nr)
1438 warning("Ignoring --negotiation-tip=%s because it does not match any refs",
1441 smart_options->negotiation_tips = oids;
1444 static struct transport *prepare_transport(struct remote *remote, int deepen)
1446 struct transport *transport;
1448 transport = transport_get(remote, NULL);
1449 transport_set_verbosity(transport, verbosity, progress);
1450 transport->family = family;
1451 if (upload_pack)
1452 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1453 if (keep)
1454 set_option(transport, TRANS_OPT_KEEP, "yes");
1455 if (depth)
1456 set_option(transport, TRANS_OPT_DEPTH, depth);
1457 if (deepen && deepen_since)
1458 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1459 if (deepen && deepen_not.nr)
1460 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1461 (const char *)&deepen_not);
1462 if (deepen_relative)
1463 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1464 if (update_shallow)
1465 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1466 if (filter_options.choice) {
1467 const char *spec =
1468 expand_list_objects_filter_spec(&filter_options);
1469 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1470 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1472 if (negotiation_tip.nr) {
1473 if (transport->smart_options)
1474 add_negotiation_tips(transport->smart_options);
1475 else
1476 warning("Ignoring --negotiation-tip because the protocol does not support it.");
1478 return transport;
1481 static void backfill_tags(struct transport *transport, struct ref *ref_map)
1483 int cannot_reuse;
1486 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1487 * when remote helper is used (setting it to an empty string
1488 * is not unsetting). We could extend the remote helper
1489 * protocol for that, but for now, just force a new connection
1490 * without deepen-since. Similar story for deepen-not.
1492 cannot_reuse = transport->cannot_reuse ||
1493 deepen_since || deepen_not.nr;
1494 if (cannot_reuse) {
1495 gsecondary = prepare_transport(transport->remote, 0);
1496 transport = gsecondary;
1499 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1500 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1501 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1502 if (!fetch_refs(transport, ref_map))
1503 consume_refs(transport, ref_map);
1505 if (gsecondary) {
1506 transport_disconnect(gsecondary);
1507 gsecondary = NULL;
1511 static int do_fetch(struct transport *transport,
1512 struct refspec *rs)
1514 struct ref *ref_map;
1515 int autotags = (transport->remote->fetch_tags == 1);
1516 int retcode = 0;
1517 const struct ref *remote_refs;
1518 struct transport_ls_refs_options transport_ls_refs_options =
1519 TRANSPORT_LS_REFS_OPTIONS_INIT;
1520 int must_list_refs = 1;
1522 if (tags == TAGS_DEFAULT) {
1523 if (transport->remote->fetch_tags == 2)
1524 tags = TAGS_SET;
1525 if (transport->remote->fetch_tags == -1)
1526 tags = TAGS_UNSET;
1529 /* if not appending, truncate FETCH_HEAD */
1530 if (!append && write_fetch_head) {
1531 retcode = truncate_fetch_head();
1532 if (retcode)
1533 goto cleanup;
1536 if (rs->nr) {
1537 int i;
1539 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1542 * We can avoid listing refs if all of them are exact
1543 * OIDs
1545 must_list_refs = 0;
1546 for (i = 0; i < rs->nr; i++) {
1547 if (!rs->items[i].exact_sha1) {
1548 must_list_refs = 1;
1549 break;
1552 } else if (transport->remote && transport->remote->fetch.nr)
1553 refspec_ref_prefixes(&transport->remote->fetch,
1554 &transport_ls_refs_options.ref_prefixes);
1556 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1557 must_list_refs = 1;
1558 if (transport_ls_refs_options.ref_prefixes.nr)
1559 strvec_push(&transport_ls_refs_options.ref_prefixes,
1560 "refs/tags/");
1563 if (must_list_refs) {
1564 trace2_region_enter("fetch", "remote_refs", the_repository);
1565 remote_refs = transport_get_remote_refs(transport,
1566 &transport_ls_refs_options);
1567 trace2_region_leave("fetch", "remote_refs", the_repository);
1568 } else
1569 remote_refs = NULL;
1571 strvec_clear(&transport_ls_refs_options.ref_prefixes);
1573 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1574 tags, &autotags);
1575 if (!update_head_ok)
1576 check_not_current_branch(ref_map);
1578 if (tags == TAGS_DEFAULT && autotags)
1579 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1580 if (prune) {
1582 * We only prune based on refspecs specified
1583 * explicitly (via command line or configuration); we
1584 * don't care whether --tags was specified.
1586 if (rs->nr) {
1587 prune_refs(rs, ref_map, transport->url);
1588 } else {
1589 prune_refs(&transport->remote->fetch,
1590 ref_map,
1591 transport->url);
1594 if (fetch_refs(transport, ref_map) || consume_refs(transport, ref_map)) {
1595 free_refs(ref_map);
1596 retcode = 1;
1597 goto cleanup;
1600 if (set_upstream) {
1601 struct branch *branch = branch_get("HEAD");
1602 struct ref *rm;
1603 struct ref *source_ref = NULL;
1606 * We're setting the upstream configuration for the
1607 * current branch. The relevant upstream is the
1608 * fetched branch that is meant to be merged with the
1609 * current one, i.e. the one fetched to FETCH_HEAD.
1611 * When there are several such branches, consider the
1612 * request ambiguous and err on the safe side by doing
1613 * nothing and just emit a warning.
1615 for (rm = ref_map; rm; rm = rm->next) {
1616 if (!rm->peer_ref) {
1617 if (source_ref) {
1618 warning(_("multiple branches detected, incompatible with --set-upstream"));
1619 goto skip;
1620 } else {
1621 source_ref = rm;
1625 if (source_ref) {
1626 if (!strcmp(source_ref->name, "HEAD") ||
1627 starts_with(source_ref->name, "refs/heads/"))
1628 install_branch_config(0,
1629 branch->name,
1630 transport->remote->name,
1631 source_ref->name);
1632 else if (starts_with(source_ref->name, "refs/remotes/"))
1633 warning(_("not setting upstream for a remote remote-tracking branch"));
1634 else if (starts_with(source_ref->name, "refs/tags/"))
1635 warning(_("not setting upstream for a remote tag"));
1636 else
1637 warning(_("unknown branch type"));
1638 } else {
1639 warning(_("no source branch found.\n"
1640 "you need to specify exactly one branch with the --set-upstream option."));
1643 skip:
1644 free_refs(ref_map);
1646 /* if neither --no-tags nor --tags was specified, do automated tag
1647 * following ... */
1648 if (tags == TAGS_DEFAULT && autotags) {
1649 struct ref **tail = &ref_map;
1650 ref_map = NULL;
1651 find_non_local_tags(remote_refs, &ref_map, &tail);
1652 if (ref_map)
1653 backfill_tags(transport, ref_map);
1654 free_refs(ref_map);
1657 cleanup:
1658 return retcode;
1661 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1663 struct string_list *list = priv;
1664 if (!remote->skip_default_update)
1665 string_list_append(list, remote->name);
1666 return 0;
1669 struct remote_group_data {
1670 const char *name;
1671 struct string_list *list;
1674 static int get_remote_group(const char *key, const char *value, void *priv)
1676 struct remote_group_data *g = priv;
1678 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1679 /* split list by white space */
1680 while (*value) {
1681 size_t wordlen = strcspn(value, " \t\n");
1683 if (wordlen >= 1)
1684 string_list_append_nodup(g->list,
1685 xstrndup(value, wordlen));
1686 value += wordlen + (value[wordlen] != '\0');
1690 return 0;
1693 static int add_remote_or_group(const char *name, struct string_list *list)
1695 int prev_nr = list->nr;
1696 struct remote_group_data g;
1697 g.name = name; g.list = list;
1699 git_config(get_remote_group, &g);
1700 if (list->nr == prev_nr) {
1701 struct remote *remote = remote_get(name);
1702 if (!remote_is_configured(remote, 0))
1703 return 0;
1704 string_list_append(list, remote->name);
1706 return 1;
1709 static void add_options_to_argv(struct strvec *argv)
1711 if (dry_run)
1712 strvec_push(argv, "--dry-run");
1713 if (prune != -1)
1714 strvec_push(argv, prune ? "--prune" : "--no-prune");
1715 if (prune_tags != -1)
1716 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1717 if (update_head_ok)
1718 strvec_push(argv, "--update-head-ok");
1719 if (force)
1720 strvec_push(argv, "--force");
1721 if (keep)
1722 strvec_push(argv, "--keep");
1723 if (recurse_submodules == RECURSE_SUBMODULES_ON)
1724 strvec_push(argv, "--recurse-submodules");
1725 else if (recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1726 strvec_push(argv, "--recurse-submodules=on-demand");
1727 if (tags == TAGS_SET)
1728 strvec_push(argv, "--tags");
1729 else if (tags == TAGS_UNSET)
1730 strvec_push(argv, "--no-tags");
1731 if (verbosity >= 2)
1732 strvec_push(argv, "-v");
1733 if (verbosity >= 1)
1734 strvec_push(argv, "-v");
1735 else if (verbosity < 0)
1736 strvec_push(argv, "-q");
1737 if (family == TRANSPORT_FAMILY_IPV4)
1738 strvec_push(argv, "--ipv4");
1739 else if (family == TRANSPORT_FAMILY_IPV6)
1740 strvec_push(argv, "--ipv6");
1743 /* Fetch multiple remotes in parallel */
1745 struct parallel_fetch_state {
1746 const char **argv;
1747 struct string_list *remotes;
1748 int next, result;
1751 static int fetch_next_remote(struct child_process *cp, struct strbuf *out,
1752 void *cb, void **task_cb)
1754 struct parallel_fetch_state *state = cb;
1755 char *remote;
1757 if (state->next < 0 || state->next >= state->remotes->nr)
1758 return 0;
1760 remote = state->remotes->items[state->next++].string;
1761 *task_cb = remote;
1763 strvec_pushv(&cp->args, state->argv);
1764 strvec_push(&cp->args, remote);
1765 cp->git_cmd = 1;
1767 if (verbosity >= 0)
1768 printf(_("Fetching %s\n"), remote);
1770 return 1;
1773 static int fetch_failed_to_start(struct strbuf *out, void *cb, void *task_cb)
1775 struct parallel_fetch_state *state = cb;
1776 const char *remote = task_cb;
1778 state->result = error(_("Could not fetch %s"), remote);
1780 return 0;
1783 static int fetch_finished(int result, struct strbuf *out,
1784 void *cb, void *task_cb)
1786 struct parallel_fetch_state *state = cb;
1787 const char *remote = task_cb;
1789 if (result) {
1790 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1791 remote, result);
1792 state->result = -1;
1795 return 0;
1798 static int fetch_multiple(struct string_list *list, int max_children)
1800 int i, result = 0;
1801 struct strvec argv = STRVEC_INIT;
1803 if (!append && write_fetch_head) {
1804 int errcode = truncate_fetch_head();
1805 if (errcode)
1806 return errcode;
1809 strvec_pushl(&argv, "fetch", "--append", "--no-auto-gc",
1810 "--no-write-commit-graph", NULL);
1811 add_options_to_argv(&argv);
1813 if (max_children != 1 && list->nr != 1) {
1814 struct parallel_fetch_state state = { argv.v, list, 0, 0 };
1816 strvec_push(&argv, "--end-of-options");
1817 result = run_processes_parallel_tr2(max_children,
1818 &fetch_next_remote,
1819 &fetch_failed_to_start,
1820 &fetch_finished,
1821 &state,
1822 "fetch", "parallel/fetch");
1824 if (!result)
1825 result = state.result;
1826 } else
1827 for (i = 0; i < list->nr; i++) {
1828 const char *name = list->items[i].string;
1829 strvec_push(&argv, name);
1830 if (verbosity >= 0)
1831 printf(_("Fetching %s\n"), name);
1832 if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
1833 error(_("Could not fetch %s"), name);
1834 result = 1;
1836 strvec_pop(&argv);
1839 strvec_clear(&argv);
1840 return !!result;
1844 * Fetching from the promisor remote should use the given filter-spec
1845 * or inherit the default filter-spec from the config.
1847 static inline void fetch_one_setup_partial(struct remote *remote)
1850 * Explicit --no-filter argument overrides everything, regardless
1851 * of any prior partial clones and fetches.
1853 if (filter_options.no_filter)
1854 return;
1857 * If no prior partial clone/fetch and the current fetch DID NOT
1858 * request a partial-fetch, do a normal fetch.
1860 if (!has_promisor_remote() && !filter_options.choice)
1861 return;
1864 * If this is a partial-fetch request, we enable partial on
1865 * this repo if not already enabled and remember the given
1866 * filter-spec as the default for subsequent fetches to this
1867 * remote if there is currently no default filter-spec.
1869 if (filter_options.choice) {
1870 partial_clone_register(remote->name, &filter_options);
1871 return;
1875 * Do a partial-fetch from the promisor remote using either the
1876 * explicitly given filter-spec or inherit the filter-spec from
1877 * the config.
1879 if (!filter_options.choice)
1880 partial_clone_get_default_filter_spec(&filter_options, remote->name);
1881 return;
1884 static int fetch_one(struct remote *remote, int argc, const char **argv,
1885 int prune_tags_ok, int use_stdin_refspecs)
1887 struct refspec rs = REFSPEC_INIT_FETCH;
1888 int i;
1889 int exit_code;
1890 int maybe_prune_tags;
1891 int remote_via_config = remote_is_configured(remote, 0);
1893 if (!remote)
1894 die(_("No remote repository specified. Please, specify either a URL or a\n"
1895 "remote name from which new revisions should be fetched."));
1897 gtransport = prepare_transport(remote, 1);
1899 if (prune < 0) {
1900 /* no command line request */
1901 if (0 <= remote->prune)
1902 prune = remote->prune;
1903 else if (0 <= fetch_prune_config)
1904 prune = fetch_prune_config;
1905 else
1906 prune = PRUNE_BY_DEFAULT;
1909 if (prune_tags < 0) {
1910 /* no command line request */
1911 if (0 <= remote->prune_tags)
1912 prune_tags = remote->prune_tags;
1913 else if (0 <= fetch_prune_tags_config)
1914 prune_tags = fetch_prune_tags_config;
1915 else
1916 prune_tags = PRUNE_TAGS_BY_DEFAULT;
1919 maybe_prune_tags = prune_tags_ok && prune_tags;
1920 if (maybe_prune_tags && remote_via_config)
1921 refspec_append(&remote->fetch, TAG_REFSPEC);
1923 if (maybe_prune_tags && (argc || !remote_via_config))
1924 refspec_append(&rs, TAG_REFSPEC);
1926 for (i = 0; i < argc; i++) {
1927 if (!strcmp(argv[i], "tag")) {
1928 i++;
1929 if (i >= argc)
1930 die(_("You need to specify a tag name."));
1932 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
1933 argv[i], argv[i]);
1934 } else {
1935 refspec_append(&rs, argv[i]);
1939 if (use_stdin_refspecs) {
1940 struct strbuf line = STRBUF_INIT;
1941 while (strbuf_getline_lf(&line, stdin) != EOF)
1942 refspec_append(&rs, line.buf);
1943 strbuf_release(&line);
1946 if (server_options.nr)
1947 gtransport->server_options = &server_options;
1949 sigchain_push_common(unlock_pack_on_signal);
1950 atexit(unlock_pack);
1951 sigchain_push(SIGPIPE, SIG_IGN);
1952 exit_code = do_fetch(gtransport, &rs);
1953 sigchain_pop(SIGPIPE);
1954 refspec_clear(&rs);
1955 transport_disconnect(gtransport);
1956 gtransport = NULL;
1957 return exit_code;
1960 int cmd_fetch(int argc, const char **argv, const char *prefix)
1962 int i;
1963 struct string_list list = STRING_LIST_INIT_DUP;
1964 struct remote *remote = NULL;
1965 int result = 0;
1966 int prune_tags_ok = 1;
1968 packet_trace_identity("fetch");
1970 /* Record the command line for the reflog */
1971 strbuf_addstr(&default_rla, "fetch");
1972 for (i = 1; i < argc; i++) {
1973 /* This handles non-URLs gracefully */
1974 char *anon = transport_anonymize_url(argv[i]);
1976 strbuf_addf(&default_rla, " %s", anon);
1977 free(anon);
1980 git_config(git_fetch_config, NULL);
1982 argc = parse_options(argc, argv, prefix,
1983 builtin_fetch_options, builtin_fetch_usage, 0);
1984 if (recurse_submodules != RECURSE_SUBMODULES_OFF) {
1985 int *sfjc = submodule_fetch_jobs_config == -1
1986 ? &submodule_fetch_jobs_config : NULL;
1987 int *rs = recurse_submodules == RECURSE_SUBMODULES_DEFAULT
1988 ? &recurse_submodules : NULL;
1990 fetch_config_from_gitmodules(sfjc, rs);
1993 if (negotiate_only && !negotiation_tip.nr)
1994 die(_("--negotiate-only needs one or more --negotiate-tip=*"));
1996 if (deepen_relative) {
1997 if (deepen_relative < 0)
1998 die(_("Negative depth in --deepen is not supported"));
1999 if (depth)
2000 die(_("--deepen and --depth are mutually exclusive"));
2001 depth = xstrfmt("%d", deepen_relative);
2003 if (unshallow) {
2004 if (depth)
2005 die(_("--depth and --unshallow cannot be used together"));
2006 else if (!is_repository_shallow(the_repository))
2007 die(_("--unshallow on a complete repository does not make sense"));
2008 else
2009 depth = xstrfmt("%d", INFINITE_DEPTH);
2012 /* no need to be strict, transport_set_option() will validate it again */
2013 if (depth && atoi(depth) < 1)
2014 die(_("depth %s is not a positive number"), depth);
2015 if (depth || deepen_since || deepen_not.nr)
2016 deepen = 1;
2018 /* FETCH_HEAD never gets updated in --dry-run mode */
2019 if (dry_run)
2020 write_fetch_head = 0;
2022 if (all) {
2023 if (argc == 1)
2024 die(_("fetch --all does not take a repository argument"));
2025 else if (argc > 1)
2026 die(_("fetch --all does not make sense with refspecs"));
2027 (void) for_each_remote(get_one_remote_for_fetch, &list);
2028 } else if (argc == 0) {
2029 /* No arguments -- use default remote */
2030 remote = remote_get(NULL);
2031 } else if (multiple) {
2032 /* All arguments are assumed to be remotes or groups */
2033 for (i = 0; i < argc; i++)
2034 if (!add_remote_or_group(argv[i], &list))
2035 die(_("No such remote or remote group: %s"), argv[i]);
2036 } else {
2037 /* Single remote or group */
2038 (void) add_remote_or_group(argv[0], &list);
2039 if (list.nr > 1) {
2040 /* More than one remote */
2041 if (argc > 1)
2042 die(_("Fetching a group and specifying refspecs does not make sense"));
2043 } else {
2044 /* Zero or one remotes */
2045 remote = remote_get(argv[0]);
2046 prune_tags_ok = (argc == 1);
2047 argc--;
2048 argv++;
2052 if (negotiate_only) {
2053 struct oidset acked_commits = OIDSET_INIT;
2054 struct oidset_iter iter;
2055 const struct object_id *oid;
2057 if (!remote)
2058 die(_("must supply remote when using --negotiate-only"));
2059 gtransport = prepare_transport(remote, 1);
2060 if (gtransport->smart_options) {
2061 gtransport->smart_options->acked_commits = &acked_commits;
2062 } else {
2063 warning(_("Protocol does not support --negotiate-only, exiting."));
2064 return 1;
2066 if (server_options.nr)
2067 gtransport->server_options = &server_options;
2068 result = transport_fetch_refs(gtransport, NULL);
2070 oidset_iter_init(&acked_commits, &iter);
2071 while ((oid = oidset_iter_next(&iter)))
2072 printf("%s\n", oid_to_hex(oid));
2073 oidset_clear(&acked_commits);
2074 } else if (remote) {
2075 if (filter_options.choice || has_promisor_remote())
2076 fetch_one_setup_partial(remote);
2077 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs);
2078 } else {
2079 int max_children = max_jobs;
2081 if (filter_options.choice)
2082 die(_("--filter can only be used with the remote "
2083 "configured in extensions.partialclone"));
2085 if (atomic_fetch)
2086 die(_("--atomic can only be used when fetching "
2087 "from one remote"));
2089 if (stdin_refspecs)
2090 die(_("--stdin can only be used when fetching "
2091 "from one remote"));
2093 if (max_children < 0)
2094 max_children = fetch_parallel_config;
2096 /* TODO should this also die if we have a previous partial-clone? */
2097 result = fetch_multiple(&list, max_children);
2100 if (!result && (recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2101 struct strvec options = STRVEC_INIT;
2102 int max_children = max_jobs;
2104 if (max_children < 0)
2105 max_children = submodule_fetch_jobs_config;
2106 if (max_children < 0)
2107 max_children = fetch_parallel_config;
2109 add_options_to_argv(&options);
2110 result = fetch_populated_submodules(the_repository,
2111 &options,
2112 submodule_prefix,
2113 recurse_submodules,
2114 recurse_submodules_default,
2115 verbosity < 0,
2116 max_children);
2117 strvec_clear(&options);
2120 string_list_clear(&list, 0);
2122 prepare_repo_settings(the_repository);
2123 if (fetch_write_commit_graph > 0 ||
2124 (fetch_write_commit_graph < 0 &&
2125 the_repository->settings.fetch_write_commit_graph)) {
2126 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2128 if (progress)
2129 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2131 write_commit_graph_reachable(the_repository->objects->odb,
2132 commit_graph_flags,
2133 NULL);
2136 close_object_store(the_repository->objects);
2138 if (enable_auto_gc)
2139 run_auto_maintenance(verbosity < 0);
2141 return result;