Merge branch 'jk/pretty-commit-header-incomplete-line'
[git] / pretty.c
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
14 static char *user_format;
15 static 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;
22 static size_t builtin_formats_len;
23 static size_t commit_formats_len;
24 static size_t commit_formats_alloc;
25 static struct cmt_fmt_map *find_commit_format(const char *sought);
26
27 static 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
36 static 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
82 static 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
102 static 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
137 static 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
145 void 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  */
179 static 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 */
195 static int non_ascii(int ch)
196 {
197         return !isascii(ch) || ch == '\033';
198 }
199
200 int 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
212 static 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
234 static 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
243 static 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
264 static int is_rfc2047_special(char ch)
265 {
266         return (non_ascii(ch) || (ch == '=') || (ch == '?') || (ch == '_'));
267 }
268
269 static 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
292 needquote:
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
322 void 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
389 static 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
398 static 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
412 static 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
437 static 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
464 static 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
495 char *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
522 static 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
532 static 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                 strlcpy(person_name, name_start, name_end - name_start + 1);
554                 strlcpy(person_mail, mail_start, mail_end - mail_start + 1);
555                 mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
556                 name_start = person_name;
557                 name_end = name_start + strlen(person_name);
558                 mail_start = person_mail;
559                 mail_end = mail_start +  strlen(person_mail);
560         }
561         if (part == 'n' || part == 'N') {       /* name */
562                 strbuf_add(sb, name_start, name_end-name_start);
563                 return placeholder_len;
564         }
565         if (part == 'e' || part == 'E') {       /* email */
566                 strbuf_add(sb, mail_start, mail_end-mail_start);
567                 return placeholder_len;
568         }
569
570         if (!s.date_begin)
571                 goto skip;
572
573         date = strtoul(s.date_begin, NULL, 10);
574
575         if (part == 't') {      /* date, UNIX timestamp */
576                 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
577                 return placeholder_len;
578         }
579
580         /* parse tz */
581         tz = strtoul(s.tz_begin + 1, NULL, 10);
582         if (*s.tz_begin == '-')
583                 tz = -tz;
584
585         switch (part) {
586         case 'd':       /* date */
587                 strbuf_addstr(sb, show_date(date, tz, dmode));
588                 return placeholder_len;
589         case 'D':       /* date, RFC2822 style */
590                 strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
591                 return placeholder_len;
592         case 'r':       /* date, relative */
593                 strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
594                 return placeholder_len;
595         case 'i':       /* date, ISO 8601 */
596                 strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
597                 return placeholder_len;
598         }
599
600 skip:
601         /*
602          * reading from either a bogus commit, or a reflog entry with
603          * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
604          * to compute a valid return value.
605          */
606         if (part == 'n' || part == 'e' || part == 't' || part == 'd'
607             || part == 'D' || part == 'r' || part == 'i')
608                 return placeholder_len;
609
610         return 0; /* unknown placeholder */
611 }
612
613 struct chunk {
614         size_t off;
615         size_t len;
616 };
617
618 struct format_commit_context {
619         const struct commit *commit;
620         const struct pretty_print_context *pretty_ctx;
621         unsigned commit_header_parsed:1;
622         unsigned commit_message_parsed:1;
623         unsigned commit_signature_parsed:1;
624         struct {
625                 char *gpg_output;
626                 char good_bad;
627                 char *signer;
628         } signature;
629         char *message;
630         size_t width, indent1, indent2;
631
632         /* These offsets are relative to the start of the commit message. */
633         struct chunk author;
634         struct chunk committer;
635         struct chunk encoding;
636         size_t message_off;
637         size_t subject_off;
638         size_t body_off;
639
640         /* The following ones are relative to the result struct strbuf. */
641         struct chunk abbrev_commit_hash;
642         struct chunk abbrev_tree_hash;
643         struct chunk abbrev_parent_hashes;
644         size_t wrap_start;
645 };
646
647 static int add_again(struct strbuf *sb, struct chunk *chunk)
648 {
649         if (chunk->len) {
650                 strbuf_adddup(sb, chunk->off, chunk->len);
651                 return 1;
652         }
653
654         /*
655          * We haven't seen this chunk before.  Our caller is surely
656          * going to add it the hard way now.  Remember the most likely
657          * start of the to-be-added chunk: the current end of the
658          * struct strbuf.
659          */
660         chunk->off = sb->len;
661         return 0;
662 }
663
664 static void parse_commit_header(struct format_commit_context *context)
665 {
666         const char *msg = context->message;
667         int i;
668
669         for (i = 0; msg[i]; i++) {
670                 int eol;
671                 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
672                         ; /* do nothing */
673
674                 if (i == eol) {
675                         break;
676                 } else if (!prefixcmp(msg + i, "author ")) {
677                         context->author.off = i + 7;
678                         context->author.len = eol - i - 7;
679                 } else if (!prefixcmp(msg + i, "committer ")) {
680                         context->committer.off = i + 10;
681                         context->committer.len = eol - i - 10;
682                 } else if (!prefixcmp(msg + i, "encoding ")) {
683                         context->encoding.off = i + 9;
684                         context->encoding.len = eol - i - 9;
685                 }
686                 i = eol;
687         }
688         context->message_off = i;
689         context->commit_header_parsed = 1;
690 }
691
692 static int istitlechar(char c)
693 {
694         return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
695                 (c >= '0' && c <= '9') || c == '.' || c == '_';
696 }
697
698 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
699 {
700         size_t trimlen;
701         size_t start_len = sb->len;
702         int space = 2;
703
704         for (; *msg && *msg != '\n'; msg++) {
705                 if (istitlechar(*msg)) {
706                         if (space == 1)
707                                 strbuf_addch(sb, '-');
708                         space = 0;
709                         strbuf_addch(sb, *msg);
710                         if (*msg == '.')
711                                 while (*(msg+1) == '.')
712                                         msg++;
713                 } else
714                         space |= 1;
715         }
716
717         /* trim any trailing '.' or '-' characters */
718         trimlen = 0;
719         while (sb->len - trimlen > start_len &&
720                 (sb->buf[sb->len - 1 - trimlen] == '.'
721                 || sb->buf[sb->len - 1 - trimlen] == '-'))
722                 trimlen++;
723         strbuf_remove(sb, sb->len - trimlen, trimlen);
724 }
725
726 const char *format_subject(struct strbuf *sb, const char *msg,
727                            const char *line_separator)
728 {
729         int first = 1;
730
731         for (;;) {
732                 const char *line = msg;
733                 int linelen = get_one_line(line);
734
735                 msg += linelen;
736                 if (!linelen || is_empty_line(line, &linelen))
737                         break;
738
739                 if (!sb)
740                         continue;
741                 strbuf_grow(sb, linelen + 2);
742                 if (!first)
743                         strbuf_addstr(sb, line_separator);
744                 strbuf_add(sb, line, linelen);
745                 first = 0;
746         }
747         return msg;
748 }
749
750 static void parse_commit_message(struct format_commit_context *c)
751 {
752         const char *msg = c->message + c->message_off;
753         const char *start = c->message;
754
755         msg = skip_empty_lines(msg);
756         c->subject_off = msg - start;
757
758         msg = format_subject(NULL, msg, NULL);
759         msg = skip_empty_lines(msg);
760         c->body_off = msg - start;
761
762         c->commit_message_parsed = 1;
763 }
764
765 static void format_decoration(struct strbuf *sb, const struct commit *commit)
766 {
767         struct name_decoration *d;
768         const char *prefix = " (";
769
770         load_ref_decorations(DECORATE_SHORT_REFS);
771         d = lookup_decoration(&name_decoration, &commit->object);
772         while (d) {
773                 strbuf_addstr(sb, prefix);
774                 prefix = ", ";
775                 strbuf_addstr(sb, d->name);
776                 d = d->next;
777         }
778         if (prefix[0] == ',')
779                 strbuf_addch(sb, ')');
780 }
781
782 static void strbuf_wrap(struct strbuf *sb, size_t pos,
783                         size_t width, size_t indent1, size_t indent2)
784 {
785         struct strbuf tmp = STRBUF_INIT;
786
787         if (pos)
788                 strbuf_add(&tmp, sb->buf, pos);
789         strbuf_add_wrapped_text(&tmp, sb->buf + pos,
790                                 (int) indent1, (int) indent2, (int) width);
791         strbuf_swap(&tmp, sb);
792         strbuf_release(&tmp);
793 }
794
795 static void rewrap_message_tail(struct strbuf *sb,
796                                 struct format_commit_context *c,
797                                 size_t new_width, size_t new_indent1,
798                                 size_t new_indent2)
799 {
800         if (c->width == new_width && c->indent1 == new_indent1 &&
801             c->indent2 == new_indent2)
802                 return;
803         if (c->wrap_start < sb->len)
804                 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
805         c->wrap_start = sb->len;
806         c->width = new_width;
807         c->indent1 = new_indent1;
808         c->indent2 = new_indent2;
809 }
810
811 static struct {
812         char result;
813         const char *check;
814 } signature_check[] = {
815         { 'G', ": Good signature from " },
816         { 'B', ": BAD signature from " },
817 };
818
819 static void parse_signature_lines(struct format_commit_context *ctx)
820 {
821         const char *buf = ctx->signature.gpg_output;
822         int i;
823
824         for (i = 0; i < ARRAY_SIZE(signature_check); i++) {
825                 const char *found = strstr(buf, signature_check[i].check);
826                 const char *next;
827                 if (!found)
828                         continue;
829                 ctx->signature.good_bad = signature_check[i].result;
830                 found += strlen(signature_check[i].check);
831                 next = strchrnul(found, '\n');
832                 ctx->signature.signer = xmemdupz(found, next - found);
833                 break;
834         }
835 }
836
837 static void parse_commit_signature(struct format_commit_context *ctx)
838 {
839         struct strbuf payload = STRBUF_INIT;
840         struct strbuf signature = STRBUF_INIT;
841         struct strbuf gpg_output = STRBUF_INIT;
842         int status;
843
844         ctx->commit_signature_parsed = 1;
845
846         if (parse_signed_commit(ctx->commit->object.sha1,
847                                 &payload, &signature) <= 0)
848                 goto out;
849         status = verify_signed_buffer(payload.buf, payload.len,
850                                       signature.buf, signature.len,
851                                       &gpg_output);
852         if (status && !gpg_output.len)
853                 goto out;
854         ctx->signature.gpg_output = strbuf_detach(&gpg_output, NULL);
855         parse_signature_lines(ctx);
856
857  out:
858         strbuf_release(&gpg_output);
859         strbuf_release(&payload);
860         strbuf_release(&signature);
861 }
862
863
864 static int format_reflog_person(struct strbuf *sb,
865                                 char part,
866                                 struct reflog_walk_info *log,
867                                 enum date_mode dmode)
868 {
869         const char *ident;
870
871         if (!log)
872                 return 2;
873
874         ident = get_reflog_ident(log);
875         if (!ident)
876                 return 2;
877
878         return format_person_part(sb, part, ident, strlen(ident), dmode);
879 }
880
881 static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
882                                 void *context)
883 {
884         struct format_commit_context *c = context;
885         const struct commit *commit = c->commit;
886         const char *msg = c->message;
887         struct commit_list *p;
888         int h1, h2;
889
890         /* these are independent of the commit */
891         switch (placeholder[0]) {
892         case 'C':
893                 if (placeholder[1] == '(') {
894                         const char *end = strchr(placeholder + 2, ')');
895                         char color[COLOR_MAXLEN];
896                         if (!end)
897                                 return 0;
898                         color_parse_mem(placeholder + 2,
899                                         end - (placeholder + 2),
900                                         "--pretty format", color);
901                         strbuf_addstr(sb, color);
902                         return end - placeholder + 1;
903                 }
904                 if (!prefixcmp(placeholder + 1, "red")) {
905                         strbuf_addstr(sb, GIT_COLOR_RED);
906                         return 4;
907                 } else if (!prefixcmp(placeholder + 1, "green")) {
908                         strbuf_addstr(sb, GIT_COLOR_GREEN);
909                         return 6;
910                 } else if (!prefixcmp(placeholder + 1, "blue")) {
911                         strbuf_addstr(sb, GIT_COLOR_BLUE);
912                         return 5;
913                 } else if (!prefixcmp(placeholder + 1, "reset")) {
914                         strbuf_addstr(sb, GIT_COLOR_RESET);
915                         return 6;
916                 } else
917                         return 0;
918         case 'n':               /* newline */
919                 strbuf_addch(sb, '\n');
920                 return 1;
921         case 'x':
922                 /* %x00 == NUL, %x0a == LF, etc. */
923                 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
924                     h1 <= 16 &&
925                     0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
926                     h2 <= 16) {
927                         strbuf_addch(sb, (h1<<4)|h2);
928                         return 3;
929                 } else
930                         return 0;
931         case 'w':
932                 if (placeholder[1] == '(') {
933                         unsigned long width = 0, indent1 = 0, indent2 = 0;
934                         char *next;
935                         const char *start = placeholder + 2;
936                         const char *end = strchr(start, ')');
937                         if (!end)
938                                 return 0;
939                         if (end > start) {
940                                 width = strtoul(start, &next, 10);
941                                 if (*next == ',') {
942                                         indent1 = strtoul(next + 1, &next, 10);
943                                         if (*next == ',') {
944                                                 indent2 = strtoul(next + 1,
945                                                                  &next, 10);
946                                         }
947                                 }
948                                 if (*next != ')')
949                                         return 0;
950                         }
951                         rewrap_message_tail(sb, c, width, indent1, indent2);
952                         return end - placeholder + 1;
953                 } else
954                         return 0;
955         }
956
957         /* these depend on the commit */
958         if (!commit->object.parsed)
959                 parse_object(commit->object.sha1);
960
961         switch (placeholder[0]) {
962         case 'H':               /* commit hash */
963                 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
964                 return 1;
965         case 'h':               /* abbreviated commit hash */
966                 if (add_again(sb, &c->abbrev_commit_hash))
967                         return 1;
968                 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
969                                                      c->pretty_ctx->abbrev));
970                 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
971                 return 1;
972         case 'T':               /* tree hash */
973                 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
974                 return 1;
975         case 't':               /* abbreviated tree hash */
976                 if (add_again(sb, &c->abbrev_tree_hash))
977                         return 1;
978                 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
979                                                      c->pretty_ctx->abbrev));
980                 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
981                 return 1;
982         case 'P':               /* parent hashes */
983                 for (p = commit->parents; p; p = p->next) {
984                         if (p != commit->parents)
985                                 strbuf_addch(sb, ' ');
986                         strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
987                 }
988                 return 1;
989         case 'p':               /* abbreviated parent hashes */
990                 if (add_again(sb, &c->abbrev_parent_hashes))
991                         return 1;
992                 for (p = commit->parents; p; p = p->next) {
993                         if (p != commit->parents)
994                                 strbuf_addch(sb, ' ');
995                         strbuf_addstr(sb, find_unique_abbrev(
996                                         p->item->object.sha1,
997                                         c->pretty_ctx->abbrev));
998                 }
999                 c->abbrev_parent_hashes.len = sb->len -
1000                                               c->abbrev_parent_hashes.off;
1001                 return 1;
1002         case 'm':               /* left/right/bottom */
1003                 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1004                 return 1;
1005         case 'd':
1006                 format_decoration(sb, commit);
1007                 return 1;
1008         case 'g':               /* reflog info */
1009                 switch(placeholder[1]) {
1010                 case 'd':       /* reflog selector */
1011                 case 'D':
1012                         if (c->pretty_ctx->reflog_info)
1013                                 get_reflog_selector(sb,
1014                                                     c->pretty_ctx->reflog_info,
1015                                                     c->pretty_ctx->date_mode,
1016                                                     c->pretty_ctx->date_mode_explicit,
1017                                                     (placeholder[1] == 'd'));
1018                         return 2;
1019                 case 's':       /* reflog message */
1020                         if (c->pretty_ctx->reflog_info)
1021                                 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1022                         return 2;
1023                 case 'n':
1024                 case 'N':
1025                 case 'e':
1026                 case 'E':
1027                         return format_reflog_person(sb,
1028                                                     placeholder[1],
1029                                                     c->pretty_ctx->reflog_info,
1030                                                     c->pretty_ctx->date_mode);
1031                 }
1032                 return 0;       /* unknown %g placeholder */
1033         case 'N':
1034                 if (c->pretty_ctx->show_notes) {
1035                         format_display_notes(commit->object.sha1, sb,
1036                                     get_log_output_encoding(), 0);
1037                         return 1;
1038                 }
1039                 return 0;
1040         }
1041
1042         if (placeholder[0] == 'G') {
1043                 if (!c->commit_signature_parsed)
1044                         parse_commit_signature(c);
1045                 switch (placeholder[1]) {
1046                 case 'G':
1047                         if (c->signature.gpg_output)
1048                                 strbuf_addstr(sb, c->signature.gpg_output);
1049                         break;
1050                 case '?':
1051                         switch (c->signature.good_bad) {
1052                         case 'G':
1053                         case 'B':
1054                                 strbuf_addch(sb, c->signature.good_bad);
1055                         }
1056                         break;
1057                 case 'S':
1058                         if (c->signature.signer)
1059                                 strbuf_addstr(sb, c->signature.signer);
1060                         break;
1061                 }
1062                 return 2;
1063         }
1064
1065
1066         /* For the rest we have to parse the commit header. */
1067         if (!c->commit_header_parsed)
1068                 parse_commit_header(c);
1069
1070         switch (placeholder[0]) {
1071         case 'a':       /* author ... */
1072                 return format_person_part(sb, placeholder[1],
1073                                    msg + c->author.off, c->author.len,
1074                                    c->pretty_ctx->date_mode);
1075         case 'c':       /* committer ... */
1076                 return format_person_part(sb, placeholder[1],
1077                                    msg + c->committer.off, c->committer.len,
1078                                    c->pretty_ctx->date_mode);
1079         case 'e':       /* encoding */
1080                 strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
1081                 return 1;
1082         case 'B':       /* raw body */
1083                 /* message_off is always left at the initial newline */
1084                 strbuf_addstr(sb, msg + c->message_off + 1);
1085                 return 1;
1086         }
1087
1088         /* Now we need to parse the commit message. */
1089         if (!c->commit_message_parsed)
1090                 parse_commit_message(c);
1091
1092         switch (placeholder[0]) {
1093         case 's':       /* subject */
1094                 format_subject(sb, msg + c->subject_off, " ");
1095                 return 1;
1096         case 'f':       /* sanitized subject */
1097                 format_sanitized_subject(sb, msg + c->subject_off);
1098                 return 1;
1099         case 'b':       /* body */
1100                 strbuf_addstr(sb, msg + c->body_off);
1101                 return 1;
1102         }
1103         return 0;       /* unknown placeholder */
1104 }
1105
1106 static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
1107                                  void *context)
1108 {
1109         int consumed;
1110         size_t orig_len;
1111         enum {
1112                 NO_MAGIC,
1113                 ADD_LF_BEFORE_NON_EMPTY,
1114                 DEL_LF_BEFORE_EMPTY,
1115                 ADD_SP_BEFORE_NON_EMPTY
1116         } magic = NO_MAGIC;
1117
1118         switch (placeholder[0]) {
1119         case '-':
1120                 magic = DEL_LF_BEFORE_EMPTY;
1121                 break;
1122         case '+':
1123                 magic = ADD_LF_BEFORE_NON_EMPTY;
1124                 break;
1125         case ' ':
1126                 magic = ADD_SP_BEFORE_NON_EMPTY;
1127                 break;
1128         default:
1129                 break;
1130         }
1131         if (magic != NO_MAGIC)
1132                 placeholder++;
1133
1134         orig_len = sb->len;
1135         consumed = format_commit_one(sb, placeholder, context);
1136         if (magic == NO_MAGIC)
1137                 return consumed;
1138
1139         if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1140                 while (sb->len && sb->buf[sb->len - 1] == '\n')
1141                         strbuf_setlen(sb, sb->len - 1);
1142         } else if (orig_len != sb->len) {
1143                 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1144                         strbuf_insert(sb, orig_len, "\n", 1);
1145                 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1146                         strbuf_insert(sb, orig_len, " ", 1);
1147         }
1148         return consumed + 1;
1149 }
1150
1151 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1152                                    void *context)
1153 {
1154         struct userformat_want *w = context;
1155
1156         if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1157                 placeholder++;
1158
1159         switch (*placeholder) {
1160         case 'N':
1161                 w->notes = 1;
1162                 break;
1163         }
1164         return 0;
1165 }
1166
1167 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1168 {
1169         struct strbuf dummy = STRBUF_INIT;
1170
1171         if (!fmt) {
1172                 if (!user_format)
1173                         return;
1174                 fmt = user_format;
1175         }
1176         strbuf_expand(&dummy, fmt, userformat_want_item, w);
1177         strbuf_release(&dummy);
1178 }
1179
1180 void format_commit_message(const struct commit *commit,
1181                            const char *format, struct strbuf *sb,
1182                            const struct pretty_print_context *pretty_ctx)
1183 {
1184         struct format_commit_context context;
1185         static const char utf8[] = "UTF-8";
1186         const char *output_enc = pretty_ctx->output_encoding;
1187
1188         memset(&context, 0, sizeof(context));
1189         context.commit = commit;
1190         context.pretty_ctx = pretty_ctx;
1191         context.wrap_start = sb->len;
1192         context.message = commit->buffer;
1193         if (output_enc) {
1194                 char *enc = get_header(commit, "encoding");
1195                 if (strcmp(enc ? enc : utf8, output_enc)) {
1196                         context.message = logmsg_reencode(commit, output_enc);
1197                         if (!context.message)
1198                                 context.message = commit->buffer;
1199                 }
1200                 free(enc);
1201         }
1202
1203         strbuf_expand(sb, format, format_commit_item, &context);
1204         rewrap_message_tail(sb, &context, 0, 0, 0);
1205
1206         if (context.message != commit->buffer)
1207                 free(context.message);
1208         free(context.signature.gpg_output);
1209         free(context.signature.signer);
1210 }
1211
1212 static void pp_header(const struct pretty_print_context *pp,
1213                       const char *encoding,
1214                       const struct commit *commit,
1215                       const char **msg_p,
1216                       struct strbuf *sb)
1217 {
1218         int parents_shown = 0;
1219
1220         for (;;) {
1221                 const char *line = *msg_p;
1222                 int linelen = get_one_line(*msg_p);
1223
1224                 if (!linelen)
1225                         return;
1226                 *msg_p += linelen;
1227
1228                 if (linelen == 1)
1229                         /* End of header */
1230                         return;
1231
1232                 if (pp->fmt == CMIT_FMT_RAW) {
1233                         strbuf_add(sb, line, linelen);
1234                         continue;
1235                 }
1236
1237                 if (!memcmp(line, "parent ", 7)) {
1238                         if (linelen != 48)
1239                                 die("bad parent line in commit");
1240                         continue;
1241                 }
1242
1243                 if (!parents_shown) {
1244                         struct commit_list *parent;
1245                         int num;
1246                         for (parent = commit->parents, num = 0;
1247                              parent;
1248                              parent = parent->next, num++)
1249                                 ;
1250                         /* with enough slop */
1251                         strbuf_grow(sb, num * 50 + 20);
1252                         add_merge_info(pp, sb, commit);
1253                         parents_shown = 1;
1254                 }
1255
1256                 /*
1257                  * MEDIUM == DEFAULT shows only author with dates.
1258                  * FULL shows both authors but not dates.
1259                  * FULLER shows both authors and dates.
1260                  */
1261                 if (!memcmp(line, "author ", 7)) {
1262                         strbuf_grow(sb, linelen + 80);
1263                         pp_user_info(pp, "Author", sb, line + 7, encoding);
1264                 }
1265                 if (!memcmp(line, "committer ", 10) &&
1266                     (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1267                         strbuf_grow(sb, linelen + 80);
1268                         pp_user_info(pp, "Commit", sb, line + 10, encoding);
1269                 }
1270         }
1271 }
1272
1273 void pp_title_line(const struct pretty_print_context *pp,
1274                    const char **msg_p,
1275                    struct strbuf *sb,
1276                    const char *encoding,
1277                    int need_8bit_cte)
1278 {
1279         struct strbuf title;
1280
1281         strbuf_init(&title, 80);
1282         *msg_p = format_subject(&title, *msg_p,
1283                                 pp->preserve_subject ? "\n" : " ");
1284
1285         strbuf_grow(sb, title.len + 1024);
1286         if (pp->subject) {
1287                 strbuf_addstr(sb, pp->subject);
1288                 add_rfc2047(sb, title.buf, title.len, encoding);
1289         } else {
1290                 strbuf_addbuf(sb, &title);
1291         }
1292         strbuf_addch(sb, '\n');
1293
1294         if (need_8bit_cte > 0) {
1295                 const char *header_fmt =
1296                         "MIME-Version: 1.0\n"
1297                         "Content-Type: text/plain; charset=%s\n"
1298                         "Content-Transfer-Encoding: 8bit\n";
1299                 strbuf_addf(sb, header_fmt, encoding);
1300         }
1301         if (pp->after_subject) {
1302                 strbuf_addstr(sb, pp->after_subject);
1303         }
1304         if (pp->fmt == CMIT_FMT_EMAIL) {
1305                 strbuf_addch(sb, '\n');
1306         }
1307         strbuf_release(&title);
1308 }
1309
1310 void pp_remainder(const struct pretty_print_context *pp,
1311                   const char **msg_p,
1312                   struct strbuf *sb,
1313                   int indent)
1314 {
1315         int first = 1;
1316         for (;;) {
1317                 const char *line = *msg_p;
1318                 int linelen = get_one_line(line);
1319                 *msg_p += linelen;
1320
1321                 if (!linelen)
1322                         break;
1323
1324                 if (is_empty_line(line, &linelen)) {
1325                         if (first)
1326                                 continue;
1327                         if (pp->fmt == CMIT_FMT_SHORT)
1328                                 break;
1329                 }
1330                 first = 0;
1331
1332                 strbuf_grow(sb, linelen + indent + 20);
1333                 if (indent) {
1334                         memset(sb->buf + sb->len, ' ', indent);
1335                         strbuf_setlen(sb, sb->len + indent);
1336                 }
1337                 strbuf_add(sb, line, linelen);
1338                 strbuf_addch(sb, '\n');
1339         }
1340 }
1341
1342 char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
1343 {
1344         const char *encoding;
1345
1346         encoding = get_log_output_encoding();
1347         if (encoding_p)
1348                 *encoding_p = encoding;
1349         return logmsg_reencode(commit, encoding);
1350 }
1351
1352 void pretty_print_commit(const struct pretty_print_context *pp,
1353                          const struct commit *commit,
1354                          struct strbuf *sb)
1355 {
1356         unsigned long beginning_of_body;
1357         int indent = 4;
1358         const char *msg = commit->buffer;
1359         char *reencoded;
1360         const char *encoding;
1361         int need_8bit_cte = pp->need_8bit_cte;
1362
1363         if (pp->fmt == CMIT_FMT_USERFORMAT) {
1364                 format_commit_message(commit, user_format, sb, pp);
1365                 return;
1366         }
1367
1368         reencoded = reencode_commit_message(commit, &encoding);
1369         if (reencoded) {
1370                 msg = reencoded;
1371         }
1372
1373         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1374                 indent = 0;
1375
1376         /*
1377          * We need to check and emit Content-type: to mark it
1378          * as 8-bit if we haven't done so.
1379          */
1380         if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1381                 int i, ch, in_body;
1382
1383                 for (in_body = i = 0; (ch = msg[i]); i++) {
1384                         if (!in_body) {
1385                                 /* author could be non 7-bit ASCII but
1386                                  * the log may be so; skip over the
1387                                  * header part first.
1388                                  */
1389                                 if (ch == '\n' && msg[i+1] == '\n')
1390                                         in_body = 1;
1391                         }
1392                         else if (non_ascii(ch)) {
1393                                 need_8bit_cte = 1;
1394                                 break;
1395                         }
1396                 }
1397         }
1398
1399         pp_header(pp, encoding, commit, &msg, sb);
1400         if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1401                 strbuf_addch(sb, '\n');
1402         }
1403
1404         /* Skip excess blank lines at the beginning of body, if any... */
1405         msg = skip_empty_lines(msg);
1406
1407         /* These formats treat the title line specially. */
1408         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1409                 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1410
1411         beginning_of_body = sb->len;
1412         if (pp->fmt != CMIT_FMT_ONELINE)
1413                 pp_remainder(pp, &msg, sb, indent);
1414         strbuf_rtrim(sb);
1415
1416         /* Make sure there is an EOLN for the non-oneline case */
1417         if (pp->fmt != CMIT_FMT_ONELINE)
1418                 strbuf_addch(sb, '\n');
1419
1420         /*
1421          * The caller may append additional body text in e-mail
1422          * format.  Make sure we did not strip the blank line
1423          * between the header and the body.
1424          */
1425         if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1426                 strbuf_addch(sb, '\n');
1427
1428         if (pp->show_notes)
1429                 format_display_notes(commit->object.sha1, sb, encoding,
1430                                      NOTES_SHOW_HEADER | NOTES_INDENT);
1431
1432         free(reencoded);
1433 }
1434
1435 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1436                     struct strbuf *sb)
1437 {
1438         struct pretty_print_context pp = {0};
1439         pp.fmt = fmt;
1440         pretty_print_commit(&pp, commit, sb);
1441 }