am: Use cat instead of echo to avoid DOS line-endings (fixes t4150)
[git/dscho.git] / pretty.c
blobf2dee308b887efc9a23ee1b2dcda9119f23cc9a4
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)
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;
36 static int git_pretty_formats_config(const char *var, const char *value, void *cb)
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;
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;
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++;
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;
82 static void setup_commit_formats(void)
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 }
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;
128 if (found && found->is_alias) {
129 found = find_commit_format_recursive(found->user_format,
130 original,
131 num_redirections+1);
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;
154 if (!prefixcmp(arg, "format:") || !prefixcmp(arg, "tformat:")) {
155 save_user_format(rev, strchr(arg, ':') + 1, arg[0] == 't');
156 return;
159 if (strchr(arg, '%')) {
160 save_user_format(rev, arg, 1);
161 return;
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);
177 * Generic support for pretty-printing the header
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;
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;
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;
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]);
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;
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 */
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.
310 if (is_rfc2047_special(ch) || ch == ' ' || ch == '\n') {
311 strbuf_addf(sb, "=%02X", ch);
312 line_len += 3;
314 else {
315 strbuf_addch(sb, ch);
316 line_len++;
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);
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, ' ');
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);
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;
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;
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);
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);
457 line = next;
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;
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));
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);
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 tz;
535 unsigned long date = 0;
536 char person_name[1024];
537 char person_mail[1024];
538 struct ident_split s;
539 const char *name_start, *name_end, *mail_start, *mail_end;
541 if (split_ident_line(&s, msg, len) < 0)
542 goto skip;
544 name_start = s.name_begin;
545 name_end = s.name_end;
546 mail_start = s.mail_begin;
547 mail_end = s.mail_end;
549 if (part == 'N' || part == 'E') { /* mailmap lookup */
550 strlcpy(person_name, name_start, name_end - name_start + 1);
551 strlcpy(person_mail, mail_start, mail_end - mail_start + 1);
552 mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
553 name_start = person_name;
554 name_end = name_start + strlen(person_name);
555 mail_start = person_mail;
556 mail_end = mail_start + strlen(person_mail);
558 if (part == 'n' || part == 'N') { /* name */
559 strbuf_add(sb, name_start, name_end-name_start);
560 return placeholder_len;
562 if (part == 'e' || part == 'E') { /* email */
563 strbuf_add(sb, mail_start, mail_end-mail_start);
564 return placeholder_len;
567 if (!s.date_begin)
568 goto skip;
570 date = strtoul(s.date_begin, NULL, 10);
572 if (part == 't') { /* date, UNIX timestamp */
573 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
574 return placeholder_len;
577 /* parse tz */
578 tz = strtoul(s.tz_begin + 1, NULL, 10);
579 if (*s.tz_begin == '-')
580 tz = -tz;
582 switch (part) {
583 case 'd': /* date */
584 strbuf_addstr(sb, show_date(date, tz, dmode));
585 return placeholder_len;
586 case 'D': /* date, RFC2822 style */
587 strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
588 return placeholder_len;
589 case 'r': /* date, relative */
590 strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
591 return placeholder_len;
592 case 'i': /* date, ISO 8601 */
593 strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
594 return placeholder_len;
597 skip:
599 * reading from either a bogus commit, or a reflog entry with
600 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
601 * to compute a valid return value.
603 if (part == 'n' || part == 'e' || part == 't' || part == 'd'
604 || part == 'D' || part == 'r' || part == 'i')
605 return placeholder_len;
607 return 0; /* unknown placeholder */
610 struct chunk {
611 size_t off;
612 size_t len;
615 struct format_commit_context {
616 const struct commit *commit;
617 const struct pretty_print_context *pretty_ctx;
618 unsigned commit_header_parsed:1;
619 unsigned commit_message_parsed:1;
620 unsigned commit_signature_parsed:1;
621 struct {
622 char *gpg_output;
623 char good_bad;
624 char *signer;
625 } signature;
626 char *message;
627 size_t width, indent1, indent2;
629 /* These offsets are relative to the start of the commit message. */
630 struct chunk author;
631 struct chunk committer;
632 struct chunk encoding;
633 size_t message_off;
634 size_t subject_off;
635 size_t body_off;
637 /* The following ones are relative to the result struct strbuf. */
638 struct chunk abbrev_commit_hash;
639 struct chunk abbrev_tree_hash;
640 struct chunk abbrev_parent_hashes;
641 size_t wrap_start;
644 static int add_again(struct strbuf *sb, struct chunk *chunk)
646 if (chunk->len) {
647 strbuf_adddup(sb, chunk->off, chunk->len);
648 return 1;
652 * We haven't seen this chunk before. Our caller is surely
653 * going to add it the hard way now. Remember the most likely
654 * start of the to-be-added chunk: the current end of the
655 * struct strbuf.
657 chunk->off = sb->len;
658 return 0;
661 static void parse_commit_header(struct format_commit_context *context)
663 const char *msg = context->message;
664 int i;
666 for (i = 0; msg[i]; i++) {
667 int eol;
668 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
669 ; /* do nothing */
671 if (i == eol) {
672 break;
673 } else if (!prefixcmp(msg + i, "author ")) {
674 context->author.off = i + 7;
675 context->author.len = eol - i - 7;
676 } else if (!prefixcmp(msg + i, "committer ")) {
677 context->committer.off = i + 10;
678 context->committer.len = eol - i - 10;
679 } else if (!prefixcmp(msg + i, "encoding ")) {
680 context->encoding.off = i + 9;
681 context->encoding.len = eol - i - 9;
683 i = eol;
685 context->message_off = i;
686 context->commit_header_parsed = 1;
689 static int istitlechar(char c)
691 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
692 (c >= '0' && c <= '9') || c == '.' || c == '_';
695 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
697 size_t trimlen;
698 size_t start_len = sb->len;
699 int space = 2;
701 for (; *msg && *msg != '\n'; msg++) {
702 if (istitlechar(*msg)) {
703 if (space == 1)
704 strbuf_addch(sb, '-');
705 space = 0;
706 strbuf_addch(sb, *msg);
707 if (*msg == '.')
708 while (*(msg+1) == '.')
709 msg++;
710 } else
711 space |= 1;
714 /* trim any trailing '.' or '-' characters */
715 trimlen = 0;
716 while (sb->len - trimlen > start_len &&
717 (sb->buf[sb->len - 1 - trimlen] == '.'
718 || sb->buf[sb->len - 1 - trimlen] == '-'))
719 trimlen++;
720 strbuf_remove(sb, sb->len - trimlen, trimlen);
723 const char *format_subject(struct strbuf *sb, const char *msg,
724 const char *line_separator)
726 int first = 1;
728 for (;;) {
729 const char *line = msg;
730 int linelen = get_one_line(line);
732 msg += linelen;
733 if (!linelen || is_empty_line(line, &linelen))
734 break;
736 if (!sb)
737 continue;
738 strbuf_grow(sb, linelen + 2);
739 if (!first)
740 strbuf_addstr(sb, line_separator);
741 strbuf_add(sb, line, linelen);
742 first = 0;
744 return msg;
747 static void parse_commit_message(struct format_commit_context *c)
749 const char *msg = c->message + c->message_off;
750 const char *start = c->message;
752 msg = skip_empty_lines(msg);
753 c->subject_off = msg - start;
755 msg = format_subject(NULL, msg, NULL);
756 msg = skip_empty_lines(msg);
757 c->body_off = msg - start;
759 c->commit_message_parsed = 1;
762 static void format_decoration(struct strbuf *sb, const struct commit *commit)
764 struct name_decoration *d;
765 const char *prefix = " (";
767 load_ref_decorations(DECORATE_SHORT_REFS);
768 d = lookup_decoration(&name_decoration, &commit->object);
769 while (d) {
770 strbuf_addstr(sb, prefix);
771 prefix = ", ";
772 strbuf_addstr(sb, d->name);
773 d = d->next;
775 if (prefix[0] == ',')
776 strbuf_addch(sb, ')');
779 static void strbuf_wrap(struct strbuf *sb, size_t pos,
780 size_t width, size_t indent1, size_t indent2)
782 struct strbuf tmp = STRBUF_INIT;
784 if (pos)
785 strbuf_add(&tmp, sb->buf, pos);
786 strbuf_add_wrapped_text(&tmp, sb->buf + pos,
787 (int) indent1, (int) indent2, (int) width);
788 strbuf_swap(&tmp, sb);
789 strbuf_release(&tmp);
792 static void rewrap_message_tail(struct strbuf *sb,
793 struct format_commit_context *c,
794 size_t new_width, size_t new_indent1,
795 size_t new_indent2)
797 if (c->width == new_width && c->indent1 == new_indent1 &&
798 c->indent2 == new_indent2)
799 return;
800 if (c->wrap_start < sb->len)
801 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
802 c->wrap_start = sb->len;
803 c->width = new_width;
804 c->indent1 = new_indent1;
805 c->indent2 = new_indent2;
808 static struct {
809 char result;
810 const char *check;
811 } signature_check[] = {
812 { 'G', ": Good signature from " },
813 { 'B', ": BAD signature from " },
816 static void parse_signature_lines(struct format_commit_context *ctx)
818 const char *buf = ctx->signature.gpg_output;
819 int i;
821 for (i = 0; i < ARRAY_SIZE(signature_check); i++) {
822 const char *found = strstr(buf, signature_check[i].check);
823 const char *next;
824 if (!found)
825 continue;
826 ctx->signature.good_bad = signature_check[i].result;
827 found += strlen(signature_check[i].check);
828 next = strchrnul(found, '\n');
829 ctx->signature.signer = xmemdupz(found, next - found);
830 break;
834 static void parse_commit_signature(struct format_commit_context *ctx)
836 struct strbuf payload = STRBUF_INIT;
837 struct strbuf signature = STRBUF_INIT;
838 struct strbuf gpg_output = STRBUF_INIT;
839 int status;
841 ctx->commit_signature_parsed = 1;
843 if (parse_signed_commit(ctx->commit->object.sha1,
844 &payload, &signature) <= 0)
845 goto out;
846 status = verify_signed_buffer(payload.buf, payload.len,
847 signature.buf, signature.len,
848 &gpg_output);
849 if (status && !gpg_output.len)
850 goto out;
851 ctx->signature.gpg_output = strbuf_detach(&gpg_output, NULL);
852 parse_signature_lines(ctx);
854 out:
855 strbuf_release(&gpg_output);
856 strbuf_release(&payload);
857 strbuf_release(&signature);
861 static int format_reflog_person(struct strbuf *sb,
862 char part,
863 struct reflog_walk_info *log,
864 enum date_mode dmode)
866 const char *ident;
868 if (!log)
869 return 2;
871 ident = get_reflog_ident(log);
872 if (!ident)
873 return 2;
875 return format_person_part(sb, part, ident, strlen(ident), dmode);
878 static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
879 void *context)
881 struct format_commit_context *c = context;
882 const struct commit *commit = c->commit;
883 const char *msg = c->message;
884 struct commit_list *p;
885 int h1, h2;
887 /* these are independent of the commit */
888 switch (placeholder[0]) {
889 case 'C':
890 if (placeholder[1] == '(') {
891 const char *end = strchr(placeholder + 2, ')');
892 char color[COLOR_MAXLEN];
893 if (!end)
894 return 0;
895 color_parse_mem(placeholder + 2,
896 end - (placeholder + 2),
897 "--pretty format", color);
898 strbuf_addstr(sb, color);
899 return end - placeholder + 1;
901 if (!prefixcmp(placeholder + 1, "red")) {
902 strbuf_addstr(sb, GIT_COLOR_RED);
903 return 4;
904 } else if (!prefixcmp(placeholder + 1, "green")) {
905 strbuf_addstr(sb, GIT_COLOR_GREEN);
906 return 6;
907 } else if (!prefixcmp(placeholder + 1, "blue")) {
908 strbuf_addstr(sb, GIT_COLOR_BLUE);
909 return 5;
910 } else if (!prefixcmp(placeholder + 1, "reset")) {
911 strbuf_addstr(sb, GIT_COLOR_RESET);
912 return 6;
913 } else
914 return 0;
915 case 'n': /* newline */
916 strbuf_addch(sb, '\n');
917 return 1;
918 case 'x':
919 /* %x00 == NUL, %x0a == LF, etc. */
920 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
921 h1 <= 16 &&
922 0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
923 h2 <= 16) {
924 strbuf_addch(sb, (h1<<4)|h2);
925 return 3;
926 } else
927 return 0;
928 case 'w':
929 if (placeholder[1] == '(') {
930 unsigned long width = 0, indent1 = 0, indent2 = 0;
931 char *next;
932 const char *start = placeholder + 2;
933 const char *end = strchr(start, ')');
934 if (!end)
935 return 0;
936 if (end > start) {
937 width = strtoul(start, &next, 10);
938 if (*next == ',') {
939 indent1 = strtoul(next + 1, &next, 10);
940 if (*next == ',') {
941 indent2 = strtoul(next + 1,
942 &next, 10);
945 if (*next != ')')
946 return 0;
948 rewrap_message_tail(sb, c, width, indent1, indent2);
949 return end - placeholder + 1;
950 } else
951 return 0;
954 /* these depend on the commit */
955 if (!commit->object.parsed)
956 parse_object(commit->object.sha1);
958 switch (placeholder[0]) {
959 case 'H': /* commit hash */
960 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
961 return 1;
962 case 'h': /* abbreviated commit hash */
963 if (add_again(sb, &c->abbrev_commit_hash))
964 return 1;
965 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
966 c->pretty_ctx->abbrev));
967 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
968 return 1;
969 case 'T': /* tree hash */
970 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
971 return 1;
972 case 't': /* abbreviated tree hash */
973 if (add_again(sb, &c->abbrev_tree_hash))
974 return 1;
975 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
976 c->pretty_ctx->abbrev));
977 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
978 return 1;
979 case 'P': /* parent hashes */
980 for (p = commit->parents; p; p = p->next) {
981 if (p != commit->parents)
982 strbuf_addch(sb, ' ');
983 strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
985 return 1;
986 case 'p': /* abbreviated parent hashes */
987 if (add_again(sb, &c->abbrev_parent_hashes))
988 return 1;
989 for (p = commit->parents; p; p = p->next) {
990 if (p != commit->parents)
991 strbuf_addch(sb, ' ');
992 strbuf_addstr(sb, find_unique_abbrev(
993 p->item->object.sha1,
994 c->pretty_ctx->abbrev));
996 c->abbrev_parent_hashes.len = sb->len -
997 c->abbrev_parent_hashes.off;
998 return 1;
999 case 'm': /* left/right/bottom */
1000 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1001 return 1;
1002 case 'd':
1003 format_decoration(sb, commit);
1004 return 1;
1005 case 'g': /* reflog info */
1006 switch(placeholder[1]) {
1007 case 'd': /* reflog selector */
1008 case 'D':
1009 if (c->pretty_ctx->reflog_info)
1010 get_reflog_selector(sb,
1011 c->pretty_ctx->reflog_info,
1012 c->pretty_ctx->date_mode,
1013 (placeholder[1] == 'd'));
1014 return 2;
1015 case 's': /* reflog message */
1016 if (c->pretty_ctx->reflog_info)
1017 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1018 return 2;
1019 case 'n':
1020 case 'N':
1021 case 'e':
1022 case 'E':
1023 return format_reflog_person(sb,
1024 placeholder[1],
1025 c->pretty_ctx->reflog_info,
1026 c->pretty_ctx->date_mode);
1028 return 0; /* unknown %g placeholder */
1029 case 'N':
1030 if (c->pretty_ctx->show_notes) {
1031 format_display_notes(commit->object.sha1, sb,
1032 get_log_output_encoding(), 0);
1033 return 1;
1035 return 0;
1038 if (placeholder[0] == 'G') {
1039 if (!c->commit_signature_parsed)
1040 parse_commit_signature(c);
1041 switch (placeholder[1]) {
1042 case 'G':
1043 if (c->signature.gpg_output)
1044 strbuf_addstr(sb, c->signature.gpg_output);
1045 break;
1046 case '?':
1047 switch (c->signature.good_bad) {
1048 case 'G':
1049 case 'B':
1050 strbuf_addch(sb, c->signature.good_bad);
1052 break;
1053 case 'S':
1054 if (c->signature.signer)
1055 strbuf_addstr(sb, c->signature.signer);
1056 break;
1058 return 2;
1062 /* For the rest we have to parse the commit header. */
1063 if (!c->commit_header_parsed)
1064 parse_commit_header(c);
1066 switch (placeholder[0]) {
1067 case 'a': /* author ... */
1068 return format_person_part(sb, placeholder[1],
1069 msg + c->author.off, c->author.len,
1070 c->pretty_ctx->date_mode);
1071 case 'c': /* committer ... */
1072 return format_person_part(sb, placeholder[1],
1073 msg + c->committer.off, c->committer.len,
1074 c->pretty_ctx->date_mode);
1075 case 'e': /* encoding */
1076 strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
1077 return 1;
1078 case 'B': /* raw body */
1079 /* message_off is always left at the initial newline */
1080 strbuf_addstr(sb, msg + c->message_off + 1);
1081 return 1;
1084 /* Now we need to parse the commit message. */
1085 if (!c->commit_message_parsed)
1086 parse_commit_message(c);
1088 switch (placeholder[0]) {
1089 case 's': /* subject */
1090 format_subject(sb, msg + c->subject_off, " ");
1091 return 1;
1092 case 'f': /* sanitized subject */
1093 format_sanitized_subject(sb, msg + c->subject_off);
1094 return 1;
1095 case 'b': /* body */
1096 strbuf_addstr(sb, msg + c->body_off);
1097 return 1;
1099 return 0; /* unknown placeholder */
1102 static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
1103 void *context)
1105 int consumed;
1106 size_t orig_len;
1107 enum {
1108 NO_MAGIC,
1109 ADD_LF_BEFORE_NON_EMPTY,
1110 DEL_LF_BEFORE_EMPTY,
1111 ADD_SP_BEFORE_NON_EMPTY
1112 } magic = NO_MAGIC;
1114 switch (placeholder[0]) {
1115 case '-':
1116 magic = DEL_LF_BEFORE_EMPTY;
1117 break;
1118 case '+':
1119 magic = ADD_LF_BEFORE_NON_EMPTY;
1120 break;
1121 case ' ':
1122 magic = ADD_SP_BEFORE_NON_EMPTY;
1123 break;
1124 default:
1125 break;
1127 if (magic != NO_MAGIC)
1128 placeholder++;
1130 orig_len = sb->len;
1131 consumed = format_commit_one(sb, placeholder, context);
1132 if (magic == NO_MAGIC)
1133 return consumed;
1135 if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1136 while (sb->len && sb->buf[sb->len - 1] == '\n')
1137 strbuf_setlen(sb, sb->len - 1);
1138 } else if (orig_len != sb->len) {
1139 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1140 strbuf_insert(sb, orig_len, "\n", 1);
1141 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1142 strbuf_insert(sb, orig_len, " ", 1);
1144 return consumed + 1;
1147 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1148 void *context)
1150 struct userformat_want *w = context;
1152 if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1153 placeholder++;
1155 switch (*placeholder) {
1156 case 'N':
1157 w->notes = 1;
1158 break;
1160 return 0;
1163 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1165 struct strbuf dummy = STRBUF_INIT;
1167 if (!fmt) {
1168 if (!user_format)
1169 return;
1170 fmt = user_format;
1172 strbuf_expand(&dummy, fmt, userformat_want_item, w);
1173 strbuf_release(&dummy);
1176 void format_commit_message(const struct commit *commit,
1177 const char *format, struct strbuf *sb,
1178 const struct pretty_print_context *pretty_ctx)
1180 struct format_commit_context context;
1181 static const char utf8[] = "UTF-8";
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 char *enc = get_header(commit, "encoding");
1191 if (strcmp(enc ? enc : utf8, output_enc)) {
1192 context.message = logmsg_reencode(commit, output_enc);
1193 if (!context.message)
1194 context.message = commit->buffer;
1196 free(enc);
1199 strbuf_expand(sb, format, format_commit_item, &context);
1200 rewrap_message_tail(sb, &context, 0, 0, 0);
1202 if (context.message != commit->buffer)
1203 free(context.message);
1204 free(context.signature.gpg_output);
1205 free(context.signature.signer);
1208 static void pp_header(const struct pretty_print_context *pp,
1209 const char *encoding,
1210 const struct commit *commit,
1211 const char **msg_p,
1212 struct strbuf *sb)
1214 int parents_shown = 0;
1216 for (;;) {
1217 const char *line = *msg_p;
1218 int linelen = get_one_line(*msg_p);
1220 if (!linelen)
1221 return;
1222 *msg_p += linelen;
1224 if (linelen == 1)
1225 /* End of header */
1226 return;
1228 if (pp->fmt == CMIT_FMT_RAW) {
1229 strbuf_add(sb, line, linelen);
1230 continue;
1233 if (!memcmp(line, "parent ", 7)) {
1234 if (linelen != 48)
1235 die("bad parent line in commit");
1236 continue;
1239 if (!parents_shown) {
1240 struct commit_list *parent;
1241 int num;
1242 for (parent = commit->parents, num = 0;
1243 parent;
1244 parent = parent->next, num++)
1246 /* with enough slop */
1247 strbuf_grow(sb, num * 50 + 20);
1248 add_merge_info(pp, sb, commit);
1249 parents_shown = 1;
1253 * MEDIUM == DEFAULT shows only author with dates.
1254 * FULL shows both authors but not dates.
1255 * FULLER shows both authors and dates.
1257 if (!memcmp(line, "author ", 7)) {
1258 strbuf_grow(sb, linelen + 80);
1259 pp_user_info(pp, "Author", sb, line + 7, encoding);
1261 if (!memcmp(line, "committer ", 10) &&
1262 (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1263 strbuf_grow(sb, linelen + 80);
1264 pp_user_info(pp, "Commit", sb, line + 10, encoding);
1269 void pp_title_line(const struct pretty_print_context *pp,
1270 const char **msg_p,
1271 struct strbuf *sb,
1272 const char *encoding,
1273 int need_8bit_cte)
1275 struct strbuf title;
1277 strbuf_init(&title, 80);
1278 *msg_p = format_subject(&title, *msg_p,
1279 pp->preserve_subject ? "\n" : " ");
1281 strbuf_grow(sb, title.len + 1024);
1282 if (pp->subject) {
1283 strbuf_addstr(sb, pp->subject);
1284 add_rfc2047(sb, title.buf, title.len, encoding);
1285 } else {
1286 strbuf_addbuf(sb, &title);
1288 strbuf_addch(sb, '\n');
1290 if (need_8bit_cte > 0) {
1291 const char *header_fmt =
1292 "MIME-Version: 1.0\n"
1293 "Content-Type: text/plain; charset=%s\n"
1294 "Content-Transfer-Encoding: 8bit\n";
1295 strbuf_addf(sb, header_fmt, encoding);
1297 if (pp->after_subject) {
1298 strbuf_addstr(sb, pp->after_subject);
1300 if (pp->fmt == CMIT_FMT_EMAIL) {
1301 strbuf_addch(sb, '\n');
1303 strbuf_release(&title);
1306 void pp_remainder(const struct pretty_print_context *pp,
1307 const char **msg_p,
1308 struct strbuf *sb,
1309 int indent)
1311 int first = 1;
1312 for (;;) {
1313 const char *line = *msg_p;
1314 int linelen = get_one_line(line);
1315 *msg_p += linelen;
1317 if (!linelen)
1318 break;
1320 if (is_empty_line(line, &linelen)) {
1321 if (first)
1322 continue;
1323 if (pp->fmt == CMIT_FMT_SHORT)
1324 break;
1326 first = 0;
1328 strbuf_grow(sb, linelen + indent + 20);
1329 if (indent) {
1330 memset(sb->buf + sb->len, ' ', indent);
1331 strbuf_setlen(sb, sb->len + indent);
1333 strbuf_add(sb, line, linelen);
1334 strbuf_addch(sb, '\n');
1338 char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
1340 const char *encoding;
1342 encoding = get_log_output_encoding();
1343 if (encoding_p)
1344 *encoding_p = encoding;
1345 return logmsg_reencode(commit, encoding);
1348 void pretty_print_commit(const struct pretty_print_context *pp,
1349 const struct commit *commit,
1350 struct strbuf *sb)
1352 unsigned long beginning_of_body;
1353 int indent = 4;
1354 const char *msg = commit->buffer;
1355 char *reencoded;
1356 const char *encoding;
1357 int need_8bit_cte = pp->need_8bit_cte;
1359 if (pp->fmt == CMIT_FMT_USERFORMAT) {
1360 format_commit_message(commit, user_format, sb, pp);
1361 return;
1364 reencoded = reencode_commit_message(commit, &encoding);
1365 if (reencoded) {
1366 msg = reencoded;
1369 if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1370 indent = 0;
1373 * We need to check and emit Content-type: to mark it
1374 * as 8-bit if we haven't done so.
1376 if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1377 int i, ch, in_body;
1379 for (in_body = i = 0; (ch = msg[i]); i++) {
1380 if (!in_body) {
1381 /* author could be non 7-bit ASCII but
1382 * the log may be so; skip over the
1383 * header part first.
1385 if (ch == '\n' && msg[i+1] == '\n')
1386 in_body = 1;
1388 else if (non_ascii(ch)) {
1389 need_8bit_cte = 1;
1390 break;
1395 pp_header(pp, encoding, commit, &msg, sb);
1396 if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1397 strbuf_addch(sb, '\n');
1400 /* Skip excess blank lines at the beginning of body, if any... */
1401 msg = skip_empty_lines(msg);
1403 /* These formats treat the title line specially. */
1404 if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1405 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1407 beginning_of_body = sb->len;
1408 if (pp->fmt != CMIT_FMT_ONELINE)
1409 pp_remainder(pp, &msg, sb, indent);
1410 strbuf_rtrim(sb);
1412 /* Make sure there is an EOLN for the non-oneline case */
1413 if (pp->fmt != CMIT_FMT_ONELINE)
1414 strbuf_addch(sb, '\n');
1417 * The caller may append additional body text in e-mail
1418 * format. Make sure we did not strip the blank line
1419 * between the header and the body.
1421 if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1422 strbuf_addch(sb, '\n');
1424 if (pp->show_notes)
1425 format_display_notes(commit->object.sha1, sb, encoding,
1426 NOTES_SHOW_HEADER | NOTES_INDENT);
1428 free(reencoded);
1431 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1432 struct strbuf *sb)
1434 struct pretty_print_context pp = {0};
1435 pp.fmt = fmt;
1436 pretty_print_commit(&pp, commit, sb);