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