builtin-send-pack.con commit merge-tool documentation: describe custom command usage (caa9982)
   1#include "cache.h"
   2#include "commit.h"
   3#include "tag.h"
   4#include "refs.h"
   5#include "pkt-line.h"
   6#include "run-command.h"
   7#include "remote.h"
   8#include "send-pack.h"
   9
  10static const char send_pack_usage[] =
  11"git-send-pack [--all | --mirror] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]\n"
  12"  --all and explicit <ref> specification are mutually exclusive.";
  13
  14static struct send_pack_args args = {
  15        /* .receivepack = */ "git-receive-pack",
  16};
  17
  18/*
  19 * Make a pack stream and spit it out into file descriptor fd
  20 */
  21static int pack_objects(int fd, struct ref *refs)
  22{
  23        /*
  24         * The child becomes pack-objects --revs; we feed
  25         * the revision parameters to it via its stdin and
  26         * let its stdout go back to the other end.
  27         */
  28        const char *argv[] = {
  29                "pack-objects",
  30                "--all-progress",
  31                "--revs",
  32                "--stdout",
  33                NULL,
  34                NULL,
  35        };
  36        struct child_process po;
  37
  38        if (args.use_thin_pack)
  39                argv[4] = "--thin";
  40        memset(&po, 0, sizeof(po));
  41        po.argv = argv;
  42        po.in = -1;
  43        po.out = fd;
  44        po.git_cmd = 1;
  45        if (start_command(&po))
  46                die("git-pack-objects failed (%s)", strerror(errno));
  47
  48        /*
  49         * We feed the pack-objects we just spawned with revision
  50         * parameters by writing to the pipe.
  51         */
  52        while (refs) {
  53                char buf[42];
  54
  55                if (!is_null_sha1(refs->old_sha1) &&
  56                    has_sha1_file(refs->old_sha1)) {
  57                        memcpy(buf + 1, sha1_to_hex(refs->old_sha1), 40);
  58                        buf[0] = '^';
  59                        buf[41] = '\n';
  60                        if (!write_or_whine(po.in, buf, 42,
  61                                                "send-pack: send refs"))
  62                                break;
  63                }
  64                if (!is_null_sha1(refs->new_sha1)) {
  65                        memcpy(buf, sha1_to_hex(refs->new_sha1), 40);
  66                        buf[40] = '\n';
  67                        if (!write_or_whine(po.in, buf, 41,
  68                                                "send-pack: send refs"))
  69                                break;
  70                }
  71                refs = refs->next;
  72        }
  73
  74        close(po.in);
  75        if (finish_command(&po))
  76                return error("pack-objects died with strange error");
  77        return 0;
  78}
  79
  80static void unmark_and_free(struct commit_list *list, unsigned int mark)
  81{
  82        while (list) {
  83                struct commit_list *temp = list;
  84                temp->item->object.flags &= ~mark;
  85                list = temp->next;
  86                free(temp);
  87        }
  88}
  89
  90static int ref_newer(const unsigned char *new_sha1,
  91                     const unsigned char *old_sha1)
  92{
  93        struct object *o;
  94        struct commit *old, *new;
  95        struct commit_list *list, *used;
  96        int found = 0;
  97
  98        /* Both new and old must be commit-ish and new is descendant of
  99         * old.  Otherwise we require --force.
 100         */
 101        o = deref_tag(parse_object(old_sha1), NULL, 0);
 102        if (!o || o->type != OBJ_COMMIT)
 103                return 0;
 104        old = (struct commit *) o;
 105
 106        o = deref_tag(parse_object(new_sha1), NULL, 0);
 107        if (!o || o->type != OBJ_COMMIT)
 108                return 0;
 109        new = (struct commit *) o;
 110
 111        if (parse_commit(new) < 0)
 112                return 0;
 113
 114        used = list = NULL;
 115        commit_list_insert(new, &list);
 116        while (list) {
 117                new = pop_most_recent_commit(&list, 1);
 118                commit_list_insert(new, &used);
 119                if (new == old) {
 120                        found = 1;
 121                        break;
 122                }
 123        }
 124        unmark_and_free(list, 1);
 125        unmark_and_free(used, 1);
 126        return found;
 127}
 128
 129static struct ref *local_refs, **local_tail;
 130static struct ref *remote_refs, **remote_tail;
 131
 132static int one_local_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
 133{
 134        struct ref *ref;
 135        int len = strlen(refname) + 1;
 136        ref = xcalloc(1, sizeof(*ref) + len);
 137        hashcpy(ref->new_sha1, sha1);
 138        memcpy(ref->name, refname, len);
 139        *local_tail = ref;
 140        local_tail = &ref->next;
 141        return 0;
 142}
 143
 144static void get_local_heads(void)
 145{
 146        local_tail = &local_refs;
 147        for_each_ref(one_local_ref, NULL);
 148}
 149
 150static int receive_status(int in, struct ref *refs)
 151{
 152        struct ref *hint;
 153        char line[1000];
 154        int ret = 0;
 155        int len = packet_read_line(in, line, sizeof(line));
 156        if (len < 10 || memcmp(line, "unpack ", 7))
 157                return error("did not receive remote status");
 158        if (memcmp(line, "unpack ok\n", 10)) {
 159                char *p = line + strlen(line) - 1;
 160                if (*p == '\n')
 161                        *p = '\0';
 162                error("unpack failed: %s", line + 7);
 163                ret = -1;
 164        }
 165        hint = NULL;
 166        while (1) {
 167                char *refname;
 168                char *msg;
 169                len = packet_read_line(in, line, sizeof(line));
 170                if (!len)
 171                        break;
 172                if (len < 3 ||
 173                    (memcmp(line, "ok ", 3) && memcmp(line, "ng ", 3))) {
 174                        fprintf(stderr, "protocol error: %s\n", line);
 175                        ret = -1;
 176                        break;
 177                }
 178
 179                line[strlen(line)-1] = '\0';
 180                refname = line + 3;
 181                msg = strchr(refname, ' ');
 182                if (msg)
 183                        *msg++ = '\0';
 184
 185                /* first try searching at our hint, falling back to all refs */
 186                if (hint)
 187                        hint = find_ref_by_name(hint, refname);
 188                if (!hint)
 189                        hint = find_ref_by_name(refs, refname);
 190                if (!hint) {
 191                        warning("remote reported status on unknown ref: %s",
 192                                        refname);
 193                        continue;
 194                }
 195                if (hint->status != REF_STATUS_EXPECTING_REPORT) {
 196                        warning("remote reported status on unexpected ref: %s",
 197                                        refname);
 198                        continue;
 199                }
 200
 201                if (line[0] == 'o' && line[1] == 'k')
 202                        hint->status = REF_STATUS_OK;
 203                else {
 204                        hint->status = REF_STATUS_REMOTE_REJECT;
 205                        ret = -1;
 206                }
 207                if (msg)
 208                        hint->remote_status = xstrdup(msg);
 209                /* start our next search from the next ref */
 210                hint = hint->next;
 211        }
 212        return ret;
 213}
 214
 215static void update_tracking_ref(struct remote *remote, struct ref *ref)
 216{
 217        struct refspec rs;
 218
 219        if (ref->status != REF_STATUS_OK)
 220                return;
 221
 222        rs.src = ref->name;
 223        rs.dst = NULL;
 224
 225        if (!remote_find_tracking(remote, &rs)) {
 226                if (args.verbose)
 227                        fprintf(stderr, "updating local tracking ref '%s'\n", rs.dst);
 228                if (ref->deletion) {
 229                        if (delete_ref(rs.dst, NULL))
 230                                error("Failed to delete");
 231                } else
 232                        update_ref("update by push", rs.dst,
 233                                        ref->new_sha1, NULL, 0, 0);
 234                free(rs.dst);
 235        }
 236}
 237
 238static const char *prettify_ref(const struct ref *ref)
 239{
 240        const char *name = ref->name;
 241        return name + (
 242                !prefixcmp(name, "refs/heads/") ? 11 :
 243                !prefixcmp(name, "refs/tags/") ? 10 :
 244                !prefixcmp(name, "refs/remotes/") ? 13 :
 245                0);
 246}
 247
 248#define SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
 249
 250static void print_ref_status(char flag, const char *summary, struct ref *to, struct ref *from, const char *msg)
 251{
 252        fprintf(stderr, " %c %-*s ", flag, SUMMARY_WIDTH, summary);
 253        if (from)
 254                fprintf(stderr, "%s -> %s", prettify_ref(from), prettify_ref(to));
 255        else
 256                fputs(prettify_ref(to), stderr);
 257        if (msg) {
 258                fputs(" (", stderr);
 259                fputs(msg, stderr);
 260                fputc(')', stderr);
 261        }
 262        fputc('\n', stderr);
 263}
 264
 265static const char *status_abbrev(unsigned char sha1[20])
 266{
 267        return find_unique_abbrev(sha1, DEFAULT_ABBREV);
 268}
 269
 270static void print_ok_ref_status(struct ref *ref)
 271{
 272        if (ref->deletion)
 273                print_ref_status('-', "[deleted]", ref, NULL, NULL);
 274        else if (is_null_sha1(ref->old_sha1))
 275                print_ref_status('*',
 276                        (!prefixcmp(ref->name, "refs/tags/") ? "[new tag]" :
 277                          "[new branch]"),
 278                        ref, ref->peer_ref, NULL);
 279        else {
 280                char quickref[84];
 281                char type;
 282                const char *msg;
 283
 284                strcpy(quickref, status_abbrev(ref->old_sha1));
 285                if (ref->nonfastforward) {
 286                        strcat(quickref, "...");
 287                        type = '+';
 288                        msg = "forced update";
 289                } else {
 290                        strcat(quickref, "..");
 291                        type = ' ';
 292                        msg = NULL;
 293                }
 294                strcat(quickref, status_abbrev(ref->new_sha1));
 295
 296                print_ref_status(type, quickref, ref, ref->peer_ref, msg);
 297        }
 298}
 299
 300static int print_one_push_status(struct ref *ref, const char *dest, int count)
 301{
 302        if (!count)
 303                fprintf(stderr, "To %s\n", dest);
 304
 305        switch(ref->status) {
 306        case REF_STATUS_NONE:
 307                print_ref_status('X', "[no match]", ref, NULL, NULL);
 308                break;
 309        case REF_STATUS_REJECT_NODELETE:
 310                print_ref_status('!', "[rejected]", ref, NULL,
 311                                "remote does not support deleting refs");
 312                break;
 313        case REF_STATUS_UPTODATE:
 314                print_ref_status('=', "[up to date]", ref,
 315                                ref->peer_ref, NULL);
 316                break;
 317        case REF_STATUS_REJECT_NONFASTFORWARD:
 318                print_ref_status('!', "[rejected]", ref, ref->peer_ref,
 319                                "non-fast forward");
 320                break;
 321        case REF_STATUS_REMOTE_REJECT:
 322                print_ref_status('!', "[remote rejected]", ref,
 323                                ref->deletion ? NULL : ref->peer_ref,
 324                                ref->remote_status);
 325                break;
 326        case REF_STATUS_EXPECTING_REPORT:
 327                print_ref_status('!', "[remote failure]", ref,
 328                                ref->deletion ? NULL : ref->peer_ref,
 329                                "remote failed to report status");
 330                break;
 331        case REF_STATUS_OK:
 332                print_ok_ref_status(ref);
 333                break;
 334        }
 335
 336        return 1;
 337}
 338
 339static void print_push_status(const char *dest, struct ref *refs)
 340{
 341        struct ref *ref;
 342        int n = 0;
 343
 344        if (args.verbose) {
 345                for (ref = refs; ref; ref = ref->next)
 346                        if (ref->status == REF_STATUS_UPTODATE)
 347                                n += print_one_push_status(ref, dest, n);
 348        }
 349
 350        for (ref = refs; ref; ref = ref->next)
 351                if (ref->status == REF_STATUS_OK)
 352                        n += print_one_push_status(ref, dest, n);
 353
 354        for (ref = refs; ref; ref = ref->next) {
 355                if (ref->status != REF_STATUS_NONE &&
 356                    ref->status != REF_STATUS_UPTODATE &&
 357                    ref->status != REF_STATUS_OK)
 358                        n += print_one_push_status(ref, dest, n);
 359        }
 360}
 361
 362static int refs_pushed(struct ref *ref)
 363{
 364        for (; ref; ref = ref->next) {
 365                switch(ref->status) {
 366                case REF_STATUS_NONE:
 367                case REF_STATUS_UPTODATE:
 368                        break;
 369                default:
 370                        return 1;
 371                }
 372        }
 373        return 0;
 374}
 375
 376static int do_send_pack(int in, int out, struct remote *remote, const char *dest, int nr_refspec, const char **refspec)
 377{
 378        struct ref *ref;
 379        int new_refs;
 380        int ask_for_status_report = 0;
 381        int allow_deleting_refs = 0;
 382        int expect_status_report = 0;
 383        int flags = MATCH_REFS_NONE;
 384        int ret;
 385
 386        if (args.send_all)
 387                flags |= MATCH_REFS_ALL;
 388        if (args.send_mirror)
 389                flags |= MATCH_REFS_MIRROR;
 390
 391        /* No funny business with the matcher */
 392        remote_tail = get_remote_heads(in, &remote_refs, 0, NULL, REF_NORMAL);
 393        get_local_heads();
 394
 395        /* Does the other end support the reporting? */
 396        if (server_supports("report-status"))
 397                ask_for_status_report = 1;
 398        if (server_supports("delete-refs"))
 399                allow_deleting_refs = 1;
 400
 401        /* match them up */
 402        if (!remote_tail)
 403                remote_tail = &remote_refs;
 404        if (match_refs(local_refs, remote_refs, &remote_tail,
 405                       nr_refspec, refspec, flags)) {
 406                close(out);
 407                return -1;
 408        }
 409
 410        if (!remote_refs) {
 411                fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
 412                        "Perhaps you should specify a branch such as 'master'.\n");
 413                close(out);
 414                return 0;
 415        }
 416
 417        /*
 418         * Finally, tell the other end!
 419         */
 420        new_refs = 0;
 421        for (ref = remote_refs; ref; ref = ref->next) {
 422                const unsigned char *new_sha1;
 423
 424                if (!ref->peer_ref) {
 425                        if (!args.send_mirror)
 426                                continue;
 427                        new_sha1 = null_sha1;
 428                }
 429                else
 430                        new_sha1 = ref->peer_ref->new_sha1;
 431
 432
 433                ref->deletion = is_null_sha1(new_sha1);
 434                if (ref->deletion && !allow_deleting_refs) {
 435                        ref->status = REF_STATUS_REJECT_NODELETE;
 436                        continue;
 437                }
 438                if (!ref->deletion &&
 439                    !hashcmp(ref->old_sha1, new_sha1)) {
 440                        ref->status = REF_STATUS_UPTODATE;
 441                        continue;
 442                }
 443
 444                /* This part determines what can overwrite what.
 445                 * The rules are:
 446                 *
 447                 * (0) you can always use --force or +A:B notation to
 448                 *     selectively force individual ref pairs.
 449                 *
 450                 * (1) if the old thing does not exist, it is OK.
 451                 *
 452                 * (2) if you do not have the old thing, you are not allowed
 453                 *     to overwrite it; you would not know what you are losing
 454                 *     otherwise.
 455                 *
 456                 * (3) if both new and old are commit-ish, and new is a
 457                 *     descendant of old, it is OK.
 458                 *
 459                 * (4) regardless of all of the above, removing :B is
 460                 *     always allowed.
 461                 */
 462
 463                ref->nonfastforward =
 464                    !ref->deletion &&
 465                    !is_null_sha1(ref->old_sha1) &&
 466                    (!has_sha1_file(ref->old_sha1)
 467                      || !ref_newer(new_sha1, ref->old_sha1));
 468
 469                if (ref->nonfastforward && !ref->force && !args.force_update) {
 470                        ref->status = REF_STATUS_REJECT_NONFASTFORWARD;
 471                        continue;
 472                }
 473
 474                hashcpy(ref->new_sha1, new_sha1);
 475                if (!ref->deletion)
 476                        new_refs++;
 477
 478                if (!args.dry_run) {
 479                        char *old_hex = sha1_to_hex(ref->old_sha1);
 480                        char *new_hex = sha1_to_hex(ref->new_sha1);
 481
 482                        if (ask_for_status_report) {
 483                                packet_write(out, "%s %s %s%c%s",
 484                                        old_hex, new_hex, ref->name, 0,
 485                                        "report-status");
 486                                ask_for_status_report = 0;
 487                                expect_status_report = 1;
 488                        }
 489                        else
 490                                packet_write(out, "%s %s %s",
 491                                        old_hex, new_hex, ref->name);
 492                }
 493                ref->status = expect_status_report ?
 494                        REF_STATUS_EXPECTING_REPORT :
 495                        REF_STATUS_OK;
 496        }
 497
 498        packet_flush(out);
 499        if (new_refs && !args.dry_run) {
 500                if (pack_objects(out, remote_refs) < 0)
 501                        return -1;
 502        }
 503        else
 504                close(out);
 505
 506        if (expect_status_report)
 507                ret = receive_status(in, remote_refs);
 508        else
 509                ret = 0;
 510
 511        print_push_status(dest, remote_refs);
 512
 513        if (!args.dry_run && remote) {
 514                for (ref = remote_refs; ref; ref = ref->next)
 515                        update_tracking_ref(remote, ref);
 516        }
 517
 518        if (!refs_pushed(remote_refs))
 519                fprintf(stderr, "Everything up-to-date\n");
 520        if (ret < 0)
 521                return ret;
 522        for (ref = remote_refs; ref; ref = ref->next) {
 523                switch (ref->status) {
 524                case REF_STATUS_NONE:
 525                case REF_STATUS_UPTODATE:
 526                case REF_STATUS_OK:
 527                        break;
 528                default:
 529                        return -1;
 530                }
 531        }
 532        return 0;
 533}
 534
 535static void verify_remote_names(int nr_heads, const char **heads)
 536{
 537        int i;
 538
 539        for (i = 0; i < nr_heads; i++) {
 540                const char *remote = strchr(heads[i], ':');
 541
 542                remote = remote ? (remote + 1) : heads[i];
 543                switch (check_ref_format(remote)) {
 544                case 0: /* ok */
 545                case CHECK_REF_FORMAT_ONELEVEL:
 546                        /* ok but a single level -- that is fine for
 547                         * a match pattern.
 548                         */
 549                case CHECK_REF_FORMAT_WILDCARD:
 550                        /* ok but ends with a pattern-match character */
 551                        continue;
 552                }
 553                die("remote part of refspec is not a valid name in %s",
 554                    heads[i]);
 555        }
 556}
 557
 558int cmd_send_pack(int argc, const char **argv, const char *prefix)
 559{
 560        int i, nr_heads = 0;
 561        const char **heads = NULL;
 562        const char *remote_name = NULL;
 563        struct remote *remote = NULL;
 564        const char *dest = NULL;
 565
 566        argv++;
 567        for (i = 1; i < argc; i++, argv++) {
 568                const char *arg = *argv;
 569
 570                if (*arg == '-') {
 571                        if (!prefixcmp(arg, "--receive-pack=")) {
 572                                args.receivepack = arg + 15;
 573                                continue;
 574                        }
 575                        if (!prefixcmp(arg, "--exec=")) {
 576                                args.receivepack = arg + 7;
 577                                continue;
 578                        }
 579                        if (!prefixcmp(arg, "--remote=")) {
 580                                remote_name = arg + 9;
 581                                continue;
 582                        }
 583                        if (!strcmp(arg, "--all")) {
 584                                args.send_all = 1;
 585                                continue;
 586                        }
 587                        if (!strcmp(arg, "--dry-run")) {
 588                                args.dry_run = 1;
 589                                continue;
 590                        }
 591                        if (!strcmp(arg, "--mirror")) {
 592                                args.send_mirror = 1;
 593                                continue;
 594                        }
 595                        if (!strcmp(arg, "--force")) {
 596                                args.force_update = 1;
 597                                continue;
 598                        }
 599                        if (!strcmp(arg, "--verbose")) {
 600                                args.verbose = 1;
 601                                continue;
 602                        }
 603                        if (!strcmp(arg, "--thin")) {
 604                                args.use_thin_pack = 1;
 605                                continue;
 606                        }
 607                        usage(send_pack_usage);
 608                }
 609                if (!dest) {
 610                        dest = arg;
 611                        continue;
 612                }
 613                heads = (const char **) argv;
 614                nr_heads = argc - i;
 615                break;
 616        }
 617        if (!dest)
 618                usage(send_pack_usage);
 619        /*
 620         * --all and --mirror are incompatible; neither makes sense
 621         * with any refspecs.
 622         */
 623        if ((heads && (args.send_all || args.send_mirror)) ||
 624                                        (args.send_all && args.send_mirror))
 625                usage(send_pack_usage);
 626
 627        if (remote_name) {
 628                remote = remote_get(remote_name);
 629                if (!remote_has_url(remote, dest)) {
 630                        die("Destination %s is not a uri for %s",
 631                            dest, remote_name);
 632                }
 633        }
 634
 635        return send_pack(&args, dest, remote, nr_heads, heads);
 636}
 637
 638int send_pack(struct send_pack_args *my_args,
 639              const char *dest, struct remote *remote,
 640              int nr_heads, const char **heads)
 641{
 642        int fd[2], ret;
 643        struct child_process *conn;
 644
 645        memcpy(&args, my_args, sizeof(args));
 646
 647        verify_remote_names(nr_heads, heads);
 648
 649        conn = git_connect(fd, dest, args.receivepack, args.verbose ? CONNECT_VERBOSE : 0);
 650        ret = do_send_pack(fd[0], fd[1], remote, dest, nr_heads, heads);
 651        close(fd[0]);
 652        /* do_send_pack always closes fd[1] */
 653        ret |= finish_connect(conn);
 654        return !!ret;
 655}