builtin rebase: support --quit
[git] / builtin / rebase.c
1 /*
2  * "git rebase" builtin command
3  *
4  * Copyright (c) 2018 Pratik Karki
5  */
6
7 #include "builtin.h"
8 #include "run-command.h"
9 #include "exec-cmd.h"
10 #include "argv-array.h"
11 #include "dir.h"
12 #include "packfile.h"
13 #include "refs.h"
14 #include "quote.h"
15 #include "config.h"
16 #include "cache-tree.h"
17 #include "unpack-trees.h"
18 #include "lockfile.h"
19 #include "parse-options.h"
20 #include "commit.h"
21 #include "diff.h"
22 #include "wt-status.h"
23 #include "revision.h"
24 #include "rerere.h"
25
26 static char const * const builtin_rebase_usage[] = {
27         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
28                 "[<upstream>] [<branch>]"),
29         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
30                 "--root [<branch>]"),
31         N_("git rebase --continue | --abort | --skip | --edit-todo"),
32         NULL
33 };
34
35 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
36 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
37
38 enum rebase_type {
39         REBASE_UNSPECIFIED = -1,
40         REBASE_AM,
41         REBASE_MERGE,
42         REBASE_INTERACTIVE,
43         REBASE_PRESERVE_MERGES
44 };
45
46 static int use_builtin_rebase(void)
47 {
48         struct child_process cp = CHILD_PROCESS_INIT;
49         struct strbuf out = STRBUF_INIT;
50         int ret;
51
52         argv_array_pushl(&cp.args,
53                          "config", "--bool", "rebase.usebuiltin", NULL);
54         cp.git_cmd = 1;
55         if (capture_command(&cp, &out, 6)) {
56                 strbuf_release(&out);
57                 return 0;
58         }
59
60         strbuf_trim(&out);
61         ret = !strcmp("true", out.buf);
62         strbuf_release(&out);
63         return ret;
64 }
65
66 static int apply_autostash(void)
67 {
68         warning("TODO");
69         return 0;
70 }
71
72 struct rebase_options {
73         enum rebase_type type;
74         const char *state_dir;
75         struct commit *upstream;
76         const char *upstream_name;
77         const char *upstream_arg;
78         char *head_name;
79         struct object_id orig_head;
80         struct commit *onto;
81         const char *onto_name;
82         const char *revisions;
83         const char *switch_to;
84         int root;
85         struct commit *restrict_revision;
86         int dont_finish_rebase;
87         enum {
88                 REBASE_NO_QUIET = 1<<0,
89                 REBASE_VERBOSE = 1<<1,
90                 REBASE_DIFFSTAT = 1<<2,
91                 REBASE_FORCE = 1<<3,
92                 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
93         } flags;
94         struct strbuf git_am_opt;
95         const char *action;
96 };
97
98 static int is_interactive(struct rebase_options *opts)
99 {
100         return opts->type == REBASE_INTERACTIVE ||
101                 opts->type == REBASE_PRESERVE_MERGES;
102 }
103
104 /* Returns the filename prefixed by the state_dir */
105 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
106 {
107         static struct strbuf path = STRBUF_INIT;
108         static size_t prefix_len;
109
110         if (!prefix_len) {
111                 strbuf_addf(&path, "%s/", opts->state_dir);
112                 prefix_len = path.len;
113         }
114
115         strbuf_setlen(&path, prefix_len);
116         strbuf_addstr(&path, filename);
117         return path.buf;
118 }
119
120 /* Read one file, then strip line endings */
121 static int read_one(const char *path, struct strbuf *buf)
122 {
123         if (strbuf_read_file(buf, path, 0) < 0)
124                 return error_errno(_("could not read '%s'"), path);
125         strbuf_trim_trailing_newline(buf);
126         return 0;
127 }
128
129 /* Initialize the rebase options from the state directory. */
130 static int read_basic_state(struct rebase_options *opts)
131 {
132         struct strbuf head_name = STRBUF_INIT;
133         struct strbuf buf = STRBUF_INIT;
134         struct object_id oid;
135
136         if (read_one(state_dir_path("head-name", opts), &head_name) ||
137             read_one(state_dir_path("onto", opts), &buf))
138                 return -1;
139         opts->head_name = starts_with(head_name.buf, "refs/") ?
140                 xstrdup(head_name.buf) : NULL;
141         strbuf_release(&head_name);
142         if (get_oid(buf.buf, &oid))
143                 return error(_("could not get 'onto': '%s'"), buf.buf);
144         opts->onto = lookup_commit_or_die(&oid, buf.buf);
145
146         /*
147          * We always write to orig-head, but interactive rebase used to write to
148          * head. Fall back to reading from head to cover for the case that the
149          * user upgraded git with an ongoing interactive rebase.
150          */
151         strbuf_reset(&buf);
152         if (file_exists(state_dir_path("orig-head", opts))) {
153                 if (read_one(state_dir_path("orig-head", opts), &buf))
154                         return -1;
155         } else if (read_one(state_dir_path("head", opts), &buf))
156                 return -1;
157         if (get_oid(buf.buf, &opts->orig_head))
158                 return error(_("invalid orig-head: '%s'"), buf.buf);
159
160         strbuf_reset(&buf);
161         if (read_one(state_dir_path("quiet", opts), &buf))
162                 return -1;
163         if (buf.len)
164                 opts->flags &= ~REBASE_NO_QUIET;
165         else
166                 opts->flags |= REBASE_NO_QUIET;
167
168         if (file_exists(state_dir_path("verbose", opts)))
169                 opts->flags |= REBASE_VERBOSE;
170
171         strbuf_release(&buf);
172
173         return 0;
174 }
175
176 static int finish_rebase(struct rebase_options *opts)
177 {
178         struct strbuf dir = STRBUF_INIT;
179         const char *argv_gc_auto[] = { "gc", "--auto", NULL };
180
181         delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
182         apply_autostash();
183         close_all_packs(the_repository->objects);
184         /*
185          * We ignore errors in 'gc --auto', since the
186          * user should see them.
187          */
188         run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
189         strbuf_addstr(&dir, opts->state_dir);
190         remove_dir_recursively(&dir, 0);
191         strbuf_release(&dir);
192
193         return 0;
194 }
195
196 static struct commit *peel_committish(const char *name)
197 {
198         struct object *obj;
199         struct object_id oid;
200
201         if (get_oid(name, &oid))
202                 return NULL;
203         obj = parse_object(the_repository, &oid);
204         return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
205 }
206
207 static void add_var(struct strbuf *buf, const char *name, const char *value)
208 {
209         if (!value)
210                 strbuf_addf(buf, "unset %s; ", name);
211         else {
212                 strbuf_addf(buf, "%s=", name);
213                 sq_quote_buf(buf, value);
214                 strbuf_addstr(buf, "; ");
215         }
216 }
217
218 static int run_specific_rebase(struct rebase_options *opts)
219 {
220         const char *argv[] = { NULL, NULL };
221         struct strbuf script_snippet = STRBUF_INIT;
222         int status;
223         const char *backend, *backend_func;
224
225         add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
226         add_var(&script_snippet, "state_dir", opts->state_dir);
227
228         add_var(&script_snippet, "upstream_name", opts->upstream_name);
229         add_var(&script_snippet, "upstream", opts->upstream ?
230                 oid_to_hex(&opts->upstream->object.oid) : NULL);
231         add_var(&script_snippet, "head_name",
232                 opts->head_name ? opts->head_name : "detached HEAD");
233         add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
234         add_var(&script_snippet, "onto", opts->onto ?
235                 oid_to_hex(&opts->onto->object.oid) : NULL);
236         add_var(&script_snippet, "onto_name", opts->onto_name);
237         add_var(&script_snippet, "revisions", opts->revisions);
238         add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
239                 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
240         add_var(&script_snippet, "GIT_QUIET",
241                 opts->flags & REBASE_NO_QUIET ? "" : "t");
242         add_var(&script_snippet, "git_am_opt", opts->git_am_opt.buf);
243         add_var(&script_snippet, "verbose",
244                 opts->flags & REBASE_VERBOSE ? "t" : "");
245         add_var(&script_snippet, "diffstat",
246                 opts->flags & REBASE_DIFFSTAT ? "t" : "");
247         add_var(&script_snippet, "force_rebase",
248                 opts->flags & REBASE_FORCE ? "t" : "");
249         if (opts->switch_to)
250                 add_var(&script_snippet, "switch_to", opts->switch_to);
251         add_var(&script_snippet, "action", opts->action ? opts->action : "");
252
253         switch (opts->type) {
254         case REBASE_AM:
255                 backend = "git-rebase--am";
256                 backend_func = "git_rebase__am";
257                 break;
258         case REBASE_INTERACTIVE:
259                 backend = "git-rebase--interactive";
260                 backend_func = "git_rebase__interactive";
261                 break;
262         case REBASE_MERGE:
263                 backend = "git-rebase--merge";
264                 backend_func = "git_rebase__merge";
265                 break;
266         case REBASE_PRESERVE_MERGES:
267                 backend = "git-rebase--preserve-merges";
268                 backend_func = "git_rebase__preserve_merges";
269                 break;
270         default:
271                 BUG("Unhandled rebase type %d", opts->type);
272                 break;
273         }
274
275         strbuf_addf(&script_snippet,
276                     ". git-sh-setup && . git-rebase--common &&"
277                     " . %s && %s", backend, backend_func);
278         argv[0] = script_snippet.buf;
279
280         status = run_command_v_opt(argv, RUN_USING_SHELL);
281         if (opts->dont_finish_rebase)
282                 ; /* do nothing */
283         else if (status == 0) {
284                 if (!file_exists(state_dir_path("stopped-sha", opts)))
285                         finish_rebase(opts);
286         } else if (status == 2) {
287                 struct strbuf dir = STRBUF_INIT;
288
289                 apply_autostash();
290                 strbuf_addstr(&dir, opts->state_dir);
291                 remove_dir_recursively(&dir, 0);
292                 strbuf_release(&dir);
293                 die("Nothing to do");
294         }
295
296         strbuf_release(&script_snippet);
297
298         return status ? -1 : 0;
299 }
300
301 #define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
302
303 static int reset_head(struct object_id *oid, const char *action,
304                       const char *switch_to_branch, int detach_head)
305 {
306         struct object_id head_oid;
307         struct tree_desc desc;
308         struct lock_file lock = LOCK_INIT;
309         struct unpack_trees_options unpack_tree_opts;
310         struct tree *tree;
311         const char *reflog_action;
312         struct strbuf msg = STRBUF_INIT;
313         size_t prefix_len;
314         struct object_id *orig = NULL, oid_orig,
315                 *old_orig = NULL, oid_old_orig;
316         int ret = 0;
317
318         if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
319                 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
320
321         if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0)
322                 return -1;
323
324         if (!oid) {
325                 if (get_oid("HEAD", &head_oid)) {
326                         rollback_lock_file(&lock);
327                         return error(_("could not determine HEAD revision"));
328                 }
329                 oid = &head_oid;
330         }
331
332         memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
333         setup_unpack_trees_porcelain(&unpack_tree_opts, action);
334         unpack_tree_opts.head_idx = 1;
335         unpack_tree_opts.src_index = the_repository->index;
336         unpack_tree_opts.dst_index = the_repository->index;
337         unpack_tree_opts.fn = oneway_merge;
338         unpack_tree_opts.update = 1;
339         unpack_tree_opts.merge = 1;
340         if (!detach_head)
341                 unpack_tree_opts.reset = 1;
342
343         if (read_index_unmerged(the_repository->index) < 0) {
344                 rollback_lock_file(&lock);
345                 return error(_("could not read index"));
346         }
347
348         if (!fill_tree_descriptor(&desc, oid)) {
349                 error(_("failed to find tree of %s"), oid_to_hex(oid));
350                 rollback_lock_file(&lock);
351                 free((void *)desc.buffer);
352                 return -1;
353         }
354
355         if (unpack_trees(1, &desc, &unpack_tree_opts)) {
356                 rollback_lock_file(&lock);
357                 free((void *)desc.buffer);
358                 return -1;
359         }
360
361         tree = parse_tree_indirect(oid);
362         prime_cache_tree(the_repository->index, tree);
363
364         if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0)
365                 ret = error(_("could not write index"));
366         free((void *)desc.buffer);
367
368         if (ret)
369                 return ret;
370
371         reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
372         strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
373         prefix_len = msg.len;
374
375         if (!get_oid("ORIG_HEAD", &oid_old_orig))
376                 old_orig = &oid_old_orig;
377         if (!get_oid("HEAD", &oid_orig)) {
378                 orig = &oid_orig;
379                 strbuf_addstr(&msg, "updating ORIG_HEAD");
380                 update_ref(msg.buf, "ORIG_HEAD", orig, old_orig, 0,
381                            UPDATE_REFS_MSG_ON_ERR);
382         } else if (old_orig)
383                 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
384         strbuf_setlen(&msg, prefix_len);
385         strbuf_addstr(&msg, "updating HEAD");
386         if (!switch_to_branch)
387                 ret = update_ref(msg.buf, "HEAD", oid, orig, REF_NO_DEREF,
388                                  UPDATE_REFS_MSG_ON_ERR);
389         else {
390                 ret = create_symref("HEAD", switch_to_branch, msg.buf);
391                 if (!ret)
392                         ret = update_ref(msg.buf, "HEAD", oid, NULL, 0,
393                                          UPDATE_REFS_MSG_ON_ERR);
394         }
395
396         strbuf_release(&msg);
397         return ret;
398 }
399
400 static int rebase_config(const char *var, const char *value, void *data)
401 {
402         struct rebase_options *opts = data;
403
404         if (!strcmp(var, "rebase.stat")) {
405                 if (git_config_bool(var, value))
406                         opts->flags |= REBASE_DIFFSTAT;
407                 else
408                         opts->flags &= !REBASE_DIFFSTAT;
409                 return 0;
410         }
411
412         return git_default_config(var, value, data);
413 }
414
415 /*
416  * Determines whether the commits in from..to are linear, i.e. contain
417  * no merge commits. This function *expects* `from` to be an ancestor of
418  * `to`.
419  */
420 static int is_linear_history(struct commit *from, struct commit *to)
421 {
422         while (to && to != from) {
423                 parse_commit(to);
424                 if (!to->parents)
425                         return 1;
426                 if (to->parents->next)
427                         return 0;
428                 to = to->parents->item;
429         }
430         return 1;
431 }
432
433 static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
434                             struct object_id *merge_base)
435 {
436         struct commit *head = lookup_commit(the_repository, head_oid);
437         struct commit_list *merge_bases;
438         int res;
439
440         if (!head)
441                 return 0;
442
443         merge_bases = get_merge_bases(onto, head);
444         if (merge_bases && !merge_bases->next) {
445                 oidcpy(merge_base, &merge_bases->item->object.oid);
446                 res = !oidcmp(merge_base, &onto->object.oid);
447         } else {
448                 oidcpy(merge_base, &null_oid);
449                 res = 0;
450         }
451         free_commit_list(merge_bases);
452         return res && is_linear_history(onto, head);
453 }
454
455 int cmd_rebase(int argc, const char **argv, const char *prefix)
456 {
457         struct rebase_options options = {
458                 .type = REBASE_UNSPECIFIED,
459                 .flags = REBASE_NO_QUIET,
460                 .git_am_opt = STRBUF_INIT,
461         };
462         const char *branch_name;
463         int ret, flags, total_argc, in_progress = 0;
464         int ok_to_skip_pre_rebase = 0;
465         struct strbuf msg = STRBUF_INIT;
466         struct strbuf revisions = STRBUF_INIT;
467         struct strbuf buf = STRBUF_INIT;
468         struct object_id merge_base;
469         enum {
470                 NO_ACTION,
471                 ACTION_CONTINUE,
472                 ACTION_SKIP,
473                 ACTION_ABORT,
474                 ACTION_QUIT,
475         } action = NO_ACTION;
476         struct option builtin_rebase_options[] = {
477                 OPT_STRING(0, "onto", &options.onto_name,
478                            N_("revision"),
479                            N_("rebase onto given branch instead of upstream")),
480                 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
481                          N_("allow pre-rebase hook to run")),
482                 OPT_NEGBIT('q', "quiet", &options.flags,
483                            N_("be quiet. implies --no-stat"),
484                            REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
485                 OPT_BIT('v', "verbose", &options.flags,
486                         N_("display a diffstat of what changed upstream"),
487                         REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
488                 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
489                         N_("do not show diffstat of what changed upstream"),
490                         PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
491                 OPT_BIT('f', "force-rebase", &options.flags,
492                         N_("cherry-pick all commits, even if unchanged"),
493                         REBASE_FORCE),
494                 OPT_BIT(0, "no-ff", &options.flags,
495                         N_("cherry-pick all commits, even if unchanged"),
496                         REBASE_FORCE),
497                 OPT_CMDMODE(0, "continue", &action, N_("continue"),
498                             ACTION_CONTINUE),
499                 OPT_CMDMODE(0, "skip", &action,
500                             N_("skip current patch and continue"), ACTION_SKIP),
501                 OPT_CMDMODE(0, "abort", &action,
502                             N_("abort and check out the original branch"),
503                             ACTION_ABORT),
504                 OPT_CMDMODE(0, "quit", &action,
505                             N_("abort but keep HEAD where it is"), ACTION_QUIT),
506                 OPT_END(),
507         };
508
509         /*
510          * NEEDSWORK: Once the builtin rebase has been tested enough
511          * and git-legacy-rebase.sh is retired to contrib/, this preamble
512          * can be removed.
513          */
514
515         if (!use_builtin_rebase()) {
516                 const char *path = mkpath("%s/git-legacy-rebase",
517                                           git_exec_path());
518
519                 if (sane_execvp(path, (char **)argv) < 0)
520                         die_errno(_("could not exec %s"), path);
521                 else
522                         BUG("sane_execvp() returned???");
523         }
524
525         if (argc == 2 && !strcmp(argv[1], "-h"))
526                 usage_with_options(builtin_rebase_usage,
527                                    builtin_rebase_options);
528
529         prefix = setup_git_directory();
530         trace_repo_setup(prefix);
531         setup_work_tree();
532
533         git_config(rebase_config, &options);
534
535         if (is_directory(apply_dir())) {
536                 options.type = REBASE_AM;
537                 options.state_dir = apply_dir();
538         } else if (is_directory(merge_dir())) {
539                 strbuf_reset(&buf);
540                 strbuf_addf(&buf, "%s/rewritten", merge_dir());
541                 if (is_directory(buf.buf)) {
542                         options.type = REBASE_PRESERVE_MERGES;
543                         options.flags |= REBASE_INTERACTIVE_EXPLICIT;
544                 } else {
545                         strbuf_reset(&buf);
546                         strbuf_addf(&buf, "%s/interactive", merge_dir());
547                         if(file_exists(buf.buf)) {
548                                 options.type = REBASE_INTERACTIVE;
549                                 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
550                         } else
551                                 options.type = REBASE_MERGE;
552                 }
553                 options.state_dir = merge_dir();
554         }
555
556         if (options.type != REBASE_UNSPECIFIED)
557                 in_progress = 1;
558
559         total_argc = argc;
560         argc = parse_options(argc, argv, prefix,
561                              builtin_rebase_options,
562                              builtin_rebase_usage, 0);
563
564         if (action != NO_ACTION && total_argc != 2) {
565                 usage_with_options(builtin_rebase_usage,
566                                    builtin_rebase_options);
567         }
568
569         if (argc > 2)
570                 usage_with_options(builtin_rebase_usage,
571                                    builtin_rebase_options);
572
573         switch (action) {
574         case ACTION_CONTINUE: {
575                 struct object_id head;
576                 struct lock_file lock_file = LOCK_INIT;
577                 int fd;
578
579                 options.action = "continue";
580
581                 /* Sanity check */
582                 if (get_oid("HEAD", &head))
583                         die(_("Cannot read HEAD"));
584
585                 fd = hold_locked_index(&lock_file, 0);
586                 if (read_index(the_repository->index) < 0)
587                         die(_("could not read index"));
588                 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
589                               NULL);
590                 if (0 <= fd)
591                         update_index_if_able(the_repository->index,
592                                              &lock_file);
593                 rollback_lock_file(&lock_file);
594
595                 if (has_unstaged_changes(1)) {
596                         puts(_("You must edit all merge conflicts and then\n"
597                                "mark them as resolved using git add"));
598                         exit(1);
599                 }
600                 if (read_basic_state(&options))
601                         exit(1);
602                 goto run_rebase;
603         }
604         case ACTION_SKIP: {
605                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
606
607                 options.action = "skip";
608
609                 rerere_clear(&merge_rr);
610                 string_list_clear(&merge_rr, 1);
611
612                 if (reset_head(NULL, "reset", NULL, 0) < 0)
613                         die(_("could not discard worktree changes"));
614                 if (read_basic_state(&options))
615                         exit(1);
616                 goto run_rebase;
617         }
618         case ACTION_ABORT: {
619                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
620                 options.action = "abort";
621
622                 rerere_clear(&merge_rr);
623                 string_list_clear(&merge_rr, 1);
624
625                 if (read_basic_state(&options))
626                         exit(1);
627                 if (reset_head(&options.orig_head, "reset",
628                                options.head_name, 0) < 0)
629                         die(_("could not move back to %s"),
630                             oid_to_hex(&options.orig_head));
631                 ret = finish_rebase(&options);
632                 goto cleanup;
633         }
634         case ACTION_QUIT: {
635                 strbuf_reset(&buf);
636                 strbuf_addstr(&buf, options.state_dir);
637                 ret = !!remove_dir_recursively(&buf, 0);
638                 if (ret)
639                         die(_("could not remove '%s'"), options.state_dir);
640                 goto cleanup;
641         }
642         default:
643                 die("TODO");
644         }
645
646         /* Make sure no rebase is in progress */
647         if (in_progress) {
648                 const char *last_slash = strrchr(options.state_dir, '/');
649                 const char *state_dir_base =
650                         last_slash ? last_slash + 1 : options.state_dir;
651                 const char *cmd_live_rebase =
652                         "git rebase (--continue | --abort | --skip)";
653                 strbuf_reset(&buf);
654                 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
655                 die(_("It seems that there is already a %s directory, and\n"
656                       "I wonder if you are in the middle of another rebase.  "
657                       "If that is the\n"
658                       "case, please try\n\t%s\n"
659                       "If that is not the case, please\n\t%s\n"
660                       "and run me again.  I am stopping in case you still "
661                       "have something\n"
662                       "valuable there.\n"),
663                     state_dir_base, cmd_live_rebase, buf.buf);
664         }
665
666         if (!(options.flags & REBASE_NO_QUIET))
667                 strbuf_addstr(&options.git_am_opt, " -q");
668
669         switch (options.type) {
670         case REBASE_MERGE:
671         case REBASE_INTERACTIVE:
672         case REBASE_PRESERVE_MERGES:
673                 options.state_dir = merge_dir();
674                 break;
675         case REBASE_AM:
676                 options.state_dir = apply_dir();
677                 break;
678         default:
679                 /* the default rebase backend is `--am` */
680                 options.type = REBASE_AM;
681                 options.state_dir = apply_dir();
682                 break;
683         }
684
685         if (!options.root) {
686                 if (argc < 1)
687                         die("TODO: handle @{upstream}");
688                 else {
689                         options.upstream_name = argv[0];
690                         argc--;
691                         argv++;
692                         if (!strcmp(options.upstream_name, "-"))
693                                 options.upstream_name = "@{-1}";
694                 }
695                 options.upstream = peel_committish(options.upstream_name);
696                 if (!options.upstream)
697                         die(_("invalid upstream '%s'"), options.upstream_name);
698                 options.upstream_arg = options.upstream_name;
699         } else
700                 die("TODO: upstream for --root");
701
702         /* Make sure the branch to rebase onto is valid. */
703         if (!options.onto_name)
704                 options.onto_name = options.upstream_name;
705         if (strstr(options.onto_name, "...")) {
706                 if (get_oid_mb(options.onto_name, &merge_base) < 0)
707                         die(_("'%s': need exactly one merge base"),
708                             options.onto_name);
709                 options.onto = lookup_commit_or_die(&merge_base,
710                                                     options.onto_name);
711         } else {
712                 options.onto = peel_committish(options.onto_name);
713                 if (!options.onto)
714                         die(_("Does not point to a valid commit '%s'"),
715                                 options.onto_name);
716         }
717
718         /*
719          * If the branch to rebase is given, that is the branch we will rebase
720          * branch_name -- branch/commit being rebased, or
721          *                HEAD (already detached)
722          * orig_head -- commit object name of tip of the branch before rebasing
723          * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
724          */
725         if (argc == 1) {
726                 /* Is it "rebase other branchname" or "rebase other commit"? */
727                 branch_name = argv[0];
728                 options.switch_to = argv[0];
729
730                 /* Is it a local branch? */
731                 strbuf_reset(&buf);
732                 strbuf_addf(&buf, "refs/heads/%s", branch_name);
733                 if (!read_ref(buf.buf, &options.orig_head))
734                         options.head_name = xstrdup(buf.buf);
735                 /* If not is it a valid ref (branch or commit)? */
736                 else if (!get_oid(branch_name, &options.orig_head))
737                         options.head_name = NULL;
738                 else
739                         die(_("fatal: no such branch/commit '%s'"),
740                             branch_name);
741         } else if (argc == 0) {
742                 /* Do not need to switch branches, we are already on it. */
743                 options.head_name =
744                         xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
745                                          &flags));
746                 if (!options.head_name)
747                         die(_("No such ref: %s"), "HEAD");
748                 if (flags & REF_ISSYMREF) {
749                         if (!skip_prefix(options.head_name,
750                                          "refs/heads/", &branch_name))
751                                 branch_name = options.head_name;
752
753                 } else {
754                         free(options.head_name);
755                         options.head_name = NULL;
756                         branch_name = "HEAD";
757                 }
758                 if (get_oid("HEAD", &options.orig_head))
759                         die(_("Could not resolve HEAD to a revision"));
760         } else
761                 BUG("unexpected number of arguments left to parse");
762
763         if (read_index(the_repository->index) < 0)
764                 die(_("could not read index"));
765
766         if (require_clean_work_tree("rebase",
767                                     _("Please commit or stash them."), 1, 1)) {
768                 ret = 1;
769                 goto cleanup;
770         }
771
772         /*
773          * Now we are rebasing commits upstream..orig_head (or with --root,
774          * everything leading up to orig_head) on top of onto.
775          */
776
777         /*
778          * Check if we are already based on onto with linear history,
779          * but this should be done only when upstream and onto are the same
780          * and if this is not an interactive rebase.
781          */
782         if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
783             !is_interactive(&options) && !options.restrict_revision &&
784             !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
785                 int flag;
786
787                 if (!(options.flags & REBASE_FORCE)) {
788                         /* Lazily switch to the target branch if needed... */
789                         if (options.switch_to) {
790                                 struct object_id oid;
791
792                                 if (get_oid(options.switch_to, &oid) < 0) {
793                                         ret = !!error(_("could not parse '%s'"),
794                                                       options.switch_to);
795                                         goto cleanup;
796                                 }
797
798                                 strbuf_reset(&buf);
799                                 strbuf_addf(&buf, "rebase: checkout %s",
800                                             options.switch_to);
801                                 if (reset_head(&oid, "checkout",
802                                                options.head_name, 0) < 0) {
803                                         ret = !!error(_("could not switch to "
804                                                         "%s"),
805                                                       options.switch_to);
806                                         goto cleanup;
807                                 }
808                         }
809
810                         if (!(options.flags & REBASE_NO_QUIET))
811                                 ; /* be quiet */
812                         else if (!strcmp(branch_name, "HEAD") &&
813                                  resolve_ref_unsafe("HEAD", 0, NULL, &flag))
814                                 puts(_("HEAD is up to date."));
815                         else
816                                 printf(_("Current branch %s is up to date.\n"),
817                                        branch_name);
818                         ret = !!finish_rebase(&options);
819                         goto cleanup;
820                 } else if (!(options.flags & REBASE_NO_QUIET))
821                         ; /* be quiet */
822                 else if (!strcmp(branch_name, "HEAD") &&
823                          resolve_ref_unsafe("HEAD", 0, NULL, &flag))
824                         puts(_("HEAD is up to date, rebase forced."));
825                 else
826                         printf(_("Current branch %s is up to date, rebase "
827                                  "forced.\n"), branch_name);
828         }
829
830         /* If a hook exists, give it a chance to interrupt*/
831         if (!ok_to_skip_pre_rebase &&
832             run_hook_le(NULL, "pre-rebase", options.upstream_arg,
833                         argc ? argv[0] : NULL, NULL))
834                 die(_("The pre-rebase hook refused to rebase."));
835
836         if (options.flags & REBASE_DIFFSTAT) {
837                 struct diff_options opts;
838
839                 if (options.flags & REBASE_VERBOSE)
840                         printf(_("Changes from %s to %s:\n"),
841                                 oid_to_hex(&merge_base),
842                                 oid_to_hex(&options.onto->object.oid));
843
844                 /* We want color (if set), but no pager */
845                 diff_setup(&opts);
846                 opts.stat_width = -1; /* use full terminal width */
847                 opts.stat_graph_width = -1; /* respect statGraphWidth config */
848                 opts.output_format |=
849                         DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
850                 opts.detect_rename = DIFF_DETECT_RENAME;
851                 diff_setup_done(&opts);
852                 diff_tree_oid(&merge_base, &options.onto->object.oid,
853                               "", &opts);
854                 diffcore_std(&opts);
855                 diff_flush(&opts);
856         }
857
858         /* Detach HEAD and reset the tree */
859         if (options.flags & REBASE_NO_QUIET)
860                 printf(_("First, rewinding head to replay your work on top of "
861                          "it...\n"));
862
863         strbuf_addf(&msg, "rebase: checkout %s", options.onto_name);
864         if (reset_head(&options.onto->object.oid, "checkout", NULL, 1))
865                 die(_("Could not detach HEAD"));
866         strbuf_release(&msg);
867
868         strbuf_addf(&revisions, "%s..%s",
869                     options.root ? oid_to_hex(&options.onto->object.oid) :
870                     (options.restrict_revision ?
871                      oid_to_hex(&options.restrict_revision->object.oid) :
872                      oid_to_hex(&options.upstream->object.oid)),
873                     oid_to_hex(&options.orig_head));
874
875         options.revisions = revisions.buf;
876
877 run_rebase:
878         ret = !!run_specific_rebase(&options);
879
880 cleanup:
881         strbuf_release(&revisions);
882         free(options.head_name);
883         return ret;
884 }