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
, int 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? */
358 for (i
= 0; i
< len
; i
++) {
359 unsigned ch
= line
[i
] & 0xFF;
360 int is_special
= is_rfc2047_special(ch
, type
);
363 * According to RFC 2047, we could encode the special character
364 * ' ' (space) with '_' (underscore) for readability. But many
365 * programs do not understand this and just leave the
366 * underscore in place. Thus, we do nothing special here, which
367 * causes ' ' to be encoded as '=20', avoiding this problem.
370 if (line_len
+ 2 + (is_special
? 3 : 1) > max_encoded_length
) {
371 strbuf_addf(sb
, "?=\n =?%s?q?", encoding
);
372 line_len
= strlen(encoding
) + 5 + 1; /* =??q? plus SP */
376 strbuf_addf(sb
, "=%02X", ch
);
379 strbuf_addch(sb
, ch
);
383 strbuf_addstr(sb
, "?=");
386 void pp_user_info(const struct pretty_print_context
*pp
,
387 const char *what
, struct strbuf
*sb
,
388 const char *line
, const char *encoding
)
390 struct ident_split ident
;
391 int linelen
, namelen
;
392 char *line_end
, *date
;
393 int max_length
= 78; /* per rfc2822 */
397 if (pp
->fmt
== CMIT_FMT_ONELINE
)
400 line_end
= strchr(line
, '\n');
402 line_end
= strchr(line
, '\0');
407 linelen
= ++line_end
- line
;
408 if (split_ident_line(&ident
, line
, linelen
))
411 namelen
= ident
.mail_end
- ident
.name_begin
+ 1;
412 time
= strtoul(ident
.date_begin
, &date
, 10);
413 tz
= strtol(date
, NULL
, 10);
415 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
416 int display_name_length
;
418 display_name_length
= ident
.name_end
- ident
.name_begin
;
420 strbuf_addstr(sb
, "From: ");
421 if (needs_rfc2047_encoding(line
, display_name_length
, RFC2047_ADDRESS
)) {
422 add_rfc2047(sb
, line
, display_name_length
,
423 encoding
, RFC2047_ADDRESS
);
424 max_length
= 76; /* per rfc2047 */
425 } else if (needs_rfc822_quoting(line
, display_name_length
)) {
426 struct strbuf quoted
= STRBUF_INIT
;
427 add_rfc822_quoted("ed
, line
, display_name_length
);
428 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
430 strbuf_release("ed
);
432 strbuf_add_wrapped_bytes(sb
, line
, display_name_length
,
435 if (namelen
- display_name_length
+ last_line_length(sb
) > max_length
) {
436 strbuf_addch(sb
, '\n');
437 if (!isspace(ident
.name_end
[0]))
438 strbuf_addch(sb
, ' ');
440 strbuf_add(sb
, ident
.name_end
, namelen
- display_name_length
);
441 strbuf_addch(sb
, '\n');
443 strbuf_addf(sb
, "%s: %.*s%.*s\n", what
,
444 (pp
->fmt
== CMIT_FMT_FULLER
) ? 4 : 0,
448 case CMIT_FMT_MEDIUM
:
449 strbuf_addf(sb
, "Date: %s\n", show_date(time
, tz
, pp
->date_mode
));
452 strbuf_addf(sb
, "Date: %s\n", show_date(time
, tz
, DATE_RFC2822
));
454 case CMIT_FMT_FULLER
:
455 strbuf_addf(sb
, "%sDate: %s\n", what
, show_date(time
, tz
, pp
->date_mode
));
463 static int is_empty_line(const char *line
, int *len_p
)
466 while (len
&& isspace(line
[len
-1]))
472 static const char *skip_empty_lines(const char *msg
)
475 int linelen
= get_one_line(msg
);
479 if (!is_empty_line(msg
, &ll
))
486 static void add_merge_info(const struct pretty_print_context
*pp
,
487 struct strbuf
*sb
, const struct commit
*commit
)
489 struct commit_list
*parent
= commit
->parents
;
491 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (pp
->fmt
== CMIT_FMT_EMAIL
) ||
492 !parent
|| !parent
->next
)
495 strbuf_addstr(sb
, "Merge:");
498 struct commit
*p
= parent
->item
;
499 const char *hex
= NULL
;
501 hex
= find_unique_abbrev(p
->object
.sha1
, pp
->abbrev
);
503 hex
= sha1_to_hex(p
->object
.sha1
);
504 parent
= parent
->next
;
506 strbuf_addf(sb
, " %s", hex
);
508 strbuf_addch(sb
, '\n');
511 static char *get_header(const struct commit
*commit
, const char *key
)
513 int key_len
= strlen(key
);
514 const char *line
= commit
->buffer
;
517 const char *eol
= strchr(line
, '\n'), *next
;
522 warning("malformed commit (header is missing newline): %s",
523 sha1_to_hex(commit
->object
.sha1
));
524 eol
= line
+ strlen(line
);
528 if (eol
- line
> key_len
&&
529 !strncmp(line
, key
, key_len
) &&
530 line
[key_len
] == ' ') {
531 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
538 static char *replace_encoding_header(char *buf
, const char *encoding
)
540 struct strbuf tmp
= STRBUF_INIT
;
544 /* guess if there is an encoding header before a \n\n */
545 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
546 cp
= strchr(cp
, '\n');
547 if (!cp
|| *++cp
== '\n')
551 cp
= strchr(cp
, '\n');
553 return buf
; /* should not happen but be defensive */
554 len
= cp
+ 1 - (buf
+ start
);
556 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
557 if (is_encoding_utf8(encoding
)) {
558 /* we have re-coded to UTF-8; drop the header */
559 strbuf_remove(&tmp
, start
, len
);
561 /* just replaces XXXX in 'encoding XXXX\n' */
562 strbuf_splice(&tmp
, start
+ strlen("encoding "),
563 len
- strlen("encoding \n"),
564 encoding
, strlen(encoding
));
566 return strbuf_detach(&tmp
, NULL
);
569 char *logmsg_reencode(const struct commit
*commit
,
570 const char *output_encoding
)
572 static const char *utf8
= "UTF-8";
573 const char *use_encoding
;
577 if (!*output_encoding
)
579 encoding
= get_header(commit
, "encoding");
580 use_encoding
= encoding
? encoding
: utf8
;
581 if (same_encoding(use_encoding
, output_encoding
))
582 if (encoding
) /* we'll strip encoding header later */
583 out
= xstrdup(commit
->buffer
);
585 return NULL
; /* nothing to do */
587 out
= reencode_string(commit
->buffer
,
588 output_encoding
, use_encoding
);
590 out
= replace_encoding_header(out
, output_encoding
);
596 static int mailmap_name(char *email
, int email_len
, char *name
, int name_len
)
598 static struct string_list
*mail_map
;
600 mail_map
= xcalloc(1, sizeof(*mail_map
));
601 read_mailmap(mail_map
, NULL
);
603 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
606 static size_t format_person_part(struct strbuf
*sb
, char part
,
607 const char *msg
, int len
, enum date_mode dmode
)
609 /* currently all placeholders have same length */
610 const int placeholder_len
= 2;
612 unsigned long date
= 0;
613 char person_name
[1024];
614 char person_mail
[1024];
615 struct ident_split s
;
616 const char *name_start
, *name_end
, *mail_start
, *mail_end
;
618 if (split_ident_line(&s
, msg
, len
) < 0)
621 name_start
= s
.name_begin
;
622 name_end
= s
.name_end
;
623 mail_start
= s
.mail_begin
;
624 mail_end
= s
.mail_end
;
626 if (part
== 'N' || part
== 'E') { /* mailmap lookup */
627 snprintf(person_name
, sizeof(person_name
), "%.*s",
628 (int)(name_end
- name_start
), name_start
);
629 snprintf(person_mail
, sizeof(person_mail
), "%.*s",
630 (int)(mail_end
- mail_start
), mail_start
);
631 mailmap_name(person_mail
, sizeof(person_mail
), person_name
, sizeof(person_name
));
632 name_start
= person_name
;
633 name_end
= name_start
+ strlen(person_name
);
634 mail_start
= person_mail
;
635 mail_end
= mail_start
+ strlen(person_mail
);
637 if (part
== 'n' || part
== 'N') { /* name */
638 strbuf_add(sb
, name_start
, name_end
-name_start
);
639 return placeholder_len
;
641 if (part
== 'e' || part
== 'E') { /* email */
642 strbuf_add(sb
, mail_start
, mail_end
-mail_start
);
643 return placeholder_len
;
649 date
= strtoul(s
.date_begin
, NULL
, 10);
651 if (part
== 't') { /* date, UNIX timestamp */
652 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
653 return placeholder_len
;
657 tz
= strtoul(s
.tz_begin
+ 1, NULL
, 10);
658 if (*s
.tz_begin
== '-')
663 strbuf_addstr(sb
, show_date(date
, tz
, dmode
));
664 return placeholder_len
;
665 case 'D': /* date, RFC2822 style */
666 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RFC2822
));
667 return placeholder_len
;
668 case 'r': /* date, relative */
669 strbuf_addstr(sb
, show_date(date
, tz
, DATE_RELATIVE
));
670 return placeholder_len
;
671 case 'i': /* date, ISO 8601 */
672 strbuf_addstr(sb
, show_date(date
, tz
, DATE_ISO8601
));
673 return placeholder_len
;
678 * reading from either a bogus commit, or a reflog entry with
679 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
680 * to compute a valid return value.
682 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
683 || part
== 'D' || part
== 'r' || part
== 'i')
684 return placeholder_len
;
686 return 0; /* unknown placeholder */
694 struct format_commit_context
{
695 const struct commit
*commit
;
696 const struct pretty_print_context
*pretty_ctx
;
697 unsigned commit_header_parsed
:1;
698 unsigned commit_message_parsed
:1;
699 unsigned commit_signature_parsed
:1;
706 size_t width
, indent1
, indent2
;
708 /* These offsets are relative to the start of the commit message. */
710 struct chunk committer
;
711 struct chunk encoding
;
716 /* The following ones are relative to the result struct strbuf. */
717 struct chunk abbrev_commit_hash
;
718 struct chunk abbrev_tree_hash
;
719 struct chunk abbrev_parent_hashes
;
723 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
726 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
731 * We haven't seen this chunk before. Our caller is surely
732 * going to add it the hard way now. Remember the most likely
733 * start of the to-be-added chunk: the current end of the
736 chunk
->off
= sb
->len
;
740 static void parse_commit_header(struct format_commit_context
*context
)
742 const char *msg
= context
->message
;
745 for (i
= 0; msg
[i
]; i
++) {
747 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
752 } else if (!prefixcmp(msg
+ i
, "author ")) {
753 context
->author
.off
= i
+ 7;
754 context
->author
.len
= eol
- i
- 7;
755 } else if (!prefixcmp(msg
+ i
, "committer ")) {
756 context
->committer
.off
= i
+ 10;
757 context
->committer
.len
= eol
- i
- 10;
758 } else if (!prefixcmp(msg
+ i
, "encoding ")) {
759 context
->encoding
.off
= i
+ 9;
760 context
->encoding
.len
= eol
- i
- 9;
764 context
->message_off
= i
;
765 context
->commit_header_parsed
= 1;
768 static int istitlechar(char c
)
770 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
771 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
774 static void format_sanitized_subject(struct strbuf
*sb
, const char *msg
)
777 size_t start_len
= sb
->len
;
780 for (; *msg
&& *msg
!= '\n'; msg
++) {
781 if (istitlechar(*msg
)) {
783 strbuf_addch(sb
, '-');
785 strbuf_addch(sb
, *msg
);
787 while (*(msg
+1) == '.')
793 /* trim any trailing '.' or '-' characters */
795 while (sb
->len
- trimlen
> start_len
&&
796 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
797 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
799 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
802 const char *format_subject(struct strbuf
*sb
, const char *msg
,
803 const char *line_separator
)
808 const char *line
= msg
;
809 int linelen
= get_one_line(line
);
812 if (!linelen
|| is_empty_line(line
, &linelen
))
817 strbuf_grow(sb
, linelen
+ 2);
819 strbuf_addstr(sb
, line_separator
);
820 strbuf_add(sb
, line
, linelen
);
826 static void parse_commit_message(struct format_commit_context
*c
)
828 const char *msg
= c
->message
+ c
->message_off
;
829 const char *start
= c
->message
;
831 msg
= skip_empty_lines(msg
);
832 c
->subject_off
= msg
- start
;
834 msg
= format_subject(NULL
, msg
, NULL
);
835 msg
= skip_empty_lines(msg
);
836 c
->body_off
= msg
- start
;
838 c
->commit_message_parsed
= 1;
841 static void format_decoration(struct strbuf
*sb
, const struct commit
*commit
)
843 struct name_decoration
*d
;
844 const char *prefix
= " (";
846 load_ref_decorations(DECORATE_SHORT_REFS
);
847 d
= lookup_decoration(&name_decoration
, &commit
->object
);
849 strbuf_addstr(sb
, prefix
);
851 strbuf_addstr(sb
, d
->name
);
854 if (prefix
[0] == ',')
855 strbuf_addch(sb
, ')');
858 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
859 size_t width
, size_t indent1
, size_t indent2
)
861 struct strbuf tmp
= STRBUF_INIT
;
864 strbuf_add(&tmp
, sb
->buf
, pos
);
865 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
866 (int) indent1
, (int) indent2
, (int) width
);
867 strbuf_swap(&tmp
, sb
);
868 strbuf_release(&tmp
);
871 static void rewrap_message_tail(struct strbuf
*sb
,
872 struct format_commit_context
*c
,
873 size_t new_width
, size_t new_indent1
,
876 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
877 c
->indent2
== new_indent2
)
879 if (c
->wrap_start
< sb
->len
)
880 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
881 c
->wrap_start
= sb
->len
;
882 c
->width
= new_width
;
883 c
->indent1
= new_indent1
;
884 c
->indent2
= new_indent2
;
890 } signature_check
[] = {
891 { 'G', ": Good signature from " },
892 { 'B', ": BAD signature from " },
895 static void parse_signature_lines(struct format_commit_context
*ctx
)
897 const char *buf
= ctx
->signature
.gpg_output
;
900 for (i
= 0; i
< ARRAY_SIZE(signature_check
); i
++) {
901 const char *found
= strstr(buf
, signature_check
[i
].check
);
905 ctx
->signature
.good_bad
= signature_check
[i
].result
;
906 found
+= strlen(signature_check
[i
].check
);
907 next
= strchrnul(found
, '\n');
908 ctx
->signature
.signer
= xmemdupz(found
, next
- found
);
913 static void parse_commit_signature(struct format_commit_context
*ctx
)
915 struct strbuf payload
= STRBUF_INIT
;
916 struct strbuf signature
= STRBUF_INIT
;
917 struct strbuf gpg_output
= STRBUF_INIT
;
920 ctx
->commit_signature_parsed
= 1;
922 if (parse_signed_commit(ctx
->commit
->object
.sha1
,
923 &payload
, &signature
) <= 0)
925 status
= verify_signed_buffer(payload
.buf
, payload
.len
,
926 signature
.buf
, signature
.len
,
928 if (status
&& !gpg_output
.len
)
930 ctx
->signature
.gpg_output
= strbuf_detach(&gpg_output
, NULL
);
931 parse_signature_lines(ctx
);
934 strbuf_release(&gpg_output
);
935 strbuf_release(&payload
);
936 strbuf_release(&signature
);
940 static int format_reflog_person(struct strbuf
*sb
,
942 struct reflog_walk_info
*log
,
943 enum date_mode dmode
)
950 ident
= get_reflog_ident(log
);
954 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
957 static size_t format_commit_one(struct strbuf
*sb
, const char *placeholder
,
960 struct format_commit_context
*c
= context
;
961 const struct commit
*commit
= c
->commit
;
962 const char *msg
= c
->message
;
963 struct commit_list
*p
;
966 /* these are independent of the commit */
967 switch (placeholder
[0]) {
969 if (placeholder
[1] == '(') {
970 const char *end
= strchr(placeholder
+ 2, ')');
971 char color
[COLOR_MAXLEN
];
974 color_parse_mem(placeholder
+ 2,
975 end
- (placeholder
+ 2),
976 "--pretty format", color
);
977 strbuf_addstr(sb
, color
);
978 return end
- placeholder
+ 1;
980 if (!prefixcmp(placeholder
+ 1, "red")) {
981 strbuf_addstr(sb
, GIT_COLOR_RED
);
983 } else if (!prefixcmp(placeholder
+ 1, "green")) {
984 strbuf_addstr(sb
, GIT_COLOR_GREEN
);
986 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
987 strbuf_addstr(sb
, GIT_COLOR_BLUE
);
989 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
990 strbuf_addstr(sb
, GIT_COLOR_RESET
);
994 case 'n': /* newline */
995 strbuf_addch(sb
, '\n');
998 /* %x00 == NUL, %x0a == LF, etc. */
999 if (0 <= (h1
= hexval_table
[0xff & placeholder
[1]]) &&
1001 0 <= (h2
= hexval_table
[0xff & placeholder
[2]]) &&
1003 strbuf_addch(sb
, (h1
<<4)|h2
);
1008 if (placeholder
[1] == '(') {
1009 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1011 const char *start
= placeholder
+ 2;
1012 const char *end
= strchr(start
, ')');
1016 width
= strtoul(start
, &next
, 10);
1018 indent1
= strtoul(next
+ 1, &next
, 10);
1020 indent2
= strtoul(next
+ 1,
1027 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1028 return end
- placeholder
+ 1;
1033 /* these depend on the commit */
1034 if (!commit
->object
.parsed
)
1035 parse_object(commit
->object
.sha1
);
1037 switch (placeholder
[0]) {
1038 case 'H': /* commit hash */
1039 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
1041 case 'h': /* abbreviated commit hash */
1042 if (add_again(sb
, &c
->abbrev_commit_hash
))
1044 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
1045 c
->pretty_ctx
->abbrev
));
1046 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
1048 case 'T': /* tree hash */
1049 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
1051 case 't': /* abbreviated tree hash */
1052 if (add_again(sb
, &c
->abbrev_tree_hash
))
1054 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
1055 c
->pretty_ctx
->abbrev
));
1056 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
1058 case 'P': /* parent hashes */
1059 for (p
= commit
->parents
; p
; p
= p
->next
) {
1060 if (p
!= commit
->parents
)
1061 strbuf_addch(sb
, ' ');
1062 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
1065 case 'p': /* abbreviated parent hashes */
1066 if (add_again(sb
, &c
->abbrev_parent_hashes
))
1068 for (p
= commit
->parents
; p
; p
= p
->next
) {
1069 if (p
!= commit
->parents
)
1070 strbuf_addch(sb
, ' ');
1071 strbuf_addstr(sb
, find_unique_abbrev(
1072 p
->item
->object
.sha1
,
1073 c
->pretty_ctx
->abbrev
));
1075 c
->abbrev_parent_hashes
.len
= sb
->len
-
1076 c
->abbrev_parent_hashes
.off
;
1078 case 'm': /* left/right/bottom */
1079 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1082 format_decoration(sb
, commit
);
1084 case 'g': /* reflog info */
1085 switch(placeholder
[1]) {
1086 case 'd': /* reflog selector */
1088 if (c
->pretty_ctx
->reflog_info
)
1089 get_reflog_selector(sb
,
1090 c
->pretty_ctx
->reflog_info
,
1091 c
->pretty_ctx
->date_mode
,
1092 c
->pretty_ctx
->date_mode_explicit
,
1093 (placeholder
[1] == 'd'));
1095 case 's': /* reflog message */
1096 if (c
->pretty_ctx
->reflog_info
)
1097 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1103 return format_reflog_person(sb
,
1105 c
->pretty_ctx
->reflog_info
,
1106 c
->pretty_ctx
->date_mode
);
1108 return 0; /* unknown %g placeholder */
1110 if (c
->pretty_ctx
->notes_message
) {
1111 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1117 if (placeholder
[0] == 'G') {
1118 if (!c
->commit_signature_parsed
)
1119 parse_commit_signature(c
);
1120 switch (placeholder
[1]) {
1122 if (c
->signature
.gpg_output
)
1123 strbuf_addstr(sb
, c
->signature
.gpg_output
);
1126 switch (c
->signature
.good_bad
) {
1129 strbuf_addch(sb
, c
->signature
.good_bad
);
1133 if (c
->signature
.signer
)
1134 strbuf_addstr(sb
, c
->signature
.signer
);
1141 /* For the rest we have to parse the commit header. */
1142 if (!c
->commit_header_parsed
)
1143 parse_commit_header(c
);
1145 switch (placeholder
[0]) {
1146 case 'a': /* author ... */
1147 return format_person_part(sb
, placeholder
[1],
1148 msg
+ c
->author
.off
, c
->author
.len
,
1149 c
->pretty_ctx
->date_mode
);
1150 case 'c': /* committer ... */
1151 return format_person_part(sb
, placeholder
[1],
1152 msg
+ c
->committer
.off
, c
->committer
.len
,
1153 c
->pretty_ctx
->date_mode
);
1154 case 'e': /* encoding */
1155 strbuf_add(sb
, msg
+ c
->encoding
.off
, c
->encoding
.len
);
1157 case 'B': /* raw body */
1158 /* message_off is always left at the initial newline */
1159 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1163 /* Now we need to parse the commit message. */
1164 if (!c
->commit_message_parsed
)
1165 parse_commit_message(c
);
1167 switch (placeholder
[0]) {
1168 case 's': /* subject */
1169 format_subject(sb
, msg
+ c
->subject_off
, " ");
1171 case 'f': /* sanitized subject */
1172 format_sanitized_subject(sb
, msg
+ c
->subject_off
);
1174 case 'b': /* body */
1175 strbuf_addstr(sb
, msg
+ c
->body_off
);
1178 return 0; /* unknown placeholder */
1181 static size_t format_commit_item(struct strbuf
*sb
, const char *placeholder
,
1188 ADD_LF_BEFORE_NON_EMPTY
,
1189 DEL_LF_BEFORE_EMPTY
,
1190 ADD_SP_BEFORE_NON_EMPTY
1193 switch (placeholder
[0]) {
1195 magic
= DEL_LF_BEFORE_EMPTY
;
1198 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1201 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1206 if (magic
!= NO_MAGIC
)
1210 consumed
= format_commit_one(sb
, placeholder
, context
);
1211 if (magic
== NO_MAGIC
)
1214 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1215 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1216 strbuf_setlen(sb
, sb
->len
- 1);
1217 } else if (orig_len
!= sb
->len
) {
1218 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1219 strbuf_insert(sb
, orig_len
, "\n", 1);
1220 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1221 strbuf_insert(sb
, orig_len
, " ", 1);
1223 return consumed
+ 1;
1226 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1229 struct userformat_want
*w
= context
;
1231 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1234 switch (*placeholder
) {
1242 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1244 struct strbuf dummy
= STRBUF_INIT
;
1251 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1252 strbuf_release(&dummy
);
1255 void format_commit_message(const struct commit
*commit
,
1256 const char *format
, struct strbuf
*sb
,
1257 const struct pretty_print_context
*pretty_ctx
)
1259 struct format_commit_context context
;
1260 static const char utf8
[] = "UTF-8";
1261 const char *output_enc
= pretty_ctx
->output_encoding
;
1263 memset(&context
, 0, sizeof(context
));
1264 context
.commit
= commit
;
1265 context
.pretty_ctx
= pretty_ctx
;
1266 context
.wrap_start
= sb
->len
;
1267 context
.message
= commit
->buffer
;
1269 char *enc
= get_header(commit
, "encoding");
1270 if (strcmp(enc
? enc
: utf8
, output_enc
)) {
1271 context
.message
= logmsg_reencode(commit
, output_enc
);
1272 if (!context
.message
)
1273 context
.message
= commit
->buffer
;
1278 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1279 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1281 if (context
.message
!= commit
->buffer
)
1282 free(context
.message
);
1283 free(context
.signature
.gpg_output
);
1284 free(context
.signature
.signer
);
1287 static void pp_header(const struct pretty_print_context
*pp
,
1288 const char *encoding
,
1289 const struct commit
*commit
,
1293 int parents_shown
= 0;
1296 const char *line
= *msg_p
;
1297 int linelen
= get_one_line(*msg_p
);
1307 if (pp
->fmt
== CMIT_FMT_RAW
) {
1308 strbuf_add(sb
, line
, linelen
);
1312 if (!memcmp(line
, "parent ", 7)) {
1314 die("bad parent line in commit");
1318 if (!parents_shown
) {
1319 struct commit_list
*parent
;
1321 for (parent
= commit
->parents
, num
= 0;
1323 parent
= parent
->next
, num
++)
1325 /* with enough slop */
1326 strbuf_grow(sb
, num
* 50 + 20);
1327 add_merge_info(pp
, sb
, commit
);
1332 * MEDIUM == DEFAULT shows only author with dates.
1333 * FULL shows both authors but not dates.
1334 * FULLER shows both authors and dates.
1336 if (!memcmp(line
, "author ", 7)) {
1337 strbuf_grow(sb
, linelen
+ 80);
1338 pp_user_info(pp
, "Author", sb
, line
+ 7, encoding
);
1340 if (!memcmp(line
, "committer ", 10) &&
1341 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1342 strbuf_grow(sb
, linelen
+ 80);
1343 pp_user_info(pp
, "Commit", sb
, line
+ 10, encoding
);
1348 void pp_title_line(const struct pretty_print_context
*pp
,
1351 const char *encoding
,
1354 static const int max_length
= 78; /* per rfc2047 */
1355 struct strbuf title
;
1357 strbuf_init(&title
, 80);
1358 *msg_p
= format_subject(&title
, *msg_p
,
1359 pp
->preserve_subject
? "\n" : " ");
1361 strbuf_grow(sb
, title
.len
+ 1024);
1363 strbuf_addstr(sb
, pp
->subject
);
1364 if (needs_rfc2047_encoding(title
.buf
, title
.len
, RFC2047_SUBJECT
))
1365 add_rfc2047(sb
, title
.buf
, title
.len
,
1366 encoding
, RFC2047_SUBJECT
);
1368 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
1369 -last_line_length(sb
), 1, max_length
);
1371 strbuf_addbuf(sb
, &title
);
1373 strbuf_addch(sb
, '\n');
1375 if (need_8bit_cte
> 0) {
1376 const char *header_fmt
=
1377 "MIME-Version: 1.0\n"
1378 "Content-Type: text/plain; charset=%s\n"
1379 "Content-Transfer-Encoding: 8bit\n";
1380 strbuf_addf(sb
, header_fmt
, encoding
);
1382 if (pp
->after_subject
) {
1383 strbuf_addstr(sb
, pp
->after_subject
);
1385 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
1386 strbuf_addch(sb
, '\n');
1388 strbuf_release(&title
);
1391 void pp_remainder(const struct pretty_print_context
*pp
,
1398 const char *line
= *msg_p
;
1399 int linelen
= get_one_line(line
);
1405 if (is_empty_line(line
, &linelen
)) {
1408 if (pp
->fmt
== CMIT_FMT_SHORT
)
1413 strbuf_grow(sb
, linelen
+ indent
+ 20);
1415 memset(sb
->buf
+ sb
->len
, ' ', indent
);
1416 strbuf_setlen(sb
, sb
->len
+ indent
);
1418 strbuf_add(sb
, line
, linelen
);
1419 strbuf_addch(sb
, '\n');
1423 void pretty_print_commit(const struct pretty_print_context
*pp
,
1424 const struct commit
*commit
,
1427 unsigned long beginning_of_body
;
1429 const char *msg
= commit
->buffer
;
1431 const char *encoding
;
1432 int need_8bit_cte
= pp
->need_8bit_cte
;
1434 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
1435 format_commit_message(commit
, user_format
, sb
, pp
);
1439 encoding
= get_log_output_encoding();
1440 reencoded
= logmsg_reencode(commit
, encoding
);
1445 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1449 * We need to check and emit Content-type: to mark it
1450 * as 8-bit if we haven't done so.
1452 if (pp
->fmt
== CMIT_FMT_EMAIL
&& need_8bit_cte
== 0) {
1455 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
1457 /* author could be non 7-bit ASCII but
1458 * the log may be so; skip over the
1459 * header part first.
1461 if (ch
== '\n' && msg
[i
+1] == '\n')
1464 else if (non_ascii(ch
)) {
1471 pp_header(pp
, encoding
, commit
, &msg
, sb
);
1472 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->subject
) {
1473 strbuf_addch(sb
, '\n');
1476 /* Skip excess blank lines at the beginning of body, if any... */
1477 msg
= skip_empty_lines(msg
);
1479 /* These formats treat the title line specially. */
1480 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1481 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
1483 beginning_of_body
= sb
->len
;
1484 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1485 pp_remainder(pp
, &msg
, sb
, indent
);
1488 /* Make sure there is an EOLN for the non-oneline case */
1489 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1490 strbuf_addch(sb
, '\n');
1493 * The caller may append additional body text in e-mail
1494 * format. Make sure we did not strip the blank line
1495 * between the header and the body.
1497 if (pp
->fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
1498 strbuf_addch(sb
, '\n');
1503 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
1506 struct pretty_print_context pp
= {0};
1508 pretty_print_commit(&pp
, commit
, sb
);