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