documentation: add some commas where they are helpful
[git.git] / send-pack.c
blob89aca9d829ed046f532b87120f39d807c86ebcb9
1 #include "git-compat-util.h"
2 #include "config.h"
3 #include "commit.h"
4 #include "date.h"
5 #include "gettext.h"
6 #include "hex.h"
7 #include "refs.h"
8 #include "object-store-ll.h"
9 #include "pkt-line.h"
10 #include "sideband.h"
11 #include "run-command.h"
12 #include "remote.h"
13 #include "connect.h"
14 #include "send-pack.h"
15 #include "quote.h"
16 #include "transport.h"
17 #include "version.h"
18 #include "oid-array.h"
19 #include "gpg-interface.h"
20 #include "shallow.h"
21 #include "parse-options.h"
22 #include "trace2.h"
23 #include "write-or-die.h"
25 int option_parse_push_signed(const struct option *opt,
26 const char *arg, int unset)
28 if (unset) {
29 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_NEVER;
30 return 0;
32 switch (git_parse_maybe_bool(arg)) {
33 case 1:
34 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_ALWAYS;
35 return 0;
36 case 0:
37 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_NEVER;
38 return 0;
40 if (!strcasecmp("if-asked", arg)) {
41 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_IF_ASKED;
42 return 0;
44 die("bad %s argument: %s", opt->long_name, arg);
47 static void feed_object(const struct object_id *oid, FILE *fh, int negative)
49 if (negative &&
50 !repo_has_object_file_with_flags(the_repository, oid,
51 OBJECT_INFO_SKIP_FETCH_OBJECT |
52 OBJECT_INFO_QUICK))
53 return;
55 if (negative)
56 putc('^', fh);
57 fputs(oid_to_hex(oid), fh);
58 putc('\n', fh);
62 * Make a pack stream and spit it out into file descriptor fd
64 static int pack_objects(int fd, struct ref *refs, struct oid_array *advertised,
65 struct oid_array *negotiated,
66 struct send_pack_args *args)
69 * The child becomes pack-objects --revs; we feed
70 * the revision parameters to it via its stdin and
71 * let its stdout go back to the other end.
73 struct child_process po = CHILD_PROCESS_INIT;
74 FILE *po_in;
75 int i;
76 int rc;
78 strvec_push(&po.args, "pack-objects");
79 strvec_push(&po.args, "--all-progress-implied");
80 strvec_push(&po.args, "--revs");
81 strvec_push(&po.args, "--stdout");
82 if (args->use_thin_pack)
83 strvec_push(&po.args, "--thin");
84 if (args->use_ofs_delta)
85 strvec_push(&po.args, "--delta-base-offset");
86 if (args->quiet || !args->progress)
87 strvec_push(&po.args, "-q");
88 if (args->progress)
89 strvec_push(&po.args, "--progress");
90 if (is_repository_shallow(the_repository))
91 strvec_push(&po.args, "--shallow");
92 if (args->disable_bitmaps)
93 strvec_push(&po.args, "--no-use-bitmap-index");
94 po.in = -1;
95 po.out = args->stateless_rpc ? -1 : fd;
96 po.git_cmd = 1;
97 po.clean_on_exit = 1;
98 if (start_command(&po))
99 die_errno("git pack-objects failed");
102 * We feed the pack-objects we just spawned with revision
103 * parameters by writing to the pipe.
105 po_in = xfdopen(po.in, "w");
106 for (i = 0; i < advertised->nr; i++)
107 feed_object(&advertised->oid[i], po_in, 1);
108 for (i = 0; i < negotiated->nr; i++)
109 feed_object(&negotiated->oid[i], po_in, 1);
111 while (refs) {
112 if (!is_null_oid(&refs->old_oid))
113 feed_object(&refs->old_oid, po_in, 1);
114 if (!is_null_oid(&refs->new_oid))
115 feed_object(&refs->new_oid, po_in, 0);
116 refs = refs->next;
119 fflush(po_in);
120 if (ferror(po_in))
121 die_errno("error writing to pack-objects");
122 fclose(po_in);
124 if (args->stateless_rpc) {
125 char *buf = xmalloc(LARGE_PACKET_MAX);
126 while (1) {
127 ssize_t n = xread(po.out, buf, LARGE_PACKET_MAX);
128 if (n <= 0)
129 break;
130 send_sideband(fd, -1, buf, n, LARGE_PACKET_MAX);
132 free(buf);
133 close(po.out);
134 po.out = -1;
137 rc = finish_command(&po);
138 if (rc) {
140 * For a normal non-zero exit, we assume pack-objects wrote
141 * something useful to stderr. For death by signal, though,
142 * we should mention it to the user. The exception is SIGPIPE
143 * (141), because that's a normal occurrence if the remote end
144 * hangs up (and we'll report that by trying to read the unpack
145 * status).
147 if (rc > 128 && rc != 141)
148 error("pack-objects died of signal %d", rc - 128);
149 return -1;
151 return 0;
154 static int receive_unpack_status(struct packet_reader *reader)
156 if (packet_reader_read(reader) != PACKET_READ_NORMAL)
157 return error(_("unexpected flush packet while reading remote unpack status"));
158 if (!skip_prefix(reader->line, "unpack ", &reader->line))
159 return error(_("unable to parse remote unpack status: %s"), reader->line);
160 if (strcmp(reader->line, "ok"))
161 return error(_("remote unpack failed: %s"), reader->line);
162 return 0;
165 static int receive_status(struct packet_reader *reader, struct ref *refs)
167 struct ref *hint;
168 int ret;
169 struct ref_push_report *report = NULL;
170 int new_report = 0;
171 int once = 0;
173 hint = NULL;
174 ret = receive_unpack_status(reader);
175 while (1) {
176 struct object_id old_oid, new_oid;
177 const char *head;
178 const char *refname;
179 char *p;
180 if (packet_reader_read(reader) != PACKET_READ_NORMAL)
181 break;
182 head = reader->line;
183 p = strchr(head, ' ');
184 if (!p) {
185 error("invalid status line from remote: %s", reader->line);
186 ret = -1;
187 break;
189 *p++ = '\0';
191 if (!strcmp(head, "option")) {
192 const char *key, *val;
194 if (!hint || !(report || new_report)) {
195 if (!once++)
196 error("'option' without a matching 'ok/ng' directive");
197 ret = -1;
198 continue;
200 if (new_report) {
201 if (!hint->report) {
202 CALLOC_ARRAY(hint->report, 1);
203 report = hint->report;
204 } else {
205 report = hint->report;
206 while (report->next)
207 report = report->next;
208 CALLOC_ARRAY(report->next, 1);
209 report = report->next;
211 new_report = 0;
213 key = p;
214 p = strchr(key, ' ');
215 if (p)
216 *p++ = '\0';
217 val = p;
218 if (!strcmp(key, "refname"))
219 report->ref_name = xstrdup_or_null(val);
220 else if (!strcmp(key, "old-oid") && val &&
221 !parse_oid_hex(val, &old_oid, &val))
222 report->old_oid = oiddup(&old_oid);
223 else if (!strcmp(key, "new-oid") && val &&
224 !parse_oid_hex(val, &new_oid, &val))
225 report->new_oid = oiddup(&new_oid);
226 else if (!strcmp(key, "forced-update"))
227 report->forced_update = 1;
228 continue;
231 report = NULL;
232 new_report = 0;
233 if (strcmp(head, "ok") && strcmp(head, "ng")) {
234 error("invalid ref status from remote: %s", head);
235 ret = -1;
236 break;
238 refname = p;
239 p = strchr(refname, ' ');
240 if (p)
241 *p++ = '\0';
242 /* first try searching at our hint, falling back to all refs */
243 if (hint)
244 hint = find_ref_by_name(hint, refname);
245 if (!hint)
246 hint = find_ref_by_name(refs, refname);
247 if (!hint) {
248 warning("remote reported status on unknown ref: %s",
249 refname);
250 continue;
252 if (hint->status != REF_STATUS_EXPECTING_REPORT &&
253 hint->status != REF_STATUS_OK &&
254 hint->status != REF_STATUS_REMOTE_REJECT) {
255 warning("remote reported status on unexpected ref: %s",
256 refname);
257 continue;
259 if (!strcmp(head, "ng")) {
260 hint->status = REF_STATUS_REMOTE_REJECT;
261 if (p)
262 hint->remote_status = xstrdup(p);
263 else
264 hint->remote_status = "failed";
265 } else {
266 hint->status = REF_STATUS_OK;
267 hint->remote_status = xstrdup_or_null(p);
268 new_report = 1;
271 return ret;
274 static int sideband_demux(int in UNUSED, int out, void *data)
276 int *fd = data, ret;
277 if (async_with_fork())
278 close(fd[1]);
279 ret = recv_sideband("send-pack", fd[0], out);
280 close(out);
281 return ret;
284 static int advertise_shallow_grafts_cb(const struct commit_graft *graft, void *cb)
286 struct strbuf *sb = cb;
287 if (graft->nr_parent == -1)
288 packet_buf_write(sb, "shallow %s\n", oid_to_hex(&graft->oid));
289 return 0;
292 static void advertise_shallow_grafts_buf(struct strbuf *sb)
294 if (!is_repository_shallow(the_repository))
295 return;
296 for_each_commit_graft(advertise_shallow_grafts_cb, sb);
299 #define CHECK_REF_NO_PUSH -1
300 #define CHECK_REF_STATUS_REJECTED -2
301 #define CHECK_REF_UPTODATE -3
302 static int check_to_send_update(const struct ref *ref, const struct send_pack_args *args)
304 if (!ref->peer_ref && !args->send_mirror)
305 return CHECK_REF_NO_PUSH;
307 /* Check for statuses set by set_ref_status_for_push() */
308 switch (ref->status) {
309 case REF_STATUS_REJECT_NONFASTFORWARD:
310 case REF_STATUS_REJECT_ALREADY_EXISTS:
311 case REF_STATUS_REJECT_FETCH_FIRST:
312 case REF_STATUS_REJECT_NEEDS_FORCE:
313 case REF_STATUS_REJECT_STALE:
314 case REF_STATUS_REJECT_REMOTE_UPDATED:
315 case REF_STATUS_REJECT_NODELETE:
316 return CHECK_REF_STATUS_REJECTED;
317 case REF_STATUS_UPTODATE:
318 return CHECK_REF_UPTODATE;
320 default:
321 case REF_STATUS_EXPECTING_REPORT:
322 /* already passed checks on the local side */
323 case REF_STATUS_OK:
324 /* of course this is OK */
325 return 0;
330 * the beginning of the next line, or the end of buffer.
332 * NEEDSWORK: perhaps move this to git-compat-util.h or somewhere and
333 * convert many similar uses found by "git grep -A4 memchr".
335 static const char *next_line(const char *line, size_t len)
337 const char *nl = memchr(line, '\n', len);
338 if (!nl)
339 return line + len; /* incomplete line */
340 return nl + 1;
343 static int generate_push_cert(struct strbuf *req_buf,
344 const struct ref *remote_refs,
345 struct send_pack_args *args,
346 const char *cap_string,
347 const char *push_cert_nonce)
349 const struct ref *ref;
350 struct string_list_item *item;
351 char *signing_key_id = xstrdup(get_signing_key_id());
352 const char *cp, *np;
353 struct strbuf cert = STRBUF_INIT;
354 int update_seen = 0;
356 strbuf_addstr(&cert, "certificate version 0.1\n");
357 strbuf_addf(&cert, "pusher %s ", signing_key_id);
358 datestamp(&cert);
359 strbuf_addch(&cert, '\n');
360 if (args->url && *args->url) {
361 char *anon_url = transport_anonymize_url(args->url);
362 strbuf_addf(&cert, "pushee %s\n", anon_url);
363 free(anon_url);
365 if (push_cert_nonce[0])
366 strbuf_addf(&cert, "nonce %s\n", push_cert_nonce);
367 if (args->push_options)
368 for_each_string_list_item(item, args->push_options)
369 strbuf_addf(&cert, "push-option %s\n", item->string);
370 strbuf_addstr(&cert, "\n");
372 for (ref = remote_refs; ref; ref = ref->next) {
373 if (check_to_send_update(ref, args) < 0)
374 continue;
375 update_seen = 1;
376 strbuf_addf(&cert, "%s %s %s\n",
377 oid_to_hex(&ref->old_oid),
378 oid_to_hex(&ref->new_oid),
379 ref->name);
381 if (!update_seen)
382 goto free_return;
384 if (sign_buffer(&cert, &cert, get_signing_key()))
385 die(_("failed to sign the push certificate"));
387 packet_buf_write(req_buf, "push-cert%c%s", 0, cap_string);
388 for (cp = cert.buf; cp < cert.buf + cert.len; cp = np) {
389 np = next_line(cp, cert.buf + cert.len - cp);
390 packet_buf_write(req_buf,
391 "%.*s", (int)(np - cp), cp);
393 packet_buf_write(req_buf, "push-cert-end\n");
395 free_return:
396 free(signing_key_id);
397 strbuf_release(&cert);
398 return update_seen;
401 #define NONCE_LEN_LIMIT 256
403 static void reject_invalid_nonce(const char *nonce, int len)
405 int i = 0;
407 if (NONCE_LEN_LIMIT <= len)
408 die("the receiving end asked to sign an invalid nonce <%.*s>",
409 len, nonce);
411 for (i = 0; i < len; i++) {
412 int ch = nonce[i] & 0xFF;
413 if (isalnum(ch) ||
414 ch == '-' || ch == '.' ||
415 ch == '/' || ch == '+' ||
416 ch == '=' || ch == '_')
417 continue;
418 die("the receiving end asked to sign an invalid nonce <%.*s>",
419 len, nonce);
423 static void get_commons_through_negotiation(const char *url,
424 const struct ref *remote_refs,
425 struct oid_array *commons)
427 struct child_process child = CHILD_PROCESS_INIT;
428 const struct ref *ref;
429 int len = the_hash_algo->hexsz + 1; /* hash + NL */
431 child.git_cmd = 1;
432 child.no_stdin = 1;
433 child.out = -1;
434 strvec_pushl(&child.args, "fetch", "--negotiate-only", NULL);
435 for (ref = remote_refs; ref; ref = ref->next) {
436 if (!is_null_oid(&ref->new_oid))
437 strvec_pushf(&child.args, "--negotiation-tip=%s", oid_to_hex(&ref->new_oid));
439 strvec_push(&child.args, url);
441 if (start_command(&child))
442 die(_("send-pack: unable to fork off fetch subprocess"));
444 do {
445 char hex_hash[GIT_MAX_HEXSZ + 1];
446 int read_len = read_in_full(child.out, hex_hash, len);
447 struct object_id oid;
448 const char *end;
450 if (!read_len)
451 break;
452 if (read_len != len)
453 die("invalid length read %d", read_len);
454 if (parse_oid_hex(hex_hash, &oid, &end) || *end != '\n')
455 die("invalid hash");
456 oid_array_append(commons, &oid);
457 } while (1);
459 if (finish_command(&child)) {
461 * The information that push negotiation provides is useful but
462 * not mandatory.
464 warning(_("push negotiation failed; proceeding anyway with push"));
468 int send_pack(struct send_pack_args *args,
469 int fd[], struct child_process *conn,
470 struct ref *remote_refs,
471 struct oid_array *extra_have)
473 struct oid_array commons = OID_ARRAY_INIT;
474 int in = fd[0];
475 int out = fd[1];
476 struct strbuf req_buf = STRBUF_INIT;
477 struct strbuf cap_buf = STRBUF_INIT;
478 struct ref *ref;
479 int need_pack_data = 0;
480 int allow_deleting_refs = 0;
481 int status_report = 0;
482 int use_sideband = 0;
483 int quiet_supported = 0;
484 int agent_supported = 0;
485 int advertise_sid = 0;
486 int push_negotiate = 0;
487 int use_atomic = 0;
488 int atomic_supported = 0;
489 int use_push_options = 0;
490 int push_options_supported = 0;
491 int object_format_supported = 0;
492 unsigned cmds_sent = 0;
493 int ret;
494 struct async demux;
495 const char *push_cert_nonce = NULL;
496 struct packet_reader reader;
497 int use_bitmaps;
499 if (!remote_refs) {
500 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
501 "Perhaps you should specify a branch.\n");
502 return 0;
505 git_config_get_bool("push.negotiate", &push_negotiate);
506 if (push_negotiate)
507 get_commons_through_negotiation(args->url, remote_refs, &commons);
509 if (!git_config_get_bool("push.usebitmaps", &use_bitmaps))
510 args->disable_bitmaps = !use_bitmaps;
512 git_config_get_bool("transfer.advertisesid", &advertise_sid);
514 /* Does the other end support the reporting? */
515 if (server_supports("report-status-v2"))
516 status_report = 2;
517 else if (server_supports("report-status"))
518 status_report = 1;
519 if (server_supports("delete-refs"))
520 allow_deleting_refs = 1;
521 if (server_supports("ofs-delta"))
522 args->use_ofs_delta = 1;
523 if (server_supports("side-band-64k"))
524 use_sideband = 1;
525 if (server_supports("quiet"))
526 quiet_supported = 1;
527 if (server_supports("agent"))
528 agent_supported = 1;
529 if (!server_supports("session-id"))
530 advertise_sid = 0;
531 if (server_supports("no-thin"))
532 args->use_thin_pack = 0;
533 if (server_supports("atomic"))
534 atomic_supported = 1;
535 if (server_supports("push-options"))
536 push_options_supported = 1;
538 if (!server_supports_hash(the_hash_algo->name, &object_format_supported))
539 die(_("the receiving end does not support this repository's hash algorithm"));
541 if (args->push_cert != SEND_PACK_PUSH_CERT_NEVER) {
542 size_t len;
543 push_cert_nonce = server_feature_value("push-cert", &len);
544 if (push_cert_nonce) {
545 reject_invalid_nonce(push_cert_nonce, len);
546 push_cert_nonce = xmemdupz(push_cert_nonce, len);
547 } else if (args->push_cert == SEND_PACK_PUSH_CERT_ALWAYS) {
548 die(_("the receiving end does not support --signed push"));
549 } else if (args->push_cert == SEND_PACK_PUSH_CERT_IF_ASKED) {
550 warning(_("not sending a push certificate since the"
551 " receiving end does not support --signed"
552 " push"));
556 if (args->atomic && !atomic_supported)
557 die(_("the receiving end does not support --atomic push"));
559 use_atomic = atomic_supported && args->atomic;
561 if (args->push_options && !push_options_supported)
562 die(_("the receiving end does not support push options"));
564 use_push_options = push_options_supported && args->push_options;
566 if (status_report == 1)
567 strbuf_addstr(&cap_buf, " report-status");
568 else if (status_report == 2)
569 strbuf_addstr(&cap_buf, " report-status-v2");
570 if (use_sideband)
571 strbuf_addstr(&cap_buf, " side-band-64k");
572 if (quiet_supported && (args->quiet || !args->progress))
573 strbuf_addstr(&cap_buf, " quiet");
574 if (use_atomic)
575 strbuf_addstr(&cap_buf, " atomic");
576 if (use_push_options)
577 strbuf_addstr(&cap_buf, " push-options");
578 if (object_format_supported)
579 strbuf_addf(&cap_buf, " object-format=%s", the_hash_algo->name);
580 if (agent_supported)
581 strbuf_addf(&cap_buf, " agent=%s", git_user_agent_sanitized());
582 if (advertise_sid)
583 strbuf_addf(&cap_buf, " session-id=%s", trace2_session_id());
586 * NEEDSWORK: why does delete-refs have to be so specific to
587 * send-pack machinery that set_ref_status_for_push() cannot
588 * set this bit for us???
590 for (ref = remote_refs; ref; ref = ref->next)
591 if (ref->deletion && !allow_deleting_refs)
592 ref->status = REF_STATUS_REJECT_NODELETE;
595 * Clear the status for each ref and see if we need to send
596 * the pack data.
598 for (ref = remote_refs; ref; ref = ref->next) {
599 switch (check_to_send_update(ref, args)) {
600 case 0: /* no error */
601 break;
602 case CHECK_REF_STATUS_REJECTED:
604 * When we know the server would reject a ref update if
605 * we were to send it and we're trying to send the refs
606 * atomically, abort the whole operation.
608 if (use_atomic) {
609 strbuf_release(&req_buf);
610 strbuf_release(&cap_buf);
611 reject_atomic_push(remote_refs, args->send_mirror);
612 error("atomic push failed for ref %s. status: %d\n",
613 ref->name, ref->status);
614 return args->porcelain ? 0 : -1;
616 /* else fallthrough */
617 default:
618 continue;
620 if (!ref->deletion)
621 need_pack_data = 1;
623 if (args->dry_run || !status_report)
624 ref->status = REF_STATUS_OK;
625 else
626 ref->status = REF_STATUS_EXPECTING_REPORT;
629 if (!args->dry_run)
630 advertise_shallow_grafts_buf(&req_buf);
633 * Finally, tell the other end!
635 if (!args->dry_run && push_cert_nonce)
636 cmds_sent = generate_push_cert(&req_buf, remote_refs, args,
637 cap_buf.buf, push_cert_nonce);
638 else if (!args->dry_run)
639 for (ref = remote_refs; ref; ref = ref->next) {
640 char *old_hex, *new_hex;
642 if (check_to_send_update(ref, args) < 0)
643 continue;
645 old_hex = oid_to_hex(&ref->old_oid);
646 new_hex = oid_to_hex(&ref->new_oid);
647 if (!cmds_sent) {
648 packet_buf_write(&req_buf,
649 "%s %s %s%c%s",
650 old_hex, new_hex, ref->name, 0,
651 cap_buf.buf);
652 cmds_sent = 1;
653 } else {
654 packet_buf_write(&req_buf, "%s %s %s",
655 old_hex, new_hex, ref->name);
659 if (use_push_options) {
660 struct string_list_item *item;
662 packet_buf_flush(&req_buf);
663 for_each_string_list_item(item, args->push_options)
664 packet_buf_write(&req_buf, "%s", item->string);
667 if (args->stateless_rpc) {
668 if (!args->dry_run && (cmds_sent || is_repository_shallow(the_repository))) {
669 packet_buf_flush(&req_buf);
670 send_sideband(out, -1, req_buf.buf, req_buf.len, LARGE_PACKET_MAX);
672 } else {
673 write_or_die(out, req_buf.buf, req_buf.len);
674 packet_flush(out);
676 strbuf_release(&req_buf);
677 strbuf_release(&cap_buf);
679 if (use_sideband && cmds_sent) {
680 memset(&demux, 0, sizeof(demux));
681 demux.proc = sideband_demux;
682 demux.data = fd;
683 demux.out = -1;
684 demux.isolate_sigpipe = 1;
685 if (start_async(&demux))
686 die("send-pack: unable to fork off sideband demultiplexer");
687 in = demux.out;
690 packet_reader_init(&reader, in, NULL, 0,
691 PACKET_READ_CHOMP_NEWLINE |
692 PACKET_READ_DIE_ON_ERR_PACKET);
694 if (need_pack_data && cmds_sent) {
695 if (pack_objects(out, remote_refs, extra_have, &commons, args) < 0) {
696 if (args->stateless_rpc)
697 close(out);
698 if (git_connection_is_socket(conn))
699 shutdown(fd[0], SHUT_WR);
702 * Do not even bother with the return value; we know we
703 * are failing, and just want the error() side effects,
704 * as well as marking refs with their remote status (if
705 * we get one).
707 if (status_report)
708 receive_status(&reader, remote_refs);
710 if (use_sideband) {
711 close(demux.out);
712 finish_async(&demux);
714 fd[1] = -1;
715 return -1;
717 if (!args->stateless_rpc)
718 /* Closed by pack_objects() via start_command() */
719 fd[1] = -1;
721 if (args->stateless_rpc && cmds_sent)
722 packet_flush(out);
724 if (status_report && cmds_sent)
725 ret = receive_status(&reader, remote_refs);
726 else
727 ret = 0;
728 if (args->stateless_rpc)
729 packet_flush(out);
731 if (use_sideband && cmds_sent) {
732 close(demux.out);
733 if (finish_async(&demux)) {
734 error("error in sideband demultiplexer");
735 ret = -1;
739 if (ret < 0)
740 return ret;
742 if (args->porcelain)
743 return 0;
745 for (ref = remote_refs; ref; ref = ref->next) {
746 switch (ref->status) {
747 case REF_STATUS_NONE:
748 case REF_STATUS_UPTODATE:
749 case REF_STATUS_OK:
750 break;
751 default:
752 return -1;
755 return 0;