pretty.con commit README: Git is released under the GPLv2, not just "the GPL" (779d7e9)
   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 needs_rfc822_quoting(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 int last_line_length(struct strbuf *sb)
 244{
 245        int i;
 246
 247        /* How many bytes are already used on the last line? */
 248        for (i = sb->len - 1; i >= 0; i--)
 249                if (sb->buf[i] == '\n')
 250                        break;
 251        return sb->len - (i + 1);
 252}
 253
 254static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
 255{
 256        int i;
 257
 258        /* just a guess, we may have to also backslash-quote */
 259        strbuf_grow(out, len + 2);
 260
 261        strbuf_addch(out, '"');
 262        for (i = 0; i < len; i++) {
 263                switch (s[i]) {
 264                case '"':
 265                case '\\':
 266                        strbuf_addch(out, '\\');
 267                        /* fall through */
 268                default:
 269                        strbuf_addch(out, s[i]);
 270                }
 271        }
 272        strbuf_addch(out, '"');
 273}
 274
 275enum rfc2047_type {
 276        RFC2047_SUBJECT,
 277        RFC2047_ADDRESS,
 278};
 279
 280static int is_rfc2047_special(char ch, enum rfc2047_type type)
 281{
 282        /*
 283         * rfc2047, section 4.2:
 284         *
 285         *    8-bit values which correspond to printable ASCII characters other
 286         *    than "=", "?", and "_" (underscore), MAY be represented as those
 287         *    characters.  (But see section 5 for restrictions.)  In
 288         *    particular, SPACE and TAB MUST NOT be represented as themselves
 289         *    within encoded words.
 290         */
 291
 292        /*
 293         * rule out non-ASCII characters and non-printable characters (the
 294         * non-ASCII check should be redundant as isprint() is not localized
 295         * and only knows about ASCII, but be defensive about that)
 296         */
 297        if (non_ascii(ch) || !isprint(ch))
 298                return 1;
 299
 300        /*
 301         * rule out special printable characters (' ' should be the only
 302         * whitespace character considered printable, but be defensive and use
 303         * isspace())
 304         */
 305        if (isspace(ch) || ch == '=' || ch == '?' || ch == '_')
 306                return 1;
 307
 308        /*
 309         * rfc2047, section 5.3:
 310         *
 311         *    As a replacement for a 'word' entity within a 'phrase', for example,
 312         *    one that precedes an address in a From, To, or Cc header.  The ABNF
 313         *    definition for 'phrase' from RFC 822 thus becomes:
 314         *
 315         *    phrase = 1*( encoded-word / word )
 316         *
 317         *    In this case the set of characters that may be used in a "Q"-encoded
 318         *    'encoded-word' is restricted to: <upper and lower case ASCII
 319         *    letters, decimal digits, "!", "*", "+", "-", "/", "=", and "_"
 320         *    (underscore, ASCII 95.)>.  An 'encoded-word' that appears within a
 321         *    'phrase' MUST be separated from any adjacent 'word', 'text' or
 322         *    'special' by 'linear-white-space'.
 323         */
 324
 325        if (type != RFC2047_ADDRESS)
 326                return 0;
 327
 328        /* '=' and '_' are special cases and have been checked above */
 329        return !(isalnum(ch) || ch == '!' || ch == '*' || ch == '+' || ch == '-' || ch == '/');
 330}
 331
 332static int needs_rfc2047_encoding(const char *line, int len,
 333                                  enum rfc2047_type type)
 334{
 335        int i;
 336
 337        for (i = 0; i < len; i++) {
 338                int ch = line[i];
 339                if (non_ascii(ch) || ch == '\n')
 340                        return 1;
 341                if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
 342                        return 1;
 343        }
 344
 345        return 0;
 346}
 347
 348static void add_rfc2047(struct strbuf *sb, const char *line, int len,
 349                       const char *encoding, enum rfc2047_type type)
 350{
 351        static const int max_encoded_length = 76; /* per rfc2047 */
 352        int i;
 353        int line_len = last_line_length(sb);
 354
 355        strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
 356        strbuf_addf(sb, "=?%s?q?", encoding);
 357        line_len += strlen(encoding) + 5; /* 5 for =??q? */
 358        for (i = 0; i < len; i++) {
 359                unsigned ch = line[i] & 0xFF;
 360                int is_special = is_rfc2047_special(ch, type);
 361
 362                /*
 363                 * According to RFC 2047, we could encode the special character
 364                 * ' ' (space) with '_' (underscore) for readability. But many
 365                 * programs do not understand this and just leave the
 366                 * underscore in place. Thus, we do nothing special here, which
 367                 * causes ' ' to be encoded as '=20', avoiding this problem.
 368                 */
 369
 370                if (line_len + 2 + (is_special ? 3 : 1) > max_encoded_length) {
 371                        strbuf_addf(sb, "?=\n =?%s?q?", encoding);
 372                        line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
 373                }
 374
 375                if (is_special) {
 376                        strbuf_addf(sb, "=%02X", ch);
 377                        line_len += 3;
 378                } else {
 379                        strbuf_addch(sb, ch);
 380                        line_len++;
 381                }
 382        }
 383        strbuf_addstr(sb, "?=");
 384}
 385
 386void pp_user_info(const struct pretty_print_context *pp,
 387                  const char *what, struct strbuf *sb,
 388                  const char *line, const char *encoding)
 389{
 390        int max_length = 78; /* per rfc2822 */
 391        char *date;
 392        int namelen;
 393        unsigned long time;
 394        int tz;
 395
 396        if (pp->fmt == CMIT_FMT_ONELINE)
 397                return;
 398        date = strchr(line, '>');
 399        if (!date)
 400                return;
 401        namelen = ++date - line;
 402        time = strtoul(date, &date, 10);
 403        tz = strtol(date, NULL, 10);
 404
 405        if (pp->fmt == CMIT_FMT_EMAIL) {
 406                char *name_tail = strchr(line, '<');
 407                int display_name_length;
 408                if (!name_tail)
 409                        return;
 410                while (line < name_tail && isspace(name_tail[-1]))
 411                        name_tail--;
 412                display_name_length = name_tail - line;
 413                strbuf_addstr(sb, "From: ");
 414                if (needs_rfc2047_encoding(line, display_name_length, RFC2047_ADDRESS)) {
 415                        add_rfc2047(sb, line, display_name_length,
 416                                                encoding, RFC2047_ADDRESS);
 417                        max_length = 76; /* per rfc2047 */
 418                } else if (needs_rfc822_quoting(line, display_name_length)) {
 419                        struct strbuf quoted = STRBUF_INIT;
 420                        add_rfc822_quoted(&quoted, line, display_name_length);
 421                        strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
 422                                                        -6, 1, max_length);
 423                        strbuf_release(&quoted);
 424                } else {
 425                        strbuf_add_wrapped_bytes(sb, line, display_name_length,
 426                                                        -6, 1, max_length);
 427                }
 428                if (namelen - display_name_length + last_line_length(sb) > max_length) {
 429                        strbuf_addch(sb, '\n');
 430                        if (!isspace(name_tail[0]))
 431                                strbuf_addch(sb, ' ');
 432                }
 433                strbuf_add(sb, name_tail, namelen - display_name_length);
 434                strbuf_addch(sb, '\n');
 435        } else {
 436                strbuf_addf(sb, "%s: %.*s%.*s\n", what,
 437                              (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0,
 438                              "    ", namelen, line);
 439        }
 440        switch (pp->fmt) {
 441        case CMIT_FMT_MEDIUM:
 442                strbuf_addf(sb, "Date:   %s\n", show_date(time, tz, pp->date_mode));
 443                break;
 444        case CMIT_FMT_EMAIL:
 445                strbuf_addf(sb, "Date: %s\n", show_date(time, tz, DATE_RFC2822));
 446                break;
 447        case CMIT_FMT_FULLER:
 448                strbuf_addf(sb, "%sDate: %s\n", what, show_date(time, tz, pp->date_mode));
 449                break;
 450        default:
 451                /* notin' */
 452                break;
 453        }
 454}
 455
 456static int is_empty_line(const char *line, int *len_p)
 457{
 458        int len = *len_p;
 459        while (len && isspace(line[len-1]))
 460                len--;
 461        *len_p = len;
 462        return !len;
 463}
 464
 465static const char *skip_empty_lines(const char *msg)
 466{
 467        for (;;) {
 468                int linelen = get_one_line(msg);
 469                int ll = linelen;
 470                if (!linelen)
 471                        break;
 472                if (!is_empty_line(msg, &ll))
 473                        break;
 474                msg += linelen;
 475        }
 476        return msg;
 477}
 478
 479static void add_merge_info(const struct pretty_print_context *pp,
 480                           struct strbuf *sb, const struct commit *commit)
 481{
 482        struct commit_list *parent = commit->parents;
 483
 484        if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
 485            !parent || !parent->next)
 486                return;
 487
 488        strbuf_addstr(sb, "Merge:");
 489
 490        while (parent) {
 491                struct commit *p = parent->item;
 492                const char *hex = NULL;
 493                if (pp->abbrev)
 494                        hex = find_unique_abbrev(p->object.sha1, pp->abbrev);
 495                if (!hex)
 496                        hex = sha1_to_hex(p->object.sha1);
 497                parent = parent->next;
 498
 499                strbuf_addf(sb, " %s", hex);
 500        }
 501        strbuf_addch(sb, '\n');
 502}
 503
 504static char *get_header(const struct commit *commit, const char *key)
 505{
 506        int key_len = strlen(key);
 507        const char *line = commit->buffer;
 508
 509        while (line) {
 510                const char *eol = strchr(line, '\n'), *next;
 511
 512                if (line == eol)
 513                        return NULL;
 514                if (!eol) {
 515                        warning("malformed commit (header is missing newline): %s",
 516                                sha1_to_hex(commit->object.sha1));
 517                        eol = line + strlen(line);
 518                        next = NULL;
 519                } else
 520                        next = eol + 1;
 521                if (eol - line > key_len &&
 522                    !strncmp(line, key, key_len) &&
 523                    line[key_len] == ' ') {
 524                        return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
 525                }
 526                line = next;
 527        }
 528        return NULL;
 529}
 530
 531static char *replace_encoding_header(char *buf, const char *encoding)
 532{
 533        struct strbuf tmp = STRBUF_INIT;
 534        size_t start, len;
 535        char *cp = buf;
 536
 537        /* guess if there is an encoding header before a \n\n */
 538        while (strncmp(cp, "encoding ", strlen("encoding "))) {
 539                cp = strchr(cp, '\n');
 540                if (!cp || *++cp == '\n')
 541                        return buf;
 542        }
 543        start = cp - buf;
 544        cp = strchr(cp, '\n');
 545        if (!cp)
 546                return buf; /* should not happen but be defensive */
 547        len = cp + 1 - (buf + start);
 548
 549        strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
 550        if (is_encoding_utf8(encoding)) {
 551                /* we have re-coded to UTF-8; drop the header */
 552                strbuf_remove(&tmp, start, len);
 553        } else {
 554                /* just replaces XXXX in 'encoding XXXX\n' */
 555                strbuf_splice(&tmp, start + strlen("encoding "),
 556                                          len - strlen("encoding \n"),
 557                                          encoding, strlen(encoding));
 558        }
 559        return strbuf_detach(&tmp, NULL);
 560}
 561
 562char *logmsg_reencode(const struct commit *commit,
 563                      const char *output_encoding)
 564{
 565        static const char *utf8 = "UTF-8";
 566        const char *use_encoding;
 567        char *encoding;
 568        char *out;
 569
 570        if (!*output_encoding)
 571                return NULL;
 572        encoding = get_header(commit, "encoding");
 573        use_encoding = encoding ? encoding : utf8;
 574        if (same_encoding(use_encoding, output_encoding))
 575                if (encoding) /* we'll strip encoding header later */
 576                        out = xstrdup(commit->buffer);
 577                else
 578                        return NULL; /* nothing to do */
 579        else
 580                out = reencode_string(commit->buffer,
 581                                      output_encoding, use_encoding);
 582        if (out)
 583                out = replace_encoding_header(out, output_encoding);
 584
 585        free(encoding);
 586        return out;
 587}
 588
 589static int mailmap_name(char *email, int email_len, char *name, int name_len)
 590{
 591        static struct string_list *mail_map;
 592        if (!mail_map) {
 593                mail_map = xcalloc(1, sizeof(*mail_map));
 594                read_mailmap(mail_map, NULL);
 595        }
 596        return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
 597}
 598
 599static size_t format_person_part(struct strbuf *sb, char part,
 600                                 const char *msg, int len, enum date_mode dmode)
 601{
 602        /* currently all placeholders have same length */
 603        const int placeholder_len = 2;
 604        int tz;
 605        unsigned long date = 0;
 606        char person_name[1024];
 607        char person_mail[1024];
 608        struct ident_split s;
 609        const char *name_start, *name_end, *mail_start, *mail_end;
 610
 611        if (split_ident_line(&s, msg, len) < 0)
 612                goto skip;
 613
 614        name_start = s.name_begin;
 615        name_end = s.name_end;
 616        mail_start = s.mail_begin;
 617        mail_end = s.mail_end;
 618
 619        if (part == 'N' || part == 'E') { /* mailmap lookup */
 620                snprintf(person_name, sizeof(person_name), "%.*s",
 621                         (int)(name_end - name_start), name_start);
 622                snprintf(person_mail, sizeof(person_mail), "%.*s",
 623                         (int)(mail_end - mail_start), mail_start);
 624                mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
 625                name_start = person_name;
 626                name_end = name_start + strlen(person_name);
 627                mail_start = person_mail;
 628                mail_end = mail_start +  strlen(person_mail);
 629        }
 630        if (part == 'n' || part == 'N') {       /* name */
 631                strbuf_add(sb, name_start, name_end-name_start);
 632                return placeholder_len;
 633        }
 634        if (part == 'e' || part == 'E') {       /* email */
 635                strbuf_add(sb, mail_start, mail_end-mail_start);
 636                return placeholder_len;
 637        }
 638
 639        if (!s.date_begin)
 640                goto skip;
 641
 642        date = strtoul(s.date_begin, NULL, 10);
 643
 644        if (part == 't') {      /* date, UNIX timestamp */
 645                strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
 646                return placeholder_len;
 647        }
 648
 649        /* parse tz */
 650        tz = strtoul(s.tz_begin + 1, NULL, 10);
 651        if (*s.tz_begin == '-')
 652                tz = -tz;
 653
 654        switch (part) {
 655        case 'd':       /* date */
 656                strbuf_addstr(sb, show_date(date, tz, dmode));
 657                return placeholder_len;
 658        case 'D':       /* date, RFC2822 style */
 659                strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
 660                return placeholder_len;
 661        case 'r':       /* date, relative */
 662                strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
 663                return placeholder_len;
 664        case 'i':       /* date, ISO 8601 */
 665                strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
 666                return placeholder_len;
 667        }
 668
 669skip:
 670        /*
 671         * reading from either a bogus commit, or a reflog entry with
 672         * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
 673         * to compute a valid return value.
 674         */
 675        if (part == 'n' || part == 'e' || part == 't' || part == 'd'
 676            || part == 'D' || part == 'r' || part == 'i')
 677                return placeholder_len;
 678
 679        return 0; /* unknown placeholder */
 680}
 681
 682struct chunk {
 683        size_t off;
 684        size_t len;
 685};
 686
 687struct format_commit_context {
 688        const struct commit *commit;
 689        const struct pretty_print_context *pretty_ctx;
 690        unsigned commit_header_parsed:1;
 691        unsigned commit_message_parsed:1;
 692        unsigned commit_signature_parsed:1;
 693        struct {
 694                char *gpg_output;
 695                char good_bad;
 696                char *signer;
 697        } signature;
 698        char *message;
 699        size_t width, indent1, indent2;
 700
 701        /* These offsets are relative to the start of the commit message. */
 702        struct chunk author;
 703        struct chunk committer;
 704        struct chunk encoding;
 705        size_t message_off;
 706        size_t subject_off;
 707        size_t body_off;
 708
 709        /* The following ones are relative to the result struct strbuf. */
 710        struct chunk abbrev_commit_hash;
 711        struct chunk abbrev_tree_hash;
 712        struct chunk abbrev_parent_hashes;
 713        size_t wrap_start;
 714};
 715
 716static int add_again(struct strbuf *sb, struct chunk *chunk)
 717{
 718        if (chunk->len) {
 719                strbuf_adddup(sb, chunk->off, chunk->len);
 720                return 1;
 721        }
 722
 723        /*
 724         * We haven't seen this chunk before.  Our caller is surely
 725         * going to add it the hard way now.  Remember the most likely
 726         * start of the to-be-added chunk: the current end of the
 727         * struct strbuf.
 728         */
 729        chunk->off = sb->len;
 730        return 0;
 731}
 732
 733static void parse_commit_header(struct format_commit_context *context)
 734{
 735        const char *msg = context->message;
 736        int i;
 737
 738        for (i = 0; msg[i]; i++) {
 739                int eol;
 740                for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
 741                        ; /* do nothing */
 742
 743                if (i == eol) {
 744                        break;
 745                } else if (!prefixcmp(msg + i, "author ")) {
 746                        context->author.off = i + 7;
 747                        context->author.len = eol - i - 7;
 748                } else if (!prefixcmp(msg + i, "committer ")) {
 749                        context->committer.off = i + 10;
 750                        context->committer.len = eol - i - 10;
 751                } else if (!prefixcmp(msg + i, "encoding ")) {
 752                        context->encoding.off = i + 9;
 753                        context->encoding.len = eol - i - 9;
 754                }
 755                i = eol;
 756        }
 757        context->message_off = i;
 758        context->commit_header_parsed = 1;
 759}
 760
 761static int istitlechar(char c)
 762{
 763        return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
 764                (c >= '0' && c <= '9') || c == '.' || c == '_';
 765}
 766
 767static void format_sanitized_subject(struct strbuf *sb, const char *msg)
 768{
 769        size_t trimlen;
 770        size_t start_len = sb->len;
 771        int space = 2;
 772
 773        for (; *msg && *msg != '\n'; msg++) {
 774                if (istitlechar(*msg)) {
 775                        if (space == 1)
 776                                strbuf_addch(sb, '-');
 777                        space = 0;
 778                        strbuf_addch(sb, *msg);
 779                        if (*msg == '.')
 780                                while (*(msg+1) == '.')
 781                                        msg++;
 782                } else
 783                        space |= 1;
 784        }
 785
 786        /* trim any trailing '.' or '-' characters */
 787        trimlen = 0;
 788        while (sb->len - trimlen > start_len &&
 789                (sb->buf[sb->len - 1 - trimlen] == '.'
 790                || sb->buf[sb->len - 1 - trimlen] == '-'))
 791                trimlen++;
 792        strbuf_remove(sb, sb->len - trimlen, trimlen);
 793}
 794
 795const char *format_subject(struct strbuf *sb, const char *msg,
 796                           const char *line_separator)
 797{
 798        int first = 1;
 799
 800        for (;;) {
 801                const char *line = msg;
 802                int linelen = get_one_line(line);
 803
 804                msg += linelen;
 805                if (!linelen || is_empty_line(line, &linelen))
 806                        break;
 807
 808                if (!sb)
 809                        continue;
 810                strbuf_grow(sb, linelen + 2);
 811                if (!first)
 812                        strbuf_addstr(sb, line_separator);
 813                strbuf_add(sb, line, linelen);
 814                first = 0;
 815        }
 816        return msg;
 817}
 818
 819static void parse_commit_message(struct format_commit_context *c)
 820{
 821        const char *msg = c->message + c->message_off;
 822        const char *start = c->message;
 823
 824        msg = skip_empty_lines(msg);
 825        c->subject_off = msg - start;
 826
 827        msg = format_subject(NULL, msg, NULL);
 828        msg = skip_empty_lines(msg);
 829        c->body_off = msg - start;
 830
 831        c->commit_message_parsed = 1;
 832}
 833
 834static void format_decoration(struct strbuf *sb, const struct commit *commit)
 835{
 836        struct name_decoration *d;
 837        const char *prefix = " (";
 838
 839        load_ref_decorations(DECORATE_SHORT_REFS);
 840        d = lookup_decoration(&name_decoration, &commit->object);
 841        while (d) {
 842                strbuf_addstr(sb, prefix);
 843                prefix = ", ";
 844                strbuf_addstr(sb, d->name);
 845                d = d->next;
 846        }
 847        if (prefix[0] == ',')
 848                strbuf_addch(sb, ')');
 849}
 850
 851static void strbuf_wrap(struct strbuf *sb, size_t pos,
 852                        size_t width, size_t indent1, size_t indent2)
 853{
 854        struct strbuf tmp = STRBUF_INIT;
 855
 856        if (pos)
 857                strbuf_add(&tmp, sb->buf, pos);
 858        strbuf_add_wrapped_text(&tmp, sb->buf + pos,
 859                                (int) indent1, (int) indent2, (int) width);
 860        strbuf_swap(&tmp, sb);
 861        strbuf_release(&tmp);
 862}
 863
 864static void rewrap_message_tail(struct strbuf *sb,
 865                                struct format_commit_context *c,
 866                                size_t new_width, size_t new_indent1,
 867                                size_t new_indent2)
 868{
 869        if (c->width == new_width && c->indent1 == new_indent1 &&
 870            c->indent2 == new_indent2)
 871                return;
 872        if (c->wrap_start < sb->len)
 873                strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
 874        c->wrap_start = sb->len;
 875        c->width = new_width;
 876        c->indent1 = new_indent1;
 877        c->indent2 = new_indent2;
 878}
 879
 880static struct {
 881        char result;
 882        const char *check;
 883} signature_check[] = {
 884        { 'G', ": Good signature from " },
 885        { 'B', ": BAD signature from " },
 886};
 887
 888static void parse_signature_lines(struct format_commit_context *ctx)
 889{
 890        const char *buf = ctx->signature.gpg_output;
 891        int i;
 892
 893        for (i = 0; i < ARRAY_SIZE(signature_check); i++) {
 894                const char *found = strstr(buf, signature_check[i].check);
 895                const char *next;
 896                if (!found)
 897                        continue;
 898                ctx->signature.good_bad = signature_check[i].result;
 899                found += strlen(signature_check[i].check);
 900                next = strchrnul(found, '\n');
 901                ctx->signature.signer = xmemdupz(found, next - found);
 902                break;
 903        }
 904}
 905
 906static void parse_commit_signature(struct format_commit_context *ctx)
 907{
 908        struct strbuf payload = STRBUF_INIT;
 909        struct strbuf signature = STRBUF_INIT;
 910        struct strbuf gpg_output = STRBUF_INIT;
 911        int status;
 912
 913        ctx->commit_signature_parsed = 1;
 914
 915        if (parse_signed_commit(ctx->commit->object.sha1,
 916                                &payload, &signature) <= 0)
 917                goto out;
 918        status = verify_signed_buffer(payload.buf, payload.len,
 919                                      signature.buf, signature.len,
 920                                      &gpg_output);
 921        if (status && !gpg_output.len)
 922                goto out;
 923        ctx->signature.gpg_output = strbuf_detach(&gpg_output, NULL);
 924        parse_signature_lines(ctx);
 925
 926 out:
 927        strbuf_release(&gpg_output);
 928        strbuf_release(&payload);
 929        strbuf_release(&signature);
 930}
 931
 932
 933static int format_reflog_person(struct strbuf *sb,
 934                                char part,
 935                                struct reflog_walk_info *log,
 936                                enum date_mode dmode)
 937{
 938        const char *ident;
 939
 940        if (!log)
 941                return 2;
 942
 943        ident = get_reflog_ident(log);
 944        if (!ident)
 945                return 2;
 946
 947        return format_person_part(sb, part, ident, strlen(ident), dmode);
 948}
 949
 950static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
 951                                void *context)
 952{
 953        struct format_commit_context *c = context;
 954        const struct commit *commit = c->commit;
 955        const char *msg = c->message;
 956        struct commit_list *p;
 957        int h1, h2;
 958
 959        /* these are independent of the commit */
 960        switch (placeholder[0]) {
 961        case 'C':
 962                if (placeholder[1] == '(') {
 963                        const char *end = strchr(placeholder + 2, ')');
 964                        char color[COLOR_MAXLEN];
 965                        if (!end)
 966                                return 0;
 967                        color_parse_mem(placeholder + 2,
 968                                        end - (placeholder + 2),
 969                                        "--pretty format", color);
 970                        strbuf_addstr(sb, color);
 971                        return end - placeholder + 1;
 972                }
 973                if (!prefixcmp(placeholder + 1, "red")) {
 974                        strbuf_addstr(sb, GIT_COLOR_RED);
 975                        return 4;
 976                } else if (!prefixcmp(placeholder + 1, "green")) {
 977                        strbuf_addstr(sb, GIT_COLOR_GREEN);
 978                        return 6;
 979                } else if (!prefixcmp(placeholder + 1, "blue")) {
 980                        strbuf_addstr(sb, GIT_COLOR_BLUE);
 981                        return 5;
 982                } else if (!prefixcmp(placeholder + 1, "reset")) {
 983                        strbuf_addstr(sb, GIT_COLOR_RESET);
 984                        return 6;
 985                } else
 986                        return 0;
 987        case 'n':               /* newline */
 988                strbuf_addch(sb, '\n');
 989                return 1;
 990        case 'x':
 991                /* %x00 == NUL, %x0a == LF, etc. */
 992                if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
 993                    h1 <= 16 &&
 994                    0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
 995                    h2 <= 16) {
 996                        strbuf_addch(sb, (h1<<4)|h2);
 997                        return 3;
 998                } else
 999                        return 0;
1000        case 'w':
1001                if (placeholder[1] == '(') {
1002                        unsigned long width = 0, indent1 = 0, indent2 = 0;
1003                        char *next;
1004                        const char *start = placeholder + 2;
1005                        const char *end = strchr(start, ')');
1006                        if (!end)
1007                                return 0;
1008                        if (end > start) {
1009                                width = strtoul(start, &next, 10);
1010                                if (*next == ',') {
1011                                        indent1 = strtoul(next + 1, &next, 10);
1012                                        if (*next == ',') {
1013                                                indent2 = strtoul(next + 1,
1014                                                                 &next, 10);
1015                                        }
1016                                }
1017                                if (*next != ')')
1018                                        return 0;
1019                        }
1020                        rewrap_message_tail(sb, c, width, indent1, indent2);
1021                        return end - placeholder + 1;
1022                } else
1023                        return 0;
1024        }
1025
1026        /* these depend on the commit */
1027        if (!commit->object.parsed)
1028                parse_object(commit->object.sha1);
1029
1030        switch (placeholder[0]) {
1031        case 'H':               /* commit hash */
1032                strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
1033                return 1;
1034        case 'h':               /* abbreviated commit hash */
1035                if (add_again(sb, &c->abbrev_commit_hash))
1036                        return 1;
1037                strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
1038                                                     c->pretty_ctx->abbrev));
1039                c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
1040                return 1;
1041        case 'T':               /* tree hash */
1042                strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
1043                return 1;
1044        case 't':               /* abbreviated tree hash */
1045                if (add_again(sb, &c->abbrev_tree_hash))
1046                        return 1;
1047                strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
1048                                                     c->pretty_ctx->abbrev));
1049                c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
1050                return 1;
1051        case 'P':               /* parent hashes */
1052                for (p = commit->parents; p; p = p->next) {
1053                        if (p != commit->parents)
1054                                strbuf_addch(sb, ' ');
1055                        strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
1056                }
1057                return 1;
1058        case 'p':               /* abbreviated parent hashes */
1059                if (add_again(sb, &c->abbrev_parent_hashes))
1060                        return 1;
1061                for (p = commit->parents; p; p = p->next) {
1062                        if (p != commit->parents)
1063                                strbuf_addch(sb, ' ');
1064                        strbuf_addstr(sb, find_unique_abbrev(
1065                                        p->item->object.sha1,
1066                                        c->pretty_ctx->abbrev));
1067                }
1068                c->abbrev_parent_hashes.len = sb->len -
1069                                              c->abbrev_parent_hashes.off;
1070                return 1;
1071        case 'm':               /* left/right/bottom */
1072                strbuf_addstr(sb, get_revision_mark(NULL, commit));
1073                return 1;
1074        case 'd':
1075                format_decoration(sb, commit);
1076                return 1;
1077        case 'g':               /* reflog info */
1078                switch(placeholder[1]) {
1079                case 'd':       /* reflog selector */
1080                case 'D':
1081                        if (c->pretty_ctx->reflog_info)
1082                                get_reflog_selector(sb,
1083                                                    c->pretty_ctx->reflog_info,
1084                                                    c->pretty_ctx->date_mode,
1085                                                    c->pretty_ctx->date_mode_explicit,
1086                                                    (placeholder[1] == 'd'));
1087                        return 2;
1088                case 's':       /* reflog message */
1089                        if (c->pretty_ctx->reflog_info)
1090                                get_reflog_message(sb, c->pretty_ctx->reflog_info);
1091                        return 2;
1092                case 'n':
1093                case 'N':
1094                case 'e':
1095                case 'E':
1096                        return format_reflog_person(sb,
1097                                                    placeholder[1],
1098                                                    c->pretty_ctx->reflog_info,
1099                                                    c->pretty_ctx->date_mode);
1100                }
1101                return 0;       /* unknown %g placeholder */
1102        case 'N':
1103                if (c->pretty_ctx->show_notes) {
1104                        format_display_notes(commit->object.sha1, sb,
1105                                    get_log_output_encoding(), 0);
1106                        return 1;
1107                }
1108                return 0;
1109        }
1110
1111        if (placeholder[0] == 'G') {
1112                if (!c->commit_signature_parsed)
1113                        parse_commit_signature(c);
1114                switch (placeholder[1]) {
1115                case 'G':
1116                        if (c->signature.gpg_output)
1117                                strbuf_addstr(sb, c->signature.gpg_output);
1118                        break;
1119                case '?':
1120                        switch (c->signature.good_bad) {
1121                        case 'G':
1122                        case 'B':
1123                                strbuf_addch(sb, c->signature.good_bad);
1124                        }
1125                        break;
1126                case 'S':
1127                        if (c->signature.signer)
1128                                strbuf_addstr(sb, c->signature.signer);
1129                        break;
1130                }
1131                return 2;
1132        }
1133
1134
1135        /* For the rest we have to parse the commit header. */
1136        if (!c->commit_header_parsed)
1137                parse_commit_header(c);
1138
1139        switch (placeholder[0]) {
1140        case 'a':       /* author ... */
1141                return format_person_part(sb, placeholder[1],
1142                                   msg + c->author.off, c->author.len,
1143                                   c->pretty_ctx->date_mode);
1144        case 'c':       /* committer ... */
1145                return format_person_part(sb, placeholder[1],
1146                                   msg + c->committer.off, c->committer.len,
1147                                   c->pretty_ctx->date_mode);
1148        case 'e':       /* encoding */
1149                strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
1150                return 1;
1151        case 'B':       /* raw body */
1152                /* message_off is always left at the initial newline */
1153                strbuf_addstr(sb, msg + c->message_off + 1);
1154                return 1;
1155        }
1156
1157        /* Now we need to parse the commit message. */
1158        if (!c->commit_message_parsed)
1159                parse_commit_message(c);
1160
1161        switch (placeholder[0]) {
1162        case 's':       /* subject */
1163                format_subject(sb, msg + c->subject_off, " ");
1164                return 1;
1165        case 'f':       /* sanitized subject */
1166                format_sanitized_subject(sb, msg + c->subject_off);
1167                return 1;
1168        case 'b':       /* body */
1169                strbuf_addstr(sb, msg + c->body_off);
1170                return 1;
1171        }
1172        return 0;       /* unknown placeholder */
1173}
1174
1175static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
1176                                 void *context)
1177{
1178        int consumed;
1179        size_t orig_len;
1180        enum {
1181                NO_MAGIC,
1182                ADD_LF_BEFORE_NON_EMPTY,
1183                DEL_LF_BEFORE_EMPTY,
1184                ADD_SP_BEFORE_NON_EMPTY
1185        } magic = NO_MAGIC;
1186
1187        switch (placeholder[0]) {
1188        case '-':
1189                magic = DEL_LF_BEFORE_EMPTY;
1190                break;
1191        case '+':
1192                magic = ADD_LF_BEFORE_NON_EMPTY;
1193                break;
1194        case ' ':
1195                magic = ADD_SP_BEFORE_NON_EMPTY;
1196                break;
1197        default:
1198                break;
1199        }
1200        if (magic != NO_MAGIC)
1201                placeholder++;
1202
1203        orig_len = sb->len;
1204        consumed = format_commit_one(sb, placeholder, context);
1205        if (magic == NO_MAGIC)
1206                return consumed;
1207
1208        if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1209                while (sb->len && sb->buf[sb->len - 1] == '\n')
1210                        strbuf_setlen(sb, sb->len - 1);
1211        } else if (orig_len != sb->len) {
1212                if (magic == ADD_LF_BEFORE_NON_EMPTY)
1213                        strbuf_insert(sb, orig_len, "\n", 1);
1214                else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1215                        strbuf_insert(sb, orig_len, " ", 1);
1216        }
1217        return consumed + 1;
1218}
1219
1220static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1221                                   void *context)
1222{
1223        struct userformat_want *w = context;
1224
1225        if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1226                placeholder++;
1227
1228        switch (*placeholder) {
1229        case 'N':
1230                w->notes = 1;
1231                break;
1232        }
1233        return 0;
1234}
1235
1236void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1237{
1238        struct strbuf dummy = STRBUF_INIT;
1239
1240        if (!fmt) {
1241                if (!user_format)
1242                        return;
1243                fmt = user_format;
1244        }
1245        strbuf_expand(&dummy, fmt, userformat_want_item, w);
1246        strbuf_release(&dummy);
1247}
1248
1249void format_commit_message(const struct commit *commit,
1250                           const char *format, struct strbuf *sb,
1251                           const struct pretty_print_context *pretty_ctx)
1252{
1253        struct format_commit_context context;
1254        static const char utf8[] = "UTF-8";
1255        const char *output_enc = pretty_ctx->output_encoding;
1256
1257        memset(&context, 0, sizeof(context));
1258        context.commit = commit;
1259        context.pretty_ctx = pretty_ctx;
1260        context.wrap_start = sb->len;
1261        context.message = commit->buffer;
1262        if (output_enc) {
1263                char *enc = get_header(commit, "encoding");
1264                if (strcmp(enc ? enc : utf8, output_enc)) {
1265                        context.message = logmsg_reencode(commit, output_enc);
1266                        if (!context.message)
1267                                context.message = commit->buffer;
1268                }
1269                free(enc);
1270        }
1271
1272        strbuf_expand(sb, format, format_commit_item, &context);
1273        rewrap_message_tail(sb, &context, 0, 0, 0);
1274
1275        if (context.message != commit->buffer)
1276                free(context.message);
1277        free(context.signature.gpg_output);
1278        free(context.signature.signer);
1279}
1280
1281static void pp_header(const struct pretty_print_context *pp,
1282                      const char *encoding,
1283                      const struct commit *commit,
1284                      const char **msg_p,
1285                      struct strbuf *sb)
1286{
1287        int parents_shown = 0;
1288
1289        for (;;) {
1290                const char *line = *msg_p;
1291                int linelen = get_one_line(*msg_p);
1292
1293                if (!linelen)
1294                        return;
1295                *msg_p += linelen;
1296
1297                if (linelen == 1)
1298                        /* End of header */
1299                        return;
1300
1301                if (pp->fmt == CMIT_FMT_RAW) {
1302                        strbuf_add(sb, line, linelen);
1303                        continue;
1304                }
1305
1306                if (!memcmp(line, "parent ", 7)) {
1307                        if (linelen != 48)
1308                                die("bad parent line in commit");
1309                        continue;
1310                }
1311
1312                if (!parents_shown) {
1313                        struct commit_list *parent;
1314                        int num;
1315                        for (parent = commit->parents, num = 0;
1316                             parent;
1317                             parent = parent->next, num++)
1318                                ;
1319                        /* with enough slop */
1320                        strbuf_grow(sb, num * 50 + 20);
1321                        add_merge_info(pp, sb, commit);
1322                        parents_shown = 1;
1323                }
1324
1325                /*
1326                 * MEDIUM == DEFAULT shows only author with dates.
1327                 * FULL shows both authors but not dates.
1328                 * FULLER shows both authors and dates.
1329                 */
1330                if (!memcmp(line, "author ", 7)) {
1331                        strbuf_grow(sb, linelen + 80);
1332                        pp_user_info(pp, "Author", sb, line + 7, encoding);
1333                }
1334                if (!memcmp(line, "committer ", 10) &&
1335                    (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1336                        strbuf_grow(sb, linelen + 80);
1337                        pp_user_info(pp, "Commit", sb, line + 10, encoding);
1338                }
1339        }
1340}
1341
1342void pp_title_line(const struct pretty_print_context *pp,
1343                   const char **msg_p,
1344                   struct strbuf *sb,
1345                   const char *encoding,
1346                   int need_8bit_cte)
1347{
1348        static const int max_length = 78; /* per rfc2047 */
1349        struct strbuf title;
1350
1351        strbuf_init(&title, 80);
1352        *msg_p = format_subject(&title, *msg_p,
1353                                pp->preserve_subject ? "\n" : " ");
1354
1355        strbuf_grow(sb, title.len + 1024);
1356        if (pp->subject) {
1357                strbuf_addstr(sb, pp->subject);
1358                if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
1359                        add_rfc2047(sb, title.buf, title.len,
1360                                                encoding, RFC2047_SUBJECT);
1361                else
1362                        strbuf_add_wrapped_bytes(sb, title.buf, title.len,
1363                                         -last_line_length(sb), 1, max_length);
1364        } else {
1365                strbuf_addbuf(sb, &title);
1366        }
1367        strbuf_addch(sb, '\n');
1368
1369        if (need_8bit_cte > 0) {
1370                const char *header_fmt =
1371                        "MIME-Version: 1.0\n"
1372                        "Content-Type: text/plain; charset=%s\n"
1373                        "Content-Transfer-Encoding: 8bit\n";
1374                strbuf_addf(sb, header_fmt, encoding);
1375        }
1376        if (pp->after_subject) {
1377                strbuf_addstr(sb, pp->after_subject);
1378        }
1379        if (pp->fmt == CMIT_FMT_EMAIL) {
1380                strbuf_addch(sb, '\n');
1381        }
1382        strbuf_release(&title);
1383}
1384
1385void pp_remainder(const struct pretty_print_context *pp,
1386                  const char **msg_p,
1387                  struct strbuf *sb,
1388                  int indent)
1389{
1390        int first = 1;
1391        for (;;) {
1392                const char *line = *msg_p;
1393                int linelen = get_one_line(line);
1394                *msg_p += linelen;
1395
1396                if (!linelen)
1397                        break;
1398
1399                if (is_empty_line(line, &linelen)) {
1400                        if (first)
1401                                continue;
1402                        if (pp->fmt == CMIT_FMT_SHORT)
1403                                break;
1404                }
1405                first = 0;
1406
1407                strbuf_grow(sb, linelen + indent + 20);
1408                if (indent) {
1409                        memset(sb->buf + sb->len, ' ', indent);
1410                        strbuf_setlen(sb, sb->len + indent);
1411                }
1412                strbuf_add(sb, line, linelen);
1413                strbuf_addch(sb, '\n');
1414        }
1415}
1416
1417char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
1418{
1419        const char *encoding;
1420
1421        encoding = get_log_output_encoding();
1422        if (encoding_p)
1423                *encoding_p = encoding;
1424        return logmsg_reencode(commit, encoding);
1425}
1426
1427void pretty_print_commit(const struct pretty_print_context *pp,
1428                         const struct commit *commit,
1429                         struct strbuf *sb)
1430{
1431        unsigned long beginning_of_body;
1432        int indent = 4;
1433        const char *msg = commit->buffer;
1434        char *reencoded;
1435        const char *encoding;
1436        int need_8bit_cte = pp->need_8bit_cte;
1437
1438        if (pp->fmt == CMIT_FMT_USERFORMAT) {
1439                format_commit_message(commit, user_format, sb, pp);
1440                return;
1441        }
1442
1443        reencoded = reencode_commit_message(commit, &encoding);
1444        if (reencoded) {
1445                msg = reencoded;
1446        }
1447
1448        if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1449                indent = 0;
1450
1451        /*
1452         * We need to check and emit Content-type: to mark it
1453         * as 8-bit if we haven't done so.
1454         */
1455        if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1456                int i, ch, in_body;
1457
1458                for (in_body = i = 0; (ch = msg[i]); i++) {
1459                        if (!in_body) {
1460                                /* author could be non 7-bit ASCII but
1461                                 * the log may be so; skip over the
1462                                 * header part first.
1463                                 */
1464                                if (ch == '\n' && msg[i+1] == '\n')
1465                                        in_body = 1;
1466                        }
1467                        else if (non_ascii(ch)) {
1468                                need_8bit_cte = 1;
1469                                break;
1470                        }
1471                }
1472        }
1473
1474        pp_header(pp, encoding, commit, &msg, sb);
1475        if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1476                strbuf_addch(sb, '\n');
1477        }
1478
1479        /* Skip excess blank lines at the beginning of body, if any... */
1480        msg = skip_empty_lines(msg);
1481
1482        /* These formats treat the title line specially. */
1483        if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1484                pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1485
1486        beginning_of_body = sb->len;
1487        if (pp->fmt != CMIT_FMT_ONELINE)
1488                pp_remainder(pp, &msg, sb, indent);
1489        strbuf_rtrim(sb);
1490
1491        /* Make sure there is an EOLN for the non-oneline case */
1492        if (pp->fmt != CMIT_FMT_ONELINE)
1493                strbuf_addch(sb, '\n');
1494
1495        /*
1496         * The caller may append additional body text in e-mail
1497         * format.  Make sure we did not strip the blank line
1498         * between the header and the body.
1499         */
1500        if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1501                strbuf_addch(sb, '\n');
1502
1503        if (pp->show_notes)
1504                format_display_notes(commit->object.sha1, sb, encoding,
1505                                     NOTES_SHOW_HEADER | NOTES_INDENT);
1506
1507        free(reencoded);
1508}
1509
1510void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1511                    struct strbuf *sb)
1512{
1513        struct pretty_print_context pp = {0};
1514        pp.fmt = fmt;
1515        pretty_print_commit(&pp, commit, sb);
1516}