Merge branch 'jk/merge-rename-ux'
[git] / git.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "exec_cmd.h"
4 #include "help.h"
5 #include "quote.h"
6 #include "run-command.h"
7
8 const char git_usage_string[] =
9         "git [--version] [--exec-path[=<path>]] [--html-path]\n"
10         "           [-p|--paginate|--no-pager] [--no-replace-objects]\n"
11         "           [--bare] [--git-dir=<path>] [--work-tree=<path>]\n"
12         "           [-c name=value] [--help]\n"
13         "           <command> [<args>]";
14
15 const char git_more_info_string[] =
16         "See 'git help <command>' for more information on a specific command.";
17
18 static struct startup_info git_startup_info;
19 static int use_pager = -1;
20 struct pager_config {
21         const char *cmd;
22         int want;
23         char *value;
24 };
25
26 static int pager_command_config(const char *var, const char *value, void *data)
27 {
28         struct pager_config *c = data;
29         if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd)) {
30                 int b = git_config_maybe_bool(var, value);
31                 if (b >= 0)
32                         c->want = b;
33                 else {
34                         c->want = 1;
35                         c->value = xstrdup(value);
36                 }
37         }
38         return 0;
39 }
40
41 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
42 int check_pager_config(const char *cmd)
43 {
44         struct pager_config c;
45         c.cmd = cmd;
46         c.want = -1;
47         c.value = NULL;
48         git_config(pager_command_config, &c);
49         if (c.value)
50                 pager_program = c.value;
51         return c.want;
52 }
53
54 static void commit_pager_choice(void) {
55         switch (use_pager) {
56         case 0:
57                 setenv("GIT_PAGER", "cat", 1);
58                 break;
59         case 1:
60                 setup_pager();
61                 break;
62         default:
63                 break;
64         }
65 }
66
67 static int handle_options(const char ***argv, int *argc, int *envchanged)
68 {
69         int handled = 0;
70
71         while (*argc > 0) {
72                 const char *cmd = (*argv)[0];
73                 if (cmd[0] != '-')
74                         break;
75
76                 /*
77                  * For legacy reasons, the "version" and "help"
78                  * commands can be written with "--" prepended
79                  * to make them look like flags.
80                  */
81                 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
82                         break;
83
84                 /*
85                  * Check remaining flags.
86                  */
87                 if (!prefixcmp(cmd, "--exec-path")) {
88                         cmd += 11;
89                         if (*cmd == '=')
90                                 git_set_argv_exec_path(cmd + 1);
91                         else {
92                                 puts(git_exec_path());
93                                 exit(0);
94                         }
95                 } else if (!strcmp(cmd, "--html-path")) {
96                         puts(system_path(GIT_HTML_PATH));
97                         exit(0);
98                 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
99                         use_pager = 1;
100                 } else if (!strcmp(cmd, "--no-pager")) {
101                         use_pager = 0;
102                         if (envchanged)
103                                 *envchanged = 1;
104                 } else if (!strcmp(cmd, "--no-replace-objects")) {
105                         read_replace_refs = 0;
106                         setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
107                         if (envchanged)
108                                 *envchanged = 1;
109                 } else if (!strcmp(cmd, "--git-dir")) {
110                         if (*argc < 2) {
111                                 fprintf(stderr, "No directory given for --git-dir.\n" );
112                                 usage(git_usage_string);
113                         }
114                         setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
115                         if (envchanged)
116                                 *envchanged = 1;
117                         (*argv)++;
118                         (*argc)--;
119                         handled++;
120                 } else if (!prefixcmp(cmd, "--git-dir=")) {
121                         setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
122                         if (envchanged)
123                                 *envchanged = 1;
124                 } else if (!strcmp(cmd, "--work-tree")) {
125                         if (*argc < 2) {
126                                 fprintf(stderr, "No directory given for --work-tree.\n" );
127                                 usage(git_usage_string);
128                         }
129                         setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
130                         if (envchanged)
131                                 *envchanged = 1;
132                         (*argv)++;
133                         (*argc)--;
134                 } else if (!prefixcmp(cmd, "--work-tree=")) {
135                         setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
136                         if (envchanged)
137                                 *envchanged = 1;
138                 } else if (!strcmp(cmd, "--bare")) {
139                         static char git_dir[PATH_MAX+1];
140                         is_bare_repository_cfg = 1;
141                         setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
142                         if (envchanged)
143                                 *envchanged = 1;
144                 } else if (!strcmp(cmd, "-c")) {
145                         if (*argc < 2) {
146                                 fprintf(stderr, "-c expects a configuration string\n" );
147                                 usage(git_usage_string);
148                         }
149                         git_config_push_parameter((*argv)[1]);
150                         (*argv)++;
151                         (*argc)--;
152                 } else {
153                         fprintf(stderr, "Unknown option: %s\n", cmd);
154                         usage(git_usage_string);
155                 }
156
157                 (*argv)++;
158                 (*argc)--;
159                 handled++;
160         }
161         return handled;
162 }
163
164 static int handle_alias(int *argcp, const char ***argv)
165 {
166         int envchanged = 0, ret = 0, saved_errno = errno;
167         const char *subdir;
168         int count, option_count;
169         const char **new_argv;
170         const char *alias_command;
171         char *alias_string;
172         int unused_nongit;
173
174         subdir = setup_git_directory_gently(&unused_nongit);
175
176         alias_command = (*argv)[0];
177         alias_string = alias_lookup(alias_command);
178         if (alias_string) {
179                 if (alias_string[0] == '!') {
180                         const char **alias_argv;
181                         int argc = *argcp, i;
182
183                         commit_pager_choice();
184
185                         /* build alias_argv */
186                         alias_argv = xmalloc(sizeof(*alias_argv) * (argc + 1));
187                         alias_argv[0] = alias_string + 1;
188                         for (i = 1; i < argc; ++i)
189                                 alias_argv[i] = (*argv)[i];
190                         alias_argv[argc] = NULL;
191
192                         ret = run_command_v_opt(alias_argv, RUN_USING_SHELL);
193                         if (ret >= 0)   /* normal exit */
194                                 exit(ret);
195
196                         die_errno("While expanding alias '%s': '%s'",
197                             alias_command, alias_string + 1);
198                 }
199                 count = split_cmdline(alias_string, &new_argv);
200                 if (count < 0)
201                         die("Bad alias.%s string: %s", alias_command,
202                             split_cmdline_strerror(count));
203                 option_count = handle_options(&new_argv, &count, &envchanged);
204                 if (envchanged)
205                         die("alias '%s' changes environment variables\n"
206                                  "You can use '!git' in the alias to do this.",
207                                  alias_command);
208                 memmove(new_argv - option_count, new_argv,
209                                 count * sizeof(char *));
210                 new_argv -= option_count;
211
212                 if (count < 1)
213                         die("empty alias for %s", alias_command);
214
215                 if (!strcmp(alias_command, new_argv[0]))
216                         die("recursive alias: %s", alias_command);
217
218                 trace_argv_printf(new_argv,
219                                   "trace: alias expansion: %s =>",
220                                   alias_command);
221
222                 new_argv = xrealloc(new_argv, sizeof(char *) *
223                                     (count + *argcp));
224                 /* insert after command name */
225                 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
226
227                 *argv = new_argv;
228                 *argcp += count - 1;
229
230                 ret = 1;
231         }
232
233         if (subdir && chdir(subdir))
234                 die_errno("Cannot change to '%s'", subdir);
235
236         errno = saved_errno;
237
238         return ret;
239 }
240
241 const char git_version_string[] = GIT_VERSION;
242
243 #define RUN_SETUP               (1<<0)
244 #define RUN_SETUP_GENTLY        (1<<1)
245 #define USE_PAGER               (1<<2)
246 /*
247  * require working tree to be present -- anything uses this needs
248  * RUN_SETUP for reading from the configuration file.
249  */
250 #define NEED_WORK_TREE          (1<<3)
251
252 struct cmd_struct {
253         const char *cmd;
254         int (*fn)(int, const char **, const char *);
255         int option;
256 };
257
258 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
259 {
260         int status, help;
261         struct stat st;
262         const char *prefix;
263
264         prefix = NULL;
265         help = argc == 2 && !strcmp(argv[1], "-h");
266         if (!help) {
267                 if (p->option & RUN_SETUP)
268                         prefix = setup_git_directory();
269                 if (p->option & RUN_SETUP_GENTLY) {
270                         int nongit_ok;
271                         prefix = setup_git_directory_gently(&nongit_ok);
272                 }
273
274                 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY))
275                         use_pager = check_pager_config(p->cmd);
276                 if (use_pager == -1 && p->option & USE_PAGER)
277                         use_pager = 1;
278
279                 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
280                     startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
281                         trace_repo_setup(prefix);
282         }
283         commit_pager_choice();
284
285         if (!help && p->option & NEED_WORK_TREE)
286                 setup_work_tree();
287
288         trace_argv_printf(argv, "trace: built-in: git");
289
290         status = p->fn(argc, argv, prefix);
291         if (status)
292                 return status;
293
294         /* Somebody closed stdout? */
295         if (fstat(fileno(stdout), &st))
296                 return 0;
297         /* Ignore write errors for pipes and sockets.. */
298         if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
299                 return 0;
300
301         /* Check for ENOSPC and EIO errors.. */
302         if (fflush(stdout))
303                 die_errno("write failure on standard output");
304         if (ferror(stdout))
305                 die("unknown write failure on standard output");
306         if (fclose(stdout))
307                 die_errno("close failed on standard output");
308         return 0;
309 }
310
311 static void handle_internal_command(int argc, const char **argv)
312 {
313         const char *cmd = argv[0];
314         static struct cmd_struct commands[] = {
315                 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
316                 { "annotate", cmd_annotate, RUN_SETUP },
317                 { "apply", cmd_apply, RUN_SETUP_GENTLY },
318                 { "archive", cmd_archive },
319                 { "bisect--helper", cmd_bisect__helper, RUN_SETUP | NEED_WORK_TREE },
320                 { "blame", cmd_blame, RUN_SETUP },
321                 { "branch", cmd_branch, RUN_SETUP },
322                 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
323                 { "cat-file", cmd_cat_file, RUN_SETUP },
324                 { "check-attr", cmd_check_attr, RUN_SETUP },
325                 { "check-ref-format", cmd_check_ref_format },
326                 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
327                 { "checkout-index", cmd_checkout_index,
328                         RUN_SETUP | NEED_WORK_TREE},
329                 { "cherry", cmd_cherry, RUN_SETUP },
330                 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
331                 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
332                 { "clone", cmd_clone },
333                 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
334                 { "commit-tree", cmd_commit_tree, RUN_SETUP },
335                 { "config", cmd_config, RUN_SETUP_GENTLY },
336                 { "count-objects", cmd_count_objects, RUN_SETUP },
337                 { "describe", cmd_describe, RUN_SETUP },
338                 { "diff", cmd_diff },
339                 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
340                 { "diff-index", cmd_diff_index, RUN_SETUP },
341                 { "diff-tree", cmd_diff_tree, RUN_SETUP },
342                 { "fast-export", cmd_fast_export, RUN_SETUP },
343                 { "fetch", cmd_fetch, RUN_SETUP },
344                 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
345                 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
346                 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
347                 { "format-patch", cmd_format_patch, RUN_SETUP },
348                 { "fsck", cmd_fsck, RUN_SETUP },
349                 { "fsck-objects", cmd_fsck, RUN_SETUP },
350                 { "gc", cmd_gc, RUN_SETUP },
351                 { "get-tar-commit-id", cmd_get_tar_commit_id },
352                 { "grep", cmd_grep, RUN_SETUP_GENTLY },
353                 { "hash-object", cmd_hash_object },
354                 { "help", cmd_help },
355                 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
356                 { "init", cmd_init_db },
357                 { "init-db", cmd_init_db },
358                 { "log", cmd_log, RUN_SETUP },
359                 { "ls-files", cmd_ls_files, RUN_SETUP },
360                 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
361                 { "ls-tree", cmd_ls_tree, RUN_SETUP },
362                 { "mailinfo", cmd_mailinfo },
363                 { "mailsplit", cmd_mailsplit },
364                 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
365                 { "merge-base", cmd_merge_base, RUN_SETUP },
366                 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
367                 { "merge-index", cmd_merge_index, RUN_SETUP },
368                 { "merge-ours", cmd_merge_ours, RUN_SETUP },
369                 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
370                 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
371                 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
372                 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
373                 { "merge-tree", cmd_merge_tree, RUN_SETUP },
374                 { "mktag", cmd_mktag, RUN_SETUP },
375                 { "mktree", cmd_mktree, RUN_SETUP },
376                 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
377                 { "name-rev", cmd_name_rev, RUN_SETUP },
378                 { "notes", cmd_notes, RUN_SETUP },
379                 { "pack-objects", cmd_pack_objects, RUN_SETUP },
380                 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
381                 { "pack-refs", cmd_pack_refs, RUN_SETUP },
382                 { "patch-id", cmd_patch_id },
383                 { "peek-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
384                 { "pickaxe", cmd_blame, RUN_SETUP },
385                 { "prune", cmd_prune, RUN_SETUP },
386                 { "prune-packed", cmd_prune_packed, RUN_SETUP },
387                 { "push", cmd_push, RUN_SETUP },
388                 { "read-tree", cmd_read_tree, RUN_SETUP },
389                 { "receive-pack", cmd_receive_pack },
390                 { "reflog", cmd_reflog, RUN_SETUP },
391                 { "remote", cmd_remote, RUN_SETUP },
392                 { "remote-ext", cmd_remote_ext },
393                 { "remote-fd", cmd_remote_fd },
394                 { "replace", cmd_replace, RUN_SETUP },
395                 { "repo-config", cmd_repo_config, RUN_SETUP_GENTLY },
396                 { "rerere", cmd_rerere, RUN_SETUP },
397                 { "reset", cmd_reset, RUN_SETUP },
398                 { "rev-list", cmd_rev_list, RUN_SETUP },
399                 { "rev-parse", cmd_rev_parse },
400                 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
401                 { "rm", cmd_rm, RUN_SETUP },
402                 { "send-pack", cmd_send_pack, RUN_SETUP },
403                 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
404                 { "show", cmd_show, RUN_SETUP },
405                 { "show-branch", cmd_show_branch, RUN_SETUP },
406                 { "show-ref", cmd_show_ref, RUN_SETUP },
407                 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
408                 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
409                 { "stripspace", cmd_stripspace },
410                 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
411                 { "tag", cmd_tag, RUN_SETUP },
412                 { "tar-tree", cmd_tar_tree },
413                 { "unpack-file", cmd_unpack_file, RUN_SETUP },
414                 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
415                 { "update-index", cmd_update_index, RUN_SETUP },
416                 { "update-ref", cmd_update_ref, RUN_SETUP },
417                 { "update-server-info", cmd_update_server_info, RUN_SETUP },
418                 { "upload-archive", cmd_upload_archive },
419                 { "var", cmd_var, RUN_SETUP_GENTLY },
420                 { "verify-pack", cmd_verify_pack },
421                 { "verify-tag", cmd_verify_tag, RUN_SETUP },
422                 { "version", cmd_version },
423                 { "whatchanged", cmd_whatchanged, RUN_SETUP },
424                 { "write-tree", cmd_write_tree, RUN_SETUP },
425         };
426         int i;
427         static const char ext[] = STRIP_EXTENSION;
428
429         if (sizeof(ext) > 1) {
430                 i = strlen(argv[0]) - strlen(ext);
431                 if (i > 0 && !strcmp(argv[0] + i, ext)) {
432                         char *argv0 = xstrdup(argv[0]);
433                         argv[0] = cmd = argv0;
434                         argv0[i] = '\0';
435                 }
436         }
437
438         /* Turn "git cmd --help" into "git help cmd" */
439         if (argc > 1 && !strcmp(argv[1], "--help")) {
440                 argv[1] = argv[0];
441                 argv[0] = cmd = "help";
442         }
443
444         for (i = 0; i < ARRAY_SIZE(commands); i++) {
445                 struct cmd_struct *p = commands+i;
446                 if (strcmp(p->cmd, cmd))
447                         continue;
448                 exit(run_builtin(p, argc, argv));
449         }
450 }
451
452 static void execv_dashed_external(const char **argv)
453 {
454         struct strbuf cmd = STRBUF_INIT;
455         const char *tmp;
456         int status;
457
458         commit_pager_choice();
459
460         strbuf_addf(&cmd, "git-%s", argv[0]);
461
462         /*
463          * argv[0] must be the git command, but the argv array
464          * belongs to the caller, and may be reused in
465          * subsequent loop iterations. Save argv[0] and
466          * restore it on error.
467          */
468         tmp = argv[0];
469         argv[0] = cmd.buf;
470
471         trace_argv_printf(argv, "trace: exec:");
472
473         /*
474          * if we fail because the command is not found, it is
475          * OK to return. Otherwise, we just pass along the status code.
476          */
477         status = run_command_v_opt(argv, RUN_SILENT_EXEC_FAILURE);
478         if (status >= 0 || errno != ENOENT)
479                 exit(status);
480
481         argv[0] = tmp;
482
483         strbuf_release(&cmd);
484 }
485
486 static int run_argv(int *argcp, const char ***argv)
487 {
488         int done_alias = 0;
489
490         while (1) {
491                 /* See if it's an internal command */
492                 handle_internal_command(*argcp, *argv);
493
494                 /* .. then try the external ones */
495                 execv_dashed_external(*argv);
496
497                 /* It could be an alias -- this works around the insanity
498                  * of overriding "git log" with "git show" by having
499                  * alias.log = show
500                  */
501                 if (done_alias || !handle_alias(argcp, argv))
502                         break;
503                 done_alias = 1;
504         }
505
506         return done_alias;
507 }
508
509
510 int main(int argc, const char **argv)
511 {
512         const char *cmd;
513
514         startup_info = &git_startup_info;
515
516         cmd = git_extract_argv0_path(argv[0]);
517         if (!cmd)
518                 cmd = "git-help";
519
520         /*
521          * "git-xxxx" is the same as "git xxxx", but we obviously:
522          *
523          *  - cannot take flags in between the "git" and the "xxxx".
524          *  - cannot execute it externally (since it would just do
525          *    the same thing over again)
526          *
527          * So we just directly call the internal command handler, and
528          * die if that one cannot handle it.
529          */
530         if (!prefixcmp(cmd, "git-")) {
531                 cmd += 4;
532                 argv[0] = cmd;
533                 handle_internal_command(argc, argv);
534                 die("cannot handle %s internally", cmd);
535         }
536
537         /* Look for flags.. */
538         argv++;
539         argc--;
540         handle_options(&argv, &argc, NULL);
541         if (argc > 0) {
542                 if (!prefixcmp(argv[0], "--"))
543                         argv[0] += 2;
544         } else {
545                 /* The user didn't specify a command; give them help */
546                 commit_pager_choice();
547                 printf("usage: %s\n\n", git_usage_string);
548                 list_common_cmds_help();
549                 printf("\n%s\n", git_more_info_string);
550                 exit(1);
551         }
552         cmd = argv[0];
553
554         /*
555          * We use PATH to find git commands, but we prepend some higher
556          * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
557          * environment, and the $(gitexecdir) from the Makefile at build
558          * time.
559          */
560         setup_path();
561
562         while (1) {
563                 static int done_help = 0;
564                 static int was_alias = 0;
565                 was_alias = run_argv(&argc, &argv);
566                 if (errno != ENOENT)
567                         break;
568                 if (was_alias) {
569                         fprintf(stderr, "Expansion of alias '%s' failed; "
570                                 "'%s' is not a git command\n",
571                                 cmd, argv[0]);
572                         exit(1);
573                 }
574                 if (!done_help) {
575                         cmd = argv[0] = help_unknown_cmd(cmd);
576                         done_help = 1;
577                 } else
578                         break;
579         }
580
581         fprintf(stderr, "Failed to run command '%s': %s\n",
582                 cmd, strerror(errno));
583
584         return 1;
585 }