Documentation: help: specify supported html browsers.
[git/dscho.git] / builtin-tag.c
blob03e70155fc676a8dd38ca5cef800ed4a446e921a
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];
54                 if (strcspn(editor, "$ \t'") != len) {
55                         /* there are specials */
56                         args[i++] = "sh";
57                         args[i++] = "-c";
58                         args[i++] = "$0 \"$@\"";
59                 }
60                 args[i++] = editor;
61                 args[i++] = path;
62                 args[i] = NULL;
64                 if (run_command_v_opt_cd_env(args, 0, NULL, env))
65                         die("There was a problem with the editor %s.", editor);
66         }
68         if (!buffer)
69                 return;
70         if (strbuf_read_file(buffer, path, 0) < 0)
71                 die("could not read message file '%s': %s",
72                     path, strerror(errno));
75 struct tag_filter {
76         const char *pattern;
77         int lines;
80 #define PGP_SIGNATURE "-----BEGIN PGP SIGNATURE-----"
82 static int show_reference(const char *refname, const unsigned char *sha1,
83                           int flag, void *cb_data)
85         struct tag_filter *filter = cb_data;
87         if (!fnmatch(filter->pattern, refname, 0)) {
88                 int i;
89                 unsigned long size;
90                 enum object_type type;
91                 char *buf, *sp, *eol;
92                 size_t len;
94                 if (!filter->lines) {
95                         printf("%s\n", refname);
96                         return 0;
97                 }
98                 printf("%-15s ", refname);
100                 buf = read_sha1_file(sha1, &type, &size);
101                 if (!buf || !size)
102                         return 0;
104                 /* skip header */
105                 sp = strstr(buf, "\n\n");
106                 if (!sp) {
107                         free(buf);
108                         return 0;
109                 }
110                 /* only take up to "lines" lines, and strip the signature */
111                 for (i = 0, sp += 2;
112                                 i < filter->lines && sp < buf + size &&
113                                 prefixcmp(sp, PGP_SIGNATURE "\n");
114                                 i++) {
115                         if (i)
116                                 printf("\n    ");
117                         eol = memchr(sp, '\n', size - (sp - buf));
118                         len = eol ? eol - sp : size - (sp - buf);
119                         fwrite(sp, len, 1, stdout);
120                         if (!eol)
121                                 break;
122                         sp = eol + 1;
123                 }
124                 putchar('\n');
125                 free(buf);
126         }
128         return 0;
131 static int list_tags(const char *pattern, int lines)
133         struct tag_filter filter;
135         if (pattern == NULL)
136                 pattern = "*";
138         filter.pattern = pattern;
139         filter.lines = lines;
141         for_each_tag_ref(show_reference, (void *) &filter);
143         return 0;
146 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
147                                 const unsigned char *sha1);
149 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
151         const char **p;
152         char ref[PATH_MAX];
153         int had_error = 0;
154         unsigned char sha1[20];
156         for (p = argv; *p; p++) {
157                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
158                                         >= sizeof(ref)) {
159                         error("tag name too long: %.*s...", 50, *p);
160                         had_error = 1;
161                         continue;
162                 }
163                 if (!resolve_ref(ref, sha1, 1, NULL)) {
164                         error("tag '%s' not found.", *p);
165                         had_error = 1;
166                         continue;
167                 }
168                 if (fn(*p, ref, sha1))
169                         had_error = 1;
170         }
171         return had_error;
174 static int delete_tag(const char *name, const char *ref,
175                                 const unsigned char *sha1)
177         if (delete_ref(ref, sha1))
178                 return 1;
179         printf("Deleted tag '%s'\n", name);
180         return 0;
183 static int verify_tag(const char *name, const char *ref,
184                                 const unsigned char *sha1)
186         const char *argv_verify_tag[] = {"git-verify-tag",
187                                         "-v", "SHA1_HEX", NULL};
188         argv_verify_tag[2] = sha1_to_hex(sha1);
190         if (run_command_v_opt(argv_verify_tag, 0))
191                 return error("could not verify the tag '%s'", name);
192         return 0;
195 static int do_sign(struct strbuf *buffer)
197         struct child_process gpg;
198         const char *args[4];
199         char *bracket;
200         int len;
202         if (!*signingkey) {
203                 if (strlcpy(signingkey, git_committer_info(IDENT_ERROR_ON_NO_NAME),
204                                 sizeof(signingkey)) > sizeof(signingkey) - 1)
205                         return error("committer info too long.");
206                 bracket = strchr(signingkey, '>');
207                 if (bracket)
208                         bracket[1] = '\0';
209         }
211         /* When the username signingkey is bad, program could be terminated
212          * because gpg exits without reading and then write gets SIGPIPE. */
213         signal(SIGPIPE, SIG_IGN);
215         memset(&gpg, 0, sizeof(gpg));
216         gpg.argv = args;
217         gpg.in = -1;
218         gpg.out = -1;
219         args[0] = "gpg";
220         args[1] = "-bsau";
221         args[2] = signingkey;
222         args[3] = NULL;
224         if (start_command(&gpg))
225                 return error("could not run gpg.");
227         if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
228                 close(gpg.in);
229                 finish_command(&gpg);
230                 return error("gpg did not accept the tag data");
231         }
232         close(gpg.in);
233         gpg.close_in = 0;
234         len = strbuf_read(buffer, gpg.out, 1024);
236         if (finish_command(&gpg) || !len || len < 0)
237                 return error("gpg failed to sign the tag");
239         if (len < 0)
240                 return error("could not read the entire signature from gpg.");
242         return 0;
245 static const char tag_template[] =
246         "\n"
247         "#\n"
248         "# Write a tag message\n"
249         "#\n";
251 static void set_signingkey(const char *value)
253         if (strlcpy(signingkey, value, sizeof(signingkey)) >= sizeof(signingkey))
254                 die("signing key value too long (%.10s...)", value);
257 static int git_tag_config(const char *var, const char *value)
259         if (!strcmp(var, "user.signingkey")) {
260                 if (!value)
261                         die("user.signingkey without value");
262                 set_signingkey(value);
263                 return 0;
264         }
266         return git_default_config(var, value);
269 static void write_tag_body(int fd, const unsigned char *sha1)
271         unsigned long size;
272         enum object_type type;
273         char *buf, *sp, *eob;
274         size_t len;
276         buf = read_sha1_file(sha1, &type, &size);
277         if (!buf)
278                 return;
279         /* skip header */
280         sp = strstr(buf, "\n\n");
282         if (!sp || !size || type != OBJ_TAG) {
283                 free(buf);
284                 return;
285         }
286         sp += 2; /* skip the 2 LFs */
287         eob = strstr(sp, "\n" PGP_SIGNATURE "\n");
288         if (eob)
289                 len = eob - sp;
290         else
291                 len = buf + size - sp;
292         write_or_die(fd, sp, len);
294         free(buf);
297 static void create_tag(const unsigned char *object, const char *tag,
298                        struct strbuf *buf, int message, int sign,
299                        unsigned char *prev, unsigned char *result)
301         enum object_type type;
302         char header_buf[1024];
303         int header_len;
305         type = sha1_object_info(object, NULL);
306         if (type <= OBJ_NONE)
307             die("bad object type.");
309         header_len = snprintf(header_buf, sizeof(header_buf),
310                           "object %s\n"
311                           "type %s\n"
312                           "tag %s\n"
313                           "tagger %s\n\n",
314                           sha1_to_hex(object),
315                           typename(type),
316                           tag,
317                           git_committer_info(IDENT_ERROR_ON_NO_NAME));
319         if (header_len > sizeof(header_buf) - 1)
320                 die("tag header too big.");
322         if (!message) {
323                 char *path;
324                 int fd;
326                 /* write the template message before editing: */
327                 path = xstrdup(git_path("TAG_EDITMSG"));
328                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
329                 if (fd < 0)
330                         die("could not create file '%s': %s",
331                                                 path, strerror(errno));
333                 if (!is_null_sha1(prev))
334                         write_tag_body(fd, prev);
335                 else
336                         write_or_die(fd, tag_template, strlen(tag_template));
337                 close(fd);
339                 launch_editor(path, buf, NULL);
341                 unlink(path);
342                 free(path);
343         }
345         stripspace(buf, 1);
347         if (!message && !buf->len)
348                 die("no tag message?");
350         strbuf_insert(buf, 0, header_buf, header_len);
352         if (sign && do_sign(buf) < 0)
353                 die("unable to sign the tag");
354         if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
355                 die("unable to write tag file");
358 struct msg_arg {
359         int given;
360         struct strbuf buf;
363 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
365         struct msg_arg *msg = opt->value;
367         if (!arg)
368                 return -1;
369         if (msg->buf.len)
370                 strbuf_addstr(&(msg->buf), "\n\n");
371         strbuf_addstr(&(msg->buf), arg);
372         msg->given = 1;
373         return 0;
376 int cmd_tag(int argc, const char **argv, const char *prefix)
378         struct strbuf buf;
379         unsigned char object[20], prev[20];
380         char ref[PATH_MAX];
381         const char *object_ref, *tag;
382         struct ref_lock *lock;
384         int annotate = 0, sign = 0, force = 0, lines = 0,
385                 list = 0, delete = 0, verify = 0;
386         char *msgfile = NULL, *keyid = NULL;
387         struct msg_arg msg = { 0, STRBUF_INIT };
388         struct option options[] = {
389                 OPT_BOOLEAN('l', NULL, &list, "list tag names"),
390                 { OPTION_INTEGER, 'n', NULL, &lines, NULL,
391                                 "print n lines of each tag message",
392                                 PARSE_OPT_OPTARG, NULL, 1 },
393                 OPT_BOOLEAN('d', NULL, &delete, "delete tags"),
394                 OPT_BOOLEAN('v', NULL, &verify, "verify tags"),
396                 OPT_GROUP("Tag creation options"),
397                 OPT_BOOLEAN('a', NULL, &annotate,
398                                         "annotated tag, needs a message"),
399                 OPT_CALLBACK('m', NULL, &msg, "msg",
400                              "message for the tag", parse_msg_arg),
401                 OPT_STRING('F', NULL, &msgfile, "file", "message in a file"),
402                 OPT_BOOLEAN('s', NULL, &sign, "annotated and GPG-signed tag"),
403                 OPT_STRING('u', NULL, &keyid, "key-id",
404                                         "use another key to sign the tag"),
405                 OPT_BOOLEAN('f', NULL, &force, "replace the tag if exists"),
406                 OPT_END()
407         };
409         git_config(git_tag_config);
411         argc = parse_options(argc, argv, options, git_tag_usage, 0);
413         if (keyid) {
414                 sign = 1;
415                 set_signingkey(keyid);
416         }
417         if (sign)
418                 annotate = 1;
420         if (list)
421                 return list_tags(argv[0], lines);
422         if (delete)
423                 return for_each_tag_name(argv, delete_tag);
424         if (verify)
425                 return for_each_tag_name(argv, verify_tag);
427         strbuf_init(&buf, 0);
428         if (msg.given || msgfile) {
429                 if (msg.given && msgfile)
430                         die("only one -F or -m option is allowed.");
431                 annotate = 1;
432                 if (msg.given)
433                         strbuf_addbuf(&buf, &(msg.buf));
434                 else {
435                         if (!strcmp(msgfile, "-")) {
436                                 if (strbuf_read(&buf, 0, 1024) < 0)
437                                         die("cannot read %s", msgfile);
438                         } else {
439                                 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
440                                         die("could not open or read '%s': %s",
441                                                 msgfile, strerror(errno));
442                         }
443                 }
444         }
446         if (argc == 0) {
447                 if (annotate)
448                         usage_with_options(git_tag_usage, options);
449                 return list_tags(NULL, lines);
450         }
451         tag = argv[0];
453         object_ref = argc == 2 ? argv[1] : "HEAD";
454         if (argc > 2)
455                 die("too many params");
457         if (get_sha1(object_ref, object))
458                 die("Failed to resolve '%s' as a valid ref.", object_ref);
460         if (snprintf(ref, sizeof(ref), "refs/tags/%s", tag) > sizeof(ref) - 1)
461                 die("tag name too long: %.*s...", 50, tag);
462         if (check_ref_format(ref))
463                 die("'%s' is not a valid tag name.", tag);
465         if (!resolve_ref(ref, prev, 1, NULL))
466                 hashclr(prev);
467         else if (!force)
468                 die("tag '%s' already exists", tag);
470         if (annotate)
471                 create_tag(object, tag, &buf, msg.given || msgfile,
472                            sign, prev, object);
474         lock = lock_any_ref_for_update(ref, prev, 0);
475         if (!lock)
476                 die("%s: cannot lock the ref", ref);
477         if (write_ref_sha1(lock, object, NULL) < 0)
478                 die("%s: cannot update the ref", ref);
480         strbuf_release(&buf);
481         return 0;