Andrew's git / gitweb.git / pretty.c
?
pretty.con commit Merge branch 'mm/verify-filename-fix' into maint (9ca7249)
   1#include "cache.h"
   2#include "commit.h"
   3#include "utf8.h"
   4#include "diff.h"
   5#include "revision.h"
   6#include "string-list.h"
   7#include "mailmap.h"
   8#include "log-tree.h"
   9#include "notes.h"
  10#include "color.h"
  11#include "reflog-walk.h"
  12#include "gpg-interface.h"
  13
  14static char *user_format;
  15static struct cmt_fmt_map {
  16        const char *name;
  17        enum cmit_fmt format;
  18        int is_tformat;
  19        int is_alias;
  20        const char *user_format;
  21} *commit_formats;
  22static size_t builtin_formats_len;
  23static size_t commit_formats_len;
  24static size_t commit_formats_alloc;
  25static struct cmt_fmt_map *find_commit_format(const char *sought);
  26
  27static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
  28{
  29        free(user_format);
  30        user_format = xstrdup(cp);
  31        if (is_tformat)
  32                rev->use_terminator = 1;
  33        rev->commit_format = CMIT_FMT_USERFORMAT;
  34}
  35
  36static int git_pretty_formats_config(const char *var, const char *value, void *cb)
  37{
  38        struct cmt_fmt_map *commit_format = NULL;
  39        const char *name;
  40        const char *fmt;
  41        int i;
  42
  43        if (prefixcmp(var, "pretty."))
  44                return 0;
  45
  46        name = var + strlen("pretty.");
  47        for (i = 0; i < builtin_formats_len; i++) {
  48                if (!strcmp(commit_formats[i].name, name))
  49                        return 0;
  50        }
  51
  52        for (i = builtin_formats_len; i < commit_formats_len; i++) {
  53                if (!strcmp(commit_formats[i].name, name)) {
  54                        commit_format = &commit_formats[i];
  55                        break;
  56                }
  57        }
  58
  59        if (!commit_format) {
  60                ALLOC_GROW(commit_formats, commit_formats_len+1,
  61                           commit_formats_alloc);
  62                commit_format = &commit_formats[commit_formats_len];
  63                memset(commit_format, 0, sizeof(*commit_format));
  64                commit_formats_len++;
  65        }
  66
  67        commit_format->name = xstrdup(name);
  68        commit_format->format = CMIT_FMT_USERFORMAT;
  69        git_config_string(&fmt, var, value);
  70        if (!prefixcmp(fmt, "format:") || !prefixcmp(fmt, "tformat:")) {
  71                commit_format->is_tformat = fmt[0] == 't';
  72                fmt = strchr(fmt, ':') + 1;
  73        } else if (strchr(fmt, '%'))
  74                commit_format->is_tformat = 1;
  75        else
  76                commit_format->is_alias = 1;
  77        commit_format->user_format = fmt;
  78
  79        return 0;
  80}
  81
  82static void setup_commit_formats(void)
  83{
  84        struct cmt_fmt_map builtin_formats[] = {
  85                { "raw",        CMIT_FMT_RAW,           0 },
  86                { "medium",     CMIT_FMT_MEDIUM,        0 },
  87                { "short",      CMIT_FMT_SHORT,         0 },
  88                { "email",      CMIT_FMT_EMAIL,         0 },
  89                { "fuller",     CMIT_FMT_FULLER,        0 },
  90                { "full",       CMIT_FMT_FULL,          0 },
  91                { "oneline",    CMIT_FMT_ONELINE,       1 }
  92        };
  93        commit_formats_len = ARRAY_SIZE(builtin_formats);
  94        builtin_formats_len = commit_formats_len;
  95        ALLOC_GROW(commit_formats, commit_formats_len, commit_formats_alloc);
  96        memcpy(commit_formats, builtin_formats,
  97               sizeof(*builtin_formats)*ARRAY_SIZE(builtin_formats));
  98
  99        git_config(git_pretty_formats_config, NULL);
 100}
 101
 102static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
 103                                                        const char *original,
 104                                                        int num_redirections)
 105{
 106        struct cmt_fmt_map *found = NULL;
 107        size_t found_match_len = 0;
 108        int i;
 109
 110        if (num_redirections >= commit_formats_len)
 111                die("invalid --pretty format: "
 112                    "'%s' references an alias which points to itself",
 113                    original);
 114
 115        for (i = 0; i < commit_formats_len; i++) {
 116                size_t match_len;
 117
 118                if (prefixcmp(commit_formats[i].name, sought))
 119                        continue;
 120
 121                match_len = strlen(commit_formats[i].name);
 122                if (found == NULL || found_match_len > match_len) {
 123                        found = &commit_formats[i];
 124                        found_match_len = match_len;
 125                }
 126        }
 127
 128        if (found && found->is_alias) {
 129                found = find_commit_format_recursive(found->user_format,
 130                                                     original,
 131                                                     num_redirections+1);
 132        }
 133
 134        return found;
 135}
 136
 137static struct cmt_fmt_map *find_commit_format(const char *sought)
 138{
 139        if (!commit_formats)
 140                setup_commit_formats();
 141
 142        return find_commit_format_recursive(sought, sought, 0);
 143}
 144
 145void get_commit_format(const char *arg, struct rev_info *rev)
 146{
 147        struct cmt_fmt_map *commit_format;
 148
 149        rev->use_terminator = 0;
 150        if (!arg || !*arg) {
 151                rev->commit_format = CMIT_FMT_DEFAULT;
 152                return;
 153        }
 154        if (!prefixcmp(arg, "format:") || !prefixcmp(arg, "tformat:")) {
 155                save_user_format(rev, strchr(arg, ':') + 1, arg[0] == 't');
 156                return;
 157        }
 158
 159        if (strchr(arg, '%')) {
 160                save_user_format(rev, arg, 1);
 161                return;
 162        }
 163
 164        commit_format = find_commit_format(arg);
 165        if (!commit_format)
 166                die("invalid --pretty format: %s", arg);
 167
 168        rev->commit_format = commit_format->format;
 169        rev->use_terminator = commit_format->is_tformat;
 170        if (commit_format->format == CMIT_FMT_USERFORMAT) {
 171                save_user_format(rev, commit_format->user_format,
 172                                 commit_format->is_tformat);
 173        }
 174}
 175
 176/*
 177 * Generic support for pretty-printing the header
 178 */
 179static int get_one_line(const char *msg)
 180{
 181        int ret = 0;
 182
 183        for (;;) {
 184                char c = *msg++;
 185                if (!c)
 186                        break;
 187                ret++;
 188                if (c == '\n')
 189                        break;
 190        }
 191        return ret;
 192}
 193
 194/* High bit set, or ISO-2022-INT */
 195static int non_ascii(int ch)
 196{
 197        return !isascii(ch) || ch == '\033';
 198}
 199
 200int has_non_ascii(const char *s)
 201{
 202        int ch;
 203        if (!s)
 204                return 0;
 205        while ((ch = *s++) != '\0') {
 206                if (non_ascii(ch))
 207                        return 1;
 208        }
 209        return 0;
 210}
 211
 212static int is_rfc822_special(char ch)
 213{
 214        switch (ch) {
 215        case '(':
 216        case ')':
 217        case '<':
 218        case '>':
 219        case '[':
 220        case ']':
 221        case ':':
 222        case ';':
 223        case '@':
 224        case ',':
 225        case '.':
 226        case '"':
 227        case '\\':
 228                return 1;
 229        default:
 230                return 0;
 231        }
 232}
 233
 234static int has_rfc822_specials(const char *s, int len)
 235{
 236        int i;
 237        for (i = 0; i < len; i++)
 238                if (is_rfc822_special(s[i]))
 239                        return 1;
 240        return 0;
 241}
 242
 243static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
 244{
 245        int i;
 246
 247        /* just a guess, we may have to also backslash-quote */
 248        strbuf_grow(out, len + 2);
 249
 250        strbuf_addch(out, '"');
 251        for (i = 0; i < len; i++) {
 252                switch (s[i]) {
 253                case '"':
 254                case '\\':
 255                        strbuf_addch(out, '\\');
 256                        /* fall through */
 257                default:
 258                        strbuf_addch(out, s[i]);
 259                }
 260        }
 261        strbuf_addch(out, '"');
 262}
 263
 264static int is_rfc2047_special(char ch)
 265{
 266        return (non_ascii(ch) || (ch == '=') || (ch == '?') || (ch == '_'));
 267}
 268
 269static void add_rfc2047(struct strbuf *sb, const char *line, int len,
 270                       const char *encoding)
 271{
 272        static const int max_length = 78; /* per rfc2822 */
 273        int i;
 274        int line_len;
 275
 276        /* How many bytes are already used on the current line? */
 277        for (i = sb->len - 1; i >= 0; i--)
 278                if (sb->buf[i] == '\n')
 279                        break;
 280        line_len = sb->len - (i+1);
 281
 282        for (i = 0; i < len; i++) {
 283                int ch = line[i];
 284                if (non_ascii(ch) || ch == '\n')
 285                        goto needquote;
 286                if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
 287                        goto needquote;
 288        }
 289        strbuf_add_wrapped_bytes(sb, line, len, 0, 1, max_length - line_len);
 290        return;
 291
 292needquote:
 293        strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
 294        strbuf_addf(sb, "=?%s?q?", encoding);
 295        line_len += strlen(encoding) + 5; /* 5 for =??q? */
 296        for (i = 0; i < len; i++) {
 297                unsigned ch = line[i] & 0xFF;
 298
 299                if (line_len >= max_length - 2) {
 300                        strbuf_addf(sb, "?=\n =?%s?q?", encoding);
 301                        line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
 302                }
 303
 304                /*
 305                 * We encode ' ' using '=20' even though rfc2047
 306                 * allows using '_' for readability.  Unfortunately,
 307                 * many programs do not understand this and just
 308                 * leave the underscore in place.
 309                 */
 310                if (is_rfc2047_special(ch) || ch == ' ' || ch == '\n') {
 311                        strbuf_addf(sb, "=%02X", ch);
 312                        line_len += 3;
 313                }
 314                else {
 315                        strbuf_addch(sb, ch);
 316                        line_len++;
 317                }
 318        }
 319        strbuf_addstr(sb, "?=");
 320}
 321
 322void pp_user_info(const struct pretty_print_context *pp,
 323                  const char *what, struct strbuf *sb,
 324                  const char *line, const char *encoding)
 325{
 326        char *date;
 327        int namelen;
 328        unsigned long time;
 329        int tz;
 330
 331        if (pp->fmt == CMIT_FMT_ONELINE)
 332                return;
 333        date = strchr(line, '>');
 334        if (!date)
 335                return;
 336        namelen = ++date - line;
 337        time = strtoul(date, &date, 10);
 338        tz = strtol(date, NULL, 10);
 339
 340        if (pp->fmt == CMIT_FMT_EMAIL) {
 341                char *name_tail = strchr(line, '<');
 342                int display_name_length;
 343                int final_line;
 344                if (!name_tail)
 345                        return;
 346                while (line < name_tail && isspace(name_tail[-1]))
 347                        name_tail--;
 348                display_name_length = name_tail - line;
 349                strbuf_addstr(sb, "From: ");
 350                if (!has_rfc822_specials(line, display_name_length)) {
 351                        add_rfc2047(sb, line, display_name_length, encoding);
 352                } else {
 353                        struct strbuf quoted = STRBUF_INIT;
 354                        add_rfc822_quoted(&quoted, line, display_name_length);
 355                        add_rfc2047(sb, quoted.buf, quoted.len, encoding);
 356                        strbuf_release(&quoted);
 357                }
 358                for (final_line = 0; final_line < sb->len; final_line++)
 359                        if (sb->buf[sb->len - final_line - 1] == '\n')
 360                                break;
 361                if (namelen - display_name_length + final_line > 78) {
 362                        strbuf_addch(sb, '\n');
 363                        if (!isspace(name_tail[0]))
 364                                strbuf_addch(sb, ' ');
 365                }
 366                strbuf_add(sb, name_tail, namelen - display_name_length);
 367                strbuf_addch(sb, '\n');
 368        } else {
 369                strbuf_addf(sb, "%s: %.*s%.*s\n", what,
 370                              (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0,
 371                              "    ", namelen, line);
 372        }
 373        switch (pp->fmt) {
 374        case CMIT_FMT_MEDIUM:
 375                strbuf_addf(sb, "Date:   %s\n", show_date(time, tz, pp->date_mode));
 376                break;
 377        case CMIT_FMT_EMAIL:
 378                strbuf_addf(sb, "Date: %s\n", show_date(time, tz, DATE_RFC2822));
 379                break;
 380        case CMIT_FMT_FULLER:
 381                strbuf_addf(sb, "%sDate: %s\n", what, show_date(time, tz, pp->date_mode));
 382                break;
 383        default:
 384                /* notin' */
 385                break;
 386        }
 387}
 388
 389static int is_empty_line(const char *line, int *len_p)
 390{
 391        int len = *len_p;
 392        while (len && isspace(line[len-1]))
 393                len--;
 394        *len_p = len;
 395        return !len;
 396}
 397
 398static const char *skip_empty_lines(const char *msg)
 399{
 400        for (;;) {
 401                int linelen = get_one_line(msg);
 402                int ll = linelen;
 403                if (!linelen)
 404                        break;
 405                if (!is_empty_line(msg, &ll))
 406                        break;
 407                msg += linelen;
 408        }
 409        return msg;
 410}
 411
 412static void add_merge_info(const struct pretty_print_context *pp,
 413                           struct strbuf *sb, const struct commit *commit)
 414{
 415        struct commit_list *parent = commit->parents;
 416
 417        if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
 418            !parent || !parent->next)
 419                return;
 420
 421        strbuf_addstr(sb, "Merge:");
 422
 423        while (parent) {
 424                struct commit *p = parent->item;
 425                const char *hex = NULL;
 426                if (pp->abbrev)
 427                        hex = find_unique_abbrev(p->object.sha1, pp->abbrev);
 428                if (!hex)
 429                        hex = sha1_to_hex(p->object.sha1);
 430                parent = parent->next;
 431
 432                strbuf_addf(sb, " %s", hex);
 433        }
 434        strbuf_addch(sb, '\n');
 435}
 436
 437static char *get_header(const struct commit *commit, const char *key)
 438{
 439        int key_len = strlen(key);
 440        const char *line = commit->buffer;
 441
 442        while (line) {
 443                const char *eol = strchr(line, '\n'), *next;
 444
 445                if (line == eol)
 446                        return NULL;
 447                if (!eol) {
 448                        warning("malformed commit (header is missing newline): %s",
 449                                sha1_to_hex(commit->object.sha1));
 450                        eol = line + strlen(line);
 451                        next = NULL;
 452                } else
 453                        next = eol + 1;
 454                if (eol - line > key_len &&
 455                    !strncmp(line, key, key_len) &&
 456                    line[key_len] == ' ') {
 457                        return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
 458                }
 459                line = next;
 460        }
 461        return NULL;
 462}
 463
 464static char *replace_encoding_header(char *buf, const char *encoding)
 465{
 466        struct strbuf tmp = STRBUF_INIT;
 467        size_t start, len;
 468        char *cp = buf;
 469
 470        /* guess if there is an encoding header before a \n\n */
 471        while (strncmp(cp, "encoding ", strlen("encoding "))) {
 472                cp = strchr(cp, '\n');
 473                if (!cp || *++cp == '\n')
 474                        return buf;
 475        }
 476        start = cp - buf;
 477        cp = strchr(cp, '\n');
 478        if (!cp)
 479                return buf; /* should not happen but be defensive */
 480        len = cp + 1 - (buf + start);
 481
 482        strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
 483        if (is_encoding_utf8(encoding)) {
 484                /* we have re-coded to UTF-8; drop the header */
 485                strbuf_remove(&tmp, start, len);
 486        } else {
 487                /* just replaces XXXX in 'encoding XXXX\n' */
 488                strbuf_splice(&tmp, start + strlen("encoding "),
 489                                          len - strlen("encoding \n"),
 490                                          encoding, strlen(encoding));
 491        }
 492        return strbuf_detach(&tmp, NULL);
 493}
 494
 495char *logmsg_reencode(const struct commit *commit,
 496                      const char *output_encoding)
 497{
 498        static const char *utf8 = "UTF-8";
 499        const char *use_encoding;
 500        char *encoding;
 501        char *out;
 502
 503        if (!*output_encoding)
 504                return NULL;
 505        encoding = get_header(commit, "encoding");
 506        use_encoding = encoding ? encoding : utf8;
 507        if (!strcmp(use_encoding, output_encoding))
 508                if (encoding) /* we'll strip encoding header later */
 509                        out = xstrdup(commit->buffer);
 510                else
 511                        return NULL; /* nothing to do */
 512        else
 513                out = reencode_string(commit->buffer,
 514                                      output_encoding, use_encoding);
 515        if (out)
 516                out = replace_encoding_header(out, output_encoding);
 517
 518        free(encoding);
 519        return out;
 520}
 521
 522static int mailmap_name(char *email, int email_len, char *name, int name_len)
 523{
 524        static struct string_list *mail_map;
 525        if (!mail_map) {
 526                mail_map = xcalloc(1, sizeof(*mail_map));
 527                read_mailmap(mail_map, NULL);
 528        }
 529        return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
 530}
 531
 532static size_t format_person_part(struct strbuf *sb, char part,
 533                                 const char *msg, int len, enum date_mode dmode)
 534{
 535        /* currently all placeholders have same length */
 536        const int placeholder_len = 2;
 537        int tz;
 538        unsigned long date = 0;
 539        char person_name[1024];
 540        char person_mail[1024];
 541        struct ident_split s;
 542        const char *name_start, *name_end, *mail_start, *mail_end;
 543
 544        if (split_ident_line(&s, msg, len) < 0)
 545                goto skip;
 546
 547        name_start = s.name_begin;
 548        name_end = s.name_end;
 549        mail_start = s.mail_begin;
 550        mail_end = s.mail_end;
 551
 552        if (part == 'N' || part == 'E') { /* mailmap lookup */
 553                snprintf(person_name, sizeof(person_name), "%.*s",
 554                         (int)(name_end - name_start), name_start);
 555                snprintf(person_mail, sizeof(person_mail), "%.*s",
 556                         (int)(mail_end - mail_start), mail_start);
 557                mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
 558                name_start = person_name;
 559                name_end = name_start + strlen(person_name);
 560                mail_start = person_mail;
 561                mail_end = mail_start +  strlen(person_mail);
 562        }
 563        if (part == 'n' || part == 'N') {       /* name */
 564                strbuf_add(sb, name_start, name_end-name_start);
 565                return placeholder_len;
 566        }
 567        if (part == 'e' || part == 'E') {       /* email */
 568                strbuf_add(sb, mail_start, mail_end-mail_start);
 569                return placeholder_len;
 570        }
 571
 572        if (!s.date_begin)
 573                goto skip;
 574
 575        date = strtoul(s.date_begin, NULL, 10);
 576
 577        if (part == 't') {      /* date, UNIX timestamp */
 578                strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
 579                return placeholder_len;
 580        }
 581
 582        /* parse tz */
 583        tz = strtoul(s.tz_begin + 1, NULL, 10);
 584        if (*s.tz_begin == '-')
 585                tz = -tz;
 586
 587        switch (part) {
 588        case 'd':       /* date */
 589                strbuf_addstr(sb, show_date(date, tz, dmode));
 590                return placeholder_len;
 591        case 'D':       /* date, RFC2822 style */
 592                strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
 593                return placeholder_len;
 594        case 'r':       /* date, relative */
 595                strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
 596                return placeholder_len;
 597        case 'i':       /* date, ISO 8601 */
 598                strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
 599                return placeholder_len;
 600        }
 601
 602skip:
 603        /*
 604         * reading from either a bogus commit, or a reflog entry with
 605         * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
 606         * to compute a valid return value.
 607         */
 608        if (part == 'n' || part == 'e' || part == 't' || part == 'd'
 609            || part == 'D' || part == 'r' || part == 'i')
 610                return placeholder_len;
 611
 612        return 0; /* unknown placeholder */
 613}
 614
 615struct chunk {
 616        size_t off;
 617        size_t len;
 618};
 619
 620struct format_commit_context {
 621        const struct commit *commit;
 622        const struct pretty_print_context *pretty_ctx;
 623        unsigned commit_header_parsed:1;
 624        unsigned commit_message_parsed:1;
 625        unsigned commit_signature_parsed:1;
 626        struct {
 627                char *gpg_output;
 628                char good_bad;
 629                char *signer;
 630        } signature;
 631        char *message;
 632        size_t width, indent1, indent2;
 633
 634        /* These offsets are relative to the start of the commit message. */
 635        struct chunk author;
 636        struct chunk committer;
 637        struct chunk encoding;
 638        size_t message_off;
 639        size_t subject_off;
 640        size_t body_off;
 641
 642        /* The following ones are relative to the result struct strbuf. */
 643        struct chunk abbrev_commit_hash;
 644        struct chunk abbrev_tree_hash;
 645        struct chunk abbrev_parent_hashes;
 646        size_t wrap_start;
 647};
 648
 649static int add_again(struct strbuf *sb, struct chunk *chunk)
 650{
 651        if (chunk->len) {
 652                strbuf_adddup(sb, chunk->off, chunk->len);
 653                return 1;
 654        }
 655
 656        /*
 657         * We haven't seen this chunk before.  Our caller is surely
 658         * going to add it the hard way now.  Remember the most likely
 659         * start of the to-be-added chunk: the current end of the
 660         * struct strbuf.
 661         */
 662        chunk->off = sb->len;
 663        return 0;
 664}
 665
 666static void parse_commit_header(struct format_commit_context *context)
 667{
 668        const char *msg = context->message;
 669        int i;
 670
 671        for (i = 0; msg[i]; i++) {
 672                int eol;
 673                for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
 674                        ; /* do nothing */
 675
 676                if (i == eol) {
 677                        break;
 678                } else if (!prefixcmp(msg + i, "author ")) {
 679                        context->author.off = i + 7;
 680                        context->author.len = eol - i - 7;
 681                } else if (!prefixcmp(msg + i, "committer ")) {
 682                        context->committer.off = i + 10;
 683                        context->committer.len = eol - i - 10;
 684                } else if (!prefixcmp(msg + i, "encoding ")) {
 685                        context->encoding.off = i + 9;
 686                        context->encoding.len = eol - i - 9;
 687                }
 688                i = eol;
 689        }
 690        context->message_off = i;
 691        context->commit_header_parsed = 1;
 692}
 693
 694static int istitlechar(char c)
 695{
 696        return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
 697                (c >= '0' && c <= '9') || c == '.' || c == '_';
 698}
 699
 700static void format_sanitized_subject(struct strbuf *sb, const char *msg)
 701{
 702        size_t trimlen;
 703        size_t start_len = sb->len;
 704        int space = 2;
 705
 706        for (; *msg && *msg != '\n'; msg++) {
 707                if (istitlechar(*msg)) {
 708                        if (space == 1)
 709                                strbuf_addch(sb, '-');
 710                        space = 0;
 711                        strbuf_addch(sb, *msg);
 712                        if (*msg == '.')
 713                                while (*(msg+1) == '.')
 714                                        msg++;
 715                } else
 716                        space |= 1;
 717        }
 718
 719        /* trim any trailing '.' or '-' characters */
 720        trimlen = 0;
 721        while (sb->len - trimlen > start_len &&
 722                (sb->buf[sb->len - 1 - trimlen] == '.'
 723                || sb->buf[sb->len - 1 - trimlen] == '-'))
 724                trimlen++;
 725        strbuf_remove(sb, sb->len - trimlen, trimlen);
 726}
 727
 728const char *format_subject(struct strbuf *sb, const char *msg,
 729                           const char *line_separator)
 730{
 731        int first = 1;
 732
 733        for (;;) {
 734                const char *line = msg;
 735                int linelen = get_one_line(line);
 736
 737                msg += linelen;
 738                if (!linelen || is_empty_line(line, &linelen))
 739                        break;
 740
 741                if (!sb)
 742                        continue;
 743                strbuf_grow(sb, linelen + 2);
 744                if (!first)
 745                        strbuf_addstr(sb, line_separator);
 746                strbuf_add(sb, line, linelen);
 747                first = 0;
 748        }
 749        return msg;
 750}
 751
 752static void parse_commit_message(struct format_commit_context *c)
 753{
 754        const char *msg = c->message + c->message_off;
 755        const char *start = c->message;
 756
 757        msg = skip_empty_lines(msg);
 758        c->subject_off = msg - start;
 759
 760        msg = format_subject(NULL, msg, NULL);
 761        msg = skip_empty_lines(msg);
 762        c->body_off = msg - start;
 763
 764        c->commit_message_parsed = 1;
 765}
 766
 767static void format_decoration(struct strbuf *sb, const struct commit *commit)
 768{
 769        struct name_decoration *d;
 770        const char *prefix = " (";
 771
 772        load_ref_decorations(DECORATE_SHORT_REFS);
 773        d = lookup_decoration(&name_decoration, &commit->object);
 774        while (d) {
 775                strbuf_addstr(sb, prefix);
 776                prefix = ", ";
 777                strbuf_addstr(sb, d->name);
 778                d = d->next;
 779        }
 780        if (prefix[0] == ',')
 781                strbuf_addch(sb, ')');
 782}
 783
 784static void strbuf_wrap(struct strbuf *sb, size_t pos,
 785                        size_t width, size_t indent1, size_t indent2)
 786{
 787        struct strbuf tmp = STRBUF_INIT;
 788
 789        if (pos)
 790                strbuf_add(&tmp, sb->buf, pos);
 791        strbuf_add_wrapped_text(&tmp, sb->buf + pos,
 792                                (int) indent1, (int) indent2, (int) width);
 793        strbuf_swap(&tmp, sb);
 794        strbuf_release(&tmp);
 795}
 796
 797static void rewrap_message_tail(struct strbuf *sb,
 798                                struct format_commit_context *c,
 799                                size_t new_width, size_t new_indent1,
 800                                size_t new_indent2)
 801{
 802        if (c->width == new_width && c->indent1 == new_indent1 &&
 803            c->indent2 == new_indent2)
 804                return;
 805        if (c->wrap_start < sb->len)
 806                strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
 807        c->wrap_start = sb->len;
 808        c->width = new_width;
 809        c->indent1 = new_indent1;
 810        c->indent2 = new_indent2;
 811}
 812
 813static struct {
 814        char result;
 815        const char *check;
 816} signature_check[] = {
 817        { 'G', ": Good signature from " },
 818        { 'B', ": BAD signature from " },
 819};
 820
 821static void parse_signature_lines(struct format_commit_context *ctx)
 822{
 823        const char *buf = ctx->signature.gpg_output;
 824        int i;
 825
 826        for (i = 0; i < ARRAY_SIZE(signature_check); i++) {
 827                const char *found = strstr(buf, signature_check[i].check);
 828                const char *next;
 829                if (!found)
 830                        continue;
 831                ctx->signature.good_bad = signature_check[i].result;
 832                found += strlen(signature_check[i].check);
 833                next = strchrnul(found, '\n');
 834                ctx->signature.signer = xmemdupz(found, next - found);
 835                break;
 836        }
 837}
 838
 839static void parse_commit_signature(struct format_commit_context *ctx)
 840{
 841        struct strbuf payload = STRBUF_INIT;
 842        struct strbuf signature = STRBUF_INIT;
 843        struct strbuf gpg_output = STRBUF_INIT;
 844        int status;
 845
 846        ctx->commit_signature_parsed = 1;
 847
 848        if (parse_signed_commit(ctx->commit->object.sha1,
 849                                &payload, &signature) <= 0)
 850                goto out;
 851        status = verify_signed_buffer(payload.buf, payload.len,
 852                                      signature.buf, signature.len,
 853                                      &gpg_output);
 854        if (status && !gpg_output.len)
 855                goto out;
 856        ctx->signature.gpg_output = strbuf_detach(&gpg_output, NULL);
 857        parse_signature_lines(ctx);
 858
 859 out:
 860        strbuf_release(&gpg_output);
 861        strbuf_release(&payload);
 862        strbuf_release(&signature);
 863}
 864
 865
 866static int format_reflog_person(struct strbuf *sb,
 867                                char part,
 868                                struct reflog_walk_info *log,
 869                                enum date_mode dmode)
 870{
 871        const char *ident;
 872
 873        if (!log)
 874                return 2;
 875
 876        ident = get_reflog_ident(log);
 877        if (!ident)
 878                return 2;
 879
 880        return format_person_part(sb, part, ident, strlen(ident), dmode);
 881}
 882
 883static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
 884                                void *context)
 885{
 886        struct format_commit_context *c = context;
 887        const struct commit *commit = c->commit;
 888        const char *msg = c->message;
 889        struct commit_list *p;
 890        int h1, h2;
 891
 892        /* these are independent of the commit */
 893        switch (placeholder[0]) {
 894        case 'C':
 895                if (placeholder[1] == '(') {
 896                        const char *end = strchr(placeholder + 2, ')');
 897                        char color[COLOR_MAXLEN];
 898                        if (!end)
 899                                return 0;
 900                        color_parse_mem(placeholder + 2,
 901                                        end - (placeholder + 2),
 902                                        "--pretty format", color);
 903                        strbuf_addstr(sb, color);
 904                        return end - placeholder + 1;
 905                }
 906                if (!prefixcmp(placeholder + 1, "red")) {
 907                        strbuf_addstr(sb, GIT_COLOR_RED);
 908                        return 4;
 909                } else if (!prefixcmp(placeholder + 1, "green")) {
 910                        strbuf_addstr(sb, GIT_COLOR_GREEN);
 911                        return 6;
 912                } else if (!prefixcmp(placeholder + 1, "blue")) {
 913                        strbuf_addstr(sb, GIT_COLOR_BLUE);
 914                        return 5;
 915                } else if (!prefixcmp(placeholder + 1, "reset")) {
 916                        strbuf_addstr(sb, GIT_COLOR_RESET);
 917                        return 6;
 918                } else
 919                        return 0;
 920        case 'n':               /* newline */
 921                strbuf_addch(sb, '\n');
 922                return 1;
 923        case 'x':
 924                /* %x00 == NUL, %x0a == LF, etc. */
 925                if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
 926                    h1 <= 16 &&
 927                    0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
 928                    h2 <= 16) {
 929                        strbuf_addch(sb, (h1<<4)|h2);
 930                        return 3;
 931                } else
 932                        return 0;
 933        case 'w':
 934                if (placeholder[1] == '(') {
 935                        unsigned long width = 0, indent1 = 0, indent2 = 0;
 936                        char *next;
 937                        const char *start = placeholder + 2;
 938                        const char *end = strchr(start, ')');
 939                        if (!end)
 940                                return 0;
 941                        if (end > start) {
 942                                width = strtoul(start, &next, 10);
 943                                if (*next == ',') {
 944                                        indent1 = strtoul(next + 1, &next, 10);
 945                                        if (*next == ',') {
 946                                                indent2 = strtoul(next + 1,
 947                                                                 &next, 10);
 948                                        }
 949                                }
 950                                if (*next != ')')
 951                                        return 0;
 952                        }
 953                        rewrap_message_tail(sb, c, width, indent1, indent2);
 954                        return end - placeholder + 1;
 955                } else
 956                        return 0;
 957        }
 958
 959        /* these depend on the commit */
 960        if (!commit->object.parsed)
 961                parse_object(commit->object.sha1);
 962
 963        switch (placeholder[0]) {
 964        case 'H':               /* commit hash */
 965                strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
 966                return 1;
 967        case 'h':               /* abbreviated commit hash */
 968                if (add_again(sb, &c->abbrev_commit_hash))
 969                        return 1;
 970                strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
 971                                                     c->pretty_ctx->abbrev));
 972                c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
 973                return 1;
 974        case 'T':               /* tree hash */
 975                strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
 976                return 1;
 977        case 't':               /* abbreviated tree hash */
 978                if (add_again(sb, &c->abbrev_tree_hash))
 979                        return 1;
 980                strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
 981                                                     c->pretty_ctx->abbrev));
 982                c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
 983                return 1;
 984        case 'P':               /* parent hashes */
 985                for (p = commit->parents; p; p = p->next) {
 986                        if (p != commit->parents)
 987                                strbuf_addch(sb, ' ');
 988                        strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
 989                }
 990                return 1;
 991        case 'p':               /* abbreviated parent hashes */
 992                if (add_again(sb, &c->abbrev_parent_hashes))
 993                        return 1;
 994                for (p = commit->parents; p; p = p->next) {
 995                        if (p != commit->parents)
 996                                strbuf_addch(sb, ' ');
 997                        strbuf_addstr(sb, find_unique_abbrev(
 998                                        p->item->object.sha1,
 999                                        c->pretty_ctx->abbrev));
1000                }
1001                c->abbrev_parent_hashes.len = sb->len -
1002                                              c->abbrev_parent_hashes.off;
1003                return 1;
1004        case 'm':               /* left/right/bottom */
1005                strbuf_addstr(sb, get_revision_mark(NULL, commit));
1006                return 1;
1007        case 'd':
1008                format_decoration(sb, commit);
1009                return 1;
1010        case 'g':               /* reflog info */
1011                switch(placeholder[1]) {
1012                case 'd':       /* reflog selector */
1013                case 'D':
1014                        if (c->pretty_ctx->reflog_info)
1015                                get_reflog_selector(sb,
1016                                                    c->pretty_ctx->reflog_info,
1017                                                    c->pretty_ctx->date_mode,
1018                                                    c->pretty_ctx->date_mode_explicit,
1019                                                    (placeholder[1] == 'd'));
1020                        return 2;
1021                case 's':       /* reflog message */
1022                        if (c->pretty_ctx->reflog_info)
1023                                get_reflog_message(sb, c->pretty_ctx->reflog_info);
1024                        return 2;
1025                case 'n':
1026                case 'N':
1027                case 'e':
1028                case 'E':
1029                        return format_reflog_person(sb,
1030                                                    placeholder[1],
1031                                                    c->pretty_ctx->reflog_info,
1032                                                    c->pretty_ctx->date_mode);
1033                }
1034                return 0;       /* unknown %g placeholder */
1035        case 'N':
1036                if (c->pretty_ctx->show_notes) {
1037                        format_display_notes(commit->object.sha1, sb,
1038                                    get_log_output_encoding(), 0);
1039                        return 1;
1040                }
1041                return 0;
1042        }
1043
1044        if (placeholder[0] == 'G') {
1045                if (!c->commit_signature_parsed)
1046                        parse_commit_signature(c);
1047                switch (placeholder[1]) {
1048                case 'G':
1049                        if (c->signature.gpg_output)
1050                                strbuf_addstr(sb, c->signature.gpg_output);
1051                        break;
1052                case '?':
1053                        switch (c->signature.good_bad) {
1054                        case 'G':
1055                        case 'B':
1056                                strbuf_addch(sb, c->signature.good_bad);
1057                        }
1058                        break;
1059                case 'S':
1060                        if (c->signature.signer)
1061                                strbuf_addstr(sb, c->signature.signer);
1062                        break;
1063                }
1064                return 2;
1065        }
1066
1067
1068        /* For the rest we have to parse the commit header. */
1069        if (!c->commit_header_parsed)
1070                parse_commit_header(c);
1071
1072        switch (placeholder[0]) {
1073        case 'a':       /* author ... */
1074                return format_person_part(sb, placeholder[1],
1075                                   msg + c->author.off, c->author.len,
1076                                   c->pretty_ctx->date_mode);
1077        case 'c':       /* committer ... */
1078                return format_person_part(sb, placeholder[1],
1079                                   msg + c->committer.off, c->committer.len,
1080                                   c->pretty_ctx->date_mode);
1081        case 'e':       /* encoding */
1082                strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
1083                return 1;
1084        case 'B':       /* raw body */
1085                /* message_off is always left at the initial newline */
1086                strbuf_addstr(sb, msg + c->message_off + 1);
1087                return 1;
1088        }
1089
1090        /* Now we need to parse the commit message. */
1091        if (!c->commit_message_parsed)
1092                parse_commit_message(c);
1093
1094        switch (placeholder[0]) {
1095        case 's':       /* subject */
1096                format_subject(sb, msg + c->subject_off, " ");
1097                return 1;
1098        case 'f':       /* sanitized subject */
1099                format_sanitized_subject(sb, msg + c->subject_off);
1100                return 1;
1101        case 'b':       /* body */
1102                strbuf_addstr(sb, msg + c->body_off);
1103                return 1;
1104        }
1105        return 0;       /* unknown placeholder */
1106}
1107
1108static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
1109                                 void *context)
1110{
1111        int consumed;
1112        size_t orig_len;
1113        enum {
1114                NO_MAGIC,
1115                ADD_LF_BEFORE_NON_EMPTY,
1116                DEL_LF_BEFORE_EMPTY,
1117                ADD_SP_BEFORE_NON_EMPTY
1118        } magic = NO_MAGIC;
1119
1120        switch (placeholder[0]) {
1121        case '-':
1122                magic = DEL_LF_BEFORE_EMPTY;
1123                break;
1124        case '+':
1125                magic = ADD_LF_BEFORE_NON_EMPTY;
1126                break;
1127        case ' ':
1128                magic = ADD_SP_BEFORE_NON_EMPTY;
1129                break;
1130        default:
1131                break;
1132        }
1133        if (magic != NO_MAGIC)
1134                placeholder++;
1135
1136        orig_len = sb->len;
1137        consumed = format_commit_one(sb, placeholder, context);
1138        if (magic == NO_MAGIC)
1139                return consumed;
1140
1141        if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1142                while (sb->len && sb->buf[sb->len - 1] == '\n')
1143                        strbuf_setlen(sb, sb->len - 1);
1144        } else if (orig_len != sb->len) {
1145                if (magic == ADD_LF_BEFORE_NON_EMPTY)
1146                        strbuf_insert(sb, orig_len, "\n", 1);
1147                else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1148                        strbuf_insert(sb, orig_len, " ", 1);
1149        }
1150        return consumed + 1;
1151}
1152
1153static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1154                                   void *context)
1155{
1156        struct userformat_want *w = context;
1157
1158        if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1159                placeholder++;
1160
1161        switch (*placeholder) {
1162        case 'N':
1163                w->notes = 1;
1164                break;
1165        }
1166        return 0;
1167}
1168
1169void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1170{
1171        struct strbuf dummy = STRBUF_INIT;
1172
1173        if (!fmt) {
1174                if (!user_format)
1175                        return;
1176                fmt = user_format;
1177        }
1178        strbuf_expand(&dummy, fmt, userformat_want_item, w);
1179        strbuf_release(&dummy);
1180}
1181
1182void format_commit_message(const struct commit *commit,
1183                           const char *format, struct strbuf *sb,
1184                           const struct pretty_print_context *pretty_ctx)
1185{
1186        struct format_commit_context context;
1187        static const char utf8[] = "UTF-8";
1188        const char *output_enc = pretty_ctx->output_encoding;
1189
1190        memset(&context, 0, sizeof(context));
1191        context.commit = commit;
1192        context.pretty_ctx = pretty_ctx;
1193        context.wrap_start = sb->len;
1194        context.message = commit->buffer;
1195        if (output_enc) {
1196                char *enc = get_header(commit, "encoding");
1197                if (strcmp(enc ? enc : utf8, output_enc)) {
1198                        context.message = logmsg_reencode(commit, output_enc);
1199                        if (!context.message)
1200                                context.message = commit->buffer;
1201                }
1202                free(enc);
1203        }
1204
1205        strbuf_expand(sb, format, format_commit_item, &context);
1206        rewrap_message_tail(sb, &context, 0, 0, 0);
1207
1208        if (context.message != commit->buffer)
1209                free(context.message);
1210        free(context.signature.gpg_output);
1211        free(context.signature.signer);
1212}
1213
1214static void pp_header(const struct pretty_print_context *pp,
1215                      const char *encoding,
1216                      const struct commit *commit,
1217                      const char **msg_p,
1218                      struct strbuf *sb)
1219{
1220        int parents_shown = 0;
1221
1222        for (;;) {
1223                const char *line = *msg_p;
1224                int linelen = get_one_line(*msg_p);
1225
1226                if (!linelen)
1227                        return;
1228                *msg_p += linelen;
1229
1230                if (linelen == 1)
1231                        /* End of header */
1232                        return;
1233
1234                if (pp->fmt == CMIT_FMT_RAW) {
1235                        strbuf_add(sb, line, linelen);
1236                        continue;
1237                }
1238
1239                if (!memcmp(line, "parent ", 7)) {
1240                        if (linelen != 48)
1241                                die("bad parent line in commit");
1242                        continue;
1243                }
1244
1245                if (!parents_shown) {
1246                        struct commit_list *parent;
1247                        int num;
1248                        for (parent = commit->parents, num = 0;
1249                             parent;
1250                             parent = parent->next, num++)
1251                                ;
1252                        /* with enough slop */
1253                        strbuf_grow(sb, num * 50 + 20);
1254                        add_merge_info(pp, sb, commit);
1255                        parents_shown = 1;
1256                }
1257
1258                /*
1259                 * MEDIUM == DEFAULT shows only author with dates.
1260                 * FULL shows both authors but not dates.
1261                 * FULLER shows both authors and dates.
1262                 */
1263                if (!memcmp(line, "author ", 7)) {
1264                        strbuf_grow(sb, linelen + 80);
1265                        pp_user_info(pp, "Author", sb, line + 7, encoding);
1266                }
1267                if (!memcmp(line, "committer ", 10) &&
1268                    (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1269                        strbuf_grow(sb, linelen + 80);
1270                        pp_user_info(pp, "Commit", sb, line + 10, encoding);
1271                }
1272        }
1273}
1274
1275void pp_title_line(const struct pretty_print_context *pp,
1276                   const char **msg_p,
1277                   struct strbuf *sb,
1278                   const char *encoding,
1279                   int need_8bit_cte)
1280{
1281        struct strbuf title;
1282
1283        strbuf_init(&title, 80);
1284        *msg_p = format_subject(&title, *msg_p,
1285                                pp->preserve_subject ? "\n" : " ");
1286
1287        strbuf_grow(sb, title.len + 1024);
1288        if (pp->subject) {
1289                strbuf_addstr(sb, pp->subject);
1290                add_rfc2047(sb, title.buf, title.len, encoding);
1291        } else {
1292                strbuf_addbuf(sb, &title);
1293        }
1294        strbuf_addch(sb, '\n');
1295
1296        if (need_8bit_cte > 0) {
1297                const char *header_fmt =
1298                        "MIME-Version: 1.0\n"
1299                        "Content-Type: text/plain; charset=%s\n"
1300                        "Content-Transfer-Encoding: 8bit\n";
1301                strbuf_addf(sb, header_fmt, encoding);
1302        }
1303        if (pp->after_subject) {
1304                strbuf_addstr(sb, pp->after_subject);
1305        }
1306        if (pp->fmt == CMIT_FMT_EMAIL) {
1307                strbuf_addch(sb, '\n');
1308        }
1309        strbuf_release(&title);
1310}
1311
1312void pp_remainder(const struct pretty_print_context *pp,
1313                  const char **msg_p,
1314                  struct strbuf *sb,
1315                  int indent)
1316{
1317        int first = 1;
1318        for (;;) {
1319                const char *line = *msg_p;
1320                int linelen = get_one_line(line);
1321                *msg_p += linelen;
1322
1323                if (!linelen)
1324                        break;
1325
1326                if (is_empty_line(line, &linelen)) {
1327                        if (first)
1328                                continue;
1329                        if (pp->fmt == CMIT_FMT_SHORT)
1330                                break;
1331                }
1332                first = 0;
1333
1334                strbuf_grow(sb, linelen + indent + 20);
1335                if (indent) {
1336                        memset(sb->buf + sb->len, ' ', indent);
1337                        strbuf_setlen(sb, sb->len + indent);
1338                }
1339                strbuf_add(sb, line, linelen);
1340                strbuf_addch(sb, '\n');
1341        }
1342}
1343
1344char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
1345{
1346        const char *encoding;
1347
1348        encoding = get_log_output_encoding();
1349        if (encoding_p)
1350                *encoding_p = encoding;
1351        return logmsg_reencode(commit, encoding);
1352}
1353
1354void pretty_print_commit(const struct pretty_print_context *pp,
1355                         const struct commit *commit,
1356                         struct strbuf *sb)
1357{
1358        unsigned long beginning_of_body;
1359        int indent = 4;
1360        const char *msg = commit->buffer;
1361        char *reencoded;
1362        const char *encoding;
1363        int need_8bit_cte = pp->need_8bit_cte;
1364
1365        if (pp->fmt == CMIT_FMT_USERFORMAT) {
1366                format_commit_message(commit, user_format, sb, pp);
1367                return;
1368        }
1369
1370        reencoded = reencode_commit_message(commit, &encoding);
1371        if (reencoded) {
1372                msg = reencoded;
1373        }
1374
1375        if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1376                indent = 0;
1377
1378        /*
1379         * We need to check and emit Content-type: to mark it
1380         * as 8-bit if we haven't done so.
1381         */
1382        if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1383                int i, ch, in_body;
1384
1385                for (in_body = i = 0; (ch = msg[i]); i++) {
1386                        if (!in_body) {
1387                                /* author could be non 7-bit ASCII but
1388                                 * the log may be so; skip over the
1389                                 * header part first.
1390                                 */
1391                                if (ch == '\n' && msg[i+1] == '\n')
1392                                        in_body = 1;
1393                        }
1394                        else if (non_ascii(ch)) {
1395                                need_8bit_cte = 1;
1396                                break;
1397                        }
1398                }
1399        }
1400
1401        pp_header(pp, encoding, commit, &msg, sb);
1402        if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1403                strbuf_addch(sb, '\n');
1404        }
1405
1406        /* Skip excess blank lines at the beginning of body, if any... */
1407        msg = skip_empty_lines(msg);
1408
1409        /* These formats treat the title line specially. */
1410        if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1411                pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1412
1413        beginning_of_body = sb->len;
1414        if (pp->fmt != CMIT_FMT_ONELINE)
1415                pp_remainder(pp, &msg, sb, indent);
1416        strbuf_rtrim(sb);
1417
1418        /* Make sure there is an EOLN for the non-oneline case */
1419        if (pp->fmt != CMIT_FMT_ONELINE)
1420                strbuf_addch(sb, '\n');
1421
1422        /*
1423         * The caller may append additional body text in e-mail
1424         * format.  Make sure we did not strip the blank line
1425         * between the header and the body.
1426         */
1427        if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1428                strbuf_addch(sb, '\n');
1429
1430        if (pp->show_notes)
1431                format_display_notes(commit->object.sha1, sb, encoding,
1432                                     NOTES_SHOW_HEADER | NOTES_INDENT);
1433
1434        free(reencoded);
1435}
1436
1437void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1438                    struct strbuf *sb)
1439{
1440        struct pretty_print_context pp = {0};
1441        pp.fmt = fmt;
1442        pretty_print_commit(&pp, commit, sb);
1443}