Merge branch 'bg/format-patch-N'
[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
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>]";
17
18 static char signingkey[1000];
19
20 static void launch_editor(const char *path, struct strbuf *buffer)
21 {
22         const char *editor, *terminal;
23         struct child_process child;
24         const char *args[3];
25
26         editor = getenv("GIT_EDITOR");
27         if (!editor && editor_program)
28                 editor = editor_program;
29         if (!editor)
30                 editor = getenv("VISUAL");
31         if (!editor)
32                 editor = getenv("EDITOR");
33
34         terminal = getenv("TERM");
35         if (!editor && (!terminal || !strcmp(terminal, "dumb"))) {
36                 fprintf(stderr,
37                 "Terminal is dumb but no VISUAL nor EDITOR defined.\n"
38                 "Please supply the message using either -m or -F option.\n");
39                 exit(1);
40         }
41
42         if (!editor)
43                 editor = "vi";
44
45         memset(&child, 0, sizeof(child));
46         child.argv = args;
47         args[0] = editor;
48         args[1] = path;
49         args[2] = NULL;
50
51         if (run_command(&child))
52                 die("There was a problem with the editor %s.", editor);
53
54         if (strbuf_read_file(buffer, path, 0) < 0)
55                 die("could not read message file '%s': %s",
56                     path, strerror(errno));
57 }
58
59 struct tag_filter {
60         const char *pattern;
61         int lines;
62 };
63
64 #define PGP_SIGNATURE "-----BEGIN PGP SIGNATURE-----"
65
66 static int show_reference(const char *refname, const unsigned char *sha1,
67                           int flag, void *cb_data)
68 {
69         struct tag_filter *filter = cb_data;
70
71         if (!fnmatch(filter->pattern, refname, 0)) {
72                 int i;
73                 unsigned long size;
74                 enum object_type type;
75                 char *buf, *sp, *eol;
76                 size_t len;
77
78                 if (!filter->lines) {
79                         printf("%s\n", refname);
80                         return 0;
81                 }
82                 printf("%-15s ", refname);
83
84                 buf = read_sha1_file(sha1, &type, &size);
85                 if (!buf || !size)
86                         return 0;
87
88                 /* skip header */
89                 sp = strstr(buf, "\n\n");
90                 if (!sp) {
91                         free(buf);
92                         return 0;
93                 }
94                 /* only take up to "lines" lines, and strip the signature */
95                 for (i = 0, sp += 2;
96                                 i < filter->lines && sp < buf + size &&
97                                 prefixcmp(sp, PGP_SIGNATURE "\n");
98                                 i++) {
99                         if (i)
100                                 printf("\n    ");
101                         eol = memchr(sp, '\n', size - (sp - buf));
102                         len = eol ? eol - sp : size - (sp - buf);
103                         fwrite(sp, len, 1, stdout);
104                         if (!eol)
105                                 break;
106                         sp = eol + 1;
107                 }
108                 putchar('\n');
109                 free(buf);
110         }
111
112         return 0;
113 }
114
115 static int list_tags(const char *pattern, int lines)
116 {
117         struct tag_filter filter;
118
119         if (pattern == NULL)
120                 pattern = "*";
121
122         filter.pattern = pattern;
123         filter.lines = lines;
124
125         for_each_tag_ref(show_reference, (void *) &filter);
126
127         return 0;
128 }
129
130 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
131                                 const unsigned char *sha1);
132
133 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
134 {
135         const char **p;
136         char ref[PATH_MAX];
137         int had_error = 0;
138         unsigned char sha1[20];
139
140         for (p = argv; *p; p++) {
141                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
142                                         >= sizeof(ref)) {
143                         error("tag name too long: %.*s...", 50, *p);
144                         had_error = 1;
145                         continue;
146                 }
147                 if (!resolve_ref(ref, sha1, 1, NULL)) {
148                         error("tag '%s' not found.", *p);
149                         had_error = 1;
150                         continue;
151                 }
152                 if (fn(*p, ref, sha1))
153                         had_error = 1;
154         }
155         return had_error;
156 }
157
158 static int delete_tag(const char *name, const char *ref,
159                                 const unsigned char *sha1)
160 {
161         if (delete_ref(ref, sha1))
162                 return 1;
163         printf("Deleted tag '%s'\n", name);
164         return 0;
165 }
166
167 static int verify_tag(const char *name, const char *ref,
168                                 const unsigned char *sha1)
169 {
170         const char *argv_verify_tag[] = {"git-verify-tag",
171                                         "-v", "SHA1_HEX", NULL};
172         argv_verify_tag[2] = sha1_to_hex(sha1);
173
174         if (run_command_v_opt(argv_verify_tag, 0))
175                 return error("could not verify the tag '%s'", name);
176         return 0;
177 }
178
179 static int do_sign(struct strbuf *buffer)
180 {
181         struct child_process gpg;
182         const char *args[4];
183         char *bracket;
184         int len;
185
186         if (!*signingkey) {
187                 if (strlcpy(signingkey, git_committer_info(1),
188                                 sizeof(signingkey)) > sizeof(signingkey) - 1)
189                         return error("committer info too long.");
190                 bracket = strchr(signingkey, '>');
191                 if (bracket)
192                         bracket[1] = '\0';
193         }
194
195         /* When the username signingkey is bad, program could be terminated
196          * because gpg exits without reading and then write gets SIGPIPE. */
197         signal(SIGPIPE, SIG_IGN);
198
199         memset(&gpg, 0, sizeof(gpg));
200         gpg.argv = args;
201         gpg.in = -1;
202         gpg.out = -1;
203         args[0] = "gpg";
204         args[1] = "-bsau";
205         args[2] = signingkey;
206         args[3] = NULL;
207
208         if (start_command(&gpg))
209                 return error("could not run gpg.");
210
211         if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
212                 close(gpg.in);
213                 finish_command(&gpg);
214                 return error("gpg did not accept the tag data");
215         }
216         close(gpg.in);
217         gpg.close_in = 0;
218         len = strbuf_read(buffer, gpg.out, 1024);
219
220         if (finish_command(&gpg) || !len || len < 0)
221                 return error("gpg failed to sign the tag");
222
223         if (len < 0)
224                 return error("could not read the entire signature from gpg.");
225
226         return 0;
227 }
228
229 static const char tag_template[] =
230         "\n"
231         "#\n"
232         "# Write a tag message\n"
233         "#\n";
234
235 static int git_tag_config(const char *var, const char *value)
236 {
237         if (!strcmp(var, "user.signingkey")) {
238                 if (!value)
239                         die("user.signingkey without value");
240                 if (strlcpy(signingkey, value, sizeof(signingkey))
241                                                 >= sizeof(signingkey))
242                         die("user.signingkey value too long");
243                 return 0;
244         }
245
246         return git_default_config(var, value);
247 }
248
249 static void create_tag(const unsigned char *object, const char *tag,
250                        struct strbuf *buf, int message, int sign,
251                            unsigned char *result)
252 {
253         enum object_type type;
254         char header_buf[1024];
255         int header_len;
256
257         type = sha1_object_info(object, NULL);
258         if (type <= OBJ_NONE)
259             die("bad object type.");
260
261         header_len = snprintf(header_buf, sizeof(header_buf),
262                           "object %s\n"
263                           "type %s\n"
264                           "tag %s\n"
265                           "tagger %s\n\n",
266                           sha1_to_hex(object),
267                           typename(type),
268                           tag,
269                           git_committer_info(1));
270
271         if (header_len > sizeof(header_buf) - 1)
272                 die("tag header too big.");
273
274         if (!message) {
275                 char *path;
276                 int fd;
277
278                 /* write the template message before editing: */
279                 path = xstrdup(git_path("TAG_EDITMSG"));
280                 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
281                 if (fd < 0)
282                         die("could not create file '%s': %s",
283                                                 path, strerror(errno));
284                 write_or_die(fd, tag_template, strlen(tag_template));
285                 close(fd);
286
287                 launch_editor(path, buf);
288
289                 unlink(path);
290                 free(path);
291         }
292
293         stripspace(buf, 1);
294
295         if (!message && !buf->len)
296                 die("no tag message?");
297
298         strbuf_insert(buf, 0, header_buf, header_len);
299
300         if (sign && do_sign(buf) < 0)
301                 die("unable to sign the tag");
302         if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
303                 die("unable to write tag file");
304 }
305
306 int cmd_tag(int argc, const char **argv, const char *prefix)
307 {
308         struct strbuf buf;
309         unsigned char object[20], prev[20];
310         int annotate = 0, sign = 0, force = 0, lines = 0, message = 0;
311         char ref[PATH_MAX];
312         const char *object_ref, *tag;
313         int i;
314         struct ref_lock *lock;
315
316         git_config(git_tag_config);
317         strbuf_init(&buf, 0);
318
319         for (i = 1; i < argc; i++) {
320                 const char *arg = argv[i];
321
322                 if (arg[0] != '-')
323                         break;
324                 if (!strcmp(arg, "-a")) {
325                         annotate = 1;
326                         continue;
327                 }
328                 if (!strcmp(arg, "-s")) {
329                         annotate = 1;
330                         sign = 1;
331                         continue;
332                 }
333                 if (!strcmp(arg, "-f")) {
334                         force = 1;
335                         continue;
336                 }
337                 if (!strcmp(arg, "-n")) {
338                         if (i + 1 == argc || *argv[i + 1] == '-')
339                                 /* no argument */
340                                 lines = 1;
341                         else
342                                 lines = isdigit(*argv[++i]) ?
343                                         atoi(argv[i]) : 1;
344                         continue;
345                 }
346                 if (!strcmp(arg, "-m")) {
347                         annotate = 1;
348                         i++;
349                         if (i == argc)
350                                 die("option -m needs an argument.");
351                         if (message)
352                                 die("only one -F or -m option is allowed.");
353                         strbuf_addstr(&buf, argv[i]);
354                         message = 1;
355                         continue;
356                 }
357                 if (!strcmp(arg, "-F")) {
358                         annotate = 1;
359                         i++;
360                         if (i == argc)
361                                 die("option -F needs an argument.");
362                         if (message)
363                                 die("only one -F or -m option is allowed.");
364
365                         if (!strcmp(argv[i], "-")) {
366                                 if (strbuf_read(&buf, 0, 1024) < 0)
367                                         die("cannot read %s", argv[i]);
368                         } else {
369                                 if (strbuf_read_file(&buf, argv[i], 1024) < 0)
370                                         die("could not open or read '%s': %s",
371                                                 argv[i], strerror(errno));
372                         }
373                         message = 1;
374                         continue;
375                 }
376                 if (!strcmp(arg, "-u")) {
377                         annotate = 1;
378                         sign = 1;
379                         i++;
380                         if (i == argc)
381                                 die("option -u needs an argument.");
382                         if (strlcpy(signingkey, argv[i], sizeof(signingkey))
383                                                         >= sizeof(signingkey))
384                                 die("argument to option -u too long");
385                         continue;
386                 }
387                 if (!strcmp(arg, "-l"))
388                         return list_tags(argv[i + 1], lines);
389                 if (!strcmp(arg, "-d"))
390                         return for_each_tag_name(argv + i + 1, delete_tag);
391                 if (!strcmp(arg, "-v"))
392                         return for_each_tag_name(argv + i + 1, verify_tag);
393                 usage(builtin_tag_usage);
394         }
395
396         if (i == argc) {
397                 if (annotate)
398                         usage(builtin_tag_usage);
399                 return list_tags(NULL, lines);
400         }
401         tag = argv[i++];
402
403         object_ref = i < argc ? argv[i] : "HEAD";
404         if (i + 1 < argc)
405                 die("too many params");
406
407         if (get_sha1(object_ref, object))
408                 die("Failed to resolve '%s' as a valid ref.", object_ref);
409
410         if (snprintf(ref, sizeof(ref), "refs/tags/%s", tag) > sizeof(ref) - 1)
411                 die("tag name too long: %.*s...", 50, tag);
412         if (check_ref_format(ref))
413                 die("'%s' is not a valid tag name.", tag);
414
415         if (!resolve_ref(ref, prev, 1, NULL))
416                 hashclr(prev);
417         else if (!force)
418                 die("tag '%s' already exists", tag);
419
420         if (annotate)
421                 create_tag(object, tag, &buf, message, sign, object);
422
423         lock = lock_any_ref_for_update(ref, prev, 0);
424         if (!lock)
425                 die("%s: cannot lock the ref", ref);
426         if (write_ref_sha1(lock, object, NULL) < 0)
427                 die("%s: cannot update the ref", ref);
428
429         strbuf_release(&buf);
430         return 0;
431 }