builtin-remote.c

   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"
   9
  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
  18 };
  19
  20 static int verbose;
  21
  22 static int show_all(void);
  23
  24 static inline int postfixcmp(const char *string, const char *postfix)
  25 {
  26         int len1 = strlen(string), len2 = strlen(postfix);
  27         if (len1 < len2)
  28                 return 1;
  29         return strcmp(string + len1 - len2, postfix);
  30 }
  31
  32 static inline const char *skip_prefix(const char *name, const char *prefix)
  33 {
  34         return !name ? "" :
  35                 prefixcmp(name, prefix) ?  name : name + strlen(prefix);
  36 }
  37
  38 static int opt_parse_track(const struct option *opt, const char *arg, int not)
  39 {
  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;
  46 }
  47
  48 static int fetch_remote(const char *name)
  49 {
  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;
  55 }
  56
  57 static int add(int argc, const char **argv)
  58 {
  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;
  66
  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()
  75         };
  76
  77         argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
  78
  79         if (argc < 2)
  80                 usage_with_options(builtin_remote_usage, options);
  81
  82         name = argv[0];
  83         url = argv[1];
  84
  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);
  89
  90         strbuf_init(&buf, 0);
  91         strbuf_init(&buf2, 0);
  92
  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);
  96
  97         strbuf_addf(&buf, "remote.%s.url", name);
  98         if (git_config_set(buf.buf, url))
  99                 return 1;
 100
 101         strbuf_reset(&buf);
 102         strbuf_addf(&buf, "remote.%s.fetch", name);
 103
 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;
 108
 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;
 119         }
 120
 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;
 126         }
 127
 128         if (fetch && fetch_remote(name))
 129                 return 1;
 130
 131         if (master) {
 132                 strbuf_reset(&buf);
 133                 strbuf_addf(&buf, "refs/remotes/%s/HEAD", name);
 134
 135                 strbuf_reset(&buf2);
 136                 strbuf_addf(&buf2, "refs/remotes/%s/%s", name, master);
 137
 138                 if (create_symref(buf.buf, buf2.buf, "remote add"))
 139                         return error("Could not setup master '%s'", master);
 140         }
 141
 142         strbuf_release(&buf);
 143         strbuf_release(&buf2);
 144         path_list_clear(&track, 0);
 145
 146         return 0;
 147 }
 148
 149 struct branch_info {
 150         char *remote;
 151         struct path_list merge;
 152 };
 153
 154 static struct path_list branch_list;
 155
 156 static int config_read_branches(const char *key, const char *value, void *cb)
 157 {
 158         if (!prefixcmp(key, "branch.")) {
 159                 char *name;
 160                 struct path_list_item *item;
 161                 struct branch_info *info;
 162                 enum { REMOTE, MERGE } type;
 163
 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;
 173
 174                 item = path_list_insert(name, &branch_list);
 175
 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, ' ');
 192                         }
 193                         path_list_append(xstrdup(value), &info->merge);
 194                 }
 195         }
 196         return 0;
 197 }
 198
 199 static void read_branches(void)
 200 {
 201         if (branch_list.nr)
 202                 return;
 203         git_config(config_read_branches, NULL);
 204         sort_path_list(&branch_list);
 205 }
 206
 207 struct ref_states {
 208         struct remote *remote;
 209         struct path_list new, stale, tracked;
 210 };
 211
 212 static int handle_one_branch(const char *refname,
 213         const unsigned char *sha1, int flags, void *cb_data)
 214 {
 215         struct ref_states *states = cb_data;
 216         struct refspec refspec;
 217
 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);
 232         }
 233         return 0;
 234 }
 235
 236 static int get_ref_states(const struct ref *ref, struct ref_states *states)
 237 {
 238         struct ref *fetch_map = NULL, **tail = &fetch_map;
 239         int i;
 240
 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]);
 245
 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;
 251
 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;
 258                 }
 259                 path_list_append(skip_prefix(ref->name, "refs/heads/"),
 260                                 target)->util = util;
 261         }
 262         free_refs(fetch_map);
 263
 264         for_each_ref(handle_one_branch, states);
 265         sort_path_list(&states->stale);
 266
 267         return 0;
 268 }
 269
 270 struct known_remote {
 271         struct known_remote *next;
 272         struct remote *remote;
 273 };
 274
 275 struct known_remotes {
 276         struct remote *to_delete;
 277         struct known_remote *list;
 278 };
 279
 280 static int add_known_remote(struct remote *remote, void *cb_data)
 281 {
 282         struct known_remotes *all = cb_data;
 283         struct known_remote *r;
 284
 285         if (!strcmp(all->to_delete->name, remote->name))
 286                 return 0;
 287
 288         r = xmalloc(sizeof(*r));
 289         r->remote = remote;
 290         r->next = all->list;
 291         all->list = r;
 292         return 0;
 293 }
 294
 295 struct branches_for_remote {
 296         struct remote *remote;
 297         struct path_list *branches;
 298         struct known_remotes *keep;
 299 };
 300
 301 static int add_branch_for_removal(const char *refname,
 302         const unsigned char *sha1, int flags, void *cb_data)
 303 {
 304         struct branches_for_remote *branches = cb_data;
 305         struct refspec refspec;
 306         struct path_list_item *item;
 307         struct known_remote *kr;
 308
 309         memset(&refspec, 0, sizeof(refspec));
 310         refspec.dst = (char *)refname;
 311         if (remote_find_tracking(branches->remote, &refspec))
 312                 return 0;
 313
 314         /* don't delete a branch if another remote also uses it */
 315         for (kr = branches->keep->list; kr; kr = kr->next) {
 316                 memset(&refspec, 0, sizeof(refspec));
 317                 refspec.dst = (char *)refname;
 318                 if (!remote_find_tracking(kr->remote, &refspec))
 319                         return 0;
 320         }
 321
 322         /* make sure that symrefs are deleted */
 323         if (flags & REF_ISSYMREF)
 324                 return unlink(git_path(refname));
 325
 326         item = path_list_append(refname, branches->branches);
 327         item->util = xmalloc(20);
 328         hashcpy(item->util, sha1);
 329
 330         return 0;
 331 }
 332
 333 static int remove_branches(struct path_list *branches)
 334 {
 335         int i, result = 0;
 336         for (i = 0; i < branches->nr; i++) {
 337                 struct path_list_item *item = branches->items + i;
 338                 const char *refname = item->path;
 339                 unsigned char *sha1 = item->util;
 340
 341                 if (delete_ref(refname, sha1))
 342                         result |= error("Could not remove branch %s", refname);
 343         }
 344         return result;
 345 }
 346
 347 static int rm(int argc, const char **argv)
 348 {
 349         struct option options[] = {
 350                 OPT_END()
 351         };
 352         struct remote *remote;
 353         struct strbuf buf;
 354         struct known_remotes known_remotes = { NULL, NULL };
 355         struct path_list branches = { NULL, 0, 0, 1 };
 356         struct branches_for_remote cb_data = { NULL, &branches, &known_remotes };
 357         int i;
 358
 359         if (argc != 2)
 360                 usage_with_options(builtin_remote_usage, options);
 361
 362         remote = remote_get(argv[1]);
 363         if (!remote)
 364                 die("No such remote: %s", argv[1]);
 365
 366         known_remotes.to_delete = remote;
 367         for_each_remote(add_known_remote, &known_remotes);
 368
 369         strbuf_init(&buf, 0);
 370         strbuf_addf(&buf, "remote.%s", remote->name);
 371         if (git_config_rename_section(buf.buf, NULL) < 1)
 372                 return error("Could not remove config section '%s'", buf.buf);
 373
 374         read_branches();
 375         for (i = 0; i < branch_list.nr; i++) {
 376                 struct path_list_item *item = branch_list.items + i;
 377                 struct branch_info *info = item->util;
 378                 if (info->remote && !strcmp(info->remote, remote->name)) {
 379                         const char *keys[] = { "remote", "merge", NULL }, **k;
 380                         for (k = keys; *k; k++) {
 381                                 strbuf_reset(&buf);
 382                                 strbuf_addf(&buf, "branch.%s.%s",
 383                                                 item->path, *k);
 384                                 if (git_config_set(buf.buf, NULL)) {
 385                                         strbuf_release(&buf);
 386                                         return -1;
 387                                 }
 388                         }
 389                 }
 390         }
 391
 392         /*
 393          * We cannot just pass a function to for_each_ref() which deletes
 394          * the branches one by one, since for_each_ref() relies on cached
 395          * refs, which are invalidated when deleting a branch.
 396          */
 397         cb_data.remote = remote;
 398         i = for_each_ref(add_branch_for_removal, &cb_data);
 399         strbuf_release(&buf);
 400
 401         if (!i)
 402                 i = remove_branches(&branches);
 403         path_list_clear(&branches, 1);
 404
 405         return i;
 406 }
 407
 408 static void show_list(const char *title, struct path_list *list)
 409 {
 410         int i;
 411
 412         if (!list->nr)
 413                 return;
 414
 415         printf(title, list->nr > 1 ? "es" : "");
 416         printf("\n    ");
 417         for (i = 0; i < list->nr; i++)
 418                 printf("%s%s", i ? " " : "", list->items[i].path);
 419         printf("\n");
 420 }
 421
 422 static int get_remote_ref_states(const char *name,
 423                                  struct ref_states *states,
 424                                  int query)
 425 {
 426         struct transport *transport;
 427         const struct ref *ref;
 428
 429         states->remote = remote_get(name);
 430         if (!states->remote)
 431                 return error("No such remote: %s", name);
 432
 433         read_branches();
 434
 435         if (query) {
 436                 transport = transport_get(NULL, states->remote->url_nr > 0 ?
 437                         states->remote->url[0] : NULL);
 438                 ref = transport_get_remote_refs(transport);
 439                 transport_disconnect(transport);
 440
 441                 get_ref_states(ref, states);
 442         }
 443
 444         return 0;
 445 }
 446
 447 static int append_ref_to_tracked_list(const char *refname,
 448         const unsigned char *sha1, int flags, void *cb_data)
 449 {
 450         struct ref_states *states = cb_data;
 451         struct refspec refspec;
 452
 453         memset(&refspec, 0, sizeof(refspec));
 454         refspec.dst = (char *)refname;
 455         if (!remote_find_tracking(states->remote, &refspec)) {
 456                 path_list_append(skip_prefix(refspec.src, "refs/heads/"),
 457                         &states->tracked);
 458         }
 459
 460         return 0;
 461 }
 462
 463 static int show(int argc, const char **argv)
 464 {
 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()
 470         };
 471         struct ref_states states;
 472
 473         argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
 474
 475         if (argc < 1)
 476                 return show_all();
 477
 478         memset(&states, 0, sizeof(states));
 479         for (; argc; argc--, argv++) {
 480                 struct strbuf buf;
 481                 int i;
 482
 483                 get_remote_ref_states(*argv, &states, !no_query);
 484
 485                 printf("* remote %s\n  URL: %s\n", *argv,
 486                         states.remote->url_nr > 0 ?
 487                                 states.remote->url[0] : "(no URL)");
 488
 489                 for (i = 0; i < branch_list.nr; i++) {
 490                         struct path_list_item *branch = branch_list.items + i;
 491                         struct branch_info *info = branch->util;
 492                         int j;
 493
 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->path);
 500                         for (j = 0; j < info->merge.nr; j++)
 501                                 printf(" %s", info->merge.items[j].path);
 502                         printf("\n");
 503                 }
 504
 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);
 513                 }
 514
 515                 if (no_query)
 516                         for_each_ref(append_ref_to_tracked_list, &states);
 517                 show_list("  Tracked remote branch%s", &states.tracked);
 518
 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                                         skip_prefix(spec->src, "refs/heads/"),
 527                                         spec->dst ? ":" : "",
 528                                         skip_prefix(spec->dst, "refs/heads/"));
 529                         }
 530                         printf("\n");
 531                 }
 532
 533                 /* NEEDSWORK: free remote */
 534                 path_list_clear(&states.new, 0);
 535                 path_list_clear(&states.stale, 0);
 536                 path_list_clear(&states.tracked, 0);
 537         }
 538
 539         return result;
 540 }
 541
 542 static int prune(int argc, const char **argv)
 543 {
 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()
 549         };
 550         struct ref_states states;
 551
 552         argc = parse_options(argc, argv, options, builtin_remote_usage, 0);
 553
 554         if (argc < 1)
 555                 usage_with_options(builtin_remote_usage, options);
 556
 557         memset(&states, 0, sizeof(states));
 558         for (; argc; argc--, argv++) {
 559                 int i;
 560
 561                 get_remote_ref_states(*argv, &states, 1);
 562
 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)");
 569                 }
 570
 571                 for (i = 0; i < states.stale.nr; i++) {
 572                         const char *refname = states.stale.items[i].util;
 573
 574                         if (!dry_run)
 575                                 result |= delete_ref(refname, NULL);
 576
 577                         printf(" * [%s] %s\n", dry_run ? "would prune" : "pruned",
 578                                skip_prefix(refname, "refs/remotes/"));
 579                 }
 580
 581                 /* NEEDSWORK: free remote */
 582                 path_list_clear(&states.new, 0);
 583                 path_list_clear(&states.stale, 0);
 584                 path_list_clear(&states.tracked, 0);
 585         }
 586
 587         return result;
 588 }
 589
 590 static int get_one_remote_for_update(struct remote *remote, void *priv)
 591 {
 592         struct path_list *list = priv;
 593         if (!remote->skip_default_update)
 594                 path_list_append(xstrdup(remote->name), list);
 595         return 0;
 596 }
 597
 598 struct remote_group {
 599         const char *name;
 600         struct path_list *list;
 601 } remote_group;
 602
 603 static int get_remote_group(const char *key, const char *value, void *cb)
 604 {
 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                                 path_list_append(xstrndup(value, space),
 612                                                 remote_group.list);
 613                         value += space + (value[space] != '\0');
 614                         space = strcspn(value, " \t\n");
 615                 }
 616         }
 617
 618         return 0;
 619 }
 620
 621 static int update(int argc, const char **argv)
 622 {
 623         int i, result = 0;
 624         struct path_list list = { NULL, 0, 0, 0 };
 625         static const char *default_argv[] = { NULL, "default", NULL };
 626
 627         if (argc < 2) {
 628                 argc = 2;
 629                 argv = default_argv;
 630         }
 631
 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);
 636         }
 637
 638         if (!result && !list.nr  && argc == 2 && !strcmp(argv[1], "default"))
 639                 result = for_each_remote(get_one_remote_for_update, &list);
 640
 641         for (i = 0; i < list.nr; i++)
 642                 result |= fetch_remote(list.items[i].path);
 643
 644         /* all names were strdup()ed or strndup()ed */
 645         list.strdup_paths = 1;
 646         path_list_clear(&list, 0);
 647
 648         return result;
 649 }
 650
 651 static int get_one_entry(struct remote *remote, void *priv)
 652 {
 653         struct path_list *list = priv;
 654
 655         path_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);
 659
 660         return 0;
 661 }
 662
 663 static int show_all(void)
 664 {
 665         struct path_list list = { NULL, 0, 0 };
 666         int result = for_each_remote(get_one_entry, &list);
 667
 668         if (!result) {
 669                 int i;
 670
 671                 sort_path_list(&list);
 672                 for (i = 0; i < list.nr; i++) {
 673                         struct path_list_item *item = list.items + i;
 674                         printf("%s%s%s\n", item->path,
 675                                 verbose ? "\t" : "",
 676                                 verbose && item->util ?
 677                                         (const char *)item->util : "");
 678                 }
 679         }
 680         return result;
 681 }
 682
 683 int cmd_remote(int argc, const char **argv, const char *prefix)
 684 {
 685         struct option options[] = {
 686                 OPT__VERBOSE(&verbose),
 687                 OPT_END()
 688         };
 689         int result;
 690
 691         argc = parse_options(argc, argv, options, builtin_remote_usage,
 692                 PARSE_OPT_STOP_AT_NON_OPTION);
 693
 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);
 709         }
 710
 711         return result ? 1 : 0;
 712 }