Change check_ref_format() to take a flags argument
[git/git.git] / builtin / tag.c
1 /*
2 * Builtin "git tag"
3 *
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5 * Carlos Rica <jasampler@gmail.com>
6 * Based on git-tag.sh and mktag.c by Linus Torvalds.
7 */
8
9 #include "cache.h"
10 #include "builtin.h"
11 #include "refs.h"
12 #include "tag.h"
13 #include "run-command.h"
14 #include "parse-options.h"
15 #include "diff.h"
16 #include "revision.h"
17
18 static const char * const git_tag_usage[] = {
19 "git tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]",
20 "git tag -d <tagname>...",
21 "git tag -l [-n[<num>]] [<pattern>...]",
22 "git tag -v <tagname>...",
23 NULL
24 };
25
26 static char signingkey[1000];
27
28 struct tag_filter {
29 const char **patterns;
30 int lines;
31 struct commit_list *with_commit;
32 };
33
34 static int match_pattern(const char **patterns, const char *ref)
35 {
36 /* no pattern means match everything */
37 if (!*patterns)
38 return 1;
39 for (; *patterns; patterns++)
40 if (!fnmatch(*patterns, ref, 0))
41 return 1;
42 return 0;
43 }
44
45 static int in_commit_list(const struct commit_list *want, struct commit *c)
46 {
47 for (; want; want = want->next)
48 if (!hashcmp(want->item->object.sha1, c->object.sha1))
49 return 1;
50 return 0;
51 }
52
53 static int contains_recurse(struct commit *candidate,
54 const struct commit_list *want)
55 {
56 struct commit_list *p;
57
58 /* was it previously marked as containing a want commit? */
59 if (candidate->object.flags & TMP_MARK)
60 return 1;
61 /* or marked as not possibly containing a want commit? */
62 if (candidate->object.flags & UNINTERESTING)
63 return 0;
64 /* or are we it? */
65 if (in_commit_list(want, candidate))
66 return 1;
67
68 if (parse_commit(candidate) < 0)
69 return 0;
70
71 /* Otherwise recurse and mark ourselves for future traversals. */
72 for (p = candidate->parents; p; p = p->next) {
73 if (contains_recurse(p->item, want)) {
74 candidate->object.flags |= TMP_MARK;
75 return 1;
76 }
77 }
78 candidate->object.flags |= UNINTERESTING;
79 return 0;
80 }
81
82 static int contains(struct commit *candidate, const struct commit_list *want)
83 {
84 return contains_recurse(candidate, want);
85 }
86
87 static int show_reference(const char *refname, const unsigned char *sha1,
88 int flag, void *cb_data)
89 {
90 struct tag_filter *filter = cb_data;
91
92 if (match_pattern(filter->patterns, refname)) {
93 int i;
94 unsigned long size;
95 enum object_type type;
96 char *buf, *sp, *eol;
97 size_t len;
98
99 if (filter->with_commit) {
100 struct commit *commit;
101
102 commit = lookup_commit_reference_gently(sha1, 1);
103 if (!commit)
104 return 0;
105 if (!contains(commit, filter->with_commit))
106 return 0;
107 }
108
109 if (!filter->lines) {
110 printf("%s\n", refname);
111 return 0;
112 }
113 printf("%-15s ", refname);
114
115 buf = read_sha1_file(sha1, &type, &size);
116 if (!buf || !size)
117 return 0;
118
119 /* skip header */
120 sp = strstr(buf, "\n\n");
121 if (!sp) {
122 free(buf);
123 return 0;
124 }
125 /* only take up to "lines" lines, and strip the signature */
126 size = parse_signature(buf, size);
127 for (i = 0, sp += 2;
128 i < filter->lines && sp < buf + size;
129 i++) {
130 if (i)
131 printf("\n ");
132 eol = memchr(sp, '\n', size - (sp - buf));
133 len = eol ? eol - sp : size - (sp - buf);
134 fwrite(sp, len, 1, stdout);
135 if (!eol)
136 break;
137 sp = eol + 1;
138 }
139 putchar('\n');
140 free(buf);
141 }
142
143 return 0;
144 }
145
146 static int list_tags(const char **patterns, int lines,
147 struct commit_list *with_commit)
148 {
149 struct tag_filter filter;
150
151 filter.patterns = patterns;
152 filter.lines = lines;
153 filter.with_commit = with_commit;
154
155 for_each_tag_ref(show_reference, (void *) &filter);
156
157 return 0;
158 }
159
160 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
161 const unsigned char *sha1);
162
163 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
164 {
165 const char **p;
166 char ref[PATH_MAX];
167 int had_error = 0;
168 unsigned char sha1[20];
169
170 for (p = argv; *p; p++) {
171 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
172 >= sizeof(ref)) {
173 error(_("tag name too long: %.*s..."), 50, *p);
174 had_error = 1;
175 continue;
176 }
177 if (!resolve_ref(ref, sha1, 1, NULL)) {
178 error(_("tag '%s' not found."), *p);
179 had_error = 1;
180 continue;
181 }
182 if (fn(*p, ref, sha1))
183 had_error = 1;
184 }
185 return had_error;
186 }
187
188 static int delete_tag(const char *name, const char *ref,
189 const unsigned char *sha1)
190 {
191 if (delete_ref(ref, sha1, 0))
192 return 1;
193 printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
194 return 0;
195 }
196
197 static int verify_tag(const char *name, const char *ref,
198 const unsigned char *sha1)
199 {
200 const char *argv_verify_tag[] = {"verify-tag",
201 "-v", "SHA1_HEX", NULL};
202 argv_verify_tag[2] = sha1_to_hex(sha1);
203
204 if (run_command_v_opt(argv_verify_tag, RUN_GIT_CMD))
205 return error(_("could not verify the tag '%s'"), name);
206 return 0;
207 }
208
209 static int do_sign(struct strbuf *buffer)
210 {
211 struct child_process gpg;
212 const char *args[4];
213 char *bracket;
214 int len;
215 int i, j;
216
217 if (!*signingkey) {
218 if (strlcpy(signingkey, git_committer_info(IDENT_ERROR_ON_NO_NAME),
219 sizeof(signingkey)) > sizeof(signingkey) - 1)
220 return error(_("committer info too long."));
221 bracket = strchr(signingkey, '>');
222 if (bracket)
223 bracket[1] = '\0';
224 }
225
226 /* When the username signingkey is bad, program could be terminated
227 * because gpg exits without reading and then write gets SIGPIPE. */
228 signal(SIGPIPE, SIG_IGN);
229
230 memset(&gpg, 0, sizeof(gpg));
231 gpg.argv = args;
232 gpg.in = -1;
233 gpg.out = -1;
234 args[0] = "gpg";
235 args[1] = "-bsau";
236 args[2] = signingkey;
237 args[3] = NULL;
238
239 if (start_command(&gpg))
240 return error(_("could not run gpg."));
241
242 if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
243 close(gpg.in);
244 close(gpg.out);
245 finish_command(&gpg);
246 return error(_("gpg did not accept the tag data"));
247 }
248 close(gpg.in);
249 len = strbuf_read(buffer, gpg.out, 1024);
250 close(gpg.out);
251
252 if (finish_command(&gpg) || !len || len < 0)
253 return error(_("gpg failed to sign the tag"));
254
255 /* Strip CR from the line endings, in case we are on Windows. */
256 for (i = j = 0; i < buffer->len; i++)
257 if (buffer->buf[i] != '\r') {
258 if (i != j)
259 buffer->buf[j] = buffer->buf[i];
260 j++;
261 }
262 strbuf_setlen(buffer, j);
263
264 return 0;
265 }
266
267 static const char tag_template[] =
268 N_("\n"
269 "#\n"
270 "# Write a tag message\n"
271 "#\n");
272
273 static void set_signingkey(const char *value)
274 {
275 if (strlcpy(signingkey, value, sizeof(signingkey)) >= sizeof(signingkey))
276 die(_("signing key value too long (%.10s...)"), value);
277 }
278
279 static int git_tag_config(const char *var, const char *value, void *cb)
280 {
281 if (!strcmp(var, "user.signingkey")) {
282 if (!value)
283 return config_error_nonbool(var);
284 set_signingkey(value);
285 return 0;
286 }
287
288 return git_default_config(var, value, cb);
289 }
290
291 static void write_tag_body(int fd, const unsigned char *sha1)
292 {
293 unsigned long size;
294 enum object_type type;
295 char *buf, *sp;
296
297 buf = read_sha1_file(sha1, &type, &size);
298 if (!buf)
299 return;
300 /* skip header */
301 sp = strstr(buf, "\n\n");
302
303 if (!sp || !size || type != OBJ_TAG) {
304 free(buf);
305 return;
306 }
307 sp += 2; /* skip the 2 LFs */
308 write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
309
310 free(buf);
311 }
312
313 static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
314 {
315 if (sign && do_sign(buf) < 0)
316 return error(_("unable to sign the tag"));
317 if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
318 return error(_("unable to write tag file"));
319 return 0;
320 }
321
322 static void create_tag(const unsigned char *object, const char *tag,
323 struct strbuf *buf, int message, int sign,
324 unsigned char *prev, unsigned char *result)
325 {
326 enum object_type type;
327 char header_buf[1024];
328 int header_len;
329 char *path = NULL;
330
331 type = sha1_object_info(object, NULL);
332 if (type <= OBJ_NONE)
333 die(_("bad object type."));
334
335 header_len = snprintf(header_buf, sizeof(header_buf),
336 "object %s\n"
337 "type %s\n"
338 "tag %s\n"
339 "tagger %s\n\n",
340 sha1_to_hex(object),
341 typename(type),
342 tag,
343 git_committer_info(IDENT_ERROR_ON_NO_NAME));
344
345 if (header_len > sizeof(header_buf) - 1)
346 die(_("tag header too big."));
347
348 if (!message) {
349 int fd;
350
351 /* write the template message before editing: */
352 path = git_pathdup("TAG_EDITMSG");
353 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
354 if (fd < 0)
355 die_errno(_("could not create file '%s'"), path);
356
357 if (!is_null_sha1(prev))
358 write_tag_body(fd, prev);
359 else
360 write_or_die(fd, _(tag_template), strlen(_(tag_template)));
361 close(fd);
362
363 if (launch_editor(path, buf, NULL)) {
364 fprintf(stderr,
365 _("Please supply the message using either -m or -F option.\n"));
366 exit(1);
367 }
368 }
369
370 stripspace(buf, 1);
371
372 if (!message && !buf->len)
373 die(_("no tag message?"));
374
375 strbuf_insert(buf, 0, header_buf, header_len);
376
377 if (build_tag_object(buf, sign, result) < 0) {
378 if (path)
379 fprintf(stderr, _("The tag message has been left in %s\n"),
380 path);
381 exit(128);
382 }
383 if (path) {
384 unlink_or_warn(path);
385 free(path);
386 }
387 }
388
389 struct msg_arg {
390 int given;
391 struct strbuf buf;
392 };
393
394 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
395 {
396 struct msg_arg *msg = opt->value;
397
398 if (!arg)
399 return -1;
400 if (msg->buf.len)
401 strbuf_addstr(&(msg->buf), "\n\n");
402 strbuf_addstr(&(msg->buf), arg);
403 msg->given = 1;
404 return 0;
405 }
406
407 static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
408 {
409 if (name[0] == '-')
410 return -1;
411
412 strbuf_reset(sb);
413 strbuf_addf(sb, "refs/tags/%s", name);
414
415 return check_refname_format(sb->buf, 0);
416 }
417
418 int cmd_tag(int argc, const char **argv, const char *prefix)
419 {
420 struct strbuf buf = STRBUF_INIT;
421 struct strbuf ref = STRBUF_INIT;
422 unsigned char object[20], prev[20];
423 const char *object_ref, *tag;
424 struct ref_lock *lock;
425
426 int annotate = 0, sign = 0, force = 0, lines = -1,
427 list = 0, delete = 0, verify = 0;
428 const char *msgfile = NULL, *keyid = NULL;
429 struct msg_arg msg = { 0, STRBUF_INIT };
430 struct commit_list *with_commit = NULL;
431 struct option options[] = {
432 OPT_BOOLEAN('l', NULL, &list, "list tag names"),
433 { OPTION_INTEGER, 'n', NULL, &lines, "n",
434 "print <n> lines of each tag message",
435 PARSE_OPT_OPTARG, NULL, 1 },
436 OPT_BOOLEAN('d', NULL, &delete, "delete tags"),
437 OPT_BOOLEAN('v', NULL, &verify, "verify tags"),
438
439 OPT_GROUP("Tag creation options"),
440 OPT_BOOLEAN('a', NULL, &annotate,
441 "annotated tag, needs a message"),
442 OPT_CALLBACK('m', NULL, &msg, "message",
443 "tag message", parse_msg_arg),
444 OPT_FILENAME('F', NULL, &msgfile, "read message from file"),
445 OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
446 OPT_STRING('u', NULL, &keyid, "key-id",
447 "use another key to sign the tag"),
448 OPT__FORCE(&force, "replace the tag if exists"),
449
450 OPT_GROUP("Tag listing options"),
451 {
452 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
453 "print only tags that contain the commit",
454 PARSE_OPT_LASTARG_DEFAULT,
455 parse_opt_with_commit, (intptr_t)"HEAD",
456 },
457 OPT_END()
458 };
459
460 git_config(git_tag_config, NULL);
461
462 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
463
464 if (keyid) {
465 sign = 1;
466 set_signingkey(keyid);
467 }
468 if (sign)
469 annotate = 1;
470 if (argc == 0 && !(delete || verify))
471 list = 1;
472
473 if ((annotate || msg.given || msgfile || force) &&
474 (list || delete || verify))
475 usage_with_options(git_tag_usage, options);
476
477 if (list + delete + verify > 1)
478 usage_with_options(git_tag_usage, options);
479 if (list)
480 return list_tags(argv, lines == -1 ? 0 : lines,
481 with_commit);
482 if (lines != -1)
483 die(_("-n option is only allowed with -l."));
484 if (with_commit)
485 die(_("--contains option is only allowed with -l."));
486 if (delete)
487 return for_each_tag_name(argv, delete_tag);
488 if (verify)
489 return for_each_tag_name(argv, verify_tag);
490
491 if (msg.given || msgfile) {
492 if (msg.given && msgfile)
493 die(_("only one -F or -m option is allowed."));
494 annotate = 1;
495 if (msg.given)
496 strbuf_addbuf(&buf, &(msg.buf));
497 else {
498 if (!strcmp(msgfile, "-")) {
499 if (strbuf_read(&buf, 0, 1024) < 0)
500 die_errno(_("cannot read '%s'"), msgfile);
501 } else {
502 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
503 die_errno(_("could not open or read '%s'"),
504 msgfile);
505 }
506 }
507 }
508
509 tag = argv[0];
510
511 object_ref = argc == 2 ? argv[1] : "HEAD";
512 if (argc > 2)
513 die(_("too many params"));
514
515 if (get_sha1(object_ref, object))
516 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
517
518 if (strbuf_check_tag_ref(&ref, tag))
519 die(_("'%s' is not a valid tag name."), tag);
520
521 if (!resolve_ref(ref.buf, prev, 1, NULL))
522 hashclr(prev);
523 else if (!force)
524 die(_("tag '%s' already exists"), tag);
525
526 if (annotate)
527 create_tag(object, tag, &buf, msg.given || msgfile,
528 sign, prev, object);
529
530 lock = lock_any_ref_for_update(ref.buf, prev, 0);
531 if (!lock)
532 die(_("%s: cannot lock the ref"), ref.buf);
533 if (write_ref_sha1(lock, object, NULL) < 0)
534 die(_("%s: cannot update the ref"), ref.buf);
535 if (force && hashcmp(prev, object))
536 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
537
538 strbuf_release(&buf);
539 strbuf_release(&ref);
540 return 0;
541 }