6 #include "string-list.h"
11 #include "reflog-walk.h"
12 #include "gpg-interface.h"
14 static char *user_format
;
15 static struct cmt_fmt_map
{
20 const char *user_format
;
22 static size_t builtin_formats_len
;
23 static size_t commit_formats_len
;
24 static size_t commit_formats_alloc
;
25 static struct cmt_fmt_map
*find_commit_format(const char *sought
);
27 static void save_user_format(struct rev_info
*rev
, const char *cp
, int is_tformat
)
30 user_format
= xstrdup(cp
);
32 rev
->use_terminator
= 1;
33 rev
->commit_format
= CMIT_FMT_USERFORMAT
;
36 static int git_pretty_formats_config(const char *var
, const char *value
, void *cb
)
38 struct cmt_fmt_map
*commit_format
= NULL
;
43 if (prefixcmp(var
, "pretty."))
46 name
= var
+ strlen("pretty.");
47 for (i
= 0; i
< builtin_formats_len
; i
++) {
48 if (!strcmp(commit_formats
[i
].name
, name
))
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
];
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
));
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;
76 commit_format
->is_alias
= 1;
77 commit_format
->user_format
= fmt
;
82 static void setup_commit_formats(void)
84 struct cmt_fmt_map builtin_formats
[] = {
85 { "raw", CMIT_FMT_RAW
, 0 },
86 { "medium", CMIT_FMT_MEDIUM
, 0 },
87 { "short", CMIT_FMT_SHORT
, 0 },
88 { "email", CMIT_FMT_EMAIL
, 0 },
89 { "fuller", CMIT_FMT_FULLER
, 0 },
90 { "full", CMIT_FMT_FULL
, 0 },
91 { "oneline", CMIT_FMT_ONELINE
, 1 }
93 commit_formats_len
= ARRAY_SIZE(builtin_formats
);
94 builtin_formats_len
= commit_formats_len
;
95 ALLOC_GROW(commit_formats
, commit_formats_len
, commit_formats_alloc
);
96 memcpy(commit_formats
, builtin_formats
,
97 sizeof(*builtin_formats
)*ARRAY_SIZE(builtin_formats
));
99 git_config(git_pretty_formats_config
, NULL
);
102 static struct cmt_fmt_map
*find_commit_format_recursive(const char *sought
,
103 const char *original
,
104 int num_redirections
)
106 struct cmt_fmt_map
*found
= NULL
;
107 size_t found_match_len
= 0;
110 if (num_redirections
>= commit_formats_len
)
111 die("invalid --pretty format: "
112 "'%s' references an alias which points to itself",
115 for (i
= 0; i
< commit_formats_len
; i
++) {
118 if (prefixcmp(commit_formats
[i
].name
, sought
))
121 match_len
= strlen(commit_formats
[i
].name
);
122 if (found
== NULL
|| found_match_len
> match_len
) {
123 found
= &commit_formats
[i
];
124 found_match_len
= match_len
;
128 if (found
&& found
->is_alias
) {
129 found
= find_commit_format_recursive(found
->user_format
,
137 static struct cmt_fmt_map
*find_commit_format(const char *sought
)
140 setup_commit_formats();
142 return find_commit_format_recursive(sought
, sought
, 0);
145 void get_commit_format(const char *arg
, struct rev_info
*rev
)
147 struct cmt_fmt_map
*commit_format
;
149 rev
->use_terminator
= 0;
151 rev
->commit_format
= CMIT_FMT_DEFAULT
;
154 if (!prefixcmp(arg
, "format:") || !prefixcmp(arg
, "tformat:")) {
155 save_user_format(rev
, strchr(arg
, ':') + 1, arg
[0] == 't');
159 if (strchr(arg
, '%')) {
160 save_user_format(rev
, arg
, 1);
164 commit_format
= find_commit_format(arg
);
166 die("invalid --pretty format: %s", arg
);
168 rev
->commit_format
= commit_format
->format
;
169 rev
->use_terminator
= commit_format
->is_tformat
;
170 if (commit_format
->format
== CMIT_FMT_USERFORMAT
) {
171 save_user_format(rev
, commit_format
->user_format
,
172 commit_format
->is_tformat
);
177 * Generic support for pretty-printing the header
179 static int get_one_line(const char *msg
)
194 /* High bit set, or ISO-2022-INT */
195 static int non_ascii(int ch
)
197 return !isascii(ch
) || ch
== '\033';
200 int has_non_ascii(const char *s
)
205 while ((ch
= *s
++) != '\0') {
212 static int is_rfc822_special(char ch
)
234 static int needs_rfc822_quoting(const char *s
, int len
)
237 for (i
= 0; i
< len
; i
++)
238 if (is_rfc822_special(s
[i
]))
243 static int last_line_length(struct strbuf
*sb
)
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')
251 return sb
->len
- (i
+ 1);
254 static void add_rfc822_quoted(struct strbuf
*out
, const char *s
, int len
)
258 /* just a guess, we may have to also backslash-quote */
259 strbuf_grow(out
, len
+ 2);
261 strbuf_addch(out
, '"');
262 for (i
= 0; i
< len
; i
++) {
266 strbuf_addch(out
, '\\');
269 strbuf_addch(out
, s
[i
]);
272 strbuf_addch(out
, '"');
280 static int is_rfc2047_special(char ch
, enum rfc2047_type type
)
283 * rfc2047, section 4.2:
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.
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)
297 if (non_ascii(ch
) || !isprint(ch
))
301 * rule out special printable characters (' ' should be the only
302 * whitespace character considered printable, but be defensive and use
305 if (isspace(ch
) || ch
== '=' || ch
== '?' || ch
== '_')
309 * rfc2047, section 5.3:
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:
315 * phrase = 1*( encoded-word / word )
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'.
325 if (type
!= RFC2047_ADDRESS
)
328 /* '=' and '_' are special cases and have been checked above */
329 return !(isalnum(ch
) || ch
== '!' || ch
== '*' || ch
== '+' || ch
== '-' || ch
== '/');
332 static int needs_rfc2047_encoding(const char *line
, int len
,
333 enum rfc2047_type type
)
337 for (i
= 0; i
< len
; i
++) {
339 if (non_ascii(ch
) || ch
== '\n')
341 if ((i
+ 1 < len
) && (ch
== '=' && line
[i
+1] == '?'))
348 static void add_rfc2047(struct strbuf
*sb
, const char *line
, size_t len
,
349 const char *encoding
, enum rfc2047_type type
)
351 static const int max_encoded_length
= 76; /* per rfc2047 */
353 int line_len
= last_line_length(sb
);
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? */
361 * RFC 2047, section 5 (3):
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.
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
);
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;
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.
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 */
389 for (i
= 0; i
< chrlen
; i
++)
390 strbuf_addf(sb
, encoded_fmt
, p
[i
]);
391 line_len
+= encoded_len
;
393 strbuf_addstr(sb
, "?=");
396 static const char *show_ident_date(const struct ident_split
*ident
,
399 unsigned long date
= 0;
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
);
409 void pp_user_info(const struct pretty_print_context
*pp
,
410 const char *what
, struct strbuf
*sb
,
411 const char *line
, const char *encoding
)
415 struct ident_split ident
;
417 const char *mailbuf
, *namebuf
;
418 size_t namelen
, maillen
;
419 int max_length
= 78; /* per rfc2822 */
421 if (pp
->fmt
== CMIT_FMT_ONELINE
)
424 line_end
= strchrnul(line
, '\n');
425 if (split_ident_line(&ident
, line
, line_end
- line
))
428 mailbuf
= ident
.mail_begin
;
429 maillen
= ident
.mail_end
- ident
.mail_begin
;
430 namebuf
= ident
.name_begin
;
431 namelen
= ident
.name_end
- ident
.name_begin
;
434 map_user(pp
->mailmap
, &mailbuf
, &maillen
, &namebuf
, &namelen
);
436 strbuf_init(&mail
, 0);
437 strbuf_init(&name
, 0);
439 strbuf_add(&mail
, mailbuf
, maillen
);
440 strbuf_add(&name
, namebuf
, namelen
);
442 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
443 strbuf_addstr(sb
, "From: ");
444 if (needs_rfc2047_encoding(name
.buf
, name
.len
, RFC2047_ADDRESS
)) {
445 add_rfc2047(sb
, name
.buf
, name
.len
,
446 encoding
, RFC2047_ADDRESS
);
447 max_length
= 76; /* per rfc2047 */
448 } else if (needs_rfc822_quoting(name
.buf
, name
.len
)) {
449 struct strbuf quoted
= STRBUF_INIT
;
450 add_rfc822_quoted("ed
, name
.buf
, name
.len
);
451 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
453 strbuf_release("ed
);
455 strbuf_add_wrapped_bytes(sb
, name
.buf
, name
.len
,
460 last_line_length(sb
) + strlen(" <") + maillen
+ strlen(">"))
461 strbuf_addch(sb
, '\n');
462 strbuf_addf(sb
, " <%s>\n", mail
.buf
);
464 strbuf_addf(sb
, "%s: %.*s%s <%s>\n", what
,
465 (pp
->fmt
== CMIT_FMT_FULLER
) ? 4 : 0,
466 " ", name
.buf
, mail
.buf
);
469 strbuf_release(&mail
);
470 strbuf_release(&name
);
473 case CMIT_FMT_MEDIUM
:
474 strbuf_addf(sb
, "Date: %s\n",
475 show_ident_date(&ident
, pp
->date_mode
));
478 strbuf_addf(sb
, "Date: %s\n",
479 show_ident_date(&ident
, DATE_RFC2822
));
481 case CMIT_FMT_FULLER
:
482 strbuf_addf(sb
, "%sDate: %s\n", what
,
483 show_ident_date(&ident
, pp
->date_mode
));
491 static int is_empty_line(const char *line
, int *len_p
)
494 while (len
&& isspace(line
[len
-1]))
500 static const char *skip_empty_lines(const char *msg
)
503 int linelen
= get_one_line(msg
);
507 if (!is_empty_line(msg
, &ll
))
514 static void add_merge_info(const struct pretty_print_context
*pp
,
515 struct strbuf
*sb
, const struct commit
*commit
)
517 struct commit_list
*parent
= commit
->parents
;
519 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (pp
->fmt
== CMIT_FMT_EMAIL
) ||
520 !parent
|| !parent
->next
)
523 strbuf_addstr(sb
, "Merge:");
526 struct commit
*p
= parent
->item
;
527 const char *hex
= NULL
;
529 hex
= find_unique_abbrev(p
->object
.sha1
, pp
->abbrev
);
531 hex
= sha1_to_hex(p
->object
.sha1
);
532 parent
= parent
->next
;
534 strbuf_addf(sb
, " %s", hex
);
536 strbuf_addch(sb
, '\n');
539 static char *get_header(const struct commit
*commit
, const char *msg
,
542 int key_len
= strlen(key
);
543 const char *line
= msg
;
546 const char *eol
= strchr(line
, '\n'), *next
;
551 warning("malformed commit (header is missing newline): %s",
552 sha1_to_hex(commit
->object
.sha1
));
553 eol
= line
+ strlen(line
);
557 if (eol
- line
> key_len
&&
558 !strncmp(line
, key
, key_len
) &&
559 line
[key_len
] == ' ') {
560 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
567 static char *replace_encoding_header(char *buf
, const char *encoding
)
569 struct strbuf tmp
= STRBUF_INIT
;
573 /* guess if there is an encoding header before a \n\n */
574 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
575 cp
= strchr(cp
, '\n');
576 if (!cp
|| *++cp
== '\n')
580 cp
= strchr(cp
, '\n');
582 return buf
; /* should not happen but be defensive */
583 len
= cp
+ 1 - (buf
+ start
);
585 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
586 if (is_encoding_utf8(encoding
)) {
587 /* we have re-coded to UTF-8; drop the header */
588 strbuf_remove(&tmp
, start
, len
);
590 /* just replaces XXXX in 'encoding XXXX\n' */
591 strbuf_splice(&tmp
, start
+ strlen("encoding "),
592 len
- strlen("encoding \n"),
593 encoding
, strlen(encoding
));
595 return strbuf_detach(&tmp
, NULL
);
598 char *logmsg_reencode(const struct commit
*commit
,
599 const char *output_encoding
)
601 static const char *utf8
= "UTF-8";
602 const char *use_encoding
;
604 char *msg
= commit
->buffer
;
608 enum object_type type
;
611 msg
= read_sha1_file(commit
->object
.sha1
, &type
, &size
);
613 die("Cannot read commit object %s",
614 sha1_to_hex(commit
->object
.sha1
));
615 if (type
!= OBJ_COMMIT
)
616 die("Expected commit for '%s', got %s",
617 sha1_to_hex(commit
->object
.sha1
), typename(type
));
620 if (!output_encoding
|| !*output_encoding
)
622 encoding
= get_header(commit
, msg
, "encoding");
623 use_encoding
= encoding
? encoding
: utf8
;
624 if (same_encoding(use_encoding
, output_encoding
)) {
626 * No encoding work to be done. If we have no encoding header
627 * at all, then there's nothing to do, and we can return the
628 * message verbatim (whether newly allocated or not).
634 * Otherwise, we still want to munge the encoding header in the
635 * result, which will be done by modifying the buffer. If we
636 * are using a fresh copy, we can reuse it. But if we are using
637 * the cached copy from commit->buffer, we need to duplicate it
638 * to avoid munging commit->buffer.
641 if (out
== commit
->buffer
)
646 * There's actual encoding work to do. Do the reencoding, which
647 * still leaves the header to be replaced in the next step. At
648 * this point, we are done with msg. If we allocated a fresh
649 * copy, we can free it.
651 out
= reencode_string(msg
, output_encoding
, use_encoding
);
652 if (out
&& msg
!= commit
->buffer
)
657 * This replacement actually consumes the buffer we hand it, so we do
658 * not have to worry about freeing the old "out" here.
661 out
= replace_encoding_header(out
, output_encoding
);
665 * If the re-encoding failed, out might be NULL here; in that
666 * case we just return the commit message verbatim.
668 return out
? out
: msg
;
671 void logmsg_free(char *msg
, const struct commit
*commit
)
673 if (msg
!= commit
->buffer
)
677 static int mailmap_name(const char **email
, size_t *email_len
,
678 const char **name
, size_t *name_len
)
680 static struct string_list
*mail_map
;
682 mail_map
= xcalloc(1, sizeof(*mail_map
));
683 read_mailmap(mail_map
, NULL
);
685 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
688 static size_t format_person_part(struct strbuf
*sb
, char part
,
689 const char *msg
, int len
, enum date_mode dmode
)
691 /* currently all placeholders have same length */
692 const int placeholder_len
= 2;
693 struct ident_split s
;
694 const char *name
, *mail
;
695 size_t maillen
, namelen
;
697 if (split_ident_line(&s
, msg
, len
) < 0)
701 namelen
= s
.name_end
- s
.name_begin
;
703 maillen
= s
.mail_end
- s
.mail_begin
;
705 if (part
== 'N' || part
== 'E') /* mailmap lookup */
706 mailmap_name(&mail
, &maillen
, &name
, &namelen
);
707 if (part
== 'n' || part
== 'N') { /* name */
708 strbuf_add(sb
, name
, namelen
);
709 return placeholder_len
;
711 if (part
== 'e' || part
== 'E') { /* email */
712 strbuf_add(sb
, mail
, maillen
);
713 return placeholder_len
;
719 if (part
== 't') { /* date, UNIX timestamp */
720 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
721 return placeholder_len
;
726 strbuf_addstr(sb
, show_ident_date(&s
, dmode
));
727 return placeholder_len
;
728 case 'D': /* date, RFC2822 style */
729 strbuf_addstr(sb
, show_ident_date(&s
, DATE_RFC2822
));
730 return placeholder_len
;
731 case 'r': /* date, relative */
732 strbuf_addstr(sb
, show_ident_date(&s
, DATE_RELATIVE
));
733 return placeholder_len
;
734 case 'i': /* date, ISO 8601 */
735 strbuf_addstr(sb
, show_ident_date(&s
, DATE_ISO8601
));
736 return placeholder_len
;
741 * reading from either a bogus commit, or a reflog entry with
742 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
743 * to compute a valid return value.
745 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
746 || part
== 'D' || part
== 'r' || part
== 'i')
747 return placeholder_len
;
749 return 0; /* unknown placeholder */
757 struct format_commit_context
{
758 const struct commit
*commit
;
759 const struct pretty_print_context
*pretty_ctx
;
760 unsigned commit_header_parsed
:1;
761 unsigned commit_message_parsed
:1;
762 unsigned commit_signature_parsed
:1;
771 size_t width
, indent1
, indent2
;
773 /* These offsets are relative to the start of the commit message. */
775 struct chunk committer
;
776 struct chunk encoding
;
781 /* The following ones are relative to the result struct strbuf. */
782 struct chunk abbrev_commit_hash
;
783 struct chunk abbrev_tree_hash
;
784 struct chunk abbrev_parent_hashes
;
788 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
791 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
796 * We haven't seen this chunk before. Our caller is surely
797 * going to add it the hard way now. Remember the most likely
798 * start of the to-be-added chunk: the current end of the
801 chunk
->off
= sb
->len
;
805 static void parse_commit_header(struct format_commit_context
*context
)
807 const char *msg
= context
->message
;
810 for (i
= 0; msg
[i
]; i
++) {
812 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
817 } else if (!prefixcmp(msg
+ i
, "author ")) {
818 context
->author
.off
= i
+ 7;
819 context
->author
.len
= eol
- i
- 7;
820 } else if (!prefixcmp(msg
+ i
, "committer ")) {
821 context
->committer
.off
= i
+ 10;
822 context
->committer
.len
= eol
- i
- 10;
823 } else if (!prefixcmp(msg
+ i
, "encoding ")) {
824 context
->encoding
.off
= i
+ 9;
825 context
->encoding
.len
= eol
- i
- 9;
829 context
->message_off
= i
;
830 context
->commit_header_parsed
= 1;
833 static int istitlechar(char c
)
835 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
836 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
839 static void format_sanitized_subject(struct strbuf
*sb
, const char *msg
)
842 size_t start_len
= sb
->len
;
845 for (; *msg
&& *msg
!= '\n'; msg
++) {
846 if (istitlechar(*msg
)) {
848 strbuf_addch(sb
, '-');
850 strbuf_addch(sb
, *msg
);
852 while (*(msg
+1) == '.')
858 /* trim any trailing '.' or '-' characters */
860 while (sb
->len
- trimlen
> start_len
&&
861 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
862 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
864 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
867 const char *format_subject(struct strbuf
*sb
, const char *msg
,
868 const char *line_separator
)
873 const char *line
= msg
;
874 int linelen
= get_one_line(line
);
877 if (!linelen
|| is_empty_line(line
, &linelen
))
882 strbuf_grow(sb
, linelen
+ 2);
884 strbuf_addstr(sb
, line_separator
);
885 strbuf_add(sb
, line
, linelen
);
891 static void parse_commit_message(struct format_commit_context
*c
)
893 const char *msg
= c
->message
+ c
->message_off
;
894 const char *start
= c
->message
;
896 msg
= skip_empty_lines(msg
);
897 c
->subject_off
= msg
- start
;
899 msg
= format_subject(NULL
, msg
, NULL
);
900 msg
= skip_empty_lines(msg
);
901 c
->body_off
= msg
- start
;
903 c
->commit_message_parsed
= 1;
906 static void format_decoration(struct strbuf
*sb
, const struct commit
*commit
)
908 struct name_decoration
*d
;
909 const char *prefix
= " (";
911 load_ref_decorations(DECORATE_SHORT_REFS
);
912 d
= lookup_decoration(&name_decoration
, &commit
->object
);
914 strbuf_addstr(sb
, prefix
);
916 strbuf_addstr(sb
, d
->name
);
919 if (prefix
[0] == ',')
920 strbuf_addch(sb
, ')');
923 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
924 size_t width
, size_t indent1
, size_t indent2
)
926 struct strbuf tmp
= STRBUF_INIT
;
929 strbuf_add(&tmp
, sb
->buf
, pos
);
930 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
931 (int) indent1
, (int) indent2
, (int) width
);
932 strbuf_swap(&tmp
, sb
);
933 strbuf_release(&tmp
);
936 static void rewrap_message_tail(struct strbuf
*sb
,
937 struct format_commit_context
*c
,
938 size_t new_width
, size_t new_indent1
,
941 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
942 c
->indent2
== new_indent2
)
944 if (c
->wrap_start
< sb
->len
)
945 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
946 c
->wrap_start
= sb
->len
;
947 c
->width
= new_width
;
948 c
->indent1
= new_indent1
;
949 c
->indent2
= new_indent2
;
955 } signature_check
[] = {
956 { 'G', "\n[GNUPG:] GOODSIG " },
957 { 'B', "\n[GNUPG:] BADSIG " },
960 static void parse_signature_lines(struct format_commit_context
*ctx
)
962 const char *buf
= ctx
->signature
.gpg_status
;
965 for (i
= 0; i
< ARRAY_SIZE(signature_check
); i
++) {
966 const char *found
= strstr(buf
, signature_check
[i
].check
);
970 ctx
->signature
.good_bad
= signature_check
[i
].result
;
971 found
+= strlen(signature_check
[i
].check
);
972 ctx
->signature
.key
= xmemdupz(found
, 16);
974 next
= strchrnul(found
, '\n');
975 ctx
->signature
.signer
= xmemdupz(found
, next
- found
);
980 static void parse_commit_signature(struct format_commit_context
*ctx
)
982 struct strbuf payload
= STRBUF_INIT
;
983 struct strbuf signature
= STRBUF_INIT
;
984 struct strbuf gpg_output
= STRBUF_INIT
;
985 struct strbuf gpg_status
= STRBUF_INIT
;
988 ctx
->commit_signature_parsed
= 1;
990 if (parse_signed_commit(ctx
->commit
->object
.sha1
,
991 &payload
, &signature
) <= 0)
993 status
= verify_signed_buffer(payload
.buf
, payload
.len
,
994 signature
.buf
, signature
.len
,
995 &gpg_output
, &gpg_status
);
996 if (status
&& !gpg_output
.len
)
998 ctx
->signature
.gpg_output
= strbuf_detach(&gpg_output
, NULL
);
999 ctx
->signature
.gpg_status
= strbuf_detach(&gpg_status
, NULL
);
1000 parse_signature_lines(ctx
);
1003 strbuf_release(&gpg_status
);
1004 strbuf_release(&gpg_output
);
1005 strbuf_release(&payload
);
1006 strbuf_release(&signature
);
1010 static int format_reflog_person(struct strbuf
*sb
,
1012 struct reflog_walk_info
*log
,
1013 enum date_mode dmode
)
1020 ident
= get_reflog_ident(log
);
1024 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
1027 static size_t format_commit_one(struct strbuf
*sb
, const char *placeholder
,
1030 struct format_commit_context
*c
= context
;
1031 const struct commit
*commit
= c
->commit
;
1032 const char *msg
= c
->message
;
1033 struct commit_list
*p
;
1036 /* these are independent of the commit */
1037 switch (placeholder
[0]) {
1039 if (placeholder
[1] == '(') {
1040 const char *begin
= placeholder
+ 2;
1041 const char *end
= strchr(begin
, ')');
1042 char color
[COLOR_MAXLEN
];
1046 if (!prefixcmp(begin
, "auto,")) {
1047 if (!want_color(c
->pretty_ctx
->color
))
1048 return end
- placeholder
+ 1;
1051 color_parse_mem(begin
,
1053 "--pretty format", color
);
1054 strbuf_addstr(sb
, color
);
1055 return end
- placeholder
+ 1;
1057 if (!prefixcmp(placeholder
+ 1, "red")) {
1058 strbuf_addstr(sb
, GIT_COLOR_RED
);
1060 } else if (!prefixcmp(placeholder
+ 1, "green")) {
1061 strbuf_addstr(sb
, GIT_COLOR_GREEN
);
1063 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
1064 strbuf_addstr(sb
, GIT_COLOR_BLUE
);
1066 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
1067 strbuf_addstr(sb
, GIT_COLOR_RESET
);
1071 case 'n': /* newline */
1072 strbuf_addch(sb
, '\n');
1075 /* %x00 == NUL, %x0a == LF, etc. */
1076 if (0 <= (h1
= hexval_table
[0xff & placeholder
[1]]) &&
1078 0 <= (h2
= hexval_table
[0xff & placeholder
[2]]) &&
1080 strbuf_addch(sb
, (h1
<<4)|h2
);
1085 if (placeholder
[1] == '(') {
1086 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1088 const char *start
= placeholder
+ 2;
1089 const char *end
= strchr(start
, ')');
1093 width
= strtoul(start
, &next
, 10);
1095 indent1
= strtoul(next
+ 1, &next
, 10);
1097 indent2
= strtoul(next
+ 1,
1104 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1105 return end
- placeholder
+ 1;
1110 /* these depend on the commit */
1111 if (!commit
->object
.parsed
)
1112 parse_object(commit
->object
.sha1
);
1114 switch (placeholder
[0]) {
1115 case 'H': /* commit hash */
1116 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
1118 case 'h': /* abbreviated commit hash */
1119 if (add_again(sb
, &c
->abbrev_commit_hash
))
1121 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
1122 c
->pretty_ctx
->abbrev
));
1123 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
1125 case 'T': /* tree hash */
1126 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
1128 case 't': /* abbreviated tree hash */
1129 if (add_again(sb
, &c
->abbrev_tree_hash
))
1131 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
1132 c
->pretty_ctx
->abbrev
));
1133 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
1135 case 'P': /* parent hashes */
1136 for (p
= commit
->parents
; p
; p
= p
->next
) {
1137 if (p
!= commit
->parents
)
1138 strbuf_addch(sb
, ' ');
1139 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
1142 case 'p': /* abbreviated parent hashes */
1143 if (add_again(sb
, &c
->abbrev_parent_hashes
))
1145 for (p
= commit
->parents
; p
; p
= p
->next
) {
1146 if (p
!= commit
->parents
)
1147 strbuf_addch(sb
, ' ');
1148 strbuf_addstr(sb
, find_unique_abbrev(
1149 p
->item
->object
.sha1
,
1150 c
->pretty_ctx
->abbrev
));
1152 c
->abbrev_parent_hashes
.len
= sb
->len
-
1153 c
->abbrev_parent_hashes
.off
;
1155 case 'm': /* left/right/bottom */
1156 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1159 format_decoration(sb
, commit
);
1161 case 'g': /* reflog info */
1162 switch(placeholder
[1]) {
1163 case 'd': /* reflog selector */
1165 if (c
->pretty_ctx
->reflog_info
)
1166 get_reflog_selector(sb
,
1167 c
->pretty_ctx
->reflog_info
,
1168 c
->pretty_ctx
->date_mode
,
1169 c
->pretty_ctx
->date_mode_explicit
,
1170 (placeholder
[1] == 'd'));
1172 case 's': /* reflog message */
1173 if (c
->pretty_ctx
->reflog_info
)
1174 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1180 return format_reflog_person(sb
,
1182 c
->pretty_ctx
->reflog_info
,
1183 c
->pretty_ctx
->date_mode
);
1185 return 0; /* unknown %g placeholder */
1187 if (c
->pretty_ctx
->notes_message
) {
1188 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1194 if (placeholder
[0] == 'G') {
1195 if (!c
->commit_signature_parsed
)
1196 parse_commit_signature(c
);
1197 switch (placeholder
[1]) {
1199 if (c
->signature
.gpg_output
)
1200 strbuf_addstr(sb
, c
->signature
.gpg_output
);
1203 switch (c
->signature
.good_bad
) {
1206 strbuf_addch(sb
, c
->signature
.good_bad
);
1210 if (c
->signature
.signer
)
1211 strbuf_addstr(sb
, c
->signature
.signer
);
1214 if (c
->signature
.key
)
1215 strbuf_addstr(sb
, c
->signature
.key
);
1222 /* For the rest we have to parse the commit header. */
1223 if (!c
->commit_header_parsed
)
1224 parse_commit_header(c
);
1226 switch (placeholder
[0]) {
1227 case 'a': /* author ... */
1228 return format_person_part(sb
, placeholder
[1],
1229 msg
+ c
->author
.off
, c
->author
.len
,
1230 c
->pretty_ctx
->date_mode
);
1231 case 'c': /* committer ... */
1232 return format_person_part(sb
, placeholder
[1],
1233 msg
+ c
->committer
.off
, c
->committer
.len
,
1234 c
->pretty_ctx
->date_mode
);
1235 case 'e': /* encoding */
1236 strbuf_add(sb
, msg
+ c
->encoding
.off
, c
->encoding
.len
);
1238 case 'B': /* raw body */
1239 /* message_off is always left at the initial newline */
1240 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1244 /* Now we need to parse the commit message. */
1245 if (!c
->commit_message_parsed
)
1246 parse_commit_message(c
);
1248 switch (placeholder
[0]) {
1249 case 's': /* subject */
1250 format_subject(sb
, msg
+ c
->subject_off
, " ");
1252 case 'f': /* sanitized subject */
1253 format_sanitized_subject(sb
, msg
+ c
->subject_off
);
1255 case 'b': /* body */
1256 strbuf_addstr(sb
, msg
+ c
->body_off
);
1259 return 0; /* unknown placeholder */
1262 static size_t format_commit_item(struct strbuf
*sb
, const char *placeholder
,
1269 ADD_LF_BEFORE_NON_EMPTY
,
1270 DEL_LF_BEFORE_EMPTY
,
1271 ADD_SP_BEFORE_NON_EMPTY
1274 switch (placeholder
[0]) {
1276 magic
= DEL_LF_BEFORE_EMPTY
;
1279 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1282 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1287 if (magic
!= NO_MAGIC
)
1291 consumed
= format_commit_one(sb
, placeholder
, context
);
1292 if (magic
== NO_MAGIC
)
1295 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1296 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1297 strbuf_setlen(sb
, sb
->len
- 1);
1298 } else if (orig_len
!= sb
->len
) {
1299 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1300 strbuf_insert(sb
, orig_len
, "\n", 1);
1301 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1302 strbuf_insert(sb
, orig_len
, " ", 1);
1304 return consumed
+ 1;
1307 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1310 struct userformat_want
*w
= context
;
1312 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1315 switch (*placeholder
) {
1323 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1325 struct strbuf dummy
= STRBUF_INIT
;
1332 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1333 strbuf_release(&dummy
);
1336 void format_commit_message(const struct commit
*commit
,
1337 const char *format
, struct strbuf
*sb
,
1338 const struct pretty_print_context
*pretty_ctx
)
1340 struct format_commit_context context
;
1341 const char *output_enc
= pretty_ctx
->output_encoding
;
1343 memset(&context
, 0, sizeof(context
));
1344 context
.commit
= commit
;
1345 context
.pretty_ctx
= pretty_ctx
;
1346 context
.wrap_start
= sb
->len
;
1347 context
.message
= logmsg_reencode(commit
, output_enc
);
1349 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1350 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1352 logmsg_free(context
.message
, commit
);
1353 free(context
.signature
.gpg_output
);
1354 free(context
.signature
.signer
);
1357 static void pp_header(const struct pretty_print_context
*pp
,
1358 const char *encoding
,
1359 const struct commit
*commit
,
1363 int parents_shown
= 0;
1366 const char *line
= *msg_p
;
1367 int linelen
= get_one_line(*msg_p
);
1377 if (pp
->fmt
== CMIT_FMT_RAW
) {
1378 strbuf_add(sb
, line
, linelen
);
1382 if (!prefixcmp(line
, "parent ")) {
1384 die("bad parent line in commit");
1388 if (!parents_shown
) {
1389 struct commit_list
*parent
;
1391 for (parent
= commit
->parents
, num
= 0;
1393 parent
= parent
->next
, num
++)
1395 /* with enough slop */
1396 strbuf_grow(sb
, num
* 50 + 20);
1397 add_merge_info(pp
, sb
, commit
);
1402 * MEDIUM == DEFAULT shows only author with dates.
1403 * FULL shows both authors but not dates.
1404 * FULLER shows both authors and dates.
1406 if (!prefixcmp(line
, "author ")) {
1407 strbuf_grow(sb
, linelen
+ 80);
1408 pp_user_info(pp
, "Author", sb
, line
+ 7, encoding
);
1410 if (!prefixcmp(line
, "committer ") &&
1411 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1412 strbuf_grow(sb
, linelen
+ 80);
1413 pp_user_info(pp
, "Commit", sb
, line
+ 10, encoding
);
1418 void pp_title_line(const struct pretty_print_context
*pp
,
1421 const char *encoding
,
1424 static const int max_length
= 78; /* per rfc2047 */
1425 struct strbuf title
;
1427 strbuf_init(&title
, 80);
1428 *msg_p
= format_subject(&title
, *msg_p
,
1429 pp
->preserve_subject
? "\n" : " ");
1431 strbuf_grow(sb
, title
.len
+ 1024);
1433 strbuf_addstr(sb
, pp
->subject
);
1434 if (needs_rfc2047_encoding(title
.buf
, title
.len
, RFC2047_SUBJECT
))
1435 add_rfc2047(sb
, title
.buf
, title
.len
,
1436 encoding
, RFC2047_SUBJECT
);
1438 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
1439 -last_line_length(sb
), 1, max_length
);
1441 strbuf_addbuf(sb
, &title
);
1443 strbuf_addch(sb
, '\n');
1445 if (need_8bit_cte
> 0) {
1446 const char *header_fmt
=
1447 "MIME-Version: 1.0\n"
1448 "Content-Type: text/plain; charset=%s\n"
1449 "Content-Transfer-Encoding: 8bit\n";
1450 strbuf_addf(sb
, header_fmt
, encoding
);
1452 if (pp
->after_subject
) {
1453 strbuf_addstr(sb
, pp
->after_subject
);
1455 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
1456 strbuf_addch(sb
, '\n');
1458 strbuf_release(&title
);
1461 void pp_remainder(const struct pretty_print_context
*pp
,
1468 const char *line
= *msg_p
;
1469 int linelen
= get_one_line(line
);
1475 if (is_empty_line(line
, &linelen
)) {
1478 if (pp
->fmt
== CMIT_FMT_SHORT
)
1483 strbuf_grow(sb
, linelen
+ indent
+ 20);
1485 memset(sb
->buf
+ sb
->len
, ' ', indent
);
1486 strbuf_setlen(sb
, sb
->len
+ indent
);
1488 strbuf_add(sb
, line
, linelen
);
1489 strbuf_addch(sb
, '\n');
1493 void pretty_print_commit(const struct pretty_print_context
*pp
,
1494 const struct commit
*commit
,
1497 unsigned long beginning_of_body
;
1501 const char *encoding
;
1502 int need_8bit_cte
= pp
->need_8bit_cte
;
1504 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
1505 format_commit_message(commit
, user_format
, sb
, pp
);
1509 encoding
= get_log_output_encoding();
1510 msg
= reencoded
= logmsg_reencode(commit
, encoding
);
1512 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1516 * We need to check and emit Content-type: to mark it
1517 * as 8-bit if we haven't done so.
1519 if (pp
->fmt
== CMIT_FMT_EMAIL
&& need_8bit_cte
== 0) {
1522 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
1524 /* author could be non 7-bit ASCII but
1525 * the log may be so; skip over the
1526 * header part first.
1528 if (ch
== '\n' && msg
[i
+1] == '\n')
1531 else if (non_ascii(ch
)) {
1538 pp_header(pp
, encoding
, commit
, &msg
, sb
);
1539 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->subject
) {
1540 strbuf_addch(sb
, '\n');
1543 /* Skip excess blank lines at the beginning of body, if any... */
1544 msg
= skip_empty_lines(msg
);
1546 /* These formats treat the title line specially. */
1547 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1548 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
1550 beginning_of_body
= sb
->len
;
1551 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1552 pp_remainder(pp
, &msg
, sb
, indent
);
1555 /* Make sure there is an EOLN for the non-oneline case */
1556 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1557 strbuf_addch(sb
, '\n');
1560 * The caller may append additional body text in e-mail
1561 * format. Make sure we did not strip the blank line
1562 * between the header and the body.
1564 if (pp
->fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
1565 strbuf_addch(sb
, '\n');
1567 logmsg_free(reencoded
, commit
);
1570 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
1573 struct pretty_print_context pp
= {0};
1575 pretty_print_commit(&pp
, commit
, sb
);