mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
![Jeff King](/assets/img/avatar_default.png)
The packets sent during ref negotiation are all terminated by newline; even though the code to chomp these newlines is short, we end up doing it in a lot of places. This patch teaches packet_read_line to auto-chomp the trailing newline; this lets us get rid of a lot of inline chomping code. As a result, some call-sites which are not reading line-oriented data (e.g., when reading chunks of packfiles alongside sideband) transition away from packet_read_line to the generic packet_read interface. This patch converts all of the existing callsites. Since the function signature of packet_read_line does not change (but its behavior does), there is a possibility of new callsites being introduced in later commits, silently introducing an incompatibility. However, since a later patch in this series will change the signature, such a commit would have to be merged directly into this commit, not to the tip of the series; we can therefore ignore the issue. This is an internal cleanup and should produce no change of behavior in the normal case. However, there is one corner case to note. Callers of packet_read_line have never been able to tell the difference between a flush packet ("0000") and an empty packet ("0004"), as both cause packet_read_line to return a length of 0. Readers treat them identically, even though Documentation/technical/protocol-common.txt says we must not; it also says that implementations should not send an empty pkt-line. By stripping out the newline before the result gets to the caller, we will now treat the newline-only packet ("0005\n") the same as an empty packet, which in turn gets treated like a flush packet. In practice this doesn't matter, as neither empty nor newline-only packets are part of git's protocols (at least not for the line-oriented bits, and readers who are not expecting line-oriented packets will be calling packet_read directly, anyway). But even if we do decide to care about the distinction later, it is orthogonal to this patch. The right place to tighten would be to stop treating empty packets as flush packets, and this change does not make doing so any harder. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
153 lines
3.4 KiB
C
153 lines
3.4 KiB
C
#include "cache.h"
|
|
#include "pkt-line.h"
|
|
#include "sideband.h"
|
|
|
|
/*
|
|
* Receive multiplexed output stream over git native protocol.
|
|
* in_stream is the input stream from the remote, which carries data
|
|
* in pkt_line format with band designator. Demultiplex it into out
|
|
* and err and return error appropriately. Band #1 carries the
|
|
* primary payload. Things coming over band #2 is not necessarily
|
|
* error; they are usually informative message on the standard error
|
|
* stream, aka "verbose"). A message over band #3 is a signal that
|
|
* the remote died unexpectedly. A flush() concludes the stream.
|
|
*/
|
|
|
|
#define PREFIX "remote:"
|
|
|
|
#define ANSI_SUFFIX "\033[K"
|
|
#define DUMB_SUFFIX " "
|
|
|
|
#define FIX_SIZE 10 /* large enough for any of the above */
|
|
|
|
int recv_sideband(const char *me, int in_stream, int out)
|
|
{
|
|
unsigned pf = strlen(PREFIX);
|
|
unsigned sf;
|
|
char buf[LARGE_PACKET_MAX + 2*FIX_SIZE];
|
|
char *suffix, *term;
|
|
int skip_pf = 0;
|
|
|
|
memcpy(buf, PREFIX, pf);
|
|
term = getenv("TERM");
|
|
if (term && strcmp(term, "dumb"))
|
|
suffix = ANSI_SUFFIX;
|
|
else
|
|
suffix = DUMB_SUFFIX;
|
|
sf = strlen(suffix);
|
|
|
|
while (1) {
|
|
int band, len;
|
|
len = packet_read(in_stream, buf + pf, LARGE_PACKET_MAX, 0);
|
|
if (len == 0)
|
|
break;
|
|
if (len < 1) {
|
|
fprintf(stderr, "%s: protocol error: no band designator\n", me);
|
|
return SIDEBAND_PROTOCOL_ERROR;
|
|
}
|
|
band = buf[pf] & 0xff;
|
|
len--;
|
|
switch (band) {
|
|
case 3:
|
|
buf[pf] = ' ';
|
|
buf[pf+1+len] = '\0';
|
|
fprintf(stderr, "%s\n", buf);
|
|
return SIDEBAND_REMOTE_ERROR;
|
|
case 2:
|
|
buf[pf] = ' ';
|
|
do {
|
|
char *b = buf;
|
|
int brk = 0;
|
|
|
|
/*
|
|
* If the last buffer didn't end with a line
|
|
* break then we should not print a prefix
|
|
* this time around.
|
|
*/
|
|
if (skip_pf) {
|
|
b += pf+1;
|
|
} else {
|
|
len += pf+1;
|
|
brk += pf+1;
|
|
}
|
|
|
|
/* Look for a line break. */
|
|
for (;;) {
|
|
brk++;
|
|
if (brk > len) {
|
|
brk = 0;
|
|
break;
|
|
}
|
|
if (b[brk-1] == '\n' ||
|
|
b[brk-1] == '\r')
|
|
break;
|
|
}
|
|
|
|
/*
|
|
* Let's insert a suffix to clear the end
|
|
* of the screen line if a line break was
|
|
* found. Also, if we don't skip the
|
|
* prefix, then a non-empty string must be
|
|
* present too.
|
|
*/
|
|
if (brk > (skip_pf ? 0 : (pf+1 + 1))) {
|
|
char save[FIX_SIZE];
|
|
memcpy(save, b + brk, sf);
|
|
b[brk + sf - 1] = b[brk - 1];
|
|
memcpy(b + brk - 1, suffix, sf);
|
|
fprintf(stderr, "%.*s", brk + sf, b);
|
|
memcpy(b + brk, save, sf);
|
|
len -= brk;
|
|
} else {
|
|
int l = brk ? brk : len;
|
|
fprintf(stderr, "%.*s", l, b);
|
|
len -= l;
|
|
}
|
|
|
|
skip_pf = !brk;
|
|
memmove(buf + pf+1, b + brk, len);
|
|
} while (len);
|
|
continue;
|
|
case 1:
|
|
write_or_die(out, buf + pf+1, len);
|
|
continue;
|
|
default:
|
|
fprintf(stderr, "%s: protocol error: bad band #%d\n",
|
|
me, band);
|
|
return SIDEBAND_PROTOCOL_ERROR;
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* fd is connected to the remote side; send the sideband data
|
|
* over multiplexed packet stream.
|
|
*/
|
|
ssize_t send_sideband(int fd, int band, const char *data, ssize_t sz, int packet_max)
|
|
{
|
|
ssize_t ssz = sz;
|
|
const char *p = data;
|
|
|
|
while (sz) {
|
|
unsigned n;
|
|
char hdr[5];
|
|
|
|
n = sz;
|
|
if (packet_max - 5 < n)
|
|
n = packet_max - 5;
|
|
if (0 <= band) {
|
|
sprintf(hdr, "%04x", n + 5);
|
|
hdr[4] = band;
|
|
write_or_die(fd, hdr, 5);
|
|
} else {
|
|
sprintf(hdr, "%04x", n + 4);
|
|
write_or_die(fd, hdr, 4);
|
|
}
|
|
write_or_die(fd, p, n);
|
|
p += n;
|
|
sz -= n;
|
|
}
|
|
return ssz;
|
|
}
|