Code

send-pack: demultiplex a sideband stream with status data
[git.git] / builtin-send-pack.c
1 #include "cache.h"
2 #include "commit.h"
3 #include "refs.h"
4 #include "pkt-line.h"
5 #include "sideband.h"
6 #include "run-command.h"
7 #include "remote.h"
8 #include "send-pack.h"
9 #include "quote.h"
11 static const char send_pack_usage[] =
12 "git send-pack [--all | --mirror] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]\n"
13 "  --all and explicit <ref> specification are mutually exclusive.";
15 static struct send_pack_args args;
17 static int feed_object(const unsigned char *sha1, int fd, int negative)
18 {
19         char buf[42];
21         if (negative && !has_sha1_file(sha1))
22                 return 1;
24         memcpy(buf + negative, sha1_to_hex(sha1), 40);
25         if (negative)
26                 buf[0] = '^';
27         buf[40 + negative] = '\n';
28         return write_or_whine(fd, buf, 41 + negative, "send-pack: send refs");
29 }
31 /*
32  * Make a pack stream and spit it out into file descriptor fd
33  */
34 static int pack_objects(int fd, struct ref *refs, struct extra_have_objects *extra, struct send_pack_args *args)
35 {
36         /*
37          * The child becomes pack-objects --revs; we feed
38          * the revision parameters to it via its stdin and
39          * let its stdout go back to the other end.
40          */
41         const char *argv[] = {
42                 "pack-objects",
43                 "--all-progress-implied",
44                 "--revs",
45                 "--stdout",
46                 NULL,
47                 NULL,
48                 NULL,
49                 NULL,
50         };
51         struct child_process po;
52         int i;
54         i = 4;
55         if (args->use_thin_pack)
56                 argv[i++] = "--thin";
57         if (args->use_ofs_delta)
58                 argv[i++] = "--delta-base-offset";
59         if (args->quiet)
60                 argv[i++] = "-q";
61         memset(&po, 0, sizeof(po));
62         po.argv = argv;
63         po.in = -1;
64         po.out = args->stateless_rpc ? -1 : fd;
65         po.git_cmd = 1;
66         if (start_command(&po))
67                 die_errno("git pack-objects failed");
69         /*
70          * We feed the pack-objects we just spawned with revision
71          * parameters by writing to the pipe.
72          */
73         for (i = 0; i < extra->nr; i++)
74                 if (!feed_object(extra->array[i], po.in, 1))
75                         break;
77         while (refs) {
78                 if (!is_null_sha1(refs->old_sha1) &&
79                     !feed_object(refs->old_sha1, po.in, 1))
80                         break;
81                 if (!is_null_sha1(refs->new_sha1) &&
82                     !feed_object(refs->new_sha1, po.in, 0))
83                         break;
84                 refs = refs->next;
85         }
87         close(po.in);
89         if (args->stateless_rpc) {
90                 char *buf = xmalloc(LARGE_PACKET_MAX);
91                 while (1) {
92                         ssize_t n = xread(po.out, buf, LARGE_PACKET_MAX);
93                         if (n <= 0)
94                                 break;
95                         send_sideband(fd, -1, buf, n, LARGE_PACKET_MAX);
96                 }
97                 free(buf);
98                 close(po.out);
99                 po.out = -1;
100         }
102         if (finish_command(&po))
103                 return error("pack-objects died with strange error");
104         return 0;
107 static int receive_status(int in, struct ref *refs)
109         struct ref *hint;
110         char line[1000];
111         int ret = 0;
112         int len = packet_read_line(in, line, sizeof(line));
113         if (len < 10 || memcmp(line, "unpack ", 7))
114                 return error("did not receive remote status");
115         if (memcmp(line, "unpack ok\n", 10)) {
116                 char *p = line + strlen(line) - 1;
117                 if (*p == '\n')
118                         *p = '\0';
119                 error("unpack failed: %s", line + 7);
120                 ret = -1;
121         }
122         hint = NULL;
123         while (1) {
124                 char *refname;
125                 char *msg;
126                 len = packet_read_line(in, line, sizeof(line));
127                 if (!len)
128                         break;
129                 if (len < 3 ||
130                     (memcmp(line, "ok ", 3) && memcmp(line, "ng ", 3))) {
131                         fprintf(stderr, "protocol error: %s\n", line);
132                         ret = -1;
133                         break;
134                 }
136                 line[strlen(line)-1] = '\0';
137                 refname = line + 3;
138                 msg = strchr(refname, ' ');
139                 if (msg)
140                         *msg++ = '\0';
142                 /* first try searching at our hint, falling back to all refs */
143                 if (hint)
144                         hint = find_ref_by_name(hint, refname);
145                 if (!hint)
146                         hint = find_ref_by_name(refs, refname);
147                 if (!hint) {
148                         warning("remote reported status on unknown ref: %s",
149                                         refname);
150                         continue;
151                 }
152                 if (hint->status != REF_STATUS_EXPECTING_REPORT) {
153                         warning("remote reported status on unexpected ref: %s",
154                                         refname);
155                         continue;
156                 }
158                 if (line[0] == 'o' && line[1] == 'k')
159                         hint->status = REF_STATUS_OK;
160                 else {
161                         hint->status = REF_STATUS_REMOTE_REJECT;
162                         ret = -1;
163                 }
164                 if (msg)
165                         hint->remote_status = xstrdup(msg);
166                 /* start our next search from the next ref */
167                 hint = hint->next;
168         }
169         return ret;
172 static void update_tracking_ref(struct remote *remote, struct ref *ref)
174         struct refspec rs;
176         if (ref->status != REF_STATUS_OK && ref->status != REF_STATUS_UPTODATE)
177                 return;
179         rs.src = ref->name;
180         rs.dst = NULL;
182         if (!remote_find_tracking(remote, &rs)) {
183                 if (args.verbose)
184                         fprintf(stderr, "updating local tracking ref '%s'\n", rs.dst);
185                 if (ref->deletion) {
186                         delete_ref(rs.dst, NULL, 0);
187                 } else
188                         update_ref("update by push", rs.dst,
189                                         ref->new_sha1, NULL, 0, 0);
190                 free(rs.dst);
191         }
194 #define SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
196 static void print_ref_status(char flag, const char *summary, struct ref *to, struct ref *from, const char *msg)
198         fprintf(stderr, " %c %-*s ", flag, SUMMARY_WIDTH, summary);
199         if (from)
200                 fprintf(stderr, "%s -> %s", prettify_refname(from->name), prettify_refname(to->name));
201         else
202                 fputs(prettify_refname(to->name), stderr);
203         if (msg) {
204                 fputs(" (", stderr);
205                 fputs(msg, stderr);
206                 fputc(')', stderr);
207         }
208         fputc('\n', stderr);
211 static const char *status_abbrev(unsigned char sha1[20])
213         return find_unique_abbrev(sha1, DEFAULT_ABBREV);
216 static void print_ok_ref_status(struct ref *ref)
218         if (ref->deletion)
219                 print_ref_status('-', "[deleted]", ref, NULL, NULL);
220         else if (is_null_sha1(ref->old_sha1))
221                 print_ref_status('*',
222                         (!prefixcmp(ref->name, "refs/tags/") ? "[new tag]" :
223                           "[new branch]"),
224                         ref, ref->peer_ref, NULL);
225         else {
226                 char quickref[84];
227                 char type;
228                 const char *msg;
230                 strcpy(quickref, status_abbrev(ref->old_sha1));
231                 if (ref->nonfastforward) {
232                         strcat(quickref, "...");
233                         type = '+';
234                         msg = "forced update";
235                 } else {
236                         strcat(quickref, "..");
237                         type = ' ';
238                         msg = NULL;
239                 }
240                 strcat(quickref, status_abbrev(ref->new_sha1));
242                 print_ref_status(type, quickref, ref, ref->peer_ref, msg);
243         }
246 static int print_one_push_status(struct ref *ref, const char *dest, int count)
248         if (!count)
249                 fprintf(stderr, "To %s\n", dest);
251         switch(ref->status) {
252         case REF_STATUS_NONE:
253                 print_ref_status('X', "[no match]", ref, NULL, NULL);
254                 break;
255         case REF_STATUS_REJECT_NODELETE:
256                 print_ref_status('!', "[rejected]", ref, NULL,
257                                 "remote does not support deleting refs");
258                 break;
259         case REF_STATUS_UPTODATE:
260                 print_ref_status('=', "[up to date]", ref,
261                                 ref->peer_ref, NULL);
262                 break;
263         case REF_STATUS_REJECT_NONFASTFORWARD:
264                 print_ref_status('!', "[rejected]", ref, ref->peer_ref,
265                                 "non-fast-forward");
266                 break;
267         case REF_STATUS_REMOTE_REJECT:
268                 print_ref_status('!', "[remote rejected]", ref,
269                                 ref->deletion ? NULL : ref->peer_ref,
270                                 ref->remote_status);
271                 break;
272         case REF_STATUS_EXPECTING_REPORT:
273                 print_ref_status('!', "[remote failure]", ref,
274                                 ref->deletion ? NULL : ref->peer_ref,
275                                 "remote failed to report status");
276                 break;
277         case REF_STATUS_OK:
278                 print_ok_ref_status(ref);
279                 break;
280         }
282         return 1;
285 static void print_push_status(const char *dest, struct ref *refs)
287         struct ref *ref;
288         int n = 0;
290         if (args.verbose) {
291                 for (ref = refs; ref; ref = ref->next)
292                         if (ref->status == REF_STATUS_UPTODATE)
293                                 n += print_one_push_status(ref, dest, n);
294         }
296         for (ref = refs; ref; ref = ref->next)
297                 if (ref->status == REF_STATUS_OK)
298                         n += print_one_push_status(ref, dest, n);
300         for (ref = refs; ref; ref = ref->next) {
301                 if (ref->status != REF_STATUS_NONE &&
302                     ref->status != REF_STATUS_UPTODATE &&
303                     ref->status != REF_STATUS_OK)
304                         n += print_one_push_status(ref, dest, n);
305         }
308 static int refs_pushed(struct ref *ref)
310         for (; ref; ref = ref->next) {
311                 switch(ref->status) {
312                 case REF_STATUS_NONE:
313                 case REF_STATUS_UPTODATE:
314                         break;
315                 default:
316                         return 1;
317                 }
318         }
319         return 0;
322 static void print_helper_status(struct ref *ref)
324         struct strbuf buf = STRBUF_INIT;
326         for (; ref; ref = ref->next) {
327                 const char *msg = NULL;
328                 const char *res;
330                 switch(ref->status) {
331                 case REF_STATUS_NONE:
332                         res = "error";
333                         msg = "no match";
334                         break;
336                 case REF_STATUS_OK:
337                         res = "ok";
338                         break;
340                 case REF_STATUS_UPTODATE:
341                         res = "ok";
342                         msg = "up to date";
343                         break;
345                 case REF_STATUS_REJECT_NONFASTFORWARD:
346                         res = "error";
347                         msg = "non-fast forward";
348                         break;
350                 case REF_STATUS_REJECT_NODELETE:
351                 case REF_STATUS_REMOTE_REJECT:
352                         res = "error";
353                         break;
355                 case REF_STATUS_EXPECTING_REPORT:
356                 default:
357                         continue;
358                 }
360                 strbuf_reset(&buf);
361                 strbuf_addf(&buf, "%s %s", res, ref->name);
362                 if (ref->remote_status)
363                         msg = ref->remote_status;
364                 if (msg) {
365                         strbuf_addch(&buf, ' ');
366                         quote_two_c_style(&buf, "", msg, 0);
367                 }
368                 strbuf_addch(&buf, '\n');
370                 safe_write(1, buf.buf, buf.len);
371         }
372         strbuf_release(&buf);
375 static int sideband_demux(int in, int out, void *data)
377         int *fd = data;
378         int ret = recv_sideband("send-pack", fd[0], out);
379         close(out);
380         return ret;
383 int send_pack(struct send_pack_args *args,
384               int fd[], struct child_process *conn,
385               struct ref *remote_refs,
386               struct extra_have_objects *extra_have)
388         int in = fd[0];
389         int out = fd[1];
390         struct strbuf req_buf = STRBUF_INIT;
391         struct ref *ref;
392         int new_refs;
393         int allow_deleting_refs = 0;
394         int status_report = 0;
395         int use_sideband = 0;
396         unsigned cmds_sent = 0;
397         int ret;
398         struct async demux;
400         /* Does the other end support the reporting? */
401         if (server_supports("report-status"))
402                 status_report = 1;
403         if (server_supports("delete-refs"))
404                 allow_deleting_refs = 1;
405         if (server_supports("ofs-delta"))
406                 args->use_ofs_delta = 1;
407         if (server_supports("side-band-64k"))
408                 use_sideband = 1;
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                 return 0;
414         }
416         /*
417          * Finally, tell the other end!
418          */
419         new_refs = 0;
420         for (ref = remote_refs; ref; ref = ref->next) {
422                 if (ref->peer_ref)
423                         hashcpy(ref->new_sha1, ref->peer_ref->new_sha1);
424                 else if (!args->send_mirror)
425                         continue;
427                 ref->deletion = is_null_sha1(ref->new_sha1);
428                 if (ref->deletion && !allow_deleting_refs) {
429                         ref->status = REF_STATUS_REJECT_NODELETE;
430                         continue;
431                 }
432                 if (!ref->deletion &&
433                     !hashcmp(ref->old_sha1, ref->new_sha1)) {
434                         ref->status = REF_STATUS_UPTODATE;
435                         continue;
436                 }
438                 /* This part determines what can overwrite what.
439                  * The rules are:
440                  *
441                  * (0) you can always use --force or +A:B notation to
442                  *     selectively force individual ref pairs.
443                  *
444                  * (1) if the old thing does not exist, it is OK.
445                  *
446                  * (2) if you do not have the old thing, you are not allowed
447                  *     to overwrite it; you would not know what you are losing
448                  *     otherwise.
449                  *
450                  * (3) if both new and old are commit-ish, and new is a
451                  *     descendant of old, it is OK.
452                  *
453                  * (4) regardless of all of the above, removing :B is
454                  *     always allowed.
455                  */
457                 ref->nonfastforward =
458                     !ref->deletion &&
459                     !is_null_sha1(ref->old_sha1) &&
460                     (!has_sha1_file(ref->old_sha1)
461                       || !ref_newer(ref->new_sha1, ref->old_sha1));
463                 if (ref->nonfastforward && !ref->force && !args->force_update) {
464                         ref->status = REF_STATUS_REJECT_NONFASTFORWARD;
465                         continue;
466                 }
468                 if (!ref->deletion)
469                         new_refs++;
471                 if (args->dry_run) {
472                         ref->status = REF_STATUS_OK;
473                 } else {
474                         char *old_hex = sha1_to_hex(ref->old_sha1);
475                         char *new_hex = sha1_to_hex(ref->new_sha1);
477                         if (!cmds_sent && (status_report || use_sideband)) {
478                                 packet_buf_write(&req_buf, "%s %s %s%c%s%s",
479                                         old_hex, new_hex, ref->name, 0,
480                                         status_report ? " report-status" : "",
481                                         use_sideband ? " side-band-64k" : "");
482                         }
483                         else
484                                 packet_buf_write(&req_buf, "%s %s %s",
485                                         old_hex, new_hex, ref->name);
486                         ref->status = status_report ?
487                                 REF_STATUS_EXPECTING_REPORT :
488                                 REF_STATUS_OK;
489                         cmds_sent++;
490                 }
491         }
493         if (args->stateless_rpc) {
494                 if (!args->dry_run && cmds_sent) {
495                         packet_buf_flush(&req_buf);
496                         send_sideband(out, -1, req_buf.buf, req_buf.len, LARGE_PACKET_MAX);
497                 }
498         } else {
499                 safe_write(out, req_buf.buf, req_buf.len);
500                 packet_flush(out);
501         }
502         strbuf_release(&req_buf);
504         if (use_sideband && cmds_sent) {
505                 memset(&demux, 0, sizeof(demux));
506                 demux.proc = sideband_demux;
507                 demux.data = fd;
508                 demux.out = -1;
509                 if (start_async(&demux))
510                         die("receive-pack: unable to fork off sideband demultiplexer");
511                 in = demux.out;
512         }
514         if (new_refs && cmds_sent) {
515                 if (pack_objects(out, remote_refs, extra_have, args) < 0) {
516                         for (ref = remote_refs; ref; ref = ref->next)
517                                 ref->status = REF_STATUS_NONE;
518                         if (use_sideband)
519                                 finish_async(&demux);
520                         return -1;
521                 }
522         }
523         if (args->stateless_rpc && cmds_sent)
524                 packet_flush(out);
526         if (status_report && cmds_sent)
527                 ret = receive_status(in, remote_refs);
528         else
529                 ret = 0;
530         if (args->stateless_rpc)
531                 packet_flush(out);
533         if (use_sideband && cmds_sent) {
534                 if (finish_async(&demux)) {
535                         error("error in sideband demultiplexer");
536                         ret = -1;
537                 }
538                 close(demux.out);
539         }
541         if (ret < 0)
542                 return ret;
543         for (ref = remote_refs; ref; ref = ref->next) {
544                 switch (ref->status) {
545                 case REF_STATUS_NONE:
546                 case REF_STATUS_UPTODATE:
547                 case REF_STATUS_OK:
548                         break;
549                 default:
550                         return -1;
551                 }
552         }
553         return 0;
556 static void verify_remote_names(int nr_heads, const char **heads)
558         int i;
560         for (i = 0; i < nr_heads; i++) {
561                 const char *local = heads[i];
562                 const char *remote = strrchr(heads[i], ':');
564                 if (*local == '+')
565                         local++;
567                 /* A matching refspec is okay.  */
568                 if (remote == local && remote[1] == '\0')
569                         continue;
571                 remote = remote ? (remote + 1) : local;
572                 switch (check_ref_format(remote)) {
573                 case 0: /* ok */
574                 case CHECK_REF_FORMAT_ONELEVEL:
575                         /* ok but a single level -- that is fine for
576                          * a match pattern.
577                          */
578                 case CHECK_REF_FORMAT_WILDCARD:
579                         /* ok but ends with a pattern-match character */
580                         continue;
581                 }
582                 die("remote part of refspec is not a valid name in %s",
583                     heads[i]);
584         }
587 int cmd_send_pack(int argc, const char **argv, const char *prefix)
589         int i, nr_refspecs = 0;
590         const char **refspecs = NULL;
591         const char *remote_name = NULL;
592         struct remote *remote = NULL;
593         const char *dest = NULL;
594         int fd[2];
595         struct child_process *conn;
596         struct extra_have_objects extra_have;
597         struct ref *remote_refs, *local_refs;
598         int ret;
599         int helper_status = 0;
600         int send_all = 0;
601         const char *receivepack = "git-receive-pack";
602         int flags;
604         argv++;
605         for (i = 1; i < argc; i++, argv++) {
606                 const char *arg = *argv;
608                 if (*arg == '-') {
609                         if (!prefixcmp(arg, "--receive-pack=")) {
610                                 receivepack = arg + 15;
611                                 continue;
612                         }
613                         if (!prefixcmp(arg, "--exec=")) {
614                                 receivepack = arg + 7;
615                                 continue;
616                         }
617                         if (!prefixcmp(arg, "--remote=")) {
618                                 remote_name = arg + 9;
619                                 continue;
620                         }
621                         if (!strcmp(arg, "--all")) {
622                                 send_all = 1;
623                                 continue;
624                         }
625                         if (!strcmp(arg, "--dry-run")) {
626                                 args.dry_run = 1;
627                                 continue;
628                         }
629                         if (!strcmp(arg, "--mirror")) {
630                                 args.send_mirror = 1;
631                                 continue;
632                         }
633                         if (!strcmp(arg, "--force")) {
634                                 args.force_update = 1;
635                                 continue;
636                         }
637                         if (!strcmp(arg, "--verbose")) {
638                                 args.verbose = 1;
639                                 continue;
640                         }
641                         if (!strcmp(arg, "--thin")) {
642                                 args.use_thin_pack = 1;
643                                 continue;
644                         }
645                         if (!strcmp(arg, "--stateless-rpc")) {
646                                 args.stateless_rpc = 1;
647                                 continue;
648                         }
649                         if (!strcmp(arg, "--helper-status")) {
650                                 helper_status = 1;
651                                 continue;
652                         }
653                         usage(send_pack_usage);
654                 }
655                 if (!dest) {
656                         dest = arg;
657                         continue;
658                 }
659                 refspecs = (const char **) argv;
660                 nr_refspecs = argc - i;
661                 break;
662         }
663         if (!dest)
664                 usage(send_pack_usage);
665         /*
666          * --all and --mirror are incompatible; neither makes sense
667          * with any refspecs.
668          */
669         if ((refspecs && (send_all || args.send_mirror)) ||
670             (send_all && args.send_mirror))
671                 usage(send_pack_usage);
673         if (remote_name) {
674                 remote = remote_get(remote_name);
675                 if (!remote_has_url(remote, dest)) {
676                         die("Destination %s is not a uri for %s",
677                             dest, remote_name);
678                 }
679         }
681         if (args.stateless_rpc) {
682                 conn = NULL;
683                 fd[0] = 0;
684                 fd[1] = 1;
685         } else {
686                 conn = git_connect(fd, dest, receivepack,
687                         args.verbose ? CONNECT_VERBOSE : 0);
688         }
690         memset(&extra_have, 0, sizeof(extra_have));
692         get_remote_heads(fd[0], &remote_refs, 0, NULL, REF_NORMAL,
693                          &extra_have);
695         verify_remote_names(nr_refspecs, refspecs);
697         local_refs = get_local_heads();
699         flags = MATCH_REFS_NONE;
701         if (send_all)
702                 flags |= MATCH_REFS_ALL;
703         if (args.send_mirror)
704                 flags |= MATCH_REFS_MIRROR;
706         /* match them up */
707         if (match_refs(local_refs, &remote_refs, nr_refspecs, refspecs, flags))
708                 return -1;
710         ret = send_pack(&args, fd, conn, remote_refs, &extra_have);
712         if (helper_status)
713                 print_helper_status(remote_refs);
715         close(fd[1]);
716         close(fd[0]);
718         ret |= finish_connect(conn);
720         if (!helper_status)
721                 print_push_status(dest, remote_refs);
723         if (!args.dry_run && remote) {
724                 struct ref *ref;
725                 for (ref = remote_refs; ref; ref = ref->next)
726                         update_tracking_ref(remote, ref);
727         }
729         if (!ret && !refs_pushed(remote_refs))
730                 fprintf(stderr, "Everything up-to-date\n");
732         return ret;