smart_pkt.c 10.6 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
}

Carlos Martín Nieto committed
42
/* the rest of the line will be useful for multi_ack */
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 65 66 67
	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;
	}

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

69
	return 0;
Carlos Martín Nieto committed
70 71
}

Carlos Martín Nieto committed
72
static int nak_pkt(git_pkt **out)
Carlos Martín Nieto committed
73 74 75
{
	git_pkt *pkt;

76
	pkt = git__malloc(sizeof(git_pkt));
77
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
78

Carlos Martín Nieto committed
79 80 81
	pkt->type = GIT_PKT_NAK;
	*out = pkt;

82
	return 0;
Carlos Martín Nieto committed
83 84 85 86 87 88
}

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

89
	pkt = git__malloc(sizeof(git_pkt));
90
	GITERR_CHECK_ALLOC(pkt);
Carlos Martín Nieto committed
91 92

	pkt->type = GIT_PKT_PACK;
Carlos Martín Nieto committed
93 94
	*out = pkt;

95
	return 0;
Carlos Martín Nieto committed
96 97
}

98 99 100 101
static int comment_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_comment *pkt;

102
	pkt = git__malloc(sizeof(git_pkt_comment) + len + 1);
103
	GITERR_CHECK_ALLOC(pkt);
104 105 106 107 108 109 110

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

	*out = (git_pkt *) pkt;

111
	return 0;
112 113
}

114 115 116 117 118 119 120
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;
121
	pkt = git__malloc(sizeof(git_pkt_err) + len + 1);
122 123 124
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_ERR;
125
	pkt->len = (int)len;
126 127 128 129 130 131 132 133
	memcpy(pkt->error, line, len);
	pkt->error[len] = '\0';

	*out = (git_pkt *) pkt;

	return 0;
}

134 135 136 137 138 139
static int data_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_data *pkt;

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

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

	*out = (git_pkt *) pkt;

	return 0;
}

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

	line++;
	len--;
158
	pkt = git__malloc(sizeof(git_pkt_progress) + len);
159 160 161 162 163 164 165 166 167 168 169
	GITERR_CHECK_ALLOC(pkt);

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

	*out = (git_pkt *) pkt;

	return 0;
}

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
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;
}

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

197
	pkt = git__malloc(sizeof(git_pkt_ref));
198
	GITERR_CHECK_ALLOC(pkt);
199

200
	memset(pkt, 0x0, sizeof(git_pkt_ref));
201
	pkt->type = GIT_PKT_REF;
202
	if ((error = git_oid_fromstr(&pkt->head.oid, line)) < 0)
203
		goto error_out;
204 205 206

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

212
	/* Jump from the name */
213
	line += GIT_OID_HEXSZ + 1;
214
	len -= (GIT_OID_HEXSZ + 1);
215

216 217
	if (line[len - 1] == '\n')
		--len;
218

219
	pkt->head.name = git__malloc(len + 1);
220 221
	GITERR_CHECK_ALLOC(pkt->head.name);

222 223
	memcpy(pkt->head.name, line, len);
	pkt->head.name[len] = '\0';
224

225
	if (strlen(pkt->head.name) < len) {
226
		pkt->capabilities = strchr(pkt->head.name, '\0') + 1;
227 228
	}

229 230 231 232 233
	*out = (git_pkt *)pkt;
	return 0;

error_out:
	git__free(pkt);
234
	return error;
235 236
}

237 238 239 240 241
static int ok_pkt(git_pkt **out, const char *line, size_t len)
{
	git_pkt_ok *pkt;
	const char *ptr;

242
	pkt = git__malloc(sizeof(*pkt));
243 244 245 246 247 248 249 250
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_OK;

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

251
	pkt->ref = git__malloc(len + 1);
252 253 254 255 256 257 258 259 260 261 262 263 264 265
	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;

266
	pkt = git__malloc(sizeof(*pkt));
267 268 269 270 271 272 273 274
	GITERR_CHECK_ALLOC(pkt);

	pkt->type = GIT_PKT_NG;

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

275
	pkt->ref = git__malloc(len + 1);
276 277 278 279 280 281 282 283 284
	GITERR_CHECK_ALLOC(pkt->ref);

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

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

285
	pkt->msg = git__malloc(len + 1);
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
	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);

301
	pkt = git__malloc(sizeof(*pkt));
302 303 304 305 306 307 308 309 310 311 312 313
	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;
}

314
static int32_t parse_len(const char *line)
315 316
{
	char num[PKT_LEN_SIZE + 1];
317 318
	int i, error;
	int32_t len;
319 320 321 322 323 324
	const char *num_end;

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

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

331 332
	if ((error = git__strtol32(&len, num, &num_end, 16)) < 0)
		return error;
333

334
	return len;
335 336
}

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

350 351
int git_pkt_parse_line(
	git_pkt **head, const char *line, const char **out, size_t bufflen)
352
{
353 354
	int ret;
	int32_t len;
355

356
	/* Not even enough for the length */
357
	if (bufflen > 0 && bufflen < PKT_LEN_SIZE)
358
		return GIT_EBUFS;
359

360 361
	len = parse_len(line);
	if (len < 0) {
Carlos Martín Nieto committed
362 363 364 365 366
		/*
		 * 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
367
			giterr_clear();
Carlos Martín Nieto committed
368 369 370 371
			*out = line;
			return pack_pkt(head);
		}

372
		return (int)len;
373
	}
374

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

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

392 393 394
	if (len == 0) { /* Flush pkt */
		*out = line;
		return flush_pkt(head);
395 396
	}

397
	len -= PKT_LEN_SIZE; /* the encoded length includes its own size */
398

399 400 401 402
	if (*line == GIT_SIDE_BAND_DATA)
		ret = data_pkt(head, line, len);
	else if (*line == GIT_SIDE_BAND_PROGRESS)
		ret = progress_pkt(head, line, len);
403 404
	else if (*line == GIT_SIDE_BAND_ERROR)
		ret = sideband_error_pkt(head, line, len);
405
	else if (!git__prefixcmp(line, "ACK"))
406
		ret = ack_pkt(head, line, len);
Carlos Martín Nieto committed
407
	else if (!git__prefixcmp(line, "NAK"))
408
		ret = nak_pkt(head);
409 410
	else if (!git__prefixcmp(line, "ERR "))
		ret = err_pkt(head, line, len);
411
	else if (*line == '#')
412
		ret = comment_pkt(head, line, len);
413 414 415 416 417 418
	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
419
	else
420
		ret = ref_pkt(head, line, len);
421 422 423

	*out = line + len;

424
	return ret;
425
}
426

427 428
void git_pkt_free(git_pkt *pkt)
{
429
	if (pkt->type == GIT_PKT_REF) {
430
		git_pkt_ref *p = (git_pkt_ref *) pkt;
431
		git__free(p->head.name);
432 433
	}

434 435 436 437 438 439 440 441 442 443 444
	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);
	}

445
	git__free(pkt);
446 447
}

448 449
int git_pkt_buffer_flush(git_buf *buf)
{
450
	return git_buf_put(buf, pkt_flush_str, strlen(pkt_flush_str));
451 452
}

453
static int buffer_want_with_caps(const git_remote_head *head, transport_smart_caps *caps, git_buf *buf)
454
{
455
	git_buf str = GIT_BUF_INIT;
456
	char oid[GIT_OID_HEXSZ +1] = {0};
457
	unsigned int len;
458

459 460 461 462 463 464 465
	/* Prefer side-band-64k if the server supports both */
	if (caps->side_band) {
		if (caps->side_band_64k)
			git_buf_printf(&str, "%s ", GIT_CAP_SIDE_BAND_64K);
		else
			git_buf_printf(&str, "%s ", GIT_CAP_SIDE_BAND);
	}
466
	if (caps->ofs_delta)
467 468 469 470 471
		git_buf_puts(&str, GIT_CAP_OFS_DELTA " ");

	if (caps->multi_ack)
		git_buf_puts(&str, GIT_CAP_MULTI_ACK " ");

472 473 474
	if (caps->include_tag)
		git_buf_puts(&str, GIT_CAP_INCLUDE_TAG " ");

475 476
	if (git_buf_oom(&str))
		return -1;
477

478 479
	len = (unsigned int)
		(strlen("XXXXwant ") + GIT_OID_HEXSZ + 1 /* NUL */ +
480
		 git_buf_len(&str) + 1 /* LF */);
nulltoken committed
481
	git_buf_grow(buf, git_buf_len(buf) + len);
482
	git_oid_fmt(oid, &head->oid);
483 484 485 486
	git_buf_printf(buf, "%04xwant %s %s\n", len, oid, git_buf_cstr(&str));
	git_buf_free(&str);

	return git_buf_oom(buf);
487 488
}

489 490 491 492 493
/*
 * All "want" packets have the same length and format, so what we do
 * is overwrite the OID each time.
 */

494 495 496 497 498
int git_pkt_buffer_wants(
	const git_remote_head * const *refs,
	size_t count,
	transport_smart_caps *caps,
	git_buf *buf)
499
{
500 501
	size_t i = 0;
	const git_remote_head *head;
502 503

	if (caps->common) {
504 505
		for (; i < count; ++i) {
			head = refs[i];
506 507 508 509
			if (!head->local)
				break;
		}

510
		if (buffer_want_with_caps(refs[i], caps, buf) < 0)
511
			return -1;
512 513 514 515

		i++;
	}

516
	for (; i < count; ++i) {
517 518
		char oid[GIT_OID_HEXSZ];

519
		head = refs[i];
520 521 522 523
		if (head->local)
			continue;

		git_oid_fmt(oid, &head->oid);
524
		git_buf_put(buf, pkt_want_prefix, strlen(pkt_want_prefix));
525
		git_buf_put(buf, oid, GIT_OID_HEXSZ);
526
		git_buf_putc(buf, '\n');
527 528
		if (git_buf_oom(buf))
			return -1;
529 530 531 532 533 534 535 536 537 538 539
	}

	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);
540
	return git_buf_printf(buf, "%s%s\n", pkt_have_prefix, oidhex);
541 542 543 544
}

int git_pkt_buffer_done(git_buf *buf)
{
545
	return git_buf_puts(buf, pkt_done_str);
546
}