6 #include "object-name.h"
7 #include "parse-options.h"
9 #include "repository.h"
11 static const char * const git_update_ref_usage
[] = {
12 N_("git update-ref [<options>] -d <refname> [<old-oid>]"),
13 N_("git update-ref [<options>] <refname> <new-oid> [<old-oid>]"),
14 N_("git update-ref [<options>] --stdin [-z]"),
18 static char line_termination
= '\n';
19 static unsigned int update_flags
;
20 static unsigned int default_flags
;
21 static unsigned create_reflog_flag
;
22 static const char *msg
;
25 * Parse one whitespace- or NUL-terminated, possibly C-quoted argument
26 * and append the result to arg. Return a pointer to the terminator.
27 * Die if there is an error in how the argument is C-quoted. This
28 * function is only used if not -z.
30 static const char *parse_arg(const char *next
, struct strbuf
*arg
)
33 const char *orig
= next
;
35 if (unquote_c_style(arg
, next
, &next
))
36 die("badly quoted argument: %s", orig
);
37 if (*next
&& !isspace(*next
))
38 die("unexpected character after quoted argument: %s", orig
);
40 while (*next
&& !isspace(*next
))
41 strbuf_addch(arg
, *next
++);
48 * Parse the reference name immediately after "command SP". If not
49 * -z, then handle C-quoting. Return a pointer to a newly allocated
50 * string containing the name of the reference, or NULL if there was
51 * an error. Update *next to point at the character that terminates
52 * the argument. Die if C-quoting is malformed or the reference name
55 static char *parse_refname(const char **next
)
57 struct strbuf ref
= STRBUF_INIT
;
59 if (line_termination
) {
60 /* Without -z, use the next argument */
61 *next
= parse_arg(*next
, &ref
);
63 /* With -z, use everything up to the next NUL */
64 strbuf_addstr(&ref
, *next
);
73 if (check_refname_format(ref
.buf
, REFNAME_ALLOW_ONELEVEL
))
74 die("invalid ref format: %s", ref
.buf
);
76 return strbuf_detach(&ref
, NULL
);
80 * The value being parsed is <old-oid> (as opposed to <new-oid>; the
81 * difference affects which error messages are generated):
83 #define PARSE_SHA1_OLD 0x01
86 * For backwards compatibility, accept an empty string for update's
87 * <new-oid> in binary mode to be equivalent to specifying zeros.
89 #define PARSE_SHA1_ALLOW_EMPTY 0x02
92 * Parse an argument separator followed by the next argument, if any.
93 * If there is an argument, convert it to a SHA-1, write it to sha1,
94 * set *next to point at the character terminating the argument, and
95 * return 0. If there is no argument at all (not even the empty
96 * string), return 1 and leave *next unchanged. If the value is
97 * provided but cannot be converted to a SHA-1, die. flags can
98 * include PARSE_SHA1_OLD and/or PARSE_SHA1_ALLOW_EMPTY.
100 static int parse_next_oid(const char **next
, const char *end
,
101 struct object_id
*oid
,
102 const char *command
, const char *refname
,
105 struct strbuf arg
= STRBUF_INIT
;
111 if (line_termination
) {
112 /* Without -z, consume SP and use next argument */
113 if (!**next
|| **next
== line_termination
)
116 die("%s %s: expected SP but got: %s",
117 command
, refname
, *next
);
119 *next
= parse_arg(*next
, &arg
);
121 if (repo_get_oid(the_repository
, arg
.buf
, oid
))
124 /* Without -z, an empty value means all zeros: */
128 /* With -z, read the next NUL-terminated line */
130 die("%s %s: expected NUL but got: %s",
131 command
, refname
, *next
);
135 strbuf_addstr(&arg
, *next
);
139 if (repo_get_oid(the_repository
, arg
.buf
, oid
))
141 } else if (flags
& PARSE_SHA1_ALLOW_EMPTY
) {
142 /* With -z, treat an empty value as all zeros: */
143 warning("%s %s: missing <new-oid>, treating as zero",
148 * With -z, an empty non-required value means
155 strbuf_release(&arg
);
160 die(flags
& PARSE_SHA1_OLD
?
161 "%s %s: invalid <old-oid>: %s" :
162 "%s %s: invalid <new-oid>: %s",
163 command
, refname
, arg
.buf
);
166 die(flags
& PARSE_SHA1_OLD
?
167 "%s %s: unexpected end of input when reading <old-oid>" :
168 "%s %s: unexpected end of input when reading <new-oid>",
174 * The following five parse_cmd_*() functions parse the corresponding
175 * command. In each case, next points at the character following the
176 * command name and the following space. They each return a pointer
177 * to the character terminating the command, and die with an
178 * explanatory message if there are any parsing problems. All of
179 * these functions handle either text or binary format input,
180 * depending on how line_termination is set.
183 static void parse_cmd_update(struct ref_transaction
*transaction
,
184 const char *next
, const char *end
)
186 struct strbuf err
= STRBUF_INIT
;
188 struct object_id new_oid
, old_oid
;
191 refname
= parse_refname(&next
);
193 die("update: missing <ref>");
195 if (parse_next_oid(&next
, end
, &new_oid
, "update", refname
,
196 PARSE_SHA1_ALLOW_EMPTY
))
197 die("update %s: missing <new-oid>", refname
);
199 have_old
= !parse_next_oid(&next
, end
, &old_oid
, "update", refname
,
202 if (*next
!= line_termination
)
203 die("update %s: extra input: %s", refname
, next
);
205 if (ref_transaction_update(transaction
, refname
,
206 &new_oid
, have_old
? &old_oid
: NULL
,
208 update_flags
| create_reflog_flag
,
212 update_flags
= default_flags
;
214 strbuf_release(&err
);
217 static void parse_cmd_create(struct ref_transaction
*transaction
,
218 const char *next
, const char *end
)
220 struct strbuf err
= STRBUF_INIT
;
222 struct object_id new_oid
;
224 refname
= parse_refname(&next
);
226 die("create: missing <ref>");
228 if (parse_next_oid(&next
, end
, &new_oid
, "create", refname
, 0))
229 die("create %s: missing <new-oid>", refname
);
231 if (is_null_oid(&new_oid
))
232 die("create %s: zero <new-oid>", refname
);
234 if (*next
!= line_termination
)
235 die("create %s: extra input: %s", refname
, next
);
237 if (ref_transaction_create(transaction
, refname
, &new_oid
,
238 update_flags
| create_reflog_flag
,
242 update_flags
= default_flags
;
244 strbuf_release(&err
);
247 static void parse_cmd_delete(struct ref_transaction
*transaction
,
248 const char *next
, const char *end
)
250 struct strbuf err
= STRBUF_INIT
;
252 struct object_id old_oid
;
255 refname
= parse_refname(&next
);
257 die("delete: missing <ref>");
259 if (parse_next_oid(&next
, end
, &old_oid
, "delete", refname
,
263 if (is_null_oid(&old_oid
))
264 die("delete %s: zero <old-oid>", refname
);
268 if (*next
!= line_termination
)
269 die("delete %s: extra input: %s", refname
, next
);
271 if (ref_transaction_delete(transaction
, refname
,
272 have_old
? &old_oid
: NULL
,
273 update_flags
, msg
, &err
))
276 update_flags
= default_flags
;
278 strbuf_release(&err
);
281 static void parse_cmd_verify(struct ref_transaction
*transaction
,
282 const char *next
, const char *end
)
284 struct strbuf err
= STRBUF_INIT
;
286 struct object_id old_oid
;
288 refname
= parse_refname(&next
);
290 die("verify: missing <ref>");
292 if (parse_next_oid(&next
, end
, &old_oid
, "verify", refname
,
296 if (*next
!= line_termination
)
297 die("verify %s: extra input: %s", refname
, next
);
299 if (ref_transaction_verify(transaction
, refname
, &old_oid
,
303 update_flags
= default_flags
;
305 strbuf_release(&err
);
308 static void report_ok(const char *command
)
310 fprintf(stdout
, "%s: ok\n", command
);
314 static void parse_cmd_option(struct ref_transaction
*transaction UNUSED
,
315 const char *next
, const char *end UNUSED
)
318 if (skip_prefix(next
, "no-deref", &rest
) && *rest
== line_termination
)
319 update_flags
|= REF_NO_DEREF
;
321 die("option unknown: %s", next
);
324 static void parse_cmd_start(struct ref_transaction
*transaction UNUSED
,
325 const char *next
, const char *end UNUSED
)
327 if (*next
!= line_termination
)
328 die("start: extra input: %s", next
);
332 static void parse_cmd_prepare(struct ref_transaction
*transaction
,
333 const char *next
, const char *end UNUSED
)
335 struct strbuf error
= STRBUF_INIT
;
336 if (*next
!= line_termination
)
337 die("prepare: extra input: %s", next
);
338 if (ref_transaction_prepare(transaction
, &error
))
339 die("prepare: %s", error
.buf
);
340 report_ok("prepare");
343 static void parse_cmd_abort(struct ref_transaction
*transaction
,
344 const char *next
, const char *end UNUSED
)
346 struct strbuf error
= STRBUF_INIT
;
347 if (*next
!= line_termination
)
348 die("abort: extra input: %s", next
);
349 if (ref_transaction_abort(transaction
, &error
))
350 die("abort: %s", error
.buf
);
354 static void parse_cmd_commit(struct ref_transaction
*transaction
,
355 const char *next
, const char *end UNUSED
)
357 struct strbuf error
= STRBUF_INIT
;
358 if (*next
!= line_termination
)
359 die("commit: extra input: %s", next
);
360 if (ref_transaction_commit(transaction
, &error
))
361 die("commit: %s", error
.buf
);
363 ref_transaction_free(transaction
);
366 enum update_refs_state
{
367 /* Non-transactional state open for updates. */
369 /* A transaction has been started. */
371 /* References are locked and ready for commit */
372 UPDATE_REFS_PREPARED
,
373 /* Transaction has been committed or closed. */
377 static const struct parse_cmd
{
379 void (*fn
)(struct ref_transaction
*, const char *, const char *);
381 enum update_refs_state state
;
383 { "update", parse_cmd_update
, 3, UPDATE_REFS_OPEN
},
384 { "create", parse_cmd_create
, 2, UPDATE_REFS_OPEN
},
385 { "delete", parse_cmd_delete
, 2, UPDATE_REFS_OPEN
},
386 { "verify", parse_cmd_verify
, 2, UPDATE_REFS_OPEN
},
387 { "option", parse_cmd_option
, 1, UPDATE_REFS_OPEN
},
388 { "start", parse_cmd_start
, 0, UPDATE_REFS_STARTED
},
389 { "prepare", parse_cmd_prepare
, 0, UPDATE_REFS_PREPARED
},
390 { "abort", parse_cmd_abort
, 0, UPDATE_REFS_CLOSED
},
391 { "commit", parse_cmd_commit
, 0, UPDATE_REFS_CLOSED
},
394 static void update_refs_stdin(void)
396 struct strbuf input
= STRBUF_INIT
, err
= STRBUF_INIT
;
397 enum update_refs_state state
= UPDATE_REFS_OPEN
;
398 struct ref_transaction
*transaction
;
401 transaction
= ref_store_transaction_begin(get_main_ref_store(the_repository
),
406 /* Read each line dispatch its command */
407 while (!strbuf_getwholeline(&input
, stdin
, line_termination
)) {
408 const struct parse_cmd
*cmd
= NULL
;
410 if (*input
.buf
== line_termination
)
411 die("empty command in input");
412 else if (isspace(*input
.buf
))
413 die("whitespace before command: %s", input
.buf
);
415 for (i
= 0; i
< ARRAY_SIZE(command
); i
++) {
416 const char *prefix
= command
[i
].prefix
;
419 if (!starts_with(input
.buf
, prefix
))
423 * If the command has arguments, verify that it's
424 * followed by a space. Otherwise, it shall be followed
425 * by a line terminator.
427 c
= command
[i
].args
? ' ' : line_termination
;
428 if (input
.buf
[strlen(prefix
)] != c
)
435 die("unknown command: %s", input
.buf
);
438 * Read additional arguments if NUL-terminated. Do not raise an
439 * error in case there is an early EOF to let the command
440 * handle missing arguments with a proper error message.
442 for (j
= 1; line_termination
== '\0' && j
< cmd
->args
; j
++)
443 if (strbuf_appendwholeline(&input
, stdin
, line_termination
))
447 case UPDATE_REFS_OPEN
:
448 case UPDATE_REFS_STARTED
:
449 if (state
== UPDATE_REFS_STARTED
&& cmd
->state
== UPDATE_REFS_STARTED
)
450 die("cannot restart ongoing transaction");
451 /* Do not downgrade a transaction to a non-transaction. */
452 if (cmd
->state
>= state
)
455 case UPDATE_REFS_PREPARED
:
456 if (cmd
->state
!= UPDATE_REFS_CLOSED
)
457 die("prepared transactions can only be closed");
460 case UPDATE_REFS_CLOSED
:
461 if (cmd
->state
!= UPDATE_REFS_STARTED
)
462 die("transaction is closed");
465 * Open a new transaction if we're currently closed and
469 transaction
= ref_store_transaction_begin(get_main_ref_store(the_repository
),
477 cmd
->fn(transaction
, input
.buf
+ strlen(cmd
->prefix
) + !!cmd
->args
,
478 input
.buf
+ input
.len
);
482 case UPDATE_REFS_OPEN
:
483 /* Commit by default if no transaction was requested. */
484 if (ref_transaction_commit(transaction
, &err
))
486 ref_transaction_free(transaction
);
488 case UPDATE_REFS_STARTED
:
489 case UPDATE_REFS_PREPARED
:
490 /* If using a transaction, we want to abort it. */
491 if (ref_transaction_abort(transaction
, &err
))
494 case UPDATE_REFS_CLOSED
:
495 /* Otherwise no need to do anything, the transaction was closed already. */
499 strbuf_release(&err
);
500 strbuf_release(&input
);
503 int cmd_update_ref(int argc
, const char **argv
, const char *prefix
)
505 const char *refname
, *oldval
;
506 struct object_id oid
, oldoid
;
507 int delete = 0, no_deref
= 0, read_stdin
= 0, end_null
= 0;
508 int create_reflog
= 0;
509 struct option options
[] = {
510 OPT_STRING( 'm', NULL
, &msg
, N_("reason"), N_("reason of the update")),
511 OPT_BOOL('d', NULL
, &delete, N_("delete the reference")),
512 OPT_BOOL( 0 , "no-deref", &no_deref
,
513 N_("update <refname> not the one it points to")),
514 OPT_BOOL('z', NULL
, &end_null
, N_("stdin has NUL-terminated arguments")),
515 OPT_BOOL( 0 , "stdin", &read_stdin
, N_("read updates from stdin")),
516 OPT_BOOL( 0 , "create-reflog", &create_reflog
, N_("create a reflog")),
520 git_config(git_default_config
, NULL
);
521 argc
= parse_options(argc
, argv
, prefix
, options
, git_update_ref_usage
,
524 die("Refusing to perform update with empty message.");
526 create_reflog_flag
= create_reflog
? REF_FORCE_CREATE_REFLOG
: 0;
529 default_flags
= REF_NO_DEREF
;
530 update_flags
= default_flags
;
534 if (delete || argc
> 0)
535 usage_with_options(git_update_ref_usage
, options
);
537 line_termination
= '\0';
543 usage_with_options(git_update_ref_usage
, options
);
546 if (argc
< 1 || argc
> 2)
547 usage_with_options(git_update_ref_usage
, options
);
552 if (argc
< 2 || argc
> 3)
553 usage_with_options(git_update_ref_usage
, options
);
557 if (repo_get_oid(the_repository
, value
, &oid
))
558 die("%s: not a valid SHA1", value
);
564 * The empty string implies that the reference
565 * must not already exist:
568 else if (repo_get_oid(the_repository
, oldval
, &oldoid
))
569 die("%s: not a valid old SHA1", oldval
);
574 * For purposes of backwards compatibility, we treat
575 * NULL_SHA1 as "don't care" here:
577 return refs_delete_ref(get_main_ref_store(the_repository
),
579 (oldval
&& !is_null_oid(&oldoid
)) ? &oldoid
: NULL
,
582 return refs_update_ref(get_main_ref_store(the_repository
),
584 oldval
? &oldoid
: NULL
,
585 default_flags
| create_reflog_flag
,
586 UPDATE_REFS_DIE_ON_ERR
);