Documentation: fix typos, grammar, asciidoc syntax
[git/jnareb-git.git] / builtin-send-pack.c
bloba9fdbf9d45ddd84e6397ab3e559b06e105c52a19
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"
10 static 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.";
14 static struct send_pack_args args = {
15 /* .receivepack = */ "git-receive-pack",
19 * Make a pack stream and spit it out into file descriptor fd
21 static int pack_objects(int fd, struct ref *refs, struct extra_have_objects *extra)
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.
28 const char *argv[] = {
29 "pack-objects",
30 "--all-progress",
31 "--revs",
32 "--stdout",
33 NULL,
34 NULL,
36 struct child_process po;
37 int i;
38 char buf[42];
40 if (args.use_thin_pack)
41 argv[4] = "--thin";
42 memset(&po, 0, sizeof(po));
43 po.argv = argv;
44 po.in = -1;
45 po.out = fd;
46 po.git_cmd = 1;
47 if (start_command(&po))
48 die("git pack-objects failed (%s)", strerror(errno));
51 * We feed the pack-objects we just spawned with revision
52 * parameters by writing to the pipe.
54 for (i = 0; i < extra->nr; i++) {
55 memcpy(buf + 1, sha1_to_hex(&extra->array[i][0]), 40);
56 buf[0] = '^';
57 buf[41] = '\n';
58 if (!write_or_whine(po.in, buf, 42, "send-pack: send refs"))
59 break;
62 while (refs) {
63 if (!is_null_sha1(refs->old_sha1) &&
64 has_sha1_file(refs->old_sha1)) {
65 memcpy(buf + 1, sha1_to_hex(refs->old_sha1), 40);
66 buf[0] = '^';
67 buf[41] = '\n';
68 if (!write_or_whine(po.in, buf, 42,
69 "send-pack: send refs"))
70 break;
72 if (!is_null_sha1(refs->new_sha1)) {
73 memcpy(buf, sha1_to_hex(refs->new_sha1), 40);
74 buf[40] = '\n';
75 if (!write_or_whine(po.in, buf, 41,
76 "send-pack: send refs"))
77 break;
79 refs = refs->next;
82 close(po.in);
83 if (finish_command(&po))
84 return error("pack-objects died with strange error");
85 return 0;
88 static void unmark_and_free(struct commit_list *list, unsigned int mark)
90 while (list) {
91 struct commit_list *temp = list;
92 temp->item->object.flags &= ~mark;
93 list = temp->next;
94 free(temp);
98 static int ref_newer(const unsigned char *new_sha1,
99 const unsigned char *old_sha1)
101 struct object *o;
102 struct commit *old, *new;
103 struct commit_list *list, *used;
104 int found = 0;
106 /* Both new and old must be commit-ish and new is descendant of
107 * old. Otherwise we require --force.
109 o = deref_tag(parse_object(old_sha1), NULL, 0);
110 if (!o || o->type != OBJ_COMMIT)
111 return 0;
112 old = (struct commit *) o;
114 o = deref_tag(parse_object(new_sha1), NULL, 0);
115 if (!o || o->type != OBJ_COMMIT)
116 return 0;
117 new = (struct commit *) o;
119 if (parse_commit(new) < 0)
120 return 0;
122 used = list = NULL;
123 commit_list_insert(new, &list);
124 while (list) {
125 new = pop_most_recent_commit(&list, 1);
126 commit_list_insert(new, &used);
127 if (new == old) {
128 found = 1;
129 break;
132 unmark_and_free(list, 1);
133 unmark_and_free(used, 1);
134 return found;
137 static struct ref *local_refs, **local_tail;
138 static struct ref *remote_refs, **remote_tail;
140 static int one_local_ref(const char *refname, const unsigned char *sha1, int flag, void *cb_data)
142 struct ref *ref;
143 int len;
145 /* we already know it starts with refs/ to get here */
146 if (check_ref_format(refname + 5))
147 return 0;
149 len = strlen(refname) + 1;
150 ref = xcalloc(1, sizeof(*ref) + len);
151 hashcpy(ref->new_sha1, sha1);
152 memcpy(ref->name, refname, len);
153 *local_tail = ref;
154 local_tail = &ref->next;
155 return 0;
158 static void get_local_heads(void)
160 local_tail = &local_refs;
161 for_each_ref(one_local_ref, NULL);
164 static int receive_status(int in, struct ref *refs)
166 struct ref *hint;
167 char line[1000];
168 int ret = 0;
169 int len = packet_read_line(in, line, sizeof(line));
170 if (len < 10 || memcmp(line, "unpack ", 7))
171 return error("did not receive remote status");
172 if (memcmp(line, "unpack ok\n", 10)) {
173 char *p = line + strlen(line) - 1;
174 if (*p == '\n')
175 *p = '\0';
176 error("unpack failed: %s", line + 7);
177 ret = -1;
179 hint = NULL;
180 while (1) {
181 char *refname;
182 char *msg;
183 len = packet_read_line(in, line, sizeof(line));
184 if (!len)
185 break;
186 if (len < 3 ||
187 (memcmp(line, "ok ", 3) && memcmp(line, "ng ", 3))) {
188 fprintf(stderr, "protocol error: %s\n", line);
189 ret = -1;
190 break;
193 line[strlen(line)-1] = '\0';
194 refname = line + 3;
195 msg = strchr(refname, ' ');
196 if (msg)
197 *msg++ = '\0';
199 /* first try searching at our hint, falling back to all refs */
200 if (hint)
201 hint = find_ref_by_name(hint, refname);
202 if (!hint)
203 hint = find_ref_by_name(refs, refname);
204 if (!hint) {
205 warning("remote reported status on unknown ref: %s",
206 refname);
207 continue;
209 if (hint->status != REF_STATUS_EXPECTING_REPORT) {
210 warning("remote reported status on unexpected ref: %s",
211 refname);
212 continue;
215 if (line[0] == 'o' && line[1] == 'k')
216 hint->status = REF_STATUS_OK;
217 else {
218 hint->status = REF_STATUS_REMOTE_REJECT;
219 ret = -1;
221 if (msg)
222 hint->remote_status = xstrdup(msg);
223 /* start our next search from the next ref */
224 hint = hint->next;
226 return ret;
229 static void update_tracking_ref(struct remote *remote, struct ref *ref)
231 struct refspec rs;
233 if (ref->status != REF_STATUS_OK && ref->status != REF_STATUS_UPTODATE)
234 return;
236 rs.src = ref->name;
237 rs.dst = NULL;
239 if (!remote_find_tracking(remote, &rs)) {
240 if (args.verbose)
241 fprintf(stderr, "updating local tracking ref '%s'\n", rs.dst);
242 if (ref->deletion) {
243 delete_ref(rs.dst, NULL, 0);
244 } else
245 update_ref("update by push", rs.dst,
246 ref->new_sha1, NULL, 0, 0);
247 free(rs.dst);
251 static const char *prettify_ref(const struct ref *ref)
253 const char *name = ref->name;
254 return name + (
255 !prefixcmp(name, "refs/heads/") ? 11 :
256 !prefixcmp(name, "refs/tags/") ? 10 :
257 !prefixcmp(name, "refs/remotes/") ? 13 :
261 #define SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
263 static void print_ref_status(char flag, const char *summary, struct ref *to, struct ref *from, const char *msg)
265 fprintf(stderr, " %c %-*s ", flag, SUMMARY_WIDTH, summary);
266 if (from)
267 fprintf(stderr, "%s -> %s", prettify_ref(from), prettify_ref(to));
268 else
269 fputs(prettify_ref(to), stderr);
270 if (msg) {
271 fputs(" (", stderr);
272 fputs(msg, stderr);
273 fputc(')', stderr);
275 fputc('\n', stderr);
278 static const char *status_abbrev(unsigned char sha1[20])
280 return find_unique_abbrev(sha1, DEFAULT_ABBREV);
283 static void print_ok_ref_status(struct ref *ref)
285 if (ref->deletion)
286 print_ref_status('-', "[deleted]", ref, NULL, NULL);
287 else if (is_null_sha1(ref->old_sha1))
288 print_ref_status('*',
289 (!prefixcmp(ref->name, "refs/tags/") ? "[new tag]" :
290 "[new branch]"),
291 ref, ref->peer_ref, NULL);
292 else {
293 char quickref[84];
294 char type;
295 const char *msg;
297 strcpy(quickref, status_abbrev(ref->old_sha1));
298 if (ref->nonfastforward) {
299 strcat(quickref, "...");
300 type = '+';
301 msg = "forced update";
302 } else {
303 strcat(quickref, "..");
304 type = ' ';
305 msg = NULL;
307 strcat(quickref, status_abbrev(ref->new_sha1));
309 print_ref_status(type, quickref, ref, ref->peer_ref, msg);
313 static int print_one_push_status(struct ref *ref, const char *dest, int count)
315 if (!count)
316 fprintf(stderr, "To %s\n", dest);
318 switch(ref->status) {
319 case REF_STATUS_NONE:
320 print_ref_status('X', "[no match]", ref, NULL, NULL);
321 break;
322 case REF_STATUS_REJECT_NODELETE:
323 print_ref_status('!', "[rejected]", ref, NULL,
324 "remote does not support deleting refs");
325 break;
326 case REF_STATUS_UPTODATE:
327 print_ref_status('=', "[up to date]", ref,
328 ref->peer_ref, NULL);
329 break;
330 case REF_STATUS_REJECT_NONFASTFORWARD:
331 print_ref_status('!', "[rejected]", ref, ref->peer_ref,
332 "non-fast forward");
333 break;
334 case REF_STATUS_REMOTE_REJECT:
335 print_ref_status('!', "[remote rejected]", ref,
336 ref->deletion ? NULL : ref->peer_ref,
337 ref->remote_status);
338 break;
339 case REF_STATUS_EXPECTING_REPORT:
340 print_ref_status('!', "[remote failure]", ref,
341 ref->deletion ? NULL : ref->peer_ref,
342 "remote failed to report status");
343 break;
344 case REF_STATUS_OK:
345 print_ok_ref_status(ref);
346 break;
349 return 1;
352 static void print_push_status(const char *dest, struct ref *refs)
354 struct ref *ref;
355 int n = 0;
357 if (args.verbose) {
358 for (ref = refs; ref; ref = ref->next)
359 if (ref->status == REF_STATUS_UPTODATE)
360 n += print_one_push_status(ref, dest, n);
363 for (ref = refs; ref; ref = ref->next)
364 if (ref->status == REF_STATUS_OK)
365 n += print_one_push_status(ref, dest, n);
367 for (ref = refs; ref; ref = ref->next) {
368 if (ref->status != REF_STATUS_NONE &&
369 ref->status != REF_STATUS_UPTODATE &&
370 ref->status != REF_STATUS_OK)
371 n += print_one_push_status(ref, dest, n);
375 static int refs_pushed(struct ref *ref)
377 for (; ref; ref = ref->next) {
378 switch(ref->status) {
379 case REF_STATUS_NONE:
380 case REF_STATUS_UPTODATE:
381 break;
382 default:
383 return 1;
386 return 0;
389 static int do_send_pack(int in, int out, struct remote *remote, const char *dest, int nr_refspec, const char **refspec)
391 struct ref *ref;
392 int new_refs;
393 int ask_for_status_report = 0;
394 int allow_deleting_refs = 0;
395 int expect_status_report = 0;
396 int flags = MATCH_REFS_NONE;
397 int ret;
398 struct extra_have_objects extra_have;
400 memset(&extra_have, 0, sizeof(extra_have));
401 if (args.send_all)
402 flags |= MATCH_REFS_ALL;
403 if (args.send_mirror)
404 flags |= MATCH_REFS_MIRROR;
406 /* No funny business with the matcher */
407 remote_tail = get_remote_heads(in, &remote_refs, 0, NULL, REF_NORMAL,
408 &extra_have);
409 get_local_heads();
411 /* Does the other end support the reporting? */
412 if (server_supports("report-status"))
413 ask_for_status_report = 1;
414 if (server_supports("delete-refs"))
415 allow_deleting_refs = 1;
417 /* match them up */
418 if (!remote_tail)
419 remote_tail = &remote_refs;
420 if (match_refs(local_refs, remote_refs, &remote_tail,
421 nr_refspec, refspec, flags)) {
422 close(out);
423 return -1;
426 if (!remote_refs) {
427 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
428 "Perhaps you should specify a branch such as 'master'.\n");
429 close(out);
430 return 0;
434 * Finally, tell the other end!
436 new_refs = 0;
437 for (ref = remote_refs; ref; ref = ref->next) {
439 if (ref->peer_ref)
440 hashcpy(ref->new_sha1, ref->peer_ref->new_sha1);
441 else if (!args.send_mirror)
442 continue;
444 ref->deletion = is_null_sha1(ref->new_sha1);
445 if (ref->deletion && !allow_deleting_refs) {
446 ref->status = REF_STATUS_REJECT_NODELETE;
447 continue;
449 if (!ref->deletion &&
450 !hashcmp(ref->old_sha1, ref->new_sha1)) {
451 ref->status = REF_STATUS_UPTODATE;
452 continue;
455 /* This part determines what can overwrite what.
456 * The rules are:
458 * (0) you can always use --force or +A:B notation to
459 * selectively force individual ref pairs.
461 * (1) if the old thing does not exist, it is OK.
463 * (2) if you do not have the old thing, you are not allowed
464 * to overwrite it; you would not know what you are losing
465 * otherwise.
467 * (3) if both new and old are commit-ish, and new is a
468 * descendant of old, it is OK.
470 * (4) regardless of all of the above, removing :B is
471 * always allowed.
474 ref->nonfastforward =
475 !ref->deletion &&
476 !is_null_sha1(ref->old_sha1) &&
477 (!has_sha1_file(ref->old_sha1)
478 || !ref_newer(ref->new_sha1, ref->old_sha1));
480 if (ref->nonfastforward && !ref->force && !args.force_update) {
481 ref->status = REF_STATUS_REJECT_NONFASTFORWARD;
482 continue;
485 if (!ref->deletion)
486 new_refs++;
488 if (!args.dry_run) {
489 char *old_hex = sha1_to_hex(ref->old_sha1);
490 char *new_hex = sha1_to_hex(ref->new_sha1);
492 if (ask_for_status_report) {
493 packet_write(out, "%s %s %s%c%s",
494 old_hex, new_hex, ref->name, 0,
495 "report-status");
496 ask_for_status_report = 0;
497 expect_status_report = 1;
499 else
500 packet_write(out, "%s %s %s",
501 old_hex, new_hex, ref->name);
503 ref->status = expect_status_report ?
504 REF_STATUS_EXPECTING_REPORT :
505 REF_STATUS_OK;
508 packet_flush(out);
509 if (new_refs && !args.dry_run) {
510 if (pack_objects(out, remote_refs, &extra_have) < 0)
511 return -1;
513 else
514 close(out);
516 if (expect_status_report)
517 ret = receive_status(in, remote_refs);
518 else
519 ret = 0;
521 print_push_status(dest, remote_refs);
523 if (!args.dry_run && remote) {
524 for (ref = remote_refs; ref; ref = ref->next)
525 update_tracking_ref(remote, ref);
528 if (!refs_pushed(remote_refs))
529 fprintf(stderr, "Everything up-to-date\n");
530 if (ret < 0)
531 return ret;
532 for (ref = remote_refs; ref; ref = ref->next) {
533 switch (ref->status) {
534 case REF_STATUS_NONE:
535 case REF_STATUS_UPTODATE:
536 case REF_STATUS_OK:
537 break;
538 default:
539 return -1;
542 return 0;
545 static void verify_remote_names(int nr_heads, const char **heads)
547 int i;
549 for (i = 0; i < nr_heads; i++) {
550 const char *local = heads[i];
551 const char *remote = strrchr(heads[i], ':');
553 if (*local == '+')
554 local++;
556 /* A matching refspec is okay. */
557 if (remote == local && remote[1] == '\0')
558 continue;
560 remote = remote ? (remote + 1) : local;
561 switch (check_ref_format(remote)) {
562 case 0: /* ok */
563 case CHECK_REF_FORMAT_ONELEVEL:
564 /* ok but a single level -- that is fine for
565 * a match pattern.
567 case CHECK_REF_FORMAT_WILDCARD:
568 /* ok but ends with a pattern-match character */
569 continue;
571 die("remote part of refspec is not a valid name in %s",
572 heads[i]);
576 int cmd_send_pack(int argc, const char **argv, const char *prefix)
578 int i, nr_heads = 0;
579 const char **heads = NULL;
580 const char *remote_name = NULL;
581 struct remote *remote = NULL;
582 const char *dest = NULL;
584 argv++;
585 for (i = 1; i < argc; i++, argv++) {
586 const char *arg = *argv;
588 if (*arg == '-') {
589 if (!prefixcmp(arg, "--receive-pack=")) {
590 args.receivepack = arg + 15;
591 continue;
593 if (!prefixcmp(arg, "--exec=")) {
594 args.receivepack = arg + 7;
595 continue;
597 if (!prefixcmp(arg, "--remote=")) {
598 remote_name = arg + 9;
599 continue;
601 if (!strcmp(arg, "--all")) {
602 args.send_all = 1;
603 continue;
605 if (!strcmp(arg, "--dry-run")) {
606 args.dry_run = 1;
607 continue;
609 if (!strcmp(arg, "--mirror")) {
610 args.send_mirror = 1;
611 continue;
613 if (!strcmp(arg, "--force")) {
614 args.force_update = 1;
615 continue;
617 if (!strcmp(arg, "--verbose")) {
618 args.verbose = 1;
619 continue;
621 if (!strcmp(arg, "--thin")) {
622 args.use_thin_pack = 1;
623 continue;
625 usage(send_pack_usage);
627 if (!dest) {
628 dest = arg;
629 continue;
631 heads = (const char **) argv;
632 nr_heads = argc - i;
633 break;
635 if (!dest)
636 usage(send_pack_usage);
638 * --all and --mirror are incompatible; neither makes sense
639 * with any refspecs.
641 if ((heads && (args.send_all || args.send_mirror)) ||
642 (args.send_all && args.send_mirror))
643 usage(send_pack_usage);
645 if (remote_name) {
646 remote = remote_get(remote_name);
647 if (!remote_has_url(remote, dest)) {
648 die("Destination %s is not a uri for %s",
649 dest, remote_name);
653 return send_pack(&args, dest, remote, nr_heads, heads);
656 int send_pack(struct send_pack_args *my_args,
657 const char *dest, struct remote *remote,
658 int nr_heads, const char **heads)
660 int fd[2], ret;
661 struct child_process *conn;
663 memcpy(&args, my_args, sizeof(args));
665 verify_remote_names(nr_heads, heads);
667 conn = git_connect(fd, dest, args.receivepack, args.verbose ? CONNECT_VERBOSE : 0);
668 ret = do_send_pack(fd[0], fd[1], remote, dest, nr_heads, heads);
669 close(fd[0]);
670 /* do_send_pack always closes fd[1] */
671 ret |= finish_connect(conn);
672 return !!ret;