commit: support commit.status, --status, and --no-status
[git] / builtin-commit.c
1 /*
2  * Builtin "git commit"
3  *
4  * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>
5  * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
6  */
7
8 #include "cache.h"
9 #include "cache-tree.h"
10 #include "color.h"
11 #include "dir.h"
12 #include "builtin.h"
13 #include "diff.h"
14 #include "diffcore.h"
15 #include "commit.h"
16 #include "revision.h"
17 #include "wt-status.h"
18 #include "run-command.h"
19 #include "refs.h"
20 #include "log-tree.h"
21 #include "strbuf.h"
22 #include "utf8.h"
23 #include "parse-options.h"
24 #include "string-list.h"
25 #include "rerere.h"
26 #include "unpack-trees.h"
27
28 static const char * const builtin_commit_usage[] = {
29         "git commit [options] [--] <filepattern>...",
30         NULL
31 };
32
33 static const char * const builtin_status_usage[] = {
34         "git status [options] [--] <filepattern>...",
35         NULL
36 };
37
38 static unsigned char head_sha1[20], merge_head_sha1[20];
39 static char *use_message_buffer;
40 static const char commit_editmsg[] = "COMMIT_EDITMSG";
41 static struct lock_file index_lock; /* real index */
42 static struct lock_file false_lock; /* used only for partial commits */
43 static enum {
44         COMMIT_AS_IS = 1,
45         COMMIT_NORMAL,
46         COMMIT_PARTIAL,
47 } commit_style;
48
49 static const char *logfile, *force_author;
50 static const char *template_file;
51 static char *edit_message, *use_message;
52 static char *author_name, *author_email, *author_date;
53 static int all, edit_flag, also, interactive, only, amend, signoff;
54 static int quiet, verbose, no_verify, allow_empty, dry_run, renew_authorship;
55 static char *untracked_files_arg;
56 /*
57  * The default commit message cleanup mode will remove the lines
58  * beginning with # (shell comments) and leading and trailing
59  * whitespaces (empty lines or containing only whitespaces)
60  * if editor is used, and only the whitespaces if the message
61  * is specified explicitly.
62  */
63 static enum {
64         CLEANUP_SPACE,
65         CLEANUP_NONE,
66         CLEANUP_ALL,
67 } cleanup_mode;
68 static char *cleanup_arg;
69
70 static int use_editor = 1, initial_commit, in_merge, include_status = 1;
71 static const char *only_include_assumed;
72 static struct strbuf message;
73
74 static int opt_parse_m(const struct option *opt, const char *arg, int unset)
75 {
76         struct strbuf *buf = opt->value;
77         if (unset)
78                 strbuf_setlen(buf, 0);
79         else {
80                 strbuf_addstr(buf, arg);
81                 strbuf_addstr(buf, "\n\n");
82         }
83         return 0;
84 }
85
86 static struct option builtin_commit_options[] = {
87         OPT__QUIET(&quiet),
88         OPT__VERBOSE(&verbose),
89         OPT_GROUP("Commit message options"),
90
91         OPT_FILENAME('F', "file", &logfile, "read log from file"),
92         OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
93         OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
94         OPT_STRING('c', "reedit-message", &edit_message, "COMMIT", "reuse and edit message from specified commit"),
95         OPT_STRING('C', "reuse-message", &use_message, "COMMIT", "reuse message from specified commit"),
96         OPT_BOOLEAN(0, "reset-author", &renew_authorship, "the commit is authored by me now (used with -C-c/--amend)"),
97         OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
98         OPT_FILENAME('t', "template", &template_file, "use specified template file"),
99         OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
100         OPT_BOOLEAN(0, "status", &include_status, "include status in commit message template"),
101
102         OPT_GROUP("Commit contents options"),
103         OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
104         OPT_BOOLEAN('i', "include", &also, "add specified files to index for commit"),
105         OPT_BOOLEAN(0, "interactive", &interactive, "interactively add files"),
106         OPT_BOOLEAN('o', "only", &only, "commit only specified files"),
107         OPT_BOOLEAN('n', "no-verify", &no_verify, "bypass pre-commit hook"),
108         OPT_BOOLEAN(0, "dry-run", &dry_run, "show what would be committed"),
109         OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
110         { OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
111         OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
112         OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
113
114         OPT_END()
115 };
116
117 static void rollback_index_files(void)
118 {
119         switch (commit_style) {
120         case COMMIT_AS_IS:
121                 break; /* nothing to do */
122         case COMMIT_NORMAL:
123                 rollback_lock_file(&index_lock);
124                 break;
125         case COMMIT_PARTIAL:
126                 rollback_lock_file(&index_lock);
127                 rollback_lock_file(&false_lock);
128                 break;
129         }
130 }
131
132 static int commit_index_files(void)
133 {
134         int err = 0;
135
136         switch (commit_style) {
137         case COMMIT_AS_IS:
138                 break; /* nothing to do */
139         case COMMIT_NORMAL:
140                 err = commit_lock_file(&index_lock);
141                 break;
142         case COMMIT_PARTIAL:
143                 err = commit_lock_file(&index_lock);
144                 rollback_lock_file(&false_lock);
145                 break;
146         }
147
148         return err;
149 }
150
151 /*
152  * Take a union of paths in the index and the named tree (typically, "HEAD"),
153  * and return the paths that match the given pattern in list.
154  */
155 static int list_paths(struct string_list *list, const char *with_tree,
156                       const char *prefix, const char **pattern)
157 {
158         int i;
159         char *m;
160
161         for (i = 0; pattern[i]; i++)
162                 ;
163         m = xcalloc(1, i);
164
165         if (with_tree)
166                 overlay_tree_on_cache(with_tree, prefix);
167
168         for (i = 0; i < active_nr; i++) {
169                 struct cache_entry *ce = active_cache[i];
170                 if (ce->ce_flags & CE_UPDATE)
171                         continue;
172                 if (!match_pathspec(pattern, ce->name, ce_namelen(ce), 0, m))
173                         continue;
174                 string_list_insert(ce->name, list);
175         }
176
177         return report_path_error(m, pattern, prefix ? strlen(prefix) : 0);
178 }
179
180 static void add_remove_files(struct string_list *list)
181 {
182         int i;
183         for (i = 0; i < list->nr; i++) {
184                 struct stat st;
185                 struct string_list_item *p = &(list->items[i]);
186
187                 if (!lstat(p->string, &st)) {
188                         if (add_to_cache(p->string, &st, 0))
189                                 die("updating files failed");
190                 } else
191                         remove_file_from_cache(p->string);
192         }
193 }
194
195 static void create_base_index(void)
196 {
197         struct tree *tree;
198         struct unpack_trees_options opts;
199         struct tree_desc t;
200
201         if (initial_commit) {
202                 discard_cache();
203                 return;
204         }
205
206         memset(&opts, 0, sizeof(opts));
207         opts.head_idx = 1;
208         opts.index_only = 1;
209         opts.merge = 1;
210         opts.src_index = &the_index;
211         opts.dst_index = &the_index;
212
213         opts.fn = oneway_merge;
214         tree = parse_tree_indirect(head_sha1);
215         if (!tree)
216                 die("failed to unpack HEAD tree object");
217         parse_tree(tree);
218         init_tree_desc(&t, tree->buffer, tree->size);
219         if (unpack_trees(1, &t, &opts))
220                 exit(128); /* We've already reported the error, finish dying */
221 }
222
223 static char *prepare_index(int argc, const char **argv, const char *prefix, int is_status)
224 {
225         int fd;
226         struct string_list partial;
227         const char **pathspec = NULL;
228         int refresh_flags = REFRESH_QUIET;
229
230         if (is_status)
231                 refresh_flags |= REFRESH_UNMERGED;
232         if (interactive) {
233                 if (interactive_add(argc, argv, prefix) != 0)
234                         die("interactive add failed");
235                 if (read_cache_preload(NULL) < 0)
236                         die("index file corrupt");
237                 commit_style = COMMIT_AS_IS;
238                 return get_index_file();
239         }
240
241         if (*argv)
242                 pathspec = get_pathspec(prefix, argv);
243
244         if (read_cache_preload(pathspec) < 0)
245                 die("index file corrupt");
246
247         /*
248          * Non partial, non as-is commit.
249          *
250          * (1) get the real index;
251          * (2) update the_index as necessary;
252          * (3) write the_index out to the real index (still locked);
253          * (4) return the name of the locked index file.
254          *
255          * The caller should run hooks on the locked real index, and
256          * (A) if all goes well, commit the real index;
257          * (B) on failure, rollback the real index.
258          */
259         if (all || (also && pathspec && *pathspec)) {
260                 int fd = hold_locked_index(&index_lock, 1);
261                 add_files_to_cache(also ? prefix : NULL, pathspec, 0);
262                 refresh_cache(refresh_flags);
263                 if (write_cache(fd, active_cache, active_nr) ||
264                     close_lock_file(&index_lock))
265                         die("unable to write new_index file");
266                 commit_style = COMMIT_NORMAL;
267                 return index_lock.filename;
268         }
269
270         /*
271          * As-is commit.
272          *
273          * (1) return the name of the real index file.
274          *
275          * The caller should run hooks on the real index, and run
276          * hooks on the real index, and create commit from the_index.
277          * We still need to refresh the index here.
278          */
279         if (!pathspec || !*pathspec) {
280                 fd = hold_locked_index(&index_lock, 1);
281                 refresh_cache(refresh_flags);
282                 if (write_cache(fd, active_cache, active_nr) ||
283                     commit_locked_index(&index_lock))
284                         die("unable to write new_index file");
285                 commit_style = COMMIT_AS_IS;
286                 return get_index_file();
287         }
288
289         /*
290          * A partial commit.
291          *
292          * (0) find the set of affected paths;
293          * (1) get lock on the real index file;
294          * (2) update the_index with the given paths;
295          * (3) write the_index out to the real index (still locked);
296          * (4) get lock on the false index file;
297          * (5) reset the_index from HEAD;
298          * (6) update the_index the same way as (2);
299          * (7) write the_index out to the false index file;
300          * (8) return the name of the false index file (still locked);
301          *
302          * The caller should run hooks on the locked false index, and
303          * create commit from it.  Then
304          * (A) if all goes well, commit the real index;
305          * (B) on failure, rollback the real index;
306          * In either case, rollback the false index.
307          */
308         commit_style = COMMIT_PARTIAL;
309
310         if (file_exists(git_path("MERGE_HEAD")))
311                 die("cannot do a partial commit during a merge.");
312
313         memset(&partial, 0, sizeof(partial));
314         partial.strdup_strings = 1;
315         if (list_paths(&partial, initial_commit ? NULL : "HEAD", prefix, pathspec))
316                 exit(1);
317
318         discard_cache();
319         if (read_cache() < 0)
320                 die("cannot read the index");
321
322         fd = hold_locked_index(&index_lock, 1);
323         add_remove_files(&partial);
324         refresh_cache(REFRESH_QUIET);
325         if (write_cache(fd, active_cache, active_nr) ||
326             close_lock_file(&index_lock))
327                 die("unable to write new_index file");
328
329         fd = hold_lock_file_for_update(&false_lock,
330                                        git_path("next-index-%"PRIuMAX,
331                                                 (uintmax_t) getpid()),
332                                        LOCK_DIE_ON_ERROR);
333
334         create_base_index();
335         add_remove_files(&partial);
336         refresh_cache(REFRESH_QUIET);
337
338         if (write_cache(fd, active_cache, active_nr) ||
339             close_lock_file(&false_lock))
340                 die("unable to write temporary index file");
341
342         discard_cache();
343         read_cache_from(false_lock.filename);
344
345         return false_lock.filename;
346 }
347
348 static int run_status(FILE *fp, const char *index_file, const char *prefix, int nowarn,
349                       struct wt_status *s)
350 {
351         if (s->relative_paths)
352                 s->prefix = prefix;
353
354         if (amend) {
355                 s->amend = 1;
356                 s->reference = "HEAD^1";
357         }
358         s->verbose = verbose;
359         s->index_file = index_file;
360         s->fp = fp;
361         s->nowarn = nowarn;
362
363         wt_status_print(s);
364
365         return s->commitable;
366 }
367
368 static int is_a_merge(const unsigned char *sha1)
369 {
370         struct commit *commit = lookup_commit(sha1);
371         if (!commit || parse_commit(commit))
372                 die("could not parse HEAD commit");
373         return !!(commit->parents && commit->parents->next);
374 }
375
376 static const char sign_off_header[] = "Signed-off-by: ";
377
378 static void determine_author_info(void)
379 {
380         char *name, *email, *date;
381
382         name = getenv("GIT_AUTHOR_NAME");
383         email = getenv("GIT_AUTHOR_EMAIL");
384         date = getenv("GIT_AUTHOR_DATE");
385
386         if (use_message && !renew_authorship) {
387                 const char *a, *lb, *rb, *eol;
388
389                 a = strstr(use_message_buffer, "\nauthor ");
390                 if (!a)
391                         die("invalid commit: %s", use_message);
392
393                 lb = strstr(a + 8, " <");
394                 rb = strstr(a + 8, "> ");
395                 eol = strchr(a + 8, '\n');
396                 if (!lb || !rb || !eol)
397                         die("invalid commit: %s", use_message);
398
399                 name = xstrndup(a + 8, lb - (a + 8));
400                 email = xstrndup(lb + 2, rb - (lb + 2));
401                 date = xstrndup(rb + 2, eol - (rb + 2));
402         }
403
404         if (force_author) {
405                 const char *lb = strstr(force_author, " <");
406                 const char *rb = strchr(force_author, '>');
407
408                 if (!lb || !rb)
409                         die("malformed --author parameter");
410                 name = xstrndup(force_author, lb - force_author);
411                 email = xstrndup(lb + 2, rb - (lb + 2));
412         }
413
414         author_name = name;
415         author_email = email;
416         author_date = date;
417 }
418
419 static int ends_rfc2822_footer(struct strbuf *sb)
420 {
421         int ch;
422         int hit = 0;
423         int i, j, k;
424         int len = sb->len;
425         int first = 1;
426         const char *buf = sb->buf;
427
428         for (i = len - 1; i > 0; i--) {
429                 if (hit && buf[i] == '\n')
430                         break;
431                 hit = (buf[i] == '\n');
432         }
433
434         while (i < len - 1 && buf[i] == '\n')
435                 i++;
436
437         for (; i < len; i = k) {
438                 for (k = i; k < len && buf[k] != '\n'; k++)
439                         ; /* do nothing */
440                 k++;
441
442                 if ((buf[k] == ' ' || buf[k] == '\t') && !first)
443                         continue;
444
445                 first = 0;
446
447                 for (j = 0; i + j < len; j++) {
448                         ch = buf[i + j];
449                         if (ch == ':')
450                                 break;
451                         if (isalnum(ch) ||
452                             (ch == '-'))
453                                 continue;
454                         return 0;
455                 }
456         }
457         return 1;
458 }
459
460 static int prepare_to_commit(const char *index_file, const char *prefix,
461                              struct wt_status *s)
462 {
463         struct stat statbuf;
464         int commitable, saved_color_setting;
465         struct strbuf sb = STRBUF_INIT;
466         char *buffer;
467         FILE *fp;
468         const char *hook_arg1 = NULL;
469         const char *hook_arg2 = NULL;
470         int ident_shown = 0;
471
472         if (!no_verify && run_hook(index_file, "pre-commit", NULL))
473                 return 0;
474
475         if (message.len) {
476                 strbuf_addbuf(&sb, &message);
477                 hook_arg1 = "message";
478         } else if (logfile && !strcmp(logfile, "-")) {
479                 if (isatty(0))
480                         fprintf(stderr, "(reading log message from standard input)\n");
481                 if (strbuf_read(&sb, 0, 0) < 0)
482                         die_errno("could not read log from standard input");
483                 hook_arg1 = "message";
484         } else if (logfile) {
485                 if (strbuf_read_file(&sb, logfile, 0) < 0)
486                         die_errno("could not read log file '%s'",
487                                   logfile);
488                 hook_arg1 = "message";
489         } else if (use_message) {
490                 buffer = strstr(use_message_buffer, "\n\n");
491                 if (!buffer || buffer[2] == '\0')
492                         die("commit has empty message");
493                 strbuf_add(&sb, buffer + 2, strlen(buffer + 2));
494                 hook_arg1 = "commit";
495                 hook_arg2 = use_message;
496         } else if (!stat(git_path("MERGE_MSG"), &statbuf)) {
497                 if (strbuf_read_file(&sb, git_path("MERGE_MSG"), 0) < 0)
498                         die_errno("could not read MERGE_MSG");
499                 hook_arg1 = "merge";
500         } else if (!stat(git_path("SQUASH_MSG"), &statbuf)) {
501                 if (strbuf_read_file(&sb, git_path("SQUASH_MSG"), 0) < 0)
502                         die_errno("could not read SQUASH_MSG");
503                 hook_arg1 = "squash";
504         } else if (template_file && !stat(template_file, &statbuf)) {
505                 if (strbuf_read_file(&sb, template_file, 0) < 0)
506                         die_errno("could not read '%s'", template_file);
507                 hook_arg1 = "template";
508         }
509
510         /*
511          * This final case does not modify the template message,
512          * it just sets the argument to the prepare-commit-msg hook.
513          */
514         else if (in_merge)
515                 hook_arg1 = "merge";
516
517         fp = fopen(git_path(commit_editmsg), "w");
518         if (fp == NULL)
519                 die_errno("could not open '%s'", git_path(commit_editmsg));
520
521         if (cleanup_mode != CLEANUP_NONE)
522                 stripspace(&sb, 0);
523
524         if (signoff) {
525                 struct strbuf sob = STRBUF_INIT;
526                 int i;
527
528                 strbuf_addstr(&sob, sign_off_header);
529                 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
530                                              getenv("GIT_COMMITTER_EMAIL")));
531                 strbuf_addch(&sob, '\n');
532                 for (i = sb.len - 1; i > 0 && sb.buf[i - 1] != '\n'; i--)
533                         ; /* do nothing */
534                 if (prefixcmp(sb.buf + i, sob.buf)) {
535                         if (!i || !ends_rfc2822_footer(&sb))
536                                 strbuf_addch(&sb, '\n');
537                         strbuf_addbuf(&sb, &sob);
538                 }
539                 strbuf_release(&sob);
540         }
541
542         if (fwrite(sb.buf, 1, sb.len, fp) < sb.len)
543                 die_errno("could not write commit template");
544
545         strbuf_release(&sb);
546
547         determine_author_info();
548
549         /* This checks if committer ident is explicitly given */
550         git_committer_info(0);
551         if (use_editor && include_status) {
552                 char *author_ident;
553                 const char *committer_ident;
554
555                 if (in_merge)
556                         fprintf(fp,
557                                 "#\n"
558                                 "# It looks like you may be committing a MERGE.\n"
559                                 "# If this is not correct, please remove the file\n"
560                                 "#      %s\n"
561                                 "# and try again.\n"
562                                 "#\n",
563                                 git_path("MERGE_HEAD"));
564
565                 fprintf(fp,
566                         "\n"
567                         "# Please enter the commit message for your changes.");
568                 if (cleanup_mode == CLEANUP_ALL)
569                         fprintf(fp,
570                                 " Lines starting\n"
571                                 "# with '#' will be ignored, and an empty"
572                                 " message aborts the commit.\n");
573                 else /* CLEANUP_SPACE, that is. */
574                         fprintf(fp,
575                                 " Lines starting\n"
576                                 "# with '#' will be kept; you may remove them"
577                                 " yourself if you want to.\n"
578                                 "# An empty message aborts the commit.\n");
579                 if (only_include_assumed)
580                         fprintf(fp, "# %s\n", only_include_assumed);
581
582                 author_ident = xstrdup(fmt_name(author_name, author_email));
583                 committer_ident = fmt_name(getenv("GIT_COMMITTER_NAME"),
584                                            getenv("GIT_COMMITTER_EMAIL"));
585                 if (strcmp(author_ident, committer_ident))
586                         fprintf(fp,
587                                 "%s"
588                                 "# Author:    %s\n",
589                                 ident_shown++ ? "" : "#\n",
590                                 author_ident);
591                 free(author_ident);
592
593                 if (!user_ident_explicitly_given)
594                         fprintf(fp,
595                                 "%s"
596                                 "# Committer: %s\n",
597                                 ident_shown++ ? "" : "#\n",
598                                 committer_ident);
599
600                 if (ident_shown)
601                         fprintf(fp, "#\n");
602
603                 saved_color_setting = s->use_color;
604                 s->use_color = 0;
605                 commitable = run_status(fp, index_file, prefix, 1, s);
606                 s->use_color = saved_color_setting;
607         } else {
608                 unsigned char sha1[20];
609                 const char *parent = "HEAD";
610
611                 if (!active_nr && read_cache() < 0)
612                         die("Cannot read index");
613
614                 if (amend)
615                         parent = "HEAD^1";
616
617                 if (get_sha1(parent, sha1))
618                         commitable = !!active_nr;
619                 else
620                         commitable = index_differs_from(parent, 0);
621         }
622
623         fclose(fp);
624
625         if (!commitable && !in_merge && !allow_empty &&
626             !(amend && is_a_merge(head_sha1))) {
627                 run_status(stdout, index_file, prefix, 0, s);
628                 return 0;
629         }
630
631         /*
632          * Re-read the index as pre-commit hook could have updated it,
633          * and write it out as a tree.  We must do this before we invoke
634          * the editor and after we invoke run_status above.
635          */
636         discard_cache();
637         read_cache_from(index_file);
638         if (!active_cache_tree)
639                 active_cache_tree = cache_tree();
640         if (cache_tree_update(active_cache_tree,
641                               active_cache, active_nr, 0, 0) < 0) {
642                 error("Error building trees");
643                 return 0;
644         }
645
646         if (run_hook(index_file, "prepare-commit-msg",
647                      git_path(commit_editmsg), hook_arg1, hook_arg2, NULL))
648                 return 0;
649
650         if (use_editor) {
651                 char index[PATH_MAX];
652                 const char *env[2] = { index, NULL };
653                 snprintf(index, sizeof(index), "GIT_INDEX_FILE=%s", index_file);
654                 if (launch_editor(git_path(commit_editmsg), NULL, env)) {
655                         fprintf(stderr,
656                         "Please supply the message using either -m or -F option.\n");
657                         exit(1);
658                 }
659         }
660
661         if (!no_verify &&
662             run_hook(index_file, "commit-msg", git_path(commit_editmsg), NULL)) {
663                 return 0;
664         }
665
666         return 1;
667 }
668
669 /*
670  * Find out if the message in the strbuf contains only whitespace and
671  * Signed-off-by lines.
672  */
673 static int message_is_empty(struct strbuf *sb)
674 {
675         struct strbuf tmpl = STRBUF_INIT;
676         const char *nl;
677         int eol, i, start = 0;
678
679         if (cleanup_mode == CLEANUP_NONE && sb->len)
680                 return 0;
681
682         /* See if the template is just a prefix of the message. */
683         if (template_file && strbuf_read_file(&tmpl, template_file, 0) > 0) {
684                 stripspace(&tmpl, cleanup_mode == CLEANUP_ALL);
685                 if (start + tmpl.len <= sb->len &&
686                     memcmp(tmpl.buf, sb->buf + start, tmpl.len) == 0)
687                         start += tmpl.len;
688         }
689         strbuf_release(&tmpl);
690
691         /* Check if the rest is just whitespace and Signed-of-by's. */
692         for (i = start; i < sb->len; i++) {
693                 nl = memchr(sb->buf + i, '\n', sb->len - i);
694                 if (nl)
695                         eol = nl - sb->buf;
696                 else
697                         eol = sb->len;
698
699                 if (strlen(sign_off_header) <= eol - i &&
700                     !prefixcmp(sb->buf + i, sign_off_header)) {
701                         i = eol;
702                         continue;
703                 }
704                 while (i < eol)
705                         if (!isspace(sb->buf[i++]))
706                                 return 0;
707         }
708
709         return 1;
710 }
711
712 static const char *find_author_by_nickname(const char *name)
713 {
714         struct rev_info revs;
715         struct commit *commit;
716         struct strbuf buf = STRBUF_INIT;
717         const char *av[20];
718         int ac = 0;
719
720         init_revisions(&revs, NULL);
721         strbuf_addf(&buf, "--author=%s", name);
722         av[++ac] = "--all";
723         av[++ac] = "-i";
724         av[++ac] = buf.buf;
725         av[++ac] = NULL;
726         setup_revisions(ac, av, &revs, NULL);
727         prepare_revision_walk(&revs);
728         commit = get_revision(&revs);
729         if (commit) {
730                 struct pretty_print_context ctx = {0};
731                 ctx.date_mode = DATE_NORMAL;
732                 strbuf_release(&buf);
733                 format_commit_message(commit, "%an <%ae>", &buf, &ctx);
734                 return strbuf_detach(&buf, NULL);
735         }
736         die("No existing author found with '%s'", name);
737 }
738
739 static int parse_and_validate_options(int argc, const char *argv[],
740                                       const char * const usage[],
741                                       const char *prefix,
742                                       struct wt_status *s)
743 {
744         int f = 0;
745
746         argc = parse_options(argc, argv, prefix, builtin_commit_options, usage,
747                              0);
748
749         if (force_author && !strchr(force_author, '>'))
750                 force_author = find_author_by_nickname(force_author);
751
752         if (force_author && renew_authorship)
753                 die("Using both --reset-author and --author does not make sense");
754
755         if (logfile || message.len || use_message)
756                 use_editor = 0;
757         if (edit_flag)
758                 use_editor = 1;
759         if (!use_editor)
760                 setenv("GIT_EDITOR", ":", 1);
761
762         if (get_sha1("HEAD", head_sha1))
763                 initial_commit = 1;
764
765         if (!get_sha1("MERGE_HEAD", merge_head_sha1))
766                 in_merge = 1;
767
768         /* Sanity check options */
769         if (amend && initial_commit)
770                 die("You have nothing to amend.");
771         if (amend && in_merge)
772                 die("You are in the middle of a merge -- cannot amend.");
773
774         if (use_message)
775                 f++;
776         if (edit_message)
777                 f++;
778         if (logfile)
779                 f++;
780         if (f > 1)
781                 die("Only one of -c/-C/-F can be used.");
782         if (message.len && f > 0)
783                 die("Option -m cannot be combined with -c/-C/-F.");
784         if (edit_message)
785                 use_message = edit_message;
786         if (amend && !use_message)
787                 use_message = "HEAD";
788         if (!use_message && renew_authorship)
789                 die("--reset-author can be used only with -C, -c or --amend.");
790         if (use_message) {
791                 unsigned char sha1[20];
792                 static char utf8[] = "UTF-8";
793                 const char *out_enc;
794                 char *enc, *end;
795                 struct commit *commit;
796
797                 if (get_sha1(use_message, sha1))
798                         die("could not lookup commit %s", use_message);
799                 commit = lookup_commit_reference(sha1);
800                 if (!commit || parse_commit(commit))
801                         die("could not parse commit %s", use_message);
802
803                 enc = strstr(commit->buffer, "\nencoding");
804                 if (enc) {
805                         end = strchr(enc + 10, '\n');
806                         enc = xstrndup(enc + 10, end - (enc + 10));
807                 } else {
808                         enc = utf8;
809                 }
810                 out_enc = git_commit_encoding ? git_commit_encoding : utf8;
811
812                 if (strcmp(out_enc, enc))
813                         use_message_buffer =
814                                 reencode_string(commit->buffer, out_enc, enc);
815
816                 /*
817                  * If we failed to reencode the buffer, just copy it
818                  * byte for byte so the user can try to fix it up.
819                  * This also handles the case where input and output
820                  * encodings are identical.
821                  */
822                 if (use_message_buffer == NULL)
823                         use_message_buffer = xstrdup(commit->buffer);
824                 if (enc != utf8)
825                         free(enc);
826         }
827
828         if (!!also + !!only + !!all + !!interactive > 1)
829                 die("Only one of --include/--only/--all/--interactive can be used.");
830         if (argc == 0 && (also || (only && !amend)))
831                 die("No paths with --include/--only does not make sense.");
832         if (argc == 0 && only && amend)
833                 only_include_assumed = "Clever... amending the last one with dirty index.";
834         if (argc > 0 && !also && !only)
835                 only_include_assumed = "Explicit paths specified without -i nor -o; assuming --only paths...";
836         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
837                 cleanup_mode = use_editor ? CLEANUP_ALL : CLEANUP_SPACE;
838         else if (!strcmp(cleanup_arg, "verbatim"))
839                 cleanup_mode = CLEANUP_NONE;
840         else if (!strcmp(cleanup_arg, "whitespace"))
841                 cleanup_mode = CLEANUP_SPACE;
842         else if (!strcmp(cleanup_arg, "strip"))
843                 cleanup_mode = CLEANUP_ALL;
844         else
845                 die("Invalid cleanup mode %s", cleanup_arg);
846
847         if (!untracked_files_arg)
848                 ; /* default already initialized */
849         else if (!strcmp(untracked_files_arg, "no"))
850                 s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
851         else if (!strcmp(untracked_files_arg, "normal"))
852                 s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
853         else if (!strcmp(untracked_files_arg, "all"))
854                 s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
855         else
856                 die("Invalid untracked files mode '%s'", untracked_files_arg);
857
858         if (all && argc > 0)
859                 die("Paths with -a does not make sense.");
860         else if (interactive && argc > 0)
861                 die("Paths with --interactive does not make sense.");
862
863         return argc;
864 }
865
866 static int dry_run_commit(int argc, const char **argv, const char *prefix,
867                           struct wt_status *s)
868 {
869         int commitable;
870         const char *index_file;
871
872         index_file = prepare_index(argc, argv, prefix, 1);
873         commitable = run_status(stdout, index_file, prefix, 0, s);
874         rollback_index_files();
875
876         return commitable ? 0 : 1;
877 }
878
879 static int parse_status_slot(const char *var, int offset)
880 {
881         if (!strcasecmp(var+offset, "header"))
882                 return WT_STATUS_HEADER;
883         if (!strcasecmp(var+offset, "updated")
884                 || !strcasecmp(var+offset, "added"))
885                 return WT_STATUS_UPDATED;
886         if (!strcasecmp(var+offset, "changed"))
887                 return WT_STATUS_CHANGED;
888         if (!strcasecmp(var+offset, "untracked"))
889                 return WT_STATUS_UNTRACKED;
890         if (!strcasecmp(var+offset, "nobranch"))
891                 return WT_STATUS_NOBRANCH;
892         if (!strcasecmp(var+offset, "unmerged"))
893                 return WT_STATUS_UNMERGED;
894         die("bad config variable '%s'", var);
895 }
896
897 static int git_status_config(const char *k, const char *v, void *cb)
898 {
899         struct wt_status *s = cb;
900
901         if (!strcmp(k, "status.submodulesummary")) {
902                 int is_bool;
903                 s->submodule_summary = git_config_bool_or_int(k, v, &is_bool);
904                 if (is_bool && s->submodule_summary)
905                         s->submodule_summary = -1;
906                 return 0;
907         }
908         if (!strcmp(k, "status.color") || !strcmp(k, "color.status")) {
909                 s->use_color = git_config_colorbool(k, v, -1);
910                 return 0;
911         }
912         if (!prefixcmp(k, "status.color.") || !prefixcmp(k, "color.status.")) {
913                 int slot = parse_status_slot(k, 13);
914                 if (!v)
915                         return config_error_nonbool(k);
916                 color_parse(v, k, s->color_palette[slot]);
917                 return 0;
918         }
919         if (!strcmp(k, "status.relativepaths")) {
920                 s->relative_paths = git_config_bool(k, v);
921                 return 0;
922         }
923         if (!strcmp(k, "status.showuntrackedfiles")) {
924                 if (!v)
925                         return config_error_nonbool(k);
926                 else if (!strcmp(v, "no"))
927                         s->show_untracked_files = SHOW_NO_UNTRACKED_FILES;
928                 else if (!strcmp(v, "normal"))
929                         s->show_untracked_files = SHOW_NORMAL_UNTRACKED_FILES;
930                 else if (!strcmp(v, "all"))
931                         s->show_untracked_files = SHOW_ALL_UNTRACKED_FILES;
932                 else
933                         return error("Invalid untracked files mode '%s'", v);
934                 return 0;
935         }
936         return git_diff_ui_config(k, v, NULL);
937 }
938
939 int cmd_status(int argc, const char **argv, const char *prefix)
940 {
941         struct wt_status s;
942
943         wt_status_prepare(&s);
944         git_config(git_status_config, &s);
945         if (s.use_color == -1)
946                 s.use_color = git_use_color_default;
947         if (diff_use_color_default == -1)
948                 diff_use_color_default = git_use_color_default;
949
950         argc = parse_and_validate_options(argc, argv, builtin_status_usage,
951                                           prefix, &s);
952         return dry_run_commit(argc, argv, prefix, &s);
953 }
954
955 static void print_summary(const char *prefix, const unsigned char *sha1)
956 {
957         struct rev_info rev;
958         struct commit *commit;
959         static const char *format = "format:%h] %s";
960         unsigned char junk_sha1[20];
961         const char *head = resolve_ref("HEAD", junk_sha1, 0, NULL);
962
963         commit = lookup_commit(sha1);
964         if (!commit)
965                 die("couldn't look up newly created commit");
966         if (!commit || parse_commit(commit))
967                 die("could not parse newly created commit");
968
969         init_revisions(&rev, prefix);
970         setup_revisions(0, NULL, &rev, NULL);
971
972         rev.abbrev = 0;
973         rev.diff = 1;
974         rev.diffopt.output_format =
975                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
976
977         rev.verbose_header = 1;
978         rev.show_root_diff = 1;
979         get_commit_format(format, &rev);
980         rev.always_show_header = 0;
981         rev.diffopt.detect_rename = 1;
982         rev.diffopt.rename_limit = 100;
983         rev.diffopt.break_opt = 0;
984         diff_setup_done(&rev.diffopt);
985
986         printf("[%s%s ",
987                 !prefixcmp(head, "refs/heads/") ?
988                         head + 11 :
989                         !strcmp(head, "HEAD") ?
990                                 "detached HEAD" :
991                                 head,
992                 initial_commit ? " (root-commit)" : "");
993
994         if (!log_tree_commit(&rev, commit)) {
995                 struct pretty_print_context ctx = {0};
996                 struct strbuf buf = STRBUF_INIT;
997                 ctx.date_mode = DATE_NORMAL;
998                 format_commit_message(commit, format + 7, &buf, &ctx);
999                 printf("%s\n", buf.buf);
1000                 strbuf_release(&buf);
1001         }
1002 }
1003
1004 static int git_commit_config(const char *k, const char *v, void *cb)
1005 {
1006         struct wt_status *s = cb;
1007
1008         if (!strcmp(k, "commit.template"))
1009                 return git_config_pathname(&template_file, k, v);
1010         if (!strcmp(k, "commit.status")) {
1011                 include_status = git_config_bool(k, v);
1012                 return 0;
1013         }
1014
1015         return git_status_config(k, v, s);
1016 }
1017
1018 int cmd_commit(int argc, const char **argv, const char *prefix)
1019 {
1020         struct strbuf sb = STRBUF_INIT;
1021         const char *index_file, *reflog_msg;
1022         char *nl, *p;
1023         unsigned char commit_sha1[20];
1024         struct ref_lock *ref_lock;
1025         struct commit_list *parents = NULL, **pptr = &parents;
1026         struct stat statbuf;
1027         int allow_fast_forward = 1;
1028         struct wt_status s;
1029
1030         wt_status_prepare(&s);
1031         git_config(git_commit_config, &s);
1032
1033         if (s.use_color == -1)
1034                 s.use_color = git_use_color_default;
1035
1036         argc = parse_and_validate_options(argc, argv, builtin_commit_usage,
1037                                           prefix, &s);
1038         if (dry_run) {
1039                 if (diff_use_color_default == -1)
1040                         diff_use_color_default = git_use_color_default;
1041                 return dry_run_commit(argc, argv, prefix, &s);
1042         }
1043         index_file = prepare_index(argc, argv, prefix, 0);
1044
1045         /* Set up everything for writing the commit object.  This includes
1046            running hooks, writing the trees, and interacting with the user.  */
1047         if (!prepare_to_commit(index_file, prefix, &s)) {
1048                 rollback_index_files();
1049                 return 1;
1050         }
1051
1052         /* Determine parents */
1053         if (initial_commit) {
1054                 reflog_msg = "commit (initial)";
1055         } else if (amend) {
1056                 struct commit_list *c;
1057                 struct commit *commit;
1058
1059                 reflog_msg = "commit (amend)";
1060                 commit = lookup_commit(head_sha1);
1061                 if (!commit || parse_commit(commit))
1062                         die("could not parse HEAD commit");
1063
1064                 for (c = commit->parents; c; c = c->next)
1065                         pptr = &commit_list_insert(c->item, pptr)->next;
1066         } else if (in_merge) {
1067                 struct strbuf m = STRBUF_INIT;
1068                 FILE *fp;
1069
1070                 reflog_msg = "commit (merge)";
1071                 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1072                 fp = fopen(git_path("MERGE_HEAD"), "r");
1073                 if (fp == NULL)
1074                         die_errno("could not open '%s' for reading",
1075                                   git_path("MERGE_HEAD"));
1076                 while (strbuf_getline(&m, fp, '\n') != EOF) {
1077                         unsigned char sha1[20];
1078                         if (get_sha1_hex(m.buf, sha1) < 0)
1079                                 die("Corrupt MERGE_HEAD file (%s)", m.buf);
1080                         pptr = &commit_list_insert(lookup_commit(sha1), pptr)->next;
1081                 }
1082                 fclose(fp);
1083                 strbuf_release(&m);
1084                 if (!stat(git_path("MERGE_MODE"), &statbuf)) {
1085                         if (strbuf_read_file(&sb, git_path("MERGE_MODE"), 0) < 0)
1086                                 die_errno("could not read MERGE_MODE");
1087                         if (!strcmp(sb.buf, "no-ff"))
1088                                 allow_fast_forward = 0;
1089                 }
1090                 if (allow_fast_forward)
1091                         parents = reduce_heads(parents);
1092         } else {
1093                 reflog_msg = "commit";
1094                 pptr = &commit_list_insert(lookup_commit(head_sha1), pptr)->next;
1095         }
1096
1097         /* Finally, get the commit message */
1098         strbuf_reset(&sb);
1099         if (strbuf_read_file(&sb, git_path(commit_editmsg), 0) < 0) {
1100                 int saved_errno = errno;
1101                 rollback_index_files();
1102                 die("could not read commit message: %s", strerror(saved_errno));
1103         }
1104
1105         /* Truncate the message just before the diff, if any. */
1106         if (verbose) {
1107                 p = strstr(sb.buf, "\ndiff --git ");
1108                 if (p != NULL)
1109                         strbuf_setlen(&sb, p - sb.buf + 1);
1110         }
1111
1112         if (cleanup_mode != CLEANUP_NONE)
1113                 stripspace(&sb, cleanup_mode == CLEANUP_ALL);
1114         if (message_is_empty(&sb)) {
1115                 rollback_index_files();
1116                 fprintf(stderr, "Aborting commit due to empty commit message.\n");
1117                 exit(1);
1118         }
1119
1120         if (commit_tree(sb.buf, active_cache_tree->sha1, parents, commit_sha1,
1121                         fmt_ident(author_name, author_email, author_date,
1122                                 IDENT_ERROR_ON_NO_NAME))) {
1123                 rollback_index_files();
1124                 die("failed to write commit object");
1125         }
1126
1127         ref_lock = lock_any_ref_for_update("HEAD",
1128                                            initial_commit ? NULL : head_sha1,
1129                                            0);
1130
1131         nl = strchr(sb.buf, '\n');
1132         if (nl)
1133                 strbuf_setlen(&sb, nl + 1 - sb.buf);
1134         else
1135                 strbuf_addch(&sb, '\n');
1136         strbuf_insert(&sb, 0, reflog_msg, strlen(reflog_msg));
1137         strbuf_insert(&sb, strlen(reflog_msg), ": ", 2);
1138
1139         if (!ref_lock) {
1140                 rollback_index_files();
1141                 die("cannot lock HEAD ref");
1142         }
1143         if (write_ref_sha1(ref_lock, commit_sha1, sb.buf) < 0) {
1144                 rollback_index_files();
1145                 die("cannot update HEAD ref");
1146         }
1147
1148         unlink(git_path("MERGE_HEAD"));
1149         unlink(git_path("MERGE_MSG"));
1150         unlink(git_path("MERGE_MODE"));
1151         unlink(git_path("SQUASH_MSG"));
1152
1153         if (commit_index_files())
1154                 die ("Repository has been updated, but unable to write\n"
1155                      "new_index file. Check that disk is not full or quota is\n"
1156                      "not exceeded, and then \"git reset HEAD\" to recover.");
1157
1158         rerere();
1159         run_hook(get_index_file(), "post-commit", NULL);
1160         if (!quiet)
1161                 print_summary(prefix, commit_sha1);
1162
1163         return 0;
1164 }