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.
13 #include "run-command.h"
14 #include "parse-options.h"
17 #include "gpg-interface.h"
18 #include "sha1-array.h"
20 #include "ref-filter.h"
22 static const char * const git_tag_usage
[] = {
23 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <tagname> [<head>]"),
24 N_("git tag -d <tagname>..."),
25 N_("git tag -l [-n[<num>]] [--contains <commit>] [--points-at <object>]"
26 "\n\t\t[--format=<format>] [--[no-]merged [<commit>]] [<pattern>...]"),
27 N_("git tag -v [--format=<format>] <tagname>..."),
31 static unsigned int colopts
;
32 static int force_sign_annotate
;
34 static int list_tags(struct ref_filter
*filter
, struct ref_sorting
*sorting
, const char *format
)
36 struct ref_array array
;
40 memset(&array
, 0, sizeof(array
));
42 if (filter
->lines
== -1)
47 to_free
= xstrfmt("%s %%(contents:lines=%d)",
48 "%(align:15)%(refname:strip=2)%(end)",
52 format
= "%(refname:strip=2)";
55 verify_ref_format(format
);
56 filter
->with_commit_tag_algo
= 1;
57 filter_refs(&array
, filter
, FILTER_REFS_TAGS
);
58 ref_array_sort(sorting
, &array
);
60 for (i
= 0; i
< array
.nr
; i
++)
61 show_ref_array_item(array
.items
[i
], format
, 0);
62 ref_array_clear(&array
);
68 typedef int (*each_tag_name_fn
)(const char *name
, const char *ref
,
69 const unsigned char *sha1
, const void *cb_data
);
71 static int for_each_tag_name(const char **argv
, each_tag_name_fn fn
,
77 unsigned char sha1
[20];
79 for (p
= argv
; *p
; p
++) {
80 if (snprintf(ref
, sizeof(ref
), "refs/tags/%s", *p
)
82 error(_("tag name too long: %.*s..."), 50, *p
);
86 if (read_ref(ref
, sha1
)) {
87 error(_("tag '%s' not found."), *p
);
91 if (fn(*p
, ref
, sha1
, cb_data
))
97 static int delete_tag(const char *name
, const char *ref
,
98 const unsigned char *sha1
, const void *cb_data
)
100 if (delete_ref(NULL
, ref
, sha1
, 0))
102 printf(_("Deleted tag '%s' (was %s)\n"), name
, find_unique_abbrev(sha1
, DEFAULT_ABBREV
));
106 static int verify_tag(const char *name
, const char *ref
,
107 const unsigned char *sha1
, const void *cb_data
)
110 const char *fmt_pretty
= cb_data
;
111 flags
= GPG_VERIFY_VERBOSE
;
114 flags
= GPG_VERIFY_OMIT_STATUS
;
116 if (gpg_verify_tag(sha1
, name
, flags
))
120 pretty_print_ref(name
, sha1
, fmt_pretty
);
125 static int do_sign(struct strbuf
*buffer
)
127 return sign_buffer(buffer
, buffer
, get_signing_key());
130 static const char tag_template
[] =
131 N_("\nWrite a message for tag:\n %s\n"
132 "Lines starting with '%c' will be ignored.\n");
134 static const char tag_template_nocleanup
[] =
135 N_("\nWrite a message for tag:\n %s\n"
136 "Lines starting with '%c' will be kept; you may remove them"
137 " yourself if you want to.\n");
139 /* Parse arg given and add it the ref_sorting array */
140 static int parse_sorting_string(const char *arg
, struct ref_sorting
**sorting_tail
)
142 struct ref_sorting
*s
;
145 s
= xcalloc(1, sizeof(*s
));
146 s
->next
= *sorting_tail
;
153 if (skip_prefix(arg
, "version:", &arg
) ||
154 skip_prefix(arg
, "v:", &arg
))
158 s
->atom
= parse_ref_filter_atom(arg
, arg
+len
);
163 static int git_tag_config(const char *var
, const char *value
, void *cb
)
166 struct ref_sorting
**sorting_tail
= (struct ref_sorting
**)cb
;
168 if (!strcmp(var
, "tag.sort")) {
170 return config_error_nonbool(var
);
171 parse_sorting_string(value
, sorting_tail
);
175 status
= git_gpg_config(var
, value
, cb
);
178 if (!strcmp(var
, "tag.forcesignannotated")) {
179 force_sign_annotate
= git_config_bool(var
, value
);
183 if (starts_with(var
, "column."))
184 return git_column_config(var
, value
, "tag", &colopts
);
185 return git_default_config(var
, value
, cb
);
188 static void write_tag_body(int fd
, const unsigned char *sha1
)
191 enum object_type type
;
194 buf
= read_sha1_file(sha1
, &type
, &size
);
198 sp
= strstr(buf
, "\n\n");
200 if (!sp
|| !size
|| type
!= OBJ_TAG
) {
204 sp
+= 2; /* skip the 2 LFs */
205 write_or_die(fd
, sp
, parse_signature(sp
, buf
+ size
- sp
));
210 static int build_tag_object(struct strbuf
*buf
, int sign
, unsigned char *result
)
212 if (sign
&& do_sign(buf
) < 0)
213 return error(_("unable to sign the tag"));
214 if (write_sha1_file(buf
->buf
, buf
->len
, tag_type
, result
) < 0)
215 return error(_("unable to write tag file"));
219 struct create_tag_options
{
220 unsigned int message_given
:1;
229 static void create_tag(const unsigned char *object
, const char *tag
,
230 struct strbuf
*buf
, struct create_tag_options
*opt
,
231 unsigned char *prev
, unsigned char *result
)
233 enum object_type type
;
234 char header_buf
[1024];
238 type
= sha1_object_info(object
, NULL
);
239 if (type
<= OBJ_NONE
)
240 die(_("bad object type."));
242 header_len
= snprintf(header_buf
, sizeof(header_buf
),
250 git_committer_info(IDENT_STRICT
));
252 if (header_len
> sizeof(header_buf
) - 1)
253 die(_("tag header too big."));
255 if (!opt
->message_given
) {
258 /* write the template message before editing: */
259 path
= git_pathdup("TAG_EDITMSG");
260 fd
= open(path
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
262 die_errno(_("could not create file '%s'"), path
);
264 if (!is_null_sha1(prev
)) {
265 write_tag_body(fd
, prev
);
267 struct strbuf buf
= STRBUF_INIT
;
268 strbuf_addch(&buf
, '\n');
269 if (opt
->cleanup_mode
== CLEANUP_ALL
)
270 strbuf_commented_addf(&buf
, _(tag_template
), tag
, comment_line_char
);
272 strbuf_commented_addf(&buf
, _(tag_template_nocleanup
), tag
, comment_line_char
);
273 write_or_die(fd
, buf
.buf
, buf
.len
);
274 strbuf_release(&buf
);
278 if (launch_editor(path
, buf
, NULL
)) {
280 _("Please supply the message using either -m or -F option.\n"));
285 if (opt
->cleanup_mode
!= CLEANUP_NONE
)
286 strbuf_stripspace(buf
, opt
->cleanup_mode
== CLEANUP_ALL
);
288 if (!opt
->message_given
&& !buf
->len
)
289 die(_("no tag message?"));
291 strbuf_insert(buf
, 0, header_buf
, header_len
);
293 if (build_tag_object(buf
, opt
->sign
, result
) < 0) {
295 fprintf(stderr
, _("The tag message has been left in %s\n"),
300 unlink_or_warn(path
);
310 static int parse_msg_arg(const struct option
*opt
, const char *arg
, int unset
)
312 struct msg_arg
*msg
= opt
->value
;
317 strbuf_addstr(&(msg
->buf
), "\n\n");
318 strbuf_addstr(&(msg
->buf
), arg
);
323 static int strbuf_check_tag_ref(struct strbuf
*sb
, const char *name
)
329 strbuf_addf(sb
, "refs/tags/%s", name
);
331 return check_refname_format(sb
->buf
, 0);
334 int cmd_tag(int argc
, const char **argv
, const char *prefix
)
336 struct strbuf buf
= STRBUF_INIT
;
337 struct strbuf ref
= STRBUF_INIT
;
338 unsigned char object
[20], prev
[20];
339 const char *object_ref
, *tag
;
340 struct create_tag_options opt
;
341 char *cleanup_arg
= NULL
;
342 int create_reflog
= 0;
343 int annotate
= 0, force
= 0;
344 int cmdmode
= 0, create_tag_object
= 0;
345 const char *msgfile
= NULL
, *keyid
= NULL
;
346 struct msg_arg msg
= { 0, STRBUF_INIT
};
347 struct ref_transaction
*transaction
;
348 struct strbuf err
= STRBUF_INIT
;
349 struct ref_filter filter
;
350 static struct ref_sorting
*sorting
= NULL
, **sorting_tail
= &sorting
;
351 const char *format
= NULL
;
353 struct option options
[] = {
354 OPT_CMDMODE('l', "list", &cmdmode
, N_("list tag names"), 'l'),
355 { OPTION_INTEGER
, 'n', NULL
, &filter
.lines
, N_("n"),
356 N_("print <n> lines of each tag message"),
357 PARSE_OPT_OPTARG
, NULL
, 1 },
358 OPT_CMDMODE('d', "delete", &cmdmode
, N_("delete tags"), 'd'),
359 OPT_CMDMODE('v', "verify", &cmdmode
, N_("verify tags"), 'v'),
361 OPT_GROUP(N_("Tag creation options")),
362 OPT_BOOL('a', "annotate", &annotate
,
363 N_("annotated tag, needs a message")),
364 OPT_CALLBACK('m', "message", &msg
, N_("message"),
365 N_("tag message"), parse_msg_arg
),
366 OPT_FILENAME('F', "file", &msgfile
, N_("read message from file")),
367 OPT_BOOL('s', "sign", &opt
.sign
, N_("annotated and GPG-signed tag")),
368 OPT_STRING(0, "cleanup", &cleanup_arg
, N_("mode"),
369 N_("how to strip spaces and #comments from message")),
370 OPT_STRING('u', "local-user", &keyid
, N_("key-id"),
371 N_("use another key to sign the tag")),
372 OPT__FORCE(&force
, N_("replace the tag if exists")),
373 OPT_BOOL(0, "create-reflog", &create_reflog
, N_("create a reflog")),
375 OPT_GROUP(N_("Tag listing options")),
376 OPT_COLUMN(0, "column", &colopts
, N_("show tag list in columns")),
377 OPT_CONTAINS(&filter
.with_commit
, N_("print only tags that contain the commit")),
378 OPT_WITH(&filter
.with_commit
, N_("print only tags that contain the commit")),
379 OPT_MERGED(&filter
, N_("print only tags that are merged")),
380 OPT_NO_MERGED(&filter
, N_("print only tags that are not merged")),
381 OPT_CALLBACK(0 , "sort", sorting_tail
, N_("key"),
382 N_("field name to sort on"), &parse_opt_ref_sorting
),
384 OPTION_CALLBACK
, 0, "points-at", &filter
.points_at
, N_("object"),
385 N_("print only tags of the object"), 0, parse_opt_object_name
387 OPT_STRING( 0 , "format", &format
, N_("format"), N_("format to use for the output")),
388 OPT_BOOL('i', "ignore-case", &icase
, N_("sorting and filtering are case insensitive")),
392 git_config(git_tag_config
, sorting_tail
);
394 memset(&opt
, 0, sizeof(opt
));
395 memset(&filter
, 0, sizeof(filter
));
398 argc
= parse_options(argc
, argv
, prefix
, options
, git_tag_usage
, 0);
402 set_signing_key(keyid
);
404 create_tag_object
= (opt
.sign
|| annotate
|| msg
.given
|| msgfile
);
406 if (argc
== 0 && !cmdmode
)
409 if ((create_tag_object
|| force
) && (cmdmode
!= 0))
410 usage_with_options(git_tag_usage
, options
);
412 finalize_colopts(&colopts
, -1);
413 if (cmdmode
== 'l' && filter
.lines
!= -1) {
414 if (explicitly_enable_column(colopts
))
415 die(_("--column and -n are incompatible"));
419 sorting
= ref_default_sorting();
420 sorting
->ignore_case
= icase
;
421 filter
.ignore_case
= icase
;
422 if (cmdmode
== 'l') {
424 if (column_active(colopts
)) {
425 struct column_options copts
;
426 memset(&copts
, 0, sizeof(copts
));
428 run_column_filter(colopts
, &copts
);
430 filter
.name_patterns
= argv
;
431 ret
= list_tags(&filter
, sorting
, format
);
432 if (column_active(colopts
))
433 stop_column_filter();
436 if (filter
.lines
!= -1)
437 die(_("-n option is only allowed with -l."));
438 if (filter
.with_commit
)
439 die(_("--contains option is only allowed with -l."));
440 if (filter
.points_at
.nr
)
441 die(_("--points-at option is only allowed with -l."));
442 if (filter
.merge_commit
)
443 die(_("--merged and --no-merged option are only allowed with -l"));
445 return for_each_tag_name(argv
, delete_tag
, NULL
);
446 if (cmdmode
== 'v') {
448 verify_ref_format(format
);
449 return for_each_tag_name(argv
, verify_tag
, format
);
452 if (msg
.given
|| msgfile
) {
453 if (msg
.given
&& msgfile
)
454 die(_("only one -F or -m option is allowed."));
456 strbuf_addbuf(&buf
, &(msg
.buf
));
458 if (!strcmp(msgfile
, "-")) {
459 if (strbuf_read(&buf
, 0, 1024) < 0)
460 die_errno(_("cannot read '%s'"), msgfile
);
462 if (strbuf_read_file(&buf
, msgfile
, 1024) < 0)
463 die_errno(_("could not open or read '%s'"),
471 object_ref
= argc
== 2 ? argv
[1] : "HEAD";
473 die(_("too many params"));
475 if (get_sha1(object_ref
, object
))
476 die(_("Failed to resolve '%s' as a valid ref."), object_ref
);
478 if (strbuf_check_tag_ref(&ref
, tag
))
479 die(_("'%s' is not a valid tag name."), tag
);
481 if (read_ref(ref
.buf
, prev
))
484 die(_("tag '%s' already exists"), tag
);
486 opt
.message_given
= msg
.given
|| msgfile
;
488 if (!cleanup_arg
|| !strcmp(cleanup_arg
, "strip"))
489 opt
.cleanup_mode
= CLEANUP_ALL
;
490 else if (!strcmp(cleanup_arg
, "verbatim"))
491 opt
.cleanup_mode
= CLEANUP_NONE
;
492 else if (!strcmp(cleanup_arg
, "whitespace"))
493 opt
.cleanup_mode
= CLEANUP_SPACE
;
495 die(_("Invalid cleanup mode %s"), cleanup_arg
);
497 if (create_tag_object
) {
498 if (force_sign_annotate
&& !annotate
)
500 create_tag(object
, tag
, &buf
, &opt
, prev
, object
);
503 transaction
= ref_transaction_begin(&err
);
505 ref_transaction_update(transaction
, ref
.buf
, object
, prev
,
506 create_reflog
? REF_FORCE_CREATE_REFLOG
: 0,
508 ref_transaction_commit(transaction
, &err
))
510 ref_transaction_free(transaction
);
511 if (force
&& !is_null_sha1(prev
) && hashcmp(prev
, object
))
512 printf(_("Updated tag '%s' (was %s)\n"), tag
, find_unique_abbrev(prev
, DEFAULT_ABBREV
));
514 strbuf_release(&err
);
515 strbuf_release(&buf
);
516 strbuf_release(&ref
);