builtin/shortlog.c

   1 #include "builtin.h"
   2 #include "cache.h"
   3 #include "commit.h"
   4 #include "diff.h"
   5 #include "string-list.h"
   6 #include "revision.h"
   7 #include "utf8.h"
   8 #include "mailmap.h"
   9 #include "shortlog.h"
  10 #include "parse-options.h"
  11
  12 static char const * const shortlog_usage[] = {
  13         N_("git shortlog [<options>] [<revision-range>] [[--] [<path>...]]"),
  14         NULL
  15 };
  16
  17 static int compare_by_number(const void *a1, const void *a2)
  18 {
  19         const struct string_list_item *i1 = a1, *i2 = a2;
  20         const struct string_list *l1 = i1->util, *l2 = i2->util;
  21
  22         if (l1->nr < l2->nr)
  23                 return 1;
  24         else if (l1->nr == l2->nr)
  25                 return 0;
  26         else
  27                 return -1;
  28 }
  29
  30 static void insert_one_record(struct shortlog *log,
  31                               const char *author,
  32                               const char *oneline)
  33 {
  34         const char *dot3 = log->common_repo_prefix;
  35         char *buffer, *p;
  36         struct string_list_item *item;
  37         const char *mailbuf, *namebuf;
  38         size_t namelen, maillen;
  39         const char *eol;
  40         struct strbuf subject = STRBUF_INIT;
  41         struct strbuf namemailbuf = STRBUF_INIT;
  42         struct ident_split ident;
  43
  44         if (split_ident_line(&ident, author, strlen(author)))
  45                 return;
  46
  47         namebuf = ident.name_begin;
  48         mailbuf = ident.mail_begin;
  49         namelen = ident.name_end - ident.name_begin;
  50         maillen = ident.mail_end - ident.mail_begin;
  51
  52         map_user(&log->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
  53         strbuf_add(&namemailbuf, namebuf, namelen);
  54
  55         if (log->email)
  56                 strbuf_addf(&namemailbuf, " <%.*s>", (int)maillen, mailbuf);
  57
  58         item = string_list_insert(&log->list, namemailbuf.buf);
  59         if (item->util == NULL)
  60                 item->util = xcalloc(1, sizeof(struct string_list));
  61
  62         /* Skip any leading whitespace, including any blank lines. */
  63         while (*oneline && isspace(*oneline))
  64                 oneline++;
  65         eol = strchr(oneline, '\n');
  66         if (!eol)
  67                 eol = oneline + strlen(oneline);
  68         if (starts_with(oneline, "[PATCH")) {
  69                 char *eob = strchr(oneline, ']');
  70                 if (eob && (!eol || eob < eol))
  71                         oneline = eob + 1;
  72         }
  73         while (*oneline && isspace(*oneline) && *oneline != '\n')
  74                 oneline++;
  75         format_subject(&subject, oneline, " ");
  76         buffer = strbuf_detach(&subject, NULL);
  77
  78         if (dot3) {
  79                 int dot3len = strlen(dot3);
  80                 if (dot3len > 5) {
  81                         while ((p = strstr(buffer, dot3)) != NULL) {
  82                                 int taillen = strlen(p) - dot3len;
  83                                 memcpy(p, "/.../", 5);
  84                                 memmove(p + 5, p + dot3len, taillen + 1);
  85                         }
  86                 }
  87         }
  88
  89         string_list_append(item->util, buffer);
  90 }
  91
  92 static void read_from_stdin(struct shortlog *log)
  93 {
  94         struct strbuf author = STRBUF_INIT;
  95         struct strbuf oneline = STRBUF_INIT;
  96
  97         while (strbuf_getline(&author, stdin, '\n') != EOF) {
  98                 const char *v;
  99                 if (!skip_prefix(author.buf, "Author: ", &v) &&
 100                     !skip_prefix(author.buf, "author ", &v))
 101                         continue;
 102                 while (strbuf_getline(&oneline, stdin, '\n') != EOF &&
 103                        oneline.len)
 104                         ; /* discard headers */
 105                 while (strbuf_getline(&oneline, stdin, '\n') != EOF &&
 106                        !oneline.len)
 107                         ; /* discard blanks */
 108                 insert_one_record(log, v, oneline.buf);
 109         }
 110         strbuf_release(&author);
 111         strbuf_release(&oneline);
 112 }
 113
 114 void shortlog_add_commit(struct shortlog *log, struct commit *commit)
 115 {
 116         struct strbuf author = STRBUF_INIT;
 117         struct strbuf oneline = STRBUF_INIT;
 118         struct pretty_print_context ctx = {0};
 119
 120         ctx.fmt = CMIT_FMT_USERFORMAT;
 121         ctx.abbrev = log->abbrev;
 122         ctx.subject = "";
 123         ctx.after_subject = "";
 124         ctx.date_mode.type = DATE_NORMAL;
 125         ctx.output_encoding = get_log_output_encoding();
 126
 127         format_commit_message(commit, "%an <%ae>", &author, &ctx);
 128         /* we can detect a total failure only by seeing " <>" in the output */
 129         if (author.len <= 3) {
 130                 warning(_("Missing author: %s"),
 131                     oid_to_hex(&commit->object.oid));
 132                 goto out;
 133         }
 134
 135         if (log->user_format)
 136                 pretty_print_commit(&ctx, commit, &oneline);
 137         else
 138                 format_commit_message(commit, "%s", &oneline, &ctx);
 139
 140         insert_one_record(log, author.buf, oneline.len ? oneline.buf : "<none>");
 141
 142 out:
 143         strbuf_release(&author);
 144         strbuf_release(&oneline);
 145 }
 146
 147 static void get_from_rev(struct rev_info *rev, struct shortlog *log)
 148 {
 149         struct commit *commit;
 150
 151         if (prepare_revision_walk(rev))
 152                 die(_("revision walk setup failed"));
 153         while ((commit = get_revision(rev)) != NULL)
 154                 shortlog_add_commit(log, commit);
 155 }
 156
 157 static int parse_uint(char const **arg, int comma, int defval)
 158 {
 159         unsigned long ul;
 160         int ret;
 161         char *endp;
 162
 163         ul = strtoul(*arg, &endp, 10);
 164         if (*endp && *endp != comma)
 165                 return -1;
 166         if (ul > INT_MAX)
 167                 return -1;
 168         ret = *arg == endp ? defval : (int)ul;
 169         *arg = *endp ? endp + 1 : endp;
 170         return ret;
 171 }
 172
 173 static const char wrap_arg_usage[] = "-w[<width>[,<indent1>[,<indent2>]]]";
 174 #define DEFAULT_WRAPLEN 76
 175 #define DEFAULT_INDENT1 6
 176 #define DEFAULT_INDENT2 9
 177
 178 static int parse_wrap_args(const struct option *opt, const char *arg, int unset)
 179 {
 180         struct shortlog *log = opt->value;
 181
 182         log->wrap_lines = !unset;
 183         if (unset)
 184                 return 0;
 185         if (!arg) {
 186                 log->wrap = DEFAULT_WRAPLEN;
 187                 log->in1 = DEFAULT_INDENT1;
 188                 log->in2 = DEFAULT_INDENT2;
 189                 return 0;
 190         }
 191
 192         log->wrap = parse_uint(&arg, ',', DEFAULT_WRAPLEN);
 193         log->in1 = parse_uint(&arg, ',', DEFAULT_INDENT1);
 194         log->in2 = parse_uint(&arg, '\0', DEFAULT_INDENT2);
 195         if (log->wrap < 0 || log->in1 < 0 || log->in2 < 0)
 196                 return error(wrap_arg_usage);
 197         if (log->wrap &&
 198             ((log->in1 && log->wrap <= log->in1) ||
 199              (log->in2 && log->wrap <= log->in2)))
 200                 return error(wrap_arg_usage);
 201         return 0;
 202 }
 203
 204 void shortlog_init(struct shortlog *log)
 205 {
 206         memset(log, 0, sizeof(*log));
 207
 208         read_mailmap(&log->mailmap, &log->common_repo_prefix);
 209
 210         log->list.strdup_strings = 1;
 211         log->wrap = DEFAULT_WRAPLEN;
 212         log->in1 = DEFAULT_INDENT1;
 213         log->in2 = DEFAULT_INDENT2;
 214 }
 215
 216 int cmd_shortlog(int argc, const char **argv, const char *prefix)
 217 {
 218         static struct shortlog log;
 219         static struct rev_info rev;
 220         int nongit = !startup_info->have_repository;
 221
 222         static const struct option options[] = {
 223                 OPT_BOOL('n', "numbered", &log.sort_by_number,
 224                          N_("sort output according to the number of commits per author")),
 225                 OPT_BOOL('s', "summary", &log.summary,
 226                          N_("Suppress commit descriptions, only provides commit count")),
 227                 OPT_BOOL('e', "email", &log.email,
 228                          N_("Show the email address of each author")),
 229                 { OPTION_CALLBACK, 'w', NULL, &log, N_("w[,i1[,i2]]"),
 230                         N_("Linewrap output"), PARSE_OPT_OPTARG, &parse_wrap_args },
 231                 OPT_END(),
 232         };
 233
 234         struct parse_opt_ctx_t ctx;
 235
 236         git_config(git_default_config, NULL);
 237         shortlog_init(&log);
 238         init_revisions(&rev, prefix);
 239         parse_options_start(&ctx, argc, argv, prefix, options,
 240                             PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
 241
 242         for (;;) {
 243                 switch (parse_options_step(&ctx, options, shortlog_usage)) {
 244                 case PARSE_OPT_HELP:
 245                         exit(129);
 246                 case PARSE_OPT_DONE:
 247                         goto parse_done;
 248                 }
 249                 parse_revision_opt(&rev, &ctx, options, shortlog_usage);
 250         }
 251 parse_done:
 252         argc = parse_options_end(&ctx);
 253
 254         if (setup_revisions(argc, argv, &rev, NULL) != 1) {
 255                 error(_("unrecognized argument: %s"), argv[1]);
 256                 usage_with_options(shortlog_usage, options);
 257         }
 258
 259         log.user_format = rev.commit_format == CMIT_FMT_USERFORMAT;
 260         log.abbrev = rev.abbrev;
 261
 262         /* assume HEAD if from a tty */
 263         if (!nongit && !rev.pending.nr && isatty(0))
 264                 add_head_to_pending(&rev);
 265         if (rev.pending.nr == 0) {
 266                 if (isatty(0))
 267                         fprintf(stderr, _("(reading log message from standard input)\n"));
 268                 read_from_stdin(&log);
 269         }
 270         else
 271                 get_from_rev(&rev, &log);
 272
 273         shortlog_output(&log);
 274         return 0;
 275 }
 276
 277 static void add_wrapped_shortlog_msg(struct strbuf *sb, const char *s,
 278                                      const struct shortlog *log)
 279 {
 280         strbuf_add_wrapped_text(sb, s, log->in1, log->in2, log->wrap);
 281         strbuf_addch(sb, '\n');
 282 }
 283
 284 void shortlog_output(struct shortlog *log)
 285 {
 286         int i, j;
 287         struct strbuf sb = STRBUF_INIT;
 288
 289         if (log->sort_by_number)
 290                 qsort(log->list.items, log->list.nr, sizeof(struct string_list_item),
 291                         compare_by_number);
 292         for (i = 0; i < log->list.nr; i++) {
 293                 struct string_list *onelines = log->list.items[i].util;
 294
 295                 if (log->summary) {
 296                         printf("%6d\t%s\n", onelines->nr, log->list.items[i].string);
 297                 } else {
 298                         printf("%s (%d):\n", log->list.items[i].string, onelines->nr);
 299                         for (j = onelines->nr - 1; j >= 0; j--) {
 300                                 const char *msg = onelines->items[j].string;
 301
 302                                 if (log->wrap_lines) {
 303                                         strbuf_reset(&sb);
 304                                         add_wrapped_shortlog_msg(&sb, msg, log);
 305                                         fwrite(sb.buf, sb.len, 1, stdout);
 306                                 }
 307                                 else
 308                                         printf("      %s\n", msg);
 309                         }
 310                         putchar('\n');
 311                 }
 312
 313                 onelines->strdup_strings = 1;
 314                 string_list_clear(onelines, 0);
 315                 free(onelines);
 316                 log->list.items[i].util = NULL;
 317         }
 318
 319         strbuf_release(&sb);
 320         log->list.strdup_strings = 1;
 321         string_list_clear(&log->list, 1);
 322         clear_mailmap(&log->mailmap);
 323 }