format-patch: do not wrap rfc2047 encoded headers too late
[git/jrn.git] / pretty.c
blobda758799993b8b4869d01be6375186c1378d7df5
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 if (ch == ' ' || ch == '\n')
267 return 1;
269 return (non_ascii(ch) || (ch == '=') || (ch == '?') || (ch == '_'));
272 static void add_rfc2047(struct strbuf *sb, const char *line, int len,
273 const char *encoding)
275 static const int max_length = 78; /* per rfc2822 */
276 static const int max_encoded_length = 76; /* per rfc2047 */
277 int i;
278 int line_len;
280 /* How many bytes are already used on the current line? */
281 for (i = sb->len - 1; i >= 0; i--)
282 if (sb->buf[i] == '\n')
283 break;
284 line_len = sb->len - (i+1);
286 for (i = 0; i < len; i++) {
287 int ch = line[i];
288 if (non_ascii(ch) || ch == '\n')
289 goto needquote;
290 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
291 goto needquote;
293 strbuf_add_wrapped_bytes(sb, line, len, -line_len, 1, max_length);
294 return;
296 needquote:
297 strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
298 strbuf_addf(sb, "=?%s?q?", encoding);
299 line_len += strlen(encoding) + 5; /* 5 for =??q? */
300 for (i = 0; i < len; i++) {
301 unsigned ch = line[i] & 0xFF;
302 int is_special = is_rfc2047_special(ch);
305 * According to RFC 2047, we could encode the special character
306 * ' ' (space) with '_' (underscore) for readability. But many
307 * programs do not understand this and just leave the
308 * underscore in place. Thus, we do nothing special here, which
309 * causes ' ' to be encoded as '=20', avoiding this problem.
312 if (line_len + 2 + (is_special ? 3 : 1) > max_encoded_length) {
313 strbuf_addf(sb, "?=\n =?%s?q?", encoding);
314 line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
317 if (is_special) {
318 strbuf_addf(sb, "=%02X", ch);
319 line_len += 3;
320 } else {
321 strbuf_addch(sb, ch);
322 line_len++;
325 strbuf_addstr(sb, "?=");
328 void pp_user_info(const struct pretty_print_context *pp,
329 const char *what, struct strbuf *sb,
330 const char *line, const char *encoding)
332 char *date;
333 int namelen;
334 unsigned long time;
335 int tz;
337 if (pp->fmt == CMIT_FMT_ONELINE)
338 return;
339 date = strchr(line, '>');
340 if (!date)
341 return;
342 namelen = ++date - line;
343 time = strtoul(date, &date, 10);
344 tz = strtol(date, NULL, 10);
346 if (pp->fmt == CMIT_FMT_EMAIL) {
347 char *name_tail = strchr(line, '<');
348 int display_name_length;
349 int final_line;
350 if (!name_tail)
351 return;
352 while (line < name_tail && isspace(name_tail[-1]))
353 name_tail--;
354 display_name_length = name_tail - line;
355 strbuf_addstr(sb, "From: ");
356 if (!has_rfc822_specials(line, display_name_length)) {
357 add_rfc2047(sb, line, display_name_length, encoding);
358 } else {
359 struct strbuf quoted = STRBUF_INIT;
360 add_rfc822_quoted(&quoted, line, display_name_length);
361 add_rfc2047(sb, quoted.buf, quoted.len, encoding);
362 strbuf_release(&quoted);
364 for (final_line = 0; final_line < sb->len; final_line++)
365 if (sb->buf[sb->len - final_line - 1] == '\n')
366 break;
367 if (namelen - display_name_length + final_line > 78) {
368 strbuf_addch(sb, '\n');
369 if (!isspace(name_tail[0]))
370 strbuf_addch(sb, ' ');
372 strbuf_add(sb, name_tail, namelen - display_name_length);
373 strbuf_addch(sb, '\n');
374 } else {
375 strbuf_addf(sb, "%s: %.*s%.*s\n", what,
376 (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0,
377 " ", namelen, line);
379 switch (pp->fmt) {
380 case CMIT_FMT_MEDIUM:
381 strbuf_addf(sb, "Date: %s\n", show_date(time, tz, pp->date_mode));
382 break;
383 case CMIT_FMT_EMAIL:
384 strbuf_addf(sb, "Date: %s\n", show_date(time, tz, DATE_RFC2822));
385 break;
386 case CMIT_FMT_FULLER:
387 strbuf_addf(sb, "%sDate: %s\n", what, show_date(time, tz, pp->date_mode));
388 break;
389 default:
390 /* notin' */
391 break;
395 static int is_empty_line(const char *line, int *len_p)
397 int len = *len_p;
398 while (len && isspace(line[len-1]))
399 len--;
400 *len_p = len;
401 return !len;
404 static const char *skip_empty_lines(const char *msg)
406 for (;;) {
407 int linelen = get_one_line(msg);
408 int ll = linelen;
409 if (!linelen)
410 break;
411 if (!is_empty_line(msg, &ll))
412 break;
413 msg += linelen;
415 return msg;
418 static void add_merge_info(const struct pretty_print_context *pp,
419 struct strbuf *sb, const struct commit *commit)
421 struct commit_list *parent = commit->parents;
423 if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
424 !parent || !parent->next)
425 return;
427 strbuf_addstr(sb, "Merge:");
429 while (parent) {
430 struct commit *p = parent->item;
431 const char *hex = NULL;
432 if (pp->abbrev)
433 hex = find_unique_abbrev(p->object.sha1, pp->abbrev);
434 if (!hex)
435 hex = sha1_to_hex(p->object.sha1);
436 parent = parent->next;
438 strbuf_addf(sb, " %s", hex);
440 strbuf_addch(sb, '\n');
443 static char *get_header(const struct commit *commit, const char *key)
445 int key_len = strlen(key);
446 const char *line = commit->buffer;
448 while (line) {
449 const char *eol = strchr(line, '\n'), *next;
451 if (line == eol)
452 return NULL;
453 if (!eol) {
454 warning("malformed commit (header is missing newline): %s",
455 sha1_to_hex(commit->object.sha1));
456 eol = line + strlen(line);
457 next = NULL;
458 } else
459 next = eol + 1;
460 if (eol - line > key_len &&
461 !strncmp(line, key, key_len) &&
462 line[key_len] == ' ') {
463 return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
465 line = next;
467 return NULL;
470 static char *replace_encoding_header(char *buf, const char *encoding)
472 struct strbuf tmp = STRBUF_INIT;
473 size_t start, len;
474 char *cp = buf;
476 /* guess if there is an encoding header before a \n\n */
477 while (strncmp(cp, "encoding ", strlen("encoding "))) {
478 cp = strchr(cp, '\n');
479 if (!cp || *++cp == '\n')
480 return buf;
482 start = cp - buf;
483 cp = strchr(cp, '\n');
484 if (!cp)
485 return buf; /* should not happen but be defensive */
486 len = cp + 1 - (buf + start);
488 strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
489 if (is_encoding_utf8(encoding)) {
490 /* we have re-coded to UTF-8; drop the header */
491 strbuf_remove(&tmp, start, len);
492 } else {
493 /* just replaces XXXX in 'encoding XXXX\n' */
494 strbuf_splice(&tmp, start + strlen("encoding "),
495 len - strlen("encoding \n"),
496 encoding, strlen(encoding));
498 return strbuf_detach(&tmp, NULL);
501 char *logmsg_reencode(const struct commit *commit,
502 const char *output_encoding)
504 static const char *utf8 = "UTF-8";
505 const char *use_encoding;
506 char *encoding;
507 char *out;
509 if (!*output_encoding)
510 return NULL;
511 encoding = get_header(commit, "encoding");
512 use_encoding = encoding ? encoding : utf8;
513 if (!strcmp(use_encoding, output_encoding))
514 if (encoding) /* we'll strip encoding header later */
515 out = xstrdup(commit->buffer);
516 else
517 return NULL; /* nothing to do */
518 else
519 out = reencode_string(commit->buffer,
520 output_encoding, use_encoding);
521 if (out)
522 out = replace_encoding_header(out, output_encoding);
524 free(encoding);
525 return out;
528 static int mailmap_name(char *email, int email_len, char *name, int name_len)
530 static struct string_list *mail_map;
531 if (!mail_map) {
532 mail_map = xcalloc(1, sizeof(*mail_map));
533 read_mailmap(mail_map, NULL);
535 return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
538 static size_t format_person_part(struct strbuf *sb, char part,
539 const char *msg, int len, enum date_mode dmode)
541 /* currently all placeholders have same length */
542 const int placeholder_len = 2;
543 int tz;
544 unsigned long date = 0;
545 char person_name[1024];
546 char person_mail[1024];
547 struct ident_split s;
548 const char *name_start, *name_end, *mail_start, *mail_end;
550 if (split_ident_line(&s, msg, len) < 0)
551 goto skip;
553 name_start = s.name_begin;
554 name_end = s.name_end;
555 mail_start = s.mail_begin;
556 mail_end = s.mail_end;
558 if (part == 'N' || part == 'E') { /* mailmap lookup */
559 snprintf(person_name, sizeof(person_name), "%.*s",
560 (int)(name_end - name_start), name_start);
561 snprintf(person_mail, sizeof(person_mail), "%.*s",
562 (int)(mail_end - mail_start), mail_start);
563 mailmap_name(person_mail, sizeof(person_mail), person_name, sizeof(person_name));
564 name_start = person_name;
565 name_end = name_start + strlen(person_name);
566 mail_start = person_mail;
567 mail_end = mail_start + strlen(person_mail);
569 if (part == 'n' || part == 'N') { /* name */
570 strbuf_add(sb, name_start, name_end-name_start);
571 return placeholder_len;
573 if (part == 'e' || part == 'E') { /* email */
574 strbuf_add(sb, mail_start, mail_end-mail_start);
575 return placeholder_len;
578 if (!s.date_begin)
579 goto skip;
581 date = strtoul(s.date_begin, NULL, 10);
583 if (part == 't') { /* date, UNIX timestamp */
584 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
585 return placeholder_len;
588 /* parse tz */
589 tz = strtoul(s.tz_begin + 1, NULL, 10);
590 if (*s.tz_begin == '-')
591 tz = -tz;
593 switch (part) {
594 case 'd': /* date */
595 strbuf_addstr(sb, show_date(date, tz, dmode));
596 return placeholder_len;
597 case 'D': /* date, RFC2822 style */
598 strbuf_addstr(sb, show_date(date, tz, DATE_RFC2822));
599 return placeholder_len;
600 case 'r': /* date, relative */
601 strbuf_addstr(sb, show_date(date, tz, DATE_RELATIVE));
602 return placeholder_len;
603 case 'i': /* date, ISO 8601 */
604 strbuf_addstr(sb, show_date(date, tz, DATE_ISO8601));
605 return placeholder_len;
608 skip:
610 * reading from either a bogus commit, or a reflog entry with
611 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
612 * to compute a valid return value.
614 if (part == 'n' || part == 'e' || part == 't' || part == 'd'
615 || part == 'D' || part == 'r' || part == 'i')
616 return placeholder_len;
618 return 0; /* unknown placeholder */
621 struct chunk {
622 size_t off;
623 size_t len;
626 struct format_commit_context {
627 const struct commit *commit;
628 const struct pretty_print_context *pretty_ctx;
629 unsigned commit_header_parsed:1;
630 unsigned commit_message_parsed:1;
631 unsigned commit_signature_parsed:1;
632 struct {
633 char *gpg_output;
634 char good_bad;
635 char *signer;
636 } signature;
637 char *message;
638 size_t width, indent1, indent2;
640 /* These offsets are relative to the start of the commit message. */
641 struct chunk author;
642 struct chunk committer;
643 struct chunk encoding;
644 size_t message_off;
645 size_t subject_off;
646 size_t body_off;
648 /* The following ones are relative to the result struct strbuf. */
649 struct chunk abbrev_commit_hash;
650 struct chunk abbrev_tree_hash;
651 struct chunk abbrev_parent_hashes;
652 size_t wrap_start;
655 static int add_again(struct strbuf *sb, struct chunk *chunk)
657 if (chunk->len) {
658 strbuf_adddup(sb, chunk->off, chunk->len);
659 return 1;
663 * We haven't seen this chunk before. Our caller is surely
664 * going to add it the hard way now. Remember the most likely
665 * start of the to-be-added chunk: the current end of the
666 * struct strbuf.
668 chunk->off = sb->len;
669 return 0;
672 static void parse_commit_header(struct format_commit_context *context)
674 const char *msg = context->message;
675 int i;
677 for (i = 0; msg[i]; i++) {
678 int eol;
679 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
680 ; /* do nothing */
682 if (i == eol) {
683 break;
684 } else if (!prefixcmp(msg + i, "author ")) {
685 context->author.off = i + 7;
686 context->author.len = eol - i - 7;
687 } else if (!prefixcmp(msg + i, "committer ")) {
688 context->committer.off = i + 10;
689 context->committer.len = eol - i - 10;
690 } else if (!prefixcmp(msg + i, "encoding ")) {
691 context->encoding.off = i + 9;
692 context->encoding.len = eol - i - 9;
694 i = eol;
696 context->message_off = i;
697 context->commit_header_parsed = 1;
700 static int istitlechar(char c)
702 return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
703 (c >= '0' && c <= '9') || c == '.' || c == '_';
706 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
708 size_t trimlen;
709 size_t start_len = sb->len;
710 int space = 2;
712 for (; *msg && *msg != '\n'; msg++) {
713 if (istitlechar(*msg)) {
714 if (space == 1)
715 strbuf_addch(sb, '-');
716 space = 0;
717 strbuf_addch(sb, *msg);
718 if (*msg == '.')
719 while (*(msg+1) == '.')
720 msg++;
721 } else
722 space |= 1;
725 /* trim any trailing '.' or '-' characters */
726 trimlen = 0;
727 while (sb->len - trimlen > start_len &&
728 (sb->buf[sb->len - 1 - trimlen] == '.'
729 || sb->buf[sb->len - 1 - trimlen] == '-'))
730 trimlen++;
731 strbuf_remove(sb, sb->len - trimlen, trimlen);
734 const char *format_subject(struct strbuf *sb, const char *msg,
735 const char *line_separator)
737 int first = 1;
739 for (;;) {
740 const char *line = msg;
741 int linelen = get_one_line(line);
743 msg += linelen;
744 if (!linelen || is_empty_line(line, &linelen))
745 break;
747 if (!sb)
748 continue;
749 strbuf_grow(sb, linelen + 2);
750 if (!first)
751 strbuf_addstr(sb, line_separator);
752 strbuf_add(sb, line, linelen);
753 first = 0;
755 return msg;
758 static void parse_commit_message(struct format_commit_context *c)
760 const char *msg = c->message + c->message_off;
761 const char *start = c->message;
763 msg = skip_empty_lines(msg);
764 c->subject_off = msg - start;
766 msg = format_subject(NULL, msg, NULL);
767 msg = skip_empty_lines(msg);
768 c->body_off = msg - start;
770 c->commit_message_parsed = 1;
773 static void format_decoration(struct strbuf *sb, const struct commit *commit)
775 struct name_decoration *d;
776 const char *prefix = " (";
778 load_ref_decorations(DECORATE_SHORT_REFS);
779 d = lookup_decoration(&name_decoration, &commit->object);
780 while (d) {
781 strbuf_addstr(sb, prefix);
782 prefix = ", ";
783 strbuf_addstr(sb, d->name);
784 d = d->next;
786 if (prefix[0] == ',')
787 strbuf_addch(sb, ')');
790 static void strbuf_wrap(struct strbuf *sb, size_t pos,
791 size_t width, size_t indent1, size_t indent2)
793 struct strbuf tmp = STRBUF_INIT;
795 if (pos)
796 strbuf_add(&tmp, sb->buf, pos);
797 strbuf_add_wrapped_text(&tmp, sb->buf + pos,
798 (int) indent1, (int) indent2, (int) width);
799 strbuf_swap(&tmp, sb);
800 strbuf_release(&tmp);
803 static void rewrap_message_tail(struct strbuf *sb,
804 struct format_commit_context *c,
805 size_t new_width, size_t new_indent1,
806 size_t new_indent2)
808 if (c->width == new_width && c->indent1 == new_indent1 &&
809 c->indent2 == new_indent2)
810 return;
811 if (c->wrap_start < sb->len)
812 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
813 c->wrap_start = sb->len;
814 c->width = new_width;
815 c->indent1 = new_indent1;
816 c->indent2 = new_indent2;
819 static struct {
820 char result;
821 const char *check;
822 } signature_check[] = {
823 { 'G', ": Good signature from " },
824 { 'B', ": BAD signature from " },
827 static void parse_signature_lines(struct format_commit_context *ctx)
829 const char *buf = ctx->signature.gpg_output;
830 int i;
832 for (i = 0; i < ARRAY_SIZE(signature_check); i++) {
833 const char *found = strstr(buf, signature_check[i].check);
834 const char *next;
835 if (!found)
836 continue;
837 ctx->signature.good_bad = signature_check[i].result;
838 found += strlen(signature_check[i].check);
839 next = strchrnul(found, '\n');
840 ctx->signature.signer = xmemdupz(found, next - found);
841 break;
845 static void parse_commit_signature(struct format_commit_context *ctx)
847 struct strbuf payload = STRBUF_INIT;
848 struct strbuf signature = STRBUF_INIT;
849 struct strbuf gpg_output = STRBUF_INIT;
850 int status;
852 ctx->commit_signature_parsed = 1;
854 if (parse_signed_commit(ctx->commit->object.sha1,
855 &payload, &signature) <= 0)
856 goto out;
857 status = verify_signed_buffer(payload.buf, payload.len,
858 signature.buf, signature.len,
859 &gpg_output);
860 if (status && !gpg_output.len)
861 goto out;
862 ctx->signature.gpg_output = strbuf_detach(&gpg_output, NULL);
863 parse_signature_lines(ctx);
865 out:
866 strbuf_release(&gpg_output);
867 strbuf_release(&payload);
868 strbuf_release(&signature);
872 static int format_reflog_person(struct strbuf *sb,
873 char part,
874 struct reflog_walk_info *log,
875 enum date_mode dmode)
877 const char *ident;
879 if (!log)
880 return 2;
882 ident = get_reflog_ident(log);
883 if (!ident)
884 return 2;
886 return format_person_part(sb, part, ident, strlen(ident), dmode);
889 static size_t format_commit_one(struct strbuf *sb, const char *placeholder,
890 void *context)
892 struct format_commit_context *c = context;
893 const struct commit *commit = c->commit;
894 const char *msg = c->message;
895 struct commit_list *p;
896 int h1, h2;
898 /* these are independent of the commit */
899 switch (placeholder[0]) {
900 case 'C':
901 if (placeholder[1] == '(') {
902 const char *end = strchr(placeholder + 2, ')');
903 char color[COLOR_MAXLEN];
904 if (!end)
905 return 0;
906 color_parse_mem(placeholder + 2,
907 end - (placeholder + 2),
908 "--pretty format", color);
909 strbuf_addstr(sb, color);
910 return end - placeholder + 1;
912 if (!prefixcmp(placeholder + 1, "red")) {
913 strbuf_addstr(sb, GIT_COLOR_RED);
914 return 4;
915 } else if (!prefixcmp(placeholder + 1, "green")) {
916 strbuf_addstr(sb, GIT_COLOR_GREEN);
917 return 6;
918 } else if (!prefixcmp(placeholder + 1, "blue")) {
919 strbuf_addstr(sb, GIT_COLOR_BLUE);
920 return 5;
921 } else if (!prefixcmp(placeholder + 1, "reset")) {
922 strbuf_addstr(sb, GIT_COLOR_RESET);
923 return 6;
924 } else
925 return 0;
926 case 'n': /* newline */
927 strbuf_addch(sb, '\n');
928 return 1;
929 case 'x':
930 /* %x00 == NUL, %x0a == LF, etc. */
931 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
932 h1 <= 16 &&
933 0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
934 h2 <= 16) {
935 strbuf_addch(sb, (h1<<4)|h2);
936 return 3;
937 } else
938 return 0;
939 case 'w':
940 if (placeholder[1] == '(') {
941 unsigned long width = 0, indent1 = 0, indent2 = 0;
942 char *next;
943 const char *start = placeholder + 2;
944 const char *end = strchr(start, ')');
945 if (!end)
946 return 0;
947 if (end > start) {
948 width = strtoul(start, &next, 10);
949 if (*next == ',') {
950 indent1 = strtoul(next + 1, &next, 10);
951 if (*next == ',') {
952 indent2 = strtoul(next + 1,
953 &next, 10);
956 if (*next != ')')
957 return 0;
959 rewrap_message_tail(sb, c, width, indent1, indent2);
960 return end - placeholder + 1;
961 } else
962 return 0;
965 /* these depend on the commit */
966 if (!commit->object.parsed)
967 parse_object(commit->object.sha1);
969 switch (placeholder[0]) {
970 case 'H': /* commit hash */
971 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
972 return 1;
973 case 'h': /* abbreviated commit hash */
974 if (add_again(sb, &c->abbrev_commit_hash))
975 return 1;
976 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
977 c->pretty_ctx->abbrev));
978 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
979 return 1;
980 case 'T': /* tree hash */
981 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
982 return 1;
983 case 't': /* abbreviated tree hash */
984 if (add_again(sb, &c->abbrev_tree_hash))
985 return 1;
986 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
987 c->pretty_ctx->abbrev));
988 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
989 return 1;
990 case 'P': /* parent hashes */
991 for (p = commit->parents; p; p = p->next) {
992 if (p != commit->parents)
993 strbuf_addch(sb, ' ');
994 strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
996 return 1;
997 case 'p': /* abbreviated parent hashes */
998 if (add_again(sb, &c->abbrev_parent_hashes))
999 return 1;
1000 for (p = commit->parents; p; p = p->next) {
1001 if (p != commit->parents)
1002 strbuf_addch(sb, ' ');
1003 strbuf_addstr(sb, find_unique_abbrev(
1004 p->item->object.sha1,
1005 c->pretty_ctx->abbrev));
1007 c->abbrev_parent_hashes.len = sb->len -
1008 c->abbrev_parent_hashes.off;
1009 return 1;
1010 case 'm': /* left/right/bottom */
1011 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1012 return 1;
1013 case 'd':
1014 format_decoration(sb, commit);
1015 return 1;
1016 case 'g': /* reflog info */
1017 switch(placeholder[1]) {
1018 case 'd': /* reflog selector */
1019 case 'D':
1020 if (c->pretty_ctx->reflog_info)
1021 get_reflog_selector(sb,
1022 c->pretty_ctx->reflog_info,
1023 c->pretty_ctx->date_mode,
1024 c->pretty_ctx->date_mode_explicit,
1025 (placeholder[1] == 'd'));
1026 return 2;
1027 case 's': /* reflog message */
1028 if (c->pretty_ctx->reflog_info)
1029 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1030 return 2;
1031 case 'n':
1032 case 'N':
1033 case 'e':
1034 case 'E':
1035 return format_reflog_person(sb,
1036 placeholder[1],
1037 c->pretty_ctx->reflog_info,
1038 c->pretty_ctx->date_mode);
1040 return 0; /* unknown %g placeholder */
1041 case 'N':
1042 if (c->pretty_ctx->show_notes) {
1043 format_display_notes(commit->object.sha1, sb,
1044 get_log_output_encoding(), 0);
1045 return 1;
1047 return 0;
1050 if (placeholder[0] == 'G') {
1051 if (!c->commit_signature_parsed)
1052 parse_commit_signature(c);
1053 switch (placeholder[1]) {
1054 case 'G':
1055 if (c->signature.gpg_output)
1056 strbuf_addstr(sb, c->signature.gpg_output);
1057 break;
1058 case '?':
1059 switch (c->signature.good_bad) {
1060 case 'G':
1061 case 'B':
1062 strbuf_addch(sb, c->signature.good_bad);
1064 break;
1065 case 'S':
1066 if (c->signature.signer)
1067 strbuf_addstr(sb, c->signature.signer);
1068 break;
1070 return 2;
1074 /* For the rest we have to parse the commit header. */
1075 if (!c->commit_header_parsed)
1076 parse_commit_header(c);
1078 switch (placeholder[0]) {
1079 case 'a': /* author ... */
1080 return format_person_part(sb, placeholder[1],
1081 msg + c->author.off, c->author.len,
1082 c->pretty_ctx->date_mode);
1083 case 'c': /* committer ... */
1084 return format_person_part(sb, placeholder[1],
1085 msg + c->committer.off, c->committer.len,
1086 c->pretty_ctx->date_mode);
1087 case 'e': /* encoding */
1088 strbuf_add(sb, msg + c->encoding.off, c->encoding.len);
1089 return 1;
1090 case 'B': /* raw body */
1091 /* message_off is always left at the initial newline */
1092 strbuf_addstr(sb, msg + c->message_off + 1);
1093 return 1;
1096 /* Now we need to parse the commit message. */
1097 if (!c->commit_message_parsed)
1098 parse_commit_message(c);
1100 switch (placeholder[0]) {
1101 case 's': /* subject */
1102 format_subject(sb, msg + c->subject_off, " ");
1103 return 1;
1104 case 'f': /* sanitized subject */
1105 format_sanitized_subject(sb, msg + c->subject_off);
1106 return 1;
1107 case 'b': /* body */
1108 strbuf_addstr(sb, msg + c->body_off);
1109 return 1;
1111 return 0; /* unknown placeholder */
1114 static size_t format_commit_item(struct strbuf *sb, const char *placeholder,
1115 void *context)
1117 int consumed;
1118 size_t orig_len;
1119 enum {
1120 NO_MAGIC,
1121 ADD_LF_BEFORE_NON_EMPTY,
1122 DEL_LF_BEFORE_EMPTY,
1123 ADD_SP_BEFORE_NON_EMPTY
1124 } magic = NO_MAGIC;
1126 switch (placeholder[0]) {
1127 case '-':
1128 magic = DEL_LF_BEFORE_EMPTY;
1129 break;
1130 case '+':
1131 magic = ADD_LF_BEFORE_NON_EMPTY;
1132 break;
1133 case ' ':
1134 magic = ADD_SP_BEFORE_NON_EMPTY;
1135 break;
1136 default:
1137 break;
1139 if (magic != NO_MAGIC)
1140 placeholder++;
1142 orig_len = sb->len;
1143 consumed = format_commit_one(sb, placeholder, context);
1144 if (magic == NO_MAGIC)
1145 return consumed;
1147 if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1148 while (sb->len && sb->buf[sb->len - 1] == '\n')
1149 strbuf_setlen(sb, sb->len - 1);
1150 } else if (orig_len != sb->len) {
1151 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1152 strbuf_insert(sb, orig_len, "\n", 1);
1153 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1154 strbuf_insert(sb, orig_len, " ", 1);
1156 return consumed + 1;
1159 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1160 void *context)
1162 struct userformat_want *w = context;
1164 if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1165 placeholder++;
1167 switch (*placeholder) {
1168 case 'N':
1169 w->notes = 1;
1170 break;
1172 return 0;
1175 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1177 struct strbuf dummy = STRBUF_INIT;
1179 if (!fmt) {
1180 if (!user_format)
1181 return;
1182 fmt = user_format;
1184 strbuf_expand(&dummy, fmt, userformat_want_item, w);
1185 strbuf_release(&dummy);
1188 void format_commit_message(const struct commit *commit,
1189 const char *format, struct strbuf *sb,
1190 const struct pretty_print_context *pretty_ctx)
1192 struct format_commit_context context;
1193 static const char utf8[] = "UTF-8";
1194 const char *output_enc = pretty_ctx->output_encoding;
1196 memset(&context, 0, sizeof(context));
1197 context.commit = commit;
1198 context.pretty_ctx = pretty_ctx;
1199 context.wrap_start = sb->len;
1200 context.message = commit->buffer;
1201 if (output_enc) {
1202 char *enc = get_header(commit, "encoding");
1203 if (strcmp(enc ? enc : utf8, output_enc)) {
1204 context.message = logmsg_reencode(commit, output_enc);
1205 if (!context.message)
1206 context.message = commit->buffer;
1208 free(enc);
1211 strbuf_expand(sb, format, format_commit_item, &context);
1212 rewrap_message_tail(sb, &context, 0, 0, 0);
1214 if (context.message != commit->buffer)
1215 free(context.message);
1216 free(context.signature.gpg_output);
1217 free(context.signature.signer);
1220 static void pp_header(const struct pretty_print_context *pp,
1221 const char *encoding,
1222 const struct commit *commit,
1223 const char **msg_p,
1224 struct strbuf *sb)
1226 int parents_shown = 0;
1228 for (;;) {
1229 const char *line = *msg_p;
1230 int linelen = get_one_line(*msg_p);
1232 if (!linelen)
1233 return;
1234 *msg_p += linelen;
1236 if (linelen == 1)
1237 /* End of header */
1238 return;
1240 if (pp->fmt == CMIT_FMT_RAW) {
1241 strbuf_add(sb, line, linelen);
1242 continue;
1245 if (!memcmp(line, "parent ", 7)) {
1246 if (linelen != 48)
1247 die("bad parent line in commit");
1248 continue;
1251 if (!parents_shown) {
1252 struct commit_list *parent;
1253 int num;
1254 for (parent = commit->parents, num = 0;
1255 parent;
1256 parent = parent->next, num++)
1258 /* with enough slop */
1259 strbuf_grow(sb, num * 50 + 20);
1260 add_merge_info(pp, sb, commit);
1261 parents_shown = 1;
1265 * MEDIUM == DEFAULT shows only author with dates.
1266 * FULL shows both authors but not dates.
1267 * FULLER shows both authors and dates.
1269 if (!memcmp(line, "author ", 7)) {
1270 strbuf_grow(sb, linelen + 80);
1271 pp_user_info(pp, "Author", sb, line + 7, encoding);
1273 if (!memcmp(line, "committer ", 10) &&
1274 (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1275 strbuf_grow(sb, linelen + 80);
1276 pp_user_info(pp, "Commit", sb, line + 10, encoding);
1281 void pp_title_line(const struct pretty_print_context *pp,
1282 const char **msg_p,
1283 struct strbuf *sb,
1284 const char *encoding,
1285 int need_8bit_cte)
1287 struct strbuf title;
1289 strbuf_init(&title, 80);
1290 *msg_p = format_subject(&title, *msg_p,
1291 pp->preserve_subject ? "\n" : " ");
1293 strbuf_grow(sb, title.len + 1024);
1294 if (pp->subject) {
1295 strbuf_addstr(sb, pp->subject);
1296 add_rfc2047(sb, title.buf, title.len, encoding);
1297 } else {
1298 strbuf_addbuf(sb, &title);
1300 strbuf_addch(sb, '\n');
1302 if (need_8bit_cte > 0) {
1303 const char *header_fmt =
1304 "MIME-Version: 1.0\n"
1305 "Content-Type: text/plain; charset=%s\n"
1306 "Content-Transfer-Encoding: 8bit\n";
1307 strbuf_addf(sb, header_fmt, encoding);
1309 if (pp->after_subject) {
1310 strbuf_addstr(sb, pp->after_subject);
1312 if (pp->fmt == CMIT_FMT_EMAIL) {
1313 strbuf_addch(sb, '\n');
1315 strbuf_release(&title);
1318 void pp_remainder(const struct pretty_print_context *pp,
1319 const char **msg_p,
1320 struct strbuf *sb,
1321 int indent)
1323 int first = 1;
1324 for (;;) {
1325 const char *line = *msg_p;
1326 int linelen = get_one_line(line);
1327 *msg_p += linelen;
1329 if (!linelen)
1330 break;
1332 if (is_empty_line(line, &linelen)) {
1333 if (first)
1334 continue;
1335 if (pp->fmt == CMIT_FMT_SHORT)
1336 break;
1338 first = 0;
1340 strbuf_grow(sb, linelen + indent + 20);
1341 if (indent) {
1342 memset(sb->buf + sb->len, ' ', indent);
1343 strbuf_setlen(sb, sb->len + indent);
1345 strbuf_add(sb, line, linelen);
1346 strbuf_addch(sb, '\n');
1350 char *reencode_commit_message(const struct commit *commit, const char **encoding_p)
1352 const char *encoding;
1354 encoding = get_log_output_encoding();
1355 if (encoding_p)
1356 *encoding_p = encoding;
1357 return logmsg_reencode(commit, encoding);
1360 void pretty_print_commit(const struct pretty_print_context *pp,
1361 const struct commit *commit,
1362 struct strbuf *sb)
1364 unsigned long beginning_of_body;
1365 int indent = 4;
1366 const char *msg = commit->buffer;
1367 char *reencoded;
1368 const char *encoding;
1369 int need_8bit_cte = pp->need_8bit_cte;
1371 if (pp->fmt == CMIT_FMT_USERFORMAT) {
1372 format_commit_message(commit, user_format, sb, pp);
1373 return;
1376 reencoded = reencode_commit_message(commit, &encoding);
1377 if (reencoded) {
1378 msg = reencoded;
1381 if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1382 indent = 0;
1385 * We need to check and emit Content-type: to mark it
1386 * as 8-bit if we haven't done so.
1388 if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1389 int i, ch, in_body;
1391 for (in_body = i = 0; (ch = msg[i]); i++) {
1392 if (!in_body) {
1393 /* author could be non 7-bit ASCII but
1394 * the log may be so; skip over the
1395 * header part first.
1397 if (ch == '\n' && msg[i+1] == '\n')
1398 in_body = 1;
1400 else if (non_ascii(ch)) {
1401 need_8bit_cte = 1;
1402 break;
1407 pp_header(pp, encoding, commit, &msg, sb);
1408 if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1409 strbuf_addch(sb, '\n');
1412 /* Skip excess blank lines at the beginning of body, if any... */
1413 msg = skip_empty_lines(msg);
1415 /* These formats treat the title line specially. */
1416 if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1417 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1419 beginning_of_body = sb->len;
1420 if (pp->fmt != CMIT_FMT_ONELINE)
1421 pp_remainder(pp, &msg, sb, indent);
1422 strbuf_rtrim(sb);
1424 /* Make sure there is an EOLN for the non-oneline case */
1425 if (pp->fmt != CMIT_FMT_ONELINE)
1426 strbuf_addch(sb, '\n');
1429 * The caller may append additional body text in e-mail
1430 * format. Make sure we did not strip the blank line
1431 * between the header and the body.
1433 if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1434 strbuf_addch(sb, '\n');
1436 if (pp->show_notes)
1437 format_display_notes(commit->object.sha1, sb, encoding,
1438 NOTES_SHOW_HEADER | NOTES_INDENT);
1440 free(reencoded);
1443 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1444 struct strbuf *sb)
1446 struct pretty_print_context pp = {0};
1447 pp.fmt = fmt;
1448 pretty_print_commit(&pp, commit, sb);