8 #include "string-list.h"
10 #include "transport.h"
11 #include "run-command.h"
12 #include "parse-options.h"
15 static const char * const builtin_fetch_usage[] = {
16 "git fetch [<options>] [<repository> [<refspec>...]]",
17 "git fetch [<options>] <group>",
18 "git fetch --multiple [<options>] [<repository> | <group>]...",
19 "git fetch --all [<options>]",
29 static int all, append, dry_run, force, keep, multiple, prune, update_head_ok, verbosity;
30 static int tags = TAGS_DEFAULT;
31 static const char *depth;
32 static const char *upload_pack;
33 static struct strbuf default_rla = STRBUF_INIT;
34 static struct transport *transport;
36 static struct option builtin_fetch_options[] = {
37 OPT__VERBOSITY(&verbosity),
38 OPT_BOOLEAN(0, "all", &all,
39 "fetch from all remotes"),
40 OPT_BOOLEAN('a', "append", &append,
41 "append to .git/FETCH_HEAD instead of overwriting"),
42 OPT_STRING(0, "upload-pack", &upload_pack, "PATH",
43 "path to upload pack on remote end"),
44 OPT_BOOLEAN('f', "force", &force,
45 "force overwrite of local branch"),
46 OPT_BOOLEAN('m', "multiple", &multiple,
47 "fetch from multiple remotes"),
48 OPT_SET_INT('t', "tags", &tags,
49 "fetch all tags and associated objects", TAGS_SET),
50 OPT_SET_INT('n', NULL, &tags,
51 "do not fetch all tags (--no-tags)", TAGS_UNSET),
52 OPT_BOOLEAN('p', "prune", &prune,
53 "prune tracking branches no longer on remote"),
54 OPT_BOOLEAN(0, "dry-run", &dry_run,
56 OPT_BOOLEAN('k', "keep", &keep, "keep downloaded pack"),
57 OPT_BOOLEAN('u', "update-head-ok", &update_head_ok,
58 "allow updating of HEAD ref"),
59 OPT_STRING(0, "depth", &depth, "DEPTH",
60 "deepen history of shallow clone"),
64 static void unlock_pack(void)
67 transport_unlock_pack(transport);
70 static void unlock_pack_on_signal(int signo)
77 static void add_merge_config(struct ref **head,
78 const struct ref *remote_refs,
79 struct branch *branch,
84 for (i = 0; i < branch->merge_nr; i++) {
85 struct ref *rm, **old_tail = *tail;
86 struct refspec refspec;
88 for (rm = *head; rm; rm = rm->next) {
89 if (branch_merge_matches(branch, i, rm->name)) {
98 * Not fetched to a tracking branch? We need to fetch
99 * it anyway to allow this branch's "branch.$name.merge"
100 * to be honored by 'git pull', but we do not have to
101 * fail if branch.$name.merge is misconfigured to point
102 * at a nonexisting branch. If we were indeed called by
103 * 'git pull', it will notice the misconfiguration because
104 * there is no entry in the resulting FETCH_HEAD marked
107 memset(&refspec, 0, sizeof(refspec));
108 refspec.src = branch->merge[i]->src;
109 get_fetch_map(remote_refs, &refspec, tail, 1);
110 for (rm = *old_tail; rm; rm = rm->next)
115 static void find_non_local_tags(struct transport *transport,
119 static struct ref *get_ref_map(struct transport *transport,
120 struct refspec *refs, int ref_count, int tags,
125 struct ref *ref_map = NULL;
126 struct ref **tail = &ref_map;
128 const struct ref *remote_refs = transport_get_remote_refs(transport);
130 if (ref_count || tags == TAGS_SET) {
131 for (i = 0; i < ref_count; i++) {
132 get_fetch_map(remote_refs, &refs[i], &tail, 0);
133 if (refs[i].dst && refs[i].dst[0])
136 /* Merge everything on the command line, but not --tags */
137 for (rm = ref_map; rm; rm = rm->next)
139 if (tags == TAGS_SET)
140 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
142 /* Use the defaults */
143 struct remote *remote = transport->remote;
144 struct branch *branch = branch_get(NULL);
145 int has_merge = branch_has_merge_config(branch);
146 if (remote && (remote->fetch_refspec_nr || has_merge)) {
147 for (i = 0; i < remote->fetch_refspec_nr; i++) {
148 get_fetch_map(remote_refs, &remote->fetch[i], &tail, 0);
149 if (remote->fetch[i].dst &&
150 remote->fetch[i].dst[0])
152 if (!i && !has_merge && ref_map &&
153 !remote->fetch[0].pattern)
157 * if the remote we're fetching from is the same
158 * as given in branch.<name>.remote, we add the
159 * ref given in branch.<name>.merge, too.
162 !strcmp(branch->remote_name, remote->name))
163 add_merge_config(&ref_map, remote_refs, branch, &tail);
165 ref_map = get_remote_ref(remote_refs, "HEAD");
167 die("Couldn't find remote ref HEAD");
169 tail = &ref_map->next;
172 if (tags == TAGS_DEFAULT && *autotags)
173 find_non_local_tags(transport, &ref_map, &tail);
174 ref_remove_duplicates(ref_map);
179 #define STORE_REF_ERROR_OTHER 1
180 #define STORE_REF_ERROR_DF_CONFLICT 2
182 static int s_update_ref(const char *action,
187 char *rla = getenv("GIT_REFLOG_ACTION");
188 static struct ref_lock *lock;
193 rla = default_rla.buf;
194 snprintf(msg, sizeof(msg), "%s: %s", rla, action);
195 lock = lock_any_ref_for_update(ref->name,
196 check_old ? ref->old_sha1 : NULL, 0);
198 return errno == ENOTDIR ? STORE_REF_ERROR_DF_CONFLICT :
199 STORE_REF_ERROR_OTHER;
200 if (write_ref_sha1(lock, ref->new_sha1, msg) < 0)
201 return errno == ENOTDIR ? STORE_REF_ERROR_DF_CONFLICT :
202 STORE_REF_ERROR_OTHER;
206 #define SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
207 #define REFCOL_WIDTH 10
209 static int update_local_ref(struct ref *ref,
213 struct commit *current = NULL, *updated;
214 enum object_type type;
215 struct branch *current_branch = branch_get(NULL);
216 const char *pretty_ref = prettify_refname(ref->name);
219 type = sha1_object_info(ref->new_sha1, NULL);
221 die("object %s not found", sha1_to_hex(ref->new_sha1));
223 if (!hashcmp(ref->old_sha1, ref->new_sha1)) {
225 sprintf(display, "= %-*s %-*s -> %s", SUMMARY_WIDTH,
226 "[up to date]", REFCOL_WIDTH, remote,
231 if (current_branch &&
232 !strcmp(ref->name, current_branch->name) &&
233 !(update_head_ok || is_bare_repository()) &&
234 !is_null_sha1(ref->old_sha1)) {
236 * If this is the head, and it's not okay to update
237 * the head, and the old value of the head isn't empty...
239 sprintf(display, "! %-*s %-*s -> %s (can't fetch in current branch)",
240 SUMMARY_WIDTH, "[rejected]", REFCOL_WIDTH, remote,
245 if (!is_null_sha1(ref->old_sha1) &&
246 !prefixcmp(ref->name, "refs/tags/")) {
248 r = s_update_ref("updating tag", ref, 0);
249 sprintf(display, "%c %-*s %-*s -> %s%s", r ? '!' : '-',
250 SUMMARY_WIDTH, "[tag update]", REFCOL_WIDTH, remote,
251 pretty_ref, r ? " (unable to update local ref)" : "");
255 current = lookup_commit_reference_gently(ref->old_sha1, 1);
256 updated = lookup_commit_reference_gently(ref->new_sha1, 1);
257 if (!current || !updated) {
261 if (!strncmp(ref->name, "refs/tags/", 10)) {
266 msg = "storing head";
267 what = "[new branch]";
270 r = s_update_ref(msg, ref, 0);
271 sprintf(display, "%c %-*s %-*s -> %s%s", r ? '!' : '*',
272 SUMMARY_WIDTH, what, REFCOL_WIDTH, remote, pretty_ref,
273 r ? " (unable to update local ref)" : "");
277 if (in_merge_bases(current, &updated, 1)) {
280 strcpy(quickref, find_unique_abbrev(current->object.sha1, DEFAULT_ABBREV));
281 strcat(quickref, "..");
282 strcat(quickref, find_unique_abbrev(ref->new_sha1, DEFAULT_ABBREV));
283 r = s_update_ref("fast-forward", ref, 1);
284 sprintf(display, "%c %-*s %-*s -> %s%s", r ? '!' : ' ',
285 SUMMARY_WIDTH, quickref, REFCOL_WIDTH, remote,
286 pretty_ref, r ? " (unable to update local ref)" : "");
288 } else if (force || ref->force) {
291 strcpy(quickref, find_unique_abbrev(current->object.sha1, DEFAULT_ABBREV));
292 strcat(quickref, "...");
293 strcat(quickref, find_unique_abbrev(ref->new_sha1, DEFAULT_ABBREV));
294 r = s_update_ref("forced-update", ref, 1);
295 sprintf(display, "%c %-*s %-*s -> %s (%s)", r ? '!' : '+',
296 SUMMARY_WIDTH, quickref, REFCOL_WIDTH, remote,
298 r ? "unable to update local ref" : "forced update");
301 sprintf(display, "! %-*s %-*s -> %s (non-fast-forward)",
302 SUMMARY_WIDTH, "[rejected]", REFCOL_WIDTH, remote,
308 static int store_updated_refs(const char *raw_url, const char *remote_name,
312 struct commit *commit;
313 int url_len, i, note_len, shown_url = 0, rc = 0;
315 const char *what, *kind;
317 char *url, *filename = dry_run ? "/dev/null" : git_path("FETCH_HEAD");
319 fp = fopen(filename, "a");
321 return error("cannot open %s: %s\n", filename, strerror(errno));
324 url = transport_anonymize_url(raw_url);
326 url = xstrdup("foreign");
327 for (rm = ref_map; rm; rm = rm->next) {
328 struct ref *ref = NULL;
331 ref = xcalloc(1, sizeof(*ref) + strlen(rm->peer_ref->name) + 1);
332 strcpy(ref->name, rm->peer_ref->name);
333 hashcpy(ref->old_sha1, rm->peer_ref->old_sha1);
334 hashcpy(ref->new_sha1, rm->old_sha1);
335 ref->force = rm->peer_ref->force;
338 commit = lookup_commit_reference_gently(rm->old_sha1, 1);
342 if (!strcmp(rm->name, "HEAD")) {
346 else if (!prefixcmp(rm->name, "refs/heads/")) {
348 what = rm->name + 11;
350 else if (!prefixcmp(rm->name, "refs/tags/")) {
352 what = rm->name + 10;
354 else if (!prefixcmp(rm->name, "refs/remotes/")) {
355 kind = "remote branch";
356 what = rm->name + 13;
363 url_len = strlen(url);
364 for (i = url_len - 1; url[i] == '/' && 0 <= i; i--)
367 if (4 < i && !strncmp(".git", url + i - 3, 4))
373 note_len += sprintf(note + note_len, "%s ",
375 note_len += sprintf(note + note_len, "'%s' of ", what);
377 note[note_len] = '\0';
378 fprintf(fp, "%s\t%s\t%s",
379 sha1_to_hex(commit ? commit->object.sha1 :
381 rm->merge ? "" : "not-for-merge",
383 for (i = 0; i < url_len; ++i)
391 rc |= update_local_ref(ref, what, note);
394 sprintf(note, "* %-*s %-*s -> FETCH_HEAD",
395 SUMMARY_WIDTH, *kind ? kind : "branch",
396 REFCOL_WIDTH, *what ? what : "HEAD");
398 if (verbosity >= 0 && !shown_url) {
399 fprintf(stderr, "From %.*s\n",
404 fprintf(stderr, " %s\n", note);
409 if (rc & STORE_REF_ERROR_DF_CONFLICT)
410 error("some local refs could not be updated; try running\n"
411 " 'git remote prune %s' to remove any old, conflicting "
412 "branches", remote_name);
417 * We would want to bypass the object transfer altogether if
418 * everything we are going to fetch already exists and is connected
421 * The refs we are going to fetch are in ref_map. If running
423 * $ git rev-list --objects --stdin --not --all
425 * (feeding all the refs in ref_map on its standard input)
426 * does not error out, that means everything reachable from the
427 * refs we are going to fetch exists and is connected to some of
430 static int quickfetch(struct ref *ref_map)
432 struct child_process revlist;
435 const char *argv[] = {"rev-list",
436 "--quiet", "--objects", "--stdin", "--not", "--all", NULL};
439 * If we are deepening a shallow clone we already have these
440 * objects reachable. Running rev-list here will return with
441 * a good (0) exit status and we'll bypass the fetch that we
442 * really need to perform. Claiming failure now will ensure
443 * we perform the network exchange to deepen our history.
451 memset(&revlist, 0, sizeof(revlist));
454 revlist.no_stdout = 1;
455 revlist.no_stderr = 1;
458 err = start_command(&revlist);
460 error("could not run rev-list");
465 * If rev-list --stdin encounters an unknown commit, it terminates,
466 * which will cause SIGPIPE in the write loop below.
468 sigchain_push(SIGPIPE, SIG_IGN);
470 for (ref = ref_map; ref; ref = ref->next) {
471 if (write_in_full(revlist.in, sha1_to_hex(ref->old_sha1), 40) < 0 ||
472 write_str_in_full(revlist.in, "\n") < 0) {
473 if (errno != EPIPE && errno != EINVAL)
474 error("failed write to rev-list: %s", strerror(errno));
480 if (close(revlist.in)) {
481 error("failed to close rev-list's stdin: %s", strerror(errno));
485 sigchain_pop(SIGPIPE);
487 return finish_command(&revlist) || err;
490 static int fetch_refs(struct transport *transport, struct ref *ref_map)
492 int ret = quickfetch(ref_map);
494 ret = transport_fetch_refs(transport, ref_map);
496 ret |= store_updated_refs(transport->url,
497 transport->remote->name,
499 transport_unlock_pack(transport);
503 static int prune_refs(struct transport *transport, struct ref *ref_map)
506 struct ref *ref, *stale_refs = get_stale_heads(transport->remote, ref_map);
507 const char *dangling_msg = dry_run
508 ? " (%s will become dangling)\n"
509 : " (%s has become dangling)\n";
511 for (ref = stale_refs; ref; ref = ref->next) {
513 result |= delete_ref(ref->name, NULL, 0);
514 if (verbosity >= 0) {
515 fprintf(stderr, " x %-*s %-*s -> %s\n",
516 SUMMARY_WIDTH, "[deleted]",
517 REFCOL_WIDTH, "(none)", prettify_refname(ref->name));
518 warn_dangling_symref(stderr, dangling_msg, ref->name);
521 free_refs(stale_refs);
525 static int add_existing(const char *refname, const unsigned char *sha1,
526 int flag, void *cbdata)
528 struct string_list *list = (struct string_list *)cbdata;
529 struct string_list_item *item = string_list_insert(refname, list);
530 item->util = (void *)sha1;
534 static int will_fetch(struct ref **head, const unsigned char *sha1)
536 struct ref *rm = *head;
538 if (!hashcmp(rm->old_sha1, sha1))
550 static int add_to_tail(struct string_list_item *item, void *cb_data)
552 struct tag_data *data = (struct tag_data *)cb_data;
553 struct ref *rm = NULL;
555 /* We have already decided to ignore this item */
559 rm = alloc_ref(item->string);
560 rm->peer_ref = alloc_ref(item->string);
561 hashcpy(rm->old_sha1, item->util);
564 *data->tail = &rm->next;
569 static void find_non_local_tags(struct transport *transport,
573 struct string_list existing_refs = { NULL, 0, 0, 0 };
574 struct string_list remote_refs = { NULL, 0, 0, 0 };
575 struct tag_data data = {head, tail};
576 const struct ref *ref;
577 struct string_list_item *item = NULL;
579 for_each_ref(add_existing, &existing_refs);
580 for (ref = transport_get_remote_refs(transport); ref; ref = ref->next) {
581 if (prefixcmp(ref->name, "refs/tags"))
585 * The peeled ref always follows the matching base
586 * ref, so if we see a peeled ref that we don't want
587 * to fetch then we can mark the ref entry in the list
588 * as one to ignore by setting util to NULL.
590 if (!suffixcmp(ref->name, "^{}")) {
591 if (item && !has_sha1_file(ref->old_sha1) &&
592 !will_fetch(head, ref->old_sha1) &&
593 !has_sha1_file(item->util) &&
594 !will_fetch(head, item->util))
601 * If item is non-NULL here, then we previously saw a
602 * ref not followed by a peeled reference, so we need
603 * to check if it is a lightweight tag that we want to
606 if (item && !has_sha1_file(item->util) &&
607 !will_fetch(head, item->util))
612 /* skip duplicates and refs that we already have */
613 if (string_list_has_string(&remote_refs, ref->name) ||
614 string_list_has_string(&existing_refs, ref->name))
617 item = string_list_insert(ref->name, &remote_refs);
618 item->util = (void *)ref->old_sha1;
620 string_list_clear(&existing_refs, 0);
623 * We may have a final lightweight tag that needs to be
624 * checked to see if it needs fetching.
626 if (item && !has_sha1_file(item->util) &&
627 !will_fetch(head, item->util))
631 * For all the tags in the remote_refs string list, call
632 * add_to_tail to add them to the list of refs to be fetched
634 for_each_string_list(add_to_tail, &remote_refs, &data);
636 string_list_clear(&remote_refs, 0);
639 static void check_not_current_branch(struct ref *ref_map)
641 struct branch *current_branch = branch_get(NULL);
643 if (is_bare_repository() || !current_branch)
646 for (; ref_map; ref_map = ref_map->next)
647 if (ref_map->peer_ref && !strcmp(current_branch->refname,
648 ref_map->peer_ref->name))
649 die("Refusing to fetch into current branch %s "
650 "of non-bare repository", current_branch->refname);
653 static int truncate_fetch_head(void)
655 char *filename = git_path("FETCH_HEAD");
656 FILE *fp = fopen(filename, "w");
659 return error("cannot open %s: %s\n", filename, strerror(errno));
664 static int do_fetch(struct transport *transport,
665 struct refspec *refs, int ref_count)
667 struct string_list existing_refs = { NULL, 0, 0, 0 };
668 struct string_list_item *peer_item = NULL;
671 int autotags = (transport->remote->fetch_tags == 1);
673 for_each_ref(add_existing, &existing_refs);
675 if (transport->remote->fetch_tags == 2 && tags != TAGS_UNSET)
677 if (transport->remote->fetch_tags == -1)
680 if (!transport->get_refs_list || !transport->fetch)
681 die("Don't know how to fetch from %s", transport->url);
683 /* if not appending, truncate FETCH_HEAD */
684 if (!append && !dry_run) {
685 int errcode = truncate_fetch_head();
690 ref_map = get_ref_map(transport, refs, ref_count, tags, &autotags);
692 check_not_current_branch(ref_map);
694 for (rm = ref_map; rm; rm = rm->next) {
696 peer_item = string_list_lookup(rm->peer_ref->name,
699 hashcpy(rm->peer_ref->old_sha1,
704 if (tags == TAGS_DEFAULT && autotags)
705 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
706 if (fetch_refs(transport, ref_map)) {
711 prune_refs(transport, ref_map);
714 /* if neither --no-tags nor --tags was specified, do automated tag
716 if (tags == TAGS_DEFAULT && autotags) {
717 struct ref **tail = &ref_map;
719 find_non_local_tags(transport, &ref_map, &tail);
721 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
722 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
723 fetch_refs(transport, ref_map);
731 static void set_option(const char *name, const char *value)
733 int r = transport_set_option(transport, name, value);
735 die("Option \"%s\" value \"%s\" is not valid for %s",
736 name, value, transport->url);
738 warning("Option \"%s\" is ignored for %s\n",
739 name, transport->url);
742 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
744 struct string_list *list = priv;
745 if (!remote->skip_default_update)
746 string_list_append(remote->name, list);
750 struct remote_group_data {
752 struct string_list *list;
755 static int get_remote_group(const char *key, const char *value, void *priv)
757 struct remote_group_data *g = priv;
759 if (!prefixcmp(key, "remotes.") &&
760 !strcmp(key + 8, g->name)) {
761 /* split list by white space */
762 int space = strcspn(value, " \t\n");
765 string_list_append(xstrndup(value, space),
768 value += space + (value[space] != '\0');
769 space = strcspn(value, " \t\n");
776 static int add_remote_or_group(const char *name, struct string_list *list)
778 int prev_nr = list->nr;
779 struct remote_group_data g = { name, list };
781 git_config(get_remote_group, &g);
782 if (list->nr == prev_nr) {
783 struct remote *remote;
784 if (!remote_is_configured(name))
786 remote = remote_get(name);
787 string_list_append(remote->name, list);
792 static int fetch_multiple(struct string_list *list)
795 const char *argv[11] = { "fetch", "--append" };
799 argv[argc++] = "--dry-run";
801 argv[argc++] = "--prune";
803 argv[argc++] = "--update-head-ok";
805 argv[argc++] = "--force";
807 argv[argc++] = "--keep";
812 else if (verbosity < 0)
815 if (!append && !dry_run) {
816 int errcode = truncate_fetch_head();
821 for (i = 0; i < list->nr; i++) {
822 const char *name = list->items[i].string;
824 argv[argc + 1] = NULL;
826 printf("Fetching %s\n", name);
827 if (run_command_v_opt(argv, RUN_GIT_CMD)) {
828 error("Could not fetch %s", name);
836 static int fetch_one(struct remote *remote, int argc, const char **argv)
839 static const char **refs = NULL;
844 die("Where do you want to fetch from today?");
846 transport = transport_get(remote, NULL);
848 transport->verbose = verbosity <= 3 ? verbosity : 3;
850 transport->verbose = -1;
852 set_option(TRANS_OPT_UPLOADPACK, upload_pack);
854 set_option(TRANS_OPT_KEEP, "yes");
856 set_option(TRANS_OPT_DEPTH, depth);
860 refs = xcalloc(argc + 1, sizeof(const char *));
861 for (i = 0; i < argc; i++) {
862 if (!strcmp(argv[i], "tag")) {
866 die("You need to specify a tag name.");
867 ref = xmalloc(strlen(argv[i]) * 2 + 22);
868 strcpy(ref, "refs/tags/");
869 strcat(ref, argv[i]);
870 strcat(ref, ":refs/tags/");
871 strcat(ref, argv[i]);
880 sigchain_push_common(unlock_pack_on_signal);
882 exit_code = do_fetch(transport,
883 parse_fetch_refspec(ref_nr, refs), ref_nr);
884 transport_disconnect(transport);
889 int cmd_fetch(int argc, const char **argv, const char *prefix)
892 struct string_list list = { NULL, 0, 0, 0 };
893 struct remote *remote;
896 /* Record the command line for the reflog */
897 strbuf_addstr(&default_rla, "fetch");
898 for (i = 1; i < argc; i++)
899 strbuf_addf(&default_rla, " %s", argv[i]);
901 argc = parse_options(argc, argv, prefix,
902 builtin_fetch_options, builtin_fetch_usage, 0);
906 die("fetch --all does not take a repository argument");
908 die("fetch --all does not make sense with refspecs");
909 (void) for_each_remote(get_one_remote_for_fetch, &list);
910 result = fetch_multiple(&list);
911 } else if (argc == 0) {
912 /* No arguments -- use default remote */
913 remote = remote_get(NULL);
914 result = fetch_one(remote, argc, argv);
915 } else if (multiple) {
916 /* All arguments are assumed to be remotes or groups */
917 for (i = 0; i < argc; i++)
918 if (!add_remote_or_group(argv[i], &list))
919 die("No such remote or remote group: %s", argv[i]);
920 result = fetch_multiple(&list);
922 /* Single remote or group */
923 (void) add_remote_or_group(argv[0], &list);
925 /* More than one remote */
927 die("Fetching a group and specifying refspecs does not make sense");
928 result = fetch_multiple(&list);
930 /* Zero or one remotes */
931 remote = remote_get(argv[0]);
932 result = fetch_one(remote, argc-1, argv+1);
936 /* All names were strdup()ed or strndup()ed */
937 list.strdup_strings = 1;
938 string_list_clear(&list, 0);