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