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