builtin-log.con commit format-patch: --attach/inline uses filename instead of SHA1 (108dab2)
   1/*
   2 * Builtin "git log" and related commands (show, whatchanged)
   3 *
   4 * (C) Copyright 2006 Linus Torvalds
   5 *               2006 Junio Hamano
   6 */
   7#include "cache.h"
   8#include "color.h"
   9#include "commit.h"
  10#include "diff.h"
  11#include "revision.h"
  12#include "log-tree.h"
  13#include "builtin.h"
  14#include "tag.h"
  15#include "reflog-walk.h"
  16#include "patch-ids.h"
  17#include "run-command.h"
  18#include "shortlog.h"
  19#include "remote.h"
  20#include "string-list.h"
  21
  22/* Set a default date-time format for git log ("log.date" config variable) */
  23static const char *default_date_mode = NULL;
  24
  25static int default_show_root = 1;
  26static const char *fmt_patch_subject_prefix = "PATCH";
  27static const char *fmt_pretty;
  28
  29static void cmd_log_init(int argc, const char **argv, const char *prefix,
  30                      struct rev_info *rev)
  31{
  32        int i;
  33
  34        rev->abbrev = DEFAULT_ABBREV;
  35        rev->commit_format = CMIT_FMT_DEFAULT;
  36        if (fmt_pretty)
  37                get_commit_format(fmt_pretty, rev);
  38        rev->verbose_header = 1;
  39        DIFF_OPT_SET(&rev->diffopt, RECURSIVE);
  40        rev->show_root_diff = default_show_root;
  41        rev->subject_prefix = fmt_patch_subject_prefix;
  42        DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
  43
  44        if (default_date_mode)
  45                rev->date_mode = parse_date_format(default_date_mode);
  46
  47        argc = setup_revisions(argc, argv, rev, "HEAD");
  48
  49        if (rev->diffopt.pickaxe || rev->diffopt.filter)
  50                rev->always_show_header = 0;
  51        if (DIFF_OPT_TST(&rev->diffopt, FOLLOW_RENAMES)) {
  52                rev->always_show_header = 0;
  53                if (rev->diffopt.nr_paths != 1)
  54                        usage("git logs can only follow renames on one pathname at a time");
  55        }
  56        for (i = 1; i < argc; i++) {
  57                const char *arg = argv[i];
  58                if (!strcmp(arg, "--decorate")) {
  59                        load_ref_decorations();
  60                        rev->show_decorations = 1;
  61                } else if (!strcmp(arg, "--source")) {
  62                        rev->show_source = 1;
  63                } else
  64                        die("unrecognized argument: %s", arg);
  65        }
  66}
  67
  68/*
  69 * This gives a rough estimate for how many commits we
  70 * will print out in the list.
  71 */
  72static int estimate_commit_count(struct rev_info *rev, struct commit_list *list)
  73{
  74        int n = 0;
  75
  76        while (list) {
  77                struct commit *commit = list->item;
  78                unsigned int flags = commit->object.flags;
  79                list = list->next;
  80                if (!(flags & (TREESAME | UNINTERESTING)))
  81                        n++;
  82        }
  83        return n;
  84}
  85
  86static void show_early_header(struct rev_info *rev, const char *stage, int nr)
  87{
  88        if (rev->shown_one) {
  89                rev->shown_one = 0;
  90                if (rev->commit_format != CMIT_FMT_ONELINE)
  91                        putchar(rev->diffopt.line_termination);
  92        }
  93        printf("Final output: %d %s\n", nr, stage);
  94}
  95
  96struct itimerval early_output_timer;
  97
  98static void log_show_early(struct rev_info *revs, struct commit_list *list)
  99{
 100        int i = revs->early_output;
 101        int show_header = 1;
 102
 103        sort_in_topological_order(&list, revs->lifo);
 104        while (list && i) {
 105                struct commit *commit = list->item;
 106                switch (simplify_commit(revs, commit)) {
 107                case commit_show:
 108                        if (show_header) {
 109                                int n = estimate_commit_count(revs, list);
 110                                show_early_header(revs, "incomplete", n);
 111                                show_header = 0;
 112                        }
 113                        log_tree_commit(revs, commit);
 114                        i--;
 115                        break;
 116                case commit_ignore:
 117                        break;
 118                case commit_error:
 119                        return;
 120                }
 121                list = list->next;
 122        }
 123
 124        /* Did we already get enough commits for the early output? */
 125        if (!i)
 126                return;
 127
 128        /*
 129         * ..if no, then repeat it twice a second until we
 130         * do.
 131         *
 132         * NOTE! We don't use "it_interval", because if the
 133         * reader isn't listening, we want our output to be
 134         * throttled by the writing, and not have the timer
 135         * trigger every second even if we're blocked on a
 136         * reader!
 137         */
 138        early_output_timer.it_value.tv_sec = 0;
 139        early_output_timer.it_value.tv_usec = 500000;
 140        setitimer(ITIMER_REAL, &early_output_timer, NULL);
 141}
 142
 143static void early_output(int signal)
 144{
 145        show_early_output = log_show_early;
 146}
 147
 148static void setup_early_output(struct rev_info *rev)
 149{
 150        struct sigaction sa;
 151
 152        /*
 153         * Set up the signal handler, minimally intrusively:
 154         * we only set a single volatile integer word (not
 155         * using sigatomic_t - trying to avoid unnecessary
 156         * system dependencies and headers), and using
 157         * SA_RESTART.
 158         */
 159        memset(&sa, 0, sizeof(sa));
 160        sa.sa_handler = early_output;
 161        sigemptyset(&sa.sa_mask);
 162        sa.sa_flags = SA_RESTART;
 163        sigaction(SIGALRM, &sa, NULL);
 164
 165        /*
 166         * If we can get the whole output in less than a
 167         * tenth of a second, don't even bother doing the
 168         * early-output thing..
 169         *
 170         * This is a one-time-only trigger.
 171         */
 172        early_output_timer.it_value.tv_sec = 0;
 173        early_output_timer.it_value.tv_usec = 100000;
 174        setitimer(ITIMER_REAL, &early_output_timer, NULL);
 175}
 176
 177static void finish_early_output(struct rev_info *rev)
 178{
 179        int n = estimate_commit_count(rev, rev->commits);
 180        signal(SIGALRM, SIG_IGN);
 181        show_early_header(rev, "done", n);
 182}
 183
 184static int cmd_log_walk(struct rev_info *rev)
 185{
 186        struct commit *commit;
 187
 188        if (rev->early_output)
 189                setup_early_output(rev);
 190
 191        if (prepare_revision_walk(rev))
 192                die("revision walk setup failed");
 193
 194        if (rev->early_output)
 195                finish_early_output(rev);
 196
 197        /*
 198         * For --check and --exit-code, the exit code is based on CHECK_FAILED
 199         * and HAS_CHANGES being accumulated in rev->diffopt, so be careful to
 200         * retain that state information if replacing rev->diffopt in this loop
 201         */
 202        while ((commit = get_revision(rev)) != NULL) {
 203                log_tree_commit(rev, commit);
 204                if (!rev->reflog_info) {
 205                        /* we allow cycles in reflog ancestry */
 206                        free(commit->buffer);
 207                        commit->buffer = NULL;
 208                }
 209                free_commit_list(commit->parents);
 210                commit->parents = NULL;
 211        }
 212        if (rev->diffopt.output_format & DIFF_FORMAT_CHECKDIFF &&
 213            DIFF_OPT_TST(&rev->diffopt, CHECK_FAILED)) {
 214                return 02;
 215        }
 216        return diff_result_code(&rev->diffopt, 0);
 217}
 218
 219static int git_log_config(const char *var, const char *value, void *cb)
 220{
 221        if (!strcmp(var, "format.pretty"))
 222                return git_config_string(&fmt_pretty, var, value);
 223        if (!strcmp(var, "format.subjectprefix"))
 224                return git_config_string(&fmt_patch_subject_prefix, var, value);
 225        if (!strcmp(var, "log.date"))
 226                return git_config_string(&default_date_mode, var, value);
 227        if (!strcmp(var, "log.showroot")) {
 228                default_show_root = git_config_bool(var, value);
 229                return 0;
 230        }
 231        return git_diff_ui_config(var, value, cb);
 232}
 233
 234int cmd_whatchanged(int argc, const char **argv, const char *prefix)
 235{
 236        struct rev_info rev;
 237
 238        git_config(git_log_config, NULL);
 239
 240        if (diff_use_color_default == -1)
 241                diff_use_color_default = git_use_color_default;
 242
 243        init_revisions(&rev, prefix);
 244        rev.diff = 1;
 245        rev.simplify_history = 0;
 246        cmd_log_init(argc, argv, prefix, &rev);
 247        if (!rev.diffopt.output_format)
 248                rev.diffopt.output_format = DIFF_FORMAT_RAW;
 249        return cmd_log_walk(&rev);
 250}
 251
 252static void show_tagger(char *buf, int len, struct rev_info *rev)
 253{
 254        struct strbuf out = STRBUF_INIT;
 255
 256        pp_user_info("Tagger", rev->commit_format, &out, buf, rev->date_mode,
 257                git_log_output_encoding ?
 258                git_log_output_encoding: git_commit_encoding);
 259        printf("%s\n", out.buf);
 260        strbuf_release(&out);
 261}
 262
 263static int show_object(const unsigned char *sha1, int show_tag_object,
 264        struct rev_info *rev)
 265{
 266        unsigned long size;
 267        enum object_type type;
 268        char *buf = read_sha1_file(sha1, &type, &size);
 269        int offset = 0;
 270
 271        if (!buf)
 272                return error("Could not read object %s", sha1_to_hex(sha1));
 273
 274        if (show_tag_object)
 275                while (offset < size && buf[offset] != '\n') {
 276                        int new_offset = offset + 1;
 277                        while (new_offset < size && buf[new_offset++] != '\n')
 278                                ; /* do nothing */
 279                        if (!prefixcmp(buf + offset, "tagger "))
 280                                show_tagger(buf + offset + 7,
 281                                            new_offset - offset - 7, rev);
 282                        offset = new_offset;
 283                }
 284
 285        if (offset < size)
 286                fwrite(buf + offset, size - offset, 1, stdout);
 287        free(buf);
 288        return 0;
 289}
 290
 291static int show_tree_object(const unsigned char *sha1,
 292                const char *base, int baselen,
 293                const char *pathname, unsigned mode, int stage, void *context)
 294{
 295        printf("%s%s\n", pathname, S_ISDIR(mode) ? "/" : "");
 296        return 0;
 297}
 298
 299int cmd_show(int argc, const char **argv, const char *prefix)
 300{
 301        struct rev_info rev;
 302        struct object_array_entry *objects;
 303        int i, count, ret = 0;
 304
 305        git_config(git_log_config, NULL);
 306
 307        if (diff_use_color_default == -1)
 308                diff_use_color_default = git_use_color_default;
 309
 310        init_revisions(&rev, prefix);
 311        rev.diff = 1;
 312        rev.combine_merges = 1;
 313        rev.dense_combined_merges = 1;
 314        rev.always_show_header = 1;
 315        rev.ignore_merges = 0;
 316        rev.no_walk = 1;
 317        cmd_log_init(argc, argv, prefix, &rev);
 318
 319        count = rev.pending.nr;
 320        objects = rev.pending.objects;
 321        for (i = 0; i < count && !ret; i++) {
 322                struct object *o = objects[i].item;
 323                const char *name = objects[i].name;
 324                switch (o->type) {
 325                case OBJ_BLOB:
 326                        ret = show_object(o->sha1, 0, NULL);
 327                        break;
 328                case OBJ_TAG: {
 329                        struct tag *t = (struct tag *)o;
 330
 331                        printf("%stag %s%s\n",
 332                                        diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
 333                                        t->tag,
 334                                        diff_get_color_opt(&rev.diffopt, DIFF_RESET));
 335                        ret = show_object(o->sha1, 1, &rev);
 336                        if (ret)
 337                                break;
 338                        o = parse_object(t->tagged->sha1);
 339                        if (!o)
 340                                ret = error("Could not read object %s",
 341                                            sha1_to_hex(t->tagged->sha1));
 342                        objects[i].item = o;
 343                        i--;
 344                        break;
 345                }
 346                case OBJ_TREE:
 347                        printf("%stree %s%s\n\n",
 348                                        diff_get_color_opt(&rev.diffopt, DIFF_COMMIT),
 349                                        name,
 350                                        diff_get_color_opt(&rev.diffopt, DIFF_RESET));
 351                        read_tree_recursive((struct tree *)o, "", 0, 0, NULL,
 352                                        show_tree_object, NULL);
 353                        break;
 354                case OBJ_COMMIT:
 355                        rev.pending.nr = rev.pending.alloc = 0;
 356                        rev.pending.objects = NULL;
 357                        add_object_array(o, name, &rev.pending);
 358                        ret = cmd_log_walk(&rev);
 359                        break;
 360                default:
 361                        ret = error("Unknown type: %d", o->type);
 362                }
 363        }
 364        free(objects);
 365        return ret;
 366}
 367
 368/*
 369 * This is equivalent to "git log -g --abbrev-commit --pretty=oneline"
 370 */
 371int cmd_log_reflog(int argc, const char **argv, const char *prefix)
 372{
 373        struct rev_info rev;
 374
 375        git_config(git_log_config, NULL);
 376
 377        if (diff_use_color_default == -1)
 378                diff_use_color_default = git_use_color_default;
 379
 380        init_revisions(&rev, prefix);
 381        init_reflog_walk(&rev.reflog_info);
 382        rev.abbrev_commit = 1;
 383        rev.verbose_header = 1;
 384        cmd_log_init(argc, argv, prefix, &rev);
 385
 386        /*
 387         * This means that we override whatever commit format the user gave
 388         * on the cmd line.  Sad, but cmd_log_init() currently doesn't
 389         * allow us to set a different default.
 390         */
 391        rev.commit_format = CMIT_FMT_ONELINE;
 392        rev.use_terminator = 1;
 393        rev.always_show_header = 1;
 394
 395        /*
 396         * We get called through "git reflog", so unlike the other log
 397         * routines, we need to set up our pager manually..
 398         */
 399        setup_pager();
 400
 401        return cmd_log_walk(&rev);
 402}
 403
 404int cmd_log(int argc, const char **argv, const char *prefix)
 405{
 406        struct rev_info rev;
 407
 408        git_config(git_log_config, NULL);
 409
 410        if (diff_use_color_default == -1)
 411                diff_use_color_default = git_use_color_default;
 412
 413        init_revisions(&rev, prefix);
 414        rev.always_show_header = 1;
 415        cmd_log_init(argc, argv, prefix, &rev);
 416        return cmd_log_walk(&rev);
 417}
 418
 419/* format-patch */
 420
 421static const char *fmt_patch_suffix = ".patch";
 422static int numbered = 0;
 423static int auto_number = 1;
 424
 425static char *default_attach = NULL;
 426
 427static char **extra_hdr;
 428static int extra_hdr_nr;
 429static int extra_hdr_alloc;
 430
 431static char **extra_to;
 432static int extra_to_nr;
 433static int extra_to_alloc;
 434
 435static char **extra_cc;
 436static int extra_cc_nr;
 437static int extra_cc_alloc;
 438
 439static void add_header(const char *value)
 440{
 441        int len = strlen(value);
 442        while (len && value[len - 1] == '\n')
 443                len--;
 444        if (!strncasecmp(value, "to: ", 4)) {
 445                ALLOC_GROW(extra_to, extra_to_nr + 1, extra_to_alloc);
 446                extra_to[extra_to_nr++] = xstrndup(value + 4, len - 4);
 447                return;
 448        }
 449        if (!strncasecmp(value, "cc: ", 4)) {
 450                ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
 451                extra_cc[extra_cc_nr++] = xstrndup(value + 4, len - 4);
 452                return;
 453        }
 454        ALLOC_GROW(extra_hdr, extra_hdr_nr + 1, extra_hdr_alloc);
 455        extra_hdr[extra_hdr_nr++] = xstrndup(value, len);
 456}
 457
 458#define THREAD_SHALLOW 1
 459#define THREAD_DEEP 2
 460static int thread = 0;
 461
 462static int git_format_config(const char *var, const char *value, void *cb)
 463{
 464        if (!strcmp(var, "format.headers")) {
 465                if (!value)
 466                        die("format.headers without value");
 467                add_header(value);
 468                return 0;
 469        }
 470        if (!strcmp(var, "format.suffix"))
 471                return git_config_string(&fmt_patch_suffix, var, value);
 472        if (!strcmp(var, "format.cc")) {
 473                if (!value)
 474                        return config_error_nonbool(var);
 475                ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
 476                extra_cc[extra_cc_nr++] = xstrdup(value);
 477                return 0;
 478        }
 479        if (!strcmp(var, "diff.color") || !strcmp(var, "color.diff")) {
 480                return 0;
 481        }
 482        if (!strcmp(var, "format.numbered")) {
 483                if (value && !strcasecmp(value, "auto")) {
 484                        auto_number = 1;
 485                        return 0;
 486                }
 487                numbered = git_config_bool(var, value);
 488                auto_number = auto_number && numbered;
 489                return 0;
 490        }
 491        if (!strcmp(var, "format.attach")) {
 492                if (value && *value)
 493                        default_attach = xstrdup(value);
 494                else
 495                        default_attach = xstrdup(git_version_string);
 496                return 0;
 497        }
 498        if (!strcmp(var, "format.thread")) {
 499                if (value && !strcasecmp(value, "deep")) {
 500                        thread = THREAD_DEEP;
 501                        return 0;
 502                }
 503                if (value && !strcasecmp(value, "shallow")) {
 504                        thread = THREAD_SHALLOW;
 505                        return 0;
 506                }
 507                thread = git_config_bool(var, value) && THREAD_SHALLOW;
 508                return 0;
 509        }
 510
 511        return git_log_config(var, value, cb);
 512}
 513
 514static FILE *realstdout = NULL;
 515static const char *output_directory = NULL;
 516static int outdir_offset;
 517
 518static int reopen_stdout(struct commit *commit, struct rev_info *rev)
 519{
 520        struct strbuf filename = STRBUF_INIT;
 521        int suffix_len = strlen(fmt_patch_suffix) + 1;
 522
 523        if (output_directory) {
 524                strbuf_addstr(&filename, output_directory);
 525                if (filename.len >=
 526                    PATH_MAX - FORMAT_PATCH_NAME_MAX - suffix_len)
 527                        return error("name of output directory is too long");
 528                if (filename.buf[filename.len - 1] != '/')
 529                        strbuf_addch(&filename, '/');
 530        }
 531
 532        get_patch_filename(commit, rev->nr, fmt_patch_suffix, &filename);
 533
 534        if (!DIFF_OPT_TST(&rev->diffopt, QUIET))
 535                fprintf(realstdout, "%s\n", filename.buf + outdir_offset);
 536
 537        if (freopen(filename.buf, "w", stdout) == NULL)
 538                return error("Cannot open patch file %s", filename.buf);
 539
 540        strbuf_release(&filename);
 541        return 0;
 542}
 543
 544static void get_patch_ids(struct rev_info *rev, struct patch_ids *ids, const char *prefix)
 545{
 546        struct rev_info check_rev;
 547        struct commit *commit;
 548        struct object *o1, *o2;
 549        unsigned flags1, flags2;
 550
 551        if (rev->pending.nr != 2)
 552                die("Need exactly one range.");
 553
 554        o1 = rev->pending.objects[0].item;
 555        flags1 = o1->flags;
 556        o2 = rev->pending.objects[1].item;
 557        flags2 = o2->flags;
 558
 559        if ((flags1 & UNINTERESTING) == (flags2 & UNINTERESTING))
 560                die("Not a range.");
 561
 562        init_patch_ids(ids);
 563
 564        /* given a range a..b get all patch ids for b..a */
 565        init_revisions(&check_rev, prefix);
 566        o1->flags ^= UNINTERESTING;
 567        o2->flags ^= UNINTERESTING;
 568        add_pending_object(&check_rev, o1, "o1");
 569        add_pending_object(&check_rev, o2, "o2");
 570        if (prepare_revision_walk(&check_rev))
 571                die("revision walk setup failed");
 572
 573        while ((commit = get_revision(&check_rev)) != NULL) {
 574                /* ignore merges */
 575                if (commit->parents && commit->parents->next)
 576                        continue;
 577
 578                add_commit_patch_id(commit, ids);
 579        }
 580
 581        /* reset for next revision walk */
 582        clear_commit_marks((struct commit *)o1,
 583                        SEEN | UNINTERESTING | SHOWN | ADDED);
 584        clear_commit_marks((struct commit *)o2,
 585                        SEEN | UNINTERESTING | SHOWN | ADDED);
 586        o1->flags = flags1;
 587        o2->flags = flags2;
 588}
 589
 590static void gen_message_id(struct rev_info *info, char *base)
 591{
 592        const char *committer = git_committer_info(IDENT_WARN_ON_NO_NAME);
 593        const char *email_start = strrchr(committer, '<');
 594        const char *email_end = strrchr(committer, '>');
 595        struct strbuf buf = STRBUF_INIT;
 596        if (!email_start || !email_end || email_start > email_end - 1)
 597                die("Could not extract email from committer identity.");
 598        strbuf_addf(&buf, "%s.%lu.git.%.*s", base,
 599                    (unsigned long) time(NULL),
 600                    (int)(email_end - email_start - 1), email_start + 1);
 601        info->message_id = strbuf_detach(&buf, NULL);
 602}
 603
 604static void make_cover_letter(struct rev_info *rev, int use_stdout,
 605                              int numbered, int numbered_files,
 606                              struct commit *origin,
 607                              int nr, struct commit **list, struct commit *head)
 608{
 609        const char *committer;
 610        const char *subject_start = NULL;
 611        const char *body = "*** SUBJECT HERE ***\n\n*** BLURB HERE ***\n";
 612        const char *msg;
 613        const char *extra_headers = rev->extra_headers;
 614        struct shortlog log;
 615        struct strbuf sb = STRBUF_INIT;
 616        int i;
 617        const char *encoding = "utf-8";
 618        struct diff_options opts;
 619        int need_8bit_cte = 0;
 620        struct commit *commit = NULL;
 621
 622        if (rev->commit_format != CMIT_FMT_EMAIL)
 623                die("Cover letter needs email format");
 624
 625        committer = git_committer_info(0);
 626
 627        if (!numbered_files) {
 628                /*
 629                 * We fake a commit for the cover letter so we get the filename
 630                 * desired.
 631                 */
 632                commit = xcalloc(1, sizeof(*commit));
 633                commit->buffer = xmalloc(400);
 634                snprintf(commit->buffer, 400,
 635                        "tree 0000000000000000000000000000000000000000\n"
 636                        "parent %s\n"
 637                        "author %s\n"
 638                        "committer %s\n\n"
 639                        "cover letter\n",
 640                        sha1_to_hex(head->object.sha1), committer, committer);
 641        }
 642
 643        if (!use_stdout && reopen_stdout(commit, rev))
 644                return;
 645
 646        if (commit) {
 647
 648                free(commit->buffer);
 649                free(commit);
 650        }
 651
 652        log_write_email_headers(rev, head, &subject_start, &extra_headers,
 653                                &need_8bit_cte);
 654
 655        msg = body;
 656        pp_user_info(NULL, CMIT_FMT_EMAIL, &sb, committer, DATE_RFC2822,
 657                     encoding);
 658        pp_title_line(CMIT_FMT_EMAIL, &msg, &sb, subject_start, extra_headers,
 659                      encoding, need_8bit_cte);
 660        pp_remainder(CMIT_FMT_EMAIL, &msg, &sb, 0);
 661        printf("%s\n", sb.buf);
 662
 663        strbuf_release(&sb);
 664
 665        shortlog_init(&log);
 666        log.wrap_lines = 1;
 667        log.wrap = 72;
 668        log.in1 = 2;
 669        log.in2 = 4;
 670        for (i = 0; i < nr; i++)
 671                shortlog_add_commit(&log, list[i]);
 672
 673        shortlog_output(&log);
 674
 675        /*
 676         * We can only do diffstat with a unique reference point
 677         */
 678        if (!origin)
 679                return;
 680
 681        memcpy(&opts, &rev->diffopt, sizeof(opts));
 682        opts.output_format = DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
 683
 684        diff_setup_done(&opts);
 685
 686        diff_tree_sha1(origin->tree->object.sha1,
 687                       head->tree->object.sha1,
 688                       "", &opts);
 689        diffcore_std(&opts);
 690        diff_flush(&opts);
 691
 692        printf("\n");
 693}
 694
 695static const char *clean_message_id(const char *msg_id)
 696{
 697        char ch;
 698        const char *a, *z, *m;
 699
 700        m = msg_id;
 701        while ((ch = *m) && (isspace(ch) || (ch == '<')))
 702                m++;
 703        a = m;
 704        z = NULL;
 705        while ((ch = *m)) {
 706                if (!isspace(ch) && (ch != '>'))
 707                        z = m;
 708                m++;
 709        }
 710        if (!z)
 711                die("insane in-reply-to: %s", msg_id);
 712        if (++z == m)
 713                return a;
 714        return xmemdupz(a, z - a);
 715}
 716
 717static const char *set_outdir(const char *prefix, const char *output_directory)
 718{
 719        if (output_directory && is_absolute_path(output_directory))
 720                return output_directory;
 721
 722        if (!prefix || !*prefix) {
 723                if (output_directory)
 724                        return output_directory;
 725                /* The user did not explicitly ask for "./" */
 726                outdir_offset = 2;
 727                return "./";
 728        }
 729
 730        outdir_offset = strlen(prefix);
 731        if (!output_directory)
 732                return prefix;
 733
 734        return xstrdup(prefix_filename(prefix, outdir_offset,
 735                                       output_directory));
 736}
 737
 738int cmd_format_patch(int argc, const char **argv, const char *prefix)
 739{
 740        struct commit *commit;
 741        struct commit **list = NULL;
 742        struct rev_info rev;
 743        int nr = 0, total, i, j;
 744        int use_stdout = 0;
 745        int start_number = -1;
 746        int keep_subject = 0;
 747        int numbered_files = 0;         /* _just_ numbers */
 748        int subject_prefix = 0;
 749        int ignore_if_in_upstream = 0;
 750        int cover_letter = 0;
 751        int boundary_count = 0;
 752        int no_binary_diff = 0;
 753        struct commit *origin = NULL, *head = NULL;
 754        const char *in_reply_to = NULL;
 755        struct patch_ids ids;
 756        char *add_signoff = NULL;
 757        struct strbuf buf = STRBUF_INIT;
 758
 759        git_config(git_format_config, NULL);
 760        init_revisions(&rev, prefix);
 761        rev.commit_format = CMIT_FMT_EMAIL;
 762        rev.verbose_header = 1;
 763        rev.diff = 1;
 764        rev.combine_merges = 0;
 765        rev.ignore_merges = 1;
 766        DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
 767
 768        rev.subject_prefix = fmt_patch_subject_prefix;
 769
 770        if (default_attach) {
 771                rev.mime_boundary = default_attach;
 772                rev.no_inline = 1;
 773        }
 774
 775        /*
 776         * Parse the arguments before setup_revisions(), or something
 777         * like "git format-patch -o a123 HEAD^.." may fail; a123 is
 778         * possibly a valid SHA1.
 779         */
 780        for (i = 1, j = 1; i < argc; i++) {
 781                if (!strcmp(argv[i], "--stdout"))
 782                        use_stdout = 1;
 783                else if (!strcmp(argv[i], "-n") ||
 784                                !strcmp(argv[i], "--numbered"))
 785                        numbered = 1;
 786                else if (!strcmp(argv[i], "-N") ||
 787                                !strcmp(argv[i], "--no-numbered")) {
 788                        numbered = 0;
 789                        auto_number = 0;
 790                }
 791                else if (!prefixcmp(argv[i], "--start-number="))
 792                        start_number = strtol(argv[i] + 15, NULL, 10);
 793                else if (!strcmp(argv[i], "--numbered-files"))
 794                        numbered_files = 1;
 795                else if (!strcmp(argv[i], "--start-number")) {
 796                        i++;
 797                        if (i == argc)
 798                                die("Need a number for --start-number");
 799                        start_number = strtol(argv[i], NULL, 10);
 800                }
 801                else if (!prefixcmp(argv[i], "--cc=")) {
 802                        ALLOC_GROW(extra_cc, extra_cc_nr + 1, extra_cc_alloc);
 803                        extra_cc[extra_cc_nr++] = xstrdup(argv[i] + 5);
 804                }
 805                else if (!strcmp(argv[i], "-k") ||
 806                                !strcmp(argv[i], "--keep-subject")) {
 807                        keep_subject = 1;
 808                        rev.total = -1;
 809                }
 810                else if (!strcmp(argv[i], "--output-directory") ||
 811                         !strcmp(argv[i], "-o")) {
 812                        i++;
 813                        if (argc <= i)
 814                                die("Which directory?");
 815                        if (output_directory)
 816                                die("Two output directories?");
 817                        output_directory = argv[i];
 818                }
 819                else if (!strcmp(argv[i], "--signoff") ||
 820                         !strcmp(argv[i], "-s")) {
 821                        const char *committer;
 822                        const char *endpos;
 823                        committer = git_committer_info(IDENT_ERROR_ON_NO_NAME);
 824                        endpos = strchr(committer, '>');
 825                        if (!endpos)
 826                                die("bogus committer info %s", committer);
 827                        add_signoff = xmemdupz(committer, endpos - committer + 1);
 828                }
 829                else if (!strcmp(argv[i], "--attach")) {
 830                        rev.mime_boundary = git_version_string;
 831                        rev.no_inline = 1;
 832                }
 833                else if (!prefixcmp(argv[i], "--attach=")) {
 834                        rev.mime_boundary = argv[i] + 9;
 835                        rev.no_inline = 1;
 836                }
 837                else if (!strcmp(argv[i], "--no-attach")) {
 838                        rev.mime_boundary = NULL;
 839                        rev.no_inline = 0;
 840                }
 841                else if (!strcmp(argv[i], "--inline")) {
 842                        rev.mime_boundary = git_version_string;
 843                        rev.no_inline = 0;
 844                }
 845                else if (!prefixcmp(argv[i], "--inline=")) {
 846                        rev.mime_boundary = argv[i] + 9;
 847                        rev.no_inline = 0;
 848                }
 849                else if (!strcmp(argv[i], "--ignore-if-in-upstream"))
 850                        ignore_if_in_upstream = 1;
 851                else if (!strcmp(argv[i], "--thread")
 852                        || !strcmp(argv[i], "--thread=shallow"))
 853                        thread = THREAD_SHALLOW;
 854                else if (!strcmp(argv[i], "--thread=deep"))
 855                        thread = THREAD_DEEP;
 856                else if (!strcmp(argv[i], "--no-thread"))
 857                        thread = 0;
 858                else if (!prefixcmp(argv[i], "--in-reply-to="))
 859                        in_reply_to = argv[i] + 14;
 860                else if (!strcmp(argv[i], "--in-reply-to")) {
 861                        i++;
 862                        if (i == argc)
 863                                die("Need a Message-Id for --in-reply-to");
 864                        in_reply_to = argv[i];
 865                } else if (!prefixcmp(argv[i], "--subject-prefix=")) {
 866                        subject_prefix = 1;
 867                        rev.subject_prefix = argv[i] + 17;
 868                } else if (!prefixcmp(argv[i], "--suffix="))
 869                        fmt_patch_suffix = argv[i] + 9;
 870                else if (!strcmp(argv[i], "--cover-letter"))
 871                        cover_letter = 1;
 872                else if (!strcmp(argv[i], "--no-binary"))
 873                        no_binary_diff = 1;
 874                else
 875                        argv[j++] = argv[i];
 876        }
 877        argc = j;
 878
 879        for (i = 0; i < extra_hdr_nr; i++) {
 880                strbuf_addstr(&buf, extra_hdr[i]);
 881                strbuf_addch(&buf, '\n');
 882        }
 883
 884        if (extra_to_nr)
 885                strbuf_addstr(&buf, "To: ");
 886        for (i = 0; i < extra_to_nr; i++) {
 887                if (i)
 888                        strbuf_addstr(&buf, "    ");
 889                strbuf_addstr(&buf, extra_to[i]);
 890                if (i + 1 < extra_to_nr)
 891                        strbuf_addch(&buf, ',');
 892                strbuf_addch(&buf, '\n');
 893        }
 894
 895        if (extra_cc_nr)
 896                strbuf_addstr(&buf, "Cc: ");
 897        for (i = 0; i < extra_cc_nr; i++) {
 898                if (i)
 899                        strbuf_addstr(&buf, "    ");
 900                strbuf_addstr(&buf, extra_cc[i]);
 901                if (i + 1 < extra_cc_nr)
 902                        strbuf_addch(&buf, ',');
 903                strbuf_addch(&buf, '\n');
 904        }
 905
 906        rev.extra_headers = strbuf_detach(&buf, 0);
 907
 908        if (start_number < 0)
 909                start_number = 1;
 910        if (numbered && keep_subject)
 911                die ("-n and -k are mutually exclusive.");
 912        if (keep_subject && subject_prefix)
 913                die ("--subject-prefix and -k are mutually exclusive.");
 914
 915        argc = setup_revisions(argc, argv, &rev, "HEAD");
 916        if (argc > 1)
 917                die ("unrecognized argument: %s", argv[1]);
 918
 919        if (!rev.diffopt.output_format
 920                || rev.diffopt.output_format == DIFF_FORMAT_PATCH)
 921                rev.diffopt.output_format = DIFF_FORMAT_DIFFSTAT | DIFF_FORMAT_SUMMARY | DIFF_FORMAT_PATCH;
 922
 923        if (!DIFF_OPT_TST(&rev.diffopt, TEXT) && !no_binary_diff)
 924                DIFF_OPT_SET(&rev.diffopt, BINARY);
 925
 926        if (!use_stdout)
 927                output_directory = set_outdir(prefix, output_directory);
 928
 929        if (output_directory) {
 930                if (use_stdout)
 931                        die("standard output, or directory, which one?");
 932                if (mkdir(output_directory, 0777) < 0 && errno != EEXIST)
 933                        die("Could not create directory %s",
 934                            output_directory);
 935        }
 936
 937        if (rev.pending.nr == 1) {
 938                if (rev.max_count < 0 && !rev.show_root_diff) {
 939                        /*
 940                         * This is traditional behaviour of "git format-patch
 941                         * origin" that prepares what the origin side still
 942                         * does not have.
 943                         */
 944                        rev.pending.objects[0].item->flags |= UNINTERESTING;
 945                        add_head_to_pending(&rev);
 946                }
 947                /*
 948                 * Otherwise, it is "format-patch -22 HEAD", and/or
 949                 * "format-patch --root HEAD".  The user wants
 950                 * get_revision() to do the usual traversal.
 951                 */
 952        }
 953
 954        /*
 955         * We cannot move this anywhere earlier because we do want to
 956         * know if --root was given explicitly from the comand line.
 957         */
 958        rev.show_root_diff = 1;
 959
 960        if (cover_letter) {
 961                /* remember the range */
 962                int i;
 963                for (i = 0; i < rev.pending.nr; i++) {
 964                        struct object *o = rev.pending.objects[i].item;
 965                        if (!(o->flags & UNINTERESTING))
 966                                head = (struct commit *)o;
 967                }
 968                /* We can't generate a cover letter without any patches */
 969                if (!head)
 970                        return 0;
 971        }
 972
 973        if (ignore_if_in_upstream)
 974                get_patch_ids(&rev, &ids, prefix);
 975
 976        if (!use_stdout)
 977                realstdout = xfdopen(xdup(1), "w");
 978
 979        if (prepare_revision_walk(&rev))
 980                die("revision walk setup failed");
 981        rev.boundary = 1;
 982        while ((commit = get_revision(&rev)) != NULL) {
 983                if (commit->object.flags & BOUNDARY) {
 984                        boundary_count++;
 985                        origin = (boundary_count == 1) ? commit : NULL;
 986                        continue;
 987                }
 988
 989                /* ignore merges */
 990                if (commit->parents && commit->parents->next)
 991                        continue;
 992
 993                if (ignore_if_in_upstream &&
 994                                has_commit_patch_id(commit, &ids))
 995                        continue;
 996
 997                nr++;
 998                list = xrealloc(list, nr * sizeof(list[0]));
 999                list[nr - 1] = commit;
1000        }
1001        total = nr;
1002        if (!keep_subject && auto_number && total > 1)
1003                numbered = 1;
1004        if (numbered)
1005                rev.total = total + start_number - 1;
1006        if (in_reply_to || thread || cover_letter)
1007                rev.ref_message_ids = xcalloc(1, sizeof(struct string_list));
1008        if (in_reply_to) {
1009                const char *msgid = clean_message_id(in_reply_to);
1010                string_list_append(msgid, rev.ref_message_ids);
1011        }
1012        rev.numbered_files = numbered_files;
1013        rev.patch_suffix = fmt_patch_suffix;
1014        if (cover_letter) {
1015                if (thread)
1016                        gen_message_id(&rev, "cover");
1017                make_cover_letter(&rev, use_stdout, numbered, numbered_files,
1018                                  origin, nr, list, head);
1019                total++;
1020                start_number--;
1021        }
1022        rev.add_signoff = add_signoff;
1023        while (0 <= --nr) {
1024                int shown;
1025                commit = list[nr];
1026                rev.nr = total - nr + (start_number - 1);
1027                /* Make the second and subsequent mails replies to the first */
1028                if (thread) {
1029                        /* Have we already had a message ID? */
1030                        if (rev.message_id) {
1031                                /*
1032                                 * For deep threading: make every mail
1033                                 * a reply to the previous one, no
1034                                 * matter what other options are set.
1035                                 *
1036                                 * For shallow threading:
1037                                 *
1038                                 * Without --cover-letter and
1039                                 * --in-reply-to, make every mail a
1040                                 * reply to the one before.
1041                                 *
1042                                 * With --in-reply-to but no
1043                                 * --cover-letter, make every mail a
1044                                 * reply to the <reply-to>.
1045                                 *
1046                                 * With --cover-letter, make every
1047                                 * mail but the cover letter a reply
1048                                 * to the cover letter.  The cover
1049                                 * letter is a reply to the
1050                                 * --in-reply-to, if specified.
1051                                 */
1052                                if (thread == THREAD_SHALLOW
1053                                    && rev.ref_message_ids->nr > 0
1054                                    && (!cover_letter || rev.nr > 1))
1055                                        free(rev.message_id);
1056                                else
1057                                        string_list_append(rev.message_id,
1058                                                           rev.ref_message_ids);
1059                        }
1060                        gen_message_id(&rev, sha1_to_hex(commit->object.sha1));
1061                }
1062
1063                if (!use_stdout && reopen_stdout(numbered_files ? NULL : commit,
1064                                                 &rev))
1065                        die("Failed to create output files");
1066                shown = log_tree_commit(&rev, commit);
1067                free(commit->buffer);
1068                commit->buffer = NULL;
1069
1070                /* We put one extra blank line between formatted
1071                 * patches and this flag is used by log-tree code
1072                 * to see if it needs to emit a LF before showing
1073                 * the log; when using one file per patch, we do
1074                 * not want the extra blank line.
1075                 */
1076                if (!use_stdout)
1077                        rev.shown_one = 0;
1078                if (shown) {
1079                        if (rev.mime_boundary)
1080                                printf("\n--%s%s--\n\n\n",
1081                                       mime_boundary_leader,
1082                                       rev.mime_boundary);
1083                        else
1084                                printf("-- \n%s\n\n", git_version_string);
1085                }
1086                if (!use_stdout)
1087                        fclose(stdout);
1088        }
1089        free(list);
1090        if (ignore_if_in_upstream)
1091                free_patch_ids(&ids);
1092        return 0;
1093}
1094
1095static int add_pending_commit(const char *arg, struct rev_info *revs, int flags)
1096{
1097        unsigned char sha1[20];
1098        if (get_sha1(arg, sha1) == 0) {
1099                struct commit *commit = lookup_commit_reference(sha1);
1100                if (commit) {
1101                        commit->object.flags |= flags;
1102                        add_pending_object(revs, &commit->object, arg);
1103                        return 0;
1104                }
1105        }
1106        return -1;
1107}
1108
1109static const char cherry_usage[] =
1110"git cherry [-v] [<upstream> [<head> [<limit>]]]";
1111int cmd_cherry(int argc, const char **argv, const char *prefix)
1112{
1113        struct rev_info revs;
1114        struct patch_ids ids;
1115        struct commit *commit;
1116        struct commit_list *list = NULL;
1117        struct branch *current_branch;
1118        const char *upstream;
1119        const char *head = "HEAD";
1120        const char *limit = NULL;
1121        int verbose = 0;
1122
1123        if (argc > 1 && !strcmp(argv[1], "-v")) {
1124                verbose = 1;
1125                argc--;
1126                argv++;
1127        }
1128
1129        switch (argc) {
1130        case 4:
1131                limit = argv[3];
1132                /* FALLTHROUGH */
1133        case 3:
1134                head = argv[2];
1135                /* FALLTHROUGH */
1136        case 2:
1137                upstream = argv[1];
1138                break;
1139        default:
1140                current_branch = branch_get(NULL);
1141                if (!current_branch || !current_branch->merge
1142                                        || !current_branch->merge[0]
1143                                        || !current_branch->merge[0]->dst) {
1144                        fprintf(stderr, "Could not find a tracked"
1145                                        " remote branch, please"
1146                                        " specify <upstream> manually.\n");
1147                        usage(cherry_usage);
1148                }
1149
1150                upstream = current_branch->merge[0]->dst;
1151        }
1152
1153        init_revisions(&revs, prefix);
1154        revs.diff = 1;
1155        revs.combine_merges = 0;
1156        revs.ignore_merges = 1;
1157        DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
1158
1159        if (add_pending_commit(head, &revs, 0))
1160                die("Unknown commit %s", head);
1161        if (add_pending_commit(upstream, &revs, UNINTERESTING))
1162                die("Unknown commit %s", upstream);
1163
1164        /* Don't say anything if head and upstream are the same. */
1165        if (revs.pending.nr == 2) {
1166                struct object_array_entry *o = revs.pending.objects;
1167                if (hashcmp(o[0].item->sha1, o[1].item->sha1) == 0)
1168                        return 0;
1169        }
1170
1171        get_patch_ids(&revs, &ids, prefix);
1172
1173        if (limit && add_pending_commit(limit, &revs, UNINTERESTING))
1174                die("Unknown commit %s", limit);
1175
1176        /* reverse the list of commits */
1177        if (prepare_revision_walk(&revs))
1178                die("revision walk setup failed");
1179        while ((commit = get_revision(&revs)) != NULL) {
1180                /* ignore merges */
1181                if (commit->parents && commit->parents->next)
1182                        continue;
1183
1184                commit_list_insert(commit, &list);
1185        }
1186
1187        while (list) {
1188                char sign = '+';
1189
1190                commit = list->item;
1191                if (has_commit_patch_id(commit, &ids))
1192                        sign = '-';
1193
1194                if (verbose) {
1195                        struct strbuf buf = STRBUF_INIT;
1196                        pretty_print_commit(CMIT_FMT_ONELINE, commit,
1197                                            &buf, 0, NULL, NULL, 0, 0);
1198                        printf("%c %s %s\n", sign,
1199                               sha1_to_hex(commit->object.sha1), buf.buf);
1200                        strbuf_release(&buf);
1201                }
1202                else {
1203                        printf("%c %s\n", sign,
1204                               sha1_to_hex(commit->object.sha1));
1205                }
1206
1207                list = list->next;
1208        }
1209
1210        free_patch_ids(&ids);
1211        return 0;
1212}