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