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         char author[1024], oneline[1024];
  95
  96         while (fgets(author, sizeof(author), stdin) != NULL) {
  97                 if (!(author[0] == 'A' || author[0] == 'a') ||
  98                     !starts_with(author + 1, "uthor: "))
  99                         continue;
 100                 while (fgets(oneline, sizeof(oneline), stdin) &&
 101                        oneline[0] != '\n')
 102                         ; /* discard headers */
 103                 while (fgets(oneline, sizeof(oneline), stdin) &&
 104                        oneline[0] == '\n')
 105                         ; /* discard blanks */
 106                 insert_one_record(log, author + 8, oneline);
 107         }
 108 }
 109
 110 void shortlog_add_commit(struct shortlog *log, struct commit *commit)
 111 {
 112         const char *author = NULL, *buffer;
 113         struct strbuf buf = STRBUF_INIT;
 114         struct strbuf ufbuf = STRBUF_INIT;
 115
 116         pp_commit_easy(CMIT_FMT_RAW, commit, &buf);
 117         buffer = buf.buf;
 118         while (*buffer && *buffer != '\n') {
 119                 const char *eol = strchr(buffer, '\n');
 120
 121                 if (eol == NULL)
 122                         eol = buffer + strlen(buffer);
 123                 else
 124                         eol++;
 125
 126                 if (starts_with(buffer, "author "))
 127                         author = buffer + 7;
 128                 buffer = eol;
 129         }
 130         if (!author) {
 131                 warning(_("Missing author: %s"),
 132                     sha1_to_hex(commit->object.sha1));
 133                 return;
 134         }
 135         if (log->user_format) {
 136                 struct pretty_print_context ctx = {0};
 137                 ctx.fmt = CMIT_FMT_USERFORMAT;
 138                 ctx.abbrev = log->abbrev;
 139                 ctx.subject = "";
 140                 ctx.after_subject = "";
 141                 ctx.date_mode = DATE_NORMAL;
 142                 ctx.output_encoding = get_log_output_encoding();
 143                 pretty_print_commit(&ctx, commit, &ufbuf);
 144                 buffer = ufbuf.buf;
 145         } else if (*buffer) {
 146                 buffer++;
 147         }
 148         insert_one_record(log, author, !*buffer ? "<none>" : buffer);
 149         strbuf_release(&ufbuf);
 150         strbuf_release(&buf);
 151 }
 152
 153 static void get_from_rev(struct rev_info *rev, struct shortlog *log)
 154 {
 155         struct commit *commit;
 156
 157         if (prepare_revision_walk(rev))
 158                 die(_("revision walk setup failed"));
 159         while ((commit = get_revision(rev)) != NULL)
 160                 shortlog_add_commit(log, commit);
 161 }
 162
 163 static int parse_uint(char const **arg, int comma, int defval)
 164 {
 165         unsigned long ul;
 166         int ret;
 167         char *endp;
 168
 169         ul = strtoul(*arg, &endp, 10);
 170         if (*endp && *endp != comma)
 171                 return -1;
 172         if (ul > INT_MAX)
 173                 return -1;
 174         ret = *arg == endp ? defval : (int)ul;
 175         *arg = *endp ? endp + 1 : endp;
 176         return ret;
 177 }
 178
 179 static const char wrap_arg_usage[] = "-w[<width>[,<indent1>[,<indent2>]]]";
 180 #define DEFAULT_WRAPLEN 76
 181 #define DEFAULT_INDENT1 6
 182 #define DEFAULT_INDENT2 9
 183
 184 static int parse_wrap_args(const struct option *opt, const char *arg, int unset)
 185 {
 186         struct shortlog *log = opt->value;
 187
 188         log->wrap_lines = !unset;
 189         if (unset)
 190                 return 0;
 191         if (!arg) {
 192                 log->wrap = DEFAULT_WRAPLEN;
 193                 log->in1 = DEFAULT_INDENT1;
 194                 log->in2 = DEFAULT_INDENT2;
 195                 return 0;
 196         }
 197
 198         log->wrap = parse_uint(&arg, ',', DEFAULT_WRAPLEN);
 199         log->in1 = parse_uint(&arg, ',', DEFAULT_INDENT1);
 200         log->in2 = parse_uint(&arg, '\0', DEFAULT_INDENT2);
 201         if (log->wrap < 0 || log->in1 < 0 || log->in2 < 0)
 202                 return error(wrap_arg_usage);
 203         if (log->wrap &&
 204             ((log->in1 && log->wrap <= log->in1) ||
 205              (log->in2 && log->wrap <= log->in2)))
 206                 return error(wrap_arg_usage);
 207         return 0;
 208 }
 209
 210 void shortlog_init(struct shortlog *log)
 211 {
 212         memset(log, 0, sizeof(*log));
 213
 214         read_mailmap(&log->mailmap, &log->common_repo_prefix);
 215
 216         log->list.strdup_strings = 1;
 217         log->wrap = DEFAULT_WRAPLEN;
 218         log->in1 = DEFAULT_INDENT1;
 219         log->in2 = DEFAULT_INDENT2;
 220 }
 221
 222 int cmd_shortlog(int argc, const char **argv, const char *prefix)
 223 {
 224         static struct shortlog log;
 225         static struct rev_info rev;
 226         int nongit = !startup_info->have_repository;
 227
 228         static const struct option options[] = {
 229                 OPT_BOOL('n', "numbered", &log.sort_by_number,
 230                          N_("sort output according to the number of commits per author")),
 231                 OPT_BOOL('s', "summary", &log.summary,
 232                          N_("Suppress commit descriptions, only provides commit count")),
 233                 OPT_BOOL('e', "email", &log.email,
 234                          N_("Show the email address of each author")),
 235                 { OPTION_CALLBACK, 'w', NULL, &log, N_("w[,i1[,i2]]"),
 236                         N_("Linewrap output"), PARSE_OPT_OPTARG, &parse_wrap_args },
 237                 OPT_END(),
 238         };
 239
 240         struct parse_opt_ctx_t ctx;
 241
 242         git_config(git_default_config, NULL);
 243         shortlog_init(&log);
 244         init_revisions(&rev, prefix);
 245         parse_options_start(&ctx, argc, argv, prefix, options,
 246                             PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
 247
 248         for (;;) {
 249                 switch (parse_options_step(&ctx, options, shortlog_usage)) {
 250                 case PARSE_OPT_HELP:
 251                         exit(129);
 252                 case PARSE_OPT_DONE:
 253                         goto parse_done;
 254                 }
 255                 parse_revision_opt(&rev, &ctx, options, shortlog_usage);
 256         }
 257 parse_done:
 258         argc = parse_options_end(&ctx);
 259
 260         if (setup_revisions(argc, argv, &rev, NULL) != 1) {
 261                 error(_("unrecognized argument: %s"), argv[1]);
 262                 usage_with_options(shortlog_usage, options);
 263         }
 264
 265         log.user_format = rev.commit_format == CMIT_FMT_USERFORMAT;
 266         log.abbrev = rev.abbrev;
 267
 268         /* assume HEAD if from a tty */
 269         if (!nongit && !rev.pending.nr && isatty(0))
 270                 add_head_to_pending(&rev);
 271         if (rev.pending.nr == 0) {
 272                 if (isatty(0))
 273                         fprintf(stderr, _("(reading log message from standard input)\n"));
 274                 read_from_stdin(&log);
 275         }
 276         else
 277                 get_from_rev(&rev, &log);
 278
 279         shortlog_output(&log);
 280         return 0;
 281 }
 282
 283 static void add_wrapped_shortlog_msg(struct strbuf *sb, const char *s,
 284                                      const struct shortlog *log)
 285 {
 286         strbuf_add_wrapped_text(sb, s, log->in1, log->in2, log->wrap);
 287         strbuf_addch(sb, '\n');
 288 }
 289
 290 void shortlog_output(struct shortlog *log)
 291 {
 292         int i, j;
 293         struct strbuf sb = STRBUF_INIT;
 294
 295         if (log->sort_by_number)
 296                 qsort(log->list.items, log->list.nr, sizeof(struct string_list_item),
 297                         compare_by_number);
 298         for (i = 0; i < log->list.nr; i++) {
 299                 struct string_list *onelines = log->list.items[i].util;
 300
 301                 if (log->summary) {
 302                         printf("%6d\t%s\n", onelines->nr, log->list.items[i].string);
 303                 } else {
 304                         printf("%s (%d):\n", log->list.items[i].string, onelines->nr);
 305                         for (j = onelines->nr - 1; j >= 0; j--) {
 306                                 const char *msg = onelines->items[j].string;
 307
 308                                 if (log->wrap_lines) {
 309                                         strbuf_reset(&sb);
 310                                         add_wrapped_shortlog_msg(&sb, msg, log);
 311                                         fwrite(sb.buf, sb.len, 1, stdout);
 312                                 }
 313                                 else
 314                                         printf("      %s\n", msg);
 315                         }
 316                         putchar('\n');
 317                 }
 318
 319                 onelines->strdup_strings = 1;
 320                 string_list_clear(onelines, 0);
 321                 free(onelines);
 322                 log->list.items[i].util = NULL;
 323         }
 324
 325         strbuf_release(&sb);
 326         log->list.strdup_strings = 1;
 327         string_list_clear(&log->list, 1);
 328         clear_mailmap(&log->mailmap);
 329 }