fetch: avoid reading submodule config until needed
[git.git] / builtin / fetch.c
blobecd041ee046fe14f7f2218cf56e3fbe54f35158a
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 prune = -1; /* unspecified */
52 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
54 static int fetch_prune_tags_config = -1; /* unspecified */
55 static int prune_tags = -1; /* unspecified */
56 #define PRUNE_TAGS_BY_DEFAULT 0 /* do we prune tags by default? */
58 static int all, append, dry_run, force, keep, multiple, update_head_ok;
59 static int write_fetch_head = 1;
60 static int verbosity, deepen_relative, set_upstream;
61 static int progress = -1;
62 static int enable_auto_gc = 1;
63 static int tags = TAGS_DEFAULT, unshallow, update_shallow, deepen;
64 static int max_jobs = -1, submodule_fetch_jobs_config = -1;
65 static int fetch_parallel_config = 1;
66 static enum transport_family family;
67 static const char *depth;
68 static const char *deepen_since;
69 static const char *upload_pack;
70 static struct string_list deepen_not = STRING_LIST_INIT_NODUP;
71 static struct strbuf default_rla = STRBUF_INIT;
72 static struct transport *gtransport;
73 static struct transport *gsecondary;
74 static const char *submodule_prefix = "";
75 static int recurse_submodules = RECURSE_SUBMODULES_DEFAULT;
76 static int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
77 static int shown_url = 0;
78 static struct refspec refmap = REFSPEC_INIT_FETCH;
79 static struct list_objects_filter_options filter_options;
80 static struct string_list server_options = STRING_LIST_INIT_DUP;
81 static struct string_list negotiation_tip = STRING_LIST_INIT_NODUP;
82 static int fetch_write_commit_graph = -1;
83 static int stdin_refspecs = 0;
85 static int git_fetch_config(const char *k, const char *v, void *cb)
87 if (!strcmp(k, "fetch.prune")) {
88 fetch_prune_config = git_config_bool(k, v);
89 return 0;
92 if (!strcmp(k, "fetch.prunetags")) {
93 fetch_prune_tags_config = git_config_bool(k, v);
94 return 0;
97 if (!strcmp(k, "fetch.showforcedupdates")) {
98 fetch_show_forced_updates = git_config_bool(k, v);
99 return 0;
102 if (!strcmp(k, "submodule.recurse")) {
103 int r = git_config_bool(k, v) ?
104 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
105 recurse_submodules = r;
108 if (!strcmp(k, "submodule.fetchjobs")) {
109 submodule_fetch_jobs_config = parse_submodule_fetchjobs(k, v);
110 return 0;
111 } else if (!strcmp(k, "fetch.recursesubmodules")) {
112 recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
113 return 0;
116 if (!strcmp(k, "fetch.parallel")) {
117 fetch_parallel_config = git_config_int(k, v);
118 if (fetch_parallel_config < 0)
119 die(_("fetch.parallel cannot be negative"));
120 return 0;
123 return git_default_config(k, v, cb);
126 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
128 BUG_ON_OPT_NEG(unset);
131 * "git fetch --refmap='' origin foo"
132 * can be used to tell the command not to store anywhere
134 refspec_append(&refmap, arg);
136 return 0;
139 static struct option builtin_fetch_options[] = {
140 OPT__VERBOSITY(&verbosity),
141 OPT_BOOL(0, "all", &all,
142 N_("fetch from all remotes")),
143 OPT_BOOL(0, "set-upstream", &set_upstream,
144 N_("set upstream for git pull/fetch")),
145 OPT_BOOL('a', "append", &append,
146 N_("append to .git/FETCH_HEAD instead of overwriting")),
147 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
148 N_("path to upload pack on remote end")),
149 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
150 OPT_BOOL('m', "multiple", &multiple,
151 N_("fetch from multiple remotes")),
152 OPT_SET_INT('t', "tags", &tags,
153 N_("fetch all tags and associated objects"), TAGS_SET),
154 OPT_SET_INT('n', NULL, &tags,
155 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
156 OPT_INTEGER('j', "jobs", &max_jobs,
157 N_("number of submodules fetched in parallel")),
158 OPT_BOOL('p', "prune", &prune,
159 N_("prune remote-tracking branches no longer on remote")),
160 OPT_BOOL('P', "prune-tags", &prune_tags,
161 N_("prune local tags no longer on remote and clobber changed tags")),
162 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules, N_("on-demand"),
163 N_("control recursive fetching of submodules"),
164 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
165 OPT_BOOL(0, "dry-run", &dry_run,
166 N_("dry run")),
167 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
168 N_("write fetched references to the FETCH_HEAD file")),
169 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
170 OPT_BOOL('u', "update-head-ok", &update_head_ok,
171 N_("allow updating of HEAD ref")),
172 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
173 OPT_STRING(0, "depth", &depth, N_("depth"),
174 N_("deepen history of shallow clone")),
175 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
176 N_("deepen history of shallow repository based on time")),
177 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
178 N_("deepen history of shallow clone, excluding rev")),
179 OPT_INTEGER(0, "deepen", &deepen_relative,
180 N_("deepen history of shallow clone")),
181 OPT_SET_INT_F(0, "unshallow", &unshallow,
182 N_("convert to a complete repository"),
183 1, PARSE_OPT_NONEG),
184 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
185 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
186 OPT_CALLBACK_F(0, "recurse-submodules-default",
187 &recurse_submodules_default, N_("on-demand"),
188 N_("default for recursive fetching of submodules "
189 "(lower priority than config files)"),
190 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
191 OPT_BOOL(0, "update-shallow", &update_shallow,
192 N_("accept refs that update .git/shallow")),
193 OPT_CALLBACK_F(0, "refmap", NULL, N_("refmap"),
194 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
195 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
196 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
197 TRANSPORT_FAMILY_IPV4),
198 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
199 TRANSPORT_FAMILY_IPV6),
200 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
201 N_("report that we have only objects reachable from this object")),
202 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
203 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
204 N_("run 'gc --auto' after fetching")),
205 OPT_BOOL(0, "show-forced-updates", &fetch_show_forced_updates,
206 N_("check for forced-updates on all updated branches")),
207 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
208 N_("write the commit-graph after fetching")),
209 OPT_BOOL(0, "stdin", &stdin_refspecs,
210 N_("accept refspecs from stdin")),
211 OPT_END()
214 static void unlock_pack(void)
216 if (gtransport)
217 transport_unlock_pack(gtransport);
218 if (gsecondary)
219 transport_unlock_pack(gsecondary);
222 static void unlock_pack_on_signal(int signo)
224 unlock_pack();
225 sigchain_pop(signo);
226 raise(signo);
229 static void add_merge_config(struct ref **head,
230 const struct ref *remote_refs,
231 struct branch *branch,
232 struct ref ***tail)
234 int i;
236 for (i = 0; i < branch->merge_nr; i++) {
237 struct ref *rm, **old_tail = *tail;
238 struct refspec_item refspec;
240 for (rm = *head; rm; rm = rm->next) {
241 if (branch_merge_matches(branch, i, rm->name)) {
242 rm->fetch_head_status = FETCH_HEAD_MERGE;
243 break;
246 if (rm)
247 continue;
250 * Not fetched to a remote-tracking branch? We need to fetch
251 * it anyway to allow this branch's "branch.$name.merge"
252 * to be honored by 'git pull', but we do not have to
253 * fail if branch.$name.merge is misconfigured to point
254 * at a nonexisting branch. If we were indeed called by
255 * 'git pull', it will notice the misconfiguration because
256 * there is no entry in the resulting FETCH_HEAD marked
257 * for merging.
259 memset(&refspec, 0, sizeof(refspec));
260 refspec.src = branch->merge[i]->src;
261 get_fetch_map(remote_refs, &refspec, tail, 1);
262 for (rm = *old_tail; rm; rm = rm->next)
263 rm->fetch_head_status = FETCH_HEAD_MERGE;
267 static void create_fetch_oidset(struct ref **head, struct oidset *out)
269 struct ref *rm = *head;
270 while (rm) {
271 oidset_insert(out, &rm->old_oid);
272 rm = rm->next;
276 struct refname_hash_entry {
277 struct hashmap_entry ent;
278 struct object_id oid;
279 int ignore;
280 char refname[FLEX_ARRAY];
283 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data,
284 const struct hashmap_entry *eptr,
285 const struct hashmap_entry *entry_or_key,
286 const void *keydata)
288 const struct refname_hash_entry *e1, *e2;
290 e1 = container_of(eptr, const struct refname_hash_entry, ent);
291 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
292 return strcmp(e1->refname, keydata ? keydata : e2->refname);
295 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
296 const char *refname,
297 const struct object_id *oid)
299 struct refname_hash_entry *ent;
300 size_t len = strlen(refname);
302 FLEX_ALLOC_MEM(ent, refname, refname, len);
303 hashmap_entry_init(&ent->ent, strhash(refname));
304 oidcpy(&ent->oid, oid);
305 hashmap_add(map, &ent->ent);
306 return ent;
309 static int add_one_refname(const char *refname,
310 const struct object_id *oid,
311 int flag, void *cbdata)
313 struct hashmap *refname_map = cbdata;
315 (void) refname_hash_add(refname_map, refname, oid);
316 return 0;
319 static void refname_hash_init(struct hashmap *map)
321 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
324 static int refname_hash_exists(struct hashmap *map, const char *refname)
326 return !!hashmap_get_from_hash(map, strhash(refname), refname);
329 static void clear_item(struct refname_hash_entry *item)
331 item->ignore = 1;
334 static void find_non_local_tags(const struct ref *refs,
335 struct ref **head,
336 struct ref ***tail)
338 struct hashmap existing_refs;
339 struct hashmap remote_refs;
340 struct oidset fetch_oids = OIDSET_INIT;
341 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
342 struct string_list_item *remote_ref_item;
343 const struct ref *ref;
344 struct refname_hash_entry *item = NULL;
345 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
347 refname_hash_init(&existing_refs);
348 refname_hash_init(&remote_refs);
349 create_fetch_oidset(head, &fetch_oids);
351 for_each_ref(add_one_refname, &existing_refs);
352 for (ref = refs; ref; ref = ref->next) {
353 if (!starts_with(ref->name, "refs/tags/"))
354 continue;
357 * The peeled ref always follows the matching base
358 * ref, so if we see a peeled ref that we don't want
359 * to fetch then we can mark the ref entry in the list
360 * as one to ignore by setting util to NULL.
362 if (ends_with(ref->name, "^{}")) {
363 if (item &&
364 !has_object_file_with_flags(&ref->old_oid, quick_flags) &&
365 !oidset_contains(&fetch_oids, &ref->old_oid) &&
366 !has_object_file_with_flags(&item->oid, quick_flags) &&
367 !oidset_contains(&fetch_oids, &item->oid))
368 clear_item(item);
369 item = NULL;
370 continue;
374 * If item is non-NULL here, then we previously saw a
375 * ref not followed by a peeled reference, so we need
376 * to check if it is a lightweight tag that we want to
377 * fetch.
379 if (item &&
380 !has_object_file_with_flags(&item->oid, quick_flags) &&
381 !oidset_contains(&fetch_oids, &item->oid))
382 clear_item(item);
384 item = NULL;
386 /* skip duplicates and refs that we already have */
387 if (refname_hash_exists(&remote_refs, ref->name) ||
388 refname_hash_exists(&existing_refs, ref->name))
389 continue;
391 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
392 string_list_insert(&remote_refs_list, ref->name);
394 hashmap_free_entries(&existing_refs, struct refname_hash_entry, ent);
397 * We may have a final lightweight tag that needs to be
398 * checked to see if it needs fetching.
400 if (item &&
401 !has_object_file_with_flags(&item->oid, quick_flags) &&
402 !oidset_contains(&fetch_oids, &item->oid))
403 clear_item(item);
406 * For all the tags in the remote_refs_list,
407 * add them to the list of refs to be fetched
409 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
410 const char *refname = remote_ref_item->string;
411 struct ref *rm;
412 unsigned int hash = strhash(refname);
414 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
415 struct refname_hash_entry, ent);
416 if (!item)
417 BUG("unseen remote ref?");
419 /* Unless we have already decided to ignore this item... */
420 if (item->ignore)
421 continue;
423 rm = alloc_ref(item->refname);
424 rm->peer_ref = alloc_ref(item->refname);
425 oidcpy(&rm->old_oid, &item->oid);
426 **tail = rm;
427 *tail = &rm->next;
429 hashmap_free_entries(&remote_refs, struct refname_hash_entry, ent);
430 string_list_clear(&remote_refs_list, 0);
431 oidset_clear(&fetch_oids);
434 static struct ref *get_ref_map(struct remote *remote,
435 const struct ref *remote_refs,
436 struct refspec *rs,
437 int tags, int *autotags)
439 int i;
440 struct ref *rm;
441 struct ref *ref_map = NULL;
442 struct ref **tail = &ref_map;
444 /* opportunistically-updated references: */
445 struct ref *orefs = NULL, **oref_tail = &orefs;
447 struct hashmap existing_refs;
449 if (rs->nr) {
450 struct refspec *fetch_refspec;
452 for (i = 0; i < rs->nr; i++) {
453 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
454 if (rs->items[i].dst && rs->items[i].dst[0])
455 *autotags = 1;
457 /* Merge everything on the command line (but not --tags) */
458 for (rm = ref_map; rm; rm = rm->next)
459 rm->fetch_head_status = FETCH_HEAD_MERGE;
462 * For any refs that we happen to be fetching via
463 * command-line arguments, the destination ref might
464 * have been missing or have been different than the
465 * remote-tracking ref that would be derived from the
466 * configured refspec. In these cases, we want to
467 * take the opportunity to update their configured
468 * remote-tracking reference. However, we do not want
469 * to mention these entries in FETCH_HEAD at all, as
470 * they would simply be duplicates of existing
471 * entries, so we set them FETCH_HEAD_IGNORE below.
473 * We compute these entries now, based only on the
474 * refspecs specified on the command line. But we add
475 * them to the list following the refspecs resulting
476 * from the tags option so that one of the latter,
477 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
478 * by ref_remove_duplicates() in favor of one of these
479 * opportunistic entries with FETCH_HEAD_IGNORE.
481 if (refmap.nr)
482 fetch_refspec = &refmap;
483 else
484 fetch_refspec = &remote->fetch;
486 for (i = 0; i < fetch_refspec->nr; i++)
487 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
488 } else if (refmap.nr) {
489 die("--refmap option is only meaningful with command-line refspec(s).");
490 } else {
491 /* Use the defaults */
492 struct branch *branch = branch_get(NULL);
493 int has_merge = branch_has_merge_config(branch);
494 if (remote &&
495 (remote->fetch.nr ||
496 /* Note: has_merge implies non-NULL branch->remote_name */
497 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
498 for (i = 0; i < remote->fetch.nr; i++) {
499 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
500 if (remote->fetch.items[i].dst &&
501 remote->fetch.items[i].dst[0])
502 *autotags = 1;
503 if (!i && !has_merge && ref_map &&
504 !remote->fetch.items[0].pattern)
505 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
508 * if the remote we're fetching from is the same
509 * as given in branch.<name>.remote, we add the
510 * ref given in branch.<name>.merge, too.
512 * Note: has_merge implies non-NULL branch->remote_name
514 if (has_merge &&
515 !strcmp(branch->remote_name, remote->name))
516 add_merge_config(&ref_map, remote_refs, branch, &tail);
517 } else {
518 ref_map = get_remote_ref(remote_refs, "HEAD");
519 if (!ref_map)
520 die(_("Couldn't find remote ref HEAD"));
521 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
522 tail = &ref_map->next;
526 if (tags == TAGS_SET)
527 /* also fetch all tags */
528 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
529 else if (tags == TAGS_DEFAULT && *autotags)
530 find_non_local_tags(remote_refs, &ref_map, &tail);
532 /* Now append any refs to be updated opportunistically: */
533 *tail = orefs;
534 for (rm = orefs; rm; rm = rm->next) {
535 rm->fetch_head_status = FETCH_HEAD_IGNORE;
536 tail = &rm->next;
539 ref_map = ref_remove_duplicates(ref_map);
541 refname_hash_init(&existing_refs);
542 for_each_ref(add_one_refname, &existing_refs);
544 for (rm = ref_map; rm; rm = rm->next) {
545 if (rm->peer_ref) {
546 const char *refname = rm->peer_ref->name;
547 struct refname_hash_entry *peer_item;
548 unsigned int hash = strhash(refname);
550 peer_item = hashmap_get_entry_from_hash(&existing_refs,
551 hash, refname,
552 struct refname_hash_entry, ent);
553 if (peer_item) {
554 struct object_id *old_oid = &peer_item->oid;
555 oidcpy(&rm->peer_ref->old_oid, old_oid);
559 hashmap_free_entries(&existing_refs, struct refname_hash_entry, ent);
561 return ref_map;
564 #define STORE_REF_ERROR_OTHER 1
565 #define STORE_REF_ERROR_DF_CONFLICT 2
567 static int s_update_ref(const char *action,
568 struct ref *ref,
569 int check_old)
571 char *msg;
572 char *rla = getenv("GIT_REFLOG_ACTION");
573 struct ref_transaction *transaction;
574 struct strbuf err = STRBUF_INIT;
575 int ret, df_conflict = 0;
577 if (dry_run)
578 return 0;
579 if (!rla)
580 rla = default_rla.buf;
581 msg = xstrfmt("%s: %s", rla, action);
583 transaction = ref_transaction_begin(&err);
584 if (!transaction ||
585 ref_transaction_update(transaction, ref->name,
586 &ref->new_oid,
587 check_old ? &ref->old_oid : NULL,
588 0, msg, &err))
589 goto fail;
591 ret = ref_transaction_commit(transaction, &err);
592 if (ret) {
593 df_conflict = (ret == TRANSACTION_NAME_CONFLICT);
594 goto fail;
597 ref_transaction_free(transaction);
598 strbuf_release(&err);
599 free(msg);
600 return 0;
601 fail:
602 ref_transaction_free(transaction);
603 error("%s", err.buf);
604 strbuf_release(&err);
605 free(msg);
606 return df_conflict ? STORE_REF_ERROR_DF_CONFLICT
607 : STORE_REF_ERROR_OTHER;
610 static int refcol_width = 10;
611 static int compact_format;
613 static void adjust_refcol_width(const struct ref *ref)
615 int max, rlen, llen, len;
617 /* uptodate lines are only shown on high verbosity level */
618 if (!verbosity && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
619 return;
621 max = term_columns();
622 rlen = utf8_strwidth(prettify_refname(ref->name));
624 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
627 * rough estimation to see if the output line is too long and
628 * should not be counted (we can't do precise calculation
629 * anyway because we don't know if the error explanation part
630 * will be printed in update_local_ref)
632 if (compact_format) {
633 llen = 0;
634 max = max * 2 / 3;
636 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
637 if (len >= max)
638 return;
641 * Not precise calculation for compact mode because '*' can
642 * appear on the left hand side of '->' and shrink the column
643 * back.
645 if (refcol_width < rlen)
646 refcol_width = rlen;
649 static void prepare_format_display(struct ref *ref_map)
651 struct ref *rm;
652 const char *format = "full";
654 git_config_get_string_const("fetch.output", &format);
655 if (!strcasecmp(format, "full"))
656 compact_format = 0;
657 else if (!strcasecmp(format, "compact"))
658 compact_format = 1;
659 else
660 die(_("configuration fetch.output contains invalid value %s"),
661 format);
663 for (rm = ref_map; rm; rm = rm->next) {
664 if (rm->status == REF_STATUS_REJECT_SHALLOW ||
665 !rm->peer_ref ||
666 !strcmp(rm->name, "HEAD"))
667 continue;
669 adjust_refcol_width(rm);
673 static void print_remote_to_local(struct strbuf *display,
674 const char *remote, const char *local)
676 strbuf_addf(display, "%-*s -> %s", refcol_width, remote, local);
679 static int find_and_replace(struct strbuf *haystack,
680 const char *needle,
681 const char *placeholder)
683 const char *p = NULL;
684 int plen, nlen;
686 nlen = strlen(needle);
687 if (ends_with(haystack->buf, needle))
688 p = haystack->buf + haystack->len - nlen;
689 else
690 p = strstr(haystack->buf, needle);
691 if (!p)
692 return 0;
694 if (p > haystack->buf && p[-1] != '/')
695 return 0;
697 plen = strlen(p);
698 if (plen > nlen && p[nlen] != '/')
699 return 0;
701 strbuf_splice(haystack, p - haystack->buf, nlen,
702 placeholder, strlen(placeholder));
703 return 1;
706 static void print_compact(struct strbuf *display,
707 const char *remote, const char *local)
709 struct strbuf r = STRBUF_INIT;
710 struct strbuf l = STRBUF_INIT;
712 if (!strcmp(remote, local)) {
713 strbuf_addf(display, "%-*s -> *", refcol_width, remote);
714 return;
717 strbuf_addstr(&r, remote);
718 strbuf_addstr(&l, local);
720 if (!find_and_replace(&r, local, "*"))
721 find_and_replace(&l, remote, "*");
722 print_remote_to_local(display, r.buf, l.buf);
724 strbuf_release(&r);
725 strbuf_release(&l);
728 static void format_display(struct strbuf *display, char code,
729 const char *summary, const char *error,
730 const char *remote, const char *local,
731 int summary_width)
733 int width = (summary_width + strlen(summary) - gettext_width(summary));
735 strbuf_addf(display, "%c %-*s ", code, width, summary);
736 if (!compact_format)
737 print_remote_to_local(display, remote, local);
738 else
739 print_compact(display, remote, local);
740 if (error)
741 strbuf_addf(display, " (%s)", error);
744 static int update_local_ref(struct ref *ref,
745 const char *remote,
746 const struct ref *remote_ref,
747 struct strbuf *display,
748 int summary_width)
750 struct commit *current = NULL, *updated;
751 enum object_type type;
752 struct branch *current_branch = branch_get(NULL);
753 const char *pretty_ref = prettify_refname(ref->name);
754 int fast_forward = 0;
756 type = oid_object_info(the_repository, &ref->new_oid, NULL);
757 if (type < 0)
758 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
760 if (oideq(&ref->old_oid, &ref->new_oid)) {
761 if (verbosity > 0)
762 format_display(display, '=', _("[up to date]"), NULL,
763 remote, pretty_ref, summary_width);
764 return 0;
767 if (current_branch &&
768 !strcmp(ref->name, current_branch->name) &&
769 !(update_head_ok || is_bare_repository()) &&
770 !is_null_oid(&ref->old_oid)) {
772 * If this is the head, and it's not okay to update
773 * the head, and the old value of the head isn't empty...
775 format_display(display, '!', _("[rejected]"),
776 _("can't fetch in current branch"),
777 remote, pretty_ref, summary_width);
778 return 1;
781 if (!is_null_oid(&ref->old_oid) &&
782 starts_with(ref->name, "refs/tags/")) {
783 if (force || ref->force) {
784 int r;
785 r = s_update_ref("updating tag", ref, 0);
786 format_display(display, r ? '!' : 't', _("[tag update]"),
787 r ? _("unable to update local ref") : NULL,
788 remote, pretty_ref, summary_width);
789 return r;
790 } else {
791 format_display(display, '!', _("[rejected]"), _("would clobber existing tag"),
792 remote, pretty_ref, summary_width);
793 return 1;
797 current = lookup_commit_reference_gently(the_repository,
798 &ref->old_oid, 1);
799 updated = lookup_commit_reference_gently(the_repository,
800 &ref->new_oid, 1);
801 if (!current || !updated) {
802 const char *msg;
803 const char *what;
804 int r;
806 * Nicely describe the new ref we're fetching.
807 * Base this on the remote's ref name, as it's
808 * more likely to follow a standard layout.
810 const char *name = remote_ref ? remote_ref->name : "";
811 if (starts_with(name, "refs/tags/")) {
812 msg = "storing tag";
813 what = _("[new tag]");
814 } else if (starts_with(name, "refs/heads/")) {
815 msg = "storing head";
816 what = _("[new branch]");
817 } else {
818 msg = "storing ref";
819 what = _("[new ref]");
822 r = s_update_ref(msg, ref, 0);
823 format_display(display, r ? '!' : '*', what,
824 r ? _("unable to update local ref") : NULL,
825 remote, pretty_ref, summary_width);
826 return r;
829 if (fetch_show_forced_updates) {
830 uint64_t t_before = getnanotime();
831 fast_forward = in_merge_bases(current, updated);
832 forced_updates_ms += (getnanotime() - t_before) / 1000000;
833 } else {
834 fast_forward = 1;
837 if (fast_forward) {
838 struct strbuf quickref = STRBUF_INIT;
839 int r;
841 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
842 strbuf_addstr(&quickref, "..");
843 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
844 r = s_update_ref("fast-forward", ref, 1);
845 format_display(display, r ? '!' : ' ', quickref.buf,
846 r ? _("unable to update local ref") : NULL,
847 remote, pretty_ref, summary_width);
848 strbuf_release(&quickref);
849 return r;
850 } else if (force || ref->force) {
851 struct strbuf quickref = STRBUF_INIT;
852 int r;
853 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
854 strbuf_addstr(&quickref, "...");
855 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
856 r = s_update_ref("forced-update", ref, 1);
857 format_display(display, r ? '!' : '+', quickref.buf,
858 r ? _("unable to update local ref") : _("forced update"),
859 remote, pretty_ref, summary_width);
860 strbuf_release(&quickref);
861 return r;
862 } else {
863 format_display(display, '!', _("[rejected]"), _("non-fast-forward"),
864 remote, pretty_ref, summary_width);
865 return 1;
869 static int iterate_ref_map(void *cb_data, struct object_id *oid)
871 struct ref **rm = cb_data;
872 struct ref *ref = *rm;
874 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
875 ref = ref->next;
876 if (!ref)
877 return -1; /* end of the list */
878 *rm = ref->next;
879 oidcpy(oid, &ref->old_oid);
880 return 0;
883 static const char warn_show_forced_updates[] =
884 N_("Fetch normally indicates which branches had a forced update,\n"
885 "but that check has been disabled. To re-enable, use '--show-forced-updates'\n"
886 "flag or run 'git config fetch.showForcedUpdates true'.");
887 static const char warn_time_show_forced_updates[] =
888 N_("It took %.2f seconds to check forced updates. You can use\n"
889 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
890 " to avoid this check.\n");
892 static int store_updated_refs(const char *raw_url, const char *remote_name,
893 int connectivity_checked, struct ref *ref_map)
895 FILE *fp;
896 struct commit *commit;
897 int url_len, i, rc = 0;
898 struct strbuf note = STRBUF_INIT;
899 const char *what, *kind;
900 struct ref *rm;
901 char *url;
902 const char *filename = (!write_fetch_head
903 ? "/dev/null"
904 : git_path_fetch_head(the_repository));
905 int want_status;
906 int summary_width = transport_summary_width(ref_map);
908 fp = fopen(filename, "a");
909 if (!fp)
910 return error_errno(_("cannot open %s"), filename);
912 if (raw_url)
913 url = transport_anonymize_url(raw_url);
914 else
915 url = xstrdup("foreign");
917 if (!connectivity_checked) {
918 struct check_connected_options opt = CHECK_CONNECTED_INIT;
920 rm = ref_map;
921 if (check_connected(iterate_ref_map, &rm, &opt)) {
922 rc = error(_("%s did not send all necessary objects\n"), url);
923 goto abort;
927 prepare_format_display(ref_map);
930 * We do a pass for each fetch_head_status type in their enum order, so
931 * merged entries are written before not-for-merge. That lets readers
932 * use FETCH_HEAD as a refname to refer to the ref to be merged.
934 for (want_status = FETCH_HEAD_MERGE;
935 want_status <= FETCH_HEAD_IGNORE;
936 want_status++) {
937 for (rm = ref_map; rm; rm = rm->next) {
938 struct ref *ref = NULL;
939 const char *merge_status_marker = "";
941 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
942 if (want_status == FETCH_HEAD_MERGE)
943 warning(_("reject %s because shallow roots are not allowed to be updated"),
944 rm->peer_ref ? rm->peer_ref->name : rm->name);
945 continue;
948 commit = lookup_commit_reference_gently(the_repository,
949 &rm->old_oid,
951 if (!commit)
952 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
954 if (rm->fetch_head_status != want_status)
955 continue;
957 if (rm->peer_ref) {
958 ref = alloc_ref(rm->peer_ref->name);
959 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
960 oidcpy(&ref->new_oid, &rm->old_oid);
961 ref->force = rm->peer_ref->force;
964 if (recurse_submodules != RECURSE_SUBMODULES_OFF)
965 check_for_new_submodule_commits(&rm->old_oid);
967 if (!strcmp(rm->name, "HEAD")) {
968 kind = "";
969 what = "";
971 else if (skip_prefix(rm->name, "refs/heads/", &what))
972 kind = "branch";
973 else if (skip_prefix(rm->name, "refs/tags/", &what))
974 kind = "tag";
975 else if (skip_prefix(rm->name, "refs/remotes/", &what))
976 kind = "remote-tracking branch";
977 else {
978 kind = "";
979 what = rm->name;
982 url_len = strlen(url);
983 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
985 url_len = i + 1;
986 if (4 < i && !strncmp(".git", url + i - 3, 4))
987 url_len = i - 3;
989 strbuf_reset(&note);
990 if (*what) {
991 if (*kind)
992 strbuf_addf(&note, "%s ", kind);
993 strbuf_addf(&note, "'%s' of ", what);
995 switch (rm->fetch_head_status) {
996 case FETCH_HEAD_NOT_FOR_MERGE:
997 merge_status_marker = "not-for-merge";
998 /* fall-through */
999 case FETCH_HEAD_MERGE:
1000 fprintf(fp, "%s\t%s\t%s",
1001 oid_to_hex(&rm->old_oid),
1002 merge_status_marker,
1003 note.buf);
1004 for (i = 0; i < url_len; ++i)
1005 if ('\n' == url[i])
1006 fputs("\\n", fp);
1007 else
1008 fputc(url[i], fp);
1009 fputc('\n', fp);
1010 break;
1011 default:
1012 /* do not write anything to FETCH_HEAD */
1013 break;
1016 strbuf_reset(&note);
1017 if (ref) {
1018 rc |= update_local_ref(ref, what, rm, &note,
1019 summary_width);
1020 free(ref);
1021 } else
1022 format_display(&note, '*',
1023 *kind ? kind : "branch", NULL,
1024 *what ? what : "HEAD",
1025 "FETCH_HEAD", summary_width);
1026 if (note.len) {
1027 if (verbosity >= 0 && !shown_url) {
1028 fprintf(stderr, _("From %.*s\n"),
1029 url_len, url);
1030 shown_url = 1;
1032 if (verbosity >= 0)
1033 fprintf(stderr, " %s\n", note.buf);
1038 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1039 error(_("some local refs could not be updated; try running\n"
1040 " 'git remote prune %s' to remove any old, conflicting "
1041 "branches"), remote_name);
1043 if (advice_fetch_show_forced_updates) {
1044 if (!fetch_show_forced_updates) {
1045 warning(_(warn_show_forced_updates));
1046 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1047 warning(_(warn_time_show_forced_updates),
1048 forced_updates_ms / 1000.0);
1052 abort:
1053 strbuf_release(&note);
1054 free(url);
1055 fclose(fp);
1056 return rc;
1060 * We would want to bypass the object transfer altogether if
1061 * everything we are going to fetch already exists and is connected
1062 * locally.
1064 static int check_exist_and_connected(struct ref *ref_map)
1066 struct ref *rm = ref_map;
1067 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1068 struct ref *r;
1071 * If we are deepening a shallow clone we already have these
1072 * objects reachable. Running rev-list here will return with
1073 * a good (0) exit status and we'll bypass the fetch that we
1074 * really need to perform. Claiming failure now will ensure
1075 * we perform the network exchange to deepen our history.
1077 if (deepen)
1078 return -1;
1081 * check_connected() allows objects to merely be promised, but
1082 * we need all direct targets to exist.
1084 for (r = rm; r; r = r->next) {
1085 if (!has_object_file_with_flags(&r->old_oid,
1086 OBJECT_INFO_SKIP_FETCH_OBJECT))
1087 return -1;
1090 opt.quiet = 1;
1091 return check_connected(iterate_ref_map, &rm, &opt);
1094 static int fetch_refs(struct transport *transport, struct ref *ref_map)
1096 int ret = check_exist_and_connected(ref_map);
1097 if (ret) {
1098 trace2_region_enter("fetch", "fetch_refs", the_repository);
1099 ret = transport_fetch_refs(transport, ref_map);
1100 trace2_region_leave("fetch", "fetch_refs", the_repository);
1102 if (!ret)
1104 * Keep the new pack's ".keep" file around to allow the caller
1105 * time to update refs to reference the new objects.
1107 return 0;
1108 transport_unlock_pack(transport);
1109 return ret;
1112 /* Update local refs based on the ref values fetched from a remote */
1113 static int consume_refs(struct transport *transport, struct ref *ref_map)
1115 int connectivity_checked = transport->smart_options
1116 ? transport->smart_options->connectivity_checked : 0;
1117 int ret;
1118 trace2_region_enter("fetch", "consume_refs", the_repository);
1119 ret = store_updated_refs(transport->url,
1120 transport->remote->name,
1121 connectivity_checked,
1122 ref_map);
1123 transport_unlock_pack(transport);
1124 trace2_region_leave("fetch", "consume_refs", the_repository);
1125 return ret;
1128 static int prune_refs(struct refspec *rs, struct ref *ref_map,
1129 const char *raw_url)
1131 int url_len, i, result = 0;
1132 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1133 char *url;
1134 int summary_width = transport_summary_width(stale_refs);
1135 const char *dangling_msg = dry_run
1136 ? _(" (%s will become dangling)")
1137 : _(" (%s has become dangling)");
1139 if (raw_url)
1140 url = transport_anonymize_url(raw_url);
1141 else
1142 url = xstrdup("foreign");
1144 url_len = strlen(url);
1145 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
1148 url_len = i + 1;
1149 if (4 < i && !strncmp(".git", url + i - 3, 4))
1150 url_len = i - 3;
1152 if (!dry_run) {
1153 struct string_list refnames = STRING_LIST_INIT_NODUP;
1155 for (ref = stale_refs; ref; ref = ref->next)
1156 string_list_append(&refnames, ref->name);
1158 result = delete_refs("fetch: prune", &refnames, 0);
1159 string_list_clear(&refnames, 0);
1162 if (verbosity >= 0) {
1163 for (ref = stale_refs; ref; ref = ref->next) {
1164 struct strbuf sb = STRBUF_INIT;
1165 if (!shown_url) {
1166 fprintf(stderr, _("From %.*s\n"), url_len, url);
1167 shown_url = 1;
1169 format_display(&sb, '-', _("[deleted]"), NULL,
1170 _("(none)"), prettify_refname(ref->name),
1171 summary_width);
1172 fprintf(stderr, " %s\n",sb.buf);
1173 strbuf_release(&sb);
1174 warn_dangling_symref(stderr, dangling_msg, ref->name);
1178 free(url);
1179 free_refs(stale_refs);
1180 return result;
1183 static void check_not_current_branch(struct ref *ref_map)
1185 struct branch *current_branch = branch_get(NULL);
1187 if (is_bare_repository() || !current_branch)
1188 return;
1190 for (; ref_map; ref_map = ref_map->next)
1191 if (ref_map->peer_ref && !strcmp(current_branch->refname,
1192 ref_map->peer_ref->name))
1193 die(_("Refusing to fetch into current branch %s "
1194 "of non-bare repository"), current_branch->refname);
1197 static int truncate_fetch_head(void)
1199 const char *filename = git_path_fetch_head(the_repository);
1200 FILE *fp = fopen_for_writing(filename);
1202 if (!fp)
1203 return error_errno(_("cannot open %s"), filename);
1204 fclose(fp);
1205 return 0;
1208 static void set_option(struct transport *transport, const char *name, const char *value)
1210 int r = transport_set_option(transport, name, value);
1211 if (r < 0)
1212 die(_("Option \"%s\" value \"%s\" is not valid for %s"),
1213 name, value, transport->url);
1214 if (r > 0)
1215 warning(_("Option \"%s\" is ignored for %s\n"),
1216 name, transport->url);
1220 static int add_oid(const char *refname, const struct object_id *oid, int flags,
1221 void *cb_data)
1223 struct oid_array *oids = cb_data;
1225 oid_array_append(oids, oid);
1226 return 0;
1229 static void add_negotiation_tips(struct git_transport_options *smart_options)
1231 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1232 int i;
1234 for (i = 0; i < negotiation_tip.nr; i++) {
1235 const char *s = negotiation_tip.items[i].string;
1236 int old_nr;
1237 if (!has_glob_specials(s)) {
1238 struct object_id oid;
1239 if (get_oid(s, &oid))
1240 die("%s is not a valid object", s);
1241 oid_array_append(oids, &oid);
1242 continue;
1244 old_nr = oids->nr;
1245 for_each_glob_ref(add_oid, s, oids);
1246 if (old_nr == oids->nr)
1247 warning("Ignoring --negotiation-tip=%s because it does not match any refs",
1250 smart_options->negotiation_tips = oids;
1253 static struct transport *prepare_transport(struct remote *remote, int deepen)
1255 struct transport *transport;
1257 transport = transport_get(remote, NULL);
1258 transport_set_verbosity(transport, verbosity, progress);
1259 transport->family = family;
1260 if (upload_pack)
1261 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1262 if (keep)
1263 set_option(transport, TRANS_OPT_KEEP, "yes");
1264 if (depth)
1265 set_option(transport, TRANS_OPT_DEPTH, depth);
1266 if (deepen && deepen_since)
1267 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1268 if (deepen && deepen_not.nr)
1269 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1270 (const char *)&deepen_not);
1271 if (deepen_relative)
1272 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1273 if (update_shallow)
1274 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1275 if (filter_options.choice) {
1276 const char *spec =
1277 expand_list_objects_filter_spec(&filter_options);
1278 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1279 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1281 if (negotiation_tip.nr) {
1282 if (transport->smart_options)
1283 add_negotiation_tips(transport->smart_options);
1284 else
1285 warning("Ignoring --negotiation-tip because the protocol does not support it.");
1287 return transport;
1290 static void backfill_tags(struct transport *transport, struct ref *ref_map)
1292 int cannot_reuse;
1295 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1296 * when remote helper is used (setting it to an empty string
1297 * is not unsetting). We could extend the remote helper
1298 * protocol for that, but for now, just force a new connection
1299 * without deepen-since. Similar story for deepen-not.
1301 cannot_reuse = transport->cannot_reuse ||
1302 deepen_since || deepen_not.nr;
1303 if (cannot_reuse) {
1304 gsecondary = prepare_transport(transport->remote, 0);
1305 transport = gsecondary;
1308 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1309 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1310 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1311 if (!fetch_refs(transport, ref_map))
1312 consume_refs(transport, ref_map);
1314 if (gsecondary) {
1315 transport_disconnect(gsecondary);
1316 gsecondary = NULL;
1320 static int do_fetch(struct transport *transport,
1321 struct refspec *rs)
1323 struct ref *ref_map;
1324 int autotags = (transport->remote->fetch_tags == 1);
1325 int retcode = 0;
1326 const struct ref *remote_refs;
1327 struct strvec ref_prefixes = STRVEC_INIT;
1328 int must_list_refs = 1;
1330 if (tags == TAGS_DEFAULT) {
1331 if (transport->remote->fetch_tags == 2)
1332 tags = TAGS_SET;
1333 if (transport->remote->fetch_tags == -1)
1334 tags = TAGS_UNSET;
1337 /* if not appending, truncate FETCH_HEAD */
1338 if (!append && write_fetch_head) {
1339 retcode = truncate_fetch_head();
1340 if (retcode)
1341 goto cleanup;
1344 if (rs->nr) {
1345 int i;
1347 refspec_ref_prefixes(rs, &ref_prefixes);
1350 * We can avoid listing refs if all of them are exact
1351 * OIDs
1353 must_list_refs = 0;
1354 for (i = 0; i < rs->nr; i++) {
1355 if (!rs->items[i].exact_sha1) {
1356 must_list_refs = 1;
1357 break;
1360 } else if (transport->remote && transport->remote->fetch.nr)
1361 refspec_ref_prefixes(&transport->remote->fetch, &ref_prefixes);
1363 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1364 must_list_refs = 1;
1365 if (ref_prefixes.nr)
1366 strvec_push(&ref_prefixes, "refs/tags/");
1369 if (must_list_refs) {
1370 trace2_region_enter("fetch", "remote_refs", the_repository);
1371 remote_refs = transport_get_remote_refs(transport, &ref_prefixes);
1372 trace2_region_leave("fetch", "remote_refs", the_repository);
1373 } else
1374 remote_refs = NULL;
1376 strvec_clear(&ref_prefixes);
1378 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1379 tags, &autotags);
1380 if (!update_head_ok)
1381 check_not_current_branch(ref_map);
1383 if (tags == TAGS_DEFAULT && autotags)
1384 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1385 if (prune) {
1387 * We only prune based on refspecs specified
1388 * explicitly (via command line or configuration); we
1389 * don't care whether --tags was specified.
1391 if (rs->nr) {
1392 prune_refs(rs, ref_map, transport->url);
1393 } else {
1394 prune_refs(&transport->remote->fetch,
1395 ref_map,
1396 transport->url);
1399 if (fetch_refs(transport, ref_map) || consume_refs(transport, ref_map)) {
1400 free_refs(ref_map);
1401 retcode = 1;
1402 goto cleanup;
1405 if (set_upstream) {
1406 struct branch *branch = branch_get("HEAD");
1407 struct ref *rm;
1408 struct ref *source_ref = NULL;
1411 * We're setting the upstream configuration for the
1412 * current branch. The relevant upstream is the
1413 * fetched branch that is meant to be merged with the
1414 * current one, i.e. the one fetched to FETCH_HEAD.
1416 * When there are several such branches, consider the
1417 * request ambiguous and err on the safe side by doing
1418 * nothing and just emit a warning.
1420 for (rm = ref_map; rm; rm = rm->next) {
1421 if (!rm->peer_ref) {
1422 if (source_ref) {
1423 warning(_("multiple branches detected, incompatible with --set-upstream"));
1424 goto skip;
1425 } else {
1426 source_ref = rm;
1430 if (source_ref) {
1431 if (!strcmp(source_ref->name, "HEAD") ||
1432 starts_with(source_ref->name, "refs/heads/"))
1433 install_branch_config(0,
1434 branch->name,
1435 transport->remote->name,
1436 source_ref->name);
1437 else if (starts_with(source_ref->name, "refs/remotes/"))
1438 warning(_("not setting upstream for a remote remote-tracking branch"));
1439 else if (starts_with(source_ref->name, "refs/tags/"))
1440 warning(_("not setting upstream for a remote tag"));
1441 else
1442 warning(_("unknown branch type"));
1443 } else {
1444 warning(_("no source branch found.\n"
1445 "you need to specify exactly one branch with the --set-upstream option."));
1448 skip:
1449 free_refs(ref_map);
1451 /* if neither --no-tags nor --tags was specified, do automated tag
1452 * following ... */
1453 if (tags == TAGS_DEFAULT && autotags) {
1454 struct ref **tail = &ref_map;
1455 ref_map = NULL;
1456 find_non_local_tags(remote_refs, &ref_map, &tail);
1457 if (ref_map)
1458 backfill_tags(transport, ref_map);
1459 free_refs(ref_map);
1462 cleanup:
1463 return retcode;
1466 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1468 struct string_list *list = priv;
1469 if (!remote->skip_default_update)
1470 string_list_append(list, remote->name);
1471 return 0;
1474 struct remote_group_data {
1475 const char *name;
1476 struct string_list *list;
1479 static int get_remote_group(const char *key, const char *value, void *priv)
1481 struct remote_group_data *g = priv;
1483 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1484 /* split list by white space */
1485 while (*value) {
1486 size_t wordlen = strcspn(value, " \t\n");
1488 if (wordlen >= 1)
1489 string_list_append_nodup(g->list,
1490 xstrndup(value, wordlen));
1491 value += wordlen + (value[wordlen] != '\0');
1495 return 0;
1498 static int add_remote_or_group(const char *name, struct string_list *list)
1500 int prev_nr = list->nr;
1501 struct remote_group_data g;
1502 g.name = name; g.list = list;
1504 git_config(get_remote_group, &g);
1505 if (list->nr == prev_nr) {
1506 struct remote *remote = remote_get(name);
1507 if (!remote_is_configured(remote, 0))
1508 return 0;
1509 string_list_append(list, remote->name);
1511 return 1;
1514 static void add_options_to_argv(struct strvec *argv)
1516 if (dry_run)
1517 strvec_push(argv, "--dry-run");
1518 if (prune != -1)
1519 strvec_push(argv, prune ? "--prune" : "--no-prune");
1520 if (prune_tags != -1)
1521 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1522 if (update_head_ok)
1523 strvec_push(argv, "--update-head-ok");
1524 if (force)
1525 strvec_push(argv, "--force");
1526 if (keep)
1527 strvec_push(argv, "--keep");
1528 if (recurse_submodules == RECURSE_SUBMODULES_ON)
1529 strvec_push(argv, "--recurse-submodules");
1530 else if (recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1531 strvec_push(argv, "--recurse-submodules=on-demand");
1532 if (tags == TAGS_SET)
1533 strvec_push(argv, "--tags");
1534 else if (tags == TAGS_UNSET)
1535 strvec_push(argv, "--no-tags");
1536 if (verbosity >= 2)
1537 strvec_push(argv, "-v");
1538 if (verbosity >= 1)
1539 strvec_push(argv, "-v");
1540 else if (verbosity < 0)
1541 strvec_push(argv, "-q");
1545 /* Fetch multiple remotes in parallel */
1547 struct parallel_fetch_state {
1548 const char **argv;
1549 struct string_list *remotes;
1550 int next, result;
1553 static int fetch_next_remote(struct child_process *cp, struct strbuf *out,
1554 void *cb, void **task_cb)
1556 struct parallel_fetch_state *state = cb;
1557 char *remote;
1559 if (state->next < 0 || state->next >= state->remotes->nr)
1560 return 0;
1562 remote = state->remotes->items[state->next++].string;
1563 *task_cb = remote;
1565 strvec_pushv(&cp->args, state->argv);
1566 strvec_push(&cp->args, remote);
1567 cp->git_cmd = 1;
1569 if (verbosity >= 0)
1570 printf(_("Fetching %s\n"), remote);
1572 return 1;
1575 static int fetch_failed_to_start(struct strbuf *out, void *cb, void *task_cb)
1577 struct parallel_fetch_state *state = cb;
1578 const char *remote = task_cb;
1580 state->result = error(_("Could not fetch %s"), remote);
1582 return 0;
1585 static int fetch_finished(int result, struct strbuf *out,
1586 void *cb, void *task_cb)
1588 struct parallel_fetch_state *state = cb;
1589 const char *remote = task_cb;
1591 if (result) {
1592 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1593 remote, result);
1594 state->result = -1;
1597 return 0;
1600 static int fetch_multiple(struct string_list *list, int max_children)
1602 int i, result = 0;
1603 struct strvec argv = STRVEC_INIT;
1605 if (!append && write_fetch_head) {
1606 int errcode = truncate_fetch_head();
1607 if (errcode)
1608 return errcode;
1611 strvec_pushl(&argv, "fetch", "--append", "--no-auto-gc",
1612 "--no-write-commit-graph", NULL);
1613 add_options_to_argv(&argv);
1615 if (max_children != 1 && list->nr != 1) {
1616 struct parallel_fetch_state state = { argv.v, list, 0, 0 };
1618 strvec_push(&argv, "--end-of-options");
1619 result = run_processes_parallel_tr2(max_children,
1620 &fetch_next_remote,
1621 &fetch_failed_to_start,
1622 &fetch_finished,
1623 &state,
1624 "fetch", "parallel/fetch");
1626 if (!result)
1627 result = state.result;
1628 } else
1629 for (i = 0; i < list->nr; i++) {
1630 const char *name = list->items[i].string;
1631 strvec_push(&argv, name);
1632 if (verbosity >= 0)
1633 printf(_("Fetching %s\n"), name);
1634 if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
1635 error(_("Could not fetch %s"), name);
1636 result = 1;
1638 strvec_pop(&argv);
1641 strvec_clear(&argv);
1642 return !!result;
1646 * Fetching from the promisor remote should use the given filter-spec
1647 * or inherit the default filter-spec from the config.
1649 static inline void fetch_one_setup_partial(struct remote *remote)
1652 * Explicit --no-filter argument overrides everything, regardless
1653 * of any prior partial clones and fetches.
1655 if (filter_options.no_filter)
1656 return;
1659 * If no prior partial clone/fetch and the current fetch DID NOT
1660 * request a partial-fetch, do a normal fetch.
1662 if (!has_promisor_remote() && !filter_options.choice)
1663 return;
1666 * If this is a partial-fetch request, we enable partial on
1667 * this repo if not already enabled and remember the given
1668 * filter-spec as the default for subsequent fetches to this
1669 * remote.
1671 if (filter_options.choice) {
1672 partial_clone_register(remote->name, &filter_options);
1673 return;
1677 * Do a partial-fetch from the promisor remote using either the
1678 * explicitly given filter-spec or inherit the filter-spec from
1679 * the config.
1681 if (!filter_options.choice)
1682 partial_clone_get_default_filter_spec(&filter_options, remote->name);
1683 return;
1686 static int fetch_one(struct remote *remote, int argc, const char **argv,
1687 int prune_tags_ok, int use_stdin_refspecs)
1689 struct refspec rs = REFSPEC_INIT_FETCH;
1690 int i;
1691 int exit_code;
1692 int maybe_prune_tags;
1693 int remote_via_config = remote_is_configured(remote, 0);
1695 if (!remote)
1696 die(_("No remote repository specified. Please, specify either a URL or a\n"
1697 "remote name from which new revisions should be fetched."));
1699 gtransport = prepare_transport(remote, 1);
1701 if (prune < 0) {
1702 /* no command line request */
1703 if (0 <= remote->prune)
1704 prune = remote->prune;
1705 else if (0 <= fetch_prune_config)
1706 prune = fetch_prune_config;
1707 else
1708 prune = PRUNE_BY_DEFAULT;
1711 if (prune_tags < 0) {
1712 /* no command line request */
1713 if (0 <= remote->prune_tags)
1714 prune_tags = remote->prune_tags;
1715 else if (0 <= fetch_prune_tags_config)
1716 prune_tags = fetch_prune_tags_config;
1717 else
1718 prune_tags = PRUNE_TAGS_BY_DEFAULT;
1721 maybe_prune_tags = prune_tags_ok && prune_tags;
1722 if (maybe_prune_tags && remote_via_config)
1723 refspec_append(&remote->fetch, TAG_REFSPEC);
1725 if (maybe_prune_tags && (argc || !remote_via_config))
1726 refspec_append(&rs, TAG_REFSPEC);
1728 for (i = 0; i < argc; i++) {
1729 if (!strcmp(argv[i], "tag")) {
1730 char *tag;
1731 i++;
1732 if (i >= argc)
1733 die(_("You need to specify a tag name."));
1735 tag = xstrfmt("refs/tags/%s:refs/tags/%s",
1736 argv[i], argv[i]);
1737 refspec_append(&rs, tag);
1738 free(tag);
1739 } else {
1740 refspec_append(&rs, argv[i]);
1744 if (use_stdin_refspecs) {
1745 struct strbuf line = STRBUF_INIT;
1746 while (strbuf_getline_lf(&line, stdin) != EOF)
1747 refspec_append(&rs, line.buf);
1748 strbuf_release(&line);
1751 if (server_options.nr)
1752 gtransport->server_options = &server_options;
1754 sigchain_push_common(unlock_pack_on_signal);
1755 atexit(unlock_pack);
1756 sigchain_push(SIGPIPE, SIG_IGN);
1757 exit_code = do_fetch(gtransport, &rs);
1758 sigchain_pop(SIGPIPE);
1759 refspec_clear(&rs);
1760 transport_disconnect(gtransport);
1761 gtransport = NULL;
1762 return exit_code;
1765 int cmd_fetch(int argc, const char **argv, const char *prefix)
1767 int i;
1768 struct string_list list = STRING_LIST_INIT_DUP;
1769 struct remote *remote = NULL;
1770 int result = 0;
1771 int prune_tags_ok = 1;
1773 packet_trace_identity("fetch");
1775 /* Record the command line for the reflog */
1776 strbuf_addstr(&default_rla, "fetch");
1777 for (i = 1; i < argc; i++) {
1778 /* This handles non-URLs gracefully */
1779 char *anon = transport_anonymize_url(argv[i]);
1781 strbuf_addf(&default_rla, " %s", anon);
1782 free(anon);
1785 git_config(git_fetch_config, NULL);
1787 argc = parse_options(argc, argv, prefix,
1788 builtin_fetch_options, builtin_fetch_usage, 0);
1789 if (recurse_submodules != RECURSE_SUBMODULES_OFF) {
1790 int *sfjc = submodule_fetch_jobs_config == -1
1791 ? &submodule_fetch_jobs_config : NULL;
1792 int *rs = recurse_submodules == RECURSE_SUBMODULES_DEFAULT
1793 ? &recurse_submodules : NULL;
1795 fetch_config_from_gitmodules(sfjc, rs);
1798 if (deepen_relative) {
1799 if (deepen_relative < 0)
1800 die(_("Negative depth in --deepen is not supported"));
1801 if (depth)
1802 die(_("--deepen and --depth are mutually exclusive"));
1803 depth = xstrfmt("%d", deepen_relative);
1805 if (unshallow) {
1806 if (depth)
1807 die(_("--depth and --unshallow cannot be used together"));
1808 else if (!is_repository_shallow(the_repository))
1809 die(_("--unshallow on a complete repository does not make sense"));
1810 else
1811 depth = xstrfmt("%d", INFINITE_DEPTH);
1814 /* no need to be strict, transport_set_option() will validate it again */
1815 if (depth && atoi(depth) < 1)
1816 die(_("depth %s is not a positive number"), depth);
1817 if (depth || deepen_since || deepen_not.nr)
1818 deepen = 1;
1820 /* FETCH_HEAD never gets updated in --dry-run mode */
1821 if (dry_run)
1822 write_fetch_head = 0;
1824 if (all) {
1825 if (argc == 1)
1826 die(_("fetch --all does not take a repository argument"));
1827 else if (argc > 1)
1828 die(_("fetch --all does not make sense with refspecs"));
1829 (void) for_each_remote(get_one_remote_for_fetch, &list);
1830 } else if (argc == 0) {
1831 /* No arguments -- use default remote */
1832 remote = remote_get(NULL);
1833 } else if (multiple) {
1834 /* All arguments are assumed to be remotes or groups */
1835 for (i = 0; i < argc; i++)
1836 if (!add_remote_or_group(argv[i], &list))
1837 die(_("No such remote or remote group: %s"), argv[i]);
1838 } else {
1839 /* Single remote or group */
1840 (void) add_remote_or_group(argv[0], &list);
1841 if (list.nr > 1) {
1842 /* More than one remote */
1843 if (argc > 1)
1844 die(_("Fetching a group and specifying refspecs does not make sense"));
1845 } else {
1846 /* Zero or one remotes */
1847 remote = remote_get(argv[0]);
1848 prune_tags_ok = (argc == 1);
1849 argc--;
1850 argv++;
1854 if (remote) {
1855 if (filter_options.choice || has_promisor_remote())
1856 fetch_one_setup_partial(remote);
1857 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs);
1858 } else {
1859 int max_children = max_jobs;
1861 if (filter_options.choice)
1862 die(_("--filter can only be used with the remote "
1863 "configured in extensions.partialclone"));
1865 if (stdin_refspecs)
1866 die(_("--stdin can only be used when fetching "
1867 "from one remote"));
1869 if (max_children < 0)
1870 max_children = fetch_parallel_config;
1872 /* TODO should this also die if we have a previous partial-clone? */
1873 result = fetch_multiple(&list, max_children);
1876 if (!result && (recurse_submodules != RECURSE_SUBMODULES_OFF)) {
1877 struct strvec options = STRVEC_INIT;
1878 int max_children = max_jobs;
1880 if (max_children < 0)
1881 max_children = submodule_fetch_jobs_config;
1882 if (max_children < 0)
1883 max_children = fetch_parallel_config;
1885 add_options_to_argv(&options);
1886 result = fetch_populated_submodules(the_repository,
1887 &options,
1888 submodule_prefix,
1889 recurse_submodules,
1890 recurse_submodules_default,
1891 verbosity < 0,
1892 max_children);
1893 strvec_clear(&options);
1896 string_list_clear(&list, 0);
1898 prepare_repo_settings(the_repository);
1899 if (fetch_write_commit_graph > 0 ||
1900 (fetch_write_commit_graph < 0 &&
1901 the_repository->settings.fetch_write_commit_graph)) {
1902 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
1904 if (progress)
1905 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
1907 write_commit_graph_reachable(the_repository->objects->odb,
1908 commit_graph_flags,
1909 NULL);
1912 close_object_store(the_repository->objects);
1914 if (enable_auto_gc)
1915 run_auto_gc(verbosity < 0);
1917 return result;