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