setup: Provide GIT_PREFIX to built-ins
[git/git.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 struct strbuf sb = STRBUF_INIT;
183 const char *env[2];
184
185 commit_pager_choice();
186
187 /* build alias_argv */
188 alias_argv = xmalloc(sizeof(*alias_argv) * (argc + 1));
189 alias_argv[0] = alias_string + 1;
190 for (i = 1; i < argc; ++i)
191 alias_argv[i] = (*argv)[i];
192 alias_argv[argc] = NULL;
193
194 strbuf_addstr(&sb, "GIT_PREFIX=");
195 if (subdir)
196 strbuf_addstr(&sb, subdir);
197 env[0] = sb.buf;
198 env[1] = NULL;
199 ret = run_command_v_opt_cd_env(alias_argv, RUN_USING_SHELL, NULL, env);
200 strbuf_release(&sb);
201 if (ret >= 0) /* normal exit */
202 exit(ret);
203
204 die_errno("While expanding alias '%s': '%s'",
205 alias_command, alias_string + 1);
206 }
207 count = split_cmdline(alias_string, &new_argv);
208 if (count < 0)
209 die("Bad alias.%s string: %s", alias_command,
210 split_cmdline_strerror(count));
211 option_count = handle_options(&new_argv, &count, &envchanged);
212 if (envchanged)
213 die("alias '%s' changes environment variables\n"
214 "You can use '!git' in the alias to do this.",
215 alias_command);
216 memmove(new_argv - option_count, new_argv,
217 count * sizeof(char *));
218 new_argv -= option_count;
219
220 if (count < 1)
221 die("empty alias for %s", alias_command);
222
223 if (!strcmp(alias_command, new_argv[0]))
224 die("recursive alias: %s", alias_command);
225
226 trace_argv_printf(new_argv,
227 "trace: alias expansion: %s =>",
228 alias_command);
229
230 new_argv = xrealloc(new_argv, sizeof(char *) *
231 (count + *argcp));
232 /* insert after command name */
233 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
234
235 *argv = new_argv;
236 *argcp += count - 1;
237
238 ret = 1;
239 }
240
241 if (subdir && chdir(subdir))
242 die_errno("Cannot change to '%s'", subdir);
243
244 errno = saved_errno;
245
246 return ret;
247 }
248
249 const char git_version_string[] = GIT_VERSION;
250
251 #define RUN_SETUP (1<<0)
252 #define RUN_SETUP_GENTLY (1<<1)
253 #define USE_PAGER (1<<2)
254 /*
255 * require working tree to be present -- anything uses this needs
256 * RUN_SETUP for reading from the configuration file.
257 */
258 #define NEED_WORK_TREE (1<<3)
259
260 struct cmd_struct {
261 const char *cmd;
262 int (*fn)(int, const char **, const char *);
263 int option;
264 };
265
266 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
267 {
268 int status, help;
269 struct stat st;
270 const char *prefix;
271
272 prefix = NULL;
273 help = argc == 2 && !strcmp(argv[1], "-h");
274 if (!help) {
275 if (p->option & RUN_SETUP)
276 prefix = setup_git_directory();
277 if (p->option & RUN_SETUP_GENTLY) {
278 int nongit_ok;
279 prefix = setup_git_directory_gently(&nongit_ok);
280 }
281
282 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY))
283 use_pager = check_pager_config(p->cmd);
284 if (use_pager == -1 && p->option & USE_PAGER)
285 use_pager = 1;
286
287 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
288 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
289 trace_repo_setup(prefix);
290 }
291 commit_pager_choice();
292
293 if (!help && p->option & NEED_WORK_TREE)
294 setup_work_tree();
295
296 trace_argv_printf(argv, "trace: built-in: git");
297
298 status = p->fn(argc, argv, prefix);
299 if (status)
300 return status;
301
302 /* Somebody closed stdout? */
303 if (fstat(fileno(stdout), &st))
304 return 0;
305 /* Ignore write errors for pipes and sockets.. */
306 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
307 return 0;
308
309 /* Check for ENOSPC and EIO errors.. */
310 if (fflush(stdout))
311 die_errno("write failure on standard output");
312 if (ferror(stdout))
313 die("unknown write failure on standard output");
314 if (fclose(stdout))
315 die_errno("close failed on standard output");
316 return 0;
317 }
318
319 static void handle_internal_command(int argc, const char **argv)
320 {
321 const char *cmd = argv[0];
322 static struct cmd_struct commands[] = {
323 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
324 { "annotate", cmd_annotate, RUN_SETUP },
325 { "apply", cmd_apply, RUN_SETUP_GENTLY },
326 { "archive", cmd_archive },
327 { "bisect--helper", cmd_bisect__helper, RUN_SETUP | NEED_WORK_TREE },
328 { "blame", cmd_blame, RUN_SETUP },
329 { "branch", cmd_branch, RUN_SETUP },
330 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
331 { "cat-file", cmd_cat_file, RUN_SETUP },
332 { "check-attr", cmd_check_attr, RUN_SETUP },
333 { "check-ref-format", cmd_check_ref_format },
334 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
335 { "checkout-index", cmd_checkout_index,
336 RUN_SETUP | NEED_WORK_TREE},
337 { "cherry", cmd_cherry, RUN_SETUP },
338 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
339 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
340 { "clone", cmd_clone },
341 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
342 { "commit-tree", cmd_commit_tree, RUN_SETUP },
343 { "config", cmd_config, RUN_SETUP_GENTLY },
344 { "count-objects", cmd_count_objects, RUN_SETUP },
345 { "describe", cmd_describe, RUN_SETUP },
346 { "diff", cmd_diff },
347 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
348 { "diff-index", cmd_diff_index, RUN_SETUP },
349 { "diff-tree", cmd_diff_tree, RUN_SETUP },
350 { "fast-export", cmd_fast_export, RUN_SETUP },
351 { "fetch", cmd_fetch, RUN_SETUP },
352 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
353 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
354 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
355 { "format-patch", cmd_format_patch, RUN_SETUP },
356 { "fsck", cmd_fsck, RUN_SETUP },
357 { "fsck-objects", cmd_fsck, RUN_SETUP },
358 { "gc", cmd_gc, RUN_SETUP },
359 { "get-tar-commit-id", cmd_get_tar_commit_id },
360 { "grep", cmd_grep, RUN_SETUP_GENTLY },
361 { "hash-object", cmd_hash_object },
362 { "help", cmd_help },
363 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
364 { "init", cmd_init_db },
365 { "init-db", cmd_init_db },
366 { "log", cmd_log, RUN_SETUP },
367 { "ls-files", cmd_ls_files, RUN_SETUP },
368 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
369 { "ls-tree", cmd_ls_tree, RUN_SETUP },
370 { "mailinfo", cmd_mailinfo },
371 { "mailsplit", cmd_mailsplit },
372 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
373 { "merge-base", cmd_merge_base, RUN_SETUP },
374 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
375 { "merge-index", cmd_merge_index, RUN_SETUP },
376 { "merge-ours", cmd_merge_ours, RUN_SETUP },
377 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
378 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
379 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
380 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
381 { "merge-tree", cmd_merge_tree, RUN_SETUP },
382 { "mktag", cmd_mktag, RUN_SETUP },
383 { "mktree", cmd_mktree, RUN_SETUP },
384 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
385 { "name-rev", cmd_name_rev, RUN_SETUP },
386 { "notes", cmd_notes, RUN_SETUP },
387 { "pack-objects", cmd_pack_objects, RUN_SETUP },
388 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
389 { "pack-refs", cmd_pack_refs, RUN_SETUP },
390 { "patch-id", cmd_patch_id },
391 { "peek-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
392 { "pickaxe", cmd_blame, RUN_SETUP },
393 { "prune", cmd_prune, RUN_SETUP },
394 { "prune-packed", cmd_prune_packed, RUN_SETUP },
395 { "push", cmd_push, RUN_SETUP },
396 { "read-tree", cmd_read_tree, RUN_SETUP },
397 { "receive-pack", cmd_receive_pack },
398 { "reflog", cmd_reflog, RUN_SETUP },
399 { "remote", cmd_remote, RUN_SETUP },
400 { "remote-ext", cmd_remote_ext },
401 { "remote-fd", cmd_remote_fd },
402 { "replace", cmd_replace, RUN_SETUP },
403 { "repo-config", cmd_repo_config, RUN_SETUP_GENTLY },
404 { "rerere", cmd_rerere, RUN_SETUP },
405 { "reset", cmd_reset, RUN_SETUP },
406 { "rev-list", cmd_rev_list, RUN_SETUP },
407 { "rev-parse", cmd_rev_parse },
408 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
409 { "rm", cmd_rm, RUN_SETUP },
410 { "send-pack", cmd_send_pack, RUN_SETUP },
411 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
412 { "show", cmd_show, RUN_SETUP },
413 { "show-branch", cmd_show_branch, RUN_SETUP },
414 { "show-ref", cmd_show_ref, RUN_SETUP },
415 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
416 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
417 { "stripspace", cmd_stripspace },
418 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
419 { "tag", cmd_tag, RUN_SETUP },
420 { "tar-tree", cmd_tar_tree },
421 { "unpack-file", cmd_unpack_file, RUN_SETUP },
422 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
423 { "update-index", cmd_update_index, RUN_SETUP },
424 { "update-ref", cmd_update_ref, RUN_SETUP },
425 { "update-server-info", cmd_update_server_info, RUN_SETUP },
426 { "upload-archive", cmd_upload_archive },
427 { "var", cmd_var, RUN_SETUP_GENTLY },
428 { "verify-pack", cmd_verify_pack },
429 { "verify-tag", cmd_verify_tag, RUN_SETUP },
430 { "version", cmd_version },
431 { "whatchanged", cmd_whatchanged, RUN_SETUP },
432 { "write-tree", cmd_write_tree, RUN_SETUP },
433 };
434 int i;
435 static const char ext[] = STRIP_EXTENSION;
436
437 if (sizeof(ext) > 1) {
438 i = strlen(argv[0]) - strlen(ext);
439 if (i > 0 && !strcmp(argv[0] + i, ext)) {
440 char *argv0 = xstrdup(argv[0]);
441 argv[0] = cmd = argv0;
442 argv0[i] = '\0';
443 }
444 }
445
446 /* Turn "git cmd --help" into "git help cmd" */
447 if (argc > 1 && !strcmp(argv[1], "--help")) {
448 argv[1] = argv[0];
449 argv[0] = cmd = "help";
450 }
451
452 for (i = 0; i < ARRAY_SIZE(commands); i++) {
453 struct cmd_struct *p = commands+i;
454 if (strcmp(p->cmd, cmd))
455 continue;
456 exit(run_builtin(p, argc, argv));
457 }
458 }
459
460 static void execv_dashed_external(const char **argv)
461 {
462 struct strbuf cmd = STRBUF_INIT;
463 const char *tmp;
464 int status;
465
466 commit_pager_choice();
467
468 strbuf_addf(&cmd, "git-%s", argv[0]);
469
470 /*
471 * argv[0] must be the git command, but the argv array
472 * belongs to the caller, and may be reused in
473 * subsequent loop iterations. Save argv[0] and
474 * restore it on error.
475 */
476 tmp = argv[0];
477 argv[0] = cmd.buf;
478
479 trace_argv_printf(argv, "trace: exec:");
480
481 /*
482 * if we fail because the command is not found, it is
483 * OK to return. Otherwise, we just pass along the status code.
484 */
485 status = run_command_v_opt(argv, RUN_SILENT_EXEC_FAILURE);
486 if (status >= 0 || errno != ENOENT)
487 exit(status);
488
489 argv[0] = tmp;
490
491 strbuf_release(&cmd);
492 }
493
494 static int run_argv(int *argcp, const char ***argv)
495 {
496 int done_alias = 0;
497
498 while (1) {
499 /* See if it's an internal command */
500 handle_internal_command(*argcp, *argv);
501
502 /* .. then try the external ones */
503 execv_dashed_external(*argv);
504
505 /* It could be an alias -- this works around the insanity
506 * of overriding "git log" with "git show" by having
507 * alias.log = show
508 */
509 if (done_alias || !handle_alias(argcp, argv))
510 break;
511 done_alias = 1;
512 }
513
514 return done_alias;
515 }
516
517
518 int main(int argc, const char **argv)
519 {
520 const char *cmd;
521
522 startup_info = &git_startup_info;
523
524 cmd = git_extract_argv0_path(argv[0]);
525 if (!cmd)
526 cmd = "git-help";
527
528 /*
529 * "git-xxxx" is the same as "git xxxx", but we obviously:
530 *
531 * - cannot take flags in between the "git" and the "xxxx".
532 * - cannot execute it externally (since it would just do
533 * the same thing over again)
534 *
535 * So we just directly call the internal command handler, and
536 * die if that one cannot handle it.
537 */
538 if (!prefixcmp(cmd, "git-")) {
539 cmd += 4;
540 argv[0] = cmd;
541 handle_internal_command(argc, argv);
542 die("cannot handle %s internally", cmd);
543 }
544
545 /* Look for flags.. */
546 argv++;
547 argc--;
548 handle_options(&argv, &argc, NULL);
549 if (argc > 0) {
550 if (!prefixcmp(argv[0], "--"))
551 argv[0] += 2;
552 } else {
553 /* The user didn't specify a command; give them help */
554 commit_pager_choice();
555 printf("usage: %s\n\n", git_usage_string);
556 list_common_cmds_help();
557 printf("\n%s\n", git_more_info_string);
558 exit(1);
559 }
560 cmd = argv[0];
561
562 /*
563 * We use PATH to find git commands, but we prepend some higher
564 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
565 * environment, and the $(gitexecdir) from the Makefile at build
566 * time.
567 */
568 setup_path();
569
570 while (1) {
571 static int done_help = 0;
572 static int was_alias = 0;
573 was_alias = run_argv(&argc, &argv);
574 if (errno != ENOENT)
575 break;
576 if (was_alias) {
577 fprintf(stderr, "Expansion of alias '%s' failed; "
578 "'%s' is not a git command\n",
579 cmd, argv[0]);
580 exit(1);
581 }
582 if (!done_help) {
583 cmd = argv[0] = help_unknown_cmd(cmd);
584 done_help = 1;
585 } else
586 break;
587 }
588
589 fprintf(stderr, "Failed to run command '%s': %s\n",
590 cmd, strerror(errno));
591
592 return 1;
593 }