gitweb: use new Git::Repo API, and add optional caching
[git/gitweb-caching.git] / builtin-remote.c
blob01945a8651c9a42f19fba850036ed2a1339675f1
1 #include "cache.h"
2 #include "parse-options.h"
3 #include "transport.h"
4 #include "remote.h"
5 #include "string-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 int opt_parse_track(const struct option *opt, const char *arg, int not)
34 struct string_list *list = opt->value;
35 if (not)
36 string_list_clear(list, 0);
37 else
38 string_list_append(arg, list);
39 return 0;
42 static int fetch_remote(const char *name)
44 const char *argv[] = { "fetch", name, NULL };
45 printf("Updating %s\n", name);
46 if (run_command_v_opt(argv, RUN_GIT_CMD))
47 return error("Could not fetch %s", name);
48 return 0;
51 static int add(int argc, const char **argv)
53 int fetch = 0, mirror = 0;
54 struct string_list track = { NULL, 0, 0 };
55 const char *master = NULL;
56 struct remote *remote;
57 struct strbuf buf, buf2;
58 const char *name, *url;
59 int i;
61 struct option options[] = {
62 OPT_GROUP("add specific options"),
63 OPT_BOOLEAN('f', "fetch", &fetch, "fetch the remote branches"),
64 OPT_CALLBACK('t', "track", &track, "branch",
65 "branch(es) to track", opt_parse_track),
66 OPT_STRING('m', "master", &master, "branch", "master branch"),
67 OPT_BOOLEAN(0, "mirror", &mirror, "no separate remotes"),
68 OPT_END()
71 argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
73 if (argc < 2)
74 usage_with_options(builtin_remote_usage, options);
76 name = argv[0];
77 url = argv[1];
79 remote = remote_get(name);
80 if (remote && (remote->url_nr > 1 || strcmp(name, remote->url[0]) ||
81 remote->fetch_refspec_nr))
82 die("remote %s already exists.", name);
84 strbuf_init(&buf, 0);
85 strbuf_init(&buf2, 0);
87 strbuf_addf(&buf2, "refs/heads/test:refs/remotes/%s/test", name);
88 if (!valid_fetch_refspec(buf2.buf))
89 die("'%s' is not a valid remote name", name);
91 strbuf_addf(&buf, "remote.%s.url", name);
92 if (git_config_set(buf.buf, url))
93 return 1;
95 strbuf_reset(&buf);
96 strbuf_addf(&buf, "remote.%s.fetch", name);
98 if (track.nr == 0)
99 string_list_append("*", &track);
100 for (i = 0; i < track.nr; i++) {
101 struct string_list_item *item = track.items + i;
103 strbuf_reset(&buf2);
104 strbuf_addch(&buf2, '+');
105 if (mirror)
106 strbuf_addf(&buf2, "refs/%s:refs/%s",
107 item->string, item->string);
108 else
109 strbuf_addf(&buf2, "refs/heads/%s:refs/remotes/%s/%s",
110 item->string, name, item->string);
111 if (git_config_set_multivar(buf.buf, buf2.buf, "^$", 0))
112 return 1;
115 if (mirror) {
116 strbuf_reset(&buf);
117 strbuf_addf(&buf, "remote.%s.mirror", name);
118 if (git_config_set(buf.buf, "true"))
119 return 1;
122 if (fetch && fetch_remote(name))
123 return 1;
125 if (master) {
126 strbuf_reset(&buf);
127 strbuf_addf(&buf, "refs/remotes/%s/HEAD", name);
129 strbuf_reset(&buf2);
130 strbuf_addf(&buf2, "refs/remotes/%s/%s", name, master);
132 if (create_symref(buf.buf, buf2.buf, "remote add"))
133 return error("Could not setup master '%s'", master);
136 strbuf_release(&buf);
137 strbuf_release(&buf2);
138 string_list_clear(&track, 0);
140 return 0;
143 struct branch_info {
144 char *remote;
145 struct string_list merge;
148 static struct string_list branch_list;
150 static const char *abbrev_ref(const char *name, const char *prefix)
152 const char *abbrev = skip_prefix(name, prefix);
153 if (abbrev)
154 return abbrev;
155 return name;
157 #define abbrev_branch(name) abbrev_ref((name), "refs/heads/")
159 static int config_read_branches(const char *key, const char *value, void *cb)
161 if (!prefixcmp(key, "branch.")) {
162 char *name;
163 struct string_list_item *item;
164 struct branch_info *info;
165 enum { REMOTE, MERGE } type;
167 key += 7;
168 if (!postfixcmp(key, ".remote")) {
169 name = xstrndup(key, strlen(key) - 7);
170 type = REMOTE;
171 } else if (!postfixcmp(key, ".merge")) {
172 name = xstrndup(key, strlen(key) - 6);
173 type = MERGE;
174 } else
175 return 0;
177 item = string_list_insert(name, &branch_list);
179 if (!item->util)
180 item->util = xcalloc(sizeof(struct branch_info), 1);
181 info = item->util;
182 if (type == REMOTE) {
183 if (info->remote)
184 warning("more than one branch.%s", key);
185 info->remote = xstrdup(value);
186 } else {
187 char *space = strchr(value, ' ');
188 value = abbrev_branch(value);
189 while (space) {
190 char *merge;
191 merge = xstrndup(value, space - value);
192 string_list_append(merge, &info->merge);
193 value = abbrev_branch(space + 1);
194 space = strchr(value, ' ');
196 string_list_append(xstrdup(value), &info->merge);
199 return 0;
202 static void read_branches(void)
204 if (branch_list.nr)
205 return;
206 git_config(config_read_branches, NULL);
207 sort_string_list(&branch_list);
210 struct ref_states {
211 struct remote *remote;
212 struct string_list new, stale, tracked;
215 static int handle_one_branch(const char *refname,
216 const unsigned char *sha1, int flags, void *cb_data)
218 struct ref_states *states = cb_data;
219 struct refspec refspec;
221 memset(&refspec, 0, sizeof(refspec));
222 refspec.dst = (char *)refname;
223 if (!remote_find_tracking(states->remote, &refspec)) {
224 struct string_list_item *item;
225 const char *name = abbrev_branch(refspec.src);
226 /* symbolic refs pointing nowhere were handled already */
227 if ((flags & REF_ISSYMREF) ||
228 unsorted_string_list_has_string(&states->tracked,
229 name) ||
230 unsorted_string_list_has_string(&states->new,
231 name))
232 return 0;
233 item = string_list_append(name, &states->stale);
234 item->util = xstrdup(refname);
236 return 0;
239 static int get_ref_states(const struct ref *ref, struct ref_states *states)
241 struct ref *fetch_map = NULL, **tail = &fetch_map;
242 int i;
244 for (i = 0; i < states->remote->fetch_refspec_nr; i++)
245 if (get_fetch_map(ref, states->remote->fetch + i, &tail, 1))
246 die("Could not get fetch map for refspec %s",
247 states->remote->fetch_refspec[i]);
249 states->new.strdup_strings = states->tracked.strdup_strings = 1;
250 for (ref = fetch_map; ref; ref = ref->next) {
251 struct string_list *target = &states->tracked;
252 unsigned char sha1[20];
253 void *util = NULL;
255 if (!ref->peer_ref || read_ref(ref->peer_ref->name, sha1))
256 target = &states->new;
257 else {
258 target = &states->tracked;
259 if (hashcmp(sha1, ref->new_sha1))
260 util = &states;
262 string_list_append(abbrev_branch(ref->name), target)->util = util;
264 free_refs(fetch_map);
266 for_each_ref(handle_one_branch, states);
267 sort_string_list(&states->stale);
269 return 0;
272 struct known_remote {
273 struct known_remote *next;
274 struct remote *remote;
277 struct known_remotes {
278 struct remote *to_delete;
279 struct known_remote *list;
282 static int add_known_remote(struct remote *remote, void *cb_data)
284 struct known_remotes *all = cb_data;
285 struct known_remote *r;
287 if (!strcmp(all->to_delete->name, remote->name))
288 return 0;
290 r = xmalloc(sizeof(*r));
291 r->remote = remote;
292 r->next = all->list;
293 all->list = r;
294 return 0;
297 struct branches_for_remote {
298 struct remote *remote;
299 struct string_list *branches;
300 struct known_remotes *keep;
303 static int add_branch_for_removal(const char *refname,
304 const unsigned char *sha1, int flags, void *cb_data)
306 struct branches_for_remote *branches = cb_data;
307 struct refspec refspec;
308 struct string_list_item *item;
309 struct known_remote *kr;
311 memset(&refspec, 0, sizeof(refspec));
312 refspec.dst = (char *)refname;
313 if (remote_find_tracking(branches->remote, &refspec))
314 return 0;
316 /* don't delete a branch if another remote also uses it */
317 for (kr = branches->keep->list; kr; kr = kr->next) {
318 memset(&refspec, 0, sizeof(refspec));
319 refspec.dst = (char *)refname;
320 if (!remote_find_tracking(kr->remote, &refspec))
321 return 0;
324 /* make sure that symrefs are deleted */
325 if (flags & REF_ISSYMREF)
326 return unlink(git_path(refname));
328 item = string_list_append(refname, branches->branches);
329 item->util = xmalloc(20);
330 hashcpy(item->util, sha1);
332 return 0;
335 static int remove_branches(struct string_list *branches)
337 int i, result = 0;
338 for (i = 0; i < branches->nr; i++) {
339 struct string_list_item *item = branches->items + i;
340 const char *refname = item->string;
341 unsigned char *sha1 = item->util;
343 if (delete_ref(refname, sha1))
344 result |= error("Could not remove branch %s", refname);
346 return result;
349 static int rm(int argc, const char **argv)
351 struct option options[] = {
352 OPT_END()
354 struct remote *remote;
355 struct strbuf buf;
356 struct known_remotes known_remotes = { NULL, NULL };
357 struct string_list branches = { NULL, 0, 0, 1 };
358 struct branches_for_remote cb_data = { NULL, &branches, &known_remotes };
359 int i;
361 if (argc != 2)
362 usage_with_options(builtin_remote_usage, options);
364 remote = remote_get(argv[1]);
365 if (!remote)
366 die("No such remote: %s", argv[1]);
368 known_remotes.to_delete = remote;
369 for_each_remote(add_known_remote, &known_remotes);
371 strbuf_init(&buf, 0);
372 strbuf_addf(&buf, "remote.%s", remote->name);
373 if (git_config_rename_section(buf.buf, NULL) < 1)
374 return error("Could not remove config section '%s'", buf.buf);
376 read_branches();
377 for (i = 0; i < branch_list.nr; i++) {
378 struct string_list_item *item = branch_list.items + i;
379 struct branch_info *info = item->util;
380 if (info->remote && !strcmp(info->remote, remote->name)) {
381 const char *keys[] = { "remote", "merge", NULL }, **k;
382 for (k = keys; *k; k++) {
383 strbuf_reset(&buf);
384 strbuf_addf(&buf, "branch.%s.%s",
385 item->string, *k);
386 if (git_config_set(buf.buf, NULL)) {
387 strbuf_release(&buf);
388 return -1;
395 * We cannot just pass a function to for_each_ref() which deletes
396 * the branches one by one, since for_each_ref() relies on cached
397 * refs, which are invalidated when deleting a branch.
399 cb_data.remote = remote;
400 i = for_each_ref(add_branch_for_removal, &cb_data);
401 strbuf_release(&buf);
403 if (!i)
404 i = remove_branches(&branches);
405 string_list_clear(&branches, 1);
407 return i;
410 static void show_list(const char *title, struct string_list *list)
412 int i;
414 if (!list->nr)
415 return;
417 printf(title, list->nr > 1 ? "es" : "");
418 printf("\n ");
419 for (i = 0; i < list->nr; i++)
420 printf("%s%s", i ? " " : "", list->items[i].string);
421 printf("\n");
424 static int get_remote_ref_states(const char *name,
425 struct ref_states *states,
426 int query)
428 struct transport *transport;
429 const struct ref *ref;
431 states->remote = remote_get(name);
432 if (!states->remote)
433 return error("No such remote: %s", name);
435 read_branches();
437 if (query) {
438 transport = transport_get(NULL, states->remote->url_nr > 0 ?
439 states->remote->url[0] : NULL);
440 ref = transport_get_remote_refs(transport);
441 transport_disconnect(transport);
443 get_ref_states(ref, states);
446 return 0;
449 static int append_ref_to_tracked_list(const char *refname,
450 const unsigned char *sha1, int flags, void *cb_data)
452 struct ref_states *states = cb_data;
453 struct refspec refspec;
455 memset(&refspec, 0, sizeof(refspec));
456 refspec.dst = (char *)refname;
457 if (!remote_find_tracking(states->remote, &refspec))
458 string_list_append(abbrev_branch(refspec.src), &states->tracked);
460 return 0;
463 static int show(int argc, const char **argv)
465 int no_query = 0, result = 0;
466 struct option options[] = {
467 OPT_GROUP("show specific options"),
468 OPT_BOOLEAN('n', NULL, &no_query, "do not query remotes"),
469 OPT_END()
471 struct ref_states states;
473 argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
475 if (argc < 1)
476 return show_all();
478 memset(&states, 0, sizeof(states));
479 for (; argc; argc--, argv++) {
480 struct strbuf buf;
481 int i;
483 get_remote_ref_states(*argv, &states, !no_query);
485 printf("* remote %s\n URL: %s\n", *argv,
486 states.remote->url_nr > 0 ?
487 states.remote->url[0] : "(no URL)");
489 for (i = 0; i < branch_list.nr; i++) {
490 struct string_list_item *branch = branch_list.items + i;
491 struct branch_info *info = branch->util;
492 int j;
494 if (!info->merge.nr || strcmp(*argv, info->remote))
495 continue;
496 printf(" Remote branch%s merged with 'git pull' "
497 "while on branch %s\n ",
498 info->merge.nr > 1 ? "es" : "",
499 branch->string);
500 for (j = 0; j < info->merge.nr; j++)
501 printf(" %s", info->merge.items[j].string);
502 printf("\n");
505 if (!no_query) {
506 strbuf_init(&buf, 0);
507 strbuf_addf(&buf, " New remote branch%%s (next fetch "
508 "will store in remotes/%s)", states.remote->name);
509 show_list(buf.buf, &states.new);
510 strbuf_release(&buf);
511 show_list(" Stale tracking branch%s (use 'git remote "
512 "prune')", &states.stale);
515 if (no_query)
516 for_each_ref(append_ref_to_tracked_list, &states);
517 show_list(" Tracked remote branch%s", &states.tracked);
519 if (states.remote->push_refspec_nr) {
520 printf(" Local branch%s pushed with 'git push'\n ",
521 states.remote->push_refspec_nr > 1 ?
522 "es" : "");
523 for (i = 0; i < states.remote->push_refspec_nr; i++) {
524 struct refspec *spec = states.remote->push + i;
525 printf(" %s%s%s%s", spec->force ? "+" : "",
526 abbrev_branch(spec->src),
527 spec->dst ? ":" : "",
528 spec->dst ? abbrev_branch(spec->dst) : "");
530 printf("\n");
533 /* NEEDSWORK: free remote */
534 string_list_clear(&states.new, 0);
535 string_list_clear(&states.stale, 0);
536 string_list_clear(&states.tracked, 0);
539 return result;
542 static int prune(int argc, const char **argv)
544 int dry_run = 0, result = 0;
545 struct option options[] = {
546 OPT_GROUP("prune specific options"),
547 OPT__DRY_RUN(&dry_run),
548 OPT_END()
550 struct ref_states states;
552 argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
554 if (argc < 1)
555 usage_with_options(builtin_remote_usage, options);
557 memset(&states, 0, sizeof(states));
558 for (; argc; argc--, argv++) {
559 int i;
561 get_remote_ref_states(*argv, &states, 1);
563 if (states.stale.nr) {
564 printf("Pruning %s\n", *argv);
565 printf("URL: %s\n",
566 states.remote->url_nr
567 ? states.remote->url[0]
568 : "(no URL)");
571 for (i = 0; i < states.stale.nr; i++) {
572 const char *refname = states.stale.items[i].util;
574 if (!dry_run)
575 result |= delete_ref(refname, NULL);
577 printf(" * [%s] %s\n", dry_run ? "would prune" : "pruned",
578 abbrev_ref(refname, "refs/remotes/"));
581 /* NEEDSWORK: free remote */
582 string_list_clear(&states.new, 0);
583 string_list_clear(&states.stale, 0);
584 string_list_clear(&states.tracked, 0);
587 return result;
590 static int get_one_remote_for_update(struct remote *remote, void *priv)
592 struct string_list *list = priv;
593 if (!remote->skip_default_update)
594 string_list_append(xstrdup(remote->name), list);
595 return 0;
598 struct remote_group {
599 const char *name;
600 struct string_list *list;
601 } remote_group;
603 static int get_remote_group(const char *key, const char *value, void *cb)
605 if (!prefixcmp(key, "remotes.") &&
606 !strcmp(key + 8, remote_group.name)) {
607 /* split list by white space */
608 int space = strcspn(value, " \t\n");
609 while (*value) {
610 if (space > 1)
611 string_list_append(xstrndup(value, space),
612 remote_group.list);
613 value += space + (value[space] != '\0');
614 space = strcspn(value, " \t\n");
618 return 0;
621 static int update(int argc, const char **argv)
623 int i, result = 0;
624 struct string_list list = { NULL, 0, 0, 0 };
625 static const char *default_argv[] = { NULL, "default", NULL };
627 if (argc < 2) {
628 argc = 2;
629 argv = default_argv;
632 remote_group.list = &list;
633 for (i = 1; i < argc; i++) {
634 remote_group.name = argv[i];
635 result = git_config(get_remote_group, NULL);
638 if (!result && !list.nr && argc == 2 && !strcmp(argv[1], "default"))
639 result = for_each_remote(get_one_remote_for_update, &list);
641 for (i = 0; i < list.nr; i++)
642 result |= fetch_remote(list.items[i].string);
644 /* all names were strdup()ed or strndup()ed */
645 list.strdup_strings = 1;
646 string_list_clear(&list, 0);
648 return result;
651 static int get_one_entry(struct remote *remote, void *priv)
653 struct string_list *list = priv;
655 string_list_append(remote->name, list)->util = remote->url_nr ?
656 (void *)remote->url[0] : NULL;
657 if (remote->url_nr > 1)
658 warning("Remote %s has more than one URL", remote->name);
660 return 0;
663 static int show_all(void)
665 struct string_list list = { NULL, 0, 0 };
666 int result = for_each_remote(get_one_entry, &list);
668 if (!result) {
669 int i;
671 sort_string_list(&list);
672 for (i = 0; i < list.nr; i++) {
673 struct string_list_item *item = list.items + i;
674 printf("%s%s%s\n", item->string,
675 verbose ? "\t" : "",
676 verbose && item->util ?
677 (const char *)item->util : "");
680 return result;
683 int cmd_remote(int argc, const char **argv, const char *prefix)
685 struct option options[] = {
686 OPT__VERBOSE(&verbose),
687 OPT_END()
689 int result;
691 argc = parse_options(argc, argv, options, builtin_remote_usage,
692 PARSE_OPT_STOP_AT_NON_OPTION);
694 if (argc < 1)
695 result = show_all();
696 else if (!strcmp(argv[0], "add"))
697 result = add(argc, argv);
698 else if (!strcmp(argv[0], "rm"))
699 result = rm(argc, argv);
700 else if (!strcmp(argv[0], "show"))
701 result = show(argc, argv);
702 else if (!strcmp(argv[0], "prune"))
703 result = prune(argc, argv);
704 else if (!strcmp(argv[0], "update"))
705 result = update(argc, argv);
706 else {
707 error("Unknown subcommand: %s", argv[0]);
708 usage_with_options(builtin_remote_usage, options);
711 return result ? 1 : 0;