builtin-log.c

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