Split GPG interface into its own helper library
[git/git.git] / builtin / tag.c
CommitLineData
62e09ce9
CR
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"
39686585 14#include "parse-options.h"
ffc4b801
JK
15#include "diff.h"
16#include "revision.h"
2f47eae2 17#include "gpg-interface.h"
39686585
CR
18
19static const char * const git_tag_usage[] = {
1b1dd23f
SB
20 "git tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]",
21 "git tag -d <tagname>...",
588d0e83 22 "git tag -l [-n[<num>]] [<pattern>...]",
1b1dd23f 23 "git tag -v <tagname>...",
39686585
CR
24 NULL
25};
62e09ce9 26
62e09ce9 27struct tag_filter {
588d0e83 28 const char **patterns;
62e09ce9 29 int lines;
32c35cfb 30 struct commit_list *with_commit;
62e09ce9
CR
31};
32
588d0e83
JK
33static int match_pattern(const char **patterns, const char *ref)
34{
35 /* no pattern means match everything */
36 if (!*patterns)
37 return 1;
38 for (; *patterns; patterns++)
39 if (!fnmatch(*patterns, ref, 0))
40 return 1;
41 return 0;
42}
43
ffc4b801
JK
44static int in_commit_list(const struct commit_list *want, struct commit *c)
45{
46 for (; want; want = want->next)
47 if (!hashcmp(want->item->object.sha1, c->object.sha1))
48 return 1;
49 return 0;
50}
51
52static int contains_recurse(struct commit *candidate,
c6d72c49 53 const struct commit_list *want)
ffc4b801
JK
54{
55 struct commit_list *p;
56
57 /* was it previously marked as containing a want commit? */
58 if (candidate->object.flags & TMP_MARK)
59 return 1;
60 /* or marked as not possibly containing a want commit? */
61 if (candidate->object.flags & UNINTERESTING)
62 return 0;
63 /* or are we it? */
64 if (in_commit_list(want, candidate))
65 return 1;
66
67 if (parse_commit(candidate) < 0)
68 return 0;
69
70 /* Otherwise recurse and mark ourselves for future traversals. */
71 for (p = candidate->parents; p; p = p->next) {
c6d72c49 72 if (contains_recurse(p->item, want)) {
ffc4b801
JK
73 candidate->object.flags |= TMP_MARK;
74 return 1;
75 }
76 }
77 candidate->object.flags |= UNINTERESTING;
78 return 0;
79}
80
81static int contains(struct commit *candidate, const struct commit_list *want)
82{
c6d72c49 83 return contains_recurse(candidate, want);
ffc4b801
JK
84}
85
62e09ce9
CR
86static int show_reference(const char *refname, const unsigned char *sha1,
87 int flag, void *cb_data)
88{
89 struct tag_filter *filter = cb_data;
90
588d0e83 91 if (match_pattern(filter->patterns, refname)) {
62e09ce9
CR
92 int i;
93 unsigned long size;
94 enum object_type type;
95 char *buf, *sp, *eol;
96 size_t len;
97
32c35cfb
JG
98 if (filter->with_commit) {
99 struct commit *commit;
100
101 commit = lookup_commit_reference_gently(sha1, 1);
102 if (!commit)
103 return 0;
ffc4b801 104 if (!contains(commit, filter->with_commit))
32c35cfb
JG
105 return 0;
106 }
107
62e09ce9
CR
108 if (!filter->lines) {
109 printf("%s\n", refname);
110 return 0;
111 }
112 printf("%-15s ", refname);
113
e1f14cce
MH
114 buf = read_sha1_file(sha1, &type, &size);
115 if (!buf || !size)
62e09ce9 116 return 0;
e1f14cce
MH
117
118 /* skip header */
119 sp = strstr(buf, "\n\n");
120 if (!sp) {
e317cfaf
CR
121 free(buf);
122 return 0;
123 }
62e09ce9 124 /* only take up to "lines" lines, and strip the signature */
81536b2d 125 size = parse_signature(buf, size);
e317cfaf 126 for (i = 0, sp += 2;
81536b2d 127 i < filter->lines && sp < buf + size;
62e09ce9
CR
128 i++) {
129 if (i)
130 printf("\n ");
131 eol = memchr(sp, '\n', size - (sp - buf));
132 len = eol ? eol - sp : size - (sp - buf);
133 fwrite(sp, len, 1, stdout);
134 if (!eol)
135 break;
136 sp = eol + 1;
137 }
138 putchar('\n');
139 free(buf);
140 }
141
142 return 0;
143}
144
588d0e83 145static int list_tags(const char **patterns, int lines,
32c35cfb 146 struct commit_list *with_commit)
62e09ce9
CR
147{
148 struct tag_filter filter;
62e09ce9 149
588d0e83 150 filter.patterns = patterns;
62e09ce9 151 filter.lines = lines;
32c35cfb 152 filter.with_commit = with_commit;
62e09ce9
CR
153
154 for_each_tag_ref(show_reference, (void *) &filter);
155
62e09ce9
CR
156 return 0;
157}
158
e317cfaf 159typedef int (*each_tag_name_fn)(const char *name, const char *ref,
62e09ce9
CR
160 const unsigned char *sha1);
161
e317cfaf 162static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
62e09ce9
CR
163{
164 const char **p;
165 char ref[PATH_MAX];
166 int had_error = 0;
167 unsigned char sha1[20];
168
169 for (p = argv; *p; p++) {
170 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
171 >= sizeof(ref)) {
d08ebf99 172 error(_("tag name too long: %.*s..."), 50, *p);
62e09ce9
CR
173 had_error = 1;
174 continue;
175 }
176 if (!resolve_ref(ref, sha1, 1, NULL)) {
d08ebf99 177 error(_("tag '%s' not found."), *p);
62e09ce9
CR
178 had_error = 1;
179 continue;
180 }
181 if (fn(*p, ref, sha1))
182 had_error = 1;
183 }
184 return had_error;
185}
186
187static int delete_tag(const char *name, const char *ref,
188 const unsigned char *sha1)
189{
eca35a25 190 if (delete_ref(ref, sha1, 0))
62e09ce9 191 return 1;
d08ebf99 192 printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
62e09ce9
CR
193 return 0;
194}
195
196static int verify_tag(const char *name, const char *ref,
197 const unsigned char *sha1)
198{
a6ccbbdb 199 const char *argv_verify_tag[] = {"verify-tag",
62e09ce9
CR
200 "-v", "SHA1_HEX", NULL};
201 argv_verify_tag[2] = sha1_to_hex(sha1);
202
a6ccbbdb 203 if (run_command_v_opt(argv_verify_tag, RUN_GIT_CMD))
d08ebf99 204 return error(_("could not verify the tag '%s'"), name);
62e09ce9
CR
205 return 0;
206}
207
fd17f5b5 208static int do_sign(struct strbuf *buffer)
62e09ce9 209{
2f47eae2 210 return sign_buffer(buffer, buffer, get_signing_key());
62e09ce9
CR
211}
212
213static const char tag_template[] =
7fbff25a 214 N_("\n"
62e09ce9
CR
215 "#\n"
216 "# Write a tag message\n"
7fbff25a 217 "#\n");
62e09ce9 218
ef90d6d4 219static int git_tag_config(const char *var, const char *value, void *cb)
62e09ce9 220{
2f47eae2
JH
221 int status = git_gpg_config(var, value, cb);
222 if (status)
223 return status;
ef90d6d4 224 return git_default_config(var, value, cb);
62e09ce9
CR
225}
226
bab8118a
MH
227static void write_tag_body(int fd, const unsigned char *sha1)
228{
229 unsigned long size;
230 enum object_type type;
e10dfb62 231 char *buf, *sp;
bab8118a
MH
232
233 buf = read_sha1_file(sha1, &type, &size);
234 if (!buf)
235 return;
236 /* skip header */
237 sp = strstr(buf, "\n\n");
238
239 if (!sp || !size || type != OBJ_TAG) {
240 free(buf);
241 return;
242 }
243 sp += 2; /* skip the 2 LFs */
e10dfb62 244 write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
bab8118a
MH
245
246 free(buf);
247}
248
3927bbe9
JK
249static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
250{
251 if (sign && do_sign(buf) < 0)
d08ebf99 252 return error(_("unable to sign the tag"));
3927bbe9 253 if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
d08ebf99 254 return error(_("unable to write tag file"));
3927bbe9
JK
255 return 0;
256}
257
62e09ce9 258static void create_tag(const unsigned char *object, const char *tag,
fd17f5b5 259 struct strbuf *buf, int message, int sign,
bd46c9a9 260 unsigned char *prev, unsigned char *result)
62e09ce9
CR
261{
262 enum object_type type;
fd17f5b5
PH
263 char header_buf[1024];
264 int header_len;
3927bbe9 265 char *path = NULL;
62e09ce9
CR
266
267 type = sha1_object_info(object, NULL);
e317cfaf 268 if (type <= OBJ_NONE)
d08ebf99 269 die(_("bad object type."));
62e09ce9
CR
270
271 header_len = snprintf(header_buf, sizeof(header_buf),
272 "object %s\n"
273 "type %s\n"
274 "tag %s\n"
275 "tagger %s\n\n",
276 sha1_to_hex(object),
277 typename(type),
278 tag,
774751a8 279 git_committer_info(IDENT_ERROR_ON_NO_NAME));
62e09ce9 280
e317cfaf 281 if (header_len > sizeof(header_buf) - 1)
d08ebf99 282 die(_("tag header too big."));
62e09ce9
CR
283
284 if (!message) {
62e09ce9
CR
285 int fd;
286
287 /* write the template message before editing: */
a4f34cbb 288 path = git_pathdup("TAG_EDITMSG");
62e09ce9
CR
289 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
290 if (fd < 0)
d08ebf99 291 die_errno(_("could not create file '%s'"), path);
bab8118a
MH
292
293 if (!is_null_sha1(prev))
294 write_tag_body(fd, prev);
295 else
7fbff25a 296 write_or_die(fd, _(tag_template), strlen(_(tag_template)));
62e09ce9
CR
297 close(fd);
298
7198203a
SB
299 if (launch_editor(path, buf, NULL)) {
300 fprintf(stderr,
d08ebf99 301 _("Please supply the message using either -m or -F option.\n"));
7198203a
SB
302 exit(1);
303 }
62e09ce9 304 }
62e09ce9 305
6d69b6f6 306 stripspace(buf, 1);
62e09ce9 307
fd17f5b5 308 if (!message && !buf->len)
d08ebf99 309 die(_("no tag message?"));
62e09ce9 310
fd17f5b5 311 strbuf_insert(buf, 0, header_buf, header_len);
62e09ce9 312
3927bbe9
JK
313 if (build_tag_object(buf, sign, result) < 0) {
314 if (path)
d08ebf99 315 fprintf(stderr, _("The tag message has been left in %s\n"),
3927bbe9
JK
316 path);
317 exit(128);
318 }
319 if (path) {
691f1a28 320 unlink_or_warn(path);
3927bbe9
JK
321 free(path);
322 }
62e09ce9
CR
323}
324
bd46c9a9
JH
325struct msg_arg {
326 int given;
327 struct strbuf buf;
328};
329
330static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
331{
332 struct msg_arg *msg = opt->value;
333
334 if (!arg)
335 return -1;
336 if (msg->buf.len)
337 strbuf_addstr(&(msg->buf), "\n\n");
338 strbuf_addstr(&(msg->buf), arg);
339 msg->given = 1;
340 return 0;
341}
342
4f0accd6
MS
343static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
344{
345 if (name[0] == '-')
8d9c5010 346 return -1;
4f0accd6
MS
347
348 strbuf_reset(sb);
349 strbuf_addf(sb, "refs/tags/%s", name);
350
8d9c5010 351 return check_refname_format(sb->buf, 0);
4f0accd6
MS
352}
353
62e09ce9
CR
354int cmd_tag(int argc, const char **argv, const char *prefix)
355{
f285a2d7 356 struct strbuf buf = STRBUF_INIT;
4f0accd6 357 struct strbuf ref = STRBUF_INIT;
62e09ce9 358 unsigned char object[20], prev[20];
62e09ce9 359 const char *object_ref, *tag;
62e09ce9
CR
360 struct ref_lock *lock;
361
6fa8342b 362 int annotate = 0, sign = 0, force = 0, lines = -1,
78d776a9 363 list = 0, delete = 0, verify = 0;
dbd0f5c7 364 const char *msgfile = NULL, *keyid = NULL;
bd46c9a9 365 struct msg_arg msg = { 0, STRBUF_INIT };
32c35cfb 366 struct commit_list *with_commit = NULL;
39686585 367 struct option options[] = {
c97eff5a 368 OPT_BOOLEAN('l', "list", &list, "list tag names"),
e3a0ca87
SB
369 { OPTION_INTEGER, 'n', NULL, &lines, "n",
370 "print <n> lines of each tag message",
39686585 371 PARSE_OPT_OPTARG, NULL, 1 },
c97eff5a
MG
372 OPT_BOOLEAN('d', "delete", &delete, "delete tags"),
373 OPT_BOOLEAN('v', "verify", &verify, "verify tags"),
39686585
CR
374
375 OPT_GROUP("Tag creation options"),
c97eff5a 376 OPT_BOOLEAN('a', "annotate", &annotate,
39686585 377 "annotated tag, needs a message"),
c97eff5a 378 OPT_CALLBACK('m', "message", &msg, "message",
3f406175 379 "tag message", parse_msg_arg),
c97eff5a
MG
380 OPT_FILENAME('F', "file", &msgfile, "read message from file"),
381 OPT_BOOLEAN('s', "sign", &sign, "annotated and GPG-signed tag"),
382 OPT_STRING('u', "local-user", &keyid, "key-id",
39686585 383 "use another key to sign the tag"),
76946b76 384 OPT__FORCE(&force, "replace the tag if exists"),
32c35cfb
JG
385
386 OPT_GROUP("Tag listing options"),
387 {
388 OPTION_CALLBACK, 0, "contains", &with_commit, "commit",
389 "print only tags that contain the commit",
390 PARSE_OPT_LASTARG_DEFAULT,
391 parse_opt_with_commit, (intptr_t)"HEAD",
392 },
39686585
CR
393 OPT_END()
394 };
395
ef90d6d4 396 git_config(git_tag_config, NULL);
62e09ce9 397
37782920 398 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
62e09ce9 399
be15f505
LT
400 if (keyid) {
401 sign = 1;
2f47eae2 402 set_signing_key(keyid);
be15f505 403 }
c1a41b9d
JH
404 if (sign)
405 annotate = 1;
6fa8342b
ST
406 if (argc == 0 && !(delete || verify))
407 list = 1;
c1a41b9d 408
6fa8342b
ST
409 if ((annotate || msg.given || msgfile || force) &&
410 (list || delete || verify))
411 usage_with_options(git_tag_usage, options);
412
413 if (list + delete + verify > 1)
414 usage_with_options(git_tag_usage, options);
39686585 415 if (list)
588d0e83 416 return list_tags(argv, lines == -1 ? 0 : lines,
32c35cfb 417 with_commit);
6fa8342b 418 if (lines != -1)
d08ebf99 419 die(_("-n option is only allowed with -l."));
32c35cfb 420 if (with_commit)
d08ebf99 421 die(_("--contains option is only allowed with -l."));
39686585
CR
422 if (delete)
423 return for_each_tag_name(argv, delete_tag);
424 if (verify)
425 return for_each_tag_name(argv, verify_tag);
426
bd46c9a9
JH
427 if (msg.given || msgfile) {
428 if (msg.given && msgfile)
d08ebf99 429 die(_("only one -F or -m option is allowed."));
39686585 430 annotate = 1;
bd46c9a9
JH
431 if (msg.given)
432 strbuf_addbuf(&buf, &(msg.buf));
39686585
CR
433 else {
434 if (!strcmp(msgfile, "-")) {
387e7e19 435 if (strbuf_read(&buf, 0, 1024) < 0)
d08ebf99 436 die_errno(_("cannot read '%s'"), msgfile);
387e7e19 437 } else {
39686585 438 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
d08ebf99 439 die_errno(_("could not open or read '%s'"),
d824cbba 440 msgfile);
62e09ce9 441 }
62e09ce9 442 }
62e09ce9
CR
443 }
444
39686585 445 tag = argv[0];
62e09ce9 446
39686585
CR
447 object_ref = argc == 2 ? argv[1] : "HEAD";
448 if (argc > 2)
d08ebf99 449 die(_("too many params"));
62e09ce9
CR
450
451 if (get_sha1(object_ref, object))
d08ebf99 452 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
62e09ce9 453
4f0accd6 454 if (strbuf_check_tag_ref(&ref, tag))
d08ebf99 455 die(_("'%s' is not a valid tag name."), tag);
62e09ce9 456
4f0accd6 457 if (!resolve_ref(ref.buf, prev, 1, NULL))
62e09ce9
CR
458 hashclr(prev);
459 else if (!force)
d08ebf99 460 die(_("tag '%s' already exists"), tag);
62e09ce9
CR
461
462 if (annotate)
bd46c9a9
JH
463 create_tag(object, tag, &buf, msg.given || msgfile,
464 sign, prev, object);
62e09ce9 465
4f0accd6 466 lock = lock_any_ref_for_update(ref.buf, prev, 0);
62e09ce9 467 if (!lock)
4f0accd6 468 die(_("%s: cannot lock the ref"), ref.buf);
62e09ce9 469 if (write_ref_sha1(lock, object, NULL) < 0)
4f0accd6 470 die(_("%s: cannot update the ref"), ref.buf);
0a043b1f 471 if (force && hashcmp(prev, object))
d08ebf99 472 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
62e09ce9 473
fd17f5b5 474 strbuf_release(&buf);
4f0accd6 475 strbuf_release(&ref);
62e09ce9
CR
476 return 0;
477}