Documentation/describe: improve one-line summary
[git.git] / send-pack.c
blob949cb61aa0d681e30b7e8199ef9e31ff0caee089
1 #include "builtin.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 "connect.h"
9 #include "send-pack.h"
10 #include "quote.h"
11 #include "transport.h"
12 #include "version.h"
13 #include "sha1-array.h"
14 #include "gpg-interface.h"
16 static int feed_object(const unsigned char *sha1, int fd, int negative)
18 char buf[42];
20 if (negative && !has_sha1_file(sha1))
21 return 1;
23 memcpy(buf + negative, sha1_to_hex(sha1), 40);
24 if (negative)
25 buf[0] = '^';
26 buf[40 + negative] = '\n';
27 return write_or_whine(fd, buf, 41 + negative, "send-pack: send refs");
31 * Make a pack stream and spit it out into file descriptor fd
33 static int pack_objects(int fd, struct ref *refs, struct sha1_array *extra, struct send_pack_args *args)
36 * The child becomes pack-objects --revs; we feed
37 * the revision parameters to it via its stdin and
38 * let its stdout go back to the other end.
40 const char *argv[] = {
41 "pack-objects",
42 "--all-progress-implied",
43 "--revs",
44 "--stdout",
45 NULL,
46 NULL,
47 NULL,
48 NULL,
49 NULL,
51 struct child_process po = CHILD_PROCESS_INIT;
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 || !args->progress)
60 argv[i++] = "-q";
61 if (args->progress)
62 argv[i++] = "--progress";
63 po.argv = argv;
64 po.in = -1;
65 po.out = args->stateless_rpc ? -1 : fd;
66 po.git_cmd = 1;
67 if (start_command(&po))
68 die_errno("git pack-objects failed");
71 * We feed the pack-objects we just spawned with revision
72 * parameters by writing to the pipe.
74 for (i = 0; i < extra->nr; i++)
75 if (!feed_object(extra->sha1[i], po.in, 1))
76 break;
78 while (refs) {
79 if (!is_null_sha1(refs->old_sha1) &&
80 !feed_object(refs->old_sha1, po.in, 1))
81 break;
82 if (!is_null_sha1(refs->new_sha1) &&
83 !feed_object(refs->new_sha1, po.in, 0))
84 break;
85 refs = refs->next;
88 close(po.in);
90 if (args->stateless_rpc) {
91 char *buf = xmalloc(LARGE_PACKET_MAX);
92 while (1) {
93 ssize_t n = xread(po.out, buf, LARGE_PACKET_MAX);
94 if (n <= 0)
95 break;
96 send_sideband(fd, -1, buf, n, LARGE_PACKET_MAX);
98 free(buf);
99 close(po.out);
100 po.out = -1;
103 if (finish_command(&po))
104 return -1;
105 return 0;
108 static int receive_status(int in, struct ref *refs)
110 struct ref *hint;
111 int ret = 0;
112 char *line = packet_read_line(in, NULL);
113 if (!starts_with(line, "unpack "))
114 return error("did not receive remote status");
115 if (strcmp(line, "unpack ok")) {
116 error("unpack failed: %s", line + 7);
117 ret = -1;
119 hint = NULL;
120 while (1) {
121 char *refname;
122 char *msg;
123 line = packet_read_line(in, NULL);
124 if (!line)
125 break;
126 if (!starts_with(line, "ok ") && !starts_with(line, "ng ")) {
127 error("invalid ref status from remote: %s", line);
128 ret = -1;
129 break;
132 refname = line + 3;
133 msg = strchr(refname, ' ');
134 if (msg)
135 *msg++ = '\0';
137 /* first try searching at our hint, falling back to all refs */
138 if (hint)
139 hint = find_ref_by_name(hint, refname);
140 if (!hint)
141 hint = find_ref_by_name(refs, refname);
142 if (!hint) {
143 warning("remote reported status on unknown ref: %s",
144 refname);
145 continue;
147 if (hint->status != REF_STATUS_EXPECTING_REPORT) {
148 warning("remote reported status on unexpected ref: %s",
149 refname);
150 continue;
153 if (line[0] == 'o' && line[1] == 'k')
154 hint->status = REF_STATUS_OK;
155 else {
156 hint->status = REF_STATUS_REMOTE_REJECT;
157 ret = -1;
159 if (msg)
160 hint->remote_status = xstrdup(msg);
161 /* start our next search from the next ref */
162 hint = hint->next;
164 return ret;
167 static int sideband_demux(int in, int out, void *data)
169 int *fd = data, ret;
170 #ifdef NO_PTHREADS
171 close(fd[1]);
172 #endif
173 ret = recv_sideband("send-pack", fd[0], out);
174 close(out);
175 return ret;
178 static int advertise_shallow_grafts_cb(const struct commit_graft *graft, void *cb)
180 struct strbuf *sb = cb;
181 if (graft->nr_parent == -1)
182 packet_buf_write(sb, "shallow %s\n", sha1_to_hex(graft->sha1));
183 return 0;
186 static void advertise_shallow_grafts_buf(struct strbuf *sb)
188 if (!is_repository_shallow())
189 return;
190 for_each_commit_graft(advertise_shallow_grafts_cb, sb);
193 static int ref_update_to_be_sent(const struct ref *ref, const struct send_pack_args *args)
195 if (!ref->peer_ref && !args->send_mirror)
196 return 0;
198 /* Check for statuses set by set_ref_status_for_push() */
199 switch (ref->status) {
200 case REF_STATUS_REJECT_NONFASTFORWARD:
201 case REF_STATUS_REJECT_ALREADY_EXISTS:
202 case REF_STATUS_REJECT_FETCH_FIRST:
203 case REF_STATUS_REJECT_NEEDS_FORCE:
204 case REF_STATUS_REJECT_STALE:
205 case REF_STATUS_REJECT_NODELETE:
206 case REF_STATUS_UPTODATE:
207 return 0;
208 default:
209 return 1;
214 * the beginning of the next line, or the end of buffer.
216 * NEEDSWORK: perhaps move this to git-compat-util.h or somewhere and
217 * convert many similar uses found by "git grep -A4 memchr".
219 static const char *next_line(const char *line, size_t len)
221 const char *nl = memchr(line, '\n', len);
222 if (!nl)
223 return line + len; /* incomplete line */
224 return nl + 1;
227 static int generate_push_cert(struct strbuf *req_buf,
228 const struct ref *remote_refs,
229 struct send_pack_args *args,
230 const char *cap_string,
231 const char *push_cert_nonce)
233 const struct ref *ref;
234 char *signing_key = xstrdup(get_signing_key());
235 const char *cp, *np;
236 struct strbuf cert = STRBUF_INIT;
237 int update_seen = 0;
239 strbuf_addf(&cert, "certificate version 0.1\n");
240 strbuf_addf(&cert, "pusher %s ", signing_key);
241 datestamp(&cert);
242 strbuf_addch(&cert, '\n');
243 if (args->url && *args->url) {
244 char *anon_url = transport_anonymize_url(args->url);
245 strbuf_addf(&cert, "pushee %s\n", anon_url);
246 free(anon_url);
248 if (push_cert_nonce[0])
249 strbuf_addf(&cert, "nonce %s\n", push_cert_nonce);
250 strbuf_addstr(&cert, "\n");
252 for (ref = remote_refs; ref; ref = ref->next) {
253 if (!ref_update_to_be_sent(ref, args))
254 continue;
255 update_seen = 1;
256 strbuf_addf(&cert, "%s %s %s\n",
257 sha1_to_hex(ref->old_sha1),
258 sha1_to_hex(ref->new_sha1),
259 ref->name);
261 if (!update_seen)
262 goto free_return;
264 if (sign_buffer(&cert, &cert, signing_key))
265 die(_("failed to sign the push certificate"));
267 packet_buf_write(req_buf, "push-cert%c%s", 0, cap_string);
268 for (cp = cert.buf; cp < cert.buf + cert.len; cp = np) {
269 np = next_line(cp, cert.buf + cert.len - cp);
270 packet_buf_write(req_buf,
271 "%.*s", (int)(np - cp), cp);
273 packet_buf_write(req_buf, "push-cert-end\n");
275 free_return:
276 free(signing_key);
277 strbuf_release(&cert);
278 return update_seen;
281 int send_pack(struct send_pack_args *args,
282 int fd[], struct child_process *conn,
283 struct ref *remote_refs,
284 struct sha1_array *extra_have)
286 int in = fd[0];
287 int out = fd[1];
288 struct strbuf req_buf = STRBUF_INIT;
289 struct strbuf cap_buf = STRBUF_INIT;
290 struct ref *ref;
291 int need_pack_data = 0;
292 int allow_deleting_refs = 0;
293 int status_report = 0;
294 int use_sideband = 0;
295 int quiet_supported = 0;
296 int agent_supported = 0;
297 unsigned cmds_sent = 0;
298 int ret;
299 struct async demux;
300 const char *push_cert_nonce = NULL;
302 /* Does the other end support the reporting? */
303 if (server_supports("report-status"))
304 status_report = 1;
305 if (server_supports("delete-refs"))
306 allow_deleting_refs = 1;
307 if (server_supports("ofs-delta"))
308 args->use_ofs_delta = 1;
309 if (server_supports("side-band-64k"))
310 use_sideband = 1;
311 if (server_supports("quiet"))
312 quiet_supported = 1;
313 if (server_supports("agent"))
314 agent_supported = 1;
315 if (server_supports("no-thin"))
316 args->use_thin_pack = 0;
317 if (args->push_cert) {
318 int len;
320 push_cert_nonce = server_feature_value("push-cert", &len);
321 if (!push_cert_nonce)
322 die(_("the receiving end does not support --signed push"));
323 push_cert_nonce = xmemdupz(push_cert_nonce, len);
326 if (!remote_refs) {
327 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
328 "Perhaps you should specify a branch such as 'master'.\n");
329 return 0;
332 if (status_report)
333 strbuf_addstr(&cap_buf, " report-status");
334 if (use_sideband)
335 strbuf_addstr(&cap_buf, " side-band-64k");
336 if (quiet_supported && (args->quiet || !args->progress))
337 strbuf_addstr(&cap_buf, " quiet");
338 if (agent_supported)
339 strbuf_addf(&cap_buf, " agent=%s", git_user_agent_sanitized());
342 * NEEDSWORK: why does delete-refs have to be so specific to
343 * send-pack machinery that set_ref_status_for_push() cannot
344 * set this bit for us???
346 for (ref = remote_refs; ref; ref = ref->next)
347 if (ref->deletion && !allow_deleting_refs)
348 ref->status = REF_STATUS_REJECT_NODELETE;
350 if (!args->dry_run)
351 advertise_shallow_grafts_buf(&req_buf);
353 if (!args->dry_run && args->push_cert)
354 cmds_sent = generate_push_cert(&req_buf, remote_refs, args,
355 cap_buf.buf, push_cert_nonce);
358 * Clear the status for each ref and see if we need to send
359 * the pack data.
361 for (ref = remote_refs; ref; ref = ref->next) {
362 if (!ref_update_to_be_sent(ref, args))
363 continue;
365 if (!ref->deletion)
366 need_pack_data = 1;
368 if (args->dry_run || !status_report)
369 ref->status = REF_STATUS_OK;
370 else
371 ref->status = REF_STATUS_EXPECTING_REPORT;
375 * Finally, tell the other end!
377 for (ref = remote_refs; ref; ref = ref->next) {
378 char *old_hex, *new_hex;
380 if (args->dry_run || args->push_cert)
381 continue;
383 if (!ref_update_to_be_sent(ref, args))
384 continue;
386 old_hex = sha1_to_hex(ref->old_sha1);
387 new_hex = sha1_to_hex(ref->new_sha1);
388 if (!cmds_sent) {
389 packet_buf_write(&req_buf,
390 "%s %s %s%c%s",
391 old_hex, new_hex, ref->name, 0,
392 cap_buf.buf);
393 cmds_sent = 1;
394 } else {
395 packet_buf_write(&req_buf, "%s %s %s",
396 old_hex, new_hex, ref->name);
400 if (args->stateless_rpc) {
401 if (!args->dry_run && (cmds_sent || is_repository_shallow())) {
402 packet_buf_flush(&req_buf);
403 send_sideband(out, -1, req_buf.buf, req_buf.len, LARGE_PACKET_MAX);
405 } else {
406 write_or_die(out, req_buf.buf, req_buf.len);
407 packet_flush(out);
409 strbuf_release(&req_buf);
410 strbuf_release(&cap_buf);
412 if (use_sideband && cmds_sent) {
413 memset(&demux, 0, sizeof(demux));
414 demux.proc = sideband_demux;
415 demux.data = fd;
416 demux.out = -1;
417 if (start_async(&demux))
418 die("send-pack: unable to fork off sideband demultiplexer");
419 in = demux.out;
422 if (need_pack_data && cmds_sent) {
423 if (pack_objects(out, remote_refs, extra_have, args) < 0) {
424 for (ref = remote_refs; ref; ref = ref->next)
425 ref->status = REF_STATUS_NONE;
426 if (args->stateless_rpc)
427 close(out);
428 if (git_connection_is_socket(conn))
429 shutdown(fd[0], SHUT_WR);
430 if (use_sideband)
431 finish_async(&demux);
432 fd[1] = -1;
433 return -1;
435 if (!args->stateless_rpc)
436 /* Closed by pack_objects() via start_command() */
437 fd[1] = -1;
439 if (args->stateless_rpc && cmds_sent)
440 packet_flush(out);
442 if (status_report && cmds_sent)
443 ret = receive_status(in, remote_refs);
444 else
445 ret = 0;
446 if (args->stateless_rpc)
447 packet_flush(out);
449 if (use_sideband && cmds_sent) {
450 if (finish_async(&demux)) {
451 error("error in sideband demultiplexer");
452 ret = -1;
454 close(demux.out);
457 if (ret < 0)
458 return ret;
460 if (args->porcelain)
461 return 0;
463 for (ref = remote_refs; ref; ref = ref->next) {
464 switch (ref->status) {
465 case REF_STATUS_NONE:
466 case REF_STATUS_UPTODATE:
467 case REF_STATUS_OK:
468 break;
469 default:
470 return -1;
473 return 0;