]>
Commit | Line | Data |
---|---|---|
66bf85a4 | 1 | #include "cache.h" |
b2141fc1 | 2 | #include "config.h" |
66bf85a4 | 3 | #include "refs.h" |
854b4629 | 4 | #include "builtin.h" |
89942be6 | 5 | #include "parse-options.h" |
c750ba95 BK |
6 | #include "quote.h" |
7 | #include "argv-array.h" | |
66bf85a4 | 8 | |
89942be6 | 9 | static const char * const git_update_ref_usage[] = { |
9c9b4f2f AH |
10 | N_("git update-ref [<options>] -d <refname> [<old-val>]"), |
11 | N_("git update-ref [<options>] <refname> <new-val> [<old-val>]"), | |
12 | N_("git update-ref [<options>] --stdin [-z]"), | |
89942be6 PH |
13 | NULL |
14 | }; | |
152da3df | 15 | |
c750ba95 | 16 | static char line_termination = '\n'; |
e4c34855 | 17 | static unsigned int update_flags; |
d345e9fb | 18 | static unsigned int default_flags; |
144c76fa | 19 | static unsigned create_reflog_flag; |
db7516ab | 20 | static const char *msg; |
c750ba95 | 21 | |
697a4151 MH |
22 | /* |
23 | * Parse one whitespace- or NUL-terminated, possibly C-quoted argument | |
24 | * and append the result to arg. Return a pointer to the terminator. | |
25 | * Die if there is an error in how the argument is C-quoted. This | |
26 | * function is only used if not -z. | |
27 | */ | |
c750ba95 BK |
28 | static const char *parse_arg(const char *next, struct strbuf *arg) |
29 | { | |
697a4151 MH |
30 | if (*next == '"') { |
31 | const char *orig = next; | |
32 | ||
33 | if (unquote_c_style(arg, next, &next)) | |
34 | die("badly quoted argument: %s", orig); | |
35 | if (*next && !isspace(*next)) | |
36 | die("unexpected character after quoted argument: %s", orig); | |
37 | } else { | |
c750ba95 BK |
38 | while (*next && !isspace(*next)) |
39 | strbuf_addch(arg, *next++); | |
697a4151 | 40 | } |
c750ba95 | 41 | |
c750ba95 BK |
42 | return next; |
43 | } | |
44 | ||
e23d8435 | 45 | /* |
ed410e61 MH |
46 | * Parse the reference name immediately after "command SP". If not |
47 | * -z, then handle C-quoting. Return a pointer to a newly allocated | |
48 | * string containing the name of the reference, or NULL if there was | |
49 | * an error. Update *next to point at the character that terminates | |
50 | * the argument. Die if C-quoting is malformed or the reference name | |
51 | * is invalid. | |
e23d8435 | 52 | */ |
ed410e61 | 53 | static char *parse_refname(struct strbuf *input, const char **next) |
c750ba95 | 54 | { |
ed410e61 MH |
55 | struct strbuf ref = STRBUF_INIT; |
56 | ||
c750ba95 BK |
57 | if (line_termination) { |
58 | /* Without -z, use the next argument */ | |
ed410e61 | 59 | *next = parse_arg(*next, &ref); |
c750ba95 | 60 | } else { |
e23d8435 | 61 | /* With -z, use everything up to the next NUL */ |
ed410e61 MH |
62 | strbuf_addstr(&ref, *next); |
63 | *next += ref.len; | |
64 | } | |
65 | ||
66 | if (!ref.len) { | |
67 | strbuf_release(&ref); | |
68 | return NULL; | |
c750ba95 | 69 | } |
ed410e61 MH |
70 | |
71 | if (check_refname_format(ref.buf, REFNAME_ALLOW_ONELEVEL)) | |
72 | die("invalid ref format: %s", ref.buf); | |
73 | ||
74 | return strbuf_detach(&ref, NULL); | |
c750ba95 BK |
75 | } |
76 | ||
e23d8435 | 77 | /* |
3afcc463 MH |
78 | * The value being parsed is <oldvalue> (as opposed to <newvalue>; the |
79 | * difference affects which error messages are generated): | |
80 | */ | |
81 | #define PARSE_SHA1_OLD 0x01 | |
82 | ||
83 | /* | |
84 | * For backwards compatibility, accept an empty string for update's | |
85 | * <newvalue> in binary mode to be equivalent to specifying zeros. | |
86 | */ | |
87 | #define PARSE_SHA1_ALLOW_EMPTY 0x02 | |
88 | ||
89 | /* | |
90 | * Parse an argument separator followed by the next argument, if any. | |
91 | * If there is an argument, convert it to a SHA-1, write it to sha1, | |
92 | * set *next to point at the character terminating the argument, and | |
e23d8435 | 93 | * return 0. If there is no argument at all (not even the empty |
3afcc463 MH |
94 | * string), return 1 and leave *next unchanged. If the value is |
95 | * provided but cannot be converted to a SHA-1, die. flags can | |
96 | * include PARSE_SHA1_OLD and/or PARSE_SHA1_ALLOW_EMPTY. | |
e23d8435 | 97 | */ |
a0bb5535 | 98 | static int parse_next_oid(struct strbuf *input, const char **next, |
99 | struct object_id *oid, | |
100 | const char *command, const char *refname, | |
101 | int flags) | |
c750ba95 | 102 | { |
3afcc463 MH |
103 | struct strbuf arg = STRBUF_INIT; |
104 | int ret = 0; | |
105 | ||
106 | if (*next == input->buf + input->len) | |
107 | goto eof; | |
108 | ||
c750ba95 BK |
109 | if (line_termination) { |
110 | /* Without -z, consume SP and use next argument */ | |
e23d8435 | 111 | if (!**next || **next == line_termination) |
3afcc463 | 112 | return 1; |
e23d8435 | 113 | if (**next != ' ') |
3afcc463 MH |
114 | die("%s %s: expected SP but got: %s", |
115 | command, refname, *next); | |
e23d8435 | 116 | (*next)++; |
3afcc463 MH |
117 | *next = parse_arg(*next, &arg); |
118 | if (arg.len) { | |
a0bb5535 | 119 | if (get_oid(arg.buf, oid)) |
3afcc463 MH |
120 | goto invalid; |
121 | } else { | |
122 | /* Without -z, an empty value means all zeros: */ | |
a0bb5535 | 123 | oidclr(oid); |
3afcc463 | 124 | } |
c750ba95 BK |
125 | } else { |
126 | /* With -z, read the next NUL-terminated line */ | |
e23d8435 | 127 | if (**next) |
3afcc463 MH |
128 | die("%s %s: expected NUL but got: %s", |
129 | command, refname, *next); | |
e23d8435 MH |
130 | (*next)++; |
131 | if (*next == input->buf + input->len) | |
3afcc463 MH |
132 | goto eof; |
133 | strbuf_addstr(&arg, *next); | |
134 | *next += arg.len; | |
135 | ||
136 | if (arg.len) { | |
a0bb5535 | 137 | if (get_oid(arg.buf, oid)) |
3afcc463 MH |
138 | goto invalid; |
139 | } else if (flags & PARSE_SHA1_ALLOW_EMPTY) { | |
140 | /* With -z, treat an empty value as all zeros: */ | |
1fbd5049 MH |
141 | warning("%s %s: missing <newvalue>, treating as zero", |
142 | command, refname); | |
a0bb5535 | 143 | oidclr(oid); |
3afcc463 MH |
144 | } else { |
145 | /* | |
146 | * With -z, an empty non-required value means | |
147 | * unspecified: | |
148 | */ | |
149 | ret = 1; | |
150 | } | |
c750ba95 | 151 | } |
3afcc463 MH |
152 | |
153 | strbuf_release(&arg); | |
154 | ||
155 | return ret; | |
156 | ||
157 | invalid: | |
158 | die(flags & PARSE_SHA1_OLD ? | |
159 | "%s %s: invalid <oldvalue>: %s" : | |
160 | "%s %s: invalid <newvalue>: %s", | |
161 | command, refname, arg.buf); | |
162 | ||
163 | eof: | |
164 | die(flags & PARSE_SHA1_OLD ? | |
726f6916 MH |
165 | "%s %s: unexpected end of input when reading <oldvalue>" : |
166 | "%s %s: unexpected end of input when reading <newvalue>", | |
3afcc463 | 167 | command, refname); |
c750ba95 BK |
168 | } |
169 | ||
e23d8435 MH |
170 | |
171 | /* | |
172 | * The following five parse_cmd_*() functions parse the corresponding | |
173 | * command. In each case, next points at the character following the | |
174 | * command name and the following space. They each return a pointer | |
175 | * to the character terminating the command, and die with an | |
176 | * explanatory message if there are any parsing problems. All of | |
177 | * these functions handle either text or binary format input, | |
178 | * depending on how line_termination is set. | |
179 | */ | |
180 | ||
88499b29 JN |
181 | static const char *parse_cmd_update(struct ref_transaction *transaction, |
182 | struct strbuf *input, const char *next) | |
c750ba95 | 183 | { |
ab5ac957 | 184 | struct strbuf err = STRBUF_INIT; |
aebfc133 | 185 | char *refname; |
a0bb5535 | 186 | struct object_id new_oid, old_oid; |
aebfc133 | 187 | int have_old; |
c750ba95 | 188 | |
aebfc133 MH |
189 | refname = parse_refname(input, &next); |
190 | if (!refname) | |
f11b09fb | 191 | die("update: missing <ref>"); |
c750ba95 | 192 | |
a0bb5535 | 193 | if (parse_next_oid(input, &next, &new_oid, "update", refname, |
194 | PARSE_SHA1_ALLOW_EMPTY)) | |
aebfc133 | 195 | die("update %s: missing <newvalue>", refname); |
c750ba95 | 196 | |
a0bb5535 | 197 | have_old = !parse_next_oid(input, &next, &old_oid, "update", refname, |
198 | PARSE_SHA1_OLD); | |
3afcc463 MH |
199 | |
200 | if (*next != line_termination) | |
aebfc133 MH |
201 | die("update %s: extra input: %s", refname, next); |
202 | ||
1d147bdf | 203 | if (ref_transaction_update(transaction, refname, |
89f3bbdd | 204 | &new_oid, have_old ? &old_oid : NULL, |
144c76fa DT |
205 | update_flags | create_reflog_flag, |
206 | msg, &err)) | |
8e34800e | 207 | die("%s", err.buf); |
aebfc133 | 208 | |
d345e9fb | 209 | update_flags = default_flags; |
aebfc133 | 210 | free(refname); |
ab5ac957 | 211 | strbuf_release(&err); |
c750ba95 | 212 | |
e23d8435 | 213 | return next; |
c750ba95 BK |
214 | } |
215 | ||
88499b29 JN |
216 | static const char *parse_cmd_create(struct ref_transaction *transaction, |
217 | struct strbuf *input, const char *next) | |
c750ba95 | 218 | { |
ab5ac957 | 219 | struct strbuf err = STRBUF_INIT; |
aebfc133 | 220 | char *refname; |
a0bb5535 | 221 | struct object_id new_oid; |
c750ba95 | 222 | |
aebfc133 MH |
223 | refname = parse_refname(input, &next); |
224 | if (!refname) | |
f11b09fb | 225 | die("create: missing <ref>"); |
c750ba95 | 226 | |
a0bb5535 | 227 | if (parse_next_oid(input, &next, &new_oid, "create", refname, 0)) |
aebfc133 | 228 | die("create %s: missing <newvalue>", refname); |
e23d8435 | 229 | |
a0bb5535 | 230 | if (is_null_oid(&new_oid)) |
aebfc133 | 231 | die("create %s: zero <newvalue>", refname); |
c750ba95 | 232 | |
e23d8435 | 233 | if (*next != line_termination) |
aebfc133 MH |
234 | die("create %s: extra input: %s", refname, next); |
235 | ||
89f3bbdd | 236 | if (ref_transaction_create(transaction, refname, &new_oid, |
144c76fa DT |
237 | update_flags | create_reflog_flag, |
238 | msg, &err)) | |
b416af5b | 239 | die("%s", err.buf); |
aebfc133 | 240 | |
d345e9fb | 241 | update_flags = default_flags; |
aebfc133 | 242 | free(refname); |
ab5ac957 | 243 | strbuf_release(&err); |
e23d8435 MH |
244 | |
245 | return next; | |
c750ba95 BK |
246 | } |
247 | ||
88499b29 JN |
248 | static const char *parse_cmd_delete(struct ref_transaction *transaction, |
249 | struct strbuf *input, const char *next) | |
c750ba95 | 250 | { |
ab5ac957 | 251 | struct strbuf err = STRBUF_INIT; |
aebfc133 | 252 | char *refname; |
a0bb5535 | 253 | struct object_id old_oid; |
aebfc133 | 254 | int have_old; |
c750ba95 | 255 | |
aebfc133 MH |
256 | refname = parse_refname(input, &next); |
257 | if (!refname) | |
f11b09fb | 258 | die("delete: missing <ref>"); |
c750ba95 | 259 | |
a0bb5535 | 260 | if (parse_next_oid(input, &next, &old_oid, "delete", refname, |
261 | PARSE_SHA1_OLD)) { | |
aebfc133 | 262 | have_old = 0; |
3afcc463 | 263 | } else { |
a0bb5535 | 264 | if (is_null_oid(&old_oid)) |
aebfc133 MH |
265 | die("delete %s: zero <oldvalue>", refname); |
266 | have_old = 1; | |
3afcc463 | 267 | } |
c750ba95 | 268 | |
e23d8435 | 269 | if (*next != line_termination) |
aebfc133 MH |
270 | die("delete %s: extra input: %s", refname, next); |
271 | ||
fb5a6bb6 | 272 | if (ref_transaction_delete(transaction, refname, |
89f3bbdd | 273 | have_old ? &old_oid : NULL, |
fb5a6bb6 | 274 | update_flags, msg, &err)) |
8c8bdc0d | 275 | die("%s", err.buf); |
aebfc133 | 276 | |
d345e9fb | 277 | update_flags = default_flags; |
aebfc133 | 278 | free(refname); |
ab5ac957 | 279 | strbuf_release(&err); |
e23d8435 MH |
280 | |
281 | return next; | |
c750ba95 BK |
282 | } |
283 | ||
88499b29 JN |
284 | static const char *parse_cmd_verify(struct ref_transaction *transaction, |
285 | struct strbuf *input, const char *next) | |
c750ba95 | 286 | { |
ab5ac957 | 287 | struct strbuf err = STRBUF_INIT; |
aebfc133 | 288 | char *refname; |
a0bb5535 | 289 | struct object_id old_oid; |
c750ba95 | 290 | |
aebfc133 MH |
291 | refname = parse_refname(input, &next); |
292 | if (!refname) | |
f11b09fb | 293 | die("verify: missing <ref>"); |
c750ba95 | 294 | |
a0bb5535 | 295 | if (parse_next_oid(input, &next, &old_oid, "verify", refname, |
296 | PARSE_SHA1_OLD)) | |
297 | oidclr(&old_oid); | |
0e729c7e | 298 | |
e23d8435 | 299 | if (*next != line_termination) |
aebfc133 MH |
300 | die("verify %s: extra input: %s", refname, next); |
301 | ||
89f3bbdd | 302 | if (ref_transaction_verify(transaction, refname, &old_oid, |
16180334 | 303 | update_flags, &err)) |
8e34800e | 304 | die("%s", err.buf); |
aebfc133 | 305 | |
d345e9fb | 306 | update_flags = default_flags; |
aebfc133 | 307 | free(refname); |
ab5ac957 | 308 | strbuf_release(&err); |
e23d8435 MH |
309 | |
310 | return next; | |
c750ba95 BK |
311 | } |
312 | ||
e23d8435 | 313 | static const char *parse_cmd_option(struct strbuf *input, const char *next) |
c750ba95 | 314 | { |
aee9be2e SG |
315 | const char *rest; |
316 | if (skip_prefix(next, "no-deref", &rest) && *rest == line_termination) | |
91774afc | 317 | update_flags |= REF_NO_DEREF; |
c750ba95 BK |
318 | else |
319 | die("option unknown: %s", next); | |
aee9be2e | 320 | return rest; |
c750ba95 BK |
321 | } |
322 | ||
88499b29 | 323 | static void update_refs_stdin(struct ref_transaction *transaction) |
c750ba95 | 324 | { |
e23d8435 MH |
325 | struct strbuf input = STRBUF_INIT; |
326 | const char *next; | |
c750ba95 | 327 | |
e23d8435 MH |
328 | if (strbuf_read(&input, 0, 1000) < 0) |
329 | die_errno("could not read from stdin"); | |
330 | next = input.buf; | |
c750ba95 | 331 | /* Read each line dispatch its command */ |
e23d8435 MH |
332 | while (next < input.buf + input.len) { |
333 | if (*next == line_termination) | |
c750ba95 | 334 | die("empty command in input"); |
e23d8435 MH |
335 | else if (isspace(*next)) |
336 | die("whitespace before command: %s", next); | |
aee9be2e SG |
337 | else if (skip_prefix(next, "update ", &next)) |
338 | next = parse_cmd_update(transaction, &input, next); | |
339 | else if (skip_prefix(next, "create ", &next)) | |
340 | next = parse_cmd_create(transaction, &input, next); | |
341 | else if (skip_prefix(next, "delete ", &next)) | |
342 | next = parse_cmd_delete(transaction, &input, next); | |
343 | else if (skip_prefix(next, "verify ", &next)) | |
344 | next = parse_cmd_verify(transaction, &input, next); | |
345 | else if (skip_prefix(next, "option ", &next)) | |
346 | next = parse_cmd_option(&input, next); | |
c750ba95 | 347 | else |
e23d8435 MH |
348 | die("unknown command: %s", next); |
349 | ||
350 | next++; | |
351 | } | |
c750ba95 | 352 | |
e23d8435 | 353 | strbuf_release(&input); |
c750ba95 BK |
354 | } |
355 | ||
a633fca0 | 356 | int cmd_update_ref(int argc, const char **argv, const char *prefix) |
66bf85a4 | 357 | { |
db7516ab | 358 | const char *refname, *oldval; |
a0bb5535 | 359 | struct object_id oid, oldoid; |
fec14ec3 | 360 | int delete = 0, no_deref = 0, read_stdin = 0, end_null = 0; |
144c76fa | 361 | int create_reflog = 0; |
89942be6 | 362 | struct option options[] = { |
82269505 | 363 | OPT_STRING( 'm', NULL, &msg, N_("reason"), N_("reason of the update")), |
d5d09d47 SB |
364 | OPT_BOOL('d', NULL, &delete, N_("delete the reference")), |
365 | OPT_BOOL( 0 , "no-deref", &no_deref, | |
82269505 | 366 | N_("update <refname> not the one it points to")), |
9a86b899 JH |
367 | OPT_BOOL('z', NULL, &end_null, N_("stdin has NUL-terminated arguments")), |
368 | OPT_BOOL( 0 , "stdin", &read_stdin, N_("read updates from stdin")), | |
98c32bd8 | 369 | OPT_BOOL( 0 , "create-reflog", &create_reflog, N_("create a reflog")), |
89942be6 PH |
370 | OPT_END(), |
371 | }; | |
66bf85a4 | 372 | |
ef90d6d4 | 373 | git_config(git_default_config, NULL); |
37782920 SB |
374 | argc = parse_options(argc, argv, prefix, options, git_update_ref_usage, |
375 | 0); | |
89942be6 PH |
376 | if (msg && !*msg) |
377 | die("Refusing to perform update with empty message."); | |
5b16b090 | 378 | |
144c76fa DT |
379 | create_reflog_flag = create_reflog ? REF_FORCE_CREATE_REFLOG : 0; |
380 | ||
d345e9fb EN |
381 | if (no_deref) { |
382 | default_flags = REF_NO_DEREF; | |
383 | update_flags = default_flags; | |
384 | } | |
385 | ||
c750ba95 | 386 | if (read_stdin) { |
ab5ac957 | 387 | struct strbuf err = STRBUF_INIT; |
88499b29 | 388 | struct ref_transaction *transaction; |
ab5ac957 | 389 | |
93a644ea RS |
390 | transaction = ref_transaction_begin(&err); |
391 | if (!transaction) | |
392 | die("%s", err.buf); | |
d345e9fb | 393 | if (delete || argc > 0) |
c750ba95 BK |
394 | usage_with_options(git_update_ref_usage, options); |
395 | if (end_null) | |
396 | line_termination = '\0'; | |
88499b29 | 397 | update_refs_stdin(transaction); |
db7516ab | 398 | if (ref_transaction_commit(transaction, &err)) |
8bcd3748 | 399 | die("%s", err.buf); |
33f9fc59 | 400 | ref_transaction_free(transaction); |
93a644ea | 401 | strbuf_release(&err); |
8bcd3748 | 402 | return 0; |
c750ba95 BK |
403 | } |
404 | ||
405 | if (end_null) | |
406 | usage_with_options(git_update_ref_usage, options); | |
407 | ||
ac5409e4 | 408 | if (delete) { |
3fe8dce6 | 409 | if (argc < 1 || argc > 2) |
973a70ea KW |
410 | usage_with_options(git_update_ref_usage, options); |
411 | refname = argv[0]; | |
412 | oldval = argv[1]; | |
413 | } else { | |
414 | const char *value; | |
415 | if (argc < 2 || argc > 3) | |
89942be6 | 416 | usage_with_options(git_update_ref_usage, options); |
973a70ea KW |
417 | refname = argv[0]; |
418 | value = argv[1]; | |
419 | oldval = argv[2]; | |
a0bb5535 | 420 | if (get_oid(value, &oid)) |
973a70ea | 421 | die("%s: not a valid SHA1", value); |
ac5409e4 JH |
422 | } |
423 | ||
e2991c80 MH |
424 | if (oldval) { |
425 | if (!*oldval) | |
426 | /* | |
427 | * The empty string implies that the reference | |
428 | * must not already exist: | |
429 | */ | |
a0bb5535 | 430 | oidclr(&oldoid); |
431 | else if (get_oid(oldval, &oldoid)) | |
e2991c80 MH |
432 | die("%s: not a valid old SHA1", oldval); |
433 | } | |
66bf85a4 | 434 | |
973a70ea | 435 | if (delete) |
1c03c4d3 MH |
436 | /* |
437 | * For purposes of backwards compatibility, we treat | |
438 | * NULL_SHA1 as "don't care" here: | |
439 | */ | |
de922669 | 440 | return delete_ref(msg, refname, |
2616a5e5 | 441 | (oldval && !is_null_oid(&oldoid)) ? &oldoid : NULL, |
d345e9fb | 442 | default_flags); |
973a70ea | 443 | else |
ae077771 | 444 | return update_ref(msg, refname, &oid, oldval ? &oldoid : NULL, |
d345e9fb | 445 | default_flags | create_reflog_flag, |
144c76fa | 446 | UPDATE_REFS_DIE_ON_ERR); |
66bf85a4 | 447 | } |