Code

Introduce an unlink(2) wrapper which gives warning if unlink failed
[git.git] / log-tree.c
1 #include "cache.h"
2 #include "diff.h"
3 #include "commit.h"
4 #include "tag.h"
5 #include "graph.h"
6 #include "log-tree.h"
7 #include "reflog-walk.h"
8 #include "refs.h"
9 #include "string-list.h"
11 struct decoration name_decoration = { "object names" };
13 static void add_name_decoration(const char *prefix, const char *name, struct object *obj)
14 {
15         int plen = strlen(prefix);
16         int nlen = strlen(name);
17         struct name_decoration *res = xmalloc(sizeof(struct name_decoration) + plen + nlen);
18         memcpy(res->name, prefix, plen);
19         memcpy(res->name + plen, name, nlen + 1);
20         res->next = add_decoration(&name_decoration, obj, res);
21 }
23 static int add_ref_decoration(const char *refname, const unsigned char *sha1, int flags, void *cb_data)
24 {
25         struct object *obj = parse_object(sha1);
26         if (!obj)
27                 return 0;
28         add_name_decoration("", refname, obj);
29         while (obj->type == OBJ_TAG) {
30                 obj = ((struct tag *)obj)->tagged;
31                 if (!obj)
32                         break;
33                 add_name_decoration("tag: ", refname, obj);
34         }
35         return 0;
36 }
38 void load_ref_decorations(void)
39 {
40         static int loaded;
41         if (!loaded) {
42                 loaded = 1;
43                 for_each_ref(add_ref_decoration, NULL);
44         }
45 }
47 static void show_parents(struct commit *commit, int abbrev)
48 {
49         struct commit_list *p;
50         for (p = commit->parents; p ; p = p->next) {
51                 struct commit *parent = p->item;
52                 printf(" %s", find_unique_abbrev(parent->object.sha1, abbrev));
53         }
54 }
56 void show_decorations(struct rev_info *opt, struct commit *commit)
57 {
58         const char *prefix;
59         struct name_decoration *decoration;
61         if (opt->show_source && commit->util)
62                 printf("\t%s", (char *) commit->util);
63         if (!opt->show_decorations)
64                 return;
65         decoration = lookup_decoration(&name_decoration, &commit->object);
66         if (!decoration)
67                 return;
68         prefix = " (";
69         while (decoration) {
70                 printf("%s%s", prefix, decoration->name);
71                 prefix = ", ";
72                 decoration = decoration->next;
73         }
74         putchar(')');
75 }
77 /*
78  * Search for "^[-A-Za-z]+: [^@]+@" pattern. It usually matches
79  * Signed-off-by: and Acked-by: lines.
80  */
81 static int detect_any_signoff(char *letter, int size)
82 {
83         char *cp;
84         int seen_colon = 0;
85         int seen_at = 0;
86         int seen_name = 0;
87         int seen_head = 0;
89         cp = letter + size;
90         while (letter <= --cp && *cp == '\n')
91                 continue;
93         while (letter <= cp) {
94                 char ch = *cp--;
95                 if (ch == '\n')
96                         break;
98                 if (!seen_at) {
99                         if (ch == '@')
100                                 seen_at = 1;
101                         continue;
102                 }
103                 if (!seen_colon) {
104                         if (ch == '@')
105                                 return 0;
106                         else if (ch == ':')
107                                 seen_colon = 1;
108                         else
109                                 seen_name = 1;
110                         continue;
111                 }
112                 if (('A' <= ch && ch <= 'Z') ||
113                     ('a' <= ch && ch <= 'z') ||
114                     ch == '-') {
115                         seen_head = 1;
116                         continue;
117                 }
118                 /* no empty last line doesn't match */
119                 return 0;
120         }
121         return seen_head && seen_name;
124 static void append_signoff(struct strbuf *sb, const char *signoff)
126         static const char signed_off_by[] = "Signed-off-by: ";
127         size_t signoff_len = strlen(signoff);
128         int has_signoff = 0;
129         char *cp;
131         cp = sb->buf;
133         /* First see if we already have the sign-off by the signer */
134         while ((cp = strstr(cp, signed_off_by))) {
136                 has_signoff = 1;
138                 cp += strlen(signed_off_by);
139                 if (cp + signoff_len >= sb->buf + sb->len)
140                         break;
141                 if (strncmp(cp, signoff, signoff_len))
142                         continue;
143                 if (!isspace(cp[signoff_len]))
144                         continue;
145                 /* we already have him */
146                 return;
147         }
149         if (!has_signoff)
150                 has_signoff = detect_any_signoff(sb->buf, sb->len);
152         if (!has_signoff)
153                 strbuf_addch(sb, '\n');
155         strbuf_addstr(sb, signed_off_by);
156         strbuf_add(sb, signoff, signoff_len);
157         strbuf_addch(sb, '\n');
160 static unsigned int digits_in_number(unsigned int number)
162         unsigned int i = 10, result = 1;
163         while (i <= number) {
164                 i *= 10;
165                 result++;
166         }
167         return result;
170 static int has_non_ascii(const char *s)
172         int ch;
173         if (!s)
174                 return 0;
175         while ((ch = *s++) != '\0') {
176                 if (non_ascii(ch))
177                         return 1;
178         }
179         return 0;
182 void get_patch_filename(struct commit *commit, int nr, const char *suffix,
183                         struct strbuf *buf)
185         int suffix_len = strlen(suffix) + 1;
186         int start_len = buf->len;
188         strbuf_addf(buf, commit ? "%04d-" : "%d", nr);
189         if (commit) {
190                 int max_len = start_len + FORMAT_PATCH_NAME_MAX - suffix_len;
192                 format_commit_message(commit, "%f", buf, DATE_NORMAL);
193                 if (max_len < buf->len)
194                         strbuf_setlen(buf, max_len);
195                 strbuf_addstr(buf, suffix);
196         }
199 void log_write_email_headers(struct rev_info *opt, struct commit *commit,
200                              const char **subject_p,
201                              const char **extra_headers_p,
202                              int *need_8bit_cte_p)
204         const char *subject = NULL;
205         const char *extra_headers = opt->extra_headers;
206         const char *name = sha1_to_hex(commit->object.sha1);
208         *need_8bit_cte_p = 0; /* unknown */
209         if (opt->total > 0) {
210                 static char buffer[64];
211                 snprintf(buffer, sizeof(buffer),
212                          "Subject: [%s %0*d/%d] ",
213                          opt->subject_prefix,
214                          digits_in_number(opt->total),
215                          opt->nr, opt->total);
216                 subject = buffer;
217         } else if (opt->total == 0 && opt->subject_prefix && *opt->subject_prefix) {
218                 static char buffer[256];
219                 snprintf(buffer, sizeof(buffer),
220                          "Subject: [%s] ",
221                          opt->subject_prefix);
222                 subject = buffer;
223         } else {
224                 subject = "Subject: ";
225         }
227         printf("From %s Mon Sep 17 00:00:00 2001\n", name);
228         graph_show_oneline(opt->graph);
229         if (opt->message_id) {
230                 printf("Message-Id: <%s>\n", opt->message_id);
231                 graph_show_oneline(opt->graph);
232         }
233         if (opt->ref_message_ids && opt->ref_message_ids->nr > 0) {
234                 int i, n;
235                 n = opt->ref_message_ids->nr;
236                 printf("In-Reply-To: <%s>\n", opt->ref_message_ids->items[n-1].string);
237                 for (i = 0; i < n; i++)
238                         printf("%s<%s>\n", (i > 0 ? "\t" : "References: "),
239                                opt->ref_message_ids->items[i].string);
240                 graph_show_oneline(opt->graph);
241         }
242         if (opt->mime_boundary) {
243                 static char subject_buffer[1024];
244                 static char buffer[1024];
245                 struct strbuf filename =  STRBUF_INIT;
246                 *need_8bit_cte_p = -1; /* NEVER */
247                 snprintf(subject_buffer, sizeof(subject_buffer) - 1,
248                          "%s"
249                          "MIME-Version: 1.0\n"
250                          "Content-Type: multipart/mixed;"
251                          " boundary=\"%s%s\"\n"
252                          "\n"
253                          "This is a multi-part message in MIME "
254                          "format.\n"
255                          "--%s%s\n"
256                          "Content-Type: text/plain; "
257                          "charset=UTF-8; format=fixed\n"
258                          "Content-Transfer-Encoding: 8bit\n\n",
259                          extra_headers ? extra_headers : "",
260                          mime_boundary_leader, opt->mime_boundary,
261                          mime_boundary_leader, opt->mime_boundary);
262                 extra_headers = subject_buffer;
264                 get_patch_filename(opt->numbered_files ? NULL : commit, opt->nr,
265                                     opt->patch_suffix, &filename);
266                 snprintf(buffer, sizeof(buffer) - 1,
267                          "\n--%s%s\n"
268                          "Content-Type: text/x-patch;"
269                          " name=\"%s\"\n"
270                          "Content-Transfer-Encoding: 8bit\n"
271                          "Content-Disposition: %s;"
272                          " filename=\"%s\"\n\n",
273                          mime_boundary_leader, opt->mime_boundary,
274                          filename.buf,
275                          opt->no_inline ? "attachment" : "inline",
276                          filename.buf);
277                 opt->diffopt.stat_sep = buffer;
278                 strbuf_release(&filename);
279         }
280         *subject_p = subject;
281         *extra_headers_p = extra_headers;
284 void show_log(struct rev_info *opt)
286         struct strbuf msgbuf = STRBUF_INIT;
287         struct log_info *log = opt->loginfo;
288         struct commit *commit = log->commit, *parent = log->parent;
289         int abbrev = opt->diffopt.abbrev;
290         int abbrev_commit = opt->abbrev_commit ? opt->abbrev : 40;
291         const char *subject = NULL, *extra_headers = opt->extra_headers;
292         int need_8bit_cte = 0;
294         opt->loginfo = NULL;
295         if (!opt->verbose_header) {
296                 graph_show_commit(opt->graph);
298                 if (!opt->graph) {
299                         if (commit->object.flags & BOUNDARY)
300                                 putchar('-');
301                         else if (commit->object.flags & UNINTERESTING)
302                                 putchar('^');
303                         else if (opt->left_right) {
304                                 if (commit->object.flags & SYMMETRIC_LEFT)
305                                         putchar('<');
306                                 else
307                                         putchar('>');
308                         }
309                 }
310                 fputs(find_unique_abbrev(commit->object.sha1, abbrev_commit), stdout);
311                 if (opt->print_parents)
312                         show_parents(commit, abbrev_commit);
313                 show_decorations(opt, commit);
314                 if (opt->graph && !graph_is_commit_finished(opt->graph)) {
315                         putchar('\n');
316                         graph_show_remainder(opt->graph);
317                 }
318                 putchar(opt->diffopt.line_termination);
319                 return;
320         }
322         /*
323          * If use_terminator is set, add a newline at the end of the entry.
324          * Otherwise, add a diffopt.line_termination character before all
325          * entries but the first.  (IOW, as a separator between entries)
326          */
327         if (opt->shown_one && !opt->use_terminator) {
328                 /*
329                  * If entries are separated by a newline, the output
330                  * should look human-readable.  If the last entry ended
331                  * with a newline, print the graph output before this
332                  * newline.  Otherwise it will end up as a completely blank
333                  * line and will look like a gap in the graph.
334                  *
335                  * If the entry separator is not a newline, the output is
336                  * primarily intended for programmatic consumption, and we
337                  * never want the extra graph output before the entry
338                  * separator.
339                  */
340                 if (opt->diffopt.line_termination == '\n' &&
341                     !opt->missing_newline)
342                         graph_show_padding(opt->graph);
343                 putchar(opt->diffopt.line_termination);
344         }
345         opt->shown_one = 1;
347         /*
348          * If the history graph was requested,
349          * print the graph, up to this commit's line
350          */
351         graph_show_commit(opt->graph);
353         /*
354          * Print header line of header..
355          */
357         if (opt->commit_format == CMIT_FMT_EMAIL) {
358                 log_write_email_headers(opt, commit, &subject, &extra_headers,
359                                         &need_8bit_cte);
360         } else if (opt->commit_format != CMIT_FMT_USERFORMAT) {
361                 fputs(diff_get_color_opt(&opt->diffopt, DIFF_COMMIT), stdout);
362                 if (opt->commit_format != CMIT_FMT_ONELINE)
363                         fputs("commit ", stdout);
365                 if (!opt->graph) {
366                         if (commit->object.flags & BOUNDARY)
367                                 putchar('-');
368                         else if (commit->object.flags & UNINTERESTING)
369                                 putchar('^');
370                         else if (opt->left_right) {
371                                 if (commit->object.flags & SYMMETRIC_LEFT)
372                                         putchar('<');
373                                 else
374                                         putchar('>');
375                         }
376                 }
377                 fputs(find_unique_abbrev(commit->object.sha1, abbrev_commit),
378                       stdout);
379                 if (opt->print_parents)
380                         show_parents(commit, abbrev_commit);
381                 if (parent)
382                         printf(" (from %s)",
383                                find_unique_abbrev(parent->object.sha1,
384                                                   abbrev_commit));
385                 show_decorations(opt, commit);
386                 printf("%s", diff_get_color_opt(&opt->diffopt, DIFF_RESET));
387                 if (opt->commit_format == CMIT_FMT_ONELINE) {
388                         putchar(' ');
389                 } else {
390                         putchar('\n');
391                         graph_show_oneline(opt->graph);
392                 }
393                 if (opt->reflog_info) {
394                         /*
395                          * setup_revisions() ensures that opt->reflog_info
396                          * and opt->graph cannot both be set,
397                          * so we don't need to worry about printing the
398                          * graph info here.
399                          */
400                         show_reflog_message(opt->reflog_info,
401                                     opt->commit_format == CMIT_FMT_ONELINE,
402                                     opt->date_mode);
403                         if (opt->commit_format == CMIT_FMT_ONELINE)
404                                 return;
405                 }
406         }
408         if (!commit->buffer)
409                 return;
411         /*
412          * And then the pretty-printed message itself
413          */
414         if (need_8bit_cte >= 0)
415                 need_8bit_cte = has_non_ascii(opt->add_signoff);
416         pretty_print_commit(opt->commit_format, commit, &msgbuf,
417                             abbrev, subject, extra_headers, opt->date_mode,
418                             need_8bit_cte);
420         if (opt->add_signoff)
421                 append_signoff(&msgbuf, opt->add_signoff);
422         if (opt->show_log_size) {
423                 printf("log size %i\n", (int)msgbuf.len);
424                 graph_show_oneline(opt->graph);
425         }
427         /*
428          * Set opt->missing_newline if msgbuf doesn't
429          * end in a newline (including if it is empty)
430          */
431         if (!msgbuf.len || msgbuf.buf[msgbuf.len - 1] != '\n')
432                 opt->missing_newline = 1;
433         else
434                 opt->missing_newline = 0;
436         if (opt->graph)
437                 graph_show_commit_msg(opt->graph, &msgbuf);
438         else
439                 fwrite(msgbuf.buf, sizeof(char), msgbuf.len, stdout);
440         if (opt->use_terminator) {
441                 if (!opt->missing_newline)
442                         graph_show_padding(opt->graph);
443                 putchar('\n');
444         }
446         strbuf_release(&msgbuf);
449 int log_tree_diff_flush(struct rev_info *opt)
451         diffcore_std(&opt->diffopt);
453         if (diff_queue_is_empty()) {
454                 int saved_fmt = opt->diffopt.output_format;
455                 opt->diffopt.output_format = DIFF_FORMAT_NO_OUTPUT;
456                 diff_flush(&opt->diffopt);
457                 opt->diffopt.output_format = saved_fmt;
458                 return 0;
459         }
461         if (opt->loginfo && !opt->no_commit_id) {
462                 /* When showing a verbose header (i.e. log message),
463                  * and not in --pretty=oneline format, we would want
464                  * an extra newline between the end of log and the
465                  * output for readability.
466                  */
467                 show_log(opt);
468                 if ((opt->diffopt.output_format & ~DIFF_FORMAT_NO_OUTPUT) &&
469                     opt->verbose_header &&
470                     opt->commit_format != CMIT_FMT_ONELINE) {
471                         int pch = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_PATCH;
472                         if ((pch & opt->diffopt.output_format) == pch)
473                                 printf("---");
474                         putchar('\n');
475                 }
476         }
477         diff_flush(&opt->diffopt);
478         return 1;
481 static int do_diff_combined(struct rev_info *opt, struct commit *commit)
483         unsigned const char *sha1 = commit->object.sha1;
485         diff_tree_combined_merge(sha1, opt->dense_combined_merges, opt);
486         return !opt->loginfo;
489 /*
490  * Show the diff of a commit.
491  *
492  * Return true if we printed any log info messages
493  */
494 static int log_tree_diff(struct rev_info *opt, struct commit *commit, struct log_info *log)
496         int showed_log;
497         struct commit_list *parents;
498         unsigned const char *sha1 = commit->object.sha1;
500         if (!opt->diff && !DIFF_OPT_TST(&opt->diffopt, EXIT_WITH_STATUS))
501                 return 0;
503         /* Root commit? */
504         parents = commit->parents;
505         if (!parents) {
506                 if (opt->show_root_diff) {
507                         diff_root_tree_sha1(sha1, "", &opt->diffopt);
508                         log_tree_diff_flush(opt);
509                 }
510                 return !opt->loginfo;
511         }
513         /* More than one parent? */
514         if (parents && parents->next) {
515                 if (opt->ignore_merges)
516                         return 0;
517                 else if (opt->combine_merges)
518                         return do_diff_combined(opt, commit);
520                 /* If we show individual diffs, show the parent info */
521                 log->parent = parents->item;
522         }
524         showed_log = 0;
525         for (;;) {
526                 struct commit *parent = parents->item;
528                 diff_tree_sha1(parent->object.sha1, sha1, "", &opt->diffopt);
529                 log_tree_diff_flush(opt);
531                 showed_log |= !opt->loginfo;
533                 /* Set up the log info for the next parent, if any.. */
534                 parents = parents->next;
535                 if (!parents)
536                         break;
537                 log->parent = parents->item;
538                 opt->loginfo = log;
539         }
540         return showed_log;
543 int log_tree_commit(struct rev_info *opt, struct commit *commit)
545         struct log_info log;
546         int shown;
548         log.commit = commit;
549         log.parent = NULL;
550         opt->loginfo = &log;
552         shown = log_tree_diff(opt, commit, &log);
553         if (!shown && opt->loginfo && opt->always_show_header) {
554                 log.parent = NULL;
555                 show_log(opt);
556                 shown = 1;
557         }
558         opt->loginfo = NULL;
559         maybe_flush_or_die(stdout, "stdout");
560         return shown;