log-tree.c

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