Make "git-remote prune" delete refs according to fetch specs
[git/jrn.git] / builtin-remote.c
blobe5cfc882b5a2411038cd13a1926762933cfafed5
1 #include "cache.h"
2 #include "parse-options.h"
3 #include "transport.h"
4 #include "remote.h"
5 #include "path-list.h"
6 #include "strbuf.h"
7 #include "run-command.h"
8 #include "refs.h"
10 static const char * const builtin_remote_usage[] = {
11 "git remote",
12 "git remote add <name> <url>",
13 "git remote rm <name>",
14 "git remote show <name>",
15 "git remote prune <name>",
16 "git remote update [group]",
17 NULL
20 static int verbose;
22 static int show_all(void);
24 static inline int postfixcmp(const char *string, const char *postfix)
26 int len1 = strlen(string), len2 = strlen(postfix);
27 if (len1 < len2)
28 return 1;
29 return strcmp(string + len1 - len2, postfix);
32 static inline const char *skip_prefix(const char *name, const char *prefix)
34 return !name ? "" :
35 prefixcmp(name, prefix) ? name : name + strlen(prefix);
38 static int opt_parse_track(const struct option *opt, const char *arg, int not)
40 struct path_list *list = opt->value;
41 if (not)
42 path_list_clear(list, 0);
43 else
44 path_list_append(arg, list);
45 return 0;
48 static int fetch_remote(const char *name)
50 const char *argv[] = { "fetch", name, NULL };
51 printf("Updating %s\n", name);
52 if (run_command_v_opt(argv, RUN_GIT_CMD))
53 return error("Could not fetch %s", name);
54 return 0;
57 static int add(int argc, const char **argv)
59 int fetch = 0, mirror = 0;
60 struct path_list track = { NULL, 0, 0 };
61 const char *master = NULL;
62 struct remote *remote;
63 struct strbuf buf, buf2;
64 const char *name, *url;
65 int i;
67 struct option options[] = {
68 OPT_GROUP("add specific options"),
69 OPT_BOOLEAN('f', "fetch", &fetch, "fetch the remote branches"),
70 OPT_CALLBACK('t', "track", &track, "branch",
71 "branch(es) to track", opt_parse_track),
72 OPT_STRING('m', "master", &master, "branch", "master branch"),
73 OPT_BOOLEAN(0, "mirror", &mirror, "no separate remotes"),
74 OPT_END()
77 argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
79 if (argc < 2)
80 usage_with_options(builtin_remote_usage, options);
82 name = argv[0];
83 url = argv[1];
85 remote = remote_get(name);
86 if (remote && (remote->url_nr > 1 || strcmp(name, remote->url[0]) ||
87 remote->fetch_refspec_nr))
88 die("remote %s already exists.", name);
90 strbuf_init(&buf, 0);
91 strbuf_init(&buf2, 0);
93 strbuf_addf(&buf2, "refs/heads/test:refs/remotes/%s/test", name);
94 if (!valid_fetch_refspec(buf2.buf))
95 die("'%s' is not a valid remote name", name);
97 strbuf_addf(&buf, "remote.%s.url", name);
98 if (git_config_set(buf.buf, url))
99 return 1;
101 strbuf_reset(&buf);
102 strbuf_addf(&buf, "remote.%s.fetch", name);
104 if (track.nr == 0)
105 path_list_append("*", &track);
106 for (i = 0; i < track.nr; i++) {
107 struct path_list_item *item = track.items + i;
109 strbuf_reset(&buf2);
110 strbuf_addch(&buf2, '+');
111 if (mirror)
112 strbuf_addf(&buf2, "refs/%s:refs/%s",
113 item->path, item->path);
114 else
115 strbuf_addf(&buf2, "refs/heads/%s:refs/remotes/%s/%s",
116 item->path, name, item->path);
117 if (git_config_set_multivar(buf.buf, buf2.buf, "^$", 0))
118 return 1;
121 if (mirror) {
122 strbuf_reset(&buf);
123 strbuf_addf(&buf, "remote.%s.mirror", name);
124 if (git_config_set(buf.buf, "yes"))
125 return 1;
128 if (fetch && fetch_remote(name))
129 return 1;
131 if (master) {
132 strbuf_reset(&buf);
133 strbuf_addf(&buf, "refs/remotes/%s/HEAD", name);
135 strbuf_reset(&buf2);
136 strbuf_addf(&buf2, "refs/remotes/%s/%s", name, master);
138 if (create_symref(buf.buf, buf2.buf, "remote add"))
139 return error("Could not setup master '%s'", master);
142 strbuf_release(&buf);
143 strbuf_release(&buf2);
144 path_list_clear(&track, 0);
146 return 0;
149 struct branch_info {
150 char *remote;
151 struct path_list merge;
154 static struct path_list branch_list;
156 static int config_read_branches(const char *key, const char *value, void *cb)
158 if (!prefixcmp(key, "branch.")) {
159 char *name;
160 struct path_list_item *item;
161 struct branch_info *info;
162 enum { REMOTE, MERGE } type;
164 key += 7;
165 if (!postfixcmp(key, ".remote")) {
166 name = xstrndup(key, strlen(key) - 7);
167 type = REMOTE;
168 } else if (!postfixcmp(key, ".merge")) {
169 name = xstrndup(key, strlen(key) - 6);
170 type = MERGE;
171 } else
172 return 0;
174 item = path_list_insert(name, &branch_list);
176 if (!item->util)
177 item->util = xcalloc(sizeof(struct branch_info), 1);
178 info = item->util;
179 if (type == REMOTE) {
180 if (info->remote)
181 warning("more than one branch.%s", key);
182 info->remote = xstrdup(value);
183 } else {
184 char *space = strchr(value, ' ');
185 value = skip_prefix(value, "refs/heads/");
186 while (space) {
187 char *merge;
188 merge = xstrndup(value, space - value);
189 path_list_append(merge, &info->merge);
190 value = skip_prefix(space + 1, "refs/heads/");
191 space = strchr(value, ' ');
193 path_list_append(xstrdup(value), &info->merge);
196 return 0;
199 static void read_branches(void)
201 if (branch_list.nr)
202 return;
203 git_config(config_read_branches, NULL);
204 sort_path_list(&branch_list);
207 struct ref_states {
208 struct remote *remote;
209 struct path_list new, stale, tracked;
212 static int handle_one_branch(const char *refname,
213 const unsigned char *sha1, int flags, void *cb_data)
215 struct ref_states *states = cb_data;
216 struct refspec refspec;
218 memset(&refspec, 0, sizeof(refspec));
219 refspec.dst = (char *)refname;
220 if (!remote_find_tracking(states->remote, &refspec)) {
221 struct path_list_item *item;
222 const char *name = skip_prefix(refspec.src, "refs/heads/");
223 /* symbolic refs pointing nowhere were handled already */
224 if ((flags & REF_ISSYMREF) ||
225 unsorted_path_list_has_path(&states->tracked,
226 name) ||
227 unsorted_path_list_has_path(&states->new,
228 name))
229 return 0;
230 item = path_list_append(name, &states->stale);
231 item->util = xstrdup(refname);
233 return 0;
236 static int get_ref_states(const struct ref *ref, struct ref_states *states)
238 struct ref *fetch_map = NULL, **tail = &fetch_map;
239 int i;
241 for (i = 0; i < states->remote->fetch_refspec_nr; i++)
242 if (get_fetch_map(ref, states->remote->fetch + i, &tail, 1))
243 die("Could not get fetch map for refspec %s",
244 states->remote->fetch_refspec[i]);
246 states->new.strdup_paths = states->tracked.strdup_paths = 1;
247 for (ref = fetch_map; ref; ref = ref->next) {
248 struct path_list *target = &states->tracked;
249 unsigned char sha1[20];
250 void *util = NULL;
252 if (!ref->peer_ref || read_ref(ref->peer_ref->name, sha1))
253 target = &states->new;
254 else {
255 target = &states->tracked;
256 if (hashcmp(sha1, ref->new_sha1))
257 util = &states;
259 path_list_append(skip_prefix(ref->name, "refs/heads/"),
260 target)->util = util;
262 free_refs(fetch_map);
264 for_each_ref(handle_one_branch, states);
265 sort_path_list(&states->stale);
267 return 0;
270 struct branches_for_remote {
271 const char *prefix;
272 struct path_list *branches;
275 static int add_branch_for_removal(const char *refname,
276 const unsigned char *sha1, int flags, void *cb_data)
278 struct branches_for_remote *branches = cb_data;
280 if (!prefixcmp(refname, branches->prefix)) {
281 struct path_list_item *item;
283 /* make sure that symrefs are deleted */
284 if (flags & REF_ISSYMREF)
285 return unlink(git_path(refname));
287 item = path_list_append(refname, branches->branches);
288 item->util = xmalloc(20);
289 hashcpy(item->util, sha1);
292 return 0;
295 static int remove_branches(struct path_list *branches)
297 int i, result = 0;
298 for (i = 0; i < branches->nr; i++) {
299 struct path_list_item *item = branches->items + i;
300 const char *refname = item->path;
301 unsigned char *sha1 = item->util;
303 if (delete_ref(refname, sha1))
304 result |= error("Could not remove branch %s", refname);
306 return result;
309 static int rm(int argc, const char **argv)
311 struct option options[] = {
312 OPT_END()
314 struct remote *remote;
315 struct strbuf buf;
316 struct path_list branches = { NULL, 0, 0, 1 };
317 struct branches_for_remote cb_data = { NULL, &branches };
318 int i;
320 if (argc != 2)
321 usage_with_options(builtin_remote_usage, options);
323 remote = remote_get(argv[1]);
324 if (!remote)
325 die("No such remote: %s", argv[1]);
327 strbuf_init(&buf, 0);
328 strbuf_addf(&buf, "remote.%s", remote->name);
329 if (git_config_rename_section(buf.buf, NULL) < 1)
330 return error("Could not remove config section '%s'", buf.buf);
332 read_branches();
333 for (i = 0; i < branch_list.nr; i++) {
334 struct path_list_item *item = branch_list.items + i;
335 struct branch_info *info = item->util;
336 if (info->remote && !strcmp(info->remote, remote->name)) {
337 const char *keys[] = { "remote", "merge", NULL }, **k;
338 for (k = keys; *k; k++) {
339 strbuf_reset(&buf);
340 strbuf_addf(&buf, "branch.%s.%s",
341 item->path, *k);
342 if (git_config_set(buf.buf, NULL)) {
343 strbuf_release(&buf);
344 return -1;
351 * We cannot just pass a function to for_each_ref() which deletes
352 * the branches one by one, since for_each_ref() relies on cached
353 * refs, which are invalidated when deleting a branch.
355 strbuf_reset(&buf);
356 strbuf_addf(&buf, "refs/remotes/%s/", remote->name);
357 cb_data.prefix = buf.buf;
358 i = for_each_ref(add_branch_for_removal, &cb_data);
359 strbuf_release(&buf);
361 if (!i)
362 i = remove_branches(&branches);
363 path_list_clear(&branches, 1);
365 return i;
368 static void show_list(const char *title, struct path_list *list)
370 int i;
372 if (!list->nr)
373 return;
375 printf(title, list->nr > 1 ? "es" : "");
376 printf("\n ");
377 for (i = 0; i < list->nr; i++)
378 printf("%s%s", i ? " " : "", list->items[i].path);
379 printf("\n");
382 static int show_or_prune(int argc, const char **argv, int prune)
384 int dry_run = 0, result = 0;
385 struct option options[] = {
386 OPT_GROUP("show specific options"),
387 OPT__DRY_RUN(&dry_run),
388 OPT_END()
390 struct ref_states states;
392 argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
394 if (argc < 1) {
395 if (!prune)
396 return show_all();
397 usage_with_options(builtin_remote_usage, options);
400 memset(&states, 0, sizeof(states));
401 for (; argc; argc--, argv++) {
402 struct transport *transport;
403 const struct ref *ref;
404 struct strbuf buf;
405 int i, got_states;
407 states.remote = remote_get(*argv);
408 if (!states.remote)
409 return error("No such remote: %s", *argv);
410 transport = transport_get(NULL, states.remote->url_nr > 0 ?
411 states.remote->url[0] : NULL);
412 ref = transport_get_remote_refs(transport);
413 transport_disconnect(transport);
415 read_branches();
416 got_states = get_ref_states(ref, &states);
417 if (got_states)
418 result = error("Error getting local info for '%s'",
419 states.remote->name);
421 if (prune) {
422 for (i = 0; i < states.stale.nr; i++) {
423 const char *refname = states.stale.items[i].util;
424 result |= delete_ref(refname, NULL);
426 goto cleanup_states;
429 printf("* remote %s\n URL: %s\n", *argv,
430 states.remote->url_nr > 0 ?
431 states.remote->url[0] : "(no URL)");
433 for (i = 0; i < branch_list.nr; i++) {
434 struct path_list_item *branch = branch_list.items + i;
435 struct branch_info *info = branch->util;
436 int j;
438 if (!info->merge.nr || strcmp(*argv, info->remote))
439 continue;
440 printf(" Remote branch%s merged with 'git pull' "
441 "while on branch %s\n ",
442 info->merge.nr > 1 ? "es" : "",
443 branch->path);
444 for (j = 0; j < info->merge.nr; j++)
445 printf(" %s", info->merge.items[j].path);
446 printf("\n");
449 if (got_states)
450 continue;
451 strbuf_init(&buf, 0);
452 strbuf_addf(&buf, " New remote branch%%s (next fetch will "
453 "store in remotes/%s)", states.remote->name);
454 show_list(buf.buf, &states.new);
455 strbuf_release(&buf);
456 show_list(" Stale tracking branch%s (use 'git remote prune')",
457 &states.stale);
458 show_list(" Tracked remote branch%s",
459 &states.tracked);
461 if (states.remote->push_refspec_nr) {
462 printf(" Local branch%s pushed with 'git push'\n ",
463 states.remote->push_refspec_nr > 1 ?
464 "es" : "");
465 for (i = 0; i < states.remote->push_refspec_nr; i++) {
466 struct refspec *spec = states.remote->push + i;
467 printf(" %s%s%s%s", spec->force ? "+" : "",
468 skip_prefix(spec->src, "refs/heads/"),
469 spec->dst ? ":" : "",
470 skip_prefix(spec->dst, "refs/heads/"));
472 printf("\n");
474 cleanup_states:
475 /* NEEDSWORK: free remote */
476 path_list_clear(&states.new, 0);
477 path_list_clear(&states.stale, 0);
478 path_list_clear(&states.tracked, 0);
481 return result;
484 static int get_one_remote_for_update(struct remote *remote, void *priv)
486 struct path_list *list = priv;
487 if (!remote->skip_default_update)
488 path_list_append(xstrdup(remote->name), list);
489 return 0;
492 struct remote_group {
493 const char *name;
494 struct path_list *list;
495 } remote_group;
497 static int get_remote_group(const char *key, const char *value, void *cb)
499 if (!prefixcmp(key, "remotes.") &&
500 !strcmp(key + 8, remote_group.name)) {
501 /* split list by white space */
502 int space = strcspn(value, " \t\n");
503 while (*value) {
504 if (space > 1)
505 path_list_append(xstrndup(value, space),
506 remote_group.list);
507 value += space + (value[space] != '\0');
508 space = strcspn(value, " \t\n");
512 return 0;
515 static int update(int argc, const char **argv)
517 int i, result = 0;
518 struct path_list list = { NULL, 0, 0, 0 };
519 static const char *default_argv[] = { NULL, "default", NULL };
521 if (argc < 2) {
522 argc = 2;
523 argv = default_argv;
526 remote_group.list = &list;
527 for (i = 1; i < argc; i++) {
528 remote_group.name = argv[i];
529 result = git_config(get_remote_group, NULL);
532 if (!result && !list.nr && argc == 2 && !strcmp(argv[1], "default"))
533 result = for_each_remote(get_one_remote_for_update, &list);
535 for (i = 0; i < list.nr; i++)
536 result |= fetch_remote(list.items[i].path);
538 /* all names were strdup()ed or strndup()ed */
539 list.strdup_paths = 1;
540 path_list_clear(&list, 0);
542 return result;
545 static int get_one_entry(struct remote *remote, void *priv)
547 struct path_list *list = priv;
549 path_list_append(remote->name, list)->util = remote->url_nr ?
550 (void *)remote->url[0] : NULL;
551 if (remote->url_nr > 1)
552 warning("Remote %s has more than one URL", remote->name);
554 return 0;
557 static int show_all(void)
559 struct path_list list = { NULL, 0, 0 };
560 int result = for_each_remote(get_one_entry, &list);
562 if (!result) {
563 int i;
565 sort_path_list(&list);
566 for (i = 0; i < list.nr; i++) {
567 struct path_list_item *item = list.items + i;
568 printf("%s%s%s\n", item->path,
569 verbose ? "\t" : "",
570 verbose && item->util ?
571 (const char *)item->util : "");
574 return result;
577 int cmd_remote(int argc, const char **argv, const char *prefix)
579 struct option options[] = {
580 OPT__VERBOSE(&verbose),
581 OPT_END()
583 int result;
585 argc = parse_options(argc, argv, options, builtin_remote_usage,
586 PARSE_OPT_STOP_AT_NON_OPTION);
588 if (argc < 1)
589 result = show_all();
590 else if (!strcmp(argv[0], "add"))
591 result = add(argc, argv);
592 else if (!strcmp(argv[0], "rm"))
593 result = rm(argc, argv);
594 else if (!strcmp(argv[0], "show"))
595 result = show_or_prune(argc, argv, 0);
596 else if (!strcmp(argv[0], "prune"))
597 result = show_or_prune(argc, argv, 1);
598 else if (!strcmp(argv[0], "update"))
599 result = update(argc, argv);
600 else {
601 error("Unknown subcommand: %s", argv[0]);
602 usage_with_options(builtin_remote_usage, options);
605 return result ? 1 : 0;