submodule: allow erroneous values for the fetchRecurseSubmodules option
[git/gitweb.git] / builtin / fetch.c
blobfaae548a28230ea17c4bd6188194238272138a43
1 /*
2 * "git fetch"
3 */
4 #include "cache.h"
5 #include "refs.h"
6 #include "commit.h"
7 #include "builtin.h"
8 #include "string-list.h"
9 #include "remote.h"
10 #include "transport.h"
11 #include "run-command.h"
12 #include "parse-options.h"
13 #include "sigchain.h"
14 #include "submodule-config.h"
15 #include "submodule.h"
16 #include "connected.h"
17 #include "argv-array.h"
19 static const char * const builtin_fetch_usage[] = {
20 N_("git fetch [<options>] [<repository> [<refspec>...]]"),
21 N_("git fetch [<options>] <group>"),
22 N_("git fetch --multiple [<options>] [(<repository> | <group>)...]"),
23 N_("git fetch --all [<options>]"),
24 NULL
27 enum {
28 TAGS_UNSET = 0,
29 TAGS_DEFAULT = 1,
30 TAGS_SET = 2
33 static int fetch_prune_config = -1; /* unspecified */
34 static int prune = -1; /* unspecified */
35 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
37 static int all, append, dry_run, force, keep, multiple, update_head_ok, verbosity;
38 static int progress = -1, recurse_submodules = RECURSE_SUBMODULES_DEFAULT;
39 static int tags = TAGS_DEFAULT, unshallow, update_shallow;
40 static const char *depth;
41 static const char *upload_pack;
42 static struct strbuf default_rla = STRBUF_INIT;
43 static struct transport *gtransport;
44 static struct transport *gsecondary;
45 static const char *submodule_prefix = "";
46 static const char *recurse_submodules_default;
47 static int shown_url = 0;
48 static int refmap_alloc, refmap_nr;
49 static const char **refmap_array;
51 static int option_parse_recurse_submodules(const struct option *opt,
52 const char *arg, int unset)
54 if (unset) {
55 recurse_submodules = RECURSE_SUBMODULES_OFF;
56 } else {
57 if (arg)
58 recurse_submodules = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
59 else
60 recurse_submodules = RECURSE_SUBMODULES_ON;
62 return 0;
65 static int git_fetch_config(const char *k, const char *v, void *cb)
67 if (!strcmp(k, "fetch.prune")) {
68 fetch_prune_config = git_config_bool(k, v);
69 return 0;
71 return git_default_config(k, v, cb);
74 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
76 ALLOC_GROW(refmap_array, refmap_nr + 1, refmap_alloc);
79 * "git fetch --refmap='' origin foo"
80 * can be used to tell the command not to store anywhere
82 if (*arg)
83 refmap_array[refmap_nr++] = arg;
84 return 0;
87 static struct option builtin_fetch_options[] = {
88 OPT__VERBOSITY(&verbosity),
89 OPT_BOOL(0, "all", &all,
90 N_("fetch from all remotes")),
91 OPT_BOOL('a', "append", &append,
92 N_("append to .git/FETCH_HEAD instead of overwriting")),
93 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
94 N_("path to upload pack on remote end")),
95 OPT__FORCE(&force, N_("force overwrite of local branch")),
96 OPT_BOOL('m', "multiple", &multiple,
97 N_("fetch from multiple remotes")),
98 OPT_SET_INT('t', "tags", &tags,
99 N_("fetch all tags and associated objects"), TAGS_SET),
100 OPT_SET_INT('n', NULL, &tags,
101 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
102 OPT_BOOL('p', "prune", &prune,
103 N_("prune remote-tracking branches no longer on remote")),
104 { OPTION_CALLBACK, 0, "recurse-submodules", NULL, N_("on-demand"),
105 N_("control recursive fetching of submodules"),
106 PARSE_OPT_OPTARG, option_parse_recurse_submodules },
107 OPT_BOOL(0, "dry-run", &dry_run,
108 N_("dry run")),
109 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
110 OPT_BOOL('u', "update-head-ok", &update_head_ok,
111 N_("allow updating of HEAD ref")),
112 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
113 OPT_STRING(0, "depth", &depth, N_("depth"),
114 N_("deepen history of shallow clone")),
115 { OPTION_SET_INT, 0, "unshallow", &unshallow, NULL,
116 N_("convert to a complete repository"),
117 PARSE_OPT_NONEG | PARSE_OPT_NOARG, NULL, 1 },
118 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
119 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
120 { OPTION_STRING, 0, "recurse-submodules-default",
121 &recurse_submodules_default, NULL,
122 N_("default mode for recursion"), PARSE_OPT_HIDDEN },
123 OPT_BOOL(0, "update-shallow", &update_shallow,
124 N_("accept refs that update .git/shallow")),
125 { OPTION_CALLBACK, 0, "refmap", NULL, N_("refmap"),
126 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg },
127 OPT_END()
130 static void unlock_pack(void)
132 if (gtransport)
133 transport_unlock_pack(gtransport);
134 if (gsecondary)
135 transport_unlock_pack(gsecondary);
138 static void unlock_pack_on_signal(int signo)
140 unlock_pack();
141 sigchain_pop(signo);
142 raise(signo);
145 static void add_merge_config(struct ref **head,
146 const struct ref *remote_refs,
147 struct branch *branch,
148 struct ref ***tail)
150 int i;
152 for (i = 0; i < branch->merge_nr; i++) {
153 struct ref *rm, **old_tail = *tail;
154 struct refspec refspec;
156 for (rm = *head; rm; rm = rm->next) {
157 if (branch_merge_matches(branch, i, rm->name)) {
158 rm->fetch_head_status = FETCH_HEAD_MERGE;
159 break;
162 if (rm)
163 continue;
166 * Not fetched to a remote-tracking branch? We need to fetch
167 * it anyway to allow this branch's "branch.$name.merge"
168 * to be honored by 'git pull', but we do not have to
169 * fail if branch.$name.merge is misconfigured to point
170 * at a nonexisting branch. If we were indeed called by
171 * 'git pull', it will notice the misconfiguration because
172 * there is no entry in the resulting FETCH_HEAD marked
173 * for merging.
175 memset(&refspec, 0, sizeof(refspec));
176 refspec.src = branch->merge[i]->src;
177 get_fetch_map(remote_refs, &refspec, tail, 1);
178 for (rm = *old_tail; rm; rm = rm->next)
179 rm->fetch_head_status = FETCH_HEAD_MERGE;
183 static int add_existing(const char *refname, const unsigned char *sha1,
184 int flag, void *cbdata)
186 struct string_list *list = (struct string_list *)cbdata;
187 struct string_list_item *item = string_list_insert(list, refname);
188 item->util = xmalloc(20);
189 hashcpy(item->util, sha1);
190 return 0;
193 static int will_fetch(struct ref **head, const unsigned char *sha1)
195 struct ref *rm = *head;
196 while (rm) {
197 if (!hashcmp(rm->old_sha1, sha1))
198 return 1;
199 rm = rm->next;
201 return 0;
204 static void find_non_local_tags(struct transport *transport,
205 struct ref **head,
206 struct ref ***tail)
208 struct string_list existing_refs = STRING_LIST_INIT_DUP;
209 struct string_list remote_refs = STRING_LIST_INIT_NODUP;
210 const struct ref *ref;
211 struct string_list_item *item = NULL;
213 for_each_ref(add_existing, &existing_refs);
214 for (ref = transport_get_remote_refs(transport); ref; ref = ref->next) {
215 if (!starts_with(ref->name, "refs/tags/"))
216 continue;
219 * The peeled ref always follows the matching base
220 * ref, so if we see a peeled ref that we don't want
221 * to fetch then we can mark the ref entry in the list
222 * as one to ignore by setting util to NULL.
224 if (ends_with(ref->name, "^{}")) {
225 if (item && !has_sha1_file(ref->old_sha1) &&
226 !will_fetch(head, ref->old_sha1) &&
227 !has_sha1_file(item->util) &&
228 !will_fetch(head, item->util))
229 item->util = NULL;
230 item = NULL;
231 continue;
235 * If item is non-NULL here, then we previously saw a
236 * ref not followed by a peeled reference, so we need
237 * to check if it is a lightweight tag that we want to
238 * fetch.
240 if (item && !has_sha1_file(item->util) &&
241 !will_fetch(head, item->util))
242 item->util = NULL;
244 item = NULL;
246 /* skip duplicates and refs that we already have */
247 if (string_list_has_string(&remote_refs, ref->name) ||
248 string_list_has_string(&existing_refs, ref->name))
249 continue;
251 item = string_list_insert(&remote_refs, ref->name);
252 item->util = (void *)ref->old_sha1;
254 string_list_clear(&existing_refs, 1);
257 * We may have a final lightweight tag that needs to be
258 * checked to see if it needs fetching.
260 if (item && !has_sha1_file(item->util) &&
261 !will_fetch(head, item->util))
262 item->util = NULL;
265 * For all the tags in the remote_refs string list,
266 * add them to the list of refs to be fetched
268 for_each_string_list_item(item, &remote_refs) {
269 /* Unless we have already decided to ignore this item... */
270 if (item->util)
272 struct ref *rm = alloc_ref(item->string);
273 rm->peer_ref = alloc_ref(item->string);
274 hashcpy(rm->old_sha1, item->util);
275 **tail = rm;
276 *tail = &rm->next;
280 string_list_clear(&remote_refs, 0);
283 static struct ref *get_ref_map(struct transport *transport,
284 struct refspec *refspecs, int refspec_count,
285 int tags, int *autotags)
287 int i;
288 struct ref *rm;
289 struct ref *ref_map = NULL;
290 struct ref **tail = &ref_map;
292 /* opportunistically-updated references: */
293 struct ref *orefs = NULL, **oref_tail = &orefs;
295 const struct ref *remote_refs = transport_get_remote_refs(transport);
297 if (refspec_count) {
298 struct refspec *fetch_refspec;
299 int fetch_refspec_nr;
301 for (i = 0; i < refspec_count; i++) {
302 get_fetch_map(remote_refs, &refspecs[i], &tail, 0);
303 if (refspecs[i].dst && refspecs[i].dst[0])
304 *autotags = 1;
306 /* Merge everything on the command line (but not --tags) */
307 for (rm = ref_map; rm; rm = rm->next)
308 rm->fetch_head_status = FETCH_HEAD_MERGE;
311 * For any refs that we happen to be fetching via
312 * command-line arguments, the destination ref might
313 * have been missing or have been different than the
314 * remote-tracking ref that would be derived from the
315 * configured refspec. In these cases, we want to
316 * take the opportunity to update their configured
317 * remote-tracking reference. However, we do not want
318 * to mention these entries in FETCH_HEAD at all, as
319 * they would simply be duplicates of existing
320 * entries, so we set them FETCH_HEAD_IGNORE below.
322 * We compute these entries now, based only on the
323 * refspecs specified on the command line. But we add
324 * them to the list following the refspecs resulting
325 * from the tags option so that one of the latter,
326 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
327 * by ref_remove_duplicates() in favor of one of these
328 * opportunistic entries with FETCH_HEAD_IGNORE.
330 if (refmap_array) {
331 fetch_refspec = parse_fetch_refspec(refmap_nr, refmap_array);
332 fetch_refspec_nr = refmap_nr;
333 } else {
334 fetch_refspec = transport->remote->fetch;
335 fetch_refspec_nr = transport->remote->fetch_refspec_nr;
338 for (i = 0; i < fetch_refspec_nr; i++)
339 get_fetch_map(ref_map, &fetch_refspec[i], &oref_tail, 1);
341 if (tags == TAGS_SET)
342 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
343 } else if (refmap_array) {
344 die("--refmap option is only meaningful with command-line refspec(s).");
345 } else {
346 /* Use the defaults */
347 struct remote *remote = transport->remote;
348 struct branch *branch = branch_get(NULL);
349 int has_merge = branch_has_merge_config(branch);
350 if (remote &&
351 (remote->fetch_refspec_nr ||
352 /* Note: has_merge implies non-NULL branch->remote_name */
353 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
354 for (i = 0; i < remote->fetch_refspec_nr; i++) {
355 get_fetch_map(remote_refs, &remote->fetch[i], &tail, 0);
356 if (remote->fetch[i].dst &&
357 remote->fetch[i].dst[0])
358 *autotags = 1;
359 if (!i && !has_merge && ref_map &&
360 !remote->fetch[0].pattern)
361 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
364 * if the remote we're fetching from is the same
365 * as given in branch.<name>.remote, we add the
366 * ref given in branch.<name>.merge, too.
368 * Note: has_merge implies non-NULL branch->remote_name
370 if (has_merge &&
371 !strcmp(branch->remote_name, remote->name))
372 add_merge_config(&ref_map, remote_refs, branch, &tail);
373 } else {
374 ref_map = get_remote_ref(remote_refs, "HEAD");
375 if (!ref_map)
376 die(_("Couldn't find remote ref HEAD"));
377 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
378 tail = &ref_map->next;
382 if (tags == TAGS_SET)
383 /* also fetch all tags */
384 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
385 else if (tags == TAGS_DEFAULT && *autotags)
386 find_non_local_tags(transport, &ref_map, &tail);
388 /* Now append any refs to be updated opportunistically: */
389 *tail = orefs;
390 for (rm = orefs; rm; rm = rm->next) {
391 rm->fetch_head_status = FETCH_HEAD_IGNORE;
392 tail = &rm->next;
395 return ref_remove_duplicates(ref_map);
398 #define STORE_REF_ERROR_OTHER 1
399 #define STORE_REF_ERROR_DF_CONFLICT 2
401 static int s_update_ref(const char *action,
402 struct ref *ref,
403 int check_old)
405 char msg[1024];
406 char *rla = getenv("GIT_REFLOG_ACTION");
407 struct ref_transaction *transaction;
408 struct strbuf err = STRBUF_INIT;
409 int ret, df_conflict = 0;
411 if (dry_run)
412 return 0;
413 if (!rla)
414 rla = default_rla.buf;
415 snprintf(msg, sizeof(msg), "%s: %s", rla, action);
417 transaction = ref_transaction_begin(&err);
418 if (!transaction ||
419 ref_transaction_update(transaction, ref->name,
420 ref->new_sha1,
421 check_old ? ref->old_sha1 : NULL,
422 0, msg, &err))
423 goto fail;
425 ret = ref_transaction_commit(transaction, &err);
426 if (ret) {
427 df_conflict = (ret == TRANSACTION_NAME_CONFLICT);
428 goto fail;
431 ref_transaction_free(transaction);
432 strbuf_release(&err);
433 return 0;
434 fail:
435 ref_transaction_free(transaction);
436 error("%s", err.buf);
437 strbuf_release(&err);
438 return df_conflict ? STORE_REF_ERROR_DF_CONFLICT
439 : STORE_REF_ERROR_OTHER;
442 #define REFCOL_WIDTH 10
444 static int update_local_ref(struct ref *ref,
445 const char *remote,
446 const struct ref *remote_ref,
447 struct strbuf *display)
449 struct commit *current = NULL, *updated;
450 enum object_type type;
451 struct branch *current_branch = branch_get(NULL);
452 const char *pretty_ref = prettify_refname(ref->name);
454 type = sha1_object_info(ref->new_sha1, NULL);
455 if (type < 0)
456 die(_("object %s not found"), sha1_to_hex(ref->new_sha1));
458 if (!hashcmp(ref->old_sha1, ref->new_sha1)) {
459 if (verbosity > 0)
460 strbuf_addf(display, "= %-*s %-*s -> %s",
461 TRANSPORT_SUMMARY(_("[up to date]")),
462 REFCOL_WIDTH, remote, pretty_ref);
463 return 0;
466 if (current_branch &&
467 !strcmp(ref->name, current_branch->name) &&
468 !(update_head_ok || is_bare_repository()) &&
469 !is_null_sha1(ref->old_sha1)) {
471 * If this is the head, and it's not okay to update
472 * the head, and the old value of the head isn't empty...
474 strbuf_addf(display,
475 _("! %-*s %-*s -> %s (can't fetch in current branch)"),
476 TRANSPORT_SUMMARY(_("[rejected]")),
477 REFCOL_WIDTH, remote, pretty_ref);
478 return 1;
481 if (!is_null_sha1(ref->old_sha1) &&
482 starts_with(ref->name, "refs/tags/")) {
483 int r;
484 r = s_update_ref("updating tag", ref, 0);
485 strbuf_addf(display, "%c %-*s %-*s -> %s%s",
486 r ? '!' : '-',
487 TRANSPORT_SUMMARY(_("[tag update]")),
488 REFCOL_WIDTH, remote, pretty_ref,
489 r ? _(" (unable to update local ref)") : "");
490 return r;
493 current = lookup_commit_reference_gently(ref->old_sha1, 1);
494 updated = lookup_commit_reference_gently(ref->new_sha1, 1);
495 if (!current || !updated) {
496 const char *msg;
497 const char *what;
498 int r;
500 * Nicely describe the new ref we're fetching.
501 * Base this on the remote's ref name, as it's
502 * more likely to follow a standard layout.
504 const char *name = remote_ref ? remote_ref->name : "";
505 if (starts_with(name, "refs/tags/")) {
506 msg = "storing tag";
507 what = _("[new tag]");
508 } else if (starts_with(name, "refs/heads/")) {
509 msg = "storing head";
510 what = _("[new branch]");
511 } else {
512 msg = "storing ref";
513 what = _("[new ref]");
516 if ((recurse_submodules != RECURSE_SUBMODULES_OFF) &&
517 (recurse_submodules != RECURSE_SUBMODULES_ON))
518 check_for_new_submodule_commits(ref->new_sha1);
519 r = s_update_ref(msg, ref, 0);
520 strbuf_addf(display, "%c %-*s %-*s -> %s%s",
521 r ? '!' : '*',
522 TRANSPORT_SUMMARY(what),
523 REFCOL_WIDTH, remote, pretty_ref,
524 r ? _(" (unable to update local ref)") : "");
525 return r;
528 if (in_merge_bases(current, updated)) {
529 char quickref[83];
530 int r;
531 strcpy(quickref, find_unique_abbrev(current->object.sha1, DEFAULT_ABBREV));
532 strcat(quickref, "..");
533 strcat(quickref, find_unique_abbrev(ref->new_sha1, DEFAULT_ABBREV));
534 if ((recurse_submodules != RECURSE_SUBMODULES_OFF) &&
535 (recurse_submodules != RECURSE_SUBMODULES_ON))
536 check_for_new_submodule_commits(ref->new_sha1);
537 r = s_update_ref("fast-forward", ref, 1);
538 strbuf_addf(display, "%c %-*s %-*s -> %s%s",
539 r ? '!' : ' ',
540 TRANSPORT_SUMMARY_WIDTH, quickref,
541 REFCOL_WIDTH, remote, pretty_ref,
542 r ? _(" (unable to update local ref)") : "");
543 return r;
544 } else if (force || ref->force) {
545 char quickref[84];
546 int r;
547 strcpy(quickref, find_unique_abbrev(current->object.sha1, DEFAULT_ABBREV));
548 strcat(quickref, "...");
549 strcat(quickref, find_unique_abbrev(ref->new_sha1, DEFAULT_ABBREV));
550 if ((recurse_submodules != RECURSE_SUBMODULES_OFF) &&
551 (recurse_submodules != RECURSE_SUBMODULES_ON))
552 check_for_new_submodule_commits(ref->new_sha1);
553 r = s_update_ref("forced-update", ref, 1);
554 strbuf_addf(display, "%c %-*s %-*s -> %s (%s)",
555 r ? '!' : '+',
556 TRANSPORT_SUMMARY_WIDTH, quickref,
557 REFCOL_WIDTH, remote, pretty_ref,
558 r ? _("unable to update local ref") : _("forced update"));
559 return r;
560 } else {
561 strbuf_addf(display, "! %-*s %-*s -> %s %s",
562 TRANSPORT_SUMMARY(_("[rejected]")),
563 REFCOL_WIDTH, remote, pretty_ref,
564 _("(non-fast-forward)"));
565 return 1;
569 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
571 struct ref **rm = cb_data;
572 struct ref *ref = *rm;
574 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
575 ref = ref->next;
576 if (!ref)
577 return -1; /* end of the list */
578 *rm = ref->next;
579 hashcpy(sha1, ref->old_sha1);
580 return 0;
583 static int store_updated_refs(const char *raw_url, const char *remote_name,
584 struct ref *ref_map)
586 FILE *fp;
587 struct commit *commit;
588 int url_len, i, rc = 0;
589 struct strbuf note = STRBUF_INIT;
590 const char *what, *kind;
591 struct ref *rm;
592 char *url;
593 const char *filename = dry_run ? "/dev/null" : git_path("FETCH_HEAD");
594 int want_status;
596 fp = fopen(filename, "a");
597 if (!fp)
598 return error(_("cannot open %s: %s\n"), filename, strerror(errno));
600 if (raw_url)
601 url = transport_anonymize_url(raw_url);
602 else
603 url = xstrdup("foreign");
605 rm = ref_map;
606 if (check_everything_connected(iterate_ref_map, 0, &rm)) {
607 rc = error(_("%s did not send all necessary objects\n"), url);
608 goto abort;
612 * We do a pass for each fetch_head_status type in their enum order, so
613 * merged entries are written before not-for-merge. That lets readers
614 * use FETCH_HEAD as a refname to refer to the ref to be merged.
616 for (want_status = FETCH_HEAD_MERGE;
617 want_status <= FETCH_HEAD_IGNORE;
618 want_status++) {
619 for (rm = ref_map; rm; rm = rm->next) {
620 struct ref *ref = NULL;
621 const char *merge_status_marker = "";
623 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
624 if (want_status == FETCH_HEAD_MERGE)
625 warning(_("reject %s because shallow roots are not allowed to be updated"),
626 rm->peer_ref ? rm->peer_ref->name : rm->name);
627 continue;
630 commit = lookup_commit_reference_gently(rm->old_sha1, 1);
631 if (!commit)
632 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
634 if (rm->fetch_head_status != want_status)
635 continue;
637 if (rm->peer_ref) {
638 ref = xcalloc(1, sizeof(*ref) + strlen(rm->peer_ref->name) + 1);
639 strcpy(ref->name, rm->peer_ref->name);
640 hashcpy(ref->old_sha1, rm->peer_ref->old_sha1);
641 hashcpy(ref->new_sha1, rm->old_sha1);
642 ref->force = rm->peer_ref->force;
646 if (!strcmp(rm->name, "HEAD")) {
647 kind = "";
648 what = "";
650 else if (starts_with(rm->name, "refs/heads/")) {
651 kind = "branch";
652 what = rm->name + 11;
654 else if (starts_with(rm->name, "refs/tags/")) {
655 kind = "tag";
656 what = rm->name + 10;
658 else if (starts_with(rm->name, "refs/remotes/")) {
659 kind = "remote-tracking branch";
660 what = rm->name + 13;
662 else {
663 kind = "";
664 what = rm->name;
667 url_len = strlen(url);
668 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
670 url_len = i + 1;
671 if (4 < i && !strncmp(".git", url + i - 3, 4))
672 url_len = i - 3;
674 strbuf_reset(&note);
675 if (*what) {
676 if (*kind)
677 strbuf_addf(&note, "%s ", kind);
678 strbuf_addf(&note, "'%s' of ", what);
680 switch (rm->fetch_head_status) {
681 case FETCH_HEAD_NOT_FOR_MERGE:
682 merge_status_marker = "not-for-merge";
683 /* fall-through */
684 case FETCH_HEAD_MERGE:
685 fprintf(fp, "%s\t%s\t%s",
686 sha1_to_hex(rm->old_sha1),
687 merge_status_marker,
688 note.buf);
689 for (i = 0; i < url_len; ++i)
690 if ('\n' == url[i])
691 fputs("\\n", fp);
692 else
693 fputc(url[i], fp);
694 fputc('\n', fp);
695 break;
696 default:
697 /* do not write anything to FETCH_HEAD */
698 break;
701 strbuf_reset(&note);
702 if (ref) {
703 rc |= update_local_ref(ref, what, rm, &note);
704 free(ref);
705 } else
706 strbuf_addf(&note, "* %-*s %-*s -> FETCH_HEAD",
707 TRANSPORT_SUMMARY_WIDTH,
708 *kind ? kind : "branch",
709 REFCOL_WIDTH,
710 *what ? what : "HEAD");
711 if (note.len) {
712 if (verbosity >= 0 && !shown_url) {
713 fprintf(stderr, _("From %.*s\n"),
714 url_len, url);
715 shown_url = 1;
717 if (verbosity >= 0)
718 fprintf(stderr, " %s\n", note.buf);
723 if (rc & STORE_REF_ERROR_DF_CONFLICT)
724 error(_("some local refs could not be updated; try running\n"
725 " 'git remote prune %s' to remove any old, conflicting "
726 "branches"), remote_name);
728 abort:
729 strbuf_release(&note);
730 free(url);
731 fclose(fp);
732 return rc;
736 * We would want to bypass the object transfer altogether if
737 * everything we are going to fetch already exists and is connected
738 * locally.
740 static int quickfetch(struct ref *ref_map)
742 struct ref *rm = ref_map;
745 * If we are deepening a shallow clone we already have these
746 * objects reachable. Running rev-list here will return with
747 * a good (0) exit status and we'll bypass the fetch that we
748 * really need to perform. Claiming failure now will ensure
749 * we perform the network exchange to deepen our history.
751 if (depth)
752 return -1;
753 return check_everything_connected(iterate_ref_map, 1, &rm);
756 static int fetch_refs(struct transport *transport, struct ref *ref_map)
758 int ret = quickfetch(ref_map);
759 if (ret)
760 ret = transport_fetch_refs(transport, ref_map);
761 if (!ret)
762 ret |= store_updated_refs(transport->url,
763 transport->remote->name,
764 ref_map);
765 transport_unlock_pack(transport);
766 return ret;
769 static int prune_refs(struct refspec *refs, int ref_count, struct ref *ref_map,
770 const char *raw_url)
772 int url_len, i, result = 0;
773 struct ref *ref, *stale_refs = get_stale_heads(refs, ref_count, ref_map);
774 char *url;
775 const char *dangling_msg = dry_run
776 ? _(" (%s will become dangling)")
777 : _(" (%s has become dangling)");
779 if (raw_url)
780 url = transport_anonymize_url(raw_url);
781 else
782 url = xstrdup("foreign");
784 url_len = strlen(url);
785 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
788 url_len = i + 1;
789 if (4 < i && !strncmp(".git", url + i - 3, 4))
790 url_len = i - 3;
792 for (ref = stale_refs; ref; ref = ref->next) {
793 if (!dry_run)
794 result |= delete_ref(ref->name, NULL, 0);
795 if (verbosity >= 0 && !shown_url) {
796 fprintf(stderr, _("From %.*s\n"), url_len, url);
797 shown_url = 1;
799 if (verbosity >= 0) {
800 fprintf(stderr, " x %-*s %-*s -> %s\n",
801 TRANSPORT_SUMMARY(_("[deleted]")),
802 REFCOL_WIDTH, _("(none)"), prettify_refname(ref->name));
803 warn_dangling_symref(stderr, dangling_msg, ref->name);
806 free(url);
807 free_refs(stale_refs);
808 return result;
811 static void check_not_current_branch(struct ref *ref_map)
813 struct branch *current_branch = branch_get(NULL);
815 if (is_bare_repository() || !current_branch)
816 return;
818 for (; ref_map; ref_map = ref_map->next)
819 if (ref_map->peer_ref && !strcmp(current_branch->refname,
820 ref_map->peer_ref->name))
821 die(_("Refusing to fetch into current branch %s "
822 "of non-bare repository"), current_branch->refname);
825 static int truncate_fetch_head(void)
827 const char *filename = git_path("FETCH_HEAD");
828 FILE *fp = fopen(filename, "w");
830 if (!fp)
831 return error(_("cannot open %s: %s\n"), filename, strerror(errno));
832 fclose(fp);
833 return 0;
836 static void set_option(struct transport *transport, const char *name, const char *value)
838 int r = transport_set_option(transport, name, value);
839 if (r < 0)
840 die(_("Option \"%s\" value \"%s\" is not valid for %s"),
841 name, value, transport->url);
842 if (r > 0)
843 warning(_("Option \"%s\" is ignored for %s\n"),
844 name, transport->url);
847 static struct transport *prepare_transport(struct remote *remote)
849 struct transport *transport;
850 transport = transport_get(remote, NULL);
851 transport_set_verbosity(transport, verbosity, progress);
852 if (upload_pack)
853 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
854 if (keep)
855 set_option(transport, TRANS_OPT_KEEP, "yes");
856 if (depth)
857 set_option(transport, TRANS_OPT_DEPTH, depth);
858 if (update_shallow)
859 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
860 return transport;
863 static void backfill_tags(struct transport *transport, struct ref *ref_map)
865 if (transport->cannot_reuse) {
866 gsecondary = prepare_transport(transport->remote);
867 transport = gsecondary;
870 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
871 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
872 fetch_refs(transport, ref_map);
874 if (gsecondary) {
875 transport_disconnect(gsecondary);
876 gsecondary = NULL;
880 static int do_fetch(struct transport *transport,
881 struct refspec *refs, int ref_count)
883 struct string_list existing_refs = STRING_LIST_INIT_DUP;
884 struct ref *ref_map;
885 struct ref *rm;
886 int autotags = (transport->remote->fetch_tags == 1);
887 int retcode = 0;
889 for_each_ref(add_existing, &existing_refs);
891 if (tags == TAGS_DEFAULT) {
892 if (transport->remote->fetch_tags == 2)
893 tags = TAGS_SET;
894 if (transport->remote->fetch_tags == -1)
895 tags = TAGS_UNSET;
898 if (!transport->get_refs_list || !transport->fetch)
899 die(_("Don't know how to fetch from %s"), transport->url);
901 /* if not appending, truncate FETCH_HEAD */
902 if (!append && !dry_run) {
903 retcode = truncate_fetch_head();
904 if (retcode)
905 goto cleanup;
908 ref_map = get_ref_map(transport, refs, ref_count, tags, &autotags);
909 if (!update_head_ok)
910 check_not_current_branch(ref_map);
912 for (rm = ref_map; rm; rm = rm->next) {
913 if (rm->peer_ref) {
914 struct string_list_item *peer_item =
915 string_list_lookup(&existing_refs,
916 rm->peer_ref->name);
917 if (peer_item)
918 hashcpy(rm->peer_ref->old_sha1,
919 peer_item->util);
923 if (tags == TAGS_DEFAULT && autotags)
924 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
925 if (prune) {
927 * We only prune based on refspecs specified
928 * explicitly (via command line or configuration); we
929 * don't care whether --tags was specified.
931 if (ref_count) {
932 prune_refs(refs, ref_count, ref_map, transport->url);
933 } else {
934 prune_refs(transport->remote->fetch,
935 transport->remote->fetch_refspec_nr,
936 ref_map,
937 transport->url);
940 if (fetch_refs(transport, ref_map)) {
941 free_refs(ref_map);
942 retcode = 1;
943 goto cleanup;
945 free_refs(ref_map);
947 /* if neither --no-tags nor --tags was specified, do automated tag
948 * following ... */
949 if (tags == TAGS_DEFAULT && autotags) {
950 struct ref **tail = &ref_map;
951 ref_map = NULL;
952 find_non_local_tags(transport, &ref_map, &tail);
953 if (ref_map)
954 backfill_tags(transport, ref_map);
955 free_refs(ref_map);
958 cleanup:
959 string_list_clear(&existing_refs, 1);
960 return retcode;
963 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
965 struct string_list *list = priv;
966 if (!remote->skip_default_update)
967 string_list_append(list, remote->name);
968 return 0;
971 struct remote_group_data {
972 const char *name;
973 struct string_list *list;
976 static int get_remote_group(const char *key, const char *value, void *priv)
978 struct remote_group_data *g = priv;
980 if (starts_with(key, "remotes.") &&
981 !strcmp(key + 8, g->name)) {
982 /* split list by white space */
983 int space = strcspn(value, " \t\n");
984 while (*value) {
985 if (space > 1) {
986 string_list_append(g->list,
987 xstrndup(value, space));
989 value += space + (value[space] != '\0');
990 space = strcspn(value, " \t\n");
994 return 0;
997 static int add_remote_or_group(const char *name, struct string_list *list)
999 int prev_nr = list->nr;
1000 struct remote_group_data g;
1001 g.name = name; g.list = list;
1003 git_config(get_remote_group, &g);
1004 if (list->nr == prev_nr) {
1005 struct remote *remote;
1006 if (!remote_is_configured(name))
1007 return 0;
1008 remote = remote_get(name);
1009 string_list_append(list, remote->name);
1011 return 1;
1014 static void add_options_to_argv(struct argv_array *argv)
1016 if (dry_run)
1017 argv_array_push(argv, "--dry-run");
1018 if (prune != -1)
1019 argv_array_push(argv, prune ? "--prune" : "--no-prune");
1020 if (update_head_ok)
1021 argv_array_push(argv, "--update-head-ok");
1022 if (force)
1023 argv_array_push(argv, "--force");
1024 if (keep)
1025 argv_array_push(argv, "--keep");
1026 if (recurse_submodules == RECURSE_SUBMODULES_ON)
1027 argv_array_push(argv, "--recurse-submodules");
1028 else if (recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1029 argv_array_push(argv, "--recurse-submodules=on-demand");
1030 if (tags == TAGS_SET)
1031 argv_array_push(argv, "--tags");
1032 else if (tags == TAGS_UNSET)
1033 argv_array_push(argv, "--no-tags");
1034 if (verbosity >= 2)
1035 argv_array_push(argv, "-v");
1036 if (verbosity >= 1)
1037 argv_array_push(argv, "-v");
1038 else if (verbosity < 0)
1039 argv_array_push(argv, "-q");
1043 static int fetch_multiple(struct string_list *list)
1045 int i, result = 0;
1046 struct argv_array argv = ARGV_ARRAY_INIT;
1048 if (!append && !dry_run) {
1049 int errcode = truncate_fetch_head();
1050 if (errcode)
1051 return errcode;
1054 argv_array_pushl(&argv, "fetch", "--append", NULL);
1055 add_options_to_argv(&argv);
1057 for (i = 0; i < list->nr; i++) {
1058 const char *name = list->items[i].string;
1059 argv_array_push(&argv, name);
1060 if (verbosity >= 0)
1061 printf(_("Fetching %s\n"), name);
1062 if (run_command_v_opt(argv.argv, RUN_GIT_CMD)) {
1063 error(_("Could not fetch %s"), name);
1064 result = 1;
1066 argv_array_pop(&argv);
1069 argv_array_clear(&argv);
1070 return result;
1073 static int fetch_one(struct remote *remote, int argc, const char **argv)
1075 static const char **refs = NULL;
1076 struct refspec *refspec;
1077 int ref_nr = 0;
1078 int exit_code;
1080 if (!remote)
1081 die(_("No remote repository specified. Please, specify either a URL or a\n"
1082 "remote name from which new revisions should be fetched."));
1084 gtransport = prepare_transport(remote);
1086 if (prune < 0) {
1087 /* no command line request */
1088 if (0 <= gtransport->remote->prune)
1089 prune = gtransport->remote->prune;
1090 else if (0 <= fetch_prune_config)
1091 prune = fetch_prune_config;
1092 else
1093 prune = PRUNE_BY_DEFAULT;
1096 if (argc > 0) {
1097 int j = 0;
1098 int i;
1099 refs = xcalloc(argc + 1, sizeof(const char *));
1100 for (i = 0; i < argc; i++) {
1101 if (!strcmp(argv[i], "tag")) {
1102 i++;
1103 if (i >= argc)
1104 die(_("You need to specify a tag name."));
1105 refs[j++] = xstrfmt("refs/tags/%s:refs/tags/%s",
1106 argv[i], argv[i]);
1107 } else
1108 refs[j++] = argv[i];
1110 refs[j] = NULL;
1111 ref_nr = j;
1114 sigchain_push_common(unlock_pack_on_signal);
1115 atexit(unlock_pack);
1116 refspec = parse_fetch_refspec(ref_nr, refs);
1117 exit_code = do_fetch(gtransport, refspec, ref_nr);
1118 free_refspec(ref_nr, refspec);
1119 transport_disconnect(gtransport);
1120 gtransport = NULL;
1121 return exit_code;
1124 int cmd_fetch(int argc, const char **argv, const char *prefix)
1126 int i;
1127 struct string_list list = STRING_LIST_INIT_NODUP;
1128 struct remote *remote;
1129 int result = 0;
1130 struct argv_array argv_gc_auto = ARGV_ARRAY_INIT;
1132 packet_trace_identity("fetch");
1134 /* Record the command line for the reflog */
1135 strbuf_addstr(&default_rla, "fetch");
1136 for (i = 1; i < argc; i++)
1137 strbuf_addf(&default_rla, " %s", argv[i]);
1139 git_config(git_fetch_config, NULL);
1141 argc = parse_options(argc, argv, prefix,
1142 builtin_fetch_options, builtin_fetch_usage, 0);
1144 if (unshallow) {
1145 if (depth)
1146 die(_("--depth and --unshallow cannot be used together"));
1147 else if (!is_repository_shallow())
1148 die(_("--unshallow on a complete repository does not make sense"));
1149 else {
1150 static char inf_depth[12];
1151 sprintf(inf_depth, "%d", INFINITE_DEPTH);
1152 depth = inf_depth;
1156 /* no need to be strict, transport_set_option() will validate it again */
1157 if (depth && atoi(depth) < 1)
1158 die(_("depth %s is not a positive number"), depth);
1160 if (recurse_submodules != RECURSE_SUBMODULES_OFF) {
1161 if (recurse_submodules_default) {
1162 int arg = parse_fetch_recurse_submodules_arg("--recurse-submodules-default", recurse_submodules_default);
1163 set_config_fetch_recurse_submodules(arg);
1165 gitmodules_config();
1166 git_config(submodule_config, NULL);
1169 if (all) {
1170 if (argc == 1)
1171 die(_("fetch --all does not take a repository argument"));
1172 else if (argc > 1)
1173 die(_("fetch --all does not make sense with refspecs"));
1174 (void) for_each_remote(get_one_remote_for_fetch, &list);
1175 result = fetch_multiple(&list);
1176 } else if (argc == 0) {
1177 /* No arguments -- use default remote */
1178 remote = remote_get(NULL);
1179 result = fetch_one(remote, argc, argv);
1180 } else if (multiple) {
1181 /* All arguments are assumed to be remotes or groups */
1182 for (i = 0; i < argc; i++)
1183 if (!add_remote_or_group(argv[i], &list))
1184 die(_("No such remote or remote group: %s"), argv[i]);
1185 result = fetch_multiple(&list);
1186 } else {
1187 /* Single remote or group */
1188 (void) add_remote_or_group(argv[0], &list);
1189 if (list.nr > 1) {
1190 /* More than one remote */
1191 if (argc > 1)
1192 die(_("Fetching a group and specifying refspecs does not make sense"));
1193 result = fetch_multiple(&list);
1194 } else {
1195 /* Zero or one remotes */
1196 remote = remote_get(argv[0]);
1197 result = fetch_one(remote, argc-1, argv+1);
1201 if (!result && (recurse_submodules != RECURSE_SUBMODULES_OFF)) {
1202 struct argv_array options = ARGV_ARRAY_INIT;
1204 add_options_to_argv(&options);
1205 result = fetch_populated_submodules(&options,
1206 submodule_prefix,
1207 recurse_submodules,
1208 verbosity < 0);
1209 argv_array_clear(&options);
1212 /* All names were strdup()ed or strndup()ed */
1213 list.strdup_strings = 1;
1214 string_list_clear(&list, 0);
1216 argv_array_pushl(&argv_gc_auto, "gc", "--auto", NULL);
1217 if (verbosity < 0)
1218 argv_array_push(&argv_gc_auto, "--quiet");
1219 run_command_v_opt(argv_gc_auto.argv, RUN_GIT_CMD);
1220 argv_array_clear(&argv_gc_auto);
1222 return result;