use strchrnul() in place of strchr() and strlen()
[git] / pretty.c
1 #include "cache.h"
2 #include "commit.h"
3 #include "utf8.h"
4 #include "diff.h"
5 #include "revision.h"
6 #include "string-list.h"
7 #include "mailmap.h"
8 #include "log-tree.h"
9 #include "notes.h"
10 #include "color.h"
11 #include "reflog-walk.h"
12 #include "gpg-interface.h"
13
14 static char *user_format;
15 static struct cmt_fmt_map {
16         const char *name;
17         enum cmit_fmt format;
18         int is_tformat;
19         int is_alias;
20         const char *user_format;
21 } *commit_formats;
22 static size_t builtin_formats_len;
23 static size_t commit_formats_len;
24 static size_t commit_formats_alloc;
25 static struct cmt_fmt_map *find_commit_format(const char *sought);
26
27 static void save_user_format(struct rev_info *rev, const char *cp, int is_tformat)
28 {
29         free(user_format);
30         user_format = xstrdup(cp);
31         if (is_tformat)
32                 rev->use_terminator = 1;
33         rev->commit_format = CMIT_FMT_USERFORMAT;
34 }
35
36 static int git_pretty_formats_config(const char *var, const char *value, void *cb)
37 {
38         struct cmt_fmt_map *commit_format = NULL;
39         const char *name;
40         const char *fmt;
41         int i;
42
43         if (!starts_with(var, "pretty."))
44                 return 0;
45
46         name = var + strlen("pretty.");
47         for (i = 0; i < builtin_formats_len; i++) {
48                 if (!strcmp(commit_formats[i].name, name))
49                         return 0;
50         }
51
52         for (i = builtin_formats_len; i < commit_formats_len; i++) {
53                 if (!strcmp(commit_formats[i].name, name)) {
54                         commit_format = &commit_formats[i];
55                         break;
56                 }
57         }
58
59         if (!commit_format) {
60                 ALLOC_GROW(commit_formats, commit_formats_len+1,
61                            commit_formats_alloc);
62                 commit_format = &commit_formats[commit_formats_len];
63                 memset(commit_format, 0, sizeof(*commit_format));
64                 commit_formats_len++;
65         }
66
67         commit_format->name = xstrdup(name);
68         commit_format->format = CMIT_FMT_USERFORMAT;
69         git_config_string(&fmt, var, value);
70         if (starts_with(fmt, "format:") || starts_with(fmt, "tformat:")) {
71                 commit_format->is_tformat = fmt[0] == 't';
72                 fmt = strchr(fmt, ':') + 1;
73         } else if (strchr(fmt, '%'))
74                 commit_format->is_tformat = 1;
75         else
76                 commit_format->is_alias = 1;
77         commit_format->user_format = fmt;
78
79         return 0;
80 }
81
82 static void setup_commit_formats(void)
83 {
84         struct cmt_fmt_map builtin_formats[] = {
85                 { "raw",        CMIT_FMT_RAW,           0 },
86                 { "medium",     CMIT_FMT_MEDIUM,        0 },
87                 { "short",      CMIT_FMT_SHORT,         0 },
88                 { "email",      CMIT_FMT_EMAIL,         0 },
89                 { "fuller",     CMIT_FMT_FULLER,        0 },
90                 { "full",       CMIT_FMT_FULL,          0 },
91                 { "oneline",    CMIT_FMT_ONELINE,       1 }
92         };
93         commit_formats_len = ARRAY_SIZE(builtin_formats);
94         builtin_formats_len = commit_formats_len;
95         ALLOC_GROW(commit_formats, commit_formats_len, commit_formats_alloc);
96         memcpy(commit_formats, builtin_formats,
97                sizeof(*builtin_formats)*ARRAY_SIZE(builtin_formats));
98
99         git_config(git_pretty_formats_config, NULL);
100 }
101
102 static struct cmt_fmt_map *find_commit_format_recursive(const char *sought,
103                                                         const char *original,
104                                                         int num_redirections)
105 {
106         struct cmt_fmt_map *found = NULL;
107         size_t found_match_len = 0;
108         int i;
109
110         if (num_redirections >= commit_formats_len)
111                 die("invalid --pretty format: "
112                     "'%s' references an alias which points to itself",
113                     original);
114
115         for (i = 0; i < commit_formats_len; i++) {
116                 size_t match_len;
117
118                 if (!starts_with(commit_formats[i].name, sought))
119                         continue;
120
121                 match_len = strlen(commit_formats[i].name);
122                 if (found == NULL || found_match_len > match_len) {
123                         found = &commit_formats[i];
124                         found_match_len = match_len;
125                 }
126         }
127
128         if (found && found->is_alias) {
129                 found = find_commit_format_recursive(found->user_format,
130                                                      original,
131                                                      num_redirections+1);
132         }
133
134         return found;
135 }
136
137 static struct cmt_fmt_map *find_commit_format(const char *sought)
138 {
139         if (!commit_formats)
140                 setup_commit_formats();
141
142         return find_commit_format_recursive(sought, sought, 0);
143 }
144
145 void get_commit_format(const char *arg, struct rev_info *rev)
146 {
147         struct cmt_fmt_map *commit_format;
148
149         rev->use_terminator = 0;
150         if (!arg || !*arg) {
151                 rev->commit_format = CMIT_FMT_DEFAULT;
152                 return;
153         }
154         if (starts_with(arg, "format:") || starts_with(arg, "tformat:")) {
155                 save_user_format(rev, strchr(arg, ':') + 1, arg[0] == 't');
156                 return;
157         }
158
159         if (strchr(arg, '%')) {
160                 save_user_format(rev, arg, 1);
161                 return;
162         }
163
164         commit_format = find_commit_format(arg);
165         if (!commit_format)
166                 die("invalid --pretty format: %s", arg);
167
168         rev->commit_format = commit_format->format;
169         rev->use_terminator = commit_format->is_tformat;
170         if (commit_format->format == CMIT_FMT_USERFORMAT) {
171                 save_user_format(rev, commit_format->user_format,
172                                  commit_format->is_tformat);
173         }
174 }
175
176 /*
177  * Generic support for pretty-printing the header
178  */
179 static int get_one_line(const char *msg)
180 {
181         int ret = 0;
182
183         for (;;) {
184                 char c = *msg++;
185                 if (!c)
186                         break;
187                 ret++;
188                 if (c == '\n')
189                         break;
190         }
191         return ret;
192 }
193
194 /* High bit set, or ISO-2022-INT */
195 static int non_ascii(int ch)
196 {
197         return !isascii(ch) || ch == '\033';
198 }
199
200 int has_non_ascii(const char *s)
201 {
202         int ch;
203         if (!s)
204                 return 0;
205         while ((ch = *s++) != '\0') {
206                 if (non_ascii(ch))
207                         return 1;
208         }
209         return 0;
210 }
211
212 static int is_rfc822_special(char ch)
213 {
214         switch (ch) {
215         case '(':
216         case ')':
217         case '<':
218         case '>':
219         case '[':
220         case ']':
221         case ':':
222         case ';':
223         case '@':
224         case ',':
225         case '.':
226         case '"':
227         case '\\':
228                 return 1;
229         default:
230                 return 0;
231         }
232 }
233
234 static int needs_rfc822_quoting(const char *s, int len)
235 {
236         int i;
237         for (i = 0; i < len; i++)
238                 if (is_rfc822_special(s[i]))
239                         return 1;
240         return 0;
241 }
242
243 static 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
254 static 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
275 enum rfc2047_type {
276         RFC2047_SUBJECT,
277         RFC2047_ADDRESS,
278 };
279
280 static int is_rfc2047_special(char ch, enum rfc2047_type type)
281 {
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 == '_')
306                 return 1;
307
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 == '/');
330 }
331
332 static int needs_rfc2047_encoding(const char *line, int len,
333                                   enum rfc2047_type type)
334 {
335         int i;
336
337         for (i = 0; i < len; i++) {
338                 int ch = line[i];
339                 if (non_ascii(ch) || ch == '\n')
340                         return 1;
341                 if ((i + 1 < len) && (ch == '=' && line[i+1] == '?'))
342                         return 1;
343         }
344
345         return 0;
346 }
347
348 static void add_rfc2047(struct strbuf *sb, const char *line, size_t 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
355         strbuf_grow(sb, len * 3 + strlen(encoding) + 100);
356         strbuf_addf(sb, "=?%s?q?", encoding);
357         line_len += strlen(encoding) + 5; /* 5 for =??q? */
358
359         while (len) {
360                 /*
361                  * RFC 2047, section 5 (3):
362                  *
363                  * Each 'encoded-word' MUST represent an integral number of
364                  * characters.  A multi-octet character may not be split across
365                  * adjacent 'encoded- word's.
366                  */
367                 const unsigned char *p = (const unsigned char *)line;
368                 int chrlen = mbs_chrlen(&line, &len, encoding);
369                 int is_special = (chrlen > 1) || is_rfc2047_special(*p, type);
370
371                 /* "=%02X" * chrlen, or the byte itself */
372                 const char *encoded_fmt = is_special ? "=%02X"    : "%c";
373                 int         encoded_len = is_special ? 3 * chrlen : 1;
374
375                 /*
376                  * According to RFC 2047, we could encode the special character
377                  * ' ' (space) with '_' (underscore) for readability. But many
378                  * programs do not understand this and just leave the
379                  * underscore in place. Thus, we do nothing special here, which
380                  * causes ' ' to be encoded as '=20', avoiding this problem.
381                  */
382
383                 if (line_len + encoded_len + 2 > max_encoded_length) {
384                         /* It won't fit with trailing "?=" --- break the line */
385                         strbuf_addf(sb, "?=\n =?%s?q?", encoding);
386                         line_len = strlen(encoding) + 5 + 1; /* =??q? plus SP */
387                 }
388
389                 for (i = 0; i < chrlen; i++)
390                         strbuf_addf(sb, encoded_fmt, p[i]);
391                 line_len += encoded_len;
392         }
393         strbuf_addstr(sb, "?=");
394 }
395
396 static const char *show_ident_date(const struct ident_split *ident,
397                                    enum date_mode mode)
398 {
399         unsigned long date = 0;
400         int tz = 0;
401
402         if (ident->date_begin && ident->date_end)
403                 date = strtoul(ident->date_begin, NULL, 10);
404         if (ident->tz_begin && ident->tz_end)
405                 tz = strtol(ident->tz_begin, NULL, 10);
406         return show_date(date, tz, mode);
407 }
408
409 void pp_user_info(struct pretty_print_context *pp,
410                   const char *what, struct strbuf *sb,
411                   const char *line, const char *encoding)
412 {
413         struct ident_split ident;
414         char *line_end;
415         const char *mailbuf, *namebuf;
416         size_t namelen, maillen;
417         int max_length = 78; /* per rfc2822 */
418
419         if (pp->fmt == CMIT_FMT_ONELINE)
420                 return;
421
422         line_end = strchrnul(line, '\n');
423         if (split_ident_line(&ident, line, line_end - line))
424                 return;
425
426         mailbuf = ident.mail_begin;
427         maillen = ident.mail_end - ident.mail_begin;
428         namebuf = ident.name_begin;
429         namelen = ident.name_end - ident.name_begin;
430
431         if (pp->mailmap)
432                 map_user(pp->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
433
434         if (pp->fmt == CMIT_FMT_EMAIL) {
435                 if (pp->from_ident && ident_cmp(pp->from_ident, &ident)) {
436                         struct strbuf buf = STRBUF_INIT;
437
438                         strbuf_addstr(&buf, "From: ");
439                         strbuf_add(&buf, namebuf, namelen);
440                         strbuf_addstr(&buf, " <");
441                         strbuf_add(&buf, mailbuf, maillen);
442                         strbuf_addstr(&buf, ">\n");
443                         string_list_append(&pp->in_body_headers,
444                                            strbuf_detach(&buf, NULL));
445
446                         mailbuf = pp->from_ident->mail_begin;
447                         maillen = pp->from_ident->mail_end - mailbuf;
448                         namebuf = pp->from_ident->name_begin;
449                         namelen = pp->from_ident->name_end - namebuf;
450                 }
451
452                 strbuf_addstr(sb, "From: ");
453                 if (needs_rfc2047_encoding(namebuf, namelen, RFC2047_ADDRESS)) {
454                         add_rfc2047(sb, namebuf, namelen,
455                                     encoding, RFC2047_ADDRESS);
456                         max_length = 76; /* per rfc2047 */
457                 } else if (needs_rfc822_quoting(namebuf, namelen)) {
458                         struct strbuf quoted = STRBUF_INIT;
459                         add_rfc822_quoted(&quoted, namebuf, namelen);
460                         strbuf_add_wrapped_bytes(sb, quoted.buf, quoted.len,
461                                                         -6, 1, max_length);
462                         strbuf_release(&quoted);
463                 } else {
464                         strbuf_add_wrapped_bytes(sb, namebuf, namelen,
465                                                  -6, 1, max_length);
466                 }
467
468                 if (max_length <
469                     last_line_length(sb) + strlen(" <") + maillen + strlen(">"))
470                         strbuf_addch(sb, '\n');
471                 strbuf_addf(sb, " <%.*s>\n", (int)maillen, mailbuf);
472         } else {
473                 strbuf_addf(sb, "%s: %.*s%.*s <%.*s>\n", what,
474                             (pp->fmt == CMIT_FMT_FULLER) ? 4 : 0, "    ",
475                             (int)namelen, namebuf, (int)maillen, mailbuf);
476         }
477
478         switch (pp->fmt) {
479         case CMIT_FMT_MEDIUM:
480                 strbuf_addf(sb, "Date:   %s\n",
481                             show_ident_date(&ident, pp->date_mode));
482                 break;
483         case CMIT_FMT_EMAIL:
484                 strbuf_addf(sb, "Date: %s\n",
485                             show_ident_date(&ident, DATE_RFC2822));
486                 break;
487         case CMIT_FMT_FULLER:
488                 strbuf_addf(sb, "%sDate: %s\n", what,
489                             show_ident_date(&ident, pp->date_mode));
490                 break;
491         default:
492                 /* notin' */
493                 break;
494         }
495 }
496
497 static int is_empty_line(const char *line, int *len_p)
498 {
499         int len = *len_p;
500         while (len && isspace(line[len - 1]))
501                 len--;
502         *len_p = len;
503         return !len;
504 }
505
506 static const char *skip_empty_lines(const char *msg)
507 {
508         for (;;) {
509                 int linelen = get_one_line(msg);
510                 int ll = linelen;
511                 if (!linelen)
512                         break;
513                 if (!is_empty_line(msg, &ll))
514                         break;
515                 msg += linelen;
516         }
517         return msg;
518 }
519
520 static void add_merge_info(const struct pretty_print_context *pp,
521                            struct strbuf *sb, const struct commit *commit)
522 {
523         struct commit_list *parent = commit->parents;
524
525         if ((pp->fmt == CMIT_FMT_ONELINE) || (pp->fmt == CMIT_FMT_EMAIL) ||
526             !parent || !parent->next)
527                 return;
528
529         strbuf_addstr(sb, "Merge:");
530
531         while (parent) {
532                 struct commit *p = parent->item;
533                 const char *hex = NULL;
534                 if (pp->abbrev)
535                         hex = find_unique_abbrev(p->object.sha1, pp->abbrev);
536                 if (!hex)
537                         hex = sha1_to_hex(p->object.sha1);
538                 parent = parent->next;
539
540                 strbuf_addf(sb, " %s", hex);
541         }
542         strbuf_addch(sb, '\n');
543 }
544
545 static char *get_header(const struct commit *commit, const char *msg,
546                         const char *key)
547 {
548         int key_len = strlen(key);
549         const char *line = msg;
550
551         while (line) {
552                 const char *eol = strchrnul(line, '\n'), *next;
553
554                 if (line == eol)
555                         return NULL;
556                 if (!*eol) {
557                         warning("malformed commit (header is missing newline): %s",
558                                 sha1_to_hex(commit->object.sha1));
559                         next = NULL;
560                 } else
561                         next = eol + 1;
562                 if (eol - line > key_len &&
563                     !strncmp(line, key, key_len) &&
564                     line[key_len] == ' ') {
565                         return xmemdupz(line + key_len + 1, eol - line - key_len - 1);
566                 }
567                 line = next;
568         }
569         return NULL;
570 }
571
572 static char *replace_encoding_header(char *buf, const char *encoding)
573 {
574         struct strbuf tmp = STRBUF_INIT;
575         size_t start, len;
576         char *cp = buf;
577
578         /* guess if there is an encoding header before a \n\n */
579         while (strncmp(cp, "encoding ", strlen("encoding "))) {
580                 cp = strchr(cp, '\n');
581                 if (!cp || *++cp == '\n')
582                         return buf;
583         }
584         start = cp - buf;
585         cp = strchr(cp, '\n');
586         if (!cp)
587                 return buf; /* should not happen but be defensive */
588         len = cp + 1 - (buf + start);
589
590         strbuf_attach(&tmp, buf, strlen(buf), strlen(buf) + 1);
591         if (is_encoding_utf8(encoding)) {
592                 /* we have re-coded to UTF-8; drop the header */
593                 strbuf_remove(&tmp, start, len);
594         } else {
595                 /* just replaces XXXX in 'encoding XXXX\n' */
596                 strbuf_splice(&tmp, start + strlen("encoding "),
597                                           len - strlen("encoding \n"),
598                                           encoding, strlen(encoding));
599         }
600         return strbuf_detach(&tmp, NULL);
601 }
602
603 char *logmsg_reencode(const struct commit *commit,
604                       char **commit_encoding,
605                       const char *output_encoding)
606 {
607         static const char *utf8 = "UTF-8";
608         const char *use_encoding;
609         char *encoding;
610         char *msg = commit->buffer;
611         char *out;
612
613         if (!msg) {
614                 enum object_type type;
615                 unsigned long size;
616
617                 msg = read_sha1_file(commit->object.sha1, &type, &size);
618                 if (!msg)
619                         die("Cannot read commit object %s",
620                             sha1_to_hex(commit->object.sha1));
621                 if (type != OBJ_COMMIT)
622                         die("Expected commit for '%s', got %s",
623                             sha1_to_hex(commit->object.sha1), typename(type));
624         }
625
626         if (!output_encoding || !*output_encoding) {
627                 if (commit_encoding)
628                         *commit_encoding =
629                                 get_header(commit, msg, "encoding");
630                 return msg;
631         }
632         encoding = get_header(commit, msg, "encoding");
633         if (commit_encoding)
634                 *commit_encoding = encoding;
635         use_encoding = encoding ? encoding : utf8;
636         if (same_encoding(use_encoding, output_encoding)) {
637                 /*
638                  * No encoding work to be done. If we have no encoding header
639                  * at all, then there's nothing to do, and we can return the
640                  * message verbatim (whether newly allocated or not).
641                  */
642                 if (!encoding)
643                         return msg;
644
645                 /*
646                  * Otherwise, we still want to munge the encoding header in the
647                  * result, which will be done by modifying the buffer. If we
648                  * are using a fresh copy, we can reuse it. But if we are using
649                  * the cached copy from commit->buffer, we need to duplicate it
650                  * to avoid munging commit->buffer.
651                  */
652                 out = msg;
653                 if (out == commit->buffer)
654                         out = xstrdup(out);
655         }
656         else {
657                 /*
658                  * There's actual encoding work to do. Do the reencoding, which
659                  * still leaves the header to be replaced in the next step. At
660                  * this point, we are done with msg. If we allocated a fresh
661                  * copy, we can free it.
662                  */
663                 out = reencode_string(msg, output_encoding, use_encoding);
664                 if (out && msg != commit->buffer)
665                         free(msg);
666         }
667
668         /*
669          * This replacement actually consumes the buffer we hand it, so we do
670          * not have to worry about freeing the old "out" here.
671          */
672         if (out)
673                 out = replace_encoding_header(out, output_encoding);
674
675         if (!commit_encoding)
676                 free(encoding);
677         /*
678          * If the re-encoding failed, out might be NULL here; in that
679          * case we just return the commit message verbatim.
680          */
681         return out ? out : msg;
682 }
683
684 void logmsg_free(char *msg, const struct commit *commit)
685 {
686         if (msg != commit->buffer)
687                 free(msg);
688 }
689
690 static int mailmap_name(const char **email, size_t *email_len,
691                         const char **name, size_t *name_len)
692 {
693         static struct string_list *mail_map;
694         if (!mail_map) {
695                 mail_map = xcalloc(1, sizeof(*mail_map));
696                 read_mailmap(mail_map, NULL);
697         }
698         return mail_map->nr && map_user(mail_map, email, email_len, name, name_len);
699 }
700
701 static size_t format_person_part(struct strbuf *sb, char part,
702                                  const char *msg, int len, enum date_mode dmode)
703 {
704         /* currently all placeholders have same length */
705         const int placeholder_len = 2;
706         struct ident_split s;
707         const char *name, *mail;
708         size_t maillen, namelen;
709
710         if (split_ident_line(&s, msg, len) < 0)
711                 goto skip;
712
713         name = s.name_begin;
714         namelen = s.name_end - s.name_begin;
715         mail = s.mail_begin;
716         maillen = s.mail_end - s.mail_begin;
717
718         if (part == 'N' || part == 'E') /* mailmap lookup */
719                 mailmap_name(&mail, &maillen, &name, &namelen);
720         if (part == 'n' || part == 'N') {       /* name */
721                 strbuf_add(sb, name, namelen);
722                 return placeholder_len;
723         }
724         if (part == 'e' || part == 'E') {       /* email */
725                 strbuf_add(sb, mail, maillen);
726                 return placeholder_len;
727         }
728
729         if (!s.date_begin)
730                 goto skip;
731
732         if (part == 't') {      /* date, UNIX timestamp */
733                 strbuf_add(sb, s.date_begin, s.date_end - s.date_begin);
734                 return placeholder_len;
735         }
736
737         switch (part) {
738         case 'd':       /* date */
739                 strbuf_addstr(sb, show_ident_date(&s, dmode));
740                 return placeholder_len;
741         case 'D':       /* date, RFC2822 style */
742                 strbuf_addstr(sb, show_ident_date(&s, DATE_RFC2822));
743                 return placeholder_len;
744         case 'r':       /* date, relative */
745                 strbuf_addstr(sb, show_ident_date(&s, DATE_RELATIVE));
746                 return placeholder_len;
747         case 'i':       /* date, ISO 8601 */
748                 strbuf_addstr(sb, show_ident_date(&s, DATE_ISO8601));
749                 return placeholder_len;
750         }
751
752 skip:
753         /*
754          * reading from either a bogus commit, or a reflog entry with
755          * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
756          * to compute a valid return value.
757          */
758         if (part == 'n' || part == 'e' || part == 't' || part == 'd'
759             || part == 'D' || part == 'r' || part == 'i')
760                 return placeholder_len;
761
762         return 0; /* unknown placeholder */
763 }
764
765 struct chunk {
766         size_t off;
767         size_t len;
768 };
769
770 enum flush_type {
771         no_flush,
772         flush_right,
773         flush_left,
774         flush_left_and_steal,
775         flush_both
776 };
777
778 enum trunc_type {
779         trunc_none,
780         trunc_left,
781         trunc_middle,
782         trunc_right
783 };
784
785 struct format_commit_context {
786         const struct commit *commit;
787         const struct pretty_print_context *pretty_ctx;
788         unsigned commit_header_parsed:1;
789         unsigned commit_message_parsed:1;
790         struct signature_check signature_check;
791         enum flush_type flush_type;
792         enum trunc_type truncate;
793         char *message;
794         char *commit_encoding;
795         size_t width, indent1, indent2;
796         int auto_color;
797         int padding;
798
799         /* These offsets are relative to the start of the commit message. */
800         struct chunk author;
801         struct chunk committer;
802         size_t message_off;
803         size_t subject_off;
804         size_t body_off;
805
806         /* The following ones are relative to the result struct strbuf. */
807         struct chunk abbrev_commit_hash;
808         struct chunk abbrev_tree_hash;
809         struct chunk abbrev_parent_hashes;
810         size_t wrap_start;
811 };
812
813 static int add_again(struct strbuf *sb, struct chunk *chunk)
814 {
815         if (chunk->len) {
816                 strbuf_adddup(sb, chunk->off, chunk->len);
817                 return 1;
818         }
819
820         /*
821          * We haven't seen this chunk before.  Our caller is surely
822          * going to add it the hard way now.  Remember the most likely
823          * start of the to-be-added chunk: the current end of the
824          * struct strbuf.
825          */
826         chunk->off = sb->len;
827         return 0;
828 }
829
830 static void parse_commit_header(struct format_commit_context *context)
831 {
832         const char *msg = context->message;
833         int i;
834
835         for (i = 0; msg[i]; i++) {
836                 int eol;
837                 for (eol = i; msg[eol] && msg[eol] != '\n'; eol++)
838                         ; /* do nothing */
839
840                 if (i == eol) {
841                         break;
842                 } else if (starts_with(msg + i, "author ")) {
843                         context->author.off = i + 7;
844                         context->author.len = eol - i - 7;
845                 } else if (starts_with(msg + i, "committer ")) {
846                         context->committer.off = i + 10;
847                         context->committer.len = eol - i - 10;
848                 }
849                 i = eol;
850         }
851         context->message_off = i;
852         context->commit_header_parsed = 1;
853 }
854
855 static int istitlechar(char c)
856 {
857         return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
858                 (c >= '0' && c <= '9') || c == '.' || c == '_';
859 }
860
861 static void format_sanitized_subject(struct strbuf *sb, const char *msg)
862 {
863         size_t trimlen;
864         size_t start_len = sb->len;
865         int space = 2;
866
867         for (; *msg && *msg != '\n'; msg++) {
868                 if (istitlechar(*msg)) {
869                         if (space == 1)
870                                 strbuf_addch(sb, '-');
871                         space = 0;
872                         strbuf_addch(sb, *msg);
873                         if (*msg == '.')
874                                 while (*(msg+1) == '.')
875                                         msg++;
876                 } else
877                         space |= 1;
878         }
879
880         /* trim any trailing '.' or '-' characters */
881         trimlen = 0;
882         while (sb->len - trimlen > start_len &&
883                 (sb->buf[sb->len - 1 - trimlen] == '.'
884                 || sb->buf[sb->len - 1 - trimlen] == '-'))
885                 trimlen++;
886         strbuf_remove(sb, sb->len - trimlen, trimlen);
887 }
888
889 const char *format_subject(struct strbuf *sb, const char *msg,
890                            const char *line_separator)
891 {
892         int first = 1;
893
894         for (;;) {
895                 const char *line = msg;
896                 int linelen = get_one_line(line);
897
898                 msg += linelen;
899                 if (!linelen || is_empty_line(line, &linelen))
900                         break;
901
902                 if (!sb)
903                         continue;
904                 strbuf_grow(sb, linelen + 2);
905                 if (!first)
906                         strbuf_addstr(sb, line_separator);
907                 strbuf_add(sb, line, linelen);
908                 first = 0;
909         }
910         return msg;
911 }
912
913 static void parse_commit_message(struct format_commit_context *c)
914 {
915         const char *msg = c->message + c->message_off;
916         const char *start = c->message;
917
918         msg = skip_empty_lines(msg);
919         c->subject_off = msg - start;
920
921         msg = format_subject(NULL, msg, NULL);
922         msg = skip_empty_lines(msg);
923         c->body_off = msg - start;
924
925         c->commit_message_parsed = 1;
926 }
927
928 static void strbuf_wrap(struct strbuf *sb, size_t pos,
929                         size_t width, size_t indent1, size_t indent2)
930 {
931         struct strbuf tmp = STRBUF_INIT;
932
933         if (pos)
934                 strbuf_add(&tmp, sb->buf, pos);
935         strbuf_add_wrapped_text(&tmp, sb->buf + pos,
936                                 (int) indent1, (int) indent2, (int) width);
937         strbuf_swap(&tmp, sb);
938         strbuf_release(&tmp);
939 }
940
941 static void rewrap_message_tail(struct strbuf *sb,
942                                 struct format_commit_context *c,
943                                 size_t new_width, size_t new_indent1,
944                                 size_t new_indent2)
945 {
946         if (c->width == new_width && c->indent1 == new_indent1 &&
947             c->indent2 == new_indent2)
948                 return;
949         if (c->wrap_start < sb->len)
950                 strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2);
951         c->wrap_start = sb->len;
952         c->width = new_width;
953         c->indent1 = new_indent1;
954         c->indent2 = new_indent2;
955 }
956
957 static int format_reflog_person(struct strbuf *sb,
958                                 char part,
959                                 struct reflog_walk_info *log,
960                                 enum date_mode dmode)
961 {
962         const char *ident;
963
964         if (!log)
965                 return 2;
966
967         ident = get_reflog_ident(log);
968         if (!ident)
969                 return 2;
970
971         return format_person_part(sb, part, ident, strlen(ident), dmode);
972 }
973
974 static size_t parse_color(struct strbuf *sb, /* in UTF-8 */
975                           const char *placeholder,
976                           struct format_commit_context *c)
977 {
978         if (placeholder[1] == '(') {
979                 const char *begin = placeholder + 2;
980                 const char *end = strchr(begin, ')');
981                 char color[COLOR_MAXLEN];
982
983                 if (!end)
984                         return 0;
985                 if (starts_with(begin, "auto,")) {
986                         if (!want_color(c->pretty_ctx->color))
987                                 return end - placeholder + 1;
988                         begin += 5;
989                 }
990                 color_parse_mem(begin,
991                                 end - begin,
992                                 "--pretty format", color);
993                 strbuf_addstr(sb, color);
994                 return end - placeholder + 1;
995         }
996         if (starts_with(placeholder + 1, "red")) {
997                 strbuf_addstr(sb, GIT_COLOR_RED);
998                 return 4;
999         } else if (starts_with(placeholder + 1, "green")) {
1000                 strbuf_addstr(sb, GIT_COLOR_GREEN);
1001                 return 6;
1002         } else if (starts_with(placeholder + 1, "blue")) {
1003                 strbuf_addstr(sb, GIT_COLOR_BLUE);
1004                 return 5;
1005         } else if (starts_with(placeholder + 1, "reset")) {
1006                 strbuf_addstr(sb, GIT_COLOR_RESET);
1007                 return 6;
1008         } else
1009                 return 0;
1010 }
1011
1012 static size_t parse_padding_placeholder(struct strbuf *sb,
1013                                         const char *placeholder,
1014                                         struct format_commit_context *c)
1015 {
1016         const char *ch = placeholder;
1017         enum flush_type flush_type;
1018         int to_column = 0;
1019
1020         switch (*ch++) {
1021         case '<':
1022                 flush_type = flush_right;
1023                 break;
1024         case '>':
1025                 if (*ch == '<') {
1026                         flush_type = flush_both;
1027                         ch++;
1028                 } else if (*ch == '>') {
1029                         flush_type = flush_left_and_steal;
1030                         ch++;
1031                 } else
1032                         flush_type = flush_left;
1033                 break;
1034         default:
1035                 return 0;
1036         }
1037
1038         /* the next value means "wide enough to that column" */
1039         if (*ch == '|') {
1040                 to_column = 1;
1041                 ch++;
1042         }
1043
1044         if (*ch == '(') {
1045                 const char *start = ch + 1;
1046                 const char *end = start + strcspn(start, ",)");
1047                 char *next;
1048                 int width;
1049                 if (!end || end == start)
1050                         return 0;
1051                 width = strtoul(start, &next, 10);
1052                 if (next == start || width == 0)
1053                         return 0;
1054                 c->padding = to_column ? -width : width;
1055                 c->flush_type = flush_type;
1056
1057                 if (*end == ',') {
1058                         start = end + 1;
1059                         end = strchr(start, ')');
1060                         if (!end || end == start)
1061                                 return 0;
1062                         if (starts_with(start, "trunc)"))
1063                                 c->truncate = trunc_right;
1064                         else if (starts_with(start, "ltrunc)"))
1065                                 c->truncate = trunc_left;
1066                         else if (starts_with(start, "mtrunc)"))
1067                                 c->truncate = trunc_middle;
1068                         else
1069                                 return 0;
1070                 } else
1071                         c->truncate = trunc_none;
1072
1073                 return end - placeholder + 1;
1074         }
1075         return 0;
1076 }
1077
1078 static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
1079                                 const char *placeholder,
1080                                 void *context)
1081 {
1082         struct format_commit_context *c = context;
1083         const struct commit *commit = c->commit;
1084         const char *msg = c->message;
1085         struct commit_list *p;
1086         int h1, h2;
1087
1088         /* these are independent of the commit */
1089         switch (placeholder[0]) {
1090         case 'C':
1091                 if (starts_with(placeholder + 1, "(auto)")) {
1092                         c->auto_color = 1;
1093                         return 7; /* consumed 7 bytes, "C(auto)" */
1094                 } else {
1095                         int ret = parse_color(sb, placeholder, c);
1096                         if (ret)
1097                                 c->auto_color = 0;
1098                         /*
1099                          * Otherwise, we decided to treat %C<unknown>
1100                          * as a literal string, and the previous
1101                          * %C(auto) is still valid.
1102                          */
1103                         return ret;
1104                 }
1105         case 'n':               /* newline */
1106                 strbuf_addch(sb, '\n');
1107                 return 1;
1108         case 'x':
1109                 /* %x00 == NUL, %x0a == LF, etc. */
1110                 if (0 <= (h1 = hexval_table[0xff & placeholder[1]]) &&
1111                     h1 <= 16 &&
1112                     0 <= (h2 = hexval_table[0xff & placeholder[2]]) &&
1113                     h2 <= 16) {
1114                         strbuf_addch(sb, (h1<<4)|h2);
1115                         return 3;
1116                 } else
1117                         return 0;
1118         case 'w':
1119                 if (placeholder[1] == '(') {
1120                         unsigned long width = 0, indent1 = 0, indent2 = 0;
1121                         char *next;
1122                         const char *start = placeholder + 2;
1123                         const char *end = strchr(start, ')');
1124                         if (!end)
1125                                 return 0;
1126                         if (end > start) {
1127                                 width = strtoul(start, &next, 10);
1128                                 if (*next == ',') {
1129                                         indent1 = strtoul(next + 1, &next, 10);
1130                                         if (*next == ',') {
1131                                                 indent2 = strtoul(next + 1,
1132                                                                  &next, 10);
1133                                         }
1134                                 }
1135                                 if (*next != ')')
1136                                         return 0;
1137                         }
1138                         rewrap_message_tail(sb, c, width, indent1, indent2);
1139                         return end - placeholder + 1;
1140                 } else
1141                         return 0;
1142
1143         case '<':
1144         case '>':
1145                 return parse_padding_placeholder(sb, placeholder, c);
1146         }
1147
1148         /* these depend on the commit */
1149         if (!commit->object.parsed)
1150                 parse_object(commit->object.sha1);
1151
1152         switch (placeholder[0]) {
1153         case 'H':               /* commit hash */
1154                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1155                 strbuf_addstr(sb, sha1_to_hex(commit->object.sha1));
1156                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1157                 return 1;
1158         case 'h':               /* abbreviated commit hash */
1159                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_COMMIT));
1160                 if (add_again(sb, &c->abbrev_commit_hash)) {
1161                         strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1162                         return 1;
1163                 }
1164                 strbuf_addstr(sb, find_unique_abbrev(commit->object.sha1,
1165                                                      c->pretty_ctx->abbrev));
1166                 strbuf_addstr(sb, diff_get_color(c->auto_color, DIFF_RESET));
1167                 c->abbrev_commit_hash.len = sb->len - c->abbrev_commit_hash.off;
1168                 return 1;
1169         case 'T':               /* tree hash */
1170                 strbuf_addstr(sb, sha1_to_hex(commit->tree->object.sha1));
1171                 return 1;
1172         case 't':               /* abbreviated tree hash */
1173                 if (add_again(sb, &c->abbrev_tree_hash))
1174                         return 1;
1175                 strbuf_addstr(sb, find_unique_abbrev(commit->tree->object.sha1,
1176                                                      c->pretty_ctx->abbrev));
1177                 c->abbrev_tree_hash.len = sb->len - c->abbrev_tree_hash.off;
1178                 return 1;
1179         case 'P':               /* parent hashes */
1180                 for (p = commit->parents; p; p = p->next) {
1181                         if (p != commit->parents)
1182                                 strbuf_addch(sb, ' ');
1183                         strbuf_addstr(sb, sha1_to_hex(p->item->object.sha1));
1184                 }
1185                 return 1;
1186         case 'p':               /* abbreviated parent hashes */
1187                 if (add_again(sb, &c->abbrev_parent_hashes))
1188                         return 1;
1189                 for (p = commit->parents; p; p = p->next) {
1190                         if (p != commit->parents)
1191                                 strbuf_addch(sb, ' ');
1192                         strbuf_addstr(sb, find_unique_abbrev(
1193                                         p->item->object.sha1,
1194                                         c->pretty_ctx->abbrev));
1195                 }
1196                 c->abbrev_parent_hashes.len = sb->len -
1197                                               c->abbrev_parent_hashes.off;
1198                 return 1;
1199         case 'm':               /* left/right/bottom */
1200                 strbuf_addstr(sb, get_revision_mark(NULL, commit));
1201                 return 1;
1202         case 'd':
1203                 load_ref_decorations(DECORATE_SHORT_REFS);
1204                 format_decorations(sb, commit, c->auto_color);
1205                 return 1;
1206         case 'g':               /* reflog info */
1207                 switch(placeholder[1]) {
1208                 case 'd':       /* reflog selector */
1209                 case 'D':
1210                         if (c->pretty_ctx->reflog_info)
1211                                 get_reflog_selector(sb,
1212                                                     c->pretty_ctx->reflog_info,
1213                                                     c->pretty_ctx->date_mode,
1214                                                     c->pretty_ctx->date_mode_explicit,
1215                                                     (placeholder[1] == 'd'));
1216                         return 2;
1217                 case 's':       /* reflog message */
1218                         if (c->pretty_ctx->reflog_info)
1219                                 get_reflog_message(sb, c->pretty_ctx->reflog_info);
1220                         return 2;
1221                 case 'n':
1222                 case 'N':
1223                 case 'e':
1224                 case 'E':
1225                         return format_reflog_person(sb,
1226                                                     placeholder[1],
1227                                                     c->pretty_ctx->reflog_info,
1228                                                     c->pretty_ctx->date_mode);
1229                 }
1230                 return 0;       /* unknown %g placeholder */
1231         case 'N':
1232                 if (c->pretty_ctx->notes_message) {
1233                         strbuf_addstr(sb, c->pretty_ctx->notes_message);
1234                         return 1;
1235                 }
1236                 return 0;
1237         }
1238
1239         if (placeholder[0] == 'G') {
1240                 if (!c->signature_check.result)
1241                         check_commit_signature(c->commit, &(c->signature_check));
1242                 switch (placeholder[1]) {
1243                 case 'G':
1244                         if (c->signature_check.gpg_output)
1245                                 strbuf_addstr(sb, c->signature_check.gpg_output);
1246                         break;
1247                 case '?':
1248                         switch (c->signature_check.result) {
1249                         case 'G':
1250                         case 'B':
1251                         case 'U':
1252                         case 'N':
1253                                 strbuf_addch(sb, c->signature_check.result);
1254                         }
1255                         break;
1256                 case 'S':
1257                         if (c->signature_check.signer)
1258                                 strbuf_addstr(sb, c->signature_check.signer);
1259                         break;
1260                 case 'K':
1261                         if (c->signature_check.key)
1262                                 strbuf_addstr(sb, c->signature_check.key);
1263                         break;
1264                 }
1265                 return 2;
1266         }
1267
1268
1269         /* For the rest we have to parse the commit header. */
1270         if (!c->commit_header_parsed)
1271                 parse_commit_header(c);
1272
1273         switch (placeholder[0]) {
1274         case 'a':       /* author ... */
1275                 return format_person_part(sb, placeholder[1],
1276                                    msg + c->author.off, c->author.len,
1277                                    c->pretty_ctx->date_mode);
1278         case 'c':       /* committer ... */
1279                 return format_person_part(sb, placeholder[1],
1280                                    msg + c->committer.off, c->committer.len,
1281                                    c->pretty_ctx->date_mode);
1282         case 'e':       /* encoding */
1283                 if (c->commit_encoding)
1284                         strbuf_addstr(sb, c->commit_encoding);
1285                 return 1;
1286         case 'B':       /* raw body */
1287                 /* message_off is always left at the initial newline */
1288                 strbuf_addstr(sb, msg + c->message_off + 1);
1289                 return 1;
1290         }
1291
1292         /* Now we need to parse the commit message. */
1293         if (!c->commit_message_parsed)
1294                 parse_commit_message(c);
1295
1296         switch (placeholder[0]) {
1297         case 's':       /* subject */
1298                 format_subject(sb, msg + c->subject_off, " ");
1299                 return 1;
1300         case 'f':       /* sanitized subject */
1301                 format_sanitized_subject(sb, msg + c->subject_off);
1302                 return 1;
1303         case 'b':       /* body */
1304                 strbuf_addstr(sb, msg + c->body_off);
1305                 return 1;
1306         }
1307         return 0;       /* unknown placeholder */
1308 }
1309
1310 static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
1311                                     const char *placeholder,
1312                                     struct format_commit_context *c)
1313 {
1314         struct strbuf local_sb = STRBUF_INIT;
1315         int total_consumed = 0, len, padding = c->padding;
1316         if (padding < 0) {
1317                 const char *start = strrchr(sb->buf, '\n');
1318                 int occupied;
1319                 if (!start)
1320                         start = sb->buf;
1321                 occupied = utf8_strnwidth(start, -1, 1);
1322                 padding = (-padding) - occupied;
1323         }
1324         while (1) {
1325                 int modifier = *placeholder == 'C';
1326                 int consumed = format_commit_one(&local_sb, placeholder, c);
1327                 total_consumed += consumed;
1328
1329                 if (!modifier)
1330                         break;
1331
1332                 placeholder += consumed;
1333                 if (*placeholder != '%')
1334                         break;
1335                 placeholder++;
1336                 total_consumed++;
1337         }
1338         len = utf8_strnwidth(local_sb.buf, -1, 1);
1339
1340         if (c->flush_type == flush_left_and_steal) {
1341                 const char *ch = sb->buf + sb->len - 1;
1342                 while (len > padding && ch > sb->buf) {
1343                         const char *p;
1344                         if (*ch == ' ') {
1345                                 ch--;
1346                                 padding++;
1347                                 continue;
1348                         }
1349                         /* check for trailing ansi sequences */
1350                         if (*ch != 'm')
1351                                 break;
1352                         p = ch - 1;
1353                         while (ch - p < 10 && *p != '\033')
1354                                 p--;
1355                         if (*p != '\033' ||
1356                             ch + 1 - p != display_mode_esc_sequence_len(p))
1357                                 break;
1358                         /*
1359                          * got a good ansi sequence, put it back to
1360                          * local_sb as we're cutting sb
1361                          */
1362                         strbuf_insert(&local_sb, 0, p, ch + 1 - p);
1363                         ch = p - 1;
1364                 }
1365                 strbuf_setlen(sb, ch + 1 - sb->buf);
1366                 c->flush_type = flush_left;
1367         }
1368
1369         if (len > padding) {
1370                 switch (c->truncate) {
1371                 case trunc_left:
1372                         strbuf_utf8_replace(&local_sb,
1373                                             0, len - (padding - 2),
1374                                             "..");
1375                         break;
1376                 case trunc_middle:
1377                         strbuf_utf8_replace(&local_sb,
1378                                             padding / 2 - 1,
1379                                             len - (padding - 2),
1380                                             "..");
1381                         break;
1382                 case trunc_right:
1383                         strbuf_utf8_replace(&local_sb,
1384                                             padding - 2, len - (padding - 2),
1385                                             "..");
1386                         break;
1387                 case trunc_none:
1388                         break;
1389                 }
1390                 strbuf_addstr(sb, local_sb.buf);
1391         } else {
1392                 int sb_len = sb->len, offset = 0;
1393                 if (c->flush_type == flush_left)
1394                         offset = padding - len;
1395                 else if (c->flush_type == flush_both)
1396                         offset = (padding - len) / 2;
1397                 /*
1398                  * we calculate padding in columns, now
1399                  * convert it back to chars
1400                  */
1401                 padding = padding - len + local_sb.len;
1402                 strbuf_grow(sb, padding);
1403                 strbuf_setlen(sb, sb_len + padding);
1404                 memset(sb->buf + sb_len, ' ', sb->len - sb_len);
1405                 memcpy(sb->buf + sb_len + offset, local_sb.buf,
1406                        local_sb.len);
1407         }
1408         strbuf_release(&local_sb);
1409         c->flush_type = no_flush;
1410         return total_consumed;
1411 }
1412
1413 static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
1414                                  const char *placeholder,
1415                                  void *context)
1416 {
1417         int consumed;
1418         size_t orig_len;
1419         enum {
1420                 NO_MAGIC,
1421                 ADD_LF_BEFORE_NON_EMPTY,
1422                 DEL_LF_BEFORE_EMPTY,
1423                 ADD_SP_BEFORE_NON_EMPTY
1424         } magic = NO_MAGIC;
1425
1426         switch (placeholder[0]) {
1427         case '-':
1428                 magic = DEL_LF_BEFORE_EMPTY;
1429                 break;
1430         case '+':
1431                 magic = ADD_LF_BEFORE_NON_EMPTY;
1432                 break;
1433         case ' ':
1434                 magic = ADD_SP_BEFORE_NON_EMPTY;
1435                 break;
1436         default:
1437                 break;
1438         }
1439         if (magic != NO_MAGIC)
1440                 placeholder++;
1441
1442         orig_len = sb->len;
1443         if (((struct format_commit_context *)context)->flush_type != no_flush)
1444                 consumed = format_and_pad_commit(sb, placeholder, context);
1445         else
1446                 consumed = format_commit_one(sb, placeholder, context);
1447         if (magic == NO_MAGIC)
1448                 return consumed;
1449
1450         if ((orig_len == sb->len) && magic == DEL_LF_BEFORE_EMPTY) {
1451                 while (sb->len && sb->buf[sb->len - 1] == '\n')
1452                         strbuf_setlen(sb, sb->len - 1);
1453         } else if (orig_len != sb->len) {
1454                 if (magic == ADD_LF_BEFORE_NON_EMPTY)
1455                         strbuf_insert(sb, orig_len, "\n", 1);
1456                 else if (magic == ADD_SP_BEFORE_NON_EMPTY)
1457                         strbuf_insert(sb, orig_len, " ", 1);
1458         }
1459         return consumed + 1;
1460 }
1461
1462 static size_t userformat_want_item(struct strbuf *sb, const char *placeholder,
1463                                    void *context)
1464 {
1465         struct userformat_want *w = context;
1466
1467         if (*placeholder == '+' || *placeholder == '-' || *placeholder == ' ')
1468                 placeholder++;
1469
1470         switch (*placeholder) {
1471         case 'N':
1472                 w->notes = 1;
1473                 break;
1474         }
1475         return 0;
1476 }
1477
1478 void userformat_find_requirements(const char *fmt, struct userformat_want *w)
1479 {
1480         struct strbuf dummy = STRBUF_INIT;
1481
1482         if (!fmt) {
1483                 if (!user_format)
1484                         return;
1485                 fmt = user_format;
1486         }
1487         strbuf_expand(&dummy, fmt, userformat_want_item, w);
1488         strbuf_release(&dummy);
1489 }
1490
1491 void format_commit_message(const struct commit *commit,
1492                            const char *format, struct strbuf *sb,
1493                            const struct pretty_print_context *pretty_ctx)
1494 {
1495         struct format_commit_context context;
1496         const char *output_enc = pretty_ctx->output_encoding;
1497         const char *utf8 = "UTF-8";
1498
1499         memset(&context, 0, sizeof(context));
1500         context.commit = commit;
1501         context.pretty_ctx = pretty_ctx;
1502         context.wrap_start = sb->len;
1503         context.message = logmsg_reencode(commit,
1504                                           &context.commit_encoding,
1505                                           output_enc);
1506
1507         strbuf_expand(sb, format, format_commit_item, &context);
1508         rewrap_message_tail(sb, &context, 0, 0, 0);
1509
1510         if (output_enc) {
1511                 if (same_encoding(utf8, output_enc))
1512                         output_enc = NULL;
1513         } else {
1514                 if (context.commit_encoding &&
1515                     !same_encoding(context.commit_encoding, utf8))
1516                         output_enc = context.commit_encoding;
1517         }
1518
1519         if (output_enc) {
1520                 int outsz;
1521                 char *out = reencode_string_len(sb->buf, sb->len,
1522                                                 output_enc, utf8, &outsz);
1523                 if (out)
1524                         strbuf_attach(sb, out, outsz, outsz + 1);
1525         }
1526
1527         free(context.commit_encoding);
1528         logmsg_free(context.message, commit);
1529         free(context.signature_check.gpg_output);
1530         free(context.signature_check.signer);
1531 }
1532
1533 static void pp_header(struct pretty_print_context *pp,
1534                       const char *encoding,
1535                       const struct commit *commit,
1536                       const char **msg_p,
1537                       struct strbuf *sb)
1538 {
1539         int parents_shown = 0;
1540
1541         for (;;) {
1542                 const char *line = *msg_p;
1543                 int linelen = get_one_line(*msg_p);
1544
1545                 if (!linelen)
1546                         return;
1547                 *msg_p += linelen;
1548
1549                 if (linelen == 1)
1550                         /* End of header */
1551                         return;
1552
1553                 if (pp->fmt == CMIT_FMT_RAW) {
1554                         strbuf_add(sb, line, linelen);
1555                         continue;
1556                 }
1557
1558                 if (starts_with(line, "parent ")) {
1559                         if (linelen != 48)
1560                                 die("bad parent line in commit");
1561                         continue;
1562                 }
1563
1564                 if (!parents_shown) {
1565                         struct commit_list *parent;
1566                         int num;
1567                         for (parent = commit->parents, num = 0;
1568                              parent;
1569                              parent = parent->next, num++)
1570                                 ;
1571                         /* with enough slop */
1572                         strbuf_grow(sb, num * 50 + 20);
1573                         add_merge_info(pp, sb, commit);
1574                         parents_shown = 1;
1575                 }
1576
1577                 /*
1578                  * MEDIUM == DEFAULT shows only author with dates.
1579                  * FULL shows both authors but not dates.
1580                  * FULLER shows both authors and dates.
1581                  */
1582                 if (starts_with(line, "author ")) {
1583                         strbuf_grow(sb, linelen + 80);
1584                         pp_user_info(pp, "Author", sb, line + 7, encoding);
1585                 }
1586                 if (starts_with(line, "committer ") &&
1587                     (pp->fmt == CMIT_FMT_FULL || pp->fmt == CMIT_FMT_FULLER)) {
1588                         strbuf_grow(sb, linelen + 80);
1589                         pp_user_info(pp, "Commit", sb, line + 10, encoding);
1590                 }
1591         }
1592 }
1593
1594 void pp_title_line(struct pretty_print_context *pp,
1595                    const char **msg_p,
1596                    struct strbuf *sb,
1597                    const char *encoding,
1598                    int need_8bit_cte)
1599 {
1600         static const int max_length = 78; /* per rfc2047 */
1601         struct strbuf title;
1602
1603         strbuf_init(&title, 80);
1604         *msg_p = format_subject(&title, *msg_p,
1605                                 pp->preserve_subject ? "\n" : " ");
1606
1607         strbuf_grow(sb, title.len + 1024);
1608         if (pp->subject) {
1609                 strbuf_addstr(sb, pp->subject);
1610                 if (needs_rfc2047_encoding(title.buf, title.len, RFC2047_SUBJECT))
1611                         add_rfc2047(sb, title.buf, title.len,
1612                                                 encoding, RFC2047_SUBJECT);
1613                 else
1614                         strbuf_add_wrapped_bytes(sb, title.buf, title.len,
1615                                          -last_line_length(sb), 1, max_length);
1616         } else {
1617                 strbuf_addbuf(sb, &title);
1618         }
1619         strbuf_addch(sb, '\n');
1620
1621         if (need_8bit_cte == 0) {
1622                 int i;
1623                 for (i = 0; i < pp->in_body_headers.nr; i++) {
1624                         if (has_non_ascii(pp->in_body_headers.items[i].string)) {
1625                                 need_8bit_cte = 1;
1626                                 break;
1627                         }
1628                 }
1629         }
1630
1631         if (need_8bit_cte > 0) {
1632                 const char *header_fmt =
1633                         "MIME-Version: 1.0\n"
1634                         "Content-Type: text/plain; charset=%s\n"
1635                         "Content-Transfer-Encoding: 8bit\n";
1636                 strbuf_addf(sb, header_fmt, encoding);
1637         }
1638         if (pp->after_subject) {
1639                 strbuf_addstr(sb, pp->after_subject);
1640         }
1641         if (pp->fmt == CMIT_FMT_EMAIL) {
1642                 strbuf_addch(sb, '\n');
1643         }
1644
1645         if (pp->in_body_headers.nr) {
1646                 int i;
1647                 for (i = 0; i < pp->in_body_headers.nr; i++) {
1648                         strbuf_addstr(sb, pp->in_body_headers.items[i].string);
1649                         free(pp->in_body_headers.items[i].string);
1650                 }
1651                 string_list_clear(&pp->in_body_headers, 0);
1652                 strbuf_addch(sb, '\n');
1653         }
1654
1655         strbuf_release(&title);
1656 }
1657
1658 void pp_remainder(struct pretty_print_context *pp,
1659                   const char **msg_p,
1660                   struct strbuf *sb,
1661                   int indent)
1662 {
1663         int first = 1;
1664         for (;;) {
1665                 const char *line = *msg_p;
1666                 int linelen = get_one_line(line);
1667                 *msg_p += linelen;
1668
1669                 if (!linelen)
1670                         break;
1671
1672                 if (is_empty_line(line, &linelen)) {
1673                         if (first)
1674                                 continue;
1675                         if (pp->fmt == CMIT_FMT_SHORT)
1676                                 break;
1677                 }
1678                 first = 0;
1679
1680                 strbuf_grow(sb, linelen + indent + 20);
1681                 if (indent) {
1682                         memset(sb->buf + sb->len, ' ', indent);
1683                         strbuf_setlen(sb, sb->len + indent);
1684                 }
1685                 strbuf_add(sb, line, linelen);
1686                 strbuf_addch(sb, '\n');
1687         }
1688 }
1689
1690 void pretty_print_commit(struct pretty_print_context *pp,
1691                          const struct commit *commit,
1692                          struct strbuf *sb)
1693 {
1694         unsigned long beginning_of_body;
1695         int indent = 4;
1696         const char *msg;
1697         char *reencoded;
1698         const char *encoding;
1699         int need_8bit_cte = pp->need_8bit_cte;
1700
1701         if (pp->fmt == CMIT_FMT_USERFORMAT) {
1702                 format_commit_message(commit, user_format, sb, pp);
1703                 return;
1704         }
1705
1706         encoding = get_log_output_encoding();
1707         msg = reencoded = logmsg_reencode(commit, NULL, encoding);
1708
1709         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1710                 indent = 0;
1711
1712         /*
1713          * We need to check and emit Content-type: to mark it
1714          * as 8-bit if we haven't done so.
1715          */
1716         if (pp->fmt == CMIT_FMT_EMAIL && need_8bit_cte == 0) {
1717                 int i, ch, in_body;
1718
1719                 for (in_body = i = 0; (ch = msg[i]); i++) {
1720                         if (!in_body) {
1721                                 /* author could be non 7-bit ASCII but
1722                                  * the log may be so; skip over the
1723                                  * header part first.
1724                                  */
1725                                 if (ch == '\n' && msg[i+1] == '\n')
1726                                         in_body = 1;
1727                         }
1728                         else if (non_ascii(ch)) {
1729                                 need_8bit_cte = 1;
1730                                 break;
1731                         }
1732                 }
1733         }
1734
1735         pp_header(pp, encoding, commit, &msg, sb);
1736         if (pp->fmt != CMIT_FMT_ONELINE && !pp->subject) {
1737                 strbuf_addch(sb, '\n');
1738         }
1739
1740         /* Skip excess blank lines at the beginning of body, if any... */
1741         msg = skip_empty_lines(msg);
1742
1743         /* These formats treat the title line specially. */
1744         if (pp->fmt == CMIT_FMT_ONELINE || pp->fmt == CMIT_FMT_EMAIL)
1745                 pp_title_line(pp, &msg, sb, encoding, need_8bit_cte);
1746
1747         beginning_of_body = sb->len;
1748         if (pp->fmt != CMIT_FMT_ONELINE)
1749                 pp_remainder(pp, &msg, sb, indent);
1750         strbuf_rtrim(sb);
1751
1752         /* Make sure there is an EOLN for the non-oneline case */
1753         if (pp->fmt != CMIT_FMT_ONELINE)
1754                 strbuf_addch(sb, '\n');
1755
1756         /*
1757          * The caller may append additional body text in e-mail
1758          * format.  Make sure we did not strip the blank line
1759          * between the header and the body.
1760          */
1761         if (pp->fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
1762                 strbuf_addch(sb, '\n');
1763
1764         logmsg_free(reencoded, commit);
1765 }
1766
1767 void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
1768                     struct strbuf *sb)
1769 {
1770         struct pretty_print_context pp = {0};
1771         pp.fmt = fmt;
1772         pretty_print_commit(&pp, commit, sb);
1773 }