smart_pkt.c 11 KB
Newer Older
1
/*
Edward Thomson committed
2
 * Copyright (C) the libgit2 contributors. All rights reserved.
3
 *
Vicent Marti committed
4 5
 * This file is part of libgit2, distributed under the GNU GPL v2 with
 * a Linking Exception. For full terms see the included COPYING file.
6 7
 */

Vicent Marti committed
8 9
#include "common.h"

10 11
#include "git2/types.h"
#include "git2/errors.h"
12 13
#include "git2/refs.h"
#include "git2/revwalk.h"
14

15
#include "smart.h"
16
#include "util.h"
17
#include "netops.h"
18
#include "posix.h"
19
#include "buffer.h"
20

21 22 23
#include <ctype.h>

#define PKT_LEN_SIZE 4
24 25 26 27
static const char pkt_done_str[] = "0009done\n";
static const char pkt_flush_str[] = "0000";
static const char pkt_have_prefix[] = "0032have ";
static const char pkt_want_prefix[] = "0032want ";
28

29 30 31 32
static int flush_pkt(git_pkt **out)
{
	git_pkt *pkt;

33
	pkt = git__malloc(sizeof(git_pkt));
34
	GITERR_CHECK_ALLOC(pkt);
35 36 37 38

	pkt->type = GIT_PKT_FLUSH;
	*out = pkt;

39
	return 0;
40 41
}

42
/* the rest of the line will be useful for multi_ack and multi_ack_detailed */
43
static int ack_pkt(git_pkt **out, const char *line, size_t len)
Carlos Martín Nieto committed
44
{
45
	git_pkt_ack *pkt;
46 47
	GIT_UNUSED(line);
	GIT_UNUSED(len);
Carlos Martín Nieto committed
48

49
	pkt = git__calloc(1, sizeof(git_pkt_ack));
50
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
51 52

	pkt->type = GIT_PKT_ACK;
53 54 55 56 57 58 59 60 61 62 63 64
	line += 3;
	len -= 3;

	if (len >= GIT_OID_HEXSZ) {
		git_oid_fromstr(&pkt->oid, line + 1);
		line += GIT_OID_HEXSZ + 1;
		len -= GIT_OID_HEXSZ + 1;
	}

	if (len >= 7) {
		if (!git__prefixcmp(line + 1, "continue"))
			pkt->status = GIT_ACK_CONTINUE;
65 66 67 68
		if (!git__prefixcmp(line + 1, "common"))
			pkt->status = GIT_ACK_COMMON;
		if (!git__prefixcmp(line + 1, "ready"))
			pkt->status = GIT_ACK_READY;
69 70 71
	}

	*out = (git_pkt *) pkt;
Carlos Martín Nieto committed
72

73
	return 0;
Carlos Martín Nieto committed
74 75
}

Carlos Martín Nieto committed
76
static int nak_pkt(git_pkt **out)
Carlos Martín Nieto committed
77 78 79
{
	git_pkt *pkt;

80
	pkt = git__malloc(sizeof(git_pkt));
81
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
82

Carlos Martín Nieto committed
83 84 85
	pkt->type = GIT_PKT_NAK;
	*out = pkt;

86
	return 0;
Carlos Martín Nieto committed
87 88 89 90 91 92
}

static int pack_pkt(git_pkt **out)
{
	git_pkt *pkt;

93
	pkt = git__malloc(sizeof(git_pkt));
94
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
95 96

	pkt->type = GIT_PKT_PACK;
Carlos Martín Nieto committed
97 98
	*out = pkt;

99
	return 0;
Carlos Martín Nieto committed
100 101
}

102 103 104 105
static int comment_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_comment *pkt;

106
	pkt = git__malloc(sizeof(git_pkt_comment) + len + 1);
107
	GITERR_CHECK_ALLOC(pkt);
108 109 110 111 112 113 114

	pkt->type = GIT_PKT_COMMENT;
	memcpy(pkt->comment, line, len);
	pkt->comment[len] = '\0';

	*out = (git_pkt *) pkt;

115
	return 0;
116 117
}

118 119 120 121 122 123 124
static int err_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_err *pkt;

	/* Remove "ERR " from the line */
	line += 4;
	len -= 4;
125
	pkt = git__malloc(sizeof(git_pkt_err) + len + 1);
126 127 128
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_ERR;
129
	pkt->len = (int)len;
130 131 132 133 134 135 136 137
	memcpy(pkt->error, line, len);
	pkt->error[len] = '\0';

	*out = (git_pkt *) pkt;

	return 0;
}

138 139 140 141 142 143
static int data_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_data *pkt;

	line++;
	len--;
144
	pkt = git__malloc(sizeof(git_pkt_data) + len);
145 146 147 148 149 150 151 152 153 154 155
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_DATA;
	pkt->len = (int) len;
	memcpy(pkt->data, line, len);

	*out = (git_pkt *) pkt;

	return 0;
}

156
static int sideband_progress_pkt(git_pkt **out, const char *line, size_t len)
157 158 159 160 161
{
	git_pkt_progress *pkt;

	line++;
	len--;
162
	pkt = git__malloc(sizeof(git_pkt_progress) + len);
163 164 165 166 167 168 169 170 171 172 173
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_PROGRESS;
	pkt->len = (int) len;
	memcpy(pkt->data, line, len);

	*out = (git_pkt *) pkt;

	return 0;
}

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
static int sideband_error_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_err *pkt;

	line++;
	len--;
	pkt = git__malloc(sizeof(git_pkt_err) + len + 1);
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_ERR;
	pkt->len = (int)len;
	memcpy(pkt->error, line, len);
	pkt->error[len] = '\0';

	*out = (git_pkt *)pkt;

	return 0;
}

193
/*
194 195
 * Parse an other-ref line.
 */
Carlos Martín Nieto committed
196
static int ref_pkt(git_pkt **out, const char *line, size_t len)
197
{
198
	int error;
199 200
	git_pkt_ref *pkt;

201
	pkt = git__malloc(sizeof(git_pkt_ref));
202
	GITERR_CHECK_ALLOC(pkt);
203

204
	memset(pkt, 0x0, sizeof(git_pkt_ref));
205
	pkt->type = GIT_PKT_REF;
206
	if ((error = git_oid_fromstr(&pkt->head.oid, line)) < 0)
207
		goto error_out;
208 209 210

	/* Check for a bit of consistency */
	if (line[GIT_OID_HEXSZ] != ' ') {
211
		giterr_set(GITERR_NET, "Error parsing pkt-line");
212
		error = -1;
213
		goto error_out;
214 215
	}

216
	/* Jump from the name */
217
	line += GIT_OID_HEXSZ + 1;
218
	len -= (GIT_OID_HEXSZ + 1);
219

220 221
	if (line[len - 1] == '\n')
		--len;
222

223
	pkt->head.name = git__malloc(len + 1);
224 225
	GITERR_CHECK_ALLOC(pkt->head.name);

226 227
	memcpy(pkt->head.name, line, len);
	pkt->head.name[len] = '\0';
228

229
	if (strlen(pkt->head.name) < len) {
230
		pkt->capabilities = strchr(pkt->head.name, '\0') + 1;
231 232
	}

233 234 235 236 237
	*out = (git_pkt *)pkt;
	return 0;

error_out:
	git__free(pkt);
238
	return error;
239 240
}

241 242 243 244 245
static int ok_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_ok *pkt;
	const char *ptr;

246
	pkt = git__malloc(sizeof(*pkt));
247 248 249 250 251 252 253 254
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_OK;

	line += 3; /* skip "ok " */
	ptr = strchr(line, '\n');
	len = ptr - line;

255
	pkt->ref = git__malloc(len + 1);
256 257 258 259 260 261 262 263 264 265 266 267 268 269
	GITERR_CHECK_ALLOC(pkt->ref);

	memcpy(pkt->ref, line, len);
	pkt->ref[len] = '\0';

	*out = (git_pkt *)pkt;
	return 0;
}

static int ng_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_ng *pkt;
	const char *ptr;

270
	pkt = git__malloc(sizeof(*pkt));
271 272 273 274 275 276 277 278
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_NG;

	line += 3; /* skip "ng " */
	ptr = strchr(line, ' ');
	len = ptr - line;

279
	pkt->ref = git__malloc(len + 1);
280 281 282 283 284 285 286 287 288
	GITERR_CHECK_ALLOC(pkt->ref);

	memcpy(pkt->ref, line, len);
	pkt->ref[len] = '\0';

	line = ptr + 1;
	ptr = strchr(line, '\n');
	len = ptr - line;

289
	pkt->msg = git__malloc(len + 1);
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
	GITERR_CHECK_ALLOC(pkt->msg);

	memcpy(pkt->msg, line, len);
	pkt->msg[len] = '\0';

	*out = (git_pkt *)pkt;
	return 0;
}

static int unpack_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_unpack *pkt;

	GIT_UNUSED(len);

305
	pkt = git__malloc(sizeof(*pkt));
306 307 308 309 310 311 312 313 314 315 316 317
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_UNPACK;
	if (!git__prefixcmp(line, "unpack ok"))
		pkt->unpack_ok = 1;
	else
		pkt->unpack_ok = 0;

	*out = (git_pkt *)pkt;
	return 0;
}

318
static int32_t parse_len(const char *line)
319 320
{
	char num[PKT_LEN_SIZE + 1];
321 322
	int i, error;
	int32_t len;
323 324 325 326 327 328
	const char *num_end;

	memcpy(num, line, PKT_LEN_SIZE);
	num[PKT_LEN_SIZE] = '\0';

	for (i = 0; i < PKT_LEN_SIZE; ++i) {
329 330 331 332
		if (!isxdigit(num[i])) {
			giterr_set(GITERR_NET, "Found invalid hex digit in length");
			return -1;
		}
333 334
	}

335 336
	if ((error = git__strtol32(&len, num, &num_end, 16)) < 0)
		return error;
337

338
	return len;
339 340
}

341
/*
342 343
 * As per the documentation, the syntax is:
 *
Vicent Marti committed
344 345 346
 * pkt-line	= data-pkt / flush-pkt
 * data-pkt	= pkt-len pkt-payload
 * pkt-len		= 4*(HEXDIG)
347
 * pkt-payload = (pkt-len -4)*(OCTET)
Vicent Marti committed
348
 * flush-pkt	= "0000"
349 350 351 352 353
 *
 * Which means that the first four bytes are the length of the line,
 * in ASCII hexadecimal (including itself)
 */

354 355
int git_pkt_parse_line(
	git_pkt **head, const char *line, const char **out, size_t bufflen)
356
{
357 358
	int ret;
	int32_t len;
359

360
	/* Not even enough for the length */
361
	if (bufflen > 0 && bufflen < PKT_LEN_SIZE)
362
		return GIT_EBUFS;
363

364 365
	len = parse_len(line);
	if (len < 0) {
Carlos Martín Nieto committed
366 367 368 369 370
		/*
		 * If we fail to parse the length, it might be because the
		 * server is trying to send us the packfile already.
		 */
		if (bufflen >= 4 && !git__prefixcmp(line, "PACK")) {
Carlos Martín Nieto committed
371
			giterr_clear();
Carlos Martín Nieto committed
372 373 374 375
			*out = line;
			return pack_pkt(head);
		}

376
		return (int)len;
377
	}
378

379 380 381 382
	/*
	 * If we were given a buffer length, then make sure there is
	 * enough in the buffer to satisfy this line
	 */
383
	if (bufflen > 0 && bufflen < (size_t)len)
384
		return GIT_EBUFS;
385 386

	line += PKT_LEN_SIZE;
387 388 389 390
	/*
	 * TODO: How do we deal with empty lines? Try again? with the next
	 * line?
	 */
391
	if (len == PKT_LEN_SIZE) {
392
		*out = line;
393
		return 0;
394 395
	}

396 397 398
	if (len == 0) { /* Flush pkt */
		*out = line;
		return flush_pkt(head);
399 400
	}

401
	len -= PKT_LEN_SIZE; /* the encoded length includes its own size */
402

403 404 405
	if (*line == GIT_SIDE_BAND_DATA)
		ret = data_pkt(head, line, len);
	else if (*line == GIT_SIDE_BAND_PROGRESS)
406
		ret = sideband_progress_pkt(head, line, len);
407 408
	else if (*line == GIT_SIDE_BAND_ERROR)
		ret = sideband_error_pkt(head, line, len);
409
	else if (!git__prefixcmp(line, "ACK"))
410
		ret = ack_pkt(head, line, len);
Carlos Martín Nieto committed
411
	else if (!git__prefixcmp(line, "NAK"))
412
		ret = nak_pkt(head);
413 414
	else if (!git__prefixcmp(line, "ERR "))
		ret = err_pkt(head, line, len);
415
	else if (*line == '#')
416
		ret = comment_pkt(head, line, len);
417 418 419 420 421 422
	else if (!git__prefixcmp(line, "ok"))
		ret = ok_pkt(head, line, len);
	else if (!git__prefixcmp(line, "ng"))
		ret = ng_pkt(head, line, len);
	else if (!git__prefixcmp(line, "unpack"))
		ret = unpack_pkt(head, line, len);
Carlos Martín Nieto committed
423
	else
424
		ret = ref_pkt(head, line, len);
425 426 427

	*out = line + len;

428
	return ret;
429
}
430

431 432
void git_pkt_free(git_pkt *pkt)
{
433
	if (pkt->type == GIT_PKT_REF) {
434
		git_pkt_ref *p = (git_pkt_ref *) pkt;
435
		git__free(p->head.name);
436
		git__free(p->head.symref_target);
437 438
	}

439 440 441 442 443 444 445 446 447 448 449
	if (pkt->type == GIT_PKT_OK) {
		git_pkt_ok *p = (git_pkt_ok *) pkt;
		git__free(p->ref);
	}

	if (pkt->type == GIT_PKT_NG) {
		git_pkt_ng *p = (git_pkt_ng *) pkt;
		git__free(p->ref);
		git__free(p->msg);
	}

450
	git__free(pkt);
451 452
}

453 454
int git_pkt_buffer_flush(git_buf *buf)
{
455
	return git_buf_put(buf, pkt_flush_str, strlen(pkt_flush_str));
456 457
}

458
static int buffer_want_with_caps(const git_remote_head *head, transport_smart_caps *caps, git_buf *buf)
459
{
460
	git_buf str = GIT_BUF_INIT;
461
	char oid[GIT_OID_HEXSZ +1] = {0};
462
	unsigned int len;
463

464 465 466 467
	/* Prefer multi_ack_detailed */
	if (caps->multi_ack_detailed)
		git_buf_puts(&str, GIT_CAP_MULTI_ACK_DETAILED " ");
	else if (caps->multi_ack)
468 469
		git_buf_puts(&str, GIT_CAP_MULTI_ACK " ");

470 471 472 473 474 475
	/* Prefer side-band-64k if the server supports both */
	if (caps->side_band_64k)
		git_buf_printf(&str, "%s ", GIT_CAP_SIDE_BAND_64K);
	else if (caps->side_band)
		git_buf_printf(&str, "%s ", GIT_CAP_SIDE_BAND);

476 477 478
	if (caps->include_tag)
		git_buf_puts(&str, GIT_CAP_INCLUDE_TAG " ");

479 480 481
	if (caps->thin_pack)
		git_buf_puts(&str, GIT_CAP_THIN_PACK " ");

482 483 484
	if (caps->ofs_delta)
		git_buf_puts(&str, GIT_CAP_OFS_DELTA " ");

485 486
	if (git_buf_oom(&str))
		return -1;
487

488 489
	len = (unsigned int)
		(strlen("XXXXwant ") + GIT_OID_HEXSZ + 1 /* NUL */ +
490
		 git_buf_len(&str) + 1 /* LF */);
nulltoken committed
491
	git_buf_grow(buf, git_buf_len(buf) + len);
492
	git_oid_fmt(oid, &head->oid);
493 494 495 496
	git_buf_printf(buf, "%04xwant %s %s\n", len, oid, git_buf_cstr(&str));
	git_buf_free(&str);

	return git_buf_oom(buf);
497 498
}

499 500 501 502 503
/*
 * All "want" packets have the same length and format, so what we do
 * is overwrite the OID each time.
 */

504 505 506 507 508
int git_pkt_buffer_wants(
	const git_remote_head * const *refs,
	size_t count,
	transport_smart_caps *caps,
	git_buf *buf)
509
{
510 511
	size_t i = 0;
	const git_remote_head *head;
512 513

	if (caps->common) {
514 515
		for (; i < count; ++i) {
			head = refs[i];
516 517 518 519
			if (!head->local)
				break;
		}

520
		if (buffer_want_with_caps(refs[i], caps, buf) < 0)
521
			return -1;
522 523 524 525

		i++;
	}

526
	for (; i < count; ++i) {
527 528
		char oid[GIT_OID_HEXSZ];

529
		head = refs[i];
530 531 532 533
		if (head->local)
			continue;

		git_oid_fmt(oid, &head->oid);
534
		git_buf_put(buf, pkt_want_prefix, strlen(pkt_want_prefix));
535
		git_buf_put(buf, oid, GIT_OID_HEXSZ);
536
		git_buf_putc(buf, '\n');
537 538
		if (git_buf_oom(buf))
			return -1;
539 540 541 542 543 544 545 546 547 548 549
	}

	return git_pkt_buffer_flush(buf);
}

int git_pkt_buffer_have(git_oid *oid, git_buf *buf)
{
	char oidhex[GIT_OID_HEXSZ + 1];

	memset(oidhex, 0x0, sizeof(oidhex));
	git_oid_fmt(oidhex, oid);
550
	return git_buf_printf(buf, "%s%s\n", pkt_have_prefix, oidhex);
551 552 553 554
}

int git_pkt_buffer_done(git_buf *buf)
{
555
	return git_buf_puts(buf, pkt_done_str);
556
}