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                 sp = buf = read_sha1_file(sha1, &type, &size);
  85                 if (!buf)
  86                         return 0;
  87                 if (!size) {
  88                         free(buf);
  89                         return 0;
  90                 }
  91                 /* skip header */
  92                 while (sp + 1 < buf + size &&
  93                                 !(sp[0] == '\n' && sp[1] == '\n'))
  94                         sp++;
  95                 /* only take up to "lines" lines, and strip the signature */
  96                 for (i = 0, sp += 2;
  97                                 i < filter->lines && sp < buf + size &&
  98                                 prefixcmp(sp, PGP_SIGNATURE "\n");
  99                                 i++) {
 100                         if (i)
 101                                 printf("\n    ");
 102                         eol = memchr(sp, '\n', size - (sp - buf));
 103                         len = eol ? eol - sp : size - (sp - buf);
 104                         fwrite(sp, len, 1, stdout);
 105                         if (!eol)
 106                                 break;
 107                         sp = eol + 1;
 108                 }
 109                 putchar('\n');
 110                 free(buf);
 111         }
 112
 113         return 0;
 114 }
 115
 116 static int list_tags(const char *pattern, int lines)
 117 {
 118         struct tag_filter filter;
 119
 120         if (pattern == NULL)
 121                 pattern = "*";
 122
 123         filter.pattern = pattern;
 124         filter.lines = lines;
 125
 126         for_each_tag_ref(show_reference, (void *) &filter);
 127
 128         return 0;
 129 }
 130
 131 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
 132                                 const unsigned char *sha1);
 133
 134 static int for_each_tag_name(const char **argv, each_tag_name_fn fn)
 135 {
 136         const char **p;
 137         char ref[PATH_MAX];
 138         int had_error = 0;
 139         unsigned char sha1[20];
 140
 141         for (p = argv; *p; p++) {
 142                 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
 143                                         >= sizeof(ref)) {
 144                         error("tag name too long: %.*s...", 50, *p);
 145                         had_error = 1;
 146                         continue;
 147                 }
 148                 if (!resolve_ref(ref, sha1, 1, NULL)) {
 149                         error("tag '%s' not found.", *p);
 150                         had_error = 1;
 151                         continue;
 152                 }
 153                 if (fn(*p, ref, sha1))
 154                         had_error = 1;
 155         }
 156         return had_error;
 157 }
 158
 159 static int delete_tag(const char *name, const char *ref,
 160                                 const unsigned char *sha1)
 161 {
 162         if (delete_ref(ref, sha1))
 163                 return 1;
 164         printf("Deleted tag '%s'\n", name);
 165         return 0;
 166 }
 167
 168 static int verify_tag(const char *name, const char *ref,
 169                                 const unsigned char *sha1)
 170 {
 171         const char *argv_verify_tag[] = {"git-verify-tag",
 172                                         "-v", "SHA1_HEX", NULL};
 173         argv_verify_tag[2] = sha1_to_hex(sha1);
 174
 175         if (run_command_v_opt(argv_verify_tag, 0))
 176                 return error("could not verify the tag '%s'", name);
 177         return 0;
 178 }
 179
 180 static int do_sign(struct strbuf *buffer)
 181 {
 182         struct child_process gpg;
 183         const char *args[4];
 184         char *bracket;
 185         int len;
 186
 187         if (!*signingkey) {
 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, '>');
 192                 if (bracket)
 193                         bracket[1] = '\0';
 194         }
 195
 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);
 199
 200         memset(&gpg, 0, sizeof(gpg));
 201         gpg.argv = args;
 202         gpg.in = -1;
 203         gpg.out = -1;
 204         args[0] = "gpg";
 205         args[1] = "-bsau";
 206         args[2] = signingkey;
 207         args[3] = NULL;
 208
 209         if (start_command(&gpg))
 210                 return error("could not run gpg.");
 211
 212         if (write_in_full(gpg.in, buffer->buf, buffer->len) != buffer->len) {
 213                 close(gpg.in);
 214                 finish_command(&gpg);
 215                 return error("gpg did not accept the tag data");
 216         }
 217         close(gpg.in);
 218         gpg.close_in = 0;
 219         len = strbuf_read(buffer, gpg.out, 1024);
 220
 221         if (finish_command(&gpg) || !len || len < 0)
 222                 return error("gpg failed to sign the tag");
 223
 224         if (len < 0)
 225                 return error("could not read the entire signature from gpg.");
 226
 227         return 0;
 228 }
 229
 230 static const char tag_template[] =
 231         "\n"
 232         "#\n"
 233         "# Write a tag message\n"
 234         "#\n";
 235
 236 static int git_tag_config(const char *var, const char *value)
 237 {
 238         if (!strcmp(var, "user.signingkey")) {
 239                 if (!value)
 240                         die("user.signingkey without value");
 241                 if (strlcpy(signingkey, value, sizeof(signingkey))
 242                                                 >= sizeof(signingkey))
 243                         die("user.signingkey value too long");
 244                 return 0;
 245         }
 246
 247         return git_default_config(var, value);
 248 }
 249
 250 static void write_tag_body(int fd, const unsigned char *sha1)
 251 {
 252         unsigned long size;
 253         enum object_type type;
 254         char *buf, *sp, *eob;
 255         size_t len;
 256
 257         buf = read_sha1_file(sha1, &type, &size);
 258         if (!buf)
 259                 return;
 260         /* skip header */
 261         sp = strstr(buf, "\n\n");
 262
 263         if (!sp || !size || type != OBJ_TAG) {
 264                 free(buf);
 265                 return;
 266         }
 267         sp += 2; /* skip the 2 LFs */
 268         eob = strstr(sp, "\n" PGP_SIGNATURE "\n");
 269         if (eob)
 270                 len = eob - sp;
 271         else
 272                 len = buf + size - sp;
 273         write_or_die(fd, sp, len);
 274
 275         free(buf);
 276 }
 277
 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)
 281 {
 282         enum object_type type;
 283         char header_buf[1024];
 284         int header_len;
 285
 286         type = sha1_object_info(object, NULL);
 287         if (type <= OBJ_NONE)
 288             die("bad object type.");
 289
 290         header_len = snprintf(header_buf, sizeof(header_buf),
 291                           "object %s\n"
 292                           "type %s\n"
 293                           "tag %s\n"
 294                           "tagger %s\n\n",
 295                           sha1_to_hex(object),
 296                           typename(type),
 297                           tag,
 298                           git_committer_info(1));
 299
 300         if (header_len > sizeof(header_buf) - 1)
 301                 die("tag header too big.");
 302
 303         if (!message) {
 304                 char *path;
 305                 int fd;
 306
 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);
 310                 if (fd < 0)
 311                         die("could not create file '%s': %s",
 312                                                 path, strerror(errno));
 313
 314                 if (!is_null_sha1(prev))
 315                         write_tag_body(fd, prev);
 316                 else
 317                         write_or_die(fd, tag_template, strlen(tag_template));
 318                 close(fd);
 319
 320                 launch_editor(path, buf);
 321
 322                 unlink(path);
 323                 free(path);
 324         }
 325
 326         stripspace(buf, 1);
 327
 328         if (!message && !buf->len)
 329                 die("no tag message?");
 330
 331         strbuf_insert(buf, 0, header_buf, header_len);
 332
 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");
 337 }
 338
 339 int cmd_tag(int argc, const char **argv, const char *prefix)
 340 {
 341         struct strbuf buf;
 342         unsigned char object[20], prev[20];
 343         int annotate = 0, sign = 0, force = 0, lines = 0, message = 0;
 344         char ref[PATH_MAX];
 345         const char *object_ref, *tag;
 346         int i;
 347         struct ref_lock *lock;
 348
 349         git_config(git_tag_config);
 350         strbuf_init(&buf, 0);
 351
 352         for (i = 1; i < argc; i++) {
 353                 const char *arg = argv[i];
 354
 355                 if (arg[0] != '-')
 356                         break;
 357                 if (!strcmp(arg, "-a")) {
 358                         annotate = 1;
 359                         continue;
 360                 }
 361                 if (!strcmp(arg, "-s")) {
 362                         annotate = 1;
 363                         sign = 1;
 364                         continue;
 365                 }
 366                 if (!strcmp(arg, "-f")) {
 367                         force = 1;
 368                         continue;
 369                 }
 370                 if (!strcmp(arg, "-n")) {
 371                         if (i + 1 == argc || *argv[i + 1] == '-')
 372                                 /* no argument */
 373                                 lines = 1;
 374                         else
 375                                 lines = isdigit(*argv[++i]) ?
 376                                         atoi(argv[i]) : 1;
 377                         continue;
 378                 }
 379                 if (!strcmp(arg, "-m")) {
 380                         annotate = 1;
 381                         i++;
 382                         if (i == argc)
 383                                 die("option -m needs an argument.");
 384                         if (message)
 385                                 die("only one -F or -m option is allowed.");
 386                         strbuf_addstr(&buf, argv[i]);
 387                         message = 1;
 388                         continue;
 389                 }
 390                 if (!strcmp(arg, "-F")) {
 391                         annotate = 1;
 392                         i++;
 393                         if (i == argc)
 394                                 die("option -F needs an argument.");
 395                         if (message)
 396                                 die("only one -F or -m option is allowed.");
 397
 398                         if (!strcmp(argv[i], "-")) {
 399                                 if (strbuf_read(&buf, 0, 1024) < 0)
 400                                         die("cannot read %s", argv[i]);
 401                         } else {
 402                                 if (strbuf_read_file(&buf, argv[i], 1024) < 0)
 403                                         die("could not open or read '%s': %s",
 404                                                 argv[i], strerror(errno));
 405                         }
 406                         message = 1;
 407                         continue;
 408                 }
 409                 if (!strcmp(arg, "-u")) {
 410                         annotate = 1;
 411                         sign = 1;
 412                         i++;
 413                         if (i == argc)
 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");
 418                         continue;
 419                 }
 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);
 427         }
 428
 429         if (i == argc) {
 430                 if (annotate)
 431                         usage(builtin_tag_usage);
 432                 return list_tags(NULL, lines);
 433         }
 434         tag = argv[i++];
 435
 436         object_ref = i < argc ? argv[i] : "HEAD";
 437         if (i + 1 < argc)
 438                 die("too many params");
 439
 440         if (get_sha1(object_ref, object))
 441                 die("Failed to resolve '%s' as a valid ref.", object_ref);
 442
 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);
 447
 448         if (!resolve_ref(ref, prev, 1, NULL))
 449                 hashclr(prev);
 450         else if (!force)
 451                 die("tag '%s' already exists", tag);
 452
 453         if (annotate)
 454                 create_tag(object, tag, &buf, message, sign, prev, object);
 455
 456         lock = lock_any_ref_for_update(ref, prev, 0);
 457         if (!lock)
 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);
 461
 462         strbuf_release(&buf);
 463         return 0;
 464 }