builtin/shortlog.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "config.h"
   4 #include "commit.h"
   5 #include "diff.h"
   6 #include "gettext.h"
   7 #include "string-list.h"
   8 #include "revision.h"
   9 #include "utf8.h"
  10 #include "mailmap.h"
  11 #include "shortlog.h"
  12 #include "parse-options.h"
  13 #include "trailer.h"
  14 #include "strmap.h"
  15
  16 static char const * const shortlog_usage[] = {
  17         N_("git shortlog [<options>] [<revision-range>] [[--] <path>...]"),
  18         N_("git log --pretty=short | git shortlog [<options>]"),
  19         NULL
  20 };
  21
  22 /*
  23  * The util field of our string_list_items will contain one of two things:
  24  *
  25  *   - if --summary is not in use, it will point to a string list of the
  26  *     oneline subjects assigned to this author
  27  *
  28  *   - if --summary is in use, we don't need that list; we only need to know
  29  *     its size. So we abuse the pointer slot to store our integer counter.
  30  *
  31  *  This macro accesses the latter.
  32  */
  33 #define UTIL_TO_INT(x) ((intptr_t)(x)->util)
  34
  35 static int compare_by_counter(const void *a1, const void *a2)
  36 {
  37         const struct string_list_item *i1 = a1, *i2 = a2;
  38         return UTIL_TO_INT(i2) - UTIL_TO_INT(i1);
  39 }
  40
  41 static int compare_by_list(const void *a1, const void *a2)
  42 {
  43         const struct string_list_item *i1 = a1, *i2 = a2;
  44         const struct string_list *l1 = i1->util, *l2 = i2->util;
  45
  46         if (l1->nr < l2->nr)
  47                 return 1;
  48         else if (l1->nr == l2->nr)
  49                 return 0;
  50         else
  51                 return -1;
  52 }
  53
  54 static void insert_one_record(struct shortlog *log,
  55                               const char *ident,
  56                               const char *oneline)
  57 {
  58         struct string_list_item *item;
  59
  60         item = string_list_insert(&log->list, ident);
  61
  62         if (log->summary)
  63                 item->util = (void *)(UTIL_TO_INT(item) + 1);
  64         else {
  65                 char *buffer;
  66                 struct strbuf subject = STRBUF_INIT;
  67                 const char *eol;
  68
  69                 /* Skip any leading whitespace, including any blank lines. */
  70                 while (*oneline && isspace(*oneline))
  71                         oneline++;
  72                 eol = strchr(oneline, '\n');
  73                 if (!eol)
  74                         eol = oneline + strlen(oneline);
  75                 if (starts_with(oneline, "[PATCH")) {
  76                         char *eob = strchr(oneline, ']');
  77                         if (eob && (!eol || eob < eol))
  78                                 oneline = eob + 1;
  79                 }
  80                 while (*oneline && isspace(*oneline) && *oneline != '\n')
  81                         oneline++;
  82                 format_subject(&subject, oneline, " ");
  83                 buffer = strbuf_detach(&subject, NULL);
  84
  85                 if (!item->util) {
  86                         item->util = xmalloc(sizeof(struct string_list));
  87                         string_list_init_nodup(item->util);
  88                 }
  89                 string_list_append(item->util, buffer);
  90         }
  91 }
  92
  93 static int parse_ident(struct shortlog *log,
  94                        struct strbuf *out, const char *in)
  95 {
  96         const char *mailbuf, *namebuf;
  97         size_t namelen, maillen;
  98         struct ident_split ident;
  99
 100         if (split_ident_line(&ident, in, strlen(in)))
 101                 return -1;
 102
 103         namebuf = ident.name_begin;
 104         mailbuf = ident.mail_begin;
 105         namelen = ident.name_end - ident.name_begin;
 106         maillen = ident.mail_end - ident.mail_begin;
 107
 108         map_user(&log->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
 109         strbuf_add(out, namebuf, namelen);
 110         if (log->email)
 111                 strbuf_addf(out, " <%.*s>", (int)maillen, mailbuf);
 112
 113         return 0;
 114 }
 115
 116 static void read_from_stdin(struct shortlog *log)
 117 {
 118         struct strbuf ident = STRBUF_INIT;
 119         struct strbuf mapped_ident = STRBUF_INIT;
 120         struct strbuf oneline = STRBUF_INIT;
 121         static const char *author_match[2] = { "Author: ", "author " };
 122         static const char *committer_match[2] = { "Commit: ", "committer " };
 123         const char **match;
 124
 125         if (HAS_MULTI_BITS(log->groups))
 126                 die(_("using multiple --group options with stdin is not supported"));
 127
 128         switch (log->groups) {
 129         case SHORTLOG_GROUP_AUTHOR:
 130                 match = author_match;
 131                 break;
 132         case SHORTLOG_GROUP_COMMITTER:
 133                 match = committer_match;
 134                 break;
 135         case SHORTLOG_GROUP_TRAILER:
 136                 die(_("using %s with stdin is not supported"), "--group=trailer");
 137         case SHORTLOG_GROUP_FORMAT:
 138                 die(_("using %s with stdin is not supported"), "--group=format");
 139         default:
 140                 BUG("unhandled shortlog group");
 141         }
 142
 143         while (strbuf_getline_lf(&ident, stdin) != EOF) {
 144                 const char *v;
 145                 if (!skip_prefix(ident.buf, match[0], &v) &&
 146                     !skip_prefix(ident.buf, match[1], &v))
 147                         continue;
 148                 while (strbuf_getline_lf(&oneline, stdin) != EOF &&
 149                        oneline.len)
 150                         ; /* discard headers */
 151                 while (strbuf_getline_lf(&oneline, stdin) != EOF &&
 152                        !oneline.len)
 153                         ; /* discard blanks */
 154
 155                 strbuf_reset(&mapped_ident);
 156                 if (parse_ident(log, &mapped_ident, v) < 0)
 157                         continue;
 158
 159                 insert_one_record(log, mapped_ident.buf, oneline.buf);
 160         }
 161         strbuf_release(&ident);
 162         strbuf_release(&mapped_ident);
 163         strbuf_release(&oneline);
 164 }
 165
 166 static void insert_records_from_trailers(struct shortlog *log,
 167                                          struct strset *dups,
 168                                          struct commit *commit,
 169                                          struct pretty_print_context *ctx,
 170                                          const char *oneline)
 171 {
 172         struct trailer_iterator iter;
 173         const char *commit_buffer, *body;
 174         struct strbuf ident = STRBUF_INIT;
 175
 176         if (!log->trailers.nr)
 177                 return;
 178
 179         /*
 180          * Using format_commit_message("%B") would be simpler here, but
 181          * this saves us copying the message.
 182          */
 183         commit_buffer = logmsg_reencode(commit, NULL, ctx->output_encoding);
 184         body = strstr(commit_buffer, "\n\n");
 185         if (!body)
 186                 return;
 187
 188         trailer_iterator_init(&iter, body);
 189         while (trailer_iterator_advance(&iter)) {
 190                 const char *value = iter.val.buf;
 191
 192                 if (!string_list_has_string(&log->trailers, iter.key.buf))
 193                         continue;
 194
 195                 strbuf_reset(&ident);
 196                 if (!parse_ident(log, &ident, value))
 197                         value = ident.buf;
 198
 199                 if (!strset_add(dups, value))
 200                         continue;
 201                 insert_one_record(log, value, oneline);
 202         }
 203         trailer_iterator_release(&iter);
 204
 205         strbuf_release(&ident);
 206         unuse_commit_buffer(commit, commit_buffer);
 207 }
 208
 209 static int shortlog_needs_dedup(const struct shortlog *log)
 210 {
 211         return HAS_MULTI_BITS(log->groups) || log->format.nr > 1 || log->trailers.nr;
 212 }
 213
 214 static void insert_records_from_format(struct shortlog *log,
 215                                        struct strset *dups,
 216                                        struct commit *commit,
 217                                        struct pretty_print_context *ctx,
 218                                        const char *oneline)
 219 {
 220         struct strbuf buf = STRBUF_INIT;
 221         struct string_list_item *item;
 222
 223         for_each_string_list_item(item, &log->format) {
 224                 strbuf_reset(&buf);
 225
 226                 format_commit_message(commit, item->string, &buf, ctx);
 227
 228                 if (!shortlog_needs_dedup(log) || strset_add(dups, buf.buf))
 229                         insert_one_record(log, buf.buf, oneline);
 230         }
 231
 232         strbuf_release(&buf);
 233 }
 234
 235 void shortlog_add_commit(struct shortlog *log, struct commit *commit)
 236 {
 237         struct strbuf oneline = STRBUF_INIT;
 238         struct strset dups = STRSET_INIT;
 239         struct pretty_print_context ctx = {0};
 240         const char *oneline_str;
 241
 242         ctx.fmt = CMIT_FMT_USERFORMAT;
 243         ctx.abbrev = log->abbrev;
 244         ctx.print_email_subject = 1;
 245         ctx.date_mode = log->date_mode;
 246         ctx.output_encoding = get_log_output_encoding();
 247
 248         if (!log->summary) {
 249                 if (log->user_format)
 250                         pretty_print_commit(&ctx, commit, &oneline);
 251                 else
 252                         format_commit_message(commit, "%s", &oneline, &ctx);
 253         }
 254         oneline_str = oneline.len ? oneline.buf : "<none>";
 255
 256         insert_records_from_trailers(log, &dups, commit, &ctx, oneline_str);
 257         insert_records_from_format(log, &dups, commit, &ctx, oneline_str);
 258
 259         strset_clear(&dups);
 260         strbuf_release(&oneline);
 261 }
 262
 263 static void get_from_rev(struct rev_info *rev, struct shortlog *log)
 264 {
 265         struct commit *commit;
 266
 267         if (prepare_revision_walk(rev))
 268                 die(_("revision walk setup failed"));
 269         while ((commit = get_revision(rev)) != NULL)
 270                 shortlog_add_commit(log, commit);
 271 }
 272
 273 static int parse_uint(char const **arg, int comma, int defval)
 274 {
 275         unsigned long ul;
 276         int ret;
 277         char *endp;
 278
 279         ul = strtoul(*arg, &endp, 10);
 280         if (*endp && *endp != comma)
 281                 return -1;
 282         if (ul > INT_MAX)
 283                 return -1;
 284         ret = *arg == endp ? defval : (int)ul;
 285         *arg = *endp ? endp + 1 : endp;
 286         return ret;
 287 }
 288
 289 static const char wrap_arg_usage[] = "-w[<width>[,<indent1>[,<indent2>]]]";
 290 #define DEFAULT_WRAPLEN 76
 291 #define DEFAULT_INDENT1 6
 292 #define DEFAULT_INDENT2 9
 293
 294 static int parse_wrap_args(const struct option *opt, const char *arg, int unset)
 295 {
 296         struct shortlog *log = opt->value;
 297
 298         log->wrap_lines = !unset;
 299         if (unset)
 300                 return 0;
 301         if (!arg) {
 302                 log->wrap = DEFAULT_WRAPLEN;
 303                 log->in1 = DEFAULT_INDENT1;
 304                 log->in2 = DEFAULT_INDENT2;
 305                 return 0;
 306         }
 307
 308         log->wrap = parse_uint(&arg, ',', DEFAULT_WRAPLEN);
 309         log->in1 = parse_uint(&arg, ',', DEFAULT_INDENT1);
 310         log->in2 = parse_uint(&arg, '\0', DEFAULT_INDENT2);
 311         if (log->wrap < 0 || log->in1 < 0 || log->in2 < 0)
 312                 return error(wrap_arg_usage);
 313         if (log->wrap &&
 314             ((log->in1 && log->wrap <= log->in1) ||
 315              (log->in2 && log->wrap <= log->in2)))
 316                 return error(wrap_arg_usage);
 317         return 0;
 318 }
 319
 320 static int parse_group_option(const struct option *opt, const char *arg, int unset)
 321 {
 322         struct shortlog *log = opt->value;
 323         const char *field;
 324
 325         if (unset) {
 326                 log->groups = 0;
 327                 string_list_clear(&log->trailers, 0);
 328                 string_list_clear(&log->format, 0);
 329         } else if (!strcasecmp(arg, "author"))
 330                 log->groups |= SHORTLOG_GROUP_AUTHOR;
 331         else if (!strcasecmp(arg, "committer"))
 332                 log->groups |= SHORTLOG_GROUP_COMMITTER;
 333         else if (skip_prefix(arg, "trailer:", &field)) {
 334                 log->groups |= SHORTLOG_GROUP_TRAILER;
 335                 string_list_append(&log->trailers, field);
 336         } else if (skip_prefix(arg, "format:", &field)) {
 337                 log->groups |= SHORTLOG_GROUP_FORMAT;
 338                 string_list_append(&log->format, field);
 339         } else if (strchr(arg, '%')) {
 340                 log->groups |= SHORTLOG_GROUP_FORMAT;
 341                 string_list_append(&log->format, arg);
 342         } else {
 343                 return error(_("unknown group type: %s"), arg);
 344         }
 345
 346         return 0;
 347 }
 348
 349
 350 void shortlog_init(struct shortlog *log)
 351 {
 352         memset(log, 0, sizeof(*log));
 353
 354         read_mailmap(&log->mailmap);
 355
 356         log->list.strdup_strings = 1;
 357         log->wrap = DEFAULT_WRAPLEN;
 358         log->in1 = DEFAULT_INDENT1;
 359         log->in2 = DEFAULT_INDENT2;
 360         log->trailers.strdup_strings = 1;
 361         log->trailers.cmp = strcasecmp;
 362         log->format.strdup_strings = 1;
 363 }
 364
 365 void shortlog_finish_setup(struct shortlog *log)
 366 {
 367         if (log->groups & SHORTLOG_GROUP_AUTHOR)
 368                 string_list_append(&log->format,
 369                                    log->email ? "%aN <%aE>" : "%aN");
 370         if (log->groups & SHORTLOG_GROUP_COMMITTER)
 371                 string_list_append(&log->format,
 372                                    log->email ? "%cN <%cE>" : "%cN");
 373
 374         string_list_sort(&log->trailers);
 375 }
 376
 377 int cmd_shortlog(int argc, const char **argv, const char *prefix)
 378 {
 379         struct shortlog log = { STRING_LIST_INIT_NODUP };
 380         struct rev_info rev;
 381         int nongit = !startup_info->have_repository;
 382
 383         const struct option options[] = {
 384                 OPT_BIT('c', "committer", &log.groups,
 385                         N_("group by committer rather than author"),
 386                         SHORTLOG_GROUP_COMMITTER),
 387                 OPT_BOOL('n', "numbered", &log.sort_by_number,
 388                          N_("sort output according to the number of commits per author")),
 389                 OPT_BOOL('s', "summary", &log.summary,
 390                          N_("suppress commit descriptions, only provides commit count")),
 391                 OPT_BOOL('e', "email", &log.email,
 392                          N_("show the email address of each author")),
 393                 OPT_CALLBACK_F('w', NULL, &log, N_("<w>[,<i1>[,<i2>]]"),
 394                         N_("linewrap output"), PARSE_OPT_OPTARG,
 395                         &parse_wrap_args),
 396                 OPT_CALLBACK(0, "group", &log, N_("field"),
 397                         N_("group by field"), parse_group_option),
 398                 OPT_END(),
 399         };
 400
 401         struct parse_opt_ctx_t ctx;
 402
 403         git_config(git_default_config, NULL);
 404         shortlog_init(&log);
 405         repo_init_revisions(the_repository, &rev, prefix);
 406         parse_options_start(&ctx, argc, argv, prefix, options,
 407                             PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
 408
 409         for (;;) {
 410                 switch (parse_options_step(&ctx, options, shortlog_usage)) {
 411                 case PARSE_OPT_NON_OPTION:
 412                 case PARSE_OPT_UNKNOWN:
 413                         break;
 414                 case PARSE_OPT_HELP:
 415                 case PARSE_OPT_ERROR:
 416                 case PARSE_OPT_SUBCOMMAND:
 417                         exit(129);
 418                 case PARSE_OPT_COMPLETE:
 419                         exit(0);
 420                 case PARSE_OPT_DONE:
 421                         goto parse_done;
 422                 }
 423                 parse_revision_opt(&rev, &ctx, options, shortlog_usage);
 424         }
 425 parse_done:
 426         revision_opts_finish(&rev);
 427         argc = parse_options_end(&ctx);
 428
 429         if (nongit && argc > 1) {
 430                 error(_("too many arguments given outside repository"));
 431                 usage_with_options(shortlog_usage, options);
 432         }
 433
 434         if (setup_revisions(argc, argv, &rev, NULL) != 1) {
 435                 error(_("unrecognized argument: %s"), argv[1]);
 436                 usage_with_options(shortlog_usage, options);
 437         }
 438
 439         log.user_format = rev.commit_format == CMIT_FMT_USERFORMAT;
 440         log.abbrev = rev.abbrev;
 441         log.file = rev.diffopt.file;
 442         log.date_mode = rev.date_mode;
 443
 444         if (!log.groups)
 445                 log.groups = SHORTLOG_GROUP_AUTHOR;
 446         shortlog_finish_setup(&log);
 447
 448         /* assume HEAD if from a tty */
 449         if (!nongit && !rev.pending.nr && isatty(0))
 450                 add_head_to_pending(&rev);
 451         if (rev.pending.nr == 0) {
 452                 if (isatty(0))
 453                         fprintf(stderr, _("(reading log message from standard input)\n"));
 454                 read_from_stdin(&log);
 455         }
 456         else
 457                 get_from_rev(&rev, &log);
 458
 459         release_revisions(&rev);
 460
 461         shortlog_output(&log);
 462         if (log.file != stdout)
 463                 fclose(log.file);
 464         return 0;
 465 }
 466
 467 static void add_wrapped_shortlog_msg(struct strbuf *sb, const char *s,
 468                                      const struct shortlog *log)
 469 {
 470         strbuf_add_wrapped_text(sb, s, log->in1, log->in2, log->wrap);
 471         strbuf_addch(sb, '\n');
 472 }
 473
 474 void shortlog_output(struct shortlog *log)
 475 {
 476         size_t i, j;
 477         struct strbuf sb = STRBUF_INIT;
 478
 479         if (log->sort_by_number)
 480                 STABLE_QSORT(log->list.items, log->list.nr,
 481                       log->summary ? compare_by_counter : compare_by_list);
 482         for (i = 0; i < log->list.nr; i++) {
 483                 const struct string_list_item *item = &log->list.items[i];
 484                 if (log->summary) {
 485                         fprintf(log->file, "%6d\t%s\n",
 486                                 (int)UTIL_TO_INT(item), item->string);
 487                 } else {
 488                         struct string_list *onelines = item->util;
 489                         fprintf(log->file, "%s (%"PRIuMAX"):\n",
 490                                 item->string, (uintmax_t)onelines->nr);
 491                         for (j = onelines->nr; j >= 1; j--) {
 492                                 const char *msg = onelines->items[j - 1].string;
 493
 494                                 if (log->wrap_lines) {
 495                                         strbuf_reset(&sb);
 496                                         add_wrapped_shortlog_msg(&sb, msg, log);
 497                                         fwrite(sb.buf, sb.len, 1, log->file);
 498                                 }
 499                                 else
 500                                         fprintf(log->file, "      %s\n", msg);
 501                         }
 502                         putc('\n', log->file);
 503                         onelines->strdup_strings = 1;
 504                         string_list_clear(onelines, 0);
 505                         free(onelines);
 506                 }
 507
 508                 log->list.items[i].util = NULL;
 509         }
 510
 511         strbuf_release(&sb);
 512         log->list.strdup_strings = 1;
 513         string_list_clear(&log->list, 1);
 514         clear_mailmap(&log->mailmap);
 515         string_list_clear(&log->format, 0);
 516 }