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