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