blob: 045e7ad230359e9915820c4fd9c3d9bf4c29595e [file] [log] [blame]
Carlos Rica62e09ce2007-07-20 01:42:28 +02001/*
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"
Carlos Rica39686582007-11-09 14:42:56 +010014#include "parse-options.h"
Jeff Kingffc4b802011-06-11 19:04:08 +000015#include "diff.h"
16#include "revision.h"
Junio C Hamano2f47eae2011-09-07 21:19:47 -070017#include "gpg-interface.h"
Tom Grennanae7706b2012-02-08 15:03:43 -080018#include "sha1-array.h"
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +070019#include "column.h"
Karthik Nayakac4cc862015-09-10 21:18:27 +053020#include "ref-filter.h"
Carlos Rica62e09ce2007-07-20 01:42:28 +020021
Carlos Rica39686582007-11-09 14:42:56 +010022static const char * const git_tag_usage[] = {
Alex Henrie9c9b4f22015-01-13 00:44:47 -070023 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <tagname> [<head>]"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +070024 N_("git tag -d <tagname>..."),
Alex Henrie9c9b4f22015-01-13 00:44:47 -070025 N_("git tag -l [-n[<num>]] [--contains <commit>] [--points-at <object>]"
Karthik Nayak52428602015-09-10 21:52:49 +053026 "\n\t\t[--format=<format>] [--[no-]merged [<commit>]] [<pattern>...]"),
Lukas Puehringer07d347c2017-01-17 18:37:21 -050027 N_("git tag -v [--format=<format>] <tagname>..."),
Carlos Rica39686582007-11-09 14:42:56 +010028 NULL
29};
Carlos Rica62e09ce2007-07-20 01:42:28 +020030
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +070031static unsigned int colopts;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +010032static int force_sign_annotate;
Tom Grennanae7706b2012-02-08 15:03:43 -080033
Karthik Nayakdf094742015-09-11 20:36:46 +053034static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting, const char *format)
Jeff King588d0e82011-06-20 12:59:28 -040035{
Karthik Nayakac4cc862015-09-10 21:18:27 +053036 struct ref_array array;
Karthik Nayakdf094742015-09-11 20:36:46 +053037 char *to_free = NULL;
Jeff Kingca516992012-02-06 03:13:12 -050038 int i;
Jeff Kingca516992012-02-06 03:13:12 -050039
Karthik Nayakac4cc862015-09-10 21:18:27 +053040 memset(&array, 0, sizeof(array));
Jeff Kingca516992012-02-06 03:13:12 -050041
Karthik Nayakac4cc862015-09-10 21:18:27 +053042 if (filter->lines == -1)
43 filter->lines = 0;
Junio C Hamano31fd8d72012-02-06 10:13:27 -080044
Karthik Nayakdf094742015-09-11 20:36:46 +053045 if (!format) {
46 if (filter->lines) {
47 to_free = xstrfmt("%s %%(contents:lines=%d)",
Karthik Nayak17938f12017-01-10 14:19:46 +053048 "%(align:15)%(refname:lstrip=2)%(end)",
Karthik Nayakdf094742015-09-11 20:36:46 +053049 filter->lines);
50 format = to_free;
51 } else
Karthik Nayak17938f12017-01-10 14:19:46 +053052 format = "%(refname:lstrip=2)";
Carlos Rica62e09ce2007-07-20 01:42:28 +020053 }
54
Karthik Nayakb7cc53e2015-09-11 20:36:16 +053055 verify_ref_format(format);
Karthik Nayak008ed7d2015-10-18 15:55:04 +053056 filter->with_commit_tag_algo = 1;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +053057 filter_refs(&array, filter, FILTER_REFS_TAGS);
58 ref_array_sort(sorting, &array);
Carlos Rica62e09ce2007-07-20 01:42:28 +020059
Karthik Nayakb7cc53e2015-09-11 20:36:16 +053060 for (i = 0; i < array.nr; i++)
61 show_ref_array_item(array.items[i], format, 0);
62 ref_array_clear(&array);
63 free(to_free);
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 19:56:52 +070064
Carlos Rica62e09ce2007-07-20 01:42:28 +020065 return 0;
66}
67
Carlos Ricae317cfa2007-07-21 14:13:12 +020068typedef int (*each_tag_name_fn)(const char *name, const char *ref,
Lukas Puehringer07d347c2017-01-17 18:37:21 -050069 const unsigned char *sha1, const void *cb_data);
Carlos Rica62e09ce2007-07-20 01:42:28 +020070
Lukas Puehringer07d347c2017-01-17 18:37:21 -050071static int for_each_tag_name(const char **argv, each_tag_name_fn fn,
72 const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +020073{
74 const char **p;
75 char ref[PATH_MAX];
76 int had_error = 0;
77 unsigned char sha1[20];
78
79 for (p = argv; *p; p++) {
80 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
81 >= sizeof(ref)) {
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +000082 error(_("tag name too long: %.*s..."), 50, *p);
Carlos Rica62e09ce2007-07-20 01:42:28 +020083 had_error = 1;
84 continue;
85 }
Nguyễn Thái Ngọc Duyc6893322011-11-13 17:22:14 +070086 if (read_ref(ref, sha1)) {
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +000087 error(_("tag '%s' not found."), *p);
Carlos Rica62e09ce2007-07-20 01:42:28 +020088 had_error = 1;
89 continue;
90 }
Lukas Puehringer07d347c2017-01-17 18:37:21 -050091 if (fn(*p, ref, sha1, cb_data))
Carlos Rica62e09ce2007-07-20 01:42:28 +020092 had_error = 1;
93 }
94 return had_error;
95}
96
97static int delete_tag(const char *name, const char *ref,
Lukas Puehringer07d347c2017-01-17 18:37:21 -050098 const unsigned char *sha1, const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +020099{
Kyle Meyer755b49a2017-02-20 20:10:32 -0500100 if (delete_ref(NULL, ref, sha1, 0))
Carlos Rica62e09ce2007-07-20 01:42:28 +0200101 return 1;
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000102 printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200103 return 0;
104}
105
106static int verify_tag(const char *name, const char *ref,
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500107 const unsigned char *sha1, const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200108{
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500109 int flags;
110 const char *fmt_pretty = cb_data;
111 flags = GPG_VERIFY_VERBOSE;
112
113 if (fmt_pretty)
114 flags = GPG_VERIFY_OMIT_STATUS;
115
116 if (gpg_verify_tag(sha1, name, flags))
117 return -1;
118
119 if (fmt_pretty)
120 pretty_print_ref(name, sha1, fmt_pretty);
121
122 return 0;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200123}
124
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200125static int do_sign(struct strbuf *buffer)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200126{
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700127 return sign_buffer(buffer, buffer, get_signing_key());
Carlos Rica62e09ce2007-07-20 01:42:28 +0200128}
129
130static const char tag_template[] =
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200131 N_("\nWrite a message for tag:\n %s\n"
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100132 "Lines starting with '%c' will be ignored.\n");
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200133
134static const char tag_template_nocleanup[] =
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200135 N_("\nWrite a message for tag:\n %s\n"
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100136 "Lines starting with '%c' will be kept; you may remove them"
137 " yourself if you want to.\n");
Carlos Rica62e09ce2007-07-20 01:42:28 +0200138
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530139/* Parse arg given and add it the ref_sorting array */
140static int parse_sorting_string(const char *arg, struct ref_sorting **sorting_tail)
Jacob Kellerb1507942014-07-16 14:48:02 -0700141{
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530142 struct ref_sorting *s;
143 int len;
Jacob Kellerb1507942014-07-16 14:48:02 -0700144
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530145 s = xcalloc(1, sizeof(*s));
146 s->next = *sorting_tail;
147 *sorting_tail = s;
Jacob Kellerb1507942014-07-16 14:48:02 -0700148
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530149 if (*arg == '-') {
150 s->reverse = 1;
151 arg++;
Jacob Kellerb1507942014-07-16 14:48:02 -0700152 }
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530153 if (skip_prefix(arg, "version:", &arg) ||
154 skip_prefix(arg, "v:", &arg))
155 s->version = 1;
Jacob Kellerb1507942014-07-16 14:48:02 -0700156
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530157 len = strlen(arg);
158 s->atom = parse_ref_filter_atom(arg, arg+len);
Jacob Kellerb1507942014-07-16 14:48:02 -0700159
160 return 0;
161}
162
Johannes Schindelinef90d6d2008-05-14 18:46:53 +0100163static int git_tag_config(const char *var, const char *value, void *cb)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200164{
Jacob Kellerb1507942014-07-16 14:48:02 -0700165 int status;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530166 struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
Jacob Kellerb1507942014-07-16 14:48:02 -0700167
168 if (!strcmp(var, "tag.sort")) {
169 if (!value)
170 return config_error_nonbool(var);
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530171 parse_sorting_string(value, sorting_tail);
Jacob Kellerb1507942014-07-16 14:48:02 -0700172 return 0;
173 }
174
175 status = git_gpg_config(var, value, cb);
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700176 if (status)
177 return status;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100178 if (!strcmp(var, "tag.forcesignannotated")) {
179 force_sign_annotate = git_config_bool(var, value);
180 return 0;
181 }
182
Christian Couder59556542013-11-30 21:55:40 +0100183 if (starts_with(var, "column."))
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700184 return git_column_config(var, value, "tag", &colopts);
Johannes Schindelinef90d6d2008-05-14 18:46:53 +0100185 return git_default_config(var, value, cb);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200186}
187
Mike Hommeybab81182007-11-04 01:11:14 +0100188static void write_tag_body(int fd, const unsigned char *sha1)
189{
190 unsigned long size;
191 enum object_type type;
Michael J Grubere10dfb62010-11-10 12:17:28 +0100192 char *buf, *sp;
Mike Hommeybab81182007-11-04 01:11:14 +0100193
194 buf = read_sha1_file(sha1, &type, &size);
195 if (!buf)
196 return;
197 /* skip header */
198 sp = strstr(buf, "\n\n");
199
200 if (!sp || !size || type != OBJ_TAG) {
201 free(buf);
202 return;
203 }
204 sp += 2; /* skip the 2 LFs */
Michael J Grubere10dfb62010-11-10 12:17:28 +0100205 write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
Mike Hommeybab81182007-11-04 01:11:14 +0100206
207 free(buf);
208}
209
Jeff King3927bbe2008-12-06 14:40:34 -0500210static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
211{
212 if (sign && do_sign(buf) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000213 return error(_("unable to sign the tag"));
Jeff King3927bbe2008-12-06 14:40:34 -0500214 if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000215 return error(_("unable to write tag file"));
Jeff King3927bbe2008-12-06 14:40:34 -0500216 return 0;
217}
218
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200219struct create_tag_options {
220 unsigned int message_given:1;
221 unsigned int sign;
222 enum {
223 CLEANUP_NONE,
224 CLEANUP_SPACE,
225 CLEANUP_ALL
226 } cleanup_mode;
227};
228
Carlos Rica62e09ce2007-07-20 01:42:28 +0200229static void create_tag(const unsigned char *object, const char *tag,
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200230 struct strbuf *buf, struct create_tag_options *opt,
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800231 unsigned char *prev, unsigned char *result)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200232{
233 enum object_type type;
Jeff Kingb0ceab92017-03-28 15:46:23 -0400234 struct strbuf header = STRBUF_INIT;
Jeff King3927bbe2008-12-06 14:40:34 -0500235 char *path = NULL;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200236
237 type = sha1_object_info(object, NULL);
Carlos Ricae317cfa2007-07-21 14:13:12 +0200238 if (type <= OBJ_NONE)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000239 die(_("bad object type."));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200240
Jeff Kingb0ceab92017-03-28 15:46:23 -0400241 strbuf_addf(&header,
242 "object %s\n"
243 "type %s\n"
244 "tag %s\n"
245 "tagger %s\n\n",
246 sha1_to_hex(object),
247 typename(type),
248 tag,
249 git_committer_info(IDENT_STRICT));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200250
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200251 if (!opt->message_given) {
Carlos Rica62e09ce2007-07-20 01:42:28 +0200252 int fd;
253
254 /* write the template message before editing: */
Alex Riesena4f34cb2008-10-27 11:22:09 +0100255 path = git_pathdup("TAG_EDITMSG");
Carlos Rica62e09ce2007-07-20 01:42:28 +0200256 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
257 if (fd < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000258 die_errno(_("could not create file '%s'"), path);
Mike Hommeybab81182007-11-04 01:11:14 +0100259
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100260 if (!is_null_sha1(prev)) {
Mike Hommeybab81182007-11-04 01:11:14 +0100261 write_tag_body(fd, prev);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100262 } else {
263 struct strbuf buf = STRBUF_INIT;
264 strbuf_addch(&buf, '\n');
265 if (opt->cleanup_mode == CLEANUP_ALL)
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200266 strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100267 else
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200268 strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100269 write_or_die(fd, buf.buf, buf.len);
270 strbuf_release(&buf);
271 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200272 close(fd);
273
Stephan Beyer71982032008-07-25 18:28:42 +0200274 if (launch_editor(path, buf, NULL)) {
275 fprintf(stderr,
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000276 _("Please supply the message using either -m or -F option.\n"));
Stephan Beyer71982032008-07-25 18:28:42 +0200277 exit(1);
278 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200279 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200280
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200281 if (opt->cleanup_mode != CLEANUP_NONE)
Tobias Klauser63af4a82015-10-16 17:16:42 +0200282 strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200283
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200284 if (!opt->message_given && !buf->len)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000285 die(_("no tag message?"));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200286
Jeff Kingb0ceab92017-03-28 15:46:23 -0400287 strbuf_insert(buf, 0, header.buf, header.len);
288 strbuf_release(&header);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200289
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200290 if (build_tag_object(buf, opt->sign, result) < 0) {
Jeff King3927bbe2008-12-06 14:40:34 -0500291 if (path)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000292 fprintf(stderr, _("The tag message has been left in %s\n"),
Jeff King3927bbe2008-12-06 14:40:34 -0500293 path);
294 exit(128);
295 }
296 if (path) {
Alex Riesen691f1a22009-04-29 23:22:56 +0200297 unlink_or_warn(path);
Jeff King3927bbe2008-12-06 14:40:34 -0500298 free(path);
299 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200300}
301
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100302static void create_reflog_msg(const unsigned char *sha1, struct strbuf *sb)
303{
304 enum object_type type;
305 struct commit *c;
306 char *buf;
307 unsigned long size;
308 int subject_len = 0;
309 const char *subject_start;
310
311 char *rla = getenv("GIT_REFLOG_ACTION");
312 if (rla) {
313 strbuf_addstr(sb, rla);
314 } else {
315 strbuf_addstr(sb, _("tag: tagging "));
316 strbuf_add_unique_abbrev(sb, sha1, DEFAULT_ABBREV);
317 }
318
319 strbuf_addstr(sb, " (");
320 type = sha1_object_info(sha1, NULL);
321 switch (type) {
322 default:
323 strbuf_addstr(sb, _("object of unknown type"));
324 break;
325 case OBJ_COMMIT:
326 if ((buf = read_sha1_file(sha1, &type, &size)) != NULL) {
327 subject_len = find_commit_subject(buf, &subject_start);
328 strbuf_insert(sb, sb->len, subject_start, subject_len);
329 } else {
330 strbuf_addstr(sb, _("commit object"));
331 }
332 free(buf);
333
334 if ((c = lookup_commit_reference(sha1)) != NULL)
335 strbuf_addf(sb, ", %s", show_date(c->date, 0, DATE_MODE(SHORT)));
336 break;
337 case OBJ_TREE:
338 strbuf_addstr(sb, _("tree object"));
339 break;
340 case OBJ_BLOB:
341 strbuf_addstr(sb, _("blob object"));
342 break;
343 case OBJ_TAG:
344 strbuf_addstr(sb, _("other tag object"));
345 break;
346 }
347 strbuf_addch(sb, ')');
348}
349
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800350struct msg_arg {
351 int given;
352 struct strbuf buf;
353};
354
355static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
356{
357 struct msg_arg *msg = opt->value;
358
359 if (!arg)
360 return -1;
361 if (msg->buf.len)
362 strbuf_addstr(&(msg->buf), "\n\n");
363 strbuf_addstr(&(msg->buf), arg);
364 msg->given = 1;
365 return 0;
366}
367
Michael Schubert4f0accd2011-05-10 01:36:36 +0200368static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
369{
370 if (name[0] == '-')
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200371 return -1;
Michael Schubert4f0accd2011-05-10 01:36:36 +0200372
373 strbuf_reset(sb);
374 strbuf_addf(sb, "refs/tags/%s", name);
375
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200376 return check_refname_format(sb->buf, 0);
Michael Schubert4f0accd2011-05-10 01:36:36 +0200377}
378
Carlos Rica62e09ce2007-07-20 01:42:28 +0200379int cmd_tag(int argc, const char **argv, const char *prefix)
380{
Brandon Caseyf285a2d2008-10-09 14:12:12 -0500381 struct strbuf buf = STRBUF_INIT;
Michael Schubert4f0accd2011-05-10 01:36:36 +0200382 struct strbuf ref = STRBUF_INIT;
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100383 struct strbuf reflog_msg = STRBUF_INIT;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200384 unsigned char object[20], prev[20];
Carlos Rica62e09ce2007-07-20 01:42:28 +0200385 const char *object_ref, *tag;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200386 struct create_tag_options opt;
387 char *cleanup_arg = NULL;
David Turner144c76f2015-07-21 17:04:55 -0400388 int create_reflog = 0;
Karthik Nayakac4cc862015-09-10 21:18:27 +0530389 int annotate = 0, force = 0;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100390 int cmdmode = 0, create_tag_object = 0;
Junio C Hamanodbd0f5c2008-08-06 11:43:47 -0700391 const char *msgfile = NULL, *keyid = NULL;
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800392 struct msg_arg msg = { 0, STRBUF_INIT };
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700393 struct ref_transaction *transaction;
394 struct strbuf err = STRBUF_INIT;
Karthik Nayakac4cc862015-09-10 21:18:27 +0530395 struct ref_filter filter;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530396 static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
Karthik Nayakdf094742015-09-11 20:36:46 +0530397 const char *format = NULL;
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700398 int icase = 0;
Carlos Rica39686582007-11-09 14:42:56 +0100399 struct option options[] = {
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700400 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530401 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700402 N_("print <n> lines of each tag message"),
Carlos Rica39686582007-11-09 14:42:56 +0100403 PARSE_OPT_OPTARG, NULL, 1 },
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700404 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
405 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
Carlos Rica39686582007-11-09 14:42:56 +0100406
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700407 OPT_GROUP(N_("Tag creation options")),
Stefan Bellerd5d09d42013-08-03 13:51:19 +0200408 OPT_BOOL('a', "annotate", &annotate,
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700409 N_("annotated tag, needs a message")),
410 OPT_CALLBACK('m', "message", &msg, N_("message"),
411 N_("tag message"), parse_msg_arg),
412 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
Stefan Bellerd5d09d42013-08-03 13:51:19 +0200413 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700414 OPT_STRING(0, "cleanup", &cleanup_arg, N_("mode"),
415 N_("how to strip spaces and #comments from message")),
Junio C Hamanoe703d712014-03-23 15:58:12 -0700416 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700417 N_("use another key to sign the tag")),
418 OPT__FORCE(&force, N_("replace the tag if exists")),
Ralf Thielow98c32bd2015-09-11 18:04:13 +0200419 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
Jeff Kingdd059c62015-03-12 14:15:09 -0400420
421 OPT_GROUP(N_("Tag listing options")),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700422 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530423 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
424 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
Karthik Nayak52428602015-09-10 21:52:49 +0530425 OPT_MERGED(&filter, N_("print only tags that are merged")),
426 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530427 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
428 N_("field name to sort on"), &parse_opt_ref_sorting),
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 19:56:52 +0700429 {
Karthik Nayakac4cc862015-09-10 21:18:27 +0530430 OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
Karthik Nayakb2172fd2015-07-07 21:36:08 +0530431 N_("print only tags of the object"), 0, parse_opt_object_name
Tom Grennanae7706b2012-02-08 15:03:43 -0800432 },
Karthik Nayakdf094742015-09-11 20:36:46 +0530433 OPT_STRING( 0 , "format", &format, N_("format"), N_("format to use for the output")),
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700434 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
Carlos Rica39686582007-11-09 14:42:56 +0100435 OPT_END()
436 };
437
Karthik Nayak56b43602017-01-10 14:19:51 +0530438 setup_ref_filter_porcelain_msg();
439
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530440 git_config(git_tag_config, sorting_tail);
Carlos Rica39686582007-11-09 14:42:56 +0100441
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200442 memset(&opt, 0, sizeof(opt));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530443 memset(&filter, 0, sizeof(filter));
444 filter.lines = -1;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200445
Stephen Boyd37782922009-05-23 11:53:12 -0700446 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
Carlos Rica39686582007-11-09 14:42:56 +0100447
Linus Torvaldsbe15f502007-12-10 20:08:06 -0800448 if (keyid) {
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200449 opt.sign = 1;
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700450 set_signing_key(keyid);
Linus Torvaldsbe15f502007-12-10 20:08:06 -0800451 }
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100452 create_tag_object = (opt.sign || annotate || msg.given || msgfile);
453
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700454 if (argc == 0 && !cmdmode)
455 cmdmode = 'l';
Junio C Hamanoc1a41b92007-11-25 15:21:42 -0800456
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100457 if ((create_tag_object || force) && (cmdmode != 0))
Samuel Tardieu6fa83422008-11-05 00:20:31 +0100458 usage_with_options(git_tag_usage, options);
459
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700460 finalize_colopts(&colopts, -1);
Karthik Nayakac4cc862015-09-10 21:18:27 +0530461 if (cmdmode == 'l' && filter.lines != -1) {
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700462 if (explicitly_enable_column(colopts))
463 die(_("--column and -n are incompatible"));
464 colopts = 0;
465 }
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530466 if (!sorting)
467 sorting = ref_default_sorting();
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700468 sorting->ignore_case = icase;
469 filter.ignore_case = icase;
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700470 if (cmdmode == 'l') {
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700471 int ret;
472 if (column_active(colopts)) {
473 struct column_options copts;
474 memset(&copts, 0, sizeof(copts));
475 copts.padding = 2;
476 run_column_filter(colopts, &copts);
477 }
Karthik Nayakac4cc862015-09-10 21:18:27 +0530478 filter.name_patterns = argv;
Karthik Nayakdf094742015-09-11 20:36:46 +0530479 ret = list_tags(&filter, sorting, format);
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700480 if (column_active(colopts))
481 stop_column_filter();
482 return ret;
483 }
Karthik Nayakac4cc862015-09-10 21:18:27 +0530484 if (filter.lines != -1)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000485 die(_("-n option is only allowed with -l."));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530486 if (filter.with_commit)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000487 die(_("--contains option is only allowed with -l."));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530488 if (filter.points_at.nr)
Tom Grennanae7706b2012-02-08 15:03:43 -0800489 die(_("--points-at option is only allowed with -l."));
Karthik Nayak52428602015-09-10 21:52:49 +0530490 if (filter.merge_commit)
491 die(_("--merged and --no-merged option are only allowed with -l"));
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700492 if (cmdmode == 'd')
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500493 return for_each_tag_name(argv, delete_tag, NULL);
494 if (cmdmode == 'v') {
495 if (format)
496 verify_ref_format(format);
497 return for_each_tag_name(argv, verify_tag, format);
498 }
Carlos Rica39686582007-11-09 14:42:56 +0100499
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800500 if (msg.given || msgfile) {
501 if (msg.given && msgfile)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000502 die(_("only one -F or -m option is allowed."));
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800503 if (msg.given)
504 strbuf_addbuf(&buf, &(msg.buf));
Carlos Rica39686582007-11-09 14:42:56 +0100505 else {
506 if (!strcmp(msgfile, "-")) {
Pierre Habouzit387e7e12007-09-27 15:25:55 +0200507 if (strbuf_read(&buf, 0, 1024) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000508 die_errno(_("cannot read '%s'"), msgfile);
Pierre Habouzit387e7e12007-09-27 15:25:55 +0200509 } else {
Carlos Rica39686582007-11-09 14:42:56 +0100510 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000511 die_errno(_("could not open or read '%s'"),
Thomas Rastd824cbb2009-06-27 17:58:46 +0200512 msgfile);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200513 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200514 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200515 }
516
Carlos Rica39686582007-11-09 14:42:56 +0100517 tag = argv[0];
Carlos Rica62e09ce2007-07-20 01:42:28 +0200518
Carlos Rica39686582007-11-09 14:42:56 +0100519 object_ref = argc == 2 ? argv[1] : "HEAD";
520 if (argc > 2)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000521 die(_("too many params"));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200522
523 if (get_sha1(object_ref, object))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000524 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200525
Michael Schubert4f0accd2011-05-10 01:36:36 +0200526 if (strbuf_check_tag_ref(&ref, tag))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000527 die(_("'%s' is not a valid tag name."), tag);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200528
Nguyễn Thái Ngọc Duyc6893322011-11-13 17:22:14 +0700529 if (read_ref(ref.buf, prev))
Carlos Rica62e09ce2007-07-20 01:42:28 +0200530 hashclr(prev);
531 else if (!force)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000532 die(_("tag '%s' already exists"), tag);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200533
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200534 opt.message_given = msg.given || msgfile;
535
536 if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
537 opt.cleanup_mode = CLEANUP_ALL;
538 else if (!strcmp(cleanup_arg, "verbatim"))
539 opt.cleanup_mode = CLEANUP_NONE;
540 else if (!strcmp(cleanup_arg, "whitespace"))
541 opt.cleanup_mode = CLEANUP_SPACE;
542 else
543 die(_("Invalid cleanup mode %s"), cleanup_arg);
544
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100545 create_reflog_msg(object, &reflog_msg);
546
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100547 if (create_tag_object) {
548 if (force_sign_annotate && !annotate)
549 opt.sign = 1;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200550 create_tag(object, tag, &buf, &opt, prev, object);
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100551 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200552
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700553 transaction = ref_transaction_begin(&err);
554 if (!transaction ||
555 ref_transaction_update(transaction, ref.buf, object, prev,
David Turner144c76f2015-07-21 17:04:55 -0400556 create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100557 reflog_msg.buf, &err) ||
Ronnie Sahlbergdb7516a2014-04-30 12:22:42 -0700558 ref_transaction_commit(transaction, &err))
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700559 die("%s", err.buf);
560 ref_transaction_free(transaction);
Phil Hord3ae851e2013-03-12 19:13:41 -0400561 if (force && !is_null_sha1(prev) && hashcmp(prev, object))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000562 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200563
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700564 strbuf_release(&err);
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200565 strbuf_release(&buf);
Michael Schubert4f0accd2011-05-10 01:36:36 +0200566 strbuf_release(&ref);
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100567 strbuf_release(&reflog_msg);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200568 return 0;
569}