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"
15 static const char builtin_tag_usage[] =
16 "git-tag [-n [<num>]] -l [<pattern>] | [-a | -s | -u <key-id>] [-f | -d | -v] [-m <msg> | -F <file>] <tagname> [<head>]";
18 static char signingkey[1000];
20 static void launch_editor(const char *path, struct strbuf *buffer)
22 const char *editor, *terminal;
23 struct child_process child;
26 editor = getenv("GIT_EDITOR");
27 if (!editor && editor_program)
28 editor = editor_program;
30 editor = getenv("VISUAL");
32 editor = getenv("EDITOR");
34 terminal = getenv("TERM");
35 if (!editor && (!terminal || !strcmp(terminal, "dumb"))) {
37 "Terminal is dumb but no VISUAL nor EDITOR defined.\n"
38 "Please supply the message using either -m or -F option.\n");
45 memset(&child, 0, sizeof(child));
51 if (run_command(&child))
52 die("There was a problem with the editor %s.", editor);
54 if (strbuf_read_file(buffer, path, 0) < 0)
55 die("could not read message file '%s': %s",
56 path, strerror(errno));
64 #define PGP_SIGNATURE "-----BEGIN PGP SIGNATURE-----"
66 static int show_reference(const char *refname, const unsigned char *sha1,
67 int flag, void *cb_data)
69 struct tag_filter *filter = cb_data;
71 if (!fnmatch(filter->pattern, refname, 0)) {
74 enum object_type type;
79 printf("%s\n", refname);
82 printf("%-15s ", refname);
84 sp = buf = read_sha1_file(sha1, &type, &size);
92 while (sp + 1 < buf + size &&
93 !(sp[0] == '\n' && sp[1] == '\n'))
95 /* only take up to "lines" lines, and strip the signature */
97 i < filter->lines && sp < buf + size &&
98 prefixcmp(sp, PGP_SIGNATURE "\n");
102 eol = memchr(sp, '\n', size - (sp - buf));
103 len = eol ? eol - sp : size - (sp - buf);
104 fwrite(sp, len, 1, stdout);
116 static int list_tags(const char *pattern, int lines)
118 struct tag_filter filter;
123 filter.pattern = pattern;
124 filter.lines = lines;
126 for_each_tag_ref(show_reference, (void *) &filter);
131 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
132 const unsigned char *sha1);
134 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
139 unsigned char sha1[20];
141 for (p = argv; *p; p++) {
142 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
144 error("tag name too long: %.*s...", 50, *p);
148 if (!resolve_ref(ref, sha1, 1, NULL)) {
149 error("tag '%s' not found.", *p);
153 if (fn(*p, ref, sha1))
159 static int delete_tag(const char *name, const char *ref,
160 const unsigned char *sha1)
162 if (delete_ref(ref, sha1))
164 printf("Deleted tag '%s'\n", name);
168 static int verify_tag(const char *name, const char *ref,
169 const unsigned char *sha1)
171 const char *argv_verify_tag[] = {"git-verify-tag",
172 "-v", "SHA1_HEX", NULL};
173 argv_verify_tag[2] = sha1_to_hex(sha1);
175 if (run_command_v_opt(argv_verify_tag, 0))
176 return error("could not verify the tag '%s'", name);
180 static int do_sign(struct strbuf *buffer)
182 struct child_process gpg;
188 if (strlcpy(signingkey, git_committer_info(1),
189 sizeof(signingkey)) > sizeof(signingkey) - 1)
190 return error("committer info too long.");
191 bracket = strchr(signingkey, '>');
196 /* When the username signingkey is bad, program could be terminated
197 * because gpg exits without reading and then write gets SIGPIPE. */
198 signal(SIGPIPE, SIG_IGN);
200 memset(&gpg, 0, sizeof(gpg));
206 args[2] = signingkey;
209 if (start_command(&gpg))
210 return error("could not run gpg.");
212 if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
214 finish_command(&gpg);
215 return error("gpg did not accept the tag data");
219 len = strbuf_read(buffer, gpg.out, 1024);
221 if (finish_command(&gpg) || !len || len < 0)
222 return error("gpg failed to sign the tag");
225 return error("could not read the entire signature from gpg.");
230 static const char tag_template[] =
233 "# Write a tag message\n"
236 static int git_tag_config(const char *var, const char *value)
238 if (!strcmp(var, "user.signingkey")) {
240 die("user.signingkey without value");
241 if (strlcpy(signingkey, value, sizeof(signingkey))
242 >= sizeof(signingkey))
243 die("user.signingkey value too long");
247 return git_default_config(var, value);
250 static void write_tag_body(int fd, const unsigned char *sha1)
253 enum object_type type;
254 char *buf, *sp, *eob;
257 buf = read_sha1_file(sha1, &type, &size);
261 sp = strstr(buf, "\n\n");
263 if (!sp || !size || type != OBJ_TAG) {
267 sp += 2; /* skip the 2 LFs */
268 eob = strstr(sp, "\n" PGP_SIGNATURE "\n");
272 len = buf + size - sp;
273 write_or_die(fd, sp, len);
278 static void create_tag(const unsigned char *object, const char *tag,
279 struct strbuf *buf, int message, int sign,
280 unsigned char *prev, unsigned char *result)
282 enum object_type type;
283 char header_buf[1024];
286 type = sha1_object_info(object, NULL);
287 if (type <= OBJ_NONE)
288 die("bad object type.");
290 header_len = snprintf(header_buf, sizeof(header_buf),
298 git_committer_info(1));
300 if (header_len > sizeof(header_buf) - 1)
301 die("tag header too big.");
307 /* write the template message before editing: */
308 path = xstrdup(git_path("TAG_EDITMSG"));
309 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
311 die("could not create file '%s': %s",
312 path, strerror(errno));
314 if (!is_null_sha1(prev))
315 write_tag_body(fd, prev);
317 write_or_die(fd, tag_template, strlen(tag_template));
320 launch_editor(path, buf);
328 if (!message && !buf->len)
329 die("no tag message?");
331 strbuf_insert(buf, 0, header_buf, header_len);
333 if (sign && do_sign(buf) < 0)
334 die("unable to sign the tag");
335 if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
336 die("unable to write tag file");
339 int cmd_tag(int argc, const char **argv, const char *prefix)
342 unsigned char object[20], prev[20];
343 int annotate = 0, sign = 0, force = 0, lines = 0, message = 0;
345 const char *object_ref, *tag;
347 struct ref_lock *lock;
349 git_config(git_tag_config);
350 strbuf_init(&buf, 0);
352 for (i = 1; i < argc; i++) {
353 const char *arg = argv[i];
357 if (!strcmp(arg, "-a")) {
361 if (!strcmp(arg, "-s")) {
366 if (!strcmp(arg, "-f")) {
370 if (!strcmp(arg, "-n")) {
371 if (i + 1 == argc || *argv[i + 1] == '-')
375 lines = isdigit(*argv[++i]) ?
379 if (!strcmp(arg, "-m")) {
383 die("option -m needs an argument.");
385 die("only one -F or -m option is allowed.");
386 strbuf_addstr(&buf, argv[i]);
390 if (!strcmp(arg, "-F")) {
394 die("option -F needs an argument.");
396 die("only one -F or -m option is allowed.");
398 if (!strcmp(argv[i], "-")) {
399 if (strbuf_read(&buf, 0, 1024) < 0)
400 die("cannot read %s", argv[i]);
402 if (strbuf_read_file(&buf, argv[i], 1024) < 0)
403 die("could not open or read '%s': %s",
404 argv[i], strerror(errno));
409 if (!strcmp(arg, "-u")) {
414 die("option -u needs an argument.");
415 if (strlcpy(signingkey, argv[i], sizeof(signingkey))
416 >= sizeof(signingkey))
417 die("argument to option -u too long");
420 if (!strcmp(arg, "-l"))
421 return list_tags(argv[i + 1], lines);
422 if (!strcmp(arg, "-d"))
423 return for_each_tag_name(argv + i + 1, delete_tag);
424 if (!strcmp(arg, "-v"))
425 return for_each_tag_name(argv + i + 1, verify_tag);
426 usage(builtin_tag_usage);
431 usage(builtin_tag_usage);
432 return list_tags(NULL, lines);
436 object_ref = i < argc ? argv[i] : "HEAD";
438 die("too many params");
440 if (get_sha1(object_ref, object))
441 die("Failed to resolve '%s' as a valid ref.", object_ref);
443 if (snprintf(ref, sizeof(ref), "refs/tags/%s", tag) > sizeof(ref) - 1)
444 die("tag name too long: %.*s...", 50, tag);
445 if (check_ref_format(ref))
446 die("'%s' is not a valid tag name.", tag);
448 if (!resolve_ref(ref, prev, 1, NULL))
451 die("tag '%s' already exists", tag);
454 create_tag(object, tag, &buf, message, sign, prev, object);
456 lock = lock_any_ref_for_update(ref, prev, 0);
458 die("%s: cannot lock the ref", ref);
459 if (write_ref_sha1(lock, object, NULL) < 0)
460 die("%s: cannot update the ref", ref);
462 strbuf_release(&buf);