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