]>
Commit | Line | Data |
---|---|---|
66bf85a4 LT |
1 | #include "cache.h" |
2 | #include "refs.h" | |
854b4629 | 3 | #include "builtin.h" |
89942be6 | 4 | #include "parse-options.h" |
c750ba95 BK |
5 | #include "quote.h" |
6 | #include "argv-array.h" | |
66bf85a4 | 7 | |
89942be6 | 8 | static const char * const git_update_ref_usage[] = { |
82269505 NTND |
9 | N_("git update-ref [options] -d <refname> [<oldval>]"), |
10 | N_("git update-ref [options] <refname> <newval> [<oldval>]"), | |
c750ba95 | 11 | N_("git update-ref [options] --stdin [-z]"), |
89942be6 PH |
12 | NULL |
13 | }; | |
152da3df | 14 | |
c750ba95 BK |
15 | static char line_termination = '\n'; |
16 | static int update_flags; | |
db7516ab | 17 | static const char *msg; |
c750ba95 | 18 | |
697a4151 MH |
19 | /* |
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. | |
24 | */ | |
c750ba95 BK |
25 | static const char *parse_arg(const char *next, struct strbuf *arg) |
26 | { | |
697a4151 MH |
27 | if (*next == '"') { |
28 | const char *orig = next; | |
29 | ||
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); | |
34 | } else { | |
c750ba95 BK |
35 | while (*next && !isspace(*next)) |
36 | strbuf_addch(arg, *next++); | |
697a4151 | 37 | } |
c750ba95 | 38 | |
c750ba95 BK |
39 | return next; |
40 | } | |
41 | ||
e23d8435 | 42 | /* |
ed410e61 MH |
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 | |
48 | * is invalid. | |
e23d8435 | 49 | */ |
ed410e61 | 50 | static char *parse_refname(struct strbuf *input, const char **next) |
c750ba95 | 51 | { |
ed410e61 MH |
52 | struct strbuf ref = STRBUF_INIT; |
53 | ||
c750ba95 BK |
54 | if (line_termination) { |
55 | /* Without -z, use the next argument */ | |
ed410e61 | 56 | *next = parse_arg(*next, &ref); |
c750ba95 | 57 | } else { |
e23d8435 | 58 | /* With -z, use everything up to the next NUL */ |
ed410e61 MH |
59 | strbuf_addstr(&ref, *next); |
60 | *next += ref.len; | |
61 | } | |
62 | ||
63 | if (!ref.len) { | |
64 | strbuf_release(&ref); | |
65 | return NULL; | |
c750ba95 | 66 | } |
ed410e61 MH |
67 | |
68 | if (check_refname_format(ref.buf, REFNAME_ALLOW_ONELEVEL)) | |
69 | die("invalid ref format: %s", ref.buf); | |
70 | ||
71 | return strbuf_detach(&ref, NULL); | |
c750ba95 BK |
72 | } |
73 | ||
e23d8435 | 74 | /* |
3afcc463 MH |
75 | * The value being parsed is <oldvalue> (as opposed to <newvalue>; the |
76 | * difference affects which error messages are generated): | |
77 | */ | |
78 | #define PARSE_SHA1_OLD 0x01 | |
79 | ||
80 | /* | |
81 | * For backwards compatibility, accept an empty string for update's | |
82 | * <newvalue> in binary mode to be equivalent to specifying zeros. | |
83 | */ | |
84 | #define PARSE_SHA1_ALLOW_EMPTY 0x02 | |
85 | ||
86 | /* | |
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 | |
e23d8435 | 90 | * return 0. If there is no argument at all (not even the empty |
3afcc463 MH |
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. | |
e23d8435 | 94 | */ |
3afcc463 MH |
95 | static int parse_next_sha1(struct strbuf *input, const char **next, |
96 | unsigned char *sha1, | |
97 | const char *command, const char *refname, | |
98 | int flags) | |
c750ba95 | 99 | { |
3afcc463 MH |
100 | struct strbuf arg = STRBUF_INIT; |
101 | int ret = 0; | |
102 | ||
103 | if (*next == input->buf + input->len) | |
104 | goto eof; | |
105 | ||
c750ba95 BK |
106 | if (line_termination) { |
107 | /* Without -z, consume SP and use next argument */ | |
e23d8435 | 108 | if (!**next || **next == line_termination) |
3afcc463 | 109 | return 1; |
e23d8435 | 110 | if (**next != ' ') |
3afcc463 MH |
111 | die("%s %s: expected SP but got: %s", |
112 | command, refname, *next); | |
e23d8435 | 113 | (*next)++; |
3afcc463 MH |
114 | *next = parse_arg(*next, &arg); |
115 | if (arg.len) { | |
116 | if (get_sha1(arg.buf, sha1)) | |
117 | goto invalid; | |
118 | } else { | |
119 | /* Without -z, an empty value means all zeros: */ | |
120 | hashclr(sha1); | |
121 | } | |
c750ba95 BK |
122 | } else { |
123 | /* With -z, read the next NUL-terminated line */ | |
e23d8435 | 124 | if (**next) |
3afcc463 MH |
125 | die("%s %s: expected NUL but got: %s", |
126 | command, refname, *next); | |
e23d8435 MH |
127 | (*next)++; |
128 | if (*next == input->buf + input->len) | |
3afcc463 MH |
129 | goto eof; |
130 | strbuf_addstr(&arg, *next); | |
131 | *next += arg.len; | |
132 | ||
133 | if (arg.len) { | |
134 | if (get_sha1(arg.buf, sha1)) | |
135 | goto invalid; | |
136 | } else if (flags & PARSE_SHA1_ALLOW_EMPTY) { | |
137 | /* With -z, treat an empty value as all zeros: */ | |
1fbd5049 MH |
138 | warning("%s %s: missing <newvalue>, treating as zero", |
139 | command, refname); | |
3afcc463 MH |
140 | hashclr(sha1); |
141 | } else { | |
142 | /* | |
143 | * With -z, an empty non-required value means | |
144 | * unspecified: | |
145 | */ | |
146 | ret = 1; | |
147 | } | |
c750ba95 | 148 | } |
3afcc463 MH |
149 | |
150 | strbuf_release(&arg); | |
151 | ||
152 | return ret; | |
153 | ||
154 | invalid: | |
155 | die(flags & PARSE_SHA1_OLD ? | |
156 | "%s %s: invalid <oldvalue>: %s" : | |
157 | "%s %s: invalid <newvalue>: %s", | |
158 | command, refname, arg.buf); | |
159 | ||
160 | eof: | |
161 | die(flags & PARSE_SHA1_OLD ? | |
726f6916 MH |
162 | "%s %s: unexpected end of input when reading <oldvalue>" : |
163 | "%s %s: unexpected end of input when reading <newvalue>", | |
3afcc463 | 164 | command, refname); |
c750ba95 BK |
165 | } |
166 | ||
e23d8435 MH |
167 | |
168 | /* | |
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. | |
176 | */ | |
177 | ||
88499b29 JN |
178 | static const char *parse_cmd_update(struct ref_transaction *transaction, |
179 | struct strbuf *input, const char *next) | |
c750ba95 | 180 | { |
ab5ac957 | 181 | struct strbuf err = STRBUF_INIT; |
aebfc133 MH |
182 | char *refname; |
183 | unsigned char new_sha1[20]; | |
184 | unsigned char old_sha1[20]; | |
185 | int have_old; | |
c750ba95 | 186 | |
aebfc133 MH |
187 | refname = parse_refname(input, &next); |
188 | if (!refname) | |
f11b09fb | 189 | die("update: missing <ref>"); |
c750ba95 | 190 | |
aebfc133 | 191 | if (parse_next_sha1(input, &next, new_sha1, "update", refname, |
3afcc463 | 192 | PARSE_SHA1_ALLOW_EMPTY)) |
aebfc133 | 193 | die("update %s: missing <newvalue>", refname); |
c750ba95 | 194 | |
aebfc133 MH |
195 | have_old = !parse_next_sha1(input, &next, old_sha1, "update", refname, |
196 | PARSE_SHA1_OLD); | |
3afcc463 MH |
197 | |
198 | if (*next != line_termination) | |
aebfc133 MH |
199 | die("update %s: extra input: %s", refname, next); |
200 | ||
8e34800e | 201 | if (ref_transaction_update(transaction, refname, new_sha1, old_sha1, |
db7516ab | 202 | update_flags, have_old, msg, &err)) |
8e34800e | 203 | die("%s", err.buf); |
aebfc133 MH |
204 | |
205 | update_flags = 0; | |
206 | free(refname); | |
ab5ac957 | 207 | strbuf_release(&err); |
c750ba95 | 208 | |
e23d8435 | 209 | return next; |
c750ba95 BK |
210 | } |
211 | ||
88499b29 JN |
212 | static const char *parse_cmd_create(struct ref_transaction *transaction, |
213 | struct strbuf *input, const char *next) | |
c750ba95 | 214 | { |
ab5ac957 | 215 | struct strbuf err = STRBUF_INIT; |
aebfc133 MH |
216 | char *refname; |
217 | unsigned char new_sha1[20]; | |
c750ba95 | 218 | |
aebfc133 MH |
219 | refname = parse_refname(input, &next); |
220 | if (!refname) | |
f11b09fb | 221 | die("create: missing <ref>"); |
c750ba95 | 222 | |
aebfc133 MH |
223 | if (parse_next_sha1(input, &next, new_sha1, "create", refname, 0)) |
224 | die("create %s: missing <newvalue>", refname); | |
e23d8435 | 225 | |
aebfc133 MH |
226 | if (is_null_sha1(new_sha1)) |
227 | die("create %s: zero <newvalue>", refname); | |
c750ba95 | 228 | |
e23d8435 | 229 | if (*next != line_termination) |
aebfc133 MH |
230 | die("create %s: extra input: %s", refname, next); |
231 | ||
b416af5b | 232 | if (ref_transaction_create(transaction, refname, new_sha1, |
db7516ab | 233 | update_flags, msg, &err)) |
b416af5b | 234 | die("%s", err.buf); |
aebfc133 MH |
235 | |
236 | update_flags = 0; | |
237 | free(refname); | |
ab5ac957 | 238 | strbuf_release(&err); |
e23d8435 MH |
239 | |
240 | return next; | |
c750ba95 BK |
241 | } |
242 | ||
88499b29 JN |
243 | static const char *parse_cmd_delete(struct ref_transaction *transaction, |
244 | struct strbuf *input, const char *next) | |
c750ba95 | 245 | { |
ab5ac957 | 246 | struct strbuf err = STRBUF_INIT; |
aebfc133 MH |
247 | char *refname; |
248 | unsigned char old_sha1[20]; | |
249 | int have_old; | |
c750ba95 | 250 | |
aebfc133 MH |
251 | refname = parse_refname(input, &next); |
252 | if (!refname) | |
f11b09fb | 253 | die("delete: missing <ref>"); |
c750ba95 | 254 | |
aebfc133 MH |
255 | if (parse_next_sha1(input, &next, old_sha1, "delete", refname, |
256 | PARSE_SHA1_OLD)) { | |
257 | have_old = 0; | |
3afcc463 | 258 | } else { |
aebfc133 MH |
259 | if (is_null_sha1(old_sha1)) |
260 | die("delete %s: zero <oldvalue>", refname); | |
261 | have_old = 1; | |
3afcc463 | 262 | } |
c750ba95 | 263 | |
e23d8435 | 264 | if (*next != line_termination) |
aebfc133 MH |
265 | die("delete %s: extra input: %s", refname, next); |
266 | ||
8c8bdc0d | 267 | if (ref_transaction_delete(transaction, refname, old_sha1, |
db7516ab | 268 | update_flags, have_old, msg, &err)) |
8c8bdc0d | 269 | die("%s", err.buf); |
aebfc133 MH |
270 | |
271 | update_flags = 0; | |
272 | free(refname); | |
ab5ac957 | 273 | strbuf_release(&err); |
e23d8435 MH |
274 | |
275 | return next; | |
c750ba95 BK |
276 | } |
277 | ||
88499b29 JN |
278 | static const char *parse_cmd_verify(struct ref_transaction *transaction, |
279 | struct strbuf *input, const char *next) | |
c750ba95 | 280 | { |
ab5ac957 | 281 | struct strbuf err = STRBUF_INIT; |
aebfc133 MH |
282 | char *refname; |
283 | unsigned char new_sha1[20]; | |
284 | unsigned char old_sha1[20]; | |
c750ba95 | 285 | |
aebfc133 MH |
286 | refname = parse_refname(input, &next); |
287 | if (!refname) | |
f11b09fb | 288 | die("verify: missing <ref>"); |
c750ba95 | 289 | |
aebfc133 | 290 | if (parse_next_sha1(input, &next, old_sha1, "verify", refname, |
0e729c7e MH |
291 | PARSE_SHA1_OLD)) |
292 | hashclr(old_sha1); | |
293 | ||
294 | hashcpy(new_sha1, old_sha1); | |
c750ba95 | 295 | |
e23d8435 | 296 | if (*next != line_termination) |
aebfc133 MH |
297 | die("verify %s: extra input: %s", refname, next); |
298 | ||
8e34800e | 299 | if (ref_transaction_update(transaction, refname, new_sha1, old_sha1, |
0e729c7e | 300 | update_flags, 1, msg, &err)) |
8e34800e | 301 | die("%s", err.buf); |
aebfc133 MH |
302 | |
303 | update_flags = 0; | |
304 | free(refname); | |
ab5ac957 | 305 | strbuf_release(&err); |
e23d8435 MH |
306 | |
307 | return next; | |
c750ba95 BK |
308 | } |
309 | ||
e23d8435 | 310 | static const char *parse_cmd_option(struct strbuf *input, const char *next) |
c750ba95 | 311 | { |
e23d8435 | 312 | if (!strncmp(next, "no-deref", 8) && next[8] == line_termination) |
c750ba95 BK |
313 | update_flags |= REF_NODEREF; |
314 | else | |
315 | die("option unknown: %s", next); | |
e23d8435 | 316 | return next + 8; |
c750ba95 BK |
317 | } |
318 | ||
88499b29 | 319 | static void update_refs_stdin(struct ref_transaction *transaction) |
c750ba95 | 320 | { |
e23d8435 MH |
321 | struct strbuf input = STRBUF_INIT; |
322 | const char *next; | |
c750ba95 | 323 | |
e23d8435 MH |
324 | if (strbuf_read(&input, 0, 1000) < 0) |
325 | die_errno("could not read from stdin"); | |
326 | next = input.buf; | |
c750ba95 | 327 | /* Read each line dispatch its command */ |
e23d8435 MH |
328 | while (next < input.buf + input.len) { |
329 | if (*next == line_termination) | |
c750ba95 | 330 | die("empty command in input"); |
e23d8435 MH |
331 | else if (isspace(*next)) |
332 | die("whitespace before command: %s", next); | |
333 | else if (starts_with(next, "update ")) | |
88499b29 | 334 | next = parse_cmd_update(transaction, &input, next + 7); |
e23d8435 | 335 | else if (starts_with(next, "create ")) |
88499b29 | 336 | next = parse_cmd_create(transaction, &input, next + 7); |
e23d8435 | 337 | else if (starts_with(next, "delete ")) |
88499b29 | 338 | next = parse_cmd_delete(transaction, &input, next + 7); |
e23d8435 | 339 | else if (starts_with(next, "verify ")) |
88499b29 | 340 | next = parse_cmd_verify(transaction, &input, next + 7); |
e23d8435 MH |
341 | else if (starts_with(next, "option ")) |
342 | next = parse_cmd_option(&input, next + 7); | |
c750ba95 | 343 | else |
e23d8435 MH |
344 | die("unknown command: %s", next); |
345 | ||
346 | next++; | |
347 | } | |
c750ba95 | 348 | |
e23d8435 | 349 | strbuf_release(&input); |
c750ba95 BK |
350 | } |
351 | ||
a633fca0 | 352 | int cmd_update_ref(int argc, const char **argv, const char *prefix) |
66bf85a4 | 353 | { |
db7516ab | 354 | const char *refname, *oldval; |
5b16b090 | 355 | unsigned char sha1[20], oldsha1[20]; |
c750ba95 | 356 | int delete = 0, no_deref = 0, read_stdin = 0, end_null = 0, flags = 0; |
89942be6 | 357 | struct option options[] = { |
82269505 | 358 | OPT_STRING( 'm', NULL, &msg, N_("reason"), N_("reason of the update")), |
d5d09d47 SB |
359 | OPT_BOOL('d', NULL, &delete, N_("delete the reference")), |
360 | OPT_BOOL( 0 , "no-deref", &no_deref, | |
82269505 | 361 | N_("update <refname> not the one it points to")), |
9a86b899 JH |
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")), | |
89942be6 PH |
364 | OPT_END(), |
365 | }; | |
66bf85a4 | 366 | |
ef90d6d4 | 367 | git_config(git_default_config, NULL); |
37782920 SB |
368 | argc = parse_options(argc, argv, prefix, options, git_update_ref_usage, |
369 | 0); | |
89942be6 PH |
370 | if (msg && !*msg) |
371 | die("Refusing to perform update with empty message."); | |
5b16b090 | 372 | |
c750ba95 | 373 | if (read_stdin) { |
ab5ac957 | 374 | struct strbuf err = STRBUF_INIT; |
88499b29 | 375 | struct ref_transaction *transaction; |
ab5ac957 | 376 | |
93a644ea RS |
377 | transaction = ref_transaction_begin(&err); |
378 | if (!transaction) | |
379 | die("%s", err.buf); | |
c750ba95 BK |
380 | if (delete || no_deref || argc > 0) |
381 | usage_with_options(git_update_ref_usage, options); | |
382 | if (end_null) | |
383 | line_termination = '\0'; | |
88499b29 | 384 | update_refs_stdin(transaction); |
db7516ab | 385 | if (ref_transaction_commit(transaction, &err)) |
8bcd3748 | 386 | die("%s", err.buf); |
33f9fc59 | 387 | ref_transaction_free(transaction); |
93a644ea | 388 | strbuf_release(&err); |
8bcd3748 | 389 | return 0; |
c750ba95 BK |
390 | } |
391 | ||
392 | if (end_null) | |
393 | usage_with_options(git_update_ref_usage, options); | |
394 | ||
ac5409e4 | 395 | if (delete) { |
3fe8dce6 | 396 | if (argc < 1 || argc > 2) |
973a70ea KW |
397 | usage_with_options(git_update_ref_usage, options); |
398 | refname = argv[0]; | |
399 | oldval = argv[1]; | |
400 | } else { | |
401 | const char *value; | |
402 | if (argc < 2 || argc > 3) | |
89942be6 | 403 | usage_with_options(git_update_ref_usage, options); |
973a70ea KW |
404 | refname = argv[0]; |
405 | value = argv[1]; | |
406 | oldval = argv[2]; | |
407 | if (get_sha1(value, sha1)) | |
408 | die("%s: not a valid SHA1", value); | |
ac5409e4 JH |
409 | } |
410 | ||
973a70ea | 411 | hashclr(oldsha1); /* all-zero hash in case oldval is the empty string */ |
ac5409e4 | 412 | if (oldval && *oldval && get_sha1(oldval, oldsha1)) |
66bf85a4 LT |
413 | die("%s: not a valid old SHA1", oldval); |
414 | ||
569740bd MV |
415 | if (no_deref) |
416 | flags = REF_NODEREF; | |
973a70ea | 417 | if (delete) |
569740bd | 418 | return delete_ref(refname, oldval ? oldsha1 : NULL, flags); |
973a70ea KW |
419 | else |
420 | return update_ref(msg, refname, sha1, oldval ? oldsha1 : NULL, | |
f4124112 | 421 | flags, UPDATE_REFS_DIE_ON_ERR); |
66bf85a4 | 422 | } |