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