builtin/revert.c

   1 #include "cache.h"
   2 #include "builtin.h"
   3 #include "object.h"
   4 #include "commit.h"
   5 #include "tag.h"
   6 #include "wt-status.h"
   7 #include "run-command.h"
   8 #include "exec_cmd.h"
   9 #include "utf8.h"
  10 #include "parse-options.h"
  11 #include "cache-tree.h"
  12 #include "diff.h"
  13 #include "revision.h"
  14 #include "rerere.h"
  15 #include "merge-recursive.h"
  16 #include "refs.h"
  17
  18 /*
  19  * This implements the builtins revert and cherry-pick.
  20  *
  21  * Copyright (c) 2007 Johannes E. Schindelin
  22  *
  23  * Based on git-revert.sh, which is
  24  *
  25  * Copyright (c) 2005 Linus Torvalds
  26  * Copyright (c) 2005 Junio C Hamano
  27  */
  28
  29 static const char * const revert_usage[] = {
  30         "git revert [options] <commit-ish>",
  31         NULL
  32 };
  33
  34 static const char * const cherry_pick_usage[] = {
  35         "git cherry-pick [options] <commit-ish>",
  36         NULL
  37 };
  38
  39 static int edit, no_replay, no_commit, mainline, signoff, allow_ff;
  40 static enum { REVERT, CHERRY_PICK } action;
  41 static struct commit *commit;
  42 static int commit_argc;
  43 static const char **commit_argv;
  44 static int allow_rerere_auto;
  45
  46 static const char *me;
  47 static const char *strategy;
  48
  49 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
  50
  51 static char *get_encoding(const char *message);
  52
  53 static void parse_args(int argc, const char **argv)
  54 {
  55         const char * const * usage_str =
  56                 action == REVERT ?  revert_usage : cherry_pick_usage;
  57         int noop;
  58         struct option options[] = {
  59                 OPT_BOOLEAN('n', "no-commit", &no_commit, "don't automatically commit"),
  60                 OPT_BOOLEAN('e', "edit", &edit, "edit the commit message"),
  61                 OPT_BOOLEAN('r', NULL, &noop, "no-op (backward compatibility)"),
  62                 OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
  63                 OPT_INTEGER('m', "mainline", &mainline, "parent number"),
  64                 OPT_RERERE_AUTOUPDATE(&allow_rerere_auto),
  65                 OPT_STRING(0, "strategy", &strategy, "strategy", "merge strategy"),
  66                 OPT_END(),
  67                 OPT_END(),
  68                 OPT_END(),
  69         };
  70
  71         if (action == CHERRY_PICK) {
  72                 struct option cp_extra[] = {
  73                         OPT_BOOLEAN('x', NULL, &no_replay, "append commit name"),
  74                         OPT_BOOLEAN(0, "ff", &allow_ff, "allow fast-forward"),
  75                         OPT_END(),
  76                 };
  77                 if (parse_options_concat(options, ARRAY_SIZE(options), cp_extra))
  78                         die("program error");
  79         }
  80
  81         commit_argc = parse_options(argc, argv, NULL, options, usage_str, 0);
  82         if (commit_argc < 1)
  83                 usage_with_options(usage_str, options);
  84
  85         commit_argv = argv;
  86 }
  87
  88 struct commit_message {
  89         char *parent_label;
  90         const char *label;
  91         const char *subject;
  92         char *reencoded_message;
  93         const char *message;
  94 };
  95
  96 static int get_message(const char *raw_message, struct commit_message *out)
  97 {
  98         const char *encoding;
  99         const char *p, *abbrev, *eol;
 100         char *q;
 101         int abbrev_len, oneline_len;
 102
 103         if (!raw_message)
 104                 return -1;
 105         encoding = get_encoding(raw_message);
 106         if (!encoding)
 107                 encoding = "UTF-8";
 108         if (!git_commit_encoding)
 109                 git_commit_encoding = "UTF-8";
 110
 111         out->reencoded_message = NULL;
 112         out->message = raw_message;
 113         if (strcmp(encoding, git_commit_encoding))
 114                 out->reencoded_message = reencode_string(raw_message,
 115                                         git_commit_encoding, encoding);
 116         if (out->reencoded_message)
 117                 out->message = out->reencoded_message;
 118
 119         abbrev = find_unique_abbrev(commit->object.sha1, DEFAULT_ABBREV);
 120         abbrev_len = strlen(abbrev);
 121
 122         /* Find beginning and end of commit subject. */
 123         p = out->message;
 124         while (*p && (*p != '\n' || p[1] != '\n'))
 125                 p++;
 126         if (*p) {
 127                 p += 2;
 128                 for (eol = p + 1; *eol && *eol != '\n'; eol++)
 129                         ; /* do nothing */
 130         } else
 131                 eol = p;
 132         oneline_len = eol - p;
 133
 134         out->parent_label = xmalloc(strlen("parent of ") + abbrev_len +
 135                               strlen("... ") + oneline_len + 1);
 136         q = out->parent_label;
 137         q = mempcpy(q, "parent of ", strlen("parent of "));
 138         out->label = q;
 139         q = mempcpy(q, abbrev, abbrev_len);
 140         q = mempcpy(q, "... ", strlen("... "));
 141         out->subject = q;
 142         q = mempcpy(q, p, oneline_len);
 143         *q = '\0';
 144         return 0;
 145 }
 146
 147 static void free_message(struct commit_message *msg)
 148 {
 149         free(msg->parent_label);
 150         free(msg->reencoded_message);
 151 }
 152
 153 static char *get_encoding(const char *message)
 154 {
 155         const char *p = message, *eol;
 156
 157         if (!p)
 158                 die ("Could not read commit message of %s",
 159                                 sha1_to_hex(commit->object.sha1));
 160         while (*p && *p != '\n') {
 161                 for (eol = p + 1; *eol && *eol != '\n'; eol++)
 162                         ; /* do nothing */
 163                 if (!prefixcmp(p, "encoding ")) {
 164                         char *result = xmalloc(eol - 8 - p);
 165                         strlcpy(result, p + 9, eol - 8 - p);
 166                         return result;
 167                 }
 168                 p = eol;
 169                 if (*p == '\n')
 170                         p++;
 171         }
 172         return NULL;
 173 }
 174
 175 static void add_message_to_msg(struct strbuf *msgbuf, const char *message)
 176 {
 177         const char *p = message;
 178         while (*p && (*p != '\n' || p[1] != '\n'))
 179                 p++;
 180
 181         if (!*p)
 182                 strbuf_addstr(msgbuf, sha1_to_hex(commit->object.sha1));
 183
 184         p += 2;
 185         strbuf_addstr(msgbuf, p);
 186 }
 187
 188 static void set_author_ident_env(const char *message)
 189 {
 190         const char *p = message;
 191         if (!p)
 192                 die ("Could not read commit message of %s",
 193                                 sha1_to_hex(commit->object.sha1));
 194         while (*p && *p != '\n') {
 195                 const char *eol;
 196
 197                 for (eol = p; *eol && *eol != '\n'; eol++)
 198                         ; /* do nothing */
 199                 if (!prefixcmp(p, "author ")) {
 200                         char *line, *pend, *email, *timestamp;
 201
 202                         p += 7;
 203                         line = xmemdupz(p, eol - p);
 204                         email = strchr(line, '<');
 205                         if (!email)
 206                                 die ("Could not extract author email from %s",
 207                                         sha1_to_hex(commit->object.sha1));
 208                         if (email == line)
 209                                 pend = line;
 210                         else
 211                                 for (pend = email; pend != line + 1 &&
 212                                                 isspace(pend[-1]); pend--);
 213                                         ; /* do nothing */
 214                         *pend = '\0';
 215                         email++;
 216                         timestamp = strchr(email, '>');
 217                         if (!timestamp)
 218                                 die ("Could not extract author time from %s",
 219                                         sha1_to_hex(commit->object.sha1));
 220                         *timestamp = '\0';
 221                         for (timestamp++; *timestamp && isspace(*timestamp);
 222                                         timestamp++)
 223                                 ; /* do nothing */
 224                         setenv("GIT_AUTHOR_NAME", line, 1);
 225                         setenv("GIT_AUTHOR_EMAIL", email, 1);
 226                         setenv("GIT_AUTHOR_DATE", timestamp, 1);
 227                         free(line);
 228                         return;
 229                 }
 230                 p = eol;
 231                 if (*p == '\n')
 232                         p++;
 233         }
 234         die ("No author information found in %s",
 235                         sha1_to_hex(commit->object.sha1));
 236 }
 237
 238 static char *help_msg(void)
 239 {
 240         struct strbuf helpbuf = STRBUF_INIT;
 241         char *msg = getenv("GIT_CHERRY_PICK_HELP");
 242
 243         if (msg)
 244                 return msg;
 245
 246         strbuf_addstr(&helpbuf, "  After resolving the conflicts,\n"
 247                 "mark the corrected paths with 'git add <paths>' or 'git rm <paths>'\n"
 248                 "and commit the result");
 249
 250         if (action == CHERRY_PICK) {
 251                 strbuf_addf(&helpbuf, " with: \n"
 252                         "\n"
 253                         "        git commit -c %s\n",
 254                             sha1_to_hex(commit->object.sha1));
 255         }
 256         else
 257                 strbuf_addch(&helpbuf, '.');
 258         return strbuf_detach(&helpbuf, NULL);
 259 }
 260
 261 static void write_message(struct strbuf *msgbuf, const char *filename)
 262 {
 263         static struct lock_file msg_file;
 264
 265         int msg_fd = hold_lock_file_for_update(&msg_file, filename,
 266                                                LOCK_DIE_ON_ERROR);
 267         if (write_in_full(msg_fd, msgbuf->buf, msgbuf->len) < 0)
 268                 die_errno("Could not write to %s.", filename);
 269         strbuf_release(msgbuf);
 270         if (commit_lock_file(&msg_file) < 0)
 271                 die("Error wrapping up %s", filename);
 272 }
 273
 274 static struct tree *empty_tree(void)
 275 {
 276         struct tree *tree = xcalloc(1, sizeof(struct tree));
 277
 278         tree->object.parsed = 1;
 279         tree->object.type = OBJ_TREE;
 280         pretend_sha1_file(NULL, 0, OBJ_TREE, tree->object.sha1);
 281         return tree;
 282 }
 283
 284 static NORETURN void die_dirty_index(const char *me)
 285 {
 286         if (read_cache_unmerged()) {
 287                 die_resolve_conflict(me);
 288         } else {
 289                 if (advice_commit_before_merge)
 290                         die("Your local changes would be overwritten by %s.\n"
 291                             "Please, commit your changes or stash them to proceed.", me);
 292                 else
 293                         die("Your local changes would be overwritten by %s.\n", me);
 294         }
 295 }
 296
 297 static int fast_forward_to(const unsigned char *to, const unsigned char *from)
 298 {
 299         struct ref_lock *ref_lock;
 300
 301         read_cache();
 302         if (checkout_fast_forward(from, to))
 303                 exit(1); /* the callee should have complained already */
 304         ref_lock = lock_any_ref_for_update("HEAD", from, 0);
 305         return write_ref_sha1(ref_lock, to, "cherry-pick");
 306 }
 307
 308 static void do_recursive_merge(struct commit *base, struct commit *next,
 309                                const char *base_label, const char *next_label,
 310                                unsigned char *head, struct strbuf *msgbuf,
 311                                char *defmsg)
 312 {
 313         struct merge_options o;
 314         struct tree *result, *next_tree, *base_tree, *head_tree;
 315         int clean, index_fd;
 316         static struct lock_file index_lock;
 317
 318         index_fd = hold_locked_index(&index_lock, 1);
 319
 320         read_cache();
 321
 322         /*
 323          * NEEDSWORK: cherry-picking between branches with
 324          * different end-of-line normalization is a pain;
 325          * plumb in an option to set o.renormalize?
 326          * (or better: arbitrary -X options)
 327          */
 328         init_merge_options(&o);
 329         o.ancestor = base ? base_label : "(empty tree)";
 330         o.branch1 = "HEAD";
 331         o.branch2 = next ? next_label : "(empty tree)";
 332
 333         head_tree = parse_tree_indirect(head);
 334         next_tree = next ? next->tree : empty_tree();
 335         base_tree = base ? base->tree : empty_tree();
 336
 337         clean = merge_trees(&o,
 338                             head_tree,
 339                             next_tree, base_tree, &result);
 340
 341         if (active_cache_changed &&
 342             (write_cache(index_fd, active_cache, active_nr) ||
 343              commit_locked_index(&index_lock)))
 344                 die("%s: Unable to write new index file", me);
 345         rollback_lock_file(&index_lock);
 346
 347         if (!clean) {
 348                 int i;
 349                 strbuf_addstr(msgbuf, "\nConflicts:\n\n");
 350                 for (i = 0; i < active_nr;) {
 351                         struct cache_entry *ce = active_cache[i++];
 352                         if (ce_stage(ce)) {
 353                                 strbuf_addch(msgbuf, '\t');
 354                                 strbuf_addstr(msgbuf, ce->name);
 355                                 strbuf_addch(msgbuf, '\n');
 356                                 while (i < active_nr && !strcmp(ce->name,
 357                                                 active_cache[i]->name))
 358                                         i++;
 359                         }
 360                 }
 361                 write_message(msgbuf, defmsg);
 362                 fprintf(stderr, "Automatic %s failed.%s\n",
 363                         me, help_msg());
 364                 rerere(allow_rerere_auto);
 365                 exit(1);
 366         }
 367         write_message(msgbuf, defmsg);
 368         fprintf(stderr, "Finished one %s.\n", me);
 369 }
 370
 371 static int do_pick_commit(void)
 372 {
 373         unsigned char head[20];
 374         struct commit *base, *next, *parent;
 375         const char *base_label, *next_label;
 376         struct commit_message msg = { NULL, NULL, NULL, NULL, NULL };
 377         char *defmsg = NULL;
 378         struct strbuf msgbuf = STRBUF_INIT;
 379
 380         if (no_commit) {
 381                 /*
 382                  * We do not intend to commit immediately.  We just want to
 383                  * merge the differences in, so let's compute the tree
 384                  * that represents the "current" state for merge-recursive
 385                  * to work on.
 386                  */
 387                 if (write_cache_as_tree(head, 0, NULL))
 388                         die ("Your index file is unmerged.");
 389         } else {
 390                 if (get_sha1("HEAD", head))
 391                         die ("You do not have a valid HEAD");
 392                 if (index_differs_from("HEAD", 0))
 393                         die_dirty_index(me);
 394         }
 395         discard_cache();
 396
 397         if (!commit->parents) {
 398                 if (action == REVERT)
 399                         die ("Cannot revert a root commit");
 400                 parent = NULL;
 401         }
 402         else if (commit->parents->next) {
 403                 /* Reverting or cherry-picking a merge commit */
 404                 int cnt;
 405                 struct commit_list *p;
 406
 407                 if (!mainline)
 408                         die("Commit %s is a merge but no -m option was given.",
 409                             sha1_to_hex(commit->object.sha1));
 410
 411                 for (cnt = 1, p = commit->parents;
 412                      cnt != mainline && p;
 413                      cnt++)
 414                         p = p->next;
 415                 if (cnt != mainline || !p)
 416                         die("Commit %s does not have parent %d",
 417                             sha1_to_hex(commit->object.sha1), mainline);
 418                 parent = p->item;
 419         } else if (0 < mainline)
 420                 die("Mainline was specified but commit %s is not a merge.",
 421                     sha1_to_hex(commit->object.sha1));
 422         else
 423                 parent = commit->parents->item;
 424
 425         if (allow_ff && !hashcmp(parent->object.sha1, head))
 426                 return fast_forward_to(commit->object.sha1, head);
 427
 428         if (parent && parse_commit(parent) < 0)
 429                 die("%s: cannot parse parent commit %s",
 430                     me, sha1_to_hex(parent->object.sha1));
 431
 432         if (get_message(commit->buffer, &msg) != 0)
 433                 die("Cannot get commit message for %s",
 434                                 sha1_to_hex(commit->object.sha1));
 435
 436         /*
 437          * "commit" is an existing commit.  We would want to apply
 438          * the difference it introduces since its first parent "prev"
 439          * on top of the current HEAD if we are cherry-pick.  Or the
 440          * reverse of it if we are revert.
 441          */
 442
 443         defmsg = git_pathdup("MERGE_MSG");
 444
 445         if (action == REVERT) {
 446                 base = commit;
 447                 base_label = msg.label;
 448                 next = parent;
 449                 next_label = msg.parent_label;
 450                 strbuf_addstr(&msgbuf, "Revert \"");
 451                 strbuf_addstr(&msgbuf, msg.subject);
 452                 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
 453                 strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
 454
 455                 if (commit->parents->next) {
 456                         strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
 457                         strbuf_addstr(&msgbuf, sha1_to_hex(parent->object.sha1));
 458                 }
 459                 strbuf_addstr(&msgbuf, ".\n");
 460         } else {
 461                 base = parent;
 462                 base_label = msg.parent_label;
 463                 next = commit;
 464                 next_label = msg.label;
 465                 set_author_ident_env(msg.message);
 466                 add_message_to_msg(&msgbuf, msg.message);
 467                 if (no_replay) {
 468                         strbuf_addstr(&msgbuf, "(cherry picked from commit ");
 469                         strbuf_addstr(&msgbuf, sha1_to_hex(commit->object.sha1));
 470                         strbuf_addstr(&msgbuf, ")\n");
 471                 }
 472         }
 473
 474         if (!strategy || !strcmp(strategy, "recursive") || action == REVERT)
 475                 do_recursive_merge(base, next, base_label, next_label,
 476                                    head, &msgbuf, defmsg);
 477         else {
 478                 int res;
 479                 struct commit_list *common = NULL;
 480                 struct commit_list *remotes = NULL;
 481                 write_message(&msgbuf, defmsg);
 482                 commit_list_insert(base, &common);
 483                 commit_list_insert(next, &remotes);
 484                 res = try_merge_command(strategy, common,
 485                                         sha1_to_hex(head), remotes);
 486                 free_commit_list(common);
 487                 free_commit_list(remotes);
 488                 if (res) {
 489                         fprintf(stderr, "Automatic %s with strategy %s failed.%s\n",
 490                                 me, strategy, help_msg());
 491                         rerere(allow_rerere_auto);
 492                         exit(1);
 493                 }
 494         }
 495
 496         free_message(&msg);
 497
 498         /*
 499          *
 500          * If we are cherry-pick, and if the merge did not result in
 501          * hand-editing, we will hit this commit and inherit the original
 502          * author date and name.
 503          * If we are revert, or if our cherry-pick results in a hand merge,
 504          * we had better say that the current user is responsible for that.
 505          */
 506
 507         if (!no_commit) {
 508                 /* 6 is max possible length of our args array including NULL */
 509                 const char *args[6];
 510                 int res;
 511                 int i = 0;
 512
 513                 args[i++] = "commit";
 514                 args[i++] = "-n";
 515                 if (signoff)
 516                         args[i++] = "-s";
 517                 if (!edit) {
 518                         args[i++] = "-F";
 519                         args[i++] = defmsg;
 520                 }
 521                 args[i] = NULL;
 522                 res = run_command_v_opt(args, RUN_GIT_CMD);
 523                 free(defmsg);
 524
 525                 return res;
 526         }
 527
 528         free(defmsg);
 529
 530         return 0;
 531 }
 532
 533 static void prepare_revs(struct rev_info *revs)
 534 {
 535         int argc = 0;
 536         int i;
 537         const char **argv = xmalloc((commit_argc + 4) * sizeof(*argv));
 538
 539         argv[argc++] = NULL;
 540         argv[argc++] = "--no-walk";
 541         if (action != REVERT)
 542                 argv[argc++] = "--reverse";
 543         for (i = 0; i < commit_argc; i++)
 544                 argv[argc++] = commit_argv[i];
 545         argv[argc++] = NULL;
 546
 547         init_revisions(revs, NULL);
 548         setup_revisions(argc - 1, argv, revs, NULL);
 549         if (prepare_revision_walk(revs))
 550                 die("revision walk setup failed");
 551
 552         if (!revs->commits)
 553                 die("empty commit set passed");
 554
 555         free(argv);
 556 }
 557
 558 static int revert_or_cherry_pick(int argc, const char **argv)
 559 {
 560         struct rev_info revs;
 561
 562         git_config(git_default_config, NULL);
 563         me = action == REVERT ? "revert" : "cherry-pick";
 564         setenv(GIT_REFLOG_ACTION, me, 0);
 565         parse_args(argc, argv);
 566
 567         if (allow_ff) {
 568                 if (signoff)
 569                         die("cherry-pick --ff cannot be used with --signoff");
 570                 if (no_commit)
 571                         die("cherry-pick --ff cannot be used with --no-commit");
 572                 if (no_replay)
 573                         die("cherry-pick --ff cannot be used with -x");
 574                 if (edit)
 575                         die("cherry-pick --ff cannot be used with --edit");
 576         }
 577
 578         if (read_cache() < 0)
 579                 die("git %s: failed to read the index", me);
 580
 581         prepare_revs(&revs);
 582
 583         while ((commit = get_revision(&revs))) {
 584                 int res = do_pick_commit();
 585                 if (res)
 586                         return res;
 587         }
 588
 589         return 0;
 590 }
 591
 592 int cmd_revert(int argc, const char **argv, const char *prefix)
 593 {
 594         if (isatty(0))
 595                 edit = 1;
 596         action = REVERT;
 597         return revert_or_cherry_pick(argc, argv);
 598 }
 599
 600 int cmd_cherry_pick(int argc, const char **argv, const char *prefix)
 601 {
 602         action = CHERRY_PICK;
 603         return revert_or_cherry_pick(argc, argv);
 604 }