development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-06-30 22:54:27 +00:00
Code Issues Projects Releases Wiki Activity

pkt-line: do not chomp newlines for sideband messages

Browse Source 
When calling "packet_read_with_status()" to parse pkt-line encoded
packets, we can turn on the flag "PACKET_READ_CHOMP_NEWLINE" to chomp
newline character for each packet for better line matching. But when
receiving data and progress information using sideband, we should turn
off the flag "PACKET_READ_CHOMP_NEWLINE" to prevent mangling newline
characters from data and progress information.

When both the server and the client support "sideband-all" capability,
we have a dilemma that newline characters in negotiation packets should
be removed, but the newline characters in the progress information
should be left intact.

Add new flag "PACKET_READ_USE_SIDEBAND" for "packet_read_with_status()"
to prevent mangling newline characters in sideband messages.

Helped-by: Jonathan Tan <jonathantanmy@google.com>
Helped-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
Signed-off-by: Jiang Xin <zhiyou.jx@alibaba-inc.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jiang Xin 2023-12-17 22:41:38 +08:00 committed by Junio C Hamano
parent 64220dc5f7
commit 7033d5479b
3 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
pkt-line.c
View File

@ -462,8 +462,32 @@ enum packet_read_status packet_read_with_status(int fd, char **src_buffer,
}
if ((options & PACKET_READ_CHOMP_NEWLINE) &&
len && buffer[len-1] == '\n')
len--;
len && buffer[len-1] == '\n') {
if (options & PACKET_READ_USE_SIDEBAND) {
int band = *buffer & 0xff;
switch (band) {
case 1:
/* Chomp newline for payload */
len--;
break;
case 2:
case 3:
/*
* Do not chomp newline for progress and error
* message.
*/
break;
default:
/*
* Bad sideband, let's leave it to
* demultiplex_sideband() to catch this error.
*/
break;
}
} else {
len--;
}
}
buffer[len] = 0;
if (options & PACKET_READ_REDACT_URI_PATH &&
@ -602,6 +626,9 @@ enum packet_read_status packet_reader_read(struct packet_reader *reader)
return reader->status;
}
if (reader->use_sideband)
reader->options |= PACKET_READ_USE_SIDEBAND;
/*
* Consume all progress packets until a primary payload packet is
* received

1
pkt-line.h
View File

@ -85,6 +85,7 @@ void packet_fflush(FILE *f);
#define PACKET_READ_DIE_ON_ERR_PACKET (1u<<2)
#define PACKET_READ_GENTLE_ON_READ_ERROR (1u<<3)
#define PACKET_READ_REDACT_URI_PATH (1u<<4)
#define PACKET_READ_USE_SIDEBAND (1u<<5)
int packet_read(int fd, char *buffer, unsigned size, int options);
/*

2
t/t0070-fundamental.sh
View File

@ -97,7 +97,7 @@ test_expect_success 'unpack-sideband: packet_reader_read() consumes sideband, no
test_cmp expect-err err
'
test_expect_failure 'unpack-sideband: packet_reader_read() consumes sideband, chomp payload' '
test_expect_success 'unpack-sideband: packet_reader_read() consumes sideband, chomp payload' '
test_when_finished "rm -f expect-out expect-err" &&
test-tool pkt-line send-split-sideband >split-sideband &&
test-tool pkt-line unpack-sideband \