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