hashmap: add usage documentation explaining hashmap_free[_entries]()
[git] / send-pack.c
1 #include "builtin.h"
2 #include "config.h"
3 #include "commit.h"
4 #include "refs.h"
5 #include "object-store.h"
6 #include "pkt-line.h"
7 #include "sideband.h"
8 #include "run-command.h"
9 #include "remote.h"
10 #include "connect.h"
11 #include "send-pack.h"
12 #include "quote.h"
13 #include "transport.h"
14 #include "version.h"
15 #include "oid-array.h"
16 #include "gpg-interface.h"
17 #include "cache.h"
18 #include "shallow.h"
19
20 int option_parse_push_signed(const struct option *opt,
21                              const char *arg, int unset)
22 {
23         if (unset) {
24                 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_NEVER;
25                 return 0;
26         }
27         switch (git_parse_maybe_bool(arg)) {
28         case 1:
29                 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_ALWAYS;
30                 return 0;
31         case 0:
32                 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_NEVER;
33                 return 0;
34         }
35         if (!strcasecmp("if-asked", arg)) {
36                 *(int *)(opt->value) = SEND_PACK_PUSH_CERT_IF_ASKED;
37                 return 0;
38         }
39         die("bad %s argument: %s", opt->long_name, arg);
40 }
41
42 static void feed_object(const struct object_id *oid, FILE *fh, int negative)
43 {
44         if (negative &&
45             !has_object_file_with_flags(oid,
46                                         OBJECT_INFO_SKIP_FETCH_OBJECT |
47                                         OBJECT_INFO_QUICK))
48                 return;
49
50         if (negative)
51                 putc('^', fh);
52         fputs(oid_to_hex(oid), fh);
53         putc('\n', fh);
54 }
55
56 /*
57  * Make a pack stream and spit it out into file descriptor fd
58  */
59 static int pack_objects(int fd, struct ref *refs, struct oid_array *extra, struct send_pack_args *args)
60 {
61         /*
62          * The child becomes pack-objects --revs; we feed
63          * the revision parameters to it via its stdin and
64          * let its stdout go back to the other end.
65          */
66         struct child_process po = CHILD_PROCESS_INIT;
67         FILE *po_in;
68         int i;
69         int rc;
70
71         strvec_push(&po.args, "pack-objects");
72         strvec_push(&po.args, "--all-progress-implied");
73         strvec_push(&po.args, "--revs");
74         strvec_push(&po.args, "--stdout");
75         if (args->use_thin_pack)
76                 strvec_push(&po.args, "--thin");
77         if (args->use_ofs_delta)
78                 strvec_push(&po.args, "--delta-base-offset");
79         if (args->quiet || !args->progress)
80                 strvec_push(&po.args, "-q");
81         if (args->progress)
82                 strvec_push(&po.args, "--progress");
83         if (is_repository_shallow(the_repository))
84                 strvec_push(&po.args, "--shallow");
85         po.in = -1;
86         po.out = args->stateless_rpc ? -1 : fd;
87         po.git_cmd = 1;
88         if (start_command(&po))
89                 die_errno("git pack-objects failed");
90
91         /*
92          * We feed the pack-objects we just spawned with revision
93          * parameters by writing to the pipe.
94          */
95         po_in = xfdopen(po.in, "w");
96         for (i = 0; i < extra->nr; i++)
97                 feed_object(&extra->oid[i], po_in, 1);
98
99         while (refs) {
100                 if (!is_null_oid(&refs->old_oid))
101                         feed_object(&refs->old_oid, po_in, 1);
102                 if (!is_null_oid(&refs->new_oid))
103                         feed_object(&refs->new_oid, po_in, 0);
104                 refs = refs->next;
105         }
106
107         fflush(po_in);
108         if (ferror(po_in))
109                 die_errno("error writing to pack-objects");
110         fclose(po_in);
111
112         if (args->stateless_rpc) {
113                 char *buf = xmalloc(LARGE_PACKET_MAX);
114                 while (1) {
115                         ssize_t n = xread(po.out, buf, LARGE_PACKET_MAX);
116                         if (n <= 0)
117                                 break;
118                         send_sideband(fd, -1, buf, n, LARGE_PACKET_MAX);
119                 }
120                 free(buf);
121                 close(po.out);
122                 po.out = -1;
123         }
124
125         rc = finish_command(&po);
126         if (rc) {
127                 /*
128                  * For a normal non-zero exit, we assume pack-objects wrote
129                  * something useful to stderr. For death by signal, though,
130                  * we should mention it to the user. The exception is SIGPIPE
131                  * (141), because that's a normal occurrence if the remote end
132                  * hangs up (and we'll report that by trying to read the unpack
133                  * status).
134                  */
135                 if (rc > 128 && rc != 141)
136                         error("pack-objects died of signal %d", rc - 128);
137                 return -1;
138         }
139         return 0;
140 }
141
142 static int receive_unpack_status(struct packet_reader *reader)
143 {
144         if (packet_reader_read(reader) != PACKET_READ_NORMAL)
145                 return error(_("unexpected flush packet while reading remote unpack status"));
146         if (!skip_prefix(reader->line, "unpack ", &reader->line))
147                 return error(_("unable to parse remote unpack status: %s"), reader->line);
148         if (strcmp(reader->line, "ok"))
149                 return error(_("remote unpack failed: %s"), reader->line);
150         return 0;
151 }
152
153 static int receive_status(struct packet_reader *reader, struct ref *refs)
154 {
155         struct ref *hint;
156         int ret;
157         struct ref_push_report *report = NULL;
158         int new_report = 0;
159         int once = 0;
160
161         hint = NULL;
162         ret = receive_unpack_status(reader);
163         while (1) {
164                 struct object_id old_oid, new_oid;
165                 const char *head;
166                 const char *refname;
167                 char *p;
168                 if (packet_reader_read(reader) != PACKET_READ_NORMAL)
169                         break;
170                 head = reader->line;
171                 p = strchr(head, ' ');
172                 if (!p) {
173                         error("invalid status line from remote: %s", reader->line);
174                         ret = -1;
175                         break;
176                 }
177                 *p++ = '\0';
178
179                 if (!strcmp(head, "option")) {
180                         const char *key, *val;
181
182                         if (!hint || !(report || new_report)) {
183                                 if (!once++)
184                                         error("'option' without a matching 'ok/ng' directive");
185                                 ret = -1;
186                                 continue;
187                         }
188                         if (new_report) {
189                                 if (!hint->report) {
190                                         hint->report = xcalloc(1, sizeof(struct ref_push_report));
191                                         report = hint->report;
192                                 } else {
193                                         report = hint->report;
194                                         while (report->next)
195                                                 report = report->next;
196                                         report->next = xcalloc(1, sizeof(struct ref_push_report));
197                                         report = report->next;
198                                 }
199                                 new_report = 0;
200                         }
201                         key = p;
202                         p = strchr(key, ' ');
203                         if (p)
204                                 *p++ = '\0';
205                         val = p;
206                         if (!strcmp(key, "refname"))
207                                 report->ref_name = xstrdup_or_null(val);
208                         else if (!strcmp(key, "old-oid") && val &&
209                                  !parse_oid_hex(val, &old_oid, &val))
210                                 report->old_oid = oiddup(&old_oid);
211                         else if (!strcmp(key, "new-oid") && val &&
212                                  !parse_oid_hex(val, &new_oid, &val))
213                                 report->new_oid = oiddup(&new_oid);
214                         else if (!strcmp(key, "forced-update"))
215                                 report->forced_update = 1;
216                         continue;
217                 }
218
219                 report = NULL;
220                 new_report = 0;
221                 if (strcmp(head, "ok") && strcmp(head, "ng")) {
222                         error("invalid ref status from remote: %s", head);
223                         ret = -1;
224                         break;
225                 }
226                 refname = p;
227                 p = strchr(refname, ' ');
228                 if (p)
229                         *p++ = '\0';
230                 /* first try searching at our hint, falling back to all refs */
231                 if (hint)
232                         hint = find_ref_by_name(hint, refname);
233                 if (!hint)
234                         hint = find_ref_by_name(refs, refname);
235                 if (!hint) {
236                         warning("remote reported status on unknown ref: %s",
237                                 refname);
238                         continue;
239                 }
240                 if (hint->status != REF_STATUS_EXPECTING_REPORT &&
241                     hint->status != REF_STATUS_OK &&
242                     hint->status != REF_STATUS_REMOTE_REJECT) {
243                         warning("remote reported status on unexpected ref: %s",
244                                 refname);
245                         continue;
246                 }
247                 if (!strcmp(head, "ng")) {
248                         hint->status = REF_STATUS_REMOTE_REJECT;
249                         if (p)
250                                 hint->remote_status = xstrdup(p);
251                         else
252                                 hint->remote_status = "failed";
253                 } else {
254                         hint->status = REF_STATUS_OK;
255                         hint->remote_status = xstrdup_or_null(p);
256                         new_report = 1;
257                 }
258         }
259         return ret;
260 }
261
262 static int sideband_demux(int in, int out, void *data)
263 {
264         int *fd = data, ret;
265         if (async_with_fork())
266                 close(fd[1]);
267         ret = recv_sideband("send-pack", fd[0], out);
268         close(out);
269         return ret;
270 }
271
272 static int advertise_shallow_grafts_cb(const struct commit_graft *graft, void *cb)
273 {
274         struct strbuf *sb = cb;
275         if (graft->nr_parent == -1)
276                 packet_buf_write(sb, "shallow %s\n", oid_to_hex(&graft->oid));
277         return 0;
278 }
279
280 static void advertise_shallow_grafts_buf(struct strbuf *sb)
281 {
282         if (!is_repository_shallow(the_repository))
283                 return;
284         for_each_commit_graft(advertise_shallow_grafts_cb, sb);
285 }
286
287 #define CHECK_REF_NO_PUSH -1
288 #define CHECK_REF_STATUS_REJECTED -2
289 #define CHECK_REF_UPTODATE -3
290 static int check_to_send_update(const struct ref *ref, const struct send_pack_args *args)
291 {
292         if (!ref->peer_ref && !args->send_mirror)
293                 return CHECK_REF_NO_PUSH;
294
295         /* Check for statuses set by set_ref_status_for_push() */
296         switch (ref->status) {
297         case REF_STATUS_REJECT_NONFASTFORWARD:
298         case REF_STATUS_REJECT_ALREADY_EXISTS:
299         case REF_STATUS_REJECT_FETCH_FIRST:
300         case REF_STATUS_REJECT_NEEDS_FORCE:
301         case REF_STATUS_REJECT_STALE:
302         case REF_STATUS_REJECT_NODELETE:
303                 return CHECK_REF_STATUS_REJECTED;
304         case REF_STATUS_UPTODATE:
305                 return CHECK_REF_UPTODATE;
306
307         default:
308         case REF_STATUS_EXPECTING_REPORT:
309                 /* already passed checks on the local side */
310         case REF_STATUS_OK:
311                 /* of course this is OK */
312                 return 0;
313         }
314 }
315
316 /*
317  * the beginning of the next line, or the end of buffer.
318  *
319  * NEEDSWORK: perhaps move this to git-compat-util.h or somewhere and
320  * convert many similar uses found by "git grep -A4 memchr".
321  */
322 static const char *next_line(const char *line, size_t len)
323 {
324         const char *nl = memchr(line, '\n', len);
325         if (!nl)
326                 return line + len; /* incomplete line */
327         return nl + 1;
328 }
329
330 static int generate_push_cert(struct strbuf *req_buf,
331                               const struct ref *remote_refs,
332                               struct send_pack_args *args,
333                               const char *cap_string,
334                               const char *push_cert_nonce)
335 {
336         const struct ref *ref;
337         struct string_list_item *item;
338         char *signing_key = xstrdup(get_signing_key());
339         const char *cp, *np;
340         struct strbuf cert = STRBUF_INIT;
341         int update_seen = 0;
342
343         strbuf_addstr(&cert, "certificate version 0.1\n");
344         strbuf_addf(&cert, "pusher %s ", signing_key);
345         datestamp(&cert);
346         strbuf_addch(&cert, '\n');
347         if (args->url && *args->url) {
348                 char *anon_url = transport_anonymize_url(args->url);
349                 strbuf_addf(&cert, "pushee %s\n", anon_url);
350                 free(anon_url);
351         }
352         if (push_cert_nonce[0])
353                 strbuf_addf(&cert, "nonce %s\n", push_cert_nonce);
354         if (args->push_options)
355                 for_each_string_list_item(item, args->push_options)
356                         strbuf_addf(&cert, "push-option %s\n", item->string);
357         strbuf_addstr(&cert, "\n");
358
359         for (ref = remote_refs; ref; ref = ref->next) {
360                 if (check_to_send_update(ref, args) < 0)
361                         continue;
362                 update_seen = 1;
363                 strbuf_addf(&cert, "%s %s %s\n",
364                             oid_to_hex(&ref->old_oid),
365                             oid_to_hex(&ref->new_oid),
366                             ref->name);
367         }
368         if (!update_seen)
369                 goto free_return;
370
371         if (sign_buffer(&cert, &cert, signing_key))
372                 die(_("failed to sign the push certificate"));
373
374         packet_buf_write(req_buf, "push-cert%c%s", 0, cap_string);
375         for (cp = cert.buf; cp < cert.buf + cert.len; cp = np) {
376                 np = next_line(cp, cert.buf + cert.len - cp);
377                 packet_buf_write(req_buf,
378                                  "%.*s", (int)(np - cp), cp);
379         }
380         packet_buf_write(req_buf, "push-cert-end\n");
381
382 free_return:
383         free(signing_key);
384         strbuf_release(&cert);
385         return update_seen;
386 }
387
388 #define NONCE_LEN_LIMIT 256
389
390 static void reject_invalid_nonce(const char *nonce, int len)
391 {
392         int i = 0;
393
394         if (NONCE_LEN_LIMIT <= len)
395                 die("the receiving end asked to sign an invalid nonce <%.*s>",
396                     len, nonce);
397
398         for (i = 0; i < len; i++) {
399                 int ch = nonce[i] & 0xFF;
400                 if (isalnum(ch) ||
401                     ch == '-' || ch == '.' ||
402                     ch == '/' || ch == '+' ||
403                     ch == '=' || ch == '_')
404                         continue;
405                 die("the receiving end asked to sign an invalid nonce <%.*s>",
406                     len, nonce);
407         }
408 }
409
410 int send_pack(struct send_pack_args *args,
411               int fd[], struct child_process *conn,
412               struct ref *remote_refs,
413               struct oid_array *extra_have)
414 {
415         int in = fd[0];
416         int out = fd[1];
417         struct strbuf req_buf = STRBUF_INIT;
418         struct strbuf cap_buf = STRBUF_INIT;
419         struct ref *ref;
420         int need_pack_data = 0;
421         int allow_deleting_refs = 0;
422         int status_report = 0;
423         int use_sideband = 0;
424         int quiet_supported = 0;
425         int agent_supported = 0;
426         int use_atomic = 0;
427         int atomic_supported = 0;
428         int use_push_options = 0;
429         int push_options_supported = 0;
430         int object_format_supported = 0;
431         unsigned cmds_sent = 0;
432         int ret;
433         struct async demux;
434         const char *push_cert_nonce = NULL;
435         struct packet_reader reader;
436
437         /* Does the other end support the reporting? */
438         if (server_supports("report-status-v2"))
439                 status_report = 2;
440         else if (server_supports("report-status"))
441                 status_report = 1;
442         if (server_supports("delete-refs"))
443                 allow_deleting_refs = 1;
444         if (server_supports("ofs-delta"))
445                 args->use_ofs_delta = 1;
446         if (server_supports("side-band-64k"))
447                 use_sideband = 1;
448         if (server_supports("quiet"))
449                 quiet_supported = 1;
450         if (server_supports("agent"))
451                 agent_supported = 1;
452         if (server_supports("no-thin"))
453                 args->use_thin_pack = 0;
454         if (server_supports("atomic"))
455                 atomic_supported = 1;
456         if (server_supports("push-options"))
457                 push_options_supported = 1;
458
459         if (!server_supports_hash(the_hash_algo->name, &object_format_supported))
460                 die(_("the receiving end does not support this repository's hash algorithm"));
461
462         if (args->push_cert != SEND_PACK_PUSH_CERT_NEVER) {
463                 int len;
464                 push_cert_nonce = server_feature_value("push-cert", &len);
465                 if (push_cert_nonce) {
466                         reject_invalid_nonce(push_cert_nonce, len);
467                         push_cert_nonce = xmemdupz(push_cert_nonce, len);
468                 } else if (args->push_cert == SEND_PACK_PUSH_CERT_ALWAYS) {
469                         die(_("the receiving end does not support --signed push"));
470                 } else if (args->push_cert == SEND_PACK_PUSH_CERT_IF_ASKED) {
471                         warning(_("not sending a push certificate since the"
472                                   " receiving end does not support --signed"
473                                   " push"));
474                 }
475         }
476
477         if (!remote_refs) {
478                 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
479                         "Perhaps you should specify a branch.\n");
480                 return 0;
481         }
482         if (args->atomic && !atomic_supported)
483                 die(_("the receiving end does not support --atomic push"));
484
485         use_atomic = atomic_supported && args->atomic;
486
487         if (args->push_options && !push_options_supported)
488                 die(_("the receiving end does not support push options"));
489
490         use_push_options = push_options_supported && args->push_options;
491
492         if (status_report == 1)
493                 strbuf_addstr(&cap_buf, " report-status");
494         else if (status_report == 2)
495                 strbuf_addstr(&cap_buf, " report-status-v2");
496         if (use_sideband)
497                 strbuf_addstr(&cap_buf, " side-band-64k");
498         if (quiet_supported && (args->quiet || !args->progress))
499                 strbuf_addstr(&cap_buf, " quiet");
500         if (use_atomic)
501                 strbuf_addstr(&cap_buf, " atomic");
502         if (use_push_options)
503                 strbuf_addstr(&cap_buf, " push-options");
504         if (object_format_supported)
505                 strbuf_addf(&cap_buf, " object-format=%s", the_hash_algo->name);
506         if (agent_supported)
507                 strbuf_addf(&cap_buf, " agent=%s", git_user_agent_sanitized());
508
509         /*
510          * NEEDSWORK: why does delete-refs have to be so specific to
511          * send-pack machinery that set_ref_status_for_push() cannot
512          * set this bit for us???
513          */
514         for (ref = remote_refs; ref; ref = ref->next)
515                 if (ref->deletion && !allow_deleting_refs)
516                         ref->status = REF_STATUS_REJECT_NODELETE;
517
518         /*
519          * Clear the status for each ref and see if we need to send
520          * the pack data.
521          */
522         for (ref = remote_refs; ref; ref = ref->next) {
523                 switch (check_to_send_update(ref, args)) {
524                 case 0: /* no error */
525                         break;
526                 case CHECK_REF_STATUS_REJECTED:
527                         /*
528                          * When we know the server would reject a ref update if
529                          * we were to send it and we're trying to send the refs
530                          * atomically, abort the whole operation.
531                          */
532                         if (use_atomic) {
533                                 strbuf_release(&req_buf);
534                                 strbuf_release(&cap_buf);
535                                 reject_atomic_push(remote_refs, args->send_mirror);
536                                 error("atomic push failed for ref %s. status: %d\n",
537                                       ref->name, ref->status);
538                                 return args->porcelain ? 0 : -1;
539                         }
540                         /* else fallthrough */
541                 default:
542                         continue;
543                 }
544                 if (!ref->deletion)
545                         need_pack_data = 1;
546
547                 if (args->dry_run || !status_report)
548                         ref->status = REF_STATUS_OK;
549                 else
550                         ref->status = REF_STATUS_EXPECTING_REPORT;
551         }
552
553         if (!args->dry_run)
554                 advertise_shallow_grafts_buf(&req_buf);
555
556         /*
557          * Finally, tell the other end!
558          */
559         if (!args->dry_run && push_cert_nonce)
560                 cmds_sent = generate_push_cert(&req_buf, remote_refs, args,
561                                                cap_buf.buf, push_cert_nonce);
562         else if (!args->dry_run)
563                 for (ref = remote_refs; ref; ref = ref->next) {
564                         char *old_hex, *new_hex;
565
566                         if (check_to_send_update(ref, args) < 0)
567                                 continue;
568
569                         old_hex = oid_to_hex(&ref->old_oid);
570                         new_hex = oid_to_hex(&ref->new_oid);
571                         if (!cmds_sent) {
572                                 packet_buf_write(&req_buf,
573                                                  "%s %s %s%c%s",
574                                                  old_hex, new_hex, ref->name, 0,
575                                                  cap_buf.buf);
576                                 cmds_sent = 1;
577                         } else {
578                                 packet_buf_write(&req_buf, "%s %s %s",
579                                                  old_hex, new_hex, ref->name);
580                         }
581                 }
582
583         if (use_push_options) {
584                 struct string_list_item *item;
585
586                 packet_buf_flush(&req_buf);
587                 for_each_string_list_item(item, args->push_options)
588                         packet_buf_write(&req_buf, "%s", item->string);
589         }
590
591         if (args->stateless_rpc) {
592                 if (!args->dry_run && (cmds_sent || is_repository_shallow(the_repository))) {
593                         packet_buf_flush(&req_buf);
594                         send_sideband(out, -1, req_buf.buf, req_buf.len, LARGE_PACKET_MAX);
595                 }
596         } else {
597                 write_or_die(out, req_buf.buf, req_buf.len);
598                 packet_flush(out);
599         }
600         strbuf_release(&req_buf);
601         strbuf_release(&cap_buf);
602
603         if (use_sideband && cmds_sent) {
604                 memset(&demux, 0, sizeof(demux));
605                 demux.proc = sideband_demux;
606                 demux.data = fd;
607                 demux.out = -1;
608                 demux.isolate_sigpipe = 1;
609                 if (start_async(&demux))
610                         die("send-pack: unable to fork off sideband demultiplexer");
611                 in = demux.out;
612         }
613
614         packet_reader_init(&reader, in, NULL, 0,
615                            PACKET_READ_CHOMP_NEWLINE |
616                            PACKET_READ_DIE_ON_ERR_PACKET);
617
618         if (need_pack_data && cmds_sent) {
619                 if (pack_objects(out, remote_refs, extra_have, args) < 0) {
620                         if (args->stateless_rpc)
621                                 close(out);
622                         if (git_connection_is_socket(conn))
623                                 shutdown(fd[0], SHUT_WR);
624
625                         /*
626                          * Do not even bother with the return value; we know we
627                          * are failing, and just want the error() side effects,
628                          * as well as marking refs with their remote status (if
629                          * we get one).
630                          */
631                         if (status_report)
632                                 receive_status(&reader, remote_refs);
633
634                         if (use_sideband) {
635                                 close(demux.out);
636                                 finish_async(&demux);
637                         }
638                         fd[1] = -1;
639                         return -1;
640                 }
641                 if (!args->stateless_rpc)
642                         /* Closed by pack_objects() via start_command() */
643                         fd[1] = -1;
644         }
645         if (args->stateless_rpc && cmds_sent)
646                 packet_flush(out);
647
648         if (status_report && cmds_sent)
649                 ret = receive_status(&reader, remote_refs);
650         else
651                 ret = 0;
652         if (args->stateless_rpc)
653                 packet_flush(out);
654
655         if (use_sideband && cmds_sent) {
656                 close(demux.out);
657                 if (finish_async(&demux)) {
658                         error("error in sideband demultiplexer");
659                         ret = -1;
660                 }
661         }
662
663         if (ret < 0)
664                 return ret;
665
666         if (args->porcelain)
667                 return 0;
668
669         for (ref = remote_refs; ref; ref = ref->next) {
670                 switch (ref->status) {
671                 case REF_STATUS_NONE:
672                 case REF_STATUS_UPTODATE:
673                 case REF_STATUS_OK:
674                         break;
675                 default:
676                         return -1;
677                 }
678         }
679         return 0;
680 }