update-ref.c: extract a new function, parse_next_sha1()

Replace three functions, update_store_new_sha1(),
update_store_old_sha1(), and parse_next_arg(), with a single function,
parse_next_sha1().  The new function takes care of a whole argument,
including checking whether it is there, converting it to an SHA-1, and
emitting errors on EOF or for invalid values.  The return value
indicates whether the argument was present or absent, which requires
a bit of intelligence because absent values are represented
differently depending on whether "-z" was used.

The new interface means that the calling functions, parse_cmd_*(),
don't have to interpret the result differently based on the
line_termination mode that is in effect.  It also means that
parse_cmd_create() can distinguish unambiguously between an empty new
value and a zeros new value, which fixes a failure in t1400.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Michael Haggerty 2014-04-07 15:48:05 +02:00 committed by Junio C Hamano
parent 191f241b52
commit 3afcc46374
2 changed files with 100 additions and 64 deletions

View File

@ -35,27 +35,6 @@ static struct ref_update *update_alloc(void)
return update; return update;
} }
static void update_store_new_sha1(const char *command,
struct ref_update *update,
const char *newvalue)
{
if (*newvalue && get_sha1(newvalue, update->new_sha1))
die("%s %s: invalid <newvalue>: %s",
command, update->ref_name, newvalue);
}
static void update_store_old_sha1(const char *command,
struct ref_update *update,
const char *oldvalue)
{
if (*oldvalue && get_sha1(oldvalue, update->old_sha1))
die("%s %s: invalid <oldvalue>: %s",
command, update->ref_name, oldvalue);
/* We have an old value if non-empty, or if empty without -z */
update->have_old = *oldvalue || line_termination;
}
/* /*
* Parse one whitespace- or NUL-terminated, possibly C-quoted argument * Parse one whitespace- or NUL-terminated, possibly C-quoted argument
* and append the result to arg. Return a pointer to the terminator. * and append the result to arg. Return a pointer to the terminator.
@ -112,35 +91,94 @@ static char *parse_refname(struct strbuf *input, const char **next)
} }
/* /*
* Parse a SP/NUL separator followed by the next SP- or NUL-terminated * The value being parsed is <oldvalue> (as opposed to <newvalue>; the
* argument, if any. If there is an argument, write it to arg, set * difference affects which error messages are generated):
* *next to point at the character terminating the argument, and
* return 0. If there is no argument at all (not even the empty
* string), return a non-zero result and leave *next unchanged.
*/ */
static int parse_next_arg(struct strbuf *input, const char **next, #define PARSE_SHA1_OLD 0x01
struct strbuf *arg)
/*
* For backwards compatibility, accept an empty string for update's
* <newvalue> in binary mode to be equivalent to specifying zeros.
*/
#define PARSE_SHA1_ALLOW_EMPTY 0x02
/*
* Parse an argument separator followed by the next argument, if any.
* If there is an argument, convert it to a SHA-1, write it to sha1,
* set *next to point at the character terminating the argument, and
* return 0. If there is no argument at all (not even the empty
* string), return 1 and leave *next unchanged. If the value is
* provided but cannot be converted to a SHA-1, die. flags can
* include PARSE_SHA1_OLD and/or PARSE_SHA1_ALLOW_EMPTY.
*/
static int parse_next_sha1(struct strbuf *input, const char **next,
unsigned char *sha1,
const char *command, const char *refname,
int flags)
{ {
strbuf_reset(arg); struct strbuf arg = STRBUF_INIT;
int ret = 0;
if (*next == input->buf + input->len)
goto eof;
if (line_termination) { if (line_termination) {
/* Without -z, consume SP and use next argument */ /* Without -z, consume SP and use next argument */
if (!**next || **next == line_termination) if (!**next || **next == line_termination)
return -1; return 1;
if (**next != ' ') if (**next != ' ')
die("expected SP but got: %s", *next); die("%s %s: expected SP but got: %s",
command, refname, *next);
(*next)++; (*next)++;
*next = parse_arg(*next, arg); *next = parse_arg(*next, &arg);
if (arg.len) {
if (get_sha1(arg.buf, sha1))
goto invalid;
} else {
/* Without -z, an empty value means all zeros: */
hashclr(sha1);
}
} else { } else {
/* With -z, read the next NUL-terminated line */ /* With -z, read the next NUL-terminated line */
if (**next) if (**next)
die("expected NUL but got: %s", *next); die("%s %s: expected NUL but got: %s",
command, refname, *next);
(*next)++; (*next)++;
if (*next == input->buf + input->len) if (*next == input->buf + input->len)
return -1; goto eof;
strbuf_addstr(arg, *next); strbuf_addstr(&arg, *next);
*next += arg->len; *next += arg.len;
if (arg.len) {
if (get_sha1(arg.buf, sha1))
goto invalid;
} else if (flags & PARSE_SHA1_ALLOW_EMPTY) {
/* With -z, treat an empty value as all zeros: */
hashclr(sha1);
} else {
/*
* With -z, an empty non-required value means
* unspecified:
*/
ret = 1;
} }
return 0; }
strbuf_release(&arg);
return ret;
invalid:
die(flags & PARSE_SHA1_OLD ?
"%s %s: invalid <oldvalue>: %s" :
"%s %s: invalid <newvalue>: %s",
command, refname, arg.buf);
eof:
die(flags & PARSE_SHA1_OLD ?
"%s %s missing <oldvalue>" :
"%s %s missing <newvalue>",
command, refname);
} }
@ -156,8 +194,6 @@ static int parse_next_arg(struct strbuf *input, const char **next,
static const char *parse_cmd_update(struct strbuf *input, const char *next) static const char *parse_cmd_update(struct strbuf *input, const char *next)
{ {
struct strbuf newvalue = STRBUF_INIT;
struct strbuf oldvalue = STRBUF_INIT;
struct ref_update *update; struct ref_update *update;
update = update_alloc(); update = update_alloc();
@ -166,24 +202,23 @@ static const char *parse_cmd_update(struct strbuf *input, const char *next)
if (!update->ref_name) if (!update->ref_name)
die("update line missing <ref>"); die("update line missing <ref>");
if (!parse_next_arg(input, &next, &newvalue)) if (parse_next_sha1(input, &next, update->new_sha1,
update_store_new_sha1("update", update, newvalue.buf); "update", update->ref_name,
else PARSE_SHA1_ALLOW_EMPTY))
die("update %s missing <newvalue>", update->ref_name); die("update %s missing <newvalue>", update->ref_name);
if (!parse_next_arg(input, &next, &oldvalue)) { update->have_old = !parse_next_sha1(input, &next, update->old_sha1,
update_store_old_sha1("update", update, oldvalue.buf); "update", update->ref_name,
PARSE_SHA1_OLD);
if (*next != line_termination) if (*next != line_termination)
die("update %s has extra input: %s", update->ref_name, next); die("update %s has extra input: %s", update->ref_name, next);
} else if (!line_termination)
die("update %s missing <oldvalue>", update->ref_name);
return next; return next;
} }
static const char *parse_cmd_create(struct strbuf *input, const char *next) static const char *parse_cmd_create(struct strbuf *input, const char *next)
{ {
struct strbuf newvalue = STRBUF_INIT;
struct ref_update *update; struct ref_update *update;
update = update_alloc(); update = update_alloc();
@ -192,9 +227,8 @@ static const char *parse_cmd_create(struct strbuf *input, const char *next)
if (!update->ref_name) if (!update->ref_name)
die("create line missing <ref>"); die("create line missing <ref>");
if (!parse_next_arg(input, &next, &newvalue)) if (parse_next_sha1(input, &next, update->new_sha1,
update_store_new_sha1("create", update, newvalue.buf); "create", update->ref_name, 0))
else
die("create %s missing <newvalue>", update->ref_name); die("create %s missing <newvalue>", update->ref_name);
if (is_null_sha1(update->new_sha1)) if (is_null_sha1(update->new_sha1))
@ -208,7 +242,6 @@ static const char *parse_cmd_create(struct strbuf *input, const char *next)
static const char *parse_cmd_delete(struct strbuf *input, const char *next) static const char *parse_cmd_delete(struct strbuf *input, const char *next)
{ {
struct strbuf oldvalue = STRBUF_INIT;
struct ref_update *update; struct ref_update *update;
update = update_alloc(); update = update_alloc();
@ -217,12 +250,14 @@ static const char *parse_cmd_delete(struct strbuf *input, const char *next)
if (!update->ref_name) if (!update->ref_name)
die("delete line missing <ref>"); die("delete line missing <ref>");
if (!parse_next_arg(input, &next, &oldvalue)) { if (parse_next_sha1(input, &next, update->old_sha1,
update_store_old_sha1("delete", update, oldvalue.buf); "delete", update->ref_name, PARSE_SHA1_OLD)) {
if (update->have_old && is_null_sha1(update->old_sha1)) update->have_old = 0;
} else {
if (is_null_sha1(update->old_sha1))
die("delete %s given zero <oldvalue>", update->ref_name); die("delete %s given zero <oldvalue>", update->ref_name);
} else if (!line_termination) update->have_old = 1;
die("delete %s missing <oldvalue>", update->ref_name); }
if (*next != line_termination) if (*next != line_termination)
die("delete %s has extra input: %s", update->ref_name, next); die("delete %s has extra input: %s", update->ref_name, next);
@ -232,7 +267,6 @@ static const char *parse_cmd_delete(struct strbuf *input, const char *next)
static const char *parse_cmd_verify(struct strbuf *input, const char *next) static const char *parse_cmd_verify(struct strbuf *input, const char *next)
{ {
struct strbuf value = STRBUF_INIT;
struct ref_update *update; struct ref_update *update;
update = update_alloc(); update = update_alloc();
@ -241,11 +275,13 @@ static const char *parse_cmd_verify(struct strbuf *input, const char *next)
if (!update->ref_name) if (!update->ref_name)
die("verify line missing <ref>"); die("verify line missing <ref>");
if (!parse_next_arg(input, &next, &value)) { if (parse_next_sha1(input, &next, update->old_sha1,
update_store_old_sha1("verify", update, value.buf); "verify", update->ref_name, PARSE_SHA1_OLD)) {
update->have_old = 0;
} else {
hashcpy(update->new_sha1, update->old_sha1); hashcpy(update->new_sha1, update->old_sha1);
} else if (!line_termination) update->have_old = 1;
die("verify %s missing <oldvalue>", update->ref_name); }
if (*next != line_termination) if (*next != line_termination)
die("verify %s has extra input: %s", update->ref_name, next); die("verify %s has extra input: %s", update->ref_name, next);

View File

@ -858,7 +858,7 @@ test_expect_success 'stdin -z create ref fails with bad new value' '
test_must_fail git rev-parse --verify -q $c test_must_fail git rev-parse --verify -q $c
' '
test_expect_failure 'stdin -z create ref fails with empty new value' ' test_expect_success 'stdin -z create ref fails with empty new value' '
printf $F "create $c" "" >stdin && printf $F "create $c" "" >stdin &&
test_must_fail git update-ref -z --stdin <stdin 2>err && test_must_fail git update-ref -z --stdin <stdin 2>err &&
grep "fatal: create $c missing <newvalue>" err && grep "fatal: create $c missing <newvalue>" err &&