7 #include "reflog-walk.h"
9 #include "string-list.h"
11 #include "gpg-interface.h"
13 struct decoration name_decoration
= { "object names" };
15 enum decoration_type
{
18 DECORATION_REF_REMOTE
,
25 static char decoration_colors
[][COLOR_MAXLEN
] = {
27 GIT_COLOR_BOLD_GREEN
, /* REF_LOCAL */
28 GIT_COLOR_BOLD_RED
, /* REF_REMOTE */
29 GIT_COLOR_BOLD_YELLOW
, /* REF_TAG */
30 GIT_COLOR_BOLD_MAGENTA
, /* REF_STASH */
31 GIT_COLOR_BOLD_CYAN
, /* REF_HEAD */
32 GIT_COLOR_BOLD_BLUE
, /* GRAFTED */
35 static const char *decorate_get_color(int decorate_use_color
, enum decoration_type ix
)
37 if (want_color(decorate_use_color
))
38 return decoration_colors
[ix
];
42 static int parse_decorate_color_slot(const char *slot
)
45 * We're comparing with 'ignore-case' on
46 * (because config.c sets them all tolower),
47 * but let's match the letters in the literal
48 * string values here with how they are
49 * documented in Documentation/config.txt, for
52 * We love being consistent, don't we?
54 if (!strcasecmp(slot
, "branch"))
55 return DECORATION_REF_LOCAL
;
56 if (!strcasecmp(slot
, "remoteBranch"))
57 return DECORATION_REF_REMOTE
;
58 if (!strcasecmp(slot
, "tag"))
59 return DECORATION_REF_TAG
;
60 if (!strcasecmp(slot
, "stash"))
61 return DECORATION_REF_STASH
;
62 if (!strcasecmp(slot
, "HEAD"))
63 return DECORATION_REF_HEAD
;
67 int parse_decorate_color_config(const char *var
, const int ofs
, const char *value
)
69 int slot
= parse_decorate_color_slot(var
+ ofs
);
73 return config_error_nonbool(var
);
74 color_parse(value
, var
, decoration_colors
[slot
]);
79 * log-tree.c uses DIFF_OPT_TST for determining whether to use color
80 * for showing the commit sha1, use the same check for --decorate
82 #define decorate_get_color_opt(o, ix) \
83 decorate_get_color((o)->use_color, ix)
85 static void add_name_decoration(enum decoration_type type
, const char *name
, struct object
*obj
)
87 int nlen
= strlen(name
);
88 struct name_decoration
*res
= xmalloc(sizeof(struct name_decoration
) + nlen
);
89 memcpy(res
->name
, name
, nlen
+ 1);
91 res
->next
= add_decoration(&name_decoration
, obj
, res
);
94 static int add_ref_decoration(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
)
97 enum decoration_type type
= DECORATION_NONE
;
99 if (!prefixcmp(refname
, "refs/replace/")) {
100 unsigned char original_sha1
[20];
101 if (!read_replace_refs
)
103 if (get_sha1_hex(refname
+ 13, original_sha1
)) {
104 warning("invalid replace ref %s", refname
);
107 obj
= parse_object(original_sha1
);
109 add_name_decoration(DECORATION_GRAFTED
, "replaced", obj
);
113 obj
= parse_object(sha1
);
117 if (!prefixcmp(refname
, "refs/heads/"))
118 type
= DECORATION_REF_LOCAL
;
119 else if (!prefixcmp(refname
, "refs/remotes/"))
120 type
= DECORATION_REF_REMOTE
;
121 else if (!prefixcmp(refname
, "refs/tags/"))
122 type
= DECORATION_REF_TAG
;
123 else if (!prefixcmp(refname
, "refs/stash"))
124 type
= DECORATION_REF_STASH
;
125 else if (!prefixcmp(refname
, "HEAD"))
126 type
= DECORATION_REF_HEAD
;
128 if (!cb_data
|| *(int *)cb_data
== DECORATE_SHORT_REFS
)
129 refname
= prettify_refname(refname
);
130 add_name_decoration(type
, refname
, obj
);
131 while (obj
->type
== OBJ_TAG
) {
132 obj
= ((struct tag
*)obj
)->tagged
;
135 add_name_decoration(DECORATION_REF_TAG
, refname
, obj
);
140 static int add_graft_decoration(const struct commit_graft
*graft
, void *cb_data
)
142 struct commit
*commit
= lookup_commit(graft
->sha1
);
145 add_name_decoration(DECORATION_GRAFTED
, "grafted", &commit
->object
);
149 void load_ref_decorations(int flags
)
154 for_each_ref(add_ref_decoration
, &flags
);
155 head_ref(add_ref_decoration
, &flags
);
156 for_each_commit_graft(add_graft_decoration
, NULL
);
160 static void show_parents(struct commit
*commit
, int abbrev
)
162 struct commit_list
*p
;
163 for (p
= commit
->parents
; p
; p
= p
->next
) {
164 struct commit
*parent
= p
->item
;
165 printf(" %s", find_unique_abbrev(parent
->object
.sha1
, abbrev
));
169 static void show_children(struct rev_info
*opt
, struct commit
*commit
, int abbrev
)
171 struct commit_list
*p
= lookup_decoration(&opt
->children
, &commit
->object
);
172 for ( ; p
; p
= p
->next
) {
173 printf(" %s", find_unique_abbrev(p
->item
->object
.sha1
, abbrev
));
177 void show_decorations(struct rev_info
*opt
, struct commit
*commit
)
180 struct name_decoration
*decoration
;
181 const char *color_commit
=
182 diff_get_color_opt(&opt
->diffopt
, DIFF_COMMIT
);
183 const char *color_reset
=
184 decorate_get_color_opt(&opt
->diffopt
, DECORATION_NONE
);
186 if (opt
->show_source
&& commit
->util
)
187 printf("\t%s", (char *) commit
->util
);
188 if (!opt
->show_decorations
)
190 decoration
= lookup_decoration(&name_decoration
, &commit
->object
);
195 printf("%s", prefix
);
196 fputs(decorate_get_color_opt(&opt
->diffopt
, decoration
->type
),
198 if (decoration
->type
== DECORATION_REF_TAG
)
199 fputs("tag: ", stdout
);
200 printf("%s", decoration
->name
);
201 fputs(color_reset
, stdout
);
202 fputs(color_commit
, stdout
);
204 decoration
= decoration
->next
;
210 * Search for "^[-A-Za-z]+: [^@]+@" pattern. It usually matches
211 * Signed-off-by: and Acked-by: lines.
213 static int detect_any_signoff(char *letter
, int size
)
222 while (letter
<= --cp
&& *cp
== '\n')
225 while (letter
<= cp
) {
244 if (('A' <= ch
&& ch
<= 'Z') ||
245 ('a' <= ch
&& ch
<= 'z') ||
250 /* no empty last line doesn't match */
253 return seen_head
&& seen_name
;
256 static void append_signoff(struct strbuf
*sb
, const char *signoff
)
258 static const char signed_off_by
[] = "Signed-off-by: ";
259 size_t signoff_len
= strlen(signoff
);
265 /* First see if we already have the sign-off by the signer */
266 while ((cp
= strstr(cp
, signed_off_by
))) {
270 cp
+= strlen(signed_off_by
);
271 if (cp
+ signoff_len
>= sb
->buf
+ sb
->len
)
273 if (strncmp(cp
, signoff
, signoff_len
))
275 if (!isspace(cp
[signoff_len
]))
277 /* we already have him */
282 has_signoff
= detect_any_signoff(sb
->buf
, sb
->len
);
285 strbuf_addch(sb
, '\n');
287 strbuf_addstr(sb
, signed_off_by
);
288 strbuf_add(sb
, signoff
, signoff_len
);
289 strbuf_addch(sb
, '\n');
292 static unsigned int digits_in_number(unsigned int number
)
294 unsigned int i
= 10, result
= 1;
295 while (i
<= number
) {
302 void get_patch_filename(struct commit
*commit
, int nr
, const char *suffix
,
305 int suffix_len
= strlen(suffix
) + 1;
306 int start_len
= buf
->len
;
308 strbuf_addf(buf
, commit
? "%04d-" : "%d", nr
);
310 int max_len
= start_len
+ FORMAT_PATCH_NAME_MAX
- suffix_len
;
311 struct pretty_print_context ctx
= {0};
312 ctx
.date_mode
= DATE_NORMAL
;
314 format_commit_message(commit
, "%f", buf
, &ctx
);
315 if (max_len
< buf
->len
)
316 strbuf_setlen(buf
, max_len
);
317 strbuf_addstr(buf
, suffix
);
321 void log_write_email_headers(struct rev_info
*opt
, struct commit
*commit
,
322 const char **subject_p
,
323 const char **extra_headers_p
,
324 int *need_8bit_cte_p
)
326 const char *subject
= NULL
;
327 const char *extra_headers
= opt
->extra_headers
;
328 const char *name
= sha1_to_hex(commit
->object
.sha1
);
330 *need_8bit_cte_p
= 0; /* unknown */
331 if (opt
->total
> 0) {
332 static char buffer
[64];
333 snprintf(buffer
, sizeof(buffer
),
334 "Subject: [%s%s%0*d/%d] ",
336 *opt
->subject_prefix
? " " : "",
337 digits_in_number(opt
->total
),
338 opt
->nr
, opt
->total
);
340 } else if (opt
->total
== 0 && opt
->subject_prefix
&& *opt
->subject_prefix
) {
341 static char buffer
[256];
342 snprintf(buffer
, sizeof(buffer
),
344 opt
->subject_prefix
);
347 subject
= "Subject: ";
350 printf("From %s Mon Sep 17 00:00:00 2001\n", name
);
351 graph_show_oneline(opt
->graph
);
352 if (opt
->message_id
) {
353 printf("Message-Id: <%s>\n", opt
->message_id
);
354 graph_show_oneline(opt
->graph
);
356 if (opt
->ref_message_ids
&& opt
->ref_message_ids
->nr
> 0) {
358 n
= opt
->ref_message_ids
->nr
;
359 printf("In-Reply-To: <%s>\n", opt
->ref_message_ids
->items
[n
-1].string
);
360 for (i
= 0; i
< n
; i
++)
361 printf("%s<%s>\n", (i
> 0 ? "\t" : "References: "),
362 opt
->ref_message_ids
->items
[i
].string
);
363 graph_show_oneline(opt
->graph
);
365 if (opt
->mime_boundary
) {
366 static char subject_buffer
[1024];
367 static char buffer
[1024];
368 struct strbuf filename
= STRBUF_INIT
;
369 *need_8bit_cte_p
= -1; /* NEVER */
370 snprintf(subject_buffer
, sizeof(subject_buffer
) - 1,
372 "MIME-Version: 1.0\n"
373 "Content-Type: multipart/mixed;"
374 " boundary=\"%s%s\"\n"
376 "This is a multi-part message in MIME "
379 "Content-Type: text/plain; "
380 "charset=UTF-8; format=fixed\n"
381 "Content-Transfer-Encoding: 8bit\n\n",
382 extra_headers
? extra_headers
: "",
383 mime_boundary_leader
, opt
->mime_boundary
,
384 mime_boundary_leader
, opt
->mime_boundary
);
385 extra_headers
= subject_buffer
;
387 get_patch_filename(opt
->numbered_files
? NULL
: commit
, opt
->nr
,
388 opt
->patch_suffix
, &filename
);
389 snprintf(buffer
, sizeof(buffer
) - 1,
391 "Content-Type: text/x-patch;"
393 "Content-Transfer-Encoding: 8bit\n"
394 "Content-Disposition: %s;"
395 " filename=\"%s\"\n\n",
396 mime_boundary_leader
, opt
->mime_boundary
,
398 opt
->no_inline
? "attachment" : "inline",
400 opt
->diffopt
.stat_sep
= buffer
;
401 strbuf_release(&filename
);
403 *subject_p
= subject
;
404 *extra_headers_p
= extra_headers
;
407 static void show_signature(struct rev_info
*opt
, struct commit
*commit
)
409 struct strbuf payload
= STRBUF_INIT
;
410 struct strbuf signature
= STRBUF_INIT
;
411 struct strbuf gpg_output
= STRBUF_INIT
;
413 const char *color
, *reset
, *bol
, *eol
;
415 if (parse_signed_commit(commit
->object
.sha1
, &payload
, &signature
) <= 0)
418 status
= verify_signed_buffer(payload
.buf
, payload
.len
,
419 signature
.buf
, signature
.len
,
421 if (status
&& !gpg_output
.len
)
422 strbuf_addstr(&gpg_output
, "No signature\n");
424 color
= diff_get_color_opt(&opt
->diffopt
,
425 status
? DIFF_WHITESPACE
: DIFF_FRAGINFO
);
426 reset
= diff_get_color_opt(&opt
->diffopt
, DIFF_RESET
);
428 bol
= gpg_output
.buf
;
430 eol
= strchrnul(bol
, '\n');
431 printf("%s%.*s%s%s", color
, (int)(eol
- bol
), bol
, reset
,
433 bol
= (*eol
) ? (eol
+ 1) : eol
;
437 strbuf_release(&gpg_output
);
438 strbuf_release(&payload
);
439 strbuf_release(&signature
);
442 void show_log(struct rev_info
*opt
)
444 struct strbuf msgbuf
= STRBUF_INIT
;
445 struct log_info
*log
= opt
->loginfo
;
446 struct commit
*commit
= log
->commit
, *parent
= log
->parent
;
447 int abbrev_commit
= opt
->abbrev_commit
? opt
->abbrev
: 40;
448 const char *extra_headers
= opt
->extra_headers
;
449 struct pretty_print_context ctx
= {0};
452 ctx
.show_notes
= opt
->show_notes
;
453 if (!opt
->verbose_header
) {
454 graph_show_commit(opt
->graph
);
457 put_revision_mark(opt
, commit
);
458 fputs(find_unique_abbrev(commit
->object
.sha1
, abbrev_commit
), stdout
);
459 if (opt
->print_parents
)
460 show_parents(commit
, abbrev_commit
);
461 if (opt
->children
.name
)
462 show_children(opt
, commit
, abbrev_commit
);
463 show_decorations(opt
, commit
);
464 if (opt
->graph
&& !graph_is_commit_finished(opt
->graph
)) {
466 graph_show_remainder(opt
->graph
);
468 putchar(opt
->diffopt
.line_termination
);
473 * If use_terminator is set, we already handled any record termination
474 * at the end of the last record.
475 * Otherwise, add a diffopt.line_termination character before all
476 * entries but the first. (IOW, as a separator between entries)
478 if (opt
->shown_one
&& !opt
->use_terminator
) {
480 * If entries are separated by a newline, the output
481 * should look human-readable. If the last entry ended
482 * with a newline, print the graph output before this
483 * newline. Otherwise it will end up as a completely blank
484 * line and will look like a gap in the graph.
486 * If the entry separator is not a newline, the output is
487 * primarily intended for programmatic consumption, and we
488 * never want the extra graph output before the entry
491 if (opt
->diffopt
.line_termination
== '\n' &&
492 !opt
->missing_newline
)
493 graph_show_padding(opt
->graph
);
494 putchar(opt
->diffopt
.line_termination
);
499 * If the history graph was requested,
500 * print the graph, up to this commit's line
502 graph_show_commit(opt
->graph
);
505 * Print header line of header..
508 if (opt
->commit_format
== CMIT_FMT_EMAIL
) {
509 log_write_email_headers(opt
, commit
, &ctx
.subject
, &extra_headers
,
511 } else if (opt
->commit_format
!= CMIT_FMT_USERFORMAT
) {
512 fputs(diff_get_color_opt(&opt
->diffopt
, DIFF_COMMIT
), stdout
);
513 if (opt
->commit_format
!= CMIT_FMT_ONELINE
)
514 fputs("commit ", stdout
);
517 put_revision_mark(opt
, commit
);
518 fputs(find_unique_abbrev(commit
->object
.sha1
, abbrev_commit
),
520 if (opt
->print_parents
)
521 show_parents(commit
, abbrev_commit
);
522 if (opt
->children
.name
)
523 show_children(opt
, commit
, abbrev_commit
);
526 find_unique_abbrev(parent
->object
.sha1
,
528 show_decorations(opt
, commit
);
529 printf("%s", diff_get_color_opt(&opt
->diffopt
, DIFF_RESET
));
530 if (opt
->commit_format
== CMIT_FMT_ONELINE
) {
534 graph_show_oneline(opt
->graph
);
536 if (opt
->reflog_info
) {
538 * setup_revisions() ensures that opt->reflog_info
539 * and opt->graph cannot both be set,
540 * so we don't need to worry about printing the
543 show_reflog_message(opt
->reflog_info
,
544 opt
->commit_format
== CMIT_FMT_ONELINE
,
545 opt
->date_mode_explicit
?
548 if (opt
->commit_format
== CMIT_FMT_ONELINE
)
553 if (opt
->show_signature
)
554 show_signature(opt
, commit
);
560 * And then the pretty-printed message itself
562 if (ctx
.need_8bit_cte
>= 0)
563 ctx
.need_8bit_cte
= has_non_ascii(opt
->add_signoff
);
564 ctx
.date_mode
= opt
->date_mode
;
565 ctx
.abbrev
= opt
->diffopt
.abbrev
;
566 ctx
.after_subject
= extra_headers
;
567 ctx
.preserve_subject
= opt
->preserve_subject
;
568 ctx
.reflog_info
= opt
->reflog_info
;
569 ctx
.fmt
= opt
->commit_format
;
570 pretty_print_commit(&ctx
, commit
, &msgbuf
);
572 if (opt
->add_signoff
)
573 append_signoff(&msgbuf
, opt
->add_signoff
);
574 if (opt
->show_log_size
) {
575 printf("log size %i\n", (int)msgbuf
.len
);
576 graph_show_oneline(opt
->graph
);
580 * Set opt->missing_newline if msgbuf doesn't
581 * end in a newline (including if it is empty)
583 if (!msgbuf
.len
|| msgbuf
.buf
[msgbuf
.len
- 1] != '\n')
584 opt
->missing_newline
= 1;
586 opt
->missing_newline
= 0;
589 graph_show_commit_msg(opt
->graph
, &msgbuf
);
591 /* Do not use fwrite() to give MinGW reencoding a chance */
592 printf("%.*s", (int)msgbuf
.len
, msgbuf
.buf
);
593 if (opt
->use_terminator
) {
594 if (!opt
->missing_newline
)
595 graph_show_padding(opt
->graph
);
599 strbuf_release(&msgbuf
);
602 int log_tree_diff_flush(struct rev_info
*opt
)
604 diffcore_std(&opt
->diffopt
);
606 if (diff_queue_is_empty()) {
607 int saved_fmt
= opt
->diffopt
.output_format
;
608 opt
->diffopt
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
609 diff_flush(&opt
->diffopt
);
610 opt
->diffopt
.output_format
= saved_fmt
;
614 if (opt
->loginfo
&& !opt
->no_commit_id
) {
615 /* When showing a verbose header (i.e. log message),
616 * and not in --pretty=oneline format, we would want
617 * an extra newline between the end of log and the
618 * output for readability.
621 if ((opt
->diffopt
.output_format
& ~DIFF_FORMAT_NO_OUTPUT
) &&
622 opt
->verbose_header
&&
623 opt
->commit_format
!= CMIT_FMT_ONELINE
) {
624 int pch
= DIFF_FORMAT_DIFFSTAT
| DIFF_FORMAT_PATCH
;
625 if ((pch
& opt
->diffopt
.output_format
) == pch
)
627 if (opt
->diffopt
.output_prefix
) {
628 struct strbuf
*msg
= NULL
;
629 msg
= opt
->diffopt
.output_prefix(&opt
->diffopt
,
630 opt
->diffopt
.output_prefix_data
);
631 fwrite(msg
->buf
, msg
->len
, 1, stdout
);
636 diff_flush(&opt
->diffopt
);
640 static int do_diff_combined(struct rev_info
*opt
, struct commit
*commit
)
642 unsigned const char *sha1
= commit
->object
.sha1
;
644 diff_tree_combined_merge(sha1
, opt
->dense_combined_merges
, opt
);
645 return !opt
->loginfo
;
649 * Show the diff of a commit.
651 * Return true if we printed any log info messages
653 static int log_tree_diff(struct rev_info
*opt
, struct commit
*commit
, struct log_info
*log
)
656 struct commit_list
*parents
;
657 unsigned const char *sha1
= commit
->object
.sha1
;
659 if (!opt
->diff
&& !DIFF_OPT_TST(&opt
->diffopt
, EXIT_WITH_STATUS
))
663 parents
= commit
->parents
;
665 if (opt
->show_root_diff
) {
666 diff_root_tree_sha1(sha1
, "", &opt
->diffopt
);
667 log_tree_diff_flush(opt
);
669 return !opt
->loginfo
;
672 /* More than one parent? */
673 if (parents
&& parents
->next
) {
674 if (opt
->ignore_merges
)
676 else if (opt
->combine_merges
)
677 return do_diff_combined(opt
, commit
);
678 else if (opt
->first_parent_only
) {
680 * Generate merge log entry only for the first
681 * parent, showing summary diff of the others
684 diff_tree_sha1(parents
->item
->object
.sha1
, sha1
, "", &opt
->diffopt
);
685 log_tree_diff_flush(opt
);
686 return !opt
->loginfo
;
689 /* If we show individual diffs, show the parent info */
690 log
->parent
= parents
->item
;
695 struct commit
*parent
= parents
->item
;
697 diff_tree_sha1(parent
->object
.sha1
, sha1
, "", &opt
->diffopt
);
698 log_tree_diff_flush(opt
);
700 showed_log
|= !opt
->loginfo
;
702 /* Set up the log info for the next parent, if any.. */
703 parents
= parents
->next
;
706 log
->parent
= parents
->item
;
712 int log_tree_commit(struct rev_info
*opt
, struct commit
*commit
)
721 shown
= log_tree_diff(opt
, commit
, &log
);
722 if (!shown
&& opt
->loginfo
&& opt
->always_show_header
) {
728 maybe_flush_or_die(stdout
, "stdout");