4 #include "parse-options.h"
6 #include "argv-array.h"
8 static const char * const git_update_ref_usage
[] = {
9 N_("git update-ref [<options>] -d <refname> [<old-val>]"),
10 N_("git update-ref [<options>] <refname> <new-val> [<old-val>]"),
11 N_("git update-ref [<options>] --stdin [-z]"),
15 static char line_termination
= '\n';
16 static int update_flags
;
17 static const char *msg
;
20 * Parse one whitespace- or NUL-terminated, possibly C-quoted argument
21 * and append the result to arg. Return a pointer to the terminator.
22 * Die if there is an error in how the argument is C-quoted. This
23 * function is only used if not -z.
25 static const char *parse_arg(const char *next
, struct strbuf
*arg
)
28 const char *orig
= next
;
30 if (unquote_c_style(arg
, next
, &next
))
31 die("badly quoted argument: %s", orig
);
32 if (*next
&& !isspace(*next
))
33 die("unexpected character after quoted argument: %s", orig
);
35 while (*next
&& !isspace(*next
))
36 strbuf_addch(arg
, *next
++);
43 * Parse the reference name immediately after "command SP". If not
44 * -z, then handle C-quoting. Return a pointer to a newly allocated
45 * string containing the name of the reference, or NULL if there was
46 * an error. Update *next to point at the character that terminates
47 * the argument. Die if C-quoting is malformed or the reference name
50 static char *parse_refname(struct strbuf
*input
, const char **next
)
52 struct strbuf ref
= STRBUF_INIT
;
54 if (line_termination
) {
55 /* Without -z, use the next argument */
56 *next
= parse_arg(*next
, &ref
);
58 /* With -z, use everything up to the next NUL */
59 strbuf_addstr(&ref
, *next
);
68 if (check_refname_format(ref
.buf
, REFNAME_ALLOW_ONELEVEL
))
69 die("invalid ref format: %s", ref
.buf
);
71 return strbuf_detach(&ref
, NULL
);
75 * The value being parsed is <oldvalue> (as opposed to <newvalue>; the
76 * difference affects which error messages are generated):
78 #define PARSE_SHA1_OLD 0x01
81 * For backwards compatibility, accept an empty string for update's
82 * <newvalue> in binary mode to be equivalent to specifying zeros.
84 #define PARSE_SHA1_ALLOW_EMPTY 0x02
87 * Parse an argument separator followed by the next argument, if any.
88 * If there is an argument, convert it to a SHA-1, write it to sha1,
89 * set *next to point at the character terminating the argument, and
90 * return 0. If there is no argument at all (not even the empty
91 * string), return 1 and leave *next unchanged. If the value is
92 * provided but cannot be converted to a SHA-1, die. flags can
93 * include PARSE_SHA1_OLD and/or PARSE_SHA1_ALLOW_EMPTY.
95 static int parse_next_sha1(struct strbuf
*input
, const char **next
,
97 const char *command
, const char *refname
,
100 struct strbuf arg
= STRBUF_INIT
;
103 if (*next
== input
->buf
+ input
->len
)
106 if (line_termination
) {
107 /* Without -z, consume SP and use next argument */
108 if (!**next
|| **next
== line_termination
)
111 die("%s %s: expected SP but got: %s",
112 command
, refname
, *next
);
114 *next
= parse_arg(*next
, &arg
);
116 if (get_sha1(arg
.buf
, sha1
))
119 /* Without -z, an empty value means all zeros: */
123 /* With -z, read the next NUL-terminated line */
125 die("%s %s: expected NUL but got: %s",
126 command
, refname
, *next
);
128 if (*next
== input
->buf
+ input
->len
)
130 strbuf_addstr(&arg
, *next
);
134 if (get_sha1(arg
.buf
, sha1
))
136 } else if (flags
& PARSE_SHA1_ALLOW_EMPTY
) {
137 /* With -z, treat an empty value as all zeros: */
138 warning("%s %s: missing <newvalue>, treating as zero",
143 * With -z, an empty non-required value means
150 strbuf_release(&arg
);
155 die(flags
& PARSE_SHA1_OLD
?
156 "%s %s: invalid <oldvalue>: %s" :
157 "%s %s: invalid <newvalue>: %s",
158 command
, refname
, arg
.buf
);
161 die(flags
& PARSE_SHA1_OLD
?
162 "%s %s: unexpected end of input when reading <oldvalue>" :
163 "%s %s: unexpected end of input when reading <newvalue>",
169 * The following five parse_cmd_*() functions parse the corresponding
170 * command. In each case, next points at the character following the
171 * command name and the following space. They each return a pointer
172 * to the character terminating the command, and die with an
173 * explanatory message if there are any parsing problems. All of
174 * these functions handle either text or binary format input,
175 * depending on how line_termination is set.
178 static const char *parse_cmd_update(struct ref_transaction
*transaction
,
179 struct strbuf
*input
, const char *next
)
181 struct strbuf err
= STRBUF_INIT
;
183 unsigned char new_sha1
[20];
184 unsigned char old_sha1
[20];
187 refname
= parse_refname(input
, &next
);
189 die("update: missing <ref>");
191 if (parse_next_sha1(input
, &next
, new_sha1
, "update", refname
,
192 PARSE_SHA1_ALLOW_EMPTY
))
193 die("update %s: missing <newvalue>", refname
);
195 have_old
= !parse_next_sha1(input
, &next
, old_sha1
, "update", refname
,
198 if (*next
!= line_termination
)
199 die("update %s: extra input: %s", refname
, next
);
201 if (ref_transaction_update(transaction
, refname
,
202 new_sha1
, have_old
? old_sha1
: NULL
,
203 update_flags
, msg
, &err
))
208 strbuf_release(&err
);
213 static const char *parse_cmd_create(struct ref_transaction
*transaction
,
214 struct strbuf
*input
, const char *next
)
216 struct strbuf err
= STRBUF_INIT
;
218 unsigned char new_sha1
[20];
220 refname
= parse_refname(input
, &next
);
222 die("create: missing <ref>");
224 if (parse_next_sha1(input
, &next
, new_sha1
, "create", refname
, 0))
225 die("create %s: missing <newvalue>", refname
);
227 if (is_null_sha1(new_sha1
))
228 die("create %s: zero <newvalue>", refname
);
230 if (*next
!= line_termination
)
231 die("create %s: extra input: %s", refname
, next
);
233 if (ref_transaction_create(transaction
, refname
, new_sha1
,
234 update_flags
, msg
, &err
))
239 strbuf_release(&err
);
244 static const char *parse_cmd_delete(struct ref_transaction
*transaction
,
245 struct strbuf
*input
, const char *next
)
247 struct strbuf err
= STRBUF_INIT
;
249 unsigned char old_sha1
[20];
252 refname
= parse_refname(input
, &next
);
254 die("delete: missing <ref>");
256 if (parse_next_sha1(input
, &next
, old_sha1
, "delete", refname
,
260 if (is_null_sha1(old_sha1
))
261 die("delete %s: zero <oldvalue>", refname
);
265 if (*next
!= line_termination
)
266 die("delete %s: extra input: %s", refname
, next
);
268 if (ref_transaction_delete(transaction
, refname
,
269 have_old
? old_sha1
: NULL
,
270 update_flags
, msg
, &err
))
275 strbuf_release(&err
);
280 static const char *parse_cmd_verify(struct ref_transaction
*transaction
,
281 struct strbuf
*input
, const char *next
)
283 struct strbuf err
= STRBUF_INIT
;
285 unsigned char old_sha1
[20];
287 refname
= parse_refname(input
, &next
);
289 die("verify: missing <ref>");
291 if (parse_next_sha1(input
, &next
, old_sha1
, "verify", refname
,
295 if (*next
!= line_termination
)
296 die("verify %s: extra input: %s", refname
, next
);
298 if (ref_transaction_verify(transaction
, refname
, old_sha1
,
304 strbuf_release(&err
);
309 static const char *parse_cmd_option(struct strbuf
*input
, const char *next
)
311 if (!strncmp(next
, "no-deref", 8) && next
[8] == line_termination
)
312 update_flags
|= REF_NODEREF
;
314 die("option unknown: %s", next
);
318 static void update_refs_stdin(struct ref_transaction
*transaction
)
320 struct strbuf input
= STRBUF_INIT
;
323 if (strbuf_read(&input
, 0, 1000) < 0)
324 die_errno("could not read from stdin");
326 /* Read each line dispatch its command */
327 while (next
< input
.buf
+ input
.len
) {
328 if (*next
== line_termination
)
329 die("empty command in input");
330 else if (isspace(*next
))
331 die("whitespace before command: %s", next
);
332 else if (starts_with(next
, "update "))
333 next
= parse_cmd_update(transaction
, &input
, next
+ 7);
334 else if (starts_with(next
, "create "))
335 next
= parse_cmd_create(transaction
, &input
, next
+ 7);
336 else if (starts_with(next
, "delete "))
337 next
= parse_cmd_delete(transaction
, &input
, next
+ 7);
338 else if (starts_with(next
, "verify "))
339 next
= parse_cmd_verify(transaction
, &input
, next
+ 7);
340 else if (starts_with(next
, "option "))
341 next
= parse_cmd_option(&input
, next
+ 7);
343 die("unknown command: %s", next
);
348 strbuf_release(&input
);
351 int cmd_update_ref(int argc
, const char **argv
, const char *prefix
)
353 const char *refname
, *oldval
;
354 unsigned char sha1
[20], oldsha1
[20];
355 int delete = 0, no_deref
= 0, read_stdin
= 0, end_null
= 0;
356 unsigned int flags
= 0;
357 struct option options
[] = {
358 OPT_STRING( 'm', NULL
, &msg
, N_("reason"), N_("reason of the update")),
359 OPT_BOOL('d', NULL
, &delete, N_("delete the reference")),
360 OPT_BOOL( 0 , "no-deref", &no_deref
,
361 N_("update <refname> not the one it points to")),
362 OPT_BOOL('z', NULL
, &end_null
, N_("stdin has NUL-terminated arguments")),
363 OPT_BOOL( 0 , "stdin", &read_stdin
, N_("read updates from stdin")),
367 git_config(git_default_config
, NULL
);
368 argc
= parse_options(argc
, argv
, prefix
, options
, git_update_ref_usage
,
371 die("Refusing to perform update with empty message.");
374 struct strbuf err
= STRBUF_INIT
;
375 struct ref_transaction
*transaction
;
377 transaction
= ref_transaction_begin(&err
);
380 if (delete || no_deref
|| argc
> 0)
381 usage_with_options(git_update_ref_usage
, options
);
383 line_termination
= '\0';
384 update_refs_stdin(transaction
);
385 if (ref_transaction_commit(transaction
, &err
))
387 ref_transaction_free(transaction
);
388 strbuf_release(&err
);
393 usage_with_options(git_update_ref_usage
, options
);
396 if (argc
< 1 || argc
> 2)
397 usage_with_options(git_update_ref_usage
, options
);
402 if (argc
< 2 || argc
> 3)
403 usage_with_options(git_update_ref_usage
, options
);
407 if (get_sha1(value
, sha1
))
408 die("%s: not a valid SHA1", value
);
414 * The empty string implies that the reference
415 * must not already exist:
418 else if (get_sha1(oldval
, oldsha1
))
419 die("%s: not a valid old SHA1", oldval
);
425 return delete_ref(refname
, oldval
? oldsha1
: NULL
, flags
);
427 return update_ref(msg
, refname
, sha1
, oldval
? oldsha1
: NULL
,
428 flags
, UPDATE_REFS_DIE_ON_ERR
);