Merge branch 'jc/am-mailinfo-direct'
[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 #include "gpg-interface.h"
18 #include "sha1-array.h"
19 #include "column.h"
20 #include "ref-filter.h"
21
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 <tagname>..."),
28         NULL
29 };
30
31 static unsigned int colopts;
32
33 static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting, const char *format)
34 {
35         struct ref_array array;
36         char *to_free = NULL;
37         int i;
38
39         memset(&array, 0, sizeof(array));
40
41         if (filter->lines == -1)
42                 filter->lines = 0;
43
44         if (!format) {
45                 if (filter->lines) {
46                         to_free = xstrfmt("%s %%(contents:lines=%d)",
47                                           "%(align:15)%(refname:short)%(end)",
48                                           filter->lines);
49                         format = to_free;
50                 } else
51                         format = "%(refname:short)";
52         }
53
54         verify_ref_format(format);
55         filter->with_commit_tag_algo = 1;
56         filter_refs(&array, filter, FILTER_REFS_TAGS);
57         ref_array_sort(sorting, &array);
58
59         for (i = 0; i < array.nr; i++)
60                 show_ref_array_item(array.items[i], format, 0);
61         ref_array_clear(&array);
62         free(to_free);
63
64         return 0;
65 }
66
67 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
68                                 const unsigned char *sha1);
69
70 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
71 {
72         const char **p;
73         char ref[PATH_MAX];
74         int had_error = 0;
75         unsigned char sha1[20];
76
77         for (p = argv; *p; p++) {
78                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
79                                         >= sizeof(ref)) {
80                         error(_("tag name too long: %.*s..."), 50, *p);
81                         had_error = 1;
82                         continue;
83                 }
84                 if (read_ref(ref, sha1)) {
85                         error(_("tag '%s' not found."), *p);
86                         had_error = 1;
87                         continue;
88                 }
89                 if (fn(*p, ref, sha1))
90                         had_error = 1;
91         }
92         return had_error;
93 }
94
95 static int delete_tag(const char *name, const char *ref,
96                                 const unsigned char *sha1)
97 {
98         if (delete_ref(ref, sha1, 0))
99                 return 1;
100         printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
101         return 0;
102 }
103
104 static int verify_tag(const char *name, const char *ref,
105                                 const unsigned char *sha1)
106 {
107         const char *argv_verify_tag[] = {"verify-tag",
108                                         "-v", "SHA1_HEX", NULL};
109         argv_verify_tag[2] = sha1_to_hex(sha1);
110
111         if (run_command_v_opt(argv_verify_tag, RUN_GIT_CMD))
112                 return error(_("could not verify the tag '%s'"), name);
113         return 0;
114 }
115
116 static int do_sign(struct strbuf *buffer)
117 {
118         return sign_buffer(buffer, buffer, get_signing_key());
119 }
120
121 static const char tag_template[] =
122         N_("\nWrite a message for tag:\n  %s\n"
123         "Lines starting with '%c' will be ignored.\n");
124
125 static const char tag_template_nocleanup[] =
126         N_("\nWrite a message for tag:\n  %s\n"
127         "Lines starting with '%c' will be kept; you may remove them"
128         " yourself if you want to.\n");
129
130 /* Parse arg given and add it the ref_sorting array */
131 static int parse_sorting_string(const char *arg, struct ref_sorting **sorting_tail)
132 {
133         struct ref_sorting *s;
134         int len;
135
136         s = xcalloc(1, sizeof(*s));
137         s->next = *sorting_tail;
138         *sorting_tail = s;
139
140         if (*arg == '-') {
141                 s->reverse = 1;
142                 arg++;
143         }
144         if (skip_prefix(arg, "version:", &arg) ||
145             skip_prefix(arg, "v:", &arg))
146                 s->version = 1;
147
148         len = strlen(arg);
149         s->atom = parse_ref_filter_atom(arg, arg+len);
150
151         return 0;
152 }
153
154 static int git_tag_config(const char *var, const char *value, void *cb)
155 {
156         int status;
157         struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
158
159         if (!strcmp(var, "tag.sort")) {
160                 if (!value)
161                         return config_error_nonbool(var);
162                 parse_sorting_string(value, sorting_tail);
163                 return 0;
164         }
165
166         status = git_gpg_config(var, value, cb);
167         if (status)
168                 return status;
169         if (starts_with(var, "column."))
170                 return git_column_config(var, value, "tag", &colopts);
171         return git_default_config(var, value, cb);
172 }
173
174 static void write_tag_body(int fd, const unsigned char *sha1)
175 {
176         unsigned long size;
177         enum object_type type;
178         char *buf, *sp;
179
180         buf = read_sha1_file(sha1, &type, &size);
181         if (!buf)
182                 return;
183         /* skip header */
184         sp = strstr(buf, "\n\n");
185
186         if (!sp || !size || type != OBJ_TAG) {
187                 free(buf);
188                 return;
189         }
190         sp += 2; /* skip the 2 LFs */
191         write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
192
193         free(buf);
194 }
195
196 static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
197 {
198         if (sign && do_sign(buf) < 0)
199                 return error(_("unable to sign the tag"));
200         if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
201                 return error(_("unable to write tag file"));
202         return 0;
203 }
204
205 struct create_tag_options {
206         unsigned int message_given:1;
207         unsigned int sign;
208         enum {
209                 CLEANUP_NONE,
210                 CLEANUP_SPACE,
211                 CLEANUP_ALL
212         } cleanup_mode;
213 };
214
215 static void create_tag(const unsigned char *object, const char *tag,
216                        struct strbuf *buf, struct create_tag_options *opt,
217                        unsigned char *prev, unsigned char *result)
218 {
219         enum object_type type;
220         char header_buf[1024];
221         int header_len;
222         char *path = NULL;
223
224         type = sha1_object_info(object, NULL);
225         if (type <= OBJ_NONE)
226             die(_("bad object type."));
227
228         header_len = snprintf(header_buf, sizeof(header_buf),
229                           "object %s\n"
230                           "type %s\n"
231                           "tag %s\n"
232                           "tagger %s\n\n",
233                           sha1_to_hex(object),
234                           typename(type),
235                           tag,
236                           git_committer_info(IDENT_STRICT));
237
238         if (header_len > sizeof(header_buf) - 1)
239                 die(_("tag header too big."));
240
241         if (!opt->message_given) {
242                 int fd;
243
244                 /* write the template message before editing: */
245                 path = git_pathdup("TAG_EDITMSG");
246                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
247                 if (fd < 0)
248                         die_errno(_("could not create file '%s'"), path);
249
250                 if (!is_null_sha1(prev)) {
251                         write_tag_body(fd, prev);
252                 } else {
253                         struct strbuf buf = STRBUF_INIT;
254                         strbuf_addch(&buf, '\n');
255                         if (opt->cleanup_mode == CLEANUP_ALL)
256                                 strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
257                         else
258                                 strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
259                         write_or_die(fd, buf.buf, buf.len);
260                         strbuf_release(&buf);
261                 }
262                 close(fd);
263
264                 if (launch_editor(path, buf, NULL)) {
265                         fprintf(stderr,
266                         _("Please supply the message using either -m or -F option.\n"));
267                         exit(1);
268                 }
269         }
270
271         if (opt->cleanup_mode != CLEANUP_NONE)
272                 strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
273
274         if (!opt->message_given && !buf->len)
275                 die(_("no tag message?"));
276
277         strbuf_insert(buf, 0, header_buf, header_len);
278
279         if (build_tag_object(buf, opt->sign, result) < 0) {
280                 if (path)
281                         fprintf(stderr, _("The tag message has been left in %s\n"),
282                                 path);
283                 exit(128);
284         }
285         if (path) {
286                 unlink_or_warn(path);
287                 free(path);
288         }
289 }
290
291 struct msg_arg {
292         int given;
293         struct strbuf buf;
294 };
295
296 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
297 {
298         struct msg_arg *msg = opt->value;
299
300         if (!arg)
301                 return -1;
302         if (msg->buf.len)
303                 strbuf_addstr(&(msg->buf), "\n\n");
304         strbuf_addstr(&(msg->buf), arg);
305         msg->given = 1;
306         return 0;
307 }
308
309 static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
310 {
311         if (name[0] == '-')
312                 return -1;
313
314         strbuf_reset(sb);
315         strbuf_addf(sb, "refs/tags/%s", name);
316
317         return check_refname_format(sb->buf, 0);
318 }
319
320 int cmd_tag(int argc, const char **argv, const char *prefix)
321 {
322         struct strbuf buf = STRBUF_INIT;
323         struct strbuf ref = STRBUF_INIT;
324         unsigned char object[20], prev[20];
325         const char *object_ref, *tag;
326         struct create_tag_options opt;
327         char *cleanup_arg = NULL;
328         int create_reflog = 0;
329         int annotate = 0, force = 0;
330         int cmdmode = 0;
331         const char *msgfile = NULL, *keyid = NULL;
332         struct msg_arg msg = { 0, STRBUF_INIT };
333         struct ref_transaction *transaction;
334         struct strbuf err = STRBUF_INIT;
335         struct ref_filter filter;
336         static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
337         const char *format = NULL;
338         struct option options[] = {
339                 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
340                 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
341                                 N_("print <n> lines of each tag message"),
342                                 PARSE_OPT_OPTARG, NULL, 1 },
343                 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
344                 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
345
346                 OPT_GROUP(N_("Tag creation options")),
347                 OPT_BOOL('a', "annotate", &annotate,
348                                         N_("annotated tag, needs a message")),
349                 OPT_CALLBACK('m', "message", &msg, N_("message"),
350                              N_("tag message"), parse_msg_arg),
351                 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
352                 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
353                 OPT_STRING(0, "cleanup", &cleanup_arg, N_("mode"),
354                         N_("how to strip spaces and #comments from message")),
355                 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
356                                         N_("use another key to sign the tag")),
357                 OPT__FORCE(&force, N_("replace the tag if exists")),
358                 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
359
360                 OPT_GROUP(N_("Tag listing options")),
361                 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
362                 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
363                 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
364                 OPT_MERGED(&filter, N_("print only tags that are merged")),
365                 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
366                 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
367                              N_("field name to sort on"), &parse_opt_ref_sorting),
368                 {
369                         OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
370                         N_("print only tags of the object"), 0, parse_opt_object_name
371                 },
372                 OPT_STRING(  0 , "format", &format, N_("format"), N_("format to use for the output")),
373                 OPT_END()
374         };
375
376         git_config(git_tag_config, sorting_tail);
377
378         memset(&opt, 0, sizeof(opt));
379         memset(&filter, 0, sizeof(filter));
380         filter.lines = -1;
381
382         argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
383
384         if (keyid) {
385                 opt.sign = 1;
386                 set_signing_key(keyid);
387         }
388         if (opt.sign)
389                 annotate = 1;
390         if (argc == 0 && !cmdmode)
391                 cmdmode = 'l';
392
393         if ((annotate || msg.given || msgfile || force) && (cmdmode != 0))
394                 usage_with_options(git_tag_usage, options);
395
396         finalize_colopts(&colopts, -1);
397         if (cmdmode == 'l' && filter.lines != -1) {
398                 if (explicitly_enable_column(colopts))
399                         die(_("--column and -n are incompatible"));
400                 colopts = 0;
401         }
402         if (!sorting)
403                 sorting = ref_default_sorting();
404         if (cmdmode == 'l') {
405                 int ret;
406                 if (column_active(colopts)) {
407                         struct column_options copts;
408                         memset(&copts, 0, sizeof(copts));
409                         copts.padding = 2;
410                         run_column_filter(colopts, &copts);
411                 }
412                 filter.name_patterns = argv;
413                 ret = list_tags(&filter, sorting, format);
414                 if (column_active(colopts))
415                         stop_column_filter();
416                 return ret;
417         }
418         if (filter.lines != -1)
419                 die(_("-n option is only allowed with -l."));
420         if (filter.with_commit)
421                 die(_("--contains option is only allowed with -l."));
422         if (filter.points_at.nr)
423                 die(_("--points-at option is only allowed with -l."));
424         if (filter.merge_commit)
425                 die(_("--merged and --no-merged option are only allowed with -l"));
426         if (cmdmode == 'd')
427                 return for_each_tag_name(argv, delete_tag);
428         if (cmdmode == 'v')
429                 return for_each_tag_name(argv, verify_tag);
430
431         if (msg.given || msgfile) {
432                 if (msg.given && msgfile)
433                         die(_("only one -F or -m option is allowed."));
434                 annotate = 1;
435                 if (msg.given)
436                         strbuf_addbuf(&buf, &(msg.buf));
437                 else {
438                         if (!strcmp(msgfile, "-")) {
439                                 if (strbuf_read(&buf, 0, 1024) < 0)
440                                         die_errno(_("cannot read '%s'"), msgfile);
441                         } else {
442                                 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
443                                         die_errno(_("could not open or read '%s'"),
444                                                 msgfile);
445                         }
446                 }
447         }
448
449         tag = argv[0];
450
451         object_ref = argc == 2 ? argv[1] : "HEAD";
452         if (argc > 2)
453                 die(_("too many params"));
454
455         if (get_sha1(object_ref, object))
456                 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
457
458         if (strbuf_check_tag_ref(&ref, tag))
459                 die(_("'%s' is not a valid tag name."), tag);
460
461         if (read_ref(ref.buf, prev))
462                 hashclr(prev);
463         else if (!force)
464                 die(_("tag '%s' already exists"), tag);
465
466         opt.message_given = msg.given || msgfile;
467
468         if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
469                 opt.cleanup_mode = CLEANUP_ALL;
470         else if (!strcmp(cleanup_arg, "verbatim"))
471                 opt.cleanup_mode = CLEANUP_NONE;
472         else if (!strcmp(cleanup_arg, "whitespace"))
473                 opt.cleanup_mode = CLEANUP_SPACE;
474         else
475                 die(_("Invalid cleanup mode %s"), cleanup_arg);
476
477         if (annotate)
478                 create_tag(object, tag, &buf, &opt, prev, object);
479
480         transaction = ref_transaction_begin(&err);
481         if (!transaction ||
482             ref_transaction_update(transaction, ref.buf, object, prev,
483                                    create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
484                                    NULL, &err) ||
485             ref_transaction_commit(transaction, &err))
486                 die("%s", err.buf);
487         ref_transaction_free(transaction);
488         if (force && !is_null_sha1(prev) && hashcmp(prev, object))
489                 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
490
491         strbuf_release(&err);
492         strbuf_release(&buf);
493         strbuf_release(&ref);
494         return 0;
495 }