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