fetch-pack.c: mark strings for translating
[git.git] / transport-helper.c
blob27a34e9d4ed5f327f4619209c1ccd55a3a31fdcf
1 #include "cache.h"
2 #include "transport.h"
3 #include "quote.h"
4 #include "run-command.h"
5 #include "commit.h"
6 #include "diff.h"
7 #include "revision.h"
8 #include "remote.h"
9 #include "string-list.h"
10 #include "thread-utils.h"
11 #include "sigchain.h"
12 #include "argv-array.h"
13 #include "refs.h"
15 static int debug;
17 struct helper_data {
18 const char *name;
19 struct child_process *helper;
20 FILE *out;
21 unsigned fetch : 1,
22 import : 1,
23 bidi_import : 1,
24 export : 1,
25 option : 1,
26 push : 1,
27 connect : 1,
28 signed_tags : 1,
29 check_connectivity : 1,
30 no_disconnect_req : 1,
31 no_private_update : 1;
32 char *export_marks;
33 char *import_marks;
34 /* These go from remote name (as in "list") to private name */
35 struct refspec *refspecs;
36 int refspec_nr;
37 /* Transport options for fetch-pack/send-pack (should one of
38 * those be invoked).
40 struct git_transport_options transport_options;
43 static void sendline(struct helper_data *helper, struct strbuf *buffer)
45 if (debug)
46 fprintf(stderr, "Debug: Remote helper: -> %s", buffer->buf);
47 if (write_in_full(helper->helper->in, buffer->buf, buffer->len)
48 != buffer->len)
49 die_errno("Full write to remote helper failed");
52 static int recvline_fh(FILE *helper, struct strbuf *buffer, const char *name)
54 strbuf_reset(buffer);
55 if (debug)
56 fprintf(stderr, "Debug: Remote helper: Waiting...\n");
57 if (strbuf_getline(buffer, helper) == EOF) {
58 if (debug)
59 fprintf(stderr, "Debug: Remote helper quit.\n");
60 return 1;
63 if (debug)
64 fprintf(stderr, "Debug: Remote helper: <- %s\n", buffer->buf);
65 return 0;
68 static int recvline(struct helper_data *helper, struct strbuf *buffer)
70 return recvline_fh(helper->out, buffer, helper->name);
73 static void write_constant(int fd, const char *str)
75 if (debug)
76 fprintf(stderr, "Debug: Remote helper: -> %s", str);
77 if (write_in_full(fd, str, strlen(str)) != strlen(str))
78 die_errno("Full write to remote helper failed");
81 static const char *remove_ext_force(const char *url)
83 if (url) {
84 const char *colon = strchr(url, ':');
85 if (colon && colon[1] == ':')
86 return colon + 2;
88 return url;
91 static void do_take_over(struct transport *transport)
93 struct helper_data *data;
94 data = (struct helper_data *)transport->data;
95 transport_take_over(transport, data->helper);
96 fclose(data->out);
97 free(data);
100 static void standard_options(struct transport *t);
102 static struct child_process *get_helper(struct transport *transport)
104 struct helper_data *data = transport->data;
105 struct strbuf buf = STRBUF_INIT;
106 struct child_process *helper;
107 const char **refspecs = NULL;
108 int refspec_nr = 0;
109 int refspec_alloc = 0;
110 int duped;
111 int code;
113 if (data->helper)
114 return data->helper;
116 helper = xmalloc(sizeof(*helper));
117 child_process_init(helper);
118 helper->in = -1;
119 helper->out = -1;
120 helper->err = 0;
121 argv_array_pushf(&helper->args, "git-remote-%s", data->name);
122 argv_array_push(&helper->args, transport->remote->name);
123 argv_array_push(&helper->args, remove_ext_force(transport->url));
124 helper->git_cmd = 0;
125 helper->silent_exec_failure = 1;
127 argv_array_pushf(&helper->env_array, "%s=%s", GIT_DIR_ENVIRONMENT,
128 get_git_dir());
130 code = start_command(helper);
131 if (code < 0 && errno == ENOENT)
132 die("Unable to find remote helper for '%s'", data->name);
133 else if (code != 0)
134 exit(code);
136 data->helper = helper;
137 data->no_disconnect_req = 0;
140 * Open the output as FILE* so strbuf_getline_*() family of
141 * functions can be used.
142 * Do this with duped fd because fclose() will close the fd,
143 * and stuff like taking over will require the fd to remain.
145 duped = dup(helper->out);
146 if (duped < 0)
147 die_errno("Can't dup helper output fd");
148 data->out = xfdopen(duped, "r");
150 write_constant(helper->in, "capabilities\n");
152 while (1) {
153 const char *capname, *arg;
154 int mandatory = 0;
155 if (recvline(data, &buf))
156 exit(128);
158 if (!*buf.buf)
159 break;
161 if (*buf.buf == '*') {
162 capname = buf.buf + 1;
163 mandatory = 1;
164 } else
165 capname = buf.buf;
167 if (debug)
168 fprintf(stderr, "Debug: Got cap %s\n", capname);
169 if (!strcmp(capname, "fetch"))
170 data->fetch = 1;
171 else if (!strcmp(capname, "option"))
172 data->option = 1;
173 else if (!strcmp(capname, "push"))
174 data->push = 1;
175 else if (!strcmp(capname, "import"))
176 data->import = 1;
177 else if (!strcmp(capname, "bidi-import"))
178 data->bidi_import = 1;
179 else if (!strcmp(capname, "export"))
180 data->export = 1;
181 else if (!strcmp(capname, "check-connectivity"))
182 data->check_connectivity = 1;
183 else if (!data->refspecs && skip_prefix(capname, "refspec ", &arg)) {
184 ALLOC_GROW(refspecs,
185 refspec_nr + 1,
186 refspec_alloc);
187 refspecs[refspec_nr++] = xstrdup(arg);
188 } else if (!strcmp(capname, "connect")) {
189 data->connect = 1;
190 } else if (!strcmp(capname, "signed-tags")) {
191 data->signed_tags = 1;
192 } else if (skip_prefix(capname, "export-marks ", &arg)) {
193 data->export_marks = xstrdup(arg);
194 } else if (skip_prefix(capname, "import-marks ", &arg)) {
195 data->import_marks = xstrdup(arg);
196 } else if (starts_with(capname, "no-private-update")) {
197 data->no_private_update = 1;
198 } else if (mandatory) {
199 die("Unknown mandatory capability %s. This remote "
200 "helper probably needs newer version of Git.",
201 capname);
204 if (refspecs) {
205 int i;
206 data->refspec_nr = refspec_nr;
207 data->refspecs = parse_fetch_refspec(refspec_nr, refspecs);
208 for (i = 0; i < refspec_nr; i++)
209 free((char *)refspecs[i]);
210 free(refspecs);
211 } else if (data->import || data->bidi_import || data->export) {
212 warning("This remote helper should implement refspec capability.");
214 strbuf_release(&buf);
215 if (debug)
216 fprintf(stderr, "Debug: Capabilities complete.\n");
217 standard_options(transport);
218 return data->helper;
221 static int disconnect_helper(struct transport *transport)
223 struct helper_data *data = transport->data;
224 int res = 0;
226 if (data->helper) {
227 if (debug)
228 fprintf(stderr, "Debug: Disconnecting.\n");
229 if (!data->no_disconnect_req) {
231 * Ignore write errors; there's nothing we can do,
232 * since we're about to close the pipe anyway. And the
233 * most likely error is EPIPE due to the helper dying
234 * to report an error itself.
236 sigchain_push(SIGPIPE, SIG_IGN);
237 xwrite(data->helper->in, "\n", 1);
238 sigchain_pop(SIGPIPE);
240 close(data->helper->in);
241 close(data->helper->out);
242 fclose(data->out);
243 res = finish_command(data->helper);
244 free(data->helper);
245 data->helper = NULL;
247 return res;
250 static const char *unsupported_options[] = {
251 TRANS_OPT_UPLOADPACK,
252 TRANS_OPT_RECEIVEPACK,
253 TRANS_OPT_THIN,
254 TRANS_OPT_KEEP
257 static const char *boolean_options[] = {
258 TRANS_OPT_THIN,
259 TRANS_OPT_KEEP,
260 TRANS_OPT_FOLLOWTAGS,
263 static int strbuf_set_helper_option(struct helper_data *data,
264 struct strbuf *buf)
266 int ret;
268 sendline(data, buf);
269 if (recvline(data, buf))
270 exit(128);
272 if (!strcmp(buf->buf, "ok"))
273 ret = 0;
274 else if (starts_with(buf->buf, "error"))
275 ret = -1;
276 else if (!strcmp(buf->buf, "unsupported"))
277 ret = 1;
278 else {
279 warning("%s unexpectedly said: '%s'", data->name, buf->buf);
280 ret = 1;
282 return ret;
285 static int set_helper_option(struct transport *transport,
286 const char *name, const char *value)
288 struct helper_data *data = transport->data;
289 struct strbuf buf = STRBUF_INIT;
290 int i, ret, is_bool = 0;
292 get_helper(transport);
294 if (!data->option)
295 return 1;
297 for (i = 0; i < ARRAY_SIZE(unsupported_options); i++) {
298 if (!strcmp(name, unsupported_options[i]))
299 return 1;
302 for (i = 0; i < ARRAY_SIZE(boolean_options); i++) {
303 if (!strcmp(name, boolean_options[i])) {
304 is_bool = 1;
305 break;
309 strbuf_addf(&buf, "option %s ", name);
310 if (is_bool)
311 strbuf_addstr(&buf, value ? "true" : "false");
312 else
313 quote_c_style(value, &buf, NULL, 0);
314 strbuf_addch(&buf, '\n');
316 ret = strbuf_set_helper_option(data, &buf);
317 strbuf_release(&buf);
318 return ret;
321 static void standard_options(struct transport *t)
323 char buf[16];
324 int n;
325 int v = t->verbose;
327 set_helper_option(t, "progress", t->progress ? "true" : "false");
329 n = snprintf(buf, sizeof(buf), "%d", v + 1);
330 if (n >= sizeof(buf))
331 die("impossibly large verbosity value");
332 set_helper_option(t, "verbosity", buf);
335 static int release_helper(struct transport *transport)
337 int res = 0;
338 struct helper_data *data = transport->data;
339 free_refspec(data->refspec_nr, data->refspecs);
340 data->refspecs = NULL;
341 res = disconnect_helper(transport);
342 free(transport->data);
343 return res;
346 static int fetch_with_fetch(struct transport *transport,
347 int nr_heads, struct ref **to_fetch)
349 struct helper_data *data = transport->data;
350 int i;
351 struct strbuf buf = STRBUF_INIT;
353 for (i = 0; i < nr_heads; i++) {
354 const struct ref *posn = to_fetch[i];
355 if (posn->status & REF_STATUS_UPTODATE)
356 continue;
358 strbuf_addf(&buf, "fetch %s %s\n",
359 oid_to_hex(&posn->old_oid),
360 posn->symref ? posn->symref : posn->name);
363 strbuf_addch(&buf, '\n');
364 sendline(data, &buf);
366 while (1) {
367 if (recvline(data, &buf))
368 exit(128);
370 if (starts_with(buf.buf, "lock ")) {
371 const char *name = buf.buf + 5;
372 if (transport->pack_lockfile)
373 warning("%s also locked %s", data->name, name);
374 else
375 transport->pack_lockfile = xstrdup(name);
377 else if (data->check_connectivity &&
378 data->transport_options.check_self_contained_and_connected &&
379 !strcmp(buf.buf, "connectivity-ok"))
380 data->transport_options.self_contained_and_connected = 1;
381 else if (!buf.len)
382 break;
383 else
384 warning("%s unexpectedly said: '%s'", data->name, buf.buf);
386 strbuf_release(&buf);
387 return 0;
390 static int get_importer(struct transport *transport, struct child_process *fastimport)
392 struct child_process *helper = get_helper(transport);
393 struct helper_data *data = transport->data;
394 int cat_blob_fd, code;
395 child_process_init(fastimport);
396 fastimport->in = helper->out;
397 argv_array_push(&fastimport->args, "fast-import");
398 argv_array_push(&fastimport->args, debug ? "--stats" : "--quiet");
400 if (data->bidi_import) {
401 cat_blob_fd = xdup(helper->in);
402 argv_array_pushf(&fastimport->args, "--cat-blob-fd=%d", cat_blob_fd);
404 fastimport->git_cmd = 1;
406 code = start_command(fastimport);
407 return code;
410 static int get_exporter(struct transport *transport,
411 struct child_process *fastexport,
412 struct string_list *revlist_args)
414 struct helper_data *data = transport->data;
415 struct child_process *helper = get_helper(transport);
416 int i;
418 child_process_init(fastexport);
420 /* we need to duplicate helper->in because we want to use it after
421 * fastexport is done with it. */
422 fastexport->out = dup(helper->in);
423 argv_array_push(&fastexport->args, "fast-export");
424 argv_array_push(&fastexport->args, "--use-done-feature");
425 argv_array_push(&fastexport->args, data->signed_tags ?
426 "--signed-tags=verbatim" : "--signed-tags=warn-strip");
427 if (data->export_marks)
428 argv_array_pushf(&fastexport->args, "--export-marks=%s.tmp", data->export_marks);
429 if (data->import_marks)
430 argv_array_pushf(&fastexport->args, "--import-marks=%s", data->import_marks);
432 for (i = 0; i < revlist_args->nr; i++)
433 argv_array_push(&fastexport->args, revlist_args->items[i].string);
435 fastexport->git_cmd = 1;
436 return start_command(fastexport);
439 static int fetch_with_import(struct transport *transport,
440 int nr_heads, struct ref **to_fetch)
442 struct child_process fastimport;
443 struct helper_data *data = transport->data;
444 int i;
445 struct ref *posn;
446 struct strbuf buf = STRBUF_INIT;
448 get_helper(transport);
450 if (get_importer(transport, &fastimport))
451 die("Couldn't run fast-import");
453 for (i = 0; i < nr_heads; i++) {
454 posn = to_fetch[i];
455 if (posn->status & REF_STATUS_UPTODATE)
456 continue;
458 strbuf_addf(&buf, "import %s\n",
459 posn->symref ? posn->symref : posn->name);
460 sendline(data, &buf);
461 strbuf_reset(&buf);
464 write_constant(data->helper->in, "\n");
466 * remote-helpers that advertise the bidi-import capability are required to
467 * buffer the complete batch of import commands until this newline before
468 * sending data to fast-import.
469 * These helpers read back data from fast-import on their stdin, which could
470 * be mixed with import commands, otherwise.
473 if (finish_command(&fastimport))
474 die("Error while running fast-import");
477 * The fast-import stream of a remote helper that advertises
478 * the "refspec" capability writes to the refs named after the
479 * right hand side of the first refspec matching each ref we
480 * were fetching.
482 * (If no "refspec" capability was specified, for historical
483 * reasons we default to the equivalent of *:*.)
485 * Store the result in to_fetch[i].old_sha1. Callers such
486 * as "git fetch" can use the value to write feedback to the
487 * terminal, populate FETCH_HEAD, and determine what new value
488 * should be written to peer_ref if the update is a
489 * fast-forward or this is a forced update.
491 for (i = 0; i < nr_heads; i++) {
492 char *private, *name;
493 posn = to_fetch[i];
494 if (posn->status & REF_STATUS_UPTODATE)
495 continue;
496 name = posn->symref ? posn->symref : posn->name;
497 if (data->refspecs)
498 private = apply_refspecs(data->refspecs, data->refspec_nr, name);
499 else
500 private = xstrdup(name);
501 if (private) {
502 if (read_ref(private, posn->old_oid.hash) < 0)
503 die("Could not read ref %s", private);
504 free(private);
507 strbuf_release(&buf);
508 return 0;
511 static int process_connect_service(struct transport *transport,
512 const char *name, const char *exec)
514 struct helper_data *data = transport->data;
515 struct strbuf cmdbuf = STRBUF_INIT;
516 struct child_process *helper;
517 int r, duped, ret = 0;
518 FILE *input;
520 helper = get_helper(transport);
523 * Yes, dup the pipe another time, as we need unbuffered version
524 * of input pipe as FILE*. fclose() closes the underlying fd and
525 * stream buffering only can be changed before first I/O operation
526 * on it.
528 duped = dup(helper->out);
529 if (duped < 0)
530 die_errno("Can't dup helper output fd");
531 input = xfdopen(duped, "r");
532 setvbuf(input, NULL, _IONBF, 0);
535 * Handle --upload-pack and friends. This is fire and forget...
536 * just warn if it fails.
538 if (strcmp(name, exec)) {
539 r = set_helper_option(transport, "servpath", exec);
540 if (r > 0)
541 warning("Setting remote service path not supported by protocol.");
542 else if (r < 0)
543 warning("Invalid remote service path.");
546 if (data->connect)
547 strbuf_addf(&cmdbuf, "connect %s\n", name);
548 else
549 goto exit;
551 sendline(data, &cmdbuf);
552 if (recvline_fh(input, &cmdbuf, name))
553 exit(128);
555 if (!strcmp(cmdbuf.buf, "")) {
556 data->no_disconnect_req = 1;
557 if (debug)
558 fprintf(stderr, "Debug: Smart transport connection "
559 "ready.\n");
560 ret = 1;
561 } else if (!strcmp(cmdbuf.buf, "fallback")) {
562 if (debug)
563 fprintf(stderr, "Debug: Falling back to dumb "
564 "transport.\n");
565 } else
566 die("Unknown response to connect: %s",
567 cmdbuf.buf);
569 exit:
570 fclose(input);
571 return ret;
574 static int process_connect(struct transport *transport,
575 int for_push)
577 struct helper_data *data = transport->data;
578 const char *name;
579 const char *exec;
581 name = for_push ? "git-receive-pack" : "git-upload-pack";
582 if (for_push)
583 exec = data->transport_options.receivepack;
584 else
585 exec = data->transport_options.uploadpack;
587 return process_connect_service(transport, name, exec);
590 static int connect_helper(struct transport *transport, const char *name,
591 const char *exec, int fd[2])
593 struct helper_data *data = transport->data;
595 /* Get_helper so connect is inited. */
596 get_helper(transport);
597 if (!data->connect)
598 die("Operation not supported by protocol.");
600 if (!process_connect_service(transport, name, exec))
601 die("Can't connect to subservice %s.", name);
603 fd[0] = data->helper->out;
604 fd[1] = data->helper->in;
605 return 0;
608 static int fetch(struct transport *transport,
609 int nr_heads, struct ref **to_fetch)
611 struct helper_data *data = transport->data;
612 int i, count;
614 if (process_connect(transport, 0)) {
615 do_take_over(transport);
616 return transport->fetch(transport, nr_heads, to_fetch);
619 count = 0;
620 for (i = 0; i < nr_heads; i++)
621 if (!(to_fetch[i]->status & REF_STATUS_UPTODATE))
622 count++;
624 if (!count)
625 return 0;
627 if (data->check_connectivity &&
628 data->transport_options.check_self_contained_and_connected)
629 set_helper_option(transport, "check-connectivity", "true");
631 if (transport->cloning)
632 set_helper_option(transport, "cloning", "true");
634 if (data->transport_options.update_shallow)
635 set_helper_option(transport, "update-shallow", "true");
637 if (data->fetch)
638 return fetch_with_fetch(transport, nr_heads, to_fetch);
640 if (data->import)
641 return fetch_with_import(transport, nr_heads, to_fetch);
643 return -1;
646 static int push_update_ref_status(struct strbuf *buf,
647 struct ref **ref,
648 struct ref *remote_refs)
650 char *refname, *msg;
651 int status, forced = 0;
653 if (starts_with(buf->buf, "ok ")) {
654 status = REF_STATUS_OK;
655 refname = buf->buf + 3;
656 } else if (starts_with(buf->buf, "error ")) {
657 status = REF_STATUS_REMOTE_REJECT;
658 refname = buf->buf + 6;
659 } else
660 die("expected ok/error, helper said '%s'", buf->buf);
662 msg = strchr(refname, ' ');
663 if (msg) {
664 struct strbuf msg_buf = STRBUF_INIT;
665 const char *end;
667 *msg++ = '\0';
668 if (!unquote_c_style(&msg_buf, msg, &end))
669 msg = strbuf_detach(&msg_buf, NULL);
670 else
671 msg = xstrdup(msg);
672 strbuf_release(&msg_buf);
674 if (!strcmp(msg, "no match")) {
675 status = REF_STATUS_NONE;
676 free(msg);
677 msg = NULL;
679 else if (!strcmp(msg, "up to date")) {
680 status = REF_STATUS_UPTODATE;
681 free(msg);
682 msg = NULL;
684 else if (!strcmp(msg, "non-fast forward")) {
685 status = REF_STATUS_REJECT_NONFASTFORWARD;
686 free(msg);
687 msg = NULL;
689 else if (!strcmp(msg, "already exists")) {
690 status = REF_STATUS_REJECT_ALREADY_EXISTS;
691 free(msg);
692 msg = NULL;
694 else if (!strcmp(msg, "fetch first")) {
695 status = REF_STATUS_REJECT_FETCH_FIRST;
696 free(msg);
697 msg = NULL;
699 else if (!strcmp(msg, "needs force")) {
700 status = REF_STATUS_REJECT_NEEDS_FORCE;
701 free(msg);
702 msg = NULL;
704 else if (!strcmp(msg, "stale info")) {
705 status = REF_STATUS_REJECT_STALE;
706 free(msg);
707 msg = NULL;
709 else if (!strcmp(msg, "forced update")) {
710 forced = 1;
711 free(msg);
712 msg = NULL;
716 if (*ref)
717 *ref = find_ref_by_name(*ref, refname);
718 if (!*ref)
719 *ref = find_ref_by_name(remote_refs, refname);
720 if (!*ref) {
721 warning("helper reported unexpected status of %s", refname);
722 return 1;
725 if ((*ref)->status != REF_STATUS_NONE) {
727 * Earlier, the ref was marked not to be pushed, so ignore the ref
728 * status reported by the remote helper if the latter is 'no match'.
730 if (status == REF_STATUS_NONE)
731 return 1;
734 (*ref)->status = status;
735 (*ref)->forced_update |= forced;
736 (*ref)->remote_status = msg;
737 return !(status == REF_STATUS_OK);
740 static int push_update_refs_status(struct helper_data *data,
741 struct ref *remote_refs,
742 int flags)
744 struct strbuf buf = STRBUF_INIT;
745 struct ref *ref = remote_refs;
746 int ret = 0;
748 for (;;) {
749 char *private;
751 if (recvline(data, &buf)) {
752 ret = 1;
753 break;
756 if (!buf.len)
757 break;
759 if (push_update_ref_status(&buf, &ref, remote_refs))
760 continue;
762 if (flags & TRANSPORT_PUSH_DRY_RUN || !data->refspecs || data->no_private_update)
763 continue;
765 /* propagate back the update to the remote namespace */
766 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
767 if (!private)
768 continue;
769 update_ref("update by helper", private, ref->new_oid.hash, NULL, 0, 0);
770 free(private);
772 strbuf_release(&buf);
773 return ret;
776 static void set_common_push_options(struct transport *transport,
777 const char *name, int flags)
779 if (flags & TRANSPORT_PUSH_DRY_RUN) {
780 if (set_helper_option(transport, "dry-run", "true") != 0)
781 die("helper %s does not support dry-run", name);
782 } else if (flags & TRANSPORT_PUSH_CERT_ALWAYS) {
783 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "true") != 0)
784 die("helper %s does not support --signed", name);
785 } else if (flags & TRANSPORT_PUSH_CERT_IF_ASKED) {
786 if (set_helper_option(transport, TRANS_OPT_PUSH_CERT, "if-asked") != 0)
787 die("helper %s does not support --signed=if-asked", name);
791 static int push_refs_with_push(struct transport *transport,
792 struct ref *remote_refs, int flags)
794 int force_all = flags & TRANSPORT_PUSH_FORCE;
795 int mirror = flags & TRANSPORT_PUSH_MIRROR;
796 struct helper_data *data = transport->data;
797 struct strbuf buf = STRBUF_INIT;
798 struct ref *ref;
799 struct string_list cas_options = STRING_LIST_INIT_DUP;
800 struct string_list_item *cas_option;
802 get_helper(transport);
803 if (!data->push)
804 return 1;
806 for (ref = remote_refs; ref; ref = ref->next) {
807 if (!ref->peer_ref && !mirror)
808 continue;
810 /* Check for statuses set by set_ref_status_for_push() */
811 switch (ref->status) {
812 case REF_STATUS_REJECT_NONFASTFORWARD:
813 case REF_STATUS_REJECT_STALE:
814 case REF_STATUS_REJECT_ALREADY_EXISTS:
815 case REF_STATUS_UPTODATE:
816 continue;
817 default:
818 ; /* do nothing */
821 if (force_all)
822 ref->force = 1;
824 strbuf_addstr(&buf, "push ");
825 if (!ref->deletion) {
826 if (ref->force)
827 strbuf_addch(&buf, '+');
828 if (ref->peer_ref)
829 strbuf_addstr(&buf, ref->peer_ref->name);
830 else
831 strbuf_addstr(&buf, oid_to_hex(&ref->new_oid));
833 strbuf_addch(&buf, ':');
834 strbuf_addstr(&buf, ref->name);
835 strbuf_addch(&buf, '\n');
838 * The "--force-with-lease" options without explicit
839 * values to expect have already been expanded into
840 * the ref->old_oid_expect[] field; we can ignore
841 * transport->smart_options->cas altogether and instead
842 * can enumerate them from the refs.
844 if (ref->expect_old_sha1) {
845 struct strbuf cas = STRBUF_INIT;
846 strbuf_addf(&cas, "%s:%s",
847 ref->name, oid_to_hex(&ref->old_oid_expect));
848 string_list_append(&cas_options, strbuf_detach(&cas, NULL));
851 if (buf.len == 0) {
852 string_list_clear(&cas_options, 0);
853 return 0;
856 for_each_string_list_item(cas_option, &cas_options)
857 set_helper_option(transport, "cas", cas_option->string);
858 set_common_push_options(transport, data->name, flags);
860 strbuf_addch(&buf, '\n');
861 sendline(data, &buf);
862 strbuf_release(&buf);
864 return push_update_refs_status(data, remote_refs, flags);
867 static int push_refs_with_export(struct transport *transport,
868 struct ref *remote_refs, int flags)
870 struct ref *ref;
871 struct child_process *helper, exporter;
872 struct helper_data *data = transport->data;
873 struct string_list revlist_args = STRING_LIST_INIT_DUP;
874 struct strbuf buf = STRBUF_INIT;
876 if (!data->refspecs)
877 die("remote-helper doesn't support push; refspec needed");
879 set_common_push_options(transport, data->name, flags);
880 if (flags & TRANSPORT_PUSH_FORCE) {
881 if (set_helper_option(transport, "force", "true") != 0)
882 warning("helper %s does not support 'force'", data->name);
885 helper = get_helper(transport);
887 write_constant(helper->in, "export\n");
889 for (ref = remote_refs; ref; ref = ref->next) {
890 char *private;
891 struct object_id oid;
893 private = apply_refspecs(data->refspecs, data->refspec_nr, ref->name);
894 if (private && !get_sha1(private, oid.hash)) {
895 strbuf_addf(&buf, "^%s", private);
896 string_list_append(&revlist_args, strbuf_detach(&buf, NULL));
897 oidcpy(&ref->old_oid, &oid);
899 free(private);
901 if (ref->peer_ref) {
902 if (strcmp(ref->name, ref->peer_ref->name)) {
903 if (!ref->deletion) {
904 const char *name;
905 int flag;
907 /* Follow symbolic refs (mainly for HEAD). */
908 name = resolve_ref_unsafe(
909 ref->peer_ref->name,
910 RESOLVE_REF_READING,
911 oid.hash, &flag);
912 if (!name || !(flag & REF_ISSYMREF))
913 name = ref->peer_ref->name;
915 strbuf_addf(&buf, "%s:%s", name, ref->name);
916 } else
917 strbuf_addf(&buf, ":%s", ref->name);
919 string_list_append(&revlist_args, "--refspec");
920 string_list_append(&revlist_args, buf.buf);
921 strbuf_release(&buf);
923 if (!ref->deletion)
924 string_list_append(&revlist_args, ref->peer_ref->name);
928 if (get_exporter(transport, &exporter, &revlist_args))
929 die("Couldn't run fast-export");
931 string_list_clear(&revlist_args, 1);
933 if (finish_command(&exporter))
934 die("Error while running fast-export");
935 if (push_update_refs_status(data, remote_refs, flags))
936 return 1;
938 if (data->export_marks) {
939 strbuf_addf(&buf, "%s.tmp", data->export_marks);
940 rename(buf.buf, data->export_marks);
941 strbuf_release(&buf);
944 return 0;
947 static int push_refs(struct transport *transport,
948 struct ref *remote_refs, int flags)
950 struct helper_data *data = transport->data;
952 if (process_connect(transport, 1)) {
953 do_take_over(transport);
954 return transport->push_refs(transport, remote_refs, flags);
957 if (!remote_refs) {
958 fprintf(stderr, "No refs in common and none specified; doing nothing.\n"
959 "Perhaps you should specify a branch such as 'master'.\n");
960 return 0;
963 if (data->push)
964 return push_refs_with_push(transport, remote_refs, flags);
966 if (data->export)
967 return push_refs_with_export(transport, remote_refs, flags);
969 return -1;
973 static int has_attribute(const char *attrs, const char *attr) {
974 int len;
975 if (!attrs)
976 return 0;
978 len = strlen(attr);
979 for (;;) {
980 const char *space = strchrnul(attrs, ' ');
981 if (len == space - attrs && !strncmp(attrs, attr, len))
982 return 1;
983 if (!*space)
984 return 0;
985 attrs = space + 1;
989 static struct ref *get_refs_list(struct transport *transport, int for_push)
991 struct helper_data *data = transport->data;
992 struct child_process *helper;
993 struct ref *ret = NULL;
994 struct ref **tail = &ret;
995 struct ref *posn;
996 struct strbuf buf = STRBUF_INIT;
998 helper = get_helper(transport);
1000 if (process_connect(transport, for_push)) {
1001 do_take_over(transport);
1002 return transport->get_refs_list(transport, for_push);
1005 if (data->push && for_push)
1006 write_str_in_full(helper->in, "list for-push\n");
1007 else
1008 write_str_in_full(helper->in, "list\n");
1010 while (1) {
1011 char *eov, *eon;
1012 if (recvline(data, &buf))
1013 exit(128);
1015 if (!*buf.buf)
1016 break;
1018 eov = strchr(buf.buf, ' ');
1019 if (!eov)
1020 die("Malformed response in ref list: %s", buf.buf);
1021 eon = strchr(eov + 1, ' ');
1022 *eov = '\0';
1023 if (eon)
1024 *eon = '\0';
1025 *tail = alloc_ref(eov + 1);
1026 if (buf.buf[0] == '@')
1027 (*tail)->symref = xstrdup(buf.buf + 1);
1028 else if (buf.buf[0] != '?')
1029 get_oid_hex(buf.buf, &(*tail)->old_oid);
1030 if (eon) {
1031 if (has_attribute(eon + 1, "unchanged")) {
1032 (*tail)->status |= REF_STATUS_UPTODATE;
1033 if (read_ref((*tail)->name,
1034 (*tail)->old_oid.hash) < 0)
1035 die(N_("Could not read ref %s"),
1036 (*tail)->name);
1039 tail = &((*tail)->next);
1041 if (debug)
1042 fprintf(stderr, "Debug: Read ref listing.\n");
1043 strbuf_release(&buf);
1045 for (posn = ret; posn; posn = posn->next)
1046 resolve_remote_symref(posn, ret);
1048 return ret;
1051 int transport_helper_init(struct transport *transport, const char *name)
1053 struct helper_data *data = xcalloc(1, sizeof(*data));
1054 data->name = name;
1056 transport_check_allowed(name);
1058 if (getenv("GIT_TRANSPORT_HELPER_DEBUG"))
1059 debug = 1;
1061 transport->data = data;
1062 transport->set_option = set_helper_option;
1063 transport->get_refs_list = get_refs_list;
1064 transport->fetch = fetch;
1065 transport->push_refs = push_refs;
1066 transport->disconnect = release_helper;
1067 transport->connect = connect_helper;
1068 transport->smart_options = &(data->transport_options);
1069 return 0;
1073 * Linux pipes can buffer 65536 bytes at once (and most platforms can
1074 * buffer less), so attempt reads and writes with up to that size.
1076 #define BUFFERSIZE 65536
1077 /* This should be enough to hold debugging message. */
1078 #define PBUFFERSIZE 8192
1080 /* Print bidirectional transfer loop debug message. */
1081 __attribute__((format (printf, 1, 2)))
1082 static void transfer_debug(const char *fmt, ...)
1084 va_list args;
1085 char msgbuf[PBUFFERSIZE];
1086 static int debug_enabled = -1;
1088 if (debug_enabled < 0)
1089 debug_enabled = getenv("GIT_TRANSLOOP_DEBUG") ? 1 : 0;
1090 if (!debug_enabled)
1091 return;
1093 va_start(args, fmt);
1094 vsnprintf(msgbuf, PBUFFERSIZE, fmt, args);
1095 va_end(args);
1096 fprintf(stderr, "Transfer loop debugging: %s\n", msgbuf);
1099 /* Stream state: More data may be coming in this direction. */
1100 #define SSTATE_TRANSFERING 0
1102 * Stream state: No more data coming in this direction, flushing rest of
1103 * data.
1105 #define SSTATE_FLUSHING 1
1106 /* Stream state: Transfer in this direction finished. */
1107 #define SSTATE_FINISHED 2
1109 #define STATE_NEEDS_READING(state) ((state) <= SSTATE_TRANSFERING)
1110 #define STATE_NEEDS_WRITING(state) ((state) <= SSTATE_FLUSHING)
1111 #define STATE_NEEDS_CLOSING(state) ((state) == SSTATE_FLUSHING)
1113 /* Unidirectional transfer. */
1114 struct unidirectional_transfer {
1115 /* Source */
1116 int src;
1117 /* Destination */
1118 int dest;
1119 /* Is source socket? */
1120 int src_is_sock;
1121 /* Is destination socket? */
1122 int dest_is_sock;
1123 /* Transfer state (TRANSFERRING/FLUSHING/FINISHED) */
1124 int state;
1125 /* Buffer. */
1126 char buf[BUFFERSIZE];
1127 /* Buffer used. */
1128 size_t bufuse;
1129 /* Name of source. */
1130 const char *src_name;
1131 /* Name of destination. */
1132 const char *dest_name;
1135 /* Closes the target (for writing) if transfer has finished. */
1136 static void udt_close_if_finished(struct unidirectional_transfer *t)
1138 if (STATE_NEEDS_CLOSING(t->state) && !t->bufuse) {
1139 t->state = SSTATE_FINISHED;
1140 if (t->dest_is_sock)
1141 shutdown(t->dest, SHUT_WR);
1142 else
1143 close(t->dest);
1144 transfer_debug("Closed %s.", t->dest_name);
1149 * Tries to read read data from source into buffer. If buffer is full,
1150 * no data is read. Returns 0 on success, -1 on error.
1152 static int udt_do_read(struct unidirectional_transfer *t)
1154 ssize_t bytes;
1156 if (t->bufuse == BUFFERSIZE)
1157 return 0; /* No space for more. */
1159 transfer_debug("%s is readable", t->src_name);
1160 bytes = read(t->src, t->buf + t->bufuse, BUFFERSIZE - t->bufuse);
1161 if (bytes < 0 && errno != EWOULDBLOCK && errno != EAGAIN &&
1162 errno != EINTR) {
1163 error("read(%s) failed: %s", t->src_name, strerror(errno));
1164 return -1;
1165 } else if (bytes == 0) {
1166 transfer_debug("%s EOF (with %i bytes in buffer)",
1167 t->src_name, (int)t->bufuse);
1168 t->state = SSTATE_FLUSHING;
1169 } else if (bytes > 0) {
1170 t->bufuse += bytes;
1171 transfer_debug("Read %i bytes from %s (buffer now at %i)",
1172 (int)bytes, t->src_name, (int)t->bufuse);
1174 return 0;
1177 /* Tries to write data from buffer into destination. If buffer is empty,
1178 * no data is written. Returns 0 on success, -1 on error.
1180 static int udt_do_write(struct unidirectional_transfer *t)
1182 ssize_t bytes;
1184 if (t->bufuse == 0)
1185 return 0; /* Nothing to write. */
1187 transfer_debug("%s is writable", t->dest_name);
1188 bytes = xwrite(t->dest, t->buf, t->bufuse);
1189 if (bytes < 0 && errno != EWOULDBLOCK) {
1190 error("write(%s) failed: %s", t->dest_name, strerror(errno));
1191 return -1;
1192 } else if (bytes > 0) {
1193 t->bufuse -= bytes;
1194 if (t->bufuse)
1195 memmove(t->buf, t->buf + bytes, t->bufuse);
1196 transfer_debug("Wrote %i bytes to %s (buffer now at %i)",
1197 (int)bytes, t->dest_name, (int)t->bufuse);
1199 return 0;
1203 /* State of bidirectional transfer loop. */
1204 struct bidirectional_transfer_state {
1205 /* Direction from program to git. */
1206 struct unidirectional_transfer ptg;
1207 /* Direction from git to program. */
1208 struct unidirectional_transfer gtp;
1211 static void *udt_copy_task_routine(void *udt)
1213 struct unidirectional_transfer *t = (struct unidirectional_transfer *)udt;
1214 while (t->state != SSTATE_FINISHED) {
1215 if (STATE_NEEDS_READING(t->state))
1216 if (udt_do_read(t))
1217 return NULL;
1218 if (STATE_NEEDS_WRITING(t->state))
1219 if (udt_do_write(t))
1220 return NULL;
1221 if (STATE_NEEDS_CLOSING(t->state))
1222 udt_close_if_finished(t);
1224 return udt; /* Just some non-NULL value. */
1227 #ifndef NO_PTHREADS
1230 * Join thread, with appropriate errors on failure. Name is name for the
1231 * thread (for error messages). Returns 0 on success, 1 on failure.
1233 static int tloop_join(pthread_t thread, const char *name)
1235 int err;
1236 void *tret;
1237 err = pthread_join(thread, &tret);
1238 if (!tret) {
1239 error("%s thread failed", name);
1240 return 1;
1242 if (err) {
1243 error("%s thread failed to join: %s", name, strerror(err));
1244 return 1;
1246 return 0;
1250 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1251 * -1 on failure.
1253 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1255 pthread_t gtp_thread;
1256 pthread_t ptg_thread;
1257 int err;
1258 int ret = 0;
1259 err = pthread_create(&gtp_thread, NULL, udt_copy_task_routine,
1260 &s->gtp);
1261 if (err)
1262 die("Can't start thread for copying data: %s", strerror(err));
1263 err = pthread_create(&ptg_thread, NULL, udt_copy_task_routine,
1264 &s->ptg);
1265 if (err)
1266 die("Can't start thread for copying data: %s", strerror(err));
1268 ret |= tloop_join(gtp_thread, "Git to program copy");
1269 ret |= tloop_join(ptg_thread, "Program to git copy");
1270 return ret;
1272 #else
1274 /* Close the source and target (for writing) for transfer. */
1275 static void udt_kill_transfer(struct unidirectional_transfer *t)
1277 t->state = SSTATE_FINISHED;
1279 * Socket read end left open isn't a disaster if nobody
1280 * attempts to read from it (mingw compat headers do not
1281 * have SHUT_RD)...
1283 * We can't fully close the socket since otherwise gtp
1284 * task would first close the socket it sends data to
1285 * while closing the ptg file descriptors.
1287 if (!t->src_is_sock)
1288 close(t->src);
1289 if (t->dest_is_sock)
1290 shutdown(t->dest, SHUT_WR);
1291 else
1292 close(t->dest);
1296 * Join process, with appropriate errors on failure. Name is name for the
1297 * process (for error messages). Returns 0 on success, 1 on failure.
1299 static int tloop_join(pid_t pid, const char *name)
1301 int tret;
1302 if (waitpid(pid, &tret, 0) < 0) {
1303 error("%s process failed to wait: %s", name, strerror(errno));
1304 return 1;
1306 if (!WIFEXITED(tret) || WEXITSTATUS(tret)) {
1307 error("%s process failed", name);
1308 return 1;
1310 return 0;
1314 * Spawn the transfer tasks and then wait for them. Returns 0 on success,
1315 * -1 on failure.
1317 static int tloop_spawnwait_tasks(struct bidirectional_transfer_state *s)
1319 pid_t pid1, pid2;
1320 int ret = 0;
1322 /* Fork thread #1: git to program. */
1323 pid1 = fork();
1324 if (pid1 < 0)
1325 die_errno("Can't start thread for copying data");
1326 else if (pid1 == 0) {
1327 udt_kill_transfer(&s->ptg);
1328 exit(udt_copy_task_routine(&s->gtp) ? 0 : 1);
1331 /* Fork thread #2: program to git. */
1332 pid2 = fork();
1333 if (pid2 < 0)
1334 die_errno("Can't start thread for copying data");
1335 else if (pid2 == 0) {
1336 udt_kill_transfer(&s->gtp);
1337 exit(udt_copy_task_routine(&s->ptg) ? 0 : 1);
1341 * Close both streams in parent as to not interfere with
1342 * end of file detection and wait for both tasks to finish.
1344 udt_kill_transfer(&s->gtp);
1345 udt_kill_transfer(&s->ptg);
1346 ret |= tloop_join(pid1, "Git to program copy");
1347 ret |= tloop_join(pid2, "Program to git copy");
1348 return ret;
1350 #endif
1353 * Copies data from stdin to output and from input to stdout simultaneously.
1354 * Additionally filtering through given filter. If filter is NULL, uses
1355 * identity filter.
1357 int bidirectional_transfer_loop(int input, int output)
1359 struct bidirectional_transfer_state state;
1361 /* Fill the state fields. */
1362 state.ptg.src = input;
1363 state.ptg.dest = 1;
1364 state.ptg.src_is_sock = (input == output);
1365 state.ptg.dest_is_sock = 0;
1366 state.ptg.state = SSTATE_TRANSFERING;
1367 state.ptg.bufuse = 0;
1368 state.ptg.src_name = "remote input";
1369 state.ptg.dest_name = "stdout";
1371 state.gtp.src = 0;
1372 state.gtp.dest = output;
1373 state.gtp.src_is_sock = 0;
1374 state.gtp.dest_is_sock = (input == output);
1375 state.gtp.state = SSTATE_TRANSFERING;
1376 state.gtp.bufuse = 0;
1377 state.gtp.src_name = "stdin";
1378 state.gtp.dest_name = "remote output";
1380 return tloop_spawnwait_tasks(&state);