Re-fix check-ref-format documentation mark-up
[tgit.git] / remote-curl.c
blob3edbf5717c94f3123a97939acf265cc8334ca899
1 #include "cache.h"
2 #include "remote.h"
3 #include "strbuf.h"
4 #include "walker.h"
5 #include "http.h"
6 #include "exec_cmd.h"
7 #include "run-command.h"
8 #include "pkt-line.h"
9 #include "sideband.h"
11 static struct remote *remote;
12 static const char *url;
13 static struct walker *walker;
15 struct options {
16 int verbosity;
17 unsigned long depth;
18 unsigned progress : 1,
19 followtags : 1,
20 dry_run : 1,
21 thin : 1;
23 static struct options options;
25 static void init_walker(void)
27 if (!walker)
28 walker = get_http_walker(url, remote);
31 static int set_option(const char *name, const char *value)
33 if (!strcmp(name, "verbosity")) {
34 char *end;
35 int v = strtol(value, &end, 10);
36 if (value == end || *end)
37 return -1;
38 options.verbosity = v;
39 return 0;
41 else if (!strcmp(name, "progress")) {
42 if (!strcmp(value, "true"))
43 options.progress = 1;
44 else if (!strcmp(value, "false"))
45 options.progress = 0;
46 else
47 return -1;
48 return 0;
50 else if (!strcmp(name, "depth")) {
51 char *end;
52 unsigned long v = strtoul(value, &end, 10);
53 if (value == end || *end)
54 return -1;
55 options.depth = v;
56 return 0;
58 else if (!strcmp(name, "followtags")) {
59 if (!strcmp(value, "true"))
60 options.followtags = 1;
61 else if (!strcmp(value, "false"))
62 options.followtags = 0;
63 else
64 return -1;
65 return 0;
67 else if (!strcmp(name, "dry-run")) {
68 if (!strcmp(value, "true"))
69 options.dry_run = 1;
70 else if (!strcmp(value, "false"))
71 options.dry_run = 0;
72 else
73 return -1;
74 return 0;
76 else {
77 return 1 /* unsupported */;
81 struct discovery {
82 const char *service;
83 char *buf_alloc;
84 char *buf;
85 size_t len;
86 unsigned proto_git : 1;
88 static struct discovery *last_discovery;
90 static void free_discovery(struct discovery *d)
92 if (d) {
93 if (d == last_discovery)
94 last_discovery = NULL;
95 free(d->buf_alloc);
96 free(d);
100 static struct discovery* discover_refs(const char *service)
102 struct strbuf buffer = STRBUF_INIT;
103 struct discovery *last = last_discovery;
104 char *refs_url;
105 int http_ret, is_http = 0, proto_git_candidate = 1;
107 if (last && !strcmp(service, last->service))
108 return last;
109 free_discovery(last);
111 strbuf_addf(&buffer, "%s/info/refs", url);
112 if (!prefixcmp(url, "http://") || !prefixcmp(url, "https://")) {
113 is_http = 1;
114 if (!strchr(url, '?'))
115 strbuf_addch(&buffer, '?');
116 else
117 strbuf_addch(&buffer, '&');
118 strbuf_addf(&buffer, "service=%s", service);
120 refs_url = strbuf_detach(&buffer, NULL);
122 init_walker();
123 http_ret = http_get_strbuf(refs_url, &buffer, HTTP_NO_CACHE);
125 /* try again with "plain" url (no ? or & appended) */
126 if (http_ret != HTTP_OK) {
127 free(refs_url);
128 strbuf_reset(&buffer);
130 proto_git_candidate = 0;
131 strbuf_addf(&buffer, "%s/info/refs", url);
132 refs_url = strbuf_detach(&buffer, NULL);
134 http_ret = http_get_strbuf(refs_url, &buffer, HTTP_NO_CACHE);
137 switch (http_ret) {
138 case HTTP_OK:
139 break;
140 case HTTP_MISSING_TARGET:
141 die("%s not found: did you run git update-server-info on the"
142 " server?", refs_url);
143 default:
144 http_error(refs_url, http_ret);
145 die("HTTP request failed");
148 last= xcalloc(1, sizeof(*last_discovery));
149 last->service = service;
150 last->buf_alloc = strbuf_detach(&buffer, &last->len);
151 last->buf = last->buf_alloc;
153 if (is_http && proto_git_candidate
154 && 5 <= last->len && last->buf[4] == '#') {
155 /* smart HTTP response; validate that the service
156 * pkt-line matches our request.
158 struct strbuf exp = STRBUF_INIT;
160 if (packet_get_line(&buffer, &last->buf, &last->len) <= 0)
161 die("%s has invalid packet header", refs_url);
162 if (buffer.len && buffer.buf[buffer.len - 1] == '\n')
163 strbuf_setlen(&buffer, buffer.len - 1);
165 strbuf_addf(&exp, "# service=%s", service);
166 if (strbuf_cmp(&exp, &buffer))
167 die("invalid server response; got '%s'", buffer.buf);
168 strbuf_release(&exp);
170 /* The header can include additional metadata lines, up
171 * until a packet flush marker. Ignore these now, but
172 * in the future we might start to scan them.
174 strbuf_reset(&buffer);
175 while (packet_get_line(&buffer, &last->buf, &last->len) > 0)
176 strbuf_reset(&buffer);
178 last->proto_git = 1;
181 free(refs_url);
182 strbuf_release(&buffer);
183 last_discovery = last;
184 return last;
187 static int write_discovery(int fd, void *data)
189 struct discovery *heads = data;
190 int err = 0;
191 if (write_in_full(fd, heads->buf, heads->len) != heads->len)
192 err = 1;
193 close(fd);
194 return err;
197 static struct ref *parse_git_refs(struct discovery *heads)
199 struct ref *list = NULL;
200 struct async async;
202 memset(&async, 0, sizeof(async));
203 async.proc = write_discovery;
204 async.data = heads;
206 if (start_async(&async))
207 die("cannot start thread to parse advertised refs");
208 get_remote_heads(async.out, &list, 0, NULL, 0, NULL);
209 close(async.out);
210 if (finish_async(&async))
211 die("ref parsing thread failed");
212 return list;
215 static struct ref *parse_info_refs(struct discovery *heads)
217 char *data, *start, *mid;
218 char *ref_name;
219 int i = 0;
221 struct ref *refs = NULL;
222 struct ref *ref = NULL;
223 struct ref *last_ref = NULL;
225 data = heads->buf;
226 start = NULL;
227 mid = data;
228 while (i < heads->len) {
229 if (!start) {
230 start = &data[i];
232 if (data[i] == '\t')
233 mid = &data[i];
234 if (data[i] == '\n') {
235 data[i] = 0;
236 ref_name = mid + 1;
237 ref = xmalloc(sizeof(struct ref) +
238 strlen(ref_name) + 1);
239 memset(ref, 0, sizeof(struct ref));
240 strcpy(ref->name, ref_name);
241 get_sha1_hex(start, ref->old_sha1);
242 if (!refs)
243 refs = ref;
244 if (last_ref)
245 last_ref->next = ref;
246 last_ref = ref;
247 start = NULL;
249 i++;
252 init_walker();
253 ref = alloc_ref("HEAD");
254 if (!walker->fetch_ref(walker, ref) &&
255 !resolve_remote_symref(ref, refs)) {
256 ref->next = refs;
257 refs = ref;
258 } else {
259 free(ref);
262 return refs;
265 static struct ref *get_refs(int for_push)
267 struct discovery *heads;
269 if (for_push)
270 heads = discover_refs("git-receive-pack");
271 else
272 heads = discover_refs("git-upload-pack");
274 if (heads->proto_git)
275 return parse_git_refs(heads);
276 return parse_info_refs(heads);
279 static void output_refs(struct ref *refs)
281 struct ref *posn;
282 for (posn = refs; posn; posn = posn->next) {
283 if (posn->symref)
284 printf("@%s %s\n", posn->symref, posn->name);
285 else
286 printf("%s %s\n", sha1_to_hex(posn->old_sha1), posn->name);
288 printf("\n");
289 fflush(stdout);
290 free_refs(refs);
293 struct rpc_state {
294 const char *service_name;
295 const char **argv;
296 char *service_url;
297 char *hdr_content_type;
298 char *hdr_accept;
299 char *buf;
300 size_t alloc;
301 size_t len;
302 size_t pos;
303 int in;
304 int out;
305 struct strbuf result;
306 unsigned gzip_request : 1;
309 static size_t rpc_out(void *ptr, size_t eltsize,
310 size_t nmemb, void *buffer_)
312 size_t max = eltsize * nmemb;
313 struct rpc_state *rpc = buffer_;
314 size_t avail = rpc->len - rpc->pos;
316 if (!avail) {
317 avail = packet_read_line(rpc->out, rpc->buf, rpc->alloc);
318 if (!avail)
319 return 0;
320 rpc->pos = 0;
321 rpc->len = avail;
324 if (max < avail)
325 avail = max;
326 memcpy(ptr, rpc->buf + rpc->pos, avail);
327 rpc->pos += avail;
328 return avail;
331 static size_t rpc_in(const void *ptr, size_t eltsize,
332 size_t nmemb, void *buffer_)
334 size_t size = eltsize * nmemb;
335 struct rpc_state *rpc = buffer_;
336 write_or_die(rpc->in, ptr, size);
337 return size;
340 static int post_rpc(struct rpc_state *rpc)
342 struct active_request_slot *slot;
343 struct slot_results results;
344 struct curl_slist *headers = NULL;
345 int use_gzip = rpc->gzip_request;
346 char *gzip_body = NULL;
347 int err = 0, large_request = 0;
349 /* Try to load the entire request, if we can fit it into the
350 * allocated buffer space we can use HTTP/1.0 and avoid the
351 * chunked encoding mess.
353 while (1) {
354 size_t left = rpc->alloc - rpc->len;
355 char *buf = rpc->buf + rpc->len;
356 int n;
358 if (left < LARGE_PACKET_MAX) {
359 large_request = 1;
360 use_gzip = 0;
361 break;
364 n = packet_read_line(rpc->out, buf, left);
365 if (!n)
366 break;
367 rpc->len += n;
370 slot = get_active_slot();
371 slot->results = &results;
373 curl_easy_setopt(slot->curl, CURLOPT_NOBODY, 0);
374 curl_easy_setopt(slot->curl, CURLOPT_POST, 1);
375 curl_easy_setopt(slot->curl, CURLOPT_URL, rpc->service_url);
376 curl_easy_setopt(slot->curl, CURLOPT_ENCODING, "");
378 headers = curl_slist_append(headers, rpc->hdr_content_type);
379 headers = curl_slist_append(headers, rpc->hdr_accept);
381 if (large_request) {
382 /* The request body is large and the size cannot be predicted.
383 * We must use chunked encoding to send it.
385 headers = curl_slist_append(headers, "Expect: 100-continue");
386 headers = curl_slist_append(headers, "Transfer-Encoding: chunked");
387 curl_easy_setopt(slot->curl, CURLOPT_READFUNCTION, rpc_out);
388 curl_easy_setopt(slot->curl, CURLOPT_INFILE, rpc);
389 if (options.verbosity > 1) {
390 fprintf(stderr, "POST %s (chunked)\n", rpc->service_name);
391 fflush(stderr);
394 } else if (use_gzip && 1024 < rpc->len) {
395 /* The client backend isn't giving us compressed data so
396 * we can try to deflate it ourselves, this may save on.
397 * the transfer time.
399 size_t size;
400 z_stream stream;
401 int ret;
403 memset(&stream, 0, sizeof(stream));
404 ret = deflateInit2(&stream, Z_BEST_COMPRESSION,
405 Z_DEFLATED, (15 + 16),
406 8, Z_DEFAULT_STRATEGY);
407 if (ret != Z_OK)
408 die("cannot deflate request; zlib init error %d", ret);
409 size = deflateBound(&stream, rpc->len);
410 gzip_body = xmalloc(size);
412 stream.next_in = (unsigned char *)rpc->buf;
413 stream.avail_in = rpc->len;
414 stream.next_out = (unsigned char *)gzip_body;
415 stream.avail_out = size;
417 ret = deflate(&stream, Z_FINISH);
418 if (ret != Z_STREAM_END)
419 die("cannot deflate request; zlib deflate error %d", ret);
421 ret = deflateEnd(&stream);
422 if (ret != Z_OK)
423 die("cannot deflate request; zlib end error %d", ret);
425 size = stream.total_out;
427 headers = curl_slist_append(headers, "Content-Encoding: gzip");
428 curl_easy_setopt(slot->curl, CURLOPT_POSTFIELDS, gzip_body);
429 curl_easy_setopt(slot->curl, CURLOPT_POSTFIELDSIZE, size);
431 if (options.verbosity > 1) {
432 fprintf(stderr, "POST %s (gzip %lu to %lu bytes)\n",
433 rpc->service_name,
434 (unsigned long)rpc->len, (unsigned long)size);
435 fflush(stderr);
437 } else {
438 /* We know the complete request size in advance, use the
439 * more normal Content-Length approach.
441 curl_easy_setopt(slot->curl, CURLOPT_POSTFIELDS, rpc->buf);
442 curl_easy_setopt(slot->curl, CURLOPT_POSTFIELDSIZE, rpc->len);
443 if (options.verbosity > 1) {
444 fprintf(stderr, "POST %s (%lu bytes)\n",
445 rpc->service_name, (unsigned long)rpc->len);
446 fflush(stderr);
450 curl_easy_setopt(slot->curl, CURLOPT_HTTPHEADER, headers);
451 curl_easy_setopt(slot->curl, CURLOPT_WRITEFUNCTION, rpc_in);
452 curl_easy_setopt(slot->curl, CURLOPT_FILE, rpc);
454 slot->curl_result = curl_easy_perform(slot->curl);
455 finish_active_slot(slot);
457 if (results.curl_result != CURLE_OK) {
458 err |= error("RPC failed; result=%d, HTTP code = %ld",
459 results.curl_result, results.http_code);
462 curl_slist_free_all(headers);
463 free(gzip_body);
464 return err;
467 static int rpc_service(struct rpc_state *rpc, struct discovery *heads)
469 const char *svc = rpc->service_name;
470 struct strbuf buf = STRBUF_INIT;
471 struct child_process client;
472 int err = 0;
474 init_walker();
475 memset(&client, 0, sizeof(client));
476 client.in = -1;
477 client.out = -1;
478 client.git_cmd = 1;
479 client.argv = rpc->argv;
480 if (start_command(&client))
481 exit(1);
482 if (heads)
483 write_or_die(client.in, heads->buf, heads->len);
485 rpc->alloc = http_post_buffer;
486 rpc->buf = xmalloc(rpc->alloc);
487 rpc->in = client.in;
488 rpc->out = client.out;
489 strbuf_init(&rpc->result, 0);
491 strbuf_addf(&buf, "%s/%s", url, svc);
492 rpc->service_url = strbuf_detach(&buf, NULL);
494 strbuf_addf(&buf, "Content-Type: application/x-%s-request", svc);
495 rpc->hdr_content_type = strbuf_detach(&buf, NULL);
497 strbuf_addf(&buf, "Accept: application/x-%s-result", svc);
498 rpc->hdr_accept = strbuf_detach(&buf, NULL);
500 while (!err) {
501 int n = packet_read_line(rpc->out, rpc->buf, rpc->alloc);
502 if (!n)
503 break;
504 rpc->pos = 0;
505 rpc->len = n;
506 err |= post_rpc(rpc);
508 strbuf_read(&rpc->result, client.out, 0);
510 close(client.in);
511 close(client.out);
512 client.in = -1;
513 client.out = -1;
515 err |= finish_command(&client);
516 free(rpc->service_url);
517 free(rpc->hdr_content_type);
518 free(rpc->hdr_accept);
519 free(rpc->buf);
520 strbuf_release(&buf);
521 return err;
524 static int fetch_dumb(int nr_heads, struct ref **to_fetch)
526 char **targets = xmalloc(nr_heads * sizeof(char*));
527 int ret, i;
529 if (options.depth)
530 die("dumb http transport does not support --depth");
531 for (i = 0; i < nr_heads; i++)
532 targets[i] = xstrdup(sha1_to_hex(to_fetch[i]->old_sha1));
534 init_walker();
535 walker->get_all = 1;
536 walker->get_tree = 1;
537 walker->get_history = 1;
538 walker->get_verbosely = options.verbosity >= 3;
539 walker->get_recover = 0;
540 ret = walker_fetch(walker, nr_heads, targets, NULL, NULL);
542 for (i = 0; i < nr_heads; i++)
543 free(targets[i]);
544 free(targets);
546 return ret ? error("Fetch failed.") : 0;
549 static int fetch_git(struct discovery *heads,
550 int nr_heads, struct ref **to_fetch)
552 struct rpc_state rpc;
553 char *depth_arg = NULL;
554 const char **argv;
555 int argc = 0, i, err;
557 argv = xmalloc((15 + nr_heads) * sizeof(char*));
558 argv[argc++] = "fetch-pack";
559 argv[argc++] = "--stateless-rpc";
560 argv[argc++] = "--lock-pack";
561 if (options.followtags)
562 argv[argc++] = "--include-tag";
563 if (options.thin)
564 argv[argc++] = "--thin";
565 if (options.verbosity >= 3) {
566 argv[argc++] = "-v";
567 argv[argc++] = "-v";
569 if (!options.progress)
570 argv[argc++] = "--no-progress";
571 if (options.depth) {
572 struct strbuf buf = STRBUF_INIT;
573 strbuf_addf(&buf, "--depth=%lu", options.depth);
574 depth_arg = strbuf_detach(&buf, NULL);
575 argv[argc++] = depth_arg;
577 argv[argc++] = url;
578 for (i = 0; i < nr_heads; i++) {
579 struct ref *ref = to_fetch[i];
580 if (!ref->name || !*ref->name)
581 die("cannot fetch by sha1 over smart http");
582 argv[argc++] = ref->name;
584 argv[argc++] = NULL;
586 memset(&rpc, 0, sizeof(rpc));
587 rpc.service_name = "git-upload-pack",
588 rpc.argv = argv;
589 rpc.gzip_request = 1;
591 err = rpc_service(&rpc, heads);
592 if (rpc.result.len)
593 safe_write(1, rpc.result.buf, rpc.result.len);
594 strbuf_release(&rpc.result);
595 free(argv);
596 free(depth_arg);
597 return err;
600 static int fetch(int nr_heads, struct ref **to_fetch)
602 struct discovery *d = discover_refs("git-upload-pack");
603 if (d->proto_git)
604 return fetch_git(d, nr_heads, to_fetch);
605 else
606 return fetch_dumb(nr_heads, to_fetch);
609 static void parse_fetch(struct strbuf *buf)
611 struct ref **to_fetch = NULL;
612 struct ref *list_head = NULL;
613 struct ref **list = &list_head;
614 int alloc_heads = 0, nr_heads = 0;
616 do {
617 if (!prefixcmp(buf->buf, "fetch ")) {
618 char *p = buf->buf + strlen("fetch ");
619 char *name;
620 struct ref *ref;
621 unsigned char old_sha1[20];
623 if (strlen(p) < 40 || get_sha1_hex(p, old_sha1))
624 die("protocol error: expected sha/ref, got %s'", p);
625 if (p[40] == ' ')
626 name = p + 41;
627 else if (!p[40])
628 name = "";
629 else
630 die("protocol error: expected sha/ref, got %s'", p);
632 ref = alloc_ref(name);
633 hashcpy(ref->old_sha1, old_sha1);
635 *list = ref;
636 list = &ref->next;
638 ALLOC_GROW(to_fetch, nr_heads + 1, alloc_heads);
639 to_fetch[nr_heads++] = ref;
641 else
642 die("http transport does not support %s", buf->buf);
644 strbuf_reset(buf);
645 if (strbuf_getline(buf, stdin, '\n') == EOF)
646 return;
647 if (!*buf->buf)
648 break;
649 } while (1);
651 if (fetch(nr_heads, to_fetch))
652 exit(128); /* error already reported */
653 free_refs(list_head);
654 free(to_fetch);
656 printf("\n");
657 fflush(stdout);
658 strbuf_reset(buf);
661 static int push_dav(int nr_spec, char **specs)
663 const char **argv = xmalloc((10 + nr_spec) * sizeof(char*));
664 int argc = 0, i;
666 argv[argc++] = "http-push";
667 argv[argc++] = "--helper-status";
668 if (options.dry_run)
669 argv[argc++] = "--dry-run";
670 if (options.verbosity > 1)
671 argv[argc++] = "--verbose";
672 argv[argc++] = url;
673 for (i = 0; i < nr_spec; i++)
674 argv[argc++] = specs[i];
675 argv[argc++] = NULL;
677 if (run_command_v_opt(argv, RUN_GIT_CMD))
678 die("git-%s failed", argv[0]);
679 free(argv);
680 return 0;
683 static int push_git(struct discovery *heads, int nr_spec, char **specs)
685 struct rpc_state rpc;
686 const char **argv;
687 int argc = 0, i, err;
689 argv = xmalloc((10 + nr_spec) * sizeof(char*));
690 argv[argc++] = "send-pack";
691 argv[argc++] = "--stateless-rpc";
692 argv[argc++] = "--helper-status";
693 if (options.thin)
694 argv[argc++] = "--thin";
695 if (options.dry_run)
696 argv[argc++] = "--dry-run";
697 if (options.verbosity > 1)
698 argv[argc++] = "--verbose";
699 argv[argc++] = url;
700 for (i = 0; i < nr_spec; i++)
701 argv[argc++] = specs[i];
702 argv[argc++] = NULL;
704 memset(&rpc, 0, sizeof(rpc));
705 rpc.service_name = "git-receive-pack",
706 rpc.argv = argv;
708 err = rpc_service(&rpc, heads);
709 if (rpc.result.len)
710 safe_write(1, rpc.result.buf, rpc.result.len);
711 strbuf_release(&rpc.result);
712 free(argv);
713 return err;
716 static int push(int nr_spec, char **specs)
718 struct discovery *heads = discover_refs("git-receive-pack");
719 int ret;
721 if (heads->proto_git)
722 ret = push_git(heads, nr_spec, specs);
723 else
724 ret = push_dav(nr_spec, specs);
725 free_discovery(heads);
726 return ret;
729 static void parse_push(struct strbuf *buf)
731 char **specs = NULL;
732 int alloc_spec = 0, nr_spec = 0, i;
734 do {
735 if (!prefixcmp(buf->buf, "push ")) {
736 ALLOC_GROW(specs, nr_spec + 1, alloc_spec);
737 specs[nr_spec++] = xstrdup(buf->buf + 5);
739 else
740 die("http transport does not support %s", buf->buf);
742 strbuf_reset(buf);
743 if (strbuf_getline(buf, stdin, '\n') == EOF)
744 return;
745 if (!*buf->buf)
746 break;
747 } while (1);
749 if (push(nr_spec, specs))
750 exit(128); /* error already reported */
751 for (i = 0; i < nr_spec; i++)
752 free(specs[i]);
753 free(specs);
755 printf("\n");
756 fflush(stdout);
759 int main(int argc, const char **argv)
761 struct strbuf buf = STRBUF_INIT;
762 int nongit;
764 git_extract_argv0_path(argv[0]);
765 setup_git_directory_gently(&nongit);
766 if (argc < 2) {
767 fprintf(stderr, "Remote needed\n");
768 return 1;
771 options.verbosity = 1;
772 options.progress = !!isatty(2);
773 options.thin = 1;
775 remote = remote_get(argv[1]);
777 if (argc > 2) {
778 url = argv[2];
779 } else {
780 url = remote->url[0];
783 do {
784 if (strbuf_getline(&buf, stdin, '\n') == EOF)
785 break;
786 if (!prefixcmp(buf.buf, "fetch ")) {
787 if (nongit)
788 die("Fetch attempted without a local repo");
789 parse_fetch(&buf);
791 } else if (!strcmp(buf.buf, "list") || !prefixcmp(buf.buf, "list ")) {
792 int for_push = !!strstr(buf.buf + 4, "for-push");
793 output_refs(get_refs(for_push));
795 } else if (!prefixcmp(buf.buf, "push ")) {
796 parse_push(&buf);
798 } else if (!prefixcmp(buf.buf, "option ")) {
799 char *name = buf.buf + strlen("option ");
800 char *value = strchr(name, ' ');
801 int result;
803 if (value)
804 *value++ = '\0';
805 else
806 value = "true";
808 result = set_option(name, value);
809 if (!result)
810 printf("ok\n");
811 else if (result < 0)
812 printf("error invalid value\n");
813 else
814 printf("unsupported\n");
815 fflush(stdout);
817 } else if (!strcmp(buf.buf, "capabilities")) {
818 printf("fetch\n");
819 printf("option\n");
820 printf("push\n");
821 printf("\n");
822 fflush(stdout);
823 } else {
824 return 1;
826 strbuf_reset(&buf);
827 } while (1);
828 return 0;