Documentation: help: describe 'man.viewer' config variable
[git/dscho.git] / builtin-tag.c
blob8dd959fe1c74507023f8e82c7f4682c1588ebac6
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  */
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"
16 static const char * const git_tag_usage[] = {
17         "git-tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]",
18         "git-tag -d <tagname>...",
19         "git-tag -l [-n [<num>]] [<pattern>]",
20         "git-tag -v <tagname>...",
21         NULL
24 static char signingkey[1000];
26 void launch_editor(const char *path, struct strbuf *buffer, const char *const *env)
28         const char *editor, *terminal;
30         editor = getenv("GIT_EDITOR");
31         if (!editor && editor_program)
32                 editor = editor_program;
33         if (!editor)
34                 editor = getenv("VISUAL");
35         if (!editor)
36                 editor = getenv("EDITOR");
38         terminal = getenv("TERM");
39         if (!editor && (!terminal || !strcmp(terminal, "dumb"))) {
40                 fprintf(stderr,
41                 "Terminal is dumb but no VISUAL nor EDITOR defined.\n"
42                 "Please supply the message using either -m or -F option.\n");
43                 exit(1);
44         }
46         if (!editor)
47                 editor = "vi";
49         if (strcmp(editor, ":")) {
50                 size_t len = strlen(editor);
51                 int i = 0;
52                 const char *args[6];
53                 struct strbuf arg0;
55                 strbuf_init(&arg0, 0);
56                 if (strcspn(editor, "$ \t'") != len) {
57                         /* there are specials */
58                         strbuf_addf(&arg0, "%s \"$@\"", editor);
59                         args[i++] = "sh";
60                         args[i++] = "-c";
61                         args[i++] = arg0.buf;
62                 }
63                 args[i++] = editor;
64                 args[i++] = path;
65                 args[i] = NULL;
67                 if (run_command_v_opt_cd_env(args, 0, NULL, env))
68                         die("There was a problem with the editor %s.", editor);
69                 strbuf_release(&arg0);
70         }
72         if (!buffer)
73                 return;
74         if (strbuf_read_file(buffer, path, 0) < 0)
75                 die("could not read message file '%s': %s",
76                     path, strerror(errno));
79 struct tag_filter {
80         const char *pattern;
81         int lines;
84 #define PGP_SIGNATURE "-----BEGIN PGP SIGNATURE-----"
86 static int show_reference(const char *refname, const unsigned char *sha1,
87                           int flag, void *cb_data)
89         struct tag_filter *filter = cb_data;
91         if (!fnmatch(filter->pattern, refname, 0)) {
92                 int i;
93                 unsigned long size;
94                 enum object_type type;
95                 char *buf, *sp, *eol;
96                 size_t len;
98                 if (!filter->lines) {
99                         printf("%s\n", refname);
100                         return 0;
101                 }
102                 printf("%-15s ", refname);
104                 buf = read_sha1_file(sha1, &type, &size);
105                 if (!buf || !size)
106                         return 0;
108                 /* skip header */
109                 sp = strstr(buf, "\n\n");
110                 if (!sp) {
111                         free(buf);
112                         return 0;
113                 }
114                 /* only take up to "lines" lines, and strip the signature */
115                 for (i = 0, sp += 2;
116                                 i < filter->lines && sp < buf + size &&
117                                 prefixcmp(sp, PGP_SIGNATURE "\n");
118                                 i++) {
119                         if (i)
120                                 printf("\n    ");
121                         eol = memchr(sp, '\n', size - (sp - buf));
122                         len = eol ? eol - sp : size - (sp - buf);
123                         fwrite(sp, len, 1, stdout);
124                         if (!eol)
125                                 break;
126                         sp = eol + 1;
127                 }
128                 putchar('\n');
129                 free(buf);
130         }
132         return 0;
135 static int list_tags(const char *pattern, int lines)
137         struct tag_filter filter;
139         if (pattern == NULL)
140                 pattern = "*";
142         filter.pattern = pattern;
143         filter.lines = lines;
145         for_each_tag_ref(show_reference, (void *) &filter);
147         return 0;
150 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
151                                 const unsigned char *sha1);
153 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
155         const char **p;
156         char ref[PATH_MAX];
157         int had_error = 0;
158         unsigned char sha1[20];
160         for (p = argv; *p; p++) {
161                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
162                                         >= sizeof(ref)) {
163                         error("tag name too long: %.*s...", 50, *p);
164                         had_error = 1;
165                         continue;
166                 }
167                 if (!resolve_ref(ref, sha1, 1, NULL)) {
168                         error("tag '%s' not found.", *p);
169                         had_error = 1;
170                         continue;
171                 }
172                 if (fn(*p, ref, sha1))
173                         had_error = 1;
174         }
175         return had_error;
178 static int delete_tag(const char *name, const char *ref,
179                                 const unsigned char *sha1)
181         if (delete_ref(ref, sha1))
182                 return 1;
183         printf("Deleted tag '%s'\n", name);
184         return 0;
187 static int verify_tag(const char *name, const char *ref,
188                                 const unsigned char *sha1)
190         const char *argv_verify_tag[] = {"git-verify-tag",
191                                         "-v", "SHA1_HEX", NULL};
192         argv_verify_tag[2] = sha1_to_hex(sha1);
194         if (run_command_v_opt(argv_verify_tag, 0))
195                 return error("could not verify the tag '%s'", name);
196         return 0;
199 static int do_sign(struct strbuf *buffer)
201         struct child_process gpg;
202         const char *args[4];
203         char *bracket;
204         int len;
206         if (!*signingkey) {
207                 if (strlcpy(signingkey, git_committer_info(IDENT_ERROR_ON_NO_NAME),
208                                 sizeof(signingkey)) > sizeof(signingkey) - 1)
209                         return error("committer info too long.");
210                 bracket = strchr(signingkey, '>');
211                 if (bracket)
212                         bracket[1] = '\0';
213         }
215         /* When the username signingkey is bad, program could be terminated
216          * because gpg exits without reading and then write gets SIGPIPE. */
217         signal(SIGPIPE, SIG_IGN);
219         memset(&gpg, 0, sizeof(gpg));
220         gpg.argv = args;
221         gpg.in = -1;
222         gpg.out = -1;
223         args[0] = "gpg";
224         args[1] = "-bsau";
225         args[2] = signingkey;
226         args[3] = NULL;
228         if (start_command(&gpg))
229                 return error("could not run gpg.");
231         if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
232                 close(gpg.in);
233                 close(gpg.out);
234                 finish_command(&gpg);
235                 return error("gpg did not accept the tag data");
236         }
237         close(gpg.in);
238         len = strbuf_read(buffer, gpg.out, 1024);
239         close(gpg.out);
241         if (finish_command(&gpg) || !len || len < 0)
242                 return error("gpg failed to sign the tag");
244         return 0;
247 static const char tag_template[] =
248         "\n"
249         "#\n"
250         "# Write a tag message\n"
251         "#\n";
253 static void set_signingkey(const char *value)
255         if (strlcpy(signingkey, value, sizeof(signingkey)) >= sizeof(signingkey))
256                 die("signing key value too long (%.10s...)", value);
259 static int git_tag_config(const char *var, const char *value)
261         if (!strcmp(var, "user.signingkey")) {
262                 if (!value)
263                         return config_error_nonbool(value);
264                 set_signingkey(value);
265                 return 0;
266         }
268         return git_default_config(var, value);
271 static void write_tag_body(int fd, const unsigned char *sha1)
273         unsigned long size;
274         enum object_type type;
275         char *buf, *sp, *eob;
276         size_t len;
278         buf = read_sha1_file(sha1, &type, &size);
279         if (!buf)
280                 return;
281         /* skip header */
282         sp = strstr(buf, "\n\n");
284         if (!sp || !size || type != OBJ_TAG) {
285                 free(buf);
286                 return;
287         }
288         sp += 2; /* skip the 2 LFs */
289         eob = strstr(sp, "\n" PGP_SIGNATURE "\n");
290         if (eob)
291                 len = eob - sp;
292         else
293                 len = buf + size - sp;
294         write_or_die(fd, sp, len);
296         free(buf);
299 static void create_tag(const unsigned char *object, const char *tag,
300                        struct strbuf *buf, int message, int sign,
301                        unsigned char *prev, unsigned char *result)
303         enum object_type type;
304         char header_buf[1024];
305         int header_len;
307         type = sha1_object_info(object, NULL);
308         if (type <= OBJ_NONE)
309             die("bad object type.");
311         header_len = snprintf(header_buf, sizeof(header_buf),
312                           "object %s\n"
313                           "type %s\n"
314                           "tag %s\n"
315                           "tagger %s\n\n",
316                           sha1_to_hex(object),
317                           typename(type),
318                           tag,
319                           git_committer_info(IDENT_ERROR_ON_NO_NAME));
321         if (header_len > sizeof(header_buf) - 1)
322                 die("tag header too big.");
324         if (!message) {
325                 char *path;
326                 int fd;
328                 /* write the template message before editing: */
329                 path = xstrdup(git_path("TAG_EDITMSG"));
330                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
331                 if (fd < 0)
332                         die("could not create file '%s': %s",
333                                                 path, strerror(errno));
335                 if (!is_null_sha1(prev))
336                         write_tag_body(fd, prev);
337                 else
338                         write_or_die(fd, tag_template, strlen(tag_template));
339                 close(fd);
341                 launch_editor(path, buf, NULL);
343                 unlink(path);
344                 free(path);
345         }
347         stripspace(buf, 1);
349         if (!message && !buf->len)
350                 die("no tag message?");
352         strbuf_insert(buf, 0, header_buf, header_len);
354         if (sign && do_sign(buf) < 0)
355                 die("unable to sign the tag");
356         if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
357                 die("unable to write tag file");
360 struct msg_arg {
361         int given;
362         struct strbuf buf;
365 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
367         struct msg_arg *msg = opt->value;
369         if (!arg)
370                 return -1;
371         if (msg->buf.len)
372                 strbuf_addstr(&(msg->buf), "\n\n");
373         strbuf_addstr(&(msg->buf), arg);
374         msg->given = 1;
375         return 0;
378 int cmd_tag(int argc, const char **argv, const char *prefix)
380         struct strbuf buf;
381         unsigned char object[20], prev[20];
382         char ref[PATH_MAX];
383         const char *object_ref, *tag;
384         struct ref_lock *lock;
386         int annotate = 0, sign = 0, force = 0, lines = 0,
387                 list = 0, delete = 0, verify = 0;
388         char *msgfile = NULL, *keyid = NULL;
389         struct msg_arg msg = { 0, STRBUF_INIT };
390         struct option options[] = {
391                 OPT_BOOLEAN('l', NULL, &list, "list tag names"),
392                 { OPTION_INTEGER, 'n', NULL, &lines, NULL,
393                                 "print n lines of each tag message",
394                                 PARSE_OPT_OPTARG, NULL, 1 },
395                 OPT_BOOLEAN('d', NULL, &delete, "delete tags"),
396                 OPT_BOOLEAN('v', NULL, &verify, "verify tags"),
398                 OPT_GROUP("Tag creation options"),
399                 OPT_BOOLEAN('a', NULL, &annotate,
400                                         "annotated tag, needs a message"),
401                 OPT_CALLBACK('m', NULL, &msg, "msg",
402                              "message for the tag", parse_msg_arg),
403                 OPT_STRING('F', NULL, &msgfile, "file", "message in a file"),
404                 OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
405                 OPT_STRING('u', NULL, &keyid, "key-id",
406                                         "use another key to sign the tag"),
407                 OPT_BOOLEAN('f', NULL, &force, "replace the tag if exists"),
408                 OPT_END()
409         };
411         git_config(git_tag_config);
413         argc = parse_options(argc, argv, options, git_tag_usage, 0);
415         if (keyid) {
416                 sign = 1;
417                 set_signingkey(keyid);
418         }
419         if (sign)
420                 annotate = 1;
422         if (list)
423                 return list_tags(argv[0], lines);
424         if (delete)
425                 return for_each_tag_name(argv, delete_tag);
426         if (verify)
427                 return for_each_tag_name(argv, verify_tag);
429         strbuf_init(&buf, 0);
430         if (msg.given || msgfile) {
431                 if (msg.given && msgfile)
432                         die("only one -F or -m option is allowed.");
433                 annotate = 1;
434                 if (msg.given)
435                         strbuf_addbuf(&buf, &(msg.buf));
436                 else {
437                         if (!strcmp(msgfile, "-")) {
438                                 if (strbuf_read(&buf, 0, 1024) < 0)
439                                         die("cannot read %s", msgfile);
440                         } else {
441                                 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
442                                         die("could not open or read '%s': %s",
443                                                 msgfile, strerror(errno));
444                         }
445                 }
446         }
448         if (argc == 0) {
449                 if (annotate)
450                         usage_with_options(git_tag_usage, options);
451                 return list_tags(NULL, lines);
452         }
453         tag = argv[0];
455         object_ref = argc == 2 ? argv[1] : "HEAD";
456         if (argc > 2)
457                 die("too many params");
459         if (get_sha1(object_ref, object))
460                 die("Failed to resolve '%s' as a valid ref.", object_ref);
462         if (snprintf(ref, sizeof(ref), "refs/tags/%s", tag) > sizeof(ref) - 1)
463                 die("tag name too long: %.*s...", 50, tag);
464         if (check_ref_format(ref))
465                 die("'%s' is not a valid tag name.", tag);
467         if (!resolve_ref(ref, prev, 1, NULL))
468                 hashclr(prev);
469         else if (!force)
470                 die("tag '%s' already exists", tag);
472         if (annotate)
473                 create_tag(object, tag, &buf, msg.given || msgfile,
474                            sign, prev, object);
476         lock = lock_any_ref_for_update(ref, prev, 0);
477         if (!lock)
478                 die("%s: cannot lock the ref", ref);
479         if (write_ref_sha1(lock, object, NULL) < 0)
480                 die("%s: cannot update the ref", ref);
482         strbuf_release(&buf);
483         return 0;