Code

log-tree: show mergetag in log --show-signature output
[git.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"
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);
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 }
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;
43         if (prefixcmp(var, "pretty."))
44                 return 0;
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         }
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         }
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         }
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;
79         return 0;
80 }
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));
99         git_config(git_pretty_formats_config, NULL);
102 static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
103                                                         const char *original,
104                                                         int num_redirections)
106         struct cmt_fmt_map *found = NULL;
107         size_t found_match_len = 0;
108         int i;
110         if (num_redirections >= commit_formats_len)
111                 die("invalid --pretty format: "
112                     "'%s' references an alias which points to itself",
113                     original);
115         for (i = 0; i < commit_formats_len; i++) {
116                 size_t match_len;
118                 if (prefixcmp(commit_formats[i].name, sought))
119                         continue;
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         }
128         if (found && found->is_alias) {
129                 found = find_commit_format_recursive(found->user_format,
130                                                      original,
131                                                      num_redirections+1);
132         }
134         return found;
137 static struct cmt_fmt_map *find_commit_format(const char *sought)
139         if (!commit_formats)
140                 setup_commit_formats();
142         return find_commit_format_recursive(sought, sought, 0);
145 void get_commit_format(const char *arg, struct rev_info *rev)
147         struct cmt_fmt_map *commit_format;
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         }
159         if (strchr(arg, '%')) {
160                 save_user_format(rev, arg, 1);
161                 return;
162         }
164         commit_format = find_commit_format(arg);
165         if (!commit_format)
166                 die("invalid --pretty format: %s", arg);
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         }
176 /*
177  * Generic support for pretty-printing the header
178  */
179 static int get_one_line(const char *msg)
181         int ret = 0;
183         for (;;) {
184                 char c = *msg++;
185                 if (!c)
186                         break;
187                 ret++;
188                 if (c == '\n')
189                         break;
190         }
191         return ret;
194 /* High bit set, or ISO-2022-INT */
195 static int non_ascii(int ch)
197         return !isascii(ch) || ch == '\033';
200 int has_non_ascii(const char *s)
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;
212 static int is_rfc822_special(char ch)
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         }
234 static int has_rfc822_specials(const char *s, int len)
236         int i;
237         for (i = 0; i < len; i++)
238                 if (is_rfc822_special(s[i]))
239                         return 1;
240         return 0;
243 static void add_rfc822_quoted(struct strbuf *out, const char *s, int len)
245         int i;
247         /* just a guess, we may have to also backslash-quote */
248         strbuf_grow(out, len + 2);
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, '"');
264 static int is_rfc2047_special(char ch)
266         return (non_ascii(ch) || (ch == '=') || (ch == '?') || (ch == '_'));
269 static void add_rfc2047(struct strbuf *sb, const char *line, int len,
270                        const char *encoding)
272         static const int max_length = 78; /* per rfc2822 */
273         int i;
274         int line_len;
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);
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;
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;
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                 }
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, "?=");
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)
326         char *date;
327         int namelen;
328         unsigned long time;
329         int tz;
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);
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         }
389 static int is_empty_line(const char *line, int *len_p)
391         int len = *len_p;
392         while (len && isspace(line[len-1]))
393                 len--;
394         *len_p = len;
395         return !len;
398 static const char *skip_empty_lines(const char *msg)
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;
412 static void add_merge_info(const struct pretty_print_context *pp,
413                            struct strbuf *sb, const struct commit *commit)
415         struct commit_list *parent = commit->parents;
417         if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
418             !parent || !parent->next)
419                 return;
421         strbuf_addstr(sb, "Merge:");
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;
432                 strbuf_addf(sb, " %s", hex);
433         }
434         strbuf_addch(sb, '\n');
437 static char *get_header(const struct commit *commit, const char *key)
439         int key_len = strlen(key);
440         const char *line = commit->buffer;
442         for (;;) {
443                 const char *eol = strchr(line, '\n'), *next;
445                 if (line == eol)
446                         return NULL;
447                 if (!eol) {
448                         eol = line + strlen(line);
449                         next = NULL;
450                 } else
451                         next = eol + 1;
452                 if (eol - line > key_len &&
453                     !strncmp(line, key, key_len) &&
454                     line[key_len] == ' ') {
455                         return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
456                 }
457                 line = next;
458         }
461 static char *replace_encoding_header(char *buf, const char *encoding)
463         struct strbuf tmp = STRBUF_INIT;
464         size_t start, len;
465         char *cp = buf;
467         /* guess if there is an encoding header before a \n\n */
468         while (strncmp(cp, "encoding ", strlen("encoding "))) {
469                 cp = strchr(cp, '\n');
470                 if (!cp || *++cp == '\n')
471                         return buf;
472         }
473         start = cp - buf;
474         cp = strchr(cp, '\n');
475         if (!cp)
476                 return buf; /* should not happen but be defensive */
477         len = cp + 1 - (buf + start);
479         strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
480         if (is_encoding_utf8(encoding)) {
481                 /* we have re-coded to UTF-8; drop the header */
482                 strbuf_remove(&tmp, start, len);
483         } else {
484                 /* just replaces XXXX in 'encoding XXXX\n' */
485                 strbuf_splice(&tmp, start + strlen("encoding "),
486                                           len - strlen("encoding \n"),
487                                           encoding, strlen(encoding));
488         }
489         return strbuf_detach(&tmp, NULL);
492 char *logmsg_reencode(const struct commit *commit,
493                       const char *output_encoding)
495         static const char *utf8 = "UTF-8";
496         const char *use_encoding;
497         char *encoding;
498         char *out;
500         if (!*output_encoding)
501                 return NULL;
502         encoding = get_header(commit, "encoding");
503         use_encoding = encoding ? encoding : utf8;
504         if (!strcmp(use_encoding, output_encoding))
505                 if (encoding) /* we'll strip encoding header later */
506                         out = xstrdup(commit->buffer);
507                 else
508                         return NULL; /* nothing to do */
509         else
510                 out = reencode_string(commit->buffer,
511                                       output_encoding, use_encoding);
512         if (out)
513                 out = replace_encoding_header(out, output_encoding);
515         free(encoding);
516         return out;
519 static int mailmap_name(char *email, int email_len, char *name, int name_len)
521         static struct string_list *mail_map;
522         if (!mail_map) {
523                 mail_map = xcalloc(1, sizeof(*mail_map));
524                 read_mailmap(mail_map, NULL);
525         }
526         return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
529 static size_t format_person_part(struct strbuf *sb, char part,
530                                  const char *msg, int len, enum date_mode dmode)
532         /* currently all placeholders have same length */
533         const int placeholder_len = 2;
534         int start, end, tz = 0;
535         unsigned long date = 0;
536         char *ep;
537         const char *name_start, *name_end, *mail_start, *mail_end, *msg_end = msg+len;
538         char person_name[1024];
539         char person_mail[1024];
541         /* advance 'end' to point to email start delimiter */
542         for (end = 0; end < len && msg[end] != '<'; end++)
543                 ; /* do nothing */
545         /*
546          * When end points at the '<' that we found, it should have
547          * matching '>' later, which means 'end' must be strictly
548          * below len - 1.
549          */
550         if (end >= len - 2)
551                 goto skip;
553         /* Seek for both name and email part */
554         name_start = msg;
555         name_end = msg+end;
556         while (name_end > name_start && isspace(*(name_end-1)))
557                 name_end--;
558         mail_start = msg+end+1;
559         mail_end = mail_start;
560         while (mail_end < msg_end && *mail_end != '>')
561                 mail_end++;
562         if (mail_end == msg_end)
563                 goto skip;
564         end = mail_end-msg;
566         if (part == 'N' || part == 'E') { /* mailmap lookup */
567                 strlcpy(person_name, name_start, name_end-name_start+1);
568                 strlcpy(person_mail, mail_start, mail_end-mail_start+1);
569                 mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
570                 name_start = person_name;
571                 name_end = name_start + strlen(person_name);
572                 mail_start = person_mail;
573                 mail_end = mail_start +  strlen(person_mail);
574         }
575         if (part == 'n' || part == 'N') {       /* name */
576                 strbuf_add(sb, name_start, name_end-name_start);
577                 return placeholder_len;
578         }
579         if (part == 'e' || part == 'E') {       /* email */
580                 strbuf_add(sb, mail_start, mail_end-mail_start);
581                 return placeholder_len;
582         }
584         /* advance 'start' to point to date start delimiter */
585         for (start = end + 1; start < len && isspace(msg[start]); start++)
586                 ; /* do nothing */
587         if (start >= len)
588                 goto skip;
589         date = strtoul(msg + start, &ep, 10);
590         if (msg + start == ep)
591                 goto skip;
593         if (part == 't') {      /* date, UNIX timestamp */
594                 strbuf_add(sb, msg + start, ep - (msg + start));
595                 return placeholder_len;
596         }
598         /* parse tz */
599         for (start = ep - msg + 1; start < len && isspace(msg[start]); start++)
600                 ; /* do nothing */
601         if (start + 1 < len) {
602                 tz = strtoul(msg + start + 1, NULL, 10);
603                 if (msg[start] == '-')
604                         tz = -tz;
605         }
607         switch (part) {
608         case 'd':       /* date */
609                 strbuf_addstr(sb, show_date(date, tz, dmode));
610                 return placeholder_len;
611         case 'D':       /* date, RFC2822 style */
612                 strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
613                 return placeholder_len;
614         case 'r':       /* date, relative */
615                 strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
616                 return placeholder_len;
617         case 'i':       /* date, ISO 8601 */
618                 strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
619                 return placeholder_len;
620         }
622 skip:
623         /*
624          * bogus commit, 'sb' cannot be updated, but we still need to
625          * compute a valid return value.
626          */
627         if (part == 'n' || part == 'e' || part == 't' || part == 'd'
628             || part == 'D' || part == 'r' || part == 'i')
629                 return placeholder_len;
631         return 0; /* unknown placeholder */
634 struct chunk {
635         size_t off;
636         size_t len;
637 };
639 struct format_commit_context {
640         const struct commit *commit;
641         const struct pretty_print_context *pretty_ctx;
642         unsigned commit_header_parsed:1;
643         unsigned commit_message_parsed:1;
644         unsigned commit_signature_parsed:1;
645         struct {
646                 char *gpg_output;
647                 char good_bad;
648                 char *signer;
649         } signature;
650         char *message;
651         size_t width, indent1, indent2;
653         /* These offsets are relative to the start of the commit message. */
654         struct chunk author;
655         struct chunk committer;
656         struct chunk encoding;
657         size_t message_off;
658         size_t subject_off;
659         size_t body_off;
661         /* The following ones are relative to the result struct strbuf. */
662         struct chunk abbrev_commit_hash;
663         struct chunk abbrev_tree_hash;
664         struct chunk abbrev_parent_hashes;
665         size_t wrap_start;
666 };
668 static int add_again(struct strbuf *sb, struct chunk *chunk)
670         if (chunk->len) {
671                 strbuf_adddup(sb, chunk->off, chunk->len);
672                 return 1;
673         }
675         /*
676          * We haven't seen this chunk before.  Our caller is surely
677          * going to add it the hard way now.  Remember the most likely
678          * start of the to-be-added chunk: the current end of the
679          * struct strbuf.
680          */
681         chunk->off = sb->len;
682         return 0;
685 static void parse_commit_header(struct format_commit_context *context)
687         const char *msg = context->message;
688         int i;
690         for (i = 0; msg[i]; i++) {
691                 int eol;
692                 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
693                         ; /* do nothing */
695                 if (i == eol) {
696                         break;
697                 } else if (!prefixcmp(msg + i, "author ")) {
698                         context->author.off = i + 7;
699                         context->author.len = eol - i - 7;
700                 } else if (!prefixcmp(msg + i, "committer ")) {
701                         context->committer.off = i + 10;
702                         context->committer.len = eol - i - 10;
703                 } else if (!prefixcmp(msg + i, "encoding ")) {
704                         context->encoding.off = i + 9;
705                         context->encoding.len = eol - i - 9;
706                 }
707                 i = eol;
708         }
709         context->message_off = i;
710         context->commit_header_parsed = 1;
713 static int istitlechar(char c)
715         return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
716                 (c >= '0' && c <= '9') || c == '.' || c == '_';
719 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
721         size_t trimlen;
722         size_t start_len = sb->len;
723         int space = 2;
725         for (; *msg && *msg != '\n'; msg++) {
726                 if (istitlechar(*msg)) {
727                         if (space == 1)
728                                 strbuf_addch(sb, '-');
729                         space = 0;
730                         strbuf_addch(sb, *msg);
731                         if (*msg == '.')
732                                 while (*(msg+1) == '.')
733                                         msg++;
734                 } else
735                         space |= 1;
736         }
738         /* trim any trailing '.' or '-' characters */
739         trimlen = 0;
740         while (sb->len - trimlen > start_len &&
741                 (sb->buf[sb->len - 1 - trimlen] == '.'
742                 || sb->buf[sb->len - 1 - trimlen] == '-'))
743                 trimlen++;
744         strbuf_remove(sb, sb->len - trimlen, trimlen);
747 const char *format_subject(struct strbuf *sb, const char *msg,
748                            const char *line_separator)
750         int first = 1;
752         for (;;) {
753                 const char *line = msg;
754                 int linelen = get_one_line(line);
756                 msg += linelen;
757                 if (!linelen || is_empty_line(line, &linelen))
758                         break;
760                 if (!sb)
761                         continue;
762                 strbuf_grow(sb, linelen + 2);
763                 if (!first)
764                         strbuf_addstr(sb, line_separator);
765                 strbuf_add(sb, line, linelen);
766                 first = 0;
767         }
768         return msg;
771 static void parse_commit_message(struct format_commit_context *c)
773         const char *msg = c->message + c->message_off;
774         const char *start = c->message;
776         msg = skip_empty_lines(msg);
777         c->subject_off = msg - start;
779         msg = format_subject(NULL, msg, NULL);
780         msg = skip_empty_lines(msg);
781         c->body_off = msg - start;
783         c->commit_message_parsed = 1;
786 static void format_decoration(struct strbuf *sb, const struct commit *commit)
788         struct name_decoration *d;
789         const char *prefix = " (";
791         load_ref_decorations(DECORATE_SHORT_REFS);
792         d = lookup_decoration(&name_decoration, &commit->object);
793         while (d) {
794                 strbuf_addstr(sb, prefix);
795                 prefix = ", ";
796                 strbuf_addstr(sb, d->name);
797                 d = d->next;
798         }
799         if (prefix[0] == ',')
800                 strbuf_addch(sb, ')');
803 static void strbuf_wrap(struct strbuf *sb, size_t pos,
804                         size_t width, size_t indent1, size_t indent2)
806         struct strbuf tmp = STRBUF_INIT;
808         if (pos)
809                 strbuf_add(&tmp, sb->buf, pos);
810         strbuf_add_wrapped_text(&tmp, sb->buf + pos,
811                                 (int) indent1, (int) indent2, (int) width);
812         strbuf_swap(&tmp, sb);
813         strbuf_release(&tmp);
816 static void rewrap_message_tail(struct strbuf *sb,
817                                 struct format_commit_context *c,
818                                 size_t new_width, size_t new_indent1,
819                                 size_t new_indent2)
821         if (c->width == new_width && c->indent1 == new_indent1 &&
822             c->indent2 == new_indent2)
823                 return;
824         if (c->wrap_start < sb->len)
825                 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
826         c->wrap_start = sb->len;
827         c->width = new_width;
828         c->indent1 = new_indent1;
829         c->indent2 = new_indent2;
832 static struct {
833         char result;
834         const char *check;
835 } signature_check[] = {
836         { 'G', ": Good signature from " },
837         { 'B', ": BAD signature from " },
838 };
840 static void parse_signature_lines(struct format_commit_context *ctx)
842         const char *buf = ctx->signature.gpg_output;
843         int i;
845         for (i = 0; i < ARRAY_SIZE(signature_check); i++) {
846                 const char *found = strstr(buf, signature_check[i].check);
847                 const char *next;
848                 if (!found)
849                         continue;
850                 ctx->signature.good_bad = signature_check[i].result;
851                 found += strlen(signature_check[i].check);
852                 next = strchrnul(found, '\n');
853                 ctx->signature.signer = xmemdupz(found, next - found);
854                 break;
855         }
858 static void parse_commit_signature(struct format_commit_context *ctx)
860         struct strbuf payload = STRBUF_INIT;
861         struct strbuf signature = STRBUF_INIT;
862         struct strbuf gpg_output = STRBUF_INIT;
863         int status;
865         ctx->commit_signature_parsed = 1;
867         if (parse_signed_commit(ctx->commit->object.sha1,
868                                 &payload, &signature) <= 0)
869                 goto out;
870         status = verify_signed_buffer(payload.buf, payload.len,
871                                       signature.buf, signature.len,
872                                       &gpg_output);
873         if (status && !gpg_output.len)
874                 goto out;
875         ctx->signature.gpg_output = strbuf_detach(&gpg_output, NULL);
876         parse_signature_lines(ctx);
878  out:
879         strbuf_release(&gpg_output);
880         strbuf_release(&payload);
881         strbuf_release(&signature);
885 static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
886                                 void *context)
888         struct format_commit_context *c = context;
889         const struct commit *commit = c->commit;
890         const char *msg = c->message;
891         struct commit_list *p;
892         int h1, h2;
894         /* these are independent of the commit */
895         switch (placeholder[0]) {
896         case 'C':
897                 if (placeholder[1] == '(') {
898                         const char *end = strchr(placeholder + 2, ')');
899                         char color[COLOR_MAXLEN];
900                         if (!end)
901                                 return 0;
902                         color_parse_mem(placeholder + 2,
903                                         end - (placeholder + 2),
904                                         "--pretty format", color);
905                         strbuf_addstr(sb, color);
906                         return end - placeholder + 1;
907                 }
908                 if (!prefixcmp(placeholder + 1, "red")) {
909                         strbuf_addstr(sb, GIT_COLOR_RED);
910                         return 4;
911                 } else if (!prefixcmp(placeholder + 1, "green")) {
912                         strbuf_addstr(sb, GIT_COLOR_GREEN);
913                         return 6;
914                 } else if (!prefixcmp(placeholder + 1, "blue")) {
915                         strbuf_addstr(sb, GIT_COLOR_BLUE);
916                         return 5;
917                 } else if (!prefixcmp(placeholder + 1, "reset")) {
918                         strbuf_addstr(sb, GIT_COLOR_RESET);
919                         return 6;
920                 } else
921                         return 0;
922         case 'n':               /* newline */
923                 strbuf_addch(sb, '\n');
924                 return 1;
925         case 'x':
926                 /* %x00 == NUL, %x0a == LF, etc. */
927                 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
928                     h1 <= 16 &&
929                     0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
930                     h2 <= 16) {
931                         strbuf_addch(sb, (h1<<4)|h2);
932                         return 3;
933                 } else
934                         return 0;
935         case 'w':
936                 if (placeholder[1] == '(') {
937                         unsigned long width = 0, indent1 = 0, indent2 = 0;
938                         char *next;
939                         const char *start = placeholder + 2;
940                         const char *end = strchr(start, ')');
941                         if (!end)
942                                 return 0;
943                         if (end > start) {
944                                 width = strtoul(start, &next, 10);
945                                 if (*next == ',') {
946                                         indent1 = strtoul(next + 1, &next, 10);
947                                         if (*next == ',') {
948                                                 indent2 = strtoul(next + 1,
949                                                                  &next, 10);
950                                         }
951                                 }
952                                 if (*next != ')')
953                                         return 0;
954                         }
955                         rewrap_message_tail(sb, c, width, indent1, indent2);
956                         return end - placeholder + 1;
957                 } else
958                         return 0;
959         }
961         /* these depend on the commit */
962         if (!commit->object.parsed)
963                 parse_object(commit->object.sha1);
965         switch (placeholder[0]) {
966         case 'H':               /* commit hash */
967                 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
968                 return 1;
969         case 'h':               /* abbreviated commit hash */
970                 if (add_again(sb, &c->abbrev_commit_hash))
971                         return 1;
972                 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
973                                                      c->pretty_ctx->abbrev));
974                 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
975                 return 1;
976         case 'T':               /* tree hash */
977                 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
978                 return 1;
979         case 't':               /* abbreviated tree hash */
980                 if (add_again(sb, &c->abbrev_tree_hash))
981                         return 1;
982                 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
983                                                      c->pretty_ctx->abbrev));
984                 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
985                 return 1;
986         case 'P':               /* parent hashes */
987                 for (p = commit->parents; p; p = p->next) {
988                         if (p != commit->parents)
989                                 strbuf_addch(sb, ' ');
990                         strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
991                 }
992                 return 1;
993         case 'p':               /* abbreviated parent hashes */
994                 if (add_again(sb, &c->abbrev_parent_hashes))
995                         return 1;
996                 for (p = commit->parents; p; p = p->next) {
997                         if (p != commit->parents)
998                                 strbuf_addch(sb, ' ');
999                         strbuf_addstr(sb, find_unique_abbrev(
1000                                         p->item->object.sha1,
1001                                         c->pretty_ctx->abbrev));
1002                 }
1003                 c->abbrev_parent_hashes.len = sb->len -
1004                                               c->abbrev_parent_hashes.off;
1005                 return 1;
1006         case 'm':               /* left/right/bottom */
1007                 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1008                 return 1;
1009         case 'd':
1010                 format_decoration(sb, commit);
1011                 return 1;
1012         case 'g':               /* reflog info */
1013                 switch(placeholder[1]) {
1014                 case 'd':       /* reflog selector */
1015                 case 'D':
1016                         if (c->pretty_ctx->reflog_info)
1017                                 get_reflog_selector(sb,
1018                                                     c->pretty_ctx->reflog_info,
1019                                                     c->pretty_ctx->date_mode,
1020                                                     (placeholder[1] == 'd'));
1021                         return 2;
1022                 case 's':       /* reflog message */
1023                         if (c->pretty_ctx->reflog_info)
1024                                 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1025                         return 2;
1026                 }
1027                 return 0;       /* unknown %g placeholder */
1028         case 'N':
1029                 if (c->pretty_ctx->show_notes) {
1030                         format_display_notes(commit->object.sha1, sb,
1031                                     get_log_output_encoding(), 0);
1032                         return 1;
1033                 }
1034                 return 0;
1035         }
1037         if (placeholder[0] == 'G') {
1038                 if (!c->commit_signature_parsed)
1039                         parse_commit_signature(c);
1040                 switch (placeholder[1]) {
1041                 case 'G':
1042                         if (c->signature.gpg_output)
1043                                 strbuf_addstr(sb, c->signature.gpg_output);
1044                         break;
1045                 case '?':
1046                         switch (c->signature.good_bad) {
1047                         case 'G':
1048                         case 'B':
1049                                 strbuf_addch(sb, c->signature.good_bad);
1050                         }
1051                         break;
1052                 case 'S':
1053                         if (c->signature.signer)
1054                                 strbuf_addstr(sb, c->signature.signer);
1055                         break;
1056                 }
1057                 return 2;
1058         }
1061         /* For the rest we have to parse the commit header. */
1062         if (!c->commit_header_parsed)
1063                 parse_commit_header(c);
1065         switch (placeholder[0]) {
1066         case 'a':       /* author ... */
1067                 return format_person_part(sb, placeholder[1],
1068                                    msg + c->author.off, c->author.len,
1069                                    c->pretty_ctx->date_mode);
1070         case 'c':       /* committer ... */
1071                 return format_person_part(sb, placeholder[1],
1072                                    msg + c->committer.off, c->committer.len,
1073                                    c->pretty_ctx->date_mode);
1074         case 'e':       /* encoding */
1075                 strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
1076                 return 1;
1077         case 'B':       /* raw body */
1078                 /* message_off is always left at the initial newline */
1079                 strbuf_addstr(sb, msg + c->message_off + 1);
1080                 return 1;
1081         }
1083         /* Now we need to parse the commit message. */
1084         if (!c->commit_message_parsed)
1085                 parse_commit_message(c);
1087         switch (placeholder[0]) {
1088         case 's':       /* subject */
1089                 format_subject(sb, msg + c->subject_off, " ");
1090                 return 1;
1091         case 'f':       /* sanitized subject */
1092                 format_sanitized_subject(sb, msg + c->subject_off);
1093                 return 1;
1094         case 'b':       /* body */
1095                 strbuf_addstr(sb, msg + c->body_off);
1096                 return 1;
1097         }
1098         return 0;       /* unknown placeholder */
1101 static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
1102                                  void *context)
1104         int consumed;
1105         size_t orig_len;
1106         enum {
1107                 NO_MAGIC,
1108                 ADD_LF_BEFORE_NON_EMPTY,
1109                 DEL_LF_BEFORE_EMPTY,
1110                 ADD_SP_BEFORE_NON_EMPTY
1111         } magic = NO_MAGIC;
1113         switch (placeholder[0]) {
1114         case '-':
1115                 magic = DEL_LF_BEFORE_EMPTY;
1116                 break;
1117         case '+':
1118                 magic = ADD_LF_BEFORE_NON_EMPTY;
1119                 break;
1120         case ' ':
1121                 magic = ADD_SP_BEFORE_NON_EMPTY;
1122                 break;
1123         default:
1124                 break;
1125         }
1126         if (magic != NO_MAGIC)
1127                 placeholder++;
1129         orig_len = sb->len;
1130         consumed = format_commit_one(sb, placeholder, context);
1131         if (magic == NO_MAGIC)
1132                 return consumed;
1134         if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1135                 while (sb->len && sb->buf[sb->len - 1] == '\n')
1136                         strbuf_setlen(sb, sb->len - 1);
1137         } else if (orig_len != sb->len) {
1138                 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1139                         strbuf_insert(sb, orig_len, "\n", 1);
1140                 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1141                         strbuf_insert(sb, orig_len, " ", 1);
1142         }
1143         return consumed + 1;
1146 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1147                                    void *context)
1149         struct userformat_want *w = context;
1151         if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1152                 placeholder++;
1154         switch (*placeholder) {
1155         case 'N':
1156                 w->notes = 1;
1157                 break;
1158         }
1159         return 0;
1162 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1164         struct strbuf dummy = STRBUF_INIT;
1166         if (!fmt) {
1167                 if (!user_format)
1168                         return;
1169                 fmt = user_format;
1170         }
1171         strbuf_expand(&dummy, fmt, userformat_want_item, w);
1172         strbuf_release(&dummy);
1175 void format_commit_message(const struct commit *commit,
1176                            const char *format, struct strbuf *sb,
1177                            const struct pretty_print_context *pretty_ctx)
1179         struct format_commit_context context;
1180         static const char utf8[] = "UTF-8";
1181         const char *enc;
1182         const char *output_enc = pretty_ctx->output_encoding;
1184         memset(&context, 0, sizeof(context));
1185         context.commit = commit;
1186         context.pretty_ctx = pretty_ctx;
1187         context.wrap_start = sb->len;
1188         context.message = commit->buffer;
1189         if (output_enc) {
1190                 enc = get_header(commit, "encoding");
1191                 enc = enc ? enc : utf8;
1192                 if (strcmp(enc, output_enc))
1193                         context.message = logmsg_reencode(commit, output_enc);
1194         }
1196         strbuf_expand(sb, format, format_commit_item, &context);
1197         rewrap_message_tail(sb, &context, 0, 0, 0);
1199         if (context.message != commit->buffer)
1200                 free(context.message);
1201         free(context.signature.gpg_output);
1202         free(context.signature.signer);
1205 static void pp_header(const struct pretty_print_context *pp,
1206                       const char *encoding,
1207                       const struct commit *commit,
1208                       const char **msg_p,
1209                       struct strbuf *sb)
1211         int parents_shown = 0;
1213         for (;;) {
1214                 const char *line = *msg_p;
1215                 int linelen = get_one_line(*msg_p);
1217                 if (!linelen)
1218                         return;
1219                 *msg_p += linelen;
1221                 if (linelen == 1)
1222                         /* End of header */
1223                         return;
1225                 if (pp->fmt == CMIT_FMT_RAW) {
1226                         strbuf_add(sb, line, linelen);
1227                         continue;
1228                 }
1230                 if (!memcmp(line, "parent ", 7)) {
1231                         if (linelen != 48)
1232                                 die("bad parent line in commit");
1233                         continue;
1234                 }
1236                 if (!parents_shown) {
1237                         struct commit_list *parent;
1238                         int num;
1239                         for (parent = commit->parents, num = 0;
1240                              parent;
1241                              parent = parent->next, num++)
1242                                 ;
1243                         /* with enough slop */
1244                         strbuf_grow(sb, num * 50 + 20);
1245                         add_merge_info(pp, sb, commit);
1246                         parents_shown = 1;
1247                 }
1249                 /*
1250                  * MEDIUM == DEFAULT shows only author with dates.
1251                  * FULL shows both authors but not dates.
1252                  * FULLER shows both authors and dates.
1253                  */
1254                 if (!memcmp(line, "author ", 7)) {
1255                         strbuf_grow(sb, linelen + 80);
1256                         pp_user_info(pp, "Author", sb, line + 7, encoding);
1257                 }
1258                 if (!memcmp(line, "committer ", 10) &&
1259                     (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1260                         strbuf_grow(sb, linelen + 80);
1261                         pp_user_info(pp, "Commit", sb, line + 10, encoding);
1262                 }
1263         }
1266 void pp_title_line(const struct pretty_print_context *pp,
1267                    const char **msg_p,
1268                    struct strbuf *sb,
1269                    const char *encoding,
1270                    int need_8bit_cte)
1272         struct strbuf title;
1274         strbuf_init(&title, 80);
1275         *msg_p = format_subject(&title, *msg_p,
1276                                 pp->preserve_subject ? "\n" : " ");
1278         strbuf_grow(sb, title.len + 1024);
1279         if (pp->subject) {
1280                 strbuf_addstr(sb, pp->subject);
1281                 add_rfc2047(sb, title.buf, title.len, encoding);
1282         } else {
1283                 strbuf_addbuf(sb, &title);
1284         }
1285         strbuf_addch(sb, '\n');
1287         if (need_8bit_cte > 0) {
1288                 const char *header_fmt =
1289                         "MIME-Version: 1.0\n"
1290                         "Content-Type: text/plain; charset=%s\n"
1291                         "Content-Transfer-Encoding: 8bit\n";
1292                 strbuf_addf(sb, header_fmt, encoding);
1293         }
1294         if (pp->after_subject) {
1295                 strbuf_addstr(sb, pp->after_subject);
1296         }
1297         if (pp->fmt == CMIT_FMT_EMAIL) {
1298                 strbuf_addch(sb, '\n');
1299         }
1300         strbuf_release(&title);
1303 void pp_remainder(const struct pretty_print_context *pp,
1304                   const char **msg_p,
1305                   struct strbuf *sb,
1306                   int indent)
1308         int first = 1;
1309         for (;;) {
1310                 const char *line = *msg_p;
1311                 int linelen = get_one_line(line);
1312                 *msg_p += linelen;
1314                 if (!linelen)
1315                         break;
1317                 if (is_empty_line(line, &linelen)) {
1318                         if (first)
1319                                 continue;
1320                         if (pp->fmt == CMIT_FMT_SHORT)
1321                                 break;
1322                 }
1323                 first = 0;
1325                 strbuf_grow(sb, linelen + indent + 20);
1326                 if (indent) {
1327                         memset(sb->buf + sb->len, ' ', indent);
1328                         strbuf_setlen(sb, sb->len + indent);
1329                 }
1330                 strbuf_add(sb, line, linelen);
1331                 strbuf_addch(sb, '\n');
1332         }
1335 char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
1337         const char *encoding;
1339         encoding = get_log_output_encoding();
1340         if (encoding_p)
1341                 *encoding_p = encoding;
1342         return logmsg_reencode(commit, encoding);
1345 void pretty_print_commit(const struct pretty_print_context *pp,
1346                          const struct commit *commit,
1347                          struct strbuf *sb)
1349         unsigned long beginning_of_body;
1350         int indent = 4;
1351         const char *msg = commit->buffer;
1352         char *reencoded;
1353         const char *encoding;
1354         int need_8bit_cte = pp->need_8bit_cte;
1356         if (pp->fmt == CMIT_FMT_USERFORMAT) {
1357                 format_commit_message(commit, user_format, sb, pp);
1358                 return;
1359         }
1361         reencoded = reencode_commit_message(commit, &encoding);
1362         if (reencoded) {
1363                 msg = reencoded;
1364         }
1366         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1367                 indent = 0;
1369         /*
1370          * We need to check and emit Content-type: to mark it
1371          * as 8-bit if we haven't done so.
1372          */
1373         if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1374                 int i, ch, in_body;
1376                 for (in_body = i = 0; (ch = msg[i]); i++) {
1377                         if (!in_body) {
1378                                 /* author could be non 7-bit ASCII but
1379                                  * the log may be so; skip over the
1380                                  * header part first.
1381                                  */
1382                                 if (ch == '\n' && msg[i+1] == '\n')
1383                                         in_body = 1;
1384                         }
1385                         else if (non_ascii(ch)) {
1386                                 need_8bit_cte = 1;
1387                                 break;
1388                         }
1389                 }
1390         }
1392         pp_header(pp, encoding, commit, &msg, sb);
1393         if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1394                 strbuf_addch(sb, '\n');
1395         }
1397         /* Skip excess blank lines at the beginning of body, if any... */
1398         msg = skip_empty_lines(msg);
1400         /* These formats treat the title line specially. */
1401         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1402                 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1404         beginning_of_body = sb->len;
1405         if (pp->fmt != CMIT_FMT_ONELINE)
1406                 pp_remainder(pp, &msg, sb, indent);
1407         strbuf_rtrim(sb);
1409         /* Make sure there is an EOLN for the non-oneline case */
1410         if (pp->fmt != CMIT_FMT_ONELINE)
1411                 strbuf_addch(sb, '\n');
1413         /*
1414          * The caller may append additional body text in e-mail
1415          * format.  Make sure we did not strip the blank line
1416          * between the header and the body.
1417          */
1418         if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1419                 strbuf_addch(sb, '\n');
1421         if (pp->show_notes)
1422                 format_display_notes(commit->object.sha1, sb, encoding,
1423                                      NOTES_SHOW_HEADER | NOTES_INDENT);
1425         free(reencoded);
1428 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1429                     struct strbuf *sb)
1431         struct pretty_print_context pp = {0};
1432         pp.fmt = fmt;
1433         pretty_print_commit(&pp, commit, sb);