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 namelen
= name
.len
+ mail
.len
+ 3; /* ' ' + '<' + '>' */
444 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
445 strbuf_addstr(sb
, "From: ");
446 if (needs_rfc2047_encoding(name
.buf
, name
.len
, RFC2047_ADDRESS
)) {
447 add_rfc2047(sb
, name
.buf
, name
.len
,
448 encoding
, RFC2047_ADDRESS
);
449 max_length
= 76; /* per rfc2047 */
450 } else if (needs_rfc822_quoting(name
.buf
, name
.len
)) {
451 struct strbuf quoted
= STRBUF_INIT
;
452 add_rfc822_quoted("ed
, name
.buf
, name
.len
);
453 strbuf_add_wrapped_bytes(sb
, quoted
.buf
, quoted
.len
,
455 strbuf_release("ed
);
457 strbuf_add_wrapped_bytes(sb
, name
.buf
, name
.len
,
460 if (namelen
- name
.len
+ last_line_length(sb
) > max_length
)
461 strbuf_addch(sb
, '\n');
463 strbuf_addf(sb
, " <%s>\n", mail
.buf
);
465 strbuf_addf(sb
, "%s: %.*s%s <%s>\n", what
,
466 (pp
->fmt
== CMIT_FMT_FULLER
) ? 4 : 0,
467 " ", name
.buf
, mail
.buf
);
470 strbuf_release(&mail
);
471 strbuf_release(&name
);
474 case CMIT_FMT_MEDIUM
:
475 strbuf_addf(sb
, "Date: %s\n",
476 show_ident_date(&ident
, pp
->date_mode
));
479 strbuf_addf(sb
, "Date: %s\n",
480 show_ident_date(&ident
, DATE_RFC2822
));
482 case CMIT_FMT_FULLER
:
483 strbuf_addf(sb
, "%sDate: %s\n", what
,
484 show_ident_date(&ident
, pp
->date_mode
));
492 static int is_empty_line(const char *line
, int *len_p
)
495 while (len
&& isspace(line
[len
-1]))
501 static const char *skip_empty_lines(const char *msg
)
504 int linelen
= get_one_line(msg
);
508 if (!is_empty_line(msg
, &ll
))
515 static void add_merge_info(const struct pretty_print_context
*pp
,
516 struct strbuf
*sb
, const struct commit
*commit
)
518 struct commit_list
*parent
= commit
->parents
;
520 if ((pp
->fmt
== CMIT_FMT_ONELINE
) || (pp
->fmt
== CMIT_FMT_EMAIL
) ||
521 !parent
|| !parent
->next
)
524 strbuf_addstr(sb
, "Merge:");
527 struct commit
*p
= parent
->item
;
528 const char *hex
= NULL
;
530 hex
= find_unique_abbrev(p
->object
.sha1
, pp
->abbrev
);
532 hex
= sha1_to_hex(p
->object
.sha1
);
533 parent
= parent
->next
;
535 strbuf_addf(sb
, " %s", hex
);
537 strbuf_addch(sb
, '\n');
540 static char *get_header(const struct commit
*commit
, const char *msg
,
543 int key_len
= strlen(key
);
544 const char *line
= msg
;
547 const char *eol
= strchr(line
, '\n'), *next
;
552 warning("malformed commit (header is missing newline): %s",
553 sha1_to_hex(commit
->object
.sha1
));
554 eol
= line
+ strlen(line
);
558 if (eol
- line
> key_len
&&
559 !strncmp(line
, key
, key_len
) &&
560 line
[key_len
] == ' ') {
561 return xmemdupz(line
+ key_len
+ 1, eol
- line
- key_len
- 1);
568 static char *replace_encoding_header(char *buf
, const char *encoding
)
570 struct strbuf tmp
= STRBUF_INIT
;
574 /* guess if there is an encoding header before a \n\n */
575 while (strncmp(cp
, "encoding ", strlen("encoding "))) {
576 cp
= strchr(cp
, '\n');
577 if (!cp
|| *++cp
== '\n')
581 cp
= strchr(cp
, '\n');
583 return buf
; /* should not happen but be defensive */
584 len
= cp
+ 1 - (buf
+ start
);
586 strbuf_attach(&tmp
, buf
, strlen(buf
), strlen(buf
) + 1);
587 if (is_encoding_utf8(encoding
)) {
588 /* we have re-coded to UTF-8; drop the header */
589 strbuf_remove(&tmp
, start
, len
);
591 /* just replaces XXXX in 'encoding XXXX\n' */
592 strbuf_splice(&tmp
, start
+ strlen("encoding "),
593 len
- strlen("encoding \n"),
594 encoding
, strlen(encoding
));
596 return strbuf_detach(&tmp
, NULL
);
599 char *logmsg_reencode(const struct commit
*commit
,
600 const char *output_encoding
)
602 static const char *utf8
= "UTF-8";
603 const char *use_encoding
;
605 char *msg
= commit
->buffer
;
609 enum object_type type
;
612 msg
= read_sha1_file(commit
->object
.sha1
, &type
, &size
);
614 die("Cannot read commit object %s",
615 sha1_to_hex(commit
->object
.sha1
));
616 if (type
!= OBJ_COMMIT
)
617 die("Expected commit for '%s', got %s",
618 sha1_to_hex(commit
->object
.sha1
), typename(type
));
621 if (!output_encoding
|| !*output_encoding
)
623 encoding
= get_header(commit
, msg
, "encoding");
624 use_encoding
= encoding
? encoding
: utf8
;
625 if (same_encoding(use_encoding
, output_encoding
)) {
627 * No encoding work to be done. If we have no encoding header
628 * at all, then there's nothing to do, and we can return the
629 * message verbatim (whether newly allocated or not).
635 * Otherwise, we still want to munge the encoding header in the
636 * result, which will be done by modifying the buffer. If we
637 * are using a fresh copy, we can reuse it. But if we are using
638 * the cached copy from commit->buffer, we need to duplicate it
639 * to avoid munging commit->buffer.
642 if (out
== commit
->buffer
)
647 * There's actual encoding work to do. Do the reencoding, which
648 * still leaves the header to be replaced in the next step. At
649 * this point, we are done with msg. If we allocated a fresh
650 * copy, we can free it.
652 out
= reencode_string(msg
, output_encoding
, use_encoding
);
653 if (out
&& msg
!= commit
->buffer
)
658 * This replacement actually consumes the buffer we hand it, so we do
659 * not have to worry about freeing the old "out" here.
662 out
= replace_encoding_header(out
, output_encoding
);
666 * If the re-encoding failed, out might be NULL here; in that
667 * case we just return the commit message verbatim.
669 return out
? out
: msg
;
672 void logmsg_free(char *msg
, const struct commit
*commit
)
674 if (msg
!= commit
->buffer
)
678 static int mailmap_name(const char **email
, size_t *email_len
,
679 const char **name
, size_t *name_len
)
681 static struct string_list
*mail_map
;
683 mail_map
= xcalloc(1, sizeof(*mail_map
));
684 read_mailmap(mail_map
, NULL
);
686 return mail_map
->nr
&& map_user(mail_map
, email
, email_len
, name
, name_len
);
689 static size_t format_person_part(struct strbuf
*sb
, char part
,
690 const char *msg
, int len
, enum date_mode dmode
)
692 /* currently all placeholders have same length */
693 const int placeholder_len
= 2;
694 struct ident_split s
;
695 const char *name
, *mail
;
696 size_t maillen
, namelen
;
698 if (split_ident_line(&s
, msg
, len
) < 0)
702 namelen
= s
.name_end
- s
.name_begin
;
704 maillen
= s
.mail_end
- s
.mail_begin
;
706 if (part
== 'N' || part
== 'E') /* mailmap lookup */
707 mailmap_name(&mail
, &maillen
, &name
, &namelen
);
708 if (part
== 'n' || part
== 'N') { /* name */
709 strbuf_add(sb
, name
, namelen
);
710 return placeholder_len
;
712 if (part
== 'e' || part
== 'E') { /* email */
713 strbuf_add(sb
, mail
, maillen
);
714 return placeholder_len
;
720 if (part
== 't') { /* date, UNIX timestamp */
721 strbuf_add(sb
, s
.date_begin
, s
.date_end
- s
.date_begin
);
722 return placeholder_len
;
727 strbuf_addstr(sb
, show_ident_date(&s
, dmode
));
728 return placeholder_len
;
729 case 'D': /* date, RFC2822 style */
730 strbuf_addstr(sb
, show_ident_date(&s
, DATE_RFC2822
));
731 return placeholder_len
;
732 case 'r': /* date, relative */
733 strbuf_addstr(sb
, show_ident_date(&s
, DATE_RELATIVE
));
734 return placeholder_len
;
735 case 'i': /* date, ISO 8601 */
736 strbuf_addstr(sb
, show_ident_date(&s
, DATE_ISO8601
));
737 return placeholder_len
;
742 * reading from either a bogus commit, or a reflog entry with
743 * %gn, %ge, etc.; 'sb' cannot be updated, but we still need
744 * to compute a valid return value.
746 if (part
== 'n' || part
== 'e' || part
== 't' || part
== 'd'
747 || part
== 'D' || part
== 'r' || part
== 'i')
748 return placeholder_len
;
750 return 0; /* unknown placeholder */
758 struct format_commit_context
{
759 const struct commit
*commit
;
760 const struct pretty_print_context
*pretty_ctx
;
761 unsigned commit_header_parsed
:1;
762 unsigned commit_message_parsed
:1;
763 unsigned commit_signature_parsed
:1;
772 size_t width
, indent1
, indent2
;
774 /* These offsets are relative to the start of the commit message. */
776 struct chunk committer
;
777 struct chunk encoding
;
782 /* The following ones are relative to the result struct strbuf. */
783 struct chunk abbrev_commit_hash
;
784 struct chunk abbrev_tree_hash
;
785 struct chunk abbrev_parent_hashes
;
789 static int add_again(struct strbuf
*sb
, struct chunk
*chunk
)
792 strbuf_adddup(sb
, chunk
->off
, chunk
->len
);
797 * We haven't seen this chunk before. Our caller is surely
798 * going to add it the hard way now. Remember the most likely
799 * start of the to-be-added chunk: the current end of the
802 chunk
->off
= sb
->len
;
806 static void parse_commit_header(struct format_commit_context
*context
)
808 const char *msg
= context
->message
;
811 for (i
= 0; msg
[i
]; i
++) {
813 for (eol
= i
; msg
[eol
] && msg
[eol
] != '\n'; eol
++)
818 } else if (!prefixcmp(msg
+ i
, "author ")) {
819 context
->author
.off
= i
+ 7;
820 context
->author
.len
= eol
- i
- 7;
821 } else if (!prefixcmp(msg
+ i
, "committer ")) {
822 context
->committer
.off
= i
+ 10;
823 context
->committer
.len
= eol
- i
- 10;
824 } else if (!prefixcmp(msg
+ i
, "encoding ")) {
825 context
->encoding
.off
= i
+ 9;
826 context
->encoding
.len
= eol
- i
- 9;
830 context
->message_off
= i
;
831 context
->commit_header_parsed
= 1;
834 static int istitlechar(char c
)
836 return (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
837 (c
>= '0' && c
<= '9') || c
== '.' || c
== '_';
840 static void format_sanitized_subject(struct strbuf
*sb
, const char *msg
)
843 size_t start_len
= sb
->len
;
846 for (; *msg
&& *msg
!= '\n'; msg
++) {
847 if (istitlechar(*msg
)) {
849 strbuf_addch(sb
, '-');
851 strbuf_addch(sb
, *msg
);
853 while (*(msg
+1) == '.')
859 /* trim any trailing '.' or '-' characters */
861 while (sb
->len
- trimlen
> start_len
&&
862 (sb
->buf
[sb
->len
- 1 - trimlen
] == '.'
863 || sb
->buf
[sb
->len
- 1 - trimlen
] == '-'))
865 strbuf_remove(sb
, sb
->len
- trimlen
, trimlen
);
868 const char *format_subject(struct strbuf
*sb
, const char *msg
,
869 const char *line_separator
)
874 const char *line
= msg
;
875 int linelen
= get_one_line(line
);
878 if (!linelen
|| is_empty_line(line
, &linelen
))
883 strbuf_grow(sb
, linelen
+ 2);
885 strbuf_addstr(sb
, line_separator
);
886 strbuf_add(sb
, line
, linelen
);
892 static void parse_commit_message(struct format_commit_context
*c
)
894 const char *msg
= c
->message
+ c
->message_off
;
895 const char *start
= c
->message
;
897 msg
= skip_empty_lines(msg
);
898 c
->subject_off
= msg
- start
;
900 msg
= format_subject(NULL
, msg
, NULL
);
901 msg
= skip_empty_lines(msg
);
902 c
->body_off
= msg
- start
;
904 c
->commit_message_parsed
= 1;
907 static void format_decoration(struct strbuf
*sb
, const struct commit
*commit
)
909 struct name_decoration
*d
;
910 const char *prefix
= " (";
912 load_ref_decorations(DECORATE_SHORT_REFS
);
913 d
= lookup_decoration(&name_decoration
, &commit
->object
);
915 strbuf_addstr(sb
, prefix
);
917 strbuf_addstr(sb
, d
->name
);
920 if (prefix
[0] == ',')
921 strbuf_addch(sb
, ')');
924 static void strbuf_wrap(struct strbuf
*sb
, size_t pos
,
925 size_t width
, size_t indent1
, size_t indent2
)
927 struct strbuf tmp
= STRBUF_INIT
;
930 strbuf_add(&tmp
, sb
->buf
, pos
);
931 strbuf_add_wrapped_text(&tmp
, sb
->buf
+ pos
,
932 (int) indent1
, (int) indent2
, (int) width
);
933 strbuf_swap(&tmp
, sb
);
934 strbuf_release(&tmp
);
937 static void rewrap_message_tail(struct strbuf
*sb
,
938 struct format_commit_context
*c
,
939 size_t new_width
, size_t new_indent1
,
942 if (c
->width
== new_width
&& c
->indent1
== new_indent1
&&
943 c
->indent2
== new_indent2
)
945 if (c
->wrap_start
< sb
->len
)
946 strbuf_wrap(sb
, c
->wrap_start
, c
->width
, c
->indent1
, c
->indent2
);
947 c
->wrap_start
= sb
->len
;
948 c
->width
= new_width
;
949 c
->indent1
= new_indent1
;
950 c
->indent2
= new_indent2
;
956 } signature_check
[] = {
957 { 'G', "\n[GNUPG:] GOODSIG " },
958 { 'B', "\n[GNUPG:] BADSIG " },
961 static void parse_signature_lines(struct format_commit_context
*ctx
)
963 const char *buf
= ctx
->signature
.gpg_status
;
966 for (i
= 0; i
< ARRAY_SIZE(signature_check
); i
++) {
967 const char *found
= strstr(buf
, signature_check
[i
].check
);
971 ctx
->signature
.good_bad
= signature_check
[i
].result
;
972 found
+= strlen(signature_check
[i
].check
);
973 ctx
->signature
.key
= xmemdupz(found
, 16);
975 next
= strchrnul(found
, '\n');
976 ctx
->signature
.signer
= xmemdupz(found
, next
- found
);
981 static void parse_commit_signature(struct format_commit_context
*ctx
)
983 struct strbuf payload
= STRBUF_INIT
;
984 struct strbuf signature
= STRBUF_INIT
;
985 struct strbuf gpg_output
= STRBUF_INIT
;
986 struct strbuf gpg_status
= STRBUF_INIT
;
989 ctx
->commit_signature_parsed
= 1;
991 if (parse_signed_commit(ctx
->commit
->object
.sha1
,
992 &payload
, &signature
) <= 0)
994 status
= verify_signed_buffer(payload
.buf
, payload
.len
,
995 signature
.buf
, signature
.len
,
996 &gpg_output
, &gpg_status
);
997 if (status
&& !gpg_output
.len
)
999 ctx
->signature
.gpg_output
= strbuf_detach(&gpg_output
, NULL
);
1000 ctx
->signature
.gpg_status
= strbuf_detach(&gpg_status
, NULL
);
1001 parse_signature_lines(ctx
);
1004 strbuf_release(&gpg_status
);
1005 strbuf_release(&gpg_output
);
1006 strbuf_release(&payload
);
1007 strbuf_release(&signature
);
1011 static int format_reflog_person(struct strbuf
*sb
,
1013 struct reflog_walk_info
*log
,
1014 enum date_mode dmode
)
1021 ident
= get_reflog_ident(log
);
1025 return format_person_part(sb
, part
, ident
, strlen(ident
), dmode
);
1028 static size_t format_commit_one(struct strbuf
*sb
, const char *placeholder
,
1031 struct format_commit_context
*c
= context
;
1032 const struct commit
*commit
= c
->commit
;
1033 const char *msg
= c
->message
;
1034 struct commit_list
*p
;
1037 /* these are independent of the commit */
1038 switch (placeholder
[0]) {
1040 if (placeholder
[1] == '(') {
1041 const char *begin
= placeholder
+ 2;
1042 const char *end
= strchr(begin
, ')');
1043 char color
[COLOR_MAXLEN
];
1047 if (!prefixcmp(begin
, "auto,")) {
1048 if (!want_color(c
->pretty_ctx
->color
))
1049 return end
- placeholder
+ 1;
1052 color_parse_mem(begin
,
1054 "--pretty format", color
);
1055 strbuf_addstr(sb
, color
);
1056 return end
- placeholder
+ 1;
1058 if (!prefixcmp(placeholder
+ 1, "red")) {
1059 strbuf_addstr(sb
, GIT_COLOR_RED
);
1061 } else if (!prefixcmp(placeholder
+ 1, "green")) {
1062 strbuf_addstr(sb
, GIT_COLOR_GREEN
);
1064 } else if (!prefixcmp(placeholder
+ 1, "blue")) {
1065 strbuf_addstr(sb
, GIT_COLOR_BLUE
);
1067 } else if (!prefixcmp(placeholder
+ 1, "reset")) {
1068 strbuf_addstr(sb
, GIT_COLOR_RESET
);
1072 case 'n': /* newline */
1073 strbuf_addch(sb
, '\n');
1076 /* %x00 == NUL, %x0a == LF, etc. */
1077 if (0 <= (h1
= hexval_table
[0xff & placeholder
[1]]) &&
1079 0 <= (h2
= hexval_table
[0xff & placeholder
[2]]) &&
1081 strbuf_addch(sb
, (h1
<<4)|h2
);
1086 if (placeholder
[1] == '(') {
1087 unsigned long width
= 0, indent1
= 0, indent2
= 0;
1089 const char *start
= placeholder
+ 2;
1090 const char *end
= strchr(start
, ')');
1094 width
= strtoul(start
, &next
, 10);
1096 indent1
= strtoul(next
+ 1, &next
, 10);
1098 indent2
= strtoul(next
+ 1,
1105 rewrap_message_tail(sb
, c
, width
, indent1
, indent2
);
1106 return end
- placeholder
+ 1;
1111 /* these depend on the commit */
1112 if (!commit
->object
.parsed
)
1113 parse_object(commit
->object
.sha1
);
1115 switch (placeholder
[0]) {
1116 case 'H': /* commit hash */
1117 strbuf_addstr(sb
, sha1_to_hex(commit
->object
.sha1
));
1119 case 'h': /* abbreviated commit hash */
1120 if (add_again(sb
, &c
->abbrev_commit_hash
))
1122 strbuf_addstr(sb
, find_unique_abbrev(commit
->object
.sha1
,
1123 c
->pretty_ctx
->abbrev
));
1124 c
->abbrev_commit_hash
.len
= sb
->len
- c
->abbrev_commit_hash
.off
;
1126 case 'T': /* tree hash */
1127 strbuf_addstr(sb
, sha1_to_hex(commit
->tree
->object
.sha1
));
1129 case 't': /* abbreviated tree hash */
1130 if (add_again(sb
, &c
->abbrev_tree_hash
))
1132 strbuf_addstr(sb
, find_unique_abbrev(commit
->tree
->object
.sha1
,
1133 c
->pretty_ctx
->abbrev
));
1134 c
->abbrev_tree_hash
.len
= sb
->len
- c
->abbrev_tree_hash
.off
;
1136 case 'P': /* parent hashes */
1137 for (p
= commit
->parents
; p
; p
= p
->next
) {
1138 if (p
!= commit
->parents
)
1139 strbuf_addch(sb
, ' ');
1140 strbuf_addstr(sb
, sha1_to_hex(p
->item
->object
.sha1
));
1143 case 'p': /* abbreviated parent hashes */
1144 if (add_again(sb
, &c
->abbrev_parent_hashes
))
1146 for (p
= commit
->parents
; p
; p
= p
->next
) {
1147 if (p
!= commit
->parents
)
1148 strbuf_addch(sb
, ' ');
1149 strbuf_addstr(sb
, find_unique_abbrev(
1150 p
->item
->object
.sha1
,
1151 c
->pretty_ctx
->abbrev
));
1153 c
->abbrev_parent_hashes
.len
= sb
->len
-
1154 c
->abbrev_parent_hashes
.off
;
1156 case 'm': /* left/right/bottom */
1157 strbuf_addstr(sb
, get_revision_mark(NULL
, commit
));
1160 format_decoration(sb
, commit
);
1162 case 'g': /* reflog info */
1163 switch(placeholder
[1]) {
1164 case 'd': /* reflog selector */
1166 if (c
->pretty_ctx
->reflog_info
)
1167 get_reflog_selector(sb
,
1168 c
->pretty_ctx
->reflog_info
,
1169 c
->pretty_ctx
->date_mode
,
1170 c
->pretty_ctx
->date_mode_explicit
,
1171 (placeholder
[1] == 'd'));
1173 case 's': /* reflog message */
1174 if (c
->pretty_ctx
->reflog_info
)
1175 get_reflog_message(sb
, c
->pretty_ctx
->reflog_info
);
1181 return format_reflog_person(sb
,
1183 c
->pretty_ctx
->reflog_info
,
1184 c
->pretty_ctx
->date_mode
);
1186 return 0; /* unknown %g placeholder */
1188 if (c
->pretty_ctx
->notes_message
) {
1189 strbuf_addstr(sb
, c
->pretty_ctx
->notes_message
);
1195 if (placeholder
[0] == 'G') {
1196 if (!c
->commit_signature_parsed
)
1197 parse_commit_signature(c
);
1198 switch (placeholder
[1]) {
1200 if (c
->signature
.gpg_output
)
1201 strbuf_addstr(sb
, c
->signature
.gpg_output
);
1204 switch (c
->signature
.good_bad
) {
1207 strbuf_addch(sb
, c
->signature
.good_bad
);
1211 if (c
->signature
.signer
)
1212 strbuf_addstr(sb
, c
->signature
.signer
);
1215 if (c
->signature
.key
)
1216 strbuf_addstr(sb
, c
->signature
.key
);
1223 /* For the rest we have to parse the commit header. */
1224 if (!c
->commit_header_parsed
)
1225 parse_commit_header(c
);
1227 switch (placeholder
[0]) {
1228 case 'a': /* author ... */
1229 return format_person_part(sb
, placeholder
[1],
1230 msg
+ c
->author
.off
, c
->author
.len
,
1231 c
->pretty_ctx
->date_mode
);
1232 case 'c': /* committer ... */
1233 return format_person_part(sb
, placeholder
[1],
1234 msg
+ c
->committer
.off
, c
->committer
.len
,
1235 c
->pretty_ctx
->date_mode
);
1236 case 'e': /* encoding */
1237 strbuf_add(sb
, msg
+ c
->encoding
.off
, c
->encoding
.len
);
1239 case 'B': /* raw body */
1240 /* message_off is always left at the initial newline */
1241 strbuf_addstr(sb
, msg
+ c
->message_off
+ 1);
1245 /* Now we need to parse the commit message. */
1246 if (!c
->commit_message_parsed
)
1247 parse_commit_message(c
);
1249 switch (placeholder
[0]) {
1250 case 's': /* subject */
1251 format_subject(sb
, msg
+ c
->subject_off
, " ");
1253 case 'f': /* sanitized subject */
1254 format_sanitized_subject(sb
, msg
+ c
->subject_off
);
1256 case 'b': /* body */
1257 strbuf_addstr(sb
, msg
+ c
->body_off
);
1260 return 0; /* unknown placeholder */
1263 static size_t format_commit_item(struct strbuf
*sb
, const char *placeholder
,
1270 ADD_LF_BEFORE_NON_EMPTY
,
1271 DEL_LF_BEFORE_EMPTY
,
1272 ADD_SP_BEFORE_NON_EMPTY
1275 switch (placeholder
[0]) {
1277 magic
= DEL_LF_BEFORE_EMPTY
;
1280 magic
= ADD_LF_BEFORE_NON_EMPTY
;
1283 magic
= ADD_SP_BEFORE_NON_EMPTY
;
1288 if (magic
!= NO_MAGIC
)
1292 consumed
= format_commit_one(sb
, placeholder
, context
);
1293 if (magic
== NO_MAGIC
)
1296 if ((orig_len
== sb
->len
) && magic
== DEL_LF_BEFORE_EMPTY
) {
1297 while (sb
->len
&& sb
->buf
[sb
->len
- 1] == '\n')
1298 strbuf_setlen(sb
, sb
->len
- 1);
1299 } else if (orig_len
!= sb
->len
) {
1300 if (magic
== ADD_LF_BEFORE_NON_EMPTY
)
1301 strbuf_insert(sb
, orig_len
, "\n", 1);
1302 else if (magic
== ADD_SP_BEFORE_NON_EMPTY
)
1303 strbuf_insert(sb
, orig_len
, " ", 1);
1305 return consumed
+ 1;
1308 static size_t userformat_want_item(struct strbuf
*sb
, const char *placeholder
,
1311 struct userformat_want
*w
= context
;
1313 if (*placeholder
== '+' || *placeholder
== '-' || *placeholder
== ' ')
1316 switch (*placeholder
) {
1324 void userformat_find_requirements(const char *fmt
, struct userformat_want
*w
)
1326 struct strbuf dummy
= STRBUF_INIT
;
1333 strbuf_expand(&dummy
, fmt
, userformat_want_item
, w
);
1334 strbuf_release(&dummy
);
1337 void format_commit_message(const struct commit
*commit
,
1338 const char *format
, struct strbuf
*sb
,
1339 const struct pretty_print_context
*pretty_ctx
)
1341 struct format_commit_context context
;
1342 const char *output_enc
= pretty_ctx
->output_encoding
;
1344 memset(&context
, 0, sizeof(context
));
1345 context
.commit
= commit
;
1346 context
.pretty_ctx
= pretty_ctx
;
1347 context
.wrap_start
= sb
->len
;
1348 context
.message
= logmsg_reencode(commit
, output_enc
);
1350 strbuf_expand(sb
, format
, format_commit_item
, &context
);
1351 rewrap_message_tail(sb
, &context
, 0, 0, 0);
1353 logmsg_free(context
.message
, commit
);
1354 free(context
.signature
.gpg_output
);
1355 free(context
.signature
.signer
);
1358 static void pp_header(const struct pretty_print_context
*pp
,
1359 const char *encoding
,
1360 const struct commit
*commit
,
1364 int parents_shown
= 0;
1367 const char *line
= *msg_p
;
1368 int linelen
= get_one_line(*msg_p
);
1378 if (pp
->fmt
== CMIT_FMT_RAW
) {
1379 strbuf_add(sb
, line
, linelen
);
1383 if (!prefixcmp(line
, "parent ")) {
1385 die("bad parent line in commit");
1389 if (!parents_shown
) {
1390 struct commit_list
*parent
;
1392 for (parent
= commit
->parents
, num
= 0;
1394 parent
= parent
->next
, num
++)
1396 /* with enough slop */
1397 strbuf_grow(sb
, num
* 50 + 20);
1398 add_merge_info(pp
, sb
, commit
);
1403 * MEDIUM == DEFAULT shows only author with dates.
1404 * FULL shows both authors but not dates.
1405 * FULLER shows both authors and dates.
1407 if (!prefixcmp(line
, "author ")) {
1408 strbuf_grow(sb
, linelen
+ 80);
1409 pp_user_info(pp
, "Author", sb
, line
+ 7, encoding
);
1411 if (!prefixcmp(line
, "committer ") &&
1412 (pp
->fmt
== CMIT_FMT_FULL
|| pp
->fmt
== CMIT_FMT_FULLER
)) {
1413 strbuf_grow(sb
, linelen
+ 80);
1414 pp_user_info(pp
, "Commit", sb
, line
+ 10, encoding
);
1419 void pp_title_line(const struct pretty_print_context
*pp
,
1422 const char *encoding
,
1425 static const int max_length
= 78; /* per rfc2047 */
1426 struct strbuf title
;
1428 strbuf_init(&title
, 80);
1429 *msg_p
= format_subject(&title
, *msg_p
,
1430 pp
->preserve_subject
? "\n" : " ");
1432 strbuf_grow(sb
, title
.len
+ 1024);
1434 strbuf_addstr(sb
, pp
->subject
);
1435 if (needs_rfc2047_encoding(title
.buf
, title
.len
, RFC2047_SUBJECT
))
1436 add_rfc2047(sb
, title
.buf
, title
.len
,
1437 encoding
, RFC2047_SUBJECT
);
1439 strbuf_add_wrapped_bytes(sb
, title
.buf
, title
.len
,
1440 -last_line_length(sb
), 1, max_length
);
1442 strbuf_addbuf(sb
, &title
);
1444 strbuf_addch(sb
, '\n');
1446 if (need_8bit_cte
> 0) {
1447 const char *header_fmt
=
1448 "MIME-Version: 1.0\n"
1449 "Content-Type: text/plain; charset=%s\n"
1450 "Content-Transfer-Encoding: 8bit\n";
1451 strbuf_addf(sb
, header_fmt
, encoding
);
1453 if (pp
->after_subject
) {
1454 strbuf_addstr(sb
, pp
->after_subject
);
1456 if (pp
->fmt
== CMIT_FMT_EMAIL
) {
1457 strbuf_addch(sb
, '\n');
1459 strbuf_release(&title
);
1462 void pp_remainder(const struct pretty_print_context
*pp
,
1469 const char *line
= *msg_p
;
1470 int linelen
= get_one_line(line
);
1476 if (is_empty_line(line
, &linelen
)) {
1479 if (pp
->fmt
== CMIT_FMT_SHORT
)
1484 strbuf_grow(sb
, linelen
+ indent
+ 20);
1486 memset(sb
->buf
+ sb
->len
, ' ', indent
);
1487 strbuf_setlen(sb
, sb
->len
+ indent
);
1489 strbuf_add(sb
, line
, linelen
);
1490 strbuf_addch(sb
, '\n');
1494 void pretty_print_commit(const struct pretty_print_context
*pp
,
1495 const struct commit
*commit
,
1498 unsigned long beginning_of_body
;
1502 const char *encoding
;
1503 int need_8bit_cte
= pp
->need_8bit_cte
;
1505 if (pp
->fmt
== CMIT_FMT_USERFORMAT
) {
1506 format_commit_message(commit
, user_format
, sb
, pp
);
1510 encoding
= get_log_output_encoding();
1511 msg
= reencoded
= logmsg_reencode(commit
, encoding
);
1513 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1517 * We need to check and emit Content-type: to mark it
1518 * as 8-bit if we haven't done so.
1520 if (pp
->fmt
== CMIT_FMT_EMAIL
&& need_8bit_cte
== 0) {
1523 for (in_body
= i
= 0; (ch
= msg
[i
]); i
++) {
1525 /* author could be non 7-bit ASCII but
1526 * the log may be so; skip over the
1527 * header part first.
1529 if (ch
== '\n' && msg
[i
+1] == '\n')
1532 else if (non_ascii(ch
)) {
1539 pp_header(pp
, encoding
, commit
, &msg
, sb
);
1540 if (pp
->fmt
!= CMIT_FMT_ONELINE
&& !pp
->subject
) {
1541 strbuf_addch(sb
, '\n');
1544 /* Skip excess blank lines at the beginning of body, if any... */
1545 msg
= skip_empty_lines(msg
);
1547 /* These formats treat the title line specially. */
1548 if (pp
->fmt
== CMIT_FMT_ONELINE
|| pp
->fmt
== CMIT_FMT_EMAIL
)
1549 pp_title_line(pp
, &msg
, sb
, encoding
, need_8bit_cte
);
1551 beginning_of_body
= sb
->len
;
1552 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1553 pp_remainder(pp
, &msg
, sb
, indent
);
1556 /* Make sure there is an EOLN for the non-oneline case */
1557 if (pp
->fmt
!= CMIT_FMT_ONELINE
)
1558 strbuf_addch(sb
, '\n');
1561 * The caller may append additional body text in e-mail
1562 * format. Make sure we did not strip the blank line
1563 * between the header and the body.
1565 if (pp
->fmt
== CMIT_FMT_EMAIL
&& sb
->len
<= beginning_of_body
)
1566 strbuf_addch(sb
, '\n');
1568 logmsg_free(reencoded
, commit
);
1571 void pp_commit_easy(enum cmit_fmt fmt
, const struct commit
*commit
,
1574 struct pretty_print_context pp
= {0};
1576 pretty_print_commit(&pp
, commit
, sb
);